Merge branch 'master' into prod

Author: cybex-dev

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,24 @@
+---
+name: '🐞 Bug Report'
+about: Create a report
+title: ''
+labels: ['type:Bug', 'status:Unconfirmed']
+assignees: ''
+---
+
+<!--
+Found a bug? Please fill out the sections below. 👍
+-->
+
+### Issue Summary
+
+<!--
+A summary of the issue.
+-->
+
+### Steps to Reproduce
+
+1. 
+
+Any other relevant information. For example, why do you consider this a bug and what did you expect to happen instead?
+

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,40 @@
+---
+name: '🚀 Feature request'
+about: Suggest an idea/concept/feature to enhance the project
+title: ''
+labels: 'type:Enhancement'
+assignees: ''
+---
+
+### Is your proposal related to a problem?
+
+<!--
+  Provide a clear and concise description of what the problem is.
+-->
+
+(Write your answer here.)
+
+### Describe the solution you'd like
+
+<!--
+  Provide a clear and concise description of what you want to happen.
+-->
+
+(Describe your proposed solution here.)
+
+### Describe alternatives you've considered
+
+<!--
+  Let us know about other solutions you've tried or researched.
+-->
+
+(Write your answer here.)
+
+### Additional context
+
+<!--
+  Is there anything else you can add about the proposal?
+  You might want to link to related issues here, if you haven't already.
+-->
+
+(Write your answer here.)

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,15 @@
+# Description
+
+Please include a summary of the change(s) and which issue(s) are to be fixed/addressed or feature(s) to be added. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## Screenshots (if appropriate):

.github/workflows/flutter-prod.yml

@@ -0,0 +1,71 @@
+# 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 analyze, test & deploy example web app
+
+on:
+  push:
+    branches: [ "prod" ]
+
+  workflow_dispatch:
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.22.0'
+          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
+        run: echo "Ignoring tests for now."
+
+  deploy-example-web:
+    runs-on: ubuntu-latest
+    needs: build_and_test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Flutter build environment
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.22.0'
+          channel: 'stable'
+          cache: true
+
+      - run: flutter config --enable-web
+      - run: cd ./example; flutter build web --release --target=lib/main.dart --output=build/web
+
+      - name: Archive Production Artifact
+        uses: actions/upload-artifact@master
+        with:
+          name: web-build
+          path: example/build/web
+
+      - name: Firebase Deploy
+        uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_WEB_CALLKIT }}'
+          projectId: web-callkit
+          channelId: live
+

.gitignore

@@ -25,3 +25,7 @@ doc/api/
 
 .flutter-plugins
 .flutter-plugins-dependencies
+
+.idea/
+
+.DS_Store

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.

README.md

@@ -1 +1,114 @@
-# web_callkit
+# web_callkit
+
+**This project is a Web Flutter plugin that facilitates handling of calls.**
+
+Inspired by the iOS CallKit framework, this plugin provides the boilerplate to manage calls via a
+simple API and provides a browser call control mechanism through browser notifications.
+
+### Notes
+
+Due to many voip providers e.g. twilio-voice.js providing their own SDKs and audio handling (
+incoming ringing, etc), this plugin is intended to be used as a boilerplate for call management and
+not as a full-fledged voip solution.
+
+A bird's eye overview/usage of the plugin:
+
+- Notify callkit of an incoming call
+- Update state of call from VOIP/SIP provider
+- Add/update call capabilities (hold, mute, etc)
+
+## Features
+
+- Boilerplate for call management
+- Integration with browser notifications
+- Support background calls
+- Custom audio sounds for incoming calls, etc.
+
+### Call State flow
+
+![](https://raw.githubusercontent.com/cybex-dev/web_callkit/refs/heads/master/doc/images/callflow.png)
+
+## Limitations
+
+### Browser notifications
+
+Use native browser integration, the following limitations apply to each platform. Usage of Flutter
+package [js_notifications](https://pub.dev/packages/js_notifications) is assist in browser
+notification integration to native systems. See [js_notifications > platform limitations](https://github.com/cybex-dev/js_notifications?tab=readme-ov-file#platform-limitations)
+for more information
+
+## Installation
+
+### Import the package  
+
+```dart
+import 'package:web_callkit/web_callkit.dart';
+```
+
+### Display the system call screen
+
+Inform the plugin that an incoming call is being received. This will hook into the browser
+notification system.
+
+```dart
+WebCallKit.instance.displayIncomingCall(
+uuid: '1234',
+handle: 'John Doe',
+);
+```
+
+### End the call
+
+End the call by calling the `endCall` method. This will remove the call screen and stop the browser
+notification. Calls are disconnected for various reasons, via local user requests or remote errors
+or disconnects with VoIP calls due to internet disruptions.
+
+The CallKit supports `DisconnectResponse` enum to specify the reason for the call disconnection.
+
+e.g. `WebCallKit.instance.reportCallDisconnected('1234', response: DisconnectResponse.local);`
+
+| Reason   | Description                                                                           |
+|----------|---------------------------------------------------------------------------------------|
+| local    | Disconnect due to a local end call request.                                           |
+| remote   | Disconnect due to a remote end call request or remote party failed to answer in time. |
+| canceled | Disconnect due to a call was cancelled.                                               |
+| missed   | Disconnect due to a incoming call was not answered in time.                           |
+| rejected | Disconnect due to incoming call was rejected.                                         |
+| busy     | Disconnect due to remote party being busy.                                            |
+| error    | Disconnect due to an error.                                                           |
+| unknown  | Disconnect response is unknown.                                                       |
+
+### Features
+
+#### Call Management
+
+CallKit provides a simple API to manage calls. The plugin provides methods to report incoming calls,
+end calls, and update call information. Futher, inspiration is taken from Android's ConnectionService 
+providing a set of capabilities to manage calls, such as:
+
+| Reason       | Description                                                 |
+|--------------|-------------------------------------------------------------|
+| hold         | Ability to place a call on hold after the call has started. |
+| supportHold  | Ability to place a call on hold from the start of the call. |
+| mute         | Ability to mute a call.                                     |
+
+##### Incoming Calls
+
+Incoming calls are displayed on the screen with the caller's name and number. The call screen can be
+customized with the caller's name, number, and profile picture.
+
+```dart
+WebCallKit.instance.reportNewCall(
+uuid: '1234',
+handle: 'John Doe',
+);
+```
+
+#### Notification Integration
+
+#### Capabilities
+
+## Limitations / Future work
+
+- Support video & desktop streaming natively
+

analysis_options.yaml

@@ -0,0 +1,4 @@
+include: package:flutter_lints/flutter.yaml
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options