react-native-quicktracking-analytics-module 2.0.2 → 2.1.1

package/lib/typescript/index.d.ts

@@ -1,81 +1,122 @@
-type GlobalProperty = Record<string, string | number>;
-type EventParams = Record<string, string | number>;
-/**
- *引入 QuickTracking SDK
- */
-export declare class QT {
-    /**
-     * 页面浏览事件埋点-打开页面
-     * @param pageName 页面编码
-     */
-    static onPageStart(pageName: string): void;
-    /**
-     * 页面浏览事件埋点-离开页面
-     * @param pageName 页面编码
-     */
-    static onPageEnd(pageName: string): void;
-    /**
-     * 上传页面属性
-     * @param pageName 页面编码
-     * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
-     */
-    static uploadPageProperties(pageName: string, params: EventParams): void;
-    /**
-     * 自定义事件埋点
-     * @param eventId 当前统计的事件编码
-     * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
-     * @param pageName 当前统计事件的页面编码
-     */
-    static sendEvent(eventId: string, params?: EventParams, pageName?: string): void;
-    /**
-     * 桥接事件埋点
-     * @param data H5转发事件的日志体
-     */
-    static sendEventForH5(data: string): void;
-    /**
-     * 注册一个全局事件属性
-     * @param property 要注册的全局属性
-     * @description
-     ** 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
-     ** 且这些属性及属性值存入缓存，APP退出后清除。
-     ** 在分析数据时，可根据此属性进行查看和筛选。
-     */
-    static registerGlobalProperty(gp: GlobalProperty): void;
-    /**
-     * 删除一个全局事件属性
-     * @param propertyName 要删除的全局事件属性名，只支持大小写字母、数字及下划线
-     */
-    static unregisterGlobalProperty(propertyName: string): void;
-    /**
-     * 根据Key获取单个全局属性
-     * @param propertyName 属性名，只支持大小写字母、数字及下划线！
-     */
-    static getGlobalProperty(propertyName: string): Promise<any>;
-    /**
-     * 获取所有的全局事件属性, 返回包含所有全局事件属性的JSONObject
-     */
-    static getGlobalProperties(): Promise<any>;
-    /**
-     * 清空全部全局事件属性。
-     */
-    static clearGlobalProperties(): void;
-    /**
-     * 账号登录时调用此接口，用于统计应用自身的账号
-     * @param ID 用户账号ID，长度小于64字节
-     * @param provider
-     */
-    static profileSignIn(ID: string, Provider?: string): void;
-    /**
-     * 账号登出时需调用此接口，调用之后不再发送账号相关内容。
-     */
-    static profileSignOff(): void;
-    /**
-     * SDK正式初始化
-     * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
-     * @param channel 下载渠道
-     * @description 请务必在用户同意隐私政策后，再初始化SDK，务必调用。
-     */
-    static init(appKey: string, channel: string): void;
-}
+type GlobalProperty = Record<string, string | number | string[]>;
+type EventParams = Record<string, string | number | string[]>;
+/**
+ * SDK正式初始化
+ * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+ * @param channel 下载渠道
+ * @description 请务必在用户同意隐私政策后，再初始化SDK，务必调用。
+ * ！！！
+ * 1. SDK的初始化需要在用户同意隐私政策后，再初始化SDK，务必调用。
+ * 2. 且必须在主线程中调用，iOS端强依赖主线程， Android端建议在主线程中初始化SDK，否则可能会导致数据不准确。
+ * 3. 调用初始化SDK能力之前，需要调用 setTrackDomain 方法设置收数域名。
+ */
+export declare function init(appKey: string, channel: string): void;
+/**
+ * SDK预初始化方法
+ * @param appKey QuickTracking后台提供的唯一key值，请勿泄露给第三方
+ * @param channel 下载渠道
+ * @description 仅Android端需要预初始化方法
+ *  1. 预初始化方法可以在用户同意隐私政策之前调用。
+ *  2. 请在主线程中完成预初始化方法的调用
+ */
+export declare function preInit(appKey: string, channel: string): void;
+/**
+ * 设置SDK的收数域名
+ * @param mainTrackDomain SDK的主收数域名，例如：https://log.quicktracking.cn
+ * @param subTrackDomain SDK的副收数域名，例如：https://log.quicktracking.cn
+ * @description 设置SDK的收数域名, 调用SDK init 初始化API之前需要先设置收数域名。
+ */
+export declare function setTrackDomain(mainTrackDomain: string, subTrackDomain: string): void;
+/**
+ * SDK开启日志
+ * @param enable 日志开关
+ * @description SDK日志开关
+ */
+export declare function enableLog(enable: boolean): void;
+/**
+ * 页面浏览事件埋点-打开页面
+ * @param pageName 页面编码
+ */
+export declare function onPageStart(pageName: string): void;
+/**
+ * 页面浏览事件埋点-离开页面
+ * @param pageName 页面编码
+ */
+export declare function onPageEnd(pageName: string): void;
+/**
+ * 上传页面属性
+ * @param pageName 页面编码
+ * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
+ */
+export declare function uploadPageProperties(pageName: string, params: EventParams): void;
+/**
+ * 自定义事件埋点
+ * @param eventId 当前统计的事件编码
+ * @param params 对当前事件的参数描述，定义为“参数名:参数值”的“<键-值>”对
+ * @param pageName 当前统计事件的页面编码
+ */
+export declare function sendEvent(eventId: string, params?: EventParams, pageName?: string): void;
+/**
+ * 桥接事件埋点
+ * @param data H5转发事件的日志体
+ */
+export declare function sendEventForH5(data: string): void;
+/**
+ * 注册一个全局事件属性
+ * @param property 要注册的全局属性
+ * @description
+ * 注册全局属性后，后续触发的所有事件都将自动包含这些属性；
+ * 且这些属性及属性值存入缓存，APP退出后清除。
+ * 在分析数据时，可根据此属性进行查看和筛选。
+ */
+export declare function registerGlobalProperty(gp: GlobalProperty): void;
+/**
+ * 删除一个全局事件属性
+ * @param propertyName 要删除的全局事件属性名，只支持大小写字母、数字及下划线
+ */
+export declare function unregisterGlobalProperty(propertyName: string): void;
+/**
+ * 根据Key获取单个全局属性
+ * @param propertyName 属性名，只支持大小写字母、数字及下划线！
+ */
+export declare const getGlobalProperty: (propertyName: string) => Promise<any>;
+/**
+ * 获取所有的全局事件属性, 返回包含所有全局事件属性的JSONObject
+ */
+export declare const getGlobalProperties: () => Promise<any>;
+/**
+ * 清空全部全局事件属性。
+ */
+export declare const clearGlobalProperties: () => void;
+/**
+ * 账号登录时调用此接口，用于统计应用自身的账号
+ * @param ID 用户账号ID，长度小于64字节
+ * @param provider
+ */
+export declare const profileSignIn: (ID: string, Provider?: string) => void;
+/**
+ * 账号登出时需调用此接口，调用之后不再发送账号相关内容。
+ */
+export declare const profileSignOff: () => void;
+/**
+ * 设置应用版本
+ */
+export declare const setAppVersion: (version: string, versionCode: number) => void;
+/**
+ * 关闭SDK
+ */
+export declare const disableSDK: () => void;
+/**
+ * 开启SDK
+ */
+export declare const enableSDK: () => void;
+/**
+ * 自定义设备ID
+ */
+export declare const setCustomDeviceId: (deviceId: string) => void;
+/**
+ * 读取设备ID
+ */
+export declare const getDeviceId: () => Promise<any>;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAEA,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;AACjE,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;AAK9D;;;;;;;;;GASG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,QAEnD;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,QAMtD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,eAAe,EAAE,MAAM,EACvB,cAAc,EAAE,MAAM,QAGvB;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,QAExC;AAGD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,QAE3C;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,QAEzC;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,QAEzE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,WAAW,EACpB,QAAQ,CAAC,EAAE,MAAM,QA2BlB;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,QAkC1C;AAGD;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,EAAE,EAAE,cAAc,QAcxD;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,YAAY,EAAE,MAAM,QAE5D;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAU,cAAc,MAAM,iBAQ3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,oBAO/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,YAEjC,CAAC;AAGF;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,IAAI,MAAM,EAAE,WAAW,MAAM,SAmB1D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,YAE1B,CAAC;AAGF;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,SAAS,MAAM,EAAE,aAAa,MAAM,SAMjE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,YAEtB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,YAErB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,UAAU,MAAM,SAEjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,oBAMvB,CAAC"}

