@naturalcycles/db-lib 8.16.1 → 8.19.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [8.19.0](https://github.com/NaturalCycles/db-lib/compare/v8.18.0...v8.19.0) (2021-10-17)
+
+
+### Features
+
+* better-typed Queries, excludeFromIndexes ([b7a37ba](https://github.com/NaturalCycles/db-lib/commit/b7a37ba0ed28d5047f4cea5a5f5900f7d1fe5da4))
+
+# [8.18.0](https://github.com/NaturalCycles/db-lib/compare/v8.17.0...v8.18.0) (2021-10-15)
+
+
+### Features
+
+* stop exporting Saved, Unsaved, {base,saved}DBEntitySchema ([0894b20](https://github.com/NaturalCycles/db-lib/commit/0894b20b221136150feab4ee30e1208e0cc238f4))
+
+# [8.17.0](https://github.com/NaturalCycles/db-lib/compare/v8.16.2...v8.17.0) (2021-10-15)
+
+
+### Features
+
+* use BaseDBEntity, SavedDBEntity from js-lib ([93210d1](https://github.com/NaturalCycles/db-lib/commit/93210d15ad154b64e9232571f3cc0fe23565ced6))
+
+## [8.16.2](https://github.com/NaturalCycles/db-lib/compare/v8.16.1...v8.16.2) (2021-10-04)
+
+
+### Bug Fixes
+
+* unnecessary await ([11282ba](https://github.com/NaturalCycles/db-lib/commit/11282ba44982c174b1b9eeb052c911c30ee22076))
+
 ## [8.16.1](https://github.com/NaturalCycles/db-lib/compare/v8.16.0...v8.16.1) (2021-10-04)
 
 

package/dist/adapter/cachedb/cache.db.d.ts

@@ -23,12 +23,12 @@ export declare class CacheDB extends BaseCommonDB implements CommonDB {
      */
     getTables(): Promise<string[]>;
     getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
-    createTable(table: string, schema: JsonSchemaObject, opt?: CacheDBCreateOptions): Promise<void>;
-    getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: CacheDBOptions): Promise<ROW[]>;
-    deleteByIds(table: string, ids: string[], opt?: CacheDBOptions): Promise<number>;
-    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: CacheDBOptions): Promise<void>;
-    runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBOptions): Promise<RunQueryResult<ROW>>;
-    runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBOptions): Promise<number>;
-    streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBStreamOptions): Readable;
-    deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBOptions): Promise<number>;
+    createTable<ROW extends ObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CacheDBCreateOptions<ROW>): Promise<void>;
+    getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: CacheDBOptions<ROW>): Promise<ROW[]>;
+    deleteByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: CacheDBOptions<ROW>): Promise<number>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: CacheDBOptions<ROW>): Promise<void>;
+    runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBOptions<ROW>): Promise<RunQueryResult<ROW>>;
+    runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBOptions<ROW>): Promise<number>;
+    streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBStreamOptions<ROW>): Readable;
+    deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBOptions<ROW>): Promise<number>;
 }

package/dist/adapter/cachedb/cache.db.model.d.ts

@@ -1,5 +1,5 @@
 import { CommonDB } from '../../common.db';
