@lukoweb/apitogo 0.2.22 → 0.2.24

package/src/app/main.tsx

@@ -1,167 +1,167 @@
-import { Apitogo } from "@lukoweb/apitogo/components";
-import { Outlet } from "@lukoweb/apitogo/router";
-import type { RouteObject } from "react-router";
-import type { HighlighterCore } from "shiki";
-import { configuredApiKeysPlugin } from "virtual:zudoku-api-keys-plugin";
-import {
-  configuredApiCatalogPlugins,
-  configuredApiPlugins,
-} from "virtual:zudoku-api-plugins";
-import { configuredAuthProvider } from "virtual:zudoku-auth";
-import { configuredCustomPagesPlugin } from "virtual:zudoku-custom-pages-plugin";
-import { configuredDocsPlugin } from "virtual:zudoku-docs-plugin";
-import {
-  configuredModulesPlugins,
-  configuredModulesSlots,
-} from "virtual:zudoku-modules-plugin";
-import "virtual:zudoku-theme.css";
-import {
-  configuredHeaderNavigation,
-  configuredNavigation,
-  configuredNavigationRules,
-} from "virtual:zudoku-navigation";
-import { configuredSearchPlugin } from "virtual:zudoku-search-plugin";
-import type { ApitogoConfig } from "../config/config.js";
-import {
-  resolveModulesConfig,
-  getEffectiveRedirects,
-} from "../config/resolve-modules.js";
-import { BuildCheck } from "../lib/components/BuildCheck.js";
-import "./main.css";
-import { Meta } from "../lib/components/Meta.js";
-import "./polyfills.js";
-import { StatusPage } from "../lib/components/StatusPage.js";
-import { isNavigationPlugin } from "../lib/core/plugins.js";
-import { RouteGuard } from "../lib/core/RouteGuard.js";
-import type { ZudokuContextOptions } from "../lib/core/ZudokuContext.js";
-import { RouterError } from "../lib/errors/RouterError.js";
-import { ZuploEnv } from "./env.js";
-import { processRoutes } from "./processRoutes.js";
-import { createRedirectRoutes } from "./utils/createRedirectRoutes.js";
-
-export const shikiReady: Promise<HighlighterCore> =
-  import("../lib/shiki.js").then(async ({ highlighterPromise }) => {
-    const highlighter = await highlighterPromise;
-    const { registerShiki } = await import("virtual:zudoku-shiki-register");
-    await registerShiki(highlighter);
-    return highlighter;
-  });
-
-export const convertApitogoConfigToOptions = (
-  config: ApitogoConfig,
-): ZudokuContextOptions => {
-  const siteTitle =
-    config.metadata?.applicationName ?? config.site?.title ?? "API ToGo";
-
-  return {
-    basePath: config.basePath,
-    canonicalUrlOrigin: config.canonicalUrlOrigin,
-    aiAssistants: config.aiAssistants,
-    protectedRoutes: config.protectedRoutes,
-    site: {
-      ...config.site,
-      showPoweredBy: ZuploEnv.buildConfig?.entitlements.devPortalZuploBranding,
-      logo: config.site?.logo,
-    },
-    slots: { ...configuredModulesSlots, ...config.slots },
-    metadata: {
-      applicationName: siteTitle,
-      defaultTitle: siteTitle,
-      title: `%s - ${siteTitle}`,
-      ...config.metadata,
-    },
-    header: {
-      navigation: configuredHeaderNavigation,
-      placements: config.header?.placements,
-    },
-    navigation: configuredNavigation,
-    navigationRules: configuredNavigationRules,
-    mdx: config.mdx,
-    plugins: [
-      ...(configuredAuthProvider ? [configuredAuthProvider] : []),
-      ...(configuredDocsPlugin ? [configuredDocsPlugin] : []),
-      ...configuredApiPlugins,
-      ...(configuredSearchPlugin ? [configuredSearchPlugin] : []),
-      ...(configuredApiKeysPlugin ? [configuredApiKeysPlugin] : []),
-      ...(configuredCustomPagesPlugin ? [configuredCustomPagesPlugin] : []),
-      ...configuredModulesPlugins,
-      ...configuredApiCatalogPlugins,
-      ...(config.plugins ?? []),
-    ],
-    syntaxHighlighting: {
-      highlighterPromise: shikiReady,
-      themes: config.syntaxHighlighting?.themes,
-    },
-  };
-};
-
-/**
- * @deprecated Use {@link convertApitogoConfigToOptions} instead.
- */
-export const convertZudokuConfigToOptions = convertApitogoConfigToOptions;
-
-export const getRoutesByOptions = (
-  options: ZudokuContextOptions,
-  enableStatusPages = true,
-) => {
-  const allPlugins = [
-    ...(options.plugins ?? []),
-    ...(options.authentication ? [options.authentication] : []),
-  ];
-
-  const routes = allPlugins
-    .flatMap((plugin) => (isNavigationPlugin(plugin) ? plugin.getRoutes() : []))
-    .concat(
-      enableStatusPages
-        ? [400, 404, 500].map((statusCode) => ({
-            path: `/${statusCode}`,
-            element: <StatusPage statusCode={statusCode} />,
-          }))
-        : [],
-    )
-    .concat([{ path: "*", element: <StatusPage statusCode={404} /> }])
-    .map((route) => ({
-      ...route,
-      errorElement: <RouterError className="w-full m-0" />,
-    }));
-
-  // @TODO Detect conflicts in routes and log warning
-
-  return routes;
-};
-
-export const getRoutesByConfig = (config: ApitogoConfig): RouteObject[] => {
-  const resolvedModules = resolveModulesConfig(config);
-  const options = convertApitogoConfigToOptions(config);
-  const routes = getRoutesByOptions(
-    options,
-    import.meta.env.IS_ZUPLO || config.enableStatusPages,
-  );
-
-  return [
-    ...createRedirectRoutes(getEffectiveRedirects(config, resolvedModules)),
-    {
-      element: (
-        <Apitogo {...options} env={import.meta.env}>
-          <BuildCheck
-            buildId={import.meta.env.ZUPLO_BUILD_ID}
-            environmentType={import.meta.env.ZUPLO_ENVIRONMENT_TYPE}
-          />
-          <Outlet />
-        </Apitogo>
-      ),
-      hydrateFallbackElement: <div>Loading...</div>,
-      children: [
-        {
-          element: (
-            <Meta>
-              <RouteGuard />
-            </Meta>
-          ),
-          errorElement: <RouterError />,
-          children: processRoutes(routes),
-        },
-      ],
-    },
-  ];
-};
+import { Apitogo } from "@lukoweb/apitogo/components";
+import { Outlet } from "@lukoweb/apitogo/router";
+import type { RouteObject } from "react-router";
+import type { HighlighterCore } from "shiki";
+import { configuredApiKeysPlugin } from "virtual:zudoku-api-keys-plugin";
+import {
+  configuredApiCatalogPlugins,
+  configuredApiPlugins,
+} from "virtual:zudoku-api-plugins";
+import { configuredAuthProvider } from "virtual:zudoku-auth";
+import { configuredCustomPagesPlugin } from "virtual:zudoku-custom-pages-plugin";
+import { configuredDocsPlugin } from "virtual:zudoku-docs-plugin";
+import {
+  configuredModulesPlugins,
+  configuredModulesSlots,
+} from "virtual:zudoku-modules-plugin";
+import "virtual:zudoku-theme.css";
+import {
+  configuredHeaderNavigation,
+  configuredNavigation,
+  configuredNavigationRules,
+} from "virtual:zudoku-navigation";
+import { configuredSearchPlugin } from "virtual:zudoku-search-plugin";
+import type { ApitogoConfig } from "../config/config.js";
+import {
+  resolveModulesConfig,
+  getEffectiveRedirects,
+} from "../config/resolve-modules.js";
+import { BuildCheck } from "../lib/components/BuildCheck.js";
+import "./main.css";
+import { Meta } from "../lib/components/Meta.js";
+import "./polyfills.js";
+import { StatusPage } from "../lib/components/StatusPage.js";
+import { isNavigationPlugin } from "../lib/core/plugins.js";
+import { RouteGuard } from "../lib/core/RouteGuard.js";
+import type { ZudokuContextOptions } from "../lib/core/ZudokuContext.js";
+import { RouterError } from "../lib/errors/RouterError.js";
+import { ZuploEnv } from "./env.js";
+import { processRoutes } from "./processRoutes.js";
+import { createRedirectRoutes } from "./utils/createRedirectRoutes.js";
+
+export const shikiReady: Promise<HighlighterCore> =
+  import("../lib/shiki.js").then(async ({ highlighterPromise }) => {
+    const highlighter = await highlighterPromise;
+    const { registerShiki } = await import("virtual:zudoku-shiki-register");
+    await registerShiki(highlighter);
+    return highlighter;
+  });
+
+export const convertApitogoConfigToOptions = (
+  config: ApitogoConfig,
+): ZudokuContextOptions => {
+  const siteTitle =
+    config.metadata?.applicationName ?? config.site?.title ?? "API ToGo";
+
+  return {
+    basePath: config.basePath,
+    canonicalUrlOrigin: config.canonicalUrlOrigin,
+    aiAssistants: config.aiAssistants,
+    protectedRoutes: config.protectedRoutes,
+    site: {
+      ...config.site,
+      showPoweredBy: ZuploEnv.buildConfig?.entitlements.devPortalZuploBranding,
+      logo: config.site?.logo,
+    },
+    slots: { ...configuredModulesSlots, ...config.slots },
+    metadata: {
+      applicationName: siteTitle,
+      defaultTitle: siteTitle,
+      title: `%s - ${siteTitle}`,
+      ...config.metadata,
+    },
+    header: {
+      navigation: configuredHeaderNavigation,
+      placements: config.header?.placements,
+    },
+    navigation: configuredNavigation,
+    navigationRules: configuredNavigationRules,
+    mdx: config.mdx,
+    plugins: [
+      ...(configuredAuthProvider ? [configuredAuthProvider] : []),
+      ...(configuredDocsPlugin ? [configuredDocsPlugin] : []),
+      ...configuredApiPlugins,
+      ...(configuredSearchPlugin ? [configuredSearchPlugin] : []),
+      ...(configuredApiKeysPlugin ? [configuredApiKeysPlugin] : []),
+      ...(configuredCustomPagesPlugin ? [configuredCustomPagesPlugin] : []),
+      ...configuredModulesPlugins,
+      ...configuredApiCatalogPlugins,
+      ...(config.plugins ?? []),
+    ],
+    syntaxHighlighting: {
+      highlighterPromise: shikiReady,
+      themes: config.syntaxHighlighting?.themes,
+    },
+  };
+};
+
+/**
+ * @deprecated Use {@link convertApitogoConfigToOptions} instead.
+ */
+export const convertZudokuConfigToOptions = convertApitogoConfigToOptions;
+
+export const getRoutesByOptions = (
+  options: ZudokuContextOptions,
+  enableStatusPages = true,
+) => {
+  const allPlugins = [
+    ...(options.plugins ?? []),
+    ...(options.authentication ? [options.authentication] : []),
+  ];
+
+  const routes = allPlugins
+    .flatMap((plugin) => (isNavigationPlugin(plugin) ? plugin.getRoutes() : []))
+    .concat(
+      enableStatusPages
+        ? [400, 404, 500].map((statusCode) => ({
+            path: `/${statusCode}`,
+            element: <StatusPage statusCode={statusCode} />,
+          }))
+        : [],
+    )
+    .concat([{ path: "*", element: <StatusPage statusCode={404} /> }])
+    .map((route) => ({
+      ...route,
+      errorElement: <RouterError className="w-full m-0" />,
+    }));
+
+  // @TODO Detect conflicts in routes and log warning
+
+  return routes;
+};
+
+export const getRoutesByConfig = (config: ApitogoConfig): RouteObject[] => {
+  const resolvedModules = resolveModulesConfig(config);
+  const options = convertApitogoConfigToOptions(config);
+  const routes = getRoutesByOptions(
+    options,
+    import.meta.env.IS_ZUPLO || config.enableStatusPages,
+  );
+
+  return [
+    ...createRedirectRoutes(getEffectiveRedirects(config, resolvedModules)),
+    {
+      element: (
+        <Apitogo {...options} env={import.meta.env}>
+          <BuildCheck
+            buildId={import.meta.env.ZUPLO_BUILD_ID}
+            environmentType={import.meta.env.ZUPLO_ENVIRONMENT_TYPE}
+          />
+          <Outlet />
+        </Apitogo>
+      ),
+      hydrateFallbackElement: <div>Loading...</div>,
+      children: [
+        {
+          element: (
+            <Meta>
+              <RouteGuard />
+            </Meta>
+          ),
+          errorElement: <RouterError />,
+          children: processRoutes(routes),
+        },
+      ],
+    },
+  ];
+};

