@naturalcycles/datastore-lib 3.39.3 → 3.39.4

package/dist/DatastoreStreamReadable.d.ts

@@ -1,6 +1,6 @@
 import { Readable } from 'node:stream';
-import { Query } from '@google-cloud/datastore';
-import { CommonLogger } from '@naturalcycles/js-lib';
+import type { Query } from '@google-cloud/datastore';
+import type { CommonLogger } from '@naturalcycles/js-lib';
 import type { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import type { DatastoreDBStreamOptions } from './datastore.model';
 export declare class DatastoreStreamReadable<T = any> extends Readable implements ReadableTyped<T> {

package/dist/datastore.db.d.ts

@@ -1,9 +1,9 @@
-import type { Datastore, Key } from '@google-cloud/datastore';
-import { Transaction } from '@google-cloud/datastore';
-import { BaseCommonDB, CommonDB, CommonDBOptions, CommonDBReadOptions, CommonDBSaveOptions, CommonDBSupport, CommonDBTransactionOptions, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult } from '@naturalcycles/db-lib';
-import { CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
-import { ReadableTyped } from '@naturalcycles/nodejs-lib';
-import { DatastoreDBCfg, DatastoreDBOptions, DatastoreDBReadOptions, DatastoreDBSaveOptions, DatastoreDBStreamOptions, DatastorePropertyStats, DatastoreStats } from './datastore.model';
+import type { Datastore, Key, Transaction } from '@google-cloud/datastore';
+import type { CommonDB, CommonDBOptions, CommonDBReadOptions, CommonDBSaveOptions, CommonDBSupport, CommonDBTransactionOptions, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult } from '@naturalcycles/db-lib';
+import { BaseCommonDB } from '@naturalcycles/db-lib';
+import type { CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib';
+import type { DatastoreDBCfg, DatastoreDBOptions, DatastoreDBReadOptions, DatastoreDBSaveOptions, DatastoreDBStreamOptions, DatastorePropertyStats, DatastoreStats } from './datastore.model';
 /**
  * Datastore API:
  * https://googlecloudplatform.github.io/google-cloud-node/#/docs/datastore/1.0.3/datastore
@@ -21,6 +21,8 @@ export declare class DatastoreDB extends BaseCommonDB implements CommonDB {
      */
     protected KEY: symbol;
     ds(): Datastore;
+    private getPropertyFilter;
+    private getDatastoreLib;
     ping(): Promise<void>;
     getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: DatastoreDBReadOptions): Promise<ROW[]>;
     runQuery<ROW extends ObjectWithId>(dbQuery: DBQuery<ROW>, opt?: DatastoreDBReadOptions): Promise<RunQueryResult<ROW>>;

package/dist/datastore.db.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DatastoreDBTransaction = exports.DatastoreDB = void 0;
-const datastore_1 = require("@google-cloud/datastore");
 const db_lib_1 = require("@naturalcycles/db-lib");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
@@ -50,9 +49,7 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
     ds() {
         if (!this.cachedDatastore) {
             (0, js_lib_1._assert)(process.env['APP_ENV'] !== 'test', 'DatastoreDB cannot be used in Test env, please use InMemoryDB');
-            // Lazy-loading
-            const datastoreLib = require('@google-cloud/datastore');
-            const DS = datastoreLib.Datastore;
+            const DS = this.getDatastoreLib().Datastore;
             this.cfg.projectId ||= this.cfg.credentials?.project_id || process.env['GOOGLE_CLOUD_PROJECT'];
             if (this.cfg.projectId) {
                 this.cfg.logger.log(`DatastoreDB connected to ${(0, nodejs_lib_1.boldWhite)(this.cfg.projectId)}`);
@@ -68,6 +65,13 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
         }
         return this.cachedDatastore;
     }
+    getPropertyFilter() {
+        return this.getDatastoreLib().PropertyFilter;
+    }
+    getDatastoreLib() {
+        // Lazy-loading
+        return require('@google-cloud/datastore');
+    }
     async ping() {
         await this.getAllStats();
     }
@@ -138,7 +142,7 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
                 rows: await this.getByIds(dbQuery.table, ids, opt),
             };
         }
-        const q = (0, query_util_1.dbQueryToDatastoreQuery)(dbQuery, this.ds().createQuery(dbQuery.table));
+        const q = (0, query_util_1.dbQueryToDatastoreQuery)(dbQuery, this.ds().createQuery(dbQuery.table), this.getPropertyFilter());
         const dsOpt = this.getRunQueryOptions(opt);
         const qr = await this.runDatastoreQuery(q, dsOpt);
         // Special case when projection query didn't specify 'id'
@@ -148,7 +152,7 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
         return qr;
     }
     async runQueryCount(dbQuery, opt = {}) {
-        const q = (0, query_util_1.dbQueryToDatastoreQuery)(dbQuery.select([]), this.ds().createQuery(dbQuery.table));
+        const q = (0, query_util_1.dbQueryToDatastoreQuery)(dbQuery.select([]), this.ds().createQuery(dbQuery.table), this.getPropertyFilter());
         const aq = this.ds().createAggregationQuery(q).count('count');
         const dsOpt = this.getRunQueryOptions(opt);
         const [entities] = await this.ds().runAggregationQuery(aq, dsOpt);
@@ -173,7 +177,7 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
             : this.ds().runQueryStream(q, dsOpt)).map(chunk => this.mapId(chunk));
     }
     streamQuery(dbQuery, opt) {
-        const q = (0, query_util_1.dbQueryToDatastoreQuery)(dbQuery, this.ds().createQuery(dbQuery.table));
+        const q = (0, query_util_1.dbQueryToDatastoreQuery)(dbQuery, this.ds().createQuery(dbQuery.table), this.getPropertyFilter());
         return this.runQueryStream(q, opt);
     }
     // https://github.com/GoogleCloudPlatform/nodejs-getting-started/blob/master/2-structured-data/books/model-datastore.js
