npm - hasancode-api-docs - Versions diffs - 1.0.13 → 1.0.15 - Mend

hasancode-api-docs 1.0.13 → 1.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/middleware/ApiDoc.js +29 -27
package/package.json +1 -1
package/dist/middleware/RouteDoc.js +0 -47

package/dist/middleware/ApiDoc.js CHANGED Viewed

@@ -250,7 +250,9 @@ class ApiDoc {
             // Calculate the absolute base path for the documentation
             // This makes the app portable even when mounted at a prefix
             const mountPath = req.baseUrl || "";
-            const docsPath = this.DOCS_PATH.startsWith("/") ? this.DOCS_PATH : `/${this.DOCS_PATH}`;
+            const docsPath = this.DOCS_PATH.startsWith("/")
+                ? this.DOCS_PATH
+                : `/${this.DOCS_PATH}`;
             const fullPath = (mountPath + docsPath).replace(/\/+$/, "");
             const baseTag = `<base href="${fullPath}/">`;
             // Insert or replace base tag
@@ -268,32 +270,32 @@ class ApiDoc {
         }
         else {
             res.status(404).send(`
-        <html>
-          <head>
-            <title>API Docs - Not Built</title>
-            <style>
-              body {
-                font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
-                max-width: 600px;
-                margin: 100px auto;
-                padding: 20px;
-                text-align: center;
-              }
-              h1 { color: #e53e3e; }
-              code {
-                background: #f7fafc;
-                padding: 2px 6px;
-                border-radius: 4px;
-              }
-            </style>
-          </head>
-          <body>
-            <h1>⚠️ Client Not Built</h1>
-            <p>Please run <code>npm run build</code> first.</p>
-            <p><small>Looking at: ${this.clientPath}</small></p>
-          </body>
-        </html>
-      `);
+            <html>
+                <head>
+                    <title>API Docs - Not Built</title>
+                    <style>
+                    body {
+                        font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+                        max-width: 600px;
+                        margin: 100px auto;
+                        padding: 20px;
+                        text-align: center;
+                    }
+                    h1 { color: #e53e3e; }
+                    code {
+                        background: #f7fafc;
+                        padding: 2px 6px;
+                        border-radius: 4px;
+                    }
+                    </style>
+                </head>
+                <body>
+                    <h1>⚠️ Client Not Built</h1>
+                    <p>Please run <code>npm run build</code> first.</p>
+                    <p><small>Looking at: ${this.clientPath}</small></p>
+                </body>
+            </html>
+            `);
         }
     }
     /**

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "hasancode-api-docs",
-    "version": "1.0.13",
+    "version": "1.0.15",
     "description": "A simple and easy to use API documentation generator for Express.js",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/dist/middleware/RouteDoc.js DELETED Viewed

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.doc = doc;
-const RouteRegistry_1 = require("../registry/RouteRegistry");
-/**
- * doc() — Express route middleware that registers API documentation.
- *
- * Two signatures:
- *
- * ① As a standalone middleware — method & path come from Express router:
- *
- *   router.post('/users', doc({ summary: 'Create user', ... }), handler);
- *
- * ② Wrapping the handler directly (handler runs after doc is registered):
- *
- *   router.post('/signin/:userType',
- *     validateRequest(schema),
- *     doc({ summary: 'Sign in', tags: ['Auth'], ... }, AuthControllers.signin),
- *   );
- */
-function doc(options, handler) {
-    let registered = false; // register once per route, not on every request
-    const middleware = (req, res, next) => {
-        var _a, _b, _c, _d;
-        if (!registered) {
-            registered = true;
-            // Express populates req.route only once the route is matched
-            // (i.e. on the first real request). We use that to get method & path.
-            const method = ((_b = (_a = req.method) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== null && _b !== void 0 ? _b : "get");
-            // req.route.path gives us the pattern (/users/:id),
-            // NOT the actual URL — exactly what we want for docs.
-            const path = (_d = (_c = req.route) === null || _c === void 0 ? void 0 : _c.path) !== null && _d !== void 0 ? _d : req.path;
-            const routeDoc = Object.assign({ method,
-                path }, options);
-            console.log(routeDoc);
-            RouteRegistry_1.routeRegistry.register(routeDoc);
-        }
-        // If the user passed a handler as second arg, call it directly
-        if (handler) {
-            return handler(req, res, next);
-        }
-        next();
-    };
-    // Mark this middleware so ApiDoc can identify it if needed
-    middleware.__isDocMiddleware = true;
-    return middleware;
-}