tspace-spear 1.0.0 → 1.0.1

package/build/lib/core/server/index.js

@@ -35,20 +35,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = void 0;
+exports.Application = exports.Spear = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const find_my_way_1 = __importDefault(require("find-my-way"));
-const formidable_1 = __importDefault(require("formidable"));
 const url_1 = require("url");
 const on_finished_1 = __importDefault(require("on-finished"));
-const string_decoder_1 = require("string_decoder");
 const http_1 = __importStar(require("http"));
+const parser_factory_1 = require("./parser-factory");
 /**
  *
- * The 'Application' class is used to create a server and handle HTTP requests.
+ * The 'Spear' class is used to create a server and handle HTTP requests.
  *
- * @returns {Application} application
+ * @returns {Spear} application
  * @example
  * new Application()
  *  .get('/' , () => 'Hello world!')
@@ -60,128 +59,62 @@ const http_1 = __importStar(require("http"));
  *  .listen(3000 , () => console.log('server listening on port : 3000'))
  *
  */
-class Application {
+class Spear {
     constructor({ controllers, middlewares, globalPrefix, logger } = {}) {
         this._router = (0, find_my_way_1.default)();
+        this._parser = new parser_factory_1.ParserFactory();
+        this._swagger = {
+            use: false,
+            path: '/api/docs',
+            servers: [
+                {
+                    url: 'http://localhost:3000'
+                }
+            ],
+            tags: [],
+            info: {
+                title: "API Documentation",
+                description: "This is a sample documentation",
+                version: "1.0.0"
+            }
+        };
+        this._swaggerAdditional = [];
         this._errorHandler = null;
         this._globalMiddlewares = [];
         this._formatResponse = null;
         this._onListeners = [];
         this._fileUploadOptions = {
-            limits: Infinity,
-            useTempFiles: false,
+            limit: Infinity,
             tempFileDir: 'tmp',
             removeTempFile: {
-                remove: true,
+                remove: false,
                 ms: 1000 * 60 * 10
             }
         };
-        this._filesParser = (req) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const temp = this._fileUploadOptions.tempFileDir;
-                if (!fs_1.default.existsSync(temp)) {
-                    try {
-                        fs_1.default.mkdirSync(temp, { recursive: true });
-                    }
-                    catch (err) { }
-                }
-                const form = (0, formidable_1.default)({ uploadDir: temp });
-                const [dataBody, dataFiles] = yield form.parse(req);
-                const files = {};
-                const body = {};
-                const removeTemp = (fileTemp) => {
-                    if (!this._fileUploadOptions.removeTempFile.remove)
-                        return;
-                    const remove = () => fs_1.default.unlinkSync(fileTemp);
-                    setTimeout(remove, this._fileUploadOptions.removeTempFile.ms);
-                };
-                for (const key in dataFiles) {
-                    const v = dataFiles[key];
-                    if (v == null)
-                        continue;
-                    const file = v[0];
-                    if (file.size > this._fileUploadOptions.limits) {
-                        fs_1.default.unlinkSync(file.filepath);
-                        continue;
-                    }
-                    files[key] = {
-                        size: file.size,
-                        tempFilePath: file.filepath,
-                        tempFileName: file.newFilename,
-                        mimetype: file.mimetype,
-                        name: file.originalFilename
-                    };
-                    removeTemp(file.filepath);
-                }
-                for (const key in dataBody) {
-                    const v = dataBody[key];
-                    if (v == null)
-                        continue;
-                    body[key] = v[0];
-                }
-                return {
-                    body,
-                    files
-                };
-            }
-            catch (e) {
-                return {
-                    body: {},
-                    files: {}
-                };
-            }
-        });
-        this._bodyParser = (req) => {
-            if ((req === null || req === void 0 ? void 0 : req._writeParserEnd) === true)
-                return req._bodyParser;
-            return new Promise((resolve, reject) => {
-                const decoder = new string_decoder_1.StringDecoder('utf-8');
-                let payload = '';
-                req.on('data', (data) => {
-                    payload += decoder.write(data);
-                });
-                req.on('end', () => {
-                    try {
-                        payload += decoder.end();
-                        req._writeParserEnd = true;
-                        req._bodyParser = JSON.parse(payload);
-                        return resolve(JSON.parse(payload));
-                    }
-                    catch (e) {
-                        req._writeParserEnd = true;
-                        req._bodyParser = {};
-                        return resolve({});
-                    }
-                });
-                req.on('error', (err) => {
-                    req._writeParserEnd = true;
-                    req._bodyParser = {};
-                    return reject(err);
-                });
-            });
-        };
         this._wrapHandlers = (...handlers) => {
             return (req, res, params) => __awaiter(this, void 0, void 0, function* () {
-                const runHandler = (index = 0) => __awaiter(this, void 0, void 0, function* () {
+                const runHandler = (...args_1) => __awaiter(this, [...args_1], void 0, function* (index = 0) {
                     const response = this._customizeResponse(req, res);
                     const request = req;
                     const body = request._bodyParser;
                     const files = request._filesParser;
                     const cookies = request._cookiesParser;
+                    const headers = request.headers;
                     const query = Object.assign({}, (0, url_1.parse)(String(req.url), true).query);
-                    const objectOrNull = (data) => {
+                    const RecordOrEmptyRecord = (data) => {
                         if (data == null)
-                            return null;
-                        return Object.keys(data).length ? data : null;
+                            return {};
+                        return Object.keys(data).length ? data : {};
                     };
                     const ctx = {
                         req: request,
                         res: response,
-                        params: objectOrNull(params),
-                        query: objectOrNull(query),
-                        body: objectOrNull(body),
-                        files: objectOrNull(files),
-                        cookies: objectOrNull(cookies),
+                        headers: RecordOrEmptyRecord(headers),
+                        params: RecordOrEmptyRecord(params),
+                        query: RecordOrEmptyRecord(query),
+                        body: RecordOrEmptyRecord(body),
+                        files: RecordOrEmptyRecord(files),
+                        cookies: RecordOrEmptyRecord(cookies),
                     };
                     if (index === handlers.length - 1) {
                         return this._wrapResponse(handlers[index].bind(handlers[index]))(ctx, this._nextFunction(ctx));
@@ -195,11 +128,12 @@ class Application {
                     const ctx = {
                         req,
                         res: this._customizeResponse(req, res),
-                        params: Object.keys(params).length ? params : null,
-                        query: null,
-                        body: null,
-                        files: null,
-                        cookies: null
+                        params: Object.keys(params).length ? params : {},
+                        headers: {},
+                        query: {},
+                        body: {},
+                        files: {},
+                        cookies: {}
                     };
                     return this._nextFunction(ctx)(err);
                 });
@@ -211,6 +145,12 @@ class Application {
         this._middlewares = middlewares;
         this._globalPrefix = globalPrefix == null ? '' : globalPrefix;
     }
+    get instance() {
+        return this;
+    }
+    get routers() {
+        return this._router;
+    }
     /**
      * The 'enableCors' is used to enable the cors origins on the server.
      *
@@ -225,7 +165,7 @@ class Application {
             const origin = (_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin;
             if (origin == null)
                 return next();
-            res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
+            res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, PATCH, DELETE, OPTIONS');
             res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
             if (origins == null) {
                 res.setHeader('Access-Control-Allow-Origin', '*');
@@ -254,44 +194,20 @@ class Application {
         this._globalMiddlewares.push(middleware);
         return this;
     }
-    /**
-     * The 'useRouter' method is used to add the router in the request context.
-     *
-     * @parms {Function} router
-     * @property  {Function} router - get() , post() , put() , patch() , delete()
-     * @returns {this}
-     */
-    useRouter(router) {
-        const routes = router.routes;
-        for (const { path, method, handlers } of routes) {
-            let normalizePath = [
-                this._globalPrefix,
-                path
-            ].join('/')
-                .replace(/\/+/g, '/')
-                .replace(/\/+$/, '');
-            normalizePath = normalizePath.startsWith('/') ? normalizePath : `/${normalizePath}`;
-            this[method](normalizePath, ...handlers);
-        }
-        return this;
-    }
     /**
      * The 'useBodyParser' method is a middleware used to parse the request body of incoming HTTP requests.
      *
      * @returns {this}
      */
     useBodyParser() {
-        this._globalMiddlewares.push(({ req, res }, next) => __awaiter(this, void 0, void 0, function* () {
+        this._globalMiddlewares.push((_a, next_1) => __awaiter(this, [_a, next_1], void 0, function* ({ req, res }, next) {
             const contentType = req === null || req === void 0 ? void 0 : req.headers['content-type'];
             const isFileUpload = contentType && contentType.startsWith('multipart/form-data');
-            const isListMethods = ['POST', 'PATCH', 'PUT'].includes(String(req.method));
-            if (!isListMethods)
-                return next();
             if (isFileUpload)
                 return next();
             if ((req === null || req === void 0 ? void 0 : req._bodyParser) != null)
                 return next();
-            req._bodyParser = yield this._bodyParser(req);
+            req._bodyParser = yield this._parser.body(req);
             return next();
         }));
         return this;
@@ -305,37 +221,47 @@ class Application {
         this._globalMiddlewares.push(({ req }, next) => {
             if ((req === null || req === void 0 ? void 0 : req._cookiesParser) != null)
                 return next();
-            req._cookiesParser = this._cookiesParser(req);
+            req._cookiesParser = this._parser.cookies(req);
             return next();
         });
         return this;
     }
+    /**
+     * The 'useRouter' method is used to add the router in the request context.
+     *
+     * @parms {Function} router
+     * @property  {Function} router - get() , post() , put() , patch() , delete()
+     * @returns {this}
+     */
+    useRouter(router) {
+        const routes = router.routes;
+        for (const { path, method, handlers } of routes) {
+            this[method](this._normalizePath(this._globalPrefix, path), ...handlers);
+        }
+        return this;
+    }
     /**
      * The 'useFileUpload' method is a middleware used to handler file uploads. It adds a file upload of incoming HTTP requests.
      *
      * @param {?Object}
      * @property {?number} limits
-     * @property {?boolean} useTempFiles
      * @property {?string} tempFileDir
      * @property {?Object} removeTempFile
      * @property {boolean} removeTempFile.remove
      * @property {number} removeTempFile.ms
      * @returns
      */
-    useFileUpload({ limits, useTempFiles, tempFileDir, removeTempFile } = {}) {
-        if (limits != null) {
-            this._fileUploadOptions.limits = limits;
+    useFileUpload({ limit, tempFileDir, removeTempFile } = {}) {
+        if (limit != null) {
+            this._fileUploadOptions.limit = limit;
         }
         if (tempFileDir != null) {
             this._fileUploadOptions.tempFileDir = tempFileDir;
         }
-        if (useTempFiles != null) {
-            this._fileUploadOptions.useTempFiles = useTempFiles;
-        }
         if (removeTempFile != null) {
             this._fileUploadOptions.removeTempFile = removeTempFile;
         }
-        this._globalMiddlewares.push(({ req }, next) => __awaiter(this, void 0, void 0, function* () {
+        this._globalMiddlewares.push((_a, next_1) => __awaiter(this, [_a, next_1], void 0, function* ({ req }, next) {
             const contentType = req === null || req === void 0 ? void 0 : req.headers['content-type'];
             const isFileUpload = contentType && contentType.startsWith('multipart/form-data');
             const isListMethods = ['POST', 'PATCH', 'PUT'].includes(String(req.method));
@@ -345,13 +271,33 @@ class Application {
                 return next();
             if ((req === null || req === void 0 ? void 0 : req._filesParser) != null)
                 return next();
-            const { body, files } = yield this._filesParser(req);
+            const { body, files } = yield this._parser.files({ req, options: this._fileUploadOptions });
             req._filesParser = files;
             req._bodyParser = body;
             return next();
         }));
         return this;
     }
+    /**
+     * The 'useSwagger' method is a middleware used to create swagger api.
+     *
+     * @param {?Object}
+     * @property {?string} path
+     * @property {?array} servers
+     * @property {?object} info
+     * @property {?array} tags
+     * @returns
+     */
+    useSwagger({ path, servers, info, tags } = {}) {
+        this._swagger = {
+            use: true,
+            path: path !== null && path !== void 0 ? path : this._swagger.path,
+            servers: servers !== null && servers !== void 0 ? servers : this._swagger.servers,
+            tags: tags !== null && tags !== void 0 ? tags : this._swagger.tags,
+            info: info !== null && info !== void 0 ? info : this._swagger.info
+        };
+        return this;
+    }
     /**
      * The 'formatResponse' method is used to format the response
      *
@@ -383,11 +329,12 @@ class Application {
             return notfound({
                 req,
                 res: this._customizeResponse(req, res),
-                query: null,
-                files: null,
-                body: null,
-                params: null,
-                cookies: null
+                headers: {},
+                query: {},
+                files: {},
+                body: {},
+                params: {},
+                cookies: {}
             });
         };
         this._onListeners.push(() => {
@@ -406,7 +353,7 @@ class Application {
      */
     get(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.get(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.get(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -421,7 +368,7 @@ class Application {
      */
     post(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.post(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.post(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -436,7 +383,7 @@ class Application {
      */
     put(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.put(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.put(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -451,7 +398,7 @@ class Application {
      */
     patch(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.patch(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.patch(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -466,7 +413,7 @@ class Application {
      */
     delete(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.delete(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.delete(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -481,7 +428,7 @@ class Application {
      */
     all(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.all(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.all(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -492,24 +439,36 @@ class Application {
      * @param {function} cb
      * @returns
      */
-    listen(port = 3000, cb) {
-        return __awaiter(this, arguments, void 0, function* () {
-            if (arguments.length === 1 && typeof port === 'function') {
+    listen() {
+        var arguments_1 = arguments;
+        return __awaiter(this, arguments, void 0, function* (port = 3000, cb) {
+            if (arguments_1.length === 1 && typeof port === 'function') {
                 cb = port;
                 port = 3000;
             }
             const server = yield this._createServer();
+            server.listen(port == null ? 3000 : port, () => {
+                if (cb)
+                    cb({ server, port });
+            });
             server.on('listening', () => {
                 this._onListeners.forEach(listener => listener());
+                if (this._swagger.use) {
+                    const routes = this.routers
+                        .routes.filter(r => ["GET", "POST", "PUT", "PATCH", "DELETE"].includes(r.method));
+                    const { path, html, staticSwaggerHandler, staticUrl } = this._parser.swagger(Object.assign(Object.assign({}, this._swagger), { options: this._swaggerAdditional, routes }));
+                    this.routers.get(staticUrl, staticSwaggerHandler);
+                    this.routers.get(String(path), (req, res) => {
+                        res.writeHead(200, { 'Content-Type': 'text/html' });
+                        res.write(html);
+                        return res.end();
+                    });
+                }
             });
             server.on('error', (_) => {
                 port = Math.floor(Math.random() * 8999) + 1000;
                 server.listen(port);
             });
-            server.listen(port == null ? 3000 : port, () => {
-                if (cb)
-                    cb();
-            });
             return;
         });
     }
@@ -560,6 +519,7 @@ class Application {
     }
     _registerControllers() {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f;
             if (this._controllers == null)
                 return;
             if (!Array.isArray(this._controllers)) {
@@ -568,40 +528,40 @@ class Application {
                     const response = yield Promise.resolve(`${file}`).then(s => __importStar(require(s)));
                     const controller = response === null || response === void 0 ? void 0 : response.default;
                     const controllerInstance = new controller();
-                    const prefixPath = Reflect.getMetadata("controllers", controller);
-                    const routers = Reflect.getMetadata("routers", controller);
+                    const prefixPath = (_a = Reflect.getMetadata("controllers", controller)) !== null && _a !== void 0 ? _a : '';
+                    const routers = (_b = Reflect.getMetadata("routers", controller)) !== null && _b !== void 0 ? _b : [];
+                    const swaggers = (_c = Reflect.getMetadata("swaggers", controller)) !== null && _c !== void 0 ? _c : [];
                     if (prefixPath == null)
                         continue;
-                    for (const { method, path, handler } of routers) {
-                        let normalizePath = [
-                            this._globalPrefix,
-                            prefixPath,
-                            path
-                        ].join('/')
-                            .replace(/\/+/g, '/')
-                            .replace(/\/+$/, '');
-                        normalizePath = normalizePath.startsWith('/') ? normalizePath : `/${normalizePath}`;
-                        this[method](normalizePath, this._wrapResponse(controllerInstance[String(handler)].bind(controllerInstance)));
+                    for (const { method, path, handler } of Array.from(routers)) {
+                        const find = Array.from(swaggers).find(s => s.handler === handler);
+                        if (find != null) {
+                            this._swaggerAdditional = [
+                                ...this._swaggerAdditional,
+                                Object.assign(Object.assign({}, find), { path: this._normalizePath(this._globalPrefix, prefixPath, path), method })
+                            ];
+                        }
+                        this[method](this._normalizePath(this._globalPrefix, prefixPath, path), this._wrapResponse(controllerInstance[String(handler)].bind(controllerInstance)));
                     }
                 }
                 return;
             }
             for (const controller of this._controllers) {
                 const controllerInstance = new controller();
-                const prefixPath = Reflect.getMetadata("controllers", controller);
-                const routers = Reflect.getMetadata("routers", controller);
+                const prefixPath = (_d = Reflect.getMetadata("controllers", controller)) !== null && _d !== void 0 ? _d : '';
+                const routers = (_e = Reflect.getMetadata("routers", controller)) !== null && _e !== void 0 ? _e : [];
+                const swaggers = (_f = Reflect.getMetadata("swaggers", controller)) !== null && _f !== void 0 ? _f : [];
                 if (prefixPath == null)
                     continue;
-                for (const { method, path, handler } of routers) {
-                    let normalizePath = [
-                        this._globalPrefix,
-                        prefixPath,
-                        path
-                    ].join('/')
-                        .replace(/\/+/g, '/')
-                        .replace(/\/+$/, '');
-                    normalizePath = normalizePath.startsWith('/') ? normalizePath : `/${normalizePath}`;
-                    this[method](normalizePath, this._wrapResponse(controllerInstance[String(handler)].bind(controllerInstance)));
+                for (const { method, path, handler } of Array.from(routers)) {
+                    const find = Array.from(swaggers).find(s => s.handler === handler);
+                    if (find != null) {
+                        this._swaggerAdditional = [
+                            ...this._swaggerAdditional,
+                            Object.assign(Object.assign({}, find), { path: this._normalizePath(this._globalPrefix, prefixPath, path), method })
+                        ];
+                    }
+                    this[method](this._normalizePath(this._globalPrefix, prefixPath, path), this._wrapResponse(controllerInstance[String(handler)].bind(controllerInstance)));
                 }
             }
         });
@@ -626,28 +586,6 @@ class Application {
             return;
         });
     }
-    _cookiesParser(req) {
-        var _a;
-        const cookies = {};
-        const cookieString = (_a = req.headers) === null || _a === void 0 ? void 0 : _a.cookie;
-        if (cookieString == null)
-            return null;
-        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='))
-                continue;
-            const expiresString = cookie.replace('Expires=', '');
-            const expiresDate = new Date(expiresString);
-            if (isNaN(expiresDate.getTime()) || expiresDate < new Date()) {
-                delete cookies[name];
-            }
-        }
-        return cookies;
-    }
     _customizeResponse(req, res) {
         const response = res;
         response.json = (results) => {
@@ -837,8 +775,6 @@ class Application {
     _wrapResponse(handler) {
         return (ctx, next) => __awaiter(this, void 0, void 0, function* () {
             const result = yield handler(ctx, next);
-            if (result == null)
-                return;
             if (result instanceof http_1.ServerResponse)
                 return;
             if (typeof result === 'string') {
@@ -858,11 +794,17 @@ class Application {
                 if (!ctx.res.headersSent) {
                     ctx.res.writeHead(200, { 'Content-Type': 'application/json' });
                 }
+                if (Array.isArray(result)) {
+                    return ctx.res.end(JSON.stringify(this._formatResponse(result)));
+                }
                 return ctx.res.end(JSON.stringify(this._formatResponse(Object.assign({}, result), ctx.res.statusCode), null, 2));
             }
             if (!ctx.res.headersSent) {
                 ctx.res.writeHead(200, { 'Content-Type': 'application/json' });
             }
+            if (Array.isArray(result)) {
+                return ctx.res.end(JSON.stringify(result));
+            }
             return ctx.res.end(JSON.stringify(Object.assign({}, result), null, 2));
         });
     }
@@ -876,6 +818,18 @@ class Application {
             return server;
         });
     }
+    _normalizePath(...paths) {
+        const path = paths
+            .join('/')
+            .replace(/\/+/g, '/')
+            .replace(/\/+$/, '');
+        const normalizedPath = path.startsWith('/') ? path : `/${path}`;
+        return /\/api\/api/.test(normalizedPath) ? normalizedPath.replace(/\/api\/api\//, "/api/") : normalizedPath;
+    }
+}
+exports.Spear = Spear;
+class Application extends Spear {
 }
 exports.Application = Application;
-exports.default = Application;
+exports.default = Spear;
+//# sourceMappingURL=index.js.map