@naturalcycles/db-lib 9.3.0 → 9.3.2

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { Transform } from 'node:stream';
-import { AnyObject, AsyncMapper, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, PartialObjectWithId, Saved, UnixTimestampMillisNumber, ZodSchema } from '@naturalcycles/js-lib';
+import { AnyObject, AsyncMapper, BaseDBEntity, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, PartialObjectWithId, Saved, UnixTimestampMillisNumber, ZodSchema } from '@naturalcycles/js-lib';
 import { AjvSchema, ObjectSchema, ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonDBTransactionOptions, DBModelType, DBPatch, DBTransaction, RunQueryResult } from '../db.model';
 import { DBQuery, RunnableDBQuery } from '../query/dbQuery';
@@ -60,11 +60,11 @@ export declare class CommonDao<BM extends PartialObjectWithId, DBM extends Parti
     runQueryExtendedAsTM(q: DBQuery<DBM>, opt?: CommonDaoOptions): Promise<RunQueryResult<TM>>;
     runQueryCount(q: DBQuery<DBM>, opt?: CommonDaoOptions): Promise<number>;
     streamQueryForEach(q: DBQuery<DBM>, mapper: AsyncMapper<Saved<BM>, void>, opt?: CommonDaoStreamForEachOptions<Saved<BM>>): Promise<void>;
-    streamQueryAsDBMForEach(q: DBQuery<DBM>, mapper: AsyncMapper<DBM, void>, opt?: CommonDaoStreamForEachOptions<DBM>): Promise<void>;
+    streamQueryAsDBMForEach(q: DBQuery<DBM>, mapper: AsyncMapper<Saved<DBM>, void>, opt?: CommonDaoStreamForEachOptions<DBM>): Promise<void>;
     /**
      * Stream as Readable, to be able to .pipe() it further with support of backpressure.
      */
-    streamQueryAsDBM(q: DBQuery<DBM>, opt?: CommonDaoStreamOptions<DBM>): ReadableTyped<DBM>;
+    streamQueryAsDBM(q: DBQuery<DBM>, opt?: CommonDaoStreamOptions<DBM>): ReadableTyped<Saved<DBM>>;
     /**
      * Stream as Readable, to be able to .pipe() it further with support of backpressure.
      *
@@ -82,8 +82,7 @@ export declare class CommonDao<BM extends PartialObjectWithId, DBM extends Parti
      * Mutates!
      * "Returns", just to have a type of "Saved"
      */
-    assignIdCreatedUpdated(obj: Partial<DBM>, opt?: CommonDaoOptions): Saved<Partial<DBM>>;
-    assignIdCreatedUpdated(obj: Partial<BM>, opt?: CommonDaoOptions): Saved<Partial<BM>>;
+    assignIdCreatedUpdated<T extends BaseDBEntity>(obj: T, opt?: CommonDaoOptions): Saved<T>;
     /**
      * Mutates with id, created, updated
      */

package/dist/commondao/common.dao.js

@@ -479,16 +479,17 @@ class CommonDao {
             this.cfg.logger?.log(`<< ${q.table}.${op}: ${count} id(s) in ${(0, js_lib_1._since)(started)}`);
         }
     }
