@totalpave/cordova-plugin-insets 0.1.5 → 0.1.7

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+
+@totalpave/cordova-plugin-insets
+--------------------------------
+
+# Changelog
+
+## 0.1.7 (July 6, 2023)
+- Fixed clobbers namespace to merge instead, since this particular plugin targets a shared namespace.
+
+## 0.1.6 (April 20, 2023)
+-   Replaced `insets.getSystemWindowInset*` usages that was deprecated in API 30.
+-   Replaced `insets.consumeSystemWindowInsets` usages that was deprecated in API 30.
+-   Fix an issue on API 30 and earlier devices where the inset provided on launch may be incorrect.
+
+## 0.1.5 (April 13, 2023)
+
+-   Initial Release to NPM

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@totalpave/cordova-plugin-insets",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Cordova Android Plugin to receive native information regarding the unsafe area insets.",
   "main": "www/insets.js",
   "types": "www/api.d.ts",
@@ -25,19 +25,19 @@
   },
   "homepage": "https://github.com/totalpaveinc/cordova-plugin-insets#readme",
   "devDependencies": {
-    "@babel/core": "7.21.4",
-    "@babel/preset-env": "7.21.4",
-    "@babel/preset-typescript": "7.21.4",
-    "@babel/register": "7.21.0",
+    "@babel/core": "7.22.8",
+    "@babel/preset-env": "7.22.7",
+    "@babel/preset-typescript": "7.22.5",
+    "@babel/register": "7.22.5",
     "@rollup/plugin-babel": "6.0.3",
-    "@rollup/plugin-commonjs": "24.1.0",
-    "@rollup/plugin-node-resolve": "15.0.2",
+    "@rollup/plugin-commonjs": "25.0.2",
+    "@rollup/plugin-node-resolve": "15.1.0",
     "@types/cordova": "11.0.0",
-    "rollup": "3.20.2",
+    "rollup": "3.26.2",
     "rollup-plugin-progress": "1.1.2",
-    "rollup-plugin-typescript2": "0.34.1",
+    "rollup-plugin-typescript2": "0.35.0",
     "ts-node": "10.9.1",
-    "typescript": "5.0.4"
+    "typescript": "5.1.6"
   },
   "engines": {
     "cordovaDependencies": {
@@ -47,6 +47,6 @@
     }
   },
   "dependencies": {
-    "tslib": "2.5.0"
+    "tslib": "2.6.0"
   }
 }

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0" id="@totalpave/cordova-plugin-insets" version="0.1.3">
+<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0" id="@totalpave/cordova-plugin-insets" version="0.1.6">
   <name>cordova-plugin-insets</name>
   <description>Cordova Android Plugin to receive native information regarding the unsafe area insets</description>
   <author>Total Pave Inc.</author>
@@ -8,7 +8,7 @@
   <repo>https://github.com/totalpaveinc/cordova-plugin-unsafe-insets</repo>
 
   <js-module src="www/insets.js" name="Insets">
-    <clobbers target="totalpave" />
+    <merges target="totalpave" />
   </js-module>
 
   <platform name="android">

package/src/android/com/totalpave/cordova/insets/Insets.java

