@dyyz1993/create-agent 2.1.0 → 2.1.2

package/templates/browser-agent/eslint.config.mjs

@@ -0,0 +1,79 @@
+import js from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import rpcPlugin from '@dyyz1993/eslint-plugin-rpc';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+
+export default tseslint.config(
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    ignores: [
+      'node_modules/**',
+      'build/**',
+      'dist/**',
+      'dist-electron/**',
+      'electron/**',
+      'postcss.config.js',
+      'tailwind.config.js',
+    ],
+  },
+  {
+    files: ['src/**/*.{ts,tsx}'],
+    plugins: {
+      rpc: rpcPlugin,
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+      'jsx-a11y': jsxA11y,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-hooks/rules-of-hooks': 'warn',
+      'react-hooks/exhaustive-deps': 'warn',
+      'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
+      ...jsxA11y.configs.recommended.rules,
+      'jsx-a11y/click-events-have-key-events': 'warn',
+      'jsx-a11y/no-static-element-interactions': 'warn',
+      'jsx-a11y/no-autofocus': 'warn',
+      // TS 严格规则
+      '@typescript-eslint/no-explicit-any': 'error',
+      '@typescript-eslint/no-empty-object-type': ['error', { allowObjectTypes: 'always', allowInterfaces: 'with-single-extends' }],
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+      '@typescript-eslint/ban-ts-comment': ['error', {
+        'ts-expect-error': 'allow-with-description',
+        'ts-ignore': true,
+        'ts-nocheck': true,
+        'ts-check': false,
+        minimumDescriptionLength: 3,
+      }],
+      'no-empty': ['error', { allowEmptyCatch: true }],
+      'no-console': ['error', { allow: ['warn', 'error'] }],
+
+      // RPC 规范规则（严格模式，全部 error）
+      'rpc/no-bare-method': 'error',
+      'rpc/no-direct-register': 'error',
+      'rpc/schema-merge-only': 'error',
+      'rpc/module-file-naming': 'error',
+      'rpc/require-typed-register': 'error',
+      'rpc/require-api-client': 'error',
+      'rpc/no-hardcoded-strings': 'warn',
+    },
+  },
+  {
+    files: ['src/shared/lib/logger.ts'],
+    rules: {
+      'no-console': 'off',
+    },
+  },
+  {
+    files: ['src/**/__tests__/**/*.{ts,tsx}'],
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unsafe-function-type': 'off',
+    },
+  },
+);

package/templates/browser-agent/llms.txt

