@kubb/plugin-redoc 0.0.0-canary-20240509211223

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Stijn Van Hulle
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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

@@ -0,0 +1,44 @@
+<div align="center">
+
+<!-- <img src="assets/logo.png" alt="logo" width="200" height="auto" /> -->
+<h1>@kubb/plugin-redoc</h1>
+
+<p>
+   Create beautiful docs with Redoc.
+  </p>
+  <img src="https://raw.githubusercontent.com/kubb-labs/kubb/main/assets/banner.png" alt="logo"  height="auto" />
+
+[![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]
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+</p>
+
+<h4>
+    <a href="https://codesandbox.io/s/github/kubb-labs/kubb/tree/alpha/examples/typescript" target="_blank">View Demo</a>
+    <span> · </span>
+      <a href="https://kubb.dev/" target="_blank">Documentation</a>
+    <span> · </span>
+      <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
+    <span> · </span>
+      <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Request Feature</a>
+  </h4>
+</div>
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@kubb/plugin-redoc?flat&colorA=18181B&colorB=f58517
+[npm-version-href]: https://npmjs.com/package/@kubb/plugin-redoc
+[npm-downloads-src]: https://img.shields.io/npm/dm/@kubb/plugin-redoc?flat&colorA=18181B&colorB=f58517
+[npm-downloads-href]: https://npmjs.com/package/@kubb/plugin-redoc
+[license-src]: https://img.shields.io/github/license/kubb-labs/kubb.svg?flat&colorA=18181B&colorB=f58517
+[license-href]: https://github.com/kubb-labs/kubb/blob/main/LICENSE
+[build-src]: https://img.shields.io/github/actions/workflow/status/kubb-labs/kubb/ci.yaml?style=flat&colorA=18181B&colorB=f58517
+[build-href]: https://www.npmjs.com/package/@kubb/plugin-redoc
+[minified-src]: https://img.shields.io/bundlephobia/min/@kubb/plugin-redoc?style=flat&colorA=18181B&colorB=f58517
+[minified-href]: https://www.npmjs.com/package/@kubb/plugin-redoc
+[coverage-src]: https://img.shields.io/codecov/c/github/kubb-labs/kubb?style=flat&colorA=18181B&colorB=f58517
+[coverage-href]: https://www.npmjs.com/package/@kubb/plugin-redoc

package/dist/index.cjs

@@ -0,0 +1,106 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined")
+    return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// src/plugin.ts
+var _path = require('path'); var _path2 = _interopRequireDefault(_path);
+var _core = require('@kubb/core');
+var _transformers = require('@kubb/core/transformers');
+var _pluginoas = require('@kubb/plugin-oas');
+
+// src/redoc.tsx
+var _fs = require('fs'); var _fs2 = _interopRequireDefault(_fs);
+
+var _handlebars = require('handlebars'); var _handlebars2 = _interopRequireDefault(_handlebars);
+var _server = require('react-dom/server');
+var _styledcomponents = require('styled-components');
+var _redoc = require('redoc'); var _redoc2 = _interopRequireDefault(_redoc);
+var _jsxruntime = require('react/jsx-runtime');
+function escapeClosingScriptTag(str) {
+  return str.replace(/<\/script>/g, "<\\/script>");
+}
+function escapeUnicode(str) {
+  return str.replace(/\u2028|\u2029/g, (m) => "\\u202" + (m === "\u2028" ? "8" : "9"));
+}
+function sanitizeJSONString(str) {
+  return escapeClosingScriptTag(escapeUnicode(str));
+}
+async function getPageHTML(api, { title, disableGoogleFont, templateOptions, redocOptions = {} } = {}) {
+  const apiUrl = redocOptions.specUrl;
+  const { Redoc, createStore } = _redoc2.default || __require("redoc");
+  const store = await createStore(api, apiUrl, redocOptions);
+  const sheet = new (0, _styledcomponents.ServerStyleSheet)();
+  const error = console.error;
+  console.error = (...args) => {
+    if (/defaultProps/.test(args[0]))
+      return;
+    error(...args);
+  };
+  const html = _server.renderToString.call(void 0, sheet.collectStyles(/* @__PURE__ */ _jsxruntime.jsx.call(void 0, Redoc, { store })));
+  const state = await store.toJS();
+  const css = sheet.getStyleTags();
+  const templateFileName = _path2.default.join(__dirname, "../static/redoc.hbs");
+  const template = _handlebars2.default.compile(_fs2.default.readFileSync(templateFileName).toString());
+  return template({
+    redocHTML: `
+      <div id="redoc">${html || ""}</div>
+      <script>
+      ${`const __redoc_state = ${sanitizeJSONString(JSON.stringify(state))};` || ""}
+
+      var container = document.getElementById('redoc');
+      Redoc.${"hydrate(__redoc_state, container)"};
+
+      </script>`,
+    redocHead: (
+      // biome-ignore lint/style/useTemplate: <explanation>
+      `<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>` + css
+    ),
+    title: title || api.info.title || "ReDoc documentation",
+    disableGoogleFont,
+    templateOptions
+  });
+}
+
+// src/plugin.ts
+var pluginRedocName = "plugin-redoc";
+var pluginRedoc = _core.createPlugin.call(void 0, (options) => {
+  const { output = { path: "docs.html" } } = options;
+  return {
+    name: pluginRedocName,
+    options: {
+      name: _transformers.trimExtName.call(void 0, output.path),
+      baseURL: void 0
+    },
+    pre: [_pluginoas.pluginOasName],
+    resolvePath(baseName) {
+      const root = _path2.default.resolve(this.config.root, this.config.output.path);
+      return _path2.default.resolve(root, baseName);
+    },
+    resolveName(name, type) {
+      return _transformers.camelCase.call(void 0, name, { isFile: type === "file" });
+    },
+    async writeFile(source, writePath) {
+      if (!writePath.endsWith(".ts") || !source) {
+        return;
+      }
+      return this.fileManager.write(source, writePath, { sanity: false });
+    },
+    async buildStart() {
+      const [swaggerPlugin] = _core.PluginManager.getDependedPlugins(this.plugins, [_pluginoas.pluginOasName]);
+      const oas = await swaggerPlugin.api.getOas();
+      await oas.dereference();
+      const root = _path2.default.resolve(this.config.root, this.config.output.path);
+      const pageHTML = await getPageHTML(oas.api);
+      await this.fileManager.write(pageHTML, _path2.default.resolve(root, output.path || "./docs.html"));
+    }
+  };
+});
+
+
+
+exports.pluginRedoc = pluginRedoc; exports.pluginRedocName = pluginRedocName;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin.ts","../src/redoc.tsx"],"names":["path"],"mappings":";;;;;;;;;AAAA,OAAOA,WAAU;AAEjB,SAAS,eAAe,oBAAoB;AAC5C,SAAS,WAAW,mBAAmB;AACvC,SAAS,qBAAqB;;;ACJ9B,OAAO,QAAQ;AACf,OAAO,UAAU;AAEjB,OAAO,SAAS;AAChB,SAAS,sBAAsB;AAC/B,SAAS,wBAAwB;AACjC,OAAO,WAAW;AAoCgC;AA1BlD,SAAS,uBAAuB,KAAqB;AACnD,SAAO,IAAI,QAAQ,eAAe,aAAa;AACjD;AAGA,SAAS,cAAc,KAAqB;AAE1C,SAAO,IAAI,QAAQ,kBAAkB,CAAC,MAAM,YAAY,MAAM,WAAW,MAAM,IAAI;AACrF;AAEA,SAAS,mBAAmB,KAAqB;AAC/C,SAAO,uBAAuB,cAAc,GAAG,CAAC;AAClD;AAEA,eAAsB,YAAY,KAA2B,EAAE,OAAO,mBAAmB,iBAAiB,eAAe,CAAC,EAAE,IAAsB,CAAC,GAAG;AACpJ,QAAM,SAAS,aAAa;AAC5B,QAAM,EAAE,OAAO,YAAY,IAAI,SAAS,UAAQ,OAAO;AACvD,QAAM,QAAQ,MAAM,YAAY,KAAK,QAAQ,YAAY;AACzD,QAAM,QAAQ,IAAI,iBAAiB;AAEnC,QAAM,QAAQ,QAAQ;AACtB,UAAQ,QAAQ,IAAI,SAAc;AAChC,QAAI,eAAe,KAAK,KAAK,CAAC,CAAC;AAAG;AAClC,UAAM,GAAG,IAAI;AAAA,EACf;AAEA,QAAM,OAAO,eAAe,MAAM,cAAc,oBAAC,SAAM,OAAc,CAAE,CAAC;AACxE,QAAM,QAAQ,MAAM,MAAM,KAAK;AAC/B,QAAM,MAAM,MAAM,aAAa;AAE/B,QAAM,mBAAmB,KAAK,KAAK,WAAW,qBAAqB;AACnE,QAAM,WAAW,IAAI,QAAQ,GAAG,aAAa,gBAAgB,EAAE,SAAS,CAAC;AACzE,SAAO,SAAS;AAAA,IACd,WAAW;AAAA,wBACS,QAAQ,EAAE;AAAA;AAAA,QAE1B,yBAAyB,mBAAmB,KAAK,UAAU,KAAK,CAAC,CAAC,OAAO,EAAE;AAAA;AAAA;AAAA,cAGrE,mCAAmC;AAAA;AAAA;AAAA,IAG7C;AAAA;AAAA,MAEE,0FAA0F;AAAA;AAAA,IAC5F,OAAO,SAAS,IAAI,KAAK,SAAS;AAAA,IAClC;AAAA,IACA;AAAA,EACF,CAAC;AACH;;;ADtDO,IAAM,kBAAkB;AAExB,IAAM,cAAc,aAA0B,CAAC,YAAY;AAChE,QAAM,EAAE,SAAS,EAAE,MAAM,YAAY,EAAE,IAAI;AAE3C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,SAAS;AAAA,MACP,MAAM,YAAY,OAAO,IAAI;AAAA,MAC7B,SAAS;AAAA,IACX;AAAA,IACA,KAAK,CAAC,aAAa;AAAA,IACnB,YAAY,UAAU;AACpB,YAAM,OAAOA,MAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI;AAEnE,aAAOA,MAAK,QAAQ,MAAM,QAAQ;AAAA,IACpC;AAAA,IACA,YAAY,MAAM,MAAM;AACtB,aAAO,UAAU,MAAM,EAAE,QAAQ,SAAS,OAAO,CAAC;AAAA,IACpD;AAAA,IACA,MAAM,UAAU,QAAQ,WAAW;AACjC,UAAI,CAAC,UAAU,SAAS,KAAK,KAAK,CAAC,QAAQ;AACzC;AAAA,MACF;AAEA,aAAO,KAAK,YAAY,MAAM,QAAQ,WAAW,EAAE,QAAQ,MAAM,CAAC;AAAA,IACpE;AAAA,IACA,MAAM,aAAa;AACjB,YAAM,CAAC,aAAa,IAAyB,cAAc,mBAA8B,KAAK,SAAS,CAAC,aAAa,CAAC;AACtH,YAAM,MAAM,MAAM,cAAc,IAAI,OAAO;AAE3C,YAAM,IAAI,YAAY;AAEtB,YAAM,OAAOA,MAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI;AACnE,YAAM,WAAW,MAAM,YAAY,IAAI,GAAG;AAE1C,YAAM,KAAK,YAAY,MAAM,UAAUA,MAAK,QAAQ,MAAM,OAAO,QAAQ,aAAa,CAAC;AAAA,IACzF;AAAA,EACF;AACF,CAAC","sourcesContent":["import path from 'node:path'\n\nimport { PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase, trimExtName } from '@kubb/core/transformers'\nimport { pluginOasName } from '@kubb/plugin-oas'\n\nimport type { Plugin } from '@kubb/core'\nimport type { PluginOas } from '@kubb/plugin-oas'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\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      name: trimExtName(output.path),\n      baseURL: undefined,\n    },\n    pre: [pluginOasName],\n    resolvePath(baseName) {\n      const root = path.resolve(this.config.root, this.config.output.path)\n\n      return path.resolve(root, baseName)\n    },\n    resolveName(name, type) {\n      return camelCase(name, { isFile: type === 'file' })\n    },\n    async writeFile(source, writePath) {\n      if (!writePath.endsWith('.ts') || !source) {\n        return\n      }\n\n      return this.fileManager.write(source, writePath, { sanity: false })\n    },\n    async buildStart() {\n      const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])\n      const oas = await swaggerPlugin.api.getOas()\n\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.fileManager.write(pageHTML, path.resolve(root, output.path || './docs.html'))\n    },\n  }\n})\n","import fs from 'node:fs'\nimport path from 'node:path'\nimport type { OasTypes } from '@kubb/oas'\nimport pkg from 'handlebars'\nimport { renderToString } from 'react-dom/server'\nimport { ServerStyleSheet } from 'styled-components'\nimport redoc from 'redoc'\n\ntype BuildDocsOptions = {\n  title?: string\n  disableGoogleFont?: boolean\n  templateOptions?: any\n  redocOptions?: any\n}\n\n// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/\nfunction escapeClosingScriptTag(str: string): string {\n  return str.replace(/<\\/script>/g, '<\\\\/script>')\n}\n\n// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/\nfunction escapeUnicode(str: string): string {\n  // biome-ignore lint/style/useTemplate: <explanation>\n  return str.replace(/\\u2028|\\u2029/g, (m) => '\\\\u202' + (m === '\\u2028' ? '8' : '9'))\n}\n\nfunction sanitizeJSONString(str: string): string {\n  return escapeClosingScriptTag(escapeUnicode(str))\n}\n\nexport async function getPageHTML(api: OasTypes.OASDocument, { title, disableGoogleFont, templateOptions, redocOptions = {} }: BuildDocsOptions = {}) {\n  const apiUrl = redocOptions.specUrl\n  const { Redoc, createStore } = redoc || require('redoc')\n  const store = await createStore(api, apiUrl, redocOptions)\n  const sheet = new ServerStyleSheet()\n\n  const error = console.error\n  console.error = (...args: any) => {\n    if (/defaultProps/.test(args[0])) return\n    error(...args)\n  }\n\n  const html = renderToString(sheet.collectStyles(<Redoc store={store} />))\n  const state = await store.toJS()\n  const css = sheet.getStyleTags()\n\n  const templateFileName = path.join(__dirname, '../static/redoc.hbs')\n  const template = pkg.compile(fs.readFileSync(templateFileName).toString())\n  return template({\n    redocHTML: `\n      <div id=\"redoc\">${html || ''}</div>\n      <script>\n      ${`const __redoc_state = ${sanitizeJSONString(JSON.stringify(state))};` || ''}\n\n      var container = document.getElementById('redoc');\n      Redoc.${'hydrate(__redoc_state, container)'};\n\n      </script>`,\n    redocHead:\n      // biome-ignore lint/style/useTemplate: <explanation>\n      `<script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"></script>` + css,\n    title: title || api.info.title || 'ReDoc documentation',\n    disableGoogleFont,\n    templateOptions,\n  })\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,24 @@
+import * as _kubb_core from '@kubb/core';
+import { PluginFactoryOptions } from '@kubb/core';
+
+type Options = {
+    output?: {
+        /**
+         * Output for the generated doc, we are using [https://redocly.com/](https://redocly.com/) for the generation
+         * @default 'docs.html'
+         */
+        path: string;
+    };
+};
+type ResolveOptions = {};
+type PluginRedoc = PluginFactoryOptions<'plugin-redoc', Options, ResolveOptions, never>;
+declare module '@kubb/core' {
+    interface _Register {
+        ['@kubb/plugin-redoc']: PluginRedoc;
+    }
+}
+
+declare const pluginRedocName = "plugin-redoc";
+declare const pluginRedoc: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginRedoc>;
+
+export { type PluginRedoc, pluginRedoc, pluginRedocName };

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import * as _kubb_core from '@kubb/core';
+import { PluginFactoryOptions } from '@kubb/core';
+
+type Options = {
+    output?: {
+        /**
+         * Output for the generated doc, we are using [https://redocly.com/](https://redocly.com/) for the generation
+         * @default 'docs.html'
+         */
+        path: string;
+    };
+};
+type ResolveOptions = {};
+type PluginRedoc = PluginFactoryOptions<'plugin-redoc', Options, ResolveOptions, never>;
+declare module '@kubb/core' {
+    interface _Register {
+        ['@kubb/plugin-redoc']: PluginRedoc;
+    }
+}
+
+declare const pluginRedocName = "plugin-redoc";
+declare const pluginRedoc: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginRedoc>;
+
+export { type PluginRedoc, pluginRedoc, pluginRedocName };

