gio-miniprogram-sdk 4.3.2 → 4.4.1

package/src/minipInstance/base.ts

@@ -13,7 +13,8 @@ import {
   isString,
   last,
   typeOf,
-  isEmpty
+  isEmpty,
+  isArray
 } from '@@/utils/glodash';
 import EMIT_MSG from '@@/constants/emitMsg';
 import {
@@ -21,7 +22,8 @@ import {
   niceTry,
   getPlainMinip,
   getPlainPlatform,
-  getPlainConfig
+  getPlainConfig,
+  getPlainAppCode
 } from '@@/utils/tools';
 
 // 此基础实现类仅包含所有小程序，快应用所有方法全部单独实现
@@ -139,39 +141,67 @@ class BaseInstance implements MinipInstanceType {
     if (typeOf(instConfig) === 'string') {
       instConfig = niceTry(() => JSON.parse(instConfig)) ?? {};
     }
-    // 第一优先级在base中的hook setNavigationBarTitle设置的值(在dataStore page实例中实现)
-    // 第二优先级支持客户自己在页面中设置页面title
+    // 第一优先级在base中的hook setNavigationBarTitle设置的值(在dataStore page实例中实现，准确率最高)
+    // 第二优先级支持客户自己在页面中设置页面title（保持3.8的向下兼容，不准确但优先级高）
     const data = page?.data || page.$data || {};
     title = isString(data?.gioPageTitle) ? data?.gioPageTitle : '';
-    if (instConfig) {
-      // 第三优先级app生命周期中拿不到page对象，拿生命周期的参数来匹配
+
+    let instPage;
+    // 第三优先级取页面的配置json的navigationBarTitleText（仅部分支持）
+    if (!title) {
+      // 存在__[wx]AppCode__时尝试从__[wx]AppCode__中匹配
+      niceTry(() => {
+        const instAppCode = getPlainAppCode(platform);
+        if (instAppCode) {
+          instPage = instAppCode[`${page.route}.json`] || {};
+          title =
+            instPage?.navigationBarTitleText || // wx/qq/jd
+            instPage?.mod?.exports?.navigationBarTitleText; // ks
+        }
+      });
+    }
+    if (!title && 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);
+        title = page.route
+          ? this._getTitleFromTabBar(instConfig, page.route)
+          : '';
       }
-      // 第四优先级取页面的navigationBarTitleText
-      niceTry(() => {
-        if (!title) {
-          const instPage = instConfig.page || {};
+
+      // 第五优先级存在pages数组或page对象时尝试从page中匹配（大概率匹配不到，跟框架有关）
+      if (!title) {
+        if (isArray(instConfig.pages)) {
+          instPage = instConfig.pages.find((o) => o.path === page.route) ?? {};
+        } else {
+          instPage = instConfig.page || {};
+        }
+        if (instPage) {
           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;
-          }
+            instPage[page.route] || instPage[`${page.route}.html`] || instPage;
+          title =
+            pageInfo?.navigationBarTitleText ||
+            pageInfo?.window?.navigationBarTitleText;
         }
-      });
-      // 第五优先级取tabBar配置
+      }
+
+      // 第六优先级取tabBar配置匹配（只有tabbar的4个页面有机会）
       if (!title) {
         title = this._getTitleFromTabBar(instConfig, page.route);
       }
     }
+
+    // 第七优先级兜底取全局window的navigationBarTitleText
+    if (!title) {
+      if (['wx', 'tt'].includes(platform)) {
+        title = (instConfig || global || $global)?.global?.window
+          ?.navigationBarTitleText;
+      } else {
+        title = (instConfig || global || $global)?.window
+          ?.navigationBarTitleText;
+      }
+    }
     return limitString(title);
   };
 
@@ -308,6 +338,15 @@ class BaseInstance implements MinipInstanceType {
       this.minip?.getSetting({ success: resolve, fail: resolve });
     });
   };
