@kubb/swagger-ts 2.0.0-beta.1 → 2.0.0-beta.11

package/dist/oas.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=oas.cjs.map

package/dist/oas.cjs.map

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

package/dist/oas.d.cts

@@ -0,0 +1,6 @@
+export { I as Infer, M as MethodMap, a as Model, P as PathMap, R as RequestParams, b as Response, S as StatusMap } from './index-PYW2PpJw.cjs';
+import 'hotscript';
+import 'ts-toolbelt';
+import '@kubb/swagger';
+import 'json-schema-to-ts';
+import '@kubb/types';

package/dist/oas.d.ts

@@ -0,0 +1,6 @@
+export { I as Infer, M as MethodMap, a as Model, P as PathMap, R as RequestParams, b as Response, S as StatusMap } from './index-PYW2PpJw.js';
+import 'hotscript';
+import 'ts-toolbelt';
+import '@kubb/swagger';
+import 'json-schema-to-ts';
+import '@kubb/types';

package/dist/oas.js

@@ -0,0 +1,5 @@
+import { createRequire } from 'module';
+
+createRequire(import.meta.url);
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=oas.js.map

package/dist/oas.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/dist/types-IAThMYCO.d.cts

@@ -0,0 +1,105 @@
+import { KubbFile, ResolveNameParams, KubbPlugin, PluginFactoryOptions } from '@kubb/core';
+import { Exclude, Include, Override, ResolvePathOptions, AppMeta as AppMeta$1 } from '@kubb/swagger';
+
+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' | 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 paramaters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include paramaters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override paramaters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<Options>>;
+    /**
+     * Choose to use `enum` or `as const` for enums
+     * @default 'asConst'
+     */
+    enumType?: 'enum' | 'asConst' | 'asPascalConst';
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * 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/swagger-ts/oas'`
+     */
+    oasType?: 'infer' | false;
+};
+type ResolvedOptions = {
+    enumType: NonNullable<Options['enumType']>;
+    dateType: NonNullable<Options['dateType']>;
+    optionalType: NonNullable<Options['optionalType']>;
+    transformers: NonNullable<Options['transformers']>;
+    oasType: NonNullable<Options['oasType']>;
+    usedEnumNames: Record<string, number>;
+};
+type FileMeta = {
+    pluginKey?: KubbPlugin['key'];
+    name?: string;
+    tag?: string;
+};
+type AppMeta = AppMeta$1;
+type PluginOptions = PluginFactoryOptions<'swagger-ts', Options, ResolvedOptions, never, ResolvePathOptions, AppMeta>;
+declare module '@kubb/core' {
+    interface _Register {
+        ['@kubb/swagger-ts']: PluginOptions;
+    }
+}
+
+export type { FileMeta as F, Options as O, PluginOptions as P };

package/dist/types-IAThMYCO.d.ts

@@ -0,0 +1,105 @@
+import { KubbFile, ResolveNameParams, KubbPlugin, PluginFactoryOptions } from '@kubb/core';
+import { Exclude, Include, Override, ResolvePathOptions, AppMeta as AppMeta$1 } from '@kubb/swagger';
+
+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' | 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 paramaters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include paramaters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override paramaters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<Options>>;
+    /**
+     * Choose to use `enum` or `as const` for enums
+     * @default 'asConst'
+     */
+    enumType?: 'enum' | 'asConst' | 'asPascalConst';
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * 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/swagger-ts/oas'`
+     */
+    oasType?: 'infer' | false;
+};
+type ResolvedOptions = {
+    enumType: NonNullable<Options['enumType']>;
+    dateType: NonNullable<Options['dateType']>;
+    optionalType: NonNullable<Options['optionalType']>;
+    transformers: NonNullable<Options['transformers']>;
+    oasType: NonNullable<Options['oasType']>;
+    usedEnumNames: Record<string, number>;
+};
+type FileMeta = {
+    pluginKey?: KubbPlugin['key'];
+    name?: string;
+    tag?: string;
+};
+type AppMeta = AppMeta$1;
+type PluginOptions = PluginFactoryOptions<'swagger-ts', Options, ResolvedOptions, never, ResolvePathOptions, AppMeta>;
+declare module '@kubb/core' {
+    interface _Register {
+        ['@kubb/swagger-ts']: PluginOptions;
+    }
+}
+
+export type { FileMeta as F, Options as O, PluginOptions as P };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/swagger-ts",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.11",
   "description": "Generator swagger-ts",
   "keywords": [
     "typescript",
@@ -25,6 +25,14 @@
       "require": "./dist/index.cjs",
       "default": "./dist/index.cjs"
     },
+    "./components": {
+      "import": "./dist/components.js",
+      "require": "./dist/components.cjs",
+      "default": "./dist/components.cjs"
+    },
+    "./oas": {
+      "types": "./dist/oas.d.ts"
+    },
     "./package.json": "./package.json",
     "./*": "./*"
   },
