@jhb.software/payload-alt-text-plugin 0.10.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +225 -36
- package/dist/components/BulkGenerateAltTextsButton.js +3 -16
- package/dist/components/BulkGenerateAltTextsButton.js.map +1 -1
- package/dist/components/summarizeBulkGenerate.d.ts +26 -0
- package/dist/components/summarizeBulkGenerate.js +56 -0
- package/dist/components/summarizeBulkGenerate.js.map +1 -0
- package/dist/endpoints/bulkGenerateAltTexts.d.ts +18 -1
- package/dist/endpoints/bulkGenerateAltTexts.js +39 -16
- package/dist/endpoints/bulkGenerateAltTexts.js.map +1 -1
- package/dist/endpoints/generateAltText.js +17 -9
- package/dist/endpoints/generateAltText.js.map +1 -1
- package/dist/index.d.ts +6 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/plugin.js +20 -4
- package/dist/plugin.js.map +1 -1
- package/dist/resolvers/anthropic.d.ts +64 -0
- package/dist/resolvers/anthropic.js +140 -0
- package/dist/resolvers/anthropic.js.map +1 -0
- package/dist/resolvers/createVisionResolver.d.ts +148 -0
- package/dist/resolvers/createVisionResolver.js +300 -0
- package/dist/resolvers/createVisionResolver.js.map +1 -0
- package/dist/resolvers/mistral.d.ts +15 -1
- package/dist/resolvers/mistral.js +85 -250
- package/dist/resolvers/mistral.js.map +1 -1
- package/dist/resolvers/openAI.d.ts +22 -3
- package/dist/resolvers/openAI.js +57 -138
- package/dist/resolvers/openAI.js.map +1 -1
- package/dist/translations/de.js +12 -4
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +12 -4
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/translation-schema.json +24 -8
- package/dist/types/AltTextPluginConfig.d.ts +71 -12
- package/dist/types/AltTextPluginConfig.js.map +1 -1
- package/dist/utilities/altTextHealth.d.ts +3 -1
- package/dist/utilities/altTextHealth.js +103 -12
- package/dist/utilities/altTextHealth.js.map +1 -1
- package/dist/utilities/resolveLocales.d.ts +15 -0
- package/dist/utilities/resolveLocales.js +38 -0
- package/dist/utilities/resolveLocales.js.map +1 -0
- package/dist/utilities/stableStringify.d.ts +9 -0
- package/dist/utilities/stableStringify.js +19 -0
- package/dist/utilities/stableStringify.js.map +1 -0
- package/package.json +4 -5
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/types/AltTextPluginConfig.ts"],"sourcesContent":["import type { CollectionSlug, Field, PayloadRequest } from 'payload'\n\nimport type { AltTextResolver } from '../resolvers/types.js'\nimport type {\n AltTextCollectionConfig,\n IncomingCollectionsConfig,\n NormalizedAltTextCollectionConfig,\n} from '../utilities/mimeTypes.js'\n\nexport type { AltTextCollectionConfig, NormalizedAltTextCollectionConfig }\n\n/**\n * Builds the thumbnail URL the resolver fetches. Must be publicly reachable.\n *\n * May be async, so the URL can be signed on demand (S3 presigning, short-lived\n * CDN tokens).\n *\n * @param doc The upload document to build the URL for.\n * @param args.collection The slug of the collection `doc` belongs to — use it to\n * build different URLs per collection (e.g. a Cloudinary transformation for one\n * collection and a plain S3 URL for another).\n * @param args.req The request the generation runs under.\n */\nexport type GetImageThumbnail = (\n doc: Record<string, unknown>,\n args: { collection: CollectionSlug; req: PayloadRequest },\n) => Promise<string> | string\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 /**\n * Collections to enable the plugin for.\n *\n * Each entry may be a bare collection slug or an object with a `slug` and an\n * optional `mimeTypes` array restricting which MIME types are tracked,\n * validated, and generated. Bare slugs default to `['image/*']`.\n *\n * @example\n * ```typescript\n * collections: [\n * 'images', // shorthand — defaults to ['image/*']\n * { slug: 'media', mimeTypes: ['image/*', 'application/pdf'] },\n * ]\n * ```\n */\n collections: IncomingCollectionsConfig\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 * Builds the image URL sent to the resolver. See {@link GetImageThumbnail}.\n *\n * @remarks\n * - Prefer a thumbnail/preview size over the original (e.g. from the sizes field)\n * - When the URL transcodes, declare the delivered format via\n * `imageThumbnailMimeType` so source formats the resolver does not accept are\n * not rejected\n */\n getImageThumbnail: GetImageThumbnail\n\n /**\n * Controls the alt text health feature (REST endpoint, cache revalidation hooks, and dashboard widget).\n *\n * - `false` disables the entire feature.\n * - `true` enables it, gated by `access
|
|
1
|
+
{"version":3,"sources":["../../src/types/AltTextPluginConfig.ts"],"sourcesContent":["import type { CollectionSlug, Field, PayloadRequest, Where } from 'payload'\n\nimport type { AltTextResolver } from '../resolvers/types.js'\nimport type {\n AltTextCollectionConfig,\n IncomingCollectionsConfig,\n NormalizedAltTextCollectionConfig,\n} from '../utilities/mimeTypes.js'\n\nexport type { AltTextCollectionConfig, NormalizedAltTextCollectionConfig }\n\n/**\n * Builds the thumbnail URL the resolver fetches. Must be publicly reachable.\n *\n * May be async, so the URL can be signed on demand (S3 presigning, short-lived\n * CDN tokens).\n *\n * @param doc The upload document to build the URL for.\n * @param args.collection The slug of the collection `doc` belongs to — use it to\n * build different URLs per collection (e.g. a Cloudinary transformation for one\n * collection and a plain S3 URL for another).\n * @param args.req The request the generation runs under.\n */\nexport type GetImageThumbnail = (\n doc: Record<string, unknown>,\n args: { collection: CollectionSlug; req: PayloadRequest },\n) => Promise<string> | string\n\n/**\n * Narrows the health scan of one collection to a subset of its documents — in a\n * multi-tenant CMS, to the tenant the request is for. The returned constraint is\n * ANDed onto the scan's MIME type filter.\n *\n * Called once per configured collection, so collections that do not carry the\n * constraining field (a media library shared across tenants, say) can return `{}`\n * instead of being queried for a field they do not have.\n *\n * Return `{}` to scan the collection whole.\n *\n * @param args.collection The slug of the collection being scanned.\n * @param args.req The request the scan runs for.\n */\nexport type AltTextHealthBaseFilter = (args: {\n collection: CollectionSlug\n req: PayloadRequest\n}) => Promise<Where> | Where\n\n/**\n * Narrows the locales a request generates for and is measured against — in a\n * multi-tenant CMS, to the locales of the tenant the request is for.\n *\n * Must return a non-empty subset of `locales`; anything else ends the operation\n * with an error rather than writing into a locale the project does not define.\n *\n * @param args.locales The locales configured on the Payload config.\n * @param args.req The request being served.\n */\nexport type FilterLocales = (args: {\n locales: string[]\n req: PayloadRequest\n}) => Promise<string[]> | string[]\n\n/** Configuration of the alt text health feature. */\nexport type AltTextHealthCheckConfig = {\n /**\n * Access control for the health report — both the REST endpoint and the dashboard\n * widget, which hides itself when this denies.\n *\n * Use it to restrict the collection-wide report more strictly than the\n * per-document generate endpoints (e.g. to admins).\n *\n * @default the plugin's `access`\n */\n access?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\n /**\n * Narrows what the report counts. See {@link AltTextHealthBaseFilter}.\n *\n * This is not access control: it scopes the aggregate, it does not decide who\n * may see it. Use `access` for that, and note the report is always filtered to\n * the collections the requesting user can read.\n */\n baseFilter?: AltTextHealthBaseFilter\n}\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 /**\n * Collections to enable the plugin for.\n *\n * Each entry may be a bare collection slug or an object with a `slug` and an\n * optional `mimeTypes` array restricting which MIME types are tracked,\n * validated, and generated. Bare slugs default to `['image/*']`.\n *\n * @example\n * ```typescript\n * collections: [\n * 'images', // shorthand — defaults to ['image/*']\n * { slug: 'media', mimeTypes: ['image/*', 'application/pdf'] },\n * ]\n * ```\n */\n collections: IncomingCollectionsConfig\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 * Narrows the locales this request targets. See {@link FilterLocales}.\n *\n * Governs bulk generation, the generate endpoint's locale validation, and the\n * health report.\n */\n filterLocales?: FilterLocales\n\n /**\n * Builds the image URL sent to the resolver. See {@link GetImageThumbnail}.\n *\n * @remarks\n * - Prefer a thumbnail/preview size over the original (e.g. from the sizes field)\n * - When the URL transcodes, declare the delivered format via\n * `imageThumbnailMimeType` so source formats the resolver does not accept are\n * not rejected\n */\n getImageThumbnail: GetImageThumbnail\n\n /**\n * Controls the alt text health feature (REST endpoint, cache revalidation hooks, and dashboard widget).\n *\n * - `false` disables the entire feature.\n * - `true` enables it, gated by `access` and covering every document.\n * - An object enables it and configures it. See {@link AltTextHealthCheckConfig}.\n *\n * @default true\n */\n healthCheck?: AltTextHealthCheckConfig | boolean\n\n /**\n * The MIME type `getImageThumbnail` delivers, for every configured collection.\n *\n * Declaring it takes a document's stored `mimeType` out of the decision of\n * whether alt text can be generated. Collections may override it or opt out with\n * `null` — see {@link AltTextCollectionConfig.imageThumbnailMimeType} for the\n * rationale and the `f_auto` caveat.\n *\n * @example 'image/webp'\n */\n imageThumbnailMimeType?: 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 /**\n * Maximum number of image IDs accepted in a single bulk generate request.\n * Requests exceeding this are rejected with `400`. Duplicate IDs are collapsed\n * before the limit is applied, so each image counts once.\n *\n * Raise it for large libraries that need to process more images per request.\n *\n * @default 100\n */\n maxBulkGenerateIds?: 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 /**\n * Collections with resolved MIME type filters and resolved delivered thumbnail\n * MIME types. The plugin-level `imageThumbnailMimeType` is folded into these\n * entries during normalization, so this is the only place to read it from.\n */\n collections: NormalizedAltTextCollectionConfig[]\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 /** Narrows the locales one request targets. See {@link FilterLocales}. */\n filterLocales?: FilterLocales\n\n /** Function to get the thumbnail URL of an image document. */\n getImageThumbnail: GetImageThumbnail\n\n /** Whether alt text health tracking is enabled. */\n healthCheck: boolean\n\n /** Access control for the health endpoint. Defaults to `access`. */\n healthCheckAccess: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\n /** Narrows what the health report counts. See {@link AltTextHealthBaseFilter}. */\n healthCheckBaseFilter?: AltTextHealthBaseFilter\n\n /** The locale to generate alt texts in when localization is disabled. */\n locale?: string\n\n /** The locales configured on the Payload config. Empty when localization is disabled. */\n locales: string[]\n\n /** Maximum number of concurrent API requests for bulk generate operations. */\n maxBulkGenerateConcurrency: number\n\n /** Maximum number of image IDs accepted per bulk generate request. */\n maxBulkGenerateIds: number\n\n /** The resolver to use for generating alt text */\n resolver: AltTextResolver\n}\n"],"names":[],"mappings":"AA8LA,2EAA2E,GAC3E,WA8CC"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import type { PayloadRequest } from 'payload';
|
|
2
|
+
import type { AltTextHealthCacheFactory } from './altTextHealthCache.js';
|
|
2
3
|
export declare const ALT_TEXT_HEALTH_PLUGIN_SLUG = "alt-text";
|
|
3
4
|
export declare const ALT_TEXT_HEALTH_CACHE_TTL = 3600;
|
|
4
5
|
export declare const ALT_TEXT_HEALTH_GLOBAL_TAG = "alt-text-health";
|
|
5
|
-
export type AltTextHealthErrorCode = 'ALT_TEXT_COLLECTION_READ_FAILED' | 'ALT_TEXT_PLUGIN_CONFIG_MISSING';
|
|
6
|
+
export type AltTextHealthErrorCode = 'ALT_TEXT_BASE_FILTER_FAILED' | 'ALT_TEXT_COLLECTION_READ_FAILED' | 'ALT_TEXT_LOCALES_FILTER_FAILED' | 'ALT_TEXT_PLUGIN_CONFIG_MISSING';
|
|
6
7
|
export type AltTextHealthError = {
|
|
7
8
|
code: AltTextHealthErrorCode;
|
|
8
9
|
collection?: string;
|
|
@@ -33,6 +34,7 @@ export type AltTextHealthWidgetData = {
|
|
|
33
34
|
totalDocs: number;
|
|
34
35
|
};
|
|
35
36
|
export declare const getAltTextHealthCollectionTag: (collectionSlug: string) => string;
|
|
37
|
+
export declare function getAltTextHealthScan(req: PayloadRequest, cacheFactory?: AltTextHealthCacheFactory<AltTextHealthScan>): Promise<AltTextHealthScan>;
|
|
36
38
|
/**
|
|
37
39
|
* Filters a shared, elevated-access health scan down to the collections the
|
|
38
40
|
* requesting user may read. The scan is computed once with `overrideAccess: true`
|
|
@@ -2,6 +2,8 @@ import { unstable_cache } from 'next/cache.js';
|
|
|
2
2
|
import { createCachedAltTextHealthScan } from './altTextHealthCache.js';
|
|
3
3
|
import { localesFromConfig } from './localesFromConfig.js';
|
|
4
4
|
import { buildMimeTypeWhere } from './mimeTypes.js';
|
|
5
|
+
import { configuredLocales, resolveLocales } from './resolveLocales.js';
|
|
6
|
+
import { stableStringify } from './stableStringify.js';
|
|
5
7
|
import { summarizeCollection } from './summarizeCollection.js';
|
|
6
8
|
export const ALT_TEXT_HEALTH_PLUGIN_SLUG = 'alt-text';
|
|
7
9
|
export const ALT_TEXT_HEALTH_CACHE_TTL = 3600;
|
|
@@ -22,11 +24,20 @@ const createCollectionReadError = (collection, message)=>({
|
|
|
22
24
|
operation: 'find'
|
|
23
25
|
});
|
|
24
26
|
const PAGE_SIZE = 500;
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
27
|
+
const isEmptyWhere = (where)=>!where || Object.keys(where).length === 0;
|
|
28
|
+
async function fetchAllDocs(payload, collection, isLocalized, mimeTypes, baseFilter) {
|
|
29
|
+
const mimeTypeWhere = buildMimeTypeWhere(mimeTypes);
|
|
30
|
+
if (!mimeTypeWhere) {
|
|
28
31
|
return [];
|
|
29
32
|
}
|
|
33
|
+
// The scan runs with `overrideAccess: true`, so a narrowing constraint has to be
|
|
34
|
+
// part of the query itself — this is what keeps the aggregate within one tenant.
|
|
35
|
+
const where = isEmptyWhere(baseFilter) ? mimeTypeWhere : {
|
|
36
|
+
and: [
|
|
37
|
+
mimeTypeWhere,
|
|
38
|
+
baseFilter
|
|
39
|
+
]
|
|
40
|
+
};
|
|
30
41
|
const docs = [];
|
|
31
42
|
let page = 1;
|
|
32
43
|
let hasMore = true;
|
|
@@ -55,10 +66,10 @@ async function fetchAllDocs(payload, collection, isLocalized, mimeTypes) {
|
|
|
55
66
|
}
|
|
56
67
|
return docs;
|
|
57
68
|
}
|
|
58
|
-
async function computeAltTextHealthScan({ collections, isLocalized, localeCodes, payload }) {
|
|
69
|
+
async function computeAltTextHealthScan({ baseFilters, collections, isLocalized, localeCodes, payload }) {
|
|
59
70
|
const collectionSummaries = await Promise.all(collections.map(async ({ slug, mimeTypes })=>{
|
|
60
71
|
try {
|
|
61
|
-
const docs = await fetchAllDocs(payload, slug, isLocalized, mimeTypes);
|
|
72
|
+
const docs = await fetchAllDocs(payload, slug, isLocalized, mimeTypes, baseFilters[slug]);
|
|
62
73
|
return summarizeCollection({
|
|
63
74
|
collection: slug,
|
|
64
75
|
docs,
|
|
@@ -96,12 +107,50 @@ async function computeAltTextHealthScan({ collections, isLocalized, localeCodes,
|
|
|
96
107
|
};
|
|
97
108
|
}
|
|
98
109
|
export const getAltTextHealthCollectionTag = (collectionSlug)=>`${ALT_TEXT_HEALTH_GLOBAL_TAG}:${collectionSlug}`;
|
|
99
|
-
|
|
110
|
+
/**
|
|
111
|
+
* Resolves the configured base filter for every scanned collection.
|
|
112
|
+
*
|
|
113
|
+
* A throwing filter (a tenant cookie pointing at a deleted tenant, say) must not
|
|
114
|
+
* take the dashboard down, and must never fall back to an unfiltered scan — so it
|
|
115
|
+
* ends the scan with an error the widget and the endpoint report. The error carries
|
|
116
|
+
* the slug in its message rather than in `collection`, so it survives the read-access
|
|
117
|
+
* filter that drops errors for collections the caller cannot read.
|
|
118
|
+
*/ async function resolveBaseFilters(req, collections, baseFilter) {
|
|
119
|
+
const baseFilters = {};
|
|
120
|
+
if (!baseFilter) {
|
|
121
|
+
return {
|
|
122
|
+
baseFilters
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
for (const { slug } of collections){
|
|
126
|
+
try {
|
|
127
|
+
baseFilters[slug] = await baseFilter({
|
|
128
|
+
collection: slug,
|
|
129
|
+
req
|
|
130
|
+
});
|
|
131
|
+
} catch (error) {
|
|
132
|
+
const message = error instanceof Error ? error.message : 'Unknown error';
|
|
133
|
+
req.payload.logger.error({
|
|
134
|
+
collection: slug,
|
|
135
|
+
err: error,
|
|
136
|
+
msg: 'Alt text health check failed while resolving the base filter.',
|
|
137
|
+
plugin: ALT_TEXT_HEALTH_PLUGIN_SLUG
|
|
138
|
+
});
|
|
139
|
+
return {
|
|
140
|
+
error: {
|
|
141
|
+
code: 'ALT_TEXT_BASE_FILTER_FAILED',
|
|
142
|
+
message: `Failed to resolve the alt text health base filter for the "${slug}" collection: ${message}`
|
|
143
|
+
}
|
|
144
|
+
};
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
return {
|
|
148
|
+
baseFilters
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
export async function getAltTextHealthScan(req, cacheFactory = unstable_cache) {
|
|
100
152
|
const { payload } = req;
|
|
101
153
|
const pluginConfig = payload.config.custom?.altTextPluginConfig;
|
|
102
|
-
const localeCodes = localesFromConfig(payload.config) ?? (pluginConfig?.locale ? [
|
|
103
|
-
pluginConfig.locale
|
|
104
|
-
] : []);
|
|
105
154
|
const isLocalized = Boolean(payload.config.localization);
|
|
106
155
|
if (!pluginConfig) {
|
|
107
156
|
return createUnknownScan({
|
|
@@ -110,10 +159,46 @@ async function getAltTextHealthScan(req) {
|
|
|
110
159
|
message: 'Alt text plugin config not found'
|
|
111
160
|
},
|
|
112
161
|
isLocalized,
|
|
113
|
-
localeCodes
|
|
162
|
+
localeCodes: localesFromConfig(payload.config) ?? []
|
|
114
163
|
});
|
|
115
164
|
}
|
|
165
|
+
const configured = configuredLocales(pluginConfig);
|
|
166
|
+
// Measuring a tenant against locales it does not serve leaves it permanently
|
|
167
|
+
// partial, in a way no editor of that tenant can fix.
|
|
168
|
+
let localeCodes = configured;
|
|
169
|
+
if (pluginConfig.filterLocales) {
|
|
170
|
+
try {
|
|
171
|
+
localeCodes = await resolveLocales({
|
|
172
|
+
pluginConfig,
|
|
173
|
+
req
|
|
174
|
+
});
|
|
175
|
+
} catch (error) {
|
|
176
|
+
const message = error instanceof Error ? error.message : 'Unknown error';
|
|
177
|
+
payload.logger.error({
|
|
178
|
+
err: error,
|
|
179
|
+
msg: 'Alt text health check failed while resolving the locales to report on.',
|
|
180
|
+
plugin: ALT_TEXT_HEALTH_PLUGIN_SLUG
|
|
181
|
+
});
|
|
182
|
+
return createUnknownScan({
|
|
183
|
+
error: {
|
|
184
|
+
code: 'ALT_TEXT_LOCALES_FILTER_FAILED',
|
|
185
|
+
message: `Failed to resolve the alt text health locales: ${message}`
|
|
186
|
+
},
|
|
187
|
+
isLocalized,
|
|
188
|
+
localeCodes: configured
|
|
189
|
+
});
|
|
190
|
+
}
|
|
191
|
+
}
|
|
116
192
|
const collections = pluginConfig.collections;
|
|
193
|
+
const resolved = await resolveBaseFilters(req, collections, pluginConfig.healthCheckBaseFilter);
|
|
194
|
+
if ('error' in resolved) {
|
|
195
|
+
return createUnknownScan({
|
|
196
|
+
error: resolved.error,
|
|
197
|
+
isLocalized,
|
|
198
|
+
localeCodes
|
|
199
|
+
});
|
|
200
|
+
}
|
|
201
|
+
const { baseFilters } = resolved;
|
|
117
202
|
const cacheKeyParts = [
|
|
118
203
|
ALT_TEXT_HEALTH_GLOBAL_TAG,
|
|
119
204
|
[
|
|
@@ -121,16 +206,22 @@ async function getAltTextHealthScan(req) {
|
|
|
121
206
|
].map(({ slug, mimeTypes })=>`${slug}:${[
|
|
122
207
|
...mimeTypes
|
|
123
208
|
].sort().join('|')}`).sort().join(','),
|
|
124
|
-
localeCodes.join(',')
|
|
209
|
+
localeCodes.join(','),
|
|
210
|
+
// The scan is shared across requests, so a scoped scan needs a scoped cache
|
|
211
|
+
// entry. Deriving the key from the resolved filters — rather than taking one
|
|
212
|
+
// from the caller — makes it impossible to narrow the scan without also
|
|
213
|
+
// narrowing its cache, which would serve one tenant's counts to another.
|
|
214
|
+
`filter:${stableStringify(baseFilters)}`
|
|
125
215
|
];
|
|
126
216
|
const tags = [
|
|
127
217
|
ALT_TEXT_HEALTH_GLOBAL_TAG,
|
|
128
218
|
...new Set(collections.map(({ slug })=>getAltTextHealthCollectionTag(slug)))
|
|
129
219
|
];
|
|
130
220
|
const getCachedHealthScan = createCachedAltTextHealthScan({
|
|
131
|
-
cacheFactory
|
|
221
|
+
cacheFactory,
|
|
132
222
|
cacheKeyParts,
|
|
133
223
|
compute: async ()=>computeAltTextHealthScan({
|
|
224
|
+
baseFilters,
|
|
134
225
|
collections,
|
|
135
226
|
isLocalized,
|
|
136
227
|
localeCodes,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/utilities/altTextHealth.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\n\nimport { unstable_cache } from 'next/cache.js'\n\nimport type {\n AltTextPluginConfig,\n NormalizedAltTextCollectionConfig,\n} from '../types/AltTextPluginConfig.js'\n\nimport { createCachedAltTextHealthScan } from './altTextHealthCache.js'\nimport { localesFromConfig } from './localesFromConfig.js'\nimport { buildMimeTypeWhere } from './mimeTypes.js'\nimport { summarizeCollection } from './summarizeCollection.js'\n\nexport const ALT_TEXT_HEALTH_PLUGIN_SLUG = 'alt-text'\nexport const ALT_TEXT_HEALTH_CACHE_TTL = 3600\nexport const ALT_TEXT_HEALTH_GLOBAL_TAG = 'alt-text-health'\n\nexport type AltTextHealthErrorCode =\n 'ALT_TEXT_COLLECTION_READ_FAILED' | 'ALT_TEXT_PLUGIN_CONFIG_MISSING'\n\nexport type AltTextHealthError = {\n code: AltTextHealthErrorCode\n collection?: string\n message: string\n operation?: 'find'\n}\n\nexport type AltTextHealthScanCollection = {\n collection: string\n completeDocs: number\n error?: AltTextHealthError\n invalidDocIds: (number | string)[] | undefined\n missingDocs: number\n partialDocs: number\n totalDocs: number\n}\n\nexport type AltTextHealthScan = {\n checkedAt: string\n collections: AltTextHealthScanCollection[]\n errors: AltTextHealthError[]\n isLocalized: boolean\n localeCodes: string[]\n}\n\nexport type AltTextHealthWidgetData = {\n collections: AltTextHealthScanCollection[]\n errors: AltTextHealthError[]\n isLocalized: boolean\n localeCount: number\n totalDocs: number\n}\n\ntype AltTextHealthComputationArgs = {\n collections: NormalizedAltTextCollectionConfig[]\n isLocalized: boolean\n localeCodes: string[]\n payload: Payload\n}\n\nconst createUnknownScan = ({\n error,\n isLocalized,\n localeCodes,\n}: {\n error: AltTextHealthScan['errors'][number]\n isLocalized: boolean\n localeCodes: string[]\n}): AltTextHealthScan => ({\n checkedAt: new Date().toISOString(),\n collections: [],\n errors: [error],\n isLocalized,\n localeCodes,\n})\n\nconst createCollectionReadError = (collection: string, message: string) => ({\n code: 'ALT_TEXT_COLLECTION_READ_FAILED' as const,\n collection,\n message,\n operation: 'find' as const,\n})\n\nconst PAGE_SIZE = 500\n\nasync function fetchAllDocs(\n payload: Payload,\n collection: string,\n isLocalized: boolean,\n mimeTypes: readonly string[],\n): Promise<{ alt: unknown; id: number | string }[]> {\n const where = buildMimeTypeWhere(mimeTypes)\n if (!where) {\n return []\n }\n\n const docs: { alt: unknown; id: number | string }[] = []\n let page = 1\n let hasMore = true\n\n while (hasMore) {\n const result = await payload.find({\n collection,\n depth: 0,\n fallbackLocale: isLocalized ? false : undefined,\n limit: PAGE_SIZE,\n locale: isLocalized ? 'all' : undefined,\n overrideAccess: true,\n page,\n select: {\n alt: true,\n },\n where,\n })\n\n for (const doc of result.docs) {\n docs.push({\n id: doc.id,\n alt: 'alt' in doc ? doc.alt : undefined,\n })\n }\n\n hasMore = result.hasNextPage\n page++\n }\n\n return docs\n}\n\nasync function computeAltTextHealthScan({\n collections,\n isLocalized,\n localeCodes,\n payload,\n}: AltTextHealthComputationArgs): Promise<AltTextHealthScan> {\n const collectionSummaries = await Promise.all(\n collections.map(async ({ slug, mimeTypes }): Promise<AltTextHealthScanCollection> => {\n try {\n const docs = await fetchAllDocs(payload, slug, isLocalized, mimeTypes)\n\n return summarizeCollection({\n collection: slug,\n docs,\n isLocalized,\n localeCodes,\n })\n } catch (error) {\n const message = error instanceof Error ? error.message : 'Unknown error'\n const collectionError = createCollectionReadError(slug, message)\n\n payload.logger.error({\n collection: slug,\n err: error,\n msg: 'Alt text health check failed while reading a collection.',\n operation: 'find',\n plugin: ALT_TEXT_HEALTH_PLUGIN_SLUG,\n })\n\n return {\n collection: slug,\n completeDocs: 0,\n error: collectionError,\n invalidDocIds: undefined,\n missingDocs: 0,\n partialDocs: 0,\n totalDocs: 0,\n }\n }\n }),\n )\n\n const errors = collectionSummaries\n .filter((summary) => summary.error)\n .map((summary) => summary.error!)\n\n return {\n checkedAt: new Date().toISOString(),\n collections: collectionSummaries,\n errors,\n isLocalized,\n localeCodes,\n }\n}\n\nexport const getAltTextHealthCollectionTag = (collectionSlug: string): string =>\n `${ALT_TEXT_HEALTH_GLOBAL_TAG}:${collectionSlug}`\n\nasync function getAltTextHealthScan(req: PayloadRequest): Promise<AltTextHealthScan> {\n const { payload } = req\n const pluginConfig = payload.config.custom?.altTextPluginConfig as AltTextPluginConfig | undefined\n const localeCodes =\n localesFromConfig(payload.config) ?? (pluginConfig?.locale ? [pluginConfig.locale] : [])\n const isLocalized = Boolean(payload.config.localization)\n\n if (!pluginConfig) {\n return createUnknownScan({\n error: {\n code: 'ALT_TEXT_PLUGIN_CONFIG_MISSING',\n message: 'Alt text plugin config not found',\n },\n isLocalized,\n localeCodes,\n })\n }\n\n const collections = pluginConfig.collections\n\n const cacheKeyParts = [\n ALT_TEXT_HEALTH_GLOBAL_TAG,\n [...collections]\n .map(({ slug, mimeTypes }) => `${slug}:${[...mimeTypes].sort().join('|')}`)\n .sort()\n .join(','),\n localeCodes.join(','),\n ]\n\n const tags = [\n ALT_TEXT_HEALTH_GLOBAL_TAG,\n ...new Set(collections.map(({ slug }) => getAltTextHealthCollectionTag(slug))),\n ]\n\n const getCachedHealthScan = createCachedAltTextHealthScan({\n cacheFactory: unstable_cache,\n cacheKeyParts,\n compute: async () =>\n computeAltTextHealthScan({\n collections,\n isLocalized,\n localeCodes,\n payload,\n }),\n revalidate: ALT_TEXT_HEALTH_CACHE_TTL,\n tags,\n })\n\n return getCachedHealthScan()\n}\n\n/**\n * Whether `req.user` is allowed to read the given collection at the collection\n * level. The collection's `read` access is evaluated with the request; `false`\n * denies, while `true` or a scoped `Where` constraint grants visibility of the\n * collection's health aggregate. A thrown access function (e.g. `Forbidden`)\n * counts as denied so a restricted collection never leaks.\n */\nasync function userCanReadCollection(req: PayloadRequest, slug: string): Promise<boolean> {\n const readAccess = req.payload.collections?.[slug]?.config.access?.read\n\n if (typeof readAccess !== 'function') {\n return true\n }\n\n try {\n return (await readAccess({ req })) !== false\n } catch {\n return false\n }\n}\n\n/**\n * Filters a shared, elevated-access health scan down to the collections the\n * requesting user may read. The scan is computed once with `overrideAccess: true`\n * so it stays complete and cacheable; access is applied per request at\n * collection granularity, matching the aggregate's altitude.\n */\nexport async function filterScanByReadAccess(\n req: PayloadRequest,\n scan: AltTextHealthScan,\n): Promise<AltTextHealthScan> {\n const visibility = await Promise.all(\n scan.collections.map((collection) => userCanReadCollection(req, collection.collection)),\n )\n\n const collections = scan.collections.filter((_, index) => visibility[index])\n const allowedSlugs = new Set(collections.map((collection) => collection.collection))\n const errors = scan.errors.filter(\n (error) => !error.collection || allowedSlugs.has(error.collection),\n )\n\n return { ...scan, collections, errors }\n}\n\n/**\n * Whether the requesting user may view the health report at all, per the\n * configured `healthCheck` access gate. The dashboard widget uses this to hide\n * itself, mirroring the gate enforced on the health endpoint.\n */\nexport async function canViewHealthReport(req: PayloadRequest): Promise<boolean> {\n const pluginConfig = req.payload.config.custom?.altTextPluginConfig as\n AltTextPluginConfig | undefined\n\n if (!pluginConfig) {\n return false\n }\n\n return pluginConfig.healthCheckAccess({ req })\n}\n\nexport function toWidgetData(scan: AltTextHealthScan): AltTextHealthWidgetData {\n return {\n collections: scan.collections,\n errors: scan.errors,\n isLocalized: scan.isLocalized,\n localeCount: scan.localeCodes.length,\n totalDocs: scan.collections.reduce((total, c) => total + c.totalDocs, 0),\n }\n}\n\nexport async function getAltTextHealth(req: PayloadRequest): Promise<AltTextHealthScan> {\n return filterScanByReadAccess(req, await getAltTextHealthScan(req))\n}\n\nexport async function getAltTextHealthWidgetData(\n req: PayloadRequest,\n): Promise<AltTextHealthWidgetData> {\n return toWidgetData(await filterScanByReadAccess(req, await getAltTextHealthScan(req)))\n}\n"],"names":["unstable_cache","createCachedAltTextHealthScan","localesFromConfig","buildMimeTypeWhere","summarizeCollection","ALT_TEXT_HEALTH_PLUGIN_SLUG","ALT_TEXT_HEALTH_CACHE_TTL","ALT_TEXT_HEALTH_GLOBAL_TAG","createUnknownScan","error","isLocalized","localeCodes","checkedAt","Date","toISOString","collections","errors","createCollectionReadError","collection","message","code","operation","PAGE_SIZE","fetchAllDocs","payload","mimeTypes","where","docs","page","hasMore","result","find","depth","fallbackLocale","undefined","limit","locale","overrideAccess","select","alt","doc","push","id","hasNextPage","computeAltTextHealthScan","collectionSummaries","Promise","all","map","slug","Error","collectionError","logger","err","msg","plugin","completeDocs","invalidDocIds","missingDocs","partialDocs","totalDocs","filter","summary","getAltTextHealthCollectionTag","collectionSlug","getAltTextHealthScan","req","pluginConfig","config","custom","altTextPluginConfig","Boolean","localization","cacheKeyParts","sort","join","tags","Set","getCachedHealthScan","cacheFactory","compute","revalidate","userCanReadCollection","readAccess","access","read","filterScanByReadAccess","scan","visibility","_","index","allowedSlugs","has","canViewHealthReport","healthCheckAccess","toWidgetData","localeCount","length","reduce","total","c","getAltTextHealth","getAltTextHealthWidgetData"],"mappings":"AAEA,SAASA,cAAc,QAAQ,gBAAe;AAO9C,SAASC,6BAA6B,QAAQ,0BAAyB;AACvE,SAASC,iBAAiB,QAAQ,yBAAwB;AAC1D,SAASC,kBAAkB,QAAQ,iBAAgB;AACnD,SAASC,mBAAmB,QAAQ,2BAA0B;AAE9D,OAAO,MAAMC,8BAA8B,WAAU;AACrD,OAAO,MAAMC,4BAA4B,KAAI;AAC7C,OAAO,MAAMC,6BAA6B,kBAAiB;AA6C3D,MAAMC,oBAAoB,CAAC,EACzBC,KAAK,EACLC,WAAW,EACXC,WAAW,EAKZ,GAAyB,CAAA;QACxBC,WAAW,IAAIC,OAAOC,WAAW;QACjCC,aAAa,EAAE;QACfC,QAAQ;YAACP;SAAM;QACfC;QACAC;IACF,CAAA;AAEA,MAAMM,4BAA4B,CAACC,YAAoBC,UAAqB,CAAA;QAC1EC,MAAM;QACNF;QACAC;QACAE,WAAW;IACb,CAAA;AAEA,MAAMC,YAAY;AAElB,eAAeC,aACbC,OAAgB,EAChBN,UAAkB,EAClBR,WAAoB,EACpBe,SAA4B;IAE5B,MAAMC,QAAQvB,mBAAmBsB;IACjC,IAAI,CAACC,OAAO;QACV,OAAO,EAAE;IACX;IAEA,MAAMC,OAAgD,EAAE;IACxD,IAAIC,OAAO;IACX,IAAIC,UAAU;IAEd,MAAOA,QAAS;QACd,MAAMC,SAAS,MAAMN,QAAQO,IAAI,CAAC;YAChCb;YACAc,OAAO;YACPC,gBAAgBvB,cAAc,QAAQwB;YACtCC,OAAOb;YACPc,QAAQ1B,cAAc,QAAQwB;YAC9BG,gBAAgB;YAChBT;YACAU,QAAQ;gBACNC,KAAK;YACP;YACAb;QACF;QAEA,KAAK,MAAMc,OAAOV,OAAOH,IAAI,CAAE;YAC7BA,KAAKc,IAAI,CAAC;gBACRC,IAAIF,IAAIE,EAAE;gBACVH,KAAK,SAASC,MAAMA,IAAID,GAAG,GAAGL;YAChC;QACF;QAEAL,UAAUC,OAAOa,WAAW;QAC5Bf;IACF;IAEA,OAAOD;AACT;AAEA,eAAeiB,yBAAyB,EACtC7B,WAAW,EACXL,WAAW,EACXC,WAAW,EACXa,OAAO,EACsB;IAC7B,MAAMqB,sBAAsB,MAAMC,QAAQC,GAAG,CAC3ChC,YAAYiC,GAAG,CAAC,OAAO,EAAEC,IAAI,EAAExB,SAAS,EAAE;QACxC,IAAI;YACF,MAAME,OAAO,MAAMJ,aAAaC,SAASyB,MAAMvC,aAAae;YAE5D,OAAOrB,oBAAoB;gBACzBc,YAAY+B;gBACZtB;gBACAjB;gBACAC;YACF;QACF,EAAE,OAAOF,OAAO;YACd,MAAMU,UAAUV,iBAAiByC,QAAQzC,MAAMU,OAAO,GAAG;YACzD,MAAMgC,kBAAkBlC,0BAA0BgC,MAAM9B;YAExDK,QAAQ4B,MAAM,CAAC3C,KAAK,CAAC;gBACnBS,YAAY+B;gBACZI,KAAK5C;gBACL6C,KAAK;gBACLjC,WAAW;gBACXkC,QAAQlD;YACV;YAEA,OAAO;gBACLa,YAAY+B;gBACZO,cAAc;gBACd/C,OAAO0C;gBACPM,eAAevB;gBACfwB,aAAa;gBACbC,aAAa;gBACbC,WAAW;YACb;QACF;IACF;IAGF,MAAM5C,SAAS6B,oBACZgB,MAAM,CAAC,CAACC,UAAYA,QAAQrD,KAAK,EACjCuC,GAAG,CAAC,CAACc,UAAYA,QAAQrD,KAAK;IAEjC,OAAO;QACLG,WAAW,IAAIC,OAAOC,WAAW;QACjCC,aAAa8B;QACb7B;QACAN;QACAC;IACF;AACF;AAEA,OAAO,MAAMoD,gCAAgC,CAACC,iBAC5C,GAAGzD,2BAA2B,CAAC,EAAEyD,gBAAgB,CAAA;AAEnD,eAAeC,qBAAqBC,GAAmB;IACrD,MAAM,EAAE1C,OAAO,EAAE,GAAG0C;IACpB,MAAMC,eAAe3C,QAAQ4C,MAAM,CAACC,MAAM,EAAEC;IAC5C,MAAM3D,cACJT,kBAAkBsB,QAAQ4C,MAAM,KAAMD,CAAAA,cAAc/B,SAAS;QAAC+B,aAAa/B,MAAM;KAAC,GAAG,EAAE,AAAD;IACxF,MAAM1B,cAAc6D,QAAQ/C,QAAQ4C,MAAM,CAACI,YAAY;IAEvD,IAAI,CAACL,cAAc;QACjB,OAAO3D,kBAAkB;YACvBC,OAAO;gBACLW,MAAM;gBACND,SAAS;YACX;YACAT;YACAC;QACF;IACF;IAEA,MAAMI,cAAcoD,aAAapD,WAAW;IAE5C,MAAM0D,gBAAgB;QACpBlE;QACA;eAAIQ;SAAY,CACbiC,GAAG,CAAC,CAAC,EAAEC,IAAI,EAAExB,SAAS,EAAE,GAAK,GAAGwB,KAAK,CAAC,EAAE;mBAAIxB;aAAU,CAACiD,IAAI,GAAGC,IAAI,CAAC,MAAM,EACzED,IAAI,GACJC,IAAI,CAAC;QACRhE,YAAYgE,IAAI,CAAC;KAClB;IAED,MAAMC,OAAO;QACXrE;WACG,IAAIsE,IAAI9D,YAAYiC,GAAG,CAAC,CAAC,EAAEC,IAAI,EAAE,GAAKc,8BAA8Bd;KACxE;IAED,MAAM6B,sBAAsB7E,8BAA8B;QACxD8E,cAAc/E;QACdyE;QACAO,SAAS,UACPpC,yBAAyB;gBACvB7B;gBACAL;gBACAC;gBACAa;YACF;QACFyD,YAAY3E;QACZsE;IACF;IAEA,OAAOE;AACT;AAEA;;;;;;CAMC,GACD,eAAeI,sBAAsBhB,GAAmB,EAAEjB,IAAY;IACpE,MAAMkC,aAAajB,IAAI1C,OAAO,CAACT,WAAW,EAAE,CAACkC,KAAK,EAAEmB,OAAOgB,QAAQC;IAEnE,IAAI,OAAOF,eAAe,YAAY;QACpC,OAAO;IACT;IAEA,IAAI;QACF,OAAO,AAAC,MAAMA,WAAW;YAAEjB;QAAI,OAAQ;IACzC,EAAE,OAAM;QACN,OAAO;IACT;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAeoB,uBACpBpB,GAAmB,EACnBqB,IAAuB;IAEvB,MAAMC,aAAa,MAAM1C,QAAQC,GAAG,CAClCwC,KAAKxE,WAAW,CAACiC,GAAG,CAAC,CAAC9B,aAAegE,sBAAsBhB,KAAKhD,WAAWA,UAAU;IAGvF,MAAMH,cAAcwE,KAAKxE,WAAW,CAAC8C,MAAM,CAAC,CAAC4B,GAAGC,QAAUF,UAAU,CAACE,MAAM;IAC3E,MAAMC,eAAe,IAAId,IAAI9D,YAAYiC,GAAG,CAAC,CAAC9B,aAAeA,WAAWA,UAAU;IAClF,MAAMF,SAASuE,KAAKvE,MAAM,CAAC6C,MAAM,CAC/B,CAACpD,QAAU,CAACA,MAAMS,UAAU,IAAIyE,aAAaC,GAAG,CAACnF,MAAMS,UAAU;IAGnE,OAAO;QAAE,GAAGqE,IAAI;QAAExE;QAAaC;IAAO;AACxC;AAEA;;;;CAIC,GACD,OAAO,eAAe6E,oBAAoB3B,GAAmB;IAC3D,MAAMC,eAAeD,IAAI1C,OAAO,CAAC4C,MAAM,CAACC,MAAM,EAAEC;IAGhD,IAAI,CAACH,cAAc;QACjB,OAAO;IACT;IAEA,OAAOA,aAAa2B,iBAAiB,CAAC;QAAE5B;IAAI;AAC9C;AAEA,OAAO,SAAS6B,aAAaR,IAAuB;IAClD,OAAO;QACLxE,aAAawE,KAAKxE,WAAW;QAC7BC,QAAQuE,KAAKvE,MAAM;QACnBN,aAAa6E,KAAK7E,WAAW;QAC7BsF,aAAaT,KAAK5E,WAAW,CAACsF,MAAM;QACpCrC,WAAW2B,KAAKxE,WAAW,CAACmF,MAAM,CAAC,CAACC,OAAOC,IAAMD,QAAQC,EAAExC,SAAS,EAAE;IACxE;AACF;AAEA,OAAO,eAAeyC,iBAAiBnC,GAAmB;IACxD,OAAOoB,uBAAuBpB,KAAK,MAAMD,qBAAqBC;AAChE;AAEA,OAAO,eAAeoC,2BACpBpC,GAAmB;IAEnB,OAAO6B,aAAa,MAAMT,uBAAuBpB,KAAK,MAAMD,qBAAqBC;AACnF"}
|
|
1
|
+
{"version":3,"sources":["../../src/utilities/altTextHealth.ts"],"sourcesContent":["import type { Payload, PayloadRequest, Where } from 'payload'\n\nimport { unstable_cache } from 'next/cache.js'\n\nimport type {\n AltTextPluginConfig,\n NormalizedAltTextCollectionConfig,\n} from '../types/AltTextPluginConfig.js'\nimport type { AltTextHealthCacheFactory } from './altTextHealthCache.js'\n\nimport { createCachedAltTextHealthScan } from './altTextHealthCache.js'\nimport { localesFromConfig } from './localesFromConfig.js'\nimport { buildMimeTypeWhere } from './mimeTypes.js'\nimport { configuredLocales, resolveLocales } from './resolveLocales.js'\nimport { stableStringify } from './stableStringify.js'\nimport { summarizeCollection } from './summarizeCollection.js'\n\nexport const ALT_TEXT_HEALTH_PLUGIN_SLUG = 'alt-text'\nexport const ALT_TEXT_HEALTH_CACHE_TTL = 3600\nexport const ALT_TEXT_HEALTH_GLOBAL_TAG = 'alt-text-health'\n\nexport type AltTextHealthErrorCode =\n | 'ALT_TEXT_BASE_FILTER_FAILED'\n | 'ALT_TEXT_COLLECTION_READ_FAILED'\n | 'ALT_TEXT_LOCALES_FILTER_FAILED'\n | 'ALT_TEXT_PLUGIN_CONFIG_MISSING'\n\nexport type AltTextHealthError = {\n code: AltTextHealthErrorCode\n collection?: string\n message: string\n operation?: 'find'\n}\n\nexport type AltTextHealthScanCollection = {\n collection: string\n completeDocs: number\n error?: AltTextHealthError\n invalidDocIds: (number | string)[] | undefined\n missingDocs: number\n partialDocs: number\n totalDocs: number\n}\n\nexport type AltTextHealthScan = {\n checkedAt: string\n collections: AltTextHealthScanCollection[]\n errors: AltTextHealthError[]\n isLocalized: boolean\n localeCodes: string[]\n}\n\nexport type AltTextHealthWidgetData = {\n collections: AltTextHealthScanCollection[]\n errors: AltTextHealthError[]\n isLocalized: boolean\n localeCount: number\n totalDocs: number\n}\n\ntype AltTextHealthComputationArgs = {\n /** The resolved base filter per collection slug, if one is configured. */\n baseFilters: Record<string, undefined | Where>\n collections: NormalizedAltTextCollectionConfig[]\n isLocalized: boolean\n localeCodes: string[]\n payload: Payload\n}\n\nconst createUnknownScan = ({\n error,\n isLocalized,\n localeCodes,\n}: {\n error: AltTextHealthScan['errors'][number]\n isLocalized: boolean\n localeCodes: string[]\n}): AltTextHealthScan => ({\n checkedAt: new Date().toISOString(),\n collections: [],\n errors: [error],\n isLocalized,\n localeCodes,\n})\n\nconst createCollectionReadError = (collection: string, message: string) => ({\n code: 'ALT_TEXT_COLLECTION_READ_FAILED' as const,\n collection,\n message,\n operation: 'find' as const,\n})\n\nconst PAGE_SIZE = 500\n\nconst isEmptyWhere = (where: undefined | Where): boolean =>\n !where || Object.keys(where).length === 0\n\nasync function fetchAllDocs(\n payload: Payload,\n collection: string,\n isLocalized: boolean,\n mimeTypes: readonly string[],\n baseFilter: undefined | Where,\n): Promise<{ alt: unknown; id: number | string }[]> {\n const mimeTypeWhere = buildMimeTypeWhere(mimeTypes)\n if (!mimeTypeWhere) {\n return []\n }\n\n // The scan runs with `overrideAccess: true`, so a narrowing constraint has to be\n // part of the query itself — this is what keeps the aggregate within one tenant.\n const where = isEmptyWhere(baseFilter) ? mimeTypeWhere : { and: [mimeTypeWhere, baseFilter!] }\n\n const docs: { alt: unknown; id: number | string }[] = []\n let page = 1\n let hasMore = true\n\n while (hasMore) {\n const result = await payload.find({\n collection,\n depth: 0,\n fallbackLocale: isLocalized ? false : undefined,\n limit: PAGE_SIZE,\n locale: isLocalized ? 'all' : undefined,\n overrideAccess: true,\n page,\n select: {\n alt: true,\n },\n where,\n })\n\n for (const doc of result.docs) {\n docs.push({\n id: doc.id,\n alt: 'alt' in doc ? doc.alt : undefined,\n })\n }\n\n hasMore = result.hasNextPage\n page++\n }\n\n return docs\n}\n\nasync function computeAltTextHealthScan({\n baseFilters,\n collections,\n isLocalized,\n localeCodes,\n payload,\n}: AltTextHealthComputationArgs): Promise<AltTextHealthScan> {\n const collectionSummaries = await Promise.all(\n collections.map(async ({ slug, mimeTypes }): Promise<AltTextHealthScanCollection> => {\n try {\n const docs = await fetchAllDocs(payload, slug, isLocalized, mimeTypes, baseFilters[slug])\n\n return summarizeCollection({\n collection: slug,\n docs,\n isLocalized,\n localeCodes,\n })\n } catch (error) {\n const message = error instanceof Error ? error.message : 'Unknown error'\n const collectionError = createCollectionReadError(slug, message)\n\n payload.logger.error({\n collection: slug,\n err: error,\n msg: 'Alt text health check failed while reading a collection.',\n operation: 'find',\n plugin: ALT_TEXT_HEALTH_PLUGIN_SLUG,\n })\n\n return {\n collection: slug,\n completeDocs: 0,\n error: collectionError,\n invalidDocIds: undefined,\n missingDocs: 0,\n partialDocs: 0,\n totalDocs: 0,\n }\n }\n }),\n )\n\n const errors = collectionSummaries\n .filter((summary) => summary.error)\n .map((summary) => summary.error!)\n\n return {\n checkedAt: new Date().toISOString(),\n collections: collectionSummaries,\n errors,\n isLocalized,\n localeCodes,\n }\n}\n\nexport const getAltTextHealthCollectionTag = (collectionSlug: string): string =>\n `${ALT_TEXT_HEALTH_GLOBAL_TAG}:${collectionSlug}`\n\n/**\n * Resolves the configured base filter for every scanned collection.\n *\n * A throwing filter (a tenant cookie pointing at a deleted tenant, say) must not\n * take the dashboard down, and must never fall back to an unfiltered scan — so it\n * ends the scan with an error the widget and the endpoint report. The error carries\n * the slug in its message rather than in `collection`, so it survives the read-access\n * filter that drops errors for collections the caller cannot read.\n */\nasync function resolveBaseFilters(\n req: PayloadRequest,\n collections: NormalizedAltTextCollectionConfig[],\n baseFilter: AltTextPluginConfig['healthCheckBaseFilter'],\n): Promise<{ baseFilters: Record<string, undefined | Where> } | { error: AltTextHealthError }> {\n const baseFilters: Record<string, undefined | Where> = {}\n\n if (!baseFilter) {\n return { baseFilters }\n }\n\n for (const { slug } of collections) {\n try {\n baseFilters[slug] = await baseFilter({ collection: slug, req })\n } catch (error) {\n const message = error instanceof Error ? error.message : 'Unknown error'\n\n req.payload.logger.error({\n collection: slug,\n err: error,\n msg: 'Alt text health check failed while resolving the base filter.',\n plugin: ALT_TEXT_HEALTH_PLUGIN_SLUG,\n })\n\n return {\n error: {\n code: 'ALT_TEXT_BASE_FILTER_FAILED',\n message: `Failed to resolve the alt text health base filter for the \"${slug}\" collection: ${message}`,\n },\n }\n }\n }\n\n return { baseFilters }\n}\n\nexport async function getAltTextHealthScan(\n req: PayloadRequest,\n cacheFactory: AltTextHealthCacheFactory<AltTextHealthScan> = unstable_cache,\n): Promise<AltTextHealthScan> {\n const { payload } = req\n const pluginConfig = payload.config.custom?.altTextPluginConfig as AltTextPluginConfig | undefined\n const isLocalized = Boolean(payload.config.localization)\n\n if (!pluginConfig) {\n return createUnknownScan({\n error: {\n code: 'ALT_TEXT_PLUGIN_CONFIG_MISSING',\n message: 'Alt text plugin config not found',\n },\n isLocalized,\n localeCodes: localesFromConfig(payload.config) ?? [],\n })\n }\n\n const configured = configuredLocales(pluginConfig)\n\n // Measuring a tenant against locales it does not serve leaves it permanently\n // partial, in a way no editor of that tenant can fix.\n let localeCodes = configured\n\n if (pluginConfig.filterLocales) {\n try {\n localeCodes = await resolveLocales({ pluginConfig, req })\n } catch (error) {\n const message = error instanceof Error ? error.message : 'Unknown error'\n\n payload.logger.error({\n err: error,\n msg: 'Alt text health check failed while resolving the locales to report on.',\n plugin: ALT_TEXT_HEALTH_PLUGIN_SLUG,\n })\n\n return createUnknownScan({\n error: {\n code: 'ALT_TEXT_LOCALES_FILTER_FAILED',\n message: `Failed to resolve the alt text health locales: ${message}`,\n },\n isLocalized,\n localeCodes: configured,\n })\n }\n }\n\n const collections = pluginConfig.collections\n\n const resolved = await resolveBaseFilters(req, collections, pluginConfig.healthCheckBaseFilter)\n\n if ('error' in resolved) {\n return createUnknownScan({ error: resolved.error, isLocalized, localeCodes })\n }\n\n const { baseFilters } = resolved\n\n const cacheKeyParts = [\n ALT_TEXT_HEALTH_GLOBAL_TAG,\n [...collections]\n .map(({ slug, mimeTypes }) => `${slug}:${[...mimeTypes].sort().join('|')}`)\n .sort()\n .join(','),\n localeCodes.join(','),\n // The scan is shared across requests, so a scoped scan needs a scoped cache\n // entry. Deriving the key from the resolved filters — rather than taking one\n // from the caller — makes it impossible to narrow the scan without also\n // narrowing its cache, which would serve one tenant's counts to another.\n `filter:${stableStringify(baseFilters)}`,\n ]\n\n const tags = [\n ALT_TEXT_HEALTH_GLOBAL_TAG,\n ...new Set(collections.map(({ slug }) => getAltTextHealthCollectionTag(slug))),\n ]\n\n const getCachedHealthScan = createCachedAltTextHealthScan({\n cacheFactory,\n cacheKeyParts,\n compute: async () =>\n computeAltTextHealthScan({\n baseFilters,\n collections,\n isLocalized,\n localeCodes,\n payload,\n }),\n revalidate: ALT_TEXT_HEALTH_CACHE_TTL,\n tags,\n })\n\n return getCachedHealthScan()\n}\n\n/**\n * Whether `req.user` is allowed to read the given collection at the collection\n * level. The collection's `read` access is evaluated with the request; `false`\n * denies, while `true` or a scoped `Where` constraint grants visibility of the\n * collection's health aggregate. A thrown access function (e.g. `Forbidden`)\n * counts as denied so a restricted collection never leaks.\n */\nasync function userCanReadCollection(req: PayloadRequest, slug: string): Promise<boolean> {\n const readAccess = req.payload.collections?.[slug]?.config.access?.read\n\n if (typeof readAccess !== 'function') {\n return true\n }\n\n try {\n return (await readAccess({ req })) !== false\n } catch {\n return false\n }\n}\n\n/**\n * Filters a shared, elevated-access health scan down to the collections the\n * requesting user may read. The scan is computed once with `overrideAccess: true`\n * so it stays complete and cacheable; access is applied per request at\n * collection granularity, matching the aggregate's altitude.\n */\nexport async function filterScanByReadAccess(\n req: PayloadRequest,\n scan: AltTextHealthScan,\n): Promise<AltTextHealthScan> {\n const visibility = await Promise.all(\n scan.collections.map((collection) => userCanReadCollection(req, collection.collection)),\n )\n\n const collections = scan.collections.filter((_, index) => visibility[index])\n const allowedSlugs = new Set(collections.map((collection) => collection.collection))\n const errors = scan.errors.filter(\n (error) => !error.collection || allowedSlugs.has(error.collection),\n )\n\n return { ...scan, collections, errors }\n}\n\n/**\n * Whether the requesting user may view the health report at all, per the\n * configured `healthCheck` access gate. The dashboard widget uses this to hide\n * itself, mirroring the gate enforced on the health endpoint.\n */\nexport async function canViewHealthReport(req: PayloadRequest): Promise<boolean> {\n const pluginConfig = req.payload.config.custom?.altTextPluginConfig as\n AltTextPluginConfig | undefined\n\n if (!pluginConfig) {\n return false\n }\n\n return pluginConfig.healthCheckAccess({ req })\n}\n\nexport function toWidgetData(scan: AltTextHealthScan): AltTextHealthWidgetData {\n return {\n collections: scan.collections,\n errors: scan.errors,\n isLocalized: scan.isLocalized,\n localeCount: scan.localeCodes.length,\n totalDocs: scan.collections.reduce((total, c) => total + c.totalDocs, 0),\n }\n}\n\nexport async function getAltTextHealth(req: PayloadRequest): Promise<AltTextHealthScan> {\n return filterScanByReadAccess(req, await getAltTextHealthScan(req))\n}\n\nexport async function getAltTextHealthWidgetData(\n req: PayloadRequest,\n): Promise<AltTextHealthWidgetData> {\n return toWidgetData(await filterScanByReadAccess(req, await getAltTextHealthScan(req)))\n}\n"],"names":["unstable_cache","createCachedAltTextHealthScan","localesFromConfig","buildMimeTypeWhere","configuredLocales","resolveLocales","stableStringify","summarizeCollection","ALT_TEXT_HEALTH_PLUGIN_SLUG","ALT_TEXT_HEALTH_CACHE_TTL","ALT_TEXT_HEALTH_GLOBAL_TAG","createUnknownScan","error","isLocalized","localeCodes","checkedAt","Date","toISOString","collections","errors","createCollectionReadError","collection","message","code","operation","PAGE_SIZE","isEmptyWhere","where","Object","keys","length","fetchAllDocs","payload","mimeTypes","baseFilter","mimeTypeWhere","and","docs","page","hasMore","result","find","depth","fallbackLocale","undefined","limit","locale","overrideAccess","select","alt","doc","push","id","hasNextPage","computeAltTextHealthScan","baseFilters","collectionSummaries","Promise","all","map","slug","Error","collectionError","logger","err","msg","plugin","completeDocs","invalidDocIds","missingDocs","partialDocs","totalDocs","filter","summary","getAltTextHealthCollectionTag","collectionSlug","resolveBaseFilters","req","getAltTextHealthScan","cacheFactory","pluginConfig","config","custom","altTextPluginConfig","Boolean","localization","configured","filterLocales","resolved","healthCheckBaseFilter","cacheKeyParts","sort","join","tags","Set","getCachedHealthScan","compute","revalidate","userCanReadCollection","readAccess","access","read","filterScanByReadAccess","scan","visibility","_","index","allowedSlugs","has","canViewHealthReport","healthCheckAccess","toWidgetData","localeCount","reduce","total","c","getAltTextHealth","getAltTextHealthWidgetData"],"mappings":"AAEA,SAASA,cAAc,QAAQ,gBAAe;AAQ9C,SAASC,6BAA6B,QAAQ,0BAAyB;AACvE,SAASC,iBAAiB,QAAQ,yBAAwB;AAC1D,SAASC,kBAAkB,QAAQ,iBAAgB;AACnD,SAASC,iBAAiB,EAAEC,cAAc,QAAQ,sBAAqB;AACvE,SAASC,eAAe,QAAQ,uBAAsB;AACtD,SAASC,mBAAmB,QAAQ,2BAA0B;AAE9D,OAAO,MAAMC,8BAA8B,WAAU;AACrD,OAAO,MAAMC,4BAA4B,KAAI;AAC7C,OAAO,MAAMC,6BAA6B,kBAAiB;AAkD3D,MAAMC,oBAAoB,CAAC,EACzBC,KAAK,EACLC,WAAW,EACXC,WAAW,EAKZ,GAAyB,CAAA;QACxBC,WAAW,IAAIC,OAAOC,WAAW;QACjCC,aAAa,EAAE;QACfC,QAAQ;YAACP;SAAM;QACfC;QACAC;IACF,CAAA;AAEA,MAAMM,4BAA4B,CAACC,YAAoBC,UAAqB,CAAA;QAC1EC,MAAM;QACNF;QACAC;QACAE,WAAW;IACb,CAAA;AAEA,MAAMC,YAAY;AAElB,MAAMC,eAAe,CAACC,QACpB,CAACA,SAASC,OAAOC,IAAI,CAACF,OAAOG,MAAM,KAAK;AAE1C,eAAeC,aACbC,OAAgB,EAChBX,UAAkB,EAClBR,WAAoB,EACpBoB,SAA4B,EAC5BC,UAA6B;IAE7B,MAAMC,gBAAgBhC,mBAAmB8B;IACzC,IAAI,CAACE,eAAe;QAClB,OAAO,EAAE;IACX;IAEA,iFAAiF;IACjF,iFAAiF;IACjF,MAAMR,QAAQD,aAAaQ,cAAcC,gBAAgB;QAAEC,KAAK;YAACD;YAAeD;SAAY;IAAC;IAE7F,MAAMG,OAAgD,EAAE;IACxD,IAAIC,OAAO;IACX,IAAIC,UAAU;IAEd,MAAOA,QAAS;QACd,MAAMC,SAAS,MAAMR,QAAQS,IAAI,CAAC;YAChCpB;YACAqB,OAAO;YACPC,gBAAgB9B,cAAc,QAAQ+B;YACtCC,OAAOpB;YACPqB,QAAQjC,cAAc,QAAQ+B;YAC9BG,gBAAgB;YAChBT;YACAU,QAAQ;gBACNC,KAAK;YACP;YACAtB;QACF;QAEA,KAAK,MAAMuB,OAAOV,OAAOH,IAAI,CAAE;YAC7BA,KAAKc,IAAI,CAAC;gBACRC,IAAIF,IAAIE,EAAE;gBACVH,KAAK,SAASC,MAAMA,IAAID,GAAG,GAAGL;YAChC;QACF;QAEAL,UAAUC,OAAOa,WAAW;QAC5Bf;IACF;IAEA,OAAOD;AACT;AAEA,eAAeiB,yBAAyB,EACtCC,WAAW,EACXrC,WAAW,EACXL,WAAW,EACXC,WAAW,EACXkB,OAAO,EACsB;IAC7B,MAAMwB,sBAAsB,MAAMC,QAAQC,GAAG,CAC3CxC,YAAYyC,GAAG,CAAC,OAAO,EAAEC,IAAI,EAAE3B,SAAS,EAAE;QACxC,IAAI;YACF,MAAMI,OAAO,MAAMN,aAAaC,SAAS4B,MAAM/C,aAAaoB,WAAWsB,WAAW,CAACK,KAAK;YAExF,OAAOrD,oBAAoB;gBACzBc,YAAYuC;gBACZvB;gBACAxB;gBACAC;YACF;QACF,EAAE,OAAOF,OAAO;YACd,MAAMU,UAAUV,iBAAiBiD,QAAQjD,MAAMU,OAAO,GAAG;YACzD,MAAMwC,kBAAkB1C,0BAA0BwC,MAAMtC;YAExDU,QAAQ+B,MAAM,CAACnD,KAAK,CAAC;gBACnBS,YAAYuC;gBACZI,KAAKpD;gBACLqD,KAAK;gBACLzC,WAAW;gBACX0C,QAAQ1D;YACV;YAEA,OAAO;gBACLa,YAAYuC;gBACZO,cAAc;gBACdvD,OAAOkD;gBACPM,eAAexB;gBACfyB,aAAa;gBACbC,aAAa;gBACbC,WAAW;YACb;QACF;IACF;IAGF,MAAMpD,SAASqC,oBACZgB,MAAM,CAAC,CAACC,UAAYA,QAAQ7D,KAAK,EACjC+C,GAAG,CAAC,CAACc,UAAYA,QAAQ7D,KAAK;IAEjC,OAAO;QACLG,WAAW,IAAIC,OAAOC,WAAW;QACjCC,aAAasC;QACbrC;QACAN;QACAC;IACF;AACF;AAEA,OAAO,MAAM4D,gCAAgC,CAACC,iBAC5C,GAAGjE,2BAA2B,CAAC,EAAEiE,gBAAgB,CAAA;AAEnD;;;;;;;;CAQC,GACD,eAAeC,mBACbC,GAAmB,EACnB3D,WAAgD,EAChDgB,UAAwD;IAExD,MAAMqB,cAAiD,CAAC;IAExD,IAAI,CAACrB,YAAY;QACf,OAAO;YAAEqB;QAAY;IACvB;IAEA,KAAK,MAAM,EAAEK,IAAI,EAAE,IAAI1C,YAAa;QAClC,IAAI;YACFqC,WAAW,CAACK,KAAK,GAAG,MAAM1B,WAAW;gBAAEb,YAAYuC;gBAAMiB;YAAI;QAC/D,EAAE,OAAOjE,OAAO;YACd,MAAMU,UAAUV,iBAAiBiD,QAAQjD,MAAMU,OAAO,GAAG;YAEzDuD,IAAI7C,OAAO,CAAC+B,MAAM,CAACnD,KAAK,CAAC;gBACvBS,YAAYuC;gBACZI,KAAKpD;gBACLqD,KAAK;gBACLC,QAAQ1D;YACV;YAEA,OAAO;gBACLI,OAAO;oBACLW,MAAM;oBACND,SAAS,CAAC,2DAA2D,EAAEsC,KAAK,cAAc,EAAEtC,SAAS;gBACvG;YACF;QACF;IACF;IAEA,OAAO;QAAEiC;IAAY;AACvB;AAEA,OAAO,eAAeuB,qBACpBD,GAAmB,EACnBE,eAA6D/E,cAAc;IAE3E,MAAM,EAAEgC,OAAO,EAAE,GAAG6C;IACpB,MAAMG,eAAehD,QAAQiD,MAAM,CAACC,MAAM,EAAEC;IAC5C,MAAMtE,cAAcuE,QAAQpD,QAAQiD,MAAM,CAACI,YAAY;IAEvD,IAAI,CAACL,cAAc;QACjB,OAAOrE,kBAAkB;YACvBC,OAAO;gBACLW,MAAM;gBACND,SAAS;YACX;YACAT;YACAC,aAAaZ,kBAAkB8B,QAAQiD,MAAM,KAAK,EAAE;QACtD;IACF;IAEA,MAAMK,aAAalF,kBAAkB4E;IAErC,6EAA6E;IAC7E,sDAAsD;IACtD,IAAIlE,cAAcwE;IAElB,IAAIN,aAAaO,aAAa,EAAE;QAC9B,IAAI;YACFzE,cAAc,MAAMT,eAAe;gBAAE2E;gBAAcH;YAAI;QACzD,EAAE,OAAOjE,OAAO;YACd,MAAMU,UAAUV,iBAAiBiD,QAAQjD,MAAMU,OAAO,GAAG;YAEzDU,QAAQ+B,MAAM,CAACnD,KAAK,CAAC;gBACnBoD,KAAKpD;gBACLqD,KAAK;gBACLC,QAAQ1D;YACV;YAEA,OAAOG,kBAAkB;gBACvBC,OAAO;oBACLW,MAAM;oBACND,SAAS,CAAC,+CAA+C,EAAEA,SAAS;gBACtE;gBACAT;gBACAC,aAAawE;YACf;QACF;IACF;IAEA,MAAMpE,cAAc8D,aAAa9D,WAAW;IAE5C,MAAMsE,WAAW,MAAMZ,mBAAmBC,KAAK3D,aAAa8D,aAAaS,qBAAqB;IAE9F,IAAI,WAAWD,UAAU;QACvB,OAAO7E,kBAAkB;YAAEC,OAAO4E,SAAS5E,KAAK;YAAEC;YAAaC;QAAY;IAC7E;IAEA,MAAM,EAAEyC,WAAW,EAAE,GAAGiC;IAExB,MAAME,gBAAgB;QACpBhF;QACA;eAAIQ;SAAY,CACbyC,GAAG,CAAC,CAAC,EAAEC,IAAI,EAAE3B,SAAS,EAAE,GAAK,GAAG2B,KAAK,CAAC,EAAE;mBAAI3B;aAAU,CAAC0D,IAAI,GAAGC,IAAI,CAAC,MAAM,EACzED,IAAI,GACJC,IAAI,CAAC;QACR9E,YAAY8E,IAAI,CAAC;QACjB,4EAA4E;QAC5E,6EAA6E;QAC7E,wEAAwE;QACxE,yEAAyE;QACzE,CAAC,OAAO,EAAEtF,gBAAgBiD,cAAc;KACzC;IAED,MAAMsC,OAAO;QACXnF;WACG,IAAIoF,IAAI5E,YAAYyC,GAAG,CAAC,CAAC,EAAEC,IAAI,EAAE,GAAKc,8BAA8Bd;KACxE;IAED,MAAMmC,sBAAsB9F,8BAA8B;QACxD8E;QACAW;QACAM,SAAS,UACP1C,yBAAyB;gBACvBC;gBACArC;gBACAL;gBACAC;gBACAkB;YACF;QACFiE,YAAYxF;QACZoF;IACF;IAEA,OAAOE;AACT;AAEA;;;;;;CAMC,GACD,eAAeG,sBAAsBrB,GAAmB,EAAEjB,IAAY;IACpE,MAAMuC,aAAatB,IAAI7C,OAAO,CAACd,WAAW,EAAE,CAAC0C,KAAK,EAAEqB,OAAOmB,QAAQC;IAEnE,IAAI,OAAOF,eAAe,YAAY;QACpC,OAAO;IACT;IAEA,IAAI;QACF,OAAO,AAAC,MAAMA,WAAW;YAAEtB;QAAI,OAAQ;IACzC,EAAE,OAAM;QACN,OAAO;IACT;AACF;AAEA;;;;;CAKC,GACD,OAAO,eAAeyB,uBACpBzB,GAAmB,EACnB0B,IAAuB;IAEvB,MAAMC,aAAa,MAAM/C,QAAQC,GAAG,CAClC6C,KAAKrF,WAAW,CAACyC,GAAG,CAAC,CAACtC,aAAe6E,sBAAsBrB,KAAKxD,WAAWA,UAAU;IAGvF,MAAMH,cAAcqF,KAAKrF,WAAW,CAACsD,MAAM,CAAC,CAACiC,GAAGC,QAAUF,UAAU,CAACE,MAAM;IAC3E,MAAMC,eAAe,IAAIb,IAAI5E,YAAYyC,GAAG,CAAC,CAACtC,aAAeA,WAAWA,UAAU;IAClF,MAAMF,SAASoF,KAAKpF,MAAM,CAACqD,MAAM,CAC/B,CAAC5D,QAAU,CAACA,MAAMS,UAAU,IAAIsF,aAAaC,GAAG,CAAChG,MAAMS,UAAU;IAGnE,OAAO;QAAE,GAAGkF,IAAI;QAAErF;QAAaC;IAAO;AACxC;AAEA;;;;CAIC,GACD,OAAO,eAAe0F,oBAAoBhC,GAAmB;IAC3D,MAAMG,eAAeH,IAAI7C,OAAO,CAACiD,MAAM,CAACC,MAAM,EAAEC;IAGhD,IAAI,CAACH,cAAc;QACjB,OAAO;IACT;IAEA,OAAOA,aAAa8B,iBAAiB,CAAC;QAAEjC;IAAI;AAC9C;AAEA,OAAO,SAASkC,aAAaR,IAAuB;IAClD,OAAO;QACLrF,aAAaqF,KAAKrF,WAAW;QAC7BC,QAAQoF,KAAKpF,MAAM;QACnBN,aAAa0F,KAAK1F,WAAW;QAC7BmG,aAAaT,KAAKzF,WAAW,CAACgB,MAAM;QACpCyC,WAAWgC,KAAKrF,WAAW,CAAC+F,MAAM,CAAC,CAACC,OAAOC,IAAMD,QAAQC,EAAE5C,SAAS,EAAE;IACxE;AACF;AAEA,OAAO,eAAe6C,iBAAiBvC,GAAmB;IACxD,OAAOyB,uBAAuBzB,KAAK,MAAMC,qBAAqBD;AAChE;AAEA,OAAO,eAAewC,2BACpBxC,GAAmB;IAEnB,OAAOkC,aAAa,MAAMT,uBAAuBzB,KAAK,MAAMC,qBAAqBD;AACnF"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { PayloadRequest } from 'payload';
|
|
2
|
+
import type { AltTextPluginConfig } from '../types/AltTextPluginConfig.js';
|
|
3
|
+
/**
|
|
4
|
+
* The locales one request generates for and is measured against — the configured
|
|
5
|
+
* list itself when no `filterLocales` is set.
|
|
6
|
+
*
|
|
7
|
+
* Throws on an empty or out-of-range result, which would otherwise write into a
|
|
8
|
+
* locale the project does not define.
|
|
9
|
+
*/
|
|
10
|
+
export declare function resolveLocales({ pluginConfig, req, }: {
|
|
11
|
+
pluginConfig: AltTextPluginConfig;
|
|
12
|
+
req: PayloadRequest;
|
|
13
|
+
}): Promise<string[]>;
|
|
14
|
+
/** The configured locales, or the single fallback locale when localization is off. */
|
|
15
|
+
export declare function configuredLocales(pluginConfig: AltTextPluginConfig): string[];
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The locales one request generates for and is measured against — the configured
|
|
3
|
+
* list itself when no `filterLocales` is set.
|
|
4
|
+
*
|
|
5
|
+
* Throws on an empty or out-of-range result, which would otherwise write into a
|
|
6
|
+
* locale the project does not define.
|
|
7
|
+
*/ export async function resolveLocales({ pluginConfig, req }) {
|
|
8
|
+
const configured = configuredLocales(pluginConfig);
|
|
9
|
+
if (!pluginConfig.filterLocales) {
|
|
10
|
+
return configured;
|
|
11
|
+
}
|
|
12
|
+
// Deduplicated: a repeated locale would be generated and written twice, and
|
|
13
|
+
// reach the resolver as a duplicate key in the schema it must answer with.
|
|
14
|
+
const filtered = [
|
|
15
|
+
...new Set(await pluginConfig.filterLocales({
|
|
16
|
+
locales: configured,
|
|
17
|
+
req
|
|
18
|
+
}))
|
|
19
|
+
];
|
|
20
|
+
const unconfigured = filtered.filter((locale)=>!configured.includes(locale));
|
|
21
|
+
if (unconfigured.length > 0) {
|
|
22
|
+
throw new Error(`filterLocales returned ${unconfigured.join(', ')}, which the Payload config does not define. ` + `Configured locales: ${configured.join(', ')}.`);
|
|
23
|
+
}
|
|
24
|
+
if (filtered.length === 0) {
|
|
25
|
+
throw new Error('filterLocales returned no locales, leaving nothing to generate or report on. ' + 'Return at least one of the configured locales.');
|
|
26
|
+
}
|
|
27
|
+
return filtered;
|
|
28
|
+
}
|
|
29
|
+
/** The configured locales, or the single fallback locale when localization is off. */ export function configuredLocales(pluginConfig) {
|
|
30
|
+
if (pluginConfig.locales.length > 0) {
|
|
31
|
+
return pluginConfig.locales;
|
|
32
|
+
}
|
|
33
|
+
return pluginConfig.locale ? [
|
|
34
|
+
pluginConfig.locale
|
|
35
|
+
] : [];
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
//# sourceMappingURL=resolveLocales.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/utilities/resolveLocales.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport type { AltTextPluginConfig } from '../types/AltTextPluginConfig.js'\n\n/**\n * The locales one request generates for and is measured against — the configured\n * list itself when no `filterLocales` is set.\n *\n * Throws on an empty or out-of-range result, which would otherwise write into a\n * locale the project does not define.\n */\nexport async function resolveLocales({\n pluginConfig,\n req,\n}: {\n pluginConfig: AltTextPluginConfig\n req: PayloadRequest\n}): Promise<string[]> {\n const configured = configuredLocales(pluginConfig)\n\n if (!pluginConfig.filterLocales) {\n return configured\n }\n\n // Deduplicated: a repeated locale would be generated and written twice, and\n // reach the resolver as a duplicate key in the schema it must answer with.\n const filtered = [...new Set(await pluginConfig.filterLocales({ locales: configured, req }))]\n\n const unconfigured = filtered.filter((locale) => !configured.includes(locale))\n\n if (unconfigured.length > 0) {\n throw new Error(\n `filterLocales returned ${unconfigured.join(', ')}, which the Payload config does not define. ` +\n `Configured locales: ${configured.join(', ')}.`,\n )\n }\n\n if (filtered.length === 0) {\n throw new Error(\n 'filterLocales returned no locales, leaving nothing to generate or report on. ' +\n 'Return at least one of the configured locales.',\n )\n }\n\n return filtered\n}\n\n/** The configured locales, or the single fallback locale when localization is off. */\nexport function configuredLocales(pluginConfig: AltTextPluginConfig): string[] {\n if (pluginConfig.locales.length > 0) {\n return pluginConfig.locales\n }\n\n return pluginConfig.locale ? [pluginConfig.locale] : []\n}\n"],"names":["resolveLocales","pluginConfig","req","configured","configuredLocales","filterLocales","filtered","Set","locales","unconfigured","filter","locale","includes","length","Error","join"],"mappings":"AAIA;;;;;;CAMC,GACD,OAAO,eAAeA,eAAe,EACnCC,YAAY,EACZC,GAAG,EAIJ;IACC,MAAMC,aAAaC,kBAAkBH;IAErC,IAAI,CAACA,aAAaI,aAAa,EAAE;QAC/B,OAAOF;IACT;IAEA,4EAA4E;IAC5E,2EAA2E;IAC3E,MAAMG,WAAW;WAAI,IAAIC,IAAI,MAAMN,aAAaI,aAAa,CAAC;YAAEG,SAASL;YAAYD;QAAI;KAAI;IAE7F,MAAMO,eAAeH,SAASI,MAAM,CAAC,CAACC,SAAW,CAACR,WAAWS,QAAQ,CAACD;IAEtE,IAAIF,aAAaI,MAAM,GAAG,GAAG;QAC3B,MAAM,IAAIC,MACR,CAAC,uBAAuB,EAAEL,aAAaM,IAAI,CAAC,MAAM,4CAA4C,CAAC,GAC7F,CAAC,oBAAoB,EAAEZ,WAAWY,IAAI,CAAC,MAAM,CAAC,CAAC;IAErD;IAEA,IAAIT,SAASO,MAAM,KAAK,GAAG;QACzB,MAAM,IAAIC,MACR,kFACE;IAEN;IAEA,OAAOR;AACT;AAEA,oFAAoF,GACpF,OAAO,SAASF,kBAAkBH,YAAiC;IACjE,IAAIA,aAAaO,OAAO,CAACK,MAAM,GAAG,GAAG;QACnC,OAAOZ,aAAaO,OAAO;IAC7B;IAEA,OAAOP,aAAaU,MAAM,GAAG;QAACV,aAAaU,MAAM;KAAC,GAAG,EAAE;AACzD"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Serializes a value with object keys sorted, so two structurally equal values
|
|
3
|
+
* produce the same string regardless of the order their keys were written in.
|
|
4
|
+
*
|
|
5
|
+
* The health scan uses it to derive a cache key from the resolved base filter:
|
|
6
|
+
* narrowing the scan then always narrows its cache entry, which no amount of
|
|
7
|
+
* documentation can guarantee for a caller-supplied key.
|
|
8
|
+
*/
|
|
9
|
+
export declare function stableStringify(value: unknown): string;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Serializes a value with object keys sorted, so two structurally equal values
|
|
3
|
+
* produce the same string regardless of the order their keys were written in.
|
|
4
|
+
*
|
|
5
|
+
* The health scan uses it to derive a cache key from the resolved base filter:
|
|
6
|
+
* narrowing the scan then always narrows its cache entry, which no amount of
|
|
7
|
+
* documentation can guarantee for a caller-supplied key.
|
|
8
|
+
*/ export function stableStringify(value) {
|
|
9
|
+
if (Array.isArray(value)) {
|
|
10
|
+
return `[${value.map(stableStringify).join(',')}]`;
|
|
11
|
+
}
|
|
12
|
+
if (value && typeof value === 'object') {
|
|
13
|
+
const entries = Object.entries(value).filter(([, entryValue])=>entryValue !== undefined).sort(([a], [b])=>a < b ? -1 : a > b ? 1 : 0).map(([key, entryValue])=>`${JSON.stringify(key)}:${stableStringify(entryValue)}`);
|
|
14
|
+
return `{${entries.join(',')}}`;
|
|
15
|
+
}
|
|
16
|
+
return JSON.stringify(value) ?? 'null';
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
//# sourceMappingURL=stableStringify.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/utilities/stableStringify.ts"],"sourcesContent":["/**\n * Serializes a value with object keys sorted, so two structurally equal values\n * produce the same string regardless of the order their keys were written in.\n *\n * The health scan uses it to derive a cache key from the resolved base filter:\n * narrowing the scan then always narrows its cache entry, which no amount of\n * documentation can guarantee for a caller-supplied key.\n */\nexport function stableStringify(value: unknown): string {\n if (Array.isArray(value)) {\n return `[${value.map(stableStringify).join(',')}]`\n }\n\n if (value && typeof value === 'object') {\n const entries = Object.entries(value as Record<string, unknown>)\n .filter(([, entryValue]) => entryValue !== undefined)\n .sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0))\n .map(([key, entryValue]) => `${JSON.stringify(key)}:${stableStringify(entryValue)}`)\n\n return `{${entries.join(',')}}`\n }\n\n return JSON.stringify(value) ?? 'null'\n}\n"],"names":["stableStringify","value","Array","isArray","map","join","entries","Object","filter","entryValue","undefined","sort","a","b","key","JSON","stringify"],"mappings":"AAAA;;;;;;;CAOC,GACD,OAAO,SAASA,gBAAgBC,KAAc;IAC5C,IAAIC,MAAMC,OAAO,CAACF,QAAQ;QACxB,OAAO,CAAC,CAAC,EAAEA,MAAMG,GAAG,CAACJ,iBAAiBK,IAAI,CAAC,KAAK,CAAC,CAAC;IACpD;IAEA,IAAIJ,SAAS,OAAOA,UAAU,UAAU;QACtC,MAAMK,UAAUC,OAAOD,OAAO,CAACL,OAC5BO,MAAM,CAAC,CAAC,GAAGC,WAAW,GAAKA,eAAeC,WAC1CC,IAAI,CAAC,CAAC,CAACC,EAAE,EAAE,CAACC,EAAE,GAAMD,IAAIC,IAAI,CAAC,IAAID,IAAIC,IAAI,IAAI,GAC7CT,GAAG,CAAC,CAAC,CAACU,KAAKL,WAAW,GAAK,GAAGM,KAAKC,SAAS,CAACF,KAAK,CAAC,EAAEd,gBAAgBS,aAAa;QAErF,OAAO,CAAC,CAAC,EAAEH,QAAQD,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC;IAEA,OAAOU,KAAKC,SAAS,CAACf,UAAU;AAClC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jhb.software/payload-alt-text-plugin",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.12.0",
|
|
4
4
|
"description": "A Payload CMS plugin that adds AI-powered alt text generation for images.",
|
|
5
5
|
"bugs": "https://github.com/jhb-software/payload-plugins/issues",
|
|
6
6
|
"repository": {
|
|
@@ -20,7 +20,6 @@
|
|
|
20
20
|
"main": "./dist/index.js",
|
|
21
21
|
"types": "./dist/index.d.ts",
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"openai": "^7.4.0",
|
|
24
23
|
"p-map": "^7.0.6",
|
|
25
24
|
"zod": "^4.4.3"
|
|
26
25
|
},
|
|
@@ -36,15 +35,15 @@
|
|
|
36
35
|
"@payloadcms/eslint-config": "^3.28.0",
|
|
37
36
|
"@payloadcms/translations": "^3.88.0",
|
|
38
37
|
"@swc/cli": "^0.8.1",
|
|
39
|
-
"@swc/core": "^1.
|
|
38
|
+
"@swc/core": "^1.16.1",
|
|
40
39
|
"@types/react": "19.2.18",
|
|
41
|
-
"@types/react-dom": "19.2.
|
|
40
|
+
"@types/react-dom": "19.2.5",
|
|
42
41
|
"copyfiles": "2.4.1",
|
|
43
42
|
"eslint": "^9.39.4",
|
|
44
43
|
"prettier": "3.9.6",
|
|
45
44
|
"rimraf": "6.1.3",
|
|
46
45
|
"typescript": "^6.0.3",
|
|
47
|
-
"vitest": "^4.1.
|
|
46
|
+
"vitest": "^4.1.11"
|
|
48
47
|
},
|
|
49
48
|
"files": [
|
|
50
49
|
"dist"
|