gio-miniprogram-sdk 4.0.0

package/src/types/eventHooks.ts

@@ -0,0 +1,141 @@
+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 {
+  path: string;
+  time: number;
+  query: any;
+  settedTitle: any;
+  title: string;
+  pageProps: any;
+  lastLifecycle: string;
+  currentLifecycle: string;
+  parsePage: (page: any, query: any) => void;
+  getQuery: (query: any) => string;
+  getReferralPage: () => string;
+  saveShareId: (query: string) => void;
+  buildShareQuery: (result: PageShareResult) => [string, string];
+  updateAppMessageResult: (result: PageShareResult) => PageShareResult;
+  updateTimelineResult: (result: PageShareResult) => PageShareResult;
+  updateAddFavoritesResult: (result: PageShareResult) => PageShareResult;
+}
+
+export interface EventHooksType {
+  defAppCbs: any;
+  defPageCbs: any;
+  appHandlers: string[];
+  pageHandlers: string[];
+  actionEventTypes: string[];
+  originalApp: (any: any) => any;
+  originalPage: (any: any) => any;
+  originalComponent: (any: any) => any;
+  originalBehavior: (any: any) => any;
+  appEffects: (app: any, event: AppHookLifeCircle, args: any) => void;
+  pageEffects: (page: any, event: PageHookLifeCircle, args: any) => void;
+  actionEffects: (event: EventTarget, method: string) => void;
+  currentPage: MinipPageType;
+  // 判断是否为非构造函数的一个函数
+  isNormalFc: (key: string, method: any) => any;
+  // 补充生命周期函数
+  supLifeFcs: (target: any, type: 'app' | 'page') => void;
+  // 对象的遍历
+  objectTraverse: (target: any, fn: any) => any;
+  // 初始化无埋点
+  initEventHooks: () => void;
+  // 生命周期方法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属性重写复用方法
+  growingApp: (app: any) => any;
+  // Page属性重写复用方法
+  growingPage: (page: any) => any;
+  // Component属性重写复用方法
+  growingComponent: (component: any) => any;
+  // Behavior属性重写复用方法
+  growingBehavior: (behavior: any) => any;
+  // 对原生的重写方法
+  nativeGrowing: (designated?: string[]) => void;
+}

package/src/types/gioCustomTracking.ts

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

package/src/types/gioEventTracking.ts

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,102 @@
+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 {
+  // 小程序平台
+  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;
+  // 初始化方法
+  init: (args: any) => void;
+  // 注册插件
+  registerPlugins?: (path?: string) => void;
+  // 运行中修改配置
+  setOption: (optionKey: string, value: any) => void;
+  // 运行中获取配置
+  getOption: (optionKey?: string) => any;
+  // 创建自定义埋点事件
+  track?: (
+    name: string,
+    properties: { [key: string]: string },
+    items?: { key: string; id: string; attributes?: { [key: string]: string } }
+  ) => void;
+  // 设置登录用户Id
+  setUserId?: (userId: string, userKey?: string) => void;
+  // 清除登录用户Id
+  clearUserId?: () => void;
+  // 设置openId作为uid
+  identify?: (openId: string) => void;
+  // 发送用户变量
+  setUserAttributes?: (userAttributes: any) => void;
+  // 初始化回调
+  initCallback?: () => void;
+  // 错误提示
+  callError?: (fn: string, type?: boolean, msg?: string) => void;
+  // 工具类
+  utils?: any;
+  // 事件通用维度组装
+  eventContextBuilder?: (updateTime?: boolean) => any;
+  // 事件转换
+  eventConverter?: (event: any) => void;
+  // 事件拦截器
+  eventInterceptor?: (event: any) => void;
+  // 设置埋点通用属性
+  setGeneralProps?: (properties: any) => void;
+  // 清除已设置的埋点通用属性
+  clearGeneralProps?: (properties: string[] | undefined) => void;
+  // 手动更新曝光监听
+  updateImpression?: (collect?: any) => void;
+  // 清除所有事件计时器
+  clearTrackTimer?: () => void;
+  // 手动获取位置信息补发visit上报
+  setLocation: (latitude: number, longitude: number) => void;
+  // 获取打通信息
+  getGioInfo: () => string;
+  // 获取ABTest数据
+  getABTest?: (layerId: string, callback?: (arg: any) => any) => void;
+
+  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;
+  };
+  GioApp?: any;
+  GioPage?: any;
+  GioComponent?: any;
+  GioBehavior?: any;
+}

