zudoku 0.1.1-dev.18 → 0.1.1-dev.19

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

@@ -0,0 +1,49 @@
+import { useApiIdentities } from "../../components/context/DevPortalProvider.js";
+import type { OperationListItemResult } from "./OperationList.js";
+import { Playground } from "./playground/Playground.js";
+import { useOasConfig } from "./index.js";
+import { gql, useQuery } from "urql";
+
+const getServerQuery = gql`
+  query getServerQuery($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      url
+    }
+  }
+`;
+
+export const MakeRequest = ({
+  operation,
+}: {
+  operation: OperationListItemResult;
+}) => {
+  const identities = useApiIdentities();
+  const variables = useOasConfig();
+  const [server] = useQuery({ query: getServerQuery, variables });
+
+  return (
+    <div>
+      <Playground
+        host={server.data?.schema.url}
+        method={operation.method}
+        url={operation.path}
+        defaultHeaders={[]}
+      />
+      {identities.data.map((identity) => (
+        <button
+          key={identity.id}
+          onClick={() => {
+            const test = new Request(
+              "https://zudoku-customer-main-b36fa2f.d2.zuplo.dev" +
+                operation.path,
+            );
+            void fetch(identity.authorizeRequest(test));
+          }}
+          className="p-2 border border-border rounded hover:bg-accent"
+        >
+          Test Request {operation.path} ({identity.name})
+        </button>
+      ))}
+    </div>
+  );
+};

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

@@ -0,0 +1,36 @@
+import { cn } from "../../util/cn.js";
+
+export const MethodTextColorMap = {
+  get: "text-green-600",
+  post: "text-sky-600",
+  put: "text-yellow-600",
+  delete: "text-red-600",
+  patch: "text-purple-600",
+  options: "text-indigo-600",
+  head: "text-gray-600",
+  trace: "text-gray-600",
+};
+
+const MethodColorMap = {
+  get: "bg-green-400 dark:bg-green-800",
+  post: "bg-sky-400 dark:bg-sky-800",
+  put: "bg-yellow-400 dark:bg-yellow-800",
+  delete: "bg-red-400 dark:bg-red-800",
+  patch: "bg-purple-400 dark:bg-purple-600",
+  options: "bg-indigo-400 dark:bg-indigo-600",
+  head: "bg-gray-400 dark:bg-gray-600",
+  trace: "bg-gray-400 dark:bg-gray-600",
+};
+
+export const MethodBadge = ({ method }: { method: string }) => {
+  return (
+    <span
+      className={cn(
+        "mt-0.5 flex items-center duration-200 transition-opacity text-center uppercase font-mono text-[0.65rem] font-bold rounded text-background dark:text-zinc-50 h-4 px-1",
+        MethodColorMap[method as keyof typeof MethodColorMap],
+      )}
+    >
+      {method}
+    </span>
+  );
+};

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

@@ -0,0 +1,117 @@
+import { Heading } from "../../Heading.js";
+import { CategoryHeading } from "../../components/CategoryHeading.js";
+import { Markdown, ProseClasses } from "../../components/Markdown.js";
+import { cn } from "../../util/cn.js";
+import { OperationListItem } from "./OperationListItem.js";
+import { useOasConfig } from "./index.js";
+import { graphql } from "./graphql/index.js";
+import { useQuery } from "./util/urql.js";
+import { ResultOf } from "@graphql-typed-document-node/core";
+
+export const OperationsFragment = graphql(/* GraphQL */ `
+  fragment OperationsFragment on OperationItem {
+    slug
+    summary
+    method
+    description
+    operationId
+    contentTypes
+    path
+    parameters {
+      name
+      in
+      description
+      required
+      schema
+      style
+    }
+    requestBody {
+      content {
+        mediaType
+        encoding {
+          name
+        }
+        schema
+      }
+      description
+      required
+    }
+    responses {
+      statusCode
+      links
+      description
+      content {
+        mediaType
+        encoding {
+          name
+        }
+        schema
+      }
+    }
+  }
+`);
+
+export type OperationListItemResult = ResultOf<typeof OperationsFragment>;
+
+const AllOperationsQuery = graphql(/* GraphQL */ `
+  query AllOperations($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      description
+      title
+      url
+      version
+      tags {
+        name
+        description
+        operations {
+          slug
+          ...OperationsFragment
+        }
+      }
+    }
+  }
+`);
+
+export const OperationList = () => {
+  const { type, input } = useOasConfig();
+
+  const [result] = useQuery({
+    query: AllOperationsQuery,
+    variables: { type, input },
+  });
+
+  if (!result.data) return null;
+
+  return (
+    <div className="pt-[--padding-content-top]">
+      <div className={cn(ProseClasses, "mb-16")}>
+        <CategoryHeading>Overview</CategoryHeading>
+        <Heading level={1} id="description" registerSidebarAnchor>
+          {result.data.schema.title}
+        </Heading>
+        <Markdown content={result.data.schema.description ?? ""} />
+      </div>
+      {result.data?.schema.tags
+        .filter((tag) => tag.operations.length > 0)
+        .map((tag) => (
+          <div key={tag.name}>
+            {tag.name && <CategoryHeading>{tag.name}</CategoryHeading>}
+            {tag.description && (
+              <Markdown
+                className={`${ProseClasses} mt-2 mb-12`}
+                content={tag.description}
+              />
+            )}
+            <div className="operation mb-12">
+              {tag.operations.map((fragment) => (
+                <OperationListItem
+                  key={fragment.slug}
+                  operationFragment={fragment}
+                />
+              ))}
+            </div>
+          </div>
+        ))}
+    </div>
+  );
+};

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

