feat: modernize, convert to ESM

BREAKING CHANGE: ^^^

Author: kirillgroshkov

eslint.config.js

@@ -1,4 +1,10 @@
-// prettier-ignore
-module.exports = [
-  ...require('@naturalcycles/dev-lib/cfg/eslint.config'),
+import sharedConfig from '@naturalcycles/dev-lib/cfg/eslint.config.js'
+
+export default [
+  ...sharedConfig,
+  {
+    rules: {
+      '@typescript-eslint/consistent-type-imports': 2,
+    },
+  },
 ]

jest.config.js

@@ -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",
+    "@naturalcycles/db-lib": "^10",
     "@naturalcycles/js-lib": "^14",
     "@naturalcycles/nodejs-lib": "^13",
     "@types/mysql": "^2",
     "mysql": "^2"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^15",
+    "@naturalcycles/dev-lib": "^17",
     "@types/node": "^22",
+    "@vitest/coverage-v8": "^3",
     "dotenv": "^16",
-    "jest": "^29"
+    "tsx": "^4",
+    "vitest": "^3"
   },
   "files": [
     "dist",

package.json

@@ -1 +1,3 @@
-module.exports = require('@naturalcycles/dev-lib/cfg/prettier.config')
+import sharedConfig from '@naturalcycles/dev-lib/cfg/prettier.config.js'
+
+export default sharedConfig

prettier.config.js

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`dbQueryToSQLDelete 1`] = `"DELETE FROM \`TBL1\`"`;
 
@@ -14,13 +14,13 @@ exports[`dbQueryToSQLSelect 4`] = `"SELECT * FROM \`TBL1\` WHERE \`a\` IS NULL A
 
 exports[`dbQueryToSQLSelect 5`] = `"SELECT * FROM \`TBL1\` WHERE \`a\` IN ('a1', 'a2', 'a3')"`;
 
-exports[`dbQueryToSQLUpdate 1`] = `"UPDATE \`TEST_TABLE\` SET \`id\` = 'id1', \`k1\` = 'v1', \`k2\` = 'v2', \`k3\` = 1, \`even\` = false, \`created\` = 1529539200, \`updated\` = 1529539200"`;
+exports[`dbQueryToSQLUpdate 1`] = `"UPDATE \`TEST_TABLE\` SET \`id\` = 'id1', \`k1\` = 'v1', \`k2\` = 'v2', \`k3\` = 1, \`even\` = false, \`nested\` = \`foo\` = 1, \`created\` = 1529539200, \`updated\` = 1529539200"`;
 
-exports[`dbQueryToSQLUpdate 2`] = `"UPDATE \`TEST_TABLE\` SET \`id\` = 'id1', \`k1\` = 'v1', \`k2\` = 'v2', \`k3\` = 1, \`even\` = false, \`created\` = 1529539200, \`updated\` = 1529539200 WHERE \`a\` > 5"`;
+exports[`dbQueryToSQLUpdate 2`] = `"UPDATE \`TEST_TABLE\` SET \`id\` = 'id1', \`k1\` = 'v1', \`k2\` = 'v2', \`k3\` = 1, \`even\` = false, \`nested\` = \`foo\` = 1, \`created\` = 1529539200, \`updated\` = 1529539200 WHERE \`a\` > 5"`;
 
 exports[`insertSQL 1`] = `
-"INSERT INTO \`TEST_TABLE\` (\`id\`,\`k1\`,\`k2\`,\`k3\`,\`even\`,\`created\`,\`updated\`) VALUES
-('id1','v1','v2',1,false,1529539200,1529539200),
-('id2','v2','v4',2,true,1529539200,1529539200),
-('id3','v3','v6',3,false,1529539200,1529539200)"
+"INSERT INTO \`TEST_TABLE\` (\`id\`,\`k1\`,\`k2\`,\`k3\`,\`even\`,\`nested\`,\`created\`,\`updated\`) VALUES
+('id1','v1','v2',1,false,\`foo\` = 1,1529539200,1529539200),
+('id2','v2','v4',2,true,\`foo\` = 2,1529539200,1529539200),
+('id3','v3','v6',3,false,\`foo\` = 3,1529539200,1529539200)"
 `;

src/__snapshots__/query.util.test.ts.snap

@@ -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'

src/index.ts

@@ -1,32 +1,32 @@
 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,
   _mapKeys,
   _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> {}

src/mysql.db.ts

@@ -1,15 +1,17 @@
 import { Transform } from 'node:stream'
-import {
+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

src/mysqlKeyValueDB.ts

@@ -3,8 +3,14 @@ import {
   createTestItemDBM,
   createTestItemsDBM,
   TEST_TABLE,
-} from '@naturalcycles/db-lib/dist/testing'
-import { dbQueryToSQLDelete, dbQueryToSQLSelect, dbQueryToSQLUpdate, insertSQL } from './query.util'
+} from '@naturalcycles/db-lib/dist/testing/index.js'
+import { expect, test } from 'vitest'
+import {
+  dbQueryToSQLDelete,
+  dbQueryToSQLSelect,
+  dbQueryToSQLUpdate,
+  insertSQL,
+} from './query.util.js'
 
 test('dbQueryToSQLSelect', () => {
   let sql = dbQueryToSQLSelect(new DBQuery('TBL1'))

src/query.util.test.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