firestore[-lite].api.md update

Author: dconeybe

common/api-review/firestore-lite.api.md

@@ -10,7 +10,7 @@ import { FirebaseError } from '@firebase/util';
 import { LogLevelString as LogLevel } from '@firebase/logger';
 
 // @public
-export function addDoc<T>(reference: CollectionReference<T>, data: WithFieldValue<T>): Promise<DocumentReference<T>>;
+export function addDoc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: CollectionReference<AppType, DbType>, data: WithFieldValue<AppType>): Promise<DocumentReference<AppType, DbType>>;
 
 // @public
 export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
@@ -26,14 +26,14 @@ export class AggregateField<T> {
 export type AggregateFieldType = AggregateField<number | null>;
 
 // @public
-export class AggregateQuerySnapshot<T extends AggregateSpec> {
-    data(): AggregateSpecData<T>;
-    readonly query: Query<unknown>;
+export class AggregateQuerySnapshot<AggregateSpecType extends AggregateSpec, AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> {
+    data(): AggregateSpecData<AggregateSpecType>;
+    readonly query: Query<AppType, DbType>;
     readonly type = "AggregateQuerySnapshot";
 }
 
 // @public
-export function aggregateQuerySnapshotEqual<T extends AggregateSpec>(left: AggregateQuerySnapshot<T>, right: AggregateQuerySnapshot<T>): boolean;
+export function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec>(left: AggregateQuerySnapshot<AggregateSpecType>, right: AggregateQuerySnapshot<AggregateSpecType>): boolean;
 
 // @public
 export interface AggregateSpec {
@@ -69,25 +69,25 @@ export class Bytes {
 export type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;
 
 // @public
-export function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;
+export function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
 
 // @public
-export function collection(reference: CollectionReference<unknown>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;
+export function collection<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: CollectionReference<AppType, DbType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
 
 // @public
-export function collection(reference: DocumentReference, path: string, ...pathSegments: string[]): CollectionReference<DocumentData>;
+export function collection<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: DocumentReference<AppType, DbType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;
 
 // @public
-export function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData>;
+export function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;
 
 // @public
-export class CollectionReference<T = DocumentData> extends Query<T> {
+export class CollectionReference<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> extends Query<AppType, DbType> {
     get id(): string;
-    get parent(): DocumentReference<DocumentData> | null;
+    get parent(): DocumentReference<DocumentData, DocumentData> | null;
     get path(): string;
     readonly type = "collection";
-    withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
-    withConverter(converter: null): CollectionReference<DocumentData>;
+    withConverter<NewAppType = DocumentData, NewDbType extends DocumentData = NewAppType extends DocumentData ? NewAppType : DocumentData>(converter: FirestoreDataConverter<NewAppType, NewDbType>): CollectionReference<NewAppType, NewDbType>;
+    withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
 }
 
 // @public
@@ -96,48 +96,46 @@ export function connectFirestoreEmulator(firestore: Firestore, host: string, por
 }): void;
 
 // @public
-export function deleteDoc(reference: DocumentReference<unknown>): Promise<void>;
+export function deleteDoc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: DocumentReference<AppType, DbType>): Promise<void>;
 
 // @public
 export function deleteField(): FieldValue;
 
 // @public
-export function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData>;
+export function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
 
 // @public
-export function doc<T>(reference: CollectionReference<T>, path?: string, ...pathSegments: string[]): DocumentReference<T>;
+export function doc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: CollectionReference<AppType, DbType>, path?: string, ...pathSegments: string[]): DocumentReference<AppType, DbType>;
 
 // @public
-export function doc(reference: DocumentReference<unknown>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData>;
+export function doc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: DocumentReference<AppType, DbType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
 
 // @public
-export interface DocumentData {
-    [field: string]: any;
-}
+export type DocumentData = Record<string, any>;
 
 // @public
 export function documentId(): FieldPath;
 
 // @public
-export class DocumentReference<T = DocumentData> {
-    readonly converter: FirestoreDataConverter<T> | null;
+export class DocumentReference<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> {
+    readonly converter: FirestoreDataConverter<AppType, DbType> | null;
     readonly firestore: Firestore;
     get id(): string;
-    get parent(): CollectionReference<T>;
+    get parent(): CollectionReference<AppType, DbType>;
     get path(): string;
     readonly type = "document";
-    withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
-    withConverter(converter: null): DocumentReference<DocumentData>;
+    withConverter<NewAppType = DocumentData, NewDbType extends DocumentData = NewAppType extends DocumentData ? NewAppType : DocumentData>(converter: FirestoreDataConverter<NewAppType, NewDbType>): DocumentReference<NewAppType, NewDbType>;
+    withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
 }
 
 // @public
-export class DocumentSnapshot<T = DocumentData> {
+export class DocumentSnapshot<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> {
     protected constructor();
-    data(): T | undefined;
-    exists(): this is QueryDocumentSnapshot<T>;
+    data(): AppType | undefined;
+    exists(): this is QueryDocumentSnapshot<AppType, DbType>;
     get(fieldPath: string | FieldPath): any;
     get id(): string;
-    get ref(): DocumentReference<T>;
+    get ref(): DocumentReference<AppType, DbType>;
 }
 
 export { EmulatorMockTokenOptions }
@@ -173,10 +171,10 @@ export class Firestore {
 }
 
 // @public
-export interface FirestoreDataConverter<T> {
-    fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData>): T;
-    toFirestore(modelObject: WithFieldValue<T>): DocumentData;
-    toFirestore(modelObject: PartialWithFieldValue<T>, options: SetOptions): DocumentData;
+export interface FirestoreDataConverter<AppType, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> {
+    fromFirestore(snapshot: QueryDocumentSnapshot<DbType, DbType>): AppType;
+    toFirestore(modelObject: WithFieldValue<AppType>): WithFieldValue<DbType>;
+    toFirestore(modelObject: PartialWithFieldValue<AppType>, options: SetOptions): PartialWithFieldValue<DbType>;
 }
 
 // @public
@@ -202,15 +200,15 @@ export class GeoPoint {
 }
 
 // @public
-export function getCount(query: Query<unknown>): Promise<AggregateQuerySnapshot<{
+export function getCount<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(query: Query<AppType, DbType>): Promise<AggregateQuerySnapshot<{
     count: AggregateField<number>;
-}>>;
+}, AppType, DbType>>;
 
 // @public
-export function getDoc<T>(reference: DocumentReference<T>): Promise<DocumentSnapshot<T>>;
+export function getDoc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: DocumentReference<AppType, DbType>): Promise<DocumentSnapshot<AppType, DbType>>;
 
 // @public
-export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
+export function getDocs<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(query: Query<AppType, DbType>): Promise<QuerySnapshot<AppType, DbType>>;
 
 // @public
 export function getFirestore(): Firestore;
@@ -255,20 +253,20 @@ export type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T
 export type Primitive = string | number | boolean | undefined | null;
 
 // @public
-export class Query<T = DocumentData> {
+export class Query<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> {
     protected constructor();
-    readonly converter: FirestoreDataConverter<T> | null;
+    readonly converter: FirestoreDataConverter<AppType, DbType> | null;
     readonly firestore: Firestore;
     readonly type: 'query' | 'collection';
-    withConverter(converter: null): Query<DocumentData>;
-    withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
+    withConverter(converter: null): Query<DocumentData, DocumentData>;
+    withConverter<NewAppType = DocumentData, NewDbType extends DocumentData = NewAppType extends DocumentData ? NewAppType : DocumentData>(converter: FirestoreDataConverter<NewAppType, NewDbType>): Query<NewAppType, NewDbType>;
 }
 
 // @public
-export function query<T>(query: Query<T>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<T>;
+export function query<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(query: Query<AppType, DbType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppType, DbType>;
 
 // @public
-export function query<T>(query: Query<T>, ...queryConstraints: QueryConstraint[]): Query<T>;
+export function query<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(query: Query<AppType, DbType>, ...queryConstraints: QueryConstraint[]): Query<AppType, DbType>;
 
 // @public
 export class QueryCompositeFilterConstraint {
@@ -284,9 +282,9 @@ export abstract class QueryConstraint {
 export type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';
 
 // @public
-export class QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<T> {
+export class QueryDocumentSnapshot<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> extends DocumentSnapshot<AppType, DbType> {
     // @override
-    data(): T;
+    data(): AppType;
 }
 
 // @public
@@ -295,7 +293,7 @@ export class QueryEndAtConstraint extends QueryConstraint {
 }
 
 // @public
-export function queryEqual<T>(left: Query<T>, right: Query<T>): boolean;
+export function queryEqual<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(left: Query<AppType, DbType>, right: Query<AppType, DbType>): boolean;
 
 // @public
 export class QueryFieldFilterConstraint extends QueryConstraint {
@@ -319,11 +317,11 @@ export class QueryOrderByConstraint extends QueryConstraint {
 }
 
 // @public
-export class QuerySnapshot<T = DocumentData> {
-    get docs(): Array<QueryDocumentSnapshot<T>>;
+export class QuerySnapshot<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> {
+    get docs(): Array<QueryDocumentSnapshot<AppType, DbType>>;
     get empty(): boolean;
-    forEach(callback: (result: QueryDocumentSnapshot<T>) => void, thisArg?: unknown): void;
-    readonly query: Query<T>;
+    forEach(callback: (result: QueryDocumentSnapshot<AppType, DbType>) => void, thisArg?: unknown): void;
+    readonly query: Query<AppType, DbType>;
     get size(): number;
 }
 
@@ -333,7 +331,7 @@ export class QueryStartAtConstraint extends QueryConstraint {
 }
 
 // @public
-export function refEqual<T>(left: DocumentReference<T> | CollectionReference<T>, right: DocumentReference<T> | CollectionReference<T>): boolean;
+export function refEqual<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(left: DocumentReference<AppType, DbType> | CollectionReference<AppType, DbType>, right: DocumentReference<AppType, DbType> | CollectionReference<AppType, DbType>): boolean;
 
 // @public
 export function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;
@@ -342,10 +340,10 @@ export function runTransaction<T>(firestore: Firestore, updateFunction: (transac
 export function serverTimestamp(): FieldValue;
 
 // @public
-export function setDoc<T>(reference: DocumentReference<T>, data: WithFieldValue<T>): Promise<void>;
+export function setDoc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: DocumentReference<AppType, DbType>, data: WithFieldValue<AppType>): Promise<void>;
 
 // @public
-export function setDoc<T>(reference: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): Promise<void>;
+export function setDoc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: DocumentReference<AppType, DbType>, data: PartialWithFieldValue<AppType>, options: SetOptions): Promise<void>;
 
 // @public
 export function setLogLevel(logLevel: LogLevel): void;
@@ -365,7 +363,7 @@ export interface Settings {
 }
 
 // @public
-export function snapshotEqual<T>(left: DocumentSnapshot<T> | QuerySnapshot<T>, right: DocumentSnapshot<T> | QuerySnapshot<T>): boolean;
+export function snapshotEqual<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(left: DocumentSnapshot<AppType, DbType> | QuerySnapshot<AppType, DbType>, right: DocumentSnapshot<AppType, DbType> | QuerySnapshot<AppType, DbType>): boolean;
 
 // @public
 export function startAfter(snapshot: DocumentSnapshot<unknown>): QueryStartAtConstraint;
@@ -405,12 +403,12 @@ export class Timestamp {
 
 // @public
 export class Transaction {
-    delete(documentRef: DocumentReference<unknown>): this;
-    get<T>(documentRef: DocumentReference<T>): Promise<DocumentSnapshot<T>>;
-    set<T>(documentRef: DocumentReference<T>, data: WithFieldValue<T>): this;
-    set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): this;
-    update<T>(documentRef: DocumentReference<T>, data: UpdateData<T>): this;
-    update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
+    delete<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>): this;
+    get<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>): Promise<DocumentSnapshot<AppType, DbType>>;
+    set<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>, data: WithFieldValue<AppType>): this;
+    set<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>, data: PartialWithFieldValue<AppType>, options: SetOptions): this;
+    update<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>, data: UpdateData<DbType>): this;
+    update<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
 }
 
 // @public
@@ -427,10 +425,10 @@ export type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
 } & NestedUpdateFields<T> : Partial<T>;
 
 // @public
-export function updateDoc<T>(reference: DocumentReference<T>, data: UpdateData<T>): Promise<void>;
+export function updateDoc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: DocumentReference<AppType, DbType>, data: UpdateData<DbType>): Promise<void>;
 
 // @public
-export function updateDoc(reference: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
+export function updateDoc<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>(reference: DocumentReference<AppType, DbType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
 
 // @public
 export function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;
@@ -446,11 +444,11 @@ export type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
 // @public
 export class WriteBatch {
     commit(): Promise<void>;
-    delete(documentRef: DocumentReference<unknown>): WriteBatch;
-    set<T>(documentRef: DocumentReference<T>, data: WithFieldValue<T>): WriteBatch;
-    set<T>(documentRef: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): WriteBatch;
-    update<T>(documentRef: DocumentReference<T>, data: UpdateData<T>): WriteBatch;
-    update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
+    delete<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>): WriteBatch;
+    set<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>, data: WithFieldValue<AppType>): WriteBatch;
+    set<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>, data: PartialWithFieldValue<AppType>, options: SetOptions): WriteBatch;
+    update<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>, data: UpdateData<DbType>): WriteBatch;
+    update<AppType, DbType extends DocumentData>(documentRef: DocumentReference<AppType, DbType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
 }
 
 // @public