class-validator-jsonschema - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

build/decorators.d.ts

@@ -5,3 +5,3 @@ import { SchemaObject } from 'openapi3-ts';
 export declare type DecoratorSchema = SchemaObject | ((source: SchemaObject, options: IOptions) => SchemaObject);
-export declare function JSONSchema(schema: DecoratorSchema): (target: object, key?: string | undefined) => void;
-export declare function getMetadataSchema(target: object, key?: string): DecoratorSchema;
+export declare function JSONSchema(schema: DecoratorSchema): (target: object | Function, key?: string | undefined) => void;
+export declare function getMetadataSchema(target: object | Function, key: string): DecoratorSchema;

build/decorators.js

@@ -7,3 +7,8 @@ "use strict";
     return (target, key) => {
-        setMetadataSchema(schema, target, key);
+        if (key) {
+            setMetadataSchema(schema, target.constructor, key);
+        }
+        else {
+            setMetadataSchema(schema, target, target.name);
+        }
     };
@@ -13,13 +18,8 @@ }
 function getMetadataSchema(target, key) {
-    const schema = key
-        ? Reflect.getMetadata(SCHEMA_KEY, target.constructor, key)
-        : Reflect.getMetadata(SCHEMA_KEY, target.constructor);
-    return schema || {};
+    return Reflect.getMetadata(SCHEMA_KEY, target.constructor, key) || {};
 }
 exports.getMetadataSchema = getMetadataSchema;
 function setMetadataSchema(value, target, key) {
-    return key
-        ? Reflect.defineMetadata(SCHEMA_KEY, value, target.constructor, key)
-        : Reflect.defineMetadata(SCHEMA_KEY, value, target.constructor);
+    return Reflect.defineMetadata(SCHEMA_KEY, value, target, key);
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsNEJBQXlCO0FBSXpCLE1BQU0sVUFBVSxHQUFHLE1BQU0sQ0FBQyx1Q0FBdUMsQ0FBQyxDQUFBO0FBb0JsRSxvQkFBMkIsTUFBdUI7SUFDaEQsTUFBTSxDQUFDLENBQUMsTUFBYyxFQUFFLEdBQVksRUFBRSxFQUFFO1FBQ3RDLGlCQUFpQixDQUFDLE1BQU0sRUFBRSxNQUFNLEVBQUUsR0FBRyxDQUFDLENBQUE7SUFDeEMsQ0FBQyxDQUFBO0FBQ0gsQ0FBQztBQUpELGdDQUlDO0FBS0QsMkJBQ0UsTUFBYyxFQUNkLEdBQVk7SUFFWixNQUFNLE1BQU0sR0FBRyxHQUFHO1FBQ2hCLENBQUMsQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLFVBQVUsRUFBRSxNQUFNLENBQUMsV0FBVyxFQUFFLEdBQUcsQ0FBQztRQUMxRCxDQUFDLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxVQUFVLEVBQUUsTUFBTSxDQUFDLFdBQVcsQ0FBQyxDQUFBO0lBQ3ZELE1BQU0sQ0FBQyxNQUFNLElBQUksRUFBRSxDQUFBO0FBQ3JCLENBQUM7QUFSRCw4Q0FRQztBQUtELDJCQUNFLEtBQXNCLEVBQ3RCLE1BQWMsRUFDZCxHQUFZO0lBRVosTUFBTSxDQUFDLEdBQUc7UUFDUixDQUFDLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQyxXQUFXLEVBQUUsR0FBRyxDQUFDO1FBQ3BFLENBQUMsQ0FBQyxPQUFPLENBQUMsY0FBYyxDQUFDLFVBQVUsRUFBRSxLQUFLLEVBQUUsTUFBTSxDQUFDLFdBQVcsQ0FBQyxDQUFBO0FBQ25FLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb3JhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9kZWNvcmF0b3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBRUEsNEJBQXlCO0FBSXpCLE1BQU0sVUFBVSxHQUFHLE1BQU0sQ0FBQyx1Q0FBdUMsQ0FBQyxDQUFBO0FBb0JsRSxvQkFBMkIsTUFBdUI7SUFDaEQsTUFBTSxDQUFDLENBQUMsTUFBeUIsRUFBRSxHQUFZLEVBQUUsRUFBRTtRQUNqRCxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO1lBQ1IsaUJBQWlCLENBQUMsTUFBTSxFQUFFLE1BQU0sQ0FBQyxXQUFXLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFDcEQsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ04saUJBQWlCLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRyxNQUFtQixDQUFDLElBQUksQ0FBQyxDQUFBO1FBQzlELENBQUM7SUFDSCxDQUFDLENBQUE7QUFDSCxDQUFDO0FBUkQsZ0NBUUM7QUFLRCwyQkFDRSxNQUF5QixFQUN6QixHQUFXO0lBRVgsTUFBTSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsVUFBVSxFQUFFLE1BQU0sQ0FBQyxXQUFXLEVBQUUsR0FBRyxDQUFDLElBQUksRUFBRSxDQUFBO0FBQ3ZFLENBQUM7QUFMRCw4Q0FLQztBQUtELDJCQUNFLEtBQXNCLEVBQ3RCLE1BQXlCLEVBQ3pCLEdBQVc7SUFFWCxNQUFNLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxHQUFHLENBQUMsQ0FBQTtBQUMvRCxDQUFDIn0=

build/index.js

@@ -15,5 +15,6 @@ "use strict";
         .groupBy('target.name')
-        .mapValues(schemaMetas => {
-        const target = schemaMetas[0].target;
-        const properties = _(schemaMetas)
+        .mapValues(ownMetas => {
+        const target = ownMetas[0].target;
+        const metas = ownMetas.concat(getInheritedMetadatas(target, metadatas));
+        const properties = _(metas)
             .groupBy('propertyName')
@@ -27,6 +28,6 @@ .mapValues((propMetas, propKey) => {
             properties,
-            required: getRequiredPropNames(schemaMetas, options),
+            required: getRequiredPropNames(target, metas, options),
             type: 'object'
         };
-        return applyDecorators(definitionSchema, target.constructor, options);
+        return applyDecorators(definitionSchema, target, options, target.name);
     })
@@ -37,2 +38,11 @@ .value();
 exports.validationMetadatasToSchemas = validationMetadatasToSchemas;
+function getInheritedMetadatas(target, metadatas) {
+    return metadatas.filter(d => d.target instanceof Function &&
+        target.prototype instanceof d.target &&
+        !_.find(metadatas, {
+            propertyName: d.propertyName,
+            target,
+            type: d.type
+        }));
+}
 function applyConverters(propertyMetadatas, options) {
@@ -57,13 +67,16 @@ const converters = Object.assign({}, defaultConverters_1.defaultConverters, options.additionalConverters);
 }
-function getRequiredPropNames(metadatas, options) {
-    const optionalValidators = [
-        class_validator_1.ValidationTypes.CONDITIONAL_VALIDATION,
-        class_validator_1.ValidationTypes.IS_EMPTY
-    ];
+function getRequiredPropNames(target, metadatas, options) {
+    function isDefined(metas) {
+        return _.some(metas, { type: class_validator_1.ValidationTypes.IS_DEFINED });
+    }
+    function isOptional(metas) {
+        return _.some(metas, ({ type }) => _.includes([class_validator_1.ValidationTypes.CONDITIONAL_VALIDATION, class_validator_1.ValidationTypes.IS_EMPTY], type));
+    }
     return _(metadatas)
         .groupBy('propertyName')
-        .pickBy(d => {
+        .pickBy(metas => {
+        const [own, inherited] = _.partition(metas, d => d.target === target);
         return options.skipMissingProperties
-            ? _.some(d, { type: class_validator_1.ValidationTypes.IS_DEFINED })
-            : !_.some(d, ({ type }) => _.includes(optionalValidators, type));
+            ? isDefined(own) || (!isOptional(own) && isDefined(inherited))
+            : !(isOptional(own) || isOptional(inherited));
     })
@@ -73,2 +86,2 @@ .keys()
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSxxREFBaUQ7QUFFakQsNEJBQTJCO0FBRTNCLE1BQU0sS0FBSyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQyw2QkFBNkIsQ0FBQyxDQUFBO0FBRTdELDZDQUFnRDtBQUNoRCwyREFBdUQ7QUFDdkQsdUNBQW9EO0FBRXBELDJDQUF5QztBQUFoQyxrQ0FBQSxVQUFVLENBQUE7QUFNbkIsc0NBQ0UsU0FBK0IsRUFDL0IsV0FBK0I7SUFFL0IsTUFBTSxPQUFPLHFCQUNSLHdCQUFjLEVBQ2QsV0FBVyxDQUNmLENBQUE7SUFFRCxNQUFNLE9BQU8sR0FBb0MsQ0FBQyxDQUFDLFNBQVMsQ0FBQztTQUMxRCxPQUFPLENBQUMsYUFBYSxDQUFDO1NBQ3RCLFNBQVMsQ0FBQyxXQUFXLENBQUMsRUFBRTtRQUN2QixNQUFNLE1BQU0sR0FBRyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBa0IsQ0FBQTtRQUNoRCxNQUFNLFVBQVUsR0FBRyxDQUFDLENBQUMsV0FBVyxDQUFDO2FBQzlCLE9BQU8sQ0FBQyxjQUFjLENBQUM7YUFDdkIsU0FBUyxDQUFDLENBQUMsU0FBUyxFQUFFLE9BQU8sRUFBRSxFQUFFO1lBQ2hDLE1BQU0sTUFBTSxHQUFHLGVBQWUsQ0FBQyxTQUFTLEVBQUUsT0FBTyxDQUFDLENBQUE7WUFDbEQsTUFBTSxDQUFDLGVBQWUsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQTtRQUMxRCxDQUFDLENBQUM7YUFDRCxLQUFLLEVBQUUsQ0FBQTtRQUVWLE1BQU0sZ0JBQWdCLEdBQUc7WUFDdkIsVUFBVTtZQUNWLFFBQVEsRUFBRSxvQkFBb0IsQ0FBQyxXQUFXLEVBQUUsT0FBTyxDQUFDO1lBQ3BELElBQUksRUFBRSxRQUFRO1NBQ2YsQ0FBQTtRQUVELE1BQU0sQ0FBQyxlQUFlLENBQUMsZ0JBQWdCLEVBQUUsTUFBTSxDQUFDLFdBQVcsRUFBRSxPQUFPLENBQUMsQ0FBQTtJQUN2RSxDQUFDLENBQUM7U0FDRCxLQUFLLEVBQUUsQ0FBQTtJQUVWLE1BQU0sQ0FBQyxPQUFPLENBQUE7QUFDaEIsQ0FBQztBQWhDRCxvRUFnQ0M7QUFLRCx5QkFDRSxpQkFBdUMsRUFDdkMsT0FBaUI7SUFFakIsTUFBTSxVQUFVLHFCQUFRLHFDQUFpQixFQUFLLE9BQU8sQ0FBQyxvQkFBb0IsQ0FBRSxDQUFBO0lBQzVFLE1BQU0sT0FBTyxHQUFHLENBQUMsSUFBd0IsRUFBRSxFQUFFO1FBQzNDLE1BQU0sU0FBUyxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUE7UUFDdkMsRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDO1lBQ2YsS0FBSyxDQUFDLG1EQUFtRCxFQUFFLElBQUksQ0FBQyxDQUFBO1lBQ2hFLE1BQU0sQ0FBQyxFQUFFLENBQUE7UUFDWCxDQUFDO1FBRUQsTUFBTSxLQUFLLEdBQUcsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDLElBQUksRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFBO1FBQzVFLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxFQUFFLEtBQUssRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQTtJQUNyRCxDQUFDLENBQUE7SUFHRCxNQUFNLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxFQUFFLEVBQUUsR0FBRyxpQkFBaUIsQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQTtBQUN2RCxDQUFDO0FBTUQseUJBQ0UsTUFBb0IsRUFDcEIsTUFBZ0IsRUFDaEIsT0FBaUIsRUFDakIsWUFBcUI7SUFFckIsTUFBTSxnQkFBZ0IsR0FBRyw4QkFBaUIsQ0FBQyxNQUFNLENBQUMsU0FBUyxFQUFFLFlBQVksQ0FBQyxDQUFBO0lBQzFFLE1BQU0sQ0FBQyxDQUFDLENBQUMsVUFBVSxDQUFDLGdCQUFnQixDQUFDO1FBQ25DLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDO1FBQ25DLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLEVBQUUsRUFBRSxNQUFNLEVBQUUsZ0JBQWdCLENBQUMsQ0FBQTtBQUMzQyxDQUFDO0FBTUQsOEJBQ0UsU0FBK0IsRUFDL0IsT0FBaUI7SUFFakIsTUFBTSxrQkFBa0IsR0FBRztRQUN6QixpQ0FBZSxDQUFDLHNCQUFzQjtRQUN0QyxpQ0FBZSxDQUFDLFFBQVE7S0FDekIsQ0FBQTtJQUNELE1BQU0sQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDO1NBQ2hCLE9BQU8sQ0FBQyxjQUFjLENBQUM7U0FDdkIsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFO1FBQ1YsTUFBTSxDQUFDLE9BQU8sQ0FBQyxxQkFBcUI7WUFDbEMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxFQUFFLEVBQUUsSUFBSSxFQUFFLGlDQUFlLENBQUMsVUFBVSxFQUFFLENBQUM7WUFDakQsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUFFLElBQUksRUFBRSxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLGtCQUFrQixFQUFFLElBQUksQ0FBQyxDQUFDLENBQUE7SUFDcEUsQ0FBQyxDQUFDO1NBQ0QsSUFBSSxFQUFFO1NBQ04sS0FBSyxFQUFFLENBQUE7QUFDWixDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSxxREFBaUQ7QUFFakQsNEJBQTJCO0FBRTNCLE1BQU0sS0FBSyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQyw2QkFBNkIsQ0FBQyxDQUFBO0FBRTdELDZDQUFnRDtBQUNoRCwyREFBdUQ7QUFDdkQsdUNBQW9EO0FBRXBELDJDQUF5QztBQUFoQyxrQ0FBQSxVQUFVLENBQUE7QUFNbkIsc0NBQ0UsU0FBK0IsRUFDL0IsV0FBK0I7SUFFL0IsTUFBTSxPQUFPLHFCQUNSLHdCQUFjLEVBQ2QsV0FBVyxDQUNmLENBQUE7SUFFRCxNQUFNLE9BQU8sR0FBb0MsQ0FBQyxDQUFDLFNBQVMsQ0FBQztTQUMxRCxPQUFPLENBQUMsYUFBYSxDQUFDO1NBQ3RCLFNBQVMsQ0FBQyxRQUFRLENBQUMsRUFBRTtRQUNwQixNQUFNLE1BQU0sR0FBRyxRQUFRLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBa0IsQ0FBQTtRQUM3QyxNQUFNLEtBQUssR0FBRyxRQUFRLENBQUMsTUFBTSxDQUFDLHFCQUFxQixDQUFDLE1BQU0sRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFBO1FBRXZFLE1BQU0sVUFBVSxHQUFHLENBQUMsQ0FBQyxLQUFLLENBQUM7YUFDeEIsT0FBTyxDQUFDLGNBQWMsQ0FBQzthQUN2QixTQUFTLENBQUMsQ0FBQyxTQUFTLEVBQUUsT0FBTyxFQUFFLEVBQUU7WUFDaEMsTUFBTSxNQUFNLEdBQUcsZUFBZSxDQUFDLFNBQVMsRUFBRSxPQUFPLENBQUMsQ0FBQTtZQUNsRCxNQUFNLENBQUMsZUFBZSxDQUFDLE1BQU0sRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFBO1FBQzFELENBQUMsQ0FBQzthQUNELEtBQUssRUFBRSxDQUFBO1FBRVYsTUFBTSxnQkFBZ0IsR0FBRztZQUN2QixVQUFVO1lBQ1YsUUFBUSxFQUFFLG9CQUFvQixDQUFDLE1BQU0sRUFBRSxLQUFLLEVBQUUsT0FBTyxDQUFDO1lBQ3RELElBQUksRUFBRSxRQUFRO1NBQ2YsQ0FBQTtRQUVELE1BQU0sQ0FBQyxlQUFlLENBQUMsZ0JBQWdCLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUE7SUFDeEUsQ0FBQyxDQUFDO1NBQ0QsS0FBSyxFQUFFLENBQUE7SUFFVixNQUFNLENBQUMsT0FBTyxDQUFBO0FBQ2hCLENBQUM7QUFsQ0Qsb0VBa0NDO0FBV0QsK0JBQ0UsTUFBZ0IsRUFDaEIsU0FBK0I7SUFFL0IsTUFBTSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQ3JCLENBQUMsQ0FBQyxFQUFFLENBQ0YsQ0FBQyxDQUFDLE1BQU0sWUFBWSxRQUFRO1FBQzVCLE1BQU0sQ0FBQyxTQUFTLFlBQVksQ0FBQyxDQUFDLE1BQU07UUFDcEMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRTtZQUNqQixZQUFZLEVBQUUsQ0FBQyxDQUFDLFlBQVk7WUFDNUIsTUFBTTtZQUNOLElBQUksRUFBRSxDQUFDLENBQUMsSUFBSTtTQUNiLENBQUMsQ0FDTCxDQUFBO0FBQ0gsQ0FBQztBQUtELHlCQUNFLGlCQUF1QyxFQUN2QyxPQUFpQjtJQUVqQixNQUFNLFVBQVUscUJBQVEscUNBQWlCLEVBQUssT0FBTyxDQUFDLG9CQUFvQixDQUFFLENBQUE7SUFDNUUsTUFBTSxPQUFPLEdBQUcsQ0FBQyxJQUF3QixFQUFFLEVBQUU7UUFDM0MsTUFBTSxTQUFTLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQTtRQUN2QyxFQUFFLENBQUMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUM7WUFDZixLQUFLLENBQUMsbURBQW1ELEVBQUUsSUFBSSxDQUFDLENBQUE7WUFDaEUsTUFBTSxDQUFDLEVBQUUsQ0FBQTtRQUNYLENBQUM7UUFFRCxNQUFNLEtBQUssR0FBRyxDQUFDLENBQUMsVUFBVSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsSUFBSSxFQUFFLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUE7UUFDNUUsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxPQUFPLEVBQUUsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFBO0lBQ3JELENBQUMsQ0FBQTtJQUdELE1BQU0sQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLEVBQUUsRUFBRSxHQUFHLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFBO0FBQ3ZELENBQUM7QUFNRCx5QkFDRSxNQUFvQixFQUNwQixNQUFnQixFQUNoQixPQUFpQixFQUNqQixZQUFvQjtJQUVwQixNQUFNLGdCQUFnQixHQUFHLDhCQUFpQixDQUFDLE1BQU0sQ0FBQyxTQUFTLEVBQUUsWUFBWSxDQUFDLENBQUE7SUFDMUUsTUFBTSxDQUFDLENBQUMsQ0FBQyxVQUFVLENBQUMsZ0JBQWdCLENBQUM7UUFDbkMsQ0FBQyxDQUFDLGdCQUFnQixDQUFDLE1BQU0sRUFBRSxPQUFPLENBQUM7UUFDbkMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsRUFBRSxFQUFFLE1BQU0sRUFBRSxnQkFBZ0IsQ0FBQyxDQUFBO0FBQzNDLENBQUM7QUFRRCw4QkFDRSxNQUFnQixFQUNoQixTQUErQixFQUMvQixPQUFpQjtJQUVqQixtQkFBbUIsS0FBMkI7UUFDNUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLEVBQUUsSUFBSSxFQUFFLGlDQUFlLENBQUMsVUFBVSxFQUFFLENBQUMsQ0FBQTtJQUM1RCxDQUFDO0lBQ0Qsb0JBQW9CLEtBQTJCO1FBQzdDLE1BQU0sQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLEVBQUUsSUFBSSxFQUFFLEVBQUUsRUFBRSxDQUNoQyxDQUFDLENBQUMsUUFBUSxDQUNSLENBQUMsaUNBQWUsQ0FBQyxzQkFBc0IsRUFBRSxpQ0FBZSxDQUFDLFFBQVEsQ0FBQyxFQUNsRSxJQUFJLENBQ0wsQ0FDRixDQUFBO0lBQ0gsQ0FBQztJQUVELE1BQU0sQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDO1NBQ2hCLE9BQU8sQ0FBQyxjQUFjLENBQUM7U0FDdkIsTUFBTSxDQUFDLEtBQUssQ0FBQyxFQUFFO1FBQ2QsTUFBTSxDQUFDLEdBQUcsRUFBRSxTQUFTLENBQUMsR0FBRyxDQUFDLENBQUMsU0FBUyxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxNQUFNLEtBQUssTUFBTSxDQUFDLENBQUE7UUFDckUsTUFBTSxDQUFDLE9BQU8sQ0FBQyxxQkFBcUI7WUFDbEMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxJQUFJLFNBQVMsQ0FBQyxTQUFTLENBQUMsQ0FBQztZQUM5RCxDQUFDLENBQUMsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsSUFBSSxVQUFVLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQTtJQUNqRCxDQUFDLENBQUM7U0FDRCxJQUFJLEVBQUU7U0FDTixLQUFLLEVBQUUsQ0FBQTtBQUNaLENBQUMifQ==

CHANGELOG.md

@@ -9,2 +9,6 @@ # Changelog
 
+## [1.1.2] - 2018-08-19
+### Fixed
+- Add missing handling for [inherited validation decorators](https://github.com/typestack/class-validator#inheriting-validation-decorators) [#3](https://github.com/epiphone/class-validator-jsonschema/pull/3)
+
 ## [1.1.1] - 2018-03-14
@@ -11,0 +15,0 @@ ### Fixed

package.json

 {
   "name": "class-validator-jsonschema",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Convert class-validator-decorated classes into JSON schema",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -184,2 +184,6 @@ # class-validator-jsonschema
 
+`JSONSchema` decorators also flow down from parent classes into [inherited validation decorators](https://github.com/typestack/class-validator#inheriting-validation-decorators). Note though that if the inherited class uses `JSONSchema` to redecorate a property from the parent class, the parent class `JSONSchema` gets overwritten - i.e. there's no merging logic.
+
+#### Custom handlers
+
 Alternatively `JSONSchema` can take a function of type `(existingSchema: SchemaObject, options: IOptions) => SchemaObject`. The return value of this function is then **not** automatically merged into existing schema (i.e. the one derived from `class-validator` decorators). Instead you can handle merging yourself in whichever way is preferred, the idea being that removal of existing keywords and other more complex overwrite scenarios can be implemented here.
@@ -186,0 +190,0 @@

src/decorators.ts

@@ -0,1 +1,2 @@
+// tslint:disable:ban-types
 import { SchemaObject } from 'openapi3-ts'
@@ -27,4 +28,8 @@ import 'reflect-metadata'
 export function JSONSchema(schema: DecoratorSchema) {
-  return (target: object, key?: string) => {
-    setMetadataSchema(schema, target, key)
+  return (target: object | Function, key?: string) => {
+    if (key) {
+      setMetadataSchema(schema, target.constructor, key) // Property metadata
+    } else {
+      setMetadataSchema(schema, target, (target as Function).name) // Class metadata
+    }
   }
@@ -37,9 +42,6 @@ }
 export function getMetadataSchema(
-  target: object,
-  key?: string
+  target: object | Function,
+  key: string
 ): DecoratorSchema {
-  const schema = key
-    ? Reflect.getMetadata(SCHEMA_KEY, target.constructor, key)
-    : Reflect.getMetadata(SCHEMA_KEY, target.constructor)
-  return schema || {}
+  return Reflect.getMetadata(SCHEMA_KEY, target.constructor, key) || {}
 }
@@ -52,8 +54,6 @@
   value: DecoratorSchema,
-  target: object,
-  key?: string
+  target: object | Function,
+  key: string
 ) {
-  return key
-    ? Reflect.defineMetadata(SCHEMA_KEY, value, target.constructor, key)
-    : Reflect.defineMetadata(SCHEMA_KEY, value, target.constructor)
+  return Reflect.defineMetadata(SCHEMA_KEY, value, target, key)
 }

src/index.ts

@@ -29,5 +29,7 @@ // tslint:disable:no-submodule-imports ban-types
     .groupBy('target.name')
-    .mapValues(schemaMetas => {
-      const target = schemaMetas[0].target as Function
-      const properties = _(schemaMetas)
+    .mapValues(ownMetas => {
+      const target = ownMetas[0].target as Function
+      const metas = ownMetas.concat(getInheritedMetadatas(target, metadatas))
+
+      const properties = _(metas)
         .groupBy('propertyName')
@@ -42,7 +44,7 @@ .mapValues((propMetas, propKey) => {
         properties,
-        required: getRequiredPropNames(schemaMetas, options),
+        required: getRequiredPropNames(target, metas, options),
         type: 'object'
       }
 
-      return applyDecorators(definitionSchema, target.constructor, options)
+      return applyDecorators(definitionSchema, target, options, target.name)
     })
@@ -55,2 +57,27 @@ .value()
 /**
+ * Return target class' inherited validation metadatas, with original metadatas
+ * given precedence over inherited ones in case of duplicates.
+ *
+ * Adapted from `class-validator` source.
+ *
+ * @param target Target child class.
+ * @param metadatas All class-validator metadata objects.
+ */
+function getInheritedMetadatas(
+  target: Function,
+  metadatas: ValidationMetadata[]
+) {
+  return metadatas.filter(
+    d =>
+      d.target instanceof Function &&
+      target.prototype instanceof d.target &&
+      !_.find(metadatas, {
+        propertyName: d.propertyName,
+        target,
+        type: d.type
+      })
+  )
+}
+
+/**
  * Convert a property's class-validator metadata into a JSON Schema property.
@@ -86,3 +113,3 @@ */
   options: IOptions,
-  propertyName?: string
+  propertyName: string
 ): SchemaObject {
@@ -97,18 +124,30 @@ const additionalSchema = getMetadataSchema(target.prototype, propertyName)
  * Get the required property names of a validated class.
+ * @param target Validation target class.
  * @param metadatas Validation metadata objects of the validated class.
+ * @param options Global class-validator options.
  */
 function getRequiredPropNames(
+  target: Function,
   metadatas: ValidationMetadata[],
   options: IOptions
 ) {
-  const optionalValidators = [
-    ValidationTypes.CONDITIONAL_VALIDATION,
-    ValidationTypes.IS_EMPTY
-  ]
+  function isDefined(metas: ValidationMetadata[]) {
+    return _.some(metas, { type: ValidationTypes.IS_DEFINED })
+  }
+  function isOptional(metas: ValidationMetadata[]) {
+    return _.some(metas, ({ type }) =>
+      _.includes(
+        [ValidationTypes.CONDITIONAL_VALIDATION, ValidationTypes.IS_EMPTY],
+        type
+      )
+    )
+  }
+
   return _(metadatas)
     .groupBy('propertyName')
-    .pickBy(d => {
+    .pickBy(metas => {
+      const [own, inherited] = _.partition(metas, d => d.target === target)
       return options.skipMissingProperties
-        ? _.some(d, { type: ValidationTypes.IS_DEFINED })
-        : !_.some(d, ({ type }) => _.includes(optionalValidators, type))
+        ? isDefined(own) || (!isOptional(own) && isDefined(inherited))
+        : !(isOptional(own) || isOptional(inherited))
     })
@@ -115,0 +154,0 @@ .keys()

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

189321

increased by3.41%

Number of package files

28

increased by3.7%

Lines of code

1939

increased by9.98%

Number of lines in readme file

216

increased by1.89%

No dependency changes