Merge pull request #1693 from 100mslive/develop

Release 1.9.6: Develop to main
100mslive · Jan 16, 2024 · 1c95753 · 1c95753
2 parents 69d970f + 787091f
commit 1c95753
Show file tree

Hide file tree

Showing 79 changed files with 3,475 additions and 1,841 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -15,6 +15,7 @@
 ### Pre-launch Checklist
 
 - [ ] The [Documentation] is updated accordingly, or this PR doesn't require it.
+- [ ] The [ExampleAppChangelog] is updated with related tickets, or this PR doesn't require it.
 - [ ] I updated/added relevant documentation (doc comments with `///`).
 - [ ] I listed at least one issue that this PR fixes in the description above.
 - [ ] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
@@ -23,5 +24,6 @@
 
 <!-- Links -->
 [Documentation]: https://www.100ms.live/docs
+[ExampleAppChangelog]: https://github.com/100mslive/100ms-flutter/blob/main/packages/hmssdk_flutter/example/ExampleAppChangelog.txt
 [Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
 [Features we expect every widget to implement]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#features-we-expect-every-widget-to-implement
diff --git a/.github/styles/Vocab/HMSVocab/accept.txt b/.github/styles/Vocab/HMSVocab/accept.txt
@@ -171,3 +171,26 @@ userid
 peerid
 ios
 android
+iOS
+authToken
+issue_tracker
+publish_to
+bool
+prominentRoles
+isOverlay
+roleName
+forceChange
+previousRole
+peerMetadata
+toRole
+forPeer
+Enum
+rolesWhitelist
+messagePlaceholder
+chatTitle
+isOverlay
+bool
+permission_handler
+intl
+chatState
+pinnedMessages
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -5,7 +5,7 @@ concurrency:
   cancel-in-progress: true
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: {}
   push:
     branches:
       - main

diff --git a/.github/workflows/firstinteraction.yml b/.github/workflows/firstinteraction.yml
@@ -1,7 +1,7 @@
 name: Appreciate first interaction
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: {}
   issues:
     types: [opened]
   pull_request:

diff --git a/.github/workflows/ktlint.yml b/.github/workflows/ktlint.yml
@@ -1,7 +1,7 @@
 name: KtLint
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: {}
   pull_request:
     paths:
       - "**/*.kt"

diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -1,6 +1,6 @@
 name: Close stale issues and PRs
 on:
-  workflow_dispatch:
+  workflow_dispatch: {}
   schedule:
     - cron: "30 1 * * *"
 

diff --git a/.github/workflows/swiftlint.yml b/.github/workflows/swiftlint.yml
@@ -1,7 +1,7 @@
 name: SwiftLint
 
 on:
-  workflow_dispatch:
+  workflow_dispatch: {}
   pull_request:
     paths:
       - "**/*.swift"

diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml
@@ -1,7 +1,7 @@
-name: Vale linter
+name: Vale Linter
 
 on:
-    workflow_dispatch:
+    workflow_dispatch: {}
     pull_request:
         branches:
             - develop

diff --git a/.vale.ini b/.vale.ini
@@ -4,13 +4,11 @@ MinAlertLevel = error
 
 Vocab = HMSVocab
 
-Packages = Google
-
-[*]
+Packages = Google, Readability
 
+[*.md]
 BasedOnStyles = Vale, Google
 
-
 BlockIgnores = (?s) *(\x60\x60\x60[a-z]*\n[\s\S]*?\x60\x60\x60)
 
 TokenIgnores = [a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12} , r.M , (^[a-z]|[A-Z])[a-z]* , `{3}([\S]+)?\n([\s\S]+)\n`{3} , .*",
diff --git a/README.md b/README.md
@@ -21,6 +21,10 @@ With support for HLS and RTMP Live Streaming and Recording, Picture-in-Picture (
 | hms_room_kit   | [![Pub Version](https://img.shields.io/pub/v/hms_room_kit)](https://pub.dev/packages/hms_room_kit)     |
 | hmssdk_flutter | [![Pub Version](https://img.shields.io/pub/v/hmssdk_flutter)](https://pub.dev/packages/hmssdk_flutter) |
 
+💻 Checkout the 100ms Flutter SDK [here](https://github.com/100mslive/100ms-flutter/tree/main/packages/hmssdk_flutter)
+
+❤️ Checkout the 100ms Prebuilt [here](https://github.com/100mslive/100ms-flutter/tree/main/packages/hms_room_kit)
+
 🧱 The Prebuilt QuickStart Guide is [available here](https://www.100ms.live/docs/flutter/v2/quickstart/prebuilt).
 
 📖 Read the Complete Documentation here: https://www.100ms.live/docs/flutter/v2/guides/quickstart

diff --git a/packages/hms_room_kit/CHANGELOG.md b/packages/hms_room_kit/CHANGELOG.md
@@ -5,6 +5,39 @@
 | hms_room_kit   | [![Pub Version](https://img.shields.io/pub/v/hms_room_kit)](https://pub.dev/packages/hms_room_kit)     |
 | hmssdk_flutter | [![Pub Version](https://img.shields.io/pub/v/hmssdk_flutter)](https://pub.dev/packages/hmssdk_flutter) |
 
+## 1.0.9 - 2024-01-15
+
+| Package        | Version                                                                                                |
+| -------------- | ------------------------------------------------------------------------------------------------------ |
+| hms_room_kit   | 1.0.9     |
+| hmssdk_flutter | 1.9.6     |
+
+### 🚀 Added
+
+- Enhanced Chat Controls
+
+  - 📌 Pin and Hide Messages
+
+      Elevate your chat experience with our new room kit feature. Effortlessly pin messages to keep them visible at the top of your chat, or hide messages to remove them from view.
+
+  - 🔒 Chat Moderation
+
+      Gain more control over your chat environment. You can now temporarily block peers within a session, preventing them from sending messages.
+
+  - 👥 Recipient Selector
+
+      Communication tailored to your needs. Send broadcast messages, reach specific groups or roles, and initiate direct messages (DMs) to particular peers with ease.
+
+  - 📋 Copy Messages
+
+      Simplify your interactions. Copy any message quickly with just a single tap, enhancing your chat efficiency.
+
+- Added Skip Preview for Role Change functionality
+
+  100ms Prebuilt now supports skipping preview screen, while changing roles. This can be configured from 100ms dashboard.
+  If preview screen is skipped, then mic and camera will be muted by default.
+
+
 ## 1.0.8 - 2023-12-15
 
 | Package        | Version                                                                                                |

diff --git a/packages/hms_room_kit/README.md b/packages/hms_room_kit/README.md
@@ -1,4 +1,4 @@
-[![100ms-svg](https://user-images.githubusercontent.com/93931528/205858417-8c0a0d1b-2d46-4710-9316-7418092fd3d6.svg)](https://100ms.live/)
+# 100ms Room Kit 🎉
 
 [![Pub Version](https://img.shields.io/pub/v/hms_room_kit)](https://pub.dev/packages/hms_room_kit)
 [![License](https://img.shields.io/github/license/100mslive/100ms-flutter)](https://www.100ms.live/)
@@ -9,7 +9,9 @@
 [![Activity](https://img.shields.io/github/commit-activity/m/100mslive/100ms-flutter.svg)](https://github.com/100mslive/100ms-flutter/projects/1)
 [![Register](https://img.shields.io/badge/Contact-Know%20More-blue)](https://dashboard.100ms.live/register)
 
-# 100ms Room Kit 🎉
+<p align="center" width="100%">
+<img width="600" height="500" alt="Prebuilt - Edtech" src="https://github.com/100mslive/100ms-flutter/assets/93931528/de8008f7-1fa7-4329-84b4-ce6fedc0833f">
+</p>
 
 A powerful prebuilt UI library for audio/video conferencing, live streaming, and one-to-one calls.
 This package provides developers with a comprehensive set of tools and components to quickly integrate high-quality audio and video communication features into their Flutter applications.
@@ -65,7 +67,23 @@ HMSPrebuilt(
 
 ## Overview
 
-This guide will walk you through simple instructions to create a video conferencing app using 100ms Prebuilt and and test it using an emulator or your mobile phone.
+This guide will walk you through simple instructions to create a video conferencing app using 100ms Prebuilt and and test it using an emulator or your mobile phone. 100ms prebuilt is completely customizable from 100ms dashboard. Following images portray what you get with 100ms prebuilt
+
+<table>
+    <tr>
+        <td><img src="https://github.com/100mslive/100ms-flutter/assets/93931528/02f7181e-ef73-48fc-b8cd-ed977b3bc28c"></td>
+        <td><img src="https://github.com/100mslive/100ms-flutter/assets/93931528/7875bc6d-597c-4213-98f4-7333a660e689"></td>
+        <td><img src="https://github.com/100mslive/100ms-flutter/assets/93931528/cf10216a-93cb-41c9-b0fd-15b2d05611a0"></td>
+    </tr>
+    <tr>
+        <td><img src="https://github.com/100mslive/100ms-flutter/assets/93931528/e4ba9546-56b6-42ee-bea1-c7733053b2b6"></td>
+        <td><img src="https://github.com/100mslive/100ms-flutter/assets/93931528/8a0a5a8c-024f-4128-b607-c3ee5957bb17"></td>
+        <td><img src="https://github.com/100mslive/100ms-flutter/assets/93931528/f292bf26-3061-4c9c-925a-981e7dd6c86b"></td>
+    </tr>
+</table>
+
+<!-- |  ![Prebuilt iOS - 3](https://github.com/100mslive/100ms-flutter/assets/93931528/f292bf26-3061-4c9c-925a-981e7dd6c86b) | ![3](https://github.com/100mslive/100ms-flutter/assets/93931528/7875bc6d-597c-4213-98f4-7333a660e689) | 
+|![Prebuilt Flutter - 1](https://github.com/100mslive/100ms-flutter/assets/93931528/cf10216a-93cb-41c9-b0fd-15b2d05611a0) | ![4](https://github.com/100mslive/100ms-flutter/assets/93931528/43263ecf-57e8-4b8d-9bdc-68a72b4ce7fa) | -->
 
 ## Create a sample app
 

diff --git a/packages/hms_room_kit/example/ios/Podfile.lock b/packages/hms_room_kit/example/ios/Podfile.lock
@@ -6,14 +6,14 @@ PODS:
   - HMSBroadcastExtensionSDK (0.0.9)
   - HMSHLSPlayerSDK (0.0.2):
     - HMSAnalyticsSDK (= 0.0.2)
-  - HMSSDK (1.3.1):
+  - HMSSDK (1.4.1):
     - HMSAnalyticsSDK (= 0.0.2)
     - HMSWebRTC (= 1.0.5116)
-  - hmssdk_flutter (1.9.4):
+  - hmssdk_flutter (1.9.6):
     - Flutter
     - HMSBroadcastExtensionSDK (= 0.0.9)
     - HMSHLSPlayerSDK (= 0.0.2)
-    - HMSSDK (= 1.3.1)
+    - HMSSDK (= 1.4.1)
   - HMSWebRTC (1.0.5116)
   - path_provider_foundation (0.0.1):
     - Flutter
@@ -70,8 +70,8 @@ SPEC CHECKSUMS:
   HMSAnalyticsSDK: 4d2a88a729b1eb42f3d25f217c28937ec318a5b7
   HMSBroadcastExtensionSDK: d80fe325f6c928bd8e5176290b5a4b7ae15d6fbb
   HMSHLSPlayerSDK: 6a54ad4d12f3dc2270d1ecd24019d71282a4f6a3
-  HMSSDK: 04aac0fefd95419cd1b4135156d4295cbcd51216
-  hmssdk_flutter: 3876d06f4ad68bf48a2ceb4c797551fedb860bd1
+  HMSSDK: 6a579cb806d4760cda149002150ff0beab03749b
+  hmssdk_flutter: 0b12e79b2f184fa3308fb65dade6e3b022d805c9
   HMSWebRTC: ae54e9dd91b869051b283b43b14f57d43b7bf8e1
   path_provider_foundation: 29f094ae23ebbca9d3d0cec13889cd9060c0e943
   permission_handler_apple: e76247795d700c14ea09e3a2d8855d41ee80a2e6

diff --git a/packages/hms_room_kit/example/pubspec.lock b/packages/hms_room_kit/example/pubspec.lock
@@ -214,15 +214,15 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.0.8"
+    version: "1.0.9"
   hmssdk_flutter:
     dependency: transitive
     description:
       name: hmssdk_flutter
-      sha256: f61fb1ffcaf7296e0e2eeff9bc34d699baf9190136b8570a15cde61819cf3276
+      sha256: "112381755d47a639ef296295ace5b9d73267b89458f33ac767d1b6536a3fc898"
       url: "https://pub.dev"
     source: hosted
-    version: "1.9.5"
+    version: "1.9.6"
   http:
     dependency: transitive
     description:
@@ -243,10 +243,10 @@ packages:
     dependency: transitive
     description:
       name: intl
-      sha256: d6f56758b7d3014a48af9701c085700aac781a92a87a62b1333b46d8879661cf
+      sha256: "3bc132a9dbce73a7e4a21a17d06e1878839ffbf975568bc875c60537824b0c4d"
       url: "https://pub.dev"
     source: hosted
-    version: "0.19.0"
+    version: "0.18.1"
   js:
     dependency: transitive
     description:
@@ -347,10 +347,10 @@ packages:
     dependency: transitive
     description:
       name: path_provider_android
-      sha256: e595b98692943b4881b219f0a9e3945118d3c16bd7e2813f98ec6e532d905f72
+      sha256: "477184d672607c0a3bf68fbbf601805f92ef79c82b64b4d6eb318cbca4c48668"
       url: "https://pub.dev"
     source: hosted
-    version: "2.2.1"
+    version: "2.2.2"
   path_provider_foundation:
     dependency: transitive
     description:
@@ -640,10 +640,10 @@ packages:
     dependency: transitive
     description:
       name: url_launcher_linux
-      sha256: "9f2d390e096fdbe1e6e6256f97851e51afc2d9c423d3432f1d6a02a8a9a8b9fd"
+      sha256: ab360eb661f8879369acac07b6bb3ff09d9471155357da8443fd5d3cf7363811
       url: "https://pub.dev"
     source: hosted
-    version: "3.1.0"
+    version: "3.1.1"
   url_launcher_macos:
     dependency: transitive
     description:
@@ -672,18 +672,18 @@ packages:
     dependency: transitive
     description:
       name: url_launcher_windows
-      sha256: "7754a1ad30ee896b265f8d14078b0513a4dba28d358eabb9d5f339886f4a1adc"
+      sha256: ecf9725510600aa2bb6d7ddabe16357691b6d2805f66216a97d1b881e21beff7
       url: "https://pub.dev"
     source: hosted
-    version: "3.1.0"
+    version: "3.1.1"
   uuid:
     dependency: transitive
     description:
       name: uuid
-      sha256: df5a4d8f22ee4ccd77f8839ac7cb274ebc11ef9adcce8b92be14b797fe889921
+      sha256: "22c94e5ad1e75f9934b766b53c742572ee2677c56bc871d850a57dad0f82127f"
       url: "https://pub.dev"
     source: hosted
-    version: "4.2.1"
+    version: "4.2.2"
   vector_graphics:
     dependency: transitive
     description:

diff --git a/packages/hms_room_kit/example/pubspec.yaml b/packages/hms_room_kit/example/pubspec.yaml
@@ -16,7 +16,7 @@ publish_to: "none" # Remove this line if you wish to publish to pub.dev
 # https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
 # In Windows, build-name is used as the major, minor, and patch parts
 # of the product and file versions while build-number is used as the build suffix.
-version: 1.0.8
+version: 1.0.9
 
 environment:
   sdk: ">=2.19.6 <3.0.0"

diff --git a/packages/hms_room_kit/lib/src/assets/icons/block.svg b/packages/hms_room_kit/lib/src/assets/icons/block.svg
diff --git a/packages/hms_room_kit/lib/src/assets/icons/copy.svg b/packages/hms_room_kit/lib/src/assets/icons/copy.svg
diff --git a/packages/hms_room_kit/lib/src/assets/icons/everyone.svg b/packages/hms_room_kit/lib/src/assets/icons/everyone.svg