@firebase/database 0.8.3-canary.fb90580e5 → 0.8.3

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

@@ -1,74 +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';
-/**
- * @constructor
- * @struct
- * @param {!string} type The event type
- * @param {!Node} snapshotNode The data
- * @param {string=} childName The name for this child, if it's a child event
- * @param {Node=} oldSnap Used for intermediate processing of child changed events
- * @param {string=} prevName The name for the previous child, if applicable
- */
-export declare class Change {
-    type: string;
-    snapshotNode: Node;
-    childName?: string;
-    oldSnap?: Node;
-    prevName?: string | null;
-    constructor(type: string, snapshotNode: Node, childName?: string, oldSnap?: Node, prevName?: string | null);
-    /**
-     * @param {!Node} snapshot
-     * @return {!Change}
-     */
-    static valueChange(snapshot: Node): Change;
-    /**
-     * @param {string} childKey
-     * @param {!Node} snapshot
-     * @return {!Change}
-     */
-    static childAddedChange(childKey: string, snapshot: Node): Change;
-    /**
-     * @param {string} childKey
-     * @param {!Node} snapshot
-     * @return {!Change}
-     */
-    static childRemovedChange(childKey: string, snapshot: Node): Change;
-    /**
-     * @param {string} childKey
-     * @param {!Node} newSnapshot
-     * @param {!Node} oldSnapshot
-     * @return {!Change}
-     */
-    static childChangedChange(childKey: string, newSnapshot: Node, oldSnapshot: Node): Change;
-    /**
-     * @param {string} childKey
-     * @param {!Node} snapshot
-     * @return {!Change}
-     */
-    static childMovedChange(childKey: string, snapshot: Node): Change;
-    /** Event type for a child added */
-    static CHILD_ADDED: string;
-    /** Event type for a child removed */
-    static CHILD_REMOVED: string;
-    /** Event type for a child changed */
-    static CHILD_CHANGED: string;
-    /** Event type for a child moved */
-    static CHILD_MOVED: string;
-    /** Event type for a value change */
-    static VALUE: string;
-}

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

@@ -1,22 +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 { Change } from './Change';
-export declare class ChildChangeAccumulator {
-    private readonly changeMap;
-    trackChildChange(change: Change): void;
-    getChanges(): Change[];
-}

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

@@ -1,91 +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 { NamedNode, Node } from '../snap/Node';
-import { Index } from '../snap/indexes/Index';
-import { WriteTreeRef } from '../WriteTree';
-import { ViewCache } from './ViewCache';
-/**
- * Since updates to filtered nodes might require nodes to be pulled in from "outside" the node, this interface
- * can help to get complete children that can be pulled in.
- * A class implementing this interface takes potentially multiple sources (e.g. user writes, server data from
- * other views etc.) to try it's best to get a complete child that might be useful in pulling into the view.
- *
- * @interface
- */
-export interface CompleteChildSource {
-    /**
-     * @param {!string} childKey
-     * @return {?Node}
-     */
-    getCompleteChild(childKey: string): Node | null;
-    /**
-     * @param {!Index} index
-     * @param {!NamedNode} child
-     * @param {boolean} reverse
-     * @return {?NamedNode}
-     */
-    getChildAfterChild(index: Index, child: NamedNode, reverse: boolean): NamedNode | null;
-}
-/**
- * An implementation of CompleteChildSource that never returns any additional children
- *
- * @private
- * @constructor
- * @implements CompleteChildSource
- */
-export declare class NoCompleteChildSource_ implements CompleteChildSource {
-    /**
-     * @inheritDoc
-     */
-    getCompleteChild(childKey?: string): Node | null;
-    /**
-     * @inheritDoc
-     */
-    getChildAfterChild(index?: Index, child?: NamedNode, reverse?: boolean): NamedNode | null;
-}
-/**
- * Singleton instance.
- * @const
- * @type {!CompleteChildSource}
- */
-export declare const NO_COMPLETE_CHILD_SOURCE: NoCompleteChildSource_;
-/**
- * An implementation of CompleteChildSource that uses a WriteTree in addition to any other server data or
- * old event caches available to calculate complete children.
- *
- *
- * @implements CompleteChildSource
- */
-export declare class WriteTreeCompleteChildSource implements CompleteChildSource {
-    private writes_;
-    private viewCache_;
-    private optCompleteServerCache_;
-    /**
-     * @param {!WriteTreeRef} writes_
-     * @param {!ViewCache} viewCache_
-     * @param {?Node} optCompleteServerCache_
-     */
-    constructor(writes_: WriteTreeRef, viewCache_: ViewCache, optCompleteServerCache_?: Node | null);
-    /**
-     * @inheritDoc
-     */
-    getCompleteChild(childKey: string): Node | null;
-    /**
-     * @inheritDoc
-     */
-    getChildAfterChild(index: Index, child: NamedNode, reverse: boolean): NamedNode | null;
-}

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

