@mehdad67/apitogo 0.1.24

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

@@ -0,0 +1,602 @@
+import { Button } from "@lukoweb/apitogo/ui/Button.js";
+import {
+  Collapsible,
+  CollapsibleContent,
+} from "@lukoweb/apitogo/ui/Collapsible.js";
+import {
+  Select,
+  SelectContent,
+  SelectItem,
+  SelectTrigger,
+  SelectValue,
+} from "@lukoweb/apitogo/ui/Select.js";
+import { TooltipProvider } from "@lukoweb/apitogo/ui/Tooltip.js";
+import { useNProgress } from "@tanem/react-nprogress";
+import { useMutation } from "@tanstack/react-query";
+import {
+  CheckIcon,
+  CopyIcon,
+  IdCardLanyardIcon,
+  ShapesIcon,
+} from "lucide-react";
+import { useEffect, useMemo, useRef, useState, useTransition } from "react";
+import { FormProvider, useForm } from "react-hook-form";
+import { useApiIdentities } from "../../../components/context/ZudokuContext.js";
+import { useHotkey } from "../../../hooks/useHotkey.js";
+import { cn } from "../../../util/cn.js";
+import { useCopyToClipboard } from "../../../util/useCopyToClipboard.js";
+import { useLatest } from "../../../util/useLatest.js";
+import type { MediaTypeObject } from "../graphql/graphql.js";
+import { useSelectedServer } from "../state.js";
+import BodyPanel from "./BodyPanel.js";
+import {
+  CollapsibleHeader,
+  CollapsibleHeaderTrigger,
+} from "./CollapsibleHeader.js";
+import { createUrl } from "./createUrl.js";
+import { extractFileName, isBinaryContentType } from "./fileUtils.js";
+import { Headers } from "./Headers.js";
+import { IdentityDialog } from "./IdentityDialog.js";
+import IdentitySelector from "./IdentitySelector.js";
+import { PathParams } from "./PathParams.js";
+import { QueryParams } from "./QueryParams.js";
+import { useIdentityStore } from "./rememberedIdentity.js";
+import { UrlPath } from "./request-panel/UrlPath.js";
+import { UrlQueryParams } from "./request-panel/UrlQueryParams.js";
+import RequestLoginDialog from "./RequestLoginDialog.js";
+import { ResultPanel } from "./result-panel/ResultPanel.js";
+import { useRememberSkipLoginDialog } from "./useRememberSkipLoginDialog.js";
+
+export const NO_IDENTITY = "__none";
+
+export type Header = {
+  name: string;
+  defaultValue?: string;
+  defaultActive?: boolean;
+  isRequired?: boolean;
+  enum?: string[];
+  type?: string;
+};
+
+export type QueryParam = {
+  name: string;
+  defaultValue?: string;
+  defaultActive?: boolean;
+  isRequired?: boolean;
+  enum?: string[];
+  type?: string;
+  style?: string;
+  explode?: boolean;
+  allowReserved?: boolean;
+};
+
+export type PathParam = {
+  name: string;
+  defaultValue?: string;
+  isRequired?: boolean;
+};
+
+export type PlaygroundForm = {
+  body: string;
+  bodyMode?: "text" | "file" | "multipart";
+  file?: File | null;
+  multipartFormFields: Array<{
+    name: string;
+    value: File | string;
+    active: boolean;
+  }>;
+  queryParams: Array<{
+    name: string;
+    value: string;
+    active: boolean;
+    enum?: string[];
+    type?: string;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+  }>;
+  pathParams: Array<{ name: string; value: string }>;
+  headers: Array<{
+    name: string;
+    value: string;
+    active: boolean;
+    enum?: string[];
+  }>;
+  identity?: string;
+};
+
+export type PlaygroundResult = {
+  status: number;
+  headers: Array<[string, string]>;
+  size: number;
+  body: string;
+  time: number;
+  isBinary?: boolean;
+  fileName?: string;
+  blob?: Blob;
+  request: {
+    method: string;
+    url: string;
+    headers: Array<[string, string]>;
+    body?: string;
+  };
+};
+
+export type PlaygroundContentProps = {
+  server?: string;
+  servers?: string[];
+  url: string;
+  method: string;
+  headers?: Header[];
+  queryParams?: QueryParam[];
+  pathParams?: PathParam[];
+  defaultBody?: string;
+  examples?: MediaTypeObject[];
+  requiresLogin?: boolean;
+  onLogin?: () => void;
+  onSignUp?: () => void;
+};
+
+export const Playground = ({
+  server,
+  servers = [],
+  url,
+  method,
+  headers = [],
+  queryParams = [],
+  pathParams = [],
+  defaultBody = "",
+  examples,
+  requiresLogin = false,
+  onLogin,
+  onSignUp,
+}: PlaygroundContentProps) => {
+  const { selectedServer, setSelectedServer } = useSelectedServer(
+    servers.map((url) => ({ url })),
+  );
+  const [showSelectIdentity, setShowSelectIdentity] = useState(false);
+  const identities = useApiIdentities();
+  const { setRememberedIdentity, getRememberedIdentity } = useIdentityStore();
+  const [, startTransition] = useTransition();
+  const { skipLogin, setSkipLogin } = useRememberSkipLoginDialog();
+  const [isLoginDialogDismissed, setIsLoginDialogDismissed] = useState(false);
+  const [showLongRunningWarning, setShowLongRunningWarning] = useState(false);
+  const abortControllerRef = useRef<AbortController | undefined>(undefined);
+  const latestSetRememberedIdentity = useLatest(setRememberedIdentity);
+  const formRef = useRef<HTMLFormElement>(null);
+
+  const { label: hotkeyLabel } = useHotkey("meta+enter", () => {
+    formRef.current?.requestSubmit();
+  });
+
+  const pathParamOrder =
+    url.match(/\{([^}]+)\}/g)?.map((match) => match.slice(1, -1)) ?? [];
+  const sortedPathParams = [...pathParams].sort(
+    (a, b) => pathParamOrder.indexOf(a.name) - pathParamOrder.indexOf(b.name),
+  );
+
+  const { register, control, handleSubmit, watch, setValue, ...form } =
+    useForm<PlaygroundForm>({
+      defaultValues: {
+        body: defaultBody,
+        bodyMode: "text",
+        file: null,
+        multipartFormFields: [],
+        queryParams:
+          queryParams.length > 0
+            ? queryParams.map((param) => ({
+                name: param.name,
+                value: param.defaultValue ?? "",
+                active: param.defaultActive ?? false,
+                enum: param.enum ?? [],
+                type: param.type,
+                style: param.style,
+                explode: param.explode,
+                allowReserved: param.allowReserved,
+              }))
+            : [{ name: "", value: "", active: false, enum: [] }],
+        pathParams: sortedPathParams.map((param) => ({
+          name: param.name,
+          value: param.defaultValue ?? "",
+        })),
+        headers:
+          headers.length > 0
+            ? headers.map((header) => ({
+                name: header.name,
+                value: header.defaultValue ?? "",
+                active: header.defaultActive ?? false,
+              }))
+            : [{ name: "", value: "", active: false }],
+        identity: getRememberedIdentity([
+          NO_IDENTITY,
+          ...(identities.data?.map((i) => i.id) ?? []),
+        ]),
+      },
+    });
+  const identity = watch("identity");
+
+  const authorizationFields = useMemo(
+    () => identities.data?.find((i) => i.id === identity)?.authorizationFields,
+    [identities.data, identity],
+  );
+
+  useEffect(() => {
+    if (identity) {
+      latestSetRememberedIdentity.current(identity);
+    }
+  }, [latestSetRememberedIdentity, identity]);
+
+  const queryMutation = useMutation({
+    gcTime: 0,
+    mutationFn: async (data: PlaygroundForm) => {
+      const start = performance.now();
+
+      const headers = new window.Headers(
+        data.headers
+          .filter((h) => h.name && h.active)
+          .map<[string, string]>((h) => [h.name, h.value]),
+      );
+
+      let body: string | FormData | File | undefined;
+
+      switch (data.bodyMode) {
+        case "file":
+          body = data.file || undefined;
+          headers.delete("Content-Type");
+          break;
+        case "multipart": {
+          const formData = new FormData();
+          data.multipartFormFields
+            ?.filter((field) => field.name && field.active)
+            .forEach((field) => formData.append(field.name, field.value));
+
+          body = formData;
+          headers.delete("Content-Type");
+          break;
+        }
+        default:
+          body = data.body || undefined;
+          break;
+      }
+
+      const request = new Request(
+        createUrl(server ?? selectedServer, url, data),
+        {
+          method,
+          headers,
+          body: ["GET", "HEAD"].includes(method.toUpperCase()) ? null : body,
+        },
+      );
+
+      if (data.identity !== NO_IDENTITY) {
+        await identities.data
+          ?.find((i) => i.id === data.identity)
+          ?.authorizeRequest(request);
+      }
+
+      const warningTimeout = setTimeout(
+        () => setShowLongRunningWarning(true),
+        3210,
+      );
+      abortControllerRef.current = new AbortController();
+
+      abortControllerRef.current.signal.addEventListener("abort", () => {
+        clearTimeout(warningTimeout);
+      });
+
+      try {
+        const response = await fetch(request, {
+          cache: "no-store",
+          signal: abortControllerRef.current.signal,
+        });
+
+        clearTimeout(warningTimeout);
+        setShowLongRunningWarning(false);
+
+        const time = performance.now() - start;
+        const url = new URL(request.url);
+        const responseHeaders = Array.from(response.headers.entries());
+        const contentType = response.headers.get("content-type") || "";
+        const isBinary = isBinaryContentType(contentType);
+
+        let body = "";
+        let blob: Blob | undefined;
+        let fileName: string | undefined;
+
+        if (isBinary) {
+          blob = await response.blob();
+          fileName = extractFileName(responseHeaders, request.url);
+          body = `Binary content (${contentType})`;
+        } else {
+          body = await response.text();
+        }
+
+        const responseSize = response.headers.get("content-length");
+
+        let requestBody = "";
+
+        switch (data.bodyMode) {
+          case "text":
+            requestBody = data.body;
+            break;
+          case "file":
+            requestBody = `[File: ${data.file?.name ?? "Unknown"}]`;
+            break;
+          case "multipart":
+            requestBody = "[Multipart Form Data]\n";
+            requestBody += data.multipartFormFields
+              ?.filter((f) => f.name && f.active)
+              .map((f) =>
+                f.value instanceof File
+                  ? `${f.name}: [File: ${f.value.name}]`
+                  : `${f.name}: ${f.value}`,
+              )
+              .join("\n");
+            break;
+          default:
+            requestBody = data.body;
+            break;
+        }
+
+        return {
+          status: response.status,
+          headers: responseHeaders,
+          size: responseSize ? Number(responseSize) : body.length,
+          body,
+          time,
+          isBinary,
+          fileName,
+          blob,
+          request: {
+            method: request.method.toUpperCase(),
+            url: request.url,
+            headers: [
+              ["Host", url.host],
+              ["User-Agent", "Zudoku Playground"],
+              ...Array.from(request.headers.entries()),
+            ],
+            body: requestBody,
+          },
+        } satisfies PlaygroundResult;
+      } catch (error) {
+        clearTimeout(warningTimeout);
+        setShowLongRunningWarning(false);
+        if (error instanceof TypeError) {
+          throw new Error(
+            "The request failed, possibly due to network issues or CORS policy.",
+          );
+        } else {
+          throw error;
+        }
+      }
+    },
+  });
+
+  const isRequestAnimating = queryMutation.isPending;
+  const [isAnimating, setIsAnimating] = useState(false);
+
+  useEffect(() => {
+    const timer = setTimeout(() => setIsAnimating(isRequestAnimating), 100);
+    return () => clearTimeout(timer);
+  }, [isRequestAnimating]);
+
+  const { isFinished, progress } = useNProgress({ isAnimating });
+
+  useEffect(() => {
+    return () => {
+      abortControllerRef.current?.abort();
+    };
+  }, []);
+
+  const serverSelect = (
+    <div className="inline-block opacity-50 hover:opacity-100 transition">
+      {server ? (
+        <span>{server.replace(/^https?:\/\//, "").replace(/\/$/, "")}</span>
+      ) : (
+        servers.length > 1 && (
+          <Select
+            onValueChange={(value) => {
+              startTransition(() => setSelectedServer(value));
+            }}
+            value={selectedServer}
+            defaultValue={selectedServer}
+          >
+            <SelectTrigger className="p-0 h-fit shadow-none border-none flex-row-reverse bg-transparent text-xs gap-0.5 translate-y-[4px]">
+              <SelectValue />
+            </SelectTrigger>
+            <SelectContent>
+              {servers.map((s) => (
+                <SelectItem key={s} value={s}>
+                  {s.replace(/^https?:\/\//, "").replace(/\/$/, "")}
+                </SelectItem>
+              ))}
+            </SelectContent>
+          </Select>
+        )
+      )}
+    </div>
+  );
+
+  const showLogin = requiresLogin && !skipLogin && !isLoginDialogDismissed;
+  const isBodySupported = ["POST", "PUT", "PATCH", "DELETE"].includes(
+    method.toUpperCase(),
+  );
+  const [isCopied, copyToClipboard] = useCopyToClipboard();
+
+  return (
+    <FormProvider
+      {...{ register, control, handleSubmit, watch, setValue, ...form }}
+    >
+      <TooltipProvider delayDuration={150}>
+        <form
+          ref={formRef}
+          onKeyDown={(e) => {
+            if (e.key === "Enter" && e.target instanceof HTMLInputElement) {
+              e.preventDefault();
+            }
+          }}
+          onSubmit={handleSubmit((data) => {
+            if (identities.data?.length === 0 || data.identity) {
+              queryMutation.mutate(data);
+            } else {
+              setShowSelectIdentity(true);
+            }
+          })}
+          className="relative"
+        >
+          <IdentityDialog
+            identities={identities.data ?? []}
+            open={showSelectIdentity}
+            onOpenChange={setShowSelectIdentity}
+            onSubmit={({ rememberedIdentity, identity }) => {
+              if (rememberedIdentity) {
+                setValue("identity", identity ?? NO_IDENTITY);
+              }
+              setShowSelectIdentity(false);
+              queryMutation.mutate({ ...form.getValues(), identity });
+            }}
+          />
+          <RequestLoginDialog
+            open={showLogin}
+            setOpen={(open) => {
+              if (!open) {
+                setIsLoginDialogDismissed(true);
+              }
+            }}
+            onSkip={(rememberSkip) => {
+              setIsLoginDialogDismissed(true);
+              if (rememberSkip) {
+                setSkipLogin(true);
+              }
+            }}
+            onSignUp={onSignUp}
+            onLogin={onLogin}
+          />
+
+          <div className="grid grid-cols-[1fr_1px_1fr] text-sm">
+            <div className="col-span-3 p-4 border-b flex gap-2 items-stretch">
+              <div className="flex flex-1 items-center w-full border rounded-md relative overflow-hidden">
+                <div className="border-r p-2 bg-muted rounded-l-md self-stretch font-semibold font-mono flex items-center">
+                  {method.toUpperCase()}
+                </div>
+                <div className="items-center px-2 font-mono text-xs break-all leading-6 relative h-full w-full">
+                  <div className="h-full py-1.5">
+                    {serverSelect}
+                    <UrlPath url={url} />
+                    <UrlQueryParams />
+                  </div>
+                </div>
+                <div className="px-1">
+                  <Button
+                    type="button"
+                    onClick={() => {
+                      copyToClipboard(
+                        createUrl(
+                          server ?? selectedServer,
+                          url,
+                          form.getValues(),
+                        ).toString(),
+                      );
+                    }}
+                    variant="ghost"
+                    size="icon-xs"
+                    className={cn(
+                      "hover:opacity-100 transition",
+                      isCopied ? "text-emerald-600 opacity-100" : "opacity-50",
+                    )}
+                  >
+                    {isCopied ? (
+                      <CheckIcon className="text-green-500" size={14} />
+                    ) : (
+                      <CopyIcon size={14} />
+                    )}
+                  </Button>
+                </div>
+              </div>
+
+              <Button
+                type="submit"
+                variant={queryMutation.isPending ? "destructive" : "default"}
+                onClick={(e) => {
+                  if (queryMutation.isPending) {
+                    abortControllerRef.current?.abort(
+                      "Request cancelled by user",
+                    );
+                    e.preventDefault();
+                  }
+                }}
+                className="w-18"
+              >
+                {queryMutation.isPending ? "Cancel" : "Send"}
+              </Button>
+            </div>
+            <div className="relative overflow-y-auto h-[80vh]">
+              {identities.data?.length !== 0 && (
+                <Collapsible defaultOpen>
+                  <CollapsibleHeaderTrigger>
+                    <IdCardLanyardIcon size={16} />
+                    <CollapsibleHeader>Authentication</CollapsibleHeader>
+                  </CollapsibleHeaderTrigger>
+                  <CollapsibleContent className="CollapsibleContent">
+                    <IdentitySelector
+                      value={identity}
+                      identities={identities.data ?? []}
+                      setValue={(value) => setValue("identity", value)}
+                    />
+                  </CollapsibleContent>
+                </Collapsible>
+              )}
+
+              {sortedPathParams.length > 0 && (
+                <Collapsible defaultOpen>
+                  <CollapsibleHeaderTrigger>
+                    <ShapesIcon size={16} />
+                    <CollapsibleHeader>Path Parameters</CollapsibleHeader>
+                  </CollapsibleHeaderTrigger>
+                  <CollapsibleContent className="CollapsibleContent">
+                    <PathParams url={url} control={control} />
+                  </CollapsibleContent>
+                </Collapsible>
+              )}
+
+              <QueryParams control={control} schemaQueryParams={queryParams} />
+
+              <Headers
+                control={control}
+                schemaHeaders={headers}
+                lockedHeaders={authorizationFields?.headers}
+              />
+              {isBodySupported && <BodyPanel content={examples} />}
+            </div>
+            <div className="w-full bg-muted-foreground/20" />
+            <ResultPanel
+              queryMutation={queryMutation}
+              showLongRunningWarning={showLongRunningWarning}
+              isFinished={isFinished}
+              progress={progress}
+              tip={
+                <div className="text-xs w-full">
+                  <span className="text-muted-foreground">
+                    Press{" "}
+                    <kbd className="text-foreground border rounded m-0.5 px-1 py-0.5 capitalize">
+                      {hotkeyLabel.join(" + ")}
+                    </kbd>{" "}
+                    to send a request
+                  </span>
+                </div>
+              }
+              onCancel={() => {
+                abortControllerRef.current?.abort(
+                  "Request cancelled by the user",
+                );
+                setShowLongRunningWarning(false);
+              }}
+            />
+          </div>
+        </form>
+      </TooltipProvider>
+    </FormProvider>
+  );
+};
+
+export default Playground;

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

@@ -0,0 +1,56 @@
+import { useAuth } from "@lukoweb/apitogo/hooks";
+import { Button } from "@lukoweb/apitogo/ui/Button.js";
+import {
+  Dialog,
+  DialogContent,
+  DialogTitle,
+  DialogTrigger,
+} from "@lukoweb/apitogo/ui/Dialog.js";
+import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
+import { PlayIcon } from "lucide-react";
+import { type PropsWithChildren, useState } from "react";
+import { Playground, type PlaygroundContentProps } from "./Playground.js";
+
+export type PlaygroundDialogProps = PropsWithChildren<PlaygroundContentProps>;
+
+const PlaygroundDialog = (props: PlaygroundDialogProps) => {
+  const [open, setOpen] = useState(false);
+  const { isAuthEnabled, login, signup, isPending, isAuthenticated } =
+    useAuth();
+
+  return (
+    <Dialog onOpenChange={(open) => setOpen(open)}>
+      <DialogTrigger asChild>
+        {props.children ?? (
+          <Button variant="ghost" size="icon-xs" className="group">
+            <PlayIcon
+              className="fill-muted-foreground group-hover:fill-foreground transition"
+              size={16}
+              strokeWidth={1.5}
+            />
+          </Button>
+        )}
+      </DialogTrigger>
+
+      <DialogContent
+        className="max-w-screen-xl! w-full overflow-hidden p-0"
+        aria-describedby={undefined}
+        showCloseButton={true}
+      >
+        <VisuallyHidden>
+          <DialogTitle>Playground</DialogTitle>
+        </VisuallyHidden>
+        {open && (
+          <Playground
+            requiresLogin={isAuthEnabled && !isAuthenticated && !isPending}
+            onLogin={() => login()}
+            onSignUp={() => signup()}
+            {...props}
+          />
+        )}
+      </DialogContent>
+    </Dialog>
+  );
+};
+
+export { PlaygroundDialog };