gio-miniprogram-sdk 4.0.0

package/src/minipInstance/base.ts

@@ -0,0 +1,287 @@
+import { GrowingIOType } from '@@/types/growingIO';
+import {
+  AppSource,
+  Location,
+  MinipInstanceType,
+  NavigateToMiniProgramOption,
+  SystemInfo
+} from '@@/types/minipInstance';
+import { PLATFORMS } from '@@/types/platforms';
+import { isFunction, isObject, isString, last } from '@@/utils/glodash';
+import {
+  limitString,
+  niceTry,
+  getPlainMinip,
+  getPlainPlatform,
+  getPlainConfig
+} from '@@/utils/tools';
+
+// 此基础实现类仅包含所有小程序，快应用所有方法全部单独实现
+class BaseInstance implements MinipInstanceType {
+  readonly minip: any = getPlainMinip('__GIO_PLATFORM__');
+  public platform: PLATFORMS;
+  public scnPrefix: string;
+  public location: Location;
+  public appSource: AppSource;
+  public systemInfo: any;
+  public network: any;
+
+  constructor(public growingIO: GrowingIOType) {
+    const {
+      platformConfig: { platform, scnPrefix }
+    } = this.growingIO;
+    this.platform = platform;
+    this.scnPrefix = scnPrefix;
+    this.growingIO.emitter.on('OPTION_INITIALIZED', () => {
+      this.getNetworkType().then(() =>
+        this.growingIO.dataStore?.eventReleaseInspector()
+      );
+      this.getSystemInfo().then(() =>
+        this.growingIO.dataStore?.eventReleaseInspector()
+      );
+    });
+  }
+
+  // 通过hook setNavigationBarTitle方法优雅地获取客户设置的当前页面标题
+  hookSetTitle = () => {
+    const originSetter = this.minip?.setNavigationBarTitle;
+    const self = this;
+    if (originSetter) {
+      Object.defineProperty(this.minip, 'setNavigationBarTitle', {
+        writable: true,
+        enumerable: true,
+        configurable: true,
+        value: function () {
+          if (self.growingIO.gioSDKInitialized) {
+            // 这个currentPath一般认为是在onLoad中获取的当前小程序页面的path，此时SDK还没有parse，保存的还是上一个页面的信息
+            const currentPath = self.getCurrentPath();
+            const { title } = arguments[0] || {};
+            self.growingIO.dataStore.eventHooks.currentPage.settedTitle[
+              currentPath
+            ] = title;
+          }
+          return originSetter.apply(this, arguments);
+        }
+      });
+    }
+  };
+
+  // -----以下为除快应用以外的小程序通用的实现，由各平台端继承并差异化实现-----
+
+  /**
+   * 业务相关
+   */
+  // 保留当前页面，跳转到应用内的某个页面
+  navigateTo = (opt: {
+    url: string;
+    fail: () => void;
+    success: () => void;
+    complete: () => void;
+  }) => this.minip?.navigateTo(opt);
+
+  // 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
+  switchTab = (opt: {
+    url: string;
+    fail: () => void;
+    success: () => void;
+    complete: () => void;
+  }) => {
+    this.minip?.switchTab(opt);
+  };
+
+  // 打开另一个小程序
+  navigateToMiniProgram = (opt: NavigateToMiniProgramOption) =>
+    this.minip?.navigateToMiniProgram(opt);
+
+  // 获取图片信息
+  getImageInfo = ({ src, success, fail, complete }: any) =>
+    this.minip?.getImageInfo({ src, success, fail, complete });
+
+  // 采集曝光事件
+  initImpression = (collectPage: any) => {
+    this.growingIO.plugins?.gioImpressionTracking?.main(
+      collectPage,
+      'observeAll'
+    );
+  };
+
+  /**
+   * 页面相关
+   */
+  // 获取当前页面栈
+  getCurrentPage = (): any => {
+    // @ts-ignore 小程序自带api
+    return niceTry(() => last(getCurrentPages())) || {};
+  };
+
+  // 获取当前页面路由
+  getCurrentPath = () => {
+    const currentPage = this.getCurrentPage();
+    // wx/my取route; swan取uri; tt取__route__; qq无值
+    return (
+      currentPage?.route || currentPage?.uri || currentPage?.__route__ || ''
+    );
+  };
+
+  // 获取页面标题
+  getPageTitle = (page) => {
+    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;
+        }
+      }
+      // 第四优先级取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 || '';
+      }
+    } catch (e) {
+      return '';
+    }
+    return limitString(title);
+  };
+
+  /**
+   * 存储相关
+   */
+  // 同步获取存储数据
+  getStorageSync = (key: string): any => {
+    let value = this.minip?.getStorageSync(key);
+    if (isObject(value) && value.expiredAt) {
+      if (value.expiredAt < Date.now()) {
+        return '';
+      } else {
+        return value.value;
+      }
+    }
+    return value;
+  };
+
+  // 异步获取存储数据
+  getStorage = (key: string): Promise<string> => {
+    return new Promise((resolve) => {
+      this.minip?.getStorage({
+        key,
+        success: ({ data }) => resolve(data),
+        fail: () => resolve('')
+      });
+    });
+  };
+
+  // 同步存储数据
+  setStorageSync = (key: string, value: any, expiredAt?: string | number) => {
+    if (expiredAt) {
+      value = { value, expiredAt };
+    }
+    this.minip?.setStorageSync(key, value);
+  };
+
+  // 异步存储数据
+  setStorage = (key: string, value: any) => {
+    this.minip?.setStorage({ key, data: value });
+  };
+
+  // 同步移除指定数据
+  removeStorageSync = (key: string) => {
+    this.minip?.removeStorageSync(key);
+  };
+
+  // 异步移除指定数据
+  removeStorage = (key: string) => {
+    this.minip?.removeStorage(key);
+  };
+
+  /**
+   * 网络相关
+   */
+  // 获取网络类型
+  getNetworkType = (): Promise<{ networkType: string }> => {
+    const self = this;
+    return new Promise((resolve) => {
+      this.minip?.getNetworkType({
+        success: (r) => {
+          self.network = r;
+          resolve(r);
+        },
+        fail: () => resolve(null)
+      });
+    });
+  };
+
+  // 发起请求
+  request = ({
+    url,
+    data,
+    header,
+    timeout,
+    method,
+    success,
+    fail,
+    complete
+  }) => {
+    const requestTask = this.minip?.request({
+      url,
+      data,
+      // 微信小程序和其他小程序里叫header
+      header,
+      // 支付宝小程序里叫headers
+      headers: header,
+      timeout,
+      method,
+      success,
+      fail,
+      complete
+    });
+    // 设置超时中断请求
+    let t = setTimeout(() => {
+      if (requestTask?.abort && isFunction(requestTask?.abort)) {
+        requestTask?.abort();
+      }
+      clearTimeout(t);
+      t = null;
+    }, (timeout || 10000) + 10);
+    return requestTask;
+  };
+
+  /**
+   * 系统相关
+   */
+  // 获取小程序系统信息
+  getSystemInfo = (): Promise<SystemInfo> => {
+    const self = this;
+    return new Promise((resolve) => {
+      this.minip?.getSystemInfo({
+        success: (r) => {
+          self.systemInfo = r;
+          resolve(r);
+        },
+        fail: () => resolve(null)
+      });
+    });
+  };
+
+  // 获取小程序设置
+  getSetting = () => {
+    return new Promise((resolve) => {
+      this.minip?.getSetting({ success: resolve, fail: resolve });
+    });
+  };
+}
+
+export default BaseInstance;