@@ -0,0 +1,55 @@
+import { Heading } from "../../Heading.js";
+import { Markdown, ProseClasses } from "../../components/Markdown.js";
+import { groupBy } from "../../util/groupBy.js";
+import { OperationsFragment } from "./OperationList.js";
+import { ParameterList } from "./ParameterList.js";
+import { Sidecar } from "./Sidecar.js";
+import { FragmentType, useFragment } from "./graphql/index.js";
+
+export const PARAM_GROUPS = ["path", "query", "header", "cookie"] as const;
+export type ParameterGroup = (typeof PARAM_GROUPS)[number];
+
+export const OperationListItem = ({
+  operationFragment,
+}: {
+  operationFragment: FragmentType<typeof OperationsFragment>;
+}) => {
+  const operation = useFragment(OperationsFragment, operationFragment);
+  const groupedParameters = groupBy(operation?.parameters ?? [], "in");
+
+  return (
+    <div
+      key={operation.operationId}
+      className="grid grid-cols-2 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
+        >
+          {operation.summary}
+        </Heading>
+        {operation.description && <Markdown content={operation.description} />}
+        {operation.parameters && operation.parameters.length > 0 && (
+          <div className="mt-4">
+            {PARAM_GROUPS.flatMap((group) =>
+              groupedParameters?.[group]?.length ? (
+                <ParameterList
+                  key={group}
+                  id={operation.slug}
+                  groupedParameters={groupedParameters}
+                  group={group}
+                />
+              ) : (
+                []
+              ),
+            )}
+          </div>
+        )}
+      </div>
+      <Sidecar operation={operation} />
+    </div>
+  );
+};

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

@@ -0,0 +1,32 @@
+import { Heading } from "../../Heading.js";
+import type { ParameterGroup } from "./OperationListItem.js";
+import {
+  ParameterListItem,
+  type ParameterListItemResult,
+} from "./ParameterListItem.js";
+
+export const ParameterList = ({
+  groupedParameters,
+  group,
+  id,
+}: {
+  groupedParameters: Record<ParameterGroup, ParameterListItemResult[]>;
+  group: ParameterGroup;
+  id: string;
+}) => (
+  <>
+    <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">
+      {groupedParameters[group].map((parameter) => (
+        <ParameterListItem
+          key={`${parameter.name}-${parameter.in}`}
+          parameter={parameter}
+          id={id}
+          group={group}
+        />
+      ))}
+    </ul>
+  </>
+);

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

