@firebase/database 0.8.3-canary.fb90580e5 → 0.8.3

package/dist/exp/index.node.d.ts

@@ -1,83 +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 { FirebaseNamespace, FirebaseApp } from '@firebase/app-types';
-import { Database } from './src/api/Database';
-import { DataSnapshot } from './src/api/DataSnapshot';
-import { Query } from './src/api/Query';
-import { Reference } from './src/api/Reference';
-import { enableLogging } from './src/core/util/util';
-import * as INTERNAL from './src/api/internal';
-import * as TEST_ACCESS from './src/api/test_access';
-import * as types from '@firebase/database-types';
-declare const ServerValue: {
-    TIMESTAMP: {
-        '.sv': string;
-    };
-    increment: (delta: number) => {
-        '.sv': {
-            increment: number;
-        };
-    };
-};
-/**
- * A one off register function which returns a database based on the app and
- * passed database URL. (Used by the Admin SDK)
- *
- * @param app A valid FirebaseApp-like object
- * @param url A valid Firebase databaseURL
- * @param version custom version e.g. firebase-admin version
- * @param nodeAdmin true if the SDK is being initialized from Firebase Admin.
- */
-export declare function initStandalone(app: FirebaseApp, url: string, version: string, nodeAdmin?: boolean): {
-    instance: types.Database;
-    namespace: {
-        Reference: typeof Reference;
-        Query: typeof Query;
-        Database: typeof Database;
-        DataSnapshot: typeof DataSnapshot;
-        enableLogging: (logger_?: boolean | ((a: string) => void), persistent?: boolean) => void;
-        INTERNAL: typeof INTERNAL;
-        ServerValue: {
-            TIMESTAMP: {
-                '.sv': string;
-            };
-            increment: (delta: number) => {
-                '.sv': {
-                    increment: number;
-                };
-            };
-        };
-        TEST_ACCESS: typeof TEST_ACCESS;
-    };
-};
-export declare function registerDatabase(instance: FirebaseNamespace): void;
-export { Database, Query, Reference, enableLogging, ServerValue };
-export { DataSnapshot } from './src/api/DataSnapshot';
-export { OnDisconnect } from './src/api/onDisconnect';
-declare module '@firebase/app-types' {
-    interface FirebaseNamespace {
-        database?: {
-            (app?: FirebaseApp): types.FirebaseDatabase;
-            enableLogging: typeof types.enableLogging;
-            ServerValue: types.ServerValue;
-            Database: typeof types.FirebaseDatabase;
-        };
-    }
-    interface FirebaseApp {
-        database?(): types.FirebaseDatabase;
-    }
-}

package/dist/exp/src/api/DataSnapshot.d.ts

