Merge branch 'master' into more_phone_support

Author: cybex-dev

.github/workflows/flutter-build-test.yml

@@ -0,0 +1,43 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Flutter Build and Test only
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+  workflow_dispatch:
+
+env:
+  FLUTTER_VERSION: 3.27.4
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ env.FLUTTER_VERSION }}
+          channel: 'stable'
+          cache: true
+
+      - run: flutter --version
+
+      - name: Install dependencies
+        run: flutter pub get
+
+      - name: Analyze project source
+        run: flutter analyze
+
+      - name: Run tests
+        run: flutter test --coverage

.github/workflows/flutter.yml renamed to .github/workflows/flutter_web-build-deploy.yml

@@ -3,28 +3,29 @@
 # separate terms of service, privacy policy, and support
 # documentation.
 
-name: Flutter analyze, test & deploy example web app
+name: Flutter Web deploy Example to Firebase Hosting
 
 on:
   push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
+    branches: [ "prod" ]
 
   workflow_dispatch:
 
+env:
+  FLUTTER_VERSION: 3.27.4
+
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Flutter
         uses: subosito/flutter-action@v2
         with:
-          flutter-version: '3.10.6'
+          flutter-version: ${{ env.FLUTTER_VERSION }}
           channel: 'stable'
           cache: true
 
@@ -33,39 +34,31 @@ jobs:
       - name: Install dependencies
         run: flutter pub get
 
-      - name: Analyze project source
-        run: flutter analyze
+      - name: Enable web support
+        run: flutter config --enable-web
 
-      - name: Run tests
-        run: flutter test --coverage
+      - name: Create web build with release mode
+        run: |
+          cd ./example
+          flutter build web --release --target=lib/main.dart --output=build/web          
 
-  deploy-example-web:
+      - name: Archive Production Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: web-build
+          path: example/build/web
+
+  deploy:
     runs-on: ubuntu-latest
     needs: build
-
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - name: Setup Flutter build environment
-        uses: subosito/flutter-action@v2
-        with:
-          flutter-version: '3.10.6'
-          channel: 'stable'
-          cache: true
-
-      - run: flutter --version
-      - run: flutter pub get
-      - run: flutter config --enable-web
-      - run: cd ./example; flutter build web --release --target=lib/main.dart --output=build/web
-
-      - name: Update service worker
-        run: cat ./example/service-worker/twilio-sw.js >> ./example/build/web/flutter_service_worker.js
-
-      - name: Archive Production Artifact
-        uses: actions/upload-artifact@master
+      - name: Download Production Artifact
+        uses: actions/download-artifact@v4
         with:
           name: web-build
-          path: example/build/web
+          path: ./example/build/web
 
       - name: Firebase Deploy
         uses: FirebaseExtended/action-hosting-deploy@v0

CHANGELOG.md

