@jhb.software/payload-alt-text-plugin 0.2.2 → 0.3.1

package/dist/types/AltTextPluginConfig.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/AltTextPluginConfig.ts"],"sourcesContent":["import { CollectionSlug, Field } from 'payload'\n\n/** Configuration options for the alt text plugin. */\nexport type IncomingAltTextPluginConfig = {\n  /** Whether the plugin is enabled. */\n  enabled?: boolean\n\n  /** OpenAI API key for authentication. */\n  openAIApiKey: string\n\n  /** Collection slugs to enable the plugin for. */\n  collections: CollectionSlug[]\n\n  /** Maximum number of concurrent API requests for bulk operations. */\n  maxBulkGenerateConcurrency?: number\n\n  /**\n   * Function to get the thumbnail URL of an image document.\n   * This URL will be sent to the LLM for analysis.\n   *\n   * @remarks\n   * - The URL must be publicly accessible so the LLM can fetch it\n   * - Use a thumbnail/preview version of the image when possible (e.g. from the sizes field)\n   */\n  getImageThumbnail: (doc: Record<string, unknown>) => string\n\n  /** The OpenAI LLM model to use for alt text generation. */\n  model?: 'gpt-4.1-nano' | 'gpt-4.1-mini'\n\n  /** Override the default fields inserted by the plugin via a function that receives the default fields and returns the new fields */\n  fieldsOverride?: (args: { defaultFields: Field[] }) => Field[]\n\n  /**\n   * The locale to generate alt texts in when localization is disabled.\n   * Required when localization is disabled, ignored when localization is enabled.\n   * @example 'en', 'de'\n   */\n  locale?: string\n}\n\n/** Configuration of the alt text plugin after defaults have been applied. */\nexport type AltTextPluginConfig = {\n  /** Whether the plugin is enabled. */\n  enabled: boolean\n\n  /** OpenAI API key for authentication. */\n  openAIApiKey: string\n\n  /** Collection slugs to enable the plugin for. */\n  collections: CollectionSlug[]\n\n  /** Maximum number of concurrent API requests for bulk generate operations. */\n  maxBulkGenerateConcurrency: number\n\n  /** Function to get the thumbnail URL of an image document. */\n  getImageThumbnail: (doc: Record<string, unknown>) => string\n\n  /** The OpenAI LLM model to use for alt text generation. */\n  model: 'gpt-4.1-nano' | 'gpt-4.1-mini'\n\n  /** Override the default fields inserted by the plugin via a function that receives the default fields and returns the new fields */\n  fieldsOverride?: (args: { defaultFields: Field[] }) => Field[]\n\n  /** The locales to generate alt texts for. */\n  locales: string[]\n\n  /** The locale to generate alt texts in when localization is disabled. */\n  locale?: string\n}\n"],"names":[],"mappings":"AAwCA,2EAA2E,GAC3E,WA2BC"}
+{"version":3,"sources":["../../src/types/AltTextPluginConfig.ts"],"sourcesContent":["import type { CollectionSlug, Field } from 'payload'\n\nimport type { AltTextResolver } from '../resolvers/types.js'\n\n/** Configuration options for the alt text plugin. */\nexport type IncomingAltTextPluginConfig = {\n  /** Collection slugs to enable the plugin for. */\n  collections: CollectionSlug[]\n\n  /** Whether the plugin is enabled. */\n  enabled?: boolean\n\n  /** Override the default fields inserted by the plugin via a function that receives the default fields and returns the new fields */\n  fieldsOverride?: (args: { defaultFields: Field[] }) => Field[]\n\n  /**\n   * Function to get the thumbnail URL of an image document.\n   * This URL will be sent to the LLM for analysis.\n   *\n   * @remarks\n   * - The URL must be publicly accessible so the LLM can fetch it\n   * - Use a thumbnail/preview version of the image when possible (e.g. from the sizes field)\n   */\n  getImageThumbnail: (doc: Record<string, unknown>) => string\n\n  /**\n   * The locale to generate alt texts in when localization is disabled.\n   *\n   * Required when localization is disabled, ignored when localization is enabled.\n   * @example 'en'\n   */\n  locale?: string\n\n  /**\n   * Maximum number of concurrent API requests for bulk generate operations.\n   *\n   * @default 16\n   */\n  maxBulkGenerateConcurrency?: number\n\n  /** The resolver to use for generating alt text (e.g., openAIResolver) */\n  resolver: AltTextResolver\n}\n\n/** Configuration of the alt text plugin after defaults have been applied. */\nexport type AltTextPluginConfig = {\n  /** Collection slugs to enable the plugin for. */\n  collections: CollectionSlug[]\n\n  /** Whether the plugin is enabled. */\n  enabled: boolean\n\n  /** Override the default fields inserted by the plugin via a function that receives the default fields and returns the new fields */\n  fieldsOverride?: (args: { defaultFields: Field[] }) => Field[]\n\n  /** Function to get the thumbnail URL of an image document. */\n  getImageThumbnail: (doc: Record<string, unknown>) => string\n\n  /** The locale to generate alt texts in when localization is disabled. */\n  locale?: string\n\n  /** The locales to generate alt texts for. */\n  locales: string[]\n\n  /** Maximum number of concurrent API requests for bulk generate operations. */\n  maxBulkGenerateConcurrency: number\n\n  /** The resolver to use for generating alt text */\n  resolver: AltTextResolver\n}\n"],"names":[],"mappings":"AA4CA,2EAA2E,GAC3E,WAwBC"}