@@ -215,7 +219,7 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
             const ids = idFilter.op === '==' ? [idFilter.val] : idFilter.val;
             return await this.deleteByIds(q.table, ids, opt);
         }
-        const datastoreQuery = (0, query_util_1.dbQueryToDatastoreQuery)(q.select([]), this.ds().createQuery(q.table));
+        const datastoreQuery = (0, query_util_1.dbQueryToDatastoreQuery)(q.select([]), this.ds().createQuery(q.table), this.getPropertyFilter());
         const dsOpt = this.getRunQueryOptions(opt);
         const { rows } = await this.runDatastoreQuery(datastoreQuery, dsOpt);
         return await this.deleteByIds(q.table, rows.map(obj => obj.id), opt);
@@ -256,10 +260,11 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
      * Returns undefined e.g when Table is non-existing
      */
     async getStats(table) {
+        const { PropertyFilter } = this.getDatastoreLib();
         const q = this.ds()
             .createQuery('__Stat_Kind__')
             // .filter('kind_name', table)
-            .filter(new datastore_1.PropertyFilter('kind_name', '=', table))
+            .filter(new PropertyFilter('kind_name', '=', table))
             .limit(1);
         const [statsArray] = await this.ds().runQuery(q);
         const [stats] = statsArray;
@@ -273,7 +278,7 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
         const q = this.ds()
             .createQuery('__Stat_PropertyType_PropertyName_Kind__')
             // .filter('kind_name', table)
-            .filter(new datastore_1.PropertyFilter('kind_name', '=', table));
+            .filter(new (this.getPropertyFilter())('kind_name', '=', table));
         const [stats] = await this.ds().runQuery(q);
         return stats;
     }

package/dist/datastore.model.d.ts

@@ -1,6 +1,6 @@
 import type { DatastoreOptions, Key } from '@google-cloud/datastore';