-import { CommonDBCreateOptions, CommonDBSaveOptions, CommonDBStreamOptions } from '../../db.model';
+import { CommonDBCreateOptions, CommonDBSaveOptions, CommonDBStreamOptions, ObjectWithId } from '../../db.model';
 export interface CacheDBCfg {
     name: string;
     cacheDB: CommonDB;
@@ -32,7 +32,7 @@ export interface CacheDBCfg {
      */
     logDownstream?: boolean;
 }
-export interface CacheDBOptions extends CommonDBSaveOptions {
+export interface CacheDBOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {
     /**
      * @default false
      */
@@ -42,7 +42,7 @@ export interface CacheDBOptions extends CommonDBSaveOptions {
      */
     onlyCache?: boolean;
 }
-export interface CacheDBStreamOptions extends CacheDBOptions, CommonDBStreamOptions {
+export interface CacheDBStreamOptions<ROW extends ObjectWithId> extends CacheDBOptions<ROW>, CommonDBStreamOptions {
 }
-export interface CacheDBCreateOptions extends CacheDBOptions, CommonDBCreateOptions {
+export interface CacheDBCreateOptions<ROW extends ObjectWithId> extends CacheDBOptions<ROW>, CommonDBCreateOptions {
 }

package/dist/adapter/file/file.db.d.ts

@@ -22,11 +22,11 @@ export declare class FileDB extends BaseCommonDB implements CommonDB {
     ping(): Promise<void>;
     getTables(): Promise<string[]>;
     getByIds<ROW extends ObjectWithId>(table: string, ids: string[], _opt?: CommonDBOptions): Promise<ROW[]>;
-    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], _opt?: CommonDBSaveOptions): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], _opt?: CommonDBSaveOptions<ROW>): Promise<void>;
     /**
      * Implementation is optimized for loading/saving _whole files_.
      */
-    commitTransaction(tx: DBTransaction, _opt?: CommonDBSaveOptions): Promise<void>;
+    commitTransaction(tx: DBTransaction, _opt?: CommonDBOptions): Promise<void>;
     runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<RunQueryResult<ROW>>;
     runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
     streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CommonDBStreamOptions): ReadableTyped<ROW>;
@@ -35,7 +35,7 @@ export declare class FileDB extends BaseCommonDB implements CommonDB {
     getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
     loadFile<ROW extends ObjectWithId>(table: string): Promise<ROW[]>;
     saveFile<ROW extends ObjectWithId>(table: string, _rows: ROW[]): Promise<void>;
-    saveFiles(ops: DBSaveBatchOperation[]): Promise<void>;
+    saveFiles<ROW extends ObjectWithId>(ops: DBSaveBatchOperation<ROW>[]): Promise<void>;
     /**
      * Mutates
      */

package/dist/adapter/inmemory/inMemory.db.d.ts

@@ -47,15 +47,15 @@ export declare class InMemoryDB implements CommonDB {
     resetCache(_table?: string): Promise<void>;
     getTables(): Promise<string[]>;
     getTableSchema<ROW extends ObjectWithId>(_table: string): Promise<JsonSchemaRootObject<ROW>>;
-    createTable(_table: string, _schema: JsonSchemaObject, opt?: CommonDBCreateOptions): Promise<void>;
+    createTable<ROW extends ObjectWithId>(_table: string, _schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
     getByIds<ROW extends ObjectWithId>(_table: string, ids: string[], _opt?: CommonDBOptions): Promise<ROW[]>;
-    saveBatch<ROW extends ObjectWithId>(_table: string, rows: ROW[], _opt?: CommonDBSaveOptions): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(_table: string, rows: ROW[], _opt?: CommonDBSaveOptions<ROW>): Promise<void>;
     deleteByIds(_table: string, ids: string[], _opt?: CommonDBOptions): Promise<number>;
     deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
     runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<RunQueryResult<ROW>>;
     runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
     streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): ReadableTyped<ROW>;
-    commitTransaction(tx: DBTransaction, opt?: CommonDBSaveOptions): Promise<void>;
+    commitTransaction(tx: DBTransaction, opt?: CommonDBOptions): Promise<void>;
     /**
      * Flushes all tables (all namespaces) at once.
      */

package/dist/base.common.db.d.ts

@@ -1,7 +1,7 @@
 import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonDB } from './common.db';
-import { CommonDBSaveOptions, ObjectWithId, RunQueryResult } from './db.model';
+import { CommonDBOptions, ObjectWithId, RunQueryResult } from './db.model';
 import { DBQuery } from './query/dbQuery';
 import { DBTransaction } from './transaction/dbTransaction';
 /**
@@ -12,7 +12,7 @@ export declare class BaseCommonDB implements CommonDB {
     ping(): Promise<void>;
     getTables(): Promise<string[]>;
     getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
-    createTable(_table: string, _schema: JsonSchemaObject): Promise<void>;
+    createTable<ROW extends ObjectWithId>(_table: string, _schema: JsonSchemaObject<ROW>): Promise<void>;
     deleteByIds(_table: string, _ids: string[]): Promise<number>;
     deleteByQuery<ROW extends ObjectWithId>(_q: DBQuery<ROW>): Promise<number>;
     getByIds<ROW extends ObjectWithId>(_table: string, _ids: string[]): Promise<ROW[]>;
@@ -24,5 +24,5 @@ export declare class BaseCommonDB implements CommonDB {
      * Naive implementation.
      * To be extended.
      */
-    commitTransaction(tx: DBTransaction, opt?: CommonDBSaveOptions): Promise<void>;
+    commitTransaction(tx: DBTransaction, opt?: CommonDBOptions): Promise<void>;
 }

package/dist/common.db.d.ts

@@ -26,7 +26,7 @@ export interface CommonDB {
      * Will do like `create table ...` for mysql.
      * Caution! dropIfExists defaults to false. If set to true - will actually DROP the table!
      */
-    createTable(table: string, schema: JsonSchemaObject, opt?: CommonDBCreateOptions): Promise<void>;
+    createTable<ROW extends ObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
     /**
      * Order of items returned is not guaranteed to match order of ids.
      * (Such limitation exists because Datastore doesn't support it).
@@ -38,7 +38,7 @@ export interface CommonDB {
     runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CommonDBOptions): Promise<RunQueryResult<ROW>>;
     runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CommonDBOptions): Promise<number>;
     streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CommonDBStreamOptions): ReadableTyped<ROW>;
-    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: CommonDBSaveOptions): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
     /**
      * @returns number of deleted items.
      * Not supported by all implementations (e.g Datastore will always return same number as number of ids).
@@ -49,5 +49,5 @@ export interface CommonDB {
      * Should be implemented as a Transaction (best effort), which means that
      * either ALL or NONE of the operations should be applied.
      */
-    commitTransaction(tx: DBTransaction, opt?: CommonDBSaveOptions): Promise<void>;
+    commitTransaction(tx: DBTransaction, opt?: CommonDBOptions): Promise<void>;
 }

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

@@ -1,6 +1,6 @@
-import { AsyncMapper, JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
+import { AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, Saved } from '@naturalcycles/js-lib';
 import { AjvSchema, ObjectSchemaTyped, ReadableTyped } from '@naturalcycles/nodejs-lib';
-import { DBModelType, ObjectWithId, RunQueryResult, Saved } from '../db.model';
+import { DBModelType, ObjectWithId, RunQueryResult } from '../db.model';
 import { DBQuery, RunnableDBQuery } from '../query/dbQuery';
 import { CommonDaoCfg, CommonDaoCreateOptions, CommonDaoOptions, CommonDaoSaveOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions } from './common.dao.model';
 /**
@@ -32,8 +32,8 @@ export declare class CommonDao<BM extends Partial<ObjectWithId>, DBM extends Obj
      * Throws if readOnly is true
      */
     private requireWriteAccess;
-    getBy(by: string, value: any, limit?: number, opt?: CommonDaoOptions): Promise<Saved<BM>[]>;
-    getOneBy(by: string, value: any, opt?: CommonDaoOptions): Promise<Saved<BM> | null>;
+    getBy(by: keyof DBM, value: any, limit?: number, opt?: CommonDaoOptions): Promise<Saved<BM>[]>;
+    getOneBy(by: keyof DBM, value: any, opt?: CommonDaoOptions): Promise<Saved<BM> | null>;
     getAll(opt?: CommonDaoOptions): Promise<Saved<BM>[]>;
     /**
      * Pass `table` to override table
@@ -74,7 +74,7 @@ export declare class CommonDao<BM extends Partial<ObjectWithId>, DBM extends Obj
     /**
      * Mutates with id, created, updated
      */
-    save(bm: BM, opt?: CommonDaoSaveOptions): Promise<Saved<BM>>;
+    save(bm: BM, opt?: CommonDaoSaveOptions<DBM>): Promise<Saved<BM>>;
     /**
      * Mutates id if needed
      */
@@ -87,11 +87,11 @@ export declare class CommonDao<BM extends Partial<ObjectWithId>, DBM extends Obj
      *
      * Convenience method to replace 3 operations (loading+patching+saving) with one.
      */
-    patch(id: string, patch: Partial<BM>, opt?: CommonDaoSaveOptions): Promise<Saved<BM>>;
-    patchAsDBM(id: string, patch: Partial<DBM>, opt?: CommonDaoSaveOptions): Promise<DBM>;
-    saveAsDBM(dbm: DBM, opt?: CommonDaoSaveOptions): Promise<DBM>;
-    saveBatch(bms: BM[], opt?: CommonDaoSaveOptions): Promise<Saved<BM>[]>;
-    saveBatchAsDBM(dbms: DBM[], opt?: CommonDaoSaveOptions): Promise<DBM[]>;
+    patch(id: string, patch: Partial<BM>, opt?: CommonDaoSaveOptions<DBM>): Promise<Saved<BM>>;
+    patchAsDBM(id: string, patch: Partial<DBM>, opt?: CommonDaoSaveOptions<DBM>): Promise<DBM>;
+    saveAsDBM(dbm: DBM, opt?: CommonDaoSaveOptions<DBM>): Promise<DBM>;
+    saveBatch(bms: BM[], opt?: CommonDaoSaveOptions<DBM>): Promise<Saved<BM>[]>;
+    saveBatchAsDBM(dbms: DBM[], opt?: CommonDaoSaveOptions<DBM>): Promise<DBM[]>;
     /**
      * @returns number of deleted items
      */

package/dist/commondao/common.dao.js

@@ -155,10 +155,10 @@ class CommonDao {
         }
     }
     async getBy(by, value, limit = 0, opt) {
-        return await this.query().filter(by, '==', value).limit(limit).runQuery(opt);
+        return await this.query().filterEq(by, value).limit(limit).runQuery(opt);
     }
     async getOneBy(by, value, opt) {
-        const [bm] = await this.query().filter(by, '==', value).limit(1).runQuery(opt);
+        const [bm] = await this.query().filterEq(by, value).limit(1).runQuery(opt);
         return bm || null;
     }
     async getAll(opt) {
@@ -548,7 +548,8 @@ class CommonDao {
         // DBM > BM
         const bm = await this.cfg.hooks.beforeDBMToBM(dbm);
         // Validate/convert BM
-        return await this.validateAndConvert(bm, this.cfg.bmSchema, db_model_1.DBModelType.BM, opt);
+        // eslint-disable-next-line @typescript-eslint/return-await
+        return this.validateAndConvert(bm, this.cfg.bmSchema, db_model_1.DBModelType.BM, opt);
     }
     async dbmsToBM(dbms, opt = {}) {
         return await (0, js_lib_1.pMap)(dbms, async (dbm) => await this.dbmToBM(dbm, opt));
@@ -565,7 +566,8 @@ class CommonDao {
         // BM > DBM
         const dbm = { ...(await this.cfg.hooks.beforeBMToDBM(bm)) };
         // Validate/convert DBM
-        return await this.validateAndConvert(dbm, this.cfg.dbmSchema, db_model_1.DBModelType.DBM, opt);
+        // eslint-disable-next-line @typescript-eslint/return-await
+        return this.validateAndConvert(dbm, this.cfg.dbmSchema, db_model_1.DBModelType.DBM, opt);
     }
     async bmsToDBM(bms, opt = {}) {
         // try/catch?

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

@@ -47,7 +47,7 @@ export interface CommonDaoCfg<BM extends Partial<ObjectWithId>, DBM extends Obje
     dbmSchema?: ObjectSchemaTyped<DBM> | AjvSchema<DBM>;
     bmSchema?: ObjectSchemaTyped<BM> | AjvSchema<BM>;
     tmSchema?: ObjectSchemaTyped<TM> | AjvSchema<TM>;
-    excludeFromIndexes?: string[];
+    excludeFromIndexes?: (keyof DBM)[];
     /**
      * @default to false
      * Set to true to limit DB writing (will throw an error is such case).
@@ -116,7 +116,7 @@ export interface CommonDaoOptions extends CommonDBOptions {
 /**
  * All properties default to undefined.
  */
-export interface CommonDaoSaveOptions extends CommonDaoOptions, CommonDBSaveOptions {
+export interface CommonDaoSaveOptions<DBM extends ObjectWithId> extends CommonDaoOptions, CommonDBSaveOptions<DBM> {
     /**
      * @default false
      *

package/dist/db.model.d.ts

@@ -1,12 +1,12 @@
-import type { Merge } from '@naturalcycles/js-lib';
+import { AnyObject } from '@naturalcycles/js-lib';
 import { CommonDB } from './common.db';
 export interface CommonDBOptions {
 }
 /**
  * All properties default to undefined.
  */
-export interface CommonDBSaveOptions extends CommonDBOptions {
-    excludeFromIndexes?: string[];
+export interface CommonDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId> extends CommonDBOptions {
+    excludeFromIndexes?: (keyof ROW)[];
 }
 export declare type CommonDBStreamOptions = CommonDBOptions;
 export interface CommonDBCreateOptions extends CommonDBOptions {
@@ -21,7 +21,7 @@ export interface RunQueryResult<T> {
     endCursor?: string;
 }
 export declare type DBOperation = DBSaveBatchOperation | DBDeleteByIdsOperation;
-export interface DBSaveBatchOperation<ROW extends ObjectWithId = any> {
+export interface DBSaveBatchOperation<ROW extends ObjectWithId = AnyObjectWithId> {
     type: 'saveBatch';
     table: string;
     rows: ROW[];
@@ -47,28 +47,11 @@ export interface CreatedUpdated {
 export interface CreatedUpdatedId extends CreatedUpdated {
     id: string;
 }
-export interface CreatedUpdatedVer {
-    created: number;
-    updated: number;
-    _ver?: number;
-}
 export interface ObjectWithId {
     id: string;
 }
-export interface BaseDBEntity {
-    id?: string;
-    created?: number;
-    updated?: number;
-}
-export interface SavedDBEntity {
-    id: string;
-    created: number;
-    updated: number;
+export interface AnyObjectWithId extends AnyObject, ObjectWithId {
 }
-export declare type Saved<E> = Merge<E, SavedDBEntity>;
-export declare type Unsaved<E> = Merge<E, BaseDBEntity>;
-export declare const baseDBEntitySchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<BaseDBEntity, BaseDBEntity>;
-export declare const savedDBEntitySchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<SavedDBEntity, SavedDBEntity>;
 /**
  * Interface for a module (lib) that implements CommonDB.
  *

package/dist/db.model.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.savedDBEntitySchema = exports.baseDBEntitySchema = exports.DBModelType = exports.DBRelation = void 0;
-const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
+exports.DBModelType = exports.DBRelation = void 0;
 var DBRelation;
 (function (DBRelation) {
     DBRelation["ONE_TO_ONE"] = "ONE_TO_ONE";
@@ -13,15 +12,3 @@ var DBModelType;
     DBModelType["BM"] = "BM";
     DBModelType["TM"] = "TM";
 })(DBModelType = exports.DBModelType || (exports.DBModelType = {}));
-exports.baseDBEntitySchema = (0, nodejs_lib_1.objectSchema)({
-    id: nodejs_lib_1.stringSchema.optional(),
-    created: nodejs_lib_1.unixTimestampSchema.optional(),
-    updated: nodejs_lib_1.unixTimestampSchema.optional(),
-    // _ver: verSchema.optional(),
-});
-exports.savedDBEntitySchema = (0, nodejs_lib_1.objectSchema)({
-    id: nodejs_lib_1.stringSchema,
-    created: nodejs_lib_1.unixTimestampSchema,
-    updated: nodejs_lib_1.unixTimestampSchema,
-    // _ver: verSchema.optional(),
-});

package/dist/index.d.ts

@@ -6,7 +6,7 @@ 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 } from './commondao/common.dao.model';
-import { BaseDBEntity, baseDBEntitySchema, CommonDBAdapter, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CreatedUpdated, CreatedUpdatedId, CreatedUpdatedVer, DBDeleteByIdsOperation, DBModelType, DBOperation, DBRelation, DBSaveBatchOperation, ObjectWithId, RunQueryResult, Saved, SavedDBEntity, savedDBEntitySchema, Unsaved } from './db.model';
+import { AnyObjectWithId, CommonDBAdapter, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CreatedUpdated, CreatedUpdatedId, DBDeleteByIdsOperation, DBModelType, DBOperation, DBRelation, DBSaveBatchOperation, ObjectWithId, RunQueryResult } from './db.model';
 import { getDB } from './getDB';
 import { CommonKeyValueDao, CommonKeyValueDaoCfg } from './kv/commonKeyValueDao';
 import { CommonKeyValueDB, KeyValueDBTuple } from './kv/commonKeyValueDB';
@@ -17,5 +17,5 @@ import { dbPipelineRestore, DBPipelineRestoreOptions } from './pipeline/dbPipeli
 import { DBQuery, DBQueryFilter, DBQueryFilterOperator, dbQueryFilterOperatorValues, DBQueryOrder, RunnableDBQuery } from './query/dbQuery';
 import { DBTransaction, RunnableDBTransaction } from './transaction/dbTransaction';
 import { commitDBTransactionSimple, mergeDBOperations } from './transaction/dbTransaction.util';
-export type { DBQueryFilterOperator, DBQueryFilter, DBQueryOrder, CommonDaoCreateOptions, CommonDaoOptions, CommonDaoSaveOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CommonDBCreateOptions, CommonDB, RunQueryResult, CreatedUpdated, CreatedUpdatedId, CreatedUpdatedVer, ObjectWithId, BaseDBEntity, SavedDBEntity, Saved, Unsaved, CommonDaoCfg, CommonDaoCreateIdHook, CommonDaoParseNaturalIdHook, CommonDaoBeforeCreateHook, CommonDaoBeforeDBMValidateHook, CommonDaoBeforeDBMToBMHook, CommonDaoBeforeBMToDBMHook, CommonDaoBeforeTMToBMHook, CommonDaoBeforeBMToTMHook, CommonDaoAnonymizeHook, InMemoryDBCfg, InMemoryKeyValueDBCfg, DBPipelineBackupOptions, DBPipelineRestoreOptions, DBPipelineCopyOptions, CommonDBAdapter, DBOperation, DBSaveBatchOperation, DBDeleteByIdsOperation, CommonKeyValueDB, CommonKeyValueDaoCfg, KeyValueDBTuple, };
-export { DBQuery, dbQueryFilterOperatorValues, RunnableDBQuery, CommonDaoLogLevel, DBRelation, DBModelType, baseDBEntitySchema, savedDBEntitySchema, CommonDao, createdUpdatedFields, createdUpdatedIdFields, idField, InMemoryDB, InMemoryKeyValueDB, queryInMemory, serializeJsonField, deserializeJsonField, dbPipelineBackup, dbPipelineRestore, dbPipelineCopy, getDB, DBLibError, BaseCommonDB, DBTransaction, RunnableDBTransaction, mergeDBOperations, commitDBTransactionSimple, CommonKeyValueDao, };
+export type { DBQueryFilterOperator, DBQueryFilter, DBQueryOrder, CommonDaoCreateOptions, CommonDaoOptions, CommonDaoSaveOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBStreamOptions, CommonDBCreateOptions, CommonDB, RunQueryResult, CreatedUpdated, CreatedUpdatedId, AnyObjectWithId, ObjectWithId, CommonDaoCfg, CommonDaoCreateIdHook, CommonDaoParseNaturalIdHook, CommonDaoBeforeCreateHook, CommonDaoBeforeDBMValidateHook, CommonDaoBeforeDBMToBMHook, CommonDaoBeforeBMToDBMHook, CommonDaoBeforeTMToBMHook, CommonDaoBeforeBMToTMHook, CommonDaoAnonymizeHook, InMemoryDBCfg, InMemoryKeyValueDBCfg, DBPipelineBackupOptions, DBPipelineRestoreOptions, DBPipelineCopyOptions, CommonDBAdapter, DBOperation, DBSaveBatchOperation, DBDeleteByIdsOperation, CommonKeyValueDB, CommonKeyValueDaoCfg, KeyValueDBTuple, };
+export { DBQuery, dbQueryFilterOperatorValues, RunnableDBQuery, CommonDaoLogLevel, DBRelation, DBModelType, CommonDao, createdUpdatedFields, createdUpdatedIdFields, idField, InMemoryDB, InMemoryKeyValueDB, queryInMemory, serializeJsonField, deserializeJsonField, dbPipelineBackup, dbPipelineRestore, dbPipelineCopy, getDB, DBLibError, BaseCommonDB, DBTransaction, RunnableDBTransaction, mergeDBOperations, commitDBTransactionSimple, CommonKeyValueDao, };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommonKeyValueDao = exports.commitDBTransactionSimple = exports.mergeDBOperations = exports.RunnableDBTransaction = exports.DBTransaction = exports.BaseCommonDB = exports.DBLibError = exports.getDB = exports.dbPipelineCopy = exports.dbPipelineRestore = exports.dbPipelineBackup = exports.deserializeJsonField = exports.serializeJsonField = exports.queryInMemory = exports.InMemoryKeyValueDB = exports.InMemoryDB = exports.idField = exports.createdUpdatedIdFields = exports.createdUpdatedFields = exports.CommonDao = exports.savedDBEntitySchema = exports.baseDBEntitySchema = exports.DBModelType = exports.DBRelation = exports.CommonDaoLogLevel = exports.RunnableDBQuery = exports.dbQueryFilterOperatorValues = exports.DBQuery = void 0;
+exports.CommonKeyValueDao = exports.commitDBTransactionSimple = exports.mergeDBOperations = exports.RunnableDBTransaction = exports.DBTransaction = exports.BaseCommonDB = exports.DBLibError = exports.getDB = exports.dbPipelineCopy = exports.dbPipelineRestore = exports.dbPipelineBackup = exports.deserializeJsonField = exports.serializeJsonField = exports.queryInMemory = exports.InMemoryKeyValueDB = exports.InMemoryDB = exports.idField = exports.createdUpdatedIdFields = exports.createdUpdatedFields = exports.CommonDao = exports.DBModelType = exports.DBRelation = exports.CommonDaoLogLevel = exports.RunnableDBQuery = exports.dbQueryFilterOperatorValues = exports.DBQuery = void 0;
 const inMemory_db_1 = require("./adapter/inmemory/inMemory.db");
 Object.defineProperty(exports, "InMemoryDB", { enumerable: true, get: function () { return inMemory_db_1.InMemoryDB; } });
 const inMemoryKeyValueDB_1 = require("./adapter/inmemory/inMemoryKeyValueDB");
@@ -16,10 +16,8 @@ Object.defineProperty(exports, "CommonDao", { enumerable: true, get: function ()
 const common_dao_model_1 = require("./commondao/common.dao.model");
 Object.defineProperty(exports, "CommonDaoLogLevel", { enumerable: true, get: function () { return common_dao_model_1.CommonDaoLogLevel; } });
 const db_model_1 = require("./db.model");
-Object.defineProperty(exports, "baseDBEntitySchema", { enumerable: true, get: function () { return db_model_1.baseDBEntitySchema; } });
 Object.defineProperty(exports, "DBModelType", { enumerable: true, get: function () { return db_model_1.DBModelType; } });
 Object.defineProperty(exports, "DBRelation", { enumerable: true, get: function () { return db_model_1.DBRelation; } });
-Object.defineProperty(exports, "savedDBEntitySchema", { enumerable: true, get: function () { return db_model_1.savedDBEntitySchema; } });
 const getDB_1 = require("./getDB");
 Object.defineProperty(exports, "getDB", { enumerable: true, get: function () { return getDB_1.getDB; } });
 const commonKeyValueDao_1 = require("./kv/commonKeyValueDao");

package/dist/query/dbQuery.d.ts

@@ -1,8 +1,8 @@
-import { AsyncMapper } from '@naturalcycles/js-lib';
+import { AsyncMapper, Saved } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonDaoOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions } from '..';
 import { CommonDao } from '../commondao/common.dao';
-import { ObjectWithId, RunQueryResult, Saved } from '../db.model';
+import { AnyObjectWithId, ObjectWithId, RunQueryResult } from '../db.model';
 /**
  * Modeled after Firestore operators (WhereFilterOp type)
  *
@@ -24,13 +24,13 @@ import { ObjectWithId, RunQueryResult, Saved } from '../db.model';
  */
 export declare type DBQueryFilterOperator = '<' | '<=' | '==' | '>=' | '>' | 'in' | 'not-in' | 'array-contains' | 'array-contains-any';
 export declare const dbQueryFilterOperatorValues: string[];
-export interface DBQueryFilter {
-    name: string;
+export interface DBQueryFilter<ROW extends ObjectWithId = AnyObjectWithId> {
+    name: keyof ROW;
     op: DBQueryFilterOperator;
     val: any;
 }
-export interface DBQueryOrder {
-    name: string;
+export interface DBQueryOrder<ROW extends ObjectWithId = AnyObjectWithId> {
+    name: keyof ROW;
     descending?: boolean;
 }
 /**
@@ -43,33 +43,33 @@ export interface DBQueryOrder {
  *
  * <DBM> is the type of **queried** object (so e.g `key of DBM` can be used), not **returned** object.
  */
-export declare class DBQuery<ROW extends ObjectWithId> {
+export declare class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
     table: string;
     constructor(table: string);
     /**
      * Convenience method.
      */
-    static create<ROW extends ObjectWithId = any>(table: string): DBQuery<ROW>;
-    static fromPlainObject<ROW extends ObjectWithId = any>(obj: Partial<DBQuery<ROW>> & {
+    static create<ROW extends ObjectWithId = AnyObjectWithId>(table: string): DBQuery<ROW>;
+    static fromPlainObject<ROW extends ObjectWithId = AnyObjectWithId>(obj: Partial<DBQuery<ROW>> & {
         table: string;
     }): DBQuery<ROW>;
-    _filters: DBQueryFilter[];
+    _filters: DBQueryFilter<ROW>[];
     _limitValue: number;
     _offsetValue: number;
-    _orders: DBQueryOrder[];
+    _orders: DBQueryOrder<ROW>[];
     _startCursor?: string;
     _endCursor?: string;
     /**
      * If defined - only those fields will be selected.
      * In undefined - all fields (*) will be returned.
      */
-    _selectedFieldNames?: string[];
-    filter(name: string, op: DBQueryFilterOperator, val: any): this;
-    filterEq(name: string, val: any): this;
+    _selectedFieldNames?: (keyof ROW)[];
+    filter(name: keyof ROW, op: DBQueryFilterOperator, val: any): this;
+    filterEq(name: keyof ROW, val: any): this;
     limit(limit: number): this;
     offset(offset: number): this;
-    order(name: string, descending?: boolean): this;
-    select(fieldNames: string[]): this;
+    order(name: keyof ROW, descending?: boolean): this;
+    select(fieldNames: (keyof ROW)[]): this;
     startCursor(startCursor?: string): this;
     endCursor(endCursor?: string): this;
     clone(): DBQuery<ROW>;

package/dist/query/dbQuery.js

@@ -13,17 +13,6 @@ exports.dbQueryFilterOperatorValues = [
     'array-contains',
     'array-contains-any',
 ];
-// export interface DBQueryData {
-//   _filters: DBQueryFilter[]
-//   _limitValue: number
-//   _orders: DBQueryOrder[]
-//
-//   /**
-//    * If defined - only those fields will be selected.
-//    * In undefined - all fields (*) will be returned.
-//    */
-//   _selectedFieldNames?: string[]
-// }
 /**
  * Lowest Common Denominator Query object.
  * To be executed by CommonDao / CommonDB.

package/dist/testing/test.model.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
-import { JsonSchemaObject } from '@naturalcycles/js-lib';
-import { BaseDBEntity, Saved } from '../db.model';
+import { JsonSchemaObject, BaseDBEntity, Saved } from '@naturalcycles/js-lib';
 export declare const TEST_TABLE = "TEST_TABLE";
 export interface TestItemBM extends BaseDBEntity {
     k1: string;

package/dist/testing/test.model.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTestItemSchema = exports.createTestItemsBM = exports.createTestItemsDBM = exports.createTestItemBM = exports.createTestItemDBM = exports.testItemDBMJsonSchema = exports.testItemBMJsonSchema = exports.testItemTMSchema = exports.testItemDBMSchema = exports.testItemBMSchema = exports.TEST_TABLE = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const db_model_1 = require("../db.model");
 const MOCK_TS_2018_06_21 = 1529539200;
 exports.TEST_TABLE = 'TEST_TABLE';
 exports.testItemBMSchema = (0, nodejs_lib_1.objectSchema)({
@@ -12,14 +11,14 @@ exports.testItemBMSchema = (0, nodejs_lib_1.objectSchema)({
     k3: nodejs_lib_1.numberSchema.optional(),
     even: nodejs_lib_1.booleanSchema.optional(),
     b1: nodejs_lib_1.binarySchema.optional(),
-}).concat(db_model_1.baseDBEntitySchema);
+}).concat(nodejs_lib_1.baseDBEntitySchema);
 exports.testItemDBMSchema = (0, nodejs_lib_1.objectSchema)({
     k1: nodejs_lib_1.stringSchema,
     k2: nodejs_lib_1.stringSchema.optional(),
     k3: nodejs_lib_1.numberSchema.optional(),
     even: nodejs_lib_1.booleanSchema.optional(),
     b1: nodejs_lib_1.binarySchema.optional(),
-}).concat(db_model_1.savedDBEntitySchema);
+}).concat(nodejs_lib_1.savedDBEntitySchema);
 exports.testItemTMSchema = (0, nodejs_lib_1.objectSchema)({
     k1: nodejs_lib_1.stringSchema,
     even: nodejs_lib_1.booleanSchema.optional(),

package/dist/timeseries/commonTimeSeriesDao.js

@@ -66,7 +66,7 @@ class CommonTimeSeriesDao {
             dbq.filter('ts', '>=', q.fromIncl);
         if (q.toExcl)
             dbq.filter('ts', '<', q.toExcl);
-        const { rows } = await this.cfg.db.runQuery(dbq);
+        const rows = (await this.cfg.db.runQuery(dbq)).rows;
         // todo: query from aggregated tables when step is above 'hour'
         return rows
             .filter(r => r.v !== null && r.v !== undefined) // can be 0

package/dist/transaction/dbTransaction.d.ts

@@ -1,11 +1,11 @@
 import type { CommonDB } from '../common.db';
-import type { CommonDBSaveOptions, DBOperation, ObjectWithId } from '../db.model';
+import type { AnyObjectWithId, CommonDBSaveOptions, DBOperation, ObjectWithId } from '../db.model';
 /**
  * Convenience class that stores the list of DBOperations and provides a fluent API to add them.
  */
 export declare class DBTransaction {
     ops: DBOperation[];
-    saveBatch<ROW extends ObjectWithId = any>(table: string, rows: ROW[]): this;
+    saveBatch<ROW extends ObjectWithId = AnyObjectWithId>(table: string, rows: ROW[]): this;
     deleteByIds(table: string, ids: string[]): this;
 }
 /**
@@ -15,5 +15,5 @@ export declare class DBTransaction {
 export declare class RunnableDBTransaction extends DBTransaction {
     db: CommonDB;
     constructor(db: CommonDB);
-    commit(opt?: CommonDBSaveOptions): Promise<void>;
+    commit<ROW extends ObjectWithId>(opt?: CommonDBSaveOptions<ROW>): Promise<void>;
 }

package/dist/validation/index.d.ts

@@ -1,8 +1,8 @@
 import { CommonDBOptions, CommonDBSaveOptions } from '../db.model';
 import { DBQuery, DBQueryFilter, DBQueryOrder } from '../query/dbQuery';
 export declare const commonDBOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBOptions, CommonDBOptions>;
-export declare const commonDBSaveOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBSaveOptions, CommonDBSaveOptions>;
+export declare const commonDBSaveOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBSaveOptions<import("../db.model").AnyObjectWithId>, CommonDBSaveOptions<import("../db.model").AnyObjectWithId>>;
 export declare const dbQueryFilterOperatorSchema: import("@naturalcycles/nodejs-lib/dist/validation/joi/string.extensions").ExtendedStringSchema;
-export declare const dbQueryFilterSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryFilter, DBQueryFilter>;
-export declare const dbQueryOrderSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryOrder, DBQueryOrder>;
+export declare const dbQueryFilterSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryFilter<import("../db.model").AnyObjectWithId>, DBQueryFilter<import("../db.model").AnyObjectWithId>>;
+export declare const dbQueryOrderSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryOrder<import("../db.model").AnyObjectWithId>, DBQueryOrder<import("../db.model").AnyObjectWithId>>;
 export declare const dbQuerySchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQuery<any>, DBQuery<any>>;

package/package.json

@@ -42,7 +42,7 @@
   "engines": {
     "node": ">=12.13"
   },
-  "version": "8.16.1",
+  "version": "8.19.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/adapter/cachedb/cache.db.model.ts

@@ -1,5 +1,10 @@
 import { CommonDB } from '../../common.db'
-import { CommonDBCreateOptions, CommonDBSaveOptions, CommonDBStreamOptions } from '../../db.model'
+import {
+  CommonDBCreateOptions,
+  CommonDBSaveOptions,
+  CommonDBStreamOptions,
+  ObjectWithId,
+} from '../../db.model'
 
 export interface CacheDBCfg {
   name: string
@@ -39,7 +44,7 @@ export interface CacheDBCfg {
   logDownstream?: boolean
 }
 
-export interface CacheDBOptions extends CommonDBSaveOptions {
+export interface CacheDBOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {
   /**
    * @default false
    */
@@ -51,5 +56,9 @@ export interface CacheDBOptions extends CommonDBSaveOptions {
   onlyCache?: boolean
 }
 
-export interface CacheDBStreamOptions extends CacheDBOptions, CommonDBStreamOptions {}
-export interface CacheDBCreateOptions extends CacheDBOptions, CommonDBCreateOptions {}
+export interface CacheDBStreamOptions<ROW extends ObjectWithId>
+  extends CacheDBOptions<ROW>,
+    CommonDBStreamOptions {}
+export interface CacheDBCreateOptions<ROW extends ObjectWithId>
+  extends CacheDBOptions<ROW>,
+    CommonDBCreateOptions {}