zudoku 0.0.0-f3786a4 → 0.0.0-f3d517c

package/src/lib/plugins/openapi/playground/result-panel/ResultPanel.tsx

@@ -0,0 +1,126 @@
+import { type UseMutationResult } from "@tanstack/react-query";
+import { Spinner } from "../../../../components/Spinner.js";
+import { Button } from "../../../../ui/Button.js";
+import { Callout } from "../../../../ui/Callout.js";
+import {
+  Card,
+  CardContent,
+  CardHeader,
+  CardTitle,
+} from "../../../../ui/Card.js";
+import {
+  Tabs,
+  TabsContent,
+  TabsList,
+  TabsTrigger,
+} from "../../../../ui/Tabs.js";
+import { cn } from "../../../../util/cn.js";
+import { type PlaygroundResult } from "../Playground.js";
+import { RequestTab } from "./RequestTab.js";
+import { ResponseTab } from "./ResponseTab.js";
+
+export const ResultPanel = ({
+  queryMutation,
+  showPathParamsWarning,
+  showLongRunningWarning,
+  onCancel,
+}: {
+  queryMutation: UseMutationResult<PlaygroundResult, Error, any>;
+  showPathParamsWarning: boolean;
+  showLongRunningWarning?: boolean;
+  onCancel?: () => void;
+}) => {
+  const status = ((queryMutation.data?.status ?? 0) / 100).toFixed(0);
+  return (
+    <div className="min-w-0 p-4 py-4 bg-muted/50">
+      {queryMutation.error ? (
+        <div className="flex flex-col gap-2">
+          {showPathParamsWarning && (
+            <Callout type="caution">
+              Some path parameters are missing values. Please fill them in to
+              ensure the request is sent correctly.
+            </Callout>
+          )}
+          <Card>
+            <CardHeader>
+              <CardTitle>Request failed</CardTitle>
+            </CardHeader>
+            <CardContent>
+              Error:{" "}
+              {queryMutation.error.message ||
+                String(queryMutation.error) ||
+                "Unexpected error"}
+            </CardContent>
+          </Card>
+        </div>
+      ) : queryMutation.data ? (
+        <Tabs defaultValue="response">
+          <TabsList>
+            <TabsTrigger value="request">Request</TabsTrigger>
+            <TabsTrigger value="response">
+              Response
+              <span
+                className={cn(
+                  "text-xs font-mono ms-1",
+                  status === "2" && "text-green-500",
+                  status === "3" && "text-blue-500",
+                  status === "4" && "text-yellow-500",
+                  status === "5" && "text-red-500",
+                )}
+              >
+                ({queryMutation.data.status})
+              </span>
+            </TabsTrigger>
+          </TabsList>
+          <TabsContent value="request">
+            <RequestTab {...queryMutation.data.request} />
+          </TabsContent>
+          <TabsContent value="response">
+            <ResponseTab
+              status={queryMutation.data.status}
+              time={queryMutation.data.time}
+              size={queryMutation.data.size}
+              headers={queryMutation.data.headers}
+              body={queryMutation.data.body}
+              url={queryMutation.data.request.url}
+              isBinary={queryMutation.data.isBinary}
+              fileName={queryMutation.data.fileName}
+              blob={queryMutation.data.blob}
+            />
+          </TabsContent>
+        </Tabs>
+      ) : (
+        <div className="grid place-items-center h-full">
+          {queryMutation.isPending ? (
+            <div className="flex flex-col gap-2 items-center mt-20">
+              <Spinner size={20} />
+              <div
+                className={cn(
+                  "opacity-0 pointer-events-none transition-opacity h-20 text-sm text-muted-foreground duration-300 flex flex-col gap-2 items-center",
+                  showLongRunningWarning && "opacity-100 pointer-events-auto",
+                )}
+              >
+                Looks like the request is taking longer than expected.
+                <Button
+                  type="button"
+                  onClick={onCancel}
+                  size="sm"
+                  className="w-fit"
+                  variant="outline"
+                >
+                  Cancel
+                </Button>
+              </div>
+            </div>
+          ) : (
+            <span className="text-[16px] font-semibold text-muted-foreground">
+              Send a request first to see the response here
+            </span>
+          )}
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default ResultPanel;

package/src/lib/plugins/openapi/playground/result-panel/convertToTypes.test.ts

@@ -0,0 +1,64 @@
+import { describe, expect, it } from "vitest";
+import { generateInterface } from "./convertToTypes.js";
+
+describe("generateInterface", () => {
+  it("should handle primitive types", () => {
+    const input = {
+      string: "hello",
+      number: 42,
+      boolean: true,
+      null: null,
+    };
+
+    const expected = [
+      "{",
+      "  string: string;",
+      "  number: number;",
+      "  boolean: boolean;",
+      "  null: null;",
+      "}",
+    ].join("\n");
+
+    expect(generateInterface(input)).toBe(expected);
+  });
+
+  it("should handle nested objects", () => {
+    const input = {
+      user: {
+        name: "John",
+        age: 30,
+      },
+    };
+
+    const expected = [
+      "{",
+      "  user: {",
+      "  name: string;",
+      "  age: number;",
+      "};",
+      "}",
+    ].join("\n");
+
+    expect(generateInterface(input)).toBe(expected);
+  });
+
+  it("should handle arrays", () => {
+    const input = {
+      numbers: [1, 2, 3],
+      empty: [],
+      objects: [{ id: 1 }],
+    };
+
+    const expected = [
+      "{",
+      "  numbers: number[];",
+      "  empty: any[];",
+      "  objects: {",
+      "  id: number;",
+      "}[];",
+      "}",
+    ].join("\n");
+
+    expect(generateInterface(input)).toBe(expected);
+  });
+});

package/src/lib/plugins/openapi/playground/result-panel/convertToTypes.ts

@@ -0,0 +1,36 @@
+type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
+type JsonObject = { [key: string]: JsonValue };
+type JsonArray = JsonValue[];
+
+function inferType(value: JsonValue): string {
+  if (value === null) return "null";
+  if (Array.isArray(value)) {
+    if (value.length === 0) return "any[]";
+    const firstValue = value[0];
+    if (firstValue === undefined) return "any[]";
+    const elementType = inferType(firstValue);
+    return `${elementType}[]`;
+  }
+  if (typeof value === "object") {
+    return generateInterface(value);
+  }
+  return typeof value;
+}
+
+export function generateInterface(obj: JsonObject, indentation = ""): string {
+  const lines: string[] = ["{"];
+
+  for (const [key, value] of Object.entries(obj)) {
+    const propertyType = inferType(value);
+    lines.push(`  ${key}: ${propertyType};`);
+  }
+
+  lines.push("}");
+  return lines.join("\n");
+}
+
+export function convertToTypes(json: JsonValue): { lines: string[] } {
+  const typeDefinition = inferType(json);
+  const lines = [`type GeneratedType = ${typeDefinition};`];
+  return { lines };
+}

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

@@ -0,0 +1,20 @@
+import { create } from "zustand";
+import { createJSONStorage, persist } from "zustand/middleware";
+
+type RememberSkipLoginState = {
+  skipLogin: boolean;
+  setSkipLogin: (skipLogin: boolean) => void;
+};
+
+export const useRememberSkipLoginDialog = create<RememberSkipLoginState>()(
+  persist(
+    (set) => ({
+      skipLogin: false,
+      setSkipLogin: (skipLogin: boolean) => set({ skipLogin }),
+    }),
+    {
+      name: "remember-skip-login",
+      storage: createJSONStorage(() => sessionStorage),
+    },
+  ),
+);

package/src/lib/plugins/openapi/{post-processors → processors}/removeExtensions.test.ts

@@ -64,11 +64,15 @@ const baseDoc = {
       },
     },
   },
-};
+} as any;
 
 describe("removeExtensions", () => {
   it("removes all x- extensions by default", () => {
-    const processed = removeExtensions()(baseDoc);
+    const processed = removeExtensions()({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
 
     const removedExtensions = [
       "x-root-ext",
@@ -93,7 +97,7 @@ describe("removeExtensions", () => {
       ["paths", "/test", "get", "responses", "200", "description"],
       "OK",
     );
-    expect(processed.tags[0].name).toBe("example");
+    expect(processed.tags?.[0]?.name).toBe("example");
   });
 
   it("removes only specified x- extensions when names are provided", () => {
@@ -104,7 +108,11 @@ describe("removeExtensions", () => {
 
     const processed = removeExtensions({
       keys: ["x-path-ext", "x-param-ext"],
-    })(docWithExtraExtensions);
+    })({
+      schema: docWithExtraExtensions,
+      file: "/file.json",
+      dereference: async (id) => id,
+    }) as any;
 
     // Assert specified extensions are removed
     expect(processed.paths["/test"]["x-path-ext"]).toBeUndefined();
@@ -131,9 +139,13 @@ describe("removeExtensions", () => {
           },
         },
       },
-    };
+    } as any;
 
-    const processed = removeExtensions()(deeplyNested);
+    const processed = removeExtensions()({
+      schema: deeplyNested,
+      file: "/file.json",
+      dereference: async (id) => id,
+    }) as any;
 
     expect(processed.a.b.c["x-deep-ext"]).toBeUndefined();
     expect(processed.a.b.c.d["x-another-ext"]).toBeUndefined();
@@ -144,9 +156,13 @@ describe("removeExtensions", () => {
     const docWithoutExtensions = {
       openapi: "3.1.0",
       info: { title: "API without extensions" },
-    };
+    } as any;
 
-    const processed = removeExtensions()(docWithoutExtensions);
+    const processed = removeExtensions()({
+      schema: docWithoutExtensions,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
 
     expect(processed).toEqual(docWithoutExtensions);
   });
@@ -154,7 +170,11 @@ describe("removeExtensions", () => {
   it("removes extensions based on shouldRemove callback", () => {
     const processed = removeExtensions({
       shouldRemove: (key) => key.startsWith("x-zuplo"),
-    })(baseDoc);
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
 
     // Should remove x-zuplo extensions
     const removedExtensions = [

package/src/lib/plugins/openapi/{post-processors → processors}/removeExtensions.ts

@@ -1,3 +1,5 @@
+import type { ProcessorArg } from "../../../../config/validators/BuildSchema.js";
+import type { OpenAPIDocument } from "../../../oas/parser/index.js";
 import { type RecordAny, traverse } from "./traverse.js";
 
 interface RemoveExtensionsOptions {
@@ -8,8 +10,8 @@ interface RemoveExtensionsOptions {
 // Remove all `x-` prefixed key/value pairs, or filter by names if provided
 export const removeExtensions =
   ({ keys, shouldRemove }: RemoveExtensionsOptions = {}) =>
-  (doc: RecordAny): RecordAny =>
-    traverse(doc, (spec) => {
+  ({ schema }: ProcessorArg) =>
+    traverse(schema, (spec) => {
       const result: RecordAny = {};
 
       for (const [key, value] of Object.entries(spec)) {
@@ -24,4 +26,4 @@ export const removeExtensions =
         result[key] = value;
       }
       return result;
-    });
+    }) as OpenAPIDocument;

package/src/lib/plugins/openapi/{post-processors → processors}/removeParameters.test.ts

@@ -1,8 +1,8 @@
-import { type OpenAPIV3_1 } from "openapi-types";
 import { describe, expect, it } from "vitest";
+import type { OpenAPIDocument } from "../../../oas/parser/index.js";
 import { removeParameters } from "./removeParameters.js";
 
-const baseDoc: OpenAPIV3_1.Document = {
+const baseDoc: OpenAPIDocument = {
   openapi: "3.1.0",
   info: {
     title: "Test API",
@@ -67,45 +67,67 @@ describe("removeParameters", () => {
   it("removes parameters by name", () => {
     const processed = removeParameters({
       names: ["pathParam", "opParam"],
-    })(baseDoc);
-
-    expect(processed.paths["/test"].parameters).toHaveLength(1);
-    expect(processed.paths["/test"].parameters[0].name).toBe("pathHeader");
-    expect(processed.paths["/test"].get.parameters).toHaveLength(1);
-    expect(processed.paths["/test"].get.parameters[0].name).toBe("opHeader");
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/test"]?.parameters).toHaveLength(1);
+    expect(processed.paths?.["/test"]?.parameters?.[0]?.name).toBe(
+      "pathHeader",
+    );
+    expect(processed.paths?.["/test"]?.get?.parameters).toHaveLength(1);
+    expect(processed.paths?.["/test"]?.get?.parameters?.[0]?.name).toBe(
+      "opHeader",
+    );
   });
 
   it("removes parameters by location", () => {
     const processed = removeParameters({
       in: ["header"],
-    })(baseDoc);
-
-    expect(processed.paths["/test"].parameters).toHaveLength(1);
-    expect(processed.paths["/test"].parameters[0].in).toBe("path");
-    expect(processed.paths["/test"].get.parameters).toHaveLength(1);
-    expect(processed.paths["/test"].get.parameters[0].in).toBe("query");
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/test"]?.parameters).toHaveLength(1);
+    expect(processed.paths?.["/test"]?.parameters?.[0]?.in).toBe("path");
+    expect(processed.paths?.["/test"]?.get?.parameters).toHaveLength(1);
+    expect(processed.paths?.["/test"]?.get?.parameters?.[0]?.in).toBe("query");
   });
 
   it("removes parameters using shouldRemove callback", () => {
     const processed = removeParameters({
       shouldRemove: ({ parameter }) =>
         parameter.in === "header" && parameter.name.includes("op"),
-    })(baseDoc);
-
-    expect(processed.paths["/test"].parameters).toHaveLength(2);
-    expect(processed.paths["/test"].get.parameters).toHaveLength(1);
-    expect(processed.paths["/test"].get.parameters[0].name).toBe("opParam");
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/test"]?.parameters).toHaveLength(2);
+    expect(processed.paths?.["/test"]?.get?.parameters).toHaveLength(1);
+    expect(processed.paths?.["/test"]?.get?.parameters?.[0]?.name).toBe(
+      "opParam",
+    );
   });
 
   it("combines multiple removal criteria", () => {
     const processed = removeParameters({
       in: ["query", "header"],
       shouldRemove: ({ parameter }) => parameter.name === "pathHeader",
-    })(baseDoc);
-
-    expect(processed.paths["/test"].parameters).toHaveLength(1);
-    expect(processed.paths["/test"].parameters[0].name).toBe("pathParam");
-    expect(processed.paths["/test"].get.parameters).toHaveLength(0);
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/test"]?.parameters).toHaveLength(1);
+    expect(processed.paths?.["/test"]?.parameters?.[0]?.name).toBe("pathParam");
+    expect(processed.paths?.["/test"]?.get?.parameters).toHaveLength(0);
   });
 
   it("handles missing parameters arrays", () => {
@@ -118,11 +140,15 @@ describe("removeParameters", () => {
           },
         },
       },
-    };
+    } as any;
 
     const processed = removeParameters({
       names: ["someParam"],
-    })(docWithoutParams);
+    })({
+      schema: docWithoutParams,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
 
     expect(processed).toEqual(docWithoutParams);
   });
@@ -130,19 +156,27 @@ describe("removeParameters", () => {
   it("preserves non-parameter properties", () => {
     const processed = removeParameters({
       names: ["globalParam"],
-    })(baseDoc);
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
 
     expect(processed.openapi).toBe("3.1.0");
-    expect(processed.paths["/test"].get).toBeDefined();
+    expect(processed.paths?.["/test"]?.get).toBeDefined();
   });
 
   it("removes parameters from components", () => {
     const processed = removeParameters({
       in: ["header"],
-    })(baseDoc);
-
-    expect(Object.keys(processed.components.parameters)).toHaveLength(1);
-    expect(processed.components.parameters.commonParam).toBeDefined();
-    expect(processed.components.parameters.headerParam).toBeUndefined();
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(Object.keys(processed.components?.parameters ?? {})).toHaveLength(1);
+    expect(processed.components?.parameters?.commonParam).toBeDefined();
+    expect(processed.components?.parameters?.headerParam).toBeUndefined();
   });
 });

package/src/lib/plugins/openapi/{post-processors → processors}/removeParameters.ts

@@ -1,3 +1,5 @@
+import type { ProcessorArg } from "../../../../config/validators/BuildSchema.js";
+import type { OpenAPIDocument } from "../../../oas/parser/index.js";
 import { type RecordAny, traverse } from "./traverse.js";
 
 interface RemoveParametersOptions {
@@ -11,8 +13,8 @@ interface RemoveParametersOptions {
 
 export const removeParameters =
   ({ names, in: locations, shouldRemove }: RemoveParametersOptions = {}) =>
-  (doc: RecordAny): RecordAny =>
-    traverse(doc, (spec) => {
+  ({ schema }: ProcessorArg) =>
+    traverse(schema, (spec) => {
       // Helper function to filter parameters
       const filterParameters = (parameters: RecordAny[]) =>
         parameters.filter((p) => {
@@ -98,4 +100,4 @@ export const removeParameters =
       }
 
       return spec;
-    });
+    }) as OpenAPIDocument;