@orbit-stream/redpanda 1.0.0 → 1.0.2

package/README.md

@@ -1,67 +1,180 @@
-# orbit-stream-redpanda
-
-High-performance Redpanda transport adapter for Orbit Stream.
-
 # @orbit-stream/redpanda
 
 High-performance Redpanda transport adapter for Orbit Stream.
 
 Optimized for:
 
-- high-throughput telemetry
-- binary payloads
-- batching
-- low-latency streaming
-- backpressure-aware processing
+- high-throughput telemetry streaming
+- binary payload processing
+- batch publishing and consumption
+- low-latency message delivery
+- backpressure-aware streaming
+- large-scale distributed consumers
 
 ---
 
 # Installation
 
-```bash id="ygt1m4"
+```bash
 npm install @orbit-stream/redpanda
 ```
 
 ---
 
+# Features
+
+- KafkaJS based transport
+- Redpanda optimized architecture
+- Batch publishing support
+- Batch consumption support
+- Buffer-first design
+- Backpressure-aware processing
+- High-throughput optimized
+- Binary payload support
+- Transport-independent OrbitStream API
+
+---
+
 # Usage
 
-```js id="w9d4p7"
-const { RedpandaAdapter } = require("@orbit-stream/redpanda");
+```js
+const { OrbitStream } = require("@orbit-stream/redpanda");
 
-const stream = new RedpandaAdapter({
-  brokers: ["localhost:9092"],
+async function main() {
+  const stream = new OrbitStream({
+    brokers: ["localhost:9092"],
 
-  groupId: "telemetry-group",
+    groupId: "telemetry-group",
 
-  batchSize: 5000,
+    batchSize: 5000,
+
+    flushInterval: 100,
+  });
+
+  await stream.connect();
+
+  await stream.publish("telemetry", {
+    value: Buffer.from("hello"),
+  });
 
-  flushInterval: 100,
+  await stream.subscribe(
+    "telemetry",
+
+    async (messages) => {
+      console.log(messages.length);
+    },
+  );
+}
+
+main();
+```
+
+---
+
+# Producer Example
+
+```js
+const { OrbitStream } = require("@orbit-stream/redpanda");
+
+const stream = new OrbitStream({
+  brokers: ["localhost:9092"],
+
+  clientId: "telemetry-producer",
 });
 
 await stream.connect();
 
 await stream.publish("telemetry", {
-  value: Buffer.from("hello"),
+  value: Buffer.from("payload"),
 });
+```
+
+---
+
+# Consumer Example
 
-await stream.subscribe("telemetry", async (messages) => {
-  console.log(messages.length);
+```js
+const { OrbitStream } = require("@orbit-stream/redpanda");
+
+const stream = new OrbitStream({
+  brokers: ["localhost:9092"],
+
+  groupId: "telemetry-group",
 });
+
+await stream.connect();
+
+await stream.subscribe(
+  "telemetry",
+
+  async (messages) => {
+    console.log("received:", messages.length);
+  },
+
+  {
+    partitionsConsumedConcurrently: 8,
+  },
+);
 ```
 
 ---
 
-# Features
+# Recommended Configuration
 
-- KafkaJS based
-- Redpanda optimized
-- Batch publishing
-- Batch consumption
-- Buffer-first architecture
-- Backpressure-aware
-- High throughput optimized
-- Binary payload support
+## Standard Telemetry
+
+```js
+{
+  batchSize: 5000,
+  flushInterval: 100
+}
+```
+
+---
+
+## High Throughput Telemetry (~800 Mbps)
+
+```js
+{
+  batchSize: 10000,
+  flushInterval: 50,
+  maxInFlightRequests: 10
+}
+```
+
+---
+
+# Architecture
+
+```txt
+Telemetry Source
+        │
+        ▼
+OrbitStream Producer
+        │
+        ▼
+Redpanda Cluster
+        │
+        ▼
+Consumer Group
+        │
+        ▼
+Telemetry Processors
+```
+
+---
+
+# Package Architecture
+
+Orbit Stream uses modular transport packages:
+
+| Package                  | Purpose                         |
+| ------------------------ | ------------------------------- |
+| `@orbit-stream/core`     | Shared interfaces and utilities |
+| `@orbit-stream/redpanda` | Redpanda transport              |
+| `@orbit-stream/valkey`   | Valkey Streams transport        |
+
+Applications install only the transport they use.
 
 ---
 

package/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  OrbitStream: require("./src/adapters/RedpandaAdapter"),
+};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@orbit-stream/redpanda",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "High-performance Redpanda transport adapter for Orbit Stream.",
-  "main": "src/index.js",
+  "main": "index.js",
   "types": "index.d.ts",
   "files": [
     "src",

package/src/examples/consumer.js

@@ -0,0 +1,15 @@
+const { OrbitStream } = require("@orbit-stream/redpanda");
+async function main() {
+  const stream = new OrbitStream({
+    brokers: ["localhost:9092"],
+    groupId: "test-group",
+  });
+  await stream.connect();
+  console.log("consumer connected");
+  await stream.subscribe("telemetry", async (messages) => {
+    for (let i = 0; i < messages.length; i++) {
+      console.log(messages[i].value.toString());
+    }
+  });
+}
+main().catch(console.error);

package/src/examples/producer.js

@@ -0,0 +1,17 @@
+const { OrbitStream } = require("@orbit-stream/redpanda");
+async function main() {
+  const stream = new OrbitStream({
+    brokers: ["localhost:9092"],
+    clientId: "test-producer",
+    batchSize: 1000,
+    flushInterval: 100,
+  });
+  await stream.connect();
+  console.log("producer connected");
+  let counter = 0;
+  setInterval(async () => {
+    const payload = Buffer.from(`packet-${counter++}`);
+    await stream.publish("telemetry", { value: payload });
+  }, 100);
+}
+main().catch(console.error);