shelving 1.150.6 → 1.150.7

package/package.json

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

package/store/DataStore.d.ts

@@ -23,14 +23,14 @@ export declare class OptionalDataStore<T extends Data> extends Store<T | undefin
     set data(data: T);
     /** Does the data exist or not? */
     get exists(): boolean;
-    /** Return the data for this data store, or throw `RequiredError` if it is not set. */
-    requireData(caller?: AnyCaller): T;
+    /** Require the data for this data store, or throw `RequiredError` if it is not set. */
+    require(caller?: AnyCaller): T;
     /** Update several props in this data. */
     update(updates: Updates<T>): void;
     /** Update a single named prop in this data. */
-    getProp<K extends DataKey<T>>(name: K): T[K];
+    get<K extends DataKey<T>>(name: K): T[K];
     /** Update a single named prop in this data. */
-    setProp<K extends DataKey<T>>(name: K, value: T[K]): void;
+    set<K extends DataKey<T>>(name: K, value: T[K]): void;
     /** Set the data to `undefined`. */
-    unset(): void;
+    delete(): void;
 }

package/store/DataStore.js

@@ -30,7 +30,7 @@ export class DataStore extends Store {
 export class OptionalDataStore extends Store {
     /** Get current data value of this store (or throw `Promise` that resolves to the next required value). */
     get data() {
-        return this.requireData(getGetter(this, "data"));
+        return this.require(getGetter(this, "data"));
     }
     /** Set the data of this store. */
     set data(data) {
@@ -40,8 +40,8 @@ export class OptionalDataStore extends Store {
     get exists() {
         return !!this.value;
     }
-    /** Return the data for this data store, or throw `RequiredError` if it is not set. */
-    requireData(caller = this.requireData) {
+    /** Require the data for this data store, or throw `RequiredError` if it is not set. */
+    require(caller = this.require) {
         const data = this.value;
         if (!data)
             throw new RequiredError("Data is empty", { caller });
@@ -49,18 +49,18 @@ export class OptionalDataStore extends Store {
     }
     /** Update several props in this data. */
     update(updates) {
-        this.value = updateData(this.requireData(this.update), updates);
+        this.value = updateData(this.require(this.update), updates);
     }
     /** Update a single named prop in this data. */
-    getProp(name) {
-        return this.requireData(this.getProp)[name];
+    get(name) {
+        return this.require(this.get)[name];
     }
     /** Update a single named prop in this data. */
-    setProp(name, value) {
-        this.value = withProp(this.requireData(this.setProp), name, value);
+    set(name, value) {
+        this.value = withProp(this.require(this.set), name, value);
     }
     /** Set the data to `undefined`. */
-    unset() {
+    delete() {
         this.value = undefined;
     }
 }

package/store/DictionaryStore.d.ts

@@ -9,11 +9,11 @@ export declare class DictionaryStore<T> extends Store<ImmutableDictionary<T>> im
     /** Set a named entry in this object with a different value. */
     update(updates: Updates<ImmutableDictionary<T>>): void;
     /** Remove a named entry from this object. */
-    delete(...keys: string[]): void;
+    deleteItems(...keys: string[]): void;
     /** Get an item in this dictionary. */
-    getItem(name: string): T | undefined;
+    get(name: string): T | undefined;
     /** Set an item in this dictionary. */
-    setItem(name: string, value: T): void;
+    set(name: string, value: T): void;
     /** Iterate over the entries of the object. */
     [Symbol.iterator](): Iterator<DictionaryItem<T>>;
 }

package/store/DictionaryStore.js

@@ -16,15 +16,15 @@ export class DictionaryStore extends Store {
         this.value = updateData(this.value, updates);
     }
     /** Remove a named entry from this object. */
-    delete(...keys) {
+    deleteItems(...keys) {
         this.value = omitDictionaryItems(this.value, ...keys);
     }
     /** Get an item in this dictionary. */
-    getItem(name) {
+    get(name) {
         return this.value[name];
     }
     /** Set an item in this dictionary. */
-    setItem(name, value) {
+    set(name, value) {
         this.value = withProp(this.value, name, value);
     }
     /** Iterate over the entries of the object. */

package/store/PathStore.d.ts

@@ -3,11 +3,12 @@ import { Store } from "./Store.js";
 /** Store an absolute path, e.g. `/a/b/c` */
 export declare class PathStore extends Store<AbsolutePath> {
     constructor(path?: string, time?: number);
+    get value(): AbsolutePath;
+    set value(path: string);
     /** 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 store path. */
     getPath(path: string): AbsolutePath;
-    set(path: string): void;
 }

package/store/PathStore.js

@@ -5,6 +5,13 @@ export class PathStore extends Store {
     constructor(path = ".", time) {
         super(requirePath(path), time);
     }
+    // Override to clean the path on set.
+    get value() {
+        return super.value;
+    }
+    set value(path) {
+        super.value = requirePath(path, super.value);
+    }
     /** Based on the current store path, is a path active? */
     isActive(path) {
         return isPathActive(this.value, path);
@@ -17,8 +24,4 @@ export class PathStore extends Store {
     getPath(path) {
         return requirePath(path, this.value);
     }
-    // Override to clean the path.
-    set(path) {
-        super.set(requirePath(path, this.value));
-    }
 }

package/store/Store.d.ts

@@ -36,8 +36,6 @@ export declare class Store<T> implements AsyncIterable<T> {
     private _starter;
     /** Store is initiated with an initial store. */
     constructor(value: T | typeof NONE, time?: number);
-    /** 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>;

package/store/Store.js

@@ -70,10 +70,6 @@ export class Store {
         this._value = value;
         this._time = time;
     }
-    /** Set the value of the store. */
-    set(next) {
-        this.value = next;
-    }
     /** Set the value of the store as values are pulled from a sequence. */
     async *through(sequence) {
         for await (const value of sequence) {