gio-miniprogram-sdk 4.4.2 → 4.5.0

package/src/utils/tools.ts

@@ -1,511 +0,0 @@
-import { IMP_EVENTNAME_REG } from '@@/constants/regex';
-import {
-  compact,
-  find,
-  forEach,
-  formatDate,
-  has,
-  head,
-  isArray,
-  isDate,
-  isEmpty,
-  isFunction,
-  isNil,
-  isObject,
-  isString,
-  keys,
-  split,
-  startsWith,
-  toString,
-  unset
-} from '@@/utils/glodash';
-
-// 控制台打印提示信息，包含错误、警告和信息3种形式
-export const consoleText = (
-  msg: string,
-  type?: 'info' | 'success' | 'error' | 'warn'
-) => {
-  const styles = {
-    info: 'color: #3B82F6;',
-    error: 'color: #EF4444',
-    warn: 'color: #F59E0B',
-    success: 'color: #10B981'
-  };
-  console.log(`%c[GrowingIO]：${msg}`, styles[type] || '');
-};
-
-// 失败提示
-export const callError = (fn: string, type = true, msg = '参数不合法') =>
-  consoleText(`${type ? '调用' : '设置'} ${fn} 失败，${msg}!`, 'warn');
-
-// 优化过的try...catch包裹体
-export const niceTry = (fn: Function) => {
-  try {
-    return fn();
-  } catch (e) {
-    return undefined;
-  }
-};
-
-// 封装过的调用callback的方法
-export const niceCallback = (cb: Function, cbv?: any) => {
-  if (isFunction(cb)) {
-    try {
-      cb(cbv);
-    } catch (error) {
-      consoleText(`回调执行失败！${error}`, 'error');
-    }
-  }
-};
-
-// 限制处理字符串
-export const limitString = (s: string) => {
-  return isString(s) ? s.trim().substring(0, 100) : s;
-};
-
-// 埋点事件名校验
-export const eventNameValidate = (eventName: string, callback: () => void) => {
-  if (
-    isString(eventName) &&
-    !isEmpty(eventName) &&
-    eventName.match(IMP_EVENTNAME_REG)
-  ) {
-    return callback();
-  } else {
-    consoleText(
-      '事件名格式不正确，只能包含数字、字母和下划线，且不能以数字开头，字符总长度不能超过100!',
-      'error'
-    );
-    return false;
-  }
-};
-
-// 获取动态属性的值
-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) {
-    const r = (Math.random() * 16) | 0,
-      v = c === 'x' ? r : (r & 0x3) | 0x8;
-    return v.toString(16);
-  });
-};
-
-export const getScreenHeight = (info) => {
-  if (info.pixelRatio) {
-    return Math.round(info.screenHeight * info.pixelRatio);
-  }
-  return info.screenHeight;
-};
-
-export const getScreenWidth = (info) => {
-  if (info.pixelRatio) {
-    return Math.round(info.screenWidth * info.pixelRatio);
-  }
-  return info.screenWidth;
-};
-
-export const getOS = (system: any, configName: string) => {
-  if (system) {
-    const lowsys = system.toLowerCase();
-    if (lowsys.indexOf('android') !== -1) {
-      return `${configName}-Android`;
-    } else if (lowsys.indexOf('ios') !== -1) {
-      return `${configName}-iOS`;
-    } else if (
-      lowsys.indexOf('harmonyos') !== -1 ||
-      lowsys.indexOf('ohos') !== -1
-    ) {
-      return `${configName}-HarmonyOS`;
-    } else {
-      return `${configName}-${system}`;
-    }
-  }
-};
-
-// 比较两个正式的版本号，v1>v2返回1，v1<v2返回-1，v1=v2返回0
-export const compareVersion = (v1 = '', v2 = '') => {
-  const rpSpace = (s) => s.replace(/\s+/g, '');
-  const rpV = (s) => s.replace(/[vV]/g, '');
-  const nv1 = rpSpace(rpV(v1));
-  const nv2 = rpSpace(rpV(v2));
-  const nv1Array = nv1.split('.');
-  const nv2Array = nv2.split('.');
-  for (let i = 0; i < 3; i++) {
-    let na = Number(nv1Array[i]);
-    let nb = Number(nv2Array[i]);
-    if (na > nb) return 1;
-    if (nb > na) return -1;
-    if (!isNaN(na) && isNaN(nb)) return 1;
-    if (isNaN(na) && !isNaN(nb)) return -1;
-  }
-  return 0;
-};
-
-// 获取vue的主版本号
-export const getVueVersion = (vue) => {
-  if (vue) {
-    const mv = Number(head(split(vue.version, '.')));
-    return Number.isNaN(mv) ? 0 : mv;
-  } else {
-    return 0;
-  }
-};
-
-export const splitPath = (fullPath?: string): [string | undefined, string] => {
-  if (isString(fullPath)) {
-    const idx = fullPath.indexOf('?');
-    if (idx !== -1) {
-      const path = fullPath.substring(0, idx);
-      const query = fullPath.substring(idx + 1);
-      return [path, query];
-    } else {
-      return [fullPath, ''];
-    }
-  } else {
-    return ['', ''];
-  }
-};
-
-export const normalPath = (path: string): string => {
-  if (isString(path)) {
-    return path.startsWith('/') ? path : `/${path}`;
-  } else {
-    return '';
-  }
-};
-
-// 判断是否为Taro3环境
-export const isTaro3 = (taro: any): boolean => {
-  const { Current, createComponent } = taro;
-  if (taro && Current && !createComponent) {
-    return true;
-  } else {
-    return false;
-  }
-};
-
-export const getPlainMinip = (platform?: string) => {
-  return niceTry(() => {
-    switch (platform) {
-      // 指定平台获取实例
-      case 'wx':
-        return wx;
-      case 'my':
-      // 淘宝小程序和支付宝小程序共用my对象
-      case 'tb':
-        return my;
-      case 'swan':
-        return swan;
-      case 'tt':
-        return tt;
-      case 'qq':
-        return qq;
-      case 'ks':
-        return ks;
-      case 'jd':
-        return jd;
-      case 'xhs':
-        return xhs;
-      // 第三方框架下自动获取实例
-      // 百度等小程序中可能存在封装过的wx对象，因此wx要放在最后判断
-      default: {
-        let minip;
-        if (!minip) minip = niceTry(() => xhs);
-        if (!minip) minip = niceTry(() => swan);
-        if (!minip) minip = niceTry(() => my);
-        if (!minip) minip = niceTry(() => tt);
-        if (!minip) minip = niceTry(() => qq);
-        if (!minip) minip = niceTry(() => ks);
-        if (!minip) minip = niceTry(() => jd);
-        if (!minip) minip = niceTry(() => wx);
-        return minip;
-      }
-    }
-  });
-};
-
-export const getPlainConfig = (platform?: string) => {
-  return niceTry(() => {
-    switch (platform) {
-      // 指定平台获取实例
-      case 'wx':
-        return __wxConfig;
-      case 'swan':
-        return appConfig;
-      case 'tt':
-        return (
-          niceTry(() => __ttConfig) ||
-          global?.TMAConfig ||
-          globalThis?.TMAConfig
-        ); // 可能会拿不到
-      case 'qq':
-        return __qqConfig;
-      case 'ks':
-        return __ksConfig; // 新版快手小程序已经拿不到了
-      case 'jd':
-        return __jdConfig;
-      case 'xhs':
-        return __MP_APP_JSON_MIGRATION__ ?? __MP_APP_JSON__;
-      // 第三方框架下自动获取实例
-      default:
-        // 支付宝和淘宝不存在可获取的全局对象
-        return undefined;
-    }
-  });
-};
-
-export const getPlainAppCode = (platform?: string) => {
-  return niceTry(() => {
-    switch (platform) {
-      // 指定平台获取实例
-      case 'wx':
-      case 'qq':
-        return __wxAppCode__;
-      case 'tt':
-        return __allConfig__;
-      case 'ks':
-        return __module__;
-      case 'jd':
-        return __jdAppCode__;
-      default:
-        return undefined;
-    }
-  });
-};
-
-// 在框架下自动获取当前平台值
-export const getPlainPlatform = () => {
-  // 百度等小程序中可能存在封装过的wx对象，因此wx要放在最后判断
-  let platform;
-  if (!platform && niceTry(() => xhs)) platform = 'xhs';
-  if (!platform && niceTry(() => swan)) platform = 'swan';
-  if (!platform && niceTry(() => tt)) platform = 'tt';
-  if (!platform && niceTry(() => qq)) platform = 'qq';
-  if (!platform && niceTry(() => my.tb)) platform = 'tb';
-  if (!platform && niceTry(() => my)) platform = 'my';
-  if (!platform && niceTry(() => ks)) platform = 'ks';
-  if (!platform && niceTry(() => jd)) platform = 'jd';
-  if (!platform && niceTry(() => wx)) platform = 'wx';
-  if (!platform) {
-    const quickappExist = !!find(keys(global), (o) =>
-      toString(o).toLowerCase().includes('quickapp')
-    );
-    if (quickappExist) {
-      platform = 'quickapp';
-    }
-  }
-  return platform;
-};
-
-// 获取当前分包在全局中的key值
-export const getSubKeys = (app: any) => {
-  return keys(app)
-    .filter((o) => o.indexOf('__sub') > -1 && o.indexOf('gio__') > -1)
-    .sort();
-};
-
-// 获取app实例
-export const getAppInst = () => {
-  let app = niceTry(() => getApp({ allowDefault: true }));
-  // 阿里小程序中不支持getApp提前调用，所以只能把gio实例存在global当中
-  // 获取不到app实例的一律把gio实例存在global当中
-  if (!app) {
-    app = getGlobal();
-  }
-  return app;
-};
-
-export const getGlobal = () => {
-  return (
-    niceTry(() => niceTry(() => niceTry(() => $global) ?? global) ?? window) ??
-    globalThis
-  );
-};
-
-// Object参数限制
-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] = 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) : '';
-      }
-    });
-  }
-  return ob;
-};
-
-// 批量获取存储中的数据，减少性能影响
-export const batchGetStorageSync = (minipInstance: any, keys: string[]) => {
-  const batchFunction = () => {
-    return minipInstance.minip.batchGetStorageSync(keys);
-  };
-  const singleFunction = () => {
-    return keys.map((key: string) => minipInstance.getStorageSync(key));
-  };
-  // 优先使用批量接口（目前仅支持wx）
-  try {
-    if (minipInstance.minip.canIUse('batchGetStorageSync')) {
-      return batchFunction();
-    } else {
-      return singleFunction();
-    }
-  } catch (error) {
-    return singleFunction();
-  }
-};
-
-// 批量存储数据，减少性能影响
-export const batchSetStorageSync = (minipInstance: any, kvList: any[]) => {
-  const batchFunction = () => {
-    return minipInstance.minip.batchSetStorageSync(kvList);
-  };
-  const singleFunction = () => {
-    return kvList.map(({ key, value }: any) =>
-      minipInstance.setStorageSync(key, value)
-    );
-  };
-  // 优先使用批量接口（目前仅支持wx）
-  try {
-    if (minipInstance.minip.canIUse('batchSetStorageSync')) {
-      return batchFunction();
-    } else {
-      return singleFunction();
-    }
-  } catch (error) {
-    return singleFunction();
-  }
-};
-
-// 将参数对象转为参数字符串
-export const qsStringify = (query: any) => {
-  return keys(query || {})
-    .map((key) => {
-      if (key) {
-        return `${key}=${isNil(query[key]) ? '' : query[key]}`;
-      } else {
-        return '';
-      }
-    })
-    .join('&');
-};
-
-// 解析参数
-export const qsParse = (s: string) => {
-  if (startsWith(s, '?') || startsWith(s, '&')) {
-    s = s.slice(1, s.length);
-  }
-  const qsObject = {};
-  s.split('&').forEach((pairs: string) => {
-    const pair = pairs.split('=');
-    if (pair[0]) {
-      qsObject[pair[0]] = pair[1];
-    }
-  });
-  return qsObject;
-};
-
-// 将字符串转为hash
-export const hashCode = (string: string, abs = false) => {
-  let hash = 0;
-  if (isEmpty(string) || typeof string === 'boolean') {
-    return hash;
-  }
-  let i = 0;
-  while (i < string.length) {
-    const char = string.charCodeAt(i);
-    hash = (hash << 5) - hash + char;
-    hash = hash & hash; //Convert to 32bit integer
-    i++;
-  }
-  return abs ? Math.abs(hash) : hash;
-};
-
-export const getExtraData = (data: any) => {
-  if (isString(data)) {
-    return niceTry(() => JSON.parse(data)) ?? {};
-  } else {
-    return data ?? {};
-  }
-};
-
-/**
- * 清理参数中的非法字段
- * @param originQuery 原始查询参数，可以是对象或参数字符串
- * @param extraData 额外数据，可以是对象或参数字符串
- * @returns 清理后的纯净参数对象
- */
-const dirtyKey = [
-  'wxShoppingListScene',
-  '$taroTimestamp',
-  'gdpCircleRoomCollectUrl'
-];
-export const getPureParams = (originQuery: any = {}, extraData: any = {}) => {
-  // 处理originQuery可能是字符串的情况
-  const parsedOriginQuery =
-    typeof originQuery === 'string' ? qsParse(originQuery) : originQuery || {};
-
-  // 递归清理函数
-  function cleanObject(obj, needCompare) {
-    if (typeof obj !== 'object' || obj === null || Array.isArray(obj)) {
-      return obj;
-    }
-
-    const result = {};
-
-    keys(obj).forEach((key) => {
-      // 检查key是否包含dirtyKey中的任何字符串
-      const isKeyDirty = dirtyKey.some((dirty) => key.includes(dirty));
-      const isKeyExist = has(parsedOriginQuery, key);
-
-      if (!isKeyDirty && (needCompare ? !isKeyExist : true)) {
-        const value = obj[key];
-
-        // 检查value是否是字符串且包含dirtyKey中的任何字符串
-        if (typeof value === 'string') {
-          const isValueDirty = dirtyKey.some((dirty) => value.includes(dirty));
-          if (!isValueDirty) {
-            result[key] = value;
-          }
-        }
-        // 如果是数字和布尔值，直接保留，其他类型丢弃
-        else if (typeof value === 'number' || typeof value === 'boolean') {
-          result[key] = value;
-        }
-      }
-    });
-
-    return result;
-  }
-
-  return Object.assign(
-    {},
-    cleanObject(parsedOriginQuery, false),
-    cleanObject(extraData, true)
-  );
-};

