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

package/dist/server/spec/plugins/mcp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcp.js","names":[],"sources":["../../../../src/server/spec/plugins/mcp.ts"],"sourcesContent":["import type { OperationObject, SchemaObject } from '@scalar/openapi-types/3.2'\n\nimport { ERROR_SCHEMA_NAME, errorResponses, jsonBody, jsonResponse } from '@/server/spec/components.js'\nimport { refTo } from '@/server/spec/names.js'\n\nimport { type OfficialPlugin, mountEndpoints } from './shared.js'\n\nconst TAG = 'MCP'\n\nconst jsonRpcId: SchemaObject = { type: ['string', 'integer', 'null'] }\n\nconst jsonRpc: SchemaObject = {\n  type: 'object',\n  additionalProperties: true,\n  properties: {\n    jsonrpc: { type: 'string', enum: ['2.0'] },\n    id: jsonRpcId,\n    method: { type: 'string' },\n    params: { type: 'object', additionalProperties: true },\n    result: {},\n    error: { type: 'object', additionalProperties: true },\n  },\n  required: ['jsonrpc'],\n}\n\nconst jsonRpcBatch: SchemaObject = { oneOf: [jsonRpc, { type: 'array', items: jsonRpc }] }\n\nconst jsonRpcError: SchemaObject = {\n  type: 'object',\n  properties: {\n    jsonrpc: { type: 'string', enum: ['2.0'] },\n    error: {\n      type: 'object',\n      properties: { code: { type: 'integer' }, message: { type: 'string' }, data: {} },\n      required: ['code', 'message'],\n    },\n    id: jsonRpcId,\n  },\n  required: ['jsonrpc', 'error', 'id'],\n}\n\nexport const mcp: OfficialPlugin = {\n  slug: '@payloadcms/plugin-mcp',\n  tag: TAG,\n  build: ({ config, ctx, t }) => {\n    const rpcError = (description: string) => jsonResponse(description, jsonRpcError)\n    const post: OperationObject = {\n      tags: [TAG],\n      operationId: 'mcp',\n      summary: t('mcp'),\n      description: t('mcpDesc'),\n      parameters: [\n        {\n          name: 'overrideAccess',\n          in: 'query',\n          description: t('mcpOverrideAccess'),\n          schema: { type: 'string', enum: ['true', 'false'] },\n        },\n        {\n          name: 'MCP-Protocol-Version',\n          in: 'header',\n          description: t('mcpProtocolVersion'),\n          schema: { type: 'string' },\n        },\n      ],\n      requestBody: jsonBody(jsonRpcBatch),\n      responses: {\n        '200': jsonResponse(t('mcpResult'), jsonRpcBatch),\n        '202': { description: t('mcpResult202') },\n        '400': jsonResponse(t('errorPlugin400'), { oneOf: [jsonRpcError, { $ref: refTo(ERROR_SCHEMA_NAME) }] }),\n        ...errorResponses(['401'], t),\n        '404': rpcError(t('errorPluginMcp404')),\n        '406': rpcError(t('errorPluginMcp406')),\n        '413': rpcError(t('errorPluginMcp413')),\n        '415': rpcError(t('errorPluginMcp415')),\n        '500': rpcError(t('errorPlugin500')),\n      },\n    }\n    const get: OperationObject = {\n      tags: [TAG],\n      operationId: 'mcpStream',\n      summary: t('mcpGet'),\n      responses: {\n        '405': {\n          description: t('errorPluginMcpGet405'),\n          headers: { Allow: { schema: { type: 'string', enum: ['POST'] } } },\n        },\n      },\n    }\n    return [\n      {\n        paths: mountEndpoints(config.endpoints, ctx.apiRoute, ({ method, path }) => {\n          if (path !== '/mcp') return undefined\n          if (method === 'post') return post\n          return method === 'get' ? get : undefined\n        }),\n      },\n    ]\n  },\n}\n"],"mappings":";;;AAOA,MAAM,MAAM;AAEZ,MAAM,YAA0B,EAAE,MAAM;CAAC;CAAU;CAAW;AAAM,EAAE;AAEtE,MAAM,UAAwB;CAC5B,MAAM;CACN,sBAAsB;CACtB,YAAY;EACV,SAAS;GAAE,MAAM;GAAU,MAAM,CAAC,KAAK;EAAE;EACzC,IAAI;EACJ,QAAQ,EAAE,MAAM,SAAS;EACzB,QAAQ;GAAE,MAAM;GAAU,sBAAsB;EAAK;EACrD,QAAQ,CAAC;EACT,OAAO;GAAE,MAAM;GAAU,sBAAsB;EAAK;CACtD;CACA,UAAU,CAAC,SAAS;AACtB;AAEA,MAAM,eAA6B,EAAE,OAAO,CAAC,SAAS;CAAE,MAAM;CAAS,OAAO;AAAQ,CAAC,EAAE;AAEzF,MAAM,eAA6B;CACjC,MAAM;CACN,YAAY;EACV,SAAS;GAAE,MAAM;GAAU,MAAM,CAAC,KAAK;EAAE;EACzC,OAAO;GACL,MAAM;GACN,YAAY;IAAE,MAAM,EAAE,MAAM,UAAU;IAAG,SAAS,EAAE,MAAM,SAAS;IAAG,MAAM,CAAC;GAAE;GAC/E,UAAU,CAAC,QAAQ,SAAS;EAC9B;EACA,IAAI;CACN;CACA,UAAU;EAAC;EAAW;EAAS;CAAI;AACrC;AAEA,MAAa,MAAsB;CACjC,MAAM;CACN,KAAK;CACL,QAAQ,EAAE,QAAQ,KAAK,QAAQ;EAC7B,MAAM,YAAY,gBAAwB,aAAa,aAAa,YAAY;EAChF,MAAM,OAAwB;GAC5B,MAAM,CAAC,GAAG;GACV,aAAa;GACb,SAAS,EAAE,KAAK;GAChB,aAAa,EAAE,SAAS;GACxB,YAAY,CACV;IACE,MAAM;IACN,IAAI;IACJ,aAAa,EAAE,mBAAmB;IAClC,QAAQ;KAAE,MAAM;KAAU,MAAM,CAAC,QAAQ,OAAO;IAAE;GACpD,GACA;IACE,MAAM;IACN,IAAI;IACJ,aAAa,EAAE,oBAAoB;IACnC,QAAQ,EAAE,MAAM,SAAS;GAC3B,CACF;GACA,aAAa,SAAS,YAAY;GAClC,WAAW;IACT,OAAO,aAAa,EAAE,WAAW,GAAG,YAAY;IAChD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE;IACxC,OAAO,aAAa,EAAE,gBAAgB,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,MAAM,iBAAiB,EAAE,CAAC,EAAE,CAAC;IACtG,GAAG,eAAe,CAAC,KAAK,GAAG,CAAC;IAC5B,OAAO,SAAS,EAAE,mBAAmB,CAAC;IACtC,OAAO,SAAS,EAAE,mBAAmB,CAAC;IACtC,OAAO,SAAS,EAAE,mBAAmB,CAAC;IACtC,OAAO,SAAS,EAAE,mBAAmB,CAAC;IACtC,OAAO,SAAS,EAAE,gBAAgB,CAAC;GACrC;EACF;EACA,MAAM,MAAuB;GAC3B,MAAM,CAAC,GAAG;GACV,aAAa;GACb,SAAS,EAAE,QAAQ;GACnB,WAAW,EACT,OAAO;IACL,aAAa,EAAE,sBAAsB;IACrC,SAAS,EAAE,OAAO,EAAE,QAAQ;KAAE,MAAM;KAAU,MAAM,CAAC,MAAM;IAAE,EAAE,EAAE;GACnE,EACF;EACF;EACA,OAAO,CACL,EACE,OAAO,eAAe,OAAO,WAAW,IAAI,WAAW,EAAE,QAAQ,WAAW;GAC1E,IAAI,SAAS,QAAQ,OAAO,KAAA;GAC5B,IAAI,WAAW,QAAQ,OAAO;GAC9B,OAAO,WAAW,QAAQ,MAAM,KAAA;EAClC,CAAC,EACH,CACF;CACF;AACF"}

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

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

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