package/src/minipInstance/framework.ts

@@ -0,0 +1,22 @@
+import { getPlainPlatform } from '@@/utils/tools';
+
+import JingDong from './jd';
+import KuaiShou from './ks';
+import Alipay from './my';
+import QQ from './qq';
+import Baidu from './swan';
+import Bytedance from './tt';
+import Weixin from './wx';
+
+const plainPlatform = getPlainPlatform();
+const INST = {
+  wx: Weixin,
+  swan: Baidu,
+  my: Alipay,
+  qq: QQ,
+  tt: Bytedance,
+  ks: KuaiShou,
+  jd: JingDong
+};
+
+export default INST[plainPlatform];

package/src/minipInstance/jd.ts

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

package/src/minipInstance/ks.ts

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

package/src/minipInstance/my.ts

@@ -0,0 +1,53 @@
+import { GrowingIOType } from '@@/types/growingIO';
+import BaseImplements from './base';
+
+class Alipay extends BaseImplements {
+  constructor(public growingIO: GrowingIOType) {
+    super(growingIO);
+    this.hookSetTitle();
+  }
+
+  hookSetTitle = () => {
+    const originSetter = this.minip?.setNavigationBar;
+    const self = this;
+    if (originSetter) {
+      Object.defineProperty(this.minip, 'setNavigationBar', {
+        writable: true,
+        enumerable: true,
+        configurable: true,
+        value: function () {
+          if (self.growingIO.gioSDKInitialized) {
+            // 这个currentPath一般认为是在onLoad中获取的当前小程序页面的path，此时SDK还没有parse，保存的还是上一个页面的信息
+            const currentPath = self.getCurrentPath();
+            const { title } = arguments[0] || {};
+            self.growingIO.dataStore.eventHooks.currentPage.settedTitle[
+              currentPath
+            ] = title;
+          }
+          return originSetter.apply(this, arguments);
+        }
+      });
+    }
+  };
+
+  // 采集曝光事件
+  initImpression = (collectPage: any) => {
+    this.growingIO.plugins?.gioImpressionTracking?.main(
+      collectPage,
+      'selectAll'
+    );
+  };
+
+  // 同步获取存储数据（支付宝小程序返回值与其他平台不同）
+  getStorageSync = (key: string) => {
+    const { data } = my.getStorageSync({ key });
+    return data;
+  };
+
+  // 同步存储数据（支付宝小程序参数与其他平台不同）
+  setStorageSync = (key: string, value: any) => {
+    this.minip?.setStorageSync({ key, data: value });
+  };
+}
+
+export default Alipay;

