cordova.plugins.diagnostic 7.2.0 → 7.2.2

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+**v7.2.2**
+* (ios & android) feat: add isDebugBuild()
+* fix: Separate isMobileDataEnabled() for Android vs isMobileDataAuthorized() for iOS. 
+  * Resolves [#482](https://github.com/dpa99c/cordova-diagnostic-plugin/issues/482)
+
+
+**v7.2.1**
+* (android) fix logic in native resolution of single combined permission status in `getCameraAuthorizationStatus()` so it handles case where storage permissions are not requested
+
 **v7.2.0**
 * (android) feat: direct getExternalSdCardDetails without permission request
   * Merged from PR [#501](https://github.com/dpa99c/cordova-diagnostic-plugin/pull/501)

package/README.md

@@ -43,10 +43,12 @@ Cordova diagnostic plugin [![Latest Stable Version](https://img.shields.io/npm/v
     - [getCurrentBatteryLevel()](#getcurrentbatterylevel)
     - [isAirplaneModeEnabled()](#isairplanemodeenabled)
     - [isMobileDataEnabled()](#ismobiledataenabled)
+    - [isMobileDataAuthorized()](#ismobiledataauthorized)
     - [isAccessibilityModeEnabled()](#isaccessibilitymodeenabled)
     - [isTouchExplorationEnabled()](#istouchexplorationenabled)
     - [getDeviceOSVersion()](#getdeviceosversion)
     - [getBuildOSVersion()](#getbuildosversion)
+    - [isDebugBuild()](#isdebugbuild)
   - [Location module](#location-module)
     - [locationMode constants](#locationmode-constants)
     - [locationAuthorizationMode constants](#locationauthorizationmode-constants)
@@ -939,19 +941,17 @@ The function is passed a single string parameter containing the error message.
 #### Example usage
 
     cordova.plugins.diagnostic.isAirplaneModeEnabled(function(enabled){
-        console.log(`Airplane mode is currently ${enabled ? 'enabled' : 'disabled'}%`);
+        console.log(`Airplane mode is currently ${enabled ? 'enabled' : 'disabled'}`);
     });
 
-
-=======
     
 ### isMobileDataEnabled()
 
-Platforms: Android and iOS
+Platforms: Android
 
-Checks if mobile (cellular) data is currently enabled on the device.
+Checks if mobile (cellular) data is currently enabled in the device settings.
 
-On Android this requires permission `<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />`
+Requires permission `<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />`
 
 
     cordova.plugins.diagnostic.isMobileDataEnabled(successCallback, errorCallback);
@@ -967,7 +967,31 @@ The function is passed a single string parameter containing the error message.
 #### Example usage
 
     cordova.plugins.diagnostic.isMobileDataEnabled(function(enabled){
-        console.log(`Mobile data is currently ${enabled ? 'enabled' : 'disabled'}%`);
+        console.log(`Mobile data is currently ${enabled ? 'enabled' : 'disabled'}`);
+    });``
+
+### isMobileDataAuthorized()
+
+Platforms: iOS
+
+Checks if mobile data is authorized for this app.
+
+Returns true if the per-app Mobile Data setting is set to enabled (regardless of whether the device is currently connected to a cellular network)
+
+    cordova.plugins.diagnostic.isMobileDataAuthorized(successCallback, errorCallback);
+
+#### Parameters
+
+- {Function} successCallback -  The callback which will be called when operation is successful.
+  The function is passed a single boolean parameter which is TRUE if mobile data is authorized.
+- {Function} errorCallback -  The callback which will be called when operation encounters an error.
+  The function is passed a single string parameter containing the error message.
+
+
+#### Example usage
+
+    cordova.plugins.diagnostic.isMobileDataAuthorized(function(authorized){
+        console.log(`Mobile data is currently ${authorized ? 'authorized' : 'unauthorized'}`);
     });
     
 ### isAccessibilityModeEnabled()
@@ -988,7 +1012,7 @@ This callback function is passed a single boolean parameter which is TRUE if acc
 #### Example usage
 
     cordova.plugins.diagnostic.isAccessibilityModeEnabled(function(enabled){
-        console.log(`Accessibility Mode is currently ${enabled ? 'enabled' : 'disabled'}%`);
+        console.log(`Accessibility Mode is currently ${enabled ? 'enabled' : 'disabled'}`);
     });
     
 
@@ -1010,7 +1034,7 @@ This callback function is passed a single boolean parameter which is TRUE if tou
 #### Example usage
 
     cordova.plugins.diagnostic.isTouchExplorationEnabled(function(enabled){
-        console.log(`touch exploration is currently ${enabled ? 'enabled' : 'disabled'}%`);
+        console.log(`touch exploration is currently ${enabled ? 'enabled' : 'disabled'}`);
     });
     
 
@@ -1037,9 +1061,9 @@ The function is passed a single string parameter containing the error message.
 #### Example usage
 
     cordova.plugins.diagnostic.getDeviceOSVersion(function(details){
-        console.log(`Version: ${details.version}%`); // "13.0"
-        console.log(`API level: ${details.apiLevel}%`); // 33
-        console.log(`API name: ${details.apiName}%`); // "TIRAMISU"
+        console.log(`Version: ${details.version}`); // "13.0"
+        console.log(`API level: ${details.apiLevel}`); // 33
+        console.log(`API name: ${details.apiName}`); // "TIRAMISU"
     });
 
 ### getBuildOSVersion()
@@ -1066,13 +1090,32 @@ The function is passed a single string parameter containing the error message.
 #### Example usage
 
     cordova.plugins.diagnostic.getBuildOSVersion(function(details){
-        console.log(`Target API level: ${details.targetApiLevel}%`); // 33
-        console.log(`Target API name: ${details.targetApiLevel}%`); // "TIRAMISU"
-        console.log(`Minimum API level: ${details.targetApiLevel}%`); // 21
-        console.log(`Target API name: ${details.targetApiLevel}%`); // "LOLLIPOP"
+        console.log(`Target API level: ${details.targetApiLevel}`); // 33
+        console.log(`Target API name: ${details.targetApiLevel}`); // "TIRAMISU"
+        console.log(`Minimum API level: ${details.targetApiLevel}`); // 21
+        console.log(`Target API name: ${details.targetApiLevel}`); // "LOLLIPOP"
     });
 
+### isDebugBuild()
+
+Platforms: Android & iOS
+
+Checks if currently running app build is a debug build.
+
+    cordova.plugins.diagnostic.isDebugBuild(successCallback, errorCallback);
+
+#### Parameters
+
+- {Function} successCallback -  The callback which will be called when the operation is successful.
+  This callback function is passed a single boolean parameter which is TRUE if touch exploration (in accessibility mode) is enabled.
+- {Function} errorCallback -  The callback which will be called when the operation encounters an error.
+  This callback function is passed a single string parameter containing the error message.
 
+#### Example usage
+
+    cordova.plugins.diagnostic.isDebugBuild(function(isDebug){
+        console.log(`current app build type is: ${isDebug ? 'debug' : 'release'}`);
+    });
 
 ## Location module
 
@@ -1625,7 +1668,7 @@ The function is passed a single string parameter containing the error message.
 #### Example usage
 
     cordova.plugins.diagnostic.getLocationAccuracyAuthorization(function(accuracy){
-       switch(status){
+       switch(accuracy){
            case cordova.plugins.diagnostic.locationAccuracyAuthorization.FULL:
                console.log("Full location accuracy is authorized");
                break;

package/cordova.plugins.diagnostic.d.ts

@@ -305,6 +305,17 @@ interface Diagnostic {
         successCallback: () => void
     ) => void;
 
+    /**
+     * Returns true if the current build is a debug build.
+     * @param successCallback
+     * @param errorCallback
+     */
+    isDebugBuild?: (
+        successCallback: (enabled: boolean) => void,
+        errorCallback: (error: string) => void
+    ) => void;
+
+
 
     /**
      * ANDROID ONLY
@@ -332,6 +343,19 @@ interface Diagnostic {
         errorCallback: (error: string) => void
     ) => void;
 
+    /**
+     * IOS ONLY
+     *
+     * Checks if mobile data is authorized for this app.
+     *
+     * @param successCallback
+     * @param errorCallback
+     */
+    isMobileDataAuthorized?: (
+        successCallback: () => boolean,
+        errorCallback: (error: string) => void
+    ) => void;
+
     /**
      *
      * Checks if accessibility mode is enabled on device.

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "7.2.0",
+    "version": "7.2.2",
     "name": "cordova.plugins.diagnostic",
     "cordova_name": "Diagnostic",
     "description": "Cordova/Phonegap plugin to check the state of Location/WiFi/Camera/Bluetooth device settings.",

package/plugin.xml

@@ -2,7 +2,7 @@
 <plugin xmlns="http://www.phonegap.com/ns/plugins/1.0"
     xmlns:android="http://schemas.android.com/apk/res/android"
     id="cordova.plugins.diagnostic"
-    version="7.2.0">
+    version="7.2.2">
 
     <name>Diagnostic</name>
     <description>Cordova/Phonegap plugin to check the state of Location/WiFi/Camera/Bluetooth device settings.</description>

package/src/android/Diagnostic.java

@@ -64,6 +64,8 @@ import android.view.accessibility.AccessibilityManager;
 
 import androidx.core.app.ActivityCompat;
 
+import cordova.plugins.diagnostic.example.BuildConfig;
+
 /**
  * Diagnostic plugin implementation for Android
  */
@@ -354,6 +356,8 @@ public class Diagnostic extends CordovaPlugin{
                 callbackContext.success(getDeviceOSVersion());
             } else if(action.equals("getBuildOSVersion")) {
                 callbackContext.success(getBuildOSVersion());
+            } else if(action.equals("isDebugBuild")) {
+                callbackContext.success(isDebugBuild() ? 1 : 0);
             } else {
                 handleError("Invalid action");
                 return false;
@@ -542,6 +546,12 @@ public class Diagnostic extends CordovaPlugin{
         return result;
     }
 
+    private boolean isDebugBuild() {
+        boolean result = BuildConfig.DEBUG;
+        logDebug("Debug build: " + result);
+        return result;
+    }
+
     /************
      * Internals
      ***********/

package/src/android/Diagnostic_Camera.java

@@ -179,47 +179,75 @@ public class Diagnostic_Camera extends CordovaPlugin{
         String[] permissions = getPermissions(storage);
         JSONObject statuses = Diagnostic.instance._getPermissionsAuthorizationStatus(permissions);
 
-        String status;
-        if (
-                Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU &&
-                        (
-                                getStatusForPermission(statuses, "READ_MEDIA_IMAGES").equals("GRANTED") ||
-                                        getStatusForPermission(statuses, "READ_MEDIA_VIDEO").equals("GRANTED")
-                        )
-        ) {
-            // Full access on Android 13 (API level 33) or higher
-            status = "GRANTED";
-        } else if (
-                Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE &&
-                getStatusForPermission(statuses, "READ_MEDIA_VISUAL_USER_SELECTED").equals("GRANTED")
-        ) {
-            // Partial access on Android 14 (API level 34) or higher
-            status = "LIMITED";
-        }  else if (
-                getStatusForPermission(statuses, "READ_EXTERNAL_STORAGE").equals("GRANTED")
-        ) {
-            // Full access up to Android 12 (API level 32)
-            status = "GRANTED";
-        } else {
-            // Access denied or not requested
-
-            // if any permission is not requested, return NOT_REQUESTED
-            if (getStatusForPermission(statuses, "CAMERA").equals("NOT_REQUESTED") ||
-                    getStatusForPermission(statuses, "READ_EXTERNAL_STORAGE").equals("NOT_REQUESTED") ||
-                    getStatusForPermission(statuses, "WRITE_EXTERNAL_STORAGE").equals("NOT_REQUESTED") ||
-                    getStatusForPermission(statuses, "READ_MEDIA_IMAGES").equals("NOT_REQUESTED") ||
-                    getStatusForPermission(statuses, "READ_MEDIA_VIDEO").equals("NOT_REQUESTED") ||
-                    getStatusForPermission(statuses, "READ_MEDIA_VISUAL_USER_SELECTED").equals("NOT_REQUESTED")
+        String cameraStatus = getStatusForPermission(statuses, cameraPermission);
+
+        String storageStatus = "DENIED";
+        if(storage) {
+            if (
+                    Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU &&
+                            (
+                                    getStatusForPermission(statuses, "READ_MEDIA_IMAGES").equals("GRANTED") ||
+                                            getStatusForPermission(statuses, "READ_MEDIA_VIDEO").equals("GRANTED")
+                            )
+            ) {
+                // Full access on Android 13 (API level 33) or higher
+                storageStatus = "GRANTED";
+            } else if (
+                    Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE &&
+                            getStatusForPermission(statuses, "READ_MEDIA_VISUAL_USER_SELECTED").equals("GRANTED")
             ) {
-                status = "NOT_REQUESTED";
+                // Partial access on Android 14 (API level 34) or higher
+                storageStatus = "LIMITED";
+            } else if (
+                    getStatusForPermission(statuses, "READ_EXTERNAL_STORAGE").equals("GRANTED")
+            ) {
+                // Full access up to Android 12 (API level 32)
+                storageStatus = "GRANTED";
             } else {
-                status = "DENIED";
+                // Combination of statuses for all storage permissions for relevant API level
+                storageStatus = combinePermissionStatuses(statuses);
             }
         }
+        String status = cameraStatus;
+        if(storage){
+            status = combinePermissionStatuses(new String[]{cameraStatus, storageStatus});
+        }
+
         callbackContext.success(status);
     }
 
     private String getStatusForPermission(JSONObject statuses, String permissionName) throws JSONException {
         return statuses.has(permissionName) ? statuses.getString(permissionName) : "DENIED";
     }
+
+    private boolean anyStatusIs(String status, String[] statuses){
+        for(String s : statuses){
+            if(s.equals(status)){
+                return true;
+            }
+        }
+        return false;
+    }
+
+    private String combinePermissionStatuses(JSONObject permissionsStatuses) throws JSONException {
+        String[] statuses = new String[storagePermissions.length];
+        for(int i = 0; i < storagePermissions.length; i++){
+            statuses[i] = getStatusForPermission(permissionsStatuses, storagePermissions[i]);
+        }
+        return combinePermissionStatuses(statuses);
+    }
+
+    private String combinePermissionStatuses(String[] statuses){
+        if(anyStatusIs("DENIED_ALWAYS", statuses)){
+            return "DENIED_ALWAYS";
+        }else if(anyStatusIs("LIMITED", statuses)){
+            return "LIMITED";
+        }else if(anyStatusIs("DENIED", statuses)){
+            return "DENIED";
+        }else if(anyStatusIs("GRANTED", statuses)){
+            return "GRANTED";
+        }else{
+            return "NOT_REQUESTED";
+        }
+    }
 }

package/src/ios/Diagnostic.h

@@ -37,8 +37,9 @@ extern NSString*const AUTHORIZATION_LIMITED;
 - (void) getCurrentBatteryLevel: (CDVInvokedUrlCommand*)command;
 - (void) getDeviceOSVersion: (CDVInvokedUrlCommand*)command;
 - (void) getBuildOSVersion: (CDVInvokedUrlCommand*)command;
-- (void) isMobileDataEnabled: (CDVInvokedUrlCommand*)command;
+- (void) isMobileDataAuthorized: (CDVInvokedUrlCommand*)command;
 - (void) isAccessibilityModeEnabled: (CDVInvokedUrlCommand*)command;
+- (void) isDebugBuild: (CDVInvokedUrlCommand*)command;
 
 // Utilities
 + (id) getInstance;

package/src/ios/Diagnostic.m

@@ -227,7 +227,7 @@ static CTCellularData* cellularData;
     }];
 }
 
-- (void) isMobileDataEnabled: (CDVInvokedUrlCommand*)command
+- (void) isMobileDataAuthorized: (CDVInvokedUrlCommand*)command
 {
     [self.commandDelegate runInBackground:^{
         @try {
@@ -259,6 +259,22 @@ static CTCellularData* cellularData;
     }];
 }
 
+- (void) isDebugBuild: (CDVInvokedUrlCommand*)command
+{
+    [self.commandDelegate runInBackground:^{
+        @try {
+            bool result = false;
+            #ifdef DEBUG
+                result = true;
+            #endif
+            [diagnostic sendPluginResultBool:result :command];
+        }
+        @catch (NSException *exception) {
+            [diagnostic handlePluginException:exception :command];
+        }
+    }];
+}
+
 /********************************/
 #pragma mark - Send results
 /********************************/

package/www/android/diagnostic.js

@@ -499,7 +499,7 @@ var Diagnostic = (function(){
     };
 
     /**
-     * Checks if mobile data is enabled on device.
+     * Checks if mobile data is enabled in device settings.
      *
      * @param {Function} successCallback -  The callback which will be called when the operation is successful.
      * This callback function is passed a single boolean parameter which is TRUE if mobile data is enabled.
@@ -1560,6 +1560,22 @@ var Diagnostic = (function(){
         }
     };
 
+    /**
+     * Checks if the current app build is a debug build.
+     *
+     * @param {Function} successCallback -  The callback which will be called when the operation is successful.
+     * This callback function is passed a single boolean parameter which is TRUE if the app is a debug build.
+     * @param {Function} errorCallback -  The callback which will be called when the operation encounters an error.
+     *  This callback function is passed a single string parameter containing the error message.
+     */
+    Diagnostic.isDebugBuild = function(successCallback, errorCallback) {
+        return cordova.exec(Diagnostic._ensureBoolean(successCallback),
+            errorCallback,
+            'Diagnostic',
+            'isDebugBuild',
+            []);
+    };
+
 
     return Diagnostic;
 });

package/www/ios/diagnostic.js

@@ -154,18 +154,19 @@ var Diagnostic = (function(){
     };
 
     /**
-     * Checks if mobile data is enabled on device.
+     * Checks if mobile data is authorized for this app.
+     * Returns true if the per-app Mobile Data setting is set to enabled (regardless of whether the device is currently connected to a cellular network)
      *
      * @param {Function} successCallback -  The callback which will be called when the operation is successful.
      * This callback function is passed a single boolean parameter which is TRUE if mobile data is enabled.
      * @param {Function} errorCallback -  The callback which will be called when the operation encounters an error.
      *  This callback function is passed a single string parameter containing the error message.
      */
-    Diagnostic.isMobileDataEnabled = function(successCallback, errorCallback) {
+    Diagnostic.isMobileDataAuthorized = function(successCallback, errorCallback) {
         return cordova.exec(Diagnostic._ensureBoolean(successCallback),
             errorCallback,
             'Diagnostic',
-            'isMobileDataEnabled',
+            'isMobileDataAuthorized',
             []);
     };
 
@@ -225,6 +226,22 @@ var Diagnostic = (function(){
             []);
     };
 
+    /**
+     * Checks if the current app build is a debug build.
+     *
+     * @param {Function} successCallback -  The callback which will be called when the operation is successful.
+     * This callback function is passed a single boolean parameter which is TRUE if the app is a debug build.
+     * @param {Function} errorCallback -  The callback which will be called when the operation encounters an error.
+     *  This callback function is passed a single string parameter containing the error message.
+     */
+    Diagnostic.isDebugBuild = function(successCallback, errorCallback) {
+        return cordova.exec(Diagnostic._ensureBoolean(successCallback),
+            errorCallback,
+            'Diagnostic',
+            'isDebugBuild',
+            []);
+    };
+
     /************
      * Location *
      ************/
@@ -1125,6 +1142,8 @@ var Diagnostic = (function(){
         }
     };
 
+
+
     return Diagnostic;
 })();
 module.exports = Diagnostic;