Skip to content

Commit 50abc22

Browse files
committed
[refactor] 使用ts重构
1 parent 59e9d54 commit 50abc22

File tree

723 files changed

+55937
-11626
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

723 files changed

+55937
-11626
lines changed

.babelrc

Lines changed: 0 additions & 9 deletions
This file was deleted.

.env

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
ANS=JS
2+
LIB=JS
3+
LibVERSION=5.0.0

.eslintcache

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

.eslintignore

Lines changed: 0 additions & 9 deletions
This file was deleted.

.eslintrc.js

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
1-
module.exports = {
2-
"env": {
3-
"browser": true,
4-
"es6": true,
5-
"jest": true,
6-
"node": true
7-
},
8-
"extends": "eslint:recommended",
9-
"globals": {
10-
"Atomics": "readonly",
11-
"SharedArrayBuffer": "readonly",
12-
"__static": true
13-
},
14-
"parser": 'babel-eslint',
15-
"parserOptions": {
16-
"ecmaVersion": 6,
17-
"sourceType": "module",
18-
},
19-
"rules": {
20-
"no-empty": 0,
21-
"no-control-regex": "off",
22-
"no-misleading-character-class": "off"
23-
}
24-
};
1+
const { defineConfig } = require('eslint-define-config');
2+
3+
module.exports = defineConfig({
4+
root: true,
5+
env: {
6+
browser: true,
7+
node: true,
8+
es6: true
9+
},
10+
globals: {
11+
wx: true,
12+
Page: true,
13+
App: true,
14+
Component: true,
15+
getCurrentPages: true
16+
},
17+
extends: [
18+
"eslint:recommended",
19+
"plugin:@typescript-eslint/eslint-recommended",
20+
"plugin:@typescript-eslint/recommended"
21+
],
22+
parserOptions: {
23+
ecmaVersion: 'latest',
24+
sourceType: 'module',
25+
},
26+
rules: {
27+
"@typescript-eslint/no-this-alias": ["error", {
28+
allowedNames: ['_this', 'self']
29+
}],
30+
"@typescript-eslint/no-explicit-any": ["off"]
31+
},
32+
});

.github/workflows/npm-publish.yml

Lines changed: 0 additions & 18 deletions
This file was deleted.

.gitignore

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
package-lock.json
22
node_modules/
3-
*.zip
3+
*.zip
4+
.DS_Store
5+
yarn.lock
6+
.log
7+
bac
8+
vue-h5

README.md

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,67 @@
1+
# [易观方舟](https://www.analysys.cn/) asd-javascript-sdk [![NPM version][npm-image]][npm-url] [![License](https://img.shields.io/github/license/analysys/ans-wechat-sdk.svg)](https://github.com/analysys/ans-wechat-sdk/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/analysys/ans-wechat-sdk.svg)](https://github.com/analysys/ans-wechat-sdk/releases)
12

2-
# Analysys JavaScript SDK [![NPM version][npm-image]][npm-url] [![License](https://img.shields.io/github/license/analysys/ans-javascript-sdk.svg)](https://github.com/analysys/ans-javascript-sdk/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/analysys/ans-javascript-sdk.svg)](https://github.com/analysys/ans-javascript-sdk/releases)
3+
## 安装
34

4-
========
5+
```sh
6+
$ npm install asd-javascript-sdk --save
7+
```
58

6-
This is the official JavaScript SDK for Analysys.
9+
## javascript SDK 基础说明
710

