gio-miniprogram-sdk 4.4.2 → 4.5.0

package/src/plugins/gioPerformance.ts

@@ -1,131 +0,0 @@
-/**
- * 名称：性能采集插件
- * 用途：用于采集小程序基本性能信息。
- */
-import { GrowingIOType } from '@@/types/growingIO';
-import { isEmpty } from '@@/utils/glodash';
-import { limitObject } from '@@/utils/tools';
-import EMIT_MSG from '@@/constants/emitMsg';
-import Exception from './gioPerformance/exception';
-import Monitor from './gioPerformance/monitor';
-import Network from './gioPerformance/network';
-
-let ut;
-class GioPerformance {
-  public pluginVersion: string;
-  public network: any;
-  public exception: any;
-  public monitor: any;
-  // 缓存队列，SDK初始化完成之后再根据性能的配置项发送数据
-  private cacheQueue: any[];
-  constructor(public growingIO: GrowingIOType, public options: any = {}) {
-    this.pluginVersion = '__PLUGIN_VERSION__';
-    ut = this.growingIO.utils;
-    this.options = {
-      monitor: true,
-      exception: true,
-      network: false,
-      ...this.options
-    };
-    this.cacheQueue = [];
-    this.growingIO.emitter.on(EMIT_MSG.SDK_INITIALIZED, (vdsConfig: any) => {
-      if (vdsConfig.trackingId === this.growingIO.trackingId) {
-        // 初始化配置项优先级更高（后续版本考虑把配置项值放在插件options上去配，弱化初始化配置项）
-        const { monitor, exception, network } = vdsConfig.performance;
-        if (monitor !== this.options.monitor) {
-          this.options.monitor = monitor;
-        }
-        if (exception !== this.options.exception) {
-          this.options.exception = exception;
-        }
-        if (network !== this.options.network) {
-          this.options.network = network;
-        }
-        this.init();
-      }
-    });
-    // 采集开关从关闭到打开时要把队列中存的启动和错误都发出去
-    // 采集开关开启必会更新session
-    this.growingIO.emitter?.on(EMIT_MSG.SESSIONID_UPDATE, () => {
-      const { trackingId, getOption } = this.growingIO;
-      if (getOption(trackingId, 'dataCollect')) {
-        this.sendCacheQuene();
-      }
-    });
-  }
-
-  init = () => {
-    const { dataCollect } = this.growingIO.vdsConfig;
-    const { monitor, exception, network } = this.options;
-    if (monitor) {
-      this.monitor = new Monitor(this.growingIO);
-    }
-    if (exception) {
-      this.exception = new Exception(this.growingIO);
-    }
-    if (network) {
-      this.network = new Network(this.growingIO, this.options);
-    }
-    // SDK初始化完成发送缓存队列
-    if (dataCollect) {
-      this.sendCacheQuene();
-    }
-  };
-
-  // 发送缓存队列
-  sendCacheQuene = () => {
-    if (!ut.isEmpty(this.cacheQueue)) {
-      this.cacheQueue.forEach((o: any) => {
-        this.buildPerfEvent(o.eventName, o.attributes, o.extra);
-      });
-      this.cacheQueue = [];
-    }
-  };
-
-  // 构建各种性能事件
-  buildPerfEvent = (eventName: string, attributes: any, extra?: any) => {
-    const {
-      dataStore: { eventContextBuilder, eventConverter },
-      gioSDKInitialized,
-      vdsConfig
-    } = this.growingIO;
-    // SDK没初始化完成或初始化关闭采集开关的事件先存起来，等SDK初始化完成或开启采集开关再发
-    if (!gioSDKInitialized || !vdsConfig.dataCollect) {
-      this.cacheQueue = [
-        ...this.cacheQueue,
-        {
-          eventName,
-          attributes,
-          extra
-        }
-      ];
-      return false;
-    }
-    // 处理过长的小数，保留0位
-    ut.forEach(attributes, (v, k) => {
-      if (Number.isNaN(v) || ut.isNil(v) || Number(v) < 0) {
-        attributes[k] = 0;
-      }
-      attributes[k] = ut.fixed(v, 0);
-    });
-    let event = {
-      eventType: 'CUSTOM',
-      eventName,
-      attributes,
-      ...eventContextBuilder(this.growingIO.trackingId)
-    };
-    event.attributes = limitObject({
-      ...(event.attributes ?? {}),
-      ...attributes
-    });
-    if (!isEmpty(extra)) {
-      event = { ...event, ...extra };
-    }
-    eventConverter(event);
-  };
-}
-
-export default {
-  name: 'gioPerformance',
-  method: GioPerformance
-};

