@lukoweb/apitogo 0.1.23 → 0.1.37

package/src/vite/pagefind-dev-index.ts

@@ -1,100 +1,100 @@
-import path from "node:path";
-import { createIndex, type PagefindIndex } from "pagefind";
-import { isRunnableDevEnvironment, type ViteDevServer } from "vite";
-import type { LoadedConfig } from "../config/config.js";
-import invariant from "../lib/util/invariant.js";
-import { joinUrl } from "../lib/util/joinUrl.js";
-import { getAppServerEntryPath } from "./config.js";
-import { getDevHtml } from "./html.js";
-import { routesToPaths } from "./prerender/utils.js";
-
-type EntryServerImport = typeof import("../app/entry.server.js");
-
-export type IndexProgress = {
-  type: "progress";
-  total: number;
-  current: number;
-  path: string;
-};
-
-export type IndexComplete = {
-  type: "complete";
-  success: boolean;
-  indexed: number;
-  error?: string;
-};
-
-export type IndexEvent = IndexProgress | IndexComplete;
-
-export async function* buildPagefindDevIndex(
-  vite: ViteDevServer,
-  config: LoadedConfig,
-): AsyncGenerator<IndexEvent> {
-  const { index, errors } = await createIndex();
-  invariant(index, `Failed to create pagefind index: ${errors.join(", ")}`);
-
-  const pagefindIndex: PagefindIndex = index;
-  const ssrEnvironment = vite.environments.ssr;
-
-  if (!isRunnableDevEnvironment(ssrEnvironment)) {
-    throw new Error("SSR environment is not runnable");
-  }
-
-  // Import the entry server module
-  const serverModule = (await ssrEnvironment.runner.import(
-    getAppServerEntryPath(),
-  )) as EntryServerImport;
-
-  const routes = serverModule.getRoutesByConfig(config);
-  const paths = routesToPaths(routes);
-  const { basePath } = config;
-
-  const template = getDevHtml({
-    jsEntry: "/__z/entry.client.tsx",
-    dir: config.site?.dir,
-  });
-  const transformedTemplate = await vite.transformIndexHtml("/", template);
-
-  let indexed = 0;
-
-  for (const urlPath of paths) {
-    try {
-      const pathname = joinUrl(basePath, urlPath);
-      const url = joinUrl("http://localhost", pathname);
-      const request = new Request(url);
-
-      const response = await serverModule.handleRequest({
-        template: transformedTemplate,
-        request,
-        routes,
-        basePath,
-        bypassProtection: true,
-      });
-
-      if (response.status < 400 && response.body) {
-        const content = await response.text();
-        await pagefindIndex.addHTMLFile({
-          url: urlPath,
-          content,
-        });
-        indexed++;
-      }
-    } catch (error) {
-      // biome-ignore lint/suspicious/noConsole: Log errors during indexing
-      console.error(`Failed to index ${urlPath}:`, error);
-    }
-
-    yield {
-      type: "progress",
-      total: paths.length,
-      current: indexed,
-      path: urlPath,
-    };
-  }
-
-  // Write the index to public/pagefind
-  const outputPath = path.join(vite.config.publicDir, "pagefind");
-  await pagefindIndex.writeFiles({ outputPath });
-
-  yield { type: "complete", success: true, indexed };
-}
+import path from "node:path";
+import { createIndex, type PagefindIndex } from "pagefind";
+import { isRunnableDevEnvironment, type ViteDevServer } from "vite";
+import type { LoadedConfig } from "../config/config.js";
+import invariant from "../lib/util/invariant.js";
+import { joinUrl } from "../lib/util/joinUrl.js";
+import { getAppServerEntryPath } from "./config.js";
+import { getDevHtml } from "./html.js";
+import { routesToPaths } from "./prerender/utils.js";
+
+type EntryServerImport = typeof import("../app/entry.server.js");
+
+export type IndexProgress = {
+  type: "progress";
+  total: number;
+  current: number;
+  path: string;
+};
+
+export type IndexComplete = {
+  type: "complete";
+  success: boolean;
+  indexed: number;
+  error?: string;
+};
+
+export type IndexEvent = IndexProgress | IndexComplete;
+
+export async function* buildPagefindDevIndex(
+  vite: ViteDevServer,
+  config: LoadedConfig,
+): AsyncGenerator<IndexEvent> {
+  const { index, errors } = await createIndex();
+  invariant(index, `Failed to create pagefind index: ${errors.join(", ")}`);
+
+  const pagefindIndex: PagefindIndex = index;
+  const ssrEnvironment = vite.environments.ssr;
+
+  if (!isRunnableDevEnvironment(ssrEnvironment)) {
+    throw new Error("SSR environment is not runnable");
+  }
+
+  // Import the entry server module
+  const serverModule = (await ssrEnvironment.runner.import(
+    getAppServerEntryPath(),
+  )) as EntryServerImport;
+
+  const routes = serverModule.getRoutesByConfig(config);
+  const paths = routesToPaths(routes);
+  const { basePath } = config;
+
+  const template = getDevHtml({
+    jsEntry: "/__z/entry.client.tsx",
+    dir: config.site?.dir,
+  });
+  const transformedTemplate = await vite.transformIndexHtml("/", template);
+
+  let indexed = 0;
+
+  for (const urlPath of paths) {
+    try {
+      const pathname = joinUrl(basePath, urlPath);
+      const url = joinUrl("http://localhost", pathname);
+      const request = new Request(url);
+
+      const response = await serverModule.handleRequest({
+        template: transformedTemplate,
+        request,
+        routes,
+        basePath,
+        bypassProtection: true,
+      });
+
+      if (response.status < 400 && response.body) {
+        const content = await response.text();
+        await pagefindIndex.addHTMLFile({
+          url: urlPath,
+          content,
+        });
+        indexed++;
+      }
+    } catch (error) {
+      // biome-ignore lint/suspicious/noConsole: Log errors during indexing
+      console.error(`Failed to index ${urlPath}:`, error);
+    }
+
+    yield {
+      type: "progress",
+      total: paths.length,
+      current: indexed,
+      path: urlPath,
+    };
+  }
+
+  // Write the index to public/pagefind
+  const outputPath = path.join(vite.config.publicDir, "pagefind");
+  await pagefindIndex.writeFiles({ outputPath });
+
+  yield { type: "complete", success: true, indexed };
+}

