zudoku 0.0.0-fcb84d6 → 0.0.0-fd8f8ad

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

@@ -1,16 +1,13 @@
 import { ResultOf } from "@graphql-typed-document-node/core";
-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";
 
@@ -44,6 +41,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
         encoding {
           name
         }
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         schema
       }
       description
@@ -54,6 +58,13 @@ export const OperationsFragment = graphql(/* GraphQL */ `
       links
       description
       content {
+        examples {
+          name
+          description
+          externalValue
+          value
+          summary
+        }
         mediaType
         encoding {
           name
@@ -85,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]">
@@ -140,7 +120,7 @@ export const OperationList = () => {
       {result.data.schema.tags
         .filter((tag) => tag.operations.length > 0)
         .map((tag) => (
-          <div key={tag.name}>
+          <div key={tag.name} className="[content-visibility:auto]">
             {tag.name && <CategoryHeading>{tag.name}</CategoryHeading>}
             {tag.description && (
               <Markdown

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

@@ -27,36 +27,42 @@ export const ParameterListItem = ({
   parameter: ParameterListItemResult;
   group: ParameterGroup;
   id: string;
-}) => (
-  <li className="p-4 bg-border/20 text-sm flex flex-col gap-1">
-    <div className="flex items-center gap-2">
-      <code>
-        {group === "path" ? (
-          <ColorizedParam
-            name={parameter.name}
-            backgroundOpacity="15%"
-            slug={id + "-" + parameter.name.toLocaleLowerCase()}
-          />
-        ) : (
-          parameter.name
+}) => {
+  const paramSchema = getParameterSchema(parameter);
+
+  return (
+    <li className="p-4 bg-border/20 text-sm flex flex-col gap-1">
+      <div className="flex items-center gap-2">
+        <code>
+          {group === "path" ? (
+            <ColorizedParam
+              name={parameter.name}
+              backgroundOpacity="15%"
+              slug={id + "-" + parameter.name.toLocaleLowerCase()}
+            />
+          ) : (
+            parameter.name
+          )}
+        </code>
+        {parameter.required && (
+          <span className="py-px px-1.5 font-medium bg-primary/75 text-muted rounded-lg">
+            required
+          </span>
         )}
-      </code>
-      {parameter.required && (
-        <span className="py-px px-1.5 font-medium bg-primary/75 text-muted rounded-lg">
-          required
-        </span>
-      )}
-      {getParameterSchema(parameter).type && (
-        <span className="text-muted-foreground">
-          {getParameterSchema(parameter).type}
-        </span>
+        {paramSchema.type && (
+          <span className="text-muted-foreground">
+            {paramSchema.type === "array"
+              ? `${paramSchema.items.type}[]`
+              : paramSchema.type}
+          </span>
+        )}
+      </div>
+      {parameter.description && (
+        <Markdown
+          content={parameter.description}
+          className="text-sm prose-p:my-1 prose-code:whitespace-pre-line"
+        />
       )}
-    </div>
-    {parameter.description && (
-      <Markdown
-        content={parameter.description}
-        className="text-sm prose-p:my-1 prose-code:whitespace-pre-line"
-      />
-    )}
-  </li>
-);
+    </li>
+  );
+};

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

@@ -1,5 +1,6 @@
 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 { generateSchemaExample } from "./util/generateSchemaExample.js";
@@ -12,6 +13,14 @@ type Content = NonNullable<
 export const RequestBodySidecarBox = ({ content }: { content: Content }) => {
   if (!content.length) return null;
 
+  const firstContent = content.at(0);
+
+  const example =
+    firstContent?.examples?.at(0)?.value ??
+    (firstContent?.schema
+      ? generateSchemaExample(firstContent.schema as SchemaObject)
+      : "");
+
   return (
     <>
       <SidecarBox.Root>
@@ -19,19 +28,15 @@ export const RequestBodySidecarBox = ({ content }: { content: Content }) => {
           <span className="font-mono">Request Body Example</span>
         </SidecarBox.Head>
         <SidecarBox.Body className="p-0">
-          <SyntaxHighlight
-            language="json"
-            noBackground
-            copyable
-            className="text-xs max-h-[450px] p-2"
-            code={JSON.stringify(
-              content.at(0)?.schema
-                ? generateSchemaExample(content[0].schema as SchemaObject)
-                : "",
-              null,
-              2,
-            )}
-          />
+          <CollapsibleCode>
+            <SyntaxHighlight
+              language={example ? "json" : "plain"}
+              noBackground
+              copyable
+              className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+              code={example ? JSON.stringify(example, null, 2) : "No example"}
+            />
+          </CollapsibleCode>
         </SidecarBox.Body>
       </SidecarBox.Root>
     </>

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

@@ -2,6 +2,7 @@ import * as Tabs from "@radix-ui/react-tabs";
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import { type SchemaObject } from "../../oas/graphql/index.js";
 import { cn } from "../../util/cn.js";
+import { CollapsibleCode } from "./CollapsibleCode.js";
 import type { OperationListItemResult } from "./OperationList.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
@@ -41,25 +42,29 @@ export const ResponsesSidecarBox = ({
         </Tabs.List>
       </SidecarBox.Head>
       {responses.map((response) => {
-        const schema = response.content?.[0]?.schema as
-          | SchemaObject
-          | undefined;
+        const firstContent = response.content?.at(0);
+
+        const example =
+          firstContent?.examples?.at(0)?.value ??
+          (firstContent?.schema
+            ? generateSchemaExample(firstContent.schema as SchemaObject)
+            : "");
 
         return (
           <Tabs.Content key={response.statusCode} value={response.statusCode}>
             <SidecarBox.Body className="p-0">
-              {schema ? (
+              <CollapsibleCode>
                 <SyntaxHighlight
-                  language="json"
+                  language={example ? "json" : "plain"}
                   noBackground
-                  className="text-xs max-h-[450px] p-2"
-                  code={JSON.stringify(generateSchemaExample(schema), null, 2)}
+                  className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+                  code={
+                    example
+                      ? JSON.stringify(example, null, 2)
+                      : "Empty response"
+                  }
                 />
-              ) : (
-                <span className="text-muted-foreground font-mono italic text-xs">
-                  Empty Response
-                </span>
-              )}
+              </CollapsibleCode>
             </SidecarBox.Body>
             <SidecarBox.Footer className="flex justify-end text-xs">
               {response.description}

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,12 +1,15 @@
+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";
 import { graphql } from "./graphql/index.js";
@@ -73,8 +76,6 @@ export const GetServerQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const context = { suspense: true };
-
 const methodToColor = {
   get: TextColorMap.green,
   post: TextColorMap.blue,
@@ -86,6 +87,20 @@ const methodToColor = {
   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,
   selectedResponse,
@@ -95,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
@@ -149,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
         ? {
@@ -167,15 +180,20 @@ export const Sidecar = ({
 
     return getConverted(snippet, selectedLang);
   }, [
-    selectedServer,
-    selectedLang,
+    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">
           <span className="font-mono break-words">
@@ -185,55 +203,51 @@ 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}
+            />
+          )}
         </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-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={EXAMPLE_LANGUAGES}
+              />
+            </SidecarBox.Footer>
+          </>
+        )}
       </SidecarBox.Root>
-      {requestBodyContent && (
+      {isOnScreen && requestBodyContent && (
         <RequestBodySidecarBox content={requestBodyContent} />
       )}
-      {operation.responses.length > 0 && (
+      {isOnScreen && operation.responses.length > 0 && (
         <ResponsesSidecarBox
           selectedResponse={selectedResponse}
           onSelectResponse={onSelectResponse}

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