agora-token 2.0.4 → 2.0.6

package/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+    "name": "AgoraDynamicKey-nodejs",
+    "image": "node:22.4",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "swellaby.node-pack",
+                "esbenp.prettier-vscode"
+            ],
+            "settings": {
+                "[javascript]": {
+                    "editor.defaultFormatter": "esbenp.prettier-vscode"
+                },
+                "[typescript]": {
+                    "editor.defaultFormatter": "esbenp.prettier-vscode"
+                }
+            }
+        }
+    },
+    "workspaceMount": "source=${localWorkspaceFolder},target=/app,type=bind",
+    "workspaceFolder": "/app"
+}

package/.prettierrc

@@ -0,0 +1,12 @@
+{
+    "arrowParens": "avoid",
+    "bracketSameLine": false,
+    "bracketSpacing": true,
+    "jsxSingleQuote": false,
+    "printWidth": 120,
+    "semi": false,
+    "singleQuote": true,
+    "tabWidth": 4,
+    "trailingComma": "none",
+    "useTabs": false
+}

package/index.d.ts

@@ -1,3 +1,19 @@
+/** Stores RTM2 resource-level permissions. */
+export class Rtm2Permissions {
+    static readonly kMessageChannels: number
+    static readonly kStreamChannels: number
+    static readonly kGroupChannels: number
+    static readonly kServerGroups: number
+    static readonly kUsers: number
+    static readonly kRead: number
+    static readonly kWrite: number
+
+    details: { [resourceType: number]: { [permissionType: number]: string[] } }
+
+    /** Adds or replaces resources for a resource and permission type. */
+    add(resourceType: number, permissionType: number, resources: string[]): void
+}
+
 export namespace ApaasTokenBuilder {
     /**
      * build user room token
@@ -9,7 +25,9 @@ export namespace ApaasTokenBuilder {
      * @param userUuid          The user's id, must be unique.
      * @param role              The user's role.
      * @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 expire as 600(seconds).
+     *                          Agora Service within 10 minutes after the token is generated, set expire as
+     *                          600(seconds). This value is the whole token expiration and the service
+     *                          privilege expiration. The whole token is invalid after this time.
      * @return The user room token.
      */
     export function buildRoomUserToken(
@@ -29,7 +47,9 @@ export namespace ApaasTokenBuilder {
      *                          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 expire as 600(seconds).
+     *                          Agora Service within 10 minutes after the token is generated, set expire as
+     *                          600(seconds). This value is the whole token expiration and the service
+     *                          privilege expiration. The whole token is invalid after this time.
      * @return The user token.
      */
     export function buildUserToken(
@@ -46,7 +66,9 @@ export namespace ApaasTokenBuilder {
      * @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 expire as 600(seconds).
+     *                       Agora Service within 10 minutes after the token is generated, set expire as
+     *                       600(seconds). This value is the whole token expiration and the service privilege
+     *                       expiration. The whole token is invalid after this time.
      * @return The app token.
      */
     export function buildAppToken(appId: string, appCertificate: string, expire: number): string
@@ -62,7 +84,9 @@ export namespace ChatTokenBuilder {
      * 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 expire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds). This value is
+     * the whole token expiration and the service privilege expiration. The whole token is invalid after this
+     * time.
      * @return The chat user token.
      */
     export function buildUserToken(
@@ -80,7 +104,9 @@ export namespace ChatTokenBuilder {
      * @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 expire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds). This value is
+     * the whole token expiration and the service privilege expiration. The whole token is invalid after this
+     * time.
      * @return The chat App token.
      */
     export function buildAppToken(appId: string, appCertificate: string, expire: number): string
@@ -97,7 +123,9 @@ export namespace EducationTokenBuilder {
      * @param userUuid          The user's id, must be unique.
      * @param role              The user's role.
      * @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 expire as 600(seconds).
+     *                          Agora Service within 10 minutes after the token is generated, set expire as
+     *                          600(seconds). This value is the whole token expiration and the service
+     *                          privilege expiration. The whole token is invalid after this time.
      * @return The user room token.
      */
     export function buildRoomUserToken(
@@ -117,7 +145,9 @@ export namespace EducationTokenBuilder {
      *                          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 expire as 600(seconds).
+     *                          Agora Service within 10 minutes after the token is generated, set expire as
+     *                          600(seconds). This value is the whole token expiration and the service
+     *                          privilege expiration. The whole token is invalid after this time.
      * @return The user token.
      */
     export function buildUserToken(
@@ -134,7 +164,9 @@ export namespace EducationTokenBuilder {
      * @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 expire as 600(seconds).
+     *                       Agora Service within 10 minutes after the token is generated, set expire as
+     *                       600(seconds). This value is the whole token expiration and the service privilege
+     *                       expiration. The whole token is invalid after this time.
      * @return The app token.
      */
     export function buildAppToken(appId: string, appCertificate: string, expire: number): string
@@ -147,7 +179,7 @@ export namespace FpaTokenBuilder {
      * 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.
-     * @return The FPA token.
+     * @return The FPA token. The token expires 24 hours after generation.
      */
     export function buildToken(appId: string, appCertificate: string): string
 }
@@ -172,8 +204,13 @@ export namespace RtcTokenBuilder {
      * @param {*} role 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 {*} tokenExpire 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 {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds).
+     * @param {*} tokenExpire 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 tokenExpire as
+     * 600(seconds). This is the whole token expiration. The whole token is invalid after this time, even if a
+     * privilege expiration time is later.
+     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds). This value must not
+     * exceed the token expiration value; otherwise, the privilege is limited by the token expiration time.
      * @return The RTC Token.
      */
     export function buildTokenWithUid(
@@ -200,8 +237,13 @@ export namespace RtcTokenBuilder {
      * @param {*} role 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 {*} tokenExpire 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 {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds).
+     * @param {*} tokenExpire 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 tokenExpire as
+     * 600(seconds). This is the whole token expiration. The whole token is invalid after this time, even if a
+     * privilege expiration time is later.
+     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds). This value must not
+     * exceed the token expiration value; otherwise, the privilege is limited by the token expiration time.
      * @return The RTC Token.
      */
     export function buildTokenWithUserAccount(
@@ -249,15 +291,25 @@ export namespace RtcTokenBuilder {
      * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
      * @param uid The user ID. A 32-bit unsigned integer with a value range from 1 to (2^32 - 1). It must be unique. Set uid as 0, if you do not want to authenticate the user ID, that is, any uid from the app client can join the channel.
      * @param tokenExpire 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 tokenExpire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds). This is
+     * the whole token expiration. The whole token is invalid after this time, even if a privilege expiration
+     * time is later.
      * @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).
+     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set
+     * joinChannelPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
      * @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).
+     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
      * @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).
+     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
      * @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).
+     * If, for example, you want to enable publish data stream privilege for 10 minutes, set
+     * pubDataStreamPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
      * @return The RTC Token
      */
     export function buildTokenWithUidAndPrivilege(
@@ -307,15 +359,25 @@ export namespace RtcTokenBuilder {
      * - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
      * @param userAccount The user account.
      * @param tokenExpire 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 tokenExpire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set tokenExpire as 600(seconds). This is
+     * the whole token expiration. The whole token is invalid after this time, even if a privilege expiration
+     * time is later.
      * @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).
+     * If, for example, you want to join channel and expect stay in the channel for 10 minutes, set
+     * joinChannelPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
      * @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).
+     * If, for example, you want to enable publish audio privilege for 10 minutes, set pubAudioPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
      * @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).
+     * If, for example, you want to enable publish video privilege for 10 minutes, set pubVideoPrivilegeExpire
+     * as 600(seconds). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
      * @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).
+     * If, for example, you want to enable publish data stream privilege for 10 minutes, set
+     * pubDataStreamPrivilegeExpire as 600(seconds). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
      * @return The RTC Token.
      */
     export function BuildTokenWithUserAccountAndPrivilege(
@@ -344,8 +406,13 @@ export namespace RtcTokenBuilder {
      * @param {*} role 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 {*} tokenExpire 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 {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds).
+     * @param {*} tokenExpire 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 tokenExpire as
+     * 600(seconds). This is the whole token expiration. The whole token is invalid after this time, even if a
+     * privilege expiration time is later.
+     * @param {*} privilegeExpire represented by the number of seconds elapsed since now. If, for example, you
+     * want to enable your privilege for 10 minutes, set privilegeExpire as 600(seconds). This value must not
+     * exceed the token expiration value; otherwise, the privilege is limited by the token expiration time.
      * @return The RTC and RTM Token.
      */
     export function buildTokenWithRtm(
@@ -357,6 +424,150 @@ 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 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 rtcTokenExpire as
+     * 600(seconds). This is the whole token expiration. The whole token is invalid after this time, even if a
+     * privilege expiration time is later.
+     * @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). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
+     * @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). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
+     * @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). This value must not exceed the token expiration value; otherwise, the privilege is
+     * limited by the token expiration time.
+     * @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). This value must not exceed the token expiration value;
+     * otherwise, the privilege is limited by the token expiration time.
+     * @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). This value must not exceed the RTC token expiration value; otherwise, the RTM login
+     * privilege is limited by the token expiration time.
+     * * @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 ConvoAITokenBuilder {
+    /**
+     * Builds a Token007 that carries RTC, RTM, and ConvoAI services.
+     * @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.
+     * @param rtcAccount The RTC user's account, max length is 255 bytes.
+     * @param rtcRole RtcRole.PUBLISHER for a broadcaster or RtcRole.SUBSCRIBER for an audience member.
+     * @param rtcTokenExpire Represented by the number of seconds elapsed since now. This is the whole token
+     * expiration. The whole token is invalid after this time, even if a privilege expiration time is later.
+     * @param joinChannelPrivilegeExpire Represented by the number of seconds elapsed since now. This value
+     * must not exceed the token expiration value; otherwise, the privilege is limited by the token expiration
+     * time.
+     * @param pubAudioPrivilegeExpire Represented by the number of seconds elapsed since now. This value must
+     * not exceed the token expiration value; otherwise, the privilege is limited by the token expiration
+     * time.
+     * @param pubVideoPrivilegeExpire Represented by the number of seconds elapsed since now. This value must
+     * not exceed the token expiration value; otherwise, the privilege is limited by the token expiration
+     * time.
+     * @param pubDataStreamPrivilegeExpire Represented by the number of seconds elapsed since now. This value
+     * must not exceed the token expiration value; otherwise, the privilege is limited by the token expiration
+     * time.
+     * @param rtmUserId The RTM user's account, max length is 255 bytes.
+     * @param rtmTokenExpire Represented by the number of seconds elapsed since now. This value must not
+     * exceed the RTC token expiration value; otherwise, the RTM login privilege is limited by the token
+     * expiration time.
+     * @return The RTC, RTM, and ConvoAI token.
+     */
+    export function buildToken(
+        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 SttTokenBuilder {
+    /**
+     * Builds a Token007 that carries RTC, RTM, and STT services.
+     * @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.
+     * @param rtcAccount The RTC user's account, max length is 255 bytes.
+     * @param rtcRole RtcRole.PUBLISHER for a broadcaster or RtcRole.SUBSCRIBER for an audience member.
+     * @param rtcTokenExpire Represented by the number of seconds elapsed since now. This is the whole token
+     * expiration. The whole token is invalid after this time, even if a privilege expiration time is later.
+     * @param joinChannelPrivilegeExpire Represented by the number of seconds elapsed since now. This value
+     * must not exceed the token expiration value; otherwise, the privilege is limited by the token expiration
+     * time.
+     * @param pubAudioPrivilegeExpire Represented by the number of seconds elapsed since now. This value must
+     * not exceed the token expiration value; otherwise, the privilege is limited by the token expiration
+     * time.
+     * @param pubVideoPrivilegeExpire Represented by the number of seconds elapsed since now. This value must
+     * not exceed the token expiration value; otherwise, the privilege is limited by the token expiration
+     * time.
+     * @param pubDataStreamPrivilegeExpire Represented by the number of seconds elapsed since now. This value
+     * must not exceed the token expiration value; otherwise, the privilege is limited by the token expiration
+     * time.
+     * @param rtmUserId The RTM user's account, max length is 255 bytes.
+     * @param rtmTokenExpire Represented by the number of seconds elapsed since now. This value must not
+     * exceed the RTC token expiration value; otherwise, the RTM login privilege is limited by the token
+     * expiration time.
+     * @return The RTC, RTM, and STT token.
+     */
+    export function buildToken(
+        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 {
@@ -369,8 +580,31 @@ export namespace RtmTokenBuilder {
      * the Agora Dashboard. See Get an App Certificate.
      * @param userId The user's account, max length is 64 Bytes.
      * @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 expire as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds). This value is
+     * the whole token expiration and the service privilege expiration. The whole token is invalid after this
+     * time.
      * @return The RTM token.
      */
     export function buildToken(appId: string, appCertificate: string, userId: string | number, expire: number): string
+
+    /**
+     * Build an RTM2 token with resource-level permissions.
+     *
+     * This special interface requires Agora assistance for proper usage.
+     *
+     * @param appId The App ID issued to you by Agora.
+     * @param appCertificate Certificate of the application registered in the Agora Dashboard.
+     * @param userId The user's account, max length is 64 bytes.
+     * @param permissions The RTM2 resource-level permissions.
+     * @param expire The number of seconds from now before the token expires. This value is the whole token
+     * expiration and the service privilege expiration. The whole token is invalid after this time.
+     * @return The RTM2 token.
+     */
+    export function buildTokenWithPermissions(
+        appId: string,
+        appCertificate: string,
+        userId: string | number,
+        permissions: Rtm2Permissions,
+        expire: number
+    ): string
 }

package/index.js

@@ -1,9 +1,12 @@
 module.exports = {
     ApaasTokenBuilder: require('./src/ApaasTokenBuilder').ApaasTokenBuilder,
     ChatTokenBuilder: require('./src/ChatTokenBuilder').ChatTokenBuilder,
+    ConvoAITokenBuilder: require('./src/ConvoAITokenBuilder').ConvoAITokenBuilder,
     EducationTokenBuilder: require('./src/EducationTokenBuilder').EducationTokenBuilder,
     FpaTokenBuilder: require('./src/FpaTokenBuilder').FpaTokenBuilder,
     RtcRole: require('./src/RtcTokenBuilder2').Role,
     RtcTokenBuilder: require('./src/RtcTokenBuilder2').RtcTokenBuilder,
-    RtmTokenBuilder: require('./src/RtmTokenBuilder2').RtmTokenBuilder
+    RtmTokenBuilder: require('./src/RtmTokenBuilder2').RtmTokenBuilder,
+    Rtm2Permissions: require('./src/AccessToken2').Rtm2Permissions,
+    SttTokenBuilder: require('./src/SttTokenBuilder').SttTokenBuilder
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "agora-token",
-    "version": "2.0.4",
+    "version": "2.0.6",
     "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/ConvoAITokenBuilderSample.js

@@ -0,0 +1,36 @@
+const { ConvoAITokenBuilder, RtcRole } = require('..')
+
+const appId = process.env.AGORA_APP_ID
+const appCertificate = process.env.AGORA_APP_CERTIFICATE
+const channelName = '7d72365eb983485397e3e3f9d460bdda'
+const rtcAccount = '2882341273'
+const rtcRole = RtcRole.PUBLISHER
+const rtcTokenExpire = 3600
+const joinChannelPrivilegeExpire = 3600
+const pubAudioPrivilegeExpire = 3600
+const pubVideoPrivilegeExpire = 3600
+const pubDataStreamPrivilegeExpire = 3600
+const rtmUserId = '2882341273'
+const rtmTokenExpire = 3600
+
+console.log('App Id:', appId)
+if (!appId || !appCertificate) {
+    console.log('Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE')
+    process.exit(0)
+}
+
+const token = ConvoAITokenBuilder.buildToken(
+    appId,
+    appCertificate,
+    channelName,
+    rtcAccount,
+    rtcRole,
+    rtcTokenExpire,
+    joinChannelPrivilegeExpire,
+    pubAudioPrivilegeExpire,
+    pubVideoPrivilegeExpire,
+    pubDataStreamPrivilegeExpire,
+    rtmUserId,
+    rtmTokenExpire
+)
+console.log('ConvoAI token:', token)

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/sample/SttTokenBuilderSample.js

@@ -0,0 +1,36 @@
+const { SttTokenBuilder, RtcRole } = require('..')
+
+const appId = process.env.AGORA_APP_ID
+const appCertificate = process.env.AGORA_APP_CERTIFICATE
+const channelName = '7d72365eb983485397e3e3f9d460bdda'
+const rtcAccount = '2882341273'
+const rtcRole = RtcRole.PUBLISHER
+const rtcTokenExpire = 3600
+const joinChannelPrivilegeExpire = 3600
+const pubAudioPrivilegeExpire = 3600
+const pubVideoPrivilegeExpire = 3600
+const pubDataStreamPrivilegeExpire = 3600
+const rtmUserId = '2882341273'
+const rtmTokenExpire = 3600
+
+console.log('App Id:', appId)
+if (!appId || !appCertificate) {
+    console.log('Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE')
+    process.exit(0)
+}
+
+const token = SttTokenBuilder.buildToken(
+    appId,
+    appCertificate,
+    channelName,
+    rtcAccount,
+    rtcRole,
+    rtcTokenExpire,
+    joinChannelPrivilegeExpire,
+    pubAudioPrivilegeExpire,
+    pubVideoPrivilegeExpire,
+    pubDataStreamPrivilegeExpire,
+    rtmUserId,
+    rtmTokenExpire
+)
+console.log('STT token:', token)