pushwoosh-cordova-plugin 8.3.56 → 8.3.58

package/README.md

@@ -14,13 +14,13 @@ Cross-Platform push notifications by Pushwoosh for Cordova / PhoneGap
 Using npm:
 
 ```
-cordova plugin add pushwoosh-cordova-plugin@8.3.56
+cordova plugin add pushwoosh-cordova-plugin@8.3.58
 ```
 
 Using git:
 
 ```
-cordova plugin add https://github.com/Pushwoosh/pushwoosh-phonegap-plugin.git#8.3.56
+cordova plugin add https://github.com/Pushwoosh/pushwoosh-phonegap-plugin.git#8.3.58
 ```
 
 ### Guide

package/example_voip/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pushwoosh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/example_voip/README.md

@@ -0,0 +1,156 @@
+# CORDOVA VOIP SAMPLE
+
+## VoIP Demo application showcasing Pushwoosh SDK VoIP functionality with CallKit integration
+
+### iOS, Android
+
+## Quick Start
+
+### 1. Add platforms
+
+Simply add the required platforms — all dependencies will be installed automatically:
+
+```bash
+cd demovoip
+npm install
+
+# Add iOS platform
+cordova platform add ios
+
+# Add Android platform
+cordova platform add android
+```
+
+**What happens automatically:**
+- `pushwoosh-cordova-plugin` is installed with VoIP enabled for the added platform
+  - iOS: `PW_VOIP_IOS_ENABLED=true` is set automatically
+  - Android: `PW_VOIP_ANDROID_ENABLED=true` is set in gradle.properties
+- Gradle 8.9 and AGP 8.5.1 are configured for Android
+- `google-services.json` is copied for Firebase/FCM
+
+### 2. Configure your VoIP App Code
+
+Open the app and set your VoIP App Code in the UI, or modify the default value in `www/index.html`:
+
+```html
+<input type="text" id="pushAppId" value="YOUR-APP-ID">
+<input type="text" id="pushProjectId" value="YOUR-FCM-PROJECT-ID">
+```
+
+### 3. [Android] Configure Firebase
+
+Place your `google-services.json` in the project root. The file will be automatically copied to `platforms/android/app/` when running `cordova prepare`.
+
+To work with Firebase/FCM:
+1. Download `google-services.json` from Firebase Console
+2. Place it in `/demovoip/google-services.json`
+3. Run `cordova prepare android`
+
+### 4. [iOS] VoIP Push Notifications Setup
+
+#### a. Enable VoIP Push in your Apple Developer Account
+- Navigate to your App ID settings
+- Enable "Background Modes" → "Voice over IP"
+- Enable "Push Notifications"
+
+#### b. Configure CallKit in Xcode
+Open the Xcode project (`platforms/ios/demovoip.xcworkspace`) and ensure:
+- Background Modes → Voice over IP is enabled
+- Push Notifications capability is added
+
+### 5. Build and Run
+
+```bash
+# iOS
+cordova build ios
+
+# Android
+cordova build android
+```
+
+## Features
+
+- VoIP push notifications support
+- CallKit integration (iOS)
+- Android calling support with permissions
+- Real-time VoIP event monitoring
+- Interactive demo UI with event logging
+- Manual SDK initialization with App ID input
+- VoIP parameters configuration (video, ringtone, handle type)
+
+## App Features
+
+### Push Notifications Setup
+- Initialize Pushwoosh SDK with App ID and FCM Project ID
+- Automatically set VoIP App Code
+
+### VoIP Parameters
+- Enable/disable video support
+- Configure ringtone sound (iOS only)
+- Select handle type (Generic, Phone Number, Email)
+
+### Call Permissions (Android)
+- Request call permission (Android 12+)
+- Check permission status
+
+### Push Notifications (Android)
+- Register for regular push notifications
+- Get push token
+
+### Call Controls
+- End active VoIP call
+
+### VoIP Events Log
+- Monitor all VoIP events:
+  - `voipPushPayload` - VoIP notification received
+  - `answer` - Incoming call answered
+  - `reject` - Incoming call rejected
+  - `hangup` - Call ended
+  - `muted` / `unmuted` - Microphone muted/unmuted
+  - `held` / `unheld` - Call held/unheld
+  - `dtmf` - DTMF tones
+  - `audioInterruption` - Audio interruption
+  - `callFailed` - Call failed
+  - `providerDidActivate` / `providerDidDeactivate` - CallKit activation/deactivation
+  - `incomingCallSuccess` / `incomingCallFailure` - Incoming call success/failure
+  - `voipDidRegisterTokenSuccessfully` / `voipDidFailToRegisterTokenWithError` - VoIP token registration
+
+## Testing VoIP Calls
+
+### iOS
+1. Build and run the app on a physical device (VoIP doesn't work on simulator)
+2. The app will automatically register for VoIP notifications
+3. Send a VoIP push from Pushwoosh Control Panel using the VoIP App Code
+4. Receive an incoming call via CallKit
+
+### Android
+1. Build and run the app
+2. Grant call permission (Android 12+)
+3. Tap "Register for Push Notifications" to register
+4. Send a VoIP push from Pushwoosh Control Panel
+5. Receive an incoming call via Android Calling API
+
+## Troubleshooting
+
+### Android: "Minimum supported Gradle version is 8.9"
+The hook automatically creates `gradle-wrapper.properties` with Gradle 8.9. If the error appears, run:
+```bash
+cordova prepare android
+```
+
+### Android: "Incompatible AGP version"
+The hook automatically fixes AGP to 8.5.1. If the error appears, run:
+```bash
+cordova prepare android
+```
+
+### Android: Firebase FIS_AUTH_ERROR
+Make sure that:
+1. `google-services.json` is in the project root
+2. An Android app with package name `com.pushwoosh.demovoip` is added in Firebase Console
+3. `oauth_client` arrays are populated in `google-services.json`
+
+### iOS: VoIP events not firing
+Make sure that:
+1. `registerVoIPEvents()` is called immediately in `onDeviceReady()`, BEFORE SDK initialization
+2. The app is running on a physical device (not simulator)

package/example_voip/demovoip/README.md

@@ -0,0 +1,181 @@
+# Pushwoosh VoIP Demo App
+
+Demo application for testing Pushwoosh SDK VoIP functionality in Cordova.
+
+## Quick Start
+
+### 1. Adding Platforms
+
+Simply add the required platforms — all dependencies will be installed automatically:
+
+```bash
+# Add iOS platform
+cordova platform add ios
+
+# Add Android platform
+cordova platform add android
+```
+
+**What happens automatically:**
+- `pushwoosh-cordova-plugin` is installed with VoIP enabled for the added platform
+  - iOS: `PW_VOIP_IOS_ENABLED=true` is set automatically
+  - Android: `PW_VOIP_ANDROID_ENABLED=true` is set in gradle.properties
+- Gradle 8.9 and AGP 8.5.1 are configured for Android
+- `google-services.json` is copied for Firebase/FCM
+
+### 2. Configuration
+
+#### App ID and VoIP App Code
+By default, the test App ID is used: `7BCDB-76CBE`
+
+To use your own App ID, change the values in `www/index.html`:
+```html
+<input type="text" id="pushAppId" value="YOUR-APP-ID">
+<input type="text" id="pushProjectId" value="YOUR-FCM-PROJECT-ID">
+```
+
+#### Google Services (Android)
+To work with Firebase/FCM, place your `google-services.json` in the project root. The file will be automatically copied to `platforms/android/app/` when running `cordova prepare`.
+
+### 3. Build
+
+```bash
+# iOS
+cordova build ios
+
+# Android
+cordova build android
+```
+
+## Project Structure
+
+```
+demovoip/
+├── www/                        # Application sources
+│   ├── index.html             # Main page with UI
+│   ├── js/index.js            # Application logic
+│   └── css/index.css          # Styles
+├── hooks/                      # Cordova hooks (automation)
+│   ├── after_prepare/         # Run after cordova prepare
+│   │   ├── 010_setup_gradle_wrapper.js    # Sets up Gradle 8.9
+│   │   ├── 015_fix_agp_version.js         # Fixes AGP to 8.5.1
+│   │   └── 020_copy_google_services.js    # Copies google-services.json
+│   └── after_platform_add/    # Run after platform add
+│       └── 010_install_plugin.js          # Installs Pushwoosh plugin
+├── google-services.json       # Firebase configuration for Android
+├── config.xml                 # Cordova configuration
+└── package.json               # npm dependencies
+
+```
+
+## Application Features
+
+### Push Notifications Setup
+- Initialize Pushwoosh SDK with App ID and FCM Project ID
+- Automatically set VoIP App Code
+
+### VoIP Parameters
+- Enable/disable video support
+- Configure ringtone sound (iOS only)
+- Select handle type (Generic, Phone Number, Email)
+
+### Call Permissions (Android)
+- Request call permission (Android 12+)
+- Check permission status
+
+### Push Notifications (Android)
+- Register for regular push notifications
+- Get push token
+
+### Call Controls
+- End active VoIP call
+
+### VoIP Events Log
+- Monitor all VoIP events:
+  - `voipPushPayload` - VoIP notification received
+  - `answer` - Incoming call answered
+  - `reject` - Incoming call rejected
+  - `hangup` - Call ended
+  - `muted` / `unmuted` - Microphone muted/unmuted
+  - `held` / `unheld` - Call held/unheld
+  - `dtmf` - DTMF tones
+  - `audioInterruption` - Audio interruption
+  - `callFailed` - Call failed
+  - `providerDidActivate` / `providerDidDeactivate` - CallKit activation/deactivation
+  - `incomingCallSuccess` / `incomingCallFailure` - Incoming call success/failure
+  - `voipDidRegisterTokenSuccessfully` / `voipDidFailToRegisterTokenWithError` - VoIP token registration
+
+## Configuration (config.xml)
+
+### Android Settings
+```xml
+<platform name="android">
+    <preference name="GradleVersion" value="8.9" />
+    <preference name="AndroidGradlePluginVersion" value="8.5.1" />
+    <preference name="android-minSdkVersion" value="24" />
+    <preference name="android-targetSdkVersion" value="35" />
+</platform>
+```
+
+### Hooks
+```xml
+<hook type="after_prepare" src="hooks/after_prepare/010_setup_gradle_wrapper.js" />
+<hook type="after_prepare" src="hooks/after_prepare/015_fix_agp_version.js" />
+<hook type="after_prepare" src="hooks/after_prepare/020_copy_google_services.js" />
+<hook type="after_platform_add" src="hooks/after_platform_add/010_install_plugin.js" />
+```
+
+## Testing VoIP
+
+### iOS
+1. Build and run the app on a physical device (VoIP doesn't work on simulator)
+2. The app will automatically register for VoIP notifications
+3. Send a VoIP push from Pushwoosh Control Panel using the VoIP App Code
+4. Receive an incoming call via CallKit
+
+### Android
+1. Build and run the app
+2. Grant call permission (Android 12+)
+3. Tap "Register for Push Notifications" to register
+4. Send a VoIP push from Pushwoosh Control Panel
+5. Receive an incoming call via Android Calling API
+
+## Requirements
+
+- Node.js 14+
+- Cordova CLI 12+
+- For iOS: Xcode 14+, macOS
+- For Android: Android Studio, JDK 17, Android SDK
+
+## Versions
+
+- Cordova Android: 14.0.1
+- Cordova iOS: 7.1.1
+- Pushwoosh Cordova Plugin: 8.3.49
+- Gradle: 8.9
+- Android Gradle Plugin: 8.5.1
+
+## Troubleshooting
+
+### Android: "Minimum supported Gradle version is 8.9"
+The hook automatically creates `gradle-wrapper.properties` with Gradle 8.9. If the error appears, run:
+```bash
+cordova prepare android
+```
+
+### Android: "Incompatible AGP version"
+The hook automatically fixes AGP to 8.5.1. If the error appears, run:
+```bash
+cordova prepare android
+```
+
+### Android: Firebase FIS_AUTH_ERROR
+Make sure that:
+1. `google-services.json` is in the project root
+2. An Android app with package name `com.pushwoosh.demovoip` is added in Firebase Console
+3. `oauth_client` arrays are populated in `google-services.json`
+
+### iOS: VoIP events not firing
+Make sure that:
+1. `registerVoIPEvents()` is called immediately in `onDeviceReady()`, BEFORE SDK initialization
+2. The app is running on a physical device (not simulator)

package/example_voip/demovoip/config.xml

@@ -0,0 +1,22 @@
+<?xml version='1.0' encoding='utf-8'?>
+<widget id="com.pushwoosh.demovoip" version="1.0.0" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
+    <name>demovoip</name>
+    <description>Pushwoosh VoIP Sample App</description>
+    <author email="support@pushwoosh.com" href="https://www.pushwoosh.com">
+        Pushwoosh Team
+    </author>
+    <content src="index.html" />
+    <allow-intent href="http://*/*" />
+    <allow-intent href="https://*/*" />
+    <platform name="android">
+        <preference name="GradleVersion" value="8.9" />
+        <preference name="AndroidGradlePluginVersion" value="8.5.1" />
+        <preference name="android-minSdkVersion" value="24" />
+        <preference name="android-targetSdkVersion" value="35" />
+    </platform>
+    <hook type="after_prepare" src="hooks/after_prepare/010_setup_gradle_wrapper.js" />
+    <hook type="after_prepare" src="hooks/after_prepare/015_fix_agp_version.js" />
+    <hook type="after_prepare" src="hooks/after_prepare/020_copy_google_services.js" />
+    <hook type="after_platform_add" src="hooks/after_platform_add/010_install_plugin.js" />
+
+</widget>

package/example_voip/demovoip/google-services.json

@@ -0,0 +1,86 @@
+{
+  "project_info": {
+    "project_number": "843884467752",
+    "project_id": "demoapp-33098",
+    "storage_bucket": "demoapp-33098.firebasestorage.app"
+  },
+  "client": [
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1:843884467752:android:38e0329182de6fb22ec71d",
+        "android_client_info": {
+          "package_name": "com.pushwoosh.demoapp"
+        }
+      },
+      "oauth_client": [],
+      "api_key": [
+        {
+          "current_key": "AIzaSyD0fJnFrwLD820xFNFuE38csE2bm5Jn1EY"
+        }
+      ],
+      "services": {
+        "appinvite_service": {
+          "other_platform_oauth_client": []
+        }
+      }
+    },
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1:843884467752:android:a894ac7d888708bd2ec71d",
+        "android_client_info": {
+          "package_name": "com.pushwoosh.demoappunity"
+        }
+      },
+      "oauth_client": [],
+      "api_key": [
+        {
+          "current_key": "AIzaSyD0fJnFrwLD820xFNFuE38csE2bm5Jn1EY"
+        }
+      ],
+      "services": {
+        "appinvite_service": {
+          "other_platform_oauth_client": []
+        }
+      }
+    },
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1:843884467752:android:5594d785995d41832ec71d",
+        "android_client_info": {
+          "package_name": "com.pushwoosh.demovoip"
+        }
+      },
+      "oauth_client": [],
+      "api_key": [
+        {
+          "current_key": "AIzaSyD0fJnFrwLD820xFNFuE38csE2bm5Jn1EY"
+        }
+      ],
+      "services": {
+        "appinvite_service": {
+          "other_platform_oauth_client": []
+        }
+      }
+    },
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1:843884467752:android:5e6b23b8939b0d3b2ec71d",
+        "android_client_info": {
+          "package_name": "com.pushwoosh.newdemo"
+        }
+      },
+      "oauth_client": [],
+      "api_key": [
+        {
+          "current_key": "AIzaSyD0fJnFrwLD820xFNFuE38csE2bm5Jn1EY"
+        }
+      ],
+      "services": {
+        "appinvite_service": {
+          "other_platform_oauth_client": []
+        }
+      }
+    }
+  ],
+  "configuration_version": "1"
+}

