agora-token 2.0.0 → 2.0.2

package/index.d.ts

@@ -230,3 +230,32 @@ export namespace FpaTokenBuilder {
      */
     export function buildToken(appId: string, appCertificate: string): string;
 }
+
+export namespace ChatTokenBuilder {
+    /**
+     * Build the Chat user token.
+     *
+     * @param appId The App ID issued to you by Agora. Apply for a new App ID from
+     * Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate Certificate of the application that you registered in
+     * the Agora Dashboard. See Get an App Certificate.
+     * @param userUuid The user's id, must be unique.
+     * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
+     * Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * @return The chat user token.
+     */
+     export function buildUserToken(appId: string, appCertificate: string, userId: string | number, expire: number): string;
+
+    /**
+     * Build the Chat App token.
+     *
+     * @param appId The App ID issued to you by Agora. Apply for a new App ID from
+     * Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate Certificate of the application that you registered in
+     * the Agora Dashboard. See Get an App Certificate.
+     * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
+     * Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * @return The chat App token.
+     */
+     export function buildAppToken(appId: string, appCertificate: string, expire: number): string;
+}

package/index.js

@@ -3,5 +3,6 @@ module.exports = {
   RtcRole: require('./src/RtcTokenBuilder2').Role,
   RtmTokenBuilder: require('./src/RtmTokenBuilder2').RtmTokenBuilder,
   EducationTokenBuilder: require('./src/EducationTokenBuilder').EducationTokenBuilder,
-  FpaTokenBuilder: require('./src/FpaTokenBuilder').FpaTokenBuilder
+  FpaTokenBuilder: require('./src/FpaTokenBuilder').FpaTokenBuilder,
+  ChatTokenBuilder: require('./src/ChatTokenBuilder').ChatTokenBuilder
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-token",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "",
   "homepage": "https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/nodejs",
   "main": "index.js",

package/sample/ChatTokenBuilderSample.js

@@ -0,0 +1,11 @@
+const ChatTokenBuilder = require("../src/ChatTokenBuilder").ChatTokenBuilder;
+const appId = "970CA35de60c44645bbae8a215061b33";
+const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b";
+const userUuid = "a7180cb0-1d4a-11ed-9210-89ff47c9da5e";
+const expirationInSeconds = 600;
+
+const userToken = ChatTokenBuilder.buildUserToken(appId, appCertificate, userUuid, expirationInSeconds);
+console.log("Chat User Token: " + userToken + "\n");
+
+const appToken = ChatTokenBuilder.buildAppToken(appId, appCertificate, expirationInSeconds)
+console.log("Chat App Token: " + appToken);

package/src/ChatTokenBuilder.js

@@ -0,0 +1,46 @@
+const AccessToken = require("../src/AccessToken2").AccessToken2;
+const ServiceChat = require("../src/AccessToken2").ServiceChat;
+
+class ChatTokenBuilder {
+    /**
+     * Build the Chat user token.
+     *
+     * @param appId The App ID issued to you by Agora. Apply for a new App ID from
+     * Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate Certificate of the application that you registered in
+     * the Agora Dashboard. See Get an App Certificate.
+     * @param userUuid The user's id, must be unique.
+     * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
+     * Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * @return The chat user token.
+     */
+    static buildUserToken(appId, appCertificate, userUuid, expire) {
+        const token = new AccessToken(appId, appCertificate, null, expire);
+        const serviceChat = new ServiceChat(userUuid);
+        serviceChat.add_privilege(ServiceChat.kPrivilegeUser, expire);
+        token.add_service(serviceChat);
+        return token.build();
+    }
+
+    /**
+     * Build the Chat App token.
+     *
+     * @param appId The App ID issued to you by Agora. Apply for a new App ID from
+     * Agora Dashboard if it is missing from your kit. See Get an App ID.
+     * @param appCertificate Certificate of the application that you registered in
+     * the Agora Dashboard. See Get an App Certificate.
+     * @param expire represented by the number of seconds elapsed since now. If, for example, you want to access the
+     * Agora Service within 10 minutes after the token is generated, set expireTimestamp as 600(seconds).
+     * @return The chat App token.
+     */
+    static buildAppToken(appId, appCertificate, expire) {
+    	const token = new AccessToken(appId, appCertificate, null, expire);
+    	const serviceChat = new ServiceChat();
+    	serviceChat.add_privilege(ServiceChat.kPrivilegeApp, expire);
+    	token.add_service(serviceChat);
+    	return token.build();
+    }
+}
+
+exports.ChatTokenBuilder = ChatTokenBuilder;
+

package/test/ChatTokenBuilderTest.js

@@ -0,0 +1,34 @@
+/**
+ * run this test with command:
+ * nodeunit ChatTokenBuilderTest.js
+ * see https://github.com/caolan/nodeunit
+ */
+const ChatTokenBuilder = require("../src/ChatTokenBuilder").ChatTokenBuilder;
+const { AccessToken2, ServiceChat, kChatServiceType } = require("../src/AccessToken2");
+
+const appId = "970CA35de60c44645bbae8a215061b33";
+const appCertificate = "5CFd2fd1755d40ecb72977518be15d3b";
+const userUuid = "2882341273";
+const expire = 600;
+
+exports.buildUserToken_Test = function (test) {
+    let token = ChatTokenBuilder.buildUserToken(appId, appCertificate, userUuid, expire);
+    let accessToken = new AccessToken2("", "", 0, 0);
+    accessToken.from_string(token);
+    test.equal(appId, accessToken.appId);
+    test.equal(expire, accessToken.expire);
+    test.equal(userUuid, accessToken.services[kChatServiceType].__user_id);
+    test.equal(expire, accessToken.services[kChatServiceType].__privileges[ServiceChat.kPrivilegeUser]);
+    test.done();
+};
+
+exports.buildAppToken_Test = function (test) {
+	let token = ChatTokenBuilder.buildAppToken(appId, appCertificate, expire);
+    let accessToken = new AccessToken2("", "", 0, 0);
+    accessToken.from_string(token);
+    test.equal(appId, accessToken.appId);
+    test.equal(expire, accessToken.expire);
+    test.equal(expire, accessToken.services[kChatServiceType].__privileges[ServiceChat.kPrivilegeApp]);
+    test.done();
+}
+