feat: enhance release workflow and improve serial monitor functionality

Author: JakubAndrysek

.github/workflows/release.yml

@@ -27,10 +27,10 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y binfmt-support qemu-user-static
       - name: 'Build'
-        run: pnpm run package
+        run: pnpm run build && pnpm --filter wokwi-cli run package
       - name: Upload Release
         uses: ncipollo/release-action@v1
         with:
-          artifacts: 'dist/bin/wokwi-cli-*,dist/bin/version.json'
+          artifacts: 'packages/wokwi-cli/dist/bin/wokwi-cli-*,packages/wokwi-cli/dist/bin/version.json'
           token: ${{ secrets.GITHUB_TOKEN }}
           generateReleaseNotes: true

package.json

@@ -16,7 +16,7 @@
     "test:embed:playwright": "playwright test test/wokwi-embed",
     "test:embed:playwright:ui": "playwright test test/wokwi-embed --ui",
     "test:cli:integration": "pnpm exec tsx scripts/test-cli-integration.ts",
-    "package": "pnpm -r run package",
+    "package": "pnpm --filter wokwi-cli run package",
     "cli": "tsx packages/wokwi-cli/src/main.ts",
     "prepare": "husky install"
   },

packages/wokwi-cli/src/main.ts

@@ -6,6 +6,7 @@ import YAML from 'yaml';
 import { APIClient, type APIEvent, type ChipsLogPayload, type SerialMonitorDataPayload } from 'wokwi-client-js';
 import { WebSocketTransport } from './transport/WebSocketTransport.js';
 import { DEFAULT_SERVER } from './constants.js';
+import { createSerialMonitorWritable } from './utils/serialMonitorWritable.js';
 import { ExpectEngine } from './ExpectEngine.js';
 import { SimulationTimeoutError } from './SimulationTimeoutError.js';
 import { TestScenario } from './TestScenario.js';
@@ -362,7 +363,7 @@ async function main() {
     });
 
     if (interactive) {
-      process.stdin.pipe(await client.serialMonitorWritable());
+      process.stdin.pipe(await createSerialMonitorWritable(client));
     }
 
     if (scenario != null) {

packages/wokwi-cli/src/mcp/SimulationManager.ts

@@ -1,6 +1,6 @@
 import { existsSync, readFileSync } from 'fs';
 import path from 'path';
-import { APIClient, type APIEvent } from 'wokwi-client-js';
+import { APIClient, SerialMonitorDataPayload, type APIEvent } from 'wokwi-client-js';
 import { WebSocketTransport } from '../transport/WebSocketTransport.js';
 import { DEFAULT_SERVER } from '../constants.js';
 import { parseConfig } from '../config.js';
@@ -49,13 +49,10 @@ export class SimulationManager {
       throw new Error(`API Error: ${error.message}`);
     };
 
-    this.client.onEvent = (event: APIEvent) => {
-      if (event.event === 'serial-monitor:data') {
-        const bytes = (event as any).payload.bytes;
-        const text = bytes.map((byte: number) => String.fromCharCode(byte)).join('');
-        this.addToSerialBuffer(text);
-      }
-    };
+    this.client.listen('serial-monitor:data', (event: APIEvent<SerialMonitorDataPayload>) => {
+      const { bytes } = event.payload;
+      this.addToSerialBuffer(String.fromCharCode(...bytes));
+    });
 
     await this.client.connected;
   }

packages/wokwi-cli/src/utils/serialMonitorWritable.ts

@@ -0,0 +1,20 @@
+import type { APIClient } from 'wokwi-client-js';
+import { Writable } from 'stream';
+import { Buffer } from 'buffer';
+
+/**
+ * Creates a Node.js Writable stream that forwards data to the serial monitor.
+ * This function is Node.js-only and cannot be used in browser environments.
+ */
+export async function createSerialMonitorWritable(client: APIClient) {
+  return new Writable({
+    write: (chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void) => {
+      if (typeof chunk === 'string') {
+        chunk = Buffer.from(chunk, encoding);
+      }
+      client.serialMonitorWrite(chunk).then(() => {
+        callback(null);
+      }, callback);
+    },
+  });
+}

packages/wokwi-client-js/src/APIClient.ts

@@ -13,7 +13,6 @@ import { ITransport } from './transport/ITransport.js';
 import { base64ToByteArray, byteArrayToBase64 } from './base64.js';
 
 export class APIClient {
-  private connectionAttempts = 0;
   private lastId = 0;
   private lastPausePointId = 0;
   private closed = false;
@@ -30,7 +29,6 @@ export class APIClient {
 
   onConnected?: (helloMessage: APIHello) => void;
   onError?: (error: APIError) => void;
-  onEvent?: (event: APIEvent) => void;
 
   constructor(
     private readonly transport: ITransport,
@@ -106,22 +104,6 @@ export class APIClient {
     });
   }
 
-  async serialMonitorWritable() {
-    // Dynamic import for Node.js-only API
-    const { Writable } = await import('stream');
-    const { Buffer } = await import('buffer');
-    return new Writable({
-      write: (chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void) => {
-        if (typeof chunk === 'string') {
-          chunk = Buffer.from(chunk, encoding);
-        }
-        this.serialMonitorWrite(chunk).then(() => {
-          callback(null);
-        }, callback);
-      },
-    });
-  }
-
   async framebufferRead(partId: string) {
     return await this.sendCommand<{ png: string }>('framebuffer:read', {
       id: partId,
@@ -249,7 +231,6 @@ export class APIClient {
       }
     }
     this._lastNanos = message.nanos;
-    this.onEvent?.(message);
     this.apiEvents.dispatchEvent(new CustomEvent<APIEvent>(message.event, { detail: message }));
   }
 
@@ -292,14 +273,10 @@ export class APIClient {
     if (this.closed) return;
     const target = (this as any).server ?? 'transport';
     const msg = `Connection to ${target} closed unexpectedly: code ${code}${reason ? ` (${reason})` : ''}`;
-    const errorObj: APIError = { type: 'error', message: msg };
-    this.onError?.(errorObj);
-    console.error(msg);
+    this.onError?.({ type: 'error', message: msg });
   }
 
   private handleTransportError(error: Error) {
-    const errorObj: APIError = { type: 'error', message: error.message };
-    this.onError?.(errorObj);
-    console.error('Transport error:', error.message);
+    this.onError?.({ type: 'error', message: error.message });
   }
 }

packages/wokwi-client-js/src/index.ts

@@ -2,7 +2,7 @@
 export { APIClient } from './APIClient.js';
 
 // Transport interfaces and implementations
-export { ITransport } from './transport/ITransport.js';
+export { type ITransport } from './transport/ITransport.js';
 export { MessagePortTransport } from './transport/MessagePortTransport.js';
 
 // Pause Point

packages/wokwi-client-js/tools/bundle-browser.js

@@ -13,12 +13,9 @@ const options = {
   platform: 'browser',
   format: 'esm',
   target: 'es2020',
-  // Explicitly mark Node.js-only packages as external
-  external: ['ws', 'stream', 'buffer'],
   banner: {
     js: `// Browser bundle of wokwi-client-js
-// Note: serialMonitorWritable() requires Node.js and won't work in browsers
-// Use MessagePortTransport for browser communication with Wokwi Simulator
+    // Use MessagePortTransport for browser communication with Wokwi Simulator
 `,
   },
 };
@@ -32,4 +29,3 @@ build(options)
     console.error('✗ Browser bundle failed:', error);
     process.exit(1);
   });
-