@firebase/database 1.0.9 → 1.0.10

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

@@ -1,81 +1,81 @@
-/**
- * @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 { NamedNode, Node } from './snap/Node';
-import { ImmutableTree } from './util/ImmutableTree';
-import { Path } from './util/Path';
-/**
- * This class holds a collection of writes that can be applied to nodes in unison. It abstracts away the logic with
- * dealing with priority writes and multiple nested writes. At any given path there is only allowed to be one write
- * modifying that path. Any write to an existing path or shadowing an existing path will modify that existing write
- * to reflect the write added.
- */
-export declare class CompoundWrite {
-    writeTree_: ImmutableTree<Node>;
-    constructor(writeTree_: ImmutableTree<Node>);
-    static empty(): CompoundWrite;
-}
-export declare function compoundWriteAddWrite(compoundWrite: CompoundWrite, path: Path, node: Node): CompoundWrite;
-export declare function compoundWriteAddWrites(compoundWrite: CompoundWrite, path: Path, updates: {
-    [name: string]: Node;
-}): CompoundWrite;
-/**
- * Will remove a write at the given path and deeper paths. This will <em>not</em> modify a write at a higher
- * location, which must be removed by calling this method with that path.
- *
- * @param compoundWrite - The CompoundWrite to remove.
- * @param path - The path at which a write and all deeper writes should be removed
- * @returns The new CompoundWrite with the removed path
- */
-export declare function compoundWriteRemoveWrite(compoundWrite: CompoundWrite, path: Path): CompoundWrite;
-/**
- * Returns whether this CompoundWrite will fully overwrite a node at a given location and can therefore be
- * considered "complete".
- *
- * @param compoundWrite - The CompoundWrite to check.
- * @param path - The path to check for
- * @returns Whether there is a complete write at that path
- */
-export declare function compoundWriteHasCompleteWrite(compoundWrite: CompoundWrite, path: Path): boolean;
-/**
- * Returns a node for a path if and only if the node is a "complete" overwrite at that path. This will not aggregate
- * writes from deeper paths, but will return child nodes from a more shallow path.
- *
- * @param compoundWrite - The CompoundWrite to get the node from.
- * @param path - The path to get a complete write
- * @returns The node if complete at that path, or null otherwise.
- */
-export declare function compoundWriteGetCompleteNode(compoundWrite: CompoundWrite, path: Path): Node | null;
-/**
- * Returns all children that are guaranteed to be a complete overwrite.
- *
- * @param compoundWrite - The CompoundWrite to get children from.
- * @returns A list of all complete children.
- */
-export declare function compoundWriteGetCompleteChildren(compoundWrite: CompoundWrite): NamedNode[];
-export declare function compoundWriteChildCompoundWrite(compoundWrite: CompoundWrite, path: Path): CompoundWrite;
-/**
- * Returns true if this CompoundWrite is empty and therefore does not modify any nodes.
- * @returns Whether this CompoundWrite is empty
- */
-export declare function compoundWriteIsEmpty(compoundWrite: CompoundWrite): boolean;
-/**
- * Applies this CompoundWrite to a node. The node is returned with all writes from this CompoundWrite applied to the
- * node
- * @param node - The node to apply this CompoundWrite to
- * @returns The node with all writes applied
- */
-export declare function compoundWriteApply(compoundWrite: CompoundWrite, node: Node): Node;
+/**
+ * @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 { NamedNode, Node } from './snap/Node';
+import { ImmutableTree } from './util/ImmutableTree';
+import { Path } from './util/Path';
+/**
+ * This class holds a collection of writes that can be applied to nodes in unison. It abstracts away the logic with
+ * dealing with priority writes and multiple nested writes. At any given path there is only allowed to be one write
+ * modifying that path. Any write to an existing path or shadowing an existing path will modify that existing write
+ * to reflect the write added.
+ */
+export declare class CompoundWrite {
+    writeTree_: ImmutableTree<Node>;
+    constructor(writeTree_: ImmutableTree<Node>);
+    static empty(): CompoundWrite;
+}
+export declare function compoundWriteAddWrite(compoundWrite: CompoundWrite, path: Path, node: Node): CompoundWrite;
+export declare function compoundWriteAddWrites(compoundWrite: CompoundWrite, path: Path, updates: {
+    [name: string]: Node;
+}): CompoundWrite;
+/**
+ * Will remove a write at the given path and deeper paths. This will <em>not</em> modify a write at a higher
+ * location, which must be removed by calling this method with that path.
+ *
+ * @param compoundWrite - The CompoundWrite to remove.
+ * @param path - The path at which a write and all deeper writes should be removed
+ * @returns The new CompoundWrite with the removed path
+ */
+export declare function compoundWriteRemoveWrite(compoundWrite: CompoundWrite, path: Path): CompoundWrite;
+/**
+ * Returns whether this CompoundWrite will fully overwrite a node at a given location and can therefore be
+ * considered "complete".
+ *
+ * @param compoundWrite - The CompoundWrite to check.
+ * @param path - The path to check for
+ * @returns Whether there is a complete write at that path
+ */
+export declare function compoundWriteHasCompleteWrite(compoundWrite: CompoundWrite, path: Path): boolean;
+/**
+ * Returns a node for a path if and only if the node is a "complete" overwrite at that path. This will not aggregate
+ * writes from deeper paths, but will return child nodes from a more shallow path.
+ *
+ * @param compoundWrite - The CompoundWrite to get the node from.
+ * @param path - The path to get a complete write
+ * @returns The node if complete at that path, or null otherwise.
+ */
+export declare function compoundWriteGetCompleteNode(compoundWrite: CompoundWrite, path: Path): Node | null;
+/**
+ * Returns all children that are guaranteed to be a complete overwrite.
+ *
+ * @param compoundWrite - The CompoundWrite to get children from.
+ * @returns A list of all complete children.
+ */
+export declare function compoundWriteGetCompleteChildren(compoundWrite: CompoundWrite): NamedNode[];
+export declare function compoundWriteChildCompoundWrite(compoundWrite: CompoundWrite, path: Path): CompoundWrite;
+/**
+ * Returns true if this CompoundWrite is empty and therefore does not modify any nodes.
+ * @returns Whether this CompoundWrite is empty
+ */
+export declare function compoundWriteIsEmpty(compoundWrite: CompoundWrite): boolean;
+/**
+ * Applies this CompoundWrite to a node. The node is returned with all writes from this CompoundWrite applied to the
+ * node
+ * @param node - The node to apply this CompoundWrite to
+ * @returns The node with all writes applied
+ */
+export declare function compoundWriteApply(compoundWrite: CompoundWrite, node: Node): Node;

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

