zudoku 0.3.0-dev.11 → 0.3.0-dev.110

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

@@ -1,10 +1,11 @@
-import * as Collapsible from "@radix-ui/react-collapsible";
-import { ListPlusIcon } from "lucide-react";
-import { useState } from "react";
 import { Markdown } from "../../components/Markdown.js";
 import { SchemaObject } from "../../oas/parser/index.js";
-import { Button } from "../../ui/Button.js";
-import { cn } from "../../util/cn.js";
+import { Card } from "../../ui/Card.js";
+import { groupBy } from "../../util/groupBy.js";
+import { objectEntries } from "../../util/objectEntries.js";
+import { SchemaListViewItem } from "./SchemaListViewItem.js";
+import { SchemaListViewItemGroup } from "./SchemaListViewItemGroup.js";
+import { SchemaProseClasses } from "./util/prose.js";
 
 export const SchemaListView = ({
   name,
@@ -27,202 +28,48 @@ export const SchemaListView = ({
     Array.isArray(additionalProperties) ? additionalProperties : [],
   );
 
-  const groups = Object.groupBy(
-    combinedProperties,
-    ([propertyName, property]) => {
-      return property.deprecated
-        ? "deprecated"
-        : schema.required?.includes(propertyName)
-          ? "required"
-          : "optional";
-    },
-  );
+  const groups = groupBy(combinedProperties, ([propertyName, property]) => {
+    return property.deprecated
+      ? "deprecated"
+      : schema.required?.includes(propertyName)
+        ? "required"
+        : "optional";
+  });
+
+  if (schema.type === "array") {
+    return (
+      <Card className="overflow-hidden">
+        <SchemaListViewItem
+          propertyName={schema.title ?? name}
+          isRequired={true}
+          property={schema}
+          defaultOpen={level === 0}
+          nestingLevel={level}
+        />
+      </Card>
+    );
+  }
 
   return (
-    <div
-      className={cn(
-        "not-prose",
-        level > 0 && "border border-border rounded text-sm",
-      )}
-    >
+    <div className="flex flex-col gap-2.5">
       {(schema.title ?? name) && (
         <div className="ml-2 my-1 font-bold">{schema.title ?? name}</div>
       )}
       {level === 0 && schema.description && (
-        <p className="prose">{schema.description}</p>
-      )}
-      <ul>
-        {Object.entries(groups).map(([group, properties]) => {
-          return (
-            <SchemaListViewItemGroup
-              key={group}
-              defaultOpen={defaultOpen}
-              group={group as any}
-              nestingLevel={level}
-              properties={properties}
-              required={schema.required ?? []}
-            />
-          );
-        })}
-      </ul>
-    </div>
-  );
-};
-
-const SchemaListViewItemGroup = ({
-  group,
-  properties,
-  nestingLevel,
-  required,
-  defaultOpen = false,
-}: {
-  group: "optional" | "required" | "deprecated";
-  defaultOpen?: boolean;
-  properties: [string, SchemaObject][];
-  nestingLevel: number;
-  required: string[];
-}) => {
-  const notCollapsible =
-    defaultOpen ||
-    group === "required" ||
-    properties.length === 1 ||
-    nestingLevel === 0;
-  const [open, setOpen] = useState(notCollapsible);
-  if (properties.length === 0) {
-    return;
-  }
-
-  return (
-    <Collapsible.Root
-      className="CollapsibleRoot"
-      open={open}
-      onOpenChange={setOpen}
-    >
-      {!open && (
-        <Collapsible.Trigger
-          className={cn(
-            "py-2 hover:bg-muted w-full",
-            group === "optional" && "font-semibold",
-            group === "deprecated" && "text-muted-foreground",
-          )}
-        >
-          {properties.length} {group} fields
-        </Collapsible.Trigger>
+        <Markdown className={SchemaProseClasses} content={schema.description} />
       )}
-
-      <Collapsible.Content>
-        {properties.map(([propertyName, property]) => (
-          <SchemaListViewItem
-            key={propertyName}
-            property={property}
-            propertyName={propertyName}
-            nestingLevel={nestingLevel}
-            isRequired={required.includes(propertyName)}
+      <Card className="overflow-hidden">
+        {objectEntries(groups).map(([group, properties]) => (
+          <SchemaListViewItemGroup
+            key={group}
+            defaultOpen={defaultOpen}
+            group={group}
+            nestingLevel={level}
+            properties={properties ?? []}
+            required={schema.required ?? []}
           />
         ))}
-      </Collapsible.Content>
-    </Collapsible.Root>
-  );
-};
-
-const SchemaListViewItem = ({
-  propertyName,
-  property,
-  nestingLevel,
-  isRequired,
-}: {
-  propertyName: string;
-  isRequired: boolean;
-  property: SchemaObject;
-  nestingLevel: number;
-}) => {
-  return (
-    <div
-      key={propertyName}
-      className={cn(
-        nestingLevel > 0 ? "py-2" : "py-4",
-        "px-2 border-t border-border bg-border/20 hover:bg-border/30 flex gap-1 flex-col text-sm",
-        property.deprecated && "opacity-50",
-      )}
-    >
-      <div className="flex items-center gap-2 relative">
-        <code>
-          {propertyName} {property.title}
-        </code>
-
-        {property.type && (
-          <span className="text-xs text-muted-foreground">{property.type}</span>
-        )}
-        {property.deprecated && (
-          <span className="text-xs text-muted-foreground">Deprecated</span>
-        )}
-        {!isRequired && (
-          <span className="py-px px-1.5 font-medium text-xs border border-border rounded-lg">
-            optional {property.required}
-          </span>
-        )}
-      </div>
-      {property.description && (
-        <Markdown
-          content={property.description}
-          className="text-sm leading-normal line-clamp-4 "
-        />
-      )}
-
-      {property.enum && (
-        <span className="text-sm text-muted-foreground flex gap-1 flex-wrap items-center">
-          <span>Possible values</span>
-          {property.enum
-            .filter((value) => value)
-            .map((value) => (
-              <span
-                key={value}
-                className="font-mono text-xs border-border border bg-muted rounded px-1"
-              >
-                {value}
-              </span>
-            ))
-            .slice(0, 4)}
-          {property.enum.length > 4 && (
-            <span className="font-mono text-xs border-border border bg-muted rounded px-1">
-              ...
-            </span>
-          )}
-        </span>
-      )}
-
-      <Collapsible.Root className="CollapsibleRoot" defaultOpen={false}>
-        {property.type === "object" ||
-        (property.type === "array" && property.items.type === "object") ? (
-          <Collapsible.Trigger asChild>
-            <Button variant="ghost" size="sm">
-              Show nested fields
-              <ListPlusIcon size={18} className="ml-1.5" />
-            </Button>
-          </Collapsible.Trigger>
-        ) : null}
-
-        <Collapsible.Content>
-          {property.type === "object" && (
-            <div className="mt-2.5">
-              <SchemaListView
-                schema={property}
-                level={nestingLevel + 1}
-                defaultOpen
-              />
-            </div>
-          )}
-          {property.type === "array" && property.items.type === "object" && (
-            <div className="mt-2.5">
-              <SchemaListView
-                schema={property.items}
-                defaultOpen
-                level={nestingLevel + 1}
-              />
-            </div>
-          )}
-        </Collapsible.Content>
-      </Collapsible.Root>
+      </Card>
     </div>
   );
 };

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

@@ -0,0 +1,125 @@
+import * as Collapsible from "@radix-ui/react-collapsible";
+import { ListPlusIcon } from "lucide-react";
+import { Markdown } from "../../components/Markdown.js";
+import { SchemaObject } from "../../oas/parser/index.js";
+import { Button } from "../../ui/Button.js";
+import { cn } from "../../util/cn.js";
+import { SchemaListView } from "./SchemaListView.js";
+
+export const SchemaListViewItem = ({
+  propertyName,
+  property,
+  nestingLevel,
+  isRequired,
+  defaultOpen = false,
+}: {
+  propertyName?: string;
+  isRequired: boolean;
+  property: SchemaObject;
+  nestingLevel: number;
+  defaultOpen?: boolean;
+}) => {
+  if (!property) {
+    return <div>no property</div>;
+  }
+
+  const title =
+    propertyName || property.title
+      ? [propertyName, property.title].filter(Boolean).join(" ")
+      : null;
+
+  return (
+    <div
+      className={cn(
+        "p-4 bg-border/20 hover:bg-border/30 flex gap-1 flex-col text-sm",
+        property.deprecated && "opacity-50",
+      )}
+    >
+      <div className="flex items-center gap-2 relative">
+        {title && <code>{title}</code>}
+
+        {property.type && (
+          <span className="text-muted-foreground">{property.type}</span>
+        )}
+        {property.deprecated && (
+          <span className="text-muted-foreground">Deprecated</span>
+        )}
+        {!isRequired && (
+          <span className="py-px px-1.5 font-medium border rounded-lg">
+            optional {property.required}
+          </span>
+        )}
+      </div>
+      {property.description && (
+        <Markdown
+          content={property.description}
+          className="text-sm leading-normal line-clamp-4 "
+        />
+      )}
+
+      {property.enum && (
+        <span className="text-sm text-muted-foreground flex gap-1 flex-wrap items-center">
+          <span>Possible values</span>
+          {/* Make values unique, some schemas have duplicates */}
+          {[...new Set(property.enum.filter((value) => value))]
+            .map((value) => (
+              <span
+                key={value}
+                className="font-mono text-xs border bg-muted rounded px-1"
+              >
+                {value}
+              </span>
+            ))
+            .slice(0, 4)}
+          {property.enum.length > 4 && (
+            <span className="font-mono text-xs border bg-muted rounded px-1">
+              ...
+            </span>
+          )}
+        </span>
+      )}
+
+      {(property.type === "object" &&
+        (property.properties?.length ??
+          Object.entries(property.additionalProperties ?? {}).length > 0)) ||
+      (property.type === "array" &&
+        // this check is needed because the `items` can be undefined despite the type being defined
+        typeof property.items !== "undefined" &&
+        property.items.type === "object") ? (
+        <Collapsible.Root className="CollapsibleRoot" defaultOpen={defaultOpen}>
+          <Collapsible.Trigger asChild>
+            <Button
+              variant="ghost"
+              size="sm"
+              className={cn(defaultOpen && "hidden")}
+            >
+              Show nested fields
+              <ListPlusIcon size={18} className="ml-1.5" />
+            </Button>
+          </Collapsible.Trigger>
+
+          <Collapsible.Content>
+            {property.type === "object" && (
+              <div className="mt-2.5">
+                <SchemaListView
+                  schema={property}
+                  level={nestingLevel + 1}
+                  defaultOpen
+                />
+              </div>
+            )}
+            {property.type === "array" && property.items.type === "object" && (
+              <div className="mt-2.5">
+                <SchemaListView
+                  schema={property.items}
+                  defaultOpen
+                  level={nestingLevel + 1}
+                />
+              </div>
+            )}
+          </Collapsible.Content>
+        </Collapsible.Root>
+      ) : null}
+    </div>
+  );
+};

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

@@ -0,0 +1,63 @@
+import * as Collapsible from "@radix-ui/react-collapsible";
+import { useState } from "react";
+import { SchemaObject } from "../../oas/parser/index.js";
+import { cn } from "../../util/cn.js";
+import { SchemaListViewItem } from "./SchemaListViewItem.js";
+
+export const SchemaListViewItemGroup = ({
+  group,
+  properties,
+  nestingLevel,
+  required,
+  defaultOpen = false,
+}: {
+  group: "optional" | "required" | "deprecated";
+  defaultOpen?: boolean;
+  properties: [string, SchemaObject][];
+  nestingLevel: number;
+  required: string[];
+}) => {
+  const notCollapsible =
+    defaultOpen ||
+    group === "required" ||
+    properties.length === 1 ||
+    nestingLevel === 0;
+
+  const [open, setOpen] = useState(notCollapsible);
+
+  if (properties.length === 0) {
+    return;
+  }
+
+  return (
+    <Collapsible.Root
+      className="CollapsibleRoot"
+      open={open}
+      onOpenChange={setOpen}
+    >
+      {!open && (
+        <Collapsible.Trigger
+          className={cn(
+            "py-2 hover:bg-muted w-full",
+            group === "optional" && "font-semibold",
+            group === "deprecated" && "text-muted-foreground",
+          )}
+        >
+          {properties.length} {group} fields
+        </Collapsible.Trigger>
+      )}
+
+      <Collapsible.Content className="divide-y divide-border">
+        {properties.map(([propertyName, property]) => (
+          <SchemaListViewItem
+            key={propertyName}
+            property={property}
+            propertyName={propertyName}
+            nestingLevel={nestingLevel}
+            isRequired={required.includes(propertyName)}
+          />
+        ))}
+      </Collapsible.Content>
+    </Collapsible.Root>
+  );
+};

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

@@ -1,11 +1,13 @@
 import { HTTPSnippet } from "@zudoku/httpsnippet";
-import { Fragment, useMemo } from "react";
+import { Fragment, useMemo, useTransition } from "react";
 import { useSearchParams } from "react-router-dom";
+import { TextColorMap } from "../../components/navigation/SidebarBadge.js";
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import type { SchemaObject } from "../../oas/parser/index.js";
 import { cn } from "../../util/cn.js";
 import { ColorizedParam } from "./ColorizedParam.js";
-import { MethodTextColorMap } from "./MethodBadge.js";
+import { useOasConfig } from "./context.js";
+import { graphql } from "./graphql/index.js";
 import type { OperationListItemResult } from "./OperationList.js";
 import { PlaygroundDialogWrapper } from "./PlaygroundDialogWrapper.js";
 import { RequestBodySidecarBox } from "./RequestBodySidecarBox.js";
@@ -13,6 +15,7 @@ import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { SimpleSelect } from "./SimpleSelect.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
+import { useQuery } from "./util/urql.js";
 
 const getConverted = (snippet: HTTPSnippet, option: string) => {
   let converted;
@@ -58,15 +61,46 @@ const getConverted = (snippet: HTTPSnippet, option: string) => {
   return converted ? converted[0] : "";
 };
 
+export const GetServerQuery = graphql(/* GraphQL */ `
+  query getServerQuery($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      url
+    }
+  }
+`);
+
+const context = { suspense: true };
+
+const methodToColor = {
+  get: TextColorMap.green,
+  post: TextColorMap.blue,
+  put: TextColorMap.yellow,
+  delete: TextColorMap.red,
+  patch: TextColorMap.purple,
+  options: TextColorMap.indigo,
+  head: TextColorMap.gray,
+  trace: TextColorMap.gray,
+};
+
 export const Sidecar = ({
   operation,
 }: {
   operation: OperationListItemResult;
 }) => {
+  const oasConfig = useOasConfig();
+  const [result] = useQuery({
+    query: GetServerQuery,
+    variables: oasConfig,
+    context,
+  });
   const methodTextColor =
-    MethodTextColorMap[operation.method as keyof typeof MethodTextColorMap];
+    methodToColor[
+      operation.method.toLocaleLowerCase() as keyof typeof methodToColor
+    ] ?? TextColorMap.gray;
 
   const [searchParams, setSearchParams] = useSearchParams();
+  const [, startTransition] = useTransition();
+
   const selectedLang = searchParams.get("lang") ?? "shell";
 
   const requestBodyContent = operation.requestBody?.content;
@@ -115,7 +149,7 @@ export const Sidecar = ({
   return (
     <aside className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4">
       <SidecarBox.Root>
-        <SidecarBox.Head className="flex justify-between items-center flex-nowrap p-2 gap-2 text-xs">
+        <SidecarBox.Head className="flex justify-between items-center flex-nowrap py-3 gap-2 text-xs">
           <span className="font-mono break-words">
             <span className={cn("font-semibold", methodTextColor)}>
               {operation.method.toLocaleUpperCase()}
@@ -123,27 +157,10 @@ export const Sidecar = ({
             &nbsp;
             {path}
           </span>
-          <div className="flex gap-2 items-center">
-            <SimpleSelect
-              className="self-start"
-              value={selectedLang}
-              onChange={(e) => setSearchParams({ lang: e.target.value })}
-              options={[
-                { value: "shell", label: "cURL" },
-                { value: "js", label: "Javascript" },
-                { value: "python", label: "Python" },
-                { value: "java", label: "Java" },
-                { value: "go", label: "Go" },
-                { value: "csharp", label: "C#" },
-                { value: "kotlin", label: "Kotlin" },
-                { value: "objc", label: "Objective C" },
-                { value: "php", label: "PHP" },
-                { value: "ruby", label: "Ruby" },
-                { value: "swift", label: "Swift" },
-              ]}
-            />
-            <PlaygroundDialogWrapper operation={operation} />
-          </div>
+          <PlaygroundDialogWrapper
+            server={result.data?.schema.url ?? ""}
+            operation={operation}
+          />
         </SidecarBox.Head>
         <SidecarBox.Body>
           <SyntaxHighlight
@@ -153,6 +170,31 @@ export const Sidecar = ({
             code={code}
           />
         </SidecarBox.Body>
+        <SidecarBox.Footer className="flex items-center text-xs gap-2 justify-end py-1">
+          <span>Show example in</span>
+          <SimpleSelect
+            className="self-start max-w-[150px]"
+            value={selectedLang}
+            onChange={(e) => {
+              startTransition(() => {
+                setSearchParams({ lang: e.target.value });
+              });
+            }}
+            options={[
+              { value: "shell", label: "cURL" },
+              { value: "js", label: "Javascript" },
+              { value: "python", label: "Python" },
+              { value: "java", label: "Java" },
+              { value: "go", label: "Go" },
+              { value: "csharp", label: "C#" },
+              { value: "kotlin", label: "Kotlin" },
+              { value: "objc", label: "Objective C" },
+              { value: "php", label: "PHP" },
+              { value: "ruby", label: "Ruby" },
+              { value: "swift", label: "Swift" },
+            ]}
+          />
+        </SidecarBox.Footer>
       </SidecarBox.Root>
       {requestBodyContent && (
         <RequestBodySidecarBox content={requestBodyContent} />

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

@@ -8,7 +8,7 @@ type BaseComponentProps<T = unknown> = PropsWithChildren<
 export const Root = ({ children, className }: BaseComponentProps) => (
   <div
     className={cn(
-      "rounded-lg overflow-hidden border border-border dark:border-transparent",
+      "rounded-lg overflow-hidden border dark:border-transparent",
       className,
     )}
   >
@@ -19,7 +19,7 @@ export const Root = ({ children, className }: BaseComponentProps) => (
 export const Head = ({ children, className }: BaseComponentProps) => (
   <div
     className={cn(
-      "border-b border-b-border dark:border-b-zinc-600 bg-zinc-100 dark:bg-zinc-700 p-2",
+      "border-b dark:border-zinc-600 bg-zinc-100 dark:bg-zinc-700 p-2",
       className,
     )}
   >
@@ -34,3 +34,14 @@ export const Body = ({ children, className }: BaseComponentProps) => (
     {children}
   </div>
 );
+
+export const Footer = ({ children, className }: BaseComponentProps) => (
+  <div
+    className={cn(
+      "border-t dark:border-zinc-600 bg-zinc-100 dark:bg-zinc-700 p-2",
+      className,
+    )}
+  >
+    {children}
+  </div>
+);

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

@@ -1,5 +1,5 @@
+import { ChevronsUpDownIcon } from "lucide-react";
 import type { ChangeEventHandler } from "react";
-import { ChevronsUpDownIcon } from "../../core/icons.js";
 import { cn } from "../../util/cn.js";
 
 export const SimpleSelect = ({

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

@@ -0,0 +1,31 @@
+import {
+  Children,
+  createContext,
+  ReactNode,
+  useContext,
+  useEffect,
+  useState,
+} from "react";
+
+export const StaggeredRenderContext = createContext({ stagger: false });
+
+const StaggeredRender = ({ children }: { children: ReactNode[] }) => {
+  const { stagger } = useContext(StaggeredRenderContext);
+  const [renderAll, setRenderAll] = useState(!stagger);
+
+  useEffect(() => {
+    if (renderAll) {
+      return;
+    }
+
+    const idle = requestIdleCallback(() => {
+      setRenderAll(true);
+    });
+
+    return () => cancelIdleCallback(idle);
+  }, [renderAll]);
+
+  return !renderAll ? Children.toArray(children).slice(0, 3) : children;
+};
+
+export default StaggeredRender;