@kubb/plugin-redoc 5.0.4 → 5.0.6

package/OVERVIEW.md

@@ -0,0 +1,15 @@
+# Redoc
+
+Generates a single HTML page that documents your OpenAPI spec with Redoc. The page is rebuilt on every Kubb run, so the docs always match the spec your code comes from.
+
+The spec is embedded in the page, so you can publish it to any static host without a build step. Viewing the page needs network access, because Redoc's scripts and fonts load from a CDN.
+
+## Setup
+
+No other plugins or packages are needed.
+
+## Options worth knowing
+
+- `output.path` is the path of the HTML file. The default is `docs.html`. It points at a file, not a folder, so end it with `.html`.
+
+The plugin takes no other options.

package/dist/index.cjs

@@ -28,8 +28,14 @@ let node_path = require("node:path");
 node_path = __toESM(node_path, 1);
 let _kubb_adapter_oas = require("@kubb/adapter-oas");
 let kubb_kit = require("kubb/kit");
+//#region kubb-extension.json
+var compatibility = {
+	"kubb": ">=5.8.0",
+	"node": ">=22"
+};
+//#endregion
 //#region package.json
-var version = "5.0.4";
+var version = "5.0.6";
 //#endregion
 //#region src/redoc.tsx
 const htmlEscapes = {
@@ -107,37 +113,38 @@ const pluginRedocName = "plugin-redoc";
 * })
 * ```
 */
-const pluginRedoc = (0, kubb_kit.definePlugin)((options) => {
-	const { output = { path: "docs.html" } } = options;
-	const extname = node_path.default.extname(output.path);
-	const name = extname ? output.path.slice(0, -extname.length) : output.path;
-	return {
+const pluginRedoc = (0, kubb_kit.definePlugin)({
+	meta: {
 		name: pluginRedocName,
 		version,
-		options,
-		hooks: { async "kubb:plugin:setup"(ctx) {
-			ctx.setOptions({
-				output,
-				name,
-				exclude: [],
-				override: []
-			});
-			const adapter = ctx.config.adapter;
-			if (adapter?.name !== _kubb_adapter_oas.adapterOasName) throw new Error(`[${pluginRedocName}] plugin-redoc requires the OpenAPI adapter. Make sure you are using adapterOas (e.g. \`adapter: adapterOas()\`) in your Kubb config.`);
-			const document = adapter.document;
-			if (!document) throw new Error(`[${pluginRedocName}] No OpenAPI document found. The adapterOas did not produce a document — ensure the adapter has run before this plugin.`);
-			const root = node_path.default.resolve(ctx.config.root, ctx.config.output.path);
-			const pageHTML = await getPageHTML(document);
-			ctx.injectFile({
-				baseName: "docs.html",
-				path: node_path.default.resolve(root, output.path || "./docs.html"),
-				sources: [kubb_kit.ast.factory.createSource({
-					name: "docs.html",
-					nodes: [kubb_kit.ast.factory.createText(pageHTML)]
-				})]
-			});
-		} }
-	};
+		compatibility
+	},
+	async setup(options) {
+		const config = (0, kubb_kit.useConfig)();
+		const { output = { path: "docs.html" } } = options;
+		const extname = node_path.default.extname(output.path);
+		const name = extname ? output.path.slice(0, -extname.length) : output.path;
+		const adapter = config.adapter;
+		if (adapter?.name !== _kubb_adapter_oas.adapterOasName) throw new Error(`[${pluginRedocName}] plugin-redoc requires the OpenAPI adapter. Make sure you are using adapterOas (e.g. \`adapter: adapterOas()\`) in your Kubb config.`);
+		const document = adapter.document;
+		if (!document) throw new Error(`[${pluginRedocName}] No OpenAPI document found. The adapterOas did not produce a document — ensure the adapter has run before this plugin.`);
+		const root = node_path.default.resolve(config.root, config.output.path);
+		const pageHTML = await getPageHTML(document);
+		(0, kubb_kit.injectFile)({
+			baseName: "docs.html",
+			path: node_path.default.resolve(root, output.path || "./docs.html"),
+			sources: [kubb_kit.ast.factory.createSource({
+				name: "docs.html",
+				nodes: [kubb_kit.ast.factory.createText(pageHTML)]
+			})]
+		});
+		return {
+			output,
+			name,
+			exclude: [],
+			override: []
+		};
+	}
 });
 //#endregion
 exports.default = pluginRedoc;

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["definePlugin","path","adapterOasName","ast"],"sources":["../package.json","../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["","import type { AdapterOas } from '@kubb/adapter-oas'\n\nconst htmlEscapes: Record<string, string> = {\n  '&': '&amp;',\n  '<': '&lt;',\n  '>': '&gt;',\n  '\"': '&quot;',\n  \"'\": '&#x27;',\n  '`': '&#x60;',\n  '=': '&#x3D;',\n}\n\nfunction escapeHtml(value: string) {\n  return value.replace(/[&<>\"'`=]/g, (char) => htmlEscapes[char] ?? char)\n}\n\n/**\n * Renders a self-contained Redoc HTML page for an OpenAPI document. The page\n * embeds the spec inline and pulls Redoc's bundle from a CDN at runtime, so\n * the generated file works without further build steps.\n */\nexport async function getPageHTML(api: AdapterOas['document']) {\n  const pageTitle = escapeHtml(api.info.title || 'ReDoc documentation')\n  const googleFont = `<link href='https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700' rel='stylesheet' />`\n  const redocHTML = `\n     <script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"> </script>\n <div id=\"redoc-container\"></div>\n <script>\n   const data = ${JSON.stringify(api, null, 2)};\n   Redoc.init(data, {\n     \"expandResponses\": \"200,400\"\n   }, document.getElementById('redoc-container'))\n </script>\n    `\n\n  return `<html>\n\n  <head>\n    <meta charset='utf8' />\n    <title>${pageTitle}</title>\n    <!-- needed for adaptive design -->\n    <meta name='viewport' content='width=device-width, initial-scale=1' />\n    <style>\n      body {\n        padding: 0;\n        margin: 0;\n      }\n    </style>\n    ${googleFont}\n  </head>\n\n  <body>\n    ${redocHTML}\n  </body>\n\n</html>`\n}\n","import path from 'node:path'\nimport type { AdapterOas } from '@kubb/adapter-oas'\nimport { adapterOasName } from '@kubb/adapter-oas'\n\nimport { type Adapter, ast, definePlugin } from 'kubb/kit'\nimport { version } from '../package.json'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\n/**\n * Canonical plugin name for `@kubb/plugin-redoc`. Used for driver lookups and\n * cross-plugin dependency references.\n */\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\n/**\n * Generates a self-contained static HTML documentation page from your OpenAPI\n * spec using Redoc. The file is regenerated on every Kubb build, so the docs\n * stay in lockstep with the spec the rest of your code is generated from.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb/config'\n * import { pluginRedoc } from '@kubb/plugin-redoc'\n *\n * export default defineConfig({\n *   input: './petStore.yaml',\n *   output: { path: './src/gen' },\n *   plugins: [\n *     pluginRedoc({ output: { path: 'docs.html' } }),\n *   ],\n * })\n * ```\n */\nexport const pluginRedoc = definePlugin<PluginRedoc>((options) => {\n  const { output = { path: 'docs.html' } } = options\n  const extname = path.extname(output.path)\n  const name = extname ? output.path.slice(0, -extname.length) : output.path\n\n  return {\n    name: pluginRedocName,\n    version,\n    options,\n    hooks: {\n      async 'kubb:plugin:setup'(ctx) {\n        ctx.setOptions({\n          output,\n          name,\n          exclude: [],\n          override: [],\n        })\n\n        const adapter = ctx.config.adapter\n\n        if (adapter?.name !== adapterOasName) {\n          throw new Error(\n            `[${pluginRedocName}] plugin-redoc requires the OpenAPI adapter. Make sure you are using adapterOas (e.g. \\`adapter: adapterOas()\\`) in your Kubb config.`,\n          )\n        }\n\n        const document = (adapter as Adapter<AdapterOas>).document\n\n        if (!document) {\n          throw new Error(\n            `[${pluginRedocName}] No OpenAPI document found. The adapterOas did not produce a document — ensure the adapter has run before this plugin.`,\n          )\n        }\n\n        const root = path.resolve(ctx.config.root, ctx.config.output.path)\n        const pageHTML = await getPageHTML(document)\n\n        ctx.injectFile({\n          baseName: 'docs.html',\n          path: path.resolve(root, output.path || './docs.html'),\n          sources: [\n            ast.factory.createSource({\n              name: 'docs.html',\n              nodes: [ast.factory.createText(pageHTML)],\n            }),\n          ],\n        })\n      },\n    },\n  }\n})\n\nexport default pluginRedoc\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACEA,MAAM,cAAsC;CAC1C,KAAK;CACL,KAAK;CACL,KAAK;CACL,MAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;AACP;AAEA,SAAS,WAAW,OAAe;CACjC,OAAO,MAAM,QAAQ,eAAe,SAAS,YAAY,SAAS,IAAI;AACxE;;;;;;AAOA,eAAsB,YAAY,KAA6B;CAc7D,OAAO;;;;aAbW,WAAW,IAAI,KAAK,SAAS,qBAiB5B,EAAE;;;;;;;;;;;;;MAajB;;;;kBAxBY,KAAK,UAAU,KAAK,MAAM,CAAC,EAAE;;;;;MAwB/B;;;;AAIhB;;;;;;;AC3CA,MAAa,kBAAkB;;;;;;;;;;;;;;;;;;;;AAqB/B,MAAa,eAAA,GAAcA,SAAAA,aAAAA,EAA2B,YAAY;CAChE,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,MAAM;CAC3C,MAAM,UAAUC,UAAAA,QAAK,QAAQ,OAAO,IAAI;CACxC,MAAM,OAAO,UAAU,OAAO,KAAK,MAAM,GAAG,CAAC,QAAQ,MAAM,IAAI,OAAO;CAEtE,OAAO;EACL,MAAM;EACN;EACA;EACA,OAAO,EACL,MAAM,oBAAoB,KAAK;GAC7B,IAAI,WAAW;IACb;IACA;IACA,SAAS,CAAC;IACV,UAAU,CAAC;GACb,CAAC;GAED,MAAM,UAAU,IAAI,OAAO;GAE3B,IAAI,SAAS,SAASC,kBAAAA,gBACpB,MAAM,IAAI,MACR,IAAI,gBAAgB,sIACtB;GAGF,MAAM,WAAY,QAAgC;GAElD,IAAI,CAAC,UACH,MAAM,IAAI,MACR,IAAI,gBAAgB,wHACtB;GAGF,MAAM,OAAOD,UAAAA,QAAK,QAAQ,IAAI,OAAO,MAAM,IAAI,OAAO,OAAO,IAAI;GACjE,MAAM,WAAW,MAAM,YAAY,QAAQ;GAE3C,IAAI,WAAW;IACb,UAAU;IACV,MAAMA,UAAAA,QAAK,QAAQ,MAAM,OAAO,QAAQ,aAAa;IACrD,SAAS,CACPE,SAAAA,IAAI,QAAQ,aAAa;KACvB,MAAM;KACN,OAAO,CAACA,SAAAA,IAAI,QAAQ,WAAW,QAAQ,CAAC;IAC1C,CAAC,CACH;GACF,CAAC;EACH,EACF;CACF;AACF,CAAC"}
+{"version":3,"file":"index.cjs","names":["definePlugin","useConfig","path","adapterOasName","ast"],"sources":["../kubb-extension.json","../package.json","../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["","","import type { AdapterOas } from '@kubb/adapter-oas'\n\nconst htmlEscapes: Record<string, string> = {\n  '&': '&amp;',\n  '<': '&lt;',\n  '>': '&gt;',\n  '\"': '&quot;',\n  \"'\": '&#x27;',\n  '`': '&#x60;',\n  '=': '&#x3D;',\n}\n\nfunction escapeHtml(value: string) {\n  return value.replace(/[&<>\"'`=]/g, (char) => htmlEscapes[char] ?? char)\n}\n\n/**\n * Renders a self-contained Redoc HTML page for an OpenAPI document. The page\n * embeds the spec inline and pulls Redoc's bundle from a CDN at runtime, so\n * the generated file works without further build steps.\n */\nexport async function getPageHTML(api: AdapterOas['document']) {\n  const pageTitle = escapeHtml(api.info.title || 'ReDoc documentation')\n  const googleFont = `<link href='https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700' rel='stylesheet' />`\n  const redocHTML = `\n     <script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"> </script>\n <div id=\"redoc-container\"></div>\n <script>\n   const data = ${JSON.stringify(api, null, 2)};\n   Redoc.init(data, {\n     \"expandResponses\": \"200,400\"\n   }, document.getElementById('redoc-container'))\n </script>\n    `\n\n  return `<html>\n\n  <head>\n    <meta charset='utf8' />\n    <title>${pageTitle}</title>\n    <!-- needed for adaptive design -->\n    <meta name='viewport' content='width=device-width, initial-scale=1' />\n    <style>\n      body {\n        padding: 0;\n        margin: 0;\n      }\n    </style>\n    ${googleFont}\n  </head>\n\n  <body>\n    ${redocHTML}\n  </body>\n\n</html>`\n}\n","import path from 'node:path'\nimport type { AdapterOas } from '@kubb/adapter-oas'\nimport { adapterOasName } from '@kubb/adapter-oas'\n\nimport { type Adapter, ast, definePlugin, injectFile, useConfig } from 'kubb/kit'\nimport { compatibility } from '../kubb-extension.json'\nimport { version } from '../package.json'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\n/**\n * Canonical plugin name for `@kubb/plugin-redoc`. Used for driver lookups and\n * cross-plugin dependency references.\n */\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\n/**\n * Generates a self-contained static HTML documentation page from your OpenAPI\n * spec using Redoc. The file is regenerated on every Kubb build, so the docs\n * stay in lockstep with the spec the rest of your code is generated from.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb/config'\n * import { pluginRedoc } from '@kubb/plugin-redoc'\n *\n * export default defineConfig({\n *   input: './petStore.yaml',\n *   output: { path: './src/gen' },\n *   plugins: [\n *     pluginRedoc({ output: { path: 'docs.html' } }),\n *   ],\n * })\n * ```\n */\nexport const pluginRedoc = definePlugin<PluginRedoc>({\n  meta: { name: pluginRedocName, version, compatibility },\n  async setup(options) {\n    const config = useConfig()\n    const { output = { path: 'docs.html' } } = options\n    const extname = path.extname(output.path)\n    const name = extname ? output.path.slice(0, -extname.length) : output.path\n\n    const adapter = config.adapter\n\n    if (adapter?.name !== adapterOasName) {\n      throw new Error(\n        `[${pluginRedocName}] plugin-redoc requires the OpenAPI adapter. Make sure you are using adapterOas (e.g. \\`adapter: adapterOas()\\`) in your Kubb config.`,\n      )\n    }\n\n    const document = (adapter as Adapter<AdapterOas>).document\n\n    if (!document) {\n      throw new Error(\n        `[${pluginRedocName}] No OpenAPI document found. The adapterOas did not produce a document — ensure the adapter has run before this plugin.`,\n      )\n    }\n\n    const root = path.resolve(config.root, config.output.path)\n    const pageHTML = await getPageHTML(document)\n\n    injectFile({\n      baseName: 'docs.html',\n      path: path.resolve(root, output.path || './docs.html'),\n      sources: [\n        ast.factory.createSource({\n          name: 'docs.html',\n          nodes: [ast.factory.createText(pageHTML)],\n        }),\n      ],\n    })\n\n    return { output, name, exclude: [], override: [] }\n  },\n})\n\nexport default pluginRedoc\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AEEA,MAAM,cAAsC;CAC1C,KAAK;CACL,KAAK;CACL,KAAK;CACL,MAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;AACP;AAEA,SAAS,WAAW,OAAe;CACjC,OAAO,MAAM,QAAQ,eAAe,SAAS,YAAY,SAAS,IAAI;AACxE;;;;;;AAOA,eAAsB,YAAY,KAA6B;CAc7D,OAAO;;;;aAbW,WAAW,IAAI,KAAK,SAAS,qBAiB5B,EAAE;;;;;;;;;;;;;MAajB;;;;kBAxBY,KAAK,UAAU,KAAK,MAAM,CAAC,EAAE;;;;;MAwB/B;;;;AAIhB;;;;;;;AC1CA,MAAa,kBAAkB;;;;;;;;;;;;;;;;;;;;AAqB/B,MAAa,eAAA,GAAcA,SAAAA,aAAAA,CAA0B;CACnD,MAAM;EAAE,MAAM;EAAiB;EAAS;CAAc;CACtD,MAAM,MAAM,SAAS;EACnB,MAAM,UAAA,GAASC,SAAAA,UAAAA,CAAU;EACzB,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,MAAM;EAC3C,MAAM,UAAUC,UAAAA,QAAK,QAAQ,OAAO,IAAI;EACxC,MAAM,OAAO,UAAU,OAAO,KAAK,MAAM,GAAG,CAAC,QAAQ,MAAM,IAAI,OAAO;EAEtE,MAAM,UAAU,OAAO;EAEvB,IAAI,SAAS,SAASC,kBAAAA,gBACpB,MAAM,IAAI,MACR,IAAI,gBAAgB,sIACtB;EAGF,MAAM,WAAY,QAAgC;EAElD,IAAI,CAAC,UACH,MAAM,IAAI,MACR,IAAI,gBAAgB,wHACtB;EAGF,MAAM,OAAOD,UAAAA,QAAK,QAAQ,OAAO,MAAM,OAAO,OAAO,IAAI;EACzD,MAAM,WAAW,MAAM,YAAY,QAAQ;EAE3C,CAAA,GAAA,SAAA,WAAA,CAAW;GACT,UAAU;GACV,MAAMA,UAAAA,QAAK,QAAQ,MAAM,OAAO,QAAQ,aAAa;GACrD,SAAS,CACPE,SAAAA,IAAI,QAAQ,aAAa;IACvB,MAAM;IACN,OAAO,CAACA,SAAAA,IAAI,QAAQ,WAAW,QAAQ,CAAC;GAC1C,CAAC,CACH;EACF,CAAC;EAED,OAAO;GAAE;GAAQ;GAAM,SAAS,CAAC;GAAG,UAAU,CAAC;EAAE;CACnD;AACF,CAAC"}

package/dist/index.d.ts

@@ -57,7 +57,7 @@ export declare const pluginRedocName = "plugin-redoc";
  * })
  * ```
  */
-export declare const pluginRedoc: (options?: Options | undefined) => import("kubb/kit").Plugin<PluginRedoc>;
+export declare const pluginRedoc: import("kubb/kit").PluginFactory<PluginRedoc>;
 //#endregion
 export { type PluginRedoc, pluginRedoc as default };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,9 +1,15 @@
 import "./rolldown-runtime-C0LytTxp.js";
 import path from "node:path";
 import { adapterOasName } from "@kubb/adapter-oas";
-import { ast, definePlugin } from "kubb/kit";
+import { ast, definePlugin, injectFile, useConfig } from "kubb/kit";
+//#region kubb-extension.json
+var compatibility = {
+	"kubb": ">=5.8.0",
+	"node": ">=22"
+};
+//#endregion
 //#region package.json
-var version = "5.0.4";
+var version = "5.0.6";
 //#endregion
 //#region src/redoc.tsx
 const htmlEscapes = {
@@ -81,37 +87,38 @@ const pluginRedocName = "plugin-redoc";
 * })
 * ```
 */
-const pluginRedoc = definePlugin((options) => {
-	const { output = { path: "docs.html" } } = options;
-	const extname = path.extname(output.path);
-	const name = extname ? output.path.slice(0, -extname.length) : output.path;
-	return {
+const pluginRedoc = definePlugin({
+	meta: {
 		name: pluginRedocName,
 		version,
-		options,
-		hooks: { async "kubb:plugin:setup"(ctx) {
-			ctx.setOptions({
-				output,
-				name,
-				exclude: [],
-				override: []
-			});
-			const adapter = ctx.config.adapter;
-			if (adapter?.name !== adapterOasName) throw new Error(`[${pluginRedocName}] plugin-redoc requires the OpenAPI adapter. Make sure you are using adapterOas (e.g. \`adapter: adapterOas()\`) in your Kubb config.`);
-			const document = adapter.document;
-			if (!document) throw new Error(`[${pluginRedocName}] No OpenAPI document found. The adapterOas did not produce a document — ensure the adapter has run before this plugin.`);
-			const root = path.resolve(ctx.config.root, ctx.config.output.path);
-			const pageHTML = await getPageHTML(document);
-			ctx.injectFile({
-				baseName: "docs.html",
-				path: path.resolve(root, output.path || "./docs.html"),
-				sources: [ast.factory.createSource({
-					name: "docs.html",
-					nodes: [ast.factory.createText(pageHTML)]
-				})]
-			});
-		} }
-	};
+		compatibility
+	},
+	async setup(options) {
+		const config = useConfig();
+		const { output = { path: "docs.html" } } = options;
+		const extname = path.extname(output.path);
+		const name = extname ? output.path.slice(0, -extname.length) : output.path;
+		const adapter = config.adapter;
+		if (adapter?.name !== adapterOasName) throw new Error(`[${pluginRedocName}] plugin-redoc requires the OpenAPI adapter. Make sure you are using adapterOas (e.g. \`adapter: adapterOas()\`) in your Kubb config.`);
+		const document = adapter.document;
+		if (!document) throw new Error(`[${pluginRedocName}] No OpenAPI document found. The adapterOas did not produce a document — ensure the adapter has run before this plugin.`);
+		const root = path.resolve(config.root, config.output.path);
+		const pageHTML = await getPageHTML(document);
+		injectFile({
+			baseName: "docs.html",
+			path: path.resolve(root, output.path || "./docs.html"),
+			sources: [ast.factory.createSource({
+				name: "docs.html",
+				nodes: [ast.factory.createText(pageHTML)]
+			})]
+		});
+		return {
+			output,
+			name,
+			exclude: [],
+			override: []
+		};
+	}
 });
 //#endregion
 export { pluginRedoc as default, pluginRedoc, pluginRedocName };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../package.json","../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["","import type { AdapterOas } from '@kubb/adapter-oas'\n\nconst htmlEscapes: Record<string, string> = {\n  '&': '&amp;',\n  '<': '&lt;',\n  '>': '&gt;',\n  '\"': '&quot;',\n  \"'\": '&#x27;',\n  '`': '&#x60;',\n  '=': '&#x3D;',\n}\n\nfunction escapeHtml(value: string) {\n  return value.replace(/[&<>\"'`=]/g, (char) => htmlEscapes[char] ?? char)\n}\n\n/**\n * Renders a self-contained Redoc HTML page for an OpenAPI document. The page\n * embeds the spec inline and pulls Redoc's bundle from a CDN at runtime, so\n * the generated file works without further build steps.\n */\nexport async function getPageHTML(api: AdapterOas['document']) {\n  const pageTitle = escapeHtml(api.info.title || 'ReDoc documentation')\n  const googleFont = `<link href='https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700' rel='stylesheet' />`\n  const redocHTML = `\n     <script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"> </script>\n <div id=\"redoc-container\"></div>\n <script>\n   const data = ${JSON.stringify(api, null, 2)};\n   Redoc.init(data, {\n     \"expandResponses\": \"200,400\"\n   }, document.getElementById('redoc-container'))\n </script>\n    `\n\n  return `<html>\n\n  <head>\n    <meta charset='utf8' />\n    <title>${pageTitle}</title>\n    <!-- needed for adaptive design -->\n    <meta name='viewport' content='width=device-width, initial-scale=1' />\n    <style>\n      body {\n        padding: 0;\n        margin: 0;\n      }\n    </style>\n    ${googleFont}\n  </head>\n\n  <body>\n    ${redocHTML}\n  </body>\n\n</html>`\n}\n","import path from 'node:path'\nimport type { AdapterOas } from '@kubb/adapter-oas'\nimport { adapterOasName } from '@kubb/adapter-oas'\n\nimport { type Adapter, ast, definePlugin } from 'kubb/kit'\nimport { version } from '../package.json'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\n/**\n * Canonical plugin name for `@kubb/plugin-redoc`. Used for driver lookups and\n * cross-plugin dependency references.\n */\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\n/**\n * Generates a self-contained static HTML documentation page from your OpenAPI\n * spec using Redoc. The file is regenerated on every Kubb build, so the docs\n * stay in lockstep with the spec the rest of your code is generated from.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb/config'\n * import { pluginRedoc } from '@kubb/plugin-redoc'\n *\n * export default defineConfig({\n *   input: './petStore.yaml',\n *   output: { path: './src/gen' },\n *   plugins: [\n *     pluginRedoc({ output: { path: 'docs.html' } }),\n *   ],\n * })\n * ```\n */\nexport const pluginRedoc = definePlugin<PluginRedoc>((options) => {\n  const { output = { path: 'docs.html' } } = options\n  const extname = path.extname(output.path)\n  const name = extname ? output.path.slice(0, -extname.length) : output.path\n\n  return {\n    name: pluginRedocName,\n    version,\n    options,\n    hooks: {\n      async 'kubb:plugin:setup'(ctx) {\n        ctx.setOptions({\n          output,\n          name,\n          exclude: [],\n          override: [],\n        })\n\n        const adapter = ctx.config.adapter\n\n        if (adapter?.name !== adapterOasName) {\n          throw new Error(\n            `[${pluginRedocName}] plugin-redoc requires the OpenAPI adapter. Make sure you are using adapterOas (e.g. \\`adapter: adapterOas()\\`) in your Kubb config.`,\n          )\n        }\n\n        const document = (adapter as Adapter<AdapterOas>).document\n\n        if (!document) {\n          throw new Error(\n            `[${pluginRedocName}] No OpenAPI document found. The adapterOas did not produce a document — ensure the adapter has run before this plugin.`,\n          )\n        }\n\n        const root = path.resolve(ctx.config.root, ctx.config.output.path)\n        const pageHTML = await getPageHTML(document)\n\n        ctx.injectFile({\n          baseName: 'docs.html',\n          path: path.resolve(root, output.path || './docs.html'),\n          sources: [\n            ast.factory.createSource({\n              name: 'docs.html',\n              nodes: [ast.factory.createText(pageHTML)],\n            }),\n          ],\n        })\n      },\n    },\n  }\n})\n\nexport default pluginRedoc\n"],"mappings":";;;;;;;;ACEA,MAAM,cAAsC;CAC1C,KAAK;CACL,KAAK;CACL,KAAK;CACL,MAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;AACP;AAEA,SAAS,WAAW,OAAe;CACjC,OAAO,MAAM,QAAQ,eAAe,SAAS,YAAY,SAAS,IAAI;AACxE;;;;;;AAOA,eAAsB,YAAY,KAA6B;CAc7D,OAAO;;;;aAbW,WAAW,IAAI,KAAK,SAAS,qBAiB5B,EAAE;;;;;;;;;;;;;MAajB;;;;kBAxBY,KAAK,UAAU,KAAK,MAAM,CAAC,EAAE;;;;;MAwB/B;;;;AAIhB;;;;;;;AC3CA,MAAa,kBAAkB;;;;;;;;;;;;;;;;;;;;AAqB/B,MAAa,cAAc,cAA2B,YAAY;CAChE,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,MAAM;CAC3C,MAAM,UAAU,KAAK,QAAQ,OAAO,IAAI;CACxC,MAAM,OAAO,UAAU,OAAO,KAAK,MAAM,GAAG,CAAC,QAAQ,MAAM,IAAI,OAAO;CAEtE,OAAO;EACL,MAAM;EACN;EACA;EACA,OAAO,EACL,MAAM,oBAAoB,KAAK;GAC7B,IAAI,WAAW;IACb;IACA;IACA,SAAS,CAAC;IACV,UAAU,CAAC;GACb,CAAC;GAED,MAAM,UAAU,IAAI,OAAO;GAE3B,IAAI,SAAS,SAAS,gBACpB,MAAM,IAAI,MACR,IAAI,gBAAgB,sIACtB;GAGF,MAAM,WAAY,QAAgC;GAElD,IAAI,CAAC,UACH,MAAM,IAAI,MACR,IAAI,gBAAgB,wHACtB;GAGF,MAAM,OAAO,KAAK,QAAQ,IAAI,OAAO,MAAM,IAAI,OAAO,OAAO,IAAI;GACjE,MAAM,WAAW,MAAM,YAAY,QAAQ;GAE3C,IAAI,WAAW;IACb,UAAU;IACV,MAAM,KAAK,QAAQ,MAAM,OAAO,QAAQ,aAAa;IACrD,SAAS,CACP,IAAI,QAAQ,aAAa;KACvB,MAAM;KACN,OAAO,CAAC,IAAI,QAAQ,WAAW,QAAQ,CAAC;IAC1C,CAAC,CACH;GACF,CAAC;EACH,EACF;CACF;AACF,CAAC"}
+{"version":3,"file":"index.js","names":[],"sources":["../kubb-extension.json","../package.json","../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["","","import type { AdapterOas } from '@kubb/adapter-oas'\n\nconst htmlEscapes: Record<string, string> = {\n  '&': '&amp;',\n  '<': '&lt;',\n  '>': '&gt;',\n  '\"': '&quot;',\n  \"'\": '&#x27;',\n  '`': '&#x60;',\n  '=': '&#x3D;',\n}\n\nfunction escapeHtml(value: string) {\n  return value.replace(/[&<>\"'`=]/g, (char) => htmlEscapes[char] ?? char)\n}\n\n/**\n * Renders a self-contained Redoc HTML page for an OpenAPI document. The page\n * embeds the spec inline and pulls Redoc's bundle from a CDN at runtime, so\n * the generated file works without further build steps.\n */\nexport async function getPageHTML(api: AdapterOas['document']) {\n  const pageTitle = escapeHtml(api.info.title || 'ReDoc documentation')\n  const googleFont = `<link href='https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700' rel='stylesheet' />`\n  const redocHTML = `\n     <script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"> </script>\n <div id=\"redoc-container\"></div>\n <script>\n   const data = ${JSON.stringify(api, null, 2)};\n   Redoc.init(data, {\n     \"expandResponses\": \"200,400\"\n   }, document.getElementById('redoc-container'))\n </script>\n    `\n\n  return `<html>\n\n  <head>\n    <meta charset='utf8' />\n    <title>${pageTitle}</title>\n    <!-- needed for adaptive design -->\n    <meta name='viewport' content='width=device-width, initial-scale=1' />\n    <style>\n      body {\n        padding: 0;\n        margin: 0;\n      }\n    </style>\n    ${googleFont}\n  </head>\n\n  <body>\n    ${redocHTML}\n  </body>\n\n</html>`\n}\n","import path from 'node:path'\nimport type { AdapterOas } from '@kubb/adapter-oas'\nimport { adapterOasName } from '@kubb/adapter-oas'\n\nimport { type Adapter, ast, definePlugin, injectFile, useConfig } from 'kubb/kit'\nimport { compatibility } from '../kubb-extension.json'\nimport { version } from '../package.json'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\n/**\n * Canonical plugin name for `@kubb/plugin-redoc`. Used for driver lookups and\n * cross-plugin dependency references.\n */\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\n/**\n * Generates a self-contained static HTML documentation page from your OpenAPI\n * spec using Redoc. The file is regenerated on every Kubb build, so the docs\n * stay in lockstep with the spec the rest of your code is generated from.\n *\n * @example\n * ```ts\n * import { defineConfig } from 'kubb/config'\n * import { pluginRedoc } from '@kubb/plugin-redoc'\n *\n * export default defineConfig({\n *   input: './petStore.yaml',\n *   output: { path: './src/gen' },\n *   plugins: [\n *     pluginRedoc({ output: { path: 'docs.html' } }),\n *   ],\n * })\n * ```\n */\nexport const pluginRedoc = definePlugin<PluginRedoc>({\n  meta: { name: pluginRedocName, version, compatibility },\n  async setup(options) {\n    const config = useConfig()\n    const { output = { path: 'docs.html' } } = options\n    const extname = path.extname(output.path)\n    const name = extname ? output.path.slice(0, -extname.length) : output.path\n\n    const adapter = config.adapter\n\n    if (adapter?.name !== adapterOasName) {\n      throw new Error(\n        `[${pluginRedocName}] plugin-redoc requires the OpenAPI adapter. Make sure you are using adapterOas (e.g. \\`adapter: adapterOas()\\`) in your Kubb config.`,\n      )\n    }\n\n    const document = (adapter as Adapter<AdapterOas>).document\n\n    if (!document) {\n      throw new Error(\n        `[${pluginRedocName}] No OpenAPI document found. The adapterOas did not produce a document — ensure the adapter has run before this plugin.`,\n      )\n    }\n\n    const root = path.resolve(config.root, config.output.path)\n    const pageHTML = await getPageHTML(document)\n\n    injectFile({\n      baseName: 'docs.html',\n      path: path.resolve(root, output.path || './docs.html'),\n      sources: [\n        ast.factory.createSource({\n          name: 'docs.html',\n          nodes: [ast.factory.createText(pageHTML)],\n        }),\n      ],\n    })\n\n    return { output, name, exclude: [], override: [] }\n  },\n})\n\nexport default pluginRedoc\n"],"mappings":";;;;;;;;;;;;;;AEEA,MAAM,cAAsC;CAC1C,KAAK;CACL,KAAK;CACL,KAAK;CACL,MAAK;CACL,KAAK;CACL,KAAK;CACL,KAAK;AACP;AAEA,SAAS,WAAW,OAAe;CACjC,OAAO,MAAM,QAAQ,eAAe,SAAS,YAAY,SAAS,IAAI;AACxE;;;;;;AAOA,eAAsB,YAAY,KAA6B;CAc7D,OAAO;;;;aAbW,WAAW,IAAI,KAAK,SAAS,qBAiB5B,EAAE;;;;;;;;;;;;;MAajB;;;;kBAxBY,KAAK,UAAU,KAAK,MAAM,CAAC,EAAE;;;;;MAwB/B;;;;AAIhB;;;;;;;AC1CA,MAAa,kBAAkB;;;;;;;;;;;;;;;;;;;;AAqB/B,MAAa,cAAc,aAA0B;CACnD,MAAM;EAAE,MAAM;EAAiB;EAAS;CAAc;CACtD,MAAM,MAAM,SAAS;EACnB,MAAM,SAAS,UAAU;EACzB,MAAM,EAAE,SAAS,EAAE,MAAM,YAAY,MAAM;EAC3C,MAAM,UAAU,KAAK,QAAQ,OAAO,IAAI;EACxC,MAAM,OAAO,UAAU,OAAO,KAAK,MAAM,GAAG,CAAC,QAAQ,MAAM,IAAI,OAAO;EAEtE,MAAM,UAAU,OAAO;EAEvB,IAAI,SAAS,SAAS,gBACpB,MAAM,IAAI,MACR,IAAI,gBAAgB,sIACtB;EAGF,MAAM,WAAY,QAAgC;EAElD,IAAI,CAAC,UACH,MAAM,IAAI,MACR,IAAI,gBAAgB,wHACtB;EAGF,MAAM,OAAO,KAAK,QAAQ,OAAO,MAAM,OAAO,OAAO,IAAI;EACzD,MAAM,WAAW,MAAM,YAAY,QAAQ;EAE3C,WAAW;GACT,UAAU;GACV,MAAM,KAAK,QAAQ,MAAM,OAAO,QAAQ,aAAa;GACrD,SAAS,CACP,IAAI,QAAQ,aAAa;IACvB,MAAM;IACN,OAAO,CAAC,IAAI,QAAQ,WAAW,QAAQ,CAAC;GAC1C,CAAC,CACH;EACF,CAAC;EAED,OAAO;GAAE;GAAQ;GAAM,SAAS,CAAC;GAAG,UAAU,CAAC;EAAE;CACnD;AACF,CAAC"}

package/kubb-extension.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://kubb.dev/schemas/kubb-extension.json",
+  "kind": "plugin",
+  "name": "plugin-redoc",
+  "export": "pluginRedoc",
+  "displayName": "Redoc",
+  "description": "Generates a single-file HTML page from your OpenAPI spec with Redoc, rebuilt on every Kubb run so the docs match the spec your code comes from.",
+  "category": "documentation",
+  "icon": {
+    "light": "https://kubb.dev/feature/openapi.svg"
+  },
+  "tags": ["redoc", "api-docs", "documentation", "interactive-docs", "codegen", "openapi"],
+  "docs": "https://kubb.dev/plugins/plugin-redoc",
+  "compatibility": {
+    "kubb": ">=5.8.0",
+    "node": ">=22"
+  },
+  "options": [
+    {
+      "key": "outputPath",
+      "path": ["output", "path"],
+      "label": "Output Path",
+      "description": "Path of the generated HTML file. End it in .html.",
+      "type": "text",
+      "default": "docs.html"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-redoc",
-  "version": "5.0.4",
+  "version": "5.0.6",
   "description": "Generate a ReDoc API reference page with Kubb. Produces a standalone HTML file you can host without a build step.",
   "keywords": [
     "api-docs",
@@ -37,6 +37,8 @@
   ],
   "files": [
     "dist",
+    "kubb-extension.json",
+    "OVERVIEW.md",
     "!/**/**.test.**",
     "!/**/__tests__/**",
     "!/**/__snapshots__/**"
@@ -55,20 +57,21 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./kubb-extension.json": "./kubb-extension.json"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/adapter-oas": "^5.5.2"
+    "@kubb/adapter-oas": "^5.8.1"
   },
   "devDependencies": {
-    "kubb": "^5.5.2"
+    "kubb": "^5.8.1"
   },
   "peerDependencies": {
-    "kubb": "^5.5.2"
+    "kubb": "^5.8.1"
   },
   "engines": {
     "node": ">=22"
@@ -76,10 +79,7 @@
   "scripts": {
     "build": "tsdown",
     "clean": "node -e \"require('node:fs').rmSync('./dist', {recursive:true,force:true})\"",
-    "lint": "oxlint .",
-    "lint:fix": "oxlint --fix .",
     "start": "tsdown --watch",
-    "test": "vitest --passWithNoTests",
-    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
+    "typecheck": "tsc"
   }
 }