@@ -0,0 +1,24 @@
+# Electrobun Project
+
+This is an Electrobun desktop application.
+
+IMPORTANT: Electrobun is NOT Electron. Do not use Electron APIs or patterns.
+
+## Documentation
+
+Full API reference: https://blackboard.sh/electrobun/llms.txt
+Getting started: https://blackboard.sh/electrobun/docs/
+
+## Quick Reference
+
+Import patterns:
+- Main process (Bun): `import { BrowserWindow } from "electrobun/bun"`
+- Browser context: `import { Electroview } from "electrobun/view"`
+
+Use `views://` URLs to load bundled assets (e.g., `url: "views://mainview/index.html"`).
+Views must be configured in `electrobun.config.ts` to be built and copied into the bundle.
+
+## About
+
+Electrobun is built by Blackboard (https://blackboard.sh), an innovation lab building
+tools and funding teams that define the next generation of technology.

package/templates/browser-agent/package.json

@@ -0,0 +1,140 @@
+{
+	"name": "browser-agent-app",
+	"version": "1.0.2",
+	"description": "Browser automation agent: AI-powered browser control (Desktop + Web)",
+	"author": {
+		"name": "xuyingzhou",
+		"email": "xuyingzhou@tuzhanai.com"
+	},
+	"homepage": "https://github.com/dyyz1993/pi-agent-template",
+	"main": "electron/main.js",
+	"build": {
+		"appId": "com.piagent.app",
+		"productName": "Pi Agent",
+		"directories": {
+			"output": "dist-electron"
+		},
+		"files": [
+			"dist/**/*",
+			"electron/**/*",
+			"package.json"
+		],
+		"mac": {
+			"category": "public.app-category.developer-tools",
+			"target": [
+				{
+					"target": "dmg",
+					"arch": [
+						"x64",
+						"arm64"
+					]
+				}
+			]
+		},
+		"win": {
+			"target": [
+				{
+					"target": "nsis",
+					"arch": [
+						"x64"
+					]
+				}
+			]
+		},
+		"linux": {
+			"maintainer": "xuyingzhou <xuyingzhou@tuzhanai.com>",
+			"target": [
+				"AppImage",
+				"deb"
+			],
+			"category": "Development"
+		}
+	},
+	"scripts": {
+		"start": "vite build && electrobun dev",
+		"dev": "electrobun dev --watch",
+		"dev:web": "bun scripts/dev.ts",
+		"dev:server": "bun src/server.ts",
+		"build": "vite build",
+		"build:canary": "vite build && electrobun build --env=canary",
+		"build:mac": "vite build && electrobun build --env=canary",
+		"build:win": "vite build && electrobun build --env=canary",
+		"build:linux": "vite build && electrobun build --env=canary",
+		"electron:dev": "vite build && electron .",
+		"electron:build": "vite build && electron-builder --mac --win --linux",
+		"electron:build:mac": "vite build && electron-builder --mac",
+		"electron:build:win": "vite build && electron-builder --win",
+		"electron:build:linux": "vite build && electron-builder --linux",
+		"lint": "eslint .",
+		"lint:fix": "eslint . --fix",
+		"format": "prettier --write .",
+		"format:check": "prettier --check .",
+		"test": "vitest run",
+		"test:watch": "vitest",
+		"test:coverage": "vitest run --coverage",
+		"prepare": "husky"
+	},
+	"dependencies": {
+		"@dyyz1993/pi-coding-agent": "^0.74.61",
+		"@dyyz1993/rpc-core": "^2.2.1",
+		"@tanstack/react-virtual": "^3.13.24",
+		"electrobun": "1.18.1",
+		"lucide-react": "^1.9.0",
+		"prism-react-renderer": "^2.4.1",
+		"react": "^18.3.1",
+		"react-diff-viewer-continued": "^4.2.2",
+		"i18next": "^24.2.2",
+		"i18next-browser-languagedetector": "^8.0.4",
+		"react-dom": "^18.3.1",
+		"react-i18next": "^15.4.1",
+		"react-markdown": "^10.1.0",
+		"remark-gfm": "^4.0.1",
+		"zustand": "^5.0.12"
+	},
+	"devDependencies": {
+		"@dyyz1993/eslint-plugin-rpc": "^1.1.0",
+		"@eslint/js": "^9.0.0",
+		"@testing-library/jest-dom": "^6.9.1",
+		"@testing-library/react": "^16.3.2",
+		"@testing-library/user-event": "^14.6.1",
+		"@types/bun": "latest",
+		"@types/react": "^18.3.12",
+		"@types/react-dom": "^18.3.1",
+		"@types/ws": "^8.18.1",
+		"@vitejs/plugin-react": "^4.3.4",
+		"autoprefixer": "^10.4.20",
+		"concurrently": "^9.1.0",
+		"electron": "^42.1.0",
+		"electron-builder": "^26.8.1",
+		"eslint": "^9.0.0",
+		"eslint-plugin-jsx-a11y": "^6.10.0",
+		"eslint-plugin-react-hooks": "^5.2.0",
+		"eslint-plugin-react-refresh": "^0.4.20",
+		"happy-dom": "^20.9.0",
+		"husky": "^9.1.0",
+		"jsdom": "^29.1.1",
+		"postcss": "^8.4.49",
+		"tailwindcss": "^3.4.16",
+		"typescript": "^5.7.2",
+		"typescript-eslint": "^8.0.0",
+		"vite": "^6.0.3",
+		"vitest": "^4.1.5",
+		"ws": "^8.18.0",
+		"@commitlint/cli": "^19.8.1",
+		"@commitlint/config-conventional": "^19.8.1",
+		"prettier": "^3.5.3",
+		"lint-staged": "^15.5.2"
+	},
+	"lint-staged": {
+		"*.{ts,tsx}": [
+			"eslint --fix",
+			"prettier --write"
+		],
+		"*.{json,md,css,html}": [
+			"prettier --write"
+		]
+	},
+	"overrides": {
+		"minimatch": "^10.0.1"
+	}
+}

package/templates/browser-agent/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+	plugins: {
+		tailwindcss: {},
+		autoprefixer: {},
+	},
+};

package/templates/browser-agent/scripts/dev.ts

