@wangofnextdoor/zzd-config/README.md

浙政钉配置和流量分析工具包

# @wx/zzd-config

浙政钉配置和流量分析工具包

## 安装

```bash
npm install @wx/zzd-config
```

## 使用方法

### 初始化流量分析

```typescript
import { initFlowAnalysis, setUserInfo, sendPageView } from '@wx/zzd-config';

// 初始化流量分析
await initFlowAnalysis();

// 设置用户信息
setUserInfo('user123', 'device456');

// 发送页面浏览埋点
sendPageView({
  page_id: 'home',
  page_name: '首页'
});
```

### 初始化WPK日志

```typescript
import { initWpkLog } from '@wx/zzd-config';

// 使用默认配置初始化
await initWpkLog();

// 使用自定义配置初始化
await initWpkLog({
  bid: 'custom_bid',
  signkey: 'custom_key',
  gateway: 'https://custom.gateway.com'
});
```

### 配置管理

```typescript
import { getAppConfig } from '@wx/zzd-config';

// 获取当前应用配置
const config = getAppConfig();
console.log(config);
```

## API 文档

### initFlowAnalysis()
初始化流量分析SDK

### setUserInfo(userId: string, deviceId?: string)
设置用户信息

### sendPageView(params?: PageViewParams)
发送页面浏览埋点

### initWpkLog(config?: Partial<WpkConfig>)
初始化WPK日志

### getAppConfig()
获取应用配置

## 类型定义

```typescript
interface PageViewParams {
  sapp_id?: string;
  sapp_name?: string;
  page_id?: string;
  page_name?: string;
  page_url?: string;
  [key: string]: any;
}

interface WpkConfig {
  bid: string;
  signkey: string;
  gateway: string;
}
```

## 注意事项

1. 此包只能在浏览器环境中使用
2. 需要确保网络能够访问相关的CDN资源
3. 在SSR环境中使用时需要做好环境检查