tspace-spear 1.0.0-rc → 1.0.0

package/README.md

@@ -23,16 +23,20 @@ npm install tspace-spear --save
 
 ## StartServer
 ```js
-import Spear from "tspace-spear";
+import { Application } from "tspace-spear";
 
-new Spear()
-.get('/' , () => 'Hello world!')
-.get('/json' , () => {
-  return {
-    message : 'Hello world!'
-  }
-})
-.listen(3000 , ({ server, port }) => console.log(`server listening on : http://localhost:${port}`))
+(async () => {
+    await new Application()
+    .get('/' , () => 'Hello world!')
+    .get('/json' , () => {
+      return {
+        message : 'Hello world!'
+      }
+    })
+    .listen(3000 , () => console.log('server listening on port : 3000'))
+})()
+
+// localhost:3000
 
 ```
 
@@ -44,12 +48,12 @@ export default (ctx : TContext, next: TNextFunction) =>{
   return next();
 }
 
-import  Spear { Router, TContext, TNextFunction } from "tspace-spear";
+import { Application , Router, TContext, TNextFunction } from "tspace-spear";
 import CatMiddleware from './cat-middleware.ts'
 
 (async () => {
   const port = Number(process.env.PORT ?? 3000)
-  const app = new Spear({
+  const app = new Application({
     middlewares: [ CatMiddleware ]
     // if you want to import a middleware with a directory can you follow the example
     // middlewares : {
@@ -165,12 +169,12 @@ class CatController {
   }
 }
 
-import Spear , { Router, TContext, TNextFunction } from "tspace-spear";
+import { Application , Router, TContext, TNextFunction } from "tspace-spear";
 import CatController from './cat-controller.ts'
 
 (async () => {
 
-  const app = new Spear({
+  const app = new Application({
     controllers: [ CatController ]
     // if you want to import a controller with a directory can you follow the example
     // controllers : {
@@ -198,9 +202,9 @@ import CatController from './cat-controller.ts'
 ## Router
 
 ```js
-import Spear , { Router, TContext, TNextFunction } from "tspace-spear";
+import { Application , Router, TContext, TNextFunction } from "tspace-spear";
 
-const app = new Spear()
+const app = new Application()
 
 const router = new Router()
     
