@naturalcycles/db-lib 10.42.0 → 10.42.2

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

@@ -168,14 +168,15 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
      */
     patchInTransaction?: boolean;
     /**
-     * When specified, the listed properties will be compressed under a `data` property in the DBM.
-     * If DBM already has a `data` property and you don't add it to the list, an error will be thrown.
-     *
-     * When specified with an empty `keys` list, then compression will be skipped, but all previously compressed data
-     * will be decompressed, so the Dao can still work.
+     * When specified, the listed properties will be compressed into the `__compressed` property.
      *
      * Compression happens after the `beforeBMToDBM` hook and before the DBM is saved to the database.
      * Decompression happens after the DBM is loaded from the database and before the `beforeDBMToBM` hook.
+     *
+     * To migrate away from compression:
+     * 1. Remove this config (or set `keys` to empty array)
+     * 2. Add `beforeDBMToBM: CommonDao.decompressLegacyRow` to your hooks to decompress legacy data on read
+     * 3. Once all data has been naturally rewritten without compression, remove the hook
      */
     compress?: {
         keys: (keyof DBM)[];

package/dist/commondao/common.dao.model.js

@@ -1,4 +1,5 @@
-export var CommonDaoLogLevel;
+export { CommonDaoLogLevel };
+var CommonDaoLogLevel;
 (function (CommonDaoLogLevel) {
     /**
      * Same as undefined

package/dist/commondb/common.db.js

@@ -1,4 +1,5 @@
-export var CommonDBType;
+export { CommonDBType };
+var CommonDBType;
 (function (CommonDBType) {
     CommonDBType["document"] = "document";
     CommonDBType["relational"] = "relational";

package/dist/db.model.js

@@ -1,9 +1,11 @@
-export var DBRelation;
+export { DBRelation };
+var DBRelation;
 (function (DBRelation) {
     DBRelation["ONE_TO_ONE"] = "ONE_TO_ONE";
     DBRelation["ONE_TO_MANY"] = "ONE_TO_MANY";
 })(DBRelation || (DBRelation = {}));
-export var DBModelType;
+export { DBModelType };
+var DBModelType;
 (function (DBModelType) {
     DBModelType["DBM"] = "DBM";
     DBModelType["BM"] = "BM";

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

@@ -1,5 +1,5 @@
 import type { CommonLogger } from '@naturalcycles/js-lib/log';
-import { type AnyObjectWithId, type ObjectWithId, type StringMap } from '@naturalcycles/js-lib/types';
+import type { AnyObjectWithId, ObjectWithId, StringMap } from '@naturalcycles/js-lib/types';
 import type { JsonSchema } from '@naturalcycles/nodejs-lib/ajv';
 import { Pipeline } from '@naturalcycles/nodejs-lib/stream';
 import type { CommonDB, CommonDBSupport } from '../commondb/common.db.js';

package/dist/inmemory/inMemory.db.js

@@ -1,7 +1,7 @@
 import { _isEmptyObject } from '@naturalcycles/js-lib';
 import { _assert } from '@naturalcycles/js-lib/error/assert.js';
 import { _deepCopy, _sortObjectDeep } from '@naturalcycles/js-lib/object';
-import { _stringMapEntries, _stringMapValues, } from '@naturalcycles/js-lib/types';
+import { _stringMapEntries, _stringMapValues } from '@naturalcycles/js-lib/types';
 import { generateJsonSchemaFromData } from '@naturalcycles/nodejs-lib/ajv';
 import { Pipeline } from '@naturalcycles/nodejs-lib/stream';
 import { bufferReviver } from '@naturalcycles/nodejs-lib/stream/ndjson/transformJsonParse.js';

package/dist/inmemory/inMemoryKeyValueDB.d.ts

@@ -8,8 +8,8 @@ export declare class InMemoryKeyValueDB implements CommonKeyValueDB {
     cfg: InMemoryKeyValueDBCfg;
     constructor(cfg?: InMemoryKeyValueDBCfg);
     support: {
-        count?: boolean;
-        increment?: boolean;
+        count?: boolean | undefined;
+        increment?: boolean | undefined;
     };
     data: StringMap<StringMap<any>>;
     ping(): Promise<void>;

package/dist/kv/commonKeyValueDao.d.ts

@@ -1,5 +1,5 @@
 import type { CommonLogger } from '@naturalcycles/js-lib/log';
-import { type Integer, type KeyValueTuple } from '@naturalcycles/js-lib/types';
+import type { Integer, KeyValueTuple } from '@naturalcycles/js-lib/types';
 import type { Pipeline } from '@naturalcycles/nodejs-lib/stream';
 import type { CommonDaoLogLevel } from '../commondao/common.dao.model.js';
 import type { CommonDBCreateOptions } from '../db.model.js';

package/dist/kv/commonKeyValueDao.js

@@ -7,14 +7,14 @@ import { decompressZstdOrInflateToString, deflateString, inflateToString, zstdCo
  */
 export function commonKeyValueDaoDeflatedJsonTransformer() {
     return {
-        valueToBuffer: async (v) => await deflateString(JSON.stringify(v)),
-        bufferToValue: async (buf) => JSON.parse(await inflateToString(buf)),
+        valueToBuffer: async v => await deflateString(JSON.stringify(v)),
+        bufferToValue: async buf => JSON.parse(await inflateToString(buf)),
     };
 }
 export function commonKeyValueDaoZstdJsonTransformer(level) {
     return {
-        valueToBuffer: async (v) => await zstdCompress(JSON.stringify(v), level),
-        bufferToValue: async (buf) => JSON.parse(await zstdDecompressToString(buf)),
+        valueToBuffer: async v => await zstdCompress(JSON.stringify(v), level),
+        bufferToValue: async buf => JSON.parse(await zstdDecompressToString(buf)),
     };
 }
 /**
@@ -23,8 +23,8 @@ export function commonKeyValueDaoZstdJsonTransformer(level) {
  */
 export function commonKeyValueDaoCompressedTransformer() {
     return {
-        valueToBuffer: async (v) => await zstdCompress(JSON.stringify(v)),
-        bufferToValue: async (buf) => JSON.parse(await decompressZstdOrInflateToString(buf)),
+        valueToBuffer: async v => await zstdCompress(JSON.stringify(v)),
+        bufferToValue: async buf => JSON.parse(await decompressZstdOrInflateToString(buf)),
     };
 }
 // todo: logging
@@ -117,7 +117,7 @@ export class CommonKeyValueDao {
         if (!transformer) {
             return this.cfg.db.streamValues(this.cfg.table, limit);
         }
-        return this.cfg.db.streamValues(this.cfg.table, limit).map(async (buf) => {
+        return this.cfg.db.streamValues(this.cfg.table, limit).map(async buf => {
             try {
                 return await transformer.bufferToValue(buf);
             }

package/dist/pipeline/dbPipelineBackup.js

@@ -23,7 +23,7 @@ export async function dbPipelineBackup(opt) {
     tables ||= await db.getTables();
     console.log(`${yellow(tables.length)} ${boldWhite('table(s)')}:\n` + tables.join('\n'));
     const statsPerTable = {};
-    await pMap(tables, async (table) => {
+    await pMap(tables, async table => {
         let q = DBQuery.create(table).limit(limit);
         const sinceUpdated = opt.sinceUpdatedPerTable?.[table] ?? opt.sinceUpdated;
         if (sinceUpdated) {

package/dist/pipeline/dbPipelineCopy.js

@@ -19,7 +19,7 @@ export async function dbPipelineCopy(opt) {
     tables ||= await dbInput.getTables();
     console.log(`${yellow(tables.length)} ${boldWhite('table(s)')}:\n` + tables.join('\n'));
     const statsPerTable = {};
-    await pMap(tables, async (table) => {
+    await pMap(tables, async table => {
         let q = DBQuery.create(table).limit(limit);
         if (sinceUpdated) {
             q = q.filter('updated', '>=', sinceUpdated);
@@ -43,7 +43,7 @@ export async function dbPipelineCopy(opt) {
             .flattenIfNeeded()
             .tapSync(() => rows++)
             .chunk(chunkSize)
-            .forEach(async (dbms) => {
+            .forEach(async dbms => {
             await dbOutput.saveBatch(table, dbms, saveOptions);
         });
         const stats = NDJsonStats.create({

package/dist/pipeline/dbPipelineRestore.d.ts

@@ -1,6 +1,7 @@
 import { ErrorMode } from '@naturalcycles/js-lib/error/errorMode.js';
 import type { AsyncMapper, UnixTimestamp } from '@naturalcycles/js-lib/types';
-import { NDJsonStats, type TransformLogProgressOptions, type TransformMapOptions } from '@naturalcycles/nodejs-lib/stream';
+import { NDJsonStats } from '@naturalcycles/nodejs-lib/stream';
+import type { TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib/stream';
 import type { CommonDB } from '../commondb/common.db.js';
 import type { CommonDBSaveOptions } from '../db.model.js';
 export interface DBPipelineRestoreOptions extends TransformLogProgressOptions {

package/dist/pipeline/dbPipelineRestore.js

@@ -6,7 +6,7 @@ import { pMap } from '@naturalcycles/js-lib/promise/pMap.js';
 import { _passthroughMapper } from '@naturalcycles/js-lib/types';
 import { boldWhite, dimWhite, grey, yellow } from '@naturalcycles/nodejs-lib/colors';
 import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
-import { NDJsonStats, Pipeline, } from '@naturalcycles/nodejs-lib/stream';
+import { NDJsonStats, Pipeline } from '@naturalcycles/nodejs-lib/stream';
 /**
  * Pipeline from NDJSON files in a folder (optionally gzipped) to CommonDB.
  * Allows to define a mapper and a predicate to map/filter objects between input and output.
@@ -48,7 +48,7 @@ export async function dbPipelineRestore(opt) {
     console.log(`${yellow(tables.length)} ${boldWhite('table(s)')}:\n`, sizeStrByTable);
     // const schemaByTable: Record<string, CommonSchema> = {}
     if (recreateTables) {
-        await pMap(tables, async (table) => {
+        await pMap(tables, async table => {
             const schemaFilePath = `${inputDirPath}/${table}.schema.json`;
             if (!fs2.pathExists(schemaFilePath)) {
                 console.warn(`${schemaFilePath} does not exist!`);
@@ -58,7 +58,7 @@ export async function dbPipelineRestore(opt) {
             await db.createTable(table, schema, { dropIfExists: true });
         });
     }
-    await pMap(tables, async (table) => {
+    await pMap(tables, async table => {
         const zst = tablesToCompress.has(table);
         const filePath = `${inputDirPath}/${table}.ndjson` + (zst ? '.zst' : '');
         const saveOptions = saveOptionsPerTable[table] || {};
@@ -82,7 +82,7 @@ export async function dbPipelineRestore(opt) {
         })
             .flattenIfNeeded()
             .chunk(chunkSize)
-            .forEach(async (dbms) => {
+            .forEach(async dbms => {
             await db.saveBatch(table, dbms, saveOptions);
         });
         const stats = NDJsonStats.create({

package/dist/testing/commonDBTest.js

@@ -169,7 +169,7 @@ export async function runCommonDBTest(db, quirks = {}) {
         const tables = await db.getTables();
         // console.log({ tables })
         if (support.tableSchemas) {
-            await pMap(tables, async (table) => {
+            await pMap(tables, async table => {
                 const schema = await db.getTableSchema(table);
                 // console.log(schema)
                 expect(schema.$id).toBe(`${table}.schema.json`);
@@ -227,7 +227,7 @@ export async function runCommonDBTest(db, quirks = {}) {
             // save item3 with k1: k1_mod
             // delete item2
             // remaining: item1, item3_with_k1_mod
-            await db.runInTransaction(async (tx) => {
+            await db.runInTransaction(async tx => {
                 await tx.saveBatch(TEST_TABLE, items);
                 await tx.saveBatch(TEST_TABLE, [{ ...items[2], k1: 'k1_mod' }]);
                 await tx.deleteByIds(TEST_TABLE, [items[1].id]);
@@ -252,7 +252,7 @@ export async function runCommonDBTest(db, quirks = {}) {
             const expected = await prepare();
             let err;
             try {
-                await db.runInTransaction(async (tx) => {
+                await db.runInTransaction(async tx => {
                     await tx.deleteByIds(TEST_TABLE, [items[2].id]);
                     // It should fail on id == null
                     await tx.saveBatch(TEST_TABLE, [{ ...items[0], k1: 5, id: null }]);

package/dist/testing/commonDaoTest.js

@@ -243,7 +243,7 @@ export async function runCommonDaoTest(db, quirks = {}) {
             await dao.query().deleteByQuery();
             // Test that id, created, updated are created
             const now = localTime.nowUnix();
-            await dao.runInTransaction(async (tx) => {
+            await dao.runInTransaction(async tx => {
                 const row = _omit(item1, ['id', 'created', 'updated']);
                 await tx.save(dao, row);
             });
@@ -252,14 +252,14 @@ export async function runCommonDaoTest(db, quirks = {}) {
             expect(loaded[0].id).toBeDefined();
             expect(loaded[0].created).toBeGreaterThanOrEqual(now);
             expect(loaded[0].updated).toBe(loaded[0].created);
-            await dao.runInTransaction(async (tx) => {
+            await dao.runInTransaction(async tx => {
                 await tx.deleteById(dao, loaded[0].id);
             });
             // saveBatch [item1, 2, 3]
             // save item3 with k1: k1_mod
             // delete item2
             // remaining: item1, item3_with_k1_mod
-            await dao.runInTransaction(async (tx) => {
+            await dao.runInTransaction(async tx => {
                 await tx.saveBatch(dao, items);
                 await tx.save(dao, { ...items[2], k1: 'k1_mod' });
                 await tx.deleteById(dao, items[1].id);
@@ -304,7 +304,7 @@ export async function runCommonDaoTest(db, quirks = {}) {
             const expected = await prepare();
             let err;
             try {
-                await dao.runInTransaction(async (tx) => {
+                await dao.runInTransaction(async tx => {
                     await tx.deleteById(dao, items[2].id);
                     await tx.save(dao, { ...items[0], k1: 5 }); // it should fail here
                 });

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

@@ -1,5 +1,5 @@
 import type { BaseDBEntity } from '@naturalcycles/js-lib/types';
-import { type JsonSchemaObjectBuilder } from '@naturalcycles/nodejs-lib/ajv';
+import type { JsonSchemaObjectBuilder } from '@naturalcycles/nodejs-lib/ajv';
 export declare const TEST_TABLE = "TEST_TABLE";
 export declare const TEST_TABLE_2 = "TEST_TABLE_2";
 export interface TestItemBM extends BaseDBEntity {

package/dist/timeseries/commonTimeSeriesDao.js

@@ -40,7 +40,7 @@ export class CommonTimeSeriesDao {
     async commitTransaction(ops) {
         if (!ops.length)
             return;
-        await this.cfg.db.runInTransaction(async (tx) => {
+        await this.cfg.db.runInTransaction(async tx => {
             for (const op of ops) {
                 const rows = op.dataPoints.map(([ts, v]) => ({
                     id: String(ts), // Convert Number id into String id, as per CommonDB

package/dist/validation/index.d.ts

@@ -1,5 +1,3 @@
-import type { ObjectWithId } from '@naturalcycles/js-lib/types';
-import { type JsonSchemaObjectBuilder } from '@naturalcycles/nodejs-lib/ajv';
 import type { CommonDBOptions } from '../db.model.js';
 export declare const commonDBOptionsSchema: () => JsonSchemaObjectBuilder<CommonDBOptions, CommonDBOptions>;
 export declare const commonDBSaveOptionsSchema: <ROW extends ObjectWithId>() => any;

package/dist/validation/index.js

@@ -1,5 +1,5 @@
-import { j, JsonSchemaAnyBuilder, } from '@naturalcycles/nodejs-lib/ajv';
-import { dbQueryFilterOperatorValues, } from '../query/dbQuery.js';
+import { j, JsonSchemaAnyBuilder } from '@naturalcycles/nodejs-lib/ajv';
+import { dbQueryFilterOperatorValues } from '../query/dbQuery.js';
 // oxlint-disable typescript/explicit-function-return-type
 // DBTransaction schema - validates presence without deep validation
 const dbTransactionSchema = j.object.any().castAs();

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.42.0",
+  "version": "10.42.2",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"
   },
   "devDependencies": {
+    "@typescript/native-preview": "7.0.0-dev.20260201.1",
     "@naturalcycles/dev-lib": "18.4.2"
   },
   "files": [

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

@@ -3,11 +3,8 @@ import { _by, _sortBy } from '@naturalcycles/js-lib/array'
 import { _since, localTime } from '@naturalcycles/js-lib/datetime'
 import { _assert } from '@naturalcycles/js-lib/error/assert.js'
 import { _deepEquals, _filterUndefinedValues, _sortObjectDeep } from '@naturalcycles/js-lib/object'
-import {
-  _stringMapValues,
-  type ObjectWithId,
-  type UnixTimestampMillis,
-} from '@naturalcycles/js-lib/types'
+import { _stringMapValues } from '@naturalcycles/js-lib/types'
+import type { ObjectWithId, UnixTimestampMillis } from '@naturalcycles/js-lib/types'
 import type { JsonSchema } from '@naturalcycles/nodejs-lib/ajv'
 import { generateJsonSchemaFromData } from '@naturalcycles/nodejs-lib/ajv'
 import { dimGrey } from '@naturalcycles/nodejs-lib/colors'

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

@@ -207,14 +207,15 @@ export interface CommonDaoCfg<
   patchInTransaction?: boolean
 
   /**
-   * When specified, the listed properties will be compressed under a `data` property in the DBM.
-   * If DBM already has a `data` property and you don't add it to the list, an error will be thrown.
-   *
-   * When specified with an empty `keys` list, then compression will be skipped, but all previously compressed data
-   * will be decompressed, so the Dao can still work.
+   * When specified, the listed properties will be compressed into the `__compressed` property.
    *
    * Compression happens after the `beforeBMToDBM` hook and before the DBM is saved to the database.
    * Decompression happens after the DBM is loaded from the database and before the `beforeDBMToBM` hook.
+   *
+   * To migrate away from compression:
+   * 1. Remove this config (or set `keys` to empty array)
+   * 2. Add `beforeDBMToBM: CommonDao.decompressLegacyRow` to your hooks to decompress legacy data on read
+   * 3. Once all data has been naturally rewritten without compression, remove the hook
    */
   compress?: {
     keys: (keyof DBM)[]