node-firebird 2.4.0 → 2.4.2

package/README.md

@@ -6,29 +6,25 @@
 
 [![NPM](https://nodei.co/npm/node-firebird.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-firebird/)
 
-[Firebird forum](https://groups.google.com/forum/#!forum/node-firebird) on Google Groups.
-
-## Firebird database on social networks
-
-- [Firebird on Twitter](https://twitter.com/firebirdsql/)
-- [Firebird on Facebook](https://www.facebook.com/FirebirdSQL)
-
-## Changelog for version v0.2.x
-
-- added auto-reconnect
-- added [sequentially selects](https://github.com/hgourvest/node-firebird/wiki/What-is-sequentially-selects)
-- events for connection (attach, detach, row, result, transaction, commit, rollback, error, etc.)
-- performance improvements
-- supports inserting/updating buffers and streams
-- reading blobs (sequentially)
-- pooling
-- `database.detach()` waits for last command
-- better unit-test
-
----
-
-- [Firebird documentation](https://firebirdsql.org/en/documentation/)
-- [Firebird limits and data types](https://firebirdsql.org/en/firebird-technical-specifications/)
+## Table of contents
+
+- [Installation](#installation)
+- [Usage](#usage) — including [developing the driver](#developing-the-driver)
+- [Connection types](#connection-types) — connection options, classic connections, pooling
+- [Database object (db)](#database-object-db) — database, transaction and statement methods/options
+- [Examples](#examples) — parametrized queries, BLOBs, streaming big data, transactions, driver events, database events (POST_EVENT), service manager, charsets/encoding, Firebird 3.0–6.0 features
+- [Extensive Examples](#extensive-examples) — DECFLOAT/INT128, statement timeouts, scrollable cursors, RETURNING multiple rows, SKIP LOCKED, advanced pooling
+- [Using node-firebird with Express.js](#using-node-firebird-with-expressjs)
+- [FAQ](#faq)
+- [Contributing](#contributing) · [Contributors](#contributors)
+
+## Community & resources
+
+- [Firebird forum](https://groups.google.com/forum/#!forum/node-firebird) on Google Groups — questions and discussion
+- [GitHub issues](https://github.com/hgourvest/node-firebird/issues) — bug reports and feature requests
+- [ROADMAP](ROADMAP.md) — planned work and protocol implementation status
+- Driver internals: [SRP authentication protocol](docs/SRP_PROTOCOL.md) · [database encryption key callback](docs/ENCRYPTION_CALLBACK.md)
+- Firebird itself: [documentation](https://firebirdsql.org/en/documentation/) · [limits and data types](https://firebirdsql.org/en/firebird-technical-specifications/) · [Twitter/X](https://twitter.com/firebirdsql/) · [Facebook](https://www.facebook.com/FirebirdSQL)
 
 ## Installation
 
@@ -36,6 +32,10 @@
 npm install node-firebird
 ```
 
+The driver is pure JavaScript at runtime — no native addons and no runtime
+dependencies. Node.js 20 or newer is supported (CI runs on Node 20, 22, 24
+and 26 against Firebird 3, 4, 5 and 6).
+
 ## Usage
 
 ```js
@@ -50,21 +50,47 @@ import * as Firebird from 'node-firebird';
 import type { Options, Database } from 'node-firebird';
 ```
 
-### Development
+### Developing the driver
+
+Since v2.4.0 the driver is written in TypeScript and compiled with the native
+TypeScript 7 compiler (`tsc`). The published package ships both the compiled
+output and the sources.
+
+**Requirements**
 
-The sources live in `src/` (TypeScript) and are compiled to `lib/` (CommonJS +
-`.d.ts`) by the native TypeScript 7 compiler:
+- Node.js >= 20 (CI matrix: 20, 22, 24, 26)
+- npm (TypeScript 7 and all tooling are installed as devDependencies — no
+  global installs needed)
+- a Firebird server on `127.0.0.1:3050` with `SYSDBA`/`masterkey` for the
+  integration tests (CI tests against Firebird 3, 4, 5 and 6-snapshot); the
+  unit tests under `test/unit/` run without a server
+
+The quickest way to get a test server is Docker:
+
+```bash
+docker run -d --name firebird -p 3050:3050 \
+  -e FIREBIRD_ROOT_PASSWORD=masterkey \
+  firebirdsql/firebird:5
+```
+
+**Layout**
+
+- `src/` — the TypeScript sources; this is what you edit
+- `lib/` — compiled CommonJS + generated `.d.ts` declarations; build output,
+  gitignored — never edit it by hand
+- `test/` — vitest suite (integration tests at the top level, server-free
+  tests in `test/unit/`)
+
+**Workflow**
 
 ```bash
 npm install        # installs deps and builds lib/ via the prepare script
 npm run build      # compile src/ -> lib/
-npm run typecheck  # type-check sources and unit tests without emitting
+npm run typecheck  # type-check sources and tests without emitting
+npm run lint       # oxlint
 npm test           # build + run the vitest suite (unit + integration)
 ```
 
-The integration tests expect a Firebird server on `127.0.0.1:3050`
-(SYSDBA/masterkey); the unit tests under `test/unit/` run without a server.
-
 ### Methods
 
 - `Firebird.escape(value) -> return {String}` - prevent for SQL Injections
@@ -1506,11 +1532,27 @@ db.query('SELECT * FROM ACTORS WHERE NAME LIKE ?', ['James Wick%'], function (er
 });
 ```
 
+## Contributing
+
+Contributions are welcome — code, documentation, and bug reports alike.
+
+- **Found a bug or have a question?** Open a [GitHub issue](https://github.com/hgourvest/node-firebird/issues). Please include your Node.js version, your Firebird server version, and a minimal reproduction (SQL plus code).
+- **Want to write code?** See [Developing the driver](#developing-the-driver) for the build and test setup, and the [ROADMAP](ROADMAP.md) for ideas on what to pick up. Pull requests against `master` should come with tests and pass `npm test`, `npm run typecheck` and `npm run lint`.
+- **Improving the documentation** is just as valuable — clearer examples and FAQ entries help everyone.
+
 ## Contributors
 
-- Henri Gourvest, <https://github.com/hgourvest>
-- Popa Marius Adrian, <https://github.com/mariuz>
-- Peter Širka, <https://github.com/petersirka>
+`node-firebird` was created by **Henri Gourvest** and is maintained by **Popa Marius Adrian**, with major early contributions from **Peter Širka** (pooling, sequential selects, driver events).
+
+- Henri Gourvest — author, <https://github.com/hgourvest>
+- Popa Marius Adrian — maintainer, <https://github.com/mariuz>
+- Peter Širka — <https://github.com/petersirka>
+
+…and many more — see the full [list of contributors](https://github.com/hgourvest/node-firebird/graphs/contributors).
+
+<a href="https://github.com/hgourvest/node-firebird/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=hgourvest/node-firebird" alt="Contributors" />
+</a>
 
 [license-image]: http://img.shields.io/badge/license-MOZILLA-blue.svg?style=flat
 [license-url]: LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-firebird",
-    "version": "2.4.0",
+    "version": "2.4.2",
     "description": "Pure JavaScript and Asynchronous Firebird client for Node.js.",
     "keywords": [
         "firebird",