@@ -0,0 +1,39 @@
+import { schemaName } from "../names.js";
+import { errorResponses, jsonResponse } from "../components.js";
+import { securedRequirement } from "../security.js";
+import { collectionGroups } from "./shared.js";
+const TAG = "Multi-tenant";
+const multiTenant = {
+	slug: "@payloadcms/plugin-multi-tenant",
+	tag: TAG,
+	build: ({ collections, ctx, options, t }) => {
+		const tenantsSlug = options?.tenantsSlug || "tenants";
+		return collectionGroups(collections.filter((c) => c.slug === tenantsSlug), ctx, ({ method, path }, collection) => method === "get" && path === "/populate-tenant-options" ? {
+			tags: [TAG],
+			operationId: `populate${schemaName(collection.slug)}Options`,
+			summary: t("tenantOptions"),
+			responses: {
+				"200": jsonResponse(t("tenantOptionsResult"), {
+					type: "object",
+					properties: { tenantOptions: {
+						type: "array",
+						items: {
+							type: "object",
+							properties: {
+								label: { type: "string" },
+								value: { oneOf: [{ type: "string" }, { type: "number" }] }
+							},
+							required: ["label", "value"]
+						}
+					} },
+					required: ["tenantOptions"]
+				}),
+				...errorResponses(["401"], t)
+			},
+			security: securedRequirement()
+		} : void 0);
+	}
+};
+export { multiTenant };
+
+//# sourceMappingURL=multiTenant.js.map

package/dist/server/spec/plugins/multiTenant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multiTenant.js","names":[],"sources":["../../../../src/server/spec/plugins/multiTenant.ts"],"sourcesContent":["import { errorResponses, jsonResponse } from '@/server/spec/components.js'\nimport { schemaName } from '@/server/spec/names.js'\nimport { securedRequirement } from '@/server/spec/security.js'\n\nimport { type OfficialPlugin, collectionGroups } from './shared.js'\n\nconst TAG = 'Multi-tenant'\n\nexport const multiTenant: OfficialPlugin = {\n  slug: '@payloadcms/plugin-multi-tenant',\n  tag: TAG,\n  build: ({ collections, ctx, options, t }) => {\n    const tenantsSlug = (options?.tenantsSlug as string | undefined) || 'tenants'\n    return collectionGroups(\n      collections.filter((c) => c.slug === tenantsSlug),\n      ctx,\n      ({ method, path }, collection) =>\n        method === 'get' && path === '/populate-tenant-options'\n          ? {\n              tags: [TAG],\n              operationId: `populate${schemaName(collection.slug)}Options`,\n              summary: t('tenantOptions'),\n              responses: {\n                '200': jsonResponse(t('tenantOptionsResult'), {\n                  type: 'object',\n                  properties: {\n                    tenantOptions: {\n                      type: 'array',\n                      items: {\n                        type: 'object',\n                        properties: {\n                          label: { type: 'string' },\n                          value: { oneOf: [{ type: 'string' }, { type: 'number' }] },\n                        },\n                        required: ['label', 'value'],\n                      },\n                    },\n                  },\n                  required: ['tenantOptions'],\n                }),\n                ...errorResponses(['401'], t),\n              },\n              security: securedRequirement(),\n            }\n          : undefined,\n    )\n  },\n}\n"],"mappings":";;;;AAMA,MAAM,MAAM;AAEZ,MAAa,cAA8B;CACzC,MAAM;CACN,KAAK;CACL,QAAQ,EAAE,aAAa,KAAK,SAAS,QAAQ;EAC3C,MAAM,cAAe,SAAS,eAAsC;EACpE,OAAO,iBACL,YAAY,QAAQ,MAAM,EAAE,SAAS,WAAW,GAChD,MACC,EAAE,QAAQ,QAAQ,eACjB,WAAW,SAAS,SAAS,6BACzB;GACE,MAAM,CAAC,GAAG;GACV,aAAa,WAAW,WAAW,WAAW,IAAI,EAAE;GACpD,SAAS,EAAE,eAAe;GAC1B,WAAW;IACT,OAAO,aAAa,EAAE,qBAAqB,GAAG;KAC5C,MAAM;KACN,YAAY,EACV,eAAe;MACb,MAAM;MACN,OAAO;OACL,MAAM;OACN,YAAY;QACV,OAAO,EAAE,MAAM,SAAS;QACxB,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,SAAS,GAAG,EAAE,MAAM,SAAS,CAAC,EAAE;OAC3D;OACA,UAAU,CAAC,SAAS,OAAO;MAC7B;KACF,EACF;KACA,UAAU,CAAC,eAAe;IAC5B,CAAC;IACD,GAAG,eAAe,CAAC,KAAK,GAAG,CAAC;GAC9B;GACA,UAAU,mBAAmB;EAC/B,IACA,KAAA,CACR;CACF;AACF"}

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

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

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

@@ -0,0 +1,43 @@
+import { schemaName } from "../names.js";
+import { jsonBody, jsonResponse } from "../components.js";
+import { securedRequirement } from "../security.js";
+import { collectionGroups, messageErrors, messageSchema } from "./shared.js";
+const TAG = "Search";
+const search = {
+	slug: "@payloadcms/plugin-search",
+	tag: TAG,
+	build: ({ collections, ctx, options, t }) => {
+		const searchSlug = (options?.searchOverrides)?.slug || "search";
+		const visible = new Set(collections.map((c) => c.slug));
+		const indexed = Array.isArray(options?.collections) ? options.collections.filter((slug) => visible.has(slug)) : [];
+		return collectionGroups(collections.filter((c) => c.slug === searchSlug), ctx, ({ method, path }, collection) => method === "post" && path === "/reindex" ? {
+			tags: [TAG],
+			operationId: `reindex${schemaName(collection.slug)}`,
+			summary: t("searchReindex"),
+			requestBody: jsonBody({
+				type: "object",
+				properties: { collections: {
+					type: "array",
+					minItems: 1,
+					items: {
+						type: "string",
+						...indexed.length > 0 ? { enum: indexed } : {}
+					}
+				} },
+				required: ["collections"]
+			}),
+			responses: {
+				"200": jsonResponse(t("searchReindexResult"), messageSchema),
+				...messageErrors([
+					"400",
+					"401",
+					"500"
+				], t)
+			},
+			security: securedRequirement()
+		} : void 0);
+	}
+};
+export { search };
+
+//# sourceMappingURL=search.js.map