package/dist/utilities/localesFromConfig.d.ts

@@ -1,3 +1,3 @@
-import { SanitizedConfig } from 'payload';
+import type { SanitizedConfig } from 'payload';
 /** Returns the locales from the config. Returns undefined when localization is disabled. */
 export declare function localesFromConfig(config: SanitizedConfig): string[] | undefined;

package/dist/utilities/localesFromConfig.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/localesFromConfig.ts"],"sourcesContent":["import { SanitizedConfig } from 'payload'\n\n/** Returns the locales from the config. Returns undefined when localization is disabled. */\nexport function localesFromConfig(config: SanitizedConfig): string[] | undefined {\n  if (typeof config.localization === 'object' && config.localization) {\n    return config.localization.localeCodes\n  } else {\n    return undefined\n  }\n}\n"],"names":["localesFromConfig","config","localization","localeCodes","undefined"],"mappings":"AAEA,0FAA0F,GAC1F,OAAO,SAASA,kBAAkBC,MAAuB;IACvD,IAAI,OAAOA,OAAOC,YAAY,KAAK,YAAYD,OAAOC,YAAY,EAAE;QAClE,OAAOD,OAAOC,YAAY,CAACC,WAAW;IACxC,OAAO;QACL,OAAOC;IACT;AACF"}
+{"version":3,"sources":["../../src/utilities/localesFromConfig.ts"],"sourcesContent":["import type { SanitizedConfig } from 'payload'\n\n/** Returns the locales from the config. Returns undefined when localization is disabled. */\nexport function localesFromConfig(config: SanitizedConfig): string[] | undefined {\n  if (typeof config.localization === 'object' && config.localization) {\n    return config.localization.localeCodes\n  } else {\n    return undefined\n  }\n}\n"],"names":["localesFromConfig","config","localization","localeCodes","undefined"],"mappings":"AAEA,0FAA0F,GAC1F,OAAO,SAASA,kBAAkBC,MAAuB;IACvD,IAAI,OAAOA,OAAOC,YAAY,KAAK,YAAYD,OAAOC,YAAY,EAAE;QAClE,OAAOD,OAAOC,YAAY,CAACC,WAAW;IACxC,OAAO;QACL,OAAOC;IACT;AACF"}

package/dist/utils/translatedLabel.d.ts

@@ -1,3 +1,3 @@
-import { StaticLabel } from 'payload';
+import type { StaticLabel } from 'payload';
 /** Returns the StaticLabel object for the given translation to to use inside the field label. */
 export declare function translatedLabel(key: string): StaticLabel;

