@kubb/plugin-ts 4.5.1 → 4.5.3

package/dist/{types-BXlkWRNi.d.ts → types-3bqiJQCB.d.cts}

@@ -1,14 +1,14 @@
-import { Fabric, FileManager } from "@kubb/react-fabric";
-import ts from "typescript";
 import * as OasTypes from "oas/types";
 import { HttpMethods as HttpMethod, OASDocument, SchemaObject, User } from "oas/types";
 import { Operation, Operation as Operation$1 } from "oas/operation";
 import { OpenAPIV3 } from "openapi-types";
 import * as oas_normalize_lib_types0 from "oas-normalize/lib/types";
 import BaseOas from "oas";
-import { KubbNode } from "@kubb/react-fabric/types";
 import { KubbFile } from "@kubb/fabric-core/types";
+import { Fabric } from "@kubb/react-fabric";
 import { ConsolaInstance, LogLevel } from "consola";
+import { KubbNode } from "@kubb/react-fabric/types";
+import ts from "typescript";
 
 //#region ../oas/src/types.d.ts
 type contentType = 'application/json' | (string & {});
@@ -111,6 +111,21 @@ type Logger = {
 type PossiblePromise<T> = Promise<T> | T;
 //#endregion
 //#region ../core/src/types.d.ts
+declare global {
+  namespace Kubb {
+    interface PluginContext {}
+  }
+}
+/**
+ * Config used in `kubb.config.ts`
+ *
+ * @example
+ * import { defineConfig } from '@kubb/core'
+ * export default defineConfig({
+ * ...
+ * })
+ */
+
 type InputPath = {
   /**
    * Specify your Swagger/OpenAPI file, either as an absolute path or a path relative to the root.
@@ -265,11 +280,8 @@ type UserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
    * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins.
    */
   post?: Array<string>;
-} & (TOptions['context'] extends never ? {
-  context?: never;
-} : {
-  context: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['context'];
-});
+  inject?: (this: PluginContext<TOptions>, context: PluginContext<TOptions>) => TOptions['context'];
+};
 type UserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = UserPlugin<TOptions> & PluginLifecycle<TOptions>;
 type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
   /**
@@ -295,25 +307,26 @@ type Plugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
    * Options set for a specific plugin(see kubb.config.js), passthrough of options.
    */
   options: TOptions['resolvedOptions'];
-} & (TOptions['context'] extends never ? {
-  context?: never;
-} : {
-  context: TOptions['context'];
-});
+  install: (this: PluginContext<TOptions>, context: PluginContext<TOptions>) => PossiblePromise<void>;
+  /**
+   * Define a context that can be used by other plugins, see `PluginManager' where we convert from `UserPlugin` to `Plugin`(used when calling `definePlugin`).
+   */
+  inject: (this: PluginContext<TOptions>, context: PluginContext<TOptions>) => TOptions['context'];
+};
 type PluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = Plugin<TOptions> & PluginLifecycle<TOptions>;
 type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
   /**
    * Start of the lifecycle of a plugin.
    * @type hookParallel
    */
-  buildStart?: (this: PluginContext<TOptions>, Config: Config) => PossiblePromise<void>;
+  install?: (this: PluginContext<TOptions>, context: PluginContext<TOptions>) => PossiblePromise<void>;
   /**
    * Resolve to a Path based on a baseName(example: `./Pet.ts`) and directory(example: `./models`).
    * Options can als be included.
    * @type hookFirst
    * @example ('./Pet.ts', './src/gen/') => '/src/gen/Pet.ts'
    */