@@ -38,21 +46,27 @@
     "!/**/__tests__/**"
   ],
   "dependencies": {
-    "change-case": "^4.1.2",
-    "typescript": "^5.3.2",
-    "@kubb/core": "2.0.0-beta.1",
-    "@kubb/parser": "2.0.0-beta.1",
-    "@kubb/swagger": "2.0.0-beta.1"
+    "hotscript": "^1.0.13",
+    "json-schema-to-ts": "^2.9.2",
+    "ts-toolbelt": "^9.6.0",
+    "@kubb/parser": "2.0.0-beta.11",
+    "@kubb/react": "2.0.0-beta.11",
+    "@kubb/core": "2.0.0-beta.11",
+    "@kubb/swagger": "2.0.0-beta.11",
+    "@kubb/types": "2.0.0-beta.11"
   },
   "devDependencies": {
-    "eslint": "^8.54.0",
+    "@types/react": "^18.2.41",
+    "eslint": "^8.55.0",
+    "expect-type": "^0.17.3",
+    "react": "^18.2.0",
     "tsup": "^8.0.1",
     "@kubb/eslint-config": "1.1.8",
     "@kubb/ts-config": "0.1.0",
     "@kubb/tsup-config": "1.1.8"
   },
   "peerDependencies": {
-    "typescript": "^5.3.0"
+    "@kubb/react": "2.0.0-beta.11"
   },
   "packageManager": "pnpm@8.3.0",
   "engines": {

package/src/OperationGenerator.tsx

@@ -0,0 +1,62 @@
+import { createRoot } from '@kubb/react'
+import { OperationGenerator as Generator } from '@kubb/swagger'
+
+import { Mutation } from './components/Mutation.tsx'
+import { Oas } from './components/Oas.tsx'
+import { Query } from './components/Query.tsx'
+
+import type { AppContextProps } from '@kubb/react'
+import type { Operation, OperationMethodResult, OperationSchemas } from '@kubb/swagger'
+import type { FileMeta, PluginOptions } from './types.ts'
+
+export class OperationGenerator extends Generator<PluginOptions['resolvedOptions'], PluginOptions> {
+  async all(): OperationMethodResult<FileMeta> {
+    const { oas, pluginManager, plugin } = this.context
+
+    if (!plugin.options.oasType) {
+      return null
+    }
+
+    const root = createRoot<AppContextProps>({ logger: pluginManager.logger })
+    root.render(
+      <Oas.File name="oas" typeName="Oas" />,
+      { meta: { oas, pluginManager, plugin } },
+    )
+
+    return root.files
+  }
+
+  async get(operation: Operation, schemas: OperationSchemas, options: PluginOptions['resolvedOptions']): OperationMethodResult<FileMeta> {
+    const { oas, pluginManager, plugin, mode = 'directory' } = this.context
+
+    const root = createRoot<AppContextProps<PluginOptions['appMeta']>>({ logger: pluginManager.logger })
+    root.render(
+      <Query.File mode={mode} />,
+      { meta: { oas, pluginManager, plugin: { ...plugin, options }, schemas, operation } },
+    )
+
+    return root.files
+  }
+
+  async post(operation: Operation, schemas: OperationSchemas, options: PluginOptions['resolvedOptions']): OperationMethodResult<FileMeta> {
+    const { oas, pluginManager, plugin, mode = 'directory' } = this.context
+
+    const root = createRoot<AppContextProps<PluginOptions['appMeta']>>({ logger: pluginManager.logger })
+    root.render(
+      <Mutation.File mode={mode} />,
+      { meta: { oas, pluginManager, plugin: { ...plugin, options }, schemas, operation } },
+    )
+
+    return root.files
+  }
+
+  async put(operation: Operation, schemas: OperationSchemas, options: PluginOptions['resolvedOptions']): OperationMethodResult<FileMeta> {
+    return this.post(operation, schemas, options)
+  }
+  async patch(operation: Operation, schemas: OperationSchemas, options: PluginOptions['resolvedOptions']): OperationMethodResult<FileMeta> {
+    return this.post(operation, schemas, options)
+  }
+  async delete(operation: Operation, schemas: OperationSchemas, options: PluginOptions['resolvedOptions']): OperationMethodResult<FileMeta> {
+    return this.post(operation, schemas, options)
+  }
+}

package/src/TypeBuilder.ts

@@ -0,0 +1,58 @@
+import transformers from '@kubb/core/transformers'
+import { print } from '@kubb/parser'
+import { OasBuilder } from '@kubb/swagger'
+import { refsSorter } from '@kubb/swagger/utils'
+
+import { TypeGenerator } from './TypeGenerator.ts'
+
+import type { KubbFile } from '@kubb/core'
+import type { ImportMeta } from '@kubb/swagger'
+import type { PluginOptions } from './types.ts'
+
+export class TypeBuilder extends OasBuilder<PluginOptions['resolvedOptions']> {
+  build(name?: string): Required<Pick<KubbFile.File, 'imports' | 'source'>> {
+    const importMeta: ImportMeta[] = []
+    const codes: string[] = []
+
+    const generated = this.items
+      .filter((operationSchema) => (name ? operationSchema.name === name : true))
+      .sort(transformers.nameSorter)
+      .map((operationSchema) => {
+        const generator = new TypeGenerator(this.options, this.context)
+        const sources = generator.build({
+          schema: operationSchema.schema,
+          baseName: operationSchema.name,
+          description: operationSchema.description,
+          keysToOmit: operationSchema.keysToOmit,
+        })
+
+        importMeta.push(...generator.imports)
+
+        return {
+          import: {
+            refs: generator.refs,
+            name: operationSchema.name,
+          },
+          sources,
+        }
+      })
+      .sort(refsSorter)
+
+    generated.forEach((item) => {
+      codes.push(print(item.sources))
+    })
+
+    const imports: KubbFile.Import[] = importMeta.map((item) => {
+      return {
+        name: [item.ref.propertyName],
+        path: item.path,
+        isTypeOnly: item.isTypeOnly,
+      }
+    })
+
+    return {
+      imports,
+      source: transformers.combineCodes(codes),
+    }
+  }
+}