@naturalcycles/db-lib 8.42.1 → 8.43.0

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

@@ -25,7 +25,7 @@ export declare class CacheDB extends BaseCommonDB implements CommonDB {
     createTable<ROW extends ObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CacheDBCreateOptions): Promise<void>;
     getByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], opt?: CacheDBSaveOptions<ROW>): Promise<ROW[]>;
     deleteByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], opt?: CacheDBOptions): Promise<number>;
-    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], opt?: CacheDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: CacheDBSaveOptions<ROW>): Promise<void>;
     runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBSaveOptions<ROW>): Promise<RunQueryResult<ROW>>;
     runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBOptions): Promise<number>;
     streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, opt?: CacheDBStreamOptions): Readable;

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

@@ -47,7 +47,7 @@ export interface CacheDBOptions {
      */
     onlyCache?: boolean;
 }
-export interface CacheDBSaveOptions<ROW extends Partial<ObjectWithId>> extends CacheDBOptions, CommonDBSaveOptions<ROW> {
+export interface CacheDBSaveOptions<ROW extends ObjectWithId> extends CacheDBOptions, CommonDBSaveOptions<ROW> {
 }
 export interface CacheDBStreamOptions extends CacheDBOptions, CommonDBStreamOptions {
 }

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

@@ -22,7 +22,7 @@ export declare class FileDB extends BaseCommonDB implements CommonDB {
     ping(): Promise<void>;
     getTables(): Promise<string[]>;
     getByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], _opt?: CommonDBOptions): Promise<ROW[]>;
-    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], _opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], _opt?: CommonDBSaveOptions<ROW>): Promise<void>;
     /**
      * Implementation is optimized for loading/saving _whole files_.
      */

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

