@arms/rum-core 0.0.35 → 0.0.37

package/es/types/client.d.ts

@@ -0,0 +1,170 @@
+import { ICollector } from './collector';
+import { IProcessor } from './processor';
+import { IReporter } from './reporter';
+import { RumEvent, RumEventBundle, IViewData } from './rum-event';
+import { MatchOption } from "../utils/match";
+export declare enum EventType {
+    /**
+     * 收集数据
+     */
+    collect = "collect"
+}
+export interface IContext {
+    session: IRumSession;
+    /**
+     * user config
+     */
+    getConfig(): IConfiguration;
+    setConfig(config: IConfiguration): void;
+    /**
+     * view
+     */
+    getViews(): IViewData[];
+    addView(view: IViewData): void;
+    removeView(viewId: string): void;
+    /**
+     * event
+     */
+    getRumEvent(): RumEvent;
+    setRumEvent(rumEvent: RumEvent): void;
+    [key: string]: any;
+}
+export interface SessionConfig {
+    sampleRate?: number;
+    maxDuration?: number;
+    overtime?: number;
+    storage?: string;
+}
+export interface IRumSession {
+    init(ctx: IContext): void;
+    sessionConfig: SessionConfig;
+    getSessionId: () => string;
+    getSampled: () => boolean;
+    updateSession: () => void;
+    getEventId: () => string;
+    getViewId: () => string;
+    getUserId: () => string;
+    getBaseEvent: () => any;
+}
+export interface IClient {
+    /**
+     * 初始化
+     */
+    init: (configuration: IConfiguration, rumSession?: IRumSession) => void;
+    /**
+     * 业务自定义上传数据
+     */
+    sendEvent(payload: RumEvent): void;
+    /**
+     * 修改运行时上下文
+     */
+    setContext(ctx: IContext): void;
+    /**
+     * 获取运行时上下文
+     */
+    getContext(): IContext;
+    /**
+     * 装载 client 需要的 Collector
+     */
+    useCollectors(collectors: ICollector[]): void;
+    /**
+     * 返回装载的collector
+     */
+    getCollectors(): ICollector[];
+    /**
+     * 装载 client 需要的 processor
+     */
+    useProcessors(processors: IProcessor[]): void;
+    /**
+     * 装载 client 需要的 report
+     */
+    useReporter(reporter: IReporter): void;
+}
+export interface IConfiguration {
+    /**
+     * 项目 id
+     */
+    pid: string;
+    /**
+     * 应用环境
+     */
+    env?: 'prod' | 'gray' | 'pre' | 'daily' | 'local';
+    /**
+     * 应用版本
+     */
+    version?: string;
+    /**
+     * 应用配置
+     */
+    app?: {
+        id?: string;
+        name?: string;
+        version?: string;
+        channel?: string;
+        env?: string;
+        type?: string;
+        package?: string;
+        framework?: string;
+    };
+    /**
+     * 用户配置
+     */
+    user?: {
+        id?: string;
+        tags?: string;
+        name?: string;
+    };
+    /**
+     * 上报地址
+     */
+    endpoint: string;
+    /**
+     * reporter 发送事件之前
+     */
+    beforeReport?(bundle: RumEventBundle): any;
+    /**
+     * reporter 发送节奏配置
+     */
+    reportConfig?: {
+        flushTime?: number;
+        maxEventCount?: number;
+    };
+    /**
+     *  配置下发
+     *  - 运行时动态配置更新，根据端侧特点来做定制化配置
+     */
+    remoteConfig?: Boolean;
+    /**
+     * session config
+     */
+    sessionConfig?: SessionConfig;
+    /**
+     * 各个 collector config
+     */
+    collectors?: {
+        [key: string]: boolean;
+    };
+    /**
+     * 事件过滤器配置
+     */
+    filters?: {
+        view?: MatchOption | MatchOption[];
+        resource?: MatchOption | MatchOption[];
+        exception?: MatchOption | MatchOption[];
+    };
+    /**
+     * 全局自定义属性
+     */
+    properties?: {
+        [key: string]: number | string;
+    };
+    /**
+     * 检测元素是否溢出的弹性长度
+     */
+    overflowPx?: number;
+    /**
+     * 检测正则匹配内容
+     */
+    regexp?: string;
+    [key: string]: unknown;
+}

package/es/types/client.js

@@ -0,0 +1,7 @@
+export var EventType = /*#__PURE__*/function (EventType) {
+  /**
+   * 收集数据
+   */
+  EventType["collect"] = "collect";
+  return EventType;
+}({});

package/es/types/collector.d.ts

@@ -0,0 +1,7 @@
+import { IContext } from './client';
+import { RumEvent } from './rum-event';
+export interface ICollector {
+    name: string;
+    setup(ctx: IContext, sendEvent: (payload: RumEvent) => void): void;
+    destroy?(): void;
+}

package/es/types/collector.js

@@ -0,0 +1 @@
+export {};

package/es/types/processor.d.ts

