@kubb/core 1.2.2 → 1.2.4

package/dist/index.d.ts

@@ -34,8 +34,6 @@ type PathMode = 'file' | 'directory';
 declare function getPathMode(path: string | undefined | null): PathMode;
 declare function read(path: string): Promise<string>;
 
-declare function isURL(data: string): boolean;
-
 type Data = string[][];
 type Options$2 = {
     typed?: boolean;
@@ -138,6 +136,45 @@ 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;
+    get isUrl(): boolean;
+    /**
+     * 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;
+    static isURL(path: string): boolean;
+}
+
 type Import = {
     name: string | string[];
     path: string;
@@ -210,6 +247,22 @@ declare class FileManager {
     read(...params: Parameters<typeof read>): Promise<string>;
 }
 
+declare class PluginError extends Error {
+    pluginManager: PluginManager;
+    cause: Error;
+    constructor(message: string, options: {
+        cause: Error;
+        pluginManager: PluginManager;
+    });
+}
+
+declare class EventEmitter<TEvents extends Record<string, any>> {
+    private emitter;
+    emit<TEventName extends keyof TEvents & string>(eventName: TEventName, ...eventArg: TEvents[TEventName]): void;
+    on<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
+    off<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
+}
+
 /**
  * Get the type of the first argument in a function.
  * @example Arg0<(a: string, b: number) => void> -> string
@@ -220,10 +273,9 @@ type Executer<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
     strategy: Strategy;
     hookName: H;
     plugin: KubbPlugin;
-    input?: unknown[] | undefined;
+    parameters?: unknown[] | undefined;
     output?: unknown;
 };
-type OnExecute<H extends PluginLifecycleHooks = PluginLifecycleHooks> = (this: PluginManager, executer: Executer<H> | undefined, pluginManager: PluginManager) => void;
 type ParseResult<H extends PluginLifecycleHooks> = PluginLifecycle[H];
 type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseResult<H>>> = {
     result: Result;
@@ -235,20 +287,24 @@ type Options$1 = {
     debug?: boolean;
     task: QueueTask<ResolvedFile>;
     logger: Logger;
-    onExecute?: OnExecute<PluginLifecycleHooks>;
+};
+type Events = {
+    execute: [executer: Executer];
+    executed: [executer: Executer];
+    error: [pluginError: PluginError];
 };
 declare class PluginManager {
     plugins: KubbPlugin[];
     readonly fileManager: FileManager;
-    private readonly onExecute?;
     private readonly core;
     queue: Queue;
     executed: Executer[];
     logger: Logger;
+    eventEmitter: EventEmitter<Events>;
     constructor(config: KubbConfig, options: Options$1);
     resolvePath: (params: ResolvePathParams) => OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
-    load: (id: string) => Promise<SafeParseResult<'load'>>;
+    on<TEventName extends keyof Events & string>(eventName: TEventName, handler: (...eventArg: Events[TEventName]) => void): void;
     /**
      *
      * Run only hook for a specific plugin name
@@ -330,15 +386,6 @@ declare class ValidationPluginError extends Error {
 }
 declare function validatePlugins(plugins: KubbPlugin[], dependedPluginNames: string | string[]): true;
 
-declare class PluginError extends Error {
-    pluginManager: PluginManager;
-    cause: Error;
-    constructor(message: string, options: {
-        cause: Error;
-        pluginManager: PluginManager;
-    });
-}
-
 declare class ParallelPluginError extends Error {
     errors: PluginError[];
     pluginManager: PluginManager;
@@ -347,7 +394,7 @@ declare class ParallelPluginError extends Error {
         errors: PluginError[];
         pluginManager: PluginManager;
     });
-    findError<T extends Error = Error>(searchError: T): T | undefined;
+    findError<T extends Error = Error>(searchError: T | undefined): T | undefined;
 }
 
 interface Register {
@@ -592,7 +639,6 @@ type PluginContext<TOptions = Record<string, unknown>> = {
     addFile: (...file: File[]) => Promise<File[]>;
     resolvePath: (params: ResolvePathParams<TOptions>) => OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
-    load: (id: string) => Promise<SafeParseResult<'load'>>;
     logger: Logger;
 };
 type TransformResult = string | null;
@@ -635,7 +681,6 @@ type Options = {
     fileManager: FileManager;
     resolvePath: PluginContext['resolvePath'];
     resolveName: PluginContext['resolveName'];
-    load: PluginContext['load'];
     logger: PluginContext['logger'];
 };
 type CorePluginOptions = PluginFactoryOptions<'core', Options, false, PluginContext>;
@@ -659,4 +704,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, PluginCache, 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, 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, pluginName as name, nameSorter, normalizeDirectory, objectToParameters, pluginName, randomColour, randomPicoColour, read, renderTemplate, throttle, timeout, transformReservedWord, uniqueId, validatePlugins, write, writeIndexes };

package/dist/index.js

@@ -12,6 +12,7 @@ import pc3 from 'picocolors';
 export { default as pc } from 'picocolors';
 import seedrandom from 'seedrandom';
 import { createImportDeclaration, print, createExportDeclaration } from '@kubb/ts-codegen';
+import { EventEmitter as EventEmitter$1 } from 'node:events';
 
 createRequire(import.meta.url);
 
@@ -97,19 +98,6 @@ function getPathMode(path) {
 async function read(path) {
   return fs.readFile(path, { encoding: "utf8" });
 }
-
-// src/utils/isURL.ts
-function isURL(data) {
-  try {
-    const url = new URL(data);
-    if (url?.href) {
-      return true;
-    }
-  } catch (error) {
-    return false;
-  }
-  return false;
-}
 function objectToParameters(data, options = {}) {
   const { typed } = options;
   return data.reduce((acc, [key, value]) => {
@@ -399,7 +387,7 @@ var reservedWords = [
   "valueOf"
 ];
 function transformReservedWord(word) {
-  if (word && reservedWords.includes(word)) {
+  if (word && reservedWords.includes(word) || word?.match(/^\d/)) {
     return `_${word}`;
   }
   return word;
@@ -555,6 +543,79 @@ function randomPicoColour(text, colors = defaultColours) {
   }
   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();
+  }
+  get isUrl() {
+    return URLPath.isURL(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}`
+   */
+  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("}", "");
+  }
+  static isURL(path) {
+    try {
+      const url = new URL(path);
+      if (url?.href) {
+        return true;
+      }
+    } catch (error) {
+      return false;
+    }
+    return false;
+  }
+};
 function writeIndexes(root, options = {}) {
   const tree = TreeNode.build(root, { extensions: /\.ts/, ...options });
   if (!tree) {
@@ -825,7 +886,7 @@ function createPlugin(factory) {
 }
 var pluginName = "core";
 var definePlugin = createPlugin((options) => {
-  const { fileManager, resolvePath, resolveName, load, logger } = options;
+  const { fileManager, resolvePath, resolveName, logger } = options;
   return {
     name: pluginName,
     options,
@@ -869,7 +930,6 @@ var definePlugin = createPlugin((options) => {
           const name = resolveName(params);
           return transformReservedWord(name);
         },
-        load,
         cache: createPluginCache()
       };
     },
@@ -894,6 +954,9 @@ var ParallelPluginError = class extends Error {
     this.pluginManager = options.pluginManager;
   }
   findError(searchError) {
+    if (!searchError) {
+      return void 0;
+    }
     return this.errors.find((error) => {
       if (error.cause) {
         if (error.cause.name == searchError.name) {
@@ -917,6 +980,30 @@ var PluginError = class extends Error {
     this.pluginManager = options.pluginManager;
   }
 };
+var EventEmitter = class {
+  emitter = new EventEmitter$1();
+  emit(eventName, ...eventArg) {
+    this.emitter.emit(eventName, ...eventArg);
+  }
+  on(eventName, handler) {
+    this.emitter.on(eventName, handler);
+  }
+  off(eventName, handler) {
+    this.emitter.off(eventName, handler);
+  }
+};
+
+// src/managers/pluginManager/pluginParser.ts
+function pluginParser(plugin, context) {
+  if (plugin.api && typeof plugin.api === "function") {
+    const api = plugin.api.call(context);
+    return {
+      ...plugin,
+      api
+    };
+  }
+  return null;
+}
 
 // src/managers/pluginManager/PluginManager.ts
 var hookNames = {
@@ -930,26 +1017,15 @@ var hookNames = {
   buildEnd: 1
 };
 var hooks = Object.keys(hookNames);
-var convertKubbUserPluginToKubbPlugin = (plugin, context) => {
-  if (plugin.api && typeof plugin.api === "function") {
-    const api = plugin.api.call(context);
-    return {
-      ...plugin,
-      api
-    };
-  }
-  return null;
-};
 var PluginManager = class {
   plugins;
   fileManager;
-  onExecute;
   core;
   queue;
   executed = [];
   logger;
+  eventEmitter = new EventEmitter();
   constructor(config, options) {
-    this.onExecute = options.onExecute?.bind(this);
     this.logger = options.logger;
     this.queue = new Queue(100, options.debug);
     this.fileManager = new FileManager({ task: options.task, queue: this.queue });
@@ -957,14 +1033,12 @@ var PluginManager = class {
       config,
       logger: this.logger,
       fileManager: this.fileManager,
-      load: this.load,
       resolvePath: this.resolvePath,
       resolveName: this.resolveName
     });
-    const convertedCore = convertKubbUserPluginToKubbPlugin(core, core.api.call(null));
-    this.core = convertedCore;
+    this.core = pluginParser(core, core.api.call(null));
     this.plugins = [this.core, ...config.plugins || []].reduce((prev, plugin) => {
-      const convertedApi = convertKubbUserPluginToKubbPlugin(plugin, convertedCore?.api);
+      const convertedApi = pluginParser(plugin, this.core?.api);
       if (convertedApi) {
         return [...prev, convertedApi];
       }
@@ -997,12 +1071,9 @@ var PluginManager = class {
       parameters: [params.name]
     }).result;
   };
-  load = async (id) => {
-    return this.hookFirst({
-      hookName: "load",
-      parameters: [id]
-    });
-  };
+  on(eventName, handler) {
+    this.eventEmitter.on(eventName, handler);
+  }
   /**
    *
    * Run only hook for a specific plugin name
@@ -1175,8 +1246,8 @@ var PluginManager = class {
     return pluginByPluginName;
   }
   addExecutedToCallStack(executer) {
-    this.onExecute?.call(this, executer, this);
     if (executer) {
+      this.eventEmitter.emit("execute", executer);
       this.executed.push(executer);
     }
   }
@@ -1198,6 +1269,7 @@ var PluginManager = class {
     if (!hook) {
       return null;
     }
+    this.eventEmitter.emit("execute", { strategy, hookName, parameters, plugin });
     const task = Promise.resolve().then(() => {
       if (typeof hook === "function") {
         const possiblePromiseResult = hook.apply(this.core.api, parameters);
@@ -1215,7 +1287,7 @@ var PluginManager = class {
       return null;
     }).finally(() => {
       this.addExecutedToCallStack({
-        input: parameters,
+        parameters,
         output,
         strategy,
         hookName,
@@ -1242,6 +1314,7 @@ var PluginManager = class {
     if (!hook) {
       return null;
     }
+    this.eventEmitter.emit("execute", { strategy, hookName, parameters, plugin });
     try {
       if (typeof hook === "function") {
         const fn = hook.apply(this.core.api, parameters);
@@ -1255,7 +1328,7 @@ var PluginManager = class {
       return null;
     } finally {
       this.addExecutedToCallStack({
-        input: parameters,
+        parameters,
         output,
         strategy,
         hookName,
@@ -1266,7 +1339,9 @@ var PluginManager = class {
   catcher(e, plugin, hookName) {
     const text = `${e.message} (plugin: ${plugin.name}, hook: ${hookName})
 `;
-    throw new PluginError(text, { cause: e, pluginManager: this });
+    const pluginError = new PluginError(text, { cause: e, pluginManager: this });
+    this.eventEmitter.emit("error", pluginError);
+    throw pluginError;
   }
 };
 function noReturn() {
@@ -1305,7 +1380,7 @@ async function transformReducer(_previousCode, result, _plugin) {
 async function build(options) {
   const { config, debug, logger = createLogger() } = options;
   try {
-    if (!isURL(config.input.path)) {
+    if (!URLPath.isURL(config.input.path)) {
       await read(config.input.path);
     }
   } catch (e) {
@@ -1346,32 +1421,29 @@ async function build(options) {
       }
     }
   };
-  const onExecute = (executer) => {
-    if (!executer) {
-      return;
-    }
-    const { hookName, plugin, output, input } = executer;
+  const pluginManager = new PluginManager(config, { debug, logger, task: queueTask });
+  const { plugins, fileManager } = pluginManager;
+  pluginManager.on("execute", (executer) => {
+    const { hookName, plugin, output, parameters } = executer;
     const messsage = `${randomPicoColour(plugin.name)} Executing ${hookName}`;
-    if (config.logLevel === LogLevel.info && logger?.spinner && input) {
+    if (config.logLevel === LogLevel.info && logger?.spinner && parameters) {
       if (debug) {
         logger.info(messsage);
       } else {
         logger.spinner.suffixText = messsage;
       }
     }
-    if (config.logLevel === LogLevel.stacktrace && logger?.spinner && input) {
+    if (config.logLevel === LogLevel.stacktrace && logger?.spinner && parameters) {
       logger.info(messsage);
       const logs = [
-        input && `${pc3.bgWhite(`Input`)} ${randomPicoColour(plugin.name)} ${hookName}`,
-        JSON.stringify(input, void 0, 2),
+        parameters && `${pc3.bgWhite(`Parameters`)} ${randomPicoColour(plugin.name)} ${hookName}`,
+        JSON.stringify(parameters, void 0, 2),
         output && `${pc3.bgWhite("Output")} ${randomPicoColour(plugin.name)} ${hookName}`,
         output
       ].filter(Boolean);
       console.log(logs.join("\n"));
     }
-  };
-  const pluginManager = new PluginManager(config, { debug, logger, task: queueTask, onExecute });
-  const { plugins, fileManager } = pluginManager;
+  });
   await pluginManager.hookParallel({
     hookName: "validate",
     parameters: [plugins]
@@ -1413,6 +1485,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, 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