@strapi/data-transfer/dist/strapi/utils/project-settings-logos.mjs.map

Data transfer capabilities for Strapi

{"version":3,"file":"project-settings-logos.mjs","sources":["../../../src/strapi/utils/project-settings-logos.ts"],"sourcesContent":["import { join } from 'path';\nimport { Readable } from 'stream';\nimport { pick } from 'lodash/fp';\nimport { readFile } from 'fs-extra';\nimport { lookup as lookupMimeType } from 'mime-types';\nimport * as webStream from 'stream/web';\nimport type { Core } from '@strapi/types';\n\nexport const PROJECT_SETTINGS_CORE_STORE_KEY = 'core_admin_project-settings';\n\nexport const PROJECT_SETTINGS_LOGO_FIELDS = ['menuLogo', 'authLogo'] as const;\n\nexport type ProjectSettingsLogoField = (typeof PROJECT_SETTINGS_LOGO_FIELDS)[number];\n\nexport type ProjectSettingsLogo = {\n  name?: string;\n  hash?: string;\n  url?: string;\n  width?: number;\n  height?: number;\n  ext?: string;\n  size?: number;\n  mime?: string;\n  provider?: string;\n  __transferBuffer?: string;\n};\n\nexport type ProjectSettingsStoreValue = {\n  menuLogo?: ProjectSettingsLogo | null;\n  authLogo?: ProjectSettingsLogo | null;\n};\n\nexport type CoreStoreRow = {\n  key: string;\n  value: unknown;\n  [key: string]: unknown;\n};\n\n// The shape persisted back to core-store, matching what the admin project-settings\n// service stores (so the admin UI keeps behaving identically after a transfer).\nconst LOGO_PERSISTED_FIELDS = [\n  'name',\n  'hash',\n  'url',\n  'width',\n  'height',\n  'ext',\n  'size',\n  'provider',\n] as const;\n\nconst isProjectSettingsRow = (row: CoreStoreRow) => row.key === PROJECT_SETTINGS_CORE_STORE_KEY;\n\nconst getConfiguredUploadProvider = (strapi: Core.Strapi) =>\n  (strapi.config.get('plugin::upload') as { provider?: string } | undefined)?.provider;\n\n// Admin logos with no provider were uploaded with the local provider (the default).\nconst isLocalProviderLogo = (logo: ProjectSettingsLogo) =>\n  !logo.provider || logo.provider === 'local';\n\n// Best-effort mime type for a logo so that remote providers (S3, Cloudinary, …)\n// store the correct Content-Type and the image renders instead of downloading.\n// The admin does not persist the mime type, so it is reconstructed from the\n// file extension (falling back to the file name).\nconst getLogoMimeType = (logo: ProjectSettingsLogo): string | undefined => {\n  const fromExt = logo.ext ? lookupMimeType(logo.ext) : false;\n  if (fromExt) {\n    return fromExt;\n  }\n\n  const fromName = logo.name ? lookupMimeType(logo.name) : false;\n  if (fromName) {\n    return fromName;\n  }\n\n  return undefined;\n};\n\n/**\n * Resolve the URL to read a non-local logo from during export.\n *\n * Mirrors the media-library asset export: when the file lives on the\n * currently-configured provider and that provider serves private files,\n * a signed URL is generated so the bytes can be fetched.\n */\nconst getRemoteLogoUrl = async (strapi: Core.Strapi, logo: ProjectSettingsLogo) => {\n  const { provider } = strapi.plugins.upload;\n  const providerName = getConfiguredUploadProvider(strapi);\n\n  if (\n    logo.provider === providerName &&\n    typeof provider?.isPrivate === 'function' &&\n    typeof provider?.getSignedUrl === 'function' &&\n    (await provider.isPrivate())\n  ) {\n    const { url } = await provider.getSignedUrl(logo);\n    return url;\n  }\n\n  return logo.url;\n};\n\nconst logoLabel = (logo: ProjectSettingsLogo) => logo.name ?? logo.hash ?? 'unknown';\n\nconst readLocalLogoBuffer = async (strapi: Core.Strapi, logo: ProjectSettingsLogo) => {\n  const filepath = join(strapi.dirs.static.public, logo.url as string);\n\n  try {\n    const buffer = await readFile(filepath);\n    return buffer.toString('base64');\n  } catch (error) {\n    const code =\n      error && typeof error === 'object' && 'code' in error\n        ? (error as NodeJS.ErrnoException).code\n        : undefined;\n\n    if (code === 'ENOENT') {\n      strapi.log.warn(\n        `[Data transfer] Admin logo \"${logoLabel(logo)}\" exists in project settings but no corresponding file was found to transfer. Path: ${filepath}`\n      );\n      return undefined;\n    }\n\n    throw error;\n  }\n};\n\nconst readRemoteLogoBuffer = async (strapi: Core.Strapi, logo: ProjectSettingsLogo) => {\n  const url = await getRemoteLogoUrl(strapi, logo);\n  const response = await strapi.fetch(url);\n\n  if (response.status !== 200 || !response.body) {\n    strapi.log.warn(\n      `[Data transfer] Admin logo \"${logoLabel(logo)}\" exists in project settings but could not be fetched for transfer. URL: ${url} (status: ${response.status})`\n    );\n    return undefined;\n  }\n\n  const chunks: Uint8Array[] = [];\n\n  for await (const chunk of Readable.fromWeb(\n    response.body as webStream.ReadableStream<Uint8Array>\n  )) {\n    chunks.push(chunk);\n  }\n\n  return Buffer.concat(chunks).toString('base64');\n};\n\nconst readLogoTransferBuffer = async (strapi: Core.Strapi, logo: ProjectSettingsLogo) => {\n  if (!logo.url) {\n    return undefined;\n  }\n\n  if (isLocalProviderLogo(logo)) {\n    return readLocalLogoBuffer(strapi, logo);\n  }\n\n  return readRemoteLogoBuffer(strapi, logo);\n};\n\nconst enrichLogoForExport = async (\n  strapi: Core.Strapi,\n  logo: ProjectSettingsLogo | null | undefined\n) => {\n  if (!logo?.url) {\n    return logo;\n  }\n\n  const transferBuffer = await readLogoTransferBuffer(strapi, logo);\n\n  if (!transferBuffer) {\n    return logo;\n  }\n\n  return {\n    ...logo,\n    __transferBuffer: transferBuffer,\n  };\n};\n\nexport const enrichProjectSettingsForExport = async (\n  strapi: Core.Strapi,\n  row: CoreStoreRow\n): Promise<CoreStoreRow> => {\n  if (!isProjectSettingsRow(row)) {\n    return row;\n  }\n\n  const settings = row.value as ProjectSettingsStoreValue;\n\n  const [menuLogo, authLogo] = await Promise.all([\n    enrichLogoForExport(strapi, settings.menuLogo),\n    enrichLogoForExport(strapi, settings.authLogo),\n  ]);\n\n  return {\n    ...row,\n    value: {\n      ...settings,\n      menuLogo,\n      authLogo,\n    },\n  };\n};\n\n/**\n * Re-upload a transferred logo to the destination's configured upload provider.\n *\n * The file is always re-uploaded through the destination provider, so the\n * persisted `url` and `provider` reflect the destination (matching how the\n * media-library asset restore behaves). A best-effort mime type is supplied so\n * remote providers serve the logo with the correct Content-Type.\n */\nconst uploadLogoFromTransferBuffer = async (strapi: Core.Strapi, logo: ProjectSettingsLogo) => {\n  if (!logo.__transferBuffer) {\n    return logo;\n  }\n\n  const { __transferBuffer: transferBuffer, ...logoWithoutBuffer } = logo;\n  const provider = getConfiguredUploadProvider(strapi);\n  const mime = getLogoMimeType(logoWithoutBuffer);\n\n  const file = {\n    ...logoWithoutBuffer,\n    ...(mime ? { mime } : {}),\n    stream: Readable.from(Buffer.from(transferBuffer, 'base64')),\n    provider,\n  };\n\n  await strapi.plugin('upload').provider.uploadStream(file);\n\n  return pick(LOGO_PERSISTED_FIELDS, file);\n};\n\nexport const restoreProjectSettingsLogos = async (\n  strapi: Core.Strapi,\n  settings: ProjectSettingsStoreValue\n): Promise<ProjectSettingsStoreValue> => {\n  const [menuLogo, authLogo] = await Promise.all([\n    settings.menuLogo ? uploadLogoFromTransferBuffer(strapi, settings.menuLogo) : settings.menuLogo,\n    settings.authLogo ? uploadLogoFromTransferBuffer(strapi, settings.authLogo) : settings.authLogo,\n  ]);\n\n  return {\n    ...settings,\n    menuLogo,\n    authLogo,\n  };\n};\n\nexport const restoreProjectSettingsRow = async (strapi: Core.Strapi, row: CoreStoreRow) => {\n  if (!isProjectSettingsRow(row)) {\n    return row;\n  }\n\n  return {\n    ...row,\n    value: await restoreProjectSettingsLogos(strapi, row.value as ProjectSettingsStoreValue),\n  };\n};\n"],"names":["PROJECT_SETTINGS_CORE_STORE_KEY","LOGO_PERSISTED_FIELDS","isProjectSettingsRow","row","key","getConfiguredUploadProvider","strapi","config","get","provider","isLocalProviderLogo","logo","getLogoMimeType","fromExt","ext","lookupMimeType","fromName","name","undefined","getRemoteLogoUrl","plugins","upload","providerName","isPrivate","getSignedUrl","url","logoLabel","hash","readLocalLogoBuffer","filepath","join","dirs","static","public","buffer","readFile","toString","error","code","log","warn","readRemoteLogoBuffer","response","fetch","status","body","chunks","chunk","Readable","fromWeb","push","Buffer","concat","readLogoTransferBuffer","enrichLogoForExport","transferBuffer","__transferBuffer","enrichProjectSettingsForExport","settings","value","menuLogo","authLogo","Promise","all","uploadLogoFromTransferBuffer","logoWithoutBuffer","mime","file","stream","from","plugin","uploadStream","pick","restoreProjectSettingsLogos","restoreProjectSettingsRow"],"mappings":";;;;;;AAQO,MAAMA,kCAAkC;AA8B/C;AACA;AACA,MAAMC,qBAAAA,GAAwB;AAC5B,IAAA,MAAA;AACA,IAAA,MAAA;AACA,IAAA,KAAA;AACA,IAAA,OAAA;AACA,IAAA,QAAA;AACA,IAAA,KAAA;AACA,IAAA,MAAA;AACA,IAAA;AACD,CAAA;AAED,MAAMC,oBAAAA,GAAuB,CAACC,GAAAA,GAAsBA,GAAAA,CAAIC,GAAG,KAAKJ,+BAAAA;AAEhE,MAAMK,2BAAAA,GAA8B,CAACC,MAAAA,GAClCA,MAAAA,CAAOC,MAAM,CAACC,GAAG,CAAC,gBAAA,CAAA,EAAyDC,QAAAA;AAE9E;AACA,MAAMC,mBAAAA,GAAsB,CAACC,IAAAA,GAC3B,CAACA,KAAKF,QAAQ,IAAIE,IAAAA,CAAKF,QAAQ,KAAK,OAAA;AAEtC;AACA;AACA;AACA;AACA,MAAMG,kBAAkB,CAACD,IAAAA,GAAAA;AACvB,IAAA,MAAME,UAAUF,IAAAA,CAAKG,GAAG,GAAGC,MAAAA,CAAeJ,IAAAA,CAAKG,GAAG,CAAA,GAAI,KAAA;AACtD,IAAA,IAAID,OAAAA,EAAS;QACX,OAAOA,OAAAA;AACT,IAAA;AAEA,IAAA,MAAMG,WAAWL,IAAAA,CAAKM,IAAI,GAAGF,MAAAA,CAAeJ,IAAAA,CAAKM,IAAI,CAAA,GAAI,KAAA;AACzD,IAAA,IAAID,QAAAA,EAAU;QACZ,OAAOA,QAAAA;AACT,IAAA;IAEA,OAAOE,SAAAA;AACT,CAAA;AAEA;;;;;;IAOA,MAAMC,gBAAAA,GAAmB,OAAOb,MAAAA,EAAqBK,IAAAA,GAAAA;AACnD,IAAA,MAAM,EAAEF,QAAQ,EAAE,GAAGH,MAAAA,CAAOc,OAAO,CAACC,MAAM;AAC1C,IAAA,MAAMC,eAAejB,2BAAAA,CAA4BC,MAAAA,CAAAA;AAEjD,IAAA,IACEK,IAAAA,CAAKF,QAAQ,KAAKa,YAAAA,IAClB,OAAOb,QAAAA,EAAUc,SAAAA,KAAc,UAAA,IAC/B,OAAOd,UAAUe,YAAAA,KAAiB,UAAA,IACjC,MAAMf,QAAAA,CAASc,SAAS,EAAA,EACzB;AACA,QAAA,MAAM,EAAEE,GAAG,EAAE,GAAG,MAAMhB,QAAAA,CAASe,YAAY,CAACb,IAAAA,CAAAA;QAC5C,OAAOc,GAAAA;AACT,IAAA;AAEA,IAAA,OAAOd,KAAKc,GAAG;AACjB,CAAA;AAEA,MAAMC,SAAAA,GAAY,CAACf,IAAAA,GAA8BA,IAAAA,CAAKM,IAAI,IAAIN,IAAAA,CAAKgB,IAAI,IAAI,SAAA;AAE3E,MAAMC,mBAAAA,GAAsB,OAAOtB,MAAAA,EAAqBK,IAAAA,GAAAA;IACtD,MAAMkB,QAAAA,GAAWC,IAAAA,CAAKxB,MAAAA,CAAOyB,IAAI,CAACC,MAAM,CAACC,MAAM,EAAEtB,IAAAA,CAAKc,GAAG,CAAA;IAEzD,IAAI;QACF,MAAMS,MAAAA,GAAS,MAAMC,QAAAA,CAASN,QAAAA,CAAAA;QAC9B,OAAOK,MAAAA,CAAOE,QAAQ,CAAC,QAAA,CAAA;AACzB,IAAA,CAAA,CAAE,OAAOC,KAAAA,EAAO;QACd,MAAMC,IAAAA,GACJD,KAAAA,IAAS,OAAOA,KAAAA,KAAU,QAAA,IAAY,UAAUA,KAAAA,GAC3CA,KAAAA,CAAgCC,IAAI,GACrCpB,SAAAA;AAEN,QAAA,IAAIoB,SAAS,QAAA,EAAU;YACrBhC,MAAAA,CAAOiC,GAAG,CAACC,IAAI,CACb,CAAC,4BAA4B,EAAEd,SAAAA,CAAUf,IAAAA,CAAAA,CAAM,oFAAoF,EAAEkB,QAAAA,CAAAA,CAAU,CAAA;YAEjJ,OAAOX,SAAAA;AACT,QAAA;QAEA,MAAMmB,KAAAA;AACR,IAAA;AACF,CAAA;AAEA,MAAMI,oBAAAA,GAAuB,OAAOnC,MAAAA,EAAqBK,IAAAA,GAAAA;IACvD,MAAMc,GAAAA,GAAM,MAAMN,gBAAAA,CAAiBb,MAAAA,EAAQK,IAAAA,CAAAA;AAC3C,IAAA,MAAM+B,QAAAA,GAAW,MAAMpC,MAAAA,CAAOqC,KAAK,CAAClB,GAAAA,CAAAA;AAEpC,IAAA,IAAIiB,SAASE,MAAM,KAAK,OAAO,CAACF,QAAAA,CAASG,IAAI,EAAE;AAC7CvC,QAAAA,MAAAA,CAAOiC,GAAG,CAACC,IAAI,CACb,CAAC,4BAA4B,EAAEd,SAAAA,CAAUf,IAAAA,CAAAA,CAAM,yEAAyE,EAAEc,IAAI,UAAU,EAAEiB,SAASE,MAAM,CAAC,CAAC,CAAC,CAAA;QAE9J,OAAO1B,SAAAA;AACT,IAAA;AAEA,IAAA,MAAM4B,SAAuB,EAAE;AAE/B,IAAA,WAAW,MAAMC,KAAAA,IAASC,QAAAA,CAASC,OAAO,CACxCP,QAAAA,CAASG,IAAI,CAAA,CACZ;AACDC,QAAAA,MAAAA,CAAOI,IAAI,CAACH,KAAAA,CAAAA;AACd,IAAA;AAEA,IAAA,OAAOI,MAAAA,CAAOC,MAAM,CAACN,MAAAA,CAAAA,CAAQV,QAAQ,CAAC,QAAA,CAAA;AACxC,CAAA;AAEA,MAAMiB,sBAAAA,GAAyB,OAAO/C,MAAAA,EAAqBK,IAAAA,GAAAA;IACzD,IAAI,CAACA,IAAAA,CAAKc,GAAG,EAAE;QACb,OAAOP,SAAAA;AACT,IAAA;AAEA,IAAA,IAAIR,oBAAoBC,IAAAA,CAAAA,EAAO;AAC7B,QAAA,OAAOiB,oBAAoBtB,MAAAA,EAAQK,IAAAA,CAAAA;AACrC,IAAA;AAEA,IAAA,OAAO8B,qBAAqBnC,MAAAA,EAAQK,IAAAA,CAAAA;AACtC,CAAA;AAEA,MAAM2C,mBAAAA,GAAsB,OAC1BhD,MAAAA,EACAK,IAAAA,GAAAA;IAEA,IAAI,CAACA,MAAMc,GAAAA,EAAK;QACd,OAAOd,IAAAA;AACT,IAAA;IAEA,MAAM4C,cAAAA,GAAiB,MAAMF,sBAAAA,CAAuB/C,MAAAA,EAAQK,IAAAA,CAAAA;AAE5D,IAAA,IAAI,CAAC4C,cAAAA,EAAgB;QACnB,OAAO5C,IAAAA;AACT,IAAA;IAEA,OAAO;AACL,QAAA,GAAGA,IAAI;QACP6C,gBAAAA,EAAkBD;AACpB,KAAA;AACF,CAAA;AAEO,MAAME,8BAAAA,GAAiC,OAC5CnD,MAAAA,EACAH,GAAAA,GAAAA;IAEA,IAAI,CAACD,qBAAqBC,GAAAA,CAAAA,EAAM;QAC9B,OAAOA,GAAAA;AACT,IAAA;IAEA,MAAMuD,QAAAA,GAAWvD,IAAIwD,KAAK;AAE1B,IAAA,MAAM,CAACC,QAAAA,EAAUC,QAAAA,CAAS,GAAG,MAAMC,OAAAA,CAAQC,GAAG,CAAC;QAC7CT,mBAAAA,CAAoBhD,MAAAA,EAAQoD,SAASE,QAAQ,CAAA;QAC7CN,mBAAAA,CAAoBhD,MAAAA,EAAQoD,SAASG,QAAQ;AAC9C,KAAA,CAAA;IAED,OAAO;AACL,QAAA,GAAG1D,GAAG;QACNwD,KAAAA,EAAO;AACL,YAAA,GAAGD,QAAQ;AACXE,YAAAA,QAAAA;AACAC,YAAAA;AACF;AACF,KAAA;AACF;AAEA;;;;;;;IAQA,MAAMG,4BAAAA,GAA+B,OAAO1D,MAAAA,EAAqBK,IAAAA,GAAAA;IAC/D,IAAI,CAACA,IAAAA,CAAK6C,gBAAgB,EAAE;QAC1B,OAAO7C,IAAAA;AACT,IAAA;AAEA,IAAA,MAAM,EAAE6C,gBAAAA,EAAkBD,cAAc,EAAE,GAAGU,mBAAmB,GAAGtD,IAAAA;AACnE,IAAA,MAAMF,WAAWJ,2BAAAA,CAA4BC,MAAAA,CAAAA;AAC7C,IAAA,MAAM4D,OAAOtD,eAAAA,CAAgBqD,iBAAAA,CAAAA;AAE7B,IAAA,MAAME,IAAAA,GAAO;AACX,QAAA,GAAGF,iBAAiB;AACpB,QAAA,GAAIC,IAAAA,GAAO;AAAEA,YAAAA;AAAK,SAAA,GAAI,EAAE;AACxBE,QAAAA,MAAAA,EAAQpB,SAASqB,IAAI,CAAClB,MAAAA,CAAOkB,IAAI,CAACd,cAAAA,EAAgB,QAAA,CAAA,CAAA;AAClD9C,QAAAA;AACF,KAAA;AAEA,IAAA,MAAMH,OAAOgE,MAAM,CAAC,UAAU7D,QAAQ,CAAC8D,YAAY,CAACJ,IAAAA,CAAAA;AAEpD,IAAA,OAAOK,KAAKvE,qBAAAA,EAAuBkE,IAAAA,CAAAA;AACrC,CAAA;AAEO,MAAMM,2BAAAA,GAA8B,OACzCnE,MAAAA,EACAoD,QAAAA,GAAAA;AAEA,IAAA,MAAM,CAACE,QAAAA,EAAUC,QAAAA,CAAS,GAAG,MAAMC,OAAAA,CAAQC,GAAG,CAAC;QAC7CL,QAAAA,CAASE,QAAQ,GAAGI,4BAAAA,CAA6B1D,MAAAA,EAAQoD,SAASE,QAAQ,CAAA,GAAIF,SAASE,QAAQ;QAC/FF,QAAAA,CAASG,QAAQ,GAAGG,4BAAAA,CAA6B1D,MAAAA,EAAQoD,SAASG,QAAQ,CAAA,GAAIH,SAASG;AACxF,KAAA,CAAA;IAED,OAAO;AACL,QAAA,GAAGH,QAAQ;AACXE,QAAAA,QAAAA;AACAC,QAAAA;AACF,KAAA;AACF;AAEO,MAAMa,yBAAAA,GAA4B,OAAOpE,MAAAA,EAAqBH,GAAAA,GAAAA;IACnE,IAAI,CAACD,qBAAqBC,GAAAA,CAAAA,EAAM;QAC9B,OAAOA,GAAAA;AACT,IAAA;IAEA,OAAO;AACL,QAAA,GAAGA,GAAG;AACNwD,QAAAA,KAAAA,EAAO,MAAMc,2BAAAA,CAA4BnE,MAAAA,EAAQH,GAAAA,CAAIwD,KAAK;AAC5D,KAAA;AACF;;;;"}