@gtkx/config 0.21.0 → 1.0.0-rc.2

package/dist/virtual.js

@@ -1,20 +1,28 @@
-export const GTKX_CONFIG_VIRTUAL_ID = "virtual:gtkx-config";
-export const RESOLVED_GTKX_CONFIG_VIRTUAL_ID = `\0${GTKX_CONFIG_VIRTUAL_ID}`;
+const GTKX_CONFIG_VIRTUAL_ID = "virtual:gtkx-config";
+const RESOLVED_GTKX_CONFIG_VIRTUAL_ID = `\0${GTKX_CONFIG_VIRTUAL_ID}`;
 const METADATA_SPECIFIER = "@gtkx/jsx/metadata";
-const serializeConfigValue = (value) => (value === undefined ? "undefined" : JSON.stringify(value));
-export const serializeGtkxConfig = (config) => ({
-    libraries: config.libraries,
-    girPath: config.girPath,
-    applicationId: config.applicationId,
-    containerProps: config.containerProps,
-    arrayProps: config.arrayProps,
-    objectProps: config.objectProps,
-    virtualProps: config.virtualProps,
-    elementMap: config.elementMap,
-    reactCompiler: config.reactCompiler,
-});
-export const renderGtkxConfigModule = (config) => [
-    `export * from ${JSON.stringify(METADATA_SPECIFIER)};`,
-    ...Object.entries(serializeGtkxConfig(config)).map(([key, value]) => `export const ${key} = ${serializeConfigValue(value)};`),
-].join("\n");
+const lazyElementConfig = (lazyElements) => Object.fromEntries(lazyElements.map((type) => [type, { lazy: true }]));
+/**
+ * The runtime element config is the app's static per-element config (currently its lazy flags) merged
+ * with its behaviors module, so a single `elements` map is registered.
+ */
+const renderConfigModule = (config) => {
+    const lazyJson = JSON.stringify(lazyElementConfig(config.lazyElements));
+    const behaviorImports = config.elements === null
+        ? []
+        : [
+            "import { mergeElementConfigs } from \"@gtkx/react/config\";",
+            `import __elementBehaviors from ${JSON.stringify(config.elements)};`,
+        ];
+    return [
+        ...behaviorImports,
+        `export * from ${JSON.stringify(METADATA_SPECIFIER)};`,
+        `export const applicationId = ${JSON.stringify(config.applicationId)};`,
+        `export const userEventSignals = ${JSON.stringify(config.userEventSignals)};`,
+        config.elements === null
+            ? `export const elements = ${lazyJson};`
+            : `export const elements = mergeElementConfigs(__elementBehaviors, ${lazyJson});`,
+    ].join("\n");
+};
+export { GTKX_CONFIG_VIRTUAL_ID, RESOLVED_GTKX_CONFIG_VIRTUAL_ID, renderConfigModule };
 //# sourceMappingURL=virtual.js.map

package/dist/virtual.js.map

