@firebase/database 1.0.9 → 1.0.10

package/dist/src/core/snap/Node.d.ts

@@ -1,126 +1,126 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { Path } from '../util/Path';
-import { Index } from './indexes/Index';
-/**
- * Node is an interface defining the common functionality for nodes in
- * a DataSnapshot.
- *
- * @interface
- */
-export interface Node {
-    /**
-     * Whether this node is a leaf node.
-     * @returns Whether this is a leaf node.
-     */
-    isLeafNode(): boolean;
-    /**
-     * Gets the priority of the node.
-     * @returns The priority of the node.
-     */
-    getPriority(): Node;
-    /**
-     * Returns a duplicate node with the new priority.
-     * @param newPriorityNode - New priority to set for the node.
-     * @returns Node with new priority.
-     */
-    updatePriority(newPriorityNode: Node): Node;
-    /**
-     * Returns the specified immediate child, or null if it doesn't exist.
-     * @param childName - The name of the child to retrieve.
-     * @returns The retrieved child, or an empty node.
-     */
-    getImmediateChild(childName: string): Node;
-    /**
-     * Returns a child by path, or null if it doesn't exist.
-     * @param path - The path of the child to retrieve.
-     * @returns The retrieved child or an empty node.
-     */
-    getChild(path: Path): Node;
-    /**
-     * Returns the name of the child immediately prior to the specified childNode, or null.
-     * @param childName - The name of the child to find the predecessor of.
-     * @param childNode - The node to find the predecessor of.
-     * @param index - The index to use to determine the predecessor
-     * @returns The name of the predecessor child, or null if childNode is the first child.
-     */
-    getPredecessorChildName(childName: string, childNode: Node, index: Index): string | null;
-    /**
-     * Returns a duplicate node, with the specified immediate child updated.
-     * Any value in the node will be removed.
-     * @param childName - The name of the child to update.
-     * @param newChildNode - The new child node
-     * @returns The updated node.
-     */
-    updateImmediateChild(childName: string, newChildNode: Node): Node;
-    /**
-     * Returns a duplicate node, with the specified child updated.  Any value will
-     * be removed.
-     * @param path - The path of the child to update.
-     * @param newChildNode - The new child node, which may be an empty node
-     * @returns The updated node.
-     */
-    updateChild(path: Path, newChildNode: Node): Node;
-    /**
-     * True if the immediate child specified exists
-     */
-    hasChild(childName: string): boolean;
-    /**
-     * @returns True if this node has no value or children.
-     */
-    isEmpty(): boolean;
-    /**
-     * @returns The number of children of this node.
-     */
-    numChildren(): number;
-    /**
-     * Calls action for each child.
-     * @param action - Action to be called for
-     * each child.  It's passed the child name and the child node.
-     * @returns The first truthy value return by action, or the last falsey one
-     */
-    forEachChild(index: Index, action: (a: string, b: Node) => void): unknown;
-    /**
-     * @param exportFormat - True for export format (also wire protocol format).
-     * @returns Value of this node as JSON.
-     */
-    val(exportFormat?: boolean): unknown;
-    /**
-     * @returns hash representing the node contents.
-     */
-    hash(): string;
-    /**
-     * @param other - Another node
-     * @returns -1 for less than, 0 for equal, 1 for greater than other
-     */
-    compareTo(other: Node): number;
-    /**
-     * @returns Whether or not this snapshot equals other
-     */
-    equals(other: Node): boolean;
-    /**
-     * @returns This node, with the specified index now available
-     */
-    withIndex(indexDefinition: Index): Node;
-    isIndexed(indexDefinition: Index): boolean;
-}
-export declare class NamedNode {
-    name: string;
-    node: Node;
-    constructor(name: string, node: Node);
-    static Wrap(name: string, node: Node): NamedNode;
-}
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Path } from '../util/Path';
+import { Index } from './indexes/Index';
+/**
+ * Node is an interface defining the common functionality for nodes in
+ * a DataSnapshot.
+ *
+ * @interface
+ */
+export interface Node {
+    /**
+     * Whether this node is a leaf node.
+     * @returns Whether this is a leaf node.
+     */
+    isLeafNode(): boolean;
+    /**
+     * Gets the priority of the node.
+     * @returns The priority of the node.
+     */
+    getPriority(): Node;
+    /**
+     * Returns a duplicate node with the new priority.
+     * @param newPriorityNode - New priority to set for the node.
+     * @returns Node with new priority.
+     */
+    updatePriority(newPriorityNode: Node): Node;
+    /**
+     * Returns the specified immediate child, or null if it doesn't exist.
+     * @param childName - The name of the child to retrieve.
+     * @returns The retrieved child, or an empty node.
+     */
+    getImmediateChild(childName: string): Node;
+    /**
+     * Returns a child by path, or null if it doesn't exist.
+     * @param path - The path of the child to retrieve.
+     * @returns The retrieved child or an empty node.
+     */
+    getChild(path: Path): Node;
+    /**
+     * Returns the name of the child immediately prior to the specified childNode, or null.
+     * @param childName - The name of the child to find the predecessor of.
+     * @param childNode - The node to find the predecessor of.
+     * @param index - The index to use to determine the predecessor
+     * @returns The name of the predecessor child, or null if childNode is the first child.
+     */
+    getPredecessorChildName(childName: string, childNode: Node, index: Index): string | null;
+    /**
+     * Returns a duplicate node, with the specified immediate child updated.
+     * Any value in the node will be removed.
+     * @param childName - The name of the child to update.
+     * @param newChildNode - The new child node
+     * @returns The updated node.
+     */
+    updateImmediateChild(childName: string, newChildNode: Node): Node;
+    /**
+     * Returns a duplicate node, with the specified child updated.  Any value will
+     * be removed.
+     * @param path - The path of the child to update.
+     * @param newChildNode - The new child node, which may be an empty node
+     * @returns The updated node.
+     */
+    updateChild(path: Path, newChildNode: Node): Node;
+    /**
+     * True if the immediate child specified exists
+     */
+    hasChild(childName: string): boolean;
+    /**
+     * @returns True if this node has no value or children.
+     */
+    isEmpty(): boolean;
+    /**
+     * @returns The number of children of this node.
+     */
+    numChildren(): number;
+    /**
+     * Calls action for each child.
+     * @param action - Action to be called for
+     * each child.  It's passed the child name and the child node.
+     * @returns The first truthy value return by action, or the last falsey one
+     */
+    forEachChild(index: Index, action: (a: string, b: Node) => void): unknown;
+    /**
+     * @param exportFormat - True for export format (also wire protocol format).
+     * @returns Value of this node as JSON.
+     */
+    val(exportFormat?: boolean): unknown;
+    /**
+     * @returns hash representing the node contents.
+     */
+    hash(): string;
+    /**
+     * @param other - Another node
+     * @returns -1 for less than, 0 for equal, 1 for greater than other
+     */
+    compareTo(other: Node): number;
+    /**
+     * @returns Whether or not this snapshot equals other
+     */
+    equals(other: Node): boolean;
+    /**
+     * @returns This node, with the specified index now available
+     */
+    withIndex(indexDefinition: Index): Node;
+    isIndexed(indexDefinition: Index): boolean;
+}
+export declare class NamedNode {
+    name: string;
+    node: Node;
+    constructor(name: string, node: Node);
+    static Wrap(name: string, node: Node): NamedNode;
+}

