@effectionx/chain 0.1.0

package/README.md

@@ -0,0 +1,83 @@
+# Chain
+
+There are some use-cases for Promise for which there is not a 1:1 analogue in
+Effection. One of these is the "promise chaining" behavior of the `Promise`
+constructor itself using `then()`, `catch()`, and `finally()`.
+
+The chain package accomplishes this in a very similar way:
+
+```ts
+import { Chain } from "@effectionx/chain";
+
+await main(function* () {
+  let chain = new Chain<number>((resolve) => {
+    resolve(10);
+  });
+
+  let result = yield* chain.then(function* (value) {
+    return value * 2;
+  });
+
+  console.log(result); //=> 20;
+});
+```
+
+Another is to share a promise in multiple places. For example this async data
+call is used and re-used:
+
+```ts
+class Foo {
+  data: Promise<number>;
+
+  constructor() {
+    this.data = (async () => 5)();
+  }
+
+  async getData() {
+    return await this.data;
+  }
+}
+
+const foo = new Foo();
+console.log(await foo.getData());
+```
+
+This can be accomplished with Chain like so:
+
+```ts
+class Foo {
+  data: Promise<number>;
+
+  constructor() {
+    let operation = (function* () {
+      return 5;
+    })();
+    this.data = Chain.from(operation);
+  }
+
+  *getData() {
+    return yield* this.data;
+  }
+}
+
+const foo = new Foo();
+console.log(yield * foo.getData());
+```
+
+---
+
+```ts
+import { Chain } from "@effectionx/chain";
+
+await main(function* () {
+  let chain = new Chain<number>((resolve) => {
+    resolve(10);
+  });
+
+  let result = yield* chain.then(function* (value) {
+    return value * 2;
+  });
+
+  console.log(result); //=> 20;
+});
+```

package/esm/mod.d.ts

@@ -0,0 +1,58 @@
+import type { Operation, WithResolvers } from "effection";
+/**
+ * Resolve a Chain
+ */
+export type Resolve<T> = WithResolvers<T>["resolve"];
+/**
+ * Reject a chain
+ */
+export type Reject = WithResolvers<unknown>["reject"];
+/**
+ * Represent the eventual completion of an [Operation] in a fashion
+ * that mirrors the * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise}
+ * implementation
+ */
+export declare class Chain<T> implements From<T> {
+    private resolvers;
+    /**
+     * Create a chain from any operation.
+     */
+    static from: typeof from;
+    constructor(compute: (resolve: Resolve<T>, reject: Reject) => void);
+    then<B>(fn: (value: T) => Operation<B>): From<B>;
+    catch<B>(fn: (error: unknown | Error) => Operation<B>): From<T | B>;
+    finally(fn: () => Operation<void>): From<T>;
+    [Symbol.iterator](): ReturnType<From<T>[typeof Symbol.iterator]>;
+}
+export interface From<A> extends Operation<A> {
+    /**
+     * Create a new chain that will resolve to the current chain's value after
+     * applying `fn`;
+     *
+     * @param `fn` - is applied to the source operation's result to create the chained operation's result
+     *
+     * @returns a new {Chain} representing this application
+     */
+    then<B>(fn: (value: A) => Operation<B>): From<B>;
+    /**
+     * Create a new chain that will resolve to the original chain's
+     * value, or the result of `fn` in the event that the current chain
+     * rejects. applying `fn`;
+     *
+     * @param `fn` - applied when the current chain rejects and becomes the result of chain
+     *
+     * @returns a new {Chain} representing the potentially caught rejection
+     */
+    catch<B>(fn: (error: unknown | Error) => Operation<B>): From<A | B>;
+    /**
+     * Create a new {Chain} that behaves exactly like the original chain, except that operation specified with
+     * `fn` will run in all cases.
+     *
+     * @param `fn` - a function returning an operation that is always
+     *   evaluate just before the current chain yields its value.
+     */
+    finally(fn: () => Operation<void>): From<A>;
+}
+declare function from<T>(source: Operation<T>): From<T>;
+export {};
+//# sourceMappingURL=mod.d.ts.map

