Misc fixes for firestore-exp API definition (#3359)

firebase · Jul 7, 2020 · 26767cd · 26767cd
1 parent 064cf2e
commit 26767cd
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 12 deletions.
diff --git a/.changeset/tough-donkeys-hope.md b/.changeset/tough-donkeys-hope.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/firestore/exp/index.d.ts b/packages/firestore/exp/index.d.ts
@@ -65,7 +65,10 @@ export function setLogLevel(logLevel: LogLevel): void;
 export interface FirestoreDataConverter<T> {
   toFirestore(modelObject: T): DocumentData;
   toFirestore(modelObject: Partial<T>, options: SetOptions): DocumentData;
-  fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData>): T;
+  fromFirestore(
+    snapshot: QueryDocumentSnapshot<DocumentData>,
+    options: SnapshotOptions
+  ): T;
 }
 
 export class FirebaseFirestore {
@@ -219,10 +222,13 @@ export class WriteBatch {
   commit(): Promise<void>;
 }
 
-export interface SetOptions {
-  readonly merge?: boolean;
-  readonly mergeFields?: Array<string | FieldPath>;
-}
+export type SetOptions =
+  | {
+      readonly merge?: boolean;
+    }
+  | {
+      readonly mergeFields?: Array<string | FieldPath>;
+    };
 
 export class DocumentReference<T = DocumentData> {
   private constructor();
@@ -249,7 +255,7 @@ export class DocumentSnapshot<T = DocumentData> {
 export class QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<
   T
 > {
-  data(): T;
+  data(options?: SnapshotOptions): T;
 }
 
 export type OrderByDirection = 'desc' | 'asc';

diff --git a/packages/firestore/lite/index.d.ts b/packages/firestore/lite/index.d.ts
@@ -183,10 +183,13 @@ export class WriteBatch {
   commit(): Promise<void>;
 }
 
-export interface SetOptions {
-  readonly merge?: boolean;
-  readonly mergeFields?: Array<string | FieldPath>;
-}
+export type SetOptions =
+  | {
+      readonly merge?: boolean;
+    }
+  | {
+      readonly mergeFields?: Array<string | FieldPath>;
+    };
 
 export class DocumentReference<T = DocumentData> {
   private constructor();

diff --git a/packages/firestore/lite/src/api/snapshot.ts b/packages/firestore/lite/src/api/snapshot.ts
@@ -25,7 +25,10 @@ import { DocumentKey } from '../../../src/model/document_key';
 import { Document } from '../../../src/model/document';
 import { UserDataWriter } from '../../../src/api/user_data_writer';
 import { FieldPath as InternalFieldPath } from '../../../src/model/path';
-import { fieldPathFromDotSeparatedString } from '../../../src/api/user_data_reader';
+import {
+  fieldPathFromDotSeparatedString,
+  UntypedFirestoreDataConverter
+} from '../../../src/api/user_data_reader';
 import { arrayEquals } from '../../../src/util/misc';
 
 export class DocumentSnapshot<T = firestore.DocumentData>
@@ -39,7 +42,7 @@ export class DocumentSnapshot<T = firestore.DocumentData>
     public _firestore: Firestore,
     public _key: DocumentKey,
     public _document: Document | null,
-    public _converter: firestore.FirestoreDataConverter<T> | null
+    public _converter: UntypedFirestoreDataConverter<T> | null
   ) {}
 
   get id(): string {