@naturalcycles/mysql-lib 3.16.2 → 4.0.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from './mysql.db';
-export * from './mysqlKeyValueDB';
-export { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util';
+export * from './mysql.db.js';
+export * from './mysqlKeyValueDB.js';
+export { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util.js';

package/dist/index.js

@@ -1,8 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonSchemaToMySQLDDL = void 0;
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./mysql.db"), exports);
-tslib_1.__exportStar(require("./mysqlKeyValueDB"), exports);
-var mysql_schema_util_1 = require("./schema/mysql.schema.util");
-Object.defineProperty(exports, "jsonSchemaToMySQLDDL", { enumerable: true, get: function () { return mysql_schema_util_1.jsonSchemaToMySQLDDL; } });
+export * from './mysql.db.js';
+export * from './mysqlKeyValueDB.js';
+export { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util.js';

package/dist/mysql.db.d.ts

@@ -1,7 +1,8 @@
-import { BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBSupport, CommonDBType, DBQuery, RunQueryResult } from '@naturalcycles/db-lib';
-import { CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
-import { ReadableTyped } from '@naturalcycles/nodejs-lib';
-import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
+import type { CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBSupport, RunQueryResult } from '@naturalcycles/db-lib';
+import { BaseCommonDB, CommonDBType, DBQuery } from '@naturalcycles/db-lib';
+import type { CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib';
+import type { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
 export interface MysqlDBOptions extends CommonDBOptions {
 }
 export interface MysqlDBSaveOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {

package/dist/mysql.db.js

@@ -1,15 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MysqlDB = void 0;
-const tslib_1 = require("tslib");
-const node_stream_1 = require("node:stream");
-const node_util_1 = require("node:util");
-const db_lib_1 = require("@naturalcycles/db-lib");
-const js_lib_1 = require("@naturalcycles/js-lib");
-const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const mysql = tslib_1.__importStar(require("mysql"));
-const query_util_1 = require("./query.util");
-const mysql_schema_util_1 = require("./schema/mysql.schema.util");
+import { __decorate } from "tslib";
+import { Readable, Transform } from 'node:stream';
+import { promisify } from 'node:util';
+import { BaseCommonDB, commonDBFullSupport, CommonDBType, DBQuery } from '@naturalcycles/db-lib';
+import { _assert, _filterUndefinedValues, _mapKeys, _mapValues, _Memo, _omit, commonLoggerPrefix, } from '@naturalcycles/js-lib';
+import { white } from '@naturalcycles/nodejs-lib';
+import * as mysql from 'mysql';
+import { dbQueryToSQLDelete, dbQueryToSQLSelect, dbQueryToSQLUpdate, insertSQL, } from './query.util.js';
+import { jsonSchemaToMySQLDDL, mapNameFromMySQL, mysqlTableStatsToJsonSchemaField, } from './schema/mysql.schema.util.js';
 const BOOLEAN_TYPES = new Set(['TINY', 'TINYINT', 'INT']);
 const BOOLEAN_BIT_TYPES = new Set(['BIT']);
 const typeCast = (field, next) => {
@@ -31,16 +28,16 @@ const typeCast = (field, next) => {
     }
     return next();
 };
-class MysqlDB extends db_lib_1.BaseCommonDB {
+export class MysqlDB extends BaseCommonDB {
+    dbType = CommonDBType.relational;
+    support = {
+        ...commonDBFullSupport,
+        updateSaveMethod: false, // todo: can be implemented
+        transactions: false, // todo: can be implemented
+        increment: false, // todo: can be implemented
+    };
     constructor(cfg = {}) {
         super();
-        this.dbType = db_lib_1.CommonDBType.relational;
-        this.support = {
-            ...db_lib_1.commonDBFullSupport,
-            updateSaveMethod: false, // todo: can be implemented
-            transactions: false, // todo: can be implemented
-            increment: false, // todo: can be implemented
-        };
         this.cfg = {
             typeCast,
             // charset: 'utf8mb4', // for emoji support
@@ -49,9 +46,10 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             // password: MYSQL_PW,
             // database: MYSQL_DB,
             ...cfg,
-            logger: (0, js_lib_1.commonLoggerPrefix)(cfg.logger || console, '[mysql]'),
+            logger: commonLoggerPrefix(cfg.logger || console, '[mysql]'),
         };
     }
+    cfg;
     async ping() {
         const con = await this.getConnection();
         con.release();
@@ -59,7 +57,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     pool() {
         const pool = mysql.createPool(this.cfg);
         const { host, database, logger } = this.cfg;
-        logger.log(`connected to ${(0, nodejs_lib_1.white)(host + '/' + database)}`);
+        logger.log(`connected to ${white(host + '/' + database)}`);
         if (this.cfg.debugConnections) {
             pool.on('acquire', con => {
                 logger.log(`acquire(${con.threadId})`);
@@ -81,7 +79,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     }
     async close() {
         const pool = this.pool();
-        await (0, node_util_1.promisify)(pool.end.bind(pool))();
+        await promisify(pool.end.bind(pool))();
         this.cfg.logger.log('closed');
     }
     /**
@@ -89,7 +87,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
      */
     async getConnection() {
         const pool = this.pool();
-        return await (0, node_util_1.promisify)(pool.getConnection.bind(pool))();
+        return await promisify(pool.getConnection.bind(pool))();
     }
     /**
      * Manually create a single (not pool) connection.
@@ -97,7 +95,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
      */
     async createSingleConnection() {
         const con = mysql.createConnection(this.cfg);
-        await (0, node_util_1.promisify)(con.connect.bind(con))();
+        await promisify(con.connect.bind(con))();
         const { threadId } = con;
         if (this.cfg.debugConnections) {
             this.cfg.logger.log(`createSingleConnection(${threadId})`);
@@ -115,19 +113,19 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     async getByIds(table, ids, opt = {}) {
         if (!ids.length)
             return [];
-        const q = new db_lib_1.DBQuery(table).filterEq('id', ids);
+        const q = new DBQuery(table).filterEq('id', ids);
         const { rows } = await this.runQuery(q, opt);
-        return rows.map(r => (0, js_lib_1._mapKeys)(r, k => (0, mysql_schema_util_1.mapNameFromMySQL)(k)));
+        return rows.map(r => _mapKeys(r, k => mapNameFromMySQL(k)));
     }
     // QUERY
     async runQuery(q, _opt = {}) {
-        const sql = (0, query_util_1.dbQueryToSQLSelect)(q);
+        const sql = dbQueryToSQLSelect(q);
         if (!sql) {
             return {
                 rows: [],
             };
         }
-        const rows = (await this.runSQL({ sql })).map(row => (0, js_lib_1._mapKeys)((0, js_lib_1._filterUndefinedValues)(row, true), k => (0, mysql_schema_util_1.mapNameFromMySQL)(k)));
+        const rows = (await this.runSQL({ sql })).map(row => _mapKeys(_filterUndefinedValues(row, true), k => mapNameFromMySQL(k)));
         // edge case where 0 fields are selected
         if (q._selectedFieldNames?.length === 0) {
             return {
@@ -167,24 +165,35 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         return rows[0]._count;
     }
     streamQuery(q, _opt = {}) {
-        const sql = (0, query_util_1.dbQueryToSQLSelect)(q);
+        const sql = dbQueryToSQLSelect(q);
         if (!sql) {
-            return node_stream_1.Readable.from([]);
+            return Readable.from([]);
         }
         if (this.cfg.logSQL)
             this.cfg.logger.log(`stream: ${sql}`);
-        // return this.streamSQL(sql, opt)
-        return this.pool().query(sql).stream().map(row => (0, js_lib_1._filterUndefinedValues)(row, true));
+        // todo: this is nice, but `mysql` package uses `readable-stream@2` which is not compatible with `node:stream` iterable helpers
+        // return (this.pool().query(sql).stream() as ReadableTyped<ROW>).map(row =>
+        //   _filterUndefinedValues(row, true),
+        // )
+        return this.pool()
+            .query(sql)
+            .stream()
+            .pipe(new Transform({
+            objectMode: true,
+            transform(row, _encoding, cb) {
+                cb(null, _filterUndefinedValues(row, true));
+            },
+        }));
     }
     // SAVE
     async saveBatch(table, rowsInput, opt = {}) {
         if (!rowsInput.length)
             return;
         // Stringify object values
-        const rows = rowsInput.map(row => (0, js_lib_1._mapValues)(row, (_k, v) => {
+        const rows = rowsInput.map(row => _mapValues(row, (_k, v) => {
             if (v && typeof v === 'object' && !Buffer.isBuffer(v)) {
                 // This is to avoid implicit Date stringification and mismatch: it gets saved as Date, but loaded as String
-                (0, js_lib_1._assert)(!(v instanceof Date), 'mysql-lib does not support Date values, please stringify them before passing');
+                _assert(!(v instanceof Date), 'mysql-lib does not support Date values, please stringify them before passing');
                 return JSON.stringify(v);
             }
             return v;
@@ -196,12 +205,12 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
                 i++;
                 if (row.id) {
                     // Update already existing
-                    const query = new db_lib_1.DBQuery(table).filterEq('id', row.id);
-                    await this.patchByQuery(query, (0, js_lib_1._omit)(row, ['id']));
+                    const query = new DBQuery(table).filterEq('id', row.id);
+                    await this.patchByQuery(query, _omit(row, ['id']));
                 }
                 else {
                     // Create new
-                    const sql = (0, query_util_1.insertSQL)(table, [row], 'INSERT', this.cfg.logger)[0];
+                    const sql = insertSQL(table, [row], 'INSERT', this.cfg.logger)[0];
                     const { insertId } = await this.runSQL({ sql });
                     // Mutate the input row with insertIt
                     rowsInput[i].id = insertId; // this is because we no longer support number ids in CommonDB
@@ -213,15 +222,15 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             // TODO: This fails if a combination of entities with id and without id are parsed
             for (const row of rows) {
                 // Update already existing
-                (0, js_lib_1._assert)(row.id, 'id is required for updating');
-                const query = new db_lib_1.DBQuery(table).filterEq('id', row.id);
-                await this.patchByQuery(query, (0, js_lib_1._omit)(row, ['id']));
+                _assert(row.id, 'id is required for updating');
+                const query = new DBQuery(table).filterEq('id', row.id);
+                await this.patchByQuery(query, _omit(row, ['id']));
             }
             return;
         }
         const verb = opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE';
         // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-        const sqls = (0, query_util_1.insertSQL)(table, rows, verb, this.cfg.logger);
+        const sqls = insertSQL(table, rows, verb, this.cfg.logger);
         for (const sql of sqls) {
             await this.runSQL({ sql });
         }
@@ -233,14 +242,14 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     async deleteByIds(table, ids, _opt) {
         if (!ids.length)
             return 0;
-        const sql = (0, query_util_1.dbQueryToSQLDelete)(new db_lib_1.DBQuery(table).filterEq('id', ids));
+        const sql = dbQueryToSQLDelete(new DBQuery(table).filterEq('id', ids));
         if (!sql)
             return 0;
         const { affectedRows } = await this.runSQL({ sql });
         return affectedRows;
     }
     async deleteByQuery(q, _opt) {
-        const sql = (0, query_util_1.dbQueryToSQLDelete)(q);
+        const sql = dbQueryToSQLDelete(q);
         if (!sql)
             return 0;
         const { affectedRows } = await this.runSQL({ sql });
@@ -258,7 +267,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     async createTable(table, schema, opt = {}) {
         if (opt.dropIfExists)
             await this.dropTable(table);
-        const sql = (0, mysql_schema_util_1.jsonSchemaToMySQLDDL)(table, schema);
+        const sql = jsonSchemaToMySQLDDL(table, schema);
         await this.runSQL({ sql });
     }
     async getTables() {
@@ -270,17 +279,16 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         const stats = await this.runSQL({
             sql: `describe ${mysql.escapeId(table)}`,
         });
-        return (0, mysql_schema_util_1.mysqlTableStatsToJsonSchemaField)(table, stats, this.cfg.logger);
+        return mysqlTableStatsToJsonSchemaField(table, stats, this.cfg.logger);
     }
     async patchByQuery(q, patch) {
-        const sql = (0, query_util_1.dbQueryToSQLUpdate)(q, patch);
+        const sql = dbQueryToSQLUpdate(q, patch);
         if (!sql)
             return 0;
         const { affectedRows } = await this.runSQL({ sql });
         return affectedRows;
     }
 }
-exports.MysqlDB = MysqlDB;
-tslib_1.__decorate([
-    (0, js_lib_1._Memo)()
+__decorate([
+    _Memo()
 ], MysqlDB.prototype, "pool", null);

package/dist/mysqlKeyValueDB.d.ts

@@ -1,7 +1,8 @@
-import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib';
-import { IncrementTuple } from '@naturalcycles/db-lib/dist/kv/commonKeyValueDB';
-import { ReadableTyped } from '@naturalcycles/nodejs-lib';
-import { MysqlDB, MysqlDBCfg } from './mysql.db';
+import type { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib';
+import type { IncrementTuple } from '@naturalcycles/db-lib/dist/kv/commonKeyValueDB.js';
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib';
+import type { MysqlDBCfg } from './mysql.db.js';
+import { MysqlDB } from './mysql.db.js';
 export declare class MySQLKeyValueDB implements CommonKeyValueDB {
     cfg: MysqlDBCfg;
     constructor(cfg: MysqlDBCfg);

package/dist/mysqlKeyValueDB.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MySQLKeyValueDB = void 0;
-const db_lib_1 = require("@naturalcycles/db-lib");
-const js_lib_1 = require("@naturalcycles/js-lib");
-const mysql_db_1 = require("./mysql.db");
-class MySQLKeyValueDB {
+import { Transform } from 'node:stream';
+import { commonKeyValueDBFullSupport } from '@naturalcycles/db-lib';
+import { AppError, pMap } from '@naturalcycles/js-lib';
+import { MysqlDB } from './mysql.db.js';
+export class MySQLKeyValueDB {
+    cfg;
     constructor(cfg) {
         this.cfg = cfg;
-        this.support = {
-            ...db_lib_1.commonKeyValueDBFullSupport,
-            increment: false,
-        };
-        this.db = new mysql_db_1.MysqlDB(this.cfg);
+        this.db = new MysqlDB(this.cfg);
     }
+    db;
+    support = {
+        ...commonKeyValueDBFullSupport,
+        increment: false,
+    };
     async ping() {
         await this.db.ping();
     }
@@ -55,7 +55,7 @@ class MySQLKeyValueDB {
                 values: [id, buf],
             };
         });
-        await (0, js_lib_1.pMap)(statements, async (statement) => {
+        await pMap(statements, async (statement) => {
             if (this.cfg.debug)
                 this.db.cfg.logger.log(statement.sql);
             await this.db.runSQL(statement);
@@ -67,7 +67,18 @@ class MySQLKeyValueDB {
             sql += ` LIMIT ${limit}`;
         if (this.cfg.logSQL)
             this.db.cfg.logger.log(`stream: ${sql}`);
-        return this.db.pool().query(sql).stream().map(row => row.id);
+        // todo: this is nice, but `mysql` package uses `readable-stream@2` which is not compatible with `node:stream` iterable helpers
+        // return (this.db.pool().query(sql).stream() as ReadableTyped<ObjectWithId>).map(row => row.id)
+        return this.db
+            .pool()
+            .query(sql)
+            .stream()
+            .pipe(new Transform({
+            objectMode: true,
+            transform(row, _encoding, cb) {
+                cb(null, row.id);
+            },
+        }));
     }
     streamValues(table, limit) {
         let sql = `SELECT v FROM ${table}`;
@@ -102,7 +113,6 @@ class MySQLKeyValueDB {
         return rows[0].cnt;
     }
     async incrementBatch(_table, _entries) {
-        throw new js_lib_1.AppError('MySQLKeyValueDB.incrementBatch() is not implemented');
+        throw new AppError('MySQLKeyValueDB.incrementBatch() is not implemented');
     }
 }
-exports.MySQLKeyValueDB = MySQLKeyValueDB;

package/dist/query.util.d.ts

@@ -1,6 +1,6 @@
-import { DBQuery } from '@naturalcycles/db-lib';
-import { CommonLogger } from '@naturalcycles/js-lib';
-import { QueryOptions } from 'mysql';
+import type { DBQuery } from '@naturalcycles/db-lib';
+import type { CommonLogger } from '@naturalcycles/js-lib';
+import type { QueryOptions } from 'mysql';
 /**
  * Returns `null` if it detects that 0 rows will be returned,
  * e.g when `IN ()` (empty array) is used.

package/dist/query.util.js

@@ -1,23 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dbQueryToSQLSelect = dbQueryToSQLSelect;
-exports.dbQueryToSQLDelete = dbQueryToSQLDelete;
-exports.insertSQL = insertSQL;
-exports.insertSQLSingle = insertSQLSingle;
-exports.insertSQLSetSingle = insertSQLSetSingle;
-exports.dbQueryToSQLUpdate = dbQueryToSQLUpdate;
-const tslib_1 = require("tslib");
-const js_lib_1 = require("@naturalcycles/js-lib");
-const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const mysql = tslib_1.__importStar(require("mysql"));
-const mysql_schema_util_1 = require("./schema/mysql.schema.util");
+import { _hb } from '@naturalcycles/js-lib';
+import { white, yellow } from '@naturalcycles/nodejs-lib';
+import * as mysql from 'mysql';
+import { mapNameToMySQL } from './schema/mysql.schema.util.js';
 const MAX_PACKET_SIZE = 1024 * 1024; // 1Mb
 const MAX_ROW_SIZE = 800 * 1024; // 1Mb - margin
 /**
  * Returns `null` if it detects that 0 rows will be returned,
  * e.g when `IN ()` (empty array) is used.
  */
-function dbQueryToSQLSelect(q) {
+export function dbQueryToSQLSelect(q) {
     const tokens = selectTokens(q);
     // filters
     const whereTokens = getWhereTokens(q);
@@ -33,7 +24,7 @@ function dbQueryToSQLSelect(q) {
 /**
  * Returns null in "0 rows" case.
  */
-function dbQueryToSQLDelete(q) {
+export function dbQueryToSQLDelete(q) {
     const tokens = [`DELETE FROM`, mysql.escapeId(q.table)];
     // filters
     const whereTokens = getWhereTokens(q);
@@ -47,7 +38,7 @@ function dbQueryToSQLDelete(q) {
 /**
  * Returns array of sql statements to respect the max sql size.
  */
-function insertSQL(table, rows, verb = 'INSERT', logger = console) {
+export function insertSQL(table, rows, verb = 'INSERT', logger = console) {
     // INSERT INTO table_name (column1, column2, column3, ...)
     // VALUES (value1, value2, value3, ...);
     // eslint-disable-next-line unicorn/no-array-reduce
@@ -60,7 +51,7 @@ function insertSQL(table, rows, verb = 'INSERT', logger = console) {
         verb,
         `INTO`,
         mysql.escapeId(table),
-        `(` + [...fields].map(f => mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f))).join(',') + `)`,
+        `(` + [...fields].map(f => mysql.escapeId(mapNameToMySQL(f))).join(',') + `)`,
         `VALUES\n`,
     ].join(' ');
     const valueRows = rows.map(rec => {
@@ -88,11 +79,11 @@ function insertSQL(table, rows, verb = 'INSERT', logger = console) {
     if (sql) {
         sqls.push(sql); // last one
     }
-    logger.log(`${(0, nodejs_lib_1.white)(table)} large sql query (${(0, nodejs_lib_1.yellow)((0, js_lib_1._hb)(full.length))}) was split into ${(0, nodejs_lib_1.yellow)(sqls.length)} chunks`);
+    logger.log(`${white(table)} large sql query (${yellow(_hb(full.length))}) was split into ${yellow(sqls.length)} chunks`);
     return sqls;
     // todo: handle "upsert" later
 }
-function insertSQLSingle(table, record) {
+export function insertSQLSingle(table, record) {
     // INSERT INTO table_name (column1, column2, column3, ...)
     // VALUES (value1, value2, value3, ...);
     const tokens = [
@@ -100,7 +91,7 @@ function insertSQLSingle(table, record) {
         mysql.escapeId(table),
         `(` +
             Object.keys(record)
-                .map(f => mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f)))
+                .map(f => mysql.escapeId(mapNameToMySQL(f)))
                 .join(',') +
             `)`,
         `\nVALUES`,
@@ -112,13 +103,13 @@ function insertSQLSingle(table, record) {
     ];
     return tokens.join(' ');
 }
-function insertSQLSetSingle(table, record) {
+export function insertSQLSetSingle(table, record) {
     return {
         sql: `INSERT INTO ${mysql.escapeId(table)} SET ?`,
         values: [record],
     };
 }
-function dbQueryToSQLUpdate(q, patch) {
+export function dbQueryToSQLUpdate(q, patch) {
     // var sql = mysql.format('UPDATE posts SET modified = ? WHERE id = ?', [CURRENT_TIMESTAMP, 42]);
     const whereTokens = getWhereTokens(q);
     if (!whereTokens)
@@ -128,7 +119,7 @@ function dbQueryToSQLUpdate(q, patch) {
         mysql.escapeId(q.table),
         `SET`,
         Object.keys(patch)
-            .map(f => mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f)) + ' = ?')
+            .map(f => mysql.escapeId(mapNameToMySQL(f)) + ' = ?')
             .join(', '),
         ...whereTokens,
     ];
@@ -143,7 +134,7 @@ function selectTokens(q) {
     return [
         `SELECT`,
         q._distinct && 'DISTINCT',
-        fields.map(f => (0, mysql_schema_util_1.mapNameToMySQL)(f)).join(', '),
+        fields.map(f => mapNameToMySQL(f)).join(', '),
         `FROM`,
         mysql.escapeId(q.table),
     ].filter(Boolean);
@@ -186,7 +177,7 @@ function getWhereTokens(q) {
             if (f.val === null || f.val === undefined) {
                 // special treatment
                 return [
-                    mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f.name)),
+                    mysql.escapeId(mapNameToMySQL(f.name)),
                     f.op === '==' ? 'IS NULL' : 'IS NOT NULL',
                 ].join(' ');
             }
@@ -194,10 +185,10 @@ function getWhereTokens(q) {
                 // special case for arrays
                 if (!f.val.length)
                     returnNull = true;
-                return `${mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f.name))} IN (${mysql.escape(f.val)})`;
+                return `${mysql.escapeId(mapNameToMySQL(f.name))} IN (${mysql.escape(f.val)})`;
             }
             return [
-                mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f.name)),
+                mysql.escapeId(mapNameToMySQL(f.name)),
                 OP_MAP[f.op] || f.op,
                 mysql.escape(f.val),
             ].join(' ');

package/dist/schema/mysql.schema.util.d.ts

@@ -1,4 +1,4 @@
-import { AnyObject, CommonLogger, JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
+import type { AnyObject, CommonLogger, JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
 export interface MySQLTableStats {
     Field: string;
     Type: string;

package/dist/schema/mysql.schema.util.js

@@ -1,15 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonSchemaToMySQLDDL = jsonSchemaToMySQLDDL;
-exports.mysqlTableStatsToJsonSchemaField = mysqlTableStatsToJsonSchemaField;
-exports.mapNameToMySQL = mapNameToMySQL;
-exports.mapNameFromMySQL = mapNameFromMySQL;
-const tslib_1 = require("tslib");
-const mysql = tslib_1.__importStar(require("mysql"));
+import * as mysql from 'mysql';
 /**
  * It currently skips nullability and declares everything as "DEFAULT NULL".
  */
-function jsonSchemaToMySQLDDL(table, schema, opt = {}) {
+export function jsonSchemaToMySQLDDL(table, schema, opt = {}) {
     const { engine = 'InnoDB' } = opt;
     const lines = [`CREATE TABLE ${mysql.escapeId(table)} (`];
     const innerLines = Object.entries(schema.properties).map(([k, s]) => {
@@ -59,7 +52,7 @@ function jsonSchemaToMySQLDDL(table, schema, opt = {}) {
     lines.push(`) ENGINE=${engine}`);
     return lines.join('\n');
 }
-function mysqlTableStatsToJsonSchemaField(table, stats, logger) {
+export function mysqlTableStatsToJsonSchemaField(table, stats, logger) {
     const s = {
         $id: `${table}.schema.json`,
         type: 'object',
@@ -101,9 +94,9 @@ function mysqlTableStatsToJsonSchemaField(table, stats, logger) {
  *
  * @param name
  */
-function mapNameToMySQL(name) {
+export function mapNameToMySQL(name) {
     return name.replaceAll('.', '_dot_');
 }
-function mapNameFromMySQL(name) {
+export function mapNameFromMySQL(name) {
     return name.replaceAll('_dot_', '.');
 }

package/package.json

@@ -1,5 +1,6 @@
 {
   "name": "@naturalcycles/mysql-lib",
+  "type": "module",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",
@@ -9,17 +10,19 @@
     "lbt": "dev-lib lbt"
   },
   "dependencies": {
-    "@naturalcycles/db-lib": "^9.1.0",
-    "@naturalcycles/js-lib": "^14.47.0",
-    "@naturalcycles/nodejs-lib": "^13.1.0",
-    "@types/mysql": "^2.15.19",
-    "mysql": "^2.17.1"
+    "@naturalcycles/db-lib": "^10",
+    "@naturalcycles/js-lib": "^14",
+    "@naturalcycles/nodejs-lib": "^13",
+    "@types/mysql": "^2",
+    "mysql": "^2"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^15.18.0",
-    "@types/node": "^22.7.4",
-    "dotenv": "^16.0.0",
-    "jest": "^29.0.0"
+    "@naturalcycles/dev-lib": "^17",
+    "@types/node": "^22",
+    "@vitest/coverage-v8": "^3",
+    "dotenv": "^16",
+    "tsx": "^4",
+    "vitest": "^3"
   },
   "files": [
     "dist",
@@ -39,9 +42,9 @@
     "url": "https://github.com/NaturalCycles/mysql-lib"
   },
   "engines": {
-    "node": ">=20.13.0"
+    "node": ">=22.12.0"
   },
-  "version": "3.16.2",
+  "version": "4.0.0",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/index.ts

@@ -1,3 +1,3 @@
-export * from './mysql.db'
-export * from './mysqlKeyValueDB'
-export { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util'
+export * from './mysql.db.js'
+export * from './mysqlKeyValueDB.js'
+export { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util.js'

package/src/mysql.db.ts

@@ -1,17 +1,20 @@
-import { Readable } from 'node:stream'
+import { Readable, Transform } from 'node:stream'
 import { promisify } from 'node:util'
-import {
-  BaseCommonDB,
+import type {
   CommonDB,
   CommonDBCreateOptions,
-  commonDBFullSupport,
   CommonDBOptions,
   CommonDBSaveOptions,
   CommonDBSupport,
-  CommonDBType,
-  DBQuery,
   RunQueryResult,
 } from '@naturalcycles/db-lib'
+import { BaseCommonDB, commonDBFullSupport, CommonDBType, DBQuery } from '@naturalcycles/db-lib'
+import type {
+  CommonLogger,
+  JsonSchemaObject,
+  JsonSchemaRootObject,
+  ObjectWithId,
+} from '@naturalcycles/js-lib'
 import {
   _assert,
   _filterUndefinedValues,
@@ -19,14 +22,11 @@ import {
   _mapValues,
   _Memo,
   _omit,
-  CommonLogger,
   commonLoggerPrefix,
-  JsonSchemaObject,
-  JsonSchemaRootObject,
-  ObjectWithId,
 } from '@naturalcycles/js-lib'
-import { ReadableTyped, white } from '@naturalcycles/nodejs-lib'
-import {
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { white } from '@naturalcycles/nodejs-lib'
+import type {
   Connection,
   OkPacket,
   Pool,
@@ -36,13 +36,18 @@ import {
   TypeCast,
 } from 'mysql'
 import * as mysql from 'mysql'
-import { dbQueryToSQLDelete, dbQueryToSQLSelect, dbQueryToSQLUpdate, insertSQL } from './query.util'
+import {
+  dbQueryToSQLDelete,
+  dbQueryToSQLSelect,
+  dbQueryToSQLUpdate,
+  insertSQL,
+} from './query.util.js'
+import type { MySQLTableStats } from './schema/mysql.schema.util.js'
 import {
   jsonSchemaToMySQLDDL,
   mapNameFromMySQL,
-  MySQLTableStats,
   mysqlTableStatsToJsonSchemaField,
-} from './schema/mysql.schema.util'
+} from './schema/mysql.schema.util.js'
 
 export interface MysqlDBOptions extends CommonDBOptions {}
 export interface MysqlDBSaveOptions<ROW extends ObjectWithId> extends CommonDBSaveOptions<ROW> {}
@@ -277,10 +282,21 @@ 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() as ReadableTyped<ROW>).map(row =>
-      _filterUndefinedValues(row, true),
-    )
+    // todo: this is nice, but `mysql` package uses `readable-stream@2` which is not compatible with `node:stream` iterable helpers
+    // return (this.pool().query(sql).stream() as ReadableTyped<ROW>).map(row =>
+    //   _filterUndefinedValues(row, true),
+    // )
+    return this.pool()
+      .query(sql)
+      .stream()
+      .pipe(
+        new Transform({
+          objectMode: true,
+          transform(row: ROW, _encoding, cb) {
+            cb(null, _filterUndefinedValues(row, true))
+          },
+        }),
+      )
   }
 
   // SAVE

package/src/mysqlKeyValueDB.ts

@@ -1,14 +1,17 @@
-import {
+import { Transform } from 'node:stream'
+import type {
   CommonDBCreateOptions,
   CommonKeyValueDB,
-  commonKeyValueDBFullSupport,
   KeyValueDBTuple,
 } from '@naturalcycles/db-lib'
-import { IncrementTuple } from '@naturalcycles/db-lib/dist/kv/commonKeyValueDB'
-import { AppError, ObjectWithId, pMap } from '@naturalcycles/js-lib'
-import { ReadableTyped } from '@naturalcycles/nodejs-lib'
-import { QueryOptions } from 'mysql'
-import { MysqlDB, MysqlDBCfg } from './mysql.db'
+import { commonKeyValueDBFullSupport } from '@naturalcycles/db-lib'
+import type { IncrementTuple } from '@naturalcycles/db-lib/dist/kv/commonKeyValueDB.js'
+import type { ObjectWithId } from '@naturalcycles/js-lib'
+import { AppError, pMap } from '@naturalcycles/js-lib'
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import type { QueryOptions } from 'mysql'
+import type { MysqlDBCfg } from './mysql.db.js'
+import { MysqlDB } from './mysql.db.js'
 
 interface KeyValueObject {
   id: string
@@ -88,7 +91,20 @@ 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() as ReadableTyped<ObjectWithId>).map(row => row.id)
+    // todo: this is nice, but `mysql` package uses `readable-stream@2` which is not compatible with `node:stream` iterable helpers
+    // return (this.db.pool().query(sql).stream() as ReadableTyped<ObjectWithId>).map(row => row.id)
+    return this.db
+      .pool()
+      .query(sql)
+      .stream()
+      .pipe(
+        new Transform({
+          objectMode: true,
+          transform(row: ObjectWithId, _encoding, cb) {
+            cb(null, row.id)
+          },
+        }),
+      )
   }
 
   streamValues(table: string, limit?: number): ReadableTyped<Buffer> {

package/src/query.util.ts

@@ -1,9 +1,10 @@
-import { DBQuery, DBQueryFilterOperator } from '@naturalcycles/db-lib'
-import { _hb, AnyObjectWithId, CommonLogger } from '@naturalcycles/js-lib'
+import type { DBQuery, DBQueryFilterOperator } from '@naturalcycles/db-lib'
+import type { AnyObjectWithId, CommonLogger } from '@naturalcycles/js-lib'
+import { _hb } from '@naturalcycles/js-lib'
 import { white, yellow } from '@naturalcycles/nodejs-lib'
-import { QueryOptions } from 'mysql'
+import type { QueryOptions } from 'mysql'
 import * as mysql from 'mysql'
-import { mapNameToMySQL } from './schema/mysql.schema.util'
+import { mapNameToMySQL } from './schema/mysql.schema.util.js'
 
 const MAX_PACKET_SIZE = 1024 * 1024 // 1Mb
 const MAX_ROW_SIZE = 800 * 1024 // 1Mb - margin

package/src/schema/mysql.schema.util.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   AnyObject,
   CommonLogger,
   JsonSchemaBoolean,