agora-token 2.0.1 → 2.0.3

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 (8) hide show
  1. package/README.md +14 -0
  2. package/package.json +5 -3
  3. package/sample.js +1 -1
  4. package/.idea/misc.xml +0 -6
  5. package/.idea/modules.xml +0 -8
  6. package/.idea/nodejs.iml +0 -8
  7. package/.idea/vcs.xml +0 -6
  8. package/.idea/workspace.xml +0 -294
package/README.md CHANGED
@@ -2,6 +2,20 @@
2
2
 
3
3
  To enhance communication security, Agora uses tokens to authenticate users before they access the Agora service, or joining an RTC channel.
4
4
 
5
+ ## Installation
6
+
7
+ This is a [Node.js](https://nodejs.org/en/) module available through the
8
+ [npm registry](https://www.npmjs.com/).
9
+
10
+ Before installing, [download and install Node.js](https://nodejs.org/en/download/).
11
+
12
+ Installation is done using the
13
+ [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
14
+
15
+ ```console
16
+ $ npm install agora-token
17
+ ```
18
+
5
19
  ## Code structure
6
20
 
7
21
  Under the `nodejs` directory:
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "agora-token",
3
- "version": "2.0.1",
3
+ "version": "2.0.3",
4
4
  "description": "",
5
5
  "homepage": "https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/nodejs",
6
6
  "main": "index.js",
7
7
  "scripts": {
8
- "test": "echo \"Error: no test specified\" && exit 1"
8
+ "test": "nodeunit test/*.js"
9
9
  },
10
10
  "types": "index.d.ts",
11
11
  "author": "",
@@ -13,7 +13,9 @@
13
13
  "dependencies": {
14
14
  "crc-32": "^1.2.0",
15
15
  "cuint": "0.2.2",
16
- "md5": "^2.3.0",
16
+ "md5": "^2.3.0"
17
+ },
18
+ "devDependencies": {
17
19
  "nodeunit": "^0.11.3"
18
20
  }
19
21
  }
package/sample.js CHANGED
@@ -22,7 +22,7 @@ const generateRtcToken = () => {
22
22
  console.log("Token With Integer Number Uid: " + tokenA);
23
23
 
24
24
  // Build token with user account
25
- const tokenB = RtcTokenBuilder.buildTokenWithAccount(appID, appCertificate, channelName, account, role, privilegeExpiredTs);
25
+ const tokenB = RtcTokenBuilder.buildTokenWithUserAccount(appID, appCertificate, channelName, account, role, privilegeExpiredTs);
26
26
  console.log("Token With UserAccount: " + tokenB);
27
27
  }
28
28
 
package/.idea/misc.xml DELETED
@@ -1,6 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <project version="4">
3
- <component name="JavaScriptSettings">
4
- <option name="languageLevel" value="ES6" />
5
- </component>
6
- </project>
package/.idea/modules.xml DELETED
@@ -1,8 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <project version="4">
3
- <component name="ProjectModuleManager">
4
- <modules>
5
- <module fileurl="file://$PROJECT_DIR$/.idea/nodejs.iml" filepath="$PROJECT_DIR$/.idea/nodejs.iml" />
6
- </modules>
7
- </component>
8
- </project>
package/.idea/nodejs.iml DELETED
@@ -1,8 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <module type="WEB_MODULE" version="4">
3
- <component name="NewModuleRootManager">
4
- <content url="file://$MODULE_DIR$" />
5
- <orderEntry type="inheritedJdk" />
6
- <orderEntry type="sourceFolder" forTests="false" />
7
- </component>
8
- </module>
package/.idea/vcs.xml DELETED
@@ -1,6 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <project version="4">
3
- <component name="VcsDirectoryMappings">
4
- <mapping directory="$PROJECT_DIR$/../../.." vcs="Git" />
5
- </component>
6
- </project>
package/.idea/workspace.xml DELETED
@@ -1,294 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <project version="4">
3
- <component name="BranchesTreeState">
4
- <expand>
5
- <path>
6
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
7
- <item name="LOCAL_ROOT" type="e8cecc67:BranchNodeDescriptor" />
8
- </path>
9
- <path>
10
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
11
- <item name="LOCAL_ROOT" type="e8cecc67:BranchNodeDescriptor" />
12
- <item name="GROUP_NODE:dev" type="e8cecc67:BranchNodeDescriptor" />
13
- </path>
14
- <path>
15
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
16
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
17
- </path>
18
- <path>
19
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
20
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
21
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
22
- </path>
23
- <path>
24
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
25
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
26
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
27
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
28
- </path>
29
- <path>
30
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
31
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
32
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
33
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
34
- <item name="GROUP_NODE:maven" type="e8cecc67:BranchNodeDescriptor" />
35
- </path>
36
- <path>
37
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
38
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
39
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
40
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
41
- <item name="GROUP_NODE:maven" type="e8cecc67:BranchNodeDescriptor" />
42
- <item name="GROUP_NODE:DynamicKey" type="e8cecc67:BranchNodeDescriptor" />
43
- </path>
44
- <path>
45
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
46
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
47
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
48
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
49
- <item name="GROUP_NODE:maven" type="e8cecc67:BranchNodeDescriptor" />
50
- <item name="GROUP_NODE:DynamicKey" type="e8cecc67:BranchNodeDescriptor" />
51
- <item name="GROUP_NODE:AgoraDynamicKey" type="e8cecc67:BranchNodeDescriptor" />
52
- </path>
53
- <path>
54
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
55
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
56
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
57
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
58
- <item name="GROUP_NODE:maven" type="e8cecc67:BranchNodeDescriptor" />
59
- <item name="GROUP_NODE:DynamicKey" type="e8cecc67:BranchNodeDescriptor" />
60
- <item name="GROUP_NODE:AgoraDynamicKey" type="e8cecc67:BranchNodeDescriptor" />
61
- <item name="GROUP_NODE:java" type="e8cecc67:BranchNodeDescriptor" />
62
- </path>
63
- <path>
64
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
65
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
66
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
67
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
68
- <item name="GROUP_NODE:npm_and_yarn" type="e8cecc67:BranchNodeDescriptor" />
69
- </path>
70
- <path>
71
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
72
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
73
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
74
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
75
- <item name="GROUP_NODE:npm_and_yarn" type="e8cecc67:BranchNodeDescriptor" />
76
- <item name="GROUP_NODE:DynamicKey" type="e8cecc67:BranchNodeDescriptor" />
77
- </path>
78
- <path>
79
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
80
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
81
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
82
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
83
- <item name="GROUP_NODE:npm_and_yarn" type="e8cecc67:BranchNodeDescriptor" />
84
- <item name="GROUP_NODE:DynamicKey" type="e8cecc67:BranchNodeDescriptor" />
85
- <item name="GROUP_NODE:AgoraDynamicKey" type="e8cecc67:BranchNodeDescriptor" />
86
- </path>
87
- <path>
88
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
89
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
90
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
91
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
92
- <item name="GROUP_NODE:npm_and_yarn" type="e8cecc67:BranchNodeDescriptor" />
93
- <item name="GROUP_NODE:DynamicKey" type="e8cecc67:BranchNodeDescriptor" />
94
- <item name="GROUP_NODE:AgoraDynamicKey" type="e8cecc67:BranchNodeDescriptor" />
95
- <item name="GROUP_NODE:nodejs" type="e8cecc67:BranchNodeDescriptor" />
96
- </path>
97
- <path>
98
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
99
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
100
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
101
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
102
- <item name="GROUP_NODE:npm_and_yarn" type="e8cecc67:BranchNodeDescriptor" />
103
- <item name="GROUP_NODE:DynamicKey" type="e8cecc67:BranchNodeDescriptor" />
104
- <item name="GROUP_NODE:AgoraDynamicKey" type="e8cecc67:BranchNodeDescriptor" />
105
- <item name="GROUP_NODE:nodejs" type="e8cecc67:BranchNodeDescriptor" />
106
- <item name="GROUP_NODE:server" type="e8cecc67:BranchNodeDescriptor" />
107
- </path>
108
- <path>
109
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
110
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
111
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
112
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
113
- <item name="GROUP_NODE:npm_and_yarn" type="e8cecc67:BranchNodeDescriptor" />
114
- <item name="GROUP_NODE:TroubleShooting" type="e8cecc67:BranchNodeDescriptor" />
115
- </path>
116
- <path>
117
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
118
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
119
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
120
- <item name="GROUP_NODE:dependabot" type="e8cecc67:BranchNodeDescriptor" />
121
- <item name="GROUP_NODE:npm_and_yarn" type="e8cecc67:BranchNodeDescriptor" />
122
- <item name="GROUP_NODE:TroubleShooting" type="e8cecc67:BranchNodeDescriptor" />
123
- <item name="GROUP_NODE:Agora-WebRTC-Troubleshooting" type="e8cecc67:BranchNodeDescriptor" />
124
- </path>
125
- <path>
126
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
127
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
128
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
129
- <item name="GROUP_NODE:dev" type="e8cecc67:BranchNodeDescriptor" />
130
- </path>
131
- <path>
132
- <item name="ROOT" type="e8cecc67:BranchNodeDescriptor" />
133
- <item name="REMOTE_ROOT" type="e8cecc67:BranchNodeDescriptor" />
134
- <item name="GROUP_NODE:origin" type="e8cecc67:BranchNodeDescriptor" />
135
- <item name="GROUP_NODE:golem" type="e8cecc67:BranchNodeDescriptor" />
136
- </path>
137
- </expand>
138
- <select />
139
- </component>
140
- <component name="ChangeListManager">
141
- <list default="true" id="d6507ff0-2195-45b1-a54e-445b180f6ba8" name="Default Changelist" comment="chore(nodejs): remove chat_user_id" />
142
- <option name="SHOW_DIALOG" value="false" />
143
- <option name="HIGHLIGHT_CONFLICTS" value="true" />
144
- <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
145
- <option name="LAST_RESOLUTION" value="IGNORE" />
146
- </component>
147
- <component name="ComposerSettings">
148
- <execution />
149
- </component>
150
- <component name="Git.Settings">
151
- <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$/../../.." />
152
- </component>
153
- <component name="MarkdownSettingsMigration">
154
- <option name="stateVersion" value="1" />
155
- </component>
156
- <component name="ProjectId" id="1xG1JQ4BoYLfSQMJPv43drgX0sB" />
157
- <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
158
- <component name="ProjectViewState">
159
- <option name="hideEmptyMiddlePackages" value="true" />
160
- <option name="showLibraryContents" value="true" />
161
- </component>
162
- <component name="PropertiesComponent"><![CDATA[{
163
- "keyToString": {
164
- "WebServerToolWindowFactoryState": "false",
165
- "dart.analysis.tool.window.visible": "false",
166
- "nodejs_package_manager_path": "npm",
167
- "vue.rearranger.settings.migration": "true"
168
- }
169
- }]]></component>
170
- <component name="RecentsManager">
171
- <key name="CopyFile.RECENT_KEYS">
172
- <recent name="$PROJECT_DIR$/sample" />
173
- <recent name="$PROJECT_DIR$/test" />
174
- <recent name="$PROJECT_DIR$/src" />
175
- </key>
176
- </component>
177
- <component name="RunManager" selected="Node.js.AccessToken2Test.js">
178
- <configuration name="AccessToken2Sample.js" type="NodeJSConfigurationType" temporary="true" nameIsGenerated="true" path-to-js-file="$PROJECT_DIR$/sample/AccessToken2Sample.js" working-dir="$PROJECT_DIR$/sample">
179
- <method v="2" />
180
- </configuration>
181
- <configuration name="AccessToken2Test.js" type="NodeJSConfigurationType" temporary="true" nameIsGenerated="true" path-to-js-file="$PROJECT_DIR$/test/AccessToken2Test.js" working-dir="$PROJECT_DIR$/test">
182
- <method v="2" />
183
- </configuration>
184
- <configuration name="FpaTokenBuilderSample.js" type="NodeJSConfigurationType" temporary="true" nameIsGenerated="true" path-to-js-file="$PROJECT_DIR$/sample/FpaTokenBuilderSample.js" working-dir="$PROJECT_DIR$/sample">
185
- <method v="2" />
186
- </configuration>
187
- <configuration name="RtcTokenBuilder2Sample.js" type="NodeJSConfigurationType" temporary="true" nameIsGenerated="true" path-to-js-file="$PROJECT_DIR$/sample/RtcTokenBuilder2Sample.js" working-dir="$PROJECT_DIR$/sample">
188
- <method v="2" />
189
- </configuration>
190
- <configuration name="RtcTokenBuilder2Test.js" type="NodeJSConfigurationType" temporary="true" nameIsGenerated="true" path-to-js-file="$PROJECT_DIR$/test/RtcTokenBuilder2Test.js" working-dir="$PROJECT_DIR$/test">
191
- <method v="2" />
192
- </configuration>
193
- <recent_temporary>
194
- <list>
195
- <item itemvalue="Node.js.AccessToken2Test.js" />
196
- <item itemvalue="Node.js.RtcTokenBuilder2Sample.js" />
197
- <item itemvalue="Node.js.AccessToken2Sample.js" />
198
- <item itemvalue="Node.js.RtcTokenBuilder2Test.js" />
199
- <item itemvalue="Node.js.FpaTokenBuilderSample.js" />
200
- </list>
201
- </recent_temporary>
202
- </component>
203
- <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
204
- <component name="SvnConfiguration">
205
- <configuration />
206
- </component>
207
- <component name="TaskManager">
208
- <task active="true" id="Default" summary="Default task">
209
- <changelist id="d6507ff0-2195-45b1-a54e-445b180f6ba8" name="Default Changelist" comment="" />
210
- <created>1629966538838</created>
211
- <option name="number" value="Default" />
212
- <option name="presentableId" value="Default" />
213
- <updated>1629966538838</updated>
214
- <workItem from="1629966540332" duration="4662000" />
215
- <workItem from="1629982312897" duration="898000" />
216
- <workItem from="1631965358288" duration="642000" />
217
- <workItem from="1636426199825" duration="19504000" />
218
- <workItem from="1636513011845" duration="73000" />
219
- <workItem from="1636514196185" duration="205000" />
220
- <workItem from="1640083978203" duration="1072000" />
221
- <workItem from="1644560749223" duration="594000" />
222
- <workItem from="1645514970967" duration="696000" />
223
- <workItem from="1646282495653" duration="34000" />
224
- <workItem from="1658144373539" duration="146000" />
225
- </task>
226
- <task id="LOCAL-00001" summary="chore(nodejs): remove chat_user_id">
227
- <created>1645515622711</created>
228
- <option name="number" value="00001" />
229
- <option name="presentableId" value="LOCAL-00001" />
230
- <option name="project" value="LOCAL" />
231
- <updated>1645515622711</updated>
232
- </task>
233
- <option name="localTasksCounter" value="2" />
234
- <servers />
235
- </component>
236
- <component name="TypeScriptGeneratedFilesManager">
237
- <option name="version" value="3" />
238
- </component>
239
- <component name="Vcs.Log.History.Properties">
240
- <option name="COLUMN_ORDER">
241
- <list>
242
- <option value="0" />
243
- <option value="2" />
244
- <option value="3" />
245
- <option value="1" />
246
- </list>
247
- </option>
248
- </component>
249
- <component name="Vcs.Log.Tabs.Properties">
250
- <option name="TAB_STATES">
251
- <map>
252
- <entry key="MAIN">
253
- <value>
254
- <State />
255
- </value>
256
- </entry>
257
- <entry key="fdebcdb2-373f-442c-a682-22825be581ed">
258
- <value>
259
- <State>
260
- <option name="SHOW_ONLY_AFFECTED_CHANGES" value="true" />
261
- <option name="FILTERS">
262
- <map>
263
- <entry key="branch">
264
- <value>
265
- <list>
266
- <option value="HEAD" />
267
- </list>
268
- </value>
269
- </entry>
270
- <entry key="structure">
271
- <value>
272
- <list>
273
- <option value="dir:/Users/lxh/sunshine/www/pj/agora/github.com/AgoraIO/Tools/DynamicKey/AgoraDynamicKey/nodejs" />
274
- </list>
275
- </value>
276
- </entry>
277
- </map>
278
- </option>
279
- </State>
280
- </value>
281
- </entry>
282
- </map>
283
- </option>
284
- <option name="OPEN_GENERIC_TABS">
285
- <map>
286
- <entry key="fdebcdb2-373f-442c-a682-22825be581ed" value="TOOL_WINDOW" />
287
- </map>
288
- </option>
289
- </component>
290
- <component name="VcsManagerConfiguration">
291
- <MESSAGE value="chore(nodejs): remove chat_user_id" />
292
- <option name="LAST_COMMIT_MESSAGE" value="chore(nodejs): remove chat_user_id" />
293
- </component>
294
- </project>