Merge pull request #5 from mfdeveloper/android-exception-catch

mfdeveloper · web-flow · commit d4078a1079ad · 2018-02-28T16:16:53.000-03:00
[Android] Return exception details + Promise support
diff --git a/README.md b/README.md
@@ -61,6 +61,18 @@ Until here, this plugin is not registered on cloud. In future, this plugin will
 
 * Or create a `.jar` or a `.aar` that contains this class, and import like a [Android module dependency](https://developer.android.com/studio/projects/android-library.html#AddDependency)
 
+* Verify if the code snippet below is present in your `AndroidManifest.xml`. This is required to open a specific Activity from a [Intent](https://developer.android.com/reference/android/content/Intent.html) (using **[package + activityName]**)
+
+```xml
+<activity android:name=".MyActivity" >
+    <intent-filter>
+        <action android:name="com.mypackage.MyActivity" />
+        <category android:name="android.intent.category.DEFAULT" />
+    </intent-filter>
+</activity>
+```
+> If this filter not exists in `AndroidManifest.xml`, you will get this error: [No Activity found to handle Intent splash screen](https://stackoverflow.com/questions/15614561/android-content-activitynotfoundexception-no-activity-found-to-handle-intent-sp)
+
 * Build/Run your android project!
 
 ## Supported Platforms
@@ -79,8 +91,25 @@ Shows a native view.
 
 ```js
 
-//  pass a package name and a activity by params
-window.NativeView.show('com.mycompany', 'MyActivity');
+document.addEventListener("deviceready", function() {
+    //  pass a package name and a activity by params
+    cordova.plugins.NativeView.show('com.mycompany', 'MyActivity')
+    .then(function() {
+      
+      /**
+       * Do something when open the activity.
+       * This code here will be executed in paralell,
+       * not after open.
+       */
+    }).catch(function(error) {
+        
+        /**
+         * error.success => Will be "false"
+         * error.name => Exception type from the captured error 
+         * error.message => A exception message
+         */
+    });
+}, false);
 
 ```
 **IOS**
@@ -91,15 +120,43 @@ window.NativeView.show('com.mycompany', 'MyActivity');
 *  Optionally, pass a storyboard name that contains
 *  an UIViewController
 */
-window.NativeView.show('MyStoryboard', 'MyUIViewController');
-
-/*
-*  Or, pass only the UIViewController name, if you don't
-*  use storyboards in your project.
-*/
-window.NativeView.show('MyUIViewController');
+document.addEventListener("deviceready", function() {
+    cordova.plugins.NativeView.show('MyStoryboard', 'MyUIViewController')
+    .then(function() {
+      
+      /**
+       * Do something when open the activity.
+       * This code here will be executed in paralell,
+       * not after open.
+       */
+    });
+
+    /*
+     *  Or, pass only the UIViewController name, if you don't
+     *  use storyboards in your project.
+     */
+     cordova.plugins.NativeView.show('MyUIViewController');
+
+     /*
+     * Or just call the "show()" method without params.
+     * This plugin will check whether exists a *"NavigationController" 
+     * in your project, and execute
+     * "[popViewControllerAnimated: Yes]" method. Else, will be throw a
+     * exception
+     * 
+     */
+     cordova.plugins.NativeView.show();
+
+}, false);
 ```
 
+**IONIC**
+
+Replace `document.addEventListener` event to `this.platform.ready().then(...)` service method. See [IONIC Platform documentation](https://ionicframework.com/docs/api/platform/Platform/)
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+
+## TODO
+
+- Better catch IOS exception from JS
diff --git a/cordova-plugin-nativeview.podspec b/cordova-plugin-nativeview.podspec
@@ -135,6 +135,6 @@ Pod::Spec.new do |s|
 
   # s.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
   # s.dependency "JSONKit", "~> 1.4"
-  s.dependency "Cordova", "~> 4.4.0"
+  s.dependency "Cordova", ">= 4.4.0"
 
 end
diff --git a/jsconfig.json b/jsconfig.json
@@ -3,7 +3,10 @@
     /* Basic Options */
     "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation:  */
+    "lib": [                                  /* Specify library files to be included in the compilation:  */
+      "dom",
+      "es2015"
+    ],                             
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
@@ -19,7 +22,7 @@
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
     /* Strict Type-Checking Options */
-    "strict": true                            /* Enable all strict type-checking options. */
+    "strict": true,                           /* Enable all strict type-checking options. */
     // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
     // "strictNullChecks": true,              /* Enable strict null checks. */
     // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
@@ -37,7 +40,7 @@
     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "types": []                            /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
 
     /* Source Map Options */
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-nativeview",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "types": "./types/index.d.ts",
   "description": "Start or Back to a native screen/page",
   "author": {
@@ -14,6 +14,9 @@
       "ios"
     ]
   },
+  "engines": {
+    "cordova": ">=3.0.0"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/mfdeveloper/cordova-plugin-nativeview"
diff --git a/plugin.xml b/plugin.xml
@@ -13,9 +13,15 @@
     <repo>https://github.com/mfdeveloper/cordova-plugin-nativeview.git</repo>
     <issue>https://github.com/mfdeveloper/cordova-plugin-nativeview/issues</issue>
 
-    <js-module src="www/plugin.js" name="NativeView">
+    <dependency id="es6-promise-plugin" version="4.2.2"></dependency>
+
+    <engines>
+        <engine name="cordova" version=">=3.0.0" />
+    </engines>
+
+    <js-module src="www/plugin.nativeview.js" name="NativeView">
         <!-- This is the window variable name you want, like window.MyCordovaPlugin -->
-        <clobbers target="window.NativeView" />
+        <clobbers target="cordova.plugins.NativeView" />
     </js-module>
 
     <!-- android -->
diff --git a/src/android/NativeView.java b/src/android/NativeView.java
@@ -9,22 +9,28 @@
 import org.apache.cordova.CordovaWebView;
 import org.json.JSONArray;
 import org.json.JSONException;
+import org.json.JSONObject;
 
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.util.HashMap;
+import java.util.Iterator;
 
 /**
- * Created by @mfdeveloper on 28/08/17.
+ * Start a native Activity. This plugin
+ * use Java Reflection to decide which method
+ * execute
+ *
+ * @author @mfdeveloper on 28/08/17
  */
-
 public class NativeView extends CordovaPlugin {
 
     private static final String TAG = "NativeViewPlugin";
 
     public void initialize(CordovaInterface cordova, CordovaWebView webView) {
         super.initialize(cordova, webView);
 
-        Log.d(TAG, "Initializing NativeViewPlugin");
+        Log.d(TAG, "Initializing " + TAG);
     }
 
     public boolean execute(String action, JSONArray args, final CallbackContext callbackContext) throws JSONException {
@@ -40,12 +46,21 @@ public boolean execute(String action, JSONArray args, final CallbackContext call
                 return true;
 
             } catch (IllegalAccessException e) {
+                JSONObject error = errorResult(e);
+                callbackContext.error(error);
+
                 e.printStackTrace();
 
             } catch (IllegalArgumentException e) {
+                JSONObject error = errorResult(e);
+                callbackContext.error(error);
+
                 e.printStackTrace();
 
             }catch (InvocationTargetException e) {
+                JSONObject error = errorResult(e);
+                callbackContext.error(error);
+
                 e.printStackTrace();
             }
         }catch (NoSuchMethodException e) {
@@ -54,6 +69,12 @@ public boolean execute(String action, JSONArray args, final CallbackContext call
 
             Log.d(TAG, message);
 
+            HashMap<String, Object> data = new HashMap<String, Object>();
+            data.put("message", message);
+
+            JSONObject error = errorResult(e, data);
+            callbackContext.error(error);
+
             e.printStackTrace();
 
         }
@@ -64,16 +85,68 @@ public boolean execute(String action, JSONArray args, final CallbackContext call
     public void show(JSONArray params, final CallbackContext callbackContext) throws JSONException {
         String packageName = params.getString(0);
         String className = params.getString(1);
+        String extraParams;
+
+        if (className.startsWith("{")) {
+              extraParams = className;
+        } else {
+
+            extraParams = params.length() >= 3 ? params.getString(2) : null;
+        }
 
         final Intent intent = new Intent(packageName.toLowerCase() + "." + className);
 
+        if (extraParams != null) {
+
+            JSONObject jsonExtra = new JSONObject(extraParams);
+            Iterator<?> keys = jsonExtra.keys();
+
+            while (keys.hasNext()) {
+                String key = (String) keys.next();
+                intent.putExtra(key, jsonExtra.getString(key));
+            }
+        }
+
         cordova.getActivity().runOnUiThread(new Runnable() {
             @Override
             public void run() {
-                cordova.getActivity().startActivity(intent);
 
-                callbackContext.success("started");
+                try {
+                    cordova.getActivity().startActivity(intent);
+                    JSONObject success = new JSONObject();
+                    success.put("success", true);
+
+                    callbackContext.success(success);
+                } catch (Exception e) {
+
+                    JSONObject error = errorResult(e);
+                    callbackContext.error(error);
+                    e.printStackTrace();
+                }
+
             }
         });
     }
+
+    protected JSONObject errorResult(Exception e) {
+        HashMap<String, Object> data = new HashMap<String, Object>();
+        data.put("success", false);
+        data.put("name", e.getClass().getName());
+        data.put("message", e.getMessage());
+
+        JSONObject error = new JSONObject(data);
+        return error;
+    }
+
+    protected JSONObject errorResult(Exception e, HashMap<String, Object> extraData) {
+        HashMap<String, Object> data = new HashMap<String, Object>();
+        data.put("success", false);
+        data.put("name", e.getClass().getName());
+        data.put("message", e.getMessage());
+
+        data.putAll(extraData);
+
+        JSONObject error = new JSONObject(data);
+        return error;
+    }
 }
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,31 +1,48 @@
 // Type definitions for NativeView
 // Project: https://github.com/mfdeveloper/cordova-plugin-nativeview
 // Definitions by: Michel Felipe <https://github.com/mfdeveloper> 
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+interface CordovaPlugins {
+  NativeView: NativeView
+}
 
+interface ResultView {
+  success: boolean;
+  name?: string;
+  message?: string;
+}
 interface NativeView {
-  
-    /**
-     * Shows the native view.
-     * 
-     * Define the `packageOrClass` param to a package (Android) or a 
-     * storyboard/classname (IOS)
-     * 
-     * ```ts
-     * 
-     * //Android
-     * NativeView.show('com.mycompany', 'MyActivity')
-     * 
-     * //IOS
-     * NativeView.show('MyStoryboard', 'MyUIViewController');
-     * ```
-     * 
-     * @param packageOrClass
-     * @param className 
-     * @param success 
-     * @param error 
-     */
-    show(packageOrClass?: string, className?: string, success?: Function, error?: Function): void;
-  }
-  
-  declare var NativeView: NativeView;
+
+  /**
+   * Shows the native view.
+   * 
+   * Define the `packageOrClass` param to a package (Android) or a 
+   * storyboard/classname (IOS)
+   * 
+   * ```ts
+   * 
+   * //Android
+   * cordova.plugins.NativeView.show('com.mycompany', 'MyActivity')
+   * .then(() => {
+   *    // Do something
+   * });
+   * 
+   * //IOS
+   * cordova.plugins.NativeView.show('MyStoryboard', 'MyUIViewController')
+   * .then(() => {
+   *    // Do something
+   * });
+   * 
+   * //OR Back to previous View (IOS only)
+   * cordova.plugins.NativeView.show().then(() => {
+   *    // Do something
+   * });
+   * 
+   * ```
+   * 
+   * @param packageOrClass Package or class name of view to open
+   * @param className Class name of view to open
+   * @param success [Optional] Callback when success, if you don't want use promise "then()"
+   * @param error [Optional] Callback when error happens, if you don't want use promise "catch()"
+   */
+  show(packageOrClass?: string, className?: string, success?: Function, error?: Function): Promise<ResultView | void>;
+}
diff --git a/www/plugin.js b/www/plugin.js
diff --git a/www/plugin.nativeview.js b/www/plugin.nativeview.js
