@lukoweb/apitogo 0.2.42 → 0.2.44

package/src/vite/plugin-modules.ts

@@ -1,188 +1,190 @@
-import path from "node:path";
-import type { Plugin } from "vite";
-import { normalizePath } from "vite";
-import { getCurrentConfig } from "../config/loader.js";
-import { writePluginDebugCode } from "./debug.js";
-
-const getLandingModuleImport = (moduleDir: string, mode: string) =>
-  mode === "internal"
-    ? normalizePath(path.join(moduleDir, "../module-landing/src/index.tsx"))
-    : "@lukoweb/apitogo-module-landing";
-
-const getUserPanelModuleImport = (moduleDir: string, mode: string) =>
-  mode === "internal"
-    ? normalizePath(path.join(moduleDir, "../module-user-panel/src/index.tsx"))
-    : "@lukoweb/apitogo-module-user-panel";
-
-const getBillingPluginImport = (moduleDir: string, mode: string) =>
-  mode === "internal"
-    ? normalizePath(
-        path.join(moduleDir, "../plugin-dev-portal-billing/src/index.ts"),
-      )
-    : "@lukoweb/apitogo-plugin-dev-portal-billing";
-
-const resolveProjectPageImport = (rootDir: string, pagePath: string) =>
-  normalizePath(path.resolve(rootDir, pagePath));
-
-const viteModulesPlugin = (): Plugin => {
-  const virtualModuleId = "virtual:zudoku-modules-plugin";
-  const resolvedVirtualModuleId = `\0${virtualModuleId}`;
-
-  return {
-    name: "zudoku-modules-plugin",
-    resolveId(id) {
-      if (id === virtualModuleId) {
-        return resolvedVirtualModuleId;
-      }
-    },
-    async load(id) {
-      if (id !== resolvedVirtualModuleId) return;
-
-      const config = getCurrentConfig();
-      const { landing, userPanel } = config.__resolvedModules;
-
-      if (config.__meta.mode === "standalone") {
-        return [
-          `export const configuredModulesPlugins = [];`,
-          `export const configuredModulesSlots = {};`,
-        ].join("\n");
-      }
-
-      const landingImport = getLandingModuleImport(
-        config.__meta.moduleDir,
-        config.__meta.mode,
-      );
-      const userPanelImport = getUserPanelModuleImport(
-        config.__meta.moduleDir,
-        config.__meta.mode,
-      );
-
-      const landingConfig = {
-        enabled: landing.enabled,
-        path: landing.path,
-        layout: landing.layout,
-        content: landing.content,
-      };
-
-      const userPanelConfig = {
-        enabled: userPanel.enabled,
-        basePath: userPanel.basePath,
-        dashboard: {
-          enabled: userPanel.dashboard.enabled,
-          path: userPanel.dashboard.path,
-          content: userPanel.dashboard.content,
-        },
-        userManagement: {
-          enabled: userPanel.userManagement.enabled,
-          routes: userPanel.userManagement.routes,
-          content: userPanel.userManagement.content,
-        },
-        apiKeys: userPanel.apiKeys,
-        plans: {
-          enabled: userPanel.plans.enabled,
-          path: userPanel.plans.path,
-          content: userPanel.plans.content,
-        },
-      };
-
-      const landingPagePath = config.modules?.landing?.page;
-      const dashboardPagePath = config.modules?.userPanel?.dashboard?.page;
-      const profilePagePath = config.modules?.userPanel?.userManagement?.page;
-      const plansPagePath = config.modules?.userPanel?.plans?.page;
-
-      const code: string[] = [`import config from "virtual:zudoku-config";`];
-
-      if (landingPagePath) {
-        code.push(
-          `import LandingPage from "${resolveProjectPageImport(config.__meta.rootDir, landingPagePath)}";`,
-        );
-      }
-
-      const useBillingDashboard = !dashboardPagePath && userPanel.plans.enabled;
-
-      if (dashboardPagePath) {
-        code.push(
-          `import UserPanelDashboardPage from "${resolveProjectPageImport(config.__meta.rootDir, dashboardPagePath)}";`,
-        );
-      } else if (useBillingDashboard) {
-        code.push(
-          `import { OverviewDashboardPage as UserPanelDashboardPage } from "${getBillingPluginImport(config.__meta.moduleDir, config.__meta.mode)}";`,
-        );
-      }
-
-      if (profilePagePath) {
-        code.push(
-          `import UserPanelProfilePage from "${resolveProjectPageImport(config.__meta.rootDir, profilePagePath)}";`,
-        );
-      }
-
-      if (plansPagePath) {
-        code.push(
-          `import UserPanelPlansPage from "${resolveProjectPageImport(config.__meta.rootDir, plansPagePath)}";`,
-        );
-      }
-
-      const configuredPlugins: string[] = [];
-      let hasLandingFooterSlot = false;
-
-      if (landing.enabled) {
-        code.push(`import { landingModule } from "${landingImport}";`);
-        code.push(
-          `const landing = landingModule({`,
-          `  ...${JSON.stringify(landingConfig)},`,
-          `  component: config.modules?.landing?.component${landingPagePath ? " ?? LandingPage" : ""},`,
-          `});`,
-        );
-        configuredPlugins.push("...(landing ? [landing] : [])");
-
-        // Render the configured landing footer on every page via the
-        // layout "footer" slot (home, docs, API reference, pricing, auth).
-        if (landing.content.footer) {
-          code.push(
-            `import { createLandingFooterSlot } from "${landingImport}";`,
-            `const landingFooterSlot = createLandingFooterSlot(${JSON.stringify(landing.content.footer)});`,
-          );
-          hasLandingFooterSlot = true;
-        }
-      }
-
-      code.push(
-        hasLandingFooterSlot
-          ? `export const configuredModulesSlots = landingFooterSlot ? { footer: landingFooterSlot } : {};`
-          : `export const configuredModulesSlots = {};`,
-      );
-
-      if (userPanel.enabled) {
-        code.push(`import { userPanelModule } from "${userPanelImport}";`);
-        code.push(
-          `const userPanel = userPanelModule({`,
-          `  ...${JSON.stringify(userPanelConfig)},`,
-          `  dashboard: {`,
-          `    ...${JSON.stringify(userPanelConfig.dashboard)},`,
-          `    component: config.modules?.userPanel?.dashboard?.component${dashboardPagePath || useBillingDashboard ? " ?? UserPanelDashboardPage" : ""},`,
-          `  },`,
-          `  userManagement: {`,
-          `    ...${JSON.stringify(userPanelConfig.userManagement)},`,
-          `    component: config.modules?.userPanel?.userManagement?.component${profilePagePath ? " ?? UserPanelProfilePage" : ""},`,
-          `  },`,
-          `  plans: {`,
-          `    ...${JSON.stringify(userPanelConfig.plans)},`,
-          `    component: config.modules?.userPanel?.plans?.component${plansPagePath ? " ?? UserPanelPlansPage" : ""},`,
-          `  },`,
-          `});`,
-        );
-        configuredPlugins.push("...(userPanel ? [userPanel] : [])");
-      }
-
-      code.push(
-        `export const configuredModulesPlugins = [${configuredPlugins.join(", ")}];`,
-      );
-
-      await writePluginDebugCode(config.__meta.rootDir, "modules-plugin", code);
-
-      return code.join("\n");
-    },
-  };
-};
-
-export default viteModulesPlugin;
+import path from "node:path";
+import type { Plugin } from "vite";
+import { normalizePath } from "vite";
+import { getCurrentConfig } from "../config/loader.js";
+import { writePluginDebugCode } from "./debug.js";
+
+const getLandingModuleImport = (moduleDir: string, mode: string) =>
+  mode === "internal"
+    ? normalizePath(path.join(moduleDir, "../module-landing/src/index.tsx"))
+    : "@lukoweb/apitogo-module-landing";
+
+const getUserPanelModuleImport = (moduleDir: string, mode: string) =>
+  mode === "internal"
+    ? normalizePath(path.join(moduleDir, "../module-user-panel/src/index.tsx"))
+    : "@lukoweb/apitogo-module-user-panel";
+
+const getBillingPluginImport = (moduleDir: string, mode: string) =>
+  mode === "internal"
+    ? normalizePath(
+        path.join(moduleDir, "../plugin-dev-portal-billing/src/index.ts"),
+      )
+    : "@lukoweb/apitogo-plugin-dev-portal-billing";
+
+const resolveProjectPageImport = (rootDir: string, pagePath: string) =>
+  normalizePath(path.resolve(rootDir, pagePath));
+
+const viteModulesPlugin = (): Plugin => {
+  const virtualModuleId = "virtual:zudoku-modules-plugin";
+  const resolvedVirtualModuleId = `\0${virtualModuleId}`;
+
+  return {
+    name: "zudoku-modules-plugin",
+    resolveId(id) {
+      if (id === virtualModuleId) {
+        return resolvedVirtualModuleId;
+      }
+    },
+    async load(id) {
+      if (id !== resolvedVirtualModuleId) return;
+
+      const config = getCurrentConfig();
+      const { landing, userPanel } = config.__resolvedModules;
+
+      if (config.__meta.mode === "standalone") {
+        return [
+          `export const configuredModulesPlugins = [];`,
+          `export const configuredModulesSlots = {};`,
+        ].join("\n");
+      }
+
+      const landingImport = getLandingModuleImport(
+        config.__meta.moduleDir,
+        config.__meta.mode,
+      );
+      const userPanelImport = getUserPanelModuleImport(
+        config.__meta.moduleDir,
+        config.__meta.mode,
+      );
+
+      const landingConfig = {
+        enabled: landing.enabled,
+        path: landing.path,
+        layout: landing.layout,
+        content: landing.content,
+      };
+
+      const userPanelConfig = {
+        enabled: userPanel.enabled,
+        basePath: userPanel.basePath,
+        dashboard: {
+          enabled: userPanel.dashboard.enabled,
+          path: userPanel.dashboard.path,
+          content: userPanel.dashboard.content,
+        },
+        userManagement: {
+          enabled: userPanel.userManagement.enabled,
+          routes: userPanel.userManagement.routes,
+          content: userPanel.userManagement.content,
+        },
+        apiKeys: userPanel.apiKeys,
+        plans: {
+          enabled: userPanel.plans.enabled,
+          path: userPanel.plans.path,
+          content: userPanel.plans.content,
+        },
+      };
+
+      const landingPagePath = config.modules?.landing?.page;
+      const dashboardPagePath = config.modules?.userPanel?.dashboard?.page;
+      const profilePagePath = config.modules?.userPanel?.userManagement?.page;
+      const plansPagePath = config.modules?.userPanel?.plans?.page;
+
+      const code: string[] = [`import config from "virtual:zudoku-config";`];
+
+      if (landingPagePath) {
+        code.push(
+          `import LandingPage from "${resolveProjectPageImport(config.__meta.rootDir, landingPagePath)}";`,
+        );
+      }
+
+      const useBillingDashboard = !dashboardPagePath && userPanel.plans.enabled;
+
+      if (dashboardPagePath) {
+        code.push(
+          `import UserPanelDashboardPage from "${resolveProjectPageImport(config.__meta.rootDir, dashboardPagePath)}";`,
+        );
+      } else if (useBillingDashboard) {
+        code.push(
+          `import { OverviewDashboardPage as UserPanelDashboardPage } from "${getBillingPluginImport(config.__meta.moduleDir, config.__meta.mode)}";`,
+        );
+      }
+
+      if (profilePagePath) {
+        code.push(
+          `import UserPanelProfilePage from "${resolveProjectPageImport(config.__meta.rootDir, profilePagePath)}";`,
+        );
+      }
+
+      if (plansPagePath) {
+        code.push(
+          `import UserPanelPlansPage from "${resolveProjectPageImport(config.__meta.rootDir, plansPagePath)}";`,
+        );
+      }
+
+      const configuredPlugins: string[] = [];
+      let hasLandingFooterSlot = false;
+
+      if (landing.enabled) {
+        code.push(`import { landingModule } from "${landingImport}";`);
+        code.push(
+          `const landing = landingModule({`,
+          `  ...${JSON.stringify(landingConfig)},`,
+          `  component: config.modules?.landing?.component${landingPagePath ? " ?? LandingPage" : ""},`,
+          `});`,
+        );
+        configuredPlugins.push("...(landing ? [landing] : [])");
+
+        // Render the configured landing footer on every page via the
+        // layout "footer" slot (home, docs, API reference, pricing, auth).
+        if (landing.content.footer) {
+          code.push(
+            `import { createLandingFooterSlot } from "${landingImport}";`,
+            `const landingFooterSlot = createLandingFooterSlot(${JSON.stringify(landing.content.footer)});`,
+          );
+          hasLandingFooterSlot = true;
+        }
+      }
+
+      code.push(
+        hasLandingFooterSlot
+          ? `export const configuredModulesSlots = landingFooterSlot ? { footer: landingFooterSlot } : {};`
+          : `export const configuredModulesSlots = {};`,
+      );
+
+      if (userPanel.enabled) {
+        code.push(`import { userPanelModule } from "${userPanelImport}";`);
+        code.push(
+          `const userPanel = userPanelModule({`,
+          `  ...${JSON.stringify(userPanelConfig)},`,
+          // With billing on, the billing plugin owns the plans page and the account side menu.
+          `  billingNav: ${config.__meta.pricingEnabled === true},`,
+          `  dashboard: {`,
+          `    ...${JSON.stringify(userPanelConfig.dashboard)},`,
+          `    component: config.modules?.userPanel?.dashboard?.component${dashboardPagePath || useBillingDashboard ? " ?? UserPanelDashboardPage" : ""},`,
+          `  },`,
+          `  userManagement: {`,
+          `    ...${JSON.stringify(userPanelConfig.userManagement)},`,
+          `    component: config.modules?.userPanel?.userManagement?.component${profilePagePath ? " ?? UserPanelProfilePage" : ""},`,
+          `  },`,
+          `  plans: {`,
+          `    ...${JSON.stringify(userPanelConfig.plans)},`,
+          `    component: config.modules?.userPanel?.plans?.component${plansPagePath ? " ?? UserPanelPlansPage" : ""},`,
+          `  },`,
+          `});`,
+        );
+        configuredPlugins.push("...(userPanel ? [userPanel] : [])");
+      }
+
+      code.push(
+        `export const configuredModulesPlugins = [${configuredPlugins.join(", ")}];`,
+      );
+
+      await writePluginDebugCode(config.__meta.rootDir, "modules-plugin", code);
+
+      return code.join("\n");
+    },
+  };
+};
+
+export default viteModulesPlugin;

