@alipay-inc/mpaas-mtracker-wxmini 1.0.0

package/README.md

@@ -0,0 +1,295 @@
+# 配置
+
+1、安装npm包
+```javascript
+npm install @alipay-inc/mpaas-mtracker-wxmini
+```
+
+2、引入npm包
+```javascript
+import { Tracker } from '@alipay/mpaas-mtracker-wxmini';
+```
+
+# 初始化
+
+```javascript
+Tracker.init({
+  server: 'https://cn-hangzhou-mas-log.cloud.alipay.com/loggw/webLog.do', // 必填，接受埋点的服务地址
+  appId: 'xxxxxxxxxx', // 必填，App 唯一标识
+  workspaceId: 'default', // 必填，环境标识
+  userId: '1234567890',      // 选填, 默认为空
+  bizScenario: 'alipay',   // 选填，渠道来源，默认为空
+  mtrDebug: true, // 选填，是否开启 mtracker 的 debug 模式，在 debug 模式下会打印上报的日志，默认为 false 不开启
+  extendParams: { test: 111 } // 选填，全局扩展参数，默认为空，1.1.0 版本以上支持
+});
+```
+
+# 接口
+### Tracker.click(eventId, options)
+**描述**：点击埋点
+```javascript
+Tracker.click('a1-b1', {
+  bizType: 'Pay',
+  ext: {
+    productId: 'xxx'
+  }
+})
+```
+#### eventId
+* 释义：事件ID
+* 类型：String
+* 示例：
+```javascript
+a1-b1
+```
+
+#### options
+
+##### bizType
+* 释义：业务码
+* 类型：String
+* 示例：
+```javascript
+Pay
+```
+
+##### ext
+* 释义：扩展参数
+* 类型：Object
+* 示例：
+
+```javascript
+{
+  productId: 'xxx'
+}
+```
+
+### Tracker.expo(eventId, options)
+**描述** 曝光埋点
+```javascript
+Tracker.expo('a1-b1', {
+  bizType: 'Pay',
+  ext: {
+    productId: 'xxx'
+  }
+})
+```
+#### eventId
+* 释义：事件ID
+* 类型：String
+* 示例：
+
+```javascript
+a1-b1
+```
+
+#### options
+
+##### bizType
+* 释义：业务码
+* 类型：String
+* 示例：
+```javascript
+Pay
+```
+
+##### ext
+* 释义：扩展参数
+* 类型：Object
+* 示例：
+```javascript
+{
+  productId: 'xxx'
+}
+```
+
+### Tracker.setUserId(userId)
+```javascript
+Tracker.setUserId('xxx');
+```
+
+### Tracker.changeTrackerExtendParams(ext)
+**描述** 改变全局扩展参数
+> 该功能自 1.1.0 版本起支持，如需使用该功能请升级
+```javascript
+Tracker.changeTrackerExtendParams({
+    productId: 'xxx'
+})
+```
+##### ext
+* 释义：扩展参数
+* 类型：Object
+* 示例：
+```javascript
+{
+  productId: 'xxx'
+}
+```
+# 预置扩展属性
+
+| 属性ID | 说明 |
+| --- | --- |
+| userAgent    | -（微信小程序内获取不到，故置为-） |
+| fullURL      | 当前页面的完整 URL              |
+| mBizScenario | 渠道来源                       |
+
+# 埋点格式
+
+## 点击埋点
+
+| 序号 | 字段名 | 字段值(示例) |
+| --- | --- | --- |
+| 01 | 日志头 | D-VM(固定值) |
+| 02 | 当前时间 | 2020-02-12 20:12:20 |
+| 03 | 客户端ID | 应用 ID_H5-workspaceId |
+| 04 | 微信客户端版本号 | 1.0.0 |
+| 05 | 日志埋点SDK版本 | 2(固定值) |
+| 06 | 终端ID | - |
+| 07 | 会话ID | d5557b75-ff80-4aab-86a6-9b1a522bbbce（生成uuid，存放在appInstance.globalData）|
+| 08 | uid | 1234567890 |
+| 09 | event | click(固定值) |
+| 10 | - |  |
+| 11 | 上一级页面 ID|上一级页面位置 ID | url|postion |
+| 12 | - |  |
+| 13 | - |  |
+| 14 | - |  |
+| 15 | - |  |
+| 16 | seedId | PayResults |
+| 17 | - |  |
+| 18 | 业务码 | Pay (默认值：UserBehaviorH5) |
+| 19 | - |  |
+| 20 | - |  |
+| 21 | - |  |
+| 22 | - |  |
+| 23 | 扩展字段 | k=v^k=v |
+| 24 | - |  |
+| 25 | - |  |
+| 26 | utdid | Wn1111111111111111111QxL (guid-timestamp ) |
+| 27 | - |  |
+| 28 | - |  |
+| 29 | - |  |
+| 30 | - |  |
+| 31 | - |  |
+| 32 | - |  |
+| 33 | - |  |
+| 34 | 设备型号 | SM-N9500 |
+| 35 | 操作系统版本 | iOS |
+| 36 | - |  |
+| 37 | - |  |
+| 38 | - |  |
+| 39 | 操作系统语言 | en |
+| 40 | - |  |
+| 41 | CPU 核数 | - |
+| 42 | - |  |
+| 43 | - |  |
+| 44 | - |  |
+| 45 | - |  |
+| 46 | 分辨率 | `1920x1200` |
+| 47 | - |  |
+| 48 | - |  |
+
+## 曝光埋点
+
+| 序号 | 字段名 | 字段值(示例) |
+| --- | --- | --- |
+| 01 | 日志头 | D-VM(固定值) |
+| 02 | 当前时间 | 2020-02-12 20:12:20 |
+| 03 | 客户端ID | 应用 ID_H5-workspaceId |
+| 04 | 微信客户端版本号 | 1.0.0 |
+| 05 | 日志埋点SDK版本 | 2(固定值) |
+| 06 | 终端ID | - |
+| 07 | 会话ID | d5557b75-ff80-4aab-86a6-9b1a522bbbce（生成uuid，存放在appInstance.globalData）|
+| 08 | uid | 1234567890 |
+| 09 | event | exposure(固定值) |
+| 10 | - |  |
+| 11 | 上一级页面 ID|上一级页面位置 ID | url|postion |
+| 12 | - |  |
+| 13 | - |  |
+| 14 | - |  |
+| 15 | - |  |
+| 16 | seedId | PayResults |
+| 17 | - |  |
+| 18 | 业务码 | Pay (默认值：UserBehaviorH5) |
+| 19 | - |  |
+| 20 | - |  |
+| 21 | - |  |
+| 22 | - |  |
+| 23 | 扩展字段 | k=v^k=v |
+| 24 | - |  |
+| 25 | - |  |
+| 26 | utdid | Wn1111111111111111111QxL (guid-timestamp ) |
+| 27 | - |  |
+| 28 | - |  |
+| 29 | - |  |
+| 30 | - |  |
+| 31 | - |  |
+| 32 | - |  |
+| 33 | - |  |
+| 34 | 设备型号 | SM-N9500 |
+| 35 | 操作系统版本 | iOS |
+| 36 | - |  |
+| 37 | - |  |
+| 38 | - |  |
+| 39 | 操作系统语言 | en |
+| 40 | - |  |
+| 41 | CPU 核数 | - |
+| 42 | - |  |
+| 43 | - |  |
+| 44 | - |  |
+| 45 | - |  |
+| 46 | 分辨率 | `1920x1200` |
+| 47 | - |  |
+| 48 | - |  |
+
+## 页面打开自动化埋点
+
+| 序号 | 字段名 | 字段值(示例) |
+| --- | --- | --- |
+| 01 | 日志头 | D-VM(固定值) |
+| 02 | 当前时间 | 2020-02-12 20:12:20 |
+| 03 | 客户端ID | 应用 ID_H5-workspaceId |
+| 04 | 微信客户端版本号 | 1.0.0 |
+| 05 | 日志埋点SDK版本 | 2(固定值) |
+| 06 | 终端ID | - |
+| 07 | 会话ID | d5557b75-ff80-4aab-86a6-9b1a522bbbce（生成uuid，存放在appInstance.globalData）|
+| 08 | uid | 1234567890 |
+| 09 | event | auto_openPage(固定值) |
+| 10 | - |  |
+| 11 | 上一级页面 ID|上一级页面位置 ID | url|postion |
+| 12 | - |  |
+| 13 | - |  |
+| 14 | - |  |
+| 15 | - |  |
+| 16 | 当前页面URL | https://d.alipay.com  |
+| 17 | - |  |
+| 18 | 业务码 | Pay (默认值：UserBehaviorH5) |
+| 19 | - |  |
+| 20 | - |  |
+| 21 | - |  |
+| 22 | - |  |
+| 23 | 扩展字段（仅包含预置属性） | k=v^k=v |
+| 24 | - |  |
+| 25 | - |  |
+| 26 | utdid | Wn1111111111111111111QxL (guid-timestamp ) |
+| 27 | - |  |
+| 28 | - |  |
+| 29 | - |  |
+| 30 | - |  |
+| 31 | - |  |
+| 32 | - |  |
+| 33 | - |  |
+| 34 | 设备型号 | SM-N9500 |
+| 35 | 操作系统版本 | iOS |
+| 36 | - |  |
+| 37 | - |  |
+| 38 | - |  |
+| 39 | 操作系统语言 | en |
+| 40 | - |  |
+| 41 | CPU 核数 | - |
+| 42 | - |  |
+| 43 | - |  |
+| 44 | - |  |
+| 45 | - |  |
+| 46 | 分辨率 | `1920x1200` |
+| 47 | - |  |
+| 48 | - |  |

