@synode/adapter-stream 1.0.0

package/LICENSE

@@ -0,0 +1,35 @@
+Synode Proprietary License
+
+Copyright (c) 2026 Digitl Cloud GmbH. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of this software and associated documentation files (the
+"Software"), to use the Software for personal, internal, and commercial
+purposes, subject to the following conditions:
+
+1. PERMITTED USE. You may use, copy, and modify the Software for your own
+   personal, internal, or commercial purposes.
+
+2. NO REDISTRIBUTION. You may not distribute, publish, sublicense, or
+   otherwise make the Software or any derivative works available to third
+   parties, whether in source code or compiled form, free of charge or for
+   a fee.
+
+3. NO RESALE. You may not sell, rent, lease, or otherwise commercially
+   exploit the Software itself as a standalone product or as part of a
+   software distribution.
+
+4. NO HOSTING AS A SERVICE. You may not offer the Software to third parties
+   as a hosted, managed, or software-as-a-service product where the primary
+   value derives from the Software.
+
+5. ATTRIBUTION. You must retain this license notice and copyright notice in
+   all copies or substantial portions of the Software.
+
+6. NO WARRANTY. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+   IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES
+   OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+   OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,66 @@
+
+//#region src/index.ts
+/**
+* Adapter that writes events to a Node.js {@link Writable} stream.
+*
+* Supports two formats:
+* - **jsonl** (default): each event is written as a single JSON line immediately
+* - **json**: events are buffered in memory and flushed as a pretty-printed
+*   JSON array when {@link close} is called
+*
+* @example
+* ```ts
+* import { createWriteStream } from 'node:fs';
+*
+* const stream = createWriteStream('./events.jsonl');
+* const adapter = new StreamAdapter(stream);
+* await generate(journey, { users: 10, adapter });
+* await adapter.close();
+* ```
+*/
+var StreamAdapter = class {
+	stream;
+	format;
+	buffer;
+	/**
+	* @param stream - The writable stream to write events to
+	* @param options - Configuration options
+	*/
+	constructor(stream, options) {
+		this.stream = stream;
+		this.format = options?.format ?? "jsonl";
+		this.buffer = [];
+	}
+	/**
+	* Writes a single event to the stream.
+	*
+	* In jsonl mode the event is serialized and written immediately.
+	* In json mode the event is added to an internal buffer.
+	*
+	* @param event - The generated event to write
+	*/
+	write(event) {
+		if (this.format === "jsonl") this.stream.write(JSON.stringify(event) + "\n");
+		else this.buffer.push(event);
+	}
+	/**
+	* Flushes any buffered data and ends the underlying stream.
+	*
+	* In json mode this writes the full buffered array before ending.
+	*
+	* @returns A promise that resolves when the stream has finished
+	*/
+	close() {
+		return new Promise((resolve, reject) => {
+			if (this.format === "json") this.stream.write(JSON.stringify(this.buffer, null, 2));
+			this.stream.end(() => {
+				resolve();
+			});
+			this.stream.on("error", reject);
+		});
+	}
+};
+
+//#endregion
+exports.StreamAdapter = StreamAdapter;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { Writable } from 'node:stream';\nimport type { Event, OutputAdapter } from '@synode/core';\n\n/**\n * Configuration options for {@link StreamAdapter}.\n *\n * @param format - Serialization format: 'jsonl' writes one JSON object per line\n *   as events arrive, 'json' buffers all events and writes a single JSON array\n *   on close. Defaults to 'jsonl'.\n */\nexport interface StreamAdapterOptions {\n  format?: 'json' | 'jsonl';\n}\n\n/**\n * Adapter that writes events to a Node.js {@link Writable} stream.\n *\n * Supports two formats:\n * - **jsonl** (default): each event is written as a single JSON line immediately\n * - **json**: events are buffered in memory and flushed as a pretty-printed\n *   JSON array when {@link close} is called\n *\n * @example\n * ```ts\n * import { createWriteStream } from 'node:fs';\n *\n * const stream = createWriteStream('./events.jsonl');\n * const adapter = new StreamAdapter(stream);\n * await generate(journey, { users: 10, adapter });\n * await adapter.close();\n * ```\n */\nexport class StreamAdapter implements OutputAdapter {\n  private stream: Writable;\n  private format: 'json' | 'jsonl';\n  private buffer: Event[];\n\n  /**\n   * @param stream - The writable stream to write events to\n   * @param options - Configuration options\n   */\n  constructor(stream: Writable, options?: StreamAdapterOptions) {\n    this.stream = stream;\n    this.format = options?.format ?? 'jsonl';\n    this.buffer = [];\n  }\n\n  /**\n   * Writes a single event to the stream.\n   *\n   * In jsonl mode the event is serialized and written immediately.\n   * In json mode the event is added to an internal buffer.\n   *\n   * @param event - The generated event to write\n   */\n  write(event: Event): void {\n    if (this.format === 'jsonl') {\n      this.stream.write(JSON.stringify(event) + '\\n');\n    } else {\n      this.buffer.push(event);\n    }\n  }\n\n  /**\n   * Flushes any buffered data and ends the underlying stream.\n   *\n   * In json mode this writes the full buffered array before ending.\n   *\n   * @returns A promise that resolves when the stream has finished\n   */\n  close(): Promise<void> {\n    return new Promise((resolve, reject) => {\n      if (this.format === 'json') {\n        this.stream.write(JSON.stringify(this.buffer, null, 2));\n      }\n      this.stream.end(() => {\n        resolve();\n      });\n      this.stream.on('error', reject);\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAgCA,IAAa,gBAAb,MAAoD;CAClD,AAAQ;CACR,AAAQ;CACR,AAAQ;;;;;CAMR,YAAY,QAAkB,SAAgC;AAC5D,OAAK,SAAS;AACd,OAAK,SAAS,SAAS,UAAU;AACjC,OAAK,SAAS,EAAE;;;;;;;;;;CAWlB,MAAM,OAAoB;AACxB,MAAI,KAAK,WAAW,QAClB,MAAK,OAAO,MAAM,KAAK,UAAU,MAAM,GAAG,KAAK;MAE/C,MAAK,OAAO,KAAK,MAAM;;;;;;;;;CAW3B,QAAuB;AACrB,SAAO,IAAI,SAAS,SAAS,WAAW;AACtC,OAAI,KAAK,WAAW,OAClB,MAAK,OAAO,MAAM,KAAK,UAAU,KAAK,QAAQ,MAAM,EAAE,CAAC;AAEzD,QAAK,OAAO,UAAU;AACpB,aAAS;KACT;AACF,QAAK,OAAO,GAAG,SAAS,OAAO;IAC/B"}

package/dist/index.d.cts

@@ -0,0 +1,63 @@
+import { Writable } from "node:stream";
+import { Event, OutputAdapter } from "@synode/core";
+
+//#region src/index.d.ts
+
+/**
+ * Configuration options for {@link StreamAdapter}.
+ *
+ * @param format - Serialization format: 'jsonl' writes one JSON object per line
+ *   as events arrive, 'json' buffers all events and writes a single JSON array
+ *   on close. Defaults to 'jsonl'.
+ */
+interface StreamAdapterOptions {
+  format?: 'json' | 'jsonl';
+}
+/**
+ * Adapter that writes events to a Node.js {@link Writable} stream.
+ *
+ * Supports two formats:
+ * - **jsonl** (default): each event is written as a single JSON line immediately
+ * - **json**: events are buffered in memory and flushed as a pretty-printed
+ *   JSON array when {@link close} is called
+ *
+ * @example
+ * ```ts
+ * import { createWriteStream } from 'node:fs';
+ *
+ * const stream = createWriteStream('./events.jsonl');
+ * const adapter = new StreamAdapter(stream);
+ * await generate(journey, { users: 10, adapter });
+ * await adapter.close();
+ * ```
+ */
+declare class StreamAdapter implements OutputAdapter {
+  private stream;
+  private format;
+  private buffer;
+  /**
+   * @param stream - The writable stream to write events to
+   * @param options - Configuration options
+   */
+  constructor(stream: Writable, options?: StreamAdapterOptions);
+  /**
+   * Writes a single event to the stream.
+   *
+   * In jsonl mode the event is serialized and written immediately.
+   * In json mode the event is added to an internal buffer.
+   *
+   * @param event - The generated event to write
+   */
+  write(event: Event): void;
+  /**
+   * Flushes any buffered data and ends the underlying stream.
+   *
+   * In json mode this writes the full buffered array before ending.
+   *
+   * @returns A promise that resolves when the stream has finished
+   */
+  close(): Promise<void>;
+}
+//#endregion
+export { StreamAdapter, StreamAdapterOptions };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,63 @@
+import { Writable } from "node:stream";
+import { Event, OutputAdapter } from "@synode/core";
+
+//#region src/index.d.ts
+
+/**
+ * Configuration options for {@link StreamAdapter}.
+ *
+ * @param format - Serialization format: 'jsonl' writes one JSON object per line
+ *   as events arrive, 'json' buffers all events and writes a single JSON array
+ *   on close. Defaults to 'jsonl'.
+ */
+interface StreamAdapterOptions {
+  format?: 'json' | 'jsonl';
+}
+/**
+ * Adapter that writes events to a Node.js {@link Writable} stream.
+ *
+ * Supports two formats:
+ * - **jsonl** (default): each event is written as a single JSON line immediately
+ * - **json**: events are buffered in memory and flushed as a pretty-printed
+ *   JSON array when {@link close} is called
+ *
+ * @example
+ * ```ts
+ * import { createWriteStream } from 'node:fs';
+ *
+ * const stream = createWriteStream('./events.jsonl');
+ * const adapter = new StreamAdapter(stream);
+ * await generate(journey, { users: 10, adapter });
+ * await adapter.close();
+ * ```
+ */
+declare class StreamAdapter implements OutputAdapter {
+  private stream;
+  private format;
+  private buffer;
+  /**
+   * @param stream - The writable stream to write events to
+   * @param options - Configuration options
+   */
+  constructor(stream: Writable, options?: StreamAdapterOptions);
+  /**
+   * Writes a single event to the stream.
+   *
+   * In jsonl mode the event is serialized and written immediately.
+   * In json mode the event is added to an internal buffer.
+   *
+   * @param event - The generated event to write
+   */
+  write(event: Event): void;
+  /**
+   * Flushes any buffered data and ends the underlying stream.
+   *
+   * In json mode this writes the full buffered array before ending.
+   *
+   * @returns A promise that resolves when the stream has finished
+   */
+  close(): Promise<void>;
+}
+//#endregion
+export { StreamAdapter, StreamAdapterOptions };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,65 @@
+//#region src/index.ts
+/**
+* Adapter that writes events to a Node.js {@link Writable} stream.
+*
+* Supports two formats:
+* - **jsonl** (default): each event is written as a single JSON line immediately
+* - **json**: events are buffered in memory and flushed as a pretty-printed
+*   JSON array when {@link close} is called
+*
+* @example
+* ```ts
+* import { createWriteStream } from 'node:fs';
+*
+* const stream = createWriteStream('./events.jsonl');
+* const adapter = new StreamAdapter(stream);
+* await generate(journey, { users: 10, adapter });
+* await adapter.close();
+* ```
+*/
+var StreamAdapter = class {
+	stream;
+	format;
+	buffer;
+	/**
+	* @param stream - The writable stream to write events to
+	* @param options - Configuration options
+	*/
+	constructor(stream, options) {
+		this.stream = stream;
+		this.format = options?.format ?? "jsonl";
+		this.buffer = [];
+	}
+	/**
+	* Writes a single event to the stream.
+	*
+	* In jsonl mode the event is serialized and written immediately.
+	* In json mode the event is added to an internal buffer.
+	*
+	* @param event - The generated event to write
+	*/
+	write(event) {
+		if (this.format === "jsonl") this.stream.write(JSON.stringify(event) + "\n");
+		else this.buffer.push(event);
+	}
+	/**
+	* Flushes any buffered data and ends the underlying stream.
+	*
+	* In json mode this writes the full buffered array before ending.
+	*
+	* @returns A promise that resolves when the stream has finished
+	*/
+	close() {
+		return new Promise((resolve, reject) => {
+			if (this.format === "json") this.stream.write(JSON.stringify(this.buffer, null, 2));
+			this.stream.end(() => {
+				resolve();
+			});
+			this.stream.on("error", reject);
+		});
+	}
+};
+
+//#endregion
+export { StreamAdapter };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { Writable } from 'node:stream';\nimport type { Event, OutputAdapter } from '@synode/core';\n\n/**\n * Configuration options for {@link StreamAdapter}.\n *\n * @param format - Serialization format: 'jsonl' writes one JSON object per line\n *   as events arrive, 'json' buffers all events and writes a single JSON array\n *   on close. Defaults to 'jsonl'.\n */\nexport interface StreamAdapterOptions {\n  format?: 'json' | 'jsonl';\n}\n\n/**\n * Adapter that writes events to a Node.js {@link Writable} stream.\n *\n * Supports two formats:\n * - **jsonl** (default): each event is written as a single JSON line immediately\n * - **json**: events are buffered in memory and flushed as a pretty-printed\n *   JSON array when {@link close} is called\n *\n * @example\n * ```ts\n * import { createWriteStream } from 'node:fs';\n *\n * const stream = createWriteStream('./events.jsonl');\n * const adapter = new StreamAdapter(stream);\n * await generate(journey, { users: 10, adapter });\n * await adapter.close();\n * ```\n */\nexport class StreamAdapter implements OutputAdapter {\n  private stream: Writable;\n  private format: 'json' | 'jsonl';\n  private buffer: Event[];\n\n  /**\n   * @param stream - The writable stream to write events to\n   * @param options - Configuration options\n   */\n  constructor(stream: Writable, options?: StreamAdapterOptions) {\n    this.stream = stream;\n    this.format = options?.format ?? 'jsonl';\n    this.buffer = [];\n  }\n\n  /**\n   * Writes a single event to the stream.\n   *\n   * In jsonl mode the event is serialized and written immediately.\n   * In json mode the event is added to an internal buffer.\n   *\n   * @param event - The generated event to write\n   */\n  write(event: Event): void {\n    if (this.format === 'jsonl') {\n      this.stream.write(JSON.stringify(event) + '\\n');\n    } else {\n      this.buffer.push(event);\n    }\n  }\n\n  /**\n   * Flushes any buffered data and ends the underlying stream.\n   *\n   * In json mode this writes the full buffered array before ending.\n   *\n   * @returns A promise that resolves when the stream has finished\n   */\n  close(): Promise<void> {\n    return new Promise((resolve, reject) => {\n      if (this.format === 'json') {\n        this.stream.write(JSON.stringify(this.buffer, null, 2));\n      }\n      this.stream.end(() => {\n        resolve();\n      });\n      this.stream.on('error', reject);\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAgCA,IAAa,gBAAb,MAAoD;CAClD,AAAQ;CACR,AAAQ;CACR,AAAQ;;;;;CAMR,YAAY,QAAkB,SAAgC;AAC5D,OAAK,SAAS;AACd,OAAK,SAAS,SAAS,UAAU;AACjC,OAAK,SAAS,EAAE;;;;;;;;;;CAWlB,MAAM,OAAoB;AACxB,MAAI,KAAK,WAAW,QAClB,MAAK,OAAO,MAAM,KAAK,UAAU,MAAM,GAAG,KAAK;MAE/C,MAAK,OAAO,KAAK,MAAM;;;;;;;;;CAW3B,QAAuB;AACrB,SAAO,IAAI,SAAS,SAAS,WAAW;AACtC,OAAI,KAAK,WAAW,OAClB,MAAK,OAAO,MAAM,KAAK,UAAU,KAAK,QAAQ,MAAM,EAAE,CAAC;AAEzD,QAAK,OAAO,UAAU;AACpB,aAAS;KACT;AACF,QAAK,OAAO,GAAG,SAAS,OAAO;IAC/B"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@synode/adapter-stream",
+  "version": "1.0.0",
+  "description": "Stream adapter for Synode",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Digitl Cloud GmbH",
+  "license": "SEE LICENSE IN LICENSE",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/digitl-cloud/synode",
+    "directory": "packages/adapter-stream"
+  },
+  "peerDependencies": {
+    "@synode/core": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.12.0",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "typescript-eslint": "^8.58.0",
+    "tsdown": "^0.16.8",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.2",
+    "@synode/core": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "lint": "eslint src tests"
+  }
+}