8-
# JavaScript SDK目录说明:
9-
* demo——API调用演示
10-
* SDK——SDK文件
11-
* src——SDK源码
12-
* vue-demo——VUE框架API调用演示
11+
#### 快速集成
12+
##### 引入sdk模块并初始化
13+
```js
1314

14-
# 安装
15+
import AnalysysAgent from "asd-javascript-sdk"
1516

16-
```
17-
npm install ans-javascript-sdk --save
17+
// 引入加密模块(非必须)
18+
import AnalysysEncryption from 'asd-javascript-sdk/dist/AnalysysAgent_encryption.min.js';
19+
AnalysysAgent.encrypt = AnalysysEncryption;
20+
21+
//初始化
22+
AnalysysAgent.init({
23+
appkey: '',
24+
uploadURL: ''
25+
})
1826
```
1927

20-
# JavaScript 基础说明:
28+
##### 初始化参数说明
2129

22-
JS SDK 用于由 HTML 、 Css 及 Javascript 制作成的网站,集成前请先安装SDK
30+
参数 | 是否必须| 类型 | 默认值 | 说明
31+
--- | :--- | :--- | :--- | :---
32+
appkey | 是 | string | - | 在网站获取的AppKey
33+
uploadURL | 是 | string | - | 自定义上传地址
34+
debugMode | 否 | number | 0 | 0: 关闭调试模式;1 - 开启调试模式,数据不入库;2 - 开启调试模式,数据入库
35+
autoProfile | 否 | boolean | true | 设置是否追踪新用户的首次属性
36+
encryptType | 否 | number | 0 | 设置是否对上传数据加密:0 - 对上传数据不加密(默认);1 - 对上传数据进行AES 128位ECB加密;2 对上传数据进行AES 128位CBC加密
37+
allowTimeCheck | 否 | boolean | false | 设置是否开启时间校准
38+
maxDiffTimeInterval | 否 | number | 30 | 设置最大时间校准分为:30s(默认) ,当设置的时间差值小于他,将不开启校准。否则将会进行时间校准。假如设置成为负值,将默认为 30s。
39+
autoTrack | 否 | boolean | false | 设置是否开启全埋点,开启全埋点将会上报所有绑定(支持tab、longtab、longpress)事件,并上报$user_click 事件,设置data-content为采集的 $element_content、data-type为采集的 $element_type、data-name为采集的$element_name、id为采集的$element_id。不设置采集不到。不支持系统方法包括生命周期事件的上报,如果要采集tabbar切换,务必在注册Page的时候注册OnTabItemTap方法,否则采集不到。
40+
autoCompleteURL | 否 | boolean | true | 设置是否采集完整URL,true - 采集URL包括参数;false - 采集URL不包括参数
41+
autoPageViewDuration | 否 | boolean | false | 是否采集页面离开事件
2342

24-
## 快速集成
25-
如果您是第一次使用易观方舟产品,可以通过阅读本文快速了解此产品
26-
1. 选择集成方式
27-
目前我们提供了异步集成、同步集成的方式
28-
2. 设置初始化接口
29-
通过初始化代码的配置参数配置您的 AppKey
30-
3. 设置上传地址
31-
通过初始化代码的配置参数 uploadURL 设置您上传数据的地址。
32-
4. 设置需要采集的页面或事件
33-
通过手动埋点,设置需要采集的页面或事件。
34-
5. 打开Debug模式查看日志
35-
通过设置 Ddebug 模式,开(debugMode为1或2)/关(debugMode为0或不设置) log 查看日志。
43+
> 通过以上步骤您即可验证SDK是否已经集成成功,更多Api使用方法参考:[易观方舟 wechat SDK 文档](https://docs.analysys.cn/ark/integration/sdk/wx/wxsdkcustom)
3644
37-
> 通过以上步骤您即可验证SDK是否已经集成成功,具体使用方法参考:[易观方舟 JavaScript SDK 文档](https://docs.analysys.cn/ark/integration/sdk/js/js)
45+
> 注意 SDK 可能不完全向前兼容,请查看版本更新说明 [Release及版本升级记录](https://github.com/analysys/ans-wechat-sdk/releases)。如果有说明不兼容的话,需要升级易观方舟对应的版本。 请根据需要前往 [Release](https://github.com/analysys/ans-wechat-sdk/releases) 里下载对应的文件
3846
39-
> 注意 SDK 可能不完全向前兼容,请查看版本更新说明 [Release及版本升级记录](https://github.com/analysys/ans-javascript-sdk/releases)。如果有说明不兼容的话,需要升级易观方舟对应的版本。 请根据需要前往 [Release](https://github.com/analysys/ans-javascript-sdk/releases) 里下载对应的文件
4047

4148
## 版本升级记录
4249
请参见 [Release及版本升级记录](https://github.com/analysys/ans-wechat-sdk/releases)
43-
更多Api使用方法参考:[易观方舟 JavaScript SDK 文档](https://docs.analysys.cn/ark/integration/sdk/js/js)
4450

45-
# 讨论
46-
* 微信号:nlfxwz
47-
* 钉钉群:30099866
48-
49-
5051

51-
# License
5252

53-
[gpl-3.0](https://www.gnu.org/licenses/gpl-3.0.txt)
5453

55-
**禁止一切基于易观方舟 javascript 开源 SDK 的所有商业活动!**
54+
**禁止一切基于易观方舟 wechat 开源 SDK 的所有商业活动!**
5655

5756
---
5857

5958
[![NPM downloads][npm-downloads]][npm-url]
6059

6160

61+
62+
6263
[homepage]: https://github.com/analysys/ans-javascript-sdk
63-
[npm-url]: https://www.npmjs.com/package/ans-javascript-sdk
64-
[npm-image]: https://img.shields.io/npm/v/ans-javascript-sdk.svg?style=flat
65-
[npm-downloads]: https://img.shields.io/npm/dm/ans-javascript-sdk.svg?style=flat
64+
[npm-url]: https://www.npmjs.com/package/asd-javascript-sdk
65+
[npm-image]: https://img.shields.io/npm/v/asd-javascript-sdk.svg?style=flat
66+
[npm-downloads]: https://img.shields.io/npm/dm/asd-javascript-sdk.svg?style=flat
67+

0 commit comments

Comments
 (0)