@depup/firebase__database 1.1.1-depup.0

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

@@ -0,0 +1,117 @@
+/**
+ * @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 { SortedMap } from './SortedMap';
+/**
+ * A tree with immutable elements.
+ */
+export declare class ImmutableTree<T> {
+    readonly value: T | null;
+    readonly children: SortedMap<string, ImmutableTree<T>>;
+    static fromObject<T>(obj: {
+        [k: string]: T;
+    }): ImmutableTree<T>;
+    constructor(value: T | null, children?: SortedMap<string, ImmutableTree<T>>);
+    /**
+     * True if the value is empty and there are no children
+     */
+    isEmpty(): boolean;
+    /**
+     * Given a path and predicate, return the first node and the path to that node
+     * where the predicate returns true.
+     *
+     * TODO Do a perf test -- If we're creating a bunch of `{path: value:}`
+     * objects on the way back out, it may be better to pass down a pathSoFar obj.
+     *
+     * @param relativePath - The remainder of the path
+     * @param predicate - The predicate to satisfy to return a node
+     */
+    findRootMostMatchingPathAndValue(relativePath: Path, predicate: (a: T) => boolean): {
+        path: Path;
+        value: T;
+    } | null;
+    /**
+     * Find, if it exists, the shortest subpath of the given path that points a defined
+     * value in the tree
+     */
+    findRootMostValueAndPath(relativePath: Path): {
+        path: Path;
+        value: T;
+    } | null;
+    /**
+     * @returns The subtree at the given path
+     */
+    subtree(relativePath: Path): ImmutableTree<T>;
+    /**
+     * Sets a value at the specified path.
+     *
+     * @param relativePath - Path to set value at.
+     * @param toSet - Value to set.
+     * @returns Resulting tree.
+     */
+    set(relativePath: Path, toSet: T | null): ImmutableTree<T>;
+    /**
+     * Removes the value at the specified path.
+     *
+     * @param relativePath - Path to value to remove.
+     * @returns Resulting tree.
+     */
+    remove(relativePath: Path): ImmutableTree<T>;
+    /**
+     * Gets a value from the tree.
+     *
+     * @param relativePath - Path to get value for.
+     * @returns Value at path, or null.
+     */
+    get(relativePath: Path): T | null;
+    /**
+     * Replace the subtree at the specified path with the given new tree.
+     *
+     * @param relativePath - Path to replace subtree for.
+     * @param newTree - New tree.
+     * @returns Resulting tree.
+     */
+    setTree(relativePath: Path, newTree: ImmutableTree<T>): ImmutableTree<T>;
+    /**
+     * Performs a depth first fold on this tree. Transforms a tree into a single
+     * value, given a function that operates on the path to a node, an optional
+     * current value, and a map of child names to folded subtrees
+     */
+    fold<V>(fn: (path: Path, value: T, children: {
+        [k: string]: V;
+    }) => V): V;
+    /**
+     * Recursive helper for public-facing fold() method
+     */
+    private fold_;
+    /**
+     * Find the first matching value on the given path. Return the result of applying f to it.
+     */
+    findOnPath<V>(path: Path, f: (path: Path, value: T) => V | null): V | null;
+    private findOnPath_;
+    foreachOnPath(path: Path, f: (path: Path, value: T) => void): ImmutableTree<T>;
+    private foreachOnPath_;
+    /**
+     * Calls the given function for each node in the tree that has a value.
+     *
+     * @param f - A function to be called with the path from the root of the tree to
+     * a node, and the value at that node. Called in depth-first order.
+     */
+    foreach(f: (path: Path, value: T) => void): void;
+    private foreach_;
+    foreachChild(f: (name: string, value: T) => void): void;
+}

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

@@ -0,0 +1,33 @@
+/**
+ * @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.
+ */
+/**
+ * Fancy ID generator that creates 20-character string identifiers with the
+ * following properties:
+ *
+ * 1. They're based on timestamp so that they sort *after* any existing ids.
+ * 2. They contain 72-bits of random data after the timestamp so that IDs won't
+ *    collide with other clients' IDs.
+ * 3. They sort *lexicographically* (so the timestamp is converted to characters
+ *    that will sort properly).
+ * 4. They're monotonically increasing. Even if you generate more than one in
+ *    the same timestamp, the latter ones will sort after the former ones. We do
+ *    this by using the previous random bits but "incrementing" them by 1 (only
+ *    in the case of a timestamp collision).
+ */
+export declare const nextPushId: (now: number) => string;
+export declare const successor: (key: string) => string;
+export declare const predecessor: (key: string) => string;

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

