@kubb/plugin-ts 3.2.0 → 3.3.0

package/dist/components.cjs

@@ -1,16 +1,16 @@
 'use strict';
 
-var chunkUE4AMVPZ_cjs = require('./chunk-UE4AMVPZ.cjs');
+var chunkWETJULJE_cjs = require('./chunk-WETJULJE.cjs');
 
 
 
 Object.defineProperty(exports, "OasType", {
   enumerable: true,
-  get: function () { return chunkUE4AMVPZ_cjs.OasType; }
+  get: function () { return chunkWETJULJE_cjs.OasType; }
 });
 Object.defineProperty(exports, "Type", {
   enumerable: true,
-  get: function () { return chunkUE4AMVPZ_cjs.Type; }
+  get: function () { return chunkWETJULJE_cjs.Type; }
 });
 //# sourceMappingURL=components.cjs.map
 //# sourceMappingURL=components.cjs.map

package/dist/components.d.cts

@@ -1,7 +1,7 @@
 import { OasTypes } from '@kubb/oas';
 import { ReactNode } from 'react';
 import { Schema } from '@kubb/plugin-oas';
-import { P as PluginTs } from './types-Dy6NIaQp.cjs';
+import { P as PluginTs } from './types-9taMMp9y.cjs';
 import '@kubb/core';
 import 'typescript';
 
@@ -22,9 +22,10 @@ type Props = {
     optionalType: PluginTs['resolvedOptions']['optionalType'];
     enumType: PluginTs['resolvedOptions']['enumType'];
     mapper: PluginTs['resolvedOptions']['mapper'];
+    syntaxType: PluginTs['resolvedOptions']['syntaxType'];
     description?: string;
     keysToOmit?: string[];
 };
-declare function Type({ name, typedName, tree, keysToOmit, optionalType, enumType, mapper, description }: Props): ReactNode;
+declare function Type({ name, typedName, tree, keysToOmit, optionalType, syntaxType, enumType, mapper, description }: Props): ReactNode;
 
 export { OasType, Type };

package/dist/components.d.ts

@@ -1,7 +1,7 @@
 import { OasTypes } from '@kubb/oas';
 import { ReactNode } from 'react';
 import { Schema } from '@kubb/plugin-oas';
-import { P as PluginTs } from './types-Dy6NIaQp.js';
+import { P as PluginTs } from './types-9taMMp9y.js';
 import '@kubb/core';
 import 'typescript';
 
@@ -22,9 +22,10 @@ type Props = {
     optionalType: PluginTs['resolvedOptions']['optionalType'];
     enumType: PluginTs['resolvedOptions']['enumType'];
     mapper: PluginTs['resolvedOptions']['mapper'];
+    syntaxType: PluginTs['resolvedOptions']['syntaxType'];
     description?: string;
     keysToOmit?: string[];
 };
-declare function Type({ name, typedName, tree, keysToOmit, optionalType, enumType, mapper, description }: Props): ReactNode;
+declare function Type({ name, typedName, tree, keysToOmit, optionalType, syntaxType, enumType, mapper, description }: Props): ReactNode;
 
 export { OasType, Type };

package/dist/components.js

@@ -1,3 +1,3 @@
-export { OasType, Type } from './chunk-OJLL42LQ.js';
+export { OasType, Type } from './chunk-65CJCKDZ.js';
 //# sourceMappingURL=components.js.map
 //# sourceMappingURL=components.js.map

package/dist/generators.cjs

@@ -1,17 +1,17 @@
 'use strict';
 
-var chunkKFZ72XC5_cjs = require('./chunk-KFZ72XC5.cjs');
-require('./chunk-UE4AMVPZ.cjs');
+var chunk2M6PDW4T_cjs = require('./chunk-2M6PDW4T.cjs');
+require('./chunk-WETJULJE.cjs');
 
 
 
 Object.defineProperty(exports, "oasGenerator", {
   enumerable: true,
-  get: function () { return chunkKFZ72XC5_cjs.oasGenerator; }
+  get: function () { return chunk2M6PDW4T_cjs.oasGenerator; }
 });
 Object.defineProperty(exports, "typeGenerator", {
   enumerable: true,
-  get: function () { return chunkKFZ72XC5_cjs.typeGenerator; }
+  get: function () { return chunk2M6PDW4T_cjs.typeGenerator; }
 });
 //# sourceMappingURL=generators.cjs.map
 //# sourceMappingURL=generators.cjs.map

package/dist/generators.d.cts

