@naturalcycles/firestore-lib 1.1.10 → 1.2.0

package/dist/firestore.db.d.ts

@@ -1,27 +1,26 @@
-import { Query } from '@google-cloud/firestore';
+import { Firestore, Query } from '@google-cloud/firestore';
 import { BaseCommonDB, CommonDB, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, DBQuery, DBTransaction, RunQueryResult } from '@naturalcycles/db-lib';
 import { ObjectWithId, AnyObjectWithId } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
-import * as firebaseAdmin from 'firebase-admin';
 export interface FirestoreDBCfg {
-    firestore: firebaseAdmin.firestore.Firestore;
+    firestore: Firestore;
 }
 export interface FirestoreDBOptions extends CommonDBOptions {
 }
-export interface FirestoreDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
+export interface FirestoreDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
 }
 export declare class FirestoreDB extends BaseCommonDB implements CommonDB {
     cfg: FirestoreDBCfg;
     constructor(cfg: FirestoreDBCfg);
-    getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: FirestoreDBOptions): Promise<ROW[]>;
-    getById<ROW extends ObjectWithId>(table: string, id: string, _opt?: FirestoreDBOptions): Promise<ROW | undefined>;
+    getByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], opt?: FirestoreDBOptions): Promise<ROW[]>;
+    getById<ROW extends ObjectWithId>(table: string, id: ROW['id'], _opt?: FirestoreDBOptions): Promise<ROW | null>;
     runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: FirestoreDBOptions): Promise<RunQueryResult<ROW>>;
     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 ObjectWithId>(table: string, rows: ROW[], _opt?: FirestoreDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<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>;
+    deleteByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], _opt?: FirestoreDBOptions): Promise<number>;
     private querySnapshotToArray;
     commitTransaction(_tx: DBTransaction, _opt?: CommonDBSaveOptions): Promise<void>;
     ping(): Promise<void>;

package/dist/firestore.db.js

