@firebase/database 0.8.3-canary.fb90580e5 → 0.8.3

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

@@ -1,176 +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 { NodeFilter } from './filter/NodeFilter';
-import { Index } from '../snap/indexes/Index';
-/**
- * This class is an immutable-from-the-public-api struct containing a set of query parameters defining a
- * range to be returned for a particular location. It is assumed that validation of parameters is done at the
- * user-facing API level, so it is not done here.
- * @constructor
- */
-export declare class QueryParams {
-    private limitSet_;
-    private startSet_;
-    private startNameSet_;
-    private startAfterSet_;
-    private endSet_;
-    private endNameSet_;
-    private endBeforeSet_;
-    private limit_;
-    private viewFrom_;
-    private indexStartValue_;
-    private indexStartName_;
-    private indexEndValue_;
-    private indexEndName_;
-    private index_;
-    /**
-     * Wire Protocol Constants
-     * @const
-     * @enum {string}
-     * @private
-     */
-    private static readonly WIRE_PROTOCOL_CONSTANTS_;
-    /**
-     * REST Query Constants
-     * @const
-     * @enum {string}
-     * @private
-     */
-    private static readonly REST_QUERY_CONSTANTS_;
-    /**
-     * Default, empty query parameters
-     * @type {!QueryParams}
-     * @const
-     */
-    static readonly DEFAULT: QueryParams;
-    /**
-     * @return {boolean}
-     */
-    hasStart(): boolean;
-    hasStartAfter(): boolean;
-    hasEndBefore(): boolean;
-    /**
-     * @return {boolean} True if it would return from left.
-     */
-    isViewFromLeft(): boolean;
-    /**
-     * Only valid to call if hasStart() returns true
-     * @return {*}
-     */
-    getIndexStartValue(): unknown;
-    /**
-     * Only valid to call if hasStart() returns true.
-     * Returns the starting key name for the range defined by these query parameters
-     * @return {!string}
-     */
-    getIndexStartName(): string;
-    /**
-     * @return {boolean}
-     */
-    hasEnd(): boolean;
-    /**
-     * Only valid to call if hasEnd() returns true.
-     * @return {*}
-     */
-    getIndexEndValue(): unknown;
-    /**
-     * Only valid to call if hasEnd() returns true.
-     * Returns the end key name for the range defined by these query parameters
-     * @return {!string}
-     */
-    getIndexEndName(): string;
-    /**
-     * @return {boolean}
-     */
-    hasLimit(): boolean;
-    /**
-     * @return {boolean} True if a limit has been set and it has been explicitly anchored
-     */
-    hasAnchoredLimit(): boolean;
-    /**
-     * Only valid to call if hasLimit() returns true
-     * @return {!number}
-     */
-    getLimit(): number;
-    /**
-     * @return {!Index}
-     */
-    getIndex(): Index;
-    /**
-     * @return {!QueryParams}
-     * @private
-     */
-    private copy_;
-    /**
-     * @param {!number} newLimit
-     * @return {!QueryParams}
-     */
-    limit(newLimit: number): QueryParams;
-    /**
-     * @param {!number} newLimit
-     * @return {!QueryParams}
-     */
-    limitToFirst(newLimit: number): QueryParams;
-    /**
-     * @param {!number} newLimit
-     * @return {!QueryParams}
-     */
-    limitToLast(newLimit: number): QueryParams;
-    /**
-     * @param {*} indexValue
-     * @param {?string=} key
-     * @return {!QueryParams}
-     */
-    startAt(indexValue: unknown, key?: string | null): QueryParams;
-    startAfter(indexValue: unknown, key?: string | null): QueryParams;
-    /**
-     * @param {*} indexValue
-     * @param {?string=} key
-     * @return {!QueryParams}
-     */
-    endAt(indexValue: unknown, key?: string | null): QueryParams;
-    endBefore(indexValue: unknown, key?: string | null): QueryParams;
-    /**
-     * @param {!Index} index
-     * @return {!QueryParams}
-     */
-    orderBy(index: Index): QueryParams;
-    /**
-     * @return {!Object}
-     */
-    getQueryObject(): {};
-    /**
-     * @return {boolean}
-     */
-    loadsAllData(): boolean;
-    /**
-     * @return {boolean}
-     */
-    isDefault(): boolean;
-    /**
-     * @return {!NodeFilter}
-     */
-    getNodeFilter(): NodeFilter;
-    /**
-     * Returns a set of REST query string parameters representing this query.
-     *
-     * @return {!Object.<string,*>} query string parameters
-     */
-    toRestQueryStringParameters(): {
-        [k: string]: string | number;
-    };
-}

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

