@w57124/exs-monitor-sdk 0.1.7 → 0.1.9

package/dist/index.d.cts

@@ -1,126 +0,0 @@
-/**
- * 事件类型枚举
- */
-type EventType = 'error' | 'unhandledrejection' | 'performance' | 'network' | 'custom' | 'whitescreen';
-/**
- * SDK 上报的基础事件结构
- */
-interface BaseEvent {
-    id: string;
-    type: EventType;
-    timestamp: number;
-    appVersion?: string;
-    viewport?: {
-        width: number;
-        height: number;
-    };
-    page?: string;
-    context?: Record<string, unknown>;
-}
-/**
- * 传输层（上报）配置
- */
-interface TransportOptions {
-    endpoint: string;
-    headers?: Record<string, string>;
-    batch?: boolean;
-    batchSize?: number;
-    flushIntervalMs?: number;
-    mode?: 'http' | 'local';
-    localKey?: string;
-    localMaxItems?: number;
-    useBeacon?: boolean;
-}
-/**
- * MonitorClient 初始化配置
- */
-interface MonitorClientOptions {
-    dsn: string;
-    appVersion?: string;
-    release?: string;
-    env?: string;
-    transport?: Partial<TransportOptions>;
-    enableErrors?: boolean;
-    enablePerformance?: boolean;
-    enableNetwork?: boolean;
-    ignoreHttpCode?: number[];
-    viewerHotkey?: string;
-    enableWhiteScreen?: boolean;
-    whiteScreenOptions?: {
-        delayMs?: number;
-        minVisibleCount?: number;
-        minArea?: number;
-        sampleTimes?: number;
-        sampleIntervalMs?: number;
-        includePerf?: boolean;
-    };
-    /**
-     * 网络拦截白名单：仅当匹配这些域名时才上报网络事件。
-     * 支持：
-     * - 精确域名：例如 'api.example.com'
-     * - 通配后缀：例如 '*.example.com'（匹配任意子域）
-     */
-    networkHostsAllowlist?: string[];
-    /** 网络拦截黑名单（域名），优先级高于白名单 */
-    networkHostsBlocklist?: string[];
-    /** URL 允许上报的正则（字符串或 RegExp），存在则需匹配其一 */
-    networkUrlAllowPatterns?: (string | RegExp)[];
-    /** URL 禁止上报的正则（字符串或 RegExp），命中则直接跳过 */
-    networkUrlBlockPatterns?: (string | RegExp)[];
-    /**
-     * 网络请求/响应 body 最大长度（字符数），超出将截断并标记
-     * 默认 1000，设为 0 或负数表示不上报 body
-     */
-    networkMaxBodyLength?: number;
-}
-
-/**
- * 监控客户端：负责构建事件与调用传输层上报
- */
-declare class MonitorClient {
-    private readonly options;
-    private readonly transport;
-    /**
-     * @param options SDK 初始化参数
-     */
-    constructor(options: MonitorClientOptions);
-    /**
-     * 采集一个事件
-     * @param type 事件类型
-     * @param data 自定义上下文数据
-     */
-    capture(type: BaseEvent['type'], data?: Omit<BaseEvent, 'id' | 'type' | 'timestamp' | 'viewport' | 'page'>['context']): void;
-    /** 打开本地事件列表查看器 */
-    openEventList(): void;
-    /** 获取本地缓存事件（仅本地模式有效） */
-    getStoredEvents(): BaseEvent[];
-    /** 清空本地缓存事件（仅本地模式有效） */
-    clearStoredEvents(): void;
-    /**
-     * 绑定默认的查看器快捷键处理（对外导出）
-     * @param hotkey 自定义快捷键（如 'Alt+K'），不传则为默认
-     */
-    bindViewerHotkeyDefault(hotkey?: string): void;
-    /** 解绑默认的查看器快捷键处理 */
-    unbindViewerHotkeyDefault(): void;
-}
-
-/**
- * 打开事件查看器覆盖层
- * @param events 要展示的事件数组
- * @param onClear 点击清空后的回调
- */
-declare function openEventViewer(events: BaseEvent[], onClear?: () => void): void;
-
-/**
- * 初始化 SDK 并按配置启用集成
- */
-declare function initMonitor(options: MonitorClientOptions): MonitorClient;
-declare global {
-    interface Window {
-        __EXSMONITOR__?: MonitorClientOptions;
-        __EXSMONITOR_INSTANCE__?: MonitorClient;
-    }
-}
-
-export { type BaseEvent, MonitorClient, type MonitorClientOptions, type TransportOptions, initMonitor, openEventViewer };