mysql2 3.18.1 → 3.18.2-canary.2ad5f0b2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2",
-  "version": "3.18.1",
+  "version": "3.18.2-canary.2ad5f0b2",
   "description": "fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS",
   "main": "index.js",
   "typings": "typings/mysql/index",

package/typings/mysql/lib/Connection.d.ts

@@ -5,6 +5,7 @@
 
 import { EventEmitter } from 'events';
 import { Readable } from 'stream';
+import { Timezone } from 'sql-escaper';
 import { Query, QueryError } from './protocol/sequences/Query.js';
 import { Prepare, PrepareStatementInfo } from './protocol/sequences/Prepare.js';
 import {
@@ -150,7 +151,7 @@ export interface ConnectionOptions {
   /**
    * The timezone used to store local dates. (Default: 'local')
    */
-  timezone?: string | 'local';
+  timezone?: Timezone;
 
   /**
    * The milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 10 seconds)

package/typings/mysql/lib/protocol/sequences/ExecutableBase.d.ts

@@ -3,6 +3,7 @@ import {
   Query,
   QueryError,
   QueryOptions,
+  ExecuteValues,
   QueryableConstructor,
 } from './Query.js';
 
@@ -18,7 +19,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
     ): Query;
     execute<T extends QueryResult>(
       sql: string,
-      values: any,
+      values: ExecuteValues,
       callback?:
         | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
         | undefined
@@ -26,12 +27,12 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
     execute<T extends QueryResult>(
       options: QueryOptions,
       callback?:
-        | ((err: QueryError | null, result: T, fields?: FieldPacket[]) => any)
+        | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
         | undefined
     ): Query;
     execute<T extends QueryResult>(
       options: QueryOptions,
-      values: any,
+      values: ExecuteValues,
       callback?:
         | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
         | undefined

package/typings/mysql/lib/protocol/sequences/Query.d.ts

@@ -1,9 +1,10 @@
 import { Sequence } from './Sequence.js';
 import { OkPacket, RowDataPacket, FieldPacket } from '../packets/index.js';
 import { Readable } from 'stream';
+import { Timezone } from 'sql-escaper';
 import { TypeCast } from '../../parsers/typeCast.js';
 
-export type QueryValues =
+export type ExecuteValues =
   | string
   | number
   | bigint
@@ -13,6 +14,18 @@ export type QueryValues =
   | Blob
   | Buffer
   | ({} | null)[]
+  | { [key: string]: ExecuteValues };
+
+export type QueryValues =
+  | string
+  | number
+  | bigint
+  | boolean
+  | Date
+  | null
+  | Blob
+  | Buffer
+  | ({} | null | undefined)[]
   | { [key: string]: QueryValues };
 
 export interface QueryOptions {
@@ -95,6 +108,35 @@ export interface QueryOptions {
    * By specifying a function that returns a readable stream, an arbitrary stream can be sent when sending a local fs file.
    */
   infileStreamFactory?: (path: string) => Readable;
+
+  /**
+   * When dealing with big numbers (BIGINT and DECIMAL columns) in the database, you should enable this option
+   * (Default: false)
+   */
+  supportBigNumbers?: boolean;
+
+  /**
+   * Enabling both supportBigNumbers and bigNumberStrings forces big numbers (BIGINT and DECIMAL columns) to be
+   * always returned as JavaScript String objects (Default: false). Enabling supportBigNumbers but leaving
+   * bigNumberStrings disabled will return big numbers as String objects only when they cannot be accurately
+   * represented with JavaScript Number objects (which happens when they exceed the [-2^53, +2^53] range),
+   * otherwise they will be returned as Number objects.
+   * This option is ignored if supportBigNumbers is disabled.
+   */
+  bigNumberStrings?: boolean;
+
+  /**
+   * Force date types (TIMESTAMP, DATETIME, DATE) to be returned as strings rather then inflated into JavaScript Date
+   * objects. Can be true/false or an array of type names to keep as strings.
+   *
+   * (Default: false)
+   */
+  dateStrings?: boolean | Array<'TIMESTAMP' | 'DATETIME' | 'DATE'>;
+
+  /**
+   * The timezone used to store local dates. (Default: 'local')
+   */
+  timezone?: Timezone;
 }
 
 export interface StreamOptions {

package/typings/mysql/lib/protocol/sequences/QueryableBase.d.ts

@@ -3,6 +3,7 @@ import {
   Query,
   QueryError,
   QueryOptions,
+  QueryValues,
   QueryableConstructor,
 } from './Query.js';
 
@@ -18,7 +19,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
     ): Query;
     query<T extends QueryResult>(
       sql: string,
-      values: any,
+      values: QueryValues,
       callback?:
         | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
         | undefined
@@ -26,12 +27,12 @@ export declare function QueryableBase<T extends QueryableConstructor>(
     query<T extends QueryResult>(
       options: QueryOptions,
       callback?:
-        | ((err: QueryError | null, result: T, fields?: FieldPacket[]) => any)
+        | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
         | undefined
     ): Query;
     query<T extends QueryResult>(
       options: QueryOptions,
-      values: any,
+      values: QueryValues,
       callback?:
         | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
         | undefined

package/typings/mysql/lib/protocol/sequences/promise/ExecutableBase.d.ts

@@ -1,21 +1,17 @@
 import { FieldPacket, QueryResult } from '../../packets/index.js';
-import { QueryOptions, QueryableConstructor, QueryValues } from '../Query.js';
+import { QueryOptions, QueryableConstructor, ExecuteValues } from '../Query.js';
 
 export declare function ExecutableBase<T extends QueryableConstructor>(
   Base?: T
 ): {
   new (...args: any[]): {
-    execute<T extends QueryResult>(sql: string): Promise<[T, FieldPacket[]]>;
     execute<T extends QueryResult>(
       sql: string,
-      values?: QueryValues
-    ): Promise<[T, FieldPacket[]]>;
-    execute<T extends QueryResult>(
-      options: QueryOptions
+      values?: ExecuteValues
     ): Promise<[T, FieldPacket[]]>;
     execute<T extends QueryResult>(
       options: QueryOptions,
-      values?: QueryValues
+      values?: ExecuteValues
     ): Promise<[T, FieldPacket[]]>;
   };
 } & T;

package/typings/mysql/lib/protocol/sequences/promise/QueryableBase.d.ts

@@ -1,21 +1,18 @@
 import { FieldPacket, QueryResult } from '../../packets/index.js';
-import { QueryOptions, QueryableConstructor } from '../Query.js';
+import { QueryOptions, QueryValues, QueryableConstructor } from '../Query.js';
 
 export declare function QueryableBase<T extends QueryableConstructor>(
   Base?: T
 ): {
   new (...args: any[]): {
-    query<T extends QueryResult>(sql: string): Promise<[T, FieldPacket[]]>;
     query<T extends QueryResult>(
       sql: string,
-      values?: any
-    ): Promise<[T, FieldPacket[]]>;
-    query<T extends QueryResult>(
-      options: QueryOptions
+      values?: QueryValues
     ): Promise<[T, FieldPacket[]]>;
+
     query<T extends QueryResult>(
       options: QueryOptions,
-      values?: any
+      values?: QueryValues
     ): Promise<[T, FieldPacket[]]>;
   };
 } & T;