@naturalcycles/db-lib 10.43.0 → 10.44.0

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

@@ -201,7 +201,7 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
      *   return dbm
      * }
      */
-    static decompressLegacyRow<T extends ObjectWithId>(row: T): Promise<T>;
+    static decompressLegacyRow<T extends ObjectWithId>(this: void, row: T): Promise<T>;
     /**
      * Temporary helper to migrate from the old `data` compressed property to the new `__compressed` property.
      * Use as your `beforeDBMToBM` hook during the migration period.

package/dist/commondao/common.dao.js

@@ -89,7 +89,7 @@ export class CommonDao {
         if (!id)
             return null;
         const [row] = await this.loadByIds([id], opt);
-        return await (this.anyToDBM(row, opt) || null);
+        return await this.anyToDBM(row, opt);
     }
     async getByIds(ids, opt = {}) {
         const dbms = await this.loadByIds(ids, opt);

package/dist/kv/commonSyncKeyValueDB.d.ts

@@ -0,0 +1,56 @@
+import type { Pipeline } from '@naturalcycles/nodejs-lib/stream';
+import type { CommonDBCreateOptions } from '../db.model.js';
+import type { CommonKeyValueDBSaveBatchOptions, CommonKeyValueDBSupport, IncrementTuple, KeyValueDBTuple } from './commonKeyValueDB.js';
+/**
+ * Common interface for Synchronous Key-Value database implementations.
+ * Same as CommonKeyValueDB, but with a sync implementation,
+ * modeled after e.g SQLite in Node.js, which is designed to be sync.
+ *
+ * Methods use `Sync` postfix to allow one implementation to support
+ * both async and sync CommonKeyValueDB interfaces.
+ *
+ * @experimental
+ */
+export interface CommonSyncKeyValueDB {
+    /**
+     * Manifest of supported features.
+     */
+    support: CommonKeyValueDBSupport;
+    /**
+     * Check that DB connection is working properly.
+     */
+    pingSync: () => void;
+    /**
+     * Will do like `create table ...` for mysql.
+     * Caution! dropIfExists defaults to false. If set to true - will actually DROP the table!
+     */
+    createTableSync: (table: string, opt?: CommonDBCreateOptions) => void;
+    /**
+     * Returns an array of tuples [key, value]. Not found values are not returned (no error is thrown).
+     *
+     * Currently it is NOT required to maintain the same order as input `ids`.
+     */
+    getByIdsSync: (table: string, ids: string[]) => KeyValueDBTuple[];
+    deleteByIdsSync: (table: string, ids: string[]) => void;
+    saveBatchSync: (table: string, entries: KeyValueDBTuple[], opt?: CommonKeyValueDBSaveBatchOptions) => void;
+    streamIds: (table: string, limit?: number) => Pipeline<string>;
+    streamValues: (table: string, limit?: number) => Pipeline<Buffer>;
+    streamEntries: (table: string, limit?: number) => Pipeline<KeyValueDBTuple>;
+    countSync: (table: string) => number;
+    /**
+     * Perform a batch of Increment operations.
+     * Given entries array, increment each key of it (1st index of the tuple) by the given amount (2nd index of the tuple).
+     *
+     * Example:
+     * [
+     *   ['key1', 2],
+     *   ['key2', 3],
+     * ]
+     * would increment `key1` by 2, and `key2` by 3.
+     *
+     * Returns the entries array with tuples of the same structure, with updated numbers.
+     *
+     * @experimental
+     */
+    incrementBatchSync: (table: string, entries: IncrementTuple[]) => IncrementTuple[];
+}

package/dist/kv/commonSyncKeyValueDB.js

@@ -0,0 +1 @@
+export {};

package/dist/kv/index.d.ts

@@ -1,3 +1,4 @@
 export * from './commonKeyValueDao.js';
 export * from './commonKeyValueDaoMemoCache.js';
 export * from './commonKeyValueDB.js';
+export * from './commonSyncKeyValueDB.js';

package/dist/kv/index.js

@@ -1,3 +1,4 @@
 export * from './commonKeyValueDao.js';
 export * from './commonKeyValueDaoMemoCache.js';
 export * from './commonKeyValueDB.js';
