hina-cloud-js-sdk 3.1.6 → 3.1.8

package/packages/track/dist/index.cjs.js.map

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

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

@@ -0,0 +1,212 @@
+import { BaseCore } from 'hina-cloud-core';
+import { ReportDataType, TrackOptions, IAnyObject, PluginBase, BuiltPluginsConfig, AnyFn, ReportType, VoidFn, UnKnownFn, ReportProperties } from 'hina-cloud-types';
+import { State } from 'hina-cloud-utils';
+
+/**
+ * @description 批量发送数据
+ */
+declare class BatchSend {
+    context: HinaTrack;
+    batchKey: string;
+    batchDataKey: string;
+    constructor(context: HinaTrack);
+    getBatchConfig(): {
+        sendInterval: number;
+        dataSendTimeout: number;
+        storageLimit: number;
+    };
+    getStorageList(): {
+        dataKey: string;
+        expireTime: number;
+    }[];
+    batchInterval(): void;
+    send(): Promise<void>;
+    remove(removeKeys: string[]): void;
+    add(data: ReportDataType<any>): void;
+}
+
+declare class HinaTrack extends BaseCore<TrackOptions> {
+    /**
+     * 存储对象
+     */
+    store: State<TrackOptions>;
+    /**
+     * 批量发送器
+     */
+    batchSender: BatchSend;
+    /**
+     * 上报数据的dom元素 默认有 'a', 'input', 'button', 'textarea'
+     */
+    trackTags: string[];
+    /**
+     * 事件静态公共属性
+     */
+    presetProps: IAnyObject;
+    /**
+     * 插件列表
+     */
+    plugins: PluginBase<TrackOptions>[];
+    consolePrefix: string;
+    constructor(options: TrackOptions, useInstancing?: boolean);
+    /**
+     * 注册/初始化SDK
+     * @param options
+     */
+    init(options: TrackOptions): void;
+    /**
+     * 处理配置信息
+     */
+    normalizeConfig(): void;
+    /**
+     * 初始化广告参数
+     */
+    initAdvProps(): void;
+    /**
+     * 处理广告参数
+     * @param prefix
+     */
+    getUmtsParams(prefix?: string): IAnyObject;
+    /**
+     * 初始化共享数据
+     */
+    initState(): void;
+    /**
+     * 更新采集的dom元素
+     */
+    updateTrackTags(): void;
+    /**
+     * 应用插件
+     */
+    initPlugins(): void;
+    /**
+     * @deprecated
+     * 启动内置插件，v4版本后不建议使用该方法启动插件
+     * 建议通过配置项的方式启动内置插件
+     */
+    use<T extends keyof BuiltPluginsConfig, U extends BuiltPluginsConfig[T]>(pluginName: T, options: U): void;
+    /**
+     * 设置配置选项
+     * @param options 配置对象
+     */
+    setConfig(options: Partial<TrackOptions>): void;
+    /**
+     * 获取配置选项 参数为空时 返回整个配置对象
+     * @param key
+     */
+    getConfig(key?: keyof TrackOptions): TrackOptions[keyof TrackOptions] | TrackOptions;
+    /**
+     * 上报数据
+     * @param data
+     * @param callback
+     * @param type
+     */
+    report(data: IAnyObject, callback?: AnyFn, type?: ReportType): Promise<{
+        type: 'success' | 'error' | 'abort';
+        msg?: string;
+    }>;
+    /**
+     * 设置用户登录的唯一标识
+     * @param uid
+     * @param callback
+     */
+    setUserUId(uid: string | number, callback?: VoidFn): void;
+    /**
+     * 设置设备ID
+     * @param uid
+     */
+    setDeviceUId(uid: string): void;
+    /**
+     * 获取设备ID
+     */
+    getDeviceUId(): string;
+    /**
+     * 自定义埋点事件
+     * @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
+     */
+    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;
+    /**
+     * 删除当前用户的一些属性
+     * @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 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;
+}
+
+declare const hinaSdk: HinaTrack;
+
+export { HinaTrack, hinaSdk as default };