ztechno_core 0.0.77 → 0.0.81

package/lib/sql_service.d.ts

@@ -1,6 +1,10 @@
 import * as mysql from 'mysql';
 type ZOnErrorCallback = (err: mysql.MysqlError) => any;
 type ZOnLogCallback = (log: string) => any;
+export type ZSQLOptions = mysql.PoolConfig & {
+  dateStringTimezone?: string;
+  parseBooleans?: boolean;
+};
 export declare class ZSQLService {
   private options;
   private pool;
@@ -8,15 +12,31 @@ export declare class ZSQLService {
   private listeners;
   private databaseName;
   get database(): string;
-  constructor(
-    options: mysql.PoolConfig & {
-      dateStringTimezone?: string;
-    },
-  );
+  /**
+   * Creates a new ZSQLService instance with a MySQL connection pool.
+   * @param options - MySQL pool configuration options including custom dateStringTimezone and parseBooleans settings
+   */
+  constructor(options: ZSQLOptions);
+  /**
+   * Registers an event listener for database errors or logs.
+   * @param eventName - The event type to listen for ('err' or 'log')
+   * @param listener - The callback function to execute when the event occurs
+   * @throws Error if the event name is not supported
+   */
   on(eventName: 'err', listener: ZOnErrorCallback): void;
   on(eventName: 'log', listener: ZOnLogCallback): void;
   private triggerEvent;
   private getPoolConnection;
+  /**
+   * Executes a SQL query with automatic type conversion for dates and booleans.
+   * Converts TINYINT(1) columns to booleans if parseBooleans option is enabled.
+   * Converts date strings to Date objects if dateStringTimezone option is set.
+   * @template T - The expected result type
+   * @param opt - Query options containing the SQL query string and optional parameters
+   * @param opt.query - The SQL query string to execute
+   * @param opt.params - Optional query parameters (array for positional, object for named parameters)
+   * @returns Promise resolving to query results with type conversions applied
+   */
   exec(opt: {
     query: string;
     params?:
@@ -36,12 +56,29 @@ export declare class ZSQLService {
           [key: string]: any;
         };
   }): Promise<T>;
+  /**
+   * Legacy method to execute a SQL query. Uses uppercase property names for backwards compatibility.
+   * Does not apply date or boolean conversions. Consider using exec() instead.
+   * @template T - The expected result type
+   * @param opt - Query options
+   * @param opt.Query - The SQL query string to execute
+   * @param opt.Params - Named parameters for the query
+   * @returns Promise resolving to query results
+   */
   fetch<T = any>(opt: {
     Query: string;
     Params: {
       [key: string]: any;
     };
   }): Promise<T[]>;
+  /**
+   * Executes a SQL query without type conversions.
+   * Supports both positional (array) and named (object) parameters.
+   * @template T - The expected result type
+   * @param sql - The SQL query string to execute
+   * @param params - Optional query parameters (array for positional with ?, object for named with :key)
+   * @returns Promise resolving to query results or insert/update metadata
+   */
   query(
     sql: string,
     params?:
@@ -61,7 +98,16 @@ export declare class ZSQLService {
           [key: string]: any;
         },
   ): Promise<T[]>;
+  private queryWithFields;
   private formatQueryParams;
   private isSqlDate;
+  /**
+   * Changes the active database by closing the current connection pool and creating a new one.
+   * All active connections will be gracefully closed before switching.
+   * @param newDatabase - The name of the database to switch to
+   * @returns Promise that resolves when the database has been changed successfully
+   * @throws Error if the pool cannot be closed or new pool cannot be created
+   */
+  changeDatabase(newDatabase: string): Promise<void>;
 }
 export {};

package/lib/sql_service.js

@@ -46,6 +46,10 @@ class ZSQLService {
   get database() {
     return this.databaseName;
   }
+  /**
+   * Creates a new ZSQLService instance with a MySQL connection pool.
+   * @param options - MySQL pool configuration options including custom dateStringTimezone and parseBooleans settings
+   */
   constructor(options) {
     this.options = options;
     this.defaultPoolconfig = {
@@ -84,22 +88,44 @@ class ZSQLService {
     });
   }
   async exec(opt) {
-    const rows = await this.query(opt.query, opt.params);
-    if (!Array.isArray(rows)) {
-      return rows;
+    const { results, fields } = await this.queryWithFields(opt.query, opt.params);
+    if (!Array.isArray(results)) {
+      return results;
     }
-    if (!this.options.dateStringTimezone) {
-      return rows;
+    if (!this.options.dateStringTimezone && !this.options.parseBooleans) {
+      return results;
     }
-    return rows.map((row) => {
+    // Build a set of column names that are TINYINT(1) for boolean conversion
+    const booleanColumns = new Set();
+    if (this.options.parseBooleans && fields) {
+      fields.forEach((field) => {
+        // Check if column is TINYINT(1) - type 1 is TINY, length 1 means TINYINT(1)
+        if (field.type === 1 && field.length === 1) {
+          booleanColumns.add(field.name);
+        }
+      });
+    }
+    return results.map((row) => {
       Object.keys(row).map((key) => {
-        if (this.isSqlDate(row[key])) {
+        if (this.options.dateStringTimezone && this.isSqlDate(row[key])) {
           row[key] = new Date(row[key] + this.options.dateStringTimezone);
         }
+        if (this.options.parseBooleans && booleanColumns.has(key) && (row[key] === 0 || row[key] === 1)) {
+          row[key] = row[key] === 1;
+        }
       });
       return row;
     });
   }
+  /**
+   * Legacy method to execute a SQL query. Uses uppercase property names for backwards compatibility.
+   * Does not apply date or boolean conversions. Consider using exec() instead.
+   * @template T - The expected result type
+   * @param opt - Query options
+   * @param opt.Query - The SQL query string to execute
+   * @param opt.Params - Named parameters for the query
+   * @returns Promise resolving to query results
+   */
   async fetch(opt) {
     const items = await this.query(opt.Query, opt.Params);
     return items;
@@ -126,6 +152,40 @@ class ZSQLService {
       throw err;
     }
   }
+  async queryWithFields(sql, params) {
+    try {
+      const con = await this.getPoolConnection();
+      try {
+        const output = await new Promise((resolve, reject) => {
+          if (Array.isArray(params)) {
+            con.query(sql, params, (err, results, fields) => {
+              if (err) {
+                reject(err);
+              } else {
+                resolve({ results, fields });
+              }
+            });
+          } else {
+            sql = this.formatQueryParams(con, sql, params);
+            con.query(sql, (err, results, fields) => {
+              if (err) {
+                reject(err);
+              } else {
+                resolve({ results, fields });
+              }
+            });
+          }
+        });
+        con.release();
+        return output;
+      } catch (err) {
+        con.release();
+        throw err;
+      }
+    } catch (err) {
+      throw err;
+    }
+  }
   formatQueryParams(con, query, values) {
     if (!values) {
       return query;
@@ -148,5 +208,34 @@ class ZSQLService {
     }
     return false;
   }
+  /**
+   * Changes the active database by closing the current connection pool and creating a new one.
+   * All active connections will be gracefully closed before switching.
+   * @param newDatabase - The name of the database to switch to
+   * @returns Promise that resolves when the database has been changed successfully
+   * @throws Error if the pool cannot be closed or new pool cannot be created
+   */
+  async changeDatabase(newDatabase) {
+    return new Promise((resolve, reject) => {
+      this.pool.end((err) => {
+        if (err) {
+          reject(err);
+          return;
+        }
+        this.databaseName = newDatabase;
+        const newOptions = { ...this.options, database: newDatabase };
+        this.pool = mysql.createPool(Object.assign({}, this.defaultPoolconfig, newOptions));
+        this.pool.on('connection', (connection) => {
+          connection.on('error', (err) => {
+            this.triggerEvent('err', err);
+          });
+          connection.on('close', (err) => {
+            this.triggerEvent('err', err);
+          });
+        });
+        resolve();
+      });
+    });
+  }
 }
 exports.ZSQLService = ZSQLService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ztechno_core",
-  "version": "0.0.77",
+  "version": "0.0.81",
   "description": "Core files for ztechno framework",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",