types: improve inference

Author: posva

src/firestore/index.ts

@@ -16,7 +16,8 @@ import {
   _UseFirestoreRefOptions,
 } from './useFirestoreRef'
 
-export interface UseCollectionOptions extends _UseFirestoreRefOptions {}
+export interface UseCollectionOptions<TData = unknown>
+  extends _UseFirestoreRefOptions<TData> {}
 export type { _RefFirestore, VueFirestoreDocumentData, VueFirestoreQueryData }
 
 /**
@@ -31,7 +32,7 @@ export function useCollection<
   R extends CollectionReference<unknown> | Query<unknown>
 >(
   collectionRef: MaybeRefOrGetter<_Nullable<R>>,
-  options?: UseCollectionOptions
+  options?: UseCollectionOptions<_InferReferenceType<R>[]>
 ): _RefFirestore<_InferReferenceType<R>[]>
 
 /**
@@ -43,15 +44,17 @@ export function useCollection<
  * @param options - optional options
  */
 export function useCollection<T>(
-  collectionRef: MaybeRefOrGetter<_Nullable<CollectionReference | Query>>,
-  options?: UseCollectionOptions
+  collectionRef: MaybeRefOrGetter<
+    _Nullable<CollectionReference<unknown> | Query<unknown>>
+  >,
+  options?: UseCollectionOptions<T[]>
 ): _RefFirestore<VueFirestoreQueryData<T>>
 
 export function useCollection<T>(
   collectionRef: MaybeRefOrGetter<
     _Nullable<CollectionReference<unknown> | Query<unknown>>
   >,
-  options?: UseCollectionOptions
+  options?: UseCollectionOptions<T[]>
 ): _RefFirestore<VueFirestoreQueryData<T>> {
   return _useFirestoreRef(collectionRef, {
     target: ref([]),

src/firestore/useFirestoreRef.ts

@@ -31,6 +31,7 @@ import {
   OperationsType,
   walkSet,
   _RefWithState,
+  _Simplify,
 } from '../shared'
 import { getInitialValue } from '../ssr/initialState'
 import { addPendingPromise } from '../ssr/plugin'
@@ -234,7 +235,7 @@ export type VueFirestoreDocumentData<T = DocumentData> =
     })
 
 export type VueFirestoreQueryData<T = DocumentData> = Array<
-  Exclude<VueFirestoreDocumentData<T>, null>
+  _Simplify<NonNullable<VueFirestoreDocumentData<T>>>
 >
 
 /**

tests/database/objects.spec.ts

@@ -289,16 +289,14 @@ describe('Database objects', () => {
   tds(() => {
     const db = database
     const databaseRef = _databaseRef
-    expectType<Ref<unknown>>(useDatabaseObject(databaseRef(db, 'todo')))
-    expectType<Ref<{ name: string } | null | undefined>>(
-      useDatabaseObject<{ name: string }>(databaseRef(db, 'todo'))
-    )
-    expectType<undefined | string>(
-      useDatabaseObject(databaseRef(db, 'todo')).value?.id
-    )
-    expectType<Ref<number | null | undefined>>(
+
+    expectTypeOf(
+      useDatabaseObject(databaseRef(db, 'todo')).value!.id
+    ).toBeString()
+
+    expectTypeOf(
       useDatabaseObject<number>(databaseRef(db, 'todo'))
-    )
+    ).toMatchTypeOf<Ref<number | null | undefined>>()
 
     expectTypeOf(useDatabaseObject(databaseRef(db, 'oh'))).toMatchTypeOf<
       Ref<unknown>

tests/firestore/collection.spec.ts

@@ -1,5 +1,5 @@
 import { mount } from '@vue/test-utils'
-import { describe, expect, it } from 'vitest'
+import { describe, expect, expectTypeOf, it } from 'vitest'
 import {
   collection as originalCollection,
   CollectionReference,
@@ -40,7 +40,7 @@ describe(
       options,
       ref = collection(),
     }: {
-      options?: UseCollectionOptions
+      options?: UseCollectionOptions<T[]>
       ref?: MaybeRefOrGetter<_Nullable<CollectionReference<T>>>
     } = {}) {
       let data!: _RefFirestore<VueFirestoreQueryData<T>>
@@ -79,7 +79,7 @@ describe(
       options,
       ref,
     }: {
-      options?: UseCollectionOptions
+      options?: UseCollectionOptions<AppModelType[]>
       ref?: MaybeRefOrGetter<_Nullable<Query<AppModelType, DbModelType>>>
     } = {}) {
       let data!: _RefFirestore<VueFirestoreQueryData<AppModelType>>
@@ -88,7 +88,6 @@ describe(
         defineComponent({
           template: 'no',
           setup() {
-            // @ts-expect-error: generic forced
             data = useCollection(
               // split for ts
               ref,
@@ -490,7 +489,17 @@ describe(
         // @ts-expect-error: no id with custom converter
       ).value[0].id
 
-      expectType<Ref<TodoI[]>>(useCollection<TodoI>(collection(db, 'todos')))
+      expectTypeOf(useCollection<TodoI>(collection(db, 'todos'))).toMatchTypeOf<
+        Ref<TodoI[]>
+      >()
+
+      // TODO: can this be improved to not have the generic
+      expectTypeOf(
+        useCollection<TodoI>(collection(db, 'todos'), {
+          target: ref<TodoI[]>([]),
+        })
+      ).toMatchTypeOf<Ref<TodoI[]>>()
+
       expectType<Ref<TodoI[]>>(
         useCollection<TodoI>(collection(db, 'todos')).data
       )

tests/firestore/refs-in-collections.spec.ts

@@ -22,7 +22,7 @@ describe('Firestore refs in collections', async () => {
     options,
     ref = collection(),
   }: {
-    options?: UseCollectionOptions
+    options?: UseCollectionOptions<T[]>
     ref?: MaybeRefOrGetter<CollectionReference<T>>
   } = {}) {
     let data!: _RefFirestore<VueFirestoreQueryData<T>>

tests/firestore/refs-in-documents.spec.ts

@@ -18,7 +18,7 @@ describe('Firestore refs in documents', async () => {
     options,
     ref = doc(),
   }: {
-    options?: UseDocumentOptions
+    options?: UseDocumentOptions<T>
     ref?: MaybeRefOrGetter<DocumentReference<T>>
   } = {}) {
     let data!: _RefFirestore<VueFirestoreDocumentData<T>>