package/src/app/polyfills.ts

@@ -1,47 +1,47 @@
-if (typeof Object.groupBy === "undefined") {
-  Object.groupBy = <K extends PropertyKey, T>(
-    items: Iterable<T>,
-    keySelector: (item: T, index: number) => K,
-  ): Partial<Record<K, T[]>> => {
-    const result = {} as Record<K, T[]>;
-    let index = 0;
-
-    for (const item of items) {
-      const key = keySelector(item, index++);
-
-      result[key] ??= [];
-      result[key].push(item);
-    }
-    return result;
-  };
-}
-
-// Freeze --scrollbar-width when react-remove-scroll locks the body, preventing
-// the CSS calc(100vw - 100%) from recalculating to 0 and causing layout shift.
-if (typeof window !== "undefined") {
-  new MutationObserver(() => {
-    const locked = document.body.hasAttribute("data-scroll-locked");
-    const gap = locked
-      ? getComputedStyle(document.body).getPropertyValue(
-          "--removed-body-scroll-bar-size",
-        )
-      : "";
-
-    if (gap) {
-      document.documentElement.style.setProperty("--scrollbar-width", gap);
-    } else {
-      document.documentElement.style.removeProperty("--scrollbar-width");
-    }
-  }).observe(document.body, {
-    attributes: true,
-    attributeFilter: ["data-scroll-locked"],
-  });
-}
-
-if (typeof window !== "undefined" && !window.requestIdleCallback) {
-  window.requestIdleCallback = (cb: IdleRequestCallback) =>
-    Number(
-      setTimeout(() => cb({ didTimeout: false, timeRemaining: () => 50 }), 1),
-    );
-  window.cancelIdleCallback = (id: number) => clearTimeout(id);
-}
+if (typeof Object.groupBy === "undefined") {
+  Object.groupBy = <K extends PropertyKey, T>(
+    items: Iterable<T>,
+    keySelector: (item: T, index: number) => K,
+  ): Partial<Record<K, T[]>> => {
+    const result = {} as Record<K, T[]>;
+    let index = 0;
+
+    for (const item of items) {
+      const key = keySelector(item, index++);
+
+      result[key] ??= [];
+      result[key].push(item);
+    }
+    return result;
+  };
+}
+
+// Freeze --scrollbar-width when react-remove-scroll locks the body, preventing
+// the CSS calc(100vw - 100%) from recalculating to 0 and causing layout shift.
+if (typeof window !== "undefined") {
+  new MutationObserver(() => {
+    const locked = document.body.hasAttribute("data-scroll-locked");
+    const gap = locked
+      ? getComputedStyle(document.body).getPropertyValue(
+          "--removed-body-scroll-bar-size",
+        )
+      : "";
+
+    if (gap) {
+      document.documentElement.style.setProperty("--scrollbar-width", gap);
+    } else {
+      document.documentElement.style.removeProperty("--scrollbar-width");
+    }
+  }).observe(document.body, {
+    attributes: true,
+    attributeFilter: ["data-scroll-locked"],
+  });
+}
+
+if (typeof window !== "undefined" && !window.requestIdleCallback) {
+  window.requestIdleCallback = (cb: IdleRequestCallback) =>
+    Number(
+      setTimeout(() => cb({ didTimeout: false, timeRemaining: () => 50 }), 1),
+    );
+  window.cancelIdleCallback = (id: number) => clearTimeout(id);
+}

