@kubb/plugin-redoc 3.0.0-alpha.5 → 3.0.0-alpha.6
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/dist/index.cjs +25 -10
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +25 -11
- package/dist/index.js.map +1 -1
- package/package.json +8 -8
- package/src/plugin.ts +2 -9
package/dist/index.cjs
CHANGED
|
@@ -1,17 +1,33 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
2
|
+
var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
|
|
2
3
|
get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
|
|
3
4
|
}) : x)(function(x) {
|
|
4
5
|
if (typeof require !== "undefined") return require.apply(this, arguments);
|
|
5
6
|
throw Error('Dynamic require of "' + x + '" is not supported');
|
|
6
7
|
});
|
|
8
|
+
var __esm = (fn, res) => function __init() {
|
|
9
|
+
return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
// ../../node_modules/.pnpm/tsup@8.2.4_@microsoft+api-extractor@7.47.7_@types+node@20.16.1__jiti@1.21.6_postcss@8.4.41_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/cjs_shims.js
|
|
13
|
+
var init_cjs_shims = __esm({
|
|
14
|
+
"../../node_modules/.pnpm/tsup@8.2.4_@microsoft+api-extractor@7.47.7_@types+node@20.16.1__jiti@1.21.6_postcss@8.4.41_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/cjs_shims.js"() {
|
|
15
|
+
"use strict";
|
|
16
|
+
}
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
// src/index.ts
|
|
20
|
+
init_cjs_shims();
|
|
7
21
|
|
|
8
22
|
// src/plugin.ts
|
|
23
|
+
init_cjs_shims();
|
|
9
24
|
var _path = require('path'); var _path2 = _interopRequireDefault(_path);
|
|
10
25
|
var _core = require('@kubb/core');
|
|
11
|
-
|
|
26
|
+
require('@kubb/core/transformers');
|
|
12
27
|
var _pluginoas = require('@kubb/plugin-oas');
|
|
13
28
|
|
|
14
29
|
// src/redoc.tsx
|
|
30
|
+
init_cjs_shims();
|
|
15
31
|
var _fs = require('fs'); var _fs2 = _interopRequireDefault(_fs);
|
|
16
32
|
|
|
17
33
|
var _handlebars = require('handlebars'); var _handlebars2 = _interopRequireDefault(_handlebars);
|
|
@@ -63,6 +79,12 @@ async function getPageHTML(api, { title, disableGoogleFont, templateOptions, red
|
|
|
63
79
|
});
|
|
64
80
|
}
|
|
65
81
|
|
|
82
|
+
// ../fs/src/index.ts
|
|
83
|
+
init_cjs_shims();
|
|
84
|
+
function trimExtName(text) {
|
|
85
|
+
return text.replace(/\.[^/.]+$/, "");
|
|
86
|
+
}
|
|
87
|
+
|
|
66
88
|
// src/plugin.ts
|
|
67
89
|
var pluginRedocName = "plugin-redoc";
|
|
68
90
|
var pluginRedoc = _core.createPlugin.call(void 0, (options) => {
|
|
@@ -70,17 +92,10 @@ var pluginRedoc = _core.createPlugin.call(void 0, (options) => {
|
|
|
70
92
|
return {
|
|
71
93
|
name: pluginRedocName,
|
|
72
94
|
options: {
|
|
73
|
-
name:
|
|
95
|
+
name: trimExtName(output.path),
|
|
74
96
|
baseURL: void 0
|
|
75
97
|
},
|
|
76
98
|
pre: [_pluginoas.pluginOasName],
|
|
77
|
-
resolvePath(baseName) {
|
|
78
|
-
const root = _path2.default.resolve(this.config.root, this.config.output.path);
|
|
79
|
-
return _path2.default.resolve(root, baseName);
|
|
80
|
-
},
|
|
81
|
-
resolveName(name, type) {
|
|
82
|
-
return _transformers.camelCase.call(void 0, name, { isFile: type === "file" });
|
|
83
|
-
},
|
|
84
99
|
async buildStart() {
|
|
85
100
|
const [swaggerPlugin] = _core.PluginManager.getDependedPlugins(this.plugins, [_pluginoas.pluginOasName]);
|
|
86
101
|
const oas = await swaggerPlugin.context.getOas();
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["/home/runner/work/kubb/kubb/packages/plugin-redoc/dist/index.cjs","../src/plugin.ts","../src/redoc.tsx"],"names":["path"],"mappings":"AAAA,6KAAI,UAAU,kBAAkB,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,QAAQ,IAAI,YAAY,EAAE,QAAQ,EAAE,OAAO,MAAM,IAAI,YAAY,EAAE,IAAI,KAAK,CAAC,CAAC,EAAE;AAC/H,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,QAAQ,IAAI,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE;AACpB,EAAE,GAAG,CAAC,OAAO,QAAQ,IAAI,WAAW,EAAE,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC;AAC3E,EAAE,MAAM,KAAK,CAAC,uBAAuB,EAAE,EAAE,EAAE,oBAAoB,CAAC;AAChE,CAAC,CAAC;AACF;AACA;
|
|
1
|
+
{"version":3,"sources":["/home/runner/work/kubb/kubb/packages/plugin-redoc/dist/index.cjs","../../../node_modules/.pnpm/tsup@8.2.4_@microsoft+api-extractor@7.47.7_@types+node@20.16.1__jiti@1.21.6_postcss@8.4.41_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/cjs_shims.js","../src/index.ts","../src/plugin.ts","../src/redoc.tsx","../../fs/src/index.ts"],"names":["path"],"mappings":"AAAA,6KAAI,kBAAkB,EAAE,MAAM,CAAC,mBAAmB;AAClD,IAAI,UAAU,kBAAkB,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,QAAQ,IAAI,YAAY,EAAE,QAAQ,EAAE,OAAO,MAAM,IAAI,YAAY,EAAE,IAAI,KAAK,CAAC,CAAC,EAAE;AAC/H,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,QAAQ,IAAI,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;AACjE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE;AACpB,EAAE,GAAG,CAAC,OAAO,QAAQ,IAAI,WAAW,EAAE,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC;AAC3E,EAAE,MAAM,KAAK,CAAC,uBAAuB,EAAE,EAAE,EAAE,oBAAoB,CAAC;AAChE,CAAC,CAAC;AACF,IAAI,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,SAAS,MAAM,CAAC,EAAE;AAC3C,EAAE,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG;AACrE,CAAC;AACD;AACA;ACXA,IAAA,eAAA,EAAA,KAAA,CAAA;AAAA,EAAA,uLAAA,CAAA,EAAA;AAAA,IAAA,YAAA;AAAA,EAAA;AAAA,CAAA,CAAA;ADiBA;AACA;AElBA,cAAA,CAAA,CAAA;AFoBA;AACA;AGrBA,cAAA,CAAA,CAAA;AAAA,wEAAiB;AAEjB,kCAA4C;AAC5C,mCAA0B;AAC1B,6CAA8B;AHuB9B;AACA;AI5BA,cAAA,CAAA,CAAA;AAAA,gEAAe;AACf;AAEA,gGAAgB;AAChB,0CAA+B;AAC/B,qDAAiC;AACjC,4EAAkB;AAoCgC,+CAAA;AA1BlD,SAAS,sBAAA,CAAuB,GAAA,EAAqB;AACnD,EAAA,OAAO,GAAA,CAAI,OAAA,CAAQ,aAAA,EAAe,aAAa,CAAA;AACjD;AAGA,SAAS,aAAA,CAAc,GAAA,EAAqB;AAE1C,EAAA,OAAO,GAAA,CAAI,OAAA,CAAQ,gBAAA,EAAkB,CAAC,CAAA,EAAA,GAAM,SAAA,EAAA,CAAY,EAAA,IAAM,SAAA,EAAW,IAAA,EAAM,GAAA,CAAI,CAAA;AACrF;AAEA,SAAS,kBAAA,CAAmB,GAAA,EAAqB;AAC/C,EAAA,OAAO,sBAAA,CAAuB,aAAA,CAAc,GAAG,CAAC,CAAA;AAClD;AAEA,MAAA,SAAsB,WAAA,CAAY,GAAA,EAA2B,EAAE,KAAA,EAAO,iBAAA,EAAmB,eAAA,EAAiB,aAAA,EAAe,CAAC,EAAE,EAAA,EAAsB,CAAC,CAAA,EAAG;AACpJ,EAAA,MAAM,OAAA,EAAS,YAAA,CAAa,OAAA;AAC5B,EAAA,MAAM,EAAE,KAAA,EAAO,YAAY,EAAA,EAAI,gBAAA,GAAS,SAAA,CAAQ,OAAO,CAAA;AACvD,EAAA,MAAM,MAAA,EAAQ,MAAM,WAAA,CAAY,GAAA,EAAK,MAAA,EAAQ,YAAY,CAAA;AACzD,EAAA,MAAM,MAAA,EAAQ,IAAI,uCAAA,CAAiB,CAAA;AAEnC,EAAA,MAAM,MAAA,EAAQ,OAAA,CAAQ,KAAA;AACtB,EAAA,OAAA,CAAQ,MAAA,EAAQ,CAAA,GAAI,IAAA,EAAA,GAAc;AAChC,IAAA,GAAA,CAAI,cAAA,CAAe,IAAA,CAAK,IAAA,CAAK,CAAC,CAAC,CAAA,EAAG,MAAA;AAClC,IAAA,KAAA,CAAM,GAAG,IAAI,CAAA;AAAA,EACf,CAAA;AAEA,EAAA,MAAM,KAAA,EAAO,oCAAA,KAAe,CAAM,aAAA,iBAAc,6BAAA,KAAC,EAAA,EAAM,MAAA,CAAc,CAAE,CAAC,CAAA;AACxE,EAAA,MAAM,MAAA,EAAQ,MAAM,KAAA,CAAM,IAAA,CAAK,CAAA;AAC/B,EAAA,MAAM,IAAA,EAAM,KAAA,CAAM,YAAA,CAAa,CAAA;AAE/B,EAAA,MAAM,iBAAA,EAAmB,cAAA,CAAK,IAAA,CAAK,SAAA,EAAW,qBAAqB,CAAA;AACnE,EAAA,MAAM,SAAA,EAAW,oBAAA,CAAI,OAAA,CAAQ,YAAA,CAAG,YAAA,CAAa,gBAAgB,CAAA,CAAE,QAAA,CAAS,CAAC,CAAA;AACzE,EAAA,OAAO,QAAA,CAAS;AAAA,IACd,SAAA,EAAW,CAAA;AAAA,sBAAA,EACS,KAAA,GAAQ,EAAE,CAAA;AAAA;AAAA,MAAA,EAE1B,CAAA,sBAAA,EAAyB,kBAAA,CAAmB,IAAA,CAAK,SAAA,CAAU,KAAK,CAAC,CAAC,CAAA,CAAA,EAAA,GAAO,EAAE,CAAA;AAAA;AAAA;AAAA,YAAA,EAGrE,mCAAmC,CAAA;AAAA;AAAA,eAAA,CAAA;AAAA,IAG7C,SAAA,EAAA;AAAA;AAAA,MAEE,CAAA,qFAAA,EAAA,EAA0F;AAAA,IAAA,CAAA;AAAA,IAC5F,KAAA,EAAO,MAAA,GAAS,GAAA,CAAI,IAAA,CAAK,MAAA,GAAS,qBAAA;AAAA,IAClC,iBAAA;AAAA,IACA;AAAA,EACF,CAAC,CAAA;AACH;AJeA;AACA;AKjFA,cAAA,CAAA,CAAA;AAIO,SAAS,WAAA,CAAY,IAAA,EAAsB;AAChD,EAAA,OAAO,IAAA,CAAK,OAAA,CAAQ,WAAA,EAAa,EAAE,CAAA;AACrC;ALgFA;AACA;AG3EO,IAAM,gBAAA,EAAkB,cAAA;AAExB,IAAM,YAAA,EAAc,gCAAA,CAA2B,OAAA,EAAA,GAAY;AAChE,EAAA,MAAM,EAAE,OAAA,EAAS,EAAE,IAAA,EAAM,YAAY,EAAE,EAAA,EAAI,OAAA;AAE3C,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,eAAA;AAAA,IACN,OAAA,EAAS;AAAA,MACP,IAAA,EAAM,WAAA,CAAY,MAAA,CAAO,IAAI,CAAA;AAAA,MAC7B,OAAA,EAAS,KAAA;AAAA,IACX,CAAA;AAAA,IACA,GAAA,EAAK,CAAC,wBAAa,CAAA;AAAA,IACnB,MAAM,UAAA,CAAA,EAAa;AACjB,MAAA,MAAM,CAAC,aAAa,EAAA,EAAyB,mBAAA,CAAc,kBAAA,CAA8B,IAAA,CAAK,OAAA,EAAS,CAAC,wBAAa,CAAC,CAAA;AACtH,MAAA,MAAM,IAAA,EAAM,MAAM,aAAA,CAAc,OAAA,CAAQ,MAAA,CAAO,CAAA;AAE/C,MAAA,MAAM,GAAA,CAAI,WAAA,CAAY,CAAA;AAEtB,MAAA,MAAM,KAAA,EAAOA,cAAAA,CAAK,OAAA,CAAQ,IAAA,CAAK,MAAA,CAAO,IAAA,EAAM,IAAA,CAAK,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AACnE,MAAA,MAAM,SAAA,EAAW,MAAM,WAAA,CAAY,GAAA,CAAI,GAAG,CAAA;AAE1C,MAAA,MAAM,IAAA,CAAK,WAAA,CAAY,KAAA,CAAMA,cAAAA,CAAK,OAAA,CAAQ,IAAA,EAAM,MAAA,CAAO,KAAA,GAAQ,aAAa,CAAA,EAAG,QAAQ,CAAA;AAAA,IACzF;AAAA,EACF,CAAA;AACF,CAAC,CAAA;AHwED;AACE;AACA;AACF,6EAAC","file":"/home/runner/work/kubb/kubb/packages/plugin-redoc/dist/index.cjs","sourcesContent":[null,"// Shim globals in cjs bundle\n// There's a weird bug that esbuild will always inject importMetaUrl\n// if we export it as `const importMetaUrl = ... __filename ...`\n// But using a function will not cause this issue\n\nconst getImportMetaUrl = () =>\n typeof document === 'undefined'\n ? new URL(`file:${__filename}`).href\n : (document.currentScript && document.currentScript.src) ||\n new URL('main.js', document.baseURI).href\n\nexport const importMetaUrl = /* @__PURE__ */ getImportMetaUrl()\n","export { pluginRedoc, pluginRedocName } from './plugin.ts'\nexport type { PluginRedoc } from './types.ts'\n","import path from 'node:path'\n\nimport { PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase } 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'\nimport { trimExtName } from '@kubb/fs'\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 async buildStart() {\n const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])\n const oas = await swaggerPlugin.context.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(path.resolve(root, output.path || './docs.html'), pageHTML)\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","export { clean } from './clean.ts'\nexport { getRelativePath, read, readSync } from './read.ts'\nexport { write } from './write.ts'\n\nexport function trimExtName(text: string): string {\n return text.replace(/\\.[^/.]+$/, '')\n}\n"]}
|
package/dist/index.js
CHANGED
|
@@ -1,24 +1,39 @@
|
|
|
1
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
1
2
|
var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
|
|
2
3
|
get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
|
|
3
4
|
}) : x)(function(x) {
|
|
4
5
|
if (typeof require !== "undefined") return require.apply(this, arguments);
|
|
5
6
|
throw Error('Dynamic require of "' + x + '" is not supported');
|
|
6
7
|
});
|
|
8
|
+
var __esm = (fn, res) => function __init() {
|
|
9
|
+
return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
|
|
10
|
+
};
|
|
7
11
|
|
|
8
12
|
// ../../node_modules/.pnpm/tsup@8.2.4_@microsoft+api-extractor@7.47.7_@types+node@20.16.1__jiti@1.21.6_postcss@8.4.41_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/esm_shims.js
|
|
9
13
|
import { fileURLToPath } from "url";
|
|
10
14
|
import path from "path";
|
|
11
|
-
var getFilename
|
|
12
|
-
var
|
|
13
|
-
|
|
15
|
+
var getFilename, getDirname, __dirname;
|
|
16
|
+
var init_esm_shims = __esm({
|
|
17
|
+
"../../node_modules/.pnpm/tsup@8.2.4_@microsoft+api-extractor@7.47.7_@types+node@20.16.1__jiti@1.21.6_postcss@8.4.41_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/esm_shims.js"() {
|
|
18
|
+
"use strict";
|
|
19
|
+
getFilename = () => fileURLToPath(import.meta.url);
|
|
20
|
+
getDirname = () => path.dirname(getFilename());
|
|
21
|
+
__dirname = /* @__PURE__ */ getDirname();
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
// src/index.ts
|
|
26
|
+
init_esm_shims();
|
|
14
27
|
|
|
15
28
|
// src/plugin.ts
|
|
29
|
+
init_esm_shims();
|
|
16
30
|
import path3 from "path";
|
|
17
31
|
import { PluginManager, createPlugin } from "@kubb/core";
|
|
18
|
-
import
|
|
32
|
+
import "@kubb/core/transformers";
|
|
19
33
|
import { pluginOasName } from "@kubb/plugin-oas";
|
|
20
34
|
|
|
21
35
|
// src/redoc.tsx
|
|
36
|
+
init_esm_shims();
|
|
22
37
|
import fs from "fs";
|
|
23
38
|
import path2 from "path";
|
|
24
39
|
import pkg from "handlebars";
|
|
@@ -70,6 +85,12 @@ async function getPageHTML(api, { title, disableGoogleFont, templateOptions, red
|
|
|
70
85
|
});
|
|
71
86
|
}
|
|
72
87
|
|
|
88
|
+
// ../fs/src/index.ts
|
|
89
|
+
init_esm_shims();
|
|
90
|
+
function trimExtName(text) {
|
|
91
|
+
return text.replace(/\.[^/.]+$/, "");
|
|
92
|
+
}
|
|
93
|
+
|
|
73
94
|
// src/plugin.ts
|
|
74
95
|
var pluginRedocName = "plugin-redoc";
|
|
75
96
|
var pluginRedoc = createPlugin((options) => {
|
|
@@ -81,13 +102,6 @@ var pluginRedoc = createPlugin((options) => {
|
|
|
81
102
|
baseURL: void 0
|
|
82
103
|
},
|
|
83
104
|
pre: [pluginOasName],
|
|
84
|
-
resolvePath(baseName) {
|
|
85
|
-
const root = path3.resolve(this.config.root, this.config.output.path);
|
|
86
|
-
return path3.resolve(root, baseName);
|
|
87
|
-
},
|
|
88
|
-
resolveName(name, type) {
|
|
89
|
-
return camelCase(name, { isFile: type === "file" });
|
|
90
|
-
},
|
|
91
105
|
async buildStart() {
|
|
92
106
|
const [swaggerPlugin] = PluginManager.getDependedPlugins(this.plugins, [pluginOasName]);
|
|
93
107
|
const oas = await swaggerPlugin.context.getOas();
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../node_modules/.pnpm/tsup@8.2.4_@microsoft+api-extractor@7.47.7_@types+node@20.16.1__jiti@1.21.6_postcss@8.4.41_typescript@5.5.4_yaml@2.4.5/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
|
|
1
|
+
{"version":3,"sources":["../../../node_modules/.pnpm/tsup@8.2.4_@microsoft+api-extractor@7.47.7_@types+node@20.16.1__jiti@1.21.6_postcss@8.4.41_typescript@5.5.4_yaml@2.4.5/node_modules/tsup/assets/esm_shims.js","../src/index.ts","../src/plugin.ts","../src/redoc.tsx","../../fs/src/index.ts"],"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","export { pluginRedoc, pluginRedocName } from './plugin.ts'\nexport type { PluginRedoc } from './types.ts'\n","import path from 'node:path'\n\nimport { PluginManager, createPlugin } from '@kubb/core'\nimport { camelCase } 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'\nimport { trimExtName } from '@kubb/fs'\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 async buildStart() {\n const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])\n const oas = await swaggerPlugin.context.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(path.resolve(root, output.path || './docs.html'), pageHTML)\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","export { clean } from './clean.ts'\nexport { getRelativePath, read, readSync } from './read.ts'\nexport { write } from './write.ts'\n\nexport function trimExtName(text: string): string {\n return text.replace(/\\.[^/.]+$/, '')\n}\n"],"mappings":";;;;;;;;;;;;AACA,SAAS,qBAAqB;AAC9B,OAAO,UAAU;AAFjB,IAIM,aACA,YAEO;AAPb;AAAA;AAAA;AAIA,IAAM,cAAc,MAAM,cAAc,YAAY,GAAG;AACvD,IAAM,aAAa,MAAM,KAAK,QAAQ,YAAY,CAAC;AAE5C,IAAM,YAA4B,2BAAW;AAAA;AAAA;;;ACPpD;;;ACAA;AAAA,OAAOA,WAAU;AAEjB,SAAS,eAAe,oBAAoB;AAC5C,OAA0B;AAC1B,SAAS,qBAAqB;;;ACJ9B;AAAA,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,EAAG;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;;;ACjEA;AAIO,SAAS,YAAY,MAAsB;AAChD,SAAO,KAAK,QAAQ,aAAa,EAAE;AACrC;;;AFMO,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,MAAM,aAAa;AACjB,YAAM,CAAC,aAAa,IAAyB,cAAc,mBAA8B,KAAK,SAAS,CAAC,aAAa,CAAC;AACtH,YAAM,MAAM,MAAM,cAAc,QAAQ,OAAO;AAE/C,YAAM,IAAI,YAAY;AAEtB,YAAM,OAAOC,MAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI;AACnE,YAAM,WAAW,MAAM,YAAY,IAAI,GAAG;AAE1C,YAAM,KAAK,YAAY,MAAMA,MAAK,QAAQ,MAAM,OAAO,QAAQ,aAAa,GAAG,QAAQ;AAAA,IACzF;AAAA,EACF;AACF,CAAC;","names":["path","path","path"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/plugin-redoc",
|
|
3
|
-
"version": "3.0.0-alpha.
|
|
3
|
+
"version": "3.0.0-alpha.6",
|
|
4
4
|
"description": "Beautiful docs with Redoc",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"typescript",
|
|
@@ -47,21 +47,21 @@
|
|
|
47
47
|
"react-dom": "^18.3.1",
|
|
48
48
|
"redoc": "^2.1.5",
|
|
49
49
|
"styled-components": "^6.1.12",
|
|
50
|
-
"@kubb/core": "3.0.0-alpha.
|
|
51
|
-
"@kubb/oas": "3.0.0-alpha.
|
|
52
|
-
"@kubb/
|
|
50
|
+
"@kubb/core": "3.0.0-alpha.6",
|
|
51
|
+
"@kubb/plugin-oas": "3.0.0-alpha.6",
|
|
52
|
+
"@kubb/oas": "3.0.0-alpha.6"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
55
|
"@types/react": "^18.3.4",
|
|
56
56
|
"@types/react-dom": "^18.3.0",
|
|
57
57
|
"tsup": "^8.2.4",
|
|
58
58
|
"typescript": "^5.5.4",
|
|
59
|
-
"@kubb/config-
|
|
60
|
-
"@kubb/config-
|
|
61
|
-
"@kubb/config-tsup": "3.0.0-alpha.
|
|
59
|
+
"@kubb/config-ts": "3.0.0-alpha.6",
|
|
60
|
+
"@kubb/config-biome": "3.0.0-alpha.6",
|
|
61
|
+
"@kubb/config-tsup": "3.0.0-alpha.6"
|
|
62
62
|
},
|
|
63
63
|
"peerDependencies": {
|
|
64
|
-
"@kubb/react": "3.0.0-alpha.
|
|
64
|
+
"@kubb/react": "3.0.0-alpha.6"
|
|
65
65
|
},
|
|
66
66
|
"engines": {
|
|
67
67
|
"node": ">=20"
|
package/src/plugin.ts
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
import path from 'node:path'
|
|
2
2
|
|
|
3
3
|
import { PluginManager, createPlugin } from '@kubb/core'
|
|
4
|
-
import { camelCase
|
|
4
|
+
import { camelCase } from '@kubb/core/transformers'
|
|
5
5
|
import { pluginOasName } from '@kubb/plugin-oas'
|
|
6
6
|
|
|
7
7
|
import type { Plugin } from '@kubb/core'
|
|
8
8
|
import type { PluginOas } from '@kubb/plugin-oas'
|
|
9
9
|
import { getPageHTML } from './redoc.tsx'
|
|
10
10
|
import type { PluginRedoc } from './types.ts'
|
|
11
|
+
import { trimExtName } from '@kubb/fs'
|
|
11
12
|
|
|
12
13
|
export const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']
|
|
13
14
|
|
|
@@ -21,14 +22,6 @@ export const pluginRedoc = createPlugin<PluginRedoc>((options) => {
|
|
|
21
22
|
baseURL: undefined,
|
|
22
23
|
},
|
|
23
24
|
pre: [pluginOasName],
|
|
24
|
-
resolvePath(baseName) {
|
|
25
|
-
const root = path.resolve(this.config.root, this.config.output.path)
|
|
26
|
-
|
|
27
|
-
return path.resolve(root, baseName)
|
|
28
|
-
},
|
|
29
|
-
resolveName(name, type) {
|
|
30
|
-
return camelCase(name, { isFile: type === 'file' })
|
|
31
|
-
},
|
|
32
25
|
async buildStart() {
|
|
33
26
|
const [swaggerPlugin]: [Plugin<PluginOas>] = PluginManager.getDependedPlugins<PluginOas>(this.plugins, [pluginOasName])
|
|
34
27
|
const oas = await swaggerPlugin.context.getOas()
|