gio-miniprogram-sdk 4.4.2 → 4.4.3

package/src/core/userStore.ts

@@ -1,267 +0,0 @@
-import { batchGetStorageSync, batchSetStorageSync, guid } from '@@/utils/tools';
-import { GrowingIOType } from '@@/types/growingIO';
-import { isNil } from '@@/utils/glodash';
-import { StringObject } from '@@/types/base';
-import { UserStoreType } from '@@/types/userStore';
-import EMIT_MSG from '@@/constants/emitMsg';
-
-/**
- * 代码中与3.0测量协议字段对应关系
- * 代码定义    |  3.0测量协议定义  |  字段解释
- * ---------------------------------------------------
- * sessionId  |  sessionId      |  访问会话id
- * uid        |  deviceId       |  访问用户id(持久化)
- * userId     |  userId         |  登录用户id(持久化)
- * gioId      |  gioId          |  上一个非空的登录用户id(持久化)
- */
-
-class UserStore implements UserStoreType {
-  // 访问用户id/设备id（系统设置持久性存储）
-  public _uid: string;
-  // 用户访问会话id
-  public _sessionId: StringObject;
-  // 登录用户id（客户设置持久性存储）
-  public _userId: StringObject;
-  // 登录用户key（客户设置持久性存储）
-  public _userKey: StringObject;
-  // 最后一次登录用户id（持久性存储）
-  public _gioId: StringObject;
-  // 设置了session有效期以后判断用的session失效时间
-  public _sessionExpires: number;
-  constructor(public growingIO: GrowingIOType) {
-    this._uid = undefined;
-    this._sessionId = {};
-    this._userId = {};
-    this._userKey = {};
-    this._gioId = {};
-    this._sessionExpires = -1;
-  }
-
-  // 获取sessionId存储key
-  _getUidKey = () =>
-    this.growingIO.inPlugin ? '_growing_plugin_uid_' : '_growing_uid_';
-
-  // 获取设备Id
-  getUid = () => {
-    const { minipInstance } = this.growingIO;
-    // 内存中拿不到尝试从存储中拿
-    if (!this._uid) {
-      this._uid = minipInstance.getStorageSync(this._getUidKey());
-    }
-    // 存储中拿不到尝试设新值
-    if (!this._uid) {
-      this.setUid(guid());
-    }
-    return this._uid;
-  };
-
-  // 设置设备Id
-  setUid = (id: string) => {
-    const prevId = this._uid;
-    this._uid = id;
-    if (prevId !== this._uid) {
-      this.growingIO.minipInstance.setStorage(this._getUidKey(), this._uid);
-      // 广播通知访问用户Id变更
-      this.growingIO.emitter.emit(EMIT_MSG.UID_UPDATE, {
-        newUId: id,
-        oldUId: prevId
-      });
-    }
-  };
-
-  // 获取sessionId
-  getSessionId = (trackingId: string) => {
-    // 设置了session时长，就需要检查session是否过期
-    const {
-      vdsConfig: { sessionExpires },
-      dataStore: { trackersExecute }
-    } = this.growingIO;
-    // 不存在sessionId（即新进）要设一个新的sessionId
-    if (!this._sessionId[trackingId]) {
-      this.setSessionId(trackingId);
-    }
-    // 设置了session时长且过期
-    if (sessionExpires > -1) {
-      // 只要有一个session超时，所有实例都要重设sessionId
-      if (Date.now() > this._sessionExpires) {
-        trackersExecute((id: string) => {
-          this.setSessionId(id);
-        });
-      }
-      // 每次获取session后要更新过期时间
-      this._sessionExpires = Date.now() + 1000 * 60 * sessionExpires;
-    }
-    return this._sessionId[trackingId];
-  };
-
-  // 设置sessionId
-  setSessionId = (trackingId: string, id?: string) => {
-    const prevId = this._sessionId[trackingId];
-    if (!id) {
-      id = guid();
-    }
-    // 小程序中sessionId只需要在内存中存储就可以，不需要持久化存储
-    this._sessionId[trackingId] = id;
-    // 设置了session时长，就需要更新过期时间
-    const { sessionExpires } = this.growingIO.vdsConfig;
-    if (sessionExpires > -1) {
-      this._sessionExpires = Date.now() + 1000 * 60 * sessionExpires;
-    }
-    // 广播通知登录sessionId变更
-    if (prevId !== id) {
-      this.growingIO.emitter.emit(EMIT_MSG.SESSIONID_UPDATE, {
-        trackingId,
-        newSessionId: id,
-        oldSessionId: prevId
-      });
-    }
-  };
-
-  // 获取userId存储key
-  _getUserIdKey = (trackingId: string) =>
-    this.growingIO.dataStore.getStorageKey(trackingId, 'userId');
-
-  // 获取userId
-  getUserId = (trackingId: string) => {
-    const { minipInstance } = this.growingIO;
-    // 内存中拿不到尝试从存储中拿
-    if (!this._userId[trackingId]) {
-      this._userId[trackingId] = minipInstance.getStorageSync(
-        this._getUserIdKey(trackingId)
-      );
-    }
-    return this._userId[trackingId];
-  };
-
-  // 设置userId
-  setUserId = (trackingId: string, id: string) => {
-    const prevId = this._userId[trackingId];
-    this._userId[trackingId] = isNil(id) ? '' : id;
-    if (prevId !== this._userId[trackingId]) {
-      this.growingIO.minipInstance.setStorage(
-        this._getUserIdKey(trackingId),
-        this._userId[trackingId]
-      );
-      // 广播通知登录用户Id变更
-      this.growingIO.emitter.emit(EMIT_MSG.USERID_UPDATE, {
-        newUserId: id,
-        oldUserId: prevId
-      });
-    }
-    if (id) this.setGioId(trackingId, id);
-  };
-
-  // 获取userKey存储key
-  _getUserKeyKey = (trackingId: string) =>
-    this.growingIO.dataStore.getStorageKey(trackingId, 'userKey');
-
-  // 获取userKey
-  getUserKey = (trackingId: string) => {
-    const { minipInstance } = this.growingIO;
-    // 内存中拿不到尝试从存储中拿
-    if (!this._userKey[trackingId]) {
-      this._userKey[trackingId] = minipInstance.getStorageSync(
-        this._getUserKeyKey(trackingId)
-      );
-    }
-    return this._userKey[trackingId];
-  };
-
-  // 设置userKey
-  setUserKey = (trackingId: string, key: string) => {
-    const prevKey = this._userKey[trackingId];
-    this._userKey[trackingId] = isNil(key) ? '' : key;
-    if (prevKey !== this._userKey[trackingId]) {
-      this.growingIO.minipInstance.setStorage(
-        this._getUserKeyKey(trackingId),
-        this._userKey[trackingId]
-      );
-      // 广播通知登录用户key变更
-      this.growingIO.emitter.emit(EMIT_MSG.USERKEY_UPDATE, {
-        newUserKey: key,
-        oldUserKey: prevKey
-      });
-    }
-  };
-
-  // 获取gioId存储key
-  _getGioIdKey = (trackingId: string) =>
-    this.growingIO.dataStore.getStorageKey(trackingId, 'gioId');
-
-  // 获取gioId
-  getGioId = (trackingId: string) => {
-    const { minipInstance } = this.growingIO;
-    // 内存中拿不到尝试从存储中拿
-    if (!this._gioId[trackingId]) {
-      this._gioId[trackingId] = minipInstance.getStorageSync(
-        this._getGioIdKey(trackingId)
-      );
-    }
-    return this._gioId[trackingId];
-  };
-
-  // 设置gioId
-  setGioId = (trackingId: string, gioId: string) => {
-    const prevId = this._gioId[trackingId];
-    this._gioId[trackingId] = isNil(gioId) ? '' : gioId;
-    if (prevId !== this._gioId[trackingId]) {
-      this.growingIO.minipInstance.setStorage(
-        this._getGioIdKey(trackingId),
-        this._gioId[trackingId]
-      );
-      // 广播通知登录用户Id变更
-      this.growingIO.emitter.emit(EMIT_MSG.GIOID_UPDATE, {
-        newGioId: gioId,
-        oldGioId: prevId
-      });
-    }
-  };
-
-  // 初始化用户信息
-  initUserInfo = (trackingId: string) => {
-    const { minipInstance } = this.growingIO;
-    const storeKeys = [
-      this._getUidKey(),
-      this._getUserIdKey(trackingId),
-      this._getUserKeyKey(trackingId),
-      this._getGioIdKey(trackingId)
-    ];
-    const memoryKeys = ['_uid', '_userId', '_userKey', '_gioId'];
-    // 批量获取的存储数据
-    const values = batchGetStorageSync(minipInstance, storeKeys) ?? [];
-    // 往存储中重设的key
-    memoryKeys.forEach((key: string, index: number) => {
-      if (key === '_uid') {
-        // 调用一次往内存里存一份
-        this.getUid();
-      } else {
-        // 往内存中赋值
-        this[key][trackingId] = values[index];
-      }
-    });
-  };
-
-  // 退出小程序时在存储中同步用户信息
-  saveUserInfo = () => {
-    const {
-      minipInstance,
-      dataStore: { trackersExecute }
-    } = this.growingIO;
-    trackersExecute((trackingId: string) => {
-      batchSetStorageSync(minipInstance, [
-        { key: this._getUidKey(), value: this._uid },
-        {
-          key: this._getUserIdKey(trackingId),
-          value: this._userId[trackingId]
-        },
-        {
-          key: this._getUserKeyKey(trackingId),
-          value: this._userKey[trackingId]
-        },
-        { key: this._getGioIdKey(trackingId), value: this._gioId[trackingId] }
-      ]);
-    });
-  };
-}
-
-export default UserStore;