@@ -1,5 +1,5 @@
 import * as _kubb_plugin_oas from '@kubb/plugin-oas';
-import { P as PluginTs } from './types-Dy6NIaQp.cjs';
+import { P as PluginTs } from './types-9taMMp9y.cjs';
 import '@kubb/core';
 import 'typescript';
 

package/dist/generators.d.ts

@@ -1,5 +1,5 @@
 import * as _kubb_plugin_oas from '@kubb/plugin-oas';
-import { P as PluginTs } from './types-Dy6NIaQp.js';
+import { P as PluginTs } from './types-9taMMp9y.js';
 import '@kubb/core';
 import 'typescript';
 

package/dist/generators.js

@@ -1,4 +1,4 @@
-export { oasGenerator, typeGenerator } from './chunk-S2CJKQ76.js';
-import './chunk-OJLL42LQ.js';
+export { oasGenerator, typeGenerator } from './chunk-Z7RYCWNL.js';
+import './chunk-65CJCKDZ.js';
 //# sourceMappingURL=generators.js.map
 //# sourceMappingURL=generators.js.map

package/dist/index.cjs

@@ -1,17 +1,17 @@
 'use strict';
 
-var chunkKFZ72XC5_cjs = require('./chunk-KFZ72XC5.cjs');
-require('./chunk-UE4AMVPZ.cjs');
+var chunk2M6PDW4T_cjs = require('./chunk-2M6PDW4T.cjs');
+require('./chunk-WETJULJE.cjs');
 
 
 
 Object.defineProperty(exports, "pluginTs", {
   enumerable: true,
-  get: function () { return chunkKFZ72XC5_cjs.pluginTs; }
+  get: function () { return chunk2M6PDW4T_cjs.pluginTs; }
 });
 Object.defineProperty(exports, "pluginTsName", {
   enumerable: true,
-  get: function () { return chunkKFZ72XC5_cjs.pluginTsName; }
+  get: function () { return chunk2M6PDW4T_cjs.pluginTsName; }
 });
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _kubb_core from '@kubb/core';
-import { O as Options, P as PluginTs } from './types-Dy6NIaQp.cjs';
+import { O as Options, P as PluginTs } from './types-9taMMp9y.cjs';
 import '@kubb/plugin-oas';
 import 'typescript';
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _kubb_core from '@kubb/core';
-import { O as Options, P as PluginTs } from './types-Dy6NIaQp.js';
+import { O as Options, P as PluginTs } from './types-9taMMp9y.js';
 import '@kubb/plugin-oas';
 import 'typescript';
 

package/dist/index.js

@@ -1,4 +1,4 @@
-export { pluginTs, pluginTsName } from './chunk-S2CJKQ76.js';
-import './chunk-OJLL42LQ.js';
+export { pluginTs, pluginTsName } from './chunk-Z7RYCWNL.js';
+import './chunk-65CJCKDZ.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/{types-Dy6NIaQp.d.cts → types-9taMMp9y.d.cts}

