@naturalcycles/firestore-lib 1.6.1 → 1.7.0

package/dist/firestore.db.d.ts

@@ -1,5 +1,5 @@
 import { Firestore, Query, Transaction } from '@google-cloud/firestore';
-import { BaseCommonDB, CommonDB, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CommonDBSupport, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult } from '@naturalcycles/db-lib';
+import { BaseCommonDB, CommonDB, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CommonDBSupport, CommonDBTransactionOptions, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult } from '@naturalcycles/db-lib';
 import { ObjectWithId, AnyObjectWithId } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 export interface FirestoreDBCfg {
@@ -25,7 +25,7 @@ export declare class FirestoreDB extends BaseCommonDB implements CommonDB {
     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[]>;
 }

package/dist/firestore.db.js

@@ -149,11 +149,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

@@ -37,7 +37,7 @@
   "engines": {
     "node": ">=18.12.0"
   },
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "Firestore implementation of CommonDB interface",
   "author": "Natural Cycles Team",
   "license": "MIT"

package/src/firestore.db.ts

@@ -14,6 +14,7 @@ import {
   CommonDBSaveOptions,
   CommonDBStreamOptions,
   CommonDBSupport,
+  CommonDBTransactionOptions,
   DBQuery,
   DBTransaction,
   DBTransactionFn,
@@ -272,12 +273,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)