package/src/types/base.ts

@@ -1,167 +0,0 @@
-export interface StringObject {
-  [key: string]: string;
-}
-
-interface TBConfig {
-  cloud: any;
-  cloudFuncSend?: boolean;
-  cloudFuncName?: string;
-  cloudFuncHandler?: string;
-  cloudAppId?: string;
-  path?: string;
-}
-export interface UserOptions {
-  // 是否开启无埋点
-  autotrack: boolean;
-  // 是否开启加密压缩
-  compress: boolean;
-  // 是否开启数据采集
-  dataCollect: boolean;
-  // 是否开启调试模式
-  debug: boolean;
-  // 是否开启
-  idMapping: boolean;
-  // 与内嵌页打通时额外的信息参数
-  extraParams: string[];
-  // 是否开启分享跟踪
-  followShare: boolean;
-  // 是否开启强制登录
-  forceLogin: boolean;
-  // 或略上报字段
-  ignoreFields: string[];
-  // 曝光比例
-  impressionScale: number;
-  // 是否使用原始来源信息作为访问事件的参数上报
-  originalSource: boolean;
-  // session保活时长（5分钟）
-  keepAlive: number;
-  // 性能采集配置
-  performance?: {
-    monitor: boolean;
-    exception: boolean;
-    network: boolean;
-  };
-  // 请求超时时长
-  requestTimeout?: number;
-  // 数据上报域名
-  serverUrl?: string;
-  // session超时时长
-  sessionExpires?: number;
-  // taro框架实例
-  taro?: any;
-  // taro框架vue实例
-  taroVue?: any;
-  // 淘宝小程序/小部件配置
-  tbConfig?: TBConfig;
-  // uniapp vue实例
-  uniVue?: boolean;
-  // 上报间隔（1秒）
-  uploadInterval: number;
-  // 小程序应用版本
-  version: string;
-}
-
-export interface ErrorEventParams {
-  key?: string;
-  error: string;
-  page?: string;
-  function?: string;
-}
-
-export interface Element {
-  x: string;
-  v?: string;
-  h?: string;
-  idx?: number;
-  obj?: number;
-}
-
-export type EventTypes =
-  | 'PAGE'
-  | 'VISIT'
-  | 'CUSTOM'
-  | 'VISITOR_ATTRIBUTES'
-  | 'LOGIN_USER_ATTRIBUTES'
-  | 'APP_CLOSED'
-  | 'VIEW_CLICK'
-  | 'VIEW_CHANGE';
-
-export interface EVENT {
-  appChannel: string;
-  appVersion: string;
-  attributes?: any;
-  dataSourceId: string;
-  deviceBrand: string;
-  deviceId: string;
-  deviceModel: string;
-  deviceType: string;
-  domain: string;
-  eventName: string;
-  eventSequenceId: number;
-  eventType: EventTypes;
-  hyperlink?: string;
-  index?: number;
-  language: string;
-  latitude?: number;
-  longitude?: number;
-  networkState: string;
-  path?: string;
-  platform: string;
-  platformVersion: string;
-  properties?: any;
-  query?: string;
-  referralPage?: string;
-  screenHeight: number;
-  screenWidth: number;
-  sdkVersion: string;
-  sessionId: string;
-  textValue?: string;
-  timestamp: number;
-  title: string;
-  userId?: string;
-  xpath?: string;
-}
-
-export interface EXTEND_EVENT extends EVENT {
-  requestId: string;
-  trackingId: string;
-}
-
-export type Actions =
-  | 'tap'
-  | 'longpress'
-  | 'longtap'
-  | 'change'
-  | 'confirm'
-  | 'blur'
-  | 'getphonenumber'
-  | 'contact'
-  | 'getuserinfo';
-
-export interface EventTarget {
-  type: Actions;
-  currentTarget: {
-    id: string;
-    dataset: {
-      index: number | string;
-      src: string;
-      title: string;
-      growingTrack: boolean;
-      growingtrack: boolean;
-      growingIgnore: boolean;
-    };
-  };
-  target: {
-    id: string;
-    dataset: {
-      index: number | string;
-      src: string;
-      title: string;
-      growingTrack: boolean;
-      growingtrack: boolean;
-      growingIgnore: boolean;
-    };
-  };
-  detail: any;
-  handler: string | undefined;
-}

package/src/types/dataStore.ts

