zudoku 0.16.3 → 0.18.0

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,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";
@@ -74,8 +76,6 @@ export const GetServerQuery = graphql(/* GraphQL */ `
   }
 `);
 
-const context = { suspense: true };
-
 const methodToColor = {
   get: TextColorMap.green,
   post: TextColorMap.blue,
@@ -87,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,
@@ -96,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
@@ -150,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
         ? {
@@ -168,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">
@@ -186,57 +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}
-          />
-        </SidecarBox.Head>
-        <SidecarBox.Body className="p-0">
-          <CollapsibleCode>
-            <SyntaxHighlight
-              language={selectedLang}
-              noBackground
-              className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
-              code={code!}
+          {isOnScreen && (
+            <PlaygroundDialogWrapper
+              server={result.data.schema.url ?? ""}
+              servers={
+                result.data.schema.servers.map((server) => server.url) ?? []
+              }
+              operation={operation}
             />
-          </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={[
-              { 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>
+          )}
+        </SidecarBox.Head>
+        {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>;

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/client/worker.ts

@@ -1,30 +1,44 @@
 import { createServer } from "./createServer.js";
-import { type WorkerGraphQLMessage } from "./createWorkerClient.js";
+
+export type WorkerGraphQLMessage = { id: string; body: string };
 
 const localServer = createServer();
 
 const worker = self as unknown as SharedWorkerGlobalScope;
 
-worker.addEventListener(
-  "connect",
-  function (event: MessageEvent<{ id: string; body: string }>) {
-    const port = event.ports[0];
-
-    port!.onmessage = async function (e) {
-      const response = await localServer.fetch(
-        new Request("/__z/graphql", {
-          method: "POST",
-          body: e.data.body,
-          headers: {
-            "Content-Type": "application/json",
-          },
-        }),
-      );
-
-      port!.postMessage({
-        id: e.data.id,
-        body: await response.text(),
-      } satisfies WorkerGraphQLMessage);
-    };
-  },
-);
+worker.addEventListener("connect", (event) => {
+  const mainPort = event.ports[0];
+
+  mainPort!.onmessage = (e) => {
+    if (e.data.port) {
+      const clientPort = e.data.port as MessagePort;
+
+      clientPort.onmessage = async (
+        event: MessageEvent<{ id: string; body: string }>,
+      ) => {
+        const { id, body } = event.data;
+
+        const response = await localServer.fetch(
+          new Request("/__z/graphql", {
+            method: "POST",
+            body,
+            headers: {
+              "Content-Type": "application/json",
+            },
+          }),
+        );
+
+        const responseBody = await response.text();
+
+        clientPort.postMessage({
+          id,
+          body: responseBody,
+        } as WorkerGraphQLMessage);
+      };
+
+      clientPort.start();
+    }
+  };
+
+  mainPort!.start();
+});

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

package/src/lib/plugins/openapi/graphql/gql.ts

@@ -1,5 +1,4 @@
 /* eslint-disable */
-import type { TypedDocumentNode as DocumentNode } from "@graphql-typed-document-node/core";
 import * as types from "./graphql.js";
 
 /**
@@ -22,58 +21,41 @@ const documents = {
     types.AllOperationsDocument,
   "\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n":
     types.GetServerQueryDocument,
-  "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n":
+  "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n":
     types.GetCategoriesDocument,
 };
 
-/**
- * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
- *
- *
- * @example
- * ```ts
- * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
- * ```
- *
- * The query argument is unknown!
- * Please regenerate the types.
- */
-export function graphql(source: string): unknown;
-
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
   source: "\n  query ServersQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n",
-): (typeof documents)["\n  query ServersQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n"];
+): typeof import("./graphql.js").ServersQueryDocument;
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
   source: "\n  fragment OperationsFragment on OperationItem {\n    slug\n    summary\n    method\n    description\n    operationId\n    contentTypes\n    path\n    parameters {\n      name\n      in\n      description\n      required\n      schema\n      style\n      examples {\n        name\n        description\n        externalValue\n        value\n        summary\n      }\n    }\n    requestBody {\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        examples {\n          name\n          description\n          externalValue\n          value\n          summary\n        }\n        schema\n      }\n      description\n      required\n    }\n    responses {\n      statusCode\n      links\n      description\n      content {\n        examples {\n          name\n          description\n          externalValue\n          value\n          summary\n        }\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n    }\n  }\n",
-): (typeof documents)["\n  fragment OperationsFragment on OperationItem {\n    slug\n    summary\n    method\n    description\n    operationId\n    contentTypes\n    path\n    parameters {\n      name\n      in\n      description\n      required\n      schema\n      style\n      examples {\n        name\n        description\n        externalValue\n        value\n        summary\n      }\n    }\n    requestBody {\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        examples {\n          name\n          description\n          externalValue\n          value\n          summary\n        }\n        schema\n      }\n      description\n      required\n    }\n    responses {\n      statusCode\n      links\n      description\n      content {\n        examples {\n          name\n          description\n          externalValue\n          value\n          summary\n        }\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n    }\n  }\n"];
+): typeof import("./graphql.js").OperationsFragmentFragmentDoc;
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
   source: "\n  query AllOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      description\n      title\n      url\n      version\n      tags {\n        name\n        description\n        operations {\n          slug\n          ...OperationsFragment\n        }\n      }\n    }\n  }\n",
-): (typeof documents)["\n  query AllOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      description\n      title\n      url\n      version\n      tags {\n        name\n        description\n        operations {\n          slug\n          ...OperationsFragment\n        }\n      }\n    }\n  }\n"];
+): typeof import("./graphql.js").AllOperationsDocument;
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
   source: "\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n",
-): (typeof documents)["\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      servers {\n        url\n      }\n    }\n  }\n"];
+): typeof import("./graphql.js").GetServerQueryDocument;
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
-  source: "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n",
-): (typeof documents)["\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n"];
+  source: "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n",
+): typeof import("./graphql.js").GetCategoriesDocument;
 
 export function graphql(source: string) {
   return (documents as any)[source] ?? {};
 }
-
-export type DocumentType<TDocumentNode extends DocumentNode<any, any>> =
-  TDocumentNode extends DocumentNode<infer TType, any> ? TType : never;