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

package/dist/transformers.cjs

@@ -2,22 +2,22 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var chunk2TOEDZ2U_cjs = require('./chunk-2TOEDZ2U.cjs');
-var chunk4GJEWGQN_cjs = require('./chunk-4GJEWGQN.cjs');
-var chunk72BWXKV4_cjs = require('./chunk-72BWXKV4.cjs');
+var chunkPAAEVG63_cjs = require('./chunk-PAAEVG63.cjs');
+var chunkZTR3NNAO_cjs = require('./chunk-ZTR3NNAO.cjs');
+var chunkYEWLGG6A_cjs = require('./chunk-YEWLGG6A.cjs');
 var remeda = require('remeda');
 
 // src/transformers/index.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 
 // src/transformers/combineCodes.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function combineCodes(codes) {
   return codes.join("\n");
 }
 
 // src/transformers/createJSDocBlockText.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function createJSDocBlockText({ comments }) {
   const filteredComments = comments.filter(Boolean);
   if (!filteredComments.length) {
@@ -29,7 +29,7 @@ function createJSDocBlockText({ comments }) {
 }
 
 // src/transformers/escape.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function escape(text) {
   return text ? text.replaceAll("`", "\\`") : "";
 }
@@ -56,13 +56,13 @@ function jsStringEscape(input) {
 }
 
 // src/transformers/indent.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function createIndent(size) {
   return Array.from({ length: size + 1 }).join(" ");
 }
 
 // src/transformers/nameSorter.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function nameSorter(a, b) {
   if (a.name < b.name) {
     return -1;
@@ -74,7 +74,7 @@ function nameSorter(a, b) {
 }
 
 // src/transformers/searchAndReplace.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function searchAndReplace(options) {
   const { text, replaceBy, prefix = "", key } = options;
   const searchValues = options.searchValues?.(prefix, key) || [
@@ -92,10 +92,10 @@ function searchAndReplace(options) {
 }
 
 // src/transformers/stringify.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 
 // src/transformers/trim.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function trim(text) {
   return text.replaceAll(/\n/g, "").trim();
 }
@@ -132,7 +132,7 @@ function stringifyObject(value) {
 }
 
 // src/transformers/toRegExp.ts
-chunk72BWXKV4_cjs.init_cjs_shims();
+chunkYEWLGG6A_cjs.init_cjs_shims();
 function stringToRegex(text) {
   const isStartWithSlash = text.startsWith("/");
   const isEndWithSlash = text.endsWith("/");
@@ -156,7 +156,7 @@ var transformers_default = {
   escape,
   jsStringEscape,
   createIndent,
-  transformReservedWord: chunk2TOEDZ2U_cjs.transformReservedWord,
+  transformReservedWord: chunkPAAEVG63_cjs.transformReservedWord,
   nameSorter,
   searchAndReplace,
   stringify,
@@ -168,32 +168,32 @@ var transformers_default = {
   JSDoc: {
     createJSDocBlockText
   },
-  orderBy: chunk4GJEWGQN_cjs.orderBy,
+  orderBy: chunkZTR3NNAO_cjs.orderBy,
   merge: remeda.merge,
-  camelCase: chunk4GJEWGQN_cjs.camelCase,
-  pascalCase: chunk4GJEWGQN_cjs.pascalCase,
-  pathCase: chunk4GJEWGQN_cjs.pathCase
+  camelCase: chunkZTR3NNAO_cjs.camelCase,
+  pascalCase: chunkZTR3NNAO_cjs.pascalCase,
+  pathCase: chunkZTR3NNAO_cjs.pathCase
 };
 
 Object.defineProperty(exports, "transformReservedWord", {
   enumerable: true,
-  get: function () { return chunk2TOEDZ2U_cjs.transformReservedWord; }
+  get: function () { return chunkPAAEVG63_cjs.transformReservedWord; }
 });
 Object.defineProperty(exports, "camelCase", {
   enumerable: true,
-  get: function () { return chunk4GJEWGQN_cjs.camelCase; }
+  get: function () { return chunkZTR3NNAO_cjs.camelCase; }
 });
 Object.defineProperty(exports, "orderBy", {
   enumerable: true,
-  get: function () { return chunk4GJEWGQN_cjs.orderBy; }
+  get: function () { return chunkZTR3NNAO_cjs.orderBy; }
 });
 Object.defineProperty(exports, "pascalCase", {
   enumerable: true,
-  get: function () { return chunk4GJEWGQN_cjs.pascalCase; }
+  get: function () { return chunkZTR3NNAO_cjs.pascalCase; }
 });
 Object.defineProperty(exports, "pathCase", {
   enumerable: true,
-  get: function () { return chunk4GJEWGQN_cjs.pathCase; }
+  get: function () { return chunkZTR3NNAO_cjs.pathCase; }
 });
 Object.defineProperty(exports, "merge", {
   enumerable: true,

package/dist/utils.cjs

@@ -1,66 +1,66 @@
 'use strict';
 
-var chunkSQBOUPF4_cjs = require('./chunk-SQBOUPF4.cjs');
-require('./chunk-4GJEWGQN.cjs');
-require('./chunk-72BWXKV4.cjs');
+var chunkE3M4QKGT_cjs = require('./chunk-E3M4QKGT.cjs');
+require('./chunk-ZTR3NNAO.cjs');
+require('./chunk-YEWLGG6A.cjs');
 
 
 
 Object.defineProperty(exports, "FunctionParams", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.FunctionParams; }
+  get: function () { return chunkE3M4QKGT_cjs.FunctionParams; }
 });
 Object.defineProperty(exports, "URLPath", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.URLPath; }
+  get: function () { return chunkE3M4QKGT_cjs.URLPath; }
 });
 Object.defineProperty(exports, "createFile", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.createFile; }
+  get: function () { return chunkE3M4QKGT_cjs.createFile; }
 });
 Object.defineProperty(exports, "createFileExport", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.createFileExport; }