package/dist/index.js

@@ -0,0 +1,113 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined")
+    return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// ../../node_modules/.pnpm/tsup@8.0.2_@microsoft+api-extractor@7.43.3_@types+node@20.12.11__postcss@8.4.38_ts-node@10.9._m3ved7kneisj6uq6vsf2lw6r5q/node_modules/tsup/assets/esm_shims.js
+import { fileURLToPath } from "url";
+import path from "path";
+var getFilename = () => fileURLToPath(import.meta.url);
+var getDirname = () => path.dirname(getFilename());
+var __dirname = /* @__PURE__ */ getDirname();
+
+// src/plugin.ts
+import path3 from "path";
+import { PluginManager, createPlugin } from "@kubb/core";
+import { camelCase, trimExtName } from "@kubb/core/transformers";
+import { pluginOasName } from "@kubb/plugin-oas";
+
+// src/redoc.tsx
+import fs from "fs";
+import path2 from "path";
+import pkg from "handlebars";
+import { renderToString } from "react-dom/server";
+import { ServerStyleSheet } from "styled-components";
+import redoc from "redoc";
+import { jsx } from "react/jsx-runtime";
+function escapeClosingScriptTag(str) {
+  return str.replace(/<\/script>/g, "<\\/script>");
+}
+function escapeUnicode(str) {
+  return str.replace(/\u2028|\u2029/g, (m) => "\\u202" + (m === "\u2028" ? "8" : "9"));
+}
+function sanitizeJSONString(str) {
+  return escapeClosingScriptTag(escapeUnicode(str));
+}
+async function getPageHTML(api, { title, disableGoogleFont, templateOptions, redocOptions = {} } = {}) {
+  const apiUrl = redocOptions.specUrl;
+  const { Redoc, createStore } = redoc || __require("redoc");
+  const store = await createStore(api, apiUrl, redocOptions);
+  const sheet = new ServerStyleSheet();
+  const error = console.error;
+  console.error = (...args) => {
+    if (/defaultProps/.test(args[0]))
+      return;
+    error(...args);
+  };
+  const html = renderToString(sheet.collectStyles(/* @__PURE__ */ jsx(Redoc, { store })));
+  const state = await store.toJS();
+  const css = sheet.getStyleTags();
+  const templateFileName = path2.join(__dirname, "../static/redoc.hbs");
+  const template = pkg.compile(fs.readFileSync(templateFileName).toString());
+  return template({
+    redocHTML: `
+      <div id="redoc">${html || ""}</div>
+      <script>
+      ${`const __redoc_state = ${sanitizeJSONString(JSON.stringify(state))};` || ""}
+
+      var container = document.getElementById('redoc');
+      Redoc.${"hydrate(__redoc_state, container)"};
+
+      </script>`,
+    redocHead: (
+      // biome-ignore lint/style/useTemplate: <explanation>
+      `<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>` + css
+    ),
+    title: title || api.info.title || "ReDoc documentation",
+    disableGoogleFont,
+    templateOptions
+  });
+}
+
+// src/plugin.ts
+var pluginRedocName = "plugin-redoc";
+var pluginRedoc = createPlugin((options) => {
+  const { output = { path: "docs.html" } } = options;
+  return {
+    name: pluginRedocName,
+    options: {
+      name: trimExtName(output.path),
+      baseURL: void 0
+    },
+    pre: [pluginOasName],
+    resolvePath(baseName) {
+      const root = path3.resolve(this.config.root, this.config.output.path);
+      return path3.resolve(root, baseName);
+    },
+    resolveName(name, type) {
+      return camelCase(name, { isFile: type === "file" });
+    },
+    async writeFile(source, writePath) {
+      if (!writePath.endsWith(".ts") || !source) {
+        return;
+      }
+      return this.fileManager.write(source, writePath, { sanity: false });
+    },
+    async buildStart() {
+      const [swaggerPlugin] = PluginManager.getDependedPlugins(this.plugins, [pluginOasName]);
+      const oas = await swaggerPlugin.api.getOas();
+      await oas.dereference();
+      const root = path3.resolve(this.config.root, this.config.output.path);
+      const pageHTML = await getPageHTML(oas.api);
+      await this.fileManager.write(pageHTML, path3.resolve(root, output.path || "./docs.html"));
+    }
+  };
+});
+export {
+  pluginRedoc,
+  pluginRedocName
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../node_modules/.pnpm/tsup@8.0.2_@microsoft+api-extractor@7.43.3_@types+node@20.12.11__postcss@8.4.38_ts-node@10.9._m3ved7kneisj6uq6vsf2lw6r5q/node_modules/tsup/assets/esm_shims.js","../src/plugin.ts","../src/redoc.tsx"],"sourcesContent":["// Shim globals in esm bundle\nimport { fileURLToPath } from 'url'\nimport path from 'path'\n\nconst getFilename = () => fileURLToPath(import.meta.url)\nconst getDirname = () => path.dirname(getFilename())\n\nexport const __dirname = /* @__PURE__ */ getDirname()\nexport const __filename = /* @__PURE__ */ getFilename()\n","import path from 'node:path'\n\nimport { PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase, trimExtName } from '@kubb/core/transformers'\nimport { pluginOasName } from '@kubb/plugin-oas'\n\nimport type { Plugin } from '@kubb/core'\nimport type { PluginOas } from '@kubb/plugin-oas'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\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      name: trimExtName(output.path),\n      baseURL: undefined,\n    },\n    pre: [pluginOasName],\n    resolvePath(baseName) {\n      const root = path.resolve(this.config.root, this.config.output.path)\n\n      return path.resolve(root, baseName)\n    },\n    resolveName(name, type) {\n      return camelCase(name, { isFile: type === 'file' })\n    },\n    async writeFile(source, writePath) {\n      if (!writePath.endsWith('.ts') || !source) {\n        return\n      }\n\n      return this.fileManager.write(source, writePath, { sanity: false })\n    },\n    async buildStart() {\n      const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])\n      const oas = await swaggerPlugin.api.getOas()\n\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.fileManager.write(pageHTML, path.resolve(root, output.path || './docs.html'))\n    },\n  }\n})\n","import fs from 'node:fs'\nimport path from 'node:path'\nimport type { OasTypes } from '@kubb/oas'\nimport pkg from 'handlebars'\nimport { renderToString } from 'react-dom/server'\nimport { ServerStyleSheet } from 'styled-components'\nimport redoc from 'redoc'\n\ntype BuildDocsOptions = {\n  title?: string\n  disableGoogleFont?: boolean\n  templateOptions?: any\n  redocOptions?: any\n}\n\n// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/\nfunction escapeClosingScriptTag(str: string): string {\n  return str.replace(/<\\/script>/g, '<\\\\/script>')\n}\n\n// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/\nfunction escapeUnicode(str: string): string {\n  // biome-ignore lint/style/useTemplate: <explanation>\n  return str.replace(/\\u2028|\\u2029/g, (m) => '\\\\u202' + (m === '\\u2028' ? '8' : '9'))\n}\n\nfunction sanitizeJSONString(str: string): string {\n  return escapeClosingScriptTag(escapeUnicode(str))\n}\n\nexport async function getPageHTML(api: OasTypes.OASDocument, { title, disableGoogleFont, templateOptions, redocOptions = {} }: BuildDocsOptions = {}) {\n  const apiUrl = redocOptions.specUrl\n  const { Redoc, createStore } = redoc || require('redoc')\n  const store = await createStore(api, apiUrl, redocOptions)\n  const sheet = new ServerStyleSheet()\n\n  const error = console.error\n  console.error = (...args: any) => {\n    if (/defaultProps/.test(args[0])) return\n    error(...args)\n  }\n\n  const html = renderToString(sheet.collectStyles(<Redoc store={store} />))\n  const state = await store.toJS()\n  const css = sheet.getStyleTags()\n\n  const templateFileName = path.join(__dirname, '../static/redoc.hbs')\n  const template = pkg.compile(fs.readFileSync(templateFileName).toString())\n  return template({\n    redocHTML: `\n      <div id=\"redoc\">${html || ''}</div>\n      <script>\n      ${`const __redoc_state = ${sanitizeJSONString(JSON.stringify(state))};` || ''}\n\n      var container = document.getElementById('redoc');\n      Redoc.${'hydrate(__redoc_state, container)'};\n\n      </script>`,\n    redocHead:\n      // biome-ignore lint/style/useTemplate: <explanation>\n      `<script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"></script>` + css,\n    title: title || api.info.title || 'ReDoc documentation',\n    disableGoogleFont,\n    templateOptions,\n  })\n}\n"],"mappings":";;;;;;;;;AACA,SAAS,qBAAqB;AAC9B,OAAO,UAAU;AAEjB,IAAM,cAAc,MAAM,cAAc,YAAY,GAAG;AACvD,IAAM,aAAa,MAAM,KAAK,QAAQ,YAAY,CAAC;AAE5C,IAAM,YAA4B,2BAAW;;;ACPpD,OAAOA,WAAU;AAEjB,SAAS,eAAe,oBAAoB;AAC5C,SAAS,WAAW,mBAAmB;AACvC,SAAS,qBAAqB;;;ACJ9B,OAAO,QAAQ;AACf,OAAOC,WAAU;AAEjB,OAAO,SAAS;AAChB,SAAS,sBAAsB;AAC/B,SAAS,wBAAwB;AACjC,OAAO,WAAW;AAoCgC;AA1BlD,SAAS,uBAAuB,KAAqB;AACnD,SAAO,IAAI,QAAQ,eAAe,aAAa;AACjD;AAGA,SAAS,cAAc,KAAqB;AAE1C,SAAO,IAAI,QAAQ,kBAAkB,CAAC,MAAM,YAAY,MAAM,WAAW,MAAM,IAAI;AACrF;AAEA,SAAS,mBAAmB,KAAqB;AAC/C,SAAO,uBAAuB,cAAc,GAAG,CAAC;AAClD;AAEA,eAAsB,YAAY,KAA2B,EAAE,OAAO,mBAAmB,iBAAiB,eAAe,CAAC,EAAE,IAAsB,CAAC,GAAG;AACpJ,QAAM,SAAS,aAAa;AAC5B,QAAM,EAAE,OAAO,YAAY,IAAI,SAAS,UAAQ,OAAO;AACvD,QAAM,QAAQ,MAAM,YAAY,KAAK,QAAQ,YAAY;AACzD,QAAM,QAAQ,IAAI,iBAAiB;AAEnC,QAAM,QAAQ,QAAQ;AACtB,UAAQ,QAAQ,IAAI,SAAc;AAChC,QAAI,eAAe,KAAK,KAAK,CAAC,CAAC;AAAG;AAClC,UAAM,GAAG,IAAI;AAAA,EACf;AAEA,QAAM,OAAO,eAAe,MAAM,cAAc,oBAAC,SAAM,OAAc,CAAE,CAAC;AACxE,QAAM,QAAQ,MAAM,MAAM,KAAK;AAC/B,QAAM,MAAM,MAAM,aAAa;AAE/B,QAAM,mBAAmBA,MAAK,KAAK,WAAW,qBAAqB;AACnE,QAAM,WAAW,IAAI,QAAQ,GAAG,aAAa,gBAAgB,EAAE,SAAS,CAAC;AACzE,SAAO,SAAS;AAAA,IACd,WAAW;AAAA,wBACS,QAAQ,EAAE;AAAA;AAAA,QAE1B,yBAAyB,mBAAmB,KAAK,UAAU,KAAK,CAAC,CAAC,OAAO,EAAE;AAAA;AAAA;AAAA,cAGrE,mCAAmC;AAAA;AAAA;AAAA,IAG7C;AAAA;AAAA,MAEE,0FAA0F;AAAA;AAAA,IAC5F,OAAO,SAAS,IAAI,KAAK,SAAS;AAAA,IAClC;AAAA,IACA;AAAA,EACF,CAAC;AACH;;;ADtDO,IAAM,kBAAkB;AAExB,IAAM,cAAc,aAA0B,CAAC,YAAY;AAChE,QAAM,EAAE,SAAS,EAAE,MAAM,YAAY,EAAE,IAAI;AAE3C,SAAO;AAAA,IACL,MAAM;AAAA,IACN,SAAS;AAAA,MACP,MAAM,YAAY,OAAO,IAAI;AAAA,MAC7B,SAAS;AAAA,IACX;AAAA,IACA,KAAK,CAAC,aAAa;AAAA,IACnB,YAAY,UAAU;AACpB,YAAM,OAAOC,MAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI;AAEnE,aAAOA,MAAK,QAAQ,MAAM,QAAQ;AAAA,IACpC;AAAA,IACA,YAAY,MAAM,MAAM;AACtB,aAAO,UAAU,MAAM,EAAE,QAAQ,SAAS,OAAO,CAAC;AAAA,IACpD;AAAA,IACA,MAAM,UAAU,QAAQ,WAAW;AACjC,UAAI,CAAC,UAAU,SAAS,KAAK,KAAK,CAAC,QAAQ;AACzC;AAAA,MACF;AAEA,aAAO,KAAK,YAAY,MAAM,QAAQ,WAAW,EAAE,QAAQ,MAAM,CAAC;AAAA,IACpE;AAAA,IACA,MAAM,aAAa;AACjB,YAAM,CAAC,aAAa,IAAyB,cAAc,mBAA8B,KAAK,SAAS,CAAC,aAAa,CAAC;AACtH,YAAM,MAAM,MAAM,cAAc,IAAI,OAAO;AAE3C,YAAM,IAAI,YAAY;AAEtB,YAAM,OAAOA,MAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI;AACnE,YAAM,WAAW,MAAM,YAAY,IAAI,GAAG;AAE1C,YAAM,KAAK,YAAY,MAAM,UAAUA,MAAK,QAAQ,MAAM,OAAO,QAAQ,aAAa,CAAC;AAAA,IACzF;AAAA,EACF;AACF,CAAC;","names":["path","path","path"]}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@kubb/plugin-redoc",
+  "version": "0.0.0-canary-20240509211223",
+  "description": "Beautiful docs with Redoc",
+  "keywords": [
+    "typescript",
+    "plugins",
+    "kubb",
+    "codegen",
+    "redoc"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kubb-labs/kubb.git",
+    "directory": "packages/plugin-redoc"
+  },
+  "license": "MIT",
+  "author": "Stijn Van Hulle <stijn@stijnvanhulle.be",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {}
+  },
+  "files": [
+    "src",
+    "dist",
+    "static",
+    "!/**/**.test.**",
+    "!/**/__tests__/**"
+  ],
+  "dependencies": {
+    "handlebars": "^4.7.8",
+    "mobx": "^6.12.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "redoc": "^2.1.4",
+    "styled-components": "^6.1.10",
+    "@kubb/core": "0.0.0-canary-20240509211223",
+    "@kubb/oas": "0.0.0-canary-20240509211223",
+    "@kubb/plugin-oas": "0.0.0-canary-20240509211223"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.1",
+    "@types/react-dom": "^18.3.0",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5",
+    "@kubb/config-biome": "0.0.0-canary-20240509211223",
+    "@kubb/config-ts": "0.0.0-canary-20240509211223",
+    "@kubb/config-tsup": "0.0.0-canary-20240509211223"
+  },
+  "peerDependencies": {
+    "@kubb/react": "0.0.0-canary-20240509211223"
+  },
+  "engines": {
+    "node": ">=18",
+    "pnpm": ">=8.15.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "npx rimraf ./dist",
+    "lint": "bun biome lint .",
+    "lint:fix": "bun biome lint --apply-unsafe .",
+    "release": "pnpm publish --no-git-check",
+    "release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
+    "start": "tsup --watch",
+    "test": "vitest --passWithNoTests",
+    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
+  }
+}

