Merge pull request #223 from asteasolutions/use-prefix-items-for-tuples

handle tuples as prefix items for v3.1.0 of openapi
asteasolutions · Apr 5, 2024 · cc5ca8e · cc5ca8e
2 parents 8773c3e + 3881050
commit cc5ca8e
Show file tree

Hide file tree

Showing 7 changed files with 93 additions and 45 deletions.
diff --git a/spec/lib/helpers.ts b/spec/lib/helpers.ts
@@ -1,8 +1,9 @@
 import type {
   ComponentsObject,
   OperationObject,
-  SchemasObject,
+  SchemasObject as SchemasObjectV30,
 } from 'openapi3-ts/oas30';
+import type { SchemasObject as SchemasObjectV31 } from 'openapi3-ts/oas31';
 import type { ZodTypeAny } from 'zod';
 import {
   OpenAPIDefinitions,
@@ -33,10 +34,10 @@ export function createSchemas(
   return components;
 }
 
-export function expectSchema(
+export function expectSchema<T extends OpenApiVersion = '3.0.0'>(
   zodSchemas: ZodTypeAny[],
-  openAPISchemas: SchemasObject,
-  openApiVersion: OpenApiVersion = '3.0.0'
+  openAPISchemas: T extends '3.1.0' ? SchemasObjectV31 : SchemasObjectV30,
+  openApiVersion?: T
 ) {
   const components = createSchemas(zodSchemas, openApiVersion);
 

diff --git a/spec/types/tuple.spec.ts b/spec/types/tuple.spec.ts
@@ -2,7 +2,7 @@ import { z } from 'zod';
 import { expectSchema } from '../lib/helpers';
 
 describe('tuple', () => {
-  it('supports tuples', () => {
+  it('supports tuples in 3.0.0', () => {
     expectSchema(
       [z.tuple([z.string(), z.number(), z.boolean()]).openapi('Test')],
       {
@@ -18,7 +18,25 @@ describe('tuple', () => {
           minItems: 3,
           maxItems: 3,
         },
-      }
+      },
+      '3.0.0'
+    );
+  });
+
+  it('supports tuples in 3.1.0', () => {
+    expectSchema(
+      [z.tuple([z.string(), z.number(), z.boolean()]).openapi('Test')],
+      {
+        Test: {
+          type: 'array',
+          prefixItems: [
+            { type: 'string' },
+            { type: 'number' },
+            { type: 'boolean' },
+          ],
+        },
+      },
+      '3.1.0'
     );
   });
 
@@ -35,7 +53,7 @@ describe('tuple', () => {
     });
   });
 
-  it('supports tuples of duplicate types', () => {
+  it('supports tuples of duplicate types in 3.0.0', () => {
     expectSchema(
       [z.tuple([z.string(), z.number(), z.string()]).openapi('Test')],
       {
@@ -51,6 +69,23 @@ describe('tuple', () => {
     );
   });
 
+  it('supports tuples of duplicate types in 3.1.0', () => {
+    expectSchema(
+      [z.tuple([z.string(), z.number(), z.string()]).openapi('Test')],
+      {
+        Test: {
+          type: 'array',
+          prefixItems: [
+            { type: 'string' },
+            { type: 'number' },
+            { type: 'string' },
+          ],
+        },
+      },
+      '3.1.0'
+    );
+  });
+
   it('supports tuples of referenced schemas', () => {
     const stringSchema = z.string().openapi('String');
 
@@ -134,14 +169,10 @@ describe('tuple', () => {
         {
           Test: {
             type: 'array',
-            items: {
-              anyOf: [
-                { type: ['string', 'null'] },
-                { type: ['number', 'null'] },
-              ],
-            },
-            minItems: 2,
-            maxItems: 2,
+            prefixItems: [
+              { type: ['string', 'null'] },
+              { type: ['number', 'null'] },
+            ],
           },
         },
         '3.1.0'
@@ -172,11 +203,7 @@ describe('tuple', () => {
         {
           Test: {
             type: ['array', 'null'],
-            items: {
-              anyOf: [{ type: 'string' }, { type: 'number' }],
-            },
-            minItems: 2,
-            maxItems: 2,
+            prefixItems: [{ type: 'string' }, { type: 'number' }],
           },
         },
         '3.1.0'

diff --git a/src/openapi-generator.ts b/src/openapi-generator.ts
@@ -1,4 +1,10 @@
-import type { AnyZodObject, ZodRawShape, ZodType, ZodTypeAny } from 'zod';
+import type {
+  AnyZodObject,
+  ZodRawShape,
+  ZodTuple,
+  ZodType,
+  ZodTypeAny,
+} from 'zod';
 import {
   ConflictError,
   MissingParameterDataError,
@@ -60,6 +66,13 @@ export interface OpenApiVersionSpecifics {
     isNullable: boolean
   ): Pick<SchemaObject, 'type' | 'nullable'>;
 
+  mapTupleItems(schemas: (SchemaObject | ReferenceObject)[]): {
+    items?: SchemaObject | ReferenceObject;
+    minItems?: number;
+    maxItems?: number;
+    prefixItems?: (SchemaObject | ReferenceObject)[];
+  };
+
   getNumberChecks(checks: ZodNumericCheck[]): any;
 }
 

diff --git a/src/transformers/index.ts b/src/transformers/index.ts
@@ -27,13 +27,15 @@ export class OpenApiTransformer {
   private enumTransformer = new EnumTransformer();
   private nativeEnumTransformer = new NativeEnumTransformer();
   private arrayTransformer = new ArrayTransformer();
-  private tupleTransformer = new TupleTransformer();
+  private tupleTransformer: TupleTransformer;
   private unionTransformer = new UnionTransformer();
   private discriminatedUnionTransformer = new DiscriminatedUnionTransformer();
   private intersectionTransformer = new IntersectionTransformer();
   private recordTransformer = new RecordTransformer();
 
-  constructor(private versionSpecifics: OpenApiVersionSpecifics) {}
+  constructor(private versionSpecifics: OpenApiVersionSpecifics) {
+    this.tupleTransformer = new TupleTransformer(versionSpecifics);
+  }
 
   transform<T>(
     zodSchema: ZodType<T>,

diff --git a/src/transformers/tuple.ts b/src/transformers/tuple.ts
@@ -1,37 +1,22 @@
 import { MapNullableType, MapSubSchema, SchemaObject } from '../types';
 import { ZodTuple } from 'zod';
-import { uniq } from '../lib/lodash';
+import { OpenApiVersionSpecifics } from '../openapi-generator';
 
 export class TupleTransformer {
+  constructor(private versionSpecifics: OpenApiVersionSpecifics) {}
+
   transform(
     zodSchema: ZodTuple,
     mapNullableType: MapNullableType,
     mapItem: MapSubSchema
   ): SchemaObject {
     const { items } = zodSchema._def;
 
-    const tupleLength = items.length;
-
-    const schemas = items.map(schema => mapItem(schema));
-
-    const uniqueSchemas = uniq(schemas);
-
-    if (uniqueSchemas.length === 1) {
-      return {
-        type: 'array',
-        items: uniqueSchemas[0],
-        minItems: tupleLength,
-        maxItems: tupleLength,
-      };
-    }
+    const schemas = items.map(mapItem);
 
     return {
       ...mapNullableType('array'),
-      items: {
-        anyOf: uniqueSchemas,
-      },
-      minItems: tupleLength,
-      maxItems: tupleLength,
+      ...this.versionSpecifics.mapTupleItems(schemas),
     };
   }
 }
diff --git a/src/v3.0/specifics.ts b/src/v3.0/specifics.ts
@@ -1,6 +1,7 @@
 import type { ReferenceObject, SchemaObject } from 'openapi3-ts/oas30';
 import { OpenApiVersionSpecifics } from '../openapi-generator';
-import { ZodNumericCheck } from '../types';
+import { ZodNumericCheck, SchemaObject as CommonSchemaObject } from '../types';
+import { uniq } from '../lib/lodash';
 
 export class OpenApiGeneratorV30Specifics implements OpenApiVersionSpecifics {
   get nullType() {
@@ -27,6 +28,19 @@ export class OpenApiGeneratorV30Specifics implements OpenApiVersionSpecifics {
     };
   }
 
+  mapTupleItems(schemas: (CommonSchemaObject | ReferenceObject)[]) {
+    const uniqueSchemas = uniq(schemas);
+
+    return {
+      items:
+        uniqueSchemas.length === 1
+          ? uniqueSchemas[0]
+          : { anyOf: uniqueSchemas },
+      minItems: schemas.length,
+      maxItems: schemas.length,
+    };
+  }
+
   getNumberChecks(
     checks: ZodNumericCheck[]
   ): Pick<

diff --git a/src/v3.1/specifics.ts b/src/v3.1/specifics.ts
@@ -1,7 +1,7 @@
 import type { ReferenceObject, SchemaObject } from 'openapi3-ts/oas31';
 
 import { OpenApiVersionSpecifics } from '../openapi-generator';
-import { ZodNumericCheck } from '../types';
+import { ZodNumericCheck, SchemaObject as CommonSchemaObject } from '../types';
 
 export class OpenApiGeneratorV31Specifics implements OpenApiVersionSpecifics {
   get nullType() {
@@ -39,6 +39,12 @@ export class OpenApiGeneratorV31Specifics implements OpenApiVersionSpecifics {
     };
   }
 
+  mapTupleItems(schemas: (CommonSchemaObject | ReferenceObject)[]) {
+    return {
+      prefixItems: schemas,
+    };
+  }
+
   getNumberChecks(
     checks: ZodNumericCheck[]
   ): Pick<