@kubb/plugin-ts 0.0.0-canary-20241104172400

package/dist/generators.js

@@ -0,0 +1,4 @@
+export { oasGenerator, typeGenerator } from './chunk-HJ6SFXKJ.js';
+import './chunk-HZ6BGJL7.js';
+//# sourceMappingURL=generators.js.map
+//# sourceMappingURL=generators.js.map

package/dist/generators.js.map

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

package/dist/index.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+var chunkPTC7IOBI_cjs = require('./chunk-PTC7IOBI.cjs');
+require('./chunk-RORQTUX5.cjs');
+
+
+
+Object.defineProperty(exports, "pluginTs", {
+  enumerable: true,
+  get: function () { return chunkPTC7IOBI_cjs.pluginTs; }
+});
+Object.defineProperty(exports, "pluginTsName", {
+  enumerable: true,
+  get: function () { return chunkPTC7IOBI_cjs.pluginTsName; }
+});
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

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

package/dist/index.d.cts

@@ -0,0 +1,9 @@
+import * as _kubb_core from '@kubb/core';
+import { O as Options, P as PluginTs } from './types-zQCmVvxv.cjs';
+import '@kubb/plugin-oas';
+import 'typescript';
+
+declare const pluginTsName = "plugin-ts";
+declare const pluginTs: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginTs>;
+
+export { PluginTs, pluginTs, pluginTsName };

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import * as _kubb_core from '@kubb/core';
+import { O as Options, P as PluginTs } from './types-zQCmVvxv.js';
+import '@kubb/plugin-oas';
+import 'typescript';
+
+declare const pluginTsName = "plugin-ts";
+declare const pluginTs: (options?: Options | undefined) => _kubb_core.UserPluginWithLifeCycle<PluginTs>;
+
+export { PluginTs, pluginTs, pluginTsName };

package/dist/index.js

@@ -0,0 +1,4 @@
+export { pluginTs, pluginTsName } from './chunk-HJ6SFXKJ.js';
+import './chunk-HZ6BGJL7.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/types-zQCmVvxv.d.cts

@@ -0,0 +1,97 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
+import ts from 'typescript';
+
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'types', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the clients based on the provided name.
+     */
+    group?: Group;
+    /**
+     * 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 'enum'
+     */
+    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>;
+    /**
+     * Define some generators next to the ts generators
+     */
+    generators?: Array<Generator<PluginTs>>;
+};
+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-zQCmVvxv.d.ts

@@ -0,0 +1,97 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { ResolvePathOptions, Exclude, Include, Override, Generator } from '@kubb/plugin-oas';
+import ts from 'typescript';
+
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'types', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the clients based on the provided name.
+     */
+    group?: Group;
+    /**
+     * 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 'enum'
+     */
+    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>;
+    /**
+     * Define some generators next to the ts generators
+     */
+    generators?: Array<Generator<PluginTs>>;
+};
+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

@@ -0,0 +1,97 @@
+{
+  "name": "@kubb/plugin-ts",
+  "version": "0.0.0-canary-20241104172400",
+  "description": "Generator plugin-ts",
+  "keywords": [
+    "zod",
+    "plugins",
+    "kubb",
+    "codegen",
+    "swagger",
+    "openapi"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kubb-labs/kubb.git",
+    "directory": "packages/plugin-ts"
+  },
+  "license": "MIT",
+  "author": "Stijn Van Hulle <stijn@stijnvanhulle.be",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "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",
+      "default": "./dist/components.cjs"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "components": [
+        "./dist/components.d.ts"
+      ],
+      "generators": [
+        "./dist/generators.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!/**/**.test.**",
+    "!/**/__tests__/**"
+  ],
+  "dependencies": {
+    "@kubb/core": "0.0.0-canary-20241104172400",
+    "@kubb/fs": "0.0.0-canary-20241104172400",
+    "@kubb/oas": "0.0.0-canary-20241104172400",
+    "@kubb/parser-ts": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-oas": "0.0.0-canary-20241104172400",
+    "@kubb/react": "0.0.0-canary-20241104172400"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.12",
+    "react": "^18.3.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "@kubb/config-ts": "0.0.0-canary-20241104172400",
+    "@kubb/config-tsup": "0.0.0-canary-20241104172400"
+  },
+  "peerDependencies": {
+    "@kubb/react": "0.0.0-canary-20241104172400"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "npx rimraf ./dist",
+    "lint": "bun biome lint .",
+    "lint:fix": "bun biome lint --apply-unsafe .",
+    "release": "pnpm publish --no-git-check",
+    "release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
+    "start": "tsup --watch",
+    "test": "vitest --passWithNoTests",
+    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
+  }
+}

package/src/components/OasType.tsx

