@naturalcycles/db-lib 8.50.2 → 8.51.0

package/src/db.model.ts

@@ -74,6 +74,7 @@ export enum DBRelation {
 export enum DBModelType {
   DBM = 'DBM',
   BM = 'BM',
+  TM = 'TM',
 }
 
 /**

package/src/kv/commonKeyValueDB.ts

@@ -12,28 +12,28 @@ export interface CommonKeyValueDB {
   /**
    * Check that DB connection is working properly.
    */
-  ping(): Promise<void>
+  ping: () => Promise<void>
 
   /**
    * Will do like `create table ...` for mysql.
    * Caution! dropIfExists defaults to false. If set to true - will actually DROP the table!
    */
-  createTable(table: string, opt?: CommonDBCreateOptions): Promise<void>
+  createTable: (table: string, opt?: CommonDBCreateOptions) => Promise<void>
 
   /**
    * Returns an array of tuples [key, value]. Not found values are not returned (no error is thrown).
    *
    * Currently it is NOT required to maintain the same order as input `ids`.
    */
-  getByIds(table: string, ids: string[]): Promise<KeyValueDBTuple[]>
+  getByIds: (table: string, ids: string[]) => Promise<KeyValueDBTuple[]>
 
-  deleteByIds(table: string, ids: string[]): Promise<void>
+  deleteByIds: (table: string, ids: string[]) => Promise<void>
 
-  saveBatch(table: string, entries: KeyValueDBTuple[]): Promise<void>
+  saveBatch: (table: string, entries: KeyValueDBTuple[]) => Promise<void>
 
-  streamIds(table: string, limit?: number): ReadableTyped<string>
-  streamValues(table: string, limit?: number): ReadableTyped<Buffer>
-  streamEntries(table: string, limit?: number): ReadableTyped<KeyValueDBTuple>
+  streamIds: (table: string, limit?: number) => ReadableTyped<string>
+  streamValues: (table: string, limit?: number) => ReadableTyped<Buffer>
+  streamEntries: (table: string, limit?: number) => ReadableTyped<KeyValueDBTuple>
 
-  count(table: string): Promise<number>
+  count: (table: string) => Promise<number>
 }

package/src/kv/commonKeyValueDao.ts

@@ -32,9 +32,9 @@ export interface CommonKeyValueDaoCfg<T> {
   logStarted?: boolean
 
   hooks?: {
-    mapValueToBuffer?(v: T): Promise<Buffer>
-    mapBufferToValue?(b: Buffer): Promise<T>
-    beforeCreate?(v: Partial<T>): Partial<T>
+    mapValueToBuffer?: (v: T) => Promise<Buffer>
+    mapBufferToValue?: (b: Buffer) => Promise<T>
+    beforeCreate?: (v: Partial<T>) => Partial<T>
   }
 
   /**

package/src/query/dbQuery.ts

@@ -4,6 +4,7 @@ import {
   AsyncMapper,
   _truncate,
   Saved,
+  AnyObject,
   _objectAssign,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
@@ -60,13 +61,13 @@ export const dbQueryFilterOperatorValues: DBQueryFilterOperator[] = [
   'array-contains-any',
 ]
 
-export interface DBQueryFilter<ROW extends Partial<ObjectWithId> = AnyObjectWithId> {
+export interface DBQueryFilter<ROW extends ObjectWithId = AnyObjectWithId> {
   name: keyof ROW
   op: DBQueryFilterOperator
   val: any
 }
 
-export interface DBQueryOrder<ROW extends Partial<ObjectWithId> = AnyObjectWithId> {
+export interface DBQueryOrder<ROW extends ObjectWithId = AnyObjectWithId> {
   name: keyof ROW
   descending?: boolean
 }
@@ -81,7 +82,7 @@ export interface DBQueryOrder<ROW extends Partial<ObjectWithId> = AnyObjectWithI
  *
  * <DBM> is the type of **queried** object (so e.g `key of DBM` can be used), not **returned** object.
  */
-export class DBQuery<ROW extends Partial<ObjectWithId> = AnyObjectWithId> {
+export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
   constructor(public table: string) {}
 
   /**
@@ -91,7 +92,7 @@ export class DBQuery<ROW extends Partial<ObjectWithId> = AnyObjectWithId> {
     return new DBQuery(table)
   }
 
-  static fromPlainObject<ROW extends Partial<ObjectWithId> = AnyObjectWithId>(
+  static fromPlainObject<ROW extends ObjectWithId = AnyObjectWithId>(
     obj: Partial<DBQuery<ROW>> & { table: string },
   ): DBQuery<ROW> {
     return Object.assign(new DBQuery<ROW>(obj.table), obj)
@@ -235,14 +236,15 @@ export class DBQuery<ROW extends Partial<ObjectWithId> = AnyObjectWithId> {
  * DBQuery that has additional method to support Fluent API style.
  */
 export class RunnableDBQuery<
-  BM extends ObjectWithId<ID>,
-  DBM extends ObjectWithId<ID> = BM,
-  ID extends string | number = BM['id'],
+  BM extends Partial<ObjectWithId<ID>>,
+  DBM extends ObjectWithId<ID> = Saved<BM>,
+  TM extends AnyObject = BM,
+  ID extends string | number = string,
 > extends DBQuery<DBM> {
   /**
    * Pass `table` to override table.
    */
-  constructor(public dao: CommonDao<BM, DBM, ID>, table?: string) {
+  constructor(public dao: CommonDao<BM, DBM, TM, ID>, table?: string) {
     super(table || dao.cfg.table)
   }
 
@@ -258,6 +260,10 @@ export class RunnableDBQuery<
     return await this.dao.runQueryAsDBM(this, opt)
   }
 
+  async runQueryAsTM(opt?: CommonDaoOptions): Promise<TM[]> {
+    return await this.dao.runQueryAsTM(this, opt)
+  }
+
   async runQueryExtended(opt?: CommonDaoOptions): Promise<RunQueryResult<Saved<BM>>> {
     return await this.dao.runQueryExtended(this, opt)
   }
@@ -266,6 +272,10 @@ export class RunnableDBQuery<
     return await this.dao.runQueryExtendedAsDBM(this, opt)
   }
 
+  async runQueryExtendedAsTM(opt?: CommonDaoOptions): Promise<RunQueryResult<TM>> {
+    return await this.dao.runQueryExtendedAsTM(this, opt)
+  }
+
   async runQueryCount(opt?: CommonDaoOptions): Promise<number> {
     return await this.dao.runQueryCount(this, opt)
   }

package/src/testing/daoTest.ts

@@ -8,6 +8,7 @@ import {
   createTestItemsBM,
   testItemBMSchema,
   testItemDBMSchema,
+  testItemTMSchema,
   TEST_TABLE,
   createTestItemBM,
   testItemDBMJsonSchema,
@@ -24,6 +25,7 @@ export function runCommonDaoTest(
     db,
     dbmSchema: testItemDBMSchema,
     bmSchema: testItemBMSchema,
+    tmSchema: testItemTMSchema,
     logStarted: true,
     logLevel: CommonDaoLogLevel.DATA_FULL,
   })