+    /**
+     * Mutates!
+     * "Returns", just to have a type of "Saved"
+     */
     assignIdCreatedUpdated(obj, opt = {}) {
         const now = Math.floor(Date.now() / 1000);
         if (this.cfg.useCreatedProperty) {
-            ;
-            obj['created'] ||= obj['updated'] || now;
+            obj.created ||= obj.updated || now;
         }
         if (this.cfg.useUpdatedProperty) {
-            ;
-            obj['updated'] =
-                opt.preserveUpdatedCreated && obj['updated'] ? obj['updated'] : now;
+            obj.updated = opt.preserveUpdatedCreated && obj.updated ? obj.updated : now;
         }
         if (this.cfg.createId) {
             obj.id ||= this.cfg.hooks.createNaturalId?.(obj) || this.cfg.hooks.createRandomId();

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

@@ -1,4 +1,4 @@
-import { CommonLogger, ErrorMode, PartialObjectWithId, Promisable, Saved, ZodError, ZodSchema } from '@naturalcycles/js-lib';
+import { AnyObject, CommonLogger, ErrorMode, PartialObjectWithId, Promisable, Saved, ZodError, ZodSchema } from '@naturalcycles/js-lib';
 import { AjvSchema, AjvValidationError, JoiValidationError, ObjectSchema, TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib';
 import { CommonDB } from '../common.db';
 import { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions } from '../db.model';
@@ -104,7 +104,7 @@ export declare enum CommonDaoLogLevel {
      */
     DATA_FULL = 30
 }
-export interface CommonDaoCfg<BM extends PartialObjectWithId, DBM extends PartialObjectWithId = BM, TM = BM> {
+export interface CommonDaoCfg<BM extends PartialObjectWithId, DBM extends PartialObjectWithId = BM, TM extends AnyObject = BM> {
     db: CommonDB;
     table: string;
     /**

package/dist/query/dbQuery.d.ts

@@ -100,9 +100,9 @@ export declare class RunnableDBQuery<BM extends PartialObjectWithId, DBM extends
     runQueryCount(opt?: CommonDaoOptions): Promise<number>;
     updateByQuery(patch: DBPatch<DBM>, opt?: CommonDaoOptions): Promise<number>;
     streamQueryForEach(mapper: AsyncMapper<Saved<BM>, void>, opt?: CommonDaoStreamForEachOptions<Saved<BM>>): Promise<void>;
-    streamQueryAsDBMForEach(mapper: AsyncMapper<DBM, void>, opt?: CommonDaoStreamForEachOptions<DBM>): Promise<void>;
+    streamQueryAsDBMForEach(mapper: AsyncMapper<Saved<DBM>, void>, opt?: CommonDaoStreamForEachOptions<DBM>): Promise<void>;
     streamQuery(opt?: CommonDaoStreamOptions<Saved<BM>>): ReadableTyped<Saved<BM>>;
-    streamQueryAsDBM(opt?: CommonDaoStreamOptions<DBM>): ReadableTyped<DBM>;
+    streamQueryAsDBM(opt?: CommonDaoStreamOptions<DBM>): ReadableTyped<Saved<DBM>>;
     queryIds(opt?: CommonDaoOptions): Promise<string[]>;
     streamQueryIds(opt?: CommonDaoStreamOptions<string>): ReadableTyped<string>;
     streamQueryIdsForEach(mapper: AsyncMapper<string, void>, opt?: CommonDaoStreamForEachOptions<string>): Promise<void>;

package/package.json

@@ -40,7 +40,7 @@
   "engines": {
     "node": ">=18.12"
   },
-  "version": "9.3.0",
+  "version": "9.3.2",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

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

@@ -1,4 +1,5 @@
 import {
+  AnyObject,
   CommonLogger,
   ErrorMode,
   PartialObjectWithId,
@@ -138,7 +139,7 @@ export enum CommonDaoLogLevel {
 export interface CommonDaoCfg<
   BM extends PartialObjectWithId,
   DBM extends PartialObjectWithId = BM,
-  TM = BM,
+  TM extends AnyObject = BM,
 > {
   db: CommonDB
   table: string

package/src/commondao/common.dao.ts

@@ -13,6 +13,7 @@ import {
   AnyObject,
   AppError,
   AsyncMapper,
+  BaseDBEntity,
   CommonLogger,
   ErrorMode,
   JsonSchemaObject,
@@ -116,7 +117,7 @@ export class CommonDao<
   create(part: Partial<BM> = {}, opt: CommonDaoOptions = {}): Saved<BM> {
     const bm = this.cfg.hooks!.beforeCreate!(part)
     // First assignIdCreatedUpdated, then validate!
-    this.assignIdCreatedUpdated(bm as BM, opt)
+    this.assignIdCreatedUpdated(bm, opt)
     return this.validateAndConvert(bm, this.cfg.bmSchema, DBModelType.BM, opt)
   }
 
@@ -483,7 +484,7 @@ export class CommonDao<
 
   async streamQueryAsDBMForEach(
     q: DBQuery<DBM>,
-    mapper: AsyncMapper<DBM, void>,
+    mapper: AsyncMapper<Saved<DBM>, void>,
     opt: CommonDaoStreamForEachOptions<DBM> = {},
   ): Promise<void> {
     q.table = opt.table || q.table
@@ -514,7 +515,7 @@ export class CommonDao<
           errorMode: opt.errorMode,
         },
       ),
-      transformMap<DBM, void>(mapper, {
+      transformMap<Saved<DBM>, void>(mapper, {
         ...opt,
         predicate: _passthroughPredicate, // to be able to logProgress
       }),
@@ -534,7 +535,10 @@ export class CommonDao<
   /**
    * Stream as Readable, to be able to .pipe() it further with support of backpressure.
    */
-  streamQueryAsDBM(q: DBQuery<DBM>, opt: CommonDaoStreamOptions<DBM> = {}): ReadableTyped<DBM> {
+  streamQueryAsDBM(
+    q: DBQuery<DBM>,
+    opt: CommonDaoStreamOptions<DBM> = {},
+  ): ReadableTyped<Saved<DBM>> {
     q.table = opt.table || q.table
     opt.skipValidation = opt.skipValidation !== false // default true
     opt.skipConversion = opt.skipConversion !== false // default true
@@ -674,28 +678,22 @@ export class CommonDao<
    * Mutates!
    * "Returns", just to have a type of "Saved"
    */
-  assignIdCreatedUpdated(obj: Partial<DBM>, opt?: CommonDaoOptions): Saved<Partial<DBM>>
-  assignIdCreatedUpdated(obj: Partial<BM>, opt?: CommonDaoOptions): Saved<Partial<BM>>
-  assignIdCreatedUpdated(
-    obj: Partial<DBM> | Partial<BM>,
-    opt: CommonDaoOptions = {},
-  ): Saved<Partial<DBM>> | Saved<Partial<BM>> {
+  assignIdCreatedUpdated<T extends BaseDBEntity>(obj: T, opt: CommonDaoOptions = {}): Saved<T> {
     const now = Math.floor(Date.now() / 1000)
 
     if (this.cfg.useCreatedProperty) {
-      ;(obj as any)['created'] ||= (obj as any)['updated'] || now
+      obj.created ||= obj.updated || now
     }
 
     if (this.cfg.useUpdatedProperty) {
-      ;(obj as any)['updated'] =
-        opt.preserveUpdatedCreated && (obj as any)['updated'] ? (obj as any)['updated'] : now
+      obj.updated = opt.preserveUpdatedCreated && obj.updated ? obj.updated : now
     }
 
     if (this.cfg.createId) {
-      obj.id ||= this.cfg.hooks!.createNaturalId?.(obj as BM) || this.cfg.hooks!.createRandomId!()
+      obj.id ||= this.cfg.hooks!.createNaturalId?.(obj as any) || this.cfg.hooks!.createRandomId!()
     }
 
-    return obj as any
+    return obj as Saved<T>
   }
 
   // SAVE

package/src/query/dbQuery.ts

@@ -297,7 +297,7 @@ export class RunnableDBQuery<
   }
 
   async streamQueryAsDBMForEach(
-    mapper: AsyncMapper<DBM, void>,
+    mapper: AsyncMapper<Saved<DBM>, void>,
     opt?: CommonDaoStreamForEachOptions<DBM>,
   ): Promise<void> {
     await this.dao.streamQueryAsDBMForEach(this, mapper, opt)
@@ -307,7 +307,7 @@ export class RunnableDBQuery<
     return this.dao.streamQuery(this, opt)
   }
 
-  streamQueryAsDBM(opt?: CommonDaoStreamOptions<DBM>): ReadableTyped<DBM> {
+  streamQueryAsDBM(opt?: CommonDaoStreamOptions<DBM>): ReadableTyped<Saved<DBM>> {
     return this.dao.streamQueryAsDBM(this, opt)
   }