package/src/index.ts

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

package/src/plugin.ts

@@ -0,0 +1,51 @@
+import path from 'node:path'
+
+import { PluginManager, createPlugin } from '@kubb/core'
+import { camelCase, trimExtName } from '@kubb/core/transformers'
+import { pluginOasName } from '@kubb/plugin-oas'
+
+import type { Plugin } from '@kubb/core'
+import type { PluginOas } from '@kubb/plugin-oas'
+import { getPageHTML } from './redoc.tsx'
+import type { PluginRedoc } from './types.ts'
+
+export const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']
+
+export const pluginRedoc = createPlugin<PluginRedoc>((options) => {
+  const { output = { path: 'docs.html' } } = options
+
+  return {
+    name: pluginRedocName,
+    options: {
+      name: trimExtName(output.path),
+      baseURL: undefined,
+    },
+    pre: [pluginOasName],
+    resolvePath(baseName) {
+      const root = path.resolve(this.config.root, this.config.output.path)
+
+      return path.resolve(root, baseName)
+    },
+    resolveName(name, type) {
+      return camelCase(name, { isFile: type === 'file' })
+    },
+    async writeFile(source, writePath) {
+      if (!writePath.endsWith('.ts') || !source) {
+        return
+      }
+
+      return this.fileManager.write(source, writePath, { sanity: false })
+    },
+    async buildStart() {
+      const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])
+      const oas = await swaggerPlugin.api.getOas()
+
+      await oas.dereference()
+
+      const root = path.resolve(this.config.root, this.config.output.path)
+      const pageHTML = await getPageHTML(oas.api)
+
+      await this.fileManager.write(pageHTML, path.resolve(root, output.path || './docs.html'))
+    },
+  }
+})

