@naturalcycles/db-lib 8.38.1 → 8.40.1

package/dist/adapter/inmemory/queryInMemory.js

@@ -4,6 +4,7 @@ exports.queryInMemory = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const FILTER_FNS = {
     '==': (v, val) => v === val,
+    '!=': (v, val) => v !== val,
     '<': (v, val) => v < val,
     '<=': (v, val) => v <= val,
     '>': (v, val) => v > val,

package/dist/commondao/common.dao.js

@@ -28,6 +28,7 @@ class CommonDao {
             logLevel: isGAE || isCI ? common_dao_model_1.CommonDaoLogLevel.NONE : common_dao_model_1.CommonDaoLogLevel.OPERATIONS,
             idType: 'string',
             createId: true,
+            assignGeneratedIds: false,
             created: true,
             updated: true,
             logger: console,
@@ -450,7 +451,7 @@ class CommonDao {
      */
     async save(bm, opt = {}) {
         this.requireWriteAccess();
-        const idWasGenerated = !bm.id;
+        const idWasGenerated = !bm.id && this.cfg.createId;
         this.assignIdCreatedUpdated(bm, opt); // mutates
         const dbm = await this.bmToDBM(bm, opt);
         const table = opt.table || this.cfg.table;
@@ -461,10 +462,16 @@ class CommonDao {
         }
         const op = `save(${dbm.id})`;
         const started = this.logSaveStarted(op, bm, table);
+        const { excludeFromIndexes } = this.cfg;
+        const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds;
         await this.cfg.db.saveBatch(table, [dbm], {
-            excludeFromIndexes: this.cfg.excludeFromIndexes,
+            excludeFromIndexes,
+            assignGeneratedIds,
             ...opt,
         });
+        if (assignGeneratedIds) {
+            bm.id = dbm.id;
+        }
         this.logSaveResult(started, op, table);
         return bm;
     }
@@ -495,24 +502,31 @@ class CommonDao {
         const table = opt.table || this.cfg.table;
         // assigning id in case it misses the id
         // will override/set `updated` field, unless opts.preserveUpdated is set
+        let row = dbm;
         if (!opt.raw) {
-            const idWasGenerated = !dbm.id;
+            const idWasGenerated = !dbm.id && this.cfg.createId;
             this.assignIdCreatedUpdated(dbm, opt); // mutates
-            dbm = this.anyToDBM(dbm, opt);
+            row = this.anyToDBM(dbm, opt);
             if (opt.ensureUniqueId && idWasGenerated)
-                await this.ensureUniqueId(table, dbm);
+                await this.ensureUniqueId(table, row);
         }
         if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
             opt = { ...opt, saveMethod: 'insert' };
         }
-        const op = `saveAsDBM(${dbm.id})`;
-        const started = this.logSaveStarted(op, dbm, table);
-        await this.cfg.db.saveBatch(table, [dbm], {
-            excludeFromIndexes: this.cfg.excludeFromIndexes,
+        const op = `saveAsDBM(${row.id})`;
+        const started = this.logSaveStarted(op, row, table);
+        const { excludeFromIndexes } = this.cfg;
+        const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds;
+        await this.cfg.db.saveBatch(table, [row], {
+            excludeFromIndexes,
+            assignGeneratedIds,
             ...opt,
         });
+        if (assignGeneratedIds) {
+            dbm.id = row.id;
+        }
         this.logSaveResult(started, op, table);
-        return dbm;
+        return row;
     }
     async saveBatch(bms, opt = {}) {
         this.requireWriteAccess();
@@ -529,36 +543,49 @@ class CommonDao {
             .map(bm => bm.id)
             .join(', '), 50)})`;
         const started = this.logSaveStarted(op, bms, table);
+        const { excludeFromIndexes } = this.cfg;
+        const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds;
         await this.cfg.db.saveBatch(table, dbms, {
-            excludeFromIndexes: this.cfg.excludeFromIndexes,
+            excludeFromIndexes,
+            assignGeneratedIds,
             ...opt,
         });
+        if (assignGeneratedIds) {
+            dbms.forEach((dbm, i) => (bms[i].id = dbm.id));
+        }
         this.logSaveResult(started, op, table);
         return bms;
     }
     async saveBatchAsDBM(dbms, opt = {}) {
         this.requireWriteAccess();
         const table = opt.table || this.cfg.table;
+        let rows = dbms;
         if (!opt.raw) {
             dbms.forEach(dbm => this.assignIdCreatedUpdated(dbm, opt)); // mutates
-            dbms = this.anyToDBMs(dbms, opt);
+            rows = this.anyToDBMs(dbms, opt);
             if (opt.ensureUniqueId)
                 throw new js_lib_1.AppError('ensureUniqueId is not supported in saveBatch');
         }
         if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
             opt = { ...opt, saveMethod: 'insert' };
         }
-        const op = `saveBatchAsDBM ${dbms.length} row(s) (${(0, js_lib_1._truncate)(dbms
+        const op = `saveBatchAsDBM ${rows.length} row(s) (${(0, js_lib_1._truncate)(rows
             .slice(0, 10)
             .map(bm => bm.id)
             .join(', '), 50)})`;
-        const started = this.logSaveStarted(op, dbms, table);
-        await this.cfg.db.saveBatch(table, dbms, {
-            excludeFromIndexes: this.cfg.excludeFromIndexes,
+        const started = this.logSaveStarted(op, rows, table);
+        const { excludeFromIndexes } = this.cfg;
+        const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds;
+        await this.cfg.db.saveBatch(table, rows, {
+            excludeFromIndexes,
+            assignGeneratedIds,
             ...opt,
         });
+        if (assignGeneratedIds) {
+            rows.forEach((row, i) => (dbms[i].id = row.id));
+        }
         this.logSaveResult(started, op, table);
-        return dbms;
+        return rows;
     }
     async deleteById(id, opt = {}) {
         if (!id)

package/dist/commondao/common.dao.model.d.ts

@@ -86,6 +86,11 @@ export interface CommonDaoCfg<BM extends Partial<ObjectWithId<ID>>, DBM extends
      * Useful e.g when your DB is generating ids by itself (e.g mysql auto_increment).
      */
     createId?: boolean;
+    /**
+     * See the same option in CommonDB.
+     * Defaults to false normally.
+     */
+    assignGeneratedIds?: boolean;
     /**
      * Defaults to true
      * Set to false to disable `created` field management.

package/dist/db.model.d.ts

@@ -19,6 +19,13 @@ export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObje
      * Default is `upsert`
      */
     saveMethod?: CommonDBSaveMethod;
+    /**
+     * Only applicable to tables where id is "auto-generated by DB", e.g `auto_increment` in MySQL.
+     * By default it's false, so, auto-generated id will NOT be assigned/returned.
+     * Setting it to true will assign and return auto-generated id (on all rows, one by one).
+     * It's not true by default, because getting auto-generated id incurs an overhead of doing extra call (e.g LAST_INSERT_ID() in MySQL).
+     */
+    assignGeneratedIds?: boolean;
 }
 export declare type CommonDBStreamOptions = CommonDBOptions;
 export interface CommonDBCreateOptions extends CommonDBOptions {

package/dist/query/dbQuery.d.ts

@@ -22,8 +22,8 @@ import { RunQueryResult } from '../db.model';
  *
  * You may also look at queryInMemory() for its implementation (it implements all those).
  */
-export declare type DBQueryFilterOperator = '<' | '<=' | '==' | '>=' | '>' | 'in' | 'not-in' | 'array-contains' | 'array-contains-any';
-export declare const dbQueryFilterOperatorValues: string[];
+export declare type DBQueryFilterOperator = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'in' | 'not-in' | 'array-contains' | 'array-contains-any';
+export declare const dbQueryFilterOperatorValues: DBQueryFilterOperator[];
 export interface DBQueryFilter<ROW extends ObjectWithId = AnyObjectWithId> {
     name: keyof ROW;
     op: DBQueryFilterOperator;

package/dist/query/dbQuery.js

@@ -6,6 +6,7 @@ exports.dbQueryFilterOperatorValues = [
     '<',
     '<=',
     '==',
+    '!=',
     '>=',
     '>',
     'in',

package/package.json

@@ -12,7 +12,7 @@
     "@naturalcycles/bench-lib": "^1.0.0",
     "@naturalcycles/dev-lib": "^12.0.1",
     "@types/node": "^17.0.0",
-    "jest": "^27.0.3",
+    "jest": "^28.0.3",
     "weak-napi": "^2.0.2"
   },
   "files": [
@@ -42,7 +42,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.38.1",
+  "version": "8.40.1",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/adapter/inmemory/queryInMemory.ts

@@ -4,6 +4,7 @@ import { DBQuery, DBQueryFilterOperator } from '../../query/dbQuery'
 type FilterFn = (v: any, val: any) => boolean
 const FILTER_FNS: Record<DBQueryFilterOperator, FilterFn> = {
   '==': (v, val) => v === val,
+  '!=': (v, val) => v !== val,
   '<': (v, val) => v < val,
   '<=': (v, val) => v <= val,
   '>': (v, val) => v > val,

package/src/commondao/common.dao.model.ts

@@ -119,6 +119,12 @@ export interface CommonDaoCfg<
    */
   createId?: boolean
 
+  /**
+   * See the same option in CommonDB.
+   * Defaults to false normally.
+   */
+  assignGeneratedIds?: boolean
+
   /**
    * Defaults to true
    * Set to false to disable `created` field management.

package/src/commondao/common.dao.ts

@@ -73,6 +73,7 @@ export class CommonDao<
       logLevel: isGAE || isCI ? CommonDaoLogLevel.NONE : CommonDaoLogLevel.OPERATIONS,
       idType: 'string',
       createId: true,
+      assignGeneratedIds: false,
       created: true,
       updated: true,
       logger: console,
@@ -609,7 +610,7 @@ export class CommonDao<
    */
   async save(bm: Unsaved<BM>, opt: CommonDaoSaveOptions<DBM> = {}): Promise<Saved<BM>> {
     this.requireWriteAccess()
-    const idWasGenerated = !bm.id
+    const idWasGenerated = !bm.id && this.cfg.createId
     this.assignIdCreatedUpdated(bm, opt) // mutates
     const dbm = await this.bmToDBM(bm as BM, opt)
     const table = opt.table || this.cfg.table
@@ -619,11 +620,18 @@ export class CommonDao<
     }
     const op = `save(${dbm.id})`
     const started = this.logSaveStarted(op, bm, table)
+    const { excludeFromIndexes } = this.cfg
+    const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds
     await this.cfg.db.saveBatch(table, [dbm], {
-      excludeFromIndexes: this.cfg.excludeFromIndexes,
+      excludeFromIndexes,
+      assignGeneratedIds,
       ...opt,
     })
 
+    if (assignGeneratedIds) {
+      bm.id = dbm.id as any
+    }
+
     this.logSaveResult(started, op, table)
     return bm as any
   }
@@ -666,23 +674,32 @@ export class CommonDao<
 
     // assigning id in case it misses the id
     // will override/set `updated` field, unless opts.preserveUpdated is set
+    let row = dbm
     if (!opt.raw) {
-      const idWasGenerated = !dbm.id
+      const idWasGenerated = !dbm.id && this.cfg.createId
       this.assignIdCreatedUpdated(dbm, opt) // mutates
-      dbm = this.anyToDBM(dbm, opt)
-      if (opt.ensureUniqueId && idWasGenerated) await this.ensureUniqueId(table, dbm)
+      row = this.anyToDBM(dbm, opt)
+      if (opt.ensureUniqueId && idWasGenerated) await this.ensureUniqueId(table, row)
     }
     if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
       opt = { ...opt, saveMethod: 'insert' }
     }
-    const op = `saveAsDBM(${dbm.id})`
-    const started = this.logSaveStarted(op, dbm, table)
-    await this.cfg.db.saveBatch(table, [dbm], {
-      excludeFromIndexes: this.cfg.excludeFromIndexes,
+    const op = `saveAsDBM(${row.id})`
+    const started = this.logSaveStarted(op, row, table)
+    const { excludeFromIndexes } = this.cfg
+    const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds
+    await this.cfg.db.saveBatch(table, [row], {
+      excludeFromIndexes,
+      assignGeneratedIds,
       ...opt,
     })
+
+    if (assignGeneratedIds) {
+      dbm.id = row.id
+    }
+
     this.logSaveResult(started, op, table)
-    return dbm
+    return row
   }
 
   async saveBatch(bms: Unsaved<BM>[], opt: CommonDaoSaveOptions<DBM> = {}): Promise<Saved<BM>[]> {
@@ -703,12 +720,19 @@ export class CommonDao<
       50,
     )})`
     const started = this.logSaveStarted(op, bms, table)
+    const { excludeFromIndexes } = this.cfg
+    const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds
 
     await this.cfg.db.saveBatch(table, dbms, {
-      excludeFromIndexes: this.cfg.excludeFromIndexes,
+      excludeFromIndexes,
+      assignGeneratedIds,
       ...opt,
     })
 
+    if (assignGeneratedIds) {
+      dbms.forEach((dbm, i) => (bms[i]!.id = dbm.id as any))
+    }
+
     this.logSaveResult(started, op, table)
 
     return bms as any[]
@@ -717,30 +741,38 @@ export class CommonDao<
   async saveBatchAsDBM(dbms: DBM[], opt: CommonDaoSaveOptions<DBM> = {}): Promise<DBM[]> {
     this.requireWriteAccess()
     const table = opt.table || this.cfg.table
+    let rows = dbms
     if (!opt.raw) {
       dbms.forEach(dbm => this.assignIdCreatedUpdated(dbm, opt)) // mutates
-      dbms = this.anyToDBMs(dbms, opt)
+      rows = this.anyToDBMs(dbms, opt)
       if (opt.ensureUniqueId) throw new AppError('ensureUniqueId is not supported in saveBatch')
     }
     if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
       opt = { ...opt, saveMethod: 'insert' }
     }
-    const op = `saveBatchAsDBM ${dbms.length} row(s) (${_truncate(
-      dbms
+    const op = `saveBatchAsDBM ${rows.length} row(s) (${_truncate(
+      rows
         .slice(0, 10)
         .map(bm => bm.id)
         .join(', '),
       50,
     )})`
-    const started = this.logSaveStarted(op, dbms, table)
+    const started = this.logSaveStarted(op, rows, table)
+    const { excludeFromIndexes } = this.cfg
+    const assignGeneratedIds = opt.assignGeneratedIds || this.cfg.assignGeneratedIds
 
-    await this.cfg.db.saveBatch(table, dbms, {
-      excludeFromIndexes: this.cfg.excludeFromIndexes,
+    await this.cfg.db.saveBatch(table, rows, {
+      excludeFromIndexes,
+      assignGeneratedIds,
       ...opt,
     })
 
+    if (assignGeneratedIds) {
+      rows.forEach((row, i) => (dbms[i]!.id = row.id))
+    }
+
     this.logSaveResult(started, op, table)
-    return dbms
+    return rows
   }
 
   // DELETE

package/src/db.model.ts

@@ -24,6 +24,14 @@ export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObje
    * Default is `upsert`
    */
   saveMethod?: CommonDBSaveMethod
+
+  /**
+   * Only applicable to tables where id is "auto-generated by DB", e.g `auto_increment` in MySQL.
+   * By default it's false, so, auto-generated id will NOT be assigned/returned.
+   * Setting it to true will assign and return auto-generated id (on all rows, one by one).
+   * It's not true by default, because getting auto-generated id incurs an overhead of doing extra call (e.g LAST_INSERT_ID() in MySQL).
+   */
+  assignGeneratedIds?: boolean
 }
 
 export type CommonDBStreamOptions = CommonDBOptions

package/src/query/dbQuery.ts

@@ -27,6 +27,7 @@ export type DBQueryFilterOperator =
   | '<'
   | '<='
   | '=='
+  | '!='
   | '>='
   | '>'
   | 'in'
@@ -34,10 +35,11 @@ export type DBQueryFilterOperator =
   | 'array-contains'
   | 'array-contains-any'
 
-export const dbQueryFilterOperatorValues = [
+export const dbQueryFilterOperatorValues: DBQueryFilterOperator[] = [
   '<',
   '<=',
   '==',
+  '!=',
   '>=',
   '>',
   'in',