@capacitor/browser 5.1.1-nightly-20231108T150452.0 → 5.2.0

package/README.md

@@ -35,8 +35,8 @@ const openCapacitorSite = async () => {
 
 * [`open(...)`](#open)
 * [`close()`](#close)
-* [`addListener('browserFinished', ...)`](#addlistenerbrowserfinished)
-* [`addListener('browserPageLoaded', ...)`](#addlistenerbrowserpageloaded)
+* [`addListener('browserFinished', ...)`](#addlistenerbrowserfinished-)
+* [`addListener('browserPageLoaded', ...)`](#addlistenerbrowserpageloaded-)
 * [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
 
@@ -80,7 +80,7 @@ No-op on other platforms.
 ### addListener('browserFinished', ...)
 
 ```typescript
-addListener(eventName: 'browserFinished', listenerFunc: () => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'browserFinished', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Android & iOS only: Listen for the browser finished event.
@@ -91,7 +91,7 @@ It fires when the Browser is closed by the user.
 | **`eventName`**    | <code>'browserFinished'</code> |
 | **`listenerFunc`** | <code>() =&gt; void</code>     |
 
-**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
 **Since:** 1.0.0
 
@@ -101,7 +101,7 @@ It fires when the Browser is closed by the user.
 ### addListener('browserPageLoaded', ...)
 
 ```typescript
-addListener(eventName: 'browserPageLoaded', listenerFunc: () => void) => Promise<PluginListenerHandle>
+addListener(eventName: 'browserPageLoaded', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Android & iOS only: Listen for the page loaded event.
@@ -113,7 +113,7 @@ It is not invoked for any subsequent page loads.
 | **`eventName`**    | <code>'browserPageLoaded'</code> |
 | **`listenerFunc`** | <code>() =&gt; void</code>       |
 
-**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
 **Since:** 1.0.0
 

package/android/build.gradle

@@ -16,7 +16,7 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.2.0-rc02'
+        classpath 'com.android.tools.build:gradle:8.0.0'
         if (System.getenv("CAP_PLUGIN_PUBLISH") == "true") {
             classpath 'io.github.gradle-nexus:publish-plugin:1.3.0'
         }
@@ -32,10 +32,10 @@ if (System.getenv("CAP_PLUGIN_PUBLISH") == "true") {
 
 android {
     namespace "com.capacitorjs.plugins.browser"
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

package/android/src/main/AndroidManifest.xml

@@ -1,5 +1,11 @@
 
   <manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application>
+      <activity android:name=".BrowserControllerActivity"
+        android:exported="false"
+          android:theme="@android:style/Theme.Translucent.NoTitleBar"
+          android:launchMode="singleTask"/>
+    </application>
     <queries>
       <intent>
         <action android:name="android.support.customtabs.action.CustomTabsService" />

package/android/src/main/java/com/capacitorjs/plugins/browser/BrowserControllerActivity.java

@@ -0,0 +1,52 @@
+package com.capacitorjs.plugins.browser;
+
+import android.app.Activity;
+import android.content.Intent;
+import android.net.Uri;
+import android.os.Bundle;
+import androidx.annotation.Nullable;
+
+public class BrowserControllerActivity extends Activity {
+
+    private boolean isCustomTabsOpen = false;
+
+    @Override
+    protected void onCreate(@Nullable Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        isCustomTabsOpen = false;
+
+        if (BrowserPlugin.browserControllerListener != null) {
+            BrowserPlugin.browserControllerListener.onControllerReady(this);
+        }
+    }
+
+    @Override
+    protected void onNewIntent(Intent intent) {
+        super.onNewIntent(intent);
+        if (intent.hasExtra("close")) {
+            finish();
+        }
+    }
+
+    @Override
+    protected void onResume() {
+        super.onResume();
+        if (isCustomTabsOpen) {
+            isCustomTabsOpen = false;
+            finish();
+        } else {
+            isCustomTabsOpen = true;
+        }
+    }
+
+    public void open(Browser implementation, Uri url, Integer toolbarColor) {
+        implementation.open(url, toolbarColor);
+    }
+
+    @Override
+    protected void onDestroy() {
+        super.onDestroy();
+        isCustomTabsOpen = false;
+        BrowserPlugin.setBrowserControllerListener(null);
+    }
+}

package/android/src/main/java/com/capacitorjs/plugins/browser/BrowserControllerListener.java

@@ -0,0 +1,5 @@
+package com.capacitorjs.plugins.browser;
+
+public interface BrowserControllerListener {
+    void onControllerReady(BrowserControllerActivity activity);
+}

package/android/src/main/java/com/capacitorjs/plugins/browser/BrowserPlugin.java

@@ -1,6 +1,7 @@
 package com.capacitorjs.plugins.browser;
 
 import android.content.ActivityNotFoundException;
+import android.content.Intent;
 import android.net.Uri;
 import com.getcapacitor.Logger;
 import com.getcapacitor.Plugin;
@@ -14,6 +15,16 @@ public class BrowserPlugin extends Plugin {
 
     private Browser implementation;
 
+    public static BrowserControllerListener browserControllerListener;
+    private static BrowserControllerActivity browserControllerActivityInstance;
+
+    public static void setBrowserControllerListener(BrowserControllerListener listener) {
+        browserControllerListener = listener;
+        if (listener == null) {
+            browserControllerActivityInstance = null;
+        }
+    }
+
     public void load() {
         implementation = new Browser(getContext());
         implementation.setBrowserEventListener(this::onBrowserEvent);
@@ -50,18 +61,35 @@ public class BrowserPlugin extends Plugin {
 
         // open the browser and finish
         try {
-            implementation.open(url, toolbarColor);
+            Intent intent = new Intent(getContext(), BrowserControllerActivity.class);
+            intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
+            intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            getContext().startActivity(intent);
+
+            Integer finalToolbarColor = toolbarColor;
+            setBrowserControllerListener(
+                activity -> {
+                    activity.open(implementation, url, finalToolbarColor);
+                    browserControllerActivityInstance = activity;
+                    call.resolve();
+                }
+            );
         } catch (ActivityNotFoundException ex) {
             Logger.error(getLogTag(), ex.getLocalizedMessage(), null);
             call.reject("Unable to display URL");
             return;
         }
-        call.resolve();
     }
 
     @PluginMethod
     public void close(PluginCall call) {
-        call.unimplemented();
+        if (browserControllerActivityInstance != null) {
+            browserControllerActivityInstance = null;
+            Intent intent = new Intent(getContext(), BrowserControllerActivity.class);
+            intent.putExtra("close", true);
+            getContext().startActivity(intent);
+        }
+        call.resolve();
     }
 
     @Override

package/dist/docs.json

@@ -45,7 +45,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: 'browserFinished', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'browserFinished', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -58,7 +58,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "Promise<PluginListenerHandle>",
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
         "tags": [
           {
             "name": "since",
@@ -69,11 +69,11 @@
         "complexTypes": [
           "PluginListenerHandle"
         ],
-        "slug": "addlistenerbrowserfinished"
+        "slug": "addlistenerbrowserfinished-"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: 'browserPageLoaded', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'browserPageLoaded', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -86,7 +86,7 @@
             "type": "() => void"
           }
         ],
-        "returns": "Promise<PluginListenerHandle>",
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
         "tags": [
           {
             "name": "since",
@@ -97,7 +97,7 @@
         "complexTypes": [
           "PluginListenerHandle"
         ],
-        "slug": "addlistenerbrowserpageloaded"
+        "slug": "addlistenerbrowserpageloaded-"
       },
       {
         "name": "removeAllListeners",

package/dist/esm/definitions.d.ts

@@ -20,7 +20,7 @@ export interface BrowserPlugin {
      *
      * @since 1.0.0
      */
-    addListener(eventName: 'browserFinished', listenerFunc: () => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'browserFinished', listenerFunc: () => void): Promise<PluginListenerHandle> & PluginListenerHandle;
     /**
      * Android & iOS only: Listen for the page loaded event.
      * It's only fired when the URL passed to open method finish loading.
@@ -28,7 +28,7 @@ export interface BrowserPlugin {
      *
      * @since 1.0.0
      */
-    addListener(eventName: 'browserPageLoaded', listenerFunc: () => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'browserPageLoaded', listenerFunc: () => void): Promise<PluginListenerHandle> & PluginListenerHandle;
     /**
      * Remove all native listeners for this plugin.
      *

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface BrowserPlugin {\n  /**\n   * Open a page with the specified options.\n   *\n   * @since 1.0.0\n   */\n  open(options: OpenOptions): Promise<void>;\n\n  /**\n   * Web & iOS only: Close an open browser window.\n   *\n   * No-op on other platforms.\n   *\n   * @since 1.0.0\n   */\n  close(): Promise<void>;\n\n  /**\n   * Android & iOS only: Listen for the browser finished event.\n   * It fires when the Browser is closed by the user.\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'browserFinished',\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Android & iOS only: Listen for the page loaded event.\n   * It's only fired when the URL passed to open method finish loading.\n   * It is not invoked for any subsequent page loads.\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'browserPageLoaded',\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all native listeners for this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * Represents the options passed to `open`.\n *\n * @since 1.0.0\n */\nexport interface OpenOptions {\n  /**\n   * The URL to which the browser is opened.\n   *\n   * @since 1.0.0\n   */\n  url: string;\n\n  /**\n   * Web only: Optional target for browser open. Follows\n   * the `target` property for window.open. Defaults\n   * to _blank.\n   *\n   * Ignored on other platforms.\n   *\n   * @since 1.0.0\n   */\n  windowName?: string;\n\n  /**\n   * A hex color to which the toolbar color is set.\n   *\n   * @since 1.0.0\n   */\n  toolbarColor?: string;\n\n  /**\n   * iOS only: The presentation style of the browser. Defaults to fullscreen.\n   *\n   * Ignored on other platforms.\n   *\n   * @since 1.0.0\n   */\n  presentationStyle?: 'fullscreen' | 'popover';\n\n  /**\n   * iOS only: The width the browser when using presentationStyle 'popover' on iPads.\n   *\n   * Ignored on other platforms.\n   *\n   * @since 4.0.0\n   */\n  width?: number;\n\n  /**\n   * iOS only: The height the browser when using presentationStyle 'popover' on iPads.\n   *\n   * Ignored on other platforms.\n   *\n   * @since 4.0.0\n   */\n  height?: number;\n}\n\n/**\n * @deprecated Use `OpenOptions`.\n * @since 1.0.0\n */\nexport type BrowserOpenOptions = OpenOptions;\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface BrowserPlugin {\n  /**\n   * Open a page with the specified options.\n   *\n   * @since 1.0.0\n   */\n  open(options: OpenOptions): Promise<void>;\n\n  /**\n   * Web & iOS only: Close an open browser window.\n   *\n   * No-op on other platforms.\n   *\n   * @since 1.0.0\n   */\n  close(): Promise<void>;\n\n  /**\n   * Android & iOS only: Listen for the browser finished event.\n   * It fires when the Browser is closed by the user.\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'browserFinished',\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle;\n\n  /**\n   * Android & iOS only: Listen for the page loaded event.\n   * It's only fired when the URL passed to open method finish loading.\n   * It is not invoked for any subsequent page loads.\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'browserPageLoaded',\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle;\n\n  /**\n   * Remove all native listeners for this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * Represents the options passed to `open`.\n *\n * @since 1.0.0\n */\nexport interface OpenOptions {\n  /**\n   * The URL to which the browser is opened.\n   *\n   * @since 1.0.0\n   */\n  url: string;\n\n  /**\n   * Web only: Optional target for browser open. Follows\n   * the `target` property for window.open. Defaults\n   * to _blank.\n   *\n   * Ignored on other platforms.\n   *\n   * @since 1.0.0\n   */\n  windowName?: string;\n\n  /**\n   * A hex color to which the toolbar color is set.\n   *\n   * @since 1.0.0\n   */\n  toolbarColor?: string;\n\n  /**\n   * iOS only: The presentation style of the browser. Defaults to fullscreen.\n   *\n   * Ignored on other platforms.\n   *\n   * @since 1.0.0\n   */\n  presentationStyle?: 'fullscreen' | 'popover';\n\n  /**\n   * iOS only: The width the browser when using presentationStyle 'popover' on iPads.\n   *\n   * Ignored on other platforms.\n   *\n   * @since 4.0.0\n   */\n  width?: number;\n\n  /**\n   * iOS only: The height the browser when using presentationStyle 'popover' on iPads.\n   *\n   * Ignored on other platforms.\n   *\n   * @since 4.0.0\n   */\n  height?: number;\n}\n\n/**\n * @deprecated Use `OpenOptions`.\n * @since 1.0.0\n */\nexport type BrowserOpenOptions = OpenOptions;\n"]}

package/ios/Plugin/BrowserPlugin.m

@@ -4,4 +4,5 @@
 CAP_PLUGIN(CAPBrowserPlugin, "Browser",
   CAP_PLUGIN_METHOD(open, CAPPluginReturnPromise);
   CAP_PLUGIN_METHOD(close, CAPPluginReturnPromise);
+  CAP_PLUGIN_METHOD(removeAllListeners, CAPPluginReturnPromise);
 )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/browser",
-  "version": "5.1.1-nightly-20231108T150452.0",
+  "version": "5.2.0",
   "description": "The Browser API provides the ability to open an in-app browser and subscribe to browser events.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -47,7 +47,7 @@
   "devDependencies": {
     "@capacitor/android": "^5.0.0",
     "@capacitor/core": "^5.0.0",
-    "@capacitor/docgen": "0.2.0",
+    "@capacitor/docgen": "0.2.2",
     "@capacitor/ios": "^5.0.0",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "~1.0.1",
@@ -79,5 +79,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c44bf164b01d5f5ed405695f06efd36a881c4272"
+  "gitHead": "d5483ce9f666f1a38c25a11e63899fd35701ca45"
 }