+  get: function () { return chunkE3M4QKGT_cjs.createFileExport; }
 });
 Object.defineProperty(exports, "createFileImport", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.createFileImport; }
+  get: function () { return chunkE3M4QKGT_cjs.createFileImport; }
 });
 Object.defineProperty(exports, "createFileParser", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.createFileParser; }
+  get: function () { return chunkE3M4QKGT_cjs.createFileParser; }
 });
 Object.defineProperty(exports, "getFileParser", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.getFileParser; }
+  get: function () { return chunkE3M4QKGT_cjs.getFileParser; }
 });
 Object.defineProperty(exports, "getUniqueName", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.getUniqueName; }
+  get: function () { return chunkE3M4QKGT_cjs.getUniqueName; }
 });
 Object.defineProperty(exports, "isPromise", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.isPromise; }
+  get: function () { return chunkE3M4QKGT_cjs.isPromise; }
 });
 Object.defineProperty(exports, "isPromiseFulfilledResult", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.isPromiseFulfilledResult; }
+  get: function () { return chunkE3M4QKGT_cjs.isPromiseFulfilledResult; }
 });
 Object.defineProperty(exports, "isPromiseRejectedResult", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.isPromiseRejectedResult; }
+  get: function () { return chunkE3M4QKGT_cjs.isPromiseRejectedResult; }
 });
 Object.defineProperty(exports, "renderTemplate", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.renderTemplate; }
+  get: function () { return chunkE3M4QKGT_cjs.renderTemplate; }
 });
 Object.defineProperty(exports, "setUniqueName", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.setUniqueName; }
+  get: function () { return chunkE3M4QKGT_cjs.setUniqueName; }
 });
 Object.defineProperty(exports, "timeout", {
   enumerable: true,
-  get: function () { return chunkSQBOUPF4_cjs.timeout; }
+  get: function () { return chunkE3M4QKGT_cjs.timeout; }
 });
 //# sourceMappingURL=utils.cjs.map
 //# sourceMappingURL=utils.cjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.5",
   "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.5",
+    "@kubb/parser-ts": "3.0.0-beta.5",
+    "@kubb/types": "3.0.0-beta.5"
   },
   "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.5",
+    "@kubb/config-tsup": "3.0.0-beta.5"
   },
   "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
   /**