@@ -1,99 +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 { Node } from '../core/snap/Node';
-import { Reference } from './Reference';
-import { Index } from '../core/snap/indexes/Index';
-/**
- * Class representing a firebase data snapshot.  It wraps a SnapshotNode and
- * surfaces the public methods (val, forEach, etc.) we want to expose.
- */
-export declare class DataSnapshot {
-    private readonly node_;
-    private readonly ref_;
-    private readonly index_;
-    /**
-     * @param {!Node} node_ A SnapshotNode to wrap.
-     * @param {!Reference} ref_ The ref of the location this snapshot came from.
-     * @param {!Index} index_ The iteration order for this snapshot
-     */
-    constructor(node_: Node, ref_: Reference, index_: Index);
-    /**
-     * Retrieves the snapshot contents as JSON.  Returns null if the snapshot is
-     * empty.
-     *
-     * @return {*} JSON representation of the DataSnapshot contents, or null if empty.
-     */
-    val(): unknown;
-    /**
-     * Returns the snapshot contents as JSON, including priorities of node.  Suitable for exporting
-     * the entire node contents.
-     * @return {*} JSON representation of the DataSnapshot contents, or null if empty.
-     */
-    exportVal(): unknown;
-    toJSON(): unknown;
-    /**
-     * Returns whether the snapshot contains a non-null value.
-     *
-     * @return {boolean} Whether the snapshot contains a non-null value, or is empty.
-     */
-    exists(): boolean;
-    /**
-     * Returns a DataSnapshot of the specified child node's contents.
-     *
-     * @param {!string} childPathString Path to a child.
-     * @return {!DataSnapshot} DataSnapshot for child node.
-     */
-    child(childPathString: string): DataSnapshot;
-    /**
-     * Returns whether the snapshot contains a child at the specified path.
-     *
-     * @param {!string} childPathString Path to a child.
-     * @return {boolean} Whether the child exists.
-     */
-    hasChild(childPathString: string): boolean;
-    /**
-     * Returns the priority of the object, or null if no priority was set.
-     *
-     * @return {string|number|null} The priority.
-     */
-    getPriority(): string | number | null;
-    /**
-     * Iterates through child nodes and calls the specified action for each one.
-     *
-     * @param {function(!DataSnapshot)} action Callback function to be called
-     * for each child.
-     * @return {boolean} True if forEach was canceled by action returning true for
-     * one of the child nodes.
-     */
-    forEach(action: (d: DataSnapshot) => boolean | void): boolean;
-    /**
-     * Returns whether this DataSnapshot has children.
-     * @return {boolean} True if the DataSnapshot contains 1 or more child nodes.
-     */
-    hasChildren(): boolean;
-    get key(): string;
-    /**
-     * Returns the number of children for this DataSnapshot.
-     * @return {number} The number of children that this DataSnapshot contains.
-     */
-    numChildren(): number;
-    /**
-     * @return {Reference} The Firebase reference for the location this snapshot's data came from.
-     */
-    getRef(): Reference;
-    get ref(): Reference;
-}

package/dist/exp/src/api/Database.d.ts

@@ -1,87 +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 { Reference } from './Reference';
-import { Repo } from '../core/Repo';
-import { FirebaseApp } from '@firebase/app-types';
-import { FirebaseService } from '@firebase/app-types/private';
-/**
- * Class representing a firebase database.
- * @implements {FirebaseService}
- */
-export declare class Database implements FirebaseService {
-    private repoInternal_;
-    /** Track if the instance has been used (root or repo accessed) */
-    private instanceStarted_;
-    /** Backing state for root_ */
-    private rootInternal_?;
-    static readonly ServerValue: {
-        TIMESTAMP: {
-            '.sv': string;
-        };
-        increment: (delta: number) => {
-            '.sv': {
-                increment: number;
-            };
-        };
-    };
-    /**
-     * The constructor should not be called by users of our public API.
-     * @param {!Repo} repoInternal_
-     */
-    constructor(repoInternal_: Repo);
-    INTERNAL: {
-        delete: () => Promise<void>;
-    };
-    private get repo_();
-    get root_(): Reference;
-    get app(): FirebaseApp;
-    /**
-     * Modify this instance to communicate with the Realtime Database emulator.
-     *
-     * <p>Note: This method must be called before performing any other operation.
-     *
-     * @param host the emulator host (ex: localhost)
-     * @param port the emulator port (ex: 8080)
-     */
-    useEmulator(host: string, port: number): void;
-    /**
-     * Returns a reference to the root or to the path specified in the provided
-     * argument.
-     *
-     * @param {string|Reference=} path The relative string path or an existing
-     * Reference to a database location.
-     * @throws If a Reference is provided, throws if it does not belong to the
-     * same project.
-     * @return {!Reference} Firebase reference.
-     */
-    ref(path?: string): Reference;
-    ref(path?: Reference): Reference;
-    /**
-     * Returns a reference to the root or the path specified in url.
-     * We throw a exception if the url is not in the same domain as the
-     * current repo.
-     * @param {string} url
-     * @return {!Reference} Firebase reference.
-     */
-    refFromURL(url: string): Reference;
-    /**
-     * @param {string} apiName
-     */
-    private checkDeleted_;
-    goOffline(): void;
-    goOnline(): void;
-}

package/dist/exp/src/api/Query.d.ts

