zudoku 0.37.1 → 0.39.0

package/src/lib/oas/parser/index.ts

@@ -3,11 +3,15 @@ import { OpenAPIV3, type OpenAPIV3_1 } from "openapi-types";
 import { dereference, type JSONSchema } from "./dereference/index.js";
 import { upgradeSchema } from "./upgrade/index.js";
 
-type ReferenceObject = OpenAPIV3_1.ReferenceObject;
-type DeepOmitReference<T> = T extends ReferenceObject
+// Must be an interface (not a type) to allow merging with OpenAPI types with index signatures
+interface WithRef {
+  __$ref?: string;
+}
+
+type DeepOmitReference<T> = T extends OpenAPIV3_1.ReferenceObject
   ? never
   : T extends object
-    ? { [K in keyof T]: DeepOmitReference<T[K]> }
+    ? { [K in keyof T]: DeepOmitReference<T[K]> } & WithRef
     : T;
 
 export type OpenAPIDocument = DeepOmitReference<OpenAPIV3_1.Document>;
@@ -24,25 +28,6 @@ export type ServerObject = DeepOmitReference<OpenAPIV3_1.ServerObject>;
 
 export const HttpMethods = Object.values(OpenAPIV3.HttpMethods);
 
-// class ValidationError extends Error {
-//   constructor(public errors: OutputUnit[]) {
-//     super("Validation error");
-//   }
-// }
-
-// const getValidator = async (openApiVersion: string) => {
-//   if (openApiVersion.startsWith("3.0")) {
-//     const schema = (await import("./schemas/v3.0.json")) as any;
-//     return new Validator(schema, "4");
-//   }
-//   if (openApiVersion.startsWith("3.1")) {
-//     const schema = (await import("./schemas/v3.1.json")) as any;
-//     return new Validator(schema as any, "2020-12");
-//   }
-
-//   throw new Error(`Unsupported OpenAPI version: ${openApiVersion}`);
-// };
-
 const parseSchemaInput = async (
   schemaInput: unknown,
 ): Promise<JSONSchema & { openapi?: string }> => {
@@ -110,13 +95,6 @@ export const validate = async (schemaInput: unknown) => {
     throw new GraphQLError("OpenAPI version is not defined");
   }
 
-  // const validator = await getValidator(schema.openapi);
-  // const result = validator.validate(schema);
-  //
-  // if (!result.valid) {
-  //   throw new ValidationError(result.errors);
-  // }
-
   const dereferenced = await dereference(schema);
 
   return upgradeSchema(dereferenced);

package/src/lib/plugins/api-catalog/index.tsx

@@ -51,9 +51,22 @@ export const apiCatalogPlugin = ({
   items: ApiCatalogItem[];
   filterCatalogItems?: filterCatalogItems;
 }): ZudokuPlugin => {
+  const paths = Object.fromEntries(
+    categories.flatMap((category) =>
+      [undefined, ...category.tags].map((tag) => [
+        joinUrl(navigationId, tag ? getKey(category.label, tag) : undefined),
+        tag,
+      ]),
+    ),
+  );
+
   return {
-    getSidebar: async function Sidebar(path) {
-      if (!matchPath({ path: joinUrl(navigationId), end: false }, path)) {
+    getSidebar: async (currentPath) => {
+      const matches = Object.keys(paths).some((path) =>
+        matchPath(path, currentPath),
+      );
+
+      if (!matches) {
         return [];
       }
 
@@ -61,22 +74,19 @@ export const apiCatalogPlugin = ({
         type: "category" as const,
         label: category.label,
         collapsible: false,
-        items: category.tags.map((tag) => {
-          const tagPath = getKey(category.label, tag);
-          return {
-            type: "doc" as const,
-            id: joinUrl(navigationId, tagPath),
-            label: tag,
-            badge: {
-              label: String(
-                items.filter((api) =>
-                  api.categories.find((c) => c.tags.includes(tag)),
-                ).length,
-              ),
-              color: "outline" as const,
-            },
-          };
-        }),
+        items: category.tags.map((tag) => ({
+          type: "doc" as const,
+          id: joinUrl(navigationId, getKey(category.label, tag)),
+          label: tag,
+          badge: {
+            label: String(
+              items.filter((api) =>
+                api.categories.find((c) => c.tags.includes(tag)),
+              ).length,
+            ),
+            color: "outline" as const,
+          },
+        })),
       }));
 
       sidebar.unshift({
@@ -89,22 +99,17 @@ export const apiCatalogPlugin = ({
       return sidebar;
     },
     getRoutes: () =>
-      categories.flatMap((category) =>
-        [undefined, ...category.tags].map((tag) => ({
-          path: joinUrl(
-            navigationId,
-            tag ? getKey(category.label, tag) : undefined,
-          ),
-          element: (
-            <Catalog
-              label={label}
-              categoryLabel={tag}
-              items={items}
-              filterCatalogItems={filterCatalogItems}
-              categories={categories}
-            />
-          ),
-        })),
-      ),
+      Object.entries(paths).map(([path, tag]) => ({
+        path,
+        element: (
+          <Catalog
+            label={label}
+            categoryLabel={tag}
+            items={items}
+            filterCatalogItems={filterCatalogItems}
+            categories={categories}
+          />
+        ),
+      })),
   };
 };

package/src/lib/plugins/markdown/MdxPage.tsx

@@ -2,17 +2,17 @@ import { useMDXComponents } from "@mdx-js/react";
 import slugify from "@sindresorhus/slugify";
 import { Helmet } from "@zudoku/react-helmet-async";
 import { type PropsWithChildren, useEffect } from "react";
-import { Link, useHref } from "react-router";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
 import { Heading } from "../../components/Heading.js";
 import { ProseClasses } from "../../components/Markdown.js";
+import { Pagination } from "../../components/Pagination.js";
+import { Toc } from "../../components/navigation/Toc.js";
 import {
   useCurrentItem,
   usePrevNext,
 } from "../../components/navigation/utils.js";
 import type { MdxComponentsType } from "../../util/MdxComponents.js";
 import { cn } from "../../util/cn.js";
-import { Toc } from "./Toc.js";
 import { type MarkdownPluginDefaultOptions, type MDXImport } from "./index.js";
 
 declare global {
@@ -51,12 +51,6 @@ export const MdxPage = ({
   }
 >) => {
   const categoryTitle = useCurrentItem()?.categoryLabel;
-  let canonicalUrl = null;
-  const path = useHref("");
-  if (typeof window !== "undefined") {
-    const domain = window.location.origin;
-    canonicalUrl = `${domain}${path}`;
-  }
 
   const title = frontmatter.title;
   const category = frontmatter.category ?? categoryTitle;
@@ -98,7 +92,6 @@ export const MdxPage = ({
       <Helmet>
         <title>{pageTitle}</title>
         {excerpt && <meta name="description" content={excerpt} />}
-        {canonicalUrl && <link rel="canonical" href={canonicalUrl} />}
       </Helmet>
       <div
         className={cn(
@@ -122,40 +115,10 @@ export const MdxPage = ({
         {!hidePager && (
           <>
             <hr />
-            <div className="not-prose flex flex-wrap items-center justify-between gap-2 lg:gap-8">
-              {prev ? (
-                <Link
-                  to={prev.id}
-                  className="flex flex-col items-stretch gap-2 flex-1 min-w-max border rounded px-6 py-4 text-start hover:border-primary/85 transition shadow-sm hover:shadow-md"
-                  title={prev.label}
-                >
-                  <div className="text-sm text-muted-foreground">
-                    ← Previous page
-                  </div>
-                  <div className="text-lg text-primary truncate">
-                    {prev.label}
-                  </div>
-                </Link>
-              ) : (
-                <div className="flex-1" />
-              )}
-              {next ? (
-                <Link
-                  to={next.id}
-                  className="flex flex-col items-stretch gap-2 flex-1 min-w-max border rounded px-6 py-4 text-end hover:border-primary/85 transition shadow-sm hover:shadow-md"
-                  title={next.label}
-                >
-                  <div className="text-sm text-muted-foreground">
-                    Next page →
-                  </div>
-                  <div className="text-lg text-primary truncate">
-                    {next.label}
-                  </div>
-                </Link>
-              ) : (
-                <div className="flex-1" />
-              )}
-            </div>
+            <Pagination
+              prev={prev ? { to: prev.id, label: prev.label } : undefined}
+              next={next ? { to: next.id, label: next.label } : undefined}
+            />
           </>
         )}
       </div>

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

@@ -90,7 +90,7 @@ 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",
+        "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 data-[active=true]:bottom-px",
         className,

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 { useSelectedServer } 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!) {

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

@@ -15,10 +15,10 @@ import {
   SelectTrigger,
   SelectValue,
 } from "zudoku/ui/Select.js";
-import { useSelectedServer } from "../../authentication/state.js";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
 import { Heading } from "../../components/Heading.js";
 import { Markdown, ProseClasses } 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";
@@ -26,6 +26,8 @@ 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 */ `
@@ -121,13 +123,21 @@ const OperationsForTagQuery = graphql(/* GraphQL */ `
       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
+        }
       }
     }
   }
@@ -156,8 +166,6 @@ export const OperationList = ({
   const summary = schema.summary;
   const description = schema.description;
   const navigate = useNavigate();
-  const operations = schema.operations;
-  const tagDescription = schema.tags.find((t) => t.name === tag)?.description;
 
   // 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 });
@@ -170,6 +178,10 @@ export const OperationList = ({
   // Prefetch for Playground
   useApiIdentities();
 
+  if (!schema.tag) return null;
+
+  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
@@ -187,6 +199,16 @@ export const OperationList = ({
     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]"
@@ -194,7 +216,7 @@ export const OperationList = ({
       data-pagefind-meta="section:openapi"
     >
       <Helmet>
-        <title>{[tag, title].filter(Boolean).join(" - ")}</title>
+        <title>{[schema.tag.name, title].filter(Boolean).join(" - ")}</title>
         {metaDescription && (
           <meta name="description" content={metaDescription} />
         )}
@@ -202,7 +224,7 @@ 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}
@@ -210,7 +232,7 @@ export const OperationList = ({
                 registerSidebarAnchor
                 className="mb-0"
               >
-                {tag ?? "Other endpoints"}
+                {schema.tag.name ?? "Other endpoints"}
                 {showVersions && (
                   <span className="text-xl text-muted-foreground ml-1.5">
                     {" "}
@@ -218,6 +240,7 @@ export const OperationList = ({
                   </span>
                 )}
               </Heading>
+              <Endpoint />
             </div>
             <div className="flex flex-col gap-4 sm:items-end">
               {showVersions && (
@@ -240,7 +263,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"
@@ -282,11 +305,8 @@ export const OperationList = ({
         )}
       </div>
       <hr />
-      <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}
@@ -294,6 +314,7 @@ export const OperationList = ({
             operationFragment={fragment}
           />
         ))}
+        <Pagination {...paginationProps} />
       </div>
     </div>
   );

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

@@ -100,13 +100,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>

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

@@ -6,6 +6,7 @@ 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";
 
 const getParameterSchema = (
   parameter: ParameterListItemResult,
@@ -72,6 +73,7 @@ export const ParameterListItem = ({
       ) : (
         paramSchema.enum && <EnumValues values={paramSchema.enum} />
       )}
+      <SchemaExampleAndDefault schema={paramSchema} />
     </li>
   );
 };

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

@@ -0,0 +1,151 @@
+import slugify from "@sindresorhus/slugify";
+import { useSuspenseQuery } from "@tanstack/react-query";
+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, ProseClasses } 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";
+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 ?? [];
+
+  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");
+
+  return (
+    <div
+      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]">
+        <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"
+                registerSidebarAnchor
+                className="mb-0"
+              >
+                Schemas
+                {showVersions && (
+                  <span className="text-xl text-muted-foreground ml-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={cn(
+                  ProseClasses,
+                  "pt-4 max-w-full prose-img:max-w-prose",
+                )}
+              >
+                <Markdown
+                  className="border rounded bg-muted/25 border-border px-2.5 md:px-4"
+                  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
+                registerSidebarAnchor
+                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>
+  );
+}