@trayio/commons 4.5.0 → 4.7.0

package/dist/dynamicschema/DynamicSchema.d.ts

@@ -4,13 +4,12 @@ import * as t from 'io-ts';
 import { DynamicObject } from '../dynamictype/DynamicType';
 declare const dynamicSchemaTypeDescriptor: t.BrandC<t.Type<DynamicObject, DynamicObject, unknown>, DynamicSchemaBrand>;
 export type DynamicSchema = t.TypeOf<typeof dynamicSchemaTypeDescriptor>;
-export declare const recursivelyRemoveEmptyRequiredAndAddAdditionalProperties: (schema: DynamicObject, strict: O.Option<boolean>) => void;
 export interface DynamicSchemaBrand {
     readonly DynamicSchema: unique symbol;
 }
 export interface DynamicSchemaInterface {
-    fromDynamicObject: (schemaObj: DynamicObject) => E.Either<Error, DynamicSchema>;
-    validate: (schema: DynamicSchema | DynamicObject, value: DynamicObject, strict: O.Option<boolean>) => E.Either<Error, undefined>;
+    fromDynamicObject: (schema: DynamicObject, strict?: O.Option<boolean>) => E.Either<Error, DynamicSchema>;
+    validate: (schema: DynamicSchema | DynamicObject, value: DynamicObject, strict?: O.Option<boolean>) => E.Either<Error, DynamicObject>;
 }
 export declare const DynamicSchema: DynamicSchemaInterface;
 export {};

