muon-ui 0.8.0 → 0.9.0

package/README.md

@@ -11,9 +11,6 @@ A multi-platform GUI application framework that uses CEF as its backend.
 
 ## What is This?
 
-WIP: This project is still in a very early prototype phase.
-I intend to complete it, but please note that it is not yet at the stage of active implementation.
-
 Have you ever thought about how to update an outdated native GUI application into a modern one?
 Replacing applications is extremely complex and has always been a challenge for us.
 
@@ -45,7 +42,7 @@ It also features a plugin system that supports fully asynchronous processing, en
 Since these features become available based on pre-configured settings, there's no risk of unused functionality running unchecked.
 
 Since it's CEF-based, you can naturally use features expected in Chromium, such as WebGL, WebGPU, WebAssembly, Web Workers, and Local Storage.
-You can also display Chromium DevTools. Because it supports CDP (Chrome DevTools Protocol), you can debug using tools like VS Code or connect and control it via Playwright.
+You can also display DevTools. Because it supports CDP (Chromium DevTools Protocol), you can debug using tools like VS Code or connect and control it via Playwright.
 You can also use remote DevTools from Chromium/Chrome via `chrome://inspect/`.
 
 In short, by clearly eliminating one of the major issues that arise when migrating native GTK/Qt/Windows applications to web applications,
@@ -54,17 +51,16 @@ you can develop modern local GUI applications using the web-based technology eco
 ### Features
 
 - By restricting all network access with a whitelist filter, you can completely block problematic content.
-- It is provided as an easy-to-use NPM package, allowing you to easily turn your web application project into a native GUI application.
-  No complex configuration or modifications are required.
-- The browser responsible for rendering is CEF (Chromium Embedded Framework).
-  This means that, from the perspective of your web application, it is virtually equivalent to using Chromium or Chrome.
-- Supports Vite plugins (optional). With support for Vite’s HMR, you can update previews in real time during development.
-- Provides `muon dev` for launching local development assets directly without starting an HTTP server.
-- Linux desktop launcher and icon metadata can be bundled at distribution build time.
-- You can use Chromium DevTools. Furthermore, because it supports CDP (Chromium DevTools Protocol), you can perform remote debugging from an external source.
+- It is provided as an easy-to-use NPM package, allowing you to easily turn your web application project into a native GUI application. No complex configuration or modifications are required.
+- The browser responsible for rendering is CEF (Chromium Embedded Framework). This means that, from the perspective of the web application, it is virtually equivalent to using Chromium or Chrome.
+- It supports Vite plugins. Since it supports Vite’s HMR, you can preview real-time updates during development.
+- With `muon run`, you can launch a development environment that uses local assets directly without starting an HTTP server.
+- You can include the Linux desktop launcher and icon metadata in your distribution build.
+- You can use DevTools. Furthermore, since it supports CDP (Chromium DevTools Protocol), you can perform remote debugging from an external source.
 - You can display multiple browser windows. Browser windows can also be organized into a parent-child hierarchy.
-- It features a plugin system. Additionally, plugin functionality can be restricted using a whitelist filter.
+- It features a plugin system. Plugin functionality can be restricted using a whitelist filter.
 - Using built-in plugins, you can access local files, open dialogs, launch child processes, and manipulate windows.
+- It supports packages for Linux (deb) and Windows (NSIS), as well as portable operation.
 
 ### Environment
 

package/dist/cli.cjs

@@ -1,14 +1,14 @@
 #!/usr/bin/env node
 /*!
 * name: muon-ui
-* version: 0.8.0
+* version: 0.9.0
 * description: A multi-platform GUI application framework that uses CEF as its backend
 * author: Kouji Matsui (@kekyo@mi.kekyo.net)
 * license: MIT
 * repository.url: https://github.com/kekyo/muon-ui.git
-* git.commit.hash: 9bb6148e155dab16c4ca441073b144e21981b038
+* git.commit.hash: 3437b522a51d8772713b72722b109c5ff30fc711
 */
