liwi-mongo 13.3.3 → 14.0.0

package/README.md

@@ -81,7 +81,9 @@ interface MongoBaseModel<KeyValue extends AllowedKeyValue = string> {
 }
 ```
 
-The key path is always `_id`. `MongoInsertType<Model>` makes `_id`, `created` and `updated` optional; the store fills `created` / `updated` on insert and `updated` on every update. `insertOne` mutates and returns the object you passed.
+The key path is always `_id`. `MongoInsertType<Model>` makes `_id`, `created` and `updated` optional. Every write sets `updated` to the write time from the app clock, and an update or a replace never changes `created`: see [`created` and `updated`](../liwi-store#created-and-updated) for the rule of each method. `insertOne` and `upsertOne` mutate and return the object you passed; `replaceOne` leaves it untouched and returns the stored document.
+
+Requires MongoDB ≥ 4.2: replaces are update pipelines.
 
 ## `MongoConnection`
 
@@ -111,6 +113,29 @@ const set: Update<Task>["$set"] = { completed: true };
 
 The store also exposes the underlying driver handles when you need them: `store.collection` resolves the `mongodb` collection.
 
+### Writes and their cost
+
+The plain methods do one round trip and do not read the previous document:
+
+| Method               | Driver call                                                           | Missing key            |
+| -------------------- | --------------------------------------------------------------------- | ---------------------- |
+| `partialUpdateByKey` | `findOneAndUpdate` with `returnDocument: "after"`                     | throws `NotFoundError` |
+| `partialUpdateMany`  | one `updateMany`; every document gets the same `updated`              | —                      |
+| `replaceOne`         | `findOneAndUpdate` with a replace pipeline, `returnDocument: "after"` | throws `NotFoundError` |
+| `deleteByKey`        | `deleteOne`                                                           | no-op                  |
+
+The replace pipeline is `$replaceWith` of the object (wrapped in `$literal`, so string values starting with `$` stay data) merged with the stored `created`. A plain `replaceOne` command could not keep `created`.
+
+The [`…WithInfo` variants](../liwi-store#writes-with-info) also return the previous document, read atomically with the write. The subscribe store uses them:
+
+| Method                       | Driver calls                                                                                                            |
+| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `partialUpdateByKeyWithInfo` | `findOneAndUpdate` with `returnDocument: "before"`, then `findOne` for `next`                                           |
+| `replaceOneWithInfo`         | the replace pipeline with `returnDocument: "before"`; `next` is the replacement with the stored `created`, no read back |
+| `deleteByKeyWithInfo`        | `findOneAndDelete`                                                                                                      |
+
+Mongo cannot return both the before and after documents of one update, so `partialUpdateByKeyWithInfo` reads `next` back. That read may already include a later concurrent write (which emits its own change), and it finds nothing if a concurrent delete landed first: `next` is then `undefined` although the update was applied.
+
 ## Indexes
 
 Indexes are declared on the store and applied by an explicit sync step. The declaration is validated eagerly in the constructor (empty key, a name resolving to `_id_`, duplicate names, more than one text index).
@@ -259,7 +284,7 @@ const subscription = query.fetchAndSubscribe((error, changes) => {
 subscription.stop();
 ```
 
