shelving 1.60.0 → 1.62.0

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.60.0",
+	"version": "1.62.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -61,8 +61,8 @@
 	"devDependencies": {
 		"@google-cloud/firestore": "^5.0.2",
 		"@types/jest": "^27.5.1",
-		"@types/react": "^17.0.45",
-		"@types/react-dom": "^17.0.17",
+		"@types/react": "^18.0.9",
+		"@types/react-dom": "^18.0.4",
 		"@typescript-eslint/eslint-plugin": "^5.23.0",
 		"@typescript-eslint/parser": "^5.23.0",
 		"eslint": "^8.15.0",
@@ -70,12 +70,12 @@
 		"eslint-plugin-import": "^2.26.0",
 		"eslint-plugin-prettier": "^4.0.0",
 		"firebase": "^9.8.1",
-		"jest": "^27.5.1",
+		"jest": "^28.1.0",
 		"jest-ts-webcompat-resolver": "^1.0.0",
 		"prettier": "^2.6.2",
-		"react": "^17.0.2",
-		"react-dom": "^17.0.2",
-		"ts-jest": "^27.1.4",
+		"react": "^18.1.0",
+		"react-dom": "^18.1.0",
+		"ts-jest": "^28.0.2",
 		"typescript": "^4.6.4"
 	},
 	"peerDependencies": {

package/react/useDocument.d.ts

@@ -36,5 +36,5 @@ export declare function useDocument<T extends Data>(ref: DocumentReference<T> |
 export declare function useAsyncDocumentData<T extends Data>(ref: DocumentReference<T>, maxAge?: number | true): DocumentData<T> | PromiseLike<DocumentData<T>>;
 export declare function useAsyncDocumentData<T extends Data>(ref: DocumentReference<T> | undefined, maxAge?: number | true): DocumentData<T> | PromiseLike<DocumentData<T>> | undefined;
 /** Use the data of a document or `undefined` if the query has no matching results. */
-export declare function useDocumentData<T extends Data>(ref: DocumentReference<T>, maxAge?: number | true): T;
-export declare function useDocumentData<T extends Data>(ref: DocumentReference<T> | undefined, maxAge?: number | true): T | undefined;
+export declare function useDocumentData<T extends Data>(ref: DocumentReference<T>, maxAge?: number | true): DocumentData<T>;
+export declare function useDocumentData<T extends Data>(ref: DocumentReference<T> | undefined, maxAge?: number | true): DocumentData<T> | undefined;

package/util/iterate.js

@@ -29,7 +29,7 @@ export function countItems(items) {
 export function countIterations(items) {
     let count = 0;
     for (const unused of items)
-        count++; // eslint-disable-line @typescript-eslint/no-unused-vars
+        count++;
     return count;
 }
 /**
@@ -46,7 +46,7 @@ export function hasItems(items) {
  */
 export function hasIterations(items) {
     for (const unused of items)
-        return true; // eslint-disable-line @typescript-eslint/no-unused-vars
+        return true;
     return false;
 }
 /**

package/util/object.js

@@ -38,7 +38,7 @@ export const withEntries = withProps;
  */
 export function withoutEntry(input, key, value) {
     if (isKey(input, key) && (value === undefined || input[key] === value)) {
-        const { [key]: unused, ...output } = input; // eslint-disable-line @typescript-eslint/no-unused-vars
+        const { [key]: unused, ...output } = input;
         return output;
     }
     return input;

package/util/observable.js

@@ -1,5 +1,5 @@
 import { ConditionError } from "../error/index.js";
-import { BLACKHOLE, dispatch } from "./function.js";
+import { dispatch } from "./function.js";
 import { logError } from "./error.js";
 import { isData } from "./data.js";
 import { transform } from "./transform.js";
@@ -164,5 +164,5 @@ export function awaitNext(source) {
 }
 /** Get a promise that resolves when a source subscribable is complete. */
 export function awaitComplete(source) {
-    return new Promise((complete, error) => new ThroughObserver({ next: BLACKHOLE, complete, error }).from(source));
+    return new Promise((complete, error) => new ThroughObserver({ complete, error }).from(source));
 }

package/util/string.d.ts

@@ -81,3 +81,9 @@ export declare function yieldWords(value: string): Generator<string, void, void>
 export declare const isUppercaseLetter: (str: string) => boolean;
 /** Is the first character of a string a lowercase letter? */
 export declare const isLowercaseLetter: (str: string) => boolean;
+/**
+ * Limit a string to a given length.
+ * - Stops at the last space inside `maxLength`
+ * - Appends an `…` ellipses after the string (but only if a limit is applied).
+ */
+export declare function limitString(str: string, maxLength: number, append?: string): string;

package/util/string.js

@@ -139,3 +139,14 @@ const MATCH_WORD = /[^\s"]+|"([^"]*)"/g; // Runs of characters without spaces, o
 export const isUppercaseLetter = (str) => isBetween(str.charCodeAt(0), 65, 90);
 /** Is the first character of a string a lowercase letter? */
 export const isLowercaseLetter = (str) => isBetween(str.charCodeAt(0), 97, 122);
+/**
+ * Limit a string to a given length.
+ * - Stops at the last space inside `maxLength`
+ * - Appends an `…` ellipses after the string (but only if a limit is applied).
+ */
+export function limitString(str, maxLength, append = "…") {
+    if (str.length < maxLength)
+        return str;
+    const lastSpace = str.lastIndexOf(" ", maxLength);
+    return `${str.slice(0, lastSpace > 0 ? lastSpace : maxLength).trimEnd()}${append}`;
+}

package/util/units.d.ts

@@ -53,3 +53,8 @@ export declare const formatUnits: (num: number, unit: UnitReference, maxPrecisio
  * @param maxPrecision Number of decimal places to round the number to e.g. `2`
  */
 export declare const formatFullUnits: (num: number, unit: UnitReference, maxPrecision?: number | undefined, minPrecision?: number | undefined) => string;
+/**
+ * Format a percentage.
+ * - Combines `getPercent()` and `formatUnits()` for convenience.
+ */
+export declare const formatPercent: (numerator: number, denumerator: number, maxPrecision?: number | undefined, minPrecision?: number | undefined) => string;

package/util/units.js

@@ -1,5 +1,5 @@
 import { AssertionError } from "../error/index.js";
-import { formatFullQuantity, formatQuantity, MILLION } from "./number.js";
+import { formatFullQuantity, formatQuantity, getPercent, MILLION } from "./number.js";
 import { NNBSP } from "./string.js";
 /** One second in millseconds. */
 export const SECOND = 1000;
@@ -80,3 +80,8 @@ export const formatUnits = (num, unit, maxPrecision, minPrecision) => formatQuan
  * @param maxPrecision Number of decimal places to round the number to e.g. `2`
  */
 export const formatFullUnits = (num, unit, maxPrecision, minPrecision) => formatFullQuantity(num, UNITS[unit].singular || unit, UNITS[unit].plural || `${unit}s`, maxPrecision, minPrecision);
+/**
+ * Format a percentage.
+ * - Combines `getPercent()` and `formatUnits()` for convenience.
+ */
+export const formatPercent = (numerator, denumerator, maxPrecision, minPrecision) => formatQuantity(getPercent(numerator, denumerator), UNITS.percent.suffix, maxPrecision, minPrecision);