package/src/minipInstance/qq.ts

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

package/src/minipInstance/quickapp.ts

@@ -0,0 +1,230 @@
+import { GrowingIOType } from '@@/types/growingIO';
+import { SystemInfo } from '@@/types/minipInstance';
+import { isString, last } from '@@/utils/glodash';
+import { limitString } from '@@/utils/tools';
+import app from '@system.app';
+import device from '@system.device';
+import fetch from '@system.fetch';
+import image from '@system.image';
+import network from '@system.network';
+import router from '@system.router';
+import share from '@system.share';
+import storage from '@system.storage';
+
+import BaseImplements from './base';
+
+class QuickApp extends BaseImplements {
+  constructor(public growingIO: GrowingIOType) {
+    super(growingIO);
+    this.growingIO.emitter.on('minipLifecycle', ({ event }) => {
+      switch (event) {
+        case 'App onCreate':
+          {
+            this.getNetworkType().then(() =>
+              this.growingIO.dataStore?.eventReleaseInspector()
+            );
+            this.getSystemInfo().then(() =>
+              this.growingIO.dataStore?.eventReleaseInspector()
+            );
+          }
+          break;
+        case 'App onCreateEnd':
+          {
+            this.setStorage = (key: string, value: string) => {
+              storage?.set({ key, value });
+            };
+          }
+          break;
+        default:
+          break;
+      }
+    });
+  }
+
+  /**
+   * 业务相关
+   */
+  // 获取应用来源
+  getAppSource = () => {
+    const { source } = app.getInfo();
+    this.appSource = source || {};
+    return this.appSource;
+  };
+
+  // 保留当前页面，跳转到应用内的某个页面（重写为空）
+  navigateTo = () => {}; // eslint-disable-line
+
+  // 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面（重写为空）
+  switchTab = () => {}; // eslint-disable-line
+
+  // 打开另一个小程序（重写为空）
+  navigateToMiniProgram = () => {}; // eslint-disable-line
+
+  // 监听小程序切前台事件（重写为空）
+  onAppShow = () => {}; // eslint-disable-line
+
+  // 监听小程序切后台事件（重写为空）
+  onAppHide = () => {}; // eslint-disable-line
+
+  // 获取图片信息
+  getImageInfo = ({ src, success, fail, complete }: any) => {
+    return image?.getImageInfo({ uri: src, success, fail, complete });
+  };
+
+  // 采集曝光事件
+  initImpression = () => {}; // eslint-disable-line
+
+  // 初始化分享
+  initShareAppMessage = (growingIO: GrowingIOType) => {
+    const { vdsConfig, platformConfig } = growingIO;
+    try {
+      this.growingIO.shareAppMessage = function () {
+        const params = arguments[0];
+        if (
+          params &&
+          params.type &&
+          !/^text.*/.test(params.type) &&
+          params.data
+        ) {
+          if (vdsConfig.followShare) {
+            if (params.data.indexOf('?') === -1) {
+              params.data = params.data + '?suid=' + growingIO.userStore.uid;
+            } else {
+              params.data = params.data + '&suid=' + growingIO.userStore.uid;
+            }
+          }
+        }
+        share?.share(params);
+        growingIO?.eventTracking?.pageEffects(
+          this,
+          platformConfig.listeners.page.shareApp as any,
+          arguments
+        );
+      };
+    } catch (e) {
+      //
+    }
+  };
+
+  /**
+   * 页面相关
+   */
+  // 获取当前页面栈
+  getCurrentPage = () => {
+    if (router?.getPages) {
+      return last(router?.getPages());
+    }
+    return {};
+  };
+
+  // 获取当前页面路由
+  getCurrentPath = () => {
+    const route = router?.getState();
+    return route?.path;
+  };
+
+  // 获取页面标题(除wx以外其他平台)
+  getPageTitle = (page) => {
+    let title = '';
+    try {
+      // this.$page.setTitleBar是只读方法，不能hook
+      // 第一优先级支持客户自己在页面中设置页面title
+      title = isString(page?.gioPageTitle) ? page?.gioPageTitle : '';
+      // 第三优先级取页面的titleBarText
+      if (!title) {
+        const instConfig = page?.$app?.$def?.manifast?.display?.pages ?? {};
+        const pageInfo = instConfig?.[page.route];
+        if (pageInfo) {
+          title = pageInfo.titleBarText;
+        }
+      }
+      // 第四优先级取router状态
+      if (!title) {
+        const route = router?.getState();
+        title = route?.name || '';
+      }
+    } catch (e) {
+      return '';
+    }
+    return limitString(title);
+  };
+
+  /**
+   * 存储相关
+   */
+  // 同步获取存储数据
+  getStorageSync = () => '';
+
+  // 异步获取存储数据
+  getStorage = async (key: string): Promise<string> => {
+    return await new Promise((resolve) => {
+      storage?.get({
+        key,
+        success: (res) => resolve(res),
+        fail: () => resolve(null)
+      });
+    });
+  };
+
+  // 同步存储数据
+  setStorageSync = () => {}; // eslint-disable-line
+
+  // 异步存储数据
+  setStorage = (key: string, value: string) => {}; // eslint-disable-line
+
+  // 同步移除指定数据
+  removeStorageSync = () => {}; // eslint-disable-line
+
+  // 异步移除指定数据
+  removeStorage = (key: string) => {
+    storage?.delete({ key });
+  };
+
+  /**
+   * 网络相关
+   */
+  // 获取网络类型
+  getNetworkType = async (): Promise<{
+    networkType: string;
+  }> => {
+    const self = this;
+    return await new Promise((resolve) => {
+      network?.getType({
+        success: (res) => {
+          self.network = res;
+          resolve(res);
+        },
+        fail: () => resolve(null)
+      });
+    });
+  };
+
+  // 发起请求
+  request = ({ url, header, method, data, success, fail, complete }) => {
+    return fetch?.fetch({ url, header, method, data, success, fail, complete });
+  };
+
+  /**
+   * 系统相关
+   */
+  // 获取设备系统信息
+  getSystemInfo = async (): Promise<SystemInfo> => {
+    const self = this;
+    return await new Promise((resolve) => {
+      device?.getInfo({
+        success: (res) => {
+          const info = {
+            ...res,
+            version: res.platformVersionName,
+            platform: res.osType
+          };
+          self.systemInfo = info;
+          resolve(info);
+        },
+        fail: () => resolve(null)
+      });
+    });
+  };
+}
+
+export default QuickApp;