@@ -0,0 +1,8 @@
+import { IContext } from './client';
+import { RumEvent } from './rum-event';
+export interface IProcessor {
+    name: string;
+    setup?(ctx: IContext): void;
+    process(ctx: IContext): RumEvent;
+    match?(ctx: IContext): boolean;
+}

package/es/types/processor.js

@@ -0,0 +1 @@
+export {};

package/es/types/reporter.d.ts

@@ -0,0 +1,8 @@
+import { IContext } from './client';
+import { RumEventBundle } from './rum-event';
+export interface IReporter {
+    name: string;
+    init(ctx: IContext): void;
+    request(ctx: IContext, bundle: RumEventBundle): void;
+    report(ctx: IContext): void;
+}

package/es/types/reporter.js

@@ -0,0 +1 @@
+export {};

package/es/types/rum-event.d.ts

@@ -0,0 +1,179 @@
+export declare enum RumEventType {
+    VIEW = "view",
+    RESOURCE = "resource",
+    EXCEPTION = "exception",
+    LONG_TASK = "longTask",
+    ACTION = "action",
+    CUSTOM = "custom",
+    APPLICATION = "application"
+}
+export interface BaseObject {
+    [key: string]: BaseObjectValue;
+}
+export interface IViewData {
+    id: string;
+    name: string;
+}
+export type BaseObjectPrimitiveValue = string | number | boolean | null | undefined;
+export type BaseObjectValue = BaseObjectPrimitiveValue | BaseObject | BaseObjectPrimitiveValue[] | IViewData;
+export interface RumBaseEvent extends BaseObject {
+    event_type?: RumEventType;
+    event_id?: string;
+    session_id?: string;
+    timestamp?: number;
+    times?: number;
+    view?: IViewData;
+    snapshots?: string;
+    properties?: BaseObject;
+}
+export interface RumViewEvent extends RumBaseEvent {
+    loading_type?: 'initial_load' | 'route_change';
+    type: 'pv' | 'perf' | 'webvitals' | 'custom';
+    largest_contentful_paint?: number;
+    first_input_delay?: number;
+    cumulative_layout_shift?: number;
+    first_input_time?: number;
+    loading_time?: number;
+    first_paint?: number;
+    first_contentful_paint?: number;
+    dom_interactive?: number;
+    dom_content_loaded?: number;
+    dom_complete?: number;
+    load_event?: number;
+    t1?: number;
+    t2?: number;
+    t3?: number;
+    referrer?: string;
+    url?: string;
+    timing_data?: string;
+}
+/**
+ * 枚举值，表示资源是否加载成功
+ */
+export declare enum ResourceStatus {
+    Unknown = -1,
+    Failed = 0,
+    Success = 1
+}
+export interface RumResourceEvent extends RumBaseEvent {
+    name?: string;
+    type?: string;
+    method?: string;
+    status_code?: number | string;
+    message?: string;
+    success?: -1 | 0 | 1 | ResourceStatus;
+    trace_id?: string;
+    duration?: number;
+    size?: number;
+    connect_duration?: number;
+    ssl_duration?: number;
+    dns_duration?: number;
+    redirect_duration?: number;
+    first_byte_duration?: number;
+    download_duration?: number;
+    url?: string;
+    timing_data?: string;
+    tracing_data?: string;
+}
+export interface RumExceptionEvent extends RumBaseEvent {
+    source?: string;
+    type?: 'crash' | 'custom' | 'error' | 'blank';
+    name?: string;
+    message?: string;
+    file?: string;
+    stack?: string;
+    line?: number;
+    column?: number;
+}
+export interface RumLongTaskEvent extends RumBaseEvent {
+    source?: string;
+    type?: string;
+    message?: string;
+    duration?: number;
+    fps?: number;
+    stack?: string;
+    caused_by?: string;
+    snapshots: string;
+}
+export interface RumActionEvent extends RumBaseEvent {
+    type?: string;
+    name?: string;
+    target_name?: string;
+    duration?: number;
+}
+export interface RumCustomEvent extends RumBaseEvent {
+    type: string;
+    name: string;
+    group?: string;
+    value: number;
+}
+export interface RumApplicationEvent extends RumBaseEvent {
+    state: string;
+    scene: string;
+    duration: number;
+}
+export type RumEvent = RumViewEvent | RumResourceEvent | RumExceptionEvent | RumActionEvent | RumCustomEvent | RumApplicationEvent;
+export declare enum AppType {
+    browser = "browser",
+    miniapp = "miniapp",
+    minigame = "minigame",
+    uniapp = "uniapp",
+    reactnative = "reactnative"
+}
+export interface RumEventBundle {
+    app: {
+        id: string;
+        type: AppType | string;
+        name?: string;
+        version?: string;
+        channel?: string;
+        env?: string;
+        package?: string;
+        framework?: string;
+    };
+    user: {
+        id: string;
+        name?: string;
+        tags?: string;
+    };
+    session: {
+        id: string;
+    };
+    view: {
+        id: string;
+        name: string;
+    };
+    device?: {
+        id?: string;
+        type?: string;
+        brand?: string;
+        model?: string;
+        name?: string;
+    };
+    os?: {
+        type?: string;
+        version?: string;
+        container?: string;
+        container_version?: string;
+    };
+    geo?: {
+        country?: string;
+        country_id?: string;
+        province?: string;
+        province_id?: string;
+        city?: string;
+        city_id?: string;
+    };
+    isp?: {
+        id?: string;
+        name?: string;
+    };
+    net?: {
+        model?: string;
+        name?: string;
+        ip?: string;
+    };
+    events: Array<RumEvent>;
+    properties?: BaseObject;
+    _v?: string;
+}

