zudoku 0.0.0-f2fd45c → 0.0.0-f3786a4

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

@@ -1,18 +1,27 @@
 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 { useNavigate } from "react-router";
+import {
+  Select,
+  SelectContent,
+  SelectItem,
+  SelectTrigger,
+  SelectValue,
+} from "zudoku/ui/Select.js";
+import { useSelectedServerStore } from "../../authentication/state.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 { 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 {
@@ -44,6 +53,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
         encoding {
           name
         }
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         schema
       }
       description
@@ -54,6 +70,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
       links
       description
       content {
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         mediaType
         encoding {
           name
@@ -70,6 +93,7 @@ const AllOperationsQuery = graphql(/* GraphQL */ `
   query AllOperations($input: JSON!, $type: SchemaType!) {
     schema(input: $input, type: $type) {
       description
+      summary
       title
       url
       version
@@ -85,62 +109,77 @@ const AllOperationsQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const suspenseContext = { suspense: true };
-
 export const OperationList = () => {
-  const { type, input } = useOasConfig();
+  const { input, type, versions, version } = useOasConfig();
+  const query = useCreateQuery(AllOperationsQuery, { input, type });
+  const { selectedServer } = useSelectedServerStore();
+  const result = useSuspenseQuery(query);
+  const title = result.data.schema.title;
+  const summary = result.data.schema.summary;
+  const description = result.data.schema.description;
+  const navigate = useNavigate();
 
-  const [result] = useQuery({
-    query: AllOperationsQuery,
-    variables: { type, input },
-    context: suspenseContext,
-  });
+  // Prefetch for Playground
+  useApiIdentities();
 
-  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;
+  // 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
+      ? sanitizeMarkdownForMetatag(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}
-        </Heading>
+        <div className="flex">
+          <div className="flex-1">
+            <CategoryHeading>Overview</CategoryHeading>
+            <Heading level={1} id="description" registerSidebarAnchor>
+              {title}
+            </Heading>
+          </div>
+          <div>
+            {Object.entries(versions).length > 1 && (
+              <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={result.data.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
         .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
@@ -152,6 +191,7 @@ export const OperationList = () => {
               <StaggeredRender>
                 {tag.operations.map((fragment) => (
                   <OperationListItem
+                    serverUrl={selectedServer ?? result.data.schema.url}
                     key={fragment.slug}
                     operationFragment={fragment}
                   />

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

@@ -1,4 +1,4 @@
-import { useState } from "react";
+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 +9,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;
 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 +34,39 @@ 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>
           {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`}
@@ -64,7 +95,6 @@ export const OperationListItem = ({
               level={3}
               className="capitalize"
               id={`${operation.slug}/request-body`}
-              registerSidebarAnchor
             >
               Request Body
             </Heading>
@@ -77,7 +107,6 @@ export const OperationListItem = ({
               level={3}
               className="capitalize mt-8 pt-8 border-t"
               id={`${operation.slug}/responses`}
-              registerSidebarAnchor
             >
               Responses
             </Heading>

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";
@@ -27,36 +28,39 @@ 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%"
+              className="px-1"
+              slug={id + "-" + parameter.name.toLocaleLowerCase()}
+            />
+          ) : (
+            parameter.name
+          )}
+        </code>
+        {paramSchema.type && (
+          <Badge variant="muted">
+            {paramSchema.type === "array"
+              ? `${paramSchema.items.type}[]`
+              : paramSchema.type}
+          </Badge>
         )}
-      </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>
+        {parameter.required && <Badge variant="outline">required</Badge>}
+      </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/PlaygroundDialogWrapper.tsx

@@ -1,20 +1,24 @@
 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;
   servers?: string[];
   operation: OperationListItemResult;
+  examples?: Content;
 }) => {
   const headers = operation.parameters
     ?.filter((p) => p.in === "header")
     .map((p) => ({
       name: p.name,
       defaultValue: p.examples?.find((x) => x.value)?.value ?? "",
+      defaultActive: false,
     }));
   const queryParams = operation.parameters
     ?.filter((p) => p.in === "query")
@@ -23,6 +27,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 +43,7 @@ export const PlaygroundDialogWrapper = ({
       headers={headers}
       queryParams={queryParams}
       pathParams={pathParams}
+      examples={examples}
     />
   );
 };

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

@@ -1,39 +1,19 @@
-import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
-import { type SchemaObject } from "../../oas/graphql/index.js";
-import type { OperationListItemResult } from "./OperationList.js";
 import * as SidecarBox from "./SidecarBox.js";
-import { generateSchemaExample } from "./util/generateSchemaExample.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;
+import { type Content, SidecarExamples } from "./SidecarExamples.js";
 
+export const RequestBodySidecarBox = ({
+  content,
+  onExampleChange,
+}: {
+  content: Content;
+  onExampleChange?: (example: unknown) => void;
+}) => {
   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">
-          <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,
-            )}
-          />
-        </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,12 +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 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,
@@ -15,58 +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 schema = response.content?.[0]?.schema as
-          | SchemaObject
-          | undefined;
-
-        return (
-          <Tabs.Content key={response.statusCode} value={response.statusCode}>
-            <SidecarBox.Body className="p-0">
-              {schema ? (
-                <SyntaxHighlight
-                  language="json"
-                  noBackground
-                  className="text-xs max-h-[450px] p-2"
-                  code={JSON.stringify(generateSchemaExample(schema), null, 2)}
-                />
-              ) : (
-                <span className="text-muted-foreground font-mono italic text-xs">
-                  Empty Response
-                </span>
-              )}
-            </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>
+  );
+};

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

@@ -1,20 +1,51 @@
-import { Outlet } from "react-router-dom";
-import { Provider, Client as UrqlClient } from "urql";
+import { Outlet, useParams } from "react-router";
+import { joinPath } from "../../util/joinPath.js";
+import type { GraphQLClient } from "./client/GraphQLClient.js";
+import { GraphQLProvider } from "./client/GraphQLContext.js";
 import { OasConfigProvider } from "./context.js";
-import { OasPluginConfig } from "./interfaces.js";
+import { type OasPluginConfig } from "./interfaces.js";
 
-export function OpenApiRoute({
+export const OpenApiRoute = ({
+  basePath,
+  versions,
   config,
   client,
 }: {
+  basePath: string;
+  versions: string[];
   config: OasPluginConfig;
-  client: typeof UrqlClient;
-}) {
+  client: GraphQLClient;
+}) => {
+  const { version } = useParams<"version">();
+
+  const input =
+    config.type === "file"
+      ? {
+          type: config.type,
+          input: version
+            ? config.input[version]!
+            : Object.values(config.input).at(0)!,
+        }
+      : { type: config.type, input: config.input };
+
+  const currentVersion = version ?? versions.at(0);
+
   return (
-    <Provider value={client}>
-      <OasConfigProvider value={{ config }}>
+    <OasConfigProvider
+      value={{
+        config: {
+          ...config,
+          version: currentVersion,
+          versions: Object.fromEntries(
+            versions.map((version) => [version, joinPath(basePath, version)]),
+          ),
+          ...input,
+        },
+      }}
+    >
+      <GraphQLProvider client={client}>
         <Outlet />
-      </OasConfigProvider>
-    </Provider>
+      </GraphQLProvider>
+    </OasConfigProvider>
   );
-}
+};