@kubb/plugin-redoc 4.12.7 → 4.12.9
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.d.cts +10 -9
- package/dist/index.d.ts +10 -9
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +6 -6
package/dist/index.d.cts
CHANGED
|
@@ -119,21 +119,21 @@ interface KubbEvents {
|
|
|
119
119
|
*/
|
|
120
120
|
'hooks:end': [];
|
|
121
121
|
/**
|
|
122
|
-
* Emitted when a single hook execution starts.
|
|
123
|
-
*/
|
|
124
|
-
'hook:start': [command: string];
|
|
125
|
-
/**
|
|
126
|
-
* Emitted to execute a hook command (e.g., format or lint).
|
|
122
|
+
* Emitted when a single hook execution starts. (e.g., format or lint).
|
|
127
123
|
* The callback should be invoked when the command completes.
|
|
128
124
|
*/
|
|
129
|
-
'hook:
|
|
130
|
-
|
|
125
|
+
'hook:start': [{
|
|
126
|
+
id?: string;
|
|
127
|
+
command: string;
|
|
131
128
|
args?: readonly string[];
|
|
132
|
-
}
|
|
129
|
+
}];
|
|
133
130
|
/**
|
|
134
131
|
* Emitted when a single hook execution completes.
|
|
135
132
|
*/
|
|
136
|
-
'hook:end': [
|
|
133
|
+
'hook:end': [{
|
|
134
|
+
id?: string;
|
|
135
|
+
command: string;
|
|
136
|
+
}];
|
|
137
137
|
/**
|
|
138
138
|
* Emitted when a new version of Kubb is available.
|
|
139
139
|
*/
|
|
@@ -671,6 +671,7 @@ declare class Oas<const TOAS = unknown> extends BaseOas {
|
|
|
671
671
|
getRequestSchema(operation: Operation): SchemaObject | undefined;
|
|
672
672
|
getParametersSchema(operation: Operation, inKey: 'path' | 'query' | 'header'): SchemaObject | null;
|
|
673
673
|
valdiate(): Promise<oas_normalize_lib_types0.ValidationResult>;
|
|
674
|
+
flattenSchema(schema?: SchemaObject): SchemaObject | undefined;
|
|
674
675
|
}
|
|
675
676
|
//#endregion
|
|
676
677
|
//#region src/types.d.ts
|
package/dist/index.d.ts
CHANGED
|
@@ -119,21 +119,21 @@ interface KubbEvents {
|
|
|
119
119
|
*/
|
|
120
120
|
'hooks:end': [];
|
|
121
121
|
/**
|
|
122
|
-
* Emitted when a single hook execution starts.
|
|
123
|
-
*/
|
|
124
|
-
'hook:start': [command: string];
|
|
125
|
-
/**
|
|
126
|
-
* Emitted to execute a hook command (e.g., format or lint).
|
|
122
|
+
* Emitted when a single hook execution starts. (e.g., format or lint).
|
|
127
123
|
* The callback should be invoked when the command completes.
|
|
128
124
|
*/
|
|
129
|
-
'hook:
|
|
130
|
-
|
|
125
|
+
'hook:start': [{
|
|
126
|
+
id?: string;
|
|
127
|
+
command: string;
|
|
131
128
|
args?: readonly string[];
|
|
132
|
-
}
|
|
129
|
+
}];
|
|
133
130
|
/**
|
|
134
131
|
* Emitted when a single hook execution completes.
|
|
135
132
|
*/
|
|
136
|
-
'hook:end': [
|
|
133
|
+
'hook:end': [{
|
|
134
|
+
id?: string;
|
|
135
|
+
command: string;
|
|
136
|
+
}];
|
|
137
137
|
/**
|
|
138
138
|
* Emitted when a new version of Kubb is available.
|
|
139
139
|
*/
|
|
@@ -671,6 +671,7 @@ declare class Oas<const TOAS = unknown> extends BaseOas {
|
|
|
671
671
|
getRequestSchema(operation: Operation): SchemaObject | undefined;
|
|
672
672
|
getParametersSchema(operation: Operation, inKey: 'path' | 'query' | 'header'): SchemaObject | null;
|
|
673
673
|
valdiate(): Promise<oas_normalize_lib_types0.ValidationResult>;
|
|
674
|
+
flattenSchema(schema?: SchemaObject): SchemaObject | undefined;
|
|
674
675
|
}
|
|
675
676
|
//#endregion
|
|
676
677
|
//#region src/types.d.ts
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@ import { fileURLToPath } from "node:url";
|
|
|
5
5
|
import fs from "node:fs";
|
|
6
6
|
import pkg from "handlebars";
|
|
7
7
|
|
|
8
|
-
//#region ../../node_modules/.pnpm/tsdown@0.18.
|
|
8
|
+
//#region ../../node_modules/.pnpm/tsdown@0.18.2_oxc-resolver@11.16.0_typescript@5.9.3/node_modules/tsdown/esm-shims.js
|
|
9
9
|
const getFilename = () => fileURLToPath(import.meta.url);
|
|
10
10
|
const getDirname = () => path.dirname(getFilename());
|
|
11
11
|
const __dirname = /* @__PURE__ */ getDirname();
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../../../node_modules/.pnpm/tsdown@0.18.
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../../../node_modules/.pnpm/tsdown@0.18.2_oxc-resolver@11.16.0_typescript@5.9.3/node_modules/tsdown/esm-shims.js","../src/redoc.tsx","../src/plugin.ts"],"sourcesContent":["// Shim globals in esm bundle\nimport path from 'node:path'\nimport { fileURLToPath } from 'node:url'\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 fs from 'node:fs'\nimport path from 'node:path'\nimport type { OasTypes } from '@kubb/oas'\nimport pkg from 'handlebars'\n\ntype BuildDocsOptions = {\n title?: string\n disableGoogleFont?: boolean\n templateOptions?: any\n}\n\nexport async function getPageHTML(api: OasTypes.OASDocument, { title, disableGoogleFont, templateOptions }: BuildDocsOptions = {}) {\n const templateFileName = path.join(__dirname, '../static/redoc.hbs')\n const template = pkg.compile(fs.readFileSync(templateFileName).toString())\n return template({\n title: title || api.info.title || 'ReDoc documentation',\n redocHTML: `\n <script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"> </script>\n <div id=\"redoc-container\"></div>\n <script>\n const data = ${JSON.stringify(api, null, 2)};\n Redoc.init(data, {\n \"expandResponses\": \"200,400\"\n }, document.getElementById('redoc-container'))\n </script>\n `,\n disableGoogleFont,\n templateOptions,\n })\n}\n","import path from 'node:path'\nimport { definePlugin } from '@kubb/core'\nimport { pluginOasName } from '@kubb/plugin-oas'\nimport { getPageHTML } from './redoc.tsx'\nimport type { PluginRedoc } from './types.ts'\n\nfunction trimExtName(text: string): string {\n return text.replace(/\\.[^/.]+$/, '')\n}\n\nexport const pluginRedocName = 'plugin-redoc' satisfies PluginRedoc['name']\n\nexport const pluginRedoc = definePlugin<PluginRedoc>((options) => {\n const { output = { path: 'docs.html' } } = options\n\n return {\n name: pluginRedocName,\n options: {\n output,\n name: trimExtName(output.path),\n },\n pre: [pluginOasName],\n async install() {\n const oas = await this.getOas()\n await oas.dereference()\n\n const root = path.resolve(this.config.root, this.config.output.path)\n const pageHTML = await getPageHTML(oas.api)\n\n await this.addFile({\n baseName: 'docs.html',\n path: path.resolve(root, output.path || './docs.html'),\n sources: [\n {\n name: 'docs.html',\n value: pageHTML,\n },\n ],\n })\n },\n }\n})\n"],"x_google_ignoreList":[0],"mappings":";;;;;;;;AAIA,MAAM,oBAAoB,cAAc,OAAO,KAAK,IAAI;AACxD,MAAM,mBAAmB,KAAK,QAAQ,aAAa,CAAC;AAEpD,MAAa,YAA4B,4BAAY;;;;ACIrD,eAAsB,YAAY,KAA2B,EAAE,OAAO,mBAAmB,oBAAsC,EAAE,EAAE;CACjI,MAAM,mBAAmB,KAAK,KAAK,WAAW,sBAAsB;AAEpE,QADiB,IAAI,QAAQ,GAAG,aAAa,iBAAiB,CAAC,UAAU,CAAC,CAC1D;EACd,OAAO,SAAS,IAAI,KAAK,SAAS;EAClC,WAAW;;;;kBAIG,KAAK,UAAU,KAAK,MAAM,EAAE,CAAC;;;;;;EAM3C;EACA;EACD,CAAC;;;;;ACtBJ,SAAS,YAAY,MAAsB;AACzC,QAAO,KAAK,QAAQ,aAAa,GAAG;;AAGtC,MAAa,kBAAkB;AAE/B,MAAa,cAAc,cAA2B,YAAY;CAChE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,KAAK;AAE3C,QAAO;EACL,MAAM;EACN,SAAS;GACP;GACA,MAAM,YAAY,OAAO,KAAK;GAC/B;EACD,KAAK,CAAC,cAAc;EACpB,MAAM,UAAU;GACd,MAAM,MAAM,MAAM,KAAK,QAAQ;AAC/B,SAAM,IAAI,aAAa;GAEvB,MAAM,OAAO,KAAK,QAAQ,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,KAAK;GACpE,MAAM,WAAW,MAAM,YAAY,IAAI,IAAI;AAE3C,SAAM,KAAK,QAAQ;IACjB,UAAU;IACV,MAAM,KAAK,QAAQ,MAAM,OAAO,QAAQ,cAAc;IACtD,SAAS,CACP;KACE,MAAM;KACN,OAAO;KACR,CACF;IACF,CAAC;;EAEL;EACD"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kubb/plugin-redoc",
|
|
3
|
-
"version": "4.12.
|
|
3
|
+
"version": "4.12.9",
|
|
4
4
|
"description": "Beautiful docs with Redoc",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"typescript",
|
|
@@ -46,14 +46,14 @@
|
|
|
46
46
|
}
|
|
47
47
|
],
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"@kubb/react-fabric": "0.7.
|
|
49
|
+
"@kubb/react-fabric": "0.7.4",
|
|
50
50
|
"handlebars": "^4.7.8",
|
|
51
|
-
"@kubb/core": "4.12.
|
|
52
|
-
"@kubb/oas": "4.12.
|
|
53
|
-
"@kubb/plugin-oas": "4.12.
|
|
51
|
+
"@kubb/core": "4.12.9",
|
|
52
|
+
"@kubb/oas": "4.12.9",
|
|
53
|
+
"@kubb/plugin-oas": "4.12.9"
|
|
54
54
|
},
|
|
55
55
|
"peerDependencies": {
|
|
56
|
-
"@kubb/react-fabric": "0.7.
|
|
56
|
+
"@kubb/react-fabric": "0.7.4"
|
|
57
57
|
},
|
|
58
58
|
"engines": {
|
|
59
59
|
"node": ">=20"
|