agora-token 2.0.4 → 2.0.5

package/index.d.ts

@@ -357,6 +357,49 @@ export namespace RtcTokenBuilder {
         tokenExpire: number,
         privilegeExpire: number
     ): string
+
+    /**
+     * Build an RTC and RTM token with account.
+     * @param {*} appId  The App ID issued to you by Agora.
+     * @param {*} appCertificate Certificate of the application that you registered in the Agora Dashboard.
+     * @param {*} channelName The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
+     * - The 26 lowercase English letters: a to z.
+     * - The 26 uppercase English letters: A to Z.
+     * - The 10 digits: 0 to 9.
+     * - The space.
+     * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+     * @param {*} rtcAccount The RTC user's account, max length is 255 Bytes.
+     * @param {*} rtcRole See #userRole.
+     * - Role.PUBLISHER; RECOMMENDED. Use this role for a voice/video call or a live broadcast.
+     * - Role.SUBSCRIBER: ONLY use this role if your live-broadcast scenario requires authentication for [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication). In order for this role to take effect, please contact our support team to enable authentication for Co-host for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
+     * @param {*} rtcTokenExpire epresented 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 tokenExpire as 600(seconds)
+     * @param {*} joinChannelPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set joinChannelPrivilegeExpire as 600(seconds).
+     * @param {*} pubAudioPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire as 600(seconds).
+     * @param {*} pubVideoPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire as 600(seconds).
+     * @param {*} pubDataStreamPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish data stream privilege for 10 minutes, set pubDataStreamPrivilegeExpire as 600(seconds).
+     * @param rtmUserId: The RTM user's account, max length is 255 Bytes.
+     * @param rtmTokenExpire: 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 rtmTokenExpire as 600(seconds).
+     * * @return The RTC and RTM Token.
+     */
+    export function buildTokenWithRtm2(
+        appId: string,
+        appCertificate: string,
+        channelName: string,
+        rtcAccount: string | number,
+        rtcRole: number,
+        rtcTokenExpire: number,
+        joinChannelPrivilegeExpire: number,
+        pubAudioPrivilegeExpire: number,
+        pubVideoPrivilegeExpire: number,
+        pubDataStreamPrivilegeExpire: number,
+        rtmUserId: string | number,
+        rtmTokenExpire: number
+    ): string
 }
 
 export namespace RtmTokenBuilder {

package/package.json

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

package/sample/AccessToken2Sample.js

@@ -1,26 +1,36 @@
-const { AccessToken2, ServiceRtc } = require("../src/AccessToken2");
-const RtcRole = require("../src/RtcTokenBuilder").Role;
+const { AccessToken2, ServiceRtc } = require('../src/AccessToken2')
+const RtcRole = require('../src/RtcTokenBuilder2').Role
 
 // Need to set environment variable AGORA_APP_ID
-const appId = process.env.AGORA_APP_ID;
+const appId = process.env.AGORA_APP_ID
 // Need to set environment variable AGORA_APP_CERTIFICATE
-const appCertificate = process.env.AGORA_APP_CERTIFICATE;
+const appCertificate = process.env.AGORA_APP_CERTIFICATE
 
-const channelName = "7d72365eb983485397e3e3f9d460bdda";
-const uid = 2882341273;
-const account = "2882341273";
-const role = RtcRole.PUBLISHER;
-const expirationTimeInSeconds = 3600;
-const currentTimestamp = Math.floor(Date.now() / 1000);
+const channelName = '7d72365eb983485397e3e3f9d460bdda'
+const uid = 2882341273
+// const account = '2882341273'
+const role = RtcRole.PUBLISHER
+const tokenExpirationInSecond = 3600
+const joinChannelPrivilegeExpireInSeconds = 3600
+const pubAudioPrivilegeExpireInSeconds = 3600
+const pubVideoPrivilegeExpireInSeconds = 3600
+const pubDataStreamPrivilegeExpireInSeconds = 3600
 
-console.log("App Id:", appId);
-console.log("App Certificate:", appCertificate);
-if (appId == undefined || appId == "" || appCertificate == undefined || appCertificate == "") {
-    console.log("Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE");
-    process.exit(1);
+console.log('App Id:', appId)
+console.log('App Certificate:', appCertificate)
+if (appId == undefined || appId == '' || appCertificate == undefined || appCertificate == '') {
+    console.log('Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE')
+    process.exit(1)
 }
 
-let token = new AccessToken2(appId, appCertificate, currentTimestamp, expirationTimeInSeconds);
-let rtc_service = new ServiceRtc(channelName, uid);
-token.add_service(rtc_service);
-console.log("Token: ", token.build());
+let token = new AccessToken2(appId, appCertificate, 0, tokenExpirationInSecond)
+let serviceRtc = new ServiceRtc(channelName, uid)
+serviceRtc.add_privilege(ServiceRtc.kPrivilegeJoinChannel, joinChannelPrivilegeExpireInSeconds)
+if (role == RtcRole.PUBLISHER) {
+    serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, pubAudioPrivilegeExpireInSeconds)
+    serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, pubVideoPrivilegeExpireInSeconds)
+    serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishDataStream, pubDataStreamPrivilegeExpireInSeconds)
+}
+token.add_service(serviceRtc)
+
+console.log('Token: ', token.build())

