@kubb/plugin-redoc 5.0.6 → 5.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -10,7 +10,7 @@
10
10
  [![Node][node-src]][node-href]
11
11
 
12
12
  <h4>
13
- <a href="https://kubb.dev/plugins/plugin-redoc" target="_blank">Documentation</a>
13
+ <a href="https://kubb.dev/extensions/kubb-labs/plugin-redoc" target="_blank">Documentation</a>
14
14
  <span> · </span>
15
15
  <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
16
16
  <span> · </span>
@@ -38,7 +38,7 @@ npm install @kubb/plugin-redoc
38
38
 
39
39
  ## Documentation
40
40
 
41
- See the [full documentation](https://kubb.dev/plugins/plugin-redoc) for configuration options and examples.
41
+ See the [full documentation](https://kubb.dev/extensions/kubb-labs/plugin-redoc) for configuration options and examples.
42
42
 
43
43
  ## Supporting Kubb
44
44
 
package/dist/index.cjs CHANGED
@@ -30,12 +30,12 @@ let _kubb_adapter_oas = require("@kubb/adapter-oas");
30
30
  let kubb_kit = require("kubb/kit");
31
31
  //#region kubb-extension.json
32
32
  var compatibility = {
33
- "kubb": ">=5.8.0",
33
+ "kubb": ">=5.8.3",
34
34
  "node": ">=22"
35
35
  };
36
36
  //#endregion
37
37
  //#region package.json
38
- var version = "5.0.6";
38
+ var version = "5.0.8";
39
39
  //#endregion
40
40
  //#region src/redoc.tsx
41
41
  const htmlEscapes = {
@@ -50,6 +50,32 @@ const htmlEscapes = {
50
50
  function escapeHtml(value) {
51
51
  return value.replace(/[&<>"'`=]/g, (char) => htmlEscapes[char] ?? char);
52
52
  }
53
+ const scriptEscapes = {
54
+ "<": "\\u003c",
55
+ ">": "\\u003e",
56
+ "&": "\\u0026",
57
+ "\u2028": "\\u2028",
58
+ "\u2029": "\\u2029"
59
+ };
60
+ /**
61
+ * Serializes `value` as JSON that is safe to inline in a `<script>` tag.
62
+ * JSON only allows these characters inside strings, where the `\uXXXX` escapes
63
+ * parse back to the same value, so a spec string such as `<\/script>` can no
64
+ * longer close the tag early.
65
+ */
66
+ function toScriptJSON(value) {
67
+ return JSON.stringify(value, null, 2).replace(/[<>&\u2028\u2029]/g, (char) => scriptEscapes[char] ?? char);
68
+ }
69
+ /**
70
+ * Redoc bundle the page loads, pinned to one release with a Subresource
71
+ * Integrity hash so a changed or compromised CDN file does not run. When
72
+ * bumping the version, recompute the hash from the npm tarball:
73
+ * `openssl dgst -sha384 -binary package/bundles/redoc.standalone.js | openssl base64 -A`.
74
+ */
75
+ const redocBundle = {
76
+ src: "https://cdn.jsdelivr.net/npm/redoc@2.5.4/bundles/redoc.standalone.js",
77
+ integrity: "sha384-w447zOpYfw/1Tv/5AK9NfHTlQIqE3RVR6KY62jCyy9zNDgO64cMwGGP1Fj0zJVf5"
78
+ };
53
79
  /**
54
80
  * Renders a self-contained Redoc HTML page for an OpenAPI document. The page
55
81
  * embeds the spec inline and pulls Redoc's bundle from a CDN at runtime, so
@@ -74,10 +100,10 @@ async function getPageHTML(api) {
74
100
 
75
101
  <body>
76
102
  ${`
77
- <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> <\/script>
103
+ <script src="${redocBundle.src}" integrity="${redocBundle.integrity}" crossorigin="anonymous"><\/script>
78
104
  <div id="redoc-container"></div>
79
105
  <script>
80
- const data = ${JSON.stringify(api, null, 2)};
106
+ const data = ${toScriptJSON(api)};
81
107
  Redoc.init(data, {
82
108
  "expandResponses": "200,400"
83
109
  }, document.getElementById('redoc-container'))
@@ -113,7 +139,8 @@ const pluginRedocName = "plugin-redoc";
113
139
  * })
114
140
  * ```
115
141
  */
116
- const pluginRedoc = (0, kubb_kit.definePlugin)({
142
+ const pluginRedoc = (0, kubb_kit.defineExtension)({
143
+ kind: "plugin",
117
144
  meta: {
118
145
  name: pluginRedocName,
119
146
  version,
@@ -1 +1 @@
1
- {"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"}
1
+ {"version":3,"file":"index.cjs","names":["defineExtension","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\nconst scriptEscapes: Record<string, string> = {\n '<': '\\\\u003c',\n '>': '\\\\u003e',\n '&': '\\\\u0026',\n '\\u2028': '\\\\u2028',\n '\\u2029': '\\\\u2029',\n}\n\n/**\n * Serializes `value` as JSON that is safe to inline in a `<script>` tag.\n * JSON only allows these characters inside strings, where the `\\uXXXX` escapes\n * parse back to the same value, so a spec string such as `</script>` can no\n * longer close the tag early.\n */\nfunction toScriptJSON(value: unknown) {\n return JSON.stringify(value, null, 2).replace(/[<>&\\u2028\\u2029]/g, (char) => scriptEscapes[char] ?? char)\n}\n\n/**\n * Redoc bundle the page loads, pinned to one release with a Subresource\n * Integrity hash so a changed or compromised CDN file does not run. When\n * bumping the version, recompute the hash from the npm tarball:\n * `openssl dgst -sha384 -binary package/bundles/redoc.standalone.js | openssl base64 -A`.\n */\nconst redocBundle = {\n src: 'https://cdn.jsdelivr.net/npm/redoc@2.5.4/bundles/redoc.standalone.js',\n integrity: 'sha384-w447zOpYfw/1Tv/5AK9NfHTlQIqE3RVR6KY62jCyy9zNDgO64cMwGGP1Fj0zJVf5',\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=\"${redocBundle.src}\" integrity=\"${redocBundle.integrity}\" crossorigin=\"anonymous\"></script>\n <div id=\"redoc-container\"></div>\n <script>\n const data = ${toScriptJSON(api)};\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, defineExtension, 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 = defineExtension<PluginRedoc>({\n kind: 'plugin',\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;AAEA,MAAM,gBAAwC;CAC5C,KAAK;CACL,KAAK;CACL,KAAK;CACL,UAAU;CACV,UAAU;AACZ;;;;;;;AAQA,SAAS,aAAa,OAAgB;CACpC,OAAO,KAAK,UAAU,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,uBAAuB,SAAS,cAAc,SAAS,IAAI;AAC3G;;;;;;;AAQA,MAAM,cAAc;CAClB,KAAK;CACL,WAAW;AACb;;;;;;AAOA,eAAsB,YAAY,KAA6B;CAc7D,OAAO;;;;aAbW,WAAW,IAAI,KAAK,SAAS,qBAiB5B,EAAE;;;;;;;;;;;;;MAajB;oBA3Bc,YAAY,IAAI,eAAe,YAAY,UAAU;;;kBAGvD,aAAa,GAAG,EAAE;;;;;MAwBpB;;;;AAIhB;;;;;;;ACvEA,MAAa,kBAAkB;;;;;;;;;;;;;;;;;;;;AAqB/B,MAAa,eAAA,GAAcA,SAAAA,gBAAAA,CAA6B;CACtD,MAAM;CACN,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.js CHANGED
@@ -1,15 +1,15 @@
1
1
  import "./rolldown-runtime-C0LytTxp.js";
2
2
  import path from "node:path";
3
3
  import { adapterOasName } from "@kubb/adapter-oas";
4
- import { ast, definePlugin, injectFile, useConfig } from "kubb/kit";
4
+ import { ast, defineExtension, injectFile, useConfig } from "kubb/kit";
5
5
  //#region kubb-extension.json
6
6
  var compatibility = {
7
- "kubb": ">=5.8.0",
7
+ "kubb": ">=5.8.3",
8
8
  "node": ">=22"
9
9
  };
10
10
  //#endregion
11
11
  //#region package.json
12
- var version = "5.0.6";
12
+ var version = "5.0.8";
13
13
  //#endregion
14
14
  //#region src/redoc.tsx
15
15
  const htmlEscapes = {
@@ -24,6 +24,32 @@ const htmlEscapes = {
24
24
  function escapeHtml(value) {
25
25
  return value.replace(/[&<>"'`=]/g, (char) => htmlEscapes[char] ?? char);
26
26
  }
27
+ const scriptEscapes = {
28
+ "<": "\\u003c",
29
+ ">": "\\u003e",
30
+ "&": "\\u0026",
31
+ "\u2028": "\\u2028",
32
+ "\u2029": "\\u2029"
33
+ };
34
+ /**
35
+ * Serializes `value` as JSON that is safe to inline in a `<script>` tag.
36
+ * JSON only allows these characters inside strings, where the `\uXXXX` escapes
37
+ * parse back to the same value, so a spec string such as `<\/script>` can no
38
+ * longer close the tag early.
39
+ */
40
+ function toScriptJSON(value) {
41
+ return JSON.stringify(value, null, 2).replace(/[<>&\u2028\u2029]/g, (char) => scriptEscapes[char] ?? char);
42
+ }
43
+ /**
44
+ * Redoc bundle the page loads, pinned to one release with a Subresource
45
+ * Integrity hash so a changed or compromised CDN file does not run. When
46
+ * bumping the version, recompute the hash from the npm tarball:
47
+ * `openssl dgst -sha384 -binary package/bundles/redoc.standalone.js | openssl base64 -A`.
48
+ */
49
+ const redocBundle = {
50
+ src: "https://cdn.jsdelivr.net/npm/redoc@2.5.4/bundles/redoc.standalone.js",
51
+ integrity: "sha384-w447zOpYfw/1Tv/5AK9NfHTlQIqE3RVR6KY62jCyy9zNDgO64cMwGGP1Fj0zJVf5"
52
+ };
27
53
  /**
28
54
  * Renders a self-contained Redoc HTML page for an OpenAPI document. The page
29
55
  * embeds the spec inline and pulls Redoc's bundle from a CDN at runtime, so
@@ -48,10 +74,10 @@ async function getPageHTML(api) {
48
74
 
49
75
  <body>
50
76
  ${`
51
- <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> <\/script>
77
+ <script src="${redocBundle.src}" integrity="${redocBundle.integrity}" crossorigin="anonymous"><\/script>
52
78
  <div id="redoc-container"></div>
53
79
  <script>
54
- const data = ${JSON.stringify(api, null, 2)};
80
+ const data = ${toScriptJSON(api)};
55
81
  Redoc.init(data, {
56
82
  "expandResponses": "200,400"
57
83
  }, document.getElementById('redoc-container'))
@@ -87,7 +113,8 @@ const pluginRedocName = "plugin-redoc";
87
113
  * })
88
114
  * ```
89
115
  */
90
- const pluginRedoc = definePlugin({
116
+ const pluginRedoc = defineExtension({
117
+ kind: "plugin",
91
118
  meta: {
92
119
  name: pluginRedocName,
93
120
  version,
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"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"}
1
+ {"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\nconst scriptEscapes: Record<string, string> = {\n '<': '\\\\u003c',\n '>': '\\\\u003e',\n '&': '\\\\u0026',\n '\\u2028': '\\\\u2028',\n '\\u2029': '\\\\u2029',\n}\n\n/**\n * Serializes `value` as JSON that is safe to inline in a `<script>` tag.\n * JSON only allows these characters inside strings, where the `\\uXXXX` escapes\n * parse back to the same value, so a spec string such as `</script>` can no\n * longer close the tag early.\n */\nfunction toScriptJSON(value: unknown) {\n return JSON.stringify(value, null, 2).replace(/[<>&\\u2028\\u2029]/g, (char) => scriptEscapes[char] ?? char)\n}\n\n/**\n * Redoc bundle the page loads, pinned to one release with a Subresource\n * Integrity hash so a changed or compromised CDN file does not run. When\n * bumping the version, recompute the hash from the npm tarball:\n * `openssl dgst -sha384 -binary package/bundles/redoc.standalone.js | openssl base64 -A`.\n */\nconst redocBundle = {\n src: 'https://cdn.jsdelivr.net/npm/redoc@2.5.4/bundles/redoc.standalone.js',\n integrity: 'sha384-w447zOpYfw/1Tv/5AK9NfHTlQIqE3RVR6KY62jCyy9zNDgO64cMwGGP1Fj0zJVf5',\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=\"${redocBundle.src}\" integrity=\"${redocBundle.integrity}\" crossorigin=\"anonymous\"></script>\n <div id=\"redoc-container\"></div>\n <script>\n const data = ${toScriptJSON(api)};\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, defineExtension, 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 = defineExtension<PluginRedoc>({\n kind: 'plugin',\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;AAEA,MAAM,gBAAwC;CAC5C,KAAK;CACL,KAAK;CACL,KAAK;CACL,UAAU;CACV,UAAU;AACZ;;;;;;;AAQA,SAAS,aAAa,OAAgB;CACpC,OAAO,KAAK,UAAU,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,uBAAuB,SAAS,cAAc,SAAS,IAAI;AAC3G;;;;;;;AAQA,MAAM,cAAc;CAClB,KAAK;CACL,WAAW;AACb;;;;;;AAOA,eAAsB,YAAY,KAA6B;CAc7D,OAAO;;;;aAbW,WAAW,IAAI,KAAK,SAAS,qBAiB5B,EAAE;;;;;;;;;;;;;MAajB;oBA3Bc,YAAY,IAAI,eAAe,YAAY,UAAU;;;kBAGvD,aAAa,GAAG,EAAE;;;;;MAwBpB;;;;AAIhB;;;;;;;ACvEA,MAAa,kBAAkB;;;;;;;;;;;;;;;;;;;;AAqB/B,MAAa,cAAc,gBAA6B;CACtD,MAAM;CACN,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"}
@@ -0,0 +1,39 @@
1
+ # Options
2
+
3
+ `pluginRedoc()` accepts a single option, the path of the HTML file it writes. It takes none of the [shared plugin options](https://kubb.dev/docs/5.x/reference/plugin-options).
4
+
5
+ ## Options overview
6
+
7
+ | Option | Purpose | Default |
8
+ | ------------------- | --------------------------------------- | ----------------------- |
9
+ | [`output`](#output) | Where the HTML file is written: `path`. | `{ path: 'docs.html' }` |
10
+
11
+ ## Option details
12
+
13
+ ### output
14
+
15
+ Where the generated Redoc HTML file is written.
16
+
17
+ | | |
18
+ | -------- | ----------------------- |
19
+ | Type | `{ path: string }` |
20
+ | Required | `false` |
21
+ | Default | `{ path: 'docs.html' }` |
22
+
23
+ #### output.path
24
+
25
+ File path of the generated HTML, resolved against the global `output.path`. Unlike most plugins, this points at a single file, not a directory. End the path with `.html`. Without `.html`, Kubb writes the file at that exact path, with no extension.
26
+
27
+ | | |
28
+ | -------- | ------------- |
29
+ | Type | `string` |
30
+ | Required | `false` |
31
+ | Default | `'docs.html'` |
32
+
33
+ With `output.path` set to `'docs.html'` and the global `output.path` set to `'./src/gen'`, the plugin writes one file:
34
+
35
+ ```text
36
+ src/
37
+ └── gen/
38
+ └── docs.html
39
+ ```
@@ -0,0 +1,32 @@
1
+ # Redoc
2
+
3
+ The Redoc plugin generates a single HTML page that documents your OpenAPI spec with Redoc.
4
+
5
+ The whole spec is embedded in the page, so you can publish the page to any static host without a build step. Viewing the page needs network access, because it loads a pinned Redoc bundle from jsDelivr, checked with a Subresource Integrity hash, and its fonts from Google Fonts.
6
+
7
+ ## Setup
8
+
9
+ No other plugins or packages are needed. The plugin reads the spec through the default OpenAPI adapter, `adapterOas`, and fails with any other adapter.
10
+
11
+ ## Options worth knowing
12
+
13
+ - `output.path` sets the HTML file path, relative to the root `output.path`. The default is `docs.html`. End it with `.html`, because it names a file, not a folder.
14
+
15
+ The plugin has no other options. See [Options](https://kubb.dev/extensions/kubb-labs/plugin-redoc/options) for its type and default.
16
+
17
+ ## Example
18
+
19
+ The config below writes the page to `src/gen/docs.html`.
20
+
21
+ ```typescript [kubb.config.ts]
22
+ import { defineConfig } from 'kubb/config'
23
+ import { pluginRedoc } from '@kubb/plugin-redoc'
24
+
25
+ export default defineConfig({
26
+ input: './petStore.yaml',
27
+ output: { path: './src/gen' },
28
+ plugins: [
29
+ pluginRedoc({ output: { path: 'docs.html' } }),
30
+ ],
31
+ })
32
+ ```
@@ -10,9 +10,15 @@
10
10
  "light": "https://kubb.dev/feature/openapi.svg"
11
11
  },
12
12
  "tags": ["redoc", "api-docs", "documentation", "interactive-docs", "codegen", "openapi"],
13
- "docs": "https://kubb.dev/plugins/plugin-redoc",
13
+ "docs": "https://kubb.dev/extensions/kubb-labs/plugin-redoc",
14
+ "maintainers": [
15
+ {
16
+ "name": "Stijn Van Hulle",
17
+ "github": "stijnvanhulle"
18
+ }
19
+ ],
14
20
  "compatibility": {
15
- "kubb": ">=5.8.0",
21
+ "kubb": ">=5.8.3",
16
22
  "node": ">=22"
17
23
  },
18
24
  "options": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kubb/plugin-redoc",
3
- "version": "5.0.6",
3
+ "version": "5.0.8",
4
4
  "description": "Generate a ReDoc API reference page with Kubb. Produces a standalone HTML file you can host without a build step.",
5
5
  "keywords": [
6
6
  "api-docs",
@@ -13,7 +13,7 @@
13
13
  "redoc",
14
14
  "typescript"
15
15
  ],
16
- "homepage": "https://kubb.dev/plugins/plugin-redoc",
16
+ "homepage": "https://kubb.dev/extensions/kubb-labs/plugin-redoc",
17
17
  "license": "MIT",
18
18
  "author": "stijnvanhulle",
19
19
  "repository": {
@@ -38,7 +38,7 @@
38
38
  "files": [
39
39
  "dist",
40
40
  "kubb-extension.json",
41
- "OVERVIEW.md",
41
+ "docs",
42
42
  "!/**/**.test.**",
43
43
  "!/**/__tests__/**",
44
44
  "!/**/__snapshots__/**"
@@ -65,13 +65,13 @@
65
65
  "registry": "https://registry.npmjs.org/"
66
66
  },
67
67
  "dependencies": {
68
- "@kubb/adapter-oas": "^5.8.1"
68
+ "@kubb/adapter-oas": "^5.8.3"
69
69
  },
70
70
  "devDependencies": {
71
- "kubb": "^5.8.1"
71
+ "kubb": "^5.8.3"
72
72
  },
73
73
  "peerDependencies": {
74
- "kubb": "^5.8.1"
74
+ "kubb": "^5.8.3"
75
75
  },
76
76
  "engines": {
77
77
  "node": ">=22"
package/OVERVIEW.md DELETED
@@ -1,15 +0,0 @@
1
- # Redoc
2
-
3
- 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.
4
-
5
- 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.
6
-
7
- ## Setup
8
-
9
- No other plugins or packages are needed.
10
-
11
- ## Options worth knowing
12
-
13
- - `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`.
14
-
15
- The plugin takes no other options.