package/dist/index.js

@@ -0,0 +1,2 @@
+/*! mTracker v1.0.0 */
+!function(t,e){for(var r in e)t[r]=e[r]}(exports,function(t){var e={};function r(n){if(e[n])return e[n].exports;var s=e[n]={i:n,l:!1,exports:{}};return t[n].call(s.exports,s,s.exports,r),s.l=!0,s.exports}return r.m=t,r.c=e,r.d=function(t,e,n){r.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:n})},r.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},r.t=function(t,e){if(1&e&&(t=r(t)),8&e)return t;if(4&e&&"object"==typeof t&&t&&t.__esModule)return t;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:t}),2&e&&"string"!=typeof t)for(var s in t)r.d(n,s,function(e){return t[e]}.bind(null,s));return n},r.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return r.d(e,"a",e),e},r.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},r.p="",r(r.s=0)}([function(t,e,r){"use strict";r.r(e),r.d(e,"Tracker",(function(){return i}));var n={encodeStr:function(t){return"string"==typeof t?t.replace(/=|,|\^|\$\$/g,t=>{switch(t){case",":return"%2C";case"^":return"%5E";case"$$":return"%24%24";case"=":return"%3D";case"&&":return"%26%26";default:return" "}}):t},dateFormat:function(t){const e=t.getFullYear();let r=t.getMonth()+1;r=1===r.toString().length?"0"+r:r;let n=t.getDate();n=1===n.toString().length?"0"+n:n;let s=t.getHours();s=1===s.toString().length?"0"+s:s;let i=t.getMinutes();i=1===i.toString().length?"0"+i:i;let o=t.getSeconds();return o=1===o.toString().length?"0"+o:o,`${e}-${r}-${n} ${s}:${i}:${o}.${t.getMilliseconds()}`}};class s{constructor(){this.logTag="[mTracker]",this.mtrDebug=!1,this._extParams={},this.init=this.init.bind(this),this.click=this.click.bind(this),this.expo=this.expo.bind(this),this.changeTrackerExtendParams=this.changeTrackerExtendParams.bind(this),this.setUserId=this.setUserId.bind(this)}setUserId(t){this.userId=t}init(t){this._init(t);if(this._validate().result){var e=getCurrentPages(),r=e[e.length-1].route;this._remoteLog({seedId:r,actionId:"auto_openPage",ext:this._extParams})}}click(t,e={}){const{bizType:r,ext:n}=e;this._remoteLog({seedId:t,bizType:r,ext:Object.assign(this._extParams,n),actionId:"click"})}expo(t,e){const{bizType:r,ext:n}=e;this._remoteLog({seedId:t,bizType:r,ext:Object.assign(this._extParams,n),actionId:"exposure"})}changeTrackerExtendParams(t){this._changeExt(t)}_remoteLog(t){const e=this._formatData(t);this.send({url:this.server,data:e})}_init(t){let{extendParams:e}=t||{};Object.assign(this,t),e&&("object"==typeof e?this._extParams=e||{}:console.warn("[mTracker] extendParams 格式错误"))}_changeExt(t={}){"object"==typeof t?this._extParams=t:console.warn("[mTracker] 扩展参数格式错误")}_validate(){const t=this._isValid();return t.result||console.error(this.logTag,t.message),t}_isValid(){return this.server?this.appId?this.workspaceId?{result:!0}:{result:!1,message:"请配置workspaceId"}:{result:!1,message:"请配置appId"}:{result:!1,message:"请配置mtracker服务接收地址"}}_getUrl(){const t=getCurrentPages();if(t.length>0){return t[t.length-1].route}return"-"}_formatData(t){const{seedId:e="-",ext:r={},actionId:i="-",bizType:o="UserBehaviorH5"}=t,{version:a="-",model:c="-",system:u="",language:g="-"}=s._getSystemInfo();return["D-VM",n.dateFormat(new Date),`${this.appId||""}_H5-${this.workspaceId||""}`,a,"2","-",this._getSessionId(),this.userId||"-",i,"-",s._getRefer()+"|","-","-","-","-",e,"-",o,"-","-","-","-",this._formatExtParams(r)||"-","-","-",this._getUUid(),"-","-","-","-","-","-","-",c,this._getSystemVersion(u),"-","-","-",g,"-","-","-","-","-","-",this._getScreenInfo(),"-","-"]}_getScreenInfo(){return"-"}static _getRefer(){const t=getCurrentPages();if(t.length>1){return t[t.length-2].route}return"-"}_getSystemVersion(t){let e="-";return t&&([,e="-"]=t.split(" ")),e}static _getSystemInfo(){try{return wx.getSystemInfoSync()}catch(t){console.error(this.logTag,"systemInfo.error",t)}return{}}_getSessionId(){const t=getApp(),e="__mtr-mdap__";return t.globalData[e]||(t.globalData[e]=this._guid()),t.globalData[e]}_getUUid(){const t="__mtr-mdap__";let e;try{e=wx.getStorageSync(t),e||wx.setStorageSync(t,`${this._guid()}-${Date.now()}`)}catch(t){console.error(this.logTag,"wx.storage.error",t)}return e}_guid(){return"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g,t=>{const e=16*Math.random()|0;return("x"===t?e:3&e|8).toString(16)})}_getExtJoinChar(){return"^"}_formatExtParams(t){const e=["userAgent=-","fullURL="+this._getUrl()];return this.bizScenario&&e.push("mBizScenario="+n.encodeStr(this.bizScenario)),Object.keys(t).forEach(r=>{e.push(`${r}=${n.encodeStr(t[r])}`)}),e.join(this._getExtJoinChar())}send(t){const{url:e,data:r}=t;e&&(this.mtrDebug&&console.log(this.logTag,{url:e,data:r}),wx.request({url:e,method:"POST",header:{"content-type":"application/x-www-form-urlencoded"},data:{data:r}}))}}const i=new s}]));

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@alipay-inc/mpaas-mtracker-wxmini",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "webpack --config config/webpack.prod.conf.js",
+    "tar": "tar -zcvf mtracker.gz dist/ package.json",
+    "prepublish": "npm run build && npm run tar",
+    "pub": "tnpm publish"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.alipay-inc.com:mpaas-fe/mpaas-mtracker.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/core": "^7.8.7",
+    "@babel/preset-env": "^7.8.7",
+    "ali-oss": "^6.5.1",
+    "babel-loader": "^8.0.6",
+    "chalk": "^3.0.0",
+    "webpack": "^4.41.6",
+    "webpack-cli": "^3.3.11",
+    "webpack-merge": "^4.2.2"
+  },
+  "files": [
+    "dist"
+  ]
+}