shelving 1.112.1 → 1.114.0

package/db/ItemStore.d.ts

@@ -4,9 +4,9 @@ import type { DataKey, Database } from "../util/data.js";
 import type { Item, OptionalItem } from "../util/item.js";
 import type { Stop } from "../util/start.js";
 import { BooleanStore } from "../store/BooleanStore.js";
-import { LazyStore } from "../store/LazyStore.js";
+import { Store } from "../store/Store.js";
 /** Store a single item. */
-export declare class ItemStore<T extends Database, K extends DataKey<T>> extends LazyStore<OptionalItem<T[K]>> {
+export declare class ItemStore<T extends Database, K extends DataKey<T>> extends Store<OptionalItem<T[K]>> {
     readonly provider: AbstractProvider<T>;
     readonly collection: K;
     readonly id: string;

package/db/ItemStore.js

@@ -1,11 +1,11 @@
 import { BooleanStore } from "../store/BooleanStore.js";
-import { LazyStore } from "../store/LazyStore.js";
+import { Store } from "../store/Store.js";
 import { NONE } from "../util/constants.js";
 import { getItem } from "../util/item.js";
 import { getRequired } from "../util/optional.js";
 import { runSequence } from "../util/sequence.js";
 /** Store a single item. */
-export class ItemStore extends LazyStore {
+export class ItemStore extends Store {
     provider;
     collection;
     id;
@@ -25,8 +25,8 @@ export class ItemStore extends LazyStore {
     constructor(collection, id, provider, memory) {
         const time = memory?.getItemTime(collection, id);
         const item = memory?.getItem(collection, id);
-        super(store => memory && runSequence(store.through(memory.getCachedItemSequence(collection, id))), typeof time === "number" || item ? item : NONE, // Use the cached value if it was definitely cached or is not undefined.
-        time);
+        super(typeof time === "number" || item ? item : NONE, // Use the cached value if it was definitely cached or is not undefined.
+        time, memory && (store => runSequence(store.through(memory.getCachedItemSequence(collection, id)))));
         this.provider = provider;
         this.collection = collection;
         this.id = id;

package/db/QueryStore.d.ts

@@ -4,9 +4,9 @@ import type { DataKey, Database } from "../util/data.js";
 import type { Item, ItemQuery, Items, OptionalItem } from "../util/item.js";
 import type { Stop } from "../util/start.js";
 import { BooleanStore } from "../store/BooleanStore.js";
-import { LazyStore } from "../store/LazyStore.js";
+import { Store } from "../store/Store.js";
 /** Store a set of multiple items. */
-export declare class QueryStore<T extends Database, K extends DataKey<T>> extends LazyStore<Items<T[K]>> implements Iterable<Item<T[K]>> {
+export declare class QueryStore<T extends Database, K extends DataKey<T>> extends Store<Items<T[K]>> implements Iterable<Item<T[K]>> {
     readonly provider: AbstractProvider<T>;
     readonly collection: K;
     readonly query: ItemQuery<T[K]>;

package/db/QueryStore.js

@@ -1,11 +1,11 @@
 import { BooleanStore } from "../store/BooleanStore.js";
-import { LazyStore } from "../store/LazyStore.js";
+import { Store } from "../store/Store.js";
 import { getFirstItem, getLastItem, getOptionalFirstItem, getOptionalLastItem } from "../util/array.js";
 import { NONE } from "../util/constants.js";
 import { getAfterQuery, getLimit } from "../util/query.js";
 import { runSequence } from "../util/sequence.js";
 /** Store a set of multiple items. */
-export class QueryStore extends LazyStore {
+export class QueryStore extends Store {
     provider;
     collection;
     query;
@@ -43,8 +43,8 @@ export class QueryStore extends LazyStore {
     constructor(collection, query, provider, memory) {
         const time = memory?.getQueryTime(collection, query);
         const items = memory?.getQuery(collection, query) || [];
-        super(store => memory && runSequence(store.through(memory.getCachedQuerySequence(collection, query))), typeof time === "number" || items.length ? items : NONE, // Use the value if it was definitely cached or is not empty.
-        time);
+        super(typeof time === "number" || items.length ? items : NONE, // Use the value if it was definitely cached or is not empty.
+        time, memory && (store => runSequence(store.through(memory.getCachedQuerySequence(collection, query)))));
         this.provider = provider;
         this.collection = collection;
         this.query = query;

package/package.json

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

package/store/ArrayStore.d.ts

@@ -1,8 +1,9 @@
 import type { ImmutableArray } from "../util/array.js";
+import type { PossibleStarter } from "../util/start.js";
 import { Store } from "./Store.js";
 /** Store an array. */
 export declare class ArrayStore<T> extends Store<ImmutableArray<T>> implements Iterable<T> {
-    constructor(value?: ImmutableArray<T>, time?: number);
+    constructor(value?: ImmutableArray<T>, time?: number, start?: PossibleStarter<[Store<ImmutableArray<T>>]>);
     /** Get the length of the current value of this store. */
     get count(): number;
     /** Add items to this array. */

package/store/ArrayStore.js

@@ -2,8 +2,8 @@ import { omitArrayItems, toggleArrayItems, withArrayItems } from "../util/array.
 import { Store } from "./Store.js";
 /** Store an array. */
 export class ArrayStore extends Store {
-    constructor(value = [], time) {
-        super(value, time);
+    constructor(value = [], time, start) {
+        super(value, time, start);
     }
     /** Get the length of the current value of this store. */
     get count() {

package/store/BooleanStore.d.ts

@@ -1,8 +1,9 @@
 import type { NONE } from "../util/constants.js";
+import type { PossibleStarter } from "../util/start.js";
 import { Store } from "./Store.js";
 /** Store a boolean. */
 export declare class BooleanStore extends Store<boolean> {
-    constructor(value?: boolean | typeof NONE, time?: number);
+    constructor(value?: boolean | typeof NONE, time?: number, start?: PossibleStarter<[Store<boolean>]>);
     /** Toggle the current boolean value. */
     toggle(): void;
 }

package/store/BooleanStore.js

@@ -1,8 +1,8 @@
 import { Store } from "./Store.js";
 /** Store a boolean. */
 export class BooleanStore extends Store {
-    constructor(value = false, time) {
-        super(value, time);
+    constructor(value = false, time, start) {
+        super(value, time, start);
     }
     /** Toggle the current boolean value. */
     toggle() {

package/store/DictionaryStore.d.ts

@@ -1,9 +1,10 @@
 import type { DictionaryItem, ImmutableDictionary } from "../util/dictionary.js";
+import type { PossibleStarter } from "../util/start.js";
 import type { Updates } from "../util/update.js";
 import { Store } from "./Store.js";
 /** Store a dictionary object. */
 export declare class DictionaryStore<T> extends Store<ImmutableDictionary<T>> implements Iterable<DictionaryItem<T>> {
-    constructor(value?: ImmutableDictionary<T>, time?: number);
+    constructor(value?: ImmutableDictionary<T>, time?: number, start?: PossibleStarter<[Store<ImmutableDictionary<T>>]>);
     /** Get the length of the current value of this store. */
     get count(): number;
     /** Set a named entry in this object with a different value. */

package/store/DictionaryStore.js

@@ -4,8 +4,8 @@ import { updateData } from "../util/update.js";
 import { Store } from "./Store.js";
 /** Store a dictionary object. */
 export class DictionaryStore extends Store {
-    constructor(value = {}, time) {
-        super(value, time);
+    constructor(value = {}, time, start) {
+        super(value, time, start);
     }
     /** Get the length of the current value of this store. */
     get count() {

package/store/PathStore.d.ts

@@ -0,0 +1,14 @@
+import type { AbsolutePath, Path } from "../util/path.js";
+import type { PossibleStarter } from "../util/start.js";
+import { Store } from "./Store.js";
+/** Store an absolute path, e.g. `/a/b/c` */
+export declare class PathStore extends Store<AbsolutePath> {
+    constructor(path?: AbsolutePath, time?: number, start?: PossibleStarter<[Store<AbsolutePath>]>);
+    /** Based on the current store path, is a path active? */
+    isActive(path: AbsolutePath): boolean;
+    /** Based on the current store path, is a path proud (i.e. a child of the current store path)? */
+    isProud(path: AbsolutePath): boolean;
+    /** Get an absolute path from a path relative to the current navigation path. */
+    getAbsolute(path: Path): AbsolutePath;
+    set(path: Path): void;
+}

package/store/PathStore.js

@@ -0,0 +1,24 @@
+import { getAbsolutePath, isPathActive, isPathProud } from "../util/path.js";
+import { Store } from "./Store.js";
+/** Store an absolute path, e.g. `/a/b/c` */
+export class PathStore extends Store {
+    constructor(path = window.location.pathname, time, start) {
+        super(path, time, start);
+    }
+    /** Based on the current store path, is a path active? */
+    isActive(path) {
+        return isPathActive(path, this.value);
+    }
+    /** Based on the current store path, is a path proud (i.e. a child of the current store path)? */
+    isProud(path) {
+        return isPathProud(path, this.value);
+    }
+    /** Get an absolute path from a path relative to the current navigation path. */
+    getAbsolute(path) {
+        return getAbsolutePath(path, this.value);
+    }
+    // Override to clean the path.
+    set(path) {
+        super.set(getAbsolutePath(path, this.value));
+    }
+}

package/store/Store.d.ts

@@ -1,5 +1,6 @@
 import { DeferredSequence } from "../sequence/DeferredSequence.js";
 import { NONE } from "../util/constants.js";
+import { type PossibleStarter } from "../util/start.js";
 /** Any `Store` instance. */
 export type AnyStore = Store<any>;
 /**
@@ -30,11 +31,13 @@ export declare class Store<T> implements AsyncIterable<T> {
     get reason(): unknown;
     set reason(reason: unknown);
     private _reason;
+    private _starter;
     /** Store is initiated with an initial store. */
-    constructor(value: T | typeof NONE, time?: number);
+    constructor(value: T | typeof NONE, time?: number, start?: PossibleStarter<[Store<T>]>);
     /** Set the value of the store. */
     set(next: T): void;
     /** Set the value of the store as values are pulled from a sequence. */
     through(sequence: AsyncIterable<T>): AsyncIterable<T>;
     [Symbol.asyncIterator](): AsyncGenerator<T, void, void>;
+    private _iterating;
 }

package/store/Store.js

@@ -1,5 +1,6 @@
 import { DeferredSequence } from "../sequence/DeferredSequence.js";
 import { NONE } from "../util/constants.js";
+import { getStarter } from "../util/start.js";
 /**
  * Store that retains its most recent value and is async-iterable to allow values to be observed.
  * - Current value can be read at `store.value` and `store.data`
@@ -55,10 +56,12 @@ export class Store {
         }
     }
     _reason = undefined;
+    _starter;
     /** Store is initiated with an initial store. */
-    constructor(value, time = Date.now()) {
+    constructor(value, time = Date.now(), start) {
         this._value = value;
         this._time = time;
+        this._starter = start && getStarter(start);
     }
     /** Set the value of the store. */
     set(next) {
@@ -75,8 +78,18 @@ export class Store {
     // Issues the current value of the store first, then any subsequent values that are issued.
     async *[Symbol.asyncIterator]() {
         await Promise.resolve(); // Introduce a slight delay, i.e. don't immediately yield `this.value` in case it is changed synchronously.
-        if (!this.loading)
-            yield this.value;
-        yield* this.next;
+        this._starter?.start(this);
+        this._iterating++;
+        try {
+            if (!this.loading)
+                yield this.value;
+            yield* this.next;
+        }
+        finally {
+            this._iterating--;
+            if (this._iterating < 1)
+                this._starter?.stop();
+        }
     }
+    _iterating = 0;
 }

package/store/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./Store.js";
-export * from "./LazyStore.js";
 export * from "./ArrayStore.js";
 export * from "./BooleanStore.js";
 export * from "./DataStore.js";
+export * from "./PathStore.js";
 export * from "./DictionaryStore.js";

package/store/index.js

@@ -1,6 +1,6 @@
 export * from "./Store.js";
-export * from "./LazyStore.js";
 export * from "./ArrayStore.js";
 export * from "./BooleanStore.js";
 export * from "./DataStore.js";
+export * from "./PathStore.js";
 export * from "./DictionaryStore.js";

package/util/index.d.ts

@@ -18,7 +18,6 @@ export * from "./equal.js";
 export * from "./error.js";
 export * from "./focus.js";
 export * from "./function.js";
-export * from "./start.js";
 export * from "./hash.js";
 export * from "./hydrate.js";
 export * from "./item.js";
@@ -32,6 +31,7 @@ export * from "./null.js";
 export * from "./number.js";
 export * from "./object.js";
 export * from "./optional.js";
+export * from "./path.js";
 export * from "./query.js";
 export * from "./random.js";
 export * from "./regexp.js";
@@ -39,6 +39,7 @@ export * from "./sequence.js";
 export * from "./serialise.js";
 export * from "./sort.js";
 export * from "./source.js";
+export * from "./start.js";
 export * from "./string.js";
 export * from "./template.js";
 export * from "./time.js";

package/util/index.js

@@ -18,7 +18,6 @@ export * from "./equal.js";
 export * from "./error.js";
 export * from "./focus.js";
 export * from "./function.js";
-export * from "./start.js";
 export * from "./hash.js";
 export * from "./hydrate.js";
 export * from "./item.js";
@@ -32,6 +31,7 @@ export * from "./null.js";
 export * from "./number.js";
 export * from "./object.js";
 export * from "./optional.js";
+export * from "./path.js";
 export * from "./query.js";
 export * from "./random.js";
 export * from "./regexp.js";
@@ -39,6 +39,7 @@ export * from "./sequence.js";
 export * from "./serialise.js";
 export * from "./sort.js";
 export * from "./source.js";
+export * from "./start.js";
 export * from "./string.js";
 export * from "./template.js";
 export * from "./time.js";

package/util/path.d.ts

@@ -0,0 +1,26 @@
+/** Relative path starts with `./` or `../` */
+export type RelativePath = `./${string}` | `../${string}`;
+/** Absolute path starts with `/` slash. */
+export type AbsolutePath = `/${string}`;
+/** Path is either an absolute or relative path. */
+export type Path = AbsolutePath | RelativePath;
+/** Is a string path an absolute path? */
+export declare const isAbsolutePath: (path: string) => path is `/${string}`;
+/** Is a string path an absolute path? */
+export declare const isRelativePath: (path: string) => path is RelativePath;
+/**
+ * Clean a path.
+ * - Remove runs of more than one slash, e.g. `/a//b` becomes `/a/b`
+ * - Remove trailing slashes, e.g. `/a/b/` becomes `/a/b`
+ */
+export declare function cleanPath(path: AbsolutePath): AbsolutePath;
+export declare function cleanPath(path: string): string;
+/**
+ * Get an absolute path.
+ * @return Absolute path with a leading trailing slash, e.g. `/a/c/b`
+ */
+export declare function getAbsolutePath(path: Path, base?: AbsolutePath): AbsolutePath;
+/** Is a target path active? */
+export declare function isPathActive(target: AbsolutePath, current: AbsolutePath): boolean;
+/** Is a target path proud (i.e. is the current path, or is a child of the current path)? */
+export declare function isPathProud(target: AbsolutePath, current: AbsolutePath): boolean;

package/util/path.js

@@ -0,0 +1,30 @@
+import { AssertionError } from "../error/AssertionError.js";
+/** Is a string path an absolute path? */
+export const isAbsolutePath = (path) => path.startsWith("/");
+/** Is a string path an absolute path? */
+export const isRelativePath = (path) => path.startsWith("./") || path.startsWith("../");
+export function cleanPath(path) {
+    return path
+        .replace(/\/{2,}/g, "/") // Normalise runs of two or more slashes.
+        .replace(/(?!^)\/+$/g, ""); // Trailing slashes.
+}
+/**
+ * Get an absolute path.
+ * @return Absolute path with a leading trailing slash, e.g. `/a/c/b`
+ */
+export function getAbsolutePath(path, base = "/") {
+    try {
+        return cleanPath(new URL(path, `http://j.com${base}/`).pathname);
+    }
+    catch {
+        throw new AssertionError("Invalid path", path);
+    }
+}
+/** Is a target path active? */
+export function isPathActive(target, current) {
+    return target === current;
+}
+/** Is a target path proud (i.e. is the current path, or is a child of the current path)? */
+export function isPathProud(target, current) {
+    return target === current || (target !== "/" && target.startsWith(`${current}/`));
+}

package/util/start.d.ts

@@ -8,7 +8,7 @@ export type Stop = () => void;
  * Wrapper class to handle state on start/stop callback process.
  * - If process has already started, `starter.start()` won't be called twice (including if `start()` didn't return a `stop()` callback).
  */
-export declare class Starter<T extends Arguments = []> implements Disposable {
+export declare class Starter<T extends Arguments> implements Disposable {
     private readonly _start;
     private _stop;
     constructor(start: Start<T>);
@@ -16,3 +16,7 @@ export declare class Starter<T extends Arguments = []> implements Disposable {
     stop(): void;
     [Symbol.dispose](): void;
 }
+/** Something that can be made into a `Starter` */
+export type PossibleStarter<T extends Arguments> = Start<T> | Starter<T>;
+/** Get a `Starter` from a `PossibleStarter` */
+export declare function getStarter<T extends Arguments>(start: Start<T> | Starter<T>): Starter<T>;

package/util/start.js

@@ -24,3 +24,7 @@ export class Starter {
         this.stop();
     }
 }
+/** Get a `Starter` from a `PossibleStarter` */
+export function getStarter(start) {
+    return typeof start === "function" ? new Starter(start) : start;
+}

package/util/string.d.ts

@@ -62,7 +62,7 @@ export declare const sanitizeLines: (str: string) => string;
  * Simplify a string by removing anything that isn't a number, letter, or space.
  * - Used when you're running a query against a string entered by a user.
  *
- * @example normalizeString("Däve-is\nREALLY    éxcitable—apparęntly!!!    😂"); // Returns "dave is really excitable apparently"
+ * @example simplifyString("Däve-is\nREALLY    éxcitable—apparęntly!!!    😂"); // Returns "dave is really excitable apparently"
  *
  * @todo Convert letter-like characters (e.g. `ℝ`) to their ASCII equivalent (e.g. `R`).
  */

package/util/string.js

@@ -98,7 +98,7 @@ export const sanitizeLines = (str) => str
  * Simplify a string by removing anything that isn't a number, letter, or space.
  * - Used when you're running a query against a string entered by a user.
  *
- * @example normalizeString("Däve-is\nREALLY    éxcitable—apparęntly!!!    😂"); // Returns "dave is really excitable apparently"
+ * @example simplifyString("Däve-is\nREALLY    éxcitable—apparęntly!!!    😂"); // Returns "dave is really excitable apparently"
  *
  * @todo Convert letter-like characters (e.g. `ℝ`) to their ASCII equivalent (e.g. `R`).
  */

package/store/LazyStore.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import type { NONE } from "../util/constants.js";
-import { type Start } from "../util/start.js";
-import { Store } from "./Store.js";
-/** Store that starts/stops a source subscription when things subscribe to it, and stops when everything has unsubscribed from it. */
-export declare class LazyStore<T> extends Store<T> implements Disposable {
-    private _iterating;
-    private readonly _starter;
-    constructor(start: Start<[Store<T>]>, value: T | typeof NONE, time?: number);
-    [Symbol.asyncIterator](): AsyncGenerator<T, void, void>;
-    [Symbol.dispose](): void;
-}

package/store/LazyStore.js

@@ -1,26 +0,0 @@
-import { Starter } from "../util/start.js";
-import { Store } from "./Store.js";
-/** Store that starts/stops a source subscription when things subscribe to it, and stops when everything has unsubscribed from it. */
-export class LazyStore extends Store {
-    _iterating = 0;
-    _starter;
-    constructor(start, value, time) {
-        super(value, time);
-        this._starter = new Starter(start);
-    }
-    async *[Symbol.asyncIterator]() {
-        this._starter.start(this);
-        this._iterating++;
-        try {
-            yield* super[Symbol.asyncIterator]();
-        }
-        finally {
-            this._iterating--;
-            if (this._iterating < 1)
-                this._starter.stop();
-        }
-    }
-    [Symbol.dispose]() {
-        this._starter[Symbol.dispose]();
-    }
-}