gio-miniprogram-sdk 4.0.0

package/src/minipInstance/tt.ts

@@ -0,0 +1,12 @@
+import { GrowingIOType } from '@@/types/growingIO';
+
+import BaseImplements from './base';
+
+class Bytedance extends BaseImplements {
+  constructor(public growingIO: GrowingIOType) {
+    super(growingIO);
+    this.hookSetTitle();
+  }
+}
+
+export default Bytedance;

package/src/minipInstance/wx.ts

@@ -0,0 +1,12 @@
+import { GrowingIOType } from '@@/types/growingIO';
+
+import BaseImplements from './base';
+
+class Weixin extends BaseImplements {
+  constructor(public growingIO: GrowingIOType) {
+    super(growingIO);
+    this.hookSetTitle();
+  }
+}
+
+export default Weixin;

package/src/platformConfig/base.ts

@@ -0,0 +1,86 @@
+import { PlatformConfigType } from '@@/types/platforms';
+import { niceTry } from '@@/utils/tools';
+
+const Config: PlatformConfigType = {
+  scnPrefix: '',
+  appHandlers: [
+    'onLaunch',
+    'onShow',
+    'onHide',
+    'onError', // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
+    'onPageNotFound', // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
+    'onUnhandledRejection', // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
+    'onThemeChange' // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
+  ],
+  pageHandlers: [
+    'onLoad',
+    'onShow',
+    'onReady',
+    'onHide',
+    'onShareAppMessage',
+    'onTabItemTap',
+    'onUnload', // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
+    'onPullDownRefresh', // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
+    'onReachBottom', // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
+    'onResize' // 实际sdk不会执行，但需要写在hook里，防止被归为自定义事件
+  ],
+  actionEventTypes: [
+    'onclick',
+    'tap',
+    'onTap',
+    'longpress',
+    'longTap',
+    'blur',
+    'change',
+    'onChange',
+    'submit',
+    'confirm',
+    'getuserinfo',
+    'getphonenumber',
+    'contact',
+    'mouseup'
+  ],
+  originalApp: niceTry(() => App),
+  originalPage: niceTry(() => Page),
+  originalComponent: niceTry(() => Component),
+  originalBehavior: niceTry(() => Behavior),
+  canHook: true,
+  hooks: {
+    App: true,
+    Page: true,
+    Component: true,
+    Behavior: true
+  },
+  listeners: {
+    app: {
+      appLaunch: 'onLaunch',
+      appShow: 'onShow',
+      appClose: 'onHide'
+    },
+    page: {
+      pageLoad: 'onLoad',
+      pageShow: 'onShow',
+      pageReady: 'onReady',
+      pageHide: 'onHide',
+      pageUnload: 'onUnload',
+      tabTap: 'onTabItemTap',
+      shareApp: 'onShareAppMessage'
+    },
+    actions: {
+      click: [
+        'onclick',
+        'tap',
+        'longpress',
+        'longTap',
+        'getuserinfo',
+        'getphonenumber',
+        'contact',
+        'mouseup'
+      ],
+      change: ['blur', 'change', 'confirm'],
+      submit: ['submit']
+    }
+  }
+};
+
+export default Config;

package/src/platformConfig/framework.ts

@@ -0,0 +1,29 @@
+import { niceTry, getPlainPlatform } from '@@/utils/tools';
+
+import JDConfig from './jd';
+import KSConfig from './ks';
+import MyConfig from './my';
+import TbConfig from './tb';
+import QQConfig from './qq';
+import SwanConfig from './swan';
+import TTConfig from './tt';
+import WXConfig from './wx';
+
+const plainPlatform = getPlainPlatform();
+const FrameworkConfig = niceTry(() => {
+  const INST = {
+    jd: JDConfig,
+    ks: KSConfig,
+    my: MyConfig,
+    tb: TbConfig,
+    qq: QQConfig,
+    swan: SwanConfig,
+    tt: TTConfig,
+    wx: WXConfig
+  };
+  const targetConfig = INST[plainPlatform];
+  targetConfig.canHook = false;
+  return targetConfig;
+});
+
+export default FrameworkConfig;

package/src/platformConfig/jd.ts

@@ -0,0 +1,11 @@
+import BaseConfig from './base';
+
+const JDConfig = {
+  ...BaseConfig,
+  listeners: { ...BaseConfig.listeners },
+  name: 'JingDong',
+  platform: 'jdp',
+  scnPrefix: 'jd_'
+};
+
+export default JDConfig;

package/src/platformConfig/ks.ts

