@effectionx/signals 0.1.0

package/README.md

@@ -0,0 +1,119 @@
+# Signals
+
+Collection of immutable state containers for primitive data types.
+
+## About
+
+One way to think about Effection operation is as composable components of
+asyncrony. They are conceptually similar to React components in that they're
+functions that invoke other functions. As with React's component tree, Effection
+operations are arranged into an operation tree. React components are designed to
+make it easier to compose DOM where Effection operations are designed to make it
+easier to compose asynchrony. Because of their simularities, it should come as
+no surpise that they would share patterns for state management. React Context
+and Effection Context is one example of this, but the benefits that
+[unidirectional data flow](https://en.wikipedia.org/wiki/Unidirectional_data_flow)
+provide to composition is another.
+
+The Flux pattern, in tools like Redux and others, are "classic" ways to
+implement one directional data from in React applications. Over the years, these
+patterns involved into Signals which where implemented in variety of UI
+frameworks. The design of Signals in the JavaScript ecosystem assume that they
+will be integrated into some UI framework. Effection provides the necessary
+components to have robust yet simple implementation of Signals that doesn't
+require a UI framework.
+
+### Included in this package
+
+The collection of Signals included in this package rely on Effection's Signal
+interface to provide immutable value streams with some operations. Each Signal
+includes `set`, `update` and `valueOf` methods. Each data type also includes
+methods provided by the primitive version of that data type. For example,
+ArraySignal provides `push` and `shift`, while Set provides `difference`. We
+don't implement all methods, mostly because haven't needed all of the methods.
+If you need a method that we didn't implement but it's available in the
+promitive type, please create a PR. If you need something else, use the `update`
+method.
+
+### Boolean Signal
+
+The Boolean Signal provides a stream for a boolean value. You can set the value
+which will cause the new value to be sent to the stream.
+
+```ts
+import { each, run, spawn } from "effection";
+import { createBooleanSignal } from "@effectionx/signals";
+
+await run(function* () {
+  const boolean = yield* createBooleanSignal(true);
+
+  yield* spawn(function* () {
+    for (const update of yield* each(boolean)) {
+      console.log(update);
+      yield* each.next();
+    }
+  });
+
+  boolean.set(false); // this will send false to the stream
+  boolean.set(true); // this will send true to the stream
+  boolean.set(true); // this won't send anything since the value hasn't changed
+});
+```
+
+For an example of Boolean Signal in action, checkout the
+[faucet](https://github.com/thefrontside/effectionx/blob/main/stream-helpers/test-helpers/faucet.ts)
+
+### Array Signal
+
+The Array Signal provides a stream for the value of the array. The value is
+considered immutable - you shouldn't modify the value that comes through the
+stream, instead invoke methods on the signal to cause a new value to be sent.
+
+```ts
+import { each, run, spawn } from "effection";
+import { createArraySignal } from "@effectionx/signals";
+
+await run(function* () {
+  const array = yield* createArraySignal<number>([]);
+
+  yield* spawn(function* () {
+    for (const update of yield* each(array)) {
+      console.log(update);
+      yield* each.next();
+    }
+  });
+
+  array.push(1, 2, 3); // this will be a single update
+});
+```
+
+For an example of Array Signl, checkout the
+[valve](https://github.com/thefrontside/effectionx/blob/main/stream-helpers/valve.ts)
+and
+[batch](https://github.com/thefrontside/effectionx/blob/main/stream-helpers/batch.ts)
+stream helpers.
+
+## Helpers
+
+### is
+
+`is` helper returns an operation that completes when the value of the stream
+matches the predicate. It's useful when you want to wait for a signal to enter a
+specific state. Some of the common use cases are waiting for an array to reach a
+given length or for a boolean signal to become true or false.
+
+```ts
+import { run, spawn } from "effection";
+import { createBooleanSignal, is } from "@effectionx/signals";
+
+await run(function* () {
+  const open = yield* createBooleanSignal(false);
+
+  yield* spawn(function* () {
+    yield* is(open, (open) => open === true);
+    console.log("floodgates are open!");
+  });
+
+  open.set(true);
+});
+```

package/esm/array.d.ts

@@ -0,0 +1,44 @@
+import { type Operation } from "effection";
+import type { ValueSignal } from "./types.js";
+/**
+ * Interface for return value of {@link createArraySignal}.
+ */
+export interface ArraySignal<T> extends ValueSignal<T[]> {
+    /**
+     * Pushes a new value onto the end of the array.
+     *
+     * @param item - The value to push onto the array.
+     * @returns The new length of the array.
+     */
+    push(item: T): number;
+    /**
+     * Removes the first value from the array and returns it.
+     * If the array is empty, the operation will block until a value is available.
+     *
+     * @returns The first value from the array.
+     */
+    shift(): Operation<T>;
+    /**
+     * Returns the current value of the array.
+     *
+     * @returns The current value of the array.
+     */
+    valueOf(): Readonly<T[]>;
+    /**
+     * Returns the length of the array.
+     *
+     * @returns The length of the array.
+     */
+    get length(): number;
+}
+/**
+ * A signal for an immutable array value. The stream emits the
+ * current value of the array and new values when the array is updated. The array
+ * is immutable and cannot be changed. Instead, the value is replaced with a new
+ * value.
+ *
+ * @param initial - The initial value of the signal.
+ * @returns A stream of immutable array values.
+ */
+export declare function createArraySignal<T>(initial: Iterable<T>): Operation<ArraySignal<T>>;
+//# sourceMappingURL=array.d.ts.map

package/esm/array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,SAAS,EAAY,MAAM,WAAW,CAAC;AAInE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,CAAC,EAAE,CAAC;IACtD;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC;IACtB;;;;;OAKG;IACH,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;IACtB;;;;OAIG;IACH,OAAO,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACzB;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GACnB,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAiD3B"}

package/esm/array.js

@@ -0,0 +1,59 @@
+import { createSignal, resource } from "effection";
+import { List } from "immutable";
+import { is } from "./helpers.js";
+/**
+ * A signal for an immutable array value. The stream emits the
+ * current value of the array and new values when the array is updated. The array
+ * is immutable and cannot be changed. Instead, the value is replaced with a new
+ * value.
+ *
+ * @param initial - The initial value of the signal.
+ * @returns A stream of immutable array values.
+ */
+export function createArraySignal(initial) {
+    return resource(function* (provide) {
+        const signal = createSignal();
+        const ref = {
+            current: List.of(...initial),
+        };
+        function set(value) {
+            if (ref.current.equals(List.of(...value))) {
+                return ref.current.toArray();
+            }
+            ref.current = List.of(...value);
+            signal.send(ref.current.toArray());
+            return ref.current.toArray();
+        }
+        const array = {
+            [Symbol.iterator]: signal[Symbol.iterator],
+            set,
+            update(updater) {
+                return set(updater(ref.current.toArray()));
+            },
+            push(...args) {
+                ref.current = ref.current.push(...args);
+                signal.send(ref.current.toArray());
+                return ref.current.size;
+            },
+            *shift() {
+                yield* is(array, (array) => array.length > 0);
+                let value = ref.current.first();
+                ref.current = ref.current.shift();
+                signal.send(ref.current.toArray());
+                return value;
+            },
+            valueOf() {
+                return ref.current.toArray();
+            },
+            get length() {
+                return ref.current.size;
+            },
+        };
+        try {
+            yield* provide(array);
+        }
+        finally {
+            signal.close();
+        }
+    });
+}

package/esm/boolean.d.ts

@@ -0,0 +1,6 @@
+import { type Operation } from "effection";
+import type { ValueSignal } from "./types.js";
+export interface BooleanSignal extends ValueSignal<boolean> {
+}
+export declare function createBooleanSignal(initial?: boolean): Operation<BooleanSignal>;
+//# sourceMappingURL=boolean.d.ts.map

package/esm/boolean.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../src/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,SAAS,EAAY,MAAM,WAAW,CAAC;AAEnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,WAAW,aAAc,SAAQ,WAAW,CAAC,OAAO,CAAC;CAAG;AAE9D,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,OAAe,GACvB,SAAS,CAAC,aAAa,CAAC,CA+B1B"}

package/esm/boolean.js

@@ -0,0 +1,29 @@
+import { createSignal, resource } from "effection";
+export function createBooleanSignal(initial = false) {
+    return resource(function* (provide) {
+        const signal = createSignal();
+        const ref = { current: initial };
+        function set(value) {
+            if (value !== ref.current) {
+                ref.current = value;
+                signal.send(ref.current);
+            }
+            return ref.current;
+        }
+        try {
+            yield* provide({
+                [Symbol.iterator]: signal[Symbol.iterator],
+                set,
+                update(updater) {
+                    return set(updater(ref.current));
+                },
+                valueOf() {
+                    return ref.current;
+                },
+            });
+        }
+        finally {
+            signal.close();
+        }
+    });
+}

package/esm/helpers.d.ts

@@ -0,0 +1,10 @@
+import { type Operation } from "effection";
+import type { ValueSignal } from "./types.js";
+/**
+ * Returns an operation that will wait until the value of the stream matches the predicate.
+ * @param stream - The stream to check.
+ * @param predicate - The predicate to check the value against.
+ * @returns An operation that will wait until the value of the stream matches the predicate.
+ */
+export declare function is<T>(stream: ValueSignal<T>, predicate: (item: T) => boolean): Operation<void>;
+//# sourceMappingURL=helpers.d.ts.map

package/esm/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;GAKG;AACH,wBAAiB,EAAE,CAAC,CAAC,EACnB,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,GAC9B,SAAS,CAAC,IAAI,CAAC,CAYjB"}

package/esm/helpers.js

@@ -0,0 +1,20 @@
+import { each } from "effection";
+/**
+ * Returns an operation that will wait until the value of the stream matches the predicate.
+ * @param stream - The stream to check.
+ * @param predicate - The predicate to check the value against.
+ * @returns An operation that will wait until the value of the stream matches the predicate.
+ */
+export function* is(stream, predicate) {
+    const result = predicate(stream.valueOf());
+    if (result) {
+        return;
+    }
+    for (const value of yield* each(stream)) {
+        const result = predicate(value);
+        if (result) {
+            return;
+        }
+        yield* each.next();
+    }
+}

package/esm/mod.d.ts

@@ -0,0 +1,5 @@
+export * from "./boolean.js";
+export * from "./array.js";
+export * from "./set.js";
+export * from "./helpers.js";
+//# 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,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}

package/esm/mod.js

@@ -0,0 +1,4 @@
+export * from "./boolean.js";
+export * from "./array.js";
+export * from "./set.js";
+export * from "./helpers.js";

package/esm/package.json

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

package/esm/set.d.ts

@@ -0,0 +1,39 @@
+import { type Operation } from "effection";
+import type { ValueSignal } from "./types.js";
+import { Set } from "immutable";
+/**
+ * A signal that represents a Set.
+ */
+export interface SetSignal<T> extends ValueSignal<Set<T>> {
+    /**
+     * Adds an item to the Set.
+     * @param item - The item to add to the Set.
+     * @returns The Set.
+     */
+    add(item: T): Set<T>;
+    /**
+     * Removes an item from the Set.
+     * @param item - The item to remove from the Set.
+     * @returns `true` if the item was removed, `false` otherwise.
+     */
+    delete(item: T): boolean;
+    /**
+     * Returns a new Set with the items that are in the current Set but not in the given iterable.
+     * @param items - The items to remove from the Set.
+     * @returns A new Set with the items that are in the current Set but not in the given iterable.
+     */
+    difference(items: Iterable<T>): Set<T>;
+    /**
+     * Returns the Set value
+     * @returns The Set.
+     */
+    valueOf(): Set<T>;
+}
+/**
+ * Creates a signal that represents a set. Adding and removing items from the set will
+ * push a new value through the stream.
+ * @param initial - The initial value of the set.
+ * @returns A signal that represents a set.
+ */
+export declare function createSetSignal<T>(initial?: Array<T>): Operation<SetSignal<T>>;
+//# sourceMappingURL=set.d.ts.map

package/esm/set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../src/set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,SAAS,EAAY,MAAM,WAAW,CAAC;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAM,GAAG,EAAE,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvD;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC;IACzB;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACvC;;;OAGG;IACH,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC/B,OAAO,GAAE,KAAK,CAAC,CAAC,CAAM,GACrB,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAgDzB"}

package/esm/set.js

@@ -0,0 +1,55 @@
+import { createSignal, resource } from "effection";
+import { is, Set } from "immutable";
+/**
+ * Creates a signal that represents a set. Adding and removing items from the set will
+ * push a new value through the stream.
+ * @param initial - The initial value of the set.
+ * @returns A signal that represents a set.
+ */
+export function createSetSignal(initial = []) {
+    return resource(function* (provide) {
+        const signal = createSignal();
+        const ref = { current: Set.of(...initial) };
+        function set(value) {
+            if (is(ref.current, value)) {
+                return ref.current;
+            }
+            ref.current = Set.of(...value);
+            signal.send(ref.current);
+            return ref.current;
+        }
+        try {
+            yield* provide({
+                [Symbol.iterator]: signal[Symbol.iterator],
+                set,
+                update(updater) {
+                    return set(updater(ref.current));
+                },
+                add(item) {
+                    ref.current = ref.current.add(item);
+                    signal.send(ref.current);
+                    return ref.current;
+                },
+                difference(items) {
+                    ref.current = ref.current.subtract(items);
+                    signal.send(ref.current);
+                    return ref.current;
+                },
+                delete(item) {
+                    if (ref.current.has(item)) {
+                        ref.current = ref.current.delete(item);
+                        signal.send(ref.current);
+                        return true;
+                    }
+                    return false;
+                },
+                valueOf() {
+                    return ref.current.toSet();
+                },
+            });
+        }
+        finally {
+            signal.close();
+        }
+    });
+}

package/esm/types.d.ts

@@ -0,0 +1,25 @@
+import type { Stream } from "effection";
+/**
+ * A signal is a stream with set, update, and valueOf methods.
+ * Subscribing to a signal will yield the current value of the signal.
+ */
+export interface ValueSignal<T> extends Stream<T, void> {
+    /**
+     * Set the value of the signal.
+     * @param value - The value to set the signal to.
+     * @returns The value of the signal.
+     */
+    set(value: T): T;
+    /**
+     * Update the value of the signal.
+     * @param updater - The updater function.
+     * @returns The value of the signal.
+     */
+    update(updater: (value: T) => T): T;
+    /**
+     * Get the current value of the signal.
+     * @returns The current value of the signal.
+     */
+    valueOf(): Readonly<T>;
+}
+//# sourceMappingURL=types.d.ts.map

package/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;IACrD;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC;;;OAGG;IACH,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC;CACxB"}

package/esm/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@effectionx/signals",
+  "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"
+    }
+  },
+  "engines": {
+    "node": ">= 16"
+  },
+  "sideEffects": false,
+  "_generatedBy": "dnt@dev"
+}

package/script/array.d.ts

@@ -0,0 +1,44 @@
+import { type Operation } from "effection";
+import type { ValueSignal } from "./types.js";
+/**
+ * Interface for return value of {@link createArraySignal}.
+ */
+export interface ArraySignal<T> extends ValueSignal<T[]> {
+    /**
+     * Pushes a new value onto the end of the array.
+     *
+     * @param item - The value to push onto the array.
+     * @returns The new length of the array.
+     */
+    push(item: T): number;
+    /**
+     * Removes the first value from the array and returns it.
+     * If the array is empty, the operation will block until a value is available.
+     *
+     * @returns The first value from the array.
+     */
+    shift(): Operation<T>;
+    /**
+     * Returns the current value of the array.
+     *
+     * @returns The current value of the array.
+     */
+    valueOf(): Readonly<T[]>;
+    /**
+     * Returns the length of the array.
+     *
+     * @returns The length of the array.
+     */
+    get length(): number;
+}
+/**
+ * A signal for an immutable array value. The stream emits the
+ * current value of the array and new values when the array is updated. The array
+ * is immutable and cannot be changed. Instead, the value is replaced with a new
+ * value.
+ *
+ * @param initial - The initial value of the signal.
+ * @returns A stream of immutable array values.
+ */
+export declare function createArraySignal<T>(initial: Iterable<T>): Operation<ArraySignal<T>>;
+//# sourceMappingURL=array.d.ts.map

package/script/array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,SAAS,EAAY,MAAM,WAAW,CAAC;AAInE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,CAAC,EAAE,CAAC;IACtD;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC;IACtB;;;;;OAKG;IACH,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;IACtB;;;;OAIG;IACH,OAAO,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACzB;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GACnB,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAiD3B"}

package/script/array.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createArraySignal = createArraySignal;
+const effection_1 = require("effection");
+const immutable_1 = require("immutable");
+const helpers_js_1 = require("./helpers.js");
+/**
+ * A signal for an immutable array value. The stream emits the
+ * current value of the array and new values when the array is updated. The array
+ * is immutable and cannot be changed. Instead, the value is replaced with a new
+ * value.
+ *
+ * @param initial - The initial value of the signal.
+ * @returns A stream of immutable array values.
+ */
+function createArraySignal(initial) {
+    return (0, effection_1.resource)(function* (provide) {
+        const signal = (0, effection_1.createSignal)();
+        const ref = {
+            current: immutable_1.List.of(...initial),
+        };
+        function set(value) {
+            if (ref.current.equals(immutable_1.List.of(...value))) {
+                return ref.current.toArray();
+            }
+            ref.current = immutable_1.List.of(...value);
+            signal.send(ref.current.toArray());
+            return ref.current.toArray();
+        }
+        const array = {
+            [Symbol.iterator]: signal[Symbol.iterator],
+            set,
+            update(updater) {
+                return set(updater(ref.current.toArray()));
+            },
+            push(...args) {
+                ref.current = ref.current.push(...args);
+                signal.send(ref.current.toArray());
+                return ref.current.size;
+            },
+            *shift() {
+                yield* (0, helpers_js_1.is)(array, (array) => array.length > 0);
+                let value = ref.current.first();
+                ref.current = ref.current.shift();
+                signal.send(ref.current.toArray());
+                return value;
+            },
+            valueOf() {
+                return ref.current.toArray();
+            },
+            get length() {
+                return ref.current.size;
+            },
+        };
+        try {
+            yield* provide(array);
+        }
+        finally {
+            signal.close();
+        }
+    });
+}

package/script/boolean.d.ts

@@ -0,0 +1,6 @@
+import { type Operation } from "effection";
+import type { ValueSignal } from "./types.js";
+export interface BooleanSignal extends ValueSignal<boolean> {
+}
+export declare function createBooleanSignal(initial?: boolean): Operation<BooleanSignal>;
+//# sourceMappingURL=boolean.d.ts.map

package/script/boolean.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../src/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,SAAS,EAAY,MAAM,WAAW,CAAC;AAEnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,WAAW,aAAc,SAAQ,WAAW,CAAC,OAAO,CAAC;CAAG;AAE9D,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,OAAe,GACvB,SAAS,CAAC,aAAa,CAAC,CA+B1B"}

package/script/boolean.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBooleanSignal = createBooleanSignal;
+const effection_1 = require("effection");
+function createBooleanSignal(initial = false) {
+    return (0, effection_1.resource)(function* (provide) {
+        const signal = (0, effection_1.createSignal)();
+        const ref = { current: initial };
+        function set(value) {
+            if (value !== ref.current) {
+                ref.current = value;
+                signal.send(ref.current);
+            }
+            return ref.current;
+        }
+        try {
+            yield* provide({
+                [Symbol.iterator]: signal[Symbol.iterator],
+                set,
+                update(updater) {
+                    return set(updater(ref.current));
+                },
+                valueOf() {
+                    return ref.current;
+                },
+            });
+        }
+        finally {
+            signal.close();
+        }
+    });
+}

package/script/helpers.d.ts

@@ -0,0 +1,10 @@
+import { type Operation } from "effection";
+import type { ValueSignal } from "./types.js";
+/**
+ * Returns an operation that will wait until the value of the stream matches the predicate.
+ * @param stream - The stream to check.
+ * @param predicate - The predicate to check the value against.
+ * @returns An operation that will wait until the value of the stream matches the predicate.
+ */
+export declare function is<T>(stream: ValueSignal<T>, predicate: (item: T) => boolean): Operation<void>;
+//# sourceMappingURL=helpers.d.ts.map

package/script/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;GAKG;AACH,wBAAiB,EAAE,CAAC,CAAC,EACnB,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,GAC9B,SAAS,CAAC,IAAI,CAAC,CAYjB"}

package/script/helpers.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.is = is;
+const effection_1 = require("effection");
+/**
+ * Returns an operation that will wait until the value of the stream matches the predicate.
+ * @param stream - The stream to check.
+ * @param predicate - The predicate to check the value against.
+ * @returns An operation that will wait until the value of the stream matches the predicate.
+ */
+function* is(stream, predicate) {
+    const result = predicate(stream.valueOf());
+    if (result) {
+        return;
+    }
+    for (const value of yield* (0, effection_1.each)(stream)) {
+        const result = predicate(value);
+        if (result) {
+            return;
+        }
+        yield* effection_1.each.next();
+    }
+}

package/script/mod.d.ts

@@ -0,0 +1,5 @@
+export * from "./boolean.js";
+export * from "./array.js";
+export * from "./set.js";
+export * from "./helpers.js";
+//# 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,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}

package/script/mod.js

@@ -0,0 +1,20 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./boolean.js"), exports);
+__exportStar(require("./array.js"), exports);
+__exportStar(require("./set.js"), exports);
+__exportStar(require("./helpers.js"), exports);

package/script/package.json

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

package/script/set.d.ts

@@ -0,0 +1,39 @@
+import { type Operation } from "effection";
+import type { ValueSignal } from "./types.js";
+import { Set } from "immutable";
+/**
+ * A signal that represents a Set.
+ */
+export interface SetSignal<T> extends ValueSignal<Set<T>> {
+    /**
+     * Adds an item to the Set.
+     * @param item - The item to add to the Set.
+     * @returns The Set.
+     */
+    add(item: T): Set<T>;
+    /**
+     * Removes an item from the Set.
+     * @param item - The item to remove from the Set.
+     * @returns `true` if the item was removed, `false` otherwise.
+     */
+    delete(item: T): boolean;
+    /**
+     * Returns a new Set with the items that are in the current Set but not in the given iterable.
+     * @param items - The items to remove from the Set.
+     * @returns A new Set with the items that are in the current Set but not in the given iterable.
+     */
+    difference(items: Iterable<T>): Set<T>;
+    /**
+     * Returns the Set value
+     * @returns The Set.
+     */
+    valueOf(): Set<T>;
+}
+/**
+ * Creates a signal that represents a set. Adding and removing items from the set will
+ * push a new value through the stream.
+ * @param initial - The initial value of the set.
+ * @returns A signal that represents a set.
+ */
+export declare function createSetSignal<T>(initial?: Array<T>): Operation<SetSignal<T>>;
+//# sourceMappingURL=set.d.ts.map

package/script/set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../src/set.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,SAAS,EAAY,MAAM,WAAW,CAAC;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAM,GAAG,EAAE,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACvD;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC;IACzB;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IACvC;;;OAGG;IACH,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC/B,OAAO,GAAE,KAAK,CAAC,CAAC,CAAM,GACrB,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAgDzB"}

package/script/set.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSetSignal = createSetSignal;
+const effection_1 = require("effection");
+const immutable_1 = require("immutable");
+/**
+ * Creates a signal that represents a set. Adding and removing items from the set will
+ * push a new value through the stream.
+ * @param initial - The initial value of the set.
+ * @returns A signal that represents a set.
+ */
+function createSetSignal(initial = []) {
+    return (0, effection_1.resource)(function* (provide) {
+        const signal = (0, effection_1.createSignal)();
+        const ref = { current: immutable_1.Set.of(...initial) };
+        function set(value) {
+            if ((0, immutable_1.is)(ref.current, value)) {
+                return ref.current;
+            }
+            ref.current = immutable_1.Set.of(...value);
+            signal.send(ref.current);
+            return ref.current;
+        }
+        try {
+            yield* provide({
+                [Symbol.iterator]: signal[Symbol.iterator],
+                set,
+                update(updater) {
+                    return set(updater(ref.current));
+                },
+                add(item) {
+                    ref.current = ref.current.add(item);
+                    signal.send(ref.current);
+                    return ref.current;
+                },
+                difference(items) {
+                    ref.current = ref.current.subtract(items);
+                    signal.send(ref.current);
+                    return ref.current;
+                },
+                delete(item) {
+                    if (ref.current.has(item)) {
+                        ref.current = ref.current.delete(item);
+                        signal.send(ref.current);
+                        return true;
+                    }
+                    return false;
+                },
+                valueOf() {
+                    return ref.current.toSet();
+                },
+            });
+        }
+        finally {
+            signal.close();
+        }
+    });
+}

package/script/types.d.ts

@@ -0,0 +1,25 @@
+import type { Stream } from "effection";
+/**
+ * A signal is a stream with set, update, and valueOf methods.
+ * Subscribing to a signal will yield the current value of the signal.
+ */
+export interface ValueSignal<T> extends Stream<T, void> {
+    /**
+     * Set the value of the signal.
+     * @param value - The value to set the signal to.
+     * @returns The value of the signal.
+     */
+    set(value: T): T;
+    /**
+     * Update the value of the signal.
+     * @param updater - The updater function.
+     * @returns The value of the signal.
+     */
+    update(updater: (value: T) => T): T;
+    /**
+     * Get the current value of the signal.
+     * @returns The current value of the signal.
+     */
+    valueOf(): Readonly<T>;
+}
+//# sourceMappingURL=types.d.ts.map

package/script/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;IACrD;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC;;;OAGG;IACH,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC;CACxB"}

package/script/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });