zudoku 0.0.0-e4d0ea8 → 0.0.0-e5be921

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) {

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

@@ -1,16 +1,14 @@
 import { ResultOf } from "@graphql-typed-document-node/core";
-import { useQuery } from "urql";
+import { useSuspenseQuery } from "@tanstack/react-query";
+import { Helmet } from "@zudoku/react-helmet-async";
 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 +42,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
         encoding {
           name
         }
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         schema
       }
       description
@@ -54,6 +59,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
       links
       description
       content {
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         mediaType
         encoding {
           name
@@ -70,6 +82,7 @@ const AllOperationsQuery = graphql(/* GraphQL */ `
   query AllOperations($input: JSON!, $type: SchemaType!) {
     schema(input: $input, type: $type) {
       description
+      summary
       title
       url
       version
@@ -85,50 +98,77 @@ const AllOperationsQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const suspenseContext = { suspense: true };
+/**
+ * @description Clean up a commonmark formatted description for use in the meta
+ * description.
+ */
+function cleanDescription(
+  description: string,
+  maxLength: number = 160,
+): string {
+  if (!description) {
+    return "";
+  }
 
-export const OperationList = () => {
-  const { type, input } = useOasConfig();
+  // Replace Markdown links [text](url) with just "text"
+  description = description.replace(/\[([^\]]+)\]\([^)]+\)/g, "$1");
 
-  const [result] = useQuery({
-    query: AllOperationsQuery,
-    variables: { type, input },
-    context: suspenseContext,
-  });
+  // Remove Markdown image syntax: ![alt](url)
+  description = description.replace(/!\[.*?\]\(.*?\)/g, "");
 
-  const error = result.error?.graphQLErrors.at(0);
+  // Remove other Markdown syntax (e.g., **bold**, _italic_, `code`)
+  description = description.replace(/[_*`~]/g, "");
 
-  // 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" />
-          </>
-        }
-      />
-    );
-  }
+  // Remove headings (# Heading), blockquotes (> Quote), and horizontal rules (--- or ***)
+  description = description.replace(/^(?:>|\s*#+|-{3,}|\*{3,})/gm, "");
+
+  // Remove any remaining formatting characters
+  description = description.replace(/[|>{}[\]]/g, "");
 
-  if (!result.data) return null;
+  // Collapse multiple spaces and trim the text
+  description = description.replace(/\s+/g, " ").trim();
 
+  // Limit to the specified maximum length
+  description = description.substring(0, maxLength);
+
+  // Escape for HTML safety
+  return description
+    .replace(/&/g, "&amp;")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+    .replace(/'/g, "&#039;");
+}
+
+export const OperationList = () => {
+  const { input, type } = useOasConfig();
+  const query = useCreateQuery(AllOperationsQuery, { input, type });
+  const result = useSuspenseQuery(query);
+  const title = result.data.schema.title;
+  const summary = result.data.schema.summary;
+  const description = result.data.schema.description;
+  // The summary property is preferable here as it is a short description of
+  // the API, whereas the description property is typically longer and supports
+  // commonmark formatting, making it ill-suited for use in the meta description
+  const metaDescription = summary
+    ? summary
+    : description
+      ? cleanDescription(description)
+      : undefined;
   return (
     <div className="pt-[--padding-content-top]">
+      <Helmet>
+        <title>{title}</title>
+        {metaDescription && (
+          <meta name="description" content={metaDescription} />
+        )}
+      </Helmet>
       <div
         className={cn(ProseClasses, "mb-16 max-w-full prose-img:max-w-prose")}
       >
         <CategoryHeading>Overview</CategoryHeading>
         <Heading level={1} id="description" registerSidebarAnchor>
-          {result.data.schema.title}
+          {title}
         </Heading>
         <Markdown content={result.data.schema.description ?? ""} />
       </div>
@@ -140,7 +180,8 @@ export const OperationList = () => {
       {result.data.schema.tags
         .filter((tag) => tag.operations.length > 0)
         .map((tag) => (
-          <div key={tag.name}>
+          // px, -mx is so that `content-visibility` doesn't cut off overflown heading anchor links '#'
+          <div key={tag.name} className="px-6 -mx-6 [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>
     </>

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

@@ -2,6 +2,7 @@ import * as Tabs from "@radix-ui/react-tabs";
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import { type SchemaObject } from "../../oas/graphql/index.js";
 import { cn } from "../../util/cn.js";
+import { CollapsibleCode } from "./CollapsibleCode.js";
 import type { OperationListItemResult } from "./OperationList.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
@@ -41,25 +42,29 @@ export const ResponsesSidecarBox = ({
         </Tabs.List>
       </SidecarBox.Head>
       {responses.map((response) => {
-        const schema = response.content?.[0]?.schema as
-          | SchemaObject
-          | undefined;
+        const firstContent = response.content?.at(0);
+
+        const example =
+          firstContent?.examples?.at(0)?.value ??
+          (firstContent?.schema
+            ? generateSchemaExample(firstContent.schema as SchemaObject)
+            : "");
 
         return (
           <Tabs.Content key={response.statusCode} value={response.statusCode}>
             <SidecarBox.Body className="p-0">
-              {schema ? (
+              <CollapsibleCode>
                 <SyntaxHighlight
-                  language="json"
+                  language={example ? "json" : "plain"}
                   noBackground
-                  className="text-xs max-h-[450px] p-2"
-                  code={JSON.stringify(generateSchemaExample(schema), null, 2)}
+                  className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+                  code={
+                    example
+                      ? JSON.stringify(example, null, 2)
+                      : "Empty response"
+                  }
                 />
-              ) : (
-                <span className="text-muted-foreground font-mono italic text-xs">
-                  Empty Response
-                </span>
-              )}
+              </CollapsibleCode>
             </SidecarBox.Body>
             <SidecarBox.Footer className="flex justify-end text-xs">
               {response.description}

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

@@ -1,20 +1,19 @@
 import { Outlet } from "react-router-dom";
-import { Provider, Client as UrqlClient } from "urql";
+import type { GraphQLClient } from "./client/GraphQLClient.js";
+import { GraphQLProvider } from "./client/GraphQLContext.js";
 import { OasConfigProvider } from "./context.js";
 import { OasPluginConfig } from "./interfaces.js";
 
-export function OpenApiRoute({
+export const OpenApiRoute = ({
   config,
   client,
 }: {
   config: OasPluginConfig;
-  client: typeof UrqlClient;
-}) {
-  return (
-    <Provider value={client}>
-      <OasConfigProvider value={{ config }}>
-        <Outlet />
-      </OasConfigProvider>
-    </Provider>
-  );
-}
+  client: GraphQLClient;
+}) => (
+  <OasConfigProvider value={{ config }}>
+    <GraphQLProvider client={client}>
+      <Outlet />
+    </GraphQLProvider>
+  </OasConfigProvider>
+);