@kubb/core 3.0.0-beta.3 → 3.0.0-beta.4

package/dist/{FileManager-C9aZTwst.d.ts → FileManager-Cn8nSj1H.d.ts}

@@ -111,34 +111,34 @@ declare class PluginManager {
 }
 
 /**
- * Config used in `kubb.config.js`
+ * Config used in `kubb.config.ts`
  *
- * @example import { defineConfig } from '@kubb/core'
+ * @example
+ * import { defineConfig } from '@kubb/core'
  * export default defineConfig({
  * ...
  * })
  */
 type UserConfig = Omit<Config, 'root' | 'plugins'> & {
     /**
-     * Project root directory. Can be an absolute path, or a path relative from
-     * the location of the config file itself.
+     * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
      * @default process.cwd()
      */
     root?: string;
     /**
-     * Plugin type should be a Kubb plugin
+     * An array of Kubb plugins used for generation. Each plugin may have additional configurable options (defined within the plugin itself). If a plugin relies on another plugin, an error will occur if the required dependency is missing. Refer to “pre” for more details.
      */
     plugins?: Array<Omit<UnknownUserPlugin, 'context'>>;
 };
 type InputPath = {
     /**
-     * Define your Swagger/OpenAPI file. This can be an absolute path or a path relative to the `root`.
+     * Specify your Swagger/OpenAPI file, either as an absolute path or a path relative to the root.
      */
     path: string;
 };
 type InputData = {
     /**
-     * `string` or `object` containing your Swagger/OpenAPI data.
+     * A `string` or `object` that contains your Swagger/OpenAPI data.
      */
     data: string | unknown;
 };
