hina-cloud-js-sdk 3.1.7 → 3.1.8

package/packages/types/dist/index.d.ts

@@ -0,0 +1,603 @@
+declare enum ConsoleTypes {
+    LOG = "log",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error",
+    ASSERT = "assert"
+}
+declare enum ReportType {
+    BEACON = "beacon",
+    IMAGE = "image",
+    AJAX = "ajax"
+}
+
+type PluginConstructor<T extends BaseOptions, U = any> = new (options: T, context?: U) => PluginBase<T, U>;
+declare abstract class PluginBase<T extends BaseOptions, U = any> {
+    options: T;
+    context?: U;
+    abstract name: string;
+    protected constructor(options: T, context?: U);
+    /**
+     * 初始化方法
+     */
+    abstract init(notify?: (data: any) => void): void;
+    /**
+     * 数据格式转换
+     */
+    abstract transform(data?: any): ReportDataType<any>;
+}
+
+type VoidFn = () => void;
+interface IAnyObject {
+    [key: string]: any;
+}
+type UnKnownFn = (...args: unknown[]) => any;
+type AnyFn = (...args: any[]) => any;
+
+/**
+ * 基础配置
+ */
+interface BaseOptions {
+    /**
+     * 项目名称
+     */
+    name: string;
+    /**
+     * 采集上报地址URL
+     */
+    serverUrl: string;
+    /**
+     * 是否打印信息
+     */
+    showLog?: boolean;
+}
+/**
+ * 埋点配置
+ */
+interface TrackOptions extends BaseOptions {
+    /**
+     * 埋点配置
+     */
+    autoTrackConfig: {
+        /**
+         * 是否开启自动点击采集(默认 true), true表示开启，自动采集 H_WebClick 事件
+         */
+        clickAutoTrack?: boolean;
+        /**
+         * 是否开启页面停留采集(默认 true), true表示开启，自动采集 H_WebStay 事件
+         */
+        stayAutoTrack?: boolean;
+        /**
+         * 是否开启页面浏览采集(默认 false)，auto 表示开启，singlePage 表示单页面开启，false 关闭，可配合手动开启使用
+         * 若页面中有锚点设计，需要将该配置设为 false，否则触发锚点会多触发 H_pageview 事件
+         */
+        pageviewAutoTrack?: 'singlePage' | 'auto' | false;
+        /**
+         * 自动采集web离开事件(默认 false) false object(PageLeave的配置) 默认关闭
+         */
+        pageLeaveAutoTrack?: boolean | PageLeaveAutoTrackObject;
+        /**
+         * 是否采集当前页面的数据(默认返回true)，返回false表示不采集当前页面,
+         * 设置这个函数后，内容为空的话，是返回false。不设置函数默认是采集所有页面。
+         */
+        isCollectUrl?: () => boolean;
+        /**
+         * 用户点击页面元素时会触发这个函数，判断是否要采集当前这个元素，返回true表示采集，返回false表示不采集。(默认true)
+         */
+        isCollectElement?: (value?: any) => boolean;
+        /**
+         * 考虑到用户隐私，这里可以设置 input 里的内容是否采集
+         * 如果返回true，表示采集 input 内容，返回false表示不采集 input 内容,(默认false)。
+         */
+        isCollectInput?: (value?: any) => boolean;
+        /**
+         * 根据特定标签添加上报的自定义字段
+         * 比如您需要给有 data=test 属性的标签的点击事件增加自定义属性 name:'aa' ，则代码如下：
+         * if(element_target.getAttribute('data') === 'test'){
+         *      return {
+         *        name:'aa'
+         *      }
+         *    }
+         */
+        addCustomProperty?: (value?: any) => any;
+        /**
+         * 有效停留时长超过多少毫秒过开始采集(默认4000ms)，单位ms
+         */
+        stayDelayTime?: number;
+        /**
+         * 预置属性停留时长 event_duration 的最大值，(默认 18000s)，单位s
+         */
+        maxStayPageDuration?: number;
+        /**
+         * 是否开启dom元素采集(默认 false) 可以是boolean，也可以是object类型 配置为object类型，有如下参数
+         * ignoreTags：忽略的标签 不可自定义，内部定义好的
+         * maxLevel：层级 默认是 1，可配置范围是 [1, 2, 3],非该范围配置值，会被当作 1 处理。
+         */
+        collectTags?: {
+            div?: boolean | {
+                ignoreTags?: string[];
+                maxLevel?: number;
+            };
+            [key: string]: boolean | {
+                ignoreTags?: string[];
+                maxLevel?: number;
+            };
+        };
+        /**
+         * 开启全埋点时，配置带有指定属性的页面元素点击，自动采集点击事件(默认['hn-click'])
+         */
+        trackAttr?: string[];
+    };
+    /**
+     * 多域名打通插件配置项 v4版本开始支持配置项开启,v4版本之前只能通过use方法开启
+     */
+    siteLinkerConfig?: SiteLinkerOptions;
+    /**
+     * 采集当前页面的视区停留事件(默认返回 true)，返回false则不采集
+     */
+    stayAutoTrackConfig?: {
+        isCollectUrl?: () => boolean;
+    };
+    /**
+     * 是否使用跨域图片上报(默认false)
+     */
+    imgUseCrossOrigin?: boolean;
+    /**
+     * 单页面配置(默认false)，若页面中有锚点设计，需要将该配置删除，否则触发锚点会多触发 H_pageview 事件
+     */
+    isSinglePage?: boolean | (() => boolean | IAnyObject);
+    /**
+     * 批量发送数据(默认false) 可以是boolean，也可以是object类型
+     */
+    batchSend?: boolean | {
+        /**
+         * 一次请求超过多少毫秒的话自动取消，防止请求无响应 默认 6000ms
+         */
+        dataSendTimeout?: number;
+        /**
+         * 间隔多少毫秒发一次数据 默认 6000ms
+         */
+        sendInterval?: number;
+        /**
+         * 存储 localStorage 条数最大值，默认：200 。如 localStorage 条数超过该值，则使用 image 方式立即发送数据
+         */
+        storageLimit?: number;
+    };
+    appJsBridge?: boolean;
+    /**
+     * 上报数据方式(默认 image) beacon、image、ajax
+     */
+    sendType?: ReportType;
+    /**
+     * 表示数据发送超时时间(默认 3000ms)，如果数据发送超过 datasend_timeout 还未返回结果，会强制取消该请求,单位ms
+     */
+    dataSendTimeout?: number;
+    /**
+     * 是否开启 H_latest 相关的最近一次相关事件属性采集以及配置 H_url 作为公共属性，默认值为一个对象
+     * 子配置项 true 表示采集,false 表示不采集,未设置的参数取默认值
+     */
+    presetProperties?: {
+        /**
+         * 是否采集 最近一次广告系列相关参数，默认值 true
+         */
+        latest_utm?: boolean;
+        /**
+         * 广告来源，默认值 true
+         */
+        latest_utm_source?: boolean;
+        /**
+         * 是否采集 最近一次流量来源类型，默认值 true
+         */
+        latest_traffic_source_type?: boolean;
+        /**
+         * 是否采集 最近一次搜索引擎关键字，默认值 true
+         */
+        latest_search_keyword?: boolean;
+        /**
+         * 是否采集 最近一次前向地址，默认值 true
+         */
+        latest_referrer?: boolean;
+        /**
+         * 是否采集 页面地址作为公共属性，默认是 true
+         */
+        url?: boolean;
+        /**
+         * 是否采集 页面标题作为公共属性，默认是 true
+         */
+        title?: boolean;
+        [key: string]: boolean;
+    };
+    /**
+     * 全局回调函数
+     */
+    globalCallback?: (...data: any[]) => void;
+    /**
+     * 插件系统，v4版本开始支持用户自定义插件，具体插件开发规范参考插件文档
+     */
+    plugins?: PluginConstructor<TrackOptions>[];
+    /**
+     * 性能监控系统配置
+     */
+    performanceErrorConfig?: PerformanceOptions;
+}
+/**
+ * 监控系统配置
+ */
+interface PerformanceOptions extends BaseOptions {
+    /**
+     * 设置 true 后自动采集和上报页面错误信息。默认 true
+     */
+    errorCapture?: boolean;
+    /**
+     * 开启性能监控功能，默认 true
+     */
+    performance?: boolean;
+    /**
+     * 插件系统，v4版本开始支持用户自定义插件，具体插件开发规范参考插件文档
+     */
+    plugins?: PluginConstructor<PerformanceOptions>[];
+}
+/**
+ * PageLeavePlugin插件参数
+ */
+interface PageLeaveAutoTrackObject {
+    /**
+     * 心跳记录刷新时间 单位秒(s) 默认值 5s
+     */
+    heartbeat_interval_time?: number;
+    /**
+     * 最大页面浏览时长 单位秒(s) 默认值 432000s (5天)
+     */
+    max_duration?: number;
+    /**
+     * 设置是否采集当前页面浏览时长, 返回 true 为需要采集，返回 false 或者不返回则为不采集
+     */
+    isCollectUrl?: (url?: string) => boolean;
+    /**
+     * 页面浏览时长自定义属性
+     */
+    custom_props?: {
+        [key: string]: any;
+    };
+}
+/**
+ * SiteLinker插件参数
+ */
+interface LinkerItem {
+    /**
+     *  配置值为打通网站网址的一部分。建议配置时配置为打通网站的域名。
+     */
+    part_url?: string;
+    /**
+     * 配置 _hnsdk 参数在 URL 的 hash 部分（即 # 后部分）还是在 URL 的 search 部分（即 # 前的 ？部分）。
+     * 必填属性，且属性值必须为布尔类型，即 true 或 false（默认建议填 false）。
+     */
+    after_hash?: boolean;
+}
+interface SiteLinkerOptions {
+    /**
+     * 该配置设置为 true 后，如果从已登录的页面跳转过来，即使当前网页已经登录，当前网页仍然会以之前网页的登录 id 再次登录。
+     */
+    re_login?: boolean;
+    /**
+     * 具体网站链接配置项
+     */
+    linker?: LinkerItem[];
+}
+/**
+ * 内置插件配置
+ */
+interface BuiltPluginsConfig {
+    /**
+     * 页面浏览时长插件
+     */
+    PageLeave: PageLeaveAutoTrackObject;
+    /**
+     * 页面加载时长插件
+     */
+    PageLoad: {
+        /**
+         * 最大页面加载时长，超过这个时长将不再上报event_duration属性，默认1800s(30分钟)
+         */
+        max_duration: number;
+    };
+    /**
+     * 多域名打通插件
+     */
+    SiteLinker?: SiteLinkerOptions;
+}
+/**
+ * 用户信息存储
+ */
+interface StoreState {
+    /**
+     * 设备ID
+     */
+    deviceId?: string;
+    /**
+     * 账号ID
+     */
+    accountId?: string;
+    /**
+     * 匿名ID
+     */
+    anonymousId?: string;
+    /**
+     * 首次访问时间，用户属性用于触发profile_set_once接口
+     */
+    firstVisitTime?: number;
+    /**
+     * 广告相关参数
+     */
+    props?: UtmProperties;
+}
+/**
+ * element properties类型声明
+ */
+interface ElementProperties {
+    /**
+     * 元素类型
+     */
+    H_element_type?: string;
+    /**
+     * 元素name属性(getAttribute('name'))
+     */
+    H_element_name?: string;
+    /**
+     * 元素id属性
+     */
+    H_element_id?: string;
+    /**
+     * 元素href属性
+     */
+    H_element_target_url?: string;
+    /**
+     * 元素className属性
+     */
+    H_element_class_name?: string;
+    /**
+     * 元素内容主要是input元素的value内容和button的innerText内容
+     */
+    H_element_content?: string;
+    /**
+     * 元素路径
+     */
+    H_element_path?: string;
+    /**
+     * 元素选择器路径，通过此路径可以找到该元素对应的位置
+     */
+    H_element_selector?: string;
+    /**
+     * 元素在页面x坐标
+     */
+    H_page_x?: number | string;
+    /**
+     * 元素在页面y坐标
+     */
+    H_page_y?: number | string;
+    /**
+     * 额外自定义的参数
+     */
+    [key: string]: any;
+}
+/**
+ * 广告相关类型声明
+ */
+interface UtmProperties {
+    H_latest_referrer?: string;
+    H_latest_search_keyword?: string;
+    H_latest_traffic_source_type?: string;
+    H_latest_utm_source?: string;
+    H_latest_utm_campaign?: string;
+    H_latest_utm_content?: string;
+    H_latest_utm_medium?: string;
+    H_latest_utm_term?: string;
+    H_utm_campaign?: string;
+    H_utm_content?: string;
+    H_utm_medium?: string;
+    H_utm_source?: string;
+    H_utm_term?: string;
+    [key: string]: any;
+}
+/**
+ * page properties页面信息 类型声明类型声明
+ */
+interface PageProperties {
+    /**
+     * 页面referrer
+     */
+    H_referrer?: string;
+    /**
+     * referrer host
+     */
+    H_referrer_host?: string;
+    /**
+     * 页面url
+     */
+    H_url?: string;
+    /**
+     * 页面host
+     */
+    H_url_host?: string;
+    /**
+     * 页面domain
+     */
+    H_url_domain?: string;
+    /**
+     * 页面path
+     */
+    H_url_path?: string;
+    /**
+     * 页面hash
+     */
+    H_url_hash?: string;
+    /**
+     * 页面title
+     */
+    H_title?: string;
+    /**
+     * 页面停留时长
+     */
+    event_duration?: number;
+    /**
+     * 页面滚动位置
+     */
+    H_viewport_position?: number;
+    /**
+     * 页面停留时间
+     */
+    H_time?: number;
+    [key: string]: any;
+}
+/**
+ * 浏览器信息类型声明
+ */
+interface BrowserInfo {
+    /**
+     * 系统类型
+     */
+    H_os?: string;
+    /**
+     * 系统版本
+     */
+    H_os_version?: string;
+    /**
+     * 浏览器类型
+     */
+    H_browser?: string;
+    /**
+     * 浏览器版本
+     */
+    H_browser_version?: string;
+    /**
+     * 设备型号
+     */
+    H_model?: string;
+    /**
+     * 时区
+     */
+    H_timezone_offset?: number;
+    /**
+     * 屏幕宽度
+     */
+    H_screen_width?: number;
+    /**
+     * 屏幕高度
+     */
+    H_screen_height?: number;
+    /**
+     * 文档可视区宽度
+     */
+    H_viewport_width?: number;
+    /**
+     * 文档可视区高度
+     */
+    H_viewport_height?: number;
+    H_lib_version?: string;
+    H_lib?: string;
+    H_lib_method?: string;
+    /**
+     * 网络类型
+     */
+    H_network_type?: string;
+    /**
+     * 语言
+     */
+    H_language?: string;
+    [key: string]: any;
+}
+/**
+ * 路由改变信息类型声明
+ */
+interface RouterParams {
+    /**
+     * 上一次路由
+     */
+    fromPath?: string;
+    /**
+     * 上一个页面的地址
+     */
+    fromHref?: string;
+    /**
+     * 当前路由
+     */
+    toPath?: string;
+    /**
+     * 当前页面的地址
+     */
+    toHref?: string;
+    /**
+     * 路由模式
+     */
+    mode?: 'history' | 'hash';
+    [key: string]: any;
+}
+/**
+ * 上报通用属性类型声明
+ */
+interface ReportProperties extends UtmProperties, PageProperties, BrowserInfo {
+    /**
+     * 设备ID
+     */
+    device_id?: string;
+    H_is_first_time?: boolean;
+    H_is_first_day?: boolean;
+}
+/**
+ * 上报数据类型
+ */
+interface ReportDataType<T> {
+    /**
+     * 匿名ID
+     */
+    anonymous_id?: string;
+    /**
+     * 账号ID
+     */
+    account_id?: string;
+    /**
+     * 事件名称
+     */
+    event?: string;
+    /**
+     * 发送时间
+     */
+    send_time?: number;
+    /**
+     * 当前时间
+     */
+    time?: number;
+    /**
+     * 上报类型
+     */
+    type?: string;
+    /**
+     * 唯一ID
+     */
+    _track_id?: number;
+    /**
+     * 上报数据属性
+     */
+    properties?: T;
+    [key: string]: any;
+}
+interface RequestParams {
+    /**
+     * 上报地址
+     */
+    url: string;
+    /**
+     * 上报数据
+     */
+    data: string;
+    /**
+     * 上报超时时间
+     */
+    timeout: number;
+    /**
+     * 图片是否使用跨域
+     */
+    imgUseCrossOrigin?: boolean;
+}
+
+export { type AnyFn, type BaseOptions, type BrowserInfo, type BuiltPluginsConfig, ConsoleTypes, type ElementProperties, type IAnyObject, type LinkerItem, type PageLeaveAutoTrackObject, type PageProperties, type PerformanceOptions, PluginBase, type PluginConstructor, type ReportDataType, type ReportProperties, ReportType, type RequestParams, type RouterParams, type SiteLinkerOptions, type StoreState, type TrackOptions, type UnKnownFn, type UtmProperties, type VoidFn };

package/packages/types/dist/index.esm.js

@@ -0,0 +1,25 @@
+var ConsoleTypes;
+(function (ConsoleTypes) {
+    ConsoleTypes["LOG"] = "log";
+    ConsoleTypes["INFO"] = "info";
+    ConsoleTypes["WARN"] = "warn";
+    ConsoleTypes["ERROR"] = "error";
+    ConsoleTypes["ASSERT"] = "assert";
+})(ConsoleTypes || (ConsoleTypes = {}));
+var ReportType;
+(function (ReportType) {
+    ReportType["BEACON"] = "beacon";
+    ReportType["IMAGE"] = "image";
+    ReportType["AJAX"] = "ajax";
+})(ReportType || (ReportType = {}));
+
+var PluginBase = /** @class */ (function () {
+    function PluginBase(options, context) {
+        this.options = options;
+        this.context = context;
+    }
+    return PluginBase;
+}());
+
+export { ConsoleTypes, PluginBase, ReportType };
+//# sourceMappingURL=index.esm.js.map

package/packages/types/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;"}