@rtc-agent/component 0.2.4 → 0.2.6-rc.0

package/README.md

@@ -2,6 +2,55 @@
 
 基于 Lit 的 Web Component 组件库，提供浮窗式 RTC Agent 交互界面。
 
+## 快速开始
+
+### 安装
+
+```bash
+pnpm add @rtc-agent/component
+```
+
+### 使用工厂函数（推荐）
+
+```ts
+import { createRtcAgent } from '@rtc-agent/component';
+
+const agent = createRtcAgent({
+  appLabel: 'My Assistant',
+  server: { url: 'https://api.example.com' },
+  auth: {
+    getToken: () => localStorage.getItem('token'),
+    refreshToken: async () => {
+      const res = await fetch('/api/refresh');
+      const data = await res.json();
+      return { accessToken: data.token };
+    },
+    userId: 'user-123',
+  },
+});
+
+document.body.appendChild(agent);
+
+// 销毁
+agent.destroy();
+```
+
+完整 API 文档见 [API.md](./API.md)，更多示例见 [EXAMPLES.md](./EXAMPLES.md)。
+
+### 使用 HTML 元素
+
+```html
+<script type="module">
+  import '@rtc-agent/component';
+</script>
+
+<rtc-agent
+  theme="system"
+  app-label="RTC Agent"
+  scenarios-url="./scenarios/"
+></rtc-agent>
+```
+
 ## 导出
 
 ### 组件
@@ -18,6 +67,17 @@ import { RtcAgent } from '@rtc-agent/component';
 const agent = document.querySelector<RtcAgent>('rtc-agent')!;
 ```
 
+### 工厂函数
+
+- `createRtcAgent` — 声明式创建 `<rtc-agent>` 实例
+
+```ts
+import { createRtcAgent } from '@rtc-agent/component';
+const agent = createRtcAgent({ /* ... */ });
+```
+
+详细配置见 [API.md](./API.md)。
+
 ## 用法
 
 ```html

package/bin/rtc-agent-setup.js

