zudoku 0.40.0 → 0.40.1

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

@@ -1,4 +1,5 @@
 import { describe, expect, it } from "vitest";
+import type { OpenAPIDocument } from "../../../oas/parser/index.js";
 import { removePaths } from "./removePaths.js";
 
 const baseDoc = {
@@ -15,7 +16,7 @@ const baseDoc = {
       get: { summary: "Another example" },
     },
   },
-};
+} as unknown as OpenAPIDocument;
 
 describe("removePaths", () => {
   it("removes paths specified in the paths option", () => {
@@ -23,11 +24,15 @@ describe("removePaths", () => {
       paths: {
         "/remove-me": true,
       },
-    })(baseDoc);
-
-    expect(processed.paths["/remove-me"]).toBeUndefined();
-    expect(processed.paths["/example"]).toBeDefined();
-    expect(processed.paths["/another"]).toBeDefined();
+    })({
+      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", () => {
@@ -35,11 +40,15 @@ describe("removePaths", () => {
       paths: {
         "/example": ["get"],
       },
-    })(baseDoc);
-
-    expect(processed.paths["/example"].get).toBeUndefined();
-    expect(processed.paths["/example"].post).toBeDefined();
-    expect(processed.paths["/remove-me"]).toBeDefined();
+    })({
+      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", () => {
@@ -48,50 +57,70 @@ describe("removePaths", () => {
         "/example": ["post"],
       },
       shouldRemove: ({ path }) => path.startsWith("/remove"),
-    })(baseDoc);
-
-    expect(processed.paths["/remove-me"]).toBeUndefined();
-    expect(processed.paths["/example"].get).toBeDefined();
-    expect(processed.paths["/example"].post).toBeUndefined();
-    expect(processed.paths["/another"]).toBeDefined();
+    })({
+      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"),
-    })(baseDoc);
-
-    expect(processed.paths["/remove-me"]).toBeUndefined();
-    expect(processed.paths["/example"]).toBeDefined();
-    expect(processed.paths["/another"]).toBeDefined();
+    })({
+      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",
-    })(baseDoc);
-
-    expect(processed.paths["/example"].post).toBeUndefined();
-    expect(processed.paths["/example"].get).toBeDefined();
-    expect(processed.paths["/remove-me"]).toBeDefined();
+    })({
+      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",
-    })(baseDoc);
-
-    expect(processed.paths["/remove-me"]).toBeUndefined();
-    expect(processed.paths["/example"].post).toBeUndefined();
-    expect(processed.paths["/example"].get).toBeDefined();
-    expect(processed.paths["/another"]).toBeDefined();
+    })({
+      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,
-    })(baseDoc);
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
 
     expect(processed).toEqual(baseDoc);
   });
@@ -99,7 +128,11 @@ describe("removePaths", () => {
   it("removes everything if shouldRemove always returns true", () => {
     const processed = removePaths({
       shouldRemove: () => true,
-    })(baseDoc);
+    })({
+      schema: baseDoc,
+      file: "/file.json",
+      dereference: async (id) => id,
+    });
 
     expect(processed.paths).toEqual({});
   });
@@ -108,19 +141,27 @@ describe("removePaths", () => {
     const processed = removePaths({
       shouldRemove: ({ path, method }) =>
         method === true && path === "/remove-me",
-    })(baseDoc);
-
-    expect(processed.paths["/remove-me"]).toBeUndefined();
-    expect(processed.paths["/example"]).toBeDefined();
-    expect(processed.paths["/another"]).toBeDefined();
+    })({
+      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",
-    })(baseDoc);
-
-    expect(processed.paths["/remove-me"]).toBeDefined();
-    expect(processed.paths["/remove-me"].delete).toBeUndefined();
+    })({
+      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/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;