@jhb.software/payload-alt-text-plugin 0.3.0 → 0.4.0

package/dist/plugin.js

@@ -1,9 +1,51 @@
+import { altTextHealthEndpoint } from './endpoints/altTextHealth.js';
 import { bulkGenerateAltTextsEndpoint } from './endpoints/bulkGenerateAltTexts.js';
 import { generateAltTextEndpoint } from './endpoints/generateAltText.js';
 import { altTextField } from './fields/altTextField.js';
 import { keywordsField } from './fields/keywordsField.js';
+import { createRevalidateAltTextHealthAfterChangeHook, createRevalidateAltTextHealthAfterDeleteHook } from './hooks/revalidateAltTextHealth.js';
 import { translations } from './translations/index.js';
 import { deepMergeSimple } from './utils/deepMergeSimple.js';
+const altTextHealthWidgetDefinition = {
+    slug: 'alt-text-health',
+    Component: '@jhb.software/payload-alt-text-plugin/server#AltTextHealthWidget',
+    label: {
+        de: 'Alternativtexte Zustand',
+        en: 'Alt text health'
+    },
+    maxWidth: 'full',
+    minWidth: 'medium'
+};
+const defaultAltTextHealthWidgetLayout = {
+    widgetSlug: 'alt-text-health',
+    width: 'full'
+};
+function appendAltTextHealthWidgetToLayout(layout) {
+    if (layout.some((widget)=>widget.widgetSlug === 'alt-text-health')) {
+        return layout;
+    }
+    return [
+        ...layout,
+        defaultAltTextHealthWidgetLayout
+    ];
+}
+function getDashboardDefaultLayout(defaultLayout) {
+    if (!defaultLayout) {
+        return [
+            {
+                widgetSlug: 'collections',
+                width: 'full'
+            },
+            defaultAltTextHealthWidgetLayout
+        ];
+    }
+    if (Array.isArray(defaultLayout)) {
+        return appendAltTextHealthWidgetToLayout(defaultLayout);
+    }
+    return async ({ req })=>appendAltTextHealthWidgetToLayout(await defaultLayout({
+            req
+        }));
+}
 export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
         const config = {
             ...incomingConfig
@@ -13,11 +55,14 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
             return config;
         }
         const locales = config.localization ? config.localization.locales.map((localeConfig)=>typeof localeConfig === 'string' ? localeConfig : localeConfig.code) : [];
+        const enableHealthCheck = incomingPluginConfig.healthCheck !== false;
         const pluginConfig = {
+            access: incomingPluginConfig.access ?? (({ req })=>!!req.user),
             collections: incomingPluginConfig.collections,
             enabled: incomingPluginConfig.enabled ?? true,
             fieldsOverride: incomingPluginConfig.fieldsOverride,
             getImageThumbnail: incomingPluginConfig.getImageThumbnail,
+            healthCheck: enableHealthCheck,
             locale: incomingPluginConfig.locale,
             locales,
             maxBulkGenerateConcurrency: incomingPluginConfig.maxBulkGenerateConcurrency ?? 16,
@@ -74,13 +119,41 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
                     fields: [
                         ...collectionConfig.fields ?? [],
                         ...fields
-                    ]
+                    ],
+                    hooks: {
+                        ...collectionConfig.hooks,
+                        ...enableHealthCheck && {
+                            afterChange: [
+                                ...collectionConfig.hooks?.afterChange ?? [],
+                                createRevalidateAltTextHealthAfterChangeHook(collectionConfig.slug)
+                            ],
+                            afterDelete: [
+                                ...collectionConfig.hooks?.afterDelete ?? [],
+                                createRevalidateAltTextHealthAfterDeleteHook(collectionConfig.slug)
+                            ]
+                        }
+                    }
                 };
             }
             return collectionConfig;
         });
