zudoku 0.1.1-dev.4 → 0.1.1-dev.41

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

@@ -0,0 +1,58 @@
+import type { OperationListItemResult } from "./OperationList.js";
+import { Playground } from "./playground/Playground.js";
+import { useOasConfig } from "./index.js";
+import { graphql } from "./graphql/index.js";
+
+import { useQuery } from "urql";
+
+const GetServerQuery = graphql(/* GraphQL */ `
+  query getServerQuery($input: JSON!, $type: SchemaType!) {
+    schema(input: $input, type: $type) {
+      url
+    }
+  }
+`);
+
+export const MakeRequest = ({
+  operation,
+}: {
+  operation: OperationListItemResult;
+}) => {
+  const variables = useOasConfig();
+  const [server] = useQuery({ query: GetServerQuery, variables });
+
+  const headers = operation.parameters
+    ?.filter((p) => p.in === "header")
+    ?.map((p) => ({
+      name: p.name,
+      value: "",
+    }));
+  const queryParams = operation.parameters
+    ?.filter((p) => p.in === "query")
+    ?.map((p) => ({
+      name: p.name,
+      value: "",
+    }));
+  const pathParams = operation.parameters
+    ?.filter((p) => p.in === "path")
+    ?.map((p) => ({
+      name: p.name,
+      value: "",
+    }));
+
+  const hasParams =
+    operation.parameters?.some((p) => p.in === "query" || p.in === "path") ??
+    false;
+
+  return (
+    <Playground
+      host={server.data?.schema.url ?? ""}
+      method={operation.method}
+      url={operation.path}
+      headers={headers}
+      queryParams={queryParams}
+      pathParams={pathParams}
+      hasParams={hasParams}
+    />
+  );
+};

package/src/{app → lib}/plugins/openapi/OperationList.tsx

@@ -1,12 +1,12 @@
-import { Heading } from "../../Heading.js";
+import { ResultOf } from "@graphql-typed-document-node/core";
 import { CategoryHeading } from "../../components/CategoryHeading.js";
+import { Heading } from "../../components/Heading.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 { useOasConfig } from "./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 {

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

@@ -0,0 +1,191 @@
+import { Heading } from "../../components/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";
+import { SchemaObject } from "../../oas/parser/index.js";
+import { useState } from "react";
+import { cn } from "../../util/cn.js";
+import { Tabs, TabsContent, TabsList, TabsTrigger } from "../../ui/Tabs.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");
+  const first = operation.responses.find((re) => re.statusCode === "200");
+  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>
+        )}
+        <Heading level={3} className="capitalize">
+          Repsonses
+        </Heading>
+        <Tabs defaultValue={`${first?.statusCode}${first?.description}`}>
+          <TabsList>
+            {operation.responses.map((response) => (
+              <TabsTrigger value={response.statusCode + response.description}>
+                {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}>
+                <ViewSchema schema={response.content?.at(0)?.schema} name="" />
+              </TabsContent>
+            ))}
+          </ul>
+        </Tabs>
+      </div>
+
+      <Sidecar operation={operation} />
+    </div>
+  );
+};
+
+const ViewSchema = ({
+  name,
+  schema,
+  level = 0,
+  collapsible = false,
+}: {
+  level?: number;
+  collapsible?: boolean;
+  name?: string;
+  schema: SchemaObject;
+}) => {
+  const [open, setOpen] = useState(!collapsible);
+
+  const properties = Object.entries(schema.properties ?? {});
+  const additionalProperties =
+    typeof schema.additionalProperties === "object"
+      ? Object.entries(schema.additionalProperties)
+      : [];
+
+  return (
+    <div
+      className={cn(
+        "not-prose",
+        level > 0 && "border border-border rounded text-sm",
+      )}
+      onClick={
+        collapsible
+          ? () => {
+              setOpen((open) => !open);
+            }
+          : undefined
+      }
+    >
+      {(schema.title ?? name) && (
+        <div className="ml-2 my-1 font-bold">{schema.title ?? name}</div>
+      )}
+      {level === 0 && <p>schema.description</p>}
+      <ul>
+        {open &&
+          properties
+            .concat(additionalProperties)
+            .map(([propertyName, property]) => (
+              <div
+                className={cn(
+                  level > 0 ? "py-2" : "py-4",
+                  "px-2 border-t border-border bg-border/20 hover:bg-border/30 flex gap-1 flex-col",
+                  property.deprecated && "opacity-50",
+                )}
+              >
+                <div className="flex items-center gap-2 relative">
+                  <code>
+                    {propertyName} {property.title}
+                  </code>
+
+                  {property.type && (
+                    <span className="text-sm text-muted-foreground">
+                      {property.type}
+                    </span>
+                  )}
+                  {property.deprecated && (
+                    <span className="text-sm text-muted-foreground">
+                      Deprecated
+                    </span>
+                  )}
+
+                  {!schema.required?.includes(propertyName) &&
+                    !property.required && (
+                      <span className="py-px px-1.5 font-medium text-xs border border-border rounded-lg">
+                        optional
+                      </span>
+                    )}
+                  {/*{property.type === "object" && (*/}
+                  {/*  <div className="absolute right-3">+</div>*/}
+                  {/*)}*/}
+                </div>
+                {property.description && (
+                  <Markdown
+                    content={property.description}
+                    className="prose text-sm prose-p:my-1 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 className="font-mono text-xs border-border border bg-muted rounded px-1">
+                          {value}
+                        </span>
+                      ))}
+                  </span>
+                )}
+                {property.type === "object" && (
+                  <div className="mt-2.5">
+                    <ViewSchema schema={property} level={level + 1} />
+                  </div>
+                )}
+                {property.type === "array" &&
+                  property.items.type === "object" && (
+                    <div className="mt-2.5">
+                      <ViewSchema schema={property.items} level={level + 1} />
+                    </div>
+                  )}
+              </div>
+            ))}
+      </ul>
+    </div>
+  );
+};