package/example_voip/demovoip/hooks/after_platform_add/010_install_plugin.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+const { exec } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+
+module.exports = function(context) {
+    const projectRoot = context.opts.projectRoot;
+
+    const platforms = context.opts.platforms || [];
+    const addedPlatform = platforms[0]; // Платформа которую только что добавили
+
+    console.log(`[Hook] Platform added: ${addedPlatform}`);
+    console.log('[Hook] Installing pushwoosh-cordova-plugin with VoIP enabled...');
+
+    let voipFlags = '';
+    if (addedPlatform === 'ios') {
+        voipFlags = '--variable PW_VOIP_IOS_ENABLED=true';
+        console.log('[Hook] Enabling VoIP for iOS');
+    } else if (addedPlatform === 'android') {
+        voipFlags = '--variable PW_VOIP_ANDROID_ENABLED=true';
+        console.log('[Hook] Enabling VoIP for Android');
+    } else {
+        console.log('[Hook] No VoIP flags for this platform');
+    }
+
+    const command = `cordova plugin add ../../ --link ${voipFlags}`;
+
+    return new Promise((resolve, reject) => {
+        exec(command, { cwd: projectRoot }, (error, stdout, stderr) => {
+            if (error) {
+                if (stderr.includes('already installed') || stdout.includes('already installed')) {
+                    console.log('[Hook] Plugin already installed, skipping');
+                    resolve();
+                } else {
+                    console.error('[Hook] Error installing plugin:', stderr);
+                    reject(error);
+                }
+            } else {
+                console.log('[Hook] Plugin installed successfully');
+                console.log(stdout);
+                resolve();
+            }
+        });
+    });
+};

