zudoku 0.0.0-ec30b50 → 0.0.0-ed94abf

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

@@ -1,5 +1,6 @@
-import { UseMutationResult } from "@tanstack/react-query";
+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,
@@ -14,20 +15,24 @@ import {
   TabsTrigger,
 } from "../../../../ui/Tabs.js";
 import { cn } from "../../../../util/cn.js";
-import { PlaygroundResult } from "../Playground.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, unknown>;
+  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-8 bg-muted/70 overflow-y-auto">
+    <div className="min-w-0 p-4 py-8 bg-muted/50">
       {queryMutation.error ? (
         <div className="flex flex-col gap-2">
           {showPathParamsWarning && (
@@ -49,49 +54,66 @@ export const ResultPanel = ({
           </Card>
         </div>
       ) : queryMutation.data ? (
-        <div className="flex flex-col gap-2">
-          <Tabs defaultValue="response">
-            <TabsList>
-              <TabsTrigger value="request">Request</TabsTrigger>
-              <TabsTrigger value="response">
-                Response
-                <span
-                  className={cn(
-                    "text-xs font-mono ml-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}
-              />
-            </TabsContent>
-          </Tabs>
-        </div>
+        <Tabs defaultValue="response">
+          <TabsList>
+            <TabsTrigger value="request">Request</TabsTrigger>
+            <TabsTrigger value="response">
+              Response
+              <span
+                className={cn(
+                  "text-xs font-mono ml-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}
+            />
+          </TabsContent>
+        </Tabs>
       ) : (
         <div className="grid place-items-center h-full">
-          <span className="text-[16px] font-semibold text-muted-foreground">
-            {queryMutation.isPending ? (
-              <Spinner />
-            ) : (
-              "Send a request first to see the response here"
-            )}
-          </span>
+          {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>

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;

package/src/lib/plugins/openapi/processors/removePaths.test.ts

@@ -0,0 +1,167 @@
+import { describe, expect, it } from "vitest";
+import type { OpenAPIDocument } from "../../../oas/parser/index.js";
+import { removePaths } from "./removePaths.js";
+
+const baseDoc = {
+  openapi: "3.0.3",
+  paths: {
+    "/example": {
+      get: { summary: "Get example" },
+      post: { summary: "Post example" },
+    },
+    "/remove-me": {
+      delete: { summary: "Delete example" },
+    },
+    "/another": {
+      get: { summary: "Another example" },
+    },
+  },
+} as unknown as OpenAPIDocument;
+
+describe("removePaths", () => {
+  it("removes paths specified in the paths option", () => {
+    const processed = removePaths({
+      paths: {
+        "/remove-me": true,
+      },
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/remove-me"]).toBeUndefined();
+    expect(processed.paths?.["/example"]).toBeDefined();
+    expect(processed.paths?.["/another"]).toBeDefined();
+  });
+
+  it("removes specific methods in the paths option", () => {
+    const processed = removePaths({
+      paths: {
+        "/example": ["get"],
+      },
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/example"]?.get).toBeUndefined();
+    expect(processed.paths?.["/example"]?.post).toBeDefined();
+    expect(processed.paths?.["/remove-me"]).toBeDefined();
+  });
+
+  it("removes paths and methods using paths and shouldRemove together", () => {
+    const processed = removePaths({
+      paths: {
+        "/example": ["post"],
+      },
+      shouldRemove: ({ path }) => path.startsWith("/remove"),
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/remove-me"]).toBeUndefined();
+    expect(processed.paths?.["/example"]?.get).toBeDefined();
+    expect(processed.paths?.["/example"]?.post).toBeUndefined();
+    expect(processed.paths?.["/another"]).toBeDefined();
+  });
+
+  it("removes paths based on shouldRemove callback", () => {
+    const processed = removePaths({
+      shouldRemove: ({ path }) => path.startsWith("/remove"),
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/remove-me"]).toBeUndefined();
+    expect(processed.paths?.["/example"]).toBeDefined();
+    expect(processed.paths?.["/another"]).toBeDefined();
+  });
+
+  it("removes methods based on shouldRemove callback", () => {
+    const processed = removePaths({
+      shouldRemove: ({ method }) => method === "post",
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/example"]?.post).toBeUndefined();
+    expect(processed.paths?.["/example"]?.get).toBeDefined();
+    expect(processed.paths?.["/remove-me"]).toBeDefined();
+  });
+
+  it("removes both paths and methods based on shouldRemove callback", () => {
+    const processed = removePaths({
+      shouldRemove: ({ path, method }) =>
+        path.startsWith("/remove") || method === "post",
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/remove-me"]).toBeUndefined();
+    expect(processed.paths?.["/example"]?.post).toBeUndefined();
+    expect(processed.paths?.["/example"]?.get).toBeDefined();
+    expect(processed.paths?.["/another"]).toBeDefined();
+  });
+
+  it("does nothing if shouldRemove always returns false", () => {
+    const processed = removePaths({
+      shouldRemove: () => false,
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed).toEqual(baseDoc);
+  });
+
+  it("removes everything if shouldRemove always returns true", () => {
+    const processed = removePaths({
+      shouldRemove: () => true,
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths).toEqual({});
+  });
+
+  it("removes entire paths via shouldRemove callback", () => {
+    const processed = removePaths({
+      shouldRemove: ({ path, method }) =>
+        method === true && path === "/remove-me",
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/remove-me"]).toBeUndefined();
+    expect(processed.paths?.["/example"]).toBeDefined();
+    expect(processed.paths?.["/another"]).toBeDefined();
+  });
+
+  it("removes specific methods while keeping paths", () => {
+    const processed = removePaths({
+      shouldRemove: ({ method }) => method === "delete",
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
+
+    expect(processed.paths?.["/remove-me"]).toBeDefined();
+    expect(processed.paths?.["/remove-me"]?.delete).toBeUndefined();
+  });
+});

package/src/lib/plugins/openapi/{post-processors → processors}/removePaths.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 RemovePathsOptions {
@@ -12,8 +14,8 @@ interface RemovePathsOptions {
 
 export const removePaths =
   ({ paths = {}, shouldRemove }: RemovePathsOptions) =>
-  (doc: RecordAny): RecordAny =>
-    traverse(doc, (spec) => {
+  ({ schema }: ProcessorArg) =>
+    traverse(schema, (spec) => {
       if (!spec.paths) return spec;
 
       const updatedPaths: RecordAny = {};
@@ -52,4 +54,4 @@ export const removePaths =
       }
 
       return { ...spec, paths: updatedPaths };
-    });
+    }) as OpenAPIDocument;

package/src/lib/plugins/openapi/schema/LogicalGroup/LogicalGroup.tsx

@@ -15,14 +15,12 @@ export const LogicalGroup = ({
   schemas,
   type,
   isOpen,
-  level,
   toggleOpen,
 }: {
   schemas: SchemaObject[];
   type: LogicalGroupType;
   isOpen: boolean;
   toggleOpen: () => void;
-  level: number;
 }) => (
   <Collapsible.Root open={isOpen} onOpenChange={toggleOpen} asChild>
     <Card className="px-6">
@@ -34,12 +32,7 @@ export const LogicalGroup = ({
       <Collapsible.Content className="pb-4">
         {schemas.map((subSchema, index) => (
           // eslint-disable-next-line react/no-array-index-key
-          <LogicalGroupItem
-            key={index}
-            type={type}
-            schema={subSchema}
-            level={level}
-          />
+          <LogicalGroupItem key={index} type={type} schema={subSchema} />
         ))}
       </Collapsible.Content>
     </Card>

package/src/lib/plugins/openapi/schema/LogicalGroup/LogicalGroupConnector.tsx

@@ -24,10 +24,12 @@ export const LogicalGroupConnector = ({
   type,
   isOpen,
   className,
+  schemeName,
 }: {
   type: LogicalGroupType;
   isOpen: boolean;
   className?: string;
+  schemeName?: string;
 }) => {
   return (
     <div
@@ -48,6 +50,7 @@ export const LogicalGroupConnector = ({
         >
           <ChevronDownIcon size={16} />
         </div>
+        <span className="text-sm text-foreground">{schemeName}</span>
       </div>
     </div>
   );