@kubb/core 5.0.0-alpha.20 → 5.0.0-alpha.21

package/dist/hooks.d.ts

@@ -1,94 +1,21 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
-import { b as PluginFactoryOptions, j as ResolvePathParams, k as ResolveNameParams, l as Config, n as PluginDriver, t as GetFileOptions, v as Plugin } from "./PluginDriver-BkSenc-R.js";
-import { RootNode } from "@kubb/ast/types";
+import { C as PluginFactoryOptions, t as PluginDriver, x as Plugin } from "./PluginDriver-CEQPafXV.js";
 import { KubbFile } from "@kubb/fabric-core/types";
 
-//#region src/hooks/useKubb.d.ts
-type ResolvePathOptions = {
-  pluginName?: string;
-  group?: {
-    tag?: string;
-    path?: string;
-  };
-  type?: ResolveNameParams['type'];
-};
-type UseKubbReturn<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
-  plugin: Plugin<TOptions>;
-  mode: KubbFile.Mode;
-  config: Config;
-  /**
-   * Returns the plugin whose `name` matches `pluginName`, defaulting to the current plugin.
-   */
-  getPluginByName: (pluginName?: string) => Plugin | undefined;
-  /**
-   * Resolves a file reference, defaulting `pluginName` to the current plugin.
-   */
-  getFile: (params: Omit<GetFileOptions<ResolvePathOptions>, 'pluginName'> & {
-    pluginName?: string;
-  }) => KubbFile.File<{
-    pluginName: string;
-  }>;
-  /**
-   * Resolves a name, defaulting `pluginName` to the current plugin.
-   * @deprecated user `resolver` from options instead
-   */
-  resolveName: (params: Omit<ResolveNameParams, 'pluginName'> & {
-    pluginName?: string;
-  }) => string;
-  /**
-   * Resolves a path, defaulting `pluginName` to the current plugin.
-   */
-  resolvePath: <TPathOptions = object>(params: Omit<ResolvePathParams<TPathOptions>, 'pluginName'> & {
-    pluginName?: string;
-  }) => KubbFile.Path;
-  /**
-   * Resolves the banner using the plugin's `output.banner` option.
-   * Falls back to the default "Generated by Kubb" banner when `output.banner` is unset.
-   * When `output.banner` is a function and no node is provided, returns the default banner.
-   */
-  resolveBanner: (node?: RootNode) => string | undefined;
-  /**
-   * Resolves the footer using the plugin's `output.footer` option.
-   * Returns `undefined` when no footer is configured.
-   * When `output.footer` is a function and no node is provided, returns `undefined`.
-   */
-  resolveFooter: (node?: RootNode) => string | undefined;
-};
-/**
- * React-Fabric hook that exposes the current plugin context inside a generator component.
- *
- * Returns the active `plugin`, `mode`, `config`, and a set of resolver helpers
- * (`getFile`, `resolveName`, `resolvePath`, `resolveBanner`, `resolveFooter`) that
- * all default to the current plugin when no explicit `pluginName` is provided.
- *
- * @example
- * ```ts
- * function Operation({ node }: OperationProps) {
- *   const { config, resolvePath } = useKubb()
- *   const filePath = resolvePath({ baseName: node.operationId })
- *   return <File path={filePath}>...</File>
- * }
- * ```
- */
-declare function useKubb<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): UseKubbReturn<TOptions>;
+//#region src/hooks/useDriver.d.ts
+declare function useDriver(): PluginDriver;
 //#endregion
 //#region src/hooks/useMode.d.ts
 /**
- * @deprecated use `useKubb` instead
+ * @deprecated use `mode` from the generator component props instead
  */
 declare function useMode(): KubbFile.Mode;
 //#endregion
 //#region src/hooks/usePlugin.d.ts
 /**
- * @deprecated use useKubb instead
+ * @deprecated use `plugin` from the generator component props instead
  */
 declare function usePlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): Plugin<TOptions>;
 //#endregion
-//#region src/hooks/usePluginDriver.d.ts
-/**
- * @deprecated use `useKubb` instead
- */
-declare function usePluginDriver(): PluginDriver;
-//#endregion
-export { useKubb, useMode, usePlugin, usePluginDriver };
+export { useDriver, useMode, usePlugin };
 //# sourceMappingURL=hooks.d.ts.map

package/dist/hooks.js

@@ -1,90 +1,14 @@
 import "./chunk--u3MIqq1.js";
-import path from "node:path";
 import { useFabric } from "@kubb/react-fabric";