+        const existingWidgets = config.admin?.dashboard?.widgets ?? [];
+        const widgets = !enableHealthCheck || existingWidgets.some((widget)=>widget.slug === 'alt-text-health') ? existingWidgets : [
+            ...existingWidgets,
+            altTextHealthWidgetDefinition
+        ];
         return {
             ...config,
+            admin: {
+                ...config.admin,
+                dashboard: {
+                    ...config.admin?.dashboard,
+                    ...enableHealthCheck && {
+                        defaultLayout: getDashboardDefaultLayout(config.admin?.dashboard?.defaultLayout)
+                    },
+                    widgets
+                }
+            },
             custom: {
                 ...config.custom,
                 // Make plugin config available in hooks/actions
@@ -89,15 +162,22 @@ export const payloadAltTextPlugin = (incomingPluginConfig)=>(incomingConfig)=>{
             endpoints: [
                 ...config.endpoints ?? [],
                 {
-                    handler: generateAltTextEndpoint,
+                    handler: generateAltTextEndpoint(pluginConfig.access),
                     method: 'post',
-                    path: '/alt-text-plugin/generate-alt-text'
+                    path: '/alt-text-plugin/generate'
                 },
                 {
-                    handler: bulkGenerateAltTextsEndpoint,
+                    handler: bulkGenerateAltTextsEndpoint(pluginConfig.access),
                     method: 'post',
-                    path: '/alt-text-plugin/bulk-generate-alt-texts'
-                }
+                    path: '/alt-text-plugin/generate/bulk'
+                },
+                ...enableHealthCheck ? [
+                    {
+                        handler: altTextHealthEndpoint(pluginConfig.access),
+                        method: 'get',
+                        path: '/alt-text-plugin/health'
+                    }
+                ] : []
             ],
             i18n: {
                 ...config.i18n,

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'\n\nimport { bulkGenerateAltTextsEndpoint } from './endpoints/bulkGenerateAltTexts.js'\nimport { generateAltTextEndpoint } from './endpoints/generateAltText.js'\nimport { altTextField } from './fields/altTextField.js'\nimport { keywordsField } from './fields/keywordsField.js'\nimport { 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      collections: incomingPluginConfig.collections,\n      enabled: incomingPluginConfig.enabled ?? true,\n      fieldsOverride: incomingPluginConfig.fieldsOverride,\n      getImageThumbnail: incomingPluginConfig.getImageThumbnail,\n      locale: incomingPluginConfig.locale,\n      locales,\n      maxBulkGenerateConcurrency: incomingPluginConfig.maxBulkGenerateConcurrency ?? 16,\n      resolver: incomingPluginConfig.resolver,\n    }\n\n    // Validate locale requirement for non-localized mode\n    if (locales.length === 0 && !incomingPluginConfig.locale) {\n      throw new Error(\n        'The alt-text plugin requires a \"locale\" option when Payload localization is disabled. ' +\n          'Please add { locale: \"en\" } (or your preferred locale) to your plugin configuration.',\n      )\n    }\n\n    const 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              // TODO: use the beforeBulkAction custom component slot once available: https://github.com/payloadcms/payload/pull/11719\n              beforeListTable: [\n                ...(collectionConfig.admin?.components?.beforeListTable ?? []),\n                {\n                  path: '@jhb.software/payload-alt-text-plugin/client#BulkGenerateAltTextsButton',\n                  props: {\n                    collectionSlug: collectionConfig.slug,\n                  },\n                },\n              ],\n            },\n            // enhance the search by adding the filename, keywords and alt fields (if the user has not provided their own listSearchableFields)\n            listSearchableFields: collectionConfig.admin?.listSearchableFields ?? [\n              'filename',\n              'keywords',\n              'alt',\n            ],\n          },\n          fields: [...(collectionConfig.fields ?? []), ...fields],\n        }\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          handler: generateAltTextEndpoint,\n          method: 'post',\n          path: '/alt-text-plugin/generate-alt-text',\n        },\n        {\n          handler: bulkGenerateAltTextsEndpoint,\n          method: 'post',\n          path: '/alt-text-plugin/bulk-generate-alt-texts',\n        },\n      ],\n      i18n: {\n        ...config.i18n,\n        translations: deepMergeSimple(translations, incomingConfig.i18n?.translations ?? {}),\n      },\n    }\n  }\n"],"names":["bulkGenerateAltTextsEndpoint","generateAltTextEndpoint","altTextField","keywordsField","translations","deepMergeSimple","payloadAltTextPlugin","incomingPluginConfig","incomingConfig","config","enabled","locales","localization","map","localeConfig","code","pluginConfig","collections","fieldsOverride","getImageThumbnail","locale","maxBulkGenerateConcurrency","resolver","length","Error","defaultFields","localized","Boolean","fields","collectionConfig","includes","slug","upload","console","warn","admin","components","beforeListTable","path","props","collectionSlug","listSearchableFields","custom","altTextPluginConfig","endpoints","handler","method","i18n"],"mappings":"AAOA,SAASA,4BAA4B,QAAQ,sCAAqC;AAClF,SAASC,uBAAuB,QAAQ,iCAAgC;AACxE,SAASC,YAAY,QAAQ,2BAA0B;AACvD,SAASC,aAAa,QAAQ,4BAA2B;AACzD,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;YACxCC,aAAaV,qBAAqBU,WAAW;YAC7CP,SAASH,qBAAqBG,OAAO,IAAI;YACzCQ,gBAAgBX,qBAAqBW,cAAc;YACnDC,mBAAmBZ,qBAAqBY,iBAAiB;YACzDC,QAAQb,qBAAqBa,MAAM;YACnCT;YACAU,4BAA4Bd,qBAAqBc,0BAA0B,IAAI;YAC/EC,UAAUf,qBAAqBe,QAAQ;QACzC;QAEA,qDAAqD;QACrD,IAAIX,QAAQY,MAAM,KAAK,KAAK,CAAChB,qBAAqBa,MAAM,EAAE;YACxD,MAAM,IAAII,MACR,2FACE;QAEN;QAEA,MAAMC,gBAAgB;YACpBvB,aAAa;gBACXwB,WAAWC,QAAQlB,OAAOG,YAAY;YACxC;YACAT,cAAc;gBACZuB,WAAWC,QAAQlB,OAAOG,YAAY;YACxC;SACD;QAED,MAAMgB,SACJrB,qBAAqBW,cAAc,IACnC,OAAOX,qBAAqBW,cAAc,KAAK,aAC3CX,qBAAqBW,cAAc,CAAC;YAAEO;QAAc,KACpDA;QAEN,kCAAkC;QAClChB,OAAOQ,WAAW,GAAGR,OAAOQ,WAAW,IAAI,EAAE;QAE7C,yEAAyE;QACzER,OAAOQ,WAAW,GAAGR,OAAOQ,WAAW,CAACJ,GAAG,CAAC,CAACgB;YAC3C,IAAIb,aAAaC,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,YAAY;4BACV,GAAIP,iBAAiBM,KAAK,EAAEC,cAAc,CAAC,CAAC;4BAC5C,wHAAwH;4BACxHC,iBAAiB;mCACXR,iBAAiBM,KAAK,EAAEC,YAAYC,mBAAmB,EAAE;gCAC7D;oCACEC,MAAM;oCACNC,OAAO;wCACLC,gBAAgBX,iBAAiBE,IAAI;oCACvC;gCACF;6BACD;wBACH;wBACA,mIAAmI;wBACnIU,sBAAsBZ,iBAAiBM,KAAK,EAAEM,wBAAwB;4BACpE;4BACA;4BACA;yBACD;oBACH;oBACAb,QAAQ;2BAAKC,iBAAiBD,MAAM,IAAI,EAAE;2BAAMA;qBAAO;gBACzD;YACF;YAEA,OAAOC;QACT;QAEA,OAAO;YACL,GAAGpB,MAAM;YACTiC,QAAQ;gBACN,GAAGjC,OAAOiC,MAAM;gBAChB,gDAAgD;gBAChDC,qBAAqB3B;YACvB;YACA4B,WAAW;mBACLnC,OAAOmC,SAAS,IAAI,EAAE;gBAC1B;oBACEC,SAAS5C;oBACT6C,QAAQ;oBACRR,MAAM;gBACR;gBACA;oBACEO,SAAS7C;oBACT8C,QAAQ;oBACRR,MAAM;gBACR;aACD;YACDS,MAAM;gBACJ,GAAGtC,OAAOsC,IAAI;gBACd3C,cAAcC,gBAAgBD,cAAcI,eAAeuC,IAAI,EAAE3C,gBAAgB,CAAC;YACpF;QACF;IACF,EAAC"}
+{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config, PayloadRequest, Widget, WidgetInstance } from 'payload'\n\nimport type {\n  AltTextPluginConfig,\n  IncomingAltTextPluginConfig,\n} from './types/AltTextPluginConfig.js'\n\nimport { altTextHealthEndpoint } from './endpoints/altTextHealth.js'\nimport { bulkGenerateAltTextsEndpoint } from './endpoints/bulkGenerateAltTexts.js'\nimport { generateAltTextEndpoint } from './endpoints/generateAltText.js'\nimport { altTextField } from './fields/altTextField.js'\nimport { keywordsField } from './fields/keywordsField.js'\nimport {\n  createRevalidateAltTextHealthAfterChangeHook,\n  createRevalidateAltTextHealthAfterDeleteHook,\n} from './hooks/revalidateAltTextHealth.js'\nimport { translations } from './translations/index.js'\nimport { deepMergeSimple } from './utils/deepMergeSimple.js'\n\nconst altTextHealthWidgetDefinition: Widget = {\n  slug: 'alt-text-health',\n  Component: '@jhb.software/payload-alt-text-plugin/server#AltTextHealthWidget',\n  label: {\n    de: 'Alternativtexte Zustand',\n    en: 'Alt text health',\n  },\n  maxWidth: 'full',\n  minWidth: 'medium',\n}\n\ntype DashboardDefaultLayout = Config['admin'] extends infer TAdmin\n  ? TAdmin extends { dashboard?: infer TDashboard }\n    ? TDashboard extends { defaultLayout?: infer TDefaultLayout }\n      ? TDefaultLayout\n      : never\n    : never\n  : never\n\nconst defaultAltTextHealthWidgetLayout: WidgetInstance = {\n  widgetSlug: 'alt-text-health',\n  width: 'full',\n}\n\nfunction appendAltTextHealthWidgetToLayout(layout: WidgetInstance[]): WidgetInstance[] {\n  if (layout.some((widget) => widget.widgetSlug === 'alt-text-health')) {\n    return layout\n  }\n\n  return [...layout, defaultAltTextHealthWidgetLayout]\n}\n\nfunction getDashboardDefaultLayout(defaultLayout: DashboardDefaultLayout | undefined) {\n  if (!defaultLayout) {\n    return [\n      {\n        widgetSlug: 'collections',\n        width: 'full',\n      },\n      defaultAltTextHealthWidgetLayout,\n    ] satisfies WidgetInstance[]\n  }\n\n  if (Array.isArray(defaultLayout)) {\n    return appendAltTextHealthWidgetToLayout(defaultLayout)\n  }\n\n  return async ({ req }: { req: PayloadRequest }) =>\n    appendAltTextHealthWidgetToLayout(await defaultLayout({ req }))\n}\n\nexport const payloadAltTextPlugin =\n  (incomingPluginConfig: IncomingAltTextPluginConfig) =>\n  (incomingConfig: Config): Config => {\n    const config = { ...incomingConfig }\n\n    // If the plugin is disabled, return the config without modifying it\n    if (incomingPluginConfig.enabled === false) {\n      return config\n    }\n\n    const locales = config.localization\n      ? config.localization.locales.map((localeConfig) =>\n          typeof localeConfig === 'string' ? localeConfig : localeConfig.code,\n        )\n      : []\n\n    const enableHealthCheck = incomingPluginConfig.healthCheck !== false\n\n    const pluginConfig: AltTextPluginConfig = {\n      access: incomingPluginConfig.access ?? (({ req }) => !!req.user),\n      collections: incomingPluginConfig.collections,\n      enabled: incomingPluginConfig.enabled ?? true,\n      fieldsOverride: incomingPluginConfig.fieldsOverride,\n      getImageThumbnail: incomingPluginConfig.getImageThumbnail,\n      healthCheck: enableHealthCheck,\n      locale: incomingPluginConfig.locale,\n      locales,\n      maxBulkGenerateConcurrency: incomingPluginConfig.maxBulkGenerateConcurrency ?? 16,\n      resolver: incomingPluginConfig.resolver,\n    }\n\n    // Validate locale requirement for non-localized mode\n    if (locales.length === 0 && !incomingPluginConfig.locale) {\n      throw new Error(\n        'The alt-text plugin requires a \"locale\" option when Payload localization is disabled. ' +\n          'Please add { locale: \"en\" } (or your preferred locale) to your plugin configuration.',\n      )\n    }\n\n    const 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              // TODO: use the beforeBulkAction custom component slot once available: https://github.com/payloadcms/payload/pull/11719\n              beforeListTable: [\n                ...(collectionConfig.admin?.components?.beforeListTable ?? []),\n                {\n                  path: '@jhb.software/payload-alt-text-plugin/client#BulkGenerateAltTextsButton',\n                  props: {\n                    collectionSlug: collectionConfig.slug,\n                  },\n                },\n              ],\n            },\n            // enhance the search by adding the filename, keywords and alt fields (if the user has not provided their own listSearchableFields)\n            listSearchableFields: collectionConfig.admin?.listSearchableFields ?? [\n              'filename',\n              'keywords',\n              'alt',\n            ],\n          },\n          fields: [...(collectionConfig.fields ?? []), ...fields],\n          hooks: {\n            ...collectionConfig.hooks,\n            ...(enableHealthCheck && {\n              afterChange: [\n                ...(collectionConfig.hooks?.afterChange ?? []),\n                createRevalidateAltTextHealthAfterChangeHook(collectionConfig.slug),\n              ],\n              afterDelete: [\n                ...(collectionConfig.hooks?.afterDelete ?? []),\n                createRevalidateAltTextHealthAfterDeleteHook(collectionConfig.slug),\n              ],\n            }),\n          },\n        }\n      }\n\n      return collectionConfig\n    })\n\n    const existingWidgets = config.admin?.dashboard?.widgets ?? []\n    const widgets =\n      !enableHealthCheck || existingWidgets.some((widget) => widget.slug === 'alt-text-health')\n        ? existingWidgets\n        : [...existingWidgets, altTextHealthWidgetDefinition]\n\n    return {\n      ...config,\n      admin: {\n        ...config.admin,\n        dashboard: {\n          ...config.admin?.dashboard,\n          ...(enableHealthCheck && {\n            defaultLayout: getDashboardDefaultLayout(config.admin?.dashboard?.defaultLayout),\n          }),\n          widgets,\n        },\n      },\n      custom: {\n        ...config.custom,\n        // Make plugin config available in hooks/actions\n        altTextPluginConfig: pluginConfig,\n      },\n      endpoints: [\n        ...(config.endpoints ?? []),\n        {\n          handler: generateAltTextEndpoint(pluginConfig.access),\n          method: 'post',\n          path: '/alt-text-plugin/generate',\n        },\n        {\n          handler: bulkGenerateAltTextsEndpoint(pluginConfig.access),\n          method: 'post',\n          path: '/alt-text-plugin/generate/bulk',\n        },\n        ...(enableHealthCheck\n          ? [\n              {\n                handler: altTextHealthEndpoint(pluginConfig.access),\n                method: 'get' as const,\n                path: '/alt-text-plugin/health',\n              },\n            ]\n          : []),\n      ],\n      i18n: {\n        ...config.i18n,\n        translations: deepMergeSimple(translations, incomingConfig.i18n?.translations ?? {}),\n      },\n    }\n  }\n"],"names":["altTextHealthEndpoint","bulkGenerateAltTextsEndpoint","generateAltTextEndpoint","altTextField","keywordsField","createRevalidateAltTextHealthAfterChangeHook","createRevalidateAltTextHealthAfterDeleteHook","translations","deepMergeSimple","altTextHealthWidgetDefinition","slug","Component","label","de","en","maxWidth","minWidth","defaultAltTextHealthWidgetLayout","widgetSlug","width","appendAltTextHealthWidgetToLayout","layout","some","widget","getDashboardDefaultLayout","defaultLayout","Array","isArray","req","payloadAltTextPlugin","incomingPluginConfig","incomingConfig","config","enabled","locales","localization","map","localeConfig","code","enableHealthCheck","healthCheck","pluginConfig","access","user","collections","fieldsOverride","getImageThumbnail","locale","maxBulkGenerateConcurrency","resolver","length","Error","defaultFields","localized","Boolean","fields","collectionConfig","includes","upload","console","warn","admin","components","beforeListTable","path","props","collectionSlug","listSearchableFields","hooks","afterChange","afterDelete","existingWidgets","dashboard","widgets","custom","altTextPluginConfig","endpoints","handler","method","i18n"],"mappings":"AAOA,SAASA,qBAAqB,QAAQ,+BAA8B;AACpE,SAASC,4BAA4B,QAAQ,sCAAqC;AAClF,SAASC,uBAAuB,QAAQ,iCAAgC;AACxE,SAASC,YAAY,QAAQ,2BAA0B;AACvD,SAASC,aAAa,QAAQ,4BAA2B;AACzD,SACEC,4CAA4C,EAC5CC,4CAA4C,QACvC,qCAAoC;AAC3C,SAASC,YAAY,QAAQ,0BAAyB;AACtD,SAASC,eAAe,QAAQ,6BAA4B;AAE5D,MAAMC,gCAAwC;IAC5CC,MAAM;IACNC,WAAW;IACXC,OAAO;QACLC,IAAI;QACJC,IAAI;IACN;IACAC,UAAU;IACVC,UAAU;AACZ;AAUA,MAAMC,mCAAmD;IACvDC,YAAY;IACZC,OAAO;AACT;AAEA,SAASC,kCAAkCC,MAAwB;IACjE,IAAIA,OAAOC,IAAI,CAAC,CAACC,SAAWA,OAAOL,UAAU,KAAK,oBAAoB;QACpE,OAAOG;IACT;IAEA,OAAO;WAAIA;QAAQJ;KAAiC;AACtD;AAEA,SAASO,0BAA0BC,aAAiD;IAClF,IAAI,CAACA,eAAe;QAClB,OAAO;YACL;gBACEP,YAAY;gBACZC,OAAO;YACT;YACAF;SACD;IACH;IAEA,IAAIS,MAAMC,OAAO,CAACF,gBAAgB;QAChC,OAAOL,kCAAkCK;IAC3C;IAEA,OAAO,OAAO,EAAEG,GAAG,EAA2B,GAC5CR,kCAAkC,MAAMK,cAAc;YAAEG;QAAI;AAChE;AAEA,OAAO,MAAMC,uBACX,CAACC,uBACD,CAACC;QACC,MAAMC,SAAS;YAAE,GAAGD,cAAc;QAAC;QAEnC,oEAAoE;QACpE,IAAID,qBAAqBG,OAAO,KAAK,OAAO;YAC1C,OAAOD;QACT;QAEA,MAAME,UAAUF,OAAOG,YAAY,GAC/BH,OAAOG,YAAY,CAACD,OAAO,CAACE,GAAG,CAAC,CAACC,eAC/B,OAAOA,iBAAiB,WAAWA,eAAeA,aAAaC,IAAI,IAErE,EAAE;QAEN,MAAMC,oBAAoBT,qBAAqBU,WAAW,KAAK;QAE/D,MAAMC,eAAoC;YACxCC,QAAQZ,qBAAqBY,MAAM,IAAK,CAAA,CAAC,EAAEd,GAAG,EAAE,GAAK,CAAC,CAACA,IAAIe,IAAI,AAAD;YAC9DC,aAAad,qBAAqBc,WAAW;YAC7CX,SAASH,qBAAqBG,OAAO,IAAI;YACzCY,gBAAgBf,qBAAqBe,cAAc;YACnDC,mBAAmBhB,qBAAqBgB,iBAAiB;YACzDN,aAAaD;YACbQ,QAAQjB,qBAAqBiB,MAAM;YACnCb;YACAc,4BAA4BlB,qBAAqBkB,0BAA0B,IAAI;YAC/EC,UAAUnB,qBAAqBmB,QAAQ;QACzC;QAEA,qDAAqD;QACrD,IAAIf,QAAQgB,MAAM,KAAK,KAAK,CAACpB,qBAAqBiB,MAAM,EAAE;YACxD,MAAM,IAAII,MACR,2FACE;QAEN;QAEA,MAAMC,gBAAgB;YACpBjD,aAAa;gBACXkD,WAAWC,QAAQtB,OAAOG,YAAY;YACxC;YACA/B,cAAc;gBACZiD,WAAWC,QAAQtB,OAAOG,YAAY;YACxC;SACD;QAED,MAAMoB,SACJzB,qBAAqBe,cAAc,IACnC,OAAOf,qBAAqBe,cAAc,KAAK,aAC3Cf,qBAAqBe,cAAc,CAAC;YAAEO;QAAc,KACpDA;QAEN,kCAAkC;QAClCpB,OAAOY,WAAW,GAAGZ,OAAOY,WAAW,IAAI,EAAE;QAE7C,yEAAyE;QACzEZ,OAAOY,WAAW,GAAGZ,OAAOY,WAAW,CAACR,GAAG,CAAC,CAACoB;YAC3C,IAAIf,aAAaG,WAAW,CAACa,QAAQ,CAACD,iBAAiB9C,IAAI,GAAG;gBAC5D,IAAI,CAAC8C,iBAAiBE,MAAM,EAAE;oBAC5BC,QAAQC,IAAI,CACV,CAAC,gCAAgC,EAAEJ,iBAAiB9C,IAAI,CAAC,wDAAwD,CAAC;oBAEpH,OAAO8C;gBACT;gBAEA,OAAO;oBACL,GAAGA,gBAAgB;oBACnBK,OAAO;wBACL,GAAGL,iBAAiBK,KAAK;wBACzBC,YAAY;4BACV,GAAIN,iBAAiBK,KAAK,EAAEC,cAAc,CAAC,CAAC;4BAC5C,wHAAwH;4BACxHC,iBAAiB;mCACXP,iBAAiBK,KAAK,EAAEC,YAAYC,mBAAmB,EAAE;gCAC7D;oCACEC,MAAM;oCACNC,OAAO;wCACLC,gBAAgBV,iBAAiB9C,IAAI;oCACvC;gCACF;6BACD;wBACH;wBACA,mIAAmI;wBACnIyD,sBAAsBX,iBAAiBK,KAAK,EAAEM,wBAAwB;4BACpE;4BACA;4BACA;yBACD;oBACH;oBACAZ,QAAQ;2BAAKC,iBAAiBD,MAAM,IAAI,EAAE;2BAAMA;qBAAO;oBACvDa,OAAO;wBACL,GAAGZ,iBAAiBY,KAAK;wBACzB,GAAI7B,qBAAqB;4BACvB8B,aAAa;mCACPb,iBAAiBY,KAAK,EAAEC,eAAe,EAAE;gCAC7ChE,6CAA6CmD,iBAAiB9C,IAAI;6BACnE;4BACD4D,aAAa;mCACPd,iBAAiBY,KAAK,EAAEE,eAAe,EAAE;gCAC7ChE,6CAA6CkD,iBAAiB9C,IAAI;6BACnE;wBACH,CAAC;oBACH;gBACF;YACF;YAEA,OAAO8C;QACT;QAEA,MAAMe,kBAAkBvC,OAAO6B,KAAK,EAAEW,WAAWC,WAAW,EAAE;QAC9D,MAAMA,UACJ,CAAClC,qBAAqBgC,gBAAgBjD,IAAI,CAAC,CAACC,SAAWA,OAAOb,IAAI,KAAK,qBACnE6D,kBACA;eAAIA;YAAiB9D;SAA8B;QAEzD,OAAO;YACL,GAAGuB,MAAM;YACT6B,OAAO;gBACL,GAAG7B,OAAO6B,KAAK;gBACfW,WAAW;oBACT,GAAGxC,OAAO6B,KAAK,EAAEW,SAAS;oBAC1B,GAAIjC,qBAAqB;wBACvBd,eAAeD,0BAA0BQ,OAAO6B,KAAK,EAAEW,WAAW/C;oBACpE,CAAC;oBACDgD;gBACF;YACF;YACAC,QAAQ;gBACN,GAAG1C,OAAO0C,MAAM;gBAChB,gDAAgD;gBAChDC,qBAAqBlC;YACvB;YACAmC,WAAW;mBACL5C,OAAO4C,SAAS,IAAI,EAAE;gBAC1B;oBACEC,SAAS3E,wBAAwBuC,aAAaC,MAAM;oBACpDoC,QAAQ;oBACRd,MAAM;gBACR;gBACA;oBACEa,SAAS5E,6BAA6BwC,aAAaC,MAAM;oBACzDoC,QAAQ;oBACRd,MAAM;gBACR;mBACIzB,oBACA;oBACE;wBACEsC,SAAS7E,sBAAsByC,aAAaC,MAAM;wBAClDoC,QAAQ;wBACRd,MAAM;oBACR;iBACD,GACD,EAAE;aACP;YACDe,MAAM;gBACJ,GAAG/C,OAAO+C,IAAI;gBACdxE,cAAcC,gBAAgBD,cAAcwB,eAAegD,IAAI,EAAExE,gBAAgB,CAAC;YACpF;QACF;IACF,EAAC"}

package/dist/translations/de.js

@@ -26,7 +26,17 @@ export const de = {
         // Tooltips
         pleaseSaveDocumentFirst: 'Bitte speichern Sie zuerst das Dokument',
         // Validation messages
-        theAlternateTextIsRequired: 'Der Alternativtext ist erforderlich.'
+        theAlternateTextIsRequired: 'Der Alternativtext ist erforderlich.',
+        // Dashboard widget
+        altTextHealthDescription: 'Status der Bilder mit gesetztem Alternativtext.',
+        altTextHealthWidget: 'Alternativtexte Zustand',
+        collectionCheckFailed: 'Prüfung nicht verfügbar',
+        healthCheckPartialWarning: 'Einige Sammlungen konnten gerade nicht geprüft werden.',
+        localeCount: '{count} Sprachen',
+        noImagesFound: 'In den konfigurierten Sammlungen wurden noch keine Bilder gefunden.',
+        statusHealthy: 'Alternativtexte vorhanden',
+        statusUnhealthy: 'fehlende Alternativtexte',
+        totalImageCount: '{count} Bilder'
     }
 };
 

package/dist/translations/de.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/translations/de.ts"],"sourcesContent":["import type { 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    altTextGeneratedSuccess:\n      'Alternativtext erfolgreich generiert. Bitte überprüfen und speichern Sie das Dokument.',\n    cannotGenerateMissingFields:\n      'Alternativtext kann nicht generiert werden. Erforderliche Felder fehlen.',\n    errorGeneratingAltText:\n      'Fehler beim Generieren des Alternativtextes. Bitte versuchen Sie es erneut.',\n    failedToGenerate:\n      'Generierung des Alternativtextes fehlgeschlagen. Bitte versuchen Sie es erneut.',\n    failedToGenerateForXImages: 'Generierung des Alternativtextes für {X} Bilder fehlgeschlagen.',\n    noAltTextGenerated: 'Kein Alternativtext generiert. Bitte versuchen Sie es erneut.',\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","altTextGeneratedSuccess","cannotGenerateMissingFields","errorGeneratingAltText","failedToGenerate","failedToGenerateForXImages","noAltTextGenerated","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,yBACE;QACFC,6BACE;QACFC,wBACE;QACFC,kBACE;QACFC,4BAA4B;QAC5BC,oBAAoB;QACpBC,mBAAmB;QAEnB,YAAY;QACZC,oBACE;QACFC,qBAAqB;QACrBC,qBACE;QACFC,qBACE;QAEF,WAAW;QACXC,yBAAyB;QAEzB,sBAAsB;QACtBC,4BAA4B;IAC9B;AACF,EAAC"}
+{"version":3,"sources":["../../src/translations/de.ts"],"sourcesContent":["import type { 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    altTextGeneratedSuccess:\n      'Alternativtext erfolgreich generiert. Bitte überprüfen und speichern Sie das Dokument.',\n    cannotGenerateMissingFields:\n      'Alternativtext kann nicht generiert werden. Erforderliche Felder fehlen.',\n    errorGeneratingAltText:\n      'Fehler beim Generieren des Alternativtextes. Bitte versuchen Sie es erneut.',\n    failedToGenerate:\n      'Generierung des Alternativtextes fehlgeschlagen. Bitte versuchen Sie es erneut.',\n    failedToGenerateForXImages: 'Generierung des Alternativtextes für {X} Bilder fehlgeschlagen.',\n    noAltTextGenerated: 'Kein Alternativtext generiert. Bitte versuchen Sie es erneut.',\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    // Dashboard widget\n    altTextHealthDescription: 'Status der Bilder mit gesetztem Alternativtext.',\n    altTextHealthWidget: 'Alternativtexte Zustand',\n    collectionCheckFailed: 'Prüfung nicht verfügbar',\n    healthCheckPartialWarning: 'Einige Sammlungen konnten gerade nicht geprüft werden.',\n    localeCount: '{count} Sprachen',\n    noImagesFound: 'In den konfigurierten Sammlungen wurden noch keine Bilder gefunden.',\n    statusHealthy: 'Alternativtexte vorhanden',\n    statusUnhealthy: 'fehlende Alternativtexte',\n    totalImageCount: '{count} Bilder',\n  },\n}\n"],"names":["de","$schema","alternateText","keywords","keywordsDescription","generateAltText","generateAltTextFor","image","images","altTextGeneratedSuccess","cannotGenerateMissingFields","errorGeneratingAltText","failedToGenerate","failedToGenerateForXImages","noAltTextGenerated","xOfYImagesUpdated","altTextDescription","altTextRequirement1","altTextRequirement2","altTextRequirement3","pleaseSaveDocumentFirst","theAlternateTextIsRequired","altTextHealthDescription","altTextHealthWidget","collectionCheckFailed","healthCheckPartialWarning","localeCount","noImagesFound","statusHealthy","statusUnhealthy","totalImageCount"],"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,yBACE;QACFC,6BACE;QACFC,wBACE;QACFC,kBACE;QACFC,4BAA4B;QAC5BC,oBAAoB;QACpBC,mBAAmB;QAEnB,YAAY;QACZC,oBACE;QACFC,qBAAqB;QACrBC,qBACE;QACFC,qBACE;QAEF,WAAW;QACXC,yBAAyB;QAEzB,sBAAsB;QACtBC,4BAA4B;QAE5B,mBAAmB;QACnBC,0BAA0B;QAC1BC,qBAAqB;QACrBC,uBAAuB;QACvBC,2BAA2B;QAC3BC,aAAa;QACbC,eAAe;QACfC,eAAe;QACfC,iBAAiB;QACjBC,iBAAiB;IACnB;AACF,EAAC"}

package/dist/translations/en.js

@@ -26,7 +26,17 @@ export const en = {
         // Tooltips
         pleaseSaveDocumentFirst: 'Please save the document first',
         // Validation messages
-        theAlternateTextIsRequired: 'An alternate text is required.'
+        theAlternateTextIsRequired: 'An alternate text is required.',
+        // Dashboard widget
+        altTextHealthDescription: 'Alt text status across your upload collections.',
+        altTextHealthWidget: 'Alt text health',
+        collectionCheckFailed: 'Health check unavailable',
+        healthCheckPartialWarning: 'Some collections could not be checked right now.',
+        localeCount: '{count} locales',
+        noImagesFound: 'No images found in the configured collections yet.',
+        statusHealthy: 'All set',
+        statusUnhealthy: 'missing alt text',
+        totalImageCount: '{count} images'
     }
 };
 

package/dist/translations/en.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/translations/en.ts"],"sourcesContent":["import type { 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    altTextGeneratedSuccess:\n      'Alt text generated successfully. Please review and save the document.',\n    cannotGenerateMissingFields: 'Cannot generate alt text. Missing required fields.',\n    errorGeneratingAltText: 'Error generating alt text. Please try again.',\n    failedToGenerate: 'Failed to generate alt text. Please try again.',\n    failedToGenerateForXImages: 'Failed to generate alt text for {X} images.',\n    noAltTextGenerated: 'No alt text generated. Please try again.',\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","altTextGeneratedSuccess","cannotGenerateMissingFields","errorGeneratingAltText","failedToGenerate","failedToGenerateForXImages","noAltTextGenerated","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,yBACE;QACFC,6BAA6B;QAC7BC,wBAAwB;QACxBC,kBAAkB;QAClBC,4BAA4B;QAC5BC,oBAAoB;QACpBC,mBAAmB;QAEnB,YAAY;QACZC,oBACE;QACFC,qBAAqB;QACrBC,qBACE;QACFC,qBACE;QAEF,WAAW;QACXC,yBAAyB;QAEzB,sBAAsB;QACtBC,4BAA4B;IAC9B;AACF,EAAC"}
+{"version":3,"sources":["../../src/translations/en.ts"],"sourcesContent":["import type { 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    altTextGeneratedSuccess:\n      'Alt text generated successfully. Please review and save the document.',\n    cannotGenerateMissingFields: 'Cannot generate alt text. Missing required fields.',\n    errorGeneratingAltText: 'Error generating alt text. Please try again.',\n    failedToGenerate: 'Failed to generate alt text. Please try again.',\n    failedToGenerateForXImages: 'Failed to generate alt text for {X} images.',\n    noAltTextGenerated: 'No alt text generated. Please try again.',\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    // Dashboard widget\n    altTextHealthDescription: 'Alt text status across your upload collections.',\n    altTextHealthWidget: 'Alt text health',\n    collectionCheckFailed: 'Health check unavailable',\n    healthCheckPartialWarning: 'Some collections could not be checked right now.',\n    localeCount: '{count} locales',\n    noImagesFound: 'No images found in the configured collections yet.',\n    statusHealthy: 'All set',\n    statusUnhealthy: 'missing alt text',\n    totalImageCount: '{count} images',\n  },\n}\n"],"names":["en","$schema","alternateText","keywords","keywordsDescription","generateAltText","generateAltTextFor","image","images","altTextGeneratedSuccess","cannotGenerateMissingFields","errorGeneratingAltText","failedToGenerate","failedToGenerateForXImages","noAltTextGenerated","xOfYImagesUpdated","altTextDescription","altTextRequirement1","altTextRequirement2","altTextRequirement3","pleaseSaveDocumentFirst","theAlternateTextIsRequired","altTextHealthDescription","altTextHealthWidget","collectionCheckFailed","healthCheckPartialWarning","localeCount","noImagesFound","statusHealthy","statusUnhealthy","totalImageCount"],"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,yBACE;QACFC,6BAA6B;QAC7BC,wBAAwB;QACxBC,kBAAkB;QAClBC,4BAA4B;QAC5BC,oBAAoB;QACpBC,mBAAmB;QAEnB,YAAY;QACZC,oBACE;QACFC,qBAAqB;QACrBC,qBACE;QACFC,qBACE;QAEF,WAAW;QACXC,yBAAyB;QAEzB,sBAAsB;QACtBC,4BAA4B;QAE5B,mBAAmB;QACnBC,0BAA0B;QAC1BC,qBAAqB;QACrBC,uBAAuB;QACvBC,2BAA2B;QAC3BC,aAAa;QACbC,eAAe;QACfC,eAAe;QACfC,iBAAiB;QACjBC,iBAAiB;IACnB;AACF,EAAC"}

package/dist/translations/translation-schema.json

@@ -6,47 +6,65 @@
       "type": "object",
       "properties": {
         "alternateText": { "type": "string" },
-        "keywords": { "type": "string" },
-        "keywordsDescription": { "type": "string" },
+        "altTextDescription": { "type": "string" },
+        "altTextGeneratedSuccess": { "type": "string" },
+        "altTextHealthDescription": { "type": "string" },
+        "altTextHealthWidget": { "type": "string" },
+        "altTextRequirement1": { "type": "string" },
+        "altTextRequirement2": { "type": "string" },
+        "altTextRequirement3": { "type": "string" },
+        "cannotGenerateMissingFields": { "type": "string" },
+        "collectionCheckFailed": { "type": "string" },
+        "errorGeneratingAltText": { "type": "string" },
+        "failedToGenerate": { "type": "string" },
+        "failedToGenerateForXImages": { "type": "string" },
         "generateAltText": { "type": "string" },
         "generateAltTextFor": { "type": "string" },
+        "healthCheckPartialWarning": { "type": "string" },
         "image": { "type": "string" },
         "images": { "type": "string" },
-        "cannotGenerateMissingFields": { "type": "string" },
-        "failedToGenerate": { "type": "string" },
-        "altTextGeneratedSuccess": { "type": "string" },
+        "keywords": { "type": "string" },
+        "localeCount": { "type": "string" },
+        "keywordsDescription": { "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" },
+        "noImagesFound": { "type": "string" },
         "pleaseSaveDocumentFirst": { "type": "string" },
-        "theAlternateTextIsRequired": { "type": "string" }
+        "statusHealthy": { "type": "string" },
+        "statusUnhealthy": { "type": "string" },
+        "theAlternateTextIsRequired": { "type": "string" },
+        "totalImageCount": { "type": "string" },
+        "xOfYImagesUpdated": { "type": "string" }
       },
       "required": [
         "alternateText",
-        "keywords",
-        "keywordsDescription",
+        "altTextDescription",
+        "altTextGeneratedSuccess",
+        "altTextHealthDescription",
+        "altTextHealthWidget",
+        "altTextRequirement1",
+        "altTextRequirement2",
+        "altTextRequirement3",
+        "cannotGenerateMissingFields",
+        "collectionCheckFailed",
+        "errorGeneratingAltText",
+        "failedToGenerate",
+        "failedToGenerateForXImages",
         "generateAltText",
         "generateAltTextFor",
+        "healthCheckPartialWarning",
         "image",
         "images",
-        "cannotGenerateMissingFields",
-        "failedToGenerate",
-        "altTextGeneratedSuccess",
+        "keywords",
+        "keywordsDescription",
+        "localeCount",
         "noAltTextGenerated",
-        "errorGeneratingAltText",
-        "failedToGenerateForXImages",
-        "xOfYImagesUpdated",
-        "altTextDescription",
-        "altTextRequirement1",
-        "altTextRequirement2",
-        "altTextRequirement3",
+        "noImagesFound",
         "pleaseSaveDocumentFirst",
-        "theAlternateTextIsRequired"
+        "statusHealthy",
+        "statusUnhealthy",
+        "theAlternateTextIsRequired",
+        "totalImageCount",
+        "xOfYImagesUpdated"
       ]
     }
   },

