node-firebird 2.0.1 → 2.2.0

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.

package/diff

@@ -1,62 +0,0 @@
-diff --git a/lib/wire/database.js b/lib/wire/database.js
-index d91b9db..a9f3128 100644
---- a/lib/wire/database.js
-+++ b/lib/wire/database.js
-@@ -5,6 +5,46 @@ const Const = require('./const');
- const EventConnection = require('./eventConnection');
- const FbEventManager = require('./fbEventManager');
- 
-+/**
-+ * Resolves the host to use for the auxiliary event channel.
-+ *
-+ * Priority:
-+ *   1. connection.options.host  – explicitly provided by the caller; known reachable.
-+ *   2. socket_info.host         – only when it is a concrete routable address
-+ *                                 (i.e. not "0.0.0.0" and not "::").
-+ *   3. socket.remoteAddress     – the OS-level address of the main connection socket,
-+ *                                 with IPv6-mapped IPv4 prefixes stripped.
-+ *
-+ * @param {object} connection   The active database connection object.
-+ * @param {string} auxHost      The host returned by the auxConnection() call.
-+ * @returns {string}            A connectable host string.
-+ */
-+function resolveEventHost(connection, auxHost) {
-+    // 1. Prefer the host the caller explicitly supplied.
-+    if (connection.options && connection.options.host) {
-+        return connection.options.host;
-+    }
-+
-+    // 2. Use auxConnection host only when it is a real address.
-+    var BIND_ANY = ['0.0.0.0', '::'];
-+    if (auxHost && BIND_ANY.indexOf(auxHost) === -1) {
-+        return auxHost;
-+    }
-+
-+    // 3. Fall back to the OS-reported remote address of the main socket,
-+    //    normalising IPv6-mapped IPv4 (e.g. "::ffff:10.0.0.1" → "10.0.0.1").
-+    var remoteAddress = connection._socket && connection._socket.remoteAddress;
-+    if (remoteAddress) {
-+        return remoteAddress.replace(/^::ffff:/, '');
-+    }
-+
-+    // Last resort: return whatever auxConnection gave us and let the caller fail
-+    // with a meaningful socket error rather than a silent undefined.
-+    return auxHost;
-+}
-+
-+
-+
- /***************************************
-  *
-  *   Database
-@@ -279,8 +319,9 @@ class Database extends Events.EventEmitter {
-                 doError(err, callback);
-                 return;
-             }
-+            var eventHost = resolveEventHost(self.connection, socket_info.host);
- 
--            const eventConnection = new EventConnection(socket_info.host, socket_info.port, function (err) {
-+            const eventConnection = new EventConnection(eventHost, socket_info.port, function (err) {
-                 if (err) {
-                     doError(err, callback);
-                     return;