@seshuk/payload-plugin-openapi 0.2.2 → 1.0.0-beta.1

package/dist/server/spec/paths/system.js

@@ -0,0 +1,137 @@
+import { SECURITY_SCHEME_NAME, errorResponses, jsonBody, jsonResponse } from "../components.js";
+import { makeT } from "../../../shared/translations/index.js";
+const buildSystemPaths = ({ ctx, access, uploadSlugs }) => {
+	const t = makeT(ctx.i18n);
+	const paths = {};
+	if (access) paths[`${ctx.apiRoute}/access`] = { get: {
+		tags: ["Access"],
+		operationId: "access",
+		responses: {
+			"200": jsonResponse(t("authAccess"), {
+				type: "object",
+				additionalProperties: true
+			}),
+			...errorResponses(["500"], t)
+		}
+	} };
+	if (uploadSlugs.length > 0) {
+		const staged = {
+			"204": { description: t("uploadStageResult") },
+			...errorResponses(["400", "500"], t)
+		};
+		paths[`${ctx.apiRoute}/upload-instructions`] = { post: {
+			tags: ["Uploads"],
+			operationId: "getUploadInstructions",
+			summary: t("uploadInstructionsSummary"),
+			requestBody: jsonBody({
+				type: "object",
+				additionalProperties: false,
+				properties: {
+					collectionSlug: {
+						type: "string",
+						enum: uploadSlugs
+					},
+					docPrefix: { type: "string" },
+					filename: { type: "string" },
+					filesize: {
+						type: "integer",
+						minimum: 0
+					},
+					mimeType: { type: "string" }
+				},
+				required: [
+					"collectionSlug",
+					"filename",
+					"filesize",
+					"mimeType"
+				]
+			}),
+			responses: {
+				"200": jsonResponse(t("uploadInstructionsResult"), {
+					type: "object",
+					properties: {
+						type: {
+							type: "string",
+							enum: ["http", "dispatch"]
+						},
+						file: {
+							type: "object",
+							properties: {
+								filename: { type: "string" },
+								mimeType: { type: "string" },
+								size: { type: "integer" },
+								uploadReference: {
+									type: "object",
+									additionalProperties: true
+								}
+							},
+							required: [
+								"filename",
+								"mimeType",
+								"size",
+								"uploadReference"
+							]
+						},
+						request: {
+							type: "object",
+							properties: {
+								method: {
+									type: "string",
+									enum: ["POST", "PUT"]
+								},
+								url: { type: "string" },
+								headers: {
+									type: "object",
+									additionalProperties: { type: "string" }
+								}
+							},
+							required: ["method", "url"]
+						},
+						name: { type: "string" },
+						data: {}
+					},
+					required: ["type", "file"]
+				}),
+				...errorResponses([
+					"400",
+					"403",
+					"500"
+				], t)
+			},
+			security: [{ [SECURITY_SCHEME_NAME]: [] }]
+		} };
+		paths[`${ctx.apiRoute}/upload-instructions/{uploadId}`] = {
+			parameters: [{
+				name: "uploadId",
+				in: "path",
+				required: true,
+				schema: { type: "string" }
+			}],
+			put: {
+				tags: ["Uploads"],
+				operationId: "uploadStagedFile",
+				summary: t("uploadStagePutSummary"),
+				requestBody: {
+					required: true,
+					content: { "*/*": { schema: {
+						type: "string",
+						format: "binary"
+					} } }
+				},
+				responses: staged,
+				security: [{ [SECURITY_SCHEME_NAME]: [] }]
+			},
+			delete: {
+				tags: ["Uploads"],
+				operationId: "deleteStagedFile",
+				summary: t("uploadStageDeleteSummary"),
+				responses: staged,
+				security: [{ [SECURITY_SCHEME_NAME]: [] }]
+			}
+		};
+	}
+	return paths;
+};
+export { buildSystemPaths };
+
+//# sourceMappingURL=system.js.map