@@ -1,102 +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 '../util/Path';
-import { EventRegistration } from './EventRegistration';
-import { DataSnapshot } from '../../api/DataSnapshot';
-/**
- * Encapsulates the data needed to raise an event
- * @interface
- */
-export interface Event {
-    /**
-     * @return {!Path}
-     */
-    getPath(): Path;
-    /**
-     * @return {!string}
-     */
-    getEventType(): string;
-    /**
-     * @return {!function()}
-     */
-    getEventRunner(): () => void;
-    /**
-     * @return {!string}
-     */
-    toString(): string;
-}
-export declare type EventType = 'value' | ' child_added' | ' child_changed' | ' child_moved' | ' child_removed';
-/**
- * Encapsulates the data needed to raise an event
- * @implements {Event}
- */
-export declare class DataEvent implements Event {
-    eventType: EventType;
-    eventRegistration: EventRegistration;
-    snapshot: DataSnapshot;
-    prevName?: string | null;
-    /**
-     * @param {!string} eventType One of: value, child_added, child_changed, child_moved, child_removed
-     * @param {!EventRegistration} eventRegistration The function to call to with the event data. User provided
-     * @param {!DataSnapshot} snapshot The data backing the event
-     * @param {?string=} prevName Optional, the name of the previous child for child_* events.
-     */
-    constructor(eventType: EventType, eventRegistration: EventRegistration, snapshot: DataSnapshot, prevName?: string | null);
-    /**
-     * @inheritDoc
-     */
-    getPath(): Path;
-    /**
-     * @inheritDoc
-     */
-    getEventType(): string;
-    /**
-     * @inheritDoc
-     */
-    getEventRunner(): () => void;
-    /**
-     * @inheritDoc
-     */
-    toString(): string;
-}
-export declare class CancelEvent implements Event {
-    eventRegistration: EventRegistration;
-    error: Error;
-    path: Path;
-    /**
-     * @param {EventRegistration} eventRegistration
-     * @param {Error} error
-     * @param {!Path} path
-     */
-    constructor(eventRegistration: EventRegistration, error: Error, path: Path);
-    /**
-     * @inheritDoc
-     */
-    getPath(): Path;
-    /**
-     * @inheritDoc
-     */
-    getEventType(): string;
-    /**
-     * @inheritDoc
-     */
-    getEventRunner(): () => void;
-    /**
-     * @inheritDoc
-     */
-    toString(): string;
-}

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

