gio-miniprogram-sdk 4.0.1 → 4.2.0

package/src/utils/tools.ts

@@ -1,8 +1,12 @@
+import { IMP_EVENTNAME_REG } from '@@/constants/regex';
 import {
+  compact,
   find,
   forEach,
+  formatDate,
   head,
   isArray,
+  isDate,
   isEmpty,
   isFunction,
   isNil,
@@ -11,7 +15,8 @@ import {
   keys,
   split,
   startsWith,
-  toString
+  toString,
+  unset
 } from '@@/utils/glodash';
 
 // 控制台打印提示信息，包含错误、警告和信息3种形式
@@ -62,7 +67,7 @@ export const eventNameValidate = (eventName: string, callback: () => void) => {
   if (
     isString(eventName) &&
     !isEmpty(eventName) &&
-    eventName.match(/^[a-zA-Z_][0-9a-zA-Z_]{0,100}$/)
+    eventName.match(IMP_EVENTNAME_REG)
   ) {
     return callback();
   } else {
@@ -74,6 +79,22 @@ export const eventNameValidate = (eventName: string, callback: () => void) => {
   }
 };
 
+// 获取动态属性的值
+export const getDynamicAttributes = (properties: any) => {
+  if (!isNil(properties)) {
+    keys(properties).forEach((k: string) => {
+      if (isFunction(properties[k])) {
+        properties[k] = niceTry(() => properties[k]());
+      } else if (isObject(properties[k])) {
+        unset(properties, k);
+      } else if (!isArray(properties[k])) {
+        properties[k] = toString(properties[k]);
+      }
+    });
+  }
+  return properties;
+};
+
 // 生成uuid
 export const guid = () => {
   return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
@@ -132,7 +153,7 @@ export const compareVersion = (v1 = '', v2 = '') => {
 // 获取vue的主版本号
 export const getVueVersion = (vue) => {
   if (vue) {
-    const mv = Number.parseInt(head(split(vue.version, '.')), 10);
+    const mv = Number(head(split(vue.version, '.')));
     return Number.isNaN(mv) ? 0 : mv;
   } else {
     return 0;
@@ -282,13 +303,17 @@ export const getGlobal = () => {
 export const limitObject = (o: any) => {
   const ob = {};
   if (isObject(o)) {
+    // 移除预置的'&&sendTo'字段
+    unset(o, '&&sendTo');
     forEach(o, (v, k) => {
       const key = toString(k).slice(0, 100);
       if (isObject(v)) {
         ob[key] = limitObject(v);
       } else if (isArray(v)) {
-        ob[key] = v.slice(0, 100);
+        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) : '';
       }
@@ -368,7 +393,7 @@ export const qsParse = (s: string) => {
 };
 
 // 将字符串转为hash
-export const hashCode = (string) => {
+export const hashCode = (string: string, abs = false) => {
   let hash = 0;
   if (isEmpty(string) || typeof string === 'boolean') {
     return hash;
@@ -380,5 +405,5 @@ export const hashCode = (string) => {
     hash = hash & hash; //Convert to 32bit integer
     i++;
   }
-  return hash;
+  return abs ? Math.abs(hash) : hash;
 };

package/src/utils/verifiers.ts

@@ -1,9 +1,9 @@
 /**
  * 代码中一些通用的或者业务上的校验器
  */
-import { GrowingIOType } from '@@/types/growingIO';
-import { compact, isNumber, isObject, isString, last } from '@@/utils/glodash';
 import { consoleText } from '@@/utils/tools';
+import { GrowingIOType } from '@@/types/growingIO';
+import { isNumber, isString, toString } from '@@/utils/glodash';
 
 /**
  * 一些id的合法性校验
@@ -18,59 +18,34 @@ export const verifyId = (o: string | number) =>
  * 初始化时的一些合法性校验
  */
 
-export const initPreCheck = (growingIO: GrowingIOType) => {
-  // 重复初始化校验
-  if (growingIO.vdsConfig || growingIO.gioSDKInitialized) {
+export const initialCheck = (growingIO: GrowingIOType, args: any) => {
+  // ?重复初始化由init方法内部判断
+  const projectId = toString(args[0]);
+  const dataSourceId = toString(args[1]);
+  // 参数为空校验
+  const userOptions = (args.length === 4 ? args[3] : args[2]) || {};
+  if (!projectId || !dataSourceId) {
     consoleText(
-      'SDK重复初始化，请检查是否重复加载SDK或接入其他平台SDK导致冲突!',
-      'warn'
-    );
-    return false;
-  }
-  return true;
-};
-
-// 参数为空校验
-export const paramsEmptyCheck = (args: any) => {
-  if (!compact(args)) {
-    consoleText(
-      'SDK初始化失败，请使用 gdp("init", "您的GrowingIO项目 accountId", "您项目的 dataSourceId", "你的应用 AppId", options); 进行初始化!',
+      'SDK初始化失败，请使用 gdp("init", "您的GrowingIO项目 accountId", "您项目的 dataSourceId", "您的小程序 AppId（可选）", options: { host: "您的数据上报地址host" }); 进行初始化!',
       'error'
     );
     return false;
   }
-  return true;
-};
-
-// 基础参数校验（projectId、userOptions）
-export const paramsBaseCheck = (args: any) => {
-  const projectId: string = args[0];
-  let userOptions: object = last(args);
-  // 参数校验（projectId）
-  if (!verifyId(projectId)) {
-    consoleText('SDK初始化失败，accountId 参数不合法!', 'error');
-    return false;
-  }
-  // 参数校验（userOptions）
-  if (!isObject(userOptions) || !userOptions) {
-    userOptions = {};
-  }
-  return { projectId, userOptions };
-};
-
-// 额外的参数校验（校验dataSourceId、AppId）
-export const paramExtraCheck = (args: any) => {
-  // 参数校验（dataSourceId）
-  const dataSourceId: string = args[1];
-  let appId: any = args[2];
-  const options: any = last(args);
-  if (!dataSourceId || !isString(dataSourceId)) {
-    consoleText('SDK初始化失败，dataSourceId 参数不合法!', 'error');
-    return false;
-  }
-  if (!verifyId(appId)) {
-    consoleText('SDK初始化失败，appId 参数不合法!', 'error');
+  const gioSDKInitialized = growingIO.dataStore.initializedTrackingIds.some(
+    (tid: string, index: number) => {
+      const vds =
+        index === 0 ? growingIO.vdsConfig : growingIO.subInstance[tid];
+      return vds.projectId === projectId && vds.dataSourceId === dataSourceId;
+    }
+  );
+  if (gioSDKInitialized) {
+    consoleText('SDK初始化失败，重复初始化，请检查初始化参数!', 'error');
     return false;
   }
-  return { dataSourceId, appId, options };
+  return {
+    projectId,
+    dataSourceId,
+    appId: toString(args.length === 4 ? args[2] : ''),
+    userOptions
+  };
 };

package/typings/global.d.ts

@@ -46,6 +46,11 @@ declare module "__GIO_PLATFORM_INSTANCE__" {
   export default module;
 }
 
+declare module "__GIO_PLUGIN_INSTANCE__" {
+  let module: any;
+  export default module;
+}
+
 declare module "@system.app" {
   let module: any;
   export default module;

package/.babelrc

@@ -1,4 +0,0 @@
-{
-  // "presets": ["@babel/preset-env"],
-  "plugins": ["babel-plugin-bulk-import"]
-}

package/bin/build/full.sh

@@ -1,32 +0,0 @@
-### 全量打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 框架适配插件
-cp src/pluginsOut/frameworks/gioTaroAdapter.ts src/pluginsIn/gioTaroAdapter.ts
-cp src/pluginsOut/frameworks/gioUniAppAdapter.ts src/pluginsIn/gioUniAppAdapter.ts
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 无埋点插件
-cp src/pluginsOut/ordinary/gioEventAutoTracking.ts src/pluginsIn/gioEventAutoTracking.ts
-# 加密插件
-cp src/pluginsOut/ordinary/gioCompress.ts src/pluginsIn/gioCompress.ts
-# 曝光插件
-cp src/pluginsOut/ordinary/gioImpressionTracking.ts src/pluginsIn/gioImpressionTracking.ts
-# 打包
-rollup -c rollup.config.js --framework-full
-# 移除框架适配插件
-rm src/pluginsIn/gioTaroAdapter.ts
-rm src/pluginsIn/gioUniAppAdapter.ts
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts
-# 移除无埋点插件
-rm src/pluginsIn/gioEventAutoTracking.ts
-# 移除加密插件
-rm src/pluginsIn/gioCompress.ts
-# 移除曝光插件
-rm src/pluginsIn/gioImpressionTracking.ts

package/bin/build/jd.sh

@@ -1,14 +0,0 @@
-### 原生京东小程序打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --jd
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/ks.sh

@@ -1,14 +0,0 @@
-### 原生快手小程序打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --ks
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/my.sh

@@ -1,14 +0,0 @@
-### 原生阿里小程序打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --my
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/plugins.sh

@@ -1,5 +0,0 @@
-# 清空原产物
-rm -r dist/plugins/*
-
-# 打包插件
-rollup -c rollup.plugins.config.js --ordinary

package/bin/build/qq.sh

@@ -1,14 +0,0 @@
-### 原生QQ小程序打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --qq
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/quickapp.sh

@@ -1,14 +0,0 @@
-### 原生快应用打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --quickapp
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/swan.sh

@@ -1,14 +0,0 @@
-### 原生百度小程序打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --swan
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/taro.sh

@@ -1,18 +0,0 @@
-### Taro打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 框架适配插件
-cp src/pluginsOut/frameworks/gioTaroAdapter.ts src/pluginsIn/gioTaroAdapter.ts
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --framework-taro
-# 移除框架适配插件
-rm src/pluginsIn/gioTaroAdapter.ts
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/tb.sh

@@ -1,18 +0,0 @@
-### 原生淘宝小程序打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 淘宝小程序上报适配插件
-cp src/pluginsOut/frameworks/gioTaobaoAdapter.ts src/pluginsIn/gioTaobaoAdapter.ts
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --tb
-# 移除淘宝小程序上报适配插件
-rm src/pluginsIn/gioTaobaoAdapter.ts
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/tt.sh

@@ -1,14 +0,0 @@
-### 原生字节小程序打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --tt
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/uniapp.sh

@@ -1,18 +0,0 @@
-### UniApp打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 框架适配插件
-cp src/pluginsOut/frameworks/gioUniAppAdapter.ts src/pluginsIn/gioUniAppAdapter.ts
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --framework-uniapp
-# 移除框架适配插件
-rm src/pluginsIn/gioUniAppAdapter.ts
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/bin/build/wx.sh

@@ -1,14 +0,0 @@
-### 原生微信小程序打包逻辑
-
-# 新建plugins目录
-mkdir -p src/pluginsIn
-# 移除已有文件
-rm src/pluginsIn/*
-
-### 打包逻辑
-# 埋点插件
-cp src/pluginsOut/ordinary/gioCustomTracking.ts src/pluginsIn/gioCustomTracking.ts
-# 打包
-rollup -c rollup.config.js --wx
-# 移除埋点插件
-rm src/pluginsIn/gioCustomTracking.ts

package/src/core/plugins.ts

@@ -1,152 +0,0 @@
-// @ts-nocheck
-import { GrowingIOType } from '@@/types/growingIO';
-import { PluginItem, PluginsType } from '@@/types/plugins';
-import { isEmpty, isFunction, keys, lowerFirst, unset } from '@@/utils/glodash';
-import { consoleText } from '@@/utils/tools';
-
-import * as pluginsContext from '../pluginsIn/*.ts';
-
-class Plugins implements PluginsType {
-  public pluginItems: PluginItem[];
-  constructor(public growingIO: GrowingIOType) {
-    this.pluginItems = [];
-    this.growingIO.emitter.on('onComposeBefore', this.onComposeBefore);
-    this.growingIO.emitter.on('onComposeAfter', this.onComposeAfter);
-    this.growingIO.emitter.on('onSendBefore', this.onSendBefore);
-    this.growingIO.emitter.on('onSendAfter', this.onSendAfter);
-  }
-
-  // 初始化内置插件，不允许客户自己热插拔的插件，内置打包完成
-  innerPluginInit = () => {
-    keys(pluginsContext.pluginsIn).forEach((key) => {
-      const { name, method }: { name: string; method: any } =
-        pluginsContext.pluginsIn[key];
-      // 若列表中出现同名插件，以第一个扫描出来的插件为准
-      const isExist = this.pluginItems.find((o) => o.name === name);
-      if (!isExist) {
-        this.pluginItems.push({
-          // 优先使用指定插件名
-          name: lowerFirst(name || key),
-          method: method ? method : (growingIO) => {} // eslint-disable-line
-        });
-      }
-    });
-    if (!isEmpty(this.pluginItems)) {
-      this.installAll();
-    }
-  };
-
-  // 挂载插件
-  install = (pluginName: string, pluginItem?: any, options?: any): boolean => {
-    const pluginTarget: PluginItem =
-      pluginItem ||
-      this.pluginItems.find((o: PluginItem) => o.name === pluginName);
-    // 插件已加载或与已加载的插件重名
-    if (this.growingIO?.plugins[pluginName]) {
-      consoleText(`重复加载插件 ${pluginName} 或插件重名，已跳过加载!`, 'warn');
-      return false;
-    }
-    // 插件列表中不存在要加载的插件
-    if (!pluginTarget) {
-      consoleText(`插件加载失败!不存在名为 ${pluginName} 的插件!`, 'error');
-      return false;
-    }
-    // 将插件实例挂载到growingIO实例上使得其他模块可以调用
-    try {
-      this.growingIO.plugins[pluginName] = new pluginTarget.method(
-        this.growingIO,
-        options
-      );
-      if (pluginItem) {
-        consoleText(`加载插件：${pluginName}`, 'info');
-      }
-      return true;
-    } catch (error) {
-      consoleText(`插件【${pluginName}】加载异常 ${error}`, 'error');
-      return false;
-    }
-  };
-
-  // 挂载所有插件
-  installAll = (plugins: PluginItem[]) => {
-    (plugins || this.pluginItems).forEach((o: PluginItem) =>
-      this.install(o.name, plugins ? o : undefined, o.options)
-    );
-  };
-
-  // 移除插件
-  uninstall = (pluginName: string): boolean => {
-    unset(this.pluginItems, pluginName);
-    const u = unset(this.growingIO?.plugins, pluginName);
-    if (!u) {
-      consoleText(`卸载插件 ${pluginName} 失败!`, 'error');
-    }
-    return u;
-  };
-
-  // 移除所有插件
-  uninstallAll = () => {
-    this.pluginItems.forEach((o: PluginItem) => this.uninstall(o.name));
-  };
-
-  lifeError = (p: PluginItem, e: any) =>
-    consoleText(`插件执行错误 ${p.name} ${e}`, 'error');
-
-  // 触发生命周期事件（事件合成前）
-  onComposeBefore = (args: any) => {
-    this.pluginItems.forEach((o: PluginItem) => {
-      const method = this.growingIO.plugins[o.name]?.onComposeBefore;
-      if (method && isFunction(method)) {
-        try {
-          method(args);
-        } catch (e) {
-          this.lifeError(o, e);
-        }
-      }
-    });
-  };
-
-  // 触发生命周期事件（事件合成后）
-  onComposeAfter = (args: any) => {
-    this.pluginItems.forEach((o: PluginItem) => {
-      const method = this.growingIO.plugins[o.name]?.onComposeAfter;
-      if (method && isFunction(method)) {
-        try {
-          method(args);
-        } catch (e) {
-          this.lifeError(o, e);
-        }
-      }
-    });
-  };
-
-  // 触发生命周期事件（事件发送前）
-  onSendBefore = (args: any) => {
-    this.pluginItems.forEach((o: PluginItem) => {
-      const method = this.growingIO.plugins[o.name]?.onSendBefore;
-      if (method && isFunction(method)) {
-        try {
-          method(args);
-        } catch (e) {
-          this.lifeError(o, e);
-        }
-      }
-    });
-  };
-
-  // 触发生命周期事件（事件发送后）
-  onSendAfter = (args: any) => {
-    this.pluginItems.forEach((o: PluginItem) => {
-      const method = this.growingIO.plugins[o.name]?.onSendAfter;
-      if (method && isFunction(method)) {
-        try {
-          method(args);
-        } catch (e) {
-          this.lifeError(o, e);
-        }
-      }
-    });
-  };
-}
-
-export default Plugins;

package/src/pluginsOut/ordinary/gioCustomTracking.ts

@@ -1,71 +0,0 @@
-/**
- * 名称：自定义埋点插件
- * 用途：用于提供自定义埋点的事件构建方法。
- */
-import { GioCustomTrackingType } from '@@/types/gioCustomTracking';
-import { GrowingIOType } from '@@/types/growingIO';
-
-let ut;
-class GioCustomTracking implements GioCustomTrackingType {
-  constructor(public growingIO: GrowingIOType) {
-    ut = this.growingIO.utils;
-  }
-
-  // 获取动态属性的值
-  getDynamicAttributes = (properties: any) => {
-    if (!ut.isNil(properties)) {
-      ut.keys(properties).forEach((k: string) => {
-        if (ut.isFunction(properties[k])) {
-          properties[k] = properties[k]();
-        } else if (!ut.isArray(properties[k])) {
-          properties[k] = ut.toString(properties[k]);
-        }
-      });
-    }
-    return properties;
-  };
-
-  // 构建自定义埋点事件
-  buildCustomEvent = (name: string, properties: { [key: string]: string }) => {
-    ut.eventNameValidate(name, () => {
-      const {
-        dataStore: { eventContextBuilder, eventInterceptor }
-      } = this.growingIO;
-      const event = {
-        eventType: 'CUSTOM',
-        eventName: name,
-        attributes: ut.limitObject(
-          this.getDynamicAttributes(
-            ut.isObject(properties) && !ut.isEmpty(properties)
-              ? properties
-              : undefined
-          )
-        ),
-        ...eventContextBuilder()
-      };
-      eventInterceptor(event);
-    });
-  };
-
-  // 构建用户变量事件
-  buildUserAttributesEvent = (attributes: { [key: string]: string }) => {
-    const {
-      dataStore: { eventContextBuilder, eventInterceptor, lastVisitEvent }
-    } = this.growingIO;
-    const event = {
-      eventType: 'LOGIN_USER_ATTRIBUTES',
-      attributes: ut.limitObject(attributes),
-      ...eventContextBuilder()
-    };
-    // 该方法很可能被放在在app的onShow中的wx.login异步回调中，
-    // 此时页面的path和query可能还没取到，就拿visit事件的path和query补上
-    if (!event.path) {
-      event.path = lastVisitEvent.path;
-      event.query = lastVisitEvent.query;
-      event.title = lastVisitEvent.title;
-    }
-    eventInterceptor(event);
-  };
-}
-
-export default { name: 'gioCustomTracking', method: GioCustomTracking };

package/bin/{build/all.sh → build.sh}

@@ -1,9 +1,6 @@
 # 清空产物
 rm -r dist/*
 
-# 插件
-npm run build:plugins
-
 # 微信小程序
 npm run build:wx
 
@@ -36,3 +33,6 @@ npm run build:uniapp
 
 # taro2/3 react/vue2/vue3
 npm run build:taro
+
+# 插件
+npm run build:plugins