@lukoweb/apitogo 0.1.0 → 0.1.2

package/src/config/loader.ts

@@ -1,245 +1,245 @@
-import { stat } from "node:fs/promises";
-import path from "node:path";
-import colors from "picocolors";
-import type { RollupOutput, RollupWatcher } from "rollup";
-import {
-  type ConfigEnv,
-  runnerImport,
-  loadEnv as viteLoadEnv,
-  type Plugin as VitePlugin,
-} from "vite";
-import { logger } from "../cli/common/logger.js";
-import { getZudokuRootDir } from "../cli/common/package-json.js";
-import { runPluginTransformConfig } from "../lib/core/transform-config.js";
-import invariant from "../lib/util/invariant.js";
-import { fileExists } from "./file-exists.js";
-import type { ZudokuConfig } from "./validators/ZudokuConfig.js";
-import { validateConfig } from "./validators/ZudokuConfig.js";
-
-export type ConfigWithMeta = ZudokuConfig & {
-  __meta: {
-    rootDir: string;
-    moduleDir: string;
-    configPath: string;
-    mode: typeof process.env.ZUDOKU_ENV;
-    dependencies: string[];
-  };
-};
-
-let config: ConfigWithMeta | undefined;
-let envPrefix: string[] | undefined;
-let publicEnv: Record<string, string> | undefined;
-let modifiedTimes: Map<string, number> | undefined;
-
-const zudokuConfigFiles = [
-  "apitogo.config.js",
-  "apitogo.config.jsx",
-  "apitogo.config.ts",
-  "apitogo.config.tsx",
-  "apitogo.config.mjs",
-  "zudoku.config.js",
-  "zudoku.config.jsx",
-  "zudoku.config.ts",
-  "zudoku.config.tsx",
-  "zudoku.config.mjs",
-];
-
-const serverConfigOutputFiles = ["apitogo.config.js", "zudoku.config.js"];
-
-async function getConfigFilePath(rootDir: string) {
-  for (const fileName of zudokuConfigFiles) {
-    const filepath = path.join(rootDir, fileName);
-    if (await fileExists(filepath)) {
-      return filepath;
-    }
-  }
-  throw new Error(`No APIToGo or Zudoku config file found in project root.`);
-}
-
-// Stub virtual modules so transitive imports don't fail during config loading.
-// The real Vite server replaces these with actual values at runtime.
-const virtualModuleStubPlugin: VitePlugin = {
-  name: "zudoku-virtual-module-stubs",
-  resolveId(id) {
-    if (id.startsWith("virtual:")) return `\0${id}`;
-  },
-  load(id) {
-    if (id.startsWith("\0virtual:")) return "export default {}";
-  },
-};
-
-async function loadZudokuConfigWithMeta(
-  rootDir: string,
-): Promise<ConfigWithMeta> {
-  const configPath = await getConfigFilePath(rootDir);
-
-  const { module, dependencies } = await runnerImport<{
-    default: ZudokuConfig;
-  }>(configPath, {
-    plugins: [virtualModuleStubPlugin],
-    environments: {
-      inline: {
-        resolve: {
-          // Prevent Node.js from trying to load apitogo's raw .ts source
-          // directly, which fails with ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING
-          // when --experimental-strip-types is enabled. Uses regex to also
-          // catch plugins that re-export from apitogo (e.g. @zuplo/zudoku-plugin-*).
-          noExternal: [/apitogo/],
-        },
-      },
-    },
-    server: {
-      // this allows us to 'load' CSS files in the config
-      // see https://github.com/vitejs/vite/pull/19577
-      perEnvironmentStartEndDuringDev: true,
-    },
-  });
-
-  const config = module.default;
-
-  validateConfig(config, configPath);
-
-  const configWithMetadata: ConfigWithMeta = {
-    ...config,
-    __meta: {
-      rootDir,
-      moduleDir: getZudokuRootDir(),
-      mode: process.env.ZUDOKU_ENV,
-      dependencies,
-      configPath,
-    },
-  };
-
-  return configWithMetadata;
-}
-
-export function findOutputPathOfServerConfig(
-  output: RollupOutput | RollupOutput[] | RollupWatcher,
-) {
-  if (Array.isArray(output)) {
-    throw new Error("Expected a single output, but got an array");
-  }
-  if ("output" in output) {
-    const result = output.output.find(
-      (o) =>
-        "isEntry" in o &&
-        o.isEntry &&
-        serverConfigOutputFiles.includes(o.fileName),
-    );
-    if (result) {
-      return result.fileName;
-    }
-  }
-  throw new Error("Could not find server config output file");
-}
-
-function loadEnv(configEnv: ConfigEnv, rootDir: string) {
-  const envPrefix = ["ZUPLO_PUBLIC_", "ZUDOKU_PUBLIC_"];
-  const localEnv = viteLoadEnv(configEnv.mode, rootDir, envPrefix);
-
-  process.env = { ...localEnv, ...process.env };
-
-  const publicEnv = Object.fromEntries(
-    Object.entries(process.env)
-      .filter(([key]) => envPrefix.some((prefix) => key.startsWith(prefix)))
-      .map(([key, value]) => [key, JSON.stringify(value)]),
-  );
-
-  return { publicEnv, envPrefix };
-}
-
-async function hasConfigChanged() {
-  if (!config || !modifiedTimes) return true;
-
-  const files = [config.__meta.configPath, ...config.__meta.dependencies];
-
-  try {
-    const hasChanged = await Promise.all(
-      files.map(async (depPath) => {
-        const depStat = await stat(depPath);
-        const cachedMtime = modifiedTimes?.get(depPath);
-        return !cachedMtime || depStat.mtimeMs !== cachedMtime;
-      }),
-    ).then((results) => results.some(Boolean));
-
-    return hasChanged;
-  } catch {
-    return true;
-  }
-}
-
-async function updateModifiedTimes() {
-  if (!config) return;
-
-  const files = [config.__meta.configPath, ...config.__meta.dependencies];
-
-  modifiedTimes = new Map();
-
-  await Promise.all(
-    files.map(async (depPath) => {
-      const depStat = await stat(depPath);
-      modifiedTimes?.set(depPath, depStat.mtimeMs);
-    }),
-  );
-}
-
-export const getCurrentConfig = () => {
-  invariant(config, "Config not loaded");
-  return config;
-};
-
-export const setCurrentConfig = (newConfig: ConfigWithMeta) => {
-  config = newConfig;
-};
-
-export async function loadZudokuConfig(
-  configEnv: ConfigEnv,
-  rootDir: string,
-): Promise<{
-  config: ConfigWithMeta;
-  envPrefix: string[];
-  publicEnv: Record<string, string>;
-}> {
-  const shouldReload = await hasConfigChanged();
-
-  if (!shouldReload && config && envPrefix && publicEnv) {
-    return { config, envPrefix, publicEnv };
-  }
-
-  ({ publicEnv, envPrefix } = loadEnv(configEnv, rootDir));
-
-  try {
-    const loadedConfig = await loadZudokuConfigWithMeta(rootDir);
-    config = await runPluginTransformConfig(loadedConfig);
-
-    logger.info(
-      colors.cyan(`loaded config file `) + colors.dim(config.__meta.configPath),
-      { timestamp: true },
-    );
-
-    return { config, envPrefix, publicEnv };
-  } catch (error) {
-    const errorMessage = error instanceof Error ? error.message : String(error);
-
-    if (config) {
-      // return the last valid config if it exists
-      return { config, envPrefix, publicEnv };
-    }
-
-    throw new Error(errorMessage, { cause: error });
-  } finally {
-    await updateModifiedTimes();
-  }
-}
-
-export const setStandaloneConfig = (rootDir: string) => {
-  config = {
-    __meta: {
-      rootDir,
-      moduleDir: getZudokuRootDir(),
-      mode: "standalone",
-      dependencies: [],
-      configPath: "",
-    },
-  };
-};
+import { stat } from "node:fs/promises";
+import path from "node:path";
+import colors from "picocolors";
+import type { RollupOutput, RollupWatcher } from "rollup";
+import {
+  type ConfigEnv,
+  runnerImport,
+  loadEnv as viteLoadEnv,
+  type Plugin as VitePlugin,
+} from "vite";
+import { logger } from "../cli/common/logger.js";
+import { getZudokuRootDir } from "../cli/common/package-json.js";
+import { runPluginTransformConfig } from "../lib/core/transform-config.js";
+import invariant from "../lib/util/invariant.js";
+import { fileExists } from "./file-exists.js";
+import type { ZudokuConfig } from "./validators/ZudokuConfig.js";
+import { validateConfig } from "./validators/ZudokuConfig.js";
+
+export type ConfigWithMeta = ZudokuConfig & {
+  __meta: {
+    rootDir: string;
+    moduleDir: string;
+    configPath: string;
+    mode: typeof process.env.ZUDOKU_ENV;
+    dependencies: string[];
+  };
+};
+
+let config: ConfigWithMeta | undefined;
+let envPrefix: string[] | undefined;
+let publicEnv: Record<string, string> | undefined;
+let modifiedTimes: Map<string, number> | undefined;
+
+const zudokuConfigFiles = [
+  "apitogo.config.js",
+  "apitogo.config.jsx",
+  "apitogo.config.ts",
+  "apitogo.config.tsx",
+  "apitogo.config.mjs",
+  "zudoku.config.js",
+  "zudoku.config.jsx",
+  "zudoku.config.ts",
+  "zudoku.config.tsx",
+  "zudoku.config.mjs",
+];
+
+const serverConfigOutputFiles = ["apitogo.config.js", "zudoku.config.js"];
+
+async function getConfigFilePath(rootDir: string) {
+  for (const fileName of zudokuConfigFiles) {
+    const filepath = path.join(rootDir, fileName);
+    if (await fileExists(filepath)) {
+      return filepath;
+    }
+  }
+  throw new Error(`No APIToGo or Zudoku config file found in project root.`);
+}
+
+// Stub virtual modules so transitive imports don't fail during config loading.
+// The real Vite server replaces these with actual values at runtime.
+const virtualModuleStubPlugin: VitePlugin = {
+  name: "zudoku-virtual-module-stubs",
+  resolveId(id) {
+    if (id.startsWith("virtual:")) return `\0${id}`;
+  },
+  load(id) {
+    if (id.startsWith("\0virtual:")) return "export default {}";
+  },
+};
+
+async function loadZudokuConfigWithMeta(
+  rootDir: string,
+): Promise<ConfigWithMeta> {
+  const configPath = await getConfigFilePath(rootDir);
+
+  const { module, dependencies } = await runnerImport<{
+    default: ZudokuConfig;
+  }>(configPath, {
+    plugins: [virtualModuleStubPlugin],
+    environments: {
+      inline: {
+        resolve: {
+          // Prevent Node.js from trying to load apitogo's raw .ts source
+          // directly, which fails with ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING
+          // when --experimental-strip-types is enabled. Uses regex to also
+          // catch plugins that re-export from apitogo (e.g. @zuplo/zudoku-plugin-*).
+          noExternal: [/apitogo/],
+        },
+      },
+    },
+    server: {
+      // this allows us to 'load' CSS files in the config
+      // see https://github.com/vitejs/vite/pull/19577
+      perEnvironmentStartEndDuringDev: true,
+    },
+  });
+
+  const config = module.default;
+
+  validateConfig(config, configPath);
+
+  const configWithMetadata: ConfigWithMeta = {
+    ...config,
+    __meta: {
+      rootDir,
+      moduleDir: getZudokuRootDir(),
+      mode: process.env.ZUDOKU_ENV,
+      dependencies,
+      configPath,
+    },
+  };
+
+  return configWithMetadata;
+}
+
+export function findOutputPathOfServerConfig(
+  output: RollupOutput | RollupOutput[] | RollupWatcher,
+) {
+  if (Array.isArray(output)) {
+    throw new Error("Expected a single output, but got an array");
+  }
+  if ("output" in output) {
+    const result = output.output.find(
+      (o) =>
+        "isEntry" in o &&
+        o.isEntry &&
+        serverConfigOutputFiles.includes(o.fileName),
+    );
+    if (result) {
+      return result.fileName;
+    }
+  }
+  throw new Error("Could not find server config output file");
+}
+
+function loadEnv(configEnv: ConfigEnv, rootDir: string) {
+  const envPrefix = ["ZUPLO_PUBLIC_", "ZUDOKU_PUBLIC_"];
+  const localEnv = viteLoadEnv(configEnv.mode, rootDir, envPrefix);
+
+  process.env = { ...localEnv, ...process.env };
+
+  const publicEnv = Object.fromEntries(
+    Object.entries(process.env)
+      .filter(([key]) => envPrefix.some((prefix) => key.startsWith(prefix)))
+      .map(([key, value]) => [key, JSON.stringify(value)]),
+  );
+
+  return { publicEnv, envPrefix };
+}
+
+async function hasConfigChanged() {
+  if (!config || !modifiedTimes) return true;
+
+  const files = [config.__meta.configPath, ...config.__meta.dependencies];
+
+  try {
+    const hasChanged = await Promise.all(
+      files.map(async (depPath) => {
+        const depStat = await stat(depPath);
+        const cachedMtime = modifiedTimes?.get(depPath);
+        return !cachedMtime || depStat.mtimeMs !== cachedMtime;
+      }),
+    ).then((results) => results.some(Boolean));
+
+    return hasChanged;
+  } catch {
+    return true;
+  }
+}
+
+async function updateModifiedTimes() {
+  if (!config) return;
+
+  const files = [config.__meta.configPath, ...config.__meta.dependencies];
+
+  modifiedTimes = new Map();
+
+  await Promise.all(
+    files.map(async (depPath) => {
+      const depStat = await stat(depPath);
+      modifiedTimes?.set(depPath, depStat.mtimeMs);
+    }),
+  );
+}
+
+export const getCurrentConfig = () => {
+  invariant(config, "Config not loaded");
+  return config;
+};
+
+export const setCurrentConfig = (newConfig: ConfigWithMeta) => {
+  config = newConfig;
+};
+
+export async function loadZudokuConfig(
+  configEnv: ConfigEnv,
+  rootDir: string,
+): Promise<{
+  config: ConfigWithMeta;
+  envPrefix: string[];
+  publicEnv: Record<string, string>;
+}> {
+  const shouldReload = await hasConfigChanged();
+
+  if (!shouldReload && config && envPrefix && publicEnv) {
+    return { config, envPrefix, publicEnv };
+  }
+
+  ({ publicEnv, envPrefix } = loadEnv(configEnv, rootDir));
+
+  try {
+    const loadedConfig = await loadZudokuConfigWithMeta(rootDir);
+    config = await runPluginTransformConfig(loadedConfig);
+
+    logger.info(
+      colors.cyan(`loaded config file `) + colors.dim(config.__meta.configPath),
+      { timestamp: true },
+    );
+
+    return { config, envPrefix, publicEnv };
+  } catch (error) {
+    const errorMessage = error instanceof Error ? error.message : String(error);
+
+    if (config) {
+      // return the last valid config if it exists
+      return { config, envPrefix, publicEnv };
+    }
+
+    throw new Error(errorMessage, { cause: error });
+  } finally {
+    await updateModifiedTimes();
+  }
+}
+
+export const setStandaloneConfig = (rootDir: string) => {
+  config = {
+    __meta: {
+      rootDir,
+      moduleDir: getZudokuRootDir(),
+      mode: "standalone",
+      dependencies: [],
+      configPath: "",
+    },
+  };
+};