package/dist/server/spec/paths/system.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.js","names":[],"sources":["../../../../src/server/spec/paths/system.ts"],"sourcesContent":["import type { PathsObject, ResponsesObject } from '@scalar/openapi-types/3.2'\n\nimport { SECURITY_SCHEME_NAME, errorResponses, jsonBody, jsonResponse } from '@/server/spec/components.js'\nimport { makeT } from '@/shared/translations/index.js'\nimport type { BuildContext } from '@/shared/types/index.js'\n\nexport const buildSystemPaths = ({\n  ctx,\n  access,\n  uploadSlugs,\n}: {\n  ctx: BuildContext\n  access: boolean\n  uploadSlugs: string[]\n}): PathsObject => {\n  const t = makeT(ctx.i18n)\n  const paths: PathsObject = {}\n\n  if (access) {\n    paths[`${ctx.apiRoute}/access`] = {\n      get: {\n        tags: ['Access'],\n        operationId: 'access',\n        responses: {\n          '200': jsonResponse(t('authAccess'), { type: 'object', additionalProperties: true }),\n          ...errorResponses(['500'], t),\n        },\n      },\n    }\n  }\n\n  if (uploadSlugs.length > 0) {\n    const staged: ResponsesObject = {\n      '204': { description: t('uploadStageResult') },\n      ...errorResponses(['400', '500'], t),\n    }\n\n    paths[`${ctx.apiRoute}/upload-instructions`] = {\n      post: {\n        tags: ['Uploads'],\n        operationId: 'getUploadInstructions',\n        summary: t('uploadInstructionsSummary'),\n        requestBody: jsonBody({\n          type: 'object',\n          additionalProperties: false,\n          properties: {\n            collectionSlug: { type: 'string', enum: uploadSlugs },\n            docPrefix: { type: 'string' },\n            filename: { type: 'string' },\n            filesize: { type: 'integer', minimum: 0 },\n            mimeType: { type: 'string' },\n          },\n          required: ['collectionSlug', 'filename', 'filesize', 'mimeType'],\n        }),\n        responses: {\n          '200': jsonResponse(t('uploadInstructionsResult'), {\n            type: 'object',\n            properties: {\n              type: { type: 'string', enum: ['http', 'dispatch'] },\n              file: {\n                type: 'object',\n                properties: {\n                  filename: { type: 'string' },\n                  mimeType: { type: 'string' },\n                  size: { type: 'integer' },\n                  uploadReference: { type: 'object', additionalProperties: true },\n                },\n                required: ['filename', 'mimeType', 'size', 'uploadReference'],\n              },\n              request: {\n                type: 'object',\n                properties: {\n                  method: { type: 'string', enum: ['POST', 'PUT'] },\n                  url: { type: 'string' },\n                  headers: { type: 'object', additionalProperties: { type: 'string' } },\n                },\n                required: ['method', 'url'],\n              },\n              name: { type: 'string' },\n              data: {},\n            },\n            required: ['type', 'file'],\n          }),\n          ...errorResponses(['400', '403', '500'], t),\n        },\n        security: [{ [SECURITY_SCHEME_NAME]: [] }],\n      },\n    }\n    paths[`${ctx.apiRoute}/upload-instructions/{uploadId}`] = {\n      parameters: [{ name: 'uploadId', in: 'path', required: true, schema: { type: 'string' } }],\n      put: {\n        tags: ['Uploads'],\n        operationId: 'uploadStagedFile',\n        summary: t('uploadStagePutSummary'),\n        requestBody: {\n          required: true,\n          content: { '*/*': { schema: { type: 'string', format: 'binary' } } },\n        },\n        responses: staged,\n        security: [{ [SECURITY_SCHEME_NAME]: [] }],\n      },\n      delete: {\n        tags: ['Uploads'],\n        operationId: 'deleteStagedFile',\n        summary: t('uploadStageDeleteSummary'),\n        responses: staged,\n        security: [{ [SECURITY_SCHEME_NAME]: [] }],\n      },\n    }\n  }\n\n  return paths\n}\n"],"mappings":";;AAMA,MAAa,oBAAoB,EAC/B,KACA,QACA,kBAKiB;CACjB,MAAM,IAAI,MAAM,IAAI,IAAI;CACxB,MAAM,QAAqB,CAAC;CAE5B,IAAI,QACF,MAAM,GAAG,IAAI,SAAS,YAAY,EAChC,KAAK;EACH,MAAM,CAAC,QAAQ;EACf,aAAa;EACb,WAAW;GACT,OAAO,aAAa,EAAE,YAAY,GAAG;IAAE,MAAM;IAAU,sBAAsB;GAAK,CAAC;GACnF,GAAG,eAAe,CAAC,KAAK,GAAG,CAAC;EAC9B;CACF,EACF;CAGF,IAAI,YAAY,SAAS,GAAG;EAC1B,MAAM,SAA0B;GAC9B,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE;GAC7C,GAAG,eAAe,CAAC,OAAO,KAAK,GAAG,CAAC;EACrC;EAEA,MAAM,GAAG,IAAI,SAAS,yBAAyB,EAC7C,MAAM;GACJ,MAAM,CAAC,SAAS;GAChB,aAAa;GACb,SAAS,EAAE,2BAA2B;GACtC,aAAa,SAAS;IACpB,MAAM;IACN,sBAAsB;IACtB,YAAY;KACV,gBAAgB;MAAE,MAAM;MAAU,MAAM;KAAY;KACpD,WAAW,EAAE,MAAM,SAAS;KAC5B,UAAU,EAAE,MAAM,SAAS;KAC3B,UAAU;MAAE,MAAM;MAAW,SAAS;KAAE;KACxC,UAAU,EAAE,MAAM,SAAS;IAC7B;IACA,UAAU;KAAC;KAAkB;KAAY;KAAY;IAAU;GACjE,CAAC;GACD,WAAW;IACT,OAAO,aAAa,EAAE,0BAA0B,GAAG;KACjD,MAAM;KACN,YAAY;MACV,MAAM;OAAE,MAAM;OAAU,MAAM,CAAC,QAAQ,UAAU;MAAE;MACnD,MAAM;OACJ,MAAM;OACN,YAAY;QACV,UAAU,EAAE,MAAM,SAAS;QAC3B,UAAU,EAAE,MAAM,SAAS;QAC3B,MAAM,EAAE,MAAM,UAAU;QACxB,iBAAiB;SAAE,MAAM;SAAU,sBAAsB;QAAK;OAChE;OACA,UAAU;QAAC;QAAY;QAAY;QAAQ;OAAiB;MAC9D;MACA,SAAS;OACP,MAAM;OACN,YAAY;QACV,QAAQ;SAAE,MAAM;SAAU,MAAM,CAAC,QAAQ,KAAK;QAAE;QAChD,KAAK,EAAE,MAAM,SAAS;QACtB,SAAS;SAAE,MAAM;SAAU,sBAAsB,EAAE,MAAM,SAAS;QAAE;OACtE;OACA,UAAU,CAAC,UAAU,KAAK;MAC5B;MACA,MAAM,EAAE,MAAM,SAAS;MACvB,MAAM,CAAC;KACT;KACA,UAAU,CAAC,QAAQ,MAAM;IAC3B,CAAC;IACD,GAAG,eAAe;KAAC;KAAO;KAAO;IAAK,GAAG,CAAC;GAC5C;GACA,UAAU,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAC;EAC3C,EACF;EACA,MAAM,GAAG,IAAI,SAAS,oCAAoC;GACxD,YAAY,CAAC;IAAE,MAAM;IAAY,IAAI;IAAQ,UAAU;IAAM,QAAQ,EAAE,MAAM,SAAS;GAAE,CAAC;GACzF,KAAK;IACH,MAAM,CAAC,SAAS;IAChB,aAAa;IACb,SAAS,EAAE,uBAAuB;IAClC,aAAa;KACX,UAAU;KACV,SAAS,EAAE,OAAO,EAAE,QAAQ;MAAE,MAAM;MAAU,QAAQ;KAAS,EAAE,EAAE;IACrE;IACA,WAAW;IACX,UAAU,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAC;GAC3C;GACA,QAAQ;IACN,MAAM,CAAC,SAAS;IAChB,aAAa;IACb,SAAS,EAAE,0BAA0B;IACrC,WAAW;IACX,UAAU,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAC;GAC3C;EACF;CACF;CAEA,OAAO;AACT"}

package/dist/server/spec/paths/versions.d.ts

@@ -0,0 +1,22 @@
+import { BuildContext, Entity, IDType } from "../../../shared/types/index.js";
+import { EntitySecurity } from "../security.js";
+import { PathsObject, SchemaObject } from "@scalar/openapi-types/3.2";
+export interface VersionSchemas {
+  version: SchemaObject;
+  versionList: SchemaObject;
+}
+export declare const versionComponentSchemas: ({ docBase, base, idType }: {
+  docBase: string;
+  base: string;
+  idType: IDType;
+}) => VersionSchemas;
+export declare const buildVersionPaths: ({ entity, pathBase, ctx, schemaBase, nestedTags, security, global }: {
+  entity: Entity;
+  pathBase: string;
+  ctx: BuildContext;
+  schemaBase?: string;
+  nestedTags: boolean;
+  security?: EntitySecurity;
+  global?: boolean;
+}) => PathsObject;
+//# sourceMappingURL=versions.d.ts.map

package/dist/server/spec/paths/versions.js

