zudoku 0.0.0-f417aae → 0.0.0-f49e3ea

package/src/lib/plugins/api-keys/index.tsx

@@ -1,8 +1,8 @@
 import { type RouteObject } from "react-router-dom";
-import { DevPortalContext } from "../../core/DevPortalContext.js";
+import { ZudokuContext } from "../../core/ZudokuContext.js";
 import {
   type ApiIdentityPlugin,
-  type DevPortalPlugin,
+  type ZudokuPlugin,
   ProfileMenuPlugin,
 } from "../../core/plugins.js";
 import { RouterError } from "../../errors/RouterError.js";
@@ -15,17 +15,17 @@ const DEFAULT_API_KEY_ENDPOINT =
   "https://zudoku-rewiringamerica-main-ef9c9c0.d2.zuplo.dev";
 
 export type ApiKeyService = {
-  getKeys: (context: DevPortalContext) => Promise<ApiKey[]>;
-  rollKey?: (id: string, context: DevPortalContext) => Promise<void>;
-  deleteKey?: (id: string, context: DevPortalContext) => Promise<void>;
+  getKeys: (context: ZudokuContext) => Promise<ApiKey[]>;
+  rollKey?: (id: string, context: ZudokuContext) => Promise<void>;
+  deleteKey?: (id: string, context: ZudokuContext) => Promise<void>;
   updateKeyDescription?: (
     apiKey: { id: string; description: string },
-    context: DevPortalContext,
+    context: ZudokuContext,
   ) => Promise<void>;
-  getUsage?: (apiKeys: string[], context: DevPortalContext) => Promise<void>;
+  getUsage?: (apiKeys: string[], context: ZudokuContext) => Promise<void>;
   createKey?: (
     apiKey: { description: string; expiresOn?: string },
-    context: DevPortalContext,
+    context: ZudokuContext,
   ) => Promise<void>;
 };
 