@@ -1,97 +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 { ViewCache } from './ViewCache';
-import { Operation } from '../operation/Operation';
-import { Change } from './Change';
-import { Query } from '../../api/Query';
-import { EventRegistration } from './EventRegistration';
-import { Node } from '../snap/Node';
-import { Path } from '../util/Path';
-import { WriteTreeRef } from '../WriteTree';
-import { Event } from './Event';
-/**
- * A view represents a specific location and query that has 1 or more event registrations.
- *
- * It does several things:
- *  - Maintains the list of event registrations for this location/query.
- *  - Maintains a cache of the data visible for this location/query.
- *  - Applies new operations (via applyOperation), updates the cache, and based on the event
- *    registrations returns the set of events to be raised.
- * @constructor
- */
-export declare class View {
-    private query_;
-    private processor_;
-    private viewCache_;
-    private eventRegistrations_;
-    private eventGenerator_;
-    /**
-     *
-     * @param {!Query} query_
-     * @param {!ViewCache} initialViewCache
-     */
-    constructor(query_: Query, initialViewCache: ViewCache);
-    /**
-     * @return {!Query}
-     */
-    getQuery(): Query;
-    /**
-     * @return {?Node}
-     */
-    getServerCache(): Node | null;
-    /**
-     * @param {!Path} path
-     * @return {?Node}
-     */
-    getCompleteServerCache(path: Path): Node | null;
-    /**
-     * @return {boolean}
-     */
-    isEmpty(): boolean;
-    /**
-     * @param {!EventRegistration} eventRegistration
-     */
-    addEventRegistration(eventRegistration: EventRegistration): void;
-    /**
-     * @param {?EventRegistration} eventRegistration If null, remove all callbacks.
-     * @param {Error=} cancelError If a cancelError is provided, appropriate cancel events will be returned.
-     * @return {!Array.<!Event>} Cancel events, if cancelError was provided.
-     */
-    removeEventRegistration(eventRegistration: EventRegistration | null, cancelError?: Error): Event[];
-    /**
-     * Applies the given Operation, updates our cache, and returns the appropriate events.
-     *
-     * @param {!Operation} operation
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} completeServerCache
-     * @return {!Array.<!Event>}
-     */
-    applyOperation(operation: Operation, writesCache: WriteTreeRef, completeServerCache: Node | null): Event[];
-    /**
-     * @param {!EventRegistration} registration
-     * @return {!Array.<!Event>}
-     */
-    getInitialEvents(registration: EventRegistration): Event[];
-    /**
-     * @private
-     * @param {!Array.<!Change>} changes
-     * @param {!Node} eventCache
-     * @param {EventRegistration=} eventRegistration
-     * @return {!Array.<!Event>}
-     */
-    generateEventsForChanges_(changes: Change[], eventCache: Node, eventRegistration?: EventRegistration): Event[];
-}

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

@@ -1,70 +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 { CacheNode } from './CacheNode';
-import { Node } from '../snap/Node';
-/**
- * Stores the data we have cached for a view.
- *
- * serverSnap is the cached server data, eventSnap is the cached event data (server data plus any local writes).
- *
- * @constructor
- */
-export declare class ViewCache {
-    private readonly eventCache_;
-    private readonly serverCache_;
-    /**
-     *
-     * @param {!CacheNode} eventCache_
-     * @param {!CacheNode} serverCache_
-     */
-    constructor(eventCache_: CacheNode, serverCache_: CacheNode);
-    /**
-     * @const
-     * @type {ViewCache}
-     */
-    static Empty: ViewCache;
-    /**
-     * @param {!Node} eventSnap
-     * @param {boolean} complete
-     * @param {boolean} filtered
-     * @return {!ViewCache}
-     */
-    updateEventSnap(eventSnap: Node, complete: boolean, filtered: boolean): ViewCache;
-    /**
-     * @param {!Node} serverSnap
-     * @param {boolean} complete
-     * @param {boolean} filtered
-     * @return {!ViewCache}
-     */
-    updateServerSnap(serverSnap: Node, complete: boolean, filtered: boolean): ViewCache;
-    /**
-     * @return {!CacheNode}
-     */
-    getEventCache(): CacheNode;
-    /**
-     * @return {?Node}
-     */
-    getCompleteEventSnap(): Node | null;
-    /**
-     * @return {!CacheNode}
-     */
-    getServerCache(): CacheNode;
-    /**
-     * @return {?Node}
-     */
-    getCompleteServerSnap(): Node | null;
-}

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

