@naturalcycles/db-lib 10.0.0 → 10.0.2

package/src/kv/commonKeyValueDao.ts

@@ -1,8 +1,10 @@
-import { AppError, CommonLogger, KeyValueTuple, pMap } from '@naturalcycles/js-lib'
-import { deflateString, inflateToString, ReadableTyped } from '@naturalcycles/nodejs-lib'
-import { CommonDaoLogLevel } from '../commondao/common.dao.model'
-import { CommonDBCreateOptions } from '../db.model'
-import {
+import type { CommonLogger, KeyValueTuple } from '@naturalcycles/js-lib'
+import { AppError, pMap } from '@naturalcycles/js-lib'
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { deflateString, inflateToString } from '@naturalcycles/nodejs-lib'
+import type { CommonDaoLogLevel } from '../commondao/common.dao.model'
+import type { CommonDBCreateOptions } from '../db.model'
+import type {
   CommonKeyValueDB,
   CommonKeyValueDBSaveBatchOptions,
   IncrementTuple,

package/src/kv/commonKeyValueDaoMemoCache.ts

@@ -1,11 +1,6 @@
-import {
-  AsyncMemoCache,
-  localTime,
-  MISS,
-  NumberOfSeconds,
-  UnixTimestamp,
-} from '@naturalcycles/js-lib'
-import { CommonKeyValueDao } from './commonKeyValueDao'
+import type { AsyncMemoCache, NumberOfSeconds, UnixTimestamp } from '@naturalcycles/js-lib'
+import { localTime, MISS } from '@naturalcycles/js-lib'
+import type { CommonKeyValueDao } from './commonKeyValueDao'
 
 export interface CommonKeyValueDaoMemoCacheCfg<VALUE> {
   dao: CommonKeyValueDao<string, VALUE>

package/src/model.util.ts

@@ -1,4 +1,5 @@
-import { CreatedUpdated, CreatedUpdatedId, localTime } from '@naturalcycles/js-lib'
+import type { CreatedUpdated, CreatedUpdatedId } from '@naturalcycles/js-lib'
+import { localTime } from '@naturalcycles/js-lib'
 import { stringId } from '@naturalcycles/nodejs-lib'
 
 export function createdUpdatedFields(

package/src/pipeline/dbPipelineBackup.ts

@@ -1,13 +1,6 @@
-import {
-  _passthroughMapper,
-  AppError,
-  AsyncMapper,
-  ErrorMode,
-  localTime,
-  pMap,
-  StringMap,
-  UnixTimestamp,
-} from '@naturalcycles/js-lib'
+import type { AsyncMapper, StringMap, UnixTimestamp } from '@naturalcycles/js-lib'
+import { _passthroughMapper, AppError, ErrorMode, localTime, pMap } from '@naturalcycles/js-lib'
+import type { TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib'
 import {
   _pipeline,
   boldWhite,
@@ -16,13 +9,11 @@ import {
   grey,
   NDJsonStats,
   transformLogProgress,
-  TransformLogProgressOptions,
   transformMap,
-  TransformMapOptions,
   transformTap,
   yellow,
 } from '@naturalcycles/nodejs-lib'
-import { CommonDB } from '../common.db'
+import type { CommonDB } from '../common.db'
 import { DBQuery } from '../index'
 
 export interface DBPipelineBackupOptions extends TransformLogProgressOptions {

package/src/pipeline/dbPipelineCopy.ts

@@ -1,12 +1,6 @@
-import {
-  _passthroughMapper,
-  AsyncMapper,
-  BaseDBEntity,
-  ErrorMode,
-  localTime,
-  pMap,
-  UnixTimestamp,
-} from '@naturalcycles/js-lib'
+import type { AsyncMapper, BaseDBEntity, UnixTimestamp } from '@naturalcycles/js-lib'
+import { _passthroughMapper, ErrorMode, localTime, pMap } from '@naturalcycles/js-lib'
+import type { TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib'
 import {
   _pipeline,
   boldWhite,
@@ -15,15 +9,13 @@ import {
   NDJsonStats,
   transformChunk,
   transformLogProgress,
-  TransformLogProgressOptions,
   transformMap,
-  TransformMapOptions,
   transformTap,
   writableForEach,
   yellow,
 } from '@naturalcycles/nodejs-lib'
-import { CommonDB } from '../common.db'
-import { CommonDBSaveOptions } from '../db.model'
+import type { CommonDB } from '../common.db'
+import type { CommonDBSaveOptions } from '../db.model'
 import { DBQuery } from '../query/dbQuery'
 
 export interface DBPipelineCopyOptions extends TransformLogProgressOptions {

package/src/pipeline/dbPipelineRestore.ts

@@ -1,15 +1,18 @@
+import type {
+  AsyncMapper,
+  BaseDBEntity,
+  JsonSchemaObject,
+  UnixTimestamp,
+} from '@naturalcycles/js-lib'
 import {
   _hb,
   _mapValues,
   _passthroughMapper,
-  AsyncMapper,
-  BaseDBEntity,
   ErrorMode,
-  JsonSchemaObject,
   localTime,
   pMap,
-  UnixTimestamp,
 } from '@naturalcycles/js-lib'
+import type { TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib'
 import {
   _pipeline,
   boldWhite,
@@ -20,15 +23,13 @@ import {
   transformChunk,
   transformFilterSync,
   transformLogProgress,
-  TransformLogProgressOptions,
   transformMap,
-  TransformMapOptions,
   transformTap,
   writableForEach,
   yellow,
 } from '@naturalcycles/nodejs-lib'
-import { CommonDB } from '../common.db'
-import { CommonDBSaveOptions } from '../index'
+import type { CommonDB } from '../common.db'
+import type { CommonDBSaveOptions } from '../index'
 
 export interface DBPipelineRestoreOptions extends TransformLogProgressOptions {
   /**

package/src/query/dbQuery.ts

@@ -1,20 +1,15 @@
-import {
-  _objectAssign,
-  _truncate,
-  AsyncMapper,
-  BaseDBEntity,
-  ObjectWithId,
-} from '@naturalcycles/js-lib'
-import { ReadableTyped } from '@naturalcycles/nodejs-lib'
-import {
+import type { AsyncMapper, BaseDBEntity, ObjectWithId } from '@naturalcycles/js-lib'
+import { _objectAssign, _truncate } from '@naturalcycles/js-lib'
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import type {
   CommonDaoOptions,
   CommonDaoReadOptions,
   CommonDaoStreamDeleteOptions,
   CommonDaoStreamForEachOptions,
   CommonDaoStreamOptions,
 } from '..'
-import { CommonDao } from '../commondao/common.dao'
-import { RunQueryResult } from '../db.model'
+import type { CommonDao } from '../commondao/common.dao'
+import type { RunQueryResult } from '../db.model'
 
 /**
  * Modeled after Firestore operators (WhereFilterOp type)

package/src/testing/daoTest.ts

@@ -1,12 +1,11 @@
 import { Readable } from 'node:stream'
-import { _deepCopy, _omit, _pick, _sortBy, localTime } from '@naturalcycles/js-lib'
+import { _deepCopy, _filterObject, _omit, _pick, _sortBy, localTime } from '@naturalcycles/js-lib'
 import { _pipeline } from '@naturalcycles/nodejs-lib'
-import { expect, test } from 'vitest'
 import { CommonDaoLogLevel, DBQuery } from '..'
-import { CommonDB } from '../common.db'
+import type { CommonDB } from '../common.db'
 import { CommonDao } from '../commondao/common.dao'
-import { TestItemBM } from '.'
-import { CommonDBImplementationQuirks, expectMatch } from './dbTest'
+import type { TestItemBM } from '.'
+import type { CommonDBImplementationQuirks } from './dbTest'
 import {
   createTestItemBM,
   createTestItemsBM,
@@ -15,7 +14,13 @@ import {
   testItemBMSchema,
 } from './test.model'
 
-export function runCommonDaoTest(db: CommonDB, quirks: CommonDBImplementationQuirks = {}): void {
+export async function runCommonDaoTest(
+  db: CommonDB,
+  quirks: CommonDBImplementationQuirks = {},
+): Promise<void> {
+  // this is because vitest cannot be "required" from cjs
+  const { test, expect } = await import('vitest')
+
   const { support } = db
   const dao = new CommonDao({
     table: TEST_TABLE,
@@ -359,4 +364,21 @@ export function runCommonDaoTest(db: CommonDB, quirks: CommonDBImplementationQui
       })
     }
   }
+
+  function expectMatch(expected: any[], actual: any[], quirks: CommonDBImplementationQuirks): void {
+    // const expectedSorted = sortObjectDeep(expected)
+    // const actualSorted = sortObjectDeep(actual)
+
+    if (quirks.allowBooleansAsUndefined) {
+      expected = expected.map(r => {
+        return typeof r !== 'object' ? r : _filterObject(r, (_k, v) => v !== false)
+      })
+    }
+
+    if (quirks.allowExtraPropertiesInResponse) {
+      expect(actual).toMatchObject(expected)
+    } else {
+      expect(actual).toEqual(expected)
+    }
+  }
 }

package/src/testing/dbTest.ts

@@ -1,13 +1,13 @@
 import { _deepFreeze, _filterObject, _pick, _sortBy, localTime, pMap } from '@naturalcycles/js-lib'
-import { expect, test } from 'vitest'
-import { CommonDB, CommonDBType } from '../common.db'
+import type { CommonDB } from '../common.db'
+import { CommonDBType } from '../common.db'
 import { DBQuery } from '../query/dbQuery'
+import type { TestItemDBM } from './test.model'
 import {
   createTestItemDBM,
   createTestItemsDBM,
   TEST_TABLE,
   testItemBMJsonSchema,
-  TestItemDBM,
 } from './test.model'
 
 /**
@@ -25,7 +25,13 @@ export interface CommonDBImplementationQuirks {
   allowBooleansAsUndefined?: boolean
 }
 
-export function runCommonDBTest(db: CommonDB, quirks: CommonDBImplementationQuirks = {}): void {
+export async function runCommonDBTest(
+  db: CommonDB,
+  quirks: CommonDBImplementationQuirks = {},
+): Promise<void> {
+  // this is because vitest cannot be "required" from cjs
+  const { test, expect } = await import('vitest')
+
   const { support } = db
   const items = createTestItemsDBM(3)
   _deepFreeze(items)
@@ -380,25 +386,21 @@ export function runCommonDBTest(db: CommonDB, quirks: CommonDBImplementationQuir
       await db.deleteByQuery(queryAll())
     })
   }
-}
 
-export function expectMatch(
-  expected: any[],
-  actual: any[],
-  quirks: CommonDBImplementationQuirks,
-): void {
-  // const expectedSorted = sortObjectDeep(expected)
-  // const actualSorted = sortObjectDeep(actual)
-
-  if (quirks.allowBooleansAsUndefined) {
-    expected = expected.map(r => {
-      return typeof r !== 'object' ? r : _filterObject(r, (_k, v) => v !== false)
-    })
-  }
+  function expectMatch(expected: any[], actual: any[], quirks: CommonDBImplementationQuirks): void {
+    // const expectedSorted = sortObjectDeep(expected)
+    // const actualSorted = sortObjectDeep(actual)
 
-  if (quirks.allowExtraPropertiesInResponse) {
-    expect(actual).toMatchObject(expected)
-  } else {
-    expect(actual).toEqual(expected)
+    if (quirks.allowBooleansAsUndefined) {
+      expected = expected.map(r => {
+        return typeof r !== 'object' ? r : _filterObject(r, (_k, v) => v !== false)
+      })
+    }
+
+    if (quirks.allowExtraPropertiesInResponse) {
+      expect(actual).toMatchObject(expected)
+    } else {
+      expect(actual).toEqual(expected)
+    }
   }
 }

package/src/testing/index.ts

@@ -1,18 +1,17 @@
 import { runCommonDaoTest } from './daoTest'
-import { CommonDBImplementationQuirks, runCommonDBTest } from './dbTest'
+import type { CommonDBImplementationQuirks } from './dbTest'
+import { runCommonDBTest } from './dbTest'
 import { runCommonKeyValueDaoTest } from './keyValueDaoTest'
 import { runCommonKeyValueDBTest } from './keyValueDBTest'
+import type { TestItemBM, TestItemDBM, TestItemTM } from './test.model'
 import {
   createTestItemBM,
   createTestItemDBM,
   createTestItemsBM,
   createTestItemsDBM,
   TEST_TABLE,
-  TestItemBM,
   testItemBMJsonSchema,
   testItemBMSchema,
-  TestItemDBM,
-  TestItemTM,
   testItemTMSchema,
 } from './test.model'
 

package/src/testing/keyValueDBTest.ts

@@ -1,6 +1,6 @@
-import { _range, _sortBy, KeyValueTuple } from '@naturalcycles/js-lib'
-import { afterAll, beforeAll, expect, test } from 'vitest'
-import { CommonKeyValueDB } from '../kv/commonKeyValueDB'
+import type { KeyValueTuple } from '@naturalcycles/js-lib'
+import { _range, _sortBy } from '@naturalcycles/js-lib'
+import type { CommonKeyValueDB } from '../kv/commonKeyValueDB'
 import { TEST_TABLE } from './test.model'
 
 const testIds = _range(1, 4).map(n => `id${n}`)
@@ -10,7 +10,9 @@ const testEntries: KeyValueTuple<string, Buffer>[] = testIds.map(id => [
   Buffer.from(`${id}value`),
 ])
 
-export function runCommonKeyValueDBTest(db: CommonKeyValueDB): void {
+export async function runCommonKeyValueDBTest(db: CommonKeyValueDB): Promise<void> {
+  const { afterAll, beforeAll, expect, test } = await import('vitest')
+
   beforeAll(async () => {
     // Tests in this suite are not isolated,
     // and failing tests can leave the DB in an unexpected state for other tests,

package/src/testing/keyValueDaoTest.ts

@@ -1,14 +1,15 @@
 import { _sortBy } from '@naturalcycles/js-lib'
-import { afterAll, beforeAll, expect, test } from 'vitest'
 import { CommonKeyValueDao } from '../kv/commonKeyValueDao'
-import { CommonKeyValueDB, KeyValueDBTuple } from '../kv/commonKeyValueDB'
+import type { CommonKeyValueDB, KeyValueDBTuple } from '../kv/commonKeyValueDB'
 import { createTestItemsBM, TEST_TABLE } from './test.model'
 
 const testItems = createTestItemsBM(4)
 const testIds = testItems.map(e => e.id)
 const testEntries: KeyValueDBTuple[] = testItems.map(e => [e.id, Buffer.from(`${e.id}value`)])
 
-export function runCommonKeyValueDaoTest(db: CommonKeyValueDB): void {
+export async function runCommonKeyValueDaoTest(db: CommonKeyValueDB): Promise<void> {
+  const { afterAll, beforeAll, expect, test } = await import('vitest')
+
   const dao = new CommonKeyValueDao({
     db,
     table: TEST_TABLE,

package/src/testing/test.model.ts

@@ -1,10 +1,5 @@
-import {
-  _range,
-  BaseDBEntity,
-  jsonSchema,
-  JsonSchemaObject,
-  UnixTimestamp,
-} from '@naturalcycles/js-lib'
+import type { BaseDBEntity, JsonSchemaObject, UnixTimestamp } from '@naturalcycles/js-lib'
+import { _range, jsonSchema } from '@naturalcycles/js-lib'
 import {
   baseDBEntitySchema,
   binarySchema,

package/src/testing/timeSeriesTest.util.ts

@@ -1,5 +1,5 @@
 import { _randomInt, _range } from '@naturalcycles/js-lib'
-import { TimeSeriesDataPoint } from '../timeseries/timeSeries.model'
+import type { TimeSeriesDataPoint } from '../timeseries/timeSeries.model'
 
 export function createTestTimeSeries(count = 10): TimeSeriesDataPoint[] {
   const ts = Date.now()

package/src/timeseries/commonTimeSeriesDao.ts

@@ -1,6 +1,7 @@
-import { _isTruthy, ObjectWithId } from '@naturalcycles/js-lib'
+import type { ObjectWithId } from '@naturalcycles/js-lib'
+import { _isTruthy } from '@naturalcycles/js-lib'
 import { DBQuery } from '../query/dbQuery'
-import {
+import type {
   CommonTimeSeriesDaoCfg,
   TimeSeriesDataPoint,
   TimeSeriesQuery,

package/src/timeseries/timeSeries.model.ts

@@ -1,4 +1,4 @@
-import { CommonDB } from '../common.db'
+import type { CommonDB } from '../common.db'
 
 export interface CommonTimeSeriesDaoCfg {
   db: CommonDB

package/src/transaction/dbTransaction.util.ts

@@ -1,6 +1,6 @@
-import { ObjectWithId } from '@naturalcycles/js-lib'
+import type { ObjectWithId } from '@naturalcycles/js-lib'
 import type { CommonDB } from '../common.db'
-import { CommonDBOptions, CommonDBSaveOptions, DBTransaction } from '../db.model'
+import type { CommonDBOptions, CommonDBSaveOptions, DBTransaction } from '../db.model'
 
 /**
  * Optimizes the Transaction (list of DBOperations) to do less operations.

package/src/validation/index.ts

@@ -7,14 +7,9 @@ import {
   objectSchema,
   stringSchema,
 } from '@naturalcycles/nodejs-lib'
-import { CommonDBOptions, CommonDBSaveOptions } from '../db.model'
-import {
-  DBQuery,
-  DBQueryFilter,
-  DBQueryFilterOperator,
-  dbQueryFilterOperatorValues,
-  DBQueryOrder,
-} from '../query/dbQuery'
+import type { CommonDBOptions, CommonDBSaveOptions } from '../db.model'
+import type { DBQuery, DBQueryFilter, DBQueryFilterOperator, DBQueryOrder } from '../query/dbQuery'
+import { dbQueryFilterOperatorValues } from '../query/dbQuery'
 
 export const commonDBOptionsSchema = objectSchema<CommonDBOptions>({
   ['onlyCache' as any]: booleanSchema.optional(),