@naturalcycles/db-lib 9.2.0 → 9.3.0

package/src/db.model.ts

@@ -1,4 +1,4 @@
-import type { ObjectWithId } from '@naturalcycles/js-lib'
+import type { PartialObjectWithId } from '@naturalcycles/js-lib'
 import { CommonDB } from './common.db'
 
 /**
@@ -55,7 +55,7 @@ export interface CommonDBOptions {
 /**
  * All properties default to undefined.
  */
-export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = any>
+export interface CommonDBSaveOptions<ROW extends PartialObjectWithId = any>
   extends CommonDBOptions {
   excludeFromIndexes?: (keyof ROW)[]
 
@@ -91,7 +91,7 @@ export interface RunQueryResult<T> {
 
 export type DBOperation = DBSaveBatchOperation | DBDeleteByIdsOperation
 
-export interface DBSaveBatchOperation<ROW extends Partial<ObjectWithId> = any> {
+export interface DBSaveBatchOperation<ROW extends PartialObjectWithId = any> {
   type: 'saveBatch'
   table: string
   rows: ROW[]
@@ -131,6 +131,6 @@ export class DBIncrement {
   }
 }
 
-export type DBPatch<ROW extends Partial<ObjectWithId>> = Partial<
+export type DBPatch<ROW extends PartialObjectWithId> = Partial<
   Record<keyof ROW, ROW[keyof ROW] | DBIncrement>
 >

package/src/query/dbQuery.ts

@@ -1,11 +1,11 @@
 import {
-  AnyObjectWithId,
-  ObjectWithId,
   AsyncMapper,
   _truncate,
   Saved,
   AnyObject,
   _objectAssign,
+  PartialObjectWithId,
+  AnyPartialObjectWithId,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import {
@@ -62,13 +62,13 @@ export const dbQueryFilterOperatorValues: DBQueryFilterOperator[] = [
   'array-contains-any',
 ]
 
-export interface DBQueryFilter<ROW extends ObjectWithId = AnyObjectWithId> {
+export interface DBQueryFilter<ROW extends PartialObjectWithId = AnyPartialObjectWithId> {
   name: keyof ROW
   op: DBQueryFilterOperator
   val: any
 }
 
-export interface DBQueryOrder<ROW extends ObjectWithId = AnyObjectWithId> {
+export interface DBQueryOrder<ROW extends PartialObjectWithId = AnyPartialObjectWithId> {
   name: keyof ROW
   descending?: boolean
 }
@@ -83,17 +83,19 @@ export interface DBQueryOrder<ROW extends ObjectWithId = AnyObjectWithId> {
  *
  * <DBM> is the type of **queried** object (so e.g `key of DBM` can be used), not **returned** object.
  */
-export class DBQuery<ROW extends ObjectWithId = AnyObjectWithId> {
+export class DBQuery<ROW extends PartialObjectWithId = AnyPartialObjectWithId> {
   constructor(public table: string) {}
 
   /**
    * Convenience method.
    */
-  static create<ROW extends ObjectWithId = AnyObjectWithId>(table: string): DBQuery<ROW> {
+  static create<ROW extends PartialObjectWithId = AnyPartialObjectWithId>(
+    table: string,
+  ): DBQuery<ROW> {
     return new DBQuery(table)
   }
 
-  static fromPlainObject<ROW extends ObjectWithId = AnyObjectWithId>(
+  static fromPlainObject<ROW extends PartialObjectWithId = AnyPartialObjectWithId>(
     obj: Partial<DBQuery<ROW>> & { table: string },
   ): DBQuery<ROW> {
     return Object.assign(new DBQuery<ROW>(obj.table), obj)
@@ -237,8 +239,8 @@ 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 = Saved<BM>,
+  BM extends PartialObjectWithId,
+  DBM extends PartialObjectWithId = BM,
   TM extends AnyObject = BM,
 > extends DBQuery<DBM> {
   /**
@@ -259,7 +261,7 @@ export class RunnableDBQuery<
     return await this.dao.runQuerySingleColumn<T>(this, opt)
   }
 
-  async runQueryAsDBM(opt?: CommonDaoOptions): Promise<DBM[]> {
+  async runQueryAsDBM(opt?: CommonDaoOptions): Promise<Saved<DBM>[]> {
     return await this.dao.runQueryAsDBM(this, opt)
   }
 
@@ -271,7 +273,7 @@ export class RunnableDBQuery<
     return await this.dao.runQueryExtended(this, opt)
   }
 
-  async runQueryExtendedAsDBM(opt?: CommonDaoOptions): Promise<RunQueryResult<DBM>> {
+  async runQueryExtendedAsDBM(opt?: CommonDaoOptions): Promise<RunQueryResult<Saved<DBM>>> {
     return await this.dao.runQueryExtendedAsDBM(this, opt)
   }
 

package/src/testing/test.model.ts

@@ -5,7 +5,6 @@ import {
   booleanSchema,
   numberSchema,
   objectSchema,
-  savedDBEntitySchema,
   stringSchema,
 } from '@naturalcycles/nodejs-lib'
 
@@ -14,7 +13,6 @@ 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
@@ -22,7 +20,7 @@ export interface TestItemBM extends BaseDBEntity {
   b1?: Buffer
 }
 
-export interface TestItemDBM extends Saved<TestItemBM> {}
+export interface TestItemDBM extends TestItemBM {}
 
 export interface TestItemTM {
   k1: string
@@ -43,7 +41,7 @@ export const testItemDBMSchema = objectSchema<TestItemDBM>({
   k3: numberSchema.optional(),
   even: booleanSchema.optional(),
   b1: binarySchema.optional(),
-}).concat(savedDBEntitySchema as any)
+}).concat(baseDBEntitySchema as any)
 
 export const testItemTMSchema = objectSchema<TestItemTM>({
   k1: stringSchema,
@@ -76,7 +74,7 @@ export const testItemDBMJsonSchema: JsonSchemaObject<TestItemDBM> = jsonSchema
   })
   .build()
 
-export function createTestItemDBM(num = 1): TestItemDBM {
+export function createTestItemDBM(num = 1): Saved<TestItemDBM> {
   return {
     id: `id${num}`,
     k1: `v${num}`,
@@ -92,7 +90,7 @@ export function createTestItemBM(num = 1): Saved<TestItemBM> {
   return createTestItemDBM(num)
 }
 
-export function createTestItemsDBM(count = 1): TestItemDBM[] {
+export function createTestItemsDBM(count = 1): Saved<TestItemDBM>[] {
   return _range(1, count + 1).map(num => createTestItemDBM(num))
 }
 

package/src/transaction/dbTransaction.util.ts

@@ -1,4 +1,4 @@
-import { ObjectWithId } from '@naturalcycles/js-lib'
+import { PartialObjectWithId } from '@naturalcycles/js-lib'
 import type { CommonDB } from '../common.db'
 import { CommonDBOptions, CommonDBSaveOptions, DBTransaction } from '../db.model'
 
@@ -100,7 +100,7 @@ export class FakeDBTransaction implements DBTransaction {
   // no-op
   async rollback(): Promise<void> {}
 
-  async getByIds<ROW extends ObjectWithId>(
+  async getByIds<ROW extends PartialObjectWithId>(
     table: string,
     ids: string[],
     opt?: CommonDBOptions,
@@ -113,7 +113,7 @@ export class FakeDBTransaction implements DBTransaction {
   // ): Promise<RunQueryResult<ROW>> {
   //   return await this.db.runQuery(q, opt)
   // }
-  async saveBatch<ROW extends Partial<ObjectWithId>>(
+  async saveBatch<ROW extends PartialObjectWithId>(
     table: string,
     rows: ROW[],
     opt?: CommonDBSaveOptions<ROW>,