agora-token 2.0.2 → 2.0.4

package/README.md

@@ -2,6 +2,20 @@
 
 To enhance communication security, Agora uses tokens to authenticate users before they access the Agora service, or joining an RTC channel.
 
+## Installation
+
+This is a [Node.js](https://nodejs.org/en/) module available through the
+[npm registry](https://www.npmjs.com/).
+
+Before installing, [download and install Node.js](https://nodejs.org/en/download/).
+
+Installation is done using the
+[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
+
+```console
+$ npm install agora-token
+```
+
 ## Code structure
 
 Under the `nodejs` directory:

package/eslint.config.mjs

@@ -0,0 +1,8 @@
+import globals from 'globals'
+import pluginJs from '@eslint/js'
+
+export default [
+    { files: ['**/*.js'], languageOptions: { sourceType: 'commonjs' } },
+    { languageOptions: { globals: globals.node } },
+    pluginJs.configs.recommended
+]

package/index.d.ts

@@ -1,11 +1,163 @@
+export namespace ApaasTokenBuilder {
+    /**
+     * build user room 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 roomUuid          The room's id, must be unique.
+     * @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).
+     * @return The user room token.
+     */
+    export function buildRoomUserToken(
+        appId: string,
+        appCertificate: string,
+        roomUuid: string,
+        userUuid: string | number,
+        role: number,
+        expire: number
+    ): string
+
+    /**
+     * build 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 expire as 600(seconds).
+     * @return The user token.
+     */
+    export function buildUserToken(
+        appId: string,
+        appCertificate: string,
+        userUuid: string | number,
+        expire: number
+    ): string
+
+    /**
+     * build 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 expire as 600(seconds).
+     * @return The app token.
+     */
+    export function buildAppToken(appId: string, appCertificate: string, expire: number): 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 expire 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 expire as 600(seconds).
+     * @return The chat App token.
+     */
+    export function buildAppToken(appId: string, appCertificate: string, expire: number): string
+}
+
+export namespace EducationTokenBuilder {
+    /**
+     * build user room 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 roomUuid          The room's id, must be unique.
+     * @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).
+     * @return The user room token.
+     */
+    export function buildRoomUserToken(
+        appId: string,
+        appCertificate: string,
+        roomUuid: string,
+        userUuid: string | number,
+        role: number,
+        expire: number
+    ): string
+
+    /**
+     * build 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 expire as 600(seconds).
+     * @return The user token.
+     */
+    export function buildUserToken(
+        appId: string,
+        appCertificate: string,
+        userUuid: string | number,
+        expire: number
+    ): string
+
+    /**
+     * build 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 expire as 600(seconds).
+     * @return The app token.
+     */
+    export function buildAppToken(appId: string, appCertificate: string, expire: number): string
+}
+
+export namespace FpaTokenBuilder {
+    /**
+     * Build the FPA 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.
+     * @return The FPA token.
+     */
+    export function buildToken(appId: string, appCertificate: string): string
+}
 
 export namespace RtcRole {
-    export const PUBLISHER: number;
-    export const SUBSCRIBER: number;
+    export const PUBLISHER: number
+    export const SUBSCRIBER: number
 }
 
 export namespace RtcTokenBuilder {
-
     /**
      * Builds an RTC token using an Integer uid.
      * @param {*} appId  The App ID issued to you by Agora.
@@ -19,14 +171,23 @@ export namespace RtcTokenBuilder {
      * @param {*} uid User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
      * @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 [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in). In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-     * @param {*} token_expire 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 token_expire as 600(seconds)
-     * @param {*} privilege_expire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).     * @return The new Token.
+     * - 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).
+     * @return The RTC Token.
      */
-     export function buildTokenWithUid(appId: string, appCertificate: string, channelName: string, uid: string | number, role: number,  token_expire: number, privilege_expire: number): string;
+    export function buildTokenWithUid(
+        appId: string,
+        appCertificate: string,
+        channelName: string,
+        uid: string | number,
+        role: number,
+        tokenExpire: number,
+        privilegeExpire: number
+    ): string
 
     /**
-     * Builds an RTC token using an Integer uid.
+     * Builds an RTC 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:
@@ -38,14 +199,22 @@ export namespace RtcTokenBuilder {
      * @param {*} account The user account.
      * @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 [Hosting-in](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#hosting-in). In order for this role to take effect, please contact our support team to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber still has the same privileges as Role_Publisher.
-     * @param {*} token_expire 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 token_expire as 600(seconds)
-     * @param {*} privilege_expire represented by the number of seconds elapsed since now. If, for example, you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).
-     * @return The new Token.
+     * - 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).
+     * @return The RTC Token.
      */
-     export function buildTokenWithUserAccount(appId: string, appCertificate: string, channelName: string, account: string | number, role: number, token_expire: number, privilege_expire: number): string;
+    export function buildTokenWithUserAccount(
+        appId: string,
+        appCertificate: string,
+        channelName: string,
+        account: string | number,
+        role: number,
+        tokenExpire: number,
+        privilegeExpire: number
+    ): string
 
-     /**
+    /**
      * Generates an RTC token with the specified privilege.
      *
      * This method supports generating a token with the following privileges:
@@ -80,27 +249,28 @@ 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 token_expire as 600(seconds).
-     * @param joinChannelPrivilegeExpire The Unix timestamp when the privilege for joining the channel expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set joinChannelPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes.
-     * @param pubAudioPrivilegeExpire The Unix timestamp when the privilege for publishing audio expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubAudioPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubAudioPrivilegeExpire as the current Unix timestamp.
-     * @param pubVideoPrivilegeExpire The Unix timestamp when the privilege for publishing video expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubVideoPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubVideoPrivilegeExpire as the current Unix timestamp.
-     * @param pubDataStreamPrivilegeExpire The Unix timestamp when the privilege for publishing data streams expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubDataStreamPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubDataStreamPrivilegeExpire as the current Unix timestamp.
-     * @return The new Token
+     * 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).
+     * @return The RTC Token
      */
-    export function buildTokenWithUidAndPrivilege(appId: string, appCertificate: string, channelName: string, uid: string | number,
-        tokenExpire: number, joinChannelPrivilegeExpire: number, pubAudioPrivilegeExpire: number,
-        pubVideoPrivilegeExpire: number, pubDataStreamPrivilegeExpire: number): string;
+    export function buildTokenWithUidAndPrivilege(
+        appId: string,
+        appCertificate: string,
+        channelName: string,
+        uid: string | number,
+        tokenExpire: number,
+        joinChannelPrivilegeExpire: number,
+        pubAudioPrivilegeExpire: number,
+        pubVideoPrivilegeExpire: number,
+        pubDataStreamPrivilegeExpire: number
+    ): string
 
     /**
      * Generates an RTC token with the specified privilege.
@@ -137,31 +307,59 @@ 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 token_expire as 600(seconds).
-     * @param joinChannelPrivilegeExpire The Unix timestamp when the privilege for joining the channel expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set joinChannelPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes.
-     * @param pubAudioPrivilegeExpire The Unix timestamp when the privilege for publishing audio expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubAudioPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubAudioPrivilegeExpire as the current Unix timestamp.
-     * @param pubVideoPrivilegeExpire The Unix timestamp when the privilege for publishing video expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubVideoPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubVideoPrivilegeExpire as the current Unix timestamp.
-     * @param pubDataStreamPrivilegeExpire The Unix timestamp when the privilege for publishing data streams expires, represented
-     * by the sum of the current timestamp plus the valid time period of the token. For example, if you set pubDataStreamPrivilegeExpire as the
-     * current timestamp plus 600 seconds, the token expires in 10 minutes. If you do not want to enable this privilege,
-     * set pubDataStreamPrivilegeExpire as the current Unix timestamp.
-     * @return The new Token.
+     * 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).
+     * @return The RTC Token.
      */
-    export function BuildTokenWithUserAccountAndPrivilege(appId: string, appCertificate: string, channelName: string, account: string | number,
-        tokenExpire: number, joinChannelPrivilegeExpire: number, pubAudioPrivilegeExpire: number,
-        pubVideoPrivilegeExpire: number, pubDataStreamPrivilegeExpire: number): string;
+    export function BuildTokenWithUserAccountAndPrivilege(
+        appId: string,
+        appCertificate: string,
+        channelName: string,
+        account: string | number,
+        tokenExpire: number,
+        joinChannelPrivilegeExpire: number,
+        pubAudioPrivilegeExpire: number,
+        pubVideoPrivilegeExpire: number,
+        pubDataStreamPrivilegeExpire: 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 {*} account The user account.
+     * @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).
+     * @return The RTC and RTM Token.
+     */
+    export function buildTokenWithRtm(
+        appId: string,
+        appCertificate: string,
+        channelName: string,
+        account: string | number,
+        role: number,
+        tokenExpire: number,
+        privilegeExpire: number
+    ): string
 }
 
 export namespace RtmTokenBuilder {
-
     /**
      * Build the RTM token.
      *
@@ -171,91 +369,8 @@ 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 expireTimestamp as 600(seconds).
+     * Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
      * @return The RTM token.
      */
-     export function buildToken(appId: string, appCertificate: string, userId: string | number, expire: number): string;
-}
-
-export namespace EducationTokenBuilder {
-    /**
-     * build user room 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 roomUuid          The room's id, must be unique.
-     * @param userUuid          The user's id, must be unique.
-     * @param role              The user's role, such as 0(invisible), 1(teacher), 2(student), 3(assistant), 4(observer) etc.
-     * @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 education user room token.
-     */
-     export function buildRoomUserToken(appId: string, appCertificate: string, roomUuid: string, userUuid: string | number, role: number, expire: number): string;
-
-    /**
-     * build user individual 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 education user token.
-     */
-    export function buildUserToken(appId: string, appCertificate: string, userUuid: string | number, expire: number): string;
-
-    /**
-     * build app global 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 education global token.
-     */
-     export function buildAppToken(appId: string, appCertificate: string, expire: number): string;
-}
-
-export namespace FpaTokenBuilder {
-    /**
-     * Build the FPA 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.
-     * @return The FPA token.
-     */
-    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;
+    export function buildToken(appId: string, appCertificate: string, userId: string | number, expire: number): string
 }

package/index.js

@@ -1,8 +1,9 @@
 module.exports = {
-  RtcTokenBuilder: require('./src/RtcTokenBuilder2').RtcTokenBuilder,
-  RtcRole: require('./src/RtcTokenBuilder2').Role,
-  RtmTokenBuilder: require('./src/RtmTokenBuilder2').RtmTokenBuilder,
-  EducationTokenBuilder: require('./src/EducationTokenBuilder').EducationTokenBuilder,
-  FpaTokenBuilder: require('./src/FpaTokenBuilder').FpaTokenBuilder,
-  ChatTokenBuilder: require('./src/ChatTokenBuilder').ChatTokenBuilder
-};
+    ApaasTokenBuilder: require('./src/ApaasTokenBuilder').ApaasTokenBuilder,
+    ChatTokenBuilder: require('./src/ChatTokenBuilder').ChatTokenBuilder,
+    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
+}

package/package.json

@@ -1,19 +1,24 @@
 {
-  "name": "agora-token",
-  "version": "2.0.2",
-  "description": "",
-  "homepage": "https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/nodejs",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "types": "index.d.ts",
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "crc-32": "^1.2.0",
-    "cuint": "0.2.2",
-    "md5": "^2.3.0",
-    "nodeunit": "^0.11.3"
-  }
-}
+    "name": "agora-token",
+    "version": "2.0.4",
+    "description": "",
+    "homepage": "https://github.com/AgoraIO/Tools/tree/master/DynamicKey/AgoraDynamicKey/nodejs",
+    "main": "index.js",
+    "scripts": {
+        "test": "nodeunit test/*.js"
+    },
+    "types": "index.d.ts",
+    "author": "",
+    "license": "ISC",
+    "dependencies": {
+        "crc-32": "^1.2.0",
+        "cuint": "0.2.2",
+        "md5": "^2.3.0"
+    },
+    "devDependencies": {
+        "@eslint/js": "^9.8.0",
+        "eslint": "^9.8.0",
+        "globals": "^15.8.0",
+        "nodeunit": "^0.11.3"
+    }
+}

package/sample/AccessToken2Sample.js

@@ -1,18 +1,26 @@
-const {AccessToken2, ServiceRtc} = require('../src/AccessToken2')
-const RtcRole = require('../src/RtcTokenBuilder').Role;
+const { AccessToken2, ServiceRtc } = require("../src/AccessToken2");
+const RtcRole = require("../src/RtcTokenBuilder").Role;
 
-const appID = '970CA35de60c44645bbae8a215061b33';
-const appCertificate = '5CFd2fd1755d40ecb72977518be15d3b';
-const channelName = '7d72365eb983485397e3e3f9d460bdda';
+// Need to set environment variable 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 channelName = "7d72365eb983485397e3e3f9d460bdda";
 const uid = 2882341273;
 const account = "2882341273";
 const role = RtcRole.PUBLISHER;
+const expirationTimeInSeconds = 3600;
+const currentTimestamp = Math.floor(Date.now() / 1000);
 
-const expirationTimeInSeconds = 3600
-
-const currentTimestamp = Math.floor(Date.now() / 1000)
+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.build())
+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());

package/sample/ApaasTokenSample.js

@@ -0,0 +1,27 @@
+const ApaasTokenBuilder = require('../src/ApaasTokenBuilder').ApaasTokenBuilder
+
+// Need to set environment variable 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 expire = 600
+const roomUuid = '123'
+const userUuid = '2882341273'
+const role = 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)
+}
+
+const tokenRoomUserToken = ApaasTokenBuilder.buildRoomUserToken(appId, appCertificate, roomUuid, userUuid, role, expire)
+console.log('Apaas room user token:', tokenRoomUserToken)
+
+const tokenUserToken = ApaasTokenBuilder.buildUserToken(appId, appCertificate, userUuid, expire)
+console.log('Apaas user token:', tokenUserToken)
+
+const tokenAppToken = ApaasTokenBuilder.buildAppToken(appId, appCertificate, expire)
+console.log('Apaas app token:', tokenAppToken)