@@ -0,0 +1,29 @@
+import { File, Type } from '@kubb/react'
+
+import type { OasTypes } from '@kubb/oas'
+import type { ReactNode } from 'react'
+
+type Props = {
+  /**
+   * Name of the function
+   */
+  name: string
+  typeName: string
+  api: OasTypes.OASDocument
+}
+
+export function OasType({ name, typeName, api }: Props): ReactNode {
+  return (
+    <>
+      <File.Source name={name} isExportable isIndexable>
+        {`export const ${name} = ${JSON.stringify(api, undefined, 2)} as const`}
+      </File.Source>
+      <br />
+      <File.Source name={typeName} isExportable isIndexable isTypeOnly>
+        <Type name={typeName} export>
+          {`Infer<typeof ${name}>`}
+        </Type>
+      </File.Source>
+    </>
+  )
+}

package/src/components/Type.tsx

@@ -0,0 +1,141 @@
+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 { Fragment, type ReactNode } from 'react'
+import type ts from 'typescript'
+import { parse, typeKeywordMapper } from '../parser/index.ts'
+import type { PluginTs } from '../types.ts'
+
+type Props = {
+  name: string
+  typedName: string
+  tree: Array<Schema>
+  optionalType: PluginTs['resolvedOptions']['optionalType']
+  enumType: PluginTs['resolvedOptions']['enumType']
+  mapper: PluginTs['resolvedOptions']['mapper']
+  description?: string
+  keysToOmit?: string[]
+}
+
+export function Type({ name, typedName, tree, keysToOmit, optionalType, 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)
+
+  let type =
+    (tree
+      .map((schema, _index, siblings) =>
+        parse(
+          { parent: undefined, current: schema, siblings },
+          {
+            name,
+            typeName: typedName,
+            description,
+            keysToOmit,
+            optionalType,
+            enumType,
+            mapper,
+          },
+        ),
+      )
+      .filter(Boolean)
+      .at(0) as ts.TypeNode) || typeKeywordMapper.undefined()
+
+  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
+  }
+
+  const node = factory.createTypeAliasDeclaration({
+    modifiers: [factory.modifiers.export],
+    name,
+    type: keysToOmit?.length
+      ? factory.createOmitDeclaration({
+          keys: keysToOmit,
+          type,
+          nonNullable: true,
+        })
+      : type,
+  })
+
+  const enumSchemas = SchemaGenerator.deepSearch(tree, schemaKeywords.enum)
+
+  const enums = [...new Set(enumSchemas)].map((enumSchema) => {
+    const name = enumType === 'asPascalConst' ? transformers.pascalCase(enumSchema.args.name) : transformers.camelCase(enumSchema.args.name)
+    const typeName = enumSchema.args.typeName
+
+    const [nameNode, typeNode] = factory.createEnumDeclaration({
+      name,
+      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][],
+      type: enumType,
+    })
+
+    return {
+      nameNode,
+      typeNode,
+      name,
+      typeName,
+    }
+  })
+
+  typeNodes.push(
+    factory.appendJSDocToNode({
+      node,
+      comments: [description ? `@description ${transformers.jsStringEscape(description)}` : undefined].filter(Boolean),
+    }),
+  )
+
+  return (
+    <Fragment>
+      {enums.map(({ name, nameNode, typeName, typeNode }, index) => (
+        <Fragment key={[name, nameNode].join('-')}>
+          {nameNode && (
+            <File.Source name={name} isExportable isIndexable>
+              {print([nameNode])}
+            </File.Source>
+          )}
+          {
+            <File.Source
+              name={typeName}
+              isIndexable
+              isExportable={['enum', 'asConst', 'constEnum', 'literal', undefined].includes(enumType)}
+              isTypeOnly={['asConst', 'constEnum', 'literal', undefined].includes(enumType)}
+            >
+              {print([typeNode])}
+            </File.Source>
+          }
+        </Fragment>
+      ))}
+      {enums.every((item) => item.typeName !== name) && (
+        <File.Source name={typedName} isTypeOnly isExportable isIndexable>
+          {print(typeNodes)}
+        </File.Source>
+      )}
+    </Fragment>
+  )
+}

package/src/components/index.ts

@@ -0,0 +1,2 @@
+export { OasType } from './OasType.tsx'
+export { Type } from './Type.tsx'

package/src/generators/__snapshots__/bodyUploadFileApiAssetsPost.ts

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

package/src/generators/__snapshots__/catTypeAsConst.ts

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

package/src/generators/__snapshots__/createPet.ts

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

package/src/generators/__snapshots__/createPetWithUnknownTypeUnknown.ts

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

package/src/generators/__snapshots__/deletePet.ts

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

package/src/generators/__snapshots__/dogTypeAsConst.ts

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

package/src/generators/__snapshots__/enumAllOf.ts

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

package/src/generators/__snapshots__/enumArray.ts

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