zudoku 0.0.0-ec30b50 → 0.0.0-ed94abf

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

@@ -0,0 +1,87 @@
+import { ChevronsLeftRightIcon } from "lucide-react";
+import { isValidElement, useState } from "react";
+import { InlineCode } from "../../components/InlineCode.js";
+import { type SchemaObject } from "../../oas/parser/index.js";
+import { cn } from "../../util/cn.js";
+
+const Pattern = ({ pattern }: { pattern: string }) => {
+  const [isExpanded, setIsExpanded] = useState(false);
+  const isExpandable = pattern.length > 20;
+  const shortPattern = isExpandable ? `${pattern.slice(0, 20)}…` : pattern;
+
+  return (
+    <InlineCode
+      className={cn("text-xs", isExpandable && "cursor-pointer")}
+      onClick={() => setIsExpanded(!isExpanded)}
+      selectOnClick={false}
+    >
+      {isExpanded ? pattern : shortPattern}
+      {isExpandable && (
+        <button type="button" className="p-1 translate-y-[2px]">
+          {!isExpanded && <ChevronsLeftRightIcon size={12} />}
+        </button>
+      )}
+    </InlineCode>
+  );
+};
+
+const getSchemaInfos = (schema?: SchemaObject) => {
+  if (!schema) return [];
+
+  return [
+    schema.type === "array" && schema.items.type
+      ? `${schema.items.type}[]`
+      : Array.isArray(schema.type)
+        ? schema.type.join(" | ")
+        : schema.type,
+
+    schema.enum && "enum",
+    schema.format,
+    schema.minimum && `min: ${schema.minimum}`,
+    schema.maximum && `max: ${schema.maximum}`,
+    schema.minLength && `minLength: ${schema.minLength}`,
+    schema.maxLength && `maxLength: ${schema.maxLength}`,
+    schema.minItems && `minItems: ${schema.minItems}`,
+    schema.maxItems && `maxItems: ${schema.maxItems}`,
+    schema.uniqueItems && "unique",
+    schema.minProperties && `minProps: ${schema.minProperties}`,
+    schema.maxProperties && `maxProps: ${schema.maxProperties}`,
+    schema.readOnly && "readOnly",
+    schema.writeOnly && "writeOnly",
+    schema.deprecated && "deprecated",
+    schema.pattern && (
+      <>
+        pattern: <Pattern pattern={schema.pattern} />
+      </>
+    ),
+  ];
+};
+
+export const ParamInfos = ({
+  schema,
+  extraItems = [],
+  className,
+}: {
+  schema?: SchemaObject;
+  extraItems?: unknown[];
+  className?: string;
+}) => {
+  const filteredItems = [...getSchemaInfos(schema), ...extraItems].flatMap(
+    (item) => (typeof item === "string" || isValidElement(item) ? item : []),
+  );
+
+  return (
+    <span className={className}>
+      {filteredItems.map((item, index) => (
+        <span className="text-muted-foreground" key={index}>
+          {item}
+          {index < filteredItems.length - 1 && (
+            <span className="text-muted-foreground/50">
+              &nbsp;&middot;&nbsp;
+            </span>
+          )}
+        </span>
+      ))}
+    </span>
+  );
+};

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

@@ -1,3 +1,4 @@
+import { VisuallyHidden } from "@radix-ui/react-visually-hidden";
 import { Heading } from "../../components/Heading.js";
 import { Card } from "../../ui/Card.js";
 import type { ParameterGroup } from "./OperationListItem.js";
