shelving 1.23.2 → 1.24.0

package/db/Database.d.ts

@@ -2,7 +2,7 @@ import { Entry, Observable, Observer, Result, Unsubscriber, ResultsMap, Validata
 import { Transform, Transforms } from "../transform/index.js";
 import type { Provider } from "../provider/Provider.js";
 import { Filters, Sorts, Query } from "../query/index.js";
-import { DocumentWrite, Write } from "./Write.js";
+import { DocumentWrite, Write, Writes } from "./Write.js";
 /**
  * Combines a database model and a provider.
  *
@@ -18,8 +18,10 @@ export declare class Database<V extends Validators<Datas> = Validators<Datas>> {
     query<K extends Key<V>>(collection: K, filters?: Filters<ValidatorType<V[K]>>, sorts?: Sorts<ValidatorType<V[K]>>, limit?: number | null): DataQuery<ValidatorType<V[K]>>;
     /** Reference a document in a collection in this model. */
     doc<K extends Key<V>>(collection: K, id: string): DataDocument<ValidatorType<V[K]>>;
-    /** Perform a write on this database. */
-    write(write: Write): void | PromiseLike<void>;
+    /** Perform a write on this database and return the `Write` instance representing the changes. */
+    write(write: Write): Promise<Write>;
+    /** Perform multiple writes on this database by combining them into a single `Writes` instance representing the changes. */
+    writes(...writes: (Write | undefined)[]): Promise<Writes>;
 }
 /** A documents reference within a specific database. */
 export declare class DataQuery<T extends Data = Data> extends Query<T> implements Observable<Results<T>>, Validatable<Results<T>>, Iterable<Entry<T>> {

package/db/Database.js

@@ -3,7 +3,7 @@ import { DataTransform, Transform } from "../transform/index.js";
 import { Feedback, InvalidFeedback } from "../feedback/index.js";
 import { Filters, Query, EqualFilter } from "../query/index.js";
 import { DocumentRequiredError, DocumentValidationError, QueryValidationError } from "./errors.js";
-import { DocumentWrite } from "./Write.js";
+import { DocumentWrite, Writes } from "./Write.js";
 /**
  * Combines a database model and a provider.
  *
@@ -25,9 +25,16 @@ export class Database {
     doc(collection, id) {
         return new DataDocument(this.provider, this.validators[collection], collection, id);
     }
-    /** Perform a write on this database. */
-    write(write) {
-        return write.transform(this);
+    /** Perform a write on this database and return the `Write` instance representing the changes. */
+    async write(write) {
+        await write.transform(this);
+        return write;
+    }
+    /** Perform multiple writes on this database by combining them into a single `Writes` instance representing the changes. */
+    async writes(...writes) {
+        const write = new Writes(...writes);
+        await write.transform(this);
+        return write;
     }
 }
 /** A documents reference within a specific database. */

package/db/Write.d.ts

@@ -20,7 +20,7 @@ export declare class DocumentWrite<T extends Data> extends Write {
  */
 export declare class Writes extends Write {
     readonly writes: ImmutableArray<Write>;
-    constructor(...writes: Write[]);
+    constructor(...writes: (Write | undefined)[]);
     transform(db: Database): Promise<void>;
 }
 /** Set of hydrations for all change classes. */

package/db/Write.js

@@ -22,13 +22,14 @@ export class DocumentWrite extends Write {
 export class Writes extends Write {
     constructor(...writes) {
         super();
-        this.writes = writes;
+        this.writes = writes.filter(isWrite);
     }
     async transform(db) {
         for (const writes of this.writes)
             await transform(db, writes);
     }
 }
+const isWrite = (v) => !!v;
 /** Set of hydrations for all change classes. */
 export const WRITE_HYDRATIONS = {
     writes: Writes,

package/package.json

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

package/util/transform.d.ts

@@ -24,24 +24,13 @@ export declare function transform<I, O>(input: I, transformer: (v: I) => O): O;
 export declare function transform<I, O>(input: I, transformer: Transformer<I, O>): O;
 /**
  * Apply a transformer to each item in a set of items and yield the transformed item.
- *
  * @yield Transformed items after calling `transformer()` on each.
- * @returns Number of items that changed.
  */
 export declare function transformItems<I, O>(items: Iterable<I>, transformer: (input: I) => O): Iterable<O>;
 export declare function transformItems<I, O>(items: Iterable<I>, transformer: Transformer<I, O>): Iterable<O>;
 /**
  * Apply a transformer to each item in an array and return the transformed array.
- *
- * @param arr The input array or map-like object or iterable to iterate over.
- * @param mapper Mapping function that receives the value and key and returns the corresponding value.
- * - Mapper can return a promise. If it does will return a Promise that resolves once every value has resolved.
- * - Return the `SKIP` symbol from the mapper to skip that property and not include it in the output object.
- * - `SKIP` is useful because using `filter(Boolean)` doesn't currently filter in TypeScript (and requires another loop anyway).
- * - Mapper can be a non-function static value and all the values will be set to that value.
- *
- * @return The mapped array.
- * - Immutable so if the values don't change then the same instance will be returned.
+ * @return The transformed array.
  */
 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>;