refactor: rename wokwi-client-js package to @wokwi/client

urish · urish · commit e204ea2fb9eb · 2025-11-26T21:23:19.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -11,4 +11,4 @@ wokwi-part-tests/
 
 # Ignore packed tarballs
 wokwi-cli-*.tgz
-wokwi-client-js-*.tgz
+wokwi-client-*.tgz
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -31,7 +31,7 @@ pnpm exec playwright install
 
 The repository contains two main packages:
 - `wokwi-cli`: The command-line interface for Wokwi.
-- `wokwi-client-js`: The JavaScript client library used to interact with Wokwi from a browser iframe.
+- `@wokwi/client`: The JavaScript client library used to interact with Wokwi from a browser iframe.
 
 When you run `pnpm` commands from the repository root, the monorepo configuration determines which packages the command runs in. For example, `pnpm build` runs the build across packages, while `pnpm lint` runs `eslint .` for the whole repository.
 
@@ -156,13 +156,13 @@ The `wokwi-cli` package includes binary executables for multiple platforms. To p
    pnpm publish
    ```
 
-### Publishing wokwi-client-js
+### Publishing @wokwi/client
 
-The `wokwi-client-js` package is a JavaScript library without binaries. To publish:
+The `@wokwi/client` package is a JavaScript library without binaries. To publish:
 
 1. Navigate to the package directory:
    ```bash
-   cd packages/wokwi-client-js
+   cd packages/client
    ```
 
 2. Clean previous builds:
@@ -190,8 +190,8 @@ The `wokwi-client-js` package is a JavaScript library without binaries. To publi
 To publish both packages in sequence:
 
 ```bash
-# Publish wokwi-client-js first (it's a dependency of wokwi-cli)
-cd packages/wokwi-client-js
+# Publish @wokwi/client first (it's a dependency of wokwi-cli)
+cd packages/client
 pnpm clean && pnpm build && pnpm publish
 
 # Then publish wokwi-cli
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "wokwi-client-js",
+  "name": "@wokwi/client",
   "version": "0.18.3",
   "description": "Wokwi Client JS Library",
   "main": "dist/index.js",
@@ -12,7 +12,7 @@
     },
     "./browser": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/wokwi-client-js.browser.js"
