zudoku 0.27.0 → 0.28.1

package/lib/zudoku.plugin-api-catalog.js

@@ -1,10 +1,10 @@
 import { j as e } from "./jsx-runtime-Bdg6XQ1m.js";
-import { s as j } from "./index-LNp6rxyU.js";
-import { u as b } from "./ZudokuContext-8jts0fF3.js";
+import { s as j } from "./index-CjJS0l4l.js";
+import { u as b } from "./ZudokuContext-BTUJPpQl.js";
 import { b as y } from "./chunk-SYFQ2XB5-BPvC-soB.js";
 import { Head as v, Link as N } from "./zudoku.components.js";
 import { u as w } from "./state-mM7uaXTW.js";
-import { M as C } from "./Markdown-B8o9Qz4q.js";
+import { M as C } from "./Markdown-Cyrx_JrO.js";
 import { c as h } from "./cn-qaFjX9_3.js";
 const f = (r, n) => j(`${r}-${n}`), k = ({
   items: r,

package/lib/zudoku.plugin-api-keys.js

@@ -1,14 +1,14 @@
 import { j as e } from "./jsx-runtime-Bdg6XQ1m.js";
 import { RotateCwIcon as g, TrashIcon as f, EyeOffIcon as j, EyeIcon as v, CheckIcon as w, CopyIcon as b, FileKey2Icon as K } from "lucide-react";
-import { D as k, S as m, R as N } from "./SlotletProvider-CtIp8rP3.js";
+import { D as k, S as m, R as N } from "./SlotletProvider-mQiPDQIH.js";
 import { i as c } from "./invariant-Caa8-XvF.js";
-import { u as d, S as I, a as S, b as A, c as C, d as E, e as x } from "./Select-B7UXR0SB.js";
+import { u as d, S as I, a as S, b as A, c as C, d as E, e as x } from "./Select-CnCZ4WhS.js";
 import { a as P } from "./index.esm-CrSoEshU.js";
 import { a as D, L as u, O as R } from "./chunk-SYFQ2XB5-BPvC-soB.js";
-import { a as y, e as q, u as O } from "./ZudokuContext-8jts0fF3.js";
+import { a as y, e as q, u as O } from "./ZudokuContext-BTUJPpQl.js";
 import { Button as l } from "./ui/Button.js";
 import { Input as z } from "./ui/Input.js";
-import { u as F } from "./hook-BG02esyv.js";
+import { u as F } from "./hook-FT3SJLe_.js";
 import { useState as p } from "react";
 import { c as T } from "./cn-qaFjX9_3.js";
 const L = ({ service: t }) => {

package/lib/zudoku.plugin-custom-pages.js

@@ -1,6 +1,6 @@
 import { j as o } from "./jsx-runtime-Bdg6XQ1m.js";
 import a from "react";
-import { P as n } from "./Markdown-B8o9Qz4q.js";
+import { P as n } from "./Markdown-Cyrx_JrO.js";
 import { c } from "./cn-qaFjX9_3.js";
 import { u as p } from "./useExposedProps-BLKFBylA.js";
 const u = ({

package/lib/zudoku.plugin-markdown.js

@@ -74,7 +74,7 @@ const C = (n) => ({
         const h = {
           path: r,
           lazy: async () => {
-            const { MdxPage: l } = await import("./MdxPage-BxRt3Ly7.js"), { default: p, ...g } = await a();
+            const { MdxPage: l } = await import("./MdxPage-BuG8Tuwc.js"), { default: p, ...g } = await a();
             return {
               element: /* @__PURE__ */ P.jsx(
                 l,

package/lib/zudoku.plugin-openapi.js

@@ -1,11 +1,12 @@
 import "./jsx-runtime-Bdg6XQ1m.js";
-import "./chunk-SYFQ2XB5-BPvC-soB.js";
-import { o as a } from "./index-DmqsUPcm.js";
+import "./index-CjJS0l4l.js";
 import "lucide-react";
-import "./hook-BG02esyv.js";
+import "./chunk-SYFQ2XB5-BPvC-soB.js";
+import "./hook-FT3SJLe_.js";
 import "./ui/Button.js";
-import "./ZudokuContext-8jts0fF3.js";
+import "./joinUrl-nLx9pD-Z.js";
+import { o as f } from "./index-Eb1oiHbM.js";
 export {
-  a as openApiPlugin
+  f as openApiPlugin
 };
 //# sourceMappingURL=zudoku.plugin-openapi.js.map

package/lib/zudoku.plugin-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"zudoku.plugin-openapi.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;"}
+{"version":3,"file":"zudoku.plugin-openapi.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/package.json

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

package/src/app/main.tsx

@@ -11,12 +11,11 @@ import { configuredRedirectPlugin } from "virtual:zudoku-redirect-plugin";
 import { configuredSearchPlugin } from "virtual:zudoku-search-plugin";
 import { configuredSidebar } from "virtual:zudoku-sidebar";
 import "virtual:zudoku-theme.css";
-import { Layout, RouterError, Zudoku } from "zudoku/components";
+import { Layout, RouteGuard, RouterError, Zudoku } from "zudoku/components";
 import type { ZudokuConfig } from "../config/config.js";
 import { StatusPage } from "../lib/components/StatusPage.js";
 import type { ZudokuContextOptions } from "../lib/core/ZudokuContext.js";
 import { isNavigationPlugin } from "../lib/core/plugins.js";
-import { RouteGuard } from "../lib/core/RouteGuard.js";
 
 export const convertZudokuConfigToOptions = (
   config: ZudokuConfig,

package/src/lib/components/PathRenderer.tsx

@@ -0,0 +1,59 @@
+import { Fragment, type ReactNode } from "react";
+
+type PathParamProps = {
+  name: string;
+  index: number;
+  originalValue?: string;
+};
+
+export const PathRenderer = ({
+  path,
+  renderParam,
+}: {
+  path: string;
+  renderParam: (props: PathParamProps) => ReactNode;
+}) =>
+  path.split("/").map((part, i, arr) => {
+    const matches = Array.from(part.matchAll(/{([^}]+)}/g));
+    const elements: ReactNode[] = [];
+    let lastIndex = 0;
+
+    matches.forEach((match, matchIndex) => {
+      const [originalValue, name] = match;
+      if (!name) return;
+      const startIndex = match.index!;
+
+      if (startIndex > lastIndex) {
+        elements.push(
+          <Fragment key={`text-${lastIndex}-${startIndex}`}>
+            {part.slice(lastIndex, startIndex)}
+          </Fragment>,
+        );
+      }
+
+      elements.push(
+        <Fragment key={`param-${name}`}>
+          {renderParam({ name, originalValue, index: matchIndex })}
+        </Fragment>,
+      );
+
+      lastIndex = startIndex + originalValue.length;
+    });
+
+    if (lastIndex < part.length) {
+      elements.push(
+        <Fragment key={`text-${lastIndex}-${part.length}`}>
+          {part.slice(lastIndex)}
+        </Fragment>,
+      );
+    }
+
+    return (
+      // eslint-disable-next-line react/no-array-index-key
+      <Fragment key={`${part}-${i}`}>
+        {elements}
+        {i < arr.length - 1 && "/"}
+        <wbr />
+      </Fragment>
+    );
+  });

package/src/lib/components/ThemeSwitch.tsx

@@ -1,25 +1,26 @@
 import { MoonStarIcon, SunIcon } from "lucide-react";
 import { useTheme } from "next-themes";
 import { Button } from "zudoku/ui/Button.js";
-import { cn } from "../util/cn.js";
+import { ClientOnly } from "./ClientOnly.js";
 
 export const ThemeSwitch = () => {
   const { resolvedTheme, setTheme } = useTheme();
   const ThemeIcon = resolvedTheme === "dark" ? MoonStarIcon : SunIcon;
 
   return (
-    <Button
-      variant="ghost"
-      size="icon"
-      aria-label={
-        resolvedTheme === "dark"
-          ? "Switch to light mode"
-          : "Switch to dark mode"
-      }
-      className={cn(resolvedTheme ? "opacity-100" : "opacity-0")}
-      onClick={() => setTheme(resolvedTheme === "dark" ? "light" : "dark")}
-    >
-      <ThemeIcon size={18} />
-    </Button>
+    <ClientOnly fallback={<Button variant="ghost" size="icon" />}>
+      <Button
+        variant="ghost"
+        size="icon"
+        aria-label={
+          resolvedTheme === "dark"
+            ? "Switch to light mode"
+            : "Switch to dark mode"
+        }
+        onClick={() => setTheme(resolvedTheme === "dark" ? "light" : "dark")}
+      >
+        <ThemeIcon size={18} />
+      </Button>
+    </ClientOnly>
   );
 };

package/src/lib/components/index.ts

@@ -2,6 +2,7 @@ import { useMDXComponents as useMDXComponentsImport } from "@mdx-js/react";
 import { Helmet } from "@zudoku/react-helmet-async";
 import { Link as LinkImport } from "react-router";
 import { useAuth as useAuthImport } from "../authentication/hook.js";
+import { RouteGuard as RouteGuardImport } from "../core/RouteGuard.js";
 import { RouterError as RouterErrorImport } from "../errors/RouterError.js";
 import { ServerError as ServerErrorImport } from "../errors/ServerError.js";
 import { Button as ButtonImport } from "../ui/Button.js";
@@ -10,16 +11,16 @@ import {
   Bootstrap as BootstrapImport,
   BootstrapStatic as BootstrapStaticImport,
 } from "./Bootstrap.js";
-import { ClientOnly as ClientOnlyImport } from "./ClientOnly.js";
-import { Layout as LayoutImport } from "./Layout.js";
-import { Markdown as MarkdownImport } from "./Markdown.js";
-import { Spinner as SpinnerImport } from "./Spinner.js";
-import { Zudoku as ZudokuImport } from "./Zudoku.js";
 import {
   CACHE_KEYS as CACHE_KEYS_IMPORT,
   useCache as useCacheImport,
 } from "./cache.js";
+import { ClientOnly as ClientOnlyImport } from "./ClientOnly.js";
 import { useZudoku as useZudokuImport } from "./context/ZudokuContext.js";
+import { Layout as LayoutImport } from "./Layout.js";
+import { Markdown as MarkdownImport } from "./Markdown.js";
+import { Spinner as SpinnerImport } from "./Spinner.js";
+import { Zudoku as ZudokuImport } from "./Zudoku.js";
 
 export const useMDXComponents = /*@__PURE__*/ useMDXComponentsImport;
 export const Layout = /*@__PURE__*/ LayoutImport;
@@ -27,6 +28,7 @@ export const RouterError = /*@__PURE__*/ RouterErrorImport;
 export const ServerError = /*@__PURE__*/ ServerErrorImport;
 export const Bootstrap = /*@__PURE__*/ BootstrapImport;
 export const BootstrapStatic = /*@__PURE__*/ BootstrapStaticImport;
+export const RouteGuard = /*@__PURE__*/ RouteGuardImport;
 
 export const Head = /*@__PURE__*/ Helmet;
 

package/src/lib/components/navigation/SidebarCategory.tsx

@@ -53,6 +53,22 @@ export const SidebarCategory = ({
     </button>
   );
 
+  const icon = category.icon && (
+    <category.icon
+      size={16}
+      className={cn("align-[-0.125em] ", isActive && "text-primary")}
+    />
+  );
+
+  const styles = navigationListItem({
+    className: [
+      "text-start font-medium",
+      isCollapsible || typeof category.link !== "undefined"
+        ? "cursor-pointer"
+        : "cursor-default hover:bg-transparent",
+    ],
+  });
+
   return (
     <Collapsible.Root
       className="flex flex-col"
@@ -61,57 +77,44 @@ export const SidebarCategory = ({
       onOpenChange={() => setOpen(true)}
     >
       <Collapsible.Trigger className="group" asChild disabled={!isCollapsible}>
-        <div
-          onClick={() => setHasInteracted(true)}
-          className={navigationListItem({
-            isActive: false,
-            className: [
-              "text-start font-medium",
-              isCollapsible
-                ? "cursor-pointer"
-                : "cursor-default hover:bg-transparent",
-            ],
-          })}
-        >
-          {category.icon && (
-            <category.icon
-              size={16}
-              className={cn("align-[-0.125em] ", isActive && "text-primary")}
-            />
-          )}
-          {category.link?.type === "doc" ? (
-            <NavLink
-              to={joinPath(category.link.id)}
-              className="flex-1"
-              onClick={() => {
-                // if it is the current path and closed then open it because there's no path change to trigger the open
-                if (isActive && !open) {
-                  setOpen(true);
-                }
-              }}
+        {category.link?.type === "doc" ? (
+          <NavLink
+            to={joinPath(category.link.id)}
+            className={styles}
+            onClick={() => {
+              setHasInteracted(true);
+              // if it is the current path and closed then open it because there's no path change to trigger the open
+              if (isActive && !open) {
+                setOpen(true);
+              }
+            }}
+          >
+            {icon}
+            <div
+              className={cn(
+                "flex items-center gap-2 justify-between w-full",
+                isActive ? "text-primary" : "text-foreground/80",
+              )}
             >
-              <div
-                className={cn(
-                  "flex items-center gap-2 justify-between w-full",
-                  isActive ? "text-primary" : "text-foreground/80",
-                )}
-              >
-                <div className="truncate">{category.label}</div>
-                {ToggleButton}
-              </div>
-            </NavLink>
-          ) : (
+              <div className="truncate">{category.label}</div>
+              {ToggleButton}
+            </div>
+          </NavLink>
+        ) : (
+          <div onClick={() => setHasInteracted(true)} className={styles}>
+            {icon}
             <div className="flex items-center justify-between w-full">
               <div className="flex gap-2 truncate w-full">{category.label}</div>
               {ToggleButton}
             </div>
-          )}
-        </div>
+          </div>
+        )}
       </Collapsible.Trigger>
       <Collapsible.Content
         className={cn(
           // CollapsibleContent class is used to animate and it should only be applied when the user has triggered the toggle
           hasInteracted && "CollapsibleContent",
+          category.items.length === 0 && "hidden",
           "ms-6 my-1",
         )}
       >

package/src/lib/oas/graphql/circular.ts

@@ -1,25 +1,46 @@
 import { GraphQLJSON } from "graphql-type-json";
 import { GraphQLScalarType } from "graphql/index.js";
+import { RecordAny } from "../../util/traverse.js";
 
 export const CIRCULAR_REF = "$[Circular Reference]";
-const handleCircularRefs = (obj: any, visited = new WeakSet()): any => {
+
+const handleCircularRefs = (
+  obj: any,
+  visited = new Map<string, string[]>(),
+  path: string[] = [],
+): any => {
   if (obj === CIRCULAR_REF) return CIRCULAR_REF;
   if (obj === null || typeof obj !== "object") return obj;
 
-  if (visited.has(obj)) return CIRCULAR_REF;
+  const currentPath = path.join(".");
+
+  if (obj.type === "object" && obj.properties) {
+    const schemaKey = Object.keys(obj.properties).sort().join("-");
 
-  visited.add(obj);
+    if (visited.has(schemaKey)) {
+      const prevPaths = visited.get(schemaKey)!;
+      if (prevPaths.some((prev) => currentPath.startsWith(prev))) {
+        return CIRCULAR_REF;
+      }
+      visited.set(schemaKey, [...prevPaths, currentPath]);
+    } else {
+      visited.set(schemaKey, [currentPath]);
+    }
+  }
 
   if (Array.isArray(obj)) {
-    return obj.map((item) => handleCircularRefs(item, visited));
+    return obj.map((item, index) =>
+      handleCircularRefs(item, visited, [...path, `${index}`]),
+    );
   }
 
-  const result: Record<string, any> = {};
+  const result: RecordAny = {};
   for (const [key, value] of Object.entries(obj)) {
-    result[key] = handleCircularRefs(value, visited);
+    result[key] = handleCircularRefs(value, visited, [...path, key]);
   }
   return result;
 };
+
 export const GraphQLJSONSchema = new GraphQLScalarType({
   ...GraphQLJSON,
   name: "JSONSchema",

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

@@ -67,15 +67,26 @@ const builder = new SchemaBuilder<{
   };
   Context: {
     schema: OpenAPIDocument;
+    operations: GraphQLOperationObject[];
+    tags: TagObject[];
     schemaImports?: SchemaImports;
+    currentTag?: string;
+    slugify: CountableSlugify;
   };
 }>({});
 
+type GraphQLOperationObject = OperationObject & {
+  path: string;
+  method: string;
+  slug?: string;
+  parentTag?: string;
+};
+
 const JSONScalar = builder.addScalarType("JSON", GraphQLJSON);
 const JSONObjectScalar = builder.addScalarType("JSONObject", GraphQLJSONObject);
 const JSONSchemaScalar = builder.addScalarType("JSONSchema", GraphQLJSONSchema);
 
-const getAllTags = (schema: OpenAPIDocument): TagObject[] => {
+export const getAllTags = (schema: OpenAPIDocument): TagObject[] => {
   const tags = schema.tags ?? [];
 
   // Extract tags from operations
@@ -94,10 +105,10 @@ const getAllTags = (schema: OpenAPIDocument): TagObject[] => {
   return [...tags, ...uniqueOperationTags.map((tag) => ({ name: tag }))];
 };
 
-const getAllOperations = (paths?: PathsObject, tag?: string) => {
-  const slugify = slugifyWithCounter();
+const getAllOperations = (paths?: PathsObject) => {
+  const start = performance.now();
 
-  return Object.entries(paths ?? {}).flatMap(([path, value]) =>
+  const operations = Object.entries(paths ?? {}).flatMap(([path, value]) =>
     HttpMethods.flatMap((method) => {
       if (!value?.[method]) return [];
 
@@ -118,23 +129,17 @@ const getAllOperations = (paths?: PathsObject, tag?: string) => {
         ...operationParameters,
       ];
 
-      const slugData = {
-        summary: operation.summary,
-        operationId: operation.operationId,
-        path,
-        method,
-      };
-
       return {
         ...operation,
         method,
         path,
         parameters,
         tags: operation.tags ?? [],
-        slug: createOperationSlug(slugify, slugData, tag),
       };
     }),
   );
+
+  return operations;
 };
 
 const SchemaTag = builder.objectRef<TagObject>("SchemaTag").implement({
@@ -144,15 +149,19 @@ const SchemaTag = builder.objectRef<TagObject>("SchemaTag").implement({
     operations: t.field({
       type: [OperationItem],
       resolve: (parent, _args, ctx) => {
-        const rootTags = getAllTags(ctx.schema).map((tag) => tag.name);
-
-        return getAllOperations(ctx.schema.paths, parent.name).filter((item) =>
-          parent.name
-            ? item.tags.includes(parent.name)
-            : item.tags.length === 0 ||
-              // If none of the tags are present in the root tags, then show them here
-              item.tags.every((tag) => !rootTags.includes(tag)),
-        );
+        const rootTags = ctx.tags.map((tag) => tag.name);
+        return ctx.operations
+          .filter((item) =>
+            parent.name
+              ? item.tags?.includes(parent.name)
+              : item.tags?.length === 0 ||
+                // If none of the tags are present in the root tags, then show them here
+                item.tags?.every((tag) => !rootTags.includes(tag)),
+          )
+          .map((item) => ({
+            ...item,
+            parentTag: parent.name,
+          }));
       },
     }),
   }),
@@ -300,12 +309,24 @@ const ResponseItem = builder
   });
 
 const OperationItem = builder
-  .objectRef<
-    OperationObject & { path: string; method: string; slug: string }
-  >("OperationItem")
+  .objectRef<GraphQLOperationObject>("OperationItem")
   .implement({
     fields: (t) => ({
-      slug: t.exposeString("slug"),
+      slug: t.field({
+        type: "String",
+        resolve: (parent, _, ctx) => {
+          const slugData = {
+            summary: parent.summary,
+            operationId: parent.operationId,
+            path: parent.path,
+            method: parent.method,
+          };
+
+          //TODO: fix parent tag parent.tags
+          return createOperationSlug(ctx.slugify, slugData, parent.parentTag);
+        },
+      }),
+
       path: t.exposeString("path"),
       method: t.exposeString("method"),
       operationId: t.exposeString("operationId", { nullable: true }),
@@ -414,8 +435,8 @@ const Schema = builder.objectRef<OpenAPIDocument>("Schema").implement({
         name: t.arg.string(),
       },
       type: [SchemaTag],
-      resolve: (root, args) => {
-        const tags = [...getAllTags(root), { name: "" }];
+      resolve: (root, args, ctx) => {
+        const tags = [...ctx.tags, { name: "" }];
         return args.name ? tags.filter((tag) => tag.name === args.name) : tags;
       },
     }),
@@ -426,15 +447,18 @@ const Schema = builder.objectRef<OpenAPIDocument>("Schema").implement({
         method: t.arg.string(),
         operationId: t.arg.string(),
         tag: t.arg.string(),
+        untagged: t.arg.boolean(),
       },
-      resolve: (parent, args) =>
-        getAllOperations(parent.paths).filter(
-          (item) =>
-            (!args.operationId || item.operationId === args.operationId) &&
-            (!args.path || item.path === args.path) &&
-            (!args.method || item.method === args.method) &&
-            (!args.tag || item.tags.includes(args.tag)),
-        ),
+      resolve: (parent, args, ctx) =>
+        ctx.operations.filter((op) => {
+          return (
+            (!args.operationId || op.operationId === args.operationId) &&
+            (!args.path || op.path === args.path) &&
+            (!args.method || op.method === args.method) &&
+            (!args.tag || op.tags?.some((tag) => args.tag?.includes(tag))) &&
+            (!args.untagged || (op.tags ?? []).length === 0)
+          );
+        }),
     }),
   }),
 });
@@ -467,6 +491,10 @@ builder.queryType({
         }
 
         ctx.schema = schema;
+        ctx.operations = getAllOperations(schema.paths);
+        ctx.slugify = slugifyWithCounter();
+        ctx.tags = getAllTags(schema);
+
         return schema;
       },
     }),

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

@@ -89,10 +89,10 @@ export const ColorizedParam = ({
     <span
       {...{ [DATA_ATTR]: normalizedSlug }}
       className={cn(
-        "relative inline-block rounded transition-all duration-100",
-        "rounded-lg",
+        // 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]:-translate-y-px",
+        "data-[active=true]:border-[--param-color] data-[active=true]:shadow data-[active=true]:bottom-px",
         className,
       )}
       title={title}

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

@@ -77,14 +77,14 @@ export const Endpoint = () => {
             setSelectedServer(e.target.value);
           })
         }
-        value={selectedServer ?? result.data.schema.url}
+        value={selectedServer ?? servers.at(0)!.url}
         showChevrons={servers.length > 1}
         options={servers.map((server) => ({
           value: server.url,
           label: server.url,
         }))}
       />
-      <CopyButton url={selectedServer ?? result.data.schema.url} />
+      <CopyButton url={selectedServer ?? servers.at(0)!.url} />
     </div>
   );
 };

package/src/lib/plugins/openapi/{Route.tsx → OpenApiRoute.tsx}

@@ -1,4 +1,4 @@
-import { Outlet, useParams } from "react-router";
+import { Outlet } from "react-router";
 import { joinPath } from "../../util/joinPath.js";
 import type { GraphQLClient } from "./client/GraphQLClient.js";
 import { GraphQLProvider } from "./client/GraphQLContext.js";
@@ -8,16 +8,16 @@ import { type OasPluginConfig } from "./interfaces.js";
 export const OpenApiRoute = ({
   basePath,
   versions,
+  version,
   config,
   client,
 }: {
   basePath: string;
+  version?: string;
   versions: string[];
   config: OasPluginConfig;
   client: GraphQLClient;
 }) => {
-  const { version } = useParams<"version">();
-
   const input =
     config.type === "file"
       ? {