@naturalcycles/db-lib 8.43.2 → 8.43.4

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 ObjectWithId>(table: string, rows: ROW[], opt?: CacheDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<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 ObjectWithId> extends CacheDBOptions, CommonDBSaveOptions<ROW> {
+export interface CacheDBSaveOptions<ROW extends Partial<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 ObjectWithId>(table: string, rows: ROW[], _opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<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 ObjectWithId>(_table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<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 ObjectWithId>(_table: string, _rows: ROW[], _opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<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 ObjectWithId>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<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

@@ -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 extends AnyObject = BM, ID extends string | number = string> {
+export declare class CommonDao<BM extends Partial<ObjectWithId<ID>>, DBM extends ObjectWithId<ID> = Saved<BM>, TM extends AnyObject = BM, ID extends string | number = NonNullable<BM['id']>> {
     cfg: CommonDaoCfg<BM, DBM, TM, ID>;
     constructor(cfg: CommonDaoCfg<BM, DBM, TM, ID>);
     create(part?: Partial<BM>, opt?: CommonDaoOptions): Saved<BM>;

package/dist/db.model.d.ts

@@ -1,4 +1,4 @@
-import { AnyObjectWithId, ObjectWithId } from '@naturalcycles/js-lib';
+import { ObjectWithId } from '@naturalcycles/js-lib';
 /**
  * Similar to SQL INSERT, UPDATE.
  * Insert will fail if row already exists.
@@ -13,7 +13,7 @@ export interface CommonDBOptions {
 /**
  * All properties default to undefined.
  */
-export interface CommonDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId> extends CommonDBOptions {
+export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = any> extends CommonDBOptions {
     excludeFromIndexes?: (keyof ROW)[];
     /**
      * Default is `upsert`
@@ -41,7 +41,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 Partial<ObjectWithId> = any> {
     type: 'saveBatch';
     table: string;
     rows: ROW[];

package/dist/transaction/dbTransaction.d.ts

@@ -11,8 +11,8 @@ export declare class DBTransaction {
      * Convenience method.
      */
     static create(ops?: DBOperation[]): DBTransaction;
-    save<ROW extends ObjectWithId>(table: string, row: ROW): this;
-    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[]): this;
+    save<ROW extends Partial<ObjectWithId>>(table: string, row: ROW): this;
+    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[]): this;
     deleteById(table: string, id: string): this;
     deleteByIds(table: string, ids: string[]): this;
 }
@@ -23,5 +23,5 @@ export declare class DBTransaction {
 export declare class RunnableDBTransaction extends DBTransaction {
     db: CommonDB;
     constructor(db: CommonDB);
-    commit<ROW extends ObjectWithId>(opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    commit<ROW extends Partial<ObjectWithId>>(opt?: CommonDBSaveOptions<ROW>): Promise<void>;
 }

package/dist/validation/index.d.ts

@@ -1,7 +1,7 @@
 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<import("@naturalcycles/js-lib").AnyObjectWithId<string | number>>, CommonDBSaveOptions<import("@naturalcycles/js-lib").AnyObjectWithId<string | number>>>;
+export declare const commonDBSaveOptionsSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<CommonDBSaveOptions<any>, CommonDBSaveOptions<any>>;
 export declare const dbQueryFilterOperatorSchema: import("@naturalcycles/nodejs-lib/dist/validation/joi/string.extensions").ExtendedStringSchema;
 export declare const dbQueryFilterSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId<string | number>>, DBQueryFilter<import("@naturalcycles/js-lib").AnyObjectWithId<string | number>>>;
 export declare const dbQueryOrderSchema: import("@naturalcycles/nodejs-lib").ObjectSchemaTyped<DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId<string | number>>, DBQueryOrder<import("@naturalcycles/js-lib").AnyObjectWithId<string | number>>>;

package/package.json

@@ -41,7 +41,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.43.2",
+  "version": "8.43.4",
   "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 ObjectWithId>
+export interface CacheDBSaveOptions<ROW extends Partial<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 ObjectWithId>(
+  override async saveBatch<ROW extends Partial<ObjectWithId>>(
     table: string,
     rows: ROW[],
     opt: CacheDBSaveOptions<ROW> = {},

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

@@ -15,6 +15,7 @@ import {
   _assert,
   _deepCopy,
   _stringMapEntries,
+  Saved,
 } from '@naturalcycles/js-lib'
 import { readableCreate, ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { dimGrey } from '@naturalcycles/nodejs-lib/dist/colors'
@@ -73,7 +74,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     return ids.map(id => byId[id]!).filter(Boolean)
   }
 
-  override async saveBatch<ROW extends ObjectWithId>(
+  override async saveBatch<ROW extends Partial<ObjectWithId>>(
     table: string,
     rows: ROW[],
     _opt?: CommonDBSaveOptions<ROW>,
@@ -81,7 +82,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>(table), r => r.id)
+    const byId = _by(await this.loadFile<Saved<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 ObjectWithId>(
+  async saveBatch<ROW extends Partial<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 ObjectWithId>(
+  async saveBatch<ROW extends Partial<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 ObjectWithId>(
+  saveBatch<ROW extends Partial<ObjectWithId>>(
     table: string,
     rows: ROW[],
     opt?: CommonDBSaveOptions<ROW>,

package/src/commondao/common.dao.ts

@@ -71,7 +71,7 @@ export class CommonDao<
   BM extends Partial<ObjectWithId<ID>>,
   DBM extends ObjectWithId<ID> = Saved<BM>,
   TM extends AnyObject = BM,
-  ID extends string | number = string,
+  ID extends string | number = NonNullable<BM['id']>,
 > {
   constructor(public cfg: CommonDaoCfg<BM, DBM, TM, ID>) {
     this.cfg = {

package/src/db.model.ts

@@ -1,4 +1,4 @@
-import { AnyObjectWithId, ObjectWithId } from '@naturalcycles/js-lib'
+import { ObjectWithId } from '@naturalcycles/js-lib'
 
 /**
  * Similar to SQL INSERT, UPDATE.
@@ -16,7 +16,7 @@ export interface CommonDBOptions {}
 /**
  * All properties default to undefined.
  */
-export interface CommonDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId>
+export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = any>
   extends CommonDBOptions {
   excludeFromIndexes?: (keyof ROW)[]
 
@@ -52,7 +52,7 @@ export interface RunQueryResult<T> {
 
 export type DBOperation = DBSaveBatchOperation | DBDeleteByIdsOperation
 
-export interface DBSaveBatchOperation<ROW extends ObjectWithId = any> {
+export interface DBSaveBatchOperation<ROW extends Partial<ObjectWithId> = any> {
   type: 'saveBatch'
   table: string
   rows: ROW[]

package/src/transaction/dbTransaction.ts

@@ -15,7 +15,7 @@ export class DBTransaction {
     return new DBTransaction(ops)
   }
 
-  save<ROW extends ObjectWithId>(table: string, row: ROW): this {
+  save<ROW extends Partial<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>(table: string, rows: ROW[]): this {
+  saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[]): this {
     this.ops.push({
       type: 'saveBatch',
       table,
@@ -61,7 +61,7 @@ export class RunnableDBTransaction extends DBTransaction {
     super()
   }
 
-  async commit<ROW extends ObjectWithId>(opt?: CommonDBSaveOptions<ROW>): Promise<void> {
+  async commit<ROW extends Partial<ObjectWithId>>(opt?: CommonDBSaveOptions<ROW>): Promise<void> {
     await this.db.commitTransaction(this, opt)
   }
 }