zudoku 0.0.0-f2c28ed → 0.0.0-f36627bd

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

@@ -0,0 +1,107 @@
+import { HTTPSnippet } from "@zudoku/httpsnippet";
+import type { OperationsFragmentFragment } from "../graphql/graphql.js";
+
+export const createHttpSnippet = ({
+  operation,
+  selectedServer,
+  exampleBody,
+}: {
+  operation: OperationsFragmentFragment;
+  selectedServer: string;
+  exampleBody: {
+    mimeType: string;
+    text?: string;
+  };
+}) => {
+  return new HTTPSnippet({
+    method: operation.method.toUpperCase(),
+    url:
+      selectedServer + operation.path.replaceAll("{", ":").replaceAll("}", ""),
+    postData: exampleBody,
+    headers: [
+      ...(exampleBody.text
+        ? [{ name: "Content-Type", value: exampleBody.mimeType }]
+        : []),
+      ...(operation.parameters
+        ?.filter((p) => p.in === "header" && p.required === true)
+        .map((p) => ({
+          name: p.name,
+          value:
+            p.schema?.default ??
+            p.examples?.find((x) => x.value)?.value ??
+            (p.schema?.type === "string"
+              ? "<string>"
+              : p.schema?.type === "number" || p.schema?.type === "integer"
+                ? "<number>"
+                : p.schema?.type === "boolean"
+                  ? "<bool>"
+                  : "<value>"),
+        })) ?? []),
+    ],
+    queryString:
+      operation.parameters
+        ?.filter((p) => p.in === "query" && p.required === true)
+        .map((p) => ({
+          name: p.name,
+          value:
+            p.schema?.default ??
+            p.examples?.find((x) => x.value)?.value ??
+            (p.schema?.type === "string"
+              ? "<string>"
+              : p.schema?.type === "number" || p.schema?.type === "integer"
+                ? "<number>"
+                : p.schema?.type === "boolean"
+                  ? "<bool>"
+                  : "<value>"),
+        })) ?? [],
+    httpVersion: "",
+    cookies: [],
+    headersSize: 0,
+    bodySize: 0,
+  });
+};
+
+export const getConverted = (snippet: HTTPSnippet, option: string) => {
+  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+  let converted: any;
+  switch (option) {
+    case "shell":
+      converted = snippet.convert("shell", "curl");
+      break;
+    case "js":
+      converted = snippet.convert("javascript", "fetch");
+      break;
+    case "python":
+      converted = snippet.convert("python", "requests");
+      break;
+    case "java":
+      converted = snippet.convert("java", "okhttp");
+      break;
+    case "go":
+      converted = snippet.convert("go", "native");
+      break;
+    case "csharp":
+      converted = snippet.convert("csharp", "httpclient");
+      break;
+    case "kotlin":
+      converted = snippet.convert("kotlin", "okhttp");
+      break;
+    case "objc":
+      converted = snippet.convert("objc", "nsurlsession");
+      break;
+    case "php":
+      converted = snippet.convert("php", "http2");
+      break;
+    case "ruby":
+      converted = snippet.convert("ruby");
+      break;
+    case "swift":
+      converted = snippet.convert("swift");
+      break;
+    default:
+      converted = snippet.convert("shell");
+      break;
+  }
+
+  return converted ? converted[0] : "";
+};

package/src/lib/plugins/openapi/util/{createSidebarCategory.tsx → createNavigationCategory.tsx}

@@ -1,8 +1,8 @@
-import type { SidebarItem } from "../../../../config/validators/SidebarSchema.js";
+import type { NavigationItem } from "../../../../config/validators/NavigationSchema.js";
 import type { OperationResult } from "../index.js";
 import { MethodColorMap } from "./methodColorMap.js";
 