+
+  // 监听网络变更
+  setNetworkStatusListener = () => {
+    this.minip?.onNetworkStatusChange(({ networkType }) => {
+      if (networkType) {
+        this.network.networkType = networkType;
+      }
+    });
+  };
 }
 
 export default BaseInstance;

package/src/minipInstance/framework.ts

@@ -1,5 +1,6 @@
 import { getPlainPlatform } from '@@/utils/tools';
 
+import XiaoHongShu from './xhs';
 import JingDong from './jd';
 import KuaiShou from './ks';
 import Alipay from './my';
@@ -16,7 +17,8 @@ const INST = {
   qq: QQ,
   tt: Bytedance,
   ks: KuaiShou,
-  jd: JingDong
+  jd: JingDong,
+  xhs: XiaoHongShu
 };
 
 export default INST[plainPlatform];

package/src/minipInstance/my.ts

@@ -1,4 +1,4 @@
-import { compareVersion } from '@@/utils/tools';
+import { compareVersion, consoleText } from '@@/utils/tools';
 import { GrowingIOType } from '@@/types/growingIO';
 import { isFunction } from '@@/utils/glodash';
 import BaseImplements from './base';
@@ -93,6 +93,39 @@ class Alipay extends BaseImplements {
     }
     return requestTask;
   };
+
+  // 执行支付宝特有的promise分享
+  handleSharePromise = (originResult, handlePromiseResult) => {
+    // 创建监听_result变化的Promise
+    const alipayPromise = new Promise((resolve) => {
+      // 如果已有_result直接返回
+      if (originResult._result) {
+        resolve(originResult._result);
+        return;
+      }
+      // 监听_result属性变化
+      Object.defineProperty(originResult, '_result', {
+        set(value) {
+          this.__result = value;
+          resolve(value);
+        },
+        get() {
+          return this.__result;
+        }
+      });
+    });
+    // 如果三秒内不resolve结果，分享会使用原默认参数
+    Promise.race([
+      alipayPromise,
+      new Promise((resolve) => {
+        setTimeout(() => {
+          resolve(originResult._result || {});
+        }, 3000);
+      })
+    ])
+      .then(handlePromiseResult)
+      .catch((error) => consoleText(error, 'error'));
+  };
 }
 
 export default Alipay;

package/src/minipInstance/quickapp.ts

@@ -217,6 +217,17 @@ class QuickApp extends BaseImplements {
       });
     });
   };
+
+  // 监听网络变更
+  setNetworkStatusListener = () => {
+    network.subscribe({
+      callback: (data) => {
+        if (data.type) {
+          this.network.networkType = data.type;
+        }
+      }
+    });
+  };
 }
 
 export default QuickApp;

package/src/minipInstance/wx.ts

@@ -1,4 +1,5 @@
 import { GrowingIOType } from '@@/types/growingIO';
+import { SystemInfo } from '@@/types/minipInstance';
 
 import BaseImplements from './base';
 
@@ -7,6 +8,20 @@ class Weixin extends BaseImplements {
     super(growingIO);
     this.hookSetTitle();
   }
+
+  // 获取小程序系统信息
+  getSystemInfo = (): Promise<SystemInfo> => {
+    const self = this;
+    return new Promise((resolve) => {
+      const systemInfo = {
+        ...this.minip?.getDeviceInfo(),
+        ...this.minip?.getWindowInfo(),
+        ...this.minip?.getAppBaseInfo()
+      };
+      self.systemInfo = systemInfo;
+      resolve(systemInfo);
+    });
+  };
 }
 
 export default Weixin;

package/src/minipInstance/xhs.ts

@@ -0,0 +1,20 @@
+import { GrowingIOType } from '@@/types/growingIO';
+
+import BaseImplements from './base';
+
+class XiaoHongShu extends BaseImplements {
+  constructor(public growingIO: GrowingIOType) {
+    super(growingIO);
+    this.hookSetTitle();
+  }
+
+  // 采集曝光事件
+  initImpression = (collectPage: any) => {
+    this.growingIO.plugins?.gioImpressionTracking?.main(
+      collectPage,
+      'selectAll'
+    );
+  };
+}
+
+export default XiaoHongShu;