@@ -0,0 +1,185 @@
+import { refTo, schemaName } from "../names.js";
+import { ERRORS, errorResponses, jsonResponse, nullableType } from "../components.js";
+import { versionsTagName } from "../tags.js";
+import { makeT } from "../../../shared/translations/index.js";
+import { buildParamSchemas, commonReadParams } from "../params.js";
+const buildVersionSchema = (base, idType) => {
+	const id = { type: idType === "number" ? "integer" : "string" };
+	return {
+		type: "object",
+		properties: {
+			id,
+			parent: id,
+			version: { $ref: refTo(base) },
+			createdAt: {
+				type: "string",
+				format: "date-time"
+			},
+			updatedAt: {
+				type: "string",
+				format: "date-time"
+			},
+			latest: { type: "boolean" },
+			autosave: { type: "boolean" },
+			snapshot: { type: "boolean" },
+			publishedLocale: { type: "string" }
+		},
+		required: [
+			"id",
+			"parent",
+			"version",
+			"createdAt",
+			"updatedAt"
+		]
+	};
+};
+const buildVersionListSchema = (base) => ({
+	type: "object",
+	properties: {
+		docs: {
+			type: "array",
+			items: { $ref: refTo(`${base}Version`) }
+		},
+		totalDocs: { type: "integer" },
+		limit: { type: "integer" },
+		totalPages: { type: "integer" },
+		page: { type: "integer" },
+		pagingCounter: { type: "integer" },
+		hasPrevPage: { type: "boolean" },
+		hasNextPage: { type: "boolean" },
+		prevPage: nullableType("integer"),
+		nextPage: nullableType("integer")
+	}
+});
+const versionComponentSchemas = ({ docBase, base, idType }) => ({
+	version: buildVersionSchema(docBase, idType),
+	versionList: buildVersionListSchema(base)
+});
+const versionRef = (base) => ({ $ref: refTo(`${base}Version`) });
+const versionListRef = (base) => ({ $ref: refTo(`${base}VersionList`) });
+const listVersionParams = ({ base, ctx, refs }) => {
+	const t = makeT(ctx.i18n);
+	return [
+		{
+			name: "page",
+			in: "query",
+			schema: { type: "integer" }
+		},
+		{
+			name: "limit",
+			in: "query",
+			schema: { type: "integer" }
+		},
+		{
+			name: "pagination",
+			in: "query",
+			schema: { type: "boolean" }
+		},
+		{
+			name: "sort",
+			in: "query",
+			description: t("paramSortShort"),
+			schema: { type: "string" }
+		},
+		...commonReadParams({
+			base,
+			ctx,
+			refs
+		}),
+		{
+			name: "where",
+			in: "query",
+			description: t("versionWhere"),
+			content: { "application/json": { schema: {
+				type: "object",
+				additionalProperties: true
+			} } }
+		}
+	];
+};
+const buildVersionPaths = ({ entity, pathBase, ctx, schemaBase, nestedTags, security = {}, global = false }) => {
+	if (!entity.versions) return {};
+	const t = makeT(ctx.i18n);
+	const name = schemaBase ?? schemaName(entity.slug);
+	const versionsTag = [nestedTags ? versionsTagName(name) : name];
+	const paramSchemas = buildParamSchemas({
+		fields: entity.fields,
+		ctx
+	});
+	const refs = {
+		select: true,
+		populate: Boolean(paramSchemas.populate),
+		joins: Boolean(paramSchemas.joins)
+	};
+	const idParam = {
+		name: "id",
+		in: "path",
+		required: true,
+		schema: { type: ctx.defaultIDType === "number" ? "integer" : "string" }
+	};
+	const message = { type: "string" };
+	const restoreResponse = global ? {
+		type: "object",
+		properties: {
+			message,
+			doc: { $ref: refTo(name) }
+		}
+	} : { allOf: [{ $ref: refTo(name) }, {
+		type: "object",
+		properties: { message }
+	}] };
+	return {
+		[`${pathBase}/versions`]: { get: {
+			tags: versionsTag,
+			operationId: `find${name}Versions`,
+			parameters: listVersionParams({
+				base: name,
+				ctx,
+				refs
+			}),
+			responses: {
+				"200": jsonResponse(t("versionList"), versionListRef(name)),
+				...errorResponses(ERRORS.versionList, t)
+			},
+			security: security.readVersions
+		} },
+		[`${pathBase}/versions/{id}`]: {
+			parameters: [idParam],
+			get: {
+				tags: versionsTag,
+				operationId: `find${name}VersionById`,
+				parameters: commonReadParams({
+					base: name,
+					ctx,
+					refs
+				}),
+				responses: {
+					"200": jsonResponse(t("versionSingle"), versionRef(name)),
+					...errorResponses(ERRORS.versionRead, t)
+				},
+				security: security.readVersions
+			},
+			post: {
+				tags: versionsTag,
+				operationId: `restore${name}Version`,
+				parameters: [{
+					name: "depth",
+					in: "query",
+					schema: { type: "integer" }
+				}, {
+					name: "draft",
+					in: "query",
+					schema: { type: "boolean" }
+				}],
+				responses: {
+					"200": jsonResponse(t("versionRestored"), restoreResponse),
+					...errorResponses(ERRORS.versionRestore, t)
+				},
+				security: security.update
+			}
+		}
+	};
+};
+export { buildVersionPaths, versionComponentSchemas };
+
+//# sourceMappingURL=versions.js.map