-export const createSidebarCategory = ({
+export const createNavigationCategory = ({
   label,
   path,
   operations,
@@ -14,12 +14,13 @@ export const createSidebarCategory = ({
   operations: OperationResult[];
   collapsible?: boolean;
   collapsed?: boolean;
-}): SidebarItem => ({
+}): NavigationItem => ({
   type: "category",
   label,
   link: {
     type: "doc" as const,
-    id: path,
+    path,
+    file: path,
     label,
   },
   collapsible,
@@ -27,9 +28,10 @@ export const createSidebarCategory = ({
   items: operations.map((operation) => ({
     type: "link" as const,
     label: operation.summary ?? operation.path,
-    href: `${path}#${operation.slug}`,
+    to: `${path}#${operation.slug}`,
     badge: {
       label: operation.method,
+      // biome-ignore lint/style/noNonNullAssertion: is guaranteed to be defined
       color: MethodColorMap[operation.method.toLowerCase()]!,
       invert: true,
     },

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

@@ -1,10 +1,10 @@
-import { type SchemaObject } from "../../../oas/graphql/index.js";
+import type { SchemaObject } from "../../../oas/graphql/index.js";
 import { isCircularRef } from "../schema/utils.js";
 
 export const generateSchemaExample = (
   schema?: SchemaObject,
   name?: string,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
 ): any => {
   if (!schema || isCircularRef(schema)) {
     return null;
@@ -36,6 +36,7 @@ export const generateSchemaExample = (
 
   // For object schemas with properties
   if (schema.type === "object" && schema.properties) {
+    // biome-ignore lint/suspicious/noExplicitAny: Allow any type
     const example: Record<string, any> = {};
 
     for (const [key, propSchema] of Object.entries(schema.properties)) {
@@ -53,7 +54,6 @@ export const generateSchemaExample = (
         generateSchemaExample(itemSchema as SchemaObject),
       );
     }
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- OpenAPI schemas don't always adhere to spec
     if (schema.items) {
       return [generateSchemaExample(schema.items as SchemaObject)];
     }
@@ -116,7 +116,6 @@ export const generateSchemaExample = (
       return null;
     case "object":
       return {};
-    case undefined:
     default:
       return {};
   }

package/src/lib/plugins/openapi/util/getRoutes.tsx

@@ -2,8 +2,8 @@ import { useSuspenseQuery } from "@tanstack/react-query";
 import {
   generatePath,
   Navigate,
-  redirect,
   type RouteObject,
+  redirect,
   useLocation,
   useParams,
 } from "react-router";
@@ -12,7 +12,7 @@ import type { GraphQLClient } from "../client/GraphQLClient.js";
 import { useCreateQuery } from "../client/useCreateQuery.js";
 import { useOasConfig } from "../context.js";
 import {
-  GetSidebarOperationsQuery,
+  GetNavigationOperationsQuery,
   type OpenApiPluginOptions,
   UNTAGGED_PATH,
 } from "../index.js";
@@ -71,7 +71,7 @@ const NonTagPagesOperationList = ({
   const { type, input } = useOasConfig();
   const { tag: currentTag } = useParams();
   const location = useLocation();
-  const query = useCreateQuery(GetSidebarOperationsQuery, { type, input });
+  const query = useCreateQuery(GetNavigationOperationsQuery, { type, input });
   const {
     data: { schema },
   } = useSuspenseQuery(query);
@@ -170,7 +170,7 @@ export const getRoutes = ({
         basePath,
         routePath: basePath,
         routes: [
-          createNonTagPagesRoute({ path: basePath + "/:tag?" }),
+          createNonTagPagesRoute({ path: `${basePath}/:tag?` }),
           ...createAdditionalRoutes(basePath),
         ],
         client,

package/src/lib/plugins/openapi/util/methodColorMap.tsx

@@ -1,4 +1,4 @@
-import { ColorMap } from "../../../components/navigation/SidebarBadge.js";
+import type { ColorMap } from "../../../components/navigation/NavigationBadge.js";
 
 export const MethodColorMap: Record<string, keyof typeof ColorMap> = {
   get: "green",

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

@@ -1,5 +1,5 @@
 import { redirect } from "react-router";
-import { ZudokuRedirect } from "../../../config/validators/common.js";
+import type { ZudokuRedirect } from "../../../config/validators/validate.js";
 import type { ZudokuPlugin } from "../../core/plugins.js";
 
 export const redirectPlugin = (options: {

package/src/lib/plugins/search-inkeep/index.tsx

@@ -1,102 +1,98 @@
-import { useEffect, useMemo, useRef, useState } from "react";
+import type {
+  InkeepBaseSettings,
+  InkeepComponentInstance,
+  InkeepJS,
+  InkeepSettings,
+} from "@inkeep/cxkit-types";
+import { useEffect, useMemo, useState } from "react";
 import { ClientOnly } from "../../components/ClientOnly.js";
 import type { ZudokuPlugin } from "../../core/plugins.js";
-import { aiChatSettings, baseSettings } from "./inkeep.js";
-
-interface PluginInkeepBaseSettings {
-  apiKey?: string;
-  integrationId: string;
-  organizationId: string;
-  organizationDisplayName?: string;
-  primaryBrandColor: string;
-}
-
-interface InkeepEmbedConfig {
-  componentType: string;
-  targetElement: HTMLElement;
-  properties: unknown;
-}
-
-interface InkeepWidget {
-  render: (config: InkeepEmbedConfig & { isOpen: boolean }) => void;
-}
+import {
+  aiChatSettings,
+  baseSettings,
+  modalSettings,
+  searchSettings,
+} from "./inkeep.js";
 
 declare global {
-  let Inkeep: () => {
-    embed: (config: InkeepEmbedConfig) => InkeepWidget;
-  };
+  interface Window {
+    Inkeep: InkeepJS | undefined;
+  }
 }
 
 const InkeepSearch = ({
-  prefilledQuery,
   isOpen,
   onClose,
   settings,
 }: {
   isOpen: boolean;
   onClose: () => void;
-  prefilledQuery?: string | null;
-  settings: PluginInkeepBaseSettings;
+  settings: InkeepBaseSettings;
 }) => {
-  const ref = useRef<HTMLDivElement>(null);
-  const widgetRef = useRef<InkeepWidget | null>(null);
-  const [isInkeepAvailable, setIsInkeepAvailable] = useState(
-    typeof Inkeep !== "undefined",
-  );
-
-  const config: InkeepEmbedConfig = useMemo(
+  const config = useMemo<InkeepSettings>(
     () => ({
-      componentType: "CustomTrigger",
-      targetElement: ref.current!,
-      properties: {
-        isOpen,
-        onClose,
-        onOpen: undefined,
-        baseSettings: { ...baseSettings, ...settings },
-        searchSettings: {
-          prefilledQuery: prefilledQuery || undefined,
+      baseSettings: {
+        ...baseSettings,
+        ...settings,
+        colorMode: {
+          sync: {
+            target: "html",
+            attributes: ["class"],
+            isDarkMode: (attrs) => attrs.class?.includes("dark") ?? false,
+          },
+        },
+      },
+      modalSettings: {
+        ...modalSettings,
+        onOpenChange: (newOpen: boolean) => {
+          if (!newOpen) onClose();
         },
-        aiChatSettings,
       },
+      searchSettings,
+      aiChatSettings,
     }),
-    [isOpen, onClose, prefilledQuery, settings, ref],
+    [onClose, settings],
+  );
+  const [searchInstance, setSearchInstance] = useState<
+    InkeepComponentInstance | undefined
+  >(
+    typeof window !== "undefined" && window.Inkeep?.ModalSearchAndChat
+      ? window.Inkeep.ModalSearchAndChat(config)
+      : undefined,
   );
 
   useEffect(() => {
-    if (isInkeepAvailable) return;
+    if (searchInstance) return;
 
     const checkInkeep = setInterval(() => {
-      if (typeof Inkeep !== "undefined") {
-        setIsInkeepAvailable(true);
+      if (typeof window !== "undefined" && window.Inkeep?.ModalSearchAndChat) {
+        const inkeep = window.Inkeep.ModalSearchAndChat(config);
+        setSearchInstance(inkeep);
         clearInterval(checkInkeep);
       }
     }, 100);
 
     return () => clearInterval(checkInkeep);
-  }, [isInkeepAvailable]);
+  }, [config, searchInstance]);
 
   useEffect(() => {
-    if (!isInkeepAvailable || widgetRef.current) return;
-
-    widgetRef.current = Inkeep().embed(config);
-  }, [config, isInkeepAvailable]);
+    if (!searchInstance) return;
 
-  useEffect(() => {
-    widgetRef.current?.render({ ...config, isOpen });
-  }, [config, isOpen]);
+    searchInstance.update({ modalSettings: { isOpen } });
+  }, [isOpen, searchInstance]);
 
-  return <div ref={ref} />;
+  return null;
 };
 
 export const inkeepSearchPlugin = (
-  settings: PluginInkeepBaseSettings,
+  settings: InkeepBaseSettings,
 ): ZudokuPlugin => {
   return {
     getHead: () => {
       return (
         <script
           type="module"
-          src="https://unpkg.com/@inkeep/uikit-js@0.3.19/dist/embed.js"
+          src="https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5.90/+esm"
           defer
         />
       );

package/src/lib/plugins/search-inkeep/inkeep.ts

@@ -1,26 +1,24 @@
-const baseSettings = {
-  theme: {
-    components: {
-      AIChatPageWrapper: {
-        defaultProps: {
-          size: "shrink-vertically",
-          variant: "no-shadow",
-        },
-      },
-      SearchBarTrigger: {
-        defaultProps: {
-          size: "expand",
-          variant: "subtle", // Choose from 'emphasized' or 'subtle'
-        },
-      },
-    },
-  },
-} as const;
+import type {
+  InkeepAIChatSettings,
+  InkeepBaseSettings,
+  InkeepModalSettings,
+  InkeepSearchSettings,
+} from "@inkeep/cxkit-types";
 
-const modalSettings = {};
+const baseSettings: InkeepBaseSettings = {
+  primaryBrandColor: "#26D6FF",
+};
 
-const searchSettings = {};
+const modalSettings: InkeepModalSettings = {
+  shortcutKey: "k",
+};
 
-const aiChatSettings = {};
+const searchSettings: InkeepSearchSettings = {
+  placeholder: "Search...",
+};
+
+const aiChatSettings: InkeepAIChatSettings = {
+  aiAssistantName: "Assistant",
+};
 
 export { aiChatSettings, baseSettings, modalSettings, searchSettings };

package/src/lib/plugins/search-pagefind/PagefindSearch.tsx

@@ -63,7 +63,7 @@ const usePagefind = (options: PagefindOptions) => {
   });
 
   if (result.isError && result.error.message !== "NOT_BUILT_YET") {
-    // eslint-disable-next-line no-console
+    // biome-ignore lint/suspicious/noConsole: Logging allowed here
     console.error(result.error);
   }
 
@@ -141,9 +141,7 @@ export const PagefindSearch = ({
             <Callout type="info">
               Search is currently not available in development mode by default.
               <br />
-              To still use search in development, run <code>
-                zudoku build
-              </code>{" "}
+              To still use search in development, run <code>zudoku build</code>{" "}
               and copy the <code>dist/pagefind</code> directory to your{" "}
               <code>public</code> directory.
             </Callout>
@@ -153,6 +151,7 @@ export const PagefindSearch = ({
         </div>
       ) : (
         <ResultList
+          basePath={context.options.basePath}
           searchResults={searchResults ?? []}
           searchTerm={searchTerm}
           onClose={onClose}

package/src/lib/plugins/search-pagefind/ResultList.tsx

@@ -2,10 +2,8 @@ import { BracketsIcon, FileTextIcon } from "lucide-react";
 import { useLayoutEffect, useRef } from "react";
 import { Link, useNavigate } from "react-router";
 import { CommandGroup, CommandItem, CommandList } from "zudoku/ui/Command.js";
-import {
-  type PagefindSearchFragment,
-  type PagefindSubResult,
-} from "./types.js";
+import { joinUrl } from "../../util/joinUrl.js";
+import type { PagefindSearchFragment, PagefindSubResult } from "./types.js";
 
 const sortSubResults = (a: PagefindSubResult, b: PagefindSubResult) => {
   const aScore = a.weighted_locations.reduce(
@@ -22,6 +20,7 @@ const sortSubResults = (a: PagefindSubResult, b: PagefindSubResult) => {
 const hoverClassname = `cursor-pointer border border-transparent data-[selected=true]:border-border`;
 
 export const ResultList = ({
+  basePath,
   searchResults,
   searchTerm,
   onClose,
@@ -36,12 +35,20 @@ export const ResultList = ({
   const navigate = useNavigate();
   const commandListRef = useRef<HTMLDivElement | null>(null);
 
+  // biome-ignore lint/correctness/useExhaustiveDependencies: Only scroll to top when search term changes
   useLayoutEffect(() => {
     requestIdleCallback(() => {
       commandListRef.current?.scrollTo({ top: 0 });
     });
   }, [searchTerm]);
 
+  const stripBasePath = (url: string) => {
+    if (basePath && url.startsWith(basePath)) {
+      return joinUrl(url.slice(basePath.length));
+    }
+    return url;
+  };
+
   return (
     <CommandList className="max-h-[450px]" ref={commandListRef}>
       {searchTerm && searchResults.length > 0 && (
@@ -60,11 +67,11 @@ export const ResultList = ({
               value={`${result.meta.title}-${result.url}`}
               className={hoverClassname}
               onSelect={() => {
-                void navigate(result.url);
+                void navigate(stripBasePath(result.url));
                 onClose();
               }}
             >
-              <Link to={result.url}>
+              <Link to={stripBasePath(result.url)}>
                 {result.meta.section === "openapi" ? (
                   <BracketsIcon />
                 ) : (
@@ -83,15 +90,16 @@ export const ResultList = ({
                   value={`sub-${result.meta.title}-${subResult.url}`}
                   className={hoverClassname}
                   onSelect={() => {
-                    void navigate(subResult.url);
+                    void navigate(stripBasePath(subResult.url));
                     onClose();
                   }}
                 >
-                  <Link to={subResult.url} onClick={onClose}>
+                  <Link to={stripBasePath(subResult.url)} onClick={onClose}>
                     <div className="flex flex-col items-start gap-2 ms-2.5 ps-5 border-l border-muted-foreground/50">
                       <span className="font-bold">{subResult.title}</span>
                       <span
                         className="text-[13px] [&_mark]:bg-primary [&_mark]:text-primary-foreground"
+                        // biome-ignore lint/security/noDangerouslySetInnerHtml: Pagefind provides sanitized HTML
                         dangerouslySetInnerHTML={{ __html: subResult.excerpt }}
                       />
                     </div>

package/src/lib/plugins/search-pagefind/get-results.tsx

@@ -62,7 +62,6 @@ async function* searchResultGenerator({
 
       if (transformed === false) {
         // Skip this result
-        continue;
       } else if (transformed === true || transformed == null) {
         // Keep the original result
         yield result;

package/src/lib/shiki.ts

@@ -9,7 +9,12 @@ import type { Root } from "hast";
 import { toJsxRuntime } from "hast-util-to-jsx-runtime";
 import { Fragment, type JSX } from "react";
 import { jsx, jsxs } from "react/jsx-runtime";
-import type { BundledLanguage, BundledTheme, HighlighterCore } from "shiki";
+import type {
+  BundledLanguage,
+  BundledTheme,
+  CodeOptionsMultipleThemes,
+  HighlighterCore,
+} from "shiki";
 import { createHighlighterCore } from "shiki/core";
 import { createJavaScriptRegexEngine } from "shiki/engine/javascript";
 import type { Pluggable } from "unified";
@@ -30,12 +35,16 @@ export const highlighter = await createHighlighterCore({
   },
 });
 
+type ThemesRecord = CodeOptionsMultipleThemes<BundledTheme>["themes"];
+
 export const defaultHighlightOptions = {
   themes: {
     light: "github-light",
     dark: "github-dark",
-  } satisfies { light: BundledTheme; dark: BundledTheme },
+  },
   defaultColor: false,
+  defaultLanguage: "text",
+  fallbackLanguage: "text",
   inline: "tailing-curly-colon",
   addLanguageClass: true,
   transformers: [transformerMetaHighlight(), transformerMetaWordHighlight()],
@@ -60,6 +69,8 @@ export const defaultLanguages: BundledLanguage[] = [
   "jsx",
   "typescript",
   "tsx",
+  "graphql",
+  "jsonc",
   "json",
   "python",
   "java",
@@ -74,6 +85,8 @@ export const defaultLanguages: BundledLanguage[] = [
   "html",
   "xml",
   "yaml",
+  "toml",
+  "rust",
   "markdown",
   "mdx",
 ];
@@ -97,31 +110,23 @@ const rehypeCodeBlockPlugin = () => (tree: Root) => {
   });
 };
 
-export const createConfiguredShikiRehypePlugins = (themes?: {
-  light: BundledTheme;
-  dark: BundledTheme;
-}) => {
-  return [
-    [
-      rehypeShikiFromHighlighter,
-      highlighter,
-      {
-        ...defaultHighlightOptions,
-        themes: themes ?? defaultHighlightOptions.themes,
-      } satisfies RehypeShikiCoreOptions,
-    ] satisfies Pluggable,
-    rehypeCodeBlockPlugin,
-  ];
-};
+export const createConfiguredShikiRehypePlugins = (
+  themes: ThemesRecord = defaultHighlightOptions.themes,
+  highlighterInstance: HighlighterCore = highlighter,
+) => [
+  [
+    rehypeShikiFromHighlighter,
+    highlighterInstance,
+    { ...defaultHighlightOptions, themes },
+  ] satisfies Pluggable,
+  rehypeCodeBlockPlugin,
+];
 
 export const highlight = (
   highlighter: HighlighterCore,
   code: string,
   lang = "text",
-  themes: {
-    light: BundledTheme;
-    dark: BundledTheme;
-  } = defaultHighlightOptions.themes,
+  themes: ThemesRecord = defaultHighlightOptions.themes,
 ) => {
   const value = highlighter.codeToHast(code, {
     lang,

package/src/lib/ui/ActionButton.tsx

@@ -19,7 +19,9 @@ export const ActionButton = forwardRef<HTMLButtonElement, ActionButtonProps>(
             <Spinner />
           </div>
         )}
-        <div className={cn(isPending && "invisible")}>{children}</div>
+        <span className={cn("block", isPending && "invisible")}>
+          {children}
+        </span>
       </Button>
     );
   },