zudoku 0.3.0-dev.5 → 0.3.0-dev.50

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

@@ -0,0 +1,110 @@
+import * as Collapsible from "@radix-ui/react-collapsible";
+import { ListPlusIcon } from "lucide-react";
+import { Markdown } from "../../components/Markdown.js";
+import { SchemaObject } from "../../oas/parser/index.js";
+import { Button } from "../../ui/Button.js";
+import { cn } from "../../util/cn.js";
+import { SchemaListView } from "./SchemaListView.js";
+
+export const SchemaListViewItem = ({
+  propertyName,
+  property,
+  nestingLevel,
+  isRequired,
+}: {
+  propertyName: string;
+  isRequired: boolean;
+  property: SchemaObject;
+  nestingLevel: number;
+}) => {
+  return (
+    <div
+      key={propertyName}
+      className={cn(
+        "p-4 bg-border/20 hover:bg-border/30 flex gap-1 flex-col text-sm",
+        property.deprecated && "opacity-50",
+      )}
+    >
+      <div className="flex items-center gap-2 relative">
+        <code>
+          {propertyName} {property.title}
+        </code>
+
+        {property.type && (
+          <span className="text-muted-foreground">{property.type}</span>
+        )}
+        {property.deprecated && (
+          <span className="text-muted-foreground">Deprecated</span>
+        )}
+        {!isRequired && (
+          <span className="py-px px-1.5 font-medium border border-border rounded-lg">
+            optional {property.required}
+          </span>
+        )}
+      </div>
+      {property.description && (
+        <Markdown
+          content={property.description}
+          className="text-sm leading-normal line-clamp-4 "
+        />
+      )}
+
+      {property.enum && (
+        <span className="text-sm text-muted-foreground flex gap-1 flex-wrap items-center">
+          <span>Possible values</span>
+          {/* Make values unique, some schemas have duplicates */}
+          {[...new Set(property.enum.filter((value) => value))]
+            .map((value) => (
+              <span
+                key={value}
+                className="font-mono text-xs border-border border bg-muted rounded px-1"
+              >
+                {value}
+              </span>
+            ))
+            .slice(0, 4)}
+          {property.enum.length > 4 && (
+            <span className="font-mono text-xs border-border border bg-muted rounded px-1">
+              ...
+            </span>
+          )}
+        </span>
+      )}
+
+      {(property.type === "object" &&
+        (property.properties?.length ??
+          Object.entries(property.additionalProperties ?? {}).length > 0)) ||
+      (property.type === "array" && property.items.type === "object") ? (
+        <Collapsible.Root className="CollapsibleRoot" defaultOpen={false}>
+          <Collapsible.Trigger asChild>
+            <Button variant="ghost" size="sm">
+              Show nested fields
+              <ListPlusIcon size={18} className="ml-1.5" />
+            </Button>
+          </Collapsible.Trigger>
+
+          <Collapsible.Content>
+            {property.type === "object" && (
+              <div className="mt-2.5">
+                <SchemaListView
+                  schema={property}
+                  level={nestingLevel + 1}
+                  defaultOpen
+                />
+              </div>
+            )}
+            {property.type === "array" && property.items.type === "object" && (
+              <div className="mt-2.5">
+                <SchemaListView
+                  schema={property.items}
+                  defaultOpen
+                  level={nestingLevel + 1}
+                />
+              </div>
+            )}
+          </Collapsible.Content>
+        </Collapsible.Root>
+      ) : null}
+    </div>
+  );
+};

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