package/src/app/processRoutes.tsx

@@ -1,51 +1,51 @@
-import type { RouteObject } from "react-router";
-import { LandingLayout } from "../lib/components/LandingLayout.js";
-import { Layout } from "../lib/components/Layout.js";
-
-type LayoutMode = "default" | "landing" | "none";
-
-const resolveLayoutComponent = (layout: LayoutMode | undefined) => {
-  if (layout === "landing") {
-    return LandingLayout;
-  }
-
-  return Layout;
-};
-
-const shouldWrapRoute = (
-  layout: LayoutMode | undefined,
-  layoutDisabled?: boolean,
-) => {
-  if (layout === "none") {
-    return false;
-  }
-
-  if (layoutDisabled) {
-    return layout === "default" || layout === "landing";
-  }
-
-  return true;
-};
-
-export const processRoutes = (
-  routes: RouteObject[],
-  layoutDisabled?: boolean,
-): RouteObject[] =>
-  routes.map((r) => {
-    const layout = r.handle?.layout as LayoutMode | undefined;
-    const wrapRoute = shouldWrapRoute(layout, layoutDisabled);
-    const LayoutComponent = wrapRoute ? resolveLayoutComponent(layout) : null;
-
-    const route = r.children
-      ? {
-          ...r,
-          children: LayoutComponent
-            ? r.children
-            : processRoutes(r.children, true),
-        }
-      : r;
-
-    return LayoutComponent
-      ? { element: <LayoutComponent />, children: [route] }
-      : route;
-  });
+import type { RouteObject } from "react-router";
+import { LandingLayout } from "../lib/components/LandingLayout.js";
+import { Layout } from "../lib/components/Layout.js";
+
+type LayoutMode = "default" | "landing" | "none";
+
+const resolveLayoutComponent = (layout: LayoutMode | undefined) => {
+  if (layout === "landing") {
+    return LandingLayout;
+  }
+
+  return Layout;
+};
+
+const shouldWrapRoute = (
+  layout: LayoutMode | undefined,
+  layoutDisabled?: boolean,
+) => {
+  if (layout === "none") {
+    return false;
+  }
+
+  if (layoutDisabled) {
+    return layout === "default" || layout === "landing";
+  }
+
+  return true;
+};
+
+export const processRoutes = (
+  routes: RouteObject[],
+  layoutDisabled?: boolean,
+): RouteObject[] =>
+  routes.map((r) => {
+    const layout = r.handle?.layout as LayoutMode | undefined;
+    const wrapRoute = shouldWrapRoute(layout, layoutDisabled);
+    const LayoutComponent = wrapRoute ? resolveLayoutComponent(layout) : null;
+
+    const route = r.children
+      ? {
+          ...r,
+          children: LayoutComponent
+            ? r.children
+            : processRoutes(r.children, true),
+        }
+      : r;
+
+    return LayoutComponent
+      ? { element: <LayoutComponent />, children: [route] }
+      : route;
+  });

