tspace-spear 1.2.2 → 1.2.4

package/dist/lib/core/server/parser-factory.js

@@ -4,16 +4,42 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ParserFactory = void 0;
+const busboy_1 = __importDefault(require("busboy"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const mime_types_1 = __importDefault(require("mime-types"));
 const crypto_1 = __importDefault(require("crypto"));
 const swagger_ui_dist_1 = __importDefault(require("swagger-ui-dist"));
-const querystring_1 = __importDefault(require("querystring"));
 const string_decoder_1 = require("string_decoder");
-const busboy_1 = __importDefault(require("busboy"));
+const fast_querystring_1 = __importDefault(require("fast-querystring"));
+const utils_1 = require("../utils");
+const uWS_1 = require("./uWS");
+const net_1 = require("./net");
 class ParserFactory {
-    files(req, options) {
+    uWebStockets = false;
+    net = false;
+    useAdater(adapter) {
+        if (adapter.kind === 'uWS') {
+            this.uWebStockets = true;
+        }
+        if (adapter.kind === 'net') {
+            this.net = true;
+        }
+        return this;
+    }
+    queryString(url) {
+        const i = url.indexOf("?");
+        if (i === -1)
+            return {};
+        return fast_querystring_1.default.parse(url.slice(i + 1));
+    }
+    async files({ req, res, options, }) {
+        if (this.uWebStockets) {
+            return (0, uWS_1.uWSfiles)({ req, res, options });
+        }
+        if (this.net) {
+            return (0, net_1.netFiles)(req, options);
+        }
         const temp = options.tempFileDir;
         if (!fs_1.default.existsSync(temp)) {
             try {
@@ -25,7 +51,7 @@ class ParserFactory {
             const body = {};
             const files = {};
             const fileWritePromises = [];
-            const bb = (0, busboy_1.default)({ headers: req.headers, defParamCharset: 'utf8' });
+            const bb = (0, busboy_1.default)({ headers: req.headers, defParamCharset: "utf8" });
             const removeTemp = (fileTemp, ms) => {
                 const remove = () => {
                     try {
@@ -35,13 +61,16 @@ class ParserFactory {
                 };
                 setTimeout(remove, ms);
             };
-            bb.on('file', (fieldName, fileData, info) => {
+            bb.on("file", (fieldName, fileData, info) => {
                 const { filename, mimeType } = info;
-                const tempFilename = crypto_1.default.randomBytes(16).toString('hex');
+                const extension = mime_types_1.default.extension(mimeType) ||
+                    path_1.default.extname(filename).replace(".", "") ||
+                    "bin";
+                const tempFilename = crypto_1.default.randomBytes(16).toString("hex");
                 const filePath = path_1.default.join(path_1.default.resolve(), `${temp}/${tempFilename}`);
                 const writeStream = fs_1.default.createWriteStream(filePath);
                 let fileSize = 0;
-                fileData.on('data', (data) => {
+                fileData.on("data", (data) => {
                     fileSize += data.length;
                     if (fileSize > options.limit) {
                         fileData.unpipe(writeStream);
@@ -51,38 +80,39 @@ class ParserFactory {
                 });
                 const fileWritePromise = new Promise((resolve, reject) => {
                     fileData.pipe(writeStream);
-                    writeStream.on('finish', () => {
+                    writeStream.on("finish", () => {
                         const file = {
                             name: filename,
                             tempFilePath: filePath,
                             tempFileName: tempFilename,
                             mimetype: mimeType,
-                            extension: String(mime_types_1.default.extension(String(mimeType))),
+                            extension: extension,
                             size: fileSize,
                             sizes: {
                                 bytes: fileSize,
                                 kb: fileSize / 1024,
                                 mb: fileSize / 1024 / 1024,
-                                gb: fileSize / 1024 / 1024 / 1024
+                                gb: fileSize / 1024 / 1024 / 1024,
                             },
                             write: (to) => {
                                 return new Promise((resolve, reject) => {
-                                    fs_1.default.createReadStream(filePath)
+                                    fs_1.default
+                                        .createReadStream(filePath)
                                         .pipe(fs_1.default.createWriteStream(to))
-                                        .on('finish', () => {
+                                        .on("finish", () => {
                                         return resolve(null);
                                     })
-                                        .on('error', (err) => {
+                                        .on("error", (err) => {
                                         return reject(err);
                                     });
                                 });
                             },
                             remove: () => {
-                                return new Promise(resolve => setTimeout(() => {
+                                return new Promise((resolve) => setTimeout(() => {
                                     fs_1.default.unlinkSync(filePath);
                                     return resolve(null);
                                 }, 100));
-                            }
+                            },
                         };
                         if (files[fieldName] == null) {
                             files[fieldName] = [];
@@ -93,52 +123,56 @@ class ParserFactory {
                         }
                         return resolve(null);
                     });
-                    writeStream.on('error', reject);
+                    writeStream.on("error", reject);
                 });
                 fileWritePromises.push(fileWritePromise);
             });
-            bb.on('field', (name, value) => {
+            bb.on("field", (name, value) => {
                 body[name] = value;
             });
-            bb.on('finish', () => {
+            bb.on("finish", () => {
                 Promise.all(fileWritePromises)
                     .then(() => {
                     return resolve({
                         files,
-                        body
+                        body,
                     });
                 })
                     .catch((err) => {
                     return reject(err);
                 });
             });
-            bb.on('error', (err) => {
+            bb.on("error", (err) => {
                 return reject(err);
             });
             req.pipe(bb);
         });
     }
-    body(req) {
+    async body(req, res) {
+        if (this.uWebStockets) {
+            return (await (0, uWS_1.uWSBody)(req, res));
+        }
+        if (this.net) {
+            return (await (0, net_1.netBody)(req));
+        }
         return new Promise((resolve, reject) => {
-            const decoder = new string_decoder_1.StringDecoder('utf-8');
-            let payload = '';
-            req.on('data', (data) => {
+            const decoder = new string_decoder_1.StringDecoder("utf-8");
+            let payload = "";
+            req.on("data", (data) => {
                 payload += decoder.write(data);
             });
-            req.on('end', () => {
+            req.on("end", async () => {
+                payload += decoder.end();
+                const contentType = req.headers["content-type"]?.toLowerCase() || null;
                 try {
-                    const isUrlEncoded = req.headers['content-type']?.includes('x-www-form-urlencoded');
-                    if (isUrlEncoded) {
-                        return resolve(querystring_1.default.parse(payload));
-                    }
-                    payload += decoder.end();
-                    return resolve(JSON.parse(payload));
+                    const body = await (0, utils_1.normalizeRequestBody)({ contentType, payload });
+                    return resolve(body);
                 }
-                catch (e) {
-                    return resolve({});
+                catch (err) {
+                    return reject(err);
                 }
             });
-            req.on('error', (err) => {
+            req.on("error", (err) => {
                 return reject(err);
             });
         });
@@ -148,15 +182,15 @@ class ParserFactory {
         const cookieString = req.headers?.cookie;
         if (cookieString == null)
             return null;
-        for (const cookie of cookieString.split(';')) {
-            const [name, value] = cookie.split('=').map((v) => v.trim());
+        for (const cookie of cookieString.split(";")) {
+            const [name, value] = cookie.split("=").map((v) => v.trim());
             cookies[name] = decodeURIComponent(value);
         }
         for (const name of Object.keys(cookies)) {
             const cookie = cookies[name];
-            if (!cookie.startsWith('Expires='))
+            if (!cookie.startsWith("Expires="))
                 continue;
-            const expiresString = cookie.replace('Expires=', '');
+            const expiresString = cookie.replace("Expires=", "");
             const expiresDate = new Date(expiresString);
             if (isNaN(expiresDate.getTime()) || expiresDate < new Date()) {
                 delete cookies[name];
@@ -168,9 +202,9 @@ class ParserFactory {
         const spec = {
             openapi: "3.1.0",
             info: doc.info ?? {
-                title: 'API Documentation',
+                title: "API Documentation",
                 description: "Documentation",
-                version: '1.0.0'
+                version: "1.0.0",
             },
             components: {
                 securitySchemes: {
@@ -178,14 +212,14 @@ class ParserFactory {
                         type: "http",
                         scheme: "bearer",
                         name: "Authorization",
-                        description: "Enter your token in the format : 'Bearer {TOKEN}'"
+                        description: "Enter your token in the format : 'Bearer {TOKEN}'",
                     },
                     cookies: {
                         type: "apiKey",
                         in: "header",
                         name: "Cookie",
-                        description: "Enter your cookies in the headers"
-                    }
+                        description: "Enter your cookies in the headers",
+                    },
                 },
             },
             servers: doc.servers,
@@ -194,14 +228,30 @@ class ParserFactory {
         };
         const specPaths = (routes) => {
             let paths = {};
+            const defaultSpecResponse = {
+                "200": {
+                    description: "OK",
+                    content: {
+                        "application/json": {
+                            schema: {
+                                type: "object",
+                                properties: {
+                                    message: {
+                                        example: "success",
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            };
             for (const r of routes) {
-                if (r.path === '*')
+                if (r.path === "*")
                     continue;
                 const path = r.path.replace(/:(\w+)/g, "{$1}");
-                const method = r.method.toLocaleLowerCase();
-                const swagger = (doc.specs ?? []).find(s => {
-                    return s.path === r.path &&
-                        s.method.toLocaleLowerCase() === method;
+                const method = r.method.toLowerCase();
+                const swagger = (doc.specs ?? []).find((s) => {
+                    return s.path === r.path && s.method.toLowerCase() === method;
                 });
                 const decoratedOnly = doc.options?.decoratedOnly ?? false;
                 if ((swagger == null && decoratedOnly) || swagger?.disabled) {
@@ -209,15 +259,15 @@ class ParserFactory {
                 }
                 if (paths[path] == null) {
                     paths[path] = {
-                        [method]: {}
+                        [method]: {},
                     };
                 }
                 const spec = {};
                 const tags = /\/api\/v\d+/.test(r.path)
-                    ? r.path.split('/')[3]
+                    ? r.path.split("/")[3]
                     : /\/api/.test(r.path)
-                        ? r.path.split('/')[2]
-                        : r.path.split('/')[1];
+                        ? r.path.split("/")[2]
+                        : r.path.split("/")[1];
                 spec.parameters = [];
                 spec.responses = {};
                 spec.tags = [];
@@ -231,152 +281,192 @@ class ParserFactory {
                             content: {
                                 "application/json": {
                                     schema: {
-                                        type: 'object',
+                                        type: "object",
                                         properties: response.example == null
                                             ? {}
-                                            : Object.keys(response.example)
-                                                .reduce((prev, key) => {
-                                                prev[key] = { example: (response?.example ?? {})[key] ?? {} };
+                                            : Object.keys(response.example).reduce((prev, key) => {
+                                                prev[key] = {
+                                                    example: (response?.example ?? {})[key] ?? {},
+                                                };
                                                 return prev;
-                                            }, {})
-                                    }
-                                }
-                            }
+                                            }, {}),
+                                    },
+                                },
+                            },
                         };
                     }
                     spec.responses = {
-                        ...responses
+                        ...responses,
                     };
                 }
-                if (swagger != null) {
+                if (swagger == null) {
                     spec.tags = [
-                        swagger.tags == null
-                            ? tags == null || tags === '' || /^:[^:]*$/.test(tags) ? 'default' : tags
-                            : swagger.tags
+                        tags == null || tags === "" || /^:[^:]*$/.test(tags)
+                            ? "default"
+                            : tags,
                     ];
-                    if (swagger.bearerToken) {
-                        spec.security = [{ "BearerToken": [] }];
-                    }
-                    if (swagger.summary != null) {
-                        spec.summary = swagger.summary;
-                    }
-                    if (swagger.description != null) {
-                        spec.description = swagger.description;
-                    }
                     if (Array.isArray(r.params) && Array.from(r.params).length) {
-                        spec.parameters = Array.from(r?.params).map(p => {
+                        spec.parameters = Array.from(r.params).map((p) => {
                             return {
                                 name: p,
                                 in: "path",
                                 required: true,
                                 schema: {
-                                    type: "string"
-                                }
+                                    type: "string",
+                                },
                             };
                         });
                     }
-                    if (swagger.query != null) {
-                        spec.parameters = [
-                            ...spec.parameters,
-                            ...Object.entries(swagger.query).map(([k, v]) => {
-                                return {
-                                    name: k,
-                                    in: "query",
-                                    required: v.required == null ? false : true,
-                                    schema: {
-                                        type: v.type
-                                    }
-                                };
-                            })
-                        ];
-                    }
-                    if (swagger.cookies != null) {
-                        spec.parameters = [
-                            ...spec.parameters,
-                            ...[{
-                                    name: "Cookie",
-                                    in: "header",
-                                    required: swagger.cookies.required == null ? false : true,
-                                    schema: {
-                                        type: "string"
-                                    },
-                                    example: swagger.cookies.names.map((v, i) => `${v}={value${i + 1}}`).join(' ; '),
-                                    description: swagger.cookies?.description
-                                }]
-                        ];
-                    }
-                    if (swagger.body != null) {
-                        spec.requestBody = {
-                            description: swagger.body?.description == null ? "description" : swagger.body.description,
-                            required: swagger.body?.required == null ? false : true,
-                            content: {
-                                "application/json": {
-                                    schema: {
-                                        type: "object",
-                                        properties: swagger.body.properties
-                                    }
-                                }
-                            }
-                        };
-                    }
-                    if (swagger.files != null) {
-                        spec.requestBody = {
-                            description: swagger.files?.description == null ? "description" : swagger.files.description,
-                            required: swagger.files?.required == null ? false : true,
-                            content: {
-                                "multipart/form-data": {
-                                    schema: {
-                                        type: "object",
-                                        properties: swagger.files.properties
-                                    }
-                                }
-                            }
-                        };
-                    }
-                    if (swagger.responses != null) {
-                        const responses = {};
-                        for (const response of swagger.responses) {
-                            if (response == null || !Object.keys(response).length)
-                                continue;
-                            responses[`${response.status}`] = {
-                                description: response.description,
-                                content: {
-                                    "application/json": {
-                                        schema: {
-                                            type: 'object',
-                                            properties: response.example == null
-                                                ? {}
-                                                : Object.keys(response.example)
-                                                    .reduce((prev, key) => {
-                                                    prev[key] = { example: (response?.example ?? {})[key] ?? {} };
-                                                    return prev;
-                                                }, {})
-                                        }
-                                    }
-                                }
-                            };
-                        }
-                        spec.responses = {
-                            ...responses
-                        };
+                    if (!Object.keys(spec.responses).length) {
+                        spec.responses = defaultSpecResponse;
                     }
                     paths[path][method] = spec;
                     continue;
                 }
                 spec.tags = [
-                    tags == null || tags === '' || /^:[^:]*$/.test(tags) ? 'default' : tags
+                    swagger.tags == null
+                        ? tags == null || tags === "" || /^:[^:]*$/.test(tags)
+                            ? "default"
+                            : tags
+                        : swagger.tags,
                 ];
-                if (Array.isArray(r.params) && Array.from(r.params).length) {
-                    spec.parameters = Array.from(r.params).map(p => {
+                if (swagger.bearerToken) {
+                    spec.security = [{ BearerToken: [] }];
+                }
+                if (swagger.summary != null) {
+                    spec.summary = swagger.summary;
+                }
+                if (swagger.description != null) {
+                    spec.description = swagger.description;
+                }
+                if (swagger.params != null) {
+                    const params = Object.entries(swagger.params).map(([k, v]) => {
+                        return {
+                            name: k,
+                            in: "path",
+                            required: v?.required === true,
+                            description: v?.description,
+                            example: v?.example || v?.enum,
+                            schema: {
+                                type: v?.type ?? "string",
+                            }
+                        };
+                    });
+                    spec.parameters = [
+                        ...(spec.parameters ?? []),
+                        ...params,
+                    ];
+                }
+                else if (Array.isArray(r.params) && Array.from(r.params).length) {
+                    spec.parameters = Array.from(r?.params).map((p) => {
                         return {
                             name: p,
                             in: "path",
                             required: true,
                             schema: {
-                                type: "string"
+                                type: "string",
+                            },
+                        };
+                    });
+                }
+                if (swagger.query != null) {
+                    const queryParams = Object.entries(swagger.query).map(([k, v]) => {
+                        return {
+                            name: k,
+                            in: "query",
+                            required: v?.required === true,
+                            description: v?.description,
+                            example: v?.example || v?.enum,
+                            schema: {
+                                type: v?.type ?? "string",
                             }
                         };
                     });
+                    spec.parameters = [
+                        ...(spec.parameters ?? []),
+                        ...queryParams,
+                    ];
+                }
+                if (swagger.cookies != null) {
+                    spec.parameters = [
+                        ...spec.parameters,
+                        ...[
+                            {
+                                name: "Cookie",
+                                in: "header",
+                                required: swagger.cookies.required === true,
+                                schema: {
+                                    type: "string",
+                                },
+                                example: swagger.cookies.names
+                                    .map((v, i) => `${v}={value${i + 1}}`)
+                                    .join(" ; "),
+                                description: swagger.cookies?.description,
+                            },
+                        ],
+                    ];
+                }
+                if (swagger.body != null) {
+                    spec.requestBody = {
+                        description: swagger.body.description,
+                        required: swagger.body?.required === true,
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: "object",
+                                    properties: swagger.body.properties,
+                                    required: Object.entries(swagger.body.properties)
+                                        .filter(([_, v]) => v.required)
+                                        .map(([key]) => key)
+                                },
+                            },
+                        },
+                    };
+                }
+                if (swagger.files != null) {
+                    spec.requestBody = {
+                        description: swagger.files.description,
+                        required: swagger.files?.required === true,
+                        content: {
+                            "multipart/form-data": {
+                                schema: {
+                                    type: "object",
+                                    properties: swagger.files.properties,
+                                },
+                            },
+                        },
+                    };
+                }
+                if (swagger.responses != null) {
+                    const responses = {};
+                    for (const response of swagger.responses) {
+                        if (response == null || !Object.keys(response).length)
+                            continue;
+                        responses[`${response.status}`] = {
+                            description: response.description,
+                            content: {
+                                "application/json": {
+                                    schema: {
+                                        type: "object",
+                                        properties: response.example == null
+                                            ? {}
+                                            : Object.keys(response.example).reduce((prev, key) => {
+                                                prev[key] = {
+                                                    example: (response?.example ?? {})[key] ?? {},
+                                                };
+                                                return prev;
+                                            }, {}),
+                                    },
+                                },
+                            },
+                        };
+                    }
+                    spec.responses = {
+                        ...responses,
+                    };
+                }
+                if (!Object.keys(spec.responses).length) {
+                    spec.responses = defaultSpecResponse;
                 }
                 paths[path][method] = spec;
             }
@@ -384,20 +474,17 @@ class ParserFactory {
         };
         spec.paths = specPaths(doc.routes ?? []);
         const normalizePath = (...paths) => {
-            const path = paths
-                .join('/')
-                .replace(/\/+/g, '/')
-                .replace(/\/+$/, '');
-            const normalizedPath = path.startsWith('/') ? path : `/${path}`;
+            const path = paths.join("/").replace(/\/+/g, "/").replace(/\/+$/, "");
+            const normalizedPath = path.startsWith("/") ? path : `/${path}`;
             return /\/api\/api/.test(normalizedPath)
                 ? normalizedPath.replace(/\/api\/api\//, "/api/")
                 : normalizedPath;
         };
-        const STATIC_URL = '/swagger-ui';
-        const iconURL = normalizePath(doc.staticUrl ?? '', `${STATIC_URL}/favicon-32x32.png`).replace(/^\/(http[s]?:\/{0,2})/, '$1');
-        const cssURL = normalizePath(doc.staticUrl ?? '', `${STATIC_URL}/swagger-ui.css`).replace(/^\/(http[s]?:\/{0,2})/, '$1');
-        const scriptBundle = normalizePath(doc.staticUrl ?? '', `${STATIC_URL}/swagger-ui-bundle.js`).replace(/^\/(http[s]?:\/{0,2})/, '$1');
-        const scriptStandalonePreset = normalizePath(doc.staticUrl ?? '', `${STATIC_URL}/swagger-ui-standalone-preset.js`).replace(/^\/(http[s]?:\/{0,2})/, '$1');
+        const STATIC_URL = "/swagger-ui";
+        const iconURL = normalizePath(doc.staticUrl ?? "", `${STATIC_URL}/favicon-32x32.png`).replace(/^\/(http[s]?:\/{0,2})/, "$1");
+        const cssURL = normalizePath(doc.staticUrl ?? "", `${STATIC_URL}/swagger-ui.css`).replace(/^\/(http[s]?:\/{0,2})/, "$1");
+        const scriptBundle = normalizePath(doc.staticUrl ?? "", `${STATIC_URL}/swagger-ui-bundle.js`).replace(/^\/(http[s]?:\/{0,2})/, "$1");
+        const scriptStandalonePreset = normalizePath(doc.staticUrl ?? "", `${STATIC_URL}/swagger-ui-standalone-preset.js`).replace(/^\/(http[s]?:\/{0,2})/, "$1");
         const html = `
         <!DOCTYPE html>
         <html lang="en">
@@ -425,7 +512,7 @@ class ParserFactory {
                         presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset], 
                         spec : ${JSON.stringify(spec)}, 
                         withCredentials: ${doc.options?.withCredentials ?? "true"},
-                        layout: "${doc.options?.layout ?? 'StandaloneLayout'}",
+                        layout: "${doc.options?.layout ?? "StandaloneLayout"}",
                         filter: "${doc.options?.filter ?? "false"}",
                         docExpansion: "${doc.options?.docExpansion ?? "list"}",
                         deepLinking: "${doc.options?.deepLinking ?? "true"}",
@@ -437,36 +524,36 @@ class ParserFactory {
         </html>
         `;
         const staticSwaggerHandler = (req, res, params) => {
-            const swaggerUiPath = swagger_ui_dist_1.default.getAbsoluteFSPath();
-            const mimeTypes = {
-                '.html': 'text/html',
-                '.css': 'text/css',
-                '.js': 'application/javascript',
-                '.png': 'image/png',
-                '.jpg': 'image/jpeg',
-                '.gif': 'image/gif',
-                '.svg': 'image/svg+xml',
-                '.json': 'application/json'
-            };
-            const requestedFilePath = params['*'];
-            const filePath = path_1.default.join(swaggerUiPath, requestedFilePath);
-            const extname = path_1.default.extname(filePath);
-            const contentType = mimeTypes[extname] || 'text/html';
             try {
+                const swaggerUiPath = swagger_ui_dist_1.default.getAbsoluteFSPath();
+                const mimeTypes = {
+                    ".html": "text/html",
+                    ".css": "text/css",
+                    ".js": "application/javascript",
+                    ".png": "image/png",
+                    ".jpg": "image/jpeg",
+                    ".gif": "image/gif",
+                    ".svg": "image/svg+xml",
+                    ".json": "application/json",
+                };
+                const requestedFilePath = params["*"];
+                const filePath = path_1.default.join(swaggerUiPath, requestedFilePath);
+                const extname = path_1.default.extname(filePath);
+                const contentType = mimeTypes[extname] || "text/html";
                 const content = fs_1.default.readFileSync(filePath);
-                res.writeHead(200, { 'Content-Type': contentType });
-                return res.end(content, 'utf-8');
+                res.writeHead(200, { "Content-Type": contentType });
+                return res.end(content, "utf-8");
             }
             catch (err) {
-                res.writeHead(404, { 'Content-Type': contentType });
-                return res.end(`The file '${requestedFilePath}' is not exists`);
+                res.writeHead(404, { "Content-Type": "text/plain" });
+                return res.end("Not found");
             }
         };
         return {
             path: doc.path,
             staticUrl: `${STATIC_URL}/*`,
             staticSwaggerHandler,
-            html
+            html,
         };
     }
 }