@softvisio/webview 1.2.12

package/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 99999999
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

package/CHANGELOG.md

@@ -0,0 +1,109 @@
+# Changelog
+
+### 1.2.12 (2022-05-28)
+
+Fixes:
+
+-   fix: search browser
+
+### 1.2.11 (2022-05-28)
+
+Fixes:
+
+-   fix: win net isolation check
+
+### 1.2.10 (2022-05-28)
+
+Fixes:
+
+-   fix: browser width, height
+
+### 1.2.9 (2022-05-28)
+
+Fixes:
+
+-   fix: browser app mode
+
+### 1.2.8 (2022-05-28)
+
+Fixes:
+
+-   fix: browser support
+
+### 1.2.7 (2022-05-19)
+
+Fixes:
+
+-   fix: windows elevation error handle
+
+### 1.2.6 (2022-05-19)
+
+Fixes:
+
+-   fix: windows elevation error handle
+
+### 1.2.5 (2022-05-19)
+
+Fixes:
+
+-   fix: windows elevation error handle
+
+### 1.2.4 (2022-05-19)
+
+Fixes:
+
+-   fix: error message on windows
+
+### 1.2.3 (2022-05-19)
+
+Fixes:
+
+-   fix: use laucher under windows
+
+### 1.2.2 (2022-05-18)
+
+Fixes:
+
+-   fix: windows launcher
+
+### 1.2.1 (2022-04-23)
+
+Fixes:
+
+-   fix: windows isolation patch removed
+
+### 1.2.0 (2022-04-21)
+
+Features:
+
+-   feat: abort signal support
+
+Fixes:
+
+-   fix: spawn typo
+
+### 1.1.2 (2022-04-16)
+
+Fixes:
+
+-   fix: win32 loopback
+
+### 1.1.1 (2022-04-16)
+
+Fixes:
+
+-   fix: docs
+
+### 1.1.0 (2022-04-16)
+
+Features:
+
+-   feat: close events
+
+### 1.0.0 (2022-04-16)
+
+Fixes:
+
+-   fix: build
+
+Migration:

package/README.md