package/package.json

@@ -1,54 +1,97 @@
 {
   "name": "react-native-quicktracking-analytics-module",
-  "version": "2.0.2",
-  "description": "QuickTracking ReactNative SDK",
-  "main": "lib/commonjs/index",
-  "module": "lib/module/index",
-  "types": "lib/typescript/index.d.ts",
-  "react-native": "src/index",
-  "source": "src/index",
+  "version": "2.1.1",
+  "description": "QuickTracking ReactNative Analytics SDK",
+  "source": "./src/index.tsx",
+  "main": "./lib/commonjs/index.js",
+  "types": "./lib/typescript/index.d.ts",
+  "module": "lib/module/index.js",
+  "exports": {
+    ".": {
+      "types": "./lib/typescript/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "src",
-    "lib/commonjs/index.js",
-    "lib/module/index.js",
-    "lib/typescript/index.d.ts",
+    "lib",
     "android",
     "ios",
     "cpp",
-    "react-native-quicktracking-analytics-module.podspec",
-    "!lib/typescript/example",
-    "!android/build",
+    "*.podspec",
+    "react-native.config.js",
     "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
     "!**/__tests__",
     "!**/__fixtures__",
-    "!**/__mocks__"
+    "!**/__mocks__",
+    "!**/.*"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "typescript": "tsc --noEmit",
+    "example": "yarn workspace react-native-quicktracking-analytics-module-example",
+    "test": "jest",
+    "typecheck": "tsc",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
-    "prepare": "npx bob build",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
     "release": "release-it",
-    "example": "yarn --cwd example",
-    "bootstrap": "yarn example && yarn && yarn example pods",
-    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build"
+    "build": "yarn clean && bob build"
   },
   "keywords": [
-    "quicktracking",
     "react-native",
     "ios",
     "android"
   ],
-  "author": "yuzhao",
+  "repository": {
+    "type": "git",
+    "url": "git+https://www.github.com/rn_qt_analytics.git.git"
+  },
+  "author": "yuzhao <changliang.lcl@alibaba-inc.com> (https://help.aliyun.com/document_detail/2805800.html)",
   "license": "MIT",
-  "homepage": "https://www.aliyun.com/product/man?scm=20140722.S_product%40%40%E4%BA%91%E4%BA%A7%E5%93%81%40%40125428._.ID_product%40%40%E4%BA%91%E4%BA%A7%E5%93%81%40%40125428-RL_quicktracking-LOC_main-OR_ser-V_2-P0_1",
+  "bugs": {
+    "url": "https://www.github.com/rn_qt_analytics.git/issues"
+  },
+  "homepage": "https://www.github.com/rn_qt_analytics.git#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.6.0",
+    "@eslint/compat": "^1.2.7",
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.22.0",
+    "@evilmartians/lefthook": "^1.5.0",
+    "@react-native/eslint-config": "^0.78.0",
+    "@release-it/conventional-changelog": "^9.0.2",
+    "@types/jest": "^29.5.5",
+    "@types/react": "^19.0.0",
+    "commitlint": "^19.6.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.3",
+    "react": "19.0.0",
+    "react-native": "0.78.2",
+    "react-native-builder-bob": "^0.40.5",
+    "release-it": "^17.10.0",
+    "turbo": "^1.10.7",
+    "typescript": "^5.2.2"
+  },
   "peerDependencies": {
     "react": "*",
     "react-native": "*"
   },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@3.6.1",
   "jest": {
     "preset": "react-native",
     "modulePathIgnorePatterns": [
@@ -62,34 +105,24 @@
     ]
   },
   "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
     "npm": {
       "publish": true
-    }
-  },
-  "eslintConfig": {
-    "root": true,
-    "parser": "@babel/eslint-parser",
-    "extends": [
-      "@react-native-community",
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
         }
-      ]
+      }
     }
   },
