@lukoweb/apitogo 0.2.51 → 0.2.53

package/src/vite/plugin-config.ts

@@ -1,131 +1,192 @@
-import path from "node:path";
-import { normalizePath, type Plugin, type ResolvedConfig } from "vite";
-import { getZudokuRootDir } from "../cli/common/package-json.js";
-import { getCurrentConfig, loadZudokuConfig } from "../config/loader.js";
-import type { ConfigWithMeta } from "../config/loader.js";
-
-const virtualModuleId = "virtual:zudoku-config";
-const resolvedVirtualModuleId = `\0${virtualModuleId}`;
-const browserConfigLoaderPath = path.join(
-  getZudokuRootDir(),
-  "src/config/apitogo-config-loader.browser.ts",
-);
-
-function serializeClientConfig(config: ConfigWithMeta): string {
-  const {
-    plugins: _plugins,
-    __meta: _meta,
-    __resolvedModules,
-    ...rest
-  } = config;
-
-  return JSON.stringify({ ...rest, __resolvedModules }, (_key, value) =>
-    typeof value === "function" ? undefined : value,
-  );
-}
-
-const viteConfigPlugin = (): Plugin => {
-  let viteConfig: ResolvedConfig;
-
-  return {
-    name: "zudoku-config-plugin",
-    resolveId(source, _importer, options) {
-      if (source === virtualModuleId) {
-        return resolvedVirtualModuleId;
-      }
-
-      if (!source.includes("apitogo-config-loader.node")) {
-        return;
-      }
-
-      const isServerEnvironment =
-        options?.ssr === true ||
-        this.environment?.config?.consumer === "server";
-
-      if (!isServerEnvironment) {
-        return browserConfigLoaderPath;
-      }
-    },
-    configResolved(resolvedConfig) {
-      viteConfig = resolvedConfig;
-    },
-    async load(id) {
-      if (id !== resolvedVirtualModuleId) return;
-
-      const configPath = getCurrentConfig().__meta.configPath;
-      if (!configPath) {
-        return `export default {};`;
-      }
-
-      const { config: loadedConfig } = await loadZudokuConfig(
-        {
-          mode: viteConfig.mode,
-          command: viteConfig.command,
-        },
-        viteConfig.root,
-      );
-      const clientMeta = {
-        rootDir: loadedConfig.__meta.rootDir,
-        pricingEnabled: loadedConfig.__meta.pricingEnabled,
-        authenticationEnabled: loadedConfig.__meta.authenticationEnabled,
-        previewPlans: loadedConfig.__meta.previewPlans,
-        gatewayBaseUrl: loadedConfig.__meta.gatewayBaseUrl,
-      };
-
-      return `
-import rawConfig from "${normalizePath(configPath)}";
-import { runPluginTransformConfig } from "@lukoweb/apitogo/plugins";
-
-const embeddedConfig = ${serializeClientConfig(loadedConfig)};
-
-// JSON embedding drops Symbol values (React element's $$typeof). Prefer live
-// navigation/plugins from the TSX module so custom-page elements stay valid.
-const config = await runPluginTransformConfig({
-  ...embeddedConfig,
-  navigation: rawConfig?.navigation ?? embeddedConfig.navigation,
-  plugins: rawConfig?.plugins ?? embeddedConfig.plugins ?? [],
-  __meta: ${JSON.stringify(clientMeta)},
-});
-export default config;
-`;
-    },
-    async transform(code, id) {
-      if (id !== getCurrentConfig().__meta.configPath) return;
-
-      const replacedCode = code.replaceAll(
-        /process\.env\.([a-z_][a-z0-9_]*)/gi,
-        (_, envVar) => {
-          const allowedPrefixes = Array.isArray(viteConfig.envPrefix)
-            ? viteConfig.envPrefix
-            : [viteConfig.envPrefix];
-
-          if (!allowedPrefixes.some((prefix) => envVar.startsWith(prefix))) {
-            viteConfig.logger.warn(
-              `Warning: process.env.${envVar} is not prefixed with ${allowedPrefixes.join(
-                " or ",
-              )}.`,
-            );
-            return "undefined";
-          }
-
-          const value =
-            viteConfig.define?.[`process.env.${envVar}`] ??
-            viteConfig.define?.[`import.meta.env.${envVar}`];
-
-          if (value === undefined) {
-            viteConfig.logger.warn(
-              `Warning: process.env.${envVar} is not defined.`,
-            );
-            return "undefined";
-          }
-
-          return value;
-        },
-      );
-
-      return { code: replacedCode, map: null };
-    },
-  };
-};
-
-export default viteConfigPlugin;
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { normalizePath, type Plugin, type ResolvedConfig } from "vite";
+import { getZudokuRootDir } from "../cli/common/package-json.js";
+import { getCurrentConfig, loadZudokuConfig } from "../config/loader.js";
+import type { ConfigWithMeta } from "../config/loader.js";
+
+const virtualModuleId = "virtual:zudoku-config";
+const resolvedVirtualModuleId = `\0${virtualModuleId}`;
+const browserConfigLoaderPath = path.join(
+  getZudokuRootDir(),
+  "src/config/apitogo-config-loader.browser.ts",
+);
+
+/**
+ * Module settings that name a file on the build machine (`modules.landing.page`, `userPanel.dashboard.page`, …). The
+ * build imports those files itself (plugin-modules), so the browser never needs the path (API-127).
+ */
+const BUILD_ONLY_KEYS = new Set(["page"]);
+
+/** Drops the build-only file paths from the module settings. */
+export function stripBuildOnlyPaths(value: unknown): unknown {
+  if (Array.isArray(value)) return value.map(stripBuildOnlyPaths);
+  if (typeof value !== "object" || value === null) return value;
+  return Object.fromEntries(
+    Object.entries(value).flatMap(([key, child]) =>
+      BUILD_ONLY_KEYS.has(key) && typeof child === "string"
+        ? []
+        : [[key, stripBuildOnlyPaths(child)]],
+    ),
+  );
+}
+
+/**
+ * The config the browser gets. Plugins and functions cannot be embedded, `__meta` is replaced by a client subset,
+ * and no absolute path of the build machine is left in it (API-127).
+ */
+export function serializeClientConfig(config: ConfigWithMeta): string {
+  const {
+    plugins: _plugins,
+    __meta: _meta,
+    // Folders of the plugin packages on the build machine, for the build's Tailwind sources only.
+    __pluginDirs: _pluginDirs,
+    __resolvedModules,
+    modules,
+    ...rest
+  } = config;
+
+  return JSON.stringify(
+    {
+      ...rest,
+      ...(modules !== undefined
+        ? { modules: stripBuildOnlyPaths(modules) }
+        : {}),
+      __resolvedModules,
+    },
+    (_key, value) => (typeof value === "function" ? undefined : value),
+  );
+}
+
+/** The `__meta` the browser gets: no build-machine paths such as `rootDir` or `configPath` (API-127). */
+export function clientMetaOf(meta: ConfigWithMeta["__meta"]) {
+  return {
+    pricingEnabled: meta.pricingEnabled,
+    authenticationEnabled: meta.authenticationEnabled,
+    previewPlans: meta.previewPlans,
+    gatewayBaseUrl: meta.gatewayBaseUrl,
+  };
+}
+
+/**
+ * The navigation as the config file states it, for the browser. A TSX/TS config is imported, so its React elements
+ * stay live. A JSON config holds no elements, so only its navigation is embedded: importing the file would ship the
+ * whole file, file paths included (API-127).
+ */
+async function rawConfigSource(configPath: string): Promise<string> {
+  if (!configPath.toLowerCase().endsWith(".json"))
+    return `import rawConfig from "${normalizePath(configPath)}";`;
+  let navigation: unknown;
+  try {
+    navigation = (
+      JSON.parse(await readFile(configPath, "utf8")) as {
+        navigation?: unknown;
+      }
+    ).navigation;
+  } catch {
+    navigation = undefined;
+  }
+  return `const rawConfig = ${JSON.stringify(navigation === undefined ? {} : { navigation })};`;
+}
+
+const viteConfigPlugin = (): Plugin => {
+  let viteConfig: ResolvedConfig;
+
+  return {
+    name: "zudoku-config-plugin",
+    resolveId(source, _importer, options) {
+      if (source === virtualModuleId) {
+        return resolvedVirtualModuleId;
+      }
+
+      if (!source.includes("apitogo-config-loader.node")) {
+        return;
+      }
+
+      const isServerEnvironment =
+        options?.ssr === true ||
+        this.environment?.config?.consumer === "server";
+
+      if (!isServerEnvironment) {
+        return browserConfigLoaderPath;
+      }
+    },
+    configResolved(resolvedConfig) {
+      viteConfig = resolvedConfig;
+    },
+    async load(id) {
+      if (id !== resolvedVirtualModuleId) return;
+
+      const configPath = getCurrentConfig().__meta.configPath;
+      if (!configPath) {
+        return `export default {};`;
+      }
+
+      const { config: loadedConfig } = await loadZudokuConfig(
+        {
+          mode: viteConfig.mode,
+          command: viteConfig.command,
+        },
+        viteConfig.root,
+      );
+      const clientMeta = clientMetaOf(loadedConfig.__meta);
+      // A JSON config is no longer imported, so watch it here to keep reloading on edits.
+      this.addWatchFile(configPath);
+
+      return `
+${await rawConfigSource(configPath)}
+import { runPluginTransformConfig } from "@lukoweb/apitogo/plugins";
+
+const embeddedConfig = ${serializeClientConfig(loadedConfig)};
+
+// JSON embedding drops Symbol values (React element's $$typeof). Prefer live
+// navigation/plugins from the TSX module so custom-page elements stay valid.
+const config = await runPluginTransformConfig({
+  ...embeddedConfig,
+  navigation: rawConfig?.navigation ?? embeddedConfig.navigation,
+  plugins: rawConfig?.plugins ?? embeddedConfig.plugins ?? [],
+  __meta: ${JSON.stringify(clientMeta)},
+});
+export default config;
+`;
+    },
+    async transform(code, id) {
+      if (id !== getCurrentConfig().__meta.configPath) return;
+
+      const replacedCode = code.replaceAll(
+        /process\.env\.([a-z_][a-z0-9_]*)/gi,
+        (_, envVar) => {
+          const allowedPrefixes = Array.isArray(viteConfig.envPrefix)
+            ? viteConfig.envPrefix
+            : [viteConfig.envPrefix];
+
+          if (!allowedPrefixes.some((prefix) => envVar.startsWith(prefix))) {
+            viteConfig.logger.warn(
+              `Warning: process.env.${envVar} is not prefixed with ${allowedPrefixes.join(
+                " or ",
+              )}.`,
+            );
+            return "undefined";
+          }
+
+          const value =
+            viteConfig.define?.[`process.env.${envVar}`] ??
+            viteConfig.define?.[`import.meta.env.${envVar}`];
+
+          if (value === undefined) {
+            viteConfig.logger.warn(
+              `Warning: process.env.${envVar} is not defined.`,
+            );
+            return "undefined";
+          }
+
+          return value;
+        },
+      );
+
+      return { code: replacedCode, map: null };
+    },
+  };
+};
+
+export default viteConfigPlugin;