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

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

@@ -0,0 +1,314 @@
+import { createSchemaName, listSchemaName, refTo, schemaName, updateSchemaName } from "../names.js";
+import { ERRORS, docAccessOperation, errorResponses, jsonOk, jsonResponse, uploadRequestBody, validateOperation } from "../components.js";
+import { makeT } from "../../../shared/translations/index.js";
+import { buildListParams, buildParamSchemas, commonReadParams, validateParams, writeParams } from "../params.js";
+const buildCollectionPaths = ({ collection, ctx, security = {}, access = false }) => {
+	const t = makeT(ctx.i18n);
+	const name = schemaName(collection.slug);
+	const base = `${ctx.apiRoute}/${collection.slug}`;
+	const docRef = { $ref: refTo(name) };
+	const listRef = { $ref: refTo(listSchemaName(name)) };
+	const createRef = { $ref: refTo(createSchemaName(name)) };
+	const updateRef = { $ref: refTo(updateSchemaName(name)) };
+	const idType = ctx.defaultIDType === "number" ? "integer" : "string";
+	const { read: secRead, create: secCreate, update: secUpdate, delete: secDelete, validate: secValidate } = security;
+	const allowBulk = collection.disableBulkEdit !== true;
+	const allowDuplicate = collection.disableDuplicate !== true;
+	const paramSchemas = buildParamSchemas({
+		fields: collection.fields,
+		ctx
+	});
+	const refs = {
+		select: true,
+		populate: Boolean(paramSchemas.populate),
+		joins: Boolean(paramSchemas.joins)
+	};
+	const isUpload = Boolean(collection.upload);
+	const fileRequiredOnCreate = typeof collection.upload === "object" ? collection.upload.filesRequiredOnCreate !== false : true;
+	const requestBody = (ref, fileRequired) => isUpload ? uploadRequestBody({
+		bodyRef: ref,
+		fileRequired,
+		t
+	}) : { content: { "application/json": { schema: ref } } };
+	const mutationSchema = {
+		type: "object",
+		properties: {
+			message: { type: "string" },
+			doc: docRef
+		}
+	};
+	const listResponse = {
+		...jsonOk(t("collectionList"), listRef),
+		...errorResponses(ERRORS.list, t)
+	};
+	const findByIdResponse = {
+		...jsonOk(t("collectionDoc"), docRef),
+		...errorResponses(ERRORS.read, t)
+	};
+	const createResponse = {
+		"201": jsonResponse(t("collectionCreated"), mutationSchema),
+		...errorResponses(ERRORS.create, t)
+	};
+	const updateResponse = {
+		...jsonOk(t("collectionUpdated"), mutationSchema),
+		...errorResponses(ERRORS.update, t)
+	};
+	const deleteResponse = {
+		...jsonOk(t("collectionDeleted"), mutationSchema),
+		...errorResponses(ERRORS.delete, t)
+	};
+	const bulkSchema = {
+		type: "object",
+		properties: {
+			message: { type: "string" },
+			docs: {
+				type: "array",
+				items: docRef
+			},
+			errors: {
+				type: "array",
+				items: {
+					type: "object",
+					properties: {
+						message: { type: "string" },
+						id: { type: idType }
+					}
+				}
+			}
+		}
+	};
+	const bulkUpdateResponse = {
+		...jsonOk(t("collectionBulkUpdate"), bulkSchema),
+		...errorResponses(ERRORS.update, t)
+	};
+	const bulkDeleteResponse = {
+		...jsonOk(t("collectionBulkDelete"), bulkSchema),
+		...errorResponses(ERRORS.delete, t)
+	};
+	const countResponse = {
+		...jsonOk(t("collectionCount"), {
+			type: "object",
+			properties: { totalDocs: { type: "integer" } }
+		}),
+		...errorResponses(ERRORS.list, t)
+	};
+	const listParams = buildListParams({
+		base: name,
+		fields: collection.fields,
+		ctx,
+		refs
+	});
+	const bulkParams = listParams.filter((p) => p.name === "where");
+	const bulkUpdateParams = listParams.filter((p) => [
+		"limit",
+		"sort",
+		"where"
+	].includes(p.name));
+	const write = (operation) => writeParams({
+		base: name,
+		entity: collection,
+		ctx,
+		refs,
+		operation
+	});
+	const deleteParams = write("delete");
+	const bulkOps = allowBulk ? {
+		patch: {
+			tags: [name],
+			operationId: `update${name}`,
+			parameters: [...bulkUpdateParams, ...write("update")],
+			requestBody: requestBody(updateRef, false),
+			responses: bulkUpdateResponse,
+			security: secUpdate
+		},
+		delete: {
+			tags: [name],
+			operationId: `delete${name}`,
+			parameters: [...bulkParams, ...deleteParams],
+			responses: bulkDeleteResponse,
+			security: secDelete
+		}
+	} : {};
+	const paths = {
+		[base]: {
+			get: {
+				tags: [name],
+				operationId: `find${name}`,
+				parameters: buildListParams({
+					base: name,
+					fields: collection.fields,
+					ctx,
+					refs
+				}),
+				responses: listResponse,
+				security: secRead
+			},
+			post: {
+				tags: [name],
+				operationId: `create${name}`,
+				parameters: write("create"),
+				requestBody: requestBody(createRef, fileRequiredOnCreate),
+				responses: createResponse,
+				security: secCreate
+			},
+			...bulkOps
+		},
+		[`${base}/count`]: { get: {
+			tags: [name],
+			operationId: `count${name}`,
+			parameters: bulkParams,
+			responses: countResponse,
+			security: secRead
+		} },
+		[`${base}/validate`]: { post: validateOperation({
+			tag: name,
+			operationId: `validate${name}`,
+			parameters: validateParams(ctx),
+			requestBody: {
+				...requestBody(createRef, false),
+				required: true
+			},
+			errors: ERRORS.create,
+			security: secValidate,
+			t
+		}) },
+		[`${base}/{id}`]: {
+			parameters: [{
+				name: "id",
+				in: "path",
+				required: true,
+				schema: { type: idType }
+			}],
+			get: {
+				tags: [name],
+				operationId: `find${name}ById`,
+				parameters: commonReadParams({
+					base: name,
+					ctx,
+					refs
+				}),
+				responses: findByIdResponse,
+				security: secRead
+			},
+			patch: {
+				tags: [name],
+				operationId: `update${name}ById`,
+				parameters: write("updateByID"),
+				requestBody: requestBody(updateRef, false),
+				responses: updateResponse,
+				security: secUpdate
+			},
+			delete: {
+				tags: [name],
+				operationId: `delete${name}ById`,
+				parameters: deleteParams,
+				responses: deleteResponse,
+				security: secDelete
+			}
+		}
+	};
+	paths[`${base}/{id}/validate`] = {
+		parameters: [{
+			name: "id",
+			in: "path",
+			required: true,
+			schema: { type: idType }
+		}],
+		post: validateOperation({
+			tag: name,
+			operationId: `validate${name}ById`,
+			parameters: validateParams(ctx),
+			requestBody: requestBody(updateRef, false),
+			errors: ERRORS.update,
+			security: secValidate,
+			t
+		})
+	};
+	if (allowDuplicate) paths[`${base}/{id}/duplicate`] = {
+		parameters: [{
+			name: "id",
+			in: "path",
+			required: true,
+			schema: { type: idType }
+		}],
+		post: {
+			tags: [name],
+			operationId: `duplicate${name}`,
+			parameters: write("duplicate"),
+			responses: {
+				...jsonOk(t("collectionDuplicated"), mutationSchema),
+				...errorResponses(ERRORS.create, t)
+			},
+			security: secCreate
+		}
+	};
+	if (access) {
+		const auth = collection.auth;
+		const operations = [
+			"create",
+			"read",
+			"update",
+			"delete",
+			"validate",
+			...auth && auth.maxLoginAttempts ? ["unlock"] : [],
+			...collection.versions ? ["readVersions"] : []
+		];
+		const accessOp = (operationId, errors) => docAccessOperation({
+			tag: name,
+			operationId,
+			operations,
+			bodyRef: updateRef,
+			errors,
+			t
+		});
+		paths[`${base}/access`] = { post: accessOp(`access${name}`, ["500"]) };
+		paths[`${base}/access/{id}`] = {
+			parameters: [{
+				name: "id",
+				in: "path",
+				required: true,
+				schema: { type: idType }
+			}],
+			post: accessOp(`access${name}ById`, ["404", "500"])
+		};
+	}
+	if (isUpload) {
+		const file = { content: { "*/*": { schema: {
+			type: "string",
+			format: "binary"
+		} } } };
+		paths[`${base}/file/{filename}`] = {
+			parameters: [{
+				name: "filename",
+				in: "path",
+				required: true,
+				schema: { type: "string" }
+			}],
+			get: {
+				tags: [name],
+				operationId: `get${name}File`,
+				responses: {
+					"200": {
+						description: t("fileServe"),
+						...file
+					},
+					"206": {
+						description: t("filePartial"),
+						...file
+					},
+					...errorResponses([
+						"400",
+						"403",
+						"404",
+						"500"
+					], t)
+				},
+				security: secRead
+			}
+		};
+	}
+	return paths;
+};
+export { buildCollectionPaths };
+
+//# sourceMappingURL=collections.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"collections.js","names":[],"sources":["../../../../src/server/spec/paths/collections.ts"],"sourcesContent":["import type {\n  PathsObject,\n  ReferenceObject,\n  RequestBodyObject,\n  ResponsesObject,\n  SchemaObject,\n} from '@scalar/openapi-types/3.2'\nimport type { SanitizedCollectionConfig } from 'payload'\n\nimport {\n  ERRORS,\n  docAccessOperation,\n  errorResponses,\n  jsonOk,\n  jsonResponse,\n  uploadRequestBody,\n  validateOperation,\n} from '@/server/spec/components.js'\nimport { createSchemaName, listSchemaName, refTo, schemaName, updateSchemaName } from '@/server/spec/names.js'\nimport {\n  buildListParams,\n  buildParamSchemas,\n  commonReadParams,\n  type ReadParamRefs,\n  validateParams,\n  writeParams,\n  type WriteOperation,\n} from '@/server/spec/params.js'\nimport type { EntitySecurity } from '@/server/spec/security.js'\nimport { makeT } from '@/shared/translations/index.js'\nimport type { BuildContext } from '@/shared/types/index.js'\n\nexport const buildCollectionPaths = ({\n  collection,\n  ctx,\n  security = {},\n  access = false,\n}: {\n  collection: SanitizedCollectionConfig\n  ctx: BuildContext\n  security?: EntitySecurity\n  access?: boolean\n}): PathsObject => {\n  const t = makeT(ctx.i18n)\n  const name = schemaName(collection.slug)\n  const base = `${ctx.apiRoute}/${collection.slug}`\n  const docRef: ReferenceObject = { $ref: refTo(name) }\n  const listRef: ReferenceObject = { $ref: refTo(listSchemaName(name)) }\n  const createRef: ReferenceObject = { $ref: refTo(createSchemaName(name)) }\n  const updateRef: ReferenceObject = { $ref: refTo(updateSchemaName(name)) }\n  const idType = ctx.defaultIDType === 'number' ? 'integer' : 'string'\n  const { read: secRead, create: secCreate, update: secUpdate, delete: secDelete, validate: secValidate } = security\n\n  const allowBulk = collection.disableBulkEdit !== true\n  const allowDuplicate = collection.disableDuplicate !== true\n\n  const paramSchemas = buildParamSchemas({ fields: collection.fields, ctx })\n  const refs: ReadParamRefs = {\n    select: true,\n    populate: Boolean(paramSchemas.populate),\n    joins: Boolean(paramSchemas.joins),\n  }\n\n  const isUpload = Boolean(collection.upload)\n  const fileRequiredOnCreate =\n    typeof collection.upload === 'object' ? collection.upload.filesRequiredOnCreate !== false : true\n\n  const requestBody = (ref: ReferenceObject, fileRequired: boolean): RequestBodyObject =>\n    isUpload\n      ? uploadRequestBody({ bodyRef: ref, fileRequired, t })\n      : { content: { 'application/json': { schema: ref } } }\n\n  const mutationSchema: SchemaObject = {\n    type: 'object',\n    properties: { message: { type: 'string' }, doc: docRef },\n  }\n\n  const listResponse: ResponsesObject = {\n    ...jsonOk(t('collectionList'), listRef),\n    ...errorResponses(ERRORS.list, t),\n  }\n  const findByIdResponse: ResponsesObject = {\n    ...jsonOk(t('collectionDoc'), docRef),\n    ...errorResponses(ERRORS.read, t),\n  }\n  const createResponse: ResponsesObject = {\n    '201': jsonResponse(t('collectionCreated'), mutationSchema),\n    ...errorResponses(ERRORS.create, t),\n  }\n  const updateResponse: ResponsesObject = {\n    ...jsonOk(t('collectionUpdated'), mutationSchema),\n    ...errorResponses(ERRORS.update, t),\n  }\n  const deleteResponse: ResponsesObject = {\n    ...jsonOk(t('collectionDeleted'), mutationSchema),\n    ...errorResponses(ERRORS.delete, t),\n  }\n\n  const bulkSchema: SchemaObject = {\n    type: 'object',\n    properties: {\n      message: { type: 'string' },\n      docs: { type: 'array', items: docRef },\n      errors: {\n        type: 'array',\n        items: {\n          type: 'object',\n          properties: { message: { type: 'string' }, id: { type: idType } },\n        },\n      },\n    },\n  }\n  const bulkUpdateResponse: ResponsesObject = {\n    ...jsonOk(t('collectionBulkUpdate'), bulkSchema),\n    ...errorResponses(ERRORS.update, t),\n  }\n  const bulkDeleteResponse: ResponsesObject = {\n    ...jsonOk(t('collectionBulkDelete'), bulkSchema),\n    ...errorResponses(ERRORS.delete, t),\n  }\n  const countResponse: ResponsesObject = {\n    ...jsonOk(t('collectionCount'), { type: 'object', properties: { totalDocs: { type: 'integer' } } }),\n    ...errorResponses(ERRORS.list, t),\n  }\n\n  const listParams = buildListParams({ base: name, fields: collection.fields, ctx, refs })\n  const bulkParams = listParams.filter((p) => p.name === 'where')\n  const bulkUpdateParams = listParams.filter((p) => ['limit', 'sort', 'where'].includes(p.name))\n  const write = (operation: WriteOperation) => writeParams({ base: name, entity: collection, ctx, refs, operation })\n  const deleteParams = write('delete')\n\n  const bulkOps = allowBulk\n    ? {\n        patch: {\n          tags: [name],\n          operationId: `update${name}`,\n          parameters: [...bulkUpdateParams, ...write('update')],\n          requestBody: requestBody(updateRef, false),\n          responses: bulkUpdateResponse,\n          security: secUpdate,\n        },\n        delete: {\n          tags: [name],\n          operationId: `delete${name}`,\n          parameters: [...bulkParams, ...deleteParams],\n          responses: bulkDeleteResponse,\n          security: secDelete,\n        },\n      }\n    : {}\n\n  const paths: PathsObject = {\n    [base]: {\n      get: {\n        tags: [name],\n        operationId: `find${name}`,\n        parameters: buildListParams({ base: name, fields: collection.fields, ctx, refs }),\n        responses: listResponse,\n        security: secRead,\n      },\n      post: {\n        tags: [name],\n        operationId: `create${name}`,\n        parameters: write('create'),\n        requestBody: requestBody(createRef, fileRequiredOnCreate),\n        responses: createResponse,\n        security: secCreate,\n      },\n      ...bulkOps,\n    },\n    [`${base}/count`]: {\n      get: {\n        tags: [name],\n        operationId: `count${name}`,\n        parameters: bulkParams,\n        responses: countResponse,\n        security: secRead,\n      },\n    },\n    [`${base}/validate`]: {\n      post: validateOperation({\n        tag: name,\n        operationId: `validate${name}`,\n        parameters: validateParams(ctx),\n        requestBody: { ...requestBody(createRef, false), required: true },\n        errors: ERRORS.create,\n        security: secValidate,\n        t,\n      }),\n    },\n    [`${base}/{id}`]: {\n      parameters: [{ name: 'id', in: 'path', required: true, schema: { type: idType } }],\n      get: {\n        tags: [name],\n        operationId: `find${name}ById`,\n        parameters: commonReadParams({ base: name, ctx, refs }),\n        responses: findByIdResponse,\n        security: secRead,\n      },\n      patch: {\n        tags: [name],\n        operationId: `update${name}ById`,\n        parameters: write('updateByID'),\n        requestBody: requestBody(updateRef, false),\n        responses: updateResponse,\n        security: secUpdate,\n      },\n      delete: {\n        tags: [name],\n        operationId: `delete${name}ById`,\n        parameters: deleteParams,\n        responses: deleteResponse,\n        security: secDelete,\n      },\n    },\n  }\n\n  paths[`${base}/{id}/validate`] = {\n    parameters: [{ name: 'id', in: 'path', required: true, schema: { type: idType } }],\n    post: validateOperation({\n      tag: name,\n      operationId: `validate${name}ById`,\n      parameters: validateParams(ctx),\n      requestBody: requestBody(updateRef, false),\n      errors: ERRORS.update,\n      security: secValidate,\n      t,\n    }),\n  }\n\n  if (allowDuplicate) {\n    paths[`${base}/{id}/duplicate`] = {\n      parameters: [{ name: 'id', in: 'path', required: true, schema: { type: idType } }],\n      post: {\n        tags: [name],\n        operationId: `duplicate${name}`,\n        parameters: write('duplicate'),\n        responses: { ...jsonOk(t('collectionDuplicated'), mutationSchema), ...errorResponses(ERRORS.create, t) },\n        security: secCreate,\n      },\n    }\n  }\n\n  if (access) {\n    const auth = collection.auth\n    const operations = [\n      'create',\n      'read',\n      'update',\n      'delete',\n      'validate',\n      ...(auth && auth.maxLoginAttempts ? ['unlock'] : []),\n      ...(collection.versions ? ['readVersions'] : []),\n    ]\n    const accessOp = (operationId: string, errors: typeof ERRORS.read) =>\n      docAccessOperation({ tag: name, operationId, operations, bodyRef: updateRef, errors, t })\n    paths[`${base}/access`] = { post: accessOp(`access${name}`, ['500']) }\n    paths[`${base}/access/{id}`] = {\n      parameters: [{ name: 'id', in: 'path', required: true, schema: { type: idType } }],\n      post: accessOp(`access${name}ById`, ['404', '500']),\n    }\n  }\n\n  if (isUpload) {\n    const file = { content: { '*/*': { schema: { type: 'string', format: 'binary' } } } } as const\n    paths[`${base}/file/{filename}`] = {\n      parameters: [{ name: 'filename', in: 'path', required: true, schema: { type: 'string' } }],\n      get: {\n        tags: [name],\n        operationId: `get${name}File`,\n        responses: {\n          '200': { description: t('fileServe'), ...file },\n          '206': { description: t('filePartial'), ...file },\n          ...errorResponses(['400', '403', '404', '500'], t),\n        },\n        security: secRead,\n      },\n    }\n  }\n\n  return paths\n}\n"],"mappings":";;;;AAgCA,MAAa,wBAAwB,EACnC,YACA,KACA,WAAW,CAAC,GACZ,SAAS,YAMQ;CACjB,MAAM,IAAI,MAAM,IAAI,IAAI;CACxB,MAAM,OAAO,WAAW,WAAW,IAAI;CACvC,MAAM,OAAO,GAAG,IAAI,SAAS,GAAG,WAAW;CAC3C,MAAM,SAA0B,EAAE,MAAM,MAAM,IAAI,EAAE;CACpD,MAAM,UAA2B,EAAE,MAAM,MAAM,eAAe,IAAI,CAAC,EAAE;CACrE,MAAM,YAA6B,EAAE,MAAM,MAAM,iBAAiB,IAAI,CAAC,EAAE;CACzE,MAAM,YAA6B,EAAE,MAAM,MAAM,iBAAiB,IAAI,CAAC,EAAE;CACzE,MAAM,SAAS,IAAI,kBAAkB,WAAW,YAAY;CAC5D,MAAM,EAAE,MAAM,SAAS,QAAQ,WAAW,QAAQ,WAAW,QAAQ,WAAW,UAAU,gBAAgB;CAE1G,MAAM,YAAY,WAAW,oBAAoB;CACjD,MAAM,iBAAiB,WAAW,qBAAqB;CAEvD,MAAM,eAAe,kBAAkB;EAAE,QAAQ,WAAW;EAAQ;CAAI,CAAC;CACzE,MAAM,OAAsB;EAC1B,QAAQ;EACR,UAAU,QAAQ,aAAa,QAAQ;EACvC,OAAO,QAAQ,aAAa,KAAK;CACnC;CAEA,MAAM,WAAW,QAAQ,WAAW,MAAM;CAC1C,MAAM,uBACJ,OAAO,WAAW,WAAW,WAAW,WAAW,OAAO,0BAA0B,QAAQ;CAE9F,MAAM,eAAe,KAAsB,iBACzC,WACI,kBAAkB;EAAE,SAAS;EAAK;EAAc;CAAE,CAAC,IACnD,EAAE,SAAS,EAAE,oBAAoB,EAAE,QAAQ,IAAI,EAAE,EAAE;CAEzD,MAAM,iBAA+B;EACnC,MAAM;EACN,YAAY;GAAE,SAAS,EAAE,MAAM,SAAS;GAAG,KAAK;EAAO;CACzD;CAEA,MAAM,eAAgC;EACpC,GAAG,OAAO,EAAE,gBAAgB,GAAG,OAAO;EACtC,GAAG,eAAe,OAAO,MAAM,CAAC;CAClC;CACA,MAAM,mBAAoC;EACxC,GAAG,OAAO,EAAE,eAAe,GAAG,MAAM;EACpC,GAAG,eAAe,OAAO,MAAM,CAAC;CAClC;CACA,MAAM,iBAAkC;EACtC,OAAO,aAAa,EAAE,mBAAmB,GAAG,cAAc;EAC1D,GAAG,eAAe,OAAO,QAAQ,CAAC;CACpC;CACA,MAAM,iBAAkC;EACtC,GAAG,OAAO,EAAE,mBAAmB,GAAG,cAAc;EAChD,GAAG,eAAe,OAAO,QAAQ,CAAC;CACpC;CACA,MAAM,iBAAkC;EACtC,GAAG,OAAO,EAAE,mBAAmB,GAAG,cAAc;EAChD,GAAG,eAAe,OAAO,QAAQ,CAAC;CACpC;CAEA,MAAM,aAA2B;EAC/B,MAAM;EACN,YAAY;GACV,SAAS,EAAE,MAAM,SAAS;GAC1B,MAAM;IAAE,MAAM;IAAS,OAAO;GAAO;GACrC,QAAQ;IACN,MAAM;IACN,OAAO;KACL,MAAM;KACN,YAAY;MAAE,SAAS,EAAE,MAAM,SAAS;MAAG,IAAI,EAAE,MAAM,OAAO;KAAE;IAClE;GACF;EACF;CACF;CACA,MAAM,qBAAsC;EAC1C,GAAG,OAAO,EAAE,sBAAsB,GAAG,UAAU;EAC/C,GAAG,eAAe,OAAO,QAAQ,CAAC;CACpC;CACA,MAAM,qBAAsC;EAC1C,GAAG,OAAO,EAAE,sBAAsB,GAAG,UAAU;EAC/C,GAAG,eAAe,OAAO,QAAQ,CAAC;CACpC;CACA,MAAM,gBAAiC;EACrC,GAAG,OAAO,EAAE,iBAAiB,GAAG;GAAE,MAAM;GAAU,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,EAAE;EAAE,CAAC;EAClG,GAAG,eAAe,OAAO,MAAM,CAAC;CAClC;CAEA,MAAM,aAAa,gBAAgB;EAAE,MAAM;EAAM,QAAQ,WAAW;EAAQ;EAAK;CAAK,CAAC;CACvF,MAAM,aAAa,WAAW,QAAQ,MAAM,EAAE,SAAS,OAAO;CAC9D,MAAM,mBAAmB,WAAW,QAAQ,MAAM;EAAC;EAAS;EAAQ;CAAO,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC;CAC7F,MAAM,SAAS,cAA8B,YAAY;EAAE,MAAM;EAAM,QAAQ;EAAY;EAAK;EAAM;CAAU,CAAC;CACjH,MAAM,eAAe,MAAM,QAAQ;CAEnC,MAAM,UAAU,YACZ;EACE,OAAO;GACL,MAAM,CAAC,IAAI;GACX,aAAa,SAAS;GACtB,YAAY,CAAC,GAAG,kBAAkB,GAAG,MAAM,QAAQ,CAAC;GACpD,aAAa,YAAY,WAAW,KAAK;GACzC,WAAW;GACX,UAAU;EACZ;EACA,QAAQ;GACN,MAAM,CAAC,IAAI;GACX,aAAa,SAAS;GACtB,YAAY,CAAC,GAAG,YAAY,GAAG,YAAY;GAC3C,WAAW;GACX,UAAU;EACZ;CACF,IACA,CAAC;CAEL,MAAM,QAAqB;GACxB,OAAO;GACN,KAAK;IACH,MAAM,CAAC,IAAI;IACX,aAAa,OAAO;IACpB,YAAY,gBAAgB;KAAE,MAAM;KAAM,QAAQ,WAAW;KAAQ;KAAK;IAAK,CAAC;IAChF,WAAW;IACX,UAAU;GACZ;GACA,MAAM;IACJ,MAAM,CAAC,IAAI;IACX,aAAa,SAAS;IACtB,YAAY,MAAM,QAAQ;IAC1B,aAAa,YAAY,WAAW,oBAAoB;IACxD,WAAW;IACX,UAAU;GACZ;GACA,GAAG;EACL;GACC,GAAG,KAAK,UAAU,EACjB,KAAK;GACH,MAAM,CAAC,IAAI;GACX,aAAa,QAAQ;GACrB,YAAY;GACZ,WAAW;GACX,UAAU;EACZ,EACF;GACC,GAAG,KAAK,aAAa,EACpB,MAAM,kBAAkB;GACtB,KAAK;GACL,aAAa,WAAW;GACxB,YAAY,eAAe,GAAG;GAC9B,aAAa;IAAE,GAAG,YAAY,WAAW,KAAK;IAAG,UAAU;GAAK;GAChE,QAAQ,OAAO;GACf,UAAU;GACV;EACF,CAAC,EACH;GACC,GAAG,KAAK,SAAS;GAChB,YAAY,CAAC;IAAE,MAAM;IAAM,IAAI;IAAQ,UAAU;IAAM,QAAQ,EAAE,MAAM,OAAO;GAAE,CAAC;GACjF,KAAK;IACH,MAAM,CAAC,IAAI;IACX,aAAa,OAAO,KAAK;IACzB,YAAY,iBAAiB;KAAE,MAAM;KAAM;KAAK;IAAK,CAAC;IACtD,WAAW;IACX,UAAU;GACZ;GACA,OAAO;IACL,MAAM,CAAC,IAAI;IACX,aAAa,SAAS,KAAK;IAC3B,YAAY,MAAM,YAAY;IAC9B,aAAa,YAAY,WAAW,KAAK;IACzC,WAAW;IACX,UAAU;GACZ;GACA,QAAQ;IACN,MAAM,CAAC,IAAI;IACX,aAAa,SAAS,KAAK;IAC3B,YAAY;IACZ,WAAW;IACX,UAAU;GACZ;EACF;CACF;CAEA,MAAM,GAAG,KAAK,mBAAmB;EAC/B,YAAY,CAAC;GAAE,MAAM;GAAM,IAAI;GAAQ,UAAU;GAAM,QAAQ,EAAE,MAAM,OAAO;EAAE,CAAC;EACjF,MAAM,kBAAkB;GACtB,KAAK;GACL,aAAa,WAAW,KAAK;GAC7B,YAAY,eAAe,GAAG;GAC9B,aAAa,YAAY,WAAW,KAAK;GACzC,QAAQ,OAAO;GACf,UAAU;GACV;EACF,CAAC;CACH;CAEA,IAAI,gBACF,MAAM,GAAG,KAAK,oBAAoB;EAChC,YAAY,CAAC;GAAE,MAAM;GAAM,IAAI;GAAQ,UAAU;GAAM,QAAQ,EAAE,MAAM,OAAO;EAAE,CAAC;EACjF,MAAM;GACJ,MAAM,CAAC,IAAI;GACX,aAAa,YAAY;GACzB,YAAY,MAAM,WAAW;GAC7B,WAAW;IAAE,GAAG,OAAO,EAAE,sBAAsB,GAAG,cAAc;IAAG,GAAG,eAAe,OAAO,QAAQ,CAAC;GAAE;GACvG,UAAU;EACZ;CACF;CAGF,IAAI,QAAQ;EACV,MAAM,OAAO,WAAW;EACxB,MAAM,aAAa;GACjB;GACA;GACA;GACA;GACA;GACA,GAAI,QAAQ,KAAK,mBAAmB,CAAC,QAAQ,IAAI,CAAC;GAClD,GAAI,WAAW,WAAW,CAAC,cAAc,IAAI,CAAC;EAChD;EACA,MAAM,YAAY,aAAqB,WACrC,mBAAmB;GAAE,KAAK;GAAM;GAAa;GAAY,SAAS;GAAW;GAAQ;EAAE,CAAC;EAC1F,MAAM,GAAG,KAAK,YAAY,EAAE,MAAM,SAAS,SAAS,QAAQ,CAAC,KAAK,CAAC,EAAE;EACrE,MAAM,GAAG,KAAK,iBAAiB;GAC7B,YAAY,CAAC;IAAE,MAAM;IAAM,IAAI;IAAQ,UAAU;IAAM,QAAQ,EAAE,MAAM,OAAO;GAAE,CAAC;GACjF,MAAM,SAAS,SAAS,KAAK,OAAO,CAAC,OAAO,KAAK,CAAC;EACpD;CACF;CAEA,IAAI,UAAU;EACZ,MAAM,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ;GAAE,MAAM;GAAU,QAAQ;EAAS,EAAE,EAAE,EAAE;EACpF,MAAM,GAAG,KAAK,qBAAqB;GACjC,YAAY,CAAC;IAAE,MAAM;IAAY,IAAI;IAAQ,UAAU;IAAM,QAAQ,EAAE,MAAM,SAAS;GAAE,CAAC;GACzF,KAAK;IACH,MAAM,CAAC,IAAI;IACX,aAAa,MAAM,KAAK;IACxB,WAAW;KACT,OAAO;MAAE,aAAa,EAAE,WAAW;MAAG,GAAG;KAAK;KAC9C,OAAO;MAAE,aAAa,EAAE,aAAa;MAAG,GAAG;KAAK;KAChD,GAAG,eAAe;MAAC;MAAO;MAAO;MAAO;KAAK,GAAG,CAAC;IACnD;IACA,UAAU;GACZ;EACF;CACF;CAEA,OAAO;AACT"}

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