package/dist/utils/translatedLabel.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/translatedLabel.ts"],"sourcesContent":["import { StaticLabel } from 'payload'\nimport { translations } from '../translations/index.js'\n\n/** Returns the StaticLabel object for the given translation to to use inside the field label. */\nexport function translatedLabel(key: string): StaticLabel {\n  return Object.fromEntries(\n    Object.entries(translations).map(([locale, translation]) => [\n      locale,\n      (translation['@jhb.software/payload-alt-text-plugin'] as Record<string, string>)[key] || key,\n    ]),\n  )\n}\n"],"names":["translations","translatedLabel","key","Object","fromEntries","entries","map","locale","translation"],"mappings":"AACA,SAASA,YAAY,QAAQ,2BAA0B;AAEvD,+FAA+F,GAC/F,OAAO,SAASC,gBAAgBC,GAAW;IACzC,OAAOC,OAAOC,WAAW,CACvBD,OAAOE,OAAO,CAACL,cAAcM,GAAG,CAAC,CAAC,CAACC,QAAQC,YAAY,GAAK;YAC1DD;YACCC,WAAW,CAAC,wCAAwC,AAA2B,CAACN,IAAI,IAAIA;SAC1F;AAEL"}
+{"version":3,"sources":["../../src/utils/translatedLabel.ts"],"sourcesContent":["import type { StaticLabel } from 'payload'\n\nimport { translations } from '../translations/index.js'\n\n/** Returns the StaticLabel object for the given translation to to use inside the field label. */\nexport function translatedLabel(key: string): StaticLabel {\n  return Object.fromEntries(\n    Object.entries(translations).map(([locale, translation]) => [\n      locale,\n      (translation['@jhb.software/payload-alt-text-plugin'] as Record<string, string>)[key] || key,\n    ]),\n  )\n}\n"],"names":["translations","translatedLabel","key","Object","fromEntries","entries","map","locale","translation"],"mappings":"AAEA,SAASA,YAAY,QAAQ,2BAA0B;AAEvD,+FAA+F,GAC/F,OAAO,SAASC,gBAAgBC,GAAW;IACzC,OAAOC,OAAOC,WAAW,CACvBD,OAAOE,OAAO,CAACL,cAAcM,GAAG,CAAC,CAAC,CAACC,QAAQC,YAAY,GAAK;YAC1DD;YACCC,WAAW,CAAC,wCAAwC,AAA2B,CAACN,IAAI,IAAIA;SAC1F;AAEL"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jhb.software/payload-alt-text-plugin",
-  "version": "0.2.2",
-  "description": "A minimal Payload CMS plugin to generate image alt texts using OpenAI's Vision API.",
+  "version": "0.3.1",
+  "description": "A Payload CMS plugin that adds AI-powered alt text generation for images.",
   "bugs": "https://github.com/jhb-software/payload-plugins/issues",
   "repository": "https://github.com/jhb-software/payload-plugins",
   "keywords": [
@@ -17,25 +17,27 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "openai": "^6.8.1",
-    "p-map": "^7.0.3",
-    "zod": "^4.1.12"
+    "openai": "^6.16.0",
+    "p-map": "^7.0.4",
+    "zod": "^4.3.5"
   },
   "peerDependencies": {
-    "@payloadcms/ui": "^3.62.1",
-    "next": "15.5.6",
-    "payload": "^3.62.1",
-    "react": "19.2.0",
-    "react-dom": "19.2.0"
+    "@payloadcms/ui": "^3.72.0",
+    "next": "15.5.9",
+    "payload": "^3.72.0",
+    "react": "19.2.3",
+    "react-dom": "19.2.3"
   },
   "devDependencies": {
-    "@swc/cli": "^0.7.9",
-    "@swc/core": "^1.15.0",
-    "@types/react": "19.2.2",
-    "@types/react-dom": "19.2.2",
+    "@payloadcms/eslint-config": "^3.28.0",
+    "@swc/cli": "^0.7.10",
+    "@swc/core": "^1.15.10",
+    "@types/react": "19.2.8",
+    "@types/react-dom": "19.2.3",
     "copyfiles": "2.4.1",
-    "prettier": "^3.6.2",
-    "rimraf": "6.1.0",
+    "eslint": "^9.39.2",
+    "prettier": "^3.8.0",
+    "rimraf": "6.1.2",
     "typescript": "5.9.3"
   },
   "files": [
@@ -73,7 +75,7 @@
     "clean": "rimraf --glob {dist,*.tsbuildinfo}",
     "dev": "tsc -w",
     "format": "prettier --write src",
-    "lint": "eslint ./src",
-    "lint:fix": "eslint ./src --fix"
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix"
   }
 }

