@kubb/plugin-faker 4.4.0 → 4.5.0

package/dist/{types-C6bgZQkZ.d.cts → types-CEWRTyrN.d.ts}

@@ -1,4 +1,5 @@
 import { Fabric, FileManager } from "@kubb/react-fabric";
+import { KubbFile } from "@kubb/fabric-core/types";
 import { ConsolaInstance, LogLevel } from "consola";
 import * as OasTypes from "oas/types";
 import { HttpMethods as HttpMethod, OASDocument, SchemaObject, User } from "oas/types";
@@ -22,121 +23,6 @@ declare abstract class BaseGenerator<TOptions = unknown, TContext = unknown> {
   abstract build(...params: unknown[]): unknown;
 }
 //#endregion
-//#region ../core/src/fs/types.d.ts
-type BasePath<T extends string = string> = `${T}/`;
-type Import = {
-  /**
-   * Import name to be used
-   * @example ["useState"]
-   * @example "React"
-   */
-  name: string | Array<string | {
-    propertyName: string;
-    name?: string;
-  }>;
-  /**
-   * Path for the import
-   * @example '@kubb/core'
-   */
-  path: string;
-  /**
-   * Add `type` prefix to the import, this will result in: `import type { Type } from './path'`.
-   */
-  isTypeOnly?: boolean;
-  isNameSpace?: boolean;
-  /**
-   * When root is set it will get the path with relative getRelativePath(root, path).
-   */
-  root?: string;
-};
-type Source = {
-  name?: string;
-  value?: string;
-  isTypeOnly?: boolean;
-  /**
-   * Has const or type 'export'
-   * @default false
-   */
-  isExportable?: boolean;
-  /**
-   * When set, barrel generation will add this
-   * @default false
-   */
-  isIndexable?: boolean;
-};
-type Export = {
-  /**
-   * Export name to be used.
-   * @example ["useState"]
-   * @example "React"
-   */
-  name?: string | Array<string>;
-  /**
-   * Path for the import.
-   * @example '@kubb/core'
-   */
-  path: string;
-  /**
-   * Add `type` prefix to the export, this will result in: `export type { Type } from './path'`.
-   */
-  isTypeOnly?: boolean;
-  /**
-   * Make it possible to override the name, this will result in: `export * as aliasName from './path'`.
-   */
-  asAlias?: boolean;
-};
-type Extname = '.ts' | '.js' | '.tsx' | '.json' | `.${string}`;
-type Mode = 'single' | 'split';
-/**
- * Name to be used to dynamicly create the baseName(based on input.path)
- * Based on UNIX basename
- * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
- */
-type BaseName = `${string}.${string}`;
-/**
- * Path will be full qualified path to a specified file
- */
-type Path = string;
-type AdvancedPath<T extends BaseName = BaseName> = `${BasePath}${T}`;
-type OptionalPath = Path | undefined | null;
-type File<TMeta extends object = object> = {
-  /**
-   * Name to be used to create the path
-   * Based on UNIX basename, `${name}.extname`
-   * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
-   */
-  baseName: BaseName;
-  /**
-   * Path will be full qualified path to a specified file
-   */
-  path: AdvancedPath<BaseName> | Path;
-  sources: Array<Source>;
-  imports?: Array<Import>;
-  exports?: Array<Export>;
-  /**
-   * Use extra meta, this is getting used to generate the barrel/index files.
-   */
-  meta?: TMeta;
-  banner?: string;
-  footer?: string;
-};
-type ResolvedImport = Import;
-type ResolvedExport = Export;
-type ResolvedFile<TMeta extends object = object> = File<TMeta> & {
-  /**
-   * @default object-hash
-   */
-  id: string;
-  /**
-   * Contains the first part of the baseName, generated based on baseName
-   * @link  https://nodejs.org/api/path.html#pathformatpathobject
-   */
-  name: string;
-  extname: Extname;
-  imports: Array<ResolvedImport>;
-  exports: Array<ResolvedExport>;
-};
-//#endregion
 //#region ../core/src/utils/EventEmitter.d.ts
 declare class EventEmitter<TEvents extends Record<string, any>> {
   #private;
@@ -260,7 +146,7 @@ type Config<TInput = Input> = {
      * Override the extension to the generated imports and exports, by default each plugin will add an extension
      * @default { '.ts': '.ts'}
      */
-    extension?: Record<Extname, Extname | ''>;
+    extension?: Record<KubbFile.Extname, KubbFile.Extname | ''>;
     /**
      * Specify how `index.ts` files should be created. You can also disable the generation of barrel files here. While each plugin has its own `barrelType` option, this setting controls the creation of the root barrel file, such as` src/gen/index.ts`.
      * @default 'named'
@@ -391,7 +277,7 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
    * @type hookFirst
    * @example ('./Pet.ts', './src/gen/') => '/src/gen/Pet.ts'
    */
-  resolvePath?: (this: PluginContext<TOptions>, baseName: BaseName, mode?: Mode, options?: TOptions['resolvePathOptions']) => OptionalPath;
+  resolvePath?: (this: PluginContext<TOptions>, baseName: KubbFile.BaseName, mode?: KubbFile.Mode, options?: TOptions['resolvePathOptions']) => KubbFile.OptionalPath;
   /**
    * Resolve to a name based on a string.
    * Useful when converting to PascalCase or camelCase.
@@ -409,8 +295,8 @@ type PluginLifecycleHooks = keyof PluginLifecycle;
 type PluginParameter<H extends PluginLifecycleHooks> = Parameters<Required<PluginLifecycle>[H]>;
 type ResolvePathParams<TOptions = object> = {
   pluginKey?: Plugin['key'];
-  baseName: BaseName;
-  mode?: Mode;
+  baseName: KubbFile.BaseName;
+  mode?: KubbFile.Mode;
   /**
    * Options to be passed to 'resolvePath' 3th parameter
    */
@@ -435,8 +321,8 @@ type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions>
    */
   fileManager: FileManager;
   pluginManager: PluginManager;
-  addFile: (...file: Array<File>) => Promise<Array<ResolvedFile>>;
-  resolvePath: (params: ResolvePathParams<TOptions['resolvePathOptions']>) => OptionalPath;
+  addFile: (...file: Array<KubbFile.File>) => Promise<Array<KubbFile.ResolvedFile>>;
+  resolvePath: (params: ResolvePathParams<TOptions['resolvePathOptions']>) => KubbFile.OptionalPath;
   resolveName: (params: ResolveNameParams) => string;
   logger: Logger;
   /**
@@ -515,8 +401,8 @@ type Events = {
 };
 type GetFileProps<TOptions = object> = {
   name: string;
-  mode?: Mode;
-  extname: Extname;
+  mode?: KubbFile.Mode;
+  extname: KubbFile.Extname;
   pluginKey: Plugin['key'];
   options?: TOptions;
 };
@@ -535,10 +421,10 @@ declare class PluginManager {
     extname,
     pluginKey,
     options
-  }: GetFileProps<TOptions>): File<{
+  }: GetFileProps<TOptions>): KubbFile.File<{
     pluginKey: Plugin['key'];
   }>;
-  resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => OptionalPath;
+  resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => KubbFile.OptionalPath;
   resolveName: (params: ResolveNameParams) => string;
   /**
    * Instead of calling `pluginManager.events.on` you can use `pluginManager.on`. This one also has better types.
@@ -670,170 +556,6 @@ declare class Oas<const TOAS = unknown> extends BaseOas {
   valdiate(): Promise<oas_normalize_lib_types0.ValidationResult>;
 }
 //#endregion
-//#region ../plugin-oas/src/generators/createReactGenerator.d.ts
-type ReactGenerator<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  type: 'react';
-  Operations: (props: OperationsProps<TOptions>) => KubbNode;
-  Operation: (props: OperationProps<TOptions>) => KubbNode;
-  Schema: (props: SchemaProps$1<TOptions>) => KubbNode;
-};
-//#endregion
-//#region ../plugin-oas/src/generators/types.d.ts
-type OperationsProps<TOptions extends PluginFactoryOptions> = {
-  /**
-   * @deprecated
-   */
-  instance: Omit<OperationGenerator<TOptions>, 'build'>;
-  options: TOptions['resolvedOptions'];
-  operations: Array<Operation$1>;
-};
-type OperationProps<TOptions extends PluginFactoryOptions> = {
-  /**
-   * @deprecated
-   */
-  instance: Omit<OperationGenerator<TOptions>, 'build'>;
-  options: TOptions['resolvedOptions'];
-  operation: Operation$1;
-};
-type SchemaProps$1<TOptions extends PluginFactoryOptions> = {
-  instance: Omit<SchemaGenerator<SchemaGeneratorOptions, TOptions>, 'build'>;
-  options: TOptions['resolvedOptions'];
-  schema: {
-    name: string;
-    tree: Array<Schema>;
-    value: SchemaObject$1;
-  };
-};
-type Generator<TOptions extends PluginFactoryOptions> = CoreGenerator<TOptions> | ReactGenerator<TOptions>;
-//#endregion
-//#region ../plugin-oas/src/generators/createGenerator.d.ts
-type CoreGenerator<TOptions extends PluginFactoryOptions> = {
-  name: string;
-  type: 'core';
-  operations: (props: OperationsProps<TOptions>) => Promise<File[]>;
-  operation: (props: OperationProps<TOptions>) => Promise<File[]>;
-  schema: (props: SchemaProps$1<TOptions>) => Promise<File[]>;
-};
-//#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: 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/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: 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<File<TFileMeta>>>;
-}
-//#endregion
 //#region ../plugin-oas/src/SchemaMapper.d.ts
 type SchemaKeywordMapper = {
   object: {
@@ -947,7 +669,7 @@ type SchemaKeywordMapper = {
       /**
        * Full qualified path.
        */
-      path: OptionalPath;
+      path: KubbFile.OptionalPath;
       /**
        * When true `File.Import` will be used.
        * When false a reference will be used inside the current file.
@@ -1051,8 +773,96 @@ 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<TOptions, TPluginOptions extends PluginFactoryOptions> = {
+type Context$1<TOptions, TPluginOptions extends PluginFactoryOptions> = {
   fabric: Fabric;
   oas: Oas;
   pluginManager: PluginManager;
@@ -1060,7 +870,7 @@ type Context<TOptions, TPluginOptions extends PluginFactoryOptions> = {
    * Current plugin
    */
   plugin: Plugin<TPluginOptions>;
-  mode: Mode;
+  mode: KubbFile.Mode;
   include?: Array<'schemas' | 'responses' | 'requestBodies'>;
   override: Array<Override<TOptions>> | undefined;
   contentType?: contentType;
@@ -1085,15 +895,15 @@ type SchemaGeneratorOptions = {
      * TODO TODO add docs
      * @beta
      */
-    schema?: (schemaProps: SchemaProps, defaultSchemas: Schema[]) => Schema[] | undefined;
+    schema?: (schemaProps: SchemaProps$1, defaultSchemas: Schema[]) => Schema[] | undefined;
   };
 };
-type SchemaProps = {
+type SchemaProps$1 = {
   schemaObject?: SchemaObject$1;
   name?: string;
   parentName?: string;
 };
-declare class SchemaGenerator<TOptions extends SchemaGeneratorOptions = SchemaGeneratorOptions, TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TOptions, Context<TOptions, TPluginOptions>> {
+declare class SchemaGenerator<TOptions extends SchemaGeneratorOptions = SchemaGeneratorOptions, TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TOptions, Context$1<TOptions, TPluginOptions>> {
   #private;
   refs: Refs;
   /**
@@ -1101,14 +911,84 @@ declare class SchemaGenerator<TOptions extends SchemaGeneratorOptions = SchemaGe
    * Delegates to getBaseTypeFromSchema internally and
    * optionally adds a union with null.
    */
-  parse(props: SchemaProps): Schema[];
-  deepSearch<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): Array<SchemaKeywordMapper[T]>;
-  find<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T] | undefined;
+  parse(props: SchemaProps$1): Schema[];
   static deepSearch<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): Array<SchemaKeywordMapper[T]>;
-  static findInObject<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T] | undefined;
   static find<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T] | undefined;
   static combineObjects(tree: Schema[] | undefined): Schema[];