package/src/vite/plugin-api-keys.ts

@@ -16,8 +16,12 @@ const viteApiKeysPlugin = (): Plugin => {
     async load(id) {
       if (id === resolvedVirtualModuleId) {
         const config = getCurrentConfig();
+        const apiKeysPath = config.__resolvedModules.userPanel.apiKeys.path;
 
-        if (!config.apiKeys?.enabled || config.__meta.mode === "standalone") {
+        if (
+          !config.__resolvedModules.userPanel.apiKeys.enabled ||
+          config.__meta.mode === "standalone"
+        ) {
           return `export const configuredApiKeysPlugin = undefined;`;
         }
 
@@ -33,6 +37,7 @@ const viteApiKeysPlugin = (): Plugin => {
             : `import { apiKeyPlugin } from "@lukoweb/apitogo/plugins/api-keys";`,
           `export const configuredApiKeysPlugin = apiKeyPlugin({
             ...config.apiKeys,
+            path: "${apiKeysPath}",
             isZuplo: ${ZuploEnv.isZuplo},
             ${deploymentName ? `deploymentName: "${deploymentName}"` : ""}
           });`,

package/src/vite/plugin-api.ts

@@ -122,7 +122,10 @@ const viteApiPlugin = async (): Promise<Plugin> => {
           .forEach((file) => this.addWatchFile(file));
       }
 
-      if (config.__meta.mode === "standalone") {
+      if (
+        config.__meta.mode === "standalone" ||
+        !config.__resolvedModules.docs.enabled
+      ) {
         return [
           "export const configuredApiPlugins = [];",
           "export const configuredApiCatalogPlugins = [];",

package/src/vite/plugin-auth.ts

@@ -16,7 +16,11 @@ const viteAuthPlugin = (): Plugin => {
       if (id === resolvedVirtualModuleId) {
         const config = getCurrentConfig();
 
-        if (!config.authentication || config.__meta.mode === "standalone") {
+        if (
+          !config.authentication ||
+          !config.__resolvedModules.userPanel.userManagement.enabled ||
+          config.__meta.mode === "standalone"
+        ) {
           return `export const configuredAuthProvider = undefined;`;
         }
         // TODO: Validate that the authConfig.type is a valid authentication provider

package/src/vite/plugin-component.ts

@@ -26,7 +26,7 @@ const viteAliasPlugin = (): Plugin => {
           "@lukoweb/apitogo/plugins/search-pagefind",
           "src/lib/plugins/search-pagefind/index.tsx",
         ],
-        [/^@lukoweb\/apitogo\/ui\/(.*)\.js/, "src/lib/ui/$1.tsx"],
+        [/^@apitogo\/apitogo\/ui\/(.*)\.js/, "src/lib/ui/$1.tsx"],
       ] as const;
 
       const aliases = replacements.map(([find, replacement]) => ({

package/src/vite/plugin-config-reload.ts

@@ -1,49 +1,49 @@
-import path from "node:path";
-import colors from "picocolors";
-import type { Plugin, ViteDevServer } from "vite";
-import { logger } from "../cli/common/logger.js";
-import { getCurrentConfig } from "../config/loader.js";
-import { invalidate as invalidateNavigation } from "./plugin-navigation.js";
-
-export const reload = ({ ws, environments }: ViteDevServer) => {
-  Object.values(environments).forEach((environment) => {
-    environment.moduleGraph.invalidateAll();
-  });
-
-  ws.send({ type: "full-reload" });
-};
-
-export const viteConfigReloadPlugin = (): Plugin => ({
-  name: "zudoku-config-reload",
-  configureServer: (server) => {
-    const initialConfig = getCurrentConfig();
-    let importDependencies = initialConfig.__meta.dependencies;
-    server.watcher.on("change", async (file) => {
-      if (
-        !importDependencies.includes(file) &&
-        file !== initialConfig.__meta.configPath
-      ) {
-        return;
-      }
-
-      const currentConfig = getCurrentConfig();
-      importDependencies = currentConfig.__meta.dependencies;
-
-      // Assume `.tsx` files are handled by HMR (skip if the config file itself changed)
-      if (file !== currentConfig.__meta.configPath && file.endsWith(".tsx"))
-        return;
-
-      invalidateNavigation(server);
-      Object.values(server.environments).forEach((env) => {
-        env.moduleGraph.invalidateAll();
-      });
-
-      logger.info(
-        colors.blue(
-          `Config ${path.basename(currentConfig.__meta.configPath)} changed. Reloading...`,
-        ),
-        { timestamp: true },
-      );
-    });
-  },
-});
+import path from "node:path";
+import colors from "picocolors";
+import type { Plugin, ViteDevServer } from "vite";
+import { logger } from "../cli/common/logger.js";
+import { getCurrentConfig } from "../config/loader.js";
+import { invalidate as invalidateNavigation } from "./plugin-navigation.js";
+
+export const reload = ({ ws, environments }: ViteDevServer) => {
+  Object.values(environments).forEach((environment) => {
+    environment.moduleGraph.invalidateAll();
+  });
+
+  ws.send({ type: "full-reload" });
+};
+
+export const viteConfigReloadPlugin = (): Plugin => ({
+  name: "zudoku-config-reload",
+  configureServer: (server) => {
+    const initialConfig = getCurrentConfig();
+    let importDependencies = initialConfig.__meta.dependencies;
+    server.watcher.on("change", async (file) => {
+      if (
+        !importDependencies.includes(file) &&
+        file !== initialConfig.__meta.configPath
+      ) {
+        return;
+      }
+
+      const currentConfig = getCurrentConfig();
+      importDependencies = currentConfig.__meta.dependencies;
+
+      // Assume `.tsx` files are handled by HMR (skip if the config file itself changed)
+      if (file !== currentConfig.__meta.configPath && file.endsWith(".tsx"))
+        return;
+
+      invalidateNavigation(server);
+      Object.values(server.environments).forEach((env) => {
+        env.moduleGraph.invalidateAll();
+      });
+
+      logger.info(
+        colors.blue(
+          `Config ${path.basename(currentConfig.__meta.configPath)} changed. Reloading...`,
+        ),
+        { timestamp: true },
+      );
+    });
+  },
+});

package/src/vite/plugin-doc-metadata.ts

@@ -1,45 +1,45 @@
-import { glob } from "glob";
-import type { Plugin } from "vite";
-import { getCurrentConfig } from "../config/loader.js";
-import { readFrontmatter } from "../lib/util/readFrontmatter.js";
-import { reload } from "./plugin-config-reload.js";
-import { invalidate as invalidateNavigation } from "./plugin-navigation.js";
-
-const serializeMetadata = async (filePath: string): Promise<string> => {
-  const fm = await readFrontmatter(filePath);
-  const h1 = fm.content.match(/^#\s+(.*)$/m)?.[1];
-  return JSON.stringify({ frontmatter: fm.data, h1 });
-};
-
-export const viteDocMetadataPlugin = (): Plugin => ({
-  enforce: "pre",
-  name: "zudoku-doc-metadata-plugin",
-  configureServer: async (server) => {
-    const config = getCurrentConfig();
-    const files = await glob("**/*.{md,mdx}", {
-      cwd: config.__meta.rootDir,
-      ignore: ["node_modules", "dist"],
-      absolute: true,
-    });
-
-    const metadataMap = new Map<string, string>(
-      await Promise.all(
-        files.map(
-          async (file) => [file, await serializeMetadata(file)] as const,
-        ),
-      ),
-    );
-
-    server.watcher.on("all", async (event, filePath) => {
-      if (event !== "change" && event !== "add") return;
-      if (!/\.mdx?$/.test(filePath)) return;
-
-      const metadata = await serializeMetadata(filePath);
-      if (metadataMap.get(filePath) === metadata) return;
-
-      metadataMap.set(filePath, metadata);
-      invalidateNavigation(server);
-      reload(server);
-    });
-  },
-});
+import { glob } from "glob";
+import type { Plugin } from "vite";
+import { getCurrentConfig } from "../config/loader.js";
+import { readFrontmatter } from "../lib/util/readFrontmatter.js";
+import { reload } from "./plugin-config-reload.js";
+import { invalidate as invalidateNavigation } from "./plugin-navigation.js";
+
+const serializeMetadata = async (filePath: string): Promise<string> => {
+  const fm = await readFrontmatter(filePath);
+  const h1 = fm.content.match(/^#\s+(.*)$/m)?.[1];
+  return JSON.stringify({ frontmatter: fm.data, h1 });
+};
+
+export const viteDocMetadataPlugin = (): Plugin => ({
+  enforce: "pre",
+  name: "zudoku-doc-metadata-plugin",
+  configureServer: async (server) => {
+    const config = getCurrentConfig();
+    const files = await glob("**/*.{md,mdx}", {
+      cwd: config.__meta.rootDir,
+      ignore: ["node_modules", "dist"],
+      absolute: true,
+    });
+
+    const metadataMap = new Map<string, string>(
+      await Promise.all(
+        files.map(
+          async (file) => [file, await serializeMetadata(file)] as const,
+        ),
+      ),
+    );
+
+    server.watcher.on("all", async (event, filePath) => {
+      if (event !== "change" && event !== "add") return;
+      if (!/\.mdx?$/.test(filePath)) return;
+
+      const metadata = await serializeMetadata(filePath);
+      if (metadataMap.get(filePath) === metadata) return;
+
+      metadataMap.set(filePath, metadata);
+      invalidateNavigation(server);
+      reload(server);
+    });
+  },
+});

package/src/vite/plugin-docs.ts

@@ -137,7 +137,10 @@ const viteDocsPlugin = (): Plugin => {
 
       const config = getCurrentConfig();
 
-      if (config.__meta.mode === "standalone") {
+      if (
+        config.__meta.mode === "standalone" ||
+        !config.__resolvedModules.docs.enabled
+      ) {
         return `export const configuredDocsPlugin = undefined;`;
       }
 

package/src/vite/plugin-metadata.ts

@@ -1,30 +1,30 @@
-import { writeFileSync } from "node:fs";
-import path from "node:path";
-import type { Plugin } from "vite";
-
-/**
- * Used for debugging, writes metadata to build.
- */
-const viteBuildMetadata = (): Plugin => {
-  return {
-    name: "zudoku-build-metadata-plugin",
-    buildEnd() {
-      const deps = [];
-      for (const id of this.getModuleIds()) {
-        const m = this.getModuleInfo(id);
-        if (m != null && !m.isExternal) {
-          for (const target of m.importedIds) {
-            deps.push({ source: m.id, target });
-          }
-        }
-      }
-
-      writeFileSync(
-        path.join(__dirname, "graph.json"),
-        JSON.stringify(deps, null, 2),
-      );
-    },
-  };
-};
-
-export default viteBuildMetadata;
+import { writeFileSync } from "node:fs";
+import path from "node:path";
+import type { Plugin } from "vite";
+
+/**
+ * Used for debugging, writes metadata to build.
+ */
+const viteBuildMetadata = (): Plugin => {
+  return {
+    name: "zudoku-build-metadata-plugin",
+    buildEnd() {
+      const deps = [];
+      for (const id of this.getModuleIds()) {
+        const m = this.getModuleInfo(id);
+        if (m != null && !m.isExternal) {
+          for (const target of m.importedIds) {
+            deps.push({ source: m.id, target });
+          }
+        }
+      }
+
+      writeFileSync(
+        path.join(__dirname, "graph.json"),
+        JSON.stringify(deps, null, 2),
+      );
+    },
+  };
+};
+
+export default viteBuildMetadata;

package/src/vite/plugin-modules.ts

@@ -0,0 +1,144 @@
+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 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 = [];`;
+      }
+
+      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)}";`,
+        );
+      }
+
+      if (dashboardPagePath) {
+        code.push(
+          `import UserPanelDashboardPage from "${resolveProjectPageImport(config.__meta.rootDir, dashboardPagePath)}";`,
+        );
+      }
+
+      if (profilePagePath) {
+        code.push(
+          `import UserPanelProfilePage from "${resolveProjectPageImport(config.__meta.rootDir, profilePagePath)}";`,
+        );
+      }
+
+      if (plansPagePath) {
+        code.push(
+          `import UserPanelPlansPage from "${resolveProjectPageImport(config.__meta.rootDir, plansPagePath)}";`,
+        );
+      }
+
+      code.push(
+        `import { landingModule } from "${landingImport}";`,
+        `import { userPanelModule } from "${userPanelImport}";`,
+        `const landing = landingModule({`,
+        `  ...${JSON.stringify(landingConfig)},`,
+        `  component: config.modules?.landing?.component${landingPagePath ? " ?? LandingPage" : ""},`,
+        `});`,
+        `const userPanel = userPanelModule({`,
+        `  ...${JSON.stringify(userPanelConfig)},`,
+        `  dashboard: {`,
+        `    ...${JSON.stringify(userPanelConfig.dashboard)},`,
+        `    component: config.modules?.userPanel?.dashboard?.component${dashboardPagePath ? " ?? 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" : ""},`,
+        `  },`,
+        `});`,
+        `export const configuredModulesPlugins = [`,
+        `  ...(landing ? [landing] : []),`,
+        `  ...(userPanel ? [userPanel] : []),`,
+        `];`,
+      );
+
+      await writePluginDebugCode(config.__meta.rootDir, "modules-plugin", code);
+
+      return code.join("\n");
+    },
+  };
+};
+
+export default viteModulesPlugin;