zudoku 0.0.0-e097cbb → 0.0.0-e0ffac16

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

@@ -17,10 +17,9 @@ import {
 } from "zudoku/ui/Select.js";
 import { CategoryHeading } from "../../components/CategoryHeading.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";
@@ -221,14 +220,16 @@ export const OperationList = ({
       : undefined,
   };
 
+  const helmetTitle = [schema.tag.name, 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} />
         )}
@@ -241,12 +242,12 @@ export const OperationList = ({
               <Heading
                 level={1}
                 id="description"
-                registerSidebarAnchor
+                registerNavigationAnchor
                 className="mb-0"
               >
-                {schema.tag.name ?? "Other endpoints"}
+                {schema.tag.name ?? "Documentation"}
                 {showVersions && (
-                  <span className="text-xl text-muted-foreground ml-1.5">
+                  <span className="text-xl text-muted-foreground ms-1.5">
                     {" "}
                     ({version})
                   </span>
@@ -291,14 +292,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>
@@ -306,14 +302,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 />

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

@@ -2,15 +2,16 @@ 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 { Markdown } from "../../components/Markdown.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 { 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 { SchemaView } from "./schema/SchemaView.js";
 import { methodForColor } from "./util/methodToColor.js";
@@ -30,6 +31,7 @@ export const OperationListItem = ({
     operation.parameters ?? [],
     (param) => param.in,
   );
+  const { options } = useOasConfig();
 
   const first = operation.responses.at(0);
   const [selectedResponse, setSelectedResponse] = useState(first?.statusCode);
@@ -51,7 +53,7 @@ export const OperationListItem = ({
         <Heading
           level={2}
           id={operation.slug}
-          registerSidebarAnchor
+          registerNavigationAnchor
           className="break-all col-span-full"
         >
           {operation.summary}
@@ -72,10 +74,15 @@ export const OperationListItem = ({
           </SelectOnClick>
         </div>
 
-        <div className="flex flex-col gap-4">
+        <div
+          className={cn(
+            "flex flex-col gap-4",
+            options?.disableSidecar && "col-span-full",
+          )}
+        >
           {operation.description && (
             <Markdown
-              className={`${ProseClasses} max-w-full prose-img:max-w-prose`}
+              className="max-w-full prose-img:max-w-prose"
               content={operation.description}
             />
           )}
@@ -128,48 +135,22 @@ export const OperationListItem = ({
                 )}
                 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>
+              <ResponseContent
+                responses={operation.responses}
+                selectedResponse={selectedResponse}
+                onSelectResponse={setSelectedResponse}
+              />
             </>
           )}
         </div>
 
-        <Sidecar
-          selectedResponse={selectedResponse}
-          onSelectResponse={setSelectedResponse}
-          operation={operation}
-        />
+        {renderIf(!options?.disableSidecar, () => (
+          <Sidecar
+            selectedResponse={selectedResponse}
+            onSelectResponse={setSelectedResponse}
+            operation={operation}
+          />
+        ))}
       </div>
     </div>
   );

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

@@ -30,7 +30,9 @@ 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,

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

@@ -72,6 +72,12 @@ export const ParameterListItem = ({
       {parameter.description && (
         <Markdown
           content={parameter.description}
+          className="text-sm prose prose-p:my-1 prose-code:whitespace-pre-line"
+        />
+      )}
+      {paramSchema.description && (
+        <Markdown
+          content={paramSchema.description}
           className="text-sm prose-p:my-1 prose-code:whitespace-pre-line"
         />
       )}

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

@@ -1,7 +1,7 @@
 import { useAuth } from "zudoku/components";
 import type { OperationListItemResult } from "./OperationList.js";
 import { PlaygroundDialog } from "./playground/PlaygroundDialog.js";
-import { Content } from "./SidecarExamples.js";
+import { type Content } from "./SidecarExamples.js";
 
 export const PlaygroundDialogWrapper = ({
   server,
@@ -29,6 +29,7 @@ export const PlaygroundDialogWrapper = ({
       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")
     .sort((a, b) => (a.required && !b.required ? -1 : 1))
@@ -38,10 +39,15 @@ export const PlaygroundDialogWrapper = ({
       isRequired: p.required ?? false,
       enum: p.schema?.type == "array" ? p.schema?.items?.enum : p.schema?.enum,
       type: p.schema?.type ?? "string",
+      defaultValue: p.schema?.default,
     }));
+
   const pathParams = operation.parameters
     ?.filter((p) => p.in === "path")
-    .map((p) => ({ name: p.name }));
+    .map((p) => ({
+      name: p.name,
+      defaultValue: p.schema?.default,
+    }));
 
   return (
     <PlaygroundDialog

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

@@ -1,28 +1,15 @@
 import * as Tabs from "@radix-ui/react-tabs";
 import { cn } from "../../util/cn.js";
-import type { OperationListItemResult } from "./OperationList.js";
 import * as SidecarBox from "./SidecarBox.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>
-  );
-};
+import type { ResponseItem } from "./graphql/graphql.js";
 
 export const ResponsesSidecarBox = ({
   responses,
   selectedResponse,
   onSelectResponse,
 }: {
-  responses: Responses;
+  responses: ResponseItem[];
   selectedResponse?: string;
   onSelectResponse: (response: string) => void;
 }) => {
@@ -52,7 +39,9 @@ export const ResponsesSidecarBox = ({
           </Tabs.List>
         </SidecarBox.Head>
         {responses.map((response) => (
-          <ResponseContent key={response.statusCode} response={response} />
+          <Tabs.Content key={response.statusCode} value={response.statusCode}>
+            <SidecarExamples content={response.content ?? []} />
+          </Tabs.Content>
         ))}
       </Tabs.Root>
     </SidecarBox.Root>

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

@@ -1,5 +1,6 @@
 import slugify from "@sindresorhus/slugify";
 import { useSuspenseQuery } from "@tanstack/react-query";
+import { Helmet } from "@zudoku/react-helmet-async";
 import {
   ChevronRightIcon,
   ChevronsDownUpIcon,
@@ -13,9 +14,8 @@ import {
 } from "zudoku/ui/Collapsible.js";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
 import { Heading } from "../../components/Heading.js";
-import { Markdown, ProseClasses } from "../../components/Markdown.js";
+import { Markdown } from "../../components/Markdown.js";
 import { Toc } from "../../components/navigation/Toc.js";
-import { cn } from "../../util/cn.js";
 import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/gql.js";
@@ -47,23 +47,34 @@ export function SchemaList() {
   const { data } = useSuspenseQuery(schemasQuery);
 
   const schemas = data.schema.components?.schemas ?? [];
-
-  if (!schemas.length) {
-    return <div>No schemas found</div>;
-  }
-
   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"
+      className="grid grid-cols-(--sidecar-grid-cols) gap-8 justify-between"
       data-pagefind-filter="section:openapi"
       data-pagefind-meta="section:openapi"
     >
-      <div className="pt-[--padding-content-top] pb-[--padding-content-bottom]">
+      <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">
@@ -71,12 +82,12 @@ export function SchemaList() {
               <Heading
                 level={1}
                 id="schemas"
-                registerSidebarAnchor
+                registerNavigationAnchor
                 className="mb-0"
               >
                 Schemas
                 {showVersions && (
-                  <span className="text-xl text-muted-foreground ml-1.5">
+                  <span className="text-xl text-muted-foreground ms-1.5">
                     ({version})
                   </span>
                 )}
@@ -98,14 +109,9 @@ export function SchemaList() {
           </div>
           {data.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={data.schema.description}
                 />
               </div>
@@ -117,7 +123,7 @@ export function SchemaList() {
           {schemas.map((schema) => (
             <Collapsible key={schema.name} className="group" defaultOpen>
               <Heading
-                registerSidebarAnchor
+                registerNavigationAnchor
                 level={2}
                 className="flex items-center gap-1 justify-between w-fit"
                 id={slugify(schema.name)}

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

@@ -1,8 +1,7 @@
 import { useSuspenseQuery } from "@tanstack/react-query";
-import { HTTPSnippet } from "@zudoku/httpsnippet";
 import { useMemo, useState, useTransition } from "react";
 import { useSearchParams } from "react-router";
-import { useZudoku } from "zudoku/components";
+import { useZudoku } from "zudoku/hooks";
 import { useAuthState } from "../../authentication/state.js";
 import { PathRenderer } from "../../components/PathRenderer.js";
 import type { SchemaObject } from "../../oas/parser/index.js";
@@ -21,53 +20,10 @@ import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { SimpleSelect } from "./SimpleSelect.js";
 import { useSelectedServer } from "./state.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) {
@@ -149,7 +105,7 @@ export const Sidecar = ({
   const { selectedServer } = useSelectedServer(result.data.schema.servers);
 
   const code = useMemo(() => {
-    const example =
+    const exampleBody =
       selectedExample ??
       (transformedRequestBodyContent?.[0]?.schema
         ? generateSchemaExample(
@@ -157,31 +113,22 @@ export const Sidecar = ({
           )
         : undefined);
 
-    const snippet = new HTTPSnippet({
-      method: operation.method.toLocaleUpperCase(),
-      url:
-        selectedServer +
-        operation.path.replaceAll("{", ":").replaceAll("}", ""),
-      postData: example
+    const snippet = createHttpSnippet({
+      operation,
+      selectedServer,
+      exampleBody: exampleBody
         ? {
-            text: JSON.stringify(example, null, 2),
             mimeType: "application/json",
+            text: JSON.stringify(exampleBody, null, 2),
           }
-        : ({} as any),
-      headers: [{ name: "Content-Type", value: "application/json" }],
-      queryString: [],
-      httpVersion: "",
-      cookies: [],
-      headersSize: 0,
-      bodySize: 0,
+        : { mimeType: "application/json" },
     });
 
     return getConverted(snippet, selectedLang);
   }, [
     selectedExample,
     transformedRequestBodyContent,
-    operation.method,
-    operation.path,
+    operation,
     selectedServer,
     selectedLang,
   ]);
@@ -198,14 +145,14 @@ export const Sidecar = ({
   return (
     <aside
       ref={ref}
-      className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4"
+      className="flex flex-col overflow-hidden sticky top-(--scroll-padding) gap-4"
       data-pagefind-ignore="all"
     >
       <SidecarBox.Root>
         <SidecarBox.Head className="flex justify-between items-center flex-nowrap py-2.5 gap-2 text-xs">
           <span className="font-mono break-words leading-6">
             <span className={cn("font-semibold", methodTextColor)}>
-              {operation.method.toLocaleUpperCase()}
+              {operation.method.toUpperCase()}
             </span>
             &nbsp;
             {path}
@@ -223,9 +170,10 @@ export const Sidecar = ({
             <SidecarBox.Body className="p-0">
               <CollapsibleCode>
                 <SyntaxHighlight
+                  embedded
                   language={selectedLang}
                   noBackground
-                  className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+                  className="[--scrollbar-color:gray] rounded-none text-xs max-h-[500px]"
                   code={code!}
                 />
               </CollapsibleCode>

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

@@ -1,5 +1,5 @@
 import { useEffect, useMemo, useState } from "react";
-import { SchemaObject } from "../../oas/parser/index.js";
+import { type SchemaObject } from "../../oas/parser/index.js";
 import { SyntaxHighlight } from "../../ui/SyntaxHighlight.js";
 import { CollapsibleCode } from "./CollapsibleCode.js";
 import type { OperationListItemResult } from "./OperationList.js";
@@ -22,7 +22,13 @@ const formatForDisplay = (value: unknown): string => {
 
 const getLanguage = (mediaType?: string): string => {
   if (!mediaType) return "plain";
+  if (mediaType.endsWith("+json")) return "json";
+  if (mediaType.endsWith("+xml")) return "xml";
+  if (mediaType.endsWith("+yaml")) return "yaml";
+
   const languages: Record<string, string> = {
+    "text/html": "html",
+    "application/x-ndjson": "json",
     "application/json": "json",
     "application/xml": "xml",
     "application/x-yaml": "yaml",
@@ -95,9 +101,10 @@ export const SidecarExamples = ({
         ) : (
           <CollapsibleCode>
             <SyntaxHighlight
+              embedded
               language={language}
               noBackground
-              className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+              className="[--scrollbar-color:gray] rounded-none text-xs max-h-[500px]"
               code={formattedExample}
             />
           </CollapsibleCode>

package/src/lib/plugins/openapi/client/useCreateQuery.ts

@@ -1,12 +1,29 @@
 import { stripIgnoredCharacters } from "graphql";
 import { use } from "react";
 import type { TypedDocumentString } from "../graphql/graphql.js";
+import type { GraphQLClient } from "./GraphQLClient.js";
 import { GraphQLContext } from "./GraphQLContext.js";
 
 type NoExtraProps<T, U extends T = T> = U & {
   [K in Exclude<keyof U, keyof T>]?: never;
 };
 
+type VarArgs<TVariables> =
+  TVariables extends Record<string, never> ? [] : [NoExtraProps<TVariables>];
+
+export const createQuery = <TResult, TVariables>(
+  client: GraphQLClient,
+  query: TypedDocumentString<TResult, TVariables>,
+  ...[variables]: TVariables extends Record<string, never>
+    ? []
+    : [NoExtraProps<TVariables>]
+) => {
+  return {
+    queryFn: () => client.fetch(query, variables),
+    queryKey: [stripIgnoredCharacters(query.toString()), variables],
+  } as const;
+};
+
 export const useCreateQuery = <TResult, TVariables>(
   query: TypedDocumentString<TResult, TVariables>,
   ...[variables]: TVariables extends Record<string, never>
@@ -19,8 +36,10 @@ export const useCreateQuery = <TResult, TVariables>(
     throw new Error("useGraphQL must be used within a GraphQLProvider");
   }
 
-  return {
-    queryFn: () => graphQLClient.fetch(query, variables),
-    queryKey: [stripIgnoredCharacters(query.toString()), variables],
-  } as const;
+  const args =
+    variables === undefined
+      ? ([] as VarArgs<TVariables>)
+      : ([variables] as VarArgs<TVariables>);
+
+  return createQuery(graphQLClient, query, ...args);
 };

package/src/lib/plugins/openapi/components/EnumValues.tsx

@@ -26,7 +26,7 @@ export const EnumValues = ({
       <span className="text-muted-foreground">Enum values: </span>
       {visibleValues.map((value) => (
         <div key={value}>
-          <SelectOnClick className="border rounded px-1 font-mono">
+          <SelectOnClick className="border rounded-sm px-1 font-mono">
             {value}
           </SelectOnClick>
         </div>