package/example_voip/demovoip/hooks/after_prepare/010_setup_gradle_wrapper.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+module.exports = function(context) {
+    const platforms = context.opts.platforms;
+
+    if (platforms.indexOf('android') === -1) {
+        return;
+    }
+
+    const platformRoot = path.join(context.opts.projectRoot, 'platforms/android');
+    const wrapperDir = path.join(platformRoot, 'gradle/wrapper');
+    const wrapperPropsPath = path.join(wrapperDir, 'gradle-wrapper.properties');
+
+    // Create wrapper directory if it doesn't exist
+    if (!fs.existsSync(wrapperDir)) {
+        fs.mkdirSync(wrapperDir, { recursive: true });
+    }
+
+    // Write gradle-wrapper.properties with Gradle 8.7
+    const wrapperContent = `distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\\://services.gradle.org/distributions/gradle-8.7-all.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+`;
+
+    fs.writeFileSync(wrapperPropsPath, wrapperContent, 'utf8');
+    console.log('[Hook] Created gradle-wrapper.properties with Gradle 8.7');
+};

package/example_voip/demovoip/hooks/after_prepare/015_fix_agp_version.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+module.exports = function(context) {
+    const platforms = context.opts.platforms;
+
+    if (platforms.indexOf('android') === -1) {
+        return;
+    }
+
+    const platformRoot = path.join(context.opts.projectRoot, 'platforms/android');
+    const configPath = path.join(platformRoot, 'cdv-gradle-config.json');
+
+    if (!fs.existsSync(configPath)) {
+        console.log('[Hook] cdv-gradle-config.json not found, skipping AGP fix');
+        return;
+    }
+
+    try {
+        const configContent = fs.readFileSync(configPath, 'utf8');
+        const config = JSON.parse(configContent);
+
+        // Fix AGP version to 8.5.1 (compatible with Android Studio)
+        if (config.AGP_VERSION !== '8.5.1') {
+            config.AGP_VERSION = '8.5.1';
+            fs.writeFileSync(configPath, JSON.stringify(config, null, 2) + '\n', 'utf8');
+            console.log('[Hook] Fixed AGP version to 8.5.1 in cdv-gradle-config.json');
+        } else {
+            console.log('[Hook] AGP version already correct (8.5.1)');
+        }
+    } catch (error) {
+        console.error('[Hook] Error fixing AGP version:', error.message);
+    }
+};