package/dist/server/spec/plugins/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","names":[],"sources":["../../../../src/server/spec/plugins/search.ts"],"sourcesContent":["import { jsonBody, jsonResponse } from '@/server/spec/components.js'\nimport { schemaName } from '@/server/spec/names.js'\nimport { securedRequirement } from '@/server/spec/security.js'\n\nimport { type OfficialPlugin, collectionGroups, messageErrors, messageSchema } from './shared.js'\n\nconst TAG = 'Search'\n\nexport const search: OfficialPlugin = {\n  slug: '@payloadcms/plugin-search',\n  tag: TAG,\n  build: ({ collections, ctx, options, t }) => {\n    const overrides = options?.searchOverrides as { slug?: string } | undefined\n    const searchSlug = overrides?.slug || 'search'\n    const visible = new Set(collections.map((c) => c.slug))\n    const indexed = Array.isArray(options?.collections)\n      ? (options.collections as string[]).filter((slug) => visible.has(slug))\n      : []\n    return collectionGroups(\n      collections.filter((c) => c.slug === searchSlug),\n      ctx,\n      ({ method, path }, collection) =>\n        method === 'post' && path === '/reindex'\n          ? {\n              tags: [TAG],\n              operationId: `reindex${schemaName(collection.slug)}`,\n              summary: t('searchReindex'),\n              requestBody: jsonBody({\n                type: 'object',\n                properties: {\n                  collections: {\n                    type: 'array',\n                    minItems: 1,\n                    items: { type: 'string', ...(indexed.length > 0 ? { enum: indexed } : {}) },\n                  },\n                },\n                required: ['collections'],\n              }),\n              responses: {\n                '200': jsonResponse(t('searchReindexResult'), messageSchema),\n                ...messageErrors(['400', '401', '500'], t),\n              },\n              security: securedRequirement(),\n            }\n          : undefined,\n    )\n  },\n}\n"],"mappings":";;;;AAMA,MAAM,MAAM;AAEZ,MAAa,SAAyB;CACpC,MAAM;CACN,KAAK;CACL,QAAQ,EAAE,aAAa,KAAK,SAAS,QAAQ;EAE3C,MAAM,cADY,SAAS,gBAAA,EACG,QAAQ;EACtC,MAAM,UAAU,IAAI,IAAI,YAAY,KAAK,MAAM,EAAE,IAAI,CAAC;EACtD,MAAM,UAAU,MAAM,QAAQ,SAAS,WAAW,IAC7C,QAAQ,YAAyB,QAAQ,SAAS,QAAQ,IAAI,IAAI,CAAC,IACpE,CAAC;EACL,OAAO,iBACL,YAAY,QAAQ,MAAM,EAAE,SAAS,UAAU,GAC/C,MACC,EAAE,QAAQ,QAAQ,eACjB,WAAW,UAAU,SAAS,aAC1B;GACE,MAAM,CAAC,GAAG;GACV,aAAa,UAAU,WAAW,WAAW,IAAI;GACjD,SAAS,EAAE,eAAe;GAC1B,aAAa,SAAS;IACpB,MAAM;IACN,YAAY,EACV,aAAa;KACX,MAAM;KACN,UAAU;KACV,OAAO;MAAE,MAAM;MAAU,GAAI,QAAQ,SAAS,IAAI,EAAE,MAAM,QAAQ,IAAI,CAAC;KAAG;IAC5E,EACF;IACA,UAAU,CAAC,aAAa;GAC1B,CAAC;GACD,WAAW;IACT,OAAO,aAAa,EAAE,qBAAqB,GAAG,aAAa;IAC3D,GAAG,cAAc;KAAC;KAAO;KAAO;IAAK,GAAG,CAAC;GAC3C;GACA,UAAU,mBAAmB;EAC/B,IACA,KAAA,CACR;CACF;AACF"}

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

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

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

@@ -0,0 +1,83 @@
+import { errorResponses, jsonBody, jsonResponse } from "../components.js";
+import { securedRequirement } from "../security.js";
+import { idSchema, mountEndpoints } from "./shared.js";
+const TAG = "SEO";
+const GENERATORS = {
+	"/plugin-seo/generate-title": {
+		operationId: "seoGenerateTitle",
+		summary: "seoTitle"
+	},
+	"/plugin-seo/generate-description": {
+		operationId: "seoGenerateDescription",
+		summary: "seoDescription"
+	},
+	"/plugin-seo/generate-url": {
+		operationId: "seoGenerateUrl",
+		summary: "seoUrl"
+	},
+	"/plugin-seo/generate-image": {
+		operationId: "seoGenerateImage",
+		summary: "seoImage",
+		image: true
+	}
+};
+const seo = {
+	slug: "@payloadcms/plugin-seo",
+	tag: TAG,
+	build: ({ config, ctx, t }) => {
+		const id = idSchema(ctx);
+		const operation = (path) => {
+			const generator = GENERATORS[path];
+			if (!generator) return void 0;
+			const result = generator.image ? { oneOf: [
+				{ type: "string" },
+				{ type: "number" },
+				{
+					type: "object",
+					additionalProperties: true
+				}
+			] } : { type: "string" };
+			return {
+				tags: [TAG],
+				operationId: generator.operationId,
+				summary: t(generator.summary),
+				requestBody: {
+					...jsonBody({
+						type: "object",
+						additionalProperties: true,
+						properties: {
+							id: { oneOf: [{ type: "string" }, { type: "number" }] },
+							collectionSlug: { type: "string" },
+							globalSlug: { type: "string" },
+							doc: {
+								type: "object",
+								additionalProperties: true,
+								properties: { id }
+							},
+							locale: { type: "string" },
+							title: { type: "string" }
+						}
+					}),
+					description: t("seoBody")
+				},
+				responses: {
+					"200": jsonResponse(t("seoResult"), {
+						type: "object",
+						properties: { result },
+						required: ["result"]
+					}),
+					...errorResponses([
+						"401",
+						"403",
+						"500"
+					], t)
+				},
+				security: securedRequirement()
+			};
+		};
+		return [{ paths: mountEndpoints(config.endpoints, ctx.apiRoute, (endpoint) => endpoint.method === "post" ? operation(endpoint.path) : void 0) }];
+	}
+};
+export { seo };
+
+//# sourceMappingURL=seo.js.map