@@ -1 +1 @@
-{"version":3,"file":"virtual.js","sourceRoot":"","sources":["../src/virtual.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,sBAAsB,GAAG,qBAAqB,CAAC;AAE5D,MAAM,CAAC,MAAM,+BAA+B,GAAW,KAAK,sBAAsB,EAAE,CAAC;AAErF,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AAehD,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAU,EAAE,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AAErH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAA0B,EAAwB,EAAE,CAAC,CAAC;IACtF,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;IACvB,aAAa,EAAE,MAAM,CAAC,aAAa;IACnC,cAAc,EAAE,MAAM,CAAC,cAAc;IACrC,UAAU,EAAE,MAAM,CAAC,UAAU;IAC7B,WAAW,EAAE,MAAM,CAAC,WAAW;IAC/B,YAAY,EAAE,MAAM,CAAC,YAAY;IACjC,UAAU,EAAE,MAAM,CAAC,UAAU;IAC7B,aAAa,EAAE,MAAM,CAAC,aAAa;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,MAA0B,EAAU,EAAE,CACzE;IACI,iBAAiB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,GAAG;IACtD,GAAG,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAC9C,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,gBAAgB,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,GAAG,CAC5E;CACJ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"virtual.js","sourceRoot":"","sources":["../src/virtual.ts"],"names":[],"mappings":"AAEA,MAAM,sBAAsB,GAAG,qBAAqB,CAAC;AACrD,MAAM,+BAA+B,GAAG,KAAK,sBAAsB,EAAE,CAAC;AACtE,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AAEhD,MAAM,iBAAiB,GAAG,CAAC,YAAsB,EAAkC,EAAE,CACjF,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE3E;;;GAGG;AACH,MAAM,kBAAkB,GAAG,CAAC,MAAsB,EAAU,EAAE;IAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAExE,MAAM,eAAe,GACjB,MAAM,CAAC,QAAQ,KAAK,IAAI;QACpB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;YACM,6DAA6D;YAC7D,kCAAkC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG;SACvE,CAAC;IAEd,OAAO;QACH,GAAG,eAAe;QAClB,iBAAiB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,GAAG;QACtD,gCAAgC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG;QACvE,mCAAmC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG;QAC7E,MAAM,CAAC,QAAQ,KAAK,IAAI;YACpB,CAAC,CAAC,2BAA2B,QAAQ,GAAG;YACxC,CAAC,CAAC,mEAAmE,QAAQ,IAAI;KACxF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["import type { ResolvedConfig } from \"./config.js\";\n\nconst GTKX_CONFIG_VIRTUAL_ID = \"virtual:gtkx-config\";\nconst RESOLVED_GTKX_CONFIG_VIRTUAL_ID = `\\0${GTKX_CONFIG_VIRTUAL_ID}`;\nconst METADATA_SPECIFIER = \"@gtkx/jsx/metadata\";\n\nconst lazyElementConfig = (lazyElements: string[]): Record<string, { lazy: true }> =>\n    Object.fromEntries(lazyElements.map((type) => [type, { lazy: true }]));\n\n/**\n * The runtime element config is the app's static per-element config (currently its lazy flags) merged\n * with its behaviors module, so a single `elements` map is registered.\n */\nconst renderConfigModule = (config: ResolvedConfig): string => {\n    const lazyJson = JSON.stringify(lazyElementConfig(config.lazyElements));\n\n    const behaviorImports =\n        config.elements === null\n            ? []\n            : [\n                    \"import { mergeElementConfigs } from \\\"@gtkx/react/config\\\";\",\n                    `import __elementBehaviors from ${JSON.stringify(config.elements)};`,\n                ];\n\n    return [\n        ...behaviorImports,\n        `export * from ${JSON.stringify(METADATA_SPECIFIER)};`,\n        `export const applicationId = ${JSON.stringify(config.applicationId)};`,\n        `export const userEventSignals = ${JSON.stringify(config.userEventSignals)};`,\n        config.elements === null\n            ? `export const elements = ${lazyJson};`\n            : `export const elements = mergeElementConfigs(__elementBehaviors, ${lazyJson});`,\n    ].join(\"\\n\");\n};\n\nexport { GTKX_CONFIG_VIRTUAL_ID, RESOLVED_GTKX_CONFIG_VIRTUAL_ID, renderConfigModule };\n"]}

package/dist/vite-plugin.d.ts

@@ -0,0 +1,16 @@
+import type { Plugin, UserConfig } from "vite";
+import { type ConfigLoader } from "./loader.js";
+/**
+ * Creates the Vite plugin that resolves and serves the `virtual:gtkx-config`
+ * module, exposing the JSX metadata and the resolved application ID from the
+ * project's configuration.
+ * @param options Plugin name, an optional custom {@link ConfigLoader}, and an
+ * optional hook returning extra Vite user config.
+ */
+declare const createConfigPlugin: (options: {
+    name: string;
+    loadConfig?: ConfigLoader;
+    config?: () => Omit<UserConfig, "plugins">;
+}) => Plugin;
+export default createConfigPlugin;
+//# sourceMappingURL=vite-plugin.d.ts.map

package/dist/vite-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite-plugin.d.ts","sourceRoot":"","sources":["../src/vite-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAC/C,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,aAAa,CAAC;AAsBpE;;;;;;GAMG;AACH,QAAA,MAAM,kBAAkB,GAAI,SAAS;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;CAC9C,KAAG,MAcH,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/dist/vite-plugin.js

@@ -0,0 +1,31 @@
+import { createConfigLoader } from "./loader.js";
+import { GTKX_CONFIG_VIRTUAL_ID, renderConfigModule, RESOLVED_GTKX_CONFIG_VIRTUAL_ID } from "./virtual.js";
+const resolveVirtualId = (id) => id === GTKX_CONFIG_VIRTUAL_ID ? RESOLVED_GTKX_CONFIG_VIRTUAL_ID : null;
+const loadVirtualModule = async (id, loadConfig, state) => {
+    if (id !== RESOLVED_GTKX_CONFIG_VIRTUAL_ID) {
+        return undefined;
+    }
+    return renderConfigModule(await loadConfig(state.root ?? process.cwd()));
+};
+/**
+ * Creates the Vite plugin that resolves and serves the `virtual:gtkx-config`
+ * module, exposing the JSX metadata and the resolved application ID from the
+ * project's configuration.
+ * @param options Plugin name, an optional custom {@link ConfigLoader}, and an
+ * optional hook returning extra Vite user config.
+ */
+const createConfigPlugin = (options) => {
+    const loadConfig = options.loadConfig ?? createConfigLoader();
+    const state = { root: undefined };
+    return {
+        name: options.name,
+        config(config) {
+            state.root = config.root ?? state.root;
+            return options.config?.();
+        },
+        resolveId: (id) => resolveVirtualId(id),
+        load: (id) => loadVirtualModule(id, loadConfig, state),
+    };
+};
+export default createConfigPlugin;
+//# sourceMappingURL=vite-plugin.js.map

package/dist/vite-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite-plugin.js","sourceRoot":"","sources":["../src/vite-plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,+BAA+B,EAAE,MAAM,cAAc,CAAC;AAM3G,MAAM,gBAAgB,GAAG,CAAC,EAAU,EAAiB,EAAE,CACnD,EAAE,KAAK,sBAAsB,CAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC,CAAC,IAAI,CAAC;AAE3E,MAAM,iBAAiB,GAAG,KAAK,EAC3B,EAAU,EACV,UAAwB,EACxB,KAAkB,EACS,EAAE;IAC7B,IAAI,EAAE,KAAK,+BAA+B,EAAE,CAAC;QACzC,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,kBAAkB,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;AAC7E,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,kBAAkB,GAAG,CAAC,OAI3B,EAAU,EAAE;IACT,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,kBAAkB,EAAE,CAAC;IAC9D,MAAM,KAAK,GAAgB,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAE/C,OAAO;QACH,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,MAAM,CAAC,MAAkB;YACrB,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;YAEvC,OAAO,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QAC9B,CAAC;QACD,SAAS,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC/C,IAAI,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC;KACjE,CAAC;AACN,CAAC,CAAC;AAEF,eAAe,kBAAkB,CAAC","sourcesContent":["import type { Plugin, UserConfig } from \"vite\";\nimport { type ConfigLoader, createConfigLoader } from \"./loader.js\";\nimport { GTKX_CONFIG_VIRTUAL_ID, renderConfigModule, RESOLVED_GTKX_CONFIG_VIRTUAL_ID } from \"./virtual.js\";\n\ntype PluginState = {\n    root: string | undefined;\n};\n\nconst resolveVirtualId = (id: string): string | null =>\n    id === GTKX_CONFIG_VIRTUAL_ID ? RESOLVED_GTKX_CONFIG_VIRTUAL_ID : null;\n\nconst loadVirtualModule = async (\n    id: string,\n    loadConfig: ConfigLoader,\n    state: PluginState,\n): Promise<string | undefined> => {\n    if (id !== RESOLVED_GTKX_CONFIG_VIRTUAL_ID) {\n        return undefined;\n    }\n\n    return renderConfigModule(await loadConfig(state.root ?? process.cwd()));\n};\n\n/**\n * Creates the Vite plugin that resolves and serves the `virtual:gtkx-config`\n * module, exposing the JSX metadata and the resolved application ID from the\n * project's configuration.\n * @param options Plugin name, an optional custom {@link ConfigLoader}, and an\n * optional hook returning extra Vite user config.\n */\nconst createConfigPlugin = (options: {\n    name: string;\n    loadConfig?: ConfigLoader;\n    config?: () => Omit<UserConfig, \"plugins\">;\n}): Plugin => {\n    const loadConfig = options.loadConfig ?? createConfigLoader();\n    const state: PluginState = { root: undefined };\n\n    return {\n        name: options.name,\n        config(config: UserConfig) {\n            state.root = config.root ?? state.root;\n\n            return options.config?.();\n        },\n        resolveId: (id: string) => resolveVirtualId(id),\n        load: (id: string) => loadVirtualModule(id, loadConfig, state),\n    };\n};\n\nexport default createConfigPlugin;\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gtkx/config",
-  "version": "0.21.0",
-  "description": "gtkx.config.ts schema, validation, and loader shared by the GTKX toolchain",
+  "version": "1.0.0-rc.2",
+  "description": "gtkx.config.ts schema, loader, and the element-prop mapping language shared across the GTKX toolchain",
   "keywords": [
     "gtkx",
     "gtk",
@@ -18,7 +18,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/gtkx-org/gtkx.git",
+    "url": "git+https://github.com/gtkx-org/gtkx.git",
     "directory": "packages/config"
   },
   "license": "MPL-2.0",
@@ -27,26 +27,33 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "source": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./env": {
-      "types": "./env.d.ts"
+    "./internal": {
+      "types": "./dist/internal.d.ts",
+      "default": "./dist/internal.js"
+    },
+    "./vite-plugin": {
+      "types": "./dist/vite-plugin.d.ts",
+      "default": "./dist/vite-plugin.js"
     }
   },
   "sideEffects": false,
   "files": [
     "dist",
-    "src",
-    "env.d.ts"
+    "src"
   ],
