tspace-spear 1.0.0 → 1.0.1

package/build/lib/{types → core/types}/index.d.ts

@@ -1,28 +1,30 @@
-/// <reference types="node" />
 import { IncomingMessage, ServerResponse } from "http";
 export type TContext = {
     req: TRequest;
     res: TResponse;
+    headers: THeaders;
     query: TQuery;
     params: TParams;
     body: TBody;
     files: TFiles;
     cookies: TCookies;
 };
-export type TQuery<T = Record<string, string> | null> = T;
-export type TParams<T = Record<string, string> | null> = T;
-export type TBody<T = Record<string, string | number | boolean | undefined | null | any[] | Record<string, string | number | boolean | undefined | null | any[]>> | null> = T;
+export type THeaders<T = Record<string, string>> = T;
+export type TQuery<T = Record<string, string>> = T;
+export type TParams<T = Record<string, string>> = T;
+export type TBody<T = Record<string, string | number | boolean | undefined | null | any[] | Record<string, string | number | boolean | undefined | null | any[]>>> = T;
 export type TCookies<T = Record<string, any> | null> = T;
 export type TFiles<T = Record<string, {
     size: number;
     tempFilePath: string;
     tempName: string;
     mimetype: string;
+    extension: string;
     name: string;
-}> | null> = T;
+}[]> | null> = T;
 export type TNextFunction<T = any> = (err?: Error) => T | Promise<T>;
 export type TRequest<T = any> = IncomingMessage & Partial<T>;