package/dist/server/spec/paths/versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","names":[],"sources":["../../../../src/server/spec/paths/versions.ts"],"sourcesContent":["import type { ParameterObject, PathsObject, ReferenceObject, SchemaObject } from '@scalar/openapi-types/3.2'\n\nimport { ERRORS, errorResponses, jsonResponse, nullableType } from '@/server/spec/components.js'\nimport { refTo, schemaName } from '@/server/spec/names.js'\nimport { buildParamSchemas, commonReadParams, type ReadParamRefs } from '@/server/spec/params.js'\nimport type { EntitySecurity } from '@/server/spec/security.js'\nimport { versionsTagName } from '@/server/spec/tags.js'\nimport { makeT } from '@/shared/translations/index.js'\nimport type { BuildContext, Entity, IDType } from '@/shared/types/index.js'\n\nconst buildVersionSchema = (base: string, idType: IDType): SchemaObject => {\n  const id: SchemaObject = { type: idType === 'number' ? 'integer' : 'string' }\n  return {\n    type: 'object',\n    properties: {\n      id,\n      parent: id,\n      version: { $ref: refTo(base) },\n      createdAt: { type: 'string', format: 'date-time' },\n      updatedAt: { type: 'string', format: 'date-time' },\n      latest: { type: 'boolean' },\n      autosave: { type: 'boolean' },\n      snapshot: { type: 'boolean' },\n      publishedLocale: { type: 'string' },\n    },\n    required: ['id', 'parent', 'version', 'createdAt', 'updatedAt'],\n  }\n}\n\nconst buildVersionListSchema = (base: string): SchemaObject => ({\n  type: 'object',\n  properties: {\n    docs: { type: 'array', items: { $ref: refTo(`${base}Version`) } },\n    totalDocs: { type: 'integer' },\n    limit: { type: 'integer' },\n    totalPages: { type: 'integer' },\n    page: { type: 'integer' },\n    pagingCounter: { type: 'integer' },\n    hasPrevPage: { type: 'boolean' },\n    hasNextPage: { type: 'boolean' },\n    prevPage: nullableType('integer'),\n    nextPage: nullableType('integer'),\n  },\n})\n\nexport interface VersionSchemas {\n  version: SchemaObject\n  versionList: SchemaObject\n}\n\nexport const versionComponentSchemas = ({\n  docBase,\n  base,\n  idType,\n}: {\n  docBase: string\n  base: string\n  idType: IDType\n}): VersionSchemas => ({\n  version: buildVersionSchema(docBase, idType),\n  versionList: buildVersionListSchema(base),\n})\n\nconst versionRef = (base: string): ReferenceObject => ({\n  $ref: refTo(`${base}Version`),\n})\nconst versionListRef = (base: string): ReferenceObject => ({\n  $ref: refTo(`${base}VersionList`),\n})\n\nconst listVersionParams = ({\n  base,\n  ctx,\n  refs,\n}: {\n  base: string\n  ctx: BuildContext\n  refs: ReadParamRefs\n}): ParameterObject[] => {\n  const t = makeT(ctx.i18n)\n  return [\n    { name: 'page', in: 'query', schema: { type: 'integer' } },\n    { name: 'limit', in: 'query', schema: { type: 'integer' } },\n    { name: 'pagination', in: 'query', schema: { type: 'boolean' } },\n    {\n      name: 'sort',\n      in: 'query',\n      description: t('paramSortShort'),\n      schema: { type: 'string' },\n    },\n    ...commonReadParams({ base, ctx, refs }),\n    {\n      name: 'where',\n      in: 'query',\n      description: t('versionWhere'),\n      content: {\n        'application/json': { schema: { type: 'object', additionalProperties: true } },\n      },\n    },\n  ]\n}\n\nexport const buildVersionPaths = ({\n  entity,\n  pathBase,\n  ctx,\n  schemaBase,\n  nestedTags,\n  security = {},\n  global = false,\n}: {\n  entity: Entity\n  pathBase: string\n  ctx: BuildContext\n  schemaBase?: string\n  nestedTags: boolean\n  security?: EntitySecurity\n  global?: boolean\n}): PathsObject => {\n  if (!entity.versions) return {}\n\n  const t = makeT(ctx.i18n)\n  const name = schemaBase ?? schemaName(entity.slug)\n  const versionsTag = [nestedTags ? versionsTagName(name) : name]\n  const paramSchemas = buildParamSchemas({ fields: entity.fields, ctx })\n  const refs: ReadParamRefs = {\n    select: true,\n    populate: Boolean(paramSchemas.populate),\n    joins: Boolean(paramSchemas.joins),\n  }\n  const idParam: ParameterObject = {\n    name: 'id',\n    in: 'path',\n    required: true,\n    schema: { type: ctx.defaultIDType === 'number' ? 'integer' : 'string' },\n  }\n\n  const message: SchemaObject = { type: 'string' }\n  const restoreResponse: SchemaObject = global\n    ? { type: 'object', properties: { message, doc: { $ref: refTo(name) } } }\n    : { allOf: [{ $ref: refTo(name) }, { type: 'object', properties: { message } }] }\n\n  return {\n    [`${pathBase}/versions`]: {\n      get: {\n        tags: versionsTag,\n        operationId: `find${name}Versions`,\n        parameters: listVersionParams({ base: name, ctx, refs }),\n        responses: {\n          '200': jsonResponse(t('versionList'), versionListRef(name)),\n          ...errorResponses(ERRORS.versionList, t),\n        },\n        security: security.readVersions,\n      },\n    },\n    [`${pathBase}/versions/{id}`]: {\n      parameters: [idParam],\n      get: {\n        tags: versionsTag,\n        operationId: `find${name}VersionById`,\n        parameters: commonReadParams({ base: name, ctx, refs }),\n        responses: {\n          '200': jsonResponse(t('versionSingle'), versionRef(name)),\n          ...errorResponses(ERRORS.versionRead, t),\n        },\n        security: security.readVersions,\n      },\n      post: {\n        tags: versionsTag,\n        operationId: `restore${name}Version`,\n        parameters: [\n          { name: 'depth', in: 'query', schema: { type: 'integer' } },\n          { name: 'draft', in: 'query', schema: { type: 'boolean' } },\n        ],\n        responses: {\n          '200': jsonResponse(t('versionRestored'), restoreResponse),\n          ...errorResponses(ERRORS.versionRestore, t),\n        },\n        security: security.update,\n      },\n    },\n  }\n}\n"],"mappings":";;;;;AAUA,MAAM,sBAAsB,MAAc,WAAiC;CACzE,MAAM,KAAmB,EAAE,MAAM,WAAW,WAAW,YAAY,SAAS;CAC5E,OAAO;EACL,MAAM;EACN,YAAY;GACV;GACA,QAAQ;GACR,SAAS,EAAE,MAAM,MAAM,IAAI,EAAE;GAC7B,WAAW;IAAE,MAAM;IAAU,QAAQ;GAAY;GACjD,WAAW;IAAE,MAAM;IAAU,QAAQ;GAAY;GACjD,QAAQ,EAAE,MAAM,UAAU;GAC1B,UAAU,EAAE,MAAM,UAAU;GAC5B,UAAU,EAAE,MAAM,UAAU;GAC5B,iBAAiB,EAAE,MAAM,SAAS;EACpC;EACA,UAAU;GAAC;GAAM;GAAU;GAAW;GAAa;EAAW;CAChE;AACF;AAEA,MAAM,0BAA0B,UAAgC;CAC9D,MAAM;CACN,YAAY;EACV,MAAM;GAAE,MAAM;GAAS,OAAO,EAAE,MAAM,MAAM,GAAG,KAAK,QAAQ,EAAE;EAAE;EAChE,WAAW,EAAE,MAAM,UAAU;EAC7B,OAAO,EAAE,MAAM,UAAU;EACzB,YAAY,EAAE,MAAM,UAAU;EAC9B,MAAM,EAAE,MAAM,UAAU;EACxB,eAAe,EAAE,MAAM,UAAU;EACjC,aAAa,EAAE,MAAM,UAAU;EAC/B,aAAa,EAAE,MAAM,UAAU;EAC/B,UAAU,aAAa,SAAS;EAChC,UAAU,aAAa,SAAS;CAClC;AACF;AAOA,MAAa,2BAA2B,EACtC,SACA,MACA,cAKqB;CACrB,SAAS,mBAAmB,SAAS,MAAM;CAC3C,aAAa,uBAAuB,IAAI;AAC1C;AAEA,MAAM,cAAc,UAAmC,EACrD,MAAM,MAAM,GAAG,KAAK,QAAQ,EAC9B;AACA,MAAM,kBAAkB,UAAmC,EACzD,MAAM,MAAM,GAAG,KAAK,YAAY,EAClC;AAEA,MAAM,qBAAqB,EACzB,MACA,KACA,WAKuB;CACvB,MAAM,IAAI,MAAM,IAAI,IAAI;CACxB,OAAO;EACL;GAAE,MAAM;GAAQ,IAAI;GAAS,QAAQ,EAAE,MAAM,UAAU;EAAE;EACzD;GAAE,MAAM;GAAS,IAAI;GAAS,QAAQ,EAAE,MAAM,UAAU;EAAE;EAC1D;GAAE,MAAM;GAAc,IAAI;GAAS,QAAQ,EAAE,MAAM,UAAU;EAAE;EAC/D;GACE,MAAM;GACN,IAAI;GACJ,aAAa,EAAE,gBAAgB;GAC/B,QAAQ,EAAE,MAAM,SAAS;EAC3B;EACA,GAAG,iBAAiB;GAAE;GAAM;GAAK;EAAK,CAAC;EACvC;GACE,MAAM;GACN,IAAI;GACJ,aAAa,EAAE,cAAc;GAC7B,SAAS,EACP,oBAAoB,EAAE,QAAQ;IAAE,MAAM;IAAU,sBAAsB;GAAK,EAAE,EAC/E;EACF;CACF;AACF;AAEA,MAAa,qBAAqB,EAChC,QACA,UACA,KACA,YACA,YACA,WAAW,CAAC,GACZ,SAAS,YASQ;CACjB,IAAI,CAAC,OAAO,UAAU,OAAO,CAAC;CAE9B,MAAM,IAAI,MAAM,IAAI,IAAI;CACxB,MAAM,OAAO,cAAc,WAAW,OAAO,IAAI;CACjD,MAAM,cAAc,CAAC,aAAa,gBAAgB,IAAI,IAAI,IAAI;CAC9D,MAAM,eAAe,kBAAkB;EAAE,QAAQ,OAAO;EAAQ;CAAI,CAAC;CACrE,MAAM,OAAsB;EAC1B,QAAQ;EACR,UAAU,QAAQ,aAAa,QAAQ;EACvC,OAAO,QAAQ,aAAa,KAAK;CACnC;CACA,MAAM,UAA2B;EAC/B,MAAM;EACN,IAAI;EACJ,UAAU;EACV,QAAQ,EAAE,MAAM,IAAI,kBAAkB,WAAW,YAAY,SAAS;CACxE;CAEA,MAAM,UAAwB,EAAE,MAAM,SAAS;CAC/C,MAAM,kBAAgC,SAClC;EAAE,MAAM;EAAU,YAAY;GAAE;GAAS,KAAK,EAAE,MAAM,MAAM,IAAI,EAAE;EAAE;CAAE,IACtE,EAAE,OAAO,CAAC,EAAE,MAAM,MAAM,IAAI,EAAE,GAAG;EAAE,MAAM;EAAU,YAAY,EAAE,QAAQ;CAAE,CAAC,EAAE;CAElF,OAAO;GACJ,GAAG,SAAS,aAAa,EACxB,KAAK;GACH,MAAM;GACN,aAAa,OAAO,KAAK;GACzB,YAAY,kBAAkB;IAAE,MAAM;IAAM;IAAK;GAAK,CAAC;GACvD,WAAW;IACT,OAAO,aAAa,EAAE,aAAa,GAAG,eAAe,IAAI,CAAC;IAC1D,GAAG,eAAe,OAAO,aAAa,CAAC;GACzC;GACA,UAAU,SAAS;EACrB,EACF;GACC,GAAG,SAAS,kBAAkB;GAC7B,YAAY,CAAC,OAAO;GACpB,KAAK;IACH,MAAM;IACN,aAAa,OAAO,KAAK;IACzB,YAAY,iBAAiB;KAAE,MAAM;KAAM;KAAK;IAAK,CAAC;IACtD,WAAW;KACT,OAAO,aAAa,EAAE,eAAe,GAAG,WAAW,IAAI,CAAC;KACxD,GAAG,eAAe,OAAO,aAAa,CAAC;IACzC;IACA,UAAU,SAAS;GACrB;GACA,MAAM;IACJ,MAAM;IACN,aAAa,UAAU,KAAK;IAC5B,YAAY,CACV;KAAE,MAAM;KAAS,IAAI;KAAS,QAAQ,EAAE,MAAM,UAAU;IAAE,GAC1D;KAAE,MAAM;KAAS,IAAI;KAAS,QAAQ,EAAE,MAAM,UAAU;IAAE,CAC5D;IACA,WAAW;KACT,OAAO,aAAa,EAAE,iBAAiB,GAAG,eAAe;KACzD,GAAG,eAAe,OAAO,gBAAgB,CAAC;IAC5C;IACA,UAAU,SAAS;GACrB;EACF;CACF;AACF"}

