@arms/rum-core 0.0.25-beta.16 → 0.0.25-beta.18

package/{es/index.js → lib/index.d.ts}

@@ -14,4 +14,4 @@ export * from './utils/is';
 export * from './utils/number';
 export * from './utils/match';
 export * from './utils/trace';
-export { Client, Context, Reporter, Shell };
+export { Client, Context, Reporter, Shell };

package/lib/model/client.d.ts

@@ -0,0 +1,20 @@
+import { IClient, IConfiguration, IContext, IRumSession } from '../types/client';
+import { RumEvent } from '../types/rum-event';
+import { IProcessor } from '../types/processor';
+import { ICollector } from '../types/collector';
+import { IReporter } from '../types/reporter';
+declare class Client implements IClient {
+    private emitter;
+    private collectors;
+    private processors;
+    private reporter;
+    private ctx;
+    init(config: IConfiguration, rumSession?: IRumSession): void;
+    sendEvent: (payload: RumEvent) => void;
+    setContext(ctx: IContext): void;
+    getContext(): IContext;
+    useCollectors(collectors: ICollector[]): void;
+    useProcessors(processors: IProcessor[]): void;
+    useReporter(reporter: IReporter): void;
+}
+export default Client;

package/lib/model/context.d.ts

@@ -0,0 +1,18 @@
+import { IConfiguration, IContext, IRumSession } from "../types/client";
+import { RumEvent, IViewData } from "../types/rum-event";
+declare class Context implements IContext {
+    private config;
+    private rumEvent;
+    private views;
+    session: IRumSession;
+    constructor(config: IConfiguration, rumSession?: IRumSession);
+    getConfig(): IConfiguration;
+    setConfig(config: IConfiguration): void;
+    getViews(): IViewData[];
+    addView(view: IViewData): void;
+    removeView(viewId: string): void;
+    getRumEvent(): RumEvent;
+    setRumEvent(rumEvent: RumEvent): void;
+    [key: string]: any;
+}
+export default Context;

package/lib/model/reporter.d.ts

@@ -0,0 +1,30 @@
+import { IContext } from '../types/client';
+import { RumEvent, IViewData } from '../types/rum-event';
+export default abstract class Reporter {
+    name: string;
+    /**
+     * 新上报事件优先检测队列是否超过 50 条，如果超过立即 report。
+     * 如果没超过则检测 FlushTime 内有无新上报事件，如果有新事件，重置 timer，无则 report
+     */
+    protected eventQueue: RumEvent[];
+    protected ctx: IContext;
+    private timer;
+    getReportCfg(): {
+        flushTime?: number;
+        maxEventCount?: number;
+    };
+    report(ctx: IContext): void;
+    private pushToQueue;
+    /**
+     * eventQueue 提取最新 View 作为公共 View，event 中不同 View Event 保留 View id
+     */
+    protected flushEventQueue(): void;
+    /**
+     * 接口请求由各平台 sdk reporter 实现
+     */
+    abstract request(ctx: IContext, events: RumEvent[], view: IViewData): void;
+    /**
+     * 初始化时
+     */
+    protected init(ctx: IContext): void;
+}

package/lib/model/shell.d.ts

@@ -0,0 +1,33 @@
+import { IClient, IConfiguration } from "../types/client";
+import { RumCustomEvent, RumEvent, RumExceptionEvent, RumResourceEvent } from "../types/rum-event";
+import { IShell } from "../types/shell";
+export default abstract class Shell implements IShell {
+    client: IClient;
+    constructor(config?: IConfiguration);
+    /**
+     * 初始化
+     */
+    abstract init(configuration: IConfiguration): void;
+    sendEvent(payload: RumEvent): void;
+    /**
+     * get config
+     */
+    getConfig(): IConfiguration;
+    /**
+     * set config
+     */
+    abstract setConfig<T extends keyof IConfiguration>(key: T, value: IConfiguration[T]): void;
+    abstract setConfig(value: IConfiguration): void;
+    /**
+     * 自定义事件上报
+     */
+    sendCustom(payload: RumCustomEvent): void;
+    /**
+     * 自定义异常上报
+     */
+    sendException(payload: RumExceptionEvent): void;
+    /**
+     * 自定义资源上报
+     */
+    sendResource(payload: RumResourceEvent): void;
+}

package/lib/types/client.d.ts