package/dist/utilities/getGenerationCost.d.ts

@@ -1,12 +0,0 @@
-import type OpenAI from 'openai';
-import type { AltTextPluginConfig } from '../types/AltTextPluginConfig.js';
-type GenerationCost = {
-    model: 'gpt-4.1-nano' | 'gpt-4.1-mini';
-    inputCost: number;
-    outputCost: number;
-    totalCost: number;
-    totalTokens: number;
-};
-/** Calculates the cost of a generation. */
-export declare function getGenerationCost(response: OpenAI.Chat.Completions.ChatCompletion, model: AltTextPluginConfig['model']): GenerationCost;
-export {};

package/dist/utilities/getGenerationCost.js

@@ -1,30 +0,0 @@
-/** Calculates the cost of a generation. */ export function getGenerationCost(response, model) {
-    const modelCosts = {
-        // see https://platform.openai.com/docs/models/gpt-4.1-nano
-        'gpt-4.1-nano': {
-            input: 0.1,
-            output: 0.4
-        },
-        // see https://platform.openai.com/docs/models/gpt-4.1-mini
-        'gpt-4.1-mini': {
-            input: 0.4,
-            output: 1.6
-        }
-    };
-    // Calculate cost based on token usage
-    const inputTokens = response.usage?.prompt_tokens || 0;
-    const outputTokens = response.usage?.completion_tokens || 0;
-    const totalTokens = response.usage?.total_tokens || 0;
-    const inputCost = inputTokens / 1_000_000 * modelCosts[model].input;
-    const outputCost = outputTokens / 1_000_000 * modelCosts[model].output;
-    const totalCost = inputCost + outputCost;
-    return {
-        model,
-        inputCost,
-        outputCost,
-        totalCost,
-        totalTokens
-    };
-}
-
-//# sourceMappingURL=getGenerationCost.js.map

