Support void as unknownType

kubb-labs · Feb 26, 2025 · e95563a · e95563a
1 parent 7603554
commit e95563a
Show file tree

Hide file tree

Showing 12 changed files with 74 additions and 6 deletions.
diff --git a/packages/parser-ts/src/factory.ts b/packages/parser-ts/src/factory.ts
@@ -591,6 +591,7 @@ export function createOmitDeclaration({
 export const keywordTypeNodes = {
   any: factory.createKeywordTypeNode(ts.SyntaxKind.AnyKeyword),
   unknown: factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword),
+  void: factory.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword),
   number: factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
   integer: factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
   object: factory.createKeywordTypeNode(ts.SyntaxKind.ObjectKeyword),

diff --git a/packages/plugin-faker/src/parser.ts b/packages/plugin-faker/src/parser.ts
@@ -7,6 +7,7 @@ import type { Options } from './types.ts'
 const fakerKeywordMapper = {
   any: () => 'undefined',
   unknown: () => 'unknown',
+  void: () => 'void',
   number: (min?: number, max?: number) => {
     if (max !== undefined && min !== undefined) {
       return `faker.number.float({ min: ${min}, max: ${max} })`

diff --git a/packages/plugin-oas/src/SchemaGenerator.ts b/packages/plugin-oas/src/SchemaGenerator.ts
@@ -36,7 +36,7 @@ type Context<TOptions, TPluginOptions extends PluginFactoryOptions> = {
 
 export type SchemaGeneratorOptions = {
   dateType: false | 'string' | 'stringOffset' | 'stringLocal' | 'date'
-  unknownType: 'any' | 'unknown'
+  unknownType: 'any' | 'unknown' | 'void'
   enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal'
   enumSuffix?: string
   usedEnumNames?: Record<string, number>
@@ -260,6 +260,9 @@ export class SchemaGenerator<
     if (options.unknownType === 'any') {
       return schemaKeywords.any
     }
+    if (options.unknownType === 'void') {
+      return schemaKeywords.void
+    }
 
     return schemaKeywords.unknown
   }

diff --git a/packages/plugin-oas/src/SchemaMapper.ts b/packages/plugin-oas/src/SchemaMapper.ts
@@ -83,6 +83,7 @@ export type SchemaKeywordMapper = {
   null: { keyword: 'null' }
   any: { keyword: 'any' }
   unknown: { keyword: 'unknown' }
+  void: { keyword: 'void' }
   blob: { keyword: 'blob' }
   schema: { keyword: 'schema'; args: { type: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object'; format?: string } }
   name: { keyword: 'name'; args: string }
@@ -110,6 +111,7 @@ export const schemaKeywords = {
   email: 'email',
   uuid: 'uuid',
   url: 'url',
+  void: 'void',
   /* intersection */
   default: 'default',
   const: 'const',

diff --git a/packages/plugin-ts/mocks/petStore.yaml b/packages/plugin-ts/mocks/petStore.yaml
@@ -71,6 +71,8 @@ paths:
                     properties:
                         name:
                             $ref: "#/components/schemas/ErrorCode"
+        '202':
+          description: Accepted response
         default:
           description: unexpected error
           content:

diff --git a/packages/plugin-ts/src/generators/__snapshots__/createPet.ts b/packages/plugin-ts/src/generators/__snapshots__/createPet.ts
@@ -8,6 +8,11 @@ export type CreatePets201 = error & {
   name?: errorCode
 }
 
+/**
+ * @description Accepted response
+ */
+export type CreatePets202 = any
+
 /**
  * @description unexpected error
  */
@@ -24,10 +29,10 @@ export type CreatePetsMutationRequest = {
   tag: string
 }
 
-export type CreatePetsMutationResponse = createPets201
+export type CreatePetsMutationResponse = createPets201 | createPets202
 
 export type createPetsMutation = {
-  Response: createPets201
+  Response: createPets201 | createPets202
   Request: createPetsMutationRequest
   Errors: any
 }
diff --git a/packages/plugin-ts/src/generators/__snapshots__/createPetWithUnknownTypeUnknown.ts b/packages/plugin-ts/src/generators/__snapshots__/createPetWithUnknownTypeUnknown.ts
@@ -8,6 +8,11 @@ export type CreatePets201 = error & {
   name?: errorCode
 }
 
+/**
+ * @description Accepted response
+ */
+export type CreatePets202 = unknown
+
 /**
  * @description unexpected error
  */
@@ -24,10 +29,10 @@ export type CreatePetsMutationRequest = {
   tag: string
 }
 
-export type CreatePetsMutationResponse = createPets201
+export type CreatePetsMutationResponse = createPets201 | createPets202
 
 export type createPetsMutation = {
-  Response: createPets201
+  Response: createPets201 | createPets202
   Request: createPetsMutationRequest
   Errors: any
 }
diff --git a/packages/plugin-ts/src/generators/__snapshots__/createPetWithUnknownTypeVoid.ts b/packages/plugin-ts/src/generators/__snapshots__/createPetWithUnknownTypeVoid.ts
@@ -0,0 +1,38 @@
+/**
+ * @description Null response
+ */
+export type CreatePets201 = error & {
+  /**
+   * @type object | undefined
+   */
+  name?: errorCode
+}
+
+/**
+ * @description Accepted response
+ */
+export type CreatePets202 = void
+
+/**
+ * @description unexpected error
+ */
+export type CreatePetsError = error
+
+export type CreatePetsMutationRequest = {
+  /**
+   * @type string
+   */
+  name: string
+  /**
+   * @type string
+   */
+  tag: string
+}
+
+export type CreatePetsMutationResponse = createPets201 | createPets202
+
+export type createPetsMutation = {
+  Response: createPets201 | createPets202
+  Request: createPetsMutationRequest
+  Errors: any
+}
diff --git a/packages/plugin-ts/src/generators/typeGenerator.test.tsx b/packages/plugin-ts/src/generators/typeGenerator.test.tsx
@@ -445,6 +445,15 @@ describe('typeGenerator operation', async () => {
         unknownType: 'unknown',
       },
     },
+    {
+      name: 'createPet with unknownType void',
+      input: '../../mocks/petStore.yaml',
+      path: '/pets',
+      method: 'post',
+      options: {
+        unknownType: 'void',
+      },
+    },
     {
       name: 'deletePet',
       input: '../../mocks/petStore.yaml',

diff --git a/packages/plugin-ts/src/parser.ts b/packages/plugin-ts/src/parser.ts
@@ -8,6 +8,7 @@ import type ts from 'typescript'
 export const typeKeywordMapper = {
   any: () => factory.keywordTypeNodes.any,
   unknown: () => factory.keywordTypeNodes.unknown,
+  void: () => factory.keywordTypeNodes.void,
   number: () => factory.keywordTypeNodes.number,
   integer: () => factory.keywordTypeNodes.number,
   object: (nodes?: ts.TypeElement[]) => {

diff --git a/packages/plugin-ts/src/types.ts b/packages/plugin-ts/src/types.ts
@@ -55,7 +55,7 @@ export type Options = {
    * Which type to use when the Swagger/OpenAPI file is not providing more information.
    * @default 'any'
    */
-  unknownType?: 'any' | 'unknown'
+  unknownType?: 'any' | 'unknown' | 'void'
   /**
    * Choose what to use as mode for an optional value.
    * @examples 'questionToken': type?: string

diff --git a/packages/plugin-zod/src/parser.ts b/packages/plugin-zod/src/parser.ts
@@ -7,6 +7,7 @@ import type { Schema, SchemaKeywordBase, SchemaMapper } from '@kubb/plugin-oas'
 const zodKeywordMapper = {
   any: () => 'z.any()',
   unknown: () => 'z.unknown()',
+  void: () => 'z.void()',
   number: (coercion?: boolean, min?: number, max?: number) => {
     return [coercion ? 'z.coerce.number()' : 'z.number()', min !== undefined ? `.min(${min})` : undefined, max !== undefined ? `.max(${max})` : undefined]
       .filter(Boolean)