@kubb/core 4.36.1 → 5.0.0-alpha.10
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/{types-D30QAz2y.d.ts → PluginDriver-BkFepPdm.d.ts} +354 -291
- package/dist/hooks.cjs +85 -8
- package/dist/hooks.cjs.map +1 -1
- package/dist/hooks.d.ts +66 -4
- package/dist/hooks.js +83 -8
- package/dist/hooks.js.map +1 -1
- package/dist/index.cjs +346 -315
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +91 -77
- package/dist/index.js +338 -305
- package/dist/index.js.map +1 -1
- package/package.json +7 -7
- package/src/Kubb.ts +27 -55
- package/src/{PluginManager.ts → PluginDriver.ts} +69 -82
- package/src/build.ts +32 -33
- package/src/constants.ts +1 -1
- package/src/createAdapter.ts +25 -0
- package/src/createPlugin.ts +28 -0
- package/src/createStorage.ts +58 -0
- package/src/defineGenerator.ts +134 -0
- package/src/defineLogger.ts +13 -3
- package/src/defineResolver.ts +131 -0
- package/src/hooks/index.ts +2 -1
- package/src/hooks/useKubb.ts +143 -0
- package/src/hooks/useMode.ts +5 -2
- package/src/hooks/usePlugin.ts +5 -2
- package/src/hooks/usePluginDriver.ts +11 -0
- package/src/index.ts +7 -7
- package/src/storages/fsStorage.ts +2 -2
- package/src/storages/memoryStorage.ts +2 -2
- package/src/types.ts +94 -48
- package/src/utils/FunctionParams.ts +2 -2
- package/src/utils/TreeNode.ts +1 -1
- package/src/utils/formatters.ts +1 -1
- package/src/utils/getBarrelFiles.ts +73 -11
- package/src/utils/getConfigs.ts +3 -21
- package/src/utils/linters.ts +1 -1
- package/src/utils/packageJSON.ts +61 -0
- package/src/BarrelManager.ts +0 -74
- package/src/PackageManager.ts +0 -180
- package/src/PromiseManager.ts +0 -40
- package/src/defineAdapter.ts +0 -22
- package/src/definePlugin.ts +0 -12
- package/src/defineStorage.ts +0 -56
- package/src/errors.ts +0 -1
- package/src/hooks/usePluginManager.ts +0 -8
- package/src/utils/getPlugins.ts +0 -23
package/dist/hooks.cjs
CHANGED
|
@@ -1,26 +1,103 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
-
require("./chunk-ByKO4r7w.cjs");
|
|
2
|
+
const require_chunk = require("./chunk-ByKO4r7w.cjs");
|
|
3
|
+
let node_path = require("node:path");
|
|
4
|
+
node_path = require_chunk.__toESM(node_path);
|
|
3
5
|
let _kubb_react_fabric = require("@kubb/react-fabric");
|
|
6
|
+
//#region src/hooks/useKubb.ts
|
|
7
|
+
/**
|
|
8
|
+
* Generates the default "Generated by Kubb" banner from node metadata.
|
|
9
|
+
*/
|
|
10
|
+
function buildDefaultBanner({ title, description, version, config }) {
|
|
11
|
+
try {
|
|
12
|
+
let source = "";
|
|
13
|
+
if (Array.isArray(config.input)) {
|
|
14
|
+
const first = config.input[0];
|
|
15
|
+
if (first && "path" in first) source = node_path.default.basename(first.path);
|
|
16
|
+
} else if ("path" in config.input) source = node_path.default.basename(config.input.path);
|
|
17
|
+
else if ("data" in config.input) source = "text content";
|
|
18
|
+
let banner = "/**\n* Generated by Kubb (https://kubb.dev/).\n* Do not edit manually.\n";
|
|
19
|
+
if (config.output.defaultBanner === "simple") {
|
|
20
|
+
banner += "*/\n";
|
|
21
|
+
return banner;
|
|
22
|
+
}
|
|
23
|
+
if (source) banner += `* Source: ${source}\n`;
|
|
24
|
+
if (title) banner += `* Title: ${title}\n`;
|
|
25
|
+
if (description) {
|
|
26
|
+
const formattedDescription = description.replace(/\n/gm, "\n* ");
|
|
27
|
+
banner += `* Description: ${formattedDescription}\n`;
|
|
28
|
+
}
|
|
29
|
+
if (version) banner += `* OpenAPI spec version: ${version}\n`;
|
|
30
|
+
banner += "*/\n";
|
|
31
|
+
return banner;
|
|
32
|
+
} catch (_error) {
|
|
33
|
+
return "/**\n* Generated by Kubb (https://kubb.dev/).\n* Do not edit manually.\n*/";
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
function useKubb() {
|
|
37
|
+
const { meta } = (0, _kubb_react_fabric.useFabric)();
|
|
38
|
+
const config = meta.driver.config;
|
|
39
|
+
const defaultPluginName = meta.plugin.name;
|
|
40
|
+
const output = meta.plugin.options?.output;
|
|
41
|
+
return {
|
|
42
|
+
plugin: meta.plugin,
|
|
43
|
+
mode: meta.mode,
|
|
44
|
+
config,
|
|
45
|
+
getPluginByName: (pluginName = defaultPluginName) => meta.driver.getPluginByName.call(meta.driver, pluginName),
|
|
46
|
+
getFile: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.getFile.call(meta.driver, {
|
|
47
|
+
pluginName,
|
|
48
|
+
...rest
|
|
49
|
+
}),
|
|
50
|
+
resolveName: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolveName.call(meta.driver, {
|
|
51
|
+
pluginName,
|
|
52
|
+
...rest
|
|
53
|
+
}),
|
|
54
|
+
resolvePath: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolvePath.call(meta.driver, {
|
|
55
|
+
pluginName,
|
|
56
|
+
...rest
|
|
57
|
+
}),
|
|
58
|
+
resolveBanner: (node) => {
|
|
59
|
+
if (typeof output?.banner === "function") return node ? output.banner(node) : buildDefaultBanner({ config });
|
|
60
|
+
if (typeof output?.banner === "string") return output.banner;
|
|
61
|
+
if (config.output.defaultBanner === false) return;
|
|
62
|
+
return buildDefaultBanner({ config });
|
|
63
|
+
},
|
|
64
|
+
resolveFooter: (node) => {
|
|
65
|
+
if (typeof output?.footer === "function") return node ? output.footer(node) : void 0;
|
|
66
|
+
if (typeof output?.footer === "string") return output.footer;
|
|
67
|
+
}
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
//#endregion
|
|
4
71
|
//#region src/hooks/useMode.ts
|
|
72
|
+
/**
|
|
73
|
+
* @deprecated use `useKubb` instead
|
|
74
|
+
*/
|
|
5
75
|
function useMode() {
|
|
6
|
-
const { meta } = (0, _kubb_react_fabric.
|
|
76
|
+
const { meta } = (0, _kubb_react_fabric.useFabric)();
|
|
7
77
|
return meta.mode;
|
|
8
78
|
}
|
|
9
79
|
//#endregion
|
|
10
80
|
//#region src/hooks/usePlugin.ts
|
|
81
|
+
/**
|
|
82
|
+
* @deprecated use useKubb instead
|
|
83
|
+
*/
|
|
11
84
|
function usePlugin() {
|
|
12
|
-
const { meta } = (0, _kubb_react_fabric.
|
|
85
|
+
const { meta } = (0, _kubb_react_fabric.useFabric)();
|
|
13
86
|
return meta.plugin;
|
|
14
87
|
}
|
|
15
88
|
//#endregion
|
|
16
|
-
//#region src/hooks/
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
89
|
+
//#region src/hooks/usePluginDriver.ts
|
|
90
|
+
/**
|
|
91
|
+
* @deprecated use `useKubb` instead
|
|
92
|
+
*/
|
|
93
|
+
function usePluginDriver() {
|
|
94
|
+
const { meta } = (0, _kubb_react_fabric.useFabric)();
|
|
95
|
+
return meta.driver;
|
|
20
96
|
}
|
|
21
97
|
//#endregion
|
|
98
|
+
exports.useKubb = useKubb;
|
|
22
99
|
exports.useMode = useMode;
|
|
23
100
|
exports.usePlugin = usePlugin;
|
|
24
|
-
exports.
|
|
101
|
+
exports.usePluginDriver = usePluginDriver;
|
|
25
102
|
|
|
26
103
|
//# sourceMappingURL=hooks.cjs.map
|
package/dist/hooks.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.cjs","names":[],"sources":["../src/hooks/useMode.ts","../src/hooks/usePlugin.ts","../src/hooks/
|
|
1
|
+
{"version":3,"file":"hooks.cjs","names":["path"],"sources":["../src/hooks/useKubb.ts","../src/hooks/useMode.ts","../src/hooks/usePlugin.ts","../src/hooks/usePluginDriver.ts"],"sourcesContent":["import path from 'node:path'\nimport type { RootNode } from '@kubb/ast/types'\nimport type { KubbFile } from '@kubb/fabric-core/types'\nimport { useFabric } from '@kubb/react-fabric'\nimport type { GetFileOptions, PluginDriver } from '../PluginDriver.ts'\nimport type { Config, Plugin, PluginFactoryOptions, ResolveNameParams, ResolvePathParams } from '../types.ts'\n\ntype ResolvePathOptions = {\n pluginName?: string\n group?: {\n tag?: string\n path?: string\n }\n type?: ResolveNameParams['type']\n}\n\ntype UseKubbReturn<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {\n plugin: Plugin<TOptions>\n mode: KubbFile.Mode\n config: Config\n /**\n * Returns the plugin whose `name` matches `pluginName`, defaulting to the current plugin.\n */\n getPluginByName: (pluginName?: string) => Plugin | undefined\n /**\n * Resolves a file reference, defaulting `pluginName` to the current plugin.\n */\n getFile: (params: Omit<GetFileOptions<ResolvePathOptions>, 'pluginName'> & { pluginName?: string }) => KubbFile.File<{ pluginName: string }>\n /**\n * Resolves a name, defaulting `pluginName` to the current plugin.\n */\n resolveName: (params: Omit<ResolveNameParams, 'pluginName'> & { pluginName?: string }) => string\n /**\n * Resolves a path, defaulting `pluginName` to the current plugin.\n */\n resolvePath: <TPathOptions = object>(params: Omit<ResolvePathParams<TPathOptions>, 'pluginName'> & { pluginName?: string }) => KubbFile.Path\n /**\n * Resolves the banner using the plugin's `output.banner` option.\n * Falls back to the default \"Generated by Kubb\" banner when `output.banner` is unset.\n * When `output.banner` is a function and no node is provided, returns the default banner.\n */\n resolveBanner: (node?: RootNode) => string | undefined\n /**\n * Resolves the footer using the plugin's `output.footer` option.\n * Returns `undefined` when no footer is configured.\n * When `output.footer` is a function and no node is provided, returns `undefined`.\n */\n resolveFooter: (node?: RootNode) => string | undefined\n}\n\n/**\n * Generates the default \"Generated by Kubb\" banner from node metadata.\n */\nfunction buildDefaultBanner({ title, description, version, config }: { title?: string; description?: string; version?: string; config: Config }): string {\n try {\n let source = ''\n if (Array.isArray(config.input)) {\n const first = config.input[0]\n if (first && 'path' in first) {\n source = path.basename(first.path)\n }\n } else if ('path' in config.input) {\n source = path.basename(config.input.path)\n } else if ('data' in config.input) {\n source = 'text content'\n }\n\n let banner = '/**\\n* Generated by Kubb (https://kubb.dev/).\\n* Do not edit manually.\\n'\n\n if (config.output.defaultBanner === 'simple') {\n banner += '*/\\n'\n return banner\n }\n\n if (source) {\n banner += `* Source: ${source}\\n`\n }\n\n if (title) {\n banner += `* Title: ${title}\\n`\n }\n\n if (description) {\n const formattedDescription = description.replace(/\\n/gm, '\\n* ')\n banner += `* Description: ${formattedDescription}\\n`\n }\n\n if (version) {\n banner += `* OpenAPI spec version: ${version}\\n`\n }\n\n banner += '*/\\n'\n return banner\n } catch (_error) {\n return '/**\\n* Generated by Kubb (https://kubb.dev/).\\n* Do not edit manually.\\n*/'\n }\n}\n\nexport function useKubb<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): UseKubbReturn<TOptions> {\n const { meta } = useFabric<{\n plugin: Plugin<TOptions>\n mode: KubbFile.Mode\n driver: PluginDriver\n }>()\n\n const config = meta.driver.config\n const defaultPluginName = meta.plugin.name\n\n const output = (\n meta.plugin.options as { output?: { banner?: string | ((node: RootNode) => string); footer?: string | ((node: RootNode) => string) } } | undefined\n )?.output\n\n return {\n plugin: meta.plugin as Plugin<TOptions>,\n mode: meta.mode,\n config,\n getPluginByName: (pluginName = defaultPluginName) => meta.driver.getPluginByName.call(meta.driver, pluginName),\n getFile: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.getFile.call(meta.driver, { pluginName, ...rest }),\n resolveName: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolveName.call(meta.driver, { pluginName, ...rest }),\n resolvePath: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolvePath.call(meta.driver, { pluginName, ...rest }),\n resolveBanner: (node?: RootNode) => {\n if (typeof output?.banner === 'function') {\n return node ? output.banner(node) : buildDefaultBanner({ config })\n }\n if (typeof output?.banner === 'string') {\n return output.banner\n }\n if (config.output.defaultBanner === false) {\n return undefined\n }\n return buildDefaultBanner({ config })\n },\n resolveFooter: (node?: RootNode) => {\n if (typeof output?.footer === 'function') {\n return node ? output.footer(node) : undefined\n }\n if (typeof output?.footer === 'string') {\n return output.footer\n }\n return undefined\n },\n }\n}\n","import type { KubbFile } from '@kubb/fabric-core/types'\nimport { useFabric } from '@kubb/react-fabric'\n\n/**\n * @deprecated use `useKubb` instead\n */\nexport function useMode(): KubbFile.Mode {\n const { meta } = useFabric<{ mode: KubbFile.Mode }>()\n\n return meta.mode\n}\n","import { useFabric } from '@kubb/react-fabric'\nimport type { Plugin, PluginFactoryOptions } from '../types.ts'\n\n/**\n * @deprecated use useKubb instead\n */\nexport function usePlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): Plugin<TOptions> {\n const { meta } = useFabric<{ plugin: Plugin<TOptions> }>()\n\n return meta.plugin\n}\n","import { useFabric } from '@kubb/react-fabric'\nimport type { PluginDriver } from '../PluginDriver.ts'\n\n/**\n * @deprecated use `useKubb` instead\n */\nexport function usePluginDriver(): PluginDriver {\n const { meta } = useFabric<{ driver: PluginDriver }>()\n\n return meta.driver\n}\n"],"mappings":";;;;;;;;;AAqDA,SAAS,mBAAmB,EAAE,OAAO,aAAa,SAAS,UAA8F;AACvJ,KAAI;EACF,IAAI,SAAS;AACb,MAAI,MAAM,QAAQ,OAAO,MAAM,EAAE;GAC/B,MAAM,QAAQ,OAAO,MAAM;AAC3B,OAAI,SAAS,UAAU,MACrB,UAASA,UAAAA,QAAK,SAAS,MAAM,KAAK;aAE3B,UAAU,OAAO,MAC1B,UAASA,UAAAA,QAAK,SAAS,OAAO,MAAM,KAAK;WAChC,UAAU,OAAO,MAC1B,UAAS;EAGX,IAAI,SAAS;AAEb,MAAI,OAAO,OAAO,kBAAkB,UAAU;AAC5C,aAAU;AACV,UAAO;;AAGT,MAAI,OACF,WAAU,aAAa,OAAO;AAGhC,MAAI,MACF,WAAU,YAAY,MAAM;AAG9B,MAAI,aAAa;GACf,MAAM,uBAAuB,YAAY,QAAQ,QAAQ,OAAO;AAChE,aAAU,kBAAkB,qBAAqB;;AAGnD,MAAI,QACF,WAAU,2BAA2B,QAAQ;AAG/C,YAAU;AACV,SAAO;UACA,QAAQ;AACf,SAAO;;;AAIX,SAAgB,UAAiG;CAC/G,MAAM,EAAE,UAAA,GAAA,mBAAA,YAIJ;CAEJ,MAAM,SAAS,KAAK,OAAO;CAC3B,MAAM,oBAAoB,KAAK,OAAO;CAEtC,MAAM,SACJ,KAAK,OAAO,SACX;AAEH,QAAO;EACL,QAAQ,KAAK;EACb,MAAM,KAAK;EACX;EACA,kBAAkB,aAAa,sBAAsB,KAAK,OAAO,gBAAgB,KAAK,KAAK,QAAQ,WAAW;EAC9G,UAAU,EAAE,aAAa,mBAAmB,GAAG,WAAW,KAAK,OAAO,QAAQ,KAAK,KAAK,QAAQ;GAAE;GAAY,GAAG;GAAM,CAAC;EACxH,cAAc,EAAE,aAAa,mBAAmB,GAAG,WAAW,KAAK,OAAO,YAAY,KAAK,KAAK,QAAQ;GAAE;GAAY,GAAG;GAAM,CAAC;EAChI,cAAc,EAAE,aAAa,mBAAmB,GAAG,WAAW,KAAK,OAAO,YAAY,KAAK,KAAK,QAAQ;GAAE;GAAY,GAAG;GAAM,CAAC;EAChI,gBAAgB,SAAoB;AAClC,OAAI,OAAO,QAAQ,WAAW,WAC5B,QAAO,OAAO,OAAO,OAAO,KAAK,GAAG,mBAAmB,EAAE,QAAQ,CAAC;AAEpE,OAAI,OAAO,QAAQ,WAAW,SAC5B,QAAO,OAAO;AAEhB,OAAI,OAAO,OAAO,kBAAkB,MAClC;AAEF,UAAO,mBAAmB,EAAE,QAAQ,CAAC;;EAEvC,gBAAgB,SAAoB;AAClC,OAAI,OAAO,QAAQ,WAAW,WAC5B,QAAO,OAAO,OAAO,OAAO,KAAK,GAAG,KAAA;AAEtC,OAAI,OAAO,QAAQ,WAAW,SAC5B,QAAO,OAAO;;EAInB;;;;;;;ACvIH,SAAgB,UAAyB;CACvC,MAAM,EAAE,UAAA,GAAA,mBAAA,YAA6C;AAErD,QAAO,KAAK;;;;;;;ACHd,SAAgB,YAA4F;CAC1G,MAAM,EAAE,UAAA,GAAA,mBAAA,YAAkD;AAE1D,QAAO,KAAK;;;;;;;ACHd,SAAgB,kBAAgC;CAC9C,MAAM,EAAE,UAAA,GAAA,mBAAA,YAA8C;AAEtD,QAAO,KAAK"}
|
package/dist/hooks.d.ts
CHANGED
|
@@ -1,15 +1,77 @@
|
|
|
1
1
|
import { t as __name } from "./chunk--u3MIqq1.js";
|
|
2
|
-
import {
|
|
2
|
+
import { E as ResolveNameParams, O as ResolvePathParams, _ as Plugin, c as Config, n as PluginDriver, t as GetFileOptions, y as PluginFactoryOptions } from "./PluginDriver-BkFepPdm.js";
|
|
3
|
+
import { RootNode } from "@kubb/ast/types";
|
|
3
4
|
import { KubbFile } from "@kubb/fabric-core/types";
|
|
4
5
|
|
|
6
|
+
//#region src/hooks/useKubb.d.ts
|
|
7
|
+
type ResolvePathOptions = {
|
|
8
|
+
pluginName?: string;
|
|
9
|
+
group?: {
|
|
10
|
+
tag?: string;
|
|
11
|
+
path?: string;
|
|
12
|
+
};
|
|
13
|
+
type?: ResolveNameParams['type'];
|
|
14
|
+
};
|
|
15
|
+
type UseKubbReturn<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
|
|
16
|
+
plugin: Plugin<TOptions>;
|
|
17
|
+
mode: KubbFile.Mode;
|
|
18
|
+
config: Config;
|
|
19
|
+
/**
|
|
20
|
+
* Returns the plugin whose `name` matches `pluginName`, defaulting to the current plugin.
|
|
21
|
+
*/
|
|
22
|
+
getPluginByName: (pluginName?: string) => Plugin | undefined;
|
|
23
|
+
/**
|
|
24
|
+
* Resolves a file reference, defaulting `pluginName` to the current plugin.
|
|
25
|
+
*/
|
|
26
|
+
getFile: (params: Omit<GetFileOptions<ResolvePathOptions>, 'pluginName'> & {
|
|
27
|
+
pluginName?: string;
|
|
28
|
+
}) => KubbFile.File<{
|
|
29
|
+
pluginName: string;
|
|
30
|
+
}>;
|
|
31
|
+
/**
|
|
32
|
+
* Resolves a name, defaulting `pluginName` to the current plugin.
|
|
33
|
+
*/
|
|
34
|
+
resolveName: (params: Omit<ResolveNameParams, 'pluginName'> & {
|
|
35
|
+
pluginName?: string;
|
|
36
|
+
}) => string;
|
|
37
|
+
/**
|
|
38
|
+
* Resolves a path, defaulting `pluginName` to the current plugin.
|
|
39
|
+
*/
|
|
40
|
+
resolvePath: <TPathOptions = object>(params: Omit<ResolvePathParams<TPathOptions>, 'pluginName'> & {
|
|
41
|
+
pluginName?: string;
|
|
42
|
+
}) => KubbFile.Path;
|
|
43
|
+
/**
|
|
44
|
+
* Resolves the banner using the plugin's `output.banner` option.
|
|
45
|
+
* Falls back to the default "Generated by Kubb" banner when `output.banner` is unset.
|
|
46
|
+
* When `output.banner` is a function and no node is provided, returns the default banner.
|
|
47
|
+
*/
|
|
48
|
+
resolveBanner: (node?: RootNode) => string | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* Resolves the footer using the plugin's `output.footer` option.
|
|
51
|
+
* Returns `undefined` when no footer is configured.
|
|
52
|
+
* When `output.footer` is a function and no node is provided, returns `undefined`.
|
|
53
|
+
*/
|
|
54
|
+
resolveFooter: (node?: RootNode) => string | undefined;
|
|
55
|
+
};
|
|
56
|
+
declare function useKubb<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): UseKubbReturn<TOptions>;
|
|
57
|
+
//#endregion
|
|
5
58
|
//#region src/hooks/useMode.d.ts
|
|
59
|
+
/**
|
|
60
|
+
* @deprecated use `useKubb` instead
|
|
61
|
+
*/
|
|
6
62
|
declare function useMode(): KubbFile.Mode;
|
|
7
63
|
//#endregion
|
|
8
64
|
//#region src/hooks/usePlugin.d.ts
|
|
65
|
+
/**
|
|
66
|
+
* @deprecated use useKubb instead
|
|
67
|
+
*/
|
|
9
68
|
declare function usePlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): Plugin<TOptions>;
|
|
10
69
|
//#endregion
|
|
11
|
-
//#region src/hooks/
|
|
12
|
-
|
|
70
|
+
//#region src/hooks/usePluginDriver.d.ts
|
|
71
|
+
/**
|
|
72
|
+
* @deprecated use `useKubb` instead
|
|
73
|
+
*/
|
|
74
|
+
declare function usePluginDriver(): PluginDriver;
|
|
13
75
|
//#endregion
|
|
14
|
-
export { useMode, usePlugin,
|
|
76
|
+
export { useKubb, useMode, usePlugin, usePluginDriver };
|
|
15
77
|
//# sourceMappingURL=hooks.d.ts.map
|
package/dist/hooks.js
CHANGED
|
@@ -1,23 +1,98 @@
|
|
|
1
1
|
import "./chunk--u3MIqq1.js";
|
|
2
|
-
import
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
import { useFabric } from "@kubb/react-fabric";
|
|
4
|
+
//#region src/hooks/useKubb.ts
|
|
5
|
+
/**
|
|
6
|
+
* Generates the default "Generated by Kubb" banner from node metadata.
|
|
7
|
+
*/
|
|
8
|
+
function buildDefaultBanner({ title, description, version, config }) {
|
|
9
|
+
try {
|
|
10
|
+
let source = "";
|
|
11
|
+
if (Array.isArray(config.input)) {
|
|
12
|
+
const first = config.input[0];
|
|
13
|
+
if (first && "path" in first) source = path.basename(first.path);
|
|
14
|
+
} else if ("path" in config.input) source = path.basename(config.input.path);
|
|
15
|
+
else if ("data" in config.input) source = "text content";
|
|
16
|
+
let banner = "/**\n* Generated by Kubb (https://kubb.dev/).\n* Do not edit manually.\n";
|
|
17
|
+
if (config.output.defaultBanner === "simple") {
|
|
18
|
+
banner += "*/\n";
|
|
19
|
+
return banner;
|
|
20
|
+
}
|
|
21
|
+
if (source) banner += `* Source: ${source}\n`;
|
|
22
|
+
if (title) banner += `* Title: ${title}\n`;
|
|
23
|
+
if (description) {
|
|
24
|
+
const formattedDescription = description.replace(/\n/gm, "\n* ");
|
|
25
|
+
banner += `* Description: ${formattedDescription}\n`;
|
|
26
|
+
}
|
|
27
|
+
if (version) banner += `* OpenAPI spec version: ${version}\n`;
|
|
28
|
+
banner += "*/\n";
|
|
29
|
+
return banner;
|
|
30
|
+
} catch (_error) {
|
|
31
|
+
return "/**\n* Generated by Kubb (https://kubb.dev/).\n* Do not edit manually.\n*/";
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
function useKubb() {
|
|
35
|
+
const { meta } = useFabric();
|
|
36
|
+
const config = meta.driver.config;
|
|
37
|
+
const defaultPluginName = meta.plugin.name;
|
|
38
|
+
const output = meta.plugin.options?.output;
|
|
39
|
+
return {
|
|
40
|
+
plugin: meta.plugin,
|
|
41
|
+
mode: meta.mode,
|
|
42
|
+
config,
|
|
43
|
+
getPluginByName: (pluginName = defaultPluginName) => meta.driver.getPluginByName.call(meta.driver, pluginName),
|
|
44
|
+
getFile: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.getFile.call(meta.driver, {
|
|
45
|
+
pluginName,
|
|
46
|
+
...rest
|
|
47
|
+
}),
|
|
48
|
+
resolveName: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolveName.call(meta.driver, {
|
|
49
|
+
pluginName,
|
|
50
|
+
...rest
|
|
51
|
+
}),
|
|
52
|
+
resolvePath: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolvePath.call(meta.driver, {
|
|
53
|
+
pluginName,
|
|
54
|
+
...rest
|
|
55
|
+
}),
|
|
56
|
+
resolveBanner: (node) => {
|
|
57
|
+
if (typeof output?.banner === "function") return node ? output.banner(node) : buildDefaultBanner({ config });
|
|
58
|
+
if (typeof output?.banner === "string") return output.banner;
|
|
59
|
+
if (config.output.defaultBanner === false) return;
|
|
60
|
+
return buildDefaultBanner({ config });
|
|
61
|
+
},
|
|
62
|
+
resolveFooter: (node) => {
|
|
63
|
+
if (typeof output?.footer === "function") return node ? output.footer(node) : void 0;
|
|
64
|
+
if (typeof output?.footer === "string") return output.footer;
|
|
65
|
+
}
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
//#endregion
|
|
3
69
|
//#region src/hooks/useMode.ts
|
|
70
|
+
/**
|
|
71
|
+
* @deprecated use `useKubb` instead
|
|
72
|
+
*/
|
|
4
73
|
function useMode() {
|
|
5
|
-
const { meta } =
|
|
74
|
+
const { meta } = useFabric();
|
|
6
75
|
return meta.mode;
|
|
7
76
|
}
|
|
8
77
|
//#endregion
|
|
9
78
|
//#region src/hooks/usePlugin.ts
|
|
79
|
+
/**
|
|
80
|
+
* @deprecated use useKubb instead
|
|
81
|
+
*/
|
|
10
82
|
function usePlugin() {
|
|
11
|
-
const { meta } =
|
|
83
|
+
const { meta } = useFabric();
|
|
12
84
|
return meta.plugin;
|
|
13
85
|
}
|
|
14
86
|
//#endregion
|
|
15
|
-
//#region src/hooks/
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
87
|
+
//#region src/hooks/usePluginDriver.ts
|
|
88
|
+
/**
|
|
89
|
+
* @deprecated use `useKubb` instead
|
|
90
|
+
*/
|
|
91
|
+
function usePluginDriver() {
|
|
92
|
+
const { meta } = useFabric();
|
|
93
|
+
return meta.driver;
|
|
19
94
|
}
|
|
20
95
|
//#endregion
|
|
21
|
-
export { useMode, usePlugin,
|
|
96
|
+
export { useKubb, useMode, usePlugin, usePluginDriver };
|
|
22
97
|
|
|
23
98
|
//# sourceMappingURL=hooks.js.map
|
package/dist/hooks.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.js","names":[],"sources":["../src/hooks/useMode.ts","../src/hooks/usePlugin.ts","../src/hooks/
|
|
1
|
+
{"version":3,"file":"hooks.js","names":[],"sources":["../src/hooks/useKubb.ts","../src/hooks/useMode.ts","../src/hooks/usePlugin.ts","../src/hooks/usePluginDriver.ts"],"sourcesContent":["import path from 'node:path'\nimport type { RootNode } from '@kubb/ast/types'\nimport type { KubbFile } from '@kubb/fabric-core/types'\nimport { useFabric } from '@kubb/react-fabric'\nimport type { GetFileOptions, PluginDriver } from '../PluginDriver.ts'\nimport type { Config, Plugin, PluginFactoryOptions, ResolveNameParams, ResolvePathParams } from '../types.ts'\n\ntype ResolvePathOptions = {\n pluginName?: string\n group?: {\n tag?: string\n path?: string\n }\n type?: ResolveNameParams['type']\n}\n\ntype UseKubbReturn<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {\n plugin: Plugin<TOptions>\n mode: KubbFile.Mode\n config: Config\n /**\n * Returns the plugin whose `name` matches `pluginName`, defaulting to the current plugin.\n */\n getPluginByName: (pluginName?: string) => Plugin | undefined\n /**\n * Resolves a file reference, defaulting `pluginName` to the current plugin.\n */\n getFile: (params: Omit<GetFileOptions<ResolvePathOptions>, 'pluginName'> & { pluginName?: string }) => KubbFile.File<{ pluginName: string }>\n /**\n * Resolves a name, defaulting `pluginName` to the current plugin.\n */\n resolveName: (params: Omit<ResolveNameParams, 'pluginName'> & { pluginName?: string }) => string\n /**\n * Resolves a path, defaulting `pluginName` to the current plugin.\n */\n resolvePath: <TPathOptions = object>(params: Omit<ResolvePathParams<TPathOptions>, 'pluginName'> & { pluginName?: string }) => KubbFile.Path\n /**\n * Resolves the banner using the plugin's `output.banner` option.\n * Falls back to the default \"Generated by Kubb\" banner when `output.banner` is unset.\n * When `output.banner` is a function and no node is provided, returns the default banner.\n */\n resolveBanner: (node?: RootNode) => string | undefined\n /**\n * Resolves the footer using the plugin's `output.footer` option.\n * Returns `undefined` when no footer is configured.\n * When `output.footer` is a function and no node is provided, returns `undefined`.\n */\n resolveFooter: (node?: RootNode) => string | undefined\n}\n\n/**\n * Generates the default \"Generated by Kubb\" banner from node metadata.\n */\nfunction buildDefaultBanner({ title, description, version, config }: { title?: string; description?: string; version?: string; config: Config }): string {\n try {\n let source = ''\n if (Array.isArray(config.input)) {\n const first = config.input[0]\n if (first && 'path' in first) {\n source = path.basename(first.path)\n }\n } else if ('path' in config.input) {\n source = path.basename(config.input.path)\n } else if ('data' in config.input) {\n source = 'text content'\n }\n\n let banner = '/**\\n* Generated by Kubb (https://kubb.dev/).\\n* Do not edit manually.\\n'\n\n if (config.output.defaultBanner === 'simple') {\n banner += '*/\\n'\n return banner\n }\n\n if (source) {\n banner += `* Source: ${source}\\n`\n }\n\n if (title) {\n banner += `* Title: ${title}\\n`\n }\n\n if (description) {\n const formattedDescription = description.replace(/\\n/gm, '\\n* ')\n banner += `* Description: ${formattedDescription}\\n`\n }\n\n if (version) {\n banner += `* OpenAPI spec version: ${version}\\n`\n }\n\n banner += '*/\\n'\n return banner\n } catch (_error) {\n return '/**\\n* Generated by Kubb (https://kubb.dev/).\\n* Do not edit manually.\\n*/'\n }\n}\n\nexport function useKubb<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): UseKubbReturn<TOptions> {\n const { meta } = useFabric<{\n plugin: Plugin<TOptions>\n mode: KubbFile.Mode\n driver: PluginDriver\n }>()\n\n const config = meta.driver.config\n const defaultPluginName = meta.plugin.name\n\n const output = (\n meta.plugin.options as { output?: { banner?: string | ((node: RootNode) => string); footer?: string | ((node: RootNode) => string) } } | undefined\n )?.output\n\n return {\n plugin: meta.plugin as Plugin<TOptions>,\n mode: meta.mode,\n config,\n getPluginByName: (pluginName = defaultPluginName) => meta.driver.getPluginByName.call(meta.driver, pluginName),\n getFile: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.getFile.call(meta.driver, { pluginName, ...rest }),\n resolveName: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolveName.call(meta.driver, { pluginName, ...rest }),\n resolvePath: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolvePath.call(meta.driver, { pluginName, ...rest }),\n resolveBanner: (node?: RootNode) => {\n if (typeof output?.banner === 'function') {\n return node ? output.banner(node) : buildDefaultBanner({ config })\n }\n if (typeof output?.banner === 'string') {\n return output.banner\n }\n if (config.output.defaultBanner === false) {\n return undefined\n }\n return buildDefaultBanner({ config })\n },\n resolveFooter: (node?: RootNode) => {\n if (typeof output?.footer === 'function') {\n return node ? output.footer(node) : undefined\n }\n if (typeof output?.footer === 'string') {\n return output.footer\n }\n return undefined\n },\n }\n}\n","import type { KubbFile } from '@kubb/fabric-core/types'\nimport { useFabric } from '@kubb/react-fabric'\n\n/**\n * @deprecated use `useKubb` instead\n */\nexport function useMode(): KubbFile.Mode {\n const { meta } = useFabric<{ mode: KubbFile.Mode }>()\n\n return meta.mode\n}\n","import { useFabric } from '@kubb/react-fabric'\nimport type { Plugin, PluginFactoryOptions } from '../types.ts'\n\n/**\n * @deprecated use useKubb instead\n */\nexport function usePlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): Plugin<TOptions> {\n const { meta } = useFabric<{ plugin: Plugin<TOptions> }>()\n\n return meta.plugin\n}\n","import { useFabric } from '@kubb/react-fabric'\nimport type { PluginDriver } from '../PluginDriver.ts'\n\n/**\n * @deprecated use `useKubb` instead\n */\nexport function usePluginDriver(): PluginDriver {\n const { meta } = useFabric<{ driver: PluginDriver }>()\n\n return meta.driver\n}\n"],"mappings":";;;;;;;AAqDA,SAAS,mBAAmB,EAAE,OAAO,aAAa,SAAS,UAA8F;AACvJ,KAAI;EACF,IAAI,SAAS;AACb,MAAI,MAAM,QAAQ,OAAO,MAAM,EAAE;GAC/B,MAAM,QAAQ,OAAO,MAAM;AAC3B,OAAI,SAAS,UAAU,MACrB,UAAS,KAAK,SAAS,MAAM,KAAK;aAE3B,UAAU,OAAO,MAC1B,UAAS,KAAK,SAAS,OAAO,MAAM,KAAK;WAChC,UAAU,OAAO,MAC1B,UAAS;EAGX,IAAI,SAAS;AAEb,MAAI,OAAO,OAAO,kBAAkB,UAAU;AAC5C,aAAU;AACV,UAAO;;AAGT,MAAI,OACF,WAAU,aAAa,OAAO;AAGhC,MAAI,MACF,WAAU,YAAY,MAAM;AAG9B,MAAI,aAAa;GACf,MAAM,uBAAuB,YAAY,QAAQ,QAAQ,OAAO;AAChE,aAAU,kBAAkB,qBAAqB;;AAGnD,MAAI,QACF,WAAU,2BAA2B,QAAQ;AAG/C,YAAU;AACV,SAAO;UACA,QAAQ;AACf,SAAO;;;AAIX,SAAgB,UAAiG;CAC/G,MAAM,EAAE,SAAS,WAIb;CAEJ,MAAM,SAAS,KAAK,OAAO;CAC3B,MAAM,oBAAoB,KAAK,OAAO;CAEtC,MAAM,SACJ,KAAK,OAAO,SACX;AAEH,QAAO;EACL,QAAQ,KAAK;EACb,MAAM,KAAK;EACX;EACA,kBAAkB,aAAa,sBAAsB,KAAK,OAAO,gBAAgB,KAAK,KAAK,QAAQ,WAAW;EAC9G,UAAU,EAAE,aAAa,mBAAmB,GAAG,WAAW,KAAK,OAAO,QAAQ,KAAK,KAAK,QAAQ;GAAE;GAAY,GAAG;GAAM,CAAC;EACxH,cAAc,EAAE,aAAa,mBAAmB,GAAG,WAAW,KAAK,OAAO,YAAY,KAAK,KAAK,QAAQ;GAAE;GAAY,GAAG;GAAM,CAAC;EAChI,cAAc,EAAE,aAAa,mBAAmB,GAAG,WAAW,KAAK,OAAO,YAAY,KAAK,KAAK,QAAQ;GAAE;GAAY,GAAG;GAAM,CAAC;EAChI,gBAAgB,SAAoB;AAClC,OAAI,OAAO,QAAQ,WAAW,WAC5B,QAAO,OAAO,OAAO,OAAO,KAAK,GAAG,mBAAmB,EAAE,QAAQ,CAAC;AAEpE,OAAI,OAAO,QAAQ,WAAW,SAC5B,QAAO,OAAO;AAEhB,OAAI,OAAO,OAAO,kBAAkB,MAClC;AAEF,UAAO,mBAAmB,EAAE,QAAQ,CAAC;;EAEvC,gBAAgB,SAAoB;AAClC,OAAI,OAAO,QAAQ,WAAW,WAC5B,QAAO,OAAO,OAAO,OAAO,KAAK,GAAG,KAAA;AAEtC,OAAI,OAAO,QAAQ,WAAW,SAC5B,QAAO,OAAO;;EAInB;;;;;;;ACvIH,SAAgB,UAAyB;CACvC,MAAM,EAAE,SAAS,WAAoC;AAErD,QAAO,KAAK;;;;;;;ACHd,SAAgB,YAA4F;CAC1G,MAAM,EAAE,SAAS,WAAyC;AAE1D,QAAO,KAAK;;;;;;;ACHd,SAAgB,kBAAgC;CAC9C,MAAM,EAAE,SAAS,WAAqC;AAEtD,QAAO,KAAK"}
|