package/src/app/sentry.ts

@@ -1,24 +1,24 @@
-import * as Sentry from "@sentry/react";
-import { useEffect } from "react";
-import {
-  createRoutesFromChildren,
-  matchRoutes,
-  useLocation,
-  useNavigationType,
-} from "react-router";
-
-export const initSentry = ({ dsn }: { dsn: string }) => {
-  Sentry.init({
-    dsn,
-    integrations: [
-      Sentry.reactRouterV7BrowserTracingIntegration({
-        useEffect,
-        useLocation,
-        useNavigationType,
-        createRoutesFromChildren,
-        matchRoutes,
-      }),
-      Sentry.replayIntegration(),
-    ],
-  });
-};
+import * as Sentry from "@sentry/react";
+import { useEffect } from "react";
+import {
+  createRoutesFromChildren,
+  matchRoutes,
+  useLocation,
+  useNavigationType,
+} from "react-router";
+
+export const initSentry = ({ dsn }: { dsn: string }) => {
+  Sentry.init({
+    dsn,
+    integrations: [
+      Sentry.reactRouterV7BrowserTracingIntegration({
+        useEffect,
+        useLocation,
+        useNavigationType,
+        createRoutesFromChildren,
+        matchRoutes,
+      }),
+      Sentry.replayIntegration(),
+    ],
+  });
+};

package/src/app/standalone.html

@@ -1,23 +1,23 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <link
-      rel="icon"
-      type="image/svg+xml"
-      href="https://cdn.zudoku.dev/logos/favicon.svg"
-    />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
-    />
-    <title>Zudoku</title>
-    <script type="module" crossorigin src="./main.js"></script>
-    <link rel="stylesheet" crossorigin href="./zudoku.css" />
-  </head>
-  <body>
-    <div
-      data-api-url="https://blue-sloth-main-afc3428.d2.zuplo.dev/schemas/rewiring-america"
-    ></div>
-  </body>
-</html>
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link
+      rel="icon"
+      type="image/svg+xml"
+      href="https://cdn.zudoku.dev/logos/favicon.svg"
+    />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <title>Zudoku</title>
+    <script type="module" crossorigin src="./main.js"></script>
+    <link rel="stylesheet" crossorigin href="./zudoku.css" />
+  </head>
+  <body>
+    <div
+      data-api-url="https://blue-sloth-main-afc3428.d2.zuplo.dev/schemas/rewiring-america"
+    ></div>
+  </body>
+</html>