@naturalcycles/firestore-lib 1.7.0 → 1.8.0

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, CommonDBTransactionOptions, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult } from '@naturalcycles/db-lib';
-import { ObjectWithId, AnyObjectWithId } from '@naturalcycles/js-lib';
+import { ObjectWithId, StringMap } 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,15 @@ 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, opt?: CommonDBTransactionOptions): Promise<void>;
+    /**
+     * Caveat: it always returns an empty object, not the actual incrementMap.
+     */
+    incrementBatch(table: string, prop: string, incrementMap: StringMap<number>, _opt?: CommonDBOptions): Promise<StringMap<number>>;
     ping(): Promise<void>;
     getTables(): Promise<string[]>;
 }
@@ -38,6 +42,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

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FirestoreDBTransaction = exports.FirestoreDB = exports.RollbackError = void 0;
+const firestore_1 = require("@google-cloud/firestore");
 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 = {
@@ -23,7 +23,7 @@ class FirestoreDB extends db_lib_1.BaseCommonDB {
         this.cfg = cfg;
         this.support = {
             ...db_lib_1.commonDBFullSupport,
-            updateByQuery: false,
+            patchByQuery: false, // todo: can be implemented
             tableSchemas: false,
         };
     }
@@ -72,16 +72,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 = {}) {
@@ -167,6 +163,21 @@ class FirestoreDB extends db_lib_1.BaseCommonDB {
             throw err;
         }
     }
+    /**
+     * Caveat: it always returns an empty object, not the actual incrementMap.
+     */
+    async incrementBatch(table, prop, incrementMap, _opt) {
+        const { firestore } = this.cfg;
+        const col = firestore.collection(table);
+        const batch = firestore.batch();
+        for (const [id, increment] of (0, js_lib_1._stringMapEntries)(incrementMap)) {
+            batch.set(col.doc((0, firestore_util_1.escapeDocId)(id)), {
+                [prop]: firestore_1.FieldValue.increment(increment),
+            }, { merge: true });
+        }
+        await batch.commit();
+        return {};
+    }
     async ping() {
         // no-op now
     }

package/dist/firestore.util.js

@@ -1,15 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unescapeDocId = exports.escapeDocId = void 0;
+exports.escapeDocId = escapeDocId;
+exports.unescapeDocId = unescapeDocId;
 const SLASH = '_SLASH_';
 function escapeDocId(docId) {
     if (typeof docId === 'number')
         return String(docId);
     return docId.replaceAll('/', SLASH);
 }
-exports.escapeDocId = escapeDocId;
 function unescapeDocId(docId) {
     // if (typeof docId === 'number') return docId
     return docId.replaceAll(SLASH, '/');
 }
-exports.unescapeDocId = unescapeDocId;

package/dist/query.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dbQueryToFirestoreQuery = void 0;
+exports.dbQueryToFirestoreQuery = dbQueryToFirestoreQuery;
 // Map DBQueryFilterOp to WhereFilterOp
 // Currently it's fully aligned!
 const OP_MAP = {
@@ -27,4 +27,3 @@ function dbQueryToFirestoreQuery(dbQuery, emptyQuery) {
     }
     return q;
 }
-exports.dbQueryToFirestoreQuery = dbQueryToFirestoreQuery;

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@naturalcycles/firestore-lib",
   "scripts": {
-    "prepare": "husky install"
+    "prepare": "husky",
+    "build": "dev-lib build",
+    "test": "dev-lib test",
+    "lint": "dev-lib lint",
+    "bt": "dev-lib bt",
+    "lbt": "dev-lib lbt"
   },
   "dependencies": {
     "@google-cloud/firestore": "^7.0.0",
@@ -10,9 +15,9 @@
     "@naturalcycles/nodejs-lib": "^13.1.0"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^13.0.1",
+    "@naturalcycles/dev-lib": "^15.22.0",
     "@naturalcycles/test-lib": "^1.0.3",
-    "@types/node": "^20.1.2",
+    "@types/node": "^22.7.5",
     "dotenv": "^16.0.0",
     "firebase-admin": "^12.0.0",
     "jest": "^29.1.2"
@@ -37,7 +42,7 @@
   "engines": {
     "node": ">=18.12.0"
   },
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Firestore implementation of CommonDB interface",
   "author": "Natural Cycles Team",
   "license": "MIT"

package/src/firestore.db.ts

@@ -1,4 +1,5 @@
 import {
+  FieldValue,
   Firestore,
   Query,
   QueryDocumentSnapshot,
@@ -21,17 +22,17 @@ import {
   RunQueryResult,
 } from '@naturalcycles/db-lib'
 import {
-  ErrorMode,
-  pMap,
+  _assert,
   _chunk,
-  _omit,
   _filterUndefinedValues,
-  ObjectWithId,
-  AnyObjectWithId,
-  _assert,
   _isTruthy,
+  _omit,
+  _stringMapEntries,
+  ObjectWithId,
+  pMap,
+  StringMap,
 } 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'
 
@@ -40,7 +41,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'
@@ -64,7 +65,7 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
 
   override support: CommonDBSupport = {
     ...commonDBFullSupport,
-    updateByQuery: false,
+    patchByQuery: false, // todo: can be implemented
     tableSchemas: false,
   }
 
@@ -142,26 +143,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> = {},
@@ -298,6 +289,33 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
     }
   }
 
+  /**
+   * Caveat: it always returns an empty object, not the actual incrementMap.
+   */
+  override async incrementBatch(
+    table: string,
+    prop: string,
+    incrementMap: StringMap<number>,
+    _opt?: CommonDBOptions,
+  ): Promise<StringMap<number>> {
+    const { firestore } = this.cfg
+    const col = firestore.collection(table)
+    const batch = firestore.batch()
+
+    for (const [id, increment] of _stringMapEntries(incrementMap)) {
+      batch.set(
+        col.doc(escapeDocId(id)),
+        {
+          [prop]: FieldValue.increment(increment),
+        },
+        { merge: true },
+      )
+    }
+
+    await batch.commit()
+    return {}
+  }
+
   override async ping(): Promise<void> {
     // no-op now
   }
@@ -328,7 +346,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>,