@firebase/database 0.8.3-canary.fb90580e5 → 0.8.3

package/dist/exp/src/core/RepoManager.d.ts

@@ -1,78 +0,0 @@
-/**
- * @license
- * Copyright 2017 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.
- */
-import { FirebaseApp } from '@firebase/app-types';
-import { FirebaseApp as FirebaseAppExp } from "@firebase/app-types";
-import { Repo } from './Repo';
-import './Repo_transaction';
-import { Database } from '../api/Database';
-import { RepoInfo } from './RepoInfo';
-import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
-import { Provider } from '@firebase/component';
-import { AuthTokenProvider } from './AuthTokenProvider';
-/**
- * Intersection type that allows the SDK to be used from firebase-exp and
- * firebase v8.
- */
-export declare type FirebaseAppLike = FirebaseApp | FirebaseAppExp;
-/**
- * Creates and caches Repo instances.
- */
-export declare class RepoManager {
-    /**
-     * @private {!Object.<string, Object<string, !fb.core.Repo>>}
-     */
-    private repos_;
-    /**
-     * If true, new Repos will be created to use ReadonlyRestClient (for testing purposes).
-     * @private {boolean}
-     */
-    private useRestClient_;
-    static getInstance(): RepoManager;
-    interrupt(): void;
-    resume(): void;
-    /**
-     * Update an existing repo in place to point to a new host/port.
-     */
-    applyEmulatorSettings(repo: Repo, host: string, port: number): void;
-    /**
-     * This function should only ever be called to CREATE a new database instance.
-     *
-     * @param {!FirebaseApp} app
-     * @return {!Database}
-     */
-    databaseFromApp(app: FirebaseAppLike, authProvider: Provider<FirebaseAuthInternalName>, url?: string, nodeAdmin?: boolean): Database;
-    /**
-     * Remove the repo and make sure it is disconnected.
-     *
-     * @param {!Repo} repo
-     */
-    deleteRepo(repo: Repo): void;
-    /**
-     * Ensures a repo doesn't already exist and then creates one using the
-     * provided app.
-     *
-     * @param {!RepoInfo} repoInfo The metadata about the Repo
-     * @param {!FirebaseApp} app
-     * @return {!Repo} The Repo object for the specified server / repoName.
-     */
-    createRepo(repoInfo: RepoInfo, app: FirebaseAppLike, authTokenProvider: AuthTokenProvider): Repo;
-    /**
-     * Forces us to use ReadonlyRestClient instead of PersistentConnection for new Repos.
-     * @param {boolean} forceRestClient
-     */
-    forceRestClient(forceRestClient: boolean): void;
-}

package/dist/exp/src/core/Repo_transaction.d.ts

@@ -1,33 +0,0 @@
-/**
- * @license
- * Copyright 2017 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.
- */
-import { DataSnapshot } from '../api/DataSnapshot';
-import { Path } from './util/Path';
-/**
- * @enum {number}
- */
-export declare enum TransactionStatus {
-    RUN = 0,
-    SENT = 1,
-    COMPLETED = 2,
-    SENT_NEEDS_ABORT = 3,
-    NEEDS_ABORT = 4
-}
-declare module './Repo' {
-    interface Repo {
-        startTransaction(path: Path, transactionUpdate: (a: unknown) => void, onComplete: ((a: Error, b: boolean, c: DataSnapshot) => void) | null, applyLocally: boolean): void;
-    }
-}

package/dist/exp/src/core/ServerActions.d.ts

@@ -1,85 +0,0 @@
-/**
- * @license
- * Copyright 2017 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.
- */
-import { Query } from '../api/Query';
-/**
- * Interface defining the set of actions that can be performed against the Firebase server
- * (basically corresponds to our wire protocol).
- *
- * @interface
- */
-export declare abstract class ServerActions {
-    /**
-     * @param {!Query} query
-     * @param {function():string} currentHashFn
-     * @param {?number} tag
-     * @param {function(string, *)} onComplete
-     */
-    abstract listen(query: Query, currentHashFn: () => string, tag: number | null, onComplete: (a: string, b: unknown) => void): void;
-    /**
-     * Remove a listen.
-     *
-     * @param {!Query} query
-     * @param {?number} tag
-     */
-    abstract unlisten(query: Query, tag: number | null): void;
-    /**
-     * Get the server value satisfying this query.
-     */
-    abstract get(query: Query): Promise<string>;
-    /**
-     * @param {string} pathString
-     * @param {*} data
-     * @param {function(string, string)=} onComplete
-     * @param {string=} hash
-     */
-    put(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void, hash?: string): void;
-    /**
-     * @param {string} pathString
-     * @param {*} data
-     * @param {function(string, ?string)} onComplete
-     * @param {string=} hash
-     */
-    merge(pathString: string, data: unknown, onComplete: (a: string, b: string | null) => void, hash?: string): void;
-    /**
-     * Refreshes the auth token for the current connection.
-     * @param {string} token The authentication token
-     */
-    refreshAuthToken(token: string): void;
-    /**
-     * @param {string} pathString
-     * @param {*} data
-     * @param {function(string, string)=} onComplete
-     */
-    onDisconnectPut(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void): void;
-    /**
-     * @param {string} pathString
-     * @param {*} data
-     * @param {function(string, string)=} onComplete
-     */
-    onDisconnectMerge(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void): void;
-    /**
-     * @param {string} pathString
-     * @param {function(string, string)=} onComplete
-     */
-    onDisconnectCancel(pathString: string, onComplete?: (a: string, b: string) => void): void;
-    /**
-     * @param {Object.<string, *>} stats
-     */
-    reportStats(stats: {
-        [k: string]: unknown;
-    }): void;
-}