package/src/utils/verifiers.ts

@@ -1,52 +0,0 @@
-/**
- * 代码中一些通用的或者业务上的校验器
- */
-import { consoleText } from '@@/utils/tools';
-import { GrowingIOType } from '@@/types/growingIO';
-import { isNumber, isString, toString } from '@@/utils/glodash';
-
-/**
- * 一些id的合法性校验
- * @param id // 只允许数字和字符串，不允许为空字符串、0、负数、短横线字符串null,undefined
- */
-
-export const verifyId = (o: string | number) =>
-  ((isString(o) && (o as string).length > 0) ||
-    (isNumber(o) && (o as number) > 0)) &&
-  !['-', 'null', 'undefined'].includes(o as string);
-
-/**
- * 初始化时的一些合法性校验
- */
-
-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初始化失败，请使用 gdp("init", "您的GrowingIO项目 accountId", "您项目的 dataSourceId", "您的小程序 AppId（可选）", options: { serverUrl: "您的数据上报地址" }); 进行初始化!',
-      'error'
-    );
-    return false;
-  }
-  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 {
-    projectId,
-    dataSourceId,
-    appId: toString(args.length === 4 ? args[2] : ''),
-    userOptions
-  };
-};

package/tsconfig.json

@@ -1,32 +0,0 @@
-{
-  "compilerOptions": {
-    "removeComments": true,
-    "allowSyntheticDefaultImports": true,
-    "allowUnreachableCode": true,
-    "baseUrl": "./",
-    "esModuleInterop": true,
-    "noImplicitAny": false,
-    "module": "es6",
-    "moduleResolution": "Node",
-    "preserveConstEnums": false,
-    "sourceMap": true,
-    "strict": false,
-    "lib": ["DOM", "ES5", "ES6", "ES2016", "ES2017"],
-    "target": "ES5",
-    "types": ["node", "webpack-env"],
-    "paths": {
-      "@@/*": ["src/*"]
-    }
-  },
-  "exclude": ["./node_modules", "./dist"],
-  "include": [
-    "./src/*.ts",
-    "./src/**/*.ts",
-    "./src/**/**/*.ts",
-    "./typings/*.d.ts"
-  ],
-  "typedocOptions": {
-    "mode": "modules",
-    "out": "docs"
-  }
-}

