zudoku 0.0.0-fb7d300 → 0.0.0-fc93837

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

@@ -1,12 +1,12 @@
-import { matchPath, type RouteObject } from "react-router-dom";
+import { matchPath } from "react-router";
 import { type ZudokuPlugin } from "../../core/plugins.js";
 import { graphql } from "./graphql/index.js";
 
-import { useQuery } from "@tanstack/react-query";
 import { CirclePlayIcon, LogInIcon } from "lucide-react";
 import type { SidebarItem } from "../../../config/validators/SidebarSchema.js";
 import { useAuth } from "../../authentication/hook.js";
 import { ColorMap } from "../../components/navigation/SidebarBadge.js";
+import type { SchemaImports } from "../../oas/graphql/index.js";
 import { Button } from "../../ui/Button.js";
 import { joinPath } from "../../util/joinPath.js";
 import { GraphQLClient } from "./client/GraphQLClient.js";
@@ -35,7 +35,7 @@ const GetCategoriesQuery = graphql(`
   }
 `);
 
-type InternalOasPluginConfig = { inMemory?: boolean };
+type InternalOasPluginConfig = { schemaImports?: SchemaImports };
 
 const MethodColorMap: Record<string, keyof typeof ColorMap> = {
   get: "green",
@@ -52,6 +52,8 @@ export type OpenApiPluginOptions = OasPluginConfig & InternalOasPluginConfig;
 export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
   const basePath = joinPath(config.navigationId ?? "/reference");
 
+  const versions = config.type === "file" ? Object.keys(config.input) : [];
+
   const client = new GraphQLClient(config);
 
   return {
@@ -78,18 +80,15 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
         method,
         url,
         ...props
-      }: Partial<PlaygroundContentProps> & { requireAuth: boolean }) => {
+      }: Partial<PlaygroundContentProps> &
+        Pick<PlaygroundContentProps, "server"> & {
+          requireAuth: boolean;
+        }) => {
         const auth = useAuth();
-        // We don't have the GraphQL context here
-        const serverQuery = useQuery({
-          queryFn: () =>
-            client.fetch(GetCategoriesQuery, {
-              type: config.type,
-              input: config.input,
-            }),
-          enabled: !server,
-          queryKey: ["playground-server"],
-        });
+
+        if (!server) {
+          throw new Error("Server is required");
+        }
 
         if (requireAuth && !auth.isAuthenticated) {
           return (
@@ -107,9 +106,7 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
           <PlaygroundDialog
             url={url ?? "/"}
             method={method ?? "get"}
-            server={
-              server ?? serverQuery.data?.schema.url ?? "https://example.com"
-            }
+            server={server}
             {...props}
           >
             <Button className="gap-2 items-center" variant="outline">
@@ -125,9 +122,14 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
       }
 
       try {
+        const version =
+          versions.find((v) => path === joinPath(basePath, v)) ??
+          Object.keys(config.input).at(0);
+
         const data = await client.fetch(GetCategoriesQuery, {
           type: config.type,
-          input: config.input,
+          input: config.type === "file" ? config.input[version!] : config.input,
+          version,
         });
 
         const categories = data.schema.tags
@@ -144,6 +146,7 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
               badge: {
                 label: operation.method,
                 color: MethodColorMap[operation.method.toLowerCase()]!,
+                invert: true,
               },
             })),
           }));
@@ -159,32 +162,34 @@ export const openApiPlugin = (config: OpenApiPluginOptions): ZudokuPlugin => {
         return [];
       }
     },
-    getRoutes: () =>
-      [
-        {
-          async lazy() {
-            const { OpenApiRoute } = await import("./Route.js");
-            return {
-              element: <OpenApiRoute client={client} config={config} />,
-            };
-          },
-          children: [
-            {
-              path: basePath,
-              children: [
-                {
-                  index: true,
-                  async lazy() {
-                    const { OperationList } = await import(
-                      "./OperationList.js"
-                    );
-                    return { element: <OperationList /> };
-                  },
-                },
-              ],
-            },
-          ],
+    getRoutes: () => {
+      const versionsInPath = [null, ...versions];
+
+      return versionsInPath.map((version) => ({
+        path: basePath + (version ? `/${version}` : ""),
+        async lazy() {
+          const { OpenApiRoute } = await import("./Route.js");
+          return {
+            element: (
+              <OpenApiRoute
+                basePath={basePath}
+                versions={versions}
+                client={client}
+                config={config}
+              />
+            ),
+          };
         },
-      ] satisfies RouteObject[],
+        children: [
+          {
+            index: true,
+            async lazy() {
+              const { OperationList } = await import("./OperationList.js");
+              return { element: <OperationList /> };
+            },
+          },
+        ],
+      }));
+    },
   };
 };

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