-  "eslintIgnore": [
-    "node_modules/",
-    "lib/"
-  ],
   "prettier": {
     "quoteProps": "consistent",
     "singleQuote": true,
@@ -111,26 +144,9 @@
       ]
     ]
   },
-  "devDependencies": {
-    "@commitlint/config-conventional": "^17.0.2",
-    "@evilmartians/lefthook": "^1.2.2",
-    "@react-native-community/eslint-config": "^3.0.2",
-    "@release-it/conventional-changelog": "^5.0.0",
-    "@types/jest": "^28.1.2",
-    "@types/react": "~17.0.21",
-    "@types/react-native": "0.70.0",
-    "commitlint": "^17.0.2",
-    "del-cli": "^5.0.0",
-    "eslint": "^8.4.1",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^28.1.1",
-    "pod-install": "^0.1.0",
-    "prettier": "^2.0.5",
-    "react": "18.1.0",
-    "react-native": "0.70.6",
-    "react-native-builder-bob": "^0.20.3",
-    "release-it": "^15.0.0",
-    "typescript": "^4.9.5"
+  "create-react-native-library": {
+    "type": "legacy-module",
+    "languages": "kotlin-objc",
+    "version": "0.49.8"
   }
 }

package/src/hook.js

@@ -33,8 +33,8 @@ function lastArgumentName(content, index) {
 // 自动PV开关
 let enableAutoCLK = false;
 
-if (packageJSON && packageJSON['QTSDKConfig']) {
-  enableAutoCLK = !!packageJSON['QTSDKConfig']['enableAutoCLK'];
+if (packageJSON && packageJSON.QTSDKConfig) {
+  enableAutoCLK = !!packageJSON.QTSDKConfig.enableAutoCLK;
 }
 
 // react native clickable component path
@@ -144,7 +144,7 @@ const QTSegmentedControlHookCode =
 const QTSwitchHookCode = `if(this.props.onChange != null || this.props.onValueChange != null){
     (function(thatThis){
       try {
-       const ReactNative = require(react-native);
+       const ReactNative = require('react-native');
         const qtModule = ReactNative.NativeModules.QuicktrackingAnalyticsModule;
        qtModule && qtModule?.onEventAutoCLK(ReactNative.findNodeHandle(thatThis));
      } catch (error) {