zudoku 0.0.0-feda542 → 0.0.0-ff27e7ea

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

@@ -1,8 +1,7 @@
-import { type ResultOf } from "@graphql-typed-document-node/core";
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import { Helmet } from "@zudoku/react-helmet-async";
 import { ChevronsDownUpIcon, ChevronsUpDownIcon } from "lucide-react";
-import { useNavigate } from "react-router";
+import { useNavigate, useParams } from "react-router";
 import {
   Collapsible,
   CollapsibleContent,
@@ -16,17 +15,16 @@ import {
   SelectValue,
 } from "zudoku/ui/Select.js";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
+import { useApiIdentities } from "../../components/context/ZudokuContext.js";
 import { Heading } from "../../components/Heading.js";
-import { Markdown, ProseClasses } from "../../components/Markdown.js";
+import { Markdown } from "../../components/Markdown.js";
 import { Pagination } from "../../components/Pagination.js";
-import { useApiIdentities } from "../../components/context/ZudokuContext.js";
-import { cn } from "../../util/cn.js";
-import { Endpoint } from "./Endpoint.js";
-import { OperationListItem } from "./OperationListItem.js";
 import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
+import { Endpoint } from "./Endpoint.js";
 import { graphql } from "./graphql/index.js";
 import { UNTAGGED_PATH } from "./index.js";
+import { OperationListItem } from "./OperationListItem.js";
 import { useSelectedServer } from "./state.js";
 import { sanitizeMarkdownForMetatag } from "./util/sanitizeMarkdownForMetatag.js";
 
@@ -41,6 +39,10 @@ export const OperationsFragment = graphql(/* GraphQL */ `
     path
     deprecated
     extensions
+    servers {
+      url
+      description
+    }
     parameters {
       name
       in
@@ -97,8 +99,6 @@ export const OperationsFragment = graphql(/* GraphQL */ `
   }
 `);
 
-export type OperationListItemResult = ResultOf<typeof OperationsFragment>;
-
 const SchemaWarmupQuery = graphql(/* GraphQL */ `
   query SchemaWarmup($input: JSON!, $type: SchemaType!) {
     schema(input: $input, type: $type) {
@@ -130,19 +130,24 @@ const OperationsForTagQuery = graphql(/* GraphQL */ `
           slug
           ...OperationsFragment
         }
+        extensions
         next {
           name
           slug
+          extensions
         }
         prev {
           name
           slug
+          extensions
         }
       }
     }
   }
 `);
 
+const LAZY_OPERATION_LIST_THRESHOLD = 30;
+
 export const OperationList = ({
   tag,
   untagged,
@@ -151,17 +156,21 @@ export const OperationList = ({
   untagged?: boolean;
 }) => {
   const { input, type, versions, version, options } = useOasConfig();
+  const { tag: tagFromParams } = useParams<"tag">();
   const query = useCreateQuery(OperationsForTagQuery, {
     input,
     type,
-    tag,
+    tag: tag ?? tagFromParams,
     untagged,
   });
   const result = useSuspenseQuery(query);
   const {
     data: { schema },
   } = result;
-  const { selectedServer } = useSelectedServer(schema.servers);
+  // Global server selection for the dropdown UI
+  const { selectedServer: globalSelectedServer } = useSelectedServer(
+    schema.servers,
+  );
   const title = schema.title;
   const summary = schema.summary;
   const description = schema.description;
@@ -178,10 +187,25 @@ export const OperationList = ({
   // Prefetch for Playground
   useApiIdentities();
 
-  if (!schema.tag) return null;
+  if (!schema.tag) {
+    return (
+      <div className="flex flex-col h-full items-center justify-center text-center">
+        <div className="text-muted-foreground font-medium">
+          No operations found
+        </div>
+        <div className="mt-2 text-sm text-muted-foreground">
+          This API doesn't have any operations defined yet.
+        </div>
+      </div>
+    );
+  }
 
   const { operations, next, prev, description: tagDescription } = schema.tag;
 
+  // Simple heuristic to determine if we should lazy highlight the code
+  // This is to avoid the performance issues when there are a lot of operations
+  const shouldLazyHighlight = operations.length > LAZY_OPERATION_LIST_THRESHOLD;
+
   // 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
@@ -200,41 +224,56 @@ export const OperationList = ({
     (hasMultipleVersions && options?.showVersionSelect !== "hide");
 
   const paginationProps = {
-    prev: prev?.name ? { to: `../${prev.slug}`, label: prev.name } : undefined,
+    prev: prev
+      ? {
+          to: `../${prev.slug}`,
+          label: prev.extensions?.["x-displayName"] ?? prev.name,
+        }
+      : undefined,
     next: next
       ? {
           to: `../${next.slug ?? UNTAGGED_PATH}`,
-          label: next.name ?? "Other endpoints",
+          label:
+            next.extensions?.["x-displayName"] ??
+            next.name ??
+            "Other endpoints",
         }
       : undefined,
   };
 
+  const tagTitle = schema.tag.extensions?.["x-displayName"] ?? schema.tag.name;
+  const helmetTitle = [tagTitle, title].filter(Boolean).join(" - ");
+
   return (
     <div
-      className="pt-[--padding-content-top]"
+      className="pt-(--padding-content-top)"
       data-pagefind-filter="section:openapi"
       data-pagefind-meta="section:openapi"
     >
       <Helmet>
-        <title>{[schema.tag.name, title].filter(Boolean).join(" - ")}</title>
+        {helmetTitle && <title>{helmetTitle}</title>}
         {metaDescription && (
           <meta name="description" content={metaDescription} />
         )}
       </Helmet>
+
       <div className="mb-8">
-        <Collapsible className="w-full">
+        <Collapsible
+          className="w-full"
+          defaultOpen={options?.expandApiInformation}
+        >
           <div className="flex flex-col gap-y-4 sm:flex-row justify-around items-start sm:items-end">
             <div className="flex flex-col flex-1 gap-2">
               <CategoryHeading>{title}</CategoryHeading>
               <Heading
                 level={1}
                 id="description"
-                registerSidebarAnchor
+                registerNavigationAnchor
                 className="mb-0"
               >
-                {schema.tag.name ?? "Other endpoints"}
+                {tagTitle}
                 {showVersions && (
-                  <span className="text-xl text-muted-foreground ml-1.5">
+                  <span className="text-xl text-muted-foreground ms-1.5">
                     {" "}
                     ({version})
                   </span>
@@ -245,6 +284,7 @@ export const OperationList = ({
             <div className="flex flex-col gap-4 sm:items-end">
               {showVersions && (
                 <Select
+                  // biome-ignore lint/style/noNonNullAssertion: is guaranteed to be defined
                   onValueChange={(version) => navigate(versions[version]!)}
                   defaultValue={version}
                   disabled={!hasMultipleVersions}
@@ -279,14 +319,9 @@ export const OperationList = ({
           </div>
           {schema.description && (
             <CollapsibleContent className="CollapsibleContent">
-              <div
-                className={cn(
-                  ProseClasses,
-                  "pt-4 max-w-full prose-img:max-w-prose",
-                )}
-              >
+              <div className="mt-4 max-w-full border rounded-sm bg-muted/25">
                 <Markdown
-                  className="border rounded bg-muted/25 border-border px-2.5 md:px-4"
+                  className="max-w-full prose-img:max-w-prose border-border p-3 lg:p-5"
                   content={schema.description}
                 />
               </div>
@@ -294,14 +329,10 @@ export const OperationList = ({
           )}
         </Collapsible>
         {tagDescription && (
-          <div
-            className={cn(
-              ProseClasses,
-              "my-4 max-w-full prose-img:max-w-prose",
-            )}
-          >
-            <Markdown content={tagDescription} />
-          </div>
+          <Markdown
+            className="my-4 max-w-full prose-img:max-w-prose"
+            content={tagDescription}
+          />
         )}
       </div>
       <hr />
@@ -310,8 +341,9 @@ export const OperationList = ({
         {operations.map((fragment) => (
           <div key={fragment.slug}>
             <OperationListItem
-              serverUrl={selectedServer}
               operationFragment={fragment}
+              globalSelectedServer={globalSelectedServer}
+              shouldLazyHighlight={shouldLazyHighlight}
             />
             <hr className="my-10" />
           </div>

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

@@ -1,17 +1,20 @@
 import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
 import { useState } from "react";
 import { Badge } from "zudoku/ui/Badge.js";
+import { Separator } from "zudoku/ui/Separator.js";
 import { Heading } from "../../components/Heading.js";
-import { Markdown, ProseClasses } from "../../components/Markdown.js";
-import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../ui/Tabs.js";
+import { Markdown } from "../../components/Markdown.js";
 import { cn } from "../../util/cn.js";
 import { groupBy } from "../../util/groupBy.js";
 import { renderIf } from "../../util/renderIf.js";
+import { ResponseContent } from "./components/ResponseContent.js";
+import { SelectOnClick } from "./components/SelectOnClick.js";
+import { useOasConfig } from "./context.js";
+import { type FragmentType, useFragment } from "./graphql/index.js";
+import { MCPEndpoint } from "./MCPEndpoint.js";
 import { OperationsFragment } from "./OperationList.js";
 import { ParameterList } from "./ParameterList.js";
 import { Sidecar } from "./Sidecar.js";
-import { SelectOnClick } from "./components/SelectOnClick.js";
-import { type FragmentType, useFragment } from "./graphql/index.js";
 import { SchemaView } from "./schema/SchemaView.js";
 import { methodForColor } from "./util/methodToColor.js";
 
@@ -20,19 +23,27 @@ export type ParameterGroup = (typeof PARAM_GROUPS)[number];
 
 export const OperationListItem = ({
   operationFragment,
-  serverUrl,
+  globalSelectedServer,
+  shouldLazyHighlight,
 }: {
   operationFragment: FragmentType<typeof OperationsFragment>;
-  serverUrl?: string;
+  globalSelectedServer?: string;
+  shouldLazyHighlight?: boolean;
 }) => {
   const operation = useFragment(OperationsFragment, operationFragment);
   const groupedParameters = groupBy(
     operation.parameters ?? [],
     (param) => param.in,
   );
+  const { options } = useOasConfig();
+
+  // Manual server selection takes precedence over the server hierarchy.
+  // If no manual selection, fall back to operation's first server (already respects operation > path > global hierarchy)
+  const displayServerUrl = globalSelectedServer || operation.servers.at(0)?.url;
 
   const first = operation.responses.at(0);
   const [selectedResponse, setSelectedResponse] = useState(first?.statusCode);
+  const isMCPEndpoint = operation.extensions?.["x-mcp-server"] !== undefined;
 
   return (
     <div>
@@ -51,37 +62,53 @@ export const OperationListItem = ({
         <Heading
           level={2}
           id={operation.slug}
-          registerSidebarAnchor
+          registerNavigationAnchor
           className="break-all col-span-full"
         >
           {operation.summary}
         </Heading>
-        <div className="text-sm flex gap-2 font-mono col-span-full">
-          <span className={methodForColor(operation.method)}>
-            {operation.method.toUpperCase()}
-          </span>
-          <SelectOnClick className="max-w-full truncate flex cursor-pointer">
-            {serverUrl && (
-              <div className="text-neutral-400 dark:text-neutral-500 truncate">
-                {serverUrl.replace(/\/$/, "")}
+        {!isMCPEndpoint && (
+          <div className="text-sm flex gap-2 font-mono col-span-full">
+            <span className={methodForColor(operation.method)}>
+              {operation.method.toUpperCase()}
+            </span>
+            <SelectOnClick className="max-w-full truncate flex cursor-pointer">
+              {displayServerUrl && (
+                <div className="text-neutral-400 dark:text-neutral-500 truncate">
+                  {displayServerUrl.replace(/\/$/, "")}
+                </div>
+              )}
+              <div className="text-neutral-900 dark:text-neutral-200">
+                {operation.path}
               </div>
-            )}
-            <div className="text-neutral-900 dark:text-neutral-200">
-              {operation.path}
-            </div>
-          </SelectOnClick>
-        </div>
+            </SelectOnClick>
+          </div>
+        )}
 
-        <div className="flex flex-col gap-4">
-          {operation.description && (
-            <Markdown
-              className={`${ProseClasses} max-w-full prose-img:max-w-prose`}
-              content={operation.description}
+        {isMCPEndpoint ? (
+          <div className="col-span-full">
+            <MCPEndpoint
+              serverUrl={displayServerUrl}
+              summary={operation.summary ?? undefined}
+              data={operation.extensions?.["x-mcp-server"]}
             />
-          )}
-          {operation.parameters && operation.parameters.length > 0 && (
-            <>
-              {PARAM_GROUPS.flatMap((group) =>
+          </div>
+        ) : (
+          <div
+            className={cn(
+              "flex flex-col gap-4",
+              options?.disableSidecar && "col-span-full",
+            )}
+          >
+            {operation.description && (
+              <Markdown
+                className="max-w-full prose-img:max-w-prose"
+                content={operation.description}
+              />
+            )}
+            {operation.parameters &&
+              operation.parameters.length > 0 &&
+              PARAM_GROUPS.flatMap((group) =>
                 groupedParameters[group]?.length ? (
                   <ParameterList
                     key={group}
@@ -94,82 +121,63 @@ export const OperationListItem = ({
                   []
                 ),
               )}
-            </>
-          )}
-          {renderIf(operation.requestBody?.content?.at(0)?.schema, (schema) => (
-            <div className="mt-4 flex flex-col gap-4">
-              <Heading
-                level={3}
-                className="capitalize flex items-center gap-2"
-                id={`${operation.slug}/request-body`}
-              >
-                {operation.summary && (
-                  <VisuallyHidden>{operation.summary} &rsaquo; </VisuallyHidden>
-                )}
-                Request Body{" "}
-                {operation.requestBody?.required === false ? (
-                  <Badge variant="muted">optional</Badge>
-                ) : (
-                  ""
-                )}
-              </Heading>
-              <SchemaView schema={schema} />
-            </div>
-          ))}
-          {operation.responses.length > 0 && (
-            <>
-              <Heading
-                level={3}
-                className="capitalize mt-8 pt-8 border-t"
-                id={`${operation.slug}/responses`}
-              >
-                {operation.summary && (
-                  <VisuallyHidden>{operation.summary} &rsaquo; </VisuallyHidden>
-                )}
-                Responses
-              </Heading>
-              <Tabs
-                onValueChange={(value) => setSelectedResponse(value)}
-                value={selectedResponse}
-              >
-                {operation.responses.length > 1 && (
-                  <TabsList>
-                    {operation.responses.map((response) => (
-                      <TabsTrigger
-                        value={response.statusCode}
-                        key={response.statusCode}
-                        title={response.description ?? undefined}
-                      >
-                        {response.statusCode}
-                      </TabsTrigger>
-                    ))}
-                  </TabsList>
-                )}
-                <ul className="list-none m-0 px-0">
-                  {operation.responses.map((response) => (
-                    <TabsContent
-                      value={response.statusCode}
-                      key={response.statusCode}
-                    >
-                      <SchemaView
-                        schema={
-                          response.content?.find((content) => content.schema)
-                            ?.schema
-                        }
-                      />
-                    </TabsContent>
-                  ))}
-                </ul>
-              </Tabs>
-            </>
-          )}
-        </div>
+            {renderIf(operation.requestBody?.content?.at(0)?.schema, () => (
+              <Separator className="my-4" />
+            ))}
+            {renderIf(
+              operation.requestBody?.content?.at(0)?.schema,
+              (schema) => (
+                <div className="flex flex-col gap-4">
+                  <Heading
+                    level={3}
+                    className="capitalize flex items-center gap-2"
+                    id={`${operation.slug}/request-body`}
+                  >
+                    {operation.summary && (
+                      <VisuallyHidden>
+                        {operation.summary} &rsaquo;{" "}
+                      </VisuallyHidden>
+                    )}
+                    Request Body{" "}
+                    {operation.requestBody?.required === false ? (
+                      <Badge variant="muted">optional</Badge>
+                    ) : (
+                      ""
+                    )}
+                  </Heading>
+                  <SchemaView schema={schema} />
+                </div>
+              ),
+            )}
+            <Separator className="my-4" />
+            {operation.responses.length > 0 && (
+              <>
+                <Heading level={3} id={`${operation.slug}/responses`}>
+                  {operation.summary && (
+                    <VisuallyHidden>
+                      {operation.summary} &rsaquo;{" "}
+                    </VisuallyHidden>
+                  )}
+                  Responses
+                </Heading>
+                <ResponseContent
+                  responses={operation.responses}
+                  selectedResponse={selectedResponse}
+                  onSelectResponse={setSelectedResponse}
+                />
+              </>
+            )}
+          </div>
+        )}
 
-        <Sidecar
-          selectedResponse={selectedResponse}
-          onSelectResponse={setSelectedResponse}
-          operation={operation}
-        />
+        {renderIf(!options?.disableSidecar && !isMCPEndpoint, () => (
+          <Sidecar
+            selectedResponse={selectedResponse}
+            operation={operation}
+            globalSelectedServer={globalSelectedServer}
+            shouldLazyHighlight={shouldLazyHighlight}
+          />
+        ))}
       </div>
     </div>
   );

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

@@ -1,7 +1,7 @@
 import { ChevronsLeftRightIcon } from "lucide-react";
 import { isValidElement, useState } from "react";
 import { InlineCode } from "../../components/InlineCode.js";
-import { type SchemaObject } from "../../oas/parser/index.js";
+import type { SchemaObject } from "../../oas/parser/index.js";
 import { cn } from "../../util/cn.js";
 
 const Pattern = ({ pattern }: { pattern: string }) => {
@@ -30,22 +30,25 @@ const getSchemaInfos = (schema?: SchemaObject) => {
 
   return [
     schema.type === "array" && schema.items.type
-      ? `${schema.items.type}[]`
+      ? Array.isArray(schema.items.type)
+        ? `(${schema.items.type.join(" | ")})[]`
+        : `${schema.items.type}[]`
       : Array.isArray(schema.type)
         ? schema.type.join(" | ")
         : schema.type,
 
     schema.enum && "enum",
+    schema.const && "const",
     schema.format,
-    schema.minimum && `min: ${schema.minimum}`,
-    schema.maximum && `max: ${schema.maximum}`,
-    schema.minLength && `minLength: ${schema.minLength}`,
-    schema.maxLength && `maxLength: ${schema.maxLength}`,
-    schema.minItems && `minItems: ${schema.minItems}`,
-    schema.maxItems && `maxItems: ${schema.maxItems}`,
+    schema.minimum !== undefined && `min: ${schema.minimum}`,
+    schema.maximum !== undefined && `max: ${schema.maximum}`,
+    schema.minLength !== undefined && `minLength: ${schema.minLength}`,
+    schema.maxLength !== undefined && `maxLength: ${schema.maxLength}`,
+    schema.minItems !== undefined && `minItems: ${schema.minItems}`,
+    schema.maxItems !== undefined && `maxItems: ${schema.maxItems}`,
+    schema.minProperties !== undefined && `minProps: ${schema.minProperties}`,
+    schema.maxProperties !== undefined && `maxProps: ${schema.maxProperties}`,
     schema.uniqueItems && "unique",
-    schema.minProperties && `minProps: ${schema.minProperties}`,
-    schema.maxProperties && `maxProps: ${schema.maxProperties}`,
     schema.readOnly && "readOnly",
     schema.writeOnly && "writeOnly",
     schema.deprecated && "deprecated",
@@ -73,6 +76,7 @@ export const ParamInfos = ({
   return (
     <span className={className}>
       {filteredItems.map((item, index) => (
+        // biome-ignore lint/suspicious/noArrayIndexKey: index should be stable
         <span className="text-muted-foreground" key={index}>
           {item}
           {index < filteredItems.length - 1 && (

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

@@ -1,11 +1,11 @@
 import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
+import { Fragment } from "react";
 import { Heading } from "../../components/Heading.js";
-import { Card } from "../../ui/Card.js";
+import { Frame, FramePanel } from "../../ui/Frame.js";
+import { ItemGroup, ItemSeparator } from "../../ui/Item.js";
+import type { ParameterItem } from "./graphql/graphql.js";
 import type { ParameterGroup } from "./OperationListItem.js";
-import {
-  ParameterListItem,
-  type ParameterListItemResult,
-} from "./ParameterListItem.js";
+import { ParameterListItem } from "./ParameterListItem.js";
 
 export const ParameterList = ({
   summary,
@@ -15,27 +15,39 @@ export const ParameterList = ({
 }: {
   summary?: string;
   group: ParameterGroup;
-  parameters: ParameterListItemResult[];
+  parameters: ParameterItem[];
   id: string;
-}) => (
-  <>
-    <Heading level={3} id={`${id}/${group}-parameters`} className="capitalize">
-      {summary && <VisuallyHidden>{summary} &rsaquo; </VisuallyHidden>}
-      {group === "header" ? "Headers" : `${group} Parameters`}
-    </Heading>
-    <Card>
-      <ul className="list-none m-0 px-0 divide-y ">
-        {parameters
-          .sort((a, b) => (a.required === b.required ? 0 : a.required ? -1 : 1))
-          .map((parameter) => (
-            <ParameterListItem
-              key={`${parameter.name}-${parameter.in}`}
-              parameter={parameter}
-              id={id}
-              group={group}
-            />
-          ))}
-      </ul>
-    </Card>
-  </>
-);
+}) => {
+  const sortedParameters = parameters.sort((a, b) =>
+    a.required === b.required ? 0 : a.required ? -1 : 1,
+  );
+
+  return (
+    <>
+      <Heading
+        level={3}
+        id={`${id}/${group}-parameters`}
+        className="capitalize"
+      >
+        {summary && <VisuallyHidden>{summary} &rsaquo; </VisuallyHidden>}
+        {group === "header" ? "Headers" : `${group} Parameters`}
+      </Heading>
+      <Frame>
+        <FramePanel className="p-0!">
+          <ItemGroup className="overflow-clip">
+            {sortedParameters.map((parameter) => (
+              <Fragment key={`${parameter.name}-${parameter.in}`}>
+                <ParameterListItem
+                  parameter={parameter}
+                  id={id}
+                  group={group}
+                />
+                <ItemSeparator />
+              </Fragment>
+            ))}
+          </ItemGroup>
+        </FramePanel>
+      </Frame>
+    </>
+  );
+};