package/dist/server/spec/security.d.ts

@@ -0,0 +1,33 @@
+import { Entity, EntityOperation, EntitySecurityOverride, OperationKind, SecurityOption } from "../../shared/types/index.js";
+import { Access, SanitizedConfig } from "payload";
+import { PathsObject, SecurityRequirementObject } from "@scalar/openapi-types/3.2";
+export declare const securedRequirement: (login?: boolean) => SecurityRequirementObject[];
+type ProbedOperation = EntityOperation | 'readVersions';
+export type EntitySecurity = Partial<Record<ProbedOperation, SecurityRequirementObject[] | undefined>>;
+export declare const evaluateAccess: (access: Access | undefined, opts?: {
+  locale?: string;
+  timeoutMs?: number;
+  baseAccess?: SanitizedConfig['baseAccess'];
+}) => Promise<boolean>;
+export declare const readSecurityOverride: (entity: {
+  slug: string;
+  custom?: {
+    openapi?: {
+      security?: unknown;
+    };
+  };
+}) => EntitySecurityOverride | undefined;
+export declare const resolveEntitySecurity: ({ entity, operations, locale, baseAccess }: {
+  entity: Entity;
+  operations: ProbedOperation[];
+  locale?: string;
+  baseAccess?: SanitizedConfig['baseAccess'];
+}) => Promise<EntitySecurity>;
+export declare const applySecurity: ({ paths, slug, kind, security, login }: {
+  paths: PathsObject;
+  slug?: string;
+  kind: OperationKind;
+  security?: SecurityOption;
+  login?: boolean;
+}) => Promise<PathsObject>;
+//# sourceMappingURL=security.d.ts.map

package/dist/server/spec/security.js

@@ -0,0 +1,97 @@
+import { isPlainObject } from "../../shared/utils.js";
+import { INTERACTIVE_SCHEME_NAME, SECURITY_SCHEME_NAME } from "./components.js";
+import { PLUGIN_NAME } from "../../shared/constants.js";
+const HTTP_METHODS = [
+	"get",
+	"post",
+	"patch",
+	"put",
+	"delete"
+];
+const securedRequirement = (login = false) => login ? [{ [SECURITY_SCHEME_NAME]: [] }, { [INTERACTIVE_SCHEME_NAME]: [] }] : [{ [SECURITY_SCHEME_NAME]: [] }];
+const OVERRIDE_FALLBACK = {
+	readVersions: "read",
+	validate: "update"
+};
+const withTimeout = async (promise, timeoutMs) => {
+	let timer;
+	const guard = new Promise((resolve) => {
+		timer = setTimeout(() => resolve(false), timeoutMs);
+	});
+	try {
+		return await Promise.race([promise.then((value) => value === true, () => false), guard]);
+	} finally {
+		if (timer) clearTimeout(timer);
+	}
+};
+const evaluateAccess = async (access, opts = {}) => {
+	if (!access) return false;
+	const { locale, timeoutMs = 250, baseAccess } = opts;
+	const trap = (allowed, value) => new Proxy({}, { get(_target, key) {
+		if (key === allowed) return value;
+		throw new Error("req.payload accessed during build");
+	} });
+	const payloadTrap = trap("config", trap("baseAccess", baseAccess));
+	const req = {
+		user: null,
+		headers: new Headers(),
+		context: {},
+		locale,
+		payload: payloadTrap
+	};
+	try {
+		const result = access({ req });
+		if (result && typeof result.then === "function") return await withTimeout(result, timeoutMs);
+		return result === true;
+	} catch {
+		return false;
+	}
+};
+const readSecurityOverride = (entity) => {
+	const meta = entity.custom?.openapi?.security;
+	if ((isPlainObject(meta) ? Object.values(meta) : [meta]).some((value) => typeof value === "boolean")) throw new Error(`[${PLUGIN_NAME}] custom.openapi.security true/false on "${entity.slug}" was removed, use 'public' or 'secured'`);
+	return meta === void 0 ? void 0 : meta;
+};
+const overrideFor = (override, op) => {
+	const fallback = OVERRIDE_FALLBACK[op];
+	const marking = typeof override === "string" ? override : override?.[op] ?? (fallback ? override?.[fallback] : void 0);
+	return marking === void 0 ? void 0 : marking === "public";
+};
+const resolveEntitySecurity = async ({ entity, operations, locale, baseAccess }) => {
+	const override = readSecurityOverride(entity);
+	const access = entity.access;
+	const out = {};
+	for (const op of operations) out[op] = overrideFor(override, op) ?? await evaluateAccess(access?.[op], {
+		locale,
+		baseAccess
+	}) ? void 0 : securedRequirement();
+	return out;
+};
+const withLogin = (security) => security.some((r) => "PayloadToken" in r) && !security.some((r) => "PayloadLogin" in r) ? [...security, { [INTERACTIVE_SCHEME_NAME]: [] }] : security;
+const applySecurity = async ({ paths, slug, kind, security, login = false }) => {
+	if (!security && !login) return paths;
+	for (const [path, item] of Object.entries(paths)) {
+		if (!item) continue;
+		const ops = item;
+		for (const method of HTTP_METHODS) {
+			const op = ops[method];
+			if (!op) continue;
+			if (login && op.security) op.security = withLogin(op.security);
+			if (!security) continue;
+			const decision = await security({
+				method,
+				path,
+				slug,
+				kind,
+				detected: op.security?.length ? "secured" : "public"
+			});
+			if (decision === "public") delete op.security;
+			else if (decision === "secured") op.security = securedRequirement(login);
+			else if (Array.isArray(decision)) op.security = decision;
+		}
+	}
+	return paths;
+};
+export { applySecurity, evaluateAccess, readSecurityOverride, resolveEntitySecurity, securedRequirement };
+
+//# sourceMappingURL=security.js.map

