zudoku 0.0.0-fabd0c1 → 0.0.0-fb5b775d

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

@@ -0,0 +1,161 @@
+import slugify from "@sindresorhus/slugify";
+import { useSuspenseQuery } from "@tanstack/react-query";
+import { Helmet } from "@zudoku/react-helmet-async";
+import {
+  ChevronRightIcon,
+  ChevronsDownUpIcon,
+  ChevronsUpDownIcon,
+} from "lucide-react";
+import { Button } from "zudoku/ui/Button.js";
+import {
+  Collapsible,
+  CollapsibleContent,
+  CollapsibleTrigger,
+} from "zudoku/ui/Collapsible.js";
+import { CategoryHeading } from "../../components/CategoryHeading.js";
+import { Heading } from "../../components/Heading.js";
+import { Markdown } from "../../components/Markdown.js";
+import { Toc } from "../../components/navigation/Toc.js";
+import { PagefindSearchMeta } from "../../components/PagefindSearchMeta.js";
+import { useCreateQuery } from "./client/useCreateQuery.js";
+import { useOasConfig } from "./context.js";
+import { graphql } from "./graphql/gql.js";
+import { SchemaView } from "./schema/SchemaView.js";
+
+const GET_SCHEMAS = graphql(/* GraphQL */ `
+  query GetSchemas($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      title
+      description
+      summary
+      components {
+        schemas {
+          name
+          schema
+          extensions
+        }
+      }
+    }
+  }
+`);
+
+export function SchemaList() {
+  const { input, type, versions, version, options } = useOasConfig();
+  const schemasQuery = useCreateQuery(GET_SCHEMAS, {
+    input,
+    type,
+  });
+  const { data } = useSuspenseQuery(schemasQuery);
+
+  const schemas = data.schema.components?.schemas ?? [];
+  const hasMultipleVersions = Object.entries(versions).length > 1;
+  const showVersions =
+    options?.showVersionSelect === "always" ||
+    (hasMultipleVersions && options?.showVersionSelect !== "hide");
+
+  if (!schemas.length) {
+    return (
+      <div>
+        <Helmet>
+          <title>Schemas {showVersions ? version : ""}</title>
+          <meta name="description" content="List of schemas used by the API." />
+        </Helmet>
+        No schemas found
+      </div>
+    );
+  }
+
+  return (
+    <div
+      className="grid grid-cols-(--sidecar-grid-cols) gap-8 justify-between"
+      data-pagefind-filter="section:openapi"
+      data-pagefind-meta="section:openapi"
+    >
+      <PagefindSearchMeta name="category">
+        {data.schema.title}
+      </PagefindSearchMeta>
+      <Helmet>
+        <title>Schemas {showVersions ? version : ""}</title>
+        <meta name="description" content="List of schemas used by the API." />
+      </Helmet>
+      <div className="pt-(--padding-content-top) pb-(--padding-content-bottom)">
+        <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-1">
+              <CategoryHeading>{data.schema.title}</CategoryHeading>
+              <Heading
+                level={1}
+                id="schemas"
+                registerNavigationAnchor
+                className="mb-0"
+              >
+                Schemas
+                {showVersions && (
+                  <span className="text-xl text-muted-foreground ms-1.5">
+                    ({version})
+                  </span>
+                )}
+              </Heading>
+            </div>
+            {data.schema.description && (
+              <CollapsibleTrigger className="flex items-center gap-1 text-sm font-medium text-muted-foreground group">
+                <span>API information</span>
+                <ChevronsUpDownIcon
+                  className="group-data-[state=open]:hidden translate-y-px"
+                  size={14}
+                />
+                <ChevronsDownUpIcon
+                  className="group-data-[state=closed]:hidden translate-y-px"
+                  size={13}
+                />
+              </CollapsibleTrigger>
+            )}
+          </div>
+          {data.schema.description && (
+            <CollapsibleContent className="CollapsibleContent">
+              <div className="mt-4 max-w-full border rounded-sm bg-muted/25">
+                <Markdown
+                  className="max-w-full prose-img:max-w-prose border-border p-3 lg:p-5"
+                  content={data.schema.description}
+                />
+              </div>
+            </CollapsibleContent>
+          )}
+        </Collapsible>
+        <hr className="my-8" />
+        <div className="flex flex-col gap-y-5">
+          {schemas.map((schema) => (
+            <Collapsible key={schema.name} className="group" defaultOpen>
+              <Heading
+                registerNavigationAnchor
+                level={2}
+                className="flex items-center gap-1 justify-between w-fit"
+                id={slugify(schema.name)}
+              >
+                {schema.name}{" "}
+                <CollapsibleTrigger asChild>
+                  <Button variant="ghost" size="icon" className="size-6">
+                    <ChevronRightIcon
+                      size={16}
+                      className="group-data-[state=open]:rotate-90 transition cursor-pointer"
+                    />
+                  </Button>
+                </CollapsibleTrigger>
+              </Heading>
+              <CollapsibleContent className="mt-4 CollapsibleContent">
+                <SchemaView schema={schema.schema} />
+              </CollapsibleContent>
+            </Collapsible>
+          ))}
+        </div>
+      </div>
+      <Toc
+        entries={schemas.map((schema) => ({
+          id: slugify(schema.name),
+          value: schema.name,
+          depth: 1,
+        }))}
+      />
+    </div>
+  );
+}

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

