zudoku 0.0.0-f3f6db5 → 0.0.0-f40ea27

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

@@ -0,0 +1,157 @@
+import slugify from "@sindresorhus/slugify";
+import { useSuspenseQuery } from "@tanstack/react-query";
+import { Helmet } from "@zudoku/react-helmet-async";
+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 } from "../../components/Markdown.js";
+import { Toc } from "../../components/navigation/Toc.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 ?? [];
+  const hasMultipleVersions = Object.entries(versions).length > 1;
+  const showVersions =
+    options?.showVersionSelect === "always" ||
+    (hasMultipleVersions && options?.showVersionSelect !== "hide");
+
+  if (!schemas.length) {
+    return (
+      <div>
+        <Helmet>
+          <title>Schemas {showVersions ? version : ""}</title>
+          <meta name="description" content="List of schemas used by the API." />
+        </Helmet>
+        No schemas found
+      </div>
+    );
+  }
+
+  return (
+    <div
+      className="grid grid-cols-(--sidecar-grid-cols) gap-8 justify-between"
+      data-pagefind-filter="section:openapi"
+      data-pagefind-meta="section:openapi"
+    >
+      <Helmet>
+        <title>Schemas {showVersions ? version : ""}</title>
+        <meta name="description" content="List of schemas used by the API." />
+      </Helmet>
+      <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"
+                registerNavigationAnchor
+                className="mb-0"
+              >
+                Schemas
+                {showVersions && (
+                  <span className="text-xl text-muted-foreground ms-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="mt-4 max-w-full border rounded-sm bg-muted/25">
+                <Markdown
+                  className="max-w-full prose-img:max-w-prose border-border p-3 lg:p-5"
+                  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
+                registerNavigationAnchor
+                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

@@ -1,11 +1,11 @@
 import { useSuspenseQuery } from "@tanstack/react-query";
-import { HTTPSnippet } from "@zudoku/httpsnippet";
 import { useMemo, useState, useTransition } from "react";
 import { useSearchParams } from "react-router";
-import { useSelectedServerStore } from "../../authentication/state.js";
+import { useZudoku } from "zudoku/hooks";
+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,53 +19,11 @@ 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 { createHttpSnippet, getConverted } from "./util/createHttpSnippet.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
 import { methodForColor } from "./util/methodToColor.js";
 
-const getConverted = (snippet: HTTPSnippet, option: string) => {
-  let converted;
-  switch (option) {
-    case "shell":
-      converted = snippet.convert("shell", "curl");
-      break;
-    case "js":
-      converted = snippet.convert("javascript", "fetch");
-      break;
-    case "python":
-      converted = snippet.convert("python", "requests");
-      break;
-    case "java":
-      converted = snippet.convert("java", "okhttp");
-      break;
-    case "go":
-      converted = snippet.convert("go", "native");
-      break;
-    case "csharp":
-      converted = snippet.convert("csharp", "httpclient");
-      break;
-    case "kotlin":
-      converted = snippet.convert("kotlin", "okhttp");
-      break;
-    case "objc":
-      converted = snippet.convert("objc", "nsurlsession");
-      break;
-    case "php":
-      converted = snippet.convert("php", "http2");
-      break;
-    case "ruby":
-      converted = snippet.convert("ruby");
-      break;
-    case "swift":
-      converted = snippet.convert("swift");
-      break;
-    default:
-      converted = snippet.convert("shell");
-      break;
-  }
-
-  return converted ? converted[0] : "";
-};
-
 export const GetServerQuery = graphql(/* GraphQL */ `
   query getServerQuery($input: JSON!, $type: SchemaType!) {
     schema(input: $input, type: $type) {
@@ -101,8 +59,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 +71,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}
@@ -131,63 +102,63 @@ export const Sidecar = ({
     />
   );
 
-  const { selectedServer } = useSelectedServerStore();
+  const { selectedServer } = useSelectedServer(result.data.schema.servers);
 
   const code = useMemo(() => {
-    const example =
+    const exampleBody =
       selectedExample ??
-      (requestBodyContent?.[0]?.schema
-        ? generateSchemaExample(requestBodyContent[0].schema as SchemaObject)
+      (transformedRequestBodyContent?.[0]?.schema
+        ? generateSchemaExample(
+            transformedRequestBodyContent[0].schema as SchemaObject,
+          )
         : undefined);
 
-    const snippet = new HTTPSnippet({
-      method: operation.method.toLocaleUpperCase(),
-      url:
-        (selectedServer ?? result.data.schema.url ?? "") +
-        operation.path.replaceAll("{", ":").replaceAll("}", ""),
-      postData: example
+    const snippet = createHttpSnippet({
+      operation,
+      selectedServer,
+      exampleBody: exampleBody
         ? {
-            text: JSON.stringify(example, null, 2),
             mimeType: "application/json",
+            text: JSON.stringify(exampleBody, null, 2),
           }
-        : ({} as any),
-      headers: [],
-      queryString: [],
-      httpVersion: "",
-      cookies: [],
-      headersSize: 0,
-      bodySize: 0,
+        : { mimeType: "application/json" },
     });
 
     return getConverted(snippet, selectedLang);
   }, [
     selectedExample,
-    requestBodyContent,
-    operation.method,
-    operation.path,
+    transformedRequestBodyContent,
+    operation,
     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"
+      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()}
+              {operation.method.toUpperCase()}
             </span>
             &nbsp;
             {path}
           </span>
-          {isOnScreen && (
+          {showPlayground && (
             <PlaygroundDialogWrapper
-              server={result.data.schema.url ?? ""}
               servers={result.data.schema.servers.map((server) => server.url)}
               operation={operation}
               examples={requestBodyContent ?? undefined}
@@ -199,9 +170,10 @@ export const Sidecar = ({
             <SidecarBox.Body className="p-0">
               <CollapsibleCode>
                 <SyntaxHighlight
+                  embedded
                   language={selectedLang}
                   noBackground
-                  className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+                  className="[--scrollbar-color:gray] rounded-none text-xs max-h-[500px] p-2"
                   code={code!}
                 />
               </CollapsibleCode>
@@ -225,9 +197,9 @@ export const Sidecar = ({
           </>
         )}
       </SidecarBox.Root>
-      {isOnScreen && requestBodyContent && (
+      {isOnScreen && transformedRequestBodyContent && (
         <RequestBodySidecarBox
-          content={requestBodyContent}
+          content={transformedRequestBodyContent}
           onExampleChange={setSelectedExample}
         />
       )}
@@ -235,7 +207,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 { type 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";
@@ -22,7 +22,13 @@ const formatForDisplay = (value: unknown): string => {
 
 const getLanguage = (mediaType?: string): string => {
   if (!mediaType) return "plain";
+  if (mediaType.endsWith("+json")) return "json";
+  if (mediaType.endsWith("+xml")) return "xml";
+  if (mediaType.endsWith("+yaml")) return "yaml";
+
   const languages: Record<string, string> = {
+    "text/html": "html",
+    "application/x-ndjson": "json",
     "application/json": "json",
     "application/xml": "xml",
     "application/x-yaml": "yaml",
@@ -95,10 +101,10 @@ export const SidecarExamples = ({
         ) : (
           <CollapsibleCode>
             <SyntaxHighlight
+              embedded
               language={language}
               noBackground
-              copyable
-              className="[--scrollbar-color:gray] text-xs max-h-[500px] p-2"
+              className="[--scrollbar-color:gray] rounded-none text-xs max-h-[500px] p-2"
               code={formattedExample}
             />
           </CollapsibleCode>

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,45 @@
-import { useContext } from "react";
+import { stripIgnoredCharacters } from "graphql";
+import { use } from "react";
 import type { TypedDocumentString } from "../graphql/graphql.js";
+import type { GraphQLClient } from "./GraphQLClient.js";
 import { GraphQLContext } from "./GraphQLContext.js";
 
+type NoExtraProps<T, U extends T = T> = U & {
+  [K in Exclude<keyof U, keyof T>]?: never;
+};
+
+type VarArgs<TVariables> =
+  TVariables extends Record<string, never> ? [] : [NoExtraProps<TVariables>];
+
+export const createQuery = <TResult, TVariables>(
+  client: GraphQLClient,
+  query: TypedDocumentString<TResult, TVariables>,
+  ...[variables]: TVariables extends Record<string, never>
+    ? []
+    : [NoExtraProps<TVariables>]
+) => {
+  return {
+    queryFn: () => client.fetch(query, variables),
+    queryKey: [stripIgnoredCharacters(query.toString()), variables],
+  } as const;
+};
+
 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]],
-  } as const;
+  const args =
+    variables === undefined
+      ? ([] as VarArgs<TVariables>)
+      : ([variables] as VarArgs<TVariables>);
+
+  return createQuery(graphQLClient, query, ...args);
 };

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

@@ -0,0 +1,24 @@
+import type { SchemaObject } from "../../../oas/parser/index.js";
+import { SelectOnClick } from "./SelectOnClick.js";
+
+export const ConstValue = ({
+  schema,
+  hideDescription = false,
+}: {
+  schema: SchemaObject;
+  hideDescription?: boolean;
+}) => {
+  return (
+    <div className="flex flex-col gap-1 text-xs">
+      <div>
+        <span className="text-muted-foreground">Const value: </span>
+        <SelectOnClick className="border rounded px-1 font-mono">
+          {schema.const}
+        </SelectOnClick>
+        {!hideDescription && schema.description && (
+          <div className="text-muted-foreground">{schema.description}</div>
+        )}
+      </div>
+    </div>
+  );
+};

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-sm 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>
+  );
+};