fix: exactOptionalPropertyTypes TS option compatibility (#256)

Author: andipaetzold

package-lock.json

@@ -54,6 +54,7 @@
         "@semantic-release/git": "10.0.1",
         "@testing-library/react": "14.0.0",
         "@tsconfig/recommended": "1.0.3",
+        "@tsconfig/strictest": "2.0.2",
         "@types/react": "18.2.33",
         "@typescript-eslint/eslint-plugin": "6.9.0",
         "@typescript-eslint/parser": "6.9.0",

package.json

@@ -10,8 +10,8 @@ export type UseObjectValueResult<Value = unknown> = ValueHookResult<Value, Error
 export type UseObjectValueConverter<Value> = (snap: DataSnapshot) => Value;
 
 export interface UseObjectValueOptions<Value> {
-    converter?: UseObjectValueConverter<Value>;
-    initialValue?: Value;
+    converter?: UseObjectValueConverter<Value> | undefined;
+    initialValue?: Value | undefined;
 }
 
 /**
@@ -28,7 +28,7 @@ export interface UseObjectValueOptions<Value> {
  */
 export function useObjectValue<Value = unknown>(
     query: Query | undefined | null,
-    options?: UseObjectValueOptions<Value>,
+    options?: UseObjectValueOptions<Value> | undefined,
 ): UseObjectValueResult<Value> {
     const { converter = defaultConverter, initialValue = LoadingState } = options ?? {};
 

src/database/useObjectValue.ts

@@ -9,7 +9,7 @@ export type UseObjectValueOnceResult<Value = unknown> = ValueHookResult<Value, E
 export type UseObjectValueOnceConverter<Value> = (snap: DataSnapshot) => Value;
 
 export interface UseObjectValueOnceOptions<Value> {
-    converter?: UseObjectValueOnceConverter<Value>;
+    converter?: UseObjectValueOnceConverter<Value> | undefined;
 }
 
 /**
@@ -25,7 +25,7 @@ export interface UseObjectValueOnceOptions<Value> {
  */
 export function useObjectValueOnce<Value = unknown>(
     query: Query | undefined | null,
-    options?: UseObjectValueOnceOptions<Value>,
+    options?: UseObjectValueOnceOptions<Value> | undefined,
 ): UseObjectValueOnceResult<Value> {
     const { converter = defaultConverter } = options ?? {};
 

src/database/useObjectValueOnce.ts

@@ -125,6 +125,13 @@ describe("isAggregateSpecEqual", () => {
         expect(isAggregateSpecEqual(spec1, spec2)).toBe(false);
     });
 
+    it("different keys", () => {
+        const spec1 = { count: count() };
+        const spec2 = { total: count() };
+        // @ts-expect-error Different specs
+        expect(isAggregateSpecEqual(spec1, spec2)).toBe(false);
+    });
+
     it("different aggregations", () => {
         const spec1 = { value: count() };
         const spec2 = { value: average("abc") };

src/firestore/internal.spec.ts

@@ -83,5 +83,5 @@ export function isAggregateSpecEqual<T extends AggregateSpec>(a: T, b: T): boole
         return false;
     }
 
-    return Object.entries(a).every(([key, value]) => aggregateFieldEqual(value, b[key]));
+    return Object.entries(a).every(([key, value]) => aggregateFieldEqual(value, b[key]!));
 }

src/firestore/internal.ts

@@ -18,7 +18,7 @@ export type UseDocumentResult<AppModelType = DocumentData> = ValueHookResult<Doc
  * Options to configure the subscription
  */
 export interface UseDocumentOptions {
-    snapshotListenOptions?: SnapshotListenOptions;
+    snapshotListenOptions?: SnapshotListenOptions | undefined;
 }
 
 /**
@@ -34,10 +34,10 @@ export interface UseDocumentOptions {
  */
 export function useDocument<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(
     reference: DocumentReference<AppModelType, DbModelType> | undefined | null,
-    options?: UseDocumentOptions,
+    options?: UseDocumentOptions | undefined,
 ): UseDocumentResult<AppModelType> {
     const { snapshotListenOptions } = options ?? {};
-    const { includeMetadataChanges } = snapshotListenOptions ?? {};
+    const { includeMetadataChanges = false } = snapshotListenOptions ?? {};
 
     const onChange: UseListenOnChange<
         DocumentSnapshot<AppModelType, DbModelType>,

src/firestore/useDocument.ts

@@ -18,9 +18,9 @@ export type UseDocumentDataResult<AppModelType = DocumentData> = ValueHookResult
  * Options to configure the subscription
  */
 export interface UseDocumentDataOptions<AppModelType = DocumentData> {
-    snapshotListenOptions?: SnapshotListenOptions;
-    snapshotOptions?: SnapshotOptions;
-    initialValue?: AppModelType;
+    snapshotListenOptions?: SnapshotListenOptions | undefined;
+    snapshotOptions?: SnapshotOptions | undefined;
+    initialValue?: AppModelType | undefined;
 }
 
 /**
@@ -37,11 +37,11 @@ export interface UseDocumentDataOptions<AppModelType = DocumentData> {
  */
 export function useDocumentData<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(
     reference: DocumentReference<AppModelType, DbModelType> | undefined | null,
-    options?: UseDocumentDataOptions<AppModelType>,
+    options?: UseDocumentDataOptions<AppModelType> | undefined,
 ): UseDocumentDataResult<AppModelType> {
     const { snapshotListenOptions, snapshotOptions } = options ?? {};
-    const { includeMetadataChanges } = snapshotListenOptions ?? {};
-    const { serverTimestamps } = snapshotOptions ?? {};
+    const { includeMetadataChanges = false } = snapshotListenOptions ?? {};
+    const { serverTimestamps = "none" } = snapshotOptions ?? {};
 
     const onChange: UseListenOnChange<
         AppModelType,

src/firestore/useDocumentData.ts

@@ -11,8 +11,8 @@ export type UseDocumentDataOnceResult<AppModelType = DocumentData> = ValueHookRe
  * Options to configure how the document is fetched
  */
 export interface UseDocumentDataOnceOptions {
-    source?: Source;
-    snapshotOptions?: SnapshotOptions;
+    source?: Source | undefined;
+    snapshotOptions?: SnapshotOptions | undefined;
 }
 
 /**
@@ -28,10 +28,10 @@ export interface UseDocumentDataOnceOptions {
  */
 export function useDocumentDataOnce<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(
     reference: DocumentReference<AppModelType, DbModelType> | undefined | null,
-    options?: UseDocumentDataOnceOptions,
+    options?: UseDocumentDataOnceOptions | undefined,
 ): UseDocumentDataOnceResult<AppModelType> {
     const { source = "default", snapshotOptions } = options ?? {};
-    const { serverTimestamps } = snapshotOptions ?? {};
+    const { serverTimestamps = "none" } = snapshotOptions ?? {};
 
     const getData = useCallback(
         async (stableRef: DocumentReference<AppModelType, DbModelType>) => {

src/firestore/useDocumentDataOnce.ts

@@ -14,7 +14,7 @@ export type UseDocumentOnceResult<AppModelType = DocumentData> = ValueHookResult
  * Options to configure how the document is fetched
  */
 export interface UseDocumentOnceOptions {
-    source?: Source;
+    source?: Source | undefined;
 }
 
 /**
@@ -30,7 +30,7 @@ export interface UseDocumentOnceOptions {
  */
 export function useDocumentOnce<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(
     reference: DocumentReference<AppModelType, DbModelType> | undefined | null,
-    options?: UseDocumentOnceOptions,
+    options?: UseDocumentOnceOptions | undefined,
 ): UseDocumentOnceResult<AppModelType> {
     const { source = "default" } = options ?? {};