@naturalcycles/firestore-lib 1.6.1 → 1.7.1

package/dist/firestore.db.d.ts

@@ -1,13 +1,13 @@
 import { Firestore, Query, Transaction } from '@google-cloud/firestore';
-import { BaseCommonDB, CommonDB, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CommonDBSupport, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult } from '@naturalcycles/db-lib';
-import { ObjectWithId, AnyObjectWithId } from '@naturalcycles/js-lib';
+import { BaseCommonDB, CommonDB, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CommonDBSupport, CommonDBTransactionOptions, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult } from '@naturalcycles/db-lib';
+import { ObjectWithId } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 export interface FirestoreDBCfg {
     firestore: Firestore;
 }
 export interface FirestoreDBOptions extends CommonDBOptions {
 }
-export interface FirestoreDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
+export interface FirestoreDBSaveOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {
 }
 export declare class RollbackError extends Error {
     constructor();
@@ -21,11 +21,11 @@ export declare class FirestoreDB extends BaseCommonDB implements CommonDB {
     runFirestoreQuery<ROW extends ObjectWithId>(q: Query, _opt?: FirestoreDBOptions): Promise<ROW[]>;
     runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: FirestoreDBOptions): Promise<number>;
     streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBStreamOptions): ReadableTyped<ROW>;
-    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], opt?: FirestoreDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: FirestoreDBSaveOptions<ROW>): Promise<void>;
     deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: FirestoreDBOptions): Promise<number>;
     deleteByIds(table: string, ids: string[], opt?: FirestoreDBOptions): Promise<number>;
     private querySnapshotToArray;
-    runInTransaction(fn: DBTransactionFn): Promise<void>;
+    runInTransaction(fn: DBTransactionFn, opt?: CommonDBTransactionOptions): Promise<void>;
     ping(): Promise<void>;
     getTables(): Promise<string[]>;
 }
@@ -38,6 +38,6 @@ export declare class FirestoreDBTransaction implements DBTransaction {
     constructor(db: FirestoreDB, tx: Transaction);
     rollback(): Promise<void>;
     getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: CommonDBOptions): Promise<ROW[]>;
-    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
     deleteByIds(table: string, ids: string[], opt?: CommonDBOptions): Promise<number>;
 }

package/dist/firestore.db.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FirestoreDBTransaction = exports.FirestoreDB = exports.RollbackError = void 0;
 const db_lib_1 = require("@naturalcycles/db-lib");
 const js_lib_1 = require("@naturalcycles/js-lib");
-const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const firestore_util_1 = require("./firestore.util");
 const query_util_1 = require("./query.util");
 const methodMap = {
@@ -72,16 +71,12 @@ class FirestoreDB extends db_lib_1.BaseCommonDB {
     }
     streamQuery(q, _opt) {
         const firestoreQuery = (0, query_util_1.dbQueryToFirestoreQuery)(q, this.cfg.firestore.collection(q.table));
-        const stream = firestoreQuery
-            .stream()
-            .on('error', err => stream.emit('error', err))
-            .pipe((0, nodejs_lib_1.transformMapSimple)(doc => ({
-            id: (0, firestore_util_1.unescapeDocId)(doc.id),
-            ...doc.data(),
-        }), {
-            errorMode: js_lib_1.ErrorMode.SUPPRESS, // because .pipe cannot propagate errors
-        }));
-        return stream;
+        return firestoreQuery.stream().map(doc => {
+            return {
+                id: (0, firestore_util_1.unescapeDocId)(doc.id),
+                ...doc.data(),
+            };
+        });
     }
     // SAVE
     async saveBatch(table, rows, opt = {}) {
@@ -149,11 +144,14 @@ class FirestoreDB extends db_lib_1.BaseCommonDB {
         });
         return rows;
     }