package/dist/server/spec/plugins/seo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo.js","names":[],"sources":["../../../../src/server/spec/plugins/seo.ts"],"sourcesContent":["import type { OperationObject, SchemaObject } from '@scalar/openapi-types/3.2'\n\nimport { errorResponses, jsonBody, jsonResponse } from '@/server/spec/components.js'\nimport { securedRequirement } from '@/server/spec/security.js'\nimport type { MessageKey } from '@/shared/translations/types.js'\n\nimport { type OfficialPlugin, idSchema, mountEndpoints } from './shared.js'\n\nconst TAG = 'SEO'\n\nconst GENERATORS: Record<string, { operationId: string; summary: MessageKey; image?: boolean }> = {\n  '/plugin-seo/generate-title': { operationId: 'seoGenerateTitle', summary: 'seoTitle' },\n  '/plugin-seo/generate-description': { operationId: 'seoGenerateDescription', summary: 'seoDescription' },\n  '/plugin-seo/generate-url': { operationId: 'seoGenerateUrl', summary: 'seoUrl' },\n  '/plugin-seo/generate-image': { operationId: 'seoGenerateImage', summary: 'seoImage', image: true },\n}\n\nexport const seo: OfficialPlugin = {\n  slug: '@payloadcms/plugin-seo',\n  tag: TAG,\n  build: ({ config, ctx, t }) => {\n    const id = idSchema(ctx)\n    const operation = (path: string): OperationObject | undefined => {\n      const generator = GENERATORS[path]\n      if (!generator) return undefined\n      const result: SchemaObject = generator.image\n        ? { oneOf: [{ type: 'string' }, { type: 'number' }, { type: 'object', additionalProperties: true }] }\n        : { type: 'string' }\n      return {\n        tags: [TAG],\n        operationId: generator.operationId,\n        summary: t(generator.summary),\n        requestBody: {\n          ...jsonBody({\n            type: 'object',\n            additionalProperties: true,\n            properties: {\n              id: { oneOf: [{ type: 'string' }, { type: 'number' }] },\n              collectionSlug: { type: 'string' },\n              globalSlug: { type: 'string' },\n              doc: { type: 'object', additionalProperties: true, properties: { id } },\n              locale: { type: 'string' },\n              title: { type: 'string' },\n            },\n          }),\n          description: t('seoBody'),\n        },\n        responses: {\n          '200': jsonResponse(t('seoResult'), {\n            type: 'object',\n            properties: { result },\n            required: ['result'],\n          }),\n          ...errorResponses(['401', '403', '500'], t),\n        },\n        security: securedRequirement(),\n      }\n    }\n    return [\n      {\n        paths: mountEndpoints(config.endpoints, ctx.apiRoute, (endpoint) =>\n          endpoint.method === 'post' ? operation(endpoint.path) : undefined,\n        ),\n      },\n    ]\n  },\n}\n"],"mappings":";;;AAQA,MAAM,MAAM;AAEZ,MAAM,aAA4F;CAChG,8BAA8B;EAAE,aAAa;EAAoB,SAAS;CAAW;CACrF,oCAAoC;EAAE,aAAa;EAA0B,SAAS;CAAiB;CACvG,4BAA4B;EAAE,aAAa;EAAkB,SAAS;CAAS;CAC/E,8BAA8B;EAAE,aAAa;EAAoB,SAAS;EAAY,OAAO;CAAK;AACpG;AAEA,MAAa,MAAsB;CACjC,MAAM;CACN,KAAK;CACL,QAAQ,EAAE,QAAQ,KAAK,QAAQ;EAC7B,MAAM,KAAK,SAAS,GAAG;EACvB,MAAM,aAAa,SAA8C;GAC/D,MAAM,YAAY,WAAW;GAC7B,IAAI,CAAC,WAAW,OAAO,KAAA;GACvB,MAAM,SAAuB,UAAU,QACnC,EAAE,OAAO;IAAC,EAAE,MAAM,SAAS;IAAG,EAAE,MAAM,SAAS;IAAG;KAAE,MAAM;KAAU,sBAAsB;IAAK;GAAC,EAAE,IAClG,EAAE,MAAM,SAAS;GACrB,OAAO;IACL,MAAM,CAAC,GAAG;IACV,aAAa,UAAU;IACvB,SAAS,EAAE,UAAU,OAAO;IAC5B,aAAa;KACX,GAAG,SAAS;MACV,MAAM;MACN,sBAAsB;MACtB,YAAY;OACV,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,SAAS,GAAG,EAAE,MAAM,SAAS,CAAC,EAAE;OACtD,gBAAgB,EAAE,MAAM,SAAS;OACjC,YAAY,EAAE,MAAM,SAAS;OAC7B,KAAK;QAAE,MAAM;QAAU,sBAAsB;QAAM,YAAY,EAAE,GAAG;OAAE;OACtE,QAAQ,EAAE,MAAM,SAAS;OACzB,OAAO,EAAE,MAAM,SAAS;MAC1B;KACF,CAAC;KACD,aAAa,EAAE,SAAS;IAC1B;IACA,WAAW;KACT,OAAO,aAAa,EAAE,WAAW,GAAG;MAClC,MAAM;MACN,YAAY,EAAE,OAAO;MACrB,UAAU,CAAC,QAAQ;KACrB,CAAC;KACD,GAAG,eAAe;MAAC;MAAO;MAAO;KAAK,GAAG,CAAC;IAC5C;IACA,UAAU,mBAAmB;GAC/B;EACF;EACA,OAAO,CACL,EACE,OAAO,eAAe,OAAO,WAAW,IAAI,WAAW,aACrD,SAAS,WAAW,SAAS,UAAU,SAAS,IAAI,IAAI,KAAA,CAC1D,EACF,CACF;CACF;AACF"}

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

@@ -0,0 +1,35 @@
+import { BuildContext } from "../../../shared/types/index.js";
+import { Translate } from "../../../shared/translations/types.js";
+import { Endpoint, SanitizedCollectionConfig, SanitizedConfig } from "payload";
+import { OperationObject, PathsObject, ResponsesObject, SchemaObject } from "@scalar/openapi-types/3.2";
+export interface PluginBuildArgs {
+  config: SanitizedConfig;
+  collections: SanitizedCollectionConfig[];
+  ctx: BuildContext;
+  options: Record<string, unknown> | undefined;
+  schemas: Record<string, SchemaObject>;
+  t: Translate;
+}
+export interface PluginGroup {
+  paths: PathsObject;
+  slug?: string;
+}
+export interface OfficialPlugin {
+  slug: string;
+  tag: string;
+  installed?: (config: SanitizedConfig) => boolean;
+  build: (args: PluginBuildArgs) => PluginGroup[];
+}
+export declare const mountEndpoints: (endpoints: Endpoint[] | false | undefined, prefix: string, operation: (endpoint: Endpoint) => OperationObject | undefined) => PathsObject;
+export declare const collectionGroups: (collections: SanitizedCollectionConfig[], ctx: BuildContext, operation: (endpoint: Endpoint, collection: SanitizedCollectionConfig) => OperationObject | undefined) => PluginGroup[];
+export declare const idSchema: (ctx: BuildContext) => SchemaObject;
+export declare const messageSchema: SchemaObject;
+declare const MESSAGE_ERROR_KEYS: {
+  readonly '400': 'errorPlugin400';
+  readonly '401': 'errorPlugin401';
+  readonly '403': 'errorPlugin403';
+  readonly '404': 'errorPlugin404';
+  readonly '500': 'errorPlugin500';
+};
+export declare const messageErrors: (codes: Array<keyof typeof MESSAGE_ERROR_KEYS>, t: Translate, schema?: SchemaObject) => ResponsesObject;
+//# sourceMappingURL=shared.d.ts.map

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

