@wong2kim/wmux 1.0.0

package/src/shared/rpc.ts

@@ -0,0 +1,71 @@
+// === JSON-RPC Protocol Types ===
+
+export interface RpcRequest {
+  id: string;
+  method: RpcMethod;
+  params: Record<string, unknown>;
+  token?: string;
+}
+
+export type RpcResponse =
+  | { id: string; ok: true; result: unknown }
+  | { id: string; ok: false; error: string };
+
+// === RPC Method definitions ===
+export type RpcMethod =
+  | 'workspace.list'
+  | 'workspace.new'
+  | 'workspace.focus'
+  | 'workspace.close'
+  | 'workspace.current'
+  | 'surface.list'
+  | 'surface.new'
+  | 'surface.focus'
+  | 'surface.close'
+  | 'pane.list'
+  | 'pane.focus'
+  | 'pane.split'
+  | 'input.send'
+  | 'input.sendKey'
+  | 'input.readScreen'
+  | 'notify'
+  | 'meta.setStatus'
+  | 'meta.setProgress'
+  | 'system.identify'
+  | 'system.capabilities'
+  | 'browser.open'
+  | 'browser.snapshot'
+  | 'browser.click'
+  | 'browser.fill'
+  | 'browser.eval'
+  | 'browser.navigate';
+
+// All available methods as array (for system.capabilities)
+export const ALL_RPC_METHODS = [
+  'workspace.list',
+  'workspace.new',
+  'workspace.focus',
+  'workspace.close',
+  'workspace.current',
+  'surface.list',
+  'surface.new',
+  'surface.focus',
+  'surface.close',
+  'pane.list',
+  'pane.focus',
+  'pane.split',
+  'input.send',
+  'input.sendKey',
+  'input.readScreen',
+  'notify',
+  'meta.setStatus',
+  'meta.setProgress',
+  'system.identify',
+  'system.capabilities',
+  'browser.open',
+  'browser.snapshot',
+  'browser.click',
+  'browser.fill',
+  'browser.eval',
+  'browser.navigate',
+] as const satisfies readonly RpcMethod[];

package/src/shared/types.ts

