@deepsure/page-replay-sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,29 +1,29 @@
-# 金融监管录制系统 JavaScript SDK
+# Page Replay JavaScript SDK
 
-用于金融场景的会话录制和回溯，支持自动会话管理、增量上传和数据脱敏。
+A JavaScript SDK for page session recording and replay, supporting automatic session management, incremental uploads, and data masking.
 
-## 安装
+## Installation
 
-### CDN 引入
+### CDN
 
 ```html
 <script src="https://cdn.yourplatform.com/sdk/v1/recorder.js"></script>
 ```
 
-### NPM 安装
+### NPM
 
 ```bash
-npm install @finance-recorder/sdk
+npm install @deepsure/page-replay-sdk
 ```
 
-## 快速开始
+## Quick Start
 
-### 基础用法
+### Basic Usage
 
 ```html
 <script src="https://cdn.yourplatform.com/sdk/v1/recorder.js"></script>
 <script>
-  FinanceRecorder.init({
+  PageRecorder.init({
     apiKey: 'your_api_key',
     projectId: 'proj_12345',
     autoStart: true
@@ -31,45 +31,45 @@ npm install @finance-recorder/sdk
 </script>
 ```
 
-### 完整配置
+### Full Configuration
 
 ```javascript
-import FinanceRecorder from '@finance-recorder/sdk';
+import PageRecorder from '@deepsure/page-replay-sdk';
 
-await FinanceRecorder.init({
-  // 必需配置
-  apiKey: 'your_api_key',              // API 密钥
-  projectId: 'proj_12345',             // 项目 ID
+await PageRecorder.init({
+  // Required configuration
+  apiKey: 'your_api_key',              // API key
+  projectId: 'proj_12345',             // Project ID
   
-  // 可选配置
-  apiBaseUrl: 'https://api.yourplatform.com',  // API 地址
-  autoStart: true,                     // 自动开始录制
-  chunkSize: 100,                      // 批量上传大小
-  uploadInterval: 30000,               // 上传间隔（毫秒）
+  // Optional configuration
+  apiBaseUrl: 'https://api.yourplatform.com',  // API base URL
+  autoStart: false,                     // Auto-start recording
+  chunkSize: 100,                      // Batch upload size
+  uploadInterval: 30000,               // Upload interval (milliseconds)
   
-  // 隐私配置
+  // Privacy configuration
   privacy: {
-    maskAllInputs: false,              // 是否屏蔽所有输入
+    maskAllInputs: false,              // Mask all inputs
     maskInputOptions: {
-      idCard: true,                    // 身份证脱敏
-      phone: true,                     // 手机号脱敏
-      bankCard: true,                  // 银行卡脱敏
+      idCard: true,                    // Mask ID card numbers
+      phone: true,                     // Mask phone numbers
+      bankCard: true,                  // Mask bank card numbers
     }
   },
   
-  // 业务元数据
+  // Business metadata
   metadata: {
-    productType: '车险',               // 产品类型
-    quoteId: 'quote_789',              // 报价单号
-    userId: 'user_123'                 // 用户 ID
+    productType: 'Auto Insurance',     // Product type
+    quoteId: 'quote_789',              // Quote ID
+    userId: 'user_123'                 // User ID
   },
   
-  // 回调函数
+  // Callback functions
   onSessionCreated: (session) => {
-    console.log('会话已创建:', session.sessionId);
+    console.log('Session created:', session.sessionId);
   },
   onUploadProgress: (progress) => {
-    console.log('上传进度:', progress);
+    console.log('Upload progress:', progress);
   },
   onError: (message, error) => {
     console.error(message, error);
@@ -77,66 +77,66 @@ await FinanceRecorder.init({
 });
 ```
 
-## API 参考
+## API Reference
 
 ### init(config)
 
-初始化录制器。
+Initialize the recorder.
 
-**参数：**
-- `apiKey` (string, 必需) - API 密钥
-- `projectId` (string, 必需) - 项目 ID
-- `apiBaseUrl` (string) - API 基础 URL
-- `autoStart` (boolean) - 是否自动开始录制，默认 true
-- `privacy` (object) - 隐私配置
-- `metadata` (object) - 业务元数据
+**Parameters:**
+- `apiKey` (string, required) - API key
+- `projectId` (string, required) - Project ID
+- `apiBaseUrl` (string) - API base URL
+- `autoStart` (boolean) - Whether to auto-start recording, defaults to true
+- `privacy` (object) - Privacy configuration
+- `metadata` (object) - Business metadata
 
-**返回：** Promise<FinanceRecorder>
+**Returns:** Promise<PageRecorder>
 
 ### start(customMetadata?)
 
-手动开始录制。
+Manually start recording.
 
-**参数：**
-- `customMetadata` (object, 可选) - 自定义元数据
+**Parameters:**
+- `customMetadata` (object, optional) - Custom metadata
 
-**返回：** Promise<void>
+**Returns:** Promise<void>
 
 ### stop()
 
-停止录制并上传剩余数据。
+Stop recording and upload remaining data.
 
-**返回：** Promise<string> - 会话 ID
+**Returns:** Promise<string> - Session ID
 
 ### setMetadata(metadata)
 
-更新会话元数据。
+Update session metadata.
 