@@ -0,0 +1,60 @@
+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";
+
+const getParameterSchema = (
+  parameter: ParameterListItemResult,
+): SchemaObject => {
+  if (parameter.schema != null && typeof parameter.schema === "object") {
+    return parameter.schema;
+  }
+  return {
+    type: "string",
+  };
+};
+
+export type ParameterListItemResult = NonNullable<
+  OperationListItemResult["parameters"]
+>[number];
+
+export const ParameterListItem = ({
+  parameter,
+  group,
+  id,
+}: {
+  parameter: ParameterListItemResult;
+  group: ParameterGroup;
+  id: string;
+}) => (
+  <li className="not-prose px-2 py-4 border-t border-border bg-border/20">
+    <div className="flex items-center gap-2">
+      <code>
+        {group === "path" ? (
+          <ColorizedParam
+            name={parameter.name}
+            backgroundOpacity="15%"
+            className="px-1"
+            slug={id + "-" + parameter.name.toLocaleLowerCase()}
+          />
+        ) : (
+          parameter.name
+        )}
+      </code>
+      {parameter.required && (
+        <span className="py-px px-1.5 font-medium text-xs bg-primary/75 text-muted rounded-lg">
+          required
+        </span>
+      )}
+      {getParameterSchema(parameter).type && (
+        <span className="text-xs text-muted-foreground">
+          {getParameterSchema(parameter).type}
+        </span>
+      )}
+    </div>
+    {parameter.description && (
+      <Markdown content={parameter.description} className="prose-p:my-1" />
+    )}
+  </li>
+);

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

@@ -0,0 +1,51 @@
+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";
+
+type Content = NonNullable<
+  NonNullable<OperationListItemResult["requestBody"]>["content"]
+>;
+
+// @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" },
+            ]}
+          />
+        </SidecarBox.Head>
+        <SidecarBox.Body>
+          <SyntaxHighlight
+            language="json"
+            noBackground
+            copyable={false}
+            className="text-xs"
+            code={JSON.stringify(
+              selected === "example"
+                ? generateSchemaExample(content[0].schema as SchemaObject)
+                : content[0].schema,
+              null,
+              2,
+            )}
+          />
+        </SidecarBox.Body>
+      </SidecarBox.Root>
+    </>
+  );
+};

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

@@ -0,0 +1,60 @@
+import { useState } from "react";
+import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
+import { type SchemaObject } from "../../oas/graphql/index.js";
+import { cn } from "../../util/cn.js";
+import type { OperationListItemResult } from "./OperationList.js";
+import * as SidecarBox from "./SidecarBox.js";
+import { generateSchemaExample } from "./util/generateSchemaExample.js";
+
+type Responses = OperationListItemResult["responses"];
+export const ResponsesSidecarBox = ({
+  responses,
+}: {
+  responses: Responses;
+}) => {
+  const [tabIndex, setTabIndex] = useState(0);
+
+  const activeTab = responses[tabIndex];
+  const schema = activeTab?.content?.[0]?.schema as SchemaObject | undefined;
+
+  return (
+    <SidecarBox.Root>
+      <SidecarBox.Head className="text-xs grid grid-rows-2 pb-0">
+        <span className="font-mono">Responses</span>
+        <div className="flex gap-2">
+          {responses.map((response, index) => (
+            <div
+              key={response.statusCode}
+              onClick={() => setTabIndex(index)}
+              className={cn(
+                "text-xs font-mono px-1.5 py-1 pb-px translate-y-px border-b-2 border-transparent rounded-t cursor-pointer",
+                tabIndex === index
+                  ? "text-primary dark:text-inherit border-primary"
+                  : "hover:border-accent-foreground/25",
+              )}
+            >
+              {response.statusCode}
+            </div>
+          ))}
+        </div>
+      </SidecarBox.Head>
+      <SidecarBox.Body>
+        {schema ? (
+          <SyntaxHighlight
+            language="json"
+            noBackground
+            copyable={false}
+            className="text-xs"
+            code={JSON.stringify(generateSchemaExample(schema), null, 2)}
+          />
+        ) : (
+          <span className="text-muted-foreground font-mono italic text-xs">
+            Empty Response
+          </span>
+        )}
+        <hr className="border-border my-1" />
+        <div className="text-xs">{responses[tabIndex].description}</div>
+      </SidecarBox.Body>
+    </SidecarBox.Root>
+  );
+};

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

