@naturalcycles/datastore-lib 3.19.2 → 3.21.0

package/dist/datastore.db.d.ts

@@ -30,7 +30,7 @@ export declare class DatastoreDB extends BaseCommonDB implements CommonDB {
     /**
      * Returns saved entities with generated id/updated/created (non-mutating!)
      */
-    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: DatastoreDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], opt?: DatastoreDBSaveOptions<ROW>): Promise<void>;
     deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: DatastoreDBOptions): Promise<number>;
     /**
      * Limitation: Datastore's delete returns void, so we always return all ids here as "deleted"

package/dist/datastore.db.js

@@ -13,6 +13,11 @@ const MAX_ITEMS = 500;
 const RETRY_ON = ['GOAWAY', 'UNAVAILABLE', 'UNKNOWN'];
 // Examples of errors:
 // UNKNOWN: Stream removed
+const methodMap = {
+    insert: 'insert',
+    update: 'update',
+    upsert: 'save',
+};
 /**
  * Datastore API:
  * https://googlecloudplatform.github.io/google-cloud-node/#/docs/datastore/1.0.3/datastore
@@ -147,8 +152,9 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
      */
     async saveBatch(table, rows, opt = {}) {
         const entities = rows.map(obj => this.toDatastoreEntity(table, obj, opt.excludeFromIndexes));
+        const method = methodMap[opt.saveMethod || 'upsert'] || 'save';
         const save = (0, js_lib_1.pRetryFn)(async (batch) => {
-            await (opt.tx || this.ds()).save(batch);
+            await (opt.tx || this.ds())[method](batch);
         }, {
             // Here we retry the GOAWAY errors that are somewhat common for Datastore
             // Currently only retrying them here in .saveBatch(), cause probably they're only thrown when saving
@@ -297,7 +303,8 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
         stats
             .filter(s => !s.property_name.includes('.') && s.property_name !== 'id') // filter out objectify's "virtual properties"
             .forEach(stats => {
-            const { property_name: name, property_type: dtype } = stats;
+            const { property_type: dtype } = stats;
+            const name = stats.property_name;
             if (dtype === datastore_model_1.DatastoreType.Blob) {
                 s.properties[name] = {
                     instanceof: 'Buffer',

package/dist/datastore.model.d.ts

@@ -88,7 +88,7 @@ export interface DatastoreDBStreamOptions extends DatastoreDBOptions {
 export interface DatastoreDBOptions extends CommonDBOptions {
     tx?: Transaction;
 }
-export interface DatastoreDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
+export interface DatastoreDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
     tx?: Transaction;
 }
 export interface DatastoreStats {

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import { DatastoreDB } from './datastore.db';
 import { DatastoreCredentials, DatastoreDBCfg, DatastoreDBOptions, DatastoreDBSaveOptions, DatastoreDBStreamOptions, DatastorePayload, DatastorePropertyStats, DatastoreStats, DatastoreType } from './datastore.model';
 import { DatastoreKeyValueDB, DatastoreKeyValueDBCfg } from './datastoreKeyValueDB';
-import { getDBAdapter } from './dbAdapter';
 export type { DatastorePayload, DatastoreDBCfg, DatastoreKeyValueDBCfg, DatastoreStats, DatastoreCredentials, DatastorePropertyStats, DatastoreDBStreamOptions, DatastoreDBOptions, DatastoreDBSaveOptions, };
-export { DatastoreDB, DatastoreType, getDBAdapter, DatastoreKeyValueDB };
+export { DatastoreDB, DatastoreType, DatastoreKeyValueDB };

package/dist/index.js

@@ -1,11 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatastoreKeyValueDB = exports.getDBAdapter = exports.DatastoreType = exports.DatastoreDB = void 0;
+exports.DatastoreKeyValueDB = exports.DatastoreType = exports.DatastoreDB = void 0;
 const datastore_db_1 = require("./datastore.db");
 Object.defineProperty(exports, "DatastoreDB", { enumerable: true, get: function () { return datastore_db_1.DatastoreDB; } });
 const datastore_model_1 = require("./datastore.model");
 Object.defineProperty(exports, "DatastoreType", { enumerable: true, get: function () { return datastore_model_1.DatastoreType; } });
 const datastoreKeyValueDB_1 = require("./datastoreKeyValueDB");
 Object.defineProperty(exports, "DatastoreKeyValueDB", { enumerable: true, get: function () { return datastoreKeyValueDB_1.DatastoreKeyValueDB; } });
-const dbAdapter_1 = require("./dbAdapter");
-Object.defineProperty(exports, "getDBAdapter", { enumerable: true, get: function () { return dbAdapter_1.getDBAdapter; } });

package/dist/query.util.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dbQueryToDatastoreQuery = void 0;
-// import Operator = google.datastore.v1.CompositeFilter.Operator
 const FNAME_MAP = {
     id: '__key__',
 };
 const OP_MAP = {
     '==': '=',
+    in: 'IN',
+    'not-in': 'NOT_IN',
 };
 function dbQueryToDatastoreQuery(dbQuery, emptyQuery) {
     let q = emptyQuery;

package/package.json

@@ -1,24 +1,21 @@
 {
   "name": "@naturalcycles/datastore-lib",
-  "version": "3.19.2",
+  "version": "3.21.0",
   "description": "Opinionated library to work with Google Datastore",
   "scripts": {
     "prepare": "husky install"
   },
-  "peerDependencies": {
-    "@google-cloud/datastore": ">=6.0.0"
-  },
   "dependencies": {
+    "@google-cloud/datastore": "^7.0.0",
     "@naturalcycles/db-lib": "^8.0.0",
     "@naturalcycles/js-lib": "^14.0.0",
     "@naturalcycles/nodejs-lib": "^12.0.0",
     "grpc": "^1.24.2"
   },
   "devDependencies": {
-    "@google-cloud/datastore": "^6.0.0",
-    "@naturalcycles/dev-lib": "^12.0.1",
+    "@naturalcycles/dev-lib": "^13.0.0",
     "@types/node": "^17.0.8",
-    "jest": "^27.0.4"
+    "jest": "^28.1.0"
   },
   "files": [
     "dist",

package/src/datastore.db.ts

@@ -3,6 +3,7 @@ import type { Datastore, Key, Query } from '@google-cloud/datastore'
 import {
   BaseCommonDB,
   CommonDB,
+  CommonDBSaveMethod,
   DBQuery,
   DBTransaction,
   mergeDBOperations,
@@ -48,6 +49,12 @@ const RETRY_ON = ['GOAWAY', 'UNAVAILABLE', 'UNKNOWN']
 // Examples of errors:
 // UNKNOWN: Stream removed
 
+const methodMap: Record<CommonDBSaveMethod, string> = {
+  insert: 'insert',
+  update: 'update',
+  upsert: 'save',
+}
+
 /**
  * Datastore API:
  * https://googlecloudplatform.github.io/google-cloud-node/#/docs/datastore/1.0.3/datastore
@@ -238,7 +245,7 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
   /**
    * Returns saved entities with generated id/updated/created (non-mutating!)
    */
-  override async saveBatch<ROW extends ObjectWithId>(
+  override async saveBatch<ROW extends Partial<ObjectWithId>>(
     table: string,
     rows: ROW[],
     opt: DatastoreDBSaveOptions<ROW> = {},
@@ -247,9 +254,11 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
       this.toDatastoreEntity(table, obj, opt.excludeFromIndexes as string[]),
     )
 
+    const method = methodMap[opt.saveMethod || 'upsert'] || 'save'
+
     const save = pRetryFn(
       async (batch: DatastorePayload<ROW>[]) => {
-        await (opt.tx || this.ds()).save(batch)
+        await (opt.tx || this.ds())[method](batch)
       },
       {
         // Here we retry the GOAWAY errors that are somewhat common for Datastore
@@ -439,7 +448,8 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     stats
       .filter(s => !s.property_name.includes('.') && s.property_name !== 'id') // filter out objectify's "virtual properties"
       .forEach(stats => {
-        const { property_name: name, property_type: dtype } = stats
+        const { property_type: dtype } = stats
+        const name = stats.property_name as keyof ROW
 
         if (dtype === DatastoreType.Blob) {
           s.properties[name] = {
@@ -479,7 +489,9 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
             } as JsonSchemaNull
           }
         } else {
-          throw new Error(`Unknown Datastore Type '${stats.property_type}' for ${table}.${name}`)
+          throw new Error(
+            `Unknown Datastore Type '${stats.property_type}' for ${table}.${name as string}`,
+          )
         }
       })
 

package/src/datastore.model.ts

@@ -102,7 +102,7 @@ export interface DatastoreDBStreamOptions extends DatastoreDBOptions {
 export interface DatastoreDBOptions extends CommonDBOptions {
   tx?: Transaction
 }
-export interface DatastoreDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId>
+export interface DatastoreDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId>
   extends CommonDBSaveOptions<ROW> {
   tx?: Transaction
 }

package/src/index.ts

@@ -11,7 +11,6 @@ import {
   DatastoreType,
 } from './datastore.model'
 import { DatastoreKeyValueDB, DatastoreKeyValueDBCfg } from './datastoreKeyValueDB'
-import { getDBAdapter } from './dbAdapter'
 
 export type {
   DatastorePayload,
@@ -25,4 +24,4 @@ export type {
   DatastoreDBSaveOptions,
 }
 
-export { DatastoreDB, DatastoreType, getDBAdapter, DatastoreKeyValueDB }
+export { DatastoreDB, DatastoreType, DatastoreKeyValueDB }

package/src/query.util.ts

@@ -1,7 +1,6 @@
 import { Query } from '@google-cloud/datastore'
 import { DBQuery, DBQueryFilterOperator } from '@naturalcycles/db-lib'
 import { ObjectWithId, StringMap } from '@naturalcycles/js-lib'
-// import Operator = google.datastore.v1.CompositeFilter.Operator
 
 const FNAME_MAP: StringMap = {
   id: '__key__',
@@ -9,6 +8,8 @@ const FNAME_MAP: StringMap = {
 
 const OP_MAP: Partial<Record<DBQueryFilterOperator, string>> = {
   '==': '=',
+  in: 'IN',
+  'not-in': 'NOT_IN',
 }
 
 export function dbQueryToDatastoreQuery<ROW extends ObjectWithId>(

package/dist/dbAdapter.d.ts

@@ -1,2 +0,0 @@
-import { DatastoreDB } from './datastore.db';
-export declare function getDBAdapter(cfgStr?: string): DatastoreDB;

package/dist/dbAdapter.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDBAdapter = void 0;
-const datastore_db_1 = require("./datastore.db");
-function getDBAdapter(cfgStr) {
-    const cfg = cfgStr
-        ? JSON.parse(cfgStr)
-        : {
-            useLegacyGRPC: true,
-        };
-    return new datastore_db_1.DatastoreDB(cfg);
-}
-exports.getDBAdapter = getDBAdapter;

package/src/dbAdapter.ts

@@ -1,11 +0,0 @@
-import { DatastoreDB } from './datastore.db'
-import { DatastoreDBCfg } from './datastore.model'
-
-export function getDBAdapter(cfgStr?: string): DatastoreDB {
-  const cfg: DatastoreDBCfg = cfgStr
-    ? JSON.parse(cfgStr)
-    : {
-        useLegacyGRPC: true,
-      }
-  return new DatastoreDB(cfg)
-}