ncloudchat 1.0.33 → 1.0.35

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 (143) hide show
  1. package/LICENSE.md +2 -2
  2. package/README.md +23 -393
  3. package/ncloudchat.d.ts +1298 -0
  4. package/ncloudchat.min.js +1 -0
  5. package/package.json +19 -40
  6. package/deploy.sh +0 -20
  7. package/esm/CloudChat.d.ts +0 -482
  8. package/esm/CloudChat.js +0 -1736
  9. package/esm/CloudChat.js.map +0 -1
  10. package/esm/CoreManager.d.ts +0 -11
  11. package/esm/CoreManager.js +0 -36
  12. package/esm/CoreManager.js.map +0 -1
  13. package/esm/Dispatcher.d.ts +0 -37
  14. package/esm/Dispatcher.js +0 -93
  15. package/esm/Dispatcher.js.map +0 -1
  16. package/esm/Network.d.ts +0 -7
  17. package/esm/Network.js +0 -96
  18. package/esm/Network.js.map +0 -1
  19. package/esm/Type.d.ts +0 -79
  20. package/esm/Type.js +0 -28
  21. package/esm/Type.js.map +0 -1
  22. package/esm/Util.d.ts +0 -15
  23. package/esm/Util.js +0 -20
  24. package/esm/Util.js.map +0 -1
  25. package/esm/graphql/channel.d.ts +0 -13
  26. package/esm/graphql/channel.js +0 -16
  27. package/esm/graphql/channel.js.map +0 -1
  28. package/esm/graphql/friend.d.ts +0 -11
  29. package/esm/graphql/friend.js +0 -13
  30. package/esm/graphql/friend.js.map +0 -1
  31. package/esm/graphql/invite.d.ts +0 -7
  32. package/esm/graphql/invite.js +0 -8
  33. package/esm/graphql/invite.js.map +0 -1
  34. package/esm/graphql/member.d.ts +0 -11
  35. package/esm/graphql/member.js +0 -13
  36. package/esm/graphql/member.js.map +0 -1
  37. package/esm/graphql/message.d.ts +0 -11
  38. package/esm/graphql/message.js +0 -13
  39. package/esm/graphql/message.js.map +0 -1
  40. package/esm/graphql/pin.d.ts +0 -10
  41. package/esm/graphql/pin.js +0 -12
  42. package/esm/graphql/pin.js.map +0 -1
  43. package/esm/graphql/project.d.ts +0 -6
  44. package/esm/graphql/project.js +0 -8
  45. package/esm/graphql/project.js.map +0 -1
  46. package/esm/graphql/subscription.d.ts +0 -11
  47. package/esm/graphql/subscription.js +0 -13
  48. package/esm/graphql/subscription.js.map +0 -1
  49. package/esm/index.d.ts +0 -8
  50. package/esm/index.js +0 -9
  51. package/esm/index.js.map +0 -1
  52. package/esm/logger.d.ts +0 -10
  53. package/esm/logger.js +0 -17
  54. package/esm/logger.js.map +0 -1
  55. package/esm/mutations/channel.d.ts +0 -56
  56. package/esm/mutations/channel.js +0 -170
  57. package/esm/mutations/channel.js.map +0 -1
  58. package/esm/mutations/friend.d.ts +0 -42
  59. package/esm/mutations/friend.js +0 -122
  60. package/esm/mutations/friend.js.map +0 -1
  61. package/esm/mutations/index.d.ts +0 -13
  62. package/esm/mutations/index.js +0 -14
  63. package/esm/mutations/index.js.map +0 -1
  64. package/esm/mutations/invite.d.ts +0 -16
  65. package/esm/mutations/invite.js +0 -67
  66. package/esm/mutations/invite.js.map +0 -1
  67. package/esm/mutations/member.d.ts +0 -41
  68. package/esm/mutations/member.js +0 -129
  69. package/esm/mutations/member.js.map +0 -1
  70. package/esm/mutations/message.d.ts +0 -37
  71. package/esm/mutations/message.js +0 -132
  72. package/esm/mutations/message.js.map +0 -1
  73. package/esm/mutations/pin.d.ts +0 -28
  74. package/esm/mutations/pin.js +0 -88
  75. package/esm/mutations/pin.js.map +0 -1
  76. package/esm/mutations/subscription.d.ts +0 -37
  77. package/esm/mutations/subscription.js +0 -115
  78. package/esm/mutations/subscription.js.map +0 -1
  79. package/esm/queries/channel.d.ts +0 -26
  80. package/esm/queries/channel.js +0 -88
  81. package/esm/queries/channel.js.map +0 -1
  82. package/esm/queries/friend.d.ts +0 -17
  83. package/esm/queries/friend.js +0 -69
  84. package/esm/queries/friend.js.map +0 -1
  85. package/esm/queries/index.d.ts +0 -14
  86. package/esm/queries/index.js +0 -15
  87. package/esm/queries/index.js.map +0 -1
  88. package/esm/queries/member.d.ts +0 -17
  89. package/esm/queries/member.js +0 -69
  90. package/esm/queries/member.js.map +0 -1
  91. package/esm/queries/memberblocks.d.ts +0 -17
  92. package/esm/queries/memberblocks.js +0 -69
  93. package/esm/queries/memberblocks.js.map +0 -1
  94. package/esm/queries/message.d.ts +0 -36
  95. package/esm/queries/message.js +0 -109
  96. package/esm/queries/message.js.map +0 -1
  97. package/esm/queries/pin.d.ts +0 -28
  98. package/esm/queries/pin.js +0 -92
  99. package/esm/queries/pin.js.map +0 -1
  100. package/esm/queries/project.d.ts +0 -14
  101. package/esm/queries/project.js +0 -22
  102. package/esm/queries/project.js.map +0 -1
  103. package/esm/queries/subscription.d.ts +0 -27
  104. package/esm/queries/subscription.js +0 -90
  105. package/esm/queries/subscription.js.map +0 -1
  106. package/lib/CloudChat.js +0 -2661
  107. package/lib/CoreManager.js +0 -45
  108. package/lib/Dispatcher.js +0 -125
  109. package/lib/Network.js +0 -229
  110. package/lib/Type.js +0 -44
  111. package/lib/Util.js +0 -32
  112. package/lib/graphql/channel.js +0 -32
  113. package/lib/graphql/friend.js +0 -27
  114. package/lib/graphql/invite.js +0 -18
  115. package/lib/graphql/member.js +0 -27
  116. package/lib/graphql/message.js +0 -27
  117. package/lib/graphql/pin.js +0 -25
  118. package/lib/graphql/project.js +0 -7
  119. package/lib/graphql/subscription.js +0 -27
  120. package/lib/index.js +0 -18
  121. package/lib/logger.js +0 -33
  122. package/lib/mutations/channel.js +0 -354
  123. package/lib/mutations/friend.js +0 -299
  124. package/lib/mutations/index.js +0 -109
  125. package/lib/mutations/invite.js +0 -205
  126. package/lib/mutations/member.js +0 -304
  127. package/lib/mutations/message.js +0 -300
  128. package/lib/mutations/pin.js +0 -229
  129. package/lib/mutations/subscription.js +0 -281
  130. package/lib/queries/channel.js +0 -239
  131. package/lib/queries/friend.js +0 -207
  132. package/lib/queries/index.js +0 -123
  133. package/lib/queries/member.js +0 -207
  134. package/lib/queries/memberblocks.js +0 -207
  135. package/lib/queries/message.js +0 -273
  136. package/lib/queries/pin.js +0 -243
  137. package/lib/queries/project.js +0 -7
  138. package/lib/queries/subscription.js +0 -241
  139. package/ncloudchat_javascript.md +0 -289
  140. package/tsconfig.json +0 -32
  141. package/types/exif.d.ts +0 -10
  142. package/types/window.d.ts +0 -5
  143. package//353/260/260/355/217/254/354/210/234/354/204/234.md +0 -8
