cordova-plugin-in-app-updates 2.0.5 → 2.1.0

package/README.md

@@ -1,5 +1,4 @@
-
- ![License](https://img.shields.io/badge/license-MIT-orange.svg) ![Platform](https://img.shields.io/badge/platform-android-green.svg) [![Donate](https://img.shields.io/badge/donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G33QACCVKYD7U)
+![npm](https://img.shields.io/npm/dt/cordova-plugin-in-app-updates) ![npm](https://img.shields.io/npm/v/cordova-plugin-in-app-updates) ![GitHub package.json version](https://img.shields.io/github/package-json/v/andreszs/cordova-plugin-in-app-updates?color=FF6D00&label=master&logo=github) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/andreszs/cordova-plugin-in-app-updates) ![GitHub top language](https://img.shields.io/github/languages/top/andreszs/cordova-plugin-in-app-updates) ![GitHub](https://img.shields.io/github/license/andreszs/cordova-plugin-in-app-updates) ![GitHub last commit](https://img.shields.io/github/last-commit/andreszs/cordova-plugin-in-app-updates)
 
 # cordova-plugin-in-app-updates
 
@@ -8,12 +7,12 @@ Cordova Android plugin for checking for updates and auto updating app with Googl
 # Platforms
 
 - Android
-- Browser
+- Browser (filler platform)
 
 # Features
 
-- AndroidX ready (plugin version 2.0.x)
-- Checks for updates
+- AndroidX ready (plugin version 2.x.x)
+- Check for updates
 - Install flexible updates
 - Install immediate updates
 - Customize snackbar message and button for Flexible updates
@@ -21,23 +20,24 @@ Cordova Android plugin for checking for updates and auto updating app with Googl
 
 # Installation
 
-## Version Requirements
+## Plugin Versions
 
-| Plugin version | Cordova CLI | Cordova Android | AndroidX support |
-| --- | --- | --- | --- |
-| 1.0.6 | 9.0.0 | 8.0.0 | No |
-| 2.0.5 | 10.0.0 | 9.0.0 | Yes |
+| Plugin version | Cordova >= | Cordova Android | AndroidX | targetSdkVersion |
+| --- | --- | --- | --- | --- |
+| 1.0.6 | 9.0.0 | 8.0.0 | No | 29 |
+| 2.0.5 | 10.0.0 | 9.0.0 | Yes | 30/31 |
+| 2.1.0 | 10.0.0 | 11.0.0 | Yes | 32 |
 
-## Install latest version
+### Install latest version from NPM
 
 ```bash
   cordova plugin add cordova-plugin-in-app-updates
 ```
 
-## Install version 1.x
+### Install latest version from master
 
 ```bash
-  cordova plugin add cordova-plugin-in-app-updates@1.0.6
+  cordova plugin add https://github.com/andreszs/cordova-plugin-in-app-updates
 ```
 
 # Methods
@@ -46,6 +46,10 @@ Cordova Android plugin for checking for updates and auto updating app with Googl
 
 Invokes the AppUpdateManager and return one of the [updateAvailability](https://developer.android.com/reference/com/google/android/play/core/install/model/UpdateAvailability.html) codes as string.
 
+```javascript
+cordova.plugins.InAppUpdate.getUpdateAvailability(successCallback, errorCallback)
+```
+
 ### Return values
 
 - **UPDATE_AVAILABLE**
@@ -73,6 +77,10 @@ cordova.plugins.InAppUpdate.getUpdateAvailability(onSuccess, onFailure);
 
 Starts a [flexible update](https://developer.android.com/guide/playcore/in-app-updates/kotlin-java#flexible "flexible update") process and prompts the user with a dialog to download the new version now or when Wi-Fi is available.
 
+```javascript
+cordova.plugins.InAppUpdate.updateFlexible(successCallback, errorCallback)
+```
+
 :warning: The **successCallback** from this method can be triggered repeatedly according to its status.
 
 ### Return values
@@ -107,6 +115,10 @@ cordova.plugins.InAppUpdate.updateFlexible(onSuccess, onFailure);
 
 Starts an [immediate update](https://developer.android.com/guide/playcore/in-app-updates/kotlin-java#immediate "immediate update") process and prompts the user with a fullscreen dialog to download now or when Wi-Fi is available. The update is downloaded and installed in the foreground, preventing the user from interacting with your app until the installation succeeds and the app is automatically restarted.
 
+```javascript
+cordova.plugins.InAppUpdate.updateImmediate(successCallback, errorCallback)
+```
+
 :warning: The **successCallback** from this method can be triggered repeatedly according to its status.
 
 ### Return values
@@ -138,7 +150,9 @@ cordova.plugins.InAppUpdate.updateImmediate(onSuccess, onFailure);
 
 Sets the label and the button text for the snackbar shown after downloading a flexible update. You are free to call this method at any time. You can also call it again to show different snackbar messages after the snackbar was shown.
 
-If not called, default messages in English will be shown.
+```javascript
+cordova.plugins.InAppUpdate.setSnackbarOptions(successCallback, errorCallback,  snackbarText, snackbarButton, snackbarButtonColor)
+```
 
 :information_source: Browser platform does nothing and always returns **SUCCESS**
 
@@ -157,7 +171,9 @@ var snackbarButtonColor = "#76FF03";
 cordova.plugins.InAppUpdate.setSnackbarOptions(onSuccess, onFailure, snackbarText, snackbarButton, snackbarButtonColor);
 ```
 
-### Default messages when not called
+### Snackbar default values
+
+ If this method is not called, default messages in English will be shown as follows.
 
 - **snackbarText** = "An update has just been downloaded."
 - **snackbarButton** = "RESTART"
@@ -170,8 +186,27 @@ cordova.plugins.InAppUpdate.setSnackbarOptions(onSuccess, onFailure, snackbarTex
 
 # Plugin demo app
 
-Get the [In-App Update Plugin Demo app](https://www.andreszsogon.com/cordova-in-app-update-plugin-demo-app/ "In-App Update Plugin Demo app") to test the plugin in all possible scenarios. This app is available in the Store, please follow the linked  instructions to test the update flow.
+- [Compiled APK and reference](https://www.andreszsogon.com/cordova-in-app-update-plugin-demo-app/) including testing procedure instructions
+- [Latest demo app version in Play Store](https://play.google.com/store/apps/details?id=com.andreszs.inappupdate.demo)
+- [Source code for www folder](https://github.com/andreszs/cordova-plugin-demos)
+
+<img src="https://github.com/andreszs/cordova-plugin-demos/blob/main/com.andreszs.inappupdate.demo/screenshots/cordova.in_app_updates_1.jpg?raw=true" width="200" /> <img src="https://github.com/andreszs/cordova-plugin-demos/blob/main/com.andreszs.inappupdate.demo/screenshots/cordova.in_app_updates_2.jpg?raw=true" width="200" /> <img src="https://github.com/andreszs/cordova-plugin-demos/blob/main/com.andreszs.inappupdate.demo/screenshots/cordova.in_app_updates_3.jpg?raw=true" width="200" /> <img src="https://github.com/andreszs/cordova-plugin-demos/blob/main/com.andreszs.inappupdate.demo/screenshots/cordova.in_app_updates_4.jpg?raw=true" width="200" />
+
+# Changelog
+
+### 2.1.0
+
+- Optimized for android-compileSdkVersion 32
+- Minimum cordova-android version set to 11
+- Replaced com.google.android.play:core with the standalone [Play In-App Updates Library](https://developer.android.com/reference/com/google/android/play/core/release-notes-in_app_updates "Play In-App Updates Library") 2.1.0
+- Updated androidx.appcompat:appcompat to 1.5.1
+- Updated com.google.android.material:material to 1.3.0
+- Removed the `edit-config` rule that was setting `android:theme="@style/Theme.AppCompat.NoActionBar"`
+- Tested on Android 5.1, 8.1, 10.
 
-# Reporting issues
+### 2.0.5
 
-Please report any issue with this plugin in GitHub by providing detailed context and sample code.
+- Optimized for android-compileSdkVersion 30
+- Updated androidx.appcompat:appcompat to 1.3.0
+- Updated com.google.android.play:core to 1.8.0
+- Updated com.google.android.material:material to 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "cordova-plugin-in-app-updates",
-	"version": "2.0.5",
+	"version": "2.1.0",
 	"description": "In-App updates from Play Store for your Apache Cordova app.",
 	"cordova": {
 		"id": "cordova-plugin-in-app-update",
@@ -11,13 +11,17 @@
 	},
 	"engines": {
 		"cordovaDependencies": {
-			"1.0.6": {
-				"cordova": ">=9.0.0",
-				"cordova-android": ">=8.0.0"
+			"2.1.0": {
+				"cordova": ">=10.0.0",
+				"cordova-android": ">=11.0.0"
 			},
 			"2.0.5": {
 				"cordova": ">=10.0.0",
-				"cordova-android": ">=9.0.0"
+				"cordova-android": ">=10.0.0"
+			},
+			"1.0.6": {
+				"cordova": ">=9.0.0",
+				"cordova-android": ">=8.0.0"
 			}
 		}
 	},

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="cordova-plugin-in-app-updates" version="2.0.5" xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android">
+<plugin id="cordova-plugin-in-app-updates" version="2.1.0" xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android">
 	<name>InAppUpdate</name>
 	<description>In-App updates from Play Store for your Apache Cordova app.</description>
 	<license>MIT</license>
@@ -7,7 +7,7 @@
 
 	<engines>
 		<engine name="cordova" version=">=10.0.0" />
-		<engine name="cordova-android" version=">=9.0.0" />
+		<engine name="cordova-android" version=">=11.0.0" />
 	</engines>
 
 	<js-module name="InAppUpdate" src="www/InAppUpdate.js">
@@ -19,13 +19,13 @@
 			<preference name="AndroidXEnabled" value="true" />
 		</config-file>
 
-		<preference name="ANDROIDX_APPCOMPAT_VERSION" default="1.3.0" />
+		<preference name="ANDROIDX_APPCOMPAT_VERSION" default="1.5.1" />
 		<framework src="androidx.appcompat:appcompat:$ANDROIDX_APPCOMPAT_VERSION" />
+		
+		<preference name="ANDROID_PLAY_APP_UPDATE_VERSION" default="2.1.0" />
+		<framework src="com.google.android.play:app-update:$ANDROID_PLAY_APP_UPDATE_VERSION" />
 
-		<preference name="ANDROID_PLAY_CORE_VERSION" default="1.8.0" />
-		<framework src="com.google.android.play:core:$ANDROID_PLAY_CORE_VERSION" />
-
-		<preference name="ANDROID_MATERIAL_VERSION" default="1.2.0" />
+		<preference name="ANDROID_MATERIAL_VERSION" default="1.3.0" />
 		<framework src="com.google.android.material:material:$ANDROID_MATERIAL_VERSION" />
 
 		<config-file target="res/xml/config.xml" parent="/*">
@@ -33,11 +33,7 @@
 				<param name="android-package" value="com.andreszs.inappupdate.InAppUpdate" />
 			</feature>
 		</config-file>
-
-		<edit-config file="AndroidManifest.xml" target="/manifest/application/activity[@android:name='MainActivity']" mode="merge">
-			<activity android:name="MainActivity" android:theme="@style/Theme.AppCompat.NoActionBar" />
-		</edit-config>
-
+		
 		<source-file src="src/android/InAppUpdate.java" target-dir="src/com/andreszs/inappupdate" />
 	</platform>
 

package/src/android/InAppUpdate.java

@@ -19,7 +19,7 @@ import com.google.android.play.core.install.model.UpdateAvailability;
 import com.google.android.play.core.install.model.InstallStatus;
 import com.google.android.play.core.install.InstallState;
 import com.google.android.play.core.install.InstallStateUpdatedListener;
-import com.google.android.play.core.tasks.Task;
+import com.google.android.gms.tasks.Task;
 
 import org.apache.cordova.CallbackContext;
 import org.apache.cordova.CordovaInterface;