zudoku 0.1.1-dev.2 → 0.1.1-dev.21

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

@@ -1,14 +1,14 @@
-import { type ResultOf } from "gql.tada";
 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 { graphql } from "./graphql/index.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(`
+export const OperationsFragment = graphql(/* GraphQL */ `
   fragment OperationsFragment on OperationItem {
     slug
     summary
@@ -51,32 +51,30 @@ export const OperationsFragment = graphql(`
   }
 `);
 
-const AllOperationsQuery = graphql(
-  `
-    query AllOperations($input: JSON!, $type: SchemaType!) {
-      schema(input: $input, type: $type) {
+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
-        title
-        url
-        version
-        tags {
-          name
-          description
-          operations {
-            slug
-            ...OperationsFragment
-          }
+        operations {
+          slug
+          ...OperationsFragment
         }
       }
     }
-  `,
-  [OperationsFragment],
-);
-
-export type OperationListItemResult = ResultOf<typeof OperationsFragment>;
+  }
+`);
 
 export const OperationList = () => {
   const { type, input } = useOasConfig();
+
   const [result] = useQuery({
     query: AllOperationsQuery,
     variables: { type, input },

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

@@ -1,10 +1,10 @@
-import { readFragment, type FragmentOf } from "gql.tada";
 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];
@@ -12,9 +12,9 @@ export type ParameterGroup = (typeof PARAM_GROUPS)[number];
 export const OperationListItem = ({
   operationFragment,
 }: {
-  operationFragment: FragmentOf<typeof OperationsFragment>;
+  operationFragment: FragmentType<typeof OperationsFragment>;
 }) => {
-  const operation = readFragment(OperationsFragment, operationFragment);
+  const operation = useFragment(OperationsFragment, operationFragment);
   const groupedParameters = groupBy(operation?.parameters ?? [], "in");
 
   return (

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/{app → lib}/plugins/openapi/ResponsesSidecarBox.tsx

@@ -3,7 +3,7 @@ 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 { SidecarBox } from "./SidecarBox.js";
+import * as SidecarBox from "./SidecarBox.js";
 import { generateSchemaExample } from "./util/generateSchemaExample.js";
 
 type Responses = OperationListItemResult["responses"];

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

@@ -1,4 +1,4 @@
-import { Fragment, useState } from "react";
+import { Fragment, useMemo, useState } from "react";
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
 import { cn } from "../../util/cn.js";
 import { ColorizedParam } from "./ColorizedParam.js";
@@ -8,8 +8,54 @@ import type { OperationListItemResult } from "./OperationList.js";
 import { RequestBodySidecarBox } from "./RequestBodySidecarBox.js";
 import { ResponsesSidecarBox } from "./ResponsesSidecarBox.js";
 import { Select } from "./Select.js";
-import { SidecarBox } from "./SidecarBox.js";
-import { getCode } from "./util/getCode.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,
@@ -40,16 +86,27 @@ export const Sidecar = ({
     </Fragment>
   ));
 
-  const language =
-    {
-      js: "javascript",
-      go: "go",
-      rust: "rust",
-      curl: "bash",
-      wget: "bash",
-      ruby: "ruby",
-      php: "php",
-    }[option] ?? "bash";
+  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">
@@ -67,23 +124,27 @@ export const Sidecar = ({
             className="self-start"
             onChange={(e) => setOption(e.target.value)}
             options={[
-              { value: "curl", label: "cURL" },
-              { value: "wget", label: "wget" },
+              { value: "shell", label: "cURL" },
               { value: "js", label: "Javascript" },
-              { value: "ruby", label: "Ruby" },
-              { value: "php", label: "PHP" },
+              { value: "python", label: "Python" },
+              { value: "java", label: "Java" },
               { value: "go", label: "Go" },
-              { value: "rust", label: "Rust" },
+              { 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={language}
+            language={option}
             copyable={false}
             noBackground
             className="text-xs"
-            code={getCode(operation, option.toLowerCase())}
+            code={code}
           />
         </SidecarBox.Body>
       </SidecarBox.Root>

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

@@ -0,0 +1,36 @@
+import type { PropsWithChildren } from "react";
+import { cn } from "../../util/cn.js";
+
+type BaseComponentProps<T = unknown> = PropsWithChildren<
+  T & { className?: string }
+>;
+
+export const Root = ({ children, className }: BaseComponentProps) => (
+  <div
+    className={cn(
+      "rounded-lg overflow-hidden border border-border dark:border-transparent",
+      className,
+    )}
+  >
+    {children}
+  </div>
+);
+
+export const Head = ({ children, className }: BaseComponentProps) => (
+  <div
+    className={cn(
+      "border-b border-b-border dark:border-b-zinc-600 bg-zinc-100 dark:bg-zinc-700 p-2",
+      className,
+    )}
+  >
+    {children}
+  </div>
+);
+
+export const Body = ({ children, className }: BaseComponentProps) => (
+  <div
+    className={cn("bg-zinc-50 dark:bg-zinc-800 overflow-auto p-2", className)}
+  >
+    {children}
+  </div>
+);

package/src/lib/plugins/openapi/graphql/fragment-masking.ts

@@ -0,0 +1,111 @@
+/* eslint-disable */
+import type {
+  ResultOf,
+  DocumentTypeDecoration,
+  TypedDocumentNode,
+} from "@graphql-typed-document-node/core";
+import type { FragmentDefinitionNode } from "graphql";
+import type { Incremental } from "./graphql.js";
+
+export type FragmentType<
+  TDocumentType extends DocumentTypeDecoration<any, any>,
+> =
+  TDocumentType extends DocumentTypeDecoration<infer TType, any>
+    ? [TType] extends [{ " $fragmentName"?: infer TKey }]
+      ? TKey extends string
+        ? { " $fragmentRefs"?: { [key in TKey]: TType } }
+        : never
+      : never
+    : never;
+
+// return non-nullable if `fragmentType` is non-nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>>,
+): TType;
+// return nullable if `fragmentType` is undefined
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | undefined,
+): TType | undefined;
+// return nullable if `fragmentType` is nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null,
+): TType | null;
+// return nullable if `fragmentType` is nullable or undefined
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType:
+    | FragmentType<DocumentTypeDecoration<TType, any>>
+    | null
+    | undefined,
+): TType | null | undefined;
+// return array of non-nullable if `fragmentType` is array of non-nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>>,
+): Array<TType>;
+// return array of nullable if `fragmentType` is array of nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType:
+    | Array<FragmentType<DocumentTypeDecoration<TType, any>>>
+    | null
+    | undefined,
+): Array<TType> | null | undefined;
+// return readonly array of non-nullable if `fragmentType` is array of non-nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>,
+): ReadonlyArray<TType>;
+// return readonly array of nullable if `fragmentType` is array of nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType:
+    | ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
+    | null
+    | undefined,
+): ReadonlyArray<TType> | null | undefined;
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType:
+    | FragmentType<DocumentTypeDecoration<TType, any>>
+    | Array<FragmentType<DocumentTypeDecoration<TType, any>>>
+    | ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
+    | null
+    | undefined,
+): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
+  return fragmentType as any;
+}
+
+export function makeFragmentData<
+  F extends DocumentTypeDecoration<any, any>,
+  FT extends ResultOf<F>,
+>(data: FT, _fragment: F): FragmentType<F> {
+  return data as FragmentType<F>;
+}
+export function isFragmentReady<TQuery, TFrag>(
+  queryNode: DocumentTypeDecoration<TQuery, any>,
+  fragmentNode: TypedDocumentNode<TFrag>,
+  data:
+    | FragmentType<TypedDocumentNode<Incremental<TFrag>, any>>
+    | null
+    | undefined,
+): data is FragmentType<typeof fragmentNode> {
+  const deferredFields = (
+    queryNode as {
+      __meta__?: { deferredFields: Record<string, (keyof TFrag)[]> };
+    }
+  ).__meta__?.deferredFields;
+
+  if (!deferredFields) return true;
+
+  const fragDef = fragmentNode.definitions[0] as
+    | FragmentDefinitionNode
+    | undefined;
+  const fragName = fragDef?.name?.value;
+
+  const fields = (fragName && deferredFields[fragName]) || [];
+  return fields.length > 0 && fields.every((field) => data && field in data);
+}

