@jhb.software/payload-alt-text-plugin 0.1.1 → 0.2.1

package/README.md

@@ -1,6 +1,6 @@
 # Image Alt Text Generation Plugin for Payload CMS
 
-A minimal plugin to generate image alt texts using OpenAI's Vision API.
+A minimal plugin to generate image alt texts using OpenAI's Vision API. This plugin automatically adds an alt text field with a button to generate the alt text to upload collections, and includes a bulk generation feature in the list view for processing multiple images at once.
 
 ## Installation
 
@@ -18,7 +18,7 @@ import { payloadAltTextPlugin } from '@jhb.software/payload-alt-text-plugin'
 export default buildConfig({
   plugins: [
     payloadAltTextPlugin({
-      collections: ['media'], // Specify which upload collections should have alt text fields
+      collections: ['media'], // Specify which upload collections to enable the plugin for
       openAIApiKey: process.env.OPENAI_API_KEY!,
       model: 'gpt-4.1-mini',
       getImageThumbnail: (doc: Record<string, unknown>) => {
@@ -30,6 +30,8 @@ export default buildConfig({
 })
 ```
 
+Note: When localization is disabled in your Payload config (default), you need to specify the locale to generate the alt texts in via the `locale` plugin option.
+
 ## Features
 
 When the plugin is enabled for an upload collection, it will
@@ -39,7 +41,7 @@ When the plugin is enabled for an upload collection, it will
    - This field will include a description of what the alt text should be
 2. Add a keywords fields to the collection
    - This field will be automatically filled when generating the alt text 
-   - It can be used for improving the search of images in the admin panel
+   - It will be used for improving the search of images in the admin panel
 2. Add a bulk generate button to the collection list view
    - This button will allow you to generate alt text for multiple images at once
 

package/dist/components/BulkGenerateAltTextsButton.d.ts

@@ -1 +1,3 @@
-export declare function BulkGenerateAltTextsButton(): false | import("react").JSX.Element;
+export declare function BulkGenerateAltTextsButton({ collectionSlug }: {
+    collectionSlug: string;
+}): false | import("react").JSX.Element;

package/dist/components/BulkGenerateAltTextsButton.js

@@ -5,34 +5,39 @@ import { useRouter } from 'next/navigation.js';
 import { useTransition } from 'react';
 import { Lightning } from './icons/Lightning.js';
 import { Spinner } from './icons/Spinner.js';
-export function BulkGenerateAltTextsButton() {
+import { usePluginTranslation } from '../utils/usePluginTranslation.js';
+export function BulkGenerateAltTextsButton({ collectionSlug }) {
+    const { t } = usePluginTranslation();
     const [isPending, startTransition] = useTransition();
     const { selected, setSelection } = useSelection();
     const selectedIds = Array.from(selected.entries()).filter(([, isSelected])=>isSelected).map(([id])=>id);
     const router = useRouter();
     const handleGenerateAltTexts = async ()=>{
         startTransition(async ()=>{
+            if (!collectionSlug) {
+                throw new Error('Collection slug is required');
+            }
             try {
                 const response = await fetch('/api/alt-text-plugin/bulk-generate-alt-texts', {
                     method: 'POST',
                     body: JSON.stringify({
-                        collection: 'media',
+                        collection: collectionSlug,
                         ids: selectedIds
                     })
                 });
                 if (!response.ok) {
-                    toast.error('Failed to generate alt text. Please try again.');
+                    toast.error(t('failedToGenerate'));
                     return;
                 }
                 const data = await response.json();
                 if (data.erroredDocs.length > 0) {
-                    toast.error(`Failed to generate alt text for ${data.erroredDocs.length} images.`);
+                    toast.error(t('failedToGenerateForXImages').replace('{X}', data.erroredDocs.length.toString()));
                 }
                 // in case not all images were updated, show a warning instead of a success message:
                 if (data.updatedDocs === data.totalDocs) {
-                    toast.success(`${data.updatedDocs} of ${data.totalDocs} images updated.`);
+                    toast.success(t('xOfYImagesUpdated').replace('{X}', data.updatedDocs.toString()).replace('{Y}', data.totalDocs.toString()));
                 } else {
-                    toast.warning(`${data.updatedDocs} of ${data.totalDocs} images updated.`);
+                    toast.warning(t('xOfYImagesUpdated').replace('{X}', data.updatedDocs.toString()).replace('{Y}', data.totalDocs.toString()));
                 }
                 // deselect all previously selected images
                 for (const id of selectedIds){
@@ -41,7 +46,7 @@ export function BulkGenerateAltTextsButton() {
                 router.refresh();
             } catch (error) {
                 console.error('Error generating alt text:', error);
-                toast.error('Error generating alt text. Please try again.');
+                toast.error(t('errorGeneratingAltText'));
             }
         });
     };
@@ -57,10 +62,11 @@ export function BulkGenerateAltTextsButton() {
             icon: isPending ? /*#__PURE__*/ _jsx(Spinner, {}) : /*#__PURE__*/ _jsx(Lightning, {}),
             className: "m-0",
             children: [
-                "Generate alt text for ",
-                selectedIds.length,
+                t('generateAltTextFor'),
                 " ",
-                selectedIds.length === 1 ? 'image' : 'images'
+                selectedIds.length,
+                ' ',
+                selectedIds.length === 1 ? t('image') : t('images')
             ]
         })
     });

package/dist/components/BulkGenerateAltTextsButton.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/components/BulkGenerateAltTextsButton.tsx"],"sourcesContent":["'use client'\n\nimport { Button, toast, useSelection } from '@payloadcms/ui'\nimport { useRouter } from 'next/navigation.js'\nimport { useTransition } from 'react'\n\nimport { Lightning } from './icons/Lightning.js'\nimport { Spinner } from './icons/Spinner.js'\n\nexport function BulkGenerateAltTextsButton() {\n  const [isPending, startTransition] = useTransition()\n  const { selected, setSelection } = useSelection()\n\n  const selectedIds = Array.from(selected.entries())\n    .filter(([, isSelected]) => isSelected)\n    .map(([id]) => id) as string[]\n\n  const router = useRouter()\n\n  const handleGenerateAltTexts = async () => {\n    startTransition(async () => {\n      try {\n        const response = await fetch('/api/alt-text-plugin/bulk-generate-alt-texts', {\n          method: 'POST',\n          body: JSON.stringify({\n            collection: 'media',\n            ids: selectedIds,\n          }),\n        })\n\n        if (!response.ok) {\n          toast.error('Failed to generate alt text. Please try again.')\n          return\n        }\n\n        const data = (await response.json()) as {\n          updatedDocs: number\n          totalDocs: number\n          erroredDocs: string[]\n        }\n\n        if (data.erroredDocs.length > 0) {\n          toast.error(`Failed to generate alt text for ${data.erroredDocs.length} images.`)\n        }\n\n        // in case not all images were updated, show a warning instead of a success message:\n        if (data.updatedDocs === data.totalDocs) {\n          toast.success(`${data.updatedDocs} of ${data.totalDocs} images updated.`)\n        } else {\n          toast.warning(`${data.updatedDocs} of ${data.totalDocs} images updated.`)\n        }\n\n        // deselect all previously selected images\n        for (const id of selectedIds) {\n          setSelection(id)\n        }\n\n        router.refresh()\n      } catch (error) {\n        console.error('Error generating alt text:', error)\n        toast.error('Error generating alt text. Please try again.')\n      }\n    })\n  }\n\n  return (\n    selectedIds.length > 0 && (\n      <div style={{ display: 'flex', justifyContent: 'right' }} className=\"m-0\">\n        <Button\n          onClick={handleGenerateAltTexts}\n          disabled={isPending || selectedIds.length === 0}\n          icon={isPending ? <Spinner /> : <Lightning />}\n          className=\"m-0\"\n        >\n          Generate alt text for {selectedIds.length} {selectedIds.length === 1 ? 'image' : 'images'}\n        </Button>\n      </div>\n    )\n  )\n}\n"],"names":["Button","toast","useSelection","useRouter","useTransition","Lightning","Spinner","BulkGenerateAltTextsButton","isPending","startTransition","selected","setSelection","selectedIds","Array","from","entries","filter","isSelected","map","id","router","handleGenerateAltTexts","response","fetch","method","body","JSON","stringify","collection","ids","ok","error","data","json","erroredDocs","length","updatedDocs","totalDocs","success","warning","refresh","console","div","style","display","justifyContent","className","onClick","disabled","icon"],"mappings":"AAAA;;AAEA,SAASA,MAAM,EAAEC,KAAK,EAAEC,YAAY,QAAQ,iBAAgB;AAC5D,SAASC,SAAS,QAAQ,qBAAoB;AAC9C,SAASC,aAAa,QAAQ,QAAO;AAErC,SAASC,SAAS,QAAQ,uBAAsB;AAChD,SAASC,OAAO,QAAQ,qBAAoB;AAE5C,OAAO,SAASC;IACd,MAAM,CAACC,WAAWC,gBAAgB,GAAGL;IACrC,MAAM,EAAEM,QAAQ,EAAEC,YAAY,EAAE,GAAGT;IAEnC,MAAMU,cAAcC,MAAMC,IAAI,CAACJ,SAASK,OAAO,IAC5CC,MAAM,CAAC,CAAC,GAAGC,WAAW,GAAKA,YAC3BC,GAAG,CAAC,CAAC,CAACC,GAAG,GAAKA;IAEjB,MAAMC,SAASjB;IAEf,MAAMkB,yBAAyB;QAC7BZ,gBAAgB;YACd,IAAI;gBACF,MAAMa,WAAW,MAAMC,MAAM,gDAAgD;oBAC3EC,QAAQ;oBACRC,MAAMC,KAAKC,SAAS,CAAC;wBACnBC,YAAY;wBACZC,KAAKjB;oBACP;gBACF;gBAEA,IAAI,CAACU,SAASQ,EAAE,EAAE;oBAChB7B,MAAM8B,KAAK,CAAC;oBACZ;gBACF;gBAEA,MAAMC,OAAQ,MAAMV,SAASW,IAAI;gBAMjC,IAAID,KAAKE,WAAW,CAACC,MAAM,GAAG,GAAG;oBAC/BlC,MAAM8B,KAAK,CAAC,CAAC,gCAAgC,EAAEC,KAAKE,WAAW,CAACC,MAAM,CAAC,QAAQ,CAAC;gBAClF;gBAEA,oFAAoF;gBACpF,IAAIH,KAAKI,WAAW,KAAKJ,KAAKK,SAAS,EAAE;oBACvCpC,MAAMqC,OAAO,CAAC,GAAGN,KAAKI,WAAW,CAAC,IAAI,EAAEJ,KAAKK,SAAS,CAAC,gBAAgB,CAAC;gBAC1E,OAAO;oBACLpC,MAAMsC,OAAO,CAAC,GAAGP,KAAKI,WAAW,CAAC,IAAI,EAAEJ,KAAKK,SAAS,CAAC,gBAAgB,CAAC;gBAC1E;gBAEA,0CAA0C;gBAC1C,KAAK,MAAMlB,MAAMP,YAAa;oBAC5BD,aAAaQ;gBACf;gBAEAC,OAAOoB,OAAO;YAChB,EAAE,OAAOT,OAAO;gBACdU,QAAQV,KAAK,CAAC,8BAA8BA;gBAC5C9B,MAAM8B,KAAK,CAAC;YACd;QACF;IACF;IAEA,OACEnB,YAAYuB,MAAM,GAAG,mBACnB,KAACO;QAAIC,OAAO;YAAEC,SAAS;YAAQC,gBAAgB;QAAQ;QAAGC,WAAU;kBAClE,cAAA,MAAC9C;YACC+C,SAAS1B;YACT2B,UAAUxC,aAAaI,YAAYuB,MAAM,KAAK;YAC9Cc,MAAMzC,0BAAY,KAACF,6BAAa,KAACD;YACjCyC,WAAU;;gBACX;gBACwBlC,YAAYuB,MAAM;gBAAC;gBAAEvB,YAAYuB,MAAM,KAAK,IAAI,UAAU;;;;AAK3F"}
+{"version":3,"sources":["../../src/components/BulkGenerateAltTextsButton.tsx"],"sourcesContent":["'use client'\n\nimport { Button, toast, useSelection } from '@payloadcms/ui'\nimport { useRouter } from 'next/navigation.js'\nimport { useTransition } from 'react'\n\nimport { Lightning } from './icons/Lightning.js'\nimport { Spinner } from './icons/Spinner.js'\nimport { usePluginTranslation } from '../utils/usePluginTranslation.js'\n\nexport function BulkGenerateAltTextsButton({ collectionSlug }: { collectionSlug: string }) {\n  const { t } = usePluginTranslation()\n  const [isPending, startTransition] = useTransition()\n  const { selected, setSelection } = useSelection()\n\n  const selectedIds = Array.from(selected.entries())\n    .filter(([, isSelected]) => isSelected)\n    .map(([id]) => id) as string[]\n\n  const router = useRouter()\n\n  const handleGenerateAltTexts = async () => {\n    startTransition(async () => {\n      if (!collectionSlug) {\n        throw new Error('Collection slug is required')\n      }\n\n      try {\n        const response = await fetch('/api/alt-text-plugin/bulk-generate-alt-texts', {\n          method: 'POST',\n          body: JSON.stringify({\n            collection: collectionSlug,\n            ids: selectedIds,\n          }),\n        })\n\n        if (!response.ok) {\n          toast.error(t('failedToGenerate'))\n          return\n        }\n\n        const data = (await response.json()) as {\n          updatedDocs: number\n          totalDocs: number\n          erroredDocs: string[]\n        }\n\n        if (data.erroredDocs.length > 0) {\n          toast.error(\n            t('failedToGenerateForXImages').replace('{X}', data.erroredDocs.length.toString()),\n          )\n        }\n\n        // in case not all images were updated, show a warning instead of a success message:\n        if (data.updatedDocs === data.totalDocs) {\n          toast.success(\n            t('xOfYImagesUpdated')\n              .replace('{X}', data.updatedDocs.toString())\n              .replace('{Y}', data.totalDocs.toString()),\n          )\n        } else {\n          toast.warning(\n            t('xOfYImagesUpdated')\n              .replace('{X}', data.updatedDocs.toString())\n              .replace('{Y}', data.totalDocs.toString()),\n          )\n        }\n\n        // deselect all previously selected images\n        for (const id of selectedIds) {\n          setSelection(id)\n        }\n\n        router.refresh()\n      } catch (error) {\n        console.error('Error generating alt text:', error)\n        toast.error(t('errorGeneratingAltText'))\n      }\n    })\n  }\n\n  return (\n    selectedIds.length > 0 && (\n      <div style={{ display: 'flex', justifyContent: 'right' }} className=\"m-0\">\n        <Button\n          onClick={handleGenerateAltTexts}\n          disabled={isPending || selectedIds.length === 0}\n          icon={isPending ? <Spinner /> : <Lightning />}\n          className=\"m-0\"\n        >\n          {t('generateAltTextFor')} {selectedIds.length}{' '}\n          {selectedIds.length === 1 ? t('image') : t('images')}\n        </Button>\n      </div>\n    )\n  )\n}\n"],"names":["Button","toast","useSelection","useRouter","useTransition","Lightning","Spinner","usePluginTranslation","BulkGenerateAltTextsButton","collectionSlug","t","isPending","startTransition","selected","setSelection","selectedIds","Array","from","entries","filter","isSelected","map","id","router","handleGenerateAltTexts","Error","response","fetch","method","body","JSON","stringify","collection","ids","ok","error","data","json","erroredDocs","length","replace","toString","updatedDocs","totalDocs","success","warning","refresh","console","div","style","display","justifyContent","className","onClick","disabled","icon"],"mappings":"AAAA;;AAEA,SAASA,MAAM,EAAEC,KAAK,EAAEC,YAAY,QAAQ,iBAAgB;AAC5D,SAASC,SAAS,QAAQ,qBAAoB;AAC9C,SAASC,aAAa,QAAQ,QAAO;AAErC,SAASC,SAAS,QAAQ,uBAAsB;AAChD,SAASC,OAAO,QAAQ,qBAAoB;AAC5C,SAASC,oBAAoB,QAAQ,mCAAkC;AAEvE,OAAO,SAASC,2BAA2B,EAAEC,cAAc,EAA8B;IACvF,MAAM,EAAEC,CAAC,EAAE,GAAGH;IACd,MAAM,CAACI,WAAWC,gBAAgB,GAAGR;IACrC,MAAM,EAAES,QAAQ,EAAEC,YAAY,EAAE,GAAGZ;IAEnC,MAAMa,cAAcC,MAAMC,IAAI,CAACJ,SAASK,OAAO,IAC5CC,MAAM,CAAC,CAAC,GAAGC,WAAW,GAAKA,YAC3BC,GAAG,CAAC,CAAC,CAACC,GAAG,GAAKA;IAEjB,MAAMC,SAASpB;IAEf,MAAMqB,yBAAyB;QAC7BZ,gBAAgB;YACd,IAAI,CAACH,gBAAgB;gBACnB,MAAM,IAAIgB,MAAM;YAClB;YAEA,IAAI;gBACF,MAAMC,WAAW,MAAMC,MAAM,gDAAgD;oBAC3EC,QAAQ;oBACRC,MAAMC,KAAKC,SAAS,CAAC;wBACnBC,YAAYvB;wBACZwB,KAAKlB;oBACP;gBACF;gBAEA,IAAI,CAACW,SAASQ,EAAE,EAAE;oBAChBjC,MAAMkC,KAAK,CAACzB,EAAE;oBACd;gBACF;gBAEA,MAAM0B,OAAQ,MAAMV,SAASW,IAAI;gBAMjC,IAAID,KAAKE,WAAW,CAACC,MAAM,GAAG,GAAG;oBAC/BtC,MAAMkC,KAAK,CACTzB,EAAE,8BAA8B8B,OAAO,CAAC,OAAOJ,KAAKE,WAAW,CAACC,MAAM,CAACE,QAAQ;gBAEnF;gBAEA,oFAAoF;gBACpF,IAAIL,KAAKM,WAAW,KAAKN,KAAKO,SAAS,EAAE;oBACvC1C,MAAM2C,OAAO,CACXlC,EAAE,qBACC8B,OAAO,CAAC,OAAOJ,KAAKM,WAAW,CAACD,QAAQ,IACxCD,OAAO,CAAC,OAAOJ,KAAKO,SAAS,CAACF,QAAQ;gBAE7C,OAAO;oBACLxC,MAAM4C,OAAO,CACXnC,EAAE,qBACC8B,OAAO,CAAC,OAAOJ,KAAKM,WAAW,CAACD,QAAQ,IACxCD,OAAO,CAAC,OAAOJ,KAAKO,SAAS,CAACF,QAAQ;gBAE7C;gBAEA,0CAA0C;gBAC1C,KAAK,MAAMnB,MAAMP,YAAa;oBAC5BD,aAAaQ;gBACf;gBAEAC,OAAOuB,OAAO;YAChB,EAAE,OAAOX,OAAO;gBACdY,QAAQZ,KAAK,CAAC,8BAA8BA;gBAC5ClC,MAAMkC,KAAK,CAACzB,EAAE;YAChB;QACF;IACF;IAEA,OACEK,YAAYwB,MAAM,GAAG,mBACnB,KAACS;QAAIC,OAAO;YAAEC,SAAS;YAAQC,gBAAgB;QAAQ;QAAGC,WAAU;kBAClE,cAAA,MAACpD;YACCqD,SAAS7B;YACT8B,UAAU3C,aAAaI,YAAYwB,MAAM,KAAK;YAC9CgB,MAAM5C,0BAAY,KAACL,6BAAa,KAACD;YACjC+C,WAAU;;gBAET1C,EAAE;gBAAsB;gBAAEK,YAAYwB,MAAM;gBAAE;gBAC9CxB,YAAYwB,MAAM,KAAK,IAAI7B,EAAE,WAAWA,EAAE;;;;AAKrD"}

package/dist/components/GenerateAltTextButton.js

@@ -4,7 +4,9 @@ import { Button, toast, useDocumentInfo, useField, useLocale } from '@payloadcms
 import { useTransition } from 'react';
 import { Lightning } from './icons/Lightning.js';
 import { Spinner } from './icons/Spinner.js';
+import { usePluginTranslation } from '../utils/usePluginTranslation.js';
 export function GenerateAltTextButton() {
+    const { t } = usePluginTranslation();
     const { id, collectionSlug } = useDocumentInfo();
     const locale = useLocale();
     const [isPending, startTransition] = useTransition();
@@ -16,7 +18,7 @@ export function GenerateAltTextButton() {
     });
     const handleGenerateAltText = async ()=>{
         if (!collectionSlug || !id) {
-            toast.error('Cannot generate alt text. Missing required fields.');
+            toast.error(t('cannotGenerateMissingFields'));
             throw new Error('Missing required fields');
         }
         startTransition(async ()=>{
@@ -26,11 +28,11 @@ export function GenerateAltTextButton() {
                     body: JSON.stringify({
                         collection: collectionSlug,
                         id: id,
-                        locale: locale.code
+                        locale: locale?.code ?? null
                     })
                 });
                 if (!response.ok) {
-                    let errorMessage = 'Failed to generate alt text. Please try again.';
+                    let errorMessage = t('failedToGenerate');
                     try {
                         const errorData = await response.json();
                         errorMessage = errorData.error;
@@ -44,13 +46,13 @@ export function GenerateAltTextButton() {
                 if (data.altText && data.keywords) {
                     setAltText(data.altText);
                     setKeywords(data.keywords);
-                    toast.success('Alt text generated successfully. Please review and save the document.');
+                    toast.success(t('altTextGeneratedSuccess'));
                 } else {
-                    toast.error('No alt text generated. Please try again.');
+                    toast.error(t('noAltTextGenerated'));
                 }
             } catch (error) {
                 console.error('Error generating alt text:', error);
-                toast.error('Error generating alt text. Please try again.');
+                toast.error(t('errorGeneratingAltText'));
             }
         });
     };
@@ -68,7 +70,7 @@ export function GenerateAltTextButton() {
                 },
                 children: [
                     /*#__PURE__*/ _jsx("p", {
-                        children: "Alternate text for the image. This will be used for screen readers and SEO. It should meet the following requirements:"
+                        children: t('altTextDescription')
                     }),
                     /*#__PURE__*/ _jsxs("ol", {
                         style: {
@@ -77,13 +79,13 @@ export function GenerateAltTextButton() {
                         },
                         children: [
                             /*#__PURE__*/ _jsx("li", {
-                                children: "Briefly describe what is visible in the image in 1–2 sentences."
+                                children: t('altTextRequirement1')
                             }),
                             /*#__PURE__*/ _jsx("li", {
-                                children: "Ensure it conveys the same information or purpose as the image, whenever possible."
+                                children: t('altTextRequirement2')
                             }),
                             /*#__PURE__*/ _jsx("li", {
-                                children: 'Avoid phrases like "image of" or "picture of" — screen readers already announce that it"s an image.'
+                                children: t('altTextRequirement3')
                             })
                         ]
                     })
@@ -98,8 +100,8 @@ export function GenerateAltTextButton() {
                     onClick: handleGenerateAltText,
                     disabled: isPending || !id,
                     icon: isPending ? /*#__PURE__*/ _jsx(Spinner, {}) : /*#__PURE__*/ _jsx(Lightning, {}),
-                    tooltip: !id ? 'Please save the document first' : undefined,
-                    children: "Generate alt text"
+                    tooltip: !id ? t('pleaseSaveDocumentFirst') : undefined,
+                    children: t('generateAltText')
                 })
             })
         ]

package/dist/components/GenerateAltTextButton.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/components/GenerateAltTextButton.tsx"],"sourcesContent":["'use client'\n\nimport { Button, toast, useDocumentInfo, useField, useLocale } from '@payloadcms/ui'\nimport { useTransition } from 'react'\n\nimport { Lightning } from './icons/Lightning.js'\nimport { Spinner } from './icons/Spinner.js'\n\nexport function GenerateAltTextButton() {\n  const { id, collectionSlug } = useDocumentInfo()\n  const locale = useLocale()\n  const [isPending, startTransition] = useTransition()\n\n  const { setValue: setKeywords } = useField<string>({ path: 'keywords' })\n  const { setValue: setAltText } = useField<string>({ path: 'alt' })\n\n  const handleGenerateAltText = async () => {\n    if (!collectionSlug || !id) {\n      toast.error('Cannot generate alt text. Missing required fields.')\n      throw new Error('Missing required fields')\n    }\n\n    startTransition(async () => {\n      try {\n        const response = await fetch('/api/alt-text-plugin/generate-alt-text', {\n          method: 'POST',\n          body: JSON.stringify({\n            collection: collectionSlug,\n            id: id as string,\n            locale: locale.code,\n          }),\n        })\n\n        if (!response.ok) {\n          let errorMessage = 'Failed to generate alt text. Please try again.'\n          try {\n            const errorData = (await response.json()) as { error: string }\n            errorMessage = errorData.error\n          } catch (error) {\n            console.error('Error generating alt text:', error)\n          }\n\n          toast.error(errorMessage)\n          return\n        }\n\n        const data = (await response.json()) as {\n          altText: string\n          keywords: string[]\n        }\n\n        if (data.altText && data.keywords) {\n          setAltText(data.altText)\n          setKeywords(data.keywords)\n          toast.success('Alt text generated successfully. Please review and save the document.')\n        } else {\n          toast.error('No alt text generated. Please try again.')\n        }\n      } catch (error) {\n        console.error('Error generating alt text:', error)\n        toast.error('Error generating alt text. Please try again.')\n      }\n    })\n  }\n\n  return (\n    <div style={{ display: 'flex', gap: '20px', marginTop: '10px' }}>\n      <div style={{ flex: '1', color: 'var(--theme-elevation-400)' }}>\n        <p>\n          Alternate text for the image. This will be used for screen readers and SEO. It should meet\n          the following requirements:\n        </p>\n        <ol style={{ paddingLeft: '20px', margin: '10px 0' }}>\n          <li>Briefly describe what is visible in the image in 1–2 sentences.</li>\n          <li>\n            Ensure it conveys the same information or purpose as the image, whenever possible.\n          </li>\n          <li>\n            Avoid phrases like &quot;image of&quot; or &quot;picture of&quot; — screen readers\n            already announce that it&quot;s an image.\n          </li>\n        </ol>\n      </div>\n      <div style={{ display: 'flex', alignItems: 'center' }}>\n        <Button\n          onClick={handleGenerateAltText}\n          disabled={isPending || !id}\n          icon={isPending ? <Spinner /> : <Lightning />}\n          tooltip={!id ? 'Please save the document first' : undefined}\n        >\n          Generate alt text\n        </Button>\n      </div>\n    </div>\n  )\n}\n"],"names":["Button","toast","useDocumentInfo","useField","useLocale","useTransition","Lightning","Spinner","GenerateAltTextButton","id","collectionSlug","locale","isPending","startTransition","setValue","setKeywords","path","setAltText","handleGenerateAltText","error","Error","response","fetch","method","body","JSON","stringify","collection","code","ok","errorMessage","errorData","json","console","data","altText","keywords","success","div","style","display","gap","marginTop","flex","color","p","ol","paddingLeft","margin","li","alignItems","onClick","disabled","icon","tooltip","undefined"],"mappings":"AAAA;;AAEA,SAASA,MAAM,EAAEC,KAAK,EAAEC,eAAe,EAAEC,QAAQ,EAAEC,SAAS,QAAQ,iBAAgB;AACpF,SAASC,aAAa,QAAQ,QAAO;AAErC,SAASC,SAAS,QAAQ,uBAAsB;AAChD,SAASC,OAAO,QAAQ,qBAAoB;AAE5C,OAAO,SAASC;IACd,MAAM,EAAEC,EAAE,EAAEC,cAAc,EAAE,GAAGR;IAC/B,MAAMS,SAASP;IACf,MAAM,CAACQ,WAAWC,gBAAgB,GAAGR;IAErC,MAAM,EAAES,UAAUC,WAAW,EAAE,GAAGZ,SAAiB;QAAEa,MAAM;IAAW;IACtE,MAAM,EAAEF,UAAUG,UAAU,EAAE,GAAGd,SAAiB;QAAEa,MAAM;IAAM;IAEhE,MAAME,wBAAwB;QAC5B,IAAI,CAACR,kBAAkB,CAACD,IAAI;YAC1BR,MAAMkB,KAAK,CAAC;YACZ,MAAM,IAAIC,MAAM;QAClB;QAEAP,gBAAgB;YACd,IAAI;gBACF,MAAMQ,WAAW,MAAMC,MAAM,0CAA0C;oBACrEC,QAAQ;oBACRC,MAAMC,KAAKC,SAAS,CAAC;wBACnBC,YAAYjB;wBACZD,IAAIA;wBACJE,QAAQA,OAAOiB,IAAI;oBACrB;gBACF;gBAEA,IAAI,CAACP,SAASQ,EAAE,EAAE;oBAChB,IAAIC,eAAe;oBACnB,IAAI;wBACF,MAAMC,YAAa,MAAMV,SAASW,IAAI;wBACtCF,eAAeC,UAAUZ,KAAK;oBAChC,EAAE,OAAOA,OAAO;wBACdc,QAAQd,KAAK,CAAC,8BAA8BA;oBAC9C;oBAEAlB,MAAMkB,KAAK,CAACW;oBACZ;gBACF;gBAEA,MAAMI,OAAQ,MAAMb,SAASW,IAAI;gBAKjC,IAAIE,KAAKC,OAAO,IAAID,KAAKE,QAAQ,EAAE;oBACjCnB,WAAWiB,KAAKC,OAAO;oBACvBpB,YAAYmB,KAAKE,QAAQ;oBACzBnC,MAAMoC,OAAO,CAAC;gBAChB,OAAO;oBACLpC,MAAMkB,KAAK,CAAC;gBACd;YACF,EAAE,OAAOA,OAAO;gBACdc,QAAQd,KAAK,CAAC,8BAA8BA;gBAC5ClB,MAAMkB,KAAK,CAAC;YACd;QACF;IACF;IAEA,qBACE,MAACmB;QAAIC,OAAO;YAAEC,SAAS;YAAQC,KAAK;YAAQC,WAAW;QAAO;;0BAC5D,MAACJ;gBAAIC,OAAO;oBAAEI,MAAM;oBAAKC,OAAO;gBAA6B;;kCAC3D,KAACC;kCAAE;;kCAIH,MAACC;wBAAGP,OAAO;4BAAEQ,aAAa;4BAAQC,QAAQ;wBAAS;;0CACjD,KAACC;0CAAG;;0CACJ,KAACA;0CAAG;;0CAGJ,KAACA;0CAAG;;;;;;0BAMR,KAACX;gBAAIC,OAAO;oBAAEC,SAAS;oBAAQU,YAAY;gBAAS;0BAClD,cAAA,KAAClD;oBACCmD,SAASjC;oBACTkC,UAAUxC,aAAa,CAACH;oBACxB4C,MAAMzC,0BAAY,KAACL,6BAAa,KAACD;oBACjCgD,SAAS,CAAC7C,KAAK,mCAAmC8C;8BACnD;;;;;AAMT"}
+{"version":3,"sources":["../../src/components/GenerateAltTextButton.tsx"],"sourcesContent":["'use client'\n\nimport { Button, toast, useDocumentInfo, useField, useLocale } from '@payloadcms/ui'\nimport { useTransition } from 'react'\n\nimport { Lightning } from './icons/Lightning.js'\nimport { Spinner } from './icons/Spinner.js'\nimport { usePluginTranslation } from '../utils/usePluginTranslation.js'\n\nexport function GenerateAltTextButton() {\n  const { t } = usePluginTranslation()\n  const { id, collectionSlug } = useDocumentInfo()\n  const locale = useLocale()\n  const [isPending, startTransition] = useTransition()\n\n  const { setValue: setKeywords } = useField<string>({ path: 'keywords' })\n  const { setValue: setAltText } = useField<string>({ path: 'alt' })\n\n  const handleGenerateAltText = async () => {\n    if (!collectionSlug || !id) {\n      toast.error(t('cannotGenerateMissingFields'))\n      throw new Error('Missing required fields')\n    }\n\n    startTransition(async () => {\n      try {\n        const response = await fetch('/api/alt-text-plugin/generate-alt-text', {\n          method: 'POST',\n          body: JSON.stringify({\n            collection: collectionSlug,\n            id: id as string,\n            locale: locale?.code ?? null, // sent null when localization is disabled\n          }),\n        })\n\n        if (!response.ok) {\n          let errorMessage = t('failedToGenerate')\n          try {\n            const errorData = (await response.json()) as { error: string }\n            errorMessage = errorData.error\n          } catch (error) {\n            console.error('Error generating alt text:', error)\n          }\n\n          toast.error(errorMessage)\n          return\n        }\n\n        const data = (await response.json()) as {\n          altText: string\n          keywords: string[]\n        }\n\n        if (data.altText && data.keywords) {\n          setAltText(data.altText)\n          setKeywords(data.keywords)\n          toast.success(t('altTextGeneratedSuccess'))\n        } else {\n          toast.error(t('noAltTextGenerated'))\n        }\n      } catch (error) {\n        console.error('Error generating alt text:', error)\n        toast.error(t('errorGeneratingAltText'))\n      }\n    })\n  }\n\n  return (\n    <div style={{ display: 'flex', gap: '20px', marginTop: '10px' }}>\n      <div style={{ flex: '1', color: 'var(--theme-elevation-400)' }}>\n        <p>{t('altTextDescription')}</p>\n        <ol style={{ paddingLeft: '20px', margin: '10px 0' }}>\n          <li>{t('altTextRequirement1')}</li>\n          <li>{t('altTextRequirement2')}</li>\n          <li>{t('altTextRequirement3')}</li>\n        </ol>\n      </div>\n      <div style={{ display: 'flex', alignItems: 'center' }}>\n        <Button\n          onClick={handleGenerateAltText}\n          disabled={isPending || !id}\n          icon={isPending ? <Spinner /> : <Lightning />}\n          tooltip={!id ? t('pleaseSaveDocumentFirst') : undefined}\n        >\n          {t('generateAltText')}\n        </Button>\n      </div>\n    </div>\n  )\n}\n"],"names":["Button","toast","useDocumentInfo","useField","useLocale","useTransition","Lightning","Spinner","usePluginTranslation","GenerateAltTextButton","t","id","collectionSlug","locale","isPending","startTransition","setValue","setKeywords","path","setAltText","handleGenerateAltText","error","Error","response","fetch","method","body","JSON","stringify","collection","code","ok","errorMessage","errorData","json","console","data","altText","keywords","success","div","style","display","gap","marginTop","flex","color","p","ol","paddingLeft","margin","li","alignItems","onClick","disabled","icon","tooltip","undefined"],"mappings":"AAAA;;AAEA,SAASA,MAAM,EAAEC,KAAK,EAAEC,eAAe,EAAEC,QAAQ,EAAEC,SAAS,QAAQ,iBAAgB;AACpF,SAASC,aAAa,QAAQ,QAAO;AAErC,SAASC,SAAS,QAAQ,uBAAsB;AAChD,SAASC,OAAO,QAAQ,qBAAoB;AAC5C,SAASC,oBAAoB,QAAQ,mCAAkC;AAEvE,OAAO,SAASC;IACd,MAAM,EAAEC,CAAC,EAAE,GAAGF;IACd,MAAM,EAAEG,EAAE,EAAEC,cAAc,EAAE,GAAGV;IAC/B,MAAMW,SAAST;IACf,MAAM,CAACU,WAAWC,gBAAgB,GAAGV;IAErC,MAAM,EAAEW,UAAUC,WAAW,EAAE,GAAGd,SAAiB;QAAEe,MAAM;IAAW;IACtE,MAAM,EAAEF,UAAUG,UAAU,EAAE,GAAGhB,SAAiB;QAAEe,MAAM;IAAM;IAEhE,MAAME,wBAAwB;QAC5B,IAAI,CAACR,kBAAkB,CAACD,IAAI;YAC1BV,MAAMoB,KAAK,CAACX,EAAE;YACd,MAAM,IAAIY,MAAM;QAClB;QAEAP,gBAAgB;YACd,IAAI;gBACF,MAAMQ,WAAW,MAAMC,MAAM,0CAA0C;oBACrEC,QAAQ;oBACRC,MAAMC,KAAKC,SAAS,CAAC;wBACnBC,YAAYjB;wBACZD,IAAIA;wBACJE,QAAQA,QAAQiB,QAAQ;oBAC1B;gBACF;gBAEA,IAAI,CAACP,SAASQ,EAAE,EAAE;oBAChB,IAAIC,eAAetB,EAAE;oBACrB,IAAI;wBACF,MAAMuB,YAAa,MAAMV,SAASW,IAAI;wBACtCF,eAAeC,UAAUZ,KAAK;oBAChC,EAAE,OAAOA,OAAO;wBACdc,QAAQd,KAAK,CAAC,8BAA8BA;oBAC9C;oBAEApB,MAAMoB,KAAK,CAACW;oBACZ;gBACF;gBAEA,MAAMI,OAAQ,MAAMb,SAASW,IAAI;gBAKjC,IAAIE,KAAKC,OAAO,IAAID,KAAKE,QAAQ,EAAE;oBACjCnB,WAAWiB,KAAKC,OAAO;oBACvBpB,YAAYmB,KAAKE,QAAQ;oBACzBrC,MAAMsC,OAAO,CAAC7B,EAAE;gBAClB,OAAO;oBACLT,MAAMoB,KAAK,CAACX,EAAE;gBAChB;YACF,EAAE,OAAOW,OAAO;gBACdc,QAAQd,KAAK,CAAC,8BAA8BA;gBAC5CpB,MAAMoB,KAAK,CAACX,EAAE;YAChB;QACF;IACF;IAEA,qBACE,MAAC8B;QAAIC,OAAO;YAAEC,SAAS;YAAQC,KAAK;YAAQC,WAAW;QAAO;;0BAC5D,MAACJ;gBAAIC,OAAO;oBAAEI,MAAM;oBAAKC,OAAO;gBAA6B;;kCAC3D,KAACC;kCAAGrC,EAAE;;kCACN,MAACsC;wBAAGP,OAAO;4BAAEQ,aAAa;4BAAQC,QAAQ;wBAAS;;0CACjD,KAACC;0CAAIzC,EAAE;;0CACP,KAACyC;0CAAIzC,EAAE;;0CACP,KAACyC;0CAAIzC,EAAE;;;;;;0BAGX,KAAC8B;gBAAIC,OAAO;oBAAEC,SAAS;oBAAQU,YAAY;gBAAS;0BAClD,cAAA,KAACpD;oBACCqD,SAASjC;oBACTkC,UAAUxC,aAAa,CAACH;oBACxB4C,MAAMzC,0BAAY,KAACP,6BAAa,KAACD;oBACjCkD,SAAS,CAAC7C,KAAKD,EAAE,6BAA6B+C;8BAE7C/C,EAAE;;;;;AAKb"}

package/dist/endpoints/bulkGenerateAltTexts.js

@@ -3,6 +3,7 @@ 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.
  */ export const bulkGenerateAltTextsEndpoint = async (req)=>{
@@ -24,7 +25,14 @@ import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
         const erroredDocs = [];
         // Get plugin config from payload config
         const pluginConfig = req.payload.config.custom?.altTextPluginConfig;
-        if (!pluginConfig?.openAIApiKey) {
+        if (!pluginConfig) {
+            return Response.json({
+                error: 'Plugin config not found'
+            }, {
+                status: 500
+            });
+        }
+        if (!pluginConfig.openAIApiKey) {
             return Response.json({
                 error: 'OpenAI API key not configured'
             }, {
@@ -33,6 +41,18 @@ import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
         }
         // Use concurrency from config
         const concurrency = pluginConfig.maxBulkGenerateConcurrency || 16;
+        // determine target locales based on config
+        const locales = localesFromConfig(req.payload.config);
+        const targetLocales = locales ?? [
+            pluginConfig.locale
+        ];
+        if (!targetLocales) {
+            return Response.json({
+                error: 'Could not determine target locales for alt text generation. Please check your plugin configuration.'
+            }, {
+                status: 500
+            });
+        }
         await pMap(ids, async (id)=>{
             try {
                 await generateAndUpdateAltText({
@@ -40,7 +60,7 @@ import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
                     id,
                     collection,
                     pluginConfig,
-                    locales: pluginConfig.locales
+                    locales: targetLocales
                 });
                 updatedDocs++;
                 console.log(`${updatedDocs}/${ids.length} updated (${Math.round(updatedDocs / ids.length * 100)}%)`);

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'\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?.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    await pMap(\n      ids,\n      async (id) => {\n        try {\n          await generateAndUpdateAltText({\n            payload: req.payload,\n            id,\n            collection,\n            pluginConfig,\n            locales: pluginConfig.locales,\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","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","id","generateAndUpdateAltText","locales","console","log","length","Math","round","push","join","totalDocs","Error","message","imageDoc","findByID","depth","imageThumbnailUrl","getImageThumbnail","openai","apiKey","modelResponseSchema","Object","fromEntries","map","locale","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;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,SAASX,EAAEY,MAAM,CAAC;YACtBC,YAAYb,EAAEc,MAAM;YACpBC,KAAKf,EAAEgB,KAAK,CAAChB,EAAEc,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,cAAcK,cAAc;YAC/B,OAAOnB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAgC,GAAG;gBAAEC,QAAQ;YAAI;QACjF;QAEA,8BAA8B;QAC9B,MAAMiB,cAAcN,aAAaO,0BAA0B,IAAI;QAE/D,MAAM5B,KACJgB,KACA,OAAOa;YACL,IAAI;gBACF,MAAMC,yBAAyB;oBAC7BR,SAASjB,IAAIiB,OAAO;oBACpBO;oBACAf;oBACAO;oBACAU,SAASV,aAAaU,OAAO;gBAC/B;gBACAZ;gBACAa,QAAQC,GAAG,CACT,GAAGd,YAAY,CAAC,EAAEH,IAAIkB,MAAM,CAAC,UAAU,EAAEC,KAAKC,KAAK,CAAC,AAACjB,cAAcH,IAAIkB,MAAM,GAAI,KAAK,EAAE,CAAC;YAE7F,EAAE,OAAOzB,OAAO;gBACduB,QAAQvB,KAAK,CAAC,CAAC,8BAA8B,EAAEoB,GAAG,CAAC,CAAC,EAAEpB;gBACtDW,YAAYiB,IAAI,CAACR;YACnB;QACF,GACA;YAAEF;QAAY;QAGhB,IAAIP,YAAYc,MAAM,GAAG,GAAG;YAC1BF,QAAQvB,KAAK,CAAC,CAAC,YAAY,EAAEW,YAAYkB,IAAI,CAAC,OAAO;QACvD;QAEA,OAAO/B,SAASC,IAAI,CAAC;YACnBW;YACAoB,WAAWvB,IAAIkB,MAAM;YACrBd;QACF;IACF,EAAE,OAAOX,OAAO;QACduB,QAAQvB,KAAK,CAAC,6BAA6BA;QAC3C,OAAOF,SAASC,IAAI,CAClB;YACEC,OAAO,CAAC,2BAA2B,EAAEA,iBAAiB+B,QAAQ/B,MAAMgC,OAAO,GAAG,iBAAiB;QACjG,GACA;YAAE/B,QAAQ;QAAI;IAElB;AACF,EAAC;AAED,eAAeoB,yBAAyB,EACtCR,OAAO,EACPO,EAAE,EACFf,UAAU,EACVO,YAAY,EACZU,OAAO,EAOR;IACC,MAAMW,WAAW,MAAMpB,QAAQqB,QAAQ,CAAC;QACtC7B,YAAYA;QACZe,IAAIA;QACJe,OAAO;IACT;IAEA,IAAI,CAACF,UAAU;QACb,MAAM,IAAIF,MAAM;IAClB;IAEA,MAAMK,oBAAoBxB,aAAayB,iBAAiB,CAACJ;IAEzD,MAAMK,SAAS,IAAIhD,OAAO;QACxBiD,QAAQ3B,aAAaK,YAAY;IACnC;IAEA,MAAMuB,sBAAsBhD,EAAEY,MAAM,CAClCqC,OAAOC,WAAW,CAChBpB,QAAQqB,GAAG,CAAC,CAACC,SAAW;YACtBA;YACApD,EAAEY,MAAM,CAAC;gBACPyC,SAASrD,EAAEc,MAAM,GAAGwC,QAAQ,CAAC;gBAC7BC,UAAUvD,EAAEgB,KAAK,CAAChB,EAAEc,MAAM,IAAIwC,QAAQ,CAAC;YACzC;SACD;IAIL,MAAME,WAAW,MAAMV,OAAOW,IAAI,CAACC,WAAW,CAACzC,KAAK,CAAC;QACnD0C,OAAOvC,aAAauC,KAAK;QACzBC,UAAU;YACR;gBACEC,MAAM;gBACNC,SAAS,CAAC;;;kEAGgD,EAAEhC,QAAQO,IAAI,CAAC,MAAM;;;;;;iDAMtC,EAAEP,QAAQO,IAAI,CAAC,MAAM;IAClE,CAAC;YACC;YACA;gBACEwB,MAAM;gBACNC,SAAS;oBACP;wBACEC,MAAM;wBACNC,WAAW;4BAAEC,KAAKrB;wBAAkB;oBACtC;uBACI,cAAcH,YAAYA,SAASyB,QAAQ,GAC3C;wBACE;4BACEH,MAAM;4BACNI,MAAM1B,SAASyB,QAAQ;wBACzB;qBACD,GACD,EAAE;iBACP;YACH;SACD;QACDE,uBAAuB;QACvBC,iBAAiBnE,kBAAkB8C,qBAAqB;IAC1D;IAEAjB,QAAQC,GAAG,CAAC;QAAEsC,SAAS1C;QAAI,GAAG3B,kBAAkBuD,UAAUpC,aAAauC,KAAK,CAAC;IAAC;IAE9E,MAAMY,SAASf,SAASgB,OAAO,CAAC,EAAE,EAAEhC,SAASiC;IAE7C,IAAI,CAACF,QAAQ;QACX,MAAM,IAAIhC,MAAM;IAClB;IAEA,KAAK,MAAMa,UAAUtB,QAAS;QAC5B,MAAMT,QAAQqD,MAAM,CAAC;YACnB7D,YAAYA;YACZe,IAAIA;YACJwB,QAAQA;YACR1C,MAAM;gBACJiE,KAAK,AAACJ,MAAc,CAACnB,OAAO,EAAEC;gBAC9BE,UAAU,AAACgB,MAAc,CAACnB,OAAO,EAAEG;YACrC;QACF;IACF;AACF"}
+{"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"}

package/dist/endpoints/generateAltText.js

@@ -18,7 +18,7 @@ import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
         const requestSchema = z.object({
             collection: z.string(),
             id: z.string(),
-            locale: z.string()
+            locale: z.string().nullable()
         });
         const { collection, id, locale } = requestSchema.parse(data);
         const imageDoc = await req.payload.findByID({
@@ -34,13 +34,29 @@ import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
             });
         }
         const pluginConfig = req.payload.config.custom?.altTextPluginConfig;
-        if (!pluginConfig?.getImageThumbnail) {
+        if (!pluginConfig) {
+            return Response.json({
+                error: 'Plugin config not found'
+            }, {
+                status: 500
+            });
+        }
+        if (!pluginConfig.getImageThumbnail) {
             return Response.json({
                 error: 'getImageThumbnail function not configured'
             }, {
                 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) {
             return Response.json({
@@ -77,7 +93,7 @@ import { zodResponseFormat } from '../utilities/zodResponseFormat.js';
 
             If a context is provided, use it to enhance the alt text.
 
-            Format your response as a JSON object. You must respond in the ${locale} language.
+            Format your response as a JSON object. You must respond in the ${targetLocale} language.
           `
                 },
                 {

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(),\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?.getImageThumbnail) {\n      return Response.json({ error: 'getImageThumbnail function not configured' }, { status: 500 })\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 ${locale} 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","parse","imageDoc","payload","findByID","depth","pluginConfig","config","custom","altTextPluginConfig","getImageThumbnail","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;QAClB;QAEA,MAAM,EAAED,UAAU,EAAEE,EAAE,EAAEC,MAAM,EAAE,GAAGL,cAAcM,KAAK,CAACP;QAEvD,MAAMQ,WAAW,MAAMd,IAAIe,OAAO,CAACC,QAAQ,CAAC;YAC1CP;YACAE;YACAM,OAAO;QACT;QAEA,IAAI,CAACH,UAAU;YACb,OAAOZ,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAkB,GAAG;gBAAEC,QAAQ;YAAI;QACnE;QAEA,MAAMa,eAAelB,IAAIe,OAAO,CAACI,MAAM,CAACC,MAAM,EAAEC;QAIhD,IAAI,CAACH,cAAcI,mBAAmB;YACpC,OAAOpB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAA4C,GAAG;gBAAEC,QAAQ;YAAI;QAC7F;QACA,MAAMkB,oBAAoBL,aAAaI,iBAAiB,CAACR;QAEzD,IAAI,CAACS,mBAAmB;YACtB,OAAOrB,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAkC,GAAG;gBAAEC,QAAQ;YAAI;QACnF;QAEA,IAAI,CAACkB,kBAAkBC,UAAU,CAAC,eAAe,CAACD,kBAAkBE,QAAQ,CAAC,YAAY;YACvF,OAAOvB,SAASC,IAAI,CAClB;gBAAEC,OAAO;YAAiF,GAC1F;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMqB,SAAS,IAAI/B,OAAO;YACxBgC,QAAQT,aAAaU,YAAY;QACnC;QAEA,MAAMC,sBAAsBjC,EAAEY,MAAM,CAAC;YACnCsB,SAASlC,EAAEc,MAAM,GAAGqB,QAAQ,CAAC;YAC7BC,UAAUpC,EAAEqC,KAAK,CAACrC,EAAEc,MAAM,IAAIqB,QAAQ,CAAC;QACzC;QAEA,MAAMG,WAAW,MAAMR,OAAOS,IAAI,CAACC,WAAW,CAACvB,KAAK,CAAC;YACnDwB,OAAOnB,aAAamB,KAAK;YACzBC,UAAU;gBACR;oBACEC,MAAM;oBACNC,SAAS,CAAC;;;;;;;;;2EASuD,EAAE5B,OAAO;UAC1E,CAAC;gBACH;gBACA;oBACE2B,MAAM;oBACNC,SAAS;wBACP;4BACEC,MAAM;4BACNC,WAAW;gCAAEC,KAAKpB;4BAAkB;wBACtC;2BACI,cAAcT,YAAYA,SAAS8B,QAAQ,GAC3C;4BACE;gCACEH,MAAM;gCACNI,MAAM/B,SAAS8B,QAAQ;4BACzB;yBACD,GACD,EAAE;qBACP;gBACH;aACD;YACD,kDAAkD;YAClDE,uBAAuB;YACvBC,iBAAiBjD,kBAAkB+B,qBAAqB;QAC1D;QAEAmB,QAAQC,GAAG,CAAC;YAAEC,SAASvC;YAAI,GAAGd,kBAAkBqC,UAAUhB,aAAamB,KAAK,CAAC;QAAC;QAE9E,MAAMc,SAASjB,SAASkB,OAAO,CAAC,EAAE,EAAEC,SAASC;QAE7C,IAAI,CAACH,QAAQ;YACX,OAAOjD,SAASC,IAAI,CAAC;gBAAEC,OAAO;YAAwB,GAAG;gBAAEC,QAAQ;YAAI;QACzE;QAEA,OAAOH,SAASC,IAAI,CAACgD;IACvB,EAAE,OAAO/C,OAAO;QACd4C,QAAQ5C,KAAK,CAAC,8BAA8BA;QAC5C,OAAOF,SAASC,IAAI,CAClB;YACEC,OAAO,CAAC,2BAA2B,EAAEA,iBAAiBmD,QAAQnD,MAAMiD,OAAO,GAAG,iBAAiB;QACjG,GACA;YAAEhD,QAAQ;QAAI;IAElB;AACF,EAAC"}
+{"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"}

package/dist/fields/altTextField.js

@@ -1,19 +1,21 @@
+import { translatedLabel } from '../utils/translatedLabel.js';
 export function altTextField({ localized }) {
     return {
         name: 'alt',
-        label: 'Alternate text',
+        label: translatedLabel('alternateText'),
         type: 'textarea',
         required: true,
         localized: localized,
-        validate: (value, ctx)=>{
-            // if the document has an id, the alt text is required
-            if (ctx.id) {
+        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) {
-                    return 'The alternate text is required.';
+                    // @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 document is created because the alt text generation
-            // can only be used once the document is created and the image uploaded
+            // 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: {

package/dist/fields/altTextField.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fields/altTextField.ts"],"sourcesContent":["import type { TextareaField } from 'payload'\n\nexport function altTextField({\n  localized,\n}: {\n  localized?: TextareaField['localized']\n}): TextareaField {\n  return {\n    name: 'alt',\n    label: 'Alternate text',\n    type: 'textarea',\n    required: true,\n    localized: localized,\n    validate: (value, ctx) => {\n      // if the document has an id, the alt text is required\n      if (ctx.id) {\n        if (!value || value.trim().length === 0) {\n          return 'The alternate text is required.'\n        }\n      }\n\n      // The alt text is not required when the document is created because the alt text generation\n      // can only be used once the document is created and the image uploaded\n      return true\n    },\n    admin: {\n      components: {\n        Field: '@jhb.software/payload-alt-text-plugin/client#AltTextField',\n      },\n    },\n  }\n}\n"],"names":["altTextField","localized","name","label","type","required","validate","value","ctx","id","trim","length","admin","components","Field"],"mappings":"AAEA,OAAO,SAASA,aAAa,EAC3BC,SAAS,EAGV;IACC,OAAO;QACLC,MAAM;QACNC,OAAO;QACPC,MAAM;QACNC,UAAU;QACVJ,WAAWA;QACXK,UAAU,CAACC,OAAOC;YAChB,sDAAsD;YACtD,IAAIA,IAAIC,EAAE,EAAE;gBACV,IAAI,CAACF,SAASA,MAAMG,IAAI,GAAGC,MAAM,KAAK,GAAG;oBACvC,OAAO;gBACT;YACF;YAEA,4FAA4F;YAC5F,uEAAuE;YACvE,OAAO;QACT;QACAC,OAAO;YACLC,YAAY;gBACVC,OAAO;YACT;QACF;IACF;AACF"}
+{"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"}

package/dist/fields/keywordsField.js

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

package/dist/fields/keywordsField.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fields/keywordsField.ts"],"sourcesContent":["import type { TextField } from 'payload'\n\nexport function keywordsField({ localized }: { localized?: TextField['localized'] }): TextField {\n  return {\n    name: 'keywords',\n    label: 'Keywords',\n    type: 'text',\n    hasMany: true,\n    required: false,\n    localized: localized,\n    hidden: true, // this field is only meant to be used for improving the search\n    admin: {\n      description: 'Keywords which describe the image. Used when searching for the image.',\n      readOnly: true,\n    },\n  }\n}\n"],"names":["keywordsField","localized","name","label","type","hasMany","required","hidden","admin","description","readOnly"],"mappings":"AAEA,OAAO,SAASA,cAAc,EAAEC,SAAS,EAA0C;IACjF,OAAO;QACLC,MAAM;QACNC,OAAO;QACPC,MAAM;QACNC,SAAS;QACTC,UAAU;QACVL,WAAWA;QACXM,QAAQ;QACRC,OAAO;YACLC,aAAa;YACbC,UAAU;QACZ;IACF;AACF"}
+{"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"}

package/dist/plugin.js

@@ -2,6 +2,8 @@ import { altTextField } from './fields/altTextField.js';
 import { keywordsField } from './fields/keywordsField.js';
 import { generateAltTextEndpoint } from './endpoints/generateAltText.js';
 import { bulkGenerateAltTextsEndpoint } from './endpoints/bulkGenerateAltTexts.js';
+import { translations } from './translations/index.js';
+import { deepMergeSimple } from './utils/deepMergeSimple.js';
 export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
         const config = {
             ...incomingConfig
@@ -11,9 +13,6 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
             return config;
         }
         const locales = config.localization ? config.localization.locales.map((localeConfig)=>typeof localeConfig === 'string' ? localeConfig : localeConfig.code) : [];
-        if (locales.length === 0) {
-            throw new Error('The alt text plugin currently only supports localized setups. If you need to use this plugin in a non-localized setup, please open an issue at https://github.com/jhb-software/payload-plugins.');
-        }
         const pluginConfig = {
             enabled: incomingPluginConfig.enabled ?? true,
             openAIApiKey: incomingPluginConfig.openAIApiKey,
@@ -21,9 +20,14 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
             maxBulkGenerateConcurrency: incomingPluginConfig.maxBulkGenerateConcurrency ?? 16,
             model: incomingPluginConfig.model ?? 'gpt-4.1-nano',
             locales: locales,
+            locale: incomingPluginConfig.locale,
             getImageThumbnail: incomingPluginConfig.getImageThumbnail,
             fieldsOverride: incomingPluginConfig.fieldsOverride
         };
+        // Validate locale requirement for non-localized mode
+        if (locales.length === 0 && !incomingPluginConfig.locale) {
+            throw new Error('The alt-text plugin requires a "locale" option when Payload localization is disabled. ' + 'Please add { locale: "en" } (or your preferred locale) to your plugin configuration.');
+        }
         const defaultFields = [
             altTextField({
                 localized: Boolean(config.localization)
@@ -48,11 +52,27 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
                     ...collectionConfig,
                     admin: {
                         ...collectionConfig.admin,
+                        listSearchableFields: [
+                            // enhance the search by adding the keywords and alt fields (if not already included)
+                            ...collectionConfig.admin?.listSearchableFields ?? [],
+                            ...collectionConfig.admin?.listSearchableFields?.includes('keywords') ? [] : [
+                                'keywords'
+                            ],
+                            ...collectionConfig.admin?.listSearchableFields?.includes('alt') ? [] : [
+                                'alt'
+                            ]
+                        ],
                         components: {
                             ...collectionConfig.admin?.components ?? {},
+                            // TODO: use the beforeBulkAction custom component slot once available: https://github.com/payloadcms/payload/pull/11719
                             beforeListTable: [
                                 ...collectionConfig.admin?.components?.beforeListTable ?? [],
-                                '@jhb.software/payload-alt-text-plugin/client#BulkGenerateAltTextsButton'
+                                {
+                                    path: '@jhb.software/payload-alt-text-plugin/client#BulkGenerateAltTextsButton',
+                                    props: {
+                                        collectionSlug: collectionConfig.slug
+                                    }
+                                }
                             ]
                         }
                     },
@@ -66,6 +86,10 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
         });
         return {
             ...config,
+            i18n: {
+                ...config.i18n,
+                translations: deepMergeSimple(translations, incomingConfig.i18n?.translations ?? {})
+            },
             custom: {
                 ...config.custom,
                 // Make plugin config available in hooks/actions

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config } from 'payload'\n\nimport type {\n  AltTextPluginConfig,\n  IncomingAltTextPluginConfig,\n} from './types/AltTextPluginConfig.js'\nimport { altTextField } from './fields/altTextField.js'\nimport { keywordsField } from './fields/keywordsField.js'\nimport { generateAltTextEndpoint } from './endpoints/generateAltText.js'\nimport { bulkGenerateAltTextsEndpoint } from './endpoints/bulkGenerateAltTexts.js'\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    if (locales.length === 0) {\n      throw new Error(\n        'The alt text plugin currently only supports localized setups. If you need to use this plugin in a non-localized setup, please open an issue at https://github.com/jhb-software/payload-plugins.',\n      )\n    }\n\n    const pluginConfig: AltTextPluginConfig = {\n      enabled: incomingPluginConfig.enabled ?? true,\n      openAIApiKey: incomingPluginConfig.openAIApiKey,\n      collections: incomingPluginConfig.collections,\n      maxBulkGenerateConcurrency: incomingPluginConfig.maxBulkGenerateConcurrency ?? 16,\n      model: incomingPluginConfig.model ?? 'gpt-4.1-nano',\n      locales: locales,\n      getImageThumbnail: incomingPluginConfig.getImageThumbnail,\n      fieldsOverride: incomingPluginConfig.fieldsOverride,\n    }\n\n    const defaultFields = [\n      altTextField({\n        localized: Boolean(config.localization),\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    // 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      if (pluginConfig.collections.includes(collectionConfig.slug)) {\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        return {\n          ...collectionConfig,\n          admin: {\n            ...collectionConfig.admin,\n            components: {\n              ...(collectionConfig.admin?.components ?? {}),\n              beforeListTable: [\n                ...(collectionConfig.admin?.components?.beforeListTable ?? []),\n                '@jhb.software/payload-alt-text-plugin/client#BulkGenerateAltTextsButton',\n              ],\n            },\n          },\n          fields: [...(collectionConfig.fields ?? []), ...fields],\n        }\n      }\n\n      return collectionConfig\n    })\n\n    return {\n      ...config,\n      custom: {\n        ...config.custom,\n        // Make plugin config available in hooks/actions\n        altTextPluginConfig: pluginConfig,\n      },\n      endpoints: [\n        ...(config.endpoints ?? []),\n        {\n          path: '/alt-text-plugin/generate-alt-text',\n          method: 'post',\n          handler: generateAltTextEndpoint,\n        },\n        {\n          path: '/alt-text-plugin/bulk-generate-alt-texts',\n          method: 'post',\n          handler: bulkGenerateAltTextsEndpoint,\n        },\n      ],\n    }\n  }\n"],"names":["altTextField","keywordsField","generateAltTextEndpoint","bulkGenerateAltTextsEndpoint","payloadAltTextPlugin","incomingPluginConfig","incomingConfig","config","enabled","locales","localization","map","localeConfig","code","length","Error","pluginConfig","openAIApiKey","collections","maxBulkGenerateConcurrency","model","getImageThumbnail","fieldsOverride","defaultFields","localized","Boolean","fields","collectionConfig","includes","slug","upload","console","warn","admin","components","beforeListTable","custom","altTextPluginConfig","endpoints","path","method","handler"],"mappings":"AAMA,SAASA,YAAY,QAAQ,2BAA0B;AACvD,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,uBAAuB,QAAQ,iCAAgC;AACxE,SAASC,4BAA4B,QAAQ,sCAAqC;AAElF,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,IAAIJ,QAAQK,MAAM,KAAK,GAAG;YACxB,MAAM,IAAIC,MACR;QAEJ;QAEA,MAAMC,eAAoC;YACxCR,SAASH,qBAAqBG,OAAO,IAAI;YACzCS,cAAcZ,qBAAqBY,YAAY;YAC/CC,aAAab,qBAAqBa,WAAW;YAC7CC,4BAA4Bd,qBAAqBc,0BAA0B,IAAI;YAC/EC,OAAOf,qBAAqBe,KAAK,IAAI;YACrCX,SAASA;YACTY,mBAAmBhB,qBAAqBgB,iBAAiB;YACzDC,gBAAgBjB,qBAAqBiB,cAAc;QACrD;QAEA,MAAMC,gBAAgB;YACpBvB,aAAa;gBACXwB,WAAWC,QAAQlB,OAAOG,YAAY;YACxC;YACAT,cAAc;gBACZuB,WAAWC,QAAQlB,OAAOG,YAAY;YACxC;SACD;QAED,MAAMgB,SACJrB,qBAAqBiB,cAAc,IACnC,OAAOjB,qBAAqBiB,cAAc,KAAK,aAC3CjB,qBAAqBiB,cAAc,CAAC;YAAEC;QAAc,KACpDA;QAEN,kCAAkC;QAClChB,OAAOW,WAAW,GAAGX,OAAOW,WAAW,IAAI,EAAE;QAE7C,yEAAyE;QACzEX,OAAOW,WAAW,GAAGX,OAAOW,WAAW,CAACP,GAAG,CAAC,CAACgB;YAC3C,IAAIX,aAAaE,WAAW,CAACU,QAAQ,CAACD,iBAAiBE,IAAI,GAAG;gBAC5D,IAAI,CAACF,iBAAiBG,MAAM,EAAE;oBAC5BC,QAAQC,IAAI,CACV,CAAC,gCAAgC,EAAEL,iBAAiBE,IAAI,CAAC,wDAAwD,CAAC;oBAEpH,OAAOF;gBACT;gBAEA,OAAO;oBACL,GAAGA,gBAAgB;oBACnBM,OAAO;wBACL,GAAGN,iBAAiBM,KAAK;wBACzBC,YAAY;4BACV,GAAIP,iBAAiBM,KAAK,EAAEC,cAAc,CAAC,CAAC;4BAC5CC,iBAAiB;mCACXR,iBAAiBM,KAAK,EAAEC,YAAYC,mBAAmB,EAAE;gCAC7D;6BACD;wBACH;oBACF;oBACAT,QAAQ;2BAAKC,iBAAiBD,MAAM,IAAI,EAAE;2BAAMA;qBAAO;gBACzD;YACF;YAEA,OAAOC;QACT;QAEA,OAAO;YACL,GAAGpB,MAAM;YACT6B,QAAQ;gBACN,GAAG7B,OAAO6B,MAAM;gBAChB,gDAAgD;gBAChDC,qBAAqBrB;YACvB;YACAsB,WAAW;mBACL/B,OAAO+B,SAAS,IAAI,EAAE;gBAC1B;oBACEC,MAAM;oBACNC,QAAQ;oBACRC,SAASvC;gBACX;gBACA;oBACEqC,MAAM;oBACNC,QAAQ;oBACRC,SAAStC;gBACX;aACD;QACH;IACF,EAAC"}
+{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config } from 'payload'\n\nimport type {\n  AltTextPluginConfig,\n  IncomingAltTextPluginConfig,\n} from './types/AltTextPluginConfig.js'\nimport { altTextField } from './fields/altTextField.js'\nimport { keywordsField } from './fields/keywordsField.js'\nimport { generateAltTextEndpoint } from './endpoints/generateAltText.js'\nimport { bulkGenerateAltTextsEndpoint } from './endpoints/bulkGenerateAltTexts.js'\nimport { translations } from './translations/index.js'\nimport { deepMergeSimple } from './utils/deepMergeSimple.js'\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 pluginConfig: AltTextPluginConfig = {\n      enabled: incomingPluginConfig.enabled ?? true,\n      openAIApiKey: incomingPluginConfig.openAIApiKey,\n      collections: incomingPluginConfig.collections,\n      maxBulkGenerateConcurrency: incomingPluginConfig.maxBulkGenerateConcurrency ?? 16,\n      model: incomingPluginConfig.model ?? 'gpt-4.1-nano',\n      locales: locales,\n      locale: incomingPluginConfig.locale,\n      getImageThumbnail: incomingPluginConfig.getImageThumbnail,\n      fieldsOverride: incomingPluginConfig.fieldsOverride,\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 defaultFields = [\n      altTextField({\n        localized: Boolean(config.localization),\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    // 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      if (pluginConfig.collections.includes(collectionConfig.slug)) {\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        return {\n          ...collectionConfig,\n          admin: {\n            ...collectionConfig.admin,\n            listSearchableFields: [\n              // enhance the search by adding the keywords and alt fields (if not already included)\n              ...(collectionConfig.admin?.listSearchableFields ?? []),\n              ...(collectionConfig.admin?.listSearchableFields?.includes('keywords')\n                ? []\n                : ['keywords']),\n              ...(collectionConfig.admin?.listSearchableFields?.includes('alt') ? [] : ['alt']),\n            ],\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          },\n          fields: [...(collectionConfig.fields ?? []), ...fields],\n        }\n      }\n\n      return collectionConfig\n    })\n\n    return {\n      ...config,\n      i18n: {\n        ...config.i18n,\n        translations: deepMergeSimple(translations, incomingConfig.i18n?.translations ?? {}),\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          path: '/alt-text-plugin/generate-alt-text',\n          method: 'post',\n          handler: generateAltTextEndpoint,\n        },\n        {\n          path: '/alt-text-plugin/bulk-generate-alt-texts',\n          method: 'post',\n          handler: bulkGenerateAltTextsEndpoint,\n        },\n      ],\n    }\n  }\n"],"names":["altTextField","keywordsField","generateAltTextEndpoint","bulkGenerateAltTextsEndpoint","translations","deepMergeSimple","payloadAltTextPlugin","incomingPluginConfig","incomingConfig","config","enabled","locales","localization","map","localeConfig","code","pluginConfig","openAIApiKey","collections","maxBulkGenerateConcurrency","model","locale","getImageThumbnail","fieldsOverride","length","Error","defaultFields","localized","Boolean","fields","collectionConfig","includes","slug","upload","console","warn","admin","listSearchableFields","components","beforeListTable","path","props","collectionSlug","i18n","custom","altTextPluginConfig","endpoints","method","handler"],"mappings":"AAMA,SAASA,YAAY,QAAQ,2BAA0B;AACvD,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SAASC,uBAAuB,QAAQ,iCAAgC;AACxE,SAASC,4BAA4B,QAAQ,sCAAqC;AAClF,SAASC,YAAY,QAAQ,0BAAyB;AACtD,SAASC,eAAe,QAAQ,6BAA4B;AAE5D,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,eAAoC;YACxCN,SAASH,qBAAqBG,OAAO,IAAI;YACzCO,cAAcV,qBAAqBU,YAAY;YAC/CC,aAAaX,qBAAqBW,WAAW;YAC7CC,4BAA4BZ,qBAAqBY,0BAA0B,IAAI;YAC/EC,OAAOb,qBAAqBa,KAAK,IAAI;YACrCT,SAASA;YACTU,QAAQd,qBAAqBc,MAAM;YACnCC,mBAAmBf,qBAAqBe,iBAAiB;YACzDC,gBAAgBhB,qBAAqBgB,cAAc;QACrD;QAEA,qDAAqD;QACrD,IAAIZ,QAAQa,MAAM,KAAK,KAAK,CAACjB,qBAAqBc,MAAM,EAAE;YACxD,MAAM,IAAII,MACR,2FACE;QAEN;QAEA,MAAMC,gBAAgB;YACpB1B,aAAa;gBACX2B,WAAWC,QAAQnB,OAAOG,YAAY;YACxC;YACAX,cAAc;gBACZ0B,WAAWC,QAAQnB,OAAOG,YAAY;YACxC;SACD;QAED,MAAMiB,SACJtB,qBAAqBgB,cAAc,IACnC,OAAOhB,qBAAqBgB,cAAc,KAAK,aAC3ChB,qBAAqBgB,cAAc,CAAC;YAAEG;QAAc,KACpDA;QAEN,kCAAkC;QAClCjB,OAAOS,WAAW,GAAGT,OAAOS,WAAW,IAAI,EAAE;QAE7C,yEAAyE;QACzET,OAAOS,WAAW,GAAGT,OAAOS,WAAW,CAACL,GAAG,CAAC,CAACiB;YAC3C,IAAId,aAAaE,WAAW,CAACa,QAAQ,CAACD,iBAAiBE,IAAI,GAAG;gBAC5D,IAAI,CAACF,iBAAiBG,MAAM,EAAE;oBAC5BC,QAAQC,IAAI,CACV,CAAC,gCAAgC,EAAEL,iBAAiBE,IAAI,CAAC,wDAAwD,CAAC;oBAEpH,OAAOF;gBACT;gBAEA,OAAO;oBACL,GAAGA,gBAAgB;oBACnBM,OAAO;wBACL,GAAGN,iBAAiBM,KAAK;wBACzBC,sBAAsB;4BACpB,qFAAqF;+BACjFP,iBAAiBM,KAAK,EAAEC,wBAAwB,EAAE;+BAClDP,iBAAiBM,KAAK,EAAEC,sBAAsBN,SAAS,cACvD,EAAE,GACF;gCAAC;6BAAW;+BACZD,iBAAiBM,KAAK,EAAEC,sBAAsBN,SAAS,SAAS,EAAE,GAAG;gCAAC;6BAAM;yBACjF;wBACDO,YAAY;4BACV,GAAIR,iBAAiBM,KAAK,EAAEE,cAAc,CAAC,CAAC;4BAC5C,wHAAwH;4BACxHC,iBAAiB;mCACXT,iBAAiBM,KAAK,EAAEE,YAAYC,mBAAmB,EAAE;gCAC7D;oCACEC,MAAM;oCACNC,OAAO;wCACLC,gBAAgBZ,iBAAiBE,IAAI;oCACvC;gCACF;6BACD;wBACH;oBACF;oBACAH,QAAQ;2BAAKC,iBAAiBD,MAAM,IAAI,EAAE;2BAAMA;qBAAO;gBACzD;YACF;YAEA,OAAOC;QACT;QAEA,OAAO;YACL,GAAGrB,MAAM;YACTkC,MAAM;gBACJ,GAAGlC,OAAOkC,IAAI;gBACdvC,cAAcC,gBAAgBD,cAAcI,eAAemC,IAAI,EAAEvC,gBAAgB,CAAC;YACpF;YACAwC,QAAQ;gBACN,GAAGnC,OAAOmC,MAAM;gBAChB,gDAAgD;gBAChDC,qBAAqB7B;YACvB;YACA8B,WAAW;mBACLrC,OAAOqC,SAAS,IAAI,EAAE;gBAC1B;oBACEN,MAAM;oBACNO,QAAQ;oBACRC,SAAS9C;gBACX;gBACA;oBACEsC,MAAM;oBACNO,QAAQ;oBACRC,SAAS7C;gBACX;aACD;QACH;IACF,EAAC"}

package/dist/translations/de.d.ts

@@ -0,0 +1,2 @@
+import { GenericTranslationsObject } from './index.js';
+export declare const de: GenericTranslationsObject;

package/dist/translations/de.js

@@ -0,0 +1,33 @@
+export const de = {
+    $schema: './translation-schema.json',
+    '@jhb.software/payload-alt-text-plugin': {
+        // Field labels
+        alternateText: 'Alternativtext',
+        keywords: 'Schlüsselwörter',
+        keywordsDescription: 'Schlüsselwörter, die das Bild beschreiben. Wird bei der Suche nach dem Bild verwendet.',
+        // Button labels
+        generateAltText: 'Alternativtext generieren',
+        generateAltTextFor: 'Alternativtext generieren für',
+        image: 'Bild',
+        images: 'Bilder',
+        // Toast messages
+        cannotGenerateMissingFields: 'Alternativtext kann nicht generiert werden. Erforderliche Felder fehlen.',
+        failedToGenerate: 'Generierung des Alternativtextes fehlgeschlagen. Bitte versuchen Sie es erneut.',
+        altTextGeneratedSuccess: 'Alternativtext erfolgreich generiert. Bitte überprüfen und speichern Sie das Dokument.',
+        noAltTextGenerated: 'Kein Alternativtext generiert. Bitte versuchen Sie es erneut.',
+        errorGeneratingAltText: 'Fehler beim Generieren des Alternativtextes. Bitte versuchen Sie es erneut.',
+        failedToGenerateForXImages: 'Generierung des Alternativtextes für {X} Bilder fehlgeschlagen.',
+        xOfYImagesUpdated: '{X} von {Y} Bildern aktualisiert.',
+        // Help text
+        altTextDescription: 'Alternativtext für das Bild. Dieser wird für Screenreader und SEO verwendet. Er sollte die folgenden Anforderungen erfüllen:',
+        altTextRequirement1: 'Beschreibt in 1-2 Sätzen, was auf dem Bild zu sehen ist.',
+        altTextRequirement2: 'Sollte möglichst die gleichen Informationen oder den gleichen Zweck wie das Bild vermitteln.',
+        altTextRequirement3: 'Phrasen wie "Bild von" oder "Foto von" sind überflüssig, da Screenreader bereits anzeigen, dass es sich um ein Bild handelt.',
+        // Tooltips
+        pleaseSaveDocumentFirst: 'Bitte speichern Sie zuerst das Dokument',
+        // Validation messages
+        theAlternateTextIsRequired: 'Der Alternativtext ist erforderlich.'
+    }
+};
+
+//# sourceMappingURL=de.js.map

package/dist/translations/de.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/translations/de.ts"],"sourcesContent":["import { GenericTranslationsObject } from './index.js'\n\nexport const de: GenericTranslationsObject = {\n  $schema: './translation-schema.json',\n  '@jhb.software/payload-alt-text-plugin': {\n    // Field labels\n    alternateText: 'Alternativtext',\n    keywords: 'Schlüsselwörter',\n    keywordsDescription:\n      'Schlüsselwörter, die das Bild beschreiben. Wird bei der Suche nach dem Bild verwendet.',\n\n    // Button labels\n    generateAltText: 'Alternativtext generieren',\n    generateAltTextFor: 'Alternativtext generieren für',\n    image: 'Bild',\n    images: 'Bilder',\n\n    // Toast messages\n    cannotGenerateMissingFields:\n      'Alternativtext kann nicht generiert werden. Erforderliche Felder fehlen.',\n    failedToGenerate:\n      'Generierung des Alternativtextes fehlgeschlagen. Bitte versuchen Sie es erneut.',\n    altTextGeneratedSuccess:\n      'Alternativtext erfolgreich generiert. Bitte überprüfen und speichern Sie das Dokument.',\n    noAltTextGenerated: 'Kein Alternativtext generiert. Bitte versuchen Sie es erneut.',\n    errorGeneratingAltText:\n      'Fehler beim Generieren des Alternativtextes. Bitte versuchen Sie es erneut.',\n    failedToGenerateForXImages: 'Generierung des Alternativtextes für {X} Bilder fehlgeschlagen.',\n    xOfYImagesUpdated: '{X} von {Y} Bildern aktualisiert.',\n\n    // Help text\n    altTextDescription:\n      'Alternativtext für das Bild. Dieser wird für Screenreader und SEO verwendet. Er sollte die folgenden Anforderungen erfüllen:',\n    altTextRequirement1: 'Beschreibt in 1-2 Sätzen, was auf dem Bild zu sehen ist.',\n    altTextRequirement2:\n      'Sollte möglichst die gleichen Informationen oder den gleichen Zweck wie das Bild vermitteln.',\n    altTextRequirement3:\n      'Phrasen wie \"Bild von\" oder \"Foto von\" sind überflüssig, da Screenreader bereits anzeigen, dass es sich um ein Bild handelt.',\n\n    // Tooltips\n    pleaseSaveDocumentFirst: 'Bitte speichern Sie zuerst das Dokument',\n\n    // Validation messages\n    theAlternateTextIsRequired: 'Der Alternativtext ist erforderlich.',\n  },\n}\n"],"names":["de","$schema","alternateText","keywords","keywordsDescription","generateAltText","generateAltTextFor","image","images","cannotGenerateMissingFields","failedToGenerate","altTextGeneratedSuccess","noAltTextGenerated","errorGeneratingAltText","failedToGenerateForXImages","xOfYImagesUpdated","altTextDescription","altTextRequirement1","altTextRequirement2","altTextRequirement3","pleaseSaveDocumentFirst","theAlternateTextIsRequired"],"mappings":"AAEA,OAAO,MAAMA,KAAgC;IAC3CC,SAAS;IACT,yCAAyC;QACvC,eAAe;QACfC,eAAe;QACfC,UAAU;QACVC,qBACE;QAEF,gBAAgB;QAChBC,iBAAiB;QACjBC,oBAAoB;QACpBC,OAAO;QACPC,QAAQ;QAER,iBAAiB;QACjBC,6BACE;QACFC,kBACE;QACFC,yBACE;QACFC,oBAAoB;QACpBC,wBACE;QACFC,4BAA4B;QAC5BC,mBAAmB;QAEnB,YAAY;QACZC,oBACE;QACFC,qBAAqB;QACrBC,qBACE;QACFC,qBACE;QAEF,WAAW;QACXC,yBAAyB;QAEzB,sBAAsB;QACtBC,4BAA4B;IAC9B;AACF,EAAC"}

package/dist/translations/en.d.ts

@@ -0,0 +1,2 @@
+import { GenericTranslationsObject } from './index.js';
+export declare const en: GenericTranslationsObject;

package/dist/translations/en.js

@@ -0,0 +1,33 @@
+export const en = {
+    $schema: './translation-schema.json',
+    '@jhb.software/payload-alt-text-plugin': {
+        // Field labels
+        alternateText: 'Alternate text',
+        keywords: 'Keywords',
+        keywordsDescription: 'Keywords which describe the image. Used when searching for the image.',
+        // Button labels
+        generateAltText: 'Generate alt text',
+        generateAltTextFor: 'Generate alt text for',
+        image: 'image',
+        images: 'images',
+        // Toast messages
+        cannotGenerateMissingFields: 'Cannot generate alt text. Missing required fields.',
+        failedToGenerate: 'Failed to generate alt text. Please try again.',
+        altTextGeneratedSuccess: 'Alt text generated successfully. Please review and save the document.',
+        noAltTextGenerated: 'No alt text generated. Please try again.',
+        errorGeneratingAltText: 'Error generating alt text. Please try again.',
+        failedToGenerateForXImages: 'Failed to generate alt text for {X} images.',
+        xOfYImagesUpdated: '{X} of {Y} images updated.',
+        // Help text
+        altTextDescription: 'Alternate text for the image. This will be used for screen readers and SEO. It should meet the following requirements:',
+        altTextRequirement1: 'Describes in 1-2 sentences, what is visible in the image.',
+        altTextRequirement2: 'Should convey the same information or purpose as the image, whenever possible.',
+        altTextRequirement3: 'Phrases like "image of" or "picture of" are unnecessary, since screen readers already announce that it\'s an image.',
+        // Tooltips
+        pleaseSaveDocumentFirst: 'Please save the document first',
+        // Validation messages
+        theAlternateTextIsRequired: 'An alternate text is required.'
+    }
+};
+
+//# sourceMappingURL=en.js.map

package/dist/translations/en.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/translations/en.ts"],"sourcesContent":["import { GenericTranslationsObject } from './index.js'\n\nexport const en: GenericTranslationsObject = {\n  $schema: './translation-schema.json',\n  '@jhb.software/payload-alt-text-plugin': {\n    // Field labels\n    alternateText: 'Alternate text',\n    keywords: 'Keywords',\n    keywordsDescription: 'Keywords which describe the image. Used when searching for the image.',\n\n    // Button labels\n    generateAltText: 'Generate alt text',\n    generateAltTextFor: 'Generate alt text for',\n    image: 'image',\n    images: 'images',\n\n    // Toast messages\n    cannotGenerateMissingFields: 'Cannot generate alt text. Missing required fields.',\n    failedToGenerate: 'Failed to generate alt text. Please try again.',\n    altTextGeneratedSuccess:\n      'Alt text generated successfully. Please review and save the document.',\n    noAltTextGenerated: 'No alt text generated. Please try again.',\n    errorGeneratingAltText: 'Error generating alt text. Please try again.',\n    failedToGenerateForXImages: 'Failed to generate alt text for {X} images.',\n    xOfYImagesUpdated: '{X} of {Y} images updated.',\n\n    // Help text\n    altTextDescription:\n      'Alternate text for the image. This will be used for screen readers and SEO. It should meet the following requirements:',\n    altTextRequirement1: 'Describes in 1-2 sentences, what is visible in the image.',\n    altTextRequirement2:\n      'Should convey the same information or purpose as the image, whenever possible.',\n    altTextRequirement3:\n      'Phrases like \"image of\" or \"picture of\" are unnecessary, since screen readers already announce that it\\'s an image.',\n\n    // Tooltips\n    pleaseSaveDocumentFirst: 'Please save the document first',\n\n    // Validation messages\n    theAlternateTextIsRequired: 'An alternate text is required.',\n  },\n}\n"],"names":["en","$schema","alternateText","keywords","keywordsDescription","generateAltText","generateAltTextFor","image","images","cannotGenerateMissingFields","failedToGenerate","altTextGeneratedSuccess","noAltTextGenerated","errorGeneratingAltText","failedToGenerateForXImages","xOfYImagesUpdated","altTextDescription","altTextRequirement1","altTextRequirement2","altTextRequirement3","pleaseSaveDocumentFirst","theAlternateTextIsRequired"],"mappings":"AAEA,OAAO,MAAMA,KAAgC;IAC3CC,SAAS;IACT,yCAAyC;QACvC,eAAe;QACfC,eAAe;QACfC,UAAU;QACVC,qBAAqB;QAErB,gBAAgB;QAChBC,iBAAiB;QACjBC,oBAAoB;QACpBC,OAAO;QACPC,QAAQ;QAER,iBAAiB;QACjBC,6BAA6B;QAC7BC,kBAAkB;QAClBC,yBACE;QACFC,oBAAoB;QACpBC,wBAAwB;QACxBC,4BAA4B;QAC5BC,mBAAmB;QAEnB,YAAY;QACZC,oBACE;QACFC,qBAAqB;QACrBC,qBACE;QACFC,qBACE;QAEF,WAAW;QACXC,yBAAyB;QAEzB,sBAAsB;QACtBC,4BAA4B;IAC9B;AACF,EAAC"}

package/dist/translations/index.d.ts

@@ -0,0 +1,13 @@
+export type GenericTranslationsObject = {
+    [key: string]: GenericTranslationsObject | string;
+};
+export type NestedKeysStripped<T> = T extends object ? {
+    [K in keyof T]-?: K extends string ? T[K] extends object ? `${K}:${NestedKeysStripped<T[K]>}` : `${StripCountVariants<K>}` : never;
+}[keyof T] : '';
+export type StripCountVariants<TKey> = TKey extends `${infer Base}_many` | `${infer Base}_one` | `${infer Base}_other` ? Base : TKey;
+export declare const translations: {
+    de: GenericTranslationsObject;
+    en: GenericTranslationsObject;
+};
+export type PluginAltTextTranslations = GenericTranslationsObject;
+export type PluginAltTextTranslationKeys = NestedKeysStripped<PluginAltTextTranslations>;

package/dist/translations/index.js

@@ -0,0 +1,8 @@
+import { de } from './de.js';
+import { en } from './en.js';
+export const translations = {
+    de,
+    en
+};
+
+//# sourceMappingURL=index.js.map

package/dist/translations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/translations/index.ts"],"sourcesContent":["import { de } from './de.js'\nimport { en } from './en.js'\n\n// copied from https://github.com/payloadcms/payload/blob/main/packages/translations/src/types.ts\nexport type GenericTranslationsObject = {\n  [key: string]: GenericTranslationsObject | string\n}\n\n// copied from https://github.com/payloadcms/payload/blob/main/packages/translations/src/types.ts\nexport type NestedKeysStripped<T> = T extends object\n  ? {\n      [K in keyof T]-?: K extends string\n        ? T[K] extends object\n          ? `${K}:${NestedKeysStripped<T[K]>}`\n          : `${StripCountVariants<K>}`\n        : never\n    }[keyof T]\n  : ''\n\n// copied from https://github.com/payloadcms/payload/blob/main/packages/translations/src/types.ts\nexport type StripCountVariants<TKey> = TKey extends\n  | `${infer Base}_many`\n  | `${infer Base}_one`\n  | `${infer Base}_other`\n  ? Base\n  : TKey\n\nexport const translations = {\n  de,\n  en,\n}\n\nexport type PluginAltTextTranslations = GenericTranslationsObject\n\nexport type PluginAltTextTranslationKeys = NestedKeysStripped<PluginAltTextTranslations>\n"],"names":["de","en","translations"],"mappings":"AAAA,SAASA,EAAE,QAAQ,UAAS;AAC5B,SAASC,EAAE,QAAQ,UAAS;AA0B5B,OAAO,MAAMC,eAAe;IAC1BF;IACAC;AACF,EAAC"}

package/dist/translations/translation-schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "@jhb.software/payload-alt-text-plugin": {
+      "type": "object",
+      "properties": {
+        "alternateText": { "type": "string" },
+        "keywords": { "type": "string" },
+        "keywordsDescription": { "type": "string" },
+        "generateAltText": { "type": "string" },
+        "generateAltTextFor": { "type": "string" },
+        "image": { "type": "string" },
+        "images": { "type": "string" },
+        "cannotGenerateMissingFields": { "type": "string" },
+        "failedToGenerate": { "type": "string" },
+        "altTextGeneratedSuccess": { "type": "string" },
+        "noAltTextGenerated": { "type": "string" },
+        "errorGeneratingAltText": { "type": "string" },
+        "failedToGenerateForXImages": { "type": "string" },
+        "xOfYImagesUpdated": { "type": "string" },
+        "altTextDescription": { "type": "string" },
+        "altTextRequirement1": { "type": "string" },
+        "altTextRequirement2": { "type": "string" },
+        "altTextRequirement3": { "type": "string" },
+        "pleaseSaveDocumentFirst": { "type": "string" },
+        "theAlternateTextIsRequired": { "type": "string" }
+      },
+      "required": [
+        "alternateText",
+        "keywords",
+        "keywordsDescription",
+        "generateAltText",
+        "generateAltTextFor",
+        "image",
+        "images",
+        "cannotGenerateMissingFields",
+        "failedToGenerate",
+        "altTextGeneratedSuccess",
+        "noAltTextGenerated",
+        "errorGeneratingAltText",
+        "failedToGenerateForXImages",
+        "xOfYImagesUpdated",
+        "altTextDescription",
+        "altTextRequirement1",
+        "altTextRequirement2",
+        "altTextRequirement3",
+        "pleaseSaveDocumentFirst",
+        "theAlternateTextIsRequired"
+      ]
+    }
+  },
+  "required": ["@jhb.software/payload-alt-text-plugin"]
+}

package/dist/types/AltTextPluginConfig.d.ts

@@ -1,4 +1,4 @@
-import { Field } from 'payload';
+import { CollectionSlug, Field } from 'payload';
 /** Configuration options for the alt text plugin. */
 export type IncomingAltTextPluginConfig = {
     /** Whether the plugin is enabled. */
@@ -6,7 +6,7 @@ export type IncomingAltTextPluginConfig = {
     /** OpenAI API key for authentication. */
     openAIApiKey: string;
     /** Collection slugs to enable the plugin for. */
-    collections: string[];
+    collections: CollectionSlug[];
     /** Maximum number of concurrent API requests for bulk operations. */
     maxBulkGenerateConcurrency?: number;
     /**
@@ -24,6 +24,12 @@ export type IncomingAltTextPluginConfig = {
     fieldsOverride?: (args: {
         defaultFields: Field[];
     }) => Field[];
+    /**
+     * The locale to generate alt texts in when localization is disabled.
+     * Required when localization is disabled, ignored when localization is enabled.
+     * @example 'en', 'de'
+     */
+    locale?: string;
 };
 /** Configuration of the alt text plugin after defaults have been applied. */
 export type AltTextPluginConfig = {
@@ -32,7 +38,7 @@ export type AltTextPluginConfig = {
     /** OpenAI API key for authentication. */
     openAIApiKey: string;
     /** Collection slugs to enable the plugin for. */
-    collections: string[];
+    collections: CollectionSlug[];
     /** Maximum number of concurrent API requests for bulk generate operations. */
     maxBulkGenerateConcurrency: number;
     /** Function to get the thumbnail URL of an image document. */
@@ -45,4 +51,6 @@ export type AltTextPluginConfig = {
     }) => Field[];
     /** The locales to generate alt texts for. */
     locales: string[];
+    /** The locale to generate alt texts in when localization is disabled. */
+    locale?: string;
 };

package/dist/types/AltTextPluginConfig.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/AltTextPluginConfig.ts"],"sourcesContent":["import { 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: string[]\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/** 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: string[]\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"],"names":[],"mappings":"AAiCA,2EAA2E,GAC3E,WAwBC"}
+{"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"}

package/dist/utilities/localesFromConfig.d.ts

@@ -0,0 +1,3 @@
+import { 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

@@ -0,0 +1,9 @@
+/** Returns the locales from the config. Returns undefined when localization is disabled. */ export function localesFromConfig(config) {
+    if (typeof config.localization === 'object' && config.localization) {
+        return config.localization.localeCodes;
+    } else {
+        return undefined;
+    }
+}
+
+//# sourceMappingURL=localesFromConfig.js.map

package/dist/utilities/localesFromConfig.js.map

@@ -0,0 +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"}

package/dist/utils/deepMergeSimple.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Very simple, but fast deepMerge implementation. Only deepMerges objects, not arrays and clones everything.
+ * Do not use this if your object contains any complex objects like React Components, or if you would like to combine Arrays.
+ * If you only have simple objects and need a fast deepMerge, this is the function for you.
+ *
+ * obj2 takes precedence over obj1 - thus if obj2 has a key that obj1 also has, obj2's value will be used.
+ *
+ * @param obj1 base object
+ * @param obj2 object to merge "into" obj1
+ */
+export declare function deepMergeSimple<T = object>(obj1: object, obj2: object): T;

package/dist/utils/deepMergeSimple.js

@@ -0,0 +1,30 @@
+// copied from https://github.com/payloadcms/payload/blob/main/packages/translations/src/utilities/deepMergeSimple.ts
+/**
+ * Very simple, but fast deepMerge implementation. Only deepMerges objects, not arrays and clones everything.
+ * Do not use this if your object contains any complex objects like React Components, or if you would like to combine Arrays.
+ * If you only have simple objects and need a fast deepMerge, this is the function for you.
+ *
+ * obj2 takes precedence over obj1 - thus if obj2 has a key that obj1 also has, obj2's value will be used.
+ *
+ * @param obj1 base object
+ * @param obj2 object to merge "into" obj1
+ */ export function deepMergeSimple(obj1, obj2) {
+    const output = {
+        ...obj1
+    };
+    for(const key in obj2){
+        if (Object.prototype.hasOwnProperty.call(obj2, key)) {
+            // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
+            if (typeof obj2[key] === 'object' && !Array.isArray(obj2[key]) && obj1[key]) {
+                // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
+                output[key] = deepMergeSimple(obj1[key], obj2[key]);
+            } else {
+                // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
+                output[key] = obj2[key];
+            }
+        }
+    }
+    return output;
+}
+
+//# sourceMappingURL=deepMergeSimple.js.map

package/dist/utils/deepMergeSimple.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/deepMergeSimple.ts"],"sourcesContent":["// copied from https://github.com/payloadcms/payload/blob/main/packages/translations/src/utilities/deepMergeSimple.ts\n\n/**\n * Very simple, but fast deepMerge implementation. Only deepMerges objects, not arrays and clones everything.\n * Do not use this if your object contains any complex objects like React Components, or if you would like to combine Arrays.\n * If you only have simple objects and need a fast deepMerge, this is the function for you.\n *\n * obj2 takes precedence over obj1 - thus if obj2 has a key that obj1 also has, obj2's value will be used.\n *\n * @param obj1 base object\n * @param obj2 object to merge \"into\" obj1\n */\nexport function deepMergeSimple<T = object>(obj1: object, obj2: object): T {\n  const output = { ...obj1 }\n\n  for (const key in obj2) {\n    if (Object.prototype.hasOwnProperty.call(obj2, key)) {\n      // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve\n      if (typeof obj2[key] === 'object' && !Array.isArray(obj2[key]) && obj1[key]) {\n        // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve\n        output[key] = deepMergeSimple(obj1[key], obj2[key])\n      } else {\n        // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve\n        output[key] = obj2[key]\n      }\n    }\n  }\n\n  return output as T\n}\n"],"names":["deepMergeSimple","obj1","obj2","output","key","Object","prototype","hasOwnProperty","call","Array","isArray"],"mappings":"AAAA,qHAAqH;AAErH;;;;;;;;;CASC,GACD,OAAO,SAASA,gBAA4BC,IAAY,EAAEC,IAAY;IACpE,MAAMC,SAAS;QAAE,GAAGF,IAAI;IAAC;IAEzB,IAAK,MAAMG,OAAOF,KAAM;QACtB,IAAIG,OAAOC,SAAS,CAACC,cAAc,CAACC,IAAI,CAACN,MAAME,MAAM;YACnD,oFAAoF;YACpF,IAAI,OAAOF,IAAI,CAACE,IAAI,KAAK,YAAY,CAACK,MAAMC,OAAO,CAACR,IAAI,CAACE,IAAI,KAAKH,IAAI,CAACG,IAAI,EAAE;gBAC3E,oFAAoF;gBACpFD,MAAM,CAACC,IAAI,GAAGJ,gBAAgBC,IAAI,CAACG,IAAI,EAAEF,IAAI,CAACE,IAAI;YACpD,OAAO;gBACL,oFAAoF;gBACpFD,MAAM,CAACC,IAAI,GAAGF,IAAI,CAACE,IAAI;YACzB;QACF;IACF;IAEA,OAAOD;AACT"}

package/dist/utils/translatedLabel.d.ts

@@ -0,0 +1,3 @@
+import { 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

@@ -0,0 +1,9 @@
+import { translations } from '../translations/index.js';
+/** Returns the StaticLabel object for the given translation to to use inside the field label. */ export function translatedLabel(key) {
+    return Object.fromEntries(Object.entries(translations).map(([locale, translation])=>[
+            locale,
+            translation['@jhb.software/payload-alt-text-plugin'][key] || key
+        ]));
+}
+
+//# sourceMappingURL=translatedLabel.js.map

package/dist/utils/translatedLabel.js.map

@@ -0,0 +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"}

package/dist/utils/usePluginTranslation.d.ts

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1 @@
+{"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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jhb.software/payload-alt-text-plugin",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "A minimal Payload CMS plugin to generate image alt texts using OpenAI's Vision API.",
   "bugs": "https://github.com/jhb-software/payload-plugins/issues",
   "repository": "https://github.com/jhb-software/payload-plugins",