@@ -0,0 +1,52 @@
+<!-- !!! DO NOT EDIT, THIS FILE IS GENERATED AUTOMATICALLY !!!  -->
+
+> :information_source: Please, see the full project documentation here: [https://softvisio.github.io/webview/](https://softvisio.github.io/webview/).
+
+# Introduction
+
+`NodeJS` wrapper for [webview](https://github.com/webview/webview).
+
+Compiled binaries: [suchipi/webview](https://github.com/suchipi/webview).
+
+## Install
+
+```shell
+npm i @softvisio/webview
+```
+
+## Usage
+
+```javascript
+import WebView from "@softvisio/webview";
+
+const webView = new WebView("https://example.com/", { title: "Example", width: 400, height: 400 });
+
+webView.on("close", () => {});
+
+webView.close();
+```
+
+## Notes
+
+### Windows
+
+On windows, the webview will not be able to access localhost unless the following command has been run as administrator at least once before:
+
+```shell
+checknetisolation.exe LoopbackExempt -a -n=Microsoft.Win32WebViewHost_cw5n1h2txyewy
+```
+
+```shell
+curl -sSLO https://dist.nuget.org/win-x86-commandline/latest/nuget.exe
+nuget.exe install Microsoft.Web.Webview2 -OutputDirectory script
+
+cl -DSFML_STATIC /std:c++17 /EHsc /I script\Microsoft.Web.WebView2.1.0.1185.39\build\native\include script\Microsoft.Web.WebView2.1.0.1185.39\build\native\x64\WebView2Loader.dll.lib main.cc /link /out:webview.exe
+```
+
+### Linux
+
+On Linux, you need to install GTK3 and GtkWebkit2.
+
+```shell
+sudo apt-get install libwebkit2gtk-4.0-dev
+```

package/docs/.docs.config.yaml

@@ -0,0 +1,5 @@
+logo: false
+
+externalTypes:
+  - https://softvisio.github.io/core/
+  - https://softvisio.github.io/result/

package/docs/README.md

@@ -0,0 +1,48 @@
+# Introduction
+
+`NodeJS` wrapper for [webview](https://github.com/webview/webview).
+
+Compiled binaries: [suchipi/webview](https://github.com/suchipi/webview).
+
+## Install
+
+```shell
+npm i @softvisio/webview
+```
+
+## Usage
+
+```javascript
+import WebView from "@softvisio/webview";
+
+const webView = new WebView("https://example.com/", { title: "Example", width: 400, height: 400 });
+
+webView.on("close", () => {});
+
+webView.close();
+```
+
+## Notes
+
+### Windows
+
+On windows, the webview will not be able to access localhost unless the following command has been run as administrator at least once before:
+
+```shell
+checknetisolation.exe LoopbackExempt -a -n=Microsoft.Win32WebViewHost_cw5n1h2txyewy
+```
+
+```shell
+curl -sSLO https://dist.nuget.org/win-x86-commandline/latest/nuget.exe
+nuget.exe install Microsoft.Web.Webview2 -OutputDirectory script
+
+cl -DSFML_STATIC /std:c++17 /EHsc /I script\Microsoft.Web.WebView2.1.0.1185.39\build\native\include script\Microsoft.Web.WebView2.1.0.1185.39\build\native\x64\WebView2Loader.dll.lib main.cc /link /out:webview.exe
+```
+
+### Linux
+
+On Linux, you need to install GTK3 and GtkWebkit2.
+
+```shell
+sudo apt-get install libwebkit2gtk-4.0-dev
+```

package/docs/_sidebar.md

@@ -0,0 +1,11 @@
+-   [Introduction](/)
+
+**API**
+
+-   [Introduction](/api.md)
+-   [API v1](/api-v1.md)
+-   [RPC v1](/rpc-v1.md)
+
+**Links**
+
+-   [Changelog](/changelog)

package/docs/index.html

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+
+<!-- !!! DO NOT EDIT, THIS FILE IS GENERATED AUTOMATICALLY !!!  -->
+
+<html>
+    <head>
+        <meta charset="UTF-8" />
+        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+        <meta name="viewport" content="width=device-width,initial-scale=1" />
+
+        <link rel="stylesheet" id="lightTheme" href="https://cdn.jsdelivr.net/npm/docsify-themeable/dist/css/theme-simple.css" />
+        <link rel="stylesheet" id="darkTheme" href="https://cdn.jsdelivr.net/npm/docsify-themeable/dist/css/theme-simple-dark.css" />
+        <link rel="stylesheet" href="https://softvisio.github.io/cli/assets/theme/theme.css" />
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free/css/all.min.css" />
+    </head>
+    <body>
+        <nav>
+            <a href="#/changelog">Changelog</a> • <a href="https://github.com/softvisio/webview/discussions" title="Discussions"><i class="fa-regular fa-comments"></i></a> • <a href="https://github.com/softvisio/webview/issues" title="Issues"><i class="fa-solid fa-bug"></i></a> • <a href="https://www.npmjs.com/package/@softvisio/webview" title="NPM package"><i class="fa-brands fa-npm"></i></a> • <a href="#toggleTheme"><i class="fa-solid fa-adjust"></i> Theme</a>
+        </nav>
+        <div id="app"></div>
+        <div id="gotoTop"><a href="#gotoTop">🡡 Top</a></div>
+
+        <script>
+            window.$docsify = { alias: { "/changelog": "https://raw.githubusercontent.com/softvisio/webview/master/CHANGELOG.md" }, auto2top: true, externalLinkTarget: "_self", loadSidebar: true, maxLevel: 2, name: "@softvisio/webview", relativePath: true, repo: "https://github.com/softvisio/webview", search: { depth: 3 }, subMaxLevel: 2, tabs: {} };
+        </script>
+
+        <script src="https://softvisio.github.io/cli/assets/theme/theme.js"></script>
+        <script src="https://cdn.jsdelivr.net/npm/docsify"></script>
+        <script src="https://cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
+        <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+        <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>
+        <script src="https://cdn.jsdelivr.net/npm/docsify-tabs"></script>
+        <script src="https://cdn.jsdelivr.net/npm/docsify-copy-code"></script>
+        <script src="https://cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
+        <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/external-script.min.js"></script>
+    </body>
+</html>

package/lib/binaries/win32/elevation-required.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>Elevated permissions are required</title>
+        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+        <meta name="title" content="" />
+        <meta name="keywords" content="" />
+        <meta name="description" content="" />
+        <meta name="robots" content="" />
+        <meta http-equiv="Content-Script-Type" content="text/javascript" />
+        <meta http-equiv="Content-Style-Type" content="text/css" />
+    </head>
+    <body>
+        <h2>Elevated permissions are required</h2>
+        <p>
+            Microsoft webview requires elevated permissions to access localhost.
+            <br />
+            Please, run it with the evevated permissions or run following command manually as administrator to allow access to the localhost for webview (this is required one time only):
+        </p>
+        <code>CheckNetIsolation.exe LoopbackExempt -a -n="Microsoft.Win32WebViewHost_cw5n1h2txyewy"</code>
+    </body>
+</html>

package/lib/index.js

@@ -0,0 +1,145 @@
+import Events from "node:events";
+import childProcess from "node:child_process";
+import fs from "node:fs";
+
+const BINARIES = {
+    "win32": "webview.exe",
+    "linux": "webview",
+    "darwin": "webview",
+};
+
+var BROWSER, WIN32_NET_ISOLATION;
+
+export default class WebView extends Events {
+    #proc;
+
+    constructor ( url, { title, width, height, maximized = true, signal, dataDir, forceWebView } = {} ) {
+        super();
+
+        if ( !( url instanceof URL ) ) url = new URL( url );
+
+        var command, args;
+
+        // browser
+        BROWSER: if ( !forceWebView ) {
+            if ( process.platform === "win32" ) {
+                if ( BROWSER == null ) {
+                    BROWSER = false;
+
+                    const locations = [
+
+                        //
+                        process.env["LocalAppData"] + "/Google/Chrome/Application/chrome.exe",
+                        process.env["ProgramFiles(x86)"] + "/Google/Chrome/Application/chrome.exe",
+                        process.env["ProgramFiles"] + "/Google/Chrome/Application/chrome.exe",
+                        process.env["ProgramFiles(x86)"] + "/Microsoft/Edge/Application/msedge.exe",
+                    ];
+
+                    for ( const location of locations ) {
+                        if ( fs.existsSync( location ) ) {
+                            BROWSER = location;
+
+                            break;
+                        }
+                    }
+                }
+
+                if ( !BROWSER ) break BROWSER;
+
+                command = BROWSER;
+
+                args = [
+
+                    //
+                    "--new-window",
+                    "--no-first-run",
+                    ...( dataDir ? [`--user-data-dir=${dataDir}`] : [] ),
+                    "--app=" + url,
+                ];
+
+                if ( width || height ) {
+                    args.push( `--window-size=${width || 100000},${height || 100000}` );
+                }
+                else if ( maximized ) {
+                    args.push( "--start-maximized" );
+                }
+            }
+        }
+
+        // webview
+        if ( !command ) {
+            if ( process.platform === "win32" && ( url.hostname === "localhost" || url.hostname.startsWith( "127." ) ) && !WIN32_NET_ISOLATION ) {
+                if ( WIN32_NET_ISOLATION == null ) {
+                    if ( !this.#checkWindowsNetIsolation() ) {
+
+                        // set loopback net isolation
+                        childProcess.execFileSync( "hstart.exe", ["/ELEVATE", "/NOCONSOLE", "checknetisolation.exe LoopbackExempt -a -n=Microsoft.Win32WebViewHost_cw5n1h2txyewy"], {
+                            "cwd": new URL( `binaries/${process.platform}`, import.meta.url ),
+                            "windowsHide": true,
+                            "encoding": "utf8",
+                        } );
+
+                        if ( !this.#checkWindowsNetIsolation() ) {
+                            WIN32_NET_ISOLATION = false;
+                        }
+                        else {
+                            WIN32_NET_ISOLATION = true;
+                        }
+                    }
+                    else {
+                        WIN32_NET_ISOLATION = true;
+                    }
+                }
+
+                if ( !WIN32_NET_ISOLATION ) {
+                    console.log( `Unable to start webview, elevated permissions are required (https://github.com/webview/webview/issues/599)` );
+
+                    url = new URL( `binaries/${process.platform}/elevation-required.html`, import.meta.url );
+                }
+            }
+
+            command = BINARIES[process.platform];
+
+            args = ["--url", url];
+            if ( title ) args.push( "--title", title );
+            if ( width ) args.push( "--width", width );
+            if ( height ) args.push( "--height", height );
+        }
+
+        this.#proc = childProcess
+            .spawn( command, args, {
+                "cwd": new URL( `binaries/${process.platform}`, import.meta.url ),
+                "stdio": "ignore",
+                signal,
+            } )
+            .once( "error", e => {
+                if ( e.code !== "ABORT_ERR" ) throw e;
+            } )
+            .once( "close", () => {
+                this.#proc = null;
+
+                this.emit( "close" );
+            } );
+    }
+
+    // properties
+    isStarted () {
+        return !!this.#proc;
+    }
+
+    close () {
+        if ( !this.#proc ) return;
+        this.#proc.kill();
+
+        this.#proc = null;
+    }
+
+    #checkWindowsNetIsolation () {
+        const stdout = childProcess.execFileSync( "checknetisolation.exe", ["LoopbackExempt", "-s"], {
+            "windowsHide": true,
+            "encoding": "utf8",
+        } );
+
+        return stdout.includes( "microsoft.win32webviewhost_cw5n1h2txyewy" );
+    }
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+    "name": "@softvisio/webview",
+    "version": "1.2.12",
+    "description": "Webview bindings",
+    "keywords": [
+        "softvisio",
+        "webview"
+    ],
+    "homepage": "https://softvisio.github.io/webview/",
+    "bugs": {
+        "url": "https://github.com/softvisio/webview/issues",
+        "email": "zdm <zdm@softvisio.net>"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/softvisio/webview.git"
+    },
+    "license": "ISC",
+    "author": "zdm <zdm@softvisio.net>",
+    "type": "module",
+    "imports": {
+        "#lib/*": "./lib/*.js"
+    },
+    "exports": {
+        ".": "./lib/index.js"
+    }
+}