@firebase/database 0.8.3-canary.fb90580e5 → 0.8.3

package/dist/exp/src/core/util/Tree.d.ts

@@ -1,134 +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 './Path';
-/**
- * Node in a Tree.
- */
-export declare class TreeNode<T> {
-    children: {
-        [name: string]: TreeNode<T>;
-    };
-    childCount: number;
-    value: T | null;
-}
-/**
- * A light-weight tree, traversable by path.  Nodes can have both values and children.
- * Nodes are not enumerated (by forEachChild) unless they have a value or non-empty
- * children.
- */
-export declare class Tree<T> {
-    private name_;
-    private parent_;
-    private node_;
-    /**
-     * @template T
-     * @param {string=} name_ Optional name of the node.
-     * @param {Tree=} parent_ Optional parent node.
-     * @param {TreeNode=} node_ Optional node to wrap.
-     */
-    constructor(name_?: string, parent_?: Tree<T> | null, node_?: TreeNode<T>);
-    /**
-     * Returns a sub-Tree for the given path.
-     *
-     * @param {!(string|Path)} pathObj Path to look up.
-     * @return {!Tree.<T>} Tree for path.
-     */
-    subTree(pathObj: string | Path): Tree<T>;
-    /**
-     * Returns the data associated with this tree node.
-     *
-     * @return {?T} The data or null if no data exists.
-     */
-    getValue(): T | null;
-    /**
-     * Sets data to this tree node.
-     *
-     * @param {!T} value Value to set.
-     */
-    setValue(value: T): void;
-    /**
-     * Clears the contents of the tree node (its value and all children).
-     */
-    clear(): void;
-    /**
-     * @return {boolean} Whether the tree has any children.
-     */
-    hasChildren(): boolean;
-    /**
-     * @return {boolean} Whether the tree is empty (no value or children).
-     */
-    isEmpty(): boolean;
-    /**
-     * Calls action for each child of this tree node.
-     *
-     * @param {function(!Tree.<T>)} action Action to be called for each child.
-     */
-    forEachChild(action: (tree: Tree<T>) => void): void;
-    /**
-     * Does a depth-first traversal of this node's descendants, calling action for each one.
-     *
-     * @param {function(!Tree.<T>)} action Action to be called for each child.
-     * @param {boolean=} includeSelf Whether to call action on this node as well. Defaults to
-     *   false.
-     * @param {boolean=} childrenFirst Whether to call action on children before calling it on
-     *   parent.
-     */
-    forEachDescendant(action: (tree: Tree<T>) => void, includeSelf?: boolean, childrenFirst?: boolean): void;
-    /**
-     * Calls action on each ancestor node.
-     *
-     * @param {function(!Tree.<T>)} action Action to be called on each parent; return
-     *   true to abort.
-     * @param {boolean=} includeSelf Whether to call action on this node as well.
-     * @return {boolean} true if the action callback returned true.
-     */
-    forEachAncestor(action: (tree: Tree<T>) => unknown, includeSelf?: boolean): boolean;
-    /**
-     * Does a depth-first traversal of this node's descendants.  When a descendant with a value
-     * is found, action is called on it and traversal does not continue inside the node.
-     * Action is *not* called on this node.
-     *
-     * @param {function(!Tree.<T>)} action Action to be called for each child.
-     */
-    forEachImmediateDescendantWithValue(action: (tree: Tree<T>) => void): void;
-    /**
-     * @return {!Path} The path of this tree node, as a Path.
-     */
-    path(): Path;
-    /**
-     * @return {string} The name of the tree node.
-     */
-    name(): string;
-    /**
-     * @return {?Tree} The parent tree node, or null if this is the root of the tree.
-     */
-    parent(): Tree<T> | null;
-    /**
-     * Adds or removes this child from its parent based on whether it's empty or not.
-     *
-     * @private
-     */
-    private updateParents_;
-    /**
-     * Adds or removes the passed child to this tree node, depending on whether it's empty.
-     *
-     * @param {string} childName The name of the child to update.
-     * @param {!Tree.<T>} child The child to update.
-     * @private
-     */
-    private updateChild_;
-}

package/dist/exp/src/core/util/VisibilityMonitor.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 { EventEmitter } from './EventEmitter';
-/**
- * @extends {EventEmitter}
- */
-export declare class VisibilityMonitor extends EventEmitter {
-    private visible_;
-    static getInstance(): VisibilityMonitor;
-    constructor();
-    /**
-     * @param {!string} eventType
-     * @return {Array.<boolean>}
-     */
-    getInitialEvent(eventType: string): boolean[];
-}

package/dist/exp/src/core/util/libs/parser.d.ts

