refactor: unifies spread types in their proper places (#2075)

* refactor: moving `Auth` types * refactor: unify `Connection` types * refactor: unify `Pool` and `PoolConnection` types * refactor: unify `ConnectionOptions`, `PoolOptions` and `ConnectionConfig` types * refactor: remove duplicate types between `Connection` and `PoolConnection` * refactor: unify `execute` and `query` overloads * ci: add strict checks for `query` and `execute` returns

Author: wellwelwel

index.d.ts

@@ -1,225 +1 @@
-import * as mysql from './typings/mysql/index.js';
-import {
- Connection as PromiseConnection,
- Pool as PromisePool,
- PoolConnection as PromisePoolConnection,
-} from './promise.js';
-
 export * from './typings/mysql/index.js';
-
-export interface Connection extends mysql.Connection {
- execute<
- T extends
- | mysql.RowDataPacket[][]
- | mysql.RowDataPacket[]
- | mysql.OkPacket
- | mysql.OkPacket[]
- | mysql.ResultSetHeader
- >(
- sql: string,
- callback?: (
- err: mysql.QueryError | null,
- result: T,
- fields: mysql.FieldPacket[]
- ) => any
- ): mysql.Query;
- execute<
- T extends
- | mysql.RowDataPacket[][]
- | mysql.RowDataPacket[]
- | mysql.OkPacket
- | mysql.OkPacket[]
- | mysql.ResultSetHeader
- >(
- sql: string,
- values: any | any[] | { [param: string]: any },
- callback?: (
- err: mysql.QueryError | null,
- result: T,
- fields: mysql.FieldPacket[]
- ) => any
- ): mysql.Query;
- execute<
- T extends
- | mysql.RowDataPacket[][]
- | mysql.RowDataPacket[]
- | mysql.OkPacket
- | mysql.OkPacket[]
- | mysql.ResultSetHeader
- >(
- options: mysql.QueryOptions,
- callback?: (
- err: mysql.QueryError | null,
- result: T,
- fields?: mysql.FieldPacket[]
- ) => any
- ): mysql.Query;
- execute<
- T extends
- | mysql.RowDataPacket[][]
- | mysql.RowDataPacket[]
- | mysql.OkPacket
- | mysql.OkPacket[]
- | mysql.ResultSetHeader
- >(
- options: mysql.QueryOptions,
- values: any | any[] | { [param: string]: any },
- callback?: (
- err: mysql.QueryError | null,
- result: T,
- fields: mysql.FieldPacket[]
- ) => any
- ): mysql.Query;
- ping(callback?: (err: mysql.QueryError | null) => any): void;
- unprepare(sql: string): mysql.PrepareStatementInfo;
- prepare(
- sql: string,
- callback?: (
- err: mysql.QueryError | null,
- statement: mysql.PrepareStatementInfo
- ) => any
- ): mysql.Prepare;
- serverHandshake(args: any): any;
- writeOk(args?: mysql.OkPacketParams): void;
- writeError(args?: mysql.ErrorPacketParams): void;
- writeEof(warnings?: number, statusFlags?: number): void;
- writeTextResult(rows?: Array<any>, columns?: Array<any>): void;
- writePacket(packet: any): void;
- promise(promiseImpl?: PromiseConstructor): PromiseConnection;
- sequenceId: number;
-}
-
-export interface PoolConnection extends mysql.PoolConnection {
- promise(promiseImpl?: PromiseConstructor): PromisePool;
-}
-
-export interface Pool extends mysql.Connection {
- execute<
- T extends
- | mysql.RowDataPacket[][]
- | mysql.RowDataPacket[]
- | mysql.OkPacket
- | mysql.OkPacket[]
- | mysql.ResultSetHeader
- >(
- sql: string,
- callback?: (
- err: mysql.QueryError | null,
- result: T,
- fields: mysql.FieldPacket[]
- ) => any
- ): mysql.Query;
- execute<
- T extends
- | mysql.RowDataPacket[][]
- | mysql.RowDataPacket[]
- | mysql.OkPacket
- | mysql.OkPacket[]
- | mysql.ResultSetHeader
- >(
- sql: string,
- values: any | any[] | { [param: string]: any },
- callback?: (
- err: mysql.QueryError | null,
- result: T,
- fields: mysql.FieldPacket[]
- ) => any
- ): mysql.Query;
- execute<
- T extends
- | mysql.RowDataPacket[][]
- | mysql.RowDataPacket[]
- | mysql.OkPacket
- | mysql.OkPacket[]
- | mysql.ResultSetHeader
- >(
- options: mysql.QueryOptions,
- callback?: (
- err: mysql.QueryError | null,
- result: T,
- fields?: mysql.FieldPacket[]
- ) => any
- ): mysql.Query;
- execute<
- T extends
- | mysql.RowDataPacket[][]
- | mysql.RowDataPacket[]
- | mysql.OkPacket
- | mysql.OkPacket[]
- | mysql.ResultSetHeader
- >(
- options: mysql.QueryOptions,
- values: any | any[] | { [param: string]: any },
- callback?: (
- err: mysql.QueryError | null,
- result: T,
- fields: mysql.FieldPacket[]
- ) => any
- ): mysql.Query;
- getConnection(
- callback: (err: NodeJS.ErrnoException, connection: PoolConnection) => any
- ): void;
- releaseConnection(connection: PoolConnection | PromisePoolConnection): void;
- on(event: string, listener: (args: any[]) => void): this;
- on(event: 'connection', listener: (connection: PoolConnection) => any): this;
- on(event: 'acquire', listener: (connection: PoolConnection) => any): this;
- on(event: 'release', listener: (connection: PoolConnection) => any): this;
- on(event: 'enqueue', listener: () => any): this;
- unprepare(sql: string): mysql.PrepareStatementInfo;
- prepare(
- sql: string,
- callback?: (
- err: mysql.QueryError | null,
- statement: mysql.PrepareStatementInfo
- ) => any
- ): mysql.Prepare;
- promise(promiseImpl?: PromiseConstructor): PromisePool;
- config: mysql.PoolOptions;
-}
-
-export interface ConnectionOptions extends mysql.ConnectionOptions {
- charsetNumber?: number;
- compress?: boolean;
- authSwitchHandler?: (data: any, callback: () => void) => any;
- connectAttributes?: { [param: string]: any };
- decimalNumbers?: boolean;
- isServer?: boolean;
- maxPreparedStatements?: number;
- namedPlaceholders?: boolean;
- nestTables?: boolean | string;
- passwordSha1?: string;
- pool?: any;
- rowsAsArray?: boolean;
- stream?: any;
- uri?: string;
- connectionLimit?: number;
- maxIdle?: number;
- idleTimeout?: number;
- Promise?: any;
- queueLimit?: number;
- waitForConnections?: boolean;
- authPlugins?: {
- [key: string]: mysql.AuthPlugin;
- };
-}
-
-export interface ConnectionConfig extends ConnectionOptions {
- mergeFlags(defaultFlags: string[], userFlags: string[] | string): number;
- getDefaultFlags(options?: ConnectionOptions): string[];
- getCharsetNumber(charset: string): number;
- getSSLProfile(name: string): { ca: string[] };
- parseUrl(url: string): {
- host: string;
- port: number;
- database: string;
- user: string;
- password: string;
- [key: string]: any;
- };
-}
-
-export interface PoolOptions extends mysql.PoolOptions, ConnectionOptions {}
-
-export function createConnection(connectionUri: string): Connection;
-export function createConnection(config: ConnectionOptions): Connection;
-export function createPool(config: PoolOptions): Pool;