package/dist/server/spec/security.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"security.js","names":[],"sources":["../../../src/server/spec/security.ts"],"sourcesContent":["import type { PathsObject, SecurityRequirementObject } from '@scalar/openapi-types/3.2'\nimport type { Access, SanitizedConfig } from 'payload'\n\nimport { PLUGIN_NAME } from '@/shared/constants.js'\nimport type {\n  Entity,\n  EntityOperation,\n  EntitySecurityOverride,\n  HttpMethod,\n  OperationKind,\n  SecurityOption,\n} from '@/shared/types/index.js'\nimport { isPlainObject } from '@/shared/utils.js'\n\nimport { INTERACTIVE_SCHEME_NAME, SECURITY_SCHEME_NAME } from './components.js'\n\nconst HTTP_METHODS: HttpMethod[] = ['get', 'post', 'patch', 'put', 'delete']\n\nexport const securedRequirement = (login = false): SecurityRequirementObject[] =>\n  login ? [{ [SECURITY_SCHEME_NAME]: [] }, { [INTERACTIVE_SCHEME_NAME]: [] }] : [{ [SECURITY_SCHEME_NAME]: [] }]\n\ntype ProbedOperation = EntityOperation | 'readVersions'\n\nconst OVERRIDE_FALLBACK: Partial<Record<ProbedOperation, EntityOperation>> = {\n  readVersions: 'read',\n  validate: 'update',\n}\n\nexport type EntitySecurity = Partial<Record<ProbedOperation, SecurityRequirementObject[] | undefined>>\n\nconst withTimeout = async (promise: Promise<unknown>, timeoutMs: number): Promise<boolean> => {\n  let timer: ReturnType<typeof setTimeout> | undefined\n  const guard = new Promise<false>((resolve) => {\n    timer = setTimeout(() => resolve(false), timeoutMs)\n  })\n  try {\n    return await Promise.race([\n      promise.then(\n        (value) => value === true,\n        () => false,\n      ),\n      guard,\n    ])\n  } finally {\n    if (timer) clearTimeout(timer)\n  }\n}\n\nexport const evaluateAccess = async (\n  access: Access | undefined,\n  opts: { locale?: string; timeoutMs?: number; baseAccess?: SanitizedConfig['baseAccess'] } = {},\n): Promise<boolean> => {\n  if (!access) return false\n  const { locale, timeoutMs = 250, baseAccess } = opts\n  const trap = <T extends object>(allowed: PropertyKey, value: unknown): T =>\n    new Proxy({} as T, {\n      get(_target, key) {\n        if (key === allowed) return value\n        throw new Error('req.payload accessed during build')\n      },\n    })\n  const payloadTrap = trap('config', trap('baseAccess', baseAccess))\n  const req = { user: null, headers: new Headers(), context: {}, locale, payload: payloadTrap }\n  try {\n    const result = access({ req } as never)\n    if (result && typeof (result as Promise<unknown>).then === 'function') {\n      return await withTimeout(result as Promise<unknown>, timeoutMs)\n    }\n    return result === true\n  } catch {\n    return false\n  }\n}\n\nexport const readSecurityOverride = (entity: {\n  slug: string\n  custom?: { openapi?: { security?: unknown } }\n}): EntitySecurityOverride | undefined => {\n  const meta = entity.custom?.openapi?.security\n  const values = isPlainObject(meta) ? Object.values(meta) : [meta]\n  if (values.some((value) => typeof value === 'boolean')) {\n    throw new Error(\n      `[${PLUGIN_NAME}] custom.openapi.security true/false on \"${entity.slug}\" was removed, use 'public' or 'secured'`,\n    )\n  }\n  return meta === undefined ? undefined : (meta as EntitySecurityOverride)\n}\n\nconst overrideFor = (override: EntitySecurityOverride | undefined, op: ProbedOperation): boolean | undefined => {\n  const fallback = OVERRIDE_FALLBACK[op]\n  const marking =\n    typeof override === 'string'\n      ? override\n      : (override?.[op as EntityOperation] ?? (fallback ? override?.[fallback] : undefined))\n  return marking === undefined ? undefined : marking === 'public'\n}\n\nexport const resolveEntitySecurity = async ({\n  entity,\n  operations,\n  locale,\n  baseAccess,\n}: {\n  entity: Entity\n  operations: ProbedOperation[]\n  locale?: string\n  baseAccess?: SanitizedConfig['baseAccess']\n}): Promise<EntitySecurity> => {\n  const override = readSecurityOverride(entity)\n  const access = entity.access as Partial<Record<ProbedOperation, Access>> | undefined\n  const out: EntitySecurity = {}\n  for (const op of operations) {\n    const declared = overrideFor(override, op)\n    const isPublic = declared ?? (await evaluateAccess(access?.[op], { locale, baseAccess }))\n    out[op] = isPublic ? undefined : securedRequirement()\n  }\n  return out\n}\n\nconst withLogin = (security: SecurityRequirementObject[]): SecurityRequirementObject[] =>\n  security.some((r) => SECURITY_SCHEME_NAME in r) && !security.some((r) => INTERACTIVE_SCHEME_NAME in r)\n    ? [...security, { [INTERACTIVE_SCHEME_NAME]: [] }]\n    : security\n\nexport const applySecurity = async ({\n  paths,\n  slug,\n  kind,\n  security,\n  login = false,\n}: {\n  paths: PathsObject\n  slug?: string\n  kind: OperationKind\n  security?: SecurityOption\n  login?: boolean\n}): Promise<PathsObject> => {\n  if (!security && !login) return paths\n  for (const [path, item] of Object.entries(paths)) {\n    if (!item) continue\n    const ops = item as Record<HttpMethod, { security?: SecurityRequirementObject[] } | undefined>\n    for (const method of HTTP_METHODS) {\n      const op = ops[method]\n      if (!op) continue\n      if (login && op.security) op.security = withLogin(op.security)\n      if (!security) continue\n      const detected = op.security?.length ? 'secured' : 'public'\n      const decision = await security({ method, path, slug, kind, detected })\n      if (decision === 'public') delete op.security\n      else if (decision === 'secured') op.security = securedRequirement(login)\n      else if (Array.isArray(decision)) op.security = decision\n    }\n  }\n  return paths\n}\n"],"mappings":";;;AAgBA,MAAM,eAA6B;CAAC;CAAO;CAAQ;CAAS;CAAO;AAAQ;AAE3E,MAAa,sBAAsB,QAAQ,UACzC,QAAQ,CAAC,GAAG,uBAAuB,CAAC,EAAE,GAAG,GAAG,0BAA0B,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAC;AAI/G,MAAM,oBAAuE;CAC3E,cAAc;CACd,UAAU;AACZ;AAIA,MAAM,cAAc,OAAO,SAA2B,cAAwC;CAC5F,IAAI;CACJ,MAAM,QAAQ,IAAI,SAAgB,YAAY;EAC5C,QAAQ,iBAAiB,QAAQ,KAAK,GAAG,SAAS;CACpD,CAAC;CACD,IAAI;EACF,OAAO,MAAM,QAAQ,KAAK,CACxB,QAAQ,MACL,UAAU,UAAU,YACf,KACR,GACA,KACF,CAAC;CACH,UAAU;EACR,IAAI,OAAO,aAAa,KAAK;CAC/B;AACF;AAEA,MAAa,iBAAiB,OAC5B,QACA,OAA4F,CAAC,MACxE;CACrB,IAAI,CAAC,QAAQ,OAAO;CACpB,MAAM,EAAE,QAAQ,YAAY,KAAK,eAAe;CAChD,MAAM,QAA0B,SAAsB,UACpD,IAAI,MAAM,CAAC,GAAQ,EACjB,IAAI,SAAS,KAAK;EAChB,IAAI,QAAQ,SAAS,OAAO;EAC5B,MAAM,IAAI,MAAM,mCAAmC;CACrD,EACF,CAAC;CACH,MAAM,cAAc,KAAK,UAAU,KAAK,cAAc,UAAU,CAAC;CACjE,MAAM,MAAM;EAAE,MAAM;EAAM,SAAS,IAAI,QAAQ;EAAG,SAAS,CAAC;EAAG;EAAQ,SAAS;CAAY;CAC5F,IAAI;EACF,MAAM,SAAS,OAAO,EAAE,IAAI,CAAU;EACtC,IAAI,UAAU,OAAQ,OAA4B,SAAS,YACzD,OAAO,MAAM,YAAY,QAA4B,SAAS;EAEhE,OAAO,WAAW;CACpB,QAAQ;EACN,OAAO;CACT;AACF;AAEA,MAAa,wBAAwB,WAGK;CACxC,MAAM,OAAO,OAAO,QAAQ,SAAS;CAErC,KADe,cAAc,IAAI,IAAI,OAAO,OAAO,IAAI,IAAI,CAAC,IAAI,EAAA,CACrD,MAAM,UAAU,OAAO,UAAU,SAAS,GACnD,MAAM,IAAI,MACR,IAAI,YAAY,2CAA2C,OAAO,KAAK,yCACzE;CAEF,OAAO,SAAS,KAAA,IAAY,KAAA,IAAa;AAC3C;AAEA,MAAM,eAAe,UAA8C,OAA6C;CAC9G,MAAM,WAAW,kBAAkB;CACnC,MAAM,UACJ,OAAO,aAAa,WAChB,WACC,WAAW,QAA2B,WAAW,WAAW,YAAY,KAAA;CAC/E,OAAO,YAAY,KAAA,IAAY,KAAA,IAAY,YAAY;AACzD;AAEA,MAAa,wBAAwB,OAAO,EAC1C,QACA,YACA,QACA,iBAM6B;CAC7B,MAAM,WAAW,qBAAqB,MAAM;CAC5C,MAAM,SAAS,OAAO;CACtB,MAAM,MAAsB,CAAC;CAC7B,KAAK,MAAM,MAAM,YAGf,IAAI,MAFa,YAAY,UAAU,EACf,KAAM,MAAM,eAAe,SAAS,KAAK;EAAE;EAAQ;CAAW,CAAC,IAClE,KAAA,IAAY,mBAAmB;CAEtD,OAAO;AACT;AAEA,MAAM,aAAa,aACjB,SAAS,MAAM,MAAA,kBAA8B,CAAC,KAAK,CAAC,SAAS,MAAM,MAAA,kBAAiC,CAAC,IACjG,CAAC,GAAG,UAAU,GAAG,0BAA0B,CAAC,EAAE,CAAC,IAC/C;AAEN,MAAa,gBAAgB,OAAO,EAClC,OACA,MACA,MACA,UACA,QAAQ,YAOkB;CAC1B,IAAI,CAAC,YAAY,CAAC,OAAO,OAAO;CAChC,KAAK,MAAM,CAAC,MAAM,SAAS,OAAO,QAAQ,KAAK,GAAG;EAChD,IAAI,CAAC,MAAM;EACX,MAAM,MAAM;EACZ,KAAK,MAAM,UAAU,cAAc;GACjC,MAAM,KAAK,IAAI;GACf,IAAI,CAAC,IAAI;GACT,IAAI,SAAS,GAAG,UAAU,GAAG,WAAW,UAAU,GAAG,QAAQ;GAC7D,IAAI,CAAC,UAAU;GAEf,MAAM,WAAW,MAAM,SAAS;IAAE;IAAQ;IAAM;IAAM;IAAM,UAD3C,GAAG,UAAU,SAAS,YAAY;GACkB,CAAC;GACtE,IAAI,aAAa,UAAU,OAAO,GAAG;QAChC,IAAI,aAAa,WAAW,GAAG,WAAW,mBAAmB,KAAK;QAClE,IAAI,MAAM,QAAQ,QAAQ,GAAG,GAAG,WAAW;EAClD;CACF;CACA,OAAO;AACT"}

