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

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

@@ -1,7 +1,8 @@
 import { createSchemaName, listSchemaName, refTo, schemaName, updateSchemaName } from "../names.js";
-import { ERRORS, docAccessOperation, errorResponses, jsonOk, jsonResponse, uploadRequestBody, validateOperation } from "../components.js";
+import { ERRORS, docAccessOperation, errorResponses, jsonBody, jsonOk, jsonResponse, uploadRequestBody, validateOperation } from "../components.js";
 import { makeT } from "../../../shared/translations/index.js";
 import { buildListParams, buildParamSchemas, commonReadParams, validateParams, writeParams } from "../params.js";
+import { securedRequirement } from "../security.js";
 const buildCollectionPaths = ({ collection, ctx, security = {}, access = false }) => {
 	const t = makeT(ctx.i18n);
 	const name = schemaName(collection.slug);
@@ -277,13 +278,20 @@ const buildCollectionPaths = ({ collection, ctx, security = {}, access = false }
 			type: "string",
 			format: "binary"
 		} } } };
+		const fileParams = [{
+			name: "filename",
+			in: "path",
+			required: true,
+			schema: { type: "string" }
+		}];
+		if (collection.versions) fileParams.push({
+			name: "version",
+			in: "query",
+			description: t("paramFileVersion"),
+			schema: { type: idType }
+		});
 		paths[`${base}/file/{filename}`] = {
-			parameters: [{
-				name: "filename",
-				in: "path",
-				required: true,
-				schema: { type: "string" }
-			}],
+			parameters: fileParams,
 			get: {
 				tags: [name],
 				operationId: `get${name}File`,
@@ -306,6 +314,102 @@ const buildCollectionPaths = ({ collection, ctx, security = {}, access = false }
 				security: secRead
 			}
 		};
+		paths[`${base}/{id}/rename`] = {
+			parameters: [{
+				name: "id",
+				in: "path",
+				required: true,
+				schema: { type: idType }
+			}],
+			post: {
+				tags: [name],
+				operationId: `rename${name}File`,
+				requestBody: {
+					required: true,
+					content: { "application/json": { schema: {
+						type: "object",
+						properties: {
+							filename: { type: "string" },
+							draft: { type: "boolean" }
+						},
+						required: ["filename"]
+					} } }
+				},
+				responses: updateResponse,
+				security: secUpdate
+			}
+		};
+	}
+	if (collection.slug === "payload-preferences") {
+		delete paths[`${base}/count`];
+		delete paths[`${base}/validate`];
+		delete paths[`${base}/access`];
+		const keyParam = [{
+			name: "id",
+			in: "path",
+			required: true,
+			description: t("paramPreferenceKey"),
+			schema: { type: "string" }
+		}];
+		const secured = securedRequirement();
+		paths[`${base}/{id}`] = {
+			...paths[`${base}/{id}`],
+			get: {
+				tags: [name],
+				operationId: `find${name}ByKey`,
+				summary: t("preferenceGet"),
+				parameters: keyParam,
+				responses: {
+					...jsonOk(t("preferenceGetResult"), { anyOf: [docRef, {
+						type: "object",
+						properties: {
+							message: { type: "string" },
+							value: { const: null }
+						},
+						required: ["message", "value"]
+					}] }),
+					...errorResponses(["500"], t)
+				},
+				security: secured
+			},
+			post: {
+				tags: [name],
+				operationId: `upsert${name}ByKey`,
+				summary: t("preferenceSet"),
+				parameters: keyParam,
+				requestBody: {
+					...jsonBody({
+						type: "object",
+						properties: { value: {} },
+						required: ["value"]
+					}),
+					description: t("preferenceSetBody")
+				},
+				responses: {
+					...jsonOk(t("preferenceSetResult"), mutationSchema),
+					...errorResponses(["401", "500"], t)
+				},
+				security: secured
+			},
+			delete: {
+				tags: [name],
+				operationId: `delete${name}ByKey`,
+				summary: t("preferenceDelete"),
+				parameters: keyParam,
+				responses: {
+					...jsonOk(t("preferenceDeleteResult"), { allOf: [docRef, {
+						type: "object",
+						properties: { message: { type: "string" } }
+					}] }),
+					...errorResponses([
+						"401",
+						"404",
+						"500"
+					], t)
+				},
+				security: secured
+			}
+		};
 	}
 	return paths;
 };

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