@@ -1,135 +1,135 @@
-/**
- * @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 { AppCheckTokenProvider } from './AppCheckTokenProvider';
-import { AuthTokenProvider } from './AuthTokenProvider';
-import { RepoInfo } from './RepoInfo';
-import { ServerActions } from './ServerActions';
-import { QueryContext } from './view/EventRegistration';
-/**
- * Firebase connection.  Abstracts wire protocol and handles reconnecting.
- *
- * NOTE: All JSON objects sent to the realtime connection must have property names enclosed
- * in quotes to make sure the closure compiler does not minify them.
- */
-export declare class PersistentConnection extends ServerActions {
-    private repoInfo_;
-    private applicationId_;
-    private onDataUpdate_;
-    private onConnectStatus_;
-    private onServerInfoUpdate_;
-    private authTokenProvider_;
-    private appCheckTokenProvider_;
-    private authOverride_?;
-    id: number;
-    private log_;
-    private interruptReasons_;
-    private readonly listens;
-    private outstandingPuts_;
-    private outstandingGets_;
-    private outstandingPutCount_;
-    private outstandingGetCount_;
-    private onDisconnectRequestQueue_;
-    private connected_;
-    private reconnectDelay_;
-    private maxReconnectDelay_;
-    private securityDebugCallback_;
-    lastSessionId: string | null;
-    private establishConnectionTimer_;
-    private visible_;
-    private requestCBHash_;
-    private requestNumber_;
-    private realtime_;
-    private authToken_;
-    private appCheckToken_;
-    private forceTokenRefresh_;
-    private invalidAuthTokenCount_;
-    private invalidAppCheckTokenCount_;
-    private firstConnection_;
-    private lastConnectionAttemptTime_;
-    private lastConnectionEstablishedTime_;
-    private static nextPersistentConnectionId_;
-    /**
-     * Counter for number of connections created. Mainly used for tagging in the logs
-     */
-    private static nextConnectionId_;
-    /**
-     * @param repoInfo_ - Data about the namespace we are connecting to
-     * @param applicationId_ - The Firebase App ID for this project
-     * @param onDataUpdate_ - A callback for new data from the server
-     */
-    constructor(repoInfo_: RepoInfo, applicationId_: string, onDataUpdate_: (a: string, b: unknown, c: boolean, d: number | null) => void, onConnectStatus_: (a: boolean) => void, onServerInfoUpdate_: (a: unknown) => void, authTokenProvider_: AuthTokenProvider, appCheckTokenProvider_: AppCheckTokenProvider, authOverride_?: object | null);
-    protected sendRequest(action: string, body: unknown, onResponse?: (a: unknown) => void): void;
-    get(query: QueryContext): Promise<string>;
-    listen(query: QueryContext, currentHashFn: () => string, tag: number | null, onComplete: (a: string, b: unknown) => void): void;
-    private sendGet_;
-    private sendListen_;
-    private static warnOnListenWarnings_;
-    refreshAuthToken(token: string): void;
-    private reduceReconnectDelayIfAdminCredential_;
-    refreshAppCheckToken(token: string | null): void;
-    /**
-     * Attempts to authenticate with the given credentials. If the authentication attempt fails, it's triggered like
-     * a auth revoked (the connection is closed).
-     */
-    tryAuth(): void;
-    /**
-     * Attempts to authenticate with the given token. If the authentication
-     * attempt fails, it's triggered like the token was revoked (the connection is
-     * closed).
-     */
-    tryAppCheck(): void;
-    /**
-     * @inheritDoc
-     */
-    unlisten(query: QueryContext, tag: number | null): void;
-    private sendUnlisten_;
-    onDisconnectPut(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void): void;
-    onDisconnectMerge(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void): void;
-    onDisconnectCancel(pathString: string, onComplete?: (a: string, b: string) => void): void;
-    private sendOnDisconnect_;
-    put(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void, hash?: string): void;
-    merge(pathString: string, data: unknown, onComplete: (a: string, b: string | null) => void, hash?: string): void;
-    putInternal(action: string, pathString: string, data: unknown, onComplete: (a: string, b: string | null) => void, hash?: string): void;
-    private sendPut_;
-    reportStats(stats: {
-        [k: string]: unknown;
-    }): void;
-    private onDataMessage_;
-    private onDataPush_;
-    private onReady_;
-    private scheduleConnect_;
-    private initConnection_;
-    private onVisible_;
-    private onOnline_;
-    private onRealtimeDisconnect_;
-    private establishConnection_;
-    interrupt(reason: string): void;
-    resume(reason: string): void;
-    private handleTimestamp_;
-    private cancelSentTransactions_;
-    private onListenRevoked_;
-    private removeListen_;
-    private onAuthRevoked_;
-    private onAppCheckRevoked_;
-    private onSecurityDebugPacket_;
-    private restoreState_;
-    /**
-     * Sends client stats for first connection
-     */
-    private sendConnectStats_;
-    private shouldReconnect_;
-}
+/**
+ * @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 { AppCheckTokenProvider } from './AppCheckTokenProvider';
+import { AuthTokenProvider } from './AuthTokenProvider';
+import { RepoInfo } from './RepoInfo';
+import { ServerActions } from './ServerActions';
+import { QueryContext } from './view/EventRegistration';
+/**
+ * Firebase connection.  Abstracts wire protocol and handles reconnecting.
+ *
+ * NOTE: All JSON objects sent to the realtime connection must have property names enclosed
+ * in quotes to make sure the closure compiler does not minify them.
+ */
+export declare class PersistentConnection extends ServerActions {
+    private repoInfo_;
+    private applicationId_;
+    private onDataUpdate_;
+    private onConnectStatus_;
+    private onServerInfoUpdate_;
+    private authTokenProvider_;
+    private appCheckTokenProvider_;
+    private authOverride_?;
+    id: number;
+    private log_;
+    private interruptReasons_;
+    private readonly listens;
+    private outstandingPuts_;
+    private outstandingGets_;
+    private outstandingPutCount_;
+    private outstandingGetCount_;
+    private onDisconnectRequestQueue_;
+    private connected_;
+    private reconnectDelay_;
+    private maxReconnectDelay_;
+    private securityDebugCallback_;
+    lastSessionId: string | null;
+    private establishConnectionTimer_;
+    private visible_;
+    private requestCBHash_;
+    private requestNumber_;
+    private realtime_;
+    private authToken_;
+    private appCheckToken_;
+    private forceTokenRefresh_;
+    private invalidAuthTokenCount_;
+    private invalidAppCheckTokenCount_;
+    private firstConnection_;
+    private lastConnectionAttemptTime_;
+    private lastConnectionEstablishedTime_;
+    private static nextPersistentConnectionId_;
+    /**
+     * Counter for number of connections created. Mainly used for tagging in the logs
+     */
+    private static nextConnectionId_;
+    /**
+     * @param repoInfo_ - Data about the namespace we are connecting to
+     * @param applicationId_ - The Firebase App ID for this project
+     * @param onDataUpdate_ - A callback for new data from the server
+     */
+    constructor(repoInfo_: RepoInfo, applicationId_: string, onDataUpdate_: (a: string, b: unknown, c: boolean, d: number | null) => void, onConnectStatus_: (a: boolean) => void, onServerInfoUpdate_: (a: unknown) => void, authTokenProvider_: AuthTokenProvider, appCheckTokenProvider_: AppCheckTokenProvider, authOverride_?: object | null);
+    protected sendRequest(action: string, body: unknown, onResponse?: (a: unknown) => void): void;
+    get(query: QueryContext): Promise<string>;
+    listen(query: QueryContext, currentHashFn: () => string, tag: number | null, onComplete: (a: string, b: unknown) => void): void;
+    private sendGet_;
+    private sendListen_;
+    private static warnOnListenWarnings_;
+    refreshAuthToken(token: string): void;
+    private reduceReconnectDelayIfAdminCredential_;
+    refreshAppCheckToken(token: string | null): void;
+    /**
+     * Attempts to authenticate with the given credentials. If the authentication attempt fails, it's triggered like
+     * a auth revoked (the connection is closed).
+     */
+    tryAuth(): void;
+    /**
+     * Attempts to authenticate with the given token. If the authentication
+     * attempt fails, it's triggered like the token was revoked (the connection is
+     * closed).
+     */
+    tryAppCheck(): void;
+    /**
+     * @inheritDoc
+     */
+    unlisten(query: QueryContext, tag: number | null): void;
+    private sendUnlisten_;
+    onDisconnectPut(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void): void;
+    onDisconnectMerge(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void): void;
+    onDisconnectCancel(pathString: string, onComplete?: (a: string, b: string) => void): void;
+    private sendOnDisconnect_;
+    put(pathString: string, data: unknown, onComplete?: (a: string, b: string) => void, hash?: string): void;
+    merge(pathString: string, data: unknown, onComplete: (a: string, b: string | null) => void, hash?: string): void;
+    putInternal(action: string, pathString: string, data: unknown, onComplete: (a: string, b: string | null) => void, hash?: string): void;
+    private sendPut_;
+    reportStats(stats: {
+        [k: string]: unknown;
+    }): void;
+    private onDataMessage_;
+    private onDataPush_;
+    private onReady_;
+    private scheduleConnect_;
+    private initConnection_;
+    private onVisible_;
+    private onOnline_;
+    private onRealtimeDisconnect_;
+    private establishConnection_;
+    interrupt(reason: string): void;
+    resume(reason: string): void;
+    private handleTimestamp_;
+    private cancelSentTransactions_;
+    private onListenRevoked_;
+    private removeListen_;
+    private onAuthRevoked_;
+    private onAppCheckRevoked_;
+    private onSecurityDebugPacket_;
+    private restoreState_;
+    /**
+     * Sends client stats for first connection
+     */
+    private sendConnectStats_;
+    private shouldReconnect_;
+}

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

