@jhb.software/payload-alt-text-plugin 0.9.0 → 0.10.0

package/dist/plugin.js

@@ -6,7 +6,7 @@ import { altTextField } from './fields/altTextField.js';
 import { keywordsField } from './fields/keywordsField.js';
 import { createRevalidateAltTextHealthAfterChangeHook, createRevalidateAltTextHealthAfterDeleteHook } from './hooks/revalidateAltTextHealth.js';
 import { translations } from './translations/index.js';
-import { normalizeCollectionsConfig } from './utilities/mimeTypes.js';
+import { isValidMimeType, normalizeCollectionsConfig } from './utilities/mimeTypes.js';
 import { deepMergeSimple } from './utils/deepMergeSimple.js';
 const altTextHealthWidgetDefinition = {
     slug: 'alt-text-health',
@@ -30,7 +30,25 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
         }
         const locales = config.localization ? config.localization.locales.map((localeConfig)=>typeof localeConfig === 'string' ? localeConfig : localeConfig.code) : [];
         const enableHealthCheck = incomingPluginConfig.healthCheck !== false;
-        const normalizedCollections = normalizeCollectionsConfig(incomingPluginConfig.collections);
+        const normalizedCollections = normalizeCollectionsConfig(incomingPluginConfig.collections, {
+            imageThumbnailMimeType: incomingPluginConfig.imageThumbnailMimeType
+        });
+        // A declared thumbnail MIME type replaces the per-document source check, so a
+        // wrong one fails at boot rather than as a silently missing guard or a 500 per
+        // image.
+        const supportedMimeTypes = incomingPluginConfig.resolver.supportedMimeTypes;
+        for (const collection of normalizedCollections){
+            const declared = collection.imageThumbnailMimeType;
+            if (declared === undefined) {
+                continue;
+            }
+            if (!isValidMimeType(declared)) {
+                throw new Error(`The alt-text plugin is configured with imageThumbnailMimeType "${declared}" for the "${collection.slug}" collection, ` + 'but that is not a valid MIME type. Expected something like "image/webp".');
+            }
+            if (supportedMimeTypes && !supportedMimeTypes.includes(declared)) {
+                throw new Error(`The alt-text plugin is configured with imageThumbnailMimeType "${declared}" for the "${collection.slug}" collection, ` + `but the "${incomingPluginConfig.resolver.key}" resolver does not support it. ` + `Supported types: ${supportedMimeTypes.join(', ')}. ` + "Either change the transformation in getImageThumbnail, or remove the declaration to fall back to checking each document's own mime type.");
+            }
+        }
         const access = incomingPluginConfig.access ?? (({ req })=>!!req.user);
         // A function form of `healthCheck` doubles as the health report's access
         // gate; otherwise it falls back to the shared `access`.