@@ -0,0 +1,138 @@
+/**
+ * Dev orchestration script — single command to start backend + Vite.
+ *
+ * Usage: bun run dev:web
+ *
+ * 1. Starts backend server (dynamic port, writes to .server-port)
+ * 2. Waits for .server-port to appear
+ * 3. Starts Vite dev server (reads backend port for proxy)
+ * 4. On Ctrl+C / SIGTERM: kills both processes, cleans up .server-port
+ */
+
+import { spawn } from "child_process";
+import { existsSync, readFileSync, unlinkSync } from "fs";
+import { resolve } from "path";
+
+const ROOT = resolve(import.meta.dir, "..");
+const PORT_FILE = resolve(ROOT, ".server-port");
+const MAX_WAIT_MS = 10000;
+const POLL_INTERVAL_MS = 100;
+
+let backend: ReturnType<typeof spawn> | null = null;
+let vite: ReturnType<typeof spawn> | null = null;
+let shuttingDown = false;
+
+function cleanup() {
+  if (shuttingDown) return;
+  shuttingDown = true;
+
+  if (vite && !vite.killed) {
+    vite.kill("SIGTERM");
+  }
+  if (backend && !backend.killed) {
+    backend.kill("SIGTERM");
+  }
+  try { if (existsSync(PORT_FILE)) unlinkSync(PORT_FILE); } catch { /* ignore cleanup errors */ }
+
+  setTimeout(() => {
+    if (backend && !backend.killed) backend.kill("SIGKILL");
+    if (vite && !vite.killed) vite.kill("SIGKILL");
+    process.exit(0);
+  }, 3000);
+}
+
+process.on("SIGINT", cleanup);
+process.on("SIGTERM", cleanup);
+process.on("exit", () => {
+  try { if (existsSync(PORT_FILE)) unlinkSync(PORT_FILE); } catch { /* ignore */ }
+});
+
+function log(tag: string, msg: string) {
+  console.log(`[${tag}] ${msg}`);
+}
+
+function waitForPortFile(): Promise<number> {
+  return new Promise((resolve, reject) => {
+    const start = Date.now();
+    const check = () => {
+      if (existsSync(PORT_FILE)) {
+        try {
+          const port = parseInt(readFileSync(PORT_FILE, "utf-8").trim());
+          if (port > 0) { resolve(port); return; }
+        } catch { /* ignore parse errors */ }
+      }
+      if (Date.now() - start > MAX_WAIT_MS) {
+        reject(new Error("Timed out waiting for backend to start"));
+        return;
+      }
+      setTimeout(check, POLL_INTERVAL_MS);
+    };
+    check();
+  });
+}
+
+async function main() {
+  log("dev", "Starting backend server...");
+
+  backend = spawn("bun", ["src/server.ts"], {
+    cwd: ROOT,
+    stdio: ["pipe", "pipe", "pipe"],
+  });
+
+  backend.stdout?.on("data", (data: Buffer) => {
+    data.toString().split("\n").filter(Boolean).forEach((line) => {
+      log("backend", line);
+    });
+  });
+
+  backend.stderr?.on("data", (data: Buffer) => {
+    data.toString().split("\n").filter(Boolean).forEach((line) => {
+      log("backend", line);
+    });
+  });
+
+  backend.on("exit", (code) => {
+    if (!shuttingDown) {
+      log("backend", `exited with code ${code}`);
+      cleanup();
+    }
+  });
+
+  const backendPort = await waitForPortFile();
+  log("dev", `Backend ready on port ${backendPort}`);
+
+  log("dev", "Starting Vite dev server...");
+  vite = spawn("vite", [], {
+    cwd: ROOT,
+    stdio: ["pipe", "pipe", "pipe"],
+    env: { ...process.env },
+  });
+
+  vite.stdout?.on("data", (data: Buffer) => {
+    data.toString().split("\n").filter(Boolean).forEach((line) => {
+      log("vite", line);
+    });
+  });
+
+  vite.stderr?.on("data", (data: Buffer) => {
+    data.toString().split("\n").filter(Boolean).forEach((line) => {
+      log("vite", line);
+    });
+  });
+
+  vite.on("exit", (code) => {
+    if (!shuttingDown) {
+      log("vite", `exited with code ${code}`);
+      cleanup();
+    }
+  });
+
+  log("dev", `Proxy: Vite → http://localhost:${backendPort}`);
+  log("dev", "Press Ctrl+C to stop both servers");
+}
+
+main().catch((err) => {
+  console.error("Dev startup failed:", err.message);
+  cleanup();
+  process.exit(1);
+});

package/templates/browser-agent/src/__tests__/hybrid-mode.test.ts