-//#region src/hooks/useKubb.ts
-/**
-* Generates the default "Generated by Kubb" banner from node metadata.
-*/
-function buildDefaultBanner({ title, description, version, config }) {
-	try {
-		let source = "";
-		if (Array.isArray(config.input)) {
-			const first = config.input[0];
-			if (first && "path" in first) source = path.basename(first.path);
-		} else if ("path" in config.input) source = path.basename(config.input.path);
-		else if ("data" in config.input) source = "text content";
-		let banner = "/**\n* Generated by Kubb (https://kubb.dev/).\n* Do not edit manually.\n";
-		if (config.output.defaultBanner === "simple") {
-			banner += "*/\n";
-			return banner;
-		}
-		if (source) banner += `* Source: ${source}\n`;
-		if (title) banner += `* Title: ${title}\n`;
-		if (description) {
-			const formattedDescription = description.replace(/\n/gm, "\n* ");
-			banner += `* Description: ${formattedDescription}\n`;
-		}
-		if (version) banner += `* OpenAPI spec version: ${version}\n`;
-		banner += "*/\n";
-		return banner;
-	} catch (_error) {
-		return "/**\n* Generated by Kubb (https://kubb.dev/).\n* Do not edit manually.\n*/";
-	}
-}
-/**
-* React-Fabric hook that exposes the current plugin context inside a generator component.
-*
-* Returns the active `plugin`, `mode`, `config`, and a set of resolver helpers
-* (`getFile`, `resolveName`, `resolvePath`, `resolveBanner`, `resolveFooter`) that
-* all default to the current plugin when no explicit `pluginName` is provided.
-*
-* @example
-* ```ts
-* function Operation({ node }: OperationProps) {
-*   const { config, resolvePath } = useKubb()
-*   const filePath = resolvePath({ baseName: node.operationId })
-*   return <File path={filePath}>...</File>
-* }
-* ```
-*/
-function useKubb() {
+//#region src/hooks/useDriver.ts
+function useDriver() {
 	const { meta } = useFabric();
-	const config = meta.driver.config;
-	const defaultPluginName = meta.plugin.name;
-	const output = meta.plugin.options?.output;
-	return {
-		plugin: meta.plugin,
-		mode: meta.mode,
-		config,
-		getPluginByName: (pluginName = defaultPluginName) => meta.driver.getPluginByName.call(meta.driver, pluginName),
-		getFile: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.getFile.call(meta.driver, {
-			pluginName,
-			...rest
-		}),
-		resolveName: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolveName.call(meta.driver, {
-			pluginName,
-			...rest
-		}),
-		resolvePath: ({ pluginName = defaultPluginName, ...rest }) => meta.driver.resolvePath.call(meta.driver, {
-			pluginName,
-			...rest
-		}),
-		resolveBanner: (node) => {
-			if (typeof output?.banner === "function") return node ? output.banner(node) : buildDefaultBanner({ config });
-			if (typeof output?.banner === "string") return output.banner;
-			if (config.output.defaultBanner === false) return;
-			return buildDefaultBanner({ config });
-		},
-		resolveFooter: (node) => {
-			if (typeof output?.footer === "function") return node ? output.footer(node) : void 0;
-			if (typeof output?.footer === "string") return output.footer;
-		}
-	};
+	return meta.driver;
 }
 //#endregion
 //#region src/hooks/useMode.ts
 /**
-* @deprecated use `useKubb` instead
+* @deprecated use `mode` from the generator component props instead
 */
 function useMode() {
 	const { meta } = useFabric();
@@ -93,22 +17,13 @@ function useMode() {
 //#endregion
 //#region src/hooks/usePlugin.ts
 /**
-* @deprecated use useKubb instead
+* @deprecated use `plugin` from the generator component props instead
 */
 function usePlugin() {
 	const { meta } = useFabric();
 	return meta.plugin;
 }
 //#endregion
-//#region src/hooks/usePluginDriver.ts
-/**
-* @deprecated use `useKubb` instead
-*/
-function usePluginDriver() {
-	const { meta } = useFabric();
-	return meta.driver;
-}
-//#endregion
-export { useKubb, useMode, usePlugin, usePluginDriver };
+export { useDriver, useMode, usePlugin };
 
 //# sourceMappingURL=hooks.js.map

package/dist/hooks.js.map

@@ -1 +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   * @deprecated user `resolver` from options instead\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\n/**\n * React-Fabric hook that exposes the current plugin context inside a generator component.\n *\n * Returns the active `plugin`, `mode`, `config`, and a set of resolver helpers\n * (`getFile`, `resolveName`, `resolvePath`, `resolveBanner`, `resolveFooter`) that\n * all default to the current plugin when no explicit `pluginName` is provided.\n *\n * @example\n * ```ts\n * function Operation({ node }: OperationProps) {\n *   const { config, resolvePath } = useKubb()\n *   const filePath = resolvePath({ baseName: node.operationId })\n *   return <File path={filePath}>...</File>\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":";;;;;;;AAsDA,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;;;;;;;;;;;;;;;;;;;AAoBX,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;;;;;;;ACxJH,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"}
+{"version":3,"file":"hooks.js","names":[],"sources":["../src/hooks/useDriver.ts","../src/hooks/useMode.ts","../src/hooks/usePlugin.ts"],"sourcesContent":["import { useFabric } from '@kubb/react-fabric'\nimport type { PluginDriver } from '../PluginDriver.ts'\n\nexport function useDriver(): PluginDriver {\n  const { meta } = useFabric<{ driver: PluginDriver }>()\n\n  return meta.driver\n}\n","import type { KubbFile } from '@kubb/fabric-core/types'\nimport { useFabric } from '@kubb/react-fabric'\n\n/**\n * @deprecated use `mode` from the generator component props 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 `plugin` from the generator component props 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"],"mappings":";;;AAGA,SAAgB,YAA0B;CACxC,MAAM,EAAE,SAAS,WAAqC;AAEtD,QAAO,KAAK;;;;;;;ACAd,SAAgB,UAAyB;CACvC,MAAM,EAAE,SAAS,WAAoC;AAErD,QAAO,KAAK;;;;;;;ACHd,SAAgB,YAA4F;CAC1G,MAAM,EAAE,SAAS,WAAyC;AAE1D,QAAO,KAAK"}