package/dist/server/spec/tags.d.ts

@@ -0,0 +1,34 @@
+import { Translate } from "../../shared/translations/types.js";
+import { TagObject } from "@scalar/openapi-types/3.2";
+export declare const NAV_COLLECTIONS = "Collections";
+export declare const NAV_GLOBALS = "Globals";
+export declare const NAV_SYSTEM = "System";
+export declare const entityTagName: (base: string) => string;
+export declare const authTagName: (base: string) => string;
+export declare const versionsTagName: (base: string) => string;
+declare const SYSTEM_TAG_SUMMARIES: {
+  readonly Jobs: 'tagJobs';
+  readonly Uploads: 'tagUploads';
+  readonly Access: 'tagAccess';
+};
+export type SystemTag = keyof typeof SYSTEM_TAG_SUMMARIES;
+export interface CollectionTagInfo {
+  base: string;
+  hasAuth: boolean;
+  hasVersions: boolean;
+  description?: string;
+}
+export interface GlobalTagInfo {
+  base: string;
+  hasVersions: boolean;
+  description?: string;
+}
+export interface TagHierarchyInput {
+  collections: CollectionTagInfo[];
+  globals: GlobalTagInfo[];
+  systemTags: SystemTag[];
+  t: Translate;
+  nested: boolean;
+}
+export declare const buildTagHierarchy: ({ collections, globals, systemTags, t, nested }: TagHierarchyInput) => TagObject[];
+//# sourceMappingURL=tags.d.ts.map

package/dist/server/spec/tags.js

@@ -0,0 +1,83 @@
+const NAV_COLLECTIONS = "Collections";
+const NAV_GLOBALS = "Globals";
+const NAV_SYSTEM = "System";
+const entityTagName = (base) => base;
+const authTagName = (base) => `${base} Auth`;
+const versionsTagName = (base) => `${base} Versions`;
+const SYSTEM_TAG_SUMMARIES = {
+	Jobs: "tagJobs",
+	Uploads: "tagUploads",
+	Access: "tagAccess"
+};
+const buildTagHierarchy = ({ collections, globals, systemTags, t, nested }) => {
+	if (!nested) return [...collections.map((c) => ({
+		name: entityTagName(c.base),
+		description: c.description
+	})), ...globals.map((g) => ({
+		name: entityTagName(g.base),
+		description: g.description
+	}))];
+	const tags = [];
+	if (collections.length > 0) {
+		tags.push({
+			name: NAV_COLLECTIONS,
+			summary: t("tagCollections"),
+			description: t("tagCollectionsDesc"),
+			kind: "nav"
+		});
+		for (const c of collections) {
+			tags.push({
+				name: entityTagName(c.base),
+				parent: NAV_COLLECTIONS,
+				description: c.description
+			});
+			if (c.hasAuth) tags.push({
+				name: authTagName(c.base),
+				parent: c.base,
+				summary: t("tagAuth")
+			});
+			if (c.hasVersions) tags.push({
+				name: versionsTagName(c.base),
+				parent: c.base,
+				summary: t("tagVersions")
+			});
+		}
+	}
+	if (globals.length > 0) {
+		tags.push({
+			name: NAV_GLOBALS,
+			summary: t("tagGlobals"),
+			description: t("tagGlobalsDesc"),
+			kind: "nav"
+		});
+		for (const g of globals) {
+			tags.push({
+				name: entityTagName(g.base),
+				parent: NAV_GLOBALS,
+				description: g.description
+			});
+			if (g.hasVersions) tags.push({
+				name: versionsTagName(g.base),
+				parent: g.base,
+				summary: t("tagVersions")
+			});
+		}
+	}
+	if (systemTags.length > 0) {
+		tags.push({
+			name: NAV_SYSTEM,
+			summary: t("tagSystem"),
+			description: t("tagSystemDesc"),
+			kind: "nav"
+		});
+		for (const name of systemTags) tags.push({
+			name,
+			parent: NAV_SYSTEM,
+			summary: t(SYSTEM_TAG_SUMMARIES[name])
+		});
+	}
+	return tags;
+};
+export { NAV_COLLECTIONS, NAV_GLOBALS, NAV_SYSTEM, authTagName, buildTagHierarchy, entityTagName, versionsTagName };
+
+//# sourceMappingURL=tags.js.map

