zudoku 0.0.0-feat-bundled-types.9aa135e → 0.0.0-feat-openapi-docs-redesign.dab3fc6a

package/src/lib/plugins/openapi/playground/result-panel/ResponseTab.tsx

@@ -1,13 +1,22 @@
 import { useQuery } from "@tanstack/react-query";
-import { ChevronRightIcon, DownloadIcon } from "lucide-react";
-import { Fragment, useState } from "react";
+import {
+  CornerDownLeftIcon,
+  CornerDownRightIcon,
+  DownloadIcon,
+  EyeIcon,
+  EyeOffIcon,
+  MinusCircleIcon,
+  PlusCircleIcon,
+  SquareCodeIcon,
+} from "lucide-react";
+import { useState } from "react";
 import { Button } from "zudoku/ui/Button.js";
-import { Callout } from "zudoku/ui/Callout.js";
 import {
   Collapsible,
   CollapsibleContent,
   CollapsibleTrigger,
 } from "zudoku/ui/Collapsible.js";
+import { SecretText } from "zudoku/ui/Secret.js";
 import {
   Select,
   SelectContent,
@@ -15,24 +24,16 @@ import {
   SelectTrigger,
   SelectValue,
 } from "zudoku/ui/Select.js";
-import { Card } from "../../../../ui/Card.js";
-import { SyntaxHighlight } from "../../../../ui/SyntaxHighlight.js";
+import { SyntaxHighlight } from "zudoku/ui/SyntaxHighlight.js";
+import { cn } from "../../../../util/cn.js";
+import createVariantComponent from "../../../../util/createVariantComponent.js";
 import { humanFileSize } from "../../../../util/humanFileSize.js";
+import {
+  CollapsibleHeader,
+  CollapsibleHeaderTrigger,
+} from "../CollapsibleHeader.js";
 import { convertToTypes } from "./convertToTypes.js";
 
-const statusCodeMap: Record<number, string> = {
-  200: "OK",
-  201: "Created",
-  202: "Accepted",
-  204: "No Content",
-  400: "Bad Request",
-  401: "Unauthorized",
-  403: "Forbidden",
-  404: "Not Found",
-  405: "Method Not Allowed",
-  500: "Internal Server Error",
-};
-
 const mimeTypeToLanguage = (mimeType: string) => {
   const mimeTypeMapping = {
     "application/json": "json",
@@ -51,7 +52,7 @@ const mimeTypeToLanguage = (mimeType: string) => {
 
 const detectLanguage = (headers: Array<[string, string]>) => {
   const contentType =
-    headers.find(([key, value]) => key === "Content-Type")?.[1] || "";
+    headers.find(([key]) => key.toLowerCase() === "content-type")?.[1] || "";
   return mimeTypeToLanguage(contentType);
 };
 
@@ -86,25 +87,64 @@ const sortHeadersByRelevance = (
   });
 };
 
-const SYNTAX_HIGHLIGHT_MAX_SIZE_THRESHOLD = 64_000;
+const MAX_HEADERS_TO_SHOW = 3;
+
+const Row = createVariantComponent(
+  "div",
+  "grid-cols-subgrid grid border-b col-span-full px-4 py-1.5 font-mono text-xs",
+);
+
+const RowContent = createVariantComponent("div", "py-1 break-words");
+const RowValue = ({ value, header }: { value: string; header: string }) => {
+  const secretHeaders = ["authorization", "key", "secret", "token"];
+  const isSecret = secretHeaders.includes(header.toLowerCase());
+  const [revealed, setRevealed] = useState(!isSecret);
+  return (
+    <RowContent
+      className={cn(
+        "max-h-28 overflow-auto",
+        isSecret && "cursor-pointer flex group",
+      )}
+      onClick={() => {
+        if (isSecret) {
+          setRevealed((prev) => !prev);
+        }
+      }}
+    >
+      {!isSecret ? (
+        value
+      ) : (
+        <>
+          <SecretText secret={value} previewChars={0} revealed={revealed} />
+          {revealed ? (
+            <EyeOffIcon size={14} className={cn("hidden group-hover:block")} />
+          ) : (
+            <EyeIcon size={14} className={cn("hidden group-hover:block")} />
+          )}
+        </>
+      )}
+    </RowContent>
+  );
+};
 
 export const ResponseTab = ({
   body = "",
   headers,
-  status,
-  time,
+  request,
   size,
-  url,
   isBinary = false,
   fileName,
   blob,
 }: {
   body?: string;
   headers: Array<[string, string]>;
-  status: number;
-  time: number;
+  request: {
+    method: string;
+    url: string;
+    headers: Array<[string, string]>;
+    body?: string;
+  };
   size: number;
-  url: string;
   isBinary?: boolean;
   fileName?: string;
   blob?: Blob;
@@ -138,36 +178,89 @@ export const ResponseTab = ({
   };
 
   const sortedHeaders = sortHeadersByRelevance([...headers]);
-  const shouldDisableHighlighting = size > SYNTAX_HIGHLIGHT_MAX_SIZE_THRESHOLD;
 
   return (
-    <div className="flex flex-col gap-2 h-full overflow-auto max-h-[calc(100vh-220px)] ">
+    <>
+      <Collapsible defaultOpen>
+        <CollapsibleHeaderTrigger>
+          <CornerDownRightIcon size={14} />
+          <CollapsibleHeader>Request Headers</CollapsibleHeader>
+        </CollapsibleHeaderTrigger>
+        <CollapsibleContent>
+          <div className="grid grid-cols-[2fr_3fr] gap-x-6 text-sm">
+            {request.headers
+              .slice(0, MAX_HEADERS_TO_SHOW)
+              .map(([key, value]) => (
+                <Row key={key}>
+                  <RowContent>{key}</RowContent>
+                  <RowValue value={value} header={key} />
+                </Row>
+              ))}
+            {request.headers.length > MAX_HEADERS_TO_SHOW && (
+              <Collapsible className="col-span-full grid-cols-subgrid grid group">
+                <CollapsibleTrigger className="data-[state=open]:hidden justify-center col-span-2 text-xs text-muted-foreground hover:text-primary border-b h-8 flex items-center gap-2">
+                  Show {request.headers.length - MAX_HEADERS_TO_SHOW} more
+                  headers
+                  <PlusCircleIcon size={12} className="text-muted-foreground" />
+                </CollapsibleTrigger>
+                <CollapsibleContent className="col-span-full grid grid-cols-subgrid">
+                  {request.headers
+                    .slice(MAX_HEADERS_TO_SHOW)
+                    .map(([key, value]) => (
+                      <Row key={key}>
+                        <RowContent>{key}</RowContent>
+                        <RowValue value={value} header={key} />
+                      </Row>
+                    ))}
+                  <CollapsibleTrigger className="justify-center col-span-2 text-xs text-muted-foreground hover:text-primary border-b h-8 flex items-center gap-2">
+                    Hide {request.headers.length - MAX_HEADERS_TO_SHOW} headers
+                    <MinusCircleIcon
+                      size={12}
+                      className="text-muted-foreground"
+                    />
+                  </CollapsibleTrigger>
+                </CollapsibleContent>
+              </Collapsible>
+            )}
+          </div>
+        </CollapsibleContent>
+      </Collapsible>
+
       <Collapsible defaultOpen>
-        <CollapsibleTrigger className="flex items-center gap-2 hover:text-primary group">
-          <ChevronRightIcon className="h-4 w-4 transition-transform duration-200 group-data-[state=open]:rotate-[90deg]" />
-          <span className="font-semibold">Headers</span>
-        </CollapsibleTrigger>
+        <CollapsibleHeaderTrigger>
+          <CornerDownLeftIcon size={14} />
+          <CollapsibleHeader>Response Headers</CollapsibleHeader>
+        </CollapsibleHeaderTrigger>
         <CollapsibleContent>
-          <div className="grid grid-cols-[auto,1fr] gap-x-8 gap-y-1 ps-1.5 pt-2 font-mono text-xs">
-            {sortedHeaders.slice(0, 5).map(([key, value]) => (
-              <Fragment key={key}>
-                <div className="text-primary whitespace-pre">{key}</div>
-                <div className="break-all">{value}</div>
-              </Fragment>
+          <div className="grid grid-cols-[2fr_3fr] gap-x-6 text-sm">
+            {sortedHeaders.slice(0, MAX_HEADERS_TO_SHOW).map(([key, value]) => (
+              <Row key={key}>
+                <RowContent>{key}</RowContent>
+                <RowValue value={value} header={key} />
+              </Row>
             ))}
-            {sortedHeaders.length > 5 && (
-              <Collapsible className="col-span-full grid-cols-subgrid grid">
-                <CollapsibleTrigger className="col-span-2 text-xs text-muted-foreground hover:text-primary flex items-center gap-1 py-1">
-                  <ChevronRightIcon className="h-3 w-3 transition-transform duration-200 group-data-[state=open]:rotate-[90deg]" />
-                  Show {sortedHeaders.length - 5} more headers
+            {sortedHeaders.length > MAX_HEADERS_TO_SHOW && (
+              <Collapsible className="col-span-full grid-cols-subgrid grid group">
+                <CollapsibleTrigger className="data-[state=open]:hidden justify-center col-span-2 text-xs text-muted-foreground hover:text-primary border-b h-8 flex items-center gap-2">
+                  Show {sortedHeaders.length - MAX_HEADERS_TO_SHOW} more headers
+                  <PlusCircleIcon size={12} className="text-muted-foreground" />
                 </CollapsibleTrigger>
-                <CollapsibleContent className="col-span-full grid grid-cols-subgrid gap-x-8 gap-y-1 ">
-                  {sortedHeaders.slice(5).map(([key, value]) => (
-                    <Fragment key={key}>
-                      <div className="text-primary whitespace-pre">{key}</div>
-                      <div className="break-all">{value}</div>
-                    </Fragment>
-                  ))}
+                <CollapsibleContent className="col-span-full grid grid-cols-subgrid">
+                  {sortedHeaders
+                    .slice(MAX_HEADERS_TO_SHOW)
+                    .map(([key, value]) => (
+                      <Row key={key}>
+                        <RowContent>{key}</RowContent>
+                        <RowValue value={value} header={key} />
+                      </Row>
+                    ))}
+                  <CollapsibleTrigger className="justify-center col-span-2 text-xs text-muted-foreground hover:text-primary border-b h-8 flex items-center gap-2">
+                    Hide {sortedHeaders.length - MAX_HEADERS_TO_SHOW} headers
+                    <MinusCircleIcon
+                      size={12}
+                      className="text-muted-foreground"
+                    />
+                  </CollapsibleTrigger>
                 </CollapsibleContent>
               </Collapsible>
             )}
@@ -175,7 +268,30 @@ export const ResponseTab = ({
         </CollapsibleContent>
       </Collapsible>
 
-      <Card className="shadow-none">
+      <div className="flex gap-2 justify-between items-center border-b px-2 flex-0">
+        <CollapsibleHeader className="flex items-center gap-2">
+          <SquareCodeIcon size={14} />
+          Response body
+        </CollapsibleHeader>
+        {jsonContent && !isBinary && (
+          <Select
+            value={view}
+            onValueChange={(value) =>
+              setView(value as "formatted" | "raw" | "types")
+            }
+          >
+            <SelectTrigger className="max-w-32 border-0 bg-transparent">
+              <SelectValue placeholder="View" />
+            </SelectTrigger>
+            <SelectContent>
+              <SelectItem value="formatted">Formatted</SelectItem>
+              <SelectItem value="raw">Raw</SelectItem>
+              <SelectItem value="types">Types</SelectItem>
+            </SelectContent>
+          </Select>
+        )}
+      </div>
+      <div className="flex-1">
         {isBinary ? (
           <div className="p-4 text-center">
             <div className="flex flex-col items-center gap-4">
@@ -195,71 +311,29 @@ export const ResponseTab = ({
             </div>
           </div>
         ) : (
-          <>
-            {shouldDisableHighlighting && (
-              <Callout type="info" className="my-0 p-2">
-                Code highlight is disabled for responses larger than{" "}
-                {humanFileSize(SYNTAX_HIGHLIGHT_MAX_SIZE_THRESHOLD)}
-              </Callout>
-            )}
-            <SyntaxHighlight
-              language={
-                view === "types"
-                  ? "typescript"
-                  : view === "raw"
-                    ? jsonContent
-                      ? "plain"
-                      : detectedLanguage
-                    : "json"
-              }
-              showCopy="always"
-              disabled={shouldDisableHighlighting}
-              noBackground
-              className="overflow-x-auto p-4 text-xs max-h-[calc(83.333vh-180px)]"
-              code={
-                (view === "raw"
-                  ? body
-                  : view === "types"
-                    ? types.data?.lines.join("\n")
-                    : beautifiedBody) ?? ""
-              }
-            />
-          </>
-        )}
-      </Card>
-      <div className="flex gap-2 justify-between items-center">
-        <div className="flex text-xs gap-5 border bg-muted rounded-md p-2 items-center h-8 font-mono">
-          <div>
-            <span className="text-muted-foreground">Status</span> {status}{" "}
-            {statusCodeMap[status] ?? ""}
-          </div>
-          <div>
-            <span className="text-muted-foreground">Time</span>{" "}
-            {time.toFixed(0)}ms
-          </div>
-          <div>
-            <span className="text-muted-foreground">Size</span>{" "}
-            {humanFileSize(size)}
-          </div>
-        </div>
-        {jsonContent && !isBinary && (
-          <div>
-            <Select
-              value={view}
-              onValueChange={(value) => setView(value as "formatted" | "raw")}
-            >
-              <SelectTrigger className="min-w-32">
-                <SelectValue placeholder="View" />
-              </SelectTrigger>
-              <SelectContent>
-                <SelectItem value="formatted">Formatted</SelectItem>
-                <SelectItem value="raw">Raw</SelectItem>
-                <SelectItem value="types">Types</SelectItem>
-              </SelectContent>
-            </Select>
-          </div>
+          <SyntaxHighlight
+            className="text-xs flex-1"
+            embedded
+            fullHeight
+            language={
+              view === "types"
+                ? "typescript"
+                : view === "raw"
+                  ? jsonContent
+                    ? "plain"
+                    : detectedLanguage
+                  : "json"
+            }
+            code={
+              (view === "raw"
+                ? body
+                : view === "types"
+                  ? types.data?.lines.join("\n")
+                  : beautifiedBody) ?? ""
+            }
+          />
         )}
       </div>
-    </div>
+    </>
   );
 };

package/src/lib/plugins/openapi/playground/result-panel/ResultPanel.tsx

@@ -1,122 +1,98 @@
-import { type UseMutationResult } from "@tanstack/react-query";
-import { Spinner } from "../../../../components/Spinner.js";
+import type { UseMutationResult } from "@tanstack/react-query";
+import { SendIcon, UnplugIcon } from "lucide-react";
+import { Spinner } from "zudoku/components";
+import { Alert, AlertDescription, AlertTitle } from "zudoku/ui/Alert.js";
 import { Button } from "../../../../ui/Button.js";
-import { Callout } from "../../../../ui/Callout.js";
-import {
-  Card,
-  CardContent,
-  CardHeader,
-  CardTitle,
-} from "../../../../ui/Card.js";
-import {
-  Tabs,
-  TabsContent,
-  TabsList,
-  TabsTrigger,
-} from "../../../../ui/Tabs.js";
 import { cn } from "../../../../util/cn.js";
-import { type PlaygroundResult } from "../Playground.js";
-import { RequestTab } from "./RequestTab.js";
+import type { PlaygroundResult } from "../Playground.js";
+import ResponseStatusBar from "./ResponseStatusBar.js";
 import { ResponseTab } from "./ResponseTab.js";
 
 export const ResultPanel = ({
   queryMutation,
-  showPathParamsWarning,
   showLongRunningWarning,
   onCancel,
+  tip,
+  isFinished,
+  progress,
 }: {
+  // biome-ignore lint/suspicious/noExplicitAny: Allow any type
   queryMutation: UseMutationResult<PlaygroundResult, Error, any>;
-  showPathParamsWarning: boolean;
   showLongRunningWarning?: boolean;
   onCancel?: () => void;
+  isFinished: boolean;
+  progress: number;
+  tip?: React.ReactNode;
 }) => {
-  const status = ((queryMutation.data?.status ?? 0) / 100).toFixed(0);
   return (
-    <div className="min-w-0 p-4 py-4 bg-muted/50">
+    <div className="flex flex-col overflow-y-auto h-[80vh] bg-muted/50">
+      {(queryMutation.isPending || queryMutation.data) && (
+        <ResponseStatusBar
+          status={queryMutation.data?.status}
+          time={queryMutation.data?.time}
+          size={queryMutation.data?.size}
+          isFinished={isFinished}
+          progress={progress}
+        />
+      )}
       {queryMutation.error ? (
-        <div className="flex flex-col gap-2">
-          {showPathParamsWarning && (
-            <Callout type="caution">
-              Some path parameters are missing values. Please fill them in to
-              ensure the request is sent correctly.
-            </Callout>
-          )}
-          <Card>
-            <CardHeader>
-              <CardTitle>Request failed</CardTitle>
-            </CardHeader>
-            <CardContent>
-              Error:{" "}
+        <div className="max-w-2/3 mx-auto mt-20">
+          <Alert>
+            <UnplugIcon size={24} strokeWidth={1.5} className="me-5" />
+            <AlertTitle>Request failed</AlertTitle>
+            <AlertDescription>
               {queryMutation.error.message ||
                 String(queryMutation.error) ||
                 "Unexpected error"}
-            </CardContent>
-          </Card>
+            </AlertDescription>
+          </Alert>
         </div>
       ) : queryMutation.data ? (
-        <Tabs defaultValue="response">
-          <TabsList>
-            <TabsTrigger value="request">Request</TabsTrigger>
-            <TabsTrigger value="response">
-              Response
-              <span
-                className={cn(
-                  "text-xs font-mono ms-1",
-                  status === "2" && "text-green-500",
-                  status === "3" && "text-blue-500",
-                  status === "4" && "text-yellow-500",
-                  status === "5" && "text-red-500",
-                )}
-              >
-                ({queryMutation.data.status})
-              </span>
-            </TabsTrigger>
-          </TabsList>
-          <TabsContent value="request">
-            <RequestTab {...queryMutation.data.request} />
-          </TabsContent>
-          <TabsContent value="response">
-            <ResponseTab
-              status={queryMutation.data.status}
-              time={queryMutation.data.time}
-              size={queryMutation.data.size}
-              headers={queryMutation.data.headers}
-              body={queryMutation.data.body}
-              url={queryMutation.data.request.url}
-              isBinary={queryMutation.data.isBinary}
-              fileName={queryMutation.data.fileName}
-              blob={queryMutation.data.blob}
-            />
-          </TabsContent>
-        </Tabs>
-      ) : (
+        <ResponseTab
+          request={queryMutation.data.request}
+          size={queryMutation.data.size}
+          headers={queryMutation.data.headers}
+          body={queryMutation.data.body}
+          isBinary={queryMutation.data.isBinary}
+          fileName={queryMutation.data.fileName}
+          blob={queryMutation.data.blob}
+        />
+      ) : queryMutation.isPending ? (
         <div className="grid place-items-center h-full">
-          {queryMutation.isPending ? (
-            <div className="flex flex-col gap-2 items-center mt-20">
-              <Spinner size={20} />
-              <div
-                className={cn(
-                  "opacity-0 pointer-events-none transition-opacity h-20 text-sm text-muted-foreground duration-300 flex flex-col gap-2 items-center",
-                  showLongRunningWarning && "opacity-100 pointer-events-auto",
-                )}
+          <div className="flex flex-col gap-2 items-center mt-20">
+            <Spinner />
+            <div
+              className={cn(
+                "opacity-0 pointer-events-none transition-opacity h-20 text-sm text-muted-foreground duration-300 flex flex-col gap-2 items-center",
+                showLongRunningWarning && "opacity-100 pointer-events-auto",
+              )}
+            >
+              Looks like the request is taking longer than expected.
+              <Button
+                type="button"
+                onClick={onCancel}
+                size="sm"
+                className="w-fit"
+                variant="outline"
               >
-                Looks like the request is taking longer than expected.
-                <Button
-                  type="button"
-                  onClick={onCancel}
-                  size="sm"
-                  className="w-fit"
-                  variant="outline"
-                >
-                  Cancel
-                </Button>
-              </div>
+                Cancel
+              </Button>
             </div>
-          ) : (
+          </div>
+        </div>
+      ) : (
+        <div className="h-full grid place-items-center">
+          <div className="flex flex-col gap-4 items-center">
+            <SendIcon
+              size={64}
+              className="text-muted-foreground"
+              strokeWidth={1.2}
+            />
             <span className="text-[16px] font-semibold text-muted-foreground">
-              Send a request first to see the response here
+              Send your first request
             </span>
-          )}
+            {tip}
+          </div>
         </div>
       )}
     </div>

package/src/lib/plugins/openapi/playground/result-panel/convertToTypes.ts

@@ -17,7 +17,7 @@ function inferType(value: JsonValue): string {
   return typeof value;
 }
 
-export function generateInterface(obj: JsonObject, indentation = ""): string {
+export function generateInterface(obj: JsonObject, _indentation = ""): string {
   const lines: string[] = ["{"];
 
   for (const [key, value] of Object.entries(obj)) {

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

@@ -1,5 +1,6 @@
 import { create } from "zustand";
 import { createJSONStorage, persist } from "zustand/middleware";
+import { syncZustandState } from "../../../util/syncZustandState.js";
 
 type RememberSkipLoginState = {
   skipLogin: boolean;
@@ -18,3 +19,5 @@ export const useRememberSkipLoginDialog = create<RememberSkipLoginState>()(
     },
   ),
 );
+
+syncZustandState(useRememberSkipLoginDialog);

package/src/lib/plugins/openapi/processors/removeExtensions.test.ts

@@ -1,3 +1,4 @@
+// biome-ignore-all lint/suspicious/noExplicitAny: Allow any type
 import { describe, expect, it } from "vitest";
 import { removeExtensions } from "./removeExtensions.js";
 

package/src/lib/plugins/openapi/processors/removeParameters.test.ts

@@ -1,3 +1,4 @@
+// biome-ignore-all lint/suspicious/noExplicitAny: Allow any type
 import { describe, expect, it } from "vitest";
 import type { OpenAPIDocument } from "../../../oas/parser/index.js";
 import { removeParameters } from "./removeParameters.js";

package/src/lib/plugins/openapi/processors/traverse.ts

@@ -1 +1 @@
-export { traverse, type RecordAny } from "../../../util/traverse.js";
+export { type RecordAny, traverse } from "../../../util/traverse.js";

package/src/lib/plugins/openapi/schema/SchemaExampleAndDefault.tsx

@@ -9,11 +9,11 @@ export const SchemaExampleAndDefault = ({
   const example = schema.examples?.at(0);
   const defaultValue = schema.default;
 
-  if (!example && !defaultValue) return null;
+  if (example === undefined && defaultValue === undefined) return null;
 
   return (
-    <div className="flex flex-col gap-1 text-xs">
-      {example && (
+    <div className="flex flex-col gap-1">
+      {example !== undefined && (
         <div>
           <span className="text-muted-foreground">Example: </span>
           <SelectOnClick className="border rounded-sm px-1 font-mono">
@@ -23,7 +23,7 @@ export const SchemaExampleAndDefault = ({
           </SelectOnClick>
         </div>
       )}
-      {defaultValue && (
+      {defaultValue !== undefined && (
         <div>
           <span className="text-muted-foreground">Default: </span>
           <SelectOnClick className="border rounded-sm px-1 font-mono">