@naturalcycles/firestore-lib 1.1.9 → 1.1.12

package/dist/firestore.db.d.ts

@@ -1,10 +1,9 @@
-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 {
 }
@@ -13,15 +12,15 @@ export interface FirestoreDBSaveOptions<ROW extends ObjectWithId = AnyObjectWith
 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>;
     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

@@ -21,7 +21,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,

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,19 +4,17 @@
     "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"
-  },
-  "peerDependencies": {
-    "firebase-admin": ">=9.3.0"
+    "@naturalcycles/nodejs-lib": "^12.4.0",
+    "firebase-admin": "^10.0.0"
   },
   "devDependencies": {
     "@naturalcycles/dev-lib": "^12.1.2",
     "@naturalcycles/test-lib": "^1.0.3",
-    "@types/node": "^16.7.1",
-    "dotenv": "^10.0.0",
-    "firebase-admin": "^10.0.0",
+    "@types/node": "^17.0.22",
+    "dotenv": "^16.0.0",
     "jest": "^27.0.6"
   },
   "files": [
@@ -37,9 +35,9 @@
     "url": "https://github.com/NaturalCycles/firestore-lib"
   },
   "engines": {
-    "node": ">=12.13"
+    "node": ">=14.15.0"
   },
-  "version": "1.1.9",
+  "version": "1.1.12",
   "description": "Firestore implementation of CommonDB interface",
   "author": "Natural Cycles Team",
   "license": "MIT"

package/readme.md

@@ -8,10 +8,3 @@
 # Features
 
 - ...
-
-# Packaging
-
-- `engines.node >= 10.13`: Latest Node.js LTS
-- `main: dist/index.js`: commonjs, es2018
-- `types: dist/index.d.ts`: typescript types
-- `/src` folder with source `*.ts` files included

package/src/firestore.db.ts

@@ -1,4 +1,4 @@
-import { Query, QueryDocumentSnapshot, QuerySnapshot } from '@google-cloud/firestore'
+import { Firestore, Query, QueryDocumentSnapshot, QuerySnapshot } from '@google-cloud/firestore'
 import {
   BaseCommonDB,
   CommonDB,
@@ -19,12 +19,11 @@ import {
   AnyObjectWithId,
 } 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 {}
@@ -39,7 +38,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 +50,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,
@@ -157,9 +156,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 }

package/CHANGELOG.md

