@kubb/core 1.10.0-canary.20231007T144632 → 1.10.1

package/dist/index.d.cts

@@ -1,18 +1,7 @@
-import { Ora } from 'ora';
 import { DirectoryTreeOptions } from 'directory-tree';
+import { Ora } from 'ora';
 export { default as pc } from 'picocolors';
 
-type LogType = 'error' | 'info' | 'warning';
-type Logger = {
-    log: (message: string | null) => void;
-    error: (message: string | null) => void;
-    info: (message: string | null) => void;
-    warn: (message: string | null) => void;
-    spinner?: Ora;
-    logs: string[];
-};
-declare function createLogger(spinner?: Ora): Logger;
-
 declare function isPromise<T>(result: PossiblePromise<T>): result is Promise<T>;
 declare function isPromiseFulfilledResult<T = unknown>(result: PromiseSettledResult<unknown>): result is PromiseFulfilledResult<T>;
 declare function isPromiseRejectedResult<T>(result: PromiseSettledResult<unknown>): result is Omit<PromiseRejectedResult, 'reason'> & {
@@ -150,10 +139,30 @@ declare class Warning extends Error {
     });
 }
 
+type LogType = 'error' | 'info' | 'warning';
+type Logger = {
+    log: (message: string | null) => void;
+    error: (message: string | null) => void;
+    info: (message: string | null) => void;
+    warn: (message: string | null) => void;
+    spinner?: Ora;
+    logs: string[];
+};
+declare function createLogger(spinner?: Ora): Logger;
+
 declare const defaultColours: readonly ["black", "blue", "darkBlue", "cyan", "gray", "green", "darkGreen", "magenta", "red", "darkRed", "yellow", "darkYellow"];
 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;
 
+type URLObject = {
+    url: string;
+    params?: Record<string, string>;
+};
+type ObjectOptions = {
+    type?: 'path' | 'template';
+    replacer?: (pathParam: string) => string;
+    stringify?: boolean;
+};
 declare class URLPath {
     path: string;
     constructor(path: string);
@@ -170,26 +179,32 @@ declare class URLPath {
      * @example /account/userID => `/account/${userId}`
      */
     get template(): string;
+    get object(): URLObject | string;
+    get params(): Record<string, string> | undefined;
+    toObject(options?: ObjectOptions): URLObject | 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;
+    toTemplateString(replacer?: (pathParam: string) => string): 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;
+    static toTemplateString(path: string, replacer?: (pathParam: string) => string): string;
+    getParams(replacer?: (pathParam: string) => string): Record<string, string> | undefined;
+    static getParams(path: string, replacer?: (pathParam: string) => string): Record<string, string> | undefined;
     /**
      * Convert Swagger path to URLPath(syntax of Express)
      * @example /pet/{petId} => /pet/:petId
      */
     toURLPath(): string;
     static toURLPath(path: string): string;
+    static toObject(path: string, { type, replacer, stringify }?: ObjectOptions): URLObject | string;
     static isURL(path: string): boolean;
 }
 

package/dist/index.d.ts

@@ -1,18 +1,7 @@
-import { Ora } from 'ora';
 import { DirectoryTreeOptions } from 'directory-tree';
+import { Ora } from 'ora';
 export { default as pc } from 'picocolors';
 
-type LogType = 'error' | 'info' | 'warning';
-type Logger = {
-    log: (message: string | null) => void;
-    error: (message: string | null) => void;
-    info: (message: string | null) => void;
-    warn: (message: string | null) => void;
-    spinner?: Ora;
-    logs: string[];
-};
-declare function createLogger(spinner?: Ora): Logger;
-
 declare function isPromise<T>(result: PossiblePromise<T>): result is Promise<T>;
 declare function isPromiseFulfilledResult<T = unknown>(result: PromiseSettledResult<unknown>): result is PromiseFulfilledResult<T>;
 declare function isPromiseRejectedResult<T>(result: PromiseSettledResult<unknown>): result is Omit<PromiseRejectedResult, 'reason'> & {
@@ -150,10 +139,30 @@ declare class Warning extends Error {
     });
 }
 
+type LogType = 'error' | 'info' | 'warning';
+type Logger = {
+    log: (message: string | null) => void;
+    error: (message: string | null) => void;
+    info: (message: string | null) => void;
+    warn: (message: string | null) => void;
+    spinner?: Ora;
+    logs: string[];
+};
+declare function createLogger(spinner?: Ora): Logger;
+
 declare const defaultColours: readonly ["black", "blue", "darkBlue", "cyan", "gray", "green", "darkGreen", "magenta", "red", "darkRed", "yellow", "darkYellow"];
 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;
 