package/src/lib/plugins/openapi/graphql/gql.ts

@@ -0,0 +1,70 @@
+/* eslint-disable */
+import * as types from "./graphql.js";
+import type { TypedDocumentNode as DocumentNode } from "@graphql-typed-document-node/core";
+
+/**
+ * Map of all GraphQL operations in the project.
+ *
+ * This map has several performance disadvantages:
+ * 1. It is not tree-shakeable, so it will include all operations in the project.
+ * 2. It is not minifiable, so the string of a GraphQL query will be multiple times inside the bundle.
+ * 3. It does not support dead code elimination, so it will add unused operations.
+ *
+ * Therefore it is highly recommended to use the babel or swc plugin for production.
+ */
+const documents = {
+  "\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n    }\n  }\n":
+    types.GetServerQueryDocument,
+  "\n  fragment OperationsFragment on OperationItem {\n    slug\n    summary\n    method\n    description\n    operationId\n    contentTypes\n    path\n    parameters {\n      name\n      in\n      description\n      required\n      schema\n      style\n    }\n    requestBody {\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n      description\n      required\n    }\n    responses {\n      statusCode\n      links\n      description\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n    }\n  }\n":
+    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":
+    types.GetCategoriesDocument,
+};
+
+/**
+ * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
+ *
+ *
+ * @example
+ * ```ts
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * ```
+ *
+ * The query argument is unknown!
+ * Please regenerate the types.
+ */
+export function graphql(source: string): unknown;
+
+/**
+ * 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 getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n    }\n  }\n",
+): (typeof documents)["\n  query getServerQuery($input: JSON!, $type: SchemaType!) {\n    schema(input: $input, type: $type) {\n      url\n    }\n  }\n"];
+/**
+ * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
+ */
+export function graphql(
+  source: "\n  fragment OperationsFragment on OperationItem {\n    slug\n    summary\n    method\n    description\n    operationId\n    contentTypes\n    path\n    parameters {\n      name\n      in\n      description\n      required\n      schema\n      style\n    }\n    requestBody {\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n      description\n      required\n    }\n    responses {\n      statusCode\n      links\n      description\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n    }\n  }\n",
+): (typeof documents)["\n  fragment OperationsFragment on OperationItem {\n    slug\n    summary\n    method\n    description\n    operationId\n    contentTypes\n    path\n    parameters {\n      name\n      in\n      description\n      required\n      schema\n      style\n    }\n    requestBody {\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n      description\n      required\n    }\n    responses {\n      statusCode\n      links\n      description\n      content {\n        mediaType\n        encoding {\n          name\n        }\n        schema\n      }\n    }\n  }\n"];
+/**
+ * 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 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",
+): (typeof documents)["\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"];
+/**
+ * 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"];
+
+export function graphql(source: string) {
+  return (documents as any)[source] ?? {};
+}
+
+export type DocumentType<TDocumentNode extends DocumentNode<any, any>> =
+  TDocumentNode extends DocumentNode<infer TType, any> ? TType : never;