polyv-rum-sdk 0.1.2

package/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish polyv-rum-sdk
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: Build package
+        run: npm run build
+
+      - name: Publish to npm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --access public

package/README.md

@@ -0,0 +1,168 @@
+# polyv-rum-sdk
+
+Polyv RUM SDK，基于 **MitoJS + 阿里云 SLS Web Tracking** 的前端监控采集与日志上报库，支持：
+
+- Core：与框架无关的采集与上报逻辑（MitoJS + SLS）。
+- Vue2：与现有 `live-admin-v3` 的 RUM 使用方式 100% 兼容。
+- Vue3：提供插件工厂与 `useRUM` composable。
+
+## 安装
+
+```bash
+npm install polyv-rum-sdk
+# 或者使用 pnpm / yarn
+```
+
+> 作为依赖使用时，不需要再单独安装 `@mitojs/browser` 和 `@aliyun-sls/web-track-browser`，它们已作为依赖内置。
+
+## 环境变量
+
+SDK 通过 `window.VUE_APP_ENV` 或 `process.env` 读取以下变量（与 `live-admin-v3` 保持一致）：
+
+- SLS 相关
+  - `VUE_APP_SLS_HOST`
+  - `VUE_APP_SLS_PROJECT`
+  - `VUE_APP_SLS_LOGSTORE`
+  - `VUE_APP_SLS_ENABLED`
+- RUM 相关
+  - `VUE_APP_RUM_DSN`
+  - `VUE_APP_RUM_DEBUG`
+  - `VUE_APP_RUM_ENABLED`
+- 通用
+  - `NODE_ENV`
+  - `MODE`
+  - `PACKAGE_VERSION`
+
+## 使用方式
+
+### Vue 2 项目（推荐）
+
+```js
+// main.js
+import Vue from 'vue';
+import router from './router';
+import store from './store';
+import { initRUMSystemVue2 as initRUMSystem } from 'polyv-rum-sdk';
+
+initRUMSystem(
+  { store, router, Vue },
+  {
+    debug: import.meta.env.VUE_APP_RUM_DEBUG === 'true',
+    environment:
+      import.meta.env.MODE || import.meta.env.NODE_ENV || 'development'
+  }
+);
+```
+
+业务代码中可以仍然通过 `this.$rum.xxx` 使用（在 `live-admin-v3` 中通过 alias 或统一替换即可）：
+
+```js
+this.$rum.trackEvent('event_name', { foo: 'bar' });
+```
+
+可用方法：
+
+- `trackEvent(eventName, eventData?)`
+- `trackPerformance(performanceData)`
+- `trackAction(action, actionData?)`
+- `trackMetric(metricName, value, dimensions?)`
+- `getBreadcrumbs()`
+- `enableRUM()` / `disableRUM()`
+- `getRUMConfig()` / `destroyRUM()`
+
+### Vue 3 项目（示例）
+
+```ts
+import { createApp } from 'vue';
+import { createRUMPluginVue3 } from 'polyv-rum-sdk';
+
+const app = createApp(App);
+
+app
+  .use(store)
+  .use(router)
+  .use(
+    createRUMPluginVue3({
+      store,
+      router,
+      coreOptions: {
+        debug: import.meta.env.VUE_APP_RUM_DEBUG === 'true'
+      }
+    })
+  )
+  .mount('#app');
+```
+
+在组件中：
+
+```ts
+import { useRUM } from 'polyv-rum-sdk';
+
+const rum = useRUM();
+rum?.trackEvent('event_name');
+```
+
+### Core 能力（非框架场景）
+
+```ts
+import { initRUMCore } from 'polyv-rum-sdk';
+
+const adapter = await initRUMCore({});
+adapter.trackEvent({ name: 'custom', foo: 'bar' });
+```
+
+## 本地开发
+
+```bash
+# 安装依赖
+npm install
+
+# 构建
+npm run build
+
+# 运行单元测试
+npm test
+
+# 开发模式打包（watch）
+npm run dev
+```
+
+## 发布与 GitHub Actions
+
+本仓库自带一个 GitHub Actions 工作流 `.github/workflows/publish.yml`，用于在打 tag 时自动发布到 npm。
+
+### 前置配置
+
+1. 在 GitHub 仓库的 **Settings → Secrets and variables → Actions → New repository secret** 中添加：
+   - `NPM_TOKEN`: 拥有 `npm publish` 权限的 token。
+2. 确认 `package.json` 中的包名 `"polyv-rum-sdk"` 在 npm 上可用（未被他人占用）。
+
+### 发布流程
+
+1. 在本地修改 `package.json` 的 `version` 字段，或使用：
+
+   ```bash
+   npm version patch   # 或 minor / major
+   ```
+
+2. 推送 tag：
+
+   ```bash
+   git push origin --tags
+   ```
+
+3. GitHub Actions 会在检测到 tag（形如 `v1.2.3`）后自动：
+   - 安装依赖
+   - 运行 `npm test`
+   - 运行 `npm run build`
+   - 执行 `npm publish --access public`
+
+如需手动发布，也可以在本地执行：
+
+```bash
+npm test
+npm run build
+npm publish --access public
+```
+
+确保本地已通过 `npm login` 并具有发布权限。