package/es/types/rum-event.js

@@ -0,0 +1,27 @@
+export var RumEventType = /*#__PURE__*/function (RumEventType) {
+  RumEventType["VIEW"] = "view";
+  RumEventType["RESOURCE"] = "resource";
+  RumEventType["EXCEPTION"] = "exception";
+  RumEventType["LONG_TASK"] = "longTask";
+  RumEventType["ACTION"] = "action";
+  RumEventType["CUSTOM"] = "custom";
+  RumEventType["APPLICATION"] = "application";
+  return RumEventType;
+}({});
+/**
+ * 枚举值，表示资源是否加载成功
+ */
+export var ResourceStatus = /*#__PURE__*/function (ResourceStatus) {
+  ResourceStatus[ResourceStatus["Unknown"] = -1] = "Unknown";
+  ResourceStatus[ResourceStatus["Failed"] = 0] = "Failed";
+  ResourceStatus[ResourceStatus["Success"] = 1] = "Success";
+  return ResourceStatus;
+}({});
+export var AppType = /*#__PURE__*/function (AppType) {
+  AppType["browser"] = "browser";
+  AppType["miniapp"] = "miniapp";
+  AppType["minigame"] = "minigame";
+  AppType["uniapp"] = "uniapp";
+  AppType["reactnative"] = "reactnative";
+  return AppType;
+}({});

package/es/types/shell.d.ts

@@ -0,0 +1,28 @@
+import { IConfiguration } from "./client";
+import { RumEvent } from "./rum-event";
+/**
+ * 每个 sdk shell 导出固定需要实现的基础 api
+ * 对外导出 shell 层, 所有 shell 层模型的 API 设计约定：
+ * 1. API 命名空间按照 variables / functions / events 来组织
+ * 2. 事件（events）的命名格式为：on[Will|Did]VerbNoun?，参考 https://code.visualstudio.com/api/references/vscode-api#events
+ * 3. 基于 Disposable 模式，对于事件的绑定、快捷键的绑定函数，返回值则是解绑函数
+ */
+export interface IShell {
+    /**
+     * 初始化
+     */
+    init(configuration: IConfiguration): void;
+    /**
+     * 自定义上传数据
+     */
+    sendEvent(payload: RumEvent): void;
+    /**
+     * get config
+     */
+    getConfig(): IConfiguration;
+    /**
+     * set config
+     */
+    setConfig<T extends keyof IConfiguration>(key: T, value: IConfiguration[T]): void;
+    setConfig(value: IConfiguration): void;
+}

package/es/types/shell.js

@@ -0,0 +1 @@
+export {};

package/es/utils/base.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 劫持函数或原型
+ */
+export declare function interceptFunction(target: any, name: string, callback: Function, isPrototype?: boolean): void;
+/**
+ * 还原函数
+ */
+export declare function restoreFunction(target: any, name: string): void;
+/**
+ * @description: GUID v4
+ * @return {String}
+ */
+export declare function generateGUID(): string;
+/**
+ * @description: 随机生成 traceId 或 sessionId
+ * @return {String}
+ */
+export declare function generateTraceId(): string;
+/**
+ * @description: 随机生成 spanId
+ * @param len {number}
+ * @param radix {number}
+ * @return {String}
+ */
+export declare function generateSpanId(len?: number, radix?: number): string;
+/**
+ * @description: 随机生成 eventId
+ * @param sessionId {string} sessionId
+ * @return {String}
+ */
+export declare function generateEventId(sessionId: string): string;
+/**
+ * @desc 函数防抖
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+export declare function debounce(func: Function, wait: number): () => void;
+/**
+ * @desc 函数延迟执行
+ * @param func 回调函数
+ * @param wait 延迟执行毫秒数
+ */
+export declare function delay(func: Function, wait: number, ...args: any[]): number;
+/**
+ * @desc 需要严格区分object和array
+ * @param obj 任意对象
+ */
+export declare function getType(obj: any): any;
+/**
+ * @desc 将字符串转换成正则表达式
+ * @param str 任意字符串
+ * 注意，这里只支持 /xxx/ 这种格式，不支持修饰符，例如 /xxx/ig
+ */
+export declare function transStrToReg(str: string): string | RegExp;
+/**
+ *
+ * @param config 配置
+ * @param keys 需要转换的字段
+ */
+export declare function toRegFormat(config: any, keys: any[]): void;