shelving 1.55.0 → 1.57.1

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.55.0",
+	"version": "1.57.1",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/stream/ArrayState.js

@@ -9,26 +9,26 @@ export class ArrayState extends State {
     }
     /** Get the length of the current value of this state. */
     get length() {
-        return this.value.length;
+        return this._value.length;
     }
     /** Add an item to this array. */
     add(item) {
-        this.next(withItem(this.value, item));
+        this.next(withItem(this._value, item));
     }
     /** Remove an item from this array. */
     delete(item) {
-        this.next(withoutItem(this.value, item));
+        this.next(withoutItem(this._value, item));
     }
     /** Swap an item in this array with a different item. */
     swap(oldItem, newItem) {
-        this.next(swapItem(this.value, oldItem, newItem));
+        this.next(swapItem(this._value, oldItem, newItem));
     }
     /** Toggle an item in this array. */
     toggle(item) {
-        this.next(toggleItem(this.value, item));
+        this.next(toggleItem(this._value, item));
     }
     /** Iterate over the items. */
     [Symbol.iterator]() {
-        return this.value.values();
+        return this._value.values();
     }
 }

package/stream/BooleanState.d.ts

@@ -0,0 +1,7 @@
+import { State } from "./State.js";
+/** State that stores a boolean and has additional methods to help with that. */
+export declare class BooleanState extends State<boolean> {
+    _value: boolean;
+    /** Toggle the current boolean value. */
+    toggle(): void;
+}

package/stream/BooleanState.js

@@ -0,0 +1,13 @@
+import { State } from "./State.js";
+/** State that stores a boolean and has additional methods to help with that. */
+export class BooleanState extends State {
+    constructor() {
+        super(...arguments);
+        // Set default value to be false.
+        this._value = false;
+    }
+    /** Toggle the current boolean value. */
+    toggle() {
+        this.next(this._value ? false : true);
+    }
+}

package/stream/LazyState.d.ts

@@ -1,12 +1,11 @@
-import type { Observer } from "../util/index.js";
+import { Observer } from "../util/index.js";
 import { State } from "./State.js";
 /**
  * State that tidies up after itself by completing itself after all its subscribers unsubscribe.
  * @param delay How long to wait (in ms) before the source subscription is stopped.
  */
 export declare class LazyState<T> extends State<T> {
-    private _delay;
-    private _timeout?;
-    constructor(delay?: number);
+    private _timeout;
+    constructor(delay?: number | null);
     _removeObserver(observer: Observer<T>): void;
 }

package/stream/LazyState.js