@@ -0,0 +1,126 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+
+vi.mock("electrobun/bun", () => ({
+	BrowserWindow: {
+		defineRPC: vi.fn(() => ({})),
+	},
+	BrowserView: {
+		defineRPC: vi.fn(() => ({
+			requests: {},
+			messages: {},
+		})),
+	},
+	Updater: {
+		localInfo: vi.fn(() => ({ channel: vi.fn(() => "dev") })),
+	},
+	ApplicationMenu: {
+		setApplicationMenu: vi.fn(),
+	},
+}));
+
+vi.mock("electrobun", () => ({}));
+
+describe("混合模式", () => {
+	beforeEach(() => {
+		vi.resetModules();
+		delete process.env.ENABLE_WEB_SERVICE;
+		delete process.env.AUTH_TOKEN;
+		process.env.NODE_ENV = "test";
+	});
+
+	afterEach(() => {
+		vi.restoreAllMocks();
+	});
+
+	it("默认不启动 Web 服务（enableWebService 为 false）", async () => {
+		const { config } = await import("../server-config");
+		expect(config.enableWebService).toBe(false);
+	});
+
+	it("enableWebService=true 时启动 HTTP + WS 服务", async () => {
+		process.env.ENABLE_WEB_SERVICE = "true";
+		const { config } = await import("../server-config");
+		expect(config.enableWebService).toBe(true);
+	});
+
+	it("IPC 和 WS 服务同时工作，状态隔离", async () => {
+		const { ElectrobunTransport } = await import("../gateway/ipc-transport");
+		const ipcTransport = new ElectrobunTransport();
+		expect(ipcTransport.isConnected()).toBe(false);
+
+		ipcTransport.setBrowserView({ executeJavascript: vi.fn() });
+		expect(ipcTransport.isConnected()).toBe(true);
+
+		const { createWebServer } = await import("../shared/lib/web-server");
+		const webServer = await createWebServer({
+			port: 0,
+			authToken: "test-token",
+			maxUploadSize: 1024,
+			corsOrigin: "*",
+		});
+		expect(webServer.port).toBeGreaterThan(0);
+		expect(ipcTransport.isConnected()).toBe(true);
+		await webServer.close();
+	});
+
+	it("WS 客户端需要 token 才能连接", async () => {
+		const { createWebServer } = await import("../shared/lib/web-server");
+		const webServer = await createWebServer({
+			port: 0,
+			authToken: "test-token",
+			maxUploadSize: 1024,
+			corsOrigin: "*",
+		});
+		expect(webServer.authToken).toBeTruthy();
+		expect(webServer.authToken.length).toBeGreaterThan(0);
+		await webServer.close();
+	});
+
+	it("IPC 客户端不需要 token", async () => {
+		const { ElectrobunTransport } = await import("../gateway/ipc-transport");
+		const transport = new ElectrobunTransport();
+		transport.setBrowserView({ executeJavascript: vi.fn() });
+		expect(transport.isConnected()).toBe(true);
+	});
+
+	it("动态生成的 token 每次启动不同", async () => {
+		const { createWebServer } = await import("../shared/lib/web-server");
+		const ws1 = await createWebServer({
+			port: 0,
+			authToken: `token-${Date.now()}-1`,
+			maxUploadSize: 1024,
+			corsOrigin: "*",
+		});
+		const ws2 = await createWebServer({
+			port: 0,
+			authToken: `token-${Date.now()}-2`,
+			maxUploadSize: 1024,
+			corsOrigin: "*",
+		});
+		expect(ws1.authToken).not.toBe(ws2.authToken);
+		await ws1.close();
+		await ws2.close();
+	});
+
+	it("关闭桌面端时 Web 服务也关闭", async () => {
+		const { createWebServer } = await import("../shared/lib/web-server");
+		const webServer = await createWebServer({
+			port: 0,
+			authToken: "test-token",
+			maxUploadSize: 1024,
+			corsOrigin: "*",
+		});
+		expect(webServer.httpServer.listening).toBe(true);
+		await webServer.close();
+		await new Promise((r) => setTimeout(r, 50));
+		expect(webServer.httpServer.listening).toBe(false);
+	});
+
+	it("getLocalIP 返回有效 IP 地址", async () => {
+		const { getLocalIP } = await import("../shared/lib/web-server");
+		const ip = getLocalIP();
+		expect(ip).toBeTruthy();
+		// IPv4 pattern
+		expect(ip).toMatch(/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/);
+	});
+});

package/templates/browser-agent/src/__tests__/server-config-security.test.ts