@@ -1,37 +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 '../Path';
-import { RepoInfo } from '../../RepoInfo';
-export declare const parseRepoInfo: (dataURL: string, nodeAdmin: boolean) => {
-    repoInfo: RepoInfo;
-    path: Path;
-};
-/**
- *
- * @param {!string} dataURL
- * @return {{host: string, port: number, domain: string, subdomain: string, secure: boolean, scheme: string, pathString: string, namespace: string}}
- */
-export declare const parseDatabaseURL: (dataURL: string) => {
-    host: string;
-    port: number;
-    domain: string;
-    subdomain: string;
-    secure: boolean;
-    scheme: string;
-    pathString: string;
-    namespace: string;
-};

package/dist/exp/src/core/util/misc.d.ts

@@ -1,19 +0,0 @@
-/**
- * @license
- * Copyright 2019 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.
- */
-export interface Indexable {
-    [key: string]: unknown;
-}

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

@@ -1,232 +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';
-/**
- * Returns a locally-unique ID (generated by just incrementing up from 0 each time its called).
- * @type {function(): number} Generated ID.
- */
-export declare const LUIDGenerator: () => number;
-/**
- * Sha1 hash of the input string
- * @param {!string} str The string to hash
- * @return {!string} The resulting hash
- */
-export declare const sha1: (str: string) => string;
-/**
- * Use this for all debug messages in Firebase.
- * @type {?function(string)}
- */
-export declare let logger: ((a: string) => void) | null;
-/**
- * The implementation of Firebase.enableLogging (defined here to break dependencies)
- * @param {boolean|?function(string)} logger_ A flag to turn on logging, or a custom logger
- * @param {boolean=} persistent Whether or not to persist logging settings across refreshes
- */
-export declare const enableLogging: (logger_?: boolean | ((a: string) => void), persistent?: boolean) => void;
-/**
- *
- * @param {...(string|Arguments)} varArgs
- */
-export declare const log: (...varArgs: unknown[]) => void;
-/**
- * @param {!string} prefix
- * @return {function(...[*])}
- */
-export declare const logWrapper: (prefix: string) => (...varArgs: unknown[]) => void;
-/**
- * @param {...string} varArgs
- */
-export declare const error: (...varArgs: string[]) => void;
-/**
- * @param {...string} varArgs
- */
-export declare const fatal: (...varArgs: string[]) => never;
-/**
- * @param {...*} varArgs
- */
-export declare const warn: (...varArgs: unknown[]) => void;
-/**
- * Logs a warning if the containing page uses https. Called when a call to new Firebase
- * does not use https.
- */
-export declare const warnIfPageIsSecure: () => void;
-/**
- * @param {!String} methodName
- */
-export declare const warnAboutUnsupportedMethod: (methodName: string) => void;
-/**
- * Returns true if data is NaN, or +/- Infinity.
- * @param {*} data
- * @return {boolean}
- */
-export declare const isInvalidJSONNumber: (data: unknown) => boolean;
-/**
- * @param {function()} fn
- */
-export declare const executeWhenDOMReady: (fn: () => void) => void;
-/**
- * Minimum key name. Invalid for actual data, used as a marker to sort before any valid names
- * @type {!string}
- */
-export declare const MIN_NAME = "[MIN_NAME]";
-/**
- * Maximum key name. Invalid for actual data, used as a marker to sort above any valid names
- * @type {!string}
- */
-export declare const MAX_NAME = "[MAX_NAME]";
-/**
- * Compares valid Firebase key names, plus min and max name
- * @param {!string} a
- * @param {!string} b
- * @return {!number}
- */
-export declare const nameCompare: (a: string, b: string) => number;
-/**
- * @param {!string} a
- * @param {!string} b
- * @return {!number} comparison result.
- */
-export declare const stringCompare: (a: string, b: string) => number;
-/**
- * @param {string} key
- * @param {Object} obj
- * @return {*}
- */
-export declare const requireKey: (key: string, obj: {
-    [k: string]: unknown;
-}) => unknown;
-/**
- * @param {*} obj
- * @return {string}
- */
-export declare const ObjectToUniqueKey: (obj: unknown) => string;
-/**
- * Splits a string into a number of smaller segments of maximum size
- * @param {!string} str The string
- * @param {!number} segsize The maximum number of chars in the string.
- * @return {Array.<string>} The string, split into appropriately-sized chunks
- */
-export declare const splitStringBySize: (str: string, segsize: number) => string[];
-/**
- * Apply a function to each (key, value) pair in an object or
- * apply a function to each (index, value) pair in an array
- * @param obj The object or array to iterate over
- * @param fn The function to apply
- */
-export declare function each(obj: object, fn: (k: string, v: unknown) => void): void;
-/**
- * Like goog.bind, but doesn't bother to create a closure if opt_context is null/undefined.
- * @param {function(*)} callback Callback function.
- * @param {?Object=} context Optional context to bind to.
- * @return {function(*)}
- */
-export declare const bindCallback: (callback: (a: unknown) => void, context?: object | null) => (a: unknown) => void;
-/**
- * Borrowed from http://hg.secondlife.com/llsd/src/tip/js/typedarray.js (MIT License)
- * I made one modification at the end and removed the NaN / Infinity
- * handling (since it seemed broken [caused an overflow] and we don't need it).  See MJL comments.
- * @param {!number} v A double
- * @return {string}
- */
-export declare const doubleToIEEE754String: (v: number) => string;
-/**
- * Used to detect if we're in a Chrome content script (which executes in an
- * isolated environment where long-polling doesn't work).
- * @return {boolean}
- */
-export declare const isChromeExtensionContentScript: () => boolean;
-/**
- * Used to detect if we're in a Windows 8 Store app.
- * @return {boolean}
- */
-export declare const isWindowsStoreApp: () => boolean;
-/**
- * Converts a server error code to a Javascript Error
- * @param {!string} code
- * @param {!Query} query
- * @return {Error}
- */
-export declare const errorForServerCode: (code: string, query: Query) => Error;
-/**
- * Used to test for integer-looking strings
- * @type {RegExp}
- * @private
- */
-export declare const INTEGER_REGEXP_: RegExp;
-/**
- * For use in keys, the minimum possible 32-bit integer.
- */
-export declare const INTEGER_32_MIN = -2147483648;
-/**
- * For use in kyes, the maximum possible 32-bit integer.
- */
-export declare const INTEGER_32_MAX = 2147483647;
-/**
- * If the string contains a 32-bit integer, return it.  Else return null.
- * @param {!string} str
- * @return {?number}
- */
-export declare const tryParseInt: (str: string) => number | null;
-/**
- * Helper to run some code but catch any exceptions and re-throw them later.
- * Useful for preventing user callbacks from breaking internal code.
- *
- * Re-throwing the exception from a setTimeout is a little evil, but it's very
- * convenient (we don't have to try to figure out when is a safe point to
- * re-throw it), and the behavior seems reasonable:
- *
- * * If you aren't pausing on exceptions, you get an error in the console with
- *   the correct stack trace.
- * * If you're pausing on all exceptions, the debugger will pause on your
- *   exception and then again when we rethrow it.
- * * If you're only pausing on uncaught exceptions, the debugger will only pause
- *   on us re-throwing it.
- *
- * @param {!function()} fn The code to guard.
- */
-export declare const exceptionGuard: (fn: () => void) => void;
-/**
- * Helper function to safely call opt_callback with the specified arguments.  It:
- * 1. Turns into a no-op if opt_callback is null or undefined.
- * 2. Wraps the call inside exceptionGuard to prevent exceptions from breaking our state.
- *
- * @param {?Function=} callback Optional onComplete callback.
- * @param {...*} varArgs Arbitrary args to be passed to opt_onComplete
- */
-export declare const callUserCallback: (callback?: Function | null, ...varArgs: unknown[]) => void;
-/**
- * @return {boolean} true if we think we're currently being crawled.
- */
-export declare const beingCrawled: () => boolean;
-/**
- * Export a property of an object using a getter function.
- *
- * @param {!Object} object
- * @param {string} name
- * @param {!function(): *} fnGet
- */
-export declare const exportPropGetter: (object: object, name: string, fnGet: () => unknown) => void;
-/**
- * Same as setTimeout() except on Node.JS it will /not/ prevent the process from exiting.
- *
- * It is removed with clearTimeout() as normal.
- *
- * @param {Function} fn Function to run.
- * @param {number} time Milliseconds to wait before running.
- * @return {number|Object} The setTimeout() return value.
- */
-export declare const setTimeoutNonBlocking: (fn: () => void, time: number) => number | object;

