zudoku 0.0.0-f3f6db5 → 0.0.0-f40ea27

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

@@ -45,11 +45,11 @@ export const CollapsibleCode = ({
         forceMount
         className={cn(
           "relative overflow-hidden group",
-          !open && isOverflowing && "max-h-[--max-height]",
+          !open && isOverflowing && "max-h-(--max-height)",
         )}
       >
         {!open && isOverflowing && (
-          <div className=" absolute inset-0 bg-gradient-to-b from-transparent to-zinc-50/60 dark:to-zinc-950/90 z-10 group-hover:to-transparent"></div>
+          <div className=" absolute inset-0 bg-gradient-to-b from-transparent to-zinc-50/60 dark:to-zinc-950/90 z-10 transition-all group-hover:to-transparent"></div>
         )}
         <div ref={contentRef}>{children}</div>
         {!open && isOverflowing && (
@@ -59,7 +59,7 @@ export const CollapsibleCode = ({
           >
             <div>
               <Button variant="outline" className="hidden group-hover:flex">
-                <UnfoldVerticalIcon size={14} className="mr-1.5" />
+                <UnfoldVerticalIcon size={14} className="me-1.5" />
                 Click to expand
               </Button>
             </div>
@@ -68,12 +68,15 @@ export const CollapsibleCode = ({
       </CollapsibleContent>
       {isOverflowing && (
         <div
-          className={cn("flex justify-center w-full mb-2", !open && "hidden")}
+          className={cn(
+            "flex justify-center w-full py-2 bg-muted/50",
+            !open && "hidden",
+          )}
         >
           <CollapsibleTrigger asChild>
             <Button variant="outline" size="sm">
               Collapse
-              <FoldVerticalIcon size={14} className="ml-1.5" />
+              <FoldVerticalIcon size={14} className="ms-1.5" />
             </Button>
           </CollapsibleTrigger>
         </div>

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

@@ -90,9 +90,9 @@ export const ColorizedParam = ({
       {...{ [DATA_ATTR]: normalizedSlug }}
       className={cn(
         // This may not contain (inline-)flex or (inline-)block otherwise it breaks the browser's full text search
-        "relative rounded transition-all duration-100 rounded-lg",
-        "border border-[--border-color] p-0.5 text-[--param-color] bg-[--background-color]",
-        "data-[active=true]:border-[--param-color] data-[active=true]:shadow data-[active=true]:bottom-px",
+        "relative transition-all duration-100 rounded-lg",
+        "border border-(--border-color) p-0.5 text-(--param-color) bg-(--background-color)",
+        "data-[active=true]:border-(--param-color) data-[active=true]:shadow-sm data-[active=true]:bottom-px",
         className,
       )}
       title={title}

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

@@ -1,13 +1,13 @@
 import { useSuspenseQuery } from "@tanstack/react-query";
 import { CheckIcon, CopyIcon } from "lucide-react";
 import { useState, useTransition } from "react";
-import { useSelectedServerStore } from "../../authentication/state.js";
 import { InlineCode } from "../../components/InlineCode.js";
 import { Button } from "../../ui/Button.js";
 import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
 import { SimpleSelect } from "./SimpleSelect.js";
+import { useSelectedServer } from "./state.js";
 
 const ServersQuery = graphql(/* GraphQL */ `
   query ServersQuery($input: JSON!, $type: SchemaType!) {
@@ -48,20 +48,24 @@ export const Endpoint = () => {
   const query = useCreateQuery(ServersQuery, { input, type });
   const result = useSuspenseQuery(query);
   const [, startTransition] = useTransition();
-  const { selectedServer, setSelectedServer } = useSelectedServerStore();
+  const { selectedServer, setSelectedServer } = useSelectedServer(
+    result.data.schema.servers,
+  );
 
   const { servers } = result.data.schema;
 
   if (servers.length === 0) return null;
 
+  const firstServer = servers.at(0)!;
+
   if (servers.length === 1) {
     return (
       <div className="flex items-center gap-2">
         <span className="font-medium text-sm">Endpoint:</span>
         <InlineCode className="text-xs px-2 py-1.5" selectOnClick>
-          {servers[0]!.url}
+          {firstServer.url}
         </InlineCode>
-        <CopyButton url={servers[0]!.url} />
+        <CopyButton url={firstServer.url} />
       </div>
     );
   }
@@ -73,18 +77,16 @@ export const Endpoint = () => {
       <SimpleSelect
         className="font-mono text-xs bg-border/50 dark:bg-border/70 py-1.5 max-w-[450px] truncate"
         onChange={(e) =>
-          startTransition(() => {
-            setSelectedServer(e.target.value);
-          })
+          startTransition(() => setSelectedServer(e.target.value))
         }
-        value={selectedServer ?? servers.at(0)!.url}
+        value={selectedServer}
         showChevrons={servers.length > 1}
         options={servers.map((server) => ({
           value: server.url,
           label: server.url,
         }))}
       />
-      <CopyButton url={selectedServer ?? servers.at(0)!.url} />
+      <CopyButton url={selectedServer} />
     </div>
   );
 };

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

@@ -0,0 +1,51 @@
+import { useMemo } from "react";
+import { Outlet } 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 { type OasPluginConfig } from "./interfaces.js";
+import { getVersions } from "./util/getRoutes.js";
+
+export const OasProvider = ({
+  basePath,
+  version,
+  config,
+  client,
+}: {
+  basePath: string;
+  version?: string;
+  config: OasPluginConfig;
+  client: GraphQLClient;
+}) => {
+  const value = useMemo(() => {
+    const versions = getVersions(config);
+    const firstVersion = Object.values(config.input).at(0);
+    const input =
+      config.type === "file"
+        ? {
+            type: config.type,
+            input: version ? config.input[version]! : firstVersion!,
+          }
+        : { type: config.type, input: config.input };
+
+    return {
+      config: {
+        ...config,
+        version: version ?? versions.at(0),
+        versions: Object.fromEntries(
+          versions.map((version) => [version, joinPath(basePath, version)]),
+        ),
+        ...input,
+      },
+    };
+  }, [config, basePath, version]);
+
+  return (
+    <OasConfigProvider value={value}>
+      <GraphQLProvider client={client}>
+        <Outlet />
+      </GraphQLProvider>
+    </OasConfigProvider>
+  );
+};

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

@@ -1,7 +1,13 @@
-import { ResultOf } from "@graphql-typed-document-node/core";
-import { useSuspenseQuery } from "@tanstack/react-query";
+import { type ResultOf } from "@graphql-typed-document-node/core";
+import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import { Helmet } from "@zudoku/react-helmet-async";
-import { useNavigate } from "react-router";
+import { ChevronsDownUpIcon, ChevronsUpDownIcon } from "lucide-react";
+import { useNavigate, useParams } from "react-router";
+import {
+  Collapsible,
+  CollapsibleContent,
+  CollapsibleTrigger,
+} from "zudoku/ui/Collapsible.js";
 import {
   Select,
   SelectContent,
@@ -9,17 +15,18 @@ import {
   SelectTrigger,
   SelectValue,
 } from "zudoku/ui/Select.js";
-import { useSelectedServerStore } from "../../authentication/state.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";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
+import { UNTAGGED_PATH } from "./index.js";
+import { useSelectedServer } from "./state.js";
 import { sanitizeMarkdownForMetatag } from "./util/sanitizeMarkdownForMetatag.js";
 
 export const OperationsFragment = graphql(/* GraphQL */ `
@@ -31,6 +38,8 @@ export const OperationsFragment = graphql(/* GraphQL */ `
     operationId
     contentTypes
     path
+    deprecated
+    extensions
     parameters {
       name
       in
@@ -38,6 +47,7 @@ export const OperationsFragment = graphql(/* GraphQL */ `
       required
       schema
       style
+      explode
       examples {
         name
         description
@@ -88,26 +98,45 @@ export const OperationsFragment = graphql(/* GraphQL */ `
 
 export type OperationListItemResult = ResultOf<typeof OperationsFragment>;
 
-const AllOperationsQuery = graphql(/* GraphQL */ `
-  query AllOperations(
+const SchemaWarmupQuery = graphql(/* GraphQL */ `
+  query SchemaWarmup($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      openapi
+    }
+  }
+`);
+
+const OperationsForTagQuery = graphql(/* GraphQL */ `
+  query OperationsForTag(
     $input: JSON!
     $type: SchemaType!
     $tag: String
     $untagged: Boolean
   ) {
     schema(input: $input, type: $type) {
+      servers {
+        url
+      }
       description
       summary
       title
       url
       version
-      tags(name: $tag) {
+      tag(slug: $tag, untagged: $untagged) {
         name
         description
-      }
-      operations(tag: $tag, untagged: $untagged) {
-        slug
-        ...OperationsFragment
+        operations {
+          slug
+          ...OperationsFragment
+        }
+        next {
+          name
+          slug
+        }
+        prev {
+          name
+          slug
+        }
       }
     }
   }
@@ -120,108 +149,177 @@ export const OperationList = ({
   tag?: string;
   untagged?: boolean;
 }) => {
-  const { input, type, versions, version } = useOasConfig();
-  const query = useCreateQuery(AllOperationsQuery, {
+  const { input, type, versions, version, options } = useOasConfig();
+  const { tag: tagFromParams } = useParams<"tag">();
+  const query = useCreateQuery(OperationsForTagQuery, {
     input,
     type,
-    tag,
+    tag: tag ?? tagFromParams,
     untagged,
   });
-  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 {
+    data: { schema },
+  } = result;
+  const { selectedServer } = useSelectedServer(schema.servers);
+  const title = schema.title;
+  const summary = schema.summary;
+  const description = schema.description;
   const navigate = useNavigate();
-  const operations = result.data.schema.operations;
+
+  // This is to warmup (i.e. load the schema in the background) the schema on the client, if the page has been rendered on the server
+  const warmupQuery = useCreateQuery(SchemaWarmupQuery, { input, type });
+  useQuery({
+    ...warmupQuery,
+    enabled: typeof window !== "undefined",
+    notifyOnChangeProps: [],
+  });
+
   // Prefetch for Playground
   useApiIdentities();
 
+  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;
+
   // 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;
+  const metaDescription = tagDescription
+    ? sanitizeMarkdownForMetatag(tagDescription)
+    : summary
+      ? summary
+      : description
+        ? sanitizeMarkdownForMetatag(description)
+        : undefined;
+
+  const hasMultipleVersions = Object.entries(versions).length > 1;
+
+  const showVersions =
+    options?.showVersionSelect === "always" ||
+    (hasMultipleVersions && options?.showVersionSelect !== "hide");
+
+  const paginationProps = {
+    prev: prev?.name ? { to: `../${prev.slug}`, label: prev.name } : undefined,
+    next: next
+      ? {
+          to: `../${next.slug ?? UNTAGGED_PATH}`,
+          label: next.name ?? "Other endpoints",
+        }
+      : undefined,
+  };
 
   return (
-    <div className="pt-[--padding-content-top]">
+    <div
+      className="pt-(--padding-content-top)"
+      data-pagefind-filter="section:openapi"
+      data-pagefind-meta="section:openapi"
+    >
       <Helmet>
-        <title>{title}</title>
+        <title>{[schema.tag.name, title].filter(Boolean).join(" - ")}</title>
         {metaDescription && (
           <meta name="description" content={metaDescription} />
         )}
       </Helmet>
-      <div
-        className={cn(ProseClasses, "mb-16 max-w-full prose-img:max-w-prose")}
-      >
-        <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}
+      <div className="mb-8">
+        <Collapsible className="w-full">
+          <div className="flex flex-col gap-y-4 sm:flex-row justify-around items-start sm:items-end">
+            <div className="flex flex-col flex-1 gap-2">
+              <CategoryHeading>{title}</CategoryHeading>
+              <Heading
+                level={1}
+                id="description"
+                registerNavigationAnchor
+                className="mb-0"
               >
-                <SelectTrigger className="w-[180px]">
-                  <SelectValue placeholder="Select version" />
-                </SelectTrigger>
-                <SelectContent>
-                  {Object.entries(versions).map(([version]) => (
-                    <SelectItem key={version} value={version}>
-                      {version}
-                    </SelectItem>
-                  ))}
-                </SelectContent>
-              </Select>
-            )}
+                {schema.tag.name ?? "Other endpoints"}
+                {showVersions && (
+                  <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 && (
+                <Select
+                  onValueChange={(version) => navigate(versions[version]!)}
+                  defaultValue={version}
+                  disabled={!hasMultipleVersions}
+                >
+                  <SelectTrigger className="w-[180px]">
+                    <SelectValue placeholder="Select version" />
+                  </SelectTrigger>
+                  <SelectContent>
+                    {Object.entries(versions).map(([version]) => (
+                      <SelectItem key={version} value={version}>
+                        {version}
+                      </SelectItem>
+                    ))}
+                  </SelectContent>
+                </Select>
+              )}
+              {schema.description && (
+                <CollapsibleTrigger className="flex items-center gap-1 text-sm font-medium text-muted-foreground group">
+                  <span>API information</span>
+
+                  <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>
           </div>
-        </div>
-        <Markdown content={result.data.schema.description ?? ""} />
+          {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={schema.description}
+                />
+              </div>
+            </CollapsibleContent>
+          )}
+        </Collapsible>
+        {tagDescription && (
+          <Markdown
+            className="my-4 max-w-full prose-img:max-w-prose"
+            content={tagDescription}
+          />
+        )}
       </div>
       <hr />
-      <div className="my-4 flex items-center justify-end gap-4">
-        <Endpoint />
-      </div>
-      {operations.map((fragment) => (
-        <OperationListItem
-          serverUrl={selectedServer ?? result.data.schema.url ?? ""}
-          key={fragment.slug}
-          operationFragment={fragment}
-        />
-      ))}
-      {/* {result.data.schema.tags
-        .filter((tag) => tag.operations.length > 0)
-        .map((tag) => (
-          // 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
-                className={`${ProseClasses} max-w-full prose-img:max-w-prose w-full mt-2 mb-12`}
-                content={tag.description}
-              />
-            )}
-            <div className="operation mb-12">
-              <StaggeredRender>
-                {tag.operations.map((fragment) => (
-                  <OperationListItem
-                    serverUrl={selectedServer ?? result.data.schema.url}
-                    key={fragment.slug}
-                    operationFragment={fragment}
-                  />
-                ))}
-              </StaggeredRender>
-            </div>
+      {/* px, -mx is so that `content-visibility` doesn't cut off overflown heading anchor links '#' */}
+      <div className="px-6 mt-6 -mx-6 [content-visibility:auto]">
+        {operations.map((fragment) => (
+          <div key={fragment.slug}>
+            <OperationListItem
+              serverUrl={selectedServer}
+              operationFragment={fragment}
+            />
+            <hr className="my-10" />
           </div>
-        ))} */}
+        ))}
+        <Pagination className="mb-4" {...paginationProps} />
+      </div>
     </div>
   );
 };