-type HttpStatus = {
+type THttpStatus = {
     json: (data?: Record<string, any>) => void;
     error: (err: any) => void;
     ok: (data?: Record<string, any>) => void;
@@ -50,7 +52,7 @@ export type TResponse<T = any> = ServerResponse & {
         json: (data?: Record<string, any>) => void;
         send: (message: string) => void;
     };
-} & HttpStatus & Partial<T>;
+} & THttpStatus & Partial<T>;
 export type TRouter = {
     method: TMethods;
     path: string;
@@ -76,4 +78,74 @@ export type TApplication = {
 };
 export type TRequestFunction = (ctx: TContext, next: TNextFunction) => any;
 export type TErrorFunction = (err: Error, ctx: TContext) => any;
+type TSwaggerFormat = "string" | "number" | "integer" | "boolean" | "object" | "array" | "date" | "date-time" | "password" | "int32" | "int64" | "float" | "double" | "byte" | "binary" | "base64" | "email" | "uuid" | "uri" | "hostname" | "ipv4" | "ipv6" | "json" | "xml";
+type TSwaggerType = "string" | "number" | "integer" | "boolean" | "object" | "array" | "date" | "date-time" | "file";
+export type TSwaggerDoc = {
+    path?: `/${string}`;
+    staticUrl?: `${string}`;
+    servers?: {
+        url: string;
+        description?: string;
+    }[];
+    tags?: string[];
+    info?: {
+        title?: string;
+        description?: string;
+        version?: string;
+    };
+    routes: {
+        path: string;
+        method: string;
+        params: string[];
+    }[];
+    options: (TSwagger & {
+        path: string;
+        method: string;
+    })[];
+    responses?: {
+        status: number;
+        description: string;
+        example?: Record<string, any>;
+    }[];
+};
+export type TSwagger = {
+    staticUrl?: string;
+    description?: string;
+    bearerToken?: boolean;
+    tags?: string[];
+    query?: Record<string, {
+        required?: boolean;
+        description?: string;
+        type: TSwaggerType;
+        example?: any;
+    }>;
+    cookies?: {
+        names: string[];
+        required?: boolean;
+        description?: string;
+    };
+    body?: {
+        required?: boolean;
+        description?: string;
+        properties: Record<string, {
+            type: TSwaggerType;
+            example?: any;
+        }>;
+    };
+    files?: {
+        required?: boolean;
+        description?: string;
+        properties: Record<string, {
+            type: TSwaggerType;
+            format?: TSwaggerFormat;
+            items?: any;
+            example?: any;
+        }>;
+    };
+    responses?: {
+        status: number;
+        description: string;
+        example?: Record<string, any>;
+    }[];
+};
 export {};

package/build/lib/{types → core/types}/index.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/build/lib/core/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/core/types/index.ts"],"names":[],"mappings":""}

package/build/lib/index.d.ts

@@ -1,20 +1,11 @@
 /**
   * The entry point.
   *
-  * @module tspace-ez-node
+  * @module tspace-spear
   */
 export * from './core/decorators';
-export * from './types';
+export * from './core/types';
 export * from './core/server/router';
 export * from './core/server';
-import * as decorators from './core/decorators';
-import * as types from './types';
-import * as router from './core/server/router';
-import * as server from './core/server';
-declare const _default: {
-    decorators: typeof decorators;
-    types: typeof types;
-    router: typeof router;
-    server: typeof server;
-};
-export default _default;
+import Spear from './core/server';
+export default Spear;

package/build/lib/index.js

@@ -10,38 +10,22 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
   * The entry point.
   *
-  * @module tspace-ez-node
+  * @module tspace-spear
   */
 __exportStar(require("./core/decorators"), exports);
-__exportStar(require("./types"), exports);
+__exportStar(require("./core/types"), exports);
 __exportStar(require("./core/server/router"), exports);
 __exportStar(require("./core/server"), exports);
-const decorators = __importStar(require("./core/decorators"));
-const types = __importStar(require("./types"));
-const router = __importStar(require("./core/server/router"));
-const server = __importStar(require("./core/server"));
-exports.default = {
-    decorators,
-    types,
-    router,
-    server
-};
+const server_1 = __importDefault(require("./core/server"));
+exports.default = server_1.default;
+//# sourceMappingURL=index.js.map

package/build/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;;;;IAII;AACJ,oDAAiC;AACjC,+CAA4B;AAC5B,uDAAoC;AACpC,gDAA6B;AAE7B,2DAAkC;AAElC,kBAAe,gBAAK,CAAA"}

package/build/tests/benchmark.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/benchmark.test.js

@@ -0,0 +1,135 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const autocannon_1 = __importDefault(require("autocannon"));
+const fastify_1 = __importDefault(require("fastify"));
+const express_1 = __importDefault(require("express"));
+const http_1 = __importDefault(require("http"));
+const yargs_1 = __importDefault(require("yargs"));
+const lib_1 = __importDefault(require("../lib"));
+const MESSAGE = 'Hello world!';
+const { argv } = (0, yargs_1.default)(process.argv.slice(2));
+let duration = argv.d || argv.duration;
+let connections = argv.c || argv.connections;
+let pipelining = argv.p || argv.pipelining;
+connections = connections == null ? 100 : Number(connections);
+pipelining = pipelining == null ? 10 : Number(pipelining);
+duration = duration == null ? 10 : Number(duration);
+function runExpress() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const port = 3000;
+        (0, express_1.default)()
+            .get('/', (req, res) => {
+            res.setHeader('Content-Type', 'text/plain');
+            return res.send(MESSAGE);
+        })
+            .listen(port, () => {
+            console.log(`Server 'Express' running at http://localhost:${port}`);
+        });
+    });
+}
+function runFastify() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const port = 3001;
+        (0, fastify_1.default)()
+            .get('/', (request, reply) => {
+            return reply
+                .header('Content-Type', 'text/plain')
+                .send(MESSAGE);
+        })
+            .listen({ port }, (err, address) => {
+            if (err)
+                throw err;
+            console.log(`server 'Fastify' running at : http://localhost:${port}`);
+        });
+    });
+}
+function runHttp() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const port = 3002;
+        const server = http_1.default.createServer((req, res) => {
+            res.statusCode = 200;
+            res.setHeader('Content-Type', 'text/plain');
+            res.end(MESSAGE);
+        });
+        server.listen(port, () => {
+            console.log(`Server 'Http' running at http://localhost:${port}`);
+        });
+    });
+}
+function runSpear() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const port = 3100;
+        new lib_1.default()
+            .get('/', ({ res }) => {
+            return res.send(MESSAGE);
+        })
+            .listen(port, () => console.log(`server 'Spear' running at : http://localhost:${port}`));
+    });
+}
+const url = (port) => `http://localhost:${port}`;
+const urls = [
+    { name: 'express', url: url(3000) },
+    { name: 'fastify', url: url(3001) },
+    { name: 'http', url: url(3002) },
+    { name: 'tspace-spear', url: url(3100) }
+];
+const sleep = (ms) => {
+    return new Promise(resolve => setTimeout(resolve, ms));
+};
+const runBenchmark = () => __awaiter(void 0, void 0, void 0, function* () {
+    const results = [];
+    for (const { name, url } of urls) {
+        const result = yield new Promise((resolve, reject) => {
+            (0, autocannon_1.default)({
+                url,
+                connections,
+                duration,
+                pipelining
+            }, (err, result) => {
+                if (err)
+                    return reject(err);
+                return resolve(result);
+            });
+        });
+        results.push({
+            name,
+            url,
+            requests: result.requests.total,
+            average: result.latency.average
+        });
+    }
+    console.log({
+        connections,
+        duration,
+        pipelining
+    });
+    console.table(results);
+});
+function runApps() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield Promise.all([
+            runSpear,
+            runFastify,
+            runExpress,
+            runHttp
+        ].map(v => v()));
+        yield sleep(3000);
+        console.log('benchmarking !!');
+        yield runBenchmark();
+        console.log('benchmarking done !!');
+    });
+}
+runApps();
+//# sourceMappingURL=benchmark.test.js.map

