nodenext compatibility (#108)

index.js

@@ -45,11 +45,6 @@ function fastifyMysql (fastify, options, next) {
   })
 }
 
-module.exports = fp(fastifyMysql, {
-  fastify: '4.x',
-  name: '@fastify/mysql'
-})
-
 function _createConnection ({ connectionType, options, usePromise }, cb) {
   const { format, escape, escapeId } = require('mysql2')
   const mysql = usePromise ? require('mysql2/promise') : require('mysql2')
@@ -104,3 +99,10 @@ function _createConnection ({ connectionType, options, usePromise }, cb) {
     }
   }
 }
+
+module.exports = fp(fastifyMysql, {
+  fastify: '4.x',
+  name: '@fastify/mysql'
+})
+module.exports.default = fastifyMysql
+module.exports.fastifyMysql = fastifyMysql

package.json

@@ -3,7 +3,7 @@
   "version": "4.0.0",
   "description": "Fastify Mysql connection plugin",
   "main": "index.js",
-  "types": "index.d.ts",
+  "types": "types/index.d.ts",
   "scripts": {
     "lint": "standard",
     "mariadb": "docker run -d -p 3306:3306 -e MYSQL_ALLOW_EMPTY_PASSWORD=yes --rm mariadb:10.1",

types/index.d.ts

@@ -0,0 +1,64 @@
+import { FastifyPluginCallback } from "fastify";
+import {
+  Connection,
+  ConnectionOptions,
+  escape,
+  format,
+  Pool,
+  PoolOptions,
+} from "mysql2";
+import {
+  Connection as PromiseConnection,
+  Pool as PromisePool,
+} from "mysql2/promise";
+
+type FastifyMysql = FastifyPluginCallback<fastifyMysql.MySQLOptions>;
+
+declare namespace fastifyMysql {
+
+  // upstream package missed type
+  type escapeId = (val: any, forbidQualified?: boolean) => string;
+
+  interface BaseClient {
+    format: typeof format;
+    escape: typeof escape;
+    escapeId: escapeId;
+  }
+
+  export type MySQLConnection = Pick<Connection, "query" | "execute"> & {
+    connection: Connection;
+  } & BaseClient;
+
+  export type MySQLPool = Pick<Pool, "query" | "execute" | "getConnection"> & {
+    pool: Pool;
+  } & BaseClient;
+
+  export type MySQLPromiseConnection = Pick<
+    PromiseConnection,
+    "query" | "execute"
+  > & {
+    connection: PromiseConnection;
+  } & BaseClient;
+
+  export type MySQLPromisePool = Pick<
+    PromisePool,
+    "query" | "execute" | "getConnection"
+  > & {
+    pool: PromisePool;
+  } & BaseClient;
+
+  export type ConnectionType = "connection" | "pool";
+
+  export interface MySQLOptions extends PoolOptions, ConnectionOptions {
+    type?: ConnectionType;
+    name?: string;
+    promise?: boolean;
+    connectionString?: string;
+  }
+
+  export const fastifyMysql: FastifyMysql
+  export { fastifyMysql as default } 
+}
+
+declare function fastifyMysql(...params: Parameters<FastifyMysql>): ReturnType<FastifyMysql>
+export = fastifyMysql

index.test-d.ts → types/index.test-d.ts

@@ -4,7 +4,7 @@ import fastifyMysql, {
   MySQLPool,
   MySQLPromiseConnection,
   MySQLPromisePool,
-} from ".";
+} from "..";
 
 declare module "fastify" {
   interface FastifyInstance {