package/dist/exp/src/core/SnapshotHolder.d.ts

@@ -1,28 +0,0 @@
-/**
- * @license
- * Copyright 2017 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.
- */
-import { Path } from './util/Path';
-import { Node } from './snap/Node';
-/**
- * Mutable object which basically just stores a reference to the "latest" immutable snapshot.
- *
- * @constructor
- */
-export declare class SnapshotHolder {
-    private rootNode_;
-    getNode(path: Path): Node;
-    updateSnapshot(path: Path, newSnapshotNode: Node): void;
-}

package/dist/exp/src/core/SparseSnapshotTree.d.ts

@@ -1,61 +0,0 @@
-/**
- * @license
- * Copyright 2017 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.
- */
-import { Path } from './util/Path';
-import { Node } from './snap/Node';
-/**
- * Helper class to store a sparse set of snapshots.
- */
-export declare class SparseSnapshotTree {
-    private value;
-    private readonly children;
-    /**
-     * Gets the node stored at the given path if one exists.
-     *
-     * @param path Path to look up snapshot for.
-     * @return The retrieved node, or null.
-     */
-    find(path: Path): Node | null;
-    /**
-     * Stores the given node at the specified path. If there is already a node
-     * at a shallower path, it merges the new data into that snapshot node.
-     *
-     * @param path Path to look up snapshot for.
-     * @param data The new data, or null.
-     */
-    remember(path: Path, data: Node): void;
-    /**
-     * Purge the data at path from the cache.
-     *
-     * @param path Path to look up snapshot for.
-     * @return True if this node should now be removed.
-     */
-    forget(path: Path): boolean;
-    /**
-     * Recursively iterates through all of the stored tree and calls the
-     * callback on each one.
-     *
-     * @param prefixPath Path to look up node for.
-     * @param func The function to invoke for each tree.
-     */
-    forEachTree(prefixPath: Path, func: (a: Path, b: Node) => unknown): void;
-    /**
-     * Iterates through each immediate child and triggers the callback.
-     *
-     * @param func The function to invoke for each child.
-     */
-    forEachChild(func: (a: string, b: SparseSnapshotTree) => void): void;
-}

package/dist/exp/src/core/SyncPoint.d.ts

@@ -1,84 +0,0 @@
-/**
- * @license
- * Copyright 2017 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.
- */
-import { View } from './view/View';
-import { Operation } from './operation/Operation';
-import { WriteTreeRef } from './WriteTree';
-import { Query } from '../api/Query';
-import { EventRegistration } from './view/EventRegistration';
-import { Node } from './snap/Node';
-import { Path } from './util/Path';
-import { Event } from './view/Event';
-import { ReferenceConstructor } from '../api/Reference';
-/**
- * SyncPoint represents a single location in a SyncTree with 1 or more event registrations, meaning we need to
- * maintain 1 or more Views at this location to cache server data and raise appropriate events for server changes
- * and user writes (set, transaction, update).
- *
- * It's responsible for:
- *  - Maintaining the set of 1 or more views necessary at this location (a SyncPoint with 0 views should be removed).
- *  - Proxying user / server operations to the views as appropriate (i.e. applyServerOverwrite,
- *    applyUserOverwrite, etc.)
- */
-export declare class SyncPoint {
-    static set __referenceConstructor(val: ReferenceConstructor);
-    static get __referenceConstructor(): ReferenceConstructor;
-    /**
-     * The Views being tracked at this location in the tree, stored as a map where the key is a
-     * queryId and the value is the View for that query.
-     *
-     * NOTE: This list will be quite small (usually 1, but perhaps 2 or 3; any more is an odd use case).
-     */
-    private readonly views;
-    isEmpty(): boolean;
-    applyOperation(operation: Operation, writesCache: WriteTreeRef, optCompleteServerCache: Node | null): Event[];
-    /**
-     * Add an event callback for the specified query.
-     *
-     * @param {!Query} query
-     * @param {!EventRegistration} eventRegistration
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} serverCache Complete server cache, if we have it.
-     * @param {boolean} serverCacheComplete
-     * @return {!Array.<!Event>} Events to raise.
-     */
-    addEventRegistration(query: Query, eventRegistration: EventRegistration, writesCache: WriteTreeRef, serverCache: Node | null, serverCacheComplete: boolean): Event[];
-    /**
-     * Remove event callback(s).  Return cancelEvents if a cancelError is specified.
-     *
-     * If query is the default query, we'll check all views for the specified eventRegistration.
-     * If eventRegistration is null, we'll remove all callbacks for the specified view(s).
-     *
-     * @param {!Query} query
-     * @param {?EventRegistration} eventRegistration If null, remove all callbacks.
-     * @param {Error=} cancelError If a cancelError is provided, appropriate cancel events will be returned.
-     * @return {{removed:!Array.<!Query>, events:!Array.<!Event>}} removed queries and any cancel events
-     */
-    removeEventRegistration(query: Query, eventRegistration: EventRegistration | null, cancelError?: Error): {
-        removed: Query[];
-        events: Event[];
-    };
-    getQueryViews(): View[];
-    /**
-     * @param path The path to the desired complete snapshot
-     * @return A complete cache, if it exists
-     */
-    getCompleteServerCache(path: Path): Node | null;
-    viewForQuery(query: Query): View | null;
-    viewExistsForQuery(query: Query): boolean;
-    hasCompleteView(): boolean;
-    getCompleteView(): View | null;
-}

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

