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

package/dist/server/spec/params.js

@@ -0,0 +1,394 @@
+import { joinsSchemaName, populateSchemaName, querySchemaName, refTo, selectSchemaName } from "./names.js";
+import { makeT } from "../../shared/translations/index.js";
+import { exposableFields } from "./fields.js";
+const fieldName = (field) => "name" in field && typeof field.name === "string" ? field.name : void 0;
+const relationTargets = (field) => {
+	if (field.type !== "relationship" && field.type !== "upload") return [];
+	const relTo = field.relationTo;
+	return Array.isArray(relTo) ? relTo : [relTo];
+};
+const buildSelectSchema = ({ fields, ctx }) => {
+	const properties = {};
+	for (const field of exposableFields(fields)) {
+		const name = fieldName(field);
+		if (name) properties[name] = { type: "boolean" };
+	}
+	return {
+		type: "object",
+		additionalProperties: false,
+		description: makeT(ctx.i18n)("schemaSelect"),
+		properties
+	};
+};
+const buildPopulateSchema = ({ fields, ctx }) => {
+	const targets = /* @__PURE__ */ new Set();
+	for (const field of exposableFields(fields)) for (const target of relationTargets(field)) targets.add(target);
+	if (targets.size === 0) return void 0;
+	const properties = {};
+	for (const target of targets) properties[target] = {
+		type: "object",
+		additionalProperties: { type: "boolean" }
+	};
+	return {
+		type: "object",
+		additionalProperties: false,
+		description: makeT(ctx.i18n)("schemaPopulate"),
+		properties
+	};
+};
+const buildJoinsSchema = ({ fields, ctx }) => {
+	const joinControls = {
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			limit: { type: "integer" },
+			page: { type: "integer" },
+			sort: { type: "string" },
+			count: { type: "boolean" },
+			where: {
+				type: "object",
+				additionalProperties: true
+			}
+		}
+	};
+	const properties = {};
+	for (const field of exposableFields(fields)) {
+		if (field.type !== "join") continue;
+		const name = fieldName(field);
+		if (name) properties[name] = joinControls;
+	}
+	if (Object.keys(properties).length === 0) return void 0;
+	return {
+		type: "object",
+		additionalProperties: false,
+		description: makeT(ctx.i18n)("schemaJoins"),
+		properties
+	};
+};
+const buildParamSchemas = ({ fields, ctx }) => ({
+	select: buildSelectSchema({
+		fields,
+		ctx
+	}),
+	populate: buildPopulateSchema({
+		fields,
+		ctx
+	}),
+	joins: buildJoinsSchema({
+		fields,
+		ctx
+	})
+});
+const OPERATORS_BY_TYPE = {
+	text: [
+		"equals",
+		"not_equals",
+		"like",
+		"contains",
+		"in",
+		"not_in",
+		"exists"
+	],
+	textarea: [
+		"equals",
+		"not_equals",
+		"like",
+		"contains",
+		"in",
+		"not_in",
+		"exists"
+	],
+	email: [
+		"equals",
+		"not_equals",
+		"like",
+		"contains",
+		"in",
+		"not_in",
+		"exists"
+	],
+	code: [
+		"equals",
+		"not_equals",
+		"like",
+		"contains",
+		"exists"
+	],
+	number: [
+		"equals",
+		"not_equals",
+		"greater_than",
+		"greater_than_equal",
+		"less_than",
+		"less_than_equal",
+		"in",
+		"not_in",
+		"exists"
+	],
+	date: [
+		"equals",
+		"not_equals",
+		"greater_than",
+		"greater_than_equal",
+		"less_than",
+		"less_than_equal",
+		"exists"
+	],
+	checkbox: [
+		"equals",
+		"not_equals",
+		"exists"
+	],
+	radio: [
+		"equals",
+		"not_equals",
+		"in",
+		"not_in",
+		"exists"
+	],
+	select: [
+		"equals",
+		"not_equals",
+		"in",
+		"not_in",
+		"exists"
+	],
+	relationship: [
+		"equals",
+		"not_equals",
+		"in",
+		"not_in",
+		"exists"
+	],
+	upload: [
+		"equals",
+		"not_equals",
+		"in",
+		"not_in",
+		"exists"
+	]
+};
+const fieldHasQueryOperators = (field) => Boolean(OPERATORS_BY_TYPE[field.type]);
+const collectionHasFilters = (fields) => exposableFields(fields).some((f) => fieldName(f) && fieldHasQueryOperators(f));
+const buildQueryOperationsSchema = ({ base, fields, ctx }) => {
+	const properties = {};
+	for (const field of exposableFields(fields)) {
+		const name = fieldName(field);
+		const operators = OPERATORS_BY_TYPE[field.type];
+		if (!name || !operators) continue;
+		properties[name] = {
+			type: "object",
+			additionalProperties: false,
+			properties: Object.fromEntries(operators.map((op) => [op, {}]))
+		};
+	}
+	const selfRef = { $ref: refTo(querySchemaName(base)) };
+	properties.and = {
+		type: "array",
+		items: selfRef
+	};
+	properties.or = {
+		type: "array",
+		items: selfRef
+	};
+	return {
+		type: "object",
+		additionalProperties: false,
+		description: makeT(ctx.i18n)("schemaWhere"),
+		properties
+	};
+};
+const objectParam = (name, ref) => ({
+	name,
+	in: "query",
+	content: { "application/json": { schema: ref ? { $ref: ref } : {
+		type: "object",
+		additionalProperties: true
+	} } }
+});
+const localeParam = (ctx) => ({
+	name: "locale",
+	in: "query",
+	description: makeT(ctx.i18n)("paramLocale"),
+	schema: ctx.locales.length > 0 ? {
+		type: "string",
+		enum: [...ctx.locales, "all"]
+	} : { type: "string" }
+});
+const fallbackLocaleParam = (ctx) => ({
+	name: "fallback-locale",
+	in: "query",
+	description: makeT(ctx.i18n)("paramFallbackLocale"),
+	schema: ctx.locales.length > 0 ? {
+		type: "string",
+		enum: [...ctx.locales, "none"]
+	} : { type: "string" }
+});
+const commonReadParams = ({ base, ctx, refs }) => {
+	const params = [
+		{
+			name: "depth",
+			in: "query",
+			description: makeT(ctx.i18n)("paramDepth"),
+			schema: { type: "integer" }
+		},
+		localeParam(ctx),
+		fallbackLocaleParam(ctx),
+		objectParam("select", refs.select ? refTo(selectSchemaName(base)) : void 0),
+		{
+			name: "flattenLocales",
+			in: "query",
+			description: makeT(ctx.i18n)("paramFlattenLocales"),
+			schema: { type: "boolean" }
+		},
+		{
+			name: "draft",
+			in: "query",
+			description: makeT(ctx.i18n)("paramDraft"),
+			schema: { type: "boolean" }
+		},
+		{
+			name: "trash",
+			in: "query",
+			description: makeT(ctx.i18n)("paramTrash"),
+			schema: { type: "boolean" }
+		}
+	];
+	if (refs.populate) params.push(objectParam("populate", refTo(populateSchemaName(base))));
+	if (refs.joins) params.push(objectParam("joins", refTo(joinsSchemaName(base))));
+	return params;
+};
+const SHARED = [
+	"depth",
+	"locale",
+	"fallback-locale",
+	"select",
+	"populate"
+];
+const ALL_LOCALES = ["publishAllLocales", "unpublishAllLocales"];
+const WRITE_PARAMS = {
+	create: /* @__PURE__ */ new Set([
+		...SHARED,
+		"draft",
+		"autosave",
+		"publishAllLocales"
+	]),
+	update: /* @__PURE__ */ new Set([
+		...SHARED,
+		"draft",
+		"trash",
+		"overrideLock",
+		...ALL_LOCALES
+	]),
+	updateByID: /* @__PURE__ */ new Set([
+		...SHARED,
+		"draft",
+		"trash",
+		"autosave",
+		"overrideLock",
+		...ALL_LOCALES
+	]),
+	delete: /* @__PURE__ */ new Set([
+		...SHARED,
+		"trash",
+		"overrideLock"
+	]),
+	duplicate: /* @__PURE__ */ new Set([
+		...SHARED,
+		"draft",
+		"selectedLocales[]"
+	]),
+	globalUpdate: /* @__PURE__ */ new Set([
+		...SHARED,
+		"draft",
+		"autosave",
+		...ALL_LOCALES
+	])
+};
+const entityWriteParams = (entity, ctx) => {
+	const t = makeT(ctx.i18n);
+	const flag = (name, key) => ({
+		name,
+		in: "query",
+		description: t(key),
+		schema: { type: "boolean" }
+	});
+	const drafts = entity.versions ? entity.versions.drafts : false;
+	const params = [];
+	if (drafts && drafts.autosave) params.push(flag("autosave", "paramAutosave"));
+	if (drafts && drafts.localizeStatus) {
+		params.push(flag("publishAllLocales", "paramPublishAllLocales"));
+		params.push(flag("unpublishAllLocales", "paramUnpublishAllLocales"));
+	}
+	if (entity.lockDocuments !== false) params.push(flag("overrideLock", "paramOverrideLock"));
+	if (ctx.locales.length > 0) params.push({
+		name: "selectedLocales[]",
+		in: "query",
+		description: t("paramSelectedLocales"),
+		style: "form",
+		explode: true,
+		schema: {
+			type: "array",
+			items: {
+				type: "string",
+				enum: ctx.locales
+			}
+		}
+	});
+	return params;
+};
+const writeParams = ({ base, entity, ctx, refs, operation }) => [...commonReadParams({
+	base,
+	ctx,
+	refs
+}), ...entityWriteParams(entity, ctx)].filter((p) => WRITE_PARAMS[operation].has(p.name));
+const validateParams = (ctx) => ctx.locales.length > 0 ? [{
+	name: "locale",
+	in: "query",
+	description: makeT(ctx.i18n)("paramValidateLocale"),
+	style: "form",
+	explode: true,
+	schema: {
+		type: "array",
+		items: {
+			type: "string",
+			enum: [...ctx.locales, "all"]
+		}
+	}
+}] : [];
+const whereParam = (base) => objectParam("where", refTo(querySchemaName(base)));
+const buildListParams = ({ base, fields, ctx, refs }) => {
+	const params = [
+		{
+			name: "page",
+			in: "query",
+			schema: { type: "integer" }
+		},
+		{
+			name: "limit",
+			in: "query",
+			schema: { type: "integer" }
+		},
+		{
+			name: "pagination",
+			in: "query",
+			schema: { type: "boolean" }
+		},
+		{
+			name: "sort",
+			in: "query",
+			description: makeT(ctx.i18n)("paramSort"),
+			schema: { type: "string" }
+		},
+		...commonReadParams({
+			base,
+			ctx,
+			refs
+		})
+	];
+	if (collectionHasFilters(fields)) params.push(whereParam(base));
+	return params;
+};
+export { buildJoinsSchema, buildListParams, buildParamSchemas, buildPopulateSchema, buildQueryOperationsSchema, buildSelectSchema, collectionHasFilters, commonReadParams, validateParams, whereParam, writeParams };
+
+//# sourceMappingURL=params.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"params.js","names":[],"sources":["../../../src/server/spec/params.ts"],"sourcesContent":["import type { ParameterObject, ReferenceObject, SchemaObject } from '@scalar/openapi-types/3.2'\nimport type { Field } from 'payload'\n\nimport { makeT } from '@/shared/translations/index.js'\nimport type { BuildContext, Entity } from '@/shared/types/index.js'\n\nimport { exposableFields } from './fields.js'\nimport { joinsSchemaName, populateSchemaName, querySchemaName, refTo, selectSchemaName } from './names.js'\n\nconst fieldName = (field: Field): string | undefined =>\n  'name' in field && typeof field.name === 'string' ? field.name : undefined\n\nconst relationTargets = (field: Field): string[] => {\n  if (field.type !== 'relationship' && field.type !== 'upload') return []\n  const relTo = (field as { relationTo: string | string[] }).relationTo\n  return Array.isArray(relTo) ? relTo : [relTo]\n}\n\nexport const buildSelectSchema = ({ fields, ctx }: { fields: Field[]; ctx: BuildContext }): SchemaObject => {\n  const properties: Record<string, SchemaObject> = {}\n  for (const field of exposableFields(fields)) {\n    const name = fieldName(field)\n    if (name) properties[name] = { type: 'boolean' }\n  }\n  return {\n    type: 'object',\n    additionalProperties: false,\n    description: makeT(ctx.i18n)('schemaSelect'),\n    properties,\n  }\n}\n\nexport const buildPopulateSchema = ({\n  fields,\n  ctx,\n}: {\n  fields: Field[]\n  ctx: BuildContext\n}): SchemaObject | undefined => {\n  const targets = new Set<string>()\n  for (const field of exposableFields(fields)) {\n    for (const target of relationTargets(field)) targets.add(target)\n  }\n  if (targets.size === 0) return undefined\n\n  const properties: Record<string, SchemaObject> = {}\n  for (const target of targets) {\n    properties[target] = { type: 'object', additionalProperties: { type: 'boolean' } }\n  }\n  return {\n    type: 'object',\n    additionalProperties: false,\n    description: makeT(ctx.i18n)('schemaPopulate'),\n    properties,\n  }\n}\n\nexport const buildJoinsSchema = ({ fields, ctx }: { fields: Field[]; ctx: BuildContext }): SchemaObject | undefined => {\n  const joinControls: SchemaObject = {\n    type: 'object',\n    additionalProperties: false,\n    properties: {\n      limit: { type: 'integer' },\n      page: { type: 'integer' },\n      sort: { type: 'string' },\n      count: { type: 'boolean' },\n      where: { type: 'object', additionalProperties: true },\n    },\n  }\n\n  const properties: Record<string, SchemaObject> = {}\n  for (const field of exposableFields(fields)) {\n    if (field.type !== 'join') continue\n    const name = fieldName(field)\n    if (name) properties[name] = joinControls\n  }\n  if (Object.keys(properties).length === 0) return undefined\n  return {\n    type: 'object',\n    additionalProperties: false,\n    description: makeT(ctx.i18n)('schemaJoins'),\n    properties,\n  }\n}\n\nexport interface ParamSchemas {\n  select: SchemaObject\n  populate?: SchemaObject\n  joins?: SchemaObject\n}\n\nexport const buildParamSchemas = ({ fields, ctx }: { fields: Field[]; ctx: BuildContext }): ParamSchemas => ({\n  select: buildSelectSchema({ fields, ctx }),\n  populate: buildPopulateSchema({ fields, ctx }),\n  joins: buildJoinsSchema({ fields, ctx }),\n})\n\nconst OPERATORS_BY_TYPE: Record<string, string[]> = {\n  text: ['equals', 'not_equals', 'like', 'contains', 'in', 'not_in', 'exists'],\n  textarea: ['equals', 'not_equals', 'like', 'contains', 'in', 'not_in', 'exists'],\n  email: ['equals', 'not_equals', 'like', 'contains', 'in', 'not_in', 'exists'],\n  code: ['equals', 'not_equals', 'like', 'contains', 'exists'],\n  number: [\n    'equals',\n    'not_equals',\n    'greater_than',\n    'greater_than_equal',\n    'less_than',\n    'less_than_equal',\n    'in',\n    'not_in',\n    'exists',\n  ],\n  date: ['equals', 'not_equals', 'greater_than', 'greater_than_equal', 'less_than', 'less_than_equal', 'exists'],\n  checkbox: ['equals', 'not_equals', 'exists'],\n  radio: ['equals', 'not_equals', 'in', 'not_in', 'exists'],\n  select: ['equals', 'not_equals', 'in', 'not_in', 'exists'],\n  relationship: ['equals', 'not_equals', 'in', 'not_in', 'exists'],\n  upload: ['equals', 'not_equals', 'in', 'not_in', 'exists'],\n}\n\nconst fieldHasQueryOperators = (field: Field): boolean => Boolean(OPERATORS_BY_TYPE[field.type])\n\nexport const collectionHasFilters = (fields: Field[]): boolean =>\n  exposableFields(fields).some((f) => fieldName(f) && fieldHasQueryOperators(f))\n\nexport const buildQueryOperationsSchema = ({\n  base,\n  fields,\n  ctx,\n}: {\n  base: string\n  fields: Field[]\n  ctx: BuildContext\n}): SchemaObject => {\n  const properties: Record<string, SchemaObject> = {}\n\n  for (const field of exposableFields(fields)) {\n    const name = fieldName(field)\n    const operators = OPERATORS_BY_TYPE[field.type]\n    if (!name || !operators) continue\n    properties[name] = {\n      type: 'object',\n      additionalProperties: false,\n      properties: Object.fromEntries(operators.map((op) => [op, {}])),\n    }\n  }\n\n  const selfRef: ReferenceObject = { $ref: refTo(querySchemaName(base)) }\n  properties.and = { type: 'array', items: selfRef }\n  properties.or = { type: 'array', items: selfRef }\n\n  return {\n    type: 'object',\n    additionalProperties: false,\n    description: makeT(ctx.i18n)('schemaWhere'),\n    properties,\n  }\n}\n\nexport interface ReadParamRefs {\n  select: boolean\n  populate: boolean\n  joins: boolean\n}\n\nconst objectParam = (name: string, ref?: string): ParameterObject => ({\n  name,\n  in: 'query',\n  content: {\n    'application/json': {\n      schema: ref ? { $ref: ref } : { type: 'object', additionalProperties: true },\n    },\n  },\n})\n\nconst localeParam = (ctx: BuildContext): ParameterObject => ({\n  name: 'locale',\n  in: 'query',\n  description: makeT(ctx.i18n)('paramLocale'),\n  schema: ctx.locales.length > 0 ? { type: 'string', enum: [...ctx.locales, 'all'] } : { type: 'string' },\n})\n\nconst fallbackLocaleParam = (ctx: BuildContext): ParameterObject => ({\n  name: 'fallback-locale',\n  in: 'query',\n  description: makeT(ctx.i18n)('paramFallbackLocale'),\n  schema: ctx.locales.length > 0 ? { type: 'string', enum: [...ctx.locales, 'none'] } : { type: 'string' },\n})\n\nexport const commonReadParams = ({\n  base,\n  ctx,\n  refs,\n}: {\n  base: string\n  ctx: BuildContext\n  refs: ReadParamRefs\n}): ParameterObject[] => {\n  const params: ParameterObject[] = [\n    {\n      name: 'depth',\n      in: 'query',\n      description: makeT(ctx.i18n)('paramDepth'),\n      schema: { type: 'integer' },\n    },\n    localeParam(ctx),\n    fallbackLocaleParam(ctx),\n    objectParam('select', refs.select ? refTo(selectSchemaName(base)) : undefined),\n    {\n      name: 'flattenLocales',\n      in: 'query',\n      description: makeT(ctx.i18n)('paramFlattenLocales'),\n      schema: { type: 'boolean' },\n    },\n    { name: 'draft', in: 'query', description: makeT(ctx.i18n)('paramDraft'), schema: { type: 'boolean' } },\n    { name: 'trash', in: 'query', description: makeT(ctx.i18n)('paramTrash'), schema: { type: 'boolean' } },\n  ]\n\n  if (refs.populate) {\n    params.push(objectParam('populate', refTo(populateSchemaName(base))))\n  }\n  if (refs.joins) {\n    params.push(objectParam('joins', refTo(joinsSchemaName(base))))\n  }\n\n  return params\n}\n\nexport type WriteOperation = 'create' | 'update' | 'updateByID' | 'delete' | 'duplicate' | 'globalUpdate'\n\nconst SHARED = ['depth', 'locale', 'fallback-locale', 'select', 'populate']\nconst ALL_LOCALES = ['publishAllLocales', 'unpublishAllLocales']\n\nconst WRITE_PARAMS: Record<WriteOperation, Set<string>> = {\n  create: new Set([...SHARED, 'draft', 'autosave', 'publishAllLocales']),\n  update: new Set([...SHARED, 'draft', 'trash', 'overrideLock', ...ALL_LOCALES]),\n  updateByID: new Set([...SHARED, 'draft', 'trash', 'autosave', 'overrideLock', ...ALL_LOCALES]),\n  delete: new Set([...SHARED, 'trash', 'overrideLock']),\n  duplicate: new Set([...SHARED, 'draft', 'selectedLocales[]']),\n  globalUpdate: new Set([...SHARED, 'draft', 'autosave', ...ALL_LOCALES]),\n}\n\nconst entityWriteParams = (entity: Entity, ctx: BuildContext): ParameterObject[] => {\n  const t = makeT(ctx.i18n)\n  const flag = (name: string, key: Parameters<typeof t>[0]): ParameterObject => ({\n    name,\n    in: 'query',\n    description: t(key),\n    schema: { type: 'boolean' },\n  })\n  const drafts = entity.versions ? entity.versions.drafts : false\n  const params: ParameterObject[] = []\n  if (drafts && drafts.autosave) params.push(flag('autosave', 'paramAutosave'))\n  if (drafts && drafts.localizeStatus) {\n    params.push(flag('publishAllLocales', 'paramPublishAllLocales'))\n    params.push(flag('unpublishAllLocales', 'paramUnpublishAllLocales'))\n  }\n  if (entity.lockDocuments !== false) params.push(flag('overrideLock', 'paramOverrideLock'))\n  if (ctx.locales.length > 0) {\n    params.push({\n      name: 'selectedLocales[]',\n      in: 'query',\n      description: t('paramSelectedLocales'),\n      style: 'form',\n      explode: true,\n      schema: { type: 'array', items: { type: 'string', enum: ctx.locales } },\n    })\n  }\n  return params\n}\n\nexport const writeParams = ({\n  base,\n  entity,\n  ctx,\n  refs,\n  operation,\n}: {\n  base: string\n  entity: Entity\n  ctx: BuildContext\n  refs: ReadParamRefs\n  operation: WriteOperation\n}): ParameterObject[] =>\n  [...commonReadParams({ base, ctx, refs }), ...entityWriteParams(entity, ctx)].filter((p) =>\n    WRITE_PARAMS[operation].has(p.name),\n  )\n\nexport const validateParams = (ctx: BuildContext): ParameterObject[] =>\n  ctx.locales.length > 0\n    ? [\n        {\n          name: 'locale',\n          in: 'query',\n          description: makeT(ctx.i18n)('paramValidateLocale'),\n          style: 'form',\n          explode: true,\n          schema: { type: 'array', items: { type: 'string', enum: [...ctx.locales, 'all'] } },\n        },\n      ]\n    : []\n\nexport const whereParam = (base: string): ParameterObject => objectParam('where', refTo(querySchemaName(base)))\n\nexport const buildListParams = ({\n  base,\n  fields,\n  ctx,\n  refs,\n}: {\n  base: string\n  fields: Field[]\n  ctx: BuildContext\n  refs: ReadParamRefs\n}): ParameterObject[] => {\n  const params: ParameterObject[] = [\n    { name: 'page', in: 'query', schema: { type: 'integer' } },\n    { name: 'limit', in: 'query', schema: { type: 'integer' } },\n    { name: 'pagination', in: 'query', schema: { type: 'boolean' } },\n    {\n      name: 'sort',\n      in: 'query',\n      description: makeT(ctx.i18n)('paramSort'),\n      schema: { type: 'string' },\n    },\n    ...commonReadParams({ base, ctx, refs }),\n  ]\n\n  if (collectionHasFilters(fields)) {\n    params.push(whereParam(base))\n  }\n\n  return params\n}\n"],"mappings":";;;AASA,MAAM,aAAa,UACjB,UAAU,SAAS,OAAO,MAAM,SAAS,WAAW,MAAM,OAAO,KAAA;AAEnE,MAAM,mBAAmB,UAA2B;CAClD,IAAI,MAAM,SAAS,kBAAkB,MAAM,SAAS,UAAU,OAAO,CAAC;CACtE,MAAM,QAAS,MAA4C;CAC3D,OAAO,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK;AAC9C;AAEA,MAAa,qBAAqB,EAAE,QAAQ,UAAgE;CAC1G,MAAM,aAA2C,CAAC;CAClD,KAAK,MAAM,SAAS,gBAAgB,MAAM,GAAG;EAC3C,MAAM,OAAO,UAAU,KAAK;EAC5B,IAAI,MAAM,WAAW,QAAQ,EAAE,MAAM,UAAU;CACjD;CACA,OAAO;EACL,MAAM;EACN,sBAAsB;EACtB,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,cAAc;EAC3C;CACF;AACF;AAEA,MAAa,uBAAuB,EAClC,QACA,UAI8B;CAC9B,MAAM,0BAAU,IAAI,IAAY;CAChC,KAAK,MAAM,SAAS,gBAAgB,MAAM,GACxC,KAAK,MAAM,UAAU,gBAAgB,KAAK,GAAG,QAAQ,IAAI,MAAM;CAEjE,IAAI,QAAQ,SAAS,GAAG,OAAO,KAAA;CAE/B,MAAM,aAA2C,CAAC;CAClD,KAAK,MAAM,UAAU,SACnB,WAAW,UAAU;EAAE,MAAM;EAAU,sBAAsB,EAAE,MAAM,UAAU;CAAE;CAEnF,OAAO;EACL,MAAM;EACN,sBAAsB;EACtB,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,gBAAgB;EAC7C;CACF;AACF;AAEA,MAAa,oBAAoB,EAAE,QAAQ,UAA4E;CACrH,MAAM,eAA6B;EACjC,MAAM;EACN,sBAAsB;EACtB,YAAY;GACV,OAAO,EAAE,MAAM,UAAU;GACzB,MAAM,EAAE,MAAM,UAAU;GACxB,MAAM,EAAE,MAAM,SAAS;GACvB,OAAO,EAAE,MAAM,UAAU;GACzB,OAAO;IAAE,MAAM;IAAU,sBAAsB;GAAK;EACtD;CACF;CAEA,MAAM,aAA2C,CAAC;CAClD,KAAK,MAAM,SAAS,gBAAgB,MAAM,GAAG;EAC3C,IAAI,MAAM,SAAS,QAAQ;EAC3B,MAAM,OAAO,UAAU,KAAK;EAC5B,IAAI,MAAM,WAAW,QAAQ;CAC/B;CACA,IAAI,OAAO,KAAK,UAAU,CAAC,CAAC,WAAW,GAAG,OAAO,KAAA;CACjD,OAAO;EACL,MAAM;EACN,sBAAsB;EACtB,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,aAAa;EAC1C;CACF;AACF;AAQA,MAAa,qBAAqB,EAAE,QAAQ,WAAiE;CAC3G,QAAQ,kBAAkB;EAAE;EAAQ;CAAI,CAAC;CACzC,UAAU,oBAAoB;EAAE;EAAQ;CAAI,CAAC;CAC7C,OAAO,iBAAiB;EAAE;EAAQ;CAAI,CAAC;AACzC;AAEA,MAAM,oBAA8C;CAClD,MAAM;EAAC;EAAU;EAAc;EAAQ;EAAY;EAAM;EAAU;CAAQ;CAC3E,UAAU;EAAC;EAAU;EAAc;EAAQ;EAAY;EAAM;EAAU;CAAQ;CAC/E,OAAO;EAAC;EAAU;EAAc;EAAQ;EAAY;EAAM;EAAU;CAAQ;CAC5E,MAAM;EAAC;EAAU;EAAc;EAAQ;EAAY;CAAQ;CAC3D,QAAQ;EACN;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF;CACA,MAAM;EAAC;EAAU;EAAc;EAAgB;EAAsB;EAAa;EAAmB;CAAQ;CAC7G,UAAU;EAAC;EAAU;EAAc;CAAQ;CAC3C,OAAO;EAAC;EAAU;EAAc;EAAM;EAAU;CAAQ;CACxD,QAAQ;EAAC;EAAU;EAAc;EAAM;EAAU;CAAQ;CACzD,cAAc;EAAC;EAAU;EAAc;EAAM;EAAU;CAAQ;CAC/D,QAAQ;EAAC;EAAU;EAAc;EAAM;EAAU;CAAQ;AAC3D;AAEA,MAAM,0BAA0B,UAA0B,QAAQ,kBAAkB,MAAM,KAAK;AAE/F,MAAa,wBAAwB,WACnC,gBAAgB,MAAM,CAAC,CAAC,MAAM,MAAM,UAAU,CAAC,KAAK,uBAAuB,CAAC,CAAC;AAE/E,MAAa,8BAA8B,EACzC,MACA,QACA,UAKkB;CAClB,MAAM,aAA2C,CAAC;CAElD,KAAK,MAAM,SAAS,gBAAgB,MAAM,GAAG;EAC3C,MAAM,OAAO,UAAU,KAAK;EAC5B,MAAM,YAAY,kBAAkB,MAAM;EAC1C,IAAI,CAAC,QAAQ,CAAC,WAAW;EACzB,WAAW,QAAQ;GACjB,MAAM;GACN,sBAAsB;GACtB,YAAY,OAAO,YAAY,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;EAChE;CACF;CAEA,MAAM,UAA2B,EAAE,MAAM,MAAM,gBAAgB,IAAI,CAAC,EAAE;CACtE,WAAW,MAAM;EAAE,MAAM;EAAS,OAAO;CAAQ;CACjD,WAAW,KAAK;EAAE,MAAM;EAAS,OAAO;CAAQ;CAEhD,OAAO;EACL,MAAM;EACN,sBAAsB;EACtB,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,aAAa;EAC1C;CACF;AACF;AAQA,MAAM,eAAe,MAAc,SAAmC;CACpE;CACA,IAAI;CACJ,SAAS,EACP,oBAAoB,EAClB,QAAQ,MAAM,EAAE,MAAM,IAAI,IAAI;EAAE,MAAM;EAAU,sBAAsB;CAAK,EAC7E,EACF;AACF;AAEA,MAAM,eAAe,SAAwC;CAC3D,MAAM;CACN,IAAI;CACJ,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,aAAa;CAC1C,QAAQ,IAAI,QAAQ,SAAS,IAAI;EAAE,MAAM;EAAU,MAAM,CAAC,GAAG,IAAI,SAAS,KAAK;CAAE,IAAI,EAAE,MAAM,SAAS;AACxG;AAEA,MAAM,uBAAuB,SAAwC;CACnE,MAAM;CACN,IAAI;CACJ,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,qBAAqB;CAClD,QAAQ,IAAI,QAAQ,SAAS,IAAI;EAAE,MAAM;EAAU,MAAM,CAAC,GAAG,IAAI,SAAS,MAAM;CAAE,IAAI,EAAE,MAAM,SAAS;AACzG;AAEA,MAAa,oBAAoB,EAC/B,MACA,KACA,WAKuB;CACvB,MAAM,SAA4B;EAChC;GACE,MAAM;GACN,IAAI;GACJ,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,YAAY;GACzC,QAAQ,EAAE,MAAM,UAAU;EAC5B;EACA,YAAY,GAAG;EACf,oBAAoB,GAAG;EACvB,YAAY,UAAU,KAAK,SAAS,MAAM,iBAAiB,IAAI,CAAC,IAAI,KAAA,CAAS;EAC7E;GACE,MAAM;GACN,IAAI;GACJ,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,qBAAqB;GAClD,QAAQ,EAAE,MAAM,UAAU;EAC5B;EACA;GAAE,MAAM;GAAS,IAAI;GAAS,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,YAAY;GAAG,QAAQ,EAAE,MAAM,UAAU;EAAE;EACtG;GAAE,MAAM;GAAS,IAAI;GAAS,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,YAAY;GAAG,QAAQ,EAAE,MAAM,UAAU;EAAE;CACxG;CAEA,IAAI,KAAK,UACP,OAAO,KAAK,YAAY,YAAY,MAAM,mBAAmB,IAAI,CAAC,CAAC,CAAC;CAEtE,IAAI,KAAK,OACP,OAAO,KAAK,YAAY,SAAS,MAAM,gBAAgB,IAAI,CAAC,CAAC,CAAC;CAGhE,OAAO;AACT;AAIA,MAAM,SAAS;CAAC;CAAS;CAAU;CAAmB;CAAU;AAAU;AAC1E,MAAM,cAAc,CAAC,qBAAqB,qBAAqB;AAE/D,MAAM,eAAoD;CACxD,wBAAQ,IAAI,IAAI;EAAC,GAAG;EAAQ;EAAS;EAAY;CAAmB,CAAC;CACrE,wBAAQ,IAAI,IAAI;EAAC,GAAG;EAAQ;EAAS;EAAS;EAAgB,GAAG;CAAW,CAAC;CAC7E,4BAAY,IAAI,IAAI;EAAC,GAAG;EAAQ;EAAS;EAAS;EAAY;EAAgB,GAAG;CAAW,CAAC;CAC7F,wBAAQ,IAAI,IAAI;EAAC,GAAG;EAAQ;EAAS;CAAc,CAAC;CACpD,2BAAW,IAAI,IAAI;EAAC,GAAG;EAAQ;EAAS;CAAmB,CAAC;CAC5D,8BAAc,IAAI,IAAI;EAAC,GAAG;EAAQ;EAAS;EAAY,GAAG;CAAW,CAAC;AACxE;AAEA,MAAM,qBAAqB,QAAgB,QAAyC;CAClF,MAAM,IAAI,MAAM,IAAI,IAAI;CACxB,MAAM,QAAQ,MAAc,SAAmD;EAC7E;EACA,IAAI;EACJ,aAAa,EAAE,GAAG;EAClB,QAAQ,EAAE,MAAM,UAAU;CAC5B;CACA,MAAM,SAAS,OAAO,WAAW,OAAO,SAAS,SAAS;CAC1D,MAAM,SAA4B,CAAC;CACnC,IAAI,UAAU,OAAO,UAAU,OAAO,KAAK,KAAK,YAAY,eAAe,CAAC;CAC5E,IAAI,UAAU,OAAO,gBAAgB;EACnC,OAAO,KAAK,KAAK,qBAAqB,wBAAwB,CAAC;EAC/D,OAAO,KAAK,KAAK,uBAAuB,0BAA0B,CAAC;CACrE;CACA,IAAI,OAAO,kBAAkB,OAAO,OAAO,KAAK,KAAK,gBAAgB,mBAAmB,CAAC;CACzF,IAAI,IAAI,QAAQ,SAAS,GACvB,OAAO,KAAK;EACV,MAAM;EACN,IAAI;EACJ,aAAa,EAAE,sBAAsB;EACrC,OAAO;EACP,SAAS;EACT,QAAQ;GAAE,MAAM;GAAS,OAAO;IAAE,MAAM;IAAU,MAAM,IAAI;GAAQ;EAAE;CACxE,CAAC;CAEH,OAAO;AACT;AAEA,MAAa,eAAe,EAC1B,MACA,QACA,KACA,MACA,gBAQA,CAAC,GAAG,iBAAiB;CAAE;CAAM;CAAK;AAAK,CAAC,GAAG,GAAG,kBAAkB,QAAQ,GAAG,CAAC,CAAC,CAAC,QAAQ,MACpF,aAAa,UAAU,CAAC,IAAI,EAAE,IAAI,CACpC;AAEF,MAAa,kBAAkB,QAC7B,IAAI,QAAQ,SAAS,IACjB,CACE;CACE,MAAM;CACN,IAAI;CACJ,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,qBAAqB;CAClD,OAAO;CACP,SAAS;CACT,QAAQ;EAAE,MAAM;EAAS,OAAO;GAAE,MAAM;GAAU,MAAM,CAAC,GAAG,IAAI,SAAS,KAAK;EAAE;CAAE;AACpF,CACF,IACA,CAAC;AAEP,MAAa,cAAc,SAAkC,YAAY,SAAS,MAAM,gBAAgB,IAAI,CAAC,CAAC;AAE9G,MAAa,mBAAmB,EAC9B,MACA,QACA,KACA,WAMuB;CACvB,MAAM,SAA4B;EAChC;GAAE,MAAM;GAAQ,IAAI;GAAS,QAAQ,EAAE,MAAM,UAAU;EAAE;EACzD;GAAE,MAAM;GAAS,IAAI;GAAS,QAAQ,EAAE,MAAM,UAAU;EAAE;EAC1D;GAAE,MAAM;GAAc,IAAI;GAAS,QAAQ,EAAE,MAAM,UAAU;EAAE;EAC/D;GACE,MAAM;GACN,IAAI;GACJ,aAAa,MAAM,IAAI,IAAI,CAAC,CAAC,WAAW;GACxC,QAAQ,EAAE,MAAM,SAAS;EAC3B;EACA,GAAG,iBAAiB;GAAE;GAAM;GAAK;EAAK,CAAC;CACzC;CAEA,IAAI,qBAAqB,MAAM,GAC7B,OAAO,KAAK,WAAW,IAAI,CAAC;CAG9B,OAAO;AACT"}

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

