hina-cloud-js-sdk 3.1.8 → 4.0.0

package/dist/index.d.ts

@@ -0,0 +1,411 @@
+import { Monitor } from 'hina-cloud-monitor';
+export { MonitorInstance } from 'hina-cloud-monitor';
+import { WebClient } from 'hina-cloud-core';
+import { PluginBase, TrackOptions, ReportDataType, VariablesTypes, FetchParams, ResultItem, StorageDataType, RequestData, ResponseData, PageLeaveAutoTrackObject, IAnyObject, LinkerItem, SiteLinkerOptions, AbTestingOptions, VoidFn, UnKnownFn, ReportProperties, AnyFn, ReportTypes } from 'hina-cloud-types';
+export * from 'hina-cloud-types';
+import { State } from 'hina-cloud-utils';
+
+declare class AbTestingPlugin extends PluginBase<TrackOptions> {
+    options: TrackOptions;
+    context: TrackInstance;
+    name: string;
+    isReady: boolean;
+    /**
+     * 浏览器平台 H5 Web
+     */
+    platform: "H5" | "Web";
+    /**
+     * 项目key
+     */
+    projectKey: string;
+    /**
+     * 本地存储名称
+     */
+    storageName: string;
+    constructor(options: TrackOptions, context: TrackInstance);
+    init(): void;
+    transform(): ReportDataType<any>;
+    /**
+     * 判断类型和值是否匹配
+     * @param value
+     * @param type
+     */
+    valueMatchType(value: unknown, type: VariablesTypes): boolean;
+    /**
+     * 处理参数
+     * @param prefixLog
+     * @param params
+     * @param validateKeys
+     */
+    normalizeParams(prefixLog: string, params: FetchParams, validateKeys?: (keyof FetchParams)[]): {
+        verify_success: boolean;
+        para: FetchParams;
+    };
+    /**
+     * 发送 H_ABTestTrigger事件
+     * @param data
+     */
+    sendTriggerEvent(data: {
+        abtest_experiment_id: string;
+        abtest_experiment_group_id: string;
+    }): void;
+    /**
+     * 从本地缓存中获取实验结果
+     * @param params 实验参数对象
+     * @param list
+     */
+    getExpResult(params: FetchParams, list?: ResultItem[]): string | number | boolean;
+    /**
+     * 获取本地数据
+     * @returns
+     */
+    getStorageData(): StorageDataType | null;
+    /**
+     * 保存数据到本地
+     * @param list
+     */
+    saveResponseData(list: ResultItem[]): void;
+    /**
+     * 创建请求数据
+     * @param params
+     */
+    createRequestData(params: FetchParams): RequestData;
+    /**
+     * 从服务器获取数据
+     * @param params
+     */
+    getResultFromServer(params: FetchParams): Promise<ResponseData>;
+    /**
+     * 请求服务接口获取数据
+     * @param params
+     */
+    asyncFetch(params: FetchParams): Promise<ResponseData>;
+    /**
+     * 调用方法前验证参数
+     */
+    preFetch(prefixLog: string, params: FetchParams): boolean;
+    /**
+     * 获取试验变量
+     * 忽略本地缓存，从服务端获取数据
+     * @param params
+     */
+    asyncFetchABTest(params: FetchParams): void;
+    /**
+     * 获取试验变量
+     * 读取本地缓存，缓存不存在时使用默认值
+     * @param params
+     */
+    fetchCacheABTest(params: FetchParams): void;
+    /**
+     * 获取试验变量
+     * 优先读取本地缓存，缓存不存在时从服务端获取数据
+     * @param params
+     */
+    fastFetchABTest(params: FetchParams): void;
+}
+
+declare class PageLeavePlugin extends PluginBase<TrackOptions> {
+    options: TrackOptions;
+    context: TrackInstance;
+    name: string;
+    isReady: boolean;
+    pageId: number;
+    storageName: string;
+    heartbeatIntervalTime: number;
+    maxDuration: number;
+    heartbeatIntervalTimer: any;
+    startTime: number;
+    /**
+     * 页面url
+     */
+    url: string;
+    /**
+     * 页面显示状态
+     */
+    pageShowStatus: boolean;
+    constructor(options: TrackOptions, context: TrackInstance);
+    init(): void;
+    transform(): ReportDataType<any>;
+    normalizePageLeaveAutoTrack(): PageLeaveAutoTrackObject;
+    addPageLeaveEventListener(): void;
+    addPageStartListener(): void;
+    addPageSwitchListener(): void;
+    addSinglePageListener(): void;
+    addPageEndListener(): void;
+    pageStartHandler(): void;
+    pageEndHandler(): void;
+    startHeartBeatInterval(): void;
+    reissueHeartBeatData(): void;
+    stopHeartBeatInterval(): void;
+    delHeartBeatData(storageKey?: string): void;
+    isCollectUrl(): boolean;
+    saveHeartBeatData(type?: string): void;
+    getPageLeaveProperties(): IAnyObject;
+}
+
+declare class SiteLinkerPlugin extends PluginBase<TrackOptions> {
+    options: TrackOptions;
+    context: TrackInstance;
+    name: string;
+    isReady: boolean;
+    linker: LinkerItem[];
+    constructor(options: TrackOptions, context: TrackInstance);
+    init(): void;
+    transform(): ReportDataType<any>;
+    getLinkerConfig(): {
+        linker: LinkerItem[];
+        re_login: boolean;
+    };
+    resolveOption(): void;
+    /**
+     * 多域名打通设置
+     */
+    setRefferId(): void;
+    /**
+     * 获取链接上的id
+     */
+    getUrlId(): string;
+    /**
+     * 判断url链接是否包含part_url
+     * @param url
+     */
+    getPartUrl(url: string): boolean;
+    /**
+     * 获取url链接对应的linker配置中after_hash的值
+     * @param url
+     */
+    getPartHash(url: string): boolean;
+    /**
+     * 获取当前的匿名ID和当前的登录ID
+     */
+    getCurrentId(): string;
+    /**
+     * 重写a 标签的href链接
+     * @param url
+     * @param dom
+     */
+    rewriteUrl(url: string, dom: HTMLAnchorElement): string;
+    addClickListen(): void;
+}
+
+/**
+ * 内置插件实例
+ */
+interface BuiltPluginsInstanceMap {
+    /**
+     * 页面浏览时长插件
+     */
+    PageLeave: PageLeavePlugin;
+    /**
+     * 多域名打通插件
+     */
+    SiteLinker: SiteLinkerPlugin;
+    /**
+     * abTest插件
+     */
+    HinaABTest: AbTestingPlugin;
+}
+/**
+ * 内置插件配置
+ */
+interface BuiltPluginsConfig {
+    /**
+     * 页面浏览时长插件
+     */
+    PageLeave: PageLeaveAutoTrackObject;
+    /**
+     * 多域名打通插件
+     */
+    SiteLinker?: SiteLinkerOptions;
+    /**
+     * abTest插件
+     */
+    HinaABTest?: AbTestingOptions;
+}
+
+declare class HinaTrack extends WebClient<TrackOptions> {
+    consolePrefix: string;
+    /**
+     * 存储对象
+     */
+    store: State<TrackOptions>;
+    /**
+     * 性能监控实例
+     */
+    epmInstance: Monitor;
+    /**
+     * 上报数据的dom元素 默认有 'a', 'input', 'button', 'textarea'
+     */
+    trackTags: string[];
+    /**
+     * 事件静态公共属性
+     */
+    presetProps: IAnyObject;
+    constructor(options: TrackOptions, useInstancing?: boolean);
+    /**
+     * 注册/初始化SDK
+     * @param options
+     */
+    init(options: TrackOptions): void;
+    /**
+     * 初始化共享数据
+     */
+    initState(): void;
+    /**
+     * 处理配置信息
+     */
+    normalizeConfig(): void;
+    /**
+     * 更新采集的dom元素
+     */
+    updateTrackTags(): void;
+    /**
+     * 初始化广告参数
+     */
+    initAdvProps(): void;
+    /**
+     * 应用插件
+     */
+    initPlugins(): void;
+    /**
+     * 启动内置插件
+     */
+    use<T extends keyof BuiltPluginsConfig, U extends BuiltPluginsConfig[T]>(pluginName: T, options: U): BuiltPluginsInstanceMap[T];
+    /**
+     * 获取指定插件实例
+     * @param pluginName
+     */
+    getPluginInstance<T extends keyof BuiltPluginsInstanceMap | keyof any, U extends T extends keyof BuiltPluginsInstanceMap ? BuiltPluginsInstanceMap[T] : any>(pluginName: T): U;
+    /**
+     * 设置配置选项
+     * @param options 配置对象
+     */
+    setConfig(options: Partial<TrackOptions>): void;
+    /**
+     * 获取配置选项 参数为空时 返回整个配置对象
+     * @param key
+     */
+    getConfig(key?: keyof TrackOptions): TrackOptions[keyof TrackOptions] | TrackOptions;
+    /**
+     * 设置用户登录的唯一标识
+     * @param uid
+     * @param callback
+     */
+    setUserUId(uid: string | number, callback?: VoidFn): void;
+    /**
+     * 获取用户登录的唯一标识
+     */
+    getUserUid(): string;
+    /**
+     * 设置设备ID
+     * @param uid
+     */
+    setDeviceUId(uid: string): void;
+    /**
+     * 获取设备ID
+     */
+    getDeviceUId(): string;
+    /**
+     * 添加用户属性
+     * 直接设置用户的属性，如果存在则覆盖。
+     * @param data
+     * @param callback
+     */
+    userSet(data: IAnyObject, callback?: VoidFn): void;
+    /**
+     * 添加用户属性
+     * 如果不存在则设置，存在就不设置
+     * @param data
+     * @param callback
+     */
+    userSetOnce(data: IAnyObject, callback?: VoidFn): void;
+    /**
+     * 对当前用户的属性做递增或者递减
+     * @param data
+     * @param callback
+     */
+    userAdd(data: string | {
+        [key: string]: number;
+    }, callback?: VoidFn): void;
+    /**
+     * 给数组属性添加值。通过userSet只能改变属性的值。如果这个属性是数组类型的，你不想完全改变这个值，只想做添加操作可以使用此方法。
+     */
+    userAppend(data: IAnyObject, callback?: VoidFn): void;
+    /**
+     * 删除当前用户的一些属性
+     * @param data
+     * @param callback
+     */
+    userUnset(data: string | string[], callback?: VoidFn): void;
+    /**
+     * 删除当前用户及他的所有属性。
+     * @param callback
+     */
+    userDelete(callback?: VoidFn): void;
+    /**
+     * 添加事件公共属性
+     * 当使用函数类型作为属性值、函数返回值只能是string、bool、number、date、array类型
+     * @param params
+     */
+    registerCommonProperties(params: IAnyObject | UnKnownFn): void;
+    /**
+     * 获取预置属性
+     * 此方法可获取，页面地址，页面标题，前向地址，SDK 类型及版本，屏幕宽高，最近一次的相关属性
+     */
+    getPresetProperties(): ReportProperties;
+    /**
+     * 清空或删除指定预置属性
+     * @param payload
+     */
+    clearPageRegister(payload?: boolean | string[]): void;
+    /**
+     * 检查发送数据
+     * @param props
+     */
+    checkReportProperties(props: IAnyObject): void;
+    /**
+     * 自定义埋点事件
+     * @param event
+     * @param properties
+     * @param callback
+     */
+    track(event: string, properties?: IAnyObject, callback?: VoidFn): void;
+    /**
+     * 手动调用埋点
+     * @param name
+     * @param data
+     * @param callback
+     */
+    quick(name: 'autoTrack' | 'autoTrackSinglePage', data?: IAnyObject | VoidFn, callback?: VoidFn): void;
+    /**
+     * 开启页面浏览采集
+     * @param data
+     * @param callback
+     */
+    autoTrack(data?: IAnyObject, callback?: VoidFn): void;
+    /**
+     * 上报数据
+     * @param data
+     * @param callback
+     * @param type
+     */
+    report(data: ReportDataType<any>, callback?: AnyFn, type?: ReportTypes): void;
+    /**
+     * 获取上报数据
+     * @param type
+     * @param event
+     * @param data
+     */
+    getReportData<T = any>(type: string, event: string, data?: T): ReportDataType<T & ReportProperties>;
+    /**
+     * 获取通用的上报数据
+     * @param type 上报类型
+     * @param event 事件名称
+     */
+    getReportProperties(type?: string, event?: string): ReportProperties;
+}
+type TrackInstance = InstanceType<typeof HinaTrack>;
+
+declare const hinaSdk: HinaTrack;
+
+export { HinaTrack, type TrackInstance, hinaSdk as default };

