@firebase/firestore 3.1.1 → 3.2.0

package/dist/lite/firestore/dist/lite/index.node.esm2017.d.ts

@@ -1,1195 +0,0 @@
-/**
- * @license
- * Copyright 2020 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 an array of bytes.
- */
-export class Bytes {
-    /**
-     * Creates a new `Bytes` object from the given Base64 string, converting it to
-     * bytes.
-     *
-     * @param base64 - The Base64 string used to create the `Bytes` object.
-     */
-    static fromBase64String(base64: any): Bytes;
-    /**
-     * Creates a new `Bytes` object from the given Uint8Array.
-     *
-     * @param array - The Uint8Array used to create the `Bytes` object.
-     */
-    static fromUint8Array(array: any): Bytes;
-    /** @hideconstructor */
-    constructor(byteString: any);
-    _byteString: any;
-    /**
-     * Returns the underlying bytes as a Base64-encoded string.
-     *
-     * @returns The Base64-encoded string created from the `Bytes` object.
-     */
-    toBase64(): any;
-    /**
-     * Returns the underlying bytes in a new `Uint8Array`.
-     *
-     * @returns The Uint8Array created from the `Bytes` object.
-     */
-    toUint8Array(): any;
-    /**
-     * Returns a string representation of the `Bytes` object.
-     *
-     * @returns A string representation of the `Bytes` object.
-     */
-    toString(): string;
-    /**
-     * Returns true if this `Bytes` object is equal to the provided one.
-     *
-     * @param other - The `Bytes` object to compare against.
-     * @returns true if this `Bytes` object is equal to the provided one.
-     */
-    isEqual(other: any): any;
-}
-/**
- * A `CollectionReference` object can be used for adding documents, getting
- * document references, and querying for documents (using {@link query}).
- */
-export class CollectionReference extends Query {
-    _path: any;
-    /** The collection's identifier. */
-    get id(): any;
-    /**
-     * A string representing the path of the referenced collection (relative
-     * to the root of the database).
-     */
-    get path(): any;
-    /**
-     * A reference to the containing `DocumentReference` if this is a
-     * subcollection. If this isn't a subcollection, the reference is null.
-     */
-    get parent(): DocumentReference | null;
-}
-/**
- * @license
- * Copyright 2020 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.
- */
-/**
- * A `DocumentReference` refers to a document location in a Firestore database
- * and can be used to write, read, or listen to the location. The document at
- * the referenced location may or may not exist.
- */
-export class DocumentReference {
-    /** @hideconstructor */
-    constructor(firestore: any, converter: any, _key: any);
-    converter: any;
-    _key: any;
-    /** The type of this Firestore reference. */
-    type: string;
-    firestore: any;
-    get _path(): any;
-    /**
-     * The document's identifier within its collection.
-     */
-    get id(): any;
-    /**
-     * A string representing the path of the referenced document (relative
-     * to the root of the database).
-     */
-    get path(): any;
-    /**
-     * The collection this `DocumentReference` belongs to.
-     */
-    get parent(): CollectionReference;
-    withConverter(converter: any): DocumentReference;
-}
-/**
- * @license
- * Copyright 2020 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.
- */
-/**
- * A `DocumentSnapshot` contains data read from a document in your Firestore
- * database. The data can be extracted with `.data()` or `.get(<field>)` to
- * get a specific field.
- *
- * For a `DocumentSnapshot` that points to a non-existing document, any data
- * access will return 'undefined'. You can use the `exists()` method to
- * explicitly verify a document's existence.
- */
-export class DocumentSnapshot {
-    /** @hideconstructor protected */
-    constructor(_firestore: any, _userDataWriter: any, _key: any, _document: any, _converter: any);
-    _firestore: any;
-    _userDataWriter: any;
-    _key: any;
-    _document: any;
-    _converter: any;
-    /** Property of the `DocumentSnapshot` that provides the document's ID. */
-    get id(): any;
-    /**
-     * The `DocumentReference` for the document included in the `DocumentSnapshot`.
-     */
-    get ref(): DocumentReference;
-    /**
-     * Signals whether or not the document at the snapshot's location exists.
-     *
-     * @returns true if the document exists.
-     */
-    exists(): boolean;
-    /**
-     * Retrieves all fields in the document as an `Object`. Returns `undefined` if
-     * the document doesn't exist.
-     *
-     * @returns An `Object` containing all fields in the document or `undefined`
-     * if the document doesn't exist.
-     */
-    data(): any;
-    /**
-     * Retrieves the field specified by `fieldPath`. Returns `undefined` if the
-     * document or field doesn't exist.
-     *
-     * @param fieldPath - The path (for example 'foo' or 'foo.bar') to a specific
-     * field.
-     * @returns The data at the specified field location or undefined if no such
-     * field exists in the document.
-     */
-    get(fieldPath: any): any;
-}
-/**
- * @license
- * Copyright 2020 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.
- */
-/**
- * A `FieldPath` refers to a field in a document. The path may consist of a
- * single field name (referring to a top-level field in the document), or a
- * list of field names (referring to a nested field in the document).
- *
- * Create a `FieldPath` by providing field names. If more than one field
- * name is provided, the path will point to a nested field in a document.
- */
-export class FieldPath {
-    /**
-     * Creates a `FieldPath` from the provided field names. If more than one field
-     * name is provided, the path will point to a nested field in a document.
-     *
-     * @param fieldNames - A list of field names.
-     */
-    constructor(...fieldNames: any[]);
-    _internalPath: FieldPath$1;
-    /**
-     * Returns true if this `FieldPath` is equal to the provided one.
-     *
-     * @param other - The `FieldPath` to compare against.
-     * @returns true if this `FieldPath` is equal to the provided one.
-     */
-    isEqual(other: any): boolean;
-}
-/**
- * @license
- * Copyright 2020 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.
- */
-/**
- * Sentinel values that can be used when writing document fields with `set()`
- * or `update()`.
- */
-export class FieldValue {
-    /**
-     * @param _methodName - The public API endpoint that returns this class.
-     * @hideconstructor
-     */
-    constructor(_methodName: any);
-    _methodName: any;
-}
-/**
- * @license
- * Copyright 2020 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 Cloud Firestore service interface.
- *
- * Do not call this constructor directly. Instead, use {@link getFirestore}.
- */
-export class Firestore {
-    /** @hideconstructor */
-    constructor(databaseIdOrApp: any, _credentials: any);
-    _credentials: any;
-    /**
-     * Whether it's a Firestore or Firestore Lite instance.
-     */
-    type: string;
-    _persistenceKey: string;
-    _settings: FirestoreSettingsImpl;
-    _settingsFrozen: boolean;
-    _databaseId: DatabaseId;
-    _app: any;
-    /**
-     * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
-     * instance.
-     */
-    get app(): any;
-    get _initialized(): boolean;
-    get _terminated(): boolean;
-    _setSettings(settings: any): void;
-    _getSettings(): FirestoreSettingsImpl;
-    _freezeSettings(): FirestoreSettingsImpl;
-    _delete(): Promise<void>;
-    _terminateTask: Promise<void> | undefined;
-    /** Returns a JSON-serializable representation of this `Firestore` instance. */
-    toJSON(): {
-        app: any;
-        databaseId: DatabaseId;
-        settings: FirestoreSettingsImpl;
-    };
-    /**
-     * Terminates all components used by this client. Subclasses can override
-     * this method to clean up their own dependencies, but must also call this
-     * method.
-     *
-     * Only ever called once.
-     */
-    _terminate(): Promise<void>;
-}
-/** An error returned by a Firestore operation. */
-export class FirestoreError extends Error {
-    /** @hideconstructor */
-    constructor(code: any, message: any);
-    code: any;
-}
-/**
- * @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 geographic location in Firestore. The
- * location is represented as latitude/longitude pair.
- *
- * Latitude values are in the range of [-90, 90].
- * Longitude values are in the range of [-180, 180].
- */
-export class GeoPoint {
-    /**
-     * Creates a new immutable `GeoPoint` object with the provided latitude and
-     * longitude values.
-     * @param latitude - The latitude as number between -90 and 90.
-     * @param longitude - The longitude as number between -180 and 180.
-     */
-    constructor(latitude: any, longitude: any);
-    _lat: any;
-    _long: any;
-    /**
-     * The latitude of this `GeoPoint` instance.
-     */
-    get latitude(): any;
-    /**
-     * The longitude of this `GeoPoint` instance.
-     */
-    get longitude(): any;
-    /**
-     * Returns true if this `GeoPoint` is equal to the provided one.
-     *
-     * @param other - The `GeoPoint` to compare against.
-     * @returns true if this `GeoPoint` is equal to the provided one.
-     */
-    isEqual(other: any): boolean;
-    /** Returns a JSON-serializable representation of this GeoPoint. */
-    toJSON(): {
-        latitude: any;
-        longitude: any;
-    };
-    /**
-     * Actually private to JS consumers of our API, so this function is prefixed
-     * with an underscore.
-     */
-    _compareTo(other: any): 0 | 1 | -1;
-}
-/**
- * A `Query` refers to a query which you can read or listen to. You can also
- * construct refined `Query` objects by adding filters and ordering.
- */
-export class Query {
-    /** @hideconstructor protected */
-    constructor(firestore: any, converter: any, _query: any);
-    converter: any;
-    _query: any;
-    /** The type of this Firestore reference. */
-    type: string;
-    firestore: any;
-    withConverter(converter: any): Query;
-}
-/**
- * A `QueryConstraint` is used to narrow the set of documents returned by a
- * Firestore query. `QueryConstraint`s are created by invoking {@link where},
- * {@link orderBy}, {@link (startAt:1)}, {@link (startAfter:1)}, {@link
- * endBefore:1}, {@link (endAt:1)}, {@link limit} or {@link limitToLast} and
- * can then be passed to {@link query} to create a new query instance that
- * also contains this `QueryConstraint`.
- */
-export class QueryConstraint {
-}
-/**
- * A `QueryDocumentSnapshot` contains data read from a document in your
- * Firestore database as part of a query. The document is guaranteed to exist
- * and its data can be extracted with `.data()` or `.get(<field>)` to get a
- * specific field.
- *
- * A `QueryDocumentSnapshot` offers the same API surface as a
- * `DocumentSnapshot`. Since query results contain only existing documents, the
- * `exists` property will always be true and `data()` will never return
- * 'undefined'.
- */
-export class QueryDocumentSnapshot extends DocumentSnapshot {
-}
-/**
- * A `QuerySnapshot` contains zero or more `DocumentSnapshot` objects
- * representing the results of a query. The documents can be accessed as an
- * array via the `docs` property or enumerated using the `forEach` method. The
- * number of documents can be determined via the `empty` and `size`
- * properties.
- */
-export class QuerySnapshot {
-    /** @hideconstructor */
-    constructor(_query: any, _docs: any);
-    _docs: any;
-    query: any;
-    /** An array of all the documents in the `QuerySnapshot`. */
-    get docs(): any[];
-    /** The number of documents in the `QuerySnapshot`. */
-    get size(): number;
-    /** True if there are no documents in the `QuerySnapshot`. */
-    get empty(): boolean;
-    /**
-     * Enumerates all of the documents in the `QuerySnapshot`.
-     *
-     * @param callback - A callback to be called with a `QueryDocumentSnapshot` for
-     * each document in the snapshot.
-     * @param thisArg - The `this` binding for the callback.
-     */
-    forEach(callback: any, thisArg: any): void;
-}
-/**
- * A `Timestamp` represents a point in time independent of any time zone or
- * calendar, represented as seconds and fractions of seconds at nanosecond
- * resolution in UTC Epoch time.
- *
- * It is encoded using the Proleptic Gregorian Calendar which extends the
- * Gregorian calendar backwards to year one. It is encoded assuming all minutes
- * are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second
- * table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to
- * 9999-12-31T23:59:59.999999999Z.
- *
- * For examples and further specifications, refer to the
- * {@link https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto | Timestamp definition}.
- */
-export class Timestamp {
-    /**
-     * Creates a new timestamp with the current date, with millisecond precision.
-     *
-     * @returns a new timestamp representing the current date.
-     */
-    static now(): Timestamp;
-    /**
-     * Creates a new timestamp from the given date.
-     *
-     * @param date - The date to initialize the `Timestamp` from.
-     * @returns A new `Timestamp` representing the same point in time as the given
-     *     date.
-     */
-    static fromDate(date: any): Timestamp;
-    /**
-     * Creates a new timestamp from the given number of milliseconds.
-     *
-     * @param milliseconds - Number of milliseconds since Unix epoch
-     *     1970-01-01T00:00:00Z.
-     * @returns A new `Timestamp` representing the same point in time as the given
-     *     number of milliseconds.
-     */
-    static fromMillis(milliseconds: any): Timestamp;
-    /**
-     * Creates a new timestamp.
-     *
-     * @param seconds - The number of seconds of UTC time since Unix epoch
-     *     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
-     *     9999-12-31T23:59:59Z inclusive.
-     * @param nanoseconds - The non-negative fractions of a second at nanosecond
-     *     resolution. Negative second values with fractions must still have
-     *     non-negative nanoseconds values that count forward in time. Must be
-     *     from 0 to 999,999,999 inclusive.
-     */
-    constructor(seconds: any, nanoseconds: any);
-    seconds: any;
-    nanoseconds: any;
-    /**
-     * Converts a `Timestamp` to a JavaScript `Date` object. This conversion
-     * causes a loss of precision since `Date` objects only support millisecond
-     * precision.
-     *
-     * @returns JavaScript `Date` object representing the same point in time as
-     *     this `Timestamp`, with millisecond precision.
-     */
-    toDate(): Date;
-    /**
-     * Converts a `Timestamp` to a numeric timestamp (in milliseconds since
-     * epoch). This operation causes a loss of precision.
-     *
-     * @returns The point in time corresponding to this timestamp, represented as
-     *     the number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.
-     */
-    toMillis(): number;
-    _compareTo(other: any): 0 | 1 | -1;
-    /**
-     * Returns true if this `Timestamp` is equal to the provided one.
-     *
-     * @param other - The `Timestamp` to compare against.
-     * @returns true if this `Timestamp` is equal to the provided one.
-     */
-    isEqual(other: any): boolean;
-    /** Returns a textual representation of this `Timestamp`. */
-    toString(): string;
-    /** Returns a JSON-serializable representation of this `Timestamp`. */
-    toJSON(): {
-        seconds: any;
-        nanoseconds: any;
-    };
-    /**
-     * Converts this object to a primitive string, which allows `Timestamp` objects
-     * to be compared using the `>`, `<=`, `>=` and `>` operators.
-     */
-    valueOf(): string;
-}
-/**
- * @license
- * Copyright 2020 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.
- */
-/**
- * A reference to a transaction.
- *
- * The `Transaction` object passed to a transaction's `updateFunction` provides
- * the methods to read and write data within the transaction context. See
- * {@link runTransaction}.
- */
-export class Transaction {
-    /** @hideconstructor */
-    constructor(_firestore: any, _transaction: any);
-    _firestore: any;
-    _transaction: any;
-    _dataReader: UserDataReader;
-    /**
-     * Reads the document referenced by the provided {@link DocumentReference}.
-     *
-     * @param documentRef - A reference to the document to be read.
-     * @returns A `DocumentSnapshot` with the read data.
-     */
-    get(documentRef: any): any;
-    set(documentRef: any, value: any, options: any): Transaction;
-    update(documentRef: any, fieldOrUpdateData: any, value: any, ...moreFieldsAndValues: any[]): Transaction;
-    /**
-     * Deletes the document referred to by the provided {@link DocumentReference}.
-     *
-     * @param documentRef - A reference to the document to be deleted.
-     * @returns This `Transaction` instance. Used for chaining method calls.
-     */
-    delete(documentRef: any): Transaction;
-}
-/**
- * @license
- * Copyright 2020 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.
- */
-/**
- * A write batch, used to perform multiple writes as a single atomic unit.
- *
- * A `WriteBatch` object can be acquired by calling {@link writeBatch}. It
- * provides methods for adding writes to the write batch. None of the writes
- * will be committed (or visible locally) until {@link WriteBatch.commit} is
- * called.
- */
-export class WriteBatch {
-    /** @hideconstructor */
-    constructor(_firestore: any, _commitHandler: any);
-    _firestore: any;
-    _commitHandler: any;
-    _mutations: any[];
-    _committed: boolean;
-    _dataReader: UserDataReader;
-    set(documentRef: any, data: any, options: any): WriteBatch;
-    update(documentRef: any, fieldOrUpdateData: any, value: any, ...moreFieldsAndValues: any[]): WriteBatch;
-    /**
-     * Deletes the document referred to by the provided {@link DocumentReference}.
-     *
-     * @param documentRef - A reference to the document to be deleted.
-     * @returns This `WriteBatch` instance. Used for chaining method calls.
-     */
-    delete(documentRef: any): WriteBatch;
-    /**
-     * Commits all of the writes in this write batch as a single atomic unit.
-     *
-     * The result of these writes will only be reflected in document reads that
-     * occur after the returned promise resolves. If the client is offline, the
-     * write fails. If you would like to see local modifications or buffer writes
-     * until the client is online, use the full Firestore SDK.
-     *
-     * @returns A `Promise` resolved once all of the writes in the batch have been
-     * successfully written to the backend as an atomic unit (note that it won't
-     * resolve while you're offline).
-     */
-    commit(): any;
-    _verifyNotCommitted(): void;
-}
-/**
- * Add a new document to specified `CollectionReference` with the given data,
- * assigning it a document ID automatically.
- *
- * The result of this write will only be reflected in document reads that occur
- * after the returned promise resolves. If the client is offline, the
- * write fails. If you would like to see local modifications or buffer writes
- * until the client is online, use the full Firestore SDK.
- *
- * @param reference - A reference to the collection to add this document to.
- * @param data - An Object containing the data for the new document.
- * @returns A `Promise` resolved with a `DocumentReference` pointing to the
- * newly created document after it has been written to the backend.
- */
-export function addDoc(reference: any, data: any): Promise<DocumentReference>;
-/**
- * Returns a special value that can be used with {@link (setDoc:1)} or {@link
- * updateDoc:1} that tells the server to remove the given elements from any
- * array value that already exists on the server. All instances of each element
- * specified will be removed from the array. If the field being modified is not
- * already an array it will be overwritten with an empty array.
- *
- * @param elements - The elements to remove from the array.
- * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
- * `updateDoc()`
- */
-export function arrayRemove(...elements: any[]): ArrayRemoveFieldValueImpl;
-/**
- * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
- * @firebase/firestore/lite#(updateDoc:1)} that tells the server to union the given elements with any array
- * value that already exists on the server. Each specified element that doesn't
- * already exist in the array will be added to the end. If the field being
- * modified is not already an array it will be overwritten with an array
- * containing exactly the specified elements.
- *
- * @param elements - The elements to union into the array.
- * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
- * `updateDoc()`.
- */
-export function arrayUnion(...elements: any[]): ArrayUnionFieldValueImpl;
-export function collection(parent: any, path: any, ...pathSegments: any[]): CollectionReference;
-/**
- * Creates and returns a new `Query` instance that includes all documents in the
- * database that are contained in a collection or subcollection with the
- * given `collectionId`.
- *
- * @param firestore - A reference to the root `Firestore` instance.
- * @param collectionId - Identifies the collections to query over. Every
- * collection or subcollection with this ID as the last segment of its path
- * will be included. Cannot contain a slash.
- * @returns The created `Query`.
- */
-export function collectionGroup(firestore: any, collectionId: any): Query;
-/**
- * Modify this instance to communicate with the Cloud Firestore emulator.
- *
- * Note: This must be called before this instance has been used to do any
- * operations.
- *
- * @param firestore - The `Firestore` instance to configure to connect to the
- * emulator.
- * @param host - the emulator host (ex: localhost).
- * @param port - the emulator port (ex: 9000).
- * @param options.mockUserToken - the mock auth token to use for unit testing
- * Security Rules.
- */
-export function connectFirestoreEmulator(firestore: any, host: any, port: any, options?: {}): void;
-/**
- * Deletes the document referred to by the specified `DocumentReference`.
- *
- * The deletion will only be reflected in document reads that occur after the
- * returned promise resolves. If the client is offline, the
- * delete fails. If you would like to see local modifications or buffer writes
- * until the client is online, use the full Firestore SDK.
- *
- * @param reference - A reference to the document to delete.
- * @returns A `Promise` resolved once the document has been successfully
- * deleted from the backend.
- */
-export function deleteDoc(reference: any): Promise<void>;
-/**
- * @license
- * Copyright 2020 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.
- */
-/**
- * Returns a sentinel for use with {@link @firebase/firestore/lite#(updateDoc:1)} or
- * {@link @firebase/firestore/lite#(setDoc:1)} with `{merge: true}` to mark a field for deletion.
- */
-export function deleteField(): DeleteFieldValueImpl;
-export function doc(parent: any, path: any, ...pathSegments: any[]): DocumentReference;
-/**
- * Returns a special sentinel `FieldPath` to refer to the ID of a document.
- * It can be used in queries to sort or filter by the document ID.
- */
-export function documentId(): FieldPath;
-export function endAt(...docOrFields: any[]): QueryEndAtConstraint;
-export function endBefore(...docOrFields: any[]): QueryEndAtConstraint;
-/**
- * Reads the document referred to by the specified document reference.
- *
- * All documents are directly fetched from the server, even if the document was
- * previously read or modified. Recent modifications are only reflected in the
- * retrieved `DocumentSnapshot` if they have already been applied by the
- * backend. If the client is offline, the read fails. If you like to use
- * caching or see local modifications, please use the full Firestore SDK.
- *
- * @param reference - The reference of the document to fetch.
- * @returns A Promise resolved with a `DocumentSnapshot` containing the current
- * document contents.
- */
-export function getDoc(reference: any): Promise<DocumentSnapshot>;
-/**
- * Executes the query and returns the results as a {@link QuerySnapshot}.
- *
- * All queries are executed directly by the server, even if the the query was
- * previously executed. Recent modifications are only reflected in the retrieved
- * results if they have already been applied by the backend. If the client is
- * offline, the operation fails. To see previously cached result and local
- * modifications, use the full Firestore SDK.
- *
- * @param query - The `Query` to execute.
- * @returns A Promise that will be resolved with the results of the query.
- */
-export function getDocs(query: any): Promise<QuerySnapshot>;
-/**
- * Returns the existing `Firestore` instance that is associated with the
- * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
- * instance with default settings.
- *
- * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned `Firestore`
- * instance is associated with.
- * @returns The `Firestore` instance of the provided app.
- */
-export function getFirestore(app?: import("@firebase/app").FirebaseApp): import("../../lite").Firestore;
-/**
- * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
- * @firebase/firestore/lite#(updateDoc:1)} that tells the server to increment the field's current value by
- * the given value.
- *
- * If either the operand or the current field value uses floating point
- * precision, all arithmetic follows IEEE 754 semantics. If both values are
- * integers, values outside of JavaScript's safe number range
- * (`Number.MIN_SAFE_INTEGER` to `Number.MAX_SAFE_INTEGER`) are also subject to
- * precision loss. Furthermore, once processed by the Firestore backend, all
- * integer operations are capped between -2^63 and 2^63-1.
- *
- * If the current field value is not of type `number`, or if the field does not
- * yet exist, the transformation sets the field to the given value.
- *
- * @param n - The value to increment by.
- * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
- * `updateDoc()`
- */
-export function increment(n: any): NumericIncrementFieldValueImpl;
-/**
- * Initializes a new instance of Cloud Firestore with the provided settings.
- * Can only be called before any other functions, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
- *
- * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
- * be associated.
- * @param settings - A settings object to configure the `Firestore` instance.
- * @returns A newly initialized `Firestore` instance.
- */
-export function initializeFirestore(app: any, settings: any): import("../../lite").Firestore;
-/**
- * Creates a {@link QueryConstraint} that only returns the first matching documents.
- *
- * @param limit - The maximum number of items to return.
- * @returns The created {@link Query}.
- */
-export function limit(limit: any): QueryLimitConstraint;
-/**
- * Creates a {@link QueryConstraint} that only returns the last matching documents.
- *
- * You must specify at least one `orderBy` clause for `limitToLast` queries,
- * otherwise an exception will be thrown during execution.
- *
- * @param limit - The maximum number of items to return.
- * @returns The created {@link Query}.
- */
-export function limitToLast(limit: any): QueryLimitConstraint;
-/**
- * Creates a {@link QueryConstraint} that sorts the query result by the
- * specified field, optionally in descending order instead of ascending.
- *
- * @param fieldPath - The field to sort by.
- * @param directionStr - Optional direction to sort by ('asc' or 'desc'). If
- * not specified, order will be ascending.
- * @returns The created {@link Query}.
- */
-export function orderBy(fieldPath: any, directionStr?: string): QueryOrderByConstraint;
-/**
- * Creates a new immutable instance of {@link Query} that is extended to also include
- * additional query constraints.
- *
- * @param query - The {@link Query} instance to use as a base for the new constraints.
- * @param queryConstraints - The list of {@link QueryConstraint}s to apply.
- * @throws if any of the provided query constraints cannot be combined with the
- * existing or new constraints.
- */
-export function query(query: any, ...queryConstraints: any[]): any;
-/**
- * Returns true if the provided queries point to the same collection and apply
- * the same constraints.
- *
- * @param left - A `Query` to compare.
- * @param right - A `Query` to compare.
- * @returns true if the references point to the same location in the same
- * Firestore database.
- */
-export function queryEqual(left: any, right: any): boolean;
-/**
- * Returns true if the provided references are equal.
- *
- * @param left - A reference to compare.
- * @param right - A reference to compare.
- * @returns true if the references point to the same location in the same
- * Firestore database.
- */
-export function refEqual(left: any, right: any): boolean;
-/**
- * Executes the given `updateFunction` and then attempts to commit the changes
- * applied within the transaction. If any document read within the transaction
- * has changed, Cloud Firestore retries the `updateFunction`. If it fails to
- * commit after 5 attempts, the transaction fails.
- *
- * The maximum number of writes allowed in a single transaction is 500.
- *
- * @param firestore - A reference to the Firestore database to run this
- * transaction against.
- * @param updateFunction - The function to execute within the transaction
- * context.
- * @returns If the transaction completed successfully or was explicitly aborted
- * (the `updateFunction` returned a failed promise), the promise returned by the
- * `updateFunction `is returned here. Otherwise, if the transaction failed, a
- * rejected promise with the corresponding failure error is returned.
- */
-export function runTransaction(firestore: any, updateFunction: any): Promise<any>;
-/**
- * Returns a sentinel used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link @firebase/firestore/lite#(updateDoc:1)} to
- * include a server-generated timestamp in the written data.
- */
-export function serverTimestamp(): ServerTimestampFieldValueImpl;
-export function setDoc(reference: any, data: any, options: any): Promise<void>;
-/**
- * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).
- *
- * @param logLevel - The verbosity you set for activity and error logging. Can
- *   be any of the following values:
- *
- *   <ul>
- *     <li>`debug` for the most verbose logging level, primarily for
- *     debugging.</li>
- *     <li>`error` to log errors only.</li>
- *     <li><code>`silent` to turn off logging.</li>
- *   </ul>
- */
-export function setLogLevel(logLevel: any): void;
-/**
- * Returns true if the provided snapshots are equal.
- *
- * @param left - A snapshot to compare.
- * @param right - A snapshot to compare.
- * @returns true if the snapshots are equal.
- */
-export function snapshotEqual(left: any, right: any): any;
-export function startAfter(...docOrFields: any[]): QueryStartAtConstraint;
-export function startAt(...docOrFields: any[]): QueryStartAtConstraint;
-/**
- * Terminates the provided `Firestore` instance.
- *
- * After calling `terminate()` only the `clearIndexedDbPersistence()` functions
- * may be used. Any other function will throw a `FirestoreError`. Termination
- * does not cancel any pending writes, and any promises that are awaiting a
- * response from the server will not be resolved.
- *
- * To restart after termination, create a new instance of `Firestore` with
- * {@link getFirestore}.
- *
- * Note: Under normal circumstances, calling `terminate()` is not required. This
- * function is useful only when you want to force this instance to release all of
- * its resources or in combination with {@link clearIndexedDbPersistence} to
- * ensure that all local state is destroyed between test runs.
- *
- * @param firestore - The `Firestore` instance to terminate.
- * @returns A `Promise` that is resolved when the instance has been successfully
- * terminated.
- */
-export function terminate(firestore: any): any;
-export function updateDoc(reference: any, fieldOrUpdateData: any, value: any, ...moreFieldsAndValues: any[]): Promise<void>;
-/**
- * Creates a {@link QueryConstraint} that enforces that documents must contain the
- * specified field and that the value should satisfy the relation constraint
- * provided.
- *
- * @param fieldPath - The path to compare
- * @param opStr - The operation string (e.g "&lt;", "&lt;=", "==", "&lt;",
- *   "&lt;=", "!=").
- * @param value - The value for comparison
- * @returns The created {@link Query}.
- */
-export function where(fieldPath: any, opStr: any, value: any): QueryFilterConstraint;
-/**
- * Creates a write batch, used for performing multiple writes as a single
- * atomic operation. The maximum number of writes allowed in a single WriteBatch
- * is 500.
- *
- * The result of these writes will only be reflected in document reads that
- * occur after the returned promise resolves. If the client is offline, the
- * write fails. If you would like to see local modifications or buffer writes
- * until the client is online, use the full Firestore SDK.
- *
- * @returns A `WriteBatch` that can be used to atomically execute multiple
- * writes.
- */
-export function writeBatch(firestore: any): WriteBatch;
-/**
- * A dot-separated path for navigating sub-objects within a document.
- * @internal
- */
-declare class FieldPath$1 extends BasePath {
-    /**
-     * Returns true if the string could be used as a segment in a field path
-     * without escaping.
-     */
-    static isValidIdentifier(segment: any): boolean;
-    /**
-     * The field designating the key of a document.
-     */
-    static keyField(): FieldPath$1;
-    /**
-     * Parses a field string from the given server-formatted string.
-     *
-     * - Splitting the empty string is not allowed (for now at least).
-     * - Empty segments within the string (e.g. if there are two consecutive
-     *   separators) are not allowed.
-     *
-     * TODO(b/37244157): we should make this more strict. Right now, it allows
-     * non-identifier path components, even if they aren't escaped.
-     */
-    static fromServerFormat(path: any): FieldPath$1;
-    static emptyPath(): FieldPath$1;
-    construct(segments: any, offset: any, length: any): FieldPath$1;
-    canonicalString(): any;
-    toString(): any;
-    /**
-     * Returns true if this field references the key of a document.
-     */
-    isKeyField(): boolean;
-}
-/**
- * A concrete type describing all the values that can be applied via a
- * user-supplied `FirestoreSettings` object. This is a separate type so that
- * defaults can be supplied and the value can be checked for equality.
- */
-declare class FirestoreSettingsImpl {
-    constructor(settings: any);
-    host: any;
-    ssl: any;
-    credentials: any;
-    ignoreUndefinedProperties: boolean;
-    cacheSizeBytes: any;
-    experimentalForceLongPolling: boolean;
-    experimentalAutoDetectLongPolling: boolean;
-    useFetchStreams: boolean;
-    isEqual(other: any): boolean;
-}
-/**
- * Represents the database ID a Firestore client is associated with.
- * @internal
- */
-declare class DatabaseId {
-    constructor(projectId: any, database: any);
-    projectId: any;
-    database: any;
-    get isDefaultDatabase(): boolean;
-    isEqual(other: any): boolean;
-}
-/**
- * Helper for parsing raw user input (provided via the API) into internal model
- * classes.
- */
-declare class UserDataReader {
-    constructor(databaseId: any, ignoreUndefinedProperties: any, serializer: any);
-    databaseId: any;
-    ignoreUndefinedProperties: any;
-    serializer: any;
-    /** Creates a new top-level parse context. */
-    createContext(dataSource: any, methodName: any, targetDoc: any, hasConverter?: boolean): ParseContextImpl;
-}
-declare class ArrayRemoveFieldValueImpl extends FieldValue {
-    constructor(methodName: any, _elements: any);
-    _elements: any;
-    _toFieldTransform(context: any): FieldTransform;
-    isEqual(other: any): boolean;
-}
-declare class ArrayUnionFieldValueImpl extends FieldValue {
-    constructor(methodName: any, _elements: any);
-    _elements: any;
-    _toFieldTransform(context: any): FieldTransform;
-    isEqual(other: any): boolean;
-}
-declare class DeleteFieldValueImpl extends FieldValue {
-    _toFieldTransform(context: any): null;
-    isEqual(other: any): boolean;
-}
-declare class QueryEndAtConstraint extends QueryConstraint {
-    constructor(type: any, _docOrFields: any, _before: any);
-    type: any;
-    _docOrFields: any;
-    _before: any;
-    _apply(query: any): Query;
-}
-declare class NumericIncrementFieldValueImpl extends FieldValue {
-    constructor(methodName: any, _operand: any);
-    _operand: any;
-    _toFieldTransform(context: any): FieldTransform;
-    isEqual(other: any): boolean;
-}
-declare class QueryLimitConstraint extends QueryConstraint {
-    constructor(type: any, _limit: any, _limitType: any);
-    type: any;
-    _limit: any;
-    _limitType: any;
-    _apply(query: any): Query;
-}
-declare class QueryOrderByConstraint extends QueryConstraint {
-    constructor(_field: any, _direction: any);
-    _field: any;
-    _direction: any;
-    type: string;
-    _apply(query: any): Query;
-}
-declare class ServerTimestampFieldValueImpl extends FieldValue {
-    _toFieldTransform(context: any): FieldTransform;
-    isEqual(other: any): boolean;
-}
-declare class QueryStartAtConstraint extends QueryConstraint {
-    constructor(type: any, _docOrFields: any, _before: any);
-    type: any;
-    _docOrFields: any;
-    _before: any;
-    _apply(query: any): Query;
-}
-declare class QueryFilterConstraint extends QueryConstraint {
-    constructor(_field: any, _op: any, _value: any);
-    _field: any;
-    _op: any;
-    _value: any;
-    type: string;
-    _apply(query: any): Query;
-}
-/**
- * Path represents an ordered sequence of string segments.
- */
-declare class BasePath {
-    static comparator(p1: any, p2: any): 0 | 1 | -1;
-    constructor(segments: any, offset: any, length: any);
-    segments: any;
-    offset: any;
-    len: any;
-    get length(): any;
-    isEqual(other: any): boolean;
-    child(nameOrPath: any): any;
-    /** The index of one past the last segment of the path. */
-    limit(): any;
-    popFirst(size: any): any;
-    popLast(): any;
-    firstSegment(): any;
-    lastSegment(): any;
-    get(index: any): any;
-    isEmpty(): boolean;
-    isPrefixOf(other: any): boolean;
-    isImmediateParentOf(potentialChild: any): boolean;
-    forEach(fn: any): void;
-    toArray(): any;
-}
-/** A "context" object passed around while parsing user data. */
-declare class ParseContextImpl {
-    /**
-     * Initializes a ParseContext with the given source and path.
-     *
-     * @param settings - The settings for the parser.
-     * @param databaseId - The database ID of the Firestore instance.
-     * @param serializer - The serializer to use to generate the Value proto.
-     * @param ignoreUndefinedProperties - Whether to ignore undefined properties
-     * rather than throw.
-     * @param fieldTransforms - A mutable list of field transforms encountered
-     * while parsing the data.
-     * @param fieldMask - A mutable list of field paths encountered while parsing
-     * the data.
-     *
-     * TODO(b/34871131): We don't support array paths right now, so path can be
-     * null to indicate the context represents any location within an array (in
-     * which case certain features will not work and errors will be somewhat
-     * compromised).
-     */
-    constructor(settings: any, databaseId: any, serializer: any, ignoreUndefinedProperties: any, fieldTransforms: any, fieldMask: any);
-    settings: any;
-    databaseId: any;
-    serializer: any;
-    ignoreUndefinedProperties: any;
-    fieldTransforms: any;
-    fieldMask: any;
-    get path(): any;
-    get dataSource(): any;
-    /** Returns a new context with the specified settings overwritten. */
-    contextWith(configuration: any): ParseContextImpl;
-    childContextForField(field: any): ParseContextImpl;
-    childContextForFieldPath(field: any): ParseContextImpl;
-    childContextForArray(index: any): ParseContextImpl;
-    createError(reason: any): FirestoreError;
-    /** Returns 'true' if 'fieldPath' was traversed when creating this context. */
-    contains(fieldPath: any): boolean;
-    validatePath(): void;
-    validatePathSegment(segment: any): void;
-}
-/**
- * @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.
- */
-/** A field path and the TransformOperation to perform upon it. */
-declare class FieldTransform {
-    constructor(field: any, transform: any);
-    field: any;
-    transform: any;
-}
-export {};