@@ -1 +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"}
+{"version":3,"file":"collections.js","names":[],"sources":["../../../../src/server/spec/paths/collections.ts"],"sourcesContent":["import type {\n  ParameterObject,\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  jsonBody,\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, securedRequirement } 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    const fileParams: ParameterObject[] = [{ name: 'filename', in: 'path', required: true, schema: { type: 'string' } }]\n    if (collection.versions) {\n      fileParams.push({ name: 'version', in: 'query', description: t('paramFileVersion'), schema: { type: idType } })\n    }\n    paths[`${base}/file/{filename}`] = {\n      parameters: fileParams,\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    paths[`${base}/{id}/rename`] = {\n      parameters: [{ name: 'id', in: 'path', required: true, schema: { type: idType } }],\n      post: {\n        tags: [name],\n        operationId: `rename${name}File`,\n        requestBody: {\n          required: true,\n          content: {\n            'application/json': {\n              schema: {\n                type: 'object',\n                properties: { filename: { type: 'string' }, draft: { type: 'boolean' } },\n                required: ['filename'],\n              },\n            },\n          },\n        },\n        responses: updateResponse,\n        security: secUpdate,\n      },\n    }\n  }\n\n  if (collection.slug === 'payload-preferences') {\n    delete paths[`${base}/count`]\n    delete paths[`${base}/validate`]\n    delete paths[`${base}/access`]\n    const keyParam: ParameterObject[] = [\n      { name: 'id', in: 'path', required: true, description: t('paramPreferenceKey'), schema: { type: 'string' } },\n    ]\n    const secured = securedRequirement()\n    paths[`${base}/{id}`] = {\n      ...paths[`${base}/{id}`],\n      get: {\n        tags: [name],\n        operationId: `find${name}ByKey`,\n        summary: t('preferenceGet'),\n        parameters: keyParam,\n        responses: {\n          ...jsonOk(t('preferenceGetResult'), {\n            anyOf: [\n              docRef,\n              {\n                type: 'object',\n                properties: { message: { type: 'string' }, value: { const: null } },\n                required: ['message', 'value'],\n              },\n            ],\n          }),\n          ...errorResponses(['500'], t),\n        },\n        security: secured,\n      },\n      post: {\n        tags: [name],\n        operationId: `upsert${name}ByKey`,\n        summary: t('preferenceSet'),\n        parameters: keyParam,\n        requestBody: {\n          ...jsonBody({ type: 'object', properties: { value: {} }, required: ['value'] }),\n          description: t('preferenceSetBody'),\n        },\n        responses: { ...jsonOk(t('preferenceSetResult'), mutationSchema), ...errorResponses(['401', '500'], t) },\n        security: secured,\n      },\n      delete: {\n        tags: [name],\n        operationId: `delete${name}ByKey`,\n        summary: t('preferenceDelete'),\n        parameters: keyParam,\n        responses: {\n          ...jsonOk(t('preferenceDeleteResult'), {\n            allOf: [docRef, { type: 'object', properties: { message: { type: 'string' } } }],\n          }),\n          ...errorResponses(['401', '404', '500'], t),\n        },\n        security: secured,\n      },\n    }\n  }\n\n  return paths\n}\n"],"mappings":";;;;;AAkCA,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,aAAgC,CAAC;GAAE,MAAM;GAAY,IAAI;GAAQ,UAAU;GAAM,QAAQ,EAAE,MAAM,SAAS;EAAE,CAAC;EACnH,IAAI,WAAW,UACb,WAAW,KAAK;GAAE,MAAM;GAAW,IAAI;GAAS,aAAa,EAAE,kBAAkB;GAAG,QAAQ,EAAE,MAAM,OAAO;EAAE,CAAC;EAEhH,MAAM,GAAG,KAAK,qBAAqB;GACjC,YAAY;GACZ,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;EACA,MAAM,GAAG,KAAK,iBAAiB;GAC7B,YAAY,CAAC;IAAE,MAAM;IAAM,IAAI;IAAQ,UAAU;IAAM,QAAQ,EAAE,MAAM,OAAO;GAAE,CAAC;GACjF,MAAM;IACJ,MAAM,CAAC,IAAI;IACX,aAAa,SAAS,KAAK;IAC3B,aAAa;KACX,UAAU;KACV,SAAS,EACP,oBAAoB,EAClB,QAAQ;MACN,MAAM;MACN,YAAY;OAAE,UAAU,EAAE,MAAM,SAAS;OAAG,OAAO,EAAE,MAAM,UAAU;MAAE;MACvE,UAAU,CAAC,UAAU;KACvB,EACF,EACF;IACF;IACA,WAAW;IACX,UAAU;GACZ;EACF;CACF;CAEA,IAAI,WAAW,SAAS,uBAAuB;EAC7C,OAAO,MAAM,GAAG,KAAK;EACrB,OAAO,MAAM,GAAG,KAAK;EACrB,OAAO,MAAM,GAAG,KAAK;EACrB,MAAM,WAA8B,CAClC;GAAE,MAAM;GAAM,IAAI;GAAQ,UAAU;GAAM,aAAa,EAAE,oBAAoB;GAAG,QAAQ,EAAE,MAAM,SAAS;EAAE,CAC7G;EACA,MAAM,UAAU,mBAAmB;EACnC,MAAM,GAAG,KAAK,UAAU;GACtB,GAAG,MAAM,GAAG,KAAK;GACjB,KAAK;IACH,MAAM,CAAC,IAAI;IACX,aAAa,OAAO,KAAK;IACzB,SAAS,EAAE,eAAe;IAC1B,YAAY;IACZ,WAAW;KACT,GAAG,OAAO,EAAE,qBAAqB,GAAG,EAClC,OAAO,CACL,QACA;MACE,MAAM;MACN,YAAY;OAAE,SAAS,EAAE,MAAM,SAAS;OAAG,OAAO,EAAE,OAAO,KAAK;MAAE;MAClE,UAAU,CAAC,WAAW,OAAO;KAC/B,CACF,EACF,CAAC;KACD,GAAG,eAAe,CAAC,KAAK,GAAG,CAAC;IAC9B;IACA,UAAU;GACZ;GACA,MAAM;IACJ,MAAM,CAAC,IAAI;IACX,aAAa,SAAS,KAAK;IAC3B,SAAS,EAAE,eAAe;IAC1B,YAAY;IACZ,aAAa;KACX,GAAG,SAAS;MAAE,MAAM;MAAU,YAAY,EAAE,OAAO,CAAC,EAAE;MAAG,UAAU,CAAC,OAAO;KAAE,CAAC;KAC9E,aAAa,EAAE,mBAAmB;IACpC;IACA,WAAW;KAAE,GAAG,OAAO,EAAE,qBAAqB,GAAG,cAAc;KAAG,GAAG,eAAe,CAAC,OAAO,KAAK,GAAG,CAAC;IAAE;IACvG,UAAU;GACZ;GACA,QAAQ;IACN,MAAM,CAAC,IAAI;IACX,aAAa,SAAS,KAAK;IAC3B,SAAS,EAAE,kBAAkB;IAC7B,YAAY;IACZ,WAAW;KACT,GAAG,OAAO,EAAE,wBAAwB,GAAG,EACrC,OAAO,CAAC,QAAQ;MAAE,MAAM;MAAU,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,EAAE;KAAE,CAAC,EACjF,CAAC;KACD,GAAG,eAAe;MAAC;MAAO;MAAO;KAAK,GAAG,CAAC;IAC5C;IACA,UAAU;GACZ;EACF;CACF;CAEA,OAAO;AACT"}

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

