@naturalcycles/db-lib 10.4.1 → 10.5.0

package/dist/adapter/file/file.db.js

@@ -148,7 +148,7 @@ export class FileDB extends BaseCommonDB {
     sortRows(rows) {
         rows = rows.map(r => _filterUndefinedValues(r));
         if (this.cfg.sortOnSave) {
-            _sortBy(rows, r => r[this.cfg.sortOnSave.name], true);
+            _sortBy(rows, r => r[this.cfg.sortOnSave.name], { mutate: true });
             if (this.cfg.sortOnSave.descending)
                 rows.reverse(); // mutates
         }

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

@@ -1,5 +1,5 @@
 import type { Transform } from 'node:stream';
-import type { AsyncMapper, BaseDBEntity, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, StringMap, UnixTimestampMillis, Unsaved } from '@naturalcycles/js-lib';
+import type { AsyncIndexedMapper, BaseDBEntity, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, StringMap, UnixTimestampMillis, Unsaved } from '@naturalcycles/js-lib';
 import { ZodType } from '@naturalcycles/js-lib/zod';
 import { AjvSchema } from '@naturalcycles/nodejs-lib/ajv';
 import { type ObjectSchema } from '@naturalcycles/nodejs-lib/joi';
@@ -55,8 +55,8 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
     runQueryAsDBM(q: DBQuery<DBM>, opt?: CommonDaoReadOptions): Promise<DBM[]>;
     runQueryExtendedAsDBM(q: DBQuery<DBM>, opt?: CommonDaoReadOptions): Promise<RunQueryResult<DBM>>;
     runQueryCount(q: DBQuery<DBM>, opt?: CommonDaoReadOptions): Promise<number>;
-    streamQueryForEach(q: DBQuery<DBM>, mapper: AsyncMapper<BM, void>, opt?: CommonDaoStreamForEachOptions<BM>): Promise<void>;
-    streamQueryAsDBMForEach(q: DBQuery<DBM>, mapper: AsyncMapper<DBM, void>, opt?: CommonDaoStreamForEachOptions<DBM>): Promise<void>;
+    streamQueryForEach(q: DBQuery<DBM>, mapper: AsyncIndexedMapper<BM, void>, opt?: CommonDaoStreamForEachOptions<BM>): Promise<void>;
+    streamQueryAsDBMForEach(q: DBQuery<DBM>, mapper: AsyncIndexedMapper<DBM, void>, opt?: CommonDaoStreamForEachOptions<DBM>): Promise<void>;
     /**
      * Stream as Readable, to be able to .pipe() it further with support of backpressure.
      */
@@ -73,7 +73,7 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
     streamQuery(q: DBQuery<DBM>, opt?: CommonDaoStreamOptions<BM>): ReadableTyped<BM>;
     queryIds(q: DBQuery<DBM>, opt?: CommonDaoReadOptions): Promise<ID[]>;
     streamQueryIds(q: DBQuery<DBM>, opt?: CommonDaoStreamOptions<ID>): ReadableTyped<ID>;
-    streamQueryIdsForEach(q: DBQuery<DBM>, mapper: AsyncMapper<ID, void>, opt?: CommonDaoStreamForEachOptions<ID>): Promise<void>;
+    streamQueryIdsForEach(q: DBQuery<DBM>, mapper: AsyncIndexedMapper<ID, void>, opt?: CommonDaoStreamForEachOptions<ID>): Promise<void>;
     /**
      * Mutates!
      * "Returns", just to have a type of "Saved"

package/dist/query/dbQuery.d.ts

@@ -1,4 +1,4 @@
-import type { AsyncMapper, BaseDBEntity, ObjectWithId } from '@naturalcycles/js-lib';
+import type { AsyncIndexedMapper, BaseDBEntity, ObjectWithId } from '@naturalcycles/js-lib';
 import type { ReadableTyped } from '@naturalcycles/nodejs-lib/stream';
 import type { CommonDao } from '../commondao/common.dao.js';
 import type { CommonDaoOptions, CommonDaoReadOptions, CommonDaoStreamDeleteOptions, CommonDaoStreamForEachOptions, CommonDaoStreamOptions } from '../commondao/common.dao.model.js';
@@ -100,12 +100,12 @@ export declare class RunnableDBQuery<BM extends BaseDBEntity, DBM extends BaseDB
     runQueryExtendedAsDBM(opt?: CommonDaoReadOptions): Promise<RunQueryResult<DBM>>;
     runQueryCount(opt?: CommonDaoReadOptions): Promise<number>;
     patchByQuery(patch: Partial<DBM>, opt?: CommonDaoOptions): Promise<number>;
-    streamQueryForEach(mapper: AsyncMapper<BM, void>, opt?: CommonDaoStreamForEachOptions<BM>): Promise<void>;
-    streamQueryAsDBMForEach(mapper: AsyncMapper<DBM, void>, opt?: CommonDaoStreamForEachOptions<DBM>): Promise<void>;
+    streamQueryForEach(mapper: AsyncIndexedMapper<BM, void>, opt?: CommonDaoStreamForEachOptions<BM>): Promise<void>;
+    streamQueryAsDBMForEach(mapper: AsyncIndexedMapper<DBM, void>, opt?: CommonDaoStreamForEachOptions<DBM>): Promise<void>;
     streamQuery(opt?: CommonDaoStreamOptions<BM>): ReadableTyped<BM>;
     streamQueryAsDBM(opt?: CommonDaoStreamOptions<DBM>): ReadableTyped<DBM>;
     queryIds(opt?: CommonDaoReadOptions): Promise<ID[]>;
     streamQueryIds(opt?: CommonDaoStreamOptions<ID>): ReadableTyped<ID>;
-    streamQueryIdsForEach(mapper: AsyncMapper<ID, void>, opt?: CommonDaoStreamForEachOptions<ID>): Promise<void>;
+    streamQueryIdsForEach(mapper: AsyncIndexedMapper<ID, void>, opt?: CommonDaoStreamForEachOptions<ID>): Promise<void>;
     deleteByQuery(opt?: CommonDaoStreamDeleteOptions<DBM>): Promise<number>;
 }

package/dist/testing/keyValueDBTest.js

@@ -39,7 +39,7 @@ export async function runCommonKeyValueDBTest(db) {
     test('saveBatch, then getByIds', async () => {
         await db.saveBatch(TEST_TABLE, testEntries);
         const entries = await db.getByIds(TEST_TABLE, testIds);
-        _sortBy(entries, e => e[0], true);
+        _sortBy(entries, e => e[0], { mutate: true });
         expect(entries).toEqual(testEntries);
     });
     if (support.count) {

package/dist/testing/keyValueDaoTest.js

@@ -41,7 +41,7 @@ export async function runCommonKeyValueDaoTest(db) {
         await dao.saveBatch(testEntries);
         const entries = await dao.getByIds(testIds);
         // console.log(typeof entries[0]![1], entries[0]![1])
-        _sortBy(entries, e => e[0], true);
+        _sortBy(entries, e => e[0], { mutate: true });
         expect(entries).toEqual(testEntries); // Jest doesn't allow to compare Buffers directly
         // expect(entries.map(e => e[0])).toEqual(testEntries.map(e => e[0]))
         // expect(entries.map(e => e[1].toString())).toEqual(testEntries.map(e => e[1].toString()))

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.4.1",
+  "version": "10.5.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "19.4.5"
+    "@naturalcycles/dev-lib": "19.5.0"
   },
   "files": [
     "dist",

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

@@ -228,7 +228,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
     rows = rows.map(r => _filterUndefinedValues(r))
 
     if (this.cfg.sortOnSave) {
-      _sortBy(rows, r => r[this.cfg.sortOnSave!.name as keyof ROW], true)
+      _sortBy(rows, r => r[this.cfg.sortOnSave!.name as keyof ROW] as string, { mutate: true })
       if (this.cfg.sortOnSave.descending) rows.reverse() // mutates
     }
 

package/src/commondao/common.dao.ts

@@ -1,6 +1,6 @@
 import type { Transform } from 'node:stream'
 import type {
-  AsyncMapper,
+  AsyncIndexedMapper,
   BaseDBEntity,
   CommonLogger,
   JsonSchemaObject,
@@ -358,7 +358,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
 
   async streamQueryForEach(
     q: DBQuery<DBM>,
-    mapper: AsyncMapper<BM, void>,
+    mapper: AsyncIndexedMapper<BM, void>,
     opt: CommonDaoStreamForEachOptions<BM> = {},
   ): Promise<void> {
     this.validateQueryIndexes(q) // throws if query uses `excludeFromIndexes` property
@@ -408,7 +408,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
 
   async streamQueryAsDBMForEach(
     q: DBQuery<DBM>,
-    mapper: AsyncMapper<DBM, void>,
+    mapper: AsyncIndexedMapper<DBM, void>,
     opt: CommonDaoStreamForEachOptions<DBM> = {},
   ): Promise<void> {
     this.validateQueryIndexes(q) // throws if query uses `excludeFromIndexes` property
@@ -581,7 +581,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
 
   async streamQueryIdsForEach(
     q: DBQuery<DBM>,
-    mapper: AsyncMapper<ID, void>,
+    mapper: AsyncIndexedMapper<ID, void>,
     opt: CommonDaoStreamForEachOptions<ID> = {},
   ): Promise<void> {
     this.validateQueryIndexes(q) // throws if query uses `excludeFromIndexes` property

package/src/query/dbQuery.ts

@@ -1,4 +1,4 @@
-import type { AsyncMapper, BaseDBEntity, ObjectWithId } from '@naturalcycles/js-lib'
+import type { AsyncIndexedMapper, BaseDBEntity, ObjectWithId } from '@naturalcycles/js-lib'
 import { _objectAssign, _truncate } from '@naturalcycles/js-lib'
 import type { ReadableTyped } from '@naturalcycles/nodejs-lib/stream'
 import type { CommonDao } from '../commondao/common.dao.js'
@@ -276,14 +276,14 @@ export class RunnableDBQuery<
   }
 
   async streamQueryForEach(
-    mapper: AsyncMapper<BM, void>,
+    mapper: AsyncIndexedMapper<BM, void>,
     opt?: CommonDaoStreamForEachOptions<BM>,
   ): Promise<void> {
     await this.dao.streamQueryForEach(this, mapper, opt)
   }
 
   async streamQueryAsDBMForEach(
-    mapper: AsyncMapper<DBM, void>,
+    mapper: AsyncIndexedMapper<DBM, void>,
     opt?: CommonDaoStreamForEachOptions<DBM>,
   ): Promise<void> {
     await this.dao.streamQueryAsDBMForEach(this, mapper, opt)
@@ -306,7 +306,7 @@ export class RunnableDBQuery<
   }
 
   async streamQueryIdsForEach(
-    mapper: AsyncMapper<ID, void>,
+    mapper: AsyncIndexedMapper<ID, void>,
     opt?: CommonDaoStreamForEachOptions<ID>,
   ): Promise<void> {
     await this.dao.streamQueryIdsForEach(this, mapper, opt)

package/src/testing/keyValueDBTest.ts

@@ -54,7 +54,7 @@ export async function runCommonKeyValueDBTest(db: CommonKeyValueDB): Promise<voi
     await db.saveBatch(TEST_TABLE, testEntries)
 
     const entries = await db.getByIds(TEST_TABLE, testIds)
-    _sortBy(entries, e => e[0], true)
+    _sortBy(entries, e => e[0], { mutate: true })
     expect(entries).toEqual(testEntries)
   })
 

package/src/testing/keyValueDaoTest.ts

@@ -54,7 +54,7 @@ export async function runCommonKeyValueDaoTest(db: CommonKeyValueDB): Promise<vo
     const entries = await dao.getByIds(testIds)
     // console.log(typeof entries[0]![1], entries[0]![1])
 
-    _sortBy(entries, e => e[0], true)
+    _sortBy(entries, e => e[0], { mutate: true })
     expect(entries).toEqual(testEntries) // Jest doesn't allow to compare Buffers directly
     // expect(entries.map(e => e[0])).toEqual(testEntries.map(e => e[0]))
     // expect(entries.map(e => e[1].toString())).toEqual(testEntries.map(e => e[1].toString()))