@@ -1,166 +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 { Operation } from '../operation/Operation';
-import { ChildChangeAccumulator } from './ChildChangeAccumulator';
-import { Change } from './Change';
-import { Path } from '../util/Path';
-import { ViewCache } from './ViewCache';
-import { NodeFilter } from './filter/NodeFilter';
-import { WriteTreeRef } from '../WriteTree';
-import { Node } from '../snap/Node';
-/**
- * @constructor
- * @struct
- */
-export declare class ProcessorResult {
-    readonly viewCache: ViewCache;
-    readonly changes: Change[];
-    /**
-     * @param {!ViewCache} viewCache
-     * @param {!Array.<!Change>} changes
-     */
-    constructor(viewCache: ViewCache, changes: Change[]);
-}
-/**
- * @constructor
- */
-export declare class ViewProcessor {
-    private readonly filter_;
-    /**
-     * @param {!NodeFilter} filter_
-     */
-    constructor(filter_: NodeFilter);
-    /**
-     * @param {!ViewCache} viewCache
-     */
-    assertIndexed(viewCache: ViewCache): void;
-    /**
-     * @param {!ViewCache} oldViewCache
-     * @param {!Operation} operation
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} completeCache
-     * @return {!ProcessorResult}
-     */
-    applyOperation(oldViewCache: ViewCache, operation: Operation, writesCache: WriteTreeRef, completeCache: Node | null): ProcessorResult;
-    /**
-     * @param {!ViewCache} oldViewCache
-     * @param {!ViewCache} newViewCache
-     * @param {!Array.<!Change>} accumulator
-     * @private
-     */
-    private static maybeAddValueEvent_;
-    /**
-     * @param {!ViewCache} viewCache
-     * @param {!Path} changePath
-     * @param {!WriteTreeRef} writesCache
-     * @param {!CompleteChildSource} source
-     * @param {!ChildChangeAccumulator} accumulator
-     * @return {!ViewCache}
-     * @private
-     */
-    private generateEventCacheAfterServerEvent_;
-    /**
-     * @param {!ViewCache} oldViewCache
-     * @param {!Path} changePath
-     * @param {!Node} changedSnap
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} completeCache
-     * @param {boolean} filterServerNode
-     * @param {!ChildChangeAccumulator} accumulator
-     * @return {!ViewCache}
-     * @private
-     */
-    applyServerOverwrite_(oldViewCache: ViewCache, changePath: Path, changedSnap: Node, writesCache: WriteTreeRef, completeCache: Node | null, filterServerNode: boolean, accumulator: ChildChangeAccumulator): ViewCache;
-    /**
-     * @param {!ViewCache} oldViewCache
-     * @param {!Path} changePath
-     * @param {!Node} changedSnap
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} completeCache
-     * @param {!ChildChangeAccumulator} accumulator
-     * @return {!ViewCache}
-     * @private
-     */
-    applyUserOverwrite_(oldViewCache: ViewCache, changePath: Path, changedSnap: Node, writesCache: WriteTreeRef, completeCache: Node | null, accumulator: ChildChangeAccumulator): ViewCache;
-    /**
-     * @param {!ViewCache} viewCache
-     * @param {string} childKey
-     * @return {boolean}
-     * @private
-     */
-    private static cacheHasChild_;
-    /**
-     * @param {!ViewCache} viewCache
-     * @param {!Path} path
-     * @param {ImmutableTree.<!Node>} changedChildren
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} serverCache
-     * @param {!ChildChangeAccumulator} accumulator
-     * @return {!ViewCache}
-     * @private
-     */
-    private applyUserMerge_;
-    /**
-     * @param {!Node} node
-     * @param {ImmutableTree.<!Node>} merge
-     * @return {!Node}
-     * @private
-     */
-    private applyMerge_;
-    /**
-     * @param {!ViewCache} viewCache
-     * @param {!Path} path
-     * @param {!ImmutableTree.<!Node>} changedChildren
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} serverCache
-     * @param {boolean} filterServerNode
-     * @param {!ChildChangeAccumulator} accumulator
-     * @return {!ViewCache}
-     * @private
-     */
-    private applyServerMerge_;
-    /**
-     * @param {!ViewCache} viewCache
-     * @param {!Path} ackPath
-     * @param {!ImmutableTree<!boolean>} affectedTree
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} completeCache
-     * @param {!ChildChangeAccumulator} accumulator
-     * @return {!ViewCache}
-     * @private
-     */
-    private ackUserWrite_;
-    /**
-     * @param {!ViewCache} viewCache
-     * @param {!Path} path
-     * @param {!WriteTreeRef} writesCache
-     * @param {!ChildChangeAccumulator} accumulator
-     * @return {!ViewCache}
-     * @private
-     */
-    private listenComplete_;
-    /**
-     * @param {!ViewCache} viewCache
-     * @param {!Path} path
-     * @param {!WriteTreeRef} writesCache
-     * @param {?Node} completeServerCache
-     * @param {!ChildChangeAccumulator} accumulator
-     * @return {!ViewCache}
-     * @private
-     */
-    private revertUserWrite_;
-}