@@ -1,24 +1,23 @@
+import { Timeout } from "../util/index.js";
 import { State } from "./State.js";
 /**
  * State that tidies up after itself by completing itself after all its subscribers unsubscribe.
  * @param delay How long to wait (in ms) before the source subscription is stopped.
  */
 export class LazyState extends State {
-    constructor(delay = 0) {
+    constructor(delay = null) {
         super();
-        this._delay = delay;
+        this._timeout = delay ? new Timeout(delay) : null;
     }
     // Override to stop the source subscription when the last subscriber unsubscribes.
     _removeObserver(observer) {
         super._removeObserver(observer);
-        if (this._delay) {
+        if (this._timeout) {
             // Maybe stop in a bit (if there are still no subscribers).
-            if (this._timeout)
-                clearTimeout(this._timeout);
-            this._timeout = setTimeout(() => {
+            this._timeout.set(() => {
                 if (!this._observers.size && !this.closed)
                     this.complete();
-            }, this._delay);
+            });
         }
         else {
             // Stop now.

package/stream/ObjectState.d.ts

@@ -0,0 +1,14 @@
+import { Entry, ImmutableObject } from "../util/index.js";
+import { State } from "./State.js";
+/** State that stores a map-like object and has additional methods to help with that. */
+export declare class ObjectState<T> extends State<ImmutableObject<T>> implements Iterable<Entry<T>> {
+    _value: {};
+    /** Get the length of the current value of this state. */
+    get length(): number;
+    /** Remove a named entry from this object. */
+    delete(key: string): void;
+    /** Set a named entry in this object with a different value. */
+    set(key: string, value: T): void;
+    /** Iterate over the items. */
+    [Symbol.iterator](): Iterator<Entry<T>, void>;
+}

package/stream/ObjectState.js

@@ -0,0 +1,26 @@
+import { withEntry, withoutEntry } from "../util/index.js";
+import { State } from "./State.js";
+/** State that stores a map-like object and has additional methods to help with that. */
+export class ObjectState extends State {
+    constructor() {
+        super(...arguments);
+        // Set default value to be empty object.
+        this._value = {};
+    }
+    /** Get the length of the current value of this state. */
+    get length() {
+        return Object.keys(this._value).length;
+    }
+    /** Remove a named entry from this object. */
+    delete(key) {
+        this.next(withoutEntry(this._value, key));
+    }
+    /** Set a named entry in this object with a different value. */
+    set(key, value) {
+        this.next(withEntry(this._value, key, value));
+    }
+    /** Iterate over the items. */
+    [Symbol.iterator]() {
+        return Object.entries(this._value)[Symbol.iterator]();
+    }
+}

package/stream/index.d.ts

@@ -3,5 +3,7 @@ export * from "./LazyStream.js";
 export * from "./LastStream.js";
 export * from "./State.js";
 export * from "./LazyState.js";
+export * from "./BooleanState.js";
 export * from "./ArrayState.js";
+export * from "./ObjectState.js";
 export * from "./DataState.js";

package/stream/index.js

@@ -3,5 +3,7 @@ export * from "./LazyStream.js";
 export * from "./LastStream.js";
 export * from "./State.js";
 export * from "./LazyState.js";
+export * from "./BooleanState.js";
 export * from "./ArrayState.js";
+export * from "./ObjectState.js";
 export * from "./DataState.js";

package/util/async.d.ts

@@ -59,7 +59,3 @@ export declare class Signal extends AbstractPromise<typeof DONE> {
     /** Send this signal now. */
     done(): void;
 }
-/** Resolve to `DONE` after a specified delay. */
-export declare class Timeout extends AbstractPromise<typeof DONE> {
-    constructor(ms: number);
-}

package/util/async.js

@@ -95,10 +95,3 @@ export class Signal extends AbstractPromise {
         this._resolve(DONE);
     }
 }
-/** Resolve to `DONE` after a specified delay. */
-export class Timeout extends AbstractPromise {
-    constructor(ms) {
-        super();
-        setTimeout(this._resolve, ms, DONE);
-    }
-}

package/util/index.d.ts

@@ -31,6 +31,7 @@ export * from "./serialise.js";
 export * from "./sort.js";
 export * from "./string.js";
 export * from "./template.js";
+export * from "./timeout.js";
 export * from "./transform.js";
 export * from "./undefined.js";
 export * from "./units.js";

package/util/index.js

@@ -31,6 +31,7 @@ export * from "./serialise.js";
 export * from "./sort.js";
 export * from "./string.js";
 export * from "./template.js";
+export * from "./timeout.js";
 export * from "./transform.js";
 export * from "./undefined.js";
 export * from "./units.js";

package/util/observable.d.ts

@@ -40,7 +40,7 @@ export interface Observer<T> {
      */
     readonly from?: (source: Subscribable<T>) => this;
     /** Receive the next value. */
-    readonly next: Dispatcher<[T]>;
+    readonly next?: Dispatcher<[T]>;
     /** End the subscription with an error. */
     readonly error?: Handler;
     /** End the subscription with success. */

package/util/observable.js

@@ -17,8 +17,9 @@ export function subscribe(source, target) {
 }
 /** Dispatch the next value to an observer (and if the next value errors, calls a handler). */
 export function dispatchNext(observer, value) {
+    var _a;
     try {
-        observer.next(value);
+        (_a = observer.next) === null || _a === void 0 ? void 0 : _a.call(observer, value);
     }
     catch (thrown) {
         logError(thrown);

package/util/timeout.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Create a new Timeout.
+ *
+ * Wrapper for `setTimeout()` that...
+ * - Keeps track of the reference returned from `setTimeout()`
+ * - Clears the any existing timeout when a new timeout is set.
+ * - Allows a default delay to be set that is applied to all new timeouts that don't have a delay set.
+ *
+ * @param ms The default delay for any created timeouts (in ms).
+ */
+export declare class Timeout {
+    private _ms;
+    private _timeout;
+    constructor(ms?: number);
+    /**
+     * Cancel any existing timeout and set a new one.
+     * @param callback
+     * @param ms The delay for this timeout (in ms).
+     */
+    set(callback: () => void, ms?: number): void;
+    /** Cancel any existing timeout.. */
+    clear(): void;
+}

package/util/timeout.js

@@ -0,0 +1,30 @@
+/**
+ * Create a new Timeout.
+ *
+ * Wrapper for `setTimeout()` that...
+ * - Keeps track of the reference returned from `setTimeout()`
+ * - Clears the any existing timeout when a new timeout is set.
+ * - Allows a default delay to be set that is applied to all new timeouts that don't have a delay set.
+ *
+ * @param ms The default delay for any created timeouts (in ms).
+ */
+export class Timeout {
+    constructor(ms = 0) {
+        this._timeout = undefined;
+        this._ms = ms;
+    }
+    /**
+     * Cancel any existing timeout and set a new one.
+     * @param callback
+     * @param ms The delay for this timeout (in ms).
+     */
+    set(callback, ms = this._ms) {
+        this.clear();
+        this._timeout = setTimeout(callback, ms);
+    }
+    /** Cancel any existing timeout.. */
+    clear() {
+        if (this._timeout)
+            this._timeout = void clearTimeout(this._timeout);
+    }
+}