@firebase/firestore 3.11.0 → 3.12.0-20230511201449

package/dist/lite/internal.d.ts

@@ -763,6 +763,7 @@ declare class DatabaseInfo {
     readonly ssl: boolean;
     readonly forceLongPolling: boolean;
     readonly autoDetectLongPolling: boolean;
+    readonly longPollingOptions: ExperimentalLongPollingOptions;
     readonly useFetchStreams: boolean;
     /**
      * Constructs a DatabaseInfo using the provided host, databaseId and
@@ -778,10 +779,11 @@ declare 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: DatabaseId, appId: string, persistenceKey: string, host: string, ssl: boolean, forceLongPolling: boolean, autoDetectLongPolling: boolean, useFetchStreams: boolean);
+    constructor(databaseId: DatabaseId, appId: string, persistenceKey: string, host: string, ssl: boolean, forceLongPolling: boolean, autoDetectLongPolling: boolean, longPollingOptions: ExperimentalLongPollingOptions, useFetchStreams: boolean);
 }
 
 /**
@@ -1308,6 +1310,53 @@ declare interface EventManager {
     onUnlisten?: (query: Query_2) => Promise<void>;
 }
 
+/**
+ * @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.
+ */
+/**
+ * Options that configure the SDK’s underlying network transport (WebChannel)
+ * when long-polling is used.
+ *
+ * Note: This interface is "experimental" and is subject to change.
+ *
+ * See `FirestoreSettings.experimentalAutoDetectLongPolling`,
+ * `FirestoreSettings.experimentalForceLongPolling`, and
+ * `FirestoreSettings.experimentalLongPollingOptions`.
+ */
+declare interface ExperimentalLongPollingOptions {
+    /**
+     * The desired maximum timeout interval, in seconds, to complete a
+     * long-polling GET response. Valid values are between 5 and 30, inclusive.
+     * Floating point values are allowed and will be rounded to the nearest
+     * millisecond.
+     *
+     * By default, when long-polling is used the "hanging GET" request sent by
+     * the client times out after 30 seconds. To request a different timeout
+     * from the server, set this setting with the desired timeout.
+     *
+     * Changing the default timeout may be useful, for example, if the buffering
+     * proxy that necessitated enabling long-polling in the first place has a
+     * shorter timeout for hanging GET requests, in which case setting the
+     * long-polling timeout to a shorter value, such as 25 seconds, may fix
+     * prematurely-closed hanging GET requests.
+     * For example, see https://github.com/firebase/firebase-js-sdk/issues/6987.
+     */
+    timeoutSeconds?: number;
+}
+
 declare class FieldFilter extends Filter {
     readonly field: FieldPath_2;
     readonly op: Operator;
@@ -1703,6 +1752,7 @@ declare class FirestoreSettingsImpl {
     readonly cacheSizeBytes: number;
     readonly experimentalForceLongPolling: boolean;
     readonly experimentalAutoDetectLongPolling: boolean;
+    readonly experimentalLongPollingOptions: ExperimentalLongPollingOptions;
     readonly ignoreUndefinedProperties: boolean;
     readonly useFetchStreams: boolean;
     readonly cache?: FirestoreLocalCache;
@@ -3715,6 +3765,7 @@ declare interface PrivateSettings extends Settings {
     cacheSizeBytes?: number;
     experimentalForceLongPolling?: boolean;
     experimentalAutoDetectLongPolling?: boolean;
+    experimentalLongPollingOptions?: ExperimentalLongPollingOptions;
     useFetchStreams?: boolean;
     localCache?: FirestoreLocalCache;
 }