@@ -53,7 +53,7 @@ export declare class InMemoryDB implements CommonDB {
     getTableSchema<ROW extends ObjectWithId>(_table: string): Promise<JsonSchemaRootObject<ROW>>;
     createTable<ROW extends ObjectWithId>(_table: string, _schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
     getByIds<ROW extends ObjectWithId>(_table: string, ids: ROW['id'][], _opt?: CommonDBOptions): Promise<ROW[]>;
-    saveBatch<ROW extends Partial<ObjectWithId>>(_table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(_table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
     deleteByIds<ROW extends ObjectWithId>(_table: string, ids: ROW['id'][], _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>>;

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

@@ -18,7 +18,7 @@ export declare class BaseCommonDB implements CommonDB {
     getByIds<ROW extends ObjectWithId>(_table: string, _ids: ROW['id'][]): Promise<ROW[]>;
     runQuery<ROW extends ObjectWithId>(_q: DBQuery<ROW>): Promise<RunQueryResult<ROW>>;
     runQueryCount<ROW extends ObjectWithId>(_q: DBQuery<ROW>): Promise<number>;
-    saveBatch<ROW extends Partial<ObjectWithId>>(_table: string, _rows: ROW[], _opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(_table: string, _rows: ROW[], _opt?: CommonDBSaveOptions<ROW>): Promise<void>;
     streamQuery<ROW extends ObjectWithId>(_q: DBQuery<ROW>): ReadableTyped<ROW>;
     /**
      * Naive implementation.

package/dist/common.db.d.ts

@@ -41,7 +41,7 @@ export interface CommonDB {
     /**
      * rows can have missing ids only if DB supports auto-generating them (like mysql auto_increment).
      */
-    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): 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).

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

@@ -1,4 +1,4 @@
-import { AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId, Saved, Unsaved } from '@naturalcycles/js-lib';
+import { AnyObject, AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId, Saved, Unsaved } from '@naturalcycles/js-lib';
 import { AjvSchema, ObjectSchemaTyped, ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { DBDeleteByIdsOperation, DBModelType, DBOperation, DBSaveBatchOperation, RunQueryResult } from '../db.model';
 import { DBQuery, RunnableDBQuery } from '../query/dbQuery';
@@ -10,7 +10,7 @@ import { CommonDaoCfg, CommonDaoCreateOptions, CommonDaoOptions, CommonDaoSaveOp
  * BM = Backend model (optimized for API access)
  * TM = Transport model (optimized to be sent over the wire)
  */
-export declare class CommonDao<BM extends Partial<ObjectWithId<ID>>, DBM extends ObjectWithId<ID> = Saved<BM>, TM = BM, ID extends string | number = DBM['id']> {
+export declare class CommonDao<BM extends ObjectWithId<ID>, DBM extends ObjectWithId<ID> = BM, TM extends AnyObject = BM, ID extends string | number = string> {
     cfg: CommonDaoCfg<BM, DBM, TM, ID>;
     constructor(cfg: CommonDaoCfg<BM, DBM, TM, ID>);
     create(part?: Partial<BM>, opt?: CommonDaoOptions): Saved<BM>;

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

@@ -1,8 +1,8 @@
-import { CommonLogger, ErrorMode, ObjectWithId, Saved } from '@naturalcycles/js-lib';
+import { CommonLogger, ErrorMode, ObjectWithId } from '@naturalcycles/js-lib';
 import { AjvSchema, AjvValidationError, JoiValidationError, ObjectSchemaTyped, TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib';
 import { CommonDB } from '../common.db';
 import { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions } from '../db.model';
-export interface CommonDaoHooks<BM extends Partial<ObjectWithId<ID>>, DBM extends ObjectWithId<ID>, TM, ID extends string | number> {
+export interface CommonDaoHooks<BM extends ObjectWithId<ID>, DBM extends ObjectWithId<ID>, TM, ID extends string | number> {
     createId: (obj: DBM | BM) => ID;
     parseNaturalId: (id: ID) => Partial<DBM>;
     beforeCreate: (bm: Partial<BM>) => Partial<BM>;
@@ -38,7 +38,7 @@ export declare enum CommonDaoLogLevel {
      */
     DATA_FULL = 30
 }
-export interface CommonDaoCfg<BM extends Partial<ObjectWithId<ID>>, DBM extends ObjectWithId<ID> = Saved<BM>, TM = BM, ID extends string | number = DBM['id']> {
+export interface CommonDaoCfg<BM extends ObjectWithId<ID>, DBM extends ObjectWithId<ID> = BM, TM = BM, ID extends string | number = string> {
     db: CommonDB;
     table: string;
     /**
@@ -181,7 +181,7 @@ export interface CommonDaoOptions extends CommonDBOptions {
 /**
  * All properties default to undefined.
  */
-export interface CommonDaoSaveOptions<DBM extends Partial<ObjectWithId>> extends CommonDaoOptions, CommonDBSaveOptions<DBM> {
+export interface CommonDaoSaveOptions<DBM extends ObjectWithId> extends CommonDaoOptions, CommonDBSaveOptions<DBM> {
     /**
      * @default false
      *

package/dist/db.model.d.ts

@@ -13,7 +13,7 @@ export interface CommonDBOptions {
 /**
  * All properties default to undefined.
  */
-export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId> extends CommonDBOptions {
+export interface CommonDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId> extends CommonDBOptions {
     excludeFromIndexes?: (keyof ROW)[];
     /**
      * Default is `upsert`

package/dist/query/dbQuery.d.ts

@@ -1,4 +1,4 @@
-import { AnyObjectWithId, ObjectWithId, AsyncMapper, Saved } from '@naturalcycles/js-lib';
+import { AnyObjectWithId, ObjectWithId, AsyncMapper, Saved, AnyObject } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { CommonDaoOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions } from '..';
 import { CommonDao } from '../commondao/common.dao';
@@ -83,7 +83,7 @@ export declare class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
 /**
  * DBQuery that has additional method to support Fluent API style.
  */
-export declare class RunnableDBQuery<BM extends Partial<ObjectWithId<ID>>, DBM extends ObjectWithId<ID>, TM, ID extends string | number> extends DBQuery<DBM> {
+export declare class RunnableDBQuery<BM extends ObjectWithId<ID>, DBM extends ObjectWithId<ID> = BM, TM extends AnyObject = BM, ID extends string | number = string> extends DBQuery<DBM> {
     dao: CommonDao<BM, DBM, TM, ID>;
     /**
      * Pass `table` to override table.

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

@@ -1,7 +1,8 @@
 /// <reference types="node" />
-import { BaseDBEntity, Saved } from '@naturalcycles/js-lib';
+import { BaseDBEntity, Saved, JsonSchemaObject } from '@naturalcycles/js-lib';
 export declare const TEST_TABLE = "TEST_TABLE";
 export interface TestItemBM extends BaseDBEntity {
+    id: string;
     k1: string;
     k2?: string | null;
     k3?: number;
@@ -17,8 +18,8 @@ export interface TestItemTM {
 export declare const testItemBMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemBM, TestItemBM>;
 export declare const testItemDBMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemDBM, TestItemDBM>;
 export declare const testItemTMSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<TestItemTM, TestItemTM>;
-export declare const testItemBMJsonSchema: import("@naturalcycles/js-lib").JsonSchemaObject<TestItemBM & Partial<import("@naturalcycles/js-lib").SavedDBEntity<string>>>;
-export declare const testItemDBMJsonSchema: import("@naturalcycles/js-lib").JsonSchemaObject<TestItemDBM>;
+export declare const testItemBMJsonSchema: JsonSchemaObject<TestItemBM>;
+export declare const testItemDBMJsonSchema: JsonSchemaObject<TestItemDBM>;
 export declare function createTestItemDBM(num?: number): TestItemDBM;
 export declare function createTestItemBM(num?: number): Saved<TestItemBM>;
 export declare function createTestItemsDBM(count?: number): TestItemDBM[];

package/dist/testing/test.model.js

@@ -25,6 +25,7 @@ exports.testItemTMSchema = (0, nodejs_lib_1.objectSchema)({
 });
 exports.testItemBMJsonSchema = js_lib_1.jsonSchema
     .rootObject({
+    id: js_lib_1.jsonSchema.string(),
     k1: js_lib_1.jsonSchema.string(),
     k2: js_lib_1.jsonSchema.oneOf([js_lib_1.jsonSchema.string(), js_lib_1.jsonSchema.null()]).optional(),
     k3: js_lib_1.jsonSchema.number().optional(),

package/dist/transaction/dbTransaction.d.ts

@@ -1,4 +1,4 @@
-import { AnyObjectWithId, ObjectWithId } from '@naturalcycles/js-lib';
+import { ObjectWithId } from '@naturalcycles/js-lib';
 import type { CommonDB } from '../common.db';
 import type { CommonDBSaveOptions, DBOperation } from '../db.model';
 /**
@@ -11,8 +11,8 @@ export declare class DBTransaction {
      * Convenience method.
      */
     static create(ops?: DBOperation[]): DBTransaction;
-    save<ROW extends ObjectWithId = AnyObjectWithId>(table: string, row: ROW): this;
-    saveBatch<ROW extends ObjectWithId = AnyObjectWithId>(table: string, rows: ROW[]): this;
+    save<ROW extends ObjectWithId>(table: string, row: ROW): this;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[]): this;
     deleteById(table: string, id: string): this;
     deleteByIds(table: string, ids: string[]): this;
 }

package/package.json

@@ -41,7 +41,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.42.1",
+  "version": "8.43.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

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

@@ -57,7 +57,7 @@ export interface CacheDBOptions {
   onlyCache?: boolean
 }
 
-export interface CacheDBSaveOptions<ROW extends Partial<ObjectWithId>>
+export interface CacheDBSaveOptions<ROW extends ObjectWithId>
   extends CacheDBOptions,
     CommonDBSaveOptions<ROW> {}
 

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

@@ -147,7 +147,7 @@ export class CacheDB extends BaseCommonDB implements CommonDB {
     return deletedIds
   }
 
-  override async saveBatch<ROW extends Partial<ObjectWithId>>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rows: ROW[],
     opt: CacheDBSaveOptions<ROW> = {},

package/src/adapter/file/file.db.ts

@@ -73,7 +73,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     return ids.map(id => byId[id]!).filter(Boolean)
   }
 
-  override async saveBatch<ROW extends Partial<ObjectWithId>>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rows: ROW[],
     _opt?: CommonDBSaveOptions<ROW>,
@@ -81,7 +81,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     if (!rows.length) return // save some api calls
 
     // 1. Load the whole file
-    const byId = _by(await this.loadFile<ROW & ObjectWithId>(table), r => r.id)
+    const byId = _by(await this.loadFile<ROW>(table), r => r.id)
 
     // 2. Merge with new data (using ids)
     let saved = 0

package/src/adapter/inmemory/inMemory.db.ts

@@ -152,7 +152,7 @@ export class InMemoryDB implements CommonDB {
     return ids.map(id => this.data[table]![id]).filter(Boolean) as ROW[]
   }
 
-  async saveBatch<ROW extends Partial<ObjectWithId>>(
+  async saveBatch<ROW extends ObjectWithId>(
     _table: string,
     rows: ROW[],
     opt: CommonDBSaveOptions<ROW> = {},

package/src/base.common.db.ts

@@ -55,7 +55,7 @@ export class BaseCommonDB implements CommonDB {
     return 0
   }
 
-  async saveBatch<ROW extends Partial<ObjectWithId>>(
+  async saveBatch<ROW extends ObjectWithId>(
     _table: string,
     _rows: ROW[],
     _opt?: CommonDBSaveOptions<ROW>,

package/src/common.db.ts

@@ -73,7 +73,7 @@ export interface CommonDB {
   /**
    * rows can have missing ids only if DB supports auto-generating them (like mysql auto_increment).
    */
-  saveBatch<ROW extends Partial<ObjectWithId>>(
+  saveBatch<ROW extends ObjectWithId>(
     table: string,
     rows: ROW[],
     opt?: CommonDBSaveOptions<ROW>,

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

@@ -1,4 +1,4 @@
-import { CommonLogger, ErrorMode, ObjectWithId, Saved } from '@naturalcycles/js-lib'
+import { CommonLogger, ErrorMode, ObjectWithId } from '@naturalcycles/js-lib'
 import {
   AjvSchema,
   AjvValidationError,
@@ -11,7 +11,7 @@ import { CommonDB } from '../common.db'
 import { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions } from '../db.model'
 
 export interface CommonDaoHooks<
-  BM extends Partial<ObjectWithId<ID>>,
+  BM extends ObjectWithId<ID>,
   DBM extends ObjectWithId<ID>,
   TM,
   ID extends string | number,
@@ -55,10 +55,10 @@ export enum CommonDaoLogLevel {
 }
 
 export interface CommonDaoCfg<
-  BM extends Partial<ObjectWithId<ID>>,
-  DBM extends ObjectWithId<ID> = Saved<BM>,
+  BM extends ObjectWithId<ID>,
+  DBM extends ObjectWithId<ID> = BM,
   TM = BM,
-  ID extends string | number = DBM['id'],
+  ID extends string | number = string,
 > {
   db: CommonDB
   table: string
@@ -227,7 +227,7 @@ export interface CommonDaoOptions extends CommonDBOptions {
 /**
  * All properties default to undefined.
  */
-export interface CommonDaoSaveOptions<DBM extends Partial<ObjectWithId>>
+export interface CommonDaoSaveOptions<DBM extends ObjectWithId>
   extends CommonDaoOptions,
     CommonDBSaveOptions<DBM> {
   /**

package/src/commondao/common.dao.ts

@@ -6,6 +6,7 @@ import {
   _since,
   _truncate,
   _uniqBy,
+  AnyObject,
   AppError,
   AsyncMapper,
   ErrorMode,
@@ -67,10 +68,10 @@ const isCI = !!process.env['CI']
  * TM = Transport model (optimized to be sent over the wire)
  */
 export class CommonDao<
-  BM extends Partial<ObjectWithId<ID>>,
-  DBM extends ObjectWithId<ID> = Saved<BM>,
-  TM = BM,
-  ID extends string | number = DBM['id'],
+  BM extends ObjectWithId<ID>,
+  DBM extends ObjectWithId<ID> = BM,
+  TM extends AnyObject = BM,
+  ID extends string | number = string,
 > {
   constructor(public cfg: CommonDaoCfg<BM, DBM, TM, ID>) {
     this.cfg = {

package/src/db.model.ts

@@ -16,7 +16,7 @@ export interface CommonDBOptions {}
 /**
  * All properties default to undefined.
  */
-export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId>
+export interface CommonDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId>
   extends CommonDBOptions {
   excludeFromIndexes?: (keyof ROW)[]
 

package/src/query/dbQuery.ts

@@ -1,4 +1,11 @@
-import { AnyObjectWithId, ObjectWithId, AsyncMapper, _truncate, Saved } from '@naturalcycles/js-lib'
+import {
+  AnyObjectWithId,
+  ObjectWithId,
+  AsyncMapper,
+  _truncate,
+  Saved,
+  AnyObject,
+} from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { CommonDaoOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions } from '..'
 import { CommonDao } from '../commondao/common.dao'
@@ -218,10 +225,10 @@ export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
  * DBQuery that has additional method to support Fluent API style.
  */
 export class RunnableDBQuery<
-  BM extends Partial<ObjectWithId<ID>>,
-  DBM extends ObjectWithId<ID>,
-  TM,
-  ID extends string | number,
+  BM extends ObjectWithId<ID>,
+  DBM extends ObjectWithId<ID> = BM,
+  TM extends AnyObject = BM,
+  ID extends string | number = string,
 > extends DBQuery<DBM> {
   /**
    * Pass `table` to override table.

package/src/testing/test.model.ts

@@ -1,4 +1,4 @@
-import { jsonSchema, _range, BaseDBEntity, Saved } from '@naturalcycles/js-lib'
+import { jsonSchema, _range, BaseDBEntity, Saved, JsonSchemaObject } from '@naturalcycles/js-lib'
 import {
   baseDBEntitySchema,
   binarySchema,
@@ -14,6 +14,7 @@ const MOCK_TS_2018_06_21 = 1529539200
 export const TEST_TABLE = 'TEST_TABLE'
 
 export interface TestItemBM extends BaseDBEntity {
+  id: string
   k1: string
   k2?: string | null
   k3?: number
@@ -49,8 +50,9 @@ export const testItemTMSchema = objectSchema<TestItemTM>({
   even: booleanSchema.optional(),
 })
 
-export const testItemBMJsonSchema = jsonSchema
+export const testItemBMJsonSchema: JsonSchemaObject<TestItemBM> = jsonSchema
   .rootObject<TestItemBM>({
+    id: jsonSchema.string(), // todo: not strictly needed here
     k1: jsonSchema.string(),
     k2: jsonSchema.oneOf<string | null>([jsonSchema.string(), jsonSchema.null()]).optional(),
     k3: jsonSchema.number().optional(),
@@ -60,7 +62,7 @@ export const testItemBMJsonSchema = jsonSchema
   .baseDBEntity()
   .build()
 
-export const testItemDBMJsonSchema = jsonSchema
+export const testItemDBMJsonSchema: JsonSchemaObject<TestItemDBM> = jsonSchema
   .rootObject<TestItemDBM>({
     // todo: figure out how to not copy-paste these 3 fields
     id: jsonSchema.string(),

package/src/transaction/dbTransaction.ts

@@ -1,4 +1,4 @@
-import { AnyObjectWithId, ObjectWithId } from '@naturalcycles/js-lib'
+import { ObjectWithId } from '@naturalcycles/js-lib'
 import type { CommonDB } from '../common.db'
 import type { CommonDBSaveOptions, DBOperation } from '../db.model'
 
@@ -15,7 +15,7 @@ export class DBTransaction {
     return new DBTransaction(ops)
   }
 
-  save<ROW extends ObjectWithId = AnyObjectWithId>(table: string, row: ROW): this {
+  save<ROW extends ObjectWithId>(table: string, row: ROW): this {
     this.ops.push({
       type: 'saveBatch',
       table,
@@ -24,7 +24,7 @@ export class DBTransaction {
     return this
   }
 
-  saveBatch<ROW extends ObjectWithId = AnyObjectWithId>(table: string, rows: ROW[]): this {
+  saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[]): this {
     this.ops.push({
       type: 'saveBatch',
       table,