Fix/160 (#162)

* fix: corrected the hide implmentation

* chore: added tests for hide function

Author: MathurAditya724

src/__tests__/__snapshots__/basic.test.ts.snap

@@ -0,0 +1,37 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`basic > hide with a boolean value 1`] = `
+{
+  "components": {},
+  "info": {
+    "description": "Development documentation",
+    "title": "Hono Documentation",
+    "version": "0.0.0",
+  },
+  "openapi": "3.1.0",
+  "paths": {
+    "/": {
+      "get": undefined,
+    },
+  },
+  "tags": undefined,
+}
+`;
+
+exports[`basic > hide with a function 1`] = `
+{
+  "components": {},
+  "info": {
+    "description": "Development documentation",
+    "title": "Hono Documentation",
+    "version": "0.0.0",
+  },
+  "openapi": "3.1.0",
+  "paths": {
+    "/": {
+      "get": undefined,
+    },
+  },
+  "tags": undefined,
+}
+`;

src/__tests__/basic.test.ts

@@ -2,12 +2,11 @@ import { Hono } from "hono";
 import { describe, expect, it, vi } from "vitest";
 import z from "zod";
 import { generateSpecs } from "../handler.js";
-import { validator } from "../middlewares.js";
+import { describeRoute, resolver, validator } from "../middlewares.js";
 import "zod-openapi/extend";
 
 describe("basic", () => {
   it("operationId", async () => {
-
     const operationId = vi.fn(() => "hello");
 
     const app = new Hono().get(
@@ -21,12 +20,74 @@ describe("basic", () => {
     const specs = await generateSpecs(app, {
       defaultOptions: {
         GET: {
-          operationId
-        }
-      }
+          operationId,
+        },
+      },
     });
 
     expect(operationId).toBeCalled();
-    expect(operationId).toBeCalledTimes(1)
+    expect(operationId).toBeCalledTimes(1);
+  });
+
+  it("hide with a boolean value", async () => {
+    const app = new Hono().get(
+      "/",
+      describeRoute({
+        hide: true,
+        description: "This is a test route",
+        responses: {
+          200: {
+            description: "Success",
+            content: {
+              "application/json": {
+                schema: resolver(
+                  z.object({
+                    message: z.string(),
+                  }),
+                ),
+              },
+            },
+          },
+        },
+      }),
+      async (c) => {
+        return c.json({ message: "Hello, world!" });
+      },
+    );
+
+    const specs = await generateSpecs(app);
+
+    expect(specs).toMatchSnapshot();
+  });
+
+  it("hide with a function", async () => {
+    const app = new Hono().get(
+      "/",
+      describeRoute({
+        hide: () => true,
+        description: "This is a test route",
+        responses: {
+          200: {
+            description: "Success",
+            content: {
+              "application/json": {
+                schema: resolver(
+                  z.object({
+                    message: z.string(),
+                  }),
+                ),
+              },
+            },
+          },
+        },
+      }),
+      async (c) => {
+        return c.json({ message: "Hello, world!" });
+      },
+    );
+
+    const specs = await generateSpecs(app);
+
+    expect(specs).toMatchSnapshot();
   });
 });

src/handler.ts

@@ -343,7 +343,7 @@ function mergeComponentsObjects(
 ) {
   return components.reduce<OpenAPIV3_1.ComponentsObject>(
     (prev, component, index) => {
-      if (!component || index === 0) return prev;
+      if (component == null || index === 0) return prev;
 
       if (
         (prev.schemas && Object.keys(prev.schemas).length > 0) ||

src/utils.ts

@@ -221,6 +221,8 @@ export function removeExcludedPaths(
       for (const method of Object.keys(value)) {
         const schema = value[method];
 
+        if (schema == null) continue;
+
         if (key.includes("{")) {
           if (!schema.parameters) schema.parameters = [];