@trayio/commons 4.36.1 → 4.38.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/dist/error/Error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/error/Error.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,KASvC,CAAC"}
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/error/Error.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,KAWvC,CAAC"}

package/dist/error/Error.js

@@ -8,6 +8,9 @@ const castError = (error) => {
     if (error instanceof Error) {
         return error;
     }
-    return new Error('Internal Error');
+    if (typeof error === 'object') {
+        return new Error(`Internal error: ${JSON.stringify(error)}`);
+    }
+    return new Error('Unknown internal error');
 };
 exports.castError = castError;

package/dist/task/Task.d.ts

@@ -1,7 +1,16 @@
-import { TaskEither } from 'fp-ts/TaskEither';
+import * as TE from 'fp-ts/TaskEither';
+import * as TSK from 'fp-ts/Task';
 import { Either } from 'fp-ts/lib/Either';
-export declare const createTaskEitherFromPromise: <E, T>(block: () => Promise<T>, errorHandling: (error: Error) => E) => TaskEither<E, T>;
-export declare const createTaskEither: <E, T>(block: () => Promise<Either<E, T>>) => TaskEither<E, T>;
-export declare const createTaskEitherFromEither: <E, T>(either: Either<E, T>) => TaskEither<E, T>;
-export declare const createTaskEitherFromPromiseWithSimpleError: <T>(block: () => Promise<T>) => TaskEither<Error, T>;
+export interface TaskExtensionsInterface {
+    recover: <T>(task: TSK.Task<T>, onError: (error: Error) => T) => TSK.Task<T>;
+}
+export declare const TaskExtensions: TaskExtensionsInterface;
+export interface TaskEitherExtensionsInterface {
+    fromPromiseWithSimpleError: <T>(block: () => Promise<T>) => TE.TaskEither<Error, T>;
+}
+export declare const TaskEitherExtensions: TaskEitherExtensionsInterface;
+export declare const createTaskEitherFromPromise: <E, T>(block: () => Promise<T>, errorHandling: (error: Error) => E) => TE.TaskEither<E, T>;
+export declare const createTaskEither: <E, T>(block: () => Promise<Either<E, T>>) => TE.TaskEither<E, T>;
+export declare const createTaskEitherFromEither: <E, T>(either: Either<E, T>) => TE.TaskEither<E, T>;
+export declare const createTaskEitherFromPromiseWithSimpleError: <T>(block: () => Promise<T>) => TE.TaskEither<Error, T>;
 //# sourceMappingURL=Task.d.ts.map

package/dist/task/Task.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../src/task/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAG1C,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,EAAE,CAAC,EAC9C,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACvB,aAAa,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,CAAC,KAC9B,UAAU,CAAC,CAAC,EAAE,CAAC,CACwC,CAAC;AAE7D,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,EAAE,CAAC,EACnC,KAAK,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAC9B,UAAU,CAAC,CAAC,EAAE,CAAC,CAAoB,CAAC;AAGzC,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,EAAE,CAAC,EAC7C,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAChB,UAAU,CAAC,CAAC,EAAE,CAAC,CAC4B,CAAC;AAEjD,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,EAC1D,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KACnB,UAAU,CAAC,KAAK,EAAE,CAAC,CACqB,CAAC"}
+{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../src/task/Task.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,GAAG,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAG1C,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC7E;AAED,eAAO,MAAM,cAAc,EAAE,uBAU5B,CAAC;AAEF,MAAM,WAAW,6BAA6B;IAC7C,0BAA0B,EAAE,CAAC,CAAC,EAC7B,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KACnB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;CAC7B;AAED,eAAO,MAAM,oBAAoB,EAAE,6BAIlC,CAAC;AAGF,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,EAAE,CAAC,EAC9C,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACvB,aAAa,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,CAAC,KAC9B,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CACwC,CAAC;AAGhE,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,EAAE,CAAC,EACnC,KAAK,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAC9B,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAoB,CAAC;AAG5C,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,EAAE,CAAC,EAC7C,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAChB,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CACyB,CAAC;AAGjD,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,EAC1D,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KACnB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,CACqB,CAAC"}

package/dist/task/Task.js

@@ -1,14 +1,53 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTaskEitherFromPromiseWithSimpleError = exports.createTaskEitherFromEither = exports.createTaskEither = exports.createTaskEitherFromPromise = void 0;
-const TaskEither_1 = require("fp-ts/TaskEither");
+exports.createTaskEitherFromPromiseWithSimpleError = exports.createTaskEitherFromEither = exports.createTaskEither = exports.createTaskEitherFromPromise = exports.TaskEitherExtensions = exports.TaskExtensions = void 0;
+const TE = __importStar(require("fp-ts/TaskEither"));
 const Error_1 = require("../error/Error");
-const createTaskEitherFromPromise = (block, errorHandling) => (0, TaskEither_1.tryCatch)(block, (error) => errorHandling((0, Error_1.castError)(error)));
+exports.TaskExtensions = {
+    recover: (task, onError) => async () => {
+        try {
+            return await task();
+        }
+        catch (error) {
+            return onError((0, Error_1.castError)(error));
+        }
+    },
+};
+exports.TaskEitherExtensions = {
+    fromPromiseWithSimpleError: (block) => TE.tryCatch(block, (error) => (0, Error_1.castError)(error)),
+};
+// TODO: Remove, use TE.tryCatch
+const createTaskEitherFromPromise = (block, errorHandling) => TE.tryCatch(block, (error) => errorHandling((0, Error_1.castError)(error)));
 exports.createTaskEitherFromPromise = createTaskEitherFromPromise;
+// TODO: Remove, use TE.tryCatch
 const createTaskEither = (block) => block;
 exports.createTaskEither = createTaskEither;
 // TODO: Remove, we can use TE.fromEither (double check that the other functions are necessary)
 const createTaskEitherFromEither = (either) => (0, exports.createTaskEither)(() => Promise.resolve(either));
 exports.createTaskEitherFromEither = createTaskEitherFromEither;
-const createTaskEitherFromPromiseWithSimpleError = (block) => (0, TaskEither_1.tryCatch)(block, (error) => (0, Error_1.castError)(error));
+// TODO: Remove, use the method on the interface
+const createTaskEitherFromPromiseWithSimpleError = (block) => TE.tryCatch(block, (error) => (0, Error_1.castError)(error));
 exports.createTaskEitherFromPromiseWithSimpleError = createTaskEitherFromPromiseWithSimpleError;

package/package.json

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