-    async runInTransaction(fn) {
+    async runInTransaction(fn, opt = {}) {
+        const { readOnly } = opt;
         try {
             await this.cfg.firestore.runTransaction(async (firestoreTx) => {
                 const tx = new FirestoreDBTransaction(this, firestoreTx);
                 await fn(tx);
+            }, {
+                readOnly,
             });
         }
         catch (err) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/firestore-lib",
   "scripts": {
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "dependencies": {
     "@google-cloud/firestore": "^7.0.0",
@@ -37,7 +37,7 @@
   "engines": {
     "node": ">=18.12.0"
   },
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "Firestore implementation of CommonDB interface",
   "author": "Natural Cycles Team",
   "license": "MIT"

package/src/firestore.db.ts

@@ -14,23 +14,22 @@ import {
   CommonDBSaveOptions,
   CommonDBStreamOptions,
   CommonDBSupport,
+  CommonDBTransactionOptions,
   DBQuery,
   DBTransaction,
   DBTransactionFn,
   RunQueryResult,
 } from '@naturalcycles/db-lib'
 import {
-  ErrorMode,
   pMap,
   _chunk,
   _omit,
   _filterUndefinedValues,
   ObjectWithId,
-  AnyObjectWithId,
   _assert,
   _isTruthy,
 } from '@naturalcycles/js-lib'
-import { ReadableTyped, transformMapSimple } from '@naturalcycles/nodejs-lib'
+import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { escapeDocId, unescapeDocId } from './firestore.util'
 import { dbQueryToFirestoreQuery } from './query.util'
 
@@ -39,7 +38,7 @@ export interface FirestoreDBCfg {
 }
 
 export interface FirestoreDBOptions extends CommonDBOptions {}
-export interface FirestoreDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId>
+export interface FirestoreDBSaveOptions<ROW extends ObjectWithId>
   extends CommonDBSaveOptions<ROW> {}
 
 type SaveOp = 'create' | 'update' | 'set'
@@ -141,26 +140,16 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
   ): ReadableTyped<ROW> {
     const firestoreQuery = dbQueryToFirestoreQuery(q, this.cfg.firestore.collection(q.table))
 
-    const stream: ReadableTyped<ROW> = firestoreQuery
-      .stream()
-      .on('error', err => stream.emit('error', err))
-      .pipe(
-        transformMapSimple<QueryDocumentSnapshot<any>, ROW>(
-          doc => ({
-            id: unescapeDocId(doc.id),
-            ...doc.data(),
-          }),
-          {
-            errorMode: ErrorMode.SUPPRESS, // because .pipe cannot propagate errors
-          },
-        ),
-      )
-
-    return stream
+    return (firestoreQuery.stream() as ReadableTyped<QueryDocumentSnapshot<any>>).map(doc => {
+      return {
+        id: unescapeDocId(doc.id),
+        ...doc.data(),
+      } as ROW
+    })
   }
 
   // SAVE
-  override async saveBatch<ROW extends Partial<ObjectWithId>>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rows: ROW[],
     opt: FirestoreDBSaveOptions<ROW> = {},
@@ -272,12 +261,22 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
     return rows
   }
 
-  override async runInTransaction(fn: DBTransactionFn): Promise<void> {
+  override async runInTransaction(
+    fn: DBTransactionFn,
+    opt: CommonDBTransactionOptions = {},
+  ): Promise<void> {
+    const { readOnly } = opt
+
     try {
-      await this.cfg.firestore.runTransaction(async firestoreTx => {
-        const tx = new FirestoreDBTransaction(this, firestoreTx)
-        await fn(tx)
-      })
+      await this.cfg.firestore.runTransaction(
+        async firestoreTx => {
+          const tx = new FirestoreDBTransaction(this, firestoreTx)
+          await fn(tx)
+        },
+        {
+          readOnly,
+        },
+      )
     } catch (err) {
       if (err instanceof RollbackError) {
         // RollbackError should be handled gracefully (not re-throw)
@@ -317,7 +316,7 @@ export class FirestoreDBTransaction implements DBTransaction {
     return await this.db.getByIds(table, ids, { ...opt, tx: this })
   }
 
-  async saveBatch<ROW extends Partial<ObjectWithId>>(
+  async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rows: ROW[],
     opt?: CommonDBSaveOptions<ROW>,