@@ -36,18 +36,22 @@ public class Insets extends CordovaPlugin {
     @Override
     protected void pluginInitialize() {
         ViewCompat.setOnApplyWindowInsetsListener(
-            this.cordova.getActivity().findViewById(android.R.id.content), (v, insets) -> {
+            this.cordova.getActivity().findViewById(android.R.id.content), (v, insetProvider) -> {
                 JSONObject result = new JSONObject();
+                
                 try {
                     float density = this.cordova.getActivity().getResources().getDisplayMetrics().density;
-                    result.put("top", insets.getSystemWindowInsetTop() / density);
-                    result.put("right", insets.getSystemWindowInsetRight() / density);
-                    result.put("bottom", insets.getSystemWindowInsetBottom() / density);
-                    result.put("left", insets.getSystemWindowInsetLeft() / density);
 
+                    // Ideally, we'd import this, but it shares the same name as our plugin
+                    androidx.core.graphics.Insets insets = insetProvider.getInsets(WindowInsetsCompat.Type.systemBars());
+                    
+                    result.put("top", insets.top / density);
+                    result.put("right", insets.right / density);
+                    result.put("bottom", insets.bottom / density);
+                    result.put("left", insets.left / density);
                 } catch (JSONException e) {
                     e.printStackTrace();
-                    return insets.consumeSystemWindowInsets();
+                    return insetProvider.CONSUMED; // Stop dispatching to child views
                 }
                 this.insets = result;
                 if (listener != null) {
@@ -55,7 +59,7 @@ public class Insets extends CordovaPlugin {
                     presult.setKeepCallback(true);
                     listener.sendPluginResult(presult);
                 }
-                return insets.consumeSystemWindowInsets();
+                return insetProvider.CONSUMED; // Stop dispatching to child views
             }
         );
     }
@@ -64,29 +68,17 @@ public class Insets extends CordovaPlugin {
     public boolean execute(String action, JSONArray args, CallbackContext callback) throws JSONException, NumberFormatException {
         if (action.equals("setListener")) {
             listener = callback;
-            if (this.insets == null) {
-                WindowInsetsCompat insets = ViewCompat.getRootWindowInsets(this.cordova.getActivity().findViewById(android.R.id.content));
-                if (insets != null) {
-                    JSONObject result = new JSONObject();
-                    try {
-                        float density = this.cordova.getActivity().getResources().getDisplayMetrics().density;
-                        result.put("top", insets.getSystemWindowInsetTop() / density);
-                        result.put("right", insets.getSystemWindowInsetRight() / density);
-                        result.put("bottom", insets.getSystemWindowInsetBottom() / density);
-                        result.put("left", insets.getSystemWindowInsetLeft() / density);
-                        this.insets = result;
-                    } catch (JSONException e) {
-                        e.printStackTrace();
-                        listener.error(e.getMessage());
-                        return true;
-                    }
+            cordova.getActivity().runOnUiThread(() -> {
+                if (this.insets == null) {
+                    // Trigger a inset dispatch (will eventually jump to the ApplyWindowInsetsListener above)
+                    ViewCompat.requestApplyInsets(cordova.getActivity().findViewById(android.R.id.content));
                 }
-            }
-            if (this.insets != null) {
-                PluginResult presult = new PluginResult(Status.OK, this.insets);
-                presult.setKeepCallback(true);
-                listener.sendPluginResult(presult);
-            }
+                else {
+                    PluginResult presult = new PluginResult(Status.OK, this.insets);
+                    presult.setKeepCallback(true);
+                    listener.sendPluginResult(presult);
+                }
+            });
             return true;
         }
         return false;

package/www/insets.js.map

@@ -1 +1 @@
-{"version":3,"file":"insets.js","sources":["../src/www/Insets.ts"],"sourcesContent":["/*\n   Copyright 2022 Total Pave Inc.\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.\n*/\n\nexport const SERVICE_NAME: string = \"Insets\";\n\nexport interface IInsets {\n    top: number;\n    right: number;\n    bottom: number;\n    left: number;\n}\n\nexport type IInsetCallbackFunc = (inset: IInsets) => void;\n\nexport class Insets {\n    private static initPromise: Promise<void>;\n    private static listeners: Array<Function> = [];\n    private static insets: IInsets = {\n        top: 0,\n        right: 0,\n        bottom: 0,\n        left: 0\n    };\n\n    /**\n     * Initializes javascript side of the plugin.\n     * \n     * This function is called automatically on deviceready.\n     * @internal\n     */\n    public static __init(): Promise<void> {\n        if (this.initPromise) {\n            return this.initPromise;\n        }\n        this.initPromise = new Promise<void>((resolve, reject) => {\n            // Setup promise resolving mechanism.\n            // We don't use the cordova callback functions as they will be called multiple times over the lifespan of an app.\n            let func = () => {\n                resolve();\n                Insets.removeListener(func);\n            }\n            Insets.addListener(func);\n\n            // Setup cordova callback.\n            cordova.exec(\n                (insets: IInsets) => {\n                    Insets.insets = insets;\n                    for (let i = 0, listeners = Insets.listeners.slice(), length = listeners.length; i < length; ++i) {\n                        listeners[i](insets);\n                    }\n                },\n                reject,\n                SERVICE_NAME,\n                \"setListener\",\n                []\n            );\n        });\n    }\n\n    public static addListener(callback: IInsetCallbackFunc) {\n        this.listeners.push(callback);\n    }\n\n    public static removeListener(callback: IInsetCallbackFunc) {\n        let index = this.listeners.indexOf(callback);\n        if (index === -1) {\n            return;\n        }\n        this.listeners.splice(index, 1);\n    }\n\n    /**\n     * @returns Last emitted insets.\n     */    \n    public static getInsets(): IInsets {\n        return Insets.insets;\n    }\n};\n\ndocument.addEventListener('deviceready', function() {\n    Insets.__init();\n});\n"],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;;AAcE;AAEK,MAAM,YAAY,GAAW,QAAQ,CAAC;AAW7C,MAAa,MAAM,CAAA;AAUf;;;;;AAKG;AACI,IAAA,OAAO,MAAM,GAAA;QAChB,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,OAAO,IAAI,CAAC,WAAW,CAAC;AAC3B,SAAA;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,KAAI;;;YAGrD,IAAI,IAAI,GAAG,MAAK;AACZ,gBAAA,OAAO,EAAE,CAAC;AACV,gBAAA,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AAChC,aAAC,CAAA;AACD,YAAA,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;;AAGzB,YAAA,OAAO,CAAC,IAAI,CACR,CAAC,MAAe,KAAI;AAChB,gBAAA,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;gBACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE;AAC9F,oBAAA,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AACxB,iBAAA;aACJ,EACD,MAAM,EACN,YAAY,EACZ,aAAa,EACb,EAAE,CACL,CAAC;AACN,SAAC,CAAC,CAAC;KACN;IAEM,OAAO,WAAW,CAAC,QAA4B,EAAA;AAClD,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;KACjC;IAEM,OAAO,cAAc,CAAC,QAA4B,EAAA;QACrD,IAAI,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC7C,QAAA,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YACd,OAAO;AACV,SAAA;QACD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;KACnC;AAED;;AAEG;AACI,IAAA,OAAO,SAAS,GAAA;QACnB,OAAO,MAAM,CAAC,MAAM,CAAC;KACxB;;AA5Dc,MAAS,CAAA,SAAA,GAAoB,EAAE,CAAC;AAChC,MAAA,CAAA,MAAM,GAAY;AAC7B,IAAA,GAAG,EAAE,CAAC;AACN,IAAA,KAAK,EAAE,CAAC;AACR,IAAA,MAAM,EAAE,CAAC;AACT,IAAA,IAAI,EAAE,CAAC;CACV,CAAC;AAyDN,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,YAAA;IACrC,MAAM,CAAC,MAAM,EAAE,CAAC;AACpB,CAAC,CAAC;;;;"}
+{"version":3,"file":"insets.js","sources":["../src/www/Insets.ts"],"sourcesContent":["/*\n   Copyright 2022 Total Pave Inc.\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.\n*/\n\nexport const SERVICE_NAME: string = \"Insets\";\n\nexport interface IInsets {\n    top: number;\n    right: number;\n    bottom: number;\n    left: number;\n}\n\nexport type IInsetCallbackFunc = (inset: IInsets) => void;\n\nexport class Insets {\n    private static initPromise: Promise<void>;\n    private static listeners: Array<Function> = [];\n    private static insets: IInsets = {\n        top: 0,\n        right: 0,\n        bottom: 0,\n        left: 0\n    };\n\n    /**\n     * Initializes javascript side of the plugin.\n     * \n     * This function is called automatically on deviceready.\n     * @internal\n     */\n    public static __init(): Promise<void> {\n        if (this.initPromise) {\n            return this.initPromise;\n        }\n        this.initPromise = new Promise<void>((resolve, reject) => {\n            // Setup promise resolving mechanism.\n            // We don't use the cordova callback functions as they will be called multiple times over the lifespan of an app.\n            let func = () => {\n                resolve();\n                Insets.removeListener(func);\n            }\n            Insets.addListener(func);\n\n            // Setup cordova callback.\n            cordova.exec(\n                (insets: IInsets) => {\n                    Insets.insets = insets;\n                    for (let i = 0, listeners = Insets.listeners.slice(), length = listeners.length; i < length; ++i) {\n                        listeners[i](insets);\n                    }\n                },\n                reject,\n                SERVICE_NAME,\n                \"setListener\",\n                []\n            );\n        });\n    }\n\n    public static addListener(callback: IInsetCallbackFunc) {\n        this.listeners.push(callback);\n    }\n\n    public static removeListener(callback: IInsetCallbackFunc) {\n        let index = this.listeners.indexOf(callback);\n        if (index === -1) {\n            return;\n        }\n        this.listeners.splice(index, 1);\n    }\n\n    /**\n     * @returns Last emitted insets.\n     */    \n    public static getInsets(): IInsets {\n        return Insets.insets;\n    }\n};\n\ndocument.addEventListener('deviceready', function() {\n    Insets.__init();\n});\n"],"names":[],"mappings":";;AAAA;;;;;;;;;;;;;;AAcE;AAEK,MAAM,YAAY,GAAW,QAAQ,CAAC;MAWhC,MAAM,CAAA;AAUf;;;;;AAKG;AACI,IAAA,OAAO,MAAM,GAAA;QAChB,IAAI,IAAI,CAAC,WAAW,EAAE;YAClB,OAAO,IAAI,CAAC,WAAW,CAAC;AAC3B,SAAA;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,KAAI;;;YAGrD,IAAI,IAAI,GAAG,MAAK;AACZ,gBAAA,OAAO,EAAE,CAAC;AACV,gBAAA,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AAChC,aAAC,CAAA;AACD,YAAA,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;;AAGzB,YAAA,OAAO,CAAC,IAAI,CACR,CAAC,MAAe,KAAI;AAChB,gBAAA,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;gBACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE;AAC9F,oBAAA,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AACxB,iBAAA;aACJ,EACD,MAAM,EACN,YAAY,EACZ,aAAa,EACb,EAAE,CACL,CAAC;AACN,SAAC,CAAC,CAAC;KACN;IAEM,OAAO,WAAW,CAAC,QAA4B,EAAA;AAClD,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;KACjC;IAEM,OAAO,cAAc,CAAC,QAA4B,EAAA;QACrD,IAAI,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC7C,QAAA,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YACd,OAAO;AACV,SAAA;QACD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;KACnC;AAED;;AAEG;AACI,IAAA,OAAO,SAAS,GAAA;QACnB,OAAO,MAAM,CAAC,MAAM,CAAC;KACxB;;AA5Dc,MAAS,CAAA,SAAA,GAAoB,EAAE,CAAC;AAChC,MAAA,CAAA,MAAM,GAAY;AAC7B,IAAA,GAAG,EAAE,CAAC;AACN,IAAA,KAAK,EAAE,CAAC;AACR,IAAA,MAAM,EAAE,CAAC;AACT,IAAA,IAAI,EAAE,CAAC;CACV,CAAC;AAyDN,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,YAAA;IACrC,MAAM,CAAC,MAAM,EAAE,CAAC;AACpB,CAAC,CAAC;;;;"}