@naturalcycles/firestore-lib 1.1.11 → 1.1.12

package/dist/firestore.db.d.ts

@@ -12,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/package.json

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

package/src/firestore.db.ts

@@ -38,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!
@@ -50,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,
@@ -156,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, '/')
 }