@@ -30,6 +30,11 @@ type Options = {
      * asPascalConst is deprecated
      */
     enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
+    /**
+     * Switch between type or interface for creating TypeScript types
+     * @default 'type'
+     */
+    syntaxType?: 'type' | 'interface';
     /**
      * Set a suffix for the generated enums.
      * @default 'enum'
@@ -90,6 +95,7 @@ type ResolvedOptions = {
     optionalType: NonNullable<Options['optionalType']>;
     transformers: NonNullable<Options['transformers']>;
     oasType: NonNullable<Options['oasType']>;
+    syntaxType: NonNullable<Options['syntaxType']>;
     usedEnumNames: Record<string, number>;
     mapper: Record<string, any>;
 };

package/dist/{types-Dy6NIaQp.d.ts → types-9taMMp9y.d.ts}

@@ -30,6 +30,11 @@ type Options = {
      * asPascalConst is deprecated
      */
     enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
+    /**
+     * Switch between type or interface for creating TypeScript types
+     * @default 'type'
+     */
+    syntaxType?: 'type' | 'interface';
     /**
      * Set a suffix for the generated enums.
      * @default 'enum'
@@ -90,6 +95,7 @@ type ResolvedOptions = {
     optionalType: NonNullable<Options['optionalType']>;
     transformers: NonNullable<Options['transformers']>;
     oasType: NonNullable<Options['oasType']>;
+    syntaxType: NonNullable<Options['syntaxType']>;
     usedEnumNames: Record<string, number>;
     mapper: Record<string, any>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-ts",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Generator plugin-ts",
   "keywords": [
     "zod",
@@ -58,20 +58,20 @@
     "!/**/__tests__/**"
   ],
   "dependencies": {
-    "@kubb/core": "3.2.0",
-    "@kubb/fs": "3.2.0",
-    "@kubb/oas": "3.2.0",
-    "@kubb/parser-ts": "3.2.0",
-    "@kubb/plugin-oas": "3.2.0",
-    "@kubb/react": "3.2.0"
+    "@kubb/core": "3.3.0",
+    "@kubb/fs": "3.3.0",
+    "@kubb/oas": "3.3.0",
+    "@kubb/plugin-oas": "3.3.0",
+    "@kubb/react": "3.3.0",
+    "@kubb/parser-ts": "3.3.0"
   },
   "devDependencies": {
     "@types/react": "^18.3.16",
     "react": "^18.3.1",
     "tsup": "^8.3.5",
     "typescript": "^5.7.2",
-    "@kubb/config-ts": "3.2.0",
-    "@kubb/config-tsup": "3.2.0"
+    "@kubb/config-ts": "3.3.0",
+    "@kubb/config-tsup": "3.3.0"
   },
   "peerDependencies": {
     "@kubb/react": "^3.0.0"

package/src/components/Type.tsx

@@ -3,7 +3,8 @@ import { File } from '@kubb/react'
 import transformers from '@kubb/core/transformers'
 import { print } from '@kubb/parser-ts'
 import * as factory from '@kubb/parser-ts/factory'
-import { type Schema, SchemaGenerator, schemaKeywords } from '@kubb/plugin-oas'
+import { createTypeDeclaration } from '@kubb/parser-ts/factory'
+import { type Schema, SchemaGenerator, isKeyword, schemaKeywords } from '@kubb/plugin-oas'
 import { Fragment, type ReactNode } from 'react'
 import type ts from 'typescript'
 import { parse, typeKeywordMapper } from '../parser/index.ts'
@@ -16,20 +17,19 @@ type Props = {
   optionalType: PluginTs['resolvedOptions']['optionalType']
   enumType: PluginTs['resolvedOptions']['enumType']
   mapper: PluginTs['resolvedOptions']['mapper']
+  syntaxType: PluginTs['resolvedOptions']['syntaxType']
   description?: string
   keysToOmit?: string[]
 }
 
-export function Type({ name, typedName, tree, keysToOmit, optionalType, enumType, mapper, description }: Props): ReactNode {
+export function Type({ name, typedName, tree, keysToOmit, optionalType, syntaxType, enumType, mapper, description }: Props): ReactNode {
   const typeNodes: ts.Node[] = []
 
   if (!tree.length) {
     return ''
   }
 
-  const isNullish = tree.some((item) => item.keyword === schemaKeywords.nullish)
-  const isNullable = tree.some((item) => item.keyword === schemaKeywords.nullable)
-  const isOptional = tree.some((item) => item.keyword === schemaKeywords.optional)
+  const schema = tree.find((item) => item.keyword === schemaKeywords.schema)
 
   let type =
     (tree
@@ -38,47 +38,60 @@ export function Type({ name, typedName, tree, keysToOmit, optionalType, enumType
           { parent: undefined, current: schema, siblings },
           {
             name,
-            typeName: typedName,
+            typedName,
             description,
             keysToOmit,
             optionalType,
             enumType,
             mapper,
+            syntaxType,
           },
         ),
       )
       .filter(Boolean)
       .at(0) as ts.TypeNode) || typeKeywordMapper.undefined()
 
-  if (isNullable) {
-    type = factory.createUnionDeclaration({
-      nodes: [type, factory.keywordTypeNodes.null],
-    }) as ts.TypeNode
-  }
+  if (schema && isKeyword(schema, schemaKeywords.schema) && schema.args.type !== 'object') {
+    const isNullish = tree.some((item) => item.keyword === schemaKeywords.nullish)
+    const isNullable = tree.some((item) => item.keyword === schemaKeywords.nullable)
+    const isOptional = tree.some((item) => item.keyword === schemaKeywords.optional)
 
-  if (isNullish && ['undefined', 'questionTokenAndUndefined'].includes(optionalType as string)) {
-    type = factory.createUnionDeclaration({
-      nodes: [type, factory.keywordTypeNodes.undefined],
-    }) as ts.TypeNode
-  }
+    if (isNullable) {
+      type = factory.createUnionDeclaration({
+        nodes: [type, factory.keywordTypeNodes.null],
+      }) as ts.TypeNode
+    }
+
+    if (isNullish && ['undefined', 'questionTokenAndUndefined'].includes(optionalType as string)) {
+      type = factory.createUnionDeclaration({
+        nodes: [type, factory.keywordTypeNodes.undefined],
+      }) as ts.TypeNode
+    }
 
-  if (isOptional && ['undefined', 'questionTokenAndUndefined'].includes(optionalType as string)) {
-    type = factory.createUnionDeclaration({
-      nodes: [type, factory.keywordTypeNodes.undefined],
-    }) as ts.TypeNode
+    if (isOptional && ['undefined', 'questionTokenAndUndefined'].includes(optionalType as string)) {
+      type = factory.createUnionDeclaration({
+        nodes: [type, factory.keywordTypeNodes.undefined],
+      }) as ts.TypeNode
+    }
   }
 
-  const node = factory.createTypeAliasDeclaration({
-    modifiers: [factory.modifiers.export],
-    name,
-    type: keysToOmit?.length
-      ? factory.createOmitDeclaration({
-          keys: keysToOmit,
-          type,
-          nonNullable: true,
-        })
-      : type,
-  })
+  const useTypeGeneration = syntaxType === 'type' || [factory.syntaxKind.union].includes(type.kind as typeof factory.syntaxKind.union) || !!keysToOmit?.length
+
+  typeNodes.push(
+    createTypeDeclaration({
+      name,
+      isExportable: true,
+      type: keysToOmit?.length
+        ? factory.createOmitDeclaration({
+            keys: keysToOmit,
+            type,
+            nonNullable: true,
+          })
+        : type,
+      syntax: useTypeGeneration ? 'type' : 'interface',
+      description: description ? transformers.jsStringEscape(description) : undefined,
+    }),
+  )
 
   const enumSchemas = SchemaGenerator.deepSearch(tree, schemaKeywords.enum)
 
@@ -91,7 +104,7 @@ export function Type({ name, typedName, tree, keysToOmit, optionalType, enumType
       typeName,
       enums: enumSchema.args.items
         .map((item) => (item.value === undefined ? undefined : [transformers.trimQuotes(item.name?.toString()), item.value]))
-        .filter(Boolean) as unknown as [string, string][],
+        .filter(Boolean) as unknown as Array<[string, string]>,
       type: enumType,
     })
 
@@ -103,13 +116,6 @@ export function Type({ name, typedName, tree, keysToOmit, optionalType, enumType
     }
   })
 
-  typeNodes.push(
-    factory.appendJSDocToNode({
-      node,
-      comments: [description ? `@description ${transformers.jsStringEscape(description)}` : undefined].filter(Boolean),
-    }),
-  )
-
   return (
     <Fragment>
       {enums.map(({ name, nameNode, typeName, typeNode }, index) => (

package/src/generators/__snapshots__/bodyUploadFileApiAssetsPost.ts

@@ -1,6 +1,6 @@
 export type bodyUploadFileApiAssetsPost = {
-    /**
-     * @type string, binary
-    */
-    file: Blob;
-};
+  /**
+   * @type string, binary
+   */
+  file: Blob
+}

