routing-controllers@0.9.0, class-transformer@0.4.0 (#72)

* fix: fix compatibility with routing-controllers 0.9

* class-validator v0.13.1

* Temporary class-validator-jsonschema bump

* Upgrade sample project deps

* class-validator-jsonschema v3.0.0

Co-authored-by: miguel costa <miguelcostaparedes@gmail.com>

Author: epiphone

__tests__/index.test.ts

@@ -1,5 +1,5 @@
 // tslint:disable:no-implicit-dependencies no-submodule-imports
-import { defaultMetadataStorage } from 'class-transformer/storage'
+const { defaultMetadataStorage } = require('class-transformer/cjs/storage')
 import { validationMetadatasToSchemas } from 'class-validator-jsonschema'
 import * as _ from 'lodash'
 import { getMetadataArgsStorage } from 'routing-controllers'

__tests__/parameters.test.ts

@@ -20,7 +20,7 @@ import {
 import { SchemaObject } from 'openapi3-ts'
 import { validationMetadatasToSchemas } from 'class-validator-jsonschema'
 import { IsBoolean, IsNumber, IsOptional, IsString } from 'class-validator'
-import { defaultMetadataStorage } from 'class-transformer/storage'
+const { defaultMetadataStorage } = require('class-transformer/cjs/storage')
 
 describe('parameters', () => {
   let route: IRoute

package-lock.json

@@ -43,9 +43,9 @@
     "@types/prettier": "^2.2.2",
     "@types/reflect-metadata": "^0.1.0",
     "@types/rimraf": "^3.0.0",
-    "class-transformer": "0.3.1",
-    "class-validator": "^0.12.2",
-    "class-validator-jsonschema": "^2.2.0",
+    "class-transformer": "^0.4.0",
+    "class-validator": "^0.13.1",
+    "class-validator-jsonschema": "^3.0.0",
     "codecov": "^3.8.1",
     "jest": "^26.6.3",
     "prettier": "^2.2.1",
@@ -57,6 +57,6 @@
     "typescript": "^4.2.3"
   },
   "peerDependencies": {
-    "routing-controllers": "^0.8.0"
+    "routing-controllers": "^0.9.0"
   }
 }

package.json

@@ -16,7 +16,7 @@ import {
   Put,
   QueryParams,
 } from 'routing-controllers'
-import { OpenAPI } from 'routing-controllers-openapi'
+import { OpenAPI, ResponseSchema } from 'routing-controllers-openapi'
 
 class Child {
   @IsString()
@@ -39,6 +39,14 @@ class CreateUserBody {
   children: Child[]
 }
 
+class UserResponse {
+  @IsString()
+  name: string
+
+  @IsString({ each: true })
+  hobbies: string[]
+}
+
 class PaginationQuery {
   @IsNumber()
   @IsPositive()
@@ -56,6 +64,7 @@ class PaginationQuery {
 export class UsersController {
   @Get('/')
   @OpenAPI({ summary: 'Return a list of users' })
+  @ResponseSchema(UserResponse, { isArray: true })
   getAll(@QueryParams() query: PaginationQuery) {
     return [
       { id: 1, name: 'First user!', hobbies: [] },
@@ -65,8 +74,9 @@ export class UsersController {
 
   @Get('/:id')
   @OpenAPI({ summary: 'Return a single user' })
+  @ResponseSchema(UserResponse)
   getOne(@Param('id') id: number) {
-    return { name: 'User #' + id }
+    return { name: 'User #' + id, hobbies: ['something'] }
   }
 
   @Post('/')

sample/01-basic/UsersController.ts

@@ -1,16 +1,16 @@
-import 'reflect-metadata'
-import { defaultMetadataStorage } from 'class-transformer/storage' // tslint:disable-line:no-submodule-imports
 import { validationMetadatasToSchemas } from 'class-validator-jsonschema'
 import { Express } from 'express'
+import 'reflect-metadata'
 import {
   createExpressServer,
   getMetadataArgsStorage,
 } from 'routing-controllers'
 import { routingControllersToSpec } from 'routing-controllers-openapi'
 import * as swaggerUiExpress from 'swagger-ui-express'
-
 import { UsersController } from './UsersController'
 
+const { defaultMetadataStorage } = require('class-transformer/cjs/storage')
+
 const routingControllersOptions = {
   controllers: [UsersController],
   routePrefix: '/api',