@@ -0,0 +1,63 @@
+import * as Collapsible from "@radix-ui/react-collapsible";
+import { useState } from "react";
+import { SchemaObject } from "../../oas/parser/index.js";
+import { cn } from "../../util/cn.js";
+import { SchemaListViewItem } from "./SchemaListViewItem.js";
+
+export const SchemaListViewItemGroup = ({
+  group,
+  properties,
+  nestingLevel,
+  required,
+  defaultOpen = false,
+}: {
+  group: "optional" | "required" | "deprecated";
+  defaultOpen?: boolean;
+  properties: [string, SchemaObject][];
+  nestingLevel: number;
+  required: string[];
+}) => {
+  const notCollapsible =
+    defaultOpen ||
+    group === "required" ||
+    properties.length === 1 ||
+    nestingLevel === 0;
+
+  const [open, setOpen] = useState(notCollapsible);
+
+  if (properties.length === 0) {
+    return;
+  }
+
+  return (
+    <Collapsible.Root
+      className="CollapsibleRoot"
+      open={open}
+      onOpenChange={setOpen}
+    >
+      {!open && (
+        <Collapsible.Trigger
+          className={cn(
+            "py-2 hover:bg-muted w-full",
+            group === "optional" && "font-semibold",
+            group === "deprecated" && "text-muted-foreground",
+          )}
+        >
+          {properties.length} {group} fields
+        </Collapsible.Trigger>
+      )}
+
+      <Collapsible.Content className="divide-y divide-border">
+        {properties.map(([propertyName, property]) => (
+          <SchemaListViewItem
+            key={propertyName}
+            property={property}
+            propertyName={propertyName}
+            nestingLevel={nestingLevel}
+            isRequired={required.includes(propertyName)}
+          />
+        ))}
+      </Collapsible.Content>
+    </Collapsible.Root>
+  );
+};

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

@@ -1,16 +1,17 @@
 import { HTTPSnippet } from "@zudoku/httpsnippet";
-import { Fragment, useMemo, useState } from "react";
+import { Fragment, useMemo } from "react";
+import { useSearchParams } from "react-router-dom";
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import type { SchemaObject } from "../../oas/parser/index.js";
 import { cn } from "../../util/cn.js";
 import { ColorizedParam } from "./ColorizedParam.js";
-import { MakeRequest } from "./MakeRequest.js";
 import { MethodTextColorMap } from "./MethodBadge.js";
 import type { OperationListItemResult } from "./OperationList.js";
+import { PlaygroundDialogWrapper } from "./PlaygroundDialogWrapper.js";
 import { RequestBodySidecarBox } from "./RequestBodySidecarBox.js";
 import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
-import { Select } from "./Select.js";
 import * as SidecarBox from "./SidecarBox.js";
