refactor: accept primitives in converted types

Author: posva

playground/src/pages/converter-with-number.vue

@@ -0,0 +1,25 @@
+<script setup lang="ts">
+import { collection, doc } from 'firebase/firestore'
+import { ref } from 'vue'
+import { firestoreBind, useCollection } from 'vuefire'
+import { useFirestore } from '@/firebase'
+
+const db = useFirestore()
+const numbers = useCollection(
+  collection(db, 'numbers').withConverter<number>({
+    toFirestore(n) {
+      return { n }
+    },
+    fromFirestore(snapshot) {
+      return snapshot.data().n as number
+    },
+  })
+)
+</script>
+
+<template>
+  <p>numbers:</p>
+  <ul>
+    <li v-for="num in numbers">{{ num }}</li>
+  </ul>
+</template>

playground/typed-router.d.ts

@@ -42,6 +42,12 @@ declare module 'vue-router/auto/routes' {
       Record<never, never>,
       Record<never, never>
     >
+    '/converter-with-number': RouteRecordInfo<
+      '/converter-with-number',
+      '/converter-with-number',
+      Record<never, never>,
+      Record<never, never>
+    >
     '/nested-collections': RouteRecordInfo<
       '/nested-collections',
       '/nested-collections',

src/firestore/index.ts

@@ -198,6 +198,11 @@ export function bindCollection<T>(
   extraOptions: FirestoreOptions = DEFAULT_OPTIONS
 ) {
   const options = Object.assign({}, DEFAULT_OPTIONS, extraOptions) // fill default values
+  // a custom converter means we don't need a serializer
+  if (collection.converter) {
+    // @ts-expect-error: FIXME: remove this serialize option
+    options.serialize = v => v.data()
+  }
   const key = 'value'
   if (!options.wait) ops.set(target, key, [])
   let arrayRef = ref(options.wait ? [] : target[key])

src/firestore/utils.ts

@@ -24,10 +24,13 @@ export function createSnapshot<T = DocumentData>(
 export type FirestoreSerializer = typeof createSnapshot
 
 export function extractRefs(
+  // FIXME: unknown
   doc: DocumentData,
   oldDoc: DocumentData | void,
   subs: Record<string, { path: string; data: () => DocumentData | null }>
 ): [DocumentData, Record<string, DocumentReference>] {
+  if (!isObject(doc)) return [doc, {}]
+
   const dataAndRefs: [DocumentData, Record<string, DocumentReference>] = [
     {},
     {},