@mulmobridge/protocol 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,63 @@
+# @mulmobridge/protocol
+
+Shared types and constants for the [MulmoBridge](https://github.com/receptron/mulmoclaude) chat protocol — the wire-level contract between the chat-service (server) and external bridges (CLI, Telegram, etc.).
+
+## Install
+
+```bash
+npm install @mulmobridge/protocol
+```
+
+## What's included
+
+| Export | Description |
+|---|---|
+| `EVENT_TYPES` | Agent SSE event type discriminants (`"text"`, `"error"`, `"session_finished"`, …) |
+| `EventType` | Union type of all event type strings |
+| `CHAT_SOCKET_EVENTS` | Socket.io event names (`"message"`, `"push"`) |
+| `CHAT_SOCKET_PATH` | Socket.io endpoint path (`"/ws/chat"`) |
+| `ChatSocketEvent` | Union type of socket event names |
+| `CHAT_SERVICE_ROUTES` | REST endpoint patterns for the bridge API |
+| `Attachment` | File attachment interface (`mimeType` + base64 `data` + optional `filename`) |
+
+## Usage
+
+```typescript
+import {
+  EVENT_TYPES,
+  CHAT_SOCKET_EVENTS,
+  CHAT_SOCKET_PATH,
+  type Attachment,
+} from "@mulmobridge/protocol";
+
+// Discriminate agent events
+if (event.type === EVENT_TYPES.text) {
+  console.log(event.message);
+}
+
+// Connect via socket.io
+const socket = io(serverUrl, { path: CHAT_SOCKET_PATH });
+socket.on(CHAT_SOCKET_EVENTS.push, (event) => {
+  // handle server push
+});
+
+// Send with attachment
+const attachment: Attachment = {
+  mimeType: "image/png",
+  data: base64EncodedData,
+};
+```
+
+## Part of the MulmoBridge ecosystem
+
+| Package | Description |
+|---|---|
+| **@mulmobridge/protocol** | Wire protocol types and constants (this package) |
+| [@mulmobridge/chat-service](https://www.npmjs.com/package/@mulmobridge/chat-service) | Server-side chat service |
+| [@mulmobridge/client](https://www.npmjs.com/package/@mulmobridge/client) | Bridge client library |
+| [@mulmobridge/cli](https://www.npmjs.com/package/@mulmobridge/cli) | CLI bridge |
+| [@mulmobridge/telegram](https://www.npmjs.com/package/@mulmobridge/telegram) | Telegram bridge |
+
+## License
+
+MIT — [Receptron Team](https://github.com/receptron)

package/dist/socket.d.ts

@@ -2,5 +2,10 @@ export declare const CHAT_SOCKET_PATH = "/ws/chat";
 export declare const CHAT_SOCKET_EVENTS: {
     readonly message: "message";
     readonly push: "push";
+    /** Server → bridge streaming text chunk (Phase C of #268).
+     *  Emitted during a relay while the agent is generating text.
+     *  Bridge accumulates chunks for display; the final ack still
+     *  carries the full response for backward compatibility. */
+    readonly textChunk: "textChunk";
 };
 export type ChatSocketEvent = (typeof CHAT_SOCKET_EVENTS)[keyof typeof CHAT_SOCKET_EVENTS];

package/dist/socket.js

@@ -3,4 +3,9 @@ export const CHAT_SOCKET_PATH = "/ws/chat";
 export const CHAT_SOCKET_EVENTS = {
     message: "message",
     push: "push",
+    /** Server → bridge streaming text chunk (Phase C of #268).
+     *  Emitted during a relay while the agent is generating text.
+     *  Bridge accumulates chunks for display; the final ack still
+     *  carries the full response for backward compatibility. */
+    textChunk: "textChunk",
 };

package/package.json

@@ -1,38 +1,32 @@
 {
   "name": "@mulmobridge/protocol",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Shared types and constants for the MulmoBridge protocol",
   "type": "module",
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./src/index.ts",
-      "types": "./src/index.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc",
     "prepack": "yarn build",
     "typecheck": "tsc --noEmit",
-    "test": "tsx --test test/test_*.ts"
-  },
-  "publishConfig": {
-    "main": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "exports": {
-      ".": {
-        "types": "./dist/index.d.ts",
-        "import": "./dist/index.js"
-      }
-    }
+    "test": "tsx --test test/test_*.ts",
+    "lint": "eslint src test"
   },
   "license": "MIT",
   "author": "Receptron Team",
   "devDependencies": {
-    "typescript": "^5.8.0"
+    "typescript": "^6.0.3"
   }
 }