package/src/index.ts

@@ -1,33 +1,33 @@
-export type { ZudokuBuildConfig, ZudokuConfig } from "./config/config.js";
-export { createPlugin } from "./config/create-plugin.js";
-export type { InputNavigation as Navigation } from "./config/validators/InputNavigationSchema.js";
-export type { SlotType } from "./lib/components/context/SlotProvider.js";
-export {
-  type CustomSlotNames,
-  Slot,
-  type SlotName,
-} from "./lib/components/Slot.js";
-export type {
-  ApiIdentityPlugin,
-  AuthenticationPlugin,
-  CommonPlugin,
-  NavigationPlugin,
-  ProfileMenuPlugin,
-  ProfileNavigationItem,
-  RouteObject,
-  SearchProviderPlugin,
-  TransformConfigContext,
-  ZudokuPlugin,
-} from "./lib/core/plugins.js";
-export { type ApiIdentity, ZudokuContext } from "./lib/core/ZudokuContext.js";
-/** @deprecated Import from `apitogo/hooks` instead */
-export { useEvent } from "./lib/hooks/index.js";
-export type { MDXImport } from "./lib/plugins/markdown/index.js";
-export { defaultLanguages } from "./lib/shiki.js";
-export { cn } from "./lib/ui/util.js";
-export { joinUrl } from "./lib/util/joinUrl.js";
-export {
-  type ProblemJson,
-  throwIfProblemJson,
-} from "./lib/util/problemJson.js";
-export type { MdxComponentsType } from "./lib/util/MdxComponents.js";
+export type { ZudokuBuildConfig, ZudokuConfig } from "./config/config.js";
+export { createPlugin } from "./config/create-plugin.js";
+export type { InputNavigation as Navigation } from "./config/validators/InputNavigationSchema.js";
+export type { SlotType } from "./lib/components/context/SlotProvider.js";
+export {
+  type CustomSlotNames,
+  Slot,
+  type SlotName,
+} from "./lib/components/Slot.js";
+export type {
+  ApiIdentityPlugin,
+  AuthenticationPlugin,
+  CommonPlugin,
+  NavigationPlugin,
+  ProfileMenuPlugin,
+  ProfileNavigationItem,
+  RouteObject,
+  SearchProviderPlugin,
+  TransformConfigContext,
+  ZudokuPlugin,
+} from "./lib/core/plugins.js";
+export { type ApiIdentity, ZudokuContext } from "./lib/core/ZudokuContext.js";
+/** @deprecated Import from `apitogo/hooks` instead */
+export { useEvent } from "./lib/hooks/index.js";
+export type { MDXImport } from "./lib/plugins/markdown/index.js";
+export { defaultLanguages } from "./lib/shiki.js";
+export { cn } from "./lib/ui/util.js";
+export { joinUrl } from "./lib/util/joinUrl.js";
+export {
+  type ProblemJson,
+  throwIfProblemJson,
+} from "./lib/util/problemJson.js";
+export type { MdxComponentsType } from "./lib/util/MdxComponents.js";

