feat: add global options

Author: posva

src/database/subscribe.ts

@@ -8,6 +8,7 @@ import {
   OperationsType,
   ResetOption,
   _DataSourceOptions,
+  _ResolveRejectFn,
 } from '../shared'
 import { ref, Ref, unref } from 'vue-demi'
 import type { Query, DatabaseReference } from 'firebase/database'
@@ -21,15 +22,20 @@ import {
 
 /**
  * Global option type when binding one database reference
+ * @internal
  */
 export interface _DatabaseRefOptions extends _DataSourceOptions {
+  /**
+   * Function to transform snapshots into data. By default it will
+   */
   serialize?: DatabaseSnapshotSerializer
 }
 
 /**
  * Global defaults type override options for all database bindings.
+ * @internal
  */
-interface _DefaultsDatabaseRefOptions extends _DatabaseRefOptions {
+interface _DatabaseRefOptionsWithDefaults extends _DatabaseRefOptions {
   /**
    * @defaultValue `false`
    */
@@ -42,7 +48,7 @@ interface _DefaultsDatabaseRefOptions extends _DatabaseRefOptions {
   serialize: DatabaseSnapshotSerializer
 }
 
-const DEFAULT_OPTIONS: _DefaultsDatabaseRefOptions = {
+const DEFAULT_OPTIONS: _DatabaseRefOptionsWithDefaults = {
   reset: false,
   serialize: createRecordFromDatabaseSnapshot,
   wait: true,
@@ -52,8 +58,8 @@ export { DEFAULT_OPTIONS as databaseOptionsDefaults }
 
 interface CommonBindOptionsParameter {
   target: Ref<any>
-  resolve: (value: any) => void
-  reject: (error: any) => void
+  resolve: _ResolveRejectFn
+  reject: _ResolveRejectFn
   ops: OperationsType
 }
 

src/firestore/optionsApi.ts

@@ -6,7 +6,7 @@ import type {
 } from 'firebase/firestore'
 import { App, ComponentPublicInstance, effectScope, toRef } from 'vue-demi'
 import { isVue3 } from 'vue-demi'
-import { FirestoreRefOptions } from './subscribe'
+import { firestoreOptionsDefaults, FirestoreRefOptions } from './subscribe'
 import { internalUnbind, _useFirestoreRef } from '.'
 import { ResetOption, UnbindWithReset, _FirestoreDataSource } from '../shared'
 import { FirebaseApp } from 'firebase/app'

src/firestore/subscribe.ts

@@ -35,12 +35,6 @@ export interface FirestoreRefOptions extends _DataSourceOptions {
    */
   maxRefDepth?: number
 
-  /**
-   * Should the data be fetched once rather than subscribing to changes.
-   * @experimental Still under development
-   */
-  once?: boolean
-
   /**
    * @inheritDoc {SnapshotOptions}
    */
@@ -61,7 +55,7 @@ export interface FirestoreRefOptions extends _DataSourceOptions {
  * Type of the global options for firestore refs. Some values cannot be `undefined`.
  * @internal
  */
-interface _DefaultsFirestoreRefOptions extends FirestoreRefOptions {
+interface _FirestoreRefOptionsWithDefaults extends FirestoreRefOptions {
   /**
    * @defaultValue `false`
    */
@@ -82,7 +76,10 @@ interface _DefaultsFirestoreRefOptions extends FirestoreRefOptions {
   converter: FirestoreDataConverter<unknown>
 }
 
-const DEFAULT_OPTIONS: _DefaultsFirestoreRefOptions = {
+/**
+ * Global default options
+ */
+const DEFAULT_OPTIONS: _FirestoreRefOptionsWithDefaults = {
   reset: false,
   wait: true,
   maxRefDepth: 2,
@@ -106,7 +103,7 @@ function unsubscribeAll(subs: Record<string, FirestoreSubscription>) {
 }
 
 function updateDataFromDocumentSnapshot<T>(
-  options: _DefaultsFirestoreRefOptions,
+  options: _FirestoreRefOptionsWithDefaults,
   target: Ref<T>,
   path: string,
   snapshot: DocumentSnapshot<T>,
@@ -157,7 +154,7 @@ function subscribeToDocument(
     reject,
     ops,
   }: SubscribeToDocumentParameter,
-  options: _DefaultsFirestoreRefOptions
+  options: _FirestoreRefOptionsWithDefaults
 ) {
   const subs = Object.create(null)
   let unbind = noop
@@ -213,7 +210,7 @@ function subscribeToDocument(
 // first one is calling the other on every ref and subscribeToDocument may call
 // updateDataFromDocumentSnapshot which may call subscribeToRefs as well
 function subscribeToRefs(
-  options: _DefaultsFirestoreRefOptions,
+  options: _FirestoreRefOptionsWithDefaults,
   target: Ref<unknown>,
   path: string | number,
   subs: Record<string, FirestoreSubscription>,

src/index.ts

@@ -4,6 +4,7 @@ import { _FirebaseAppInjectionKey } from './app'
 
 // Database
 export { useList, useObject, useDatabase } from './database'
+export { databaseOptionsDefaults as globalDatabaseOptions } from './database/subscribe'
 export type {
   UseListOptions,
   UseObjectOptions,
@@ -18,6 +19,7 @@ export type {
 
 // Firestore
 export { useCollection, useDocument, useFirestore } from './firestore'
+export { firestoreOptionsDefaults as globalFirestoreOptions } from './firestore/subscribe'
 export { firestoreDefaultConverter } from './firestore/utils'
 export type {
   UseCollectionOptions,
@@ -82,6 +84,9 @@ export {
  * Options for VueFire Vue plugin.
  */
 export interface VueFireOptions {
+  /**
+   * The firebase app used by VueFire and associated with the different modules.
+   */
   firebaseApp: FirebaseApp
 
   /**

src/shared.ts

@@ -224,6 +224,7 @@ export type _MaybeRef<T> = T | Ref<T>
 
 /**
  * Base options for the data source options in both Firestore and Realtime Database.
+ *
  * @internal
  */
 export interface _DataSourceOptions {
@@ -248,6 +249,12 @@ export interface _DataSourceOptions {
    * nested refs.
    */
   wait?: boolean
+
+  /**
+   * Should the data be fetched once rather than subscribing to changes.
+   * @experimental Still under development
+   */
+  once?: boolean
 }
 
 /**