-`createQuerySingleItem` behaves the same but resolves a single item.
+`createQuerySingleItem` behaves the same but resolves a single item. Without `sort`, its criteria must match at most one document: when one update moves several matching documents, the subscription reports the error `should not match more than 1, use sort if you can have multiple match` through its callback. With `sort`, it refetches on every relevant update.
 
 Subscriptions are driven in-process: writes going through the subscribe store are matched against the query criteria with [mingo](https://github.com/kofrasa/mingo).
 

package/dist/definitions/MongoConnection.d.ts

@@ -6,14 +6,20 @@ export interface MongoConfig {
     database: string;
     user?: string;
     password?: string;
+    authSource?: string;
 }
+interface BuildMongoConnectionStringParams extends MongoConfig {
+    redactCredentials: boolean;
+}
+export declare const buildMongoConnectionString: ({ host, port, database, user, password, authSource, redactCredentials, }: BuildMongoConnectionStringParams) => string;
 export default class MongoConnection extends AbstractConnection {
     _connection?: mongodb.MongoClient;
     _connecting?: Promise<mongodb.MongoClient>;
     connectionFailed?: boolean;
-    constructor({ host, port, database, user, password, }: MongoConfig);
+    constructor(config: MongoConfig);
     connect(connectionString: string, connectionStringRedacted: string): void;
     getConnection(): Promise<mongodb.MongoClient>;
     close(): Promise<void>;
 }
+export {};
 //# sourceMappingURL=MongoConnection.d.ts.map

package/dist/definitions/MongoConnection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MongoConnection.d.ts","sourceRoot":"","sources":["../../src/MongoConnection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,OAAO,MAAM,SAAS,CAAC;AAK9B,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,kBAAkB;IAC7D,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IAElC,WAAW,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE3C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAG3B,YAAY,EACV,IAAkB,EAClB,IAAc,EACd,QAAQ,EACR,IAAI,EACJ,QAAQ,GACT,EAAE,WAAW,EA0Bb;IAED,OAAO,CAAC,gBAAgB,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAgDxE;IAED,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAE5C;IAEK,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAS3B;CACF"}
+{"version":3,"file":"MongoConnection.d.ts","sourceRoot":"","sources":["../../src/MongoConnection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,OAAO,MAAM,SAAS,CAAC;AAK9B,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,gCAAiC,SAAQ,WAAW;IAC5D,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,0BAA0B,6EAQpC,gCAAgC,KAAG,MAalC,CAAC;AAEL,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,kBAAkB;IAC7D,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IAElC,WAAW,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE3C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAG3B,YAAY,MAAM,EAAE,WAAW,EAiB9B;IAED,OAAO,CAAC,gBAAgB,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAgDxE;IAED,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAE5C;IAEK,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAS3B;CACF"}

package/dist/definitions/MongoConnection.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MongoConnection.test.d.ts.map

package/dist/definitions/MongoConnection.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MongoConnection.test.d.ts","sourceRoot":"","sources":["../../src/MongoConnection.test.ts"],"names":[],"mappings":""}

package/dist/definitions/MongoCursor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MongoCursor.d.ts","sourceRoot":"","sources":["../../src/MongoCursor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAE3C,MAAM,CAAC,OAAO,OAAO,WAAW,CAC9B,KAAK,SAAS,cAAc,CAAC,QAAQ,CAAC,EACtC,MAAM,SAAS,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,EACrC,QAAQ,SAAS,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,CAC/C,SAAQ,mBAAmB,CAC3B,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,EAC3B,QAAQ,EACR,KAAK,EACL,MAAM,CACP;IAGC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAE5C,OAAO,CAAC,OAAO,CAAC,CAAgB;IAEhC,YAAY,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAGzE;IAED,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAE3B;IAED,IAAI,IAAI,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAMpC;IAEc,OAAO,CACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACjD,OAAO,CAAC,IAAI,CAAC,CAIf;IAED,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGrC;IAEQ,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAGjC;IAED,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAMrB;IAED,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAE3B;CACF"}
+{"version":3,"file":"MongoCursor.d.ts","sourceRoot":"","sources":["../../src/MongoCursor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAE3C,MAAM,CAAC,OAAO,OAAO,WAAW,CAC9B,KAAK,SAAS,cAAc,CAAC,QAAQ,CAAC,EACtC,MAAM,SAAS,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,EACrC,QAAQ,SAAS,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,CAC/C,SAAQ,mBAAmB,CAC3B,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,EAC3B,QAAQ,EACR,KAAK,EACL,MAAM,CACP;IAGC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAE5C,OAAO,CAAC,OAAO,CAAC,CAAgB;IAEhC,YAAY,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAGzE;IAED,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAE3B;IAED,IAAI,IAAI,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAMpC;IAEc,OAAO,CACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GACjD,OAAO,CAAC,IAAI,CAAC,CAIf;IAED,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGrC;IAEQ,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAGjC;IAEK,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAI3B;IAED,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAE3B;CACF"}

package/dist/definitions/MongoQuerySingleItem.d.ts

@@ -11,6 +11,7 @@ export default class MongoQuerySingleItem<Model extends MongoBaseModel<KeyValue>
     constructor(store: MongoStore<Model, KeyValue>, options: QueryOptions<Model>, transformer?: Transformer<Model, Result>);
     createMingoTestCriteria(): TestCriteria;
     fetch<T>(onFulfilled: (result: QueryResult<Result>) => T): Promise<T>;
+    private computeChanges;
     _subscribe(callback: SubscribeCallback<KeyValue, Result>, _includeInitial: boolean): QuerySubscription;
     private createMongoCursor;
 }

package/dist/definitions/MongoQuerySingleItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MongoQuerySingleItem.d.ts","sourceRoot":"","sources":["../../src/MongoQuerySingleItem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EAEf,YAAY,EACZ,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACZ,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAC;AAEtE,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,YAAY,EACb,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAS3C,KAAK,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC;AAE1C,MAAM,CAAC,OAAO,OAAO,oBAAoB,CACvC,KAAK,SAAS,cAAc,CAAC,QAAQ,CAAC,EACtC,MAAM,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,EAC1C,MAAM,SAAS,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,EACnE,QAAQ,SAAS,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,CAC/C,SAAQ,8BAA8B,CACtC,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,EAChC,MAAM,EACN,MAAM,CACP;IACC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA8B;IAEpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C,OAAO,CAAC,YAAY,CAAC,CAAe;IAEpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6B;IAEzD,YACE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,EAClC,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,EAC5B,WAAW,GAAE,WAAW,CAAC,KAAK,EAAE,MAAM,CAAuB,EAM9D;IAED,uBAAuB,IAAI,YAAY,CAWtC;IAEK,KAAK,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAe1E;IAED,UAAU,CACR,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAC7C,eAAe,EAAE,OAAO,GACvB,iBAAiB,CAmFnB;YAEa,iBAAiB;CAehC"}
+{"version":3,"file":"MongoQuerySingleItem.d.ts","sourceRoot":"","sources":["../../src/MongoQuerySingleItem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EAEf,YAAY,EACZ,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACZ,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAC;AAEtE,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,YAAY,EACb,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAS3C,KAAK,YAAY,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC;AAE1C,MAAM,CAAC,OAAO,OAAO,oBAAoB,CACvC,KAAK,SAAS,cAAc,CAAC,QAAQ,CAAC,EACtC,MAAM,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,EAC1C,MAAM,SAAS,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,EACnE,QAAQ,SAAS,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,CAC/C,SAAQ,8BAA8B,CACtC,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,EAChC,MAAM,EACN,MAAM,CACP;IACC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA8B;IAEpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C,OAAO,CAAC,YAAY,CAAC,CAAe;IAEpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6B;IAEzD,YACE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,EAClC,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,EAC5B,WAAW,GAAE,WAAW,CAAC,KAAK,EAAE,MAAM,CAAuB,EAM9D;IAED,uBAAuB,IAAI,YAAY,CAWtC;IAEK,KAAK,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAe1E;YAEa,cAAc;IAkD5B,UAAU,CACR,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAC7C,eAAe,EAAE,OAAO,GACvB,iBAAiB,CAuCnB;YAEa,iBAAiB;CAehC"}

package/dist/definitions/MongoQuerySingleItem.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MongoQuerySingleItem.test.d.ts.map

package/dist/definitions/MongoQuerySingleItem.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MongoQuerySingleItem.test.d.ts","sourceRoot":"","sources":["../../src/MongoQuerySingleItem.test.ts"],"names":[],"mappings":""}

package/dist/definitions/MongoStore.d.ts

@@ -1,4 +1,4 @@
-import type { AllowedKeyValue, CreateQueryOptions, Criteria, Fields, OptionalBaseModelKeysForInsert, QueryParams, Sort, SubscribableStore, Update, UpsertPartialObject, UpsertResult } from "liwi-store";
+import type { AllowedKeyValue, CreateQueryOptions, Criteria, DeleteResult, Fields, OptionalBaseModelKeysForInsert, PartialUpdateOptions, PartialUpdateResult, QueryParams, Sort, SubscribableStore, Update, UpsertPartialObject, UpsertResult, WriteResult } from "liwi-store";
 import type { Collection } from "mongodb";
 import type { MongoBaseModel, MongoInsertType, MongoKeyPath } from "./MongoBaseModel.ts";
 import type MongoConnection from "./MongoConnection.ts";
@@ -23,14 +23,28 @@ export default class MongoStore<Model extends MongoBaseModel<KeyValue>, KeyValue
     createQuerySingleItem<Result extends Record<MongoKeyPath, KeyValue> = Model, Params extends QueryParams<Params> = never>({ transformer, ...options }: CreateQueryOptions<Model, Result>): MongoQuerySingleItem<Model, Params, Result, KeyValue>;
     createQueryCollection<Item extends Record<MongoKeyPath, KeyValue> = Model, Params extends QueryParams<Params> = never>({ transformer, ...options }: CreateQueryOptions<Model, Item>): MongoQueryCollection<Model, Params, Model["_id"], Item>;
     insertOne(object: MongoInsertType<Model>): Promise<Model>;
+    /**
+     * Always sets `updated` to the write time and keeps the stored `created`: the
+     * object's own `created` and `updated` are ignored. The object is not mutated.
+     */
     replaceOne(object: Model): Promise<Model>;
+    /** Same rules as `replaceOne`; `next` is derived from the atomic `prev`, no read back. */
+    replaceOneWithInfo(object: Model): Promise<WriteResult<Model> | undefined>;
     upsertOne<K extends Exclude<keyof Model, MongoKeyPath | OptionalBaseModelKeysForInsert>>(object: UpsertPartialObject<MongoKeyPath, KeyValue, Model, K>, setOnInsertPartialObject?: Update<Model>["$setOnInsert"]): Promise<Model>;
     upsertOneWithInfo<K extends Exclude<keyof Model, MongoKeyPath | OptionalBaseModelKeysForInsert>>(object: UpsertPartialObject<MongoKeyPath, KeyValue, Model, K>, setOnInsertPartialObject?: Update<Model>["$setOnInsert"]): Promise<MongoUpsertResult<KeyValue, Model>>;
     replaceSeveral(objects: Model[]): Promise<Model[]>;
-    partialUpdateByKey(key: KeyValue, partialUpdate: Update<Model>, criteria?: Criteria<Model>): Promise<Model>;
-    partialUpdateOne(object: Model, partialUpdate: Update<Model>): Promise<Model>;
-    partialUpdateMany(criteria: Criteria<Model>, partialUpdate: Update<Model>): Promise<void>;
+    partialUpdateByKey(key: KeyValue, partialUpdate: Update<Model>, criteria?: Criteria<Model>, options?: PartialUpdateOptions): Promise<Model>;
+    /**
+     * `prev` is read atomically with the write. `next` is read right after it,
+     * so it may already include a later concurrent write, which emits its own change.
+     * Resolves `undefined` when no document matches.
+     */
+    partialUpdateByKeyWithInfo(key: KeyValue, partialUpdate: Update<Model>, criteria?: Criteria<Model>, options?: PartialUpdateOptions): Promise<PartialUpdateResult<Model> | undefined>;
+    partialUpdateOne(object: Model, partialUpdate: Update<Model>, options?: PartialUpdateOptions): Promise<Model>;
+    /** One `updateMany` command; every document gets the same `updated`. */
+    partialUpdateMany(criteria: Criteria<Model>, partialUpdate: Update<Model>, options?: PartialUpdateOptions): Promise<void>;
     deleteByKey(key: KeyValue, criteria?: Criteria<Model>): Promise<void>;
+    deleteByKeyWithInfo(key: KeyValue, criteria?: Criteria<Model>): Promise<DeleteResult<Model> | undefined>;
     deleteOne(object: Model): Promise<void>;
     deleteMany(selector: Criteria<Model>): Promise<void>;
     count(filter?: Criteria<Model>): Promise<number>;

package/dist/definitions/MongoStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MongoStore.d.ts","sourceRoot":"","sources":["../../src/MongoStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,QAAQ,EACR,MAAM,EACN,8BAA8B,EAC9B,WAAW,EACX,IAAI,EACJ,iBAAiB,EACjB,MAAM,EACN,mBAAmB,EACnB,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EACV,UAAU,EAKX,MAAM,SAAS,CAAC;AAEjB,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,YAAY,EACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAC;AACxD,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAK7D,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,MAAM,iBAAiB,CAC3B,QAAQ,SAAS,eAAe,EAChC,KAAK,SAAS,cAAc,CAAC,QAAQ,CAAC,IACpC,YAAY,CAAC,KAAK,CAAC,CAAC;AAExB,MAAM,WAAW,iBAAiB,CAAC,KAAK,SAAS,cAAc,CAAC,GAAG,CAAC;IAClE,OAAO,CAAC,EAAE,SAAS,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;CACxC;AAED,MAAM,CAAC,OAAO,OAAO,UAAU,CAC7B,KAAK,SAAS,cAAc,CAAC,QAAQ,CAAC,EACtC,QAAQ,SAAS,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,CACtD,YAAW,iBAAiB,CAC5B,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,eAAe,CAAC,KAAK,CAAC,EACtB,eAAe,CAChB;IACC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAS;IAEvC,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IAErC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA+B;IAE/D,OAAO,CAAC,WAAW,CAAiD;IAEpE,YACE,UAAU,EAAE,eAAe,EAC3B,cAAc,EAAE,MAAM,EACtB,EAAE,OAAY,EAAE,GAAE,iBAAiB,CAAC,KAAK,CAAM,EAsBhD;IAED,IAAI,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAM3C;IAEK,WAAW,CAAC,EAChB,qBAA4B,GAC7B,GAAE,kBAAuB,GAAG,OAAO,CAAC,cAAc,CAAC,CAiBnD;IAEK,WAAW,CACf,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,oBAAoB,CAAC,CAW/B;IAED,qBAAqB,CACnB,MAAM,SAAS,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,KAAK,EACrD,MAAM,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,EAC1C,EACA,WAAW,EACX,GAAG,OAAO,EACX,EAAE,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,oBAAoB,CACzD,KAAK,EACL,MAAM,EACN,MAAM,EACN,QAAQ,CACT,CAMA;IAED,qBAAqB,CACnB,IAAI,SAAS,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,KAAK,EACnD,MAAM,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,EAC1C,EACA,WAAW,EACX,GAAG,OAAO,EACX,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,oBAAoB,CACvD,KAAK,EACL,MAAM,EACN,KAAK,CAAC,KAAK,CAAC,EACZ,IAAI,CACL,CAMA;IAEK,SAAS,CAAC,MAAM,EAAE,eAAe,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAkB9D;IAEK,UAAU,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAM9C;IAEK,SAAS,CACb,CAAC,SAAS,OAAO,CACf,MAAM,KAAK,EACX,YAAY,GAAG,8BAA8B,CAC9C,EAED,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,EAC7D,wBAAwB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,GACvD,OAAO,CAAC,KAAK,CAAC,CAMhB;IAEK,iBAAiB,CACrB,CAAC,SAAS,OAAO,CACf,MAAM,KAAK,EACX,YAAY,GAAG,8BAA8B,CAC9C,EAED,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,EAC7D,wBAAwB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,GACvD,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAuC7C;IAED,cAAc,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAEjD;IAEK,kBAAkB,CACtB,GAAG,EAAE,QAAQ,EACb,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,EAC5B,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,GACzB,OAAO,CAAC,KAAK,CAAC,CAYhB;IAED,gBAAgB,CACd,MAAM,EAAE,KAAK,EACb,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,GAC3B,OAAO,CAAC,KAAK,CAAC,CAEhB;IAED,iBAAiB,CACf,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,EACzB,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,GAC3B,OAAO,CAAC,IAAI,CAAC,CAOf;IAED,WAAW,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAMpE;IAED,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAEtC;IAED,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAInD;IAEK,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAKrD;IAEK,MAAM,CAAC,MAAM,SAAS,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,EAChD,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EACxB,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAClB,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GACrB,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAQ/C;IAEK,SAAS,CACb,GAAG,EAAE,QAAQ,EACb,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,GACzB,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAO5B;IAED,OAAO,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAIxE;IAEK,OAAO,CACX,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,EACvB,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GACjB,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAM5B;CACF"}
+{"version":3,"file":"MongoStore.d.ts","sourceRoot":"","sources":["../../src/MongoStore.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,QAAQ,EACR,YAAY,EACZ,MAAM,EACN,8BAA8B,EAC9B,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,EACX,IAAI,EACJ,iBAAiB,EACjB,MAAM,EACN,mBAAmB,EACnB,YAAY,EACZ,WAAW,EACZ,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EACV,UAAU,EAKX,MAAM,SAAS,CAAC;AAEjB,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,YAAY,EACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAC;AACxD,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAK7D,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,oBAAoB,CAAC;AAgB5B,MAAM,MAAM,iBAAiB,CAC3B,QAAQ,SAAS,eAAe,EAChC,KAAK,SAAS,cAAc,CAAC,QAAQ,CAAC,IACpC,YAAY,CAAC,KAAK,CAAC,CAAC;AAExB,MAAM,WAAW,iBAAiB,CAAC,KAAK,SAAS,cAAc,CAAC,GAAG,CAAC;IAClE,OAAO,CAAC,EAAE,SAAS,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;CACxC;AAED,MAAM,CAAC,OAAO,OAAO,UAAU,CAC7B,KAAK,SAAS,cAAc,CAAC,QAAQ,CAAC,EACtC,QAAQ,SAAS,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,CACtD,YAAW,iBAAiB,CAC5B,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,eAAe,CAAC,KAAK,CAAC,EACtB,eAAe,CAChB;IACC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAS;IAEvC,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IAErC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA+B;IAE/D,OAAO,CAAC,WAAW,CAAiD;IAEpE,YACE,UAAU,EAAE,eAAe,EAC3B,cAAc,EAAE,MAAM,EACtB,EAAE,OAAY,EAAE,GAAE,iBAAiB,CAAC,KAAK,CAAM,EAsBhD;IAED,IAAI,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAM3C;IAEK,WAAW,CAAC,EAChB,qBAA4B,GAC7B,GAAE,kBAAuB,GAAG,OAAO,CAAC,cAAc,CAAC,CAiBnD;IAEK,WAAW,CACf,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,oBAAoB,CAAC,CAW/B;IAED,qBAAqB,CACnB,MAAM,SAAS,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,KAAK,EACrD,MAAM,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,EAC1C,EACA,WAAW,EACX,GAAG,OAAO,EACX,EAAE,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,oBAAoB,CACzD,KAAK,EACL,MAAM,EACN,MAAM,EACN,QAAQ,CACT,CAMA;IAED,qBAAqB,CACnB,IAAI,SAAS,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,KAAK,EACnD,MAAM,SAAS,WAAW,CAAC,MAAM,CAAC,GAAG,KAAK,EAC1C,EACA,WAAW,EACX,GAAG,OAAO,EACX,EAAE,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,oBAAoB,CACvD,KAAK,EACL,MAAM,EACN,KAAK,CAAC,KAAK,CAAC,EACZ,IAAI,CACL,CAMA;IAEK,SAAS,CAAC,MAAM,EAAE,eAAe,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAkB9D;IAED;;;OAGG;IACG,UAAU,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAW9C;IAED,0FAA0F;IACpF,kBAAkB,CACtB,MAAM,EAAE,KAAK,GACZ,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAgBzC;IAEK,SAAS,CACb,CAAC,SAAS,OAAO,CACf,MAAM,KAAK,EACX,YAAY,GAAG,8BAA8B,CAC9C,EAED,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,EAC7D,wBAAwB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,GACvD,OAAO,CAAC,KAAK,CAAC,CAMhB;IAEK,iBAAiB,CACrB,CAAC,SAAS,OAAO,CACf,MAAM,KAAK,EACX,YAAY,GAAG,8BAA8B,CAC9C,EAED,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,EAC7D,wBAAwB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,GACvD,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CA6C7C;IAED,cAAc,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAEjD;IAEK,kBAAkB,CACtB,GAAG,EAAE,QAAQ,EACb,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,EAC5B,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAC1B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,KAAK,CAAC,CAUhB;IAED;;;;OAIG;IACG,0BAA0B,CAC9B,GAAG,EAAE,QAAQ,EACb,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,EAC5B,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAC1B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAWjD;IAED,gBAAgB,CACd,MAAM,EAAE,KAAK,EACb,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,EAC5B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,KAAK,CAAC,CAOhB;IAED,wEAAwE;IAClE,iBAAiB,CACrB,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,EACzB,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,EAC5B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,IAAI,CAAC,CAOf;IAEK,WAAW,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAEK,mBAAmB,CACvB,GAAG,EAAE,QAAQ,EACb,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,GACzB,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAS1C;IAED,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAEtC;IAED,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAInD;IAEK,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAKrD;IAEK,MAAM,CAAC,MAAM,SAAS,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,EAChD,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EACxB,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAClB,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GACrB,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAQ/C;IAEK,SAAS,CACb,GAAG,EAAE,QAAQ,EACb,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,GACzB,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAO5B;IAED,OAAO,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAIxE;IAEK,OAAO,CACX,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,EACvB,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GACjB,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAM5B;CACF"}

package/dist/definitions/SubscribeStore.integration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SubscribeStore.integration.test.d.ts.map

package/dist/definitions/SubscribeStore.integration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubscribeStore.integration.test.d.ts","sourceRoot":"","sources":["../../src/SubscribeStore.integration.test.ts"],"names":[],"mappings":""}

package/dist/definitions/writes/createReplacePipeline.d.ts

@@ -0,0 +1,10 @@
+import type { Document } from "mongodb";
+import type { MongoBaseModel } from "../MongoBaseModel.ts";
+/**
+ * Replaces the stored document with `replacement` while keeping the stored `created`
+ * (falling back to the replacement's when the stored document has none).
+ * `$literal` keeps string values starting with `$` from being read as field paths.
+ * Update pipelines require MongoDB >= 4.2.
+ */
+export declare const createReplacePipeline: (replacement: MongoBaseModel<any>) => Document[];
+//# sourceMappingURL=createReplacePipeline.d.ts.map

package/dist/definitions/writes/createReplacePipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createReplacePipeline.d.ts","sourceRoot":"","sources":["../../../src/writes/createReplacePipeline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,gBACnB,cAAc,CAAC,GAAG,CAAC,KAC/B,QAAQ,EAWV,CAAC"}

package/dist/definitions/writes/stampPartialUpdate.d.ts

@@ -0,0 +1,9 @@
+import type { BaseModel, Update } from "liwi-store";
+/**
+ * Throws `ProtectedFieldUpdateError` when the update touches `created`, or touches
+ * `updated` with an operator other than `$set`, `$currentDate` or `$max`.
+ * Otherwise returns the update with `updated` set to `now`, unless the caller sets
+ * `updated` itself or `now` is `undefined`. The caller's update is never mutated.
+ */
+export declare const stampPartialUpdate: <Model extends BaseModel>(update: Update<Model>, now: Date | undefined) => Update<Model>;
+//# sourceMappingURL=stampPartialUpdate.d.ts.map

package/dist/definitions/writes/stampPartialUpdate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stampPartialUpdate.d.ts","sourceRoot":"","sources":["../../../src/writes/stampPartialUpdate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAoEpD;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,KAAK,SAAS,SAAS,UAChD,MAAM,CAAC,KAAK,CAAC,OAChB,IAAI,GAAG,SAAS,KACpB,MAAM,CAAC,KAAK,CAKd,CAAC"}

package/dist/definitions/writes/stampPartialUpdate.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=stampPartialUpdate.test.d.ts.map

package/dist/definitions/writes/stampPartialUpdate.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stampPartialUpdate.test.d.ts","sourceRoot":"","sources":["../../../src/writes/stampPartialUpdate.test.ts"],"names":[],"mappings":""}

package/dist/index-node.mjs

@@ -1,7 +1,7 @@
+import { AbstractStoreCursor, ProtectedFieldUpdateError, NotFoundError, AbstractConnection } from 'liwi-store';
 import mongodb from 'mongodb';
-import { AbstractStoreCursor, AbstractConnection } from 'liwi-store';
 import { AbstractSubscribableStoreQuery, SubscribeStore } from 'liwi-subscribe-store';
-import mingo from 'mingo';
+import { Query } from 'mingo';
 import { Logger } from 'nightingale-logger';
 
 class MongoCursor extends AbstractStoreCursor {
@@ -35,11 +35,10 @@ class MongoCursor extends AbstractStoreCursor {
     if (!this._result) throw new Error("Cannot call result() before next()");
     return Promise.resolve(this._result);
   }
-  close() {
+  async close() {
     if (this.cursor) {
-      this.cursor.close();
+      await this.cursor.close();
     }
-    return Promise.resolve();
   }
   toArray() {
     return this.cursor.toArray();
@@ -66,7 +65,7 @@ class MongoQueryCollection extends AbstractSubscribableStoreQuery {
       if ("$text" in this.options.criteria) {
         return () => false;
       }
-      const mingoQuery = new mingo.Query(this.options.criteria);
+      const mingoQuery = new Query(this.options.criteria);
       this.testCriteria = mingoQuery.test.bind(mingoQuery);
     }
     return this.testCriteria;
@@ -195,7 +194,7 @@ class MongoQuerySingleItem extends AbstractSubscribableStoreQuery {
       if (!this.options.criteria) {
         return () => true;
       }
-      const mingoQuery = new mingo.Query(this.options.criteria);
+      const mingoQuery = new Query(this.options.criteria);
       this.testCriteria = mingoQuery.test.bind(mingoQuery);
     }
     return this.testCriteria;
@@ -215,6 +214,49 @@ class MongoQuerySingleItem extends AbstractSubscribableStoreQuery {
       });
     });
   }
+  async computeChanges(action, testCriteria) {
+    switch (action.type) {
+      case "inserted": {
+        const filtered = action.next.filter(testCriteria);
+        if (filtered.length === 0) return [];
+        return [{ type: "updated", result: this.transformer(filtered[0]) }];
+      }
+      case "deleted": {
+        const filtered = action.prev.filter(testCriteria);
+        if (filtered.length === 0) return [];
+        return [
+          {
+            type: "deleted",
+            keys: filtered.map((object) => object[this.store.keyPath])
+          }
+        ];
+      }
+      case "updated": {
+        const filtered = action.changes.filter(
+          ([prev, next2]) => testCriteria(prev) || testCriteria(next2)
+        );
+        if (filtered.length === 0) return [];
+        if (this.options.sort) {
+          const { result } = await this.fetch((res) => res);
+          return [{ type: "updated", result }];
+        }
+        if (filtered.length > 1) {
+          throw new Error(
+            "should not match more than 1, use sort if you can have multiple match"
+          );
+        }
+        const [, next] = filtered[0];
+        return [
+          {
+            type: "updated",
+            result: testCriteria(next) ? this.transformer(next) : null
+          }
+        ];
+      }
+      default:
+        throw new Error("Unsupported type");
+    }
+  }
   _subscribe(callback, _includeInitial) {
     const store = super.getSubscribeStore();
     const testCriteria = this.createMingoTestCriteria();
@@ -229,55 +271,12 @@ class MongoQuerySingleItem extends AbstractSubscribableStoreQuery {
       ]);
     }) : Promise.resolve();
     const unsubscribe = store.subscribe(async (action) => {
-      const changes = [];
-      switch (action.type) {
-        case "inserted": {
-          const filtered = action.next.filter(testCriteria);
-          if (filtered.length > 0) {
-            changes.push({
-              type: "updated",
-              result: this.transformer(filtered[0])
-            });
-          }
-          break;
-        }
-        case "deleted": {
-          const filtered = action.prev.filter(testCriteria);
-          if (filtered.length > 0) {
-            changes.push({
-              type: "deleted",
-              keys: filtered.map((object) => object[this.store.keyPath])
-            });
-          }
-          break;
-        }
-        case "updated": {
-          const filtered = action.changes.filter(
-            ([prev, next]) => testCriteria(prev)
-          );
-          if (filtered.length > 0) {
-            if (this.options.sort) {
-              const { result } = await this.fetch((res) => res);
-              changes.push({
-                type: "updated",
-                result
-              });
-            } else if (filtered.length !== 1) {
-              throw new Error(
-                "should not match more than 1, use sort if you can have multiple match"
-              );
-            } else {
-              const [, next] = filtered[0];
-              changes.push({
-                type: "updated",
-                result: testCriteria(next) ? this.transformer(next) : null
-              });
-            }
-          } else if (filtered.length === 0) ;
-          break;
-        }
-        default:
-          throw new Error("Unsupported type");
+      let changes;
+      try {
+        changes = await this.computeChanges(action, testCriteria);
+      } catch (error) {
+        callback(error, []);
+        return;
       }
       if (changes.length === 0) return;
       callback(null, changes);
@@ -709,6 +708,72 @@ const diffIndexes = ({
 };
 const isMongoIndexPlanEmpty = (plan) => plan.toCreate.length === 0 && plan.toRecreate.length === 0 && plan.toCollMod.length === 0 && plan.toDrop.length === 0;
 
+const createReplacePipeline = (replacement) => [
+  {
+    $replaceWith: {
+      $mergeObjects: [
+        { $literal: replacement },
+        {
+          created: { $ifNull: ["$created", { $literal: replacement.created }] }
+        }
+      ]
+    }
+  }
+];
+
+const protectedFields = ["created", "updated"];
+const updatedOverrideOperators = /* @__PURE__ */ new Set([
+  "$set",
+  "$currentDate",
+  "$max"
+]);
+const findProtectedField = (path) => protectedFields.find(
+  (field) => path === field || path.startsWith(`${field}.`)
+);
+const listTouchedPaths = (operator, fields) => {
+  const keys = Object.keys(fields);
+  if (operator !== "$rename") return keys;
+  const renameTargets = Object.values(fields).filter(
+    (target) => typeof target === "string"
+  );
+  return [...keys, ...renameTargets];
+};
+const describeRejection = (field, operator, path) => field === "created" ? `Cannot use ${operator} on "${path}": created is set on insert and never updated` : `Cannot use ${operator} on "${path}": updated can only be set with $set, $currentDate or $max`;
+const validateProtectedFields = (update) => {
+  let isUpdatedSetByCaller = false;
+  const operations = Object.entries(
+    update
+  );
+  for (const [operator, fields] of operations) {
+    if (!fields) continue;
+    for (const path of listTouchedPaths(operator, fields)) {
+      const field = findProtectedField(path);
+      if (!field) continue;
+      if (field === "updated" && path === "updated" && updatedOverrideOperators.has(operator)) {
+        isUpdatedSetByCaller = true;
+        continue;
+      }
+      throw new ProtectedFieldUpdateError(
+        describeRejection(field, operator, path)
+      );
+    }
+  }
+  return { isUpdatedSetByCaller };
+};
+const stampPartialUpdate = (update, now) => {
+  const { isUpdatedSetByCaller } = validateProtectedFields(update);
+  if (isUpdatedSetByCaller || !now) return update;
+  const $set = { ...update.$set, updated: now };
+  return { ...update, $set };
+};
+
+const resolveWriteTime = (options) => options?.touchUpdated === false ? void 0 : /* @__PURE__ */ new Date();
+const toStoredValues = (values) => Object.fromEntries(
+  Object.entries(values).map(([field, value]) => [
+    field,
+    value === void 0 ? null : value
+  ])
+);
 class MongoStore {
   keyPath = "_id";
   connection;
@@ -802,11 +867,37 @@ class MongoStore {
     }
     return object;
   }
+  /**
+   * Always sets `updated` to the write time and keeps the stored `created`: the
+   * object's own `created` and `updated` are ignored. The object is not mutated.
+   */
   async replaceOne(object) {
-    if (!object.updated) object.updated = /* @__PURE__ */ new Date();
     const collection = await this.collection;
-    await collection.replaceOne({ _id: object._id }, object);
-    return object;
+    const next = await collection.findOneAndUpdate(
+      { _id: object._id },
+      createReplacePipeline({ ...object, updated: /* @__PURE__ */ new Date() }),
+      { returnDocument: "after" }
+    );
+    if (!next) {
+      throw new NotFoundError(`Document not found: ${String(object._id)}`);
+    }
+    return next;
+  }
+  /** Same rules as `replaceOne`; `next` is derived from the atomic `prev`, no read back. */
+  async replaceOneWithInfo(object) {
+    const replacement = { ...object, updated: /* @__PURE__ */ new Date() };
+    const collection = await this.collection;
+    const prev = await collection.findOneAndUpdate(
+      { _id: object._id },
+      createReplacePipeline(replacement),
+      { returnDocument: "before" }
+    );
+    if (!prev) return void 0;
+    const storedCreated = prev.created;
+    return {
+      prev,
+      next: { ...replacement, created: storedCreated ?? replacement.created }
+    };
   }
   async upsertOne(object, setOnInsertPartialObject) {
     const result = await this.upsertOneWithInfo(
@@ -816,6 +907,11 @@ class MongoStore {
     return result.object;
   }
   async upsertOneWithInfo(object, setOnInsertPartialObject) {
+    if (setOnInsertPartialObject && "updated" in setOnInsertPartialObject) {
+      throw new ProtectedFieldUpdateError(
+        'Cannot use $setOnInsert on "updated": upsert always sets it with $set, pass it in the object instead'
+      );
+    }
     const $setOnInsert = {
       // @ts-expect-error -- created is Date as set in BaseModel
       created: object.created || /* @__PURE__ */ new Date(),
@@ -840,7 +936,7 @@ class MongoStore {
         object
       };
     }
-    const next = { ...prev, ...$set };
+    const next = { ...prev, ...toStoredValues($set) };
     return {
       resolvedAs: "updated",
       inserted: false,
@@ -851,34 +947,62 @@ class MongoStore {
   replaceSeveral(objects) {
     return Promise.all(objects.map((object) => this.replaceOne(object)));
   }
-  async partialUpdateByKey(key, partialUpdate, criteria) {
+  async partialUpdateByKey(key, partialUpdate, criteria, options) {
+    const update = stampPartialUpdate(partialUpdate, resolveWriteTime(options));
     const collection = await this.collection;
-    const commandResult = await collection.updateOne(
+    const next = await collection.findOneAndUpdate(
       { _id: key, ...criteria },
-      partialUpdate
+      update,
+      { returnDocument: "after" }
+    );
+    if (!next) throw new NotFoundError(`Document not found: ${String(key)}`);
+    return next;
+  }
+  /**
+   * `prev` is read atomically with the write. `next` is read right after it,
+   * so it may already include a later concurrent write, which emits its own change.
+   * Resolves `undefined` when no document matches.
+   */
+  async partialUpdateByKeyWithInfo(key, partialUpdate, criteria, options) {
+    const update = stampPartialUpdate(partialUpdate, resolveWriteTime(options));
+    const collection = await this.collection;
+    const prev = await collection.findOneAndUpdate(
+      { _id: key, ...criteria },
+      update,
+      { returnDocument: "before" }
+    );
+    if (!prev) return void 0;
+    return { prev, next: await this.findByKey(key) };
+  }
+  partialUpdateOne(object, partialUpdate, options) {
+    return this.partialUpdateByKey(
+      object._id,
+      partialUpdate,
+      void 0,
+      options
     );
-    if (!commandResult.acknowledged) {
-      console.error(commandResult);
-      throw new Error("Update failed");
-    }
-    const object = await this.findByKey(key);
-    return object;
   }
-  partialUpdateOne(object, partialUpdate) {
-    return this.partialUpdateByKey(object._id, partialUpdate);
+  /** One `updateMany` command; every document gets the same `updated`. */
+  async partialUpdateMany(criteria, partialUpdate, options) {
+    const update = stampPartialUpdate(partialUpdate, resolveWriteTime(options));
+    const collection = await this.collection;
+    await collection.updateMany(
+      criteria,
+      update
+    );
   }
-  partialUpdateMany(criteria, partialUpdate) {
-    return this.collection.then(
-      (collection) => (
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-        collection.updateMany(criteria, partialUpdate)
-      )
-    ).then((res) => void 0);
+  async deleteByKey(key, criteria) {
+    const collection = await this.collection;
+    await collection.deleteOne({ _id: key, ...criteria });
   }
-  deleteByKey(key, criteria) {
-    return this.collection.then(
-      (collection) => collection.deleteOne({ _id: key, ...criteria })
-    ).then(() => void 0);
+  async deleteByKeyWithInfo(key, criteria) {
+    const collection = await this.collection;
+    const prev = await collection.findOneAndDelete({
+      _id: key,
+      ...criteria
+    });
+    if (!prev) return void 0;
+    return { prev };
   }
   deleteOne(object) {
     return this.deleteByKey(object._id);
@@ -920,25 +1044,33 @@ class MongoStore {
 }
 
 const logger$1 = new Logger("liwi:mongo:MongoConnection");
+const buildMongoConnectionString = ({
+  host = "localhost",
+  port = "27017",
+  database,
+  user,
+  password,
+  authSource,
+  redactCredentials
+}) => `mongodb://${user ? `${redactCredentials ? `${user.slice(0, 2)}[redacted]` : encodeURIComponent(user)}:${redactCredentials ? "[redacted]" : encodeURIComponent(password ?? "")}@` : ""}${host}:${port}/${encodeURIComponent(database)}${authSource ? `?authSource=${encodeURIComponent(authSource)}` : ""}`;
 class MongoConnection extends AbstractConnection {
   _connection;
   _connecting;
   connectionFailed;
   // TODO interface
-  constructor({
-    host = "localhost",
-    port = "27017",
-    database,
-    user,
-    password
-  }) {
+  constructor(config) {
     super();
-    if (!database) {
+    if (!config.database) {
       throw new Error("Missing config database");
     }
-    const buildConnectionString = (redactCredentials) => `mongodb://${user ? `${redactCredentials ? `${user.slice(0, 2)}[redacted]` : encodeURIComponent(user)}:${redactCredentials ? "[redacted]" : encodeURIComponent(password ?? "")}@` : ""}${host}:${port}/${encodeURIComponent(database)}`;
-    const connectionString = buildConnectionString(false);
-    const connectionStringRedacted = buildConnectionString(true);
+    const connectionString = buildMongoConnectionString({
+      ...config,
+      redactCredentials: false
+    });
+    const connectionStringRedacted = buildMongoConnectionString({
+      ...config,
+      redactCredentials: true
+    });
     this.connect(connectionString, connectionStringRedacted);
   }
   connect(connectionString, connectionStringRedacted) {