@@ -0,0 +1,10 @@
+import { BuildContext } from "../../../shared/types/index.js";
+import { SanitizedCollectionConfig, SanitizedConfig, SanitizedGlobalConfig } from "payload";
+import { PathsObject } from "@scalar/openapi-types/3.2";
+export declare const buildCustomEndpointPaths: ({ config, collections, globals, ctx }: {
+  config: SanitizedConfig;
+  collections: SanitizedCollectionConfig[];
+  globals: SanitizedGlobalConfig[];
+  ctx: BuildContext;
+}) => PathsObject;
+//# sourceMappingURL=custom.d.ts.map

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

@@ -0,0 +1,42 @@
+const getOpenapiMeta = (endpoint) => {
+	const meta = endpoint.custom?.openapi;
+	return meta && typeof meta === "object" ? meta : void 0;
+};
+const normalizePath = (prefix, path) => {
+	return `${prefix}${path.startsWith("/") ? path : `/${path}`}`.replace(/:([A-Za-z0-9_]+)/g, "{$1}");
+};
+const collect = ({ endpoints, prefix, out }) => {
+	if (!endpoints) return;
+	for (const endpoint of endpoints) {
+		const meta = getOpenapiMeta(endpoint);
+		if (!meta) continue;
+		const path = normalizePath(prefix, endpoint.path);
+		const method = endpoint.method.toLowerCase();
+		out[path] = {
+			...out[path],
+			[method]: { ...meta }
+		};
+	}
+};
+const buildCustomEndpointPaths = ({ config, collections, globals, ctx }) => {
+	const out = {};
+	collect({
+		endpoints: config.endpoints,
+		prefix: ctx.apiRoute,
+		out
+	});
+	for (const collection of collections) collect({
+		endpoints: collection.endpoints,
+		prefix: `${ctx.apiRoute}/${collection.slug}`,
+		out
+	});
+	for (const global of globals) collect({
+		endpoints: global.endpoints,
+		prefix: `${ctx.apiRoute}/globals/${global.slug}`,
+		out
+	});
+	return out;
+};
+export { buildCustomEndpointPaths };
+
+//# sourceMappingURL=custom.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom.js","names":[],"sources":["../../../../src/server/spec/paths/custom.ts"],"sourcesContent":["import type { OperationObject, PathsObject } from '@scalar/openapi-types/3.2'\nimport type { Endpoint, SanitizedCollectionConfig, SanitizedConfig, SanitizedGlobalConfig } from 'payload'\n\nimport type { BuildContext } from '@/shared/types/index.js'\n\nconst getOpenapiMeta = (endpoint: Endpoint): OperationObject | undefined => {\n  const meta = endpoint.custom?.openapi\n  return meta && typeof meta === 'object' ? (meta as OperationObject) : undefined\n}\n\nconst normalizePath = (prefix: string, path: string): string => {\n  const joined = `${prefix}${path.startsWith('/') ? path : `/${path}`}`\n  return joined.replace(/:([A-Za-z0-9_]+)/g, '{$1}')\n}\n\nconst collect = ({\n  endpoints,\n  prefix,\n  out,\n}: {\n  endpoints: Endpoint[] | false | undefined\n  prefix: string\n  out: PathsObject\n}): void => {\n  if (!endpoints) return\n  for (const endpoint of endpoints) {\n    const meta = getOpenapiMeta(endpoint)\n    if (!meta) continue\n    const path = normalizePath(prefix, endpoint.path)\n    const method = endpoint.method.toLowerCase()\n    out[path] = { ...out[path], [method]: { ...meta } }\n  }\n}\n\nexport const buildCustomEndpointPaths = ({\n  config,\n  collections,\n  globals,\n  ctx,\n}: {\n  config: SanitizedConfig\n  collections: SanitizedCollectionConfig[]\n  globals: SanitizedGlobalConfig[]\n  ctx: BuildContext\n}): PathsObject => {\n  const out: PathsObject = {}\n  collect({ endpoints: config.endpoints, prefix: ctx.apiRoute, out })\n  for (const collection of collections) {\n    collect({ endpoints: collection.endpoints, prefix: `${ctx.apiRoute}/${collection.slug}`, out })\n  }\n  for (const global of globals) {\n    collect({ endpoints: global.endpoints, prefix: `${ctx.apiRoute}/globals/${global.slug}`, out })\n  }\n  return out\n}\n"],"mappings":"AAKA,MAAM,kBAAkB,aAAoD;CAC1E,MAAM,OAAO,SAAS,QAAQ;CAC9B,OAAO,QAAQ,OAAO,SAAS,WAAY,OAA2B,KAAA;AACxE;AAEA,MAAM,iBAAiB,QAAgB,SAAyB;CAE9D,OAAO,GADW,SAAS,KAAK,WAAW,GAAG,IAAI,OAAO,IAAI,SAC/C,QAAQ,qBAAqB,MAAM;AACnD;AAEA,MAAM,WAAW,EACf,WACA,QACA,UAKU;CACV,IAAI,CAAC,WAAW;CAChB,KAAK,MAAM,YAAY,WAAW;EAChC,MAAM,OAAO,eAAe,QAAQ;EACpC,IAAI,CAAC,MAAM;EACX,MAAM,OAAO,cAAc,QAAQ,SAAS,IAAI;EAChD,MAAM,SAAS,SAAS,OAAO,YAAY;EAC3C,IAAI,QAAQ;GAAE,GAAG,IAAI;IAAQ,SAAS,EAAE,GAAG,KAAK;EAAE;CACpD;AACF;AAEA,MAAa,4BAA4B,EACvC,QACA,aACA,SACA,UAMiB;CACjB,MAAM,MAAmB,CAAC;CAC1B,QAAQ;EAAE,WAAW,OAAO;EAAW,QAAQ,IAAI;EAAU;CAAI,CAAC;CAClE,KAAK,MAAM,cAAc,aACvB,QAAQ;EAAE,WAAW,WAAW;EAAW,QAAQ,GAAG,IAAI,SAAS,GAAG,WAAW;EAAQ;CAAI,CAAC;CAEhG,KAAK,MAAM,UAAU,SACnB,QAAQ;EAAE,WAAW,OAAO;EAAW,QAAQ,GAAG,IAAI,SAAS,WAAW,OAAO;EAAQ;CAAI,CAAC;CAEhG,OAAO;AACT"}

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

