node-firebird 2.0.2 → 2.3.0

package/lib/wire/service.js

@@ -135,102 +135,110 @@ class ServiceManager extends Events.EventEmitter {
     }
 
     _processquery(buffer, callback) {
-        //console.log(buffer);
-        var br = new BlrReader(buffer);
-        var tinfo = br.readByteCode();
-        var res = {};
-        res.result = 0;
-        for (; tinfo !== Const.isc_info_end; tinfo = br.readByteCode()) {
-            switch (tinfo) {
-                case Const.isc_info_svc_server_version:
-                case Const.isc_info_svc_implementation:
-                case Const.isc_info_svc_user_dbpath:
-                case Const.isc_info_svc_get_env:
-                case Const.isc_info_svc_get_env_lock:
-                case Const.isc_info_svc_get_env_msg:
-                    res[this._infosmapping[tinfo]] = br.readString();
-                    break;
-                case Const.isc_info_svc_version:
-                    res[this._infosmapping[tinfo]] = br.readInt32();
-                    break;
-                case Const.isc_info_svc_svr_db_info:
-                    this._processdbinfo(br, res);
-                    break;
-                case Const.isc_info_svc_limbo_trans:
-                    // not implemented
-                    for (; tinfo !== isc_info_flag_end; tinfo = br.readByteCode())
+        if (!Buffer.isBuffer(buffer)) {
+            doError(new Error('Malformed service-manager response: missing BLR buffer'), callback);
+            return;
+        }
+
+        try {
+            var br = new BlrReader(buffer);
+            var tinfo = br.readByteCode();
+            var res = {};
+            res.result = 0;
+            for (; tinfo !== Const.isc_info_end; tinfo = br.readByteCode()) {
+                switch (tinfo) {
+                    case Const.isc_info_svc_server_version:
+                    case Const.isc_info_svc_implementation:
+                    case Const.isc_info_svc_user_dbpath:
+                    case Const.isc_info_svc_get_env:
+                    case Const.isc_info_svc_get_env_lock:
+                    case Const.isc_info_svc_get_env_msg:
+                        res[this._infosmapping[tinfo]] = br.readString();
                         break;
-                case Const.isc_info_svc_get_users:
-                    br.pos += 2
-                    res[this._infosmapping[tinfo]] = [];
-                    break;
-                case Const.isc_spb_sec_username:
-                    var tuser = res[this._infosmapping[68]];
-                    tuser.push({});
-                    tuser[tuser.length - 1].username = br.readString();
-                    break;
-                case Const.isc_spb_sec_firstname:
-                    var tuser = res[this._infosmapping[68]];
-                    var user = tuser[tuser.length-1];
-                    user.firstname = br.readString();
-                    break;
-                case Const.isc_spb_sec_middlename:
-                    var tuser = res[this._infosmapping[68]];
-                    var user = tuser[tuser.length-1];
-                    user.middlename = br.readString();
-                    break;
-                case Const.isc_spb_sec_lastname:
-                    var tuser = res[this._infosmapping[68]];
-                    var user = tuser[tuser.length-1];
-                    user.lastname = br.readString();
-                    break;
-                case Const.isc_spb_sec_groupid:
-                    var tuser = res[this._infosmapping[68]];
-                    var user = tuser[tuser.length-1];
-                    user.groupid = br.readInt32();
-                    break;
-                case Const.isc_spb_sec_userid:
-                    var tuser = res[this._infosmapping[68]];
-                    var user = tuser[tuser.length-1];
-                    user.userid = br.readInt32();
-    
-                    break;
-                case Const.isc_spb_sec_admin:
-                    var tuser = res[this._infosmapping[68]];
-                    var user = tuser[tuser.length-1];
-                    user.admin = br.readInt32();
-                    break;
-    
-                case Const.isc_info_svc_line:
-                    res.line = br.readString();
-                    break;
-    
-                case Const.isc_info_svc_to_eof:
-                    res.line = br.readString();
-                    break;
-    
-                case Const.isc_info_truncated:
-                    res.result = 1; // too much data for the result buffer increase size of it (buffersize parameter))
-                    break;
-    
-                case Const.isc_info_data_not_ready:
-                    res.result = 2;
-                    break;
-    
-                case Const.isc_info_svc_timeout:
-                    res.result = 3;
-                    break;
-    
-                case Const.isc_info_svc_stdin:
-    
-                    break;
-    
-                case Const.isc_info_svc_capabilities:
-                    this._processcapabilities(br, res);
-                    break;
+                    case Const.isc_info_svc_version:
+                        res[this._infosmapping[tinfo]] = br.readInt32();
+                        break;
+                    case Const.isc_info_svc_svr_db_info:
+                        this._processdbinfo(br, res);
+                        break;
+                    case Const.isc_info_svc_limbo_trans:
+                        // not implemented
+                        for (; tinfo !== isc_info_flag_end; tinfo = br.readByteCode())
+                            break;
+                    case Const.isc_info_svc_get_users:
+                        br.pos += 2
+                        res[this._infosmapping[tinfo]] = [];
+                        break;
+                    case Const.isc_spb_sec_username:
+                        var tuser = res[this._infosmapping[68]];
+                        tuser.push({});
+                        tuser[tuser.length - 1].username = br.readString();
+                        break;
+                    case Const.isc_spb_sec_firstname:
+                        var tuser = res[this._infosmapping[68]];
+                        var user = tuser[tuser.length-1];
+                        user.firstname = br.readString();
+                        break;
+                    case Const.isc_spb_sec_middlename:
+                        var tuser = res[this._infosmapping[68]];
+                        var user = tuser[tuser.length-1];
+                        user.middlename = br.readString();
+                        break;
+                    case Const.isc_spb_sec_lastname:
+                        var tuser = res[this._infosmapping[68]];
+                        var user = tuser[tuser.length-1];
+                        user.lastname = br.readString();
+                        break;
+                    case Const.isc_spb_sec_groupid:
+                        var tuser = res[this._infosmapping[68]];
+                        var user = tuser[tuser.length-1];
+                        user.groupid = br.readInt32();
+                        break;
+                    case Const.isc_spb_sec_userid:
+                        var tuser = res[this._infosmapping[68]];
+                        var user = tuser[tuser.length-1];
+                        user.userid = br.readInt32();
+        
+                        break;
+                    case Const.isc_spb_sec_admin:
+                        var tuser = res[this._infosmapping[68]];
+                        var user = tuser[tuser.length-1];
+                        user.admin = br.readInt32();
+                        break;
+        
+                    case Const.isc_info_svc_line:
+                        res.line = br.readString();
+                        break;
+        
+                    case Const.isc_info_svc_to_eof:
+                        res.line = br.readString();
+                        break;
+        
+                    case Const.isc_info_truncated:
+                        res.result = 1; // too much data for the result buffer increase size of it (buffersize parameter))
+                        break;
+        
+                    case Const.isc_info_data_not_ready:
+                        res.result = 2;
+                        break;
+        
+                    case Const.isc_info_svc_timeout:
+                        res.result = 3;
+                        break;
+        
+                    case Const.isc_info_svc_stdin:
+        
+                        break;
+        
+                    case Const.isc_info_svc_capabilities:
+                        this._processcapabilities(br, res);
+                        break;
+                }
             }
+            callback(null, res);
+        } catch (err) {
+            doError(new Error('Malformed service-manager response: ' + err.message), callback);
         }
-        callback(null, res);
     }
 
     detach(callback, force) {
@@ -1047,4 +1055,4 @@ class ServiceManager extends Events.EventEmitter {
 ServiceManager.ShutdownMode = ShutdownMode;
 ServiceManager.ShutdownKind = ShutdownKind;
 
-module.exports = ServiceManager;
+module.exports = ServiceManager;

package/lib/wire/statement.js

@@ -25,15 +25,15 @@ class Statement {
             this.connection.dropStatement(this, callback);
     }
 
-    execute(transaction, params, callback, custom) {
+    execute(transaction, params, callback, options) {
         if (params instanceof Function) {
-            custom = callback;
+            options = callback;
             callback = params;
             params = undefined;
         }
 
-        this.custom = custom;
-        this.connection.executeStatement(transaction, this, params, callback, custom);
+        this.options = options;
+        this.connection.executeStatement(transaction, this, params, callback, options);
     }
 
     fetch(transaction, count, callback) {

package/lib/wire/transaction.js

@@ -25,9 +25,9 @@ class Transaction {
         }
     }
 
-    execute(query, params, callback, custom) {
+    execute(query, params, callback, options) {
         if (params instanceof Function) {
-            custom = callback;
+            options = callback;
             callback = params;
             params = undefined;
         }
@@ -100,13 +100,13 @@ class Transaction {
                         break;
                 }
 
-            }, custom);
+            }, options);
         });
     }
 
