@mtn-ui-z/monitor 0.0.1

package/dist/src/types.d.ts

@@ -0,0 +1,219 @@
+/**
+ * @mtn-ui-z/monitor - 前端监控 SDK 类型定义
+ * @description 定义监控 SDK 的配置选项和数据类型
+ */
+/**
+ * 监控 SDK 初始化配置选项
+ */
+export interface MonitorOptions {
+    /** 上报数据的目标 URL */
+    reportUrl?: string;
+    /** 应用唯一标识，用于区分不同应用（与部分管理台的项目 sdkKey 对应） */
+    appId?: string;
+    /** 项目密钥，与 appId 二选一或一致；部分管理台用 sdkKey 做项目识别 */
+    sdkKey?: string;
+    /** 运行环境 */
+    env?: 'development' | 'production' | 'test';
+    /** 是否启用错误监控（JS 错误、Promise 异常等） */
+    errorEnabled?: boolean;
+    /** 是否启用性能监控（FP、FCP、LCP 等） */
+    performanceEnabled?: boolean;
+    /** 是否启用页面访问监控（PV/UV） */
+    pvEnabled?: boolean;
+    /** 是否启用 API 请求监控（fetch/XHR） */
+    apiEnabled?: boolean;
+    /** 是否启用用户行为监控（点击、滚动等） */
+    behaviorEnabled?: boolean;
+    /** 是否启用长任务监控（Long Task、内存） */
+    longTaskEnabled?: boolean;
+    /** 数据上报采样率，范围 0-1，1 表示 100% 上报 */
+    sampleRate?: number;
+    /** 自定义数据上报函数，优先级高于 reportUrl */
+    report?: (data: MonitorData) => void;
+}
+/**
+ * 监控数据的联合类型
+ */
+export type MonitorData = ErrorData | PerformanceData | PvData | ApiData | BehaviorData | CustomData | LongTaskData;
+/**
+ * 错误监控数据类型
+ */
+export interface ErrorData {
+    /** 数据类型，固定为 'error' */
+    type: 'error';
+    /** 错误发生的具体类型 */
+    errorType: 'js' | 'resource' | 'promise' | 'vue';
+    /** 错误信息文本 */
+    message: string;
+    /** 错误堆栈信息（可选） */
+    stack?: string;
+    /** 错误发生的页面 URL */
+    url: string;
+    /** 错误发生的行号（JS 错误时） */
+    line?: number;
+    /** 错误发生的列号（JS 错误时） */
+    column?: number;
+    /** 当前用户 ID（如果已设置） */
+    userId?: string;
+    /** 错误发生的时间戳 */
+    timestamp: number;
+}
+/**
+ * 性能监控数据类型
+ */
+export interface PerformanceData {
+    /** 数据类型，固定为 'performance' */
+    type: 'performance';
+    /** 性能指标类型 */
+    metric: 'page' | 'resource' | 'fcp' | 'fp' | 'lcp' | 'fid' | 'cls' | 'tti' | 'ttfb' | 'dns' | 'tcp' | 'download';
+    /** 指标值，单位毫秒 */
+    value: number;
+    /** 性能数据采集的页面 URL */
+    url: string;
+    /** 采集时间的时间戳 */
+    timestamp: number;
+}
+/**
+ * 页面访问（PV）数据类型
+ */
+export interface PvData {
+    /** 数据类型，固定为 'pv' */
+    type: 'pv';
+    /** 当前页面 URL */
+    url: string;
+    /** 来源页面 URL（可选） */
+    referrer?: string;
+    /** 当前用户 ID（如果已设置） */
+    userId?: string;
+    /** 访问时间戳 */
+    timestamp: number;
+}
+/**
+ * API 请求监控数据类型
+ */
+export interface ApiData {
+    /** 数据类型，固定为 'api' */
+    type: 'api';
+    /** 请求 URL */
+    url: string;
+    /** 请求方法 */
+    method: string;
+    /** HTTP 状态码 */
+    status: number;
+    /** 请求耗时（毫秒） */
+    duration: number;
+    /** 请求是否成功 */
+    success: boolean;
+    /** 错误信息（如果有） */
+    error?: string;
+    /** 时间戳 */
+    timestamp: number;
+}
+/**
+ * 用户行为监控数据类型
+ */
+export interface BehaviorData {
+    /** 数据类型，固定为 'behavior' */
+    type: 'behavior';
+    /** 行为类型 */
+    behaviorType: 'click' | 'scroll' | 'pageShow' | 'pageHide';
+    /** 点击元素标签名 */
+    element?: string;
+    /** 点击元素文本内容 */
+    text?: string;
+    /** 点击元素路径 */
+    path?: string;
+    /** 自定义监控 ID */
+    monitorId?: string;
+    /** 自定义监控标签 */
+    monitorLabel?: string;
+    /** 点击坐标 X */
+    x?: number;
+    /** 点击坐标 Y */
+    y?: number;
+    /** 滚动位置 */
+    scrollTop?: number;
+    /** 滚动百分比 */
+    scrollPercent?: number;
+    /** 时间戳 */
+    timestamp: number;
+}
+/**
+ * 自定义事件数据类型
+ */
+export interface CustomData {
+    /** 数据类型，固定为 'custom' */
+    type: 'custom';
+    /** 事件名称 */
+    eventName: string;
+    /** 事件数据 */
+    data?: Record<string, unknown>;
+    /** 页面 URL */
+    url: string;
+    /** 时间戳 */
+    timestamp: number;
+}
+/**
+ * 长任务监控数据类型
+ */
+export interface LongTaskData {
+    /** 数据类型，固定为 'longtask' */
+    type: 'longtask';
+    /** 任务类型 */
+    taskType: 'longTask' | 'memory';
+    /** 任务耗时（毫秒） */
+    duration?: number;
+    /** 任务归因 */
+    attribution?: string;
+    /** 内存使用（MB） */
+    usedMemory?: number;
+    /** 内存总量（MB） */
+    totalMemory?: number;
+    /** 内存使用百分比 */
+    memoryPercent?: number;
+    /** 页面 URL */
+    url: string;
+    /** 时间戳 */
+    timestamp: number;
+}
+/**
+ * 监控 SDK 实例接口
+ */
+export interface MonitorInstance {
+    /**
+     * 初始化监控 SDK
+     * @param options - 监控配置选项
+     */
+    init: (options: MonitorOptions) => void;
+    /**
+     * 手动上报错误
+     * @param error - Error 对象
+     * @param errorType - 错误类型
+     */
+    reportError: (error: Error, errorType?: ErrorData['errorType']) => void;
+    /**
+     * 手动上报性能数据
+     * @param metric - 性能指标类型
+     * @param value - 指标值（毫秒）
+     */
+    reportPerformance: (metric: PerformanceData['metric'], value: number) => void;
+    /**
+     * 手动上报页面访问
+     */
+    reportPv: () => void;
+    /**
+     * 手动上报自定义事件
+     * @param eventName - 事件名称
+     * @param eventData - 事件数据
+     */
+    reportCustomEvent: (eventName: string, eventData?: Record<string, unknown>) => void;
+    /**
+     * 设置用户 ID
+     * @param userId - 用户唯一标识
+     */
+    setUserId: (userId: string) => void;
+    /**
+     * 销毁监控实例，停止所有监控
+     */
+    destroy: () => void;
+}

package/dist/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vite').UserConfig;
+export default _default;

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@mtn-ui-z/monitor",
+  "version": "0.0.1",
+  "description": "MTN UI Frontend Monitor SDK",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "monitor",
+    "sdk",
+    "frontend",
+    "performance",
+    "error-tracking"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^5.0.0",
+    "typescript": "^5.3.3",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^3.9.0",
+    "vue": "^3.5.0",
+    "vue-tsc": "^2.0.0"
+  },
+  "peerDependencies": {
+    "vue": "^3.5.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "type-check": "vue-tsc --noEmit"
+  }
+}