@firebase/database 0.13.3 → 0.13.4-canary.a5d9e1083

package/dist/node-esm/src/api/Reference_impl.d.ts

@@ -156,7 +156,9 @@ export declare class DataSnapshot {
      * @returns true if enumeration was canceled due to your callback returning
      * true.
      */
-    forEach(action: (child: DataSnapshot) => boolean | void): boolean;
+    forEach(action: (child: DataSnapshot & {
+        key: string;
+    }) => boolean | void): boolean;
     /**
      * Returns true if the specified child path has (non-null) data.
      *
@@ -842,12 +844,11 @@ export declare function onChildRemoved(query: Query, callback: (snapshot: DataSn
 export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
 export { EventType };
 /**
- * Detaches a callback previously attached with `on()`.
+ * Detaches a callback previously attached with the corresponding `on*()` (`onValue`, `onChildAdded`) listener.
+ * Note: This is not the recommended way to remove a listener. Instead, please use the returned callback function from
+ * the respective `on*` callbacks.
  *
- * Detach a callback previously attached with `on()`. Note that if `on()` was
- * called multiple times with the same eventType and callback, the callback
- * will be called multiple times for each event, and `off()` must be called
- * multiple times to remove the callback. Calling `off()` on a parent listener
+ * Detach a callback previously attached with `on*()`. Calling `off()` on a parent listener
  * will not automatically remove listeners registered on child nodes, `off()`
  * must also be called on any child listeners to remove the callback.
  *

package/dist/node-esm/src/core/Repo.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { ValueEventRegistration } from '../api/Reference_impl';
 import { AppCheckTokenProvider } from './AppCheckTokenProvider';
 import { AuthTokenProvider } from './AuthTokenProvider';
 import { PersistentConnection } from './PersistentConnection';
@@ -103,14 +104,14 @@ export declare function repoInterceptServerData(repo: Repo, callback: ((a: strin
  * belonging to active listeners. If they are found, such values
  * are considered to be the most up-to-date.
  *
- * If the client is not connected, this method will try to
- * establish a connection and request the value for `query`. If
- * the client is not able to retrieve the query result, it reports
- * an error.
+ * If the client is not connected, this method will wait until the
+ *  repo has established a connection and then request the value for `query`.
+ * If the client is not able to retrieve the query result for another reason,
+ * it reports an error.
  *
  * @param query - The query to surface a value for.
  */
-export declare function repoGetValue(repo: Repo, query: QueryContext): Promise<Node>;
+export declare function repoGetValue(repo: Repo, query: QueryContext, eventRegistration: ValueEventRegistration): Promise<Node>;
 export declare function repoSetWithPriority(repo: Repo, path: Path, newVal: unknown, newPriority: number | string | null, onComplete: ((status: Error | null, errorReason?: string) => void) | null): void;
 export declare function repoUpdate(repo: Repo, path: Path, childrenToMerge: {
     [k: string]: unknown;

package/dist/node-esm/src/core/SyncTree.d.ts

@@ -21,7 +21,7 @@ import { ImmutableTree } from './util/ImmutableTree';
 import { Path } from './util/Path';
 import { Event } from './view/Event';
 import { EventRegistration, QueryContext } from './view/EventRegistration';
-import { WriteTree, WriteTreeRef } from './WriteTree';
+import { WriteTree } from './WriteTree';
 export declare function syncTreeSetReferenceConstructor(val: ReferenceConstructor): void;
 export interface ListenProvider {
     startListening(query: QueryContext, tag: number | null, hashFn: () => string, onComplete: (a: string, b?: unknown) => Event[]): Event[];
@@ -121,23 +121,11 @@ export declare function syncTreeApplyTaggedListenComplete(syncTree: SyncTree, pa
  *
  * @param eventRegistration - If null, all callbacks are removed.
  * @param cancelError - If a cancelError is provided, appropriate cancel events will be returned.
+ * @param skipListenerDedup - When performing a `get()`, we don't add any new listeners, so no
+ *  deduping needs to take place. This flag allows toggling of that behavior
  * @returns Cancel events, if cancelError was provided.
  */
-export declare function syncTreeRemoveEventRegistration(syncTree: SyncTree, query: QueryContext, eventRegistration: EventRegistration | null, cancelError?: Error): Event[];
-/**
- * This function was added to support non-listener queries,
- * specifically for use in repoGetValue. It sets up all the same
- * local cache data-structures (SyncPoint + View) that are
- * needed for listeners without installing an event registration.
- * If `query` is not `loadsAllData`, it will also provision a tag for
- * the query so that query results can be merged into the sync
- * tree using existing logic for tagged listener queries.
- *
- * @param syncTree - Synctree to add the query to.
- * @param query - Query to register
- * @returns tag as a string if query is not a default query, null if query is not.
- */
-export declare function syncTreeRegisterQuery(syncTree: SyncTree, query: QueryContext): number;
+export declare function syncTreeRemoveEventRegistration(syncTree: SyncTree, query: QueryContext, eventRegistration: EventRegistration | null, cancelError?: Error, skipListenerDedup?: boolean): Event[];
 /**
  * Apply new server data for the specified tagged query.
  *
@@ -152,25 +140,12 @@ export declare function syncTreeApplyTaggedQueryOverwrite(syncTree: SyncTree, pa
 export declare function syncTreeApplyTaggedQueryMerge(syncTree: SyncTree, path: Path, changedChildren: {
     [k: string]: Node;
 }, tag: number): Event[];
-/**
- * Creates a new syncpoint for a query and creates a tag if the view doesn't exist.
- * Extracted from addEventRegistration to allow `repoGetValue` to properly set up the SyncTree
- * without actually listening on a query.
- */
-export declare function syncTreeRegisterSyncPoint(query: QueryContext, syncTree: SyncTree): {
-    syncPoint: SyncPoint;
-    writesCache: WriteTreeRef;
-    serverCache: Node;
-    serverCacheComplete: any;
-    foundAncestorDefaultView: boolean;
-    viewAlreadyExists: boolean;
-};
 /**
  * Add an event callback for the specified query.
  *
  * @returns Events to raise.
  */
-export declare function syncTreeAddEventRegistration(syncTree: SyncTree, query: QueryContext, eventRegistration: EventRegistration): Event[];
+export declare function syncTreeAddEventRegistration(syncTree: SyncTree, query: QueryContext, eventRegistration: EventRegistration, skipSetupListener?: boolean): Event[];
 /**
  * Returns a complete cache, if we have one, of the data at a particular path. If the location does not have a
  * listener above it, we will get a false "null". This shouldn't be a problem because transactions will always
@@ -184,3 +159,7 @@ export declare function syncTreeAddEventRegistration(syncTree: SyncTree, query:
  */
 export declare function syncTreeCalcCompleteEventCache(syncTree: SyncTree, path: Path, writeIdsToExclude?: number[]): Node;
 export declare function syncTreeGetServerValue(syncTree: SyncTree, query: QueryContext): Node | null;
+/**
+ * Return the tag associated with the given query.
+ */
+export declare function syncTreeTagForQuery(syncTree: SyncTree, query: QueryContext): number | null;

package/dist/node-esm/test/helpers/util.d.ts

@@ -14,15 +14,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Database } from '../../src';
+import { Database, DatabaseReference } from '../../src';
+import { Path } from '../../src/core/util/Path';
+import { EventAccumulator } from './EventAccumulator';
 export declare const TEST_PROJECT: any;
+export declare function getFreshRepo(path: Path): DatabaseReference;
 export declare const DATABASE_ADDRESS: any;
 export declare const DATABASE_URL: any;
 export declare function testRepoInfo(url: any): import("../../src/core/RepoInfo").RepoInfo;
 export declare function repoInfoForConnectionTest(): import("../../src/core/RepoInfo").RepoInfo;
 export declare function shuffle(arr: any, randFn?: () => number): void;
 export declare function waitFor(waitTimeInMS: number): Promise<unknown>;
-export declare function getUniqueRef(db: Database): {
-    ref: import("../../src").DatabaseReference;
-    path: string;
+export declare function getUniqueRef(db: Database): DatabaseReference;
+export declare function getRWRefs(db: Database): {
+    readerRef: DatabaseReference;
+    writerRef: DatabaseReference;
 };
+export declare function writeAndValidate(writerRef: DatabaseReference, readerRef: DatabaseReference, toWrite: unknown, ec: EventAccumulator): Promise<void>;
+export declare function waitUntil(cb: () => boolean, maxRetries?: number): Promise<unknown>;

package/dist/private.d.ts

@@ -337,7 +337,9 @@ export declare class DataSnapshot {
      * @returns true if enumeration was canceled due to your callback returning
      * true.
      */
-    forEach(action: (child: DataSnapshot) => boolean | void): boolean;
+    forEach(action: (child: DataSnapshot & {
+        key: string;
+    }) => boolean | void): boolean;
     /**
      * Returns true if the specified child path has (non-null) data.
      *
@@ -1151,12 +1153,11 @@ declare interface NodeFilter_2 {
 }
 
 /**
- * Detaches a callback previously attached with `on()`.
+ * Detaches a callback previously attached with the corresponding `on*()` (`onValue`, `onChildAdded`) listener.
+ * Note: This is not the recommended way to remove a listener. Instead, please use the returned callback function from
+ * the respective `on*` callbacks.
  *
- * Detach a callback previously attached with `on()`. Note that if `on()` was
- * called multiple times with the same eventType and callback, the callback
- * will be called multiple times for each event, and `off()` must be called
- * multiple times to remove the callback. Calling `off()` on a parent listener
+ * Detach a callback previously attached with `on*()`. Calling `off()` on a parent listener
  * will not automatically remove listeners registered on child nodes, `off()`
  * must also be called on any child listeners to remove the callback.
  *

package/dist/public.d.ts

@@ -159,7 +159,9 @@ export declare class DataSnapshot {
      * @returns true if enumeration was canceled due to your callback returning
      * true.
      */
-    forEach(action: (child: DataSnapshot) => boolean | void): boolean;
+    forEach(action: (child: DataSnapshot & {
+        key: string;
+    }) => boolean | void): boolean;
     /**
      * Returns true if the specified child path has (non-null) data.
      *
@@ -403,12 +405,11 @@ export declare interface ListenOptions {
     readonly onlyOnce?: boolean;
 }
 /**
- * Detaches a callback previously attached with `on()`.
+ * Detaches a callback previously attached with the corresponding `on*()` (`onValue`, `onChildAdded`) listener.
+ * Note: This is not the recommended way to remove a listener. Instead, please use the returned callback function from
+ * the respective `on*` callbacks.
  *
- * Detach a callback previously attached with `on()`. Note that if `on()` was
- * called multiple times with the same eventType and callback, the callback
- * will be called multiple times for each event, and `off()` must be called
- * multiple times to remove the callback. Calling `off()` on a parent listener
+ * Detach a callback previously attached with `on*()`. Calling `off()` on a parent listener
  * will not automatically remove listeners registered on child nodes, `off()`
  * must also be called on any child listeners to remove the callback.
  *

package/dist/src/api/Reference_impl.d.ts

@@ -156,7 +156,9 @@ export declare class DataSnapshot {
      * @returns true if enumeration was canceled due to your callback returning
      * true.
      */
-    forEach(action: (child: DataSnapshot) => boolean | void): boolean;
+    forEach(action: (child: DataSnapshot & {
+        key: string;
+    }) => boolean | void): boolean;
     /**
      * Returns true if the specified child path has (non-null) data.
      *
@@ -842,12 +844,11 @@ export declare function onChildRemoved(query: Query, callback: (snapshot: DataSn
 export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
 export { EventType };
 /**
- * Detaches a callback previously attached with `on()`.
+ * Detaches a callback previously attached with the corresponding `on*()` (`onValue`, `onChildAdded`) listener.
+ * Note: This is not the recommended way to remove a listener. Instead, please use the returned callback function from
+ * the respective `on*` callbacks.
  *
- * Detach a callback previously attached with `on()`. Note that if `on()` was
- * called multiple times with the same eventType and callback, the callback
- * will be called multiple times for each event, and `off()` must be called
- * multiple times to remove the callback. Calling `off()` on a parent listener
+ * Detach a callback previously attached with `on*()`. Calling `off()` on a parent listener
  * will not automatically remove listeners registered on child nodes, `off()`
  * must also be called on any child listeners to remove the callback.
  *

package/dist/src/core/Repo.d.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { ValueEventRegistration } from '../api/Reference_impl';
 import { AppCheckTokenProvider } from './AppCheckTokenProvider';
 import { AuthTokenProvider } from './AuthTokenProvider';
 import { PersistentConnection } from './PersistentConnection';
@@ -103,14 +104,14 @@ export declare function repoInterceptServerData(repo: Repo, callback: ((a: strin
  * belonging to active listeners. If they are found, such values
  * are considered to be the most up-to-date.
  *
- * If the client is not connected, this method will try to
- * establish a connection and request the value for `query`. If
- * the client is not able to retrieve the query result, it reports
- * an error.
+ * If the client is not connected, this method will wait until the
+ *  repo has established a connection and then request the value for `query`.
+ * If the client is not able to retrieve the query result for another reason,
+ * it reports an error.
  *
  * @param query - The query to surface a value for.
  */
-export declare function repoGetValue(repo: Repo, query: QueryContext): Promise<Node>;
+export declare function repoGetValue(repo: Repo, query: QueryContext, eventRegistration: ValueEventRegistration): Promise<Node>;
 export declare function repoSetWithPriority(repo: Repo, path: Path, newVal: unknown, newPriority: number | string | null, onComplete: ((status: Error | null, errorReason?: string) => void) | null): void;
 export declare function repoUpdate(repo: Repo, path: Path, childrenToMerge: {
     [k: string]: unknown;

package/dist/src/core/SyncTree.d.ts

@@ -21,7 +21,7 @@ import { ImmutableTree } from './util/ImmutableTree';
 import { Path } from './util/Path';
 import { Event } from './view/Event';
 import { EventRegistration, QueryContext } from './view/EventRegistration';
-import { WriteTree, WriteTreeRef } from './WriteTree';
+import { WriteTree } from './WriteTree';
 export declare function syncTreeSetReferenceConstructor(val: ReferenceConstructor): void;
 export interface ListenProvider {
     startListening(query: QueryContext, tag: number | null, hashFn: () => string, onComplete: (a: string, b?: unknown) => Event[]): Event[];
@@ -121,23 +121,11 @@ export declare function syncTreeApplyTaggedListenComplete(syncTree: SyncTree, pa
  *
  * @param eventRegistration - If null, all callbacks are removed.
  * @param cancelError - If a cancelError is provided, appropriate cancel events will be returned.
+ * @param skipListenerDedup - When performing a `get()`, we don't add any new listeners, so no
+ *  deduping needs to take place. This flag allows toggling of that behavior
  * @returns Cancel events, if cancelError was provided.
  */
-export declare function syncTreeRemoveEventRegistration(syncTree: SyncTree, query: QueryContext, eventRegistration: EventRegistration | null, cancelError?: Error): Event[];
-/**
- * This function was added to support non-listener queries,
- * specifically for use in repoGetValue. It sets up all the same
- * local cache data-structures (SyncPoint + View) that are
- * needed for listeners without installing an event registration.
- * If `query` is not `loadsAllData`, it will also provision a tag for
- * the query so that query results can be merged into the sync
- * tree using existing logic for tagged listener queries.
- *
- * @param syncTree - Synctree to add the query to.
- * @param query - Query to register
- * @returns tag as a string if query is not a default query, null if query is not.
- */
-export declare function syncTreeRegisterQuery(syncTree: SyncTree, query: QueryContext): number;
+export declare function syncTreeRemoveEventRegistration(syncTree: SyncTree, query: QueryContext, eventRegistration: EventRegistration | null, cancelError?: Error, skipListenerDedup?: boolean): Event[];
 /**
  * Apply new server data for the specified tagged query.
  *
@@ -152,25 +140,12 @@ export declare function syncTreeApplyTaggedQueryOverwrite(syncTree: SyncTree, pa
 export declare function syncTreeApplyTaggedQueryMerge(syncTree: SyncTree, path: Path, changedChildren: {
     [k: string]: Node;
 }, tag: number): Event[];
-/**
- * Creates a new syncpoint for a query and creates a tag if the view doesn't exist.
- * Extracted from addEventRegistration to allow `repoGetValue` to properly set up the SyncTree
- * without actually listening on a query.
- */
-export declare function syncTreeRegisterSyncPoint(query: QueryContext, syncTree: SyncTree): {
-    syncPoint: SyncPoint;
-    writesCache: WriteTreeRef;
-    serverCache: Node;
-    serverCacheComplete: any;
-    foundAncestorDefaultView: boolean;
-    viewAlreadyExists: boolean;
-};
 /**
  * Add an event callback for the specified query.
  *
  * @returns Events to raise.
  */
-export declare function syncTreeAddEventRegistration(syncTree: SyncTree, query: QueryContext, eventRegistration: EventRegistration): Event[];
+export declare function syncTreeAddEventRegistration(syncTree: SyncTree, query: QueryContext, eventRegistration: EventRegistration, skipSetupListener?: boolean): Event[];
 /**
  * Returns a complete cache, if we have one, of the data at a particular path. If the location does not have a
  * listener above it, we will get a false "null". This shouldn't be a problem because transactions will always
@@ -184,3 +159,7 @@ export declare function syncTreeAddEventRegistration(syncTree: SyncTree, query:
  */
 export declare function syncTreeCalcCompleteEventCache(syncTree: SyncTree, path: Path, writeIdsToExclude?: number[]): Node;
 export declare function syncTreeGetServerValue(syncTree: SyncTree, query: QueryContext): Node | null;
+/**
+ * Return the tag associated with the given query.
+ */
+export declare function syncTreeTagForQuery(syncTree: SyncTree, query: QueryContext): number | null;

package/dist/test/helpers/util.d.ts

@@ -14,15 +14,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Database } from '../../src';
+import { Database, DatabaseReference } from '../../src';
+import { Path } from '../../src/core/util/Path';
+import { EventAccumulator } from './EventAccumulator';
 export declare const TEST_PROJECT: any;
+export declare function getFreshRepo(path: Path): DatabaseReference;
 export declare const DATABASE_ADDRESS: any;
 export declare const DATABASE_URL: any;
 export declare function testRepoInfo(url: any): import("../../src/core/RepoInfo").RepoInfo;
 export declare function repoInfoForConnectionTest(): import("../../src/core/RepoInfo").RepoInfo;
 export declare function shuffle(arr: any, randFn?: () => number): void;
 export declare function waitFor(waitTimeInMS: number): Promise<unknown>;
-export declare function getUniqueRef(db: Database): {
-    ref: import("../../src").DatabaseReference;
-    path: string;
+export declare function getUniqueRef(db: Database): DatabaseReference;
+export declare function getRWRefs(db: Database): {
+    readerRef: DatabaseReference;
+    writerRef: DatabaseReference;
 };
+export declare function writeAndValidate(writerRef: DatabaseReference, readerRef: DatabaseReference, toWrite: unknown, ec: EventAccumulator): Promise<void>;
+export declare function waitUntil(cb: () => boolean, maxRetries?: number): Promise<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/database",
-  "version": "0.13.3",
+  "version": "0.13.4-canary.a5d9e1083",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -45,15 +45,15 @@
   "license": "Apache-2.0",
   "peerDependencies": {},
   "dependencies": {
-    "@firebase/logger": "0.3.3",
-    "@firebase/util": "1.6.3",
-    "@firebase/component": "0.5.17",
-    "@firebase/auth-interop-types": "0.1.6",
+    "@firebase/logger": "0.3.3-canary.a5d9e1083",
+    "@firebase/util": "1.6.3-canary.a5d9e1083",
+    "@firebase/component": "0.5.17-canary.a5d9e1083",
+    "@firebase/auth-interop-types": "0.1.6-canary.a5d9e1083",
     "faye-websocket": "0.11.4",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.7.28",
+    "@firebase/app": "0.7.30-canary.a5d9e1083",
     "rollup": "2.72.1",
     "rollup-plugin-typescript2": "0.31.2",
     "typescript": "4.2.2"