@kubb/plugin-redoc 5.0.0-alpha.8 → 5.0.0-beta.10

package/LICENSE

@@ -1,14 +1,21 @@
-Copyright (c) 2026 Stijn Van Hulle
+MIT License
 
-This repository contains software under two licenses:
+Copyright (c) 2026 Kubb Labs
 
-1. Most of the code in this repository is licensed under the
-   MIT License — see licenses/LICENSE-MIT for the full license text.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-2. The following components are licensed under the
-   GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)
-   — see licenses/LICENSE-AGPL-3.0 for the full license text:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-   - packages/agent (published as @kubb/agent)
-
-Each package's own LICENSE file or package.json specifies its applicable license.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,19 +1,19 @@
 <div align="center">
-  <h1>Plugin Redoc</h1>
+  <h1>@kubb/plugin-redoc</h1>
   <a href="https://kubb.dev" target="_blank" rel="noopener noreferrer">
     <img width="180" src="https://raw.githubusercontent.com/kubb-labs/kubb/main/assets/logo.png" alt="Kubb logo">
   </a>
 
-
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 [![Coverage][coverage-src]][coverage-href]
 [![License][license-src]][license-href]
 [![Sponsors][sponsors-src]][sponsors-href]
+
 <h4>
-<a href="https://codesandbox.io/s/github/kubb-labs/kubb/tree/main//examples/typescript" target="_blank">View Demo</a>
+<a href="https://codesandbox.io/s/github/kubb-labs/plugins/tree/main/examples/typescript" target="_blank">View Demo</a>
 <span> · </span>
-<a href="https://kubb.dev/" target="_blank">Documentation</a>
+<a href="https://kubb.dev/plugins/redoc" target="_blank">Documentation</a>
 <span> · </span>
 <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
 <span> · </span>
@@ -21,12 +21,31 @@
 </h4>
 </div>
 
-Create beautiful docs with Redoc.
+`@kubb/plugin-redoc` generates a ReDoc API reference page from your OpenAPI specification. The output is a standalone HTML file you can host without a build step or server.
+
+## Features
+
+- Produces a self-contained HTML file with the ReDoc three-panel layout
+- Supports theming and branding via ReDoc configuration options
+- Works with any valid OpenAPI 3.0 or 3.1 specification
 