+import { SimpleSelect } from "./SimpleSelect.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
 
 const getConverted = (snippet: HTTPSnippet, option: string) => {
@@ -64,7 +65,10 @@ export const Sidecar = ({
 }) => {
   const methodTextColor =
     MethodTextColorMap[operation.method as keyof typeof MethodTextColorMap];
-  const [option, setOption] = useState("curl");
+
+  const [searchParams, setSearchParams] = useSearchParams();
+  const selectedLang = searchParams.get("lang") ?? "shell";
+
   const requestBodyContent = operation.requestBody?.content;
 
   const path = operation.path.split("/").map((part) => (
@@ -105,8 +109,8 @@ export const Sidecar = ({
       } as never, // 👈 never touch this
     );
 
-    return getConverted(snippet, option);
-  }, [option, operation.method, operation.path, requestBodyContent]);
+    return getConverted(snippet, selectedLang);
+  }, [selectedLang, operation.method, operation.path, requestBodyContent]);
 
   return (
     <aside className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4">
@@ -120,9 +124,10 @@ export const Sidecar = ({
             {path}
           </span>
           <div className="flex gap-2 items-center">
-            <Select
+            <SimpleSelect
               className="self-start"
-              onChange={(e) => setOption(e.target.value)}
+              value={selectedLang}
+              onChange={(e) => setSearchParams({ lang: e.target.value })}
               options={[
                 { value: "shell", label: "cURL" },
                 { value: "js", label: "Javascript" },
@@ -137,12 +142,12 @@ export const Sidecar = ({
                 { value: "swift", label: "Swift" },
               ]}
             />
-            <MakeRequest operation={operation} />
+            <PlaygroundDialogWrapper operation={operation} />
           </div>
         </SidecarBox.Head>
         <SidecarBox.Body>
           <SyntaxHighlight
-            language={option}
+            language={selectedLang}
             noBackground
             className="text-xs"
             code={code}

package/src/lib/plugins/openapi/{Select.tsx → SimpleSelect.tsx}

@@ -1,13 +1,15 @@
+import { ChevronsUpDownIcon } from "lucide-react";
 import type { ChangeEventHandler } from "react";
-import { ChevronsUpDownIcon } from "../../core/icons.js";
 import { cn } from "../../util/cn.js";
 
-export const Select = ({
+export const SimpleSelect = ({
+  value,
   onChange,
   className,
   options,
 }: {
-  onChange?: ChangeEventHandler<HTMLSelectElement>;
+  value: string;
+  onChange: ChangeEventHandler<HTMLSelectElement>;
   className?: string;
   options: {
     value: string;
@@ -20,6 +22,7 @@ export const Select = ({
         "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",
       )}
+      value={value}
       onChange={onChange}
     >
       {options.map((option) => (

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

@@ -0,0 +1,56 @@
+/* eslint-disable no-console */
+import {
+  cacheExchange,
+  Client,
+  fetchExchange,
+  mapExchange,
+} from "../util/urql.js";
+import { createServer } from "./createServer.js";
+import { CreateClientFunction } from "./interfaces.js";
+
+export type WorkerGraphQLMessage = { id: string; body: string };
+
+const localServer = createServer();
+
+/**
+ * Creates an in memory Client that does not use Workers. This allows
+ * developers to run the simple standalone version of zudoku using the CDN
+ * hosted scripts. Worker's cannot be loaded cross domain so in this case
+ * we sacrifice performance for making it work cross domain.
+ */
+export const createClient: CreateClientFunction = () => {
+  return new Client({
+    url: "/__z/graphql",
+    // Custom fetch to send the GraphQL request to the worker and convert the response back to a `Response` object
+    fetch: async (req, init) => {
+      if (!init?.body) throw new Error("No body");
+      const response = await localServer.fetch(
+        new Request("http://localhost/__z/graphql", {
+          method: "POST",
+          body: init.body,
+          headers: {
+            "Content-Type": "application/json",
+          },
+        }),
+      );
+      return response;
+      // port.postMessage({
+      //   id: e.data.id,
+      //   body: await response.text(),
+      // } satisfies WorkerGraphQLMessage);
+    },
+    exchanges: [
+      cacheExchange,
+      mapExchange({
+        onError(error, operation) {
+          console.error(error);
+          console.groupCollapsed("Operation info");
+          console.log("body", operation.query.loc?.source.body.trim());
+          console.log("variables", operation.variables);
+          console.groupEnd();
+        },
+      }),
+      fetchExchange,
+    ],
+  });
+};

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

@@ -0,0 +1,33 @@
+import { useLogger } from "@envelop/core";
+import { createGraphQLServer } from "../../../oas/graphql/index.js";
+
+const map = new Map<string, number>();
+
+/**
+ * Creates the GraphQL server
+ */
+export const createServer = () =>
+  createGraphQLServer({
+    plugins: [
+      // eslint-disable-next-line react-hooks/rules-of-hooks
+      useLogger({
+        logFn: (eventName, { args }) => {
+          if (import.meta.env.PROD) return;
+
+          if (eventName.endsWith("-start")) {
+            map.set(`${eventName}-${args.operationName}`, performance.now());
+          } else if (eventName.endsWith("-end")) {
+            const startEvent = eventName.replace("-end", "-start");
+            const start = map.get(`${startEvent}-${args.operationName}`);
+            if (start) {
+              // eslint-disable-next-line no-console
+              console.log(
+                `${args.operationName} query took ${performance.now() - start}ms`,
+              );
+              map.delete(`${startEvent}-${args.operationName}`);
+            }
+          }
+        },
+      }),
+    ],
+  });

package/src/lib/plugins/openapi/{worker/createSharedWorkerClient.ts → client/createWorkerClient.ts}

@@ -7,15 +7,34 @@ import {
   fetchExchange,
   mapExchange,
 } from "../util/urql.js";
+import { createClient as createMemoryClient } from "./createMemoryClient.js";
+import { CreateClientFunction } from "./interfaces.js";
 
 export type WorkerGraphQLMessage = { id: string; body: string };
-
 const ulid = monotonicFactory();
-export const createSharedWorkerClient = () => {
+
+/**
+ * This loads the client from a worker and uses mess port to send requests
+ * and responses between the main thread and the worker.
+ */
+export const createClient: CreateClientFunction = ({
+  useMemoryClient,
+}: {
+  useMemoryClient: boolean;
+}) => {
+  if (useMemoryClient || typeof SharedWorker === "undefined") {
+    return createMemoryClient({ useMemoryClient });
+  }
+  // NOTE: This URL needs to be inline with the SharedWorker otherwse
+  // vite build does not recognize the worker file as a module.
   const worker = new SharedWorker(new URL("./worker.ts", import.meta.url), {
     type: "module",
   });
 
+  worker.onerror = (e) => {
+    console.error(e);
+  };
+
   worker.port.start();
 
   const [waitFor, notify] = createWaitForNotify<string>();

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

@@ -0,0 +1,5 @@
+import { Client } from "urql";
+
+export type CreateClientFunction = (config: {
+  useMemoryClient: boolean;
+}) => Client;

package/src/lib/plugins/openapi/{worker → client}/worker.ts

@@ -1,7 +1,7 @@
-import { createGraphQLServer } from "../../../oas/graphql/index.js";
-import { type WorkerGraphQLMessage } from "./createSharedWorkerClient.js";
+import { createServer } from "./createServer.js";
+import { type WorkerGraphQLMessage } from "./createWorkerClient.js";
 
-const localServer = createGraphQLServer();
+const localServer = createServer();
 
 const worker = self as unknown as SharedWorkerGlobalScope;
 

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

@@ -0,0 +1,16 @@
+import { createContext, useContext } from "react";
+import { OasPluginConfig } from "./interfaces.js";
+
+const OasContext = createContext<{ config: OasPluginConfig } | undefined>(
+  undefined,
+);
+
+export const OasConfigProvider = OasContext.Provider;
+
+export const useOasConfig = () => {
+  const ctx = useContext(OasContext);
+  if (!ctx) {
+    throw new Error("useOasConfig must be used within a OasConfigProvider");
+  }
+  return ctx.config;
+};

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

@@ -1,61 +1,20 @@
-import { createContext, useContext } from "react";
+import { matchPath, useRouteError, type RouteObject } from "react-router-dom";
 import {
   type DevPortalPlugin,
   type PluginNavigationCategory,
 } from "../../core/plugins.js";
-import { Outlet, matchPath, type RouteObject } from "../../core/router.js";
 import { MethodBadge } from "./MethodBadge.js";
-import { OperationList } from "./OperationList.js";
 import { graphql } from "./graphql/index.js";
 import {
-  Provider,
   Client as UrqlClient,
   cacheExchange,
   fetchExchange,
 } from "./util/urql.js";
 
-import { createSharedWorkerClient } from "virtual:zudoku-openapi-worker";
-import type { createSharedWorkerClient as createSharedWorkerClientType } from "./worker/createSharedWorkerClient.js";
-
-const OasContext = createContext<{ config: OasPluginConfig } | undefined>(
-  undefined,
-);
-
-export const OasConfigProvider = OasContext.Provider;
-
-export const useOasConfig = () => {
-  const ctx = useContext(OasContext);
-  if (!ctx) {
-    throw new Error("useOasConfig must be used within a OasConfigProvider");
-  }
-  return ctx.config;
-};
-
-type OasSource =
-  | { type: "url"; input: string }
-  | { type: "yaml"; input: string }
-  | { type: "json"; input: object };
-
-export type OasPluginConfig = {
-  server?: string;
-  path?: string;
-} & OasSource;
-
-const OasContextProvider = ({
-  config,
-  client,
-}: {
-  config: OasPluginConfig;
-  client: typeof UrqlClient;
-}) => {
-  return (
-    <Provider value={client}>
-      <OasConfigProvider value={{ config }}>
-        <Outlet />
-      </OasConfigProvider>
-    </Provider>
-  );
-};
+import { createClient } from "zudoku/openapi-worker";
+import { ErrorPage } from "../../components/ErrorPage.js";
+import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
+import { OasPluginConfig } from "./interfaces.js";
 
 const GetCategoriesQuery = graphql(`
   query GetCategories($input: JSON!, $type: SchemaType!) {
@@ -77,7 +36,25 @@ const GetCategoriesQuery = graphql(`
   }
 `);
 
-export const openApiPlugin = (config: OasPluginConfig): DevPortalPlugin => {
+const OpenApiErrorPage = () => {
+  const error = useRouteError();
+  const message =
+    error instanceof Error ? (
+      <SyntaxHighlight code={error.message} />
+    ) : (
+      "An unknown error occurred"
+    );
+
+  return (
+    <ErrorPage category="Error" title="An error occurred" message={message} />
+  );
+};
+
+type InternalOasPluginConfig = { inMemory?: boolean };
+
+export const openApiPlugin = (
+  config: OasPluginConfig & InternalOasPluginConfig,
+): DevPortalPlugin => {
   const basePath = config.path ?? "/reference";
 
   const client = config.server
@@ -85,11 +62,25 @@ export const openApiPlugin = (config: OasPluginConfig): DevPortalPlugin => {
         url: config.server,
         exchanges: [cacheExchange, fetchExchange],
       })
-    : (createSharedWorkerClient() as ReturnType<
-        typeof createSharedWorkerClientType
-      >);
+    : createClient({ useMemoryClient: config.inMemory ?? false });
 
   return {
+    getHead: () => {
+      if (config.type === "url") {
+        return (
+          <link
+            rel="preload"
+            href={config.input}
+            as="fetch"
+            crossOrigin="anonymous"
+          />
+        );
+      }
+
+      if (config.server) {
+        return <link rel="preconnect" href={config.server} />;
+      }
+    },
     getNavigation: async (path: string) => {
       if (!matchPath({ path: basePath, end: false }, path)) {
         return [];
@@ -135,11 +126,27 @@ export const openApiPlugin = (config: OasPluginConfig): DevPortalPlugin => {
     getRoutes: () =>
       [
         {
-          element: <OasContextProvider config={config} client={client} />,
+          async lazy() {
+            const { OpenApiRoute } = await import("./Route.js");
+            return {
+              element: <OpenApiRoute client={client} config={config} />,
+            };
+          },
+          errorElement: <OpenApiErrorPage />,
           children: [
             {
               path: basePath,
-              children: [{ index: true, element: <OperationList /> }],
+              children: [
+                {
+                  index: true,
+                  async lazy() {
+                    const { OperationList } = await import(
+                      "./OperationList.js"
+                    );
+                    return { element: <OperationList /> };
+                  },
+                },
+              ],
             },
           ],
         },

package/src/lib/plugins/openapi/interfaces.ts

@@ -0,0 +1,9 @@
+type OasSource =
+  | { type: "url"; input: string }
+  | { type: "yaml"; input: string }
+  | { type: "json"; input: object };
+
+export type OasPluginConfig = {
+  server?: string;
+  path?: string;
+} & OasSource;