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

package/README.md

@@ -1,10 +1,10 @@
 <div align="center">
 
 <picture>
-  <img src="docs/logo.svg" alt="OpenAPI Plugin for Payload CMS" height="80" />
+  <img src="docs/logo.svg" alt="OpenAPI Plugin for Payload" height="80" />
 </picture>
 
-<h1>OpenAPI Plugin for Payload CMS</h1>
+<h1>OpenAPI Plugin for Payload</h1>
 
 <p>Generate an OpenAPI 3.0/3.1/3.2 specification from your Payload config and serve it with Scalar or Swagger UI.</p>
 
@@ -14,13 +14,13 @@
 <a href="https://github.com/maximseshuk/payload-plugin-openapi/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/maximseshuk/payload-plugin-openapi/ci.yml?style=flat-square&logo=github" alt="CI" /></a>
 <a href="https://payload-plugin-openapi.seshuk.im/"><img src="https://img.shields.io/badge/docs-payload--plugin--openapi.seshuk.im-blue?style=flat-square&logo=readthedocs&logoColor=white" alt="Documentation" /></a>
 <a href="https://github.com/maximseshuk/payload-plugin-openapi/blob/main/LICENSE"><img src="https://img.shields.io/github/license/maximseshuk/payload-plugin-openapi?style=flat-square" alt="license" /></a>
-<a href="https://ko-fi.com/V7V61UCT39"><img src="https://img.shields.io/badge/Ko--fi-Buy_me_a_coffee-ff5f5f?style=flat-square&logo=ko-fi&logoColor=white" alt="Ko-fi" /></a>
+<a href="https://ko-fi.com/seshuk"><img src="https://img.shields.io/badge/Ko--fi-Buy_me_a_coffee-ff5f5f?style=flat-square&logo=ko-fi&logoColor=white" alt="Ko-fi" /></a>
 
 </div>
 
 ## Features
 
