@trayio/commons 4.37.0 → 4.39.0

package/dist/dynamicschema/DynamicSchema.d.ts

@@ -10,6 +10,8 @@ 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>, coerce?: boolean) => E.Either<Error, DynamicObject>;
+    fromValue: (value: DynamicObject, schemaUrl: O.Option<string>) => DynamicObject;
+    isValidJsonSchema: (schema: DynamicObject) => boolean;
 }
 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;AA4BpC,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,EAC1B,MAAM,CAAC,EAAE,OAAO,KACZ,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;CACpC;AAED,eAAO,MAAM,aAAa,EAAE,sBAwC3B,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;AA+BpC,QAAA,MAAM,2BAA2B,6EAKhC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,2BAA2B,CAAC,CAAC;AA0FzE,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,EAC1B,MAAM,CAAC,EAAE,OAAO,KACZ,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IACpC,SAAS,EAAE,CACV,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KACvB,aAAa,CAAC;IACnB,iBAAiB,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC;CACtD;AAED,eAAO,MAAM,aAAa,EAAE,sBAgD3B,CAAC"}

package/dist/dynamicschema/DynamicSchema.js

@@ -32,11 +32,13 @@ const ajv_formats_1 = __importDefault(require("ajv-formats"));
 const E = __importStar(require("fp-ts/Either"));
 const O = __importStar(require("fp-ts/Option"));
 const t = __importStar(require("io-ts"));
-const function_1 = require("fp-ts/function");
+const function_1 = require("fp-ts/lib/function");
 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 draft04SchemaUrl = 'http://json-schema.org/draft-04/schema';
+const schemaProperty = '$schema';
 const ajv = new ajv_draft_04_1.default({ strict: false, removeAdditional: 'all' });
 /*
     We define additional formats for the JSON schema
@@ -92,6 +94,44 @@ const preprocessSchema = (schema, strict) => {
         preprocessSchema(schema.items, strict);
     }
 };
+const createSchema = (value) => {
+    if (Array.isArray(value) && value.length > 0) {
+        return {
+            type: 'array',
+            items: createSchema(value[0]),
+        };
+    }
+    if (typeof value === 'object' && value !== null) {
+        const properties = {};
+        for (const [key, val] of Object.entries(value)) {
+            properties[key] = createSchema(val);
+        }
+        return {
+            type: 'object',
+            properties,
+            required: Object.keys(properties),
+        };
+    }
+    if (value === null) {
+        return { type: 'null' };
+    }
+    if (typeof value === 'boolean') {
+        return { type: 'boolean' };
+    }
+    if (typeof value === 'number') {
+        return { type: 'number' };
+    }
+    if (typeof value === 'string') {
+        return { type: 'string' };
+    }
+    return {};
+};
+const createSchemaWithSchemaUrl = (schema, schemaUrl) => {
+    const hasSchemaUrl = O.isSome(schemaUrl);
+    const schemaObj = createSchema(schema);
+    schemaObj[schemaProperty] = hasSchemaUrl ? schemaUrl.value : draft04SchemaUrl;
+    return schemaObj;
+};
 exports.DynamicSchema = {
     fromDynamicObject: (schema, strict = O.none) => {
         const copiedSchema = (0, deep_copy_ts_1.deepCopy)(schema);
@@ -118,4 +158,6 @@ exports.DynamicSchema = {
             return E.left(new Error(errorText));
         }));
     },
+    fromValue: (value, schemaUrl = O.none) => createSchemaWithSchemaUrl(value, schemaUrl),
+    isValidJsonSchema: (schema) => isDynamicSchema(schema),
 };

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

@@ -30,6 +30,7 @@ describe('DynamicSchema', () => {
     let validSchema;
     let invalidSchema;
     let value;
+    let validSchemaWithoutExtraFields;
     let valueWithExtraFields;
     let valueWithCoerceableTypes;
     let invalidValue;
@@ -67,6 +68,40 @@ describe('DynamicSchema', () => {
             required: ['name', 'age', 'races'],
             advanced: [], // not part of json schema but the validator should not be strict with extra elements
         };
+        validSchemaWithoutExtraFields = {
+            type: 'object',
+            properties: {
+                name: {
+                    type: 'string',
+                },
+                age: {
+                    type: 'number',
+                },
+                races: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            name: {
+                                type: 'string',
+                            },
+                            car: {
+                                type: 'object',
+                                properties: {
+                                    model: {
+                                        type: 'string',
+                                    },
+                                },
+                                required: ['model'],
+                            },
+                        },
+                        required: ['name', 'car'],
+                    },
+                },
+            },
+            required: ['name', 'age', 'races'],
+            $schema: 'http://json-schema.org/draft-04/schema',
+        };
         invalidSchema = {
             type: 'invalidType',
             properties: {
@@ -574,4 +609,15 @@ describe('DynamicSchema', () => {
             }
         });
     });
+    describe('fromValue', () => {
+        it('should return a Right with the schema when given a valid value object', () => {
+            const result = DynamicSchema_1.DynamicSchema.fromValue(value, O.none);
+            expect(result).toEqual(validSchemaWithoutExtraFields);
+        });
+        it('should return a Right with the schema when given a valid value object and a schema url', () => {
+            const schemaUrl = 'http://json-schema.org/draft-04/schema#';
+            const result = DynamicSchema_1.DynamicSchema.fromValue(value, O.some(schemaUrl));
+            expect(result.$schema).toEqual(schemaUrl);
+        });
+    });
 });

package/package.json

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