@data-weave/backend-firestore 0.3.3 → 0.4.0

package/CHANGELOG.md

@@ -3,6 +3,35 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.0](https://github.com/data-weave/datamanager/compare/v0.3.8...v0.4.0) (2025-10-15)
+
+### Features
+
+- add error interceptor ([dde95c8](https://github.com/data-weave/datamanager/commit/dde95c8dba3d02d7861d132314db4d1cf23bec37))
+- add new typing, snapshot options and sane type defaults ([7095568](https://github.com/data-weave/datamanager/commit/7095568892048dc75cccc284e2dd2ba23793a152))
+- create shim for modular firebase as well ([591b25a](https://github.com/data-weave/datamanager/commit/591b25a8cbcf89687b3880cc3ca1cd95a735e11d))
+- move firebase-admin shim to it's own package ([ac9f861](https://github.com/data-weave/datamanager/commit/ac9f861ca810a2a14706e10e87674b1b1f14a964))
+
+## [0.3.8](https://github.com/data-weave/datamanager/compare/v0.3.7...v0.3.8) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/backend-firestore
+
+## [0.3.7](https://github.com/data-weave/datamanager/compare/v0.3.6...v0.3.7) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/backend-firestore
+
+## [0.3.6](https://github.com/data-weave/datamanager/compare/v0.3.5...v0.3.6) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/backend-firestore
+
+## [0.3.5](https://github.com/data-weave/datamanager/compare/v0.3.4...v0.3.5) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/backend-firestore
+
+## [0.3.4](https://github.com/data-weave/datamanager/compare/v0.3.3...v0.3.4) (2025-09-28)
+
+**Note:** Version bump only for package @data-weave/backend-firestore
+
 ## [0.3.3](https://github.com/data-weave/datamanager/compare/v0.3.2...v0.3.3) (2025-09-28)
 
 **Note:** Version bump only for package @data-weave/backend-firestore

package/lib/FirestoreDataManager.ts

@@ -4,14 +4,14 @@ import { Cache, MapCache } from '@data-weave/datamanager/lib/Cache'
 import { CreateOptions, DataManager, Metadata, WithMetadata } from '@data-weave/datamanager/lib/DataManager'
 import { List, ListPaginationParams } from '@data-weave/datamanager/lib/List'
 import { IdentifiableReference, WithoutId } from '@data-weave/datamanager/lib/Reference'
-import { FirestoreList } from './FirestoreList'
+import { FirestoreList, FirestoreListContext } from './FirestoreList'
 import {
     FIRESTORE_KEYS,
     FirestoreMetadataConverter,
     FirestoreSerializedMetadata,
     queryNotDeleted,
 } from './FirestoreMetadata'
-import { FirestoreReference } from './FirestoreReference'
+import { FirestoreReference, FirestoreReferenceContext } from './FirestoreReference'
 import {
     DocumentData,
     FilterBy,
@@ -35,6 +35,8 @@ export interface FirebaseDataManagerOptions {
     readonly deleteMode?: FirebaseDataManagerDeleteMode
     readonly readMode?: FirestoreReadMode
     readonly preventOverwriteOnCreate?: boolean
+    readonly errorInterceptor?: (error: unknown, ctx: FirestoreReferenceContext | FirestoreListContext) => void
+    readonly snapshotOptions?: FirestoreTypes.SnapshotOptions
     // TODO: Add preventUpdateIfNotExists?
     readonly Reference?: typeof FirestoreReference
     readonly List?: typeof FirestoreList
@@ -58,7 +60,7 @@ export interface QueryParams<T extends FirestoreTypes.DocumentData> {
 @injectable()
 export class FirestoreDataManager<
     T extends FirestoreTypes.DocumentData,
-    SerializedT extends FirestoreTypes.DocumentData,
+    SerializedT extends FirestoreTypes.DocumentData = T,
 > implements DataManager<T>
 {
     private mergedConverter: InternalFirestoreDataConverter<T & Metadata, SerializedT & FirestoreSerializedMetadata>
@@ -195,6 +197,8 @@ export class FirestoreDataManager<
 
         const newRef = new this.managerOptions.Reference(this.firestore, this.firestore.doc(this.collection, id), {
             readMode: this.managerOptions.readMode,
+            errorInterceptor: this.managerOptions.errorInterceptor,
+            snapshotOptions: this.managerOptions.snapshotOptions,
         })
         this.refCache.set(id, newRef)
         return newRef
@@ -225,6 +229,7 @@ export class FirestoreDataManager<
         }
         const newList = new this.managerOptions.List(this.firestore, compoundQuery, {
             readMode: this.managerOptions.readMode,
+            errorInterceptor: this.managerOptions.errorInterceptor,
             ...params,
         })
         this.listCache.set(key, newList)

package/lib/FirestoreList.ts

@@ -1,8 +1,15 @@
 import { ListPaginationParams, LiveList, LiveListOptions } from '@data-weave/datamanager'
 import { DocumentData, Firestore, FirestoreReadMode, FirestoreTypes } from './firestoreTypes'
 
+export interface FirestoreListContext {
+    query: FirestoreTypes.Query<unknown>
+    readMode?: FirestoreReadMode
+    type: 'list'
+}
+
 export interface FirestoreListOptions<T> extends LiveListOptions<T> {
     readMode?: FirestoreReadMode
+    errorInterceptor?: (error: unknown, ctx: FirestoreListContext) => void
 }
 
 export class FirestoreList<T extends DocumentData, S extends DocumentData> extends LiveList<T> {
@@ -79,6 +86,11 @@ export class FirestoreList<T extends DocumentData, S extends DocumentData> exten
         // Try to provide useful collection details using internal properties
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         console.error(`FirestoreList Collection: ${(this.query as any)?._collectionPath?.id} error`, error)
+        this.options?.errorInterceptor?.(error, {
+            query: this.query,
+            readMode: this.options?.readMode,
+            type: 'list',
+        })
         super.onError(error)
     }
 }

package/lib/FirestoreReference.ts

@@ -2,8 +2,18 @@ import { LiveReference, LiveReferenceOptions } from '@data-weave/datamanager'
 import { DocumentData, Firestore, FirestoreReadMode, FirestoreTypes } from './firestoreTypes'
 import { checkIfReferenceExists } from './utils'
 
+export interface FirestoreReferenceContext {
+    path: string
+    id: string
+    readMode?: FirestoreReadMode
+    snapshotOptions?: FirestoreTypes.SnapshotOptions
+    type: 'reference'
+}
+
 export interface FirestoreReferenceOptions<T> extends LiveReferenceOptions<T> {
     readMode?: FirestoreReadMode
+    snapshotOptions?: FirestoreTypes.SnapshotOptions
+    errorInterceptor?: (error: unknown, ctx: FirestoreReferenceContext) => void
 }
 
 export class FirestoreReference<T extends DocumentData, S extends DocumentData> extends LiveReference<T> {
@@ -60,6 +70,13 @@ export class FirestoreReference<T extends DocumentData, S extends DocumentData>
 
     protected onError(error: unknown): void {
         console.error(`FirestoreReference error ${this.docRef.path}`, error)
+        this.options?.errorInterceptor?.(error, {
+            path: this.docRef.path,
+            id: this.docRef.id,
+            readMode: this.options?.readMode,
+            snapshotOptions: this.options?.snapshotOptions,
+            type: 'reference',
+        })
         super.onError(error)
     }
 
@@ -70,6 +87,6 @@ export class FirestoreReference<T extends DocumentData, S extends DocumentData>
 
     private parseDocumentSnapshot(docSnapshot: FirestoreTypes.DocumentSnapshot<T, S>): T | undefined {
         if (!checkIfReferenceExists(docSnapshot)) throw new Error(`Document does not exist ${this.docRef.path}`)
-        return docSnapshot.data()
+        return docSnapshot.data(this.options?.snapshotOptions)
     }
 }

package/lib/firestoreTypes.ts

@@ -28,23 +28,38 @@ export declare interface InternalFirestoreDataConverter<
     ): T
 }
 
+export type WithTimestamps<T> = {
+    [K in keyof T]: T[K] extends Date
+        ? FirestoreTypes.Timestamp
+        : T[K] extends Date | null
+          ? FirestoreTypes.Timestamp | null
+          : T[K] extends Date | undefined
+            ? FirestoreTypes.Timestamp | undefined
+            : T[K] extends Date | null | undefined
+              ? FirestoreTypes.Timestamp | null | undefined
+              : T[K] extends object
+                ? T[K] extends any[]
+                    ? T[K] extends (infer U)[]
+                        ? WithTimestamps<U>[]
+                        : T[K]
+                    : WithTimestamps<T[K]>
+                : T[K]
+}
+
 /**
  * Converts data between model and serialized data. Differs from InternalFirestoreDataConverter
  * by using `OptionallyUndefined` and `Required` to ensure that all fields are included in de/serialization
  * even if some model defined properties are optional.
  */
-export declare interface FirestoreDataConverter<
-    T extends DocumentData,
-    SerializedT extends DocumentData = DocumentData,
-> {
+export declare interface FirestoreDataConverter<ModelObject, SerializedModelObject = ModelObject> {
     toFirestore(
-        modelObject: WithoutId<Partial<WithFieldValue<T>>>,
+        modelObject: WithoutId<ModelObject>,
         options?: FirestoreTypes.SetOptions
-    ): OptionallyUndefined<Required<WithoutId<WithFieldValue<SerializedT>>>>
+    ): OptionallyUndefined<Required<WithoutId<WithFieldValue<SerializedModelObject>>>>
     fromFirestore(
-        snapshot: FirestoreTypes.QueryDocumentSnapshot<T, SerializedT>,
+        snapshot: FirestoreTypes.QueryDocumentSnapshot<WithTimestamps<SerializedModelObject>>,
         options?: FirestoreTypes.SnapshotOptions
-    ): OptionallyUndefined<Required<WithoutId<T>>>
+    ): ModelObject
 }
 
 export type FirestoreQuery<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> = (
@@ -83,12 +98,15 @@ export type FilterableFields<
     ? // Handle firebase timestamp fields
       T[K] extends FirestoreTypes.Timestamp
         ? `${K}`
-        : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-          T[K] extends any[]
-          ? GenNode<K, IsRoot>
-          : T[K] extends object
-            ? `${GenNode<K, IsRoot>}${FilterableFields<T[K], false>}`
-            : GenNode<K, IsRoot>
+        : // Handle Date fields
+          T[K] extends Date
+          ? `${K}`
+          : // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            T[K] extends any[]
+            ? GenNode<K, IsRoot>
+            : T[K] extends object
+              ? `${GenNode<K, IsRoot>}${FilterableFields<T[K], false>}`
+              : GenNode<K, IsRoot>
     : never
 
 type GetValue<T, K extends string> = K extends `${infer L}.${infer R}`
@@ -96,7 +114,9 @@ type GetValue<T, K extends string> = K extends `${infer L}.${infer R}`
         ? GetValue<T[L], R>
         : never
     : K extends keyof T
-      ? T[K]
+      ? T[K] extends Date
+          ? Date | FirestoreTypes.Timestamp
+          : T[K]
       : K extends string
         ? string | number | boolean
         : never

package/lib/utils.ts

@@ -1,15 +1,32 @@
 import { WithoutId } from '@data-weave/datamanager'
 import {
     DocumentData,
-    FieldValues,
     Firestore,
-    FirestoreApp,
     FirestoreTypes,
     InternalFirestoreDataConverter,
     Transaction,
     WithFieldValue,
 } from './firestoreTypes'
 
+import {
+    Firestore as FirebaseFirestore,
+    collection,
+    deleteDoc,
+    doc,
+    getDoc,
+    getDocs,
+    increment,
+    limit,
+    onSnapshot,
+    orderBy,
+    query,
+    runTransaction,
+    serverTimestamp,
+    setDoc,
+    updateDoc,
+    where,
+} from 'firebase/firestore'
+
 export class MergeConverters<
     T extends DocumentData,
     SerializedT extends DocumentData,
@@ -50,111 +67,28 @@ export class MergeConverters<
     }
 }
 
-/*
- *  FirestoreNamespacedConverter creates an interface between modular and namespaced
- *  firestore libraries.
- *   - admin sdk doesn't support modular imports
- */
-
-// TODO: add types
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export class FirestoreNamespacedConverter extends Firestore {
-    public app: FirestoreApp
-    constructor(
-        readonly firestore: FirestoreApp,
-        readonly fieldValues: FieldValues
-    ) {
-        super()
-        this.app = firestore
-        this.fieldValues = fieldValues
-    }
-
-    public collection(reference: any, path: string) {
-        return reference.collection(path)
-    }
-
-    public getDocs(reference: any) {
-        return reference.get()
-    }
-
-    public getDoc(reference: any, path?: string) {
-        return reference.get(path)
-    }
-
-    public serverTimestamp() {
-        return this.fieldValues.serverTimestamp()
-    }
-
-    public increment(n: number) {
-        return this.fieldValues.increment(n)
-    }
-
-    public query(reference: any, filter: any) {
-        if (filter.type === 'where') {
-            return reference.where(filter.field, filter.op, filter.value)
-        }
-        if (filter.type === 'orderBy') {
-            return reference.orderBy(filter.field, filter.direction)
-        }
-        if (filter.type === 'limit') {
-            return reference.limit(filter.limit)
-        }
-    }
-
-    public where(field: string | FirestoreTypes.FieldPath, op: string, value: unknown): any {
-        return {
-            type: 'where',
-            field,
-            op,
-            value,
-        }
-    }
-
-    public limit(limit: number) {
-        return {
-            type: 'limit',
-            limit,
-        }
-    }
-
-    public orderBy(orderBy: string, direction: FirestoreTypes.OrderByDirection) {
-        return {
-            type: 'orderBy',
-            orderBy,
-            direction,
-        }
-    }
-
-    public setDoc(reference: any, data: any, options?: FirestoreTypes.SetOptions) {
-        return reference.set(data, options)
-    }
-
-    public updateDoc(reference: any, data: any) {
-        return reference.update(data)
-    }
-
-    public deleteDoc(reference: any) {
-        return reference.delete()
-    }
-
-    public doc(reference: any, path?: string) {
-        if (!path) return reference.doc()
-        return reference.doc(path)
-    }
-
-    public onSnapshot(reference: any, onNext: (snapshot: any) => void, onError?: (error: Error) => void) {
-        return reference.onSnapshot(onNext, onError)
-    }
-
-    public runTransaction<T>(
-        firestore: FirestoreApp,
-        transaction: (transaction: Transaction) => Promise<T>,
-        options?: FirestoreTypes.TransactionOptions
-    ) {
-        return firestore.runTransaction!(transaction, options)
+export function createModularFirestoreAdapter(firestore: FirebaseFirestore): Firestore {
+    return {
+        app: firestore,
+        collection,
+        getDocs,
+        getDoc,
+        serverTimestamp,
+        query,
+        where,
+        limit,
+        orderBy,
+        setDoc,
+        updateDoc,
+        deleteDoc,
+        doc,
+        onSnapshot,
+        increment,
+        // TODO: fix this
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        runTransaction: runTransaction as any,
     }
 }
-/* eslint-enable @typescript-eslint/no-explicit-any */
 
 // Value can be anything
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '0.3.3';
+module.exports = '0.4.0';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@data-weave/backend-firestore",
-    "version": "0.3.3",
+    "version": "0.4.0",
     "author": "",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -17,12 +17,9 @@
         "access": "public",
         "registry": "https://registry.npmjs.org/"
     },
-    "dependencies": {
-        "firebase": "^11.9.0",
-        "firebase-admin": "^13.0.2"
-    },
     "peerDependencies": {
-        "@data-weave/datamanager": "0.3.2"
+        "@data-weave/datamanager": "0.3.8",
+        "firebase": ">=11.0.0"
     },
-    "gitHead": "4fc18c650dcea3f3ede1cf2b413399656f90b79a"
+    "gitHead": "c5e5355cae5d39e7a91e17d4d30bb1e07cddedc8"
 }