-  resolvePath?: (this: PluginContext<TOptions>, baseName: KubbFile.BaseName, mode?: KubbFile.Mode, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath;
+  resolvePath?: (this: PluginContext<TOptions>, baseName: KubbFile.BaseName, mode?: KubbFile.Mode, options?: TOptions['resolvePathOptions']) => KubbFile.Path;
   /**
    * Resolve to a name based on a string.
    * Useful when converting to PascalCase or camelCase.
@@ -321,11 +334,6 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
    * @example ('pet') => 'Pet'
    */
   resolveName?: (this: PluginContext<TOptions>, name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-  /**
-   * End of the plugin lifecycle.
-   * @type hookParallel
-   */
-  buildEnd?: (this: PluginContext<TOptions>) => PossiblePromise<void>;
 };
 type PluginLifecycleHooks = keyof PluginLifecycle;
 type PluginParameter<H extends PluginLifecycleHooks> = Parameters<Required<PluginLifecycle>[H]>;
@@ -352,24 +360,15 @@ type ResolveNameParams = {
 type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
   fabric: Fabric;
   config: Config;
-  /**
-   * @deprecated
-   */
-  fileManager: FileManager;
   pluginManager: PluginManager;
-  addFile: (...file: Array<KubbFile.File>) => Promise<Array<KubbFile.ResolvedFile>>;
-  resolvePath: (params: ResolvePathParams<TOptions['resolvePathOptions']>) => KubbFile.OptionalPath;
-  resolveName: (params: ResolveNameParams) => string;
+  addFile: (...file: Array<KubbFile.File>) => Promise<void>;
   logger: Logger;
-  /**
-   * All plugins
-   */
-  plugins: Plugin[];
+  mode: KubbFile.Mode;
   /**
    * Current plugin
    */
   plugin: Plugin<TOptions>;
-};
+} & Kubb.PluginContext;
 /**
  * Specify the export location for the files and define the behavior of the output
  */