@@ -0,0 +1,37 @@
+import { jsonResponse } from "../components.js";
+import { getOpenapiMeta, normalizePath } from "../paths/custom.js";
+const mountEndpoints = (endpoints, prefix, operation) => {
+	const out = {};
+	for (const endpoint of endpoints || []) {
+		if (getOpenapiMeta(endpoint)) continue;
+		const op = operation(endpoint);
+		if (!op) continue;
+		const path = normalizePath(prefix, endpoint.path);
+		out[path] = {
+			...out[path],
+			[endpoint.method]: op
+		};
+	}
+	return out;
+};
+const collectionGroups = (collections, ctx, operation) => collections.map((collection) => ({
+	slug: collection.slug,
+	paths: mountEndpoints(collection.endpoints, `${ctx.apiRoute}/${collection.slug}`, (endpoint) => operation(endpoint, collection))
+})).filter((group) => Object.keys(group.paths).length > 0);
+const idSchema = (ctx) => ({ type: ctx.defaultIDType === "number" ? "integer" : "string" });
+const messageSchema = {
+	type: "object",
+	properties: { message: { type: "string" } },
+	required: ["message"]
+};
+const MESSAGE_ERROR_KEYS = {
+	"400": "errorPlugin400",
+	"401": "errorPlugin401",
+	"403": "errorPlugin403",
+	"404": "errorPlugin404",
+	"500": "errorPlugin500"
+};
+const messageErrors = (codes, t, schema = messageSchema) => Object.fromEntries(codes.map((code) => [code, jsonResponse(t(MESSAGE_ERROR_KEYS[code]), schema)]));
+export { collectionGroups, idSchema, messageErrors, messageSchema, mountEndpoints };
+
+//# sourceMappingURL=shared.js.map

package/dist/server/spec/plugins/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","names":[],"sources":["../../../../src/server/spec/plugins/shared.ts"],"sourcesContent":["import type { OperationObject, PathsObject, ResponsesObject, SchemaObject } from '@scalar/openapi-types/3.2'\nimport type { Endpoint, SanitizedCollectionConfig, SanitizedConfig } from 'payload'\n\nimport { jsonResponse } from '@/server/spec/components.js'\nimport { getOpenapiMeta, normalizePath } from '@/server/spec/paths/custom.js'\nimport type { Translate } from '@/shared/translations/types.js'\nimport type { BuildContext } from '@/shared/types/index.js'\n\nexport interface PluginBuildArgs {\n  config: SanitizedConfig\n  collections: SanitizedCollectionConfig[]\n  ctx: BuildContext\n  options: Record<string, unknown> | undefined\n  schemas: Record<string, SchemaObject>\n  t: Translate\n}\n\nexport interface PluginGroup {\n  paths: PathsObject\n  slug?: string\n}\n\nexport interface OfficialPlugin {\n  slug: string\n  tag: string\n  installed?: (config: SanitizedConfig) => boolean\n  build: (args: PluginBuildArgs) => PluginGroup[]\n}\n\nexport const mountEndpoints = (\n  endpoints: Endpoint[] | false | undefined,\n  prefix: string,\n  operation: (endpoint: Endpoint) => OperationObject | undefined,\n): PathsObject => {\n  const out: PathsObject = {}\n  for (const endpoint of endpoints || []) {\n    if (getOpenapiMeta(endpoint)) continue\n    const op = operation(endpoint)\n    if (!op) continue\n    const path = normalizePath(prefix, endpoint.path)\n    out[path] = { ...out[path], [endpoint.method]: op }\n  }\n  return out\n}\n\nexport const collectionGroups = (\n  collections: SanitizedCollectionConfig[],\n  ctx: BuildContext,\n  operation: (endpoint: Endpoint, collection: SanitizedCollectionConfig) => OperationObject | undefined,\n): PluginGroup[] =>\n  collections\n    .map((collection) => ({\n      slug: collection.slug,\n      paths: mountEndpoints(collection.endpoints, `${ctx.apiRoute}/${collection.slug}`, (endpoint) =>\n        operation(endpoint, collection),\n      ),\n    }))\n    .filter((group) => Object.keys(group.paths).length > 0)\n\nexport const idSchema = (ctx: BuildContext): SchemaObject => ({\n  type: ctx.defaultIDType === 'number' ? 'integer' : 'string',\n})\n\nexport const messageSchema: SchemaObject = {\n  type: 'object',\n  properties: { message: { type: 'string' } },\n  required: ['message'],\n}\n\nconst MESSAGE_ERROR_KEYS = {\n  '400': 'errorPlugin400',\n  '401': 'errorPlugin401',\n  '403': 'errorPlugin403',\n  '404': 'errorPlugin404',\n  '500': 'errorPlugin500',\n} as const\n\nexport const messageErrors = (\n  codes: Array<keyof typeof MESSAGE_ERROR_KEYS>,\n  t: Translate,\n  schema: SchemaObject = messageSchema,\n): ResponsesObject => Object.fromEntries(codes.map((code) => [code, jsonResponse(t(MESSAGE_ERROR_KEYS[code]), schema)]))\n"],"mappings":";;AA6BA,MAAa,kBACX,WACA,QACA,cACgB;CAChB,MAAM,MAAmB,CAAC;CAC1B,KAAK,MAAM,YAAY,aAAa,CAAC,GAAG;EACtC,IAAI,eAAe,QAAQ,GAAG;EAC9B,MAAM,KAAK,UAAU,QAAQ;EAC7B,IAAI,CAAC,IAAI;EACT,MAAM,OAAO,cAAc,QAAQ,SAAS,IAAI;EAChD,IAAI,QAAQ;GAAE,GAAG,IAAI;IAAQ,SAAS,SAAS;EAAG;CACpD;CACA,OAAO;AACT;AAEA,MAAa,oBACX,aACA,KACA,cAEA,YACG,KAAK,gBAAgB;CACpB,MAAM,WAAW;CACjB,OAAO,eAAe,WAAW,WAAW,GAAG,IAAI,SAAS,GAAG,WAAW,SAAS,aACjF,UAAU,UAAU,UAAU,CAChC;AACF,EAAE,CAAC,CACF,QAAQ,UAAU,OAAO,KAAK,MAAM,KAAK,CAAC,CAAC,SAAS,CAAC;AAE1D,MAAa,YAAY,SAAqC,EAC5D,MAAM,IAAI,kBAAkB,WAAW,YAAY,SACrD;AAEA,MAAa,gBAA8B;CACzC,MAAM;CACN,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,EAAE;CAC1C,UAAU,CAAC,SAAS;AACtB;AAEA,MAAM,qBAAqB;CACzB,OAAO;CACP,OAAO;CACP,OAAO;CACP,OAAO;CACP,OAAO;AACT;AAEA,MAAa,iBACX,OACA,GACA,SAAuB,kBACH,OAAO,YAAY,MAAM,KAAK,SAAS,CAAC,MAAM,aAAa,EAAE,mBAAmB,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC"}

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

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

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

