added new changes

mynaparrot · Sep 25, 2024 · 958548f · 958548f
1 parent dcffc86
commit 958548f
Show file tree

Hide file tree

Showing 8 changed files with 10,398 additions and 14,616 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -16,11 +16,14 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20.x
-
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 9
       - name: Install dependencies
-        run: npm install
+        run: pnpm install
       - name: Build website
-        run: npm run build
+        run: pnpm run build
 
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus

diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml
@@ -16,8 +16,11 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20.x
-
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 9
       - name: Install dependencies
-        run: npm install
+        run: pnpm install
       - name: Test build website
-        run: npm run build
+        run: pnpm run build
diff --git a/docs/api/room/create.md b/docs/api/room/create.md
@@ -43,6 +43,7 @@ End point: `/room/create`
 | enable_analytics                                                | boolean | No      | Enable/Disable to create analytics report for the session. Later can [fetch analytics](/docs/api/analytics/fetch). Default: false                                        |
 | allow_virtual_bg                                                | boolean | No      |         Enable/disable virtual background option         |
 | allow_raise_hand                                                | boolean | No      |                Enable/disable raise hand option                       |
+| auto_gen_user_id                                                | boolean | No      |                The system will automatically generate a `user_id` for each participant if the value is set to `true`. In this instance, any supplied `user_id` will be ignored, and the value will be stored in `ex_user_id`. Default: false                      |
 | room_duration                                                              | number  | No       | If you want to set fixed room duration. Value should be in minutes. 1 hour = 60 minutes. 0 = unlimited |
 | [recording_features](#recording-features)                                  | object  | Yes      | Recording Settings                                                                                     |
 | [chat_features](#chat-features)                                            | object  | Yes      | Chat Settings                                                                                          |
@@ -129,6 +130,8 @@ End point: `/room/create`
 | Field                | Type    | Required | Description                                                                                                                                                                                                                                                                                                                  |
 | -------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | is_enabled             | boolean | Yes      | enable/disable E2EE. Supported browsers: `browser based on Chromium 83+, Google Chrome, Microsoft Edge, Safari. Firefox: 117+` **Note:** Users will be unable to join the session if their browser does not support it. |
+| included_chat_messages             | boolean | No      | enable/disable E2EE for chat messages. |
+| included_whiteboard             | boolean | No      | enable/disable E2EE for whiteboard messages (SCENE_UPDATE, POINTER_UPDATE). This may use more CPU for the user end, do not enable it unless really necessary|
 
 ### Default lock settings
 
@@ -169,6 +172,7 @@ This will only work if server's config `client > copyright_conf > allow_override
       "enable_analytics": true,
       "allow_virtual_bg": true,
       "allow_raise_hand": true,
+      "auto_gen_user_id": false,
       "room_duration": 0,
       "recording_features": {
         "is_allow": true,
@@ -231,17 +235,4 @@ This will only work if server's config `client > copyright_conf > allow_override
 | :--------------------- | ------------------------------ | ------------------------- |
 | status                 | boolean                        | The status of the request |
 | msg                    | string                         | Response message          |
-| [roomInfo](#room-info) | object\<[roomInfo](#room-info)> |                           |
-
-### Room Info
-
-| Field            | Type   | Description                                |
-| ---------------- | ------ | ------------------------------------------ |
-| sid              | string | Room sid                                   |
-| name             | string | Room Id                                    |
-| max_participants | number | Maximum participants for this room         |
-| empty_timeout    | number | Maximum duration before closing empty room |
-| creation_time    | number | Room creation time in unix time format     |
-| turn_password    | string | Turn password                              |
-| enabled_codecs   | Array  | Video codecs for this room                 |
-| metadata         | string | Room metadata                              |
+| [room_info](/docs/api/room/room-info.md#room-info) | object |                           |
diff --git a/docs/api/room/join.md b/docs/api/room/join.md
@@ -33,6 +33,8 @@ End point: `/room/getJoinToken`
 | profile_pic                                                     | string | No       | Profile avatar |
 | preferred_lang                                                     | string | No       | You can set a preferred language to force the plugNmeet-client to use it. Please see the list of values [here](https://github.com/mynaparrot/plugNmeet-client/blob/main/src/helpers/languages.ts). Example: es-ES, bn-BD, de-DE etc |
 | [lock_settings](/docs/api/room/create#default-lock-settings) | object | No       | Lock settings  |
+| ex_user_id | string | No       | if empty then will use same value of user_id  |
+| extra_data | string | No       | You can store extra data. |
 
 ### **Example**
 

diff --git a/docs/others/webhooks.md b/docs/others/webhooks.md
@@ -20,6 +20,14 @@ In addition to the fields below, all webhook events will include the following f
 - `id` - a UUID identifying the event
 - `createdAt` - UNIX timestamp in seconds
 
+### Room created
+```js
+interface CommonNotifyEvent {
+  event: 'room_created'
+  room: Room
+}
+```
+
 ### Room started
 ```js
 interface CommonNotifyEvent {