fix: add ListenerSource type instead of literal union

Author: astanb

packages/firestore/lib/FirestoreDocumentReference.ts

@@ -38,7 +38,7 @@ import type DocumentSnapshot from './FirestoreDocumentSnapshot';
 import type { FirestoreInternal, FirestoreSyncEventBodyInternal } from './types/internal';
 import type { DocumentSnapshotNativeData } from './FirestoreDocumentSnapshot';
 import type FirestorePath from './FirestorePath';
-import type { DocumentData, FirestoreDataConverter } from './types/firestore';
+import type { DocumentData, FirestoreDataConverter, ListenSource } from './types/firestore';
 
 let FirestoreCollectionReference:
   | (new (
@@ -188,7 +188,7 @@ export default class DocumentReference {
   }
 
   onSnapshot(...args: unknown[]): () => void {
-    let snapshotListenOptions: { includeMetadataChanges?: boolean; source?: 'default' | 'cache' };
+    let snapshotListenOptions: { includeMetadataChanges?: boolean; source?: ListenSource };
     let callback: (snapshot: DocumentSnapshot | null, error: Error | null) => void;
     let onNext: (snapshot: DocumentSnapshot) => void;
     let onError: (error: Error) => void;

packages/firestore/lib/FirestoreQuery.ts

@@ -34,7 +34,7 @@ import QuerySnapshot, { type QuerySnapshotNativeData } from './FirestoreQuerySna
 import { parseSnapshotArgs, validateWithConverter } from './utils';
 
 import type FirestorePath from './FirestorePath';
-import type { DocumentData, FirestoreDataConverter } from './types/firestore';
+import type { DocumentData, FirestoreDataConverter, ListenSource } from './types/firestore';
 import type {
   FirestoreInternal,
   DocumentFieldValueInternal,
@@ -331,7 +331,7 @@ export default class Query {
   }
 
   onSnapshot(...args: unknown[]): () => void {
-    let snapshotListenOptions: { includeMetadataChanges?: boolean; source?: 'default' | 'cache' };
+    let snapshotListenOptions: { includeMetadataChanges?: boolean; source?: ListenSource };
     let callback: (snapshot: QuerySnapshot | null, error: Error | null) => void;
     let onNext: (snapshot: QuerySnapshot) => void;
     let onError: (error: Error) => void;

packages/firestore/lib/types/namespaced.ts

@@ -16,6 +16,7 @@
  */
 
 import { ReactNativeFirebase } from '@react-native-firebase/app';
+import type { ListenSource } from './firestore';
 
 /**
  * Firebase Cloud Firestore package for React Native.
@@ -1768,7 +1769,7 @@ export namespace FirebaseFirestoreTypes {
     /**
      * Set the source the query listens to. Default is 'default'.
      */
-    source?: 'default' | 'cache';
+    source?: ListenSource;
   }
 
   /**

packages/firestore/lib/utils/index.ts

@@ -31,6 +31,7 @@ import type {
   PartialSnapshotObserverInternal,
 } from '../types/internal';
 import FieldPath, { fromDotSeparatedString } from '../FieldPath';
+import type { ListenSource } from 'lib/types/firestore';
 
 export function extractFieldPathData(data: unknown, segments: string[]): unknown {
   if (!isObject(data)) {
@@ -153,7 +154,7 @@ function isPartialObserver(
 export interface ParseSnapshotArgsResult {
   snapshotListenOptions: {
     includeMetadataChanges?: boolean;
-    source?: 'default' | 'cache';
+    source?: ListenSource;
   };
   callback: (snapshot: unknown, error: Error | null) => void;
   onNext: (snapshot: unknown) => void;
@@ -168,7 +169,7 @@ export function parseSnapshotArgs(args: unknown[]): ParseSnapshotArgsResult {
   const NOOP = (): void => {};
   const snapshotListenOptions: {
     includeMetadataChanges?: boolean;
-    source?: 'default' | 'cache';
+    source?: ListenSource;
   } = {};
   let callback: (snapshot: unknown, error: Error | null) => void = NOOP;
   let onError: (error: Error) => void = NOOP;