mq-bridge 0.2.0

package/README.md

@@ -0,0 +1,41 @@
+# mq-bridge Node bindings
+
+Native Node.js bindings for `mq-bridge`, built with `napi-rs`.
+
+This package is server-side only. It loads a native `.node` addon and does not run in browsers.
+
+## Build
+
+```sh
+npm install
+npm run build:basic
+```
+
+For the fastest local smoke test, build only the HTTP + middleware surface used
+by the example:
+
+```sh
+npm run build:ci
+npm run example
+```
+
+## Handler shape
+
+```ts
+import { Message, Route } from "@mq-bridge/node";
+
+const route = Route.fromYamlStr(config, "orders");
+
+route.withHandler(async (message) => {
+  const data = message.json();
+  return Message.fromJson({ ok: true, data });
+});
+
+route.addHandler("order.created", async (data) => {
+  return Message.fromJson({ seen: data });
+});
+
+route.start();
+```
+
+Middleware is configured through the normal mq-bridge route config.

package/index.d.ts

@@ -0,0 +1,45 @@
+export type JsonValue =
+  | null
+  | boolean
+  | number
+  | string
+  | JsonValue[]
+  | { [key: string]: JsonValue };
+
+export type Metadata = Record<string, string>;
+export type HandlerResult = Message | null | undefined;
+export type MessageHandler = (message: Message) => HandlerResult | Promise<HandlerResult>;
+export type JsonHandler = (data: JsonValue) => HandlerResult | Promise<HandlerResult>;
+
+export class Message {
+  constructor(payload: Buffer | Uint8Array, metadata?: Metadata | null, id?: string | null);
+  static fromJson(data: JsonValue, metadata?: Metadata | null, id?: string | null): Message;
+  get payload(): Buffer;
+  get metadata(): Metadata;
+  get id(): string | null;
+  json(): JsonValue;
+  text(): string;
+}
+
+export class Publisher {
+  static fromYaml(path: string, name: string): Publisher;
+  static fromYamlStr(text: string, name: string): Publisher;
+  static fromConfig(config: JsonValue, name: string): Publisher;
+  send(message: Message): void;
+  request(message: Message): Message;
+  sendJson(data: JsonValue, metadata?: Metadata | null, id?: string | null): void;
+  requestJson(data: JsonValue, metadata?: Metadata | null, id?: string | null): Message;
+}
+
+export class Route {
+  static fromYaml(path: string, name: string): Route;
+  static fromYamlStr(text: string, name: string): Route;
+  static fromConfig(config: JsonValue, name: string): Route;
+  withHandler(handler: MessageHandler): void;
+  addHandler(kind: string, handler: JsonHandler): void;
+  start(): void;
+  stop(): void;
+  join(): void;
+}
+
+export const version: string;

package/index.js

@@ -0,0 +1,144 @@
+"use strict";
+
+const native = require("./mq_bridge_node.node");
+
+class Message {
+  constructor(payload, metadata = null, id = null) {
+    this._native = native.createMessage(Buffer.from(payload), metadata, id);
+  }
+
+  static fromJson(data, metadata = null, id = null) {
+    return Message._fromNative(native.messageFromJson(data, metadata, id));
+  }
+
+  static _fromNative(raw) {
+    const message = Object.create(Message.prototype);
+    message._native = raw;
+    return message;
+  }
+
+  static _toNative(message) {
+    if (message instanceof Message) {
+      return message._native;
+    }
+    return message;
+  }
+
+  static _toNativeResult(result) {
+    if (result == null) {
+      return null;
+    }
+    return Message._toNative(result);
+  }
+
+  get payload() {
+    return Buffer.from(this._native.payload);
+  }
+
+  get metadata() {
+    return { ...(this._native.metadata || {}) };
+  }
+
+  get id() {
+    return this._native.id || null;
+  }
+
+  json() {
+    return native.messageJson(this._native);
+  }
+
+  text() {
+    return native.messageText(this._native);
+  }
+}
+
+class Publisher {
+  constructor(nativePublisher) {
+    this._native = nativePublisher;
+  }
+
+  static fromYaml(path, name) {
+    return new Publisher(native.Publisher.fromYaml(path, name));
+  }
+
+  static fromYamlStr(text, name) {
+    return new Publisher(native.Publisher.fromYamlStr(text, name));
+  }
+
+  static fromConfig(config, name) {
+    return new Publisher(native.Publisher.fromConfig(config, name));
+  }
+
+  send(message) {
+    this._native.send(Message._toNative(message));
+  }
+
+  request(message) {
+    return Message._fromNative(this._native.request(Message._toNative(message)));
+  }
+
+  sendJson(data, metadata = null, id = null) {
+    this._native.sendJson(data, metadata, id);
+  }
+
+  requestJson(data, metadata = null, id = null) {
+    return Message._fromNative(this._native.requestJson(data, metadata, id));
+  }
+}
+
+class Route {
+  constructor(nativeRoute) {
+    this._native = nativeRoute;
+  }
+
+  static fromYaml(path, name) {
+    return new Route(native.Route.fromYaml(path, name));
+  }
+
+  static fromYamlStr(text, name) {
+    return new Route(native.Route.fromYamlStr(text, name));
+  }
+
+  static fromConfig(config, name) {
+    return new Route(native.Route.fromConfig(config, name));
+  }
+
+  withHandler(handler) {
+    this._native.withHandler(async (error, message) => {
+      if (error) {
+        throw error;
+      }
+      const result = await handler(Message._fromNative(message));
+      return Message._toNativeResult(result);
+    });
+  }
+
+  addHandler(kind, handler) {
+    this._native.addHandler(kind, async (error, data) => {
+      if (error) {
+        throw error;
+      }
+      const result = await handler(data);
+      return Message._toNativeResult(result);
+    });
+  }
+
+  start() {
+    this._native.start();
+  }
+
+  stop() {
+    this._native.stop();
+  }
+
+  join() {
+    this._native.join();
+  }
+}
+
+module.exports = {
+  Message,
+  Publisher,
+  Route,
+  version: native.version,
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "mq-bridge",
+  "version": "0.2.0",
+  "description": "Node.js bindings for mq-bridge",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marcomq/mq-bridge.git",
+    "directory": "node/mq-bridge-node"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "*.node"
+  ],
+  "napi": {
+    "binaryName": "mq_bridge_node"
+  },
+  "scripts": {
+    "build": "napi build --release",
+    "build:basic": "napi build --release --no-default-features --features \"basic middleware\" --dts native.d.ts",
+    "build:ci": "napi build --no-default-features --features \"http middleware\" --dts native.d.ts",
+    "build:debug": "napi build",
+    "example": "node examples/http-handler.js",
+    "test": "node --test test/*.test.js",
+    "artifacts": "napi artifacts"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}