@@ -0,0 +1,35 @@
+import type { ChangeEventHandler } from "react";
+import { ChevronsUpDownIcon } from "../../core/icons.js";
+import { cn } from "../../util/cn.js";
+
+export const Select = ({
+  onChange,
+  className,
+  options,
+}: {
+  onChange?: ChangeEventHandler<HTMLSelectElement>;
+  className?: string;
+  options: {
+    value: string;
+    label: string;
+  }[];
+}) => (
+  <div className={cn("grid", className)}>
+    <select
+      className={cn(
+        "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",
+      )}
+      onChange={onChange}
+    >
+      {options.map((option) => (
+        <option value={option.value} key={option.value}>
+          {option.label}
+        </option>
+      ))}
+    </select>
+    <div className="row-start-1 col-start-1 self-center justify-self-end relative end-2 pointer-events-none">
+      <ChevronsUpDownIcon size={14} />
+    </div>
+  </div>
+);

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

@@ -0,0 +1,160 @@
+import { Fragment, useMemo, useState } from "react";
+import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
+import { cn } from "../../util/cn.js";
+import { ColorizedParam } from "./ColorizedParam.js";
+import { MakeRequest } from "./MakeRequest.js";
+import { MethodTextColorMap } from "./MethodBadge.js";
+import type { OperationListItemResult } from "./OperationList.js";
+import { RequestBodySidecarBox } from "./RequestBodySidecarBox.js";
+import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
+import { Select } from "./Select.js";
+import * as SidecarBox from "./SidecarBox.js";
+import { HTTPSnippet } from "@zudoku/httpsnippet";
+import { generateSchemaExample } from "./util/generateSchemaExample.js";
+import type { SchemaObject } from "../../oas/parser/index.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 Sidecar = ({
+  operation,
+}: {
+  operation: OperationListItemResult;
+}) => {
+  const methodTextColor =
+    MethodTextColorMap[operation.method as keyof typeof MethodTextColorMap];
+  const [option, setOption] = useState("curl");
+  const requestBodyContent = operation.requestBody?.content;
+
+  const path = operation.path.split("/").map((part) => (
+    <Fragment key={part}>
+      {part.startsWith("{") && part.endsWith("}") ? (
+        <ColorizedParam
+          name={part.slice(1, -1)}
+          backgroundOpacity="0"
+          // same as in `ParameterListItem`
+          slug={operation.slug + "-" + part.slice(1, -1).toLocaleLowerCase()}
+        >
+          {part}
+        </ColorizedParam>
+      ) : (
+        part
+      )}
+      /
+      <wbr />
+    </Fragment>
+  ));
+
+  const code = useMemo(() => {
+    const example = requestBodyContent?.[0]?.schema
+      ? generateSchemaExample(requestBodyContent[0].schema as SchemaObject)
+      : undefined;
+
+    const snippet = new HTTPSnippet(
+      {
+        method: operation.method.toLocaleUpperCase(),
+        url: operation.path.replaceAll("{", ":").replaceAll("}", ""),
+        headers: [{ name: "Authorization", value: "Bearer <token>" }],
+        postData: example
+          ? {
+              text: JSON.stringify(example, null, 2),
+              mimeType: "application/json",
+            }
+          : {},
+      } as never, // 👈 never touch this
+    );
+
+    return getConverted(snippet, option) ?? "";
+  }, [option, operation.method, operation.path, requestBodyContent]);
+
+  return (
+    <aside className="flex flex-col overflow-hidden sticky top-[--scroll-padding] gap-4">
+      <SidecarBox.Root>
+        <MakeRequest operation={operation} />
+        <SidecarBox.Head className="flex justify-between items-center flex-nowrap p-2 gap-2 text-xs">
+          <span className="font-mono break-words">
+            <span className={cn("font-semibold", methodTextColor)}>
+              {operation.method.toLocaleUpperCase()}
+            </span>
+            &nbsp;
+            {path}
+          </span>
+          <Select
+            className="self-start"
+            onChange={(e) => setOption(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.Head>
+        <SidecarBox.Body>
+          <SyntaxHighlight
+            language={option}
+            copyable={false}
+            noBackground
+            className="text-xs"
+            code={code}
+          />
+        </SidecarBox.Body>
+      </SidecarBox.Root>
+      {/*<MakeRequest />*/}
+      {requestBodyContent && (
+        <RequestBodySidecarBox content={requestBodyContent} />
+      )}
+      {operation.responses.length > 0 && (
+        <ResponsesSidecarBox responses={operation.responses} />
+      )}
+    </aside>
+  );
+};