zudoku 0.0.0-f2fd45c → 0.0.0-f3786a4

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

@@ -1,12 +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 { Fragment, useMemo, useState, useTransition } from "react";
+import { useSearchParams } from "react-router";
 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";
 import { graphql } from "./graphql/index.js";
@@ -17,6 +19,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;
@@ -73,18 +76,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,21 +99,18 @@ 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 query = useCreateQuery(GetServerQuery, { input, type });
+  const result = useSuspenseQuery(query);
+
+  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;
 
@@ -142,14 +143,16 @@ export const Sidecar = ({
   const { selectedServer } = useSelectedServerStore();
 
   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 ?? result.data.schema.url ?? "") +
         operation.path.replaceAll("{", ":").replaceAll("}", ""),
       postData: example
         ? {
@@ -167,17 +170,23 @@ export const Sidecar = ({
 
     return getConverted(snippet, selectedLang);
   }, [
-    selectedServer,
-    selectedLang,
+    selectedExample,
+    requestBodyContent,
     operation.method,
     operation.path,
-    requestBodyContent,
+    selectedServer,
+    result.data.schema.url,
+    selectedLang,
   ]);
+  const [ref, isOnScreen] = useOnScreen({ rootMargin: "200px 0px 200px 0px" });
 
   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"
+    >
       <SidecarBox.Root>
-        <SidecarBox.Head className="flex justify-between items-center flex-nowrap py-3 gap-2 text-xs">
+        <SidecarBox.Head className="flex justify-between items-center flex-nowrap py-2.5 gap-2 text-xs">
           <span className="font-mono break-words">
             <span className={cn("font-semibold", methodTextColor)}>
               {operation.method.toLocaleUpperCase()}
@@ -185,55 +194,53 @@ export const Sidecar = ({
             &nbsp;
             {path}
           </span>
-          <PlaygroundDialogWrapper
-            server={result.data?.schema.url ?? ""}
-            servers={
-              result.data?.schema.servers.map((server) => server.url) ?? []
-            }
-            operation={operation}
-          />
+          {isOnScreen && (
+            <PlaygroundDialogWrapper
+              server={result.data.schema.url}
+              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] 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 && requestBodyContent && (
+        <RequestBodySidecarBox
+          content={requestBodyContent}
+          onExampleChange={setSelectedExample}
+        />
       )}
-      {operation.responses.length > 0 && (
+      {isOnScreen && operation.responses.length > 0 && (
         <ResponsesSidecarBox
           selectedResponse={selectedResponse}
           onSelectResponse={onSelectResponse}

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,163 @@
+import { useEffect, useState } from "react";
+import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
+import { type SchemaObject } from "../../oas/graphql/index.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];
+
+  let exampleValue = undefined;
+  if (selectedExample) {
+    // If it's a wrapped example with a value field, use that
+    exampleValue =
+      "value" in selectedExample ? selectedExample.value : selectedExample;
+  } else if (effectiveContent?.schema) {
+    // No example provided, generate one from schema
+    exampleValue = generateSchemaExample(
+      effectiveContent.schema as SchemaObject,
+    );
+  }
+
+  useEffect(() => {
+    onExampleChange?.(exampleValue);
+  }, [exampleValue, onExampleChange]);
+
+  const formattedExample = formatForDisplay(exampleValue);
+  const language = getLanguage(effectiveContent?.mediaType);
+
+  const hasContent = examples.length > 0 || content.length > 0;
+
+  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
+              copyable
+              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>
+      {hasContent && (
+        <SidecarBox.Footer className="text-xs p-0">
+          {description && (
+            <div className="text-muted-foreground text-xs border-b px-3 py-2">
+              {description}
+            </div>
+          )}
+          <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

@@ -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 extends Record<string, never> ? [] : [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>
+);

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}`);
             }
@@ -31,3 +35,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;
+};

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

package/src/lib/plugins/openapi/graphql/fragment-masking.ts

@@ -2,10 +2,8 @@
 import type {
   DocumentTypeDecoration,
   ResultOf,
-  TypedDocumentNode,
 } from "@graphql-typed-document-node/core";
-import type { FragmentDefinitionNode } from "graphql";
-import type { Incremental } from "./graphql.js";
+import type { Incremental, TypedDocumentString } from "./graphql.js";
 
 export type FragmentType<
   TDocumentType extends DocumentTypeDecoration<any, any>,
@@ -86,26 +84,21 @@ export function makeFragmentData<
   return data as FragmentType<F>;
 }
 export function isFragmentReady<TQuery, TFrag>(
-  queryNode: DocumentTypeDecoration<TQuery, any>,
-  fragmentNode: TypedDocumentNode<TFrag>,
+  queryNode: TypedDocumentString<TQuery, any>,
+  fragmentNode: TypedDocumentString<TFrag, any>,
   data:
-    | FragmentType<TypedDocumentNode<Incremental<TFrag>, any>>
+    | FragmentType<TypedDocumentString<Incremental<TFrag>, any>>
     | null
     | undefined,
 ): data is FragmentType<typeof fragmentNode> {
-  const deferredFields = (
-    queryNode as {
-      __meta__?: { deferredFields: Record<string, (keyof TFrag)[]> };
-    }
-  ).__meta__?.deferredFields;
+  const deferredFields = queryNode.__meta__?.deferredFields as Record<
+    string,
+    (keyof TFrag)[]
+  >;
+  const fragName = fragmentNode.__meta__?.fragmentName as string | undefined;
 
-  if (!deferredFields) return true;
+  if (!deferredFields || !fragName) return true;
 
-  const fragDef = fragmentNode.definitions[0] as
-    | FragmentDefinitionNode
-    | undefined;
-  const fragName = fragDef?.name?.value;
-
-  const fields = (fragName && deferredFields[fragName]) || [];
+  const fields = deferredFields[fragName] ?? [];
   return fields.length > 0 && fields.every((field) => data && field in data);
 }