@@ -1,62 +0,0 @@
-import { UserOptions } from '@@/types/base';
-import { EventHooksType } from '@@/types/eventHooks';
-
-export type StorageKeyType =
-  | 'gsid'
-  | 'originalSource'
-  | 'uid'
-  | 'sessionId'
-  | 'userId'
-  | 'userKey'
-  | 'gioId';
-
-export interface OriginOptions extends UserOptions {
-  appId: string;
-  dataSourceId?: string;
-  projectId: string;
-  trackingId: string;
-}
-
-export interface DataStoreType {
-  buildAddFavorites: (trackingId: string, args: any) => void;
-  buildAppMessageEvent: (trackingId: string, args: any) => void;
-  buildTimelineEvent: (trackingId: string, args: any) => void;
-  // 事件通用维度组装
-  eventContextBuilder?: (
-    trackingId: string,
-    params?: any,
-    executeAttributes?: boolean
-  ) => any;
-  eventConverter?: (event) => void;
-  eventHooks: EventHooksType;
-  eventInterceptor?: (event: any | void) => void;
-  eventReleaseInspector?: () => void;
-  generalProps: any;
-  getStorageKey: (trackingId: string, name: StorageKeyType) => string;
-  getTrackerVds: (trackingId: string) => any;
-  getOption: (trackingId: string, k?: string) => OriginOptions;
-  getOriginalSource: (trackingId: string) => any;
-  getGsid: (trackingId: string) => number;
-  setGsid: (trackingId: string, value: number) => void;
-  initTrackerOptions: (userOptions: OriginOptions) => any;
-  initTrackerHooker: (trackerOptions: OriginOptions) => void;
-  initOptions: (userOptions: OriginOptions) => OriginOptions;
-  initStorageInfo: (trackingId: string) => void;
-  interceptEvents: any[];
-  lastCloseTime: number;
-  lastPageEvent: any;
-  lastScene: number | string;
-  lastVisitEvent: any;
-  locationData: any;
-  saveStorageInfo: () => void;
-  scene: number | string;
-  sendPage: (trackingId: string, props?: any) => void;
-  sendVisit: (trackingId: string, props?: any) => void;
-  setOption: (trackingId: string, k: string, v: any) => boolean;
-  setOriginalSource: (trackingId: string, origins: any) => void;
-  shareOut: boolean;
-  toggleShareOut: (v?: boolean) => void;
-  trackTimers?: any;
-  initializedTrackingIds: string[];
-  trackersExecute: (callback: (trackingId: string) => void) => void;
-}

package/src/types/eventHooks.ts