@@ -1,10 +1,39 @@
 type OasSource =
   | { type: "url"; input: string }
-  | { type: "file"; input: any }
+  | {
+      type: "file";
+      input: {
+        [version: string]: () => Promise<unknown>;
+      };
+    }
+  | { type: "raw"; input: string };
+
+export type ContextOasSource =
+  | { type: "url"; input: string }
+  | {
+      type: "file";
+      input: () => Promise<unknown>;
+    }
   | { type: "raw"; input: string };
 
 export type OasPluginConfig = {
   server?: string;
   navigationId?: string;
   skipPreload?: boolean;
-} & OasSource;
+} & OasPluginConfigOptions &
+  OasSource;
+
+export type OasPluginConfigOptions = {
+  options?: {
+    examplesDefaultLanguage?: string;
+  };
+};
+
+export type OasPluginContext = {
+  server?: string;
+  navigationId?: string;
+  skipPreload?: boolean;
+  version?: string;
+  versions: Record<string, string>;
+} & ContextOasSource &
+  OasPluginConfigOptions;

package/src/lib/plugins/openapi/playground/ExamplesDropdown.tsx

@@ -0,0 +1,54 @@
+import { Button } from "zudoku/ui/Button.js";
+import {
+  DropdownMenu,
+  DropdownMenuContent,
+  DropdownMenuGroup,
+  DropdownMenuItem,
+  DropdownMenuLabel,
+  DropdownMenuSeparator,
+  DropdownMenuTrigger,
+} from "zudoku/ui/DropdownMenu.js";
+import { Content, Example } from "../SidecarExamples.js";
+
+const ExamplesDropdown = ({
+  examples,
+  onSelect,
+}: {
+  examples: Content;
+  onSelect: (example: Example) => void;
+}) => {
+  return (
+    <div className="flex flex-col gap-2 mt-2 items-end">
+      <DropdownMenu>
+        <DropdownMenuTrigger asChild>
+          <Button variant="outline">Use Example</Button>
+        </DropdownMenuTrigger>
+        <DropdownMenuContent className="w-56">
+          {examples.map((example) => {
+            return (
+              <div key={example.mediaType}>
+                <DropdownMenuLabel>{example.mediaType}</DropdownMenuLabel>
+                <DropdownMenuSeparator />
+                <DropdownMenuGroup>
+                  {example.examples?.map((example) => {
+                    return (
+                      <DropdownMenuItem
+                        key={example.name}
+                        onSelect={() => onSelect(example)}
+                        className="line-clamp-1"
+                      >
+                        {example.summary ?? example.name}
+                      </DropdownMenuItem>
+                    );
+                  })}
+                </DropdownMenuGroup>
+              </div>
+            );
+          })}
+        </DropdownMenuContent>
+      </DropdownMenu>
+    </div>
+  );
+};
+
+export default ExamplesDropdown;

package/src/lib/plugins/openapi/playground/Headers.tsx

@@ -1,9 +1,49 @@
 import { XIcon } from "lucide-react";
-import { Control, useFieldArray, UseFormRegister } from "react-hook-form";
+import { useRef } from "react";
+import {
+  Control,
+  Controller,
+  useFieldArray,
+  useFormContext,
+  UseFormRegister,
+} from "react-hook-form";
+import { Card } from "zudoku/ui/Card.js";
+import { Checkbox } from "zudoku/ui/Checkbox.js";
+import { Autocomplete } from "../../../components/Autocomplete.js";
 import { Button } from "../../../ui/Button.js";
 import { Input } from "../../../ui/Input.js";
+import ParamsGrid from "./ParamsGrid.js";
 import { type PlaygroundForm } from "./Playground.js";
 
