zudoku 0.0.0-f06d326 → 0.0.0-f0b4321

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

@@ -2,7 +2,7 @@ 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 { useNavigate, useParams } from "react-router";
 import {
   Collapsible,
   CollapsibleContent,
@@ -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";
@@ -151,10 +150,11 @@ export const OperationList = ({
   untagged?: boolean;
 }) => {
   const { input, type, versions, version, options } = useOasConfig();
+  const { tag: tagFromParams } = useParams<"tag">();
   const query = useCreateQuery(OperationsForTagQuery, {
     input,
     type,
-    tag,
+    tag: tag ?? tagFromParams,
     untagged,
   });
   const result = useSuspenseQuery(query);
@@ -178,7 +178,18 @@ export const OperationList = ({
   // Prefetch for Playground
   useApiIdentities();
 
-  if (!schema.tag) return null;
+  if (!schema.tag) {
+    return (
+      <div className="flex flex-col h-full items-center justify-center text-center">
+        <div className="text-muted-foreground font-medium">
+          No operations found
+        </div>
+        <div className="mt-2 text-sm text-muted-foreground">
+          This API doesn't have any operations defined yet.
+        </div>
+      </div>
+    );
+  }
 
   const { operations, next, prev, description: tagDescription } = schema.tag;
 
@@ -209,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} />
         )}
@@ -224,22 +237,23 @@ export const OperationList = ({
       <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-1">
+            <div className="flex flex-col flex-1 gap-2">
               <CategoryHeading>{title}</CategoryHeading>
               <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>
                 )}
               </Heading>
+              <Endpoint />
             </div>
             <div className="flex flex-col gap-4 sm:items-end">
               {showVersions && (
@@ -262,7 +276,7 @@ export const OperationList = ({
               )}
               {schema.description && (
                 <CollapsibleTrigger className="flex items-center gap-1 text-sm font-medium text-muted-foreground group">
-                  <span>Schema description</span>
+                  <span>API information</span>
 
                   <ChevronsUpDownIcon
                     className="group-data-[state=open]:hidden translate-y-px"
@@ -278,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>
@@ -293,31 +302,25 @@ 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 />
-      <Pagination {...paginationProps} />
-      <div className="my-4 flex items-center justify-end gap-4">
-        <Endpoint />
-      </div>
       {/* px, -mx is so that `content-visibility` doesn't cut off overflown heading anchor links '#' */}
-      <div className="px-6 -mx-6 [content-visibility:auto]">
+      <div className="px-6 mt-6 -mx-6 [content-visibility:auto]">
         {operations.map((fragment) => (
-          <OperationListItem
-            serverUrl={selectedServer}
-            key={fragment.slug}
-            operationFragment={fragment}
-          />
+          <div key={fragment.slug}>
+            <OperationListItem
+              serverUrl={selectedServer}
+              operationFragment={fragment}
+            />
+            <hr className="my-10" />
+          </div>
         ))}
-        <Pagination {...paginationProps} />
+        <Pagination className="mb-4" {...paginationProps} />
       </div>
     </div>
   );

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,12 +31,13 @@ export const OperationListItem = ({
     operation.parameters ?? [],
     (param) => param.in,
   );
+  const { options } = useOasConfig();
 
   const first = operation.responses.at(0);
   const [selectedResponse, setSelectedResponse] = useState(first?.statusCode);
 
   return (
-    <div className="border-b-2 mb-16 pb-16">
+    <div>
       {operation.deprecated && (
         <Badge variant="muted" className="text-xs mb-4">
           deprecated
@@ -51,8 +53,8 @@ export const OperationListItem = ({
         <Heading
           level={2}
           id={operation.slug}
-          registerSidebarAnchor
-          className="break-all"
+          registerNavigationAnchor
+          className="break-all col-span-full"
         >
           {operation.summary}
         </Heading>
@@ -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}
             />
           )}
@@ -100,13 +107,18 @@ export const OperationListItem = ({
             <div className="mt-4 flex flex-col gap-4">
               <Heading
                 level={3}
-                className="capitalize"
+                className="capitalize flex items-center gap-2"
                 id={`${operation.slug}/request-body`}
               >
                 {operation.summary && (
                   <VisuallyHidden>{operation.summary} &rsaquo; </VisuallyHidden>
                 )}
-                Request Body
+                Request Body{" "}
+                {operation.requestBody?.required === false ? (
+                  <Badge variant="muted">optional</Badge>
+                ) : (
+                  ""
+                )}
               </Heading>
               <SchemaView schema={schema} />
             </div>
@@ -123,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,12 +30,15 @@ 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,
 
     schema.enum && "enum",
+    schema.const && "const",
     schema.format,
     schema.minimum && `min: ${schema.minimum}`,
     schema.maximum && `max: ${schema.maximum}`,

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

@@ -1,11 +1,18 @@
+import * as Collapsible from "@radix-ui/react-collapsible";
+import { MinusIcon, PlusIcon } from "lucide-react";
+import { useState } from "react";
 import { Markdown } from "../../components/Markdown.js";
 import { type SchemaObject } from "../../oas/graphql/index.js";
+import { Button } from "../../ui/Button.js";
 import { ColorizedParam } from "./ColorizedParam.js";
 import type { OperationListItemResult } from "./OperationList.js";
 import type { ParameterGroup } from "./OperationListItem.js";
 import { ParamInfos } from "./ParamInfos.js";
 import { EnumValues } from "./components/EnumValues.js";
 import { SelectOnClick } from "./components/SelectOnClick.js";
+import { SchemaExampleAndDefault } from "./schema/SchemaExampleAndDefault.js";
+import { SchemaView } from "./schema/SchemaView.js";
+import { isArrayType } from "./schema/utils.js";
 
 const getParameterSchema = (
   parameter: ParameterListItemResult,
@@ -32,6 +39,7 @@ export const ParameterListItem = ({
   id: string;
 }) => {
   const paramSchema = getParameterSchema(parameter);
+  const [isOpen, setIsOpen] = useState(false);
 
   return (
     <li className="p-4 bg-border/20 text-sm flex flex-col gap-1.5">
@@ -64,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"
         />
       )}
@@ -72,6 +86,30 @@ export const ParameterListItem = ({
       ) : (
         paramSchema.enum && <EnumValues values={paramSchema.enum} />
       )}
+      <SchemaExampleAndDefault schema={paramSchema} />
+      {(paramSchema.type === "object" || isArrayType(paramSchema)) && (
+        <Collapsible.Root
+          defaultOpen={false}
+          onOpenChange={setIsOpen}
+          open={isOpen}
+        >
+          <Collapsible.Trigger asChild>
+            <Button variant="expand" size="sm">
+              {isOpen ? <MinusIcon size={12} /> : <PlusIcon size={12} />}
+              {isOpen ? "Hide properties" : "Show properties"}
+            </Button>
+          </Collapsible.Trigger>
+          <Collapsible.Content>
+            <div className="mt-2">
+              <SchemaView
+                schema={
+                  "items" in paramSchema ? paramSchema.items : paramSchema
+                }
+              />
+            </div>
+          </Collapsible.Content>
+        </Collapsible.Root>
+      )}
     </li>
   );
 };

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>
                 )}
@@ -84,7 +95,7 @@ export function SchemaList() {
             </div>
             {data.schema.description && (
               <CollapsibleTrigger className="flex items-center gap-1 text-sm font-medium text-muted-foreground group">
-                <span>Schema description</span>
+                <span>API information</span>
                 <ChevronsUpDownIcon
                   className="group-data-[state=open]:hidden translate-y-px"
                   size={14}
@@ -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)}