-import { CommonDBOptions, CommonDBReadOptions, CommonDBSaveOptions } from '@naturalcycles/db-lib';
-import { CommonLogger, NumberOfSeconds, ObjectWithId } from '@naturalcycles/js-lib';
+import type { CommonDBOptions, CommonDBReadOptions, CommonDBSaveOptions } from '@naturalcycles/db-lib';
+import type { CommonLogger, NumberOfSeconds, ObjectWithId } from '@naturalcycles/js-lib';
 export interface DatastorePayload<T = any> {
     key: Key;
     data: T;

package/dist/datastoreKeyValueDB.d.ts

@@ -1,8 +1,7 @@
-import { CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib';
-import { IncrementTuple } from '@naturalcycles/db-lib/dist/kv/commonKeyValueDB';
-import { ReadableTyped } from '@naturalcycles/nodejs-lib';
+import type { CommonKeyValueDB, IncrementTuple, KeyValueDBTuple } from '@naturalcycles/db-lib';
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { DatastoreDB } from './datastore.db';
-import { DatastoreDBCfg } from './datastore.model';
+import type { DatastoreDBCfg } from './datastore.model';
 export interface DatastoreKeyValueDBCfg extends DatastoreDBCfg {
 }
 export declare class DatastoreKeyValueDB implements CommonKeyValueDB {

package/dist/query.util.d.ts

@@ -1,4 +1,4 @@
-import { Query } from '@google-cloud/datastore';
-import { DBQuery } from '@naturalcycles/db-lib';
-import { ObjectWithId } from '@naturalcycles/js-lib';
-export declare function dbQueryToDatastoreQuery<ROW extends ObjectWithId>(dbQuery: Readonly<DBQuery<ROW>>, emptyQuery: Query): Query;
+import type { PropertyFilter, Query } from '@google-cloud/datastore';
+import type { DBQuery } from '@naturalcycles/db-lib';
+import type { ObjectWithId } from '@naturalcycles/js-lib';
+export declare function dbQueryToDatastoreQuery<ROW extends ObjectWithId>(dbQuery: Readonly<DBQuery<ROW>>, emptyQuery: Query, propertyFilterClass: typeof PropertyFilter): Query;

package/dist/query.util.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dbQueryToDatastoreQuery = dbQueryToDatastoreQuery;
-const datastore_1 = require("@google-cloud/datastore");
 const FNAME_MAP = {
     id: '__key__',
 };
@@ -10,7 +9,7 @@ const OP_MAP = {
     in: 'IN',
     'not-in': 'NOT_IN',
 };
-function dbQueryToDatastoreQuery(dbQuery, emptyQuery) {
+function dbQueryToDatastoreQuery(dbQuery, emptyQuery, propertyFilterClass) {
     let q = emptyQuery;
     // filter
     for (const f of dbQuery._filters) {
@@ -24,7 +23,7 @@ function dbQueryToDatastoreQuery(dbQuery, emptyQuery) {
         let { op, val } = f;
         if (val === undefined)
             val = null;
-        q = q.filter(new datastore_1.PropertyFilter(f.name, OP_MAP[op] || op, val));
+        q = q.filter(new propertyFilterClass(f.name, OP_MAP[op] || op, val));
     }
     // limit
     q = q.limit(dbQuery._limitValue || 0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/datastore-lib",
-  "version": "3.39.3",
+  "version": "3.39.4",
   "description": "Opinionated library to work with Google Datastore",
   "scripts": {
     "prepare": "husky",
@@ -12,14 +12,16 @@
   },
   "dependencies": {
     "@google-cloud/datastore": "^9",
-    "@naturalcycles/db-lib": "^9",
+    "@naturalcycles/db-lib": "^10",
     "@naturalcycles/js-lib": "^14",
     "@naturalcycles/nodejs-lib": "^13"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^15",
+    "@naturalcycles/dev-lib": "^17",
     "@types/node": "^22",
-    "jest": "^29"
+    "@vitest/coverage-v8": "^3",
+    "tsx": "^4.19.3",
+    "vitest": "^3"
   },
   "files": [
     "dist",

package/src/DatastoreStreamReadable.ts

@@ -1,7 +1,8 @@
 import { Readable } from 'node:stream'
-import { Query } from '@google-cloud/datastore'
+import type { Query } from '@google-cloud/datastore'
 import type { RunQueryInfo, RunQueryOptions } from '@google-cloud/datastore/build/src/query'
-import { _ms, CommonLogger, pRetry, UnixTimestampMillis } from '@naturalcycles/js-lib'
+import type { CommonLogger, UnixTimestampMillis } from '@naturalcycles/js-lib'
+import { _ms, pRetry } from '@naturalcycles/js-lib'
 import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import type { DatastoreDBStreamOptions } from './datastore.model'
 

package/src/datastore.db.ts

@@ -1,10 +1,7 @@
-import type { Datastore, Key, Query } from '@google-cloud/datastore'
-import { PropertyFilter, Transaction } from '@google-cloud/datastore'
-import { type RunQueryOptions } from '@google-cloud/datastore/build/src/query'
-import {
-  BaseCommonDB,
+import type { Datastore, Key, PropertyFilter, Query, Transaction } from '@google-cloud/datastore'
+import type { RunQueryOptions } from '@google-cloud/datastore/build/src/query'
+import type {
   CommonDB,
-  commonDBFullSupport,
   CommonDBOptions,
   CommonDBReadOptions,
   CommonDBSaveMethod,
@@ -16,13 +13,9 @@ import {
   DBTransactionFn,
   RunQueryResult,
 } from '@naturalcycles/db-lib'
-import {
-  _assert,
-  _chunk,
-  _errorDataAppend,
-  _omit,
+import { BaseCommonDB, commonDBFullSupport } from '@naturalcycles/db-lib'
+import type {
   CommonLogger,
-  commonLoggerMinLevel,
   JsonSchemaAny,
   JsonSchemaBoolean,
   JsonSchemaNull,
@@ -31,15 +24,23 @@ import {
   JsonSchemaRootObject,
   JsonSchemaString,
   ObjectWithId,
+  PRetryOptions,
+} from '@naturalcycles/js-lib'
+import {
+  _assert,
+  _chunk,
+  _errorDataAppend,
+  _omit,
+  commonLoggerMinLevel,
   pMap,
   pRetry,
   pRetryFn,
-  PRetryOptions,
   pTimeout,
   TimeoutError,
 } from '@naturalcycles/js-lib'
-import { boldWhite, ReadableTyped } from '@naturalcycles/nodejs-lib'
-import {
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { boldWhite } from '@naturalcycles/nodejs-lib'
+import type {
   DatastoreDBCfg,
   DatastoreDBOptions,
   DatastoreDBReadOptions,
@@ -48,8 +49,8 @@ import {
   DatastorePayload,
   DatastorePropertyStats,
   DatastoreStats,
-  DatastoreType,
 } from './datastore.model'
+import { DatastoreType } from './datastore.model'
 import { DatastoreStreamReadable } from './DatastoreStreamReadable'
 import { dbQueryToDatastoreQuery } from './query.util'
 
@@ -114,9 +115,7 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
         'DatastoreDB cannot be used in Test env, please use InMemoryDB',
       )
 
-      // Lazy-loading
-      const datastoreLib = require('@google-cloud/datastore')
-      const DS = datastoreLib.Datastore as typeof Datastore
+      const DS = this.getDatastoreLib().Datastore as typeof Datastore
       this.cfg.projectId ||= this.cfg.credentials?.project_id || process.env['GOOGLE_CLOUD_PROJECT']
 
       if (this.cfg.projectId) {
@@ -136,6 +135,15 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     return this.cachedDatastore
   }
 
+  private getPropertyFilter(): typeof PropertyFilter {
+    return this.getDatastoreLib().PropertyFilter
+  }
+
+  private getDatastoreLib(): any {
+    // Lazy-loading
+    return require('@google-cloud/datastore')
+  }
+
   override async ping(): Promise<void> {
     await this.getAllStats()
   }
@@ -231,7 +239,11 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
       }
     }
 
-    const q = dbQueryToDatastoreQuery(dbQuery, this.ds().createQuery(dbQuery.table))
+    const q = dbQueryToDatastoreQuery(
+      dbQuery,
+      this.ds().createQuery(dbQuery.table),
+      this.getPropertyFilter(),
+    )
     const dsOpt = this.getRunQueryOptions(opt)
     const qr = await this.runDatastoreQuery<ROW>(q, dsOpt)
 
@@ -247,7 +259,11 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     dbQuery: DBQuery<ROW>,
     opt: DatastoreDBReadOptions = {},
   ): Promise<number> {
-    const q = dbQueryToDatastoreQuery(dbQuery.select([]), this.ds().createQuery(dbQuery.table))
+    const q = dbQueryToDatastoreQuery(
+      dbQuery.select([]),
+      this.ds().createQuery(dbQuery.table),
+      this.getPropertyFilter(),
+    )
     const aq = this.ds().createAggregationQuery(q).count('count')
     const dsOpt = this.getRunQueryOptions(opt)
     const [entities] = await this.ds().runAggregationQuery(aq, dsOpt)
@@ -293,7 +309,11 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     dbQuery: DBQuery<ROW>,
     opt?: DatastoreDBStreamOptions,
   ): ReadableTyped<ROW> {
-    const q = dbQueryToDatastoreQuery(dbQuery, this.ds().createQuery(dbQuery.table))
+    const q = dbQueryToDatastoreQuery(
+      dbQuery,
+      this.ds().createQuery(dbQuery.table),
+      this.getPropertyFilter(),
+    )
     return this.runQueryStream(q, opt)
   }
 
@@ -357,7 +377,11 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
       return await this.deleteByIds(q.table, ids, opt)
     }
 
-    const datastoreQuery = dbQueryToDatastoreQuery(q.select([]), this.ds().createQuery(q.table))
+    const datastoreQuery = dbQueryToDatastoreQuery(
+      q.select([]),
+      this.ds().createQuery(q.table),
+      this.getPropertyFilter(),
+    )
     const dsOpt = this.getRunQueryOptions(opt)
     const { rows } = await this.runDatastoreQuery<ROW>(datastoreQuery, dsOpt)
     return await this.deleteByIds(
@@ -419,6 +443,8 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
    * Returns undefined e.g when Table is non-existing
    */
   async getStats(table: string): Promise<DatastoreStats | undefined> {
+    const { PropertyFilter } = this.getDatastoreLib()
+
     const q = this.ds()
       .createQuery('__Stat_Kind__')
       // .filter('kind_name', table)
@@ -438,7 +464,7 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     const q = this.ds()
       .createQuery('__Stat_PropertyType_PropertyName_Kind__')
       // .filter('kind_name', table)
-      .filter(new PropertyFilter('kind_name', '=', table))
+      .filter(new (this.getPropertyFilter())('kind_name', '=', table))
     const [stats] = await this.ds().runQuery(q)
     return stats
   }

package/src/datastore.model.ts

@@ -1,6 +1,10 @@
 import type { DatastoreOptions, Key } from '@google-cloud/datastore'
-import { CommonDBOptions, CommonDBReadOptions, CommonDBSaveOptions } from '@naturalcycles/db-lib'
-import { CommonLogger, NumberOfSeconds, ObjectWithId } from '@naturalcycles/js-lib'
+import type {
+  CommonDBOptions,
+  CommonDBReadOptions,
+  CommonDBSaveOptions,
+} from '@naturalcycles/db-lib'
+import type { CommonLogger, NumberOfSeconds, ObjectWithId } from '@naturalcycles/js-lib'
 
 export interface DatastorePayload<T = any> {
   key: Key

package/src/datastoreKeyValueDB.ts

@@ -1,14 +1,10 @@
-import {
-  CommonKeyValueDB,
-  commonKeyValueDBFullSupport,
-  DBQuery,
-  KeyValueDBTuple,
-} from '@naturalcycles/db-lib'
-import { IncrementTuple } from '@naturalcycles/db-lib/dist/kv/commonKeyValueDB'
-import { AppError, ObjectWithId } from '@naturalcycles/js-lib'
-import { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import type { CommonKeyValueDB, IncrementTuple, KeyValueDBTuple } from '@naturalcycles/db-lib'
+import { commonKeyValueDBFullSupport, DBQuery } from '@naturalcycles/db-lib'
+import type { ObjectWithId } from '@naturalcycles/js-lib'
+import { AppError } from '@naturalcycles/js-lib'
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { DatastoreDB } from './datastore.db'
-import { DatastoreDBCfg } from './datastore.model'
+import type { DatastoreDBCfg } from './datastore.model'
 
 interface KVObject {
   id: string

package/src/query.util.ts

@@ -1,6 +1,6 @@
-import { PropertyFilter, Query } from '@google-cloud/datastore'
-import { DBQuery, DBQueryFilterOperator } from '@naturalcycles/db-lib'
-import { ObjectWithId, StringMap } from '@naturalcycles/js-lib'
+import type { PropertyFilter, Query } from '@google-cloud/datastore'
+import type { DBQuery, DBQueryFilterOperator } from '@naturalcycles/db-lib'
+import type { ObjectWithId, StringMap } from '@naturalcycles/js-lib'
 
 const FNAME_MAP: StringMap = {
   id: '__key__',
@@ -15,6 +15,7 @@ const OP_MAP: Partial<Record<DBQueryFilterOperator, string>> = {
 export function dbQueryToDatastoreQuery<ROW extends ObjectWithId>(
   dbQuery: Readonly<DBQuery<ROW>>,
   emptyQuery: Query,
+  propertyFilterClass: typeof PropertyFilter,
 ): Query {
   let q = emptyQuery
 
@@ -30,7 +31,7 @@ export function dbQueryToDatastoreQuery<ROW extends ObjectWithId>(
     // `a == null` will return just that - rows with null values
     let { op, val } = f
     if (val === undefined) val = null
-    q = q.filter(new PropertyFilter(f.name as string, OP_MAP[op] || (op as any), val))
+    q = q.filter(new propertyFilterClass(f.name as string, OP_MAP[op] || (op as any), val))
   }
 
   // limit