@@ -1,140 +0,0 @@
-## [1.1.9](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.8...v1.1.9) (2021-10-19)
-
-
-### Bug Fixes
-
-* adapt to db-lib ([45c850b](https://github.com/NaturalCycles/firestore-lib/commit/45c850b923d32ac439e00b0ed52629398146bd45))
-
-## [1.1.8](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.7...v1.1.8) (2021-10-18)
-
-
-### Bug Fixes
-
-* correctly filter undefined values on save ([1eff2b4](https://github.com/NaturalCycles/firestore-lib/commit/1eff2b40fdb2ccfd137be268871d449ea2cbc74f))
-
-## [1.1.7](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.6...v1.1.7) (2021-10-18)
-
-
-### Bug Fixes
-
-* stop removing null values on save ([03b8f21](https://github.com/NaturalCycles/firestore-lib/commit/03b8f218c9c030d55ff769a653a6332580ab44dc))
-
-## [1.1.6](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.5...v1.1.6) (2021-10-17)
-
-
-### Bug Fixes
-
-* db-lib compat ([ad28580](https://github.com/NaturalCycles/firestore-lib/commit/ad28580cf772b9ff05d07cc89e6ee19be52981e3))
-
-## [1.1.5](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.4...v1.1.5) (2021-10-17)
-
-
-### Bug Fixes
-
-* adapt to latest db-lib ([e64d4ca](https://github.com/NaturalCycles/firestore-lib/commit/e64d4cad792a2f24d3e592dbbff59492017a9d60))
-
-## [1.1.4](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.3...v1.1.4) (2021-10-01)
-
-
-### Bug Fixes
-
-* adapt to db-lib ([05cbc49](https://github.com/NaturalCycles/firestore-lib/commit/05cbc4996efe5a3f1091835b016e2534b59befde))
-
-## [1.1.3](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.2...v1.1.3) (2021-08-25)
-
-
-### Bug Fixes
-
-* deps ([541438a](https://github.com/NaturalCycles/firestore-lib/commit/541438aab99613d5b0c69b48b68008d6e0fbe06f))
-
-## [1.1.2](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.1...v1.1.2) (2021-02-27)
-
-
-### Bug Fixes
-
-* deps ([741c1cb](https://github.com/NaturalCycles/firestore-lib/commit/741c1cbd2fbc913a32bdd26d394a14ea9e548f76))
-
-## [1.1.1](https://github.com/NaturalCycles/firestore-lib/compare/v1.1.0...v1.1.1) (2020-11-05)
-
-
-### Bug Fixes
-
-* adapt to db-lib ([032f821](https://github.com/NaturalCycles/firestore-lib/commit/032f82164f200d75fb5ed6c72ba12209fce45e9c))
-
-# [1.1.0](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.9...v1.1.0) (2020-10-25)
-
-
-### Features
-
-* adapt to current db-lib ([4c2f228](https://github.com/NaturalCycles/firestore-lib/commit/4c2f228c4f80711735a53b20fc75a9a74878ffb9))
-
-## [1.0.9](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.8...v1.0.9) (2020-03-22)
-
-
-### Bug Fixes
-
-* deps ([53f70bb](https://github.com/NaturalCycles/firestore-lib/commit/53f70bbe9b746c500bb394d506bc0a707f09b4f2))
-
-## [1.0.8](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.7...v1.0.8) (2019-09-21)
-
-
-### Bug Fixes
-
-* adapt to db-lib ([d046dd6](https://github.com/NaturalCycles/firestore-lib/commit/d046dd6))
-
-## [1.0.7](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.6...v1.0.7) (2019-09-20)
-
-
-### Bug Fixes
-
-* adapt to new db-lib ([414b97c](https://github.com/NaturalCycles/firestore-lib/commit/414b97c))
-
-## [1.0.6](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.5...v1.0.6) (2019-08-24)
-
-
-### Bug Fixes
-
-* missing index.ts ([b2b75cd](https://github.com/NaturalCycles/firestore-lib/commit/b2b75cd))
-
-## [1.0.5](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.4...v1.0.5) (2019-08-23)
-
-
-### Bug Fixes
-
-* adopt to db-lib ([60800db](https://github.com/NaturalCycles/firestore-lib/commit/60800db))
-
-## [1.0.4](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.3...v1.0.4) (2019-08-20)
-
-
-### Bug Fixes
-
-* return await ([6c6267d](https://github.com/NaturalCycles/firestore-lib/commit/6c6267d))
-
-## [1.0.3](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.2...v1.0.3) (2019-08-20)
-
-
-### Bug Fixes
-
-* update to recent commondb interface ([d506916](https://github.com/NaturalCycles/firestore-lib/commit/d506916))
-
-## [1.0.2](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.1...v1.0.2) (2019-08-18)
-
-
-### Bug Fixes
-
-* filterUndefinedValues ([57e0b24](https://github.com/NaturalCycles/firestore-lib/commit/57e0b24))
-
-## [1.0.1](https://github.com/NaturalCycles/firestore-lib/compare/v1.0.0...v1.0.1) (2019-08-18)
-
-
-### Bug Fixes
-
-* update to recent db-lib ([dbbb093](https://github.com/NaturalCycles/firestore-lib/commit/dbbb093))
-
-# 1.0.0 (2019-07-28)
-
-
-### Features
-
-* first version ([6d129a9](https://github.com/NaturalCycles/firestore-lib/commit/6d129a9))
-* init project by create-module ([205703f](https://github.com/NaturalCycles/firestore-lib/commit/205703f))