@naturalcycles/mysql-lib 3.14.6 → 3.14.8

package/dist/mysql.db.d.ts

@@ -1,10 +1,10 @@
 import { DBPatch, BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, RunQueryResult, CommonDBSupport, CommonDBType } from '@naturalcycles/db-lib';
-import { AnyPartialObjectWithId, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, PartialObjectWithId, Saved } from '@naturalcycles/js-lib';
+import { CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
 export interface MysqlDBOptions extends CommonDBOptions {
 }
-export interface MysqlDBSaveOptions<ROW extends PartialObjectWithId = AnyPartialObjectWithId> extends CommonDBSaveOptions<ROW> {
+export interface MysqlDBSaveOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {
 }
 /**
  * @default false / undefined
@@ -42,22 +42,22 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
      * Be careful to manage this connection yourself (open, release, etc).
      */
     createSingleConnection(): Promise<Connection>;
-    getByIds<ROW extends PartialObjectWithId>(table: string, ids: string[], opt?: MysqlDBOptions): Promise<Saved<ROW>[]>;
-    runQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): Promise<RunQueryResult<Saved<ROW>>>;
+    getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: MysqlDBOptions): Promise<ROW[]>;
+    runQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): Promise<RunQueryResult<ROW>>;
     runSQL<RESULT>(q: QueryOptions): Promise<RESULT>;
     /**
      * Allows to run semicolon-separated "SQL file".
      * E.g "ddl reset script".
      */
     runSQLString(s: string): Promise<void>;
-    runQueryCount<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
-    streamQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): ReadableTyped<Saved<ROW>>;
-    saveBatch<ROW extends PartialObjectWithId>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
+    runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
+    streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): ReadableTyped<ROW>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
     /**
      * Limitation: always returns [], regardless of which rows are actually deleted
      */
     deleteByIds(table: string, ids: string[], _opt?: MysqlDBOptions): Promise<number>;
-    deleteByQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
+    deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
     /**
      * Use with caution!
      */
@@ -65,8 +65,8 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     /**
      * dropIfExists=true needed as a safety check
      */
-    createTable<ROW extends PartialObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
+    createTable<ROW extends ObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
     getTables(): Promise<string[]>;
-    getTableSchema<ROW extends PartialObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
-    updateByQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, patch: DBPatch<ROW>): Promise<number>;
+    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
+    updateByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, patch: DBPatch<ROW>): Promise<number>;
 }

package/dist/mysql.db.js

@@ -173,15 +173,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         if (this.cfg.logSQL)
             this.cfg.logger.log(`stream: ${sql}`);
         // return this.streamSQL(sql, opt)