@@ -0,0 +1,31 @@
+/**
+ * @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';
+/**
+ * Monitors online state (as reported by window.online/offline events).
+ *
+ * The expectation is that this could have many false positives (thinks we are online
+ * when we're not), but no false negatives.  So we can safely use it to determine when
+ * we definitely cannot reach the internet.
+ */
+export declare class OnlineMonitor extends EventEmitter {
+    private online_;
+    static getInstance(): OnlineMonitor;
+    constructor();
+    getInitialEvent(eventType: string): boolean[];
+    currentlyOnline(): boolean;
+}

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

@@ -0,0 +1,94 @@
+/**
+ * @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.
+ */
+/**
+ * An immutable object representing a parsed path.  It's immutable so that you
+ * can pass them around to other functions without worrying about them changing
+ * it.
+ */
+export declare class Path {
+    pieces_: string[];
+    pieceNum_: number;
+    /**
+     * @param pathOrString - Path string to parse, or another path, or the raw
+     * tokens array
+     */
+    constructor(pathOrString: string | string[], pieceNum?: number);
+    toString(): string;
+}
+export declare function newEmptyPath(): Path;
+export declare function pathGetFront(path: Path): string | null;
+/**
+ * @returns The number of segments in this path
+ */
+export declare function pathGetLength(path: Path): number;
+export declare function pathPopFront(path: Path): Path;
+export declare function pathGetBack(path: Path): string | null;
+export declare function pathToUrlEncodedString(path: Path): string;
+/**
+ * Shallow copy of the parts of the path.
+ *
+ */
+export declare function pathSlice(path: Path, begin?: number): string[];
+export declare function pathParent(path: Path): Path | null;
+export declare function pathChild(path: Path, childPathObj: string | Path): Path;
+/**
+ * @returns True if there are no segments in this path
+ */
+export declare function pathIsEmpty(path: Path): boolean;
+/**
+ * @returns The path from outerPath to innerPath
+ */
+export declare function newRelativePath(outerPath: Path, innerPath: Path): Path;
+/**
+ * @returns -1, 0, 1 if left is less, equal, or greater than the right.
+ */
+export declare function pathCompare(left: Path, right: Path): number;
+/**
+ * @returns true if paths are the same.
+ */
+export declare function pathEquals(path: Path, other: Path): boolean;
+/**
+ * @returns True if this path is a parent of (or the same as) other
+ */
+export declare function pathContains(path: Path, other: Path): boolean;
+/**
+ * Dynamic (mutable) path used to count path lengths.
+ *
+ * This class is used to efficiently check paths for valid
+ * length (in UTF8 bytes) and depth (used in path validation).
+ *
+ * Throws Error exception if path is ever invalid.
+ *
+ * The definition of a path always begins with '/'.
+ */
+export declare class ValidationPath {
+    errorPrefix_: string;
+    parts_: string[];
+    /** Initialize to number of '/' chars needed in path. */
+    byteLength_: number;
+    /**
+     * @param path - Initial Path.
+     * @param errorPrefix_ - Prefix for any error messages.
+     */
+    constructor(path: Path, errorPrefix_: string);
+}
+export declare function validationPathPush(validationPath: ValidationPath, child: string): void;
+export declare function validationPathPop(validationPath: ValidationPath): void;
+/**
+ * String for use in error messages - uses '.' notation for path.
+ */
+export declare function validationPathToErrorString(validationPath: ValidationPath): string;

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