package/dist/src/core/snap/childSet.d.ts

@@ -1,32 +1,32 @@
-/**
- * @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 { SortedMap } from '../util/SortedMap';
-import { NamedNode } from './Node';
-/**
- * Takes a list of child nodes and constructs a SortedSet using the given comparison
- * function
- *
- * Uses the algorithm described in the paper linked here:
- * http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.46.1458
- *
- * @param childList - Unsorted list of children
- * @param cmp - The comparison method to be used
- * @param keyFn - An optional function to extract K from a node wrapper, if K's
- * type is not NamedNode
- * @param mapSortFn - An optional override for comparator used by the generated sorted map
- */
-export declare const buildChildSet: <K, V>(childList: NamedNode[], cmp: (a: NamedNode, b: NamedNode) => number, keyFn?: (a: NamedNode) => K, mapSortFn?: (a: K, b: K) => number) => SortedMap<K, V>;
+/**
+ * @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 { SortedMap } from '../util/SortedMap';
+import { NamedNode } from './Node';
+/**
+ * Takes a list of child nodes and constructs a SortedSet using the given comparison
+ * function
+ *
+ * Uses the algorithm described in the paper linked here:
+ * http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.46.1458
+ *
+ * @param childList - Unsorted list of children
+ * @param cmp - The comparison method to be used
+ * @param keyFn - An optional function to extract K from a node wrapper, if K's
+ * type is not NamedNode
+ * @param mapSortFn - An optional override for comparator used by the generated sorted map
+ */
+export declare const buildChildSet: <K, V>(childList: NamedNode[], cmp: (a: NamedNode, b: NamedNode) => number, keyFn?: (a: NamedNode) => K, mapSortFn?: (a: K, b: K) => number) => SortedMap<K, V>;