@@ -1,70 +1,27 @@
-import { useSuspenseQuery } from "@tanstack/react-query";
-import { HTTPSnippet } from "@zudoku/httpsnippet";
-import { Fragment, useMemo, useTransition } from "react";
+import { useMemo, useState, useTransition } from "react";
 import { useSearchParams } from "react-router";
-import { useSelectedServerStore } from "../../authentication/state.js";
-import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
-import type { SchemaObject } from "../../oas/parser/index.js";
+import { useZudoku } from "zudoku/hooks";
+import { Badge } from "zudoku/ui/Badge.js";
+import { NativeSelect, NativeSelectOption } from "zudoku/ui/NativeSelect.js";
+import { SyntaxHighlight } from "zudoku/ui/SyntaxHighlight.js";
+import { useAuthState } from "../../authentication/state.js";
+import { PathRenderer } from "../../components/PathRenderer.js";
 import { cn } from "../../util/cn.js";
 import { useOnScreen } from "../../util/useOnScreen.js";
-import { useCreateQuery } from "./client/useCreateQuery.js";
-import { CollapsibleCode } from "./CollapsibleCode.js";
 import { ColorizedParam } from "./ColorizedParam.js";
+import { NonHighlightedCode } from "./components/NonHighlightedCode.js";
 import { useOasConfig } from "./context.js";
+import { GeneratedExampleSidecarBox } from "./GeneratedExampleSidecarBox.js";
+import type { OperationsFragmentFragment } from "./graphql/graphql.js";
 import { graphql } from "./graphql/index.js";
-import type { OperationListItemResult } from "./OperationList.js";
 import { PlaygroundDialogWrapper } from "./PlaygroundDialogWrapper.js";
 import { RequestBodySidecarBox } from "./RequestBodySidecarBox.js";
 import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
 import * as SidecarBox from "./SidecarBox.js";
-import { SimpleSelect } from "./SimpleSelect.js";
+import { createHttpSnippet, getConverted } from "./util/createHttpSnippet.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
 import { methodForColor } from "./util/methodToColor.js";
 
