speedly 1.2.40 → 1.2.43

package/dist/cjs/db/db.js

@@ -523,7 +523,8 @@ const usingMongoDb = (collectionName, config = { type: "external" }) => {
             return next({
                 status: 500,
                 json: {
-                    message: "Internal Server Error",
+                    message: (err instanceof Error ? err.message : String(err)) ||
+                        "internal server error",
                 },
             });
         }

package/dist/cjs/document/document.d.ts

@@ -0,0 +1,2 @@
+import { Express } from "express";
+export default function swaggerLoader(app: Express, baseDir?: string): void;

package/dist/cjs/document/document.js

@@ -0,0 +1,185 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = swaggerLoader;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const swagger_ui_express_1 = __importDefault(require("swagger-ui-express"));
+const swagger_themes_1 = require("swagger-themes");
+const METHODS_WITH_BODY = ["post", "put", "patch"];
+/* ===================== HELPERS ======================= */
+function extractPath(layer) {
+    if (layer.regexp && layer.regexp.source !== "^\\/?$") {
+        return layer.regexp.source
+            .replace("^\\/", "/")
+            .replace("\\/?(?=\\/|$)", "")
+            .replace(/\\\//g, "/");
+    }
+    return "";
+}
+function splitRouteByMethod(route) {
+    const result = {};
+    route.stack.forEach((layer, idx) => {
+        if (layer.method) {
+            const method = layer.method.toLowerCase();
+            const middlewares = [];
+            for (let i = 0; i < idx; i++) {
+                if (route.stack[i].name !== "bound dispatch")
+                    middlewares.push(route.stack[i]);
+            }
+            result[method] = { middlewares, handler: layer };
+        }
+    });
+    return result;
+}
+/* ================== YUP → OPENAPI ==================== */
+function resolveYupSchema(schema) {
+    if (!schema)
+        return null;
+    if (schema?.type === "lazy" && typeof schema._resolve === "function") {
+        return schema._resolve({});
+    }
+    return schema;
+}
+function translateField(field) {
+    if (!field)
+        return { type: "string" };
+    return {
+        type: field.type === "array" ? "array" : field.type || "string",
+        nullable: field.nullable || false,
+    };
+}
+function translateYupSchema(schema) {
+    schema = resolveYupSchema(schema);
+    if (!schema)
+        return null;
+    const described = schema.describe();
+    const properties = Object.entries(described.fields ?? {}).reduce((acc, [name, field]) => {
+        acc[name] = translateField(field);
+        return acc;
+    }, {});
+    return {
+        type: "object",
+        properties,
+        required: Object.entries(described.fields ?? {})
+            .filter(([_, f]) => !(f.optional || f.nullable))
+            .map(([name]) => name),
+    };
+}
+function getAuthStatus(middlewares) {
+    for (const mw of middlewares) {
+        if (!mw.name)
+            continue;
+        if (mw.name.startsWith("auth")) {
+            const parts = mw.name.split(":");
+            if (parts[1] === "any")
+                return { type: "any", raw: mw.name };
+            return { type: "required", raw: mw.name };
+        }
+    }
+    return { type: "none", raw: null };
+}
+/* ==================== ROUTER SCANNER ==================== */
+function scanRouter(router, base = "") {
+    const routes = [];
+    router.stack.forEach((layer) => {
+        if (layer.route) {
+            routes.push({
+                path: base + layer.route.path,
+                methods: splitRouteByMethod(layer.route),
+            });
+        }
+        else if (layer.name === "router" && layer.handle?.stack) {
+            routes.push(...scanRouter(layer.handle, base + extractPath(layer)));
+        }
+    });
+    return routes;
+}
+/* ================== MAIN ANALYZER ===================== */
+function routeAnalyzer(route, routerName) {
+    const routerDetails = {};
+    const scanned = scanRouter(route);
+    const paramsRegex = /:[^/]+/g;
+    scanned.forEach((route) => {
+        const fullPath = `/${routerName}${route.path
+            .replace(/^\/$/, "")
+            .replaceAll(paramsRegex, (r) => `{${r.slice(1)}}`)}`;
+        routerDetails[fullPath] = {};
+        Object.entries(route.methods).forEach(([method, detail]) => {
+            const doc = {
+                tags: [routerName.replace("_", " ")],
+                description: "Public route",
+            };
+            const validation = detail.middlewares.find((mw) => mw.handle?.__validationSchema)?.handle.__validationSchema;
+            // If body exists
+            if (METHODS_WITH_BODY.includes(method)) {
+                if (validation?.body) {
+                    doc.requestBody = {
+                        required: true,
+                        content: {
+                            "application/json": {
+                                schema: translateYupSchema(validation.body),
+                            },
+                        },
+                    };
+                }
+            }
+            // Auth
+            const auth = getAuthStatus(detail.middlewares);
+            if (auth.type === "required") {
+                doc.security = [{ bearerAuth: [] }];
+                doc.description = `Requires authentication (${auth.raw})`;
+            }
+            else if (auth.type === "any") {
+                doc.description = "Optional login route";
+            }
+            routerDetails[fullPath][method] = doc;
+        });
+    });
+    return routerDetails;
+}
+/* =================== LOAD MODULES ==================== */
+function RouterFetcher(baseDir) {
+    const modules = fs_1.default.readdirSync(baseDir);
+    let paths = {};
+    const tags = [];
+    modules.forEach((mf) => {
+        const routerPath = path_1.default.join(baseDir, mf, `${mf}.routes.js`);
+        try {
+            const router = require(routerPath);
+            paths = { ...paths, ...routeAnalyzer(router, mf) };
+            tags.push({
+                name: mf.replace("_", " "),
+                description: `${mf} operations`,
+            });
+        }
+        catch (err) {
+            console.error("Swagger loading error:", err.message);
+        }
+    });
+    return {
+        openapi: "3.0.3",
+        info: {
+            title: `${require(path_1.default.join(process.cwd(), "package.json")).name} APIs`,
+            version: "1.0.0",
+        },
+        servers: [{ url: "/api/v1" }],
+        paths,
+        tags,
+        components: {
+            securitySchemes: {
+                bearerAuth: { type: "http", scheme: "bearer", bearerFormat: "JWT" },
+            },
+        },
+    };
+}
+/* ==================== EXPORT HOOK ==================== */
+function swaggerLoader(app, baseDir = path_1.default.join(process.cwd(), "src/module")) {
+    const doc = RouterFetcher(baseDir);
+    const theme = new swagger_themes_1.SwaggerTheme();
+    app.use("/docs", swagger_ui_express_1.default.serve, swagger_ui_express_1.default.setup(doc, {
+        customCss: theme.getBuffer(swagger_themes_1.SwaggerThemeNameEnum.DARK),
+    }));
+}

package/dist/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import auth from './auth/auth';
-import db from './db/db';
-import uploader from './uploader/uploader';
-import validator from './validator/validator';
+import auth from "./auth/auth";
+import db from "./db/db";
+import uploader from "./uploader/uploader";
+import validator from "./validator/validator";
+import document from "./document/document";
 declare const utils: {
     translator: (text?: string, lang?: string) => Promise<unknown>;
 };
@@ -67,4 +68,4 @@ declare const models: {
 declare const modules: {
     translation: import("express-serve-static-core").Router;
 };
-export { auth, db, uploader, validator, models, modules, utils };
+export { auth, db, uploader, validator, models, modules, utils, document };

package/dist/cjs/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.utils = exports.modules = exports.models = exports.validator = exports.uploader = exports.db = exports.auth = void 0;
+exports.document = exports.utils = exports.modules = exports.models = exports.validator = exports.uploader = exports.db = exports.auth = void 0;
 const auth_1 = __importDefault(require("./auth/auth"));
 exports.auth = auth_1.default;
 const db_1 = __importDefault(require("./db/db"));
@@ -14,9 +14,11 @@ const validator_1 = __importDefault(require("./validator/validator"));
 exports.validator = validator_1.default;
 const translation_1 = __importDefault(require("./model/translation"));
 const translation_routes_1 = __importDefault(require("./modules/translation/translation.routes"));
+const document_1 = __importDefault(require("./document/document"));
+exports.document = document_1.default;
 const translator_1 = __importDefault(require("./util/translator"));
 const utils = {
-    translator: translator_1.default
+    translator: translator_1.default,
 };
 exports.utils = utils;
 const models = { translation: translation_1.default };

package/dist/esm/db/db.js

@@ -523,7 +523,8 @@ const usingMongoDb = (collectionName, config = { type: "external" }) => {
             return next({
                 status: 500,
                 json: {
-                    message: "Internal Server Error",
+                    message: (err instanceof Error ? err.message : String(err)) ||
+                        "internal server error",
                 },
             });
         }

package/dist/esm/document/document.d.ts

@@ -0,0 +1,2 @@
+import { Express } from "express";
+export default function swaggerLoader(app: Express, baseDir?: string): void;

package/dist/esm/document/document.js

@@ -0,0 +1,185 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = swaggerLoader;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const swagger_ui_express_1 = __importDefault(require("swagger-ui-express"));
+const swagger_themes_1 = require("swagger-themes");
+const METHODS_WITH_BODY = ["post", "put", "patch"];
+/* ===================== HELPERS ======================= */
+function extractPath(layer) {
+    if (layer.regexp && layer.regexp.source !== "^\\/?$") {
+        return layer.regexp.source
+            .replace("^\\/", "/")
+            .replace("\\/?(?=\\/|$)", "")
+            .replace(/\\\//g, "/");
+    }
+    return "";
+}
+function splitRouteByMethod(route) {
+    const result = {};
+    route.stack.forEach((layer, idx) => {
+        if (layer.method) {
+            const method = layer.method.toLowerCase();
+            const middlewares = [];
+            for (let i = 0; i < idx; i++) {
+                if (route.stack[i].name !== "bound dispatch")
+                    middlewares.push(route.stack[i]);
+            }
+            result[method] = { middlewares, handler: layer };
+        }
+    });
+    return result;
+}
+/* ================== YUP → OPENAPI ==================== */
+function resolveYupSchema(schema) {
+    if (!schema)
+        return null;
+    if (schema?.type === "lazy" && typeof schema._resolve === "function") {
+        return schema._resolve({});
+    }
+    return schema;
+}
+function translateField(field) {
+    if (!field)
+        return { type: "string" };
+    return {
+        type: field.type === "array" ? "array" : field.type || "string",
+        nullable: field.nullable || false,
+    };
+}
+function translateYupSchema(schema) {
+    schema = resolveYupSchema(schema);
+    if (!schema)
+        return null;
+    const described = schema.describe();
+    const properties = Object.entries(described.fields ?? {}).reduce((acc, [name, field]) => {
+        acc[name] = translateField(field);
+        return acc;
+    }, {});
+    return {
+        type: "object",
+        properties,
+        required: Object.entries(described.fields ?? {})
+            .filter(([_, f]) => !(f.optional || f.nullable))
+            .map(([name]) => name),
+    };
+}
+function getAuthStatus(middlewares) {
+    for (const mw of middlewares) {
+        if (!mw.name)
+            continue;
+        if (mw.name.startsWith("auth")) {
+            const parts = mw.name.split(":");
+            if (parts[1] === "any")
+                return { type: "any", raw: mw.name };
+            return { type: "required", raw: mw.name };
+        }
+    }
+    return { type: "none", raw: null };
+}
+/* ==================== ROUTER SCANNER ==================== */
+function scanRouter(router, base = "") {
+    const routes = [];
+    router.stack.forEach((layer) => {
+        if (layer.route) {
+            routes.push({
+                path: base + layer.route.path,
+                methods: splitRouteByMethod(layer.route),
+            });
+        }
+        else if (layer.name === "router" && layer.handle?.stack) {
+            routes.push(...scanRouter(layer.handle, base + extractPath(layer)));
+        }
+    });
+    return routes;
+}
+/* ================== MAIN ANALYZER ===================== */
+function routeAnalyzer(route, routerName) {
+    const routerDetails = {};
+    const scanned = scanRouter(route);
+    const paramsRegex = /:[^/]+/g;
+    scanned.forEach((route) => {
+        const fullPath = `/${routerName}${route.path
+            .replace(/^\/$/, "")
+            .replaceAll(paramsRegex, (r) => `{${r.slice(1)}}`)}`;
+        routerDetails[fullPath] = {};
+        Object.entries(route.methods).forEach(([method, detail]) => {
+            const doc = {
+                tags: [routerName.replace("_", " ")],
+                description: "Public route",
+            };
+            const validation = detail.middlewares.find((mw) => mw.handle?.__validationSchema)?.handle.__validationSchema;
+            // If body exists
+            if (METHODS_WITH_BODY.includes(method)) {
+                if (validation?.body) {
+                    doc.requestBody = {
+                        required: true,
+                        content: {
+                            "application/json": {
+                                schema: translateYupSchema(validation.body),
+                            },
+                        },
+                    };
+                }
+            }
+            // Auth
+            const auth = getAuthStatus(detail.middlewares);
+            if (auth.type === "required") {
+                doc.security = [{ bearerAuth: [] }];
+                doc.description = `Requires authentication (${auth.raw})`;
+            }
+            else if (auth.type === "any") {
+                doc.description = "Optional login route";
+            }
+            routerDetails[fullPath][method] = doc;
+        });
+    });
+    return routerDetails;
+}
+/* =================== LOAD MODULES ==================== */
+function RouterFetcher(baseDir) {
+    const modules = fs_1.default.readdirSync(baseDir);
+    let paths = {};
+    const tags = [];
+    modules.forEach((mf) => {
+        const routerPath = path_1.default.join(baseDir, mf, `${mf}.routes.js`);
+        try {
+            const router = require(routerPath);
+            paths = { ...paths, ...routeAnalyzer(router, mf) };
+            tags.push({
+                name: mf.replace("_", " "),
+                description: `${mf} operations`,
+            });
+        }
+        catch (err) {
+            console.error("Swagger loading error:", err.message);
+        }
+    });
+    return {
+        openapi: "3.0.3",
+        info: {
+            title: `${require(path_1.default.join(process.cwd(), "package.json")).name} APIs`,
+            version: "1.0.0",
+        },
+        servers: [{ url: "/api/v1" }],
+        paths,
+        tags,
+        components: {
+            securitySchemes: {
+                bearerAuth: { type: "http", scheme: "bearer", bearerFormat: "JWT" },
+            },
+        },
+    };
+}
+/* ==================== EXPORT HOOK ==================== */
+function swaggerLoader(app, baseDir = path_1.default.join(process.cwd(), "src/module")) {
+    const doc = RouterFetcher(baseDir);
+    const theme = new swagger_themes_1.SwaggerTheme();
+    app.use("/docs", swagger_ui_express_1.default.serve, swagger_ui_express_1.default.setup(doc, {
+        customCss: theme.getBuffer(swagger_themes_1.SwaggerThemeNameEnum.DARK),
+    }));
+}

package/dist/esm/index.d.ts

@@ -1,7 +1,8 @@
-import auth from './auth/auth';
-import db from './db/db';
-import uploader from './uploader/uploader';
-import validator from './validator/validator';
+import auth from "./auth/auth";
+import db from "./db/db";
+import uploader from "./uploader/uploader";
+import validator from "./validator/validator";
+import document from "./document/document";
 declare const utils: {
     translator: (text?: string, lang?: string) => Promise<unknown>;
 };
@@ -67,4 +68,4 @@ declare const models: {
 declare const modules: {
     translation: import("express-serve-static-core").Router;
 };
-export { auth, db, uploader, validator, models, modules, utils };
+export { auth, db, uploader, validator, models, modules, utils, document };

package/dist/esm/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.utils = exports.modules = exports.models = exports.validator = exports.uploader = exports.db = exports.auth = void 0;
+exports.document = exports.utils = exports.modules = exports.models = exports.validator = exports.uploader = exports.db = exports.auth = void 0;
 const auth_1 = __importDefault(require("./auth/auth"));
 exports.auth = auth_1.default;
 const db_1 = __importDefault(require("./db/db"));
@@ -14,9 +14,11 @@ const validator_1 = __importDefault(require("./validator/validator"));
 exports.validator = validator_1.default;
 const translation_1 = __importDefault(require("./model/translation"));
 const translation_routes_1 = __importDefault(require("./modules/translation/translation.routes"));
+const document_1 = __importDefault(require("./document/document"));
+exports.document = document_1.default;
 const translator_1 = __importDefault(require("./util/translator"));
 const utils = {
-    translator: translator_1.default
+    translator: translator_1.default,
 };
 exports.utils = utils;
 const models = { translation: translation_1.default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "speedly",
-  "version": "1.2.40",
+  "version": "1.2.43",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -14,7 +14,7 @@
     "build": "npm run build:cjs && npm run build:esm",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:esm": "tsc -p tsconfig.esm.json",
-    "publish": "npm run build && git add . && git commit -m 'publish' && npm version patch && npm publish ",
+    "pub": "npm run build && git add . && git commit -m 'publish' && npm version patch && npm publish ",
     "dev": "ts-node src/index.ts"
   },
   "author": "MAHSERIN",
@@ -24,6 +24,7 @@
     "@types/express": "^5.0.3",
     "@types/multer": "^2.0.0",
     "@types/node": "^24.5.2",
+    "@types/swagger-ui-express": "^4.1.8",
     "ts-node": "^10.9.2",
     "tsc": "^2.0.4",
     "typescript": "^5.9.3"
@@ -35,6 +36,8 @@
     "jsonwebtoken": "^9.0.2",
     "mongoose": "^8.18.2",
     "multer": "^2.0.2",
+    "swagger-themes": "^1.4.3",
+    "swagger-ui-express": "^5.0.1",
     "translate": "^3.0.1",
     "yup": "^1.7.1"
   }