@@ -0,0 +1,91 @@
+import { errorResponses } from "../components.js";
+import { securedRequirement } from "../security.js";
+import { mountEndpoints } from "./shared.js";
+const TAG = "Storage R2";
+const UPLOAD_PATH = /^\/storage-r2-multi-part-upload(?:-(\d+))?$/;
+const query = (name, required, type = "string") => ({
+	name,
+	in: "query",
+	required,
+	schema: { type }
+});
+const storageR2 = {
+	slug: "@payloadcms/storage-r2",
+	tag: TAG,
+	installed: (config) => (config.storage ?? []).some((adapter) => adapter?.name === "r2"),
+	build: ({ config, ctx, t }) => {
+		const upload = (suffix) => ({
+			tags: [TAG],
+			operationId: `r2MultipartUpload${suffix}`,
+			summary: t("r2Upload"),
+			description: t("r2UploadDesc"),
+			parameters: [
+				query("collection", true),
+				query("fileName", true),
+				query("fileType", true),
+				query("docPrefix", false),
+				query("multipartId", false),
+				query("multipartKey", false),
+				query("multipartNumber", false, "integer"),
+				query("signedReceipt", false)
+			],
+			requestBody: { content: {
+				"application/octet-stream": { schema: {
+					type: "string",
+					format: "binary"
+				} },
+				"application/json": { schema: {
+					type: "array",
+					items: {
+						type: "object",
+						properties: {
+							partNumber: { type: "integer" },
+							etag: { type: "string" }
+						},
+						required: ["partNumber", "etag"]
+					}
+				} }
+			} },
+			responses: {
+				"200": {
+					description: t("r2UploadResult"),
+					content: {
+						"application/json": { schema: {
+							type: "object",
+							additionalProperties: true,
+							properties: {
+								filename: { type: "string" },
+								key: { type: "string" },
+								uploadId: { type: "string" },
+								uploadReference: {
+									type: "object",
+									additionalProperties: true
+								},
+								partNumber: { type: "integer" },
+								etag: { type: "string" }
+							}
+						} },
+						"text/plain": { schema: { type: "string" } }
+					}
+				},
+				...errorResponses([
+					"400",
+					"403",
+					"500"
+				], t),
+				"412": {
+					description: t("errorStorageR2412"),
+					content: { "text/plain": { schema: { type: "string" } } }
+				}
+			},
+			security: securedRequirement()
+		});
+		return [{ paths: mountEndpoints(config.endpoints, ctx.apiRoute, ({ method, path }) => {
+			const match = UPLOAD_PATH.exec(path);
+			return method === "post" && match ? upload(match[1] ?? "") : void 0;
+		}) }];
+	}
+};
+export { storageR2 };
+
+//# sourceMappingURL=storageR2.js.map

