@kubb/plugin-ts 3.0.0-alpha.2 → 3.0.0-alpha.21

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/kubb/kubb/packages/plugin-ts/dist/index.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,wDAA6B;AAC7B;AACE;AACA;AACF,qGAAC","file":"/home/runner/work/kubb/kubb/packages/plugin-ts/dist/index.cjs"}
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/index.d.cts

@@ -1,127 +1,9 @@
 import * as _kubb_core from '@kubb/core';
-import { PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
-import * as KubbFile from '@kubb/fs/types';
-import { ResolvePathOptions, Exclude, Include, Override } from '@kubb/plugin-oas';
-import { ts } from '@kubb/parser-ts';
-
-type Options = {
-    output?: {
-        /**
-         * Relative path to save the TypeScript types.
-         * When output is a file it will save all models inside that file else it will create a file per schema item.
-         * @default 'types'
-         */
-        path: string;
-        /**
-         * Name to be used for the `export * as {{exportAs}} from './'`
-         */
-        exportAs?: string;
-        /**
-         * Add an extension to the generated imports and exports, default it will not use an extension
-         */
-        extName?: KubbFile.Extname;
-        /**
-         * Define what needs to exported, here you can also disable the export of barrel files
-         * @default `'barrel'`
-         */
-        exportType?: 'barrel' | 'barrelNamed' | false;
-    };
-    /**
-     * Group the TypeScript types based on the provided name.
-     */
-    group?: {
-        /**
-         * Tag will group based on the operation tag inside the Swagger file.
-         */
-        type: 'tag';
-        /**
-         * Relative path to save the grouped TypeScript Types.
-         *
-         * `{{tag}}` will be replaced by the current tagName.
-         * @example `${output}/{{tag}}Controller` => `models/PetController`
-         * @default `${output}/{{tag}}Controller`
-         */
-        output?: string;
-    };
-    /**
-     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
-     */
-    exclude?: Array<Exclude>;
-    /**
-     * Array containing include parameters to include tags/operations/methods/paths.
-     */
-    include?: Array<Include>;
-    /**
-     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
-     */
-    override?: Array<Override<ResolvedOptions>>;
-    /**
-     * Choose to use `enum` or `as const` for enums
-     * @default 'asConst'
-     */
-    enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
-    /**
-     * Set a suffix for the generated enums.
-     * @default ''
-     * Default will be `'enum'` in version 3 of Kubb
-     */
-    enumSuffix?: string;
-    /**
-     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
-     * @default 'string'
-     */
-    dateType?: 'string' | 'date';
-    /**
-     * Which type to use when the Swagger/OpenAPI file is not providing more information.
-     * @default 'any'
-     */
-    unknownType?: 'any' | 'unknown';
-    /**
-     * Choose what to use as mode for an optional value.
-     * @examples 'questionToken': type?: string
-     * @examples 'undefined': type: string | undefined
-     * @examples 'questionTokenAndUndefined': type?: string | undefined
-     * @default 'questionToken'
-     */
-    optionalType?: 'questionToken' | 'undefined' | 'questionTokenAndUndefined';
-    transformers?: {
-        /**
-         * Customize the names based on the type that is provided by the plugin.
-         */
-        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-    };
-    /**
-     * Export an Oas object as Oas type with `import type { Infer } from '@kubb/oas'`
-     */
-    oasType?: 'infer' | false;
-    /**
-     * @example
-     * Use https://ts-ast-viewer.com to generate factory code(see createPropertySignature)
-     * category: factory.createPropertySignature(
-     *   undefined,
-     *   factory.createIdentifier("category"),
-     *   factory.createToken(ts.SyntaxKind.QuestionToken),
-     *   factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
-     * )
-     */
-    mapper?: Record<string, ts.PropertySignature>;
-};
-type ResolvedOptions = {
-    extName: KubbFile.Extname | undefined;
-    enumType: NonNullable<Options['enumType']>;
-    enumSuffix: NonNullable<Options['enumSuffix']>;
-    dateType: NonNullable<Options['dateType']>;
-    unknownType: NonNullable<Options['unknownType']>;
-    optionalType: NonNullable<Options['optionalType']>;
-    override: NonNullable<Options['override']>;
-    transformers: NonNullable<Options['transformers']>;
-    oasType: NonNullable<Options['oasType']>;
-    usedEnumNames: Record<string, number>;
-    mapper: Record<string, any>;
-};
-type PluginTs = PluginFactoryOptions<'plugin-ts', Options, ResolvedOptions, never, ResolvePathOptions>;
+import { O as Options, P as PluginTs } from './types-W01J9acJ.cjs';
+import '@kubb/plugin-oas';
+import 'typescript';
 
 declare const pluginTsName = "plugin-ts";
 declare const pluginTs: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginTs>;
 
-export { type PluginTs, pluginTs, pluginTsName };
+export { PluginTs, pluginTs, pluginTsName };

package/dist/index.d.ts

@@ -1,127 +1,9 @@
 import * as _kubb_core from '@kubb/core';
-import { PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
-import * as KubbFile from '@kubb/fs/types';
-import { ResolvePathOptions, Exclude, Include, Override } from '@kubb/plugin-oas';
-import { ts } from '@kubb/parser-ts';
-
-type Options = {
-    output?: {
-        /**
-         * Relative path to save the TypeScript types.
-         * When output is a file it will save all models inside that file else it will create a file per schema item.
-         * @default 'types'
-         */
-        path: string;
-        /**
-         * Name to be used for the `export * as {{exportAs}} from './'`
-         */
-        exportAs?: string;
-        /**
-         * Add an extension to the generated imports and exports, default it will not use an extension
-         */
-        extName?: KubbFile.Extname;
-        /**
-         * Define what needs to exported, here you can also disable the export of barrel files
-         * @default `'barrel'`
-         */
-        exportType?: 'barrel' | 'barrelNamed' | false;
-    };
-    /**
-     * Group the TypeScript types based on the provided name.
-     */
-    group?: {
-        /**
-         * Tag will group based on the operation tag inside the Swagger file.
-         */
-        type: 'tag';
-        /**
-         * Relative path to save the grouped TypeScript Types.
-         *
-         * `{{tag}}` will be replaced by the current tagName.
-         * @example `${output}/{{tag}}Controller` => `models/PetController`
-         * @default `${output}/{{tag}}Controller`
-         */
-        output?: string;
-    };
-    /**
-     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
-     */
-    exclude?: Array<Exclude>;
-    /**
-     * Array containing include parameters to include tags/operations/methods/paths.
-     */
-    include?: Array<Include>;
-    /**
-     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
-     */
-    override?: Array<Override<ResolvedOptions>>;
-    /**
-     * Choose to use `enum` or `as const` for enums
-     * @default 'asConst'
-     */
-    enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
-    /**
-     * Set a suffix for the generated enums.
-     * @default ''
-     * Default will be `'enum'` in version 3 of Kubb
-     */
-    enumSuffix?: string;
-    /**
-     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
-     * @default 'string'
-     */
-    dateType?: 'string' | 'date';
-    /**
-     * Which type to use when the Swagger/OpenAPI file is not providing more information.
-     * @default 'any'
-     */
-    unknownType?: 'any' | 'unknown';
-    /**
-     * Choose what to use as mode for an optional value.
-     * @examples 'questionToken': type?: string
-     * @examples 'undefined': type: string | undefined
-     * @examples 'questionTokenAndUndefined': type?: string | undefined
-     * @default 'questionToken'
-     */
-    optionalType?: 'questionToken' | 'undefined' | 'questionTokenAndUndefined';
-    transformers?: {
-        /**
-         * Customize the names based on the type that is provided by the plugin.
-         */
-        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-    };
-    /**
-     * Export an Oas object as Oas type with `import type { Infer } from '@kubb/oas'`
-     */
-    oasType?: 'infer' | false;
-    /**
-     * @example
-     * Use https://ts-ast-viewer.com to generate factory code(see createPropertySignature)
-     * category: factory.createPropertySignature(
-     *   undefined,
-     *   factory.createIdentifier("category"),
-     *   factory.createToken(ts.SyntaxKind.QuestionToken),
-     *   factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
-     * )
-     */
-    mapper?: Record<string, ts.PropertySignature>;
-};
-type ResolvedOptions = {
-    extName: KubbFile.Extname | undefined;
-    enumType: NonNullable<Options['enumType']>;
-    enumSuffix: NonNullable<Options['enumSuffix']>;
-    dateType: NonNullable<Options['dateType']>;
-    unknownType: NonNullable<Options['unknownType']>;
-    optionalType: NonNullable<Options['optionalType']>;
-    override: NonNullable<Options['override']>;
-    transformers: NonNullable<Options['transformers']>;
-    oasType: NonNullable<Options['oasType']>;
-    usedEnumNames: Record<string, number>;
-    mapper: Record<string, any>;
-};
-type PluginTs = PluginFactoryOptions<'plugin-ts', Options, ResolvedOptions, never, ResolvePathOptions>;
+import { O as Options, P as PluginTs } from './types-W01J9acJ.js';
+import '@kubb/plugin-oas';
+import 'typescript';
 
 declare const pluginTsName = "plugin-ts";
 declare const pluginTs: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginTs>;
 
-export { type PluginTs, pluginTs, pluginTsName };
+export { PluginTs, pluginTs, pluginTsName };

package/dist/index.js

@@ -1,9 +1,4 @@
-import {
-  pluginTs,
-  pluginTsName
-} from "./chunk-PU22CLWV.js";
-export {
-  pluginTs,
-  pluginTsName
-};
+export { pluginTs, pluginTsName } from './chunk-CPJWNK44.js';
+import './chunk-CAATRNVS.js';
+//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/types-W01J9acJ.d.cts

@@ -0,0 +1,106 @@
+import { PluginFactoryOptions, Output, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override } from '@kubb/plugin-oas';
+import ts from 'typescript';
+
+type Options = {
+    /**
+     * @default 'types'
+     */
+    output?: Output;
+    /**
+     * Group the TypeScript types based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file.
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped TypeScript Types.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `models/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+    };
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    /**
+     * Choose to use `enum` or `as const` for enums
+     * @default 'asConst'
+     * asPascalConst is deprecated
+     */
+    enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
+    /**
+     * Set a suffix for the generated enums.
+     * @default ''
+     * Default will be `'enum'` in version 3 of Kubb
+     */
+    enumSuffix?: string;
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * Which type to use when the Swagger/OpenAPI file is not providing more information.
+     * @default 'any'
+     */
+    unknownType?: 'any' | 'unknown';
+    /**
+     * Choose what to use as mode for an optional value.
+     * @examples 'questionToken': type?: string
+     * @examples 'undefined': type: string | undefined
+     * @examples 'questionTokenAndUndefined': type?: string | undefined
+     * @default 'questionToken'
+     */
+    optionalType?: 'questionToken' | 'undefined' | 'questionTokenAndUndefined';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Export an Oas object as Oas type with `import type { Infer } from '@kubb/oas'`
+     */
+    oasType?: 'infer' | false;
+    /**
+     * @example
+     * Use https://ts-ast-viewer.com to generate factory code(see createPropertySignature)
+     * category: factory.createPropertySignature(
+     *   undefined,
+     *   factory.createIdentifier("category"),
+     *   factory.createToken(ts.SyntaxKind.QuestionToken),
+     *   factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
+     * )
+     */
+    mapper?: Record<string, ts.PropertySignature>;
+};
+type ResolvedOptions = {
+    output: Output;
+    override: NonNullable<Options['override']>;
+    enumType: NonNullable<Options['enumType']>;
+    enumSuffix: NonNullable<Options['enumSuffix']>;
+    dateType: NonNullable<Options['dateType']>;
+    unknownType: NonNullable<Options['unknownType']>;
+    optionalType: NonNullable<Options['optionalType']>;
+    transformers: NonNullable<Options['transformers']>;
+    oasType: NonNullable<Options['oasType']>;
+    usedEnumNames: Record<string, number>;
+    mapper: Record<string, any>;
+};
+type PluginTs = PluginFactoryOptions<'plugin-ts', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginTs as P };

package/dist/types-W01J9acJ.d.ts

@@ -0,0 +1,106 @@
+import { PluginFactoryOptions, Output, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override } from '@kubb/plugin-oas';
+import ts from 'typescript';
+
+type Options = {
+    /**
+     * @default 'types'
+     */
+    output?: Output;
+    /**
+     * Group the TypeScript types based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file.
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped TypeScript Types.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `models/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+    };
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    /**
+     * Choose to use `enum` or `as const` for enums
+     * @default 'asConst'
+     * asPascalConst is deprecated
+     */
+    enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
+    /**
+     * Set a suffix for the generated enums.
+     * @default ''
+     * Default will be `'enum'` in version 3 of Kubb
+     */
+    enumSuffix?: string;
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * Which type to use when the Swagger/OpenAPI file is not providing more information.
+     * @default 'any'
+     */
+    unknownType?: 'any' | 'unknown';
+    /**
+     * Choose what to use as mode for an optional value.
+     * @examples 'questionToken': type?: string
+     * @examples 'undefined': type: string | undefined
+     * @examples 'questionTokenAndUndefined': type?: string | undefined
+     * @default 'questionToken'
+     */
+    optionalType?: 'questionToken' | 'undefined' | 'questionTokenAndUndefined';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Export an Oas object as Oas type with `import type { Infer } from '@kubb/oas'`
+     */
+    oasType?: 'infer' | false;
+    /**
+     * @example
+     * Use https://ts-ast-viewer.com to generate factory code(see createPropertySignature)
+     * category: factory.createPropertySignature(
+     *   undefined,
+     *   factory.createIdentifier("category"),
+     *   factory.createToken(ts.SyntaxKind.QuestionToken),
+     *   factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
+     * )
+     */
+    mapper?: Record<string, ts.PropertySignature>;
+};
+type ResolvedOptions = {
+    output: Output;
+    override: NonNullable<Options['override']>;
+    enumType: NonNullable<Options['enumType']>;
+    enumSuffix: NonNullable<Options['enumSuffix']>;
+    dateType: NonNullable<Options['dateType']>;
+    unknownType: NonNullable<Options['unknownType']>;
+    optionalType: NonNullable<Options['optionalType']>;
+    transformers: NonNullable<Options['transformers']>;
+    oasType: NonNullable<Options['oasType']>;
+    usedEnumNames: Record<string, number>;
+    mapper: Record<string, any>;
+};
+type PluginTs = PluginFactoryOptions<'plugin-ts', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginTs as P };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-ts",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.21",
   "description": "Generator plugin-ts",
   "keywords": [
     "zod",
@@ -25,6 +25,11 @@
       "require": "./dist/index.cjs",
       "default": "./dist/index.cjs"
     },