@@ -0,0 +1,189 @@
+#!/usr/bin/env node
+
+/**
+ * RTC Agent SharedWorker Setup Tool
+ *
+ * Automatically copies the SharedWorker file to the host application's public directory.
+ * This solves the NPM distribution problem where the worker file inside node_modules
+ * cannot be accessed by the browser.
+ *
+ * Usage:
+ *   npx rtc-agent-setup
+ *
+ * Or in package.json:
+ *   "scripts": {
+ *     "postinstall": "rtc-agent-setup"
+ *   }
+ */
+
+import { existsSync, mkdirSync, copyFileSync, readFileSync, readdirSync, writeFileSync } from 'fs';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+/**
+ * Detect project type based on dependencies
+ */
+function detectProjectType(cwd) {
+  const packageJsonPath = join(cwd, 'package.json');
+  if (!existsSync(packageJsonPath)) {
+    return null;
+  }
+
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+  const allDeps = {
+    ...packageJson.dependencies,
+    ...packageJson.devDependencies,
+  };
+
+  // Detect SvelteKit first (more specific, also uses Vite)
+  if (allDeps?.['@sveltejs/kit']) {
+    return 'sveltekit';
+  }
+
+  // Detect Vite (generic)
+  if (allDeps?.vite) {
+    return 'vite';
+  }
+
+  // Detect Webpack
+  if (allDeps?.webpack) {
+    return 'webpack';
+  }
+
+  return 'generic';
+}
+
+/**
+ * Get target directory based on project type
+ */
+function getTargetDir(projectType, cwd) {
+  switch (projectType) {
+    case 'sveltekit':
+      // SvelteKit uses 'static' directory for static assets
+      return join(cwd, 'static', 'rtc-agent');
+    case 'vite':
+      // Plain Vite projects typically use 'public' directory
+      return join(cwd, 'public', 'rtc-agent');
+    case 'webpack':
+      return join(cwd, 'static', 'rtc-agent');
+    default:
+      return join(cwd, 'public', 'rtc-agent');
+  }
+}
+
+/**
+ * Copy SharedWorker files to target directory
+ */
+function copyWorkerFiles(targetDir) {
+  const sourceDir = join(__dirname, '..', 'dist', 'assets');
+
+  if (!existsSync(sourceDir)) {
+    console.error('❌ Error: Cannot find @rtc-agent/component dist files');
+    console.error('   Please ensure the package is built correctly');
+    process.exit(1);
+  }
+
+  // Create target directory
+  if (!existsSync(targetDir)) {
+    mkdirSync(targetDir, { recursive: true });
+    console.log(`📁 Created directory: ${targetDir}`);
+  }
+
+  // Find and copy shared-worker files
+  const distFiles = readdirSync(sourceDir);
+  const workerFiles = distFiles.filter(f => f.startsWith('shared-worker') && f.endsWith('.js'));
+
+  if (workerFiles.length === 0) {
+    console.warn('⚠️  Warning: No shared-worker files found in dist/assets');
+    console.log('   Available files:', distFiles.join(', '));
+    return 0;
+  }
+
+  let copiedCount = 0;
+  let mainWorkerFile = null;
+
+  for (const file of workerFiles) {
+    const sourcePath = join(sourceDir, file);
+    const targetPath = join(targetDir, file);
+    copyFileSync(sourcePath, targetPath);
+    console.log(`✅ Copied ${file} → ${targetDir}`);
+    copiedCount++;
+
+    // Track the main worker file (without .map or other extensions)
+    if (file.endsWith('.js') && !file.includes('.map')) {
+      mainWorkerFile = file;
+    }
+  }
+
+  // Create a stable symlink or copy without hash for easy reference
+  if (mainWorkerFile && mainWorkerFile !== 'shared-worker.js') {
+    const stablePath = join(targetDir, 'shared-worker.js');
+    copyFileSync(join(targetDir, mainWorkerFile), stablePath);
+    console.log(`✅ Created stable link: shared-worker.js → ${mainWorkerFile}`);
+  }
+
+  // Create manifest.json with version info
+  const packageJsonPath = join(__dirname, '..', 'package.json');
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+
+  const manifest = {
+    version: packageJson.version,
+    workerFile: mainWorkerFile,
+    stableWorkerUrl: '/rtc-agent/shared-worker.js',
+    timestamp: new Date().toISOString(),
+  };
+
+  writeFileSync(
+    join(targetDir, 'manifest.json'),
+    JSON.stringify(manifest, null, 2)
+  );
+  console.log(`✅ Created manifest.json (version ${packageJson.version})`);
+
+  return copiedCount;
+}
+
+/**
+ * Main entry point
+ */
+async function main() {
+  console.log('🔧 RTC Agent SharedWorker Setup\n');
+
+  const cwd = process.cwd();
+  const projectType = detectProjectType(cwd);
+
+  if (!projectType) {
+    console.error('❌ Error: No package.json found in current directory');
+    process.exit(1);
+  }
+
+  console.log(`📦 Detected project type: ${projectType}`);
+
+  const targetDir = getTargetDir(projectType, cwd);
+  console.log(`📂 Target directory: ${targetDir}\n`);
+
+  const copiedFiles = copyWorkerFiles(targetDir);
+
+  if (copiedFiles > 0) {
+    console.log('\n✅ Setup complete!');
+    console.log('\nNext steps:');
+    console.log('  1. SharedWorker files are now available in your public directory');
+    console.log('  2. Configure createRtcAgent() to use the worker:');
+    console.log('     createRtcAgent({');
+    console.log('       workerUrl: \'/rtc-agent/shared-worker.js\'');
+    console.log('     })');
+    console.log('  3. When upgrading @rtc-agent/component, run:');
+    console.log('     npx rtc-agent-setup');
+    console.log('     This will update the worker files and manifest.json');
+  } else {
+    console.log('\n⚠️  Setup completed with warnings');
+    console.log('   Please check if @rtc-agent/component is installed correctly');
+  }
+}
+
+main().catch(err => {
+  console.error('❌ Setup failed:', err);
+  process.exit(1);
+});