@naturalcycles/db-lib 8.38.0 → 8.40.0

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,
@@ -410,7 +411,7 @@ class CommonDao {
     }
     async streamQueryIdsForEach(q, mapper, opt = {}) {
         q.table = opt.table || q.table;
-        opt.errorMode = opt.errorMode || js_lib_1.ErrorMode.SUPPRESS;
+        opt.errorMode || (opt.errorMode = js_lib_1.ErrorMode.SUPPRESS);
         const op = `streamQueryIdsForEach(${q.pretty()})`;
         const started = this.logStarted(op, q.table, true);
         let count = 0;
@@ -450,19 +451,20 @@ 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;
         if (opt.ensureUniqueId && idWasGenerated)
             await this.ensureUniqueId(table, dbm);
-        if (this.cfg.immutable && !opt.allowMutability) {
-            opt.saveMethod || (opt.saveMethod = 'insert');
+        if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
+            opt = { ...opt, saveMethod: 'insert' };
         }
         const op = `save(${dbm.id})`;
         const started = this.logSaveStarted(op, bm, table);
         await this.cfg.db.saveBatch(table, [dbm], {
             excludeFromIndexes: this.cfg.excludeFromIndexes,
+            assignGeneratedIds: this.cfg.assignGeneratedIds,
             ...opt,
         });
         this.logSaveResult(started, op, table);
@@ -496,19 +498,20 @@ class CommonDao {
         // assigning id in case it misses the id
         // will override/set `updated` field, unless opts.preserveUpdated is set
         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);
         }
-        if (this.cfg.immutable && !opt.allowMutability) {
-            opt.saveMethod || (opt.saveMethod = 'insert');
+        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,
+            assignGeneratedIds: this.cfg.assignGeneratedIds,
             ...opt,
         });
         this.logSaveResult(started, op, table);
@@ -521,8 +524,8 @@ class CommonDao {
         const dbms = await this.bmsToDBM(bms, 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.saveMethod = 'insert');
+        if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
+            opt = { ...opt, saveMethod: 'insert' };
         }
         const op = `saveBatch ${dbms.length} row(s) (${(0, js_lib_1._truncate)(dbms
             .slice(0, 10)
@@ -531,6 +534,7 @@ class CommonDao {
         const started = this.logSaveStarted(op, bms, table);
         await this.cfg.db.saveBatch(table, dbms, {
             excludeFromIndexes: this.cfg.excludeFromIndexes,
+            assignGeneratedIds: this.cfg.assignGeneratedIds,
             ...opt,
         });
         this.logSaveResult(started, op, table);
@@ -545,8 +549,8 @@ class CommonDao {
             if (opt.ensureUniqueId)
                 throw new js_lib_1.AppError('ensureUniqueId is not supported in saveBatch');
         }
-        if (this.cfg.immutable && !opt.allowMutability) {
-            opt.saveMethod || (opt.saveMethod = 'insert');
+        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
             .slice(0, 10)
@@ -555,6 +559,7 @@ class CommonDao {
         const started = this.logSaveStarted(op, dbms, table);
         await this.cfg.db.saveBatch(table, dbms, {
             excludeFromIndexes: this.cfg.excludeFromIndexes,
+            assignGeneratedIds: this.cfg.assignGeneratedIds,
             ...opt,
         });
         this.logSaveResult(started, op, table);

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.0",
+  "version": "8.40.0",
   "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,
@@ -553,7 +554,7 @@ export class CommonDao<
     opt: CommonDaoStreamForEachOptions<ID> = {},
   ): Promise<void> {
     q.table = opt.table || q.table
-    opt.errorMode = opt.errorMode || ErrorMode.SUPPRESS
+    opt.errorMode ||= ErrorMode.SUPPRESS
 
     const op = `streamQueryIdsForEach(${q.pretty()})`
     const started = this.logStarted(op, q.table, true)
@@ -609,18 +610,19 @@ 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
     if (opt.ensureUniqueId && idWasGenerated) await this.ensureUniqueId(table, dbm)
-    if (this.cfg.immutable && !opt.allowMutability) {
-      opt.saveMethod ||= 'insert'
+    if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
+      opt = { ...opt, saveMethod: 'insert' }
     }
     const op = `save(${dbm.id})`
     const started = this.logSaveStarted(op, bm, table)
     await this.cfg.db.saveBatch(table, [dbm], {
       excludeFromIndexes: this.cfg.excludeFromIndexes,
+      assignGeneratedIds: this.cfg.assignGeneratedIds,
       ...opt,
     })
 
@@ -667,18 +669,19 @@ export class CommonDao<
     // assigning id in case it misses the id
     // will override/set `updated` field, unless opts.preserveUpdated is set
     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)
     }
-    if (this.cfg.immutable && !opt.allowMutability) {
-      opt.saveMethod ||= 'insert'
+    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,
+      assignGeneratedIds: this.cfg.assignGeneratedIds,
       ...opt,
     })
     this.logSaveResult(started, op, table)
@@ -691,8 +694,8 @@ export class CommonDao<
     bms.forEach(bm => this.assignIdCreatedUpdated(bm, opt))
     const dbms = await this.bmsToDBM(bms as BM[], opt)
     if (opt.ensureUniqueId) throw new AppError('ensureUniqueId is not supported in saveBatch')
-    if (this.cfg.immutable && !opt.allowMutability) {
-      opt.saveMethod ||= 'insert'
+    if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
+      opt = { ...opt, saveMethod: 'insert' }
     }
 
     const op = `saveBatch ${dbms.length} row(s) (${_truncate(
@@ -706,6 +709,7 @@ export class CommonDao<
 
     await this.cfg.db.saveBatch(table, dbms, {
       excludeFromIndexes: this.cfg.excludeFromIndexes,
+      assignGeneratedIds: this.cfg.assignGeneratedIds,
       ...opt,
     })
 
@@ -722,8 +726,8 @@ export class CommonDao<
       dbms = this.anyToDBMs(dbms, opt)
       if (opt.ensureUniqueId) throw new AppError('ensureUniqueId is not supported in saveBatch')
     }
-    if (this.cfg.immutable && !opt.allowMutability) {
-      opt.saveMethod ||= 'insert'
+    if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
+      opt = { ...opt, saveMethod: 'insert' }
     }
     const op = `saveBatchAsDBM ${dbms.length} row(s) (${_truncate(
       dbms
@@ -736,6 +740,7 @@ export class CommonDao<
 
     await this.cfg.db.saveBatch(table, dbms, {
       excludeFromIndexes: this.cfg.excludeFromIndexes,
+      assignGeneratedIds: this.cfg.assignGeneratedIds,
       ...opt,
     })
 

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',