types.test.ts: add some negative tests for UpdateData

Author: dconeybe

packages/firestore/test/unit/lite-api/types.test.ts

@@ -695,4 +695,79 @@ describe('FirestoreTypeConverter', () => {
       expect(data.numberProperty).to.equal(43);
     }
   });
+
+  it('setDoc() fails to compile if `data` argument is missing properties', () => {
+    async function _(docRef: DocumentReference): Promise<void> {
+      const converter = new ThrowingConverter<
+        { foo: string },
+        { bar: number }
+      >();
+      const docRefWithConverter = docRef.withConverter(converter);
+      // @ts-expect-error `data` argument is missing `foo` property.
+      await setDoc(docRefWithConverter, { bar: 42 });
+    }
+  });
+
+  it('setDoc() fails to compile if `data` argument has incorrect type for a property', () => {
+    async function _(docRef: DocumentReference): Promise<void> {
+      const converter = new ThrowingConverter<{ foo: string }, {}>();
+      const docRefWithConverter = docRef.withConverter(converter);
+      // @ts-expect-error The `data` argument has the wrong type for `foo`.
+      await setDoc(docRefWithConverter, { foo: 42 });
+    }
+  });
+
+  it('updateDoc() fails to compile if `data` argument is missing properties', () => {
+    async function _(docRef: DocumentReference): Promise<void> {
+      const converter = new ThrowingConverter<
+        { foo: string },
+        { bar: number }
+      >();
+      const docRefWithConverter = docRef.withConverter(converter);
+      // @ts-expect-error `data` argument is missing `bar` property.
+      await updateDoc(docRefWithConverter, { foo: 'foo' });
+    }
+  });
+
+  it('updateDoc() fails to compile if `data` argument has incorrect type for a property', () => {
+    async function _(docRef: DocumentReference): Promise<void> {
+      const converter = new ThrowingConverter<{}, { bar: number }>();
+      const docRefWithConverter = docRef.withConverter(converter);
+      // @ts-expect-error The `data` argument has the wrong type for `bar`.
+      await updateDoc(docRefWithConverter, { bar: 'bar' });
+    }
+  });
+
+  it('getDoc() returns AppModelType', () => {
+    async function _(docRef: DocumentReference): Promise<void> {
+      const converter = new ThrowingConverter<
+        { foo: string },
+        { bar: number }
+      >();
+      const docRefWithConverter = docRef.withConverter(converter);
+      const snapshot = await getDoc(docRefWithConverter);
+      const data: { foo: string } = snapshot.data()!;
+      expect(data.foo).to.equal('foo');
+    }
+  });
+
+  /**
+   * An implementation of FirestoreDataConverter whose methods simply throw an
+   * exception. Instances of this class may be useful for tests that only desire
+   * to check the compile-time type checking but not actually invoke the
+   * converter at runtime.
+   */
+  class ThrowingConverter<AppModelType, DbModelType extends DocumentData>
+    implements FirestoreDataConverter<AppModelType, DbModelType>
+  {
+    toFirestore(
+      modelObject: WithFieldValue<AppModelType>
+    ): WithFieldValue<DbModelType> {
+      throw new Error('ThrowingConverter.toFirestore() should not be called');
+    }
+
+    fromFirestore(snapshot: QueryDocumentSnapshot): AppModelType {
+      throw new Error('ThrowingConverter.fromFirestore() should not be called');
+    }
+  }
 });