package/src/generators/__snapshots__/catTypeAsConst.ts

@@ -1,11 +1,11 @@
 export type cat = {
-    /**
-     * @type string, uuid
-    */
-    id: string;
-    type: "Cat";
-    /**
-     * @type boolean | undefined
-    */
-    meow?: boolean;
-};
+  /**
+   * @type string, uuid
+   */
+  id: string
+  type: 'Cat'
+  /**
+   * @type boolean | undefined
+   */
+  meow?: boolean
+}

package/src/generators/__snapshots__/createPet.ts

@@ -1,34 +1,33 @@
-
- /**
+/**
  * @description Null response
-*/
-export type CreatePets201 = (error & {
-    /**
-     * @type object | undefined
-    */
-    name?: errorCode;
-});
+ */
+export type CreatePets201 = error & {
+  /**
+   * @type object | undefined
+   */
+  name?: errorCode
+}
 
- /**
+/**
  * @description unexpected error
-*/
-export type CreatePetsError = error;
+ */
+export type CreatePetsError = error
 
- export type CreatePetsMutationRequest = {
-    /**
-     * @type string
-    */
-    name: string;
-    /**
-     * @type string
-    */
-    tag: string;
-};
+export type CreatePetsMutationRequest = {
+  /**
+   * @type string
+   */
+  name: string
+  /**
+   * @type string
+   */
+  tag: string
+}
 