@@ -7,16 +8,19 @@ import {
 } from "./ParameterListItem.js";
 
 export const ParameterList = ({
+  summary,
   group,
   parameters,
   id,
 }: {
+  summary?: string;
   group: ParameterGroup;
   parameters: ParameterListItemResult[];
   id: string;
 }) => (
   <>
     <Heading level={3} id={`${id}/${group}-parameters`} className="capitalize">
+      {summary && <VisuallyHidden>{summary} &rsaquo; </VisuallyHidden>}
       {group === "header" ? "Headers" : `${group} Parameters`}
     </Heading>
     <Card>

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

@@ -1,9 +1,12 @@
-import { Badge } from "zudoku/ui/Badge.js";
 import { Markdown } from "../../components/Markdown.js";
 import { type SchemaObject } from "../../oas/graphql/index.js";
 import { ColorizedParam } from "./ColorizedParam.js";
 import type { OperationListItemResult } from "./OperationList.js";
 import type { ParameterGroup } from "./OperationListItem.js";
+import { ParamInfos } from "./ParamInfos.js";
+import { EnumValues } from "./components/EnumValues.js";
+import { SelectOnClick } from "./components/SelectOnClick.js";
+import { SchemaExampleAndDefault } from "./schema/SchemaExampleAndDefault.js";
 
 const getParameterSchema = (
   parameter: ParameterListItemResult,
@@ -32,29 +35,32 @@ export const ParameterListItem = ({
   const paramSchema = getParameterSchema(parameter);
 
   return (
-    <li className="p-4 bg-border/20 text-sm flex flex-col gap-1">
+    <li className="p-4 bg-border/20 text-sm flex flex-col gap-1.5">
       <div className="flex items-center gap-2">
-        <code>
-          {group === "path" ? (
-            <ColorizedParam
-              name={parameter.name}
-              backgroundOpacity="15%"
-              className="px-1"
-              slug={`${id}-${parameter.name}`}
-            />
-          ) : (
-            parameter.name
-          )}
-        </code>
-        {paramSchema.type && (
-          <Badge variant="muted">
-            {paramSchema.type === "array"
-              ? `${paramSchema.items.type}[]`
-              : paramSchema.type}
-          </Badge>
-        )}
-        {parameter.required && <Badge variant="outline">required</Badge>}
-        {parameter.style === "form" && <Badge variant="secondary">form</Badge>}
+        <SelectOnClick asChild>
+          <code>
+            {group === "path" ? (
+              <ColorizedParam
+                name={parameter.name}
+                backgroundOpacity="15%"
+                className="px-2"
+                slug={`${id}-${parameter.name}`}
+              />
+            ) : (
+              parameter.name
+            )}
+          </code>
+        </SelectOnClick>
+        <ParamInfos
+          schema={paramSchema}
+          extraItems={[
+            parameter.required && (
+              <span className="text-primary">required</span>
+            ),
+            parameter.style && `style: ${parameter.style}`,
+            parameter.explode && `explode: ${parameter.explode}`,
+          ]}
+        />
       </div>
       {parameter.description && (
         <Markdown
@@ -62,6 +68,12 @@ export const ParameterListItem = ({
           className="text-sm prose-p:my-1 prose-code:whitespace-pre-line"
         />
       )}
+      {paramSchema.type === "array" && paramSchema.items.enum ? (
+        <EnumValues values={paramSchema.items.enum} />
+      ) : (
+        paramSchema.enum && <EnumValues values={paramSchema.enum} />
+      )}
+      <SchemaExampleAndDefault schema={paramSchema} />
     </li>
   );
 };

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

@@ -1,3 +1,4 @@
+import { useAuth } from "zudoku/components";
 import type { OperationListItemResult } from "./OperationList.js";
 import { PlaygroundDialog } from "./playground/PlaygroundDialog.js";
 import { Content } from "./SidecarExamples.js";
@@ -8,11 +9,14 @@ export const PlaygroundDialogWrapper = ({
   operation,
   examples,
 }: {
-  server: string;
+  server?: string;
   servers?: string[];
   operation: OperationListItemResult;
   examples?: Content;
 }) => {
+  const { isAuthEnabled, login, signup, isPending, isAuthenticated } =
+    useAuth();
+
   const headers = operation.parameters
     ?.filter((p) => p.in === "header")
     .sort((a, b) => (a.required && !b.required ? -1 : 1))
@@ -49,6 +53,9 @@ export const PlaygroundDialogWrapper = ({
       queryParams={queryParams}
       pathParams={pathParams}
       examples={examples}
+      requiresLogin={isAuthEnabled && !isAuthenticated && !isPending}
+      onLogin={() => login()}
+      onSignUp={() => signup()}
     />
   );
 };

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

@@ -0,0 +1,151 @@
+import slugify from "@sindresorhus/slugify";
+import { useSuspenseQuery } from "@tanstack/react-query";
+import {
+  ChevronRightIcon,
+  ChevronsDownUpIcon,
+  ChevronsUpDownIcon,
+} from "lucide-react";
+import { Button } from "zudoku/ui/Button.js";
+import {
+  Collapsible,
+  CollapsibleContent,
+  CollapsibleTrigger,
+} from "zudoku/ui/Collapsible.js";
+import { CategoryHeading } from "../../components/CategoryHeading.js";
+import { Heading } from "../../components/Heading.js";
+import { Markdown, ProseClasses } from "../../components/Markdown.js";
+import { Toc } from "../../components/navigation/Toc.js";
+import { cn } from "../../util/cn.js";
+import { useCreateQuery } from "./client/useCreateQuery.js";
+import { useOasConfig } from "./context.js";
+import { graphql } from "./graphql/gql.js";
+import { SchemaView } from "./schema/SchemaView.js";
+
+const GET_SCHEMAS = graphql(/* GraphQL */ `
+  query GetSchemas($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      title
+      description
+      summary
+      components {
+        schemas {
+          name
+          schema
+          extensions
+        }
+      }
+    }
+  }
+`);
+
+export function SchemaList() {
+  const { input, type, versions, version, options } = useOasConfig();
+  const schemasQuery = useCreateQuery(GET_SCHEMAS, {
+    input,
+    type,
+  });
+  const { data } = useSuspenseQuery(schemasQuery);
+
+  const schemas = data.schema.components?.schemas ?? [];
+
+  if (!schemas.length) {
+    return <div>No schemas found</div>;
+  }
+
+  const hasMultipleVersions = Object.entries(versions).length > 1;
+  const showVersions =
+    options?.showVersionSelect === "always" ||
+    (hasMultipleVersions && options?.showVersionSelect !== "hide");
+
+  return (
+    <div
+      className="grid grid-cols-[--sidecar-grid-cols] gap-8 justify-between"
+      data-pagefind-filter="section:openapi"
+      data-pagefind-meta="section:openapi"
+    >
+      <div className="pt-[--padding-content-top] pb-[--padding-content-bottom]">
+        <Collapsible className="w-full">
+          <div className="flex flex-col gap-y-4 sm:flex-row justify-around items-start sm:items-end">
+            <div className="flex-1">
+              <CategoryHeading>{data.schema.title}</CategoryHeading>
+              <Heading
+                level={1}
+                id="schemas"
+                registerSidebarAnchor
+                className="mb-0"
+              >
+                Schemas
+                {showVersions && (
+                  <span className="text-xl text-muted-foreground ml-1.5">
+                    ({version})
+                  </span>
+                )}
+              </Heading>
+            </div>
+            {data.schema.description && (
+              <CollapsibleTrigger className="flex items-center gap-1 text-sm font-medium text-muted-foreground group">
+                <span>API information</span>
+                <ChevronsUpDownIcon
+                  className="group-data-[state=open]:hidden translate-y-px"
+                  size={14}
+                />
+                <ChevronsDownUpIcon
+                  className="group-data-[state=closed]:hidden translate-y-px"
+                  size={13}
+                />
+              </CollapsibleTrigger>
+            )}
+          </div>
+          {data.schema.description && (
+            <CollapsibleContent className="CollapsibleContent">
+              <div
+                className={cn(
+                  ProseClasses,
+                  "pt-4 max-w-full prose-img:max-w-prose",
+                )}
+              >
+                <Markdown
+                  className="border rounded bg-muted/25 border-border px-2.5 md:px-4"
+                  content={data.schema.description}
+                />
+              </div>
+            </CollapsibleContent>
+          )}
+        </Collapsible>
+        <hr className="my-8" />
+        <div className="flex flex-col gap-y-5">
+          {schemas.map((schema) => (
+            <Collapsible key={schema.name} className="group" defaultOpen>
+              <Heading
+                registerSidebarAnchor
+                level={2}
+                className="flex items-center gap-1 justify-between w-fit"
+                id={slugify(schema.name)}
+              >
+                {schema.name}{" "}
+                <CollapsibleTrigger asChild>
+                  <Button variant="ghost" size="icon" className="size-6">
+                    <ChevronRightIcon
+                      size={16}
+                      className="group-data-[state=open]:rotate-90 transition cursor-pointer"
+                    />
+                  </Button>
+                </CollapsibleTrigger>
+              </Heading>
+              <CollapsibleContent className="mt-4 CollapsibleContent">
+                <SchemaView schema={schema.schema} />
+              </CollapsibleContent>
+            </Collapsible>
+          ))}
+        </div>
+      </div>
+      <Toc
+        entries={schemas.map((schema) => ({
+          id: slugify(schema.name),
+          value: schema.name,
+          depth: 1,
+        }))}
+      />
+    </div>
+  );
+}

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

@@ -2,10 +2,11 @@ import { useSuspenseQuery } from "@tanstack/react-query";
 import { HTTPSnippet } from "@zudoku/httpsnippet";
 import { useMemo, useState, useTransition } from "react";
 import { useSearchParams } from "react-router";
-import { useSelectedServer } from "../../authentication/state.js";
+import { useZudoku } from "zudoku/components";
+import { useAuthState } from "../../authentication/state.js";
 import { PathRenderer } from "../../components/PathRenderer.js";
-import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import type { SchemaObject } from "../../oas/parser/index.js";
+import { SyntaxHighlight } from "../../ui/SyntaxHighlight.js";
 import { cn } from "../../util/cn.js";
 import { useOnScreen } from "../../util/useOnScreen.js";
 import { useCreateQuery } from "./client/useCreateQuery.js";
@@ -19,6 +20,7 @@ import { RequestBodySidecarBox } from "./RequestBodySidecarBox.js";
 import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
 import * as SidecarBox from "./SidecarBox.js";
 import { SimpleSelect } from "./SimpleSelect.js";
+import { useSelectedServer } from "./state.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
 import { methodForColor } from "./util/methodToColor.js";
 
@@ -101,8 +103,10 @@ export const Sidecar = ({
   onSelectResponse: (response: string) => void;
 }) => {
   const { input, type, options } = useOasConfig();
+  const auth = useAuthState();
   const query = useCreateQuery(GetServerQuery, { input, type });
   const result = useSuspenseQuery(query);
+  const context = useZudoku();
 
   const methodTextColor = methodForColor(operation.method);
 
@@ -111,10 +115,21 @@ export const Sidecar = ({
   const [selectedExample, setSelectedExample] = useState<unknown>();
 
   const selectedLang =
-    searchParams.get("lang") ?? options?.examplesDefaultLanguage ?? "shell";
+    searchParams.get("lang") ?? options?.examplesLanguage ?? "shell";
 
   const requestBodyContent = operation.requestBody?.content;
 
+  const transformedRequestBodyContent =
+    requestBodyContent && options?.transformExamples
+      ? options.transformExamples({
+          auth,
+          type: "request",
+          operation,
+          content: requestBodyContent,
+          context,
+        })
+      : requestBodyContent;
+
   const path = (
     <PathRenderer
       path={operation.path}
@@ -136,8 +151,10 @@ export const Sidecar = ({
   const code = useMemo(() => {
     const example =
       selectedExample ??
-      (requestBodyContent?.[0]?.schema
-        ? generateSchemaExample(requestBodyContent[0].schema as SchemaObject)
+      (transformedRequestBodyContent?.[0]?.schema
+        ? generateSchemaExample(
+            transformedRequestBodyContent[0].schema as SchemaObject,
+          )
         : undefined);
 
     const snippet = new HTTPSnippet({
@@ -151,7 +168,7 @@ export const Sidecar = ({
             mimeType: "application/json",
           }
         : ({} as any),
-      headers: [],
+      headers: [{ name: "Content-Type", value: "application/json" }],
       queryString: [],
       httpVersion: "",
       cookies: [],
@@ -162,32 +179,39 @@ export const Sidecar = ({
     return getConverted(snippet, selectedLang);
   }, [
     selectedExample,
-    requestBodyContent,
+    transformedRequestBodyContent,
     operation.method,
     operation.path,
     selectedServer,
-    result.data.schema.url,
     selectedLang,
   ]);
   const [ref, isOnScreen] = useOnScreen({ rootMargin: "200px 0px 200px 0px" });
 
+  const showPlayground =
+    isOnScreen &&
+    (operation.extensions["x-explorer-enabled"] === true ||
+      operation.extensions["x-zudoku-playground-enabled"] === true ||
+      (operation.extensions["x-explorer-enabled"] === undefined &&
+        operation.extensions["x-zudoku-playground-enabled"] === undefined &&
+        !options?.disablePlayground));
+
   return (
     <aside
       ref={ref}
       className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4"
+      data-pagefind-ignore="all"
     >
       <SidecarBox.Root>
         <SidecarBox.Head className="flex justify-between items-center flex-nowrap py-2.5 gap-2 text-xs">
-          <span className="font-mono break-words">
+          <span className="font-mono break-words leading-6">
             <span className={cn("font-semibold", methodTextColor)}>
               {operation.method.toLocaleUpperCase()}
             </span>
             &nbsp;
             {path}
           </span>
-          {isOnScreen && (
+          {showPlayground && (
             <PlaygroundDialogWrapper
-              server={selectedServer}
               servers={result.data.schema.servers.map((server) => server.url)}
               operation={operation}
               examples={requestBodyContent ?? undefined}
@@ -225,9 +249,9 @@ export const Sidecar = ({
           </>
         )}
       </SidecarBox.Root>
-      {isOnScreen && requestBodyContent && (
+      {isOnScreen && transformedRequestBodyContent && (
         <RequestBodySidecarBox
-          content={requestBodyContent}
+          content={transformedRequestBodyContent}
           onExampleChange={setSelectedExample}
         />
       )}
@@ -235,7 +259,19 @@ export const Sidecar = ({
         <ResponsesSidecarBox
           selectedResponse={selectedResponse}
           onSelectResponse={onSelectResponse}
-          responses={operation.responses}
+          responses={operation.responses.map((response) => ({
+            ...response,
+            content:
+              response.content && options?.transformExamples
+                ? options.transformExamples({
+                    auth,
+                    type: "response",
+                    context,
+                    operation,
+                    content: response.content,
+                  })
+                : response.content,
+          }))}
         />
       )}
     </aside>

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

@@ -1,6 +1,6 @@
 import { useEffect, useMemo, useState } from "react";
-import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import { SchemaObject } from "../../oas/parser/index.js";
+import { SyntaxHighlight } from "../../ui/SyntaxHighlight.js";
 import { CollapsibleCode } from "./CollapsibleCode.js";
 import type { OperationListItemResult } from "./OperationList.js";
 import * as SidecarBox from "./SidecarBox.js";
@@ -97,7 +97,6 @@ export const SidecarExamples = ({
             <SyntaxHighlight
               language={language}
               noBackground
-              copyable
               className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
               code={formattedExample}
             />

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

@@ -21,7 +21,7 @@ export const SimpleSelect = ({
   <div className="grid">
     <select
       className={cn(
-        "row-start-1 col-start-1 border border-input text-foreground px-2 py-1 pe-6",
+        "w-full row-start-1 col-start-1 border border-input text-foreground px-2 py-1 pe-6",
         "rounded-md appearance-none bg-zinc-50 hover:bg-white dark:bg-zinc-800 hover:dark:bg-zinc-800/75",
         className,
       )}

package/src/lib/plugins/openapi/client/GraphQLClient.tsx

@@ -43,7 +43,7 @@ export class GraphQLClient {
 
   fetch = async <TResult, TVariables>(
     query: TypedDocumentString<TResult, TVariables>,
-    ...[variables]: TVariables extends Record<string, never> ? [] : [TVariables]
+    variables?: TVariables,
   ): Promise<TResult> => {
     const operationName = query.match(/query (\w+)/)?.[1];
 

package/src/lib/plugins/openapi/client/useCreateQuery.ts

@@ -1,18 +1,26 @@
-import { useContext } from "react";
+import { stripIgnoredCharacters } from "graphql";
+import { use } from "react";
 import type { TypedDocumentString } from "../graphql/graphql.js";
 import { GraphQLContext } from "./GraphQLContext.js";
 
+type NoExtraProps<T, U extends T = T> = U & {
+  [K in Exclude<keyof U, keyof T>]?: never;
+};
+
 export const useCreateQuery = <TResult, TVariables>(
   query: TypedDocumentString<TResult, TVariables>,
-  ...variables: TVariables extends Record<string, never> ? [] : [TVariables]
+  ...[variables]: TVariables extends Record<string, never>
+    ? []
+    : [NoExtraProps<TVariables>]
 ) => {
-  const graphQLClient = useContext(GraphQLContext);
+  const graphQLClient = use(GraphQLContext);
+
   if (graphQLClient === undefined) {
     throw new Error("useGraphQL must be used within a GraphQLProvider");
   }
 
   return {
-    queryFn: () => graphQLClient.fetch(query, ...variables),
-    queryKey: [query, variables[0]],
+    queryFn: () => graphQLClient.fetch(query, variables),
+    queryKey: [stripIgnoredCharacters(query.toString()), variables],
   } as const;
 };

package/src/lib/plugins/openapi/components/EnumValues.tsx

@@ -0,0 +1,58 @@
+import { ChevronDownIcon, ChevronUpIcon } from "lucide-react";
+import { useState } from "react";
+import { Button } from "zudoku/ui/Button.js";
+import { cn } from "../../../util/cn.js";
+import { SelectOnClick } from "./SelectOnClick.js";
+
+export const EnumValues = ({
+  values,
+  className,
+  maxVisibleValues = 8,
+}: {
+  values: Array<string | number>;
+  className?: string;
+  maxVisibleValues?: number;
+}) => {
+  const [isOpen, setIsOpen] = useState(false);
+
+  if (!values.length) return null;
+
+  const shouldCollapse = values.length > maxVisibleValues;
+  const visibleValues =
+    shouldCollapse && !isOpen ? values.slice(0, maxVisibleValues) : values;
+
+  return (
+    <div className={cn("flex flex-wrap gap-1.5 text-xs", className)}>
+      <span className="text-muted-foreground">Enum values: </span>
+      {visibleValues.map((value) => (
+        <div key={value}>
+          <SelectOnClick className="border rounded px-1 font-mono">
+            {value}
+          </SelectOnClick>
+        </div>
+      ))}
+      {shouldCollapse && (
+        <Button
+          variant="ghost"
+          size="sm"
+          className="h-fit px-0"
+          onClick={() => setIsOpen(!isOpen)}
+        >
+          {isOpen ? (
+            <div className="flex items-center gap-1">
+              <ChevronUpIcon size={12} />
+              <span className="text-muted-foreground">show less</span>
+            </div>
+          ) : (
+            <div className="flex items-center gap-1">
+              <ChevronDownIcon size={12} />
+              <span className="text-muted-foreground">
+                show {values.length - maxVisibleValues} more
+              </span>
+            </div>
+          )}
+        </Button>
+      )}
+    </div>
+  );
+};