@firebase/firestore 3.4.8-canary.69baecadd → 3.4.8-canary.6ceff4db0

package/dist/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/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/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/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/private.d.ts

@@ -4282,7 +4282,7 @@ declare type Resolver<T> = (value?: T) => void;
  * `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
@@ -5359,6 +5359,30 @@ declare class Transaction_3 {
     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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/firestore",
-  "version": "3.4.8-canary.69baecadd",
+  "version": "3.4.8-canary.6ceff4db0",
   "engines": {
     "node": ">=10.10.0"
   },
@@ -77,22 +77,22 @@
     "lite/package.json"
   ],
   "dependencies": {
-    "@firebase/component": "0.5.13-canary.69baecadd",
-    "@firebase/logger": "0.3.2-canary.69baecadd",
-    "@firebase/util": "1.5.2-canary.69baecadd",
-    "@firebase/webchannel-wrapper": "0.6.1-canary.69baecadd",
+    "@firebase/component": "0.5.13-canary.6ceff4db0",
+    "@firebase/logger": "0.3.2-canary.6ceff4db0",
+    "@firebase/util": "1.5.2-canary.6ceff4db0",
+    "@firebase/webchannel-wrapper": "0.6.1-canary.6ceff4db0",
     "@grpc/grpc-js": "^1.3.2",
     "@grpc/proto-loader": "^0.6.0",
     "node-fetch": "2.6.7",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {
-    "@firebase/app": "0.7.22-canary.69baecadd"
+    "@firebase/app": "0.7.22-canary.6ceff4db0"
   },
   "devDependencies": {
-    "@firebase/app": "0.7.22-canary.69baecadd",
-    "@firebase/app-compat": "0.1.23-canary.69baecadd",
-    "@firebase/auth": "0.19.12-canary.69baecadd",
+    "@firebase/app": "0.7.22-canary.6ceff4db0",
+    "@firebase/app-compat": "0.1.23-canary.6ceff4db0",
+    "@firebase/auth": "0.19.12-canary.6ceff4db0",
     "@rollup/plugin-alias": "3.1.5",
     "@rollup/plugin-json": "4.1.0",
     "@types/eslint": "7.28.0",
@@ -106,7 +106,7 @@
     "rollup-plugin-sourcemaps": "0.6.3",
     "rollup-plugin-terser": "7.0.2",
     "rollup-plugin-typescript2": "0.30.0",
-    "ts-node": "10.2.1",
+    "ts-node": "10.7.0",
     "typescript": "4.2.2"
   },
   "repository": {