@kubb/core 0.39.1 → 0.41.0

package/dist/index.d.ts

@@ -10,14 +10,19 @@ interface Cache<TCache = any> {
 declare function createPluginCache(cache: any): Cache;
 
 type MaybePromise<T> = Promise<T> | T;
-type KubbUserConfig<IsJSON = false> = Omit<KubbConfig, 'root'> & {
+type KubbUserConfig = Omit<KubbConfig, 'root'> & {
     /**
      * Project root directory. Can be an absolute path, or a path relative from
      * the location of the config file itself.
      * @default process.cwd()
      */
     root?: string;
-    plugins?: IsJSON extends true ? KubbJSONPlugin[] : KubbPlugin[];
+    /**
+     * Plugin type can be KubbJSONPlugin or KubbPlugin
+     * Example: ['@kubb/swagger', { output: false }]
+     * Or: createSwagger({ output: false })
+     */
+    plugins?: Array<unknown>;
 };
 /**
  * Global/internal config used through out the full generation.
@@ -91,6 +96,10 @@ type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
      * Defined an api that can be used by other plugins
      */
     api?: TOptions['api'];
+    /**
+     * Options set for a specific plugin(see kubb.config.ts)
+     */
+    options?: TOptions['options'];
 } & Partial<PluginLifecycle>;
 type PluginFactoryOptions<Options = unknown, Nested extends boolean = false, Api = any> = {
     options: Options;
@@ -153,9 +162,7 @@ type PluginContext = {
     config: KubbConfig;
     cache: Cache;
     fileManager: FileManager;
-    addFile: (emitedFile: EmittedFile | File, options?: {
-        root?: true;
-    }) => Promise<File>;
+    addFile: (file: File) => Promise<File>;
     resolveId: (params: ResolveIdParams) => MaybePromise<OptionalPath>;
     load: (id: string) => MaybePromise<TransformResult | void>;
 };
@@ -179,29 +186,6 @@ type PathMode = 'file' | 'directory';
 declare const getPathMode: (path: string | undefined | null) => PathMode | undefined;
 declare const read: (path: string) => Promise<string>;
 
-/**
- * @deprecated Use userFile instead
- */
-type EmittedFile = {
-    /**
-     *  equal to importee when getting passed through resolveId
-     */
-    id: string;
-    /**
-     * The importer is the fully resolved id of the importing module.
-     */
-    importer?: string;
-    /**
-     * Name to be used to dynamicly create the fileName(based on input.path)
-     */
-    name?: string;
-    /**
-     * FileName will be the end result so no input.path will not be added
-     */
-    fileName?: string;
-    source?: string;
-    options?: Record<string, any>;
-};
 type Import = {
     name: string | string[];
     path: string;
@@ -246,6 +230,7 @@ declare class FileManager {
     private getCache;
     private getCacheByPath;
     private getCountByStatus;
+    private getSource;
     get files(): File[];
     add(file: File): Promise<File>;
     build(file: File): string;
@@ -305,7 +290,7 @@ declare function build(options: BuildOptions): Promise<BuildOutput>;
  * accepts a direct {@link KubbConfig} object, or a function that returns it.
  * The function receives a {@link ConfigEnv} object that exposes two properties:
  */
-declare const defineConfig: (options: MaybePromise<KubbUserConfig<false>> | ((cliOptions: CLIOptions) => MaybePromise<KubbUserConfig>)) => MaybePromise<KubbUserConfig<false>> | ((cliOptions: CLIOptions) => MaybePromise<KubbUserConfig>);
+declare const defineConfig: (options: MaybePromise<KubbUserConfig> | ((cliOptions: CLIOptions) => MaybePromise<KubbUserConfig>)) => MaybePromise<KubbUserConfig> | ((cliOptions: CLIOptions) => MaybePromise<KubbUserConfig>);
 
 type KubbPluginFactory<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => T['nested'] extends true ? Array<KubbPlugin<T>> : KubbPlugin<T>;
 declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(factory: KubbPluginFactory<T>): (options: T['options']) => T["nested"] extends true ? KubbPlugin<T>[] : KubbPlugin<T>;
@@ -383,4 +368,4 @@ declare abstract class SchemaGenerator<TOptions extends object, TInput, TOutput>
     abstract build(schema: TInput, name: string, description?: string): TOutput;
 }
 
-export { Argument0, CLIOptions, Cache, CacheStore, CorePluginOptions, EmittedFile, File, FileManager, FileName, Generator, KubbBuild, KubbConfig, KubbJSONPlugin, KubbPlugin, KubbPluginKind, KubbUserConfig, LogLevel, LogType, Logger, MaybePromise, OptionalPath, Path, PathMode, PluginContext, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, ResolveIdParams, SchemaGenerator, Status, Strategy, TransformResult, TreeNode, UUID, ValidationPluginError, build, clean, createPlugin, createPluginCache, build as default, defineConfig, getPathMode, getRelativePath, hooks, isPromise, name, read, validatePlugins, write };
+export { Argument0, CLIOptions, Cache, CacheStore, CorePluginOptions, File, FileManager, FileName, Generator, KubbBuild, KubbConfig, KubbJSONPlugin, KubbPlugin, KubbPluginKind, KubbUserConfig, LogLevel, LogType, Logger, MaybePromise, OptionalPath, Path, PathMode, PluginContext, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, ResolveIdParams, SchemaGenerator, Status, Strategy, TransformResult, TreeNode, UUID, ValidationPluginError, build, clean, createPlugin, createPluginCache, build as default, defineConfig, getPathMode, getRelativePath, hooks, isPromise, name, read, validatePlugins, write };