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

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

@@ -1,128 +1,120 @@
-import {
-  type Control,
-  Controller,
-  useFieldArray,
-  useFormContext,
-} from "react-hook-form";
-import { Card } from "zudoku/ui/Card.js";
+import { Unlink2Icon } from "lucide-react";
+import { type Control, useFormContext } from "react-hook-form";
 import { Checkbox } from "zudoku/ui/Checkbox.js";
+import { Collapsible, CollapsibleContent } from "zudoku/ui/Collapsible.js";
 import { Autocomplete } from "../../../components/Autocomplete.js";
-import { Input } from "../../../ui/Input.js";
-import { InlineInput } from "./InlineInput.js";
-import ParamsGrid, { ParamsGridItem } from "./ParamsGrid.js";
-import { type PlaygroundForm, type QueryParam } from "./Playground.js";
+import {
+  CollapsibleHeader,
+  CollapsibleHeaderTrigger,
+} from "./CollapsibleHeader.js";
+import ParamsGrid, {
+  ParamsGridInput,
+  ParamsGridItem,
+  ParamsGridRemoveButton,
+} from "./ParamsGrid.js";
+import type { PlaygroundForm, QueryParam } from "./Playground.js";
+import { useKeyValueFieldManager } from "./request-panel/useKeyValueFieldManager.js";
 
 export const QueryParams = ({
   control,
-  queryParams,
+  schemaQueryParams,
 }: {
   control: Control<PlaygroundForm>;
-  queryParams: QueryParam[];
+  schemaQueryParams: QueryParam[];
 }) => {
-  const { fields } = useFieldArray<PlaygroundForm, "queryParams">({
+  const { watch } = useFormContext<PlaygroundForm>();
+  const watchedQueryParams = watch("queryParams");
+
+  const manager = useKeyValueFieldManager<PlaygroundForm, "queryParams">({
     control,
     name: "queryParams",
+    defaultValue: { name: "", value: "", active: false },
   });
-  const form = useFormContext<PlaygroundForm>();
 
-  const requiredFields = queryParams.map((param) => Boolean(param.isRequired));
+  const requiredFields = schemaQueryParams.map((param) =>
+    Boolean(param.isRequired),
+  );
+
+  const hasSchemaParams = schemaQueryParams.length > 0;
 
   return (
-    <Card className="rounded-lg overflow-hidden">
-      <div className="w-full ">
+    <Collapsible defaultOpen>
+      <CollapsibleHeaderTrigger>
+        <Unlink2Icon size={16} />
+        <CollapsibleHeader>Query Parameters</CollapsibleHeader>
+      </CollapsibleHeaderTrigger>
+      <CollapsibleContent className="CollapsibleContent">
         <ParamsGrid>
-          {fields.map((field, i) => {
-            const currentParam = queryParams.find(
-              (param) => param.name === form.watch(`queryParams.${i}.name`),
+          {manager.fields.map((field, i) => {
+            const currentParam = schemaQueryParams.find(
+              (param) => param.name === watchedQueryParams.at(i)?.name,
             );
+            const hasEnum = currentParam?.enum && currentParam.enum.length > 0;
+            const nameInputProps = manager.getNameInputProps(i);
+            const valueInputProps = manager.getValueInputProps(i);
+
             return (
               <ParamsGridItem key={field.id}>
-                <div key={field.id} className="flex items-center gap-2">
-                  <Controller
-                    control={control}
-                    name={`queryParams.${i}.active`}
-                    render={({ field }) => (
-                      <Checkbox
-                        id={`queryParams.${i}.active`}
-                        className="me-2"
-                        checked={field.value}
-                        onCheckedChange={field.onChange}
+                <Checkbox {...manager.getCheckboxProps(i)} />
+                {!requiredFields[i] ? (
+                  hasSchemaParams ? (
+                    <ParamsGridInput asChild>
+                      <Autocomplete
+                        {...nameInputProps}
+                        value={String(manager.getValue(i, "name"))}
+                        placeholder="Name"
+                        options={schemaQueryParams.map((param) => param.name)}
+                        onChange={(v) => manager.setValue(i, "name", v)}
+                        onSelect={(v) =>
+                          manager.setValue(i, "name", v, { focus: "next" })
+                        }
                       />
-                    )}
-                  />
-                  <Controller
-                    control={control}
-                    render={({ field }) =>
-                      !requiredFields[i] ? (
-                        <Autocomplete
-                          value={field.value}
-                          options={queryParams.map((param) => param.name)}
-                          onChange={(e) => {
-                            field.onChange(e);
-                          }}
-                          className="border-0 shadow-none focus-visible:ring-0 bg-transparent hover:bg-transparent text-xs font-mono"
-                        />
-                      ) : (
-                        <InlineInput asChild>
-                          <label
-                            className="flex items-center cursor-pointer gap-1"
-                            htmlFor={`queryParams.${i}.active`}
-                            title={
-                              requiredFields[i] ? "Required field" : undefined
-                            }
-                          >
-                            {field.value}
-                            {requiredFields[i] && <sup>&nbsp;*</sup>}
-                          </label>
-                        </InlineInput>
-                      )
-                    }
-                    name={`queryParams.${i}.name`}
-                  />
-                </div>
+                    </ParamsGridInput>
+                  ) : (
+                    <ParamsGridInput {...nameInputProps} placeholder="Name" />
+                  )
+                ) : (
+                  <ParamsGridInput asChild>
+                    <label
+                      className="flex items-center cursor-pointer gap-1"
+                      htmlFor={`queryParams.${i}.active`}
+                      title={requiredFields[i] ? "Required field" : undefined}
+                    >
+                      {watchedQueryParams[i]?.name}
+                      {requiredFields[i] && <sup>&nbsp;*</sup>}
+                    </label>
+                  </ParamsGridInput>
+                )}
                 <div className="flex justify-between items-center">
-                  <Controller
-                    control={control}
-                    render={({ field }) => {
-                      const hasEnum =
-                        currentParam?.enum && currentParam.enum.length > 0;
-
-                      if (!hasEnum) {
-                        return (
-                          <Input
-                            {...field}
-                            onChange={(e) => {
-                              field.onChange(e.target.value);
-                              if (e.target.value.length > 0) {
-                                form.setValue(`queryParams.${i}.active`, true);
-                              }
-                            }}
-                            placeholder="Enter value"
-                            className="w-full border-0 shadow-none focus-visible:ring-0 text-xs font-mono"
-                          />
-                        );
-                      }
-
-                      return (
-                        <Autocomplete
-                          value={field.value}
-                          options={currentParam.enum ?? []}
-                          onChange={(e) => {
-                            field.onChange(e);
-                            form.setValue(`queryParams.${i}.active`, true);
-                          }}
-                          className="border-0 shadow-none focus-visible:ring-0 bg-transparent hover:bg-transparent text-xs font-mono"
-                        />
-                      );
-                    }}
-                    name={`queryParams.${i}.value`}
+                  {!hasEnum ? (
+                    <ParamsGridInput
+                      placeholder="Value"
+                      aria-label="Query parameter value"
+                      {...valueInputProps}
+                    />
+                  ) : (
+                    <ParamsGridInput asChild>
+                      <Autocomplete
+                        {...valueInputProps}
+                        value={String(manager.getValue(i, "value"))}
+                        shouldFilter={false}
+                        options={currentParam.enum ?? []}
+                        onChange={(v) => manager.setValue(i, "value", v)}
+                        onSelect={(v) =>
+                          manager.setValue(i, "value", v, { focus: "next" })
+                        }
+                      />
+                    </ParamsGridInput>
+                  )}
+                  <ParamsGridRemoveButton
+                    {...manager.getRemoveButtonProps(i)}
                   />
                 </div>
               </ParamsGridItem>
             );
           })}
         </ParamsGrid>
-      </div>
-    </Card>
+      </CollapsibleContent>
+    </Collapsible>
   );
 };

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

@@ -1,4 +1,6 @@
+import { useState } from "react";
 import { Button } from "zudoku/ui/Button.js";
+import { Checkbox } from "zudoku/ui/Checkbox.js";
 import {
   Dialog,
   DialogContent,
@@ -6,18 +8,28 @@ import {
   DialogFooter,
   DialogTitle,
 } from "zudoku/ui/Dialog.js";
+import { Label } from "zudoku/ui/Label.js";
 
 const RequestLoginDialog = ({
   open,
   setOpen,
   onSignUp,
   onLogin,
+  onSkip,
 }: {
   open: boolean;
   onSignUp?: () => void;
   onLogin?: () => void;
   setOpen: (open: boolean) => void;
+  onSkip?: (rememberSkip: boolean) => void;
 }) => {
+  const [rememberSkip, setRememberSkip] = useState(false);
+
+  const handleSkip = () => {
+    onSkip?.(rememberSkip);
+    setOpen(false);
+  };
+
   return (
     <Dialog open={open} onOpenChange={setOpen}>
       <DialogContent>
@@ -26,8 +38,15 @@ const RequestLoginDialog = ({
           The Playground is a tool for developers to test and explore our APIs.
           To use the Playground, you need to login.
         </DialogDescription>
+        <Label className="flex items-center gap-2 font-normal">
+          <Checkbox
+            checked={rememberSkip}
+            onCheckedChange={(checked) => setRememberSkip(checked === true)}
+          />
+          Don't show this again
+        </Label>
         <DialogFooter className="flex gap-2 sm:justify-between">
-          <Button type="button" variant="ghost" onClick={() => setOpen(false)}>
+          <Button type="button" variant="outline" onClick={handleSkip}>
             Skip
           </Button>
           <div className="flex gap-2">

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

@@ -0,0 +1,87 @@
+import { motion } from "motion/react";
+
+const ball = {
+  width: 5,
+  height: 5,
+  borderRadius: "50%",
+};
+
+const Spinner = () => {
+  return (
+    <motion.div
+      className="flex items-center gap-1"
+      initial="hidden"
+      animate="visible"
+      variants={{
+        visible: {
+          transition: {
+            staggerChildren: 0.2,
+          },
+        },
+      }}
+    >
+      <motion.div
+        className="bg-white/60"
+        variants={{
+          hidden: { opacity: 0, y: 3 },
+          visible: {
+            opacity: 1,
+            y: 0,
+            transition: {
+              y: {
+                type: "spring",
+                stiffness: 300,
+                damping: 10,
+                repeat: Infinity,
+                repeatType: "reverse",
+              },
+            },
+          },
+        }}
+        style={ball}
+      />
+      <motion.div
+        className="bg-white/60"
+        variants={{
+          hidden: { opacity: 0, y: 3 },
+          visible: {
+            opacity: 1,
+            y: 0,
+            transition: {
+              y: {
+                type: "spring",
+                stiffness: 300,
+                damping: 10,
+                repeat: Infinity,
+                repeatType: "reverse",
+              },
+            },
+          },
+        }}
+        style={ball}
+      />
+      <motion.div
+        className="bg-white/60"
+        variants={{
+          hidden: { opacity: 0, y: 3 },
+          visible: {
+            opacity: 1,
+            y: 0,
+            transition: {
+              y: {
+                type: "spring",
+                stiffness: 300,
+                damping: 10,
+                repeat: Infinity,
+                repeatType: "reverse",
+              },
+            },
+          },
+        }}
+        style={ball}
+      />
+    </motion.div>
+  );
+};
+
+export default Spinner;

package/src/lib/plugins/openapi/playground/fileUtils.ts

@@ -16,7 +16,7 @@ export const extractFileName = (
     const filenameMatch = contentDisposition.match(
       /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/,
     );
-    if (filenameMatch && filenameMatch[1]) {
+    if (filenameMatch?.[1]) {
       return filenameMatch[1].replace(/['"]/g, "");
     }
   }

package/src/lib/plugins/openapi/playground/request-panel/MultipartField.tsx

@@ -0,0 +1,91 @@
+import { PaperclipIcon, TrashIcon } from "lucide-react";
+import { useRef } from "react";
+import { Button } from "zudoku/components";
+import { Checkbox } from "zudoku/ui/Checkbox.js";
+import { humanFileSize } from "../../../../util/humanFileSize.js";
+import {
+  ParamsGridInput,
+  ParamsGridItem,
+  ParamsGridRemoveButton,
+} from "../ParamsGrid.js";
+import type { PlaygroundForm } from "../Playground.js";
+import type { useKeyValueFieldManager } from "./useKeyValueFieldManager.js";
+
+type MultipartFieldProps = {
+  index: number;
+  manager: ReturnType<
+    typeof useKeyValueFieldManager<PlaygroundForm, "multipartFormFields">
+  >;
+};
+
+export const MultipartField = ({ index, manager }: MultipartFieldProps) => {
+  const fieldFileInputRef = useRef<HTMLInputElement>(null);
+  const fieldValue = manager.getValue(index, "value");
+
+  return (
+    <ParamsGridItem>
+      <Checkbox
+        {...manager.getCheckboxProps(index)}
+        disabled={!manager.getValue(index, "name")}
+      />
+      <ParamsGridInput
+        {...manager.getNameInputProps(index)}
+        placeholder="Key"
+      />
+      <div className="flex items-center gap-1 flex-1">
+        {fieldValue instanceof File ? (
+          <div className="flex items-center gap-1 flex-1 min-w-0">
+            <div className="flex items-center gap-1 border-b cursor-default">
+              <PaperclipIcon size={12} className="text-muted-foreground" />
+              <span
+                className="text-xs truncate"
+                title={`${fieldValue.name} (${humanFileSize(fieldValue.size)})`}
+              >
+                {fieldValue.name}
+              </span>
+            </div>
+            <Button
+              type="button"
+              variant="ghost"
+              size="icon-xs"
+              className="opacity-50 hover:opacity-100 hover:brightness-95 transition-opacity"
+              onClick={() => manager.setValue(index, "value", "")}
+            >
+              <TrashIcon size={13} />
+            </Button>
+          </div>
+        ) : (
+          <>
+            <ParamsGridInput
+              {...manager.getValueInputProps(index)}
+              placeholder="Value"
+            />
+            <input
+              ref={fieldFileInputRef}
+              type="file"
+              className="hidden"
+              onChange={(e) => {
+                const file = e.target.files?.[0];
+                if (!file) return;
+
+                manager.setValue(index, "value", file);
+                manager.setValue(index, "active", true);
+              }}
+            />
+            <Button
+              type="button"
+              variant="ghost"
+              size="icon-xs"
+              onClick={() => fieldFileInputRef.current?.click()}
+              title="Attach file"
+              className="opacity-0 focus-visible:opacity-100 group-hover:opacity-100 group-hover:brightness-95 transition-opacity"
+            >
+              <PaperclipIcon size={14} />
+            </Button>
+          </>
+        )}
+        <ParamsGridRemoveButton {...manager.getRemoveButtonProps(index)} />
+      </div>
+    </ParamsGridItem>
+  );
+};

package/src/lib/plugins/openapi/playground/request-panel/UrlPath.tsx

@@ -0,0 +1,31 @@
+import { useFormContext } from "react-hook-form";
+import { PathRenderer } from "../../../../components/PathRenderer.js";
+import { ColorizedParam } from "../../ColorizedParam.js";
+import type { PlaygroundForm } from "../Playground.js";
+
+export const UrlPath = ({ url }: { url: string }) => {
+  const { watch, setFocus } = useFormContext<PlaygroundForm>();
+  const [pathParams] = watch(["pathParams"]);
+
+  return (
+    <PathRenderer
+      path={url}
+      renderParam={({ name, originalValue, index }) => {
+        const formValue = pathParams.find(
+          (param) => param.name === name,
+        )?.value;
+
+        return (
+          <ColorizedParam
+            name={name}
+            backgroundOpacity="0"
+            slug={name}
+            onClick={() => setFocus(`pathParams.${index}.value`)}
+          >
+            {formValue || originalValue}
+          </ColorizedParam>
+        );
+      }}
+    />
+  );
+};

package/src/lib/plugins/openapi/playground/request-panel/UrlQueryParams.tsx

@@ -0,0 +1,25 @@
+import { Fragment } from "react";
+import { useFormContext } from "react-hook-form";
+import type { PlaygroundForm } from "../Playground.js";
+
+export const UrlQueryParams = () => {
+  const { watch } = useFormContext<PlaygroundForm>();
+  const queryParams = watch("queryParams");
+
+  const urlQueryParams = queryParams
+    .filter((p) => p.active && p.name)
+    .map((p, i, arr) => (
+      <Fragment key={`${i}-${p.name}`}>
+        {p.name}={encodeURIComponent(p.value).replaceAll("%20", "+")}
+        {i < arr.length - 1 && "&"}
+        <wbr />
+      </Fragment>
+    ));
+
+  return (
+    <>
+      {urlQueryParams.length > 0 ? `?` : ""}
+      {urlQueryParams}
+    </>
+  );
+};