package/esm/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAG1D;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;AAEtD;;;;GAIG;AACH,qBAAa,KAAK,CAAC,CAAC,CAAE,YAAW,IAAI,CAAC,CAAC,CAAC;IACtC,OAAO,CAAC,SAAS,CAAsB;IAEvC;;OAEG;IACH,MAAM,CAAC,IAAI,cAAQ;gBAEP,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI;IAKlE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAKhD,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IAKnE,OAAO,CAAC,EAAE,EAAE,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAK3C,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC;CAGjE;AAED,MAAM,WAAW,IAAI,CAAC,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAC3C;;;;;;;OAOG;IACH,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAEpE;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;CAC7C;AAED,iBAAS,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAsC9C"}

package/esm/mod.js

@@ -0,0 +1,79 @@
+import { call, withResolvers } from "effection";
+/**
+ * Represent the eventual completion of an [Operation] in a fashion
+ * that mirrors the * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise}
+ * implementation
+ */
+export class Chain {
+    constructor(compute) {
+        Object.defineProperty(this, "resolvers", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: withResolvers()
+        });
+        let { resolve, reject } = this.resolvers;
+        compute(resolve, reject);
+    }
+    then(fn) {
+        let { operation } = this.resolvers;
+        return from(operation).then(fn);
+    }
+    catch(fn) {
+        let { operation } = this.resolvers;
+        return from(operation).catch(fn);
+    }
+    finally(fn) {
+        let { operation } = this.resolvers;
+        return from(operation).finally(fn);
+    }
+    [Symbol.iterator]() {
+        return this.resolvers.operation[Symbol.iterator]();
+    }
+}
+/**
+ * Create a chain from any operation.
+ */
+Object.defineProperty(Chain, "from", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: from
+});
+function from(source) {
+    let resolvers = undefined;
+    let chain = {
+        *[Symbol.iterator]() {
+            if (!resolvers) {
+                resolvers = withResolvers();
+                try {
+                    resolvers.resolve(yield* source);
+                }
+                catch (e) {
+                    resolvers.reject(e);
+                }
+            }
+            return yield* resolvers.operation;
+        },
+        then: (fn) => from(call(function* () {
+            return yield* fn(yield* chain);
+        })),
+        catch: (fn) => from(call(function* () {
+            try {
+                return yield* chain;
+            }
+            catch (e) {
+                return yield* fn(e);
+            }
+        })),
+        finally: (fn) => from(call(function* () {
+            try {
+                return yield* chain;
+            }
+            finally {
+                yield* fn();
+            }
+        })),
+    };
+    return chain;
+}

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@effectionx/chain",
+  "version": "0.1.0",
+  "author": "engineering@frontside.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thefrontside/effectionx.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/thefrontside/effectionx/issues"
+  },
+  "main": "./script/mod.js",
+  "module": "./esm/mod.js",
+  "exports": {
+    ".": {
+      "import": "./esm/mod.js",
+      "require": "./script/mod.js"
+    }
+  },
+  "scripts": {},
+  "engines": {
+    "node": ">= 16"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "effection": "^3 || ^4.0.0-0"
+  },
+  "_generatedBy": "dnt@dev"
+}

package/script/mod.d.ts