@@ -242,32 +246,11 @@ app.listen(port , () => console.log(`Server is now listening port: ${port}`))
 ## Handlers
 ```js
 
-const app = new Spear({
+const app = new Application({
   logger : true, // logging
-  globalPrefix : '/api' // prefix all routes
+  globalPrefix : '/api' // prefix all routes in Router and Controller only!
 })
 
-app.enableCors({
-    origins: [
-      /^http:\/\/localhost:\d+$/
-    ],
-    credentials: true
-})
-
-app.useFileUpload({
-    limits : 1000 * 1000, // limits for file upload 1_000_000 bytes
-    useTempFiles : true, // whether to use temporary files
-    tempFileDir : 'tmp', // temporary directory
-    removeTempFile : {
-      remove : true, // remove temporary files
-      ms : 1000 * 60 // remove temporary after 60 seconds
-    }
-  })
-
-app.useBodyParser()
-
-app.useCookiesParser()
-
 app.get('/' , ({ res } : TContext) => {
   return res.json({
     message : 'hello world!'

package/build/lib/core/server/index.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="node" />
-import { Server, ServerResponse } from 'http';
-import { Router, TContext, TNextFunction, TApplication } from '../..';
+import { ServerResponse } from 'http';
+import { Router } from '../..';
+import type { TContext, TNextFunction, TApplication } from "../..";
 /**
  *
- * The 'Spear' class is used to create a server and handle HTTP requests.
+ * The 'Application' class is used to create a server and handle HTTP requests.
  *
- * @returns {Spear} application
+ * @returns {Application} application
  * @example
  * new Application()
  *  .get('/' , () => 'Hello world!')
@@ -17,7 +17,7 @@ import { Router, TContext, TNextFunction, TApplication } from '../..';
  *  .listen(3000 , () => console.log('server listening on port : 3000'))
  *
  */
-declare class Spear {
+declare class Application {
     private readonly _controllers?;
     private readonly _middlewares?;
     private readonly _globalPrefix;
@@ -178,10 +178,7 @@ declare class Spear {
      * @param {function} cb
      * @returns
      */
-    listen(port: number | (() => ServerResponse) | undefined, cb: (callback: {
-        server: Server;
-        port: number;
-    }) => void): Promise<void>;
+    listen(port: number | (() => ServerResponse) | undefined, cb: () => void): Promise<void>;
     private _logger;
     private _import;
     private _registerControllers;
@@ -194,9 +191,6 @@ declare class Spear {
     private _wrapHandlers;
     private _wrapResponse;
     private _createServer;
-    private _normalizePath;
 }
-export { Spear };
-export declare class Application extends Spear {
-}
-export default Spear;
+export { Application };
+export default Application;

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

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = exports.Spear = void 0;
+exports.Application = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const find_my_way_1 = __importDefault(require("find-my-way"));
@@ -46,9 +46,9 @@ const string_decoder_1 = require("string_decoder");
 const http_1 = __importStar(require("http"));
 /**
  *
- * The 'Spear' class is used to create a server and handle HTTP requests.
+ * The 'Application' class is used to create a server and handle HTTP requests.
  *
- * @returns {Spear} application
+ * @returns {Application} application
  * @example
  * new Application()
  *  .get('/' , () => 'Hello world!')
@@ -60,7 +60,7 @@ const http_1 = __importStar(require("http"));
  *  .listen(3000 , () => console.log('server listening on port : 3000'))
  *
  */
-class Spear {
+class Application {
     constructor({ controllers, middlewares, globalPrefix, logger } = {}) {
         this._router = (0, find_my_way_1.default)();
         this._errorHandler = null;
@@ -264,7 +264,14 @@ class Spear {
     useRouter(router) {
         const routes = router.routes;
         for (const { path, method, handlers } of routes) {
-            this[method](this._normalizePath(this._globalPrefix, path), ...handlers);
+            let normalizePath = [
+                this._globalPrefix,
+                path
+            ].join('/')
+                .replace(/\/+/g, '/')
+                .replace(/\/+$/, '');
+            normalizePath = normalizePath.startsWith('/') ? normalizePath : `/${normalizePath}`;
+            this[method](normalizePath, ...handlers);
         }
         return this;
     }
@@ -399,7 +406,7 @@ class Spear {
      */
     get(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.get(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.get(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -414,7 +421,7 @@ class Spear {
      */
     post(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.post(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.post(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -429,7 +436,7 @@ class Spear {
      */
     put(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.put(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.put(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -444,7 +451,7 @@ class Spear {
      */
     patch(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.patch(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.patch(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -459,7 +466,7 @@ class Spear {
      */
     delete(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.delete(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.delete(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -474,7 +481,7 @@ class Spear {
      */
     all(path, ...handlers) {
         this._onListeners.push(() => {
-            return this._router.all(this._normalizePath(this._globalPrefix, path), this._wrapHandlers(...this._globalMiddlewares, ...handlers));
+            return this._router.all(path, this._wrapHandlers(...this._globalMiddlewares, ...handlers));
         });
         return this;
     }
@@ -492,10 +499,6 @@ class Spear {
                 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());
             });
@@ -503,6 +506,10 @@ class Spear {
                 port = Math.floor(Math.random() * 8999) + 1000;
                 server.listen(port);
             });
+            server.listen(port == null ? 3000 : port, () => {
+                if (cb)
+                    cb();
+            });
             return;
         });
     }
@@ -566,7 +573,15 @@ class Spear {
                     if (prefixPath == null)
                         continue;
                     for (const { method, path, handler } of routers) {
-                        this[method](this._normalizePath(this._globalPrefix, prefixPath, path), this._wrapResponse(controllerInstance[String(handler)].bind(controllerInstance)));
+                        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)));
                     }
                 }
                 return;
@@ -578,7 +593,15 @@ class Spear {
                 if (prefixPath == null)
                     continue;
                 for (const { method, path, handler } of routers) {
-                    this[method](this._normalizePath(this._globalPrefix, prefixPath, path), this._wrapResponse(controllerInstance[String(handler)].bind(controllerInstance)));
+                    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)));
                 }
             }
         });
@@ -853,16 +876,6 @@ class Spear {
             return server;
         });
     }
-    _normalizePath(...paths) {
-        let path = paths
-            .join('/')
-            .replace(/\/+/g, '/')
-            .replace(/\/+$/, '');
-        return path.startsWith('/') ? path : `/${path}`;
-    }
-}
-exports.Spear = Spear;
-class Application extends Spear {
 }
 exports.Application = Application;
-exports.default = Spear;
+exports.default = Application;

package/build/lib/index.d.ts

@@ -7,5 +7,14 @@ export * from './core/decorators';
 export * from './types';
 export * from './core/server/router';
 export * from './core/server';
-import Spear from './core/server';
-export default Spear;
+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;

package/build/lib/index.js

@@ -10,11 +10,20 @@ 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 __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
@@ -26,5 +35,13 @@ __exportStar(require("./core/decorators"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./core/server/router"), exports);
 __exportStar(require("./core/server"), exports);
-const server_1 = __importDefault(require("./core/server"));
-exports.default = server_1.default;
+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
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tspace-spear",
-  "version": "1.0.0-rc",
+  "version": "1.0.0",
   "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",