cordova-plugin-in-app-updates 2.2.0 → 2.3.0

package/.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ["https://www.paypal.com/ncp/payment/GEEM324PDD9NC"]

package/README.md

@@ -2,9 +2,24 @@
 
 # cordova-plugin-in-app-updates
 
-Cordova Android plugin for checking for updates and auto updating app with Google Play Store In-App updates API.
-
-# Platforms
+Cordova Android plugin for checking for updates and auto updating app with Google Play Store In-App updates API.
+
+## Table of contents
+
+- [Platforms](#platforms)
+- [Features](#features)
+- [Installation](#installation)
+  - [Plugin versions](#plugin-versions)
+- [Methods](#methods)
+  - [`getUpdateAvailability()`](#getupdateavailability)
+  - [`updateFlexible()`](#updateflexible)
+  - [`updateImmediate()`](#updateimmediate)
+  - [`setSnackbarOptions()`](#setsnackbaroptions)
+- [Plugin demo app](#plugin-demo-app)
+- [Contribute](#contribute)
+- [Changelog](#changelog)
+
+# Platforms
 
 - Android
 - Browser (filler platform)
@@ -15,8 +30,8 @@ Cordova Android plugin for checking for updates and auto updating app with Googl
 - Check for updates
 - Install flexible updates
 - Install immediate updates
-- Customize snackbar message and button for Flexible updates
-- Customize snackbar button color for Flexible updates
+- Customize the completion dialog message and button for flexible updates
+- Customize the completion dialog button color for flexible updates
 
 # Installation
 
@@ -28,6 +43,7 @@ Cordova Android plugin for checking for updates and auto updating app with Googl
 | 2.0.5 | 10.0.0 | 9.0.0 | Yes | 30/31 |
 | 2.1.0 | 10.0.0 | 11.0.0 | Yes | 32 |
 | 2.2.0 | 10.0.0 | 12.0.0 | Yes | 33 |
+| 2.3.0 | 10.0.0 | 11.0.0 or later | Yes | 32 or later |
 
 ### Install latest version from NPM
 
@@ -94,7 +110,7 @@ cordova.plugins.InAppUpdate.updateFlexible(successCallback, errorCallback)
 - **RESULT_IN_APP_UPDATE_FAILED**: Something went wrong with the update dialog response.
 - **ACTIVITY_RESULT_UNKNOWN**: Unknown result code returned by the dialog.
 - **DOWNLOADING**: An update is currently being downloaded in the background.
-- **DOWNLOADED**: The update was downloaded and the snackbar with RESTART button has been shown.
+- **DOWNLOADED**: The update was downloaded and the native completion dialog has been shown. Pressing its configured button calls `completeUpdate()`.
 
 :information_source: Browser platform does nothing and always returns **UPDATE_NOT_AVAILABLE**
 
@@ -149,10 +165,12 @@ cordova.plugins.InAppUpdate.updateImmediate(onSuccess, onFailure);
 
 ## setSnackbarOptions
 
-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.
+Configures the message, button text, and button color for the completion prompt shown after downloading a flexible update. Since version 2.3.0, this prompt is a native, non-cancelable Android `AlertDialog` instead of a Material Snackbar.
+
+The public method name `setSnackbarOptions()` is preserved for compatibility with existing applications. Its arguments now configure the completion dialog. You may call it at any time, including again after a previous completion prompt was shown.
 
 ```javascript
-cordova.plugins.InAppUpdate.setSnackbarOptions(successCallback, errorCallback,  snackbarText, snackbarButton, snackbarButtonColor)
+cordova.plugins.InAppUpdate.setSnackbarOptions(successCallback, errorCallback, completionText, completionButton, completionButtonColor)
 ```
 
 :information_source: Browser platform does nothing and always returns **SUCCESS**
@@ -166,19 +184,19 @@ var onSuccess = function (strSuccess) {
 var onFailure = function (strError) {
     console.warn(strError);
 };
-var snackbarText = "An update has just been downloaded.";
-var snackbarButton = "RESTART";
-var snackbarButtonColor = "#76FF03";
-cordova.plugins.InAppUpdate.setSnackbarOptions(onSuccess, onFailure, snackbarText, snackbarButton, snackbarButtonColor);
+var completionText = "An update has just been downloaded.";
+var completionButton = "RESTART";
+var completionButtonColor = "#76FF03";
+cordova.plugins.InAppUpdate.setSnackbarOptions(onSuccess, onFailure, completionText, completionButton, completionButtonColor);
 ```
 
-### Snackbar default values
+### Completion dialog 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"
-- **snackbarText** = "#76FF03"
+- **completionText** = "An update has just been downloaded."
+- **completionButton** = "RESTART"
+- **completionButtonColor** = "#76FF03"
 
 ### Return values
 
@@ -187,13 +205,38 @@ cordova.plugins.InAppUpdate.setSnackbarOptions(onSuccess, onFailure, snackbarTex
 
 # Plugin demo app
 
-- [Compiled APK and reference](https://www.andreszsogon.com/cordova-in-app-update-plugin-demo-app/) including testing procedure instructions
+- [Plugin documentation wiki](https://github.com/andreszs/cordova-plugin-in-app-updates/wiki) with the current demo walkthrough, testing procedures, JavaScript usage, and troubleshooting
 - [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
+The screenshots below show an end-to-end flexible update using plugin 2.3.0. Version 1.4.1 of the demo was installed from Google Play, version 1.4.2 was offered as an update, and accepting the native completion dialog installed and relaunched the updated app.
+
+| Demo and configuration | Update availability | Google Play flexible prompt |
+| --- | --- | --- |
+| <img src="assets/screenshots/cordova.in_app_updates_7_main_2.3.0.png" width="200" alt="In-App Update demo using plugin 2.3.0" /> | <img src="assets/screenshots/cordova.in_app_updates_10_update_available_2.3.0.png" width="200" alt="UPDATE_AVAILABLE result" /> | <img src="assets/screenshots/cordova.in_app_updates_11_flexible_prompt_2.3.0.png" width="200" alt="Google Play flexible update prompt" /> |
+| Completion dialog options | Native completion dialog | Updated demo app |
+| <img src="assets/screenshots/cordova.in_app_updates_8_completion_options_2.3.0.png" width="200" alt="Completion dialog options configured through setSnackbarOptions" /> | <img src="assets/screenshots/cordova.in_app_updates_13_native_completion_dialog_2.3.0.png" width="200" alt="Native non-cancelable completion AlertDialog" /> | <img src="assets/screenshots/cordova.in_app_updates_14_updated_1.4.2_plugin_2.3.0.png" width="200" alt="Demo updated to version 1.4.2 using plugin 2.3.0" /> |
+
+The legacy `setSnackbarOptions()` method configures the message, button text, and button color shown in the native completion dialog. Pressing the configured button calls `completeUpdate()`.
+
+# Contribute
+
+Contributions are always welcome! If you find a bug or have an improvement in mind, please [open an issue](https://github.com/andreszs/cordova-plugin-in-app-updates/issues) or [submit a pull request](https://github.com/andreszs/cordova-plugin-in-app-updates/pulls). Every bit of feedback helps keep the plugin useful and reliable.
+
+💙 If this plugin saves you time, you can also support its continued development and maintenance through PayPal.
+
+[Support the project via PayPal](https://www.paypal.com/ncp/payment/GEEM324PDD9NC)
+
+⭐ If financial support is not an option, [star this repository](https://github.com/andreszs/cordova-plugin-in-app-updates) or share it with other Cordova developers—both make a difference.
+
+# Changelog
+
+### 2.3.0
+
+- Replaced the Material Snackbar used after a flexible update download with a native Android `AlertDialog`.
+- Removed the explicit Material Components and AppCompat dependencies.
+- Preserved the existing JavaScript `setSnackbarOptions()` API; its values now configure the completion dialog.
+- Restored compatibility with cordova-android 11 or later.
 
 ### 2.2.0
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "cordova-plugin-in-app-updates",
-	"version": "2.2.0",
+	"version": "2.3.0",
 	"description": "In-App updates from Play Store for your Apache Cordova app.",
 	"cordova": {
 		"id": "cordova-plugin-in-app-update",
@@ -11,6 +11,10 @@
 	},
 	"engines": {
 		"cordovaDependencies": {
+			"2.3.0": {
+				"cordova": ">=10.0.0",
+				"cordova-android": ">=11.0.0"
+			},
 			"2.2.0": {
 				"cordova": ">=10.0.0",
 				"cordova-android": ">=12.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.2.0" 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.3.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=">=12.0.0" />
+		<engine name="cordova-android" version=">=11.0.0" />
 	</engines>
 
 	<js-module name="InAppUpdate" src="www/InAppUpdate.js">
@@ -19,15 +19,9 @@
 			<preference name="AndroidXEnabled" value="true" />
 		</config-file>
 
-		<preference name="ANDROIDX_APPCOMPAT_VERSION" default="1.6.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_MATERIAL_VERSION" default="1.8.0" />
-		<framework src="com.google.android.material:material:$ANDROID_MATERIAL_VERSION" />
-
 		<config-file target="res/xml/config.xml" parent="/*">
 			<feature name="InAppUpdate">
 				<param name="android-package" value="com.andreszs.inappupdate.InAppUpdate" />
@@ -47,4 +41,4 @@
 			<runs />
 		</js-module>
 	</platform>
-</plugin>
+</plugin>

package/src/android/InAppUpdate.java

@@ -1,14 +1,10 @@
 package com.andreszs.inappupdate;
 
 import android.app.Activity;
+import android.app.AlertDialog;
 import android.content.Intent;
-import android.content.IntentSender;
 import android.graphics.Color;
-import com.google.android.material.snackbar.Snackbar;
 import android.util.Log;
-import android.view.View;
-import android.widget.FrameLayout;
-import android.widget.TextView;
 
 import com.google.android.play.core.appupdate.AppUpdateInfo;
 import com.google.android.play.core.appupdate.AppUpdateManager;
@@ -22,9 +18,7 @@ import com.google.android.play.core.install.InstallStateUpdatedListener;
 import com.google.android.gms.tasks.Task;
 
 import org.apache.cordova.CallbackContext;
-import org.apache.cordova.CordovaInterface;
 import org.apache.cordova.CordovaPlugin;
-import org.apache.cordova.CordovaWebView;
 import org.apache.cordova.PluginResult;
 
 import org.json.JSONArray;
@@ -38,35 +32,26 @@ import static com.google.android.play.core.install.model.ActivityResult.RESULT_I
 public class InAppUpdate extends CordovaPlugin {
 
 	private static String LOG_TAG;
-	private static boolean PROMPTED = false;
 	private static int currentUpdateType;
 	private static AppUpdateManager appUpdateManager;
 
 	private final int activityResultRequestCode = 777;
 	private CordovaPlugin activityResultCallback;
-	private FrameLayout layout;
-	private Snackbar snackbar;
+	private AlertDialog completionDialog;
 	private CallbackContext callbackContext;
 
-	private String snackbarText = "An update has just been downloaded.";
-	private String snackbarButton = "RESTART";
-	private String snackbarButtonColor = "#76FF03";
+	private String completionPromptText = "An update has just been downloaded.";
+	private String completionPromptButton = "RESTART";
+	private String completionPromptButtonColor = "#76FF03";
 
 	public InAppUpdate() {
 		this.LOG_TAG = InAppUpdate.class.getSimpleName();
 		Log.i(LOG_TAG, "Constructed");
 	}
 
-	@Override
-	public void initialize(CordovaInterface cordova, CordovaWebView webView) {
-		super.initialize(cordova, webView);
-		layout = (FrameLayout) webView.getView().getParent();
-	}
-
 	@Override
 	public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
 		this.callbackContext = callbackContext;
-		this.PROMPTED = false;
 
 		Log.i(LOG_TAG, String.format("Executing the %s action started", action));
 		if (action.equals("getUpdateAvailability")) {
@@ -144,24 +129,52 @@ public class InAppUpdate extends CordovaPlugin {
 		this.activityResultCallback = plugin;
 	}
 
-	private void popupSnackbarForCompleteUpdate() {
-		Log.i(LOG_TAG, "popupSnackbarForCompleteUpdate");
-		this.PROMPTED = true;
+	private void showCompletionDialog() {
+		Log.i(LOG_TAG, "showCompletionDialog");
 
-		cordova.getActivity().runOnUiThread(new Runnable() {
+		final Activity activity = cordova.getActivity();
+		if (activity == null) {
+			Log.w(LOG_TAG, "Unable to show completion dialog because the activity is unavailable");
+			return;
+		}
+
+		activity.runOnUiThread(new Runnable() {
 			public void run() {
 				try {
-					snackbar = Snackbar.make(layout, snackbarText, Snackbar.LENGTH_INDEFINITE);
-					snackbar.setAction(snackbarButton, new View.OnClickListener() {
-						public void onClick(View view) {
-							appUpdateManager.completeUpdate();
+					if (completionDialog != null) {
+						Log.i(LOG_TAG, "Completion dialog is already being shown");
+						return;
+					}
+
+					if (activity.isFinishing() || activity.isDestroyed()) {
+						Log.w(LOG_TAG, "Unable to show completion dialog because the activity is unavailable");
+						return;
+					}
+
+					final AlertDialog dialog = new AlertDialog.Builder(activity)
+						.setMessage(completionPromptText)
+						.setCancelable(false)
+						.setPositiveButton(completionPromptButton, (dialogInterface, which) -> {
+							if (appUpdateManager != null) {
+								appUpdateManager.completeUpdate();
+							}
+						})
+						.create();
+
+					dialog.setCanceledOnTouchOutside(false);
+					dialog.setOnShowListener(dialogInterface -> dialog.getButton(AlertDialog.BUTTON_POSITIVE)
+						.setTextColor(Color.parseColor(completionPromptButtonColor)));
+					dialog.setOnDismissListener(dialogInterface -> {
+						if (completionDialog == dialog) {
+							completionDialog = null;
 						}
 					});
-					snackbar.setActionTextColor(Color.parseColor(snackbarButtonColor));
-					snackbar.show();
+					completionDialog = dialog;
+					dialog.show();
 				} catch (Exception e) {
 					e.printStackTrace();
 					Log.e(LOG_TAG, e.getMessage());
+					completionDialog = null;
 				}
 			}
 		});
@@ -176,11 +189,11 @@ public class InAppUpdate extends CordovaPlugin {
 		try {
 
 			JSONObject arg_object = args.getJSONObject(0);
-			this.snackbarText = arg_object.getString("strText");
-			this.snackbarButton = arg_object.getString("strButton");
+			this.completionPromptText = arg_object.getString("strText");
+			this.completionPromptButton = arg_object.getString("strButton");
 			String colorHex = arg_object.getString("strButtonColor");
-			if (colorHex != null && colorHex.length() == 7) {
-				this.snackbarButtonColor = colorHex;
+			if (colorHex != null && colorHex.length() == 7 && isValidColor(colorHex)) {
+				this.completionPromptButtonColor = colorHex;
 				result = new PluginResult(PluginResult.Status.OK, "SUCCESS");
 			} else {
 				result = new PluginResult(PluginResult.Status.OK, "SUCCESS (Invalid HEX color specified; ignored)");
@@ -197,6 +210,15 @@ public class InAppUpdate extends CordovaPlugin {
 
 	}
 
+	private boolean isValidColor(String colorHex) {
+		try {
+			Color.parseColor(colorHex);
+			return true;
+		} catch (IllegalArgumentException e) {
+			return false;
+		}
+	}
+
 	private void updateFlexible() {
 
 		currentUpdateType = AppUpdateType.FLEXIBLE;
@@ -225,12 +247,9 @@ public class InAppUpdate extends CordovaPlugin {
 							// Unregister listener
 							appUpdateManager.unregisterListener(installStateUpdatedListener);
 
-							// Prevent multiple consecutive prompts of this event
-							if (!PROMPTED) {
-								popupSnackbarForCompleteUpdate();
-								PluginResult result = new PluginResult(PluginResult.Status.OK, "DOWNLOADED");
-								callbackContext.sendPluginResult(result);
-							}
+							showCompletionDialog();
+							PluginResult result = new PluginResult(PluginResult.Status.OK, "DOWNLOADED");
+							callbackContext.sendPluginResult(result);
 						} else if (state.installStatus() == InstallStatus.INSTALLED) {
 							// Update installed.
 							Log.i(LOG_TAG, "InstallStateUpdatedListener: InstallStatus.INSTALLED");
@@ -265,7 +284,7 @@ public class InAppUpdate extends CordovaPlugin {
 						// When status updates are no longer needed, unregister the listener.
 						appUpdateManager.unregisterListener(installStateUpdatedListener);
 
-						popupSnackbarForCompleteUpdate();
+						showCompletionDialog();
 						PluginResult result = new PluginResult(PluginResult.Status.OK, "DOWNLOADED");
 						callbackContext.sendPluginResult(result);
 
@@ -435,8 +454,8 @@ public class InAppUpdate extends CordovaPlugin {
 			if (appUpdateInfo.installStatus() == InstallStatus.DOWNLOADED) {
 				// If the update is downloaded but not installed, notify the user to complete the update.
 				if (currentUpdateType == AppUpdateType.FLEXIBLE) {
-					Log.i(LOG_TAG, "onResume: popupSnackbarForCompleteUpdate");
-					popupSnackbarForCompleteUpdate();
+					Log.i(LOG_TAG, "onResume: showCompletionDialog");
+					showCompletionDialog();
 				} else {
 					Log.i(LOG_TAG, "onResume: startUpdate");
 					try {
@@ -472,4 +491,14 @@ public class InAppUpdate extends CordovaPlugin {
 
 	}
 
+	@Override
+	public void onDestroy() {
+		if (completionDialog != null) {
+			completionDialog.setOnDismissListener(null);
+			completionDialog.dismiss();
+			completionDialog = null;
+		}
+		super.onDestroy();
+	}
+
 }

package/nbproject/project.properties

@@ -1,4 +0,0 @@
-file.reference.cordova-plugin-in-app-update-www=www
-files.encoding=UTF-8
-site.root.folder=${file.reference.cordova-plugin-in-app-update-www}
-source.folder=

package/nbproject/project.xml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://www.netbeans.org/ns/project/1">
-    <type>org.netbeans.modules.web.clientproject</type>
-    <configuration>
-        <data xmlns="http://www.netbeans.org/ns/clientside-project/1">
-            <name>cordova-plugin-in-app-update</name>
-        </data>
-    </configuration>
-</project>