@@ -0,0 +1,58 @@
+import type { Operation, WithResolvers } from "effection";
+/**
+ * Resolve a Chain
+ */
+export type Resolve<T> = WithResolvers<T>["resolve"];
+/**
+ * Reject a chain
+ */
+export type Reject = WithResolvers<unknown>["reject"];
+/**
+ * Represent the eventual completion of an [Operation] in a fashion
+ * that mirrors the * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise}
+ * implementation
+ */
+export declare class Chain<T> implements From<T> {
+    private resolvers;
+    /**
+     * Create a chain from any operation.
+     */
+    static from: typeof from;
+    constructor(compute: (resolve: Resolve<T>, reject: Reject) => void);
+    then<B>(fn: (value: T) => Operation<B>): From<B>;
+    catch<B>(fn: (error: unknown | Error) => Operation<B>): From<T | B>;
+    finally(fn: () => Operation<void>): From<T>;
+    [Symbol.iterator](): ReturnType<From<T>[typeof Symbol.iterator]>;
+}
+export interface From<A> extends Operation<A> {
+    /**
+     * Create a new chain that will resolve to the current chain's value after
+     * applying `fn`;
+     *
+     * @param `fn` - is applied to the source operation's result to create the chained operation's result
+     *
+     * @returns a new {Chain} representing this application
+     */
+    then<B>(fn: (value: A) => Operation<B>): From<B>;
+    /**
+     * Create a new chain that will resolve to the original chain's
+     * value, or the result of `fn` in the event that the current chain
+     * rejects. applying `fn`;
+     *
+     * @param `fn` - applied when the current chain rejects and becomes the result of chain
+     *
+     * @returns a new {Chain} representing the potentially caught rejection
+     */
+    catch<B>(fn: (error: unknown | Error) => Operation<B>): From<A | B>;
+    /**
+     * Create a new {Chain} that behaves exactly like the original chain, except that operation specified with
+     * `fn` will run in all cases.
+     *
+     * @param `fn` - a function returning an operation that is always
+     *   evaluate just before the current chain yields its value.
+     */
+    finally(fn: () => Operation<void>): From<A>;
+}
+declare function from<T>(source: Operation<T>): From<T>;
+export {};
+//# sourceMappingURL=mod.d.ts.map

package/script/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAG1D;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;AAEtD;;;;GAIG;AACH,qBAAa,KAAK,CAAC,CAAC,CAAE,YAAW,IAAI,CAAC,CAAC,CAAC;IACtC,OAAO,CAAC,SAAS,CAAsB;IAEvC;;OAEG;IACH,MAAM,CAAC,IAAI,cAAQ;gBAEP,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI;IAKlE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAKhD,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IAKnE,OAAO,CAAC,EAAE,EAAE,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAK3C,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC;CAGjE;AAED,MAAM,WAAW,IAAI,CAAC,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAC3C;;;;;;;OAOG;IACH,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAEpE;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;CAC7C;AAED,iBAAS,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAsC9C"}

package/script/mod.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Chain = void 0;
+const effection_1 = require("effection");
+/**
+ * Represent the eventual completion of an [Operation] in a fashion
+ * that mirrors the * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise}
+ * implementation
+ */
+class Chain {
+    constructor(compute) {
+        Object.defineProperty(this, "resolvers", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (0, effection_1.withResolvers)()
+        });
+        let { resolve, reject } = this.resolvers;
+        compute(resolve, reject);
+    }
+    then(fn) {
+        let { operation } = this.resolvers;
+        return from(operation).then(fn);
+    }
+    catch(fn) {
+        let { operation } = this.resolvers;
+        return from(operation).catch(fn);
+    }
+    finally(fn) {
+        let { operation } = this.resolvers;
+        return from(operation).finally(fn);
+    }
+    [Symbol.iterator]() {
+        return this.resolvers.operation[Symbol.iterator]();
+    }
+}
+exports.Chain = Chain;
+/**
+ * Create a chain from any operation.
+ */
+Object.defineProperty(Chain, "from", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: from
+});
+function from(source) {
+    let resolvers = undefined;
+    let chain = {
+        *[Symbol.iterator]() {
+            if (!resolvers) {
+                resolvers = (0, effection_1.withResolvers)();
+                try {
+                    resolvers.resolve(yield* source);
+                }
+                catch (e) {
+                    resolvers.reject(e);
+                }
+            }
+            return yield* resolvers.operation;
+        },
+        then: (fn) => from((0, effection_1.call)(function* () {
+            return yield* fn(yield* chain);
+        })),
+        catch: (fn) => from((0, effection_1.call)(function* () {
+            try {
+                return yield* chain;
+            }
+            catch (e) {
+                return yield* fn(e);
+            }
+        })),
+        finally: (fn) => from((0, effection_1.call)(function* () {
+            try {
+                return yield* chain;
+            }
+            finally {
+                yield* fn();
+            }
+        })),
+    };
+    return chain;
+}

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}