package/sample/RtcTokenBuilder2Sample.js

@@ -84,3 +84,19 @@ const tokenWithRtm = RtcTokenBuilder.buildTokenWithRtm(
     privilegeExpirationInSecond
 )
 console.log('Token with RTM:', tokenWithRtm)
+
+const tokenWithRtm2 = RtcTokenBuilder.buildTokenWithRtm2(
+    appId,
+    appCertificate,
+    channelName,
+    account,
+    role,
+    tokenExpirationInSecond,
+    joinChannelPrivilegeExpireInSeconds,
+    pubAudioPrivilegeExpireInSeconds,
+    pubVideoPrivilegeExpireInSeconds,
+    pubDataStreamPrivilegeExpireInSeconds,
+    account,
+    tokenExpirationInSecond
+)
+console.log('Token with RTM:', tokenWithRtm2)

package/src/RtcTokenBuilder2.js

@@ -268,6 +268,66 @@ class RtcTokenBuilder {
 
         return token.build()
     }
+
+    /**
+     * Build an RTC and RTM token with account.
+     * @param {*} appId  The App ID issued to you by Agora.
+     * @param {*} appCertificate Certificate of the application that you registered in the Agora Dashboard.
+     * @param {*} channelName The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
+     * - The 26 lowercase English letters: a to z.
+     * - The 26 uppercase English letters: A to Z.
+     * - The 10 digits: 0 to 9.
+     * - The space.
+     * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+     * @param {*} rtcAccount The RTC user's account, max length is 255 Bytes.
+     * @param {*} rtcRole See #userRole.
+     * - Role.PUBLISHER; RECOMMENDED. Use this role for a voice/video call or a live broadcast.
+     * - Role.SUBSCRIBER: ONLY use this role if your live-broadcast scenario requires authentication for [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication). In order for this role to take effect, please contact our support team to enable authentication for Co-host for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
+     * @param {*} rtcTokenExpire epresented 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 tokenExpire as 600(seconds)
+     * @param {*} joinChannelPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set joinChannelPrivilegeExpire as 600(seconds).
+     * @param {*} pubAudioPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire as 600(seconds).
+     * @param {*} pubVideoPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire as 600(seconds).
+     * @param {*} pubDataStreamPrivilegeExpire represented by the number of seconds elapsed since now.
+     * If, for example, you want to enable publish data stream privilege for 10 minutes, set pubDataStreamPrivilegeExpire as 600(seconds).
+     * @param {*} rtmUserId: The RTM user's account, max length is 255 Bytes.
+     * @param {*} rtmTokenExpire: 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 rtmTokenExpire as 600(seconds).
+     * * @return The RTC and RTM Token.
+     */
+    static buildTokenWithRtm2(
+        appId,
+        appCertificate,
+        channelName,
+        rtcAccount,
+        rtcRole,
+        rtcTokenExpire,
+        joinChannelPrivilegeExpire,
+        pubAudioPrivilegeExpire,
+        pubVideoPrivilegeExpire,
+        pubDataStreamPrivilegeExpire,
+        rtmUserId,
+        rtmTokenExpire
+    ) {
+        let token = new AccessToken(appId, appCertificate, 0, rtcTokenExpire)
+
+        let serviceRtc = new ServiceRtc(channelName, rtcAccount)
+        serviceRtc.add_privilege(ServiceRtc.kPrivilegeJoinChannel, joinChannelPrivilegeExpire)
+        if (rtcRole == Role.PUBLISHER) {
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishAudioStream, pubAudioPrivilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishVideoStream, pubVideoPrivilegeExpire)
+            serviceRtc.add_privilege(ServiceRtc.kPrivilegePublishDataStream, pubDataStreamPrivilegeExpire)
+        }
+        token.add_service(serviceRtc)
+
+        let serviceRtm = new ServiceRtm(rtmUserId)
+        serviceRtm.add_privilege(ServiceRtm.kPrivilegeLogin, rtmTokenExpire)
+        token.add_service(serviceRtm)
+
+        return token.build()
+    }
 }
 
 module.exports.RtcTokenBuilder = RtcTokenBuilder