@@ -0,0 +1,11 @@
+import BaseConfig from './base';
+
+const KSConfig = {
+  ...BaseConfig,
+  listeners: { ...BaseConfig.listeners },
+  name: 'KuaiShou',
+  platform: 'kuaishoup',
+  scnPrefix: 'ks_'
+};
+
+export default KSConfig;

package/src/platformConfig/my.ts

@@ -0,0 +1,15 @@
+import BaseConfig from './base';
+
+const MyConfig = {
+  ...BaseConfig,
+  listeners: { ...BaseConfig.listeners },
+  name: 'Alipay',
+  platform: 'alip',
+  scnPrefix: 'alip_',
+  hooks: {
+    ...BaseConfig?.hooks,
+    Behavior: false
+  }
+};
+
+export default MyConfig;

package/src/platformConfig/qq.ts

@@ -0,0 +1,13 @@
+import BaseConfig from './base';
+
+const QQConfig = {
+  ...BaseConfig,
+  listeners: { ...BaseConfig.listeners },
+  name: 'QQ',
+  platform: 'qq',
+  scnPrefix: 'qq_'
+};
+QQConfig.pageHandlers = [...BaseConfig.pageHandlers, 'onAddToFavorites'];
+QQConfig.listeners.page.addFavorites = 'onAddToFavorites';
+
+export default QQConfig;

package/src/platformConfig/quickapp.ts

@@ -0,0 +1,48 @@
+const QuickAppConfig = {
+  name: 'QuickApp',
+  platform: 'quickapp',
+  scnPrefix: 'quickapp_',
+  appHandlers: ['onCreate', 'onShow', 'onHide', 'onDestroy', 'onError'],
+  pageHandlers: [
+    'onInit',
+    'onReady',
+    'onShow',
+    'onHide',
+    'onDestroy',
+    'onMenuPress',
+    'onShareAppMessage'
+  ],
+  actionEventTypes: ['click', 'longpress', 'blur', 'change'],
+  canHook: false,
+  hooks: {
+    App: false,
+    Page: false,
+    Component: false,
+    Behavior: false
+  },
+  listeners: {
+    app: {
+      appCreate: 'onCreate',
+      appShow: 'onShow',
+      appHide: 'onHide',
+      appClose: 'onDestroy'
+    },
+    page: {
+      pageLoad: 'onInit',
+      pageReady: 'onReady',
+      pageShow: 'onShow',
+      pageHide: 'onHide',
+      pageClose: 'onDestroy',
+      menuPress: 'onMenuPress',
+      tabTap: undefined,
+      shareApp: 'onShareAppMessage'
+    },
+    actions: {
+      click: ['click', 'longpress'],
+      change: ['blur', 'change'],
+      submit: []
+    }
+  }
+};
+
+export default QuickAppConfig;

package/src/platformConfig/swan.ts

@@ -0,0 +1,11 @@
+import BaseConfig from './base';
+
+const SwanConfig = {
+  ...BaseConfig,
+  listeners: { ...BaseConfig.listeners },
+  name: 'Baidu',
+  platform: 'baidup',
+  scnPrefix: 'baidup_'
+};
+
+export default SwanConfig;

package/src/platformConfig/tb.ts

@@ -0,0 +1,29 @@
+import BaseConfig from './base';
+
+const TbConfig = {
+  ...BaseConfig,
+  pageHandlers: [
+    ...BaseConfig.pageHandlers,
+    'onInit',
+    'didMount',
+    'didUnmount'
+  ],
+  listeners: {
+    ...BaseConfig.listeners,
+    page: {
+      ...BaseConfig.listeners.page,
+      onInit: 'onInit',
+      didMount: 'didMount',
+      didUnmount: 'didUnmount'
+    }
+  },
+  name: 'Taobao',
+  platform: 'tbp',
+  scnPrefix: 'tbp_',
+  hooks: {
+    ...BaseConfig?.hooks,
+    Behavior: false
+  }
+};
+
+export default TbConfig;

package/src/platformConfig/tt.ts

@@ -0,0 +1,11 @@
+import BaseConfig from './base';
+
+const TTConfig = {
+  ...BaseConfig,
+  listeners: { ...BaseConfig.listeners },
+  name: 'Bytedance',
+  platform: 'bytedance',
+  scnPrefix: 'bytedance_'
+};
+
+export default TTConfig;

package/src/platformConfig/wx.ts

@@ -0,0 +1,20 @@
+import BaseConfig from './base';
+
+const WXConfig = {
+  ...BaseConfig,
+  listeners: { ...BaseConfig.listeners },
+  name: 'Weixin',
+  platform: 'MinP'
+};
+WXConfig.pageHandlers = [
+  ...BaseConfig.pageHandlers,
+  'onShareTimeline',
+  'onAddToFavorites'
+];
+WXConfig.listeners.page = {
+  ...BaseConfig.listeners.page,
+  shareTime: 'onShareTimeline',
+  addFavorites: 'onAddToFavorites'
+};
+
+export default WXConfig;