package/dist/index.d.mts

@@ -0,0 +1,300 @@
+import { App } from 'vue';
+
+interface RUMEnv {
+    [key: string]: string | undefined;
+}
+declare const getRUMEnv: () => RUMEnv;
+declare const RUM_ENV: RUMEnv;
+
+interface SlsConfig {
+    host: string;
+    project: string;
+    logstore: string;
+    time: number;
+    count: number;
+    topic: string;
+    source: string;
+    enabled: boolean;
+    debug: boolean;
+    appName: string;
+    appVersion: string;
+    retryCount: number;
+    retryInterval: number;
+}
+declare const slsConfig: SlsConfig;
+interface MitoSampleRateConfig {
+    error: number;
+    click: number;
+    route: number;
+    custom: number;
+    xhr: number;
+}
+interface MitoConfig {
+    dsn: string | null;
+    appName: string;
+    appVersion: string;
+    environment: string;
+    debug: boolean;
+    maxBreadcrumbs: number;
+    sampleRate: MitoSampleRateConfig;
+    vue: {
+        Vue?: any;
+        lifecycle: boolean;
+        performance: boolean;
+    };
+    network: {
+        xhr: boolean;
+        fetch: boolean;
+        ignoreUrls: (string | RegExp)[];
+        responseSizeLimit: number;
+    };
+    error: {
+        javascript: boolean;
+        promise: boolean;
+        resource: boolean;
+        ignoreErrors: (string | RegExp)[];
+    };
+    user: {
+        click: boolean;
+        route: boolean;
+        performance: boolean;
+        sensitiveSelectors: string[];
+    };
+    breadcrumb: {
+        console: boolean;
+        dom: boolean;
+        navigation: boolean;
+        customTypes: string[];
+    };
+    transport: {
+        type: 'xhr' | 'fetch' | 'image';
+        batch: {
+            size: number;
+            interval: number;
+            immediateOnError: boolean;
+        };
+        retry: {
+            times: number;
+            interval: number;
+        };
+    };
+}
+declare const mitoConfig: MitoConfig;
+interface TransformContext {
+    store?: any;
+    router?: any;
+}
+declare const getUserInfo: (store?: any) => any;
+declare const transformDataForSLS: (data: any, context?: TransformContext) => any;
+declare const shouldReport: (data: any) => boolean;
+
+interface SLSAdapterConfig {
+    host?: string;
+    project?: string;
+    logstore?: string;
+    time?: number;
+    count?: number;
+    topic?: string;
+    source?: string;
+    environment?: string;
+    debug?: boolean;
+    enabled?: boolean;
+    userId?: string | null;
+    sessionId?: string;
+    appName?: string;
+    appVersion?: string;
+    retryCount?: number;
+    retryInterval?: number;
+}
+declare class SLSWebTrackingAdapter {
+    private config;
+    private slsTracker;
+    private isInitialized;
+    private isDestroyed;
+    private pendingLogs;
+    private retryQueue;
+    constructor(config?: SLSAdapterConfig);
+    init(): Promise<void>;
+    sendLog(data: Record<string, any>): Promise<void>;
+    sendBatchLogs(logs: Record<string, any>[]): Promise<void>;
+    transformLogData(data: Record<string, any>): Promise<Record<string, any>>;
+    private addErrorFields;
+    private addApiFields;
+    private addClickFields;
+    private filterSensitiveData;
+    private handleSendError;
+    private retryFailedLogs;
+    private shouldRetry;
+    private handleError;
+    private checkReady;
+    private generateSessionId;
+    handleBeforeSend(logData: any): boolean | Record<string, any>;
+    setUserId(userId: string): void;
+    updateConfig(newConfig: Partial<SLSAdapterConfig>): void;
+    getConfig(): SLSAdapterConfig;
+    getStats(): {
+        isInitialized: boolean;
+        isDestroyed: boolean;
+        pendingLogsCount: number;
+        retryQueueCount: number;
+        config: {
+            project: string | undefined;
+            logstore: string | undefined;
+            enabled: boolean | undefined;
+        };
+    };
+    destroy(): void;
+}
+
+interface MitoSLSAdapterOptions extends MitoConfig {
+    slsConfigOverride?: Partial<SLSAdapterConfig>;
+}
+declare class MitoSLSAdapter {
+    private options;
+    private mitoInstance;
+    private slsAdapter;
+    private store;
+    private router;
+    private isInitialized;
+    constructor(options?: Partial<MitoSLSAdapterOptions>);
+    addBreadcrumb(payload: any): void;
+    init(context?: TransformContext & {
+        Vue?: any;
+    }): Promise<void>;
+    private setupVueIntegration;
+    private setupRouterIntegration;
+    private setupErrorHandling;
+    handleDataReport(data: any): boolean | void;
+    handleRouteChange(to: any, from: any): void;
+    handleError(error: any): void;
+    sendToSLS(data: any): Promise<void>;
+    transformDataForSLSLog(data: any): any;
+    getEventCategory(dataType: string): string;
+    getEventLevel(dataType: string): string;
+    getUserInfoFromStore(): any;
+    shouldTrackMutation(mutation: any): boolean;
+    trackEvent(eventData: Record<string, any>): void;
+    setUser(userInfo: {
+        userId?: string;
+        userName?: string;
+        email?: string;
+        accountId?: string;
+        roles?: string[];
+    }): void;
+    getBreadcrumbs(): any[];
+    destroy(): void;
+}
+declare const getMitoAdapter: (options?: Partial<MitoSLSAdapterOptions>) => MitoSLSAdapter;
+declare const initRUMCore: (context: TransformContext & {
+    Vue?: any;
+}, options?: Partial<MitoSLSAdapterOptions>) => Promise<MitoSLSAdapter>;
+declare const getRUMCoreInstance: () => MitoSLSAdapter | null;
+
+interface RUMManagerContext extends TransformContext {
+    Vue?: any;
+}
+declare class RUMManagerVue2 {
+    private adapter;
+    private isInitialized;
+    private isEnabled;
+    private context;
+    init(context: RUMManagerContext, options?: Partial<MitoSLSAdapterOptions>): Promise<void>;
+    private shouldEnableRUM;
+    private setUserInfo;
+    private setupUserStateListener;
+    private setupUserInteractionTracking;
+    private getCSSSelector;
+    trackEvent(eventName: string, eventData?: Record<string, any>): void;
+    trackPerformance(performanceData: Record<string, any>): void;
+    trackAction(action: string, actionData?: Record<string, any>): void;
+    trackMetric(metricName: string, value: number, dimensions?: Record<string, any>): void;
+    getBreadcrumbs(): any[];
+    enable(): void;
+    disable(): void;
+    private checkRUMAvailable;
+    getConfig(): Record<string, any>;
+    destroy(): void;
+}
+
+declare const initRUMSystem: (context: RUMManagerContext, options?: Partial<MitoSLSAdapterOptions>) => Promise<void>;
+declare const trackEvent: (eventName: string, eventData?: Record<string, any>) => void;
+declare const trackPerformance: (performanceData: Record<string, any>) => void;
+declare const trackAction: (action: string, actionData?: Record<string, any>) => void;
+declare const trackMetric: (metricName: string, value: number, dimensions?: Record<string, any>) => void;
+declare const getBreadcrumbs: () => any[];
+declare const enableRUM: () => void;
+declare const disableRUM: () => void;
+declare const getRUMConfig: () => Record<string, any>;
+declare const destroyRUM: () => void;
+declare const getRUMManager: () => RUMManagerVue2;
+declare const RUMPluginVue2: {
+    install(Vue: any): void;
+};
+
+declare const plugin_vue2_RUMPluginVue2: typeof RUMPluginVue2;
+declare const plugin_vue2_destroyRUM: typeof destroyRUM;
+declare const plugin_vue2_disableRUM: typeof disableRUM;
+declare const plugin_vue2_enableRUM: typeof enableRUM;
+declare const plugin_vue2_getBreadcrumbs: typeof getBreadcrumbs;
+declare const plugin_vue2_getRUMConfig: typeof getRUMConfig;
+declare const plugin_vue2_getRUMManager: typeof getRUMManager;
+declare const plugin_vue2_initRUMSystem: typeof initRUMSystem;
+declare const plugin_vue2_trackAction: typeof trackAction;
+declare const plugin_vue2_trackEvent: typeof trackEvent;
+declare const plugin_vue2_trackMetric: typeof trackMetric;
+declare const plugin_vue2_trackPerformance: typeof trackPerformance;
+declare namespace plugin_vue2 {
+  export {
+    plugin_vue2_RUMPluginVue2 as RUMPluginVue2,
+    plugin_vue2_destroyRUM as destroyRUM,
+    plugin_vue2_disableRUM as disableRUM,
+    plugin_vue2_enableRUM as enableRUM,
+    plugin_vue2_getBreadcrumbs as getBreadcrumbs,
+    plugin_vue2_getRUMConfig as getRUMConfig,
+    plugin_vue2_getRUMManager as getRUMManager,
+    plugin_vue2_initRUMSystem as initRUMSystem,
+    plugin_vue2_trackAction as trackAction,
+    plugin_vue2_trackEvent as trackEvent,
+    plugin_vue2_trackMetric as trackMetric,
+    plugin_vue2_trackPerformance as trackPerformance,
+  };
+}
+
+interface RUMManagerContextVue3 extends TransformContext {
+}
+declare class RUMManagerVue3 {
+    private inner;
+    init(context: RUMManagerContextVue3, options?: Partial<MitoSLSAdapterOptions>): Promise<void>;
+    trackEvent(eventName: string, eventData?: Record<string, any>): void;
+    trackPerformance(performanceData: Record<string, any>): void;
+    trackAction(action: string, actionData?: Record<string, any>): void;
+    trackMetric(metricName: string, value: number, dimensions?: Record<string, any>): void;
+    getBreadcrumbs(): any[];
+    enable(): void;
+    disable(): void;
+    getConfig(): Record<string, any>;
+    destroy(): void;
+}
+
+interface RUMVue3PluginOptions {
+    store?: any;
+    router?: any;
+    coreOptions?: Partial<MitoSLSAdapterOptions>;
+}
+declare function createRUMPluginVue3(options: RUMVue3PluginOptions): {
+    install(app: App): void;
+};
+declare function useRUM(): RUMManagerVue3 | undefined;
+
+type plugin_vue3_RUMVue3PluginOptions = RUMVue3PluginOptions;
+declare const plugin_vue3_createRUMPluginVue3: typeof createRUMPluginVue3;
+declare const plugin_vue3_useRUM: typeof useRUM;
+declare namespace plugin_vue3 {
+  export {
+    plugin_vue3_RUMVue3PluginOptions as RUMVue3PluginOptions,
+    plugin_vue3_createRUMPluginVue3 as createRUMPluginVue3,
+    plugin_vue3_useRUM as useRUM,
+  };
+}
+
+export { MitoConfig, MitoSLSAdapter, MitoSLSAdapterOptions, MitoSampleRateConfig, RUMEnv, RUMPluginVue2, RUM_ENV, SLSAdapterConfig, SLSWebTrackingAdapter, SlsConfig, TransformContext, createRUMPluginVue3, destroyRUM as destroyRUMVue2, disableRUM as disableRUMVue2, enableRUM as enableRUMVue2, getBreadcrumbs as getBreadcrumbsVue2, getMitoAdapter, getRUMConfig as getRUMConfigVue2, getRUMCoreInstance, getRUMEnv, getRUMManager as getRUMManagerVue2, getUserInfo, initRUMCore, initRUMSystem as initRUMSystemVue2, mitoConfig, shouldReport, slsConfig, trackAction as trackActionVue2, trackEvent as trackEventVue2, trackMetric as trackMetricVue2, trackPerformance as trackPerformanceVue2, transformDataForSLS, useRUM, plugin_vue2 as vue2, plugin_vue3 as vue3 };