@stoolap/node 0.3.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Stoolap Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,411 @@
+# @stoolap/node
+
+High-performance Node.js driver for [Stoolap](https://github.com/stoolap/stoolap) — a modern embedded SQL database with MVCC, time-travel queries, and full ACID compliance.
+
+Built with [NAPI-RS](https://napi.rs) for native performance. Provides both async and sync APIs with direct V8 object creation for minimal overhead.
+
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Node](https://img.shields.io/badge/node-%3E%3D22-brightgreen.svg)](https://nodejs.org)
+
+## Installation
+
+```bash
+npm install @stoolap/node
+```
+
+Pre-built binaries are available for:
+- macOS (x64, ARM64)
+- Linux (x64, ARM64 GNU)
+- Windows (x64 MSVC)
+
+## Quick Start
+
+```js
+// ESM
+import { Database } from '@stoolap/node';
+
+// CommonJS
+const { Database } = require('@stoolap/node');
+```
+
+```js
+const db = await Database.open(':memory:');
+
+await db.exec(`
+  CREATE TABLE users (
+    id INTEGER PRIMARY KEY,
+    name TEXT NOT NULL,
+    email TEXT
+  )
+`);
+
+// Insert with positional parameters ($1, $2, ...)
+await db.execute(
+  'INSERT INTO users (id, name, email) VALUES ($1, $2, $3)',
+  [1, 'Alice', 'alice@example.com']
+);
+
+// Insert with named parameters (:key)
+await db.execute(
+  'INSERT INTO users (id, name, email) VALUES (:id, :name, :email)',
+  { id: 2, name: 'Bob', email: 'bob@example.com' }
+);
+
+// Query rows as objects
+const users = await db.query('SELECT * FROM users ORDER BY id');
+// [{ id: 1, name: 'Alice', email: 'alice@example.com' }, ...]
+
+// Query single row
+const user = await db.queryOne('SELECT * FROM users WHERE id = $1', [1]);
+// { id: 1, name: 'Alice', email: 'alice@example.com' }
+
+// Query in raw columnar format (faster — no per-row object creation)
+const raw = await db.queryRaw('SELECT id, name FROM users ORDER BY id');
+// { columns: ['id', 'name'], rows: [[1, 'Alice'], [2, 'Bob']] }
+
+await db.close();
+```
+
+## API
+
+### Database
+
+```js
+// In-memory
+const db = await Database.open(':memory:');
+const db = await Database.open('');
+const db = await Database.open('memory://');
+
+// File-based (data persists across restarts)
+const db = await Database.open('./mydata');
+const db = await Database.open('file:///absolute/path/to/db');
+```
+
+#### Async Methods
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `execute(sql, params?)` | `Promise<RunResult>` | Execute DML statement |
+| `exec(sql)` | `Promise<void>` | Execute one or more statements |
+| `query(sql, params?)` | `Promise<Object[]>` | Query rows as objects |
+| `queryOne(sql, params?)` | `Promise<Object \| null>` | Query single row |
+| `queryRaw(sql, params?)` | `Promise<{columns, rows}>` | Query in columnar format |
+| `begin()` | `Promise<Transaction>` | Begin a transaction |
+| `close()` | `Promise<void>` | Close the database |
+
+#### Sync Methods
+
+Sync methods run on the main thread — faster for simple operations but block the event loop.
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `executeSync(sql, params?)` | `RunResult` | Execute DML statement |
+| `execSync(sql)` | `void` | Execute one or more statements |
+| `querySync(sql, params?)` | `Object[]` | Query rows as objects |
+| `queryOneSync(sql, params?)` | `Object \| null` | Query single row |
+| `queryRawSync(sql, params?)` | `{columns, rows}` | Query in columnar format |
+| `executeBatchSync(sql, paramsArray)` | `RunResult` | Execute with multiple param sets |
+| `beginSync()` | `Transaction` | Begin a transaction |
+| `prepare(sql)` | `PreparedStatement` | Create a prepared statement |
+
+`RunResult` is `{ changes: number }`. It can be imported as a type:
+
+```ts
+import { Database, RunResult } from '@stoolap/node';
+```
+
+#### Persistence
+
+File-based databases persist data to disk using WAL (Write-Ahead Logging) and periodic snapshots. Data survives process restarts.
+
+```js
+const db = await Database.open('./mydata');
+
+await db.exec('CREATE TABLE kv (key TEXT PRIMARY KEY, value TEXT)');
+await db.execute('INSERT INTO kv VALUES ($1, $2)', ['hello', 'world']);
+await db.close();
+
+// Reopen — data is still there
+const db2 = await Database.open('./mydata');
+const row = await db2.queryOne('SELECT * FROM kv WHERE key = $1', ['hello']);
+// { key: 'hello', value: 'world' }
+await db2.close();
+```
+
+##### Configuration
+
+Pass configuration as query parameters in the path:
+
+```js
+// Maximum durability — fsync on every WAL write
+const db = await Database.open('./mydata?sync=full');
+
+// High throughput — no fsync, larger buffers
+const db = await Database.open('./mydata?sync=none&wal_buffer_size=131072');
+
+// Custom snapshot interval with compression
+const db = await Database.open('./mydata?snapshot_interval=60&compression=on');
+
+// Multiple options
+const db = await Database.open(
+  './mydata?sync=full&snapshot_interval=120&keep_snapshots=10&wal_max_size=134217728'
+);
+```
+
+##### Sync Modes
+
+Controls the durability vs. performance trade-off:
+
+| Mode | Value | Description |
+|------|-------|-------------|
+| `none` | `sync=none` | No fsync — fastest, data may be lost on crash |
+| `normal` | `sync=normal` | Fsync on commit batches — good balance (default) |
+| `full` | `sync=full` | Fsync on every WAL write — slowest, maximum durability |
+
+##### All Configuration Parameters
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `sync` | `normal` | Sync mode: `none`, `normal`, or `full` |
+| `snapshot_interval` | `300` | Seconds between automatic snapshots (5 min) |
+| `keep_snapshots` | `5` | Number of snapshot files to retain |
+| `wal_flush_trigger` | `32768` | WAL flush trigger size in bytes (32 KB) |
+| `wal_buffer_size` | `65536` | WAL buffer size in bytes (64 KB) |
+| `wal_max_size` | `67108864` | Max WAL file size before rotation (64 MB) |
+| `commit_batch_size` | `100` | Commits to batch before syncing (normal mode) |
+| `sync_interval_ms` | `10` | Minimum ms between syncs (normal mode) |
+| `wal_compression` | `on` | LZ4 compression for WAL entries |
+| `snapshot_compression` | `on` | LZ4 compression for snapshots |
+| `compression` | — | Set both `wal_compression` and `snapshot_compression` |
+| `compression_threshold` | `64` | Minimum bytes before compressing an entry |
+
+#### Raw Query Format
+
+`queryRaw` / `queryRawSync` return `{ columns: string[], rows: any[][] }` instead of an array of objects. Faster when you don't need named keys.
+
+```js
+const raw = db.queryRawSync('SELECT id, name, email FROM users ORDER BY id');
+console.log(raw.columns); // ['id', 'name', 'email']
+console.log(raw.rows);    // [[1, 'Alice', 'alice@example.com'], [2, 'Bob', 'bob@example.com']]
+```
+
+#### Batch Execution
+
+Execute the same SQL with multiple parameter sets in a single call. Automatically wraps in a transaction.
+
+```js
+const result = db.executeBatchSync(
+  'INSERT INTO users VALUES ($1, $2, $3)',
+  [
+    [1, 'Alice', 'alice@example.com'],
+    [2, 'Bob', 'bob@example.com'],
+    [3, 'Charlie', 'charlie@example.com'],
+  ]
+);
+console.log(result.changes); // 3
+```
+
+### PreparedStatement
+
+Prepared statements parse SQL once and reuse the cached execution plan on every call — no parsing or cache lookup overhead per execution.
+
+```js
+const insert = db.prepare('INSERT INTO users VALUES ($1, $2, $3)');
+insert.executeSync([1, 'Alice', 'alice@example.com']);
+insert.executeSync([2, 'Bob', 'bob@example.com']);
+
+const lookup = db.prepare('SELECT * FROM users WHERE id = $1');
+const user = lookup.queryOneSync([1]);
+// { id: 1, name: 'Alice', email: 'alice@example.com' }
+```
+
+#### Methods
+
+All methods mirror `Database` but without the `sql` parameter (it's bound at prepare time).
+
+| Async | Sync | Description |
+|-------|------|-------------|
+| `execute(params?)` | `executeSync(params?)` | Execute DML statement |
+| `query(params?)` | `querySync(params?)` | Query rows as objects |
+| `queryOne(params?)` | `queryOneSync(params?)` | Query single row |
+| `queryRaw(params?)` | `queryRawSync(params?)` | Query in columnar format |
+| | `executeBatchSync(paramsArray)` | Execute with multiple param sets |
+
+Property: `sql` — returns the SQL text of this prepared statement.
+
+#### Async Prepared Statement
+
+```js
+const stmt = db.prepare('SELECT * FROM users WHERE id = $1');
+
+const rows = await stmt.query([1]);
+const one = await stmt.queryOne([1]);
+const raw = await stmt.queryRaw([1]);
+const result = await stmt.execute([1]); // for DML
+```
+
+#### Sync Prepared Statement
+
+```js
+const stmt = db.prepare('SELECT * FROM users WHERE id = $1');
+
+const rows = stmt.querySync([1]);
+const one = stmt.queryOneSync([1]);
+const raw = stmt.queryRawSync([1]);
+const result = stmt.executeSync([1]); // for DML
+```
+
+#### Batch with Prepared Statement
+
+```js
+const insert = db.prepare('INSERT INTO users VALUES ($1, $2, $3)');
+const result = insert.executeBatchSync([
+  [1, 'Alice', 'alice@example.com'],
+  [2, 'Bob', 'bob@example.com'],
+  [3, 'Charlie', 'charlie@example.com'],
+]);
+console.log(result.changes); // 3
+```
+
+### Transaction
+
+#### Methods
+
+| Async | Sync | Description |
+|-------|------|-------------|
+| `execute(sql, params?)` | `executeSync(sql, params?)` | Execute DML statement |
+| `query(sql, params?)` | `querySync(sql, params?)` | Query rows as objects |
+| `queryOne(sql, params?)` | `queryOneSync(sql, params?)` | Query single row |
+| `queryRaw(sql, params?)` | `queryRawSync(sql, params?)` | Query in columnar format |
+| `commit()` | `commitSync()` | Commit the transaction |
+| `rollback()` | `rollbackSync()` | Rollback the transaction |
+| | `executeBatchSync(sql, paramsArray)` | Execute with multiple param sets |
+
+#### Async Transaction
+
+```js
+const tx = await db.begin();
+try {
+  await tx.execute('INSERT INTO users VALUES ($1, $2, $3)', [1, 'Alice', 'alice@example.com']);
+  await tx.execute('INSERT INTO users VALUES ($1, $2, $3)', [2, 'Bob', 'bob@example.com']);
+
+  // Read within the transaction (sees uncommitted changes)
+  const rows = await tx.query('SELECT * FROM users');
+  const one = await tx.queryOne('SELECT * FROM users WHERE id = $1', [1]);
+  const raw = await tx.queryRaw('SELECT id, name FROM users');
+
+  await tx.commit();
+} catch (e) {
+  await tx.rollback();
+  throw e;
+}
+```
+
+#### Sync Transaction
+
+```js
+const tx = db.beginSync();
+try {
+  tx.executeSync('INSERT INTO users VALUES ($1, $2, $3)', [1, 'Alice', 'alice@example.com']);
+  tx.executeSync('INSERT INTO users VALUES ($1, $2, $3)', [2, 'Bob', 'bob@example.com']);
+
+  const rows = tx.querySync('SELECT * FROM users');
+  const one = tx.queryOneSync('SELECT * FROM users WHERE id = $1', [1]);
+  const raw = tx.queryRawSync('SELECT id, name FROM users');
+
+  tx.commitSync();
+} catch (e) {
+  tx.rollbackSync();
+  throw e;
+}
+```
+
+#### Batch in Transaction
+
+```js
+const tx = db.beginSync();
+const result = tx.executeBatchSync(
+  'INSERT INTO users VALUES ($1, $2, $3)',
+  [
+    [1, 'Alice', 'alice@example.com'],
+    [2, 'Bob', 'bob@example.com'],
+  ]
+);
+tx.commitSync();
+console.log(result.changes); // 2
+```
+
+### Parameters
+
+Both positional and named parameters are supported across all methods:
+
+```js
+// Positional ($1, $2, ...)
+db.querySync('SELECT * FROM users WHERE id = $1 AND name = $2', [1, 'Alice']);
+
+// Named (:key)
+db.querySync(
+  'SELECT * FROM users WHERE id = :id AND name = :name',
+  { id: 1, name: 'Alice' }
+);
+```
+
+### Error Handling
+
+All methods throw on errors (invalid SQL, constraint violations, etc.):
+
+```js
+// Async
+try {
+  await db.execute('INSERT INTO users VALUES ($1, $2)', [1, null]); // NOT NULL violation
+} catch (err) {
+  console.error(err.message);
+}
+
+// Sync
+try {
+  db.executeSync('SELECTX * FROM users'); // syntax error
+} catch (err) {
+  console.error(err.message);
+}
+
+// Prepared statement — errors at prepare time for invalid SQL
+try {
+  db.prepare('INVALID SQL HERE');
+} catch (err) {
+  console.error(err.message);
+}
+```
+
+### Supported Types
+
+| JavaScript | Stoolap |
+|-----------|---------|
+| `number` (integer) | `INTEGER` |
+| `number` (float) | `FLOAT` |
+| `string` | `TEXT` |
+| `boolean` | `BOOLEAN` |
+| `null` / `undefined` | `NULL` |
+| `BigInt` | `INTEGER` |
+| `Date` | `TIMESTAMP` |
+| `Buffer` | `TEXT` (UTF-8) |
+| `Object` / `Array` | `JSON` (stringified) |
+
+## Building from Source
+
+Requires:
+- [Rust](https://rustup.rs) (stable)
+- [Node.js](https://nodejs.org) >= 22 (with development headers)
+- C++ compiler (for V8 helpers)
+
+```bash
+git clone https://github.com/stoolap/stoolap-node.git
+cd stoolap-node
+npm install
+npm run build
+npm test
+```
+
+## License
+
+Apache 2.0 - see [LICENSE](LICENSE) for details.