zudoku 0.0.0-fed343e → 0.0.0-feda542

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

@@ -1,18 +1,34 @@
-import { ResultOf } from "@graphql-typed-document-node/core";
+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 {
+  Collapsible,
+  CollapsibleContent,
+  CollapsibleTrigger,
+} from "zudoku/ui/Collapsible.js";
+import {
+  Select,
+  SelectContent,
+  SelectItem,
+  SelectTrigger,
+  SelectValue,
+} from "zudoku/ui/Select.js";
 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 { 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 StaggeredRender from "./StaggeredRender.js";
+import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
-import { useQuery } from "./util/urql.js";
+import { UNTAGGED_PATH } from "./index.js";
+import { useSelectedServer } from "./state.js";
+import { sanitizeMarkdownForMetatag } from "./util/sanitizeMarkdownForMetatag.js";
 
 export const OperationsFragment = graphql(/* GraphQL */ `
   fragment OperationsFragment on OperationItem {
@@ -23,6 +39,8 @@ export const OperationsFragment = graphql(/* GraphQL */ `
     operationId
     contentTypes
     path
+    deprecated
+    extensions
     parameters {
       name
       in
@@ -30,6 +48,7 @@ export const OperationsFragment = graphql(/* GraphQL */ `
       required
       schema
       style
+      explode
       examples {
         name
         description
@@ -44,6 +63,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
         encoding {
           name
         }
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         schema
       }
       description
@@ -54,6 +80,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
       links
       description
       content {
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         mediaType
         encoding {
           name
@@ -66,98 +99,225 @@ export const OperationsFragment = graphql(/* GraphQL */ `
 
 export type OperationListItemResult = ResultOf<typeof OperationsFragment>;
 
-const AllOperationsQuery = graphql(/* GraphQL */ `
-  query AllOperations($input: JSON!, $type: SchemaType!) {
+const SchemaWarmupQuery = graphql(/* GraphQL */ `
+  query SchemaWarmup($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      openapi
+    }
+  }
+`);
+
+const OperationsForTagQuery = graphql(/* GraphQL */ `
+  query OperationsForTag(
+    $input: JSON!
+    $type: SchemaType!
+    $tag: String
+    $untagged: Boolean
+  ) {
     schema(input: $input, type: $type) {
+      servers {
+        url
+      }
       description
+      summary
       title
       url
       version
-      tags {
+      tag(slug: $tag, untagged: $untagged) {
         name
         description
         operations {
           slug
           ...OperationsFragment
         }
+        next {
+          name
+          slug
+        }
+        prev {
+          name
+          slug
+        }
       }
     }
   }
 `);
 
-const suspenseContext = { suspense: true };
-
-export const OperationList = () => {
-  const { type, input } = useOasConfig();
+export const OperationList = ({
+  tag,
+  untagged,
+}: {
+  tag?: string;
+  untagged?: boolean;
+}) => {
+  const { input, type, versions, version, options } = useOasConfig();
+  const query = useCreateQuery(OperationsForTagQuery, {
+    input,
+    type,
+    tag,
+    untagged,
+  });
+  const result = useSuspenseQuery(query);
+  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 [result] = useQuery({
-    query: AllOperationsQuery,
-    variables: { type, input },
-    context: suspenseContext,
+  // This is to warmup (i.e. load the schema in the background) the schema on the client, if the page has been rendered on the server
+  const warmupQuery = useCreateQuery(SchemaWarmupQuery, { input, type });
+  useQuery({
+    ...warmupQuery,
+    enabled: typeof window !== "undefined",
+    notifyOnChangeProps: [],
   });
 
-  const error = result.error?.graphQLErrors.at(0);
+  // Prefetch for Playground
+  useApiIdentities();
 
-  // 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 (!schema.tag) return null;
+
+  const { operations, next, prev, description: tagDescription } = schema.tag;
+
+  // 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 = tagDescription
+    ? sanitizeMarkdownForMetatag(tagDescription)
+    : summary
+      ? summary
+      : description
+        ? sanitizeMarkdownForMetatag(description)
+        : undefined;
+
+  const hasMultipleVersions = Object.entries(versions).length > 1;
 
-  if (!result.data) return null;
+  const showVersions =
+    options?.showVersionSelect === "always" ||
+    (hasMultipleVersions && options?.showVersionSelect !== "hide");
+
+  const paginationProps = {
+    prev: prev?.name ? { to: `../${prev.slug}`, label: prev.name } : undefined,
+    next: next
+      ? {
+          to: `../${next.slug ?? UNTAGGED_PATH}`,
+          label: next.name ?? "Other endpoints",
+        }
+      : undefined,
+  };
 
   return (
-    <div className="pt-[--padding-content-top]">
-      <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}
-        </Heading>
-        <Markdown content={result.data.schema.description ?? ""} />
-      </div>
-      <hr />
-      <Endpoint url={result.data.schema.url} />
+    <div
+      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>
+        {metaDescription && (
+          <meta name="description" content={metaDescription} />
+        )}
+      </Helmet>
+      <div className="mb-8">
+        <Collapsible className="w-full">
+          <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
+                className="mb-0"
+              >
+                {schema.tag.name ?? "Other endpoints"}
+                {showVersions && (
+                  <span className="text-xl text-muted-foreground ml-1.5">
+                    {" "}
+                    ({version})
+                  </span>
+                )}
+              </Heading>
+              <Endpoint />
+            </div>
+            <div className="flex flex-col gap-4 sm:items-end">
+              {showVersions && (
+                <Select
+                  onValueChange={(version) => navigate(versions[version]!)}
+                  defaultValue={version}
+                  disabled={!hasMultipleVersions}
+                >
+                  <SelectTrigger className="w-[180px]">
+                    <SelectValue placeholder="Select version" />
+                  </SelectTrigger>
+                  <SelectContent>
+                    {Object.entries(versions).map(([version]) => (
+                      <SelectItem key={version} value={version}>
+                        {version}
+                      </SelectItem>
+                    ))}
+                  </SelectContent>
+                </Select>
+              )}
+              {schema.description && (
+                <CollapsibleTrigger className="flex items-center gap-1 text-sm font-medium text-muted-foreground group">
+                  <span>API information</span>
 
-      {result.data.schema.tags
-        .filter((tag) => tag.operations.length > 0)
-        .map((tag) => (
-          <div key={tag.name}>
-            {tag.name && <CategoryHeading>{tag.name}</CategoryHeading>}
-            {tag.description && (
-              <Markdown
-                className={`${ProseClasses} max-w-full prose-img:max-w-prose w-full mt-2 mb-12`}
-                content={tag.description}
-              />
-            )}
-            <div className="operation mb-12">
-              <StaggeredRender>
-                {tag.operations.map((fragment) => (
-                  <OperationListItem
-                    key={fragment.slug}
-                    operationFragment={fragment}
+                  <ChevronsUpDownIcon
+                    className="group-data-[state=open]:hidden translate-y-px"
+                    size={14}
+                  />
+                  <ChevronsDownUpIcon
+                    className="group-data-[state=closed]:hidden translate-y-px"
+                    size={13}
                   />
-                ))}
-              </StaggeredRender>
+                </CollapsibleTrigger>
+              )}
             </div>
           </div>
+          {schema.description && (
+            <CollapsibleContent className="CollapsibleContent">
+              <div
+                className={cn(
+                  ProseClasses,
+                  "pt-4 max-w-full prose-img:max-w-prose",
+                )}
+              >
+                <Markdown
+                  className="border rounded bg-muted/25 border-border px-2.5 md:px-4"
+                  content={schema.description}
+                />
+              </div>
+            </CollapsibleContent>
+          )}
+        </Collapsible>
+        {tagDescription && (
+          <div
+            className={cn(
+              ProseClasses,
+              "my-4 max-w-full prose-img:max-w-prose",
+            )}
+          >
+            <Markdown content={tagDescription} />
+          </div>
+        )}
+      </div>
+      <hr />
+      {/* px, -mx is so that `content-visibility` doesn't cut off overflown heading anchor links '#' */}
+      <div className="px-6 mt-6 -mx-6 [content-visibility:auto]">
+        {operations.map((fragment) => (
+          <div key={fragment.slug}>
+            <OperationListItem
+              serverUrl={selectedServer}
+              operationFragment={fragment}
+            />
+            <hr className="my-10" />
+          </div>
         ))}
+        <Pagination className="mb-4" {...paginationProps} />
+      </div>
     </div>
   );
 };

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

@@ -1,22 +1,29 @@
+import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
 import { useState } from "react";
+import { Badge } from "zudoku/ui/Badge.js";
 import { Heading } from "../../components/Heading.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.js";
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../ui/Tabs.js";
+import { cn } from "../../util/cn.js";
 import { groupBy } from "../../util/groupBy.js";
 import { renderIf } from "../../util/renderIf.js";
 import { OperationsFragment } from "./OperationList.js";
 import { ParameterList } from "./ParameterList.js";
 import { Sidecar } from "./Sidecar.js";
-import { FragmentType, useFragment } from "./graphql/index.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";
 
-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(
@@ -28,101 +35,142 @@ export const OperationListItem = ({
   const [selectedResponse, setSelectedResponse] = useState(first?.statusCode);
 
   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"
-    >
-      <div className="flex flex-col gap-4">
-        <Heading level={2} id={operation.slug} registerSidebarAnchor>
+    <div>
+      {operation.deprecated && (
+        <Badge variant="muted" className="text-xs mb-4">
+          deprecated
+        </Badge>
+      )}
+      <div
+        key={operation.operationId}
+        className={cn(
+          "grid grid-cols-1 lg:grid-cols-[minmax(0,4fr)_minmax(0,3fr)] gap-x-8 gap-y-4 items-start",
+          operation.deprecated && "opacity-50 transition hover:opacity-100",
+        )}
+      >
+        <Heading
+          level={2}
+          id={operation.slug}
+          registerSidebarAnchor
+          className="break-all col-span-full"
+        >
           {operation.summary}
         </Heading>
-        {operation.description && (
-          <Markdown
-            className={`${ProseClasses} 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}
-                  id={operation.slug}
-                  parameters={groupedParameters[group]}
-                  group={group}
-                />
-              ) : (
-                []
-              ),
+        <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(/\/$/, "")}
+              </div>
             )}
