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

package/dist/endpoints/bulkGenerateAltTexts.js

@@ -1,8 +1,5 @@
-import OpenAI from 'openai';
 import pMap from 'p-map';
 import { z } from 'zod';
-import { getGenerationCost } from '../utilities/getGenerationCost.js';
-import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
 import { localesFromConfig } from '../utilities/localesFromConfig.js';
 /**
  * Generates and updates alt text for multiple images in all locales.
@@ -32,15 +29,14 @@ import { localesFromConfig } from '../utilities/localesFromConfig.js';
                 status: 500
             });
         }
-        if (!pluginConfig.openAIApiKey) {
+        if (!pluginConfig.resolver) {
             return Response.json({
-                error: 'OpenAI API key not configured'
+                error: 'No alt text resolver configured'
             }, {
                 status: 500
             });
         }
-        // Use concurrency from config
-        const concurrency = pluginConfig.maxBulkGenerateConcurrency || 16;
+        const concurrency = pluginConfig.maxBulkGenerateConcurrency;
         // determine target locales based on config
         const locales = localesFromConfig(req.payload.config);
         const targetLocales = locales ?? [
@@ -56,11 +52,12 @@ import { localesFromConfig } from '../utilities/localesFromConfig.js';
         await pMap(ids, async (id)=>{
             try {
                 await generateAndUpdateAltText({
-                    payload: req.payload,
                     id,
                     collection,
+                    locales: targetLocales,
+                    payload: req.payload,
                     pluginConfig,
-                    locales: targetLocales
+                    req
                 });
                 updatedDocs++;
                 console.log(`${updatedDocs}/${ids.length} updated (${Math.round(updatedDocs / ids.length * 100)}%)`);
@@ -75,9 +72,9 @@ import { localesFromConfig } from '../utilities/localesFromConfig.js';
             console.error(`Failed for: ${erroredDocs.join(', ')}`);
         }
         return Response.json({
-            updatedDocs,
+            erroredDocs,
             totalDocs: ids.length,
-            erroredDocs
+            updatedDocs
         });
     } catch (error) {
         console.error('Error in bulk generation:', error);
@@ -88,82 +85,38 @@ import { localesFromConfig } from '../utilities/localesFromConfig.js';
         });
     }
 };
-async function generateAndUpdateAltText({ payload, id, collection, pluginConfig, locales }) {
+async function generateAndUpdateAltText({ id, collection, locales, payload, pluginConfig, req }) {
     const imageDoc = await payload.findByID({
-        collection: collection,
-        id: id,
+        id,
+        collection,
         depth: 0
     });
     if (!imageDoc) {
         throw new Error('Image not found');
     }
     const imageThumbnailUrl = pluginConfig.getImageThumbnail(imageDoc);
-    const openai = new OpenAI({
-        apiKey: pluginConfig.openAIApiKey
-    });
-    const modelResponseSchema = z.object(Object.fromEntries(locales.map((locale)=>[
-            locale,
-            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')
-            })
-        ])));
-    const response = await openai.chat.completions.parse({
-        model: pluginConfig.model,
-        messages: [
-            {
-                role: 'system',
-                content: `
-      You are an expert at analyzing images and creating descriptive image alt text. 
-      
-      Please analyze the given image and provide the following in ${locales.join(', ')}:
-      - 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.
-      - A localized 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.join(', ')} keys, each containing "altText", "keywords" and "slug".
-    `
-            },
-            {
-                role: 'user',
-                content: [
-                    {
-                        type: 'image_url',
-                        image_url: {
-                            url: imageThumbnailUrl
-                        }
-                    },
-                    ...'filename' in imageDoc && imageDoc.filename ? [
-                        {
-                            type: 'text',
-                            text: imageDoc.filename
-                        }
-                    ] : []
-                ]
-            }
-        ],
-        max_completion_tokens: 300,
-        response_format: zodResponseFormat(modelResponseSchema, 'data')
-    });
-    console.log({
-        imageId: id,
-        ...getGenerationCost(response, pluginConfig.model)
+    const result = await pluginConfig.resolver.resolveBulk({
+        filename: 'filename' in imageDoc && typeof imageDoc.filename === 'string' ? imageDoc.filename : undefined,
+        imageThumbnailUrl,
+        locales,
+        req
     });
-    const result = response.choices[0]?.message?.parsed;
-    if (!result) {
-        throw new Error('No result from OpenAI');
+    if (!result.success) {
+        throw new Error(result.error || 'Failed to generate alt text');
     }
     for (const locale of locales){
-        await payload.update({
-            collection: collection,
-            id: id,
-            locale: locale,
-            data: {
-                alt: result[locale]?.altText,
-                keywords: result[locale]?.keywords
-            }
-        });
+        const localeResult = result.results[locale];
+        if (localeResult) {
+            await payload.update({
+                id,
+                collection,
+                data: {
+                    alt: localeResult.altText,
+                    keywords: localeResult.keywords
+                },
+                locale
+            });
+        }
     }
 }
 

package/dist/endpoints/bulkGenerateAltTexts.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/endpoints/bulkGenerateAltTexts.ts"],"sourcesContent":["import OpenAI from 'openai'\nimport { ChatCompletionContentPartText } from 'openai/resources/chat/completions.mjs'\nimport pMap from 'p-map'\nimport type { BasePayload, CollectionSlug, PayloadHandler, PayloadRequest } from 'payload'\nimport { z } from 'zod'\nimport { getGenerationCost } from '../utilities/getGenerationCost.js'\nimport type { AltTextPluginConfig } from '../types/AltTextPluginConfig.js'\nimport { zodResponseFormat } from '../utilities/zodResponseFormat.js'\nimport { localesFromConfig } from '../utilities/localesFromConfig.js'\n\n/**\n * Generates and updates alt text for multiple images in all locales.\n */\nexport const bulkGenerateAltTextsEndpoint: PayloadHandler = async (req: PayloadRequest) => {\n  try {\n    if (!req.user) {\n      return Response.json({ error: 'Unauthorized' }, { status: 401 })\n    }\n\n    const data = 'json' in req && typeof req.json === 'function' ? await req.json() : null\n\n    const schema = z.object({\n      collection: z.string(),\n      ids: z.array(z.string()),\n    })\n\n    const { collection, ids } = schema.parse(data)\n\n    let updatedDocs = 0\n    const erroredDocs: string[] = []\n\n    // Get plugin config from payload config\n    const pluginConfig = req.payload.config.custom?.altTextPluginConfig as\n      | AltTextPluginConfig\n      | undefined\n\n    if (!pluginConfig) {\n      return Response.json({ error: 'Plugin config not found' }, { status: 500 })\n    }\n\n    if (!pluginConfig.openAIApiKey) {\n      return Response.json({ error: 'OpenAI API key not configured' }, { status: 500 })\n    }\n\n    // Use concurrency from config\n    const concurrency = pluginConfig.maxBulkGenerateConcurrency || 16\n\n    // determine target locales based on config\n    const locales = localesFromConfig(req.payload.config)\n    const targetLocales = locales ?? [pluginConfig.locale!]\n    if (!targetLocales) {\n      return Response.json(\n        {\n          error:\n            'Could not determine target locales for alt text generation. Please check your plugin configuration.',\n        },\n        { status: 500 },\n      )\n    }\n\n    await pMap(\n      ids,\n      async (id) => {\n        try {\n          await generateAndUpdateAltText({\n            payload: req.payload,\n            id,\n            collection,\n            pluginConfig,\n            locales: targetLocales,\n          })\n          updatedDocs++\n          console.log(\n            `${updatedDocs}/${ids.length} updated (${Math.round((updatedDocs / ids.length) * 100)}%)`,\n          )\n        } catch (error) {\n          console.error(`Error generating alt text for ${id}:`, error)\n          erroredDocs.push(id)\n        }\n      },\n      { concurrency },\n    )\n\n    if (erroredDocs.length > 0) {\n      console.error(`Failed for: ${erroredDocs.join(', ')}`)\n    }\n\n    return Response.json({\n      updatedDocs,\n      totalDocs: ids.length,\n      erroredDocs,\n    })\n  } catch (error) {\n    console.error('Error in bulk generation:', error)\n    return Response.json(\n      {\n        error: `Error generating alt text: ${error instanceof Error ? error.message : 'Unknown error'}`,\n      },\n      { status: 500 },\n    )\n  }\n}\n\nasync function generateAndUpdateAltText({\n  payload,\n  id,\n  collection,\n  pluginConfig,\n  locales,\n}: {\n  payload: BasePayload\n  id: string\n  collection: CollectionSlug\n  pluginConfig: AltTextPluginConfig\n  locales: string[]\n}) {\n  const imageDoc = await payload.findByID({\n    collection: collection,\n    id: id as string,\n    depth: 0,\n  })\n\n  if (!imageDoc) {\n    throw new Error('Image not found')\n  }\n\n  const imageThumbnailUrl = pluginConfig.getImageThumbnail(imageDoc)\n\n  const openai = new OpenAI({\n    apiKey: pluginConfig.openAIApiKey,\n  })\n\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.array(z.string()).describe('Keywords that describe the content of the image'),\n        }),\n      ]),\n    ),\n  )\n\n  const response = await openai.chat.completions.parse({\n    model: pluginConfig.model,\n    messages: [\n      {\n        role: 'system',\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\", \"keywords\" and \"slug\".\n    `,\n      },\n      {\n        role: 'user',\n        content: [\n          {\n            type: 'image_url',\n            image_url: { url: imageThumbnailUrl },\n          },\n          ...('filename' in imageDoc && imageDoc.filename\n            ? [\n                {\n                  type: 'text',\n                  text: imageDoc.filename,\n                } satisfies ChatCompletionContentPartText,\n              ]\n            : []),\n        ],\n      },\n    ],\n    max_completion_tokens: 300,\n    response_format: zodResponseFormat(modelResponseSchema, 'data'),\n  })\n\n  console.log({ imageId: id, ...getGenerationCost(response, pluginConfig.model) })\n\n  const result = response.choices[0]?.message?.parsed\n\n  if (!result) {\n    throw new Error('No result from OpenAI')\n  }\n\n  for (const locale of locales) {\n    await payload.update({\n      collection: collection as CollectionSlug,\n      id: id as string,\n      locale: locale,\n      data: {\n        alt: (result as any)[locale]?.altText,\n        keywords: (result as any)[locale]?.keywords,\n      },\n    })\n  }\n}\n"],"names":["OpenAI","pMap","z","getGenerationCost","zodResponseFormat","localesFromConfig","bulkGenerateAltTextsEndpoint","req","user","Response","json","error","status","data","schema","object","collection","string","ids","array","parse","updatedDocs","erroredDocs","pluginConfig","payload","config","custom","altTextPluginConfig","openAIApiKey","concurrency","maxBulkGenerateConcurrency","locales","targetLocales","locale","id","generateAndUpdateAltText","console","log","length","Math","round","push","join","totalDocs","Error","message","imageDoc","findByID","depth","imageThumbnailUrl","getImageThumbnail","openai","apiKey","modelResponseSchema","Object","fromEntries","map","altText","describe","keywords","response","chat","completions","model","messages","role","content","type","image_url","url","filename","text","max_completion_tokens","response_format","imageId","result","choices","parsed","update","alt"],"mappings":"AAAA,OAAOA,YAAY,SAAQ;AAE3B,OAAOC,UAAU,QAAO;AAExB,SAASC,CAAC,QAAQ,MAAK;AACvB,SAASC,iBAAiB,QAAQ,oCAAmC;AAErE,SAASC,iBAAiB,QAAQ,oCAAmC;AACrE,SAASC,iBAAiB,QAAQ,oCAAmC;AAErE;;CAEC,GACD,OAAO,MAAMC,+BAA+C,OAAOC;IACjE,IAAI;QACF,IAAI,CAACA,IAAIC,IAAI,EAAE;YACb,OAAOC,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAe,GAAG;gBAAEC,QAAQ;YAAI;QAChE;QAEA,MAAMC,OAAO,UAAUN,OAAO,OAAOA,IAAIG,IAAI,KAAK,aAAa,MAAMH,IAAIG,IAAI,KAAK;QAElF,MAAMI,SAASZ,EAAEa,MAAM,CAAC;YACtBC,YAAYd,EAAEe,MAAM;YACpBC,KAAKhB,EAAEiB,KAAK,CAACjB,EAAEe,MAAM;QACvB;QAEA,MAAM,EAAED,UAAU,EAAEE,GAAG,EAAE,GAAGJ,OAAOM,KAAK,CAACP;QAEzC,IAAIQ,cAAc;QAClB,MAAMC,cAAwB,EAAE;QAEhC,wCAAwC;QACxC,MAAMC,eAAehB,IAAIiB,OAAO,CAACC,MAAM,CAACC,MAAM,EAAEC;QAIhD,IAAI,CAACJ,cAAc;YACjB,OAAOd,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAA0B,GAAG;gBAAEC,QAAQ;YAAI;QAC3E;QAEA,IAAI,CAACW,aAAaK,YAAY,EAAE;YAC9B,OAAOnB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAgC,GAAG;gBAAEC,QAAQ;YAAI;QACjF;QAEA,8BAA8B;QAC9B,MAAMiB,cAAcN,aAAaO,0BAA0B,IAAI;QAE/D,2CAA2C;QAC3C,MAAMC,UAAU1B,kBAAkBE,IAAIiB,OAAO,CAACC,MAAM;QACpD,MAAMO,gBAAgBD,WAAW;YAACR,aAAaU,MAAM;SAAE;QACvD,IAAI,CAACD,eAAe;YAClB,OAAOvB,SAASC,IAAI,CAClB;gBACEC,OACE;YACJ,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMX,KACJiB,KACA,OAAOgB;YACL,IAAI;gBACF,MAAMC,yBAAyB;oBAC7BX,SAASjB,IAAIiB,OAAO;oBACpBU;oBACAlB;oBACAO;oBACAQ,SAASC;gBACX;gBACAX;gBACAe,QAAQC,GAAG,CACT,GAAGhB,YAAY,CAAC,EAAEH,IAAIoB,MAAM,CAAC,UAAU,EAAEC,KAAKC,KAAK,CAAC,AAACnB,cAAcH,IAAIoB,MAAM,GAAI,KAAK,EAAE,CAAC;YAE7F,EAAE,OAAO3B,OAAO;gBACdyB,QAAQzB,KAAK,CAAC,CAAC,8BAA8B,EAAEuB,GAAG,CAAC,CAAC,EAAEvB;gBACtDW,YAAYmB,IAAI,CAACP;YACnB;QACF,GACA;YAAEL;QAAY;QAGhB,IAAIP,YAAYgB,MAAM,GAAG,GAAG;YAC1BF,QAAQzB,KAAK,CAAC,CAAC,YAAY,EAAEW,YAAYoB,IAAI,CAAC,OAAO;QACvD;QAEA,OAAOjC,SAASC,IAAI,CAAC;YACnBW;YACAsB,WAAWzB,IAAIoB,MAAM;YACrBhB;QACF;IACF,EAAE,OAAOX,OAAO;QACdyB,QAAQzB,KAAK,CAAC,6BAA6BA;QAC3C,OAAOF,SAASC,IAAI,CAClB;YACEC,OAAO,CAAC,2BAA2B,EAAEA,iBAAiBiC,QAAQjC,MAAMkC,OAAO,GAAG,iBAAiB;QACjG,GACA;YAAEjC,QAAQ;QAAI;IAElB;AACF,EAAC;AAED,eAAeuB,yBAAyB,EACtCX,OAAO,EACPU,EAAE,EACFlB,UAAU,EACVO,YAAY,EACZQ,OAAO,EAOR;IACC,MAAMe,WAAW,MAAMtB,QAAQuB,QAAQ,CAAC;QACtC/B,YAAYA;QACZkB,IAAIA;QACJc,OAAO;IACT;IAEA,IAAI,CAACF,UAAU;QACb,MAAM,IAAIF,MAAM;IAClB;IAEA,MAAMK,oBAAoB1B,aAAa2B,iBAAiB,CAACJ;IAEzD,MAAMK,SAAS,IAAInD,OAAO;QACxBoD,QAAQ7B,aAAaK,YAAY;IACnC;IAEA,MAAMyB,sBAAsBnD,EAAEa,MAAM,CAClCuC,OAAOC,WAAW,CAChBxB,QAAQyB,GAAG,CAAC,CAACvB,SAAW;YACtBA;YACA/B,EAAEa,MAAM,CAAC;gBACP0C,SAASvD,EAAEe,MAAM,GAAGyC,QAAQ,CAAC;gBAC7BC,UAAUzD,EAAEiB,KAAK,CAACjB,EAAEe,MAAM,IAAIyC,QAAQ,CAAC;YACzC;SACD;IAIL,MAAME,WAAW,MAAMT,OAAOU,IAAI,CAACC,WAAW,CAAC1C,KAAK,CAAC;QACnD2C,OAAOxC,aAAawC,KAAK;QACzBC,UAAU;YACR;gBACEC,MAAM;gBACNC,SAAS,CAAC;;;kEAGgD,EAAEnC,QAAQW,IAAI,CAAC,MAAM;;;;;;iDAMtC,EAAEX,QAAQW,IAAI,CAAC,MAAM;IAClE,CAAC;YACC;YACA;gBACEuB,MAAM;gBACNC,SAAS;oBACP;wBACEC,MAAM;wBACNC,WAAW;4BAAEC,KAAKpB;wBAAkB;oBACtC;uBACI,cAAcH,YAAYA,SAASwB,QAAQ,GAC3C;wBACE;4BACEH,MAAM;4BACNI,MAAMzB,SAASwB,QAAQ;wBACzB;qBACD,GACD,EAAE;iBACP;YACH;SACD;QACDE,uBAAuB;QACvBC,iBAAiBrE,kBAAkBiD,qBAAqB;IAC1D;IAEAjB,QAAQC,GAAG,CAAC;QAAEqC,SAASxC;QAAI,GAAG/B,kBAAkByD,UAAUrC,aAAawC,KAAK,CAAC;IAAC;IAE9E,MAAMY,SAASf,SAASgB,OAAO,CAAC,EAAE,EAAE/B,SAASgC;IAE7C,IAAI,CAACF,QAAQ;QACX,MAAM,IAAI/B,MAAM;IAClB;IAEA,KAAK,MAAMX,UAAUF,QAAS;QAC5B,MAAMP,QAAQsD,MAAM,CAAC;YACnB9D,YAAYA;YACZkB,IAAIA;YACJD,QAAQA;YACRpB,MAAM;gBACJkE,KAAK,AAACJ,MAAc,CAAC1C,OAAO,EAAEwB;gBAC9BE,UAAU,AAACgB,MAAc,CAAC1C,OAAO,EAAE0B;YACrC;QACF;IACF;AACF"}
+{"version":3,"sources":["../../src/endpoints/bulkGenerateAltTexts.ts"],"sourcesContent":["import type { BasePayload, CollectionSlug, PayloadHandler, PayloadRequest } from 'payload'\n\nimport pMap from 'p-map'\nimport { z } from 'zod'\n\nimport type { AltTextPluginConfig } from '../types/AltTextPluginConfig.js'\n\nimport { localesFromConfig } from '../utilities/localesFromConfig.js'\n\n/**\n * Generates and updates alt text for multiple images in all locales.\n */\nexport const bulkGenerateAltTextsEndpoint: PayloadHandler = async (req: PayloadRequest) => {\n  try {\n    if (!req.user) {\n      return Response.json({ error: 'Unauthorized' }, { status: 401 })\n    }\n\n    const data = 'json' in req && typeof req.json === 'function' ? await req.json() : null\n\n    const schema = z.object({\n      collection: z.string(),\n      ids: z.array(z.string()),\n    })\n\n    const { collection, ids } = schema.parse(data)\n\n    let updatedDocs = 0\n    const erroredDocs: string[] = []\n\n    // Get plugin config from payload config\n    const pluginConfig = req.payload.config.custom?.altTextPluginConfig as\n      | AltTextPluginConfig\n      | undefined\n\n    if (!pluginConfig) {\n      return Response.json({ error: 'Plugin config not found' }, { status: 500 })\n    }\n\n    if (!pluginConfig.resolver) {\n      return Response.json({ error: 'No alt text resolver configured' }, { status: 500 })\n    }\n\n    const concurrency = pluginConfig.maxBulkGenerateConcurrency\n\n    // determine target locales based on config\n    const locales = localesFromConfig(req.payload.config)\n    const targetLocales = locales ?? [pluginConfig.locale!]\n    if (!targetLocales) {\n      return Response.json(\n        {\n          error:\n            'Could not determine target locales for alt text generation. Please check your plugin configuration.',\n        },\n        { status: 500 },\n      )\n    }\n\n    await pMap(\n      ids,\n      async (id) => {\n        try {\n          await generateAndUpdateAltText({\n            id,\n            collection,\n            locales: targetLocales,\n            payload: req.payload,\n            pluginConfig,\n            req,\n          })\n          updatedDocs++\n          console.log(\n            `${updatedDocs}/${ids.length} updated (${Math.round((updatedDocs / ids.length) * 100)}%)`,\n          )\n        } catch (error) {\n          console.error(`Error generating alt text for ${id}:`, error)\n          erroredDocs.push(id)\n        }\n      },\n      { concurrency },\n    )\n\n    if (erroredDocs.length > 0) {\n      console.error(`Failed for: ${erroredDocs.join(', ')}`)\n    }\n\n    return Response.json({\n      erroredDocs,\n      totalDocs: ids.length,\n      updatedDocs,\n    })\n  } catch (error) {\n    console.error('Error in bulk generation:', error)\n    return Response.json(\n      {\n        error: `Error generating alt text: ${error instanceof Error ? error.message : 'Unknown error'}`,\n      },\n      { status: 500 },\n    )\n  }\n}\n\nasync function generateAndUpdateAltText({\n  id,\n  collection,\n  locales,\n  payload,\n  pluginConfig,\n  req,\n}: {\n  collection: CollectionSlug\n  id: string\n  locales: string[]\n  payload: BasePayload\n  pluginConfig: AltTextPluginConfig\n  req: PayloadRequest\n}) {\n  const imageDoc = await payload.findByID({\n    id,\n    collection,\n    depth: 0,\n  })\n\n  if (!imageDoc) {\n    throw new Error('Image not found')\n  }\n\n  const imageThumbnailUrl = pluginConfig.getImageThumbnail(imageDoc)\n\n  const result = await pluginConfig.resolver.resolveBulk({\n    filename:\n      'filename' in imageDoc && typeof imageDoc.filename === 'string'\n        ? imageDoc.filename\n        : undefined,\n    imageThumbnailUrl,\n    locales,\n    req,\n  })\n\n  if (!result.success) {\n    throw new Error(result.error || 'Failed to generate alt text')\n  }\n\n  for (const locale of locales) {\n    const localeResult = result.results[locale]\n    if (localeResult) {\n      await payload.update({\n        id,\n        collection,\n        data: {\n          alt: localeResult.altText,\n          keywords: localeResult.keywords,\n        },\n        locale,\n      })\n    }\n  }\n}\n"],"names":["pMap","z","localesFromConfig","bulkGenerateAltTextsEndpoint","req","user","Response","json","error","status","data","schema","object","collection","string","ids","array","parse","updatedDocs","erroredDocs","pluginConfig","payload","config","custom","altTextPluginConfig","resolver","concurrency","maxBulkGenerateConcurrency","locales","targetLocales","locale","id","generateAndUpdateAltText","console","log","length","Math","round","push","join","totalDocs","Error","message","imageDoc","findByID","depth","imageThumbnailUrl","getImageThumbnail","result","resolveBulk","filename","undefined","success","localeResult","results","update","alt","altText","keywords"],"mappings":"AAEA,OAAOA,UAAU,QAAO;AACxB,SAASC,CAAC,QAAQ,MAAK;AAIvB,SAASC,iBAAiB,QAAQ,oCAAmC;AAErE;;CAEC,GACD,OAAO,MAAMC,+BAA+C,OAAOC;IACjE,IAAI;QACF,IAAI,CAACA,IAAIC,IAAI,EAAE;YACb,OAAOC,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAe,GAAG;gBAAEC,QAAQ;YAAI;QAChE;QAEA,MAAMC,OAAO,UAAUN,OAAO,OAAOA,IAAIG,IAAI,KAAK,aAAa,MAAMH,IAAIG,IAAI,KAAK;QAElF,MAAMI,SAASV,EAAEW,MAAM,CAAC;YACtBC,YAAYZ,EAAEa,MAAM;YACpBC,KAAKd,EAAEe,KAAK,CAACf,EAAEa,MAAM;QACvB;QAEA,MAAM,EAAED,UAAU,EAAEE,GAAG,EAAE,GAAGJ,OAAOM,KAAK,CAACP;QAEzC,IAAIQ,cAAc;QAClB,MAAMC,cAAwB,EAAE;QAEhC,wCAAwC;QACxC,MAAMC,eAAehB,IAAIiB,OAAO,CAACC,MAAM,CAACC,MAAM,EAAEC;QAIhD,IAAI,CAACJ,cAAc;YACjB,OAAOd,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAA0B,GAAG;gBAAEC,QAAQ;YAAI;QAC3E;QAEA,IAAI,CAACW,aAAaK,QAAQ,EAAE;YAC1B,OAAOnB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAkC,GAAG;gBAAEC,QAAQ;YAAI;QACnF;QAEA,MAAMiB,cAAcN,aAAaO,0BAA0B;QAE3D,2CAA2C;QAC3C,MAAMC,UAAU1B,kBAAkBE,IAAIiB,OAAO,CAACC,MAAM;QACpD,MAAMO,gBAAgBD,WAAW;YAACR,aAAaU,MAAM;SAAE;QACvD,IAAI,CAACD,eAAe;YAClB,OAAOvB,SAASC,IAAI,CAClB;gBACEC,OACE;YACJ,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMT,KACJe,KACA,OAAOgB;YACL,IAAI;gBACF,MAAMC,yBAAyB;oBAC7BD;oBACAlB;oBACAe,SAASC;oBACTR,SAASjB,IAAIiB,OAAO;oBACpBD;oBACAhB;gBACF;gBACAc;gBACAe,QAAQC,GAAG,CACT,GAAGhB,YAAY,CAAC,EAAEH,IAAIoB,MAAM,CAAC,UAAU,EAAEC,KAAKC,KAAK,CAAC,AAACnB,cAAcH,IAAIoB,MAAM,GAAI,KAAK,EAAE,CAAC;YAE7F,EAAE,OAAO3B,OAAO;gBACdyB,QAAQzB,KAAK,CAAC,CAAC,8BAA8B,EAAEuB,GAAG,CAAC,CAAC,EAAEvB;gBACtDW,YAAYmB,IAAI,CAACP;YACnB;QACF,GACA;YAAEL;QAAY;QAGhB,IAAIP,YAAYgB,MAAM,GAAG,GAAG;YAC1BF,QAAQzB,KAAK,CAAC,CAAC,YAAY,EAAEW,YAAYoB,IAAI,CAAC,OAAO;QACvD;QAEA,OAAOjC,SAASC,IAAI,CAAC;YACnBY;YACAqB,WAAWzB,IAAIoB,MAAM;YACrBjB;QACF;IACF,EAAE,OAAOV,OAAO;QACdyB,QAAQzB,KAAK,CAAC,6BAA6BA;QAC3C,OAAOF,SAASC,IAAI,CAClB;YACEC,OAAO,CAAC,2BAA2B,EAAEA,iBAAiBiC,QAAQjC,MAAMkC,OAAO,GAAG,iBAAiB;QACjG,GACA;YAAEjC,QAAQ;QAAI;IAElB;AACF,EAAC;AAED,eAAeuB,yBAAyB,EACtCD,EAAE,EACFlB,UAAU,EACVe,OAAO,EACPP,OAAO,EACPD,YAAY,EACZhB,GAAG,EAQJ;IACC,MAAMuC,WAAW,MAAMtB,QAAQuB,QAAQ,CAAC;QACtCb;QACAlB;QACAgC,OAAO;IACT;IAEA,IAAI,CAACF,UAAU;QACb,MAAM,IAAIF,MAAM;IAClB;IAEA,MAAMK,oBAAoB1B,aAAa2B,iBAAiB,CAACJ;IAEzD,MAAMK,SAAS,MAAM5B,aAAaK,QAAQ,CAACwB,WAAW,CAAC;QACrDC,UACE,cAAcP,YAAY,OAAOA,SAASO,QAAQ,KAAK,WACnDP,SAASO,QAAQ,GACjBC;QACNL;QACAlB;QACAxB;IACF;IAEA,IAAI,CAAC4C,OAAOI,OAAO,EAAE;QACnB,MAAM,IAAIX,MAAMO,OAAOxC,KAAK,IAAI;IAClC;IAEA,KAAK,MAAMsB,UAAUF,QAAS;QAC5B,MAAMyB,eAAeL,OAAOM,OAAO,CAACxB,OAAO;QAC3C,IAAIuB,cAAc;YAChB,MAAMhC,QAAQkC,MAAM,CAAC;gBACnBxB;gBACAlB;gBACAH,MAAM;oBACJ8C,KAAKH,aAAaI,OAAO;oBACzBC,UAAUL,aAAaK,QAAQ;gBACjC;gBACA5B;YACF;QACF;IACF;AACF"}

package/dist/endpoints/generateAltText.d.ts

@@ -1,6 +1,6 @@
 import type { PayloadHandler } from 'payload';
 /**
- * Generates alt text for a single image using OpenAI Vision API.
+ * Generates alt text for a single image using the configured resolver.
  * Returns result without updating the document.
  */
 export declare const generateAltTextEndpoint: PayloadHandler;

package/dist/endpoints/generateAltText.js

@@ -1,9 +1,6 @@
-import OpenAI from 'openai';
 import { z } from 'zod';
-import { getGenerationCost } from '../utilities/getGenerationCost.js';
-import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
 /**
- * Generates alt text for a single image using OpenAI Vision API.
+ * Generates alt text for a single image using the configured resolver.
  * Returns result without updating the document.
  */ export const generateAltTextEndpoint = async (req)=>{
     try {
@@ -16,14 +13,14 @@ import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
         }
         const data = 'json' in req && typeof req.json === 'function' ? await req.json() : null;
         const requestSchema = z.object({
-            collection: z.string(),
             id: z.string(),
+            collection: z.string(),
             locale: z.string().nullable()
         });
-        const { collection, id, locale } = requestSchema.parse(data);
+        const { id, collection, locale } = requestSchema.parse(data);
         const imageDoc = await req.payload.findByID({
-            collection,
             id,
+            collection,
             depth: 0
         });
         if (!imageDoc) {
@@ -48,89 +45,37 @@ import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
                 status: 500
             });
         }
-        // determine target locale
-        const targetLocale = locale ?? pluginConfig.locale;
-        if (!targetLocale) {
-            return Response.json({
-                error: 'Could not determine target locale for alt text generation. Please check your plugin configuration.'
-            }, {
-                status: 500
-            });
-        }
-        const imageThumbnailUrl = pluginConfig.getImageThumbnail(imageDoc);
-        if (!imageThumbnailUrl) {
+        if (!pluginConfig.resolver) {
             return Response.json({
-                error: 'Image thumbnail URL not defined'
+                error: 'No alt text resolver configured'
             }, {
                 status: 500
             });
         }
-        if (!imageThumbnailUrl.startsWith('https://') && !imageThumbnailUrl.includes('http://')) {
+        // determine target locale
+        const targetLocale = locale ?? pluginConfig.locale;
+        if (!targetLocale) {
             return Response.json({
-                error: 'Image thumbnail URL is not a valid URL. It must start with https:// or http://'
+                error: 'Could not determine target locale for alt text generation. Please check your plugin configuration.'
             }, {
                 status: 500
             });
         }
-        const openai = new OpenAI({
-            apiKey: pluginConfig.openAIApiKey
-        });
-        const modelResponseSchema = 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')
-        });
-        const response = await openai.chat.completions.parse({
-            model: pluginConfig.model,
-            messages: [
-                {
-                    role: 'system',
-                    content: `
-            You are an expert at analyzing images and creating descriptive image alt text. 
-            
-            Please analyze the given image and provide the following:
-            - 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. You must respond in the ${targetLocale} language.
-          `
-                },
-                {
-                    role: 'user',
-                    content: [
-                        {
-                            type: 'image_url',
-                            image_url: {
-                                url: imageThumbnailUrl
-                            }
-                        },
-                        ...'filename' in imageDoc && imageDoc.filename ? [
-                            {
-                                type: 'text',
-                                text: imageDoc.filename
-                            }
-                        ] : []
-                    ]
-                }
-            ],
-            // limit the response tokens and costs per request
-            max_completion_tokens: 150,
-            response_format: zodResponseFormat(modelResponseSchema, 'data')
-        });
-        console.log({
-            imageId: id,
-            ...getGenerationCost(response, pluginConfig.model)
+        const imageThumbnailUrl = pluginConfig.getImageThumbnail(imageDoc);
+        const result = await pluginConfig.resolver.resolve({
+            filename: 'filename' in imageDoc && typeof imageDoc.filename === 'string' ? imageDoc.filename : undefined,
+            imageThumbnailUrl,
+            locale: targetLocale,
+            req
         });
-        const result = response.choices[0]?.message?.parsed;
-        if (!result) {
+        if (!result.success) {
             return Response.json({
-                error: 'No result from OpenAI'
+                error: result.error || 'Failed to generate alt text'
             }, {
                 status: 500
             });
         }
-        return Response.json(result);
+        return Response.json(result.result);
     } catch (error) {
         console.error('Error generating alt text:', error);
         return Response.json({

package/dist/endpoints/generateAltText.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/endpoints/generateAltText.ts"],"sourcesContent":["import OpenAI from 'openai'\nimport { ChatCompletionContentPartText } from 'openai/resources/chat/completions.mjs'\nimport type { PayloadHandler, PayloadRequest } from 'payload'\nimport { z } from 'zod'\nimport { getGenerationCost } from '../utilities/getGenerationCost.js'\nimport type { AltTextPluginConfig } from '../types/AltTextPluginConfig.js'\nimport { zodResponseFormat } from '../utilities/zodResponseFormat.js'\n\n/**\n * Generates alt text for a single image using OpenAI Vision API.\n * Returns result without updating the document.\n */\nexport const generateAltTextEndpoint: PayloadHandler = async (req: PayloadRequest) => {\n  try {\n    if (!req.user) {\n      return Response.json({ error: 'Unauthorized' }, { status: 401 })\n    }\n\n    const data = 'json' in req && typeof req.json === 'function' ? await req.json() : null\n\n    const requestSchema = z.object({\n      collection: z.string(),\n      id: z.string(),\n      locale: z.string().nullable(),\n    })\n\n    const { collection, id, locale } = requestSchema.parse(data)\n\n    const imageDoc = await req.payload.findByID({\n      collection,\n      id,\n      depth: 0,\n    })\n\n    if (!imageDoc) {\n      return Response.json({ error: 'Image not found' }, { status: 404 })\n    }\n\n    const pluginConfig = req.payload.config.custom?.altTextPluginConfig as\n      | AltTextPluginConfig\n      | undefined\n\n    if (!pluginConfig) {\n      return Response.json({ error: 'Plugin config not found' }, { status: 500 })\n    }\n\n    if (!pluginConfig.getImageThumbnail) {\n      return Response.json({ error: 'getImageThumbnail function not configured' }, { status: 500 })\n    }\n\n    // determine target locale\n    const targetLocale = locale ?? pluginConfig.locale\n    if (!targetLocale) {\n      return Response.json(\n        {\n          error:\n            'Could not determine target locale for alt text generation. Please check your plugin configuration.',\n        },\n        { status: 500 },\n      )\n    }\n\n    const imageThumbnailUrl = pluginConfig.getImageThumbnail(imageDoc)\n\n    if (!imageThumbnailUrl) {\n      return Response.json({ error: 'Image thumbnail URL not defined' }, { status: 500 })\n    }\n\n    if (!imageThumbnailUrl.startsWith('https://') && !imageThumbnailUrl.includes('http://')) {\n      return Response.json(\n        { error: 'Image thumbnail URL is not a valid URL. It must start with https:// or http://' },\n        { status: 500 },\n      )\n    }\n\n    const openai = new OpenAI({\n      apiKey: pluginConfig.openAIApiKey,\n    })\n\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 openai.chat.completions.parse({\n      model: pluginConfig.model,\n      messages: [\n        {\n          role: 'system',\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 ${targetLocale} language.\n          `,\n        },\n        {\n          role: 'user',\n          content: [\n            {\n              type: 'image_url',\n              image_url: { url: imageThumbnailUrl },\n            },\n            ...('filename' in imageDoc && imageDoc.filename\n              ? [\n                  {\n                    type: 'text',\n                    text: imageDoc.filename,\n                  } satisfies ChatCompletionContentPartText,\n                ]\n              : []),\n          ],\n        },\n      ],\n      // limit the response tokens and costs per request\n      max_completion_tokens: 150,\n      response_format: zodResponseFormat(modelResponseSchema, 'data'),\n    })\n\n    console.log({ imageId: id, ...getGenerationCost(response, pluginConfig.model) })\n\n    const result = response.choices[0]?.message?.parsed\n\n    if (!result) {\n      return Response.json({ error: 'No result from OpenAI' }, { status: 500 })\n    }\n\n    return Response.json(result)\n  } catch (error) {\n    console.error('Error generating alt text:', error)\n    return Response.json(\n      {\n        error: `Error generating alt text: ${error instanceof Error ? error.message : 'Unknown error'}`,\n      },\n      { status: 500 },\n    )\n  }\n}\n"],"names":["OpenAI","z","getGenerationCost","zodResponseFormat","generateAltTextEndpoint","req","user","Response","json","error","status","data","requestSchema","object","collection","string","id","locale","nullable","parse","imageDoc","payload","findByID","depth","pluginConfig","config","custom","altTextPluginConfig","getImageThumbnail","targetLocale","imageThumbnailUrl","startsWith","includes","openai","apiKey","openAIApiKey","modelResponseSchema","altText","describe","keywords","array","response","chat","completions","model","messages","role","content","type","image_url","url","filename","text","max_completion_tokens","response_format","console","log","imageId","result","choices","message","parsed","Error"],"mappings":"AAAA,OAAOA,YAAY,SAAQ;AAG3B,SAASC,CAAC,QAAQ,MAAK;AACvB,SAASC,iBAAiB,QAAQ,oCAAmC;AAErE,SAASC,iBAAiB,QAAQ,oCAAmC;AAErE;;;CAGC,GACD,OAAO,MAAMC,0BAA0C,OAAOC;IAC5D,IAAI;QACF,IAAI,CAACA,IAAIC,IAAI,EAAE;YACb,OAAOC,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAe,GAAG;gBAAEC,QAAQ;YAAI;QAChE;QAEA,MAAMC,OAAO,UAAUN,OAAO,OAAOA,IAAIG,IAAI,KAAK,aAAa,MAAMH,IAAIG,IAAI,KAAK;QAElF,MAAMI,gBAAgBX,EAAEY,MAAM,CAAC;YAC7BC,YAAYb,EAAEc,MAAM;YACpBC,IAAIf,EAAEc,MAAM;YACZE,QAAQhB,EAAEc,MAAM,GAAGG,QAAQ;QAC7B;QAEA,MAAM,EAAEJ,UAAU,EAAEE,EAAE,EAAEC,MAAM,EAAE,GAAGL,cAAcO,KAAK,CAACR;QAEvD,MAAMS,WAAW,MAAMf,IAAIgB,OAAO,CAACC,QAAQ,CAAC;YAC1CR;YACAE;YACAO,OAAO;QACT;QAEA,IAAI,CAACH,UAAU;YACb,OAAOb,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAkB,GAAG;gBAAEC,QAAQ;YAAI;QACnE;QAEA,MAAMc,eAAenB,IAAIgB,OAAO,CAACI,MAAM,CAACC,MAAM,EAAEC;QAIhD,IAAI,CAACH,cAAc;YACjB,OAAOjB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAA0B,GAAG;gBAAEC,QAAQ;YAAI;QAC3E;QAEA,IAAI,CAACc,aAAaI,iBAAiB,EAAE;YACnC,OAAOrB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAA4C,GAAG;gBAAEC,QAAQ;YAAI;QAC7F;QAEA,0BAA0B;QAC1B,MAAMmB,eAAeZ,UAAUO,aAAaP,MAAM;QAClD,IAAI,CAACY,cAAc;YACjB,OAAOtB,SAASC,IAAI,CAClB;gBACEC,OACE;YACJ,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMoB,oBAAoBN,aAAaI,iBAAiB,CAACR;QAEzD,IAAI,CAACU,mBAAmB;YACtB,OAAOvB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAkC,GAAG;gBAAEC,QAAQ;YAAI;QACnF;QAEA,IAAI,CAACoB,kBAAkBC,UAAU,CAAC,eAAe,CAACD,kBAAkBE,QAAQ,CAAC,YAAY;YACvF,OAAOzB,SAASC,IAAI,CAClB;gBAAEC,OAAO;YAAiF,GAC1F;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMuB,SAAS,IAAIjC,OAAO;YACxBkC,QAAQV,aAAaW,YAAY;QACnC;QAEA,MAAMC,sBAAsBnC,EAAEY,MAAM,CAAC;YACnCwB,SAASpC,EAAEc,MAAM,GAAGuB,QAAQ,CAAC;YAC7BC,UAAUtC,EAAEuC,KAAK,CAACvC,EAAEc,MAAM,IAAIuB,QAAQ,CAAC;QACzC;QAEA,MAAMG,WAAW,MAAMR,OAAOS,IAAI,CAACC,WAAW,CAACxB,KAAK,CAAC;YACnDyB,OAAOpB,aAAaoB,KAAK;YACzBC,UAAU;gBACR;oBACEC,MAAM;oBACNC,SAAS,CAAC;;;;;;;;;2EASuD,EAAElB,aAAa;UAChF,CAAC;gBACH;gBACA;oBACEiB,MAAM;oBACNC,SAAS;wBACP;4BACEC,MAAM;4BACNC,WAAW;gCAAEC,KAAKpB;4BAAkB;wBACtC;2BACI,cAAcV,YAAYA,SAAS+B,QAAQ,GAC3C;4BACE;gCACEH,MAAM;gCACNI,MAAMhC,SAAS+B,QAAQ;4BACzB;yBACD,GACD,EAAE;qBACP;gBACH;aACD;YACD,kDAAkD;YAClDE,uBAAuB;YACvBC,iBAAiBnD,kBAAkBiC,qBAAqB;QAC1D;QAEAmB,QAAQC,GAAG,CAAC;YAAEC,SAASzC;YAAI,GAAGd,kBAAkBuC,UAAUjB,aAAaoB,KAAK,CAAC;QAAC;QAE9E,MAAMc,SAASjB,SAASkB,OAAO,CAAC,EAAE,EAAEC,SAASC;QAE7C,IAAI,CAACH,QAAQ;YACX,OAAOnD,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAwB,GAAG;gBAAEC,QAAQ;YAAI;QACzE;QAEA,OAAOH,SAASC,IAAI,CAACkD;IACvB,EAAE,OAAOjD,OAAO;QACd8C,QAAQ9C,KAAK,CAAC,8BAA8BA;QAC5C,OAAOF,SAASC,IAAI,CAClB;YACEC,OAAO,CAAC,2BAA2B,EAAEA,iBAAiBqD,QAAQrD,MAAMmD,OAAO,GAAG,iBAAiB;QACjG,GACA;YAAElD,QAAQ;QAAI;IAElB;AACF,EAAC"}
+{"version":3,"sources":["../../src/endpoints/generateAltText.ts"],"sourcesContent":["import type { PayloadHandler, PayloadRequest } from 'payload'\n\nimport { z } from 'zod'\n\nimport type { AltTextPluginConfig } from '../types/AltTextPluginConfig.js'\n\n/**\n * Generates alt text for a single image using the configured resolver.\n * Returns result without updating the document.\n */\nexport const generateAltTextEndpoint: PayloadHandler = async (req: PayloadRequest) => {\n  try {\n    if (!req.user) {\n      return Response.json({ error: 'Unauthorized' }, { status: 401 })\n    }\n\n    const data = 'json' in req && typeof req.json === 'function' ? await req.json() : null\n\n    const requestSchema = z.object({\n      id: z.string(),\n      collection: z.string(),\n      locale: z.string().nullable(),\n    })\n\n    const { id, collection, locale } = requestSchema.parse(data)\n\n    const imageDoc = await req.payload.findByID({\n      id,\n      collection,\n      depth: 0,\n    })\n\n    if (!imageDoc) {\n      return Response.json({ error: 'Image not found' }, { status: 404 })\n    }\n\n    const pluginConfig = req.payload.config.custom?.altTextPluginConfig as\n      | AltTextPluginConfig\n      | undefined\n\n    if (!pluginConfig) {\n      return Response.json({ error: 'Plugin config not found' }, { status: 500 })\n    }\n\n    if (!pluginConfig.getImageThumbnail) {\n      return Response.json({ error: 'getImageThumbnail function not configured' }, { status: 500 })\n    }\n\n    if (!pluginConfig.resolver) {\n      return Response.json({ error: 'No alt text resolver configured' }, { status: 500 })\n    }\n\n    // determine target locale\n    const targetLocale = locale ?? pluginConfig.locale\n    if (!targetLocale) {\n      return Response.json(\n        {\n          error:\n            'Could not determine target locale for alt text generation. Please check your plugin configuration.',\n        },\n        { status: 500 },\n      )\n    }\n\n    const imageThumbnailUrl = pluginConfig.getImageThumbnail(imageDoc)\n\n    const result = await pluginConfig.resolver.resolve({\n      filename:\n        'filename' in imageDoc && typeof imageDoc.filename === 'string'\n          ? imageDoc.filename\n          : undefined,\n      imageThumbnailUrl,\n      locale: targetLocale,\n      req,\n    })\n\n    if (!result.success) {\n      return Response.json(\n        { error: result.error || 'Failed to generate alt text' },\n        { status: 500 },\n      )\n    }\n\n    return Response.json(result.result)\n  } catch (error) {\n    console.error('Error generating alt text:', error)\n    return Response.json(\n      {\n        error: `Error generating alt text: ${error instanceof Error ? error.message : 'Unknown error'}`,\n      },\n      { status: 500 },\n    )\n  }\n}\n"],"names":["z","generateAltTextEndpoint","req","user","Response","json","error","status","data","requestSchema","object","id","string","collection","locale","nullable","parse","imageDoc","payload","findByID","depth","pluginConfig","config","custom","altTextPluginConfig","getImageThumbnail","resolver","targetLocale","imageThumbnailUrl","result","resolve","filename","undefined","success","console","Error","message"],"mappings":"AAEA,SAASA,CAAC,QAAQ,MAAK;AAIvB;;;CAGC,GACD,OAAO,MAAMC,0BAA0C,OAAOC;IAC5D,IAAI;QACF,IAAI,CAACA,IAAIC,IAAI,EAAE;YACb,OAAOC,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAe,GAAG;gBAAEC,QAAQ;YAAI;QAChE;QAEA,MAAMC,OAAO,UAAUN,OAAO,OAAOA,IAAIG,IAAI,KAAK,aAAa,MAAMH,IAAIG,IAAI,KAAK;QAElF,MAAMI,gBAAgBT,EAAEU,MAAM,CAAC;YAC7BC,IAAIX,EAAEY,MAAM;YACZC,YAAYb,EAAEY,MAAM;YACpBE,QAAQd,EAAEY,MAAM,GAAGG,QAAQ;QAC7B;QAEA,MAAM,EAAEJ,EAAE,EAAEE,UAAU,EAAEC,MAAM,EAAE,GAAGL,cAAcO,KAAK,CAACR;QAEvD,MAAMS,WAAW,MAAMf,IAAIgB,OAAO,CAACC,QAAQ,CAAC;YAC1CR;YACAE;YACAO,OAAO;QACT;QAEA,IAAI,CAACH,UAAU;YACb,OAAOb,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAkB,GAAG;gBAAEC,QAAQ;YAAI;QACnE;QAEA,MAAMc,eAAenB,IAAIgB,OAAO,CAACI,MAAM,CAACC,MAAM,EAAEC;QAIhD,IAAI,CAACH,cAAc;YACjB,OAAOjB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAA0B,GAAG;gBAAEC,QAAQ;YAAI;QAC3E;QAEA,IAAI,CAACc,aAAaI,iBAAiB,EAAE;YACnC,OAAOrB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAA4C,GAAG;gBAAEC,QAAQ;YAAI;QAC7F;QAEA,IAAI,CAACc,aAAaK,QAAQ,EAAE;YAC1B,OAAOtB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAkC,GAAG;gBAAEC,QAAQ;YAAI;QACnF;QAEA,0BAA0B;QAC1B,MAAMoB,eAAeb,UAAUO,aAAaP,MAAM;QAClD,IAAI,CAACa,cAAc;YACjB,OAAOvB,SAASC,IAAI,CAClB;gBACEC,OACE;YACJ,GACA;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMqB,oBAAoBP,aAAaI,iBAAiB,CAACR;QAEzD,MAAMY,SAAS,MAAMR,aAAaK,QAAQ,CAACI,OAAO,CAAC;YACjDC,UACE,cAAcd,YAAY,OAAOA,SAASc,QAAQ,KAAK,WACnDd,SAASc,QAAQ,GACjBC;YACNJ;YACAd,QAAQa;YACRzB;QACF;QAEA,IAAI,CAAC2B,OAAOI,OAAO,EAAE;YACnB,OAAO7B,SAASC,IAAI,CAClB;gBAAEC,OAAOuB,OAAOvB,KAAK,IAAI;YAA8B,GACvD;gBAAEC,QAAQ;YAAI;QAElB;QAEA,OAAOH,SAASC,IAAI,CAACwB,OAAOA,MAAM;IACpC,EAAE,OAAOvB,OAAO;QACd4B,QAAQ5B,KAAK,CAAC,8BAA8BA;QAC5C,OAAOF,SAASC,IAAI,CAClB;YACEC,OAAO,CAAC,2BAA2B,EAAEA,iBAAiB6B,QAAQ7B,MAAM8B,OAAO,GAAG,iBAAiB;QACjG,GACA;YAAE7B,QAAQ;QAAI;IAElB;AACF,EAAC"}

package/dist/exports/client.d.ts

@@ -1,3 +1,3 @@
 export { AltTextField } from '../components/AltTextField.js';
-export { GenerateAltTextButton } from '../components/GenerateAltTextButton.js';
 export { BulkGenerateAltTextsButton } from '../components/BulkGenerateAltTextsButton.js';
+export { GenerateAltTextButton } from '../components/GenerateAltTextButton.js';

package/dist/exports/client.js

@@ -1,5 +1,5 @@
 export { AltTextField } from '../components/AltTextField.js';
-export { GenerateAltTextButton } from '../components/GenerateAltTextButton.js';
 export { BulkGenerateAltTextsButton } from '../components/BulkGenerateAltTextsButton.js';
+export { GenerateAltTextButton } from '../components/GenerateAltTextButton.js';
 
 //# sourceMappingURL=client.js.map

package/dist/exports/client.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/exports/client.ts"],"sourcesContent":["export { AltTextField } from '../components/AltTextField.js'\nexport { GenerateAltTextButton } from '../components/GenerateAltTextButton.js'\nexport { BulkGenerateAltTextsButton } from '../components/BulkGenerateAltTextsButton.js'\n"],"names":["AltTextField","GenerateAltTextButton","BulkGenerateAltTextsButton"],"mappings":"AAAA,SAASA,YAAY,QAAQ,gCAA+B;AAC5D,SAASC,qBAAqB,QAAQ,yCAAwC;AAC9E,SAASC,0BAA0B,QAAQ,8CAA6C"}
+{"version":3,"sources":["../../src/exports/client.ts"],"sourcesContent":["export { AltTextField } from '../components/AltTextField.js'\nexport { BulkGenerateAltTextsButton } from '../components/BulkGenerateAltTextsButton.js'\nexport { GenerateAltTextButton } from '../components/GenerateAltTextButton.js'\n"],"names":["AltTextField","BulkGenerateAltTextsButton","GenerateAltTextButton"],"mappings":"AAAA,SAASA,YAAY,QAAQ,gCAA+B;AAC5D,SAASC,0BAA0B,QAAQ,8CAA6C;AACxF,SAASC,qBAAqB,QAAQ,yCAAwC"}

package/dist/fields/altTextField.js

@@ -2,26 +2,31 @@ import { translatedLabel } from '../utils/translatedLabel.js';
 export function altTextField({ localized }) {
     return {
         name: 'alt',
-        label: translatedLabel('alternateText'),
         type: 'textarea',
-        required: true,
-        localized: localized,
-        validate: (value, { id, req: { t } })=>{
-            // if the document has an id, which means a media file was uploaded, the alt text is required
-            if (id) {
-                if (!value || value.trim().length === 0) {
-                    // @ts-expect-error - the translation key type does not include the custom key
-                    return t('@jhb.software/payload-alt-text-plugin:theAlternateTextIsRequired');
-                }
-            }
-            // The alt text is not required when the media file was not uploaded yet
-            // (since the alt text generation needs an URL to fetch the file)
-            return true;
-        },
         admin: {
             components: {
                 Field: '@jhb.software/payload-alt-text-plugin/client#AltTextField'
             }
+        },
+        label: translatedLabel('alternateText'),
+        localized,
+        required: true,
+        validate: (value, { data, operation, req: { t } })=>{
+            // Since https://github.com/payloadcms/payload/pull/14988, when using external storage (e.g., S3),
+            // it is no longer possible to detect whether this validation runs during the initial upload
+            // or a regular update by checking the existence of the ID.
+            // Instead, compare the timestamps of the createdAt and updatedAt fields.
+            const isInitialUpload = operation === 'create' || 'createdAt' in data && 'updatedAt' in data && data.createdAt === data.updatedAt;
+            // initial upload: allow without alt text
+            if (isInitialUpload) {
+                return true;
+            }
+            // regular update: require alt text
+            if (!value || value.trim().length === 0) {
+                // @ts-expect-error - the translation key type does not include the custom key
+                return t('@jhb.software/payload-alt-text-plugin:theAlternateTextIsRequired');
+            }
+            return true;
         }
     };
 }

package/dist/fields/altTextField.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fields/altTextField.ts"],"sourcesContent":["import type { TextareaField } from 'payload'\nimport { translatedLabel } from '../utils/translatedLabel.js'\n\nexport function altTextField({\n  localized,\n}: {\n  localized?: TextareaField['localized']\n}): TextareaField {\n  return {\n    name: 'alt',\n    label: translatedLabel('alternateText'),\n    type: 'textarea',\n    required: true,\n    localized: localized,\n    validate: (value, { id, req: { t } }) => {\n      // if the document has an id, which means a media file was uploaded, the alt text is required\n      if (id) {\n        if (!value || value.trim().length === 0) {\n          // @ts-expect-error - the translation key type does not include the custom key\n          return t('@jhb.software/payload-alt-text-plugin:theAlternateTextIsRequired')\n        }\n      }\n\n      // The alt text is not required when the media file was not uploaded yet\n      // (since the alt text generation needs an URL to fetch the file)\n      return true\n    },\n    admin: {\n      components: {\n        Field: '@jhb.software/payload-alt-text-plugin/client#AltTextField',\n      },\n    },\n  }\n}\n"],"names":["translatedLabel","altTextField","localized","name","label","type","required","validate","value","id","req","t","trim","length","admin","components","Field"],"mappings":"AACA,SAASA,eAAe,QAAQ,8BAA6B;AAE7D,OAAO,SAASC,aAAa,EAC3BC,SAAS,EAGV;IACC,OAAO;QACLC,MAAM;QACNC,OAAOJ,gBAAgB;QACvBK,MAAM;QACNC,UAAU;QACVJ,WAAWA;QACXK,UAAU,CAACC,OAAO,EAAEC,EAAE,EAAEC,KAAK,EAAEC,CAAC,EAAE,EAAE;YAClC,6FAA6F;YAC7F,IAAIF,IAAI;gBACN,IAAI,CAACD,SAASA,MAAMI,IAAI,GAAGC,MAAM,KAAK,GAAG;oBACvC,8EAA8E;oBAC9E,OAAOF,EAAE;gBACX;YACF;YAEA,wEAAwE;YACxE,iEAAiE;YACjE,OAAO;QACT;QACAG,OAAO;YACLC,YAAY;gBACVC,OAAO;YACT;QACF;IACF;AACF"}
+{"version":3,"sources":["../../src/fields/altTextField.ts"],"sourcesContent":["import type { TextareaField } from 'payload'\n\nimport { translatedLabel } from '../utils/translatedLabel.js'\n\nexport function altTextField({\n  localized,\n}: {\n  localized?: TextareaField['localized']\n}): TextareaField {\n  return {\n    name: 'alt',\n    type: 'textarea',\n    admin: {\n      components: {\n        Field: '@jhb.software/payload-alt-text-plugin/client#AltTextField',\n      },\n    },\n    label: translatedLabel('alternateText'),\n    localized,\n    required: true,\n    validate: (value, { data, operation, req: { t } }) => {\n      // Since https://github.com/payloadcms/payload/pull/14988, when using external storage (e.g., S3),\n      // it is no longer possible to detect whether this validation runs during the initial upload\n      // or a regular update by checking the existence of the ID.\n      // Instead, compare the timestamps of the createdAt and updatedAt fields.\n      const isInitialUpload =\n        operation === 'create' ||\n        ('createdAt' in data && 'updatedAt' in data && data.createdAt === data.updatedAt)\n\n      // initial upload: allow without alt text\n      if (isInitialUpload) {\n        return true\n      }\n\n      // regular update: require alt text\n      if (!value || value.trim().length === 0) {\n        // @ts-expect-error - the translation key type does not include the custom key\n        return t('@jhb.software/payload-alt-text-plugin:theAlternateTextIsRequired')\n      }\n\n      return true\n    },\n  }\n}\n"],"names":["translatedLabel","altTextField","localized","name","type","admin","components","Field","label","required","validate","value","data","operation","req","t","isInitialUpload","createdAt","updatedAt","trim","length"],"mappings":"AAEA,SAASA,eAAe,QAAQ,8BAA6B;AAE7D,OAAO,SAASC,aAAa,EAC3BC,SAAS,EAGV;IACC,OAAO;QACLC,MAAM;QACNC,MAAM;QACNC,OAAO;YACLC,YAAY;gBACVC,OAAO;YACT;QACF;QACAC,OAAOR,gBAAgB;QACvBE;QACAO,UAAU;QACVC,UAAU,CAACC,OAAO,EAAEC,IAAI,EAAEC,SAAS,EAAEC,KAAK,EAAEC,CAAC,EAAE,EAAE;YAC/C,kGAAkG;YAClG,4FAA4F;YAC5F,2DAA2D;YAC3D,yEAAyE;YACzE,MAAMC,kBACJH,cAAc,YACb,eAAeD,QAAQ,eAAeA,QAAQA,KAAKK,SAAS,KAAKL,KAAKM,SAAS;YAElF,yCAAyC;YACzC,IAAIF,iBAAiB;gBACnB,OAAO;YACT;YAEA,mCAAmC;YACnC,IAAI,CAACL,SAASA,MAAMQ,IAAI,GAAGC,MAAM,KAAK,GAAG;gBACvC,8EAA8E;gBAC9E,OAAOL,EAAE;YACX;YAEA,OAAO;QACT;IACF;AACF"}

package/dist/fields/keywordsField.js

@@ -2,16 +2,16 @@ import { translatedLabel } from '../utils/translatedLabel.js';
 export function keywordsField({ localized }) {
     return {
         name: 'keywords',
-        label: translatedLabel('keywords'),
         type: 'text',
-        hasMany: true,
-        required: false,
-        localized: localized,
         admin: {
             description: 'Keywords which describe the image. Used when searching for the image.',
-            readOnly: true,
-            hidden: true
-        }
+            hidden: true,
+            readOnly: true
+        },
+        hasMany: true,
+        label: translatedLabel('keywords'),
+        localized,
+        required: false
     };
 }
 

package/dist/fields/keywordsField.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fields/keywordsField.ts"],"sourcesContent":["import type { TextField } from 'payload'\nimport { translatedLabel } from '../utils/translatedLabel.js'\n\nexport function keywordsField({ localized }: { localized?: TextField['localized'] }): TextField {\n  return {\n    name: 'keywords',\n    label: translatedLabel('keywords'),\n    type: 'text',\n    hasMany: true,\n    required: false,\n    localized: localized,\n    admin: {\n      description: 'Keywords which describe the image. Used when searching for the image.', // does not need to be translated because it is only used for the JSDoc\n      readOnly: true,\n      hidden: true, // this field is only meant to be used for improving the search, therefore hide it from the UI\n    },\n  }\n}\n"],"names":["translatedLabel","keywordsField","localized","name","label","type","hasMany","required","admin","description","readOnly","hidden"],"mappings":"AACA,SAASA,eAAe,QAAQ,8BAA6B;AAE7D,OAAO,SAASC,cAAc,EAAEC,SAAS,EAA0C;IACjF,OAAO;QACLC,MAAM;QACNC,OAAOJ,gBAAgB;QACvBK,MAAM;QACNC,SAAS;QACTC,UAAU;QACVL,WAAWA;QACXM,OAAO;YACLC,aAAa;YACbC,UAAU;YACVC,QAAQ;QACV;IACF;AACF"}
+{"version":3,"sources":["../../src/fields/keywordsField.ts"],"sourcesContent":["import type { TextField } from 'payload'\n\nimport { translatedLabel } from '../utils/translatedLabel.js'\n\nexport function keywordsField({ localized }: { localized?: TextField['localized'] }): TextField {\n  return {\n    name: 'keywords',\n    type: 'text',\n    admin: {\n      description: 'Keywords which describe the image. Used when searching for the image.', // does not need to be translated because it is only used for the JSDoc\n      hidden: true, // this field is only meant to be used for improving the search, therefore hide it from the UI\n      readOnly: true,\n    },\n    hasMany: true,\n    label: translatedLabel('keywords'),\n    localized,\n    required: false,\n  }\n}\n"],"names":["translatedLabel","keywordsField","localized","name","type","admin","description","hidden","readOnly","hasMany","label","required"],"mappings":"AAEA,SAASA,eAAe,QAAQ,8BAA6B;AAE7D,OAAO,SAASC,cAAc,EAAEC,SAAS,EAA0C;IACjF,OAAO;QACLC,MAAM;QACNC,MAAM;QACNC,OAAO;YACLC,aAAa;YACbC,QAAQ;YACRC,UAAU;QACZ;QACAC,SAAS;QACTC,OAAOV,gBAAgB;QACvBE;QACAS,UAAU;IACZ;AACF"}

package/dist/index.d.ts

@@ -1,2 +1,4 @@
 export { payloadAltTextPlugin } from './plugin.js';
+export { openAIResolver } from './resolvers/openAI.js';
+export * from './resolvers/types.js';
 export type { IncomingAltTextPluginConfig as AltTextPluginConfig } from './types/AltTextPluginConfig.js';

package/dist/index.js

@@ -1,3 +1,5 @@
 export { payloadAltTextPlugin } from './plugin.js';
+export { openAIResolver } from './resolvers/openAI.js';
+export * from './resolvers/types.js';
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export { payloadAltTextPlugin } from './plugin.js'\nexport type { IncomingAltTextPluginConfig as AltTextPluginConfig } from './types/AltTextPluginConfig.js'\n"],"names":["payloadAltTextPlugin"],"mappings":"AAAA,SAASA,oBAAoB,QAAQ,cAAa"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export { payloadAltTextPlugin } from './plugin.js'\nexport { openAIResolver } from './resolvers/openAI.js'\nexport * from './resolvers/types.js'\nexport type { IncomingAltTextPluginConfig as AltTextPluginConfig } from './types/AltTextPluginConfig.js'\n"],"names":["payloadAltTextPlugin","openAIResolver"],"mappings":"AAAA,SAASA,oBAAoB,QAAQ,cAAa;AAClD,SAASC,cAAc,QAAQ,wBAAuB;AACtD,cAAc,uBAAsB"}