- export type CreatePetsMutationResponse = createPets201;
+export type CreatePetsMutationResponse = createPets201
 
- export type createPetsMutation = {
-    Response: createPets201;
-    Request: createPetsMutationRequest;
-    Errors: any;
-};
+export type createPetsMutation = {
+  Response: createPets201
+  Request: createPetsMutationRequest
+  Errors: any
+}

package/src/generators/__snapshots__/createPetWithUnknownTypeUnknown.ts

@@ -1,34 +1,33 @@
-
- /**
+/**
  * @description Null response
-*/
-export type CreatePets201 = (error & {
-    /**
-     * @type object | undefined
-    */
-    name?: errorCode;
-});
+ */
+export type CreatePets201 = error & {
+  /**
+   * @type object | undefined
+   */
+  name?: errorCode
+}
 
- /**
+/**
  * @description unexpected error
-*/
-export type CreatePetsError = error;
+ */
+export type CreatePetsError = error
 
- export type CreatePetsMutationRequest = {
-    /**
-     * @type string
-    */
-    name: string;
-    /**
-     * @type string
-    */
-    tag: string;
-};
+export type CreatePetsMutationRequest = {
+  /**
+   * @type string
+   */
+  name: string
+  /**
+   * @type string
+   */
+  tag: string
+}
 
- export type CreatePetsMutationResponse = createPets201;
+export type CreatePetsMutationResponse = createPets201
 
- export type createPetsMutation = {
-    Response: createPets201;
-    Request: createPetsMutationRequest;
-    Errors: any;
-};
+export type createPetsMutation = {
+  Response: createPets201
+  Request: createPetsMutationRequest
+  Errors: any
+}

package/src/generators/__snapshots__/deletePet.ts

@@ -1,7 +1,6 @@
+export type DeletePetsPetidMutationResponse = any
 
- export type DeletePetsPetidMutationResponse = any;
-
- export type deletePetsPetidMutation = {
-    Response: any;
-    Errors: any;
-};
+export type deletePetsPetidMutation = {
+  Response: any
+  Errors: any
+}

package/src/generators/__snapshots__/dogTypeAsConst.ts

@@ -1,11 +1,11 @@
 export type dog = {
-    /**
-     * @type string, uuid
-    */
-    id: string;
-    /**
-     * @type number | undefined
-    */
-    bark?: number;
-    type: "Dog";
-};
+  /**
+   * @type string, uuid
+   */
+  id: string
+  /**
+   * @type number | undefined
+   */
+  bark?: number
+  type: 'Dog'
+}

package/src/generators/__snapshots__/enumAllOf.ts

@@ -1,10 +1,10 @@
 export const enumAllOfReasonEnum2 = {
-    "created_at": "created_at",
-    "description": "description"
-} as const;
+  created_at: 'created_at',
+  description: 'description',
+} as const
 
- export type EnumAllOfReasonEnum2 = (typeof enumAllOfReasonEnum2)[keyof typeof enumAllOfReasonEnum2];
+export type EnumAllOfReasonEnum2 = (typeof enumAllOfReasonEnum2)[keyof typeof enumAllOfReasonEnum2]
 
- export type enumAllOf = {
-    reason?: EnumAllOfReasonEnum2;
-};
+export type enumAllOf = {
+  reason?: EnumAllOfReasonEnum2
+}

package/src/generators/__snapshots__/enumArray.ts

@@ -1,19 +1,15 @@
 export const enumArrayIdentifierEnum2 = {
-    "NW": "NW",
-    "NE": "NE",
-    "SW": "SW",
-    "SE": "SE"
-} as const;
+  NW: 'NW',
+  NE: 'NE',
+  SW: 'SW',
+  SE: 'SE',
+} as const
 
- export type EnumArrayIdentifierEnum2 = (typeof enumArrayIdentifierEnum2)[keyof typeof enumArrayIdentifierEnum2];
+export type EnumArrayIdentifierEnum2 = (typeof enumArrayIdentifierEnum2)[keyof typeof enumArrayIdentifierEnum2]
 
- export type enumArray = {
-    /**
-     * @type array | undefined
-    */
-    identifier?: [
-        number,
-        string,
-        EnumArrayIdentifierEnum2
-    ];
-};
+export type enumArray = {
+  /**
+   * @type array | undefined
+   */
+  identifier?: [number, string, EnumArrayIdentifierEnum2]
+}