package/example_voip/demovoip/hooks/after_prepare/020_copy_google_services.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+module.exports = function(context) {
+    const platforms = context.opts.platforms;
+
+    if (platforms.indexOf('android') === -1) {
+        return;
+    }
+
+    const projectRoot = context.opts.projectRoot;
+    const sourceFile = path.join(projectRoot, 'google-services.json');
+    const targetFile = path.join(projectRoot, 'platforms/android/app/google-services.json');
+
+    if (fs.existsSync(sourceFile)) {
+        fs.copyFileSync(sourceFile, targetFile);
+        console.log('[Hook] Copied google-services.json to platforms/android/app/');
+    } else {
+        console.log('[Hook] Warning: google-services.json not found in project root');
+    }
+};

package/example_voip/demovoip/hooks/after_prepare/025_add_voip_pod.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+module.exports = function(context) {
+    const platforms = context.opts.platforms;
+
+    if (platforms.indexOf('ios') === -1) {
+        return;
+    }
+
+    const iosPlatformRoot = path.join(context.opts.projectRoot, 'platforms', 'ios');
+    const podfilePath = path.join(iosPlatformRoot, 'Podfile');
+
+    if (!fs.existsSync(podfilePath)) {
+        console.log('[Hook] Podfile not found, skipping VoIP pod injection');
+        return;
+    }
+
+    let podfileContent = fs.readFileSync(podfilePath, 'utf8');
+
+    // Check if PushwooshVoIP already added
+    if (podfileContent.includes("pod 'PushwooshVoIP'")) {
+        console.log('[Hook] PushwooshVoIP pod already present in Podfile');
+        return;
+    }
+
+    // Find the target block and add PushwooshVoIP pod
+    const targetRegex = /(target\s+'[^']+'\s+do[\s\S]*?pod\s+'Pushwoosh'[^\n]*\n)/;
+
+    if (targetRegex.test(podfileContent)) {
+        podfileContent = podfileContent.replace(
+            targetRegex,
+            "$1  pod 'PushwooshXCFramework/PushwooshVoIP'\n"
+        );
+
+        fs.writeFileSync(podfilePath, podfileContent, 'utf8');
+        console.log('[Hook] Added PushwooshVoIP pod to Podfile');
+    } else {
+        console.log('[Hook] Could not find Pushwoosh pod in Podfile, skipping VoIP pod injection');
+    }
+};