package/src/vite/watch-ignore.ts

@@ -1,70 +1,80 @@
-import { lstatSync, realpathSync } from "node:fs";
-import path from "node:path";
-
-/**
- * A config version 2 portal builds from `<state>/generated/`, where `content` is a link to the project folder.
- * That folder holds the state folder itself (`.apitogo/` or `apitogo/.state/`), which holds `generated/content`
- * again, so a file watcher that follows the link goes round forever (ENAMETOOLONG).
- */
-const STATE_INSIDE_CONTENT =
-  /[\\/]content[\\/](?:\.apitogo|apitogo[\\/]\.state)(?:[\\/]|$)/;
-
-const within = (base: string, file: string) =>
-  file === base || file.startsWith(base + path.sep);
-
-const unique = (paths: string[]) => [...new Set(paths)];
-
-/** Whether `root` is the site root (`<state>/generated`) of a config version 2 workspace: it has the `content` link. */
-function isWorkspace(root: string): boolean {
-  try {
-    return (
-      path.basename(root) === "generated" &&
-      lstatSync(path.join(root, "content")).isSymbolicLink()
-    );
-  } catch {
-    return false;
-  }
-}
-
-/**
- * The tenant's own folder of a config version 2 workspace (what `content` links to), or `undefined` for any other
- * project. The site root sits inside the state folder, so the folder that holds `node_modules` and the pages is
- * outside it and the dev server has to be told it may serve files from there.
- */
-export function tenantDir(root: string): string | undefined {
-  return isWorkspace(root)
-    ? realpathSync(path.join(root, "content"))
-    : undefined;
-}
-
-/**
- * What the dev server's watcher must leave alone in a config version 2 workspace, or `undefined` for any other
- * project. The watcher meets the state folder twice: below the `content` link and, after resolving the link,
- * by its real path. So the whole state folder is skipped, except `generated/` itself (the site root) and the
- * tenant's own files.
- */
-export function stateIgnore(
-  root: string,
-): ((file: string) => boolean) | undefined {
-  if (!isWorkspace(root)) return undefined;
-
-  const state = path.dirname(root);
-  const states = unique([state, realpathSync(state)]);
-  const roots = unique([root, realpathSync(root)]);
-
-  return (file) => {
-    if (!states.some((base) => within(base, file))) return false;
-    if (!roots.some((base) => within(base, file))) return true;
-    return STATE_INSIDE_CONTENT.test(file);
-  };
-}
-
-/**
- * The folders the dev server may serve files from. The site root of a config version 2 workspace sits inside the
- * state folder, so the package (`node_modules`) and the tenant's pages are outside it. Without them the page's main
- * script fails with "Failed to load url ... Does the file exist?" and the server stops.
- */
-export function devServerAllow(root: string, moduleDir: string): string[] {
-  const tenant = tenantDir(root);
-  return [root, path.dirname(root), moduleDir, ...(tenant ? [tenant] : [])];
-}
+import { lstatSync, realpathSync } from "node:fs";
+import path from "node:path";
+
+/**
+ * A config version 2 portal builds from `<state>/generated/`, where `content` is a link to the project folder.
+ * That folder holds the state folder itself (`.apitogo/` or `apitogo/.state/`), which holds `generated/content`
+ * again, so a file watcher that follows the link goes round forever (ENAMETOOLONG).
+ */
+const STATE_INSIDE_CONTENT =
+  /[\\/]content[\\/](?:\.apitogo|apitogo[\\/]\.state)(?:[\\/]|$)/;
+
+/**
+ * On Windows the site root can arrive as `C:/...` while the watcher reports `C:\...`, so both sides are resolved to
+ * the platform's form first; otherwise nothing matched and the watcher followed `content` until ELOOP.
+ */
+const within = (base: string, file: string) => {
+  const resolvedBase = path.resolve(base);
+  const resolvedFile = path.resolve(file);
+  return (
+    resolvedFile === resolvedBase ||
+    resolvedFile.startsWith(resolvedBase + path.sep)
+  );
+};
+
+const unique = (paths: string[]) => [...new Set(paths)];
+
+/** Whether `root` is the site root (`<state>/generated`) of a config version 2 workspace: it has the `content` link. */
+function isWorkspace(root: string): boolean {
+  try {
+    return (
+      path.basename(root) === "generated" &&
+      lstatSync(path.join(root, "content")).isSymbolicLink()
+    );
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * The tenant's own folder of a config version 2 workspace (what `content` links to), or `undefined` for any other
+ * project. The site root sits inside the state folder, so the folder that holds `node_modules` and the pages is
+ * outside it and the dev server has to be told it may serve files from there.
+ */
+export function tenantDir(root: string): string | undefined {
+  return isWorkspace(root)
+    ? realpathSync(path.join(root, "content"))
+    : undefined;
+}
+
+/**
+ * What the dev server's watcher must leave alone in a config version 2 workspace, or `undefined` for any other
+ * project. The watcher meets the state folder twice: below the `content` link and, after resolving the link,
+ * by its real path. So the whole state folder is skipped, except `generated/` itself (the site root) and the
+ * tenant's own files.
+ */
+export function stateIgnore(
+  root: string,
+): ((file: string) => boolean) | undefined {
+  if (!isWorkspace(root)) return undefined;
+
+  const state = path.dirname(root);
+  const states = unique([state, realpathSync(state)]);
+  const roots = unique([root, realpathSync(root)]);
+
+  return (file) => {
+    if (!states.some((base) => within(base, file))) return false;
+    if (!roots.some((base) => within(base, file))) return true;
+    return STATE_INSIDE_CONTENT.test(file);
+  };
+}
+
+/**
+ * The folders the dev server may serve files from. The site root of a config version 2 workspace sits inside the
+ * state folder, so the package (`node_modules`) and the tenant's pages are outside it. Without them the page's main
+ * script fails with "Failed to load url ... Does the file exist?" and the server stops.
+ */
+export function devServerAllow(root: string, moduleDir: string): string[] {
+  const tenant = tenantDir(root);
+  return [root, path.dirname(root), moduleDir, ...(tenant ? [tenant] : [])];
+}