refactor: add notes

Author: posva

Diff for: packages/@posva/vuefire-core/src/firestore/index.ts

@@ -28,7 +28,7 @@ function unsubscribeAll(subs: Record<string, FirestoreSubscription>) {
 }
 
 interface UpdateDataFromDocumentSnapshot {
-  snapshot: firestore.DocumentSnapshot
+  readonly snapshot: firestore.DocumentSnapshot
   subs: Record<string, FirestoreSubscription>
   target: CommonBindOptionsParameter['vm']
   path: string
@@ -41,6 +41,7 @@ function updateDataFromDocumentSnapshot(
   { snapshot, target, path, subs, ops, depth, resolve }: UpdateDataFromDocumentSnapshot,
   options: Required<FirestoreOptions>
 ) {
+  // TODO: maybe we should options.serialize the snapshot here
   const [data, refs] = extractRefs(snapshot, walkGet(target, path))
   // NOTE use ops
   ops.set(target, path, data)

Diff for: packages/@posva/vuefire-core/src/firestore/utils.ts

@@ -21,11 +21,13 @@ export function extractRefs(
 ): [firestore.DocumentData, Record<string, firestore.DocumentReference>] {
   // must be set here because walkGet can return null or undefined
   oldDoc = oldDoc || {}
+  const [data, refs] = result
+  // TODO: this won't work if the user defines their own defined properties
+  // should we do it for every non enumerable property?
   const idDescriptor = Object.getOwnPropertyDescriptor(doc, 'id')
   if (idDescriptor && !idDescriptor.enumerable) {
-    Object.defineProperty(result[0], 'id', idDescriptor)
+    Object.defineProperty(data, 'id', idDescriptor)
   }
-  const [data, refs] = result
   for (const key in doc) {
     const ref = doc[key]
     // if it's a ref