/// /** * `Firestore` represents a Firestore Database and is the entry point for all * Firestore operations. */ export type Firestore = ReturnType; /** * Cloud Firestore. * * @packageDocumentation */ export type FirebaseFirestore = typeof import('firebase-admin/firestore'); /** * Document data (for use with `DocumentReference.set()`) consists of fields * mapped to values. */ export type DocumentData = import('firebase-admin/firestore').DocumentData; /** * An options object that configures the behavior of `set()` calls in * `DocumentReference`, `WriteBatch` and `Transaction`. These calls can be * configured to perform granular merges instead of overwriting the target * documents in their entirety. * * @param merge Changes the behavior of a set() call to only replace the * values specified in its data argument. Fields omitted from the set() call * remain untouched. If your input sets any field to an empty map, all nested * fields are overwritten. * * @param mergeFields Changes the behavior of set() calls to only replace * the specified field paths. Any field path that is not specified is ignored * and remains untouched. If your input sets any field to an empty map, all * nested fields are overwritten. */ export type SetOptions = import('firebase-admin/firestore').SetOptions; /** * An unsubscribe function that can be called to cancel * the snapshot listener. */ export type Unsubscribe = ReturnType; /** * The type of of a `DocumentChange` may be 'added', 'removed', or 'modified'. */ export type DocumentChangeType = import('firebase-admin/firestore').DocumentChangeType; /** * The direction of a `Query.orderBy()` clause is specified as 'desc' or 'asc' * (descending or ascending). */ export type OrderByDirection = import('firebase-admin/firestore').OrderByDirection; /** * Filter conditions in a `Query.where()` clause are specified using the * strings '<', '<=', '==', '!=', '>=', '>', 'array-contains', 'in', 'not-in', * and 'array-contains-any'. */ export type WhereFilterOp = import('firebase-admin/firestore').WhereFilterOp; /** * An immutable object representing a geo point in Firestore. The geo point 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 type GeoPoint = FirebaseFirestore['GeoPoint']; /** * 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. * * @see https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto */ export type Timestamp = import('firebase-admin/firestore').Timestamp; /** * An options object that configures conditional behavior of `update()` and * `delete()` calls in `DocumentReference`, `WriteBatch`, and `Transaction`. * Using Preconditions, these calls can be restricted to only apply to * documents that match the specified restrictions. */ export type Precondition = import('firebase-admin/firestore').Precondition; /** * A WriteResult wraps the write time set by the Firestore servers on `sets()`, * `updates()`, and `creates()`. */ export type WriteResult = import('firebase-admin/firestore').WriteResult; /** * An options object that can be used to configure the behavior of `getAll()` * calls. By providing a `fieldMask`, these calls can be configured to only * return a subset of fields. */ export type ReadOption = import('firebase-admin/firestore').ReadOptions; /** Options to configure a read-only transaction. */ export type ReadOnlyTransactionOptions = import('firebase-admin/firestore').ReadOnlyTransactionOptions; /** Options to configure a read-write transaction. */ export type ReadWriteTransactionOptions = import('@google-cloud/firestore').ReadWriteTransactionOptions; /** * An immutable object representing an array of bytes. */ export declare class Bytes { private constructor(); /** * 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: string): Bytes; /** * Creates a new `Bytes` object from the given Uint8Array. * * @param array - The Uint8Array used to create the `Bytes` object. */ static fromUint8Array(array: Uint8Array): Bytes; /** * Returns the underlying bytes as a Base64-encoded string. * * @returns The Base64-encoded string created from the `Bytes` object. */ toBase64(): string; /** * Returns the underlying bytes in a new `Uint8Array`. * * @returns The Uint8Array created from the `Bytes` object. */ toUint8Array(): Uint8Array; /** * 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: Bytes): boolean; } export type OriDocumentReference = import('firebase-admin/firestore').DocumentReference; export type OriCollectionReference = import('firebase-admin/firestore').CollectionReference; export type OriQuery = import('firebase-admin/firestore').Query; export type OriQuerySnapshot = import('firebase-admin/firestore').QuerySnapshot; export type OriQueryDocumentSnapshot = import('firebase-admin/firestore').QueryDocumentSnapshot; export type OriDocumentSnapshot = import('firebase-admin/firestore').DocumentSnapshot; export type OriDocumentChange = import('firebase-admin/firestore').DocumentChange; export type OriFieldValue = import('firebase-admin/firestore').FieldValue; export type OriWriteBatch = import('firebase-admin/firestore').WriteBatch; export type OriTransaction = import('firebase-admin/firestore').Transaction;