shelving 1.89.6 → 1.90.0

package/package.json

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

package/state/DataState.d.ts

@@ -1,21 +1,33 @@
-import { Data, OptionalData } from "../util/data.js";
-import { Transformers } from "../util/transform.js";
+import { Data, DataKey } from "../util/data.js";
+import { Transformers, Transformer } from "../util/transform.js";
 import { State } from "./State.js";
 /** State that stores a data object and has additional methods to help with that. */
 export declare class DataState<T extends Data> extends State<T> {
     /** Get the data value of this state. */
     get data(): T;
+    /** Update a single named prop in this data. */
+    getProp<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;
+    /** Update a single named prop in this data. */
+    updateProp<K extends DataKey<T>>(name: K, update: Transformer<T[K], T[K]>): void;
     /** Update several props in this data. */
     update(updates: Transformers<T>): void;
 }
 /** State that stores an optional data object and has additional methods to help with that. */
-export declare class OptionalDataState<T extends Data> extends State<OptionalData<T>> {
+export declare class OptionalDataState<T extends Data> extends State<T | null> {
     /** Get current data value of this state (or throw `Promise` that resolves to the next required value). */
     get data(): T;
     /** Does the data exist or not? */
     get exists(): boolean;
     /** Update several props in this data. */
     update(updates: Transformers<T>): void;
+    /** Update a single named prop in this data. */
+    getProp<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;
+    /** Update a single named prop in this data. */
+    updateProp<K extends DataKey<T>>(name: K, update: Transformer<T[K], T[K]>): void;
     /** Set the data to `null`. */
     unset(): void;
 }

package/state/DataState.js

@@ -1,5 +1,6 @@
+import { withProp } from "../util/object.js";
 import { getData } from "../util/data.js";
-import { transformObject } from "../util/transform.js";
+import { transform, transformObject } from "../util/transform.js";
 import { State } from "./State.js";
 /** State that stores a data object and has additional methods to help with that. */
 export class DataState extends State {
@@ -7,6 +8,19 @@ export class DataState extends State {
     get data() {
         return this.value;
     }
+    /** Update a single named prop in this data. */
+    getProp(name) {
+        return this.data[name];
+    }
+    /** Update a single named prop in this data. */
+    setProp(name, value) {
+        this.set(withProp(this.data, name, value));
+    }
+    /** Update a single named prop in this data. */
+    updateProp(name, update) {
+        const data = this.data;
+        this.set(withProp(data, name, transform(data[name], update)));
+    }
     /** Update several props in this data. */
     update(updates) {
         this.set(transformObject(this.data, updates));
@@ -26,6 +40,19 @@ export class OptionalDataState extends State {
     update(updates) {
         this.set(transformObject(this.data, updates));
     }
+    /** Update a single named prop in this data. */
+    getProp(name) {
+        return this.data[name];
+    }
+    /** Update a single named prop in this data. */
+    setProp(name, value) {
+        this.set(withProp(this.data, name, value));
+    }
+    /** Update a single named prop in this data. */
+    updateProp(name, update) {
+        const data = this.data;
+        this.set(withProp(data, name, transform(data[name], update)));
+    }
     /** Set the data to `null`. */
     unset() {
         this.set(null);

package/state/DictionaryState.d.ts

@@ -1,5 +1,5 @@
 import { DictionaryItem, ImmutableDictionary } from "../util/dictionary.js";
-import { Transformers } from "../util/transform.js";
+import { Transformer, Transformers } from "../util/transform.js";
 import { State } from "./State.js";
 /** State that stores a dictionary object and has additional methods to help with that. */
 export declare class DictionaryState<T> extends State<ImmutableDictionary<T>> implements Iterable<DictionaryItem<T>> {
@@ -10,6 +10,12 @@ export declare class DictionaryState<T> extends State<ImmutableDictionary<T>> im
     update(updates: Transformers<ImmutableDictionary<T>>): void;
     /** Remove a named entry from this object. */
     delete(...keys: string[]): void;
+    /** Update a single named prop in this data. */
+    getItem(name: string): T | undefined;
+    /** Update a single named prop in this data. */
+    setItem(name: string, value: T): void;
+    /** Update a single named prop in this data. */
+    updateItem(name: string, update: Transformer<T | undefined, T>): void;
     /** Iterate over the entries of the object. */
     [Symbol.iterator](): Iterator<DictionaryItem<T>>;
 }

package/state/DictionaryState.js

@@ -1,5 +1,6 @@
+import { withProp } from "../util/object.js";
 import { omitDictionaryItems } from "../util/dictionary.js";
-import { transformDictionary } from "../util/transform.js";
+import { transform, transformDictionary } from "../util/transform.js";
 import { State } from "./State.js";
 /** State that stores a dictionary object and has additional methods to help with that. */
 export class DictionaryState extends State {
@@ -18,6 +19,19 @@ export class DictionaryState extends State {
     delete(...keys) {
         this.set(omitDictionaryItems(this.value, ...keys));
     }
+    /** Update a single named prop in this data. */
+    getItem(name) {
+        return this.value[name];
+    }
+    /** Update a single named prop in this data. */
+    setItem(name, value) {
+        this.set(withProp(this.value, name, value));
+    }
+    /** Update a single named prop in this data. */
+    updateItem(name, update) {
+        const value = this.value;
+        this.set(withProp(value, name, transform(value[name], update)));
+    }
     /** Iterate over the entries of the object. */
     [Symbol.iterator]() {
         return Object.entries(this.value)[Symbol.iterator]();