@@ -0,0 +1,56 @@
+/**
+ * @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 { SyncTree } from '../SyncTree';
+import { Indexable } from './misc';
+import { Path } from './Path';
+interface ValueProvider {
+    getImmediateChild(childName: string): ValueProvider;
+    node(): Node;
+}
+/**
+ * Generate placeholders for deferred values.
+ */
+export declare const generateWithValues: (values: {
+    [k: string]: unknown;
+} | null) => {
+    [k: string]: unknown;
+};
+/**
+ * Value to use when firing local events. When writing server values, fire
+ * local events with an approximate value, otherwise return value as-is.
+ */
+export declare const resolveDeferredLeafValue: (value: {
+    [k: string]: unknown;
+} | string | number | boolean, existingVal: ValueProvider, serverValues: {
+    [k: string]: unknown;
+}) => string | number | boolean;
+/**
+ * Recursively replace all deferred values and priorities in the tree with the
+ * specified generated replacement values.
+ * @param path - path to which write is relative
+ * @param node - new data written at path
+ * @param syncTree - current data
+ */
+export declare const resolveDeferredValueTree: (path: Path, node: Node, syncTree: SyncTree, serverValues: Indexable) => Node;
+/**
+ * Recursively replace all deferred values and priorities in the node with the
+ * specified generated replacement values.  If there are no server values in the node,
+ * it'll be returned as-is.
+ */
+export declare const resolveDeferredValueSnapshot: (node: Node, existing: Node, serverValues: Indexable) => Node;
+export {};

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