package/build/tests/benchmark.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"benchmark.test.js","sourceRoot":"","sources":["../../src/tests/benchmark.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,4DAAgD;AAChD,sDAA6B;AAC7B,sDAAoD;AACpD,gDAAuB;AACvB,kDAA0B;AAC1B,iDAA0B;AAE1B,MAAM,OAAO,GAAG,cAAc,CAAA;AAE9B,MAAM,EAAE,IAAI,EAAE,GAAwB,IAAA,eAAK,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAClE,IAAI,QAAQ,GAAG,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAA;AACtC,IAAI,WAAW,GAAG,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,CAAA;AAC5C,IAAI,UAAU,GAAG,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAA;AAE1C,WAAW,GAAG,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;AAC7D,UAAU,GAAI,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;AAC1D,QAAQ,GAAM,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;AAEtD,SAAe,UAAU;;QAErB,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,IAAA,iBAAO,GAAE;aACR,GAAG,CAAC,GAAG,EAAE,CAAC,GAAY,EAAE,GAAa,EAAE,EAAE;YACtC,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAC5C,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC,CAAC;aACD,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;YACf,OAAO,CAAC,GAAG,CAAC,gDAAgD,IAAI,EAAE,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;IACP,CAAC;CAAA;AAED,SAAe,UAAU;;QACrB,MAAM,IAAI,GAAG,IAAI,CAAA;QAEjB,IAAA,iBAAO,GAAE;aACR,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YACzB,OAAO,KAAK;iBACX,MAAM,CAAC,cAAc,EAAE,YAAY,CAAC;iBACpC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnB,CAAC,CAAC;aACD,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;YAC/B,IAAI,GAAG;gBAAE,MAAM,GAAG,CAAA;YAClB,OAAO,CAAC,GAAG,CAAC,kDAAkD,IAAI,EAAE,CAAC,CAAA;QACzE,CAAC,CAAC,CAAA;IACN,CAAC;CAAA;AAED,SAAe,OAAO;;QAClB,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,MAAM,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC1C,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAC5C,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;YACrB,OAAO,CAAC,GAAG,CAAC,6CAA6C,IAAI,EAAE,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC;CAAA;AAED,SAAe,QAAQ;;QACnB,MAAM,IAAI,GAAG,IAAI,CAAA;QAEjB,IAAI,aAAK,EAAE;aACV,GAAG,CAAC,GAAG,EAAG,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;YACnB,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC5B,CAAC,CAAC;aACD,MAAM,CAAC,IAAI,EAAG,GAAG,EAAE,CAChB,OAAO,CAAC,GAAG,CAAC,gDAAgD,IAAI,EAAE,CAAC,CACtE,CAAA;IACL,CAAC;CAAA;AAED,MAAM,GAAG,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,oBAAoB,IAAI,EAAE,CAAA;AAEzD,MAAM,IAAI,GAAG;IACT,EAAE,IAAI,EAAE,SAAS,EAAO,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,EAAC;IACvC,EAAE,IAAI,EAAE,SAAS,EAAO,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,EAAC;IACvC,EAAE,IAAI,EAAE,MAAM,EAAU,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,EAAC;IACvC,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,EAAC;CAC1C,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,EAAW,EAAE,EAAE;IAC1B,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,GAAyB,EAAE;IAE5C,MAAM,OAAO,GAAW,EAAE,CAAC;IAE3B,KAAK,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,IAAI,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAa,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3D,IAAA,oBAAU,EAAC;gBACP,GAAG;gBACH,WAAW;gBACX,QAAQ;gBACR,UAAU;aACb,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;gBAEf,IAAI,GAAG;oBAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;gBAE5B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;YAE3B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAA;QAEF,OAAO,CAAC,IAAI,CAAC;YACT,IAAI;YACJ,GAAG;YACH,QAAQ,EAAG,MAAM,CAAC,QAAQ,CAAC,KAAK;YAChC,OAAO,EAAI,MAAM,CAAC,OAAO,CAAC,OAAO;SACpC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,CAAC,GAAG,CAAC;QACR,WAAW;QACX,QAAQ;QACR,UAAU;KACb,CAAC,CAAA;IAEF,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC3B,CAAC,CAAA,CAAA;AAED,SAAe,OAAO;;QAElB,MAAM,OAAO,CAAC,GAAG,CAAC;YACd,QAAQ;YACR,UAAU;YACV,UAAU;YACV,OAAO;SACV,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAEhB,MAAM,KAAK,CAAC,IAAI,CAAC,CAAA;QACjB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;QAC9B,MAAM,YAAY,EAAE,CAAA;QAEpB,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;IACvC,CAAC;CAAA;AAED,OAAO,EAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tspace-spear",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Build a REST API with high speed using a native HTTP server for Node.js.",
   "main": "./build/lib/index.js",
   "types": "./build/lib/index.d.ts",
@@ -13,15 +13,10 @@
   },
   "keywords": [
     "tspace",
-    "spear",
-    "fast",
-    "http",
-    "node",
-    "rest api",
-    "decorators",
-    "middlewares",
-    "controllers",
-    "routers"
+    "tspace-spear",
+    "web",
+    "framework",
+    "web framework"
   ],
   "author": "Thanathip (https://github.com/thanathip41)",
   "license": "MIT",
