zudoku 0.23.4 → 0.23.5

package/lib/zudoku.plugin-openapi.js

@@ -1,6 +1,6 @@
 import "./jsx-runtime-Dx-03ztt.js";
 import "./chunk-D52XG6IA-Dl7HLe6j.js";
-import { o as a } from "./index-C8ubT49C.js";
+import { o as a } from "./index-C_ul-2fb.js";
 import "./utils-B4O1uet5.js";
 import "lucide-react";
 import "./hook-DgGeo5iL.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zudoku",
-  "version": "0.23.4",
+  "version": "0.23.5",
   "type": "module",
   "homepage": "https://zudoku.dev",
   "repository": {

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

@@ -1,6 +1,14 @@
 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 { CategoryHeading } from "../../components/CategoryHeading.js";
 import { Heading } from "../../components/Heading.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.js";
@@ -11,6 +19,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 +107,24 @@ 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 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 +136,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) => (

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

@@ -1,19 +1,55 @@
-import { Outlet } from "react-router";
+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);
+
+  if (!currentVersion) {
+    throw new Error("No version found");
+  }
+
+  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/context.tsx

@@ -1,7 +1,7 @@
 import { createContext, useContext } from "react";
-import { OasPluginConfig } from "./interfaces.js";
+import { 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";
+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,32 @@ 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: () => [
+      {
+        path: basePath + "/: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/util/sanitizeMarkdownForMetatag.tsx

@@ -0,0 +1,32 @@
+export function sanitizeMarkdownForMetatag(
+  description: string,
+  maxLength: number = 160,
+): string {
+  if (!description) {
+    return "";
+  }
+
+  return (
+    description
+      // Replace Markdown links [text](url) with just "text"
+      .replace(/\[([^\]]+)\]\([^)]+\)/g, "$1")
+      // Remove Markdown image syntax: ![alt](url)
+      .replace(/!\[.*?\]\(.*?\)/g, "")
+      // Remove other Markdown syntax (e.g., **bold**, _italic_, `code`)
+      .replace(/[_*`~]/g, "")
+      // Remove headings (# Heading), blockquotes (> Quote), and horizontal rules (--- or ***)
+      .replace(/^(?:>|\s*#+|-{3,}|\*{3,})/gm, "")
+      // Remove any remaining formatting characters
+      .replace(/[|>{}[\]]/g, "")
+      // Collapse multiple spaces and trim the text
+      .replace(/\s+/g, " ")
+      .trim()
+      // Limit to the specified maximum length
+      .substring(0, maxLength)
+      .replace(/&/g, "&")
+      .replace(/</g, "&lt;")
+      .replace(/>/g, "&gt;")
+      .replace(/"/g, "&quot;")
+      .replace(/'/g, "&#039;")
+  );
+}