+  "engines": {
+    "node": ">=24"
+  },
   "dependencies": {
     "c12": "^3.3.4",
-    "vite": "^8.0.16",
-    "@gtkx/utils": "0.21.0"
+    "defu": "^6.1.7",
+    "vite": "^8.1.5",
+    "zod": "^4.4.3"
   },
   "scripts": {
-    "build": "tsc -b"
+    "release": "tsx ../../scripts/release-package.ts"
   }
 }

package/src/config-error.ts

@@ -0,0 +1,67 @@
+import type { z } from "zod";
+
+type IssuePath = (string | number)[];
+
+const CONFIG_PREFIX = "gtkx.config.ts:";
+
+const isRecord = (value: unknown): value is Record<string, unknown> =>
+    typeof value === "object" && value !== null && !Array.isArray(value);
+
+const rawIssue = (input: unknown, path: IssuePath, message: string, isStandalone = false) => ({
+    code: "custom" as const,
+    input,
+    path,
+    message,
+    continue: true as const,
+    ...(isStandalone && { params: { standalone: true } }),
+});
+
+const appendSegment = (path: string, segment: PropertyKey): string => {
+    if (typeof segment === "number") {
+        return `${path}[${String(segment)}]`;
+    }
+
+    return path === "" ? String(segment) : `${path}.${String(segment)}`;
+};
+
+const dottedPath = (segments: PropertyKey[]): string => {
+    let path = "";
+
+    for (const segment of segments) {
+        path = appendSegment(path, segment);
+    }
+
+    return path;
+};
+
+const isStandaloneIssue = (issue: z.core.$ZodIssue): boolean =>
+    "params" in issue && isRecord(issue.params) && issue.params.standalone === true;
+
+const formatIssue = (issue: z.core.$ZodIssue, fullPath: PropertyKey[]): string => {
+    if (issue.code === "unrecognized_keys") {
+        const [key] = issue.keys;
+        const path = dottedPath(key === undefined ? fullPath : [...fullPath, key]);
+
+        return `${CONFIG_PREFIX} \`${path}\` is not a recognized key`;
+    }
+
+    if (isStandaloneIssue(issue)) {
+        return `${CONFIG_PREFIX} ${issue.message}`;
+    }
+
+    const path = dottedPath(fullPath);
+
+    return path === "" ? `${CONFIG_PREFIX} ${issue.message}` : `${CONFIG_PREFIX} \`${path}\` ${issue.message}`;
+};
+
+const configError = (error: z.ZodError): Error => {
+    const issue = error.issues[0];
+
+    if (issue === undefined) {
+        return new Error(`${CONFIG_PREFIX} invalid configuration`);
+    }
+
+    return new Error(formatIssue(issue, issue.path));
+};
+
+export { isRecord, rawIssue, configError };