zudoku 0.0.0-e5be921 → 0.0.0-e614aaa

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

@@ -1,11 +1,11 @@
 import { useSuspenseQuery } from "@tanstack/react-query";
 import { HTTPSnippet } from "@zudoku/httpsnippet";
-import { Fragment, useMemo, useTransition } from "react";
-import { useSearchParams } from "react-router-dom";
-import { useSelectedServerStore } from "../../authentication/state.js";
-import { TextColorMap } from "../../components/navigation/SidebarBadge.js";
-import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
+import { useMemo, useState, useTransition } from "react";
+import { useSearchParams } from "react-router";
+import { useSelectedServer } from "../../authentication/state.js";
+import { PathRenderer } from "../../components/PathRenderer.js";
 import type { SchemaObject } from "../../oas/parser/index.js";
+import { SyntaxHighlight } from "../../ui/SyntaxHighlight.js";
 import { cn } from "../../util/cn.js";
 import { useOnScreen } from "../../util/useOnScreen.js";
 import { useCreateQuery } from "./client/useCreateQuery.js";
@@ -20,6 +20,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 +77,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" },
@@ -110,59 +100,50 @@ export const Sidecar = ({
   selectedResponse?: string;
   onSelectResponse: (response: string) => void;
 }) => {
-  const { input, type } = useOasConfig();
+  const { input, type, options } = useOasConfig();
   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();
+  const [selectedExample, setSelectedExample] = useState<unknown>();
 
-  const selectedLang = searchParams.get("lang") ?? "shell";
+  const selectedLang =
+    searchParams.get("lang") ?? options?.examplesDefaultLanguage ?? "shell";
 
   const requestBodyContent = operation.requestBody?.content;
 
-  const path = operation.path.split("/").map((part, i, arr) => {
-    const isParam =
-      (part.startsWith("{") && part.endsWith("}")) || part.startsWith(":");
-    const paramName = isParam ? part.replace(/[:{}]/g, "") : undefined;
-
-    return (
-      // eslint-disable-next-line react/no-array-index-key
-      <Fragment key={part + i}>
-        {paramName ? (
-          <ColorizedParam
-            name={paramName}
-            backgroundOpacity="0"
-            // same as in `ParameterListItem`
-            slug={`${operation.slug}-${paramName.toLocaleLowerCase()}`}
-          >
-            {part}
-          </ColorizedParam>
-        ) : (
-          part
-        )}
-        {i < arr.length - 1 ? "/" : null}
-        <wbr />
-      </Fragment>
-    );
-  });
+  const path = (
+    <PathRenderer
+      path={operation.path}
+      renderParam={({ name }) => (
+        <ColorizedParam
+          name={name}
+          backgroundOpacity="0"
+          // same as in `ParameterListItem`
+          slug={`${operation.slug}-${name}`}
+        >
+          {`{${name}}`}
+        </ColorizedParam>
+      )}
+    />
+  );
 
-  const { selectedServer } = useSelectedServerStore();
+  const { selectedServer } = useSelectedServer(result.data.schema.servers);
 
   const code = useMemo(() => {
-    const example = requestBodyContent?.[0]?.schema
-      ? generateSchemaExample(requestBodyContent[0].schema as SchemaObject)
-      : undefined;
+    const example =
+      selectedExample ??
+      (requestBodyContent?.[0]?.schema
+        ? generateSchemaExample(requestBodyContent[0].schema as SchemaObject)
+        : undefined);
 
     const snippet = new HTTPSnippet({
       method: operation.method.toLocaleUpperCase(),
       url:
-        (selectedServer ?? result.data.schema.url ?? "") +
+        selectedServer +
         operation.path.replaceAll("{", ":").replaceAll("}", ""),
       postData: example
         ? {
@@ -180,6 +161,7 @@ export const Sidecar = ({
 
     return getConverted(snippet, selectedLang);
   }, [
+    selectedExample,
     requestBodyContent,
     operation.method,
     operation.path,
@@ -193,10 +175,11 @@ export const Sidecar = ({
     <aside
       ref={ref}
       className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4"
+      data-pagefind-ignore="all"
     >
       <SidecarBox.Root>
-        <SidecarBox.Head className="flex justify-between items-center flex-nowrap py-3 gap-2 text-xs">
-          <span className="font-mono break-words">
+        <SidecarBox.Head className="flex justify-between items-center flex-nowrap py-2.5 gap-2 text-xs">
+          <span className="font-mono break-words leading-6">
             <span className={cn("font-semibold", methodTextColor)}>
               {operation.method.toLocaleUpperCase()}
             </span>
@@ -205,11 +188,9 @@ export const Sidecar = ({
           </span>
           {isOnScreen && (
             <PlaygroundDialogWrapper
-              server={result.data.schema.url ?? ""}
-              servers={
-                result.data.schema.servers.map((server) => server.url) ?? []
-              }
+              servers={result.data.schema.servers.map((server) => server.url)}
               operation={operation}
+              examples={requestBodyContent ?? undefined}
             />
           )}
         </SidecarBox.Head>
@@ -225,7 +206,7 @@ export const Sidecar = ({
                 />
               </CollapsibleCode>
             </SidecarBox.Body>
-            <SidecarBox.Footer className="flex items-center text-xs gap-2 justify-end py-1">
+            <SidecarBox.Footer className="flex items-center text-xs gap-2 justify-end py-2.5">
               <span>Show example in</span>
               <SimpleSelect
                 className="self-start max-w-[150px]"
@@ -245,7 +226,10 @@ export const Sidecar = ({
         )}
       </SidecarBox.Root>
       {isOnScreen && requestBodyContent && (
-        <RequestBodySidecarBox content={requestBodyContent} />
+        <RequestBodySidecarBox
+          content={requestBodyContent}
+          onExampleChange={setSelectedExample}
+        />
       )}
       {isOnScreen && operation.responses.length > 0 && (
         <ResponsesSidecarBox

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

@@ -7,10 +7,7 @@ type BaseComponentProps<T = unknown> = PropsWithChildren<
 
 export const Root = ({ children, className }: BaseComponentProps) => (
   <div
-    className={cn(
-      "rounded-lg overflow-hidden border dark:border-transparent",
-      className,
-    )}
+    className={cn("rounded-xl overflow-hidden border border-border", className)}
   >
     {children}
   </div>
@@ -19,7 +16,7 @@ export const Root = ({ children, className }: BaseComponentProps) => (
 export const Head = ({ children, className }: BaseComponentProps) => (
   <div
     className={cn(
-      "border-b dark:border-zinc-600 bg-zinc-100 dark:bg-zinc-700 p-2",
+      "border-b bg-muted dark:bg-transparent text-card-foreground p-3 py-2.5",
       className,
     )}
   >
@@ -28,20 +25,11 @@ export const Head = ({ children, className }: BaseComponentProps) => (
 );
 
 export const Body = ({ children, className }: BaseComponentProps) => (
-  <div
-    className={cn("bg-zinc-50 dark:bg-zinc-800 overflow-auto p-2", className)}
-  >
-    {children}
-  </div>
+  <div className={cn("bg-card overflow-auto p-2", className)}>{children}</div>
 );
 
 export const Footer = ({ children, className }: BaseComponentProps) => (
-  <div
-    className={cn(
-      "border-t dark:border-zinc-600 bg-zinc-100 dark:bg-zinc-700 p-2",
-      className,
-    )}
-  >
+  <div className={cn("border-t bg-muted dark:bg-transparent p-3", className)}>
     {children}
   </div>
 );

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

@@ -0,0 +1,162 @@
+import { useEffect, useMemo, useState } from "react";
+import { SchemaObject } from "../../oas/parser/index.js";
+import { SyntaxHighlight } from "../../ui/SyntaxHighlight.js";
+import { CollapsibleCode } from "./CollapsibleCode.js";
+import type { OperationListItemResult } from "./OperationList.js";
+import * as SidecarBox from "./SidecarBox.js";
+import { SimpleSelect } from "./SimpleSelect.js";
+import { generateSchemaExample } from "./util/generateSchemaExample.js";
+
+export type Content = NonNullable<
+  NonNullable<OperationListItemResult["requestBody"]>["content"]
+>;
+export type Example = NonNullable<
+  NonNullable<Content[number]["examples"]>
+>[number];
+
+const formatForDisplay = (value: unknown): string => {
+  if (value == null) return "No example";
+  if (typeof value === "string") return value.trim();
+  return JSON.stringify(value, null, 2);
+};
+
+const getLanguage = (mediaType?: string): string => {
+  if (!mediaType) return "plain";
+  const languages: Record<string, string> = {
+    "application/json": "json",
+    "application/xml": "xml",
+    "application/x-yaml": "yaml",
+    "text/csv": "csv",
+    "application/javascript": "javascript",
+    "application/graphql": "graphql",
+  };
+  return languages[mediaType] ?? "plain";
+};
+
+export type SidecarExamplesProps = {
+  content: Content;
+  description?: string;
+  onExampleChange?: (example: unknown) => void;
+};
+
+export const SidecarExamples = ({
+  content,
+  description,
+  onExampleChange,
+}: SidecarExamplesProps) => {
+  const [selectedContentTypeIndex, setSelectedContentTypeIndex] = useState(0);
+  const [selectedExampleIndex, setSelectedExampleIndex] = useState(0);
+
+  // Get the effective content (handle single item array case)
+  const effectiveContent =
+    Array.isArray(content) && content.length === 1
+      ? content[0]
+      : content[selectedContentTypeIndex];
+
+  // Get example value, with fallback to schema-generated example
+  const examples = effectiveContent?.examples ?? [];
+  const selectedExample = examples[selectedExampleIndex];
+
+  const exampleValue = useMemo(() => {
+    if (selectedExample) {
+      // If it's a wrapped example with a value field, use that
+      return "value" in selectedExample
+        ? selectedExample.value
+        : selectedExample;
+    } else if (effectiveContent?.schema) {
+      // No example provided, generate one from schema
+      return generateSchemaExample(effectiveContent.schema as SchemaObject);
+    }
+  }, [selectedExample, effectiveContent?.schema]);
+
+  useEffect(() => {
+    if (!exampleValue) return;
+
+    onExampleChange?.(exampleValue);
+  }, [exampleValue, onExampleChange]);
+
+  const formattedExample = formatForDisplay(exampleValue);
+  const language = getLanguage(effectiveContent?.mediaType);
+
+  return (
+    <>
+      <SidecarBox.Body className="p-0">
+        {selectedExample?.externalValue ? (
+          <div className="p-2">
+            <a
+              href={selectedExample.externalValue}
+              target="_blank"
+              rel="noopener noreferrer"
+              className="text-xs text-primary hover:underline"
+            >
+              View External Example →
+            </a>
+          </div>
+        ) : (
+          <CollapsibleCode>
+            <SyntaxHighlight
+              language={language}
+              noBackground
+              className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+              code={formattedExample}
+            />
+          </CollapsibleCode>
+        )}
+        {selectedExample?.description && (
+          <div className="border-t text-xs px-3 py-1.5 text-muted-foreground">
+            {selectedExample.description}
+          </div>
+        )}
+      </SidecarBox.Body>
+      <SidecarBox.Footer className="text-xs p-0 divide-y divide-border">
+        {description && (
+          <div className="text-muted-foreground text-xs px-3 py-2">
+            {description}
+          </div>
+        )}
+        {(examples.length !== 0 || content.length !== 0) && (
+          <div className="flex items-center gap-2 justify-between min-w-0 px-3 py-2">
+            <div className="flex items-center gap-2 min-w-0">
+              {content.length > 1 ? (
+                <SimpleSelect
+                  className="max-w-[200px]"
+                  value={selectedContentTypeIndex.toString()}
+                  onChange={(e) =>
+                    setSelectedContentTypeIndex(Number(e.target.value))
+                  }
+                  options={content.map((c, index) => ({
+                    value: index.toString(),
+                    label: c.mediaType,
+                  }))}
+                />
+              ) : (
+                <span className="font-mono text-[11px]">
+                  {content[0]?.mediaType}
+                </span>
+              )}
+            </div>
+            {examples.length > 1 && (
+              <div className="flex items-center gap-1">
+                <SimpleSelect
+                  className="max-w-[180px]"
+                  value={selectedExampleIndex.toString()}
+                  onChange={(e) =>
+                    setSelectedExampleIndex(Number(e.target.value))
+                  }
+                  options={examples.map((example, index) => ({
+                    value: index.toString(),
+                    label:
+                      example.summary ||
+                      example.name ||
+                      example.description ||
+                      `Example ${index + 1}`,
+                  }))}
+                />
+              </div>
+            )}
+          </div>
+        )}
+      </SidecarBox.Footer>
+    </>
+  );
+};

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

@@ -1,34 +1,16 @@
 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 resolveVariables = async (variables?: unknown) => {
-  if (!variables) return;
-
-  if (
-    typeof variables === "object" &&
-    "type" in variables &&
-    variables.type === "file" &&
-    "input" in variables &&
-    typeof variables.input === "function"
-  ) {
-    variables.input = await variables.input();
-  }
-};
-
 const throwIfError = (response: GraphQLResponse<unknown>) => {
   if (!response.errors?.[0]) return;
 
@@ -39,119 +21,45 @@ const throwIfError = (response: GraphQLResponse<unknown>) => {
 };
 
 export class GraphQLClient {
-  readonly #mode: "remote" | "in-memory" | "worker";
-  #pendingRequests = new Map<string, (value: any) => void>();
-  #port: MessagePort | undefined;
+  constructor(private readonly config: OpenApiPluginOptions) {}
 
-  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";
+  #getLocalServer = async () => {
+    if (!localServerPromise) {
+      localServerPromise = import("./createServer.js").then((m) =>
+        m.createServer(this.config),
+      );
     }
-  }
+    return localServerPromise;
+  };
 
-  #initializeLocalServer = () =>
-    import("./createServer.js").then((m) => m.createServer());
+  #executeFetch = async (init: RequestInit): Promise<Response> => {
+    if (this.config.server) {
+      return fetch(this.config.server, init);
+    }
+
+    const localServer = await this.#getLocalServer();
+    return localServer.fetch("http://localhost/graphql", init);
+  };
 
   fetch = async <TResult, TVariables>(
     query: TypedDocumentString<TResult, TVariables>,
     ...[variables]: TVariables extends Record<string, never> ? [] : [TVariables]
-  ) => {
+  ): Promise<TResult> => {
     const operationName = query.match(/query (\w+)/)?.[1];
 
-    await resolveVariables(variables);
-
-    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 this.#executeFetch({
+      method: "POST",
+      body: JSON.stringify({ query, variables, operationName }),
+      headers: { "Content-Type": "application/json" },
+    });
 
-        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);
-          },
-        );
+    if (!response.ok) {
+      throw new Error("Network response was not ok");
+    }
 
-        const result = await resultPromise;
-        throwIfError(result);
+    const result = (await response.json()) as GraphQLResponse<TResult>;
+    throwIfError(result);
 
-        return result.data;
-      }
-    }
+    return result.data;
   };
 }

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

@@ -1,13 +1,17 @@
 import { useLogger } from "@envelop/core";
 import { createGraphQLServer } from "../../../oas/graphql/index.js";
+import type { OpenApiPluginOptions } from "../index.js";
 
 const map = new Map<string, number>();
 
 /**
  * Creates the GraphQL server
  */
-export const createServer = () =>
+export const createServer = (config: OpenApiPluginOptions) =>
   createGraphQLServer({
+    context: {
+      schemaImports: config.schemaImports,
+    },
     plugins: [
       // eslint-disable-next-line react-hooks/rules-of-hooks
       useLogger({
@@ -22,7 +26,7 @@ export const createServer = () =>
             if (start) {
               // eslint-disable-next-line no-console
               console.log(
-                `${args.operationName} query took ${performance.now() - start}ms`,
+                `[zudoku:debug] ${args.operationName} query took ${performance.now() - start}ms`,
               );
               map.delete(`${startEvent}-${args.operationName}`);
             }

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

@@ -1,5 +1,4 @@
-import hashit from "object-hash";
-import { useContext, useMemo } from "react";
+import { useContext } from "react";
 import type { TypedDocumentString } from "../graphql/graphql.js";
 import { GraphQLContext } from "./GraphQLContext.js";
 
@@ -12,10 +11,8 @@ export const useCreateQuery = <TResult, TVariables>(
     throw new Error("useGraphQL must be used within a GraphQLProvider");
   }
 
-  const hash = useMemo(() => hashit(variables[0] ?? {}), [variables]);
-
   return {
     queryFn: () => graphQLClient.fetch(query, ...variables),
-    queryKey: [query, hash],
+    queryKey: [query, variables[0]],
   } as const;
 };

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,
 );