package/src/pluginsOut/README.md

@@ -0,0 +1,50 @@
+## 目录说明
+
+本目录下有多个文件夹，其中`ordinary`是主要的一些内置插件，`frameworks`是小程序开发框架的适配，其他文件夹为特殊场景适配。
+
+## 插件名称命名规则
+
+`gio`开头表明是gio的插件；
+
+名称带`Adapter`表明是某个场景下的适配；
+
+短横线加环境`-cdp`、`-saas`表明是cdp或者是saas专有的插件；不会被单独打包插件；
+
+除`ordinary`目录下的插件打包会打在`dist/plugins`根目录下，`frameworks`不会被单独打包，其他带文件夹的插件会打包在保留文件夹路径且与`plugins`同级的目录下。
+
+如果新增目录，发布时需要在jekins上修改配置添加路径。
+
+## 开发插件
+
+- 这里提供一个Demo供参考：
+
+```js
+/**
+ * 名称：插件Demo
+ * 用途：用于提供编写插件的模板。
+ */
+import { GrowingIOType } from '@@/types/growingIO';
+
+class GioDemoPlugin {
+  constructor(public growingIO: GrowingIOType) {}
+
+  onComposeBefore(args) {
+    // console.log('onComposeBefore', args);
+  }
+
+  onComposeAfter(args) {
+    // console.log('onComposeAfter', args);
+  }
+
+  onSendBefore(args) {
+    // console.log('onSendBefore', args);
+  }
+
+  onSendAfter(args) {
+    // console.log('onSendAfter', args);
+  }
+}
+
+export default { name: 'gioDemoPlugin', method: GioDemoPlugin };
+
+```

package/src/pluginsOut/frameworks/gioTaobaoAdapter.ts

