feat: allow getters to functions

This change allows replacing usage of `computed()` in `useDocument()`
and similar with just a function:

```ts
// from
useDocument(computed(() => doc(db, 'users', userId)))
// to
useDocument(() => doc(db, 'users', userId))
```

Author: posva

src/auth/user.ts

@@ -10,7 +10,7 @@ import {
 } from 'firebase/auth'
 import { computed, Ref } from 'vue-demi'
 import { useFirebaseApp } from '../app'
-import type { _MaybeRef, _Nullable } from '../shared'
+import type { _Nullable } from '../shared'
 
 /**
  * Maps an application to a user

src/database/bind.ts

@@ -8,10 +8,9 @@ import {
   noop,
   ResetOption,
   _DataSourceOptions,
-  _MaybeRef,
   _ResolveRejectFn,
 } from '../shared'
-import { Ref, unref } from 'vue-demi'
+import { Ref, toValue, MaybeRefOrGetter } from 'vue-demi'
 import {
   onValue,
   onChildAdded,
@@ -117,7 +116,9 @@ export function bindAsArray(
 ) {
   const options = Object.assign({}, DEFAULT_OPTIONS, extraOptions)
 
-  let arrayRef: _MaybeRef<VueDatabaseQueryData> = options.wait ? [] : target
+  let arrayRef: MaybeRefOrGetter<VueDatabaseQueryData> = options.wait
+    ? []
+    : target
   // by default we wait, if not, set the value to an empty array so it can be populated correctly
   if (!options.wait) {
     target.value = []
@@ -146,7 +147,7 @@ export function bindAsArray(
     removeChildAddedListener = onChildAdded(
       collection,
       (snapshot, prevKey) => {
-        const array = unref(arrayRef)
+        const array = toValue(arrayRef)
         const index = prevKey ? indexForKey(array, prevKey) + 1 : 0
         // cannot be null because it exists
         array.splice(index, 0, options.serialize(snapshot)!)
@@ -158,7 +159,7 @@ export function bindAsArray(
       collection,
 
       (snapshot) => {
-        const array = unref(arrayRef)
+        const array = toValue(arrayRef)
         array.splice(indexForKey(array, snapshot.key), 1)
       },
       reject
@@ -167,7 +168,7 @@ export function bindAsArray(
     removeChildChangedListener = onChildChanged(
       collection,
       (snapshot) => {
-        const array = unref(arrayRef)
+        const array = toValue(arrayRef)
         array.splice(
           indexForKey(array, snapshot.key),
           1,
@@ -181,7 +182,7 @@ export function bindAsArray(
     removeChildMovedListener = onChildMoved(
       collection,
       (snapshot, prevKey) => {
-        const array = unref(arrayRef)
+        const array = toValue(arrayRef)
         const index = indexForKey(array, snapshot.key)
         const oldRecord = array.splice(index, 1)[0]
         const newIndex = prevKey ? indexForKey(array, prevKey) + 1 : 0
@@ -194,7 +195,7 @@ export function bindAsArray(
     removeValueListener = onValue(
       collection,
       () => {
-        const array = unref(arrayRef)
+        const array = toValue(arrayRef)
         if (options.wait) {
           target.value = array
           // switch to the target so all changes happen into the target

src/database/index.ts

@@ -1,6 +1,6 @@
-import { Ref, ref } from 'vue-demi'
+import { Ref, ref, MaybeRefOrGetter } from 'vue-demi'
 import { DatabaseReference, getDatabase, Query } from 'firebase/database'
-import { _MaybeRef, _Nullable, _RefWithState } from '../shared'
+import { _Nullable, _RefWithState } from '../shared'
 import { _DatabaseRefOptions } from './bind'
 import {
   VueDatabaseDocumentData,
@@ -24,7 +24,7 @@ export type UseListOptions = UseDatabaseRefOptions
  * @param options - optional options
  */
 export function useDatabaseList<T = unknown>(
-  reference: _MaybeRef<DatabaseReference | Query>,
+  reference: MaybeRefOrGetter<DatabaseReference | Query>,
   options?: UseListOptions
 ): _RefDatabase<VueDatabaseQueryData<T>> {
   const data = ref<T[]>([]) as Ref<T[]>
@@ -54,7 +54,7 @@ export type UseObjectOptions = UseDatabaseRefOptions
  * @param options - optional options
  */
 export function useDatabaseObject<T = unknown>(
-  reference: _MaybeRef<DatabaseReference>,
+  reference: MaybeRefOrGetter<DatabaseReference>,
   options?: UseObjectOptions
 ): _RefDatabase<VueDatabaseDocumentData<T> | undefined> {
   const data = ref<T | null>()

src/database/useDatabaseRef.ts

@@ -1,6 +1,7 @@
 import type { DatabaseReference, Query } from 'firebase/database'
 import {
-  unref,
+  MaybeRefOrGetter,
+  toValue,
   ref,
   shallowRef,
   ShallowRef,
@@ -14,7 +15,6 @@ import {
 } from 'vue-demi'
 import { useFirebaseApp } from '../app'
 import {
-  _MaybeRef,
   _Nullable,
   UnbindWithReset,
   checkWrittenTarget,
@@ -38,13 +38,13 @@ import { _RefDatabase } from './utils'
 export interface UseDatabaseRefOptions extends _DatabaseRefOptions {}
 
 export function _useDatabaseRef(
-  reference: _MaybeRef<_Nullable<DatabaseReference | Query>>,
+  reference: MaybeRefOrGetter<_Nullable<DatabaseReference | Query>>,
   localOptions: UseDatabaseRefOptions = {},
   isList = false
 ): _RefDatabase<unknown> {
   let unbind: UnbindWithReset = noop
   const options = Object.assign({}, globalDatabaseOptions, localOptions)
-  const initialSourceValue = unref(reference)
+  const initialSourceValue = toValue(reference)
   const data = options.target || ref<unknown | null>()
 
   // dev only warning
@@ -88,7 +88,7 @@ export function _useDatabaseRef(
   let removePendingPromise = noop
 
   function bindDatabaseRef() {
-    const referenceValue = unref(reference)
+    const referenceValue = toValue(reference)
 
     const newPromise = new Promise<unknown | null>((resolve, reject) => {
       unbind(options.reset)

src/firestore/bind.ts

@@ -3,13 +3,12 @@ import {
   walkGet,
   callOnceWithArg,
   OperationsType,
-  _MaybeRef,
   ResetOption,
   _DataSourceOptions,
   noop,
   _ResolveRejectFn,
 } from '../shared'
-import { ref, Ref, unref } from 'vue-demi'
+import { ref, Ref, toValue } from 'vue-demi'
 import type {
   CollectionReference,
   DocumentChange,
@@ -323,7 +322,7 @@ export function bindCollection<T = unknown>(
         subs,
         options
       )
-      ops.add(unref(arrayRef), newIndex, data)
+      ops.add(toValue(arrayRef), newIndex, data)
       subscribeToRefs(
         options,
         arrayRef,
@@ -337,7 +336,7 @@ export function bindCollection<T = unknown>(
       )
     },
     modified: ({ oldIndex, newIndex, doc }: DocumentChange<T>) => {
-      const array = unref(arrayRef)
+      const array = toValue(arrayRef)
       const subs = arraySubs[oldIndex]
       const oldData = array[oldIndex]
       const [data, refs] = extractRefs(
@@ -365,7 +364,7 @@ export function bindCollection<T = unknown>(
       )
     },
     removed: ({ oldIndex }: DocumentChange<T>) => {
-      const array = unref(arrayRef)
+      const array = toValue(arrayRef)
       ops.remove(array, oldIndex)
       unsubscribeAll(arraySubs.splice(oldIndex, 1)[0])
     },
@@ -396,10 +395,10 @@ export function bindCollection<T = unknown>(
           if (++count >= expectedItems) {
             // if wait is true, finally set the array
             if (wait) {
-              ops.set(target, key, unref(arrayRef))
+              ops.set(target, key, toValue(arrayRef))
               arrayRef = target
             }
-            originalResolve(unref(arrayRef))
+            originalResolve(toValue(arrayRef))
             // reset resolve to noop
             resolve = noop
           }
@@ -417,10 +416,10 @@ export function bindCollection<T = unknown>(
     // being called multiple times
     if (!docChanges.length) {
       if (wait) {
-        ops.set(target, key, unref(arrayRef))
+        ops.set(target, key, toValue(arrayRef))
         arrayRef = target
       }
-      resolve(unref(arrayRef))
+      resolve(toValue(arrayRef))
     }
   }
 

src/firestore/index.ts

@@ -4,9 +4,9 @@ import {
   Query,
   getFirestore,
 } from 'firebase/firestore'
-import { ref } from 'vue-demi'
+import { ref, MaybeRefOrGetter } from 'vue-demi'
 import { useFirebaseApp } from '../app'
-import type { _MaybeRef, _Nullable, _RefWithState } from '../shared'
+import type { _Nullable, _RefWithState } from '../shared'
 import {
   VueFirestoreDocumentData,
   VueFirestoreQueryData,
@@ -30,7 +30,7 @@ export function useCollection<
   // explicit generic as unknown to allow arbitrary types like numbers or strings
   R extends CollectionReference<unknown> | Query<unknown>
 >(
-  collectionRef: _MaybeRef<_Nullable<R>>,
+  collectionRef: MaybeRefOrGetter<_Nullable<R>>,
   options?: UseCollectionOptions
 ): _RefFirestore<_InferReferenceType<R>[]>
 
@@ -43,12 +43,12 @@ export function useCollection<
  * @param options - optional options
  */
 export function useCollection<T>(
-  collectionRef: _MaybeRef<_Nullable<CollectionReference | Query>>,
+  collectionRef: MaybeRefOrGetter<_Nullable<CollectionReference | Query>>,
   options?: UseCollectionOptions
 ): _RefFirestore<VueFirestoreQueryData<T>>
 
 export function useCollection<T>(
-  collectionRef: _MaybeRef<
+  collectionRef: MaybeRefOrGetter<
     _Nullable<CollectionReference<unknown> | Query<unknown>>
   >,
   options?: UseCollectionOptions
@@ -71,7 +71,7 @@ export function useDocument<
   // explicit generic as unknown to allow arbitrary types like numbers or strings
   R extends DocumentReference<unknown>
 >(
-  documentRef: _MaybeRef<_Nullable<R>>,
+  documentRef: MaybeRefOrGetter<_Nullable<R>>,
   options?: UseDocumentOptions
 ): _RefFirestore<_InferReferenceType<R> | undefined> // this one can't be null or should be specified in the converter
 
@@ -84,12 +84,12 @@ export function useDocument<
  * @param options - optional options
  */
 export function useDocument<T>(
-  documentRef: _MaybeRef<_Nullable<DocumentReference>>,
+  documentRef: MaybeRefOrGetter<_Nullable<DocumentReference>>,
   options?: UseDocumentOptions
 ): _RefFirestore<VueFirestoreDocumentData<T> | undefined>
 
 export function useDocument<T>(
-  documentRef: _MaybeRef<_Nullable<DocumentReference<unknown>>>,
+  documentRef: MaybeRefOrGetter<_Nullable<DocumentReference<unknown>>>,
   options?: UseDocumentOptions
 ): _RefFirestore<VueFirestoreDocumentData<T> | undefined> {
   // no unwrapRef to have a simpler type

src/firestore/useFirestoreRef.ts

@@ -7,7 +7,8 @@ import type {
   FirestoreDataConverter,
 } from 'firebase/firestore'
 import {
-  unref,
+  MaybeRefOrGetter,
+  toValue,
   ref,
   shallowRef,
   ShallowRef,
@@ -20,7 +21,6 @@ import {
 } from 'vue-demi'
 import { useFirebaseApp } from '../app'
 import {
-  _MaybeRef,
   _Nullable,
   UnbindWithReset,
   noop,
@@ -57,7 +57,7 @@ const NO_INITIAL_VALUE = Symbol()
  * @internal
  */
 export function _useFirestoreRef(
-  docOrCollectionRef: _MaybeRef<
+  docOrCollectionRef: MaybeRefOrGetter<
     _Nullable<
       DocumentReference<unknown> | Query<unknown> | CollectionReference<unknown>
     >
@@ -66,7 +66,7 @@ export function _useFirestoreRef(
 ): _RefFirestore<unknown> {
   let unbind: UnbindWithReset = noop
   const options = Object.assign({}, firestoreOptionsDefaults, localOptions)
-  const initialSourceValue = unref(docOrCollectionRef)
+  const initialSourceValue = toValue(docOrCollectionRef)
   const data = options.target || ref<unknown | null>()
 
   // dev only warning
@@ -108,7 +108,7 @@ export function _useFirestoreRef(
   let removePendingPromise = noop
 
   function bindFirestoreRef() {
-    let docRefValue = unref(docOrCollectionRef)
+    let docRefValue = toValue(docOrCollectionRef)
 
     const newPromise = new Promise<unknown | null>((resolve, reject) => {
       // stop the previous subscription

src/shared.ts

@@ -223,11 +223,6 @@ export interface _RefWithState<T, E = Error> extends Ref<T> {
   stop: (reset?: ResetOption) => void
 }
 
-/**
- * @internal
- */
-export type _MaybeRef<T> = T | Ref<T>
-
 /**
  * Base options for the data source options in both Firestore and Realtime Database.
  *