zudoku 0.3.0-dev.5 → 0.3.0-dev.50

package/src/lib/plugins/markdown/index.tsx

@@ -5,13 +5,19 @@ import { generateRoutes } from "./generateRoutes.js";
 
 export type MarkdownPluginOptions = {
   markdownFiles: Record<string, () => Promise<MDXImport>>;
+  defaultOptions?: MarkdownPluginDefaultOptions;
 };
+export type MarkdownPluginDefaultOptions = Pick<
+  Frontmatter,
+  "toc" | "disablePager"
+>;
 
 export type Frontmatter = {
   title?: string;
   description?: string;
   category?: string;
   toc?: boolean;
+  disablePager?: boolean;
 };
 
 export type MDXImport = {
@@ -22,10 +28,7 @@ export type MDXImport = {
 
 export const markdownPlugin = ({
   markdownFiles,
-}: MarkdownPluginOptions): DevPortalPlugin => {
-  return {
-    getRoutes() {
-      return generateRoutes(markdownFiles);
-    },
-  };
-};
+  defaultOptions,
+}: MarkdownPluginOptions): DevPortalPlugin => ({
+  getRoutes: () => generateRoutes(markdownFiles, defaultOptions),
+});

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

@@ -1,11 +1,16 @@
 import { ResultOf } from "@graphql-typed-document-node/core";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
+import { ErrorPage } from "../../components/ErrorPage.js";
 import { Heading } from "../../components/Heading.js";
-import { Markdown, ProseClasses } from "../../components/Markdown.js";
+import { InlineCode } from "../../components/InlineCode.js";
+import { Markdown } from "../../components/Markdown.js";
+import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
+import { Callout } from "../../ui/Callout.js";
 import { cn } from "../../util/cn.js";
 import { OperationListItem } from "./OperationListItem.js";