@@ -0,0 +1,195 @@
+/**
+ * 名称：淘宝小程序单发插件
+ * 用途：用于提供淘宝小程序云函数和云应用的请求方法。
+ */
+import { Event } from '@@/types/base';
+import { GrowingIOType } from '@@/types/growingIO';
+
+let ut;
+class GioTaobaoAdapter {
+  constructor(public growingIO: GrowingIOType) {
+    const { utils, emitter } = this.growingIO;
+    ut = utils;
+    emitter.on('OPTION_INITIALIZED', (growingIO: GrowingIOType) => {
+      const { inPlugin, dataStore } = growingIO;
+      if (inPlugin) {
+        ut.getGlobal().Component = function (...args: any[]) {
+          return dataStore.eventHooks.componentOverriding(args[0]);
+        };
+      }
+    });
+    emitter.on('minipLifecycle', ({ event }) => {
+      const { dataStore, vdsConfig } = this.growingIO;
+      const widgetName = `小部件${vdsConfig.appId}`;
+      switch (event) {
+        case 'Page onInit':
+          {
+            const sendVisit = (relationAppInfo: any, sceneInfo: any) => {
+              const query = ut
+                .keys(relationAppInfo)
+                .map((k) => `${k}=${relationAppInfo[k]}`)
+                .join('&');
+              dataStore.scene = sceneInfo.sceneId ?? '';
+              dataStore.sendVisit({
+                path: widgetName,
+                query,
+                title: widgetName
+              });
+            };
+            this.getRelationAppInfo((relationAppInfo: any) =>
+              this.getSceneInfo(relationAppInfo, sendVisit)
+            );
+          }
+          break;
+        case 'Page didMount':
+          dataStore.sendPage({
+            path: widgetName,
+            title: widgetName
+          });
+          break;
+        default:
+          break;
+      }
+    });
+  }
+
+  // 小部件获取场景值信息
+  getSceneInfo = (relationAppInfo: any, callback: any) => {
+    this.growingIO.minipInstance.minip?.getRelationAppInfo({
+      success: (res) => callback(relationAppInfo, res),
+      fail: () => callback(relationAppInfo, {})
+    });
+  };
+
+  // 小部件获取关联小程序的信息
+  getRelationAppInfo = (callback: any) => {
+    this.growingIO.minipInstance.minip?.getRelationAppInfo({
+      success: callback,
+      fail: () => callback({})
+    });
+  };
+
+  // 单条发送无延迟
+  singleInvoke = () => {
+    const { vdsConfig, emitter, uploader } = this.growingIO;
+    // 过滤掉重试超过3次的请求(直接丢弃)
+    uploader.hoardingQueue = [...uploader.hoardingQueue].filter(
+      (o) => (uploader.retryIds[o.requestId] || 0) < uploader.retryLimit
+    );
+    uploader.requestQueue = [...uploader.requestQueue].filter(
+      (o) => (uploader.retryIds[o.requestId] || 0) < uploader.retryLimit
+    );
+    if (ut.isEmpty([...uploader.hoardingQueue, ...uploader.requestQueue])) {
+      return;
+    }
+    let requestData =
+      uploader.hoardingQueue.shift() ?? uploader.requestQueue.shift();
+    // 开启debug模式时，打印事件日志
+    if (vdsConfig.debug) {
+      console.log('[GrowingIO Debug]:', JSON.stringify(requestData, null, 2));
+    }
+    emitter.emit('onSendBefore', { requestData });
+    this.cloudFuncInvoke(requestData);
+  };
+
+  // 云函数调用
+  cloudFuncInvoke = (requestData) => {
+    const { vdsConfig, emitter, uploader } = this.growingIO;
+    const { serverUrl, projectId, tbConfig } = vdsConfig;
+    const app = ut.niceTry(() => getApp() ?? $global);
+    const cloud = tbConfig.cloud ?? app.cloud;
+    if (cloud?.function?.invoke) {
+      uploader.requestingNum += 1;
+      cloud.function
+        .invoke(
+          tbConfig.cloudFuncName,
+          {
+            domain: serverUrl,
+            path: `/v3/projects/${projectId}/collect`,
+            params: { stm: Date.now() },
+            body: requestData
+          },
+          tbConfig.cloudFuncHandler
+        )
+        .then((res) => {
+          uploader.requestingNum -= 1;
+          // 这里的返回值只是调用了api是否成功，真正是否上报成功不知道，要去淘宝控制台看
+          if (res.success) {
+            emitter.emit('onSendAfter', { result: res });
+          } else {
+            uploader.requestFailFn(requestData);
+            ut.consoleText(`请求失败! ${JSON.stringify(res)}`, 'error');
+          }
+          uploader.initiateRequest();
+        })
+        .catch((e) => {
+          uploader.requestingNum -= 1;
+          uploader.requestFailFn(requestData);
+          ut.consoleText(`请求失败! ${JSON.stringify(e)}`, 'error');
+          uploader.initiateRequest();
+        });
+    } else {
+      ut.consoleText(
+        '请求失败！无法获取 cloud 对象，请检查 tbConfig 配置项！',
+        'error'
+      );
+    }
+  };
+
+  // 云应用调用
+  tbCloudAppInvoke(requestData) {
+    const { vdsConfig, emitter, uploader } = this.growingIO;
+    const { serverUrl, projectId, tbConfig } = vdsConfig;
+    const app = ut.niceTry(() => getApp() ?? $global);
+    const cloud = tbConfig.cloud ?? app.cloud;
+    if (cloud?.application?.httpRequest) {
+      uploader.requestingNum += 1;
+      cloud.application
+        .httpRequest({
+          //不需要完整域名，只需要接口访问路径即可
+          path: tbConfig.path,
+          method: 'POST',
+          headers: { 'Content-Type': 'application/json;charset=UTF-8' },
+          params: { serverUrl, projectId, stm: Date.now() },
+          body: requestData,
+          exts: { cloudAppId: tbConfig.cloudAppId }
+        })
+        .then((res) => {
+          uploader.requestingNum -= 1;
+          // 这里的返回值只是调用了api是否成功，真正是否上报成功不知道，要看云应用的服务端是不是真的转发成功
+          if (res.success) {
+            emitter.emit('onSendAfter', { result: res });
+          } else {
+            if (ut.isArray(requestData)) {
+              requestData.forEach((o: any) => {
+                uploader.requestFailFn(o);
+              });
+            } else {
+              uploader.requestFailFn(requestData);
+            }
+            ut.consoleText(`请求失败! ${JSON.stringify(res)}`, 'error');
+          }
+          uploader.initiateRequest();
+        })
+        .catch((e) => {
+          uploader.requestingNum -= 1;
+          if (ut.isArray(requestData)) {
+            requestData.forEach((o: any) => {
+              uploader.requestFailFn(o);
+            });
+          } else {
+            uploader.requestFailFn(requestData);
+          }
+          ut.consoleText(`请求失败! ${JSON.stringify(e)}`, 'error');
+          uploader.initiateRequest();
+        });
+    } else {
+      ut.consoleText(
+        '请求失败！无法获取 cloud 对象，请检查 tbConfig 配置项！',
+        'error'
+      );
+    }
+  }
+}
+
+export default { name: 'gioTaobaoAdapter', method: GioTaobaoAdapter };