+      "import": "./dist/wokwi-client.browser.js"
     },
     "./transport/MessagePortTransport.js": {
       "types": "./dist/transport/MessagePortTransport.d.ts",
diff --git a/packages/client/src/APIClient.ts b/packages/client/src/APIClient.ts
diff --git a/packages/client/src/APITypes.ts b/packages/client/src/APITypes.ts
diff --git a/packages/client/src/PausePoint.ts b/packages/client/src/PausePoint.ts
diff --git a/packages/client/src/base64.ts b/packages/client/src/base64.ts
diff --git a/packages/client/src/index.ts b/packages/client/src/index.ts
diff --git a/packages/client/src/transport/ITransport.ts b/packages/client/src/transport/ITransport.ts
diff --git a/packages/client/src/transport/MessagePortTransport.ts b/packages/client/src/transport/MessagePortTransport.ts
diff --git a/packages/client/tools/bundle-browser.js b/packages/client/tools/bundle-browser.js
@@ -8,13 +8,13 @@ const rootDir = join(__dirname, '..');
 
 const options = {
   entryPoints: [join(rootDir, 'src/index.ts')],
-  outfile: join(rootDir, 'dist/wokwi-client-js.browser.js'),
+  outfile: join(rootDir, 'dist/wokwi-client.browser.js'),
   bundle: true,
   platform: 'browser',
   format: 'esm',
   target: 'es2020',
   banner: {
-    js: `// Browser bundle of wokwi-client-js
+    js: `// Browser bundle of @wokwi/client
     // Use MessagePortTransport for browser communication with Wokwi Simulator
 `,
   },
@@ -23,7 +23,7 @@ const options = {
 // Build the browser bundle
 build(options)
   .then(() => {
-    console.log('✓ Browser bundle created: dist/wokwi-client-js.browser.js');
+    console.log('✓ Browser bundle created: dist/wokwi-client.browser.js');
   })
   .catch((error) => {
     console.error('✗ Browser bundle failed:', error);
diff --git a/packages/client/tsconfig.json b/packages/client/tsconfig.json
diff --git a/packages/wokwi-cli/package.json b/packages/wokwi-cli/package.json
@@ -56,7 +56,7 @@
     "chalk": "^5.3.0",
     "chalk-template": "^1.1.0",
     "pngjs": "^7.0.0",
-    "wokwi-client-js": "workspace:*",
+    "@wokwi/client": "workspace:*",
     "ws": "^8.13.0",
     "yaml": "^2.3.1"
   },
diff --git a/packages/wokwi-cli/src/TestScenario.ts b/packages/wokwi-cli/src/TestScenario.ts
@@ -1,5 +1,5 @@
 import chalkTemplate from 'chalk-template';
-import type { APIClient } from 'wokwi-client-js';
+import type { APIClient } from '@wokwi/client';
 
 export interface IScenarioCommand {
   /** Validates the input to the command. Throws an exception of the input is not valid */
diff --git a/packages/wokwi-cli/src/main.ts b/packages/wokwi-cli/src/main.ts
@@ -8,7 +8,7 @@ import {
   type APIEvent,
   type ChipsLogPayload,
   type SerialMonitorDataPayload,
-} from 'wokwi-client-js';
+} from '@wokwi/client';
 import { WebSocketTransport } from './transport/WebSocketTransport.js';
 import { DEFAULT_SERVER } from './constants.js';
 import { createSerialMonitorWritable } from './utils/serialMonitorWritable.js';
diff --git a/packages/wokwi-cli/src/mcp/SimulationManager.ts b/packages/wokwi-cli/src/mcp/SimulationManager.ts
@@ -1,6 +1,6 @@
 import { existsSync, readFileSync } from 'fs';
 import path from 'path';
-import { APIClient, SerialMonitorDataPayload, type APIEvent } from 'wokwi-client-js';
+import { APIClient, SerialMonitorDataPayload, type APIEvent } from '@wokwi/client';
 import { WebSocketTransport } from '../transport/WebSocketTransport.js';
 import { DEFAULT_SERVER } from '../constants.js';
 import { parseConfig } from '../config.js';
diff --git a/packages/wokwi-cli/src/scenario/DelayCommand.ts b/packages/wokwi-cli/src/scenario/DelayCommand.ts
@@ -1,5 +1,5 @@
 import chalkTemplate from 'chalk-template';
-import { type APIClient } from 'wokwi-client-js';
+import { type APIClient } from '@wokwi/client';
 import { type TestScenario } from '../TestScenario.js';
 import { parseTime } from '../utils/parseTime.js';
 
diff --git a/packages/wokwi-cli/src/scenario/ExpectPinCommand.ts b/packages/wokwi-cli/src/scenario/ExpectPinCommand.ts
@@ -1,5 +1,5 @@
 import chalkTemplate from 'chalk-template';
-import type { APIClient } from 'wokwi-client-js';
+import type { APIClient } from '@wokwi/client';
 import type { IScenarioCommand, TestScenario } from '../TestScenario.js';
 
 export interface IExpectPinParams {
diff --git a/packages/wokwi-cli/src/scenario/SetControlCommand.ts b/packages/wokwi-cli/src/scenario/SetControlCommand.ts
@@ -1,4 +1,4 @@
-import { type APIClient } from 'wokwi-client-js';
+import { type APIClient } from '@wokwi/client';
 import { type TestScenario } from '../TestScenario.js';
 
 export interface ISetControlParams {
diff --git a/packages/wokwi-cli/src/scenario/TakeScreenshotCommand.ts b/packages/wokwi-cli/src/scenario/TakeScreenshotCommand.ts
@@ -1,7 +1,7 @@
 import { readFile, writeFile } from 'fs/promises';
 import path from 'path';
 import { PNG } from 'pngjs';
-import { base64ToByteArray, type APIClient } from 'wokwi-client-js';
+import { base64ToByteArray, type APIClient } from '@wokwi/client';
 import { type TestScenario } from '../TestScenario.js';
 
 export interface ITakeScreenshotParams {
diff --git a/packages/wokwi-cli/src/scenario/WaitSerialCommand.ts b/packages/wokwi-cli/src/scenario/WaitSerialCommand.ts
@@ -1,5 +1,5 @@
 import chalkTemplate from 'chalk-template';
-import type { APIClient } from 'wokwi-client-js';
+import type { APIClient } from '@wokwi/client';
 import type { IScenarioCommand, TestScenario } from '../TestScenario.js';
 
 const encoder = new TextEncoder();
diff --git a/packages/wokwi-cli/src/scenario/WriteSerialCommand.ts b/packages/wokwi-cli/src/scenario/WriteSerialCommand.ts
@@ -1,4 +1,4 @@
-import type { APIClient } from 'wokwi-client-js';
+import type { APIClient } from '@wokwi/client';
 import type { IScenarioCommand, TestScenario } from '../TestScenario.js';
 
 const encoder = new TextEncoder();
diff --git a/packages/wokwi-cli/src/transport/WebSocketTransport.ts b/packages/wokwi-cli/src/transport/WebSocketTransport.ts
@@ -1,4 +1,4 @@
-import { type ITransport } from 'wokwi-client-js';
+import { type ITransport } from '@wokwi/client';
 import { WebSocket } from 'ws';
 
 const retryDelays = [1000, 2000, 5000, 10000, 20000];
diff --git a/packages/wokwi-cli/src/uploadFirmware.ts b/packages/wokwi-cli/src/uploadFirmware.ts
@@ -1,6 +1,6 @@
 import { readFileSync } from 'fs';
 import { basename, dirname, resolve } from 'path';
-import { type APIClient } from 'wokwi-client-js';
+import { type APIClient } from '@wokwi/client';
 import { type IESP32FlasherJSON } from './esp/flasherArgs.js';
 
 interface IFirmwarePiece {
diff --git a/packages/wokwi-cli/src/utils/serialMonitorWritable.ts b/packages/wokwi-cli/src/utils/serialMonitorWritable.ts
@@ -1,4 +1,4 @@
-import type { APIClient } from 'wokwi-client-js';
+import type { APIClient } from '@wokwi/client';
 import { Writable } from 'stream';
 import { Buffer } from 'buffer';
 
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/wokwi-embed/index.html b/test/wokwi-embed/index.html
@@ -7,7 +7,7 @@
     <script type="importmap">
       {
         "imports": {
-          "wokwi-client-js": "/packages/wokwi-client-js/dist/index.js"
+          "@wokwi/client": "/packages/client/dist/index.js"
         }
       }
     </script>
diff --git a/test/wokwi-embed/script.js b/test/wokwi-embed/script.js
@@ -1,4 +1,4 @@
-import { MessagePortTransport, APIClient } from 'wokwi-client-js';
+import { MessagePortTransport, APIClient } from '@wokwi/client';
 
 const diagram = `{
   "version": 1,
