zudoku 0.0.0-f2a195f → 0.0.0-f2c28ed

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

@@ -1,12 +1,16 @@
+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 { useMemo, useState, useTransition } from "react";
+import { useSearchParams } from "react-router";
+import { useZudoku } from "zudoku/components";
+import { useAuthState } 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";
+import { CollapsibleCode } from "./CollapsibleCode.js";
 import { ColorizedParam } from "./ColorizedParam.js";
 import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
@@ -16,7 +20,9 @@ import { RequestBodySidecarBox } from "./RequestBodySidecarBox.js";
 import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { SimpleSelect } from "./SimpleSelect.js";
+import { useSelectedServer } from "./state.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
+import { methodForColor } from "./util/methodToColor.js";
 
 const getConverted = (snippet: HTTPSnippet, option: string) => {
   let converted;
@@ -73,18 +79,19 @@ export const GetServerQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const context = { suspense: true };
-
-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" },
+  { value: "python", label: "Python" },
+  { value: "java", label: "Java" },
+  { value: "go", label: "Go" },
+  { value: "csharp", label: "C#" },
+  { value: "kotlin", label: "Kotlin" },
+  { value: "objc", label: "Objective-C" },
+  { value: "php", label: "PHP" },
+  { value: "ruby", label: "Ruby" },
+  { value: "swift", label: "Swift" },
+];
 
 export const Sidecar = ({
   operation,
@@ -95,61 +102,65 @@ export const Sidecar = ({
   selectedResponse?: string;
   onSelectResponse: (response: string) => void;
 }) => {
-  const oasConfig = useOasConfig();
-  const [result] = useQuery({
-    query: GetServerQuery,
-    variables: oasConfig,
-    context,
-  });
-  const methodTextColor =
-    methodToColor[
-      operation.method.toLocaleLowerCase() as keyof typeof methodToColor
-    ] ?? TextColorMap.gray;
+  const { input, type, options } = useOasConfig();
+  const auth = useAuthState();
+  const query = useCreateQuery(GetServerQuery, { input, type });
+  const result = useSuspenseQuery(query);
+  const context = useZudoku();
+
+  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?.examplesLanguage ?? "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 transformedRequestBodyContent =
+    requestBodyContent && options?.transformExamples
+      ? options.transformExamples({
+          auth,
+          type: "request",
+          operation,
+          content: requestBodyContent,
+          context,
+        })
+      : requestBodyContent;
 
-  const { selectedServer } = useSelectedServerStore();
+  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 } = useSelectedServer(result.data.schema.servers);
 
   const code = useMemo(() => {
-    const example = requestBodyContent?.[0]?.schema
-      ? generateSchemaExample(requestBodyContent[0].schema as SchemaObject)
-      : undefined;
+    const example =
+      selectedExample ??
+      (transformedRequestBodyContent?.[0]?.schema
+        ? generateSchemaExample(
+            transformedRequestBodyContent[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
         ? {
@@ -157,8 +168,40 @@ export const Sidecar = ({
             mimeType: "application/json",
           }
         : ({} as any),
-      headers: [],
-      queryString: [],
+      headers: [
+        { name: "Content-Type", value: "application/json" },
+        ...(operation.parameters
+          ?.filter((p) => p.in === "header" && p.required === true)
+          .map((p) => ({
+            name: p.name,
+            value:
+              p.examples?.find((x) => x.value)?.value ??
+              p.schema?.default ??
+              (p.schema?.type === "string"
+                ? "string"
+                : p.schema?.type === "number" || p.schema?.type === "integer"
+                  ? "0"
+                  : p.schema?.type === "boolean"
+                    ? "true"
+                    : ""),
+          })) ?? []),
+      ],
+      queryString:
+        operation.parameters
+          ?.filter((p) => p.in === "query" && p.required === true)
+          .map((p) => ({
+            name: p.name,
+            value:
+              p.examples?.find((x) => x.value)?.value ??
+              p.schema?.default ??
+              (p.schema?.type === "string"
+                ? "string"
+                : p.schema?.type === "number" || p.schema?.type === "integer"
+                  ? "0"
+                  : p.schema?.type === "boolean"
+                    ? "true"
+                    : ""),
+          })) ?? [],
       httpVersion: "",
       cookies: [],
       headersSize: 0,
@@ -167,77 +210,101 @@ export const Sidecar = ({
 
     return getConverted(snippet, selectedLang);
   }, [
-    selectedServer,
-    selectedLang,
+    selectedExample,
+    transformedRequestBodyContent,
     operation.method,
     operation.path,
-    requestBodyContent,
+    selectedServer,
+    selectedLang,
+    operation.parameters,
   ]);
+  const [ref, isOnScreen] = useOnScreen({ rootMargin: "200px 0px 200px 0px" });
+
+  const showPlayground =
+    isOnScreen &&
+    (operation.extensions["x-explorer-enabled"] === true ||
+      operation.extensions["x-zudoku-playground-enabled"] === true ||
+      (operation.extensions["x-explorer-enabled"] === undefined &&
+        operation.extensions["x-zudoku-playground-enabled"] === undefined &&
+        !options?.disablePlayground));
 
   return (
-    <aside className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4">
+    <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>
             &nbsp;
             {path}
           </span>
-          <PlaygroundDialogWrapper
-            server={result.data?.schema.url ?? ""}
-            servers={
-              result.data?.schema.servers.map((server) => server.url) ?? []
-            }
-            operation={operation}
-          />
+          {showPlayground && (
+            <PlaygroundDialogWrapper
+              servers={result.data.schema.servers.map((server) => server.url)}
+              operation={operation}
+              examples={requestBodyContent ?? undefined}
+            />
+          )}
         </SidecarBox.Head>
-        <SidecarBox.Body className="max-h-[480px] p-0">
-          <SyntaxHighlight
-            language={selectedLang}
-            noBackground
-            className="text-xs p-2"
-            code={code}
-          />
-        </SidecarBox.Body>
-        <SidecarBox.Footer className="flex items-center text-xs gap-2 justify-end py-1">
-          <span>Show example in</span>
-          <SimpleSelect
-            className="self-start max-w-[150px]"
-            value={selectedLang}
-            onChange={(e) => {
-              startTransition(() => {
-                setSearchParams((prev) => {
-                  prev.set("lang", e.target.value);
-                  return prev;
-                });
-              });
-            }}
-            options={[
-              { value: "shell", label: "cURL" },
-              { value: "js", label: "Javascript" },
-              { value: "python", label: "Python" },
-              { value: "java", label: "Java" },
-              { value: "go", label: "Go" },
-              { value: "csharp", label: "C#" },
-              { value: "kotlin", label: "Kotlin" },
-              { value: "objc", label: "Objective C" },
-              { value: "php", label: "PHP" },
-              { value: "ruby", label: "Ruby" },
-              { value: "swift", label: "Swift" },
-            ]}
-          />
-        </SidecarBox.Footer>
+        {isOnScreen && (
+          <>
+            <SidecarBox.Body className="p-0">
+              <CollapsibleCode>
+                <SyntaxHighlight
+                  language={selectedLang}
+                  noBackground
+                  className="[--scrollbar-color:gray] rounded-none text-xs max-h-[500px] p-2"
+                  code={code!}
+                />
+              </CollapsibleCode>
+            </SidecarBox.Body>
+            <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]"
+                value={selectedLang}
+                onChange={(e) => {
+                  startTransition(() => {
+                    setSearchParams((prev) => {
+                      prev.set("lang", e.target.value);
+                      return prev;
+                    });
+                  });
+                }}
+                options={EXAMPLE_LANGUAGES}
+              />
+            </SidecarBox.Footer>
+          </>
+        )}
       </SidecarBox.Root>
-      {requestBodyContent && (
-        <RequestBodySidecarBox content={requestBodyContent} />
+      {isOnScreen && transformedRequestBodyContent && (
+        <RequestBodySidecarBox
+          content={transformedRequestBodyContent}
+          onExampleChange={setSelectedExample}
+        />
       )}
-      {operation.responses.length > 0 && (
+      {isOnScreen && operation.responses.length > 0 && (
         <ResponsesSidecarBox
           selectedResponse={selectedResponse}
           onSelectResponse={onSelectResponse}
-          responses={operation.responses}
+          responses={operation.responses.map((response) => ({
+            ...response,
+            content:
+              response.content && options?.transformExamples
+                ? options.transformExamples({
+                    auth,
+                    type: "response",
+                    context,
+                    operation,
+                    content: response.content,
+                  })
+                : response.content,
+          }))}
         />
       )}
     </aside>

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 { type 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] rounded-none 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/SimpleSelect.tsx

@@ -21,7 +21,7 @@ export const SimpleSelect = ({
   <div className="grid">
     <select
       className={cn(
-        "row-start-1 col-start-1 border border-input text-foreground px-2 py-1 pe-6",
+        "w-full row-start-1 col-start-1 border border-input text-foreground px-2 py-1 pe-6",
         "rounded-md appearance-none bg-zinc-50 hover:bg-white dark:bg-zinc-800 hover:dark:bg-zinc-800/75",
         className,
       )}

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

@@ -0,0 +1,65 @@
+import type { GraphQLError } from "graphql/error/index.js";
+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";
+
+let localServerPromise: Promise<LocalServer> | 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 {
+  constructor(private readonly config: OpenApiPluginOptions) {}
+
+  #getLocalServer = async () => {
+    if (!localServerPromise) {
+      localServerPromise = import("./createServer.js").then((m) =>
+        m.createServer(this.config),
+      );
+    }
+    return localServerPromise;
+  };
+
+  #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,
+  ): Promise<TResult> => {
+    const operationName = query.match(/query (\w+)/)?.[1];
+
+    const response = await this.#executeFetch({
+      method: "POST",
+      body: JSON.stringify({ query, variables, operationName }),
+      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;
+  };
+}

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