package/dist/src/core/snap/comparators.d.ts

@@ -1,19 +1,19 @@
-/**
- * @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 } from './Node';
-export declare function NAME_ONLY_COMPARATOR(left: NamedNode, right: NamedNode): number;
-export declare function NAME_COMPARATOR(left: string, right: string): number;
+/**
+ * @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 } from './Node';
+export declare function NAME_ONLY_COMPARATOR(left: NamedNode, right: NamedNode): number;
+export declare function NAME_COMPARATOR(left: string, right: string): number;

package/dist/src/core/snap/indexes/Index.d.ts

@@ -1,50 +1,50 @@
-/**
- * @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 { Comparator } from '../../util/SortedMap';
-import { Node, NamedNode } from '../Node';
-export declare abstract class Index {
-    abstract compare(a: NamedNode, b: NamedNode): number;
-    abstract isDefinedOn(node: Node): boolean;
-    /**
-     * @returns A standalone comparison function for
-     * this index
-     */
-    getCompare(): Comparator<NamedNode>;
-    /**
-     * Given a before and after value for a node, determine if the indexed value has changed. Even if they are different,
-     * it's possible that the changes are isolated to parts of the snapshot that are not indexed.
-     *
-     *
-     * @returns True if the portion of the snapshot being indexed changed between oldNode and newNode
-     */
-    indexedValueChanged(oldNode: Node, newNode: Node): boolean;
-    /**
-     * @returns a node wrapper that will sort equal to or less than
-     * any other node wrapper, using this index
-     */
-    minPost(): NamedNode;
-    /**
-     * @returns a node wrapper that will sort greater than or equal to
-     * any other node wrapper, using this index
-     */
-    abstract maxPost(): NamedNode;
-    abstract makePost(indexValue: unknown, name: string): NamedNode;
-    /**
-     * @returns String representation for inclusion in a query spec
-     */
-    abstract toString(): string;
-}
+/**
+ * @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 { Comparator } from '../../util/SortedMap';
+import { Node, NamedNode } from '../Node';
+export declare abstract class Index {
+    abstract compare(a: NamedNode, b: NamedNode): number;
+    abstract isDefinedOn(node: Node): boolean;
+    /**
+     * @returns A standalone comparison function for
+     * this index
+     */
+    getCompare(): Comparator<NamedNode>;
+    /**
+     * Given a before and after value for a node, determine if the indexed value has changed. Even if they are different,
+     * it's possible that the changes are isolated to parts of the snapshot that are not indexed.
+     *
+     *
+     * @returns True if the portion of the snapshot being indexed changed between oldNode and newNode
+     */
+    indexedValueChanged(oldNode: Node, newNode: Node): boolean;
+    /**
+     * @returns a node wrapper that will sort equal to or less than
+     * any other node wrapper, using this index
+     */
+    minPost(): NamedNode;
+    /**
+     * @returns a node wrapper that will sort greater than or equal to
+     * any other node wrapper, using this index
+     */
+    abstract maxPost(): NamedNode;
+    abstract makePost(indexValue: unknown, name: string): NamedNode;
+    /**
+     * @returns String representation for inclusion in a query spec
+     */
+    abstract toString(): string;
+}

package/dist/src/core/snap/indexes/KeyIndex.d.ts

