@lossless.org/client 1.6.0 → 1.8.0

package/dist_ts/nosqldb/classes.exactpersistence.d.ts

@@ -73,7 +73,21 @@ export interface IExactSessionOptions {
 export interface IExactReadOptions extends IExactSessionOptions {
     signal?: AbortSignal;
 }
-export interface IFindStoredOptions<TPersisted extends object> extends IExactReadOptions {
+/**
+ * Options of every exact call: `insert()`, `transition()`, `delete()`,
+ * `count()`, `distinct()` and `findStoredOne()`, and through
+ * `IFindStoredOptions` `findStored()`.
+ */
+export interface IExactBoundedOptions extends IExactReadOptions {
+    /**
+     * Client deadline (1..120000 ms), handed to the driver as its client-side
+     * operation timeout for every command of the call, including the wait for
+     * the lazy first-touch preparation. Inside a transaction with a deadline it
+     * is refused; the transaction's deadline bounds the call.
+     */
+    timeoutMS?: number;
+}
+export interface IFindStoredOptions<TPersisted extends object> extends IExactBoundedOptions {
     filter?: MongoFilter<TStoredDocument<TPersisted>>;
     sort?: Partial<Record<TExactDocumentPath<TStoredDocument<TPersisted>>, 1 | -1>>;
     skip?: number;
@@ -102,7 +116,22 @@ export declare class SmartdataExactCollection<TModel extends SmartDataDbDoc<any,
     private initializeOnce;
     prepare(): Promise<void>;
     private beginOperation;
+    /**
+     * Runs one exact call on its session lease under its client deadline and
+     * signal. A signal that is already aborted rejects with its reason before
+     * anything is sent. An expired driver deadline surfaces as the `timeout`
+     * persistence error; a write the deadline or signal interrupts in flight
+     * is reported by the write itself as `ambiguous_write`, and inside a
+     * transaction any interruption fails the attempt.
+     */
     private runOperation;
+    /**
+     * The error of a non-transactional write that its client deadline or
+     * signal interrupted after the write was handed to the driver: the command
+     * may have reached the database, so its outcome is unknown and no
+     * reconciliation read runs on the interrupted call's budget.
+     */
+    private interruptedWriteError;
     private canonicalizeDocument;
     private assertAllowedTopLevelKeys;
     private canonicalizePersistedDocument;
@@ -119,20 +148,20 @@ export declare class SmartdataExactCollection<TModel extends SmartDataDbDoc<any,
     private ambiguousWriteError;
     private canonicalizeDeleteCurrent;
     private reconcileDeleteOutcome;
-    insert(documentArg: TModel | TExactPersistedDocument<TPersisted>, optionsArg?: IExactSessionOptions): Promise<TExactInsertResult<TPersisted>>;
+    insert(documentArg: TModel | TExactPersistedDocument<TPersisted>, optionsArg?: IExactBoundedOptions): Promise<TExactInsertResult<TPersisted>>;
     toPersisted(storedDocumentArg: TStoredDocument<TPersisted>): TExactPersistedDocument<TPersisted>;
     canonicalBytes(persistedDocumentArg: TExactPersistedDocument<TPersisted>): Uint8Array;
-    findStoredOne(filterArg: MongoFilter<TStoredDocument<TPersisted>>, optionsArg?: IExactReadOptions): Promise<TStoredDocument<TPersisted> | null>;
+    findStoredOne(filterArg: MongoFilter<TStoredDocument<TPersisted>>, optionsArg?: IExactBoundedOptions): Promise<TStoredDocument<TPersisted> | null>;
     findStored(optionsArg?: IFindStoredOptions<TPersisted>): Promise<Array<TStoredDocument<TPersisted>>>;
-    count(filterArg?: MongoFilter<TStoredDocument<TPersisted>>, optionsArg?: IExactSessionOptions): Promise<number>;
-    distinct<TField extends TExactDocumentPath<TStoredDocument<TPersisted>>>(fieldArg: TField, filterArg?: MongoFilter<TStoredDocument<TPersisted>>, optionsArg?: IExactSessionOptions): Promise<Array<TExactDistinctValue<TExactDocumentPathValue<TStoredDocument<TPersisted>, TField>>>>;
+    count(filterArg?: MongoFilter<TStoredDocument<TPersisted>>, optionsArg?: IExactBoundedOptions): Promise<number>;
+    distinct<TField extends TExactDocumentPath<TStoredDocument<TPersisted>>>(fieldArg: TField, filterArg?: MongoFilter<TStoredDocument<TPersisted>>, optionsArg?: IExactBoundedOptions): Promise<Array<TExactDistinctValue<TExactDocumentPathValue<TStoredDocument<TPersisted>, TField>>>>;
     transition(optionsArg: {
         current: TStoredDocument<TPersisted>;
         change: (modelArg: TModel) => void;
-    }, sessionOptionsArg?: IExactSessionOptions): Promise<TExactTransitionResult<TPersisted>>;
+    }, sessionOptionsArg?: IExactBoundedOptions): Promise<TExactTransitionResult<TPersisted>>;
     delete(optionsArg: {
         current: TStoredDocument<TPersisted>;
-    }, sessionOptionsArg?: IExactSessionOptions): Promise<TExactDeleteResult>;
+    }, sessionOptionsArg?: IExactBoundedOptions): Promise<TExactDeleteResult>;
 }
 export declare function exactPersistence<TAssertion extends TExactDocumentAssertion<object>>(optionsArg: {
     assertDocument: TAssertion;