package/src/redoc.tsx

@@ -0,0 +1,66 @@
+import fs from 'node:fs'
+import path from 'node:path'
+import type { OasTypes } from '@kubb/oas'
+import pkg from 'handlebars'
+import { renderToString } from 'react-dom/server'
+import { ServerStyleSheet } from 'styled-components'
+import redoc from 'redoc'
+
+type BuildDocsOptions = {
+  title?: string
+  disableGoogleFont?: boolean
+  templateOptions?: any
+  redocOptions?: any
+}
+
+// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/
+function escapeClosingScriptTag(str: string): string {
+  return str.replace(/<\/script>/g, '<\\/script>')
+}
+
+// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/
+function escapeUnicode(str: string): string {
+  // biome-ignore lint/style/useTemplate: <explanation>
+  return str.replace(/\u2028|\u2029/g, (m) => '\\u202' + (m === '\u2028' ? '8' : '9'))
+}
+
+function sanitizeJSONString(str: string): string {
+  return escapeClosingScriptTag(escapeUnicode(str))
+}
+
+export async function getPageHTML(api: OasTypes.OASDocument, { title, disableGoogleFont, templateOptions, redocOptions = {} }: BuildDocsOptions = {}) {
+  const apiUrl = redocOptions.specUrl
+  const { Redoc, createStore } = redoc || require('redoc')
+  const store = await createStore(api, apiUrl, redocOptions)
+  const sheet = new ServerStyleSheet()
+
+  const error = console.error
+  console.error = (...args: any) => {
+    if (/defaultProps/.test(args[0])) return
+    error(...args)
+  }
+
+  const html = renderToString(sheet.collectStyles(<Redoc store={store} />))
+  const state = await store.toJS()
+  const css = sheet.getStyleTags()
+
+  const templateFileName = path.join(__dirname, '../static/redoc.hbs')
+  const template = pkg.compile(fs.readFileSync(templateFileName).toString())
+  return template({
+    redocHTML: `
+      <div id="redoc">${html || ''}</div>
+      <script>
+      ${`const __redoc_state = ${sanitizeJSONString(JSON.stringify(state))};` || ''}
+
+      var container = document.getElementById('redoc');
+      Redoc.${'hydrate(__redoc_state, container)'};
+
+      </script>`,
+    redocHead:
+      // biome-ignore lint/style/useTemplate: <explanation>
+      `<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>` + css,
+    title: title || api.info.title || 'ReDoc documentation',
+    disableGoogleFont,
+    templateOptions,
+  })
+}

package/src/types.ts

@@ -0,0 +1,26 @@
+import type { Plugin, PluginFactoryOptions } from '@kubb/core'
+
+export type Options = {
+  output?: {
+    /**
+     * Output for the generated doc, we are using [https://redocly.com/](https://redocly.com/) for the generation
+     * @default 'docs.html'
+     */
+    path: string
+  }
+}
+
+type ResolveOptions = {}
+
+export type FileMeta = {
+  pluginKey?: Plugin['key']
+  tag?: string
+}
+
+export type PluginRedoc = PluginFactoryOptions<'plugin-redoc', Options, ResolveOptions, never>
+
+declare module '@kubb/core' {
+  export interface _Register {
+    ['@kubb/plugin-redoc']: PluginRedoc
+  }
+}

package/static/redoc.hbs

@@ -0,0 +1,23 @@
+<!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>
+  {{{redocHead}}}
+  {{#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>
+
+</html>