@naturalcycles/db-lib 8.34.2 → 8.36.1

package/src/index.ts

@@ -6,25 +6,16 @@ import { DBLibError } from './cnst'
 import { CommonDB } from './common.db'
 import { CommonDao } from './commondao/common.dao'
 import {
-  CommonDaoAnonymizeHook,
-  CommonDaoBeforeBMToDBMHook,
-  CommonDaoBeforeBMToTMHook,
-  CommonDaoBeforeCreateHook,
-  CommonDaoBeforeDBMToBMHook,
-  CommonDaoBeforeDBMValidateHook,
-  CommonDaoBeforeTMToBMHook,
   CommonDaoCfg,
-  CommonDaoCreateIdHook,
   CommonDaoCreateOptions,
   CommonDaoLogLevel,
   CommonDaoOptions,
-  CommonDaoParseNaturalIdHook,
   CommonDaoSaveOptions,
   CommonDaoStreamForEachOptions,
   CommonDaoStreamOptions,
+  CommonDaoHooks,
 } from './commondao/common.dao.model'
 import {
-  CommonDBAdapter,
   CommonDBCreateOptions,
   CommonDBOptions,
   CommonDBSaveOptions,
@@ -36,7 +27,6 @@ import {
   DBSaveBatchOperation,
   RunQueryResult,
 } from './db.model'
-import { getDB } from './getDB'
 import { CommonKeyValueDao, CommonKeyValueDaoCfg } from './kv/commonKeyValueDao'
 import { CommonKeyValueDB, KeyValueDBTuple } from './kv/commonKeyValueDB'
 import {
@@ -69,6 +59,7 @@ export type {
   CommonDaoSaveOptions,
   CommonDaoStreamForEachOptions,
   CommonDaoStreamOptions,
+  CommonDaoHooks,
   CommonDBOptions,
   CommonDBSaveOptions,
   CommonDBStreamOptions,
@@ -76,21 +67,11 @@ export type {
   CommonDB,
   RunQueryResult,
   CommonDaoCfg,
-  CommonDaoCreateIdHook,
-  CommonDaoParseNaturalIdHook,
-  CommonDaoBeforeCreateHook,
-  CommonDaoBeforeDBMValidateHook,
-  CommonDaoBeforeDBMToBMHook,
-  CommonDaoBeforeBMToDBMHook,
-  CommonDaoBeforeTMToBMHook,
-  CommonDaoBeforeBMToTMHook,
-  CommonDaoAnonymizeHook,
   InMemoryDBCfg,
   InMemoryKeyValueDBCfg,
   DBPipelineBackupOptions,
   DBPipelineRestoreOptions,
   DBPipelineCopyOptions,
-  CommonDBAdapter,
   DBOperation,
   DBSaveBatchOperation,
   DBDeleteByIdsOperation,
@@ -117,7 +98,6 @@ export {
   dbPipelineBackup,
   dbPipelineRestore,
   dbPipelineCopy,
-  getDB,
   DBLibError,
   BaseCommonDB,
   DBTransaction,

package/src/model.util.ts

@@ -1,5 +1,5 @@
 import { stringId } from '@naturalcycles/nodejs-lib'
-import { CreatedUpdated, CreatedUpdatedId, ObjectWithId } from '@naturalcycles/js-lib'
+import { CreatedUpdated, CreatedUpdatedId } from '@naturalcycles/js-lib'
 
 export function createdUpdatedFields(
   existingObject?: Partial<CreatedUpdated> | null,
@@ -12,8 +12,8 @@ export function createdUpdatedFields(
 }
 
 export function createdUpdatedIdFields(
-  existingObject?: Partial<CreatedUpdatedId> | null,
-): CreatedUpdatedId {
+  existingObject?: Partial<CreatedUpdatedId<string>> | null,
+): CreatedUpdatedId<string> {
   const now = Math.floor(Date.now() / 1000)
   return {
     created: existingObject?.created || now,
@@ -22,12 +22,6 @@ export function createdUpdatedIdFields(
   }
 }
 
-export function idField(existingObject?: Partial<CreatedUpdatedId> | null): ObjectWithId {
-  return {
-    id: existingObject?.id || stringId(),
-  }
-}
-
 export function deserializeJsonField<T = any>(f?: string): T {
   return JSON.parse(f || '{}')
 }

package/src/pipeline/dbPipelineBackup.ts

@@ -1,5 +1,12 @@
 import { createGzip, ZlibOptions } from 'zlib'
-import { AppError, AsyncMapper, ErrorMode, pMap, _passthroughMapper } from '@naturalcycles/js-lib'
+import {
+  AppError,
+  AsyncMapper,
+  ErrorMode,
+  pMap,
+  _passthroughMapper,
+  localTime,
+} from '@naturalcycles/js-lib'
 import {
   NDJsonStats,
   transformLogProgress,
@@ -11,7 +18,6 @@ import {
   _pipeline,
 } from '@naturalcycles/nodejs-lib'
 import { boldWhite, dimWhite, grey, yellow } from '@naturalcycles/nodejs-lib/dist/colors'
-import { dayjs } from '@naturalcycles/time-lib'
 import * as fs from 'fs-extra'
 import { CommonDB } from '../common.db'
 import { DBQuery } from '../index'
@@ -144,7 +150,7 @@ export async function dbPipelineBackup(opt: DBPipelineBackupOptions): Promise<ND
 
   let { tables } = opt
 
-  const sinceUpdatedStr = sinceUpdated ? ' since ' + grey(dayjs.unix(sinceUpdated).toPretty()) : ''
+  const sinceUpdatedStr = sinceUpdated ? ' since ' + grey(localTime(sinceUpdated).toPretty()) : ''
 
   console.log(
     `>> ${dimWhite('dbPipelineBackup')} started in ${grey(outputDirPath)}...${sinceUpdatedStr}`,

package/src/pipeline/dbPipelineCopy.ts

@@ -1,4 +1,4 @@
-import { AsyncMapper, ErrorMode, pMap, _passthroughMapper } from '@naturalcycles/js-lib'
+import { AsyncMapper, ErrorMode, pMap, _passthroughMapper, localTime } from '@naturalcycles/js-lib'
 import {
   NDJsonStats,
   transformBuffer,
@@ -11,7 +11,6 @@ import {
   _pipeline,
 } from '@naturalcycles/nodejs-lib'
 import { boldWhite, dimWhite, grey, yellow } from '@naturalcycles/nodejs-lib/dist/colors'
-import { dayjs } from '@naturalcycles/time-lib'
 import { CommonDB } from '../common.db'
 import { CommonDBSaveOptions } from '../db.model'
 import { DBQuery } from '../query/dbQuery'
@@ -103,7 +102,7 @@ export async function dbPipelineCopy(opt: DBPipelineCopyOptions): Promise<NDJson
 
   let { tables } = opt
 
-  const sinceUpdatedStr = sinceUpdated ? ' since ' + grey(dayjs.unix(sinceUpdated).toPretty()) : ''
+  const sinceUpdatedStr = sinceUpdated ? ' since ' + grey(localTime(sinceUpdated).toPretty()) : ''
 
   console.log(`>> ${dimWhite('dbPipelineCopy')} started...${sinceUpdatedStr}`)
 

package/src/pipeline/dbPipelineRestore.ts

@@ -7,6 +7,7 @@ import {
   _mapValues,
   _passthroughMapper,
   SavedDBEntity,
+  localTime,
 } from '@naturalcycles/js-lib'
 import {
   NDJsonStats,
@@ -24,7 +25,6 @@ import {
   _pipeline,
 } from '@naturalcycles/nodejs-lib'
 import { boldWhite, dimWhite, grey, yellow } from '@naturalcycles/nodejs-lib/dist/colors'
-import { dayjs } from '@naturalcycles/time-lib'
 import * as fs from 'fs-extra'
 import { CommonDB } from '../common.db'
 import { CommonDBSaveOptions } from '../index'
@@ -133,7 +133,7 @@ export async function dbPipelineRestore(opt: DBPipelineRestoreOptions): Promise<
   const strict = errorMode !== ErrorMode.SUPPRESS
   const onlyTables = opt.tables && new Set(opt.tables)
 
-  const sinceUpdatedStr = sinceUpdated ? ' since ' + grey(dayjs.unix(sinceUpdated).toPretty()) : ''
+  const sinceUpdatedStr = sinceUpdated ? ' since ' + grey(localTime(sinceUpdated).toPretty()) : ''
 
   console.log(
     `>> ${dimWhite('dbPipelineRestore')} started in ${grey(inputDirPath)}...${sinceUpdatedStr}`,

package/src/query/dbQuery.ts

@@ -216,14 +216,15 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
  * DBQuery that has additional method to support Fluent API style.
  */
 export class RunnableDBQuery<
-  BM extends Partial<ObjectWithId>,
-  DBM extends ObjectWithId,
+  BM extends Partial<ObjectWithId<ID>>,
+  DBM extends ObjectWithId<ID>,
   TM,
+  ID extends string | number,
 > extends DBQuery<DBM> {
   /**
    * Pass `table` to override table.
    */
-  constructor(public dao: CommonDao<BM, DBM, TM>, table?: string) {
+  constructor(public dao: CommonDao<BM, DBM, TM, ID>, table?: string) {
     super(table || dao.cfg.table)
   }
 
@@ -281,17 +282,17 @@ export class RunnableDBQuery<
     return this.dao.streamQueryAsDBM(this, opt)
   }
 
-  async queryIds(opt?: CommonDaoOptions): Promise<string[]> {
+  async queryIds(opt?: CommonDaoOptions): Promise<ID[]> {
     return await this.dao.queryIds(this, opt)
   }
 
-  streamQueryIds(opt?: CommonDaoStreamOptions): ReadableTyped<string> {
+  streamQueryIds(opt?: CommonDaoStreamOptions): ReadableTyped<ID> {
     return this.dao.streamQueryIds(this, opt)
   }
 
   async streamQueryIdsForEach(
-    mapper: AsyncMapper<string, void>,
-    opt?: CommonDaoStreamForEachOptions<string>,
+    mapper: AsyncMapper<ID, void>,
+    opt?: CommonDaoStreamForEachOptions<ID>,
   ): Promise<void> {
     await this.dao.streamQueryIdsForEach(this, mapper, opt)
   }

package/dist/adapter/inmemory/index.d.ts

@@ -1,3 +0,0 @@
-import { CommonDB } from '../../common.db';
-export declare function getDBAdapter(): CommonDB;
-export {};

package/dist/adapter/inmemory/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDBAdapter = void 0;
-const inMemory_db_1 = require("./inMemory.db");
-function getDBAdapter() {
-    return new inMemory_db_1.InMemoryDB();
-}
-exports.getDBAdapter = getDBAdapter;

package/dist/getDB.d.ts

@@ -1,19 +0,0 @@
-import { CommonDB } from './common.db';
-/**
- * Returns pre-configured DB
- *
- * @param index defaults to 1
- *
- * Requires process.env.DB${index} to be set to the name of the adapter, e.g `mysql-lib` or `db-lib/adapter/inmemory`.
- * Requires (by most adapters) process.env.SECRET_DB${index} to contain a "connection string" to that DB. Usually a JSON.stringified object,
- * but depends on the adapter.
- */
-export declare function getDB(index?: number): CommonDB;
-declare global {
-    namespace NodeJS {
-        interface ProcessEnv {
-            DB1?: string;
-            DB2?: string;
-        }
-    }
-}

package/dist/getDB.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDB = void 0;
-const js_lib_1 = require("@naturalcycles/js-lib");
-const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const colors_1 = require("@naturalcycles/nodejs-lib/dist/colors");
-/**
- * Returns pre-configured DB
- *
- * @param index defaults to 1
- *
- * Requires process.env.DB${index} to be set to the name of the adapter, e.g `mysql-lib` or `db-lib/adapter/inmemory`.
- * Requires (by most adapters) process.env.SECRET_DB${index} to contain a "connection string" to that DB. Usually a JSON.stringified object,
- * but depends on the adapter.
- */
-function getDB(index = 1) {
-    return _getDB(index);
-}
-exports.getDB = getDB;
-// Extra function to provide index=1 as default (since memo doesn't work well with default arguments)
-const _getDB = (0, js_lib_1._memoFn)((index) => {
-    const libName = process.env[`DB${index}`];
-    if (!libName) {
-        throw new Error(`getDB(${(0, colors_1.yellow)(index)}), but process.env.${(0, colors_1.white)('DB' + index)} is not defined!`);
-    }
-    const lib = require(libName);
-    if (!lib.getDBAdapter) {
-        throw new Error(`DB${index}=${libName}, but require('${libName}').getDBAdapter() is not defined`);
-    }
-    const cfg = (0, nodejs_lib_1.secretOptional)(`SECRET_DB${index}`);
-    return lib.getDBAdapter(cfg);
-});

package/src/adapter/inmemory/index.ts

@@ -1,9 +0,0 @@
-import { CommonDB } from '../../common.db'
-import { InMemoryDB } from './inMemory.db'
-
-export function getDBAdapter(): CommonDB {
-  return new InMemoryDB()
-}
-
-export // InMemoryDB, // no, otherwise it's double-exported, which can confuse IDEs
- {}

package/src/getDB.ts

@@ -1,50 +0,0 @@
-import { _memoFn } from '@naturalcycles/js-lib'
-import { secretOptional } from '@naturalcycles/nodejs-lib'
-import { white, yellow } from '@naturalcycles/nodejs-lib/dist/colors'
-import { CommonDB } from './common.db'
-import { CommonDBAdapter } from './db.model'
-
-/**
- * Returns pre-configured DB
- *
- * @param index defaults to 1
- *
- * Requires process.env.DB${index} to be set to the name of the adapter, e.g `mysql-lib` or `db-lib/adapter/inmemory`.
- * Requires (by most adapters) process.env.SECRET_DB${index} to contain a "connection string" to that DB. Usually a JSON.stringified object,
- * but depends on the adapter.
- */
-export function getDB(index = 1): CommonDB {
-  return _getDB(index)
-}
-
-// Extra function to provide index=1 as default (since memo doesn't work well with default arguments)
-const _getDB = _memoFn((index: number) => {
-  const libName = process.env[`DB${index}`]
-
-  if (!libName) {
-    throw new Error(
-      `getDB(${yellow(index)}), but process.env.${white('DB' + index)} is not defined!`,
-    )
-  }
-
-  const lib: CommonDBAdapter = require(libName)
-
-  if (!lib.getDBAdapter) {
-    throw new Error(
-      `DB${index}=${libName}, but require('${libName}').getDBAdapter() is not defined`,
-    )
-  }
-
-  const cfg = secretOptional(`SECRET_DB${index}`)
-
-  return lib.getDBAdapter(cfg)
-})
-
-declare global {
-  namespace NodeJS {
-    interface ProcessEnv {
-      DB1?: string
-      DB2?: string
-    }
-  }
-}