@@ -149,21 +149,22 @@ type BarrelType = 'all' | 'named';
  */
 type Config<TInput = Input> = {
     /**
-     * Optional config name to show in CLI output
+     * The name to display in the CLI output.
      */
     name?: string;
     /**
-     * Project root directory. This can be an absolute path or a path relative to the location of your `kubb.config.ts` file.
+     * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
      * @default process.cwd()
      */
     root: string;
     /**
-     * You can use `input.path` or `input.data` depending on the needs you have.
+     * You can use either `input.path` or `input.data`, depending on your specific needs.
      */
     input: TInput;
     output: {
         /**
-         * The path where all generated files will be exported. This can be an absolute path or a path relative to the specified root option.
+         * The path where all generated files will be exported.
+         * This can be an absolute path or a path relative to the specified root option.
          */
         path: string;
         /**
@@ -176,13 +177,13 @@ type Config<TInput = Input> = {
          */
         write?: boolean;
         /**
-         * Override the extension to the generated imports and exports, by default the plugin will add an extension
-         * @default `{ '.ts': '.ts'}`
+         * Override the extension to the generated imports and exports, by default each plugin will add an extension
+         * @default { '.ts': '.ts'}
          */
         extension?: Record<KubbFile.Extname, KubbFile.Extname>;
         /**
-         * Define what needs to exported, here you can also disable the export of barrel files.
-         * @default `'named'`
+         * 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'
          */
         barrelType?: BarrelType | false;
     };
@@ -368,7 +369,7 @@ type Output = {
     path: string;
     /**
      * Define what needs to be exported, here you can also disable the export of barrel files
-     * @default `'named'`
+     * @default 'named'
      */
     barrelType?: BarrelType | false;
     /**

package/dist/{FileManager-ibNoWwHN.d.cts → FileManager-DKZ30qz_.d.cts}

@@ -111,34 +111,34 @@ declare class PluginManager {
 }
 
 /**
- * Config used in `kubb.config.js`
+ * Config used in `kubb.config.ts`
  *
- * @example import { defineConfig } from '@kubb/core'
+ * @example
+ * import { defineConfig } from '@kubb/core'
  * export default defineConfig({
  * ...
  * })
  */
 type UserConfig = Omit<Config, 'root' | 'plugins'> & {
     /**
-     * Project root directory. Can be an absolute path, or a path relative from
-     * the location of the config file itself.
+     * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
      * @default process.cwd()
      */
     root?: string;
     /**
-     * Plugin type should be a Kubb plugin
+     * An array of Kubb plugins used for generation. Each plugin may have additional configurable options (defined within the plugin itself). If a plugin relies on another plugin, an error will occur if the required dependency is missing. Refer to “pre” for more details.
      */
     plugins?: Array<Omit<UnknownUserPlugin, 'context'>>;
 };
 type InputPath = {
     /**
-     * Define your Swagger/OpenAPI file. This can be an absolute path or a path relative to the `root`.
+     * Specify your Swagger/OpenAPI file, either as an absolute path or a path relative to the root.
      */
     path: string;
 };
 type InputData = {
     /**
-     * `string` or `object` containing your Swagger/OpenAPI data.
+     * A `string` or `object` that contains your Swagger/OpenAPI data.
      */
     data: string | unknown;
 };
@@ -149,21 +149,22 @@ type BarrelType = 'all' | 'named';
  */
 type Config<TInput = Input> = {
     /**
-     * Optional config name to show in CLI output
+     * The name to display in the CLI output.
      */
     name?: string;
     /**
-     * Project root directory. This can be an absolute path or a path relative to the location of your `kubb.config.ts` file.
+     * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
      * @default process.cwd()
      */
     root: string;
     /**
-     * You can use `input.path` or `input.data` depending on the needs you have.
+     * You can use either `input.path` or `input.data`, depending on your specific needs.
      */
     input: TInput;
     output: {
         /**
-         * The path where all generated files will be exported. This can be an absolute path or a path relative to the specified root option.
+         * The path where all generated files will be exported.
+         * This can be an absolute path or a path relative to the specified root option.
          */
         path: string;
         /**
@@ -176,13 +177,13 @@ type Config<TInput = Input> = {
          */
         write?: boolean;
         /**
-         * Override the extension to the generated imports and exports, by default the plugin will add an extension
-         * @default `{ '.ts': '.ts'}`
+         * Override the extension to the generated imports and exports, by default each plugin will add an extension
+         * @default { '.ts': '.ts'}
          */
         extension?: Record<KubbFile.Extname, KubbFile.Extname>;
         /**
-         * Define what needs to exported, here you can also disable the export of barrel files.
-         * @default `'named'`
+         * 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'
          */
         barrelType?: BarrelType | false;
     };
@@ -368,7 +369,7 @@ type Output = {
     path: string;
     /**
      * Define what needs to be exported, here you can also disable the export of barrel files
-     * @default `'named'`
+     * @default 'named'
      */
     barrelType?: BarrelType | false;
     /**

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { P as PluginContext, F as FileManager, a as PluginManager, U as UserConfig, C as Config, I as InputPath, b as PluginFactoryOptions, c as UserPluginWithLifeCycle } from './FileManager-ibNoWwHN.cjs';
-export { B as BarrelType, d as FileMetaBase, G as GetPluginFactoryOptions, o as Group, e as InputData, O as Output, i as Plugin, f as PluginKey, k as PluginLifecycle, l as PluginLifecycleHooks, m as PluginParameter, j as PluginWithLifeCycle, n as ResolveNameParams, R as ResolvePathParams, h as UserPlugin, g as getSource } from './FileManager-ibNoWwHN.cjs';
+import { P as PluginContext, F as FileManager, a as PluginManager, U as UserConfig, C as Config, I as InputPath, b as PluginFactoryOptions, c as UserPluginWithLifeCycle } from './FileManager-DKZ30qz_.cjs';
+export { B as BarrelType, d as FileMetaBase, G as GetPluginFactoryOptions, o as Group, e as InputData, O as Output, i as Plugin, f as PluginKey, k as PluginLifecycle, l as PluginLifecycleHooks, m as PluginParameter, j as PluginWithLifeCycle, n as ResolveNameParams, R as ResolvePathParams, h as UserPlugin, g as getSource } from './FileManager-DKZ30qz_.cjs';
 import { L as Logger } from './logger-DvbHXjIO.cjs';
 import { PossiblePromise } from '@kubb/types';
 import '@kubb/fs';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { P as PluginContext, F as FileManager, a as PluginManager, U as UserConfig, C as Config, I as InputPath, b as PluginFactoryOptions, c as UserPluginWithLifeCycle } from './FileManager-C9aZTwst.js';
-export { B as BarrelType, d as FileMetaBase, G as GetPluginFactoryOptions, o as Group, e as InputData, O as Output, i as Plugin, f as PluginKey, k as PluginLifecycle, l as PluginLifecycleHooks, m as PluginParameter, j as PluginWithLifeCycle, n as ResolveNameParams, R as ResolvePathParams, h as UserPlugin, g as getSource } from './FileManager-C9aZTwst.js';
+import { P as PluginContext, F as FileManager, a as PluginManager, U as UserConfig, C as Config, I as InputPath, b as PluginFactoryOptions, c as UserPluginWithLifeCycle } from './FileManager-Cn8nSj1H.js';
+export { B as BarrelType, d as FileMetaBase, G as GetPluginFactoryOptions, o as Group, e as InputData, O as Output, i as Plugin, f as PluginKey, k as PluginLifecycle, l as PluginLifecycleHooks, m as PluginParameter, j as PluginWithLifeCycle, n as ResolveNameParams, R as ResolvePathParams, h as UserPlugin, g as getSource } from './FileManager-Cn8nSj1H.js';
 import { L as Logger } from './logger-DvbHXjIO.js';
 import { PossiblePromise } from '@kubb/types';
 import '@kubb/fs';

package/dist/mocks.d.cts

@@ -1,5 +1,5 @@
 import { ResolvedFile, File } from '@kubb/fs/types';
-import { a as PluginManager } from './FileManager-ibNoWwHN.cjs';
+import { a as PluginManager } from './FileManager-DKZ30qz_.cjs';
 import { L as Logger } from './logger-DvbHXjIO.cjs';
 import '@kubb/fs';
 import '@kubb/types';

package/dist/mocks.d.ts

@@ -1,5 +1,5 @@
 import { ResolvedFile, File } from '@kubb/fs/types';
-import { a as PluginManager } from './FileManager-C9aZTwst.js';
+import { a as PluginManager } from './FileManager-Cn8nSj1H.js';
 import { L as Logger } from './logger-DvbHXjIO.js';
 import '@kubb/fs';
 import '@kubb/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.4",
   "description": "Generator core",
   "keywords": [
     "typescript",
@@ -83,9 +83,9 @@
     "remeda": "^2.14.0",
     "seedrandom": "^3.0.5",
     "semver": "^7.6.3",
-    "@kubb/fs": "3.0.0-beta.3",
-    "@kubb/parser-ts": "3.0.0-beta.3",
-    "@kubb/types": "3.0.0-beta.3"
+    "@kubb/fs": "3.0.0-beta.4",
+    "@kubb/parser-ts": "3.0.0-beta.4",
+    "@kubb/types": "3.0.0-beta.4"
   },
   "devDependencies": {
     "@types/object-hash": "^3.0.6",
@@ -96,8 +96,8 @@
     "tinyrainbow": "^1.2.0",
     "tsup": "^8.3.0",
     "typescript": "^5.6.2",
-    "@kubb/config-ts": "3.0.0-beta.3",
-    "@kubb/config-tsup": "3.0.0-beta.3"
+    "@kubb/config-ts": "3.0.0-beta.4",
+    "@kubb/config-tsup": "3.0.0-beta.4"
   },
   "engines": {
     "node": ">=20"

package/src/types.ts

@@ -4,39 +4,37 @@ import type { FileManager } from './FileManager.ts'
 import type { PluginManager } from './PluginManager.ts'
 import type { Logger } from './logger.ts'
 
-// config
-
 /**
- * Config used in `kubb.config.js`
+ * Config used in `kubb.config.ts`
  *
- * @example import { defineConfig } from '@kubb/core'
+ * @example
+ * import { defineConfig } from '@kubb/core'
  * export default defineConfig({
  * ...
  * })
  */
 export type UserConfig = Omit<Config, 'root' | 'plugins'> & {
   /**
-   * Project root directory. Can be an absolute path, or a path relative from
-   * the location of the config file itself.
+   * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
    * @default process.cwd()
    */
   root?: string
   /**
-   * Plugin type should be a Kubb plugin
+   * An array of Kubb plugins used for generation. Each plugin may have additional configurable options (defined within the plugin itself). If a plugin relies on another plugin, an error will occur if the required dependency is missing. Refer to “pre” for more details.
    */
   plugins?: Array<Omit<UnknownUserPlugin, 'context'>>
 }
 
 export type InputPath = {
   /**
-   * Define your Swagger/OpenAPI file. This can be an absolute path or a path relative to the `root`.
+   * Specify your Swagger/OpenAPI file, either as an absolute path or a path relative to the root.
    */
   path: string
 }
 
 export type InputData = {
   /**
-   * `string` or `object` containing your Swagger/OpenAPI data.
+   * A `string` or `object` that contains your Swagger/OpenAPI data.
    */
   data: string | unknown
 }
@@ -50,21 +48,22 @@ export type BarrelType = 'all' | 'named'
  */
 export type Config<TInput = Input> = {
   /**
-   * Optional config name to show in CLI output
+   * The name to display in the CLI output.
    */
   name?: string
   /**
-   * Project root directory. This can be an absolute path or a path relative to the location of your `kubb.config.ts` file.
+   * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file.
    * @default process.cwd()
    */
   root: string
   /**
-   * You can use `input.path` or `input.data` depending on the needs you have.
+   * You can use either `input.path` or `input.data`, depending on your specific needs.
    */
   input: TInput
   output: {
     /**
-     * The path where all generated files will be exported. This can be an absolute path or a path relative to the specified root option.
+     * The path where all generated files will be exported.
+     * This can be an absolute path or a path relative to the specified root option.
      */
     path: string
     /**
@@ -78,13 +77,13 @@ export type Config<TInput = Input> = {
     write?: boolean
 
     /**
-     * Override the extension to the generated imports and exports, by default the plugin will add an extension
-     * @default `{ '.ts': '.ts'}`
+     * Override the extension to the generated imports and exports, by default each plugin will add an extension
+     * @default { '.ts': '.ts'}
      */
     extension?: Record<KubbFile.Extname, KubbFile.Extname>
     /**
-     * Define what needs to exported, here you can also disable the export of barrel files.
-     * @default `'named'`
+     * 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'
      */
     barrelType?: BarrelType | false
   }
@@ -299,7 +298,7 @@ export type Output = {
   path: string
   /**
    * Define what needs to be exported, here you can also disable the export of barrel files
-   * @default `'named'`
+   * @default 'named'
    */
   barrelType?: BarrelType | false
   /**