@firebase/firestore-compat 0.4.0-20230301000120 → 0.4.0-20250715195345

package/dist/src/api/observer.d.ts

@@ -1,29 +1,29 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { FirestoreError } from '@firebase/firestore';
-/**
- * Observer/Subscribe interfaces.
- */
-export declare type NextFn<T> = (value: T) => void;
-export declare type ErrorFn = (error: FirestoreError) => void;
-export declare type CompleteFn = () => void;
-export interface PartialObserver<T> {
-    next?: NextFn<T>;
-    error?: ErrorFn;
-    complete?: CompleteFn;
-}
-export declare function isPartialObserver<T>(obj: unknown): obj is PartialObserver<T>;
+/**
+ * @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 { FirestoreError } from '@firebase/firestore';
+/**
+ * Observer/Subscribe interfaces.
+ */
+export type NextFn<T> = (value: T) => void;
+export type ErrorFn = (error: FirestoreError) => void;
+export type CompleteFn = () => void;
+export interface PartialObserver<T> {
+    next?: NextFn<T>;
+    error?: ErrorFn;
+    complete?: CompleteFn;
+}
+export declare function isPartialObserver<T>(obj: unknown): obj is PartialObserver<T>;

package/dist/src/api/timestamp.d.ts

@@ -1,17 +1,17 @@
-/**
- * @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.
- */
-export { Timestamp } from '@firebase/firestore';
+/**
+ * @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.
+ */
+export { Timestamp } from '@firebase/firestore';

package/dist/src/config.d.ts

@@ -1,28 +1,28 @@
-/**
- * @license
- * Copyright 2021 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 { FirebaseApp } from '@firebase/app-compat';
-import { FirebaseNamespace } from '@firebase/app-types';
-import { Firestore as ModularFirestore } from '@firebase/firestore';
-import { Firestore } from './api/database';
-/**
- * Configures Firestore as part of the Firebase SDK by calling registerComponent.
- *
- * @param firebase - The FirebaseNamespace to register Firestore with
- * @param firestoreFactory - A factory function that returns a new Firestore
- *    instance.
- */
-export declare function configureForFirebase(firebase: FirebaseNamespace, firestoreFactory: (app: FirebaseApp, firestoreExp: ModularFirestore) => Firestore): void;
+/**
+ * @license
+ * Copyright 2021 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 { FirebaseApp } from '@firebase/app-compat';
+import { FirebaseNamespace } from '@firebase/app-types';
+import { Firestore as ModularFirestore } from '@firebase/firestore';
+import { Firestore } from './api/database';
+/**
+ * Configures Firestore as part of the Firebase SDK by calling registerComponent.
+ *
+ * @param firebase - The FirebaseNamespace to register Firestore with
+ * @param firestoreFactory - A factory function that returns a new Firestore
+ *    instance.
+ */
+export declare function configureForFirebase(firebase: FirebaseNamespace, firestoreFactory: (app: FirebaseApp, firestoreExp: ModularFirestore) => Firestore): void;

package/dist/src/index.console.d.ts

