shelving 1.68.4 → 1.69.1

package/observe/Observable.d.ts

@@ -6,6 +6,8 @@ export declare type Unsubscribe = () => void;
 export interface Observable<T> {
     /** Subscribe an observer to this observable. */
     subscribe(observer: PartialObserver<T> | Dispatch<[T]>): Unsubscribe;
+    /** Is this observable closed? */
+    readonly closed?: boolean;
 }
 /** Subscribe function is a function that initiates a subscription to an observer. */
 export declare type Subscribe<T> = (observer: PartialObserver<T>) => Unsubscribe;
@@ -17,4 +19,6 @@ export declare function subscribe<T>(source: Subscribable<T>, target: PartialObs
 export interface Connectable<T> {
     /** Subscribe this entity to a subscribable. */
     connect(subscribable: Subscribable<T>): Unsubscribe;
+    /** Is this observable closed? */
+    readonly closed?: boolean;
 }

package/observe/Observable.js

@@ -1,7 +1,4 @@
-import { ConditionError } from "../error/ConditionError.js";
 /** Start a subscription to a `Subscribable` and return the `Unsubscriber` function. */
 export function subscribe(source, target) {
-    if (target.closed)
-        throw new ConditionError("Target is closed");
     return typeof source === "function" ? source(target) : source.subscribe(target);
 }

package/observe/Observer.d.ts

@@ -8,13 +8,13 @@ import type { Connectable } from "./Observable.js";
  * - Compatible with https://github.com/tc39/proposal-observable/
  */
 export interface Observer<T> {
-    /** Send the next value to this object. */
+    /** Send the next value to this observer. */
     readonly next: Dispatch<[T]>;
-    /** End this object with an error. */
+    /** End this observer with an error. */
     readonly error: Handler;
-    /** End this object with success. */
+    /** End this observer with success. */
     readonly complete: Dispatch;
-    /** Is this object closed? */
+    /** Is this observer closed? */
     readonly closed?: boolean;
 }
 /** Partial observer is an observer missing one or more of its callbacks. */

package/observe/Subject.d.ts

@@ -9,7 +9,7 @@ import { Observable, Subscribable, Unsubscribe } from "./Observable.js";
  */
 export declare class Subject<T> implements Observable<T>, ConnectableObserver<T> {
     /** List of sources this subject is subscribed to. */
-    protected readonly _cleanups: Set<Unsubscribe>;
+    protected readonly _connections: Set<Unsubscribe>;
     /** List of subscribed observers that values are forwarded to. */
     protected readonly _subscribers: Set<Partial<import("./Observer.js").Observer<T>>>;
     /** Get the number of current subscribers. */
@@ -24,17 +24,17 @@ export declare class Subject<T> implements Observable<T>, ConnectableObserver<T>
     error(reason: Error | unknown): void;
     complete(): void;
     /** Close this subject (called by `error()` and `complete()`). */
-    private _close;
-    /** Connect this subjet to a source. */
+    protected _close(): void;
+    /** Connect this subject to a source. */
     connect(source: Subscribable<T>): Unsubscribe;
     /** Disconnect this subject from all sources. */
     disconnect(): void;
     /**
      * Subscribe to this subject and return an unsubscriber function.
-     * - Allows either an `Observer` object or  separate `next()`, `error()` and `complete()` functions.
+     * - Allows either an `Observer` object or  separate `next()", `error()` and `complete()` functions.
      * - Implements `Observable`
      */
-    subscribe(next: PartialObserver<T> | Dispatch<[T]>): Unsubscribe;
+    subscribe(target: PartialObserver<T> | Dispatch<[T]>): Unsubscribe;
     /** Add an observer (called by `subscribe()`). */
     protected _addObserver(observer: PartialObserver<T>): void;
     /** Called after adding the first observer. */

package/observe/Subject.js

@@ -11,7 +11,7 @@ import { subscribe } from "./Observable.js";
 export class Subject {
     constructor() {
         /** List of sources this subject is subscribed to. */
-        this._cleanups = new Set();
+        this._connections = new Set();
         /** List of subscribed observers that values are forwarded to. */
         this._subscribers = new Set();
         /** Is this subject open or closed (i.e. `error()` or `complete()` have been called. */
@@ -19,7 +19,7 @@ export class Subject {
     }
     /** Get the number of current subscribers. */
     get connections() {
-        return this._cleanups.size;
+        return this._connections.size;
     }
     /** Get the number of current subscribers. */
     get subscribers() {
@@ -27,7 +27,7 @@ export class Subject {
     }
     next(value) {
         if (this.closed)
-            throw new ConditionError("Subject is closed");
+            throw new ConditionError(`Observer is closed`);
         this._dispatch(value);
     }
     /** Call `next()` on the subscribers. */
@@ -37,7 +37,7 @@ export class Subject {
     }
     error(reason) {
         if (this.closed)
-            throw new ConditionError("Subject is closed");
+            throw new ConditionError(`Observer is closed`);
         this._close();
         for (const subscriber of this._subscribers) {
             this._subscribers.delete(subscriber);
@@ -46,7 +46,7 @@ export class Subject {
     }
     complete() {
         if (this.closed)
-            throw new ConditionError("Subject is closed");
+            throw new ConditionError(`Observer is closed`);
         this._close();
         for (const subscriber of this._subscribers) {
             this._subscribers.delete(subscriber);
@@ -58,38 +58,43 @@ export class Subject {
         this.closed = true;
         this.disconnect();
     }
-    /** Connect this subjet to a source. */
+    /** Connect this subject to a source. */
     connect(source) {
         if (this.closed)
-            throw new ConditionError("Subject is closed");
+            throw new ConditionError(`Connectable is closed`);
         const unsubscribe = subscribe(source, this);
         const cleanup = () => {
-            this._cleanups.delete(cleanup);
+            this._connections.delete(cleanup);
             dispatch(unsubscribe);
         };
-        this._cleanups.add(cleanup);
+        this._connections.add(cleanup);
         return cleanup;
     }
     /** Disconnect this subject from all sources. */
     disconnect() {
-        for (const cleanup of this._cleanups)
+        for (const cleanup of this._connections)
             dispatch(cleanup); // Cleanups are self-cleaning.
     }
     /**
      * Subscribe to this subject and return an unsubscriber function.
-     * - Allows either an `Observer` object or  separate `next()`, `error()` and `complete()` functions.
+     * - Allows either an `Observer` object or  separate `next()", `error()` and `complete()` functions.
      * - Implements `Observable`
      */
-    subscribe(next) {
-        const observer = typeof next === "function" ? { next } : next;
+    subscribe(target) {
+        if (this.closed)
+            throw new ConditionError(`Observable is closed`);
+        const observer = typeof target === `function` ? { next: target } : target;
+        if (observer.closed)
+            throw new ConditionError("Target is closed");
         this._addObserver(observer);
         return this._removeObserver.bind(this, observer);
     }
     /** Add an observer (called by `subscribe()`). */
     _addObserver(observer) {
-        const size = this._subscribers.size;
+        const sizeBefore = this._subscribers.size;
         this._subscribers.add(observer);
-        if (!size && this._subscribers.size)
+        const sizeAfter = this._subscribers.size;
+        if (!sizeBefore && sizeAfter)
             this._addFirstObserver();
     }
     /** Called after adding the first observer. */
@@ -98,9 +103,10 @@ export class Subject {
     }
     /** Remove an observer. */
     _removeObserver(observer) {
-        const size = this._subscribers.size;
+        const sizeBefore = this._subscribers.size;
         this._subscribers.delete(observer);
-        if (size && !this._subscribers.size)
+        const sizeAfter = this._subscribers.size;
+        if (sizeBefore && !sizeAfter)
             this._removeLastObserver();
     }
     /** Called after adding the first observer. */

package/package.json

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

package/react/useSubscribe.js

@@ -12,5 +12,12 @@ import { BLACKHOLE } from "../util/function.js";
  */
 export function useSubscribe(subscribable) {
     const setState = useState(subscribable instanceof State && !subscribable.loading ? subscribable.value : NOVALUE)[1];
-    useEffect(subscribable ? () => subscribe(subscribable, { next: setState, error: setState }) : BLACKHOLE, [subscribable]);
+    useEffect(subscribable
+        ? () => {
+            // If the subscribable is an observer, only subscribe if the subscribable isn't closed.
+            // Otherwise `subscribe()` is likely to throw a `Observer is closed` error.
+            if (typeof subscribable === "function" || !subscribable.closed)
+                return subscribe(subscribable, { next: setState, error: setState });
+        }
+        : BLACKHOLE, [subscribable]);
 }

package/state/SelfClosingState.js

@@ -18,7 +18,10 @@ export class SelfClosingState extends State {
 export class DelayedSelfClosingState extends State {
     constructor(delay, ...args) {
         super(...args);
-        this._timeout = new Timeout(delay);
+        this._timeout = new Timeout(() => {
+            if (!this.closed)
+                this.complete();
+        }, delay);
     }
     // Override to clear the timeout when an observer is added.
     _addFirstObserver() {
@@ -26,9 +29,6 @@ export class DelayedSelfClosingState extends State {
     }
     // Override to close this state when the last observer is removed.
     _removeLastObserver() {
-        this._timeout.set(() => {
-            if (!this.closed)
-                this.complete();
-        });
+        this._timeout.set();
     }
 }

package/util/async.js

@@ -69,7 +69,7 @@ export async function callAsyncParallel(callback, items, ...args) {
 // Internal way for us to save `resolve()` and `reject()` from a new Promise used by `Deferred` and `ExtendablePromise`
 let resolve; // eslint-disable-line @typescript-eslint/no-explicit-any
 let reject;
-function saveResolveReject(x, // eslint-disable-line @typescript-eslint/no-explicit-any
+function _saveResolveReject(x, // eslint-disable-line @typescript-eslint/no-explicit-any
 y) {
     resolve = x;
     reject = y;
@@ -77,7 +77,7 @@ y) {
 /** Type of `Promise` with its `resolve()` and `reject()` methods exposed publicly. */
 export class Deferred extends Promise {
     constructor() {
-        super(saveResolveReject);
+        super(_saveResolveReject);
         this.resolve = resolve;
         this.reject = reject;
     }
@@ -90,7 +90,7 @@ export class Deferred extends Promise {
 /** Type of `Promise` with `._resolve()` and `._reject()` methods available. */
 export class AbstractPromise extends Promise {
     constructor() {
-        super(saveResolveReject);
+        super(_saveResolveReject);
         this._resolve = resolve;
         this._reject = reject;
     }

package/util/timeout.d.ts

@@ -1,3 +1,4 @@
+import type { Dispatch } from "./function.js";
 /**
  * Create a new Timeout.
  *
@@ -9,9 +10,10 @@
  * @param ms The default delay for any created timeouts (in ms).
  */
 export declare class Timeout {
+    private _callback;
     private _ms;
     private _timeout;
-    constructor(ms?: number);
+    constructor(callback?: Dispatch | null, ms?: number);
     /** Is a timeout currently set? */
     get exists(): boolean;
     /**
@@ -19,7 +21,8 @@ export declare class Timeout {
      * @param callback
      * @param ms The delay for this timeout (in ms).
      */
-    set(callback: () => void, ms?: number): void;
+    set(callback?: Dispatch | null, ms?: number): void;
+    private _run;
     /** Cancel any existing timeout.. */
     clear(): void;
 }

package/util/timeout.js

@@ -9,8 +9,14 @@
  * @param ms The default delay for any created timeouts (in ms).
  */
 export class Timeout {
-    constructor(ms = 0) {
-        this._timeout = undefined;
+    constructor(callback = null, ms = 0) {
+        this._timeout = null;
+        this._run = () => {
+            this._timeout = null;
+            if (this._callback)
+                this._callback();
+        };
+        this._callback = callback;
         this._ms = ms;
     }
     /** Is a timeout currently set? */
@@ -22,16 +28,22 @@ export class Timeout {
      * @param callback
      * @param ms The delay for this timeout (in ms).
      */
-    set(callback, ms = this._ms) {
+    set(callback = this._callback, ms = this._ms) {
         this.clear();
-        this._timeout = setTimeout(() => {
-            this._timeout = undefined;
-            callback();
-        }, ms);
+        this._timeout = setTimeout(_executeTimeout, ms, this, callback);
     }
     /** Cancel any existing timeout.. */
     clear() {
-        if (this._timeout)
-            this._timeout = void clearTimeout(this._timeout);
+        const timeout = this._timeout;
+        if (timeout) {
+            this._timeout = null;
+            clearTimeout(timeout);
+        }
     }
 }
+/** Actually execute the timeout. */
+function _executeTimeout(timeout, callback) {
+    timeout.clear();
+    if (callback)
+        callback();
+}