fix: an issue where a doc initialised with empty string would return the collection .data instead

Author: mesqueeb

packages/plugin-firestore-admin/src/actions/fetch.ts

@@ -10,11 +10,12 @@ import {
   getFirestoreDocPath,
 } from '@magnetarjs/utils-firestore'
 import type { DocumentSnapshot, QueryDocumentSnapshot } from 'firebase-admin/firestore'
+import { isString } from 'is-what'
 import { FirestoreAdminPluginOptions } from '../CreatePlugin.js'
 import { docSnapshotToDocMetadata, getQueryInstance } from '../helpers/getFirestore.js'
 
 export function fetchActionFactory(
-  firestorePluginOptions: Required<FirestoreAdminPluginOptions>
+  firestorePluginOptions: Required<FirestoreAdminPluginOptions>,
 ): PluginFetchAction {
   return async function ({
     payload,
@@ -25,7 +26,7 @@ export function fetchActionFactory(
     const { db } = firestorePluginOptions
     // in case of a doc module
     let snapshots: (DocumentSnapshot | QueryDocumentSnapshot)[] | undefined
-    if (docId) {
+    if (isString(docId)) {
       const documentPath = getFirestoreDocPath(collectionPath, docId, pluginModuleConfig, firestorePluginOptions) // prettier-ignore
       const docSnapshot = await db.doc(documentPath).get()
       snapshots = [docSnapshot]

packages/plugin-firestore-admin/src/actions/stream.ts

@@ -9,6 +9,7 @@ import {
   getFirestoreDocPath,
 } from '@magnetarjs/utils-firestore'
 import type { DocumentChange, DocumentSnapshot, QuerySnapshot } from 'firebase-admin/firestore'
+import { isString } from 'is-what'
 import { FirestoreAdminPluginOptions } from '../CreatePlugin.js'
 import { docSnapshotToDocMetadata, getQueryInstance } from '../helpers/getFirestore.js'
 
@@ -38,7 +39,7 @@ export function streamActionFactory(
     let firstDataReceived = false
 
     // in case of a doc module
-    if (docId) {
+    if (isString(docId)) {
       const documentPath = getFirestoreDocPath(collectionPath, docId, pluginModuleConfig, firestorePluginOptions) // prettier-ignore
       closeStream = db
         .doc(documentPath)

packages/plugin-firestore/src/actions/fetch.ts

@@ -12,11 +12,12 @@ import {
 } from '@magnetarjs/utils-firestore'
 import type { DocumentSnapshot, QueryDocumentSnapshot } from 'firebase/firestore'
 import { doc, getDoc, getDocs } from 'firebase/firestore'
+import { isString } from 'is-what'
 import { FirestorePluginOptions } from '../CreatePlugin.js'
 import { docSnapshotToDocMetadata, getQueryInstance } from '../helpers/getFirestore.js'
 
 export function fetchActionFactory(
-  firestorePluginOptions: Required<FirestorePluginOptions>
+  firestorePluginOptions: Required<FirestorePluginOptions>,
 ): PluginFetchAction {
   return async function ({
     payload,
@@ -27,7 +28,7 @@ export function fetchActionFactory(
     const { db, debug } = firestorePluginOptions
     // in case of a doc module
     let snapshots: (DocumentSnapshot | QueryDocumentSnapshot)[] | undefined
-    if (docId) {
+    if (isString(docId)) {
       const documentPath = getFirestoreDocPath(collectionPath, docId, pluginModuleConfig, firestorePluginOptions) // prettier-ignore
       const query = doc(db, documentPath)
       const warnNoResponse = debug

packages/plugin-firestore/src/actions/stream.ts

@@ -10,6 +10,7 @@ import {
 } from '@magnetarjs/utils-firestore'
 import type { DocumentChange, DocumentSnapshot, QuerySnapshot } from 'firebase/firestore'
 import { doc, onSnapshot } from 'firebase/firestore'
+import { isString } from 'is-what'
 import { FirestorePluginOptions } from '../CreatePlugin.js'
 import { docSnapshotToDocMetadata, getQueryInstance } from '../helpers/getFirestore.js'
 
@@ -39,7 +40,7 @@ export function streamActionFactory(
     let firstDataReceived = false
 
     // in case of a doc module
-    if (docId) {
+    if (isString(docId)) {
       const documentPath = getFirestoreDocPath(collectionPath, docId, pluginModuleConfig, firestorePluginOptions) // prettier-ignore
       closeStream = onSnapshot(
         doc(db, documentPath),

packages/plugin-simple-store/src/CreatePlugin.ts

@@ -9,7 +9,7 @@ import { getPathWhereIdentifier } from '@magnetarjs/types'
 import { filterDataPerClauses } from '@magnetarjs/utils'
 import { copy } from 'copy-anything'
 import { mapGetOrSet, objGetOrSet } from 'getorset-anything'
-import { isArray, isNumber, isPlainObject } from 'is-what'
+import { isArray, isNumber, isPlainObject, isString } from 'is-what'
 import { deleteActionFactory } from './actions/delete.js'
 import { deletePropActionFactory } from './actions/deleteProp.js'
 import { fetchActionFactory } from './actions/fetch.js'
@@ -122,7 +122,7 @@ export const CreatePlugin: MagnetarPlugin<SimpleStoreOptions> = (
   }: PluginModuleSetupPayload<SimpleStoreModuleConfig>): any => {
     const dataCollectionMap = objGetOrSet(data, collectionPath, () => new Map())
     // if it's a doc, return the specific doc
-    if (docId) return dataCollectionMap.get(docId)
+    if (isString(docId)) return dataCollectionMap.get(docId)
     // if it's a collection, we must return the dataCollectionMap but with applied query clauses
     // but remember, the return type MUST be a map with id as keys and the docs as value
     const clauses: Clauses = pluginModuleConfig

packages/plugin-vue3/src/CreatePlugin.ts

@@ -9,7 +9,7 @@ import { getPathWhereIdentifier } from '@magnetarjs/types'
 import { filterDataPerClauses } from '@magnetarjs/utils'
 import { copy } from 'copy-anything'
 import { mapGetOrSet, objGetOrSet } from 'getorset-anything'
-import { isArray, isNumber, isPlainObject } from 'is-what'
+import { isArray, isNumber, isPlainObject, isString } from 'is-what'
 import { reactive } from 'vue'
 import { deleteActionFactory } from './actions/delete.js'
 import { deletePropActionFactory } from './actions/deleteProp.js'
@@ -130,7 +130,7 @@ export const CreatePlugin: MagnetarPlugin<Vue3StoreOptions> = (
   }: PluginModuleSetupPayload<Vue3StoreModuleConfig>): any => {
     const dataCollectionMap = objGetOrSet(data, collectionPath, () => reactive(new Map()))
     // if it's a doc, return the specific doc
-    if (docId) return dataCollectionMap.get(docId)
+    if (isString(docId)) return dataCollectionMap.get(docId)
     // if it's a collection, we must return the dataCollectionMap but with applied query clauses
     // but remember, the return type MUST be a map with id as keys and the docs as value
     const clauses: Clauses = pluginModuleConfig

packages/test-utils/src/PluginLocalMock/CreatePlugin.ts

@@ -9,7 +9,7 @@ import { getPathWhereIdentifier } from '@magnetarjs/types'
 import { filterDataPerClauses } from '@magnetarjs/utils'
 import { copy } from 'copy-anything'
 import { mapGetOrSet, objGetOrSet } from 'getorset-anything'
-import { isArray, isNumber, isPlainObject } from 'is-what'
+import { isArray, isNumber, isPlainObject, isString } from 'is-what'
 import { deleteActionFactory } from './actions/delete.js'
 import { deletePropActionFactory } from './actions/deleteProp.js'
 import { fetchActionFactory } from './actions/fetch.js'
@@ -123,7 +123,7 @@ export const CreatePlugin: MagnetarPlugin<StorePluginOptions> = (
   }: PluginModuleSetupPayload<StorePluginModuleConfig>): any => {
     const dataCollectionMap = objGetOrSet(data, collectionPath, () => new Map())
     // if it's a doc, return the specific doc
-    if (docId) return dataCollectionMap.get(docId)
+    if (isString(docId)) return dataCollectionMap.get(docId)
     // if it's a collection, we must return the dataCollectionMap but with applied query clauses
     // but remember, the return type MUST be a map with id as keys and the docs as value
     const clauses: Clauses = pluginModuleConfig

packages/test-utils/src/PluginRemoteMock/actions.ts

@@ -26,7 +26,7 @@ import type {
   StreamResponse,
 } from '@magnetarjs/types'
 import { filterDataPerClauses } from '@magnetarjs/utils'
-import { isFullArray, isFullString, isNumber, isPromise } from 'is-what'
+import { isFullArray, isFullString, isNumber, isPromise, isString } from 'is-what'
 import { getProp } from 'path-to-prop'
 import { generateRandomId, pokedexMap, throwIfEmulatedError, waitMs } from '../helpers/index.js'
 import { RemoteStoreOptions, StorePluginModuleConfig } from './index.js'
@@ -115,7 +115,7 @@ function mockDataRetrieval(
   if (collectionPath === 'pokedex') {
     const _pokedexMap = pokedexMap()
 
-    if (docId) {
+    if (isString(docId)) {
       const result = _pokedexMap.get(docId)
       return result ? [result] : []
     }