-const getConverted = (snippet: HTTPSnippet, option: string) => {
-  let converted;
-  switch (option) {
-    case "shell":
-      converted = snippet.convert("shell", "curl");
-      break;
-    case "js":
-      converted = snippet.convert("javascript", "fetch");
-      break;
-    case "python":
-      converted = snippet.convert("python", "requests");
-      break;
-    case "java":
-      converted = snippet.convert("java", "okhttp");
-      break;
-    case "go":
-      converted = snippet.convert("go", "native");
-      break;
-    case "csharp":
-      converted = snippet.convert("csharp", "httpclient");
-      break;
-    case "kotlin":
-      converted = snippet.convert("kotlin", "okhttp");
-      break;
-    case "objc":
-      converted = snippet.convert("objc", "nsurlsession");
-      break;
-    case "php":
-      converted = snippet.convert("php", "http2");
-      break;
-    case "ruby":
-      converted = snippet.convert("ruby");
-      break;
-    case "swift":
-      converted = snippet.convert("swift");
-      break;
-    default:
-      converted = snippet.convert("shell");
-      break;
-  }
-
-  return converted ? converted[0] : "";
-};
-
 export const GetServerQuery = graphql(/* GraphQL */ `
   query getServerQuery($input: JSON!, $type: SchemaType!) {
     schema(input: $input, type: $type) {
@@ -93,128 +50,161 @@ const EXAMPLE_LANGUAGES = [
 export const Sidecar = ({
   operation,
   selectedResponse,
-  onSelectResponse,
+  globalSelectedServer,
+  shouldLazyHighlight,
 }: {
-  operation: OperationListItemResult;
+  operation: OperationsFragmentFragment;
   selectedResponse?: string;
-  onSelectResponse: (response: string) => void;
+  globalSelectedServer?: string;
+  shouldLazyHighlight?: boolean;
 }) => {
-  const { input, type } = useOasConfig();
-  const query = useCreateQuery(GetServerQuery, { input, type });
-  const result = useSuspenseQuery(query);
+  const { options } = useOasConfig();
+  const auth = useAuthState();
+  const context = useZudoku();
 
   const methodTextColor = methodForColor(operation.method);
 
   const [searchParams, setSearchParams] = useSearchParams();
   const [, startTransition] = useTransition();
 
-  const selectedLang = searchParams.get("lang") ?? "shell";
+  const supportedLanguages = options?.supportedLanguages ?? EXAMPLE_LANGUAGES;
+
+  const preferredLang =
+    searchParams.get("lang") ?? options?.examplesLanguage ?? "shell";
+
+  const selectedLang =
+    supportedLanguages.find((lang) => lang.value === preferredLang)?.value ??
+    supportedLanguages.at(0)?.value ??
+    "shell";
 
   const requestBodyContent = operation.requestBody?.content;
+  const transformedRequestBodyContent =
+    requestBodyContent && options?.transformExamples
+      ? options.transformExamples({
+          auth,
+          type: "request",
+          operation,
+          content: requestBodyContent,
+          context,
+        })
+      : requestBodyContent;
 
-  const path = operation.path.split("/").map((part, i, arr) => {
-    const isParam =
-      (part.startsWith("{") && part.endsWith("}")) || part.startsWith(":");
-    const paramName = isParam ? part.replace(/[:{}]/g, "") : undefined;
-
-    return (
-      // eslint-disable-next-line react/no-array-index-key
-      <Fragment key={part + i}>
-        {paramName ? (
-          <ColorizedParam
-            name={paramName}
-            backgroundOpacity="0"
-            // same as in `ParameterListItem`
-            slug={`${operation.slug}-${paramName.toLocaleLowerCase()}`}
-          >
-            {part}
-          </ColorizedParam>
-        ) : (
-          part
-        )}
-        {i < arr.length - 1 ? "/" : null}
-        <wbr />
-      </Fragment>
-    );
+  const [selectedRequestExample, setSelectedRequestExample] = useState<{
+    contentTypeIndex: number;
+    exampleIndex: number;
+  }>({
+    contentTypeIndex: 0,
+    exampleIndex: 0,
   });
 
-  const { selectedServer } = useSelectedServerStore();
+  const selectedContent = transformedRequestBodyContent?.at(
+    selectedRequestExample.contentTypeIndex,
+  );
+  const currentExample = selectedContent?.examples?.at(
+    selectedRequestExample.exampleIndex,
+  );
 
-  const code = useMemo(() => {
-    const example = requestBodyContent?.[0]?.schema
-      ? generateSchemaExample(requestBodyContent[0].schema as SchemaObject)
+  const currentExampleCode = currentExample
+    ? (currentExample?.value ?? currentExample)
+    : selectedContent?.schema
+      ? generateSchemaExample(selectedContent?.schema)
       : undefined;
 
-    const snippet = new HTTPSnippet({
-      method: operation.method.toLocaleUpperCase(),
-      url:
-        (selectedServer ?? result.data.schema.url ?? "") +
-        operation.path.replaceAll("{", ":").replaceAll("}", ""),
-      postData: example
+  const path = (
+    <PathRenderer
+      path={operation.path}
+      renderParam={({ name }) => (
+        <ColorizedParam
+          name={name}
+          backgroundOpacity="0"
+          className="py-px px-0.5"
+          // same as in `ParameterListItem`
+          slug={`${operation.slug}-${name}`}
+        >
+          {`{${name}}`}
+        </ColorizedParam>
+      )}
+    />
+  );
+
+  // 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 selectedServer =
+    globalSelectedServer || operation.servers.at(0)?.url || "";
+
+  const httpSnippetCode = useMemo<string | undefined>(() => {
+    const converted = options?.generateCodeSnippet?.({
+      selectedLang,
+      selectedServer,
+      context,
+      operation,
+      example: currentExampleCode,
+      auth,
+    });
+
+    if (converted) return converted;
+
+    const snippet = createHttpSnippet({
+      operation,
+      selectedServer,
+      exampleBody: currentExampleCode
         ? {
-            text: JSON.stringify(example, null, 2),
-            mimeType: "application/json",
+            mimeType: selectedContent?.mediaType ?? "application/json",
+            text: JSON.stringify(currentExampleCode, null, 2),
           }
-        : ({} as any),
-      headers: [],
-      queryString: [],
-      httpVersion: "",
-      cookies: [],
-      headersSize: 0,
-      bodySize: 0,
+        : { mimeType: selectedContent?.mediaType ?? "application/json" },
     });
 
     return getConverted(snippet, selectedLang);
   }, [
-    requestBodyContent,
-    operation.method,
-    operation.path,
+    currentExampleCode,
+    operation,
     selectedServer,
-    result.data.schema.url,
     selectedLang,
+    selectedContent,
+    options,
+    auth,
+    context,
   ]);
+
   const [ref, isOnScreen] = useOnScreen({ rootMargin: "200px 0px 200px 0px" });
 
+  const showPlayground =
+    isOnScreen &&
+    (operation.extensions["x-explorer-enabled"] === true ||
+      operation.extensions["x-zudoku-playground-enabled"] === true ||
+      (operation.extensions["x-explorer-enabled"] === undefined &&
+        operation.extensions["x-zudoku-playground-enabled"] === undefined &&
+        !options?.disablePlayground));
+
+  const hasResponseExamples = operation.responses.some((response) =>
+    response.content?.some((content) => (content.examples?.length ?? 0) > 0),
+  );
+
   return (
     <aside
       ref={ref}
-      className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4"
+      className="flex flex-col sticky top-(--scroll-padding) gap-4"
+      data-pagefind-ignore="all"
     >
       <SidecarBox.Root>
-        <SidecarBox.Head className="flex justify-between items-center flex-nowrap py-3 gap-2 text-xs">
-          <span className="font-mono break-words">
-            <span className={cn("font-semibold", methodTextColor)}>
-              {operation.method.toLocaleUpperCase()}
+        <SidecarBox.Head className="py-1.5">
+          <div className="flex items-center flex-wrap gap-2 justify-between w-full">
+            <span className="font-mono wrap-break-word leading-6 space-x-1">
+              <Badge
+                variant="outline"
+                className={cn(
+                  methodTextColor,
+                  "px-1.5 rounded-md border-none bg-current/7 dark:bg-current/15",
+                )}
+              >
+                {operation.method.toUpperCase()}
+              </Badge>
+              {path}
             </span>
-            &nbsp;
-            {path}
-          </span>
-          {isOnScreen && (
-            <PlaygroundDialogWrapper
-              server={result.data.schema.url ?? ""}
-              servers={
-                result.data.schema.servers.map((server) => server.url) ?? []
-              }
-              operation={operation}
-            />
-          )}
-        </SidecarBox.Head>
-        {isOnScreen && (
-          <>
-            <SidecarBox.Body className="p-0">
-              <CollapsibleCode>
-                <SyntaxHighlight
-                  language={selectedLang}
-                  noBackground
-                  className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
-                  code={code!}
-                />
-              </CollapsibleCode>
-            </SidecarBox.Body>
-            <SidecarBox.Footer className="flex items-center text-xs gap-2 justify-end py-1">
-              <span>Show example in</span>
-              <SimpleSelect
-                className="self-start max-w-[150px]"
+            <div className="flex items-center gap-1">
+              <NativeSelect
+                className="py-0.5 h-fit max-w-32 truncate bg-background"
                 value={selectedLang}
                 onChange={(e) => {
                   startTransition(() => {
@@ -224,20 +214,94 @@ export const Sidecar = ({
                     });
                   });
                 }}
-                options={EXAMPLE_LANGUAGES}
-              />
-            </SidecarBox.Footer>
-          </>
-        )}
+              >
+                {supportedLanguages.map((language) => (
+                  <NativeSelectOption
+                    key={language.value}
+                    value={language.value}
+                  >
+                    {language.label}
+                  </NativeSelectOption>
+                ))}
+              </NativeSelect>
+              {showPlayground && (
+                <PlaygroundDialogWrapper
+                  servers={operation.servers.map((server) => server.url)}
+                  operation={operation}
+                  examples={requestBodyContent ?? undefined}
+                />
+              )}
+            </div>
+          </div>
+        </SidecarBox.Head>
+        <SidecarBox.Body>
+          {shouldLazyHighlight && !isOnScreen ? (
+            <NonHighlightedCode code={httpSnippetCode ?? ""} />
+          ) : (
+            <SyntaxHighlight
+              embedded
+              language={selectedLang}
+              className="[--scrollbar-color:gray] rounded-none text-xs max-h-[200px]"
+              // biome-ignore lint/style/noNonNullAssertion: code is guaranteed to be defined
+              code={httpSnippetCode!}
+            />
+          )}
+        </SidecarBox.Body>
       </SidecarBox.Root>
-      {isOnScreen && requestBodyContent && (
-        <RequestBodySidecarBox content={requestBodyContent} />
-      )}
-      {isOnScreen && operation.responses.length > 0 && (
+
+      {transformedRequestBodyContent && currentExample ? (
+        <RequestBodySidecarBox
+          content={transformedRequestBodyContent}
+          onExampleChange={(selected) => {
+            setSelectedRequestExample(selected);
+          }}
+          selectedContentIndex={selectedRequestExample.contentTypeIndex}
+          selectedExampleIndex={selectedRequestExample.exampleIndex}
+          isOnScreen={isOnScreen}
+          shouldLazyHighlight={shouldLazyHighlight}
+        />
+      ) : transformedRequestBodyContent && currentExampleCode ? (
+        <GeneratedExampleSidecarBox
+          isOnScreen={isOnScreen}
+          shouldLazyHighlight={shouldLazyHighlight}
+          code={JSON.stringify(currentExampleCode, null, 2)}
+        />
+      ) : null}
+
+      {hasResponseExamples ? (
+        <ResponsesSidecarBox
+          isOnScreen={isOnScreen}
+          shouldLazyHighlight={shouldLazyHighlight}
+          selectedResponse={selectedResponse}
+          responses={operation.responses.map((response) => ({
+            ...response,
+            content:
+              response.content && options?.transformExamples
+                ? options.transformExamples({
+                    auth,
+                    type: "response",
+                    context,
+                    operation,
+                    content: response.content,
+                  })
+                : response.content,
+          }))}
+        />
+      ) : (
         <ResponsesSidecarBox
+          isGenerated
+          isOnScreen={isOnScreen}
+          shouldLazyHighlight={shouldLazyHighlight}
           selectedResponse={selectedResponse}
-          onSelectResponse={onSelectResponse}
-          responses={operation.responses}
+          responses={operation.responses.map((response) => ({
+            ...response,
+            content: response.content?.map((content) => ({
+              ...content,
+              examples: content.schema
+                ? [{ name: "", value: generateSchemaExample(content.schema) }]
+                : content.examples,
+            })),
+          }))}
         />
       )}
     </aside>

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

@@ -7,8 +7,10 @@ type BaseComponentProps<T = unknown> = PropsWithChildren<
 
 export const Root = ({ children, className }: BaseComponentProps) => (
   <div
+    data-slot="sidecar-box-root"
     className={cn(
-      "rounded-lg overflow-hidden border dark:border-transparent",
+      "relative text-xs flex min-w-0 flex-col rounded-xl border bg-muted/50 bg-clip-padding",
+      "before:pointer-events-none before:absolute before:inset-0 before:rounded-[calc(var(--radius-xl)-1px)] before:shadow-[0_1px_2px_1px_--theme(--color-black/4%)] after:pointer-events-none after:absolute after:-inset-[5px] after:-z-1 after:rounded-[calc(var(--radius-xl)+4px)] after:border after:border-border/50 after:bg-clip-padding **:data-[slot=particle-wrapper]:w-full **:data-[slot=particle-wrapper]:max-w-64 lg:col-span-1 dark:after:bg-background/72",
       className,
     )}
   >
@@ -18,8 +20,9 @@ export const Root = ({ children, className }: BaseComponentProps) => (
 
 export const Head = ({ children, className }: BaseComponentProps) => (
   <div
+    data-slot="sidecar-box-head"
     className={cn(
-      "border-b dark:border-zinc-600 bg-zinc-100 dark:bg-zinc-700 p-2",
+      "flex items-center gap-3 rounded-b-xl p-2.5 data-[slot=head]:rounded-b-none",
       className,
     )}
   >
@@ -29,7 +32,13 @@ export const Head = ({ children, className }: BaseComponentProps) => (
 
 export const Body = ({ children, className }: BaseComponentProps) => (
   <div
-    className={cn("bg-zinc-50 dark:bg-zinc-800 overflow-auto p-2", className)}
+    data-slot="sidecar-box-body"
+    className={cn(
+      "overflow-auto -m-px flex min-w-0 flex-1 flex-col overflow-x-auto rounded-t-xl border bg-background",
+      "rounded-b last:rounded-b-xl",
+      "before:pointer-events-none before:absolute before:inset-0 before:rounded-[calc(var(--radius-xl)-1px)] dark:before:shadow-[0_-1px_--theme(--color-white/8%)]",
+      className,
+    )}
   >
     {children}
   </div>
@@ -37,8 +46,9 @@ export const Body = ({ children, className }: BaseComponentProps) => (
 
 export const Footer = ({ children, className }: BaseComponentProps) => (
   <div
+    data-slot="sidecar-box-footer"
     className={cn(
-      "border-t dark:border-zinc-600 bg-zinc-100 dark:bg-zinc-700 p-2",
+      "p-2 rounded-b-xl data-[slot=sidecar-box-footer]:rounded-b-none",
       className,
     )}
   >