-**参数：**
-- `metadata` (object) - 要添加/更新的元数据
+**Parameters:**
+- `metadata` (object) - Metadata to add/update
 
 ### getSessionId()
 
-获取当前会话 ID。
+Get the current session ID.
 
-**返回：** string | null
+**Returns:** string | null
 
 ### isRecording()
 
-检查是否正在录制。
+Check if recording is in progress.
 
-**返回：** boolean
+**Returns:** boolean
 
-## 使用场景
+## Use Cases
 
-### 场景 1：保险投保流程录制
+### Use Case 1: Insurance Application Recording
 
 ```javascript
-FinanceRecorder.init({
+PageRecorder.init({
   apiKey: 'your_api_key',
   projectId: 'proj_insurance',
   metadata: {
-    productType: '车险',
+    productType: 'Auto Insurance',
     policyNumber: 'POL-2025-001',
     applicantId: 'user_123'
   },
@@ -150,35 +150,35 @@ FinanceRecorder.init({
 });
 ```
 
-### 场景 2：客服协助录制
+### Use Case 2: Customer Support Recording
 
 ```javascript
-// 仅在客服协助时录制
+// Record only during customer support
 const startAssist = async () => {
-  await FinanceRecorder.init({
+  await PageRecorder.init({
     apiKey: 'your_api_key',
     projectId: 'proj_support',
     autoStart: false
   });
   
-  // 用户同意后开始录制
-  await FinanceRecorder.start({
+  // Start recording after user consent
+  await PageRecorder.start({
     supportTicketId: 'TICKET-123',
     agentId: 'agent_456'
   });
 };
 
 const endAssist = async () => {
-  const sessionId = await FinanceRecorder.stop();
-  console.log('会话已保存:', sessionId);
+  const sessionId = await PageRecorder.stop();
+  console.log('Session saved:', sessionId);
 };
 ```
 
-### 场景 3：动态更新元数据
+### Use Case 3: Dynamic Metadata Updates
 
 ```javascript
-// 初始化
-await FinanceRecorder.init({
+// Initialize
+await PageRecorder.init({
   apiKey: 'your_api_key',
   projectId: 'proj_12345',
   metadata: {
@@ -186,46 +186,46 @@ await FinanceRecorder.init({
   }
 });
 
-// 用户进入下一步
-FinanceRecorder.setMetadata({ step: 'fill_info' });
+// User proceeds to next step
+PageRecorder.setMetadata({ step: 'fill_info' });
 
-// 用户提交申请
-FinanceRecorder.setMetadata({ 
+// User submits application
+PageRecorder.setMetadata({ 
   step: 'submit',
   applicationId: 'APP-2025-001'
 });
 ```
 
-## 隐私保护
+## Privacy Protection
 
-### 自动脱敏
+### Automatic Masking
 
-SDK 自动检测并脱敏以下敏感信息：
+The SDK automatically detects and masks the following sensitive information:
 
-- **身份证号**：`110101199001011234` → `110101********1234`
-- **手机号**：`13812345678` → `138****5678`
-- **银行卡号**：`6222021234567890123` → `622202******123`
+- **ID Card Number**: `110101199001011234` → `110101********1234`
+- **Phone Number**: `13812345678` → `138****5678`
+- **Bank Card Number**: `6222021234567890123` → `622202******123`
 
-### 手动屏蔽元素
+### Manual Element Blocking
 
-在 HTML 中添加 `rr-block` 类名：
+Add the `rr-block` class name in HTML:
 
 ```html
 <div class="rr-block">
-  这个区域不会被录制
+  This area will not be recorded
 </div>
 ```
 
-## 最佳实践
+## Best Practices
 
-### 1. 错误处理
+### 1. Error Handling
 
 ```javascript
-FinanceRecorder.init({
+PageRecorder.init({
   apiKey: 'your_api_key',
   projectId: 'proj_12345',
   onError: (message, error) => {
-    // 上报到错误监控系统
+    // Report to error monitoring system
     Sentry.captureException(error, {
       tags: { component: 'recorder' },
       extra: { message }
@@ -234,12 +234,12 @@ FinanceRecorder.init({
 });
 ```
 
-### 2. 性能监控
+### 2. Performance Monitoring
 
 ```javascript
 const perfObserver = new PerformanceObserver((list) => {
   for (const entry of list.getEntries()) {
-    FinanceRecorder.setMetadata({
+    PageRecorder.setMetadata({
       [`perf_${entry.name}`]: entry.duration
     });
   }
@@ -248,14 +248,14 @@ const perfObserver = new PerformanceObserver((list) => {
 perfObserver.observe({ entryTypes: ['navigation', 'resource'] });
 ```
 
-### 3. 用户同意
+### 3. User Consent
 
 ```javascript
-// 显示用户同意弹窗
+// Show user consent dialog
 const consent = await showConsentDialog();
 
 if (consent) {
-  await FinanceRecorder.init({
+  await PageRecorder.init({
     apiKey: 'your_api_key',
     projectId: 'proj_12345',
     metadata: {
@@ -266,14 +266,13 @@ if (consent) {
 }
 ```
 
-## 浏览器兼容性
+## Browser Compatibility
 
 - Chrome 60+
 - Firefox 55+
 - Safari 11+
 - Edge 79+
 
-## 许可证
+## License
 
 MIT
-