+export * from './commonSyncKeyValueDB.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.43.0",
+  "version": "10.44.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"

package/src/commondao/common.dao.ts

@@ -137,7 +137,7 @@ export class CommonDao<
   async getByIdAsDBM(id?: ID | null, opt: CommonDaoReadOptions = {}): Promise<DBM | null> {
     if (!id) return null
     const [row] = await this.loadByIds([id], opt)
-    return await (this.anyToDBM(row, opt) || null)
+    return await this.anyToDBM(row, opt)
   }
 
   async getByIds(ids: ID[], opt: CommonDaoReadOptions = {}): Promise<BM[]> {
@@ -989,7 +989,7 @@ export class CommonDao<
    *   return dbm
    * }
    */
-  static async decompressLegacyRow<T extends ObjectWithId>(row: T): Promise<T> {
+  static async decompressLegacyRow<T extends ObjectWithId>(this: void, row: T): Promise<T> {
     // Check both __compressed (current) and data (legacy) for backward compatibility
     const compressed = (row as any).__compressed ?? (row as any).data
     if (!Buffer.isBuffer(compressed)) return row

package/src/kv/commonSyncKeyValueDB.ts

@@ -0,0 +1,74 @@
+import type { Pipeline } from '@naturalcycles/nodejs-lib/stream'
+import type { CommonDBCreateOptions } from '../db.model.js'
+import type {
+  CommonKeyValueDBSaveBatchOptions,
+  CommonKeyValueDBSupport,
+  IncrementTuple,
+  KeyValueDBTuple,
+} from './commonKeyValueDB.js'
+
+/**
+ * Common interface for Synchronous Key-Value database implementations.
+ * Same as CommonKeyValueDB, but with a sync implementation,
+ * modeled after e.g SQLite in Node.js, which is designed to be sync.
+ *
+ * Methods use `Sync` postfix to allow one implementation to support
+ * both async and sync CommonKeyValueDB interfaces.
+ *
+ * @experimental
+ */
+export interface CommonSyncKeyValueDB {
+  /**
+   * Manifest of supported features.
+   */
+  support: CommonKeyValueDBSupport
+
+  /**
+   * Check that DB connection is working properly.
+   */
+  pingSync: () => void
+
+  /**
+   * Will do like `create table ...` for mysql.
+   * Caution! dropIfExists defaults to false. If set to true - will actually DROP the table!
+   */
+  createTableSync: (table: string, opt?: CommonDBCreateOptions) => void
+
+  /**
+   * Returns an array of tuples [key, value]. Not found values are not returned (no error is thrown).
+   *
+   * Currently it is NOT required to maintain the same order as input `ids`.
+   */
+  getByIdsSync: (table: string, ids: string[]) => KeyValueDBTuple[]
+
+  deleteByIdsSync: (table: string, ids: string[]) => void
+
+  saveBatchSync: (
+    table: string,
+    entries: KeyValueDBTuple[],
+    opt?: CommonKeyValueDBSaveBatchOptions,
+  ) => void
+
+  streamIds: (table: string, limit?: number) => Pipeline<string>
+  streamValues: (table: string, limit?: number) => Pipeline<Buffer>
+  streamEntries: (table: string, limit?: number) => Pipeline<KeyValueDBTuple>
+
+  countSync: (table: string) => number
+
+  /**
+   * Perform a batch of Increment operations.
+   * Given entries array, increment each key of it (1st index of the tuple) by the given amount (2nd index of the tuple).
+   *
+   * Example:
+   * [
+   *   ['key1', 2],
+   *   ['key2', 3],
+   * ]
+   * would increment `key1` by 2, and `key2` by 3.
+   *
+   * Returns the entries array with tuples of the same structure, with updated numbers.
+   *
+   * @experimental
+   */
+  incrementBatchSync: (table: string, entries: IncrementTuple[]) => IncrementTuple[]
+}

package/src/kv/index.ts

@@ -1,3 +1,4 @@
 export * from './commonKeyValueDao.js'
 export * from './commonKeyValueDaoMemoCache.js'
 export * from './commonKeyValueDB.js'
+export * from './commonSyncKeyValueDB.js'