package/dist/types/AltTextPluginConfig.d.ts

@@ -1,7 +1,16 @@
-import type { CollectionSlug, Field } from 'payload';
+import type { CollectionSlug, Field, PayloadRequest } from 'payload';
 import type { AltTextResolver } from '../resolvers/types.js';
 /** Configuration options for the alt text plugin. */
 export type IncomingAltTextPluginConfig = {
+    /**
+     * Custom access control for plugin endpoints.
+     * Return `true` to allow access, `false` to deny.
+     *
+     * @default ({ req }) => !!req.user — requires authentication
+     */
+    access?: (args: {
+        req: PayloadRequest;
+    }) => boolean | Promise<boolean>;
     /** Collection slugs to enable the plugin for. */
     collections: CollectionSlug[];
     /** Whether the plugin is enabled. */
@@ -19,6 +28,13 @@ export type IncomingAltTextPluginConfig = {
      * - Use a thumbnail/preview version of the image when possible (e.g. from the sizes field)
      */
     getImageThumbnail: (doc: Record<string, unknown>) => string;
+    /**
+     * Enable alt text health tracking (REST endpoint, cache revalidation hooks, and dashboard widget).
+     * Set to `false` to disable the entire feature.
+     *
+     * @default true
+     */
+    healthCheck?: boolean;
     /**
      * The locale to generate alt texts in when localization is disabled.
      *
@@ -37,6 +53,10 @@ export type IncomingAltTextPluginConfig = {
 };
 /** Configuration of the alt text plugin after defaults have been applied. */
 export type AltTextPluginConfig = {
+    /** Access control for plugin endpoints. */
+    access: (args: {
+        req: PayloadRequest;
+    }) => boolean | Promise<boolean>;
     /** Collection slugs to enable the plugin for. */
     collections: CollectionSlug[];
     /** Whether the plugin is enabled. */
@@ -47,6 +67,8 @@ export type AltTextPluginConfig = {
     }) => Field[];
     /** Function to get the thumbnail URL of an image document. */
     getImageThumbnail: (doc: Record<string, unknown>) => string;
+    /** Whether alt text health tracking is enabled. */
+    healthCheck: boolean;
     /** The locale to generate alt texts in when localization is disabled. */
     locale?: string;
     /** The locales to generate alt texts for. */

package/dist/types/AltTextPluginConfig.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/AltTextPluginConfig.ts"],"sourcesContent":["import type { CollectionSlug, Field } from 'payload'\n\nimport type { AltTextResolver } from '../resolvers/types.js'\n\n/** Configuration options for the alt text plugin. */\nexport type IncomingAltTextPluginConfig = {\n  /** Collection slugs to enable the plugin for. */\n  collections: CollectionSlug[]\n\n  /** Whether the plugin is enabled. */\n  enabled?: boolean\n\n  /** Override the default fields inserted by the plugin via a function that receives the default fields and returns the new fields */\n  fieldsOverride?: (args: { defaultFields: Field[] }) => Field[]\n\n  /**\n   * Function to get the thumbnail URL of an image document.\n   * This URL will be sent to the LLM for analysis.\n   *\n   * @remarks\n   * - The URL must be publicly accessible so the LLM can fetch it\n   * - Use a thumbnail/preview version of the image when possible (e.g. from the sizes field)\n   */\n  getImageThumbnail: (doc: Record<string, unknown>) => string\n\n  /**\n   * The locale to generate alt texts in when localization is disabled.\n   *\n   * Required when localization is disabled, ignored when localization is enabled.\n   * @example 'en'\n   */\n  locale?: string\n\n  /**\n   * Maximum number of concurrent API requests for bulk generate operations.\n   *\n   * @default 16\n   */\n  maxBulkGenerateConcurrency?: number\n\n  /** The resolver to use for generating alt text (e.g., openAIResolver) */\n  resolver: AltTextResolver\n}\n\n/** Configuration of the alt text plugin after defaults have been applied. */\nexport type AltTextPluginConfig = {\n  /** Collection slugs to enable the plugin for. */\n  collections: CollectionSlug[]\n\n  /** Whether the plugin is enabled. */\n  enabled: boolean\n\n  /** Override the default fields inserted by the plugin via a function that receives the default fields and returns the new fields */\n  fieldsOverride?: (args: { defaultFields: Field[] }) => Field[]\n\n  /** Function to get the thumbnail URL of an image document. */\n  getImageThumbnail: (doc: Record<string, unknown>) => string\n\n  /** The locale to generate alt texts in when localization is disabled. */\n  locale?: string\n\n  /** The locales to generate alt texts for. */\n  locales: string[]\n\n  /** Maximum number of concurrent API requests for bulk generate operations. */\n  maxBulkGenerateConcurrency: number\n\n  /** The resolver to use for generating alt text */\n  resolver: AltTextResolver\n}\n"],"names":[],"mappings":"AA4CA,2EAA2E,GAC3E,WAwBC"}
+{"version":3,"sources":["../../src/types/AltTextPluginConfig.ts"],"sourcesContent":["import type { CollectionSlug, Field, PayloadRequest } from 'payload'\n\nimport type { AltTextResolver } from '../resolvers/types.js'\n\n/** Configuration options for the alt text plugin. */\nexport type IncomingAltTextPluginConfig = {\n  /**\n   * Custom access control for plugin endpoints.\n   * Return `true` to allow access, `false` to deny.\n   *\n   * @default ({ req }) => !!req.user — requires authentication\n   */\n  access?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\n  /** Collection slugs to enable the plugin for. */\n  collections: CollectionSlug[]\n\n  /** Whether the plugin is enabled. */\n  enabled?: boolean\n\n  /** Override the default fields inserted by the plugin via a function that receives the default fields and returns the new fields */\n  fieldsOverride?: (args: { defaultFields: Field[] }) => Field[]\n\n  /**\n   * Function to get the thumbnail URL of an image document.\n   * This URL will be sent to the LLM for analysis.\n   *\n   * @remarks\n   * - The URL must be publicly accessible so the LLM can fetch it\n   * - Use a thumbnail/preview version of the image when possible (e.g. from the sizes field)\n   */\n  getImageThumbnail: (doc: Record<string, unknown>) => string\n\n  /**\n   * Enable alt text health tracking (REST endpoint, cache revalidation hooks, and dashboard widget).\n   * Set to `false` to disable the entire feature.\n   *\n   * @default true\n   */\n  healthCheck?: boolean\n\n  /**\n   * The locale to generate alt texts in when localization is disabled.\n   *\n   * Required when localization is disabled, ignored when localization is enabled.\n   * @example 'en'\n   */\n  locale?: string\n\n  /**\n   * Maximum number of concurrent API requests for bulk generate operations.\n   *\n   * @default 16\n   */\n  maxBulkGenerateConcurrency?: number\n\n  /** The resolver to use for generating alt text (e.g., openAIResolver) */\n  resolver: AltTextResolver\n}\n\n/** Configuration of the alt text plugin after defaults have been applied. */\nexport type AltTextPluginConfig = {\n  /** Access control for plugin endpoints. */\n  access: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\n  /** Collection slugs to enable the plugin for. */\n  collections: CollectionSlug[]\n\n  /** Whether the plugin is enabled. */\n  enabled: boolean\n\n  /** Override the default fields inserted by the plugin via a function that receives the default fields and returns the new fields */\n  fieldsOverride?: (args: { defaultFields: Field[] }) => Field[]\n\n  /** Function to get the thumbnail URL of an image document. */\n  getImageThumbnail: (doc: Record<string, unknown>) => string\n\n  /** Whether alt text health tracking is enabled. */\n  healthCheck: boolean\n\n  /** The locale to generate alt texts in when localization is disabled. */\n  locale?: string\n\n  /** The locales to generate alt texts for. */\n  locales: string[]\n\n  /** Maximum number of concurrent API requests for bulk generate operations. */\n  maxBulkGenerateConcurrency: number\n\n  /** The resolver to use for generating alt text */\n  resolver: AltTextResolver\n}\n"],"names":[],"mappings":"AA4DA,2EAA2E,GAC3E,WA8BC"}

package/dist/utilities/altTextHealth.d.ts

@@ -0,0 +1,37 @@
+import type { PayloadRequest } from 'payload';
+export declare const ALT_TEXT_HEALTH_PLUGIN_SLUG = "alt-text";
+export declare const ALT_TEXT_HEALTH_CACHE_TTL = 3600;
+export declare const ALT_TEXT_HEALTH_GLOBAL_TAG = "alt-text-health";
+export type AltTextHealthErrorCode = 'ALT_TEXT_COLLECTION_READ_FAILED' | 'ALT_TEXT_PLUGIN_CONFIG_MISSING';
+export type AltTextHealthError = {
+    code: AltTextHealthErrorCode;
+    collection?: string;
+    message: string;
+    operation?: 'find';
+};
+export type AltTextHealthScanCollection = {
+    collection: string;
+    completeDocs: number;
+    error?: AltTextHealthError;
+    invalidDocIds: (number | string)[] | undefined;
+    missingDocs: number;
+    partialDocs: number;
+    totalDocs: number;
+};
+export type AltTextHealthScan = {
+    checkedAt: string;
+    collections: AltTextHealthScanCollection[];
+    errors: AltTextHealthError[];
+    isLocalized: boolean;
+    localeCodes: string[];
+};
+export type AltTextHealthWidgetData = {
+    collections: AltTextHealthScanCollection[];
+    errors: AltTextHealthError[];
+    isLocalized: boolean;
+    localeCount: number;
+    totalDocs: number;
+};
+export declare const getAltTextHealthCollectionTag: (collectionSlug: string) => string;
+export declare function getAltTextHealth(req: PayloadRequest): Promise<AltTextHealthScan>;
+export declare function getAltTextHealthWidgetData(req: PayloadRequest): Promise<AltTextHealthWidgetData>;

package/dist/utilities/altTextHealth.js

@@ -0,0 +1,150 @@
+import { unstable_cache } from 'next/cache.js';
+import { createCachedAltTextHealthScan } from './altTextHealthCache.js';
+import { localesFromConfig } from './localesFromConfig.js';
+import { summarizeCollection } from './summarizeCollection.js';
+export const ALT_TEXT_HEALTH_PLUGIN_SLUG = 'alt-text';
+export const ALT_TEXT_HEALTH_CACHE_TTL = 3600;
+export const ALT_TEXT_HEALTH_GLOBAL_TAG = 'alt-text-health';
+const createUnknownScan = ({ error, isLocalized, localeCodes })=>({
+        checkedAt: new Date().toISOString(),
+        collections: [],
+        errors: [
+            error
+        ],
+        isLocalized,
+        localeCodes
+    });
+const createCollectionReadError = (collection, message)=>({
+        code: 'ALT_TEXT_COLLECTION_READ_FAILED',
+        collection,
+        message,
+        operation: 'find'
+    });
+const PAGE_SIZE = 500;
+async function fetchAllDocs(payload, collection, isLocalized) {
+    const docs = [];
+    let page = 1;
+    let hasMore = true;
+    while(hasMore){
+        const result = await payload.find({
+            collection,
+            depth: 0,
+            fallbackLocale: isLocalized ? false : undefined,
+            limit: PAGE_SIZE,
+            locale: isLocalized ? 'all' : undefined,
+            overrideAccess: true,
+            page,
+            select: {
+                alt: true
+            }
+        });
+        for (const doc of result.docs){
+            docs.push({
+                id: doc.id,
+                alt: 'alt' in doc ? doc.alt : undefined
+            });
+        }
+        hasMore = result.hasNextPage;
+        page++;
+    }
+    return docs;
+}
+async function computeAltTextHealthScan({ collections, isLocalized, localeCodes, payload }) {
+    const collectionSummaries = await Promise.all(collections.map(async (collection)=>{
+        try {
+            const docs = await fetchAllDocs(payload, collection, isLocalized);
+            return summarizeCollection({
+                collection,
+                docs,
+                isLocalized,
+                localeCodes
+            });
+        } catch (error) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            const collectionError = createCollectionReadError(collection, message);
+            payload.logger.error({
+                collection,
+                err: error,
+                msg: 'Alt text health check failed while reading a collection.',
+                operation: 'find',
+                plugin: ALT_TEXT_HEALTH_PLUGIN_SLUG
+            });
+            return {
+                collection,
+                completeDocs: 0,
+                error: collectionError,
+                invalidDocIds: undefined,
+                missingDocs: 0,
+                partialDocs: 0,
+                totalDocs: 0
+            };
+        }
+    }));
+    const errors = collectionSummaries.filter((summary)=>summary.error).map((summary)=>summary.error);
+    return {
+        checkedAt: new Date().toISOString(),
+        collections: collectionSummaries,
+        errors,
+        isLocalized,
+        localeCodes
+    };
+}
+export const getAltTextHealthCollectionTag = (collectionSlug)=>`${ALT_TEXT_HEALTH_GLOBAL_TAG}:${collectionSlug}`;
+async function getAltTextHealthScan(req) {
+    const { payload } = req;
+    const pluginConfig = payload.config.custom?.altTextPluginConfig;
+    const localeCodes = localesFromConfig(payload.config) ?? (pluginConfig?.locale ? [
+        pluginConfig.locale
+    ] : []);
+    const isLocalized = Boolean(payload.config.localization);
+    if (!pluginConfig) {
+        return createUnknownScan({
+            error: {
+                code: 'ALT_TEXT_PLUGIN_CONFIG_MISSING',
+                message: 'Alt text plugin config not found'
+            },
+            isLocalized,
+            localeCodes
+        });
+    }
+    const collections = pluginConfig.collections;
+    const cacheKeyParts = [
+        ALT_TEXT_HEALTH_GLOBAL_TAG,
+        [
+            ...collections
+        ].sort().join(','),
+        localeCodes.join(',')
+    ];
+    const tags = [
+        ALT_TEXT_HEALTH_GLOBAL_TAG,
+        ...new Set(collections.map((collection)=>getAltTextHealthCollectionTag(collection)))
+    ];
+    const getCachedHealthScan = createCachedAltTextHealthScan({
+        cacheFactory: unstable_cache,
+        cacheKeyParts,
+        compute: async ()=>computeAltTextHealthScan({
+                collections,
+                isLocalized,
+                localeCodes,
+                payload
+            }),
+        revalidate: ALT_TEXT_HEALTH_CACHE_TTL,
+        tags
+    });
+    return getCachedHealthScan();
+}
+export async function getAltTextHealth(req) {
+    return getAltTextHealthScan(req);
+}
+export async function getAltTextHealthWidgetData(req) {
+    const scan = await getAltTextHealthScan(req);
+    return {
+        collections: scan.collections,
+        errors: scan.errors,
+        isLocalized: scan.isLocalized,
+        localeCount: scan.localeCodes.length,
+        totalDocs: scan.collections.reduce((total, c)=>total + c.totalDocs, 0)
+    };
+}
+
+//# sourceMappingURL=altTextHealth.js.map