@@ -1,60 +1,60 @@
-/**
- * @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 { AppCheckTokenProvider } from './AppCheckTokenProvider';
-import { AuthTokenProvider } from './AuthTokenProvider';
-import { RepoInfo } from './RepoInfo';
-import { ServerActions } from './ServerActions';
-import { QueryContext } from './view/EventRegistration';
-/**
- * An implementation of ServerActions that communicates with the server via REST requests.
- * This is mostly useful for compatibility with crawlers, where we don't want to spin up a full
- * persistent connection (using WebSockets or long-polling)
- */
-export declare class ReadonlyRestClient extends ServerActions {
-    private repoInfo_;
-    private onDataUpdate_;
-    private authTokenProvider_;
-    private appCheckTokenProvider_;
-    reportStats(stats: {
-        [k: string]: unknown;
-    }): void;
-    /** @private {function(...[*])} */
-    private log_;
-    /**
-     * We don't actually need to track listens, except to prevent us calling an onComplete for a listen
-     * that's been removed. :-/
-     */
-    private listens_;
-    static getListenId_(query: QueryContext, tag?: number | null): string;
-    /**
-     * @param repoInfo_ - Data about the namespace we are connecting to
-     * @param onDataUpdate_ - A callback for new data from the server
-     */
-    constructor(repoInfo_: RepoInfo, onDataUpdate_: (a: string, b: unknown, c: boolean, d: number | null) => void, authTokenProvider_: AuthTokenProvider, appCheckTokenProvider_: AppCheckTokenProvider);
-    /** @inheritDoc */
-    listen(query: QueryContext, currentHashFn: () => string, tag: number | null, onComplete: (a: string, b: unknown) => void): void;
-    /** @inheritDoc */
-    unlisten(query: QueryContext, tag: number | null): void;
-    get(query: QueryContext): Promise<string>;
-    /** @inheritDoc */
-    refreshAuthToken(token: string): void;
-    /**
-     * Performs a REST request to the given path, with the provided query string parameters,
-     * and any auth credentials we have.
-     */
-    private restRequest_;
-}
+/**
+ * @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 { AppCheckTokenProvider } from './AppCheckTokenProvider';
+import { AuthTokenProvider } from './AuthTokenProvider';
+import { RepoInfo } from './RepoInfo';
+import { ServerActions } from './ServerActions';
+import { QueryContext } from './view/EventRegistration';
+/**
+ * An implementation of ServerActions that communicates with the server via REST requests.
+ * This is mostly useful for compatibility with crawlers, where we don't want to spin up a full
+ * persistent connection (using WebSockets or long-polling)
+ */
+export declare class ReadonlyRestClient extends ServerActions {
+    private repoInfo_;
+    private onDataUpdate_;
+    private authTokenProvider_;
+    private appCheckTokenProvider_;
+    reportStats(stats: {
+        [k: string]: unknown;
+    }): void;
+    /** @private {function(...[*])} */
+    private log_;
+    /**
+     * We don't actually need to track listens, except to prevent us calling an onComplete for a listen
+     * that's been removed. :-/
+     */
+    private listens_;
+    static getListenId_(query: QueryContext, tag?: number | null): string;
+    /**
+     * @param repoInfo_ - Data about the namespace we are connecting to
+     * @param onDataUpdate_ - A callback for new data from the server
+     */
+    constructor(repoInfo_: RepoInfo, onDataUpdate_: (a: string, b: unknown, c: boolean, d: number | null) => void, authTokenProvider_: AuthTokenProvider, appCheckTokenProvider_: AppCheckTokenProvider);
+    /** @inheritDoc */
+    listen(query: QueryContext, currentHashFn: () => string, tag: number | null, onComplete: (a: string, b: unknown) => void): void;
+    /** @inheritDoc */
+    unlisten(query: QueryContext, tag: number | null): void;
+    get(query: QueryContext): Promise<string>;
+    /** @inheritDoc */
+    refreshAuthToken(token: string): void;
+    /**
+     * Performs a REST request to the given path, with the provided query string parameters,
+     * and any auth credentials we have.
+     */
+    private restRequest_;
+}