@@ -1,77 +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 { Change } from './Change';
-import { Query } from '../../api/Query';
-import { EventRegistration } from './EventRegistration';
-import { Event } from './Event';
-/**
- * An EventGenerator is used to convert "raw" changes (Change) as computed by the
- * CacheDiffer into actual events (Event) that can be raised.  See generateEventsForChanges()
- * for details.
- *
- * @constructor
- */
-export declare class EventGenerator {
-    private query_;
-    private index_;
-    /**
-     *
-     * @param {!Query} query_
-     */
-    constructor(query_: Query);
-    /**
-     * Given a set of raw changes (no moved events and prevName not specified yet), and a set of
-     * EventRegistrations that should be notified of these changes, generate the actual events to be raised.
-     *
-     * Notes:
-     *  - child_moved events will be synthesized at this time for any child_changed events that affect
-     *    our index.
-     *  - prevName will be calculated based on the index ordering.
-     *
-     * @param {!Array.<!Change>} changes
-     * @param {!Node} eventCache
-     * @param {!Array.<!EventRegistration>} eventRegistrations
-     * @return {!Array.<!Event>}
-     */
-    generateEventsForChanges(changes: Change[], eventCache: Node, eventRegistrations: EventRegistration[]): Event[];
-    /**
-     * Given changes of a single change type, generate the corresponding events.
-     *
-     * @param {!Array.<!Event>} events
-     * @param {!string} eventType
-     * @param {!Array.<!Change>} changes
-     * @param {!Array.<!EventRegistration>} registrations
-     * @param {!Node} eventCache
-     * @private
-     */
-    private generateEventsForType_;
-    /**
-     * @param {!Change} change
-     * @param {!Node} eventCache
-     * @return {!Change}
-     * @private
-     */
-    private materializeSingleChange_;
-    /**
-     * @param {!Change} a
-     * @param {!Change} b
-     * @return {number}
-     * @private
-     */
-    private compareChanges_;
-}

package/dist/exp/src/core/view/EventQueue.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 { Path } from '../util/Path';
-import { Event } from './Event';
-/**
- * The event queue serves a few purposes:
- * 1. It ensures we maintain event order in the face of event callbacks doing operations that result in more
- *    events being queued.
- * 2. raiseQueuedEvents() handles being called reentrantly nicely.  That is, if in the course of raising events,
- *    raiseQueuedEvents() is called again, the "inner" call will pick up raising events where the "outer" call
- *    left off, ensuring that the events are still raised synchronously and in order.
- * 3. You can use raiseEventsAtPath and raiseEventsForChangedPath to ensure only relevant previously-queued
- *    events are raised synchronously.
- *
- * NOTE: This can all go away if/when we move to async events.
- *
- * @constructor
- */
-export declare class EventQueue {
-    /**
-     * @private
-     * @type {!Array.<EventList>}
-     */
-    private eventLists_;
-    /**
-     * Tracks recursion depth of raiseQueuedEvents_, for debugging purposes.
-     * @private
-     * @type {!number}
-     */
-    private recursionDepth_;
-    /**
-     * @param {!Array.<Event>} eventDataList The new events to queue.
-     */
-    queueEvents(eventDataList: Event[]): void;
-    /**
-     * Queues the specified events and synchronously raises all events (including previously queued ones)
-     * for the specified path.
-     *
-     * It is assumed that the new events are all for the specified path.
-     *
-     * @param {!Path} path The path to raise events for.
-     * @param {!Array.<Event>} eventDataList The new events to raise.
-     */
-    raiseEventsAtPath(path: Path, eventDataList: Event[]): void;
-    /**
-     * Queues the specified events and synchronously raises all events (including previously queued ones) for
-     * locations related to the specified change path (i.e. all ancestors and descendants).
-     *
-     * It is assumed that the new events are all related (ancestor or descendant) to the specified path.
-     *
-     * @param {!Path} changedPath The path to raise events for.
-     * @param {!Array.<!Event>} eventDataList The events to raise
-     */
-    raiseEventsForChangedPath(changedPath: Path, eventDataList: Event[]): void;
-    /**
-     * @param {!function(!Path):boolean} predicate
-     * @private
-     */
-    private raiseQueuedEventsMatchingPredicate_;
-}
-/**
- * @param {!Path} path
- * @constructor
- */
-export declare class EventList {
-    private readonly path_;
-    /**
-     * @type {!Array.<Event>}
-     * @private
-     */
-    private events_;
-    constructor(path_: Path);
-    /**
-     * @param {!Event} eventData
-     */
-    add(eventData: Event): void;
-    /**
-     * Iterates through the list and raises each event
-     */
-    raise(): void;
-    /**
-     * @return {!Path}
-     */
-    getPath(): Path;
-}

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