@@ -6,6 +6,11 @@ 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 = {
+    insert: 'create',
+    update: 'update',
+    upsert: 'set',
+};
 class FirestoreDB extends db_lib_1.BaseCommonDB {
     constructor(cfg) {
         super();
@@ -21,7 +26,7 @@ class FirestoreDB extends db_lib_1.BaseCommonDB {
         const doc = await this.cfg.firestore.collection(table).doc((0, firestore_util_1.escapeDocId)(id)).get();
         const data = doc.data();
         if (data === undefined)
-            return;
+            return null;
         return {
             id,
             ...data,
@@ -54,12 +59,14 @@ class FirestoreDB extends db_lib_1.BaseCommonDB {
         }));
     }
     // SAVE
-    async saveBatch(table, rows, _opt) {
+    async saveBatch(table, rows, opt = {}) {
+        const method = methodMap[opt.saveMethod] || 'set';
         // Firestore allows max 500 items in one batch
         await (0, js_lib_1.pMap)((0, js_lib_1._chunk)(rows, 500), async (chunk) => {
             const batch = this.cfg.firestore.batch();
             chunk.forEach(row => {
-                batch.set(this.cfg.firestore.collection(table).doc((0, firestore_util_1.escapeDocId)(row.id)), (0, js_lib_1._filterUndefinedValues)(row));
+                (0, js_lib_1._assert)(row.id, `firestore-db doesn't support id auto-generation, but empty id was provided in saveBatch`);
+                batch[method](this.cfg.firestore.collection(table).doc((0, firestore_util_1.escapeDocId)(row.id)), (0, js_lib_1._filterUndefinedValues)(row));
             });
             await batch.commit();
         }, { concurrency: 1 });

package/dist/firestore.util.d.ts

@@ -1,2 +1,2 @@
-export declare function escapeDocId(docId: string): string;
+export declare function escapeDocId(docId: string | number): string;
 export declare function unescapeDocId(docId: string): string;

package/dist/firestore.util.js

@@ -4,10 +4,13 @@ exports.unescapeDocId = exports.escapeDocId = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const SLASH = '_SLASH_';
 function escapeDocId(docId) {
+    if (typeof docId === 'number')
+        return String(docId);
     return (0, js_lib_1._replaceAll)(docId, '/', SLASH);
 }
 exports.escapeDocId = escapeDocId;
 function unescapeDocId(docId) {
+    // if (typeof docId === 'number') return docId
     return (0, js_lib_1._replaceAll)(docId, SLASH, '/');
 }
 exports.unescapeDocId = unescapeDocId;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
+import { Firestore } from '@google-cloud/firestore';
 import { FirestoreDB, FirestoreDBCfg, FirestoreDBOptions, FirestoreDBSaveOptions } from './firestore.db';
 import { dbQueryToFirestoreQuery } from './query.util';
 export type { FirestoreDBCfg, FirestoreDBOptions, FirestoreDBSaveOptions };
-export { FirestoreDB, dbQueryToFirestoreQuery };
+export { Firestore, FirestoreDB, dbQueryToFirestoreQuery };

package/dist/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dbQueryToFirestoreQuery = exports.FirestoreDB = void 0;
+exports.dbQueryToFirestoreQuery = exports.FirestoreDB = exports.Firestore = void 0;
+const firestore_1 = require("@google-cloud/firestore");
+Object.defineProperty(exports, "Firestore", { enumerable: true, get: function () { return firestore_1.Firestore; } });
 const firestore_db_1 = require("./firestore.db");
 Object.defineProperty(exports, "FirestoreDB", { enumerable: true, get: function () { return firestore_db_1.FirestoreDB; } });
 const query_util_1 = require("./query.util");

package/package.json

@@ -4,6 +4,7 @@
     "prepare": "husky install"
   },
   "dependencies": {
+    "@google-cloud/firestore": "^4.5.0",
     "@naturalcycles/db-lib": "^8.2.0",
     "@naturalcycles/js-lib": "^14.6.0",
     "@naturalcycles/nodejs-lib": "^12.4.0",
@@ -12,8 +13,8 @@
   "devDependencies": {
     "@naturalcycles/dev-lib": "^12.1.2",
     "@naturalcycles/test-lib": "^1.0.3",
-    "@types/node": "^16.7.1",
-    "dotenv": "^10.0.0",
+    "@types/node": "^17.0.22",
+    "dotenv": "^16.0.0",
     "jest": "^27.0.6"
   },
   "files": [
@@ -36,7 +37,7 @@
   "engines": {
     "node": ">=14.15.0"
   },
-  "version": "1.1.10",
+  "version": "1.2.0",
   "description": "Firestore implementation of CommonDB interface",
   "author": "Natural Cycles Team",
   "license": "MIT"

package/src/firestore.db.ts

@@ -1,8 +1,9 @@
-import { Query, QueryDocumentSnapshot, QuerySnapshot } from '@google-cloud/firestore'
+import { Firestore, Query, QueryDocumentSnapshot, QuerySnapshot } from '@google-cloud/firestore'
 import {
   BaseCommonDB,
   CommonDB,
   CommonDBOptions,
+  CommonDBSaveMethod,
   CommonDBSaveOptions,
   CommonDBStreamOptions,
   DBQuery,
@@ -17,20 +18,26 @@ import {
   _filterUndefinedValues,
   ObjectWithId,
   AnyObjectWithId,
+  _assert,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped, transformMapSimple } from '@naturalcycles/nodejs-lib'
-import * as firebaseAdmin from 'firebase-admin'
 import { escapeDocId, unescapeDocId } from './firestore.util'
 import { dbQueryToFirestoreQuery } from './query.util'
 
 export interface FirestoreDBCfg {
-  firestore: firebaseAdmin.firestore.Firestore
+  firestore: Firestore
 }
 
 export interface FirestoreDBOptions extends CommonDBOptions {}
-export interface FirestoreDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId>
+export interface FirestoreDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId>
   extends CommonDBSaveOptions<ROW> {}
 
+const methodMap: Record<CommonDBSaveMethod, string> = {
+  insert: 'create',
+  update: 'update',
+  upsert: 'set',
+}
+
 export class FirestoreDB extends BaseCommonDB implements CommonDB {
   constructor(public cfg: FirestoreDBCfg) {
     super()
@@ -39,7 +46,7 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
   // GET
   override async getByIds<ROW extends ObjectWithId>(
     table: string,
-    ids: string[],
+    ids: ROW['id'][],
     opt?: FirestoreDBOptions,
   ): Promise<ROW[]> {
     // Oj, doesn't look like a very optimal implementation!
@@ -51,13 +58,13 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
 
   async getById<ROW extends ObjectWithId>(
     table: string,
-    id: string,
+    id: ROW['id'],
     _opt?: FirestoreDBOptions,
-  ): Promise<ROW | undefined> {
+  ): Promise<ROW | null> {
     const doc = await this.cfg.firestore.collection(table).doc(escapeDocId(id)).get()
 
     const data = doc.data()
-    if (data === undefined) return
+    if (data === undefined) return null
 
     return {
       id,
@@ -117,11 +124,13 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
   }
 
   // SAVE
-  override async saveBatch<ROW extends ObjectWithId>(
+  override async saveBatch<ROW extends Partial<ObjectWithId>>(
     table: string,
     rows: ROW[],
-    _opt?: FirestoreDBSaveOptions<ROW>,
+    opt: FirestoreDBSaveOptions<ROW> = {},
   ): Promise<void> {
+    const method = methodMap[opt.saveMethod!] || 'set'
+
     // Firestore allows max 500 items in one batch
     await pMap(
       _chunk(rows, 500),
@@ -129,7 +138,12 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
         const batch = this.cfg.firestore.batch()
 
         chunk.forEach(row => {
-          batch.set(
+          _assert(
+            row.id,
+            `firestore-db doesn't support id auto-generation, but empty id was provided in saveBatch`,
+          )
+
+          batch[method](
             this.cfg.firestore.collection(table).doc(escapeDocId(row.id)),
             _filterUndefinedValues(row),
           )
@@ -157,9 +171,9 @@ export class FirestoreDB extends BaseCommonDB implements CommonDB {
     return ids.length
   }
 
-  override async deleteByIds(
+  override async deleteByIds<ROW extends ObjectWithId>(
     table: string,
-    ids: string[],
+    ids: ROW['id'][],
     _opt?: FirestoreDBOptions,
   ): Promise<number> {
     await pMap(_chunk(ids, 500), async chunk => {

package/src/firestore.util.ts

@@ -2,10 +2,12 @@ import { _replaceAll } from '@naturalcycles/js-lib'
 
 const SLASH = '_SLASH_'
 
-export function escapeDocId(docId: string): string {
+export function escapeDocId(docId: string | number): string {
+  if (typeof docId === 'number') return String(docId)
   return _replaceAll(docId, '/', SLASH)
 }
 
 export function unescapeDocId(docId: string): string {
+  // if (typeof docId === 'number') return docId
   return _replaceAll(docId, SLASH, '/')
 }

package/src/index.ts

@@ -1,3 +1,4 @@
+import { Firestore } from '@google-cloud/firestore'
 import {
   FirestoreDB,
   FirestoreDBCfg,
@@ -8,4 +9,4 @@ import { dbQueryToFirestoreQuery } from './query.util'
 
 export type { FirestoreDBCfg, FirestoreDBOptions, FirestoreDBSaveOptions }
 
-export { FirestoreDB, dbQueryToFirestoreQuery }
+export { Firestore, FirestoreDB, dbQueryToFirestoreQuery }