+type URLObject = {
+    url: string;
+    params?: Record<string, string>;
+};
+type ObjectOptions = {
+    type?: 'path' | 'template';
+    replacer?: (pathParam: string) => string;
+    stringify?: boolean;
+};
 declare class URLPath {
     path: string;
     constructor(path: string);
@@ -170,26 +179,32 @@ declare class URLPath {
      * @example /account/userID => `/account/${userId}`
      */
     get template(): string;
+    get object(): URLObject | string;
+    get params(): Record<string, string> | undefined;
+    toObject(options?: ObjectOptions): URLObject | 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;
+    toTemplateString(replacer?: (pathParam: string) => string): 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;
+    static toTemplateString(path: string, replacer?: (pathParam: string) => string): string;
+    getParams(replacer?: (pathParam: string) => string): Record<string, string> | undefined;
+    static getParams(path: string, replacer?: (pathParam: string) => string): Record<string, string> | undefined;
     /**
      * Convert Swagger path to URLPath(syntax of Express)
      * @example /pet/{petId} => /pet/:petId
      */
     toURLPath(): string;
     static toURLPath(path: string): string;
+    static toObject(path: string, { type, replacer, stringify }?: ObjectOptions): URLObject | string;
     static isURL(path: string): boolean;
 }
 

package/dist/index.js

@@ -1,17 +1,17 @@
 import { createRequire } from 'module';
+import pc3 from 'picocolors';
+export { default as pc } from 'picocolors';
 import crypto from 'node:crypto';
-import fs, { remove } from 'fs-extra';
 import pathParser2 from 'node:path';
+import fs, { remove } from 'fs-extra';
 import { switcher } from 'js-runtime';
 import { camelCase, camelCaseTransformMerge } from 'change-case';
 import { orderBy } from 'natural-orderby';
 import { performance } from 'node:perf_hooks';
 import dirTree from 'directory-tree';
 import mod from 'node:module';
-import { pathToFileURL } from 'node:url';
 import os from 'node:os';
-import pc3 from 'picocolors';
-export { default as pc } from 'picocolors';
+import { pathToFileURL } from 'node:url';
 import seedrandom from 'seedrandom';
 import { createImportDeclaration, print, createExportDeclaration } from '@kubb/ts-codegen';
 import isEqual from 'lodash.isequal';
@@ -635,14 +635,23 @@ var URLPath = class _URLPath {
   get template() {
     return this.toTemplateString();
   }
+  get object() {
+    return this.toObject();
+  }
+  get params() {
+    return this.getParams();
+  }
+  toObject(options = {}) {
+    return _URLPath.toObject(this.path, options);
+  }
   /**
    * 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);
+  toTemplateString(replacer) {
+    return _URLPath.toTemplateString(this.path, replacer);
   }
   /**
    * Convert Swagger path to template literals/ template strings(camelcase)
@@ -650,18 +659,36 @@ var URLPath = class _URLPath {
    * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
    * @example /account/userID => `/account/${userId}`
    */
-  static toTemplateString(path) {
+  static toTemplateString(path, replacer) {
     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 })}}`;
+        const pathParam = replacer ? replacer(camelCase(curr, { delimiter: "", transform: camelCaseTransformMerge })) : camelCase(curr, { delimiter: "", transform: camelCaseTransformMerge });
+        const replacement = `\${${pathParam}}`;
         return prev.replace(curr, replacement);
       }, path);
     }
     return `\`${newPath}\``;
   }
+  getParams(replacer) {
+    return _URLPath.getParams(this.path, replacer);
+  }
+  static getParams(path, replacer) {
+    const regex = /{(\w|-)*}/g;
+    const found = path.match(regex);
+    if (!found) {
+      return void 0;
+    }
+    const params = {};
+    found.forEach((item) => {
+      item = item.replaceAll("{", "").replaceAll("}", "");
+      const pathParam = replacer ? replacer(camelCase(item, { delimiter: "", transform: camelCaseTransformMerge })) : camelCase(item, { delimiter: "", transform: camelCaseTransformMerge });
+      params[pathParam] = pathParam;
+    }, path);
+    return params;
+  }
   /**
    * Convert Swagger path to URLPath(syntax of Express)
    * @example /pet/{petId} => /pet/:petId
@@ -672,6 +699,19 @@ var URLPath = class _URLPath {
   static toURLPath(path) {
     return path.replaceAll("{", ":").replaceAll("}", "");
   }
+  static toObject(path, { type = "path", replacer, stringify } = {}) {
+    const object = {
+      url: type === "path" ? _URLPath.toURLPath(path) : _URLPath.toTemplateString(path, replacer),
+      params: _URLPath.getParams(path)
+    };
+    if (stringify) {
+      if (type !== "template") {
+        throw new Error("Type should be `template` when using stringiyf");
+      }
+      return JSON.stringify(object).replaceAll("'", "").replaceAll(`"`, "");
+    }
+    return object;
+  }
   static isURL(path) {
     try {
       const url = new URL(path);
@@ -1027,6 +1067,18 @@ var definePlugin = createPlugin((options) => {
     }
   };
 });
+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/ParallelPluginError.ts
 var ParallelPluginError = class extends Error {
@@ -1065,18 +1117,6 @@ 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) {