package/src/index.ts

@@ -1,77 +0,0 @@
-import { initialCheck } from '@@/utils/verifiers';
-import { consoleText, getGlobal, niceTry } from '@@/utils/tools';
-import { drop, isString, toString } from '@@/utils/glodash';
-import {
-  HANDLERS,
-  DEPRECATED_HANDLERS,
-  INSTANCE_HANDLERS
-} from '@@/constants/config';
-import GrowingIO from './core/growingIO';
-
-const gioInstance: any = new GrowingIO();
-
-const gdp = function () {
-  const handlerName = arguments[0];
-  let trackingId = 'g0';
-  let handler = handlerName;
-  if (handlerName.indexOf('.') > -1) {
-    trackingId = handlerName.split('.')[0] ?? 'g0'; // 没有指定trackingId，默认为g0
-    handler = handlerName.split('.')[1];
-  }
-  // 判断指令为字符串且配置项中允许调用且实例中存在的方法
-  if (isString(handler) && HANDLERS.includes(handler) && gioInstance[handler]) {
-    const args = drop(Array.from(arguments));
-    // 初始化方法单独处理
-    if (handler === 'init') {
-      const initialCheckRes: any = initialCheck(gioInstance, args);
-      if (initialCheckRes) {
-        const { projectId, dataSourceId, appId, userOptions } = initialCheckRes;
-        // 返回初始化结果
-        return gioInstance.init({
-          ...userOptions,
-          projectId,
-          dataSourceId,
-          appId,
-          trackingId
-        });
-      } else {
-        return false;
-      }
-    } else if (handler === 'registerPlugins') {
-      gioInstance.registerPlugins(args[0]);
-    } else if (gioInstance.gioSDKInitialized && gioInstance.vdsConfig) {
-      if (INSTANCE_HANDLERS.includes(handler)) {
-        return niceTry(() =>
-          gioInstance.handlerDistribute(trackingId, handler, args)
-        );
-      } else {
-        return niceTry(() => gioInstance[handler](...args));
-      }
-    } else {
-      consoleText('SDK未初始化!', 'error');
-    }
-  } else if (DEPRECATED_HANDLERS.includes(handler)) {
-    consoleText(`方法 ${toString(handler)} 已被弃用，请移除!`, 'warn');
-  } else if (handler === 'canIUse') {
-    return HANDLERS.includes(arguments[1]) && !!gioInstance[arguments[1]];
-  } else {
-    consoleText(`不存在名为 ${toString(handler)} 的方法调用!`, 'error');
-  }
-};
-
-getGlobal().gdp = gdp;
-getGlobal().gioSDKVersion = gioInstance.sdkVersion;
-
-const {
-  growingApp,
-  growingPage,
-  growingComponent,
-  growingBehavior,
-  initOriginalValue
-} = gioInstance.dataStore.eventHooks;
-initOriginalValue();
-export const GioApp = niceTry(() => growingApp ?? App);
-export const GioPage = niceTry(() => growingPage ?? Page);
-export const GioComponent = niceTry(() => growingComponent ?? Component);
-export const GioBehavior = niceTry(() => growingBehavior ?? Behavior);
-export default gdp;

