zudoku 0.17.0 → 0.18.0

package/src/lib/components/Zudoku.tsx

@@ -1,6 +1,6 @@
 import { MDXProvider } from "@mdx-js/react";
-import { QueryClientProvider } from "@tanstack/react-query";
 import { Helmet } from "@zudoku/react-helmet-async";
+import { ThemeProvider } from "next-themes";
 import {
   Fragment,
   memo,
@@ -13,11 +13,7 @@ import {
 import { ErrorBoundary } from "react-error-boundary";
 import { Outlet, useNavigation } from "react-router-dom";
 import { hasHead, isMdxProviderPlugin } from "../core/plugins.js";
-import {
-  queryClient,
-  ZudokuContext,
-  ZudokuContextOptions,
-} from "../core/ZudokuContext.js";
+import { ZudokuContext, ZudokuContextOptions } from "../core/ZudokuContext.js";
 import { TopLevelError } from "../errors/TopLevelError.js";
 import { StaggeredRenderContext } from "../plugins/openapi/StaggeredRender.js";
 import { MdxComponents } from "../util/MdxComponents.js";
@@ -26,7 +22,6 @@ import {
   ComponentsProvider,
   DEFAULT_COMPONENTS,
 } from "./context/ComponentsContext.js";
-import { ThemeProvider } from "./context/ThemeProvider.js";
 import { ViewportAnchorProvider } from "./context/ViewportAnchorContext.js";
 import { ZudokuProvider } from "./context/ZudokuProvider.js";
 import { SlotletProvider } from "./SlotletProvider.js";
@@ -77,12 +72,12 @@ const ZudokoInner = memo(
       .map((plugin, i) => <Fragment key={i}>{plugin.getHead?.()}</Fragment>);
 
     return (
-      <QueryClientProvider client={queryClient}>
+      <>
         <Helmet>{heads}</Helmet>
         <StaggeredRenderContext.Provider value={staggeredValue}>
           <ZudokuProvider context={zudokuContext}>
             <MDXProvider components={mdxComponents}>
-              <ThemeProvider>
+              <ThemeProvider attribute="class" disableTransitionOnChange>
                 <ComponentsProvider value={components}>
                   <SlotletProvider slotlets={props.slotlets}>
                     <ViewportAnchorProvider>
@@ -94,7 +89,7 @@ const ZudokoInner = memo(
             </MDXProvider>
           </ZudokuProvider>
         </StaggeredRenderContext.Provider>
-      </QueryClientProvider>
+      </>
     );
   },
 );

package/src/lib/components/context/ZudokuContext.ts

@@ -49,18 +49,13 @@ export const useCurrentNavigation = () => {
     topNavigation.find((t) => t.id === currentSidebarItem?.[0]) ??
     topNavigation.find((item) => matchPath(item.id, location.pathname));
 
-  return useSuspenseQuery({
-    queryFn: async () => {
-      const pluginSidebar = await getPluginSidebar(location.pathname);
-
-      return {
-        sidebar: [
-          ...(currentSidebarItem ? currentSidebarItem[1] : []),
-          ...pluginSidebar,
-        ],
-        topNavItem: currentTopNavItem,
-      };
-    },
-    queryKey: ["navigation", location.pathname],
+  const { data } = useSuspenseQuery({
+    queryFn: () => getPluginSidebar(location.pathname),
+    queryKey: ["plugin-sidebar", location.pathname],
   });
+
+  return {
+    sidebar: [...(currentSidebarItem ? currentSidebarItem[1] : []), ...data],
+    topNavItem: currentTopNavItem,
+  };
 };

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

@@ -15,10 +15,10 @@ export const Sidebar = () => {
     <>
       <SidebarWrapper
         ref={navRef}
-        pushMainContent={navigation.data.sidebar.length > 0}
+        pushMainContent={navigation.sidebar.length > 0}
       >
         <Slotlet name="zudoku-before-navigation" />
-        {navigation.data.sidebar.map((item) => (
+        {navigation.sidebar.map((item) => (
           <SidebarItem key={item.label} item={item} />
         ))}
         <Slotlet name="zudoku-after-navigation" />
@@ -30,7 +30,7 @@ export const Sidebar = () => {
         <VisuallyHidden>
           <DrawerTitle>Sidebar</DrawerTitle>
         </VisuallyHidden>
-        {navigation.data.sidebar.map((item) => (
+        {navigation.sidebar.map((item) => (
           <SidebarItem key={item.label} item={item} />
         ))}
       </DrawerContent>

package/src/lib/components/navigation/utils.ts

@@ -44,7 +44,7 @@ export const useCurrentItem = () => {
   const location = useLocation();
   const nav = useCurrentNavigation();
 
-  const currentSidebar = nav.data.sidebar;
+  const currentSidebar = nav.sidebar;
 
   return traverseSidebar(currentSidebar, (item) => {
     if (item.type === "doc" && joinPath(item.id) === location.pathname) {
@@ -79,7 +79,7 @@ export const usePrevNext = (): {
 } => {
   const currentId = useLocation().pathname;
   const nav = useCurrentNavigation();
-  const currentSidebar = nav.data.sidebar;
+  const currentSidebar = nav.sidebar;
 
   let prev;
   let next;

package/src/lib/core/ZudokuContext.ts

@@ -1,4 +1,3 @@
-import { QueryClient } from "@tanstack/react-query";
 import { ReactNode } from "react";
 import type { SidebarConfig } from "../../config/validators/SidebarSchema.js";
 import { TopNavigationItem } from "../../config/validators/validate.js";
@@ -21,10 +20,7 @@ export interface ApiIdentity {
   id: string;
 }
 
-export const queryClient = new QueryClient();
-
 export type ApiKeyCache = "api-keys";
-export type ZudokuCacheKey = ApiKeyCache | string;
 
 type Metadata = Partial<{
   title: string;
@@ -98,10 +94,6 @@ export class ZudokuContext {
     );
   };
 
-  invalidateCache = async (key: ZudokuCacheKey[]) => {
-    await queryClient.invalidateQueries({ queryKey: key });
-  };
-
   getApiIdentities = async () => {
     const keys = await Promise.all(
       this.plugins

package/src/lib/errors/ErrorAlert.tsx

@@ -5,6 +5,7 @@ import { ZudokuError } from "../util/invariant.js";
 export function ErrorAlert({ error }: { error: unknown }) {
   const message =
     error instanceof Error ? error.message : "Something went wrong";
+
   const hint = error instanceof ZudokuError ? error.developerHint : undefined;
   const title =
     error instanceof ZudokuError ? error.title : "Something went wrong";
@@ -12,7 +13,7 @@ export function ErrorAlert({ error }: { error: unknown }) {
   const cause = error instanceof Error ? error.cause : undefined;
 
   return (
-    <div className="flex h-screen max-h-screen min-h-full items-center justify-center bg-primary-background px-4 py-16 lg:px-8">
+    <div className="flex h-screen max-h-[calc(100vh-var(--header-height))] min-h-full items-center justify-center bg-primary-background px-4 py-16 lg:px-8">
       <div className="mx-auto max-w-[85%] sm:max-w-[50%]">
         <h1 className="text-4xl font-bold tracking-tight text-h1-text sm:text-5xl">
           {title}

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

@@ -1,15 +1,15 @@
-import { useEffect, useRef, type ReactNode } from "react";
-import { useTheme } from "../../components/context/ThemeContext.js";
+import { useTheme } from "next-themes";
+import { useEffect, useRef, type CSSProperties, type ReactNode } from "react";
 import { cn } from "../../util/cn.js";
 import { pastellize } from "../../util/pastellize.js";
 
 export const DATA_ATTR = "data-linked-param";
 
 export const usePastellizedColor = (name: string) => {
-  const [isDark] = useTheme();
+  const { resolvedTheme } = useTheme();
   return pastellize(
     name,
-    !isDark ? { saturation: 85, lightness: 50 } : undefined,
+    resolvedTheme === "light" ? { saturation: 85, lightness: 50 } : undefined,
   );
 };
 
@@ -61,27 +61,36 @@ export const ColorizedParam = ({
         });
     };
 
-    ref.current.addEventListener("mouseenter", onMouseEnter);
-    ref.current.addEventListener("mouseleave", onMouseLeave);
+    const el = ref.current;
+
+    el.addEventListener("mouseenter", onMouseEnter);
+    el.addEventListener("mouseleave", onMouseLeave);
 
     return () => {
-      ref.current?.removeEventListener("mouseenter", onMouseEnter);
-      ref.current?.removeEventListener("mouseleave", onMouseLeave);
+      el.removeEventListener("mouseenter", onMouseEnter);
+      el.removeEventListener("mouseleave", onMouseLeave);
     };
   }, [normalizedSlug]);
 
   return (
     <span
-      className={cn("inline-flex relative rounded group", className)}
       {...{ [DATA_ATTR]: normalizedSlug }}
+      className={cn(
+        "relative after:rounded after:absolute after:inset-0 after:-bottom-0.5 after:border-b-2 after:transition-opacity after:duration-200",
+        "after:pointer-events-none after:border-[--border-color] after:opacity-30 after:data-[active=true]:opacity-100",
+        className,
+      )}
+      suppressHydrationWarning
       ref={ref}
       onClick={onClick}
+      style={
+        {
+          "--border-color": borderColor,
+          "--background-color": backgroundColor,
+        } as CSSProperties
+      }
     >
-      <span
-        className="absolute inset-0 border-b-2 transition-opacity duration-200 opacity-30 group-data-[active=true]:opacity-100"
-        style={{ borderColor, backgroundColor }}
-      />
-      <span className="relative">{children ?? name}</span>
+      {children ?? name}
     </span>
   );
 };

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

@@ -1,9 +1,10 @@
+import { useSuspenseQuery } from "@tanstack/react-query";
 import { CheckIcon, CopyIcon } from "lucide-react";
 import { useState, useTransition } from "react";
-import { useQuery } from "urql";
 import { useSelectedServerStore } 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";
@@ -42,19 +43,13 @@ const CopyButton = ({ url }: { url: string }) => {
   );
 };
 
-const context = { suspense: true } as const;
-
 export const Endpoint = () => {
-  const [result] = useQuery({
-    query: ServersQuery,
-    variables: useOasConfig(),
-    context,
-  });
+  const { input, type } = useOasConfig();
+  const query = useCreateQuery(ServersQuery, { input, type });
+  const result = useSuspenseQuery(query);
   const [, startTransition] = useTransition();
   const { selectedServer, setSelectedServer } = useSelectedServerStore();
 
-  if (!result.data) return null;
-
   const { servers } = result.data.schema;
 
   if (servers.length === 1) {

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

@@ -1,17 +1,13 @@
 import { ResultOf } from "@graphql-typed-document-node/core";
-import type { CSSProperties } from "react";
-import { useQuery } from "urql";
+import { useSuspenseQuery } from "@tanstack/react-query";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
-import { DeveloperHint } from "../../components/DeveloperHint.js";
-import { ErrorPage } from "../../components/ErrorPage.js";
 import { Heading } from "../../components/Heading.js";
-import { InlineCode } from "../../components/InlineCode.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.js";
-import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import { cn } from "../../util/cn.js";
 import { Endpoint } from "./Endpoint.js";
 import { OperationListItem } from "./OperationListItem.js";
 import StaggeredRender from "./StaggeredRender.js";
+import { useCreateQuery } from "./client/useCreateQuery.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
 
@@ -100,41 +96,10 @@ const AllOperationsQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const suspenseContext = { suspense: true };
-
 export const OperationList = () => {
-  const { type, input } = useOasConfig();
-
-  const [result] = useQuery({
-    query: AllOperationsQuery,
-    variables: { type, input },
-    context: suspenseContext,
-  });
-
-  const error = result.error?.graphQLErrors.at(0);
-
-  // Looks like there is no Suspense level error handling (yet)?
-  // So we handle the error case in the component directly
-  if (error) {
-    return (
-      <ErrorPage
-        category="Error"
-        title="Schema cannot be displayed"
-        message={
-          <>
-            <DeveloperHint className="mb-4">
-              Check your configuration value <InlineCode>apis.type</InlineCode>{" "}
-              and <InlineCode>apis.input</InlineCode> in the Zudoku config.
-            </DeveloperHint>
-            An error occurred while trying to fetch the API reference:
-            <SyntaxHighlight code={error.toString()} language="plain" />
-          </>
-        }
-      />
-    );
-  }
-
-  if (!result.data) return null;
+  const { input, type } = useOasConfig();
+  const query = useCreateQuery(AllOperationsQuery, { input, type });
+  const result = useSuspenseQuery(query);
 
   return (
     <div className="pt-[--padding-content-top]">

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

@@ -1,20 +1,19 @@
 import { Outlet } from "react-router-dom";
-import { Provider, Client as UrqlClient } from "urql";
+import type { GraphQLClient } from "./client/GraphQLClient.js";
+import { GraphQLProvider } from "./client/GraphQLContext.js";
 import { OasConfigProvider } from "./context.js";
 import { OasPluginConfig } from "./interfaces.js";
 
-export function OpenApiRoute({
+export const OpenApiRoute = ({
   config,
   client,
 }: {
   config: OasPluginConfig;
-  client: typeof UrqlClient;
-}) {
-  return (
-    <Provider value={client}>
-      <OasConfigProvider value={{ config }}>
-        <Outlet />
-      </OasConfigProvider>
-    </Provider>
-  );
-}
+  client: GraphQLClient;
+}) => (
+  <OasConfigProvider value={{ config }}>
+    <GraphQLProvider client={client}>
+      <Outlet />
+    </GraphQLProvider>
+  </OasConfigProvider>
+);

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

@@ -1,13 +1,14 @@
+import { useSuspenseQuery } from "@tanstack/react-query";
 import { HTTPSnippet } from "@zudoku/httpsnippet";
 import { Fragment, useMemo, useTransition } from "react";
 import { useSearchParams } from "react-router-dom";
-import { useQuery } from "urql";
 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";
 import { useOnScreen } from "../../util/useOnScreen.js";
+import { useCreateQuery } from "./client/useCreateQuery.js";
 import { CollapsibleCode } from "./CollapsibleCode.js";
 import { ColorizedParam } from "./ColorizedParam.js";
 import { useOasConfig } from "./context.js";
@@ -75,8 +76,6 @@ export const GetServerQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const context = { suspense: true };
-
 const methodToColor = {
   get: TextColorMap.green,
   post: TextColorMap.blue,
@@ -111,12 +110,10 @@ export const Sidecar = ({
   selectedResponse?: string;
   onSelectResponse: (response: string) => void;
 }) => {
-  const oasConfig = useOasConfig();
-  const [result] = useQuery({
-    query: GetServerQuery,
-    variables: oasConfig,
-    context,
-  });
+  const { input, type } = useOasConfig();
+  const query = useCreateQuery(GetServerQuery, { input, type });
+  const result = useSuspenseQuery(query);
+
   const methodTextColor =
     methodToColor[
       operation.method.toLocaleLowerCase() as keyof typeof methodToColor
@@ -165,7 +162,7 @@ export const Sidecar = ({
     const snippet = new HTTPSnippet({
       method: operation.method.toLocaleUpperCase(),
       url:
-        (selectedServer ?? result.data?.schema.url ?? "") +
+        (selectedServer ?? result.data.schema.url ?? "") +
         operation.path.replaceAll("{", ":").replaceAll("}", ""),
       postData: example
         ? {
@@ -187,7 +184,7 @@ export const Sidecar = ({
     operation.method,
     operation.path,
     selectedServer,
-    result.data?.schema.url,
+    result.data.schema.url,
     selectedLang,
   ]);
   const [ref, isOnScreen] = useOnScreen({ rootMargin: "200px 0px 200px 0px" });
@@ -208,9 +205,9 @@ export const Sidecar = ({
           </span>
           {isOnScreen && (
             <PlaygroundDialogWrapper
-              server={result.data?.schema.url ?? ""}
+              server={result.data.schema.url ?? ""}
               servers={
-                result.data?.schema.servers.map((server) => server.url) ?? []
+                result.data.schema.servers.map((server) => server.url) ?? []
               }
               operation={operation}
             />

package/src/lib/plugins/openapi/client/GraphQLClient.tsx

@@ -0,0 +1,140 @@
+import type { GraphQLError } from "graphql/error/index.js";
+import { ulid } from "ulidx";
+import { initializeWorker } from "zudoku/openapi-worker";
+import { ZudokuError } from "../../../util/invariant.js";
+import type { TypedDocumentString } from "../graphql/graphql.js";
+import type { OpenApiPluginOptions } from "../index.js";
+import type { LocalServer } from "./createServer.js";
+import type { WorkerGraphQLMessage } from "./worker.js";
+
+let localServerPromise: Promise<LocalServer> | undefined;
+let worker: SharedWorker | undefined;
+
+type GraphQLResponse<TResult> = {
+  errors?: GraphQLError[];
+  data: TResult;
+};
+
+const throwIfError = (response: GraphQLResponse<unknown>) => {
+  if (!response.errors?.[0]) return;
+
+  throw new ZudokuError(response.errors[0].message, {
+    developerHint:
+      "Check your configuration value `apis.type` and `apis.input` in the Zudoku config.",
+  });
+};
+
+export class GraphQLClient {
+  readonly #mode: "remote" | "in-memory" | "worker";
+  #pendingRequests = new Map<string, (value: any) => void>();
+  #port: MessagePort | undefined;
+
+  constructor(private config: OpenApiPluginOptions) {
+    if (config.server) {
+      this.#mode = "remote";
+    } else if (config.inMemory || typeof SharedWorker === "undefined") {
+      this.#mode = "in-memory";
+    } else {
+      this.#mode = "worker";
+    }
+  }
+
+  #initializeLocalServer = () =>
+    import("./createServer.js").then((m) => m.createServer());
+
+  fetch = async <TResult, TVariables>(
+    query: TypedDocumentString<TResult, TVariables>,
+    ...[variables]: TVariables extends Record<string, never> ? [] : [TVariables]
+  ) => {
+    const operationName = query.match(/query (\w+)/)?.[1];
+    const body = JSON.stringify({ query, variables, operationName });
+
+    switch (this.#mode) {
+      case "remote": {
+        const response = await fetch(this.config.server!, {
+          method: "POST",
+          body,
+          headers: { "Content-Type": "application/json" },
+        });
+
+        if (!response.ok) {
+          throw new Error("Network response was not ok");
+        }
+
+        const result = (await response.json()) as GraphQLResponse<TResult>;
+        throwIfError(result);
+
+        return result.data;
+      }
+
+      case "in-memory": {
+        if (!localServerPromise) {
+          localServerPromise = this.#initializeLocalServer();
+        }
+
+        const localServer = await localServerPromise;
+        if (!localServer) throw new Error("Local server not initialized");
+
+        const response = await localServer.fetch(
+          new Request("http://localhost/graphql", {
+            method: "POST",
+            body,
+            headers: { "Content-Type": "application/json" },
+          }),
+        );
+
+        if (!response.ok) {
+          throw new Error("Network response was not ok");
+        }
+
+        const result = (await response.json()) as GraphQLResponse<TResult>;
+        throwIfError(result);
+
+        return result.data;
+      }
+
+      case "worker": {
+        if (!worker) {
+          worker = initializeWorker();
+        }
+
+        if (!this.#port) {
+          const channel = new MessageChannel();
+
+          worker.port.postMessage({ port: channel.port2 }, [channel.port2]);
+
+          this.#port = channel.port1;
+
+          this.#port.onmessage = (e: MessageEvent<WorkerGraphQLMessage>) => {
+            const { id, body } = e.data;
+            const resolve = this.#pendingRequests.get(id);
+            if (resolve) {
+              const result = JSON.parse(body);
+              resolve(result);
+              this.#pendingRequests.delete(id);
+            } else {
+              // eslint-disable-next-line no-console
+              console.error(`No pending request found for id: ${id}`);
+            }
+          };
+
+          this.#port.start();
+        }
+
+        const id = ulid();
+
+        const resultPromise = new Promise<GraphQLResponse<TResult>>(
+          (resolve) => {
+            this.#pendingRequests.set(id, resolve);
+            this.#port!.postMessage({ id, body } as WorkerGraphQLMessage);
+          },
+        );
+
+        const result = await resultPromise;
+        throwIfError(result);
+
+        return result.data;
+      }
+    }
+  };
+}

package/src/lib/plugins/openapi/client/GraphQLContext.tsx

@@ -0,0 +1,16 @@
+import { createContext, type ReactNode } from "react";
+import { GraphQLClient } from "./GraphQLClient.js";
+
+export const GraphQLContext = createContext<GraphQLClient | undefined>(
+  undefined,
+);
+
+export const GraphQLProvider = ({
+  children,
+  client,
+}: {
+  children: ReactNode;
+  client: GraphQLClient;
+}) => (
+  <GraphQLContext.Provider value={client}>{children}</GraphQLContext.Provider>
+);

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

@@ -31,3 +31,5 @@ export const createServer = () =>
       }),
     ],
   });
+
+export type LocalServer = ReturnType<typeof createServer>;

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

@@ -0,0 +1,18 @@
+import { useContext } from "react";
+import type { TypedDocumentString } from "../graphql/graphql.js";
+import { GraphQLContext } from "./GraphQLContext.js";
+
+export const useCreateQuery = <TResult, TVariables>(
+  query: TypedDocumentString<TResult, TVariables>,
+  ...variables: TVariables extends Record<string, never> ? [] : [TVariables]
+) => {
+  const graphQLClient = useContext(GraphQLContext);
+  if (graphQLClient === undefined) {
+    throw new Error("useGraphQL must be used within a GraphQLProvider");
+  }
+
+  return {
+    queryFn: () => graphQLClient.fetch(query, ...variables),
+    queryKey: [query, variables[0]],
+  } as const;
+};