@kubb/core 2.7.1 → 2.8.0

package/dist/index.d.cts

@@ -61,6 +61,13 @@ type Events = {
     executed: [executer: Executer];
     error: [error: Error];
 };
+type GetFileProps<TOptions = object> = {
+    name: string;
+    mode?: KubbFile.Mode;
+    extName: KubbFile.Extname;
+    pluginKey: Plugin['key'];
+    options?: TOptions;
+};
 declare class PluginManager {
     #private;
     readonly plugins: PluginWithLifeCycle[];
@@ -71,6 +78,9 @@ declare class PluginManager {
     readonly logger: Logger;
     readonly queue: PQueue;
     constructor(config: Config, options: Options$2);
+    getFile<TOptions = object>({ name, mode, extName, pluginKey, options }: GetFileProps<TOptions>): KubbFile.File<{
+        pluginKey: Plugin['key'];
+    }>;
     resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => KubbFile.OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
     /**
@@ -270,12 +280,7 @@ TAPI = any,
 /**
  * When calling `resolvePath` you can specify better types.
  */
-TResolvePathOptions extends object = object, 
-/**
- * When using @kubb/react(based on React) you can specify here which types should be used when calling render.
- * Always extend from `AppMeta` of the core.
- */
-TAppMeta = unknown> = {
+TResolvePathOptions extends object = object> = {
     name: TName;
     /**
      * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
@@ -287,8 +292,8 @@ TAppMeta = unknown> = {
     resolvePathOptions: TResolvePathOptions;
     appMeta: {
         pluginManager: PluginManager;
-        plugin: Plugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>;
-    } & TAppMeta;
+        plugin: Plugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions>>;
+    };
 };
 type GetPluginFactoryOptions<TPlugin extends UserPlugin> = TPlugin extends UserPlugin<infer X> ? X : never;
 type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
@@ -317,7 +322,7 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
     api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['api'];
 });
 type UserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = UserPlugin<TOptions> & PluginLifecycle<TOptions>;
-type UnknownUserPlugin = UserPlugin<PluginFactoryOptions<any, any, any, any, any, any>>;
+type UnknownUserPlugin = UserPlugin<PluginFactoryOptions<any, any, any, any, any>>;
 type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
     /**
      * Unique name used for the plugin
@@ -360,7 +365,7 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
      * @type hookFirst
      * @example ('./Pet.ts', './src/gen/') => '/src/gen/Pet.ts'
      */
-    resolvePath?: (this: PluginContext<TOptions>, baseName: string, directory?: string, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath;
+    resolvePath?: (this: PluginContext<TOptions>, baseName: string, mode?: KubbFile.Mode, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath;
     /**
      * Resolve to a name based on a string.
      * Useful when converting to PascalCase or camelCase.
@@ -395,7 +400,7 @@ type PluginCache = Record<string, [number, unknown]>;
 type ResolvePathParams<TOptions = object> = {
     pluginKey?: Plugin['key'];
     baseName: string;
-    directory?: string | undefined;
+    mode?: KubbFile.Mode;
     /**
      * Options to be passed to 'resolvePath' 3th parameter
      */

package/dist/index.d.ts

@@ -61,6 +61,13 @@ type Events = {
     executed: [executer: Executer];
     error: [error: Error];
 };
+type GetFileProps<TOptions = object> = {
+    name: string;
+    mode?: KubbFile.Mode;
+    extName: KubbFile.Extname;
+    pluginKey: Plugin['key'];
+    options?: TOptions;
+};
 declare class PluginManager {
     #private;
     readonly plugins: PluginWithLifeCycle[];
@@ -71,6 +78,9 @@ declare class PluginManager {
     readonly logger: Logger;
     readonly queue: PQueue;
     constructor(config: Config, options: Options$2);
+    getFile<TOptions = object>({ name, mode, extName, pluginKey, options }: GetFileProps<TOptions>): KubbFile.File<{
+        pluginKey: Plugin['key'];
+    }>;
     resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => KubbFile.OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
     /**
@@ -270,12 +280,7 @@ TAPI = any,
 /**
  * When calling `resolvePath` you can specify better types.
  */
-TResolvePathOptions extends object = object, 
-/**
- * When using @kubb/react(based on React) you can specify here which types should be used when calling render.
- * Always extend from `AppMeta` of the core.
- */
-TAppMeta = unknown> = {
+TResolvePathOptions extends object = object> = {
     name: TName;
     /**
      * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
@@ -287,8 +292,8 @@ TAppMeta = unknown> = {
     resolvePathOptions: TResolvePathOptions;
     appMeta: {
         pluginManager: PluginManager;
-        plugin: Plugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>;
-    } & TAppMeta;
+        plugin: Plugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions>>;
+    };
 };
 type GetPluginFactoryOptions<TPlugin extends UserPlugin> = TPlugin extends UserPlugin<infer X> ? X : never;
 type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
@@ -317,7 +322,7 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
     api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['api'];
 });
 type UserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = UserPlugin<TOptions> & PluginLifecycle<TOptions>;
-type UnknownUserPlugin = UserPlugin<PluginFactoryOptions<any, any, any, any, any, any>>;
+type UnknownUserPlugin = UserPlugin<PluginFactoryOptions<any, any, any, any, any>>;
 type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
     /**
      * Unique name used for the plugin
@@ -360,7 +365,7 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
      * @type hookFirst
      * @example ('./Pet.ts', './src/gen/') => '/src/gen/Pet.ts'
      */
-    resolvePath?: (this: PluginContext<TOptions>, baseName: string, directory?: string, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath;
+    resolvePath?: (this: PluginContext<TOptions>, baseName: string, mode?: KubbFile.Mode, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath;
     /**
      * Resolve to a name based on a string.
      * Useful when converting to PascalCase or camelCase.
@@ -395,7 +400,7 @@ type PluginCache = Record<string, [number, unknown]>;
 type ResolvePathParams<TOptions = object> = {
     pluginKey?: Plugin['key'];
     baseName: string;
-    directory?: string | undefined;
+    mode?: KubbFile.Mode;
     /**
      * Options to be passed to 'resolvePath' 3th parameter
      */

package/dist/index.js

@@ -13,7 +13,7 @@ import {
   createPlugin,
   isPromise,
   pluginName
-} from "./chunk-BHNAGXM3.js";
+} from "./chunk-6KNLOEZF.js";
 import "./chunk-L3XMZMJ5.js";
 import "./chunk-JPSCPXBD.js";
 import "./chunk-SV7GUBBD.js";

package/dist/mocks.cjs

@@ -1,11 +1,13 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-FNHECX2X.cjs');
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-AXZ52CY2.cjs');
 require('./chunk-XXN4BH6X.cjs');
 require('./chunk-GNWOOGXA.cjs');
 
 
 var _chunkAWUFUNOJcjs = require('./chunk-AWUFUNOJ.cjs');
 require('./chunk-ZJ6GI35A.cjs');
-require('./chunk-IXCRUQPC.cjs');
+
+
+var _chunkIXCRUQPCcjs = require('./chunk-IXCRUQPC.cjs');
 require('./chunk-X2JM3GAC.cjs');
 
 
@@ -28,6 +30,22 @@ var mockedPluginManager = {
     on(eventName, args) {
     },
     logLevel: "info"
+  },
+  getFile: ({ name, extName, pluginKey }) => {
+    const baseName = `${name}${extName}`;
+    let source = "";
+    try {
+      source = _chunkIXCRUQPCcjs.readSync.call(void 0, baseName);
+    } catch (_e) {
+    }
+    return {
+      path: baseName,
+      baseName,
+      meta: {
+        pluginKey
+      },
+      source
+    };
   }
 };
 

package/dist/mocks.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../mocks/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA;AAGO,IAAM,sBAAsB;AAAA,EACjC,aAAa,CAAC,EAAE,MAAM,KAAK,MAAM;AAC/B,QAAI,SAAS,QAAQ;AACnB,aAAO,WAAW,IAAI;AAAA,IACxB;AAEA,WAAO;AAAA,EACT;AAAA,EACA,aAAa,CAAC,EAAE,SAAS,MAAM;AAAA,EAC/B,QAAQ;AAAA,IACN,KAAK,SAAS;AACZ,cAAQ,IAAI,OAAO;AAAA,IACrB;AAAA,IACA,GAAG,WAAW,MAAM;AAAA,IAAC;AAAA,IACrB,UAAU;AAAA,EACZ;AACF","sourcesContent":["import { pascalCase } from '../src/transformers/casing.ts'\n\nimport { PluginManager } from '../src/PluginManager.ts'\nexport const mockedPluginManager = {\n  resolveName: ({ name, type }) => {\n    if (type === 'type') {\n      return pascalCase(name)\n    }\n\n    return name\n  },\n  resolvePath: ({ baseName }) => baseName,\n  logger: {\n    emit(message) {\n      console.log(message)\n    },\n    on(eventName, args) {},\n    logLevel: 'info',\n  },\n} as PluginManager\n"]}
+{"version":3,"sources":["../mocks/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;AAKO,IAAM,sBAAsB;AAAA,EACjC,aAAa,CAAC,EAAE,MAAM,KAAK,MAAM;AAC/B,QAAI,SAAS,QAAQ;AACnB,aAAO,WAAW,IAAI;AAAA,IACxB;AAEA,WAAO;AAAA,EACT;AAAA,EACA,aAAa,CAAC,EAAE,SAAS,MAAM;AAAA,EAC/B,QAAQ;AAAA,IACN,KAAK,SAAS;AACZ,cAAQ,IAAI,OAAO;AAAA,IACrB;AAAA,IACA,GAAG,WAAW,MAAM;AAAA,IAAC;AAAA,IACrB,UAAU;AAAA,EACZ;AAAA,EACA,SAAS,CAAC,EAAE,MAAM,SAAS,UAAU,MAAM;AACzC,UAAM,WAAW,GAAG,IAAI,GAAG,OAAO;AAClC,QAAI,SAAS;AAEb,QAAI;AACF,eAAS,SAAS,QAAQ;AAAA,IAC5B,SAAS,IAAI;AAAA,IAEb;AAEA,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MACA,MAAM;AAAA,QACJ;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF","sourcesContent":["import { pascalCase } from '../src/transformers/casing.ts'\n\nimport { PluginManager } from '../src/PluginManager.ts'\nimport { readSync } from '../src/fs/read.ts'\n\nexport const mockedPluginManager = {\n  resolveName: ({ name, type }) => {\n    if (type === 'type') {\n      return pascalCase(name)\n    }\n\n    return name\n  },\n  resolvePath: ({ baseName }) => baseName,\n  logger: {\n    emit(message) {\n      console.log(message)\n    },\n    on(eventName, args) {},\n    logLevel: 'info',\n  },\n  getFile: ({ name, extName, pluginKey }) => {\n    const baseName = `${name}${extName}`\n    let source = ''\n\n    try {\n      source = readSync(baseName)\n    } catch (_e) {\n      //\n    }\n\n    return {\n      path: baseName,\n      baseName,\n      meta: {\n        pluginKey,\n      },\n      source,\n    }\n  },\n} as PluginManager\n"]}

package/dist/mocks.js

@@ -1,11 +1,13 @@
-import "./chunk-BHNAGXM3.js";
+import "./chunk-6KNLOEZF.js";
 import "./chunk-L3XMZMJ5.js";
 import "./chunk-JPSCPXBD.js";
 import {
   pascalCase
 } from "./chunk-SV7GUBBD.js";
 import "./chunk-WRGVBPK2.js";
-import "./chunk-XDO5ZSKZ.js";
+import {
+  readSync
+} from "./chunk-XDO5ZSKZ.js";
 import "./chunk-J2ES4PYI.js";
 import {
   init_esm_shims
@@ -28,6 +30,22 @@ var mockedPluginManager = {
     on(eventName, args) {
     },
     logLevel: "info"
+  },
+  getFile: ({ name, extName, pluginKey }) => {
+    const baseName = `${name}${extName}`;
+    let source = "";
+    try {
+      source = readSync(baseName);
+    } catch (_e) {
+    }
+    return {
+      path: baseName,
+      baseName,
+      meta: {
+        pluginKey
+      },
+      source
+    };
   }
 };
 export {

package/dist/mocks.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../mocks/index.ts"],"sourcesContent":["import { pascalCase } from '../src/transformers/casing.ts'\n\nimport { PluginManager } from '../src/PluginManager.ts'\nexport const mockedPluginManager = {\n  resolveName: ({ name, type }) => {\n    if (type === 'type') {\n      return pascalCase(name)\n    }\n\n    return name\n  },\n  resolvePath: ({ baseName }) => baseName,\n  logger: {\n    emit(message) {\n      console.log(message)\n    },\n    on(eventName, args) {},\n    logLevel: 'info',\n  },\n} as PluginManager\n"],"mappings":";;;;;;;;;;;;;;AAAA;AAGO,IAAM,sBAAsB;AAAA,EACjC,aAAa,CAAC,EAAE,MAAM,KAAK,MAAM;AAC/B,QAAI,SAAS,QAAQ;AACnB,aAAO,WAAW,IAAI;AAAA,IACxB;AAEA,WAAO;AAAA,EACT;AAAA,EACA,aAAa,CAAC,EAAE,SAAS,MAAM;AAAA,EAC/B,QAAQ;AAAA,IACN,KAAK,SAAS;AACZ,cAAQ,IAAI,OAAO;AAAA,IACrB;AAAA,IACA,GAAG,WAAW,MAAM;AAAA,IAAC;AAAA,IACrB,UAAU;AAAA,EACZ;AACF;","names":[]}
+{"version":3,"sources":["../mocks/index.ts"],"sourcesContent":["import { pascalCase } from '../src/transformers/casing.ts'\n\nimport { PluginManager } from '../src/PluginManager.ts'\nimport { readSync } from '../src/fs/read.ts'\n\nexport const mockedPluginManager = {\n  resolveName: ({ name, type }) => {\n    if (type === 'type') {\n      return pascalCase(name)\n    }\n\n    return name\n  },\n  resolvePath: ({ baseName }) => baseName,\n  logger: {\n    emit(message) {\n      console.log(message)\n    },\n    on(eventName, args) {},\n    logLevel: 'info',\n  },\n  getFile: ({ name, extName, pluginKey }) => {\n    const baseName = `${name}${extName}`\n    let source = ''\n\n    try {\n      source = readSync(baseName)\n    } catch (_e) {\n      //\n    }\n\n    return {\n      path: baseName,\n      baseName,\n      meta: {\n        pluginKey,\n      },\n      source,\n    }\n  },\n} as PluginManager\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAKO,IAAM,sBAAsB;AAAA,EACjC,aAAa,CAAC,EAAE,MAAM,KAAK,MAAM;AAC/B,QAAI,SAAS,QAAQ;AACnB,aAAO,WAAW,IAAI;AAAA,IACxB;AAEA,WAAO;AAAA,EACT;AAAA,EACA,aAAa,CAAC,EAAE,SAAS,MAAM;AAAA,EAC/B,QAAQ;AAAA,IACN,KAAK,SAAS;AACZ,cAAQ,IAAI,OAAO;AAAA,IACrB;AAAA,IACA,GAAG,WAAW,MAAM;AAAA,IAAC;AAAA,IACrB,UAAU;AAAA,EACZ;AAAA,EACA,SAAS,CAAC,EAAE,MAAM,SAAS,UAAU,MAAM;AACzC,UAAM,WAAW,GAAG,IAAI,GAAG,OAAO;AAClC,QAAI,SAAS;AAEb,QAAI;AACF,eAAS,SAAS,QAAQ;AAAA,IAC5B,SAAS,IAAI;AAAA,IAEb;AAEA,WAAO;AAAA,MACL,MAAM;AAAA,MACN;AAAA,MACA,MAAM;AAAA,QACJ;AAAA,MACF;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "2.7.1",
+  "version": "2.8.0",
   "description": "Generator core",
   "keywords": [
     "typescript",
@@ -95,13 +95,13 @@
     "p-queue": "^8.0.1",
     "seedrandom": "^3.0.5",
     "semver": "^7.6.0",
-    "@kubb/parser": "2.7.1",
-    "@kubb/types": "2.7.1"
+    "@kubb/parser": "2.8.0",
+    "@kubb/types": "2.8.0"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
     "@types/lodash.isequal": "^4.5.8",
-    "@types/react": "^18.2.63",
+    "@types/react": "^18.2.64",
     "@types/seedrandom": "^3.0.8",
     "@types/semver": "^7.5.8",
     "eslint": "^8.57.0",

package/src/PluginManager.ts

@@ -2,6 +2,7 @@
 
 import PQueue from 'p-queue'
 
+import { readSync } from './fs/read.ts'
 import { transformReservedWord } from './transformers/transformReservedWord.ts'
 import { EventEmitter } from './utils/EventEmitter.ts'
 import { setUniqueName } from './utils/uniqueName.ts'
@@ -73,6 +74,14 @@ type Events = {
   error: [error: Error]
 }
 
+type GetFileProps<TOptions = object> = {
+  name: string
+  mode?: KubbFile.Mode
+  extName: KubbFile.Extname
+  pluginKey: Plugin['key']
+  options?: TOptions
+}
+
 export class PluginManager {
   readonly plugins: PluginWithLifeCycle[]
   readonly fileManager: FileManager
@@ -118,12 +127,37 @@ export class PluginManager {
     return this
   }
 
+  getFile<TOptions = object>({ name, mode, extName, pluginKey, options }: GetFileProps<TOptions>): KubbFile.File<{ pluginKey: Plugin['key'] }> {
+    let source = ''
+    const baseName = `${name}${extName}` as const
+    const path = this.resolvePath({ baseName, mode, pluginKey, options })
+
+    if (!path) {
+      throw new Error(`Filepath should be defined for resolvedName "${name}" and pluginKey [${JSON.stringify(pluginKey)}]`)
+    }
+
+    try {
+      source = readSync(path)
+    } catch (_e) {
+      //
+    }
+
+    return {
+      path,
+      baseName,
+      meta: {
+        pluginKey,
+      },
+      source,
+    }
+  }
+
   resolvePath = <TOptions = object>(params: ResolvePathParams<TOptions>): KubbFile.OptionalPath => {
     if (params.pluginKey) {
       const paths = this.hookForPluginSync({
         pluginKey: params.pluginKey,
         hookName: 'resolvePath',
-        parameters: [params.baseName, params.directory, params.options as object],
+        parameters: [params.baseName, params.mode, params.options as object],
       })
 
       if (paths && paths?.length > 1 && this.logger.logLevel === LogLevel.debug) {
@@ -138,7 +172,7 @@ export class PluginManager {
     }
     return this.hookFirstSync({
       hookName: 'resolvePath',
-      parameters: [params.baseName, params.directory, params.options as object],
+      parameters: [params.baseName, params.mode, params.options as object],
     }).result
   }
   resolveName = (params: ResolveNameParams): string => {

package/src/types.ts

@@ -148,11 +148,6 @@ export type PluginFactoryOptions<
    * When calling `resolvePath` you can specify better types.
    */
   TResolvePathOptions extends object = object,
-  /**
-   * When using @kubb/react(based on React) you can specify here which types should be used when calling render.
-   * Always extend from `AppMeta` of the core.
-   */
-  TAppMeta = unknown,
 > = {
   name: TName
   /**
@@ -165,8 +160,8 @@ export type PluginFactoryOptions<
   resolvePathOptions: TResolvePathOptions
   appMeta: {
     pluginManager: PluginManager
-    plugin: Plugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>
-  } & TAppMeta
+    plugin: Plugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions>>
+  }
 }
 
 export type GetPluginFactoryOptions<TPlugin extends UserPlugin> = TPlugin extends UserPlugin<infer X> ? X : never
@@ -202,7 +197,7 @@ export type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOpti
 
 export type UserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = UserPlugin<TOptions> & PluginLifecycle<TOptions>
 
-type UnknownUserPlugin = UserPlugin<PluginFactoryOptions<any, any, any, any, any, any>>
+type UnknownUserPlugin = UserPlugin<PluginFactoryOptions<any, any, any, any, any>>
 
 export type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
   & {
@@ -254,7 +249,7 @@ export type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactor
    * @type hookFirst
    * @example ('./Pet.ts', './src/gen/') => '/src/gen/Pet.ts'
    */
-  resolvePath?: (this: PluginContext<TOptions>, baseName: string, directory?: string, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath
+  resolvePath?: (this: PluginContext<TOptions>, baseName: string, mode?: KubbFile.Mode, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath
   /**
    * Resolve to a name based on a string.
    * Useful when converting to PascalCase or camelCase.
@@ -293,7 +288,7 @@ export type PluginCache = Record<string, [number, unknown]>
 export type ResolvePathParams<TOptions = object> = {
   pluginKey?: Plugin['key']
   baseName: string
-  directory?: string | undefined
+  mode?: KubbFile.Mode
   /**
    * Options to be passed to 'resolvePath' 3th parameter
    */