@firebase/firestore 3.11.0 → 3.12.0-20230511201449

package/dist/index.node.mjs

@@ -9,7 +9,7 @@ import * as grpc from '@grpc/grpc-js';
 import * as protoLoader from '@grpc/proto-loader';
 
 const name = "@firebase/firestore";
-const version$1 = "3.11.0";
+const version$1 = "3.12.0-20230511201449";
 
 /**
  * @license
@@ -62,7 +62,7 @@ User.GOOGLE_CREDENTIALS = new User('google-credentials-uid');
 User.FIRST_PARTY = new User('first-party-uid');
 User.MOCK_USER = new User('mock-user');
 
-const version = "9.21.0";
+const version = "9.22.0-20230511201449";
 
 /**
  * @license
@@ -4323,10 +4323,11 @@ class DatabaseInfo {
      * when using WebChannel as the network transport.
      * @param autoDetectLongPolling - Whether to use the detectBufferingProxy
      * option when using WebChannel as the network transport.
+     * @param longPollingOptions Options that configure long-polling.
      * @param useFetchStreams Whether to use the Fetch API instead of
      * XMLHTTPRequest
      */
-    constructor(databaseId, appId, persistenceKey, host, ssl, forceLongPolling, autoDetectLongPolling, useFetchStreams) {
+    constructor(databaseId, appId, persistenceKey, host, ssl, forceLongPolling, autoDetectLongPolling, longPollingOptions, useFetchStreams) {
         this.databaseId = databaseId;
         this.appId = appId;
         this.persistenceKey = persistenceKey;
@@ -4334,6 +4335,7 @@ class DatabaseInfo {
         this.ssl = ssl;
         this.forceLongPolling = forceLongPolling;
         this.autoDetectLongPolling = autoDetectLongPolling;
+        this.longPollingOptions = longPollingOptions;
         this.useFetchStreams = useFetchStreams;
     }
 }
@@ -26935,6 +26937,40 @@ function firestoreClientSetIndexConfiguration(client, indexes) {
     });
 }
 
+/**
+ * @license
+ * Copyright 2023 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.
+ */
+/**
+ * Compares two `ExperimentalLongPollingOptions` objects for equality.
+ */
+function longPollingOptionsEqual(options1, options2) {
+    return options1.timeoutSeconds === options2.timeoutSeconds;
+}
+/**
+ * Creates and returns a new `ExperimentalLongPollingOptions` with the same
+ * option values as the given instance.
+ */
+function cloneLongPollingOptions(options) {
+    const clone = {};
+    if (options.timeoutSeconds !== undefined) {
+        clone.timeoutSeconds = options.timeoutSeconds;
+    }
+    return clone;
+}
+
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -26970,7 +27006,7 @@ function removeComponents(firestore) {
     }
 }
 function makeDatabaseInfo(databaseId, appId, persistenceKey, settings) {
-    return new DatabaseInfo(databaseId, appId, persistenceKey, settings.host, settings.ssl, settings.experimentalForceLongPolling, settings.experimentalAutoDetectLongPolling, settings.useFetchStreams);
+    return new DatabaseInfo(databaseId, appId, persistenceKey, settings.host, settings.ssl, settings.experimentalForceLongPolling, settings.experimentalAutoDetectLongPolling, cloneLongPollingOptions(settings.experimentalLongPollingOptions), settings.useFetchStreams);
 }
 
 /**
@@ -26992,7 +27028,17 @@ function makeDatabaseInfo(databaseId, appId, persistenceKey, settings) {
 // settings() defaults:
 const DEFAULT_HOST = 'firestore.googleapis.com';
 const DEFAULT_SSL = true;
-const DEFAULT_AUTO_DETECT_LONG_POLLING = false;
+// The minimum long-polling timeout is hardcoded on the server. The value here
+// should be kept in sync with the value used by the server, as the server will
+// silently ignore a value below the minimum and fall back to the default.
+// Googlers see b/266868871 for relevant discussion.
+const MIN_LONG_POLLING_TIMEOUT_SECONDS = 5;
+// No maximum long-polling timeout is configured in the server, and defaults to
+// 30 seconds, which is what Watch appears to use.
+// Googlers see b/266868871 for relevant discussion.
+const MAX_LONG_POLLING_TIMEOUT_SECONDS = 30;
+// Whether long-polling auto-detected is enabled by default.
+const DEFAULT_AUTO_DETECT_LONG_POLLING = true;
 /**
  * A concrete type describing all the values that can be applied via a
  * user-supplied `FirestoreSettings` object. This is a separate type so that
@@ -27000,7 +27046,7 @@ const DEFAULT_AUTO_DETECT_LONG_POLLING = false;
  */
 class FirestoreSettingsImpl {
     constructor(settings) {
-        var _a;
+        var _a, _b;
         if (settings.host === undefined) {
             if (settings.ssl !== undefined) {
                 throw new FirestoreError(Code.INVALID_ARGUMENT, "Can't provide ssl option if host option is not set");
@@ -27042,6 +27088,8 @@ class FirestoreSettingsImpl {
             this.experimentalAutoDetectLongPolling =
                 !!settings.experimentalAutoDetectLongPolling;
         }
+        this.experimentalLongPollingOptions = cloneLongPollingOptions((_b = settings.experimentalLongPollingOptions) !== null && _b !== void 0 ? _b : {});
+        validateLongPollingOptions(this.experimentalLongPollingOptions);
         this.useFetchStreams = !!settings.useFetchStreams;
     }
     isEqual(other) {
@@ -27053,9 +27101,26 @@ class FirestoreSettingsImpl {
                 other.experimentalForceLongPolling &&
             this.experimentalAutoDetectLongPolling ===
                 other.experimentalAutoDetectLongPolling &&
+            longPollingOptionsEqual(this.experimentalLongPollingOptions, other.experimentalLongPollingOptions) &&
             this.ignoreUndefinedProperties === other.ignoreUndefinedProperties &&
             this.useFetchStreams === other.useFetchStreams);
     }
+}
+function validateLongPollingOptions(options) {
+    if (options.timeoutSeconds !== undefined) {
+        if (isNaN(options.timeoutSeconds)) {
+            throw new FirestoreError(Code.INVALID_ARGUMENT, `invalid long polling timeout: ` +
+                `${options.timeoutSeconds} (must not be NaN)`);
+        }
+        if (options.timeoutSeconds < MIN_LONG_POLLING_TIMEOUT_SECONDS) {
+            throw new FirestoreError(Code.INVALID_ARGUMENT, `invalid long polling timeout: ${options.timeoutSeconds} ` +
+                `(minimum allowed value is ${MIN_LONG_POLLING_TIMEOUT_SECONDS})`);
+        }
+        if (options.timeoutSeconds > MAX_LONG_POLLING_TIMEOUT_SECONDS) {
+            throw new FirestoreError(Code.INVALID_ARGUMENT, `invalid long polling timeout: ${options.timeoutSeconds} ` +
+                `(maximum allowed value is ${MAX_LONG_POLLING_TIMEOUT_SECONDS})`);
+        }
+    }
 }
 
 /**