@@ -0,0 +1,10 @@
+import { BuildContext } from "../../../shared/types/index.js";
+import { SanitizedCollectionConfig } from "payload";
+import { PathsObject } from "@scalar/openapi-types/3.2";
+export declare const buildAuthPaths: ({ collection, ctx, includeAdmin, nestedTags }: {
+  collection: SanitizedCollectionConfig;
+  ctx: BuildContext;
+  includeAdmin: boolean;
+  nestedTags: boolean;
+}) => PathsObject;
+//# sourceMappingURL=auth.d.ts.map

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

@@ -0,0 +1,190 @@
+import { refTo, schemaName } from "../names.js";
+import { ERRORS, SECURITY_SCHEME_NAME, errorResponses, jsonBody, jsonResponse, messageResponse } from "../components.js";
+import { authTagName } from "../tags.js";
+import { makeT } from "../../../shared/translations/index.js";
+const LOCAL_STRATEGY_ROUTES = [
+	"login",
+	"forgot-password",
+	"reset-password",
+	"first-register",
+	"unlock",
+	"verify/{id}"
+];
+const identifierBody = (auth, extra = {}) => {
+	const email = {
+		type: "string",
+		format: "email"
+	};
+	const username = { type: "string" };
+	const extraRequired = Object.keys(extra);
+	const loginWithUsername = auth?.loginWithUsername;
+	const base = {
+		type: "object",
+		additionalProperties: false
+	};
+	if (!loginWithUsername) return {
+		...base,
+		properties: {
+			email,
+			...extra
+		},
+		required: ["email", ...extraRequired]
+	};
+	if (typeof loginWithUsername === "object" && loginWithUsername.allowEmailLogin) return {
+		...base,
+		properties: {
+			email,
+			username,
+			...extra
+		},
+		...extraRequired.length > 0 ? { required: extraRequired } : {},
+		anyOf: [{ required: ["email"] }, { required: ["username"] }]
+	};
+	return {
+		...base,
+		properties: {
+			username,
+			...extra
+		},
+		required: ["username", ...extraRequired]
+	};
+};
+const buildAuthPaths = ({ collection, ctx, includeAdmin, nestedTags }) => {
+	const auth = collection.auth;
+	if (!auth) return {};
+	const t = makeT(ctx.i18n);
+	const name = schemaName(collection.slug);
+	const base = `${ctx.apiRoute}/${collection.slug}`;
+	const tag = [nestedTags ? authTagName(name) : name];
+	const userRef = { $ref: refTo(name) };
+	const op = (operationId, codes, extra) => ({
+		tags: tag,
+		operationId,
+		...extra,
+		responses: {
+			...extra.responses,
+			...errorResponses(codes, t)
+		}
+	});
+	const paths = {
+		[`${base}/login`]: { post: op(`login${name}`, ERRORS.login, {
+			requestBody: jsonBody(identifierBody(auth, { password: { type: "string" } })),
+			responses: { "200": jsonResponse(t("authLogin"), {
+				type: "object",
+				properties: {
+					message: { type: "string" },
+					user: userRef,
+					token: { type: "string" },
+					exp: { type: "integer" }
+				}
+			}) }
+		}) },
+		[`${base}/logout`]: { post: op(`logout${name}`, ERRORS.session, { responses: messageResponse(t("authLogout")) }) },
+		[`${base}/me`]: { get: op(`me${name}`, ERRORS.session, { responses: { "200": jsonResponse(t("authMe"), {
+			type: "object",
+			properties: {
+				user: userRef,
+				collection: { type: "string" },
+				token: { type: "string" },
+				exp: { type: "integer" }
+			}
+		}) } }) },
+		[`${base}/refresh-token`]: { post: op(`refreshToken${name}`, ERRORS.session, { responses: { "200": jsonResponse(t("authRefreshToken"), {
+			type: "object",
+			properties: {
+				message: { type: "string" },
+				refreshedToken: { type: "string" },
+				exp: { type: "integer" },
+				user: userRef
+			}
+		}) } }) },
+		[`${base}/forgot-password`]: { post: op(`forgotPassword${name}`, ERRORS.authAction, {
+			requestBody: jsonBody(identifierBody(auth)),
+			responses: messageResponse(t("authForgotPassword"))
+		}) },
+		[`${base}/reset-password`]: { post: op(`resetPassword${name}`, ERRORS.authAction, {
+			requestBody: jsonBody({
+				type: "object",
+				additionalProperties: false,
+				properties: {
+					token: { type: "string" },
+					password: { type: "string" }
+				},
+				required: ["token", "password"]
+			}),
+			responses: { "200": jsonResponse(t("authResetPassword"), {
+				type: "object",
+				properties: {
+					message: { type: "string" },
+					token: { type: "string" },
+					user: userRef
+				}
+			}) }
+		}) }
+	};
+	if (includeAdmin) {
+		paths[`${base}/first-register`] = { post: op(`firstRegister${name}`, ERRORS.create, {
+			requestBody: jsonBody({ $ref: refTo(`${name}Create`) }),
+			responses: { "200": jsonResponse(t("authFirstRegister"), {
+				type: "object",
+				properties: {
+					message: { type: "string" },
+					user: userRef,
+					token: { type: "string" },
+					exp: { type: "integer" }
+				}
+			}) }
+		}) };
+		paths[`${base}/init`] = { get: op(`init${name}`, ERRORS.session, { responses: { "200": jsonResponse(t("authInit"), {
+			type: "object",
+			properties: { initialized: { type: "boolean" } }
+		}) } }) };
+	}
+	paths[`${base}/unlock`] = { post: op(`unlock${name}`, ERRORS.authAction, {
+		requestBody: jsonBody(identifierBody(auth)),
+		responses: messageResponse(t("authUnlock"))
+	}) };
+	if (auth.verify) paths[`${base}/verify/{id}`] = { post: op(`verify${name}`, ERRORS.authAction, {
+		parameters: [{
+			name: "id",
+			in: "path",
+			required: true,
+			schema: { type: "string" }
+		}],
+		responses: messageResponse(t("authVerify"))
+	}) };
+	if (auth.disableLocalStrategy) for (const route of LOCAL_STRATEGY_ROUTES) delete paths[`${base}/${route}`];
+	if (typeof auth.useAPIKey === "object" && auth.useAPIKey.reveal === true) {
+		const errorBody = (description) => jsonResponse(description, {
+			type: "object",
+			properties: { error: { type: "string" } }
+		});
+		paths[`${base}/{id}/api-key/reveal`] = {
+			parameters: [{
+				name: "id",
+				in: "path",
+				required: true,
+				schema: { type: ctx.defaultIDType === "number" ? "integer" : "string" }
+			}],
+			post: {
+				tags: tag,
+				operationId: `revealApiKey${name}`,
+				responses: {
+					"200": jsonResponse(t("apiKeyReveal"), {
+						type: "object",
+						properties: { apiKey: { type: "string" } },
+						required: ["apiKey"]
+					}),
+					"403": errorBody(t("error403")),
+					"404": errorBody(t("error404")),
+					...errorResponses(["500"], t)
+				},
+				security: [{ [SECURITY_SCHEME_NAME]: [] }]
+			}
+		};
+	}
+	return paths;
+};
+export { buildAuthPaths };
+
+//# sourceMappingURL=auth.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","names":[],"sources":["../../../../src/server/spec/paths/auth.ts"],"sourcesContent":["import type {\n  OperationObject,\n  PathsObject,\n  ReferenceObject,\n  ResponsesObject,\n  SchemaObject,\n} from '@scalar/openapi-types/3.2'\nimport type { SanitizedCollectionConfig } from 'payload'\n\nimport {\n  ERRORS,\n  type ErrorCode,\n  SECURITY_SCHEME_NAME,\n  errorResponses,\n  jsonBody,\n  jsonResponse,\n  messageResponse,\n} from '@/server/spec/components.js'\nimport { refTo, schemaName } from '@/server/spec/names.js'\nimport { authTagName } from '@/server/spec/tags.js'\nimport { makeT } from '@/shared/translations/index.js'\nimport type { BuildContext } from '@/shared/types/index.js'\n\nconst LOCAL_STRATEGY_ROUTES = ['login', 'forgot-password', 'reset-password', 'first-register', 'unlock', 'verify/{id}']\n\nconst identifierBody = (\n  auth: SanitizedCollectionConfig['auth'],\n  extra: Record<string, SchemaObject> = {},\n): SchemaObject => {\n  const email: SchemaObject = { type: 'string', format: 'email' }\n  const username: SchemaObject = { type: 'string' }\n  const extraRequired = Object.keys(extra)\n  const loginWithUsername = auth?.loginWithUsername\n  const base = { type: 'object', additionalProperties: false } as const\n\n  if (!loginWithUsername) {\n    return { ...base, properties: { email, ...extra }, required: ['email', ...extraRequired] }\n  }\n  if (typeof loginWithUsername === 'object' && loginWithUsername.allowEmailLogin) {\n    return {\n      ...base,\n      properties: { email, username, ...extra },\n      ...(extraRequired.length > 0 ? { required: extraRequired } : {}),\n      anyOf: [{ required: ['email'] }, { required: ['username'] }],\n    }\n  }\n  return { ...base, properties: { username, ...extra }, required: ['username', ...extraRequired] }\n}\n\nexport const buildAuthPaths = ({\n  collection,\n  ctx,\n  includeAdmin,\n  nestedTags,\n}: {\n  collection: SanitizedCollectionConfig\n  ctx: BuildContext\n  includeAdmin: boolean\n  nestedTags: boolean\n}): PathsObject => {\n  const auth = collection.auth\n  if (!auth) return {}\n\n  const t = makeT(ctx.i18n)\n  const name = schemaName(collection.slug)\n  const base = `${ctx.apiRoute}/${collection.slug}`\n  const tag = [nestedTags ? authTagName(name) : name]\n  const userRef: ReferenceObject = { $ref: refTo(name) }\n\n  const op = (\n    operationId: string,\n    codes: ErrorCode[],\n    extra: Omit<OperationObject, 'tags' | 'operationId'> & { responses: ResponsesObject },\n  ): OperationObject => ({\n    tags: tag,\n    operationId,\n    ...extra,\n    responses: { ...extra.responses, ...errorResponses(codes, t) },\n  })\n\n  const paths: PathsObject = {\n    [`${base}/login`]: {\n      post: op(`login${name}`, ERRORS.login, {\n        requestBody: jsonBody(identifierBody(auth, { password: { type: 'string' } })),\n        responses: {\n          '200': jsonResponse(t('authLogin'), {\n            type: 'object',\n            properties: {\n              message: { type: 'string' },\n              user: userRef,\n              token: { type: 'string' },\n              exp: { type: 'integer' },\n            },\n          }),\n        },\n      }),\n    },\n    [`${base}/logout`]: {\n      post: op(`logout${name}`, ERRORS.session, { responses: messageResponse(t('authLogout')) }),\n    },\n    [`${base}/me`]: {\n      get: op(`me${name}`, ERRORS.session, {\n        responses: {\n          '200': jsonResponse(t('authMe'), {\n            type: 'object',\n            properties: {\n              user: userRef,\n              collection: { type: 'string' },\n              token: { type: 'string' },\n              exp: { type: 'integer' },\n            },\n          }),\n        },\n      }),\n    },\n    [`${base}/refresh-token`]: {\n      post: op(`refreshToken${name}`, ERRORS.session, {\n        responses: {\n          '200': jsonResponse(t('authRefreshToken'), {\n            type: 'object',\n            properties: {\n              message: { type: 'string' },\n              refreshedToken: { type: 'string' },\n              exp: { type: 'integer' },\n              user: userRef,\n            },\n          }),\n        },\n      }),\n    },\n    [`${base}/forgot-password`]: {\n      post: op(`forgotPassword${name}`, ERRORS.authAction, {\n        requestBody: jsonBody(identifierBody(auth)),\n        responses: messageResponse(t('authForgotPassword')),\n      }),\n    },\n    [`${base}/reset-password`]: {\n      post: op(`resetPassword${name}`, ERRORS.authAction, {\n        requestBody: jsonBody({\n          type: 'object',\n          additionalProperties: false,\n          properties: { token: { type: 'string' }, password: { type: 'string' } },\n          required: ['token', 'password'],\n        }),\n        responses: {\n          '200': jsonResponse(t('authResetPassword'), {\n            type: 'object',\n            properties: {\n              message: { type: 'string' },\n              token: { type: 'string' },\n              user: userRef,\n            },\n          }),\n        },\n      }),\n    },\n  }\n\n  if (includeAdmin) {\n    paths[`${base}/first-register`] = {\n      post: op(`firstRegister${name}`, ERRORS.create, {\n        requestBody: jsonBody({ $ref: refTo(`${name}Create`) } as SchemaObject),\n        responses: {\n          '200': jsonResponse(t('authFirstRegister'), {\n            type: 'object',\n            properties: {\n              message: { type: 'string' },\n              user: userRef,\n              token: { type: 'string' },\n              exp: { type: 'integer' },\n            },\n          }),\n        },\n      }),\n    }\n    paths[`${base}/init`] = {\n      get: op(`init${name}`, ERRORS.session, {\n        responses: {\n          '200': jsonResponse(t('authInit'), {\n            type: 'object',\n            properties: { initialized: { type: 'boolean' } },\n          }),\n        },\n      }),\n    }\n  }\n\n  paths[`${base}/unlock`] = {\n    post: op(`unlock${name}`, ERRORS.authAction, {\n      requestBody: jsonBody(identifierBody(auth)),\n      responses: messageResponse(t('authUnlock')),\n    }),\n  }\n\n  if (auth.verify) {\n    paths[`${base}/verify/{id}`] = {\n      post: op(`verify${name}`, ERRORS.authAction, {\n        parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'string' } }],\n        responses: messageResponse(t('authVerify')),\n      }),\n    }\n  }\n\n  if (auth.disableLocalStrategy) {\n    for (const route of LOCAL_STRATEGY_ROUTES) delete paths[`${base}/${route}`]\n  }\n\n  if (typeof auth.useAPIKey === 'object' && auth.useAPIKey.reveal === true) {\n    const errorBody = (description: string) =>\n      jsonResponse(description, { type: 'object', properties: { error: { type: 'string' } } })\n    paths[`${base}/{id}/api-key/reveal`] = {\n      parameters: [\n        {\n          name: 'id',\n          in: 'path',\n          required: true,\n          schema: { type: ctx.defaultIDType === 'number' ? 'integer' : 'string' },\n        },\n      ],\n      post: {\n        tags: tag,\n        operationId: `revealApiKey${name}`,\n        responses: {\n          '200': jsonResponse(t('apiKeyReveal'), {\n            type: 'object',\n            properties: { apiKey: { type: 'string' } },\n            required: ['apiKey'],\n          }),\n          '403': errorBody(t('error403')),\n          '404': errorBody(t('error404')),\n          ...errorResponses(['500'], t),\n        },\n        security: [{ [SECURITY_SCHEME_NAME]: [] }],\n      },\n    }\n  }\n\n  return paths\n}\n"],"mappings":";;;;AAuBA,MAAM,wBAAwB;CAAC;CAAS;CAAmB;CAAkB;CAAkB;CAAU;AAAa;AAEtH,MAAM,kBACJ,MACA,QAAsC,CAAC,MACtB;CACjB,MAAM,QAAsB;EAAE,MAAM;EAAU,QAAQ;CAAQ;CAC9D,MAAM,WAAyB,EAAE,MAAM,SAAS;CAChD,MAAM,gBAAgB,OAAO,KAAK,KAAK;CACvC,MAAM,oBAAoB,MAAM;CAChC,MAAM,OAAO;EAAE,MAAM;EAAU,sBAAsB;CAAM;CAE3D,IAAI,CAAC,mBACH,OAAO;EAAE,GAAG;EAAM,YAAY;GAAE;GAAO,GAAG;EAAM;EAAG,UAAU,CAAC,SAAS,GAAG,aAAa;CAAE;CAE3F,IAAI,OAAO,sBAAsB,YAAY,kBAAkB,iBAC7D,OAAO;EACL,GAAG;EACH,YAAY;GAAE;GAAO;GAAU,GAAG;EAAM;EACxC,GAAI,cAAc,SAAS,IAAI,EAAE,UAAU,cAAc,IAAI,CAAC;EAC9D,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,CAAC,UAAU,EAAE,CAAC;CAC7D;CAEF,OAAO;EAAE,GAAG;EAAM,YAAY;GAAE;GAAU,GAAG;EAAM;EAAG,UAAU,CAAC,YAAY,GAAG,aAAa;CAAE;AACjG;AAEA,MAAa,kBAAkB,EAC7B,YACA,KACA,cACA,iBAMiB;CACjB,MAAM,OAAO,WAAW;CACxB,IAAI,CAAC,MAAM,OAAO,CAAC;CAEnB,MAAM,IAAI,MAAM,IAAI,IAAI;CACxB,MAAM,OAAO,WAAW,WAAW,IAAI;CACvC,MAAM,OAAO,GAAG,IAAI,SAAS,GAAG,WAAW;CAC3C,MAAM,MAAM,CAAC,aAAa,YAAY,IAAI,IAAI,IAAI;CAClD,MAAM,UAA2B,EAAE,MAAM,MAAM,IAAI,EAAE;CAErD,MAAM,MACJ,aACA,OACA,WACqB;EACrB,MAAM;EACN;EACA,GAAG;EACH,WAAW;GAAE,GAAG,MAAM;GAAW,GAAG,eAAe,OAAO,CAAC;EAAE;CAC/D;CAEA,MAAM,QAAqB;GACxB,GAAG,KAAK,UAAU,EACjB,MAAM,GAAG,QAAQ,QAAQ,OAAO,OAAO;GACrC,aAAa,SAAS,eAAe,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,EAAE,CAAC,CAAC;GAC5E,WAAW,EACT,OAAO,aAAa,EAAE,WAAW,GAAG;IAClC,MAAM;IACN,YAAY;KACV,SAAS,EAAE,MAAM,SAAS;KAC1B,MAAM;KACN,OAAO,EAAE,MAAM,SAAS;KACxB,KAAK,EAAE,MAAM,UAAU;IACzB;GACF,CAAC,EACH;EACF,CAAC,EACH;GACC,GAAG,KAAK,WAAW,EAClB,MAAM,GAAG,SAAS,QAAQ,OAAO,SAAS,EAAE,WAAW,gBAAgB,EAAE,YAAY,CAAC,EAAE,CAAC,EAC3F;GACC,GAAG,KAAK,OAAO,EACd,KAAK,GAAG,KAAK,QAAQ,OAAO,SAAS,EACnC,WAAW,EACT,OAAO,aAAa,EAAE,QAAQ,GAAG;GAC/B,MAAM;GACN,YAAY;IACV,MAAM;IACN,YAAY,EAAE,MAAM,SAAS;IAC7B,OAAO,EAAE,MAAM,SAAS;IACxB,KAAK,EAAE,MAAM,UAAU;GACzB;EACF,CAAC,EACH,EACF,CAAC,EACH;GACC,GAAG,KAAK,kBAAkB,EACzB,MAAM,GAAG,eAAe,QAAQ,OAAO,SAAS,EAC9C,WAAW,EACT,OAAO,aAAa,EAAE,kBAAkB,GAAG;GACzC,MAAM;GACN,YAAY;IACV,SAAS,EAAE,MAAM,SAAS;IAC1B,gBAAgB,EAAE,MAAM,SAAS;IACjC,KAAK,EAAE,MAAM,UAAU;IACvB,MAAM;GACR;EACF,CAAC,EACH,EACF,CAAC,EACH;GACC,GAAG,KAAK,oBAAoB,EAC3B,MAAM,GAAG,iBAAiB,QAAQ,OAAO,YAAY;GACnD,aAAa,SAAS,eAAe,IAAI,CAAC;GAC1C,WAAW,gBAAgB,EAAE,oBAAoB,CAAC;EACpD,CAAC,EACH;GACC,GAAG,KAAK,mBAAmB,EAC1B,MAAM,GAAG,gBAAgB,QAAQ,OAAO,YAAY;GAClD,aAAa,SAAS;IACpB,MAAM;IACN,sBAAsB;IACtB,YAAY;KAAE,OAAO,EAAE,MAAM,SAAS;KAAG,UAAU,EAAE,MAAM,SAAS;IAAE;IACtE,UAAU,CAAC,SAAS,UAAU;GAChC,CAAC;GACD,WAAW,EACT,OAAO,aAAa,EAAE,mBAAmB,GAAG;IAC1C,MAAM;IACN,YAAY;KACV,SAAS,EAAE,MAAM,SAAS;KAC1B,OAAO,EAAE,MAAM,SAAS;KACxB,MAAM;IACR;GACF,CAAC,EACH;EACF,CAAC,EACH;CACF;CAEA,IAAI,cAAc;EAChB,MAAM,GAAG,KAAK,oBAAoB,EAChC,MAAM,GAAG,gBAAgB,QAAQ,OAAO,QAAQ;GAC9C,aAAa,SAAS,EAAE,MAAM,MAAM,GAAG,KAAK,OAAO,EAAE,CAAiB;GACtE,WAAW,EACT,OAAO,aAAa,EAAE,mBAAmB,GAAG;IAC1C,MAAM;IACN,YAAY;KACV,SAAS,EAAE,MAAM,SAAS;KAC1B,MAAM;KACN,OAAO,EAAE,MAAM,SAAS;KACxB,KAAK,EAAE,MAAM,UAAU;IACzB;GACF,CAAC,EACH;EACF,CAAC,EACH;EACA,MAAM,GAAG,KAAK,UAAU,EACtB,KAAK,GAAG,OAAO,QAAQ,OAAO,SAAS,EACrC,WAAW,EACT,OAAO,aAAa,EAAE,UAAU,GAAG;GACjC,MAAM;GACN,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,EAAE;EACjD,CAAC,EACH,EACF,CAAC,EACH;CACF;CAEA,MAAM,GAAG,KAAK,YAAY,EACxB,MAAM,GAAG,SAAS,QAAQ,OAAO,YAAY;EAC3C,aAAa,SAAS,eAAe,IAAI,CAAC;EAC1C,WAAW,gBAAgB,EAAE,YAAY,CAAC;CAC5C,CAAC,EACH;CAEA,IAAI,KAAK,QACP,MAAM,GAAG,KAAK,iBAAiB,EAC7B,MAAM,GAAG,SAAS,QAAQ,OAAO,YAAY;EAC3C,YAAY,CAAC;GAAE,MAAM;GAAM,IAAI;GAAQ,UAAU;GAAM,QAAQ,EAAE,MAAM,SAAS;EAAE,CAAC;EACnF,WAAW,gBAAgB,EAAE,YAAY,CAAC;CAC5C,CAAC,EACH;CAGF,IAAI,KAAK,sBACP,KAAK,MAAM,SAAS,uBAAuB,OAAO,MAAM,GAAG,KAAK,GAAG;CAGrE,IAAI,OAAO,KAAK,cAAc,YAAY,KAAK,UAAU,WAAW,MAAM;EACxE,MAAM,aAAa,gBACjB,aAAa,aAAa;GAAE,MAAM;GAAU,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,EAAE;EAAE,CAAC;EACzF,MAAM,GAAG,KAAK,yBAAyB;GACrC,YAAY,CACV;IACE,MAAM;IACN,IAAI;IACJ,UAAU;IACV,QAAQ,EAAE,MAAM,IAAI,kBAAkB,WAAW,YAAY,SAAS;GACxE,CACF;GACA,MAAM;IACJ,MAAM;IACN,aAAa,eAAe;IAC5B,WAAW;KACT,OAAO,aAAa,EAAE,cAAc,GAAG;MACrC,MAAM;MACN,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,EAAE;MACzC,UAAU,CAAC,QAAQ;KACrB,CAAC;KACD,OAAO,UAAU,EAAE,UAAU,CAAC;KAC9B,OAAO,UAAU,EAAE,UAAU,CAAC;KAC9B,GAAG,eAAe,CAAC,KAAK,GAAG,CAAC;IAC9B;IACA,UAAU,CAAC,GAAG,uBAAuB,CAAC,EAAE,CAAC;GAC3C;EACF;CACF;CAEA,OAAO;AACT"}

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

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