package/dist/server/spec/plugins/storageR2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storageR2.js","names":[],"sources":["../../../../src/server/spec/plugins/storageR2.ts"],"sourcesContent":["import type { OperationObject, ParameterObject } from '@scalar/openapi-types/3.2'\n\nimport { errorResponses } from '@/server/spec/components.js'\nimport { securedRequirement } from '@/server/spec/security.js'\n\nimport { type OfficialPlugin, mountEndpoints } from './shared.js'\n\nconst TAG = 'Storage R2'\n\nconst UPLOAD_PATH = /^\\/storage-r2-multi-part-upload(?:-(\\d+))?$/\n\nconst query = (name: string, required: boolean, type: 'string' | 'integer' = 'string'): ParameterObject => ({\n  name,\n  in: 'query',\n  required,\n  schema: { type },\n})\n\nexport const storageR2: OfficialPlugin = {\n  slug: '@payloadcms/storage-r2',\n  tag: TAG,\n  installed: (config) => (config.storage ?? []).some((adapter) => adapter?.name === 'r2'),\n  build: ({ config, ctx, t }) => {\n    const upload = (suffix: string): OperationObject => ({\n      tags: [TAG],\n      operationId: `r2MultipartUpload${suffix}`,\n      summary: t('r2Upload'),\n      description: t('r2UploadDesc'),\n      parameters: [\n        query('collection', true),\n        query('fileName', true),\n        query('fileType', true),\n        query('docPrefix', false),\n        query('multipartId', false),\n        query('multipartKey', false),\n        query('multipartNumber', false, 'integer'),\n        query('signedReceipt', false),\n      ],\n      requestBody: {\n        content: {\n          'application/octet-stream': { schema: { type: 'string', format: 'binary' } },\n          'application/json': {\n            schema: {\n              type: 'array',\n              items: {\n                type: 'object',\n                properties: { partNumber: { type: 'integer' }, etag: { type: 'string' } },\n                required: ['partNumber', 'etag'],\n              },\n            },\n          },\n        },\n      },\n      responses: {\n        '200': {\n          description: t('r2UploadResult'),\n          content: {\n            'application/json': {\n              schema: {\n                type: 'object',\n                additionalProperties: true,\n                properties: {\n                  filename: { type: 'string' },\n                  key: { type: 'string' },\n                  uploadId: { type: 'string' },\n                  uploadReference: { type: 'object', additionalProperties: true },\n                  partNumber: { type: 'integer' },\n                  etag: { type: 'string' },\n                },\n              },\n            },\n            'text/plain': { schema: { type: 'string' } },\n          },\n        },\n        ...errorResponses(['400', '403', '500'], t),\n        '412': { description: t('errorStorageR2412'), content: { 'text/plain': { schema: { type: 'string' } } } },\n      },\n      security: securedRequirement(),\n    })\n    return [\n      {\n        paths: mountEndpoints(config.endpoints, ctx.apiRoute, ({ method, path }) => {\n          const match = UPLOAD_PATH.exec(path)\n          return method === 'post' && match ? upload(match[1] ?? '') : undefined\n        }),\n      },\n    ]\n  },\n}\n"],"mappings":";;;AAOA,MAAM,MAAM;AAEZ,MAAM,cAAc;AAEpB,MAAM,SAAS,MAAc,UAAmB,OAA6B,cAA+B;CAC1G;CACA,IAAI;CACJ;CACA,QAAQ,EAAE,KAAK;AACjB;AAEA,MAAa,YAA4B;CACvC,MAAM;CACN,KAAK;CACL,YAAY,YAAY,OAAO,WAAW,CAAC,EAAA,CAAG,MAAM,YAAY,SAAS,SAAS,IAAI;CACtF,QAAQ,EAAE,QAAQ,KAAK,QAAQ;EAC7B,MAAM,UAAU,YAAqC;GACnD,MAAM,CAAC,GAAG;GACV,aAAa,oBAAoB;GACjC,SAAS,EAAE,UAAU;GACrB,aAAa,EAAE,cAAc;GAC7B,YAAY;IACV,MAAM,cAAc,IAAI;IACxB,MAAM,YAAY,IAAI;IACtB,MAAM,YAAY,IAAI;IACtB,MAAM,aAAa,KAAK;IACxB,MAAM,eAAe,KAAK;IAC1B,MAAM,gBAAgB,KAAK;IAC3B,MAAM,mBAAmB,OAAO,SAAS;IACzC,MAAM,iBAAiB,KAAK;GAC9B;GACA,aAAa,EACX,SAAS;IACP,4BAA4B,EAAE,QAAQ;KAAE,MAAM;KAAU,QAAQ;IAAS,EAAE;IAC3E,oBAAoB,EAClB,QAAQ;KACN,MAAM;KACN,OAAO;MACL,MAAM;MACN,YAAY;OAAE,YAAY,EAAE,MAAM,UAAU;OAAG,MAAM,EAAE,MAAM,SAAS;MAAE;MACxE,UAAU,CAAC,cAAc,MAAM;KACjC;IACF,EACF;GACF,EACF;GACA,WAAW;IACT,OAAO;KACL,aAAa,EAAE,gBAAgB;KAC/B,SAAS;MACP,oBAAoB,EAClB,QAAQ;OACN,MAAM;OACN,sBAAsB;OACtB,YAAY;QACV,UAAU,EAAE,MAAM,SAAS;QAC3B,KAAK,EAAE,MAAM,SAAS;QACtB,UAAU,EAAE,MAAM,SAAS;QAC3B,iBAAiB;SAAE,MAAM;SAAU,sBAAsB;QAAK;QAC9D,YAAY,EAAE,MAAM,UAAU;QAC9B,MAAM,EAAE,MAAM,SAAS;OACzB;MACF,EACF;MACA,cAAc,EAAE,QAAQ,EAAE,MAAM,SAAS,EAAE;KAC7C;IACF;IACA,GAAG,eAAe;KAAC;KAAO;KAAO;IAAK,GAAG,CAAC;IAC1C,OAAO;KAAE,aAAa,EAAE,mBAAmB;KAAG,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,SAAS,EAAE,EAAE;IAAE;GAC1G;GACA,UAAU,mBAAmB;EAC/B;EACA,OAAO,CACL,EACE,OAAO,eAAe,OAAO,WAAW,IAAI,WAAW,EAAE,QAAQ,WAAW;GAC1E,MAAM,QAAQ,YAAY,KAAK,IAAI;GACnC,OAAO,WAAW,UAAU,QAAQ,OAAO,MAAM,MAAM,EAAE,IAAI,KAAA;EAC/D,CAAC,EACH,CACF;CACF;AACF"}

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

@@ -0,0 +1,10 @@
+import { Translate } from "../../../shared/translations/types.js";
+import { OfficialPlugin } from "./shared.js";
+import { OperationObject } from "@scalar/openapi-types/3.2";
+export declare const stripeWebhookOperation: ({ tag, operationId, t }: {
+  tag: string;
+  operationId: string;
+  t: Translate;
+}) => OperationObject;
+export declare const stripe: OfficialPlugin;
+//# sourceMappingURL=stripe.d.ts.map

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

@@ -0,0 +1,102 @@
+import { jsonBody, jsonResponse } from "../components.js";
+import { securedRequirement } from "../security.js";
+import { messageErrors, mountEndpoints } from "./shared.js";
+const TAG = "Stripe";
+const stripeWebhookOperation = ({ tag, operationId, t }) => {
+	const received = {
+		type: "object",
+		properties: { received: { type: "boolean" } },
+		required: ["received"]
+	};
+	return {
+		tags: [tag],
+		operationId,
+		summary: t("stripeWebhook"),
+		parameters: [{
+			name: "stripe-signature",
+			in: "header",
+			schema: { type: "string" }
+		}],
+		requestBody: {
+			...jsonBody({
+				type: "object",
+				additionalProperties: true
+			}),
+			description: t("stripeWebhookBody")
+		},
+		responses: {
+			"200": jsonResponse(t("stripeWebhookResult"), received),
+			"400": jsonResponse(t("errorPluginStripeWebhook400"), received)
+		}
+	};
+};
+const stripe = {
+	slug: "@payloadcms/plugin-stripe",
+	tag: TAG,
+	build: ({ config, ctx, options, t }) => {
+		const rest = options?.rest;
+		const allowed = Array.isArray(rest?.allowedMethods) ? rest.allowedMethods : void 0;
+		const restOperation = {
+			tags: [TAG],
+			operationId: "stripeRest",
+			summary: t("stripeRest"),
+			requestBody: jsonBody({
+				type: "object",
+				properties: {
+					stripeMethod: {
+						type: "string",
+						...allowed ? { enum: [...new Set(allowed)] } : {}
+					},
+					stripeArgs: {
+						type: "array",
+						items: {}
+					}
+				},
+				required: ["stripeMethod", "stripeArgs"]
+			}),
+			responses: {
+				"200": jsonResponse(t("stripeRestResult"), {
+					type: "object",
+					properties: {
+						data: {},
+						status: {
+							type: "integer",
+							enum: [200]
+						}
+					},
+					required: ["data", "status"]
+				}),
+				...messageErrors([
+					"400",
+					"401",
+					"403"
+				], t),
+				"404": jsonResponse(t("errorPluginStripeRest404"), {
+					type: "object",
+					properties: {
+						message: { type: "string" },
+						status: {
+							type: "integer",
+							enum: [404]
+						}
+					},
+					required: ["message", "status"]
+				}),
+				...messageErrors(["500"], t)
+			},
+			security: securedRequirement()
+		};
+		return [{ paths: mountEndpoints(config.endpoints, ctx.apiRoute, ({ method, path }) => {
+			if (method !== "post") return void 0;
+			if (path === "/stripe/webhooks") return stripeWebhookOperation({
+				tag: TAG,
+				operationId: "stripeWebhooks",
+				t
+			});
+			return path === "/stripe/rest" ? restOperation : void 0;
+		}) }];
+	}
+};
+export { stripe, stripeWebhookOperation };
+
+//# sourceMappingURL=stripe.js.map

