shelving 1.42.0 → 1.43.0

package/db/Database.d.ts

@@ -29,10 +29,10 @@ export declare class Database<V extends Validators<Datas> = Validators<Datas>> {
 }
 /** A documents reference within a specific database. */
 export declare class DatabaseQuery<T extends Data = Data> extends Query<T> implements Observable<Results<T>>, Validatable<Entries<T>>, Iterable<Entry<T>> {
-    readonly provider: Provider;
+    readonly db: Database;
     readonly validator: Validator<T>;
     readonly collection: string;
-    constructor(provider: Provider, validator: Validator<T>, collection: string, filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null);
+    constructor(db: Database, validator: Validator<T>, collection: string, filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null);
     /** Reference a document in this query's collection. */
     doc(id: string): DatabaseDocument<T>;
     /**
@@ -114,11 +114,11 @@ export declare class DatabaseQuery<T extends Data = Data> extends Query<T> imple
 export declare function getQueryData<T extends Data>(entries: Entries<T>, ref: DatabaseQuery<T>): Entry<T>;
 /** A document reference within a specific database. */
 export declare class DatabaseDocument<T extends Data = Data> implements Observable<Result<T>>, Validatable<T> {
-    readonly provider: Provider;
+    readonly db: Database;
     readonly validator: Validator<T>;
     readonly collection: string;
     readonly id: string;
-    constructor(provider: Provider, validator: Validator<T>, collection: string, id: string);
+    constructor(db: Database, validator: Validator<T>, collection: string, id: string);
     /** Create a query on this document's collection. */
     query(filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null): DatabaseQuery<T>;
     /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */

package/db/Database.js

@@ -18,11 +18,11 @@ export class Database {
     }
     /** Create a query on a collection in this model. */
     query(collection, filters, sorts, limit) {
-        return new DatabaseQuery(this.provider, this.validators[collection], collection, filters, sorts, limit);
+        return new DatabaseQuery(this, this.validators[collection], collection, filters, sorts, limit);
     }
     /** Reference a document in a collection in this model. */
     doc(collection, id) {
-        return new DatabaseDocument(this.provider, this.validators[collection], collection, id);
+        return new DatabaseDocument(this, this.validators[collection], collection, id);
     }
     /**
      * Create a new document with a random ID.
@@ -38,15 +38,15 @@ export class Database {
 }
 /** A documents reference within a specific database. */
 export class DatabaseQuery extends Query {
-    constructor(provider, validator, collection, filters, sorts, limit) {
+    constructor(db, validator, collection, filters, sorts, limit) {
         super(filters, sorts, limit);
-        this.provider = provider;
+        this.db = db;
         this.validator = validator;
         this.collection = collection;
     }
     /** Reference a document in this query's collection. */
     doc(id) {
-        return new DatabaseDocument(this.provider, this.validator, this.collection, id);
+        return new DatabaseDocument(this.db, this.validator, this.collection, id);
     }
     /**
      * Create a new document with a random ID.
@@ -56,21 +56,21 @@ export class DatabaseQuery extends Query {
      * @return String ID for the created document (possibly promised).
      */
     add(data) {
-        return this.provider.add(this, data);
+        return this.db.provider.add(this, data);
     }
     /**
      * Get an iterable that yields the results of this entry.
      * @return Map containing the results.
      */
     get entries() {
-        return this.provider.getQuery(this);
+        return this.db.provider.getQuery(this);
     }
     /**
      * Get an iterable that yields the results of this entry.
      * @return Map containing the results.
      */
     get results() {
-        return callAsync(getMap, this.provider.getQuery(this));
+        return callAsync(getMap, this.db.provider.getQuery(this));
     }
     /**
      * Count the number of results of this set of documents.
@@ -84,7 +84,7 @@ export class DatabaseQuery extends Query {
      * @return `true` if a document exists or `false` otherwise (possibly promised).
      */
     get exists() {
-        return callAsync(hasItems, this.provider.getQuery(this.max(1)));
+        return callAsync(hasItems, this.db.provider.getQuery(this.max(1)));
     }
     /**
      * Get an entry for the first document matched by this query or `undefined` if this query has no results.
@@ -93,7 +93,7 @@ export class DatabaseQuery extends Query {
      * @throws RequiredError if there were no results for this query.
      */
     get result() {
-        return callAsync(getFirstItem, this.provider.getQuery(this.max(1)));
+        return callAsync(getFirstItem, this.db.provider.getQuery(this.max(1)));
     }
     /**
      * Get an entry for the first document matched by this query.
@@ -102,7 +102,7 @@ export class DatabaseQuery extends Query {
      * @throws RequiredError if there were no results for this query.
      */
     get data() {
-        return callAsync(getQueryData, this.provider.getQuery(this.max(1)), this);
+        return callAsync(getQueryData, this.db.provider.getQuery(this.max(1)), this);
     }
     /**
      * Subscribe to all matching documents.
@@ -112,7 +112,7 @@ export class DatabaseQuery extends Query {
      * @return Function that ends the subscription.
      */
     subscribe(next) {
-        return this.provider.subscribeQuery(this, new ResultsObserver(typeof next === "function" ? { next } : next));
+        return this.db.provider.subscribeQuery(this, new ResultsObserver(typeof next === "function" ? { next } : next));
     }
     /**
      * Set all matching documents to the same exact value.
@@ -121,7 +121,7 @@ export class DatabaseQuery extends Query {
      * @return Nothing (possibly promised).
      */
     set(data) {
-        return this.provider.setQuery(this, data);
+        return this.db.provider.setQuery(this, data);
     }
     /**
      * Update all matching documents with the same partial value.
@@ -130,14 +130,14 @@ export class DatabaseQuery extends Query {
      * @return Nothing (possibly promised).
      */
     update(updates) {
-        return this.provider.updateQuery(this, updates instanceof Update ? updates : new DataUpdate(updates));
+        return this.db.provider.updateQuery(this, updates instanceof Update ? updates : new DataUpdate(updates));
     }
     /**
      * Delete all matching documents.
      * @return Nothing (possibly promised).
      */
     delete() {
-        return this.provider.deleteQuery(this);
+        return this.db.provider.deleteQuery(this);
     }
     /** Iterate over the resuls (will throw `Promise` if the results are asynchronous). */
     [Symbol.iterator]() {
@@ -175,33 +175,33 @@ export function getQueryData(entries, ref) {
 }
 /** A document reference within a specific database. */
 export class DatabaseDocument {
-    constructor(provider, validator, collection, id) {
-        this.provider = provider;
+    constructor(db, validator, collection, id) {
+        this.db = db;
         this.validator = validator;
         this.collection = collection;
         this.id = id;
     }
     /** Create a query on this document's collection. */
     query(filters, sorts, limit) {
-        return new DatabaseQuery(this.provider, this.validator, this.collection, filters, sorts, limit);
+        return new DatabaseQuery(this.db, this.validator, this.collection, filters, sorts, limit);
     }
     /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
     get optional() {
-        return new DatabaseQuery(this.provider, this.validator, this.collection, new Filters(new EqualFilter("id", this.id)));
+        return new DatabaseQuery(this.db, this.validator, this.collection, new Filters(new EqualFilter("id", this.id)));
     }
     /**
      * Does this document exist?
      * @return `true` if a document exists or `false` otherwise (possibly promised).
      */
     get exists() {
-        return callAsync(Boolean, this.provider.get(this));
+        return callAsync(Boolean, this.db.provider.get(this));
     }
     /**
      * Get the result of this document.
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
     get result() {
-        return this.provider.get(this);
+        return this.db.provider.get(this);
     }
     /**
      * Get the data of this document.
@@ -211,7 +211,7 @@ export class DatabaseDocument {
      * @throws RequiredError if the document's result was undefined.
      */
     get data() {
-        return callAsync(getDocumentData, this.provider.get(this), this);
+        return callAsync(getDocumentData, this.db.provider.get(this), this);
     }
     /**
      * Subscribe to the result of this document (indefinitely).
@@ -221,19 +221,19 @@ export class DatabaseDocument {
      * @return Function that ends the subscription.
      */
     subscribe(next) {
-        return this.provider.subscribe(this, typeof next === "function" ? { next } : next);
+        return this.db.provider.subscribe(this, typeof next === "function" ? { next } : next);
     }
     /** Set the complete data of this document. */
     set(data) {
-        return this.provider.set(this, data);
+        return this.db.provider.set(this, data);
     }
     /** Update this document. */
     update(updates) {
-        return this.provider.update(this, updates instanceof Update ? updates : new DataUpdate(updates));
+        return this.db.provider.update(this, updates instanceof Update ? updates : new DataUpdate(updates));
     }
     /** Delete this document. */
     delete() {
-        return this.provider.delete(this);
+        return this.db.provider.delete(this);
     }
     /** Validate data for this query reference. */
     validate(unsafeData) {

package/db/Operation.d.ts

@@ -3,6 +3,7 @@ import { ImmutableArray, Nullish, Data, Key } from "../util/index.js";
 import type { Database, DatabaseDocument, DatabaseQuery } from "./Database.js";
 /** Represent a write operation on a database. */
 export declare abstract class Operation {
+    /** Run this operation and return the result operation. */
     abstract run(db: Database): Promise<Operation>;
 }
 /** Represent a list of write operations on a database run in series. */
@@ -22,7 +23,9 @@ export declare class Operations extends Operation {
 /** Represent a add operation made to a collection in a database. */
 export declare class AddOperation<T extends Data> extends Operation {
     /** Create a new add operation on a collection. */
-    static on<X extends Data>({ collection }: DatabaseDocument | DatabaseQuery, data: X): AddOperation<X>;
+    static on<X extends Data>({ collection }: DatabaseDocument<X> | DatabaseQuery<X>, data: X): AddOperation<X>;
+    /** Run a new add operation on a collection and return the result operation. */
+    static run<X extends Data>({ collection, db }: DatabaseDocument<X> | DatabaseQuery<X>, data: X): Promise<SetOperation<X>>;
     readonly collection: string;
     readonly data: T;
     constructor(collection: string, data: T);
@@ -33,7 +36,9 @@ export declare class AddOperation<T extends Data> extends Operation {
 /** Represent a set operation made to a single document in a database. */
 export declare class SetOperation<T extends Data> extends Operation {
     /** Create a new add operation on a collection. */
-    static on<X extends Data>({ collection, id }: DatabaseDocument, data: X): SetOperation<X>;
+    static on<X extends Data>({ collection, id }: DatabaseDocument<X>, data: X): SetOperation<X>;
+    /** Run a new set operation on a collection and return the result operation. */
+    static run<X extends Data>({ collection, id, db }: DatabaseDocument<X>, data: X): Promise<SetOperation<X>>;
     readonly collection: string;
     readonly id: string;
     readonly data: T;
@@ -45,7 +50,9 @@ export declare class SetOperation<T extends Data> extends Operation {
 /** Represent an update operation made to a single document in a database. */
 export declare class UpdateOperation<T extends Data> extends Operation {
     /** Create a new update operation on a document. */
-    static on<X extends Data>({ collection, id }: DatabaseDocument<X>, updates?: PropUpdates<X>): UpdateOperation<X>;
+    static on<X extends Data>({ collection, id }: DatabaseDocument<X>, updates: PropUpdates<X>): UpdateOperation<X>;
+    /** Run a new set operation on a collection and return the result operation. */
+    static run<X extends Data>({ collection, id, db }: DatabaseDocument<X>, updates: PropUpdates<X>): Promise<UpdateOperation<X>>;
     readonly collection: string;
     readonly id: string;
     readonly updates: PropUpdates<T>;
@@ -56,8 +63,10 @@ export declare class UpdateOperation<T extends Data> extends Operation {
 }
 /** Represent a delete operation made to a single document in a database. */
 export declare class DeleteOperation extends Operation {
-    /** Create a new update operation on a document. */
+    /** Create a new delete operation on a document. */
     static on({ collection, id }: DatabaseDocument): DeleteOperation;
+    /** Run a new delete operation on a document. */
+    static run({ collection, id, db }: DatabaseDocument): Promise<DeleteOperation>;
     readonly collection: string;
     readonly id: string;
     constructor(collection: string, id: string);

package/db/Operation.js

@@ -32,6 +32,10 @@ export class AddOperation extends Operation {
     static on({ collection }, data) {
         return new AddOperation(collection, data);
     }
+    /** Run a new add operation on a collection and return the result operation. */
+    static run({ collection, db }, data) {
+        return new AddOperation(collection, data).run(db);
+    }
     async run(db) {
         const id = await db.query(this.collection).add(this.data);
         return new SetOperation(this.collection, id, this.data); // When an add operation is run it returns a set operation so the operation is repeatable.
@@ -55,6 +59,10 @@ export class SetOperation extends Operation {
     static on({ collection, id }, data) {
         return new SetOperation(collection, id, data);
     }
+    /** Run a new set operation on a collection and return the result operation. */
+    static run({ collection, id, db }, data) {
+        return new SetOperation(collection, id, data).run(db);
+    }
     async run(db) {
         await db.doc(this.collection, this.id).set(this.data);
         return this;
@@ -75,9 +83,13 @@ export class UpdateOperation extends Operation {
         this.updates = updates;
     }
     /** Create a new update operation on a document. */
-    static on({ collection, id }, updates = {}) {
+    static on({ collection, id }, updates) {
         return new UpdateOperation(collection, id, updates);
     }
+    /** Run a new set operation on a collection and return the result operation. */
+    static run({ collection, id, db }, updates) {
+        return new UpdateOperation(collection, id, updates).run(db);
+    }
     async run(db) {
         await db.doc(this.collection, this.id).update(this.updates);
         return this;
@@ -96,10 +108,14 @@ export class DeleteOperation extends Operation {
         this.collection = collection;
         this.id = id;
     }
-    /** Create a new update operation on a document. */
+    /** Create a new delete operation on a document. */
     static on({ collection, id }) {
         return new DeleteOperation(collection, id);
     }
+    /** Run a new delete operation on a document. */
+    static run({ collection, id, db }) {
+        return new DeleteOperation(collection, id).run(db);
+    }
     async run(db) {
         await db.doc(this.collection, this.id).delete();
         return this;

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.42.0",
+	"version": "1.43.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/react/useDocument.js

@@ -30,13 +30,13 @@ export function useAsyncDocument(ref, maxAge = 1000) {
 function getCachedResult(ref) {
     if (!ref)
         return undefined;
-    const provider = findSourceProvider(ref.provider, CacheProvider);
+    const provider = findSourceProvider(ref.db.provider, CacheProvider);
     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) {
     if (ref) {
-        const provider = findSourceProvider(ref.provider, CacheProvider);
+        const provider = findSourceProvider(ref.db.provider, CacheProvider);
         const stopCache = provider.cache.subscribe(ref, { next, error });
         if (maxAge === true) {
             // If `maxAge` is true subscribe to the source for as long as this component is attached.

package/react/useQuery.js

@@ -30,18 +30,18 @@ export function useAsyncQuery(ref, maxAge = 1000) {
 function getCachedResults(ref) {
     if (!ref)
         return undefined;
-    const provider = findSourceProvider(ref.provider, CacheProvider);
+    const provider = findSourceProvider(ref.db.provider, CacheProvider);
     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) {
     if (ref) {
-        const provider = findSourceProvider(ref.provider, CacheProvider);
+        const provider = findSourceProvider(ref.db.provider, CacheProvider);
         const observer = new ResultsObserver({ next, error });
         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.
-            const stopSource = ref.provider.subscribeQuery(ref, observer);
+            const stopSource = ref.db.provider.subscribeQuery(ref, observer);
             return () => {
                 stopCache();
                 stopSource();