package/src/platformConfig/base.ts

@@ -23,6 +23,7 @@ const Config: PlatformConfigType = {
     'onReachBottom', // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
     'onResize' // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
   ],
+  shareEventTypes: ['onShareAppMessage', 'onShareTimeline', 'onAddToFavorites'],
   actionEventTypes: [
     'onclick',
     'tap',

package/src/platformConfig/framework.ts

@@ -1,5 +1,6 @@
 import { niceTry, getPlainPlatform } from '@@/utils/tools';
 
+import XHSConfig from './xhs';
 import JDConfig from './jd';
 import KSConfig from './ks';
 import MyConfig from './my';
@@ -12,6 +13,7 @@ import WXConfig from './wx';
 const plainPlatform = getPlainPlatform();
 const FrameworkConfig = niceTry(() => {
   const INST = {
+    xhs: XHSConfig,
     jd: JDConfig,
     ks: KSConfig,
     my: MyConfig,

package/src/platformConfig/my.ts

@@ -6,6 +6,7 @@ const MyConfig = {
   name: 'Alipay',
   platform: 'alip',
   scnPrefix: 'alip_',
+  shareEventTypes: ['onShareAppMessage'],
   hooks: {
     ...BaseConfig?.hooks,
     Behavior: false

package/src/platformConfig/xhs.ts

@@ -0,0 +1,27 @@
+import BaseConfig from './base';
+
+const XHSConfig = {
+  ...BaseConfig,
+  pageHandlers: [
+    ...BaseConfig.pageHandlers,
+    'onShareChat',
+    'onCopyUrl',
+    'onShareAppMessage',
+    'onShareTimeline'
+  ],
+  shareEventTypes: [...BaseConfig.shareEventTypes, 'onShareChat', 'onCopyUrl'],
+  listeners: {
+    ...BaseConfig.listeners,
+    page: {
+      ...BaseConfig.listeners.page,
+      shareTime: 'onShareTimeline',
+      shareChat: 'onShareChat',
+      copyUrl: 'onCopyUrl'
+    }
+  },
+  name: 'XiaoHongShu',
+  platform: 'xhsp',
+  scnPrefix: 'xhs_'
+};
+
+export default XHSConfig;

package/src/plugins/gioABTest.ts

@@ -33,6 +33,10 @@ class GioABTest {
   public url: any;
   // 接口重试计数
   public retryCount: number;
+  // 标记当前是否为新访问设备
+  public newDevice: boolean;
+  // 各个实例新设备进入时的sessionId；小程序没有刷新页面保持session的问题，所以存在内存里就可以
+  public visitSids: any;
   constructor(public growingIO: GrowingIOType, options: any) {
     this.pluginVersion = '__PLUGIN_VERSION__';
     const {
@@ -41,8 +45,9 @@ class GioABTest {
       requestTimeout
     } = options ?? {};
     this.timeoutCheck(requestInterval, requestTimeout);
-    const { emitter } = this.growingIO;
+    const { emitter, userStore } = this.growingIO;
     this.growingIO.getABTest = this.getABTest;
+    this.visitSids = {};
     emitter.on(EMIT_MSG.OPTION_INITIALIZED, () => {
       if (!isEmpty(abServerUrl)) {
         this.abtStorageCheck();
@@ -61,6 +66,21 @@ class GioABTest {
         );
       }
     });
+    emitter.on(EMIT_MSG.UID_UPDATE, ({ newUId, oldUId }) => {
+      // 没有旧deviceId说明是第一次进入的新设备
+      if (!oldUId && newUId) {
+        if (isString(abServerUrl)) {
+          const trackingId = this.growingIO.trackingId;
+          const sId = userStore.getSessionId(trackingId);
+          this.visitSids[trackingId] = sId;
+        } else if (isObject(abServerUrl)) {
+          keys(abServerUrl).forEach((trackingId: string) => {
+            const sId = userStore.getSessionId(trackingId);
+            this.visitSids[trackingId] = sId;
+          });
+        }
+      }
+    });
     this.retryCount = 0;
   }
 
@@ -121,6 +141,14 @@ class GioABTest {
 
   // 生成数据接口地址
   generateUrl = (trackingId: string, abServerUrl: string) => {
+    // 如果是延迟初始化的实例，当前又是首次进入设备，要补充把session存起来
+    if (this.newDevice && !this.visitSids[trackingId]) {
+      // 这里要用userStore中的getSessionId，调用这个方法的时候实例肯定已经初始化了
+      // 如果是新初始化可以通过getSessionId准确获取sessionExpires来生成准确的session值;
+      // 如果是旧实例则直接用存储中的sessionId
+      this.visitSids[trackingId] =
+        this.growingIO.userStore.getSessionId(trackingId);
+    }
     if (!startsWith(abServerUrl, 'http')) {
       this.url[
         trackingId
@@ -169,7 +197,7 @@ class GioABTest {
     callback: any
   ) => {
     const {
-      userStore: { getUid },
+      userStore: { getUid, getSessionId },
       dataStore,
       minipInstance
     } = this.growingIO;
@@ -182,7 +210,8 @@ class GioABTest {
         accountId: projectId,
         datasourceId: dataSourceId,
         distinctId: getUid(),
-        layerId
+        layerId,
+        newDevice: this.visitSids[trackingId] === getSessionId(trackingId)
       },
       timeout: this.requestTimeout,
       success: ({ data }: any) => {

package/src/plugins/gioEventAutoTracking.ts

@@ -5,17 +5,21 @@
 import { ID_REG, SWAN_XID_REG, TARO_XID_REG } from '@@/constants/regex';
 import { EventTarget } from '@@/types/eventHooks';
 import { GrowingIOType } from '@@/types/growingIO';
-import { consoleText, isTaro3 } from '@@/utils/tools';
+import { consoleText, getExtraData, isTaro3 } from '@@/utils/tools';
 import EMIT_MSG from '@@/constants/emitMsg';
+import { isEmpty } from '@@/utils/glodash';
 
 let ut;
 class GioEventAutoTracking {
   public pluginVersion: string;
   private prevEvent: any;
+  public circleServerUrl: string;
+  public circleOpen = false;
   constructor(public growingIO: GrowingIOType) {
     this.pluginVersion = '__PLUGIN_VERSION__';
     ut = this.growingIO.utils;
     this.prevEvent = {};
+    this.listenForLunchEvent();
   }
 
   main = (e: EventTarget, eventName: string) => {
@@ -183,6 +187,102 @@ class GioEventAutoTracking {
       eventInterceptor(event);
     }
   };
+
+  // --------------------- 以下内容是对新版小程序圈选的支持 ---------------------
+
+  // 监听小程序的onLunch事件
+  listenForLunchEvent = () => {
+    const { emitter } = this.growingIO;
+    emitter.on(EMIT_MSG.MINIP_LIFECYCLE, ({ event, params }) => {
+      if (['App onLaunch', 'App onShow'].includes(event)) {
+        this.circleInit(params);
+      }
+    });
+  };
+
+  // 初始化圈选
+  circleInit = (params: any) => {
+    const { emitter } = this.growingIO;
+    const extraData = getExtraData(
+      params.referrerInfo?.extraData || params.query || {}
+    );
+    // 额外参数中存在gdpCircleRoomCollectUrl，则表示是圈选的跳转，进入圈选状态
+    if (extraData?.gdpCircleRoomCollectUrl) {
+      // 圈选初始化
+      if (this.circleServerUrl !== extraData?.gdpCircleRoomCollectUrl) {
+        this.circleServerUrl = extraData?.gdpCircleRoomCollectUrl;
+        // 提前移除一次事件发送监听，防止重复监听
+        emitter.off(EMIT_MSG.ON_SEND_AFTER, this.collectorSendFn);
+        // 添加事件发送监听，用于发送圈选事件
+        emitter.on(EMIT_MSG.ON_SEND_AFTER, this.collectorSendFn);
+        this.showPromptModal('enter');
+      }
+      this.circleOpen = true;
+    }
+  };
+
+  // 数据采集发送监听回调
+  collectorSendFn = ({ requestData, trackingId }) => {
+    const { uploader } = this.growingIO;
+    if (this.circleOpen) {
+      // 过滤仅主实例的非CUSTOM事件可以圈选
+      const filteredEvents = requestData.filter(
+        (e) =>
+          e.eventType !== 'CUSTOM' && trackingId === this.growingIO.trackingId
+      );
+      if (!isEmpty(filteredEvents)) {
+        // 同时请求数在3个以下直接发起请求
+        if (uploader.requestingNum < uploader.requestLimit) {
+          this.circleRequest(filteredEvents);
+        } else {
+          // 同时有3个请求在发送时，设轮询延时直到请求数在3个以下
+          let t = setInterval(() => {
+            if (uploader.requestingNum < uploader.requestLimit) {
+              this.circleRequest(filteredEvents);
+              clearInterval(t);
+              t = undefined;
+            }
+          }, 500);
+        }
+      }
+    }
+  };
+
+  // 圈选结束
+  circleClose = () => {
+    this.circleOpen = false;
+    this.circleServerUrl = '';
+    this.growingIO.emitter.off(EMIT_MSG.ON_SEND_AFTER, this.collectorSendFn);
+  };
+
+  // 展示圈选提示
+  showPromptModal = (type: 'enter' | 'error', msg?: string) => {
+    this.growingIO.minipInstance.minip.showModal({
+      title: 'GrowingIO提示',
+      content: type === 'error' ? msg : '您已进入圈选模式',
+      showCancel: false
+    });
+  };
+
+  // 发起圈选请求
+  circleRequest = (requestData: any) => {
+    const { minipInstance } = this.growingIO;
+    minipInstance.request({
+      url: this.circleServerUrl,
+      header: { 'content-type': 'application/json;charset=UTF-8' },
+      method: 'POST',
+      data: requestData,
+      complete: ({ statusCode, data, errMsg }: any) => {
+        if (![200, 204].includes(statusCode) || !data?.success) {
+          this.showPromptModal(
+            'error',
+            data?.message || data || errMsg || '圈选请求失败，请重试!'
+          );
+          this.circleClose();
+        }
+      }
+    });
+  };
 }
 
 export default { name: 'gioEventAutoTracking', method: GioEventAutoTracking };

package/src/plugins/gioImpressionTracking.ts

@@ -107,6 +107,10 @@ class GioImpressionTracking {
         return collectTarget.route
           ? toString(hashCode(collectTarget.route)) // swan page
           : collectTarget.__nodeId__; // swan component
+      case 'xhs':
+        return collectTarget.route
+          ? collectTarget.pageId // xhs page
+          : collectTarget.componentId; // xhs component
       default:
         break;
     }
@@ -117,9 +121,10 @@ class GioImpressionTracking {
     const { gioPlatform } = this.growingIO;
     if (
       (gioPlatform === 'tt' && collectTarget.__nodeId__) ||
-      (gioPlatform === 'ks' && collectTarget.is)
+      (gioPlatform === 'ks' && collectTarget.is) ||
+      (gioPlatform === 'xhs' && collectTarget.componentId)
     ) {
-      // 字节和快手小程序页面监听时可以拿到自定义组件一次性完成监听，所以组件的节点实例不再处理
+      // 字节/快手/小红书小程序页面监听时可以拿到自定义组件一次性完成监听，所以组件的节点实例不再处理
       return false;
     }
     const nodeId = this.getNodeId(collectTarget);
@@ -216,7 +221,7 @@ class GioImpressionTracking {
       originObserver.disconnect();
     }
     // 创建一个新的监听
-    let observer = ['swan', 'jd'].includes(gioPlatform)
+    let observer = ['swan', 'jd', 'xhs'].includes(gioPlatform)
       ? minipInstance.minip?.createIntersectionObserver(
           collectTarget,
           observerOption