+import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
-import { useOasConfig } from "./index.js";
+import { SchemaProseClasses } from "./util/prose.js";
 import { useQuery } from "./util/urql.js";
 
 export const OperationsFragment = graphql(/* GraphQL */ `
@@ -90,11 +95,42 @@ export const OperationList = () => {
     context: suspenseContext,
   });
 
+  const error = result.error?.graphQLErrors.at(0);
+
+  // Looks like there is no Suspense level error handling (yet)?
+  // So we handle the error case in the component directly
+  if (error) {
+    return (
+      <ErrorPage
+        category="Error"
+        title="Schema cannot be displayed"
+        message={
+          <>
+            {import.meta.env.DEV && (
+              <Callout type="danger" title="Developer hint" className="mb-4">
+                Check your configuration value{" "}
+                <InlineCode>apis.type</InlineCode> and{" "}
+                <InlineCode>apis.input</InlineCode> in the Zudoku config.
+              </Callout>
+            )}
+            An error occurred while trying to fetch the API reference:
+            <SyntaxHighlight code={error.toString()} language="plain" />
+          </>
+        }
+      />
+    );
+  }
+
   if (!result.data) return null;
 
   return (
     <div className="pt-[--padding-content-top]">
-      <div className={cn(ProseClasses, "mb-16")}>
+      <div
+        className={cn(
+          SchemaProseClasses,
+          "mb-16 max-w-full prose-img:max-w-prose",
+        )}
+      >
         <CategoryHeading>Overview</CategoryHeading>
         <Heading level={1} id="description" registerSidebarAnchor>
           {result.data.schema.title}
@@ -108,7 +144,7 @@ export const OperationList = () => {
             {tag.name && <CategoryHeading>{tag.name}</CategoryHeading>}
             {tag.description && (
               <Markdown
-                className={`${ProseClasses} mt-2 mb-12`}
+                className={`${SchemaProseClasses} mt-2 mb-12`}
                 content={tag.description}
               />
             )}

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

@@ -1,11 +1,14 @@
 import { Heading } from "../../components/Heading.js";
-import { Markdown, ProseClasses } from "../../components/Markdown.js";
+import { Markdown } from "../../components/Markdown.js";
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../ui/Tabs.js";
+import { groupBy } from "../../util/groupBy.js";
+import { renderIf } from "../../util/renderIf.js";
 import { OperationsFragment } from "./OperationList.js";
 import { ParameterList } from "./ParameterList.js";
 import { SchemaListView } from "./SchemaListView.js";
 import { Sidecar } from "./Sidecar.js";
 import { FragmentType, useFragment } from "./graphql/index.js";
+import { SchemaProseClasses } from "./util/prose.js";
 
 export const PARAM_GROUPS = ["path", "query", "header", "cookie"] as const;
 export type ParameterGroup = (typeof PARAM_GROUPS)[number];
@@ -16,28 +19,29 @@ export const OperationListItem = ({
   operationFragment: FragmentType<typeof OperationsFragment>;
 }) => {
   const operation = useFragment(OperationsFragment, operationFragment);
-  const groupedParameters = Object.groupBy(
+  const groupedParameters = groupBy(
     operation.parameters ?? [],
     (param) => param.in,
   );
-  const first = operation.responses.find((re) => re.statusCode === "200");
+
+  const first = operation.responses.at(0);
   return (
     <div
       key={operation.operationId}
-      className="grid grid-cols-2 gap-8 items-start border-b-2 mb-16 pb-16 border-border"
+      className="grid grid-cols-1 lg:grid-cols-[4fr_3fr] gap-8 items-start border-b-2 mb-16 pb-16 border-border"
     >
-      <div className={ProseClasses}>
-        <Heading
-          level={2}
-          className="mt-0"
-          id={operation.slug}
-          registerSidebarAnchor
-        >
+      <div className="flex flex-col gap-4">
+        <Heading level={2} id={operation.slug} registerSidebarAnchor>
           {operation.summary}
         </Heading>
-        {operation.description && <Markdown content={operation.description} />}
+        {operation.description && (
+          <Markdown
+            className={SchemaProseClasses}
+            content={operation.description}
+          />
+        )}
         {operation.parameters && operation.parameters.length > 0 && (
-          <div className="mt-4">
+          <>
             {PARAM_GROUPS.flatMap((group) =>
               groupedParameters[group]?.length ? (
                 <ParameterList
@@ -50,37 +54,60 @@ export const OperationListItem = ({
                 []
               ),
             )}
+          </>
+        )}
+        {renderIf(operation.requestBody?.content?.at(0)?.schema, (schema) => (
+          <div className="mt-4 flex flex-col gap-4">
+            <Heading level={3} className="capitalize">
+              Request Body
+            </Heading>
+            <SchemaListView schema={schema} />
           </div>
+        ))}
+        {operation.responses.length > 0 && (
+          <>
+            <Heading
+              level={3}
+              className="capitalize mt-8 pt-8 border-border border-t"
+            >
+              Responses
+            </Heading>
+            <Tabs defaultValue={`${first?.statusCode}${first?.description}`}>
+              <TabsList>
+                {operation.responses.map((response) => (
+                  <TabsTrigger
+                    value={response.statusCode + response.description}
+                    key={response.statusCode}
+                    title={response.description}
+                  >
+                    {response.statusCode}
+                  </TabsTrigger>
+                ))}
+              </TabsList>
+              <ul className="list-none m-0 px-0 overflow-hidden">
+                {operation.responses.map((response) => (
+                  <TabsContent
+                    value={response.statusCode + response.description}
+                    key={response.statusCode}
+                  >
+                    {renderIf(
+                      response.content?.find((content) => content.schema),
+                      (content) => {
+                        return (
+                          <SchemaListView schema={content.schema} name="" />
+                        );
+                      },
+                    ) ?? (
+                      <div className="border-border font-mono text-sm border rounded p-4">
+                        No response body
+                      </div>
+                    )}
+                  </TabsContent>
+                ))}
+              </ul>
+            </Tabs>
+          </>
         )}
-        <Heading level={3} className="capitalize">
-          Responses
-        </Heading>
-        <Tabs defaultValue={`${first?.statusCode}${first?.description}`}>
-          <TabsList>
-            {operation.responses.map((response) => (
-              <TabsTrigger
-                value={response.statusCode + response.description}
-                key={response.statusCode}
-                title={response.description}
-              >
-                {response.statusCode}
-              </TabsTrigger>
-            ))}
-          </TabsList>
-          <ul className="list-none m-0 px-0 overflow-hidden">
-            {operation.responses.map((response) => (
-              <TabsContent
-                value={response.statusCode + response.description}
-                key={response.statusCode}
-              >
-                <SchemaListView
-                  schema={response.content?.at(0)?.schema}
-                  name=""
-                />
-              </TabsContent>
-            ))}
-          </ul>
-        </Tabs>
       </div>
 
       <Sidecar operation={operation} />

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

@@ -18,7 +18,7 @@ export const ParameterList = ({
     <Heading level={3} id={`${id}/${group}-parameters`} className="capitalize">
       {group === "header" ? "Headers" : `${group} Parameters`}
     </Heading>
-    <ul className="list-none m-0 px-0 overflow-hidden">
+    <ul className="list-none m-0 px-0 overflow-hidden border border-border divide-y divide-border rounded">
       {parameters.map((parameter) => (
         <ParameterListItem
           key={`${parameter.name}-${parameter.in}`}

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

@@ -28,14 +28,13 @@ export const ParameterListItem = ({
   group: ParameterGroup;
   id: string;
 }) => (
-  <li className="not-prose px-2 py-4 border-t border-border bg-border/20 text-sm flex flex-col gap-1">
+  <li className="p-4 bg-border/20 text-sm flex flex-col gap-1">
     <div className="flex items-center gap-2">
       <code>
         {group === "path" ? (
           <ColorizedParam
             name={parameter.name}
             backgroundOpacity="15%"
-            className="px-1"
             slug={id + "-" + parameter.name.toLocaleLowerCase()}
           />
         ) : (
@@ -43,12 +42,12 @@ export const ParameterListItem = ({
         )}
       </code>
       {parameter.required && (
-        <span className="py-px px-1.5 font-medium text-xs bg-primary/75 text-muted rounded-lg">
+        <span className="py-px px-1.5 font-medium bg-primary/75 text-muted rounded-lg">
           required
         </span>
       )}
       {getParameterSchema(parameter).type && (
-        <span className="text-xs text-muted-foreground">
+        <span className="text-muted-foreground">
           {getParameterSchema(parameter).type}
         </span>
       )}

package/src/lib/plugins/openapi/{MakeRequest.tsx → PlaygroundDialogWrapper.tsx}

@@ -1,7 +1,7 @@
+import { useOasConfig } from "./context.js";
 import { graphql } from "./graphql/index.js";
-import { useOasConfig } from "./index.js";
 import type { OperationListItemResult } from "./OperationList.js";
-import { Playground } from "./playground/Playground.js";
+import { PlaygroundDialog } from "./playground/PlaygroundDialog.js";
 
 import { useQuery } from "urql";
 
@@ -13,7 +13,7 @@ const GetServerQuery = graphql(/* GraphQL */ `
   }
 `);
 
-export const MakeRequest = ({
+export const PlaygroundDialogWrapper = ({
   operation,
 }: {
   operation: OperationListItemResult;
@@ -50,7 +50,7 @@ export const MakeRequest = ({
     false;
 
   return (
-    <Playground
+    <PlaygroundDialog
       host={server.data?.schema.url ?? ""}
       method={operation.method}
       url={operation.path}

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

@@ -1,8 +1,6 @@
-import { useState } from "react";
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import { type SchemaObject } from "../../oas/graphql/index.js";
 import type { OperationListItemResult } from "./OperationList.js";
-import { Select } from "./Select.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
 
@@ -12,23 +10,13 @@ type Content = NonNullable<
 
 // @todo should we handle multiple content types?
 export const RequestBodySidecarBox = ({ content }: { content: Content }) => {
-  const [selected, setSelected] = useState("example");
-
   if (!content.length) return null;
 
   return (
     <>
-      <div>lol</div>
       <SidecarBox.Root>
         <SidecarBox.Head className="text-xs flex justify-between items-center">
-          <span className="font-mono">Request Body</span>
-          <Select
-            onChange={(e) => setSelected(e.target.value)}
-            options={[
-              { value: "example", label: "Example" },
-              { value: "schema", label: "Schema" },
-            ]}
-          />
+          <span className="font-mono">Request Body Example</span>
         </SidecarBox.Head>
         <SidecarBox.Body>
           <SyntaxHighlight
@@ -37,9 +25,7 @@ export const RequestBodySidecarBox = ({ content }: { content: Content }) => {
             copyable
             className="text-xs"
             code={JSON.stringify(
-              selected === "example"
-                ? generateSchemaExample(content[0].schema as SchemaObject)
-                : content[0].schema,
+              generateSchemaExample(content[0].schema as SchemaObject),
               null,
               2,
             )}

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

@@ -52,7 +52,9 @@ export const ResponsesSidecarBox = ({
           </span>
         )}
         <hr className="border-border my-1" />
-        <div className="text-xs">{responses[tabIndex].description}</div>
+        <div className="text-xs  text-muted-foreground">
+          {responses[tabIndex].description}
+        </div>
       </SidecarBox.Body>
     </SidecarBox.Root>
   );

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

@@ -0,0 +1,21 @@
+import { Outlet } from "react-router-dom";
+import { OasConfigProvider } from "./context.js";
+import { OasPluginConfig } from "./interfaces.js";
+
+import { Provider, Client as UrqlClient } from "./util/urql.js";
+
+export function OpenApiRoute({
+  config,
+  client,
+}: {
+  config: OasPluginConfig;
+  client: typeof UrqlClient;
+}) {
+  return (
+    <Provider value={client}>
+      <OasConfigProvider value={{ config }}>
+        <Outlet />
+      </OasConfigProvider>
+    </Provider>
+  );
+}

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

@@ -1,10 +1,9 @@
-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 { groupBy } from "../../util/groupBy.js";
+import { objectEntries } from "../../util/objectEntries.js";
+import { SchemaListViewItemGroup } from "./SchemaListViewItemGroup.js";
+import { SchemaProseClasses } from "./util/prose.js";
 
 export const SchemaListView = ({
   name,
@@ -27,202 +26,34 @@ 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";
+  });
 
   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>
+        <Markdown className={SchemaProseClasses} content={schema.description} />
       )}
-      <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>
-      )}
-
-      <Collapsible.Content>
-        {properties.map(([propertyName, property]) => (
-          <SchemaListViewItem
-            key={propertyName}
-            property={property}
-            propertyName={propertyName}
-            nestingLevel={nestingLevel}
-            isRequired={required.includes(propertyName)}
+      <ul className="border-border border rounded 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>
+      </ul>
     </div>
   );
 };