@@ -1,146 +0,0 @@
-import { EVENT } from './base';
-
-export type AppHookLifeCircle = 'onShow' | 'onHide' | 'onError';
-export type PageHookLifeCircle =
-  | 'onShow'
-  | 'onLoad'
-  | 'onReady'
-  | 'onHide'
-  | 'onUnload'
-  | 'onShareAppMessage'
-  | 'onTabItemTap';
-
-export type ActionEventTypes =
-  | 'tap'
-  | 'longpress'
-  | 'longtap'
-  | 'change'
-  | 'confirm'
-  | 'blur'
-  | 'getphonenumber'
-  | 'contact'
-  | 'submit'
-  | 'getuserinfo';
-export interface EventTarget {
-  type: ActionEventTypes;
-  currentTarget: {
-    id: string;
-    dataset: {
-      index: number | string;
-      src: string;
-      title: string;
-      growingTrack: boolean;
-      growingtrack: boolean;
-      growingIgnore: boolean;
-    };
-  };
-  target: {
-    id: string;
-    dataset: {
-      index: number | string;
-      src: string;
-      title: string;
-      growingTrack: boolean;
-      growingtrack: boolean;
-      growingIgnore: boolean;
-    };
-  };
-  detail: any;
-  handler: string | undefined;
-  timeStamp: number | string;
-}
-
-export interface ShareQuery {
-  // 访问用户id
-  suid: string;
-  // 当前用户分享id
-  gioShareId: string;
-  // 之前用户分享id
-  gioPreShareId?: string;
-  // 内容类型
-  contentType?: string;
-  // 内容id
-  contentId?: string;
-
-  [K: string]: string;
-}
-
-export interface PageShareResult {
-  title: string;
-  path?: string;
-  query?: string;
-  imageUrl?: string;
-  contentType?: string;
-  contentId?: string;
-  attributes?: any;
-}
-
-export interface MinipPageType {
-  queryOptions: any;
-  configuredTitle: any;
-  pageProps: any;
-  lastLifecycle: string;
-  currentLifecycle: string;
-  lifeBeforeShow: boolean;
-  getPagePath: () => string;
-  getPageQuery: () => string;
-  getPageTitle: (trackingId?: string) => string;
-  getReferralPage: (trackingId: string) => string;
-  buildShareQuery: (result: PageShareResult) => [string, string];
-  updateShareResult: (
-    result: PageShareResult,
-    fillParams?: boolean
-  ) => PageShareResult;
-  eventSetPageProps: (trackingId: string, event: EVENT) => any;
-}
-
-export interface EventHooksType {
-  defAppCbs: any;
-  defPageCbs: any;
-  appHandlers: string[];
-  pageHandlers: string[];
-  actionEventTypes: string[];
-  appEffects: any;
-  pageEffects: any;
-  actionEffects: any;
-  currentPage: MinipPageType;
-  // 判断是否为非构造函数的一个函数
-  isNormalFc: (key: string, method: any) => any;
-  // 补充生命周期函数
-  supLifeFcs: (target: any, type: 'app' | 'page') => void;
-  // 对象的遍历
-  objectTraverse: (target: any, fn: any) => any;
-
-  // 生命周期方法effects
-  lifeFcEffects: (eventName: string, method: any, cType: 'App' | 'Page') => any;
-  // 自定义方法effects
-  customFcEffects: (eventName: string, method: any) => any;
-  // app逻辑执行代理
-  appApplyProxy: (eventName: string, method: any) => Function;
-  // Page事件执行代理
-  pageApplyProxy: (eventName: string, method: any) => Function;
-  // App重写(重写除构造函数之外的所有方法)
-  appOverriding: (options: any) => any;
-  // Page/Component/Behavior重写(重写除构造函数之外的所有方法，原生小程序使用)
-  pageOverriding: (options: any) => any;
-  // Component/Behavior重写(重写除构造函数之外的所有方法)
-  componentOverriding: (options: any) => any;
-  // 挂载App生命周期的effect方法
-  setAppEffectCbs: () => void;
-  // 挂载Page/Component生命周期的effect方法
-  setPageEffectCbs: () => void;
-  // App属性重写复用方法
-  growingApp: (app: any) => any;
-  // Page属性重写复用方法
-  growingPage: (page: any) => any;
-  // Component属性重写复用方法
-  growingComponent: (component: any) => any;
-  // Behavior属性重写复用方法
-  growingBehavior: (behavior: any) => any;
-  // 对原生的重写方法
-  nativeGrowing: (designated?: string[]) => void;
-  // 初始化原始值
-  initOriginalValue: () => void;
-  // 初始化事件钩子
-  initEventHooks: () => void;
-}

package/src/types/gioCustomTracking.ts

@@ -1,9 +0,0 @@
-export interface GioCustomTrackingType {
-  // 构建自定义埋点事件
-  buildCustomEvent: (
-    name: string,
-    properties: { [key: string]: string }
-  ) => void;
-  // 构建用户变量事件
-  buildUserAttributesEvent?: (attributes: { [key: string]: string }) => void;
-}

package/src/types/gioEventTracking.ts

@@ -1,10 +0,0 @@
-import { EventTarget } from './base';
-
-export default interface GioEventAutoTrackingType {
-  main: (event: EventTarget, eventName: string) => void;
-  getNodeXpath: (e: EventTarget, eventName: string) => string;
-  buildClickEvent: (e: EventTarget, eventName: string) => void;
-  buildTabClickEvent: (tabItem: any) => void;
-  buildChangeEvent: (e: EventTarget, eventName: string) => void;
-  buildSubmitEvent: (e: EventTarget, eventName: string) => void;
-}

package/src/types/gioPerformance.ts

@@ -1,8 +0,0 @@
-export interface PERF_MONITOR_VLUES {
-  title: string;
-  page_launch_duration?: number | string;
-  first_contentful_paint_duration?: number;
-  largest_contentful_paint_duration?: number;
-  reboot_duration?: number;
-  reboot_mode?: 'warm' | 'cold';
-}

package/src/types/growingIO.ts

