shelving 1.49.2 → 1.49.3

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.49.2",
+	"version": "1.49.3",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -25,9 +25,9 @@
 		"./db": "./db/index.js",
 		"./error": "./error/index.js",
 		"./feedback": "./feedback/index.js",
-		"./firestore/client": "./firestore-client/index.js",
-		"./firestore/lite": "./firestore-lite/index.js",
-		"./firestore/server": "./firestore-server/index.js",
+		"./firestore/client": "./firestore/client/index.js",
+		"./firestore/lite": "./firestore/lite/index.js",
+		"./firestore/server": "./firestore/server/index.js",
 		"./markup": "./markup/index.js",
 		"./provider": "./provider/index.js",
 		"./query": "./query/index.js",

package/stream/DataState.js

@@ -1,4 +1,4 @@
-import { withProp, transformProps, NOERROR, LOADING, awaitNext, getData } from "../util/index.js";
+import { withProp, transformData, NOERROR, LOADING, awaitNext, getData } from "../util/index.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 {
@@ -12,7 +12,7 @@ export class DataState extends State {
     }
     /** Update several props in this object. */
     update(updates) {
-        this.next(transformProps(this.data, updates));
+        this.next(transformData(this.data, updates));
     }
 }
 /** State that stores an optional data object and has additional methods to help with that. */
