@capgo/capacitor-stream-call 0.0.2

package/Package.swift

@@ -0,0 +1,31 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "StreamCall",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "StreamCall",
+            targets: ["StreamCallPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0"),
+        .package(url: "https://github.com/GetStream/stream-video-swift.git", exact: "1.16.0")
+    ],
+    targets: [
+        .target(
+            name: "StreamCallPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm"),
+                .product(name: "StreamVideo", package: "stream-video-swift"),
+                .product(name: "StreamVideoSwiftUI", package: "stream-video-swift")
+            ],
+            path: "ios/Sources/StreamCallPlugin"),
+        .testTarget(
+            name: "StreamCallPluginTests",
+            dependencies: ["StreamCallPlugin"],
+            path: "ios/Tests/StreamCallPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,340 @@
+# stream-call
+ <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+
+<div align="center">
+  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo 🚀</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Fix your annoying bug now, Hire a Capacitor expert 💪</a></h2>
+</div>
+
+WIP: We are actively working on this plugin. not yet ready for production.
+Uses the https://getstream.io/ SDK to implement calling in Capacitor
+
+## Install
+
+```bash
+npm install stream-call
+npx cap sync
+```
+
+## Setting up Android StreamVideo apikey
+1. Add your apikey to the Android project:
+```
+your_app/android/app/src/main/res/values/strings.xml
+```
+
+2. Add your apikey to the Android project:
+```xml
+<string name="CAPACITOR_STREAM_VIDEO_APIKEY">your_api_key</string>
+```
+
+## Setting up iOS StreamVideo apikey
+1. Add your apikey to the iOS project:
+```
+your_app/ios/App/App/Info.plist
+```
+
+Add the following to the Info.plist file:
+```xml
+<dict>
+  <key>CAPACITOR_STREAM_VIDEO_APIKEY</key>
+  <string>n8wv8vjmucdw</string>
+  <!-- other keys -->
+</dict>
+```
+
+## Native Localization
+
+### iOS
+
+1. Add `Localizable.strings` and `Localizable.stringsdict` files to your Xcode project if you don't have them:
+```
+/App/App/en.lproj/Localizable.strings
+/App/App/en.lproj/Localizable.stringsdict
+```
+
+2. Add new languages to your project in Xcode:
+   - Open project settings
+   - Select your project
+   - Click "Info" tab
+   - Under "Localizations" click "+"
+   - Select the languages you want to add
+
+3. Add the translations in your `Localizable.strings`:
+```
+// en.lproj/Localizable.strings
+"stream.video.call.incoming" = "Incoming call from %@";
+"stream.video.call.accept" = "Accept";
+"stream.video.call.reject" = "Reject";
+"stream.video.call.hangup" = "Hang up";
+"stream.video.call.joining" = "Joining...";
+"stream.video.call.reconnecting" = "Reconnecting...";
+```
+
+4. Configure the localization provider in your `AppDelegate.swift`:
+```swift
+import StreamVideo
+
+@UIApplicationMain
+class AppDelegate: UIResponder, UIApplicationDelegate {
+    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+        // Set localization provider to use your app's bundle
+        Appearance.localizationProvider = { key, table in
+            Bundle.main.localizedString(forKey: key, value: nil, table: table)
+        }
+        return true
+    }
+}
+```
+
+You can find all available localization keys in the [StreamVideo SDK repository](https://github.com/GetStream/stream-video-swift/blob/main/Sources/StreamVideoSwiftUI/Resources/en.lproj/Localizable.strings).
+
+### Android
+1. Create string resources in `/app/src/main/res/values/strings.xml`:
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="stream_video_call_incoming">Incoming call from %1$s</string>
+    <string name="stream_video_call_accept">Accept</string>
+    <string name="stream_video_call_reject">Reject</string>
+    <string name="stream_video_call_hangup">Hang up</string>
+    <string name="stream_video_call_joining">Joining...</string>
+    <string name="stream_video_call_reconnecting">Reconnecting...</string>
+</resources>
+```
+
+2. Add translations for other languages in their respective folders (e.g., `/app/src/main/res/values-fr/strings.xml`):
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string name="stream_video_call_incoming">Appel entrant de %1$s</string>
+    <string name="stream_video_call_accept">Accepter</string>
+    <string name="stream_video_call_reject">Refuser</string>
+    <string name="stream_video_call_hangup">Raccrocher</string>
+    <string name="stream_video_call_joining">Connexion...</string>
+    <string name="stream_video_call_reconnecting">Reconnexion...</string>
+</resources>
+```
+
+The SDK will automatically use the system language and these translations.
+
+## API
+
+<docgen-index>
+
+* [`login(...)`](#login)
+* [`logout()`](#logout)
+* [`call(...)`](#call)
+* [`endCall()`](#endcall)
+* [`setMicrophoneEnabled(...)`](#setmicrophoneenabled)
+* [`setCameraEnabled(...)`](#setcameraenabled)
+* [`addListener('callEvent', ...)`](#addlistenercallevent-)
+* [`removeAllListeners()`](#removealllisteners)
+* [`acceptCall()`](#acceptcall)
+* [`rejectCall()`](#rejectcall)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### login(...)
+
+```typescript
+login(options: LoginOptions) => Promise<SuccessResponse>
+```
+
+Login to Stream Video service
+
+| Param         | Type                                                  | Description           |
+| ------------- | ----------------------------------------------------- | --------------------- |
+| **`options`** | <code><a href="#loginoptions">LoginOptions</a></code> | - Login configuration |
+
+**Returns:** <code>Promise&lt;<a href="#successresponse">SuccessResponse</a>&gt;</code>
+
+--------------------
+
+
+### logout()
+
+```typescript
+logout() => Promise<SuccessResponse>
+```
+
+Logout from Stream Video service
+
+**Returns:** <code>Promise&lt;<a href="#successresponse">SuccessResponse</a>&gt;</code>
+
+--------------------
+
+
+### call(...)
+
+```typescript
+call(options: CallOptions) => Promise<SuccessResponse>
+```
+
+Initiate a call to another user
+
+| Param         | Type                                                | Description          |
+| ------------- | --------------------------------------------------- | -------------------- |
+| **`options`** | <code><a href="#calloptions">CallOptions</a></code> | - Call configuration |
+
+**Returns:** <code>Promise&lt;<a href="#successresponse">SuccessResponse</a>&gt;</code>
+
+--------------------
+
+
+### endCall()
+
+```typescript
+endCall() => Promise<SuccessResponse>
+```
+
+End the current call
+
+**Returns:** <code>Promise&lt;<a href="#successresponse">SuccessResponse</a>&gt;</code>
+
+--------------------
+
+
+### setMicrophoneEnabled(...)
+
+```typescript
+setMicrophoneEnabled(options: { enabled: boolean; }) => Promise<SuccessResponse>
+```
+
+Enable or disable microphone
+
+| Param         | Type                               | Description        |
+| ------------- | ---------------------------------- | ------------------ |
+| **`options`** | <code>{ enabled: boolean; }</code> | - Microphone state |
+
+**Returns:** <code>Promise&lt;<a href="#successresponse">SuccessResponse</a>&gt;</code>
+
+--------------------
+
+
+### setCameraEnabled(...)
+
+```typescript
+setCameraEnabled(options: { enabled: boolean; }) => Promise<SuccessResponse>
+```
+
+Enable or disable camera
+
+| Param         | Type                               | Description    |
+| ------------- | ---------------------------------- | -------------- |
+| **`options`** | <code>{ enabled: boolean; }</code> | - Camera state |
+
+**Returns:** <code>Promise&lt;<a href="#successresponse">SuccessResponse</a>&gt;</code>
+
+--------------------
+
+
+### addListener('callEvent', ...)
+
+```typescript
+addListener(eventName: 'callEvent', listenerFunc: (event: CallEvent) => void) => Promise<{ remove: () => Promise<void>; }>
+```
+
+Add listener for call events
+
+| Param              | Type                                                                | Description                       |
+| ------------------ | ------------------------------------------------------------------- | --------------------------------- |
+| **`eventName`**    | <code>'callEvent'</code>                                            | - Name of the event to listen for |
+| **`listenerFunc`** | <code>(event: <a href="#callevent">CallEvent</a>) =&gt; void</code> | - Callback function               |
+
+**Returns:** <code>Promise&lt;{ remove: () =&gt; Promise&lt;void&gt;; }&gt;</code>
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all event listeners
+
+--------------------
+
+
+### acceptCall()
+
+```typescript
+acceptCall() => Promise<SuccessResponse>
+```
+
+Accept an incoming call
+
+**Returns:** <code>Promise&lt;<a href="#successresponse">SuccessResponse</a>&gt;</code>
+
+--------------------
+
+
+### rejectCall()
+
+```typescript
+rejectCall() => Promise<SuccessResponse>
+```
+
+Reject an incoming call
+
+**Returns:** <code>Promise&lt;<a href="#successresponse">SuccessResponse</a>&gt;</code>
+
+--------------------
+
+
+### Interfaces
+
+
+#### SuccessResponse
+
+| Prop          | Type                 | Description                          |
+| ------------- | -------------------- | ------------------------------------ |
+| **`success`** | <code>boolean</code> | Whether the operation was successful |
+
+
+#### LoginOptions
+
+| Prop               | Type                                                                                        | Description                                             |
+| ------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
+| **`token`**        | <code>string</code>                                                                         | Stream Video API token                                  |
+| **`userId`**       | <code>string</code>                                                                         | User ID for the current user                            |
+| **`name`**         | <code>string</code>                                                                         | Display name for the current user                       |
+| **`imageURL`**     | <code>string</code>                                                                         | Optional avatar URL for the current user                |
+| **`apiKey`**       | <code>string</code>                                                                         | Stream Video API key                                    |
+| **`magicDivId`**   | <code>string</code>                                                                         | ID of the HTML element where the video will be rendered |
+| **`refreshToken`** | <code>{ url: string; headers?: <a href="#record">Record</a>&lt;string, string&gt;; }</code> | Configuration for token refresh                         |
+
+
+#### CallOptions
+
+| Prop         | Type                 | Description                                      |
+| ------------ | -------------------- | ------------------------------------------------ |
+| **`userId`** | <code>string</code>  | User ID of the person to call                    |
+| **`type`**   | <code>string</code>  | Type of call, defaults to 'default'              |
+| **`ring`**   | <code>boolean</code> | Whether to ring the other user, defaults to true |
+
+
+#### CallEvent
+
+| Prop         | Type                | Description               |
+| ------------ | ------------------- | ------------------------- |
+| **`callId`** | <code>string</code> | ID of the call            |
+| **`state`**  | <code>string</code> | Current state of the call |
+
+
+### Type Aliases
+
+
+#### Record
+
+Construct a type with a set of properties K of type T
+
+<code>{
 [P in K]: T;
 }</code>
+
+</docgen-api>

package/StreamCall.podspec

@@ -0,0 +1,19 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'StreamCall'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '14.0'
+  s.dependency 'Capacitor'
+  s.dependency 'StreamVideo'
+  s.dependency 'StreamVideoSwiftUI'
+  s.swift_version = '5.1'
+end

package/android/build.gradle

@@ -0,0 +1,74 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+    kotlin_version = '2.1.10'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:2.1.10"
+        classpath 'org.jetbrains.kotlin.plugin.compose:org.jetbrains.kotlin.plugin.compose.gradle.plugin:2.1.10'
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'org.jetbrains.kotlin.android'
+apply plugin: 'org.jetbrains.kotlin.plugin.compose'
+
+android {
+    namespace "ee.forgr.capacitor.streamcall"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+    kotlinOptions {
+        jvmTarget = '21'
+    }
+    buildFeatures {
+        compose = true
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+// ab
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation 'androidx.core:core-ktx:1.15.0'
+    implementation 'androidx.compose.material3:material3'
+    implementation("io.getstream:stream-video-android-ui-compose:1.3.1")
+    implementation "androidx.coordinatorlayout:coordinatorlayout:1.2.0"
+    implementation("io.getstream:stream-android-push-firebase:1.3.0")
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>