zudoku 0.0.0-ec30b50 → 0.0.0-ee328ec

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

@@ -1,13 +1,18 @@
-import { useRef, useState } from "react";
+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 { useOasConfig } from "./context.js";
+import { type FragmentType, useFragment } from "./graphql/index.js";
 import { SchemaView } from "./schema/SchemaView.js";
 import { methodForColor } from "./util/methodToColor.js";
 
@@ -26,137 +31,155 @@ export const OperationListItem = ({
     operation.parameters ?? [],
     (param) => param.in,
   );
-  const parentRef = useRef<HTMLDivElement>(null);
+  const { options } = useOasConfig();
 
   const first = operation.responses.at(0);
   const [selectedResponse, setSelectedResponse] = useState(first?.statusCode);
 
   return (
-    <div
-      key={operation.operationId}
-      className="grid grid-cols-1 lg:grid-cols-[minmax(0,4fr)_minmax(0,3fr)] gap-8 items-start border-b-2 mb-16 pb-16"
-    >
-      <div className="flex flex-col gap-4">
+    <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"
+          className="break-all col-span-full"
         >
           {operation.summary}
         </Heading>
-        <div className="text-sm flex gap-2 font-mono">
+        <div className="text-sm flex gap-2 font-mono col-span-full">
           <span className={methodForColor(operation.method)}>
             {operation.method.toUpperCase()}
           </span>
-          <div
-            ref={parentRef}
-            className="max-w-full truncate flex cursor-pointer"
-            onClick={() => {
-              if (parentRef.current) {
-                const range = document.createRange();
-                range.selectNodeContents(parentRef.current);
-                const selection = window.getSelection();
-                selection?.removeAllRanges();
-                selection?.addRange(range);
-              }
-            }}
-          >
+          <SelectOnClick className="max-w-full truncate flex cursor-pointer">
             {serverUrl && (
               <div className="text-neutral-400 dark:text-neutral-500 truncate">
-                {serverUrl}
+                {serverUrl.replace(/\/$/, "")}
               </div>
             )}
             <div className="text-neutral-900 dark:text-neutral-200">
               {operation.path}
             </div>
-          </div>
+          </SelectOnClick>
         </div>
-        {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}
-                />
-              ) : (
-                []
-              ),
-            )}
-          </>
-        )}
-        {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`}
-            >
-              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`}
-            >
-              Responses
-            </Heading>
-            <Tabs
-              onValueChange={(value) => setSelectedResponse(value)}
-              value={selectedResponse}
-            >
-              {operation.responses.length > 1 && (
-                <TabsList>
+
+        <div
+          className={cn(
+            "flex flex-col gap-4",
+            options?.disableSidecar && "col-span-full",
+          )}
+        >
+          {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}
-      />
+        {renderIf(!options?.disableSidecar, () => (
+          <Sidecar
+            selectedResponse={selectedResponse}
+            onSelectResponse={setSelectedResponse}
+            operation={operation}
+          />
+        ))}
+      </div>
     </div>
   );
 };

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

@@ -0,0 +1,88 @@
+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.const && "const",
+    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

@@ -1,9 +1,18 @@
-import { Badge } from "zudoku/ui/Badge.js";
+import * as Collapsible from "@radix-ui/react-collapsible";
+import { MinusIcon, PlusIcon } from "lucide-react";
+import { useState } from "react";
 import { Markdown } from "../../components/Markdown.js";
 import { type SchemaObject } from "../../oas/graphql/index.js";
+import { Button } from "../../ui/Button.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";
+import { SchemaView } from "./schema/SchemaView.js";
+import { isArrayType } from "./schema/utils.js";
 
 const getParameterSchema = (
   parameter: ParameterListItemResult,
@@ -30,31 +39,35 @@ export const ParameterListItem = ({
   id: string;
 }) => {
   const paramSchema = getParameterSchema(parameter);
+  const [isOpen, setIsOpen] = useState(false);
 
   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%"
-              className="px-1"
-              slug={`${id}-${parameter.name}`}
-            />
-          ) : (
-            parameter.name
-          )}
-        </code>
-        {paramSchema.type && (
-          <Badge variant="muted">
-            {paramSchema.type === "array"
-              ? `${paramSchema.items.type}[]`
-              : paramSchema.type}
-          </Badge>
-        )}
-        {parameter.required && <Badge variant="outline">required</Badge>}
-        {parameter.style === "form" && <Badge variant="secondary">form</Badge>}
+        <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
@@ -62,6 +75,35 @@ 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} />
+      {(paramSchema.type === "object" || isArrayType(paramSchema)) && (
+        <Collapsible.Root
+          defaultOpen={false}
+          onOpenChange={setIsOpen}
+          open={isOpen}
+        >
+          <Collapsible.Trigger asChild>
+            <Button variant="expand" size="sm">
+              {isOpen ? <MinusIcon size={12} /> : <PlusIcon size={12} />}
+              {isOpen ? "Hide properties" : "Show properties"}
+            </Button>
+          </Collapsible.Trigger>
+          <Collapsible.Content>
+            <div className="mt-2">
+              <SchemaView
+                schema={
+                  "items" in paramSchema ? paramSchema.items : paramSchema
+                }
+              />
+            </div>
+          </Collapsible.Content>
+        </Collapsible.Root>
+      )}
     </li>
   );
 };

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

@@ -1,3 +1,4 @@
+import { useAuth } from "zudoku/components";
 import type { OperationListItemResult } from "./OperationList.js";
 import { PlaygroundDialog } from "./playground/PlaygroundDialog.js";
 import { Content } from "./SidecarExamples.js";
@@ -8,11 +9,14 @@ export const PlaygroundDialogWrapper = ({
   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))
@@ -49,6 +53,9 @@ export const PlaygroundDialogWrapper = ({
       queryParams={queryParams}
       pathParams={pathParams}
       examples={examples}
+      requiresLogin={isAuthEnabled && !isAuthenticated && !isPending}
+      onLogin={() => login()}
+      onSignUp={() => signup()}
     />
   );
 };