-    sequentially(query, params, on, callback, asArray) {
+    sequentially(query, params, on, callback, options = {}) {
         if (params instanceof Function) {
-            asArray = callback;
+            options = callback;
             callback = on;
             on = params;
             params = undefined;
@@ -117,7 +117,7 @@ class Transaction {
         }
 
         if (callback instanceof Boolean) {
-            asArray = callback;
+            options = callback;
             callback = undefined;
         }
 
@@ -152,11 +152,23 @@ class Transaction {
             }
         };
 
-        self.execute(query, params, callback, { asObject: !asArray, asStream: true, on: _on });
+        // back compatibility - options parameter is a boolean
+        if (typeof options === 'boolean') {
+            options = { asObject: !options, asStream: true, on: _on };
+        } else {
+            options = {
+                asStream: true,
+                asObject: true,
+                on: _on,
+                ...options,
+            };
+        }
+
+        self.execute(query, params, callback, options);
         return self;
     }
 
-    query(query, params, callback) {
+    query(query, params, callback, options = {}) {
         if (params instanceof Function) {
             callback = params;
             params = undefined;
@@ -165,7 +177,13 @@ class Transaction {
         if (callback === undefined)
             callback = noop;
 
-        this.execute(query, params, callback, { asObject: true, asStream: callback === undefined || callback === null });
+        options = {
+            asObject: true,
+            asStream: callback === undefined || callback === null,
+            ...options,
+        };
+
+        this.execute(query, params, callback, options);
     }
 
     commit(callback) {

package/lib/wire/xsqlvar.js

@@ -199,6 +199,44 @@ class SQLVarInt128 {
 
 //------------------------------------------------------
 
+class SQLVarDecFloat16 {
+    decode(data, lowerV13) {
+        var ret = data.readDecFloat16();
+
+        if (!lowerV13 || !data.readInt()) {
+            return ret;
+        }
+
+        return null;
+    }
+
+    calcBlr(blr) {
+        blr.addByte(Const.blr_dec64);
+        blr.addShort(0);
+    }
+}
+
+//------------------------------------------------------
+
+class SQLVarDecFloat34 {
+    decode(data, lowerV13) {
+        var ret = data.readDecFloat34();
+
+        if (!lowerV13 || !data.readInt()) {
+            return ret;
+        }
+
+        return null;
+    }
+
+    calcBlr(blr) {
+        blr.addByte(Const.blr_dec128);
+        blr.addShort(0);
+    }
+}
+
+//------------------------------------------------------
+
 class SQLVarFloat {
     decode(data, lowerV13) {
         var ret = data.readFloat();
@@ -295,6 +333,92 @@ class SQLVarTimeStamp {
 
 //------------------------------------------------------
 
+class SQLVarTimeTz {
+    decode(data, lowerV13) {
+        var time = data.readUInt();
+        data.readInt(); // skip timezone info
+
+        if (!lowerV13 || !data.readInt()) {
+            var d = new Date(0);
+            d.setMilliseconds(Math.floor(time / 10) + d.getTimezoneOffset() * MsPerMinute);
+            return d;
+        }
+        return null;
+    }
+
+    calcBlr(blr) {
+        blr.addByte(Const.blr_sql_time_tz);
+    }
+}
+
+//------------------------------------------------------
+
+class SQLVarTimeTzEx extends SQLVarTimeTz {
+    decode(data, lowerV13) {
+        var time = data.readUInt();
+        data.readInt(); // skip timezone info
+        data.readInt(); // skip ext_offset
+
+        if (!lowerV13 || !data.readInt()) {
+            var d = new Date(0);
+            d.setMilliseconds(Math.floor(time / 10) + d.getTimezoneOffset() * MsPerMinute);
+            return d;
+        }
+        return null;
+    }
+
+    calcBlr(blr) {
+        blr.addByte(Const.blr_ex_time_tz);
+    }
+}
+
+//------------------------------------------------------
+
+class SQLVarTimeStampTz {
+    decode(data, lowerV13) {
+        var date = data.readInt();
+        var time = data.readUInt();
+        data.readInt(); // skip timezone info
+
+        if (!lowerV13 || !data.readInt()) {
+            var d = new Date(0);
+            d.setMilliseconds((date - DateOffset) * TimeCoeff + Math.floor(time / 10) + d.getTimezoneOffset() * MsPerMinute);
+            return d;
+        }
+
+        return null;
+    }
+
+    calcBlr(blr) {
+        blr.addByte(Const.blr_timestamp_tz);
+    }
+}
+
+//------------------------------------------------------
+
+class SQLVarTimeStampTzEx extends SQLVarTimeStampTz {
+    decode(data, lowerV13) {
+        var date = data.readInt();
+        var time = data.readUInt();
+        data.readInt(); // skip timezone info
+        data.readInt(); // skip ext_offset
+
+        if (!lowerV13 || !data.readInt()) {
+            var d = new Date(0);
+            d.setMilliseconds((date - DateOffset) * TimeCoeff + Math.floor(time / 10) + d.getTimezoneOffset() * MsPerMinute);
+            return d;
+        }
+
+        return null;
+    }
+
+    calcBlr(blr) {
+        blr.addByte(Const.blr_ex_timestamp_tz);
+    }
+}
+
+//------------------------------------------------------
+
 class SQLVarBoolean {
     decode(data, lowerV13) {
         var ret = data.readInt();
@@ -378,6 +502,50 @@ class SQLParamInt128 {
 
 //------------------------------------------------------
 
+class SQLParamDecFloat16 {
+    constructor(value) {
+        this.value = value;
+    }
+
+    calcBlr(blr) {
+        blr.addByte(Const.blr_dec64);
+        blr.addShort(0);
+    }
+
+    encode(data) {
+        if (this.value != null) {
+            data.addDecFloat16(this.value);
+        } else {
+            data.addDecFloat16(0);
+            data.addInt(1);
+        }
+    }
+}
+
+//------------------------------------------------------
+
+class SQLParamDecFloat34 {
+    constructor(value) {
+        this.value = value;
+    }
+
+    calcBlr(blr) {
+        blr.addByte(Const.blr_dec128);
+        blr.addShort(0);
+    }
+
+    encode(data) {
+        if (this.value != null) {
+            data.addDecFloat34(this.value);
+        } else {
+            data.addDecFloat34(0);
+            data.addInt(1);
+        }
+    }
+}
+
+//------------------------------------------------------
+
 class SQLParamDouble {
     constructor(value) {
         this.value = value;
@@ -509,6 +677,8 @@ module.exports = {
     SQLVarInt,
     SQLVarInt64,
     SQLVarInt128,
+    SQLVarDecFloat16,
+    SQLVarDecFloat34,
     SQLVarFloat,
     SQLVarNull,
     SQLVarShort,
@@ -516,12 +686,18 @@ module.exports = {
     SQLVarText,
     SQLVarTime,
     SQLVarTimeStamp,
+    SQLVarTimeTz,
+    SQLVarTimeTzEx,
+    SQLVarTimeStampTz,
+    SQLVarTimeStampTzEx,
     SQLParamBool,
     SQLParamDate,
     SQLParamDouble,
     SQLParamInt,
     SQLParamInt64,
     SQLParamInt128,
+    SQLParamDecFloat16,
+    SQLParamDecFloat34,
     SQLParamQuad,
     SQLParamString,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-firebird",
-    "version": "2.0.2",
+    "version": "2.3.0",
     "description": "Pure JavaScript and Asynchronous Firebird client for Node.js.",
     "keywords": [
         "firebird",
@@ -25,15 +25,15 @@
     "types": "./lib/index.d.ts",
     "license": "MPL-2.0",
     "scripts": {
-        "test": "vitest run"
+        "test": "vitest run",
+        "lint": "oxlint"
     },
     "dependencies": {
-        "big-integer": "^1.6.51",
         "long": "^5.2.3"
     },
     "devDependencies": {
-        "coveralls-next": "^4.2.0",
-        "nyc": "^15.0.1",
+        "coveralls-next": "^6.0.1",
+        "oxlint": "^0.15.11",
         "vitest": "^4.0.18"
     }
 }

package/vitest.config.js

@@ -8,6 +8,17 @@ module.exports = defineConfig({
         fileParallelism: false,
         maxWorkers: 1,
         isolate: false,
-        include: ['test/arc4.js', 'test/protocol.js', 'test/srp.js', 'test/service.js', 'test/utf8-user-identification.js', 'test/index.js', 'test/db-crypt-config.js'],
+        include: [
+            'test/arc4.js',
+            'test/protocol.js',
+            'test/srp.js',
+            'test/service.js',
+            'test/utf8-user-identification.js',
+            'test/index.js',
+            'test/db-crypt-config.js',
+            'test/timezone.js',
+            'test/decfloat.js',
+            'test/mock-server.js'
+        ],
     },
 });

package/Roadmap.md

@@ -1,80 +0,0 @@
-# Node-Firebird Roadmap
-
-This document outlines the future development direction for the `node-firebird` library. Our primary goals are to modernize the codebase, implement support for the latest Firebird features, and improve the overall developer experience.
-
-## Protocol Implementation Status
-
-The following table summarizes the current and planned implementation status of the Firebird wire protocol for each major version.
-
-| Firebird Version | Protocol Versions | Status |
-| :--- | :--- | :--- |
-| 2.5 | 10, 11, 12, 13 | ✅ Implemented |
-| 3.0 | 14, 15 | ✅ Implemented |
-| 4.0 | 16, 17 | ❌ Not Implemented |
-| 5.0 | N/A | ❌ Not Implemented |
-| 6.0 | N/A | ❌ Not Implemented |
-
-## Firebird 3 Support
-
-Firebird 3 introduced Protocol 13, which brought significant changes focusing on security and performance. The following features have been implemented:
-
-- **Protocol Versions 14 and 15:** ✅ Implemented - newer wire protocol versions are now supported.
-- **Enhanced Authentication:** ✅ Implemented - Srp256 (SHA-256) authentication plugin is now supported alongside Srp (SHA-1) and Legacy_Auth.
-- **Wire Protocol Encryption:** ✅ Implemented - Arc4 (RC4) stream cipher encryption for all network traffic using SRP session keys.
-- **Wire Protocol Compression:** ✅ Implemented - zlib compression support for protocol version 13+.
-- **Packed (NULL-aware) Row Data:** ✅ Implemented - null bitmap support for protocol version 13+.
-- **op_cond_accept Handling:** ✅ Implemented - proper handling of conditional accept with authentication continuation.
-- **UTF-8 User Identification:** ✅ Implemented - all user identification is properly handled with UTF-8 encoding via `isc_dpb_utf8_filename` flag for Firebird 3+.
-- **Database Encryption Callback:** ✅ Implemented - support for database encryption key callback (`op_crypt_key_callback`) during the connect phase, allowing connections to encrypted databases. The `dbCryptConfig` connection option supports both plain text and base64-encoded encryption keys.
-
-The following features are planned for future implementation:
-
-## Firebird 4 Support
-
-Firebird 4 introduced Protocol versions 16 and 17, continuing to build upon the foundation of Firebird 3. Key features to implement include:
-
-- **Protocol Versions 16 and 17:** Implement the latest protocol versions to support Firebird 4 features.
-
-## Firebird 5 Support
-
-Firebird 5 introduces a host of new SQL features and performance improvements that will require significant client-side implementation:
-
-- **Bidirectional Cursors:** Implement support for scrollable cursors for remote database access.
-- **`RETURNING` Multiple Rows:** Enhance DML operations to support returning multiple rows.
-- **`SKIP LOCKED`:** Add support for the `SKIP LOCKED` clause in `SELECT WITH LOCK`, `UPDATE`, and `DELETE` statements.
-- **New Data Types and Functions:** Add support for new built-in functions and packages.
-
-## Firebird 6 and Beyond
-
-As Firebird 6 and future versions are released, we will continue to monitor new features and plan for their implementation. Key areas of interest include:
-
-- **JSON Support:** Implement client-side support for the new SQL-compliant JSON functions.
-- **Tablespaces:** Add support for tablespaces.
-- **SQL Schemas:** Implement support for SQL schemas.
-
-## Codebase Refactoring
-
-The current codebase is functional but could be significantly improved by adopting modern JavaScript and TypeScript features.
-
-### Modern JavaScript Classes
-
-The existing codebase is written in a prototype-based style. We plan to refactor the entire library to use modern JavaScript classes (`class` syntax). This will improve readability, maintainability, and make the code easier to understand for new contributors.
-
-**Benefits:**
-
-- Improved code structure and organization.
-- Easier to reason about inheritance and object-oriented patterns.
-- Better alignment with modern JavaScript best practices.
-
-### TypeScript Rewrite
-
-A full rewrite of the library in TypeScript is a long-term goal. This would bring the benefits of static typing, improved developer tooling, and a more robust codebase.
-
-**Benefits:**
-
-- **Type Safety:** Catch errors at compile-time instead of runtime.
-- **Improved Autocomplete:** Better editor support and developer experience.
-- **Self-documenting Code:** Types make the code easier to understand and use.
-- **Easier Refactoring:** Static analysis makes it easier to refactor code with confidence.
-
-We believe these changes will make `node-firebird` a more robust, modern, and developer-friendly library for accessing Firebird databases.