[email protected] + [email protected] (#60)

* [email protected], [email protected]

* Remove broken Github Actions badge

* Update peer dependency version warning in README

Author: epiphone

README.md

@@ -1,16 +1,14 @@
 # class-validator-jsonschema
 
-![CI status](https://github.com/epiphone/class-validator-jsonschema/workflows/.github/workflows/test.yml/badge.svg?branch=master) [![codecov](https://codecov.io/gh/epiphone/class-validator-jsonschema/branch/master/graph/badge.svg)](https://codecov.io/gh/epiphone/class-validator-jsonschema) [![npm version](https://badge.fury.io/js/class-validator-jsonschema.svg)](https://badge.fury.io/js/class-validator-jsonschema)
+[![codecov](https://codecov.io/gh/epiphone/class-validator-jsonschema/branch/master/graph/badge.svg)](https://codecov.io/gh/epiphone/class-validator-jsonschema) [![npm version](https://badge.fury.io/js/class-validator-jsonschema.svg)](https://badge.fury.io/js/class-validator-jsonschema)
 
 Convert [class-validator](https://github.com/typestack/class-validator)-decorated classes into OpenAPI-compatible JSON Schema. The aim is to provide a best-effort conversion: since some of the `class-validator` decorators lack a direct JSON Schema counterpart, the conversion is bound to be somewhat opinionated. To account for this multiple extension points are available.
 
 ## Installation
 
 `npm install class-validator-jsonschema`
 
-Note that the library is **only compatible with `class-validator` versions 0.12 or higher**!
-
-Try installing `[email protected]` in case you're stuck with an older `class-validator` version.
+**Note the peer dependency versions** in [package.json](./package.json). Try installing a previous major version of `class-validator-jsonschema` in case you're stuck with older peer dependencies.
 
 ## Usage
 
@@ -213,8 +211,8 @@ would resolve to classes `Array` and `Promise` in JSON Schema. To work around th
 
 ```typescript
 import { Type } from 'class-transformer'
-import { defaultMetadataStorage } from 'class-transformer/storage'
 import { validationMetadatasToSchemas } from 'class-validator-jsonschema'
+const { defaultMetadataStorage } = require('class-transformer/cjs/storage') // See https://github.com/typestack/class-transformer/issues/563 for alternatives
 
 class User {
   @ValidateNested({ each: true })

__tests__/additionalProperties.ts

@@ -2,7 +2,7 @@
 import { IsString, MinLength, ValidateNested } from 'class-validator'
 import { validationMetadatasToSchemas } from '../src'
 import { Type } from 'class-transformer'
-import { defaultMetadataStorage } from 'class-transformer/storage'
+const { defaultMetadataStorage } = require('class-transformer/cjs/storage')
 
 class User {
   @IsString()

__tests__/classTransformer.test.ts

@@ -1,6 +1,5 @@
 // tslint:disable:no-submodule-imports
 import { Type } from 'class-transformer'
-import { defaultMetadataStorage } from 'class-transformer/storage'
 import {
   ArrayMinSize,
   getFromContainer,
@@ -11,6 +10,7 @@ import {
 } from 'class-validator'
 
 import { validationMetadatasToSchemas } from '../src'
+const { defaultMetadataStorage } = require('class-transformer/cjs/storage')
 
 class ValidationError {
   @IsString({ each: true })

__tests__/exclude.test.ts

@@ -1,8 +1,8 @@
 // tslint:disable:no-submodule-imports
 import { Exclude } from 'class-transformer'
-import { defaultMetadataStorage } from 'class-transformer/storage'
 import { Allow, IsString } from 'class-validator'
 import { validationMetadatasToSchemas } from '../src'
+const { defaultMetadataStorage } = require('class-transformer/cjs/storage')
 
 class Parent {
   @Allow()

package.json

@@ -53,7 +53,7 @@
     "typescript": "^4.1.3"
   },
   "peerDependencies": {
-    "class-transformer": "0.2.3 - 0.3.1",
-    "class-validator": "^0.12.0"
+    "class-transformer": "^0.4.0",
+    "class-validator": "^0.13.1"
   }
 }

src/defaultConverters.ts

@@ -277,7 +277,7 @@ export const defaultConverters: ISchemaConverters = {
     format: 'uuid',
     type: 'string',
   },
-  [cv.LENGTH]: (meta) => {
+  [cv.IS_LENGTH]: (meta) => {
     const [minLength, maxLength] = meta.constraints
     if (maxLength || maxLength === 0) {
       return { minLength, maxLength, type: 'string' }

src/options.ts

@@ -1,4 +1,4 @@
-import { MetadataStorage as ClassTransformerMetadataStorage } from 'class-transformer/metadata/MetadataStorage' // tslint:disable-line:no-submodule-imports
+import type { MetadataStorage as ClassTransformerMetadataStorage } from 'class-transformer/types/MetadataStorage' // tslint:disable-line:no-submodule-imports
 import {
   getMetadataStorage,
   MetadataStorage,