@mehdad67/apitogo 0.1.24

package/src/app/main.css

@@ -0,0 +1,390 @@
+/* @vite-plugin-inject defaultTheme */
+@import "tailwindcss" source("..");
+@import "tw-animate-css";
+
+/* @vite-plugin-inject main */
+
+@plugin "@tailwindcss/typography";
+@custom-variant dark (&:is(.dark *));
+
+@theme inline {
+  --color-warning: var(--warning);
+  --color-warning-foreground: var(--warning-foreground);
+  --color-background: var(--background);
+  --color-foreground: var(--foreground);
+  --color-card: var(--card);
+  --color-card-foreground: var(--card-foreground);
+  --color-popover: var(--popover);
+  --color-popover-foreground: var(--popover-foreground);
+  --color-primary: var(--primary);
+  --color-primary-foreground: var(--primary-foreground);
+  --color-secondary: var(--secondary);
+  --color-secondary-foreground: var(--secondary-foreground);
+  --color-muted: var(--muted);
+  --color-muted-foreground: var(--muted-foreground);
+  --color-accent: var(--accent);
+  --color-accent-foreground: var(--accent-foreground);
+  --color-destructive: var(--destructive);
+  --color-destructive-foreground: var(--destructive-foreground);
+  --color-border: var(--border);
+  --color-input: var(--input);
+  --color-ring: var(--ring);
+  --color-chart-1: var(--chart-1);
+  --color-chart-2: var(--chart-2);
+  --color-chart-3: var(--chart-3);
+  --color-chart-4: var(--chart-4);
+  --color-chart-5: var(--chart-5);
+  --color-sidebar: var(--sidebar);
+  --color-sidebar-foreground: var(--sidebar-foreground);
+  --color-sidebar-primary: var(--sidebar-primary);
+  --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
+  --color-sidebar-accent: var(--sidebar-accent);
+  --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
+  --color-sidebar-border: var(--sidebar-border);
+  --color-sidebar-ring: var(--sidebar-ring);
+  --radius-sm: calc(var(--radius) - 4px);
+  --radius-md: calc(var(--radius) - 2px);
+  --radius-lg: var(--radius);
+  --radius-xl: calc(var(--radius) + 4px);
+  --font-sans: var(--font-sans);
+  --font-mono: var(--font-mono);
+  --font-serif: var(--font-serif);
+}
+
+@utility prose {
+  a {
+    @apply font-normal underline-offset-4 hover:text-primary;
+  }
+  blockquote {
+    @apply not-italic text-neutral-500/75 dark:text-neutral-400;
+    /* Disable adding quote marks to block-quotes: https://github.com/tailwindlabs/tailwindcss-typography/issues/66 */
+    p {
+      &:first-of-type::before,
+      &:last-of-type::after {
+        content: none;
+      }
+    }
+  }
+  hr {
+    @apply border-border my-4;
+  }
+  code {
+    font-weight: 400;
+  }
+  code::before {
+    content: none;
+  }
+  code::after {
+    content: none;
+  }
+
+  ol > li {
+    @apply my-2.5;
+  }
+
+  header:has(h1) {
+    & + p {
+      @apply my-0;
+    }
+  }
+
+  h2 {
+    @apply mt-8 mb-4;
+  }
+
+  ul.contains-task-list {
+    @apply list-none px-0;
+    li {
+      @apply my-1 flex items-center gap-1.5;
+    }
+  }
+}
+
+@layer base {
+  :root {
+    --top-header-height: 65px;
+    --top-nav-height: 50px;
+    --banner-height: 35px;
+    --header-height: calc(
+      var(--top-header-height) + var(--top-nav-height) + var(--banner-height)
+    );
+    --scroll-padding: calc(var(--header-height) + 10px);
+    --side-nav-width: --spacing(72);
+    --padding-content-top: --spacing(6);
+    --padding-content-bottom: --spacing(12);
+    --padding-nav-item: --spacing(2.5);
+    --sidecar-grid-cols: 1fr minmax(200px, 260px);
+    --scrollbar-width: calc(100vw - 100%);
+  }
+
+  * {
+    border-color: var(--border);
+    outline-color: var(--ring);
+  }
+
+  html {
+    /* This is to prevent layout jumping when the scrollbar appears/disappears */
+    @apply -me-(--scrollbar-width) scroll-pt-(--scroll-padding);
+    --dark: -1;
+  }
+
+  html.dark {
+    --dark: 1;
+  }
+
+  html,
+  body {
+    @apply h-full overscroll-none;
+  }
+
+  ::view-transition-old(root),
+  ::view-transition-new(root) {
+    animation: none;
+  }
+
+  details summary {
+    @apply cursor-pointer;
+  }
+
+  #root {
+    @apply min-h-screen w-full grid grid-rows-[auto_1fr];
+  }
+
+  * {
+    @apply border-border;
+  }
+
+  body {
+    @apply antialiased bg-background text-foreground overflow-y-auto overflow-x-clip;
+    font-feature-settings:
+      "rlig" 1,
+      "calt" 1;
+  }
+
+  ::selection {
+    background: var(--color-primary);
+    color: var(--color-primary-foreground);
+  }
+
+  .bg-primary::selection,
+  .bg-primary ::selection {
+    background: var(--color-background);
+    color: var(--color-foreground);
+  }
+
+  .dark {
+    color-scheme: dark;
+  }
+
+  button:not(:disabled),
+  [role="button"]:not(:disabled) {
+    cursor: pointer;
+  }
+
+  .shiki {
+    counter-reset: line;
+    @apply leading-normal;
+    background-color: var(--shiki-light-bg) !important;
+  }
+  .dark .shiki {
+    background-color: var(--shiki-dark-bg) !important;
+  }
+  .code-block .shiki {
+    @apply grid grid-rows-1 whitespace-pre;
+    grid-auto-rows: 1lh;
+  }
+
+  .shiki,
+  .shiki span {
+    color: var(--shiki-light);
+    font-style: var(--shiki-light-font-style) !important;
+    font-weight: var(--shiki-light-font-weight) !important;
+    text-decoration: var(--shiki-light-text-decoration) !important;
+  }
+
+  .dark .shiki,
+  .dark .shiki span {
+    color: var(--shiki-dark);
+    font-style: var(--shiki-dark-font-style) !important;
+    font-weight: var(--shiki-dark-font-weight) !important;
+    text-decoration: var(--shiki-dark-text-decoration) !important;
+  }
+
+  .line-numbers .shiki .line::before {
+    counter-increment: line;
+    content: counter(line);
+    @apply tabular-nums inline-flex items-baseline justify-end me-4 w-3 text-muted-foreground/25;
+  }
+
+  .shiki.not-inline .line {
+    @apply block -mx-4 px-4;
+    width: calc(100% + --spacing(7));
+    --highlighted-bg: hsl(from var(--shiki-light-bg) h s calc(l - 6));
+  }
+  .dark .shiki.not-inline .line {
+    --highlighted-bg: hsl(from var(--shiki-dark-bg) h s calc(l + 10));
+  }
+
+  .shiki .line.highlighted {
+    @apply bg-(--highlighted-bg) relative;
+  }
+
+  .shiki .line.highlighted::after {
+    @apply absolute left-0 top-0 bottom-0 right-auto translate-x-full content-[''];
+    border-left: 4px solid
+      hsl(from var(--highlighted-bg) h s calc(l + 4 * var(--dark)));
+  }
+
+  .shiki .highlighted-word {
+    @apply inline-block bg-(--highlighted-bg) px-0.5 rounded;
+  }
+
+  select {
+    @apply focus-visible:ring-primary focus-visible:ring-[1.5px] focus:outline-hidden;
+  }
+
+  .CollapsibleContent {
+    --easing: cubic-bezier(0.4, 0, 0.2, 1);
+    --slide-offset: -0.75rem;
+  }
+  .CollapsibleContent[data-state="open"] {
+    animation: slideDown 300ms var(--easing);
+  }
+  .CollapsibleContent[data-state="closed"] {
+    animation: slideUp 300ms var(--easing);
+  }
+
+  @keyframes slideDown {
+    from {
+      height: 0;
+      opacity: 0;
+      transform: translateY(var(--slide-offset));
+    }
+    to {
+      height: var(--radix-collapsible-content-height);
+      opacity: 1;
+      transform: translateY(0);
+    }
+  }
+
+  @keyframes slideUp {
+    from {
+      height: var(--radix-collapsible-content-height);
+      opacity: 1;
+      transform: translateY(0);
+    }
+    to {
+      height: 0;
+      opacity: 0;
+      transform: translateY(var(--slide-offset));
+    }
+  }
+
+  .scrollbar {
+    /* For Firefox */
+    scrollbar-width: thin;
+    scrollbar-color: transparent transparent;
+  }
+
+  .scrollbar:hover {
+    scrollbar-color: var(--scrollbar-color, hsla(var(--border))) transparent;
+  }
+
+  .scrollbar::-webkit-scrollbar {
+    padding: 2px;
+    width: 12px;
+    height: 12px;
+    background: transparent;
+  }
+
+  .scrollbar:hover::-webkit-scrollbar-thumb {
+    background: hsla(var(--border));
+    border-radius: 12px;
+    border: 2px solid transparent;
+    background-clip: content-box;
+  }
+
+  .scrollbar::-webkit-scrollbar-thumb {
+    background: transparent;
+  }
+
+  .scrollbar::-webkit-scrollbar-corner {
+    background: transparent;
+  }
+
+  .wavy-line {
+    @apply bg-primary w-full;
+
+    --s: 3px; /* size of the wave */
+    --b: 2px; /* thickness of the line */
+    --m: 1; /* curvature of the wave [0 2] */
+
+    --R: calc(var(--s) * sqrt(var(--m) * var(--m) + 1) + var(--b) / 2);
+    height: calc(2 * var(--R));
+    --_g:
+      #0000 calc(99% - var(--b)), #000 calc(101% - var(--b)) 99%, #0000 101%;
+    mask:
+      radial-gradient(
+          var(--R) at left 50% bottom calc(-1 * var(--m) * var(--s)),
+          var(--_g)
+        )
+        calc(50% - 2 * var(--s)) calc(50% - var(--s) / 2 - var(--b) / 2) /
+        calc(4 * var(--s)) calc(var(--s) + var(--b)) repeat-x,
+      radial-gradient(
+          var(--R) at left 50% top calc(-1 * var(--m) * var(--s)),
+          var(--_g)
+        )
+        50% calc(50% + var(--s) / 2 + var(--b) / 2) / calc(4 * var(--s))
+        calc(var(--s) + var(--b)) repeat-x;
+  }
+}
+
+@layer utilities {
+  .stepper {
+    @apply my-4;
+  }
+
+  .stepper > ol {
+    --bullet-size: 1.75rem;
+    --line-spacing: 0.25rem;
+    @apply flex flex-col list-none p-0 m-0;
+    counter-reset: step-counter;
+  }
+
+  .stepper > ol > li {
+    @apply relative ps-12 pb-6 my-0;
+    counter-increment: step-counter;
+  }
+
+  .stepper > ol > li:last-child {
+    @apply pb-0;
+  }
+
+  /* Bullet with number */
+  .stepper > ol > li::before {
+    @apply absolute start-0 flex items-center justify-center size-(--bullet-size);
+    @apply bg-muted/80 border border-border text-muted-foreground text-[calc(var(--bullet-size)/2)] font-semibold rounded-full;
+    content: counter(step-counter);
+  }
+
+  /* Vertical line */
+  .stepper > ol > li::after {
+    @apply absolute content-[''] w-[2px] bg-border -translate-x-1/2;
+    inset-inline-start: calc(var(--bullet-size) / 2);
+    top: calc(var(--bullet-size) + var(--line-spacing));
+    height: calc(100% - var(--bullet-size) - (2 * var(--line-spacing)));
+  }
+
+  /*
+    This can't be as `rtl:*` variant above, because it breaks the CSS minification. See:
+    https://github.com/tailwindlabs/tailwindcss/issues/16582
+  */
+  [dir="rtl"] .stepper > ol > li::after {
+    @apply translate-x-1/2;
+  }
+
+  .stepper > ol > li > :first-child {
+    @apply mt-0 pt-0;
+    transform: translateY(calc((var(--bullet-size) - 1lh) / 2));
+  }
+}

package/src/app/main.tsx

@@ -0,0 +1,165 @@
+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 } 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 ?? "APIToGo";
+
+  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: config.slots,
+    metadata: {
+      favicon: "https://cdn.zudoku.dev/logos/favicon.svg",
+      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

@@ -0,0 +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);
+}

package/src/app/processRoutes.tsx

@@ -0,0 +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;
+  });

package/src/app/sentry.ts

@@ -0,0 +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(),
+    ],
+  });
+};

package/src/app/standalone.html

@@ -0,0 +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>