@@ -0,0 +1,11 @@
+import { BuildContext } from "../../../shared/types/index.js";
+import { EntitySecurity } from "../security.js";
+import { SanitizedGlobalConfig } from "payload";
+import { PathsObject } from "@scalar/openapi-types/3.2";
+export declare const buildGlobalPaths: ({ global, ctx, security, access }: {
+  global: SanitizedGlobalConfig;
+  ctx: BuildContext;
+  security?: EntitySecurity;
+  access?: boolean;
+}) => PathsObject;
+//# sourceMappingURL=globals.d.ts.map

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

@@ -0,0 +1,87 @@
+import { globalSchemaName, refTo, updateSchemaName } from "../names.js";
+import { ERRORS, docAccessOperation, errorResponses, jsonOk, validateOperation } from "../components.js";
+import { makeT } from "../../../shared/translations/index.js";
+import { buildParamSchemas, commonReadParams, validateParams, writeParams } from "../params.js";
+const buildGlobalPaths = ({ global, ctx, security = {}, access = false }) => {
+	const t = makeT(ctx.i18n);
+	const name = globalSchemaName(global.slug);
+	const docRef = { $ref: refTo(name) };
+	const updateRef = { $ref: refTo(updateSchemaName(name)) };
+	const { read: secRead, update: secUpdate, validate: secValidate } = security;
+	const paramSchemas = buildParamSchemas({
+		fields: global.fields,
+		ctx
+	});
+	const refs = {
+		select: true,
+		populate: Boolean(paramSchemas.populate),
+		joins: Boolean(paramSchemas.joins)
+	};
+	const paths = {
+		[`${ctx.apiRoute}/globals/${global.slug}`]: {
+			get: {
+				tags: [name],
+				operationId: `find${name}`,
+				parameters: commonReadParams({
+					base: name,
+					ctx,
+					refs
+				}),
+				responses: {
+					...jsonOk(t("globalDoc"), docRef),
+					...errorResponses(ERRORS.globalRead, t)
+				},
+				security: secRead
+			},
+			post: {
+				tags: [name],
+				operationId: `update${name}`,
+				parameters: writeParams({
+					base: name,
+					entity: global,
+					ctx,
+					refs,
+					operation: "globalUpdate"
+				}),
+				requestBody: { content: { "application/json": { schema: updateRef } } },
+				responses: {
+					...jsonOk(t("globalDoc"), {
+						type: "object",
+						properties: {
+							message: { type: "string" },
+							result: docRef
+						}
+					}),
+					...errorResponses(ERRORS.globalUpdate, t)
+				},
+				security: secUpdate
+			}
+		},
+		[`${ctx.apiRoute}/globals/${global.slug}/validate`]: { post: validateOperation({
+			tag: name,
+			operationId: `validate${name}`,
+			parameters: validateParams(ctx),
+			requestBody: { content: { "application/json": { schema: updateRef } } },
+			errors: ERRORS.globalUpdate,
+			security: secValidate,
+			t
+		}) }
+	};
+	if (access) paths[`${ctx.apiRoute}/globals/${global.slug}/access`] = { post: docAccessOperation({
+		tag: name,
+		operationId: `access${name}`,
+		operations: [
+			"read",
+			"update",
+			"validate",
+			...global.versions ? ["readVersions"] : []
+		],
+		bodyRef: updateRef,
+		errors: ["500"],
+		t
+	}) };
+	return paths;
+};
+export { buildGlobalPaths };
+
+//# sourceMappingURL=globals.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"globals.js","names":[],"sources":["../../../../src/server/spec/paths/globals.ts"],"sourcesContent":["import type { PathsObject, ReferenceObject } from '@scalar/openapi-types/3.2'\nimport type { SanitizedGlobalConfig } from 'payload'\n\nimport { ERRORS, docAccessOperation, errorResponses, jsonOk, validateOperation } from '@/server/spec/components.js'\nimport { globalSchemaName, refTo, updateSchemaName } from '@/server/spec/names.js'\nimport {\n  buildParamSchemas,\n  commonReadParams,\n  type ReadParamRefs,\n  validateParams,\n  writeParams,\n} from '@/server/spec/params.js'\nimport type { EntitySecurity } from '@/server/spec/security.js'\nimport { makeT } from '@/shared/translations/index.js'\nimport type { BuildContext } from '@/shared/types/index.js'\n\nexport const buildGlobalPaths = ({\n  global,\n  ctx,\n  security = {},\n  access = false,\n}: {\n  global: SanitizedGlobalConfig\n  ctx: BuildContext\n  security?: EntitySecurity\n  access?: boolean\n}): PathsObject => {\n  const t = makeT(ctx.i18n)\n  const name = globalSchemaName(global.slug)\n  const docRef: ReferenceObject = { $ref: refTo(name) }\n  const updateRef: ReferenceObject = { $ref: refTo(updateSchemaName(name)) }\n  const { read: secRead, update: secUpdate, validate: secValidate } = security\n\n  const paramSchemas = buildParamSchemas({ fields: global.fields, ctx })\n  const refs: ReadParamRefs = {\n    select: true,\n    populate: Boolean(paramSchemas.populate),\n    joins: Boolean(paramSchemas.joins),\n  }\n\n  const paths: PathsObject = {\n    [`${ctx.apiRoute}/globals/${global.slug}`]: {\n      get: {\n        tags: [name],\n        operationId: `find${name}`,\n        parameters: commonReadParams({ base: name, ctx, refs }),\n        responses: { ...jsonOk(t('globalDoc'), docRef), ...errorResponses(ERRORS.globalRead, t) },\n        security: secRead,\n      },\n      post: {\n        tags: [name],\n        operationId: `update${name}`,\n        parameters: writeParams({ base: name, entity: global, ctx, refs, operation: 'globalUpdate' }),\n        requestBody: { content: { 'application/json': { schema: updateRef } } },\n        responses: {\n          ...jsonOk(t('globalDoc'), {\n            type: 'object',\n            properties: { message: { type: 'string' }, result: docRef },\n          }),\n          ...errorResponses(ERRORS.globalUpdate, t),\n        },\n        security: secUpdate,\n      },\n    },\n    [`${ctx.apiRoute}/globals/${global.slug}/validate`]: {\n      post: validateOperation({\n        tag: name,\n        operationId: `validate${name}`,\n        parameters: validateParams(ctx),\n        requestBody: { content: { 'application/json': { schema: updateRef } } },\n        errors: ERRORS.globalUpdate,\n        security: secValidate,\n        t,\n      }),\n    },\n  }\n\n  if (access) {\n    paths[`${ctx.apiRoute}/globals/${global.slug}/access`] = {\n      post: docAccessOperation({\n        tag: name,\n        operationId: `access${name}`,\n        operations: ['read', 'update', 'validate', ...(global.versions ? ['readVersions'] : [])],\n        bodyRef: updateRef,\n        errors: ['500'],\n        t,\n      }),\n    }\n  }\n\n  return paths\n}\n"],"mappings":";;;;AAgBA,MAAa,oBAAoB,EAC/B,QACA,KACA,WAAW,CAAC,GACZ,SAAS,YAMQ;CACjB,MAAM,IAAI,MAAM,IAAI,IAAI;CACxB,MAAM,OAAO,iBAAiB,OAAO,IAAI;CACzC,MAAM,SAA0B,EAAE,MAAM,MAAM,IAAI,EAAE;CACpD,MAAM,YAA6B,EAAE,MAAM,MAAM,iBAAiB,IAAI,CAAC,EAAE;CACzE,MAAM,EAAE,MAAM,SAAS,QAAQ,WAAW,UAAU,gBAAgB;CAEpE,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;CAEA,MAAM,QAAqB;GACxB,GAAG,IAAI,SAAS,WAAW,OAAO,SAAS;GAC1C,KAAK;IACH,MAAM,CAAC,IAAI;IACX,aAAa,OAAO;IACpB,YAAY,iBAAiB;KAAE,MAAM;KAAM;KAAK;IAAK,CAAC;IACtD,WAAW;KAAE,GAAG,OAAO,EAAE,WAAW,GAAG,MAAM;KAAG,GAAG,eAAe,OAAO,YAAY,CAAC;IAAE;IACxF,UAAU;GACZ;GACA,MAAM;IACJ,MAAM,CAAC,IAAI;IACX,aAAa,SAAS;IACtB,YAAY,YAAY;KAAE,MAAM;KAAM,QAAQ;KAAQ;KAAK;KAAM,WAAW;IAAe,CAAC;IAC5F,aAAa,EAAE,SAAS,EAAE,oBAAoB,EAAE,QAAQ,UAAU,EAAE,EAAE;IACtE,WAAW;KACT,GAAG,OAAO,EAAE,WAAW,GAAG;MACxB,MAAM;MACN,YAAY;OAAE,SAAS,EAAE,MAAM,SAAS;OAAG,QAAQ;MAAO;KAC5D,CAAC;KACD,GAAG,eAAe,OAAO,cAAc,CAAC;IAC1C;IACA,UAAU;GACZ;EACF;GACC,GAAG,IAAI,SAAS,WAAW,OAAO,KAAK,aAAa,EACnD,MAAM,kBAAkB;GACtB,KAAK;GACL,aAAa,WAAW;GACxB,YAAY,eAAe,GAAG;GAC9B,aAAa,EAAE,SAAS,EAAE,oBAAoB,EAAE,QAAQ,UAAU,EAAE,EAAE;GACtE,QAAQ,OAAO;GACf,UAAU;GACV;EACF,CAAC,EACH;CACF;CAEA,IAAI,QACF,MAAM,GAAG,IAAI,SAAS,WAAW,OAAO,KAAK,YAAY,EACvD,MAAM,mBAAmB;EACvB,KAAK;EACL,aAAa,SAAS;EACtB,YAAY;GAAC;GAAQ;GAAU;GAAY,GAAI,OAAO,WAAW,CAAC,cAAc,IAAI,CAAC;EAAE;EACvF,SAAS;EACT,QAAQ,CAAC,KAAK;EACd;CACF,CAAC,EACH;CAGF,OAAO;AACT"}

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