@@ -35,7 +35,7 @@ export class ResultState extends State {
     }
     /** Update several props in this object. */
     update(updates) {
-        this.next(transformProps(this.data, updates));
+        this.next(transformData(this.data, updates));
     }
     /** Delete this result. */
     delete() {

package/update/DataUpdate.js

@@ -1,4 +1,4 @@
-import { transformProps, isNullish } from "../util/index.js";
+import { transformData, isNullish } from "../util/index.js";
 import { Update } from "./Update.js";
 /** Update that can be applied to a data object to update its props. */
 export class DataUpdate extends Update {
@@ -11,7 +11,7 @@ export class DataUpdate extends Update {
         return new DataUpdate(!isNullish(key) ? { [key]: value } : {});
     }
     transform(existing) {
-        return transformProps(existing, this.updates);
+        return transformData(existing, this.updates);
     }
     /** Return a data update with a specific prop marked for update. */
     with(key, value) {

package/util/transform.d.ts

@@ -1,4 +1,3 @@
-import type { Entry } from "./entry.js";
 import type { ArrayType, ImmutableArray } from "./array.js";
 import type { ImmutableMap } from "./map.js";
 import { ImmutableObject } from "./object.js";
@@ -35,12 +34,6 @@ export declare function yieldTransformed<I, O>(items: Iterable<I>, transformer:
 export declare function transformArray<T extends ImmutableArray>(arr: T, transformer: Transformer<ArrayType<T>, ArrayType<T>>): T;
 export declare function transformArray<I, O>(arr: Iterable<I>, transformer: (v: I) => O): ImmutableArray<O>;
 export declare function transformArray<I, O>(arr: Iterable<I>, transformer: Transformer<I, O>): ImmutableArray<O>;
-/**
- * Transform the _values_ of a set of entries using a transformer.
- * @yield Transformed entry after calling transforming the new value for each entry.
- */
-export declare function yieldTransformedValues<I, O>(entries: Iterable<Entry<I>>, transformer: (v: I) => O): Iterable<Entry<O>>;
-export declare function yieldTransformedValues<I, O>(entries: Iterable<Entry<I>>, transformer: Transformer<I, O>): Iterable<Entry<O>>;
 /**
  * Transform the _values_ of a map using a transformer.
  * @return New map after transforming its values.
@@ -65,7 +58,7 @@ export declare type PropTransformers<T extends Data> = {
  * Transform the props of a data object using a set of transformers for its props.
  * @returns New object with changed props (or the same object if no changes were made).
  */
-export declare function transformProps<T extends Data>(existing: T, transformers: PropTransformers<T>): T;
+export declare function transformData<T extends Data>(existing: T, transformers: PropTransformers<T>): T;
 /** Set of named transformers for a a map-like object. */
 export declare type EntryTransformers<T> = ImmutableObject<Transformer<T | undefined, T>>;
 /** Transform some of the entries of a map-like object using a set of named transformers. */

package/util/transform.js

@@ -16,18 +16,18 @@ export function* yieldTransformed(items, transformer) {
 export function transformArray(arr, transformer) {
     return Array.from(yieldTransformed(arr, transformer));
 }
-export function* yieldTransformedValues(entries, transformer) {
+function* _yieldTransformedValues(entries, transformer) {
     for (const [k, v] of entries)
         yield [k, transform(v, transformer)];
 }
 export function transformMap(map, transformer) {
-    return new Map(yieldTransformedValues(map, transformer));
+    return new Map(_yieldTransformedValues(map, transformer));
 }
 export function transformObject(obj, transformer) {
-    return Object.fromEntries(yieldTransformedValues(Object.entries(obj), transformer));
+    return Object.fromEntries(_yieldTransformedValues(Object.entries(obj), transformer));
 }
 /** Apply transformers to the props of a data object and yield any props that changed. */
-function* yieldTransformedProps(existing, transformers) {
+function* _yieldTransformedProps(existing, transformers) {
     for (const [k, v] of toProps(transformers))
         yield [k, transform(existing[k], v)];
 }
@@ -35,15 +35,15 @@ function* yieldTransformedProps(existing, transformers) {
  * Transform the props of a data object using a set of transformers for its props.
  * @returns New object with changed props (or the same object if no changes were made).
  */
-export function transformProps(existing, transformers) {
-    return Object.fromEntries(yieldMerged(toProps(existing), yieldTransformedProps(existing, transformers)));
+export function transformData(existing, transformers) {
+    return Object.fromEntries(yieldMerged(toProps(existing), _yieldTransformedProps(existing, transformers)));
 }
 /** Apply named transformers to the entries of a map-like object and yield any entries that changed. */
-function* yieldTransformedEntries(existing, updates) {
+function* _yieldTransformedEntries(existing, updates) {
     for (const [k, t] of Object.entries(updates))
         yield [k, transform(existing[k], t)];
 }
 /** Transform some of the entries of a map-like object using a set of named transformers. */
 export function transformEntries(existing, updates, deletes) {
-    return Object.fromEntries(yieldFiltered(yieldMerged(Object.entries(existing), yieldTransformedEntries(existing, updates)), isKeyInArray, deletes));
+    return Object.fromEntries(yieldFiltered(yieldMerged(Object.entries(existing), _yieldTransformedEntries(existing, updates)), isKeyInArray, deletes));
 }

package/util/undefined.js

@@ -1,4 +1,4 @@
-import { RequiredError } from "..";
+import { RequiredError } from "../error/index.js";
 /** Is a value undefined? */
 export const isUndefined = (v) => v === undefined;
 /** Is a value defined? */

package/util/validate.d.ts

@@ -1,5 +1,5 @@
 import type { Entry } from "./entry.js";
-import { Data, Prop, Result } from "./data.js";
+import { Data, Result } from "./data.js";
 /** Object that can validate an unknown value with its `validate()` method. */
 export interface Validatable<T> {
     /**
@@ -50,14 +50,6 @@ export declare function validateItems<T>(unsafeItems: Iterable<unknown>, validat
  * - `feedback.details` will contain an entry for each invalid item (keyed by their count in the input iterable).
  */
 export declare function validateValues<T>(unsafeValues: Iterable<Entry>, validator: Validator<T>): Generator<Entry<T>, void>;
-/**
- * Validate a set of object props with a set of validators.
- *
- * @yield Valid entries for each specified validator.
- * @throw InvalidFeedback if one or more entries did not validate.
- * - `feedback.details` will contain an entry for each invalid item (keyed by their count in the input iterable).
- */
-export declare function validateProps<T extends Data>(unsafeData: Data, validators: Validators<T>): Generator<Prop<T>, void>;
 /**
  * Validate an entire object with a set of validators.
  * - Defined props in the object will be validated against the corresponding validator.
@@ -69,7 +61,7 @@ export declare function validateProps<T extends Data>(unsafeData: Data, validato
  */
 export declare function validateData<T extends Data>(unsafeData: Data, validators: Validators<T>): T;
 /**
- * Validate a data result.
+ * Validate a data result against a validator for that data.
  * @return Valid object or `null`
  */
 export declare function validateResult<T extends Data>(unsafeResult: unknown, validator: Validator<T>): Result<T>;

package/util/validate.js

@@ -1,5 +1,6 @@
 import { Feedback, InvalidFeedback } from "../feedback/index.js";
 import { isData, toProps } from "./data.js";
+import { isNullish } from "./null.js";
 /** Is a given value a validator? */
 export const isValidator = (v) => typeof v === "function" || (isData(v) && typeof v.validate === "function");
 /** Validate an unknown value with a validator. */
@@ -56,6 +57,18 @@ export function* validateValues(unsafeValues, validator) {
     if (invalid)
         throw new InvalidFeedback("Invalid items", details);
 }
+/**
+ * Validate an entire object with a set of validators.
+ * - Defined props in the object will be validated against the corresponding validator.
+ * - `undefined` props in the object will be set to the default value of that prop.
+ *
+ * @return Valid object.
+ * @throw InvalidFeedback if one or more entries did not validate.
+ * - `feedback.details` will contain an entry for each invalid item (keyed by their count in the input iterable).
+ */
+export function validateData(unsafeData, validators) {
+    return Object.fromEntries(_yieldValidatedProps(unsafeData, validators));
+}
 /**
  * Validate a set of object props with a set of validators.
  *
@@ -63,7 +76,7 @@ export function* validateValues(unsafeValues, validator) {
  * @throw InvalidFeedback if one or more entries did not validate.
  * - `feedback.details` will contain an entry for each invalid item (keyed by their count in the input iterable).
  */
-export function* validateProps(unsafeData, validators) {
+function* _yieldValidatedProps(unsafeData, validators) {
     let invalid = false;
     const details = {};
     for (const [k, validator] of toProps(validators)) {
@@ -83,21 +96,9 @@ export function* validateProps(unsafeData, validators) {
         throw new InvalidFeedback("Invalid data", details);
 }
 /**
- * Validate an entire object with a set of validators.
- * - Defined props in the object will be validated against the corresponding validator.
- * - `undefined` props in the object will be set to the default value of that prop.
- *
- * @return Valid object.
- * @throw InvalidFeedback if one or more entries did not validate.
- * - `feedback.details` will contain an entry for each invalid item (keyed by their count in the input iterable).
- */
-export function validateData(unsafeData, validators) {
-    return Object.fromEntries(validateProps(unsafeData, validators));
-}
-/**
- * Validate a data result.
+ * Validate a data result against a validator for that data.
  * @return Valid object or `null`
  */
 export function validateResult(unsafeResult, validator) {
-    return unsafeResult === null || unsafeResult === undefined ? validate(unsafeResult, validator) : null;
+    return !isNullish(unsafeResult) ? validate(unsafeResult, validator) : null;
 }