@firebase/firestore 3.4.8-canary.5ce067663 → 3.4.8-canary.63caee2a5

package/dist/lite/internal.d.ts

@@ -2110,7 +2110,7 @@ declare class ResourcePath extends BasePath<ResourcePath> {
  * `updateFunction `is returned here. Otherwise, if the transaction failed, a
  * rejected promise with the corresponding failure error is returned.
  */
-export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;
+export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;
 
 /**
  * Returns a sentinel used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link @firebase/firestore/lite#(updateDoc:1)} to
@@ -2615,6 +2615,30 @@ declare class Transaction_2 {
     private ensureCommitNotCalled;
 }
 
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Options to customize transaction behavior.
+ */
+export declare interface TransactionOptions {
+    /** Maximum number of attempts to commit, after which transaction fails. Default is 5. */
+    readonly maxAttempts?: number;
+}
+
 /** Used to represent a field transform on a mutation. */
 declare class TransformOperation {
     private _;

package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts

@@ -243,7 +243,7 @@ declare class an {
 /**
  * Sentinel values that can be used when writing document fields with `set()`
  * or `update()`.
- */ declare class vn {
+ */ declare class bn {
     /**
      * @param _methodName - The public API endpoint that returns this class.
      * @hideconstructor
@@ -335,7 +335,7 @@ declare class an {
  *
  * Latitude values are in the range of [-90, 90].
  * Longitude values are in the range of [-180, 180].
- */ declare class bn {
+ */ declare class vn {
     /**
      * Creates a new immutable `GeoPoint` object with the provided latitude and
      * longitude values.
@@ -536,7 +536,7 @@ declare class gt {
      * to be compared using the `>`, `<=`, `>=` and `>` operators.
      */ valueOf(): string;
 }
-declare class Ur {
+declare class kr {
     /** @hideconstructor */
     constructor(t: any, e: any);
     _firestore: any;
@@ -548,14 +548,14 @@ declare class Ur {
      * @param documentRef - A reference to the document to be read.
      * @returns A `DocumentSnapshot` with the read data.
      */ get(t: any): any;
-    set(t: any, e: any, n: any): Ur;
-    update(t: any, e: any, n: any, ...r: any[]): Ur;
+    set(t: any, e: any, n: any): kr;
+    update(t: any, e: any, n: any, ...r: any[]): kr;
     /**
      * Deletes the document referred to by the provided {@link DocumentReference}.
      *
      * @param documentRef - A reference to the document to be deleted.
      * @returns This `Transaction` instance. Used for chaining method calls.
-     */ delete(t: any): Ur;
+     */ delete(t: any): kr;
 }
 /**
  * @license
@@ -624,7 +624,7 @@ declare class Ur {
  * @throws Error - If the provided input is not a valid Firestore document.
  * @returns A `Promise` resolved with a `DocumentReference` pointing to the
  * newly created document after it has been written to the backend.
- */ declare function Ar(t: any, e: any): Promise<an>;
+ */ declare function Ir(t: any, e: any): Promise<an>;
 /**
  * Returns a special value that can be used with {@link (setDoc:1)} or {@link
  * updateDoc:1} that tells the server to remove the given elements from any
@@ -635,7 +635,7 @@ declare class Ur {
  * @param elements - The elements to remove from the array.
  * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
  * `updateDoc()`
- */ declare function Dr(...t: any[]): xn;
+ */ declare function Dr(...t: any[]): Fn;
 /**
  * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
  * @firebase/firestore/lite#(updateDoc:1)} that tells the server to union the given elements with any array
@@ -647,7 +647,7 @@ declare class Ur {
  * @param elements - The elements to union into the array.
  * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
  * `updateDoc()`.
- */ declare function Vr(...t: any[]): Fn;
+ */ declare function Vr(...t: any[]): xn;
 declare function fn(t: any, e: any, ...n: any[]): ln;
 /**
  * Creates and returns a new `Query` instance that includes all documents in the
@@ -684,7 +684,7 @@ declare function fn(t: any, e: any, ...n: any[]): ln;
  * @param reference - A reference to the document to delete.
  * @returns A `Promise` resolved once the document has been successfully
  * deleted from the backend.
- */ declare function Ir(t: any): Promise<void>;
+ */ declare function Ar(t: any): Promise<void>;
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -724,7 +724,7 @@ declare function fr(...t: any[]): lr;
  * @param reference - The reference of the document to fetch.
  * @returns A Promise resolved with a `DocumentSnapshot` containing the current
  * document contents.
- */ declare function vr(t: any): Promise<Yn>;
+ */ declare function br(t: any): Promise<Yn>;
 /**
  * Executes the query and returns the results as a {@link QuerySnapshot}.
  *
@@ -736,7 +736,7 @@ declare function fr(...t: any[]): lr;
  *
  * @param query - The `Query` to execute.
  * @returns A Promise that will be resolved with the results of the query.
- */ declare function br(t: any): Promise<Kn>;
+ */ declare function vr(t: any): Promise<Kn>;
 /**
  * Returns the existing `Firestore` instance that is associated with the
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
@@ -832,7 +832,7 @@ declare function sn(t: any, e: any): import("../../lite").Firestore;
  * (the `updateFunction` returned a failed promise), the promise returned by the
  * `updateFunction `is returned here. Otherwise, if the transaction failed, a
  * rejected promise with the corresponding failure error is returned.
- */ declare function kr(t: any, e: any): Promise<any>;
+ */ declare function jr(t: any, e: any, n: any): Promise<any>;
 /**
  * Returns a sentinel used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link @firebase/firestore/lite#(updateDoc:1)} to
  * include a server-generated timestamp in the written data.
@@ -904,7 +904,7 @@ declare function Tr(t: any, e: any, n: any, ...r: any[]): Promise<void>;
  *
  * @returns A `WriteBatch` that can be used to atomically execute multiple
  * writes.
- */ declare function Fr(t: any): $r;
+ */ declare function xr(t: any): $r;
 /**
  * A dot-separated path for navigating sub-objects within a document.
  * @internal
@@ -979,40 +979,40 @@ import { FirebaseError as c } from "@firebase/util/dist/src/errors";
     q: any;
     /** Creates a new top-level parse context. */ ht(t: any, e: any, n: any, r?: boolean): Rn;
 }
-declare class xn extends vn {
+declare class Fn extends bn {
     constructor(t: any, e: any);
     lt: any;
-    _toFieldTransform(t: any): ve;
+    _toFieldTransform(t: any): be;
     isEqual(t: any): boolean;
 }
-declare class Fn extends vn {
+declare class xn extends bn {
     constructor(t: any, e: any);
     lt: any;
-    _toFieldTransform(t: any): ve;
+    _toFieldTransform(t: any): be;
     isEqual(t: any): boolean;
 }
-declare class Nn extends vn {
+declare class Nn extends bn {
     _toFieldTransform(t: any): null;
     isEqual(t: any): boolean;
 }
 declare class lr extends Zn {
     constructor(t: any, e: any, n: any);
     type: any;
-    bt: any;
+    vt: any;
     Et: any;
     _apply(t: any): hn;
 }
-declare class qn extends vn {
+declare class qn extends bn {
     constructor(t: any, e: any);
     ft: any;
-    _toFieldTransform(t: any): ve;
+    _toFieldTransform(t: any): be;
     isEqual(t: any): boolean;
 }
 declare class ir extends Zn {
     constructor(t: any, e: any, n: any);
     type: any;
     gt: any;
-    vt: any;
+    bt: any;
     _apply(t: any): hn;
 }
 declare class rr extends Zn {
@@ -1022,14 +1022,14 @@ declare class rr extends Zn {
     type: string;
     _apply(t: any): hn;
 }
-declare class Sn extends vn {
-    _toFieldTransform(t: any): ve;
+declare class Sn extends bn {
+    _toFieldTransform(t: any): be;
     isEqual(t: any): boolean;
 }
 declare class cr extends Zn {
     constructor(t: any, e: any, n: any);
     type: any;
-    bt: any;
+    vt: any;
     Et: any;
     _apply(t: any): hn;
 }
@@ -1134,9 +1134,9 @@ declare class J {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** A field path and the TransformOperation to perform upon it. */ declare class ve {
+/** A field path and the TransformOperation to perform upon it. */ declare class be {
     constructor(t: any, e: any);
     field: any;
     transform: any;
 }
-export { gn as Bytes, ln as CollectionReference, an as DocumentReference, Yn as DocumentSnapshot, yn as FieldPath, vn as FieldValue, rn as Firestore, U as FirestoreError, bn as GeoPoint, hn as Query, Zn as QueryConstraint, Hn as QueryDocumentSnapshot, Kn as QuerySnapshot, gt as Timestamp, Ur as Transaction, $r as WriteBatch, Ar as addDoc, Dr as arrayRemove, Vr as arrayUnion, fn as collection, dn as collectionGroup, un as connectFirestoreEmulator, Ir as deleteDoc, Rr as deleteField, wn as doc, _n as documentId, dr as endAt, fr as endBefore, vr as getDoc, br as getDocs, on as getFirestore, Nr as increment, sn as initializeFirestore, or as limit, ur as limitToLast, sr as orderBy, tr as query, pn as queryEqual, mn as refEqual, kr as runTransaction, Pr as serverTimestamp, Er as setDoc, w as setLogLevel, Jn as snapshotEqual, hr as startAfter, ar as startAt, cn as terminate, Tr as updateDoc, nr as where, Fr as writeBatch };
+export { gn as Bytes, ln as CollectionReference, an as DocumentReference, Yn as DocumentSnapshot, yn as FieldPath, bn as FieldValue, rn as Firestore, U as FirestoreError, vn as GeoPoint, hn as Query, Zn as QueryConstraint, Hn as QueryDocumentSnapshot, Kn as QuerySnapshot, gt as Timestamp, kr as Transaction, $r as WriteBatch, Ir as addDoc, Dr as arrayRemove, Vr as arrayUnion, fn as collection, dn as collectionGroup, un as connectFirestoreEmulator, Ar as deleteDoc, Rr as deleteField, wn as doc, _n as documentId, dr as endAt, fr as endBefore, br as getDoc, vr as getDocs, on as getFirestore, Nr as increment, sn as initializeFirestore, or as limit, ur as limitToLast, sr as orderBy, tr as query, pn as queryEqual, mn as refEqual, jr as runTransaction, Pr as serverTimestamp, Er as setDoc, w as setLogLevel, Jn as snapshotEqual, hr as startAfter, ar as startAt, cn as terminate, Tr as updateDoc, nr as where, xr as writeBatch };

package/dist/lite/packages/firestore/lite/index.d.ts

@@ -17,6 +17,7 @@ export { FieldValue } from '../src/lite-api/field_value';
 export { increment, arrayRemove, arrayUnion, serverTimestamp, deleteField } from '../src/lite-api/field_value_impl';
 export { FirestoreDataConverter, DocumentSnapshot, QueryDocumentSnapshot, QuerySnapshot, snapshotEqual } from '../src/lite-api/snapshot';
 export { WriteBatch, writeBatch } from '../src/lite-api/write_batch';
+export { TransactionOptions } from '../src/lite-api/transaction_options';
 export { Transaction, runTransaction } from '../src/lite-api/transaction';
 export { setLogLevel, LogLevelString as LogLevel } from '../src/util/log';
 export { Bytes } from '../src/lite-api/bytes';

package/dist/lite/packages/firestore/src/api/transaction.d.ts

@@ -19,6 +19,7 @@ import { DocumentReference } from '../lite-api/reference';
 import { Transaction as LiteTransaction } from '../lite-api/transaction';
 import { Firestore } from './database';
 import { DocumentSnapshot } from './snapshot';
+import { TransactionOptions } from './transaction_options';
 /**
  * A reference to a transaction.
  *
@@ -55,4 +56,4 @@ export declare class Transaction extends LiteTransaction {
  * `updateFunction `is returned here. Otherwise, if the transaction failed, a
  * rejected promise with the corresponding failure error is returned.
  */
-export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;
+export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

package/dist/lite/packages/firestore/src/api/transaction_options.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { TransactionOptions } from '../lite-api/transaction_options';

package/dist/lite/packages/firestore/src/api.d.ts

@@ -22,6 +22,7 @@ export { DocumentChange, DocumentSnapshot, QueryDocumentSnapshot, QuerySnapshot,
 export { DocumentReference, CollectionReference, Query, doc, collection, collectionGroup, SetOptions, DocumentData, UpdateData, WithFieldValue, PartialWithFieldValue, refEqual, queryEqual } from './api/reference';
 export { endAt, endBefore, startAt, startAfter, limit, limitToLast, where, orderBy, query, QueryConstraint, QueryConstraintType, OrderByDirection, WhereFilterOp } from './api/filter';
 export { Unsubscribe, SnapshotListenOptions } from './api/reference_impl';
+export { TransactionOptions } from './api/transaction_options';
 export { runTransaction, Transaction } from './api/transaction';
 export { getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, onSnapshot, onSnapshotsInSync, setDoc, updateDoc, deleteDoc, addDoc, executeWrite } from './api/reference_impl';
 export { FieldValue } from './api/field_value';

package/dist/lite/packages/firestore/src/core/firestore_client.d.ts

@@ -30,6 +30,7 @@ import { EventManager, ListenOptions, Observer } from './event_manager';
 import { Query } from './query';
 import { SyncEngine } from './sync_engine';
 import { Transaction } from './transaction';
+import { TransactionOptions } from './transaction_options';
 import { ViewSnapshot } from './view_snapshot';
 export declare const MAX_CONCURRENT_LIMBO_RESOLUTIONS = 100;
 /**
@@ -113,6 +114,6 @@ export declare function firestoreClientAddSnapshotsInSyncListener(client: Firest
  * been committed. For this reason, it is required that all reads are
  * performed before any writes. Transactions must be performed while online.
  */
-export declare function firestoreClientTransaction<T>(client: FirestoreClient, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;
+export declare function firestoreClientTransaction<T>(client: FirestoreClient, updateFunction: (transaction: Transaction) => Promise<T>, options: TransactionOptions): Promise<T>;
 export declare function firestoreClientLoadBundle(client: FirestoreClient, databaseId: DatabaseId, data: ReadableStream<Uint8Array> | ArrayBuffer | string, resultTask: LoadBundleTask): void;
 export declare function firestoreClientGetNamedQuery(client: FirestoreClient, queryName: string): Promise<NamedQuery | undefined>;

package/dist/lite/packages/firestore/src/core/transaction_options.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare const DEFAULT_TRANSACTION_OPTIONS: TransactionOptions;
+/**
+ * Options to customize transaction behavior.
+ */
+export declare interface TransactionOptions {
+    /** Maximum number of attempts to commit, after which transaction fails. Default is 5. */
+    readonly maxAttempts: number;
+}
+export declare function validateTransactionOptions(options: TransactionOptions): void;

package/dist/lite/packages/firestore/src/core/transaction_runner.d.ts

@@ -18,7 +18,7 @@ import { Datastore } from '../remote/datastore';
 import { AsyncQueue } from '../util/async_queue';
 import { Deferred } from '../util/promise';
 import { Transaction } from './transaction';
-export declare const DEFAULT_MAX_ATTEMPTS_COUNT = 5;
+import { TransactionOptions } from './transaction_options';
 /**
  * TransactionRunner encapsulates the logic needed to run and retry transactions
  * with backoff.
@@ -26,11 +26,12 @@ export declare const DEFAULT_MAX_ATTEMPTS_COUNT = 5;
 export declare class TransactionRunner<T> {
     private readonly asyncQueue;
     private readonly datastore;
+    private readonly options;
     private readonly updateFunction;
     private readonly deferred;
     private attemptsRemaining;
     private backoff;
-    constructor(asyncQueue: AsyncQueue, datastore: Datastore, updateFunction: (transaction: Transaction) => Promise<T>, deferred: Deferred<T>);
+    constructor(asyncQueue: AsyncQueue, datastore: Datastore, options: TransactionOptions, updateFunction: (transaction: Transaction) => Promise<T>, deferred: Deferred<T>);
     /** Runs the transaction and sets the result on deferred. */
     run(): void;
     private runWithBackOff;

package/dist/lite/packages/firestore/src/lite-api/transaction.d.ts

@@ -19,6 +19,7 @@ import { Firestore } from './database';
 import { FieldPath } from './field_path';
 import { DocumentReference, PartialWithFieldValue, SetOptions, UpdateData, WithFieldValue } from './reference';
 import { DocumentSnapshot } from './snapshot';
+import { TransactionOptions } from './transaction_options';
 /**
  * A reference to a transaction.
  *
@@ -116,4 +117,4 @@ export declare class Transaction {
  * `updateFunction `is returned here. Otherwise, if the transaction failed, a
  * rejected promise with the corresponding failure error is returned.
  */
-export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;
+export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

package/dist/lite/packages/firestore/src/lite-api/transaction_options.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Options to customize transaction behavior.
+ */
+export declare interface TransactionOptions {
+    /** Maximum number of attempts to commit, after which transaction fails. Default is 5. */
+    readonly maxAttempts?: number;
+}

package/dist/lite/private.d.ts

@@ -1970,7 +1970,7 @@ export declare function refEqual<T>(left: DocumentReference<T> | CollectionRefer
  * `updateFunction `is returned here. Otherwise, if the transaction failed, a
  * rejected promise with the corresponding failure error is returned.
  */
-export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>): Promise<T>;
+export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;
 
 /**
  * Returns a sentinel used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link @firebase/firestore/lite#(updateDoc:1)} to
@@ -2475,6 +2475,30 @@ declare class Transaction_2 {
     private ensureCommitNotCalled;
 }
 
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Options to customize transaction behavior.
+ */
+export declare interface TransactionOptions {
+    /** Maximum number of attempts to commit, after which transaction fails. Default is 5. */
+    readonly maxAttempts?: number;
+}
+
 /** Used to represent a field transform on a mutation. */
 declare class TransformOperation {
     private _;