package/src/{app → lib}/plugins/openapi/ParameterList.tsx

@@ -1,4 +1,4 @@
-import { Heading } from "../../Heading.js";
+import { Heading } from "../../components/Heading.js";
 import type { ParameterGroup } from "./OperationListItem.js";
 import {
   ParameterListItem,

package/src/{app → lib}/plugins/openapi/ParameterListItem.tsx

@@ -54,7 +54,10 @@ export const ParameterListItem = ({
       )}
     </div>
     {parameter.description && (
-      <Markdown content={parameter.description} className="prose-p:my-1" />
+      <Markdown
+        content={parameter.description}
+        className="text-sm prose-p:my-1"
+      />
     )}
   </li>
 );

package/src/{app → lib}/plugins/openapi/RequestBodySidecarBox.tsx

@@ -34,7 +34,7 @@ export const RequestBodySidecarBox = ({ content }: { content: Content }) => {
           <SyntaxHighlight
             language="json"
             noBackground
-            copyable={false}
+            copyable
             className="text-xs"
             code={JSON.stringify(
               selected === "example"

package/src/{app → lib}/plugins/openapi/ResponsesSidecarBox.tsx

@@ -20,7 +20,7 @@ export const ResponsesSidecarBox = ({
   return (
     <SidecarBox.Root>
       <SidecarBox.Head className="text-xs grid grid-rows-2 pb-0">
-        <span className="font-mono">Responses</span>
+        <span className="font-mono">Example Responses</span>
         <div className="flex gap-2">
           {responses.map((response, index) => (
             <div
@@ -43,7 +43,6 @@ export const ResponsesSidecarBox = ({
           <SyntaxHighlight
             language="json"
             noBackground
-            copyable={false}
             className="text-xs"
             code={JSON.stringify(generateSchemaExample(schema), null, 2)}
           />

package/src/{app → lib}/plugins/openapi/Sidecar.tsx

@@ -111,7 +111,6 @@ export const Sidecar = ({
   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)}>
@@ -120,35 +119,36 @@ export const Sidecar = ({
             &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" },
-            ]}
-          />
+          <div className="flex gap-2 items-center">
+            <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" },
+              ]}
+            />
+            <MakeRequest operation={operation} />
+          </div>
         </SidecarBox.Head>
         <SidecarBox.Body>
           <SyntaxHighlight
             language={option}
-            copyable={false}
             noBackground
             className="text-xs"
             code={code}
           />
         </SidecarBox.Body>
       </SidecarBox.Root>
-      {/*<MakeRequest />*/}
       {requestBodyContent && (
         <RequestBodySidecarBox content={requestBodyContent} />
       )}

package/src/{app → lib}/plugins/openapi/graphql/gql.ts

@@ -19,7 +19,7 @@ const documents = {
     types.OperationsFragmentFragmentDoc,
   "\n  query AllOperations($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      description\n      title\n      url\n      version\n      tags {\n        name\n        description\n        operations {\n          slug\n          ...OperationsFragment\n        }\n      }\n    }\n  }\n":
     types.AllOperationsDocument,
-  "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n":
+  "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n":
     types.GetCategoriesDocument,
 };
 
@@ -59,8 +59,8 @@ export function graphql(
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
-  source: "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n",
-): (typeof documents)["\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n"];
+  source: "\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n",
+): (typeof documents)["\n  query GetCategories($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      tags {\n        __typename\n        name\n        operations {\n          __typename\n          slug\n          deprecated\n          method\n          summary\n          operationId\n          path\n        }\n      }\n    }\n  }\n"];
 
 export function graphql(source: string) {
   return (documents as any)[source] ?? {};

package/src/{app → lib}/plugins/openapi/graphql/graphql.ts

@@ -259,6 +259,7 @@ export type GetCategoriesQuery = {
       operations: Array<{
         __typename: "OperationItem";
         slug: string;
+        deprecated?: boolean | null;
         method: string;
         summary?: string | null;
         operationId?: string | null;
@@ -763,6 +764,10 @@ export const GetCategoriesDocument = {
                               kind: "Field",
                               name: { kind: "Name", value: "slug" },
                             },
+                            {
+                              kind: "Field",
+                              name: { kind: "Name", value: "deprecated" },
+                            },
                             {
                               kind: "Field",
                               name: { kind: "Name", value: "method" },

package/src/{app → lib}/plugins/openapi/index.tsx

@@ -13,7 +13,9 @@ import {
   cacheExchange,
   fetchExchange,
 } from "./util/urql.js";
-import { createSharedWorkerClient } from "./worker/createSharedWorkerClient.js";
+
+import { createSharedWorkerClient } from "virtual:zudoku-openapi-worker";
+import type { createSharedWorkerClient as createSharedWorkerClientType } from "./worker/createSharedWorkerClient.js";
 
 const OasContext = createContext<{ config: OasPluginConfig } | undefined>(
   undefined,
@@ -64,6 +66,7 @@ const GetCategoriesQuery = graphql(`
         operations {
           __typename
           slug
+          deprecated
           method
           summary
           operationId
@@ -82,7 +85,9 @@ export const openApiPlugin = (config: OasPluginConfig): DevPortalPlugin => {
         url: config.server,
         exchanges: [cacheExchange, fetchExchange],
       })
-    : createSharedWorkerClient();
+    : (createSharedWorkerClient() as ReturnType<
+        typeof createSharedWorkerClientType
+      >);
 
   return {
     getNavigation: async (path: string) => {
@@ -105,6 +110,7 @@ export const openApiPlugin = (config: OasPluginConfig): DevPortalPlugin => {
           collapsible: false,
           children: tag.operations.map((operation) => ({
             path: `#${operation.slug}`,
+            muted: !!operation.deprecated,
             title: operation.summary ?? operation.path,
             label: (
               <div className="flex flex-1 min-w-0 justify-between gap-2">

package/src/lib/plugins/openapi/playground/Editor.tsx

@@ -0,0 +1,6 @@
+import { lazy } from "react";
+
+export const Editor = () => {
+  // const XoXo = lazy(() => import("@monaco-editor/react"));
+  // return <XoXo />;
+};

package/src/lib/plugins/openapi/playground/Headers.tsx

@@ -0,0 +1,60 @@
+import { Control, useFieldArray, UseFormRegister } from "react-hook-form";
+import { XIcon } from "lucide-react";
+import { InlineInput } from "./InlineInput.js";
+import type { PlaygroundForm, Header } from "./Playground.js";
+import { Button } from "../../../ui/Button.js";
+
+export const Headers = ({
+  control,
+  register,
+  headers,
+}: {
+  register: UseFormRegister<PlaygroundForm>;
+  control: Control<PlaygroundForm>;
+  headers: Header[];
+}) => {
+  const { fields, append, remove } = useFieldArray<PlaygroundForm>({
+    control,
+    name: "headers",
+  });
+  return (
+    <div className="grid grid-cols-[1fr_1fr_auto]">
+      {fields.map((header, i) => (
+        <div
+          key={header.id}
+          className="grid-cols-subgrid col-span-full grid items-center gap-x-2 has-[:focus]:bg-muted hover:bg-muted rounded overflow-hidden group"
+        >
+          <InlineInput
+            {...register(`headers.${i}.name`)}
+            placeholder="Name"
+            className="peer"
+            autoComplete="off"
+          />
+          <InlineInput
+            placeholder={"Value"}
+            className="peer"
+            {...register(`headers.${i}.value`)}
+            autoComplete="off"
+          />
+          <button
+            className="hover:bg-black/5 p-1 rounded mr-2 text-muted-foreground invisible group-hover:visible peer-focus:visible"
+            onClick={() => {
+              remove(i);
+            }}
+            type="button"
+          >
+            <XIcon size={16} />
+          </button>
+          <div className="col-span-full border-b border-border"></div>
+        </div>
+      ))}
+      <Button
+        className="col-span-full mt-4"
+        onClick={() => append({ name: "", value: "" })}
+        type="button"
+      >
+        Add header
+      </Button>
+    </div>
+  );
+};

package/src/lib/plugins/openapi/playground/InlineInput.tsx

@@ -0,0 +1,6 @@
+import createVariantComponent from "../../../util/createVariantComponent.js";
+
+export const InlineInput = createVariantComponent(
+  "input",
+  "px-2 bg-transparent h-6 font-mono text-xs m-2",
+);

package/src/lib/plugins/openapi/playground/PathParams.tsx

@@ -0,0 +1,63 @@
+import { Control, useFieldArray, UseFormRegister } from "react-hook-form";
+import { InlineInput } from "./InlineInput.js";
+import { PlaygroundForm } from "./Playground.js";
+import { DATA_ATTR, usePastellizedColor } from "../ColorizedParam.js";
+import { forwardRef, InputHTMLAttributes } from "react";
+import { cn } from "../../../util/cn.js";
+
+type ParameterValueProps = {
+  part: string;
+} & InputHTMLAttributes<HTMLInputElement>;
+
+const ParameterValue = forwardRef<HTMLInputElement, ParameterValueProps>(
+  ({ part, className, ...props }, ref) => {
+    const color = usePastellizedColor(part);
+    return (
+      <InlineInput
+        {...props}
+        ref={ref}
+        className={cn(className, "opacity-80 data-[active=true]:opacity-100")}
+        style={{
+          // color: `hsl(${color})`,
+          outlineColor: `hsl(${color})`,
+        }}
+      />
+    );
+  },
+);
+
+export const PathParams = ({
+  control,
+  register,
+}: {
+  register: UseFormRegister<PlaygroundForm>;
+  control: Control<PlaygroundForm>;
+}) => {
+  const { fields } = useFieldArray<PlaygroundForm>({
+    control,
+    name: "pathParams",
+  });
+
+  return fields.map((part, i) => (
+    <div
+      key={part.id}
+      className="grid-cols-subgrid col-span-full grid items-center gap-x-2 has-[:focus]:bg-muted hover:bg-muted rounded overflow-hidden group"
+    >
+      <InlineInput
+        {...register(`pathParams.${i}.name`)}
+        disabled
+        placeholder="Name"
+        className="peer"
+      />
+      <ParameterValue
+        {...register(`pathParams.${i}.value`)}
+        part={part.name}
+        {...{ [DATA_ATTR]: part.name }}
+        placeholder="Value"
+        className="peer"
+      />
+
+      <div className="col-span-full border-b border-border"></div>
+    </div>
+  ));
+};