zudoku 0.0.0-e5be921 → 0.0.0-e614aaa

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

@@ -1,16 +1,26 @@
-import { ResultOf } from "@graphql-typed-document-node/core";
+import { type ResultOf } from "@graphql-typed-document-node/core";
 import { useSuspenseQuery } from "@tanstack/react-query";
 import { Helmet } from "@zudoku/react-helmet-async";
+import { useNavigate } from "react-router";
+import {
+  Select,
+  SelectContent,
+  SelectItem,
+  SelectTrigger,
+  SelectValue,
+} from "zudoku/ui/Select.js";
+import { useSelectedServer } from "../../authentication/state.js";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
 import { Heading } from "../../components/Heading.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.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 StaggeredRender from "./StaggeredRender.js";
 import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
+import { sanitizeMarkdownForMetatag } from "./util/sanitizeMarkdownForMetatag.js";
 
 export const OperationsFragment = graphql(/* GraphQL */ `
   fragment OperationsFragment on OperationItem {
@@ -79,84 +89,77 @@ export const OperationsFragment = graphql(/* GraphQL */ `
 export type OperationListItemResult = ResultOf<typeof OperationsFragment>;
 
 const AllOperationsQuery = graphql(/* GraphQL */ `
-  query AllOperations($input: JSON!, $type: SchemaType!) {
+  query AllOperations(
+    $input: JSON!
+    $type: SchemaType!
+    $tag: String
+    $untagged: Boolean
+  ) {
     schema(input: $input, type: $type) {
+      servers {
+        url
+      }
       description
       summary
       title
       url
       version
-      tags {
+      tags(name: $tag) {
         name
         description
-        operations {
-          slug
-          ...OperationsFragment
-        }
+      }
+      operations(tag: $tag, untagged: $untagged) {
+        slug
+        ...OperationsFragment
       }
     }
   }
 `);
 
-/**
- * @description Clean up a commonmark formatted description for use in the meta
- * description.
- */
-function cleanDescription(
-  description: string,
-  maxLength: number = 160,
-): string {
-  if (!description) {
-    return "";
-  }
-
-  // Replace Markdown links [text](url) with just "text"
-  description = description.replace(/\[([^\]]+)\]\([^)]+\)/g, "$1");
-
-  // Remove Markdown image syntax: ![alt](url)
-  description = description.replace(/!\[.*?\]\(.*?\)/g, "");
-
-  // Remove other Markdown syntax (e.g., **bold**, _italic_, `code`)
-  description = description.replace(/[_*`~]/g, "");
-
-  // 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, "");
-
-  // 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 });
+export const OperationList = ({
+  tag,
+  untagged,
+}: {
+  tag?: string;
+  untagged?: boolean;
+}) => {
+  const { input, type, versions, version } = useOasConfig();
+  const query = useCreateQuery(AllOperationsQuery, {
+    input,
+    type,
+    tag,
+    untagged,
+  });
   const result = useSuspenseQuery(query);
-  const title = result.data.schema.title;
-  const summary = result.data.schema.summary;
-  const description = result.data.schema.description;
+  const {
+    data: { schema },
+  } = result;
+  const { selectedServer } = useSelectedServer(schema.servers);
+  const title = schema.title;
+  const summary = schema.summary;
+  const description = schema.description;
+  const navigate = useNavigate();
+  const operations = schema.operations;
+  // Prefetch for Playground
+  useApiIdentities();
+
   // 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)
+      ? sanitizeMarkdownForMetatag(description)
       : undefined;
+
+  const showVersions = Object.entries(versions).length > 1;
+
   return (
-    <div className="pt-[--padding-content-top]">
+    <div
+      className="pt-[--padding-content-top]"
+      data-pagefind-filter="section:openapi"
+      data-pagefind-meta="section:openapi"
+    >
       <Helmet>
         <title>{title}</title>
         {metaDescription && (
@@ -166,18 +169,53 @@ export const OperationList = () => {
       <div
         className={cn(ProseClasses, "mb-16 max-w-full prose-img:max-w-prose")}
       >
-        <CategoryHeading>Overview</CategoryHeading>
-        <Heading level={1} id="description" registerSidebarAnchor>
-          {title}
-        </Heading>
-        <Markdown content={result.data.schema.description ?? ""} />
+        <div className="flex">
+          <div className="flex-1">
+            <CategoryHeading>Overview</CategoryHeading>
+            <Heading level={1} id="description" registerSidebarAnchor>
+              {title}
+              {showVersions && (
+                <span className="text-xl text-muted-foreground">
+                  {" "}
+                  ({version})
+                </span>
+              )}
+            </Heading>
+          </div>
+          <div>
+            {showVersions && (
+              <Select
+                onValueChange={(version) => navigate(versions[version]!)}
+                defaultValue={version}
+              >
+                <SelectTrigger className="w-[180px]">
+                  <SelectValue placeholder="Select version" />
+                </SelectTrigger>
+                <SelectContent>
+                  {Object.entries(versions).map(([version]) => (
+                    <SelectItem key={version} value={version}>
+                      {version}
+                    </SelectItem>
+                  ))}
+                </SelectContent>
+              </Select>
+            )}
+          </div>
+        </div>
+        <Markdown content={schema.description ?? ""} />
       </div>
       <hr />
-      <div className="my-4 flex justify-end">
+      <div className="my-4 flex items-center justify-end gap-4">
         <Endpoint />
       </div>
-
-      {result.data.schema.tags
+      {operations.map((fragment) => (
+        <OperationListItem
+          serverUrl={selectedServer}
+          key={fragment.slug}
+          operationFragment={fragment}
+        />
+      ))}
+      {/* {schema.tags
         .filter((tag) => tag.operations.length > 0)
         .map((tag) => (
           // px, -mx is so that `content-visibility` doesn't cut off overflown heading anchor links '#'
@@ -193,6 +231,7 @@ export const OperationList = () => {
               <StaggeredRender>
                 {tag.operations.map((fragment) => (
                   <OperationListItem
+                    serverUrl={selectedServer ?? schema.url}
                     key={fragment.slug}
                     operationFragment={fragment}
                   />
@@ -200,7 +239,7 @@ export const OperationList = () => {
               </StaggeredRender>
             </div>
           </div>
-        ))}
+        ))} */}
     </div>
   );
 };

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

@@ -1,4 +1,5 @@
-import { useState } from "react";
+import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
+import { useRef, useState } from "react";
 import { Heading } from "../../components/Heading.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.js";
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../ui/Tabs.js";
@@ -9,20 +10,24 @@ import { ParameterList } from "./ParameterList.js";
 import { Sidecar } from "./Sidecar.js";
 import { FragmentType, useFragment } from "./graphql/index.js";
 import { SchemaView } from "./schema/SchemaView.js";
+import { methodForColor } from "./util/methodToColor.js";
 
-export const PARAM_GROUPS = ["path", "query", "header", "cookie"] as const;
+const PARAM_GROUPS = ["path", "query", "header", "cookie"] as const;
 export type ParameterGroup = (typeof PARAM_GROUPS)[number];
 
 export const OperationListItem = ({
   operationFragment,
+  serverUrl,
 }: {
   operationFragment: FragmentType<typeof OperationsFragment>;
+  serverUrl?: string;
 }) => {
   const operation = useFragment(OperationsFragment, operationFragment);
   const groupedParameters = groupBy(
     operation.parameters ?? [],
     (param) => param.in,
   );
+  const parentRef = useRef<HTMLDivElement>(null);
 
   const first = operation.responses.at(0);
   const [selectedResponse, setSelectedResponse] = useState(first?.statusCode);
@@ -30,12 +35,44 @@ export const OperationListItem = ({
   return (
     <div
       key={operation.operationId}
-      className="grid grid-cols-1 lg:grid-cols-[4fr_3fr] gap-8 items-start border-b-2 mb-16 pb-16"
+      className="grid grid-cols-1 lg:grid-cols-[minmax(0,4fr)_minmax(0,3fr)] gap-8 items-start border-b-2 mb-16 pb-16"
     >
       <div className="flex flex-col gap-4">
-        <Heading level={2} id={operation.slug} registerSidebarAnchor>
+        <Heading
+          level={2}
+          id={operation.slug}
+          registerSidebarAnchor
+          className="break-all"
+        >
           {operation.summary}
         </Heading>
+        <div className="text-sm flex gap-2 font-mono">
+          <span className={methodForColor(operation.method)}>
+            {operation.method.toUpperCase()}
+          </span>
+          <div
+            ref={parentRef}
+            className="max-w-full truncate flex cursor-pointer"
+            onClick={() => {
+              if (parentRef.current) {
+                const range = document.createRange();
+                range.selectNodeContents(parentRef.current);
+                const selection = window.getSelection();
+                selection?.removeAllRanges();
+                selection?.addRange(range);
+              }
+            }}
+          >
+            {serverUrl && (
+              <div className="text-neutral-400 dark:text-neutral-500 truncate">
+                {serverUrl}
+              </div>
+            )}
+            <div className="text-neutral-900 dark:text-neutral-200">
+              {operation.path}
+            </div>
+          </div>
+        </div>
         {operation.description && (
           <Markdown
             className={`${ProseClasses} max-w-full prose-img:max-w-prose`}
@@ -48,6 +85,7 @@ export const OperationListItem = ({
               groupedParameters[group]?.length ? (
                 <ParameterList
                   key={group}
+                  summary={operation.summary ?? undefined}
                   id={operation.slug}
                   parameters={groupedParameters[group]}
                   group={group}
@@ -64,8 +102,10 @@ export const OperationListItem = ({
               level={3}
               className="capitalize"
               id={`${operation.slug}/request-body`}
-              registerSidebarAnchor
             >
+              {operation.summary && (
+                <VisuallyHidden>{operation.summary} &rsaquo; </VisuallyHidden>
+              )}
               Request Body
             </Heading>
             <SchemaView schema={schema} />
@@ -77,8 +117,10 @@ export const OperationListItem = ({
               level={3}
               className="capitalize mt-8 pt-8 border-t"
               id={`${operation.slug}/responses`}
-              registerSidebarAnchor
             >
+              {operation.summary && (
+                <VisuallyHidden>{operation.summary} &rsaquo; </VisuallyHidden>
+              )}
               Responses
             </Heading>
             <Tabs

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

@@ -1,3 +1,4 @@
+import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
 import { Heading } from "../../components/Heading.js";
 import { Card } from "../../ui/Card.js";
 import type { ParameterGroup } from "./OperationListItem.js";
@@ -7,16 +8,19 @@ import {
 } from "./ParameterListItem.js";
 
 export const ParameterList = ({
+  summary,
   group,
   parameters,
   id,
 }: {
+  summary?: string;
   group: ParameterGroup;
   parameters: ParameterListItemResult[];
   id: string;
 }) => (
   <>
     <Heading level={3} id={`${id}/${group}-parameters`} className="capitalize">
+      {summary && <VisuallyHidden>{summary} &rsaquo; </VisuallyHidden>}
       {group === "header" ? "Headers" : `${group} Parameters`}
     </Heading>
     <Card>

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

@@ -1,3 +1,4 @@
+import { Badge } from "zudoku/ui/Badge.js";
 import { Markdown } from "../../components/Markdown.js";
 import { type SchemaObject } from "../../oas/graphql/index.js";
 import { ColorizedParam } from "./ColorizedParam.js";
@@ -38,24 +39,22 @@ export const ParameterListItem = ({
             <ColorizedParam
               name={parameter.name}
               backgroundOpacity="15%"
-              slug={id + "-" + parameter.name.toLocaleLowerCase()}
+              className="px-1"
+              slug={`${id}-${parameter.name}`}
             />
           ) : (
             parameter.name
           )}
         </code>
-        {parameter.required && (
-          <span className="py-px px-1.5 font-medium bg-primary/75 text-muted rounded-lg">
-            required
-          </span>
-        )}
         {paramSchema.type && (
-          <span className="text-muted-foreground">
+          <Badge variant="muted">
             {paramSchema.type === "array"
               ? `${paramSchema.items.type}[]`
               : paramSchema.type}
-          </span>
+          </Badge>
         )}
+        {parameter.required && <Badge variant="outline">required</Badge>}
+        {parameter.style === "form" && <Badge variant="secondary">form</Badge>}
       </div>
       {parameter.description && (
         <Markdown

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

@@ -1,20 +1,29 @@
 import type { OperationListItemResult } from "./OperationList.js";
 import { PlaygroundDialog } from "./playground/PlaygroundDialog.js";
+import { Content } from "./SidecarExamples.js";
 
 export const PlaygroundDialogWrapper = ({
   server,
   servers,
   operation,
+  examples,
 }: {
-  server: string;
+  server?: string;
   servers?: string[];
   operation: OperationListItemResult;
+  examples?: Content;
 }) => {
   const headers = operation.parameters
     ?.filter((p) => p.in === "header")
+    .sort((a, b) => (a.required && !b.required ? -1 : 1))
     .map((p) => ({
       name: p.name,
-      defaultValue: p.examples?.find((x) => x.value)?.value ?? "",
+      defaultValue:
+        p.schema?.default ?? p.examples?.find((x) => x.value)?.value ?? "",
+      defaultActive: p.required ?? false,
+      isRequired: p.required ?? false,
+      enum: p.schema?.type == "array" ? p.schema?.items?.enum : p.schema?.enum,
+      type: p.schema?.type ?? "string",
     }));
   const queryParams = operation.parameters
     ?.filter((p) => p.in === "query")
@@ -23,6 +32,8 @@ export const PlaygroundDialogWrapper = ({
       name: p.name,
       defaultActive: p.required ?? false,
       isRequired: p.required ?? false,
+      enum: p.schema?.type == "array" ? p.schema?.items?.enum : p.schema?.enum,
+      type: p.schema?.type ?? "string",
     }));
   const pathParams = operation.parameters
     ?.filter((p) => p.in === "path")
@@ -37,6 +48,7 @@ export const PlaygroundDialogWrapper = ({
       headers={headers}
       queryParams={queryParams}
       pathParams={pathParams}
+      examples={examples}
     />
   );
 };

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

@@ -1,44 +1,21 @@
-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";
+import { type Content, SidecarExamples } from "./SidecarExamples.js";
 
-type Content = NonNullable<
-  NonNullable<OperationListItemResult["requestBody"]>["content"]
->;
-
-// @todo should we handle multiple content types?
-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)
-      : "");
+export const RequestBodySidecarBox = ({
+  content,
+  onExampleChange,
+}: {
+  content: Content;
+  onExampleChange?: (example: unknown) => void;
+}) => {
+  if (content.length === 0) return null;
 
   return (
-    <>
-      <SidecarBox.Root>
-        <SidecarBox.Head className="text-xs flex justify-between items-center">
-          <span className="font-mono">Request Body Example</span>
-        </SidecarBox.Head>
-        <SidecarBox.Body className="p-0">
-          <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>
-    </>
+    <SidecarBox.Root>
+      <SidecarBox.Head className="text-xs flex justify-between items-center">
+        <span className="font-mono">Request Body Example</span>
+      </SidecarBox.Head>
+      <SidecarExamples content={content} onExampleChange={onExampleChange} />
+    </SidecarBox.Root>
   );
 };

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

@@ -1,13 +1,22 @@
 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";
+import { SidecarExamples } from "./SidecarExamples.js";
 
 type Responses = OperationListItemResult["responses"];
+
+const ResponseContent = ({ response }: { response: Responses[number] }) => {
+  return (
+    <Tabs.Content value={response.statusCode}>
+      <SidecarExamples
+        content={response.content ?? []}
+        description={response.description ?? undefined}
+      />
+    </Tabs.Content>
+  );
+};
+
 export const ResponsesSidecarBox = ({
   responses,
   selectedResponse,
@@ -16,62 +25,36 @@ export const ResponsesSidecarBox = ({
   responses: Responses;
   selectedResponse?: string;
   onSelectResponse: (response: string) => void;
-}) => (
-  <SidecarBox.Root>
-    <Tabs.Root
-      defaultValue={responses[0]?.statusCode}
-      value={selectedResponse}
-      onValueChange={(value) => onSelectResponse(value)}
-    >
-      <SidecarBox.Head className="text-xs flex flex-col gap-2 pb-0">
-        <span className="font-mono">Example Responses</span>
-        <Tabs.List className="flex gap-2">
-          {responses.map((response) => (
-            <Tabs.Trigger
-              key={response.statusCode}
-              value={response.statusCode}
-              className={cn(
-                "text-xs font-mono px-1.5 py-1 pb-px translate-y-px border-b-2 border-transparent rounded-t cursor-pointer",
-                "data-[state=active]:text-primary data-[state=active]:dark:text-inherit data-[state=active]:border-primary",
-                "hover:border-accent-foreground/25",
-              )}
-            >
-              {response.statusCode}
-            </Tabs.Trigger>
-          ))}
-        </Tabs.List>
-      </SidecarBox.Head>
-      {responses.map((response) => {
-        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">
-              <CollapsibleCode>
-                <SyntaxHighlight
-                  language={example ? "json" : "plain"}
-                  noBackground
-                  className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
-                  code={
-                    example
-                      ? JSON.stringify(example, null, 2)
-                      : "Empty response"
-                  }
-                />
-              </CollapsibleCode>
-            </SidecarBox.Body>
-            <SidecarBox.Footer className="flex justify-end text-xs">
-              {response.description}
-            </SidecarBox.Footer>
-          </Tabs.Content>
-        );
-      })}
-    </Tabs.Root>
-  </SidecarBox.Root>
-);
+}) => {
+  return (
+    <SidecarBox.Root>
+      <Tabs.Root
+        defaultValue={responses[0]?.statusCode}
+        value={selectedResponse}
+        onValueChange={(value) => onSelectResponse(value)}
+      >
+        <SidecarBox.Head className="text-xs flex flex-col gap-2 pb-0">
+          <span className="font-mono">Example Responses</span>
+          <Tabs.List className="flex gap-2">
+            {responses.map((response) => (
+              <Tabs.Trigger
+                key={response.statusCode}
+                value={response.statusCode}
+                className={cn(
+                  "text-xs font-mono px-1.5 py-1 pb-px translate-y-px border-b-2 border-transparent rounded-t cursor-pointer",
+                  "data-[state=active]:text-primary data-[state=active]:dark:text-inherit data-[state=active]:border-primary",
+                  "hover:border-accent-foreground/25",
+                )}
+              >
+                {response.statusCode}
+              </Tabs.Trigger>
+            ))}
+          </Tabs.List>
+        </SidecarBox.Head>
+        {responses.map((response) => (
+          <ResponseContent key={response.statusCode} response={response} />
+        ))}
+      </Tabs.Root>
+    </SidecarBox.Root>
+  );
+};