zudoku 0.0.0-fd8f8ad → 0.0.0-feda542

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

@@ -1,22 +1,29 @@
+import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
 import { useState } from "react";
+import { Badge } from "zudoku/ui/Badge.js";
 import { Heading } from "../../components/Heading.js";
 import { Markdown, ProseClasses } from "../../components/Markdown.js";
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../ui/Tabs.js";
+import { cn } from "../../util/cn.js";
 import { groupBy } from "../../util/groupBy.js";
 import { renderIf } from "../../util/renderIf.js";
 import { OperationsFragment } from "./OperationList.js";
 import { ParameterList } from "./ParameterList.js";
 import { Sidecar } from "./Sidecar.js";
-import { FragmentType, useFragment } from "./graphql/index.js";
+import { SelectOnClick } from "./components/SelectOnClick.js";
+import { type FragmentType, useFragment } from "./graphql/index.js";
 import { SchemaView } from "./schema/SchemaView.js";
+import { methodForColor } from "./util/methodToColor.js";
 
-export const PARAM_GROUPS = ["path", "query", "header", "cookie"] as const;
+const PARAM_GROUPS = ["path", "query", "header", "cookie"] as const;
 export type ParameterGroup = (typeof PARAM_GROUPS)[number];
 
 export const OperationListItem = ({
   operationFragment,
+  serverUrl,
 }: {
   operationFragment: FragmentType<typeof OperationsFragment>;
+  serverUrl?: string;
 }) => {
   const operation = useFragment(OperationsFragment, operationFragment);
   const groupedParameters = groupBy(
@@ -28,101 +35,142 @@ export const OperationListItem = ({
   const [selectedResponse, setSelectedResponse] = useState(first?.statusCode);
 
   return (
-    <div
-      key={operation.operationId}
-      className="grid grid-cols-1 lg:grid-cols-[4fr_3fr] gap-8 items-start border-b-2 mb-16 pb-16"
-    >
-      <div className="flex flex-col gap-4">
-        <Heading level={2} id={operation.slug} registerSidebarAnchor>
+    <div>
+      {operation.deprecated && (
+        <Badge variant="muted" className="text-xs mb-4">
+          deprecated
+        </Badge>
+      )}
+      <div
+        key={operation.operationId}
+        className={cn(
+          "grid grid-cols-1 lg:grid-cols-[minmax(0,4fr)_minmax(0,3fr)] gap-x-8 gap-y-4 items-start",
+          operation.deprecated && "opacity-50 transition hover:opacity-100",
+        )}
+      >
+        <Heading
+          level={2}
+          id={operation.slug}
+          registerSidebarAnchor
+          className="break-all col-span-full"
+        >
           {operation.summary}
         </Heading>
-        {operation.description && (
-          <Markdown
-            className={`${ProseClasses} max-w-full prose-img:max-w-prose`}
-            content={operation.description}
-          />
-        )}
-        {operation.parameters && operation.parameters.length > 0 && (
-          <>
-            {PARAM_GROUPS.flatMap((group) =>
-              groupedParameters[group]?.length ? (
-                <ParameterList
-                  key={group}
-                  id={operation.slug}
-                  parameters={groupedParameters[group]}
-                  group={group}
-                />
-              ) : (
-                []
-              ),
+        <div className="text-sm flex gap-2 font-mono col-span-full">
+          <span className={methodForColor(operation.method)}>
+            {operation.method.toUpperCase()}
+          </span>
+          <SelectOnClick className="max-w-full truncate flex cursor-pointer">
+            {serverUrl && (
+              <div className="text-neutral-400 dark:text-neutral-500 truncate">
+                {serverUrl.replace(/\/$/, "")}
+              </div>
             )}
-          </>
-        )}
-        {renderIf(operation.requestBody?.content?.at(0)?.schema, (schema) => (
-          <div className="mt-4 flex flex-col gap-4">
-            <Heading
-              level={3}
-              className="capitalize"
-              id={`${operation.slug}/request-body`}
-              registerSidebarAnchor
-            >
-              Request Body
-            </Heading>
-            <SchemaView schema={schema} />
-          </div>
-        ))}
-        {operation.responses.length > 0 && (
-          <>
-            <Heading
-              level={3}
-              className="capitalize mt-8 pt-8 border-t"
-              id={`${operation.slug}/responses`}
-              registerSidebarAnchor
-            >
-              Responses
-            </Heading>
-            <Tabs
-              onValueChange={(value) => setSelectedResponse(value)}
-              value={selectedResponse}
-            >
-              {operation.responses.length > 1 && (
-                <TabsList>
+            <div className="text-neutral-900 dark:text-neutral-200">
+              {operation.path}
+            </div>
+          </SelectOnClick>
+        </div>
+
+        <div className="flex flex-col gap-4">
+          {operation.description && (
+            <Markdown
+              className={`${ProseClasses} max-w-full prose-img:max-w-prose`}
+              content={operation.description}
+            />
+          )}
+          {operation.parameters && operation.parameters.length > 0 && (
+            <>
+              {PARAM_GROUPS.flatMap((group) =>
+                groupedParameters[group]?.length ? (
+                  <ParameterList
+                    key={group}
+                    summary={operation.summary ?? undefined}
+                    id={operation.slug}
+                    parameters={groupedParameters[group]}
+                    group={group}
+                  />
+                ) : (
+                  []
+                ),
+              )}
+            </>
+          )}
+          {renderIf(operation.requestBody?.content?.at(0)?.schema, (schema) => (
+            <div className="mt-4 flex flex-col gap-4">
+              <Heading
+                level={3}
+                className="capitalize flex items-center gap-2"
+                id={`${operation.slug}/request-body`}
+              >
+                {operation.summary && (
+                  <VisuallyHidden>{operation.summary} &rsaquo; </VisuallyHidden>
+                )}
+                Request Body{" "}
+                {operation.requestBody?.required === false ? (
+                  <Badge variant="muted">optional</Badge>
+                ) : (
+                  ""
+                )}
+              </Heading>
+              <SchemaView schema={schema} />
+            </div>
+          ))}
+          {operation.responses.length > 0 && (
+            <>
+              <Heading
+                level={3}
+                className="capitalize mt-8 pt-8 border-t"
+                id={`${operation.slug}/responses`}
+              >
+                {operation.summary && (
+                  <VisuallyHidden>{operation.summary} &rsaquo; </VisuallyHidden>
+                )}
+                Responses
+              </Heading>
+              <Tabs
+                onValueChange={(value) => setSelectedResponse(value)}
+                value={selectedResponse}
+              >
+                {operation.responses.length > 1 && (
+                  <TabsList>
+                    {operation.responses.map((response) => (
+                      <TabsTrigger
+                        value={response.statusCode}
+                        key={response.statusCode}
+                        title={response.description ?? undefined}
+                      >
+                        {response.statusCode}
+                      </TabsTrigger>
+                    ))}
+                  </TabsList>
+                )}
+                <ul className="list-none m-0 px-0">
                   {operation.responses.map((response) => (
-                    <TabsTrigger
+                    <TabsContent
                       value={response.statusCode}
                       key={response.statusCode}
-                      title={response.description ?? undefined}
                     >
-                      {response.statusCode}
-                    </TabsTrigger>
+                      <SchemaView
+                        schema={
+                          response.content?.find((content) => content.schema)
+                            ?.schema
+                        }
+                      />
+                    </TabsContent>
                   ))}
-                </TabsList>
-              )}
-              <ul className="list-none m-0 px-0">
-                {operation.responses.map((response) => (
-                  <TabsContent
-                    value={response.statusCode}
-                    key={response.statusCode}
-                  >
-                    <SchemaView
-                      schema={
-                        response.content?.find((content) => content.schema)
-                          ?.schema
-                      }
-                    />
-                  </TabsContent>
-                ))}
-              </ul>
-            </Tabs>
-          </>
-        )}
-      </div>
+                </ul>
+              </Tabs>
+            </>
+          )}
+        </div>
 
-      <Sidecar
-        selectedResponse={selectedResponse}
-        onSelectResponse={setSelectedResponse}
-        operation={operation}
-      />
+        <Sidecar
+          selectedResponse={selectedResponse}
+          onSelectResponse={setSelectedResponse}
+          operation={operation}
+        />
+      </div>
     </div>
   );
 };

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

@@ -0,0 +1,87 @@
+import { ChevronsLeftRightIcon } from "lucide-react";
+import { isValidElement, useState } from "react";
+import { InlineCode } from "../../components/InlineCode.js";
+import { type SchemaObject } from "../../oas/parser/index.js";
+import { cn } from "../../util/cn.js";
+
+const Pattern = ({ pattern }: { pattern: string }) => {
+  const [isExpanded, setIsExpanded] = useState(false);
+  const isExpandable = pattern.length > 20;
+  const shortPattern = isExpandable ? `${pattern.slice(0, 20)}…` : pattern;
+
+  return (
+    <InlineCode
+      className={cn("text-xs", isExpandable && "cursor-pointer")}
+      onClick={() => setIsExpanded(!isExpanded)}
+      selectOnClick={false}
+    >
+      {isExpanded ? pattern : shortPattern}
+      {isExpandable && (
+        <button type="button" className="p-1 translate-y-[2px]">
+          {!isExpanded && <ChevronsLeftRightIcon size={12} />}
+        </button>
+      )}
+    </InlineCode>
+  );
+};
+
+const getSchemaInfos = (schema?: SchemaObject) => {
+  if (!schema) return [];
+
+  return [
+    schema.type === "array" && schema.items.type
+      ? `${schema.items.type}[]`
+      : Array.isArray(schema.type)
+        ? schema.type.join(" | ")
+        : schema.type,
+
+    schema.enum && "enum",
+    schema.format,
+    schema.minimum && `min: ${schema.minimum}`,
+    schema.maximum && `max: ${schema.maximum}`,
+    schema.minLength && `minLength: ${schema.minLength}`,
+    schema.maxLength && `maxLength: ${schema.maxLength}`,
+    schema.minItems && `minItems: ${schema.minItems}`,
+    schema.maxItems && `maxItems: ${schema.maxItems}`,
+    schema.uniqueItems && "unique",
+    schema.minProperties && `minProps: ${schema.minProperties}`,
+    schema.maxProperties && `maxProps: ${schema.maxProperties}`,
+    schema.readOnly && "readOnly",
+    schema.writeOnly && "writeOnly",
+    schema.deprecated && "deprecated",
+    schema.pattern && (
+      <>
+        pattern: <Pattern pattern={schema.pattern} />
+      </>
+    ),
+  ];
+};
+
+export const ParamInfos = ({
+  schema,
+  extraItems = [],
+  className,
+}: {
+  schema?: SchemaObject;
+  extraItems?: unknown[];
+  className?: string;
+}) => {
+  const filteredItems = [...getSchemaInfos(schema), ...extraItems].flatMap(
+    (item) => (typeof item === "string" || isValidElement(item) ? item : []),
+  );
+
+  return (
+    <span className={className}>
+      {filteredItems.map((item, index) => (
+        <span className="text-muted-foreground" key={index}>
+          {item}
+          {index < filteredItems.length - 1 && (
+            <span className="text-muted-foreground/50">
+              &nbsp;&middot;&nbsp;
+            </span>
+          )}
+        </span>
+      ))}
+    </span>
+  );
+};

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

@@ -1,3 +1,4 @@
+import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
 import { Heading } from "../../components/Heading.js";
 import { Card } from "../../ui/Card.js";
 import type { ParameterGroup } from "./OperationListItem.js";
@@ -7,16 +8,19 @@ import {
 } from "./ParameterListItem.js";
 
 export const ParameterList = ({
+  summary,
   group,
   parameters,
   id,
 }: {
+  summary?: string;
   group: ParameterGroup;
   parameters: ParameterListItemResult[];
   id: string;
 }) => (
   <>
     <Heading level={3} id={`${id}/${group}-parameters`} className="capitalize">
+      {summary && <VisuallyHidden>{summary} &rsaquo; </VisuallyHidden>}
       {group === "header" ? "Headers" : `${group} Parameters`}
     </Heading>
     <Card>

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

@@ -3,6 +3,10 @@ import { type SchemaObject } from "../../oas/graphql/index.js";
 import { ColorizedParam } from "./ColorizedParam.js";
 import type { OperationListItemResult } from "./OperationList.js";
 import type { ParameterGroup } from "./OperationListItem.js";
+import { ParamInfos } from "./ParamInfos.js";
+import { EnumValues } from "./components/EnumValues.js";
+import { SelectOnClick } from "./components/SelectOnClick.js";
+import { SchemaExampleAndDefault } from "./schema/SchemaExampleAndDefault.js";
 
 const getParameterSchema = (
   parameter: ParameterListItemResult,
@@ -31,31 +35,32 @@ export const ParameterListItem = ({
   const paramSchema = getParameterSchema(parameter);
 
   return (
-    <li className="p-4 bg-border/20 text-sm flex flex-col gap-1">
+    <li className="p-4 bg-border/20 text-sm flex flex-col gap-1.5">
       <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>
-        )}
-        {paramSchema.type && (
-          <span className="text-muted-foreground">
-            {paramSchema.type === "array"
-              ? `${paramSchema.items.type}[]`
-              : paramSchema.type}
-          </span>
-        )}
+        <SelectOnClick asChild>
+          <code>
+            {group === "path" ? (
+              <ColorizedParam
+                name={parameter.name}
+                backgroundOpacity="15%"
+                className="px-2"
+                slug={`${id}-${parameter.name}`}
+              />
+            ) : (
+              parameter.name
+            )}
+          </code>
+        </SelectOnClick>
+        <ParamInfos
+          schema={paramSchema}
+          extraItems={[
+            parameter.required && (
+              <span className="text-primary">required</span>
+            ),
+            parameter.style && `style: ${parameter.style}`,
+            parameter.explode && `explode: ${parameter.explode}`,
+          ]}
+        />
       </div>
       {parameter.description && (
         <Markdown
@@ -63,6 +68,12 @@ export const ParameterListItem = ({
           className="text-sm prose-p:my-1 prose-code:whitespace-pre-line"
         />
       )}
+      {paramSchema.type === "array" && paramSchema.items.enum ? (
+        <EnumValues values={paramSchema.items.enum} />
+      ) : (
+        paramSchema.enum && <EnumValues values={paramSchema.enum} />
+      )}
+      <SchemaExampleAndDefault schema={paramSchema} />
     </li>
   );
 };

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

@@ -1,20 +1,33 @@
+import { useAuth } from "zudoku/components";
 import type { OperationListItemResult } from "./OperationList.js";
 import { PlaygroundDialog } from "./playground/PlaygroundDialog.js";
+import { Content } from "./SidecarExamples.js";
 
 export const PlaygroundDialogWrapper = ({
   server,
   servers,
   operation,
+  examples,
 }: {
-  server: string;
+  server?: string;
   servers?: string[];
   operation: OperationListItemResult;
+  examples?: Content;
 }) => {
+  const { isAuthEnabled, login, signup, isPending, isAuthenticated } =
+    useAuth();
+
   const headers = operation.parameters
     ?.filter((p) => p.in === "header")
+    .sort((a, b) => (a.required && !b.required ? -1 : 1))
     .map((p) => ({
       name: p.name,
-      defaultValue: p.examples?.find((x) => x.value)?.value ?? "",
+      defaultValue:
+        p.schema?.default ?? p.examples?.find((x) => x.value)?.value ?? "",
+      defaultActive: p.required ?? false,
+      isRequired: p.required ?? false,
+      enum: p.schema?.type == "array" ? p.schema?.items?.enum : p.schema?.enum,
+      type: p.schema?.type ?? "string",
     }));
   const queryParams = operation.parameters
     ?.filter((p) => p.in === "query")
@@ -23,6 +36,8 @@ export const PlaygroundDialogWrapper = ({
       name: p.name,
       defaultActive: p.required ?? false,
       isRequired: p.required ?? false,
+      enum: p.schema?.type == "array" ? p.schema?.items?.enum : p.schema?.enum,
+      type: p.schema?.type ?? "string",
     }));
   const pathParams = operation.parameters
     ?.filter((p) => p.in === "path")
@@ -37,6 +52,10 @@ export const PlaygroundDialogWrapper = ({
       headers={headers}
       queryParams={queryParams}
       pathParams={pathParams}
+      examples={examples}
+      requiresLogin={isAuthEnabled && !isAuthenticated && !isPending}
+      onLogin={() => login()}
+      onSignUp={() => signup()}
     />
   );
 };

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

@@ -1,44 +1,21 @@
-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";
+import { type Content, SidecarExamples } from "./SidecarExamples.js";
 
-type Content = NonNullable<
-  NonNullable<OperationListItemResult["requestBody"]>["content"]
->;
-
-// @todo should we handle multiple content types?
-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)
-      : "");
+export const RequestBodySidecarBox = ({
+  content,
+  onExampleChange,
+}: {
+  content: Content;
+  onExampleChange?: (example: unknown) => void;
+}) => {
+  if (content.length === 0) return null;
 
   return (
-    <>
-      <SidecarBox.Root>
-        <SidecarBox.Head className="text-xs flex justify-between items-center">
-          <span className="font-mono">Request Body Example</span>
-        </SidecarBox.Head>
-        <SidecarBox.Body className="p-0">
-          <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>
-    </>
+    <SidecarBox.Root>
+      <SidecarBox.Head className="text-xs flex justify-between items-center">
+        <span className="font-mono">Request Body Example</span>
+      </SidecarBox.Head>
+      <SidecarExamples content={content} onExampleChange={onExampleChange} />
+    </SidecarBox.Root>
   );
 };