package/package.json

@@ -1,46 +1,36 @@
 {
   "name": "hina-cloud-js-sdk",
-  "version": "3.1.8",
-  "description": "hinaCloud javascript sdk",
-  "main": "build/hina.cjs.min.js",
-  "jsnext:main": "build/hina.esm.min.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "rollup -c",
-    "build:epm": "rollup -c rollup.config.epm.js",
-    "build:sdk": "rollup -c rollup.config.sdk.js",
-    "watch": "rollup -c -w",
-    "lint:report": "eslint ./src -f json -o report.json --ext .js,.ts || exit 0"
+  "version": "4.0.0",
+  "description": "WEB埋点SDK",
+  "main": "dist/hina.full.js",
+  "module": "dist/hina.esm.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
   },
-  "repository": {
-    "type": "git",
-    "url": "git@gitlab.hinadt.com:hina-cloud/hina-cloud-js-sdk.git"
-  },
-  "keywords": [
-    "sdk",
-    "hinaCloud",
-    "hina-cloud-js-sdk",
-    "hinaCloudJsSdk"
+  "files": [
+    "dist"
   ],
-  "devDependencies": {
-    "@babel/cli": "^7.23.9",
-    "@babel/core": "^7.23.9",
-    "@babel/plugin-proposal-optional-chaining": "^7.21.0",
-    "@babel/preset-env": "^7.23.9",
-    "@rollup/plugin-commonjs": "^25.0.4",
-    "@rollup/plugin-node-resolve": "^15.1.0",
-    "@rollup/plugin-terser": "^0.4.4",
-    "rollup": "^2.53.1",
-    "rollup-plugin-babel": "^4.4.0",
-    "rollup-plugin-copy": "^3.5.0",
-    "rollup-plugin-javascript-obfuscator": "^1.0.4",
-    "rollup-plugin-uglify": "^6.0.4",
-    "rollup-watch": "^4.3.1"
+  "author": {
+    "name": "dongrudong@hinadt.com"
   },
-  "author": "",
   "license": "ISC",
   "dependencies": {
-    "mobile-detect": "^1.4.5",
-    "raven-js": "^3.27.2"
+    "hina-cloud-core": "4.0.0",
+    "hina-cloud-monitor": "4.0.0",
+    "hina-cloud-types": "2.0.0",
+    "hina-cloud-utils": "2.0.0"
+  },
+  "buildOptions": {
+    "name": "hinaDataStatistic",
+    "fileName": "hina",
+    "formats": [
+      "esm",
+      "esm-full",
+      "cjs",
+      "global",
+      "umd"
+    ],
+    "external": []
   }
-}
+}

package/readme.md

@@ -0,0 +1 @@
+## WEB埋点SDK

package/.eslintrc.js

@@ -1,12 +0,0 @@
-module.exports = {
-root: true,
-  env: {
-    node: true,
-    browser: true,
-    es2021: true,
-  },
-  parserOptions: {
-    ecmaVersion: "latest",
-    sourceType: "module",
-  },
-};

package/.gitlab-ci.yml

@@ -1,16 +0,0 @@
-sonarqube-check:
-  image:
-    name: sonarsource/sonar-scanner-cli:latest
-    entrypoint: [""]
-  variables:
-    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"  # Defines the location of the analysis task cache
-    GIT_DEPTH: "0"  # Tells git to fetch all the branches of the project, required by the analysis task
-  cache:
-    key: "${CI_JOB_NAME}"
-    paths:
-      - .sonar/cache
-  script:
-    - sonar-scanner
-  allow_failure: true
-  only:
-    - master # or the name of your main branch

package/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-    "cSpell.words": [
-        "Hina"
-    ]
-}