Merge pull request #128 from aqsous/main

refactor: update openapi3-ts

Author: Brian-McBride

package-lock.json

@@ -68,7 +68,7 @@
     "ngx-deploy-npm": "^6.0.0",
     "nx": "16.2.2",
     "nx-cloud": "16.0.5",
-    "openapi3-ts": "^3.1.2",
+    "openapi3-ts": "^4.1.2",
     "prettier": "^2.8.8",
     "reflect-metadata": "^0.1.13",
     "supertest": "^6.3.3",

package.json

@@ -1,4 +1,4 @@
-import type { SchemaObject } from 'openapi3-ts';
+import type { SchemaObject } from 'openapi3-ts/oas31';
 import { generateSchema, OpenApiZodAny } from '@anatine/zod-openapi';
 import * as z from 'zod';
 
@@ -79,14 +79,8 @@ export const createZodDto = <T extends OpenApiZodAny>(
         const schemaObjectWithRequiredField = {
           ...schemaObject,
         };
-        if (
-          (generatedSchema.required !== undefined,
-          generatedSchema.required?.includes(key))
-        ) {
-          schemaObjectWithRequiredField.required = true;
-        } else {
-          schemaObjectWithRequiredField.required = false;
-        }
+        schemaObjectWithRequiredField.required = !!(generatedSchema.required !== undefined,
+          generatedSchema.required?.includes(key));
         properties[key] = schemaObjectWithRequiredField as any; // TODO: Fix this
       }
       return properties as Record<string, SchemaObject>;
@@ -95,7 +89,7 @@ export const createZodDto = <T extends OpenApiZodAny>(
     public static create(input: unknown): CompatibleZodInfer<T> {
       return this.zodSchema.parse(input);
     }
-  };
+  }
 
   return <MergeZodSchemaOutput<T>>SchemaHolderClass;
 };

packages/zod-nestjs/src/lib/create-zod-dto.ts

@@ -5,8 +5,8 @@
  * This file was copied from:
  *   https://github.com/kbkk/abitia/blob/master/packages/zod-dto/src/OpenApi/patchNestjsSwagger.ts
  */
-import { generateSchema } from '@anatine/zod-openapi';
-import type { SchemaObject } from 'openapi3-ts';
+import {generateSchema} from '@anatine/zod-openapi';
+import type {SchemaObject} from 'openapi3-ts/oas31';
 
 interface Type<T = any> extends Function {
   new (...args: any[]): T;
@@ -38,9 +38,7 @@ export const patchNestjsSwagger = (
       return orgExploreModelSchema.call(this, type, schemas, schemaRefsStack);
     }
 
-    const openApiDef = generateSchema(type.zodSchema);
-
-    schemas[type.name] = openApiDef;
+    schemas[type.name] = generateSchema(type.zodSchema);
 
     return type.name;
   };

packages/zod-nestjs/src/lib/patch-nest-swagger.ts

@@ -4,7 +4,7 @@ This code is heavily inspired by https://github.com/asteasolutions/zod-to-openap
 
 import { extendApi } from './zod-openapi';
 import {z} from "zod";
-import { SchemaObject} from "openapi3-ts";
+import { SchemaObject } from "openapi3-ts/oas31";
 import {ZodTypeDef} from "zod/lib/types";
 
 

packages/zod-openapi/src/lib/zod-extensions.ts

@@ -1,4 +1,4 @@
-import { SchemaObject } from 'openapi3-ts';
+import { SchemaObject } from 'openapi3-ts/oas31';
 import validator from 'validator';
 import { z } from 'zod';
 import { generateSchema, extendApi } from './zod-openapi';
@@ -84,10 +84,6 @@ describe('zodOpenapi', () => {
     );
     const apiSchema = generateSchema(zodSchema);
     expect(apiSchema.properties).toBeDefined();
-    expect((apiSchema.properties?.aAny as SchemaObject).nullable).toEqual(true);
-    expect((apiSchema.properties?.aUnknown as SchemaObject).nullable).toEqual(
-      true
-    );
   });
 
   it('should support never type', () => {
@@ -201,12 +197,12 @@ describe('zodOpenapi', () => {
         aNumberMin: { type: 'number', minimum: 3 },
         aNumberMax: { type: 'number', maximum: 8 },
         aNumberInt: { type: 'integer' },
-        aNumberPositive: { type: 'number', minimum: 0, exclusiveMinimum: true },
+        aNumberPositive: { type: 'number', minimum: 0, exclusiveMinimum: 0 },
         aNumberNonnegative: { type: 'number', minimum: 0 },
-        aNumberNegative: { type: 'number', maximum: 0, exclusiveMaximum: true },
+        aNumberNegative: { type: 'number', maximum: 0, exclusiveMaximum: 0 },
         aNumberNonpositive: { type: 'number', maximum: 0 },
-        aNumberGt: { type: 'number', minimum: 5, exclusiveMinimum: true },
-        aNumberLt: { type: 'number', maximum: 5, exclusiveMaximum: true },
+        aNumberGt: { type: 'number', minimum: 5, exclusiveMinimum: 5 },
+        aNumberLt: { type: 'number', maximum: 5, exclusiveMaximum: 5 },
         aNumberMultipleOf: { type: 'number', multipleOf: 2 },
       },
       description: 'Look mah, the horse can count higher than me!',

packages/zod-openapi/src/lib/zod-openapi.spec.ts

@@ -1,6 +1,6 @@
-import type { SchemaObject, SchemaObjectType } from 'openapi3-ts';
+import type {SchemaObject, SchemaObjectType} from 'openapi3-ts/oas31';
 import merge from 'ts-deepmerge';
-import { AnyZodObject, z, ZodTypeAny } from 'zod';
+import {AnyZodObject, z, ZodTypeAny} from 'zod';
 
 export interface OpenApiZodAny extends ZodTypeAny {
   metaOpenApi?: SchemaObject | SchemaObject[];
@@ -145,11 +145,11 @@ function parseNumber({
       case 'max':
         baseSchema.maximum = item.value;
         // TODO: option to make this always explicit? (false instead of non-existent)
-        if (!item.inclusive) baseSchema.exclusiveMaximum = true;
+        if (!item.inclusive) baseSchema.exclusiveMaximum = item.value;
         break;
       case 'min':
         baseSchema.minimum = item.value;
-        if (!item.inclusive) baseSchema.exclusiveMinimum = true;
+        if (!item.inclusive) baseSchema.exclusiveMinimum = item.value;
         break;
       case 'int':
         baseSchema.type = 'integer';
@@ -206,7 +206,7 @@ function parseObject({
   const required =
     requiredProperties.length > 0 ? { required: requiredProperties } : {};
 
-  const result = merge(
+  return merge(
     {
       type: 'object' as SchemaObjectType,
       properties: iterateZodObject({
@@ -217,10 +217,9 @@ function parseObject({
       ...required,
       ...additionalProperties,
     },
-    zodRef.description ? { description: zodRef.description } : {},
+    zodRef.description ? {description: zodRef.description} : {},
     ...schemas
   );
-  return result;
 }
 
 function parseRecord({