@@ -1,193 +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 '../core/util/Path';
-import { Repo } from '../core/Repo';
-import { QueryParams } from '../core/view/QueryParams';
-import { Reference } from './Reference';
-import { DataSnapshot } from './DataSnapshot';
-export interface SnapshotCallback {
-    (a: DataSnapshot, b?: string | null): unknown;
-}
-/**
- * A Query represents a filter to be applied to a firebase location.  This object purely represents the
- * query expression (and exposes our public API to build the query).  The actual query logic is in ViewBase.js.
- *
- * Since every Firebase reference is a query, Firebase inherits from this object.
- */
-export declare class Query {
-    repo: Repo;
-    path: Path;
-    private queryParams_;
-    private orderByCalled_;
-    static set __referenceConstructor(val: new (repo: Repo, path: Path) => Query);
-    static get __referenceConstructor(): new (repo: Repo, path: Path) => Query;
-    constructor(repo: Repo, path: Path, queryParams_: QueryParams, orderByCalled_: boolean);
-    /**
-     * Validates start/end values for queries.
-     * @param {!QueryParams} params
-     * @private
-     */
-    private static validateQueryEndpoints_;
-    /**
-     * Validates that limit* has been called with the correct combination of parameters
-     * @param {!QueryParams} params
-     * @private
-     */
-    private static validateLimit_;
-    /**
-     * Validates that no other order by call has been made
-     * @param {!string} fnName
-     * @private
-     */
-    private validateNoPreviousOrderByCall_;
-    /**
-     * @return {!QueryParams}
-     */
-    getQueryParams(): QueryParams;
-    /**
-     * @return {!Reference}
-     */
-    getRef(): Reference;
-    /**
-     * @param {!string} eventType
-     * @param {!function(DataSnapshot, string=)} callback
-     * @param {(function(Error)|Object)=} cancelCallbackOrContext
-     * @param {Object=} context
-     * @return {!function(DataSnapshot, string=)}
-     */
-    on(eventType: string, callback: SnapshotCallback, cancelCallbackOrContext?: ((a: Error) => unknown) | object | null, context?: object | null): SnapshotCallback;
-    /**
-     * @param {!function(!DataSnapshot)} callback
-     * @param {?function(Error)} cancelCallback
-     * @param {?Object} context
-     * @protected
-     */
-    protected onValueEvent(callback: (a: DataSnapshot) => void, cancelCallback: ((a: Error) => void) | null, context: object | null): void;
-    /**
-     * @param {!Object.<string, !function(!DataSnapshot, ?string)>} callbacks
-     * @param {?function(Error)} cancelCallback
-     * @param {?Object} context
-     * @protected
-     */
-    onChildEvent(callbacks: {
-        [k: string]: SnapshotCallback;
-    }, cancelCallback: ((a: Error) => unknown) | null, context: object | null): void;
-    /**
-     * @param {string=} eventType
-     * @param {(function(!DataSnapshot, ?string=))=} callback
-     * @param {Object=} context
-     */
-    off(eventType?: string, callback?: SnapshotCallback, context?: object | null): void;
-    /**
-     * Get the server-value for this query, or return a cached value if not connected.
-     */
-    get(): Promise<DataSnapshot>;
-    /**
-     * Attaches a listener, waits for the first event, and then removes the listener
-     * @param {!string} eventType
-     * @param {!function(!DataSnapshot, string=)} userCallback
-     * @param failureCallbackOrContext
-     * @param context
-     * @return {!firebase.Promise}
-     */
-    once(eventType: string, userCallback?: SnapshotCallback, failureCallbackOrContext?: ((a: Error) => void) | object | null, context?: object | null): Promise<DataSnapshot>;
-    /**
-     * Set a limit and anchor it to the start of the window.
-     * @param {!number} limit
-     * @return {!Query}
-     */
-    limitToFirst(limit: number): Query;
-    /**
-     * Set a limit and anchor it to the end of the window.
-     * @param {!number} limit
-     * @return {!Query}
-     */
-    limitToLast(limit: number): Query;
-    /**
-     * Given a child path, return a new query ordered by the specified grandchild path.
-     * @param {!string} path
-     * @return {!Query}
-     */
-    orderByChild(path: string): Query;
-    /**
-     * Return a new query ordered by the KeyIndex
-     * @return {!Query}
-     */
-    orderByKey(): Query;
-    /**
-     * Return a new query ordered by the PriorityIndex
-     * @return {!Query}
-     */
-    orderByPriority(): Query;
-    /**
-     * Return a new query ordered by the ValueIndex
-     * @return {!Query}
-     */
-    orderByValue(): Query;
-    /**
-     * @param {number|string|boolean|null} value
-     * @param {?string=} name
-     * @return {!Query}
-     */
-    startAt(value?: number | string | boolean | null, name?: string | null): Query;
-    startAfter(value?: number | string | boolean | null, name?: string | null): Query;
-    /**
-     * @param {number|string|boolean|null} value
-     * @param {?string=} name
-     * @return {!Query}
-     */
-    endAt(value?: number | string | boolean | null, name?: string | null): Query;
-    endBefore(value?: number | string | boolean | null, name?: string | null): Query;
-    /**
-     * Load the selection of children with exactly the specified value, and, optionally,
-     * the specified name.
-     * @param {number|string|boolean|null} value
-     * @param {string=} name
-     * @return {!Query}
-     */
-    equalTo(value: number | string | boolean | null, name?: string): Query;
-    /**
-     * @return {!string} URL for this location.
-     */
-    toString(): string;
-    toJSON(): string;
-    /**
-     * An object representation of the query parameters used by this Query.
-     * @return {!Object}
-     */
-    queryObject(): object;
-    /**
-     * @return {!string}
-     */
-    queryIdentifier(): string;
-    /**
-     * Return true if this query and the provided query are equivalent; otherwise, return false.
-     * @param {Query} other
-     * @return {boolean}
-     */
-    isEqual(other: Query): boolean;
-    /**
-     * Helper used by .on and .once to extract the context and or cancel arguments.
-     * @param {!string} fnName The function name (on or once)
-     * @param {(function(Error)|Object)=} cancelOrContext
-     * @param {Object=} context
-     * @return {{cancel: ?function(Error), context: ?Object}}
-     * @private
-     */
-    private static getCancelAndContextArgs_;
-    get ref(): Reference;
-}