package/dist/utilities/getGenerationCost.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/getGenerationCost.ts"],"sourcesContent":["import type OpenAI from 'openai'\nimport type { AltTextPluginConfig } from '../types/AltTextPluginConfig.js'\n\ntype GenerationCost = {\n  model: 'gpt-4.1-nano' | 'gpt-4.1-mini'\n  inputCost: number\n  outputCost: number\n  totalCost: number\n  totalTokens: number\n}\n\n/** Calculates the cost of a generation. */\nexport function getGenerationCost(\n  response: OpenAI.Chat.Completions.ChatCompletion,\n  model: AltTextPluginConfig['model'],\n): GenerationCost {\n  const modelCosts: Record<AltTextPluginConfig['model'], { input: number; output: number }> = {\n    // see https://platform.openai.com/docs/models/gpt-4.1-nano\n    'gpt-4.1-nano': {\n      input: 0.1,\n      output: 0.4,\n    },\n    // see https://platform.openai.com/docs/models/gpt-4.1-mini\n    'gpt-4.1-mini': {\n      input: 0.4,\n      output: 1.6,\n    },\n  }\n\n  // Calculate cost based on token usage\n  const inputTokens = response.usage?.prompt_tokens || 0\n  const outputTokens = response.usage?.completion_tokens || 0\n  const totalTokens = response.usage?.total_tokens || 0\n\n  const inputCost = (inputTokens / 1_000_000) * modelCosts[model].input\n  const outputCost = (outputTokens / 1_000_000) * modelCosts[model].output\n  const totalCost = inputCost + outputCost\n\n  return {\n    model,\n    inputCost,\n    outputCost,\n    totalCost,\n    totalTokens,\n  }\n}\n"],"names":["getGenerationCost","response","model","modelCosts","input","output","inputTokens","usage","prompt_tokens","outputTokens","completion_tokens","totalTokens","total_tokens","inputCost","outputCost","totalCost"],"mappings":"AAWA,yCAAyC,GACzC,OAAO,SAASA,kBACdC,QAAgD,EAChDC,KAAmC;IAEnC,MAAMC,aAAsF;QAC1F,2DAA2D;QAC3D,gBAAgB;YACdC,OAAO;YACPC,QAAQ;QACV;QACA,2DAA2D;QAC3D,gBAAgB;YACdD,OAAO;YACPC,QAAQ;QACV;IACF;IAEA,sCAAsC;IACtC,MAAMC,cAAcL,SAASM,KAAK,EAAEC,iBAAiB;IACrD,MAAMC,eAAeR,SAASM,KAAK,EAAEG,qBAAqB;IAC1D,MAAMC,cAAcV,SAASM,KAAK,EAAEK,gBAAgB;IAEpD,MAAMC,YAAY,AAACP,cAAc,YAAaH,UAAU,CAACD,MAAM,CAACE,KAAK;IACrE,MAAMU,aAAa,AAACL,eAAe,YAAaN,UAAU,CAACD,MAAM,CAACG,MAAM;IACxE,MAAMU,YAAYF,YAAYC;IAE9B,OAAO;QACLZ;QACAW;QACAC;QACAC;QACAJ;IACF;AACF"}

package/dist/utilities/zodResponseFormat.d.ts

@@ -1,11 +0,0 @@
-import { AutoParseableResponseFormat } from 'openai/lib/parser.mjs';
-import { ResponseFormatJSONSchema } from 'openai/resources/shared.mjs';
-import { z } from 'zod';
-/**
- * Creates a chat completion `JSONSchema` response format object from
- * the given Zod schema.
- *
- * This is a temporary drop in replacement for the zodResponseFormat from openai/helpers/zod.ts
- * because of issue https://github.com/openai/openai-node/issues/1576
- */
-export declare function zodResponseFormat<ZodInput extends z.ZodType>(zodObject: ZodInput, name: string, props?: Omit<ResponseFormatJSONSchema.JSONSchema, 'schema' | 'strict' | 'name'>): AutoParseableResponseFormat<z.infer<ZodInput>>;

package/dist/utilities/zodResponseFormat.js

@@ -1,23 +0,0 @@
-import { makeParseableResponseFormat } from 'openai/lib/parser.mjs';
-import { z } from 'zod';
-/**
- * Creates a chat completion `JSONSchema` response format object from
- * the given Zod schema.
- *
- * This is a temporary drop in replacement for the zodResponseFormat from openai/helpers/zod.ts
- * because of issue https://github.com/openai/openai-node/issues/1576
- */ export function zodResponseFormat(zodObject, name, props) {
-    return makeParseableResponseFormat({
-        type: 'json_schema',
-        json_schema: {
-            ...props,
-            name,
-            strict: true,
-            schema: z.toJSONSchema(zodObject, {
-                target: 'draft-7'
-            })
-        }
-    }, (content)=>zodObject.parse(JSON.parse(content)));
-}
-
-//# sourceMappingURL=zodResponseFormat.js.map

package/dist/utilities/zodResponseFormat.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/zodResponseFormat.ts"],"sourcesContent":["import { AutoParseableResponseFormat, makeParseableResponseFormat } from 'openai/lib/parser.mjs'\nimport { ResponseFormatJSONSchema } from 'openai/resources/shared.mjs'\nimport { z } from 'zod'\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 */\nexport function zodResponseFormat<ZodInput extends z.ZodType>(\n  zodObject: ZodInput,\n  name: string,\n  props?: Omit<ResponseFormatJSONSchema.JSONSchema, 'schema' | 'strict' | 'name'>,\n): AutoParseableResponseFormat<z.infer<ZodInput>> {\n  return makeParseableResponseFormat(\n    {\n      type: 'json_schema',\n      json_schema: {\n        ...props,\n        name,\n        strict: true,\n        schema: z.toJSONSchema(zodObject, { target: 'draft-7' }),\n      },\n    },\n    (content) => zodObject.parse(JSON.parse(content)),\n  )\n}\n"],"names":["makeParseableResponseFormat","z","zodResponseFormat","zodObject","name","props","type","json_schema","strict","schema","toJSONSchema","target","content","parse","JSON"],"mappings":"AAAA,SAAsCA,2BAA2B,QAAQ,wBAAuB;AAEhG,SAASC,CAAC,QAAQ,MAAK;AAEvB;;;;;;CAMC,GACD,OAAO,SAASC,kBACdC,SAAmB,EACnBC,IAAY,EACZC,KAA+E;IAE/E,OAAOL,4BACL;QACEM,MAAM;QACNC,aAAa;YACX,GAAGF,KAAK;YACRD;YACAI,QAAQ;YACRC,QAAQR,EAAES,YAAY,CAACP,WAAW;gBAAEQ,QAAQ;YAAU;QACxD;IACF,GACA,CAACC,UAAYT,UAAUU,KAAK,CAACC,KAAKD,KAAK,CAACD;AAE5C"}

package/dist/utils/usePluginTranslation.d.ts

@@ -1,5 +0,0 @@
-import { PluginAltTextTranslationKeys } from 'src/translations/index.js';
-/** Hook which returns a translation function for the plugin translations. */
-export declare const usePluginTranslation: () => {
-    t: (key: PluginAltTextTranslationKeys) => string;
-};

package/dist/utils/usePluginTranslation.js

@@ -1,16 +0,0 @@
-import { useTranslation } from '@payloadcms/ui';
-/** Hook which returns a translation function for the plugin translations. */ export const usePluginTranslation = ()=>{
-    const { i18n } = useTranslation();
-    const pluginTranslations = i18n.translations['@jhb.software/payload-alt-text-plugin'];
-    return {
-        t: (key)=>{
-            const translation = pluginTranslations[key];
-            if (!translation) {
-                console.log('Plugin translation not found', key);
-            }
-            return translation ?? key;
-        }
-    };
-};
-
-//# sourceMappingURL=usePluginTranslation.js.map

package/dist/utils/usePluginTranslation.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utils/usePluginTranslation.ts"],"sourcesContent":["import { useTranslation } from '@payloadcms/ui'\nimport { PluginAltTextTranslationKeys } from 'src/translations/index.js'\nimport { PluginAltTextTranslations } from 'src/translations/index.js'\n\n/** Hook which returns a translation function for the plugin translations. */\nexport const usePluginTranslation = () => {\n  const { i18n } = useTranslation<PluginAltTextTranslations, PluginAltTextTranslationKeys>()\n  const pluginTranslations = i18n.translations[\n    '@jhb.software/payload-alt-text-plugin'\n  ] as PluginAltTextTranslations\n\n  return {\n    t: (key: PluginAltTextTranslationKeys) => {\n      const translation = pluginTranslations[key] as string\n\n      if (!translation) {\n        console.log('Plugin translation not found', key)\n      }\n      return translation ?? key\n    },\n  }\n}\n"],"names":["useTranslation","usePluginTranslation","i18n","pluginTranslations","translations","t","key","translation","console","log"],"mappings":"AAAA,SAASA,cAAc,QAAQ,iBAAgB;AAI/C,2EAA2E,GAC3E,OAAO,MAAMC,uBAAuB;IAClC,MAAM,EAAEC,IAAI,EAAE,GAAGF;IACjB,MAAMG,qBAAqBD,KAAKE,YAAY,CAC1C,wCACD;IAED,OAAO;QACLC,GAAG,CAACC;YACF,MAAMC,cAAcJ,kBAAkB,CAACG,IAAI;YAE3C,IAAI,CAACC,aAAa;gBAChBC,QAAQC,GAAG,CAAC,gCAAgCH;YAC9C;YACA,OAAOC,eAAeD;QACxB;IACF;AACF,EAAC"}