@@ -1,34 +1,34 @@
-/**
- * @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 { ChildrenNode } from '../ChildrenNode';
-import { Node, NamedNode } from '../Node';
-import { Index } from './Index';
-export declare class KeyIndex extends Index {
-    static get __EMPTY_NODE(): ChildrenNode;
-    static set __EMPTY_NODE(val: ChildrenNode);
-    compare(a: NamedNode, b: NamedNode): number;
-    isDefinedOn(node: Node): boolean;
-    indexedValueChanged(oldNode: Node, newNode: Node): boolean;
-    minPost(): any;
-    maxPost(): NamedNode;
-    makePost(indexValue: string, name: string): NamedNode;
-    /**
-     * @returns String representation for inclusion in a query spec
-     */
-    toString(): string;
-}
-export declare const KEY_INDEX: KeyIndex;
+/**
+ * @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 { ChildrenNode } from '../ChildrenNode';
+import { Node, NamedNode } from '../Node';
+import { Index } from './Index';
+export declare class KeyIndex extends Index {
+    static get __EMPTY_NODE(): ChildrenNode;
+    static set __EMPTY_NODE(val: ChildrenNode);
+    compare(a: NamedNode, b: NamedNode): number;
+    isDefinedOn(node: Node): boolean;
+    indexedValueChanged(oldNode: Node, newNode: Node): boolean;
+    minPost(): any;
+    maxPost(): NamedNode;
+    makePost(indexValue: string, name: string): NamedNode;
+    /**
+     * @returns String representation for inclusion in a query spec
+     */
+    toString(): string;
+}
+export declare const KEY_INDEX: KeyIndex;

package/dist/src/core/snap/indexes/PathIndex.d.ts

@@ -1,29 +1,29 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { Path } from '../../util/Path';
-import { NamedNode, Node } from '../Node';
-import { Index } from './Index';
-export declare class PathIndex extends Index {
-    private indexPath_;
-    constructor(indexPath_: Path);
-    protected extractChild(snap: Node): Node;
-    isDefinedOn(node: Node): boolean;
-    compare(a: NamedNode, b: NamedNode): number;
-    makePost(indexValue: object, name: string): NamedNode;
-    maxPost(): NamedNode;
-    toString(): string;
-}
+/**
+ * @license
+ * Copyright 2017 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Path } from '../../util/Path';
+import { NamedNode, Node } from '../Node';
+import { Index } from './Index';
+export declare class PathIndex extends Index {
+    private indexPath_;
+    constructor(indexPath_: Path);
+    protected extractChild(snap: Node): Node;
+    isDefinedOn(node: Node): boolean;
+    compare(a: NamedNode, b: NamedNode): number;
+    makePost(indexValue: object, name: string): NamedNode;
+    maxPost(): NamedNode;
+    toString(): string;
+}

package/dist/src/core/snap/indexes/PriorityIndex.d.ts

@@ -1,33 +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.
- */
-import { NamedNode, Node } from '../Node';
-import { Index } from './Index';
-export declare function setNodeFromJSON(val: (a: unknown) => Node): void;
-export declare function setMaxNode(val: Node): void;
-export declare class PriorityIndex extends Index {
-    compare(a: NamedNode, b: NamedNode): number;
-    isDefinedOn(node: Node): boolean;
-    indexedValueChanged(oldNode: Node, newNode: Node): boolean;
-    minPost(): NamedNode;
-    maxPost(): NamedNode;
-    makePost(indexValue: unknown, name: string): NamedNode;
-    /**
-     * @returns String representation for inclusion in a query spec
-     */
-    toString(): string;
-}
-export declare const PRIORITY_INDEX: PriorityIndex;
+/**
+ * @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 '../Node';
+import { Index } from './Index';
+export declare function setNodeFromJSON(val: (a: unknown) => Node): void;
+export declare function setMaxNode(val: Node): void;
+export declare class PriorityIndex extends Index {
+    compare(a: NamedNode, b: NamedNode): number;
+    isDefinedOn(node: Node): boolean;
+    indexedValueChanged(oldNode: Node, newNode: Node): boolean;
+    minPost(): NamedNode;
+    maxPost(): NamedNode;
+    makePost(indexValue: unknown, name: string): NamedNode;
+    /**
+     * @returns String representation for inclusion in a query spec
+     */
+    toString(): string;
+}
+export declare const PRIORITY_INDEX: PriorityIndex;