package/ncloudchat_javascript.md DELETED
@@ -1,289 +0,0 @@
1
- ---
2
- search:
3
- keyword: ["ncloudchat"]
4
- ---
5
-
6
- # NCLOUD Chat Javascript SDK
7
-
8
- ## Authentification
9
-
10
- ### 1. 대시보드에서 설정에서 프로젝트ID 를 확인 합니다.
11
- [ncloudchat.min.js](https://kr.object.ncloudstorage.com/ncloudchat/ncloudchat.min.js) 을 다운로드 합니다.
12
-
13
- <script src="ncloudchat.min.js"></script>
14
-
15
- 를 <head> </head> 사이에 추가 합니다.
16
-
17
- 엔클라우드챗을 사용하기전에 인스턴스를 초기화 해야 합니다. 대시보드에서 확인한 프로젝트ID 를 추가해 주세요.
18
-
19
- ```javascript
20
- const chat = new ncloudchat.Chat();
21
- chat.initialize(projectId);
22
- ```
23
-
24
- ### 2. Connect to NCloud Chat Server
25
-
26
- - 초기화가 완료되면 사용자명, 이름, 프로필 이미지주소(옵션) 을 입력 후에 접속해야 합니다.
27
-
28
- ```javascript
29
- const user = await chat.connect({
30
- id: USERNAME,
31
- name: NAME,
32
- profile: PROFILE_URL
33
- }, TOKEN);
34
- ```
35
-
36
- | ID | type | desc |
37
- | :--------- | :----- | :---------- |
38
- | USERNAME | string | 아이디 |
39
- | NAME | string | 이름 |
40
- | PROFILE_URL | string | 프로필 주소 |
41
- | TOKEN | string | 토큰 값 |
42
-
43
-
44
- ### 3. Disconnect from NCloud Chat Server
45
-
46
- - 사용자의 연결을 끊을려면 disconnect() 함수를 호출하면 됩니다
47
-
48
- ```javascript
49
- await chat.disconnect();
50
- ```
51
-
52
- ## Communication
53
-
54
- ### 1. Subscribe / Unsubscribe
55
-
56
- - 원하는 채널에 가입(방 참여) 합니다. 참여된 채널에는 unsubscribe 할때까지 재접속시에도 자동으로 참여됩니다.
57
-
58
- ```javascript
59
- chat.subscribe(CHANNEL_ID);
60
- ```
61
-
62
- - 해당 채널에 대한 가입을 해지 합니다. 해당 채널에 메시지를 더 이상 받을 수 없습니다.
63
- ```javascript
64
- chat.unsubscribe(CHANNEL_ID);
65
- ```
66
-
67
- | ID | type | desc |
68
- | :--------- | :----- | :---------- |
69
- | CHANNEL_ID | string | 채널 아이디 |
70
-
71
-
72
- ### 2. SendMessage
73
-
74
- - 특정 채널로 간단한 메시지 보내는 방법을 보여줍니다.
75
-
76
- ```javascript
77
- await chat.sendMessage(CHANNEL_ID, {
78
- type: "text",
79
- message: MESSAGE
80
- });
81
- ```
82
-
83
- | ID | type | desc |
84
- | :--------- | :----- | :----------------- |
85
- | CHANNEL_ID | string | 채널 아이디 |
86
- | type | string | 보내는 메시지 종류 |
87
- | MESSAGE | string | 전송 메시지 텍스트 |
88
-
89
- ### 2. SendImage
90
-
91
- - 특정 채널로 이미지 파일을 전송할 수 있습니다.
92
- ```html
93
- <input type="file" id="uploadfile" name="file" onChange={fileUpload} />
94
- ```
95
-
96
- ```javascript
97
- await chat.sendImage(CHANNEL_ID,file);
98
- ```
99
-
100
- | ID | type | desc |
101
- | :--------- | :----- | :----------------- |
102
- | CHANNEL_ID | string | 채널 아이디 |
103
- | file | string | 보내는 메시지 종류 |
104
-
105
- ## Event
106
-
107
- ### Binding Event
108
-
109
- - 다양한 수신하는 이벤트에 대해, 이벤트 핸들러를 등록/해제 할 수 있습니다,
110
-
111
- ```javascript
112
- // 메시지 수신
113
- chat.bind('onMessageReceived',function(channel, message) {
114
- });
115
- // 오류 메시지
116
- chat.bind('onErrorReceived',function(error) {
117
- });
118
- // 접속 성공
119
- chat.bind('onConnected',function(socket) {
120
- });
121
- // 접속 종료
122
- chat.bind('onDisconnected',function(reason) {
123
- });
124
- ```
125
-
126
- ## Client API
127
-
128
- ### 1-1. Subscription
129
-
130
- - Subscription Data Class
131
-
132
- | ID | type | desc |
133
- | :--------- | :----- | :------------ |
134
- | id | string | 유니크 아이디 |
135
- | channel_id | string | 채널 아이디 |
136
- | user_id | string | 유저 고유 아이디 |
137
- | created_at | string | 생성 일자 |
138
- | online | boolean | 온라인 여부 |
139
- | push | boolean | 푸시 참여 여부 |
140
- | language | string | 접속 언어 |
141
- | mark.user_id | string | 마지막 메시지 보낸 사용자 |
142
- | mark.message_id | string | 마지막 메시지 아이디 |
143
- | mark.sort_id | string | 마지막 메시지 정렬ID |
144
-
145
- ### 1-2. getSubscriptions
146
-
147
- - (특정 채널에 대해) 참여자 리스트를 가져올 수 있습니다.
148
-
149
- ```javascript
150
- const filter = {channel_id:channelId};
151
- const sort = {created_at:-1};
152
- const option = { offset:0, limit:100};
153
- const subscriptions = await chat.getSubscriptions(filter, sort, option);
154
- console.log(subscriptions);
155
- ```
156
-
157
- ### 2-1. Channel
158
-
159
- - Channel Data Class
160
-
161
- | ID | type | desc |
162
- | :--------- | :----- | :--------------------------- |
163
- | id | string | 채널 아이디(unique) |
164
- | project_id | string | 프로젝트 아이디 |
165
- | unique_id | string | 개발사에서 설정 가능한 채널 아이디 (unique) |
166
- | name | string | 채널 이름 |
167
- | user_id | string | (채널 생성한) 유저 아이디 |
168
- | unique_id | string | 채널 고유ID |
169
- | default_lang | string | 기본 언어 |
170
- | lang | string | 현재 접속중인 이용자의 언어 |
171
- | members | string | Private 일 경우 참여된 사용자 목록 |
172
- | push | boolean | 푸시 메시지 지원 여부 (Private 채널 일 경우)
173
- | state | boolean | 채널 상태 |
174
- | created_at | string | 생성 일자 |
175
- | updated_at | string | 갱신 일자 |
176
-
177
-
178
- ### 2-2. getChannels
179
-
180
- - (프로젝트 내) 전체 채널 리스트를 가져올 수 있습니다.
181
-
182
- ```javascript
183
- const filter = {state:true};
184
- const sort = {created_at:-1};
185
- const option = { offset:0, limit:100};
186
- const channels = await chat.getChannels(filter,sort,option);
187
- console.log(channels);
188
- ```
189
-
190
- | ID | type | desc |
191
- | :--------- | :----- | :--------------------------- |
192
- | FILTER | string | 사용자가 사용할 필터 입니다. 모든 필드에 대해서 쿼리를 하실 수 있습니다. |
193
- | SORT | string | 정렬을 할 수 있습니다. (ascending (1) or descending (-1)) |
194
- | OPTION | string | 페이징 및 선택 옵션들 추가할 수 있습니다. |
195
-
196
- ### 2-3. getChannel
197
-
198
- - 개별 채널에 대한 정보를 가져올 수 있습니다.
199
-
200
- ```javascript
201
- const channel = await chat.getChannel(id);
202
- ```
203
-
204
- ### 2-4. createChannel
205
-
206
- - 신규 채널을 생성합니다.
207
-
208
- ```javascript
209
- const channel = await chat.createChannel({type:"PUBLIC",name:"CHANNEL NAME"});
210
- ```
211
-
212
- ### 2-5. deleteChannel
213
-
214
- - 해당 채널을 삭제합니다. ( 한 개부터 여러개 삭제가 가능합니다.)
215
-
216
- ```javascript
217
- const channel = await chat.deleteChannel([CHANNEL_ID, CHANNEL_ID, CHANNEL_ID]);
218
- ```
219
-
220
- ### 2-6. updateChannel
221
- - 채널 정보를 업데이트 합니다.
222
-
223
- ```javascript
224
- const channel = await chat.updateChannel({id: CHANNEL_ID, type:"PUBLIC",name:"CHANNEL NAME"});
225
- ```
226
-
227
- ### 3-1. Message
228
-
229
- - Message Data Class
230
-
231
- | ID | type | desc |
232
- | :--------- | :----- | :--------------------------- |
233
- | id | string | 아이디(unique) |
234
- | message_id | string | 메시지 아이디 |
235
- | sort_id | string | 메시지 정렬을 위한 ID |
236
- | message_type | string | 메시지 종류 |
237
- | sender.id | string | 보낸 사람 ID |
238
- | sender.name | string | 보낸 사람 이름 |
239
- | sender.profile | string | 보낸 사람 프로필 이미지 |
240
- | metions | string | 맨션된 리스트 |
241
- | metions_everyone | string | 전체 맨션 여부 |
242
- | content | string | 메시지
243
- | created_at | string | 생성 일자 |
244
- | sended_at | string | 보낸 일자 |
245
- ### 2-3. getChannel
246
-
247
- - 개별 메시지에 대한 정보를 가져올 수 있습니다.
248
-
249
- ```javascript
250
- const channel = await chat.getMessage(message_id);
251
- ```
252
-
253
- ### 3-1. getMessages
254
-
255
- - (특정 채널에 대해) Message 데이터를 리스트 형태로 가져올 수 있습니다.
256
-
257
- ```javascript
258
- const filter = {channel_id: CHANNEL_ID};
259
- const sort = {created_at:-1};
260
- const option = { offset:0, limit:100};
261
- const messages = await chat.getMessages(filter, sort, option);
262
- console.log(messages);
263
- ```
264
-
265
- | ID | type | desc |
266
- | :--------- | :----- | :--------------------------- |
267
- | FILTER | string | 사용자가 사용할 필터 입니다. 모든 필드에 대해서 쿼리를 하실 수 있습니다. |
268
- | SORT | string | created_at: -1 or created_at:1 옵션만 사용가능 합니다. |
269
- | OPTION | string | 페이징 및 선택 옵션들 추가할 수 있습니다. |
270
-
271
- ### 3-3. translateMessage
272
-
273
- - (자동번역 기능이 활성화 되어 있을 경우) 임의의 텍스트를 (지정한 언어로) 번역할 수 있습니다.
274
-
275
- > 해당 기능은, NaverCloud PAPAGO NMT 상품을 함께 연동할 경우 사용 가능합니다. [[ NCP Papago NMT ]](https://www.ncloud.com/product/aiService/papagoNmt)
276
-
277
- - (Received) Translation Data Class
278
-
279
- ```javascript
280
- const message = await chat.translateMessage(CHANNEL_ID, { source_lang: SORCE_LANG, target_lang: TARTGET_LANG, message: MESSAGE, direct: DIRECT });
281
- ```
282
-
283
- | ID | type | desc |
284
- | :--------- | :----- | :--------------------------- |
285
- | SORCE_LANG | string | 원본 언어(source language)의 언어 코드 |
286
- | TARTGET_LANG | string | 목적 언어(target language)의 언어 코드 |
287
- | MESSAGE | string | 번역할 텍스트. 1회 호출 시 최대 5,000자까지 번역할 수 있습니다.|
288
- | DIRECT | boolean | 번역된 메시지를 즉시 발송 합니다. (option) |
289
-
package/tsconfig.json DELETED
@@ -1,32 +0,0 @@
1
- {
2
- "compileOnSave": true,
3
- "compilerOptions": {
4
- "outDir": "./esm",
5
- "module": "es6",
6
- "lib": ["dom", "es2015", "es2016", "es2017"],
7
- "moduleResolution": "node",
8
- "allowJs": false,
9
- "declaration": true,
10
- "downlevelIteration": true,
11
- "strict": true,
12
- "strictNullChecks": true,
13
- "sourceMap": true,
14
- "strictPropertyInitialization": false,
15
- "noImplicitThis": true,
16
- "baseUrl": "./src",
17
- "esModuleInterop": true,
18
- "suppressImplicitAnyIndexErrors": true,
19
- "typeRoots": [
20
- "./types",
21
- "./node_modules/@types"
22
- ]
23
- },
24
- "exclude": [
25
- "node_modules",
26
- "coverage",
27
- "esm",
28
- "test",
29
- "dist",
30
- "lib"
31
- ]
32
- }
package/types/exif.d.ts DELETED
@@ -1,10 +0,0 @@
1
- // 原类型有问题，这里覆盖下
2
- declare module 'exif-js' {
3
- interface EXIFStatic {
4
- getData(img: HTMLImageElement, callback: () => void): void
5
- getTag(img: HTMLImageElement, tag: string): number
6
- }
7
-
8
- const EXIF: EXIFStatic
9
- export { EXIF }
10
- }
package/types/window.d.ts DELETED
@@ -1,5 +0,0 @@
1
- interface Window {
2
- webkitURL?: typeof URL
3
- mozURL?: typeof URL
4
- ActiveXObject?: any
5
- }
package//353/260/260/355/217/254/354/210/234/354/204/234.md DELETED
@@ -1,8 +0,0 @@
1
- - package.json 수정
2
- name 을 cloudchat ncloudchat 으로 수정한다.
3
-
4
- - 배포 한다.
5
- npm publish
6
-
7
- - 릴리즈 서버에 배포한다.
8
- npm run deploy-release