@@ -31,17 +26,31 @@
   "homepage": "https://github.com/thanathip41",
   "scripts": {
     "build": "tsc",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "test": "ts-node src/tests/benchmark.test.ts",
+    "test:build": "node build/tests/benchmark.test.js"
   },
   "devDependencies": {
+    "@types/autocannon": "^7.12.5",
+    "@types/express": "^4.17.21",
     "@types/formidable": "^3.4.5",
+    "@types/mime-types": "^2.1.4",
     "@types/node": "^16.4.0",
-    "@types/on-finished": "^2.3.4"
+    "@types/on-finished": "^2.3.4",
+    "@types/swagger-ui-dist": "^3.30.4",
+    "@types/yargs": "^17.0.32",
+    "autocannon": "^7.15.0",
+    "express": "^4.19.2",
+    "fastify": "^4.28.1",
+    "typescript": "^5.4.5",
+    "yargs": "^17.7.2"
   },
   "dependencies": {
     "find-my-way": "^8.1.0",
     "formidable": "^3.5.1",
+    "mime-types": "^2.1.35",
     "on-finished": "^2.4.1",
-    "reflect-metadata": "^0.1.14"
+    "reflect-metadata": "^0.1.14",
+    "swagger-ui-dist": "^5.17.10"
   }
 }