shelving 1.49.1 → 1.50.1

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.49.1",
+	"version": "1.50.1",
 	"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",
@@ -61,22 +61,22 @@
 	"devDependencies": {
 		"@google-cloud/firestore": "^4.15.1",
 		"@types/jest": "^27.4.0",
-		"@types/react": "^17.0.38",
+		"@types/react": "^17.0.39",
 		"@types/react-dom": "^17.0.11",
-		"@typescript-eslint/eslint-plugin": "^5.9.1",
-		"@typescript-eslint/parser": "^5.9.1",
-		"eslint": "^8.7.0",
+		"@typescript-eslint/eslint-plugin": "^5.10.2",
+		"@typescript-eslint/parser": "^5.10.2",
+		"eslint": "^8.8.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-import": "^2.25.4",
 		"eslint-plugin-prettier": "^4.0.0",
-		"firebase": "^9.6.3",
-		"jest": "^27.4.7",
+		"firebase": "^9.6.6",
+		"jest": "^27.5.0",
 		"jest-ts-webcompat-resolver": "^1.0.0",
 		"prettier": "^2.5.1",
 		"react": "^17.0.2",
 		"react-dom": "^17.0.2",
 		"ts-jest": "^27.1.3",
-		"typescript": "^4.5.4"
+		"typescript": "^4.5.5"
 	},
 	"peerDependencies": {
 		"@google-cloud/firestore": ">=4.0.0",

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/color.d.ts

@@ -1,5 +1,6 @@
 /** Things that can be converted to a `Color` instance. */
 export declare type PossibleColor = Color | string;
+export declare type PossibleOptionalColor = PossibleColor | null;
 /** Represent a color. */
 export declare class Color {
     readonly r: number;
@@ -20,7 +21,7 @@ export declare class Color {
 /** Convert a number or string to a color channel number that's within bounds (strings like `0a` or `ff` are parsed as hexadecimal). */
 export declare function getColorChannel(channel: number | string): number;
 /** Convert a possible color to a `Color` instance or `null` */
-export declare function toColor(color: PossibleColor): Color | null;
+export declare function toColor(color: unknown): Color | null;
 /** Convert a possible color to a `Color` instance */
 export declare function getColor(input: PossibleColor): Color;
 /** Is a color light? */

package/util/color.js

@@ -49,12 +49,14 @@ export function getColorChannel(channel) {
 export function toColor(color) {
     if (color instanceof Color)
         return color;
-    const hex3 = color.match(HEX3);
-    if (hex3)
-        return new Color(hex3[1], hex3[2], hex3[3]);
-    const hex6 = color.match(HEX6);
-    if (hex6)
-        return new Color(hex6[1], hex6[2], hex6[3], hex6[4]);
+    if (typeof color === "string") {
+        const hex3 = color.match(HEX3);
+        if (hex3)
+            return new Color(hex3[1], hex3[2], hex3[3]);
+        const hex6 = color.match(HEX6);
+        if (hex6)
+            return new Color(hex6[1], hex6[2], hex6[3], hex6[4]);
+    }
     return null;
 }
 /** Convert a possible color to a `Color` instance */

package/util/function.d.ts

@@ -13,8 +13,8 @@ export declare type Dispatcher<T extends Arguments = []> = (...value: T) => void
 /** Function that receives a dispatched value. */
 export declare type AsyncDispatcher<T extends Arguments = []> = (...value: T) => void | PromiseLike<void>;
 /** Safely dispatch a value to a dispatcher function. */
-export declare function dispatch<T extends Arguments>(dispatcher: Dispatcher<T> | AsyncDispatcher<T>, ...value: T): void;
+export declare function dispatch<T extends Arguments>(dispatcher: AsyncDispatcher<T>, ...value: T): void;
 /** Safely dispatch a value to a dispatcher method on an object. */
 export declare function dispatchMethod<T extends Arguments, M extends string | symbol>(obj: {
-    [K in M]: Dispatcher<T> | AsyncDispatcher<T>;
+    [K in M]: AsyncDispatcher<T>;
 }, key: M, ...value: T): void;

package/util/iterate.d.ts

@@ -52,6 +52,11 @@ export declare function yieldRange(start: number, end: number): Generator<number
  * - Checks `items.size` or `items.length` first to see if the limit is necessary.
  */
 export declare function limitItems<T>(items: Iterable<T>, limit: number): TypedIterable<T, void, void>;
+/**
+ * Reduce an iterable set of items using a reducer function.
+ */
+export declare function reduceItems<T, R>(items: Iterable<T>, reducer: (previous: R, item: T) => R, initial: R): R;
+export declare function reduceItems<T, R>(items: Iterable<T>, reducer: (previous: R | undefined, item: T) => R, initial?: R): R | undefined;
 /** Yield items from a source iterable until we hit a maximum iteration count. */
 export declare function yieldUntilLimit<T>(source: Iterable<T>, limit: number): Generator<T, void, void>;
 /** Infinite iterator that yields the result of calling a function with a given set of arguments. */

package/util/iterate.js

@@ -70,6 +70,12 @@ export function limitItems(items, limit) {
     const size = (_a = getKnownSize(items)) !== null && _a !== void 0 ? _a : Infinity;
     return size <= limit ? items : yieldUntilLimit(items, limit);
 }
+export function reduceItems(items, reducer, initial) {
+    let current = initial;
+    for (const item of items)
+        current = reducer(current, item);
+    return current;
+}
 /** Yield items from a source iterable until we hit a maximum iteration count. */
 export function* yieldUntilLimit(source, limit) {
     const iterator = source[Symbol.iterator]();

package/util/number.js

@@ -17,7 +17,7 @@ export const isNumber = (v) => typeof v === "number";
  */
 export function toNumber(value) {
     if (typeof value === "number")
-        return Number.isFinite(value) ? value : null;
+        return !Number.isFinite(value) ? null : value === 0 ? 0 : value;
     else if (typeof value === "string")
         return toNumber(parseFloat(value.replace(NUMERIC, "")));
     else if (value instanceof Date)

package/util/random.d.ts

@@ -2,9 +2,10 @@ import type { ImmutableArray } from "./array.js";
 /** Generate a random integer between two numbers. */
 export declare const getRandom: (min: number, max: number) => number;
 /**
- * Make a random key, e.g. "xs23rsdxe4mrugef"
+ * Make a random key, e.g. `xs23r34hhsdx` or `e4m29klrugef`
  * - Not designed to be cryptographically random!
  * - Will probably clash — if you're making a random ID, check for existence of the record before saving.
+ * - Designed to be semi-readable, doesn't use capital letters or `i` or `o` or `l` or `u`
  */
 export declare const getRandomKey: (length?: number) => string;
 /** Get a random character from a string. */

package/util/random.js

@@ -1,14 +1,15 @@
 import { yieldUntilLimit, yieldCall } from "./iterate.js";
-import { concatStrings } from "./string.js";
+import { joinStrings } from "./string.js";
 import { getDefined } from "./undefined.js";
 /** Generate a random integer between two numbers. */
 export const getRandom = (min, max) => Math.round(Math.random() * (max - min) + min);
 /**
- * Make a random key, e.g. "xs23rsdxe4mrugef"
+ * Make a random key, e.g. `xs23r34hhsdx` or `e4m29klrugef`
  * - Not designed to be cryptographically random!
  * - Will probably clash — if you're making a random ID, check for existence of the record before saving.
+ * - Designed to be semi-readable, doesn't use capital letters or `i` or `o` or `l` or `u`
  */
-export const getRandomKey = (length = 16) => concatStrings(yieldUntilLimit(yieldCall(getRandomCharacter, KEY_CHARS), length));
+export const getRandomKey = (length = 12) => joinStrings(yieldUntilLimit(yieldCall(getRandomCharacter, KEY_CHARS), length));
 const KEY_CHARS = "0123456789abcdefghjkmnpqrstvwxyz";
 /** Get a random character from a string. */
 export const getRandomCharacter = (str) => str[getRandom(0, str.length - 1)];

package/util/string.d.ts

@@ -16,8 +16,6 @@ export declare const isString: (v: unknown) => v is string;
  * -
  */
 export declare function toString(value: unknown): string;
-/** Concatenate a set of potential strings together. */
-export declare function concatStrings(values: Iterable<unknown>): string;
 /**
  * Convert an unknown value into a title string for user-facing use.
  * - Strings return the string.
@@ -32,6 +30,8 @@ export declare function concatStrings(values: Iterable<unknown>): string;
  * - Everything else returns `"Unknown"`
  */
 export declare function toTitle(value: unknown): string;
+/** Concatenate an iterable set of strings together. */
+export declare function joinStrings(strs: Iterable<string>, joiner?: string): string;
 /**
  * Sanitize unexpected characters from a string by:
  * - Stripping control characters.

package/util/string.js

@@ -32,13 +32,6 @@ export function toString(value) {
         return value.name || "function";
     return typeof value; // "symbol" etc.
 }
-/** Concatenate a set of potential strings together. */
-export function concatStrings(values) {
-    let output = "";
-    for (const value of values)
-        output += toString(value);
-    return output;
-}
 /**
  * Convert an unknown value into a title string for user-facing use.
  * - Strings return the string.
@@ -73,6 +66,13 @@ export function toTitle(value) {
         return "None";
     return "Unknown";
 }
+/** Concatenate an iterable set of strings together. */
+export function joinStrings(strs, joiner = "") {
+    let output = "";
+    for (const str of strs)
+        output += `${output.length ? joiner : ""}${str}`;
+    return output;
+}
 /**
  * Sanitize unexpected characters from a string by:
  * - Stripping control characters.

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;
 }