package/dist/exp/src/core/util/validation.d.ts

@@ -1,108 +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, ValidationPath } from './Path';
-import { RepoInfo } from '../RepoInfo';
-/**
- * True for invalid Firebase keys
- * @type {RegExp}
- * @private
- */
-export declare const INVALID_KEY_REGEX_: RegExp;
-/**
- * True for invalid Firebase paths.
- * Allows '/' in paths.
- * @type {RegExp}
- * @private
- */
-export declare const INVALID_PATH_REGEX_: RegExp;
-/**
- * Maximum number of characters to allow in leaf value
- * @type {number}
- * @private
- */
-export declare const MAX_LEAF_SIZE_: number;
-/**
- * @param {*} key
- * @return {boolean}
- */
-export declare const isValidKey: (key: unknown) => boolean;
-/**
- * @param {string} pathString
- * @return {boolean}
- */
-export declare const isValidPathString: (pathString: string) => boolean;
-/**
- * @param {string} pathString
- * @return {boolean}
- */
-export declare const isValidRootPathString: (pathString: string) => boolean;
-/**
- * @param {*} priority
- * @return {boolean}
- */
-export declare const isValidPriority: (priority: unknown) => boolean;
-/**
- * Pre-validate a datum passed as an argument to Firebase function.
- *
- * @param {string} fnName
- * @param {number} argumentNumber
- * @param {*} data
- * @param {!Path} path
- * @param {boolean} optional
- */
-export declare const validateFirebaseDataArg: (fnName: string, argumentNumber: number, data: unknown, path: Path, optional: boolean) => void;
-/**
- * Validate a data object client-side before sending to server.
- *
- * @param {string} errorPrefix
- * @param {*} data
- * @param {!Path|!ValidationPath} path_
- */
-export declare const validateFirebaseData: (errorPrefix: string, data: unknown, path_: Path | ValidationPath) => void;
-/**
- * Pre-validate paths passed in the firebase function.
- *
- * @param {string} errorPrefix
- * @param {Array<!Path>} mergePaths
- */
-export declare const validateFirebaseMergePaths: (errorPrefix: string, mergePaths: Path[]) => void;
-/**
- * pre-validate an object passed as an argument to firebase function (
- * must be an object - e.g. for firebase.update()).
- *
- * @param {string} fnName
- * @param {number} argumentNumber
- * @param {*} data
- * @param {!Path} path
- * @param {boolean} optional
- */
-export declare const validateFirebaseMergeDataArg: (fnName: string, argumentNumber: number, data: unknown, path: Path, optional: boolean) => void;
-export declare const validatePriority: (fnName: string, argumentNumber: number, priority: unknown, optional: boolean) => void;
-export declare const validateEventType: (fnName: string, argumentNumber: number, eventType: string, optional: boolean) => void;
-export declare const validateKey: (fnName: string, argumentNumber: number, key: string, optional: boolean) => void;
-export declare const validatePathString: (fnName: string, argumentNumber: number, pathString: string, optional: boolean) => void;
-export declare const validateRootPathString: (fnName: string, argumentNumber: number, pathString: string, optional: boolean) => void;
-export declare const validateWritablePath: (fnName: string, path: Path) => void;
-export declare const validateUrl: (fnName: string, argumentNumber: number, parsedUrl: {
-    repoInfo: RepoInfo;
-    path: Path;
-}) => void;
-export declare const validateCredential: (fnName: string, argumentNumber: number, cred: unknown, optional: boolean) => void;
-export declare const validateBoolean: (fnName: string, argumentNumber: number, bool: unknown, optional: boolean) => void;
-export declare const validateString: (fnName: string, argumentNumber: number, string: unknown, optional: boolean) => void;
-export declare const validateObject: (fnName: string, argumentNumber: number, obj: unknown, optional: boolean) => void;
-export declare const validateObjectContainsKey: (fnName: string, argumentNumber: number, obj: unknown, key: string, optional: boolean, optType?: string) => void;

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