package/src/lib/authentication/components/CallbackHandler.tsx

@@ -1,45 +1,45 @@
-import { useSuspenseQuery } from "@tanstack/react-query";
-import { Navigate } from "react-router";
-import { useZudoku } from "@lukoweb/apitogo/components";
-import { joinUrl } from "../../util/joinUrl.js";
-import { normalizeRedirectUrl } from "../../util/url.js";
-import { OAuthAuthorizationError, type OAuthErrorType } from "../errors.js";
-
-export function CallbackHandler({
-  handleCallback,
-}: {
-  handleCallback: () => Promise<string>;
-}) {
-  const { options } = useZudoku();
-  const executeCallback = useSuspenseQuery({
-    retry: false,
-    queryKey: ["oauth-callback", window.location.search],
-    queryFn: async () => {
-      const url = new URL(window.location.href);
-
-      const errorParam = url.searchParams.get("error");
-      const errorDescription =
-        url.searchParams.get("error_description") ?? undefined;
-      const errorUri = url.searchParams.get("error_uri") ?? undefined;
-      if (errorParam) {
-        throw new OAuthAuthorizationError(
-          `OAuth error '${errorParam}': ${errorDescription}`,
-          {
-            error: errorParam as OAuthErrorType,
-            error_description: errorDescription,
-            error_uri: errorUri,
-          },
-        );
-      }
-      return joinUrl(
-        normalizeRedirectUrl(
-          await handleCallback(),
-          window.location.origin,
-          options.basePath,
-        ),
-      );
-    },
-  });
-
-  return <Navigate to={executeCallback.data} replace />;
-}
+import { useZudoku } from "@lukoweb/apitogo/components";
+import { useSuspenseQuery } from "@tanstack/react-query";
+import { Navigate } from "react-router";
+import { joinUrl } from "../../util/joinUrl.js";
+import { normalizeRedirectUrl } from "../../util/url.js";
+import { OAuthAuthorizationError, type OAuthErrorType } from "../errors.js";
+
+export function CallbackHandler({
+  handleCallback,
+}: {
+  handleCallback: () => Promise<string>;
+}) {
+  const { options } = useZudoku();
+  const executeCallback = useSuspenseQuery({
+    retry: false,
+    queryKey: ["oauth-callback", window.location.search],
+    queryFn: async () => {
+      const url = new URL(window.location.href);
+
+      const errorParam = url.searchParams.get("error");
+      const errorDescription =
+        url.searchParams.get("error_description") ?? undefined;
+      const errorUri = url.searchParams.get("error_uri") ?? undefined;
+      if (errorParam) {
+        throw new OAuthAuthorizationError(
+          `OAuth error '${errorParam}': ${errorDescription}`,
+          {
+            error: errorParam as OAuthErrorType,
+            error_description: errorDescription,
+            error_uri: errorUri,
+          },
+        );
+      }
+      return joinUrl(
+        normalizeRedirectUrl(
+          await handleCallback(),
+          window.location.origin,
+          options.basePath,
+        ),
+      );
+    },
+  });
+
+  return <Navigate to={executeCallback.data} replace />;
+}