@laminardb/node 0.30.0-alpha.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 [yyyy] [name of copyright owner]
+
+   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,122 @@
+# laminardb-nodejs
+
+Embedded streaming SQL for Node.js and TypeScript. This is the official Node.js binding
+for [LaminarDB](https://github.com/laminardb/laminardb), built as a
+[napi-rs](https://napi.rs) native addon over a pinned core release — the same two-layer
+shape as [`laminardb-java`](https://github.com/laminardb/laminardb-java) and
+`laminardb-python`, adapted to Node idioms: every data-plane call is a `Promise`, Arrow
+data moves as IPC `Buffer`s, and failures throw a typed error hierarchy.
+
+Status: **alpha** — embedded MVP (Phase 1). Subscriptions (async iterators), Windows/musl
+CI, and npm distribution land over the next phases. Not yet on npm — build from source.
+
+## Quickstart
+
+```js
+import { LaminarDB } from '@laminardb/node'
+
+const conn = await LaminarDB.open()
+await conn.execute('CREATE SOURCE sensors (ts TIMESTAMP, device VARCHAR, value DOUBLE)')
+await conn.start()
+
+await conn.insert('sensors', [
+  { ts: Date.now(), device: 'd1', value: 21.5 },
+  { ts: Date.now(), device: 'd2', value: 18.25 },
+])
+
+const result = await conn.query(
+  'SELECT device, avg(value) AS avg_value FROM sensors GROUP BY device',
+)
+console.log(result.toArray()) // [{ device: 'd1', avg_value: 21.5 }, ...]
+
+await conn.close()
+```
+
+Durable embedded mode is one argument plus checkpointing:
+
+```js
+const conn = await LaminarDB.open('./data', { checkpoint: { intervalMs: 5000 } })
+```
+
+Topology DDL (`CREATE SOURCE` / `STREAM` / `SINK`) must run before `start()`; manual
+`checkpoint()` requires at least one stream or sink in the topology (the core wires the
+checkpoint coordinator only for real pipelines).
+
+## Data access
+
+- `result.toArray()` / `batch.toArray()` — row objects, no dependencies. Conventions:
+  temporal columns are **milliseconds since epoch** in and out; `Int64`/`UInt64` cross as
+  JS `BigInt`.
+- `result.toIPC()` / `batch.toIPC()` — one Arrow IPC stream `Buffer`; rehydrate with
+  [`apache-arrow`](https://www.npmjs.com/package/apache-arrow) (an optional peer
+  dependency): `tableFromIPC(result.toIPC())` or the bundled `tableFrom(result)` helper.
+- `conn.insertArrow(source, buffer)` / `writer.writeArrow(buffer)` — bulk ingestion
+  straight from Arrow IPC data.
+- `conn.writer(source)` — streaming writer with `writeRows`, `watermark`, and backpressure
+  visibility (`pending` / `capacity` / `isBackpressured`).
+
+## Subscriptions
+
+Streams and materialized views are consumable frame by frame — async-iterable first:
+
+```js
+const sub = await conn.subscribe('sensor_rollup')
+for await (const frame of sub) {
+  if (frame.kind === 'data') console.log(frame.batch.toArray())
+  else console.log('checkpoint barrier', frame.checkpointId)
+}
+```
+
+Push style delivers awaited frames to handlers (a slow handler backpressures instead of
+queueing): `conn.subscribeWith('sensor_rollup', { onData, onError, onClose })`. Streaming
+queries work the same way: `for await (const batch of conn.streamQuery(sql))`.
+
+Telemetry (`metrics()`, `sourceMetrics()`, `pipelineState()`, `pipelineWatermark()`,
+`totalEventsProcessed()`) and query cancellation (`cancelQuery(id)`) round out the runtime
+surface. Benchmark baseline: `docs/benchmarks.md`.
+
+## Errors
+
+Every failure throws a `LaminarError` subclass carrying the core's numeric `code`:
+`LaminarConnectionError` (100s), `LaminarSchemaError` (200s), `LaminarIngestionError`
+(300s), `LaminarQueryError` (400s), `LaminarSubscriptionError` (500s),
+`LaminarInternalError` (900s).
+
+```js
+try {
+  conn.insert('sensors', [{ ts: 1, device: 'd1', value: 'oops' }])
+} catch (error) {
+  if (error.code === 300) {
+    // error.message: column 'value': expected a number, got string (row 0)
+  }
+}
+```
+
+## Build from source
+
+Requires Rust stable (≥ 1.95) and Node ≥ 20 with pnpm.
+
+```sh
+just install   # pnpm install (@napi-rs/cli, vitest, prettier, typescript, apache-arrow)
+just build     # debug addon + generated loader + TypeScript layer (dist/)
+just test      # vitest suites against the built addon
+just verify    # fmt + clippy -D warnings + rust tests + build + vitest
+```
+
+The first build clones and compiles the pinned LaminarDB core (git tag in `Cargo.toml`,
+registry in `CORE_PIN.md`) — expect a long cold build.
+
+## Platform support
+
+The release matrix (Phase 3) covers macOS x64/arm64, Linux x64/arm64 (glibc and musl), and
+Windows x64, distributed as per-platform optional npm packages with no postinstall and no
+source compilation. Until then, `napi build` works anywhere the toolchain does.
+
+## Documentation
+
+- `docs/plans/` — decision records and phase plans (start at
+  `00-overview-and-decisions.md`)
+- `CORE_PIN.md` — which core release each binding version ships
+- `CHANGELOG.md`
+
+Apache-2.0, like the core.

package/dist/arrow.d.ts

@@ -0,0 +1,13 @@
+/**
+ * `apache-arrow` interop helpers (plan 00 D6).
+ *
+ * `apache-arrow` is an optional peer dependency: these helpers load it
+ * lazily and throw a clear `LaminarError` when it is absent. The IPC
+ * `Buffer` API on results/batches always works without it.
+ */
+import type { ArrowBatch, QueryResult } from './index.js';
+/**
+ * Rehydrate a whole result (or a single batch) as an `apache-arrow` `Table`
+ * via `tableFromIPC`. Requires the optional `apache-arrow` dependency.
+ */
+export declare function tableFrom(source: QueryResult | ArrowBatch): unknown;

package/dist/arrow.js

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * `apache-arrow` interop helpers (plan 00 D6).
+ *
+ * `apache-arrow` is an optional peer dependency: these helpers load it
+ * lazily and throw a clear `LaminarError` when it is absent. The IPC
+ * `Buffer` API on results/batches always works without it.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tableFrom = tableFrom;
+const errors_js_1 = require("./errors.js");
+let arrowModule;
+function arrow() {
+    if (arrowModule === undefined) {
+        try {
+            // WHY require: optional peer — load lazily so absence only fails here
+            arrowModule = require('apache-arrow');
+        }
+        catch {
+            throw new errors_js_1.LaminarInternalError('apache-arrow is not installed; add it as a dependency to use tableFrom(), or use the toIPC()/toArray() APIs', 900);
+        }
+    }
+    return arrowModule;
+}
+/**
+ * Rehydrate a whole result (or a single batch) as an `apache-arrow` `Table`
+ * via `tableFromIPC`. Requires the optional `apache-arrow` dependency.
+ */
+function tableFrom(source) {
+    return arrow().tableFromIPC(source.toIPC());
+}

package/dist/errors.d.ts

@@ -0,0 +1,53 @@
+/**
+ * The typed error hierarchy (plan 00 D2/D8).
+ *
+ * The native seam throws plain `Error`s whose message starts with
+ * `[LAMINAR_<code>]` (napi-rs 3.12 cannot carry custom codes across promise
+ * rejections — see docs/plans/01 spike results). The public API re-throws
+ * them as `LaminarError` subclasses with a real `code` property and the
+ * prefix stripped from `message`.
+ */
+/** Base class: engine or binding failure with a numeric core error code. */
+export declare class LaminarError extends Error {
+    /** Numeric code from the core taxonomy (e.g. `400`). */
+    readonly code: number;
+    /** Class name (e.g. `LaminarQueryError`). */
+    readonly codeName: string;
+    constructor(message: string, code: number, options?: {
+        cause?: unknown;
+    });
+}
+/** 100–199: connection lifecycle failures. */
+export declare class LaminarConnectionError extends LaminarError {
+}
+/** 200–299: schema and catalog failures. */
+export declare class LaminarSchemaError extends LaminarError {
+}
+/** 300–399: ingestion failures. */
+export declare class LaminarIngestionError extends LaminarError {
+}
+/** 400–499: query failures. */
+export declare class LaminarQueryError extends LaminarError {
+}
+/** 500–599: subscription failures. */
+export declare class LaminarSubscriptionError extends LaminarError {
+}
+/** 900–999: internal engine or binding failures. */
+export declare class LaminarInternalError extends LaminarError {
+}
+/**
+ * Convert a thrown native error into the typed hierarchy. Coded errors get
+ * the matching subclass with the prefix stripped; napi argument-coercion
+ * failures (below the engine layer) and anything unrecognized wrap into
+ * `LaminarInternalError` with code `900`, preserving the original as
+ * `cause`.
+ */
+export declare function toLaminarError(error: unknown): LaminarError;
+/** Run `thunk`, re-throwing any failure through {@link toLaminarError}. */
+export declare function wrapSync<T>(thunk: () => T): T;
+/**
+ * Call `work` and await its result, re-throwing both synchronous throws (napi
+ * argument coercion happens before the promise exists) and rejections through
+ * {@link toLaminarError}.
+ */
+export declare function wrapAsync<T>(work: () => PromiseLike<T>): Promise<T>;

package/dist/errors.js

@@ -0,0 +1,114 @@
+"use strict";
+/**
+ * The typed error hierarchy (plan 00 D2/D8).
+ *
+ * The native seam throws plain `Error`s whose message starts with
+ * `[LAMINAR_<code>]` (napi-rs 3.12 cannot carry custom codes across promise
+ * rejections — see docs/plans/01 spike results). The public API re-throws
+ * them as `LaminarError` subclasses with a real `code` property and the
+ * prefix stripped from `message`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LaminarInternalError = void 0;
+exports.LaminarSubscriptionError = void 0;
+exports.LaminarQueryError = void 0;
+exports.LaminarIngestionError = void 0;
+exports.LaminarSchemaError = void 0;
+exports.LaminarConnectionError = void 0;
+exports.LaminarError = void 0;
+exports.toLaminarError = toLaminarError;
+exports.wrapSync = wrapSync;
+exports.wrapAsync = wrapAsync;
+const CODE_PREFIX = /^\[LAMINAR_(\d+)\]\s?/;
+/** Base class: engine or binding failure with a numeric core error code. */
+class LaminarError extends Error {
+    /** Numeric code from the core taxonomy (e.g. `400`). */
+    code;
+    /** Class name (e.g. `LaminarQueryError`). */
+    codeName;
+    constructor(message, code, options) {
+        super(message, options);
+        this.name = new.target.name;
+        this.code = code;
+        this.codeName = new.target.name;
+    }
+}
+exports.LaminarError = LaminarError;
+/** 100–199: connection lifecycle failures. */
+class LaminarConnectionError extends LaminarError {
+}
+exports.LaminarConnectionError = LaminarConnectionError;
+/** 200–299: schema and catalog failures. */
+class LaminarSchemaError extends LaminarError {
+}
+exports.LaminarSchemaError = LaminarSchemaError;
+/** 300–399: ingestion failures. */
+class LaminarIngestionError extends LaminarError {
+}
+exports.LaminarIngestionError = LaminarIngestionError;
+/** 400–499: query failures. */
+class LaminarQueryError extends LaminarError {
+}
+exports.LaminarQueryError = LaminarQueryError;
+/** 500–599: subscription failures. */
+class LaminarSubscriptionError extends LaminarError {
+}
+exports.LaminarSubscriptionError = LaminarSubscriptionError;
+/** 900–999: internal engine or binding failures. */
+class LaminarInternalError extends LaminarError {
+}
+exports.LaminarInternalError = LaminarInternalError;
+function classFor(code) {
+    if (code >= 100 && code <= 199)
+        return LaminarConnectionError;
+    if (code >= 200 && code <= 299)
+        return LaminarSchemaError;
+    if (code >= 300 && code <= 399)
+        return LaminarIngestionError;
+    if (code >= 400 && code <= 499)
+        return LaminarQueryError;
+    if (code >= 500 && code <= 599)
+        return LaminarSubscriptionError;
+    return LaminarInternalError;
+}
+/**
+ * Convert a thrown native error into the typed hierarchy. Coded errors get
+ * the matching subclass with the prefix stripped; napi argument-coercion
+ * failures (below the engine layer) and anything unrecognized wrap into
+ * `LaminarInternalError` with code `900`, preserving the original as
+ * `cause`.
+ */
+function toLaminarError(error) {
+    if (error instanceof LaminarError)
+        return error;
+    const message = error instanceof Error ? error.message : String(error);
+    const match = CODE_PREFIX.exec(message);
+    if (match) {
+        const code = Number.parseInt(match[1], 10);
+        const Class = classFor(code);
+        return new Class(message.slice(match[0].length), code, { cause: error });
+    }
+    return new LaminarInternalError(message, 900, { cause: error });
+}
+/** Run `thunk`, re-throwing any failure through {@link toLaminarError}. */
+function wrapSync(thunk) {
+    try {
+        return thunk();
+    }
+    catch (error) {
+        throw toLaminarError(error);
+    }
+}
+/**
+ * Call `work` and await its result, re-throwing both synchronous throws (napi
+ * argument coercion happens before the promise exists) and rejections through
+ * {@link toLaminarError}.
+ */
+async function wrapAsync(work) {
+    try {
+        return await work();
+    }
+    catch (error) {
+        throw toLaminarError(error);
+    }
+}