Upgrade to openapi3-ts v3.0.0 (epiphone#99)

* Upgrade to `openapi3-ts` v3.0.0 * exclusive limits should be numbers in [email protected] they are not using the v4 syntax anymore: metadevpro/openapi3-ts@e7a0851 * Fix test Co-authored-by: Daniel Varnai <[email protected]>
firefliesai · Jan 14, 2023 · be8d2f0 · be8d2f0
1 parent 9e3eba3
commit be8d2f0
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 41 deletions.
diff --git a/__tests__/defaultConverters.test.ts b/__tests__/defaultConverters.test.ts
@@ -198,8 +198,8 @@ describe('defaultConverters', () => {
 
           isDivisibleByInt: { multipleOf: 4, type: 'number' },
           isDivisibleByFloat: { multipleOf: 1.1, type: 'number' },
-          isPositive: { type: 'number', minimum: 0, exclusiveMinimum: true },
-          isNegative: { type: 'number', maximum: 0, exclusiveMaximum: true },
+          isPositive: { type: 'number', exclusiveMinimum: 0 },
+          isNegative: { type: 'number', exclusiveMaximum: 0 },
           max: { type: 'number', maximum: 10 },
           min: { type: 'number', minimum: 1 },
 

diff --git a/__tests__/inheritedProperties.test.ts b/__tests__/inheritedProperties.test.ts
@@ -17,7 +17,7 @@ import { JSONSchema, validationMetadatasToSchemas } from '../src'
 
 @JSONSchema({
   description: 'Contains email, password and phone',
-  summary: 'Base object',
+  title: 'Base object',
 })
 class BaseContent {
   @JSONSchema({
@@ -29,7 +29,7 @@ class BaseContent {
 
   @JSONSchema({
     description: 'Password field',
-    summary: 'Password',
+    title: 'Password',
   })
   @IsString()
   @IsOptional()
@@ -41,7 +41,7 @@ class BaseContent {
 }
 
 @JSONSchema({
-  summary: 'User object',
+  title: 'User object',
 })
 // @ts-ignore: not referenced
 class User extends BaseContent {
@@ -57,7 +57,7 @@ class User extends BaseContent {
   password: string
 
   @JSONSchema({
-    summary: 'Mobile phone number',
+    title: 'Mobile phone number',
   })
   @IsOptional()
   phone: string
@@ -82,7 +82,7 @@ describe('Inheriting validation decorators', () => {
         },
         password: {
           description: 'Password field',
-          summary: 'Password',
+          title: 'Password',
           type: 'string',
         },
         phone: {
@@ -92,7 +92,7 @@ describe('Inheriting validation decorators', () => {
         },
       },
       required: ['email', 'phone'],
-      summary: 'Base object',
+      title: 'Base object',
       type: 'object',
     })
 
@@ -117,7 +117,7 @@ describe('Inheriting validation decorators', () => {
         },
         phone: {
           format: 'mobile-phone',
-          summary: 'Mobile phone number',
+          title: 'Mobile phone number',
           type: 'string',
           not: { type: 'null' },
         },
@@ -127,7 +127,7 @@ describe('Inheriting validation decorators', () => {
         },
       },
       required: ['name', 'welcome', 'email'],
-      summary: 'User object',
+      title: 'User object',
       type: 'object',
     })
   })

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,7 +31,7 @@
   "dependencies": {
     "lodash.groupby": "^4.6.0",
     "lodash.merge": "^4.6.2",
-    "openapi3-ts": "^2.0.2",
+    "openapi3-ts": "^3.0.0",
     "reflect-metadata": "^0.1.13",
     "tslib": "^2.4.1"
   },

diff --git a/src/decorators.ts b/src/decorators.ts
@@ -1,5 +1,5 @@
 // tslint:disable:ban-types
-import { SchemaObject } from 'openapi3-ts'
+import type { ReferenceObject, SchemaObject } from 'openapi3-ts'
 import 'reflect-metadata'
 
 import { IOptions } from './options'
@@ -12,8 +12,12 @@ const SCHEMA_KEY = Symbol('class-validator-jsonschema:JSONSchema')
  * options, returning an updated schema.
  */
 export type DecoratorSchema =
+  | ReferenceObject
   | SchemaObject
-  | ((source: SchemaObject, options: IOptions) => SchemaObject)
+  | ((
+      source: SchemaObject,
+      options: IOptions
+    ) => ReferenceObject | SchemaObject)
 
 /**
  * Supplement class or property with additional JSON Schema keywords.

diff --git a/src/defaultConverters.ts b/src/defaultConverters.ts
@@ -1,7 +1,7 @@
 // tslint:disable:no-submodule-imports
 import * as cv from 'class-validator'
-import { ValidationMetadata } from 'class-validator/types/metadata/ValidationMetadata'
-import { SchemaObject } from 'openapi3-ts'
+import type { ValidationMetadata } from 'class-validator/types/metadata/ValidationMetadata'
+import type { ReferenceObject, SchemaObject } from 'openapi3-ts'
 import 'reflect-metadata'
 
 import { IOptions } from './options'
@@ -13,7 +13,7 @@ export interface ISchemaConverters {
 export type SchemaConverter = (
   meta: ValidationMetadata,
   options: IOptions
-) => SchemaObject | void
+) => ReferenceObject | SchemaObject | void
 
 export const defaultConverters: ISchemaConverters = {
   [cv.ValidationTypes.CUSTOM_VALIDATION]: (meta, options) => {
@@ -126,13 +126,11 @@ export const defaultConverters: ISchemaConverters = {
     type: 'number',
   }),
   [cv.IS_POSITIVE]: {
-    exclusiveMinimum: true,
-    minimum: 0,
+    exclusiveMinimum: 0,
     type: 'number',
   },
   [cv.IS_NEGATIVE]: {
-    exclusiveMaximum: true,
-    maximum: 0,
+    exclusiveMaximum: 0,
     type: 'number',
   },
   [cv.MIN]: (meta) => ({
@@ -381,7 +379,10 @@ function constraintToSchema(primitive: any): SchemaObject | void {
   }
 }
 
-function targetToSchema(type: any, options: IOptions): SchemaObject | void {
+function targetToSchema(
+  type: any,
+  options: IOptions
+): ReferenceObject | SchemaObject | void {
   if (typeof type === 'function') {
     if (
       type.prototype === String.prototype ||

diff --git a/src/index.ts b/src/index.ts
@@ -3,7 +3,7 @@ import * as cv from 'class-validator'
 import { ValidationMetadata } from 'class-validator/types/metadata/ValidationMetadata'
 import _groupBy from 'lodash.groupby'
 import _merge from 'lodash.merge'
-import { SchemaObject } from 'openapi3-ts'
+import type { ReferenceObject, SchemaObject } from 'openapi3-ts'
 
 import { getMetadataSchema } from './decorators'
 import { defaultConverters } from './defaultConverters'
@@ -65,7 +65,7 @@ export function validationMetadataArrayToSchemas(
           )
       )
 
-    const properties: { [name: string]: SchemaObject } = {}
+    const properties: { [name: string]: ReferenceObject | SchemaObject } = {}
 
     Object.entries(_groupBy(metas, 'propertyName')).forEach(
       ([propName, propMetas]) => {
@@ -94,7 +94,7 @@ export function validationMetadataArrayToSchemas(
       target,
       options,
       target.name
-    )
+    ) as SchemaObject
   })
 
   return schemas
@@ -241,7 +241,7 @@ function applyDecorators(
   target: Function,
   options: IOptions,
   propertyName: string
-): SchemaObject {
+): ReferenceObject | SchemaObject {
   const additionalSchema = getMetadataSchema(target.prototype, propertyName)
   return typeof additionalSchema === 'function'
     ? additionalSchema(schema, options)