refactor: types and deprecations

Author: posva

src/firestore/optionsApi.ts

@@ -6,29 +6,18 @@ import type {
 } from 'firebase/firestore'
 import { App, ComponentPublicInstance, effectScope, toRef } from 'vue'
 import { isVue3 } from 'vue-demi'
-import {
-  bindCollection,
-  bindDocument,
-  firestoreOptions,
-  FirestoreRefOptions,
-  _GlobalFirestoreRefOptions,
-} from './subscribe'
+import { FirestoreRefOptions, _GlobalFirestoreRefOptions } from './subscribe'
 import { internalUnbind, _useFirestoreRef } from '.'
-import { ResetOption, UnbindWithReset } from '../shared'
-import { firebaseApp } from '../../tests/utils'
+import { ResetOption, UnbindWithReset, _FirestoreDataSource } from '../shared'
 import { FirebaseApp } from 'firebase/app'
 import { getGlobalScope } from '../globals'
 import { useFirebaseApp } from '../app'
 
-export type VueFirestoreObject = Record<
-  string,
-  DocumentReference<unknown> | Query<unknown> | CollectionReference<unknown>
->
+// TODO: this should be an entry point to generate the corresponding .d.ts file that only gets included if the plugin is imported
 
+export type VueFirestoreObject = Record<string, _FirestoreDataSource>
 export type FirestoreOption = VueFirestoreObject | (() => VueFirestoreObject)
 
-// TODO: this should be an entry point to generate the corresponding .d.ts file that only gets included if the plugin is imported
-
 export const firestoreUnbinds = new WeakMap<
   object,
   Record<string, UnbindWithReset>
@@ -40,7 +29,14 @@ export const firestoreUnbinds = new WeakMap<
  */
 export interface FirestorePluginOptions
   extends Partial<_GlobalFirestoreRefOptions> {
+  /**
+   * @deprecated: was largely unused and not very useful. Please open an issue with use cases if you need this.
+   */
   bindName?: string
+
+  /**
+   * @deprecated: was largely unused and not very useful. Please open an issue with use cases if you need this.
+   */
   unbindName?: string
 }
 
@@ -90,10 +86,7 @@ export const firestorePlugin = function firestorePlugin(
   GlobalTarget[bindName] = function firestoreBind(
     this: ComponentPublicInstance,
     key: string,
-    docOrCollectionRef:
-      | Query<unknown>
-      | CollectionReference<unknown>
-      | DocumentReference<unknown>,
+    docOrCollectionRef: _FirestoreDataSource,
     userOptions?: FirestoreRefOptions
   ) {
     const options = Object.assign({}, globalOptions, userOptions)
@@ -195,20 +188,17 @@ declare module '@vue/runtime-core' {
      * @param reference
      * @param options
      */
-    $firestoreBind(
+    $firestoreBind<T = DocumentData>(
       name: string,
-      // TODO: create proper overloads with generics like in the composition API
-      reference: Query<unknown> | CollectionReference<unknown>,
+      reference: Query<T> | CollectionReference<T>,
       options?: FirestoreRefOptions
-      // TODO: match the promise with the type of internalBind
-    ): Promise<DocumentData[]>
+    ): Promise<T[]>
 
-    $firestoreBind(
+    $firestoreBind<T = DocumentData>(
       name: string,
-      // TODO: create proper overloads with generics like in the composition API
-      reference: DocumentReference<unknown>,
+      reference: DocumentReference<T>,
       options?: FirestoreRefOptions
-    ): Promise<DocumentData>
+    ): Promise<T>
 
     /**
      * Unbinds a bound reference

src/shared.ts

@@ -128,7 +128,8 @@ export function isFirestoreDataReference<T = unknown>(
 
 export function isFirestoreQuery(
   source: unknown
-): source is FirestoreQuery<unknown> & { path: undefined } { // makes some types so much easier
+): source is FirestoreQuery<unknown> & { path: undefined } {
+  // makes some types so much easier
   return isObject(source) && source.type === 'query'
 }
 
@@ -175,6 +176,11 @@ export function callOnceWithArg<T, K>(
   }
 }
 
+export type _FirestoreDataSource =
+  | DocumentReference<unknown>
+  | CollectionReference<unknown>
+  | FirestoreQuery<unknown>
+
 /**
  * @internal
  */

src/ssr/initialState.ts

@@ -11,6 +11,7 @@ import {
   isDatabaseReference,
   isFirestoreDataReference,
   isFirestoreQuery,
+  _FirestoreDataSource,
   _Nullable,
 } from '../shared'
 
@@ -52,14 +53,9 @@ export function useSSRInitialState(
   return initialStatesMap.get(firebaseApp)!
 }
 
-type FirestoreDataSource =
-  | DocumentReference<unknown>
-  | CollectionReference<unknown>
-  | FirestoreQuery<unknown>
-
 export function getInitialValue(
   dataSource: _Nullable<
-    FirestoreDataSource | DatabaseReference | DatabaseQuery
+    _FirestoreDataSource | DatabaseReference | DatabaseQuery
   >,
   ssrKey: string | undefined,
   fallbackValue: unknown
@@ -81,7 +77,7 @@ export function getInitialValue(
 
 export function deferInitialValueSetup(
   dataSource: _Nullable<
-    FirestoreDataSource | DatabaseReference | DatabaseQuery
+    _FirestoreDataSource | DatabaseReference | DatabaseQuery
   >,
   ssrKey: string | undefined | null,
   promise: Promise<unknown>
@@ -103,7 +99,7 @@ export function deferInitialValueSetup(
 }
 
 function getDataSourceInfo(
-  dataSource: FirestoreDataSource | DatabaseReference | DatabaseQuery
+  dataSource: _FirestoreDataSource | DatabaseReference | DatabaseQuery
 ) {
   return isFirestoreDataReference(dataSource) || isFirestoreQuery(dataSource)
     ? (['f', dataSource.path] as const)