@@ -0,0 +1,133 @@
+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;
+}
+export interface IRumSession {
+    init(config: IConfiguration): void;
+    sessionConfig: SessionConfig;
+    getSessionId: () => string;
+    getSampled: () => boolean;
+    updateSession: () => void;
+    getEventId: () => string;
+    getViewId: () => string;
+    getUserId: () => string;
+}
+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;
+    /**
+     * 装载 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;
+    /**
+     * 用户配置
+     */
+    user?: {
+        id?: string;
+        tags?: string;
+        name?: string;
+        [key: string]: any;
+    };
+    /**
+     * 上报地址
+     */
+    endpoint: string;
+    /**
+     * reporter 发送事件之前
+     */
+    beforeReport?(bundle: RumEventBundle): any;
+    /**
+     * reporter 发送节奏配置
+     */
+    reportConfig?: {
+        flushTime?: number;
+        maxEventCount?: number;
+    };
+    /**
+     * session config
+     */
+    sessionConfig?: SessionConfig;
+    /**
+     * 各个 collector config
+     */
+    collectors?: {
+        [key: string]: unknown;
+    };
+    /**
+     * 事件过滤器配置
+     */
+    filters?: {
+        view?: MatchOption | MatchOption[];
+        resource?: MatchOption | MatchOption[];
+        exception?: MatchOption | MatchOption[];
+    };
+    [key: string]: any;
+}

package/lib/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/lib/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/lib/types/reporter.d.ts

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

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