package/dist/exp/src/api/Reference.d.ts

@@ -1,106 +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 { OnDisconnect } from './onDisconnect';
-import { TransactionResult } from './TransactionResult';
-import { Query } from './Query';
-import { Repo } from '../core/Repo';
-import { Path } from '../core/util/Path';
-import { Database } from './Database';
-import { DataSnapshot } from './DataSnapshot';
-export interface ReferenceConstructor {
-    new (repo: Repo, path: Path): Reference;
-}
-export declare class Reference extends Query {
-    then: Promise<Reference>['then'];
-    catch: Promise<Reference>['catch'];
-    /**
-     * Call options:
-     *   new Reference(Repo, Path) or
-     *   new Reference(url: string, string|RepoManager)
-     *
-     * Externally - this is the firebase.database.Reference type.
-     *
-     * @param {!Repo} repo
-     * @param {(!Path)} path
-     * @extends {Query}
-     */
-    constructor(repo: Repo, path: Path);
-    /** @return {?string} */
-    getKey(): string | null;
-    /**
-     * @param {!(string|Path)} pathString
-     * @return {!Reference}
-     */
-    child(pathString: string | Path): Reference;
-    /** @return {?Reference} */
-    getParent(): Reference | null;
-    /** @return {!Reference} */
-    getRoot(): Reference;
-    /** @return {!Database} */
-    databaseProp(): Database;
-    /**
-     * @param {*} newVal
-     * @param {function(?Error)=} onComplete
-     * @return {!Promise}
-     */
-    set(newVal: unknown, onComplete?: (a: Error | null) => void): Promise<unknown>;
-    /**
-     * @param {!Object} objectToMerge
-     * @param {function(?Error)=} onComplete
-     * @return {!Promise}
-     */
-    update(objectToMerge: object, onComplete?: (a: Error | null) => void): Promise<unknown>;
-    /**
-     * @param {*} newVal
-     * @param {string|number|null} newPriority
-     * @param {function(?Error)=} onComplete
-     * @return {!Promise}
-     */
-    setWithPriority(newVal: unknown, newPriority: string | number | null, onComplete?: (a: Error | null) => void): Promise<unknown>;
-    /**
-     * @param {function(?Error)=} onComplete
-     * @return {!Promise}
-     */
-    remove(onComplete?: (a: Error | null) => void): Promise<unknown>;
-    /**
-     * @param {function(*):*} transactionUpdate
-     * @param {(function(?Error, boolean, ?DataSnapshot))=} onComplete
-     * @param {boolean=} applyLocally
-     * @return {!Promise}
-     */
-    transaction(transactionUpdate: (a: unknown) => unknown, onComplete?: (a: Error | null, b: boolean, c: DataSnapshot | null) => void, applyLocally?: boolean): Promise<TransactionResult>;
-    /**
-     * @param {string|number|null} priority
-     * @param {function(?Error)=} onComplete
-     * @return {!Promise}
-     */
-    setPriority(priority: string | number | null, onComplete?: (a: Error | null) => void): Promise<unknown>;
-    /**
-     * @param {*=} value
-     * @param {function(?Error)=} onComplete
-     * @return {!Reference}
-     */
-    push(value?: unknown, onComplete?: (a: Error | null) => void): Reference;
-    /**
-     * @return {!OnDisconnect}
-     */
-    onDisconnect(): OnDisconnect;
-    get database(): Database;
-    get key(): string | null;
-    get parent(): Reference | null;
-    get root(): Reference;
-}