@@ -1,48 +1,48 @@
-/**
- * @license
- * Copyright 2019 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 { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
-import { Provider } from '@firebase/component';
-import { Query as ExpQuery } from '@firebase/firestore';
-import { Compat } from '@firebase/util';
-import { Firestore as FirestoreCompat, PersistenceProvider } from './api/database';
-export { CollectionReference, DocumentReference, DocumentSnapshot, QuerySnapshot } from './api/database';
-export { Blob } from './api/blob';
-export { GeoPoint } from './api/geo_point';
-export { FieldPath } from './api/field_path';
-export { FieldValue } from './api/field_value';
-export { Timestamp } from './api/timestamp';
-export interface FirestoreDatabase {
-    projectId: string;
-    database?: string;
-}
-/**
- * The persistence provider included with the memory-only SDK. This provider
- * errors for all attempts to access persistence.
- */
-export declare class MemoryPersistenceProvider implements PersistenceProvider {
-    enableIndexedDbPersistence(firestore: FirestoreCompat, forceOwnership: boolean): Promise<void>;
-    enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
-    clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
-}
-/** Firestore class that exposes the constructor expected by the Console. */
-export declare class Firestore extends FirestoreCompat {
-    constructor(firestoreDatabase: FirestoreDatabase, authProvider: Provider<FirebaseAuthInternalName>);
-    INTERNAL: {
-        delete: () => Promise<void>;
-        count: (query: Compat<ExpQuery<unknown>>) => Promise<number>;
-    };
-}
+/**
+ * @license
+ * Copyright 2019 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 { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { Provider } from '@firebase/component';
+import { Query as ExpQuery } from '@firebase/firestore';
+import { Compat } from '@firebase/util';
+import { Firestore as FirestoreCompat, PersistenceProvider } from './api/database';
+export { CollectionReference, DocumentReference, DocumentSnapshot, QuerySnapshot } from './api/database';
+export { Blob } from './api/blob';
+export { GeoPoint } from './api/geo_point';
+export { FieldPath } from './api/field_path';
+export { FieldValue } from './api/field_value';
+export { Timestamp } from './api/timestamp';
+export interface FirestoreDatabase {
+    projectId: string;
+    database?: string;
+}
+/**
+ * The persistence provider included with the memory-only SDK. This provider
+ * errors for all attempts to access persistence.
+ */
+export declare class MemoryPersistenceProvider implements PersistenceProvider {
+    enableIndexedDbPersistence(firestore: FirestoreCompat, forceOwnership: boolean): Promise<void>;
+    enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
+    clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
+}
+/** Firestore class that exposes the constructor expected by the Console. */
+export declare class Firestore extends FirestoreCompat {
+    constructor(firestoreDatabase: FirestoreDatabase, authProvider: Provider<FirebaseAuthInternalName>);
+    INTERNAL: {
+        delete: () => Promise<void>;
+        count: (query: Compat<ExpQuery<unknown>>) => Promise<number>;
+    };
+}

package/dist/src/index.d.ts

@@ -1,126 +1,158 @@
-/**
- * @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.
- */
-import type { FirebaseNamespace } from '@firebase/app-types';
-import * as types from '@firebase/firestore-types';
-import './register-module';
-/**
- * Registers the main Firestore build with the components framework.
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
- */
-export declare function registerFirestore(instance: FirebaseNamespace): void;
-declare module '@firebase/app-compat' {
-    interface FirebaseNamespace {
-        firestore: {
-            (app?: FirebaseApp): types.FirebaseFirestore;
-            Blob: typeof types.Blob;
-            CollectionReference: typeof types.CollectionReference;
-            DocumentReference: typeof types.DocumentReference;
-            DocumentSnapshot: typeof types.DocumentSnapshot;
-            FieldPath: typeof types.FieldPath;
-            FieldValue: typeof types.FieldValue;
-            Firestore: typeof types.FirebaseFirestore;
-            GeoPoint: typeof types.GeoPoint;
-            Query: typeof types.Query;
-            QueryDocumentSnapshot: typeof types.QueryDocumentSnapshot;
-            QuerySnapshot: typeof types.QuerySnapshot;
-            Timestamp: typeof types.Timestamp;
-            Transaction: typeof types.Transaction;
-            WriteBatch: typeof types.WriteBatch;
-            setLogLevel: typeof types.setLogLevel;
-        };
-    }
-    interface FirebaseApp {
-        firestore?(): types.FirebaseFirestore;
-    }
-}
+/**
+ * @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.
+ */
+import type { FirebaseNamespace } from '@firebase/app-types';
+import * as types from '@firebase/firestore-types';
+import './register-module';
+/**
+ * Registers the main Firestore build with the components framework.
+ * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
+ */
+export declare function registerFirestore(instance: FirebaseNamespace): void;
+declare module '@firebase/app-compat' {
+    interface FirebaseNamespace {
+        firestore: {
+            (app?: FirebaseApp): types.FirebaseFirestore;
+            Blob: typeof types.Blob;
+            CollectionReference: typeof types.CollectionReference;
+            DocumentReference: typeof types.DocumentReference;
+            DocumentSnapshot: typeof types.DocumentSnapshot;
+            FieldPath: typeof types.FieldPath;
+            FieldValue: typeof types.FieldValue;
+            Firestore: typeof types.FirebaseFirestore;
+            GeoPoint: typeof types.GeoPoint;
+            Query: typeof types.Query;
+            QueryDocumentSnapshot: typeof types.QueryDocumentSnapshot;
+            QuerySnapshot: typeof types.QuerySnapshot;
+            Timestamp: typeof types.Timestamp;
+            Transaction: typeof types.Transaction;
+            WriteBatch: typeof types.WriteBatch;
+            setLogLevel: typeof types.setLogLevel;
+        };
+    }
+    interface FirebaseApp {
+        firestore?(): types.FirebaseFirestore;
+    }
+}
 
 import { FirebaseApp as FirebaseAppCompat } from "@firebase/app-compat";
