gio-miniprogram-sdk 4.1.0 → 4.3.0

package/src/minipInstance/base.ts

@@ -7,7 +7,14 @@ import {
   SystemInfo
 } from '@@/types/minipInstance';
 import { PLATFORMS } from '@@/types/platforms';
-import { isFunction, isObject, isString, last } from '@@/utils/glodash';
+import {
+  isFunction,
+  isObject,
+  isString,
+  last,
+  typeOf,
+  isEmpty
+} from '@@/utils/glodash';
 import EMIT_MSG from '@@/constants/emitMsg';
 import {
   limitString,
@@ -126,38 +133,58 @@ class BaseInstance implements MinipInstanceType {
 
   // 获取页面标题
   getPageTitle = (page) => {
+    const platform = getPlainPlatform();
     let title = '';
-    const instConfig = getPlainConfig(getPlainPlatform());
-    try {
-      // 第一优先级在base中的hook setNavigationBarTitle设置的值
-      // 第二优先级支持客户自己在页面中设置页面title
-      const data = page?.data || page.$data || {};
-      title = isString(data?.gioPageTitle) ? data?.gioPageTitle : '';
-      // 第三优先级取页面的navigationBarTitleText
-      if (title.length === 0) {
-        const pageInfo =
-          instConfig.page[page.route] || instConfig.page[`${page.route}.html`];
-        if (pageInfo) {
-          title = pageInfo.window.navigationBarTitleText;
-        } else {
-          title = instConfig.global.window.navigationBarTitleText;
-        }
+    let instConfig = getPlainConfig(platform);
+    if (typeOf(instConfig) === 'string') {
+      instConfig = niceTry(() => JSON.parse(instConfig)) ?? {};
+    }
+    // 第一优先级在base中的hook setNavigationBarTitle设置的值(在dataStore page实例中实现)
+    // 第二优先级支持客户自己在页面中设置页面title
+    const data = page?.data || page.$data || {};
+    title = isString(data?.gioPageTitle) ? data?.gioPageTitle : '';
+    if (instConfig) {
+      // 第三优先级app生命周期中拿不到page对象，拿生命周期的参数来匹配
+      const { enterParams } = this.growingIO.dataStore.eventHooks.appEffects;
+      if (!page.route && !isEmpty(enterParams)) {
+        page.route = enterParams.path || '';
+        title = this._getTitleFromTabbar(instConfig, page.route);
       }
-      // 第四优先级取tabBar配置
-      if (title.length === 0) {
-        const tabPage = instConfig?.tabBar?.list?.find((p) => {
-          return (
-            p.pagePath === page.route || p.pagePath === `${page.route}.html`
-          );
-        });
-        title = tabPage?.text || '';
+      // 第四优先级取页面的navigationBarTitleText
+      niceTry(() => {
+        if (!title) {
+          const instPage = instConfig.page || {};
+          const pageInfo =
+            instPage[page.route] || instPage[`${page.route}.html`];
+          if (pageInfo) {
+            title = pageInfo?.window?.navigationBarTitleText;
+          } else if (['wx', 'tt'].includes(platform)) {
+            title = (instConfig || global || $global)?.global?.window
+              ?.navigationBarTitleText;
+          } else {
+            title = (instConfig || global || $global)?.window
+              ?.navigationBarTitleText;
+          }
+        }
+      });
+      // 第五优先级取tabBar配置
+      if (!title) {
+        title = this._getTitleFromTabbar(instConfig, page.route);
       }
-    } catch (e) {
-      return '';
     }
     return limitString(title);
   };
 
+  private _getTitleFromTabbar = (
+    instConfig: any,
+    pageRoute: string
+  ): string => {
+    const tabPage = instConfig?.tabBar?.list?.find((p) => {
+      return p.pagePath === pageRoute || p.pagePath === `${pageRoute}.html`;
+    });
+    return tabPage?.text || '';
+  };
+
   /**
    * 存储相关
    */

package/src/minipInstance/my.ts

@@ -48,6 +48,11 @@ class Alipay extends BaseImplements {
   setStorageSync = (key: string, value: any) => {
     this.minip?.setStorageSync({ key, data: value });
   };
+
+  // 同步移除指定数据
+  removeStorageSync = (key: string) => {
+    this.minip?.removeStorageSync({ key });
+  };
 }
 
 export default Alipay;

package/src/minipInstance/tb.ts

@@ -48,6 +48,11 @@ class Taobao extends BaseImplements {
   setStorageSync = (key: string, value: any) => {
     this.minip?.setStorageSync({ key, data: value });
   };
+
+  // 同步移除指定数据
+  removeStorageSync = (key: string) => {
+    this.minip?.removeStorageSync({ key });
+  };
 }
 
 export default Taobao;

package/src/platformConfig/base.ts

@@ -1,5 +1,4 @@
 import { PlatformConfigType } from '@@/types/platforms';
-import { niceTry } from '@@/utils/tools';
 
 const Config: PlatformConfigType = {
   scnPrefix: '',

package/src/plugins/gioABTest.ts

@@ -13,11 +13,17 @@ import {
   startsWith,
   toString
 } from '@@/utils/glodash';
-import { consoleText, hashCode, niceCallback } from '@@/utils/tools';
+import {
+  consoleText,
+  hashCode,
+  limitObject,
+  niceCallback
+} from '@@/utils/tools';
 import EMIT_MSG from '@@/constants/emitMsg';
 import { ABTEST_DATA_REG, ABTEST_SIGN_REG } from '@@/constants/regex';
 
 class GioABTest {
+  public pluginVersion: string;
   // 请求间隔时长
   public requestInterval: number;
   // 请求超时时长
@@ -27,6 +33,7 @@ class GioABTest {
   // 接口重试计数
   public retryCount: number;
   constructor(public growingIO: GrowingIOType, options: any) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     const {
       abServerUrl = 'https://ab.growingio.com',
       requestInterval,
@@ -276,14 +283,14 @@ class GioABTest {
     let event = {
       eventType: 'CUSTOM',
       eventName: '$exp_hit',
-      attributes: {
-        $exp_layer_id: layerId,
-        $exp_id: experimentId,
-        $exp_strategy_id: strategyId
-      },
-      ...eventContextBuilder(trackingId),
-      customEventType: 0
+      ...eventContextBuilder(trackingId)
     };
+    event.attributes = limitObject({
+      ...(event.attributes ?? {}),
+      $exp_layer_id: layerId,
+      $exp_id: experimentId,
+      $exp_strategy_id: strategyId
+    });
     eventConverter(event);
   };
 }

package/src/plugins/gioCompress.ts

@@ -5,9 +5,11 @@
 import { GrowingIOType } from '@@/types/growingIO';
 
 class GioCompress {
+  public pluginVersion: string;
   private f;
   private _compress;
   constructor(public growingIO: GrowingIOType) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     this.f = String.fromCharCode;
     this._compress = function (uncompressed, bitsPerChar, getCharFromInt) {
       if (uncompressed === null) return '';

package/src/plugins/gioEventAutoTracking.ts

@@ -10,8 +10,10 @@ import EMIT_MSG from '@@/constants/emitMsg';
 
 let ut;
 class GioEventAutoTracking {
+  public pluginVersion: string;
   private prevEvent: any;
   constructor(public growingIO: GrowingIOType) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     ut = this.growingIO.utils;
     this.prevEvent = {};
   }
@@ -88,7 +90,7 @@ class GioEventAutoTracking {
     const xpath = this.getNodeXpath(e, eventName);
     if (xpath) {
       const {
-        dataStore: { eventContextBuilder, eventInterceptor }
+        dataStore: { eventContextBuilder, eventInterceptor, eventHooks }
       } = this.growingIO;
       const target = e.currentTarget || e.target;
       let idx;
@@ -115,6 +117,11 @@ class GioEventAutoTracking {
         ],
         ...eventContextBuilder(trackingId)
       };
+      // 合并页面属性
+      event.attributes = eventHooks.currentPage.eventSetPageProps(
+        trackingId,
+        event
+      );
       eventInterceptor(event);
     }
   };
@@ -122,7 +129,7 @@ class GioEventAutoTracking {
   // 构建tab菜单点击事件
   buildTabClickEvent = (trackingId: string, tabItem: any) => {
     const {
-      dataStore: { eventContextBuilder, eventInterceptor }
+      dataStore: { eventContextBuilder, eventInterceptor, eventHooks }
     } = this.growingIO;
     const event = {
       eventType: 'VIEW_CLICK',
@@ -136,6 +143,11 @@ class GioEventAutoTracking {
       ],
       ...eventContextBuilder(trackingId)
     };
+    // 合并页面属性
+    event.attributes = eventHooks.currentPage.eventSetPageProps(
+      trackingId,
+      event
+    );
     eventInterceptor(event);
   };
 
@@ -148,7 +160,7 @@ class GioEventAutoTracking {
     const xpath = this.getNodeXpath(e, eventName);
     if (xpath) {
       const {
-        dataStore: { eventContextBuilder, eventInterceptor }
+        dataStore: { eventContextBuilder, eventInterceptor, eventHooks }
       } = this.growingIO;
       const target = e.currentTarget || e.target;
       const event = {
@@ -163,6 +175,11 @@ class GioEventAutoTracking {
         }
       }
       event.element = [event.element];
+      // 合并页面属性
+      event.attributes = eventHooks.currentPage.eventSetPageProps(
+        trackingId,
+        event
+      );
       eventInterceptor(event);
     }
   };

package/src/plugins/gioImpressionTracking.ts

@@ -9,14 +9,21 @@ import {
   isArray,
   isEmpty,
   isEqualArray,
+  isObject,
   isString,
   toString
 } from '@@/utils/glodash';
-import { eventNameValidate, hashCode, niceTry } from '@@/utils/tools';
+import {
+  eventNameValidate,
+  hashCode,
+  limitObject,
+  niceTry
+} from '@@/utils/tools';
 import EMIT_MSG from '@@/constants/emitMsg';
 
 let ut;
 class GioImpressionTracking {
+  public pluginVersion: string;
   public observerIds: any;
   public rects: any;
   public pageImpObserver: any;
@@ -25,6 +32,7 @@ class GioImpressionTracking {
   public componentQueryTarget: any;
   public sentImps: any;
   constructor(public growingIO: GrowingIOType) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     ut = this.growingIO.utils;
     this.observerIds = {};
     this.rects = {};
@@ -353,9 +361,12 @@ class GioImpressionTracking {
     const event = {
       eventType: 'CUSTOM',
       eventName,
-      attributes: properties,
       ...eventContextBuilder(trackingId)
     };
+    event.attributes = limitObject({
+      ...(event.attributes ?? {}),
+      ...(isObject(properties) && !isEmpty(properties) ? properties : {})
+    });
     if (plugins.gioMultipleInstances && !isEmpty(sendTargets)) {
       event['&&sendTo'] = sendTargets;
     }

package/src/plugins/gioMultipleInstances.ts

@@ -11,8 +11,10 @@ import { OriginOptions } from '@@/types/dataStore';
 import EMIT_MSG from '@@/constants/emitMsg';
 
 export class GioMultipleInstances {
+  public pluginVersion: string;
   public subTrackingIds: string[];
   constructor(public growingIO: GrowingIOType) {
+    this.pluginVersion = '__PLUGIN_VERSION__';
     this.subTrackingIds = [];
     this.growingIO.emitter.on(EMIT_MSG.ON_SDK_INITIALIZE_BEFORE, () => {
       // 自动重写部分代码以实现多实例功能
@@ -153,10 +155,19 @@ export class GioMultipleInstances {
         unset(event, '&&sendTo');
         sendTo.forEach((trackingId: string) => {
           const { eventContextBuilder } = self.growingIO.dataStore;
-          originFunction.call(this, {
+          const newEvent = {
             ...event,
-            ...eventContextBuilder(trackingId)
-          });
+            ...eventContextBuilder(
+              trackingId,
+              undefined,
+              event.trackingId !== trackingId
+            )
+          };
+          newEvent.attributes = {
+            ...newEvent.attributes,
+            ...event.attributes
+          };
+          originFunction.call(this, newEvent);
         });
       } else {
         // 其他事件直接发给指定调用实例

package/src/types/dataStore.ts

@@ -22,7 +22,11 @@ export interface DataStoreType {
   buildAppMessageEvent: (trackingId: string, args: any) => void;
   buildTimelineEvent: (trackingId: string, args: any) => void;
   // 事件通用维度组装
-  eventContextBuilder?: (trackingId: string, params?: any) => any;
+  eventContextBuilder?: (
+    trackingId: string,
+    params?: any,
+    executeAttributes?: boolean
+  ) => any;
   eventConverter?: (event) => void;
   eventHooks: EventHooksType;
   eventInterceptor?: (event: any | void) => void;

package/src/types/eventHooks.ts

@@ -1,3 +1,5 @@
+import { EVENT } from './base';
+
 export type AppHookLifeCircle = 'onShow' | 'onHide' | 'onError';
 export type PageHookLifeCircle =
   | 'onShow'
@@ -74,21 +76,21 @@ export interface PageShareResult {
 }
 
 export interface MinipPageType {
-  path: string;
-  time: number;
-  query: any;
+  queryOption: any;
   settedTitle: any;
-  title: string;
   pageProps: any;
   lastLifecycle: string;
   currentLifecycle: string;
-  parsePage: (page: any, query: any) => void;
-  getQuery: (query: any) => string;
+  getPagePath: () => string;
+  getPageQeury: () => string;
+  getPageTitle: (trackingId?: string) => string;
+  qsQuery: (query: any) => string;
   getReferralPage: (trackingId: string) => string;
   buildShareQuery: (result: PageShareResult) => [string, string];
   updateAppMessageResult: (result: PageShareResult) => PageShareResult;
   updateTimelineResult: (result: PageShareResult) => PageShareResult;
   updateAddFavoritesResult: (result: PageShareResult) => PageShareResult;
+  eventSetPageProps: (trackingId: string, event: EVENT) => any;
 }
 
 export interface EventHooksType {
@@ -107,8 +109,7 @@ export interface EventHooksType {
   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
@@ -137,4 +138,8 @@ export interface EventHooksType {
   growingBehavior: (behavior: any) => any;
   // 对原生的重写方法
   nativeGrowing: (designated?: string[]) => void;
+  // 初始化原始值
+  initOriginalValue: () => void;
+  // 初始化事件钩子
+  initEventHooks: () => void;
 }

package/src/types/growingIO.ts

@@ -6,6 +6,15 @@ 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;
   // 标记当前小程序是什么框架
@@ -54,63 +63,73 @@ export interface GrowingIOType {
   setOption: (trackingId: string, optionKey: string, value: any) => void;
   // 运行中获取配置
   getOption: (trackingId: string, optionKey?: string) => any;
-  // 创建自定义埋点事件
-  track?: (
+  // 设置页面属性
+  setPageAttributes: (trackingId: string, properties: any) => void;
+  // 清空已设置的页面属性
+  clearPageAttributes: (
     trackingId: string,
-    name: string,
-    properties: { [key: string]: string },
-    items?: { key: string; id: string; attributes?: { [key: string]: string } }
+    properties: string[] | undefined
   ) => void;
-  // 设置登录用户Id
-  setUserId?: (trackingId: string, userId: string, userKey?: string) => void;
-  // 清除登录用户Id
-  clearUserId?: (trackingId: string) => void;
+  // 手动发page
+  sendPage: (trackingId: string, props?: any) => void;
   // 设置openId作为uid
   identify?: (trackingId: string, openId: string) => void;
   // 发送用户变量
   setUserAttributes?: (trackingId: string, userAttributes: any) => void;
-  // 初始化回调
-  initCallback?: () => void;
-  // 错误提示
-  callError?: (fn: string, type?: boolean, msg?: string) => void;
-  // 工具类
-  utils?: any;
-  // 事件转换
-  eventConverter?: (event: any) => void;
-  // 事件拦截器
-  eventInterceptor?: (event: 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;
-  // 手动更新曝光监听
-  updateImpression?: (collect?: any) => 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;
+  clearTrackTimer: (trackingId: string) => void;
   // 手动获取位置信息补发visit上报
   setLocation: (
     trackingId: string,
     latitude: number,
     longitude: number
   ) => void;
-  // 获取打通信息
-  getGioInfo: (trackingId: string) => string;
+  // 手动更新曝光监听
+  updateImpression?: (collect?: any) => void;
   // 获取ABTest数据
   getABTest?: (
     trackingId: string,
     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;
-  };
+  // 获取打通信息
+  getGioInfo: (trackingId: string) => string;
+  // 初始化回调
+  initCallback?: () => void;
+  // 错误提示
+  callError?: (fn: string, type?: boolean, msg?: string) => void;
   GioApp?: any;
   GioPage?: any;
   GioComponent?: any;

package/src/utils/tools.ts

@@ -3,8 +3,10 @@ import {
   compact,
   find,
   forEach,
+  formatDate,
   head,
   isArray,
+  isDate,
   isEmpty,
   isFunction,
   isNil,
@@ -14,6 +16,7 @@ import {
   split,
   startsWith,
   toString,
+  typeOf,
   unset
 } from '@@/utils/glodash';
 
@@ -237,11 +240,15 @@ export const getPlainConfig = (platform?: string) => {
       case 'swan':
         return appConfig;
       case 'tt':
-        return __ttConfig;
+        return (
+          niceTry(() => __ttConfig) ||
+          global?.TMAConfig ||
+          globalThis?.TMAConfig
+        ); // 可能会拿不到
       case 'qq':
         return __qqConfig;
       case 'ks':
-        return __ksConfig;
+        return __ksConfig; // 新版快手小程序已经拿不到了
       case 'jd':
         return __jdConfig;
       // 第三方框架下自动获取实例
@@ -294,7 +301,10 @@ export const getAppInst = () => {
 };
 
 export const getGlobal = () => {
-  return niceTry(() => $global) ?? global;
+  return (
+    niceTry(() => niceTry(() => niceTry(() => $global) ?? global) ?? window) ??
+    globalThis
+  );
 };
 
 // Object参数限制
@@ -310,6 +320,8 @@ export const limitObject = (o: any) => {
       } else if (isArray(v)) {
         ob[key] = compact(v.slice(0, 100), true);
         ob[key] = ob[key].join('||').slice(0, 1000);
+      } else if (isDate(v)) {
+        ob[key] = formatDate(v);
       } else {
         ob[key] = !isNil(v) ? toString(v).slice(0, 1000) : '';
       }
@@ -403,3 +415,14 @@ export const hashCode = (string: string, abs = false) => {
   }
   return abs ? Math.abs(hash) : hash;
 };
+
+// 获取额外的启动参数并合并进query
+export const getLaunchQuery = (originQuery: any = {}, extraData: any = {}) => {
+  const validData = {};
+  keys(extraData).forEach((k: string) => {
+    if (['string', 'number', 'boolean'].includes(typeOf(extraData[k]))) {
+      validData[k] = extraData[k];
+    }
+  });
+  return Object.assign({}, validData, originQuery);
+};