@gtkx/config 2.0.0-beta.1 → 2.0.0-beta.11

package/src/deploy.ts

@@ -10,10 +10,10 @@ import {
     url,
 } from "./schema-text.ts";
 
-const APPIMAGE_COMPRESSIONS = ["gzip", "xz", "zstd"] as const;
 const DEB_COMPRESSIONS = ["gzip", "none", "xz", "zstd"] as const;
 const DEB_SIGN_METHODS = ["debsign", "dpkg-sig"] as const;
 const DEB_SIGN_TYPES = ["archive", "maint", "origin"] as const;
+const DEPLOY_ARCH_NAMES = ["arm64", "x64"] as const;
 const DEPLOY_TARGET_NAMES = ["appimage", "deb", "flatpak", "rpm"] as const;
 const FLATPAK_MODES = ["prebuilt", "source"] as const;
 const NODE_SOURCES = ["download", "host", "path"] as const;
@@ -37,16 +37,22 @@ const URL_KINDS = [
 const BOOLEAN_ERROR = "must be a boolean";
 const EPOCH_ERROR = "must be a non-negative integer";
 const EXTRA_FILE_ERROR = "must be a source path or a { source, mode } entry";
-const FILE_MODE_ERROR = "must be an octal file mode such as 755";
+const FILE_MODE_ERROR = "must be an octal file mode without setuid or setgid bits, such as 755";
 const FILE_MODE_PATTERN = /^[0-7]{3,4}$/;
+const FILE_MODE_RADIX = 8;
+const PRIVILEGED_FILE_MODE_MASK = 0o6000;
 const HEX_COLOR_ERROR = "must be a #rrggbb color";
 const HEX_COLOR_PATTERN = /^#[\dA-Fa-f]{6}$/;
 const KEY_FILE_ERROR = "must be a path to a PGP key file";
 const KEY_ID_ERROR = "must be a PGP key id";
+const LAUNCHER_ENV_ERROR = "must be a record of POSIX environment names to values without null bytes";
+const LAUNCHER_ENV_NAME_ERROR = "must be a POSIX environment name";
+const LAUNCHER_ENV_NAME_PATTERN = /^[A-Za-z_]\w*$/;
 const MINIMUM_LIBRARY_VERSION_ERROR = "must be a version such as 4.18";
 const MINIMUM_LIBRARY_VERSION_PATTERN = /^\d+(?:\.\d+)*$/;
 const MINIMUM_LIBRARY_VERSIONS_ERROR = "must be a record of GIR library ids to a minimum version";
-const LIBRARY_ID_ERROR = 'must be a GIR library identifier of the form "Name-Version", such as "Gtk-4.0"';
+const NODE_FLAG_ERROR = "must be a Node.js flag beginning with a hyphen and containing no null bytes";
+const LIBRARY_ID_ERROR = 'must be a GIR library identifier of the form "Name-Version", such as "Adw-1"';
 const SCRIPT_ERROR = "must be a path to a shell script";
 const SOURCE_PATH_ERROR = "must be a source path";
 const SPDX_ERROR = "must be an SPDX license expression";
@@ -110,14 +116,53 @@ const brandingSchema = z.strictObject({
     dark: hexColorSchema,
 });
 
-const extraFileSchema = z.strictObject({
+/**
+ * A `deploy.extraFiles` entry in object form: the source file, resolved against the project root, that is
+ * installed at the entry's prefix-relative destination, and the octal mode it is installed with.
+ */
+type DeployExtraFileOptions = Record<"source", string> & {
+    /** Octal file mode. Setuid and setgid bits are rejected. */
+    mode?: string | undefined;
+};
+const extraFileSchema: z.ZodType<DeployExtraFileOptions> = z.strictObject({
     source: text(SOURCE_PATH_ERROR),
-    mode: z.string({ error: FILE_MODE_ERROR }).regex(FILE_MODE_PATTERN, { error: FILE_MODE_ERROR }).optional(),
+    mode: z
+        .string({ error: FILE_MODE_ERROR })
+        .regex(FILE_MODE_PATTERN, { error: FILE_MODE_ERROR })
+        .refine((mode) => (Number.parseInt(mode, FILE_MODE_RADIX) & PRIVILEGED_FILE_MODE_MASK) === 0, {
+            error: FILE_MODE_ERROR,
+        })
+        .optional(),
 });
 
 const extraFileEntrySchema = z.union([text(SOURCE_PATH_ERROR), extraFileSchema], { error: EXTRA_FILE_ERROR });
 
-const nodeRuntimeSchema = z.strictObject({
+const launcherEnvSchema = z.record(
+    z.string({ error: LAUNCHER_ENV_NAME_ERROR }).regex(LAUNCHER_ENV_NAME_PATTERN, { error: LAUNCHER_ENV_NAME_ERROR }),
+    z.string({ error: LAUNCHER_ENV_ERROR }).refine((value) => !value.includes("\0"), { error: LAUNCHER_ENV_ERROR }),
+    { error: (issue) => issue.code === "invalid_key" ? LAUNCHER_ENV_NAME_ERROR : LAUNCHER_ENV_ERROR },
+);
+
+const nodeFlagsSchema = z.array(
+    z
+        .string({ error: NODE_FLAG_ERROR })
+        .refine((value) => value.startsWith("-") && !value.includes("\0"), { error: NODE_FLAG_ERROR }),
+    { error: "must be an array of Node.js flags" },
+);
+
+/**
+ * The `deploy.node` options: where the Node.js runtime bundled with the application comes from, the version it
+ * is expected to be, whether its binary is stripped, and whether the launcher enables the compile cache.
+ */
+type DeployNodeOptions = Partial<
+    Record<"source", "download" | "host" | "path" | undefined> &
+    Record<"path", string | undefined> &
+    Record<"shouldStrip" | "shouldUseCompileCache", boolean | undefined>
+> & {
+    /** Expected Node.js version. Downloaded runtimes default to exactly 26.8.2 when omitted. */
+    version?: string | undefined;
+};
+const nodeRuntimeSchema: z.ZodType<DeployNodeOptions> = z.strictObject({
     source: z.enum(NODE_SOURCES, { error: "must be one of download, host, path" }).optional(),
     version: text("must be a Node.js version such as 26.7.0").optional(),
     path: text("must be a path to a node binary").optional(),
@@ -150,7 +195,7 @@ const rpmSchema = z.strictObject({
 
 const appimageSchema = z.strictObject({
     fileName: text("must be an output file name").optional(),
-    compression: z.enum(APPIMAGE_COMPRESSIONS, { error: "must be one of gzip, xz, zstd" }).optional(),
+    compression: z.literal("zstd", { error: "must be zstd" }).optional(),
     updateInformation: text("must be an AppImage update information string").optional(),
     runtimeFile: text("must be a path to an AppImage runtime file").optional(),
 });
@@ -229,6 +274,11 @@ const deploySchema = z.strictObject({
             error: "must be an array of deploy targets",
         })
         .optional(),
+    architectures: z
+        .array(z.enum(DEPLOY_ARCH_NAMES, { error: "must be one of arm64, x64" }), {
+            error: "must be an array of deploy architectures",
+        })
+        .optional(),
     outDir: text("must be a directory path relative to the project root").optional(),
     name: text("must be the display name shown in the launcher").optional(),
     genericName: text("must be a generic application name").optional(),
@@ -262,6 +312,8 @@ const deploySchema = z.strictObject({
         .optional(),
     releases: z.array(releaseSchema, { error: "must be an array of releases" }).optional(),
     execArgs: textList("argument", "must be an array of arguments appended to Exec").optional(),
+    launcherEnv: launcherEnvSchema.optional(),
+    nodeFlags: nodeFlagsSchema.optional(),
     fileAssociations: z
         .array(fileAssociationSchema, { error: "must be an array of file associations" })
         .optional(),
@@ -271,6 +323,7 @@ const deploySchema = z.strictObject({
         .optional(),
     desktopEntry: textRecord("must be a desktop entry value", "must be a record of desktop entry keys to values")
         .optional(),
+    metainfoExtra: textList("AppStream XML fragment", "must be an array of AppStream XML fragments").optional(),
     isDbusActivatable: flag(BOOLEAN_ERROR).optional(),
     extraFiles: relativePathRecord(
         "must be a destination path inside the install prefix, without a leading slash or a .. segment",
@@ -289,4 +342,4 @@ const deploySchema = z.strictObject({
     rpm: rpmSchema.optional(),
 });
 
-export { deploySchema };
+export { deploySchema, type DeployExtraFileOptions, type DeployNodeOptions };

package/src/index.ts

@@ -1,2 +1,3 @@
 export { type Config, defineConfig, mergeConfig, type ResolvedConfig } from "./config.ts";
+export { type DeployExtraFileOptions, type DeployNodeOptions } from "./deploy.ts";
 export { type ConfigLoader, type LoadedConfig, loadConfig } from "./loader.ts";

package/src/internal.ts

@@ -1,9 +1,12 @@
+export { configDependenciesFor } from "./config-dependencies.ts";
+export { createConfigReloader } from "./config-reloader.ts";
 export type { McpSettings, ResolvedReactCompilerOptions } from "./config.ts";
 export {
     APPLICATION_ID_MAX_LENGTH,
     isAgentReferenceEnabled,
     isAgentRulesEnabled,
     isValidApplicationId,
+    resolveAcceptedChildTypes,
     resolveElementComponents,
     resolveElementProps,
     resolveLazyElements,
@@ -11,4 +14,7 @@ export {
     resolveOmittedProps,
 } from "./config.ts";
 export { createConfigLoader } from "./loader.ts";
+export { assertSupportedNodeVersion, DEFAULT_NODE_VERSION, MINIMUM_NODE_VERSION } from "./node-version.ts";
 export { resourceBasePath } from "./resource-base-path.ts";
+export { viteProjectRoot } from "./vite-root.ts";
+export { SUPPORTED_EXTENSIONS as CONFIG_EXTENSIONS } from "c12";

package/src/loader.ts

@@ -1,8 +1,14 @@
-import { warn } from "@gtkx/utils";
+import { isPathInside, warn } from "@gtkx/utils";
 import { loadConfig as loadConfigFile } from "c12";
 import { existsSync } from "node:fs";
-import { resolve } from "node:path";
+import { relative, resolve } from "node:path";
+import {
+    captureConfigDependencies,
+    setConfigDependencies,
+    transformConfigModule,
+} from "./config-dependencies.ts";
 import { missingConfigFileError } from "./config-error.ts";
+import { type ConfigResolutionOptions, localConfigSourcePath } from "./config-source.ts";
 import {
     type Config,
     graduatedFutureKeys,
@@ -10,6 +16,7 @@ import {
     type ResolvedConfig,
     validateConfig,
 } from "./config.ts";
+import { assertSupportedNodeVersion } from "./node-version.ts";
 
 /** Result of loading a project's `gtkx.config.ts` file. */
 type LoadedConfig = {
@@ -28,7 +35,7 @@ type LoadConfigOptions = {
      * top-level values, and the name is passed to a config authored as a function.
      */
     mode?: string | undefined;
-};
+} & Partial<Record<"configFile", string | undefined>>;
 
 /** Reads a project's configuration once per directory, caching what it loads and what it resolves. */
 type ConfigLoader = {
@@ -41,6 +48,40 @@ type ConfigLoader = {
 const GRADUATED_FUTURE_ENV = "GTKX_GRADUATED_FUTURE_SHOWN";
 const graduatedFutureWarnings: Map<string, string> = new Map();
 
+const rejectMissingLocalConfig = (source: string, options: ConfigResolutionOptions): undefined => {
+    const path = localConfigSourcePath(source, options);
+
+    if (path !== undefined && !existsSync(path)) {
+        throw new Error(`Extended configuration does not exist at ${path}`);
+    }
+};
+
+const withConfigDependencies = <T>(dependencies: string[], operation: () => T): T => {
+    try {
+        return operation();
+    } catch (error) {
+        if (typeof error === "object" && error !== null) {
+            setConfigDependencies(error, dependencies);
+        }
+
+        throw error;
+    }
+};
+
+const selectedConfigFile = (root: string, configured: string | undefined): string | undefined => {
+    if (configured === undefined) {
+        return undefined;
+    }
+
+    const path = resolve(root, configured);
+
+    if (!isPathInside(root, path)) {
+        throw new Error(`Configuration file ${configured} must be inside the project root ${root}`);
+    }
+
+    return relative(root, path);
+};
+
 const warnGraduatedFuture = (config: unknown, root: string): void => {
     const keys = graduatedFutureKeys(config);
     const signature = keys.join(",");
@@ -65,37 +106,60 @@ const warnGraduatedFuture = (config: unknown, root: string): void => {
  * @throws When that directory holds no configuration file, or when the configuration fails validation.
  */
 const loadConfig = async (cwd: string, options: LoadConfigOptions = {}): Promise<LoadedConfig> => {
+    assertSupportedNodeVersion();
     const searched = resolve(cwd);
-
-    const result = await loadConfigFile<Config>({
-        name: "gtkx",
-        cwd: searched,
-        rcFile: false,
-        globalRc: false,
-        packageJson: false,
-        context: { mode: options.mode },
-        ...((options.mode !== undefined) && { envName: options.mode }),
-    });
+    const requestedConfigFile = selectedConfigFile(searched, options.configFile);
+
+    const captured = await captureConfigDependencies(() =>
+        loadConfigFile<Config>({
+            name: "gtkx",
+            cwd: searched,
+            rcFile: false,
+            globalRc: false,
+            packageJson: false,
+            omit$Keys: true,
+            context: { mode: options.mode },
+            jitiOptions: { fsCache: false, transform: transformConfigModule },
+            resolve: rejectMissingLocalConfig,
+            ...(requestedConfigFile !== undefined && { configFile: requestedConfigFile }),
+            ...((options.mode !== undefined) && { envName: options.mode }),
+        }));
+    const result = captured.value;
 
     const configFile = result.configFile;
-
-    if (configFile === undefined || !existsSync(resolve(searched, configFile))) {
-        throw missingConfigFileError(searched);
-    }
-
-    const config = result.config;
     const root = result.cwd ?? searched;
-    validateConfig(config);
-    warnGraduatedFuture(config, root);
-
-    return {
-        config,
-        configFile,
-        root,
-    };
+    const layerFiles = (result.layers ?? [])
+        .flatMap((layer) => layer.configFile === undefined
+            ? []
+            : [resolve(layer.cwd ?? root, layer.configFile)]);
+    const dependencies = [
+        ...(configFile === undefined ? [] : [configFile]),
+        ...layerFiles,
+        ...captured.dependencies,
+    ];
+
+    return withConfigDependencies(dependencies, () => {
+        if (configFile === undefined || !existsSync(resolve(searched, configFile))) {
+            throw missingConfigFileError(searched, requestedConfigFile);
+        }
+
+        const config = result.config;
+        validateConfig(config, configFile);
+        warnGraduatedFuture(config, root);
+
+        const loaded = {
+            config,
+            configFile,
+            root,
+        };
+        setConfigDependencies(loaded, dependencies);
+
+        return loaded;
+    });
 };
 
 const createConfigLoader = (options: LoadConfigOptions = {}): ConfigLoader => {
+    assertSupportedNodeVersion();
     const loaded: Map<string, Promise<LoadedConfig>> = new Map();
     const resolved: Map<string, Promise<ResolvedConfig>> = new Map();
 
@@ -114,4 +178,4 @@ const createConfigLoader = (options: LoadConfigOptions = {}): ConfigLoader => {
     };
 };
 
-export { loadConfig, createConfigLoader, type LoadedConfig, type ConfigLoader };
+export { loadConfig, createConfigLoader, type LoadedConfig, type ConfigLoader, type LoadConfigOptions };

package/src/node-version.ts

@@ -0,0 +1,17 @@
+const MINIMUM_NODE_MAJOR = 26;
+const MINIMUM_NODE_MINOR = 7;
+const MINIMUM_NODE_VERSION = "26.7.0";
+const DEFAULT_NODE_VERSION = "26.8.2";
+
+const assertSupportedNodeVersion = (): void => {
+    const [major = 0, minor = 0] = process.versions.node.split(".").map(Number);
+    const isSupported = major > MINIMUM_NODE_MAJOR || (major === MINIMUM_NODE_MAJOR && minor >= MINIMUM_NODE_MINOR);
+
+    if (!isSupported) {
+        throw new Error(
+            `GTKX requires Node.js ${MINIMUM_NODE_VERSION} or newer. Current version: ${process.versions.node}.`,
+        );
+    }
+};
+
+export { assertSupportedNodeVersion, DEFAULT_NODE_VERSION, MINIMUM_NODE_VERSION };