@@ -1,11 +1,100 @@
-## Next release
-* Update example
-  * [Web] Update example with Firebase Analytics (Web, optional)
-  * [Web] Added environment registration support
+## Next Release
+
+* BREAKING CHANGES:
+  * Feat: Completed migration to Federated Plugin structure. This requires one change:
+  ```dart
+  /// old
+  TwilioVoice.instance
+  
+  // new 
+  TwilioVoicePlatform.instance
+  ```
+* Feat: [Web] Add Twilio Device [DeviceState] accessor protecting un/registration.
+* Feat: [Web] Add Twilio Device `updateToken(String)` function to allow updating of active device tokens.
+* Fix: [Web] Twilio Device does not unregister on `unregister()` method call due to 'device.off' not visible in js object causing device event listeners to remain attached on unregistered device.
+* Feat: [Web] Check unnecessary updating device with the same token. 
+* Feat: [Web] Update internal [CallStatus] mapping method.
+* Fix: [Web] Await Twilio Device `register()` and `unregister()` method calls.
+* Fix: [Web] Prevent duplicate `TwilioVoiceWeb` instances.
+* Feat: [iOS] Add support for call logging via `enableCallLogging(bool)` to record call in recents. No other platform currently supports this, see [NOTES.md](NOTES.md#limitations) for more details.
+* Feat: update example.
+* Docs: update CHANGELOG
+
+## 0.3.2+2
+
+* Fix: [iOS] show caller number or interpretted client name for performStartCallAction
+* Docs: update CHANGELOG
+
+## 0.3.2+1
+
+* Fix: [iOS] Missed call notifications now show caller name (or full number) on title, and "Missed call" text in body. [Issue #299](https://github.com/cybex-dev/twilio_voice/issues/299)
+* Feat: [iOS] show caller number or interpretted client name for reportingIncomingCall and missed call notification
+* Docs: update CHANGELOG
+
+## 0.3.2
+
+* Fix: [iOS] Add missing `deviceToken` when reporting 'DEVICETOKEN' `CallEvent`. [Issue #241](https://github.com/cybex-dev/twilio_voice/issues/241)
+* Fix: [iOS] Notifications not showing when app is in foreground.
+
+## 0.3.1
+
+* Fix: [iOS] Fix `hangUp()` not ending incoming call when call is ringing. [Issue #244](https://github.com/cybex-dev/twilio_voice/issues/244)
+* Feat: [iOS] Add missing `answer()` native implementation. [Issue #244](https://github.com/cybex-dev/twilio_voice/issues/244)
+* Feat: Add raw `Connect({Map<String, dynamic>?})` for all platforms
+* Refactor: [Web] Removed unused `web_callkit` event listeners. 
+* Fix: [Web] Check if call SID is present when call is disconnected (this occurs if the call ends abruptly after starting, and `params` does not contain `CallSid`).
+* Fix: [iOS] unregister removes device push token preventing new access token registration (i.e. user 1 logs out, user 2 and more won't receive any calls). Thanks to [@VinceDollo](https://github.com/VinceDollo) & [@Erchil66](https://github.com/Erchil66) [Issue #273](https://github.com/cybex-dev/twilio_voice/issues/273)
+* Fix: [Android] placing outgoing call then ending immediately results in no Flutter plugin not registering call ended. Thanks to [@RageshAntonyHM](https://github.com/RageshAntonyHM) & [@Erchil66](https://github.com/Erchil66) [Issue #275](https://github.com/cybex-dev/twilio_voice/issues/275)
+* Fix: [Android] Migrate to declarative plugins block from Flutter's `app_plugin_loader` Gradle plugin. (see: [Deprecated imperative apply of Flutter's Gradle plugins](https://docs.flutter.dev/release/breaking-changes/flutter-gradle-plugin-apply))
+* Docs: update CHANGELOG, TODO
+
+## 0.3.0+1
+
+* Fix: [Web] add missing web_callkit outgoing call notification
+* Docs: update CHANGELOG, README
+
+## 0.3.0
+* BREAKING CHANGES:
+  * Feat: [Web] Add [web_callkit](https://pub.dev/packages/web_callkit) support. Please see updated [Web Setup](README.md#web-setup) section in the README for details.
+* Docs: update README, NOTES & CHANGELOG
+* Feat: [Web] Update example with custom incoming ringtone field.
+* Feat: [Web] Add custom sounds for Twilio Device using `updateSound(SoundName, String?)` or `updateSounds(Map<String, String>)` methods.
+* Fix: [Android] `call.isOnCall()` returns true when call is declined
+* Fix: [Android] handle reject vs error disconnect cause with message.
+* Logging: [Android] Added error code fallback
+* Feat: Update example permissions screen & changed `local` to `URL` registration method
+* Fix: [macOS] Remove deprecated `.alert` presentation option. [@AndreiMisiukevich](https://github.com/AndreiMisiukevich)
+* Feat: [macOS] Add native microphone permission with `AVCaptureDevice` (this replaces `getUserMedia()` from js interop available on localhost/https only). [@AndreiMisiukevich](https://github.com/AndreiMisiukevich)
+* Fix/Update: [macOS] correct runtime entitlement for `audio-input` permission. [@AndreiMisiukevich](https://github.com/AndreiMisiukevich)
+
+## 0.2.2
+
+* Fix: [Android] Fix cancelling call when app is in background throws [BackgroundServiceStartNotAllowedException](https://developer.android.com/reference/android/app/BackgroundServiceStartNotAllowedException). [Issue #204](https://github.com/cybex-dev/twilio_voice/issues/204)
+* Fix: [Web] Fixed microphone permission (using `getUserMedia`) for Firefox & Safari. [Issue #260](https://github.com/cybex-dev/twilio_voice/issues/260). Credit to [@AndreiMisiukevich](https://github.com/AndreiMisiukevich)
+
+## 0.2.1
+
+* Fix: [iOS] Race condition ending call remotely and locally results in a "End Call Failed: The operation couldn’t be completed." error. [Issue #184](https://github.com/cybex-dev/twilio_voice/issues/184)
+* Fix: [iOS] Plugin messages sent via Event Sink throwing an error due to sending from background thread. [Issue #256](https://github.com/cybex-dev/twilio_voice/issues/256)
+
+## 0.2.0+1
+
+* Fix: [Web] `window.localStorage` deprecated members
+* Updated README.md
+
+## 0.2.0
+* [Android] Support (long-awaited) AGP 8 update
+* [Android, iOS] Update Twilio SDKs to latest versions, see release notes for:
+    * [Android 6.9.0](https://www.twilio.com/docs/voice/sdks/android/3x-changelog#690), and 
+    * [iOS 6.13.0](https://www.twilio.com/docs/voice/sdks/ios/changelog#6130),
+    * _web coming soon with callkit integration_
+* Update: example
+  * Added: [Web] environment registration support
   * Added `defines.config.json` file to example to support environment configuration used with ```flutter run --dart-defines-file=defines.config.json```
-  * [Web] Added `FIREBASE_ENABLE` defines to initialize Firebase only if set to true
-* [Web] Added raw `Connect({Map<String, dynamic>?})` sent to TwiML webhook.
-  * [Android] Fix `showMissedCallNotifications` not working due to incorrect method channel name
+  * Added: [Web] `FIREBASE_ENABLE` defines to initialize Firebase only if set to true
+  * Update: [Web] Update example with Firebase Analytics (Web, optional)
+* Added: [Web] Added raw `Connect({Map<String, dynamic>?})` sent to TwiML webhook.
+* Fix: [Android] `showMissedCallNotifications` not working due to incorrect method channel name
 
 ## 0.1.3
 * Added: CallEvents: 

NOTES.md

@@ -1,6 +1,17 @@
 
 # Notes
 
+### Web
+
+Web implementation relies on the [js_notifications](https://pub.dev/packages/js_notifications) package for browser notifications. These notifications including Call functionality is used by a middleware package [web_callkit](https://pub.dev/packages/web_callkit) which provides boilerplate for call management and browser notification integration.
+
+- `js_notifications` requires the service worker file `js_notifications-sw.js` to be copied to your web directory. This file is used for handling notifications in the background.
+- `web_callkit` provides the boilerplate for call management and browser notification integration, however this package requires both files used in `js_notifications` package.
+
+Further, and most importantly the `twilio_voice` package makes use of custom [twilio_voice.js](https://github.com/twilio/twilio-voice.js/) implementation (these changes are purely to provided Flutter status outputs allowing Flutter to monitor the status of the Twilio Device).
+
+The javascript files required by `twilio_voice` is `twilio.min.js`, which is found in the `example/web` folder. This may in future be loaded dynamically, but for now is required to be provided in the `web/` folder.
+
 ### Android
 
 **Package Information:**
@@ -81,6 +92,17 @@ end
 
 ## Limitations
 
+### Android
+
+Android `ConnectionService` provides the fundamentals to managing calls, including but not limited to call logging. Using a Managed `ConnectionService` means that call logging is handled by the system's "Phone App", and so there is not access or control over call logging at this time.
+
 ### macOS
 
-Clearly, macOS isn't uppermost in mind when looking at a mobile first platform like Flutter. There are some functionality limitations for the platform/interop such as [UIImage](https://docs.flutter.dev/ui/assets-and-images#loading-ios-images-in-flutter) support and Twilio Voice library support as a whole. Hopefully we'll be seeing these implemented in future.
+Clearly, macOS isn't uppermost in mind when looking at a mobile first platform like Flutter. There are some functionality limitations for the platform/interop such as [UIImage](https://docs.flutter.dev/ui/assets-and-images#loading-ios-images-in-flutter) support and Twilio Voice library support as a whole. Hopefully we'll be seeing these implemented in future.
+
+With respect to CallKit integration for macOS, there isn't any direct support for CallKit other than via MacCatalyst which at present is somewhat out of scope for the project at this time.
+
+
+### Web
+
+As Web uses a custom [WebCallkit](https://github.com/cybex-dev/web_callkit) integration, this facilitates basic call management and browser notification integration. Call logging is not supported at this time.