@@ -0,0 +1,9 @@
+import { BuildContext } from "../../../shared/types/index.js";
+import { SanitizedConfig } from "payload";
+import { PathsObject, SecurityRequirementObject } from "@scalar/openapi-types/3.2";
+export declare const buildJobsPaths: ({ config, ctx, security }: {
+  config: SanitizedConfig;
+  ctx: BuildContext;
+  security?: SecurityRequirementObject[];
+}) => PathsObject;
+//# sourceMappingURL=jobs.d.ts.map

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

@@ -0,0 +1,98 @@
+import { errorResponses, jsonResponse } from "../components.js";
+import { makeT } from "../../../shared/translations/index.js";
+const boolParam = (name, description) => ({
+	name,
+	in: "query",
+	description,
+	schema: { type: "boolean" }
+});
+const collectQueues = (jobs) => {
+	const queues = /* @__PURE__ */ new Set(["default"]);
+	const add = (q) => {
+		if (typeof q === "string" && q) queues.add(q);
+	};
+	const fromSchedules = (items) => {
+		if (!Array.isArray(items)) return;
+		for (const item of items) for (const s of item.schedule ?? []) add(s.queue);
+	};
+	fromSchedules(jobs?.tasks);
+	fromSchedules(jobs?.workflows);
+	const autoRun = jobs?.autoRun;
+	if (Array.isArray(autoRun)) for (const cron of autoRun) add(cron.queue);
+	const processingOrder = jobs?.processingOrder;
+	if (processingOrder?.queues) for (const name of Object.keys(processingOrder.queues)) add(name);
+	return [...queues].toSorted();
+};
+const queueParam = (queues, ctx) => ({
+	name: "queue",
+	in: "query",
+	description: makeT(ctx.i18n)("jobsQueue", { queues: queues.map((q) => `\`${q}\``).join(", ") }),
+	schema: {
+		type: "string",
+		enum: queues
+	}
+});
+const buildJobsPaths = ({ config, ctx, security }) => {
+	const jobs = config.jobs;
+	if (!Boolean((jobs?.tasks)?.length || (jobs?.workflows)?.length)) return {};
+	const t = makeT(ctx.i18n);
+	const queue = queueParam(collectQueues(jobs), ctx);
+	const errors = errorResponses([
+		"401",
+		"403",
+		"500"
+	], t);
+	return {
+		[`${ctx.apiRoute}/payload-jobs/run`]: { get: {
+			tags: ["Jobs"],
+			operationId: "runJobs",
+			summary: t("jobsRunSummary"),
+			parameters: [
+				queue,
+				boolParam("allQueues", t("jobsRunAllQueues")),
+				{
+					name: "limit",
+					in: "query",
+					description: t("jobsLimit"),
+					schema: { type: "integer" }
+				},
+				boolParam("disableScheduling", t("jobsDisableScheduling")),
+				boolParam("silent", t("jobsSilent"))
+			],
+			responses: {
+				"200": jsonResponse(t("jobsRunResult"), {
+					type: "object",
+					properties: {
+						message: { type: "string" },
+						noJobsRemaining: { type: "boolean" },
+						remainingJobsFromQueried: { type: "integer" }
+					}
+				}),
+				...errors
+			},
+			security
+		} },
+		[`${ctx.apiRoute}/payload-jobs/handle-schedules`]: { get: {
+			tags: ["Jobs"],
+			operationId: "handleJobSchedules",
+			summary: t("jobsSchedulesSummary"),
+			parameters: [queue, boolParam("allQueues", t("jobsSchedulesAllQueues"))],
+			responses: {
+				"200": jsonResponse(t("jobsSchedulesResult"), {
+					type: "object",
+					properties: {
+						message: { type: "string" },
+						queued: { type: "integer" },
+						errored: { type: "integer" },
+						skipped: { type: "integer" }
+					}
+				}),
+				...errors
+			},
+			security
+		} }
+	};
+};
+export { buildJobsPaths };
+
+//# sourceMappingURL=jobs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.js","names":[],"sources":["../../../../src/server/spec/paths/jobs.ts"],"sourcesContent":["import type { ParameterObject, PathsObject, SecurityRequirementObject } from '@scalar/openapi-types/3.2'\nimport type { SanitizedConfig } from 'payload'\n\nimport { errorResponses, jsonResponse } from '@/server/spec/components.js'\nimport { makeT } from '@/shared/translations/index.js'\nimport type { BuildContext } from '@/shared/types/index.js'\n\nconst boolParam = (name: string, description: string): ParameterObject => ({\n  name,\n  in: 'query',\n  description,\n  schema: { type: 'boolean' },\n})\n\nconst collectQueues = (jobs: Record<string, unknown> | undefined): string[] => {\n  const queues = new Set<string>(['default'])\n\n  const add = (q: unknown) => {\n    if (typeof q === 'string' && q) queues.add(q)\n  }\n  const fromSchedules = (items: unknown) => {\n    if (!Array.isArray(items)) return\n    for (const item of items as Array<{ schedule?: Array<{ queue?: unknown }> }>) {\n      for (const s of item.schedule ?? []) add(s.queue)\n    }\n  }\n\n  fromSchedules(jobs?.tasks)\n  fromSchedules(jobs?.workflows)\n\n  const autoRun = jobs?.autoRun\n  if (Array.isArray(autoRun)) {\n    for (const cron of autoRun as Array<{ queue?: unknown }>) add(cron.queue)\n  }\n\n  const processingOrder = jobs?.processingOrder as { queues?: Record<string, unknown> } | undefined\n  if (processingOrder?.queues) {\n    for (const name of Object.keys(processingOrder.queues)) add(name)\n  }\n\n  return [...queues].toSorted()\n}\n\nconst queueParam = (queues: string[], ctx: BuildContext): ParameterObject => ({\n  name: 'queue',\n  in: 'query',\n  description: makeT(ctx.i18n)('jobsQueue', { queues: queues.map((q) => `\\`${q}\\``).join(', ') }),\n  schema: { type: 'string', enum: queues },\n})\n\nexport const buildJobsPaths = ({\n  config,\n  ctx,\n  security,\n}: {\n  config: SanitizedConfig\n  ctx: BuildContext\n  security?: SecurityRequirementObject[]\n}): PathsObject => {\n  const jobs = config.jobs as Record<string, unknown> | undefined\n  const hasJobs = Boolean((jobs?.tasks as unknown[])?.length || (jobs?.workflows as unknown[])?.length)\n  if (!hasJobs) return {}\n\n  const t = makeT(ctx.i18n)\n  const queue = queueParam(collectQueues(jobs), ctx)\n  const errors = errorResponses(['401', '403', '500'], t)\n\n  return {\n    [`${ctx.apiRoute}/payload-jobs/run`]: {\n      get: {\n        tags: ['Jobs'],\n        operationId: 'runJobs',\n        summary: t('jobsRunSummary'),\n        parameters: [\n          queue,\n          boolParam('allQueues', t('jobsRunAllQueues')),\n          { name: 'limit', in: 'query', description: t('jobsLimit'), schema: { type: 'integer' } },\n          boolParam('disableScheduling', t('jobsDisableScheduling')),\n          boolParam('silent', t('jobsSilent')),\n        ],\n        responses: {\n          '200': jsonResponse(t('jobsRunResult'), {\n            type: 'object',\n            properties: {\n              message: { type: 'string' },\n              noJobsRemaining: { type: 'boolean' },\n              remainingJobsFromQueried: { type: 'integer' },\n            },\n          }),\n          ...errors,\n        },\n        security,\n      },\n    },\n    [`${ctx.apiRoute}/payload-jobs/handle-schedules`]: {\n      get: {\n        tags: ['Jobs'],\n        operationId: 'handleJobSchedules',\n        summary: t('jobsSchedulesSummary'),\n        parameters: [queue, boolParam('allQueues', t('jobsSchedulesAllQueues'))],\n        responses: {\n          '200': jsonResponse(t('jobsSchedulesResult'), {\n            type: 'object',\n            properties: {\n              message: { type: 'string' },\n              queued: { type: 'integer' },\n              errored: { type: 'integer' },\n              skipped: { type: 'integer' },\n            },\n          }),\n          ...errors,\n        },\n        security,\n      },\n    },\n  }\n}\n"],"mappings":";;AAOA,MAAM,aAAa,MAAc,iBAA0C;CACzE;CACA,IAAI;CACJ;CACA,QAAQ,EAAE,MAAM,UAAU;AAC5B;AAEA,MAAM,iBAAiB,SAAwD;CAC7E,MAAM,yBAAS,IAAI,IAAY,CAAC,SAAS,CAAC;CAE1C,MAAM,OAAO,MAAe;EAC1B,IAAI,OAAO,MAAM,YAAY,GAAG,OAAO,IAAI,CAAC;CAC9C;CACA,MAAM,iBAAiB,UAAmB;EACxC,IAAI,CAAC,MAAM,QAAQ,KAAK,GAAG;EAC3B,KAAK,MAAM,QAAQ,OACjB,KAAK,MAAM,KAAK,KAAK,YAAY,CAAC,GAAG,IAAI,EAAE,KAAK;CAEpD;CAEA,cAAc,MAAM,KAAK;CACzB,cAAc,MAAM,SAAS;CAE7B,MAAM,UAAU,MAAM;CACtB,IAAI,MAAM,QAAQ,OAAO,GACvB,KAAK,MAAM,QAAQ,SAAuC,IAAI,KAAK,KAAK;CAG1E,MAAM,kBAAkB,MAAM;CAC9B,IAAI,iBAAiB,QACnB,KAAK,MAAM,QAAQ,OAAO,KAAK,gBAAgB,MAAM,GAAG,IAAI,IAAI;CAGlE,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,SAAS;AAC9B;AAEA,MAAM,cAAc,QAAkB,SAAwC;CAC5E,MAAM;CACN,IAAI;CACJ,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,aAAa,EAAE,QAAQ,OAAO,KAAK,MAAM,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;CAC9F,QAAQ;EAAE,MAAM;EAAU,MAAM;CAAO;AACzC;AAEA,MAAa,kBAAkB,EAC7B,QACA,KACA,eAKiB;CACjB,MAAM,OAAO,OAAO;CAEpB,IAAI,CADY,SAAS,MAAM,MAAA,EAAqB,WAAW,MAAM,UAAA,EAAyB,MACnF,GAAG,OAAO,CAAC;CAEtB,MAAM,IAAI,MAAM,IAAI,IAAI;CACxB,MAAM,QAAQ,WAAW,cAAc,IAAI,GAAG,GAAG;CACjD,MAAM,SAAS,eAAe;EAAC;EAAO;EAAO;CAAK,GAAG,CAAC;CAEtD,OAAO;GACJ,GAAG,IAAI,SAAS,qBAAqB,EACpC,KAAK;GACH,MAAM,CAAC,MAAM;GACb,aAAa;GACb,SAAS,EAAE,gBAAgB;GAC3B,YAAY;IACV;IACA,UAAU,aAAa,EAAE,kBAAkB,CAAC;IAC5C;KAAE,MAAM;KAAS,IAAI;KAAS,aAAa,EAAE,WAAW;KAAG,QAAQ,EAAE,MAAM,UAAU;IAAE;IACvF,UAAU,qBAAqB,EAAE,uBAAuB,CAAC;IACzD,UAAU,UAAU,EAAE,YAAY,CAAC;GACrC;GACA,WAAW;IACT,OAAO,aAAa,EAAE,eAAe,GAAG;KACtC,MAAM;KACN,YAAY;MACV,SAAS,EAAE,MAAM,SAAS;MAC1B,iBAAiB,EAAE,MAAM,UAAU;MACnC,0BAA0B,EAAE,MAAM,UAAU;KAC9C;IACF,CAAC;IACD,GAAG;GACL;GACA;EACF,EACF;GACC,GAAG,IAAI,SAAS,kCAAkC,EACjD,KAAK;GACH,MAAM,CAAC,MAAM;GACb,aAAa;GACb,SAAS,EAAE,sBAAsB;GACjC,YAAY,CAAC,OAAO,UAAU,aAAa,EAAE,wBAAwB,CAAC,CAAC;GACvE,WAAW;IACT,OAAO,aAAa,EAAE,qBAAqB,GAAG;KAC5C,MAAM;KACN,YAAY;MACV,SAAS,EAAE,MAAM,SAAS;MAC1B,QAAQ,EAAE,MAAM,UAAU;MAC1B,SAAS,EAAE,MAAM,UAAU;MAC3B,SAAS,EAAE,MAAM,UAAU;KAC7B;IACF,CAAC;IACD,GAAG;GACL;GACA;EACF,EACF;CACF;AACF"}

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

@@ -0,0 +1,8 @@
+import { BuildContext } from "../../../shared/types/index.js";
+import { PathsObject } from "@scalar/openapi-types/3.2";
+export declare const buildSystemPaths: ({ ctx, access, uploadSlugs }: {
+  ctx: BuildContext;
+  access: boolean;
+  uploadSlugs: string[];
+}) => PathsObject;
+//# sourceMappingURL=system.d.ts.map