@nymphjs/driver-mysql 1.0.0-beta.12 → 1.0.0-beta.121

package/src/conf/defaults.ts

@@ -1,4 +1,4 @@
-import { MySQLDriverConfig } from './d';
+import type { MySQLDriverConfig } from './index.js';
 
 export default {
   host: 'localhost',

package/src/conf/index.ts

@@ -1,4 +1,69 @@
-export { MySQLDriverConfig } from './d';
+import type { PoolOptions } from 'mysql2';
 
-import defaults from './defaults';
+/**
+ * MySQL Driver Config
+ */
+export interface MySQLDriverConfig {
+  /**
+   * The host on which to connect to MySQL. Can include a port, like
+   * hostname:port.
+   */
+  host: string;
+  /**
+   * The port on which to connect to MySQL.
+   */
+  port: number;
+  /**
+   * The MySQL user.
+   */
+  user: string;
+  /**
+   * The MySQL password.
+   */
+  password: string;
+  /**
+   * The MySQL database.
+   */
+  database: string;
+  /**
+   * If you need to use custom options, like SSL, you can provide them here in
+   * place of the above options.
+   */
+  customPoolConfig: PoolOptions | null;
+  /**
+   * The MySQL table name prefix.
+   */
+  prefix: string;
+  /**
+   * The MySQL table engine.
+   *
+   * You should use MYISAM if you are using MySQL < 5.6.
+   *
+   * Options are: Any MySQL storage engine supported on your server.
+   */
+  engine: string;
+  /**
+   * Whether to use transactions. If your table engine doesn't support
+   * it (like MYISAM), you should turn this off.
+   */
+  transactions: boolean;
+  /**
+   * Whether to use foreign keys. If your table engine doesn't support
+   * it (like MYISAM), you should turn this off.
+   */
+  foreignKeys: boolean;
+  /**
+   * Whether to use row locking. If your table engine doesn't support
+   * it (like MYISAM), you should turn this off.
+   */
+  rowLocking: boolean;
+  /**
+   * Whether to use table locking. If you use row locking, this should be off.
+   * If you can't use row locking (like with MYISAM), you can use table
+   * locking to ensure data consistency.
+   */
+  tableLocking: boolean;
+}
+
+import defaults from './defaults.js';
 export { defaults as MySQLDriverConfigDefaults };

package/src/index.ts

@@ -1,5 +1,5 @@
-export * from './conf';
+export * from './conf/index.js';
 
-import MySQLDriver from './MySQLDriver';
+import MySQLDriver from './MySQLDriver.js';
 export { MySQLDriver };
 export default MySQLDriver;

package/tsconfig.json

@@ -2,10 +2,13 @@
   "extends": "@tsconfig/recommended/tsconfig.json",
 
   "compilerOptions": {
-    "lib": ["ES2021"],
-    "target": "ES2021",
+    "types": ["node", "jest"],
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "lib": ["es2023"],
+    "target": "es2023",
     "noImplicitAny": true,
-    "removeComments": true,
+    "removeComments": false,
     "sourceMap": true,
     "outDir": "dist",
     "resolveJsonModule": true,

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}

package/dist/conf/d.d.ts

@@ -1,15 +0,0 @@
-import { default as MySQLType } from '@types/mysql';
-export interface MySQLDriverConfig {
-    host: string;
-    port: number;
-    user: string;
-    password: string;
-    database: string;
-    customPoolConfig: MySQLType.PoolConfig | null;
-    prefix: string;
-    engine: string;
-    transactions: boolean;
-    foreignKeys: boolean;
-    rowLocking: boolean;
-    tableLocking: boolean;
-}

package/dist/conf/d.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=d.js.map

package/dist/conf/d.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"d.js","sourceRoot":"","sources":["../../src/conf/d.ts"],"names":[],"mappings":""}

package/dist/runMysqlSync.js

@@ -1,44 +0,0 @@
-const mysql = require('@vlasky/mysql');
-
-let stdin = '';
-
-process.stdin.on('data', (data) => {
-  if (data != null) {
-    stdin += data.toString();
-  }
-});
-
-process.stdin.on('end', () => {
-  run();
-});
-
-async function run() {
-  try {
-    const { mysqlConfig, query, params } = JSON.parse(stdin);
-    const pool = mysql.createPool(mysqlConfig);
-    const [results, fields] = await new Promise((resolve, reject) =>
-      pool.query(query, params, (error, results, fields) => {
-        if (error) {
-          reject(error);
-        }
-        resolve([results, fields]);
-      })
-    );
-    process.stdout.end(
-      JSON.stringify({
-        results,
-        fields,
-      }),
-      'utf8',
-      () => {
-        pool.end(() => {
-          process.exit(0);
-        });
-      }
-    );
-  } catch (e) {
-    process.stderr.end(JSON.stringify(e), 'utf8', () => {
-      process.exit(1);
-    });
-  }
-}

