@firebase/firestore 4.6.0-canary.84f9ff008 → 4.6.0-canary.b74d8a211

package/dist/firestore/src/remote/connection.d.ts

@@ -83,10 +83,14 @@ export interface Connection {
  * A bidirectional stream that can be used to send an receive messages.
  *
  * A stream can be closed locally with close() or can be closed remotely or
- * through network errors. onClose is guaranteed to be called. onOpen will only
- * be called if the stream successfully established a connection.
+ * through network errors. onClose is guaranteed to be called. onOpen will be
+ * called once the stream is ready to send messages (which may or may not be
+ * before an actual connection to the backend has been established). The
+ * onConnected event is called when an actual, physical connection with the
+ * backend has been established, and may occur before or after the onOpen event.
  */
 export interface Stream<I, O> {
+    onConnected(callback: () => void): void;
     onOpen(callback: () => void): void;
     onClose(callback: (err?: FirestoreError) => void): void;
     onMessage(callback: (msg: O) => void): void;

package/dist/firestore/src/remote/persistent_stream.d.ts

@@ -35,6 +35,11 @@ export interface WriteRequest extends ProtoWriteRequest {
  * events by the concrete implementation classes.
  */
 export interface PersistentStreamListener {
+    /**
+     * Called after receiving an acknowledgement from the server, confirming that
+     * we are able to connect to it.
+     */
+    onConnected: () => Promise<void>;
     /**
      * Called after the stream was established and can accept outgoing
      * messages

package/dist/firestore/src/remote/stream_bridge.d.ts

@@ -22,6 +22,7 @@ import { Stream } from './connection';
  * interface. The stream callbacks are invoked with the callOn... methods.
  */
 export declare class StreamBridge<I, O> implements Stream<I, O> {
+    private wrappedOnConnected;
     private wrappedOnOpen;
     private wrappedOnClose;
     private wrappedOnMessage;
@@ -31,11 +32,13 @@ export declare class StreamBridge<I, O> implements Stream<I, O> {
         sendFn: (msg: I) => void;
         closeFn: () => void;
     });
+    onConnected(callback: () => void): void;
     onOpen(callback: () => void): void;
     onClose(callback: (err?: FirestoreError) => void): void;
     onMessage(callback: (msg: O) => void): void;
     close(): void;
     send(msg: I): void;
+    callOnConnected(): void;
     callOnOpen(): void;
     callOnClose(err?: FirestoreError): void;
     callOnMessage(msg: O): void;

package/dist/firestore/test/integration/remote/stream.test.d.ts

@@ -25,7 +25,7 @@ import { FirestoreError } from '../../../src/util/error';
  * StreamEventType combines the events that can be observed by the
  * WatchStreamListener and WriteStreamListener.
  */
-declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close';
+declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close' | 'connected';
 declare class StreamStatusListener implements WatchStreamListener, WriteStreamListener {
     private pendingCallbacks;
     private pendingPromises;
@@ -44,6 +44,7 @@ declare class StreamStatusListener implements WatchStreamListener, WriteStreamLi
     onHandshakeComplete(): Promise<void>;
     onMutationResult(commitVersion: SnapshotVersion, results: MutationResult[]): Promise<void>;
     onWatchChange(watchChange: DocumentWatchChange | WatchTargetChange | ExistenceFilterChange, snapshot: SnapshotVersion): Promise<void>;
+    onConnected(): Promise<void>;
     onOpen(): Promise<void>;
     onClose(err?: FirestoreError): Promise<void>;
     private resolvePending;