@@ -70,7 +88,10 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
                 const defaultFields = [
                     altTextField({
                         localized: Boolean(config.localization),
-                        supportedMimeTypes: pluginConfig.resolver.supportedMimeTypes,
+                        // When the collection declares what getImageThumbnail delivers, the
+                        // document's own mime type says nothing about whether generation can
+                        // succeed — so don't let the admin UI disable the button on it.
+                        supportedMimeTypes: altTextCollectionConfig.imageThumbnailMimeType ? undefined : pluginConfig.resolver.supportedMimeTypes,
                         trackedMimeTypes: altTextCollectionConfig.mimeTypes,
                         validate: altTextCollectionConfig.validate
                     }),

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config, Widget } from 'payload'\n\nimport type {\n  AltTextPluginConfig,\n  IncomingAltTextPluginConfig,\n} from './types/AltTextPluginConfig.js'\n\nimport { PLUGIN_SLUG } from './constants.js'\nimport { altTextHealthEndpoint } from './endpoints/altTextHealth.js'\nimport { bulkGenerateAltTextsEndpoint } from './endpoints/bulkGenerateAltTexts.js'\nimport { generateAltTextEndpoint } from './endpoints/generateAltText.js'\nimport { altTextField } from './fields/altTextField.js'\nimport { keywordsField } from './fields/keywordsField.js'\nimport {\n  createRevalidateAltTextHealthAfterChangeHook,\n  createRevalidateAltTextHealthAfterDeleteHook,\n} from './hooks/revalidateAltTextHealth.js'\nimport { translations } from './translations/index.js'\nimport { normalizeCollectionsConfig } from './utilities/mimeTypes.js'\nimport { deepMergeSimple } from './utils/deepMergeSimple.js'\n\nconst altTextHealthWidgetDefinition = {\n  slug: 'alt-text-health',\n  // `Component` was renamed from `ComponentPath` in Payload 3.79.0. Set both for backward compatibility.\n  Component: '@jhb.software/payload-alt-text-plugin/server#AltTextHealthWidget',\n  ComponentPath: '@jhb.software/payload-alt-text-plugin/server#AltTextHealthWidget',\n  label: {\n    de: 'Alternativtexte Zustand',\n    en: 'Alt text health',\n  },\n  maxWidth: 'full',\n  minWidth: 'medium',\n} satisfies { ComponentPath: string } & Widget\n\nexport const payloadAltTextPlugin =\n  (incomingPluginConfig: IncomingAltTextPluginConfig) =>\n  (incomingConfig: Config): Config => {\n    const config = { ...incomingConfig }\n\n    // If the plugin is disabled, return the config without modifying it\n    if (incomingPluginConfig.enabled === false) {\n      return config\n    }\n\n    const locales = config.localization\n      ? config.localization.locales.map((localeConfig) =>\n          typeof localeConfig === 'string' ? localeConfig : localeConfig.code,\n        )\n      : []\n\n    const enableHealthCheck = incomingPluginConfig.healthCheck !== false\n\n    const normalizedCollections = normalizeCollectionsConfig(incomingPluginConfig.collections)\n\n    const access = incomingPluginConfig.access ?? (({ req }) => !!req.user)\n\n    // A function form of `healthCheck` doubles as the health report's access\n    // gate; otherwise it falls back to the shared `access`.\n    const healthCheckAccess =\n      typeof incomingPluginConfig.healthCheck === 'function'\n        ? incomingPluginConfig.healthCheck\n        : access\n\n    const pluginConfig: AltTextPluginConfig = {\n      access,\n      collections: normalizedCollections,\n      enabled: incomingPluginConfig.enabled ?? true,\n      fieldsOverride: incomingPluginConfig.fieldsOverride,\n      getImageThumbnail: incomingPluginConfig.getImageThumbnail,\n      healthCheck: enableHealthCheck,\n      healthCheckAccess,\n      locale: incomingPluginConfig.locale,\n      locales,\n      maxBulkGenerateConcurrency: incomingPluginConfig.maxBulkGenerateConcurrency ?? 16,\n      maxBulkGenerateIds: incomingPluginConfig.maxBulkGenerateIds ?? 100,\n      resolver: incomingPluginConfig.resolver,\n    }\n\n    // Validate locale requirement for non-localized mode\n    if (locales.length === 0 && !incomingPluginConfig.locale) {\n      throw new Error(\n        'The alt-text plugin requires a \"locale\" option when Payload localization is disabled. ' +\n          'Please add { locale: \"en\" } (or your preferred locale) to your plugin configuration.',\n      )\n    }\n\n    const collectionConfigBySlug = new Map<string, (typeof normalizedCollections)[number]>(\n      normalizedCollections.map((entry) => [entry.slug, entry]),\n    )\n\n    // Ensure collections array exists\n    config.collections = config.collections || []\n\n    // Map over collections and inject AI alt text fields into specified ones\n    config.collections = config.collections.map((collectionConfig) => {\n      const altTextCollectionConfig = collectionConfigBySlug.get(collectionConfig.slug)\n\n      if (altTextCollectionConfig) {\n        if (!collectionConfig.upload) {\n          console.warn(\n            `AI Alt Text Plugin: Collection \"${collectionConfig.slug}\" is not an upload collection. Skipping field injection.`,\n          )\n          return collectionConfig\n        }\n\n        const defaultFields = [\n          altTextField({\n            localized: Boolean(config.localization),\n            supportedMimeTypes: pluginConfig.resolver.supportedMimeTypes,\n            trackedMimeTypes: altTextCollectionConfig.mimeTypes,\n            validate: altTextCollectionConfig.validate,\n          }),\n          keywordsField({\n            localized: Boolean(config.localization),\n          }),\n        ]\n\n        const fields =\n          incomingPluginConfig.fieldsOverride &&\n          typeof incomingPluginConfig.fieldsOverride === 'function'\n            ? incomingPluginConfig.fieldsOverride({ defaultFields })\n            : defaultFields\n\n        return {\n          ...collectionConfig,\n          admin: {\n            ...collectionConfig.admin,\n            components: {\n              ...(collectionConfig.admin?.components ?? {}),\n              // TODO: use the beforeBulkAction custom component slot once available: https://github.com/payloadcms/payload/pull/11719\n              beforeListTable: [\n                ...(collectionConfig.admin?.components?.beforeListTable ?? []),\n                {\n                  path: '@jhb.software/payload-alt-text-plugin/client#BulkGenerateAltTextsButton',\n                  props: {\n                    collectionSlug: collectionConfig.slug,\n                  },\n                },\n              ],\n            },\n            // enhance the search by adding the filename, keywords and alt fields (if the user has not provided their own listSearchableFields)\n            listSearchableFields: collectionConfig.admin?.listSearchableFields ?? [\n              'filename',\n              'keywords',\n              'alt',\n            ],\n          },\n          fields: [...(collectionConfig.fields ?? []), ...fields],\n          hooks: {\n            ...collectionConfig.hooks,\n            ...(enableHealthCheck && {\n              afterChange: [\n                ...(collectionConfig.hooks?.afterChange ?? []),\n                createRevalidateAltTextHealthAfterChangeHook(collectionConfig.slug),\n              ],\n              afterDelete: [\n                ...(collectionConfig.hooks?.afterDelete ?? []),\n                createRevalidateAltTextHealthAfterDeleteHook(collectionConfig.slug),\n              ],\n            }),\n          },\n        }\n      }\n\n      return collectionConfig\n    })\n\n    const existingWidgets = config.admin?.dashboard?.widgets ?? []\n    const widgets =\n      !enableHealthCheck || existingWidgets.some((widget) => widget.slug === 'alt-text-health')\n        ? existingWidgets\n        : [...existingWidgets, altTextHealthWidgetDefinition]\n\n    return {\n      ...config,\n      admin: {\n        ...config.admin,\n        dashboard: {\n          ...config.admin?.dashboard,\n          widgets,\n        },\n      },\n      custom: {\n        ...config.custom,\n        // Make plugin config available in hooks/actions\n        altTextPluginConfig: pluginConfig,\n      },\n      endpoints: [\n        ...(config.endpoints ?? []),\n        {\n          handler: generateAltTextEndpoint(pluginConfig.access),\n          method: 'post',\n          path: `/${PLUGIN_SLUG}/generate`,\n        },\n        {\n          handler: bulkGenerateAltTextsEndpoint(pluginConfig.access),\n          method: 'post',\n          path: `/${PLUGIN_SLUG}/generate/bulk`,\n        },\n        ...(enableHealthCheck\n          ? [\n              {\n                handler: altTextHealthEndpoint(pluginConfig.healthCheckAccess),\n                method: 'get' as const,\n                path: `/${PLUGIN_SLUG}/health`,\n              },\n            ]\n          : []),\n      ],\n      i18n: {\n        ...config.i18n,\n        translations: deepMergeSimple(translations, incomingConfig.i18n?.translations ?? {}),\n      },\n    }\n  }\n"],"names":["PLUGIN_SLUG","altTextHealthEndpoint","bulkGenerateAltTextsEndpoint","generateAltTextEndpoint","altTextField","keywordsField","createRevalidateAltTextHealthAfterChangeHook","createRevalidateAltTextHealthAfterDeleteHook","translations","normalizeCollectionsConfig","deepMergeSimple","altTextHealthWidgetDefinition","slug","Component","ComponentPath","label","de","en","maxWidth","minWidth","payloadAltTextPlugin","incomingPluginConfig","incomingConfig","config","enabled","locales","localization","map","localeConfig","code","enableHealthCheck","healthCheck","normalizedCollections","collections","access","req","user","healthCheckAccess","pluginConfig","fieldsOverride","getImageThumbnail","locale","maxBulkGenerateConcurrency","maxBulkGenerateIds","resolver","length","Error","collectionConfigBySlug","Map","entry","collectionConfig","altTextCollectionConfig","get","upload","console","warn","defaultFields","localized","Boolean","supportedMimeTypes","trackedMimeTypes","mimeTypes","validate","fields","admin","components","beforeListTable","path","props","collectionSlug","listSearchableFields","hooks","afterChange","afterDelete","existingWidgets","dashboard","widgets","some","widget","custom","altTextPluginConfig","endpoints","handler","method","i18n"],"mappings":"AAOA,SAASA,WAAW,QAAQ,iBAAgB;AAC5C,SAASC,qBAAqB,QAAQ,+BAA8B;AACpE,SAASC,4BAA4B,QAAQ,sCAAqC;AAClF,SAASC,uBAAuB,QAAQ,iCAAgC;AACxE,SAASC,YAAY,QAAQ,2BAA0B;AACvD,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SACEC,4CAA4C,EAC5CC,4CAA4C,QACvC,qCAAoC;AAC3C,SAASC,YAAY,QAAQ,0BAAyB;AACtD,SAASC,0BAA0B,QAAQ,2BAA0B;AACrE,SAASC,eAAe,QAAQ,6BAA4B;AAE5D,MAAMC,gCAAgC;IACpCC,MAAM;IACN,uGAAuG;IACvGC,WAAW;IACXC,eAAe;IACfC,OAAO;QACLC,IAAI;QACJC,IAAI;IACN;IACAC,UAAU;IACVC,UAAU;AACZ;AAEA,OAAO,MAAMC,uBACX,CAACC,uBACD,CAACC;QACC,MAAMC,SAAS;YAAE,GAAGD,cAAc;QAAC;QAEnC,oEAAoE;QACpE,IAAID,qBAAqBG,OAAO,KAAK,OAAO;YAC1C,OAAOD;QACT;QAEA,MAAME,UAAUF,OAAOG,YAAY,GAC/BH,OAAOG,YAAY,CAACD,OAAO,CAACE,GAAG,CAAC,CAACC,eAC/B,OAAOA,iBAAiB,WAAWA,eAAeA,aAAaC,IAAI,IAErE,EAAE;QAEN,MAAMC,oBAAoBT,qBAAqBU,WAAW,KAAK;QAE/D,MAAMC,wBAAwBvB,2BAA2BY,qBAAqBY,WAAW;QAEzF,MAAMC,SAASb,qBAAqBa,MAAM,IAAK,CAAA,CAAC,EAAEC,GAAG,EAAE,GAAK,CAAC,CAACA,IAAIC,IAAI,AAAD;QAErE,yEAAyE;QACzE,wDAAwD;QACxD,MAAMC,oBACJ,OAAOhB,qBAAqBU,WAAW,KAAK,aACxCV,qBAAqBU,WAAW,GAChCG;QAEN,MAAMI,eAAoC;YACxCJ;YACAD,aAAaD;YACbR,SAASH,qBAAqBG,OAAO,IAAI;YACzCe,gBAAgBlB,qBAAqBkB,cAAc;YACnDC,mBAAmBnB,qBAAqBmB,iBAAiB;YACzDT,aAAaD;YACbO;YACAI,QAAQpB,qBAAqBoB,MAAM;YACnChB;YACAiB,4BAA4BrB,qBAAqBqB,0BAA0B,IAAI;YAC/EC,oBAAoBtB,qBAAqBsB,kBAAkB,IAAI;YAC/DC,UAAUvB,qBAAqBuB,QAAQ;QACzC;QAEA,qDAAqD;QACrD,IAAInB,QAAQoB,MAAM,KAAK,KAAK,CAACxB,qBAAqBoB,MAAM,EAAE;YACxD,MAAM,IAAIK,MACR,2FACE;QAEN;QAEA,MAAMC,yBAAyB,IAAIC,IACjChB,sBAAsBL,GAAG,CAAC,CAACsB,QAAU;gBAACA,MAAMrC,IAAI;gBAAEqC;aAAM;QAG1D,kCAAkC;QAClC1B,OAAOU,WAAW,GAAGV,OAAOU,WAAW,IAAI,EAAE;QAE7C,yEAAyE;QACzEV,OAAOU,WAAW,GAAGV,OAAOU,WAAW,CAACN,GAAG,CAAC,CAACuB;YAC3C,MAAMC,0BAA0BJ,uBAAuBK,GAAG,CAACF,iBAAiBtC,IAAI;YAEhF,IAAIuC,yBAAyB;gBAC3B,IAAI,CAACD,iBAAiBG,MAAM,EAAE;oBAC5BC,QAAQC,IAAI,CACV,CAAC,gCAAgC,EAAEL,iBAAiBtC,IAAI,CAAC,wDAAwD,CAAC;oBAEpH,OAAOsC;gBACT;gBAEA,MAAMM,gBAAgB;oBACpBpD,aAAa;wBACXqD,WAAWC,QAAQnC,OAAOG,YAAY;wBACtCiC,oBAAoBrB,aAAaM,QAAQ,CAACe,kBAAkB;wBAC5DC,kBAAkBT,wBAAwBU,SAAS;wBACnDC,UAAUX,wBAAwBW,QAAQ;oBAC5C;oBACAzD,cAAc;wBACZoD,WAAWC,QAAQnC,OAAOG,YAAY;oBACxC;iBACD;gBAED,MAAMqC,SACJ1C,qBAAqBkB,cAAc,IACnC,OAAOlB,qBAAqBkB,cAAc,KAAK,aAC3ClB,qBAAqBkB,cAAc,CAAC;oBAAEiB;gBAAc,KACpDA;gBAEN,OAAO;oBACL,GAAGN,gBAAgB;oBACnBc,OAAO;wBACL,GAAGd,iBAAiBc,KAAK;wBACzBC,YAAY;4BACV,GAAIf,iBAAiBc,KAAK,EAAEC,cAAc,CAAC,CAAC;4BAC5C,wHAAwH;4BACxHC,iBAAiB;mCACXhB,iBAAiBc,KAAK,EAAEC,YAAYC,mBAAmB,EAAE;gCAC7D;oCACEC,MAAM;oCACNC,OAAO;wCACLC,gBAAgBnB,iBAAiBtC,IAAI;oCACvC;gCACF;6BACD;wBACH;wBACA,mIAAmI;wBACnI0D,sBAAsBpB,iBAAiBc,KAAK,EAAEM,wBAAwB;4BACpE;4BACA;4BACA;yBACD;oBACH;oBACAP,QAAQ;2BAAKb,iBAAiBa,MAAM,IAAI,EAAE;2BAAMA;qBAAO;oBACvDQ,OAAO;wBACL,GAAGrB,iBAAiBqB,KAAK;wBACzB,GAAIzC,qBAAqB;4BACvB0C,aAAa;mCACPtB,iBAAiBqB,KAAK,EAAEC,eAAe,EAAE;gCAC7ClE,6CAA6C4C,iBAAiBtC,IAAI;6BACnE;4BACD6D,aAAa;mCACPvB,iBAAiBqB,KAAK,EAAEE,eAAe,EAAE;gCAC7ClE,6CAA6C2C,iBAAiBtC,IAAI;6BACnE;wBACH,CAAC;oBACH;gBACF;YACF;YAEA,OAAOsC;QACT;QAEA,MAAMwB,kBAAkBnD,OAAOyC,KAAK,EAAEW,WAAWC,WAAW,EAAE;QAC9D,MAAMA,UACJ,CAAC9C,qBAAqB4C,gBAAgBG,IAAI,CAAC,CAACC,SAAWA,OAAOlE,IAAI,KAAK,qBACnE8D,kBACA;eAAIA;YAAiB/D;SAA8B;QAEzD,OAAO;YACL,GAAGY,MAAM;YACTyC,OAAO;gBACL,GAAGzC,OAAOyC,KAAK;gBACfW,WAAW;oBACT,GAAGpD,OAAOyC,KAAK,EAAEW,SAAS;oBAC1BC;gBACF;YACF;YACAG,QAAQ;gBACN,GAAGxD,OAAOwD,MAAM;gBAChB,gDAAgD;gBAChDC,qBAAqB1C;YACvB;YACA2C,WAAW;mBACL1D,OAAO0D,SAAS,IAAI,EAAE;gBAC1B;oBACEC,SAAS/E,wBAAwBmC,aAAaJ,MAAM;oBACpDiD,QAAQ;oBACRhB,MAAM,CAAC,CAAC,EAAEnE,YAAY,SAAS,CAAC;gBAClC;gBACA;oBACEkF,SAAShF,6BAA6BoC,aAAaJ,MAAM;oBACzDiD,QAAQ;oBACRhB,MAAM,CAAC,CAAC,EAAEnE,YAAY,cAAc,CAAC;gBACvC;mBACI8B,oBACA;oBACE;wBACEoD,SAASjF,sBAAsBqC,aAAaD,iBAAiB;wBAC7D8C,QAAQ;wBACRhB,MAAM,CAAC,CAAC,EAAEnE,YAAY,OAAO,CAAC;oBAChC;iBACD,GACD,EAAE;aACP;YACDoF,MAAM;gBACJ,GAAG7D,OAAO6D,IAAI;gBACd5E,cAAcE,gBAAgBF,cAAcc,eAAe8D,IAAI,EAAE5E,gBAAgB,CAAC;YACpF;QACF;IACF,EAAC"}
+{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config, Widget } from 'payload'\n\nimport type {\n  AltTextPluginConfig,\n  IncomingAltTextPluginConfig,\n} from './types/AltTextPluginConfig.js'\n\nimport { PLUGIN_SLUG } from './constants.js'\nimport { altTextHealthEndpoint } from './endpoints/altTextHealth.js'\nimport { bulkGenerateAltTextsEndpoint } from './endpoints/bulkGenerateAltTexts.js'\nimport { generateAltTextEndpoint } from './endpoints/generateAltText.js'\nimport { altTextField } from './fields/altTextField.js'\nimport { keywordsField } from './fields/keywordsField.js'\nimport {\n  createRevalidateAltTextHealthAfterChangeHook,\n  createRevalidateAltTextHealthAfterDeleteHook,\n} from './hooks/revalidateAltTextHealth.js'\nimport { translations } from './translations/index.js'\nimport { isValidMimeType, normalizeCollectionsConfig } from './utilities/mimeTypes.js'\nimport { deepMergeSimple } from './utils/deepMergeSimple.js'\n\nconst altTextHealthWidgetDefinition = {\n  slug: 'alt-text-health',\n  // `Component` was renamed from `ComponentPath` in Payload 3.79.0. Set both for backward compatibility.\n  Component: '@jhb.software/payload-alt-text-plugin/server#AltTextHealthWidget',\n  ComponentPath: '@jhb.software/payload-alt-text-plugin/server#AltTextHealthWidget',\n  label: {\n    de: 'Alternativtexte Zustand',\n    en: 'Alt text health',\n  },\n  maxWidth: 'full',\n  minWidth: 'medium',\n} satisfies { ComponentPath: string } & Widget\n\nexport const payloadAltTextPlugin =\n  (incomingPluginConfig: IncomingAltTextPluginConfig) =>\n  (incomingConfig: Config): Config => {\n    const config = { ...incomingConfig }\n\n    // If the plugin is disabled, return the config without modifying it\n    if (incomingPluginConfig.enabled === false) {\n      return config\n    }\n\n    const locales = config.localization\n      ? config.localization.locales.map((localeConfig) =>\n          typeof localeConfig === 'string' ? localeConfig : localeConfig.code,\n        )\n      : []\n\n    const enableHealthCheck = incomingPluginConfig.healthCheck !== false\n\n    const normalizedCollections = normalizeCollectionsConfig(incomingPluginConfig.collections, {\n      imageThumbnailMimeType: incomingPluginConfig.imageThumbnailMimeType,\n    })\n\n    // A declared thumbnail MIME type replaces the per-document source check, so a\n    // wrong one fails at boot rather than as a silently missing guard or a 500 per\n    // image.\n    const supportedMimeTypes = incomingPluginConfig.resolver.supportedMimeTypes\n    for (const collection of normalizedCollections) {\n      const declared = collection.imageThumbnailMimeType\n      if (declared === undefined) {\n        continue\n      }\n\n      if (!isValidMimeType(declared)) {\n        throw new Error(\n          `The alt-text plugin is configured with imageThumbnailMimeType \"${declared}\" for the \"${collection.slug}\" collection, ` +\n            'but that is not a valid MIME type. Expected something like \"image/webp\".',\n        )\n      }\n\n      if (supportedMimeTypes && !supportedMimeTypes.includes(declared)) {\n        throw new Error(\n          `The alt-text plugin is configured with imageThumbnailMimeType \"${declared}\" for the \"${collection.slug}\" collection, ` +\n            `but the \"${incomingPluginConfig.resolver.key}\" resolver does not support it. ` +\n            `Supported types: ${supportedMimeTypes.join(', ')}. ` +\n            \"Either change the transformation in getImageThumbnail, or remove the declaration to fall back to checking each document's own mime type.\",\n        )\n      }\n    }\n\n    const access = incomingPluginConfig.access ?? (({ req }) => !!req.user)\n\n    // A function form of `healthCheck` doubles as the health report's access\n    // gate; otherwise it falls back to the shared `access`.\n    const healthCheckAccess =\n      typeof incomingPluginConfig.healthCheck === 'function'\n        ? incomingPluginConfig.healthCheck\n        : access\n\n    const pluginConfig: AltTextPluginConfig = {\n      access,\n      collections: normalizedCollections,\n      enabled: incomingPluginConfig.enabled ?? true,\n      fieldsOverride: incomingPluginConfig.fieldsOverride,\n      getImageThumbnail: incomingPluginConfig.getImageThumbnail,\n      healthCheck: enableHealthCheck,\n      healthCheckAccess,\n      locale: incomingPluginConfig.locale,\n      locales,\n      maxBulkGenerateConcurrency: incomingPluginConfig.maxBulkGenerateConcurrency ?? 16,\n      maxBulkGenerateIds: incomingPluginConfig.maxBulkGenerateIds ?? 100,\n      resolver: incomingPluginConfig.resolver,\n    }\n\n    // Validate locale requirement for non-localized mode\n    if (locales.length === 0 && !incomingPluginConfig.locale) {\n      throw new Error(\n        'The alt-text plugin requires a \"locale\" option when Payload localization is disabled. ' +\n          'Please add { locale: \"en\" } (or your preferred locale) to your plugin configuration.',\n      )\n    }\n\n    const collectionConfigBySlug = new Map<string, (typeof normalizedCollections)[number]>(\n      normalizedCollections.map((entry) => [entry.slug, entry]),\n    )\n\n    // Ensure collections array exists\n    config.collections = config.collections || []\n\n    // Map over collections and inject AI alt text fields into specified ones\n    config.collections = config.collections.map((collectionConfig) => {\n      const altTextCollectionConfig = collectionConfigBySlug.get(collectionConfig.slug)\n\n      if (altTextCollectionConfig) {\n        if (!collectionConfig.upload) {\n          console.warn(\n            `AI Alt Text Plugin: Collection \"${collectionConfig.slug}\" is not an upload collection. Skipping field injection.`,\n          )\n          return collectionConfig\n        }\n\n        const defaultFields = [\n          altTextField({\n            localized: Boolean(config.localization),\n            // When the collection declares what getImageThumbnail delivers, the\n            // document's own mime type says nothing about whether generation can\n            // succeed — so don't let the admin UI disable the button on it.\n            supportedMimeTypes: altTextCollectionConfig.imageThumbnailMimeType\n              ? undefined\n              : pluginConfig.resolver.supportedMimeTypes,\n            trackedMimeTypes: altTextCollectionConfig.mimeTypes,\n            validate: altTextCollectionConfig.validate,\n          }),\n          keywordsField({\n            localized: Boolean(config.localization),\n          }),\n        ]\n\n        const fields =\n          incomingPluginConfig.fieldsOverride &&\n          typeof incomingPluginConfig.fieldsOverride === 'function'\n            ? incomingPluginConfig.fieldsOverride({ defaultFields })\n            : defaultFields\n\n        return {\n          ...collectionConfig,\n          admin: {\n            ...collectionConfig.admin,\n            components: {\n              ...(collectionConfig.admin?.components ?? {}),\n              // TODO: use the beforeBulkAction custom component slot once available: https://github.com/payloadcms/payload/pull/11719\n              beforeListTable: [\n                ...(collectionConfig.admin?.components?.beforeListTable ?? []),\n                {\n                  path: '@jhb.software/payload-alt-text-plugin/client#BulkGenerateAltTextsButton',\n                  props: {\n                    collectionSlug: collectionConfig.slug,\n                  },\n                },\n              ],\n            },\n            // enhance the search by adding the filename, keywords and alt fields (if the user has not provided their own listSearchableFields)\n            listSearchableFields: collectionConfig.admin?.listSearchableFields ?? [\n              'filename',\n              'keywords',\n              'alt',\n            ],\n          },\n          fields: [...(collectionConfig.fields ?? []), ...fields],\n          hooks: {\n            ...collectionConfig.hooks,\n            ...(enableHealthCheck && {\n              afterChange: [\n                ...(collectionConfig.hooks?.afterChange ?? []),\n                createRevalidateAltTextHealthAfterChangeHook(collectionConfig.slug),\n              ],\n              afterDelete: [\n                ...(collectionConfig.hooks?.afterDelete ?? []),\n                createRevalidateAltTextHealthAfterDeleteHook(collectionConfig.slug),\n              ],\n            }),\n          },\n        }\n      }\n\n      return collectionConfig\n    })\n\n    const existingWidgets = config.admin?.dashboard?.widgets ?? []\n    const widgets =\n      !enableHealthCheck || existingWidgets.some((widget) => widget.slug === 'alt-text-health')\n        ? existingWidgets\n        : [...existingWidgets, altTextHealthWidgetDefinition]\n\n    return {\n      ...config,\n      admin: {\n        ...config.admin,\n        dashboard: {\n          ...config.admin?.dashboard,\n          widgets,\n        },\n      },\n      custom: {\n        ...config.custom,\n        // Make plugin config available in hooks/actions\n        altTextPluginConfig: pluginConfig,\n      },\n      endpoints: [\n        ...(config.endpoints ?? []),\n        {\n          handler: generateAltTextEndpoint(pluginConfig.access),\n          method: 'post',\n          path: `/${PLUGIN_SLUG}/generate`,\n        },\n        {\n          handler: bulkGenerateAltTextsEndpoint(pluginConfig.access),\n          method: 'post',\n          path: `/${PLUGIN_SLUG}/generate/bulk`,\n        },\n        ...(enableHealthCheck\n          ? [\n              {\n                handler: altTextHealthEndpoint(pluginConfig.healthCheckAccess),\n                method: 'get' as const,\n                path: `/${PLUGIN_SLUG}/health`,\n              },\n            ]\n          : []),\n      ],\n      i18n: {\n        ...config.i18n,\n        translations: deepMergeSimple(translations, incomingConfig.i18n?.translations ?? {}),\n      },\n    }\n  }\n"],"names":["PLUGIN_SLUG","altTextHealthEndpoint","bulkGenerateAltTextsEndpoint","generateAltTextEndpoint","altTextField","keywordsField","createRevalidateAltTextHealthAfterChangeHook","createRevalidateAltTextHealthAfterDeleteHook","translations","isValidMimeType","normalizeCollectionsConfig","deepMergeSimple","altTextHealthWidgetDefinition","slug","Component","ComponentPath","label","de","en","maxWidth","minWidth","payloadAltTextPlugin","incomingPluginConfig","incomingConfig","config","enabled","locales","localization","map","localeConfig","code","enableHealthCheck","healthCheck","normalizedCollections","collections","imageThumbnailMimeType","supportedMimeTypes","resolver","collection","declared","undefined","Error","includes","key","join","access","req","user","healthCheckAccess","pluginConfig","fieldsOverride","getImageThumbnail","locale","maxBulkGenerateConcurrency","maxBulkGenerateIds","length","collectionConfigBySlug","Map","entry","collectionConfig","altTextCollectionConfig","get","upload","console","warn","defaultFields","localized","Boolean","trackedMimeTypes","mimeTypes","validate","fields","admin","components","beforeListTable","path","props","collectionSlug","listSearchableFields","hooks","afterChange","afterDelete","existingWidgets","dashboard","widgets","some","widget","custom","altTextPluginConfig","endpoints","handler","method","i18n"],"mappings":"AAOA,SAASA,WAAW,QAAQ,iBAAgB;AAC5C,SAASC,qBAAqB,QAAQ,+BAA8B;AACpE,SAASC,4BAA4B,QAAQ,sCAAqC;AAClF,SAASC,uBAAuB,QAAQ,iCAAgC;AACxE,SAASC,YAAY,QAAQ,2BAA0B;AACvD,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SACEC,4CAA4C,EAC5CC,4CAA4C,QACvC,qCAAoC;AAC3C,SAASC,YAAY,QAAQ,0BAAyB;AACtD,SAASC,eAAe,EAAEC,0BAA0B,QAAQ,2BAA0B;AACtF,SAASC,eAAe,QAAQ,6BAA4B;AAE5D,MAAMC,gCAAgC;IACpCC,MAAM;IACN,uGAAuG;IACvGC,WAAW;IACXC,eAAe;IACfC,OAAO;QACLC,IAAI;QACJC,IAAI;IACN;IACAC,UAAU;IACVC,UAAU;AACZ;AAEA,OAAO,MAAMC,uBACX,CAACC,uBACD,CAACC;QACC,MAAMC,SAAS;YAAE,GAAGD,cAAc;QAAC;QAEnC,oEAAoE;QACpE,IAAID,qBAAqBG,OAAO,KAAK,OAAO;YAC1C,OAAOD;QACT;QAEA,MAAME,UAAUF,OAAOG,YAAY,GAC/BH,OAAOG,YAAY,CAACD,OAAO,CAACE,GAAG,CAAC,CAACC,eAC/B,OAAOA,iBAAiB,WAAWA,eAAeA,aAAaC,IAAI,IAErE,EAAE;QAEN,MAAMC,oBAAoBT,qBAAqBU,WAAW,KAAK;QAE/D,MAAMC,wBAAwBvB,2BAA2BY,qBAAqBY,WAAW,EAAE;YACzFC,wBAAwBb,qBAAqBa,sBAAsB;QACrE;QAEA,8EAA8E;QAC9E,+EAA+E;QAC/E,SAAS;QACT,MAAMC,qBAAqBd,qBAAqBe,QAAQ,CAACD,kBAAkB;QAC3E,KAAK,MAAME,cAAcL,sBAAuB;YAC9C,MAAMM,WAAWD,WAAWH,sBAAsB;YAClD,IAAII,aAAaC,WAAW;gBAC1B;YACF;YAEA,IAAI,CAAC/B,gBAAgB8B,WAAW;gBAC9B,MAAM,IAAIE,MACR,CAAC,+DAA+D,EAAEF,SAAS,WAAW,EAAED,WAAWzB,IAAI,CAAC,cAAc,CAAC,GACrH;YAEN;YAEA,IAAIuB,sBAAsB,CAACA,mBAAmBM,QAAQ,CAACH,WAAW;gBAChE,MAAM,IAAIE,MACR,CAAC,+DAA+D,EAAEF,SAAS,WAAW,EAAED,WAAWzB,IAAI,CAAC,cAAc,CAAC,GACrH,CAAC,SAAS,EAAES,qBAAqBe,QAAQ,CAACM,GAAG,CAAC,gCAAgC,CAAC,GAC/E,CAAC,iBAAiB,EAAEP,mBAAmBQ,IAAI,CAAC,MAAM,EAAE,CAAC,GACrD;YAEN;QACF;QAEA,MAAMC,SAASvB,qBAAqBuB,MAAM,IAAK,CAAA,CAAC,EAAEC,GAAG,EAAE,GAAK,CAAC,CAACA,IAAIC,IAAI,AAAD;QAErE,yEAAyE;QACzE,wDAAwD;QACxD,MAAMC,oBACJ,OAAO1B,qBAAqBU,WAAW,KAAK,aACxCV,qBAAqBU,WAAW,GAChCa;QAEN,MAAMI,eAAoC;YACxCJ;YACAX,aAAaD;YACbR,SAASH,qBAAqBG,OAAO,IAAI;YACzCyB,gBAAgB5B,qBAAqB4B,cAAc;YACnDC,mBAAmB7B,qBAAqB6B,iBAAiB;YACzDnB,aAAaD;YACbiB;YACAI,QAAQ9B,qBAAqB8B,MAAM;YACnC1B;YACA2B,4BAA4B/B,qBAAqB+B,0BAA0B,IAAI;YAC/EC,oBAAoBhC,qBAAqBgC,kBAAkB,IAAI;YAC/DjB,UAAUf,qBAAqBe,QAAQ;QACzC;QAEA,qDAAqD;QACrD,IAAIX,QAAQ6B,MAAM,KAAK,KAAK,CAACjC,qBAAqB8B,MAAM,EAAE;YACxD,MAAM,IAAIX,MACR,2FACE;QAEN;QAEA,MAAMe,yBAAyB,IAAIC,IACjCxB,sBAAsBL,GAAG,CAAC,CAAC8B,QAAU;gBAACA,MAAM7C,IAAI;gBAAE6C;aAAM;QAG1D,kCAAkC;QAClClC,OAAOU,WAAW,GAAGV,OAAOU,WAAW,IAAI,EAAE;QAE7C,yEAAyE;QACzEV,OAAOU,WAAW,GAAGV,OAAOU,WAAW,CAACN,GAAG,CAAC,CAAC+B;YAC3C,MAAMC,0BAA0BJ,uBAAuBK,GAAG,CAACF,iBAAiB9C,IAAI;YAEhF,IAAI+C,yBAAyB;gBAC3B,IAAI,CAACD,iBAAiBG,MAAM,EAAE;oBAC5BC,QAAQC,IAAI,CACV,CAAC,gCAAgC,EAAEL,iBAAiB9C,IAAI,CAAC,wDAAwD,CAAC;oBAEpH,OAAO8C;gBACT;gBAEA,MAAMM,gBAAgB;oBACpB7D,aAAa;wBACX8D,WAAWC,QAAQ3C,OAAOG,YAAY;wBACtC,oEAAoE;wBACpE,qEAAqE;wBACrE,gEAAgE;wBAChES,oBAAoBwB,wBAAwBzB,sBAAsB,GAC9DK,YACAS,aAAaZ,QAAQ,CAACD,kBAAkB;wBAC5CgC,kBAAkBR,wBAAwBS,SAAS;wBACnDC,UAAUV,wBAAwBU,QAAQ;oBAC5C;oBACAjE,cAAc;wBACZ6D,WAAWC,QAAQ3C,OAAOG,YAAY;oBACxC;iBACD;gBAED,MAAM4C,SACJjD,qBAAqB4B,cAAc,IACnC,OAAO5B,qBAAqB4B,cAAc,KAAK,aAC3C5B,qBAAqB4B,cAAc,CAAC;oBAAEe;gBAAc,KACpDA;gBAEN,OAAO;oBACL,GAAGN,gBAAgB;oBACnBa,OAAO;wBACL,GAAGb,iBAAiBa,KAAK;wBACzBC,YAAY;4BACV,GAAId,iBAAiBa,KAAK,EAAEC,cAAc,CAAC,CAAC;4BAC5C,wHAAwH;4BACxHC,iBAAiB;mCACXf,iBAAiBa,KAAK,EAAEC,YAAYC,mBAAmB,EAAE;gCAC7D;oCACEC,MAAM;oCACNC,OAAO;wCACLC,gBAAgBlB,iBAAiB9C,IAAI;oCACvC;gCACF;6BACD;wBACH;wBACA,mIAAmI;wBACnIiE,sBAAsBnB,iBAAiBa,KAAK,EAAEM,wBAAwB;4BACpE;4BACA;4BACA;yBACD;oBACH;oBACAP,QAAQ;2BAAKZ,iBAAiBY,MAAM,IAAI,EAAE;2BAAMA;qBAAO;oBACvDQ,OAAO;wBACL,GAAGpB,iBAAiBoB,KAAK;wBACzB,GAAIhD,qBAAqB;4BACvBiD,aAAa;mCACPrB,iBAAiBoB,KAAK,EAAEC,eAAe,EAAE;gCAC7C1E,6CAA6CqD,iBAAiB9C,IAAI;6BACnE;4BACDoE,aAAa;mCACPtB,iBAAiBoB,KAAK,EAAEE,eAAe,EAAE;gCAC7C1E,6CAA6CoD,iBAAiB9C,IAAI;6BACnE;wBACH,CAAC;oBACH;gBACF;YACF;YAEA,OAAO8C;QACT;QAEA,MAAMuB,kBAAkB1D,OAAOgD,KAAK,EAAEW,WAAWC,WAAW,EAAE;QAC9D,MAAMA,UACJ,CAACrD,qBAAqBmD,gBAAgBG,IAAI,CAAC,CAACC,SAAWA,OAAOzE,IAAI,KAAK,qBACnEqE,kBACA;eAAIA;YAAiBtE;SAA8B;QAEzD,OAAO;YACL,GAAGY,MAAM;YACTgD,OAAO;gBACL,GAAGhD,OAAOgD,KAAK;gBACfW,WAAW;oBACT,GAAG3D,OAAOgD,KAAK,EAAEW,SAAS;oBAC1BC;gBACF;YACF;YACAG,QAAQ;gBACN,GAAG/D,OAAO+D,MAAM;gBAChB,gDAAgD;gBAChDC,qBAAqBvC;YACvB;YACAwC,WAAW;mBACLjE,OAAOiE,SAAS,IAAI,EAAE;gBAC1B;oBACEC,SAASvF,wBAAwB8C,aAAaJ,MAAM;oBACpD8C,QAAQ;oBACRhB,MAAM,CAAC,CAAC,EAAE3E,YAAY,SAAS,CAAC;gBAClC;gBACA;oBACE0F,SAASxF,6BAA6B+C,aAAaJ,MAAM;oBACzD8C,QAAQ;oBACRhB,MAAM,CAAC,CAAC,EAAE3E,YAAY,cAAc,CAAC;gBACvC;mBACI+B,oBACA;oBACE;wBACE2D,SAASzF,sBAAsBgD,aAAaD,iBAAiB;wBAC7D2C,QAAQ;wBACRhB,MAAM,CAAC,CAAC,EAAE3E,YAAY,OAAO,CAAC;oBAChC;iBACD,GACD,EAAE;aACP;YACD4F,MAAM;gBACJ,GAAGpE,OAAOoE,IAAI;gBACdpF,cAAcG,gBAAgBH,cAAce,eAAeqE,IAAI,EAAEpF,gBAAgB,CAAC;YACpF;QACF;IACF,EAAC"}

package/dist/resolvers/mistral.d.ts

@@ -0,0 +1,40 @@
+import type { AltTextResolver } from './types.js';
+export type MistralResolverConfig = {
+    /** Mistral API key for authentication */
+    apiKey: string;
+    /**
+     * Base URL of the Mistral API.
+     * @default 'https://api.mistral.ai/v1'
+     */
+    baseUrl?: string;
+    /**
+     * The vision-capable Mistral model to use for alt text generation.
+     *
+     * Must be able to read images — `mistral-medium-latest`,
+     * `mistral-large-latest`, `mistral-small-latest` and the `ministral-*` models
+     * all are.
+     *
+     * @default 'mistral-medium-latest'
+     */
+    model?: string;
+    /**
+     * Abort after this many milliseconds. Covers downloading the image and the
+     * completion call together.
+     * @default 30000
+     */
+    timeoutMs?: number;
+};
+/**
+ * Creates a Mistral-based resolver for alt text generation.
+ *
+ * @example
+ * ```typescript
+ * import { mistralResolver } from '@jhb.software/payload-alt-text-plugin'
+ *
+ * mistralResolver({
+ *   apiKey: process.env.MISTRAL_API_KEY,
+ *   model: 'mistral-medium-latest', // optional, this is the default
+ * })
+ * ```
+ */
+export declare const mistralResolver: (config: MistralResolverConfig) => AltTextResolver;

package/dist/resolvers/mistral.js

@@ -0,0 +1,280 @@
+import { z } from 'zod';
+/**
+ * Image formats the Mistral API accepts.
+ *
+ * Narrower than what an upload collection may hold — SVG and AVIF are missing,
+ * so the endpoint rejects those documents and their generate button stays
+ * disabled instead of failing at the provider.
+ */ const SUPPORTED_MIME_TYPES = [
+    'image/jpeg',
+    'image/png',
+    'image/gif',
+    'image/webp'
+];
+/** Mistral rejects images above 20 MB. */ const MAX_IMAGE_BYTES = 20 * 1024 * 1024;
+const altTextSchema = z.object({
+    altText: z.string().describe('A concise, descriptive alt text for the image'),
+    keywords: z.array(z.string()).describe('Keywords that describe the content of the image')
+});
+/** One schema entry per requested locale, so the model must answer for all of them. */ const schemaForLocales = (locales)=>z.object(Object.fromEntries(locales.map((locale)=>[
+            locale,
+            altTextSchema
+        ])));
+/**
+ * Downloads the image and returns it as a data URI.
+ *
+ * Mistral can fetch an image URL itself, but that path is not dependable for a
+ * CMS. It requires the file to be reachable from the public internet — never
+ * true in local development, and not true for private buckets — and some hosts
+ * refuse Mistral's fetcher outright, which surfaces as `File could not be
+ * fetched from url` (error 3310). Sending the bytes removes that whole class of
+ * failure for the price of one extra download.
+ */ async function fetchImageAsDataUri(url, signal) {
+    let response;
+    try {
+        response = await fetch(url, {
+            signal
+        });
+    } catch (error) {
+        return {
+            error: `Could not download the image from ${url}: ${error instanceof Error ? error.message : 'unknown error'}`
+        };
+    }
+    if (!response.ok) {
+        return {
+            error: `Could not download the image from ${url}: status ${response.status}`
+        };
+    }
+    // The document's mime type is checked by the endpoint before the resolver
+    // runs, but `getImageThumbnail` may point at a derivative in a different
+    // format, so trust what was actually served.
+    const contentType = response.headers.get('content-type')?.split(';')[0]?.trim().toLowerCase();
+    if (!contentType || !SUPPORTED_MIME_TYPES.includes(contentType)) {
+        return {
+            error: `The image at ${url} was served as "${contentType ?? 'an unknown type'}", which Mistral cannot read. Supported types: ${SUPPORTED_MIME_TYPES.join(', ')}.`
+        };
+    }
+    const bytes = Buffer.from(await response.arrayBuffer());
+    if (bytes.byteLength === 0) {
+        return {
+            error: `The image at ${url} was empty.`
+        };
+    }
+    if (bytes.byteLength > MAX_IMAGE_BYTES) {
+        return {
+            error: `The image at ${url} is ${Math.round(bytes.byteLength / 1024 / 1024)} MB, above Mistral's 20 MB limit. Point getImageThumbnail at a smaller image size.`
+        };
+    }
+    return {
+        dataUri: `data:${contentType};base64,${bytes.toString('base64')}`
+    };
+}
+function buildPrompt(locales) {
+    const languages = locales.join(', ');
+    return `
+      You are an expert at analyzing images and creating descriptive image alt text.
+
+      Please analyze the given image and provide the following in ${languages}:
+      - A concise, descriptive alt text (1-2 sentences) as "altText". Focus on the subject, action, and setting. Avoid phrases like 'Image of', 'A picture of', or 'Photo showing'. Be specific and include relevant details like location or context if visible. Make no assumptions.
+      - A list of keywords that describe the content (e.g., ["Camel", "Palm trees", "Desert"]) as "keywords"
+
+      If a context is provided, use it to enhance the alt text.
+
+      Format your response as a JSON object with ${locales.map((locale)=>`"${locale}"`).join(', ')} keys, each containing "altText" and "keywords".
+    `;
+}
+/**
+ * Reads the model's response.
+ *
+ * Deliberately strict about a blank `altText`: the field is required on the
+ * collection, so an empty string would satisfy that requirement while telling a
+ * screen reader nothing — and nobody looks at an alt text again once it is set.
+ */ function parseResults(content, locales) {
+    const parsed = schemaForLocales(locales).safeParse(content);
+    if (!parsed.success) {
+        return null;
+    }
+    const results = {};
+    for (const locale of locales){
+        const entry = parsed.data[locale];
+        if (entry.altText.trim().length === 0) {
+            return null;
+        }
+        results[locale] = {
+            altText: entry.altText.trim(),
+            keywords: entry.keywords
+        };
+    }
+    return results;
+}
+/**
+ * One request, one or more locales.
+ *
+ * All locales go into a single call rather than one call each: the image is
+ * uploaded and analyzed once — the expensive part — and every language ends up
+ * describing the same reading of it.
+ */ async function generate({ apiKey, baseUrl, filename, imageThumbnailUrl, locales, model, timeoutMs }) {
+    if (!apiKey) {
+        return {
+            error: 'No Mistral API key configured',
+            success: false
+        };
+    }
+    if (locales.length === 0) {
+        return {
+            error: 'No locale requested',
+            success: false
+        };
+    }
+    const signal = AbortSignal.timeout(timeoutMs);
+    const image = await fetchImageAsDataUri(imageThumbnailUrl, signal);
+    if ('error' in image) {
+        return {
+            error: image.error,
+            success: false
+        };
+    }
+    try {
+        const response = await fetch(`${baseUrl}/chat/completions`, {
+            body: JSON.stringify({
+                max_tokens: 150 * locales.length,
+                messages: [
+                    {
+                        content: buildPrompt(locales),
+                        role: 'system'
+                    },
+                    {
+                        content: [
+                            {
+                                type: 'image_url',
+                                image_url: image.dataUri
+                            },
+                            ...filename ? [
+                                {
+                                    type: 'text',
+                                    text: filename
+                                }
+                            ] : []
+                        ],
+                        role: 'user'
+                    }
+                ],
+                model,
+                response_format: {
+                    type: 'json_schema',
+                    json_schema: {
+                        name: 'data',
+                        schema: z.toJSONSchema(schemaForLocales(locales), {
+                            target: 'draft-7'
+                        }),
+                        strict: true
+                    }
+                }
+            }),
+            headers: {
+                Authorization: `Bearer ${apiKey}`,
+                'Content-Type': 'application/json'
+            },
+            method: 'POST',
+            signal
+        });
+        if (!response.ok) {
+            const body = await response.text().catch(()=>'');
+            return {
+                error: `Mistral responded with status ${response.status}${body ? `: ${body}` : ''}`,
+                success: false
+            };
+        }
+        const completion = await response.json();
+        const content = completion.choices?.[0]?.message?.content;
+        if (typeof content !== 'string') {
+            return {
+                error: 'No result from Mistral',
+                success: false
+            };
+        }
+        const results = parseResults(JSON.parse(content), locales);
+        if (!results) {
+            return {
+                error: `Mistral did not return a usable alt text for every requested locale (${locales.join(', ')})`,
+                success: false
+            };
+        }
+        return {
+            results,
+            success: true
+        };
+    } catch (error) {
+        console.error('Error generating alt text:', error);
+        return {
+            error: error instanceof Error ? error.message : 'Unknown error',
+            success: false
+        };
+    }
+}
+/**
+ * Creates a Mistral-based resolver for alt text generation.
+ *
+ * @example
+ * ```typescript
+ * import { mistralResolver } from '@jhb.software/payload-alt-text-plugin'
+ *
+ * mistralResolver({
+ *   apiKey: process.env.MISTRAL_API_KEY,
+ *   model: 'mistral-medium-latest', // optional, this is the default
+ * })
+ * ```
+ */ export const mistralResolver = (config)=>{
+    const { apiKey, baseUrl = 'https://api.mistral.ai/v1', model = 'mistral-medium-latest', timeoutMs = 30_000 } = config;
+    return {
+        key: 'mistral',
+        resolve: async ({ filename, imageThumbnailUrl, locale })=>{
+            const result = await generate({
+                apiKey,
+                baseUrl,
+                filename,
+                imageThumbnailUrl,
+                locales: [
+                    locale
+                ],
+                model,
+                timeoutMs
+            });
+            if (!result.success) {
+                return {
+                    error: result.error,
+                    success: false
+                };
+            }
+            return {
+                result: result.results[locale],
+                success: true
+            };
+        },
+        resolveBulk: async ({ filename, imageThumbnailUrl, locales })=>{
+            const result = await generate({
+                apiKey,
+                baseUrl,
+                filename,
+                imageThumbnailUrl,
+                locales,
+                model,
+                timeoutMs
+            });
+            if (!result.success) {
+                return {
+                    error: result.error,
+                    success: false
+                };
+            }
+            return {
+                results: result.results,
+                success: true
+            };
+        },
+        // https://docs.mistral.ai/capabilities/vision/
+        supportedMimeTypes: SUPPORTED_MIME_TYPES
+    };
+};
+
+//# sourceMappingURL=mistral.js.map

package/dist/resolvers/mistral.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/resolvers/mistral.ts"],"sourcesContent":["import { z } from 'zod'\n\nimport type {\n  AltTextBulkResolverArgs,\n  AltTextBulkResolverResponse,\n  AltTextResolver,\n  AltTextResolverArgs,\n  AltTextResolverResponse,\n  AltTextResult,\n} from './types.js'\n\nexport type MistralResolverConfig = {\n  /** Mistral API key for authentication */\n  apiKey: string\n  /**\n   * Base URL of the Mistral API.\n   * @default 'https://api.mistral.ai/v1'\n   */\n  baseUrl?: string\n  /**\n   * The vision-capable Mistral model to use for alt text generation.\n   *\n   * Must be able to read images — `mistral-medium-latest`,\n   * `mistral-large-latest`, `mistral-small-latest` and the `ministral-*` models\n   * all are.\n   *\n   * @default 'mistral-medium-latest'\n   */\n  model?: string\n  /**\n   * Abort after this many milliseconds. Covers downloading the image and the\n   * completion call together.\n   * @default 30000\n   */\n  timeoutMs?: number\n}\n\n/**\n * Image formats the Mistral API accepts.\n *\n * Narrower than what an upload collection may hold — SVG and AVIF are missing,\n * so the endpoint rejects those documents and their generate button stays\n * disabled instead of failing at the provider.\n */\nconst SUPPORTED_MIME_TYPES = ['image/jpeg', 'image/png', 'image/gif', 'image/webp']\n\n/** Mistral rejects images above 20 MB. */\nconst MAX_IMAGE_BYTES = 20 * 1024 * 1024\n\nconst altTextSchema = z.object({\n  altText: z.string().describe('A concise, descriptive alt text for the image'),\n  keywords: z.array(z.string()).describe('Keywords that describe the content of the image'),\n})\n\n/** One schema entry per requested locale, so the model must answer for all of them. */\nconst schemaForLocales = (locales: string[]) =>\n  z.object(Object.fromEntries(locales.map((locale) => [locale, altTextSchema])))\n\n/**\n * Downloads the image and returns it as a data URI.\n *\n * Mistral can fetch an image URL itself, but that path is not dependable for a\n * CMS. It requires the file to be reachable from the public internet — never\n * true in local development, and not true for private buckets — and some hosts\n * refuse Mistral's fetcher outright, which surfaces as `File could not be\n * fetched from url` (error 3310). Sending the bytes removes that whole class of\n * failure for the price of one extra download.\n */\nasync function fetchImageAsDataUri(\n  url: string,\n  signal: AbortSignal,\n): Promise<{ dataUri: string } | { error: string }> {\n  let response: Response\n\n  try {\n    response = await fetch(url, { signal })\n  } catch (error) {\n    return {\n      error: `Could not download the image from ${url}: ${error instanceof Error ? error.message : 'unknown error'}`,\n    }\n  }\n\n  if (!response.ok) {\n    return { error: `Could not download the image from ${url}: status ${response.status}` }\n  }\n\n  // The document's mime type is checked by the endpoint before the resolver\n  // runs, but `getImageThumbnail` may point at a derivative in a different\n  // format, so trust what was actually served.\n  const contentType = response.headers.get('content-type')?.split(';')[0]?.trim().toLowerCase()\n\n  if (!contentType || !SUPPORTED_MIME_TYPES.includes(contentType)) {\n    return {\n      error: `The image at ${url} was served as \"${contentType ?? 'an unknown type'}\", which Mistral cannot read. Supported types: ${SUPPORTED_MIME_TYPES.join(', ')}.`,\n    }\n  }\n\n  const bytes = Buffer.from(await response.arrayBuffer())\n\n  if (bytes.byteLength === 0) {\n    return { error: `The image at ${url} was empty.` }\n  }\n\n  if (bytes.byteLength > MAX_IMAGE_BYTES) {\n    return {\n      error: `The image at ${url} is ${Math.round(bytes.byteLength / 1024 / 1024)} MB, above Mistral's 20 MB limit. Point getImageThumbnail at a smaller image size.`,\n    }\n  }\n\n  return { dataUri: `data:${contentType};base64,${bytes.toString('base64')}` }\n}\n\nfunction buildPrompt(locales: string[]): string {\n  const languages = locales.join(', ')\n\n  return `\n      You are an expert at analyzing images and creating descriptive image alt text.\n\n      Please analyze the given image and provide the following in ${languages}:\n      - A concise, descriptive alt text (1-2 sentences) as \"altText\". Focus on the subject, action, and setting. Avoid phrases like 'Image of', 'A picture of', or 'Photo showing'. Be specific and include relevant details like location or context if visible. Make no assumptions.\n      - A list of keywords that describe the content (e.g., [\"Camel\", \"Palm trees\", \"Desert\"]) as \"keywords\"\n\n      If a context is provided, use it to enhance the alt text.\n\n      Format your response as a JSON object with ${locales.map((locale) => `\"${locale}\"`).join(', ')} keys, each containing \"altText\" and \"keywords\".\n    `\n}\n\n/**\n * Reads the model's response.\n *\n * Deliberately strict about a blank `altText`: the field is required on the\n * collection, so an empty string would satisfy that requirement while telling a\n * screen reader nothing — and nobody looks at an alt text again once it is set.\n */\nfunction parseResults(content: unknown, locales: string[]): null | Record<string, AltTextResult> {\n  const parsed = schemaForLocales(locales).safeParse(content)\n\n  if (!parsed.success) {\n    return null\n  }\n\n  const results: Record<string, AltTextResult> = {}\n\n  for (const locale of locales) {\n    const entry = parsed.data[locale]\n\n    if (entry.altText.trim().length === 0) {\n      return null\n    }\n\n    results[locale] = { altText: entry.altText.trim(), keywords: entry.keywords }\n  }\n\n  return results\n}\n\n/**\n * One request, one or more locales.\n *\n * All locales go into a single call rather than one call each: the image is\n * uploaded and analyzed once — the expensive part — and every language ends up\n * describing the same reading of it.\n */\nasync function generate({\n  apiKey,\n  baseUrl,\n  filename,\n  imageThumbnailUrl,\n  locales,\n  model,\n  timeoutMs,\n}: {\n  apiKey: string\n  baseUrl: string\n  filename?: string\n  imageThumbnailUrl: string\n  locales: string[]\n  model: string\n  timeoutMs: number\n}): Promise<\n  { error: string; success: false } | { results: Record<string, AltTextResult>; success: true }\n> {\n  if (!apiKey) {\n    return { error: 'No Mistral API key configured', success: false }\n  }\n\n  if (locales.length === 0) {\n    return { error: 'No locale requested', success: false }\n  }\n\n  const signal = AbortSignal.timeout(timeoutMs)\n  const image = await fetchImageAsDataUri(imageThumbnailUrl, signal)\n\n  if ('error' in image) {\n    return { error: image.error, success: false }\n  }\n\n  try {\n    const response = await fetch(`${baseUrl}/chat/completions`, {\n      body: JSON.stringify({\n        max_tokens: 150 * locales.length,\n        messages: [\n          { content: buildPrompt(locales), role: 'system' },\n          {\n            content: [\n              { type: 'image_url', image_url: image.dataUri },\n              ...(filename ? [{ type: 'text', text: filename }] : []),\n            ],\n            role: 'user',\n          },\n        ],\n        model,\n        response_format: {\n          type: 'json_schema',\n          json_schema: {\n            name: 'data',\n            schema: z.toJSONSchema(schemaForLocales(locales), { target: 'draft-7' }),\n            strict: true,\n          },\n        },\n      }),\n      headers: { Authorization: `Bearer ${apiKey}`, 'Content-Type': 'application/json' },\n      method: 'POST',\n      signal,\n    })\n\n    if (!response.ok) {\n      const body = await response.text().catch(() => '')\n\n      return {\n        error: `Mistral responded with status ${response.status}${body ? `: ${body}` : ''}`,\n        success: false,\n      }\n    }\n\n    const completion = (await response.json()) as {\n      choices?: { message?: { content?: unknown } }[]\n    }\n    const content = completion.choices?.[0]?.message?.content\n\n    if (typeof content !== 'string') {\n      return { error: 'No result from Mistral', success: false }\n    }\n\n    const results = parseResults(JSON.parse(content), locales)\n\n    if (!results) {\n      return {\n        error: `Mistral did not return a usable alt text for every requested locale (${locales.join(', ')})`,\n        success: false,\n      }\n    }\n\n    return { results, success: true }\n  } catch (error) {\n    console.error('Error generating alt text:', error)\n\n    return { error: error instanceof Error ? error.message : 'Unknown error', success: false }\n  }\n}\n\n/**\n * Creates a Mistral-based resolver for alt text generation.\n *\n * @example\n * ```typescript\n * import { mistralResolver } from '@jhb.software/payload-alt-text-plugin'\n *\n * mistralResolver({\n *   apiKey: process.env.MISTRAL_API_KEY,\n *   model: 'mistral-medium-latest', // optional, this is the default\n * })\n * ```\n */\nexport const mistralResolver = (config: MistralResolverConfig): AltTextResolver => {\n  const {\n    apiKey,\n    baseUrl = 'https://api.mistral.ai/v1',\n    model = 'mistral-medium-latest',\n    timeoutMs = 30_000,\n  } = config\n\n  return {\n    key: 'mistral',\n    resolve: async ({\n      filename,\n      imageThumbnailUrl,\n      locale,\n    }: AltTextResolverArgs): Promise<AltTextResolverResponse> => {\n      const result = await generate({\n        apiKey,\n        baseUrl,\n        filename,\n        imageThumbnailUrl,\n        locales: [locale],\n        model,\n        timeoutMs,\n      })\n\n      if (!result.success) {\n        return { error: result.error, success: false }\n      }\n\n      return { result: result.results[locale], success: true }\n    },\n    resolveBulk: async ({\n      filename,\n      imageThumbnailUrl,\n      locales,\n    }: AltTextBulkResolverArgs): Promise<AltTextBulkResolverResponse> => {\n      const result = await generate({\n        apiKey,\n        baseUrl,\n        filename,\n        imageThumbnailUrl,\n        locales,\n        model,\n        timeoutMs,\n      })\n\n      if (!result.success) {\n        return { error: result.error, success: false }\n      }\n\n      return { results: result.results, success: true }\n    },\n    // https://docs.mistral.ai/capabilities/vision/\n    supportedMimeTypes: SUPPORTED_MIME_TYPES,\n  }\n}\n"],"names":["z","SUPPORTED_MIME_TYPES","MAX_IMAGE_BYTES","altTextSchema","object","altText","string","describe","keywords","array","schemaForLocales","locales","Object","fromEntries","map","locale","fetchImageAsDataUri","url","signal","response","fetch","error","Error","message","ok","status","contentType","headers","get","split","trim","toLowerCase","includes","join","bytes","Buffer","from","arrayBuffer","byteLength","Math","round","dataUri","toString","buildPrompt","languages","parseResults","content","parsed","safeParse","success","results","entry","data","length","generate","apiKey","baseUrl","filename","imageThumbnailUrl","model","timeoutMs","AbortSignal","timeout","image","body","JSON","stringify","max_tokens","messages","role","type","image_url","text","response_format","json_schema","name","schema","toJSONSchema","target","strict","Authorization","method","catch","completion","json","choices","parse","console","mistralResolver","config","key","resolve","result","resolveBulk","supportedMimeTypes"],"mappings":"AAAA,SAASA,CAAC,QAAQ,MAAK;AAqCvB;;;;;;CAMC,GACD,MAAMC,uBAAuB;IAAC;IAAc;IAAa;IAAa;CAAa;AAEnF,wCAAwC,GACxC,MAAMC,kBAAkB,KAAK,OAAO;AAEpC,MAAMC,gBAAgBH,EAAEI,MAAM,CAAC;IAC7BC,SAASL,EAAEM,MAAM,GAAGC,QAAQ,CAAC;IAC7BC,UAAUR,EAAES,KAAK,CAACT,EAAEM,MAAM,IAAIC,QAAQ,CAAC;AACzC;AAEA,qFAAqF,GACrF,MAAMG,mBAAmB,CAACC,UACxBX,EAAEI,MAAM,CAACQ,OAAOC,WAAW,CAACF,QAAQG,GAAG,CAAC,CAACC,SAAW;YAACA;YAAQZ;SAAc;AAE7E;;;;;;;;;CASC,GACD,eAAea,oBACbC,GAAW,EACXC,MAAmB;IAEnB,IAAIC;IAEJ,IAAI;QACFA,WAAW,MAAMC,MAAMH,KAAK;YAAEC;QAAO;IACvC,EAAE,OAAOG,OAAO;QACd,OAAO;YACLA,OAAO,CAAC,kCAAkC,EAAEJ,IAAI,EAAE,EAAEI,iBAAiBC,QAAQD,MAAME,OAAO,GAAG,iBAAiB;QAChH;IACF;IAEA,IAAI,CAACJ,SAASK,EAAE,EAAE;QAChB,OAAO;YAAEH,OAAO,CAAC,kCAAkC,EAAEJ,IAAI,SAAS,EAAEE,SAASM,MAAM,EAAE;QAAC;IACxF;IAEA,0EAA0E;IAC1E,yEAAyE;IACzE,6CAA6C;IAC7C,MAAMC,cAAcP,SAASQ,OAAO,CAACC,GAAG,CAAC,iBAAiBC,MAAM,IAAI,CAAC,EAAE,EAAEC,OAAOC;IAEhF,IAAI,CAACL,eAAe,CAACzB,qBAAqB+B,QAAQ,CAACN,cAAc;QAC/D,OAAO;YACLL,OAAO,CAAC,aAAa,EAAEJ,IAAI,gBAAgB,EAAES,eAAe,kBAAkB,+CAA+C,EAAEzB,qBAAqBgC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnK;IACF;IAEA,MAAMC,QAAQC,OAAOC,IAAI,CAAC,MAAMjB,SAASkB,WAAW;IAEpD,IAAIH,MAAMI,UAAU,KAAK,GAAG;QAC1B,OAAO;YAAEjB,OAAO,CAAC,aAAa,EAAEJ,IAAI,WAAW,CAAC;QAAC;IACnD;IAEA,IAAIiB,MAAMI,UAAU,GAAGpC,iBAAiB;QACtC,OAAO;YACLmB,OAAO,CAAC,aAAa,EAAEJ,IAAI,IAAI,EAAEsB,KAAKC,KAAK,CAACN,MAAMI,UAAU,GAAG,OAAO,MAAM,kFAAkF,CAAC;QACjK;IACF;IAEA,OAAO;QAAEG,SAAS,CAAC,KAAK,EAAEf,YAAY,QAAQ,EAAEQ,MAAMQ,QAAQ,CAAC,WAAW;IAAC;AAC7E;AAEA,SAASC,YAAYhC,OAAiB;IACpC,MAAMiC,YAAYjC,QAAQsB,IAAI,CAAC;IAE/B,OAAO,CAAC;;;kEAGwD,EAAEW,UAAU;;;;;;iDAM7B,EAAEjC,QAAQG,GAAG,CAAC,CAACC,SAAW,CAAC,CAAC,EAAEA,OAAO,CAAC,CAAC,EAAEkB,IAAI,CAAC,MAAM;IACjG,CAAC;AACL;AAEA;;;;;;CAMC,GACD,SAASY,aAAaC,OAAgB,EAAEnC,OAAiB;IACvD,MAAMoC,SAASrC,iBAAiBC,SAASqC,SAAS,CAACF;IAEnD,IAAI,CAACC,OAAOE,OAAO,EAAE;QACnB,OAAO;IACT;IAEA,MAAMC,UAAyC,CAAC;IAEhD,KAAK,MAAMnC,UAAUJ,QAAS;QAC5B,MAAMwC,QAAQJ,OAAOK,IAAI,CAACrC,OAAO;QAEjC,IAAIoC,MAAM9C,OAAO,CAACyB,IAAI,GAAGuB,MAAM,KAAK,GAAG;YACrC,OAAO;QACT;QAEAH,OAAO,CAACnC,OAAO,GAAG;YAAEV,SAAS8C,MAAM9C,OAAO,CAACyB,IAAI;YAAItB,UAAU2C,MAAM3C,QAAQ;QAAC;IAC9E;IAEA,OAAO0C;AACT;AAEA;;;;;;CAMC,GACD,eAAeI,SAAS,EACtBC,MAAM,EACNC,OAAO,EACPC,QAAQ,EACRC,iBAAiB,EACjB/C,OAAO,EACPgD,KAAK,EACLC,SAAS,EASV;IAGC,IAAI,CAACL,QAAQ;QACX,OAAO;YAAElC,OAAO;YAAiC4B,SAAS;QAAM;IAClE;IAEA,IAAItC,QAAQ0C,MAAM,KAAK,GAAG;QACxB,OAAO;YAAEhC,OAAO;YAAuB4B,SAAS;QAAM;IACxD;IAEA,MAAM/B,SAAS2C,YAAYC,OAAO,CAACF;IACnC,MAAMG,QAAQ,MAAM/C,oBAAoB0C,mBAAmBxC;IAE3D,IAAI,WAAW6C,OAAO;QACpB,OAAO;YAAE1C,OAAO0C,MAAM1C,KAAK;YAAE4B,SAAS;QAAM;IAC9C;IAEA,IAAI;QACF,MAAM9B,WAAW,MAAMC,MAAM,GAAGoC,QAAQ,iBAAiB,CAAC,EAAE;YAC1DQ,MAAMC,KAAKC,SAAS,CAAC;gBACnBC,YAAY,MAAMxD,QAAQ0C,MAAM;gBAChCe,UAAU;oBACR;wBAAEtB,SAASH,YAAYhC;wBAAU0D,MAAM;oBAAS;oBAChD;wBACEvB,SAAS;4BACP;gCAAEwB,MAAM;gCAAaC,WAAWR,MAAMtB,OAAO;4BAAC;+BAC1CgB,WAAW;gCAAC;oCAAEa,MAAM;oCAAQE,MAAMf;gCAAS;6BAAE,GAAG,EAAE;yBACvD;wBACDY,MAAM;oBACR;iBACD;gBACDV;gBACAc,iBAAiB;oBACfH,MAAM;oBACNI,aAAa;wBACXC,MAAM;wBACNC,QAAQ5E,EAAE6E,YAAY,CAACnE,iBAAiBC,UAAU;4BAAEmE,QAAQ;wBAAU;wBACtEC,QAAQ;oBACV;gBACF;YACF;YACApD,SAAS;gBAAEqD,eAAe,CAAC,OAAO,EAAEzB,QAAQ;gBAAE,gBAAgB;YAAmB;YACjF0B,QAAQ;YACR/D;QACF;QAEA,IAAI,CAACC,SAASK,EAAE,EAAE;YAChB,MAAMwC,OAAO,MAAM7C,SAASqD,IAAI,GAAGU,KAAK,CAAC,IAAM;YAE/C,OAAO;gBACL7D,OAAO,CAAC,8BAA8B,EAAEF,SAASM,MAAM,GAAGuC,OAAO,CAAC,EAAE,EAAEA,MAAM,GAAG,IAAI;gBACnFf,SAAS;YACX;QACF;QAEA,MAAMkC,aAAc,MAAMhE,SAASiE,IAAI;QAGvC,MAAMtC,UAAUqC,WAAWE,OAAO,EAAE,CAAC,EAAE,EAAE9D,SAASuB;QAElD,IAAI,OAAOA,YAAY,UAAU;YAC/B,OAAO;gBAAEzB,OAAO;gBAA0B4B,SAAS;YAAM;QAC3D;QAEA,MAAMC,UAAUL,aAAaoB,KAAKqB,KAAK,CAACxC,UAAUnC;QAElD,IAAI,CAACuC,SAAS;YACZ,OAAO;gBACL7B,OAAO,CAAC,qEAAqE,EAAEV,QAAQsB,IAAI,CAAC,MAAM,CAAC,CAAC;gBACpGgB,SAAS;YACX;QACF;QAEA,OAAO;YAAEC;YAASD,SAAS;QAAK;IAClC,EAAE,OAAO5B,OAAO;QACdkE,QAAQlE,KAAK,CAAC,8BAA8BA;QAE5C,OAAO;YAAEA,OAAOA,iBAAiBC,QAAQD,MAAME,OAAO,GAAG;YAAiB0B,SAAS;QAAM;IAC3F;AACF;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,MAAMuC,kBAAkB,CAACC;IAC9B,MAAM,EACJlC,MAAM,EACNC,UAAU,2BAA2B,EACrCG,QAAQ,uBAAuB,EAC/BC,YAAY,MAAM,EACnB,GAAG6B;IAEJ,OAAO;QACLC,KAAK;QACLC,SAAS,OAAO,EACdlC,QAAQ,EACRC,iBAAiB,EACjB3C,MAAM,EACc;YACpB,MAAM6E,SAAS,MAAMtC,SAAS;gBAC5BC;gBACAC;gBACAC;gBACAC;gBACA/C,SAAS;oBAACI;iBAAO;gBACjB4C;gBACAC;YACF;YAEA,IAAI,CAACgC,OAAO3C,OAAO,EAAE;gBACnB,OAAO;oBAAE5B,OAAOuE,OAAOvE,KAAK;oBAAE4B,SAAS;gBAAM;YAC/C;YAEA,OAAO;gBAAE2C,QAAQA,OAAO1C,OAAO,CAACnC,OAAO;gBAAEkC,SAAS;YAAK;QACzD;QACA4C,aAAa,OAAO,EAClBpC,QAAQ,EACRC,iBAAiB,EACjB/C,OAAO,EACiB;YACxB,MAAMiF,SAAS,MAAMtC,SAAS;gBAC5BC;gBACAC;gBACAC;gBACAC;gBACA/C;gBACAgD;gBACAC;YACF;YAEA,IAAI,CAACgC,OAAO3C,OAAO,EAAE;gBACnB,OAAO;oBAAE5B,OAAOuE,OAAOvE,KAAK;oBAAE4B,SAAS;gBAAM;YAC/C;YAEA,OAAO;gBAAEC,SAAS0C,OAAO1C,OAAO;gBAAED,SAAS;YAAK;QAClD;QACA,+CAA+C;QAC/C6C,oBAAoB7F;IACtB;AACF,EAAC"}

package/dist/resolvers/openAI.d.ts

@@ -13,6 +13,16 @@ export type OpenAIResolverConfig = {
      * @default 'gpt-4.1-nano'
      */
     model?: string;
+    /**
+     * The MIME types the provider accepts for the image URL.
+     *
+     * Defaults to the formats documented for OpenAI's vision models. Override it
+     * when pointing `baseUrl` at another provider whose accepted formats differ —
+     * the person choosing the provider is the one who knows.
+     *
+     * @default ['image/jpeg', 'image/png', 'image/gif', 'image/webp']
+     */
+    supportedMimeTypes?: string[];
 };
 /**
  * Creates an OpenAI-based resolver for alt text generation.

package/dist/resolvers/openAI.js

@@ -1,6 +1,12 @@
 import OpenAI from 'openai';
 import { makeParseableResponseFormat } from 'openai/lib/parser.mjs';
 import { z } from 'zod';
+/** @see https://platform.openai.com/docs/guides/images-vision */ const OPENAI_SUPPORTED_MIME_TYPES = [
+    'image/jpeg',
+    'image/png',
+    'image/gif',
+    'image/webp'
+];
 /**
  * Creates a chat completion `JSONSchema` response format object from
  * the given Zod schema.
@@ -181,13 +187,7 @@ import { z } from 'zod';
                 };
             }
         },
-        // https://platform.openai.com/docs/guides/images-vision
-        supportedMimeTypes: [
-            'image/jpeg',
-            'image/png',
-            'image/gif',
-            'image/webp'
-        ]
+        supportedMimeTypes: config.supportedMimeTypes ?? OPENAI_SUPPORTED_MIME_TYPES
     };
 };
 

package/dist/resolvers/openAI.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/resolvers/openAI.ts"],"sourcesContent":["import type { AutoParseableResponseFormat } from 'openai/lib/parser.mjs'\nimport type { ChatCompletionContentPartText } from 'openai/resources/chat/completions.mjs'\nimport type { ResponseFormatJSONSchema } from 'openai/resources/shared.mjs'\n\nimport OpenAI from 'openai'\nimport { makeParseableResponseFormat } from 'openai/lib/parser.mjs'\nimport { z } from 'zod'\n\nimport type {\n  AltTextBulkResolverArgs,\n  AltTextBulkResolverResponse,\n  AltTextResolver,\n  AltTextResolverArgs,\n  AltTextResolverResponse,\n} from './types.js'\n\nexport type OpenAIResolverConfig = {\n  /** OpenAI API key for authentication */\n  apiKey: string\n  /**\n   * Base URL for the OpenAI-compatible API.\n   * Use this to point at alternative providers (e.g. Azure, Nebius, local inference).\n   * @default undefined — the OpenAI SDK defaults to 'https://api.openai.com/v1'\n   */\n  baseUrl?: string\n  /**\n   * The OpenAI LLM model to use for alt text generation.\n   * @default 'gpt-4.1-nano'\n   */\n  model?: string\n}\n\n/**\n * Creates a chat completion `JSONSchema` response format object from\n * the given Zod schema.\n *\n * This is a temporary drop in replacement for the zodResponseFormat from openai/helpers/zod.ts\n * because of issue https://github.com/openai/openai-node/issues/1576\n */\nfunction zodResponseFormat<ZodInput extends z.ZodType>(\n  zodObject: ZodInput,\n  name: string,\n  props?: Omit<ResponseFormatJSONSchema.JSONSchema, 'name' | 'schema' | 'strict'>,\n): AutoParseableResponseFormat<z.infer<ZodInput>> {\n  return makeParseableResponseFormat(\n    {\n      type: 'json_schema',\n      json_schema: {\n        ...props,\n        name,\n        schema: z.toJSONSchema(zodObject, { target: 'draft-7' }),\n        strict: true,\n      },\n    },\n    (content) => zodObject.parse(JSON.parse(content)),\n  )\n}\n\n/**\n * Creates an OpenAI-based resolver for alt text generation.\n *\n * @example\n * ```typescript\n * import { openAIResolver } from '@jhb.software/payload-alt-text-plugin'\n *\n * // OpenAI\n * openAIResolver({\n *   apiKey: process.env.OPENAI_API_KEY,\n *   model: 'gpt-4.1-mini', // optional, defaults to 'gpt-4.1-nano'\n * })\n *\n * // OpenAI-compatible provider (e.g. Nebius)\n * openAIResolver({\n *   apiKey: process.env.NEBIUS_API_KEY,\n *   baseUrl: 'https://api.tokenfactory.us-central1.nebius.com/v1',\n *   model: 'Qwen/Qwen2.5-VL-72B-Instruct',\n * })\n * ```\n */\nexport const openAIResolver = (config: OpenAIResolverConfig): AltTextResolver => {\n  const { apiKey, baseUrl, model = 'gpt-4.1-nano' } = config\n\n  // Build the client lazily (once, on first use): the `resolver` argument is\n  // evaluated even when the plugin is disabled, so eager construction would\n  // throw on a keyless `enabled: !!process.env.OPENAI_API_KEY` setup.\n  let openai: OpenAI | undefined\n  const getClient = (): OpenAI => (openai ??= new OpenAI({ apiKey, baseURL: baseUrl }))\n\n  return {\n    key: 'openai',\n    resolve: async ({\n      filename,\n      imageThumbnailUrl,\n      locale,\n    }: AltTextResolverArgs): Promise<AltTextResolverResponse> => {\n      try {\n        const modelResponseSchema = z.object({\n          altText: z.string().describe('A concise, descriptive alt text for the image'),\n          keywords: z.array(z.string()).describe('Keywords that describe the content of the image'),\n        })\n\n        const response = await getClient().chat.completions.parse({\n          max_completion_tokens: 150,\n          messages: [\n            {\n              content: `\n            You are an expert at analyzing images and creating descriptive image alt text.\n\n            Please analyze the given image and provide the following:\n            - A concise, descriptive alt text (1-2 sentences) as \"altText\". Focus on the subject, action, and setting. Avoid phrases like 'Image of', 'A picture of', or 'Photo showing'. Be specific and include relevant details like location or context if visible. Make no assumptions.\n            - A list of keywords that describe the content (e.g., [\"Camel\", \"Palm trees\", \"Desert\"]) as \"keywords\"\n\n            If a context is provided, use it to enhance the alt text.\n\n            Format your response as a JSON object. You must respond in the ${locale} language.\n          `,\n              role: 'system',\n            },\n            {\n              content: [\n                {\n                  type: 'image_url',\n                  image_url: { url: imageThumbnailUrl },\n                },\n                ...(filename\n                  ? [\n                      {\n                        type: 'text',\n                        text: filename,\n                      } satisfies ChatCompletionContentPartText,\n                    ]\n                  : []),\n              ],\n              role: 'user',\n            },\n          ],\n          model,\n          response_format: zodResponseFormat(modelResponseSchema, 'data'),\n        })\n\n        const result = response.choices[0]?.message?.parsed\n\n        if (!result) {\n          return { error: 'No result from OpenAI', success: false }\n        }\n\n        return {\n          result,\n          success: true,\n        }\n      } catch (error) {\n        console.error('Error generating alt text:', error)\n        return {\n          error: error instanceof Error ? error.message : 'Unknown error',\n          success: false,\n        }\n      }\n    },\n    resolveBulk: async ({\n      filename,\n      imageThumbnailUrl,\n      locales,\n    }: AltTextBulkResolverArgs): Promise<AltTextBulkResolverResponse> => {\n      try {\n        const modelResponseSchema = z.object(\n          Object.fromEntries(\n            locales.map((locale) => [\n              locale,\n              z.object({\n                altText: z.string().describe('A concise, descriptive alt text for the image'),\n                keywords: z\n                  .array(z.string())\n                  .describe('Keywords that describe the content of the image'),\n              }),\n            ]),\n          ),\n        )\n\n        const response = await getClient().chat.completions.parse({\n          max_completion_tokens: 300,\n          messages: [\n            {\n              content: `\n      You are an expert at analyzing images and creating descriptive image alt text.\n\n      Please analyze the given image and provide the following in ${locales.join(', ')}:\n      - A concise, localized descriptive alt text (1-2 sentences) as \"altText\". Focus on the subject, action, and setting. Avoid phrases like 'Image of', 'A picture of', or 'Photo showing'. Be specific and include relevant details like location or context if visible. Make no assumptions.\n      - A localized list of keywords that describe the content (e.g., [\"Camel\", \"Palm trees\", \"Desert\"]) as \"keywords\"\n\n      If a context is provided, use it to enhance the alt text.\n\n      Format your response as a JSON object with ${locales.join(', ')} keys, each containing \"altText\" and \"keywords\".\n    `,\n              role: 'system',\n            },\n            {\n              content: [\n                {\n                  type: 'image_url',\n                  image_url: { url: imageThumbnailUrl },\n                },\n                ...(filename\n                  ? [\n                      {\n                        type: 'text',\n                        text: filename,\n                      } satisfies ChatCompletionContentPartText,\n                    ]\n                  : []),\n              ],\n              role: 'user',\n            },\n          ],\n          model,\n          response_format: zodResponseFormat(modelResponseSchema, 'data'),\n        })\n\n        const result = response.choices[0]?.message?.parsed\n\n        if (!result) {\n          return { error: 'No result from OpenAI', success: false }\n        }\n\n        return {\n          results: result,\n          success: true,\n        }\n      } catch (error) {\n        console.error('Error generating bulk alt text:', error)\n        return {\n          error: error instanceof Error ? error.message : 'Unknown error',\n          success: false,\n        }\n      }\n    },\n    // https://platform.openai.com/docs/guides/images-vision\n    supportedMimeTypes: ['image/jpeg', 'image/png', 'image/gif', 'image/webp'],\n  }\n}\n"],"names":["OpenAI","makeParseableResponseFormat","z","zodResponseFormat","zodObject","name","props","type","json_schema","schema","toJSONSchema","target","strict","content","parse","JSON","openAIResolver","config","apiKey","baseUrl","model","openai","getClient","baseURL","key","resolve","filename","imageThumbnailUrl","locale","modelResponseSchema","object","altText","string","describe","keywords","array","response","chat","completions","max_completion_tokens","messages","role","image_url","url","text","response_format","result","choices","message","parsed","error","success","console","Error","resolveBulk","locales","Object","fromEntries","map","join","results","supportedMimeTypes"],"mappings":"AAIA,OAAOA,YAAY,SAAQ;AAC3B,SAASC,2BAA2B,QAAQ,wBAAuB;AACnE,SAASC,CAAC,QAAQ,MAAK;AA0BvB;;;;;;CAMC,GACD,SAASC,kBACPC,SAAmB,EACnBC,IAAY,EACZC,KAA+E;IAE/E,OAAOL,4BACL;QACEM,MAAM;QACNC,aAAa;YACX,GAAGF,KAAK;YACRD;YACAI,QAAQP,EAAEQ,YAAY,CAACN,WAAW;gBAAEO,QAAQ;YAAU;YACtDC,QAAQ;QACV;IACF,GACA,CAACC,UAAYT,UAAUU,KAAK,CAACC,KAAKD,KAAK,CAACD;AAE5C;AAEA;;;;;;;;;;;;;;;;;;;;CAoBC,GACD,OAAO,MAAMG,iBAAiB,CAACC;IAC7B,MAAM,EAAEC,MAAM,EAAEC,OAAO,EAAEC,QAAQ,cAAc,EAAE,GAAGH;IAEpD,2EAA2E;IAC3E,0EAA0E;IAC1E,oEAAoE;IACpE,IAAII;IACJ,MAAMC,YAAY,IAAeD,WAAW,IAAIrB,OAAO;YAAEkB;YAAQK,SAASJ;QAAQ;IAElF,OAAO;QACLK,KAAK;QACLC,SAAS,OAAO,EACdC,QAAQ,EACRC,iBAAiB,EACjBC,MAAM,EACc;YACpB,IAAI;gBACF,MAAMC,sBAAsB3B,EAAE4B,MAAM,CAAC;oBACnCC,SAAS7B,EAAE8B,MAAM,GAAGC,QAAQ,CAAC;oBAC7BC,UAAUhC,EAAEiC,KAAK,CAACjC,EAAE8B,MAAM,IAAIC,QAAQ,CAAC;gBACzC;gBAEA,MAAMG,WAAW,MAAMd,YAAYe,IAAI,CAACC,WAAW,CAACxB,KAAK,CAAC;oBACxDyB,uBAAuB;oBACvBC,UAAU;wBACR;4BACE3B,SAAS,CAAC;;;;;;;;;2EASmD,EAAEe,OAAO;UAC1E,CAAC;4BACGa,MAAM;wBACR;wBACA;4BACE5B,SAAS;gCACP;oCACEN,MAAM;oCACNmC,WAAW;wCAAEC,KAAKhB;oCAAkB;gCACtC;mCACID,WACA;oCACE;wCACEnB,MAAM;wCACNqC,MAAMlB;oCACR;iCACD,GACD,EAAE;6BACP;4BACDe,MAAM;wBACR;qBACD;oBACDrB;oBACAyB,iBAAiB1C,kBAAkB0B,qBAAqB;gBAC1D;gBAEA,MAAMiB,SAASV,SAASW,OAAO,CAAC,EAAE,EAAEC,SAASC;gBAE7C,IAAI,CAACH,QAAQ;oBACX,OAAO;wBAAEI,OAAO;wBAAyBC,SAAS;oBAAM;gBAC1D;gBAEA,OAAO;oBACLL;oBACAK,SAAS;gBACX;YACF,EAAE,OAAOD,OAAO;gBACdE,QAAQF,KAAK,CAAC,8BAA8BA;gBAC5C,OAAO;oBACLA,OAAOA,iBAAiBG,QAAQH,MAAMF,OAAO,GAAG;oBAChDG,SAAS;gBACX;YACF;QACF;QACAG,aAAa,OAAO,EAClB5B,QAAQ,EACRC,iBAAiB,EACjB4B,OAAO,EACiB;YACxB,IAAI;gBACF,MAAM1B,sBAAsB3B,EAAE4B,MAAM,CAClC0B,OAAOC,WAAW,CAChBF,QAAQG,GAAG,CAAC,CAAC9B,SAAW;wBACtBA;wBACA1B,EAAE4B,MAAM,CAAC;4BACPC,SAAS7B,EAAE8B,MAAM,GAAGC,QAAQ,CAAC;4BAC7BC,UAAUhC,EACPiC,KAAK,CAACjC,EAAE8B,MAAM,IACdC,QAAQ,CAAC;wBACd;qBACD;gBAIL,MAAMG,WAAW,MAAMd,YAAYe,IAAI,CAACC,WAAW,CAACxB,KAAK,CAAC;oBACxDyB,uBAAuB;oBACvBC,UAAU;wBACR;4BACE3B,SAAS,CAAC;;;kEAG0C,EAAE0C,QAAQI,IAAI,CAAC,MAAM;;;;;;iDAMtC,EAAEJ,QAAQI,IAAI,CAAC,MAAM;IAClE,CAAC;4BACSlB,MAAM;wBACR;wBACA;4BACE5B,SAAS;gCACP;oCACEN,MAAM;oCACNmC,WAAW;wCAAEC,KAAKhB;oCAAkB;gCACtC;mCACID,WACA;oCACE;wCACEnB,MAAM;wCACNqC,MAAMlB;oCACR;iCACD,GACD,EAAE;6BACP;4BACDe,MAAM;wBACR;qBACD;oBACDrB;oBACAyB,iBAAiB1C,kBAAkB0B,qBAAqB;gBAC1D;gBAEA,MAAMiB,SAASV,SAASW,OAAO,CAAC,EAAE,EAAEC,SAASC;gBAE7C,IAAI,CAACH,QAAQ;oBACX,OAAO;wBAAEI,OAAO;wBAAyBC,SAAS;oBAAM;gBAC1D;gBAEA,OAAO;oBACLS,SAASd;oBACTK,SAAS;gBACX;YACF,EAAE,OAAOD,OAAO;gBACdE,QAAQF,KAAK,CAAC,mCAAmCA;gBACjD,OAAO;oBACLA,OAAOA,iBAAiBG,QAAQH,MAAMF,OAAO,GAAG;oBAChDG,SAAS;gBACX;YACF;QACF;QACA,wDAAwD;QACxDU,oBAAoB;YAAC;YAAc;YAAa;YAAa;SAAa;IAC5E;AACF,EAAC"}
+{"version":3,"sources":["../../src/resolvers/openAI.ts"],"sourcesContent":["import type { AutoParseableResponseFormat } from 'openai/lib/parser.mjs'\nimport type { ChatCompletionContentPartText } from 'openai/resources/chat/completions.mjs'\nimport type { ResponseFormatJSONSchema } from 'openai/resources/shared.mjs'\n\nimport OpenAI from 'openai'\nimport { makeParseableResponseFormat } from 'openai/lib/parser.mjs'\nimport { z } from 'zod'\n\nimport type {\n  AltTextBulkResolverArgs,\n  AltTextBulkResolverResponse,\n  AltTextResolver,\n  AltTextResolverArgs,\n  AltTextResolverResponse,\n} from './types.js'\n\nexport type OpenAIResolverConfig = {\n  /** OpenAI API key for authentication */\n  apiKey: string\n  /**\n   * Base URL for the OpenAI-compatible API.\n   * Use this to point at alternative providers (e.g. Azure, Nebius, local inference).\n   * @default undefined — the OpenAI SDK defaults to 'https://api.openai.com/v1'\n   */\n  baseUrl?: string\n  /**\n   * The OpenAI LLM model to use for alt text generation.\n   * @default 'gpt-4.1-nano'\n   */\n  model?: string\n  /**\n   * The MIME types the provider accepts for the image URL.\n   *\n   * Defaults to the formats documented for OpenAI's vision models. Override it\n   * when pointing `baseUrl` at another provider whose accepted formats differ —\n   * the person choosing the provider is the one who knows.\n   *\n   * @default ['image/jpeg', 'image/png', 'image/gif', 'image/webp']\n   */\n  supportedMimeTypes?: string[]\n}\n\n/** @see https://platform.openai.com/docs/guides/images-vision */\nconst OPENAI_SUPPORTED_MIME_TYPES = ['image/jpeg', 'image/png', 'image/gif', 'image/webp']\n\n/**\n * Creates a chat completion `JSONSchema` response format object from\n * the given Zod schema.\n *\n * This is a temporary drop in replacement for the zodResponseFormat from openai/helpers/zod.ts\n * because of issue https://github.com/openai/openai-node/issues/1576\n */\nfunction zodResponseFormat<ZodInput extends z.ZodType>(\n  zodObject: ZodInput,\n  name: string,\n  props?: Omit<ResponseFormatJSONSchema.JSONSchema, 'name' | 'schema' | 'strict'>,\n): AutoParseableResponseFormat<z.infer<ZodInput>> {\n  return makeParseableResponseFormat(\n    {\n      type: 'json_schema',\n      json_schema: {\n        ...props,\n        name,\n        schema: z.toJSONSchema(zodObject, { target: 'draft-7' }),\n        strict: true,\n      },\n    },\n    (content) => zodObject.parse(JSON.parse(content)),\n  )\n}\n\n/**\n * Creates an OpenAI-based resolver for alt text generation.\n *\n * @example\n * ```typescript\n * import { openAIResolver } from '@jhb.software/payload-alt-text-plugin'\n *\n * // OpenAI\n * openAIResolver({\n *   apiKey: process.env.OPENAI_API_KEY,\n *   model: 'gpt-4.1-mini', // optional, defaults to 'gpt-4.1-nano'\n * })\n *\n * // OpenAI-compatible provider (e.g. Nebius)\n * openAIResolver({\n *   apiKey: process.env.NEBIUS_API_KEY,\n *   baseUrl: 'https://api.tokenfactory.us-central1.nebius.com/v1',\n *   model: 'Qwen/Qwen2.5-VL-72B-Instruct',\n * })\n * ```\n */\nexport const openAIResolver = (config: OpenAIResolverConfig): AltTextResolver => {\n  const { apiKey, baseUrl, model = 'gpt-4.1-nano' } = config\n\n  // Build the client lazily (once, on first use): the `resolver` argument is\n  // evaluated even when the plugin is disabled, so eager construction would\n  // throw on a keyless `enabled: !!process.env.OPENAI_API_KEY` setup.\n  let openai: OpenAI | undefined\n  const getClient = (): OpenAI => (openai ??= new OpenAI({ apiKey, baseURL: baseUrl }))\n\n  return {\n    key: 'openai',\n    resolve: async ({\n      filename,\n      imageThumbnailUrl,\n      locale,\n    }: AltTextResolverArgs): Promise<AltTextResolverResponse> => {\n      try {\n        const modelResponseSchema = z.object({\n          altText: z.string().describe('A concise, descriptive alt text for the image'),\n          keywords: z.array(z.string()).describe('Keywords that describe the content of the image'),\n        })\n\n        const response = await getClient().chat.completions.parse({\n          max_completion_tokens: 150,\n          messages: [\n            {\n              content: `\n            You are an expert at analyzing images and creating descriptive image alt text.\n\n            Please analyze the given image and provide the following:\n            - A concise, descriptive alt text (1-2 sentences) as \"altText\". Focus on the subject, action, and setting. Avoid phrases like 'Image of', 'A picture of', or 'Photo showing'. Be specific and include relevant details like location or context if visible. Make no assumptions.\n            - A list of keywords that describe the content (e.g., [\"Camel\", \"Palm trees\", \"Desert\"]) as \"keywords\"\n\n            If a context is provided, use it to enhance the alt text.\n\n            Format your response as a JSON object. You must respond in the ${locale} language.\n          `,\n              role: 'system',\n            },\n            {\n              content: [\n                {\n                  type: 'image_url',\n                  image_url: { url: imageThumbnailUrl },\n                },\n                ...(filename\n                  ? [\n                      {\n                        type: 'text',\n                        text: filename,\n                      } satisfies ChatCompletionContentPartText,\n                    ]\n                  : []),\n              ],\n              role: 'user',\n            },\n          ],\n          model,\n          response_format: zodResponseFormat(modelResponseSchema, 'data'),\n        })\n\n        const result = response.choices[0]?.message?.parsed\n\n        if (!result) {\n          return { error: 'No result from OpenAI', success: false }\n        }\n\n        return {\n          result,\n          success: true,\n        }\n      } catch (error) {\n        console.error('Error generating alt text:', error)\n        return {\n          error: error instanceof Error ? error.message : 'Unknown error',\n          success: false,\n        }\n      }\n    },\n    resolveBulk: async ({\n      filename,\n      imageThumbnailUrl,\n      locales,\n    }: AltTextBulkResolverArgs): Promise<AltTextBulkResolverResponse> => {\n      try {\n        const modelResponseSchema = z.object(\n          Object.fromEntries(\n            locales.map((locale) => [\n              locale,\n              z.object({\n                altText: z.string().describe('A concise, descriptive alt text for the image'),\n                keywords: z\n                  .array(z.string())\n                  .describe('Keywords that describe the content of the image'),\n              }),\n            ]),\n          ),\n        )\n\n        const response = await getClient().chat.completions.parse({\n          max_completion_tokens: 300,\n          messages: [\n            {\n              content: `\n      You are an expert at analyzing images and creating descriptive image alt text.\n\n      Please analyze the given image and provide the following in ${locales.join(', ')}:\n      - A concise, localized descriptive alt text (1-2 sentences) as \"altText\". Focus on the subject, action, and setting. Avoid phrases like 'Image of', 'A picture of', or 'Photo showing'. Be specific and include relevant details like location or context if visible. Make no assumptions.\n      - A localized list of keywords that describe the content (e.g., [\"Camel\", \"Palm trees\", \"Desert\"]) as \"keywords\"\n\n      If a context is provided, use it to enhance the alt text.\n\n      Format your response as a JSON object with ${locales.join(', ')} keys, each containing \"altText\" and \"keywords\".\n    `,\n              role: 'system',\n            },\n            {\n              content: [\n                {\n                  type: 'image_url',\n                  image_url: { url: imageThumbnailUrl },\n                },\n                ...(filename\n                  ? [\n                      {\n                        type: 'text',\n                        text: filename,\n                      } satisfies ChatCompletionContentPartText,\n                    ]\n                  : []),\n              ],\n              role: 'user',\n            },\n          ],\n          model,\n          response_format: zodResponseFormat(modelResponseSchema, 'data'),\n        })\n\n        const result = response.choices[0]?.message?.parsed\n\n        if (!result) {\n          return { error: 'No result from OpenAI', success: false }\n        }\n\n        return {\n          results: result,\n          success: true,\n        }\n      } catch (error) {\n        console.error('Error generating bulk alt text:', error)\n        return {\n          error: error instanceof Error ? error.message : 'Unknown error',\n          success: false,\n        }\n      }\n    },\n    supportedMimeTypes: config.supportedMimeTypes ?? OPENAI_SUPPORTED_MIME_TYPES,\n  }\n}\n"],"names":["OpenAI","makeParseableResponseFormat","z","OPENAI_SUPPORTED_MIME_TYPES","zodResponseFormat","zodObject","name","props","type","json_schema","schema","toJSONSchema","target","strict","content","parse","JSON","openAIResolver","config","apiKey","baseUrl","model","openai","getClient","baseURL","key","resolve","filename","imageThumbnailUrl","locale","modelResponseSchema","object","altText","string","describe","keywords","array","response","chat","completions","max_completion_tokens","messages","role","image_url","url","text","response_format","result","choices","message","parsed","error","success","console","Error","resolveBulk","locales","Object","fromEntries","map","join","results","supportedMimeTypes"],"mappings":"AAIA,OAAOA,YAAY,SAAQ;AAC3B,SAASC,2BAA2B,QAAQ,wBAAuB;AACnE,SAASC,CAAC,QAAQ,MAAK;AAoCvB,+DAA+D,GAC/D,MAAMC,8BAA8B;IAAC;IAAc;IAAa;IAAa;CAAa;AAE1F;;;;;;CAMC,GACD,SAASC,kBACPC,SAAmB,EACnBC,IAAY,EACZC,KAA+E;IAE/E,OAAON,4BACL;QACEO,MAAM;QACNC,aAAa;YACX,GAAGF,KAAK;YACRD;YACAI,QAAQR,EAAES,YAAY,CAACN,WAAW;gBAAEO,QAAQ;YAAU;YACtDC,QAAQ;QACV;IACF,GACA,CAACC,UAAYT,UAAUU,KAAK,CAACC,KAAKD,KAAK,CAACD;AAE5C;AAEA;;;;;;;;;;;;;;;;;;;;CAoBC,GACD,OAAO,MAAMG,iBAAiB,CAACC;IAC7B,MAAM,EAAEC,MAAM,EAAEC,OAAO,EAAEC,QAAQ,cAAc,EAAE,GAAGH;IAEpD,2EAA2E;IAC3E,0EAA0E;IAC1E,oEAAoE;IACpE,IAAII;IACJ,MAAMC,YAAY,IAAeD,WAAW,IAAItB,OAAO;YAAEmB;YAAQK,SAASJ;QAAQ;IAElF,OAAO;QACLK,KAAK;QACLC,SAAS,OAAO,EACdC,QAAQ,EACRC,iBAAiB,EACjBC,MAAM,EACc;YACpB,IAAI;gBACF,MAAMC,sBAAsB5B,EAAE6B,MAAM,CAAC;oBACnCC,SAAS9B,EAAE+B,MAAM,GAAGC,QAAQ,CAAC;oBAC7BC,UAAUjC,EAAEkC,KAAK,CAAClC,EAAE+B,MAAM,IAAIC,QAAQ,CAAC;gBACzC;gBAEA,MAAMG,WAAW,MAAMd,YAAYe,IAAI,CAACC,WAAW,CAACxB,KAAK,CAAC;oBACxDyB,uBAAuB;oBACvBC,UAAU;wBACR;4BACE3B,SAAS,CAAC;;;;;;;;;2EASmD,EAAEe,OAAO;UAC1E,CAAC;4BACGa,MAAM;wBACR;wBACA;4BACE5B,SAAS;gCACP;oCACEN,MAAM;oCACNmC,WAAW;wCAAEC,KAAKhB;oCAAkB;gCACtC;mCACID,WACA;oCACE;wCACEnB,MAAM;wCACNqC,MAAMlB;oCACR;iCACD,GACD,EAAE;6BACP;4BACDe,MAAM;wBACR;qBACD;oBACDrB;oBACAyB,iBAAiB1C,kBAAkB0B,qBAAqB;gBAC1D;gBAEA,MAAMiB,SAASV,SAASW,OAAO,CAAC,EAAE,EAAEC,SAASC;gBAE7C,IAAI,CAACH,QAAQ;oBACX,OAAO;wBAAEI,OAAO;wBAAyBC,SAAS;oBAAM;gBAC1D;gBAEA,OAAO;oBACLL;oBACAK,SAAS;gBACX;YACF,EAAE,OAAOD,OAAO;gBACdE,QAAQF,KAAK,CAAC,8BAA8BA;gBAC5C,OAAO;oBACLA,OAAOA,iBAAiBG,QAAQH,MAAMF,OAAO,GAAG;oBAChDG,SAAS;gBACX;YACF;QACF;QACAG,aAAa,OAAO,EAClB5B,QAAQ,EACRC,iBAAiB,EACjB4B,OAAO,EACiB;YACxB,IAAI;gBACF,MAAM1B,sBAAsB5B,EAAE6B,MAAM,CAClC0B,OAAOC,WAAW,CAChBF,QAAQG,GAAG,CAAC,CAAC9B,SAAW;wBACtBA;wBACA3B,EAAE6B,MAAM,CAAC;4BACPC,SAAS9B,EAAE+B,MAAM,GAAGC,QAAQ,CAAC;4BAC7BC,UAAUjC,EACPkC,KAAK,CAAClC,EAAE+B,MAAM,IACdC,QAAQ,CAAC;wBACd;qBACD;gBAIL,MAAMG,WAAW,MAAMd,YAAYe,IAAI,CAACC,WAAW,CAACxB,KAAK,CAAC;oBACxDyB,uBAAuB;oBACvBC,UAAU;wBACR;4BACE3B,SAAS,CAAC;;;kEAG0C,EAAE0C,QAAQI,IAAI,CAAC,MAAM;;;;;;iDAMtC,EAAEJ,QAAQI,IAAI,CAAC,MAAM;IAClE,CAAC;4BACSlB,MAAM;wBACR;wBACA;4BACE5B,SAAS;gCACP;oCACEN,MAAM;oCACNmC,WAAW;wCAAEC,KAAKhB;oCAAkB;gCACtC;mCACID,WACA;oCACE;wCACEnB,MAAM;wCACNqC,MAAMlB;oCACR;iCACD,GACD,EAAE;6BACP;4BACDe,MAAM;wBACR;qBACD;oBACDrB;oBACAyB,iBAAiB1C,kBAAkB0B,qBAAqB;gBAC1D;gBAEA,MAAMiB,SAASV,SAASW,OAAO,CAAC,EAAE,EAAEC,SAASC;gBAE7C,IAAI,CAACH,QAAQ;oBACX,OAAO;wBAAEI,OAAO;wBAAyBC,SAAS;oBAAM;gBAC1D;gBAEA,OAAO;oBACLS,SAASd;oBACTK,SAAS;gBACX;YACF,EAAE,OAAOD,OAAO;gBACdE,QAAQF,KAAK,CAAC,mCAAmCA;gBACjD,OAAO;oBACLA,OAAOA,iBAAiBG,QAAQH,MAAMF,OAAO,GAAG;oBAChDG,SAAS;gBACX;YACF;QACF;QACAU,oBAAoB5C,OAAO4C,kBAAkB,IAAI3D;IACnD;AACF,EAAC"}

package/dist/resolvers/types.d.ts

@@ -14,6 +14,16 @@ export type AltTextResult = {
 export type AltTextResolverArgs = {
     /** Optional filename for additional context */
     filename?: string;
+    /**
+     * The format served at `imageThumbnailUrl`, when the collection declares one
+     * via the plugin's `imageThumbnailMimeType` option. Undefined otherwise.
+     *
+     * Resolvers that hand the URL to the provider can ignore this. Resolvers that
+     * inline the bytes need it — Anthropic image blocks require `media_type`,
+     * Gemini's `inline_data` requires `mime_type`, and neither can be sniffed from
+     * a URL.
+     */
+    imageThumbnailMimeType?: string;
     /** URL of the image thumbnail (must be publicly accessible) */
     imageThumbnailUrl: string;
     /** Target locale for the generated alt text */
@@ -27,6 +37,11 @@ export type AltTextResolverArgs = {
 export type AltTextBulkResolverArgs = {
     /** Optional filename for additional context */
     filename?: string;
+    /**
+     * The format served at `imageThumbnailUrl`, when the collection declares one
+     * via `imageThumbnailMimeType`. See {@link AltTextResolverArgs.imageThumbnailMimeType}.
+     */
+    imageThumbnailMimeType?: string;
     /** URL of the image thumbnail (must be publicly accessible) */
     imageThumbnailUrl: string;
     /** Target locales for the generated alt texts */
@@ -65,6 +80,14 @@ export type AltTextResolver = {
     resolve: (args: AltTextResolverArgs) => Promise<AltTextResolverResponse>;
     /** Generate alt text for a single image in multiple locales (bulk operation) */
     resolveBulk: (args: AltTextBulkResolverArgs) => Promise<AltTextBulkResolverResponse>;
-    /** MIME types this resolver can process. When set, the endpoint rejects files whose mimeType is not in this list. */
+    /**
+     * Formats the provider accepts for the bytes served at `imageThumbnailUrl`.
+     *
+     * When set, the endpoints reject documents whose stored `mimeType` is not in
+     * this list — a conservative proxy, since the resolver never sees the stored
+     * file. A project whose `getImageThumbnail` transcodes should declare the
+     * delivered format via the plugin's `imageThumbnailMimeType` option, which
+     * replaces the proxy with a one-time check against this list at config load.
+     */
     supportedMimeTypes?: string[];
 };