@@ -93,7 +93,7 @@ const createDefaultHandler = (endpoint: string): ApiKeyService => {
 
 export const apiKeyPlugin = (
   options: ApiKeyPluginOptions,
-): DevPortalPlugin & ApiIdentityPlugin & ProfileMenuPlugin => {
+): ZudokuPlugin & ApiIdentityPlugin & ProfileMenuPlugin => {
   const endpoint =
     "endpoint" in options ? options.endpoint : DEFAULT_API_KEY_ENDPOINT;
 

package/src/lib/plugins/custom-pages/CustomPage.tsx

@@ -9,8 +9,8 @@ export const CustomPage = ({
   render,
   prose = true,
 }: Omit<CustomPageConfig, "path">) => {
-  const slotletProps = useExposedProps();
-  const content = render ? React.createElement(render, slotletProps) : element;
+  const exposedProps = useExposedProps();
+  const content = render ? React.createElement(render, exposedProps) : element;
 
   return (
     <div className={cn(prose && ProseClasses, "max-w-full")}>{content}</div>

package/src/lib/plugins/custom-pages/index.tsx

@@ -1,7 +1,7 @@
 import { type ComponentType, type ReactNode } from "react";
 import type { RouteObject } from "react-router-dom";
 import { type ExposedComponentProps } from "../../components/SlotletProvider.js";
-import type { DevPortalPlugin, NavigationPlugin } from "../../core/plugins.js";
+import type { NavigationPlugin, ZudokuPlugin } from "../../core/plugins.js";
 import { CustomPage } from "./CustomPage.js";
 
 export type CustomPageConfig = {
@@ -13,7 +13,7 @@ export type CustomPageConfig = {
 
 export const customPagesPlugin = (
   config: CustomPageConfig[],
-): DevPortalPlugin & NavigationPlugin => {
+): ZudokuPlugin & NavigationPlugin => {
   return {
     getRoutes: (): RouteObject[] =>
       config.map(({ path, ...props }) => ({

package/src/lib/plugins/markdown/index.tsx

@@ -1,13 +1,13 @@
 import type { Toc } from "@stefanprobst/rehype-extract-toc";
 import type { MDXProps } from "mdx/types.js";
-import type { DevPortalPlugin } from "../../core/plugins.js";
-import { generateRoutes } from "./generateRoutes.js";
+import { RouteObject } from "react-router-dom";
+import { ZudokuDocsConfig } from "../../../config/validators/validate.js";
+import type { ZudokuPlugin } from "../../core/plugins.js";
+import { DocResolver } from "./resolver.js";
 
-export type MarkdownPluginOptions = {
-  markdownFiles: Record<string, () => Promise<MDXImport>>;
-  defaultOptions?: MarkdownPluginDefaultOptions;
-  filesPath: string;
-};
+export interface MarkdownPluginOptions extends ZudokuDocsConfig {
+  fileImports: Record<string, () => Promise<MDXImport>>;
+}
 export type MarkdownPluginDefaultOptions = Pick<
   Frontmatter,
   "toc" | "disablePager"
@@ -27,10 +27,47 @@ export type MDXImport = {
   default: (props: MDXProps) => JSX.Element;
 };
 
-export const markdownPlugin = ({
-  markdownFiles,
-  defaultOptions,
-  filesPath,
-}: MarkdownPluginOptions): DevPortalPlugin => ({
-  getRoutes: () => generateRoutes(markdownFiles, filesPath, defaultOptions),
+export const markdownPlugin = (
+  options: MarkdownPluginOptions[],
+): ZudokuPlugin => ({
+  getRoutes: () => {
+    const routeMap = new Map<string, RouteObject>();
+    options.forEach(({ fileImports, files, defaultOptions }) =>
+      Object.entries(fileImports).flatMap(([file, importPromise]) => {
+        const routePath = DocResolver.resolveRoutePath({
+          filesGlob: files,
+          fsPath: file,
+        });
+
+        if (!routePath) return [];
+
+        if (routeMap.has(routePath)) {
+          // eslint-disable-next-line no-console
+          console.warn(
+            `Duplicate route path found for ${routePath}. Skipping file at '${file}'.`,
+          );
+          return [];
+        }
+
+        const route: RouteObject = {
+          path: routePath,
+          lazy: async () => {
+            const { MdxPage } = await import("./MdxPage.js");
+            const { default: Component, ...props } = await importPromise();
+            return {
+              element: (
+                <MdxPage
+                  mdxComponent={Component}
+                  {...props}
+                  defaultOptions={defaultOptions}
+                />
+              ),
+            };
+          },
+        };
+        routeMap.set(routePath, route);
+      }),
+    );
+    return [...routeMap.values()];
+  },
 });

package/src/lib/plugins/markdown/resolver.ts

@@ -0,0 +1,92 @@
+import fs from "fs";
+import path from "path";
+import {
+  ZudokuConfig,
+  ZudokuDocsConfig,
+} from "../../../config/validators/validate.js";
+
+const DEFAULT_DOCS_FILES = "/pages/**/*.{md,mdx}";
+
+// TODO: This should be dynamic based on the glob selector
+const SUPPORTED_EXTENSIONS = [".md", ".mdx"];
+
+/**
+ * Utilities for resolving markdown file paths and routes
+ */
+export class DocResolver {
+  constructor(private config: ZudokuConfig) {}
+
+  fileMap = new Map<string, string>();
+
+  /**
+   * Gets the default docs config from the zudoku config
+   */
+  getDocsConfigs() {
+    const docsConfigs: ZudokuDocsConfig[] = this.config.docs
+      ? Array.isArray(this.config.docs)
+        ? this.config.docs
+        : [this.config.docs]
+      : [{ files: DEFAULT_DOCS_FILES }];
+
+    return docsConfigs;
+  }
+
+  /**
+   * Resolves the first matching file system path for a given docId
+   * @param docId - The docId to resolve
+   * @returns
+   */
+  resolveFilePath(docId: string) {
+    const docsConfigs = this.getDocsConfigs();
+    let fsPath: string | undefined;
+
+    docsConfigs.forEach(({ files: fileGlob }) => {
+      if (fsPath) {
+        return;
+      }
+      const rootDir = DocResolver.getRootDir(fileGlob);
+      for (const ext of SUPPORTED_EXTENSIONS) {
+        if (fsPath) {
+          return;
+        }
+        const checkPath = path.join(rootDir, `${docId}${ext}`);
+        if (fs.existsSync(checkPath)) {
+          fsPath = checkPath;
+        }
+      }
+    });
+
+    return fsPath;
+  }
+
+  /**
+   * Gets the root directory from a files glob
+   */
+  private static getRootDir(filesGlob: string) {
+    let rootDir = filesGlob.split("**")[0];
+    if (!rootDir) {
+      throw new Error("Invalid files glob. Must have '**' in the path.");
+    }
+    rootDir = rootDir.replace("/**", "/");
+    return rootDir;
+  }
+
+  /**
+   * Resolves the route path for a given file system path
+   * @param options - The options to resolve the route path
+   * @returns The string route path
+   */
+  static resolveRoutePath({
+    filesGlob,
+    fsPath,
+  }: {
+    filesGlob: string;
+    fsPath: string;
+  }) {
+    const rootDir = this.getRootDir(filesGlob);
+    const re = new RegExp(`^${rootDir}(.*).mdx?`);
+    const match = fsPath.match(re);
+    const routePath = match?.at(1);
+    return routePath;
+  }
+}

package/src/lib/plugins/openapi/CollapsibleCode.tsx

@@ -0,0 +1,80 @@
+import { type CSSProperties, type ReactNode, useRef, useState } from "react";
+import { Button } from "zudoku/ui/Button.js";
+import {
+  Collapsible,
+  CollapsibleContent,
+  CollapsibleTrigger,
+} from "zudoku/ui/Collapsible.js";
+import { cn } from "../../util/cn.js";
+import useIsomorphicLayoutEffect from "../../util/useIsomorphicLayoutEffect.js";
+
+export const CollapsibleCode = ({
+  children,
+  maxHeight = 250,
+}: {
+  children: ReactNode;
+  maxHeight?: number;
+}) => {
+  const contentRef = useRef<HTMLDivElement | null>(null);
+  const [isOverflowing, setIsOverflowing] = useState(false);
+  const [open, setOpen] = useState(false);
+
+  useIsomorphicLayoutEffect(() => {
+    const el = contentRef.current;
+    if (!el) return;
+
+    setIsOverflowing(el.scrollHeight > maxHeight);
+
+    const observer = new ResizeObserver(() => {
+      setIsOverflowing(el.scrollHeight > maxHeight);
+    });
+    observer.observe(el);
+
+    return () => observer.disconnect();
+  }, [maxHeight]);
+
+  return (
+    <Collapsible
+      className="group"
+      open={open}
+      onOpenChange={setOpen}
+      style={{ "--max-height": `${maxHeight}px` } as CSSProperties}
+    >
+      <CollapsibleContent
+        forceMount
+        className={cn(
+          "relative overflow-hidden",
+          !open && isOverflowing && "max-h-[--max-height]",
+        )}
+      >
+        {!open && isOverflowing && (
+          <div className="absolute inset-0 bg-gradient-to-b from-transparent to-zinc-50/90 dark:to-zinc-800/90 z-10"></div>
+        )}
+        <div ref={contentRef}>{children}</div>
+        {!open && isOverflowing && (
+          <CollapsibleTrigger
+            className="absolute inset-0 grid place-items-center z-10"
+            asChild
+          >
+            <div>
+              <Button className="bg-primary/70 border border-accent-foreground/25">
+                Expand code
+              </Button>
+            </div>
+          </CollapsibleTrigger>
+        )}
+      </CollapsibleContent>
+      {isOverflowing && (
+        <div
+          className={cn("flex justify-center w-full mb-2", !open && "hidden")}
+        >
+          <CollapsibleTrigger asChild>
+            <Button className="border border-accent-foreground/25">
+              Collapse code
+            </Button>
+          </CollapsibleTrigger>
+        </div>
+      )}
+    </Collapsible>
+  );
+};

package/src/lib/plugins/openapi/ColorizedParam.tsx

@@ -1,15 +1,15 @@
-import { useEffect, useRef, type ReactNode } from "react";
-import { useTheme } from "../../components/context/ThemeContext.js";
+import { useTheme } from "next-themes";
+import { useEffect, useRef, type CSSProperties, type ReactNode } from "react";
 import { cn } from "../../util/cn.js";
 import { pastellize } from "../../util/pastellize.js";
 
 export const DATA_ATTR = "data-linked-param";
 
 export const usePastellizedColor = (name: string) => {
-  const [isDark] = useTheme();
+  const { resolvedTheme } = useTheme();
   return pastellize(
     name,
-    !isDark ? { saturation: 85, lightness: 50 } : undefined,
+    resolvedTheme === "light" ? { saturation: 85, lightness: 50 } : undefined,
   );
 };
 
@@ -61,27 +61,36 @@ export const ColorizedParam = ({
         });
     };
 
-    ref.current.addEventListener("mouseenter", onMouseEnter);
-    ref.current.addEventListener("mouseleave", onMouseLeave);
+    const el = ref.current;
+
+    el.addEventListener("mouseenter", onMouseEnter);
+    el.addEventListener("mouseleave", onMouseLeave);
 
     return () => {
-      ref.current?.removeEventListener("mouseenter", onMouseEnter);
-      ref.current?.removeEventListener("mouseleave", onMouseLeave);
+      el.removeEventListener("mouseenter", onMouseEnter);
+      el.removeEventListener("mouseleave", onMouseLeave);
     };
   }, [normalizedSlug]);
 
   return (
     <span
-      className={cn("inline-flex relative rounded group", className)}
       {...{ [DATA_ATTR]: normalizedSlug }}
+      className={cn(
+        "relative after:rounded after:absolute after:inset-0 after:-bottom-0.5 after:border-b-2 after:transition-opacity after:duration-200",
+        "after:pointer-events-none after:border-[--border-color] after:opacity-30 after:data-[active=true]:opacity-100",
+        className,
+      )}
+      suppressHydrationWarning
       ref={ref}
       onClick={onClick}
+      style={
+        {
+          "--border-color": borderColor,
+          "--background-color": backgroundColor,
+        } as CSSProperties
+      }
     >
-      <span
-        className="absolute inset-0 border-b-2 transition-opacity duration-200 opacity-30 group-data-[active=true]:opacity-100"
-        style={{ borderColor, backgroundColor }}
-      />
-      <span className="relative">{children ?? name}</span>
+      {children ?? name}
     </span>
   );
 };

package/src/lib/plugins/openapi/Endpoint.tsx

@@ -1,9 +1,10 @@
+import { useSuspenseQuery } from "@tanstack/react-query";
 import { CheckIcon, CopyIcon } from "lucide-react";
 import { useState, useTransition } from "react";
-import { useQuery } from "urql";
 import { useSelectedServerStore } from "../../authentication/state.js";
 import { InlineCode } from "../../components/InlineCode.js";
 import { Button } from "../../ui/Button.js";
+import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
 import { SimpleSelect } from "./SimpleSelect.js";
@@ -42,19 +43,13 @@ const CopyButton = ({ url }: { url: string }) => {
   );
 };
 
-const context = { suspense: true } as const;
-
 export const Endpoint = () => {
-  const [result] = useQuery({
-    query: ServersQuery,
-    variables: useOasConfig(),
-    context,
-  });
+  const { input, type } = useOasConfig();
+  const query = useCreateQuery(ServersQuery, { input, type });
+  const result = useSuspenseQuery(query);
   const [, startTransition] = useTransition();
   const { selectedServer, setSelectedServer } = useSelectedServerStore();
 
-  if (!result.data) return null;
-
   const { servers } = result.data.schema;
 
   if (servers.length === 1) {
@@ -62,9 +57,9 @@ export const Endpoint = () => {
       <div className="flex items-center gap-2">
         <span className="font-medium text-sm">Endpoint:</span>
         <InlineCode className="text-xs px-2 py-1.5" selectOnClick>
-          {servers[0].url}
+          {servers[0]!.url}
         </InlineCode>
-        <CopyButton url={servers[0].url} />
+        <CopyButton url={servers[0]!.url} />
       </div>
     );
   }

package/src/lib/plugins/openapi/OperationList.tsx

@@ -1,16 +1,13 @@
 import { ResultOf } from "@graphql-typed-document-node/core";
-import { useQuery } from "urql";
+import { useSuspenseQuery } from "@tanstack/react-query";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
-import { DeveloperHint } from "../../components/DeveloperHint.js";
-import { ErrorPage } from "../../components/ErrorPage.js";
 import { Heading } from "../../components/Heading.js";
-import { InlineCode } from "../../components/InlineCode.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.js";
-import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import { cn } from "../../util/cn.js";
 import { Endpoint } from "./Endpoint.js";
 import { OperationListItem } from "./OperationListItem.js";
 import StaggeredRender from "./StaggeredRender.js";
+import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
 
@@ -44,6 +41,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
         encoding {
           name
         }
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         schema
       }
       description
@@ -54,6 +58,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
       links
       description
       content {
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         mediaType
         encoding {
           name
@@ -85,41 +96,10 @@ const AllOperationsQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const suspenseContext = { suspense: true };
-
 export const OperationList = () => {
-  const { type, input } = useOasConfig();
-
-  const [result] = useQuery({
-    query: AllOperationsQuery,
-    variables: { type, input },
-    context: suspenseContext,
-  });
-
-  const error = result.error?.graphQLErrors.at(0);
-
-  // Looks like there is no Suspense level error handling (yet)?
-  // So we handle the error case in the component directly
-  if (error) {
-    return (
-      <ErrorPage
-        category="Error"
-        title="Schema cannot be displayed"
-        message={
-          <>
-            <DeveloperHint className="mb-4">
-              Check your configuration value <InlineCode>apis.type</InlineCode>{" "}
-              and <InlineCode>apis.input</InlineCode> in the Zudoku config.
-            </DeveloperHint>
-            An error occurred while trying to fetch the API reference:
-            <SyntaxHighlight code={error.toString()} language="plain" />
-          </>
-        }
-      />
-    );
-  }
-
-  if (!result.data) return null;
+  const { input, type } = useOasConfig();
+  const query = useCreateQuery(AllOperationsQuery, { input, type });
+  const result = useSuspenseQuery(query);
 
   return (
     <div className="pt-[--padding-content-top]">
@@ -140,7 +120,7 @@ export const OperationList = () => {
       {result.data.schema.tags
         .filter((tag) => tag.operations.length > 0)
         .map((tag) => (
-          <div key={tag.name}>
+          <div key={tag.name} className="[content-visibility:auto]">
             {tag.name && <CategoryHeading>{tag.name}</CategoryHeading>}
             {tag.description && (
               <Markdown

package/src/lib/plugins/openapi/ParameterListItem.tsx

@@ -27,36 +27,42 @@ export const ParameterListItem = ({
   parameter: ParameterListItemResult;
   group: ParameterGroup;
   id: string;
-}) => (
-  <li className="p-4 bg-border/20 text-sm flex flex-col gap-1">
-    <div className="flex items-center gap-2">
-      <code>
-        {group === "path" ? (
-          <ColorizedParam
-            name={parameter.name}
-            backgroundOpacity="15%"
-            slug={id + "-" + parameter.name.toLocaleLowerCase()}
-          />
-        ) : (
-          parameter.name
+}) => {
+  const paramSchema = getParameterSchema(parameter);
+
+  return (
+    <li className="p-4 bg-border/20 text-sm flex flex-col gap-1">
+      <div className="flex items-center gap-2">
+        <code>
+          {group === "path" ? (
+            <ColorizedParam
+              name={parameter.name}
+              backgroundOpacity="15%"
+              slug={id + "-" + parameter.name.toLocaleLowerCase()}
+            />
+          ) : (
+            parameter.name
+          )}
+        </code>
+        {parameter.required && (
+          <span className="py-px px-1.5 font-medium bg-primary/75 text-muted rounded-lg">
+            required
+          </span>
         )}
-      </code>
-      {parameter.required && (
-        <span className="py-px px-1.5 font-medium bg-primary/75 text-muted rounded-lg">
-          required
-        </span>
-      )}
-      {getParameterSchema(parameter).type && (
-        <span className="text-muted-foreground">
-          {getParameterSchema(parameter).type}
-        </span>
+        {paramSchema.type && (
+          <span className="text-muted-foreground">
+            {paramSchema.type === "array"
+              ? `${paramSchema.items.type}[]`
+              : paramSchema.type}
+          </span>
+        )}
+      </div>
+      {parameter.description && (
+        <Markdown
+          content={parameter.description}
+          className="text-sm prose-p:my-1 prose-code:whitespace-pre-line"
+        />
       )}
-    </div>
-    {parameter.description && (
-      <Markdown
-        content={parameter.description}
-        className="text-sm prose-p:my-1 prose-code:whitespace-pre-line"
-      />
-    )}
-  </li>
-);
+    </li>
+  );
+};

package/src/lib/plugins/openapi/RequestBodySidecarBox.tsx

@@ -1,5 +1,6 @@
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import { type SchemaObject } from "../../oas/graphql/index.js";
+import { CollapsibleCode } from "./CollapsibleCode.js";
 import type { OperationListItemResult } from "./OperationList.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
@@ -12,6 +13,14 @@ type Content = NonNullable<
 export const RequestBodySidecarBox = ({ content }: { content: Content }) => {
   if (!content.length) return null;
 
+  const firstContent = content.at(0);
+
+  const example =
+    firstContent?.examples?.at(0)?.value ??
+    (firstContent?.schema
+      ? generateSchemaExample(firstContent.schema as SchemaObject)
+      : "");
+
   return (
     <>
       <SidecarBox.Root>
@@ -19,19 +28,15 @@ export const RequestBodySidecarBox = ({ content }: { content: Content }) => {
           <span className="font-mono">Request Body Example</span>
         </SidecarBox.Head>
         <SidecarBox.Body className="p-0">
-          <SyntaxHighlight
-            language="json"
-            noBackground
-            copyable
-            className="text-xs max-h-[450px] p-2"
-            code={JSON.stringify(
-              content.at(0)?.schema
-                ? generateSchemaExample(content[0].schema as SchemaObject)
-                : "",
-              null,
-              2,
-            )}
-          />
+          <CollapsibleCode>
+            <SyntaxHighlight
+              language={example ? "json" : "plain"}
+              noBackground
+              copyable
+              className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+              code={example ? JSON.stringify(example, null, 2) : "No example"}
+            />
+          </CollapsibleCode>
         </SidecarBox.Body>
       </SidecarBox.Root>
     </>