@@ -0,0 +1,176 @@
+// === Surface: a single terminal instance within a Pane ===
+export interface Surface {
+  id: string;
+  ptyId: string;
+  title: string;
+  shell: string;
+  cwd: string;
+  surfaceType?: 'terminal' | 'browser';
+  browserUrl?: string;
+}
+
+// === Pane: either a leaf (has surfaces) or a branch (has children) ===
+export interface PaneLeaf {
+  id: string;
+  type: 'leaf';
+  surfaces: Surface[];
+  activeSurfaceId: string;
+}
+
+export interface PaneBranch {
+  id: string;
+  type: 'branch';
+  direction: 'horizontal' | 'vertical';
+  children: Pane[];
+  sizes?: number[];
+}
+
+export type Pane = PaneLeaf | PaneBranch;
+
+// === Workspace: a named collection of panes ===
+export interface Workspace {
+  id: string;
+  name: string;
+  rootPane: Pane;
+  activePaneId: string;
+  metadata?: WorkspaceMetadata;
+}
+
+// === Notification ===
+export type NotificationType = 'info' | 'warning' | 'error' | 'agent';
+
+export interface Notification {
+  id: string;
+  surfaceId: string;
+  workspaceId: string;
+  type: NotificationType;
+  title: string;
+  body: string;
+  timestamp: number;
+  read: boolean;
+}
+
+// === Workspace Metadata ===
+export interface WorkspaceMetadata {
+  gitBranch?: string;
+  cwd?: string;
+  listeningPorts?: number[];
+  lastNotification?: number;
+  status?: string;
+  progress?: number;
+  agentName?: string;
+  agentStatus?: AgentStatus;
+}
+
+// === Agent status ===
+export type AgentStatus = 'running' | 'complete' | 'error' | 'waiting' | 'idle';
+
+// === Status indicator colors ===
+export type WorkspaceStatus = 'active' | 'idle' | 'error' | 'running';
+
+// === Custom keybinding ===
+export interface CustomKeybinding {
+  id: string;
+  key: string;        // e.g. 'F7', 'Ctrl+Shift+1'
+  label: string;      // user-defined name
+  command: string;    // text to send to terminal
+  sendEnter: boolean; // append \n after command
+}
+
+// === Session: serialized app state ===
+export interface SessionData {
+  workspaces: Workspace[];
+  activeWorkspaceId: string;
+  sidebarVisible: boolean;
+  // User preferences (persisted across restarts)
+  theme?: string;
+  locale?: string;
+  terminalFontSize?: number;
+  terminalFontFamily?: string;
+  defaultShell?: string;
+  scrollbackLines?: number;
+  sidebarPosition?: 'left' | 'right';
+  notificationSoundEnabled?: boolean;
+  toastEnabled?: boolean;
+  notificationRingEnabled?: boolean;
+  customKeybindings?: CustomKeybinding[];
+}
+
+// === Utility: generate unique IDs ===
+export function generateId(prefix: string): string {
+  return `${prefix}-${crypto.randomUUID()}`;
+}
+
+// === Security: sanitize text before PTY write ===
+
+/**
+ * Strips control characters (\r, \n, \x00-\x1f except \t) from text
+ * that will be written to a PTY, preventing embedded command injection.
+ */
+export function sanitizePtyText(text: string): string {
+  // Remove all control chars except tab (\x09)
+  // eslint-disable-next-line no-control-regex
+  return text.replace(/[\x00-\x08\x0a-\x1f\x7f\u0080-\u009f]/g, '');
+}
+
+/**
+ * Validates and clamps a user-supplied name string.
+ * Returns the trimmed string if valid, or throws if invalid.
+ */
+export function validateName(value: string, label: string, maxLength = 100): string {
+  const trimmed = value.trim();
+  if (trimmed.length === 0) {
+    throw new Error(`${label} must not be empty`);
+  }
+  if (trimmed.length > maxLength) {
+    throw new Error(`${label} must be ${maxLength} characters or fewer`);
+  }
+  return trimmed;
+}
+
+/**
+ * Validates a message body string.
+ * Returns the trimmed string if valid, or throws if invalid.
+ */
+export function validateMessage(value: string, maxLength = 10000): string {
+  const trimmed = value.trim();
+  if (trimmed.length === 0) {
+    throw new Error('Message must not be empty');
+  }
+  if (trimmed.length > maxLength) {
+    throw new Error(`Message must be ${maxLength} characters or fewer`);
+  }
+  return trimmed;
+}
+
+// === Factory functions ===
+export function createSurface(ptyId: string, shell: string, cwd: string): Surface {
+  return {
+    id: generateId('surface'),
+    ptyId,
+    title: shell,
+    shell,
+    cwd,
+  };
+}
+
+export function createLeafPane(surface?: Surface): PaneLeaf {
+  const surfaces = surface ? [surface] : [];
+  return {
+    id: generateId('pane'),
+    type: 'leaf',
+    surfaces,
+    activeSurfaceId: surfaces[0]?.id || '',
+  };
+}
+
+export function createWorkspace(name: string): Workspace {
+  const rootPane = createLeafPane();
+  return {
+    id: generateId('ws'),
+    name,
+    rootPane,
+    activePaneId: rootPane.id,
+  };
+}
+

package/tailwind.config.js

@@ -0,0 +1,11 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  content: [
+    './index.html',
+    './src/renderer/**/*.{ts,tsx}',
+  ],
+  theme: {
+    extend: {},
+  },
+  plugins: [],
+};

package/tsconfig.cli.json

@@ -0,0 +1,24 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "outDir": "dist/cli",
+    "rootDir": "src",
+    "declaration": false,
+    "sourceMap": false
+  },
+  "include": [
+    "src/cli/**/*",
+    "src/shared/rpc.ts",
+    "src/shared/constants.ts",
+    "src/shared/types.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "src/main/**/*",
+    "src/renderer/**/*",
+    "src/preload/**/*"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "commonjs",
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "noImplicitAny": true,
+    "sourceMap": true,
+    "baseUrl": ".",
+    "outDir": "dist",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "jsx": "react-jsx",
+    "strict": true,
+    "paths": {
+      "@shared/*": ["src/shared/*"]
+    }
+  },
+  "include": ["src/**/*", "forge.env.d.ts"]
+}

package/tsconfig.mcp.json

@@ -0,0 +1,25 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "outDir": "dist/mcp",
+    "rootDir": "src",
+    "declaration": false,
+    "sourceMap": false
+  },
+  "include": [
+    "src/mcp/**/*",
+    "src/shared/rpc.ts",
+    "src/shared/constants.ts",
+    "src/shared/types.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "src/main/**/*",
+    "src/renderer/**/*",
+    "src/preload/**/*",
+    "src/cli/**/*"
+  ]
+}

package/vite.main.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  resolve: {
+    browserField: false,
+    conditions: ['node'],
+    mainFields: ['module', 'jsnext:main', 'jsnext'],
+  },
+  build: {
+    rollupOptions: {
+      external: ['node-pty'],
+    },
+  },
+});

package/vite.preload.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  resolve: {
+    browserField: false,
+    conditions: ['node'],
+    mainFields: ['module', 'jsnext:main', 'jsnext'],
+  },
+});

package/vite.renderer.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+
+export default defineConfig({
+  plugins: [react()],
+});