@dev-crew-berlin/enter-js-utils 0.1.6 → 0.2.1

package/dist/index.d.ts

@@ -1 +1 @@
-export declare function helloWord(): string;
+export * as result from './result/result.js';

package/dist/index.js

@@ -1,8 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.helloWord = void 0;
-function helloWord() {
-    return 'hello world';
-}
-exports.helloWord = helloWord;
+export * as result from './result/result.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,SAAgB,SAAS;IACvB,OAAO,aAAa,CAAA;AACtB,CAAC;AAFD,8BAEC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAA"}

package/dist/result/result.d.ts

@@ -0,0 +1,33 @@
+export declare type Failure<Reason> = {
+    success: false;
+    error: Reason;
+};
+export declare type Success<Payload> = {
+    success: true;
+    data: Payload;
+};
+export declare type Result<Reason, Payload> = Failure<Reason> | Success<Payload>;
+export declare function success<Payload>(data: Payload): Success<Payload>;
+export declare function failure<Reason>(reason: Reason): Failure<Reason>;
+export declare function asSuccess<Payload>(result: Result<unknown, Payload>): Success<Payload> | undefined;
+export declare function asFailure<Reason>(result: Result<Reason, unknown>): Failure<Reason> | undefined;
+declare type UnwrapSuccess<T> = T extends Success<infer Payload> ? Payload : never;
+declare type UnwrapFailure<T> = T extends Failure<infer Reason> ? Reason : never;
+declare type UnwrapArray<T> = T extends (infer R)[] ? R : never;
+declare type MergedSuccesses<T> = {
+    [K in keyof T]: UnwrapSuccess<T[K]>;
+};
+/**
+ * Takes a list of Results and creates one single result out of it
+ *
+ * If all results are successfull a Success is retured.
+ * Then the data value is an array of all the data values of the original
+ * results in correct order.
+ *
+ * If a single result has a failure a Failure is retured.
+ * The error then is an array of all the original errors.
+ * @param results
+ * @returns
+ */
+export declare function combineResults<T extends Array<Result<any, any>> | [Result<any, any>]>(results: T): Result<UnwrapFailure<UnwrapArray<T>>[], MergedSuccesses<T>>;
+export {};

package/dist/result/result.js

@@ -0,0 +1,46 @@
+export function success(data) {
+    return { success: true, data: data };
+}
+export function failure(reason) {
+    return { success: false, error: reason };
+}
+export function asSuccess(result) {
+    if (!result.success)
+        return undefined;
+    return result;
+}
+export function asFailure(result) {
+    if (result.success)
+        return undefined;
+    return result;
+}
+/**
+ * Takes a list of Results and creates one single result out of it
+ *
+ * If all results are successfull a Success is retured.
+ * Then the data value is an array of all the data values of the original
+ * results in correct order.
+ *
+ * If a single result has a failure a Failure is retured.
+ * The error then is an array of all the original errors.
+ * @param results
+ * @returns
+ */
+export function combineResults(results) {
+    if (results.every(function (result) { return result.success; })) {
+        return {
+            success: true,
+            data: results.map(
+            // the if statement checks that every result is a success so we can force this here
+            function (success) { return asSuccess(success).data; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
+            ), // also the typechecker does not resolve this so we just tell him its fine and hope there are no errors
+        };
+    }
+    return {
+        success: false,
+        error: results
+            .map(function (result) { var _a; return (_a = asFailure(result)) === null || _a === void 0 ? void 0 : _a.error; })
+            .filter(function (failure) { return failure !== undefined; }), // the typechecker does not resolve this so we just tell him its fine and hope there are no errors
+    };
+}
+//# sourceMappingURL=result.js.map

package/dist/result/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../src/result/result.ts"],"names":[],"mappings":"AAIA,MAAM,UAAU,OAAO,CAAU,IAAa;IAC5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;AACtC,CAAC;AAED,MAAM,UAAU,OAAO,CAAS,MAAc;IAC5C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAA;AAC1C,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,MAAgC;IAEhC,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO,SAAS,CAAA;IACrC,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,MAA+B;IAE/B,IAAI,MAAM,CAAC,OAAO;QAAE,OAAO,SAAS,CAAA;IACpC,OAAO,MAAM,CAAA;AACf,CAAC;AASD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,cAAc,CAI5B,OAAU;IACV,IAAI,OAAO,CAAC,KAAK,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,OAAO,EAAd,CAAc,CAAC,EAAE;QAC7C,OAAO;YACL,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,OAAO,CAAC,GAAG;YACf,mFAAmF;YACnF,UAAC,OAAO,IAAK,OAAA,SAAS,CAAC,OAAO,CAAE,CAAC,IAAI,EAAxB,CAAwB,CAAC,+DAA+D;aACrE,EAAE,uGAAuG;SAC5I,CAAA;KACF;IAED,OAAO;QACL,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,OAAO;aACX,GAAG,CAAC,UAAC,MAAM,YAAK,OAAA,MAAA,SAAS,CAAC,MAAM,CAAC,0CAAE,KAAK,CAAA,EAAA,CAAC;aACzC,MAAM,CACL,UAAC,OAAO,IAAK,OAAA,OAAO,KAAK,SAAS,EAArB,CAAqB,CACH,EAAE,kGAAkG;KACxI,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dev-crew-berlin/enter-js-utils",
-  "version": "0.1.6",
+  "version": "0.2.1",
   "description": "utils such as vaildation and other helpers to work with data from the enter app",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,14 +29,14 @@
   },
   "homepage": "https://gitlab.com/dcb-enter/js-utils#readme",
   "devDependencies": {
-    "@types/node": "^16.4.7",
-    "@typescript-eslint/eslint-plugin": "^4.28.5",
-    "@typescript-eslint/parser": "^4.28.5",
-    "eslint": "^7.31.0",
-    "eslint-config-prettier": "^8.3.0",
+    "@types/node": "^17.0.38",
+    "eslint": "^8.16.0",
+    "eslint-config-prettier": "^8.5.0",
     "husky": "^7.0.1",
-    "lint-staged": "^11.1.1",
-    "prettier": "2.3.2",
-    "typescript": "^4.3.5"
+    "prettier": "^2.6.2",
+    "typescript": "^4.7.2"
+  },
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.27.0"
   }
 }