shelving 1.49.3 → 1.50.0

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.49.3",
+	"version": "1.50.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -63,20 +63,20 @@
 		"@types/jest": "^27.4.0",
 		"@types/react": "^17.0.38",
 		"@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.1",
+		"@typescript-eslint/parser": "^5.10.1",
+		"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",
+		"firebase": "^9.6.5",
 		"jest": "^27.4.7",
 		"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/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/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/random.js

@@ -1,5 +1,5 @@
 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);
@@ -8,7 +8,7 @@ export const getRandom = (min, max) => Math.round(Math.random() * (max - min) +
  * - Not designed to be cryptographically random!
  * - Will probably clash — if you're making a random ID, check for existence of the record before saving.
  */
-export const getRandomKey = (length = 16) => concatStrings(yieldUntilLimit(yieldCall(getRandomCharacter, KEY_CHARS), length));
+export const getRandomKey = (length = 16) => 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.