@trayio/commons 4.36.1-unstable → 4.37.0

package/dist/codec/RemoveTopLevelTagCodec.d.ts

@@ -0,0 +1,16 @@
+import * as E from 'fp-ts/lib/Either';
+import { Codec } from './Codec';
+/**
+ * Codec that removes the _tag property from the top level of the object.
+ * We use this to expose RequestFailed on APIs as the _tag property is an implementation detail.
+ * Note that _tag in nested objects will not be removed. This is necessary to preserve union types.
+ */
+export declare class RemoveTopLevelTagCodec implements Codec<unknown> {
+    static instance: Codec<unknown>;
+    encode(value: unknown): unknown;
+    decode(value: unknown): E.Either<Error, unknown>;
+    private isObject;
+    private removeTopLevelTagIfPresent;
+    private removeNullFromObjectIfPresent;
+}
+//# sourceMappingURL=RemoveTopLevelTagCodec.d.ts.map

package/dist/codec/RemoveTopLevelTagCodec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemoveTopLevelTagCodec.d.ts","sourceRoot":"","sources":["../../src/codec/RemoveTopLevelTagCodec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;GAIG;AACH,qBAAa,sBAAuB,YAAW,KAAK,CAAC,OAAO,CAAC;IAC5D,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAgC;IAE/D,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAI/B,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC;IAIhD,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,6BAA6B;CAQrC"}

package/dist/codec/RemoveTopLevelTagCodec.js

@@ -0,0 +1,59 @@
+"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.RemoveTopLevelTagCodec = void 0;
+const E = __importStar(require("fp-ts/lib/Either"));
+/**
+ * Codec that removes the _tag property from the top level of the object.
+ * We use this to expose RequestFailed on APIs as the _tag property is an implementation detail.
+ * Note that _tag in nested objects will not be removed. This is necessary to preserve union types.
+ */
+class RemoveTopLevelTagCodec {
+    static instance = new RemoveTopLevelTagCodec();
+    encode(value) {
+        return this.removeTopLevelTagIfPresent(value);
+    }
+    decode(value) {
+        return E.right(this.removeTopLevelTagIfPresent(value));
+    }
+    isObject(value) {
+        return typeof value === 'object' && !Array.isArray(value) && value !== null;
+    }
+    removeTopLevelTagIfPresent(value) {
+        if (this.isObject(value)) {
+            return this.removeNullFromObjectIfPresent(value);
+        }
+        return value;
+    }
+    removeNullFromObjectIfPresent(value) {
+        return Object.entries(value).reduce((acc, [key, propertyValue]) => {
+            if (key === '_tag') {
+                return acc;
+            }
+            return { ...acc, [key]: propertyValue };
+        }, {});
+    }
+}
+exports.RemoveTopLevelTagCodec = RemoveTopLevelTagCodec;

package/dist/codec/RemoveTopLevelTagCodec.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RemoveTopLevelTagCodec.unit.test.d.ts.map

package/dist/codec/RemoveTopLevelTagCodec.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemoveTopLevelTagCodec.unit.test.d.ts","sourceRoot":"","sources":["../../src/codec/RemoveTopLevelTagCodec.unit.test.ts"],"names":[],"mappings":""}

package/dist/codec/RemoveTopLevelTagCodec.unit.test.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const RemoveTopLevelTagCodec_1 = require("./RemoveTopLevelTagCodec");
+const testRemoveTopLevelTagCodec = RemoveTopLevelTagCodec_1.RemoveTopLevelTagCodec.instance;
+describe('RemoveTopLevelTagCodec', () => {
+    test('should remove top level tag only', () => {
+        const value = {
+            _tag: 'SomeTag',
+            message: 'blue',
+            data: {
+                _tag: 'SomeOtherTag',
+                value: 'yellow',
+            },
+        };
+        const actualValue = testRemoveTopLevelTagCodec.encode(value);
+        const expectedValue = {
+            message: 'blue',
+            data: {
+                _tag: 'SomeOtherTag',
+                value: 'yellow',
+            },
+        };
+        expect(actualValue).toEqual(expectedValue);
+    });
+    test('should succeed if _tag property not present at top level', () => {
+        const value = {
+            message: 'blue',
+            data: {
+                _tag: 'SomeOtherTag',
+                value: 'yellow',
+            },
+        };
+        const actualValue = testRemoveTopLevelTagCodec.encode(value);
+        const expectedValue = {
+            message: 'blue',
+            data: {
+                _tag: 'SomeOtherTag',
+                value: 'yellow',
+            },
+        };
+        expect(actualValue).toEqual(expectedValue);
+    });
+});

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-unstable",
+  "version": "4.37.0",
   "description": "Extensions to the standard/core libraries and basic features",
   "exports": {
     "./*": "./dist/*.js"