+## Installation
+
+```bash
+bun add @kubb/plugin-redoc
+# or
+pnpm add @kubb/plugin-redoc
+# or
+npm install @kubb/plugin-redoc
+```
+
+## Documentation
+
+See the [full documentation](https://kubb.dev/plugins/redoc) for configuration options and examples.
 
 ## Supporting Kubb
 
-Kubb uses an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:
+Kubb is an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:
 
 - [Become a Sponsor on GitHub](https://github.com/sponsors/stijnvanhulle)
 
@@ -36,7 +55,6 @@ Kubb uses an MIT-licensed open source project with its ongoing development made
   </a>
 </p>
 
-
 <!-- Badges -->
 
 [npm-version-src]: https://img.shields.io/npm/v/@kubb/plugin-redoc?flat&colorA=18181B&colorB=f58517

package/dist/index.cjs

@@ -1,4 +1,7 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+Object.defineProperties(exports, {
+	__esModule: { value: true },
+	[Symbol.toStringTag]: { value: "Module" }
+});
 //#region \0rolldown/runtime.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -22,14 +25,35 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 }) : target, mod));
 //#endregion
 let node_path = require("node:path");
+let node_path$1 = __toESM(node_path, 1);
 node_path = __toESM(node_path);
+let _kubb_adapter_oas = require("@kubb/adapter-oas");
 let _kubb_core = require("@kubb/core");
-let _kubb_plugin_oas = require("@kubb/plugin-oas");
 let node_fs = require("node:fs");
 node_fs = __toESM(node_fs);
 let node_url = require("node:url");
 let handlebars = require("handlebars");
 handlebars = __toESM(handlebars);
+//#region ../../internals/utils/src/string.ts
+/**
+* Strips the file extension from a path or file name.
+* Only removes the last `.ext` segment when the dot is not part of a directory name.
+*
+* @example
+* trimExtName('petStore.ts')             // 'petStore'
+* trimExtName('/src/models/pet.ts')      // '/src/models/pet'
+* trimExtName('/project.v2/gen/pet.ts')  // '/project.v2/gen/pet'
+* trimExtName('noExtension')             // 'noExtension'
+*/
+function trimExtName(text) {
+	const dotIndex = text.lastIndexOf(".");
+	if (dotIndex > 0 && !text.includes("/", dotIndex)) return text.slice(0, dotIndex);
+	return text;
+}
+//#endregion
+//#region package.json
+var version = "5.0.0-beta.10";
+//#endregion
 //#region src/redoc.tsx
 const __filename$1 = (0, node_url.fileURLToPath)(require("url").pathToFileURL(__filename).href);
 const __dirname$1 = node_path.default.dirname(__filename$1);
@@ -53,38 +77,39 @@ async function getPageHTML(api, { title, disableGoogleFont, templateOptions } =
 }
 //#endregion
 //#region src/plugin.ts
-function trimExtName(text) {
-	return text.replace(/\.[^/.]+$/, "");
-}
 const pluginRedocName = "plugin-redoc";
-const pluginRedoc = (0, _kubb_core.createPlugin)((options) => {
+const pluginRedoc = (0, _kubb_core.definePlugin)((options) => {
 	const { output = { path: "docs.html" } } = options;
 	return {
 		name: pluginRedocName,
-		options: {
-			output,
-			name: trimExtName(output.path)
-		},
-		pre: [_kubb_plugin_oas.pluginOasName],
-		async install() {
-			const oas = await this.getOas();
-			await oas.dereference();
-			const root = node_path.default.resolve(this.config.root, this.config.output.path);
-			const pageHTML = await getPageHTML(oas.api);
-			await this.addFile({
+		version,
+		options,
+		hooks: { async "kubb:plugin:setup"(ctx) {
+			ctx.setOptions({
+				output,
+				name: trimExtName(output.path),
+				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$1.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: [{
+				path: node_path$1.default.resolve(root, output.path || "./docs.html"),
+				sources: [_kubb_core.ast.createSource({
 					name: "docs.html",
-					value: pageHTML
-				}],
-				imports: [],
-				exports: []
+					nodes: [_kubb_core.ast.createText(pageHTML)]
+				})]
 			});
-		}
+		} }
 	};
 });
 //#endregion
+exports.default = pluginRedoc;
 exports.pluginRedoc = pluginRedoc;
 exports.pluginRedocName = pluginRedocName;
 

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["__filename","__dirname","path","pkg","fs","pluginOasName","path"],"sources":["../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["import fs from 'node:fs'\nimport path from 'node:path'\nimport { fileURLToPath } from 'node:url'\nimport type { OasTypes } from '@kubb/oas'\nimport pkg from 'handlebars'\n\nconst __filename = fileURLToPath(import.meta.url)\nconst __dirname = path.dirname(__filename)\n\ntype BuildDocsOptions = {\n  title?: string\n  disableGoogleFont?: boolean\n  templateOptions?: any\n}\n\nexport async function getPageHTML(api: OasTypes.OASDocument, { title, disableGoogleFont, templateOptions }: BuildDocsOptions = {}) {\n  const templateFileName = path.join(__dirname, '../static/redoc.hbs')\n  const template = pkg.compile(fs.readFileSync(templateFileName).toString())\n  return template({\n    title: title || api.info.title || 'ReDoc documentation',\n    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    disableGoogleFont,\n    templateOptions,\n  })\n}\n","import path from 'node:path'\nimport { createPlugin } from '@kubb/core'\nimport { pluginOasName } from '@kubb/plugin-oas'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\nfunction trimExtName(text: string): string {\n  return text.replace(/\\.[^/.]+$/, '')\n}\n\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\nexport const pluginRedoc = createPlugin<PluginRedoc>((options) => {\n  const { output = { path: 'docs.html' } } = options\n\n  return {\n    name: pluginRedocName,\n    options: {\n      output,\n      name: trimExtName(output.path),\n    },\n    pre: [pluginOasName],\n    async install() {\n      const oas = await this.getOas()\n      await oas.dereference()\n\n      const root = path.resolve(this.config.root, this.config.output.path)\n      const pageHTML = await getPageHTML(oas.api)\n\n      await this.addFile({\n        baseName: 'docs.html',\n        path: path.resolve(root, output.path || './docs.html'),\n        sources: [\n          {\n            name: 'docs.html',\n            value: pageHTML,\n          },\n        ],\n        imports: [],\n        exports: [],\n      })\n    },\n  }\n})\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,MAAMA,gBAAAA,GAAAA,SAAAA,eAAAA,QAAAA,MAAAA,CAAAA,cAAAA,WAAAA,CAAAA,KAA2C;AACjD,MAAMC,cAAYC,UAAAA,QAAK,QAAQF,aAAW;AAQ1C,eAAsB,YAAY,KAA2B,EAAE,OAAO,mBAAmB,oBAAsC,EAAE,EAAE;CACjI,MAAM,mBAAmBE,UAAAA,QAAK,KAAKD,aAAW,sBAAsB;AAEpE,QADiBE,WAAAA,QAAI,QAAQC,QAAAA,QAAG,aAAa,iBAAiB,CAAC,UAAU,CAAC,CAC1D;EACd,OAAO,SAAS,IAAI,KAAK,SAAS;EAClC,WAAW;;;;kBAIG,KAAK,UAAU,KAAK,MAAM,EAAE,CAAC;;;;;;EAM3C;EACA;EACD,CAAC;;;;AC1BJ,SAAS,YAAY,MAAsB;AACzC,QAAO,KAAK,QAAQ,aAAa,GAAG;;AAGtC,MAAa,kBAAkB;AAE/B,MAAa,eAAA,GAAA,WAAA,eAAyC,YAAY;CAChE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,KAAK;AAE3C,QAAO;EACL,MAAM;EACN,SAAS;GACP;GACA,MAAM,YAAY,OAAO,KAAK;GAC/B;EACD,KAAK,CAACC,iBAAAA,cAAc;EACpB,MAAM,UAAU;GACd,MAAM,MAAM,MAAM,KAAK,QAAQ;AAC/B,SAAM,IAAI,aAAa;GAEvB,MAAM,OAAOC,UAAAA,QAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,KAAK;GACpE,MAAM,WAAW,MAAM,YAAY,IAAI,IAAI;AAE3C,SAAM,KAAK,QAAQ;IACjB,UAAU;IACV,MAAMA,UAAAA,QAAK,QAAQ,MAAM,OAAO,QAAQ,cAAc;IACtD,SAAS,CACP;KACE,MAAM;KACN,OAAO;KACR,CACF;IACD,SAAS,EAAE;IACX,SAAS,EAAE;IACZ,CAAC;;EAEL;EACD"}
+{"version":3,"file":"index.cjs","names":["__filename","__dirname","path","pkg","fs","adapterOasName","path","ast"],"sources":["../../../internals/utils/src/string.ts","../package.json","../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["/**\n * Strips a single matching pair of `\"...\"`, `'...'`, or `` `...` `` from both ends of `text`.\n * Returns the string unchanged when no balanced quote pair is found.\n *\n * @example\n * trimQuotes('\"hello\"') // 'hello'\n * trimQuotes('hello')   // 'hello'\n */\nexport function trimQuotes(text: string): string {\n  if (text.length >= 2) {\n    const first = text[0]\n    const last = text[text.length - 1]\n    if ((first === '\"' && last === '\"') || (first === \"'\" && last === \"'\") || (first === '`' && last === '`')) {\n      return text.slice(1, -1)\n    }\n  }\n  return text\n}\n\n/**\n * Escapes characters that are not allowed inside JS string literals.\n * Handles quotes, backslashes, and Unicode line terminators (U+2028 / U+2029).\n *\n * @see http://www.ecma-international.org/ecma-262/5.1/#sec-7.8.4\n *\n * @example\n * ```ts\n * jsStringEscape('say \"hi\"\\nbye') // 'say \\\\\"hi\\\\\"\\\\nbye'\n * ```\n */\nexport function jsStringEscape(input: unknown): string {\n  return `${input}`.replace(/[\"'\\\\\\n\\r\\u2028\\u2029]/g, (character) => {\n    switch (character) {\n      case '\"':\n      case \"'\":\n      case '\\\\':\n        return `\\\\${character}`\n      case '\\n':\n        return '\\\\n'\n      case '\\r':\n        return '\\\\r'\n      case '\\u2028':\n        return '\\\\u2028'\n      case '\\u2029':\n        return '\\\\u2029'\n      default:\n        return ''\n    }\n  })\n}\n\n/**\n * Strips the file extension from a path or file name.\n * Only removes the last `.ext` segment when the dot is not part of a directory name.\n *\n * @example\n * trimExtName('petStore.ts')             // 'petStore'\n * trimExtName('/src/models/pet.ts')      // '/src/models/pet'\n * trimExtName('/project.v2/gen/pet.ts')  // '/project.v2/gen/pet'\n * trimExtName('noExtension')             // 'noExtension'\n */\nexport function trimExtName(text: string): string {\n  const dotIndex = text.lastIndexOf('.')\n  if (dotIndex > 0 && !text.includes('/', dotIndex)) {\n    return text.slice(0, dotIndex)\n  }\n  return text\n}\n","","import fs from 'node:fs'\nimport path from 'node:path'\nimport { fileURLToPath } from 'node:url'\nimport type { AdapterOas } from '@kubb/adapter-oas'\nimport pkg from 'handlebars'\n\nconst __filename = fileURLToPath(import.meta.url)\nconst __dirname = path.dirname(__filename)\n\ntype BuildDocsOptions = {\n  title?: string\n  disableGoogleFont?: boolean\n  templateOptions?: any\n}\n\nexport async function getPageHTML(api: AdapterOas['document'], { title, disableGoogleFont, templateOptions }: BuildDocsOptions = {}) {\n  const templateFileName = path.join(__dirname, '../static/redoc.hbs')\n  const template = pkg.compile(fs.readFileSync(templateFileName).toString())\n  return template({\n    title: title || api.info.title || 'ReDoc documentation',\n    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    disableGoogleFont,\n    templateOptions,\n  })\n}\n","import path from 'node:path'\nimport { trimExtName } from '@internals/utils'\nimport type { AdapterOas } from '@kubb/adapter-oas'\nimport { adapterOasName } from '@kubb/adapter-oas'\n\nimport { type Adapter, ast, definePlugin } from '@kubb/core'\nimport { version } from '../package.json'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\nexport const pluginRedoc = definePlugin<PluginRedoc>((options) => {\n  const { output = { path: 'docs.html' } } = options\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: trimExtName(output.path),\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.createSource({\n              name: 'docs.html',\n              nodes: [ast.createText(pageHTML)],\n            }),\n          ],\n        })\n      },\n    },\n  }\n})\n\nexport default pluginRedoc\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6DA,SAAgB,YAAY,MAAsB;CAChD,MAAM,WAAW,KAAK,YAAY,IAAI;CACtC,IAAI,WAAW,KAAK,CAAC,KAAK,SAAS,KAAK,SAAS,EAC/C,OAAO,KAAK,MAAM,GAAG,SAAS;CAEhC,OAAO;;;;;;;AE5DT,MAAMA,gBAAAA,GAAAA,SAAAA,eAAAA,QAAAA,MAAAA,CAAAA,cAAAA,WAAAA,CAAAA,KAA2C;AACjD,MAAMC,cAAYC,UAAAA,QAAK,QAAQF,aAAW;AAQ1C,eAAsB,YAAY,KAA6B,EAAE,OAAO,mBAAmB,oBAAsC,EAAE,EAAE;CACnI,MAAM,mBAAmBE,UAAAA,QAAK,KAAKD,aAAW,sBAAsB;CAEpE,OADiBE,WAAAA,QAAI,QAAQC,QAAAA,QAAG,aAAa,iBAAiB,CAAC,UAAU,CAC1D,CAAC;EACd,OAAO,SAAS,IAAI,KAAK,SAAS;EAClC,WAAW;;;;kBAIG,KAAK,UAAU,KAAK,MAAM,EAAE,CAAC;;;;;;EAM3C;EACA;EACD,CAAC;;;;ACtBJ,MAAa,kBAAkB;AAE/B,MAAa,eAAA,GAAA,WAAA,eAAyC,YAAY;CAChE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,KAAK;CAE3C,OAAO;EACL,MAAM;EACN;EACA;EACA,OAAO,EACL,MAAM,oBAAoB,KAAK;GAC7B,IAAI,WAAW;IACb;IACA,MAAM,YAAY,OAAO,KAAK;IAC9B,SAAS,EAAE;IACX,UAAU,EAAE;IACb,CAAC;GAEF,MAAM,UAAU,IAAI,OAAO;GAE3B,IAAI,SAAS,SAASC,kBAAAA,gBACpB,MAAM,IAAI,MACR,IAAI,gBAAgB,uIACrB;GAGH,MAAM,WAAY,QAAgC;GAElD,IAAI,CAAC,UACH,MAAM,IAAI,MACR,IAAI,gBAAgB,yHACrB;GAGH,MAAM,OAAOC,YAAAA,QAAK,QAAQ,IAAI,OAAO,MAAM,IAAI,OAAO,OAAO,KAAK;GAClE,MAAM,WAAW,MAAM,YAAY,SAAS;GAE5C,IAAI,WAAW;IACb,UAAU;IACV,MAAMA,YAAAA,QAAK,QAAQ,MAAM,OAAO,QAAQ,cAAc;IACtD,SAAS,CACPC,WAAAA,IAAI,aAAa;KACf,MAAM;KACN,OAAO,CAACA,WAAAA,IAAI,WAAW,SAAS,CAAC;KAClC,CAAC,CACH;IACF,CAAC;KAEL;EACF;EACD"}

package/dist/index.d.ts

@@ -1,26 +1,37 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import * as _kubb_core0 from "@kubb/core";
-import { Output, PluginFactoryOptions } from "@kubb/core";
-import { Oas } from "@kubb/oas";
+import * as _$_kubb_core0 from "@kubb/core";
+import { Exclude, Include, Output, Override, PluginFactoryOptions } from "@kubb/core";
 
 //#region src/types.d.ts
 type Options = {
   output?: {
     /**
-     * Output for the generated doc, [https://redocly.com/](https://redocly.com/) is being used for the generation
+     * Output path for the generated HTML documentation.
+     *
      * @default 'docs.html'
      */
     path: string;
   };
 };
 type ResolveOptions = {
-  output: Output<Oas>;
+  output: Output<never>;
+  name: string;
+  exclude: Array<Exclude>;
+  include?: Array<Include>;
+  override: Array<Override<ResolveOptions>>;
 };
-type PluginRedoc = PluginFactoryOptions<'plugin-redoc', Options, ResolveOptions, never>;
+type PluginRedoc = PluginFactoryOptions<'plugin-redoc', Options, ResolveOptions>;
+declare global {
+  namespace Kubb {
+    interface PluginRegistry {
+      'plugin-redoc': PluginRedoc;
+    }
+  }
+}
 //#endregion
 //#region src/plugin.d.ts
 declare const pluginRedocName = "plugin-redoc";
-declare const pluginRedoc: (options?: Options | undefined) => _kubb_core0.UserPluginWithLifeCycle<PluginRedoc>;
+declare const pluginRedoc: (options?: Options | undefined) => _$_kubb_core0.Plugin<PluginRedoc>;
 //#endregion
-export { type PluginRedoc, pluginRedoc, pluginRedocName };
+export { type PluginRedoc, pluginRedoc as default, pluginRedoc, pluginRedocName };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,10 +1,30 @@
 import "./chunk--u3MIqq1.js";
 import path from "node:path";
-import { createPlugin } from "@kubb/core";
-import { pluginOasName } from "@kubb/plugin-oas";
+import { adapterOasName } from "@kubb/adapter-oas";
+import { ast, definePlugin } from "@kubb/core";
 import fs from "node:fs";
 import { fileURLToPath } from "node:url";
 import pkg from "handlebars";
+//#region ../../internals/utils/src/string.ts
+/**
+* Strips the file extension from a path or file name.
+* Only removes the last `.ext` segment when the dot is not part of a directory name.
+*
+* @example
+* trimExtName('petStore.ts')             // 'petStore'
+* trimExtName('/src/models/pet.ts')      // '/src/models/pet'
+* trimExtName('/project.v2/gen/pet.ts')  // '/project.v2/gen/pet'
+* trimExtName('noExtension')             // 'noExtension'
+*/
+function trimExtName(text) {
+	const dotIndex = text.lastIndexOf(".");
+	if (dotIndex > 0 && !text.includes("/", dotIndex)) return text.slice(0, dotIndex);
+	return text;
+}
+//#endregion
+//#region package.json
+var version = "5.0.0-beta.10";
+//#endregion
 //#region src/redoc.tsx
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -28,38 +48,38 @@ async function getPageHTML(api, { title, disableGoogleFont, templateOptions } =
 }
 //#endregion
 //#region src/plugin.ts
-function trimExtName(text) {
-	return text.replace(/\.[^/.]+$/, "");
-}
 const pluginRedocName = "plugin-redoc";
-const pluginRedoc = createPlugin((options) => {
+const pluginRedoc = definePlugin((options) => {
 	const { output = { path: "docs.html" } } = options;
 	return {
 		name: pluginRedocName,
-		options: {
-			output,
-			name: trimExtName(output.path)
-		},
-		pre: [pluginOasName],
-		async install() {
-			const oas = await this.getOas();
-			await oas.dereference();
-			const root = path.resolve(this.config.root, this.config.output.path);
-			const pageHTML = await getPageHTML(oas.api);
-			await this.addFile({
+		version,
+		options,
+		hooks: { async "kubb:plugin:setup"(ctx) {
+			ctx.setOptions({
+				output,
+				name: trimExtName(output.path),
+				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: [{
+				sources: [ast.createSource({
 					name: "docs.html",
-					value: pageHTML
-				}],
-				imports: [],
-				exports: []
+					nodes: [ast.createText(pageHTML)]
+				})]
 			});
-		}
+		} }
 	};
 });
 //#endregion
-export { pluginRedoc, pluginRedocName };
+export { pluginRedoc as default, pluginRedoc, pluginRedocName };
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["import fs from 'node:fs'\nimport path from 'node:path'\nimport { fileURLToPath } from 'node:url'\nimport type { OasTypes } from '@kubb/oas'\nimport pkg from 'handlebars'\n\nconst __filename = fileURLToPath(import.meta.url)\nconst __dirname = path.dirname(__filename)\n\ntype BuildDocsOptions = {\n  title?: string\n  disableGoogleFont?: boolean\n  templateOptions?: any\n}\n\nexport async function getPageHTML(api: OasTypes.OASDocument, { title, disableGoogleFont, templateOptions }: BuildDocsOptions = {}) {\n  const templateFileName = path.join(__dirname, '../static/redoc.hbs')\n  const template = pkg.compile(fs.readFileSync(templateFileName).toString())\n  return template({\n    title: title || api.info.title || 'ReDoc documentation',\n    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    disableGoogleFont,\n    templateOptions,\n  })\n}\n","import path from 'node:path'\nimport { createPlugin } from '@kubb/core'\nimport { pluginOasName } from '@kubb/plugin-oas'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\nfunction trimExtName(text: string): string {\n  return text.replace(/\\.[^/.]+$/, '')\n}\n\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\nexport const pluginRedoc = createPlugin<PluginRedoc>((options) => {\n  const { output = { path: 'docs.html' } } = options\n\n  return {\n    name: pluginRedocName,\n    options: {\n      output,\n      name: trimExtName(output.path),\n    },\n    pre: [pluginOasName],\n    async install() {\n      const oas = await this.getOas()\n      await oas.dereference()\n\n      const root = path.resolve(this.config.root, this.config.output.path)\n      const pageHTML = await getPageHTML(oas.api)\n\n      await this.addFile({\n        baseName: 'docs.html',\n        path: path.resolve(root, output.path || './docs.html'),\n        sources: [\n          {\n            name: 'docs.html',\n            value: pageHTML,\n          },\n        ],\n        imports: [],\n        exports: [],\n      })\n    },\n  }\n})\n"],"mappings":";;;;;;;;AAMA,MAAM,aAAa,cAAc,OAAO,KAAK,IAAI;AACjD,MAAM,YAAY,KAAK,QAAQ,WAAW;AAQ1C,eAAsB,YAAY,KAA2B,EAAE,OAAO,mBAAmB,oBAAsC,EAAE,EAAE;CACjI,MAAM,mBAAmB,KAAK,KAAK,WAAW,sBAAsB;AAEpE,QADiB,IAAI,QAAQ,GAAG,aAAa,iBAAiB,CAAC,UAAU,CAAC,CAC1D;EACd,OAAO,SAAS,IAAI,KAAK,SAAS;EAClC,WAAW;;;;kBAIG,KAAK,UAAU,KAAK,MAAM,EAAE,CAAC;;;;;;EAM3C;EACA;EACD,CAAC;;;;AC1BJ,SAAS,YAAY,MAAsB;AACzC,QAAO,KAAK,QAAQ,aAAa,GAAG;;AAGtC,MAAa,kBAAkB;AAE/B,MAAa,cAAc,cAA2B,YAAY;CAChE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,KAAK;AAE3C,QAAO;EACL,MAAM;EACN,SAAS;GACP;GACA,MAAM,YAAY,OAAO,KAAK;GAC/B;EACD,KAAK,CAAC,cAAc;EACpB,MAAM,UAAU;GACd,MAAM,MAAM,MAAM,KAAK,QAAQ;AAC/B,SAAM,IAAI,aAAa;GAEvB,MAAM,OAAO,KAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,KAAK;GACpE,MAAM,WAAW,MAAM,YAAY,IAAI,IAAI;AAE3C,SAAM,KAAK,QAAQ;IACjB,UAAU;IACV,MAAM,KAAK,QAAQ,MAAM,OAAO,QAAQ,cAAc;IACtD,SAAS,CACP;KACE,MAAM;KACN,OAAO;KACR,CACF;IACD,SAAS,EAAE;IACX,SAAS,EAAE;IACZ,CAAC;;EAEL;EACD"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../internals/utils/src/string.ts","../package.json","../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["/**\n * Strips a single matching pair of `\"...\"`, `'...'`, or `` `...` `` from both ends of `text`.\n * Returns the string unchanged when no balanced quote pair is found.\n *\n * @example\n * trimQuotes('\"hello\"') // 'hello'\n * trimQuotes('hello')   // 'hello'\n */\nexport function trimQuotes(text: string): string {\n  if (text.length >= 2) {\n    const first = text[0]\n    const last = text[text.length - 1]\n    if ((first === '\"' && last === '\"') || (first === \"'\" && last === \"'\") || (first === '`' && last === '`')) {\n      return text.slice(1, -1)\n    }\n  }\n  return text\n}\n\n/**\n * Escapes characters that are not allowed inside JS string literals.\n * Handles quotes, backslashes, and Unicode line terminators (U+2028 / U+2029).\n *\n * @see http://www.ecma-international.org/ecma-262/5.1/#sec-7.8.4\n *\n * @example\n * ```ts\n * jsStringEscape('say \"hi\"\\nbye') // 'say \\\\\"hi\\\\\"\\\\nbye'\n * ```\n */\nexport function jsStringEscape(input: unknown): string {\n  return `${input}`.replace(/[\"'\\\\\\n\\r\\u2028\\u2029]/g, (character) => {\n    switch (character) {\n      case '\"':\n      case \"'\":\n      case '\\\\':\n        return `\\\\${character}`\n      case '\\n':\n        return '\\\\n'\n      case '\\r':\n        return '\\\\r'\n      case '\\u2028':\n        return '\\\\u2028'\n      case '\\u2029':\n        return '\\\\u2029'\n      default:\n        return ''\n    }\n  })\n}\n\n/**\n * Strips the file extension from a path or file name.\n * Only removes the last `.ext` segment when the dot is not part of a directory name.\n *\n * @example\n * trimExtName('petStore.ts')             // 'petStore'\n * trimExtName('/src/models/pet.ts')      // '/src/models/pet'\n * trimExtName('/project.v2/gen/pet.ts')  // '/project.v2/gen/pet'\n * trimExtName('noExtension')             // 'noExtension'\n */\nexport function trimExtName(text: string): string {\n  const dotIndex = text.lastIndexOf('.')\n  if (dotIndex > 0 && !text.includes('/', dotIndex)) {\n    return text.slice(0, dotIndex)\n  }\n  return text\n}\n","","import fs from 'node:fs'\nimport path from 'node:path'\nimport { fileURLToPath } from 'node:url'\nimport type { AdapterOas } from '@kubb/adapter-oas'\nimport pkg from 'handlebars'\n\nconst __filename = fileURLToPath(import.meta.url)\nconst __dirname = path.dirname(__filename)\n\ntype BuildDocsOptions = {\n  title?: string\n  disableGoogleFont?: boolean\n  templateOptions?: any\n}\n\nexport async function getPageHTML(api: AdapterOas['document'], { title, disableGoogleFont, templateOptions }: BuildDocsOptions = {}) {\n  const templateFileName = path.join(__dirname, '../static/redoc.hbs')\n  const template = pkg.compile(fs.readFileSync(templateFileName).toString())\n  return template({\n    title: title || api.info.title || 'ReDoc documentation',\n    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    disableGoogleFont,\n    templateOptions,\n  })\n}\n","import path from 'node:path'\nimport { trimExtName } from '@internals/utils'\nimport type { AdapterOas } from '@kubb/adapter-oas'\nimport { adapterOasName } from '@kubb/adapter-oas'\n\nimport { type Adapter, ast, definePlugin } from '@kubb/core'\nimport { version } from '../package.json'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\nexport const pluginRedoc = definePlugin<PluginRedoc>((options) => {\n  const { output = { path: 'docs.html' } } = options\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: trimExtName(output.path),\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.createSource({\n              name: 'docs.html',\n              nodes: [ast.createText(pageHTML)],\n            }),\n          ],\n        })\n      },\n    },\n  }\n})\n\nexport default pluginRedoc\n"],"mappings":";;;;;;;;;;;;;;;;;;AA6DA,SAAgB,YAAY,MAAsB;CAChD,MAAM,WAAW,KAAK,YAAY,IAAI;CACtC,IAAI,WAAW,KAAK,CAAC,KAAK,SAAS,KAAK,SAAS,EAC/C,OAAO,KAAK,MAAM,GAAG,SAAS;CAEhC,OAAO;;;;;;;AE5DT,MAAM,aAAa,cAAc,OAAO,KAAK,IAAI;AACjD,MAAM,YAAY,KAAK,QAAQ,WAAW;AAQ1C,eAAsB,YAAY,KAA6B,EAAE,OAAO,mBAAmB,oBAAsC,EAAE,EAAE;CACnI,MAAM,mBAAmB,KAAK,KAAK,WAAW,sBAAsB;CAEpE,OADiB,IAAI,QAAQ,GAAG,aAAa,iBAAiB,CAAC,UAAU,CAC1D,CAAC;EACd,OAAO,SAAS,IAAI,KAAK,SAAS;EAClC,WAAW;;;;kBAIG,KAAK,UAAU,KAAK,MAAM,EAAE,CAAC;;;;;;EAM3C;EACA;EACD,CAAC;;;;ACtBJ,MAAa,kBAAkB;AAE/B,MAAa,cAAc,cAA2B,YAAY;CAChE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,KAAK;CAE3C,OAAO;EACL,MAAM;EACN;EACA;EACA,OAAO,EACL,MAAM,oBAAoB,KAAK;GAC7B,IAAI,WAAW;IACb;IACA,MAAM,YAAY,OAAO,KAAK;IAC9B,SAAS,EAAE;IACX,UAAU,EAAE;IACb,CAAC;GAEF,MAAM,UAAU,IAAI,OAAO;GAE3B,IAAI,SAAS,SAAS,gBACpB,MAAM,IAAI,MACR,IAAI,gBAAgB,uIACrB;GAGH,MAAM,WAAY,QAAgC;GAElD,IAAI,CAAC,UACH,MAAM,IAAI,MACR,IAAI,gBAAgB,yHACrB;GAGH,MAAM,OAAO,KAAK,QAAQ,IAAI,OAAO,MAAM,IAAI,OAAO,OAAO,KAAK;GAClE,MAAM,WAAW,MAAM,YAAY,SAAS;GAE5C,IAAI,WAAW;IACb,UAAU;IACV,MAAM,KAAK,QAAQ,MAAM,OAAO,QAAQ,cAAc;IACtD,SAAS,CACP,IAAI,aAAa;KACf,MAAM;KACN,OAAO,CAAC,IAAI,WAAW,SAAS,CAAC;KAClC,CAAC,CACH;IACF,CAAC;KAEL;EACF;EACD"}

package/extension.yaml

@@ -0,0 +1,67 @@
+$schema: https://kubb.dev/schemas/extension.json
+kind: plugin
+id: plugin-redoc
+name: Redoc
+description: Generate API documentation with Redoc from OpenAPI specifications.
+category: documentation
+type: official
+npmPackage: '@kubb/plugin-redoc'
+docsPath: /plugins/plugin-redoc
+repo: https://github.com/kubb-labs/plugins
+maintainers:
+  - name: Stijn Van Hulle
+    github: stijnvanhulle
+compatibility:
+  kubb: '>=5.0.0'
+  node: '>=22'
+tags:
+  - redoc
+  - api-docs
+  - documentation
+  - interactive-docs
+  - codegen
+  - openapi
+dependencies: []
+resources:
+  documentation: https://kubb.dev/plugins/plugin-redoc
+  repository: https://github.com/kubb-labs/plugins
+  issues: https://github.com/kubb-labs/plugins/issues
+  changelog: https://github.com/kubb-labs/plugins/blob/main/packages/plugin-redoc/CHANGELOG.md
+  codesandbox: https://codesandbox.io/p/github/kubb-labs/plugins/main/examples/simple-single
+featured: false
+icon:
+  light: https://kubb.dev/feature/openapi.svg
+intro: |
+  Generate interactive API documentation from your OpenAPI schema using [Redoc](https://redocly.com/).
+options:
+  - name: output
+    type: '{ path: string }'
+    required: false
+    description: Specify the output path for the generated documentation HTML file.
+    properties:
+      - name: path
+        type: string
+        required: true
+        description: |
+          The output file path for the generated documentation HTML.
+        tip: |
+          if `output.path` is a file, `group` cannot be used.
+        default: "'docs.html'"
+examples:
+  - name: kubb.config.ts
+    files:
+      - lang: typescript
+        code: |
+          import { defineConfig } from 'kubb'
+          import { pluginRedoc } from '@kubb/plugin-redoc'
+
+          export default defineConfig({
+            input: { path: './petStore.yaml' },
+            output: { path: './src/gen' },
+            plugins: [
+              pluginRedoc({
+                output: { path: 'docs.html' },
+              }),
+            ],
+          })
+        twoslash: false

package/package.json

@@ -1,29 +1,43 @@
 {
   "name": "@kubb/plugin-redoc",
-  "version": "5.0.0-alpha.8",
-  "description": "Redoc documentation generator plugin for Kubb, creating beautiful, interactive API documentation from OpenAPI specifications.",
+  "version": "5.0.0-beta.10",
+  "description": "Generate a beautiful, interactive ReDoc API reference page from your OpenAPI specification. Produces a standalone HTML file with a responsive, developer-friendly UI.",
   "keywords": [
-    "redoc",
-    "documentation",
     "api-docs",
+    "api-reference",
+    "code-generation",
+    "codegen",
+    "documentation",
+    "kubb",
     "openapi",
+    "redoc",
     "swagger",
-    "interactive-docs",
-    "typescript",
-    "code-generator",
-    "codegen",
-    "plugins",
-    "kubb"
+    "typescript"
   ],
+  "license": "MIT",
+  "author": "stijnvanhulle",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/kubb-labs/kubb.git",
+    "url": "git+https://github.com/kubb-labs/plugins.git",
     "directory": "packages/plugin-redoc"
   },
-  "license": "MIT",
-  "author": "stijnvanhulle",
-  "sideEffects": false,
+  "files": [
+    "src",
+    "dist",
+    "static",
+    "extension.yaml",
+    "!/**/**.test.**",
+    "!/**/__tests__/**",
+    "!/**/__snapshots__/**"
+  ],
   "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {}
+  },
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -31,18 +45,18 @@
     },
     "./package.json": "./package.json"
   },
-  "types": "./dist/index.d.ts",
-  "typesVersions": {
-    "*": {}
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@kubb/adapter-oas": "5.0.0-beta.10",
+    "@kubb/core": "5.0.0-beta.10",
+    "handlebars": "^4.7.9"
+  },
+  "devDependencies": {
+    "@internals/utils": "0.0.0"
   },
-  "files": [
-    "src",
-    "dist",
-    "static",
-    "!/**/**.test.**",
-    "!/**/__tests__/**",
-    "!/**/__snapshots__/**"
-  ],
   "size-limit": [
     {
       "path": "./dist/*.js",
@@ -50,32 +64,14 @@
       "gzip": true
     }
   ],
-  "dependencies": {
-    "@kubb/fabric-core": "0.14.0",
-    "@kubb/react-fabric": "0.14.0",
-    "handlebars": "^4.7.8",
-    "@kubb/core": "5.0.0-alpha.8",
-    "@kubb/plugin-oas": "5.0.0-alpha.8",
-    "@kubb/oas": "5.0.0-alpha.8"
-  },
-  "peerDependencies": {
-    "@kubb/fabric-core": "0.14.0",
-    "@kubb/react-fabric": "0.14.0"
-  },
   "engines": {
     "node": ">=22"
   },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
   "scripts": {
     "build": "tsdown && size-limit",
     "clean": "npx rimraf ./dist",
-    "lint": "bun biome lint .",
-    "lint:fix": "bun biome lint --fix --unsafe .",
+    "lint": "oxlint .",
+    "lint:fix": "oxlint --fix .",
     "release": "pnpm publish --no-git-check",
     "release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
     "start": "tsdown --watch",

package/src/index.ts

@@ -1,2 +1,2 @@
-export { pluginRedoc, pluginRedocName } from './plugin.ts'
+export { default, pluginRedoc, pluginRedocName } from './plugin.ts'
 export type { PluginRedoc } from './types.ts'

package/src/plugin.ts

@@ -1,44 +1,63 @@
 import path from 'node:path'
-import { createPlugin } from '@kubb/core'
-import { pluginOasName } from '@kubb/plugin-oas'
+import { trimExtName } from '@internals/utils'
+import type { AdapterOas } from '@kubb/adapter-oas'
+import { adapterOasName } from '@kubb/adapter-oas'
+
+import { type Adapter, ast, definePlugin } from '@kubb/core'
+import { version } from '../package.json'
 import { getPageHTML } from './redoc.tsx'
 import type { PluginRedoc } from './types.ts'
 
-function trimExtName(text: string): string {
-  return text.replace(/\.[^/.]+$/, '')
-}
-
 export const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']
 
-export const pluginRedoc = createPlugin<PluginRedoc>((options) => {
+export const pluginRedoc = definePlugin<PluginRedoc>((options) => {
   const { output = { path: 'docs.html' } } = options
 
   return {
     name: pluginRedocName,
-    options: {
-      output,
-      name: trimExtName(output.path),
-    },
-    pre: [pluginOasName],
-    async install() {
-      const oas = await this.getOas()
-      await oas.dereference()
-
-      const root = path.resolve(this.config.root, this.config.output.path)
-      const pageHTML = await getPageHTML(oas.api)
-
-      await this.addFile({
-        baseName: 'docs.html',
-        path: path.resolve(root, output.path || './docs.html'),
-        sources: [
-          {
-            name: 'docs.html',
-            value: pageHTML,
-          },
-        ],
-        imports: [],
-        exports: [],
-      })
+    version,
+    options,
+    hooks: {
+      async 'kubb:plugin:setup'(ctx) {
+        ctx.setOptions({
+          output,
+          name: trimExtName(output.path),
+          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 as Adapter<AdapterOas>).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.createSource({
+              name: 'docs.html',
+              nodes: [ast.createText(pageHTML)],
+            }),
+          ],
+        })
+      },
     },
   }
 })
+
+export default pluginRedoc

package/src/redoc.tsx

@@ -1,7 +1,7 @@
 import fs from 'node:fs'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
-import type { OasTypes } from '@kubb/oas'
+import type { AdapterOas } from '@kubb/adapter-oas'
 import pkg from 'handlebars'
 
 const __filename = fileURLToPath(import.meta.url)
@@ -13,7 +13,7 @@ type BuildDocsOptions = {
   templateOptions?: any
 }
 
-export async function getPageHTML(api: OasTypes.OASDocument, { title, disableGoogleFont, templateOptions }: BuildDocsOptions = {}) {
+export async function getPageHTML(api: AdapterOas['document'], { title, disableGoogleFont, templateOptions }: BuildDocsOptions = {}) {
   const templateFileName = path.join(__dirname, '../static/redoc.hbs')
   const template = pkg.compile(fs.readFileSync(templateFileName).toString())
   return template({

package/src/types.ts

@@ -1,10 +1,10 @@
-import type { Output, PluginFactoryOptions } from '@kubb/core'
-import type { Oas } from '@kubb/oas'
+import type { Exclude, Include, Output, Override, PluginFactoryOptions } from '@kubb/core'
 
 export type Options = {
   output?: {
     /**
-     * Output for the generated doc, [https://redocly.com/](https://redocly.com/) is being used for the generation
+     * Output path for the generated HTML documentation.
+     *
      * @default 'docs.html'
      */
     path: string
@@ -12,7 +12,19 @@ export type Options = {
 }
 
 type ResolveOptions = {
-  output: Output<Oas>
+  output: Output<never>
+  name: string
+  exclude: Array<Exclude>
+  include?: Array<Include>
+  override: Array<Override<ResolveOptions>>
 }
 
-export type PluginRedoc = PluginFactoryOptions<'plugin-redoc', Options, ResolveOptions, never>
+export type PluginRedoc = PluginFactoryOptions<'plugin-redoc', Options, ResolveOptions>
+
+declare global {
+  namespace Kubb {
+    interface PluginRegistry {
+      'plugin-redoc': PluginRedoc
+    }
+  }
+}

package/static/redoc.hbs

@@ -1,22 +1,21 @@
-<!DOCTYPE html>
 <html>
 
-<head>
-  <meta charset="utf8" />
-  <title>{{title}}</title>
-  <!-- needed for adaptive design -->
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <style>
-    body {
-      padding: 0;
-      margin: 0;
-    }
-  </style>
-  {{#unless disableGoogleFont}}<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">{{/unless}}
-</head>
+  <head>
+    <meta charset='utf8' />
+    <title>{{title}}</title>
+    <!-- needed for adaptive design -->
+    <meta name='viewport' content='width=device-width, initial-scale=1' />
+    <style>
+      body {
+        padding: 0;
+        margin: 0;
+      }
+    </style>
+    {{#unless disableGoogleFont}}<link href='https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700' rel='stylesheet' />{{/unless}}
+  </head>
 
-<body>
-  {{{redocHTML}}}
-</body>
+  <body>
+    {{{redocHTML}}}
+  </body>
 
-</html>
+</html>