@@ -1,6 +1,8 @@
 import { BuildContext } from "../../../shared/types/index.js";
-import { SanitizedCollectionConfig, SanitizedConfig, SanitizedGlobalConfig } from "payload";
-import { PathsObject } from "@scalar/openapi-types/3.2";
+import { Endpoint, SanitizedCollectionConfig, SanitizedConfig, SanitizedGlobalConfig } from "payload";
+import { OperationObject, PathsObject } from "@scalar/openapi-types/3.2";
+export declare const getOpenapiMeta: (endpoint: Endpoint) => OperationObject | undefined;
+export declare const normalizePath: (prefix: string, path: string) => string;
 export declare const buildCustomEndpointPaths: ({ config, collections, globals, ctx }: {
   config: SanitizedConfig;
   collections: SanitizedCollectionConfig[];

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

@@ -37,6 +37,6 @@ const buildCustomEndpointPaths = ({ config, collections, globals, ctx }) => {
 	});
 	return out;
 };
-export { buildCustomEndpointPaths };
+export { buildCustomEndpointPaths, getOpenapiMeta, normalizePath };
 
 //# sourceMappingURL=custom.js.map

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

@@ -1 +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"}
+{"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\nexport const getOpenapiMeta = (endpoint: Endpoint): OperationObject | undefined => {\n  const meta = endpoint.custom?.openapi\n  return meta && typeof meta === 'object' ? (meta as OperationObject) : undefined\n}\n\nexport const 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,MAAa,kBAAkB,aAAoD;CACjF,MAAM,OAAO,SAAS,QAAQ;CAC9B,OAAO,QAAQ,OAAO,SAAS,WAAY,OAA2B,KAAA;AACxE;AAEA,MAAa,iBAAiB,QAAgB,SAAyB;CAErE,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/system.d.ts

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

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

@@ -1,6 +1,6 @@
 import { SECURITY_SCHEME_NAME, errorResponses, jsonBody, jsonResponse } from "../components.js";
 import { makeT } from "../../../shared/translations/index.js";
-const buildSystemPaths = ({ ctx, access, uploadSlugs }) => {
+const buildSystemPaths = ({ ctx, access, uploadSlugs, reorderSlugs = [] }) => {
 	const t = makeT(ctx.i18n);
 	const paths = {};
 	if (access) paths[`${ctx.apiRoute}/access`] = { get: {
@@ -130,6 +130,72 @@ const buildSystemPaths = ({ ctx, access, uploadSlugs }) => {
 			}
 		};
 	}
+	if (reorderSlugs.length > 0) {
+		const idType = ctx.defaultIDType === "number" ? "integer" : "string";
+		paths[`${ctx.apiRoute}/reorder`] = { post: {
+			tags: ["Reorder"],
+			operationId: "reorder",
+			summary: t("reorder"),
+			requestBody: {
+				...jsonBody({
+					type: "object",
+					properties: {
+						collectionSlug: {
+							type: "string",
+							enum: reorderSlugs
+						},
+						docsToMove: {
+							type: "array",
+							minItems: 1,
+							items: { type: idType }
+						},
+						newKeyWillBe: {
+							type: "string",
+							enum: ["greater", "less"]
+						},
+						orderableFieldName: { type: "string" },
+						target: {
+							type: "object",
+							properties: {
+								id: { type: idType },
+								key: { type: "string" }
+							},
+							required: ["id"]
+						}
+					},
+					required: [
+						"collectionSlug",
+						"docsToMove",
+						"newKeyWillBe",
+						"orderableFieldName",
+						"target"
+					]
+				}),
+				description: t("reorderBody")
+			},
+			responses: {
+				"200": jsonResponse(t("reorderResult"), {
+					type: "object",
+					properties: {
+						success: { type: "boolean" },
+						orderValues: {
+							type: "array",
+							items: { type: "string" }
+						},
+						message: { type: "string" }
+					},
+					required: ["success"]
+				}),
+				"400": jsonResponse(t("errorReorder400"), {
+					type: "object",
+					properties: { error: { type: "string" } },
+					required: ["error"]
+				}),
+				...errorResponses(["403", "500"], t)
+			},
+			security: [{ [SECURITY_SCHEME_NAME]: [] }]
+		} };
+	}
 	return paths;
 };
 export { buildSystemPaths };

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

@@ -1 +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"}
+{"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  reorderSlugs = [],\n}: {\n  ctx: BuildContext\n  access: boolean\n  uploadSlugs: string[]\n  reorderSlugs?: 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  if (reorderSlugs.length > 0) {\n    const idType = ctx.defaultIDType === 'number' ? 'integer' : 'string'\n    paths[`${ctx.apiRoute}/reorder`] = {\n      post: {\n        tags: ['Reorder'],\n        operationId: 'reorder',\n        summary: t('reorder'),\n        requestBody: {\n          ...jsonBody({\n            type: 'object',\n            properties: {\n              collectionSlug: { type: 'string', enum: reorderSlugs },\n              docsToMove: { type: 'array', minItems: 1, items: { type: idType } },\n              newKeyWillBe: { type: 'string', enum: ['greater', 'less'] },\n              orderableFieldName: { type: 'string' },\n              target: {\n                type: 'object',\n                properties: { id: { type: idType }, key: { type: 'string' } },\n                required: ['id'],\n              },\n            },\n            required: ['collectionSlug', 'docsToMove', 'newKeyWillBe', 'orderableFieldName', 'target'],\n          }),\n          description: t('reorderBody'),\n        },\n        responses: {\n          '200': jsonResponse(t('reorderResult'), {\n            type: 'object',\n            properties: {\n              success: { type: 'boolean' },\n              orderValues: { type: 'array', items: { type: 'string' } },\n              message: { type: 'string' },\n            },\n            required: ['success'],\n          }),\n          '400': jsonResponse(t('errorReorder400'), {\n            type: 'object',\n            properties: { error: { type: 'string' } },\n            required: ['error'],\n          }),\n          ...errorResponses(['403', '500'], t),\n        },\n        security: [{ [SECURITY_SCHEME_NAME]: [] }],\n      },\n    }\n  }\n\n  return paths\n}\n"],"mappings":";;AAMA,MAAa,oBAAoB,EAC/B,KACA,QACA,aACA,eAAe,CAAC,QAMC;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,IAAI,aAAa,SAAS,GAAG;EAC3B,MAAM,SAAS,IAAI,kBAAkB,WAAW,YAAY;EAC5D,MAAM,GAAG,IAAI,SAAS,aAAa,EACjC,MAAM;GACJ,MAAM,CAAC,SAAS;GAChB,aAAa;GACb,SAAS,EAAE,SAAS;GACpB,aAAa;IACX,GAAG,SAAS;KACV,MAAM;KACN,YAAY;MACV,gBAAgB;OAAE,MAAM;OAAU,MAAM;MAAa;MACrD,YAAY;OAAE,MAAM;OAAS,UAAU;OAAG,OAAO,EAAE,MAAM,OAAO;MAAE;MAClE,cAAc;OAAE,MAAM;OAAU,MAAM,CAAC,WAAW,MAAM;MAAE;MAC1D,oBAAoB,EAAE,MAAM,SAAS;MACrC,QAAQ;OACN,MAAM;OACN,YAAY;QAAE,IAAI,EAAE,MAAM,OAAO;QAAG,KAAK,EAAE,MAAM,SAAS;OAAE;OAC5D,UAAU,CAAC,IAAI;MACjB;KACF;KACA,UAAU;MAAC;MAAkB;MAAc;MAAgB;MAAsB;KAAQ;IAC3F,CAAC;IACD,aAAa,EAAE,aAAa;GAC9B;GACA,WAAW;IACT,OAAO,aAAa,EAAE,eAAe,GAAG;KACtC,MAAM;KACN,YAAY;MACV,SAAS,EAAE,MAAM,UAAU;MAC3B,aAAa;OAAE,MAAM;OAAS,OAAO,EAAE,MAAM,SAAS;MAAE;MACxD,SAAS,EAAE,MAAM,SAAS;KAC5B;KACA,UAAU,CAAC,SAAS;IACtB,CAAC;IACD,OAAO,aAAa,EAAE,iBAAiB,GAAG;KACxC,MAAM;KACN,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,EAAE;KACxC,UAAU,CAAC,OAAO;IACpB,CAAC;IACD,GAAG,eAAe,CAAC,OAAO,KAAK,GAAG,CAAC;GACrC;GACA,UAAU,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAC;EAC3C,EACF;CACF;CAEA,OAAO;AACT"}

package/dist/server/spec/plugins/ecommerce.d.ts

@@ -0,0 +1,3 @@
+import { OfficialPlugin } from "./shared.js";
+export declare const ecommerce: OfficialPlugin;
+//# sourceMappingURL=ecommerce.d.ts.map

package/dist/server/spec/plugins/ecommerce.js

@@ -0,0 +1,270 @@
+import { upperFirst } from "../../../shared/utils.js";
+import { refTo, schemaName } from "../names.js";
+import { ERROR_SCHEMA_NAME, errorResponses, jsonBody, jsonResponse } from "../components.js";
+import { securedRequirement } from "../security.js";
+import { collectionGroups, idSchema, messageErrors, mountEndpoints } from "./shared.js";
+import { stripeWebhookOperation } from "./stripe.js";
+const TAG = "Ecommerce";
+const PAYMENT_PATH = /^\/payments\/([^/]+)\/(initiate|confirm-order)$/;
+const CART_OPERATIONS = {
+	"/:id/add-item": {
+		operationId: "addItem",
+		summary: "ecommerceAddItem"
+	},
+	"/:id/remove-item": {
+		operationId: "removeItem",
+		summary: "ecommerceRemoveItem"
+	},
+	"/:id/update-item": {
+		operationId: "updateItem",
+		summary: "ecommerceUpdateItem"
+	},
+	"/:id/clear": {
+		operationId: "clear",
+		summary: "ecommerceClearCart"
+	},
+	"/:id/merge": {
+		operationId: "merge",
+		summary: "ecommerceMergeCart"
+	}
+};
+const ecommerce = {
+	slug: "@payloadcms/plugin-ecommerce",
+	tag: TAG,
+	build: ({ config, collections, ctx, schemas, t }) => {
+		const id = idSchema(ctx);
+		const secret = { type: "string" };
+		const failure = {
+			type: "object",
+			properties: {
+				message: { type: "string" },
+				success: {
+					type: "boolean",
+					enum: [false]
+				}
+			},
+			required: ["message", "success"]
+		};
+		const cartBodies = {
+			"/:id/add-item": {
+				type: "object",
+				properties: {
+					item: {
+						type: "object",
+						additionalProperties: true,
+						properties: {
+							product: id,
+							variant: id
+						},
+						required: ["product"]
+					},
+					quantity: {
+						type: "number",
+						default: 1
+					},
+					secret
+				},
+				required: ["item"]
+			},
+			"/:id/remove-item": {
+				type: "object",
+				properties: {
+					itemID: { type: "string" },
+					secret
+				},
+				required: ["itemID"]
+			},
+			"/:id/update-item": {
+				type: "object",
+				properties: {
+					itemID: { type: "string" },
+					quantity: {
+						description: t("ecommerceQuantity"),
+						oneOf: [{ type: "number" }, {
+							type: "object",
+							properties: { $inc: { type: "number" } },
+							required: ["$inc"]
+						}]
+					},
+					removeOnZero: {
+						type: "boolean",
+						default: true
+					},
+					secret
+				},
+				required: ["itemID", "quantity"]
+			},
+			"/:id/clear": {
+				type: "object",
+				properties: { secret }
+			},
+			"/:id/merge": {
+				type: "object",
+				properties: {
+					sourceCartID: id,
+					sourceSecret: { type: "string" }
+				},
+				required: ["sourceCartID", "sourceSecret"]
+			}
+		};
+		const cartGroups = collectionGroups(collections.filter((c) => (c.endpoints || []).some((endpoint) => endpoint.method === "post" && endpoint.path === "/:id/add-item")), ctx, ({ method, path }, collection) => {
+			const meta = CART_OPERATIONS[path];
+			if (!meta || method !== "post") return void 0;
+			const name = schemaName(collection.slug);
+			const merge = path === "/:id/merge";
+			const cart = schemas[name] ? { $ref: refTo(name) } : {
+				type: "object",
+				additionalProperties: true
+			};
+			const param = {
+				name: "id",
+				in: "path",
+				required: true,
+				schema: id
+			};
+			return {
+				tags: [TAG],
+				operationId: `${meta.operationId}${name}`,
+				summary: t(meta.summary),
+				description: merge ? void 0 : t("ecommerceCartAccess"),
+				parameters: [param],
+				requestBody: {
+					...jsonBody(cartBodies[path]),
+					required: path !== "/:id/clear"
+				},
+				responses: {
+					"200": jsonResponse(t("ecommerceCartResult"), {
+						type: "object",
+						properties: {
+							cart,
+							message: { type: "string" },
+							success: {
+								type: "boolean",
+								enum: [true]
+							}
+						},
+						required: [
+							"cart",
+							"message",
+							"success"
+						]
+					}),
+					...messageErrors(merge ? ["400", "401"] : ["400"], t, failure),
+					...errorResponses(["403"], t),
+					"404": jsonResponse(t("errorPluginEcommerce404"), { oneOf: [{
+						type: "object",
+						properties: {
+							cart: { type: ["object", "null"] },
+							...failure.properties
+						},
+						required: [
+							"cart",
+							"message",
+							"success"
+						]
+					}, { $ref: refTo(ERROR_SCHEMA_NAME) }] })
+				},
+				...merge ? { security: securedRequirement() } : {}
+			};
+		});
+		const address = {
+			type: "object",
+			additionalProperties: true
+		};
+		const paymentBody = (extra) => ({
+			...jsonBody({
+				type: "object",
+				additionalProperties: true,
+				properties: {
+					cartID: id,
+					secret,
+					customerEmail: {
+						type: "string",
+						format: "email"
+					},
+					billingAddress: address,
+					shippingAddress: address,
+					...extra
+				},
+				...Object.keys(extra).length > 0 ? { required: Object.keys(extra) } : {}
+			}),
+			description: t("ecommercePaymentBody")
+		});
+		const usedIds = /* @__PURE__ */ new Set();
+		const uniqueId = (base) => {
+			let operationId = base;
+			for (let n = 2; usedIds.has(operationId); n++) operationId = `${base}${n}`;
+			usedIds.add(operationId);
+			return operationId;
+		};
+		return [{ paths: mountEndpoints(config.endpoints, ctx.apiRoute, ({ method, path }) => {
+			if (method !== "post") return void 0;
+			if (path === "/payments/stripe/webhooks") return stripeWebhookOperation({
+				tag: TAG,
+				operationId: "ecommerceStripeWebhooks",
+				t
+			});
+			const match = PAYMENT_PATH.exec(path);
+			if (!match) return void 0;
+			const [, methodName = "", step] = match;
+			const stripe = methodName === "stripe";
+			const suffix = upperFirst(methodName.replace(/[^A-Za-z0-9]+(.)?/g, (_, c = "") => c.toUpperCase()));
+			if (step === "initiate") return {
+				tags: [TAG],
+				operationId: uniqueId(`initiatePayment${suffix}`),
+				summary: t("ecommerceInitiatePayment", { method: methodName }),
+				requestBody: paymentBody({}),
+				responses: {
+					"200": jsonResponse(t("ecommerceInitiateResult"), {
+						type: "object",
+						additionalProperties: true,
+						properties: {
+							message: { type: "string" },
+							...stripe ? {
+								clientSecret: { type: "string" },
+								paymentIntentID: { type: "string" }
+							} : {}
+						},
+						required: ["message"]
+					}),
+					...messageErrors([
+						"400",
+						"404",
+						"500"
+					], t)
+				}
+			};
+			return {
+				tags: [TAG],
+				operationId: uniqueId(`confirmOrder${suffix}`),
+				summary: t("ecommerceConfirmOrder", { method: methodName }),
+				requestBody: paymentBody(stripe ? { paymentIntentID: { type: "string" } } : {}),
+				responses: {
+					"200": jsonResponse(t("ecommerceConfirmResult"), {
+						type: "object",
+						additionalProperties: true,
+						properties: {
+							message: { type: "string" },
+							orderID: id,
+							transactionID: id,
+							...stripe ? { accessToken: { type: "string" } } : {}
+						},
+						required: [
+							"message",
+							"orderID",
+							"transactionID"
+						]
+					}),
+					...messageErrors([
+						"400",
+						"404",
+						"500"
+					], t)
+				}
+			};
+		}) }, ...cartGroups];
+	}
+};
+export { ecommerce };
+
+//# sourceMappingURL=ecommerce.js.map