+const headerOptions = Object.freeze([
+  "Accept",
+  "Accept-Encoding",
+  "Accept-Language",
+  "Authorization",
+  "Cache-Control",
+  "Connection",
+  "Content-Disposition",
+  "Content-Encoding",
+  "Content-Language",
+  "Content-Length",
+  "Content-Range",
+  "Content-Security-Policy",
+  "Content-Type",
+  "Cookie",
+  "Date",
+  "ETag",
+  "Expires",
+  "Host",
+  "If-Modified-Since",
+  "Location",
+  "Origin",
+  "Pragma",
+  "Referer",
+  "Set-Cookie",
+  "User-Agent",
+  "X-Requested-With",
+]);
+
 export const Headers = ({
   control,
   register,
@@ -15,54 +55,112 @@ export const Headers = ({
     control,
     name: "headers",
   });
+  const { setValue } = useFormContext<PlaygroundForm>();
+  const valueRefs = useRef<Array<HTMLInputElement | null>>([]);
+  const nameRefs = useRef<Array<HTMLInputElement | null>>([]);
+
+  const addNewHeader = () => {
+    append({
+      name: "",
+      value: "",
+      active: false,
+    } as PlaygroundForm["headers"][number]);
+  };
+
+  const handleHeaderEnter = (index: number) => {
+    valueRefs.current[index]?.focus();
+  };
+
+  const handleValueEnter = (index: number) => {
+    addNewHeader();
+    requestAnimationFrame(() => nameRefs.current[index + 1]?.focus());
+  };
 
   return (
     <div className="flex flex-col gap-2">
-      <table className="w-full [&_td]:border [&_td]:p-1.5 [&_td]:px-2">
-        <tbody>
+      <Card className="overflow-hidden">
+        <ParamsGrid>
           {fields.map((header, i) => (
-            <tr
-              key={header.id}
-              className="group has-[:focus]:bg-muted/50 hover:bg-muted/50"
-            >
-              <td className="flex gap-2 items-center">
-                <Input
-                  {...register(`headers.${i}.name`)}
-                  placeholder="Name"
-                  className="border-0 shadow-none text-xs font-mono"
-                  autoComplete="off"
+            <div key={i} className="group grid col-span-full grid-cols-subgrid">
+              <div className="flex items-center gap-2 ">
+                <Controller
+                  control={control}
+                  name={`headers.${i}.active`}
+                  render={({ field }) => (
+                    <Checkbox
+                      variant="outline"
+                      id={`headers.${i}.active`}
+                      checked={field.value}
+                      onCheckedChange={(checked) => {
+                        field.onChange(checked);
+                      }}
+                    />
+                  )}
+                />
+                <Controller
+                  control={control}
+                  name={`headers.${i}.name`}
+                  render={({ field }) => (
+                    <Autocomplete
+                      {...field}
+                      placeholder="Name"
+                      className="border-0 shadow-none bg-transparent text-xs font-mono"
+                      options={headerOptions}
+                      onEnterPress={() => handleHeaderEnter(i)}
+                      onChange={(e) => {
+                        field.onChange(e);
+                        setValue(`headers.${i}.active`, true);
+                      }}
+                      ref={(el) => {
+                        nameRefs.current[i] = el;
+                      }}
+                    />
+                  )}
+                />
+              </div>
+              <div className="flex items-center gap-2">
+                <Controller
+                  control={control}
+                  name={`headers.${i}.value`}
+                  render={({ field }) => (
+                    <Input
+                      placeholder="Value"
+                      className="w-full border-0 shadow-none text-xs font-mono focus-visible:ring-0"
+                      {...field}
+                      ref={(el) => {
+                        valueRefs.current[i] = el;
+                      }}
+                      onKeyDown={(e) => {
+                        if (e.key === "Enter" && e.currentTarget.value.trim()) {
+                          handleValueEnter(i);
+                        }
+                      }}
+                      autoComplete="off"
+                    />
+                  )}
                 />
-              </td>
-              <td>
-                <div className="flex items-center gap-2">
-                  <Input
-                    placeholder={"Value"}
-                    className="border-0 shadow-none text-xs font-mono"
-                    {...register(`headers.${i}.value`)}
-                    autoComplete="off"
-                  />
-                  <Button
-                    size="icon"
-                    variant="ghost"
-                    className="text-muted-foreground opacity-0 group-hover:opacity-100"
-                    onClick={() => {
-                      remove(i);
-                    }}
-                    type="button"
-                  >
-                    <XIcon size={16} />
-                  </Button>
-                </div>
-              </td>
-            </tr>
+                <Button
+                  size="icon"
+                  variant="ghost"
+                  className="text-muted-foreground opacity-0 group-hover:opacity-100 rounded-full w-8 h-7"
+                  onClick={() => {
+                    remove(i);
+                  }}
+                  type="button"
+                >
+                  <XIcon size={16} />
+                </Button>
+              </div>
+            </div>
           ))}
-        </tbody>
-      </table>
+        </ParamsGrid>
+      </Card>
       <div className="text-end">
         <Button
           className=""
-          onClick={() => append({ name: "", value: "" })}
+          onClick={addNewHeader}
           type="button"
+          variant="secondary"
         >
           Add header
         </Button>

package/src/lib/plugins/openapi/playground/ParamsGrid.tsx

@@ -0,0 +1,8 @@
+import createVariantComponent from "../../../util/createVariantComponent.js";
+
+const ParamsGrid = createVariantComponent(
+  "div",
+  "hover:bg-accent/40 grid grid-cols-[2fr_3fr] gap-2 items-center px-3",
+);
+
+export default ParamsGrid;

package/src/lib/plugins/openapi/playground/PathParams.tsx

@@ -1,9 +1,8 @@
-import { EraserIcon } from "lucide-react";
 import { Control, Controller, useFieldArray } from "react-hook-form";
-import { Button } from "../../../ui/Button.js";
+import { Card } from "zudoku/ui/Card.js";
 import { Input } from "../../../ui/Input.js";
-import { cn } from "../../../util/cn.js";
 import { ColorizedParam } from "../ColorizedParam.js";
+import ParamsGrid from "./ParamsGrid.js";
 import type { PlaygroundForm } from "./Playground.js";
 
 export const PathParams = ({
@@ -17,71 +16,41 @@ export const PathParams = ({
   });
 
   return (
-    <table className="w-full table-auto [&_td]:border [&_td]:py-1 [&_td]:px-2">
-      <tbody>
+    <Card className="rounded-lg">
+      <ParamsGrid>
         {fields.map((part, i) => (
-          <tr key={part.id} className="hover:bg-accent/40">
-            <td>
+          <>
+            <Controller
+              control={control}
+              name={`pathParams.${i}.value`}
+              render={() => (
+                <div>
+                  <ColorizedParam
+                    slug={part.name}
+                    name={part.name}
+                    className="font-mono text-xs px-2"
+                  />
+                </div>
+              )}
+            />
+
+            <div className="flex justify-between items-center">
               <Controller
                 control={control}
                 name={`pathParams.${i}.value`}
                 render={({ field }) => (
-                  <div>
-                    <ColorizedParam
-                      slug={part.name}
-                      name={part.name}
-                      backgroundOpacity="25%"
-                      borderOpacity={field.value ? "100%" : "0"}
-                      className={cn(
-                        "font-mono text-xs m-2",
-                        !field.value && "opacity-60",
-                      )}
-                    />
-                    *
-                  </div>
+                  <Input
+                    {...field}
+                    required
+                    placeholder="Enter value"
+                    className="w-full border-0 shadow-none text-xs font-mono hover:bg-accent"
+                  />
                 )}
               />
-            </td>
-            <td>
-              <div className="flex justify-between items-center">
-                <Controller
-                  control={control}
-                  name={`pathParams.${i}.value`}
-                  render={({ field }) => (
-                    <Input
-                      {...field}
-                      placeholder="Enter value"
-                      className="border-0 shadow-none ring-0 font-mono text-xs"
-                    />
-                  )}
-                />
-                <Controller
-                  control={control}
-                  name={`pathParams.${i}.value`}
-                  render={({ field }) => (
-                    <Button
-                      size="icon"
-                      type="button"
-                      variant="ghost"
-                      aria-label="Clear value"
-                      className={cn(
-                        "ms-2",
-                        field.value.length === 0
-                          ? "opacity-0 pointer-events-none"
-                          : "opacity-100",
-                      )}
-                      title="Clear value"
-                      onClick={() => field.onChange("")}
-                    >
-                      <EraserIcon size={16} />
-                    </Button>
-                  )}
-                />
-              </div>
-            </td>
-          </tr>
+            </div>
+          </>
         ))}
-      </tbody>
-    </table>
+      </ParamsGrid>
+    </Card>
   );
 };