@firebase/firestore - npm Package Compare versions

Comparing version 4.6.0-20240410213044 to 4.6.0-canary.224419457

dist/firestore/src/local/simple_db.d.ts

@@ -77,4 +77,2 @@ /**
     static getIOSVersion(ua: string): number;
-    /** Parse User Agent to determine Android version. Returns -1 if not found. */
-    static getAndroidVersion(ua: string): number;
     constructor(name: string, version: number, schemaConverter: SimpleDbSchemaConverter);
@@ -89,2 +87,4 @@ /**
 }
+/** Parse User Agent to determine Android version. Returns -1 if not found. */
+export declare function getAndroidVersion(ua: string): number;
 /**
@@ -91,0 +91,0 @@ * A controller for iterating over a key range or index. It allows an iterate

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

@@ -86,6 +86,10 @@ /**
  * 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;
@@ -92,0 +96,0 @@ onClose(callback: (err?: FirestoreError) => void): void;

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

@@ -39,2 +39,7 @@ /**
     /**
+     * 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
@@ -41,0 +46,0 @@ * messages

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

@@ -25,2 +25,3 @@ /**
 export declare class StreamBridge<I, O> implements Stream<I, O> {
+    private wrappedOnConnected;
     private wrappedOnOpen;
@@ -35,2 +36,3 @@ private wrappedOnClose;
     });
+    onConnected(callback: () => void): void;
     onOpen(callback: () => void): void;
@@ -41,2 +43,3 @@ onClose(callback: (err?: FirestoreError) => void): void;
     send(msg: I): void;
+    callOnConnected(): void;
     callOnOpen(): void;
@@ -43,0 +46,0 @@ callOnClose(err?: FirestoreError): void;

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

@@ -28,3 +28,3 @@ /**
  */
-declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close';
+declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close' | 'connected';
 declare class StreamStatusListener implements WatchStreamListener, WriteStreamListener {
@@ -48,2 +48,3 @@ private pendingCallbacks;
     onWatchChange(watchChange: DocumentWatchChange | WatchTargetChange | ExistenceFilterChange, snapshot: SnapshotVersion): Promise<void>;
+    onConnected(): Promise<void>;
     onOpen(): Promise<void>;
@@ -50,0 +51,0 @@ onClose(err?: FirestoreError): Promise<void>;

dist/lite/firestore/src/local/simple_db.d.ts

@@ -77,4 +77,2 @@ /**
     static getIOSVersion(ua: string): number;
-    /** Parse User Agent to determine Android version. Returns -1 if not found. */
-    static getAndroidVersion(ua: string): number;
     constructor(name: string, version: number, schemaConverter: SimpleDbSchemaConverter);
@@ -89,2 +87,4 @@ /**
 }
+/** Parse User Agent to determine Android version. Returns -1 if not found. */
+export declare function getAndroidVersion(ua: string): number;
 /**
@@ -91,0 +91,0 @@ * A controller for iterating over a key range or index. It allows an iterate

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

@@ -86,6 +86,10 @@ /**
  * 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;
@@ -92,0 +96,0 @@ onClose(callback: (err?: FirestoreError) => void): void;

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

@@ -39,2 +39,7 @@ /**
     /**
+     * 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
@@ -41,0 +46,0 @@ * messages

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

@@ -25,2 +25,3 @@ /**
 export declare class StreamBridge<I, O> implements Stream<I, O> {
+    private wrappedOnConnected;
     private wrappedOnOpen;
@@ -35,2 +36,3 @@ private wrappedOnClose;
     });
+    onConnected(callback: () => void): void;
     onOpen(callback: () => void): void;
@@ -41,2 +43,3 @@ onClose(callback: (err?: FirestoreError) => void): void;
     send(msg: I): void;
+    callOnConnected(): void;
     callOnOpen(): void;
@@ -43,0 +46,0 @@ callOnClose(err?: FirestoreError): void;

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

@@ -28,3 +28,3 @@ /**
  */
-declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close';
+declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close' | 'connected';
 declare class StreamStatusListener implements WatchStreamListener, WriteStreamListener {
@@ -48,2 +48,3 @@ private pendingCallbacks;
     onWatchChange(watchChange: DocumentWatchChange | WatchTargetChange | ExistenceFilterChange, snapshot: SnapshotVersion): Promise<void>;
+    onConnected(): Promise<void>;
     onOpen(): Promise<void>;
@@ -50,0 +51,0 @@ onClose(err?: FirestoreError): Promise<void>;

dist/lite/packages/firestore/src/local/simple_db.d.ts

@@ -77,4 +77,2 @@ /**
     static getIOSVersion(ua: string): number;
-    /** Parse User Agent to determine Android version. Returns -1 if not found. */
-    static getAndroidVersion(ua: string): number;
     constructor(name: string, version: number, schemaConverter: SimpleDbSchemaConverter);
@@ -89,2 +87,4 @@ /**
 }
+/** Parse User Agent to determine Android version. Returns -1 if not found. */
+export declare function getAndroidVersion(ua: string): number;
 /**
@@ -91,0 +91,0 @@ * A controller for iterating over a key range or index. It allows an iterate

dist/lite/packages/firestore/src/remote/connection.d.ts

@@ -86,6 +86,10 @@ /**
  * 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;
@@ -92,0 +96,0 @@ onClose(callback: (err?: FirestoreError) => void): void;

dist/lite/packages/firestore/src/remote/persistent_stream.d.ts

@@ -39,2 +39,7 @@ /**
     /**
+     * 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
@@ -41,0 +46,0 @@ * messages

dist/lite/packages/firestore/src/remote/stream_bridge.d.ts

@@ -25,2 +25,3 @@ /**
 export declare class StreamBridge<I, O> implements Stream<I, O> {
+    private wrappedOnConnected;
     private wrappedOnOpen;
@@ -35,2 +36,3 @@ private wrappedOnClose;
     });
+    onConnected(callback: () => void): void;
     onOpen(callback: () => void): void;
@@ -41,2 +43,3 @@ onClose(callback: (err?: FirestoreError) => void): void;
     send(msg: I): void;
+    callOnConnected(): void;
     callOnOpen(): void;
@@ -43,0 +46,0 @@ callOnClose(err?: FirestoreError): void;

dist/lite/packages/firestore/test/integration/remote/stream.test.d.ts

@@ -28,3 +28,3 @@ /**
  */
-declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close';
+declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close' | 'connected';
 declare class StreamStatusListener implements WatchStreamListener, WriteStreamListener {
@@ -48,2 +48,3 @@ private pendingCallbacks;
     onWatchChange(watchChange: DocumentWatchChange | WatchTargetChange | ExistenceFilterChange, snapshot: SnapshotVersion): Promise<void>;
+    onConnected(): Promise<void>;
     onOpen(): Promise<void>;
@@ -50,0 +51,0 @@ onClose(err?: FirestoreError): Promise<void>;

dist/packages/firestore/src/local/simple_db.d.ts

@@ -77,4 +77,2 @@ /**
     static getIOSVersion(ua: string): number;
-    /** Parse User Agent to determine Android version. Returns -1 if not found. */
-    static getAndroidVersion(ua: string): number;
     constructor(name: string, version: number, schemaConverter: SimpleDbSchemaConverter);
@@ -89,2 +87,4 @@ /**
 }
+/** Parse User Agent to determine Android version. Returns -1 if not found. */
+export declare function getAndroidVersion(ua: string): number;
 /**
@@ -91,0 +91,0 @@ * A controller for iterating over a key range or index. It allows an iterate

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

@@ -86,6 +86,10 @@ /**
  * 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;
@@ -92,0 +96,0 @@ onClose(callback: (err?: FirestoreError) => void): void;

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

@@ -39,2 +39,7 @@ /**
     /**
+     * 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
@@ -41,0 +46,0 @@ * messages

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

@@ -25,2 +25,3 @@ /**
 export declare class StreamBridge<I, O> implements Stream<I, O> {
+    private wrappedOnConnected;
     private wrappedOnOpen;
@@ -35,2 +36,3 @@ private wrappedOnClose;
     });
+    onConnected(callback: () => void): void;
     onOpen(callback: () => void): void;
@@ -41,2 +43,3 @@ onClose(callback: (err?: FirestoreError) => void): void;
     send(msg: I): void;
+    callOnConnected(): void;
     callOnOpen(): void;
@@ -43,0 +46,0 @@ callOnClose(err?: FirestoreError): void;

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

@@ -28,3 +28,3 @@ /**
  */
-declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close';
+declare type StreamEventType = 'handshakeComplete' | 'mutationResult' | 'watchChange' | 'open' | 'close' | 'connected';
 declare class StreamStatusListener implements WatchStreamListener, WriteStreamListener {
@@ -48,2 +48,3 @@ private pendingCallbacks;
     onWatchChange(watchChange: DocumentWatchChange | WatchTargetChange | ExistenceFilterChange, snapshot: SnapshotVersion): Promise<void>;
+    onConnected(): Promise<void>;
     onOpen(): Promise<void>;
@@ -50,0 +51,0 @@ onClose(err?: FirestoreError): Promise<void>;

package.json

 {
   "name": "@firebase/firestore",
-  "version": "4.6.0-20240410213044",
+  "version": "4.6.0-canary.224419457",
   "engines": {
@@ -99,6 +99,6 @@ "node": ">=10.10.0"
   "dependencies": {
-    "@firebase/component": "0.6.6",
-    "@firebase/logger": "0.4.1",
-    "@firebase/util": "1.9.5",
-    "@firebase/webchannel-wrapper": "0.10.6",
+    "@firebase/component": "0.6.6-canary.224419457",
+    "@firebase/logger": "0.4.1-canary.224419457",
+    "@firebase/util": "1.9.5-canary.224419457",
+    "@firebase/webchannel-wrapper": "0.10.6-canary.224419457",
     "@grpc/grpc-js": "~1.9.0",
@@ -110,8 +110,8 @@ "@grpc/proto-loader": "^0.7.8",
   "peerDependencies": {
-    "@firebase/app": "0.10.1-20240410213044"
+    "@firebase/app": "0.10.1-canary.224419457"
   },
   "devDependencies": {
-    "@firebase/app": "0.10.1-20240410213044",
-    "@firebase/app-compat": "0.2.31-20240410213044",
-    "@firebase/auth": "1.7.1-20240410213044",
+    "@firebase/app": "0.10.1-canary.224419457",
+    "@firebase/app-compat": "0.2.31-canary.224419457",
+    "@firebase/auth": "1.7.1-canary.224419457",
     "@rollup/plugin-alias": "5.1.0",
@@ -118,0 +118,0 @@ "@rollup/plugin-json": "4.1.0",

No alert changes

Improved metrics

Total package byte prevSize

33424060

increased by0.05%

Lines of code

333666

increased by0.04%

Dependency changes

• + Added@firebase/app@0.10.1-canary.224419457(transitive)

• + Added@firebase/component@0.6.6-canary.224419457(transitive)

• + Added@firebase/logger@0.4.1-canary.224419457(transitive)

• + Added@firebase/util@1.9.5-canary.224419457(transitive)

• + Added@firebase/webchannel-wrapper@0.10.6-canary.224419457(transitive)

• - Removed@firebase/app@0.10.1-20240410213044(transitive)

• - Removed@firebase/component@0.6.6(transitive)

• - Removed@firebase/logger@0.4.1(transitive)

• - Removed@firebase/util@1.9.5(transitive)

• - Removed@firebase/webchannel-wrapper@0.10.6(transitive)

• Updated@firebase/component@0.6.6-canary.224419457

• Updated@firebase/logger@0.4.1-canary.224419457

• Updated@firebase/util@1.9.5-canary.224419457

• Updated@firebase/webchannel-wrapper@0.10.6-canary.224419457