package/src/minipInstance/swan.ts

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

package/src/minipInstance/tb.ts

@@ -0,0 +1,53 @@
+import { GrowingIOType } from '@@/types/growingIO';
+import BaseImplements from './base';
+
+class Taobao extends BaseImplements {
+  constructor(public growingIO: GrowingIOType) {
+    super(growingIO);
+    this.hookSetTitle();
+  }
+
+  hookSetTitle = () => {
+    const originSetter = this.minip?.setNavigationBar;
+    const self = this;
+    if (originSetter) {
+      Object.defineProperty(this.minip, 'setNavigationBar', {
+        writable: true,
+        enumerable: true,
+        configurable: true,
+        value: function () {
+          if (self.growingIO.gioSDKInitialized) {
+            // 这个currentPath一般认为是在onLoad中获取的当前小程序页面的path，此时SDK还没有parse，保存的还是上一个页面的信息
+            const currentPath = self.getCurrentPath();
+            const { title } = arguments[0] || {};
+            self.growingIO.dataStore.eventHooks.currentPage.settedTitle[
+              currentPath
+            ] = title;
+          }
+          return originSetter.apply(this, arguments);
+        }
+      });
+    }
+  };
+
+  // 采集曝光事件
+  initImpression = (collectPage: any) => {
+    this.growingIO.plugins?.gioImpressionTracking?.main(
+      collectPage,
+      'selectAll'
+    );
+  };
+
+  // 同步获取存储数据（支付宝小程序返回值与其他平台不同）
+  getStorageSync = (key: string) => {
+    const { data } = my.getStorageSync({ key });
+    return data;
+  };
+
+  // 同步存储数据（支付宝小程序参数与其他平台不同）
+  setStorageSync = (key: string, value: any) => {
+    this.minip?.setStorageSync({ key, data: value });
+  };
+}
+
+export default Taobao;