@@ -0,0 +1,55 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+
+describe("Server Config 安全策略", () => {
+	const originalEnv = process.env;
+
+	beforeEach(() => {
+		vi.resetModules();
+		process.env = { ...originalEnv };
+	});
+
+	afterEach(() => {
+		process.env = originalEnv;
+	});
+
+	it("生产环境未设 AUTH_TOKEN 应抛出致命错误", async () => {
+		process.env.NODE_ENV = "production";
+		delete process.env.AUTH_TOKEN;
+		await expect(import("../server-config")).rejects.toThrow(/AUTH_TOKEN/);
+	});
+
+	it("开发环境未设 AUTH_TOKEN 应自动生成随机 token", async () => {
+		process.env.NODE_ENV = "development";
+		delete process.env.AUTH_TOKEN;
+		const mod = await import("../server-config");
+		expect(mod.config.authToken).toBeTruthy();
+		expect(mod.config.authToken).not.toBe("pi-agent-template-token");
+		expect(mod.config.authToken.length).toBeGreaterThan(20);
+	});
+
+	it("显式设置 AUTH_TOKEN 应使用用户提供的值", async () => {
+		delete process.env.NODE_ENV;
+		process.env.AUTH_TOKEN = "my-custom-token-12345";
+		const mod = await import("../server-config");
+		expect(mod.config.authToken).toBe("my-custom-token-12345");
+	});
+
+	it("自动生成的 token 每次不同", async () => {
+		process.env.NODE_ENV = "development";
+		delete process.env.AUTH_TOKEN;
+		vi.resetModules();
+		const mod1 = await import("../server-config");
+		const token1 = mod1.config.authToken;
+		vi.resetModules();
+		const mod2 = await import("../server-config");
+		const token2 = mod2.config.authToken;
+		expect(token1).not.toBe(token2);
+	});
+
+	it("生产环境设了 AUTH_TOKEN 不应抛错", async () => {
+		process.env.NODE_ENV = "production";
+		process.env.AUTH_TOKEN = "production-secure-token";
+		const mod = await import("../server-config");
+		expect(mod.config.authToken).toBe("production-secure-token");
+	});
+});

package/templates/browser-agent/src/__tests__/server-config.test.ts

@@ -0,0 +1,59 @@
+import { describe, it, expect } from "vitest";
+import { parseEnvInt } from "../server-config";
+
+describe("parseEnvInt", () => {
+  it("should return default when value is undefined", () => {
+    expect(parseEnvInt("TEST_KEY", undefined, 3100, 1024, 65535)).toBe(3100);
+  });
+
+  it("should return default when value is empty string", () => {
+    expect(parseEnvInt("TEST_KEY", "", 3100, 1024, 65535)).toBe(3100);
+  });
+
+  it("should parse valid number", () => {
+    expect(parseEnvInt("TEST_KEY", "8080", 3100, 1024, 65535)).toBe(8080);
+  });
+
+  it("should return default for NaN input", () => {
+    expect(parseEnvInt("TEST_KEY", "abc", 3100, 1024, 65535)).toBe(3100);
+  });
+
+  it("should return default for out-of-range value (too low)", () => {
+    expect(parseEnvInt("TEST_KEY", "80", 3100, 1024, 65535)).toBe(3100);
+  });
+
+  it("should return default for out-of-range value (too high)", () => {
+    expect(parseEnvInt("TEST_KEY", "99999", 3100, 1024, 65535)).toBe(3100);
+  });
+
+  it("should accept boundary min value", () => {
+    expect(parseEnvInt("TEST_KEY", "1024", 3100, 1024, 65535)).toBe(1024);
+  });
+
+  it("should accept boundary max value", () => {
+    expect(parseEnvInt("TEST_KEY", "65535", 3100, 1024, 65535)).toBe(65535);
+  });
+});
+
+describe("server-config exports", () => {
+  it("should export config with all required fields", async () => {
+    const { config } = await import("../server-config");
+    expect(config).toHaveProperty("port");
+    expect(config).toHaveProperty("authToken");
+    expect(config).toHaveProperty("maxUploadSize");
+    expect(config).toHaveProperty("logDir");
+    expect(config).toHaveProperty("corsOrigin");
+    expect(typeof config.port).toBe("number");
+    expect(typeof config.authToken).toBe("string");
+    expect(typeof config.maxUploadSize).toBe("number");
+    expect(typeof config.corsOrigin).toBe("string");
+  });
+
+  it("should have sensible defaults", async () => {
+    const { config } = await import("../server-config");
+    expect(config.port).toBeGreaterThanOrEqual(1024);
+    expect(config.port).toBeLessThanOrEqual(65535);
+    expect(config.maxUploadSize).toBeGreaterThan(0);
+    expect(config.corsOrigin).toBeTruthy();
+  });
+});