@@ -1,236 +0,0 @@
-/**
- * @license
- * Copyright 2017 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.
- */
-import { Path } from './util/Path';
-import { Query } from '../api/Query';
-import { Node } from './snap/Node';
-import { Event } from './view/Event';
-import { EventRegistration } from './view/EventRegistration';
-/**
- * @typedef {{
- *   startListening: function(
- *     !Query,
- *     ?number,
- *     function():string,
- *     function(!string, *):!Array.<!Event>
- *   ):!Array.<!Event>,
- *
- *   stopListening: function(!Query, ?number)
- * }}
- */
-export interface ListenProvider {
-    startListening(query: Query, tag: number | null, hashFn: () => string, onComplete: (a: string, b?: unknown) => Event[]): Event[];
-    stopListening(a: Query, b: number | null): void;
-}
-/**
- * SyncTree is the central class for managing event callback registration, data caching, views
- * (query processing), and event generation.  There are typically two SyncTree instances for
- * each Repo, one for the normal Firebase data, and one for the .info data.
- *
- * It has a number of responsibilities, including:
- *  - Tracking all user event callbacks (registered via addEventRegistration() and removeEventRegistration()).
- *  - Applying and caching data changes for user set(), transaction(), and update() calls
- *    (applyUserOverwrite(), applyUserMerge()).
- *  - Applying and caching data changes for server data changes (applyServerOverwrite(),
- *    applyServerMerge()).
- *  - Generating user-facing events for server and user changes (all of the apply* methods
- *    return the set of events that need to be raised as a result).
- *  - Maintaining the appropriate set of server listens to ensure we are always subscribed
- *    to the correct set of paths and queries to satisfy the current set of user event
- *    callbacks (listens are started/stopped using the provided listenProvider).
- *
- * NOTE: Although SyncTree tracks event callbacks and calculates events to raise, the actual
- * events are returned to the caller rather than raised synchronously.
- *
- * @constructor
- */
-export declare class SyncTree {
-    private listenProvider_;
-    /**
-     * Tree of SyncPoints.  There's a SyncPoint at any location that has 1 or more views.
-     */
-    private syncPointTree_;
-    /**
-     * A tree of all pending user writes (user-initiated set()'s, transaction()'s, update()'s, etc.).
-     */
-    private pendingWriteTree_;
-    private readonly tagToQueryMap;
-    private readonly queryToTagMap;
-    /**
-     * @param {!ListenProvider} listenProvider_ Used by SyncTree to start / stop listening
-     *   to server data.
-     */
-    constructor(listenProvider_: ListenProvider);
-    /**
-     * Apply the data changes for a user-generated set() or transaction() call.
-     *
-     * @return Events to raise.
-     */
-    applyUserOverwrite(path: Path, newData: Node, writeId: number, visible?: boolean): Event[];
-    /**
-     * Apply the data from a user-generated update() call
-     *
-     * @return Events to raise.
-     */
-    applyUserMerge(path: Path, changedChildren: {
-        [k: string]: Node;
-    }, writeId: number): Event[];
-    /**
-     * Acknowledge a pending user write that was previously registered with applyUserOverwrite() or applyUserMerge().
-     *
-     * @param revert True if the given write failed and needs to be reverted
-     * @return Events to raise.
-     */
-    ackUserWrite(writeId: number, revert?: boolean): Event[];
-    /**
-     * Apply new server data for the specified path..
-     *
-     * @return Events to raise.
-     */
-    applyServerOverwrite(path: Path, newData: Node): Event[];
-    /**
-     * Apply new server data to be merged in at the specified path.
-     *
-     * @return Events to raise.
-     */
-    applyServerMerge(path: Path, changedChildren: {
-        [k: string]: Node;
-    }): Event[];
-    /**
-     * Apply a listen complete for a query
-     *
-     * @return Events to raise.
-     */
-    applyListenComplete(path: Path): Event[];
-    /**
-     * Apply new server data for the specified tagged query.
-     *
-     * @return Events to raise.
-     */
-    applyTaggedQueryOverwrite(path: Path, snap: Node, tag: number): Event[];
-    /**
-     * Apply server data to be merged in for the specified tagged query.
-     *
-     * @return Events to raise.
-     */
-    applyTaggedQueryMerge(path: Path, changedChildren: {
-        [k: string]: Node;
-    }, tag: number): Event[];
-    /**
-     * Apply a listen complete for a tagged query
-     *
-     * @return Events to raise.
-     */
-    applyTaggedListenComplete(path: Path, tag: number): Event[];
-    /**
-     * Add an event callback for the specified query.
-     *
-     * @return Events to raise.
-     */
-    addEventRegistration(query: Query, eventRegistration: EventRegistration): Event[];
-    /**
-     * Remove event callback(s).
-     *
-     * If query is the default query, we'll check all queries for the specified eventRegistration.
-     * If eventRegistration is null, we'll remove all callbacks for the specified query/queries.
-     *
-     * @param eventRegistration If null, all callbacks are removed.
-     * @param cancelError If a cancelError is provided, appropriate cancel events will be returned.
-     * @return Cancel events, if cancelError was provided.
-     */
-    removeEventRegistration(query: Query, eventRegistration: EventRegistration | null, cancelError?: Error): 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
-     * have a listener above, and atomic operations would correctly show a jitter of <increment value> ->
-     *     <incremented total> as the write is applied locally and then acknowledged at the server.
-     *
-     * Note: this method will *include* hidden writes from transaction with applyLocally set to false.
-     *
-     * @param path The path to the data we want
-     * @param writeIdsToExclude A specific set to be excluded
-     */
-    calcCompleteEventCache(path: Path, writeIdsToExclude?: number[]): Node;
-    /**
-     * This collapses multiple unfiltered views into a single view, since we only need a single
-     * listener for them.
-     */
-    private collectDistinctViewsForSubTree_;
-    private removeTags_;
-    /**
-     * Normalizes a query to a query we send the server for listening
-     *
-     * @return The normalized query
-     */
-    private static queryForListening_;
-    /**
-     * For a given new listen, manage the de-duplication of outstanding subscriptions.
-     *
-     * @return This method can return events to support synchronous data sources
-     */
-    private setupListener_;
-    private createListenerForView_;
-    /**
-     * Given a query, computes a "queryKey" suitable for use in our queryToTagMap_.
-     */
-    private static makeQueryKey_;
-    /**
-     * Given a queryKey (created by makeQueryKey), parse it back into a path and queryId.
-     */
-    private static parseQueryKey_;
-    /**
-     * Return the query associated with the given tag, if we have one
-     */
-    private queryKeyForTag_;
-    /**
-     * Return the tag associated with the given query.
-     */
-    private tagForQuery_;
-    /**
-     * Static tracker for next query tag.
-     */
-    private static nextQueryTag_;
-    /**
-     * Static accessor for query tags.
-     */
-    private static getNextQueryTag_;
-    /**
-     * A helper method to apply tagged operations
-     */
-    private applyTaggedOperation_;
-    /**
-     * A helper method that visits all descendant and ancestor SyncPoints, applying the operation.
-     *
-     * NOTES:
-     * - Descendant SyncPoints will be visited first (since we raise events depth-first).
-     *
-     * - We call applyOperation() on each SyncPoint passing three things:
-     *   1. A version of the Operation that has been made relative to the SyncPoint location.
-     *   2. A WriteTreeRef of any writes we have cached at the SyncPoint location.
-     *   3. A snapshot Node with cached server data, if we have it.
-     *
-     * - We concatenate all of the events returned by each SyncPoint and return the result.
-     */
-    private applyOperationToSyncPoints_;
-    /**
-     * Recursive helper for applyOperationToSyncPoints_
-     */
-    private applyOperationHelper_;
-    /**
-     * Recursive helper for applyOperationToSyncPoints_
-     */
-    private applyOperationDescendantsHelper_;
-}