@@ -0,0 +1,164 @@
+export declare enum RumEventType {
+    VIEW = "view",
+    RESOURCE = "resource",
+    EXCEPTION = "exception",
+    LONG_TASK = "longtask",
+    ACTION = "action",
+    CUSTOM = "custom"
+}
+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 {
+    event_type?: RumEventType;
+    event_id?: string;
+    session_id?: string;
+    timestamp?: number;
+    times?: number;
+    view?: IViewData;
+    snapshots?: string;
+    [key: string]: BaseObjectValue;
+}
+export interface RumViewEvent extends RumBaseEvent {
+    loading_type?: 'initial_load' | 'route_change';
+    type: 'pv' | 'perf' | 'webvitals';
+    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;
+    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 {
+    view_name: string;
+    source?: string;
+    type?: string;
+    message?: string;
+    count: number;
+    stack?: string;
+    caused_by?: 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 type RumEvent = RumViewEvent | RumResourceEvent | RumExceptionEvent | RumActionEvent | RumCustomEvent;
+export declare enum AppType {
+    browser = "browser",
+    miniapp = "miniapp",
+    uniapp = "uniapp"
+}
+export interface RumEventBundle {
+    app: {
+        id: string;
+        type: AppType;
+        name?: string;
+        version?: string;
+        channel?: string;
+        env?: string;
+        package?: 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;
+    };
+    events: Array<RumEvent>;
+    _v: string;
+}

package/lib/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/lib/utils/base.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 劫持函数
+ */
+export declare function interceptFunction(target: any, name: string, callback: Function): 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;

package/lib/utils/base.js

@@ -14,15 +14,27 @@ var _is = require("./is");
  */
 function interceptFunction(target, name, callback) {
   var registeredMethod = target[name];
-  target[name] = function () {
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-    callback.apply(this, args);
-    if (registeredMethod) {
-      return registeredMethod.apply(this, args);
-    }
-  };
+  try {
+    Object.defineProperty(target, name, {
+      configurable: true,
+      writable: true
+    });
+  } catch (e) {
+    //
+  }
+  try {
+    target[name] = function () {
+      for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+        args[_key] = arguments[_key];
+      }
+      callback.apply(this, args);
+      if (registeredMethod) {
+        return registeredMethod.apply(this, args);
+      }
+    };
+  } catch (e) {
+    //
+  }
 }
 
 /**

package/lib/utils/exception.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 获取错误对象唯一标识
+ */
+export declare const getErrorID: (error: {
+    message?: string;
+    stack?: string;
+}) => string;

package/lib/utils/is.d.ts

@@ -0,0 +1,12 @@
+export type IsFnHelper<T = unknown> = (value: unknown) => value is T;
+export declare function isTypeof<T = unknown>(value: unknown, type: string): value is T;
+export declare const isFunction: (func: any) => boolean;
+export declare const isUndefined: IsFnHelper<undefined>;
+export declare const isString: IsFnHelper<string>;
+export declare function isToString<T = unknown>(value: unknown, type: string): value is T;
+export declare const isArray: IsFnHelper<unknown[]>;
+export declare const isRegExp: IsFnHelper<string>;
+export declare const isBoolean: IsFnHelper<boolean>;
+export declare const isNumber: IsFnHelper<number | bigint>;
+export declare const isNull: IsFnHelper<null>;
+export declare const isObject: IsFnHelper<object>;

package/lib/utils/is.js

@@ -33,7 +33,7 @@ var isNumber = exports.isNumber = function isNumber(value) {
   return isTypeof(value, 'number') && !isNaN(value) || isTypeof(value, 'bigint');
 };
 var isNull = exports.isNull = function isNull(value) {
-  return isTypeof(value, 'null');
+  return value === null;
 };
 var isObject = exports.isObject = function isObject(value) {
   return !isNull(value) && isTypeof(value, 'object');

package/lib/utils/match.d.ts

@@ -0,0 +1,7 @@
+export type MatchOption = string | RegExp | ((value: string) => boolean);
+export declare function isMatchOption(item: unknown): item is MatchOption;
+/**
+ * 如果值有一个选项匹配，则返回true。在比较字符串时，useStartsWith: true时将把值与选项的开始进行比较，而不是要求精确匹配。
+ */
+export declare function matchList(list: MatchOption[], value: string, useStartsWith?: boolean): boolean;
+export declare function urlMatch(url: string, list?: MatchOption[]): boolean;

package/lib/utils/number.d.ts

@@ -0,0 +1,17 @@
+export declare const ONE_SECOND = 1000;
+export declare const ONE_MINUTE: number;
+export declare const ONE_HOUR: number;
+export declare const ONE_DAY: number;
+/**
+ * Return true if the draw is successful
+ * @param threshold between 0 and 100
+ */
+export declare function performDraw(threshold: number): boolean;
+/**
+ * 保留指定位数的小数
+ * @param num 原数据
+ * @param decimal 小数位数
+ * @param min 限制最小值，否则返回undefined
+ * @returns
+ */
+export declare function formatNumber(num: number, decimal?: number, min?: number): number;

package/lib/utils/polyfills.d.ts

@@ -0,0 +1,7 @@
+export declare function find<T, S extends T>(array: ArrayLike<T>, predicate: (item: T, index: number) => item is S): S | undefined;
+export declare function find<T>(array: ArrayLike<T>, predicate: (item: T, index: number) => boolean): T | undefined;
+export declare function startsWith(candidate: string, search: string): boolean;
+export declare function endsWith(candidate: string, search: string): boolean;
+export declare function assign<T, U>(target: T, source: U): T & U;
+export declare function assign<T, U, V>(target: T, source1: U, source2: V): T & U & V;
+export declare function assign<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;

package/lib/utils/trace.d.ts

@@ -0,0 +1,28 @@
+import { MatchOption } from "./match";
+export type PropagatorType = 'tracecontext' | 'b3' | 'b3multi' | 'jaeger' | 'sw8';
+export type TraceOption = {
+    match: MatchOption;
+    propagatorTypes: PropagatorType[];
+};
+export declare function isTraceOption(option: any): option is TraceOption;
+export interface ITracingOption {
+    enable?: boolean;
+    sample?: number | undefined;
+    propagatorTypes?: PropagatorType[];
+    allowedUrls?: Array<MatchOption | TraceOption> | undefined;
+    tracestate?: boolean;
+    baggage?: boolean;
+}
+export interface ITracingHeaders {
+    [key: string]: string;
+}
+export interface TraceSubOption {
+    tracestate?: string;
+    baggage?: string;
+    appId?: string;
+    appVersion?: string;
+    viewName?: string;
+    host?: string;
+}
+export declare function makeTracingHeaders(traceId: string, spanId: string, sampled: boolean, propagatorTypes: PropagatorType[], subOption?: TraceSubOption): ITracingHeaders;
+export declare function parseTracingOptions(tracingOption: boolean | ITracingOption): ITracingOption;

package/package.json

@@ -1,18 +1,16 @@
 {
   "name": "@arms/rum-core",
-  "version": "0.0.25-beta.16",
+  "version": "0.0.25-beta.18",
   "description": "arms rum javascript sdk core",
   "author": "guangli.fj <guangli.fj@alibaba-inc.com>",
   "license": "ISC",
   "main": "lib/index.js",
-  "module": "es/index.js",
   "directories": {
     "lib": "lib",
     "test": "__tests__"
   },
   "files": [
-    "lib",
-    "es"
+    "lib"
   ],
   "publishConfig": {
     "access": "public"
@@ -20,6 +18,7 @@
   "scripts": {
     "start": "build-scripts build --watch",
     "build": "build-scripts build --skip-demo",
+    "prepublishOnly": "npm run build",
     "test": "node ./__tests__/@arms/core.test.js"
   },
   "dependencies": {