@@ -1,154 +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 '../../api/DataSnapshot';
-import { DataEvent, CancelEvent, Event } from './Event';
-import { Path } from '../util/Path';
-import { Change } from './Change';
-import { Query } from '../../api/Query';
-/**
- * An EventRegistration is basically an event type ('value', 'child_added', etc.) and a callback
- * to be notified of that type of event.
- *
- * That said, it can also contain a cancel callback to be notified if the event is canceled.  And
- * currently, this code is organized around the idea that you would register multiple child_ callbacks
- * together, as a single EventRegistration.  Though currently we don't do that.
- */
-export interface EventRegistration {
-    /**
-     * True if this container has a callback to trigger for this event type
-     * @param {!string} eventType
-     * @return {boolean}
-     */
-    respondsTo(eventType: string): boolean;
-    /**
-     * @param {!Change} change
-     * @param {!Query} query
-     * @return {!Event}
-     */
-    createEvent(change: Change, query: Query): Event;
-    /**
-     * Given event data, return a function to trigger the user's callback
-     * @param {!Event} eventData
-     * @return {function()}
-     */
-    getEventRunner(eventData: Event): () => void;
-    /**
-     * @param {!Error} error
-     * @param {!Path} path
-     * @return {?CancelEvent}
-     */
-    createCancelEvent(error: Error, path: Path): CancelEvent | null;
-    /**
-     * @param {!EventRegistration} other
-     * @return {boolean}
-     */
-    matches(other: EventRegistration): boolean;
-    /**
-     * False basically means this is a "dummy" callback container being used as a sentinel
-     * to remove all callback containers of a particular type.  (e.g. if the user does
-     * ref.off('value') without specifying a specific callback).
-     *
-     * (TODO: Rework this, since it's hacky)
-     *
-     * @return {boolean}
-     */
-    hasAnyCallback(): boolean;
-}
-/**
- * Represents registration for 'value' events.
- */
-export declare class ValueEventRegistration implements EventRegistration {
-    private callback_;
-    private cancelCallback_;
-    private context_;
-    /**
-     * @param {?function(!DataSnapshot)} callback_
-     * @param {?function(Error)} cancelCallback_
-     * @param {?Object} context_
-     */
-    constructor(callback_: ((d: DataSnapshot) => void) | null, cancelCallback_: ((e: Error) => void) | null, context_: {} | null);
-    /**
-     * @inheritDoc
-     */
-    respondsTo(eventType: string): boolean;
-    /**
-     * @inheritDoc
-     */
-    createEvent(change: Change, query: Query): DataEvent;
-    /**
-     * @inheritDoc
-     */
-    getEventRunner(eventData: CancelEvent | DataEvent): () => void;
-    /**
-     * @inheritDoc
-     */
-    createCancelEvent(error: Error, path: Path): CancelEvent | null;
-    /**
-     * @inheritDoc
-     */
-    matches(other: EventRegistration): boolean;
-    /**
-     * @inheritDoc
-     */
-    hasAnyCallback(): boolean;
-}
-/**
- * Represents the registration of 1 or more child_xxx events.
- *
- * Currently, it is always exactly 1 child_xxx event, but the idea is we might let you
- * register a group of callbacks together in the future.
- *
- * @constructor
- * @implements {EventRegistration}
- */
-export declare class ChildEventRegistration implements EventRegistration {
-    private callbacks_;
-    private cancelCallback_;
-    private context_?;
-    /**
-     * @param {?Object.<string, function(!DataSnapshot, ?string=)>} callbacks_
-     * @param {?function(Error)} cancelCallback_
-     * @param {Object=} context_
-     */
-    constructor(callbacks_: {
-        [k: string]: (d: DataSnapshot, s?: string | null) => void;
-    } | null, cancelCallback_: ((e: Error) => void) | null, context_?: {});
-    /**
-     * @inheritDoc
-     */
-    respondsTo(eventType: string): boolean;
-    /**
-     * @inheritDoc
-     */
-    createCancelEvent(error: Error, path: Path): CancelEvent | null;
-    /**
-     * @inheritDoc
-     */
-    createEvent(change: Change, query: Query): DataEvent;
-    /**
-     * @inheritDoc
-     */
-    getEventRunner(eventData: CancelEvent | DataEvent): () => void;
-    /**
-     * @inheritDoc
-     */
-    matches(other: EventRegistration): boolean;
-    /**
-     * @inheritDoc
-     */
-    hasAnyCallback(): boolean;
-}