zudoku 0.0.0-e88b02e → 0.0.0-e8a949d

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

@@ -1,3 +1,4 @@
+import type { AuthState } from "../../authentication/state.js";
 import type { ZudokuPlugin } from "../../core/plugins.js";
 import { Catalog } from "./Catalog.js";
 
@@ -18,18 +19,30 @@ export type ApiCatalogPluginOptions = {
   label: string;
   categories?: CatalogCategory[];
   items: ApiCatalogItem[];
+  filterCatalogItems?: filterCatalogItems;
 };
 
+export type CatalogContext<ProviderData = unknown> = {
+  auth: AuthState<ProviderData>;
+};
+
+export type filterCatalogItems<ProviderData = unknown> = (
+  items: ApiCatalogItem[],
+  { auth }: CatalogContext<ProviderData>,
+) => ApiCatalogItem[];
+
 export const apiCatalogPlugin = ({
   navigationId,
   items,
   label,
   categories,
+  filterCatalogItems,
 }: {
   navigationId: string;
   label: string;
   categories?: CatalogCategory[];
   items: ApiCatalogItem[];
+  filterCatalogItems?: filterCatalogItems;
 }): ZudokuPlugin => {
   return {
     getRoutes: () => {
@@ -40,6 +53,7 @@ export const apiCatalogPlugin = ({
             <Catalog
               label={label}
               items={items}
+              filterCatalogItems={filterCatalogItems}
               categories={categories ?? []}
             />
           ),

package/src/lib/plugins/api-keys/CreateApiKey.tsx

@@ -1,6 +1,6 @@
 import { useMutation } from "@tanstack/react-query";
 import { useForm } from "react-hook-form";
-import { Link, useNavigate } from "react-router-dom";
+import { Link, useNavigate } from "react-router";
 import {
   Select,
   SelectContent,

package/src/lib/plugins/api-keys/ProtectedRoute.tsx

@@ -1,4 +1,4 @@
-import { Outlet } from "react-router-dom";
+import { Outlet } from "react-router";
 import { useAuth } from "../../authentication/hook.js";
 import { DeveloperHint } from "../../components/DeveloperHint.js";
 import { Button } from "../../ui/Button.js";

package/src/lib/plugins/api-keys/SettingsApiKeys.tsx

@@ -12,7 +12,7 @@ import {
   TrashIcon,
 } from "lucide-react";
 import { useState } from "react";
-import { Link } from "react-router-dom";
+import { Link } from "react-router";
 import { useZudoku } from "../../components/context/ZudokuContext.js";
 import { Slotlet } from "../../components/SlotletProvider.js";
 import { Button } from "../../ui/Button.js";

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

@@ -1,5 +1,5 @@
 import { FileKey2Icon } from "lucide-react";
-import { type RouteObject } from "react-router-dom";
+import { type RouteObject } from "react-router";
 import { ZudokuContext } from "../../core/ZudokuContext.js";
 import {
   type ApiIdentityPlugin,

package/src/lib/plugins/custom-pages/index.tsx

@@ -1,5 +1,5 @@
 import { type ComponentType, type ReactNode } from "react";
-import type { RouteObject } from "react-router-dom";
+import type { RouteObject } from "react-router";
 import { type ExposedComponentProps } from "../../components/SlotletProvider.js";
 import type { NavigationPlugin, ZudokuPlugin } from "../../core/plugins.js";
 import { CustomPage } from "./CustomPage.js";

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

@@ -2,7 +2,7 @@ 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 } from "react-router-dom";
+import { Link } from "react-router";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
 import { Heading } from "../../components/Heading.js";
 import { ProseClasses } from "../../components/Markdown.js";

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

@@ -1,6 +1,7 @@
 import type { Toc } from "@stefanprobst/rehype-extract-toc";
 import type { MDXProps } from "mdx/types.js";
-import { RouteObject } from "react-router-dom";
+import { type JSX } from "react";
+import { RouteObject } from "react-router";
 import { ZudokuDocsConfig } from "../../../config/validators/common.js";
 import type { ZudokuPlugin } from "../../core/plugins.js";
 import { DocResolver } from "./resolver.js";

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

@@ -1,6 +1,15 @@
 import { ResultOf } from "@graphql-typed-document-node/core";
 import { useSuspenseQuery } from "@tanstack/react-query";
 import { Helmet } from "@zudoku/react-helmet-async";
+import { useNavigate } from "react-router";
+import {
+  Select,
+  SelectContent,
+  SelectItem,
+  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";
@@ -11,6 +20,7 @@ import StaggeredRender from "./StaggeredRender.js";
 import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
+import { sanitizeMarkdownForMetatag } from "./util/sanitizeMarkdownForMetatag.js";
 
 export const OperationsFragment = graphql(/* GraphQL */ `
   fragment OperationsFragment on OperationItem {
@@ -98,63 +108,25 @@ const AllOperationsQuery = graphql(/* GraphQL */ `
   }
 `);
 
-/**
- * @description Clean up a commonmark formatted description for use in the meta
- * description.
- */
-function cleanDescription(
-  description: string,
-  maxLength: number = 160,
-): string {
-  if (!description) {
-    return "";
-  }
-
-  // Replace Markdown links [text](url) with just "text"
-  description = description.replace(/\[([^\]]+)\]\([^)]+\)/g, "$1");
-
-  // Remove Markdown image syntax: ![alt](url)
-  description = description.replace(/!\[.*?\]\(.*?\)/g, "");
-
-  // Remove other Markdown syntax (e.g., **bold**, _italic_, `code`)
-  description = description.replace(/[_*`~]/g, "");
-
-  // Remove headings (# Heading), blockquotes (> Quote), and horizontal rules (--- or ***)
-  description = description.replace(/^(?:>|\s*#+|-{3,}|\*{3,})/gm, "");
-
-  // Remove any remaining formatting characters
-  description = description.replace(/[|>{}[\]]/g, "");
-
-  // Collapse multiple spaces and trim the text
-  description = description.replace(/\s+/g, " ").trim();
-
-  // Limit to the specified maximum length
-  description = description.substring(0, maxLength);
-
-  // Escape for HTML safety
-  return description
-    .replace(/&/g, "&")
-    .replace(/</g, "&lt;")
-    .replace(/>/g, "&gt;")
-    .replace(/"/g, "&quot;")
-    .replace(/'/g, "&#039;");
-}
-
 export const OperationList = () => {
-  const { input, type } = useOasConfig();
+  const { input, type, versions, version } = useOasConfig();
   const query = useCreateQuery(AllOperationsQuery, { input, type });
+  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 navigate = useNavigate();
+
   // 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
-      ? cleanDescription(description)
+      ? sanitizeMarkdownForMetatag(description)
       : undefined;
+
   return (
     <div className="pt-[--padding-content-top]">
       <Helmet>
@@ -166,17 +138,39 @@ export const OperationList = () => {
       <div
         className={cn(ProseClasses, "mb-16 max-w-full prose-img:max-w-prose")}
       >
-        <CategoryHeading>Overview</CategoryHeading>
-        <Heading level={1} id="description" registerSidebarAnchor>
-          {title}
-        </Heading>
+        <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}
+              >
+                <SelectTrigger className="w-[180px]">
+                  <SelectValue placeholder="Select version" />
+                </SelectTrigger>
+                <SelectContent>
+                  {Object.entries(versions).map(([version]) => (
+                    <SelectItem key={version} value={version}>
+                      {version}
+                    </SelectItem>
+                  ))}
+                </SelectContent>
+              </Select>
+            )}
+          </div>
+        </div>
         <Markdown content={result.data.schema.description ?? ""} />
       </div>
       <hr />
-      <div className="my-4 flex justify-end">
+      <div className="my-4 flex items-center justify-end gap-4">
         <Endpoint />
       </div>
-
       {result.data.schema.tags
         .filter((tag) => tag.operations.length > 0)
         .map((tag) => (
@@ -193,6 +187,7 @@ export const OperationList = () => {
               <StaggeredRender>
                 {tag.operations.map((fragment) => (
                   <OperationListItem
+                    serverUrl={selectedServer ?? result.data.schema.url}
                     key={fragment.slug}
                     operationFragment={fragment}
                   />

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

@@ -1,4 +1,4 @@
-import { useState } from "react";
+import { useRef, useState } from "react";
 import { Heading } from "../../components/Heading.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.js";
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../ui/Tabs.js";
@@ -9,20 +9,24 @@ import { ParameterList } from "./ParameterList.js";
 import { Sidecar } from "./Sidecar.js";
 import { FragmentType, useFragment } from "./graphql/index.js";
 import { SchemaView } from "./schema/SchemaView.js";
+import { methodForColor } from "./util/methodToColor.js";
 
 export const PARAM_GROUPS = ["path", "query", "header", "cookie"] as const;
 export type ParameterGroup = (typeof PARAM_GROUPS)[number];
 
 export const OperationListItem = ({
   operationFragment,
+  serverUrl,
 }: {
   operationFragment: FragmentType<typeof OperationsFragment>;
+  serverUrl?: string;
 }) => {
   const operation = useFragment(OperationsFragment, operationFragment);
   const groupedParameters = groupBy(
     operation.parameters ?? [],
     (param) => param.in,
   );
+  const parentRef = useRef<HTMLDivElement>(null);
 
   const first = operation.responses.at(0);
   const [selectedResponse, setSelectedResponse] = useState(first?.statusCode);
@@ -30,12 +34,37 @@ export const OperationListItem = ({
   return (
     <div
       key={operation.operationId}
-      className="grid grid-cols-1 lg:grid-cols-[4fr_3fr] gap-8 items-start border-b-2 mb-16 pb-16"
+      className="grid grid-cols-1 lg:grid-cols-[minmax(0,4fr)_minmax(0,3fr)] gap-8 items-start border-b-2 mb-16 pb-16"
     >
       <div className="flex flex-col gap-4">
         <Heading level={2} id={operation.slug} registerSidebarAnchor>
           {operation.summary}
         </Heading>
+        <div className="text-sm flex gap-2 font-mono">
+          <span className={methodForColor(operation.method)}>
+            {operation.method.toUpperCase()}
+          </span>
+          <div
+            ref={parentRef}
+            className="max-w-full truncate flex cursor-pointer"
+            onClick={() => {
+              if (parentRef.current) {
+                const range = document.createRange();
+                range.selectNodeContents(parentRef.current);
+                const selection = window.getSelection();
+                selection?.removeAllRanges();
+                selection?.addRange(range);
+              }
+            }}
+          >
+            <div className="text-neutral-400 dark:text-neutral-500 truncate">
+              {serverUrl}
+            </div>
+            <div className="text-neutral-900 dark:text-neutral-200">
+              {operation.path}
+            </div>
+          </div>
+        </div>
         {operation.description && (
           <Markdown
             className={`${ProseClasses} max-w-full prose-img:max-w-prose`}

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

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

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

@@ -1,9 +1,8 @@
 import { useSuspenseQuery } from "@tanstack/react-query";
 import { HTTPSnippet } from "@zudoku/httpsnippet";
 import { Fragment, useMemo, useTransition } from "react";
-import { useSearchParams } from "react-router-dom";
+import { useSearchParams } from "react-router";
 import { useSelectedServerStore } from "../../authentication/state.js";
-import { TextColorMap } from "../../components/navigation/SidebarBadge.js";
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import type { SchemaObject } from "../../oas/parser/index.js";
 import { cn } from "../../util/cn.js";
@@ -20,6 +19,7 @@ import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { SimpleSelect } from "./SimpleSelect.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
+import { methodForColor } from "./util/methodToColor.js";
 
 const getConverted = (snippet: HTTPSnippet, option: string) => {
   let converted;
@@ -76,17 +76,6 @@ export const GetServerQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const methodToColor = {
-  get: TextColorMap.green,
-  post: TextColorMap.blue,
-  put: TextColorMap.yellow,
-  delete: TextColorMap.red,
-  patch: TextColorMap.purple,
-  options: TextColorMap.indigo,
-  head: TextColorMap.gray,
-  trace: TextColorMap.gray,
-};
-
 const EXAMPLE_LANGUAGES = [
   { value: "shell", label: "cURL" },
   { value: "js", label: "JavaScript" },
@@ -114,10 +103,7 @@ export const Sidecar = ({
   const query = useCreateQuery(GetServerQuery, { input, type });
   const result = useSuspenseQuery(query);
 
-  const methodTextColor =
-    methodToColor[
-      operation.method.toLocaleLowerCase() as keyof typeof methodToColor
-    ] ?? TextColorMap.gray;
+  const methodTextColor = methodForColor(operation.method);
 
   const [searchParams, setSearchParams] = useSearchParams();
   const [, startTransition] = useTransition();

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

@@ -12,7 +12,19 @@ export const useCreateQuery = <TResult, TVariables>(
     throw new Error("useGraphQL must be used within a GraphQLProvider");
   }
 
-  const hash = useMemo(() => hashit(variables[0] ?? {}), [variables]);
+  const hash = useMemo(() => {
+    if (
+      typeof variables[0] === "object" &&
+      variables[0] != null &&
+      "input" in variables[0] &&
+      typeof variables[0].input === "function"
+    ) {
+      // This is a pre-hashed name to ensure that the query key is consistent across server and client
+      return variables[0].input.name;
+    }
+
+    return hashit(variables[0] ?? {});
+  }, [variables]);
 
   return {
     queryFn: () => graphQLClient.fetch(query, ...variables),

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

@@ -1,7 +1,7 @@
 import { createContext, useContext } from "react";
-import { OasPluginConfig } from "./interfaces.js";
+import { type OasPluginContext } from "./interfaces.js";
 
-const OasContext = createContext<{ config: OasPluginConfig } | undefined>(
+const OasContext = createContext<{ config: OasPluginContext } | undefined>(
   undefined,
 );
 

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

@@ -1,4 +1,4 @@
-import { matchPath, type RouteObject } from "react-router-dom";
+import { matchPath } from "react-router";
 import { type ZudokuPlugin } from "../../core/plugins.js";
 import { graphql } from "./graphql/index.js";
 
@@ -52,6 +52,8 @@ export type OpenApiPluginOptions = OasPluginConfig & InternalOasPluginConfig;
 export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
   const basePath = joinPath(config.navigationId ?? "/reference");
 
+  const versions = config.type === "file" ? Object.keys(config.input) : [];
+
   const client = new GraphQLClient(config);
 
   return {
@@ -125,9 +127,14 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
       }
 
       try {
+        const version =
+          versions.find((v) => path === joinPath(basePath, v)) ??
+          Object.keys(config.input).at(0);
+
         const data = await client.fetch(GetCategoriesQuery, {
           type: config.type,
-          input: config.input,
+          input: config.type === "file" ? config.input[version!] : config.input,
+          version,
         });
 
         const categories = data.schema.tags
@@ -159,32 +166,34 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
         return [];
       }
     },
-    getRoutes: () =>
-      [
-        {
-          async lazy() {
-            const { OpenApiRoute } = await import("./Route.js");
-            return {
-              element: <OpenApiRoute client={client} config={config} />,
-            };
-          },
-          children: [
-            {
-              path: basePath,
-              children: [
-                {
-                  index: true,
-                  async lazy() {
-                    const { OperationList } = await import(
-                      "./OperationList.js"
-                    );
-                    return { element: <OperationList /> };
-                  },
-                },
-              ],
-            },
-          ],
+    getRoutes: () => {
+      const versionsInPath = [null, ...versions];
+
+      return versionsInPath.map((version) => ({
+        path: basePath + (version ? `/${version}` : ""),
+        async lazy() {
+          const { OpenApiRoute } = await import("./Route.js");
+          return {
+            element: (
+              <OpenApiRoute
+                basePath={basePath}
+                versions={versions}
+                client={client}
+                config={config}
+              />
+            ),
+          };
         },
-      ] satisfies RouteObject[],
+        children: [
+          {
+            index: true,
+            async lazy() {
+              const { OperationList } = await import("./OperationList.js");
+              return { element: <OperationList /> };
+            },
+          },
+        ],
+      }));
+    },
   };
 };

package/src/lib/plugins/openapi/interfaces.ts

@@ -1,6 +1,19 @@
 type OasSource =
   | { type: "url"; input: string }
-  | { type: "file"; input: () => Promise<unknown> }
+  | {
+      type: "file";
+      input: {
+        [version: string]: () => Promise<unknown>;
+      };
+    }
+  | { type: "raw"; input: string };
+
+export type ContextOasSource =
+  | { type: "url"; input: string }
+  | {
+      type: "file";
+      input: () => Promise<unknown>;
+    }
   | { type: "raw"; input: string };
 
 export type OasPluginConfig = {
@@ -8,3 +21,11 @@ export type OasPluginConfig = {
   navigationId?: string;
   skipPreload?: boolean;
 } & OasSource;
+
+export type OasPluginContext = {
+  server?: string;
+  navigationId?: string;
+  skipPreload?: boolean;
+  version?: string;
+  versions: Record<string, string>;
+} & ContextOasSource;

package/src/lib/plugins/openapi/schema/SchemaComponents.tsx

@@ -1,7 +1,8 @@
 import * as Collapsible from "@radix-ui/react-collapsible";
-import { ListPlusIcon } from "lucide-react";
+import { ListPlusIcon, RefreshCcwDotIcon } from "lucide-react";
 import { useCallback, useState } from "react";
 import { Markdown, ProseClasses } from "../../../components/Markdown.js";
+import { CIRCULAR_REF } from "../../../oas/parser/dereference/index.js";
 import type { SchemaObject } from "../../../oas/parser/index.js";
 import { Button } from "../../../ui/Button.js";
 import { cn } from "../../../util/cn.js";
@@ -39,6 +40,16 @@ export const SchemaLogicalGroup = ({
   }
 };
 
+const isCircularRef = (schema: unknown): schema is string =>
+  schema === CIRCULAR_REF;
+
+const RecursiveIndicator = () => (
+  <div className="flex items-center gap-2 italic text-sm text-muted-foreground font-mono bg-muted px-2 py-0.5 rounded-md">
+    <RefreshCcwDotIcon size={16} />
+    <span>recursive</span>
+  </div>
+);
+
 export const SchemaPropertyItem = ({
   name,
   schema,
@@ -56,6 +67,19 @@ export const SchemaPropertyItem = ({
 }) => {
   const [isOpen, setIsOpen] = useState(defaultOpen);
 
+  if (isCircularRef(schema)) {
+    return (
+      <li className="p-4 bg-border/20 hover:bg-border/30">
+        <div className="flex flex-col gap-1 justify-between text-sm">
+          <div className="flex gap-2 items-center">
+            <code>{name}</code>
+            <RecursiveIndicator />
+          </div>
+        </div>
+      </li>
+    );
+  }
+
   return (
     <li className="p-4 bg-border/20 hover:bg-border/30">
       <div className="flex flex-col gap-1 justify-between text-sm">

package/src/lib/plugins/openapi/util/methodToColor.ts

@@ -0,0 +1,27 @@
+export const TextColorMap = {
+  green: "text-green-600",
+  blue: "text-sky-600",
+  yellow: "text-yellow-600",
+  red: "text-red-600",
+  purple: "text-purple-600",
+  indigo: "text-indigo-600",
+  gray: "text-gray-600",
+};
+
+export const methodToColor = {
+  get: TextColorMap.green,
+  post: TextColorMap.blue,
+  put: TextColorMap.yellow,
+  delete: TextColorMap.red,
+  patch: TextColorMap.purple,
+  options: TextColorMap.indigo,
+  head: TextColorMap.gray,
+  trace: TextColorMap.gray,
+};
+
+export const methodForColor = (method: string) => {
+  return (
+    methodToColor[method.toLocaleLowerCase() as keyof typeof methodToColor] ??
+    TextColorMap.gray
+  );
+};