+    "./generators": {
+      "import": "./dist/generators.js",
+      "require": "./dist/generators.cjs",
+      "default": "./dist/generators.cjs"
+    },
     "./components": {
       "import": "./dist/components.js",
       "require": "./dist/components.cjs",
@@ -40,6 +45,9 @@
     "*": {
       "components": [
         "./dist/components.d.ts"
+      ],
+      "generators": [
+        "./dist/generators.d.ts"
       ]
     }
   },
@@ -50,25 +58,23 @@
     "!/**/__tests__/**"
   ],
   "dependencies": {
-    "@kubb/core": "3.0.0-alpha.2",
-    "@kubb/fs": "3.0.0-alpha.2",
-    "@kubb/oas": "3.0.0-alpha.2",
-    "@kubb/parser-ts": "3.0.0-alpha.2",
-    "@kubb/plugin-oas": "3.0.0-alpha.2",
-    "@kubb/react": "3.0.0-alpha.2"
+    "@kubb/core": "3.0.0-alpha.21",
+    "@kubb/fs": "3.0.0-alpha.21",
+    "@kubb/oas": "3.0.0-alpha.21",
+    "@kubb/parser-ts": "3.0.0-alpha.21",
+    "@kubb/plugin-oas": "3.0.0-alpha.21",
+    "@kubb/react": "3.0.0-alpha.21"
   },
   "devDependencies": {
-    "@types/react": "^18.3.4",
-    "prettier": "^3.3.3",
+    "@types/react": "^18.3.8",
     "react": "^18.3.1",
-    "tsup": "^8.2.4",
-    "typescript": "^5.5.4",
-    "@kubb/config-biome": "3.0.0-alpha.2",
-    "@kubb/config-ts": "3.0.0-alpha.2",
-    "@kubb/config-tsup": "3.0.0-alpha.2"
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.2",
+    "@kubb/config-ts": "3.0.0-alpha.21",
+    "@kubb/config-tsup": "3.0.0-alpha.21"
   },
   "peerDependencies": {
-    "@kubb/react": "3.0.0-alpha.2"
+    "@kubb/react": "3.0.0-alpha.21"
   },
   "engines": {
     "node": ">=20"

package/src/components/OasType.tsx

@@ -1,11 +1,9 @@
-import { Parser, File, Type, useApp } from '@kubb/react'
-import { useOas } from '@kubb/plugin-oas/hooks'
+import { File, Type } from '@kubb/react'
 
 import type { OasTypes } from '@kubb/oas'
 import type { ReactNode } from 'react'
-import type { FileMeta, PluginTs } from '../types.ts'
 
-type TemplateProps = {
+type Props = {
   /**
    * Name of the function
    */
@@ -14,63 +12,18 @@ type TemplateProps = {
   api: OasTypes.OASDocument
 }
 
-function Template({ name, typeName, api }: TemplateProps): ReactNode {
+export function OasType({ name, typeName, api }: Props): ReactNode {
   return (
     <>
-      {`export const ${name} = ${JSON.stringify(api, undefined, 2)} as const`}
+      <File.Source name={name} isExportable isIndexable>
+        {`export const ${name} = ${JSON.stringify(api, undefined, 2)} as const`}
+      </File.Source>
       <br />
-      <Type name={typeName} export>
-        {`Infer<typeof ${name}>`}
-      </Type>
+      <File.Source name={typeName} isExportable isIndexable isTypeOnly>
+        <Type name={typeName} export>
+          {`Infer<typeof ${name}>`}
+        </Type>
+      </File.Source>
     </>
   )
 }
-
-const defaultTemplates = { default: Template } as const
-
-type Props = {
-  name: string
-  typeName: string
-  /**
-   * This will make it possible to override the default behaviour.
-   */
-  Template?: React.ComponentType<React.ComponentProps<typeof Template>>
-}
-
-export function OasType({ name, typeName, Template = defaultTemplates.default }: Props): ReactNode {
-  const oas = useOas()
-
-  return <Template name={name} typeName={typeName} api={oas.api} />
-}
-
-type FileProps = {
-  name: string
-  typeName: string
-  /**
-   * This will make it possible to override the default behaviour.
-   */
-  templates?: typeof defaultTemplates
-}
-
-OasType.File = function ({ name, typeName, templates = defaultTemplates }: FileProps): ReactNode {
-  const {
-    pluginManager,
-    plugin: { key: pluginKey },
-  } = useApp<PluginTs>()
-  const file = pluginManager.getFile({ name, extName: '.ts', pluginKey })
-
-  const Template = templates.default
-
-  return (
-    <Parser language="typescript">
-      <File<FileMeta> baseName={file.baseName} path={file.path} meta={file.meta}>
-        <File.Import name={['Infer']} path="@kubb/oas" isTypeOnly />
-        <File.Source>
-          <OasType Template={Template} name={name} typeName={typeName} />
-        </File.Source>
-      </File>
-    </Parser>
-  )
-}
-
-OasType.templates = defaultTemplates