-import { type WithFieldValue, type DocumentReference, type CollectionReference, type DocumentData, type Query, type EmulatorMockTokenOptions, type PersistenceSettings, type AggregateQuerySnapshot, type AggregateField, type DocumentSnapshot, type QuerySnapshot, type Firestore, type FirestoreSettings, type LoadBundleTask, type FirestoreError, type Unsubscribe, type SnapshotListenOptions, type QueryConstraint, type Transaction, type TransactionOptions, type PartialWithFieldValue, type SetOptions, type IndexConfiguration, type UpdateData, type FieldPath, type WriteBatch } from "@firebase/firestore";
+import { type DocumentData, type WithFieldValue, type DocumentReference, type CollectionReference, type Query, type EmulatorMockTokenOptions, type DocumentSnapshot, type FirestoreDataConverter, type PersistenceSettings, type AggregateSpec, type AggregateQuerySnapshot, type AggregateField, type QuerySnapshot, type Firestore, type PersistentCacheIndexManager, type FirestoreSettings, type LoadBundleTask, type FirestoreError, type Unsubscribe, type SnapshotListenOptions, type QueryCompositeFilterConstraint, type QueryNonFilterConstraint, type QueryConstraint, type Transaction, type TransactionOptions, type PartialWithFieldValue, type SetOptions, type IndexConfiguration, type UpdateData, type FieldPath, type WriteBatch } from "@firebase/firestore";
 declare module "@firebase/firestore" {
-    function addDoc<T>(reference: types.CollectionReference<T>, data: WithFieldValue<T>): Promise<DocumentReference<T>>;
+    function addDoc<AppModelType, DbModelType extends DocumentData>(reference: types.CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;
     function clearIndexedDbPersistence(firestore: types.FirebaseFirestore): Promise<void>;
-    function collection(firestore: types.FirebaseFirestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;
-    function collection(reference: types.CollectionReference<unknown>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;
-    function collection(reference: types.DocumentReference, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;
-    function collectionGroup(firestore: types.FirebaseFirestore, collectionId: string): Query<DocumentData>;
+    function collection(firestore: types.FirebaseFirestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
+    function collection<AppModelType, DbModelType extends DocumentData>(reference: types.CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
+    function collection<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
+    function collectionGroup(firestore: types.FirebaseFirestore, collectionId: string): Query<DocumentData, DocumentData>;
     function connectFirestoreEmulator(firestore: types.FirebaseFirestore, host: string, port: number, options?: {
         mockUserToken?: EmulatorMockTokenOptions | string;
     }): void;
-    function deleteDoc(reference: types.DocumentReference<unknown>): Promise<void>;
+    function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>): Promise<void>;
     function disableNetwork(firestore: types.FirebaseFirestore): Promise<void>;
-    function doc(firestore: types.FirebaseFirestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData>;
-    function doc<T>(reference: types.CollectionReference<T>, path?: string, ...pathSegments: string[]): DocumentReference<T>;
-    function doc(reference: types.DocumentReference<unknown>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData>;
+    function doc(firestore: types.FirebaseFirestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
+    function doc<AppModelType, DbModelType extends DocumentData>(reference: types.CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;
+    function doc<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
+    function documentSnapshotFromJSON(db: types.FirebaseFirestore, json: object): DocumentSnapshot;
+    function documentSnapshotFromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: types.FirebaseFirestore, json: object, converter: FirestoreDataConverter<AppModelType, DbModelType>): DocumentSnapshot<AppModelType, DbModelType>;
     function enableIndexedDbPersistence(firestore: types.FirebaseFirestore, persistenceSettings?: PersistenceSettings): Promise<void>;
     function enableMultiTabIndexedDbPersistence(firestore: types.FirebaseFirestore): Promise<void>;
     function enableNetwork(firestore: types.FirebaseFirestore): Promise<void>;
-    function getCountFromServer(query: types.Query<unknown>): Promise<AggregateQuerySnapshot<{
+    function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;
+    function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
         count: AggregateField<number>;
-    }>>;
-    function getDoc<T>(reference: types.DocumentReference<T>): Promise<DocumentSnapshot<T>>;
-    function getDocFromCache<T>(reference: types.DocumentReference<T>): Promise<DocumentSnapshot<T>>;
-    function getDocFromServer<T>(reference: types.DocumentReference<T>): Promise<DocumentSnapshot<T>>;
-    function getDocs<T>(query: types.Query<T>): Promise<QuerySnapshot<T>>;
-    function getDocsFromCache<T>(query: types.Query<T>): Promise<QuerySnapshot<T>>;
-    function getDocsFromServer<T>(query: types.Query<T>): Promise<QuerySnapshot<T>>;
+    }, AppModelType, DbModelType>>;
+    function getDoc<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
+    function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
+    function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
+    function getDocs<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;
+    function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;
+    function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;
     function getFirestore(app: FirebaseAppCompat): Firestore;
+    function getFirestore(app: FirebaseAppCompat, databaseId: string): Firestore;
+    function getPersistentCacheIndexManager(firestore: types.FirebaseFirestore): PersistentCacheIndexManager | null;
     function initializeFirestore(app: FirebaseAppCompat, settings: FirestoreSettings, databaseId?: string): Firestore;
     function loadBundle(firestore: types.FirebaseFirestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;
     function namedQuery(firestore: types.FirebaseFirestore, name: string): Promise<Query | null>;
-    function onSnapshot<T>(reference: types.DocumentReference<T>, observer: {
-        next?: (snapshot: DocumentSnapshot<T>) => void;
+    function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, observer: {
+        next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
         error?: (error: FirestoreError) => void;
         complete?: () => void;
     }): Unsubscribe;
-    function onSnapshot<T>(reference: types.DocumentReference<T>, options: SnapshotListenOptions, observer: {
-        next?: (snapshot: DocumentSnapshot<T>) => void;
+    function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
+        next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
         error?: (error: FirestoreError) => void;
         complete?: () => void;
     }): Unsubscribe;
-    function onSnapshot<T>(reference: types.DocumentReference<T>, onNext: (snapshot: DocumentSnapshot<T>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;
-    function onSnapshot<T>(reference: types.DocumentReference<T>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<T>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;
-    function onSnapshot<T>(query: types.Query<T>, observer: {
-        next?: (snapshot: QuerySnapshot<T>) => void;
+    function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;
+    function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;
+    function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>, observer: {
+        next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
         error?: (error: FirestoreError) => void;
         complete?: () => void;
     }): Unsubscribe;
-    function onSnapshot<T>(query: types.Query<T>, options: SnapshotListenOptions, observer: {
-        next?: (snapshot: QuerySnapshot<T>) => void;
+    function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
+        next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
         error?: (error: FirestoreError) => void;
         complete?: () => void;
     }): Unsubscribe;
-    function onSnapshot<T>(query: types.Query<T>, onNext: (snapshot: QuerySnapshot<T>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;
-    function onSnapshot<T>(query: types.Query<T>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<T>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;
+    function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;
+    function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;
+    function onSnapshotResume<AppModelType, DbModelType extends DocumentData>(firestore: types.FirebaseFirestore, snapshotJson: object, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void, converter?: FirestoreDataConverter<DbModelType>): Unsubscribe;
+    function onSnapshotResume<AppModelType, DbModelType extends DocumentData>(firestore: types.FirebaseFirestore, snapshotJson: object, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void, converter?: FirestoreDataConverter<DbModelType>): Unsubscribe;
+    function onSnapshotResume<AppModelType, DbModelType extends DocumentData>(firestore: types.FirebaseFirestore, snapshotJson: object, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void, converter?: FirestoreDataConverter<DbModelType>): Unsubscribe;
+    function onSnapshotResume<AppModelType, DbModelType extends DocumentData>(firestore: types.FirebaseFirestore, snapshotJson: object, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void, converter?: FirestoreDataConverter<DbModelType>): Unsubscribe;
+    function onSnapshotResume<AppModelType, DbModelType extends DocumentData>(firestore: types.FirebaseFirestore, snapshotJson: object, observer: {
+        next: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
+        error?: (error: FirestoreError) => void;
+        complete?: () => void;
+    }, converter?: FirestoreDataConverter<DbModelType>): Unsubscribe;
+    function onSnapshotResume<AppModelType, DbModelType extends DocumentData>(firestore: types.FirebaseFirestore, snapshotJson: object, observer: {
+        next: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
+        error?: (error: FirestoreError) => void;
+        complete?: () => void;
+    }, converter?: FirestoreDataConverter<DbModelType>): Unsubscribe;
+    function onSnapshotResume<AppModelType, DbModelType extends DocumentData>(firestore: types.FirebaseFirestore, snapshotJson: object, options: SnapshotListenOptions, observer: {
+        next: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
+        error?: (error: FirestoreError) => void;
+        complete?: () => void;
+    }, converter?: FirestoreDataConverter<DbModelType>): Unsubscribe;
+    function onSnapshotResume<AppModelType, DbModelType extends DocumentData>(firestore: types.FirebaseFirestore, snapshotJson: object, options: SnapshotListenOptions, observer: {
+        next: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
+        error?: (error: FirestoreError) => void;
+        complete?: () => void;
+    }, converter?: FirestoreDataConverter<DbModelType>): Unsubscribe;
     function onSnapshotsInSync(firestore: types.FirebaseFirestore, observer: {
         next?: (value: void) => void;
         error?: (error: FirestoreError) => void;
         complete?: () => void;
     }): Unsubscribe;
     function onSnapshotsInSync(firestore: types.FirebaseFirestore, onSync: () => void): Unsubscribe;
-    function query<T>(query: types.Query<T>, ...queryConstraints: QueryConstraint[]): Query<T>;
-    function queryEqual<T>(left: types.Query<T>, right: types.Query<T>): boolean;
+    function query<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;
+    function query<AppModelType, DbModelType extends DocumentData>(query: types.Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;
+    function queryEqual<AppModelType, DbModelType extends DocumentData>(left: types.Query<AppModelType, DbModelType>, right: types.Query<AppModelType, DbModelType>): boolean;
+    function querySnapshotFromJSON(db: types.FirebaseFirestore, json: object): QuerySnapshot;
+    function querySnapshotFromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: types.FirebaseFirestore, json: object, converter: FirestoreDataConverter<AppModelType, DbModelType>): QuerySnapshot<AppModelType, DbModelType>;
     function runTransaction<T>(firestore: types.FirebaseFirestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;
-    function setDoc<T>(reference: types.DocumentReference<T>, data: WithFieldValue<T>): Promise<void>;
-    function setDoc<T>(reference: types.DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): Promise<void>;
+    function setDoc<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;
+    function setDoc<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;
     function setIndexConfiguration(firestore: types.FirebaseFirestore, configuration: IndexConfiguration): Promise<void>;
     function setIndexConfiguration(firestore: types.FirebaseFirestore, json: string): Promise<void>;
     function terminate(firestore: types.FirebaseFirestore): Promise<void>;
-    function updateDoc<T>(reference: types.DocumentReference<T>, data: UpdateData<T>): Promise<void>;
-    function updateDoc(reference: types.DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
+    function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;
+    function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: types.DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
     function waitForPendingWrites(firestore: types.FirebaseFirestore): Promise<void>;
     function writeBatch(firestore: types.FirebaseFirestore): WriteBatch;
 }

package/dist/src/index.node.d.ts

@@ -1,22 +1,22 @@
-/**
- * @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 { FirebaseNamespace } from '@firebase/app-types';
-/**
- * Registers the main Firestore Node build with the components framework.
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
- */
-export declare function registerFirestore(instance: FirebaseNamespace): 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.
+ */
+import { FirebaseNamespace } from '@firebase/app-types';
+/**
+ * Registers the main Firestore Node build with the components framework.
+ * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
+ */
+export declare function registerFirestore(instance: FirebaseNamespace): void;

package/dist/src/index.rn.d.ts

@@ -1,22 +1,22 @@
-/**
- * @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.
- */
-import { FirebaseNamespace } from '@firebase/app-types';
-/**
- * Registers the main Firestore ReactNative build with the components framework.
- * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
- */
-export declare function registerFirestore(instance: FirebaseNamespace): 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.
+ */
+import { FirebaseNamespace } from '@firebase/app-types';
+/**
+ * Registers the main Firestore ReactNative build with the components framework.
+ * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
+ */
+export declare function registerFirestore(instance: FirebaseNamespace): void;