@@ -1,137 +0,0 @@
-import { DataStoreType, OriginOptions } from '@@/types/dataStore';
-import { MinipInstanceType } from '@@/types/minipInstance';
-import { FRAMEWORKS, PLATFORMTYPES } from '@@/types/platforms';
-import { PluginsType } from '@@/types/plugins';
-import { UploaderType } from '@@/types/uploader';
-import { UserStoreType } from '@@/types/userStore';
-
-export interface GrowingIOType {
-  // 工具类
-  utils?: any;
-  // 监听器
-  emitter: {
-    emit?: (msg: string, args?: any) => void;
-    on?: (msg: string, method: (args?: any) => any) => void;
-    once?: (msg: string, method: (args?: any) => any) => void;
-    off?: (msg: string, method: (args?: any) => any) => void;
-  };
-  // 小程序平台
-  gioPlatform: PLATFORMTYPES;
-  // 标记当前小程序是什么框架
-  gioFramework: FRAMEWORKS;
-  // sdk版本号
-  sdkVersion: string;
-  // 是否在小程序插件中标识
-  inPlugin: boolean;
-  // 分包在全局中的实例key值
-  subKey?: string;
-  // 小程序实例配置
-  platformConfig: any;
-  // sdk初始化标识
-  gioSDKInitialized: boolean;
-  // 所有配置项
-  vdsConfig: OriginOptions;
-  // 小程序实例
-  minipInstance: MinipInstanceType;
-  // 用户管理实例
-  userStore: UserStoreType;
-  // 数据管理实例
-  dataStore: DataStoreType;
-  // 插件管理实例
-  plugins: PluginsType;
-  // 上传组件实例
-  uploader: UploaderType;
-  // 无埋点插件实例
-  eventTracking?: any;
-  // 埋点插件实例
-  customTracking?: any;
-  // taro3中存储完整的页面节点信息
-  taro3VMs?: any;
-  // 分享数据
-  shareAppMessage?: any;
-  // 用于放在事件中区别于为其他功能而生成事件的跟踪器Id，默认为g0
-  trackingId: string;
-  // 存储子实例的配置和信息
-  subInstance: {
-    [key: string]: OriginOptions;
-  };
-  // 初始化方法
-  init: (args: any) => void;
-  // 注册插件
-  registerPlugins?: (path?: string) => void;
-  // 运行中修改配置
-  setOption: (trackingId: string, optionKey: string, value: any) => void;
-  // 运行中获取配置
-  getOption: (trackingId: string, optionKey?: string) => any;
-  // 设置页面属性
-  setPageAttributes: (trackingId: string, properties: any) => void;
-  // 清空已设置的页面属性
-  clearPageAttributes: (
-    trackingId: string,
-    properties: string[] | undefined
-  ) => void;
-  // 手动发page
-  sendPage: (trackingId: string, props?: any) => void;
-  // 设置openId作为uid
-  identify?: (trackingId: string, openId: string) => void;
-  // 发送用户变量
-  setUserAttributes?: (trackingId: string, userAttributes: any) => void;
-  // 设置登录用户Id
-  setUserId?: (trackingId: string, userId: string, userKey?: string) => void;
-  // 清除登录用户Id
-  clearUserId?: (trackingId: string) => void;
-  // 设置全局通用属性
-  setGeneralProps?: (trackingId: string, properties: any) => void;
-  // 清除已设置的全局通用属性
-  clearGeneralProps?: (
-    trackingId: string,
-    properties: string[] | undefined
-  ) => void;
-  // 创建自定义埋点事件
-  track?: (
-    trackingId: string,
-    name: string,
-    properties: { [key: string]: string },
-    items?: { key: string; id: string; attributes?: { [key: string]: string } }
-  ) => void;
-  // 初始化事件计时器
-  trackTimerStart: (trackingId: string, eventName: string) => any;
-  // 暂停事件计时器
-  trackTimerPause: (trackingId: string, timerId: string) => boolean;
-  // 恢复事件计时器
-  trackTimerResume: (trackingId: string, timerId: string) => boolean;
-  // 停止事件计时器并上报事件
-  trackTimerEnd: (
-    trackingId: string,
-    timerId: string,
-    properties: any
-  ) => boolean;
-  // 移除事件计时器
-  removeTimer: (trackingId: string, timerId: string) => boolean;
-  // 清除所有事件计时器
-  clearTrackTimer: (trackingId: string) => void;
-  // 手动获取位置信息补发visit上报
-  setLocation: (
-    trackingId: string,
-    latitude: number,
-    longitude: number
-  ) => void;
-  // 手动更新曝光监听
-  updateImpression?: (collect?: any) => void;
-  // 获取ABTest数据
-  getABTest?: (
-    trackingId: string,
-    layerId: string,
-    callback?: (arg: any) => any
-  ) => void;
-  // 获取打通信息
-  getGioInfo: (trackingId: string) => string;
-  // 初始化回调
-  initCallback?: () => void;
-  // 错误提示
-  callError?: (fn: string, type?: boolean, msg?: string) => void;
-  GioApp?: any;
-  GioPage?: any;
-  GioComponent?: any;
-  GioBehavior?: any;
-}