@kubb/core 1.2.1 → 1.2.3

package/dist/index.d.ts

@@ -27,7 +27,7 @@ interface Cache<TStore extends object = object> {
     has(id: keyof TStore): boolean;
     set(id: keyof TStore, value: unknown): void;
 }
-declare function createPluginCache<TStore extends Record<string, [number, unknown]>>(Store: TStore): Cache<TStore>;
+declare function createPluginCache<TStore extends PluginCache>(Store?: TStore): Cache<TStore>;
 
 declare function getRelativePath(rootDir?: string | null, filePath?: string | null, platform?: 'windows' | 'mac' | 'linux'): string;
 type PathMode = 'file' | 'directory';
@@ -48,7 +48,7 @@ declare function objectToParameters(data: Data, options?: Options$2): string;
 
 declare function nameSorter<T extends {
     name: string;
-}>(a: T, b: T): 1 | -1 | 0;
+}>(a: T, b: T): 0 | 1 | -1;
 
 declare function createJSDocBlockText({ comments }: {
     comments: Array<string>;
@@ -95,7 +95,7 @@ declare class TreeNode<T = unknown> {
     static build<T = unknown>(path: string, options?: TreeNodeOptions): TreeNode<T> | null;
 }
 
-declare function transformReservedWord(word?: string | null): string | null | undefined;
+declare function transformReservedWord(word: string): string;
 
 declare function getStackTrace(belowFn?: Function): NodeJS.CallSite[];
 
@@ -138,6 +138,43 @@ declare const defaultColours: readonly ["black", "blue", "darkBlue", "cyan", "gr
 declare function randomColour(text?: string, colours?: readonly ["black", "blue", "darkBlue", "cyan", "gray", "green", "darkGreen", "magenta", "red", "darkRed", "yellow", "darkYellow"]): string;
 declare function randomPicoColour(text?: string, colors?: readonly ["black", "blue", "darkBlue", "cyan", "gray", "green", "darkGreen", "magenta", "red", "darkRed", "yellow", "darkYellow"]): string;
 
+declare class URLPath {
+    path: string;
+    constructor(path: string);
+    /**
+     * Convert Swagger path to URLPath(syntax of Express)
+     * @example /pet/{petId} => /pet/:petId
+     */
+    get URL(): string;
+    /**
+     * Convert Swagger path to template literals/ template strings(camelcase)
+     * @example /pet/{petId} => `/pet/${petId}`
+     * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
+     * @example /account/userID => `/account/${userId}`
+     */
+    get template(): string;
+    /**
+     * Convert Swagger path to template literals/ template strings(camelcase)
+     * @example /pet/{petId} => `/pet/${petId}`
+     * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
+     * @example /account/userID => `/account/${userId}`
+     */
+    toTemplateString(): string;
+    /**
+     * Convert Swagger path to template literals/ template strings(camelcase)
+     * @example /pet/{petId} => `/pet/${petId}`
+     * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
+     * @example /account/userID => `/account/${userId}`
+     */
+    static toTemplateString(path: string): string;
+    /**
+     * Convert Swagger path to URLPath(syntax of Express)
+     * @example /pet/{petId} => /pet/:petId
+     */
+    toURLPath(): string;
+    static toURLPath(path: string): string;
+}
+
 type Import = {
     name: string | string[];
     path: string;
@@ -230,7 +267,7 @@ type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseRe
     plugin: KubbPlugin;
 };
 
-declare const hooks: [keyof PluginLifecycle<PluginFactoryOptions<string, unknown, false, any, Record<string, any>>>];
+declare const hooks: [keyof PluginLifecycle<PluginFactoryOptions<string, unknown, false, any, Record<string, unknown>>>];
 type Options$1 = {
     debug?: boolean;
     task: QueueTask<ResolvedFile>;
@@ -247,8 +284,8 @@ declare class PluginManager {
     logger: Logger;
     constructor(config: KubbConfig, options: Options$1);
     resolvePath: (params: ResolvePathParams) => OptionalPath;
-    resolveName: (params: ResolveNameParams) => string | null;
-    load: (id: string) => Promise<SafeParseResult<"load">>;
+    resolveName: (params: ResolveNameParams) => string;
+    load: (id: string) => Promise<SafeParseResult<'load'>>;
     /**
      *
      * Run only hook for a specific plugin name
@@ -448,10 +485,6 @@ type CLIOptions = {
      * Watch changes on input
      */
     watch?: string;
-    /**
-     * Override `input` defined in `kubb.config.js`
-     */
-    input?: string;
     /**
      * Override `logLevel` defined in `kubb.config.js`
      * @default `'silent'`
@@ -513,7 +546,7 @@ type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
      */
     api?: TOptions['api'];
 } & Partial<PluginLifecycle<TOptions>>;
-type PluginFactoryOptions<Name = string, Options = unknown, Nested extends boolean = false, API = any, resolvePathOptions = Record<string, any>> = {
+type PluginFactoryOptions<Name = string, Options = unknown, Nested extends boolean = false, API = any, resolvePathOptions = Record<string, unknown>> = {
     name: Name;
     options: Options;
     nested: Nested;
@@ -567,7 +600,8 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
     buildEnd: (this: PluginContext) => PossiblePromise<void>;
 };
 type PluginLifecycleHooks = keyof PluginLifecycle;
-type ResolvePathParams<TOptions = Record<string, any>> = {
+type PluginCache = Record<string, [number, unknown]>;
+type ResolvePathParams<TOptions = Record<string, unknown>> = {
     /**
      * When set, resolvePath will only call resolvePath of the name of the plugin set here.
      * If not defined it will fall back on the resolvePath of the core plugin.
@@ -588,13 +622,13 @@ type ResolveNameParams = {
     pluginName?: string;
     name: string;
 };
-type PluginContext<TOptions = Record<string, any>> = {
+type PluginContext<TOptions = Record<string, unknown>> = {
     config: KubbConfig;
-    cache: Cache;
+    cache: Cache<PluginCache>;
     fileManager: FileManager;
     addFile: (...file: File[]) => Promise<File[]>;
     resolvePath: (params: ResolvePathParams<TOptions>) => OptionalPath;
-    resolveName: (params: ResolveNameParams) => string | null | undefined;
+    resolveName: (params: ResolveNameParams) => string;
     load: (id: string) => Promise<SafeParseResult<'load'>>;
     logger: Logger;
 };
@@ -627,10 +661,12 @@ declare function build(options: BuildOptions): Promise<BuildOutput>;
  * accepts a direct {@link KubbConfig} object, or a function that returns it.
  * The function receives a {@link ConfigEnv} object that exposes two properties:
  */
-declare const defineConfig: (options: PossiblePromise<KubbUserConfig> | ((cliOptions: CLIOptions) => PossiblePromise<KubbUserConfig>)) => PossiblePromise<KubbUserConfig> | ((cliOptions: CLIOptions) => PossiblePromise<KubbUserConfig>);
+declare function defineConfig(options: PossiblePromise<KubbUserConfig> | ((
+/** The options derived from the CLI flags */
+cliOptions: CLIOptions) => PossiblePromise<KubbUserConfig>)): typeof options;
 
 type KubbPluginFactory<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => T['nested'] extends true ? Array<KubbUserPlugin<T>> : KubbUserPlugin<T>;
-declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(factory: KubbPluginFactory<T>): (options: T['options']) => T["nested"] extends true ? KubbUserPlugin<T>[] : KubbUserPlugin<T>;
+declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(factory: KubbPluginFactory<T>): (options: T['options']) => ReturnType<KubbPluginFactory<T>>;
 type Options = {
     config: PluginContext['config'];
     fileManager: FileManager;
@@ -660,4 +696,4 @@ declare abstract class SchemaGenerator<TOptions extends object, TInput, TOutput>
     abstract build(schema: TInput, name: string, description?: string): TOutput;
 }
 
-export { Argument0, BuildOutput, CLIOptions, Cache, CorePluginOptions, Executer, Extension, File, FileManager, FileName, Generator, KubbConfig, KubbJSONPlugins, KubbObjectPlugin, KubbObjectPlugins, KubbPlugin, KubbPluginKind, KubbUserConfig, KubbUserPlugin, LogLevel, LogLevels, LogType, Logger, OnExecute, OptionalPath, ParallelPluginError, ParseResult, Path, PathMode, PluginContext, PluginError, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, PossiblePromise, Queue, QueueTask, Register, ResolveNameParams, ResolvePathParams, ResolvedFile, SafeParseResult, SchemaGenerator, Source, Status, Strategy, SummaryError, TransformResult, TreeNode, TreeNodeOptions, UUID, ValidationPluginError, Warning, build, canLogHierarchy, clean, combineFiles, createJSDocBlockText, createLogger, createPlugin, createPluginCache, build as default, defaultColours, defineConfig, extensions, getEncodedText, getFileSource, getLocation, getPathMode, getRelativePath, getStackTrace, getUniqueName, hooks, importModule, isPromise, isPromiseFulfilledResult, isPromiseRejectedResult, isURL, pluginName as name, nameSorter, normalizeDirectory, objectToParameters, pluginName, randomColour, randomPicoColour, read, renderTemplate, throttle, timeout, transformReservedWord, uniqueId, validatePlugins, write, writeIndexes };
+export { Argument0, BuildOutput, CLIOptions, Cache, CorePluginOptions, Executer, Extension, File, FileManager, FileName, Generator, KubbConfig, KubbJSONPlugins, KubbObjectPlugin, KubbObjectPlugins, KubbPlugin, KubbPluginKind, KubbUserConfig, KubbUserPlugin, LogLevel, LogLevels, LogType, Logger, OnExecute, OptionalPath, ParallelPluginError, ParseResult, Path, PathMode, PluginCache, PluginContext, PluginError, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, PossiblePromise, Queue, QueueTask, Register, ResolveNameParams, ResolvePathParams, ResolvedFile, SafeParseResult, SchemaGenerator, Source, Status, Strategy, SummaryError, TransformResult, TreeNode, TreeNodeOptions, URLPath, UUID, ValidationPluginError, Warning, build, canLogHierarchy, clean, combineFiles, createJSDocBlockText, createLogger, createPlugin, createPluginCache, build as default, defaultColours, defineConfig, extensions, getEncodedText, getFileSource, getLocation, getPathMode, getRelativePath, getStackTrace, getUniqueName, hooks, importModule, isPromise, isPromiseFulfilledResult, isPromiseRejectedResult, isURL, pluginName as name, nameSorter, normalizeDirectory, objectToParameters, pluginName, randomColour, randomPicoColour, read, renderTemplate, throttle, timeout, transformReservedWord, uniqueId, validatePlugins, write, writeIndexes };

package/dist/index.js

@@ -8,7 +8,7 @@ import { rimraf } from 'rimraf';
 import dirTree from 'directory-tree';
 import mod from 'node:module';
 import { pathToFileURL } from 'node:url';
-import pc2 from 'picocolors';
+import pc3 from 'picocolors';
 export { default as pc } from 'picocolors';
 import seedrandom from 'seedrandom';
 import { createImportDeclaration, print, createExportDeclaration } from '@kubb/ts-codegen';
@@ -44,7 +44,7 @@ async function write(data, path) {
 }
 
 // src/utils/cache.ts
-function createPluginCache(Store) {
+function createPluginCache(Store = /* @__PURE__ */ Object.create(null)) {
   return {
     set(id, value) {
       Store[id] = [0, value];
@@ -506,7 +506,7 @@ function createLogger(spinner) {
   };
   const warn = (message) => {
     if (message && spinner) {
-      spinner.warn(pc2.yellow(message));
+      spinner.warn(pc3.yellow(message));
     }
   };
   const info = (message) => {
@@ -539,7 +539,7 @@ function randomColour(text, colours = defaultColours) {
   return colour;
 }
 function randomPicoColour(text, colors = defaultColours) {
-  const colours = pc2.createColors(true);
+  const colours = pc3.createColors(true);
   if (!text) {
     return colours.white(text);
   }
@@ -548,13 +548,72 @@ function randomPicoColour(text, colors = defaultColours) {
   const key = colour.replace("dark", "").toLowerCase();
   const formatter = colours[key];
   if (isDark) {
-    return pc2.bold(formatter(text));
+    return pc3.bold(formatter(text));
   }
   if (typeof formatter !== "function") {
     throw new Error("Formatter for picoColor is not of type function/Formatter");
   }
   return formatter(text);
 }
+var URLPath = class {
+  path;
+  constructor(path) {
+    this.path = path;
+  }
+  /**
+   * Convert Swagger path to URLPath(syntax of Express)
+   * @example /pet/{petId} => /pet/:petId
+   */
+  get URL() {
+    return this.toURLPath();
+  }
+  /**
+   * Convert Swagger path to template literals/ template strings(camelcase)
+   * @example /pet/{petId} => `/pet/${petId}`
+   * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
+   * @example /account/userID => `/account/${userId}`
+   */
+  get template() {
+    return this.toTemplateString();
+  }
+  /**
+   * Convert Swagger path to template literals/ template strings(camelcase)
+   * @example /pet/{petId} => `/pet/${petId}`
+   * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
+   * @example /account/userID => `/account/${userId}`
+   */
+  toTemplateString() {
+    return URLPath.toTemplateString(this.path);
+  }
+  /**
+   * Convert Swagger path to template literals/ template strings(camelcase)
+   * @example /pet/{petId} => `/pet/${petId}`
+   * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
+   * @example /account/userID => `/account/${userId}`
+   */
+  static toTemplateString(path) {
+    const regex = /{(\w|-)*}/g;
+    const found = path.match(regex);
+    let newPath = path.replaceAll("{", "${");
+    if (found) {
+      newPath = found.reduce((prev, curr) => {
+        const replacement = `\${${camelCase(curr, { delimiter: "", transform: camelCaseTransformMerge })}}`;
+        return prev.replace(curr, replacement);
+      }, path);
+    }
+    return `\`${newPath}\``;
+  }
+  /**
+   * Convert Swagger path to URLPath(syntax of Express)
+   * @example /pet/{petId} => /pet/:petId
+   */
+  toURLPath() {
+    return URLPath.toURLPath(this.path);
+  }
+  static toURLPath(path) {
+    return path.replaceAll("{", ":").replaceAll("}", "");
+  }
+};
 function writeIndexes(root, options = {}) {
   const tree = TreeNode.build(root, { extensions: /\.ts/, ...options });
   if (!tree) {
@@ -870,7 +929,7 @@ var definePlugin = createPlugin((options) => {
           return transformReservedWord(name);
         },
         load,
-        cache: createPluginCache(/* @__PURE__ */ Object.create(null))
+        cache: createPluginCache()
       };
     },
     resolvePath(fileName) {
@@ -990,7 +1049,7 @@ var PluginManager = class {
         pluginName: params.pluginName,
         hookName: "resolveName",
         parameters: [params.name]
-      });
+      }) || params.name;
     }
     return this.hookFirstSync({
       hookName: "resolveName",
@@ -1309,7 +1368,12 @@ async function build(options) {
       await read(config.input.path);
     }
   } catch (e) {
-    throw new Error("Cannot read file/URL defined in `input.path` or set with --input in the CLI of your Kubb config", { cause: e });
+    throw new Error(
+      "Cannot read file/URL defined in `input.path` or set with `kubb generate PATH` in the CLI of your Kubb config " + pc3.dim(config.input.path),
+      {
+        cause: e
+      }
+    );
   }
   if (config.output.clean) {
     await clean(config.output.path);
@@ -1357,9 +1421,9 @@ async function build(options) {
     if (config.logLevel === LogLevel.stacktrace && logger?.spinner && input) {
       logger.info(messsage);
       const logs = [
-        input && `${pc2.bgWhite(`Input`)} ${randomPicoColour(plugin.name)} ${hookName}`,
+        input && `${pc3.bgWhite(`Input`)} ${randomPicoColour(plugin.name)} ${hookName}`,
         JSON.stringify(input, void 0, 2),
-        output && `${pc2.bgWhite("Output")} ${randomPicoColour(plugin.name)} ${hookName}`,
+        output && `${pc3.bgWhite("Output")} ${randomPicoColour(plugin.name)} ${hookName}`,
         output
       ].filter(Boolean);
       console.log(logs.join("\n"));
@@ -1380,7 +1444,9 @@ async function build(options) {
 }
 
 // src/config.ts
-var defineConfig = (options) => options;
+function defineConfig(options) {
+  return options;
+}
 
 // src/generators/Generator.ts
 var Generator = class {
@@ -1406,6 +1472,6 @@ var SchemaGenerator = class extends Generator {
 // src/index.ts
 var src_default = build;
 
-export { FileManager, Generator, LogLevel, ParallelPluginError, PluginError, PluginManager, Queue, SchemaGenerator, SummaryError, TreeNode, ValidationPluginError, Warning, build, canLogHierarchy, clean, combineFiles, createJSDocBlockText, createLogger, createPlugin, createPluginCache, src_default as default, defaultColours, defineConfig, extensions, getEncodedText, getFileSource, getLocation, getPathMode, getRelativePath, getStackTrace, getUniqueName, hooks, importModule, isPromise, isPromiseFulfilledResult, isPromiseRejectedResult, isURL, pluginName as name, nameSorter, normalizeDirectory, objectToParameters, pluginName, randomColour, randomPicoColour, read, renderTemplate, throttle, timeout, transformReservedWord, uniqueId, validatePlugins, write, writeIndexes };
+export { FileManager, Generator, LogLevel, ParallelPluginError, PluginError, PluginManager, Queue, SchemaGenerator, SummaryError, TreeNode, URLPath, ValidationPluginError, Warning, build, canLogHierarchy, clean, combineFiles, createJSDocBlockText, createLogger, createPlugin, createPluginCache, src_default as default, defaultColours, defineConfig, extensions, getEncodedText, getFileSource, getLocation, getPathMode, getRelativePath, getStackTrace, getUniqueName, hooks, importModule, isPromise, isPromiseFulfilledResult, isPromiseRejectedResult, isURL, pluginName as name, nameSorter, normalizeDirectory, objectToParameters, pluginName, randomColour, randomPicoColour, read, renderTemplate, throttle, timeout, transformReservedWord, uniqueId, validatePlugins, write, writeIndexes };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map