@cloudcare/browser-core 3.1.12 → 3.1.13

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudcare/browser-core",
-    "version": "3.1.12",
+    "version": "3.1.13",
     "main": "cjs/index.js",
     "module": "esm/index.js",
     "types": "types/index.d.ts",
@@ -22,5 +22,5 @@
     "author": "dataflux",
     "license": "MIT",
     "description": "DataFlux RUM Web 端数据指标监控",
-    "gitHead": "01fca1d8b95bbd1e8e7936bda860af98bf76fa02"
+    "gitHead": "f7180bcedb58d06418d937389efee132b995af2b"
 }

package/types/index.d.ts

@@ -23,25 +23,59 @@ export declare const RawReportType: {
 }
 export type RawReportType = (typeof RawReportType)[keyof typeof RawReportType]
 export interface InitConfiguration {
+  /**
+   *  以openway 方式上报数据令牌，从观测云控制台获取，必填
+   */
   clientToken?: string | undefined
+  /**
+   *  数据发送前的的拦截器
+   * @param event  事件内容
+   * @param context  事件额外属性
+   * @returns
+   */
   beforeSend?: (event: any, context?: any) => unknown | undefined
+  /**
+   * 数据上报采样率，100 表示全收集；0 表示不收集。默认 100
+   */
   sessionSampleRate?: number | undefined
   telemetrySampleRate?: number | undefined
   silentMultipleInit?: boolean | undefined
+  /**
+   *  以 公共openway 方式上报数据地址，从观测云控制台获取，必填
+   */
   site?: string | undefined
+  /** DataKit 数据上报 Origin 注释:
+   * 协议（包括：//），域名（或IP地址）[和端口号]
+   * 例如：
+   * https://www.datakit.com；
+   * http://100.20.34.3:8088。
+   */
   datakitOrigin: string
   service?: string | undefined
+  /** Web 应用当前环境，如 prod：线上环境；gray：灰度环境；pre：预发布环境；common：日常环境；local：本地环境。 */
   env?: string | undefined
+  /** Web 应用的版本号。 */
   version?: string | undefined
-  tracingSampleRate: number | undefined
+  /** 链路数据采样百分比：100 表示全收集；0 表示不收集。 */
+  tracingSampleRate?: number | undefined
   /**
    * @deprecated use usePartitionedCrossSiteSessionCookie instead
    */
   useCrossSiteSessionCookie?: boolean | undefined
+  /**
+   * 是否使用跨域 cookie，开启第三方 cookie 跨分区实现。默认不允许跨域，例如嵌套跨域 iframe 的情况。
+   */
+  usePartitionedCrossSiteSessionCookie?: boolean | undefined
   useSecureSessionCookie?: boolean | undefined
   trackSessionAcrossSubdomains?: boolean | undefined
-  storeContextsToLocal: boolean | undefined
-  sendContentTypeByJson: boolean | undefined
+  /**
+   * 是否把公共数据存储到localstorage,默认不存储
+   */
+  storeContextsToLocal?: boolean | undefined
+  /**
+   * 数据以 application/json 的发送方式，默认text
+   */
+  sendContentTypeByJson?: boolean | undefined
 }
 export enum TraceType {
   DDTRACE = 'ddtrace',
@@ -79,14 +113,39 @@ export declare function matchList(
 ): boolean
 
 export interface RumInitConfiguration extends InitConfiguration {
+  /**从观测云创建的应用 ID */
   applicationId: string
+  /**
+   * 排除一些影响 loadingtime 的指标准确性的url，具体可参考下面文档
+   * https://docs.guance.com/security/page-performance/#_3
+   */
   excludedActivityUrls?: MatchOption[] | undefined
+  /**
+     * 允许注入 trace 采集器所需 header 头部的所有请求列表。可以是请求的 origin，也可以是正则，origin: 协议（包括：//），域名（或IP地址）[和端口号]。例如：
+     ["https://api.example.com", /https:\\/\\/.*\\.my-api-domain\\.com/]。
+    */
   allowedTracingUrls?: Array<MatchOption | TracingOption> | undefined
   defaultPrivacyLevel?: DefaultPrivacyLevel | undefined
+  /**
+     * Session Replay 数据采集百分比:
+100 表示全收集；0 表示不收集。
+     */
   sessionReplaySampleRate?: number | undefined
+  /**
+   * 是否开启用户行为采集。
+   */
   trackUserInteractions?: boolean | undefined
+  /**
+   * 指定 action 数据 name 获取方式，默认自动获取，可以指定元素特定属性名称
+   */
   actionNameAttribute?: string | undefined
   trackViewsManually?: boolean | undefined
-  traceType: TraceType
-  traceId128Bit: boolean | undefined
+  /**
+   * 配置链路追踪工具类型，如果不配置默认为 ddtrace。目前支持 ddtrace、zipkin、skywalking_v3、jaeger、zipkin_single_header、w3c_traceparent 6 种数据类型。
+   */
+  traceType?: TraceType
+  /**
+   * 是否以 128 字节的方式生成 traceID，与 traceType 对应，目前支持类型 zipkin、jaeger。
+   */
+  traceId128Bit?: boolean | undefined
 }