-  build(...generators: Array<Generator<TPluginOptions>>): Promise<Array<File<TFileMeta>>>;
+  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;
+  type: 'react';
+  Operations: (props: OperationsProps<TOptions>) => KubbNode;
+  Operation: (props: OperationProps<TOptions>) => KubbNode;
+  Schema: (props: SchemaProps<TOptions>) => KubbNode;
+};
+//#endregion
+//#region ../plugin-oas/src/generators/types.d.ts
+type OperationsProps<TOptions extends PluginFactoryOptions> = {
+  config: Config;
+  generator: Omit<OperationGenerator<TOptions>, 'build'>;
+  plugin: Plugin<TOptions>;
+  operations: Array<Operation$1>;
+};
+type OperationProps<TOptions extends PluginFactoryOptions> = {
+  config: Config;
+  generator: Omit<OperationGenerator<TOptions>, 'build'>;
+  plugin: Plugin<TOptions>;
+  operation: Operation$1;
+};
+type SchemaProps<TOptions extends PluginFactoryOptions> = {
+  config: Config;
+  generator: Omit<SchemaGenerator<SchemaGeneratorOptions, TOptions>, 'build'>;
+  plugin: Plugin<TOptions>;
+  schema: {
+    name: string;
+    tree: Array<Schema>;
+    value: SchemaObject$1;
+  };
+};
+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;
+};
+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
@@ -1214,5 +1094,5 @@ type ResolvedOptions = {
 };
 type PluginFaker = PluginFactoryOptions<'plugin-faker', Options$1, ResolvedOptions, never, ResolvePathOptions>;
 //#endregion
-export { UserPluginWithLifeCycle as a, ReactGenerator as i, PluginFaker as n, Schema as r, Options$1 as t };
-//# sourceMappingURL=types-C6bgZQkZ.d.cts.map
+export { UserPluginWithLifeCycle as a, Schema as i, PluginFaker as n, ReactGenerator as r, Options$1 as t };
+//# sourceMappingURL=types-CEWRTyrN.d.ts.map