@@ -0,0 +1,324 @@
+/**
+ * @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.
+ */
+/**
+ * @fileoverview Implementation of an immutable SortedMap using a Left-leaning
+ * Red-Black Tree, adapted from the implementation in Mugs
+ * (http://mads379.github.com/mugs/) by Mads Hartmann Jensen
+ * (mads379\@gmail.com).
+ *
+ * Original paper on Left-leaning Red-Black Trees:
+ *   http://www.cs.princeton.edu/~rs/talks/LLRB/LLRB.pdf
+ *
+ * Invariant 1: No red node has a red child
+ * Invariant 2: Every leaf path has the same number of black nodes
+ * Invariant 3: Only the left child can be red (left leaning)
+ */
+export type Comparator<K> = (key1: K, key2: K) => number;
+/**
+ * An iterator over an LLRBNode.
+ */
+export declare class SortedMapIterator<K, V, T> {
+    private isReverse_;
+    private resultGenerator_;
+    private nodeStack_;
+    /**
+     * @param node - Node to iterate.
+     * @param isReverse_ - Whether or not to iterate in reverse
+     */
+    constructor(node: LLRBNode<K, V> | LLRBEmptyNode<K, V>, startKey: K | null, comparator: Comparator<K>, isReverse_: boolean, resultGenerator_?: ((k: K, v: V) => T) | null);
+    getNext(): T;
+    hasNext(): boolean;
+    peek(): T;
+}
+/**
+ * Represents a node in a Left-leaning Red-Black tree.
+ */
+export declare class LLRBNode<K, V> {
+    key: K;
+    value: V;
+    color: boolean;
+    left: LLRBNode<K, V> | LLRBEmptyNode<K, V>;
+    right: LLRBNode<K, V> | LLRBEmptyNode<K, V>;
+    /**
+     * @param key - Key associated with this node.
+     * @param value - Value associated with this node.
+     * @param color - Whether this node is red.
+     * @param left - Left child.
+     * @param right - Right child.
+     */
+    constructor(key: K, value: V, color: boolean | null, left?: LLRBNode<K, V> | LLRBEmptyNode<K, V> | null, right?: LLRBNode<K, V> | LLRBEmptyNode<K, V> | null);
+    static RED: boolean;
+    static BLACK: boolean;
+    /**
+     * Returns a copy of the current node, optionally replacing pieces of it.
+     *
+     * @param key - New key for the node, or null.
+     * @param value - New value for the node, or null.
+     * @param color - New color for the node, or null.
+     * @param left - New left child for the node, or null.
+     * @param right - New right child for the node, or null.
+     * @returns The node copy.
+     */
+    copy(key: K | null, value: V | null, color: boolean | null, left: LLRBNode<K, V> | LLRBEmptyNode<K, V> | null, right: LLRBNode<K, V> | LLRBEmptyNode<K, V> | null): LLRBNode<K, V>;
+    /**
+     * @returns The total number of nodes in the tree.
+     */
+    count(): number;
+    /**
+     * @returns True if the tree is empty.
+     */
+    isEmpty(): boolean;
+    /**
+     * Traverses the tree in key order and calls the specified action function
+     * for each node.
+     *
+     * @param action - Callback function to be called for each
+     *   node.  If it returns true, traversal is aborted.
+     * @returns The first truthy value returned by action, or the last falsey
+     *   value returned by action
+     */
+    inorderTraversal(action: (k: K, v: V) => unknown): boolean;
+    /**
+     * Traverses the tree in reverse key order and calls the specified action function
+     * for each node.
+     *
+     * @param action - Callback function to be called for each
+     * node.  If it returns true, traversal is aborted.
+     * @returns True if traversal was aborted.
+     */
+    reverseTraversal(action: (k: K, v: V) => void): boolean;
+    /**
+     * @returns The minimum node in the tree.
+     */
+    private min_;
+    /**
+     * @returns The maximum key in the tree.
+     */
+    minKey(): K;
+    /**
+     * @returns The maximum key in the tree.
+     */
+    maxKey(): K;
+    /**
+     * @param key - Key to insert.
+     * @param value - Value to insert.
+     * @param comparator - Comparator.
+     * @returns New tree, with the key/value added.
+     */
+    insert(key: K, value: V, comparator: Comparator<K>): LLRBNode<K, V>;
+    /**
+     * @returns New tree, with the minimum key removed.
+     */
+    private removeMin_;
+    /**
+     * @param key - The key of the item to remove.
+     * @param comparator - Comparator.
+     * @returns New tree, with the specified item removed.
+     */
+    remove(key: K, comparator: Comparator<K>): LLRBNode<K, V> | LLRBEmptyNode<K, V>;
+    /**
+     * @returns Whether this is a RED node.
+     */
+    isRed_(): boolean;
+    /**
+     * @returns New tree after performing any needed rotations.
+     */
+    private fixUp_;
+    /**
+     * @returns New tree, after moveRedLeft.
+     */
+    private moveRedLeft_;
+    /**
+     * @returns New tree, after moveRedRight.
+     */
+    private moveRedRight_;
+    /**
+     * @returns New tree, after rotateLeft.
+     */
+    private rotateLeft_;
+    /**
+     * @returns New tree, after rotateRight.
+     */
+    private rotateRight_;
+    /**
+     * @returns Newt ree, after colorFlip.
+     */
+    private colorFlip_;
+    /**
+     * For testing.
+     *
+     * @returns True if all is well.
+     */
+    private checkMaxDepth_;
+    check_(): number;
+}
+/**
+ * Represents an empty node (a leaf node in the Red-Black Tree).
+ */
+export declare class LLRBEmptyNode<K, V> {
+    key: K;
+    value: V;
+    left: LLRBNode<K, V> | LLRBEmptyNode<K, V>;
+    right: LLRBNode<K, V> | LLRBEmptyNode<K, V>;
+    color: boolean;
+    /**
+     * Returns a copy of the current node.
+     *
+     * @returns The node copy.
+     */
+    copy(key: K | null, value: V | null, color: boolean | null, left: LLRBNode<K, V> | LLRBEmptyNode<K, V> | null, right: LLRBNode<K, V> | LLRBEmptyNode<K, V> | null): LLRBEmptyNode<K, V>;
+    /**
+     * Returns a copy of the tree, with the specified key/value added.
+     *
+     * @param key - Key to be added.
+     * @param value - Value to be added.
+     * @param comparator - Comparator.
+     * @returns New tree, with item added.
+     */
+    insert(key: K, value: V, comparator: Comparator<K>): LLRBNode<K, V>;
+    /**
+     * Returns a copy of the tree, with the specified key removed.
+     *
+     * @param key - The key to remove.
+     * @param comparator - Comparator.
+     * @returns New tree, with item removed.
+     */
+    remove(key: K, comparator: Comparator<K>): LLRBEmptyNode<K, V>;
+    /**
+     * @returns The total number of nodes in the tree.
+     */
+    count(): number;
+    /**
+     * @returns True if the tree is empty.
+     */
+    isEmpty(): boolean;
+    /**
+     * Traverses the tree in key order and calls the specified action function
+     * for each node.
+     *
+     * @param action - Callback function to be called for each
+     * node.  If it returns true, traversal is aborted.
+     * @returns True if traversal was aborted.
+     */
+    inorderTraversal(action: (k: K, v: V) => unknown): boolean;
+    /**
+     * Traverses the tree in reverse key order and calls the specified action function
+     * for each node.
+     *
+     * @param action - Callback function to be called for each
+     * node.  If it returns true, traversal is aborted.
+     * @returns True if traversal was aborted.
+     */
+    reverseTraversal(action: (k: K, v: V) => void): boolean;
+    minKey(): null;
+    maxKey(): null;
+    check_(): number;
+    /**
+     * @returns Whether this node is red.
+     */
+    isRed_(): boolean;
+}
+/**
+ * An immutable sorted map implementation, based on a Left-leaning Red-Black
+ * tree.
+ */
+export declare class SortedMap<K, V> {
+    private comparator_;
+    private root_;
+    /**
+     * Always use the same empty node, to reduce memory.
+     */
+    static EMPTY_NODE: LLRBEmptyNode<unknown, unknown>;
+    /**
+     * @param comparator_ - Key comparator.
+     * @param root_ - Optional root node for the map.
+     */
+    constructor(comparator_: Comparator<K>, root_?: LLRBNode<K, V> | LLRBEmptyNode<K, V>);
+    /**
+     * Returns a copy of the map, with the specified key/value added or replaced.
+     * (TODO: We should perhaps rename this method to 'put')
+     *
+     * @param key - Key to be added.
+     * @param value - Value to be added.
+     * @returns New map, with item added.
+     */
+    insert(key: K, value: V): SortedMap<K, V>;
+    /**
+     * Returns a copy of the map, with the specified key removed.
+     *
+     * @param key - The key to remove.
+     * @returns New map, with item removed.
+     */
+    remove(key: K): SortedMap<K, V>;
+    /**
+     * Returns the value of the node with the given key, or null.
+     *
+     * @param key - The key to look up.
+     * @returns The value of the node with the given key, or null if the
+     * key doesn't exist.
+     */
+    get(key: K): V | null;
+    /**
+     * Returns the key of the item *before* the specified key, or null if key is the first item.
+     * @param key - The key to find the predecessor of
+     * @returns The predecessor key.
+     */
+    getPredecessorKey(key: K): K | null;
+    /**
+     * @returns True if the map is empty.
+     */
+    isEmpty(): boolean;
+    /**
+     * @returns The total number of nodes in the map.
+     */
+    count(): number;
+    /**
+     * @returns The minimum key in the map.
+     */
+    minKey(): K | null;
+    /**
+     * @returns The maximum key in the map.
+     */
+    maxKey(): K | null;
+    /**
+     * Traverses the map in key order and calls the specified action function
+     * for each key/value pair.
+     *
+     * @param action - Callback function to be called
+     * for each key/value pair.  If action returns true, traversal is aborted.
+     * @returns The first truthy value returned by action, or the last falsey
+     *   value returned by action
+     */
+    inorderTraversal(action: (k: K, v: V) => unknown): boolean;
+    /**
+     * Traverses the map in reverse key order and calls the specified action function
+     * for each key/value pair.
+     *
+     * @param action - Callback function to be called
+     * for each key/value pair.  If action returns true, traversal is aborted.
+     * @returns True if the traversal was aborted.
+     */
+    reverseTraversal(action: (k: K, v: V) => void): boolean;
+    /**
+     * Returns an iterator over the SortedMap.
+     * @returns The iterator.
+     */
+    getIterator<T>(resultGenerator?: (k: K, v: V) => T): SortedMapIterator<K, V, T>;
+    getIteratorFrom<T>(key: K, resultGenerator?: (k: K, v: V) => T): SortedMapIterator<K, V, T>;
+    getReverseIteratorFrom<T>(key: K, resultGenerator?: (k: K, v: V) => T): SortedMapIterator<K, V, T>;
+    getReverseIterator<T>(resultGenerator?: (k: K, v: V) => T): SortedMapIterator<K, V, T>;
+}