@@ -444,13 +443,14 @@ type GetFileProps<TOptions = object> = {
 };
 declare class PluginManager {
   #private;
-  readonly plugins: Set<Plugin<PluginFactoryOptions<string, object, object, any, object>>>;
   readonly events: EventEmitter<Events>;
   readonly config: Config;
   readonly executed: Array<Executer>;
   readonly logger: Logger;
   readonly options: Options$2;
   constructor(config: Config, options: Options$2);
+  getContext<TOptions extends PluginFactoryOptions>(plugin: Plugin<TOptions>): PluginContext<TOptions> & Record<string, any>;
+  get plugins(): Array<Plugin>;
   getFile<TOptions = object>({
     name,
     mode,
@@ -460,7 +460,7 @@ declare class PluginManager {
   }: GetFileProps<TOptions>): KubbFile.File<{
     pluginKey: Plugin['key'];
   }>;
-  resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => KubbFile.OptionalPath;
+  resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => KubbFile.Path;
   resolveName: (params: ResolveNameParams) => string;
   /**
    * Instead of calling `pluginManager.events.on` you can use `pluginManager.on`. This one also has better types.
@@ -548,15 +548,140 @@ declare class PluginManager {
   }): Promise<void>;
   getPluginByKey(pluginKey: Plugin['key']): Plugin | undefined;
   getPluginsByKey(hookName: keyof PluginWithLifeCycle, pluginKey: Plugin['key']): Plugin[];
-  static getDependedPlugins<T1 extends PluginFactoryOptions, T2 extends PluginFactoryOptions = never, T3 extends PluginFactoryOptions = never, TOutput = (T3 extends never ? (T2 extends never ? [T1: Plugin<T1>] : [T1: Plugin<T1>, T2: Plugin<T2>]) : [T1: Plugin<T1>, T2: Plugin<T2>, T3: Plugin<T3>])>(plugins: Array<Plugin>, dependedPluginNames: string | string[]): TOutput;
-  static get hooks(): readonly ["buildStart", "resolvePath", "resolveName", "buildEnd"];
 }
 //#endregion
-//#region ../core/src/FileManager.d.ts
+//#region ../core/src/utils/getBarrelFiles.d.ts
 type FileMetaBase = {
   pluginKey?: Plugin['key'];
 };
 //#endregion
+//#region ../plugin-oas/src/types.d.ts
+type Context$2 = {
+  getOas(): Promise<Oas>;
+  getBaseURL(): Promise<string | undefined>;
+};
+declare global {
+  namespace Kubb {
+    interface PluginContext extends Context$2 {}
+  }
+}
+type ResolvePathOptions = {
+  pluginKey?: Plugin['key'];
+  group?: {
+    tag?: string;
+    path?: string;
+  };
+  type?: ResolveNameParams['type'];
+};
+/**
+ * `propertyName` is the ref name + resolved with the nameResolver
+ *  @example import { Pet } from './Pet'
+ *
+ * `originalName` is the original name used(in PascalCase), only used to remove duplicates
+ *
+ * `pluginKey` can be used to override the current plugin being used, handy when you want to import a type/schema out of another plugin
+ * @example import a type(plugin-ts) for a mock file(swagger-faker)
+ */
+type Ref = {
+  propertyName: string;
+  originalName: string;
+  path: KubbFile.Path;
+  pluginKey?: Plugin['key'];
+};
+type Refs = Record<string, Ref>;
+type OperationSchema = {
+  /**
+   * Converted name, contains already `PathParams`, `QueryParams`, ...
+   */
+  name: string;
+  schema: SchemaObject$1;
+  operation?: Operation$1;
+  /**
+   * OperationName in PascalCase, only being used in OperationGenerator
+   */
+  operationName: string;
+  description?: string;
+  statusCode?: number;
+  keys?: string[];
+  keysToOmit?: string[];
+  withData?: boolean;
+};
+type OperationSchemas = {
+  pathParams?: OperationSchema & {
+    keysToOmit?: never;
+  };
+  queryParams?: OperationSchema & {
+    keysToOmit?: never;
+  };
+  headerParams?: OperationSchema & {
+    keysToOmit?: never;
+  };
+  request?: OperationSchema;
+  response: OperationSchema;
+  responses: Array<OperationSchema>;
+  statusCodes?: Array<OperationSchema>;
+  errors?: Array<OperationSchema>;
+};
+type ByTag = {
+  type: 'tag';
+  pattern: string | RegExp;
+};
+type ByOperationId = {
+  type: 'operationId';
+  pattern: string | RegExp;
+};
+type ByPath = {
+  type: 'path';
+  pattern: string | RegExp;
+};
+type ByMethod = {
+  type: 'method';
+  pattern: HttpMethod | RegExp;
+};
+type BySchemaName = {
+  type: 'schemaName';
+  pattern: string | RegExp;
+};
+type ByContentType = {
+  type: 'contentType';
+  pattern: string | RegExp;
+};
+type Exclude$1 = ByTag | ByOperationId | ByPath | ByMethod | ByContentType;
+type Include = ByTag | ByOperationId | ByPath | ByMethod | ByContentType;
+type Override<TOptions> = (ByTag | ByOperationId | ByPath | ByMethod | BySchemaName | ByContentType) & {
+  options: Partial<TOptions>;
+};
+//#endregion
+//#region ../plugin-oas/src/OperationGenerator.d.ts
+type Context$1<TOptions, TPluginOptions extends PluginFactoryOptions> = {
+  fabric: Fabric;
+  oas: Oas;
+  exclude: Array<Exclude$1> | undefined;
+  include: Array<Include> | undefined;
+  override: Array<Override<TOptions>> | undefined;
+  contentType: contentType | undefined;
+  pluginManager: PluginManager;
+  /**
+   * Current plugin
+   */
+  plugin: Plugin<TPluginOptions>;
+  mode: KubbFile.Mode;
+};
+declare class OperationGenerator<TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TPluginOptions['resolvedOptions'], Context$1<TPluginOptions['resolvedOptions'], TPluginOptions>> {
+  #private;
+  getSchemas(operation: Operation$1, {
+    resolveName
+  }?: {
+    resolveName?: (name: string) => string;
+  }): OperationSchemas;
+  getOperations(): Promise<Array<{
+    path: string;
+    method: HttpMethod;
+    operation: Operation$1;
+  }>>;
+  build(...generators: Array<Generator<TPluginOptions>>): Promise<Array<KubbFile.File<TFileMeta>>>;
+}
+//#endregion
 //#region ../plugin-oas/src/SchemaMapper.d.ts
 type SchemaKeywordMapper = {
   object: {
@@ -670,7 +795,7 @@ type SchemaKeywordMapper = {
       /**
        * Full qualified path.
        */
-      path: KubbFile.OptionalPath;
+      path: KubbFile.Path;
       /**
        * When true `File.Import` will be used.
        * When false a reference will be used inside the current file.
@@ -774,96 +899,8 @@ type Schema = {
   keyword: string;
 } | SchemaKeywordMapper[keyof SchemaKeywordMapper];
 //#endregion
-//#region ../plugin-oas/src/types.d.ts
-type ResolvePathOptions = {
-  pluginKey?: Plugin['key'];
-  group?: {
-    tag?: string;
-    path?: string;
-  };
-  type?: ResolveNameParams['type'];
-};
-/**
- * `propertyName` is the ref name + resolved with the nameResolver
- *  @example import { Pet } from './Pet'
- *
- * `originalName` is the original name used(in PascalCase), only used to remove duplicates
- *
- * `pluginKey` can be used to override the current plugin being used, handy when you want to import a type/schema out of another plugin
- * @example import a type(plugin-ts) for a mock file(swagger-faker)
- */
-type Ref = {
-  propertyName: string;
-  originalName: string;
-  path: KubbFile.OptionalPath;
-  pluginKey?: Plugin['key'];
-};
-type Refs = Record<string, Ref>;
-type OperationSchema = {
-  /**
-   * Converted name, contains already `PathParams`, `QueryParams`, ...
-   */
-  name: string;
-  schema: SchemaObject$1;
-  operation?: Operation$1;
-  /**
-   * OperationName in PascalCase, only being used in OperationGenerator
-   */
-  operationName: string;
-  description?: string;
-  statusCode?: number;
-  keys?: string[];
-  keysToOmit?: string[];
-  withData?: boolean;
-};
-type OperationSchemas = {
-  pathParams?: OperationSchema & {
-    keysToOmit?: never;
-  };
-  queryParams?: OperationSchema & {
-    keysToOmit?: never;
-  };
-  headerParams?: OperationSchema & {
-    keysToOmit?: never;
-  };
-  request?: OperationSchema;
-  response: OperationSchema;
-  responses: Array<OperationSchema>;
-  statusCodes?: Array<OperationSchema>;
-  errors?: Array<OperationSchema>;
-};
-type ByTag = {
-  type: 'tag';
-  pattern: string | RegExp;
-};
-type ByOperationId = {
-  type: 'operationId';
-  pattern: string | RegExp;
-};
-type ByPath = {
-  type: 'path';
-  pattern: string | RegExp;
-};
-type ByMethod = {
-  type: 'method';
-  pattern: HttpMethod | RegExp;
-};
-type BySchemaName = {
-  type: 'schemaName';
-  pattern: string | RegExp;
-};
-type ByContentType = {
-  type: 'contentType';
-  pattern: string | RegExp;
-};
-type Exclude$1 = ByTag | ByOperationId | ByPath | ByMethod | ByContentType;
-type Include = ByTag | ByOperationId | ByPath | ByMethod | ByContentType;
-type Override<TOptions> = (ByTag | ByOperationId | ByPath | ByMethod | BySchemaName | ByContentType) & {
-  options: Partial<TOptions>;
-};
-//#endregion
 //#region ../plugin-oas/src/SchemaGenerator.d.ts
-type Context$1<TOptions, TPluginOptions extends PluginFactoryOptions> = {
+type Context<TOptions, TPluginOptions extends PluginFactoryOptions> = {
   fabric: Fabric;
   oas: Oas;
   pluginManager: PluginManager;
@@ -904,7 +941,7 @@ type SchemaProps$1 = {
   name?: string;
   parentName?: string;
 };
-declare class SchemaGenerator<TOptions extends SchemaGeneratorOptions = SchemaGeneratorOptions, TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TOptions, Context$1<TOptions, TPluginOptions>> {
+declare class SchemaGenerator<TOptions extends SchemaGeneratorOptions = SchemaGeneratorOptions, TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TOptions, Context<TOptions, TPluginOptions>> {
   #private;
   refs: Refs;
   /**
@@ -919,15 +956,6 @@ declare class SchemaGenerator<TOptions extends SchemaGeneratorOptions = SchemaGe
   build(...generators: Array<Generator<TPluginOptions>>): Promise<Array<KubbFile.File<TFileMeta>>>;
 }
 //#endregion
-//#region ../plugin-oas/src/generators/createGenerator.d.ts
-type CoreGenerator<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  type: 'core';
-  operations: (props: OperationsProps<TOptions>) => Promise<KubbFile.File[]>;
-  operation: (props: OperationProps<TOptions>) => Promise<KubbFile.File[]>;
-  schema: (props: SchemaProps<TOptions>) => Promise<KubbFile.File[]>;
-};
-//#endregion
 //#region ../plugin-oas/src/generators/createReactGenerator.d.ts
 type ReactGenerator<TOptions extends PluginFactoryOptions> = {
   name: string;
@@ -962,35 +990,14 @@ type SchemaProps<TOptions extends PluginFactoryOptions> = {
 };
 type Generator<TOptions extends PluginFactoryOptions> = CoreGenerator<TOptions> | ReactGenerator<TOptions>;
 //#endregion
-//#region ../plugin-oas/src/OperationGenerator.d.ts
-type Context<TOptions, TPluginOptions extends PluginFactoryOptions> = {
-  fabric: Fabric;
-  oas: Oas;
-  exclude: Array<Exclude$1> | undefined;
-  include: Array<Include> | undefined;
-  override: Array<Override<TOptions>> | undefined;
-  contentType: contentType | undefined;
-  pluginManager: PluginManager;
-  /**
-   * Current plugin
-   */
-  plugin: Plugin<TPluginOptions>;
-  mode: KubbFile.Mode;
+//#region ../plugin-oas/src/generators/createGenerator.d.ts
+type CoreGenerator<TOptions extends PluginFactoryOptions> = {
+  name: string;
+  type: 'core';
+  operations: (props: OperationsProps<TOptions>) => Promise<KubbFile.File[]>;
+  operation: (props: OperationProps<TOptions>) => Promise<KubbFile.File[]>;
+  schema: (props: SchemaProps<TOptions>) => Promise<KubbFile.File[]>;
 };
-declare class OperationGenerator<TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TPluginOptions['resolvedOptions'], Context<TPluginOptions['resolvedOptions'], TPluginOptions>> {
-  #private;
-  getSchemas(operation: Operation$1, {
-    resolveName
-  }?: {
-    resolveName?: (name: string) => string;
-  }): OperationSchemas;
-  getOperations(): Promise<Array<{
-    path: string;
-    method: HttpMethod;
-    operation: Operation$1;
-  }>>;
-  build(...generators: Array<Generator<TPluginOptions>>): Promise<Array<KubbFile.File<TFileMeta>>>;
-}
 //#endregion
 //#region src/types.d.ts
 type Options$1 = {
@@ -1100,9 +1107,7 @@ type ResolvedOptions = {
   syntaxType: NonNullable<Options$1['syntaxType']>;
   mapper: Record<string, any>;
 };
-type PluginTs = PluginFactoryOptions<'plugin-ts', Options$1, ResolvedOptions, {
-  usedEnumNames: Record<string, number>;
-}, ResolvePathOptions>;
+type PluginTs = PluginFactoryOptions<'plugin-ts', Options$1, ResolvedOptions, never, ResolvePathOptions>;
 //#endregion
 export { UserPluginWithLifeCycle as a, Schema as i, PluginTs as n, OasTypes as o, ReactGenerator as r, SchemaObject$1 as s, Options$1 as t };
-//# sourceMappingURL=types-BXlkWRNi.d.ts.map
+//# sourceMappingURL=types-3bqiJQCB.d.cts.map