-const require_vite_internals = require("./vite-internals-ChWiL2TL.cjs");
+const require_vite_internals = require("./vite-internals-HXgH7b5M.cjs");
 let commander = require("commander");
 let node_child_process = require("node:child_process");
 let node_fs = require("node:fs");
@@ -130,9 +130,9 @@ var assertDevelopmentAssetDirectory = async (assetSourcePath) => {
 	try {
 		await (0, node_fs_promises.access)(assetSourcePath, node_fs.constants.F_OK);
 	} catch {
-		throw new Error(`Muon dev asset source does not exist: ${assetSourcePath}`);
+		throw new Error(`Muon run asset source does not exist: ${assetSourcePath}`);
 	}
-	throw new Error(`Muon dev asset source must be a directory: ${assetSourcePath}`);
+	throw new Error(`Muon run asset source must be a directory: ${assetSourcePath}`);
 };
 var resolveAssetSource = async (root, assetSourcePath, projectConfig) => {
 	const configuredAssetSourcePath = readConfigAssetSourcePath(projectConfig.config);
@@ -215,7 +215,7 @@ var runMuonDev = async (options = {}) => {
 	const enableDebugger = options.enableDebugger ?? pluginOptions?.enableDebugger ?? true;
 	const projectConfig = await resolveProjectConfig(root, options.configPath);
 	const asset = await resolveAssetSource(root, options.assetSourcePath, projectConfig);
-	const overrideConfigPath = (0, node_path.join)(root, ".muon", "dev", "muon.dev.json");
+	const overrideConfigPath = (0, node_path.join)(root, ".muon", "run", "muon.run.json");
 	await require_vite_internals.ensureMuonGitignoreEntry(root);
 	const preparedRuntime = await require_vite_internals.runMuonPrepare({
 		muonPath,
@@ -516,22 +516,24 @@ var packageDeb = async (root, target, metadata, artifactsRoot, packageBuildRoot,
 var escapeNsis = (value) => value.replaceAll("\\", "\\\\").replaceAll("\"", "$\\\"");
 var nsisUninstallRegistryRoot = "Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall";
 var createNsisUninstallRegistryKey = (appId) => `${nsisUninstallRegistryRoot}\\${appId}`;
-var packageNsis = async (root, target, metadata, appId, windowsResource, artifactsRoot, packageBuildRoot, environment) => {
+var packageNsis = async (root, target, metadata, windowsResource, artifactsRoot, packageBuildRoot, environment) => {
 	const descriptor = require_vite_internals.getMuonTargetDescriptor(target.target);
 	if (descriptor.os !== "windows") throw new Error(`Unsupported nsis target: ${target.target}`);
 	const scriptPath = (0, node_path.join)(packageBuildRoot, "nsis", `${metadata.packageName}-${target.target}.nsi`);
 	const outputPath = (0, node_path.join)(artifactsRoot, `${metadata.packageName}-${metadata.version}-${descriptor.arch}-setup.exe`);
 	const launcherFileName = (0, node_path.basename)(target.launcherPath);
-	const uninstallRegistryKey = createNsisUninstallRegistryKey(appId);
+	const nsisDisplayName = `${metadata.packageName} (${descriptor.arch})`;
+	const nsisInstallDirectoryName = `${metadata.packageName}-${descriptor.arch}`;
+	const uninstallRegistryKey = createNsisUninstallRegistryKey(target.runtimeAppId);
 	await (0, node_fs_promises.mkdir)((0, node_path.dirname)(scriptPath), { recursive: true });
 	await (0, node_fs_promises.mkdir)((0, node_path.dirname)(outputPath), { recursive: true });
-	const iconPath = windowsResource.iconPath === void 0 ? void 0 : (0, node_path.join)((0, node_path.dirname)(scriptPath), `${metadata.packageName}-${target.target}.ico`);
-	if (windowsResource.iconPath !== void 0 && iconPath !== void 0) await require_vite_internals.createWindowsIconFromPngFile(windowsResource.iconPath, iconPath);
+	const iconPath = (0, node_path.join)((0, node_path.dirname)(scriptPath), `${metadata.packageName}-${target.target}.ico`);
+	await require_vite_internals.createWindowsIconFromPngFile(windowsResource.iconPath, iconPath);
 	await (0, node_fs_promises.writeFile)(scriptPath, [
 		"Unicode true",
-		`Name "${escapeNsis(metadata.packageName)}"`,
+		`Name "${escapeNsis(nsisDisplayName)}"`,
 		`OutFile "${escapeNsis(outputPath)}"`,
-		`InstallDir "$LOCALAPPDATA\\Programs\\${escapeNsis(metadata.packageName)}"`,
+		`InstallDir "$LOCALAPPDATA\\Programs\\${escapeNsis(nsisInstallDirectoryName)}"`,
 		"RequestExecutionLevel user",
 		"ShowInstDetails nevershow",
 		"AutoCloseWindow true",
@@ -540,9 +542,9 @@ var packageNsis = async (root, target, metadata, appId, windowsResource, artifac
 		"Section",
 		"  SetOutPath \"$INSTDIR\"",
 		`  File /r "${escapeNsis(target.outputPath)}\\*"`,
-		`  CreateShortCut "$SMPROGRAMS\\${escapeNsis(metadata.packageName)}.lnk" "$INSTDIR\\${escapeNsis(launcherFileName)}"`,
+		`  CreateShortCut "$SMPROGRAMS\\${escapeNsis(nsisDisplayName)}.lnk" "$INSTDIR\\${escapeNsis(launcherFileName)}"`,
 		"  WriteUninstaller \"$INSTDIR\\Uninstall.exe\"",
-		`  WriteRegStr HKCU "${escapeNsis(uninstallRegistryKey)}" "DisplayName" "${escapeNsis(metadata.packageName)}"`,
+		`  WriteRegStr HKCU "${escapeNsis(uninstallRegistryKey)}" "DisplayName" "${escapeNsis(nsisDisplayName)}"`,
 		`  WriteRegStr HKCU "${escapeNsis(uninstallRegistryKey)}" "DisplayVersion" "${escapeNsis(metadata.version)}"`,
 		`  WriteRegStr HKCU "${escapeNsis(uninstallRegistryKey)}" "Publisher" "${escapeNsis(metadata.author)}"`,
 		`  WriteRegStr HKCU "${escapeNsis(uninstallRegistryKey)}" "InstallLocation" "$INSTDIR"`,
@@ -554,10 +556,10 @@ var packageNsis = async (root, target, metadata, appId, windowsResource, artifac
 		"SectionEnd",
 		"",
 		"Section \"Uninstall\"",
-		`  Delete "$SMPROGRAMS\\${escapeNsis(metadata.packageName)}.lnk"`,
+		`  Delete "$SMPROGRAMS\\${escapeNsis(nsisDisplayName)}.lnk"`,
 		`  DeleteRegKey HKCU "${escapeNsis(uninstallRegistryKey)}"`,
 		"  RMDir /r \"$INSTDIR\"",
-		`  RMDir /r "$LOCALAPPDATA\\${escapeNsis(appId)}"`,
+		`  RMDir /r "$LOCALAPPDATA\\${escapeNsis(target.runtimeAppId)}"`,
 		"SectionEnd",
 		"",
 		"Function .onInstSuccess",
@@ -577,10 +579,8 @@ var packageNsis = async (root, target, metadata, appId, windowsResource, artifac
 };
 var createNsisResourceDirectives = (resource, iconPath) => {
 	const lines = [];
-	if (iconPath !== void 0) {
-		lines.push(`Icon "${escapeNsis(iconPath)}"`);
-		lines.push(`UninstallIcon "${escapeNsis(iconPath)}"`);
-	}
+	lines.push(`Icon "${escapeNsis(iconPath)}"`);
+	lines.push(`UninstallIcon "${escapeNsis(iconPath)}"`);
 	lines.push(`VIProductVersion "${escapeNsis(resource.fixedVersion)}"`);
 	lines.push(`VIFileVersion "${escapeNsis(resource.fixedVersion)}"`);
 	lines.push(`VIAddVersionKey /LANG=${resource.language} "CompanyName" "${escapeNsis(resource.companyName)}"`);
@@ -592,12 +592,23 @@ var createNsisResourceDirectives = (resource, iconPath) => {
 	return lines;
 };
 var reapplyPackWindowsResources = async (targets, resource, root, environment) => {
-	for (const target of targets) if (require_vite_internals.getMuonTargetDescriptor(target.target).os === "windows") await require_vite_internals.updateWindowsPeResources({
-		executablePath: target.launcherPath,
-		resource,
-		environment,
-		cwd: root
-	});
+	for (const target of targets) {
+		const descriptor = require_vite_internals.getMuonTargetDescriptor(target.target);
+		if (descriptor.os === "windows") {
+			await require_vite_internals.updateWindowsPeIconResource({
+				executablePath: (0, node_path.join)(target.outputPath, descriptor.runtimeExecutableName),
+				resource,
+				environment,
+				cwd: root
+			});
+			await require_vite_internals.updateWindowsPeResources({
+				executablePath: target.launcherPath,
+				resource,
+				environment,
+				cwd: root
+			});
+		}
+	}
 };
 /**
 * Runs the Muon build sequence and creates redistributable packages.
@@ -624,7 +635,9 @@ var packMuonApp = async (options) => {
 	};
 	const windowsResourceOptions = require_vite_internals.mergeMuonWindowsResourceOptions(options.windowsResource, pluginBuildOptions.windowsResource);
 	const linuxDesktopOptions = require_vite_internals.mergeMuonLinuxDesktopOptions(options.linuxDesktop, pluginBuildOptions.linuxDesktop);
+	const iconPath = options.iconPath ?? pluginBuildOptions.iconPath;
 	if (options.configPath !== void 0) buildOptions.configPath = options.configPath;
+	if (iconPath !== void 0) buildOptions.iconPath = iconPath;
 	if (options.appName !== void 0) buildOptions.appName = options.appName;
 	if (options.appId !== void 0) buildOptions.appId = options.appId;
 	if (options.packageDirectory !== void 0) buildOptions.packageDirectory = options.packageDirectory;
@@ -638,6 +651,7 @@ var packMuonApp = async (options) => {
 		muonConfig: windowsResourceConfig.config,
 		muonConfigDirectory: windowsResourceConfig.directory,
 		options: windowsResourceOptions,
+		appIconPath: iconPath,
 		defaults: {
 			productName: metadata.packageName,
 			fileDescription: metadata.description,
@@ -666,7 +680,7 @@ var packMuonApp = async (options) => {
 	for (const target of build.targets) for (const type of typesByTarget.get(target.target) ?? []) if (type === "zip") artifacts.push(await packageZip(target, metadata, artifactsRoot));
 	else if (type === "tar.gz") artifacts.push(await packageTarGz(target, metadata, artifactsRoot));
 	else if (type === "deb") artifacts.push(await packageDeb(root, target, metadata, artifactsRoot, packageBuildRoot, environment));
-	else artifacts.push(await packageNsis(root, target, metadata, build.appId, windowsResource, artifactsRoot, packageBuildRoot, environment));
+	else artifacts.push(await packageNsis(root, target, metadata, windowsResource, artifactsRoot, packageBuildRoot, environment));
 	return {
 		root,
 		packageName: metadata.packageName,
@@ -680,8 +694,8 @@ var packMuonApp = async (options) => {
 };
 //#endregion
 //#region src/generated/packageMetadata.ts
-var version = "0.8.0";
-var git_commit_hash = "9bb6148e155dab16c4ca441073b144e21981b038";
+var version = "0.9.0";
+var git_commit_hash = "3437b522a51d8772713b72722b109c5ff30fc711";
 //#endregion
 //#region src/cli.ts
 var readTargetValues = (value) => {
@@ -738,6 +752,7 @@ var runBuildCommand = async (commandOptions) => {
 	if (commandOptions.all === true) buildOptions.allTargets = true;
 	if (commandOptions.assets !== void 0) buildOptions.assetSourcePath = commandOptions.assets;
 	if (commandOptions.config !== void 0) buildOptions.configPath = commandOptions.config;
+	if (commandOptions.icon !== void 0) buildOptions.iconPath = commandOptions.icon;
 	const windowsResource = createWindowsResourceOptions(commandOptions);
 	if (windowsResource !== void 0) buildOptions.windowsResource = windowsResource;
 	const linuxDesktop = createLinuxDesktopOptions(commandOptions);
@@ -761,6 +776,7 @@ var runPackCommand = async (commandOptions) => {
 	if (targets.length > 0) packOptions.targets = targets;
 	if (commandOptions.all !== void 0) packOptions.allTargets = commandOptions.all;
 	if (commandOptions.config !== void 0) packOptions.configPath = commandOptions.config;
+	if (commandOptions.icon !== void 0) packOptions.iconPath = commandOptions.icon;
 	const windowsResource = createWindowsResourceOptions(commandOptions);
 	if (windowsResource !== void 0) packOptions.windowsResource = windowsResource;
 	const linuxDesktop = createLinuxDesktopOptions(commandOptions);
@@ -852,13 +868,13 @@ var createCliCommand = () => {
 		program.outputHelp({ error: true });
 		process.exitCode = 1;
 	});
-	program.command("build").description("Build CEF-free Muon app distribution directories").option("--target <target>", "public target or comma-separated public targets", appendTargetValues, []).option("--all", "build all supported targets").option("--assets <path>", "asset root path").option("--config <path>", "muon config path").option("--windows-icon <path>", "Windows PNG icon resource path").option("--windows-product-name <name>", "Windows product name").option("--windows-file-description <text>", "Windows file description").option("--windows-company-name <name>", "Windows company name").option("--windows-version <version>", "Windows resource version").option("--windows-copyright <text>", "Windows legal copyright").option("--linux-desktop-id <id>", "Linux desktop entry identifier").option("--linux-name <name>", "Linux desktop display name").option("--linux-comment <text>", "Linux desktop comment").option("--linux-icon <path>", "Linux desktop PNG icon path").option("--linux-categories <list>", "Linux desktop categories").option("--linux-startup-notify <boolean>", "Linux startup notification").option("--out-dir <path>", "output root directory").option("--name <name>", "launcher file name").option("--app-id <id>", "stable application identifier").option("--package-directory <path>", "Muon package dist directory").option("--json", "write result as JSON").action(async (options) => {
+	program.command("build").description("Build CEF-free Muon app distribution directories").option("--target <target>", "public target or comma-separated public targets", appendTargetValues, []).option("--all", "build all supported targets").option("--assets <path>", "asset root path").option("--config <path>", "muon config path").option("--icon <path>", "static application PNG icon path").option("--windows-icon <path>", "Windows PNG icon resource path").option("--windows-product-name <name>", "Windows product name").option("--windows-file-description <text>", "Windows file description").option("--windows-company-name <name>", "Windows company name").option("--windows-version <version>", "Windows resource version").option("--windows-copyright <text>", "Windows legal copyright").option("--linux-desktop-id <id>", "Linux desktop entry identifier").option("--linux-name <name>", "Linux desktop display name").option("--linux-comment <text>", "Linux desktop comment").option("--linux-icon <path>", "Linux desktop PNG icon path").option("--linux-categories <list>", "Linux desktop categories").option("--linux-startup-notify <boolean>", "Linux startup notification").option("--out-dir <path>", "output root directory").option("--name <name>", "launcher file name").option("--app-id <id>", "stable application identifier").option("--package-directory <path>", "Muon package dist directory").option("--json", "write result as JSON").action(async (options) => {
 		await runBuildCommand(options);
 	});
-	program.command("pack").description("Build and package a Muon app").option("--type <type>", "package type or comma-separated package types: zip, tar.gz, tgz, deb, nsis (default: all)", appendPackTypeValues).option("--target <target>", "public target, platform, arch, or comma-separated selectors", appendTargetValues, []).option("--all", "build all supported targets").option("--config <path>", "muon config path").option("--windows-icon <path>", "Windows PNG icon resource path").option("--windows-product-name <name>", "Windows product name").option("--windows-file-description <text>", "Windows file description").option("--windows-company-name <name>", "Windows company name").option("--windows-version <version>", "Windows resource version").option("--windows-copyright <text>", "Windows legal copyright").option("--linux-desktop-id <id>", "Linux desktop entry identifier").option("--linux-name <name>", "Linux desktop display name").option("--linux-comment <text>", "Linux desktop comment").option("--linux-icon <path>", "Linux desktop PNG icon path").option("--linux-categories <list>", "Linux desktop categories").option("--linux-startup-notify <boolean>", "Linux startup notification").option("--name <name>", "launcher file name").option("--app-id <id>", "stable application identifier").option("--package-directory <path>", "Muon package dist directory").option("--artifacts-dir <path>", "package artifact output directory").option("--package-name <name>", "package name override").option("--package-version <version>", "package version override").option("--description <text>", "package description override").option("--author <text>", "package author override").option("--json", "write result as JSON").action(async (options) => {
+	program.command("pack").description("Build and package a Muon app").option("--type <type>", "package type or comma-separated package types: zip, tar.gz, tgz, deb, nsis (default: all)", appendPackTypeValues).option("--target <target>", "public target, platform, arch, or comma-separated selectors", appendTargetValues, []).option("--all", "build all supported targets").option("--config <path>", "muon config path").option("--icon <path>", "static application PNG icon path").option("--windows-icon <path>", "Windows PNG icon resource path").option("--windows-product-name <name>", "Windows product name").option("--windows-file-description <text>", "Windows file description").option("--windows-company-name <name>", "Windows company name").option("--windows-version <version>", "Windows resource version").option("--windows-copyright <text>", "Windows legal copyright").option("--linux-desktop-id <id>", "Linux desktop entry identifier").option("--linux-name <name>", "Linux desktop display name").option("--linux-comment <text>", "Linux desktop comment").option("--linux-icon <path>", "Linux desktop PNG icon path").option("--linux-categories <list>", "Linux desktop categories").option("--linux-startup-notify <boolean>", "Linux startup notification").option("--name <name>", "launcher file name").option("--app-id <id>", "stable application identifier").option("--package-directory <path>", "Muon package dist directory").option("--artifacts-dir <path>", "package artifact output directory").option("--package-name <name>", "package name override").option("--package-version <version>", "package version override").option("--description <text>", "package description override").option("--author <text>", "package author override").option("--json", "write result as JSON").action(async (options) => {
 		await runPackCommand(options);
 	});
-	const devCommand = program.command("dev").description("Launch Muon directly with local development assets").option("--muon-path <path>", "Muon runtime file root").option("--cef-path <path>", "CEF file root").option("--stage-dir <path>", "prepared runtime output directory").option("--config <path>", "muon config path").option("--assets <path>", "development asset directory").option("--no-debugger", "disable Muon debugger defaults").option("--json", "write result as JSON").action(async (options) => {
+	const devCommand = program.command("run").description("Launch Muon directly with local development assets").option("--muon-path <path>", "Muon runtime file root").option("--cef-path <path>", "CEF file root").option("--stage-dir <path>", "prepared runtime output directory").option("--config <path>", "muon config path").option("--assets <path>", "development asset directory").option("--no-debugger", "disable Muon debugger defaults").option("--json", "write result as JSON").action(async (options) => {
 		await runDevCommand(options, devCommand);
 	});
 	program.command("init").description("Initialize Muon project helper files").action(async () => {