package/dist/exp/src/core/view/filter/IndexedFilter.d.ts

@@ -1,54 +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 { NodeFilter } from './NodeFilter';
-import { Index } from '../../snap/indexes/Index';
-import { Path } from '../../util/Path';
-import { CompleteChildSource } from '../CompleteChildSource';
-import { ChildChangeAccumulator } from '../ChildChangeAccumulator';
-import { Node } from '../../snap/Node';
-/**
- * Doesn't really filter nodes but applies an index to the node and keeps track of any changes
- *
- * @constructor
- * @implements {NodeFilter}
- * @param {!Index} index
- */
-export declare class IndexedFilter implements NodeFilter {
-    private readonly index_;
-    constructor(index_: Index);
-    updateChild(snap: Node, key: string, newChild: Node, affectedPath: Path, source: CompleteChildSource, optChangeAccumulator: ChildChangeAccumulator | null): Node;
-    /**
-     * @inheritDoc
-     */
-    updateFullNode(oldSnap: Node, newSnap: Node, optChangeAccumulator: ChildChangeAccumulator | null): Node;
-    /**
-     * @inheritDoc
-     */
-    updatePriority(oldSnap: Node, newPriority: Node): Node;
-    /**
-     * @inheritDoc
-     */
-    filtersNodes(): boolean;
-    /**
-     * @inheritDoc
-     */
-    getIndexedFilter(): IndexedFilter;
-    /**
-     * @inheritDoc
-     */
-    getIndex(): Index;
-}

package/dist/exp/src/core/view/filter/LimitedFilter.d.ts

@@ -1,94 +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 { NodeFilter } from './NodeFilter';
-import { Index } from '../../snap/indexes/Index';
-import { IndexedFilter } from './IndexedFilter';
-import { QueryParams } from '../QueryParams';
-import { Path } from '../../util/Path';
-import { CompleteChildSource } from '../CompleteChildSource';
-import { ChildChangeAccumulator } from '../ChildChangeAccumulator';
-/**
- * Applies a limit and a range to a node and uses RangedFilter to do the heavy lifting where possible
- *
- * @constructor
- * @implements {NodeFilter}
- */
-export declare class LimitedFilter implements NodeFilter {
-    /**
-     * @const
-     * @type {RangedFilter}
-     * @private
-     */
-    private readonly rangedFilter_;
-    /**
-     * @const
-     * @type {!Index}
-     * @private
-     */
-    private readonly index_;
-    /**
-     * @const
-     * @type {number}
-     * @private
-     */
-    private readonly limit_;
-    /**
-     * @const
-     * @type {boolean}
-     * @private
-     */
-    private readonly reverse_;
-    /**
-     * @param {!QueryParams} params
-     */
-    constructor(params: QueryParams);
-    /**
-     * @inheritDoc
-     */
-    updateChild(snap: Node, key: string, newChild: Node, affectedPath: Path, source: CompleteChildSource, optChangeAccumulator: ChildChangeAccumulator | null): Node;
-    /**
-     * @inheritDoc
-     */
-    updateFullNode(oldSnap: Node, newSnap: Node, optChangeAccumulator: ChildChangeAccumulator | null): Node;
-    /**
-     * @inheritDoc
-     */
-    updatePriority(oldSnap: Node, newPriority: Node): Node;
-    /**
-     * @inheritDoc
-     */
-    filtersNodes(): boolean;
-    /**
-     * @inheritDoc
-     */
-    getIndexedFilter(): IndexedFilter;
-    /**
-     * @inheritDoc
-     */
-    getIndex(): Index;
-    /**
-     * @param {!Node} snap
-     * @param {string} childKey
-     * @param {!Node} childSnap
-     * @param {!CompleteChildSource} source
-     * @param {?ChildChangeAccumulator} changeAccumulator
-     * @return {!Node}
-     * @private
-     */
-    private fullLimitUpdateChild_;
-}