@@ -1,19 +0,0 @@
-/**
- * @license
- * Copyright 2019 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.
- */
-/** The semver (www.semver.org) version of the SDK. */
-export declare let SDK_VERSION: string;
-export declare function setSDKVersion(version: string): void;

package/dist/exp/src/core/view/CacheNode.d.ts

@@ -1,59 +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 '../snap/Node';
-import { Path } from '../util/Path';
-/**
- * A cache node only stores complete children. Additionally it holds a flag whether the node can be considered fully
- * initialized in the sense that we know at one point in time this represented a valid state of the world, e.g.
- * initialized with data from the server, or a complete overwrite by the client. The filtered flag also tracks
- * whether a node potentially had children removed due to a filter.
- */
-export declare class CacheNode {
-    private node_;
-    private fullyInitialized_;
-    private filtered_;
-    /**
-     * @param {!Node} node_
-     * @param {boolean} fullyInitialized_
-     * @param {boolean} filtered_
-     */
-    constructor(node_: Node, fullyInitialized_: boolean, filtered_: boolean);
-    /**
-     * Returns whether this node was fully initialized with either server data or a complete overwrite by the client
-     * @return {boolean}
-     */
-    isFullyInitialized(): boolean;
-    /**
-     * Returns whether this node is potentially missing children due to a filter applied to the node
-     * @return {boolean}
-     */
-    isFiltered(): boolean;
-    /**
-     * @param {!Path} path
-     * @return {boolean}
-     */
-    isCompleteForPath(path: Path): boolean;
-    /**
-     * @param {!string} key
-     * @return {boolean}
-     */
-    isCompleteForChild(key: string): boolean;
-    /**
-     * @return {!Node}
-     */
-    getNode(): Node;
-}