package/dist/server/spec/plugins/stripe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripe.js","names":[],"sources":["../../../../src/server/spec/plugins/stripe.ts"],"sourcesContent":["import type { OperationObject, SchemaObject } from '@scalar/openapi-types/3.2'\n\nimport { jsonBody, jsonResponse } from '@/server/spec/components.js'\nimport { securedRequirement } from '@/server/spec/security.js'\nimport type { Translate } from '@/shared/translations/types.js'\n\nimport { type OfficialPlugin, messageErrors, mountEndpoints } from './shared.js'\n\nconst TAG = 'Stripe'\n\nexport const stripeWebhookOperation = ({\n  tag,\n  operationId,\n  t,\n}: {\n  tag: string\n  operationId: string\n  t: Translate\n}): OperationObject => {\n  const received: SchemaObject = {\n    type: 'object',\n    properties: { received: { type: 'boolean' } },\n    required: ['received'],\n  }\n  return {\n    tags: [tag],\n    operationId,\n    summary: t('stripeWebhook'),\n    parameters: [{ name: 'stripe-signature', in: 'header', schema: { type: 'string' } }],\n    requestBody: {\n      ...jsonBody({ type: 'object', additionalProperties: true }),\n      description: t('stripeWebhookBody'),\n    },\n    responses: {\n      '200': jsonResponse(t('stripeWebhookResult'), received),\n      '400': jsonResponse(t('errorPluginStripeWebhook400'), received),\n    },\n  }\n}\n\nexport const stripe: OfficialPlugin = {\n  slug: '@payloadcms/plugin-stripe',\n  tag: TAG,\n  build: ({ config, ctx, options, t }) => {\n    const rest = options?.rest as { allowedMethods?: unknown } | undefined\n    const allowed = Array.isArray(rest?.allowedMethods) ? (rest.allowedMethods as string[]) : undefined\n    const restOperation: OperationObject = {\n      tags: [TAG],\n      operationId: 'stripeRest',\n      summary: t('stripeRest'),\n      requestBody: jsonBody({\n        type: 'object',\n        properties: {\n          stripeMethod: { type: 'string', ...(allowed ? { enum: [...new Set(allowed)] } : {}) },\n          stripeArgs: { type: 'array', items: {} },\n        },\n        required: ['stripeMethod', 'stripeArgs'],\n      }),\n      responses: {\n        '200': jsonResponse(t('stripeRestResult'), {\n          type: 'object',\n          properties: { data: {}, status: { type: 'integer', enum: [200] } },\n          required: ['data', 'status'],\n        }),\n        ...messageErrors(['400', '401', '403'], t),\n        '404': jsonResponse(t('errorPluginStripeRest404'), {\n          type: 'object',\n          properties: { message: { type: 'string' }, status: { type: 'integer', enum: [404] } },\n          required: ['message', 'status'],\n        }),\n        ...messageErrors(['500'], t),\n      },\n      security: securedRequirement(),\n    }\n    return [\n      {\n        paths: mountEndpoints(config.endpoints, ctx.apiRoute, ({ method, path }) => {\n          if (method !== 'post') return undefined\n          if (path === '/stripe/webhooks') return stripeWebhookOperation({ tag: TAG, operationId: 'stripeWebhooks', t })\n          return path === '/stripe/rest' ? restOperation : undefined\n        }),\n      },\n    ]\n  },\n}\n"],"mappings":";;;AAQA,MAAM,MAAM;AAEZ,MAAa,0BAA0B,EACrC,KACA,aACA,QAKqB;CACrB,MAAM,WAAyB;EAC7B,MAAM;EACN,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,EAAE;EAC5C,UAAU,CAAC,UAAU;CACvB;CACA,OAAO;EACL,MAAM,CAAC,GAAG;EACV;EACA,SAAS,EAAE,eAAe;EAC1B,YAAY,CAAC;GAAE,MAAM;GAAoB,IAAI;GAAU,QAAQ,EAAE,MAAM,SAAS;EAAE,CAAC;EACnF,aAAa;GACX,GAAG,SAAS;IAAE,MAAM;IAAU,sBAAsB;GAAK,CAAC;GAC1D,aAAa,EAAE,mBAAmB;EACpC;EACA,WAAW;GACT,OAAO,aAAa,EAAE,qBAAqB,GAAG,QAAQ;GACtD,OAAO,aAAa,EAAE,6BAA6B,GAAG,QAAQ;EAChE;CACF;AACF;AAEA,MAAa,SAAyB;CACpC,MAAM;CACN,KAAK;CACL,QAAQ,EAAE,QAAQ,KAAK,SAAS,QAAQ;EACtC,MAAM,OAAO,SAAS;EACtB,MAAM,UAAU,MAAM,QAAQ,MAAM,cAAc,IAAK,KAAK,iBAA8B,KAAA;EAC1F,MAAM,gBAAiC;GACrC,MAAM,CAAC,GAAG;GACV,aAAa;GACb,SAAS,EAAE,YAAY;GACvB,aAAa,SAAS;IACpB,MAAM;IACN,YAAY;KACV,cAAc;MAAE,MAAM;MAAU,GAAI,UAAU,EAAE,MAAM,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,EAAE,IAAI,CAAC;KAAG;KACpF,YAAY;MAAE,MAAM;MAAS,OAAO,CAAC;KAAE;IACzC;IACA,UAAU,CAAC,gBAAgB,YAAY;GACzC,CAAC;GACD,WAAW;IACT,OAAO,aAAa,EAAE,kBAAkB,GAAG;KACzC,MAAM;KACN,YAAY;MAAE,MAAM,CAAC;MAAG,QAAQ;OAAE,MAAM;OAAW,MAAM,CAAC,GAAG;MAAE;KAAE;KACjE,UAAU,CAAC,QAAQ,QAAQ;IAC7B,CAAC;IACD,GAAG,cAAc;KAAC;KAAO;KAAO;IAAK,GAAG,CAAC;IACzC,OAAO,aAAa,EAAE,0BAA0B,GAAG;KACjD,MAAM;KACN,YAAY;MAAE,SAAS,EAAE,MAAM,SAAS;MAAG,QAAQ;OAAE,MAAM;OAAW,MAAM,CAAC,GAAG;MAAE;KAAE;KACpF,UAAU,CAAC,WAAW,QAAQ;IAChC,CAAC;IACD,GAAG,cAAc,CAAC,KAAK,GAAG,CAAC;GAC7B;GACA,UAAU,mBAAmB;EAC/B;EACA,OAAO,CACL,EACE,OAAO,eAAe,OAAO,WAAW,IAAI,WAAW,EAAE,QAAQ,WAAW;GAC1E,IAAI,WAAW,QAAQ,OAAO,KAAA;GAC9B,IAAI,SAAS,oBAAoB,OAAO,uBAAuB;IAAE,KAAK;IAAK,aAAa;IAAkB;GAAE,CAAC;GAC7G,OAAO,SAAS,iBAAiB,gBAAgB,KAAA;EACnD,CAAC,EACH,CACF;CACF;AACF"}

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

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