zudoku 0.26.1 → 0.27.0

package/src/lib/oas/graphql/index.ts

@@ -1,16 +1,15 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import SchemaBuilder from "@pothos/core";
 import {
-  slugifyWithCounter,
   type CountableSlugify,
+  slugifyWithCounter,
 } from "@sindresorhus/slugify";
 import { GraphQLJSON, GraphQLJSONObject } from "graphql-type-json";
 import { createYoga, type YogaServerOptions } from "graphql-yoga";
 import {
-  HttpMethods,
-  validate,
   type EncodingObject,
   type ExampleObject,
+  HttpMethods,
   type OpenAPIDocument,
   type OperationObject,
   type ParameterObject,
@@ -18,7 +17,9 @@ import {
   type SchemaObject,
   type ServerObject,
   type TagObject,
+  validate,
 } from "../parser/index.js";
+import { GraphQLJSONSchema } from "./circular.js";
 
 export type {
   EncodingObject,
@@ -45,10 +46,7 @@ export const createOperationSlug = (
 ) => {
   const summary =
     (operation.summary ?? "") +
-    (operation.operationId
-      ? "-" +
-        operation.operationId.slice(0, operation.summary ? Infinity : Infinity)
-      : "");
+    (operation.operationId ? "-" + operation.operationId : "");
 
   return slugify(
     (tag ? tag + "-" : "") +
@@ -65,6 +63,7 @@ const builder = new SchemaBuilder<{
   Scalars: {
     JSON: any;
     JSONObject: any;
+    JSONSchema: any;
   };
   Context: {
     schema: OpenAPIDocument;
@@ -74,6 +73,7 @@ const builder = new SchemaBuilder<{
 
 const JSONScalar = builder.addScalarType("JSON", GraphQLJSON);
 const JSONObjectScalar = builder.addScalarType("JSONObject", GraphQLJSONObject);
+const JSONSchemaScalar = builder.addScalarType("JSONSchema", GraphQLJSONSchema);
 
 const getAllTags = (schema: OpenAPIDocument): TagObject[] => {
   const tags = schema.tags ?? [];
@@ -238,7 +238,7 @@ const ParameterItem = builder
           })),
         nullable: true,
       }),
-      schema: t.expose("schema", { type: JSONScalar, nullable: true }),
+      schema: t.expose("schema", { type: JSONSchemaScalar, nullable: true }),
     }),
   });
 
@@ -252,7 +252,7 @@ const MediaTypeItem = builder
   .implement({
     fields: (t) => ({
       mediaType: t.exposeString("mediaType"),
-      schema: t.expose("schema", { type: JSONScalar, nullable: true }),
+      schema: t.expose("schema", { type: JSONSchemaScalar, nullable: true }),
       examples: t.expose("examples", { type: [ExampleItem], nullable: true }),
       encoding: t.expose("encoding", { type: [EncodingItem], nullable: true }),
     }),

package/src/lib/oas/parser/dereference/index.ts

@@ -1,10 +1,9 @@
 import type { JSONSchema4, JSONSchema6 } from "json-schema";
+import { CIRCULAR_REF } from "../../graphql/circular.js";
 import { resolveLocalRef } from "./resolveRef.js";
 
 export type JSONSchema = JSONSchema4 | JSONSchema6;
 
-export const CIRCULAR_REF = "$[Circular Reference]";
-
 type CustomResolver = (ref: string) => Promise<JSONSchema | undefined>;
 
 const cache = new Map<JSONSchema, JSONSchema>();

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

@@ -95,7 +95,6 @@ export const OperationListItem = ({
               level={3}
               className="capitalize"
               id={`${operation.slug}/request-body`}
-              registerSidebarAnchor
             >
               Request Body
             </Heading>
@@ -108,7 +107,6 @@ export const OperationListItem = ({
               level={3}
               className="capitalize mt-8 pt-8 border-t"
               id={`${operation.slug}/responses`}
-              registerSidebarAnchor
             >
               Responses
             </Heading>

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

@@ -54,6 +54,7 @@ export const ParameterListItem = ({
           </Badge>
         )}
         {parameter.required && <Badge variant="outline">required</Badge>}
+        {parameter.style === "form" && <Badge variant="secondary">form</Badge>}
       </div>
       {parameter.description && (
         <Markdown

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

@@ -99,7 +99,7 @@ export const Sidecar = ({
   selectedResponse?: string;
   onSelectResponse: (response: string) => void;
 }) => {
-  const { input, type } = useOasConfig();
+  const { input, type, options } = useOasConfig();
   const query = useCreateQuery(GetServerQuery, { input, type });
   const result = useSuspenseQuery(query);
 
@@ -109,7 +109,8 @@ export const Sidecar = ({
   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;
 

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

@@ -2,7 +2,6 @@ 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";
@@ -81,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 (
@@ -110,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">

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

@@ -20,7 +20,14 @@ export type OasPluginConfig = {
   server?: string;
   navigationId?: string;
   skipPreload?: boolean;
-} & OasSource;
+} & OasPluginConfigOptions &
+  OasSource;
+
+export type OasPluginConfigOptions = {
+  options?: {
+    examplesDefaultLanguage?: string;
+  };
+};
 
 export type OasPluginContext = {
   server?: string;
@@ -28,4 +35,5 @@ export type OasPluginContext = {
   skipPreload?: boolean;
   version?: string;
   versions: Record<string, string>;
-} & ContextOasSource;
+} & ContextOasSource &
+  OasPluginConfigOptions;

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

@@ -18,33 +18,36 @@ const ExamplesDropdown = ({
   onSelect: (example: Example) => void;
 }) => {
   return (
-    <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)}
-                    >
-                      {example.name}
-                    </DropdownMenuItem>
-                  );
-                })}
-              </DropdownMenuGroup>
-            </div>
-          );
-        })}
-      </DropdownMenuContent>
-    </DropdownMenu>
+    <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>
   );
 };
 

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

@@ -12,6 +12,7 @@ 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([
@@ -77,56 +78,55 @@ export const Headers = ({
 
   return (
     <div className="flex flex-col gap-2">
-      <Card className="flex flex-col gap-2 overflow-hidden">
-        <table className="w-full">
-          <tbody>
-            {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 pl-3">
-                  <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;
-                        }}
-                      />
-                    )}
-                  />
-                </td>
-                <td>
-                  <div className="flex items-center gap-2">
+      <Card className="overflow-hidden">
+        <ParamsGrid>
+          {fields.map((header, i) => (
+            <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"
-                      {...register(`headers.${i}.value`)}
+                      className="w-full border-0 shadow-none text-xs font-mono focus-visible:ring-0"
+                      {...field}
                       ref={(el) => {
                         valueRefs.current[i] = el;
                       }}
@@ -137,23 +137,23 @@ export const Headers = ({
                       }}
                       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>
-            ))}
-          </tbody>
-        </table>
+                  )}
+                />
+                <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>
+          ))}
+        </ParamsGrid>
       </Card>
       <div className="text-end">
         <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,31 +1,10 @@
