shelving 1.51.4 → 1.52.0

package/db/Database.js

@@ -168,9 +168,9 @@ export class DatabaseQuery extends Query {
 }
 /** Get the data for a document from a result for that document. */
 export function getQueryData(entries, ref) {
-    const first = getFirstItem(entries);
-    if (first)
-        return getDocumentData(first[1], ref.doc(first[0]));
+    const data = getQueryResult(entries, ref);
+    if (data)
+        return data;
     throw new QueryRequiredError(ref);
 }
 /** Get the data for a document from a result for that document. */
@@ -178,7 +178,7 @@ export function getQueryResult(entries, ref) {
     const first = getFirstItem(entries);
     if (first)
         return getDocumentData(first[1], ref.doc(first[0]));
-    throw new QueryRequiredError(ref);
+    return null;
 }
 /** A document reference within a specific database. */
 export class DatabaseDocument {

package/db/errors.d.ts

@@ -7,16 +7,40 @@ export declare class DocumentRequiredError<T extends Data> extends RequiredError
     ref: DatabaseDocument<T>;
     constructor(ref: DatabaseDocument<T>);
 }
-/** Thrown if a query doesn't exist. */
-export declare class QueryRequiredError<T extends Data> extends RequiredError {
-    ref: DatabaseQuery<T>;
-    constructor(ref: DatabaseQuery<T>);
+/** Thrown if an error occurs while reading a document. */
+export declare class DocumentReadError<T extends Data> extends Error {
+    error: Error;
+    ref: DatabaseDocument<T>;
+    constructor(error: Error, ref: DatabaseDocument<T>);
+}
+/** Thrown if an error occurs while writing a document. */
+export declare class DocumentWriteError<T extends Data> extends Error {
+    error: Error;
+    ref: DatabaseDocument<T>;
+    constructor(error: Error, ref: DatabaseDocument<T>);
 }
 /** Thrown if a document can't validate. */
 export declare class DocumentValidationError<T extends Data> extends ValidationError {
     ref: DatabaseDocument<T>;
     constructor(ref: DatabaseDocument<T>, feedback: Feedback);
 }
+/** Thrown if a query doesn't exist. */
+export declare class QueryRequiredError<T extends Data> extends RequiredError {
+    ref: DatabaseQuery<T>;
+    constructor(ref: DatabaseQuery<T>);
+}
+/** Thrown if an error occurs while reading a query. */
+export declare class QueryReadError<T extends Data> extends Error {
+    error: Error;
+    ref: DatabaseQuery<T>;
+    constructor(error: Error, ref: DatabaseQuery<T>);
+}
+/** Thrown if an error occurs while writing a query. */
+export declare class QueryWriteError<T extends Data> extends Error {
+    error: Error;
+    ref: DatabaseQuery<T>;
+    constructor(error: Error, ref: DatabaseQuery<T>);
+}
 /** Thrown if a query can't validate a set of results. */
 export declare class QueryValidationError<T extends Data> extends ValidationError {
     ref: DatabaseQuery<T>;

package/db/errors.js

@@ -2,27 +2,63 @@ import { RequiredError, ValidationError } from "../error/index.js";
 /** Thrown if a document doesn't exist. */
 export class DocumentRequiredError extends RequiredError {
     constructor(ref) {
-        super(`Document "${ref.toString()}" does not exist`);
+        super(`Document ${ref.toString()} does not exist`);
         this.ref = ref;
     }
 }
 DocumentRequiredError.prototype.name = "DocumentRequiredError";
-/** Thrown if a query doesn't exist. */
-export class QueryRequiredError extends RequiredError {
-    constructor(ref) {
-        super(`Query "${ref.toString()}" has no results`);
+/** Thrown if an error occurs while reading a document. */
+export class DocumentReadError extends Error {
+    constructor(error, ref) {
+        super(`Error reading document ${ref.toString()}:\n${error.message}`);
+        this.error = error;
         this.ref = ref;
     }
 }
-QueryRequiredError.prototype.name = "QueryRequiredError";
+DocumentReadError.prototype.name = "DocumentReadError";
+/** Thrown if an error occurs while writing a document. */
+export class DocumentWriteError extends Error {
+    constructor(error, ref) {
+        super(`Error writing document ${ref.toString()}:\n${error.message}`);
+        this.error = error;
+        this.ref = ref;
+    }
+}
+DocumentWriteError.prototype.name = "DocumentWriteError";
 /** Thrown if a document can't validate. */
 export class DocumentValidationError extends ValidationError {
     constructor(ref, feedback) {
-        super(`Invalid data for "${ref.toString()}"`, feedback);
+        super(`Invalid data for ${ref.toString()}`, feedback);
         this.ref = ref;
     }
 }
 DocumentValidationError.prototype.name = "DocumentValidationError";
+/** Thrown if a query doesn't exist. */
+export class QueryRequiredError extends RequiredError {
+    constructor(ref) {
+        super(`Query ${ref.toString()} has no results`);
+        this.ref = ref;
+    }
+}
+QueryRequiredError.prototype.name = "QueryRequiredError";
+/** Thrown if an error occurs while reading a query. */
+export class QueryReadError extends Error {
+    constructor(error, ref) {
+        super(`Error reading query ${ref.toString()}:\n${error.message}`);
+        this.error = error;
+        this.ref = ref;
+    }
+}
+QueryReadError.prototype.name = "QueryReadError";
+/** Thrown if an error occurs while writing a query. */
+export class QueryWriteError extends Error {
+    constructor(error, ref) {
+        super(`Error writing query ${ref.toString()}:\n${error.message}`);
+        this.error = error;
+        this.ref = ref;
+    }
+}
+DocumentWriteError.prototype.name = "DocumentWriteError";
 /** Thrown if a query can't validate a set of results. */
 export class QueryValidationError extends ValidationError {
     constructor(ref, feedback) {

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.51.4",
+	"version": "1.52.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -63,13 +63,13 @@
 		"@types/jest": "^27.4.0",
 		"@types/react": "^17.0.39",
 		"@types/react-dom": "^17.0.11",
-		"@typescript-eslint/eslint-plugin": "^5.11.0",
-		"@typescript-eslint/parser": "^5.11.0",
+		"@typescript-eslint/eslint-plugin": "^5.12.0",
+		"@typescript-eslint/parser": "^5.12.0",
 		"eslint": "^8.9.0",
-		"eslint-config-prettier": "^8.3.0",
+		"eslint-config-prettier": "^8.4.0",
 		"eslint-plugin-import": "^2.25.4",
 		"eslint-plugin-prettier": "^4.0.0",
-		"firebase": "^9.6.6",
+		"firebase": "^9.6.7",
 		"jest": "^27.5.1",
 		"jest-ts-webcompat-resolver": "^1.0.0",
 		"prettier": "^2.5.1",

package/query/Query.js

@@ -70,6 +70,6 @@ export class Query extends Rule {
     }
     // Implement toString()
     toString() {
-        return `${this.filters}&${this.sorts}${this.limit ? `&LIMIT=${this.limit}` : ""}`;
+        return `filters=${this.filters}&sorts=${this.sorts}&limit={this.limit || ""}`;
     }
 }

package/query/Rules.js

@@ -19,7 +19,7 @@ export class Rules extends Rule {
         return this._rules.length;
     }
     toString() {
-        return this._rules.map(toString).join("&");
+        return this._rules.map(toString).join(",");
     }
     /** Clone this set of rules but add additional rules. */
     with(...rules) {

package/react/useDocument.js

@@ -1,5 +1,5 @@
 import { useState } from "react";
-import { CacheProvider, throwAsync, NOERROR, findSourceProvider, NOVALUE, callAsync, getDocumentData } from "../index.js";
+import { CacheProvider, throwAsync, NOERROR, findSourceProvider, NOVALUE, callAsync, getDocumentData, isAsync } from "../index.js";
 import { usePureEffect } from "./usePureEffect.js";
 import { usePureMemo } from "./usePureMemo.js";
 import { usePureState } from "./usePureState.js";
@@ -9,13 +9,14 @@ export function useAsyncDocument(ref, maxAge = 1000) {
     // Create two states to hold the value and error.
     const [value, setNext] = usePureState(getCachedResult, memoRef);
     const [error, setError] = useState(NOERROR);
-    if (error !== NOERROR)
-        throw error; // If there's an error throw it.
     // Register effect.
     usePureEffect(subscribeEffect, memoRef, maxAge, setNext, setError);
     // Always return undefined if there's no ref.
     if (!ref)
         return undefined;
+    // If there's an error throw it.
+    if (error !== NOERROR)
+        throw error;
     // If document is cached return the cached value.
     if (value !== NOVALUE)
         return value;
@@ -24,7 +25,10 @@ export function useAsyncDocument(ref, maxAge = 1000) {
     if (maxAge === true)
         setTimeout(ref.subscribe({ next: setNext, error: setError }), 10000);
     // Return a promise for the result.
-    return ref.result;
+    const result = ref.result;
+    if (isAsync(result))
+        result.then(setNext, setError);
+    return result;
 }
 /** Get the initial result for a reference from the cache. */
 function getCachedResult(ref) {
@@ -34,22 +38,30 @@ function getCachedResult(ref) {
     return provider.isCached(ref) ? provider.cache.get(ref) : NOVALUE;
 }
 /** Effect that subscribes a component to the cache for a reference. */
-function subscribeEffect(ref, maxAge, next, error) {
+function subscribeEffect(ref, maxAge, setNext, setError) {
     if (ref) {
         const provider = findSourceProvider(ref.db.provider, CacheProvider);
-        const stopCache = provider.cache.subscribe(ref, { next, error });
+        const stopCache = provider.cache.subscribe(ref, { next: setNext, error: setError });
         if (maxAge === true) {
             // If `maxAge` is true subscribe to the source for as long as this component is attached.
-            const stopSource = ref.subscribe({ next, error });
+            const stopSource = ref.subscribe({ next: setNext, error: setError });
             return () => {
                 stopCache();
                 stopSource();
             };
         }
-        else {
+        else if (provider.getCachedAge(ref) > maxAge) {
             // If cache provider's cached document is older than maxAge then force refresh the data.
-            if (provider.getCachedAge(ref) > maxAge)
-                Promise.resolve(ref.result).then(next, error);
+            try {
+                const result = ref.result;
+                if (isAsync(result))
+                    result.then(setNext, setError);
+                else
+                    setNext(result);
+            }
+            catch (e) {
+                setError(e);
+            }
         }
         return stopCache;
     }

package/react/useQuery.js

@@ -1,5 +1,5 @@
 import { useState } from "react";
-import { CacheProvider, NOERROR, findSourceProvider, NOVALUE, getMap, callAsync, getQueryData, throwAsync, ResultsObserver, getQueryResult, } from "../index.js";
+import { CacheProvider, NOERROR, findSourceProvider, NOVALUE, getMap, callAsync, getQueryData, throwAsync, ResultsObserver, getQueryResult, isAsync, } from "../index.js";
 import { usePureEffect } from "./usePureEffect.js";
 import { usePureMemo } from "./usePureMemo.js";
 import { usePureState } from "./usePureState.js";
@@ -24,7 +24,10 @@ export function useAsyncQuery(ref, maxAge = 1000) {
     if (maxAge === true)
         setTimeout(ref.subscribe({ next: setNext, error: setError }), 10000);
     // Return a promise for the result.
-    return ref.results;
+    const results = ref.results;
+    if (isAsync(results))
+        results.then(setNext, setError);
+    return results;
 }
 /** Get the initial results for a reference from the cache. */
 function getCachedResults(ref) {
@@ -34,10 +37,10 @@ function getCachedResults(ref) {
     return provider.isCached(ref) ? getMap(provider.cache.getQuery(ref)) : NOVALUE;
 }
 /** Effect that subscribes a component to the cache for a reference. */
-function subscribeEffect(ref, maxAge, next, error) {
+function subscribeEffect(ref, maxAge, setNext, setError) {
     if (ref) {
         const provider = findSourceProvider(ref.db.provider, CacheProvider);
-        const observer = new ResultsObserver({ next, error });
+        const observer = new ResultsObserver({ next: setNext, error: setError });
         const stopCache = provider.cache.subscribeQuery(ref, observer);
         if (maxAge === true) {
             // If `maxAge` is true subscribe to the source for as long as this component is attached.
@@ -47,10 +50,19 @@ function subscribeEffect(ref, maxAge, next, error) {
                 stopSource();
             };
         }
-        else {
+        else if (provider.getCachedAge(ref) > maxAge) {
             // If cache provider's cached document is older than maxAge then force refresh the data.
-            if (provider.getCachedAge(ref) > maxAge)
-                Promise.resolve(ref.results).then(next, error);
+            Promise.resolve(ref.results).then(setNext, setError);
+            try {
+                const results = ref.results;
+                if (isAsync(results))
+                    results.then(setNext, setError);
+                else
+                    setNext(results);
+            }
+            catch (e) {
+                setError(e);
+            }
         }
         return stopCache;
     }

package/util/jsx.d.ts

@@ -7,8 +7,8 @@ export declare type JSXProps = {
     readonly children?: JSXNode;
 };
 /** JSX element (similar to `React.ReactElement`)  */
-export declare type JSXElement<P extends JSXProps = JSXProps, T extends string | JSXElementCreator<P> = string | JSXElementCreator<P>> = {
-    type: T;
+export declare type JSXElement<P extends JSXProps = JSXProps> = {
+    type: string | JSXElementCreator<P>;
     props: P;
     key: string | number | null;
     $$typeof?: symbol;