tspace-spear 1.2.0 → 1.2.1

package/{build → dist}/lib/core/server/index.js

@@ -33,6 +33,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const url_1 = require("url");
 const on_finished_1 = __importDefault(require("on-finished"));
+const ws_1 = __importDefault(require("ws"));
 const http_1 = __importStar(require("http"));
 const find_my_way_1 = __importDefault(require("find-my-way"));
 const parser_factory_1 = require("./parser-factory");
@@ -75,7 +76,10 @@ class Spear {
             version: "1.0.0"
         }
     };
-    _swaggerAdditional = [];
+    _wss;
+    _ws;
+    _wsOptions;
+    _swaggerSpecs = [];
     _errorHandler = null;
     _globalMiddlewares = [];
     _formatResponse = null;
@@ -91,7 +95,8 @@ class Spear {
     constructor({ controllers, middlewares, globalPrefix, logger, cluster } = {}) {
         if (logger)
             this.useLogger();
-        this._cluster = cluster;
+        if (cluster)
+            this.useCluster(cluster);
         this._controllers = controllers;
         this._middlewares = middlewares;
         this._globalPrefix = globalPrefix == null ? '' : globalPrefix;
@@ -112,6 +117,18 @@ class Spear {
     get routers() {
         return this._router;
     }
+    /**
+     * The 'ws' method is used to creates the WebSocket server.
+     *
+     * @callback {Function} WebSocketServer
+     * @param {WebSocketServer} wss - WebSocketServer
+     * @returns {this}
+     */
+    ws(handlers, options) {
+        this._ws = handlers();
+        this._wsOptions = options ?? {};
+        return this;
+    }
     /**
      * The 'use' method is used to add the middleware into the request pipeline.
      *
@@ -131,7 +148,9 @@ class Spear {
      * @returns {this}
      */
     useCluster(cluster) {
-        this._cluster = cluster == null ? true : cluster;
+        if (cluster === false)
+            return this;
+        this._cluster = cluster ?? true;
         return this;
     }
     /**
@@ -193,7 +212,8 @@ class Spear {
             const { req } = ctx;
             const contentType = req?.headers['content-type'] ?? '';
             const isFileUpload = contentType && contentType.startsWith('multipart/form-data');
-            const isCanParserBody = contentType.includes('application/json') || contentType.includes('application/x-www-form-urlencoded');
+            const isCanParserBody = contentType.includes('application/json') ||
+                contentType.includes('application/x-www-form-urlencoded');
             if (except != null &&
                 Array.isArray(except) &&
                 except.some(v => v.toLocaleLowerCase() === (req.method)?.toLocaleLowerCase())) {
@@ -239,11 +259,11 @@ class Spear {
         }
         this._globalMiddlewares.push((ctx, next) => {
             const { req } = ctx;
-            const contentType = req?.headers['content-type'];
-            const isFileUpload = contentType && contentType.startsWith('multipart/form-data');
             if (req.method === 'GET') {
                 return next();
             }
+            const contentType = req?.headers['content-type'];
+            const isFileUpload = contentType && contentType.startsWith('multipart/form-data');
             if (!isFileUpload)
                 return next();
             if (req?.files != null)
@@ -292,16 +312,14 @@ class Spear {
     /**
      * 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
+     * @param {?Object} doc
      * @returns
      */
-    useSwagger({ path, servers, info, tags } = {}) {
+    useSwagger(doc = {}) {
+        const { path, servers, tags, info, options } = doc;
         this._swagger = {
             use: true,
+            options: options,
             path: path ?? this._swagger.path,
             servers: servers ?? this._swagger.servers,
             tags: tags ?? this._swagger.tags,
@@ -360,7 +378,7 @@ class Spear {
             const origin = req.headers?.origin ?? null;
             if (origin == null)
                 return;
-            res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, PATCH, DELETE, OPTIONS');
+            res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS');
             res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
             if (Array.isArray(origins) && origins.length) {
                 for (const o of origins) {
@@ -385,27 +403,6 @@ class Spear {
         });
         return this;
     }
-    /**
-     * The 'enableCors' is used to enable the cors origins on the server.
-     *
-     * @params {Object}
-     * @property {(string | RegExp)[]} origins
-     * @property {boolean} credentials
-     * @returns
-     */
-    enableCors({ origins, credentials } = {}) {
-        return this.cors({ origins, credentials });
-    }
-    /**
-     * The 'formatResponse' method is used to format the response
-     *
-     * @param {function} format
-     * @returns
-     */
-    formatResponse(format) {
-        this._formatResponse = format;
-        return this;
-    }
     /**
      * The 'response' method is used to format the response
      *
@@ -416,18 +413,6 @@ class Spear {
         this._formatResponse = format;
         return this;
     }
-    /**
-     * The 'errorHandler' method is middleware that is specifically designed to handle errors.
-     *
-     * that occur during the processing of requests
-     *
-     * @param {function} error
-     * @returns
-     */
-    errorHandler(error) {
-        this._errorHandler = error;
-        return this;
-    }
     /**
      * The 'catch' method is middleware that is specifically designed to handle errors.
      *
@@ -440,34 +425,10 @@ class Spear {
         this._errorHandler = error;
         return this;
     }
-    /**
-     * The 'notFoundHandler' method is middleware that is specifically designed to handle errors notfound that occur during the processing of requests
-     *
-     * @param {function} notfound
-     * @returns
-     */
-    notFoundHandler(fn) {
-        const handler = ({ req, res }) => {
-            return fn({
-                req,
-                res: this._customizeResponse(req, res),
-                headers: {},
-                query: {},
-                files: {},
-                body: {},
-                params: {},
-                cookies: {}
-            });
-        };
-        this._onListeners.push(() => {
-            return this.all('*', ...this._globalMiddlewares, handler);
-        });
-        return this;
-    }
     /**
      * The 'notfound' method is middleware that is specifically designed to handle errors notfound that occur during the processing of requests
      *
-     * @param {function} notfound
+     * @param {function} fn
      * @returns
      */
     notfound(fn) {
@@ -564,7 +525,7 @@ class Spear {
         return this;
     }
     /**
-     * The 'all' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' methods.
+     * The 'head' method is used to add the request handler to the router for 'HEAD' methods.
      *
      * @param {string} path
      * @callback {...Function[]} handlers of the middlewares
@@ -572,14 +533,29 @@ class Spear {
      * @property  {function} next  - go to next function
      * @returns {this}
      */
-    all(path, ...handlers) {
+    head(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.all(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.head(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
     /**
-     * The 'any' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' methods.
+     * The 'head' method is used to add the request handler to the router for 'HEAD' methods.
+     *
+     * @param {string} path
+     * @callback {...Function[]} handlers of the middlewares
+     * @property  {object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {function} next  - go to next function
+     * @returns {this}
+     */
+    options(path, ...handlers) {
+        this._onListeners.push(() => {
+            return this._router.options(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+        });
+        return this;
+    }
+    /**
+     * The 'any' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' 'HEAD' 'OPTIONS' methods.
      *
      * @param {string} path
      * @callback {...Function[]} handlers of the middlewares
@@ -593,6 +569,21 @@ class Spear {
         });
         return this;
     }
+    /**
+    * The 'all' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' 'HEAD' 'OPTIONS' methods.
+    *
+    * @param {string} path
+    * @callback {...Function[]} handlers of the middlewares
+    * @property  {object} ctx - context { req , res , query , params , cookies , files , body}
+    * @property  {function} next  - go to next function
+    * @returns {this}
+    */
+    all(path, ...handlers) {
+        this._onListeners.push(() => {
+            return this._router.all(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+        });
+        return this;
+    }
     _clusterMode({ server, port, hostname, callback }) {
         if (cluster_1.default.isPrimary) {
             const numCPUs = os_1.default.cpus().length;
@@ -645,8 +636,21 @@ class Spear {
         if (!Array.isArray(this._controllers)) {
             const controllers = await this._import(this._controllers.folder, this._controllers.name);
             for (const file of controllers) {
-                const response = await Promise.resolve(`${file}`).then(s => __importStar(require(s)));
-                const controller = response?.default;
+                const imported = await Promise.resolve(`${file}`).then(s => __importStar(require(s)));
+                let maybeController = imported?.default;
+                if (maybeController == null) {
+                    const entry = Object
+                        .entries(imported)
+                        .find(([name]) => {
+                        return /controller$/i.test(name);
+                    });
+                    maybeController = entry?.[1];
+                }
+                const controller = maybeController;
+                if (typeof controller !== "function") {
+                    console.log(`\x1b[31m[ControllerLoader ERROR]\x1b[0m \x1b[36m${file}\x1b[0m must export a controller class`);
+                    continue;
+                }
                 const controllerInstance = new controller();
                 const prefixPath = Reflect.getMetadata("controllers", controller) ?? '';
                 const routers = Reflect.getMetadata("routers", controller) ?? [];
@@ -656,8 +660,8 @@ class Spear {
                 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,
+                        this._swaggerSpecs = [
+                            ...this._swaggerSpecs,
                             {
                                 ...find,
                                 path: this._normalizePath(this._globalPrefix, prefixPath, path),
@@ -680,8 +684,8 @@ class Spear {
             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,
+                    this._swaggerSpecs = [
+                        ...this._swaggerSpecs,
                         {
                             ...find,
                             path: this._normalizePath(this._globalPrefix, prefixPath, path),
@@ -699,8 +703,21 @@ class Spear {
         if (!Array.isArray(this._middlewares)) {
             const middlewares = await this._import(this._middlewares.folder, this._middlewares.name);
             for (const file of middlewares) {
-                const response = await Promise.resolve(`${file}`).then(s => __importStar(require(s)));
-                const middleware = response?.default;
+                const imported = await Promise.resolve(`${file}`).then(s => __importStar(require(s)));
+                let maybeMiddleware = imported?.default;
+                if (maybeMiddleware == null) {
+                    const entry = Object
+                        .entries(imported)
+                        .find(([name]) => {
+                        return /middleware$/i.test(name);
+                    });
+                    maybeMiddleware = entry?.[1];
+                }
+                const middleware = maybeMiddleware;
+                if (typeof middleware !== "function") {
+                    console.log(`\x1b[31m[MiddlewareLoader ERROR]\x1b[0m \x1b[36m${file}\x1b[0m must export a middleware`);
+                    continue;
+                }
                 this.use(middleware);
             }
             return;
@@ -753,24 +770,26 @@ class Spear {
             return res.end(results);
         };
         response.error = (err) => {
-            let code = +err.response?.data?.code ||
-                +err.code ||
-                +err.status ||
-                +err.statusCode ||
-                +err.response?.data?.statusCode ||
-                500;
-            code = (code == null || typeof code !== 'number') ? 500 : Number.isNaN(code) ? 500 : code < 400 ? 500 : code;
-            const message = err.response?.data?.errorMessage ||
-                err.response?.data?.message ||
-                err.message ||
-                `The url '${req.url}' resulted in a server error. Please investigate.`;
+            const statusCandidates = [
+                err?.response?.data?.code,
+                err?.code,
+                err?.status,
+                err?.statusCode,
+                err?.response?.data?.statusCode
+            ];
+            let code = statusCandidates
+                .map(v => Number(v))
+                .find(v => Number.isFinite(v) && v >= 400) ?? 500;
+            const message = err?.response?.data?.errorMessage ??
+                err?.response?.data?.message ??
+                err?.message ??
+                `The request '${req.url}' resulted in a server error.`;
             response.status(code);
-            if (this._formatResponse != null) {
-                return res.end(JSON.stringify(this._formatResponse({ message }, code), null, 2));
+            const payload = { message };
+            if (this._formatResponse) {
+                return res.end(JSON.stringify(this._formatResponse(payload, code)));
             }
-            return res.end(JSON.stringify({
-                message: message
-            }, null, 2));
+            return res.end(JSON.stringify(payload));
         };
         response.ok = (results) => {
             return response.json(results == null ? {} : results);
@@ -791,7 +810,7 @@ class Spear {
             if (res.writableEnded)
                 return;
             response.status(400);
-            message = message ?? `The url '${req.url}' resulted in a bad request. Please review the data and try again.`;
+            message = message ?? `The request '${req.url}' resulted in a bad request. Please review the data and try again.`;
             if (this._formatResponse != null) {
                 return res.end(JSON.stringify(this._formatResponse({ message }, 400), null, 2));
             }
@@ -801,7 +820,7 @@ class Spear {
         };
         response.unauthorized = (message) => {
             response.status(401);
-            message = message ?? `The url '${req.url}' is unauthorized. Please verify.`;
+            message = message ?? `The request '${req.url}' is unauthorized. Please verify.`;
             if (this._formatResponse != null) {
                 return res.end(JSON.stringify(this._formatResponse({ message }, 401), null, 2));
             }
@@ -811,7 +830,7 @@ class Spear {
         };
         response.paymentRequired = (message) => {
             response.status(402);
-            message = message ?? `The url '${req.url}' requires payment. Please proceed with payment.`;
+            message = message ?? `The request '${req.url}' requires payment. Please proceed with payment.`;
             if (this._formatResponse != null) {
                 return res.end(JSON.stringify(this._formatResponse({ message }, 402), null, 2));
             }
@@ -821,7 +840,7 @@ class Spear {
         };
         response.forbidden = (message) => {
             response.status(403);
-            message = message ?? `The url '${req.url}' is forbidden. Please check the permissions or access rights.`;
+            message = message ?? `The request '${req.url}' is forbidden. Please check the permissions or access rights.`;
             if (this._formatResponse != null) {
                 return res.end(JSON.stringify(this._formatResponse({ message }, 403), null, 2));
             }
@@ -831,7 +850,7 @@ class Spear {
         };
         response.notFound = (message) => {
             response.status(404);
-            message = message ?? `The url '${req.url}' was not found. Please re-check the your url again.`;
+            message = message ?? `The request '${req.url}' was not found. Please re-check the your url again.`;
             if (this._formatResponse != null) {
                 return res.end(JSON.stringify(this._formatResponse({ message }, 404), null, 2));
             }
@@ -839,11 +858,21 @@ class Spear {
                 message
             }, null, 2));
         };
+        response.unprocessable = (message) => {
+            response.status(422);
+            message = message ?? `The request to '${req.url}' failed validation.`;
+            if (this._formatResponse != null) {
+                return res.end(JSON.stringify(this._formatResponse({ message }, 422), null, 2));
+            }
+            return res.end(JSON.stringify({
+                message
+            }, null, 2));
+        };
         response.tooManyRequests = (message) => {
             response.status(429);
-            message = message ?? `The url '${req.url}' is too many request. Please wait and try agian.`;
+            message = message ?? `The request '${req.url}' is too many request. Please wait and try agian.`;
             if (this._formatResponse != null) {
-                return res.end(JSON.stringify(this._formatResponse({ message }, 404), null, 2));
+                return res.end(JSON.stringify(this._formatResponse({ message }, 429), null, 2));
             }
             return res.end(JSON.stringify({
                 message
@@ -851,7 +880,7 @@ class Spear {
         };
         response.serverError = (message) => {
             response.status(500);
-            message = message ?? `The url '${req.url}' resulted in a server error. Please investigate.`;
+            message = message ?? `The request '${req.url}' resulted in a server error. Please investigate.`;
             if (this._formatResponse != null) {
                 return res.end(JSON.stringify(this._formatResponse({ message }, 500), null, 2));
             }
@@ -892,106 +921,85 @@ class Spear {
         };
         return response;
     }
-    _nextFunction(ctx) {
-        const NEXT_MESSAGE = "The 'next' function does not have any subsequent function.";
-        return (err) => {
-            if (err != null) {
-                if (this._errorHandler != null) {
-                    return this._errorHandler(err, ctx);
-                }
-                ctx.res.writeHead(500, { 'Content-Type': 'application/json' });
-                if (this._formatResponse != null) {
-                    return ctx.res.end(JSON.stringify(this._formatResponse({
-                        message: err?.message,
-                    }, ctx.res.statusCode), null, 2));
-                }
-                return ctx.res.end(JSON.stringify({
-                    message: err?.message,
-                }, null, 2));
-            }
-            if (this._errorHandler != null) {
-                return this._errorHandler(new Error(NEXT_MESSAGE), ctx);
-            }
-            ctx.res.writeHead(500, { 'Content-Type': 'application/json' });
-            if (this._formatResponse != null) {
-                return ctx.res.end(JSON.stringify(this._formatResponse({
-                    message: NEXT_MESSAGE
-                }, ctx.res.statusCode), null, 2));
-            }
-            return ctx.res.end(JSON.stringify({
-                message: NEXT_MESSAGE
-            }, null, 2));
-        };
-    }
-    _wrapHandlers = (...handlers) => {
+    _wrapHandlers(...handlers) {
         return (req, res, params) => {
             const nextHandler = (index = 0) => {
-                const response = this._customizeResponse(req, res);
-                const request = req;
-                request.params = params;
-                const body = request.body;
-                const files = request.files;
-                const cookies = request.cookies;
-                const headers = request.headers;
-                const query = { ...(0, url_1.parse)(String(req.url), true).query };
-                const RecordOrEmptyRecord = (data) => {
-                    if (data == null)
-                        return {};
-                    return Object.keys(data).length ? data : {};
-                };
-                const ctx = {
-                    req: request,
-                    res: response,
-                    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));
+                try {
+                    const response = this._customizeResponse(req, res);
+                    const request = req;
+                    request.params = params;
+                    const body = request.body;
+                    const files = request.files;
+                    const cookies = request.cookies;
+                    const headers = request.headers;
+                    const url = new url_1.URL(req.url, "http://localhost");
+                    const query = Object.fromEntries(url.searchParams);
+                    const RecordOrEmptyRecord = (data) => {
+                        if (data == null)
+                            return {};
+                        return Object.keys(data).length ? data : {};
+                    };
+                    const ctx = {
+                        req: request,
+                        res: response,
+                        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));
+                    }
+                    return handlers[index](ctx, () => {
+                        return nextHandler(index + 1);
+                    });
+                }
+                catch (err) {
+                    const ctx = {
+                        req,
+                        res: this._customizeResponse(req, res),
+                        params: Object.keys(params).length ? params : {},
+                        headers: {},
+                        query: {},
+                        body: {},
+                        files: {},
+                        cookies: {}
+                    };
+                    return this._nextFunction(ctx)(err);
                 }
-                return handlers[index](ctx, () => {
-                    return nextHandler(index + 1);
-                });
             };
-            try {
-                if (res.writableEnded)
-                    return;
-                return nextHandler();
-            }
-            catch (err) {
-                const ctx = {
-                    req,
-                    res: this._customizeResponse(req, res),
-                    params: Object.keys(params).length ? params : {},
-                    headers: {},
-                    query: {},
-                    body: {},
-                    files: {},
-                    cookies: {}
-                };
-                return this._nextFunction(ctx)(err);
-            }
+            if (res.writableEnded)
+                return;
+            return nextHandler();
         };
-    };
+    }
     _wrapResponse(handler) {
         return (ctx, next) => {
             Promise.resolve(handler(ctx, next))
                 .then(result => {
                 if (ctx.res.writableEnded)
                     return;
-                if (result instanceof http_1.ServerResponse)
+                if (result instanceof http_1.ServerResponse) {
+                    if (result?.end) {
+                        result.end();
+                    }
                     return;
-                if (result == null)
+                }
+                if (result == null) {
+                    if (!ctx.res.headersSent) {
+                        ctx.res.writeHead(204, { 'Content-Type': 'text/plain' });
+                    }
+                    ctx.res.end();
                     return;
+                }
                 if (typeof result === 'string') {
                     if (!ctx.res.headersSent) {
                         ctx.res.writeHead(200, { 'Content-Type': 'text/plain' });
                     }
-                    ctx.res.end(result);
+                    ctx.res.end(result ?? '');
                     return;
                 }
                 if (this._formatResponse != null) {
@@ -1006,35 +1014,94 @@ class Spear {
                     if (!ctx.res.headersSent) {
                         ctx.res.writeHead(200, { 'Content-Type': 'application/json' });
                     }
-                    ctx.res.end(JSON.stringify(formattedResult, null, 2));
+                    ctx.res.end(JSON.stringify(formattedResult));
                     return;
                 }
                 if (!ctx.res.headersSent) {
                     ctx.res.writeHead(200, { 'Content-Type': 'application/json' });
                 }
-                ctx.res.end(result == null ? undefined : JSON.stringify(result, null, 2));
+                ctx.res.end(JSON.stringify(result));
                 return;
             })
                 .catch(err => {
-                if (ctx.res.writableEnded)
-                    return;
-                if (!ctx.res.headersSent) {
-                    ctx.res.writeHead(500, { 'Content-Type': 'application/json' });
-                }
-                ctx.res.end(JSON.stringify({ message: err?.message || 'Internal Server Error' }));
-                return;
+                return this._nextFunction(ctx)(err);
             });
         };
     }
+    _nextFunction(ctx) {
+        const NEXT_MESSAGE = "The 'next' function does not have any subsequent function.";
+        return (err) => {
+            if (err != null) {
+                if (this._errorHandler != null) {
+                    const callback = this._errorHandler(err, ctx);
+                    if (callback == null || !(callback instanceof http_1.ServerResponse)) {
+                        ctx.res.writeHead(500, { 'Content-Type': 'application/json' });
+                        return ctx.res.end(JSON.stringify({
+                            message: err?.message
+                        }, null, 2));
+                    }
+                    return callback;
+                }
+                ctx.res.writeHead(500, { 'Content-Type': 'application/json' });
+                if (this._formatResponse != null) {
+                    return ctx.res.end(JSON.stringify(this._formatResponse({
+                        message: err?.message,
+                    }, ctx.res.statusCode), null, 2));
+                }
+                return ctx.res.end(JSON.stringify({
+                    message: err?.message
+                }, null, 2));
+            }
+            if (this._errorHandler != null) {
+                return this._errorHandler(new Error(NEXT_MESSAGE), ctx);
+            }
+            ctx.res.writeHead(500, { 'Content-Type': 'application/json' });
+            if (this._formatResponse != null) {
+                return ctx.res.end(JSON.stringify(this._formatResponse({
+                    message: NEXT_MESSAGE
+                }, ctx.res.statusCode), null, 2));
+            }
+            return ctx.res.end(JSON.stringify({
+                message: NEXT_MESSAGE
+            }, null, 2));
+        };
+    }
     async _createServer() {
         await this._registerMiddlewares();
         await this._registerControllers();
-        const server = http_1.default.createServer({ maxHeaderSize: 1024 * 1024 }, (req, res) => {
-            if (this._cors != null) {
-                this._cors(req, res);
+        const lookup = this._router.lookup.bind(this._router);
+        const cors = this._cors;
+        const server = http_1.default.createServer({ maxHeaderSize: 1024 * 1024 }, cors
+            ? (req, res) => {
+                cors(req, res);
+                return lookup(req, res);
             }
-            return this._router.lookup(req, res);
-        });
+            : (req, res) => {
+                return lookup(req, res);
+            });
+        if (this._ws) {
+            this._wss = new ws_1.default.Server({ server, ...this._wsOptions });
+            this._wss.on('connection', (ws) => {
+                if (this._ws?.connection) {
+                    this._ws.connection(ws);
+                }
+                ws.on('message', (data) => {
+                    if (this._ws?.message) {
+                        this._ws.message(ws, data);
+                    }
+                });
+                ws.on('close', (code, reason) => {
+                    if (this._ws?.close) {
+                        this._ws.close(ws, code, reason);
+                    }
+                });
+                ws.on('error', (err) => {
+                    if (this._ws?.error) {
+                        this._ws.error(ws, err);
+                    }
+                });
+            });
+        }
         return server;
     }
     _normalizePath(...paths) {
@@ -1050,7 +1117,7 @@ class Spear {
             .routes.filter(r => ["GET", "POST", "PUT", "PATCH", "DELETE"].includes(r.method));
         const { path, html, staticSwaggerHandler, staticUrl } = this._parser.swagger({
             ...this._swagger,
-            options: this._swaggerAdditional,
+            specs: this._swaggerSpecs,
             routes
         });
         this._router.get(staticUrl, staticSwaggerHandler);