package/src/conf/d.ts

@@ -1,67 +0,0 @@
-// @ts-ignore: types are wonky with @vlasky/mysql.
-import { default as MySQLType } from '@types/mysql';
-
-/**
- * MySQL Driver Config
- */
-export interface MySQLDriverConfig {
-  /**
-   * The host on which to connect to MySQL. Can include a port, like
-   * hostname:port.
-   */
-  host: string;
-  /**
-   * The port on which to connect to MySQL.
-   */
-  port: number;
-  /**
-   * The MySQL user.
-   */
-  user: string;
-  /**
-   * The MySQL password.
-   */
-  password: string;
-  /**
-   * The MySQL database.
-   */
-  database: string;
-  /**
-   * If you need to use custom options, like SSL, you can provide them here in
-   * place of the above options.
-   */
-  customPoolConfig: MySQLType.PoolConfig | null;
-  /**
-   * The MySQL table name prefix.
-   */
-  prefix: string;
-  /**
-   * The MySQL table engine.
-   *
-   * You should use MYISAM if you are using MySQL < 5.6.
-   *
-   * Options are: Any MySQL storage engine supported on your server.
-   */
-  engine: string;
-  /**
-   * Whether to use transactions. If your table engine doesn't support
-   * it (like MYISAM), you should turn this off.
-   */
-  transactions: boolean;
-  /**
-   * Whether to use foreign keys. If your table engine doesn't support
-   * it (like MYISAM), you should turn this off.
-   */
-  foreignKeys: boolean;
-  /**
-   * Whether to use row locking. If your table engine doesn't support
-   * it (like MYISAM), you should turn this off.
-   */
-  rowLocking: boolean;
-  /**
-   * Whether to use table locking. If you use row locking, this should be off.
-   * If you can't use row locking (like with MYISAM), you can use table
-   * locking to ensure data consistency.
-   */
-  tableLocking: boolean;
-}

package/src/runMysqlSync.js

@@ -1,44 +0,0 @@
-const mysql = require('@vlasky/mysql');
-
-let stdin = '';
-
-process.stdin.on('data', (data) => {
-  if (data != null) {
-    stdin += data.toString();
-  }
-});
-
-process.stdin.on('end', () => {
-  run();
-});
-
-async function run() {
-  try {
-    const { mysqlConfig, query, params } = JSON.parse(stdin);
-    const pool = mysql.createPool(mysqlConfig);
-    const [results, fields] = await new Promise((resolve, reject) =>
-      pool.query(query, params, (error, results, fields) => {
-        if (error) {
-          reject(error);
-        }
-        resolve([results, fields]);
-      })
-    );
-    process.stdout.end(
-      JSON.stringify({
-        results,
-        fields,
-      }),
-      'utf8',
-      () => {
-        pool.end(() => {
-          process.exit(0);
-        });
-      }
-    );
-  } catch (e) {
-    process.stderr.end(JSON.stringify(e), 'utf8', () => {
-      process.exit(1);
-    });
-  }
-}

package/src/testmysql.js

@@ -1,32 +0,0 @@
-const cp = require('child_process');
-
-const mysqlConfig = {
-  host: 'localhost',
-  user: 'nymph',
-  password: 'nymph',
-  database: 'nymph',
-  insecureAuth: true,
-};
-
-const query = 'SELECT ? AS message;';
-const params = ['Hello, world.'];
-
-// const query =
-//   'CREATE TABLE test (`id` INT UNSIGNED NOT NULL, PRIMARY KEY (`id`));';
-// const params = [];
-
-// const query = 'SELECT LOWER(HEX(UNHEX(?))) AS message;';
-// const params = ['FF'];
-
-const output = cp.spawnSync(process.argv0, [__dirname + '/runMysqlSync.js'], {
-  input: JSON.stringify({ mysqlConfig, query, params }),
-  timeout: 30000,
-  maxBuffer: 100 * 1024 * 1024,
-  encoding: 'utf8',
-  windowsHide: true,
-});
-const result = JSON.parse(output.stdout);
-const err = output.status === 0 ? null : JSON.parse(output.stderr);
-
-if (err) throw new Error(err.message);
-console.log('Server reply: ', result);