@trayio/commons 4.6.0 → 4.7.0

package/dist/dynamicschema/DynamicSchema.d.ts

@@ -9,7 +9,7 @@ export interface DynamicSchemaBrand {
 }
 export interface DynamicSchemaInterface {
     fromDynamicObject: (schema: DynamicObject, strict?: O.Option<boolean>) => E.Either<Error, DynamicSchema>;
-    validate: (schema: DynamicSchema | DynamicObject, value: DynamicObject, strict?: O.Option<boolean>) => E.Either<Error, undefined>;
+    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;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,SAAS,CAAC,CAAC;CAChC;AAED,eAAO,MAAM,aAAa,EAAE,sBA8B3B,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

@@ -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
@@ -95,10 +95,11 @@ exports.DynamicSchema = {
     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,6 +79,29 @@ 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', () => {
@@ -206,8 +249,29 @@ 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,
             };
@@ -434,23 +498,33 @@ describe('DynamicSchema', () => {
         });
     });
     describe('validate', () => {
-        it('should return a Right undefined when the value matches the schema', () => {
+        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).toBeUndefined();
+                    expect(result.right).toEqual(value);
                 }
             }
         });
-        it('should return a Right undefined when strict is false and value matches the schema', () => {
+        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).toBeUndefined();
+                    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);
                 }
             }
         });

package/package.json

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