package/src/minipInstance/base.ts

@@ -1,352 +0,0 @@
-import { GrowingIOType } from '@@/types/growingIO';
-import {
-  AppSource,
-  Location,
-  MinipInstanceType,
-  NavigateToMiniProgramOption,
-  SystemInfo
-} from '@@/types/minipInstance';
-import { PLATFORMS } from '@@/types/platforms';
-import {
-  isFunction,
-  isObject,
-  isString,
-  last,
-  typeOf,
-  isEmpty,
-  isArray
-} from '@@/utils/glodash';
-import EMIT_MSG from '@@/constants/emitMsg';
-import {
-  limitString,
-  niceTry,
-  getPlainMinip,
-  getPlainPlatform,
-  getPlainConfig,
-  getPlainAppCode
-} 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(EMIT_MSG.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.configuredTitle[
-              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) => {
-    const platform = getPlainPlatform();
-    let title = '';
-    let instConfig = getPlainConfig(platform);
-    if (typeOf(instConfig) === 'string') {
-      instConfig = niceTry(() => JSON.parse(instConfig)) ?? {};
-    }
-    // 第一优先级在base中的hook setNavigationBarTitle设置的值(在dataStore page实例中实现，准确率最高)
-    // 第二优先级支持客户自己在页面中设置页面title（保持3.8的向下兼容，不准确但优先级高）
-    const data = page?.data || page.$data || {};
-    title = isString(data?.gioPageTitle) ? data?.gioPageTitle : '';
-
-    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 = page.route
-          ? this._getTitleFromTabBar(instConfig, page.route)
-          : '';
-      }
-
-      // 第五优先级存在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`] || instPage;
-          title =
-            pageInfo?.navigationBarTitleText ||
-            pageInfo?.window?.navigationBarTitleText;
-        }
-      }
-
-      // 第六优先级取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);
-  };
-
-  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 || '';
-  };
-
-  /**
-   * 存储相关
-   */
-  // 同步获取存储数据
-  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,
-      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 });
-    });
-  };
-
-  // 监听网络变更
-  setNetworkStatusListener = () => {
-    this.minip?.onNetworkStatusChange(({ networkType }) => {
-      if (networkType) {
-        this.network.networkType = networkType;
-      }
-    });
-  };
-}
-
-export default BaseInstance;