package/src/types/minipInstance.ts

@@ -0,0 +1,126 @@
+import { PLATFORMS } from './platforms';
+
+export interface NavigateToMiniProgramOption {
+  appId: string;
+  path?: string;
+  extraData?: any;
+  envVersion?: any;
+  success: (res: any) => void;
+  fail: (err: any) => void;
+  complete: () => void;
+}
+
+export interface AppSource {
+  extra: any;
+  packageName: string;
+  type: string;
+}
+
+export interface UserInfo {
+  nickname: string;
+  avatarUrl: string;
+  gender: number;
+  province: string;
+  city: string;
+  country: string;
+}
+export interface SystemInfo {
+  // 设备品牌
+  brand: string;
+  // 设备型号
+  model: string;
+  // 设备像素比
+  pixelRatio: number;
+  // 屏幕宽度，单位px
+  screenWidth: number;
+  // 屏幕高度，单位px
+  screenHeight: number;
+  // 语言
+  language: string;
+  // 平台容器版本号
+  version: string;
+  // 操作系统及版本
+  system: string;
+  // 客户端基础库版本
+  SDKVersion: string;
+  // 客户端平台
+  platform: string;
+}
+export interface Location {
+  // 纬度，范围为 -90~90，负数表示南纬
+  latitude: number;
+  // 经度，范围为 -180~180，负数表示西经
+  longitude: number;
+}
+
+export interface MinipInstanceType {
+  // 小程序原生对象 wx/my/tt/swan/qq/ks
+  readonly minip: any;
+  // 当前平台
+  platform: PLATFORMS;
+  // 场景值前缀
+  scnPrefix: string;
+  // 地理位置
+  location: Location;
+  // 快应用来源
+  appSource: AppSource;
+  // 系统信息
+  systemInfo: any;
+  // 网络信息
+  network: any;
+  // hook动态设置页面标题方法
+  hookSetTitle: () => void;
+  // 获取快应用来源信息
+  getAppSource?: () => AppSource;
+  // 保留当前页面，跳转到应用内的某个页面
+  navigateTo?: (opt: any) => void;
+  // 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
+  switchTab?: (opt: any) => void;
+  // 打开另一个小程序
+  navigateToMiniProgram?: (opt: NavigateToMiniProgramOption) => void;
+  // 获取图片信息
+  getImageInfo: (args: any) => any;
+  // 采集曝光事件
+  initImpression?: (collectPage: any) => void;
+  // 获取快应用分享信息
+  initShareAppMessage?: (growingio: any) => void;
+  // 获取当前页面栈
+  getCurrentPage: () => any;
+  // 获取当前页面路由
+  getCurrentPath: (page?: any) => string;
+  // 获取页面标题
+  getPageTitle: (page: any) => string;
+  // 同步获取存储数据
+  getStorageSync: (key: string) => any;
+  // 异步获取存储数据
+  getStorage: (key: string) => Promise<string>;
+  // 同步存储数据
+  setStorageSync: (
+    key: string,
+    value: any,
+    expiredAt?: string | number
+  ) => void;
+  // 异步存储数据
+  setStorage: (key: string, value: any) => void;
+  // 同步移除指定数据
+  removeStorageSync: (key: string) => void;
+  // 异步移除指定数据
+  removeStorage: (key: string) => void;
+  // 获取网络类型
+  getNetworkType: () => Promise<{ networkType: string }>;
+  // 网络请求
+  request: ({
+    url,
+    data,
+    header,
+    timeout,
+    method,
+    fail,
+    success,
+    complete
+  }: any) => void;
+  // 获取小程序系统信息
+  getSystemInfo?: () => Promise<SystemInfo>;
+  // 获取小程序设置
+  getSetting?: () => any;
+}

package/src/types/platforms.ts