-import { EraserIcon } from "lucide-react";
 import { Control, Controller, useFieldArray } from "react-hook-form";
 import { Card } from "zudoku/ui/Card.js";
-import { Button } from "../../../ui/Button.js";
 import { Input } from "../../../ui/Input.js";
-import { cn } from "../../../util/cn.js";
-import { ColorizedParam, useParamColor } from "../ColorizedParam.js";
+import { ColorizedParam } from "../ColorizedParam.js";
+import ParamsGrid from "./ParamsGrid.js";
 import type { PlaygroundForm } from "./Playground.js";
 
-const PathParamLabel = ({ name }: { name: string }) => {
-  const color = useParamColor(name);
-
-  return (
-    <div className="flex items-center">
-      <div
-        className="w-2 h-2 rounded-full"
-        style={{ backgroundColor: `hsl(${color})` }}
-      />
-
-      <ColorizedParam
-        slug={name}
-        name={name}
-        className="font-mono text-xs m-2 px-1"
-      />
-    </div>
-  );
-};
-
 export const PathParams = ({
   control,
 }: {
@@ -38,59 +17,40 @@ export const PathParams = ({
 
   return (
     <Card className="rounded-lg">
-      <table className="w-full">
-        <tbody>
-          {fields.map((part, i) => (
-            <tr key={part.id} className="hover:bg-accent/40">
-              <td className="w-5/12">
-                <Controller
-                  control={control}
-                  name={`pathParams.${i}.value`}
-                  render={() => <PathParamLabel name={part.name} />}
-                />
-              </td>
-              <td className="w-7/12">
-                <div className="flex justify-between items-center">
-                  <Controller
-                    control={control}
-                    name={`pathParams.${i}.value`}
-                    render={({ field }) => (
-                      <Input
-                        {...field}
-                        required
-                        placeholder="Enter value"
-                        className="w-full border-0 shadow-none text-xs font-mono hover:bg-accent"
-                      />
-                    )}
-                  />
-                  <Controller
-                    control={control}
-                    name={`pathParams.${i}.value`}
-                    render={({ field }) => (
-                      <Button
-                        size="icon"
-                        type="button"
-                        variant="ghost"
-                        aria-label="Clear value"
-                        className={cn(
-                          "ms-2 mr-1",
-                          field.value.length === 0
-                            ? "opacity-0 pointer-events-none"
-                            : "opacity-100",
-                        )}
-                        title="Clear value"
-                        onClick={() => field.onChange("")}
-                      >
-                        <EraserIcon size={16} />
-                      </Button>
-                    )}
+      <ParamsGrid>
+        {fields.map((part, i) => (
+          <>
+            <Controller
+              control={control}
+              name={`pathParams.${i}.value`}
+              render={() => (
+                <div>
+                  <ColorizedParam
+                    slug={part.name}
+                    name={part.name}
+                    className="font-mono text-xs px-2"
                   />
                 </div>
-              </td>
-            </tr>
-          ))}
-        </tbody>
-      </table>
+              )}
+            />
+
+            <div className="flex justify-between items-center">
+              <Controller
+                control={control}
+                name={`pathParams.${i}.value`}
+                render={({ field }) => (
+                  <Input
+                    {...field}
+                    required
+                    placeholder="Enter value"
+                    className="w-full border-0 shadow-none text-xs font-mono hover:bg-accent"
+                  />
+                )}
+              />
+            </div>
+          </>
+        ))}
+      </ParamsGrid>
     </Card>
   );
 };