package/dist/exp/src/api/TransactionResult.d.ts

@@ -1,30 +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 './DataSnapshot';
-export declare class TransactionResult {
-    committed: boolean;
-    snapshot: DataSnapshot;
-    /**
-     * A type for the resolve value of Firebase.transaction.
-     * @constructor
-     * @dict
-     * @param {boolean} committed
-     * @param {DataSnapshot} snapshot
-     */
-    constructor(committed: boolean, snapshot: DataSnapshot);
-    toJSON(): object;
-}

package/dist/exp/src/api/internal.d.ts

@@ -1,55 +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 { Reference } from './Reference';
-import { FirebaseApp } from '@firebase/app-types';
-import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
-import * as types from '@firebase/database-types';
-/**
- * INTERNAL methods for internal-use only (tests, etc.).
- *
- * Customers shouldn't use these or else should be aware that they could break at any time.
- *
- * @const
- */
-export declare const forceLongPolling: () => void;
-export declare const forceWebSockets: () => void;
-export declare const isWebSocketsAvailable: () => boolean;
-export declare const setSecurityDebugCallback: (ref: Reference, callback: (a: object) => void) => void;
-export declare const stats: (ref: Reference, showDelta?: boolean) => void;
-export declare const statsIncrementCounter: (ref: Reference, metric: string) => void;
-export declare const dataUpdateCount: (ref: Reference) => number;
-export declare const interceptServerData: (ref: Reference, callback: (a: string, b: unknown) => void) => void;
-/**
- * Used by console to create a database based on the app,
- * passed database URL and a custom auth implementation.
- *
- * @param app A valid FirebaseApp-like object
- * @param url A valid Firebase databaseURL
- * @param version custom version e.g. firebase-admin version
- * @param customAuthImpl custom auth implementation
- */
-export declare function initStandalone<T>({ app, url, version, customAuthImpl, namespace, nodeAdmin }: {
-    app: FirebaseApp;
-    url: string;
-    version: string;
-    customAuthImpl: FirebaseAuthInternal;
-    namespace: T;
-    nodeAdmin?: boolean;
-}): {
-    instance: types.Database;
-    namespace: T;
-};