@@ -0,0 +1,65 @@
+export type PLATFORMS =
+  | 'MinP'
+  | 'alip'
+  | 'tbp'
+  | 'baidup'
+  | 'qq'
+  | 'bytedance'
+  | 'kuaishoup'
+  | 'jdp'
+  | 'quickapp';
+export type PLATFORMTYPES =
+  | 'wx'
+  | 'my'
+  | 'tb'
+  | 'swan'
+  | 'qq'
+  | 'tt'
+  | 'ks'
+  | 'jd'
+  | 'quickapp';
+
+export type FRAMEWORKS = 'taro' | 'uniapp' | 'full';
+
+export interface PlatformConfigType {
+  name?: string;
+  platform?: PLATFORMS;
+  scnPrefix?: string;
+  appHandlers?: string[];
+  pageHandlers?: string[];
+  actionEventTypes?: string[];
+  originalPage?: (any) => any;
+  originalApp?: (any) => any;
+  originalComponent?: (any) => any;
+  originalBehavior?: (any) => any;
+  hooks?: {
+    App: boolean;
+    Page: boolean;
+    Component: boolean;
+    Behavior: boolean;
+  };
+  canHook: boolean;
+  listeners?: {
+    app: {
+      appLaunch: string;
+      appShow: string;
+      appClose: string;
+    };
+    page: {
+      pageLoad: string;
+      pageShow: string;
+      pageReady: string;
+      pageHide: string;
+      pageUnload: string;
+      tabTap: string;
+      shareApp: string;
+      shareTime?: string;
+      addFavorites?: string;
+    };
+    actions: {
+      click: string[];
+      change: string[];
+      submit: string[];
+    };
+  };
+}

package/src/types/plugins.ts

@@ -0,0 +1,24 @@
+export interface PluginItem {
+  name: string;
+  method: (growingIO) => void;
+  options?: any;
+}
+
+export interface PluginsType {
+  gioCompress?: any;
+  gioCustomTracking?: any;
+  gioEventAutoTracking?: any;
+  gioImpressionTracking?: any;
+  gioMultiIntegrate?: any;
+  gioPerformance?: any;
+  gioTaobaoAdapter?: any;
+  gioTaroAdapter?: any;
+  gioUniAppAdapter?: any;
+  innerPluginInit: () => void;
+  outerPluginInit?: (folder?: string) => void;
+  install: (pluginName: string, showLog: boolean) => boolean;
+  installAll: (plugins: PluginItem[]) => void;
+  pluginItems: PluginItem[];
+  uninstall: (pluginName: string) => boolean;
+  uninstallAll: () => void;
+}

package/src/types/uploader.ts

@@ -0,0 +1,26 @@
+export interface UploaderType {
+  // 因forceLogin配置积压的事件请求队列
+  hoardingQueue: any[];
+  // 请求队列
+  requestQueue: any[];
+  // 请求限制最大数
+  requestLimit: number;
+  // 请求超时时间(ms)
+  requestTimeout: number;
+  // 请求重试限制最大数
+  retryLimit: number;
+  // 请求重试的原请求id
+  retryIds: any;
+  // 请求中的请求数
+  requestingNum: number;
+  // 请求地址
+  requestURL: string;
+  // 提交请求至队列
+  commitRequest: (reqData) => void;
+  // 发送请求
+  initiateRequest: (forceSend?: boolean) => void;
+  // 请求错误回调
+  requestFailFn: (data) => void;
+  // 更新/生成新的上报地址方法
+  generateURL?: () => void;
+}

package/src/types/userStore.ts

@@ -0,0 +1,22 @@
+export interface UserStoreType {
+  // 访问用户id在存储中的名称
+  uidStorageName: string;
+  // 登录用户id在存储中的名称
+  userIdStorageName: string;
+  // 最后一次登录用户id在存储中的名称
+  gioIdStorageName: string;
+  // 用户访问会话id
+  sessionId: string;
+  // 访问用户id（系统设置持久性存储）
+  uid: string;
+  // 登录用户id（客户设置持久性存储）
+  userId: string;
+  // idMapping userKey（客户设置持久性存储）
+  userKey: string;
+  // 最后一次登录用户id（持久性存储）
+  gioId: string;
+  // 初始化用户信息
+  initUserInfo: () => void;
+  // 退出小程序时在存储中同步用户信息
+  saveUserInfo: () => void;
+}