-        return this.pool()
-            .query(sql)
-            .stream()
-            .pipe(new node_stream_1.Transform({
-            objectMode: true,
-            transform(row, _encoding, cb) {
-                cb(null, (0, js_lib_1._filterUndefinedValues)(row, true));
-            },
-        }));
+        return this.pool().query(sql).stream().map(row => (0, js_lib_1._filterUndefinedValues)(row, true));
     }
     // SAVE
     async saveBatch(table, rowsInput, opt = {}) {

package/dist/mysqlKeyValueDB.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MySQLKeyValueDB = void 0;
-const node_stream_1 = require("node:stream");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const mysql_db_1 = require("./mysql.db");
 class MySQLKeyValueDB {
@@ -63,16 +62,7 @@ class MySQLKeyValueDB {
             sql += ` LIMIT ${limit}`;
         if (this.cfg.logSQL)
             this.db.cfg.logger.log(`stream: ${sql}`);
-        return this.db
-            .pool()
-            .query(sql)
-            .stream()
-            .pipe(new node_stream_1.Transform({
-            objectMode: true,
-            transform(row, _, cb) {
-                cb(null, row.id);
-            },
-        }));
+        return this.db.pool().query(sql).stream().map(row => row.id);
     }
     streamValues(table, limit) {
         let sql = `SELECT v FROM ${table}`;
@@ -80,16 +70,7 @@ class MySQLKeyValueDB {
             sql += ` LIMIT ${limit}`;
         if (this.cfg.logSQL)
             this.db.cfg.logger.log(`stream: ${sql}`);
-        return this.db
-            .pool()
-            .query(sql)
-            .stream()
-            .pipe(new node_stream_1.Transform({
-            objectMode: true,
-            transform(row, _, cb) {
-                cb(null, row.v);
-            },
-        }));
+        return this.db.pool().query(sql).stream().map(row => row.v);
     }
     streamEntries(table, limit) {
         let sql = `SELECT id,v FROM ${table}`;
@@ -97,16 +78,10 @@ class MySQLKeyValueDB {
             sql += ` LIMIT ${limit}`;
         if (this.cfg.logSQL)
             this.db.cfg.logger.log(`stream: ${sql}`);
-        return this.db
-            .pool()
-            .query(sql)
-            .stream()
-            .pipe(new node_stream_1.Transform({
-            objectMode: true,
-            transform(row, _, cb) {
-                cb(null, [row.id, row.v]);
-            },
-        }));
+        return this.db.pool().query(sql).stream().map(row => [
+            row.id,
+            row.v,
+        ]);
     }
     async beginTransaction() {
         await this.db.runSQL({ sql: `BEGIN TRANSACTION` });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/mysql-lib",
   "scripts": {
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "dependencies": {
     "@naturalcycles/db-lib": "^9.1.0",
@@ -34,9 +34,9 @@
     "url": "https://github.com/NaturalCycles/mysql-lib"
   },
   "engines": {
-    "node": ">=16.15.0"
+    "node": ">=18.12.0"
   },
-  "version": "3.14.6",
+  "version": "3.14.8",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/mysql.db.ts

@@ -1,4 +1,4 @@
-import { Readable, Transform } from 'node:stream'
+import { Readable } from 'node:stream'
 import { promisify } from 'node:util'
 import {
   DBPatch,
@@ -20,13 +20,11 @@ import {
   _mapValues,
   _Memo,
   _omit,
-  AnyPartialObjectWithId,
   CommonLogger,
   commonLoggerPrefix,
   JsonSchemaObject,
   JsonSchemaRootObject,
-  PartialObjectWithId,
-  Saved,
+  ObjectWithId,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped, white } from '@naturalcycles/nodejs-lib'
 import {
@@ -48,8 +46,7 @@ import {
 } from './schema/mysql.schema.util'
 
 export interface MysqlDBOptions extends CommonDBOptions {}
-export interface MysqlDBSaveOptions<ROW extends PartialObjectWithId = AnyPartialObjectWithId>
-  extends CommonDBSaveOptions<ROW> {}
+export interface MysqlDBSaveOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {}
 
 /**
  * @default false / undefined
@@ -196,11 +193,11 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // GET
-  override async getByIds<ROW extends PartialObjectWithId>(
+  override async getByIds<ROW extends ObjectWithId>(
     table: string,
     ids: string[],
     opt: MysqlDBOptions = {},
-  ): Promise<Saved<ROW>[]> {
+  ): Promise<ROW[]> {
     if (!ids.length) return []
     const q = new DBQuery<ROW>(table).filterEq('id', ids)
     const { rows } = await this.runQuery(q, opt)
@@ -208,10 +205,10 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // QUERY
-  override async runQuery<ROW extends PartialObjectWithId>(
+  override async runQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt: MysqlDBOptions = {},
-  ): Promise<RunQueryResult<Saved<ROW>>> {
+  ): Promise<RunQueryResult<ROW>> {
     const sql = dbQueryToSQLSelect(q)
     if (!sql) {
       return {
@@ -261,7 +258,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     }
   }
 
-  override async runQueryCount<ROW extends PartialObjectWithId>(
+  override async runQueryCount<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
@@ -269,10 +266,10 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return (rows[0] as any)._count
   }
 
-  override streamQuery<ROW extends PartialObjectWithId>(
+  override streamQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt: MysqlDBOptions = {},
-  ): ReadableTyped<Saved<ROW>> {
+  ): ReadableTyped<ROW> {
     const sql = dbQueryToSQLSelect(q)
     if (!sql) {
       return Readable.from([])
@@ -281,21 +278,13 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     if (this.cfg.logSQL) this.cfg.logger.log(`stream: ${sql}`)
 
     // return this.streamSQL(sql, opt)
-    return this.pool()
-      .query(sql)
-      .stream()
-      .pipe(
-        new Transform({
-          objectMode: true,
-          transform(row, _encoding, cb) {
-            cb(null, _filterUndefinedValues(row, true))
-          },
-        }),
-      )
+    return (this.pool().query(sql).stream() as ReadableTyped<ROW>).map(row =>
+      _filterUndefinedValues(row, true),
+    )
   }
 
   // SAVE
-  override async saveBatch<ROW extends PartialObjectWithId>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rowsInput: ROW[],
     opt: MysqlDBSaveOptions<ROW> = {},
@@ -373,7 +362,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return affectedRows
   }
 
-  override async deleteByQuery<ROW extends PartialObjectWithId>(
+  override async deleteByQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
@@ -393,7 +382,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   /**
    * dropIfExists=true needed as a safety check
    */
-  override async createTable<ROW extends PartialObjectWithId>(
+  override async createTable<ROW extends ObjectWithId>(
     table: string,
     schema: JsonSchemaObject<ROW>,
     opt: CommonDBCreateOptions = {},
@@ -410,7 +399,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
       .filter(Boolean)
   }
 
-  override async getTableSchema<ROW extends PartialObjectWithId>(
+  override async getTableSchema<ROW extends ObjectWithId>(
     table: string,
   ): Promise<JsonSchemaRootObject<ROW>> {
     const stats = await this.runSQL<MySQLTableStats[]>({
@@ -420,7 +409,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return mysqlTableStatsToJsonSchemaField<ROW>(table, stats, this.cfg.logger)
   }
 
-  override async updateByQuery<ROW extends PartialObjectWithId>(
+  override async updateByQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     patch: DBPatch<ROW>,
   ): Promise<number> {

package/src/mysqlKeyValueDB.ts

@@ -1,6 +1,5 @@
-import { Transform } from 'node:stream'
 import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib'
-import { pMap } from '@naturalcycles/js-lib'
+import { ObjectWithId, pMap } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { QueryOptions } from 'mysql'
 import { MysqlDB, MysqlDBCfg } from './mysql.db'
@@ -78,18 +77,7 @@ export class MySQLKeyValueDB implements CommonKeyValueDB {
     if (limit) sql += ` LIMIT ${limit}`
     if (this.cfg.logSQL) this.db.cfg.logger.log(`stream: ${sql}`)
 
-    return this.db
-      .pool()
-      .query(sql)
-      .stream()
-      .pipe(
-        new Transform({
-          objectMode: true,
-          transform(row, _, cb) {
-            cb(null, row.id)
-          },
-        }),
-      )
+    return (this.db.pool().query(sql).stream() as ReadableTyped<ObjectWithId>).map(row => row.id)
   }
 
   streamValues(table: string, limit?: number): ReadableTyped<Buffer> {
@@ -97,18 +85,7 @@ export class MySQLKeyValueDB implements CommonKeyValueDB {
     if (limit) sql += ` LIMIT ${limit}`
     if (this.cfg.logSQL) this.db.cfg.logger.log(`stream: ${sql}`)
 
-    return this.db
-      .pool()
-      .query(sql)
-      .stream()
-      .pipe(
-        new Transform({
-          objectMode: true,
-          transform(row, _, cb) {
-            cb(null, row.v)
-          },
-        }),
-      )
+    return (this.db.pool().query(sql).stream() as ReadableTyped<{ v: Buffer }>).map(row => row.v)
   }
 
   streamEntries(table: string, limit?: number): ReadableTyped<KeyValueDBTuple> {
@@ -116,18 +93,10 @@ export class MySQLKeyValueDB implements CommonKeyValueDB {
     if (limit) sql += ` LIMIT ${limit}`
     if (this.cfg.logSQL) this.db.cfg.logger.log(`stream: ${sql}`)
 
-    return this.db
-      .pool()
-      .query(sql)
-      .stream()
-      .pipe(
-        new Transform({
-          objectMode: true,
-          transform(row, _, cb) {
-            cb(null, [row.id, row.v])
-          },
-        }),
-      )
+    return (this.db.pool().query(sql).stream() as ReadableTyped<KeyValueObject>).map(row => [
+      row.id,
+      row.v,
+    ])
   }
 
   async beginTransaction(): Promise<void> {

package/src/query.util.ts

@@ -1,5 +1,5 @@
 import { DBQuery, DBQueryFilterOperator } from '@naturalcycles/db-lib'
-import { _hb, CommonLogger } from '@naturalcycles/js-lib'
+import { _hb, AnyObjectWithId, CommonLogger } from '@naturalcycles/js-lib'
 import { white, yellow } from '@naturalcycles/nodejs-lib'
 import { QueryOptions } from 'mysql'
 import * as mysql from 'mysql'
@@ -160,7 +160,7 @@ export function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): s
   return mysql.format(tokens.join(' '), Object.values(record))
 }
 
-function selectTokens(q: DBQuery): string[] {
+function selectTokens(q: DBQuery<any>): string[] {
   let fields = ['*']
 
   if (q._selectedFieldNames) {
@@ -192,7 +192,7 @@ function offsetLimitTokens(q: DBQuery<any>): string[] {
   return tokens
 }
 
-function groupOrderTokens(q: DBQuery): string[] {
+function groupOrderTokens(q: DBQuery<AnyObjectWithId>): string[] {
   const t: string[] = []
 
   if (q._groupByFieldNames?.length) {
@@ -216,7 +216,7 @@ const OP_MAP: Partial<Record<DBQueryFilterOperator, string>> = {
 /**
  * Returns `null` for "guaranteed 0 rows" cases.
  */
-function getWhereTokens(q: DBQuery): string[] | null {
+function getWhereTokens(q: DBQuery<any>): string[] | null {
   if (!q._filters.length) return []
 
   let returnNull = false