package/dist/server/spec/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","names":[],"sources":["../../../src/server/spec/tags.ts"],"sourcesContent":["import type { TagObject } from '@scalar/openapi-types/3.2'\n\nimport type { Translate } from '@/shared/translations/types.js'\n\nexport const NAV_COLLECTIONS = 'Collections'\nexport const NAV_GLOBALS = 'Globals'\nexport const NAV_SYSTEM = 'System'\n\nexport const entityTagName = (base: string): string => base\nexport const authTagName = (base: string): string => `${base} Auth`\nexport const versionsTagName = (base: string): string => `${base} Versions`\n\nconst SYSTEM_TAG_SUMMARIES = { Jobs: 'tagJobs', Uploads: 'tagUploads', Access: 'tagAccess' } as const\n\nexport type SystemTag = keyof typeof SYSTEM_TAG_SUMMARIES\n\nexport interface CollectionTagInfo {\n  base: string\n  hasAuth: boolean\n  hasVersions: boolean\n  description?: string\n}\n\nexport interface GlobalTagInfo {\n  base: string\n  hasVersions: boolean\n  description?: string\n}\n\nexport interface TagHierarchyInput {\n  collections: CollectionTagInfo[]\n  globals: GlobalTagInfo[]\n  systemTags: SystemTag[]\n  t: Translate\n  nested: boolean\n}\n\nexport const buildTagHierarchy = ({ collections, globals, systemTags, t, nested }: TagHierarchyInput): TagObject[] => {\n  if (!nested) {\n    return [\n      ...collections.map((c) => ({ name: entityTagName(c.base), description: c.description })),\n      ...globals.map((g) => ({ name: entityTagName(g.base), description: g.description })),\n    ]\n  }\n\n  const tags: TagObject[] = []\n\n  if (collections.length > 0) {\n    tags.push({\n      name: NAV_COLLECTIONS,\n      summary: t('tagCollections'),\n      description: t('tagCollectionsDesc'),\n      kind: 'nav',\n    })\n    for (const c of collections) {\n      tags.push({ name: entityTagName(c.base), parent: NAV_COLLECTIONS, description: c.description })\n      if (c.hasAuth) tags.push({ name: authTagName(c.base), parent: c.base, summary: t('tagAuth') })\n      if (c.hasVersions) tags.push({ name: versionsTagName(c.base), parent: c.base, summary: t('tagVersions') })\n    }\n  }\n\n  if (globals.length > 0) {\n    tags.push({ name: NAV_GLOBALS, summary: t('tagGlobals'), description: t('tagGlobalsDesc'), kind: 'nav' })\n    for (const g of globals) {\n      tags.push({ name: entityTagName(g.base), parent: NAV_GLOBALS, description: g.description })\n      if (g.hasVersions) tags.push({ name: versionsTagName(g.base), parent: g.base, summary: t('tagVersions') })\n    }\n  }\n\n  if (systemTags.length > 0) {\n    tags.push({ name: NAV_SYSTEM, summary: t('tagSystem'), description: t('tagSystemDesc'), kind: 'nav' })\n    for (const name of systemTags) tags.push({ name, parent: NAV_SYSTEM, summary: t(SYSTEM_TAG_SUMMARIES[name]) })\n  }\n\n  return tags\n}\n"],"mappings":"AAIA,MAAa,kBAAkB;AAC/B,MAAa,cAAc;AAC3B,MAAa,aAAa;AAE1B,MAAa,iBAAiB,SAAyB;AACvD,MAAa,eAAe,SAAyB,GAAG,KAAK;AAC7D,MAAa,mBAAmB,SAAyB,GAAG,KAAK;AAEjE,MAAM,uBAAuB;CAAE,MAAM;CAAW,SAAS;CAAc,QAAQ;AAAY;AAyB3F,MAAa,qBAAqB,EAAE,aAAa,SAAS,YAAY,GAAG,aAA6C;CACpH,IAAI,CAAC,QACH,OAAO,CACL,GAAG,YAAY,KAAK,OAAO;EAAE,MAAM,cAAc,EAAE,IAAI;EAAG,aAAa,EAAE;CAAY,EAAE,GACvF,GAAG,QAAQ,KAAK,OAAO;EAAE,MAAM,cAAc,EAAE,IAAI;EAAG,aAAa,EAAE;CAAY,EAAE,CACrF;CAGF,MAAM,OAAoB,CAAC;CAE3B,IAAI,YAAY,SAAS,GAAG;EAC1B,KAAK,KAAK;GACR,MAAM;GACN,SAAS,EAAE,gBAAgB;GAC3B,aAAa,EAAE,oBAAoB;GACnC,MAAM;EACR,CAAC;EACD,KAAK,MAAM,KAAK,aAAa;GAC3B,KAAK,KAAK;IAAE,MAAM,cAAc,EAAE,IAAI;IAAG,QAAQ;IAAiB,aAAa,EAAE;GAAY,CAAC;GAC9F,IAAI,EAAE,SAAS,KAAK,KAAK;IAAE,MAAM,YAAY,EAAE,IAAI;IAAG,QAAQ,EAAE;IAAM,SAAS,EAAE,SAAS;GAAE,CAAC;GAC7F,IAAI,EAAE,aAAa,KAAK,KAAK;IAAE,MAAM,gBAAgB,EAAE,IAAI;IAAG,QAAQ,EAAE;IAAM,SAAS,EAAE,aAAa;GAAE,CAAC;EAC3G;CACF;CAEA,IAAI,QAAQ,SAAS,GAAG;EACtB,KAAK,KAAK;GAAE,MAAM;GAAa,SAAS,EAAE,YAAY;GAAG,aAAa,EAAE,gBAAgB;GAAG,MAAM;EAAM,CAAC;EACxG,KAAK,MAAM,KAAK,SAAS;GACvB,KAAK,KAAK;IAAE,MAAM,cAAc,EAAE,IAAI;IAAG,QAAQ;IAAa,aAAa,EAAE;GAAY,CAAC;GAC1F,IAAI,EAAE,aAAa,KAAK,KAAK;IAAE,MAAM,gBAAgB,EAAE,IAAI;IAAG,QAAQ,EAAE;IAAM,SAAS,EAAE,aAAa;GAAE,CAAC;EAC3G;CACF;CAEA,IAAI,WAAW,SAAS,GAAG;EACzB,KAAK,KAAK;GAAE,MAAM;GAAY,SAAS,EAAE,WAAW;GAAG,aAAa,EAAE,eAAe;GAAG,MAAM;EAAM,CAAC;EACrG,KAAK,MAAM,QAAQ,YAAY,KAAK,KAAK;GAAE;GAAM,QAAQ;GAAY,SAAS,EAAE,qBAAqB,KAAK;EAAE,CAAC;CAC/G;CAEA,OAAO;AACT"}