-          </>
-        )}
-        {renderIf(operation.requestBody?.content?.at(0)?.schema, (schema) => (
-          <div className="mt-4 flex flex-col gap-4">
-            <Heading
-              level={3}
-              className="capitalize"
-              id={`${operation.slug}/request-body`}
-              registerSidebarAnchor
-            >
-              Request Body
-            </Heading>
-            <SchemaView schema={schema} />
-          </div>
-        ))}
-        {operation.responses.length > 0 && (
-          <>
-            <Heading
-              level={3}
-              className="capitalize mt-8 pt-8 border-t"
-              id={`${operation.slug}/responses`}
-              registerSidebarAnchor
-            >
-              Responses
-            </Heading>
-            <Tabs
-              onValueChange={(value) => setSelectedResponse(value)}
-              value={selectedResponse}
-            >
-              {operation.responses.length > 1 && (
-                <TabsList>
+            <div className="text-neutral-900 dark:text-neutral-200">
+              {operation.path}
+            </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}
+            />
+          )}
+          {operation.parameters && operation.parameters.length > 0 && (
+            <>
+              {PARAM_GROUPS.flatMap((group) =>
+                groupedParameters[group]?.length ? (
+                  <ParameterList
+                    key={group}
+                    summary={operation.summary ?? undefined}
+                    id={operation.slug}
+                    parameters={groupedParameters[group]}
+                    group={group}
+                  />
+                ) : (
+                  []
+                ),
+              )}
+            </>
+          )}
+          {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) => (
-                    <TabsTrigger
+                    <TabsContent
                       value={response.statusCode}
                       key={response.statusCode}
-                      title={response.description}
                     >
-                      {response.statusCode}
-                    </TabsTrigger>
+                      <SchemaView
+                        schema={
+                          response.content?.find((content) => content.schema)
+                            ?.schema
+                        }
+                      />
+                    </TabsContent>
                   ))}
-                </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>
+                </ul>
+              </Tabs>
+            </>
+          )}
+        </div>
 
-      <Sidecar
-        selectedResponse={selectedResponse}
-        onSelectResponse={setSelectedResponse}
-        operation={operation}
-      />
+        <Sidecar
+          selectedResponse={selectedResponse}
+          onSelectResponse={setSelectedResponse}
+          operation={operation}
+        />
+      </div>
     </div>
   );
 };