@capawesome/capacitor-in-app-browser 0.0.1

package/android/build.gradle

@@ -0,0 +1,60 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxBrowserVersion = project.hasProperty('androidxBrowserVersion') ? rootProject.ext.androidxBrowserVersion : '1.9.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace = "io.capawesome.capacitorjs.plugins.inappbrowser"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError = false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "androidx.browser:browser:$androidxBrowserVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/InAppBrowser.java

@@ -0,0 +1,242 @@
+package io.capawesome.capacitorjs.plugins.inappbrowser;
+
+import android.content.ActivityNotFoundException;
+import android.content.Intent;
+import android.webkit.CookieManager;
+import android.webkit.WebStorage;
+import android.webkit.WebView;
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.browser.customtabs.CustomTabColorSchemeParams;
+import androidx.browser.customtabs.CustomTabsIntent;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.CustomExceptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.WebViewDialog;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.events.BrowserPageNavigationCompletedEvent;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.events.MessageReceivedEvent;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.ExecuteScriptOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.GetCookiesOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.OpenInExternalBrowserOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.OpenInSystemBrowserOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.OpenInWebViewOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.PostMessageOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.results.ExecuteScriptResult;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.results.GetCookiesResult;
+import io.capawesome.capacitorjs.plugins.inappbrowser.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.inappbrowser.interfaces.NonEmptyResultCallback;
+import java.util.HashMap;
+import java.util.Map;
+import org.json.JSONException;
+import org.json.JSONTokener;
+
+public class InAppBrowser {
+
+    @NonNull
+    private final InAppBrowserPlugin plugin;
+
+    private boolean customTabOpened = false;
+
+    @Nullable
+    private WebViewDialog webViewDialog;
+
+    public InAppBrowser(@NonNull InAppBrowserPlugin plugin) {
+        this.plugin = plugin;
+    }
+
+    public void clearCache(@NonNull EmptyCallback callback) {
+        plugin
+            .getActivity()
+            .runOnUiThread(() -> {
+                WebView webView = new WebView(plugin.getContext());
+                webView.clearCache(true);
+                webView.destroy();
+                callback.success();
+            });
+    }
+
+    public void clearSessionData(@NonNull EmptyCallback callback) {
+        plugin
+            .getActivity()
+            .runOnUiThread(() -> {
+                CookieManager cookieManager = CookieManager.getInstance();
+                cookieManager.removeAllCookies(value -> {
+                    cookieManager.flush();
+                    WebStorage.getInstance().deleteAllData();
+                    callback.success();
+                });
+            });
+    }
+
+    public void close(@NonNull EmptyCallback callback) {
+        plugin
+            .getActivity()
+            .runOnUiThread(() -> {
+                WebViewDialog webViewDialog = this.webViewDialog;
+                if (webViewDialog != null) {
+                    webViewDialog.dismiss();
+                    callback.success();
+                    return;
+                }
+                if (customTabOpened) {
+                    Intent intent = new Intent(plugin.getContext(), plugin.getActivity().getClass());
+                    intent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_SINGLE_TOP);
+                    plugin.getActivity().startActivity(intent);
+                    callback.success();
+                    return;
+                }
+                callback.error(CustomExceptions.NO_BROWSER_OPEN);
+            });
+    }
+
+    public void executeScript(@NonNull ExecuteScriptOptions options, @NonNull NonEmptyResultCallback<ExecuteScriptResult> callback) {
+        plugin
+            .getActivity()
+            .runOnUiThread(() -> {
+                WebViewDialog webViewDialog = this.webViewDialog;
+                if (webViewDialog == null) {
+                    callback.error(CustomExceptions.NO_BROWSER_OPEN);
+                    return;
+                }
+                webViewDialog.executeScript(options.getScript(), value -> {
+                    String result = value == null || value.equals("null") ? null : value;
+                    callback.success(new ExecuteScriptResult(result));
+                });
+            });
+    }
+
+    public void getCookies(@NonNull GetCookiesOptions options, @NonNull NonEmptyResultCallback<GetCookiesResult> callback) {
+        plugin
+            .getActivity()
+            .runOnUiThread(() -> {
+                Map<String, String> cookies = new HashMap<>();
+                String cookieString = CookieManager.getInstance().getCookie(options.getUrl());
+                if (cookieString != null) {
+                    for (String cookie : cookieString.split("; ")) {
+                        int separatorIndex = cookie.indexOf('=');
+                        if (separatorIndex < 0) {
+                            continue;
+                        }
+                        String name = cookie.substring(0, separatorIndex);
+                        String value = cookie.substring(separatorIndex + 1);
+                        cookies.put(name, value);
+                    }
+                }
+                callback.success(new GetCookiesResult(cookies));
+            });
+    }
+
+    public void handleOnPause() {
+        WebViewDialog webViewDialog = this.webViewDialog;
+        if (webViewDialog != null) {
+            webViewDialog.handleOnPause();
+        }
+    }
+
+    public void handleOnResume() {
+        WebViewDialog webViewDialog = this.webViewDialog;
+        if (webViewDialog != null) {
+            webViewDialog.handleOnResume();
+        }
+        if (customTabOpened) {
+            customTabOpened = false;
+            plugin.notifyBrowserClosedListeners();
+        }
+    }
+
+    public void openInExternalBrowser(@NonNull OpenInExternalBrowserOptions options, @NonNull EmptyCallback callback) {
+        Intent intent = new Intent(Intent.ACTION_VIEW, options.getUri());
+        try {
+            plugin.getActivity().startActivity(intent);
+            callback.success();
+        } catch (ActivityNotFoundException exception) {
+            callback.error(CustomExceptions.BROWSER_NOT_FOUND);
+        }
+    }
+
+    public void openInSystemBrowser(@NonNull OpenInSystemBrowserOptions options, @NonNull EmptyCallback callback) {
+        plugin
+            .getActivity()
+            .runOnUiThread(() -> {
+                CustomTabsIntent.Builder builder = new CustomTabsIntent.Builder();
+                Integer toolbarColor = options.getToolbarColor();
+                if (toolbarColor != null) {
+                    builder.setDefaultColorSchemeParams(new CustomTabColorSchemeParams.Builder().setToolbarColor(toolbarColor).build());
+                }
+                builder.setShowTitle(options.getShowTitle());
+                builder.setUrlBarHidingEnabled(options.getHideToolbarOnScroll());
+                CustomTabsIntent customTabsIntent = builder.build();
+                try {
+                    customTabsIntent.launchUrl(plugin.getActivity(), options.getUri());
+                    customTabOpened = true;
+                    callback.success();
+                } catch (ActivityNotFoundException exception) {
+                    callback.error(CustomExceptions.BROWSER_NOT_FOUND);
+                }
+            });
+    }
+
+    public void openInWebView(@NonNull OpenInWebViewOptions options, @NonNull EmptyCallback callback) {
+        plugin
+            .getActivity()
+            .runOnUiThread(() -> {
+                WebViewDialog existingWebViewDialog = this.webViewDialog;
+                if (existingWebViewDialog != null) {
+                    existingWebViewDialog.dismiss();
+                }
+                WebViewDialog webViewDialog = new WebViewDialog(
+                    plugin.getActivity(),
+                    options,
+                    new WebViewDialog.Listener() {
+                        @Override
+                        public void onClosed(@NonNull WebViewDialog dialog) {
+                            if (InAppBrowser.this.webViewDialog == dialog) {
+                                InAppBrowser.this.webViewDialog = null;
+                            }
+                            plugin.notifyBrowserClosedListeners();
+                        }
+
+                        @Override
+                        public void onMessageReceived(@NonNull String data) {
+                            handleMessageReceived(data);
+                        }
+
+                        @Override
+                        public void onPageLoaded() {
+                            plugin.notifyBrowserPageLoadedListeners();
+                        }
+
+                        @Override
+                        public void onPageNavigationCompleted(@NonNull String url) {
+                            plugin.notifyBrowserPageNavigationCompletedListeners(new BrowserPageNavigationCompletedEvent(url));
+                        }
+                    }
+                );
+                this.webViewDialog = webViewDialog;
+                webViewDialog.show();
+                callback.success();
+            });
+    }
+
+    public void postMessage(@NonNull PostMessageOptions options, @NonNull EmptyCallback callback) {
+        plugin
+            .getActivity()
+            .runOnUiThread(() -> {
+                WebViewDialog webViewDialog = this.webViewDialog;
+                if (webViewDialog == null) {
+                    callback.error(CustomExceptions.NO_BROWSER_OPEN);
+                    return;
+                }
+                webViewDialog.postMessage(options.getData().toString());
+                callback.success();
+            });
+    }
+
+    private void handleMessageReceived(@NonNull String data) {
+        Object value;
+        try {
+            value = new JSONTokener(data).nextValue();
+        } catch (JSONException exception) {
+            value = data;
+        }
+        plugin.notifyMessageReceivedListeners(new MessageReceivedEvent(value));
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/InAppBrowserPlugin.java

@@ -0,0 +1,289 @@
+package io.capawesome.capacitorjs.plugins.inappbrowser;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.events.BrowserPageNavigationCompletedEvent;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.events.MessageReceivedEvent;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.ExecuteScriptOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.GetCookiesOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.OpenInExternalBrowserOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.OpenInSystemBrowserOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.OpenInWebViewOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.options.PostMessageOptions;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.results.ExecuteScriptResult;
+import io.capawesome.capacitorjs.plugins.inappbrowser.classes.results.GetCookiesResult;
+import io.capawesome.capacitorjs.plugins.inappbrowser.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.inappbrowser.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.inappbrowser.interfaces.Result;
+
+@CapacitorPlugin(name = "InAppBrowser")
+public class InAppBrowserPlugin extends Plugin {
+
+    public static final String EVENT_BROWSER_CLOSED = "browserClosed";
+    public static final String EVENT_BROWSER_PAGE_LOADED = "browserPageLoaded";
+    public static final String EVENT_BROWSER_PAGE_NAVIGATION_COMPLETED = "browserPageNavigationCompleted";
+    public static final String EVENT_MESSAGE_RECEIVED = "messageReceived";
+    public static final String TAG = "InAppBrowserPlugin";
+
+    private static final String ERROR_UNKNOWN_ERROR = "An unknown error occurred.";
+
+    private InAppBrowser implementation;
+
+    @PluginMethod
+    public void clearCache(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.clearCache(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void clearSessionData(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.clearSessionData(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void close(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.close(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void executeScript(PluginCall call) {
+        try {
+            ExecuteScriptOptions options = new ExecuteScriptOptions(call);
+            NonEmptyResultCallback<ExecuteScriptResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull ExecuteScriptResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.executeScript(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void getCookies(PluginCall call) {
+        try {
+            GetCookiesOptions options = new GetCookiesOptions(call);
+            NonEmptyResultCallback<GetCookiesResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GetCookiesResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.getCookies(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @Override
+    public void load() {
+        implementation = new InAppBrowser(this);
+    }
+
+    public void notifyBrowserClosedListeners() {
+        notifyListeners(EVENT_BROWSER_CLOSED, new JSObject());
+    }
+
+    public void notifyBrowserPageLoadedListeners() {
+        notifyListeners(EVENT_BROWSER_PAGE_LOADED, new JSObject());
+    }
+
+    public void notifyBrowserPageNavigationCompletedListeners(@NonNull BrowserPageNavigationCompletedEvent event) {
+        notifyListeners(EVENT_BROWSER_PAGE_NAVIGATION_COMPLETED, event.toJSObject());
+    }
+
+    public void notifyMessageReceivedListeners(@NonNull MessageReceivedEvent event) {
+        notifyListeners(EVENT_MESSAGE_RECEIVED, event.toJSObject());
+    }
+
+    @PluginMethod
+    public void openInExternalBrowser(PluginCall call) {
+        try {
+            OpenInExternalBrowserOptions options = new OpenInExternalBrowserOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.openInExternalBrowser(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void openInSystemBrowser(PluginCall call) {
+        try {
+            OpenInSystemBrowserOptions options = new OpenInSystemBrowserOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.openInSystemBrowser(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void openInWebView(PluginCall call) {
+        try {
+            OpenInWebViewOptions options = new OpenInWebViewOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.openInWebView(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void postMessage(PluginCall call) {
+        try {
+            PostMessageOptions options = new PostMessageOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.postMessage(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @Override
+    protected void handleOnPause() {
+        implementation.handleOnPause();
+    }
+
+    @Override
+    protected void handleOnResume() {
+        implementation.handleOnResume();
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        String code = null;
+        if (exception instanceof CustomException) {
+            code = ((CustomException) exception).getCode();
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message, code);
+    }
+
+    private void resolveCall(@NonNull PluginCall call) {
+        call.resolve();
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @Nullable Result result) {
+        if (result == null) {
+            call.resolve();
+        } else {
+            call.resolve(result.toJSObject());
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/CustomException.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.inappbrowser.classes;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public class CustomException extends Exception {
+
+    @Nullable
+    private final String code;
+
+    public CustomException(@Nullable String code, @NonNull String message) {
+        super(message);
+        this.code = code;
+    }
+
+    @Nullable
+    public String getCode() {
+        return code;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/inappbrowser/classes/CustomExceptions.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.inappbrowser.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException BACKGROUND_COLOR_INVALID = new CustomException(
+        null,
+        "backgroundColor must be a valid hex color code."
+    );
+    public static final CustomException BROWSER_NOT_FOUND = new CustomException(
+        "BROWSER_NOT_FOUND",
+        "No app was found on the device that can open the URL."
+    );
+    public static final CustomException COLOR_INVALID = new CustomException(null, "color must be a valid hex color code.");
+    public static final CustomException DATA_MISSING = new CustomException(null, "data must be provided.");
+    public static final CustomException NO_BROWSER_OPEN = new CustomException("NO_BROWSER_OPEN", "No browser is currently open.");
+    public static final CustomException SCRIPT_MISSING = new CustomException(null, "script must be provided.");
+    public static final CustomException TOOLBAR_COLOR_INVALID = new CustomException(null, "toolbarColor must be a valid hex color code.");
+    public static final CustomException URL_INVALID = new CustomException(null, "url is invalid.");
+    public static final CustomException URL_MISSING = new CustomException(null, "url must be provided.");
+}