package/typings/global.d.ts

@@ -1,105 +0,0 @@
-declare interface Window {
-  gioSdkInstalled: boolean;
-  gio: any;
-  GioApp: any;
-  GioPage: any;
-  GioComponent: any;
-}
-
-declare var global: any;
-declare var $global: any;
-declare var document: Document;
-declare var App: any;
-declare var Page: any;
-declare var Component: any;
-declare var Behavior: any;
-declare var SelectorQuery: any;
-declare var getApp: any;
-
-// platform
-declare var wx: any;
-declare var swan: any;
-declare var my: any;
-declare var qq: any;
-declare var tt: any;
-declare var ks: any;
-declare var jd: any;
-declare var xhs: any;
-declare var quickapp: any;
-declare var __wxAppCode__: any;
-declare var __wxConfig: any;
-declare var appConfig: any; // swan的全局配置
-declare var __myConfig: any; // my的全局配置
-declare var TMAConfig: any; // tt的全局配置
-declare var __ttConfig: any; // tt的全局配置
-declare var __allConfig__: any;
-declare var __qqConfig: any; // qq的全局配置
-declare var __ksConfig: any; // ks的全局配置
-declare var __module__: any;
-declare var __jdConfig: any; // jd的全局配置
-declare var __jdAppCode__: any; 
-declare var __MP_APP_JSON_MIGRATION__: any; // xhs的全局配置
-declare var __MP_APP_JSON__: any; // xhs的全局配置
-declare var __proto__: any;
-declare var Taro: any
-declare var uni: any
-
-declare module "__GIO_PLATFORM_CONFIG__" {
-  let module: any;
-  export default module;
-}
-
-declare module "__GIO_PLATFORM_INSTANCE__" {
-  let module: any;
-  export default module;
-}
-
-declare module "__GIO_PLUGIN_INSTANCE__" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.app" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.storage" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.network" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.device" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.geolocation" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.fetch" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.router" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.image" {
-  let module: any;
-  export default module;
-}
-
-declare module "@system.share" {
-  let module: any;
-  export default module;
-}