package/dist/dynamicschema/DynamicSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DynamicSchema.d.ts","sourceRoot":"","sources":["../../src/dynamicschema/DynamicSchema.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAG3B,OAAO,EACN,aAAa,EAEb,MAAM,4BAA4B,CAAC;AAqBpC,QAAA,MAAM,2BAA2B,6EAKhC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAMzE,eAAO,MAAM,wDAAwD,WAC5D,aAAa,UACb,EAAE,MAAM,CAAC,OAAO,CAAC,SA4CzB,CAAC;AAEF,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,aAAa,EAAE,OAAO,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACtC,iBAAiB,EAAE,CAClB,SAAS,EAAE,aAAa,KACpB,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IACpC,QAAQ,EAAE,CACT,MAAM,EAAE,aAAa,GAAG,aAAa,EACrC,KAAK,EAAE,aAAa,EACpB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KACrB,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;CAChC;AAED,eAAO,MAAM,aAAa,EAAE,sBA6B3B,CAAC"}
+{"version":3,"file":"DynamicSchema.d.ts","sourceRoot":"","sources":["../../src/dynamicschema/DynamicSchema.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAG3B,OAAO,EACN,aAAa,EAEb,MAAM,4BAA4B,CAAC;AAqBpC,QAAA,MAAM,2BAA2B,6EAKhC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,2BAA2B,CAAC,CAAC;AA4CzE,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,aAAa,EAAE,OAAO,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACtC,iBAAiB,EAAE,CAClB,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KACtB,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IACpC,QAAQ,EAAE,CACT,MAAM,EAAE,aAAa,GAAG,aAAa,EACrC,KAAK,EAAE,aAAa,EACpB,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KACtB,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;CACpC;AAED,eAAO,MAAM,aAAa,EAAE,sBA+B3B,CAAC"}

package/dist/dynamicschema/DynamicSchema.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DynamicSchema = exports.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties = void 0;
+exports.DynamicSchema = void 0;
 const ajv_draft_04_1 = __importDefault(require("ajv-draft-04"));
 const ajv_formats_1 = __importDefault(require("ajv-formats"));
 const E = __importStar(require("fp-ts/Either"));
@@ -37,7 +37,7 @@ const deep_copy_ts_1 = require("deep-copy-ts");
 const DynamicType_1 = require("../dynamictype/DynamicType");
 const TypeCodec_1 = require("../codec/TypeCodec");
 const Try_1 = require("../try/Try");
-const ajv = new ajv_draft_04_1.default({ strict: false });
+const ajv = new ajv_draft_04_1.default({ strict: false, removeAdditional: 'all' });
 /*
     We define additional formats for the JSON schema
     See: https://ajv.js.org/packages/ajv-formats.html#formats
@@ -54,14 +54,15 @@ const isDynamicSchema = (o) => {
 };
 const dynamicSchemaTypeDescriptor = t.brand(DynamicType_1.dynamicObjectTypeDescriptor, (input) => isDynamicSchema(input), 'DynamicSchema');
 const dynamicSchemaTypeCodec = TypeCodec_1.TypeCodec.fromDescriptor(dynamicSchemaTypeDescriptor);
-const recursivelyRemoveEmptyRequiredAndAddAdditionalProperties = (schema, strict) => {
+const preprocessSchema = (schema, strict) => {
     const hasStrict = O.isSome(strict);
+    delete schema.$schema;
     if (schema.oneOf || schema.anyOf || schema.allOf) {
         const schemas = (schema.oneOf ||
             schema.anyOf ||
             schema.allOf);
         schemas.forEach((subSchema) => {
-            (0, exports.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(subSchema, strict);
+            preprocessSchema(subSchema, strict);
         });
     }
     if (schema.properties) {
@@ -77,24 +78,28 @@ const recursivelyRemoveEmptyRequiredAndAddAdditionalProperties = (schema, strict
         Object.keys(properties).forEach((key) => {
             const property = properties[key];
             if (property.type === 'object' || property.type === 'array') {
-                (0, exports.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(property, strict);
+                preprocessSchema(property, strict);
             }
         });
     }
     if (schema.type === 'array') {
-        (0, exports.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema.items, strict);
+        preprocessSchema(schema.items, strict);
     }
 };
-exports.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties = recursivelyRemoveEmptyRequiredAndAddAdditionalProperties;
 exports.DynamicSchema = {
-    fromDynamicObject: (schemaObj) => (0, function_1.pipe)(dynamicSchemaTypeCodec.decode(schemaObj), E.mapLeft((e) => new Error(`Failed to create DynamicSchema: ${e}`))),
-    validate: (schema, value, strict) => {
+    fromDynamicObject: (schema, strict = O.none) => {
         const copiedSchema = (0, deep_copy_ts_1.deepCopy)(schema);
-        (0, exports.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(copiedSchema, strict);
+        preprocessSchema(copiedSchema, strict);
+        return (0, function_1.pipe)(dynamicSchemaTypeCodec.decode(copiedSchema), E.mapLeft((e) => new Error(`Failed to create DynamicSchema: ${e}`)));
+    },
+    validate: (schema, value, strict = O.none) => {
+        const copiedSchema = (0, deep_copy_ts_1.deepCopy)(schema);
+        preprocessSchema(copiedSchema, strict);
+        const copiedValue = (0, deep_copy_ts_1.deepCopy)(value);
         const validateE = (0, Try_1.tryToEither)(() => ajv.compile(copiedSchema));
         return (0, function_1.pipe)(validateE, E.chain((validate) => {
-            if (validate(value)) {
-                return E.right(undefined);
+            if (validate(copiedValue)) {
+                return E.right(copiedValue);
             }
             return E.left(new Error(ajv.errorsText(validate.errors)));
         }));

package/dist/dynamicschema/DynamicSchema.unit.test.js

@@ -30,6 +30,7 @@ describe('DynamicSchema', () => {
     let validSchema;
     let invalidSchema;
     let value;
+    let valueWithExtraFields;
     beforeEach(() => {
         validSchema = {
             type: 'object',
@@ -40,8 +41,27 @@ describe('DynamicSchema', () => {
                 age: {
                     type: 'number',
                 },
+                races: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            name: {
+                                type: 'string',
+                            },
+                            car: {
+                                type: 'object',
+                                properties: {
+                                    model: {
+                                        type: 'string',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
             },
-            required: ['name', 'age'],
+            required: ['name', 'age', 'races'],
             advanced: [], // not part of json schema but the validator should not be strict with extra elements
         };
         invalidSchema = {
@@ -59,12 +79,34 @@ describe('DynamicSchema', () => {
         value = {
             name: 'John Doe',
             age: 30,
+            races: [
+                {
+                    name: 'monza',
+                    car: {
+                        model: 'ferrari',
+                    },
+                },
+            ],
+        };
+        valueWithExtraFields = {
+            name: 'John Doe',
+            age: 30,
+            extra: 'field',
+            races: [
+                {
+                    name: 'monza',
+                    country: 'italy',
+                    car: {
+                        model: 'ferrari',
+                        year: 2017,
+                    },
+                },
+            ],
         };
     });
     describe('fromDynamicObject', () => {
         it('should return a Right DynamicSchema when given a valid schema object', () => {
             const result = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
-            console.log(JSON.stringify(result));
             expect(E.isRight(result)).toBe(true);
             if (E.isRight(result)) {
                 expect(result.right).toEqual(validSchema);
@@ -78,40 +120,35 @@ describe('DynamicSchema', () => {
                 expect(result.left.message).toContain('Failed to create DynamicSchema:');
             }
         });
-    });
-    describe('validate', () => {
-        it('should return a Right undefined when the value matches the schema', () => {
-            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
-            if (E.isRight(schema)) {
-                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, value, O.none);
-                expect(E.isRight(result)).toBe(true);
-                if (E.isRight(result)) {
-                    expect(result.right).toBeUndefined();
-                }
-            }
-        });
-        it('should return a Right undefined when strict is false and value matches the schema', () => {
-            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
-            if (E.isRight(schema)) {
-                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, value, O.some(false));
-                expect(E.isRight(result)).toBe(true);
-                if (E.isRight(result)) {
-                    expect(result.right).toBeUndefined();
-                }
-            }
-        });
-        it('should return a Left Error when the value does not match the schema', () => {
-            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
-            if (E.isRight(schema)) {
-                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, invalidSchema, O.none);
-                expect(E.isLeft(result)).toBe(true);
-                if (E.isLeft(result)) {
-                    expect(result.left).toBeInstanceOf(Error);
-                }
-            }
+        it('should remove empty $schema property', () => {
+            const schema = {
+                type: 'object',
+                properties: {
+                    name: {
+                        type: 'string',
+                    },
+                    age: {
+                        type: 'number',
+                    },
+                },
+                advanced: [],
+                $schema: 'http://json-schema.org/draft-07/schema#',
+            };
+            const expectedSchema = {
+                type: 'object',
+                properties: {
+                    name: {
+                        type: 'string',
+                    },
+                    age: {
+                        type: 'number',
+                    },
+                },
+                advanced: [],
+            };
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.none);
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
         });
-    });
-    describe('recursivelyRemoveEmptyRequiredAndAddAdditionalProperties', () => {
         it('should correctly remove empty required arrays and not add additionalProperties when strict is not set', () => {
             const schema = {
                 type: 'object',
@@ -138,8 +175,8 @@ describe('DynamicSchema', () => {
                 },
                 advanced: [],
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.none);
-            expect(schema).toEqual(expectedSchema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.none);
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
         });
         it('should correctly keep populated required arrays and not add additionalProperties when strict is not set', () => {
             const schema = {
@@ -168,8 +205,8 @@ describe('DynamicSchema', () => {
                 required: ['age', 'name'],
                 advanced: [],
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.none);
-            expect(schema).toEqual(expectedSchema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.none);
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
         });
         it('should correctly remove empty required and add additionalProperties=true to object schema when strict is set', () => {
             const schema = {
@@ -198,8 +235,8 @@ describe('DynamicSchema', () => {
                 advanced: [],
                 additionalProperties: true,
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.some(false));
-            expect(schema).toEqual(expectedSchema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.some(false));
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
         });
         it('should correctly add additionalProperties=false to object schema', () => {
             const schema = validSchema;
@@ -212,13 +249,34 @@ describe('DynamicSchema', () => {
                     age: {
                         type: 'number',
                     },
+                    races: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            additionalProperties: false,
+                            properties: {
+                                name: {
+                                    type: 'string',
+                                },
+                                car: {
+                                    type: 'object',
+                                    additionalProperties: false,
+                                    properties: {
+                                        model: {
+                                            type: 'string',
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
                 },
-                required: ['name', 'age'],
+                required: ['name', 'age', 'races'],
                 advanced: [],
                 additionalProperties: false,
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.some(true));
-            expect(schema).toEqual(expectedSchema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.some(true));
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
         });
         it('should correctly add additionalProperties=true to complex object schema', () => {
             const schema = {
@@ -284,15 +342,15 @@ describe('DynamicSchema', () => {
                 },
                 additionalProperties: true,
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.some(false));
-            expect(schema).toEqual(expectedSchema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.some(false));
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
         });
         it('should skip mutation if there is no object type schema', () => {
             const schema = {
                 type: 'string',
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.some(true));
-            expect(schema).toEqual(schema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.some(true));
+            expect(actualSchemaE).toEqual(E.right(schema));
         });
         it('should correctly add additionalProperties=true to oneOf schemas', () => {
             const schema = {
@@ -339,8 +397,8 @@ describe('DynamicSchema', () => {
                     },
                 ],
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.some(false));
-            expect(schema).toEqual(expectedSchema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.some(false));
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
         });
         it('should correctly add additionalProperties=true to anyOf schemas', () => {
             const schema = {
@@ -387,8 +445,8 @@ describe('DynamicSchema', () => {
                     },
                 ],
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.some(false));
-            expect(schema).toEqual(expectedSchema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.some(false));
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
         });
         it('should correctly add additionalProperties=true to allOf schemas', () => {
             const schema = {
@@ -435,8 +493,50 @@ describe('DynamicSchema', () => {
                     },
                 ],
             };
-            (0, DynamicSchema_1.recursivelyRemoveEmptyRequiredAndAddAdditionalProperties)(schema, O.some(false));
-            expect(schema).toEqual(expectedSchema);
+            const actualSchemaE = DynamicSchema_1.DynamicSchema.fromDynamicObject(schema, O.some(false));
+            expect(actualSchemaE).toEqual(E.right(expectedSchema));
+        });
+    });
+    describe('validate', () => {
+        it('should return a Right with the value when the value matches the schema', () => {
+            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
+            if (E.isRight(schema)) {
+                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, value, O.none);
+                expect(E.isRight(result)).toBe(true);
+                if (E.isRight(result)) {
+                    expect(result.right).toEqual(value);
+                }
+            }
+        });
+        it('should return a Right with the value when strict is false and value matches the schema', () => {
+            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
+            if (E.isRight(schema)) {
+                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, value, O.some(false));
+                expect(E.isRight(result)).toBe(true);
+                if (E.isRight(result)) {
+                    expect(result.right).toEqual(value);
+                }
+            }
+        });
+        it('should return a Right with non extra values when value matches the schema but has extra fields', () => {
+            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
+            if (E.isRight(schema)) {
+                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, valueWithExtraFields, O.some(false));
+                expect(E.isRight(result)).toBe(true);
+                if (E.isRight(result)) {
+                    expect(result.right).toEqual(value);
+                }
+            }
+        });
+        it('should return a Left Error when the value does not match the schema', () => {
+            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
+            if (E.isRight(schema)) {
+                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, invalidSchema, O.none);
+                expect(E.isLeft(result)).toBe(true);
+                if (E.isLeft(result)) {
+                    expect(result.left).toBeInstanceOf(Error);
+                }
+            }
         });
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/commons",
-  "version": "4.5.0",
+  "version": "4.7.0",
   "description": "Extensions to the standard/core libraries and basic features",
   "exports": {
     "./*": "./dist/*.js"