@gtkx/cli 1.2.0 → 1.2.1

package/src/deploy/targets/flatpak-manifest.ts

@@ -12,10 +12,76 @@ const DEFAULT_RUNTIME_VERSION = "50";
 const DEFAULT_SDK = "org.gnome.Sdk";
 const DEFAULT_FINISH_ARGS = ["--share=ipc", "--socket=wayland", "--socket=fallback-x11", "--device=dri"];
 const DEFAULT_CLEANUP = ["/include", "/share/pkgconfig", "*.la", "*.a"];
+const DISPLAY_SOCKETS = ["fallback-x11", "wayland", "x11"];
+const SOCKET_ARG = "--socket=";
+const NO_SOCKET_ARG = "--nosocket=";
+
+const NEGATED_ARGS: [string, string][] = [
+    ["--device=", "--nodevice="],
+    ["--share=", "--unshare="],
+    [SOCKET_ARG, NO_SOCKET_ARG],
+];
 
 const branchFor = (settings: DeploySettings): string => settings.deploy.flatpak?.branch ?? DEFAULT_BRANCH;
 const isSourceMode = (settings: DeploySettings): boolean => settings.deploy.flatpak?.mode === "source";
 
+const negationFor = (arg: string): string | null => {
+    const negated = NEGATED_ARGS.find(([prefix]) => arg.startsWith(prefix));
+
+    if (negated === undefined) {
+        return null;
+    }
+
+    const [prefix, negation] = negated;
+
+    return `${negation}${arg.slice(prefix.length)}`;
+};
+
+const mergeArgs = (defaults: string[], overrides: string[]): string[] => {
+    const kept = defaults.filter((arg) => {
+        const negation = negationFor(arg);
+
+        return negation === null || !overrides.includes(negation);
+    });
+
+    return [...new Set([...kept, ...overrides])];
+};
+
+const finishArgsFor = (settings: DeploySettings): string[] =>
+    mergeArgs(DEFAULT_FINISH_ARGS, settings.deploy.flatpak?.finishArgs ?? []);
+
+const cleanupFor = (settings: DeploySettings): string[] => {
+    const cleanup = settings.deploy.flatpak?.cleanup;
+
+    if (cleanup === undefined) {
+        return DEFAULT_CLEANUP;
+    }
+
+    return cleanup.length === 0 ? [] : mergeArgs(DEFAULT_CLEANUP, cleanup);
+};
+
+const grantedSockets = (args: string[]): Set<string> => {
+    const granted: Set<string> = new Set();
+
+    for (const arg of args) {
+        if (arg.startsWith(SOCKET_ARG)) {
+            granted.add(arg.slice(SOCKET_ARG.length));
+        }
+
+        if (arg.startsWith(NO_SOCKET_ARG)) {
+            granted.delete(arg.slice(NO_SOCKET_ARG.length));
+        }
+    }
+
+    return granted;
+};
+
+const hasDisplaySocket = (args: string[]): boolean => {
+    const granted = grantedSockets(args);
+
+    return DISPLAY_SOCKETS.some((socket) => granted.has(socket));
+};
+
 const sdkExtensionsFor = (settings: DeploySettings): string[] => {
     const flatpak = settings.deploy.flatpak ?? {};
     const nodeExtension = isSourceMode(settings) ? [nodeExtensionFor(settings)] : [];
@@ -46,16 +112,15 @@ const runtimeKeys = (settings: DeploySettings): FlatpakManifest => {
 
 const renderFlatpakManifest = (payload: DeployPayload): FlatpakManifest => {
     const settings = payload.settings;
-    const flatpak = settings.deploy.flatpak ?? {};
 
     return {
         id: settings.applicationId,
         ...runtimeKeys(settings),
         command: settings.binaryName,
-        "finish-args": flatpak.finishArgs ?? DEFAULT_FINISH_ARGS,
-        cleanup: flatpak.cleanup ?? DEFAULT_CLEANUP,
+        "finish-args": finishArgsFor(settings),
+        cleanup: cleanupFor(settings),
         modules: modulesFor(payload),
     };
 };
 
-export { branchFor, renderFlatpakManifest };
+export { branchFor, finishArgsFor, hasDisplaySocket, renderFlatpakManifest };

package/src/deploy/targets/flatpak-source.ts

@@ -1,13 +1,19 @@
-import { posix, relative } from "node:path";
+import { existsSync, realpathSync } from "node:fs";
+import { posix, relative, resolve } from "node:path";
 import type { DeployPayload, DeploySettings } from "../types.js";
 import { listFilesRecursive } from "../../internal/list-files.js";
 import { BUNDLE_FILENAME } from "../../vite-plugins/esm-extension.js";
 import { renderDbusService } from "../freedesktop/dbus-service.js";
 import { renderDesktopEntry } from "../freedesktop/desktop-entry.js";
 import { renderMetainfo } from "../freedesktop/metainfo.js";
+import { renderMimePackage } from "../freedesktop/mime-package.js";
 import { optional } from "../nfpm/optional.js";
+import { renderNotices } from "../notices/render.js";
+import { executableModeFor } from "../payload/copy-tree.js";
 import { iconPathFor } from "../payload/icons.js";
 import { renderLauncher } from "../payload/launcher.js";
+import { licenseDestination, nodeLicenseDestination, NOTICES_FILENAME, noticesDestination } from "../payload/stage.js";
+import { isInside } from "../settings/paths.js";
 import { pnpmPathFor, type PnpmPin, pnpmSources } from "./flatpak-pnpm.js";
 import { DESTINATION, type FlatpakModule, postInstallCommands, validationCommands } from "./flatpak-prebuilt.js";
 import {
@@ -20,6 +26,12 @@ import {
     resolveGitSource,
 } from "./flatpak-sources.js";
 
+type InstalledFile = {
+    destination: string;
+    source: string;
+    resolved: string;
+};
+
 const LAUNCHER_FILENAME = "launcher.sh";
 const MODULE_BUILD_ROOT = "/run/build";
 const RUNTIME_PREFIX = "/app";
@@ -27,6 +39,7 @@ const NPM_CACHE_DIR = "flatpak-node/npm-cache";
 const YARN_MIRROR_DIR = "flatpak-node/yarn-mirror";
 const PLAIN_ARGUMENT = /^[\w./-]+$/;
 const QUOTE_ESCAPE = String.raw`'\''`;
+const OCTAL_RADIX = 8;
 
 const inlineSource = (fileName: string, contents: string): FlatpakModule => ({
     type: "inline",
@@ -74,6 +87,21 @@ const activationInstallCommands = (settings: DeploySettings): string[] =>
             )]
         : [];
 
+const mimeSources = (settings: DeploySettings): FlatpakModule[] => {
+    const contents = renderMimePackage(settings);
+
+    return contents === null ? [] : [inlineSource(`${settings.applicationId}.xml`, contents)];
+};
+
+const mimeInstallCommands = (settings: DeploySettings): string[] =>
+    settings.fileAssociations.length === 0
+        ? []
+        : [installCommand(
+                `${settings.applicationId}.xml`,
+                `${DESTINATION}/share/mime/packages/${settings.applicationId}.xml`,
+                "m644",
+            )];
+
 const metadataInstallCommands = (settings: DeploySettings): string[] => [
     installCommand(
         `${settings.applicationId}.desktop`,
@@ -86,6 +114,7 @@ const metadataInstallCommands = (settings: DeploySettings): string[] => [
         "m644",
     ),
     ...activationInstallCommands(settings),
+    ...mimeInstallCommands(settings),
 ];
 
 const schemaInstallCommands = (settings: DeploySettings): string[] =>
@@ -120,6 +149,58 @@ const iconInstallCommands = (settings: DeploySettings): string[] => {
     return listFilesRecursive(iconsDir).map((icon) => iconInstallCommand(settings, icon.absPath, icon.rel));
 };
 
+const assertInsideProject = (settings: DeploySettings, installed: InstalledFile): void => {
+    const { resolved } = installed;
+    const target = existsSync(resolved) ? realpathSync(resolved) : resolved;
+
+    if (isInside(settings.paths.root, target)) {
+        return;
+    }
+
+    throw new Error(
+        `Cannot install "${installed.destination}" from "${installed.source}": a source-mode manifest builds from ` +
+        `your git checkout, so every file it installs has to live inside ${settings.paths.root} and be committed. ` +
+        "Move it into the project, or drop it from the source build.",
+    );
+};
+
+const licenseInstallCommands = (settings: DeploySettings): string[] => {
+    const licenseFile = settings.paths.licenseFile;
+
+    if (licenseFile === null) {
+        return [];
+    }
+
+    const destination = licenseDestination(settings);
+    assertInsideProject(settings, { destination, source: licenseFile, resolved: licenseFile });
+    const target = `${DESTINATION}/${shellArgument(destination)}`;
+
+    return [installCommand(projectRelative(settings, licenseFile), target, "m644")];
+};
+
+const noticesInstallCommands = (settings: DeploySettings): string[] => {
+    const extensionLicense = `${nodeExtensionPathFor(settings)}/LICENSE`;
+    const nodeTarget = `${DESTINATION}/${shellArgument(nodeLicenseDestination(settings))}`;
+
+    return [
+        installCommand(NOTICES_FILENAME, `${DESTINATION}/${shellArgument(noticesDestination(settings))}`, "m644"),
+        `test ! -f ${extensionLicense} || ${installCommand(extensionLicense, nodeTarget, "m644")}`,
+    ];
+};
+
+const extraFileInstallCommands = (settings: DeploySettings): string[] =>
+    settings.extraFiles.map((file) => {
+        const resolved = resolve(settings.paths.root, file.source);
+        assertInsideProject(settings, { destination: file.destination, source: file.source, resolved });
+        const mode = file.mode ?? executableModeFor(resolved);
+
+        return installCommand(
+            projectRelative(settings, resolved),
+            `${DESTINATION}/${shellArgument(file.destination)}`,
+            `m${mode.toString(OCTAL_RADIX)}`,
+        );
+    });
+
 const moduleDirFor = (settings: DeploySettings): string => `${MODULE_BUILD_ROOT}/${settings.binaryName}`;
 
 const offlineEnvFor = (manager: PackageManager, settings: DeploySettings): Record<string, string> => {
@@ -161,7 +242,9 @@ const flatpakSourceModule = (payload: DeployPayload): FlatpakModule => {
             GENERATED_SOURCES,
             inlineSource(`${settings.applicationId}.desktop`, renderDesktopEntry(settings)),
             inlineSource(`${settings.applicationId}.metainfo.xml`, renderMetainfo(settings)),
+            ...mimeSources(settings),
             inlineSource(LAUNCHER_FILENAME, renderLauncher(settings)),
+            inlineSource(NOTICES_FILENAME, renderNotices(settings, payload.notices)),
             ...activationSource(settings),
         ],
         "build-commands": [
@@ -171,6 +254,9 @@ const flatpakSourceModule = (payload: DeployPayload): FlatpakModule => {
             ...metadataInstallCommands(settings),
             ...schemaInstallCommands(settings),
             ...iconInstallCommands(settings),
+            ...licenseInstallCommands(settings),
+            ...noticesInstallCommands(settings),
+            ...extraFileInstallCommands(settings),
             ...(settings.deploy.flatpak?.buildCommands ?? []),
             ...validationCommands(settings),
         ],

package/src/deploy/types.ts

@@ -19,11 +19,27 @@ type StagedFile = {
 
 type NodeRuntime = {
     path: string;
+    licenseFile: string | null;
     version: string;
     glibcFloor: string | null;
     isStripped: boolean;
 };
 
+type Notice = {
+    subject: string;
+    license: string;
+    source: string | null;
+    copyright: string[];
+    text: string | null;
+};
+
+type NoticeSection = {
+    title: string;
+    files: string[];
+    summary: string[];
+    notices: Notice[];
+};
+
 type DeployDeveloper = {
     id: string | null;
     name: string;
@@ -51,6 +67,12 @@ type DeployFileAssociation = {
     description: string | null;
 };
 
+type DeployExtraFile = {
+    destination: string;
+    source: string;
+    mode: number | null;
+};
+
 type DeployDesktopAction = {
     id: string;
     name: string;
@@ -118,7 +140,7 @@ type DeploySettings = {
     desktopActions: DeployDesktopAction[];
     desktopEntry: Record<string, string>;
     isDbusActivatable: boolean;
-    extraFiles: Record<string, string>;
+    extraFiles: DeployExtraFile[];
     versions: DeployVersions;
     arch: DeployArch;
     paths: DeployPaths;
@@ -130,6 +152,7 @@ type DeployPayload = {
     settings: DeploySettings;
     node: NodeRuntime | null;
     stage: StagedFile[];
+    notices: NoticeSection[];
     overlays: Record<DeployTargetName, StagedFile[]>;
 };
 
@@ -157,6 +180,7 @@ export type {
     DeployConfig,
     DeployDesktopAction,
     DeployDeveloper,
+    DeployExtraFile,
     DeployFileAssociation,
     DeployManifest,
     DeployPaths,
@@ -169,6 +193,8 @@ export type {
     DeployTool,
     DeployVersions,
     NodeRuntime,
+    Notice,
+    NoticeSection,
     PackageFamily,
     StagedFile,
 };

package/src/vite-plugins/bundled-packages.ts

@@ -0,0 +1,95 @@
+import type { Plugin } from "vite";
+import { isRecord, sortStringsBy } from "@gtkx/utils";
+import { readFileSync } from "node:fs";
+import { dirname, join, relative, resolve } from "node:path";
+import { stripQuery } from "./strip-query.js";
+
+type PackageIdentity = {
+    name: string;
+    version: string | null;
+};
+
+type RecordedPackage = PackageIdentity & {
+    dir: string;
+};
+
+type PackagesState = {
+    outDir: string;
+};
+
+const BUNDLED_PACKAGES_FILENAME = "gtkx-packages.json";
+const MANIFEST_FILENAME = "package.json";
+const DEFAULT_OUT_DIR = "dist";
+const JSON_INDENT = 4;
+
+const identityIn = (dir: string): PackageIdentity | null => {
+    try {
+        const parsed: unknown = JSON.parse(readFileSync(join(dir, MANIFEST_FILENAME), "utf8"));
+
+        if (!isRecord(parsed) || typeof parsed.name !== "string") {
+            return null;
+        }
+
+        return { name: parsed.name, version: typeof parsed.version === "string" ? parsed.version : null };
+    } catch {
+        return null;
+    }
+};
+
+const packageIn = (dir: string): RecordedPackage | null => {
+    const identity = identityIn(dir);
+
+    if (identity !== null) {
+        return { ...identity, dir };
+    }
+
+    const parent = dirname(dir);
+
+    return parent === dir ? null : packageIn(parent);
+};
+
+const packageForModule = (id: string): RecordedPackage | null => {
+    const path = stripQuery(id);
+
+    return path.startsWith("/") ? packageIn(dirname(path)) : null;
+};
+
+const keyFor = (entry: RecordedPackage): string => `${entry.name}@${entry.version ?? ""}`;
+
+const relativeTo = (outDir: string, entry: RecordedPackage): RecordedPackage => ({
+    ...entry,
+    dir: relative(outDir, entry.dir),
+});
+
+const renderPackages = (outDir: string, ids: string[]): string => {
+    const found = ids.map((id) => packageForModule(id)).filter((entry) => entry !== null);
+    const unique: Map<string, RecordedPackage> = new Map(found.map((entry) => [keyFor(entry), entry]));
+    const packages = sortStringsBy(unique.values(), keyFor).map((entry) => relativeTo(outDir, entry));
+
+    return `${JSON.stringify({ packages }, null, JSON_INDENT)}\n`;
+};
+
+function gtkxBundledPackages(root: string): Plugin {
+    const state: PackagesState = { outDir: join(root, DEFAULT_OUT_DIR) };
+
+    return {
+        name: "gtkx:bundled-packages",
+        apply: "build",
+
+        configResolved(config) {
+            state.outDir = resolve(config.root, config.build.outDir);
+        },
+
+        generateBundle(_options, bundle) {
+            const ids = Object.values(bundle).flatMap((output) => (output.type === "chunk" ? output.moduleIds : []));
+
+            this.emitFile({
+                type: "asset",
+                fileName: BUNDLED_PACKAGES_FILENAME,
+                source: renderPackages(state.outDir, ids),
+            });
+        },
+    };
+}
+
+export { BUNDLED_PACKAGES_FILENAME, gtkxBundledPackages };