Merge pull request #75 from JanTvrdik/number-min-max

Fix exclusive minimum and maximum checks for numbers

Author: AGalabov

spec/types/number.spec.ts

@@ -19,4 +19,68 @@ describe('number', () => {
       Literal: { type: 'number', enum: [42] },
     });
   });
+
+  it('supports minimum in open api 3.0.0', () => {
+    expectSchema([registerSchema('SimpleInteger', z.number().int().gte(0))], {
+      SimpleInteger: { type: 'integer', minimum: 0 },
+    });
+  });
+
+  it('supports exclusive minimum in open api 3.0.0', () => {
+    expectSchema([registerSchema('SimpleInteger', z.number().int().gt(0))], {
+      SimpleInteger: { type: 'integer', minimum: 0, exclusiveMinimum: true },
+    });
+  });
+
+  it('supports maximum in open api 3.0.0', () => {
+    expectSchema([registerSchema('SimpleInteger', z.number().int().lte(0))], {
+      SimpleInteger: { type: 'integer', maximum: 0 },
+    });
+  });
+
+  it('supports exclusive maximum in open api 3.0.0', () => {
+    expectSchema([registerSchema('SimpleInteger', z.number().int().lt(0))], {
+      SimpleInteger: { type: 'integer', maximum: 0, exclusiveMaximum: true },
+    });
+  });
+
+  it('supports minimum in open api 3.1.0', () => {
+    expectSchema(
+      [registerSchema('SimpleInteger', z.number().int().gte(0))],
+      {
+        SimpleInteger: { type: 'integer', minimum: 0 },
+      },
+      '3.1.0'
+    );
+  });
+
+  it('supports exclusive minimum in open api 3.1.0', () => {
+    expectSchema(
+      [registerSchema('SimpleInteger', z.number().int().gt(0))],
+      {
+        SimpleInteger: { type: 'integer', exclusiveMinimum: 0 },
+      },
+      '3.1.0'
+    );
+  });
+
+  it('supports maximum in open api 3.1.0', () => {
+    expectSchema(
+      [registerSchema('SimpleInteger', z.number().int().lte(0))],
+      {
+        SimpleInteger: { type: 'integer', maximum: 0 },
+      },
+      '3.1.0'
+    );
+  });
+
+  it('supports exclusive maximum in open api 3.1.0', () => {
+    expectSchema(
+      [registerSchema('SimpleInteger', z.number().int().lt(0))],
+      {
+        SimpleInteger: { type: 'integer', exclusiveMaximum: 0 },
+      },
+      '3.1.0'
+    );
+  });
 });

src/openapi-generator.ts

@@ -13,6 +13,7 @@ import {
 } from 'openapi3-ts';
 import type {
   AnyZodObject,
+  ZodNumberDef,
   ZodObject,
   ZodRawShape,
   ZodSchema,
@@ -662,6 +663,37 @@ export class OpenAPIGenerator {
     };
   }
 
+  private getNumberChecks(
+    checks: ZodNumberDef['checks']
+  ): Pick<
+    SchemaObject,
+    'minimum' | 'exclusiveMinimum' | 'maximum' | 'exclusiveMaximum'
+  > {
+    return Object.assign(
+      {},
+      ...checks.map<SchemaObject>(check => {
+        switch (check.kind) {
+          case 'min':
+            return check.inclusive
+              ? { minimum: check.value }
+              : this.openApiVersionSatisfies(this.openAPIVersion, '3.1.0')
+              ? { exclusiveMinimum: check.value }
+              : { minimum: check.value, exclusiveMinimum: true };
+
+          case 'max':
+            return check.inclusive
+              ? { maximum: check.value }
+              : this.openApiVersionSatisfies(this.openAPIVersion, '3.1.0')
+              ? { exclusiveMaximum: check.value }
+              : { maximum: check.value, exclusiveMaximum: true };
+
+          default:
+            return {};
+        }
+      })
+    );
+  }
+
   private constructReferencedOpenAPISchema<T>(
     zodSchema: ZodSchema<T>,
     innerSchema: ZodSchema<T>,
@@ -709,8 +741,7 @@ export class OpenAPIGenerator {
           zodSchema.isInt ? 'integer' : 'number',
           isNullable
         ),
-        minimum: zodSchema.minValue ?? undefined,
-        maximum: zodSchema.maxValue ?? undefined,
+        ...this.getNumberChecks(zodSchema._def.checks),
         default: defaultValue,
       };
     }