@huawei-ide/codearts 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +25 -15
  2. package/index.js +38 -7
  3. package/package.json +1 -1
  4. package/util.js +30 -0
package/README.md CHANGED
@@ -1,5 +1,6 @@
1
1
  # @huawei-ide/codearts
2
- 用于集成CodeArts IDE Web
2
+
3
+ 用于集成 CodeArts IDE Web
3
4
 
4
5
  ## 如何使用
5
6
 
@@ -9,15 +10,16 @@
9
10
  2. 引入 @huawei-ide/codearts
10
11
  `const ide = require('@huawei-ide/codearts');`
11
12
 
12
- 3. 预加载IDE, 返回Promise:
13
+ 3. 预加载 IDE, 返回 Promise:
13
14
  `await ide.preload();`
14
15
 
15
- 4. 展示IDE
16
- 其中id参数为挂载节点id, 返回Promise:
16
+ 4. 展示 IDE
17
+ 其中 id 参数为挂载节点 id, 返回 Promise:
17
18
  `ide.show(id: string, {width:string,height: string}).then(() => {});`
18
19
 
19
- 5. 打开文件,默认可编辑
20
- 参数content为文件内容,类型为string,path是工程内文件的唯一路径,例如'src', 'src/tool', name为带后缀的文件名:
20
+ 5. 打开文件,默认可编辑
21
+ 参数 content 为文件内容,类型为 string,path 是工程内文件的唯一路径,例如'src', 'src/tool', name 为带后缀的文件名:
22
+
21
23
  ```
22
24
  ide.openFile({
23
25
  content: '## ReadME',
@@ -26,14 +28,22 @@
26
28
  });
27
29
  ```
28
30
 
29
- 6. 设置文件是否为预览(只读)状态
30
- `ide.setPreview(preview: boolean)`
31
-
32
- 7. 获取当前文件最新内容,返回Promise:
31
+ 6. 设置文件是否为预览(只读)状态
32
+ `ide.setPreview(preview: boolean)`
33
+
34
+ 7. 获取当前文件最新内容,返回 Promise:
33
35
  `await ide.getContent();`
34
36
 
35
- 8. 设置Token
36
- `ide.setToken();`
37
-
38
- 9. 销毁IDE
39
- `ide.dispose();`
37
+ 8. 设置 DomainId 及 UserId
38
+ `ide.setUserId(domainId: string, userId: string);`
39
+
40
+ 9. 监听当前文件变化
41
+
42
+ ```
43
+ const event = ide.onDidChange(listener: (content: string) => {});
44
+ // 销毁监听
45
+ event.dispose();
46
+ ```
47
+
48
+ 10. 销毁 IDE
49
+ `ide.dispose();`
package/index.js CHANGED
@@ -1,12 +1,17 @@
1
+ import { EventEmitter } from './util'
2
+
1
3
  const hcOrigin = 'https://res.hc-cdn.com';
2
4
  const iframe = document.createElement('iframe');
3
5
  iframe.id = 'codeartside';
4
- iframe.src = hcOrigin + '/codearts-core-web-static/1.0.16/resources/server/gitcode.html';
6
+ iframe.src = hcOrigin + '/codearts-core-web-static/1.0.18/resources/server/gitcode.html';
5
7
  iframe.width = '1px';
6
8
  iframe.height = '1px';
7
9
  iframe.style.opacity = 0;
8
10
  iframe.style.zIndex = -1;
9
11
 
12
+ const ON_DID_CHANGE = 'onDidChange';
13
+ const eventEmitter = new EventEmitter();
14
+
10
15
  function ideLoading() {
11
16
  return new Promise((resolve) => {
12
17
  function handleMessage(event) {
@@ -40,6 +45,16 @@ function ideContent() {
40
45
  });
41
46
  }
42
47
 
48
+ function onDidRecieveMessage(event) {
49
+ const { type, data } = event.data;
50
+ if (event.origin !== hcOrigin) {
51
+ return;
52
+ }
53
+ if (type === 'ide-on-did-change-file') {
54
+ eventEmitter.emit(ON_DID_CHANGE, data);
55
+ }
56
+ }
57
+
43
58
  export function preload() {
44
59
  document.body.appendChild(iframe);
45
60
  return ideLoading();
@@ -49,9 +64,9 @@ export function preload() {
49
64
  export function show(id, style) {
50
65
  var targetNode = document.getElementById(id);
51
66
  targetNode.appendChild(iframe);
52
- const {width, height} = style;
53
- iframe.width = width;
54
- iframe.height = height;
67
+ const { width, height } = style;
68
+ iframe.width = width;
69
+ iframe.height = height;
55
70
  iframe.style.opacity = 1;
56
71
  iframe.style.zIndex = 1;
57
72
  return ideLoading();
@@ -67,6 +82,8 @@ export function openFile(file) {
67
82
  }
68
83
 
69
84
  export function dispose() {
85
+ window.removeEventListener('message', onDidRecieveMessage);
86
+ eventEmitter.clear();
70
87
  iframe.remove();
71
88
  }
72
89
 
@@ -86,10 +103,10 @@ export function getContent() {
86
103
  return ideContent();
87
104
  }
88
105
 
89
- export function setToken(token) {
106
+ export function setUserId(domainId, userId) {
90
107
  const message = {
91
- type: 'setToken',
92
- data: token
108
+ type: 'setUserId',
109
+ data: { domainId, userId }
93
110
  };
94
111
  postMessage(message);
95
112
  }
@@ -97,3 +114,17 @@ export function setToken(token) {
97
114
  function postMessage(message) {
98
115
  iframe.contentWindow.postMessage(message, hcOrigin);
99
116
  }
117
+
118
+ let isRegisteredListener = false;
119
+ export function onDidChange(listener) {
120
+ if (!isRegisteredListener) {
121
+ window.addEventListener('message', onDidRecieveMessage);
122
+ isRegisteredListener = true;
123
+ }
124
+ eventEmitter.on(ON_DID_CHANGE, listener);
125
+ return {
126
+ dispose: () => {
127
+ eventEmitter.off(ON_DID_CHANGE, listener);
128
+ }
129
+ }
130
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@huawei-ide/codearts",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
package/util.js ADDED
@@ -0,0 +1,30 @@
1
+ export class EventEmitter {
2
+ constructor() {
3
+ this.events = {};
4
+ }
5
+
6
+ on(event, listener) {
7
+ if (!this.events[event]) {
8
+ this.events[event] = [];
9
+ }
10
+ this.events[event].push(listener);
11
+ }
12
+
13
+ emit(event, ...args) {
14
+ if (this.events[event]) {
15
+ this.events[event].forEach(listener => {
16
+ listener(...args);
17
+ });
18
+ }
19
+ }
20
+
21
+ off(event, listener) {
22
+ if (this.events[event]) {
23
+ this.events[event] = this.events[event].filter(l => l !== listener);
24
+ }
25
+ }
26
+
27
+ clear() {
28
+ this.events = {};
29
+ }
30
+ }