-- **Full spec from your config** — collections, globals, auth, versions, and jobs are documented with zero annotation.
+- **Full spec from your config** — collections, globals, auth, versions, uploads, and jobs are documented with zero annotation. See the [endpoint list](https://payload-plugin-openapi.seshuk.im/v1/reference/endpoints).
 - **Interactive docs included** — mount Scalar or Swagger UI, or both on different paths.
 - **Native metadata** — document custom endpoints and refine field schemas through Payload's own `custom.openapi` key. No wrapper, no separate registry.
 - **Precise filtering** — choose exactly which entities and operations end up in the spec.
@@ -31,16 +31,16 @@
 
 ## Quick start
 
-Requires **Payload CMS 3.53.0 or later** and **Node.js 20 or later**.
+Requires **Payload 4.0.0-canary.38**, **Next.js 16.4 or later** and **Node.js 24.15 or later**. On Payload 3, use `@seshuk/payload-plugin-openapi@0`.
 
 ### Install
 
 ```bash
-npm install @seshuk/payload-plugin-openapi
-yarn add @seshuk/payload-plugin-openapi
-pnpm add @seshuk/payload-plugin-openapi
+npm install @seshuk/payload-plugin-openapi@beta
 ```
 
+v1 is in beta under the `beta` npm tag, and Payload 4 is published under `canary`.
+
 ### Configure
 
 Add the plugin to your Payload config, plus a docs UI renderer:
@@ -52,7 +52,7 @@ import { openapi, scalar } from '@seshuk/payload-plugin-openapi'
 export default buildConfig({
   plugins: [
     openapi({
-      metadata: {
+      info: {
         title: 'My API',
         version: '1.0.0',
       },
@@ -67,38 +67,80 @@ Two endpoints are now live, both relative to your API route (`/api` by default):
 - `GET /api/openapi.json` — the generated OpenAPI document
 - `GET /api/docs` — the interactive API reference
 
-`metadata.title` and `metadata.version` are required; the plugin throws at boot without them. Prefer Swagger UI? Swap `scalar()` for `swaggerUi()`, or mount both on different paths.
+`info.title` and `info.version` are required; the plugin throws at boot without them. Prefer Swagger UI? Swap `scalar()` for `swaggerUi()`, or mount both on different paths.
 
 The document is built lazily from the fully sanitized config, so collections, fields, and endpoints added by other plugins are picked up regardless of plugin order.
 
-Add `filters` to control what is exposed, `interactiveAuth` for a login dialog in the docs UI, `extensions` for anything the generator doesn't produce on its own — see the [configuration reference](https://payload-plugin-openapi.seshuk.im/configuration/overview).
+Add `filters` to control what is exposed, `interactiveAuth` for a login dialog in the docs UI, `extensions` for anything the generator doesn't produce on its own — see the [configuration reference](https://payload-plugin-openapi.seshuk.im/v1/configuration/overview).
+
+## Upgrading from 0.x
+
+v1 renames a few options. The plugin throws at boot when it finds an old name.
+
+```ts
+// 0.x
+openapi({
+  metadata: { title, version },
+  specEndpoint: '/spec.json',
+  interactiveAuth: { endpoint: '/login' },
+  securityWhen: ({ slug }) => (slug === 'feed' ? true : undefined),
+  filters: { excludeWhen: ({ path }) => path.includes('/internal/') },
+})
+scalar({ specEndpoint: '/api/spec.json' })
+
+// v1
+openapi({
+  info: { title, version },
+  path: '/spec.json',
+  interactiveAuth: { path: '/login' },
+  security: ({ slug }) => (slug === 'feed' ? 'public' : undefined),
+  filters: { excludeOperations: [({ path }) => path.includes('/internal/')] },
+})
+scalar() // follows the openapi() path; use specURL for another URL
+
+// 0.x
+custom: { openapi: { security: { read: true, create: false } } }
+
+// v1
+custom: { openapi: { security: { read: 'public', create: 'secured' } } }
+```
+
+The spec no longer reads `servers` from the `Host` header. It uses `serverURL`, the new `servers` option, or hosts you list in `trustedHosts`. An extension `transform` that throws now fails the request. The spec and docs page are open by default. Add `access` to `openapi()` and `scalar()` to make them private. See [Upgrading from 0.x](https://payload-plugin-openapi.seshuk.im/v1/upgrade-guide).
 
 ## Documentation
 
 Full docs are at **<https://payload-plugin-openapi.seshuk.im/>**:
 
-- [Quick start](https://payload-plugin-openapi.seshuk.im/quick-start)
-- [Configuration reference](https://payload-plugin-openapi.seshuk.im/configuration/overview)
-- [Filters](https://payload-plugin-openapi.seshuk.im/configuration/filters)
-- [Security marking](https://payload-plugin-openapi.seshuk.im/configuration/security-marking)
-- [Docs UI — Scalar & Swagger](https://payload-plugin-openapi.seshuk.im/configuration/docs-ui)
-- [Documenting custom endpoints](https://payload-plugin-openapi.seshuk.im/guides/custom-endpoints)
-- [Field metadata](https://payload-plugin-openapi.seshuk.im/guides/field-metadata)
-- [CLI — `openapi:generate`](https://payload-plugin-openapi.seshuk.im/cli/generate)
-- [Examples](https://payload-plugin-openapi.seshuk.im/guides/examples)
+- [Quick start](https://payload-plugin-openapi.seshuk.im/v1/quick-start)
+- [Configuration reference](https://payload-plugin-openapi.seshuk.im/v1/configuration/overview)
+- [Filters](https://payload-plugin-openapi.seshuk.im/v1/configuration/filters)
+- [Security marking](https://payload-plugin-openapi.seshuk.im/v1/configuration/security-marking)
+- [Docs UI — Scalar & Swagger](https://payload-plugin-openapi.seshuk.im/v1/configuration/docs-ui)
+- [Documenting custom endpoints](https://payload-plugin-openapi.seshuk.im/v1/guides/custom-endpoints)
+- [Field metadata](https://payload-plugin-openapi.seshuk.im/v1/guides/field-metadata)
+- [CLI — `openapi:generate`](https://payload-plugin-openapi.seshuk.im/v1/cli/generate)
+- [Examples](https://payload-plugin-openapi.seshuk.im/v1/guides/examples)
 
 ## For plugin authors
 
-If you maintain a Payload plugin, attach a `custom.openapi` Operation Object to the endpoints you add and they show up in the generated spec — no dependency on this package, and nothing for your users to wire up. The same key works on fields. If this plugin isn't installed, the metadata is inert. See [For plugin authors](https://payload-plugin-openapi.seshuk.im/guides/plugin-authors).
+If you maintain a Payload plugin, attach a `custom.openapi` Operation Object to the endpoints you add and they show up in the generated spec — no dependency on this package, and nothing for your users to wire up. The same key works on fields. If this plugin isn't installed, the metadata is inert. See [For plugin authors](https://payload-plugin-openapi.seshuk.im/v1/guides/plugin-authors).
+
+## Telemetry
+
+The plugin sends an anonymous, opt-out usage report once per day: plugin, Payload, and Node versions plus which features are enabled. It never sends secrets, IPs, keys, URLs, paths, hostnames, collection names, or anything from your spec. A one-time notice prints on first run.
+
+Opt out with `telemetry: false`, `DO_NOT_TRACK=1`, or `OPENAPI_TELEMETRY_DISABLED=1` (also disabled automatically in CI and when `payload.config.telemetry` is `false`). See [Telemetry](https://payload-plugin-openapi.seshuk.im/v1/configuration/telemetry) for the full list of what is and isn't collected.
 
 ## Related plugins
 
-- **[@seshuk/payload-storage-bunny](https://github.com/maximseshuk/payload-storage-bunny)** — store files and stream video from Payload CMS on Bunny's global CDN.
-- **[@seshuk/payload-plugin-media-preview](https://github.com/maximseshuk/payload-plugin-media-preview)** — preview images, video, audio, and documents directly in the Payload admin panel.
+- **[@seshuk/payload-storage-bunny](https://github.com/maximseshuk/payload-storage-bunny)** — store files and stream video from Payload on Bunny.net's global CDN.
+- **[@seshuk/payload-plugin-media-preview](https://github.com/maximseshuk/payload-plugin-media-preview)** — preview images, video, audio and documents in the Payload admin panel.
+- **[@seshuk/payload-plugin-janitor](https://github.com/maximseshuk/payload-plugin-janitor)** — find orphaned files and unused documents, then delete only what you approve.
+- **[@seshuk/payload-plugin-sitemap](https://github.com/maximseshuk/payload-plugin-sitemap)** — sitemaps for Payload, stored with any storage adapter.
 
 ## Support
 
-Bug reports, feature requests, and questions go to [GitHub Issues](https://github.com/maximseshuk/payload-plugin-openapi/issues). For Payload itself, see the [Payload CMS docs](https://payloadcms.com/docs) and [Discord](https://discord.gg/payloadcms).
+Bug reports, feature requests, and questions go to [GitHub Issues](https://github.com/maximseshuk/payload-plugin-openapi/issues). For Payload itself, see the [Payload docs](https://payloadcms.com/docs) and [Discord](https://discord.gg/payloadcms).
 
 ## License
 
@@ -106,6 +148,6 @@ MIT — see [LICENSE](LICENSE).
 
 ## Credits
 
-Built by [Maxim Seshuk](https://github.com/maximseshuk) for the Payload CMS community.
+Built by [Maxim Seshuk](https://github.com/maximseshuk) for the Payload community.
 
 If this plugin saves you time, you can [buy me a coffee](https://ko-fi.com/seshuk) ☕

package/dist/_tooling/telemetry.js

@@ -0,0 +1,168 @@
+import { createRequire } from "node:module";
+import { fileURLToPath } from "node:url";
+import { execSync } from "node:child_process";
+import { createHash } from "node:crypto";
+import { readFileSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { dirname, join } from "node:path";
+const TELEMETRY_ENDPOINT = "https://telemetry.seshuk.im/v1/collect";
+const isTruthyEnv = (value) => value !== void 0 && value !== "" && value !== "0" && value.toLowerCase() !== "false";
+const isTelemetryDisabled = ({ disableEnv, env, option, payloadTelemetry }) => {
+	if (payloadTelemetry === false || option === false) return true;
+	if (isTruthyEnv(env[disableEnv]) || isTruthyEnv(env.DO_NOT_TRACK) || isTruthyEnv(env.CI)) return true;
+	return env.NODE_ENV === "test";
+};
+const hashProjectId = (secret, rawSource) => createHash("sha256").update(secret + rawSource).digest("hex");
+const resolveRawSource = (candidates) => {
+	if (candidates.git) return {
+		source: "git",
+		value: candidates.git
+	};
+	if (candidates.packageJSON) return {
+		source: "packageJSON",
+		value: candidates.packageJSON
+	};
+	if (candidates.serverURL) return {
+		source: "serverURL",
+		value: candidates.serverURL
+	};
+	return {
+		source: "cwd",
+		value: candidates.cwd
+	};
+};
+const readGitRemote = () => {
+	try {
+		return execSync("git config --local --get remote.origin.url", {
+			stdio: [
+				"ignore",
+				"pipe",
+				"ignore"
+			],
+			timeout: 1e3
+		}).toString().trim() || void 0;
+	} catch {
+		return;
+	}
+};
+const readJson = (file) => {
+	try {
+		return JSON.parse(readFileSync(file, "utf8"));
+	} catch {
+		return;
+	}
+};
+const readAppPackageName = (cwd) => {
+	const name = readJson(join(cwd, "package.json"))?.name;
+	return typeof name === "string" && name ? name : void 0;
+};
+const deriveProjectId = ({ cwd = process.cwd(), git, packageJSON, secret, serverURL }) => {
+	const raw = resolveRawSource({
+		cwd,
+		git: git ?? readGitRemote(),
+		packageJSON: packageJSON ?? readAppPackageName(cwd),
+		serverURL
+	});
+	return {
+		projectId: hashProjectId(secret, raw.value),
+		projectIdSource: raw.source
+	};
+};
+const utcDay = (now = /* @__PURE__ */ new Date()) => now.toISOString().slice(0, 10);
+const stateFile = (product, projectId) => join(tmpdir(), `${product}-telemetry-${projectId}.json`);
+const readState = (product, projectId) => {
+	try {
+		return JSON.parse(readFileSync(stateFile(product, projectId), "utf8"));
+	} catch {
+		return {};
+	}
+};
+const writeState = (product, projectId, state) => {
+	try {
+		writeFileSync(stateFile(product, projectId), JSON.stringify(state));
+	} catch {}
+};
+const findPackageVersion = (name, from) => {
+	let dir = from;
+	while (true) {
+		const pkg = readJson(join(dir, "package.json"));
+		if (pkg?.name === name && typeof pkg.version === "string" && pkg.version) return pkg.version;
+		const parent = dirname(dir);
+		if (parent === dir) return;
+		dir = parent;
+	}
+};
+const readPackageVersion = (packageName, from = dirname(fileURLToPath(import.meta.url))) => findPackageVersion(packageName, from) ?? "0.0.0";
+const readPayloadVersion = () => {
+	try {
+		return findPackageVersion("payload", dirname(createRequire(import.meta.url).resolve("payload"))) ?? "0.0.0";
+	} catch {
+		return "0.0.0";
+	}
+};
+const buildReport = ({ features, payloadVersion, product, productVersion, projectId, projectIdSource }) => ({
+	features,
+	os: process.platform.toLowerCase().slice(0, 16),
+	payloadVersion,
+	product,
+	productVersion,
+	projectId,
+	projectIdSource,
+	runtime: "node",
+	runtimeVersion: process.versions.node.split(".")[0],
+	schema: 1
+});
+const postReport = async (report, endpoint) => {
+	try {
+		await fetch(endpoint, {
+			body: JSON.stringify(report),
+			headers: { "content-type": "application/json" },
+			method: "POST",
+			signal: AbortSignal.timeout(2e3)
+		});
+	} catch {}
+};
+const reportTelemetry = async ({ disableEnv, docsUrl, features, option, packageName, payload, product }, deps = {}) => {
+	const env = deps.env ?? process.env;
+	const readStateImpl = deps.readState ?? ((projectId) => readState(product, projectId));
+	const writeStateImpl = deps.writeState ?? ((projectId, state) => writeState(product, projectId, state));
+	const send = deps.send ?? postReport;
+	try {
+		if (isTelemetryDisabled({
+			disableEnv,
+			env,
+			option,
+			payloadTelemetry: payload.config.telemetry
+		})) return;
+		const { projectId, projectIdSource } = deriveProjectId({
+			secret: payload.secret,
+			serverURL: payload.config.serverURL
+		});
+		const state = readStateImpl(projectId);
+		const today = utcDay(deps.now);
+		if (!state.noticeShown) payload.logger.info(`[${product}] Anonymous usage telemetry is on: plugin, Payload and Node versions and the features you use. It never sends secrets, IPs, keys or names. Opt out with telemetry: false, DO_NOT_TRACK=1 or ${disableEnv}=1. What is sent: ${docsUrl}`);
+		if (state.lastSentDay === today) {
+			if (!state.noticeShown) writeStateImpl(projectId, {
+				...state,
+				noticeShown: true
+			});
+			return;
+		}
+		const report = buildReport({
+			features,
+			payloadVersion: readPayloadVersion(),
+			product,
+			productVersion: readPackageVersion(packageName),
+			projectId,
+			projectIdSource
+		});
+		writeStateImpl(projectId, {
+			lastSentDay: today,
+			noticeShown: true
+		});
+		await send(report, typeof option === "object" && option.url ? option.url : TELEMETRY_ENDPOINT);
+	} catch {}
+};
+export { buildReport, deriveProjectId, hashProjectId, isTelemetryDisabled, postReport, readPackageVersion, readPayloadVersion, readState, reportTelemetry, resolveRawSource, utcDay, writeState };
+
+//# sourceMappingURL=telemetry.js.map

package/dist/_tooling/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","names":[],"sources":["node_modules/@seshuk/payload-plugin-tooling/dist/telemetry.js"],"sourcesContent":["import { createRequire } from \"node:module\";\nimport { execSync } from \"node:child_process\";\nimport { createHash } from \"node:crypto\";\nimport { readFileSync, writeFileSync } from \"node:fs\";\nimport { tmpdir } from \"node:os\";\nimport { dirname, join } from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n//#region src/telemetry.ts\nconst TELEMETRY_ENDPOINT = \"https://telemetry.seshuk.im/v1/collect\";\nconst isTruthyEnv = (value) => value !== void 0 && value !== \"\" && value !== \"0\" && value.toLowerCase() !== \"false\";\nconst isTelemetryDisabled = ({ disableEnv, env, option, payloadTelemetry }) => {\n\tif (payloadTelemetry === false || option === false) return true;\n\tif (isTruthyEnv(env[disableEnv]) || isTruthyEnv(env.DO_NOT_TRACK) || isTruthyEnv(env.CI)) return true;\n\treturn env.NODE_ENV === \"test\";\n};\nconst hashProjectId = (secret, rawSource) => createHash(\"sha256\").update(secret + rawSource).digest(\"hex\");\nconst resolveRawSource = (candidates) => {\n\tif (candidates.git) return {\n\t\tsource: \"git\",\n\t\tvalue: candidates.git\n\t};\n\tif (candidates.packageJSON) return {\n\t\tsource: \"packageJSON\",\n\t\tvalue: candidates.packageJSON\n\t};\n\tif (candidates.serverURL) return {\n\t\tsource: \"serverURL\",\n\t\tvalue: candidates.serverURL\n\t};\n\treturn {\n\t\tsource: \"cwd\",\n\t\tvalue: candidates.cwd\n\t};\n};\nconst readGitRemote = () => {\n\ttry {\n\t\treturn execSync(\"git config --local --get remote.origin.url\", {\n\t\t\tstdio: [\n\t\t\t\t\"ignore\",\n\t\t\t\t\"pipe\",\n\t\t\t\t\"ignore\"\n\t\t\t],\n\t\t\ttimeout: 1e3\n\t\t}).toString().trim() || void 0;\n\t} catch {\n\t\treturn;\n\t}\n};\nconst readJson = (file) => {\n\ttry {\n\t\treturn JSON.parse(readFileSync(file, \"utf8\"));\n\t} catch {\n\t\treturn;\n\t}\n};\nconst readAppPackageName = (cwd) => {\n\tconst name = readJson(join(cwd, \"package.json\"))?.name;\n\treturn typeof name === \"string\" && name ? name : void 0;\n};\nconst deriveProjectId = ({ cwd = process.cwd(), git, packageJSON, secret, serverURL }) => {\n\tconst raw = resolveRawSource({\n\t\tcwd,\n\t\tgit: git ?? readGitRemote(),\n\t\tpackageJSON: packageJSON ?? readAppPackageName(cwd),\n\t\tserverURL\n\t});\n\treturn {\n\t\tprojectId: hashProjectId(secret, raw.value),\n\t\tprojectIdSource: raw.source\n\t};\n};\nconst utcDay = (now = /* @__PURE__ */ new Date()) => now.toISOString().slice(0, 10);\nconst stateFile = (product, projectId) => join(tmpdir(), `${product}-telemetry-${projectId}.json`);\nconst readState = (product, projectId) => {\n\ttry {\n\t\treturn JSON.parse(readFileSync(stateFile(product, projectId), \"utf8\"));\n\t} catch {\n\t\treturn {};\n\t}\n};\nconst writeState = (product, projectId, state) => {\n\ttry {\n\t\twriteFileSync(stateFile(product, projectId), JSON.stringify(state));\n\t} catch {}\n};\nconst findPackageVersion = (name, from) => {\n\tlet dir = from;\n\twhile (true) {\n\t\tconst pkg = readJson(join(dir, \"package.json\"));\n\t\tif (pkg?.name === name && typeof pkg.version === \"string\" && pkg.version) return pkg.version;\n\t\tconst parent = dirname(dir);\n\t\tif (parent === dir) return;\n\t\tdir = parent;\n\t}\n};\nconst readPackageVersion = (packageName, from = dirname(fileURLToPath(import.meta.url))) => findPackageVersion(packageName, from) ?? \"0.0.0\";\nconst readPayloadVersion = () => {\n\ttry {\n\t\treturn findPackageVersion(\"payload\", dirname(createRequire(import.meta.url).resolve(\"payload\"))) ?? \"0.0.0\";\n\t} catch {\n\t\treturn \"0.0.0\";\n\t}\n};\nconst buildReport = ({ features, payloadVersion, product, productVersion, projectId, projectIdSource }) => ({\n\tfeatures,\n\tos: process.platform.toLowerCase().slice(0, 16),\n\tpayloadVersion,\n\tproduct,\n\tproductVersion,\n\tprojectId,\n\tprojectIdSource,\n\truntime: \"node\",\n\truntimeVersion: process.versions.node.split(\".\")[0],\n\tschema: 1\n});\nconst postReport = async (report, endpoint) => {\n\ttry {\n\t\tawait fetch(endpoint, {\n\t\t\tbody: JSON.stringify(report),\n\t\t\theaders: { \"content-type\": \"application/json\" },\n\t\t\tmethod: \"POST\",\n\t\t\tsignal: AbortSignal.timeout(2e3)\n\t\t});\n\t} catch {}\n};\nconst reportTelemetry = async ({ disableEnv, docsUrl, features, option, packageName, payload, product }, deps = {}) => {\n\tconst env = deps.env ?? process.env;\n\tconst readStateImpl = deps.readState ?? ((projectId) => readState(product, projectId));\n\tconst writeStateImpl = deps.writeState ?? ((projectId, state) => writeState(product, projectId, state));\n\tconst send = deps.send ?? postReport;\n\ttry {\n\t\tif (isTelemetryDisabled({\n\t\t\tdisableEnv,\n\t\t\tenv,\n\t\t\toption,\n\t\t\tpayloadTelemetry: payload.config.telemetry\n\t\t})) return;\n\t\tconst { projectId, projectIdSource } = deriveProjectId({\n\t\t\tsecret: payload.secret,\n\t\t\tserverURL: payload.config.serverURL\n\t\t});\n\t\tconst state = readStateImpl(projectId);\n\t\tconst today = utcDay(deps.now);\n\t\tif (!state.noticeShown) payload.logger.info(`[${product}] Anonymous usage telemetry is on: plugin, Payload and Node versions and the features you use. It never sends secrets, IPs, keys or names. Opt out with telemetry: false, DO_NOT_TRACK=1 or ${disableEnv}=1. What is sent: ${docsUrl}`);\n\t\tif (state.lastSentDay === today) {\n\t\t\tif (!state.noticeShown) writeStateImpl(projectId, {\n\t\t\t\t...state,\n\t\t\t\tnoticeShown: true\n\t\t\t});\n\t\t\treturn;\n\t\t}\n\t\tconst report = buildReport({\n\t\t\tfeatures,\n\t\t\tpayloadVersion: readPayloadVersion(),\n\t\t\tproduct,\n\t\t\tproductVersion: readPackageVersion(packageName),\n\t\t\tprojectId,\n\t\t\tprojectIdSource\n\t\t});\n\t\twriteStateImpl(projectId, {\n\t\t\tlastSentDay: today,\n\t\t\tnoticeShown: true\n\t\t});\n\t\tawait send(report, typeof option === \"object\" && option.url ? option.url : TELEMETRY_ENDPOINT);\n\t} catch {}\n};\n//#endregion\nexport { buildReport, deriveProjectId, hashProjectId, isTelemetryDisabled, postReport, readPackageVersion, readPayloadVersion, readState, reportTelemetry, resolveRawSource, utcDay, writeState };\n"],"ignoreList":[0],"mappings":";;;;;;;AAQA,MAAM,qBAAqB;AAC3B,MAAM,eAAe,UAAU,UAAU,KAAK,KAAK,UAAU,MAAM,UAAU,OAAO,MAAM,YAAY,MAAM;AAC5G,MAAM,uBAAuB,EAAE,YAAY,KAAK,QAAQ,uBAAuB;CAC9E,IAAI,qBAAqB,SAAS,WAAW,OAAO,OAAO;CAC3D,IAAI,YAAY,IAAI,WAAW,KAAK,YAAY,IAAI,YAAY,KAAK,YAAY,IAAI,EAAE,GAAG,OAAO;CACjG,OAAO,IAAI,aAAa;AACzB;AACA,MAAM,iBAAiB,QAAQ,cAAc,WAAW,QAAQ,CAAC,CAAC,OAAO,SAAS,SAAS,CAAC,CAAC,OAAO,KAAK;AACzG,MAAM,oBAAoB,eAAe;CACxC,IAAI,WAAW,KAAK,OAAO;EAC1B,QAAQ;EACR,OAAO,WAAW;CACnB;CACA,IAAI,WAAW,aAAa,OAAO;EAClC,QAAQ;EACR,OAAO,WAAW;CACnB;CACA,IAAI,WAAW,WAAW,OAAO;EAChC,QAAQ;EACR,OAAO,WAAW;CACnB;CACA,OAAO;EACN,QAAQ;EACR,OAAO,WAAW;CACnB;AACD;AACA,MAAM,sBAAsB;CAC3B,IAAI;EACH,OAAO,SAAS,8CAA8C;GAC7D,OAAO;IACN;IACA;IACA;GACD;GACA,SAAS;EACV,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,KAAK,KAAK;CAC9B,QAAQ;EACP;CACD;AACD;AACA,MAAM,YAAY,SAAS;CAC1B,IAAI;EACH,OAAO,KAAK,MAAM,aAAa,MAAM,MAAM,CAAC;CAC7C,QAAQ;EACP;CACD;AACD;AACA,MAAM,sBAAsB,QAAQ;CACnC,MAAM,OAAO,SAAS,KAAK,KAAK,cAAc,CAAC,CAAC,EAAE;CAClD,OAAO,OAAO,SAAS,YAAY,OAAO,OAAO,KAAK;AACvD;AACA,MAAM,mBAAmB,EAAE,MAAM,QAAQ,IAAI,GAAG,KAAK,aAAa,QAAQ,gBAAgB;CACzF,MAAM,MAAM,iBAAiB;EAC5B;EACA,KAAK,OAAO,cAAc;EAC1B,aAAa,eAAe,mBAAmB,GAAG;EAClD;CACD,CAAC;CACD,OAAO;EACN,WAAW,cAAc,QAAQ,IAAI,KAAK;EAC1C,iBAAiB,IAAI;CACtB;AACD;AACA,MAAM,UAAU,sBAAsB,IAAI,KAAK,MAAM,IAAI,YAAY,CAAC,CAAC,MAAM,GAAG,EAAE;AAClF,MAAM,aAAa,SAAS,cAAc,KAAK,OAAO,GAAG,GAAG,QAAQ,aAAa,UAAU,MAAM;AACjG,MAAM,aAAa,SAAS,cAAc;CACzC,IAAI;EACH,OAAO,KAAK,MAAM,aAAa,UAAU,SAAS,SAAS,GAAG,MAAM,CAAC;CACtE,QAAQ;EACP,OAAO,CAAC;CACT;AACD;AACA,MAAM,cAAc,SAAS,WAAW,UAAU;CACjD,IAAI;EACH,cAAc,UAAU,SAAS,SAAS,GAAG,KAAK,UAAU,KAAK,CAAC;CACnE,QAAQ,CAAC;AACV;AACA,MAAM,sBAAsB,MAAM,SAAS;CAC1C,IAAI,MAAM;CACV,OAAO,MAAM;EACZ,MAAM,MAAM,SAAS,KAAK,KAAK,cAAc,CAAC;EAC9C,IAAI,KAAK,SAAS,QAAQ,OAAO,IAAI,YAAY,YAAY,IAAI,SAAS,OAAO,IAAI;EACrF,MAAM,SAAS,QAAQ,GAAG;EAC1B,IAAI,WAAW,KAAK;EACpB,MAAM;CACP;AACD;AACA,MAAM,sBAAsB,aAAa,OAAO,QAAQ,cAAc,YAAY,GAAG,CAAC,MAAM,mBAAmB,aAAa,IAAI,KAAK;AACrI,MAAM,2BAA2B;CAChC,IAAI;EACH,OAAO,mBAAmB,WAAW,QAAQ,cAAc,YAAY,GAAG,CAAC,CAAC,QAAQ,SAAS,CAAC,CAAC,KAAK;CACrG,QAAQ;EACP,OAAO;CACR;AACD;AACA,MAAM,eAAe,EAAE,UAAU,gBAAgB,SAAS,gBAAgB,WAAW,uBAAuB;CAC3G;CACA,IAAI,QAAQ,SAAS,YAAY,CAAC,CAAC,MAAM,GAAG,EAAE;CAC9C;CACA;CACA;CACA;CACA;CACA,SAAS;CACT,gBAAgB,QAAQ,SAAS,KAAK,MAAM,GAAG,CAAC,CAAC;CACjD,QAAQ;AACT;AACA,MAAM,aAAa,OAAO,QAAQ,aAAa;CAC9C,IAAI;EACH,MAAM,MAAM,UAAU;GACrB,MAAM,KAAK,UAAU,MAAM;GAC3B,SAAS,EAAE,gBAAgB,mBAAmB;GAC9C,QAAQ;GACR,QAAQ,YAAY,QAAQ,GAAG;EAChC,CAAC;CACF,QAAQ,CAAC;AACV;AACA,MAAM,kBAAkB,OAAO,EAAE,YAAY,SAAS,UAAU,QAAQ,aAAa,SAAS,WAAW,OAAO,CAAC,MAAM;CACtH,MAAM,MAAM,KAAK,OAAO,QAAQ;CAChC,MAAM,gBAAgB,KAAK,eAAe,cAAc,UAAU,SAAS,SAAS;CACpF,MAAM,iBAAiB,KAAK,gBAAgB,WAAW,UAAU,WAAW,SAAS,WAAW,KAAK;CACrG,MAAM,OAAO,KAAK,QAAQ;CAC1B,IAAI;EACH,IAAI,oBAAoB;GACvB;GACA;GACA;GACA,kBAAkB,QAAQ,OAAO;EAClC,CAAC,GAAG;EACJ,MAAM,EAAE,WAAW,oBAAoB,gBAAgB;GACtD,QAAQ,QAAQ;GAChB,WAAW,QAAQ,OAAO;EAC3B,CAAC;EACD,MAAM,QAAQ,cAAc,SAAS;EACrC,MAAM,QAAQ,OAAO,KAAK,GAAG;EAC7B,IAAI,CAAC,MAAM,aAAa,QAAQ,OAAO,KAAK,IAAI,QAAQ,8LAA8L,WAAW,oBAAoB,SAAS;EAC9R,IAAI,MAAM,gBAAgB,OAAO;GAChC,IAAI,CAAC,MAAM,aAAa,eAAe,WAAW;IACjD,GAAG;IACH,aAAa;GACd,CAAC;GACD;EACD;EACA,MAAM,SAAS,YAAY;GAC1B;GACA,gBAAgB,mBAAmB;GACnC;GACA,gBAAgB,mBAAmB,WAAW;GAC9C;GACA;EACD,CAAC;EACD,eAAe,WAAW;GACzB,aAAa;GACb,aAAa;EACd,CAAC;EACD,MAAM,KAAK,QAAQ,OAAO,WAAW,YAAY,OAAO,MAAM,OAAO,MAAM,kBAAkB;CAC9F,QAAQ,CAAC;AACV"}

package/dist/cli/generateSpec.d.ts

@@ -0,0 +1,2 @@
+export declare const generateSpecCommand: import("payload").CLICommand;
+//# sourceMappingURL=generateSpec.d.ts.map

package/dist/cli/generateSpec.js

@@ -0,0 +1,40 @@
+import { PLUGIN_NAME } from "../shared/constants.js";
+import { buildOpenApiDocument } from "../server/spec/build.js";
+import { strictObject, z } from "payload";
+import path from "node:path";
+import { writeFile } from "node:fs/promises";
+import { defineCLICommand } from "payload/cli";
+const optionalString = (description) => z.optional(z.string()).check(z.describe(description));
+const generateSpecCommand = defineCLICommand({
+	description: "Write the OpenAPI document to a file.",
+	input: strictObject({
+		lang: optionalString("Locale for translated descriptions; `all` writes one file per supported language. Defaults to the i18n fallback."),
+		out: optionalString("Output file for a single-language run (default openapi.json)."),
+		server: optionalString("Base URL written to the document `servers`. Defaults to the `servers` option, then `serverURL`.")
+	}),
+	handler: async ({ args, getConfig, getPayload }) => {
+		const config = await getConfig();
+		const resolved = config.custom?.[PLUGIN_NAME];
+		if (!resolved) throw new Error(`${PLUGIN_NAME}: plugin is not registered in payload.config — no resolved options found on config.custom['${PLUGIN_NAME}'].`);
+		const payload = await getPayload();
+		const { lang, out, server } = args;
+		const servers = server ? [{ url: server }] : void 0;
+		const fallback = config.i18n?.fallbackLanguage ?? "en";
+		const supported = config.i18n?.supportedLanguages ? Object.keys(config.i18n.supportedLanguages) : [fallback];
+		const langs = lang === "all" ? supported : [lang ?? fallback];
+		for (const language of langs) {
+			const doc = await buildOpenApiDocument({
+				payload,
+				options: resolved,
+				language,
+				servers
+			});
+			const file = langs.length > 1 ? `openapi.${language}.json` : out ?? "openapi.json";
+			await writeFile(path.resolve(file), `${JSON.stringify(doc, null, 2)}\n`);
+			payload.logger.info(`Wrote ${file}`);
+		}
+	}
+});
+export { generateSpecCommand };
+
+//# sourceMappingURL=generateSpec.js.map

package/dist/cli/generateSpec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateSpec.js","names":[],"sources":["../../src/cli/generateSpec.ts"],"sourcesContent":["import { writeFile } from 'node:fs/promises'\nimport path from 'node:path'\n\nimport { strictObject, z } from 'payload'\nimport { defineCLICommand } from 'payload/cli'\n\nimport { buildOpenApiDocument } from '@/server/spec/build.js'\nimport { PLUGIN_NAME } from '@/shared/constants.js'\nimport type { ResolvedOptions } from '@/shared/types/index.js'\n\nconst optionalString = (description: string) => z.optional(z.string()).check(z.describe(description))\n\nexport const generateSpecCommand = defineCLICommand({\n  description: 'Write the OpenAPI document to a file.',\n  input: strictObject({\n    lang: optionalString(\n      'Locale for translated descriptions; `all` writes one file per supported language. Defaults to the i18n fallback.',\n    ),\n    out: optionalString('Output file for a single-language run (default openapi.json).'),\n    server: optionalString(\n      'Base URL written to the document `servers`. Defaults to the `servers` option, then `serverURL`.',\n    ),\n  }),\n  handler: async ({ args, getConfig, getPayload }) => {\n    const config = await getConfig()\n    const resolved = config.custom?.[PLUGIN_NAME] as ResolvedOptions | undefined\n    if (!resolved) {\n      throw new Error(\n        `${PLUGIN_NAME}: plugin is not registered in payload.config — no resolved options found on config.custom['${PLUGIN_NAME}'].`,\n      )\n    }\n\n    const payload = await getPayload()\n    const { lang, out, server } = args\n    const servers = server ? [{ url: server }] : undefined\n\n    const fallback = config.i18n?.fallbackLanguage ?? 'en'\n    const supported = config.i18n?.supportedLanguages ? Object.keys(config.i18n.supportedLanguages) : [fallback]\n    const langs = lang === 'all' ? supported : [lang ?? fallback]\n\n    for (const language of langs) {\n      const doc = await buildOpenApiDocument({ payload, options: resolved, language, servers })\n      const file = langs.length > 1 ? `openapi.${language}.json` : (out ?? 'openapi.json')\n      await writeFile(path.resolve(file), `${JSON.stringify(doc, null, 2)}\\n`)\n      payload.logger.info(`Wrote ${file}`)\n    }\n  },\n})\n"],"mappings":";;;;;;AAUA,MAAM,kBAAkB,gBAAwB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,SAAS,WAAW,CAAC;AAEpG,MAAa,sBAAsB,iBAAiB;CAClD,aAAa;CACb,OAAO,aAAa;EAClB,MAAM,eACJ,kHACF;EACA,KAAK,eAAe,+DAA+D;EACnF,QAAQ,eACN,iGACF;CACF,CAAC;CACD,SAAS,OAAO,EAAE,MAAM,WAAW,iBAAiB;EAClD,MAAM,SAAS,MAAM,UAAU;EAC/B,MAAM,WAAW,OAAO,SAAS;EACjC,IAAI,CAAC,UACH,MAAM,IAAI,MACR,GAAG,YAAY,6FAA6F,YAAY,IAC1H;EAGF,MAAM,UAAU,MAAM,WAAW;EACjC,MAAM,EAAE,MAAM,KAAK,WAAW;EAC9B,MAAM,UAAU,SAAS,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,KAAA;EAE7C,MAAM,WAAW,OAAO,MAAM,oBAAoB;EAClD,MAAM,YAAY,OAAO,MAAM,qBAAqB,OAAO,KAAK,OAAO,KAAK,kBAAkB,IAAI,CAAC,QAAQ;EAC3G,MAAM,QAAQ,SAAS,QAAQ,YAAY,CAAC,QAAQ,QAAQ;EAE5D,KAAK,MAAM,YAAY,OAAO;GAC5B,MAAM,MAAM,MAAM,qBAAqB;IAAE;IAAS,SAAS;IAAU;IAAU;GAAQ,CAAC;GACxF,MAAM,OAAO,MAAM,SAAS,IAAI,WAAW,SAAS,SAAU,OAAO;GACrE,MAAM,UAAU,KAAK,QAAQ,IAAI,GAAG,GAAG,KAAK,UAAU,KAAK,MAAM,CAAC,EAAE,GAAG;GACvE,QAAQ,OAAO,KAAK,SAAS,MAAM;EACrC;CACF;AACF,CAAC"}

package/dist/index.d.ts

@@ -1,9 +1,8 @@
-import type { Plugin } from 'payload';
-import type { OpenApiPluginOptions } from './types.js';
-export declare const openapi: (options: OpenApiPluginOptions) => Plugin;
-export { buildOpenApiDocument } from './spec/build.js';
-export type { BuildOpenApiInput } from './spec/build.js';
-export { toOpenApi30, toOpenApi31 } from './spec/downconvert.js';
-export { scalar } from './ui/scalar.js';
-export { swaggerUi } from './ui/swagger.js';
-export type { BuildContext, EntityOperation, EntitySecurityOverride, FilterOptions, OpenApiExtension, OpenApiMetadata, OpenApiPluginOptions, OpenApiVersion, OperationContext, UiPluginOptions, } from './types.js';
+import { AccessOption, BuildContext, EntityOpenApiMeta, EntityOperation, EntitySecurityOverride, ExtensionContext, FieldOpenApiMeta, FilterOptions, LocalizedText, OpenApiExtension, OpenApiInfo, OpenApiPluginOptions, OpenApiVersion, OperationContext, OperationFilter, OperationKind, OperationRule, SecurityMarking, SecurityOption, ServersOption, UiPluginOptions } from "./shared/types/index.js";
+import { BuildOpenApiInput, buildOpenApiDocument } from "./server/spec/build.js";
+import { toOpenApi30, toOpenApi31 } from "./server/spec/downconvert.js";
+import { scalar } from "./server/ui/scalar.js";
+import { swaggerUi } from "./server/ui/swagger.js";
+export declare const openapi: (options: OpenApiPluginOptions) => import("payload").Plugin;
+export { type AccessOption, type BuildContext, type BuildOpenApiInput, type EntityOpenApiMeta, type EntityOperation, type EntitySecurityOverride, type ExtensionContext, type FieldOpenApiMeta, type FilterOptions, type LocalizedText, type OpenApiExtension, type OpenApiInfo, type OpenApiPluginOptions, type OpenApiVersion, type OperationContext, type OperationFilter, type OperationKind, type OperationRule, type SecurityMarking, type SecurityOption, type ServersOption, type UiPluginOptions, buildOpenApiDocument, scalar, swaggerUi, toOpenApi30, toOpenApi31 };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,67 +1,78 @@
+import { interactiveAuthHandler } from "./server/endpoints/interactiveAuth.js";
+import { PLUGIN_NAME } from "./shared/constants.js";
+import { translations } from "./shared/translations/index.js";
+import { readSecurityOverride } from "./server/spec/security.js";
+import { toOpenApi30, toOpenApi31 } from "./server/spec/downconvert.js";
+import { buildOpenApiDocument } from "./server/spec/build.js";
+import { specHandler } from "./server/endpoints/spec.js";
+import { resolveOptions } from "./server/options/resolveOptions.js";
+import { buildFeatures, reportOpenApiTelemetry } from "./server/telemetry.js";
+import { scalar } from "./server/ui/scalar.js";
+import { swaggerUi } from "./server/ui/swagger.js";
 import { fileURLToPath } from "node:url";
-import { PLUGIN_NAME } from "./constants.js";
-import { resolveOptions } from "./options.js";
-import { interactiveAuthHandler } from "./endpoints/interactiveAuth.js";
-import { specHandler } from "./endpoints/spec.js";
-import { translations } from "./translations/index.js";
-const BIN_KEY = 'openapi:generate';
-const resolveBinScriptPath = ()=>{
-    const selfUrl = new URL(import.meta.url);
-    const ext = selfUrl.pathname.endsWith('.ts') ? '.ts' : '.js';
-    return fileURLToPath(new URL(`./bin/generateSpec${ext}`, selfUrl));
+import { definePlugin } from "payload";
+const CLI_COMMAND = "openapi:generate";
+const resolveCommandPath = () => {
+	const selfUrl = new URL(import.meta.url);
+	const ext = selfUrl.pathname.endsWith(".ts") ? ".ts" : ".js";
+	return `${fileURLToPath(new URL(`./cli/generateSpec${ext}`, selfUrl))}#generateSpecCommand`;
 };
-const openapi = (options)=>(config)=>{
-        if (false === options.enabled) return config;
-        const resolved = resolveOptions(options);
-        const authCollection = (config.collections ?? []).find((c)=>Boolean(c.auth))?.slug ?? 'users';
-        config.i18n = config.i18n ?? {};
-        config.i18n.translations = config.i18n.translations ?? {};
-        const supportedKeys = config.i18n.supportedLanguages ? Object.keys(config.i18n.supportedLanguages) : [
-            'en'
-        ];
-        for (const lang of supportedKeys){
-            const pluginEntry = translations[lang];
-            if (!pluginEntry) continue;
-            const typedLang = lang;
-            config.i18n.translations[typedLang] = {
-                ...config.i18n.translations[typedLang],
-                [PLUGIN_NAME]: pluginEntry[PLUGIN_NAME]
-            };
-        }
-        return {
-            ...config,
-            custom: {
-                ...config.custom,
-                [PLUGIN_NAME]: resolved
-            },
-            bin: [
-                ...config.bin ?? [],
-                {
-                    key: BIN_KEY,
-                    scriptPath: resolveBinScriptPath()
-                }
-            ],
-            endpoints: [
-                ...config.endpoints ?? [],
-                ...resolved.serve ? [
-                    {
-                        path: resolved.specEndpoint,
-                        method: 'get',
-                        handler: specHandler(resolved)
-                    },
-                    ...resolved.interactiveAuth.enabled ? [
-                        {
-                            path: resolved.interactiveAuth.endpoint,
-                            method: 'post',
-                            handler: interactiveAuthHandler(authCollection)
-                        }
-                    ] : []
-                ] : []
-            ]
-        };
-    };
-export { buildOpenApiDocument } from "./spec/build.js";
-export { toOpenApi30, toOpenApi31 } from "./spec/downconvert.js";
-export { scalar } from "./ui/scalar.js";
-export { swaggerUi } from "./ui/swagger.js";
-export { openapi };
+const openapi = definePlugin({
+	slug: PLUGIN_NAME,
+	plugin: ({ config, options, plugins }) => {
+		const resolved = resolveOptions(options);
+		for (const entity of [...config.collections ?? [], ...config.globals ?? []]) readSecurityOverride(entity);
+		if (options.enabled === false) return config;
+		const authCollection = resolved.interactiveAuth.collection ?? (config.collections ?? []).find((c) => Boolean(c.auth))?.slug ?? "users";
+		const features = buildFeatures({
+			plugins,
+			resolved
+		});
+		config.i18n = config.i18n ?? {};
+		config.i18n.translations = config.i18n.translations ?? {};
+		const supportedKeys = config.i18n.supportedLanguages ? Object.keys(config.i18n.supportedLanguages) : ["en"];
+		for (const lang of supportedKeys) {
+			const pluginEntry = translations[lang];
+			if (!pluginEntry) continue;
+			const typedLang = lang;
+			config.i18n.translations[typedLang] = {
+				...config.i18n.translations[typedLang],
+				[PLUGIN_NAME]: pluginEntry[PLUGIN_NAME]
+			};
+		}
+		return {
+			...config,
+			custom: {
+				...config.custom,
+				[PLUGIN_NAME]: resolved
+			},
+			cli: config.cli === false ? config.cli : {
+				...config.cli,
+				commands: {
+					[CLI_COMMAND]: resolveCommandPath(),
+					...config.cli?.commands
+				}
+			},
+			endpoints: [...config.endpoints ?? [], ...resolved.serve ? [{
+				path: resolved.path,
+				method: "get",
+				handler: specHandler(resolved)
+			}, ...resolved.interactiveAuth.enabled ? [{
+				path: resolved.interactiveAuth.path,
+				method: "post",
+				handler: interactiveAuthHandler(authCollection)
+			}] : []] : []],
+			onInit: async (payload) => {
+				await config.onInit?.(payload);
+				reportOpenApiTelemetry({
+					features,
+					options,
+					payload
+				});
+			}
+		};
+	}
+});
+export { buildOpenApiDocument, openapi, scalar, swaggerUi, toOpenApi30, toOpenApi31 };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { fileURLToPath } from 'node:url'\n\nimport { definePlugin } from 'payload'\n\nimport { interactiveAuthHandler } from '@/server/endpoints/interactiveAuth.js'\nimport { specHandler } from '@/server/endpoints/spec.js'\nimport { resolveOptions } from '@/server/options/resolveOptions.js'\nimport { readSecurityOverride } from '@/server/spec/security.js'\nimport { buildFeatures, reportOpenApiTelemetry } from '@/server/telemetry.js'\nimport { PLUGIN_NAME } from '@/shared/constants.js'\nimport { translations } from '@/shared/translations/index.js'\nimport type { OpenApiPluginOptions } from '@/shared/types/index.js'\n\nconst CLI_COMMAND = 'openapi:generate'\n\nconst resolveCommandPath = (): string => {\n  const selfUrl = new URL(import.meta.url)\n  const ext = selfUrl.pathname.endsWith('.ts') ? '.ts' : '.js'\n  return `${fileURLToPath(new URL(`./cli/generateSpec${ext}`, selfUrl))}#generateSpecCommand`\n}\n\nexport const openapi = definePlugin<OpenApiPluginOptions>({\n  slug: PLUGIN_NAME,\n  plugin: ({ config, options, plugins }) => {\n    const resolved = resolveOptions(options)\n    for (const entity of [...(config.collections ?? []), ...(config.globals ?? [])]) readSecurityOverride(entity)\n    if (options.enabled === false) return config\n\n    const authCollection =\n      resolved.interactiveAuth.collection ?? (config.collections ?? []).find((c) => Boolean(c.auth))?.slug ?? 'users'\n    const features = buildFeatures({ plugins, resolved })\n\n    config.i18n = config.i18n ?? {}\n    config.i18n.translations = config.i18n.translations ?? {}\n    const supportedKeys = config.i18n.supportedLanguages ? Object.keys(config.i18n.supportedLanguages) : ['en']\n    for (const lang of supportedKeys) {\n      const pluginEntry = translations[lang as keyof typeof translations]\n      if (!pluginEntry) continue\n      const typedLang = lang as keyof typeof config.i18n.translations\n      config.i18n.translations[typedLang] = {\n        ...(config.i18n.translations[typedLang] as Record<string, unknown>),\n        [PLUGIN_NAME]: pluginEntry[PLUGIN_NAME],\n      } as (typeof config.i18n.translations)[typeof typedLang]\n    }\n\n    return {\n      ...config,\n      custom: {\n        ...config.custom,\n        [PLUGIN_NAME]: resolved,\n      },\n      cli:\n        config.cli === false\n          ? config.cli\n          : {\n              ...config.cli,\n              commands: { [CLI_COMMAND]: resolveCommandPath(), ...config.cli?.commands },\n            },\n      endpoints: [\n        ...(config.endpoints ?? []),\n        ...(resolved.serve\n          ? [\n              {\n                path: resolved.path,\n                method: 'get' as const,\n                handler: specHandler(resolved),\n              },\n              ...(resolved.interactiveAuth.enabled\n                ? [\n                    {\n                      path: resolved.interactiveAuth.path,\n                      method: 'post' as const,\n                      handler: interactiveAuthHandler(authCollection),\n                    },\n                  ]\n                : []),\n            ]\n          : []),\n      ],\n      onInit: async (payload) => {\n        await config.onInit?.(payload)\n        void reportOpenApiTelemetry({ features, options, payload })\n      },\n    }\n  },\n})\n\nexport { buildOpenApiDocument } from '@/server/spec/build.js'\nexport type { BuildOpenApiInput } from '@/server/spec/build.js'\nexport { toOpenApi30, toOpenApi31 } from '@/server/spec/downconvert.js'\nexport { scalar } from '@/server/ui/scalar.js'\nexport { swaggerUi } from '@/server/ui/swagger.js'\n\nexport type {\n  AccessOption,\n  BuildContext,\n  EntityOpenApiMeta,\n  EntityOperation,\n  EntitySecurityOverride,\n  ExtensionContext,\n  FieldOpenApiMeta,\n  FilterOptions,\n  LocalizedText,\n  OpenApiExtension,\n  OpenApiInfo,\n  OpenApiPluginOptions,\n  OpenApiVersion,\n  OperationContext,\n  OperationFilter,\n  OperationKind,\n  OperationRule,\n  SecurityMarking,\n  SecurityOption,\n  ServersOption,\n  UiPluginOptions,\n} from '@/shared/types/index.js'\n"],"mappings":";;;;;;;;;;;;;AAaA,MAAM,cAAc;AAEpB,MAAM,2BAAmC;CACvC,MAAM,UAAU,IAAI,IAAI,YAAY,GAAG;CACvC,MAAM,MAAM,QAAQ,SAAS,SAAS,KAAK,IAAI,QAAQ;CACvD,OAAO,GAAG,cAAc,IAAI,IAAI,qBAAqB,OAAO,OAAO,CAAC,EAAE;AACxE;AAEA,MAAa,UAAU,aAAmC;CACxD,MAAM;CACN,SAAS,EAAE,QAAQ,SAAS,cAAc;EACxC,MAAM,WAAW,eAAe,OAAO;EACvC,KAAK,MAAM,UAAU,CAAC,GAAI,OAAO,eAAe,CAAC,GAAI,GAAI,OAAO,WAAW,CAAC,CAAE,GAAG,qBAAqB,MAAM;EAC5G,IAAI,QAAQ,YAAY,OAAO,OAAO;EAEtC,MAAM,iBACJ,SAAS,gBAAgB,eAAe,OAAO,eAAe,CAAC,EAAA,CAAG,MAAM,MAAM,QAAQ,EAAE,IAAI,CAAC,CAAC,EAAE,QAAQ;EAC1G,MAAM,WAAW,cAAc;GAAE;GAAS;EAAS,CAAC;EAEpD,OAAO,OAAO,OAAO,QAAQ,CAAC;EAC9B,OAAO,KAAK,eAAe,OAAO,KAAK,gBAAgB,CAAC;EACxD,MAAM,gBAAgB,OAAO,KAAK,qBAAqB,OAAO,KAAK,OAAO,KAAK,kBAAkB,IAAI,CAAC,IAAI;EAC1G,KAAK,MAAM,QAAQ,eAAe;GAChC,MAAM,cAAc,aAAa;GACjC,IAAI,CAAC,aAAa;GAClB,MAAM,YAAY;GAClB,OAAO,KAAK,aAAa,aAAa;IACpC,GAAI,OAAO,KAAK,aAAa;KAC5B,cAAc,YAAY;GAC7B;EACF;EAEA,OAAO;GACL,GAAG;GACH,QAAQ;IACN,GAAG,OAAO;KACT,cAAc;GACjB;GACA,KACE,OAAO,QAAQ,QACX,OAAO,MACP;IACE,GAAG,OAAO;IACV,UAAU;MAAG,cAAc,mBAAmB;KAAG,GAAG,OAAO,KAAK;IAAS;GAC3E;GACN,WAAW,CACT,GAAI,OAAO,aAAa,CAAC,GACzB,GAAI,SAAS,QACT,CACE;IACE,MAAM,SAAS;IACf,QAAQ;IACR,SAAS,YAAY,QAAQ;GAC/B,GACA,GAAI,SAAS,gBAAgB,UACzB,CACE;IACE,MAAM,SAAS,gBAAgB;IAC/B,QAAQ;IACR,SAAS,uBAAuB,cAAc;GAChD,CACF,IACA,CAAC,CACP,IACA,CAAC,CACP;GACA,QAAQ,OAAO,YAAY;IACzB,MAAM,OAAO,SAAS,OAAO;IAC7B,uBAA4B;KAAE;KAAU;KAAS;IAAQ,CAAC;GAC5D;EACF;CACF;AACF,CAAC"}

package/dist/{endpoints → server/endpoints}/interactiveAuth.d.ts

@@ -1,4 +1,4 @@
-import type { Endpoint } from 'payload';
+import { Endpoint } from "payload";
 type InteractiveAuthHandler = (authCollectionSlug: string) => Endpoint['handler'];
 export declare const interactiveAuthHandler: InteractiveAuthHandler;
-export {};
+//# sourceMappingURL=interactiveAuth.d.ts.map

package/dist/server/endpoints/interactiveAuth.js

@@ -0,0 +1,25 @@
+const interactiveAuthHandler = (authCollectionSlug) => async (req) => {
+	const form = await req.formData?.();
+	const username = form?.get("username")?.toString() ?? "";
+	const password = form?.get("password")?.toString() ?? "";
+	try {
+		const result = await req.payload.login({
+			collection: authCollectionSlug,
+			data: {
+				email: username,
+				username,
+				password
+			}
+		});
+		return Response.json({
+			access_token: result.token,
+			token_type: "JWT",
+			expires_in: result.exp === void 0 ? void 0 : result.exp - Math.floor(Date.now() / 1e3)
+		});
+	} catch {
+		return Response.json({ error: "invalid_grant" }, { status: 400 });
+	}
+};
+export { interactiveAuthHandler };
+
+//# sourceMappingURL=interactiveAuth.js.map

package/dist/server/endpoints/interactiveAuth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interactiveAuth.js","names":[],"sources":["../../../src/server/endpoints/interactiveAuth.ts"],"sourcesContent":["import type { Endpoint } from 'payload'\n\ntype InteractiveAuthHandler = (authCollectionSlug: string) => Endpoint['handler']\n\nexport const interactiveAuthHandler: InteractiveAuthHandler = (authCollectionSlug) => async (req) => {\n  const form = await req.formData?.()\n  const username = form?.get('username')?.toString() ?? ''\n  const password = form?.get('password')?.toString() ?? ''\n\n  try {\n    const result = await req.payload.login({\n      collection: authCollectionSlug,\n      data: { email: username, username, password } as never,\n    })\n    return Response.json({\n      access_token: result.token,\n      token_type: 'JWT',\n      expires_in: result.exp === undefined ? undefined : result.exp - Math.floor(Date.now() / 1000),\n    })\n  } catch {\n    return Response.json({ error: 'invalid_grant' }, { status: 400 })\n  }\n}\n"],"mappings":"AAIA,MAAa,0BAAkD,uBAAuB,OAAO,QAAQ;CACnG,MAAM,OAAO,MAAM,IAAI,WAAW;CAClC,MAAM,WAAW,MAAM,IAAI,UAAU,CAAC,EAAE,SAAS,KAAK;CACtD,MAAM,WAAW,MAAM,IAAI,UAAU,CAAC,EAAE,SAAS,KAAK;CAEtD,IAAI;EACF,MAAM,SAAS,MAAM,IAAI,QAAQ,MAAM;GACrC,YAAY;GACZ,MAAM;IAAE,OAAO;IAAU;IAAU;GAAS;EAC9C,CAAC;EACD,OAAO,SAAS,KAAK;GACnB,cAAc,OAAO;GACrB,YAAY;GACZ,YAAY,OAAO,QAAQ,KAAA,IAAY,KAAA,IAAY,OAAO,MAAM,KAAK,MAAM,KAAK,IAAI,IAAI,GAAI;EAC9F,CAAC;CACH,QAAQ;EACN,OAAO,SAAS,KAAK,EAAE,OAAO,gBAAgB,GAAG,EAAE,QAAQ,IAAI,CAAC;CAClE;AACF"}