tspace-spear 1.0.0 → 1.0.2

package/build/lib/core/decorators/middleware.js

@@ -21,3 +21,4 @@ const Middleware = (middleware) => {
     };
 };
 exports.Middleware = Middleware;
+//# sourceMappingURL=middleware.js.map

package/build/lib/core/decorators/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/middleware.ts"],"names":[],"mappings":";;;AAEO,MAAM,UAAU,GAAG,CAAC,UAA6B,EAAE,EAAE;IAE1D,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAClE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,UAAU,CAAC,KAAK,GAAG,UAAS,GAAc,EAAG,IAAoB;YAC/D,IAAI,CAAC;gBAEH,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,UAAU,EAAG,MAAM,CAAC,CAAA;gBAE1D,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,GAAU,EAAE,EAAE;oBACpC,IAAG,GAAG,IAAI,IAAI,EAAE,CAAC;wBACf,OAAO,IAAI,CAAC,GAAG,CAAC,CAAA;oBAClB,CAAC;oBACD,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;gBAC/C,CAAC,CAAC,CAAA;YAEJ,CAAC;YAAC,OAAO,KAAW,EAAE,CAAC;gBAErB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;YACpB,CAAC;QACH,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAA;AAtBY,QAAA,UAAU,cAsBtB"}

package/build/lib/core/decorators/statusCode.js

@@ -24,3 +24,4 @@ const StatusCode = (statusCode) => {
     };
 };
 exports.StatusCode = StatusCode;
+//# sourceMappingURL=statusCode.js.map

package/build/lib/core/decorators/statusCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"statusCode.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/statusCode.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEO,MAAO,UAAU,GAAG,CAAC,UAAmB,EAAE,EAAE;IAC/C,OAAO,CAAC,MAAW,EAAE,GAAW,EAAE,UAA8B,EAAE,EAAE;QAChE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,GAAG,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC;QAE1E,UAAU,CAAC,KAAK,GAAG,UAAe,GAAc,EAAG,IAAmB;;gBAClE,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,EAAG,EAAE,cAAc,EAAE,kBAAkB,EAAC,CAAC,CAAA;gBACrE,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAG,IAAI,CAAC,CAAC;YACvD,CAAC;SAAA,CAAC;QAEF,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAA;AAba,QAAA,UAAU,cAavB"}

package/build/lib/core/decorators/swagger.d.ts

@@ -0,0 +1,2 @@
+import { TSwagger } from "../types";
+export declare const Swagger: (data: TSwagger) => (target: any, propertyKey: any) => void;

package/build/lib/core/decorators/swagger.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Swagger = void 0;
+const Swagger = (data) => {
+    return (target, propertyKey) => {
+        const controller = target.constructor;
+        const swaggers = Reflect.hasMetadata("swaggers", controller)
+            ? Reflect.getMetadata("swaggers", controller)
+            : [];
+        swaggers.push(Object.assign({ handler: propertyKey }, data));
+        Reflect.defineMetadata("swaggers", swaggers, controller);
+    };
+};
+exports.Swagger = Swagger;
+//# sourceMappingURL=swagger.js.map

package/build/lib/core/decorators/swagger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.js","sourceRoot":"","sources":["../../../../src/lib/core/decorators/swagger.ts"],"names":[],"mappings":";;;AAEO,MAAM,OAAO,GAAG,CAAC,IAAe,EAAE,EAAE;IACvC,OAAO,CAAC,MAAW,EAAE,WAAgB,EAAE,EAAE;QACrC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC;QAEtC,MAAM,QAAQ,GAAU,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC;YACnE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,CAAC;YAC7C,CAAC,CAAC,EAAE,CAAC;QAEL,QAAQ,CAAC,IAAI,iBACT,OAAO,EAAE,WAAW,IACjB,IAAI,EACT,CAAC;QAEH,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC3D,CAAC,CAAA;AACL,CAAC,CAAA;AAfU,QAAA,OAAO,WAejB"}

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

@@ -1,13 +1,14 @@
-import { ServerResponse } from 'http';
-import { Router } from '../..';
-import type { TContext, TNextFunction, TApplication } from "../..";
+import { Server, ServerResponse } from 'http';
+import findMyWayRouter from 'find-my-way';
+import { Router } from './router';
+import type { TContext, TNextFunction, TApplication } from '../types';
 /**
  *
- * 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()
+ * new Spear()
  *  .get('/' , () => 'Hello world!')
  *  .get('/json' , () => {
  *     return {
@@ -17,29 +18,23 @@ import type { TContext, TNextFunction, TApplication } from "../..";
  *  .listen(3000 , () => console.log('server listening on port : 3000'))
  *
  */
-declare class Application {
+declare class Spear {
     private readonly _controllers?;
     private readonly _middlewares?;
     private readonly _globalPrefix;
+    private readonly _cluster?;
     private readonly _router;
+    private readonly _parser;
+    private _swagger;
+    private _swaggerAdditional;
     private _errorHandler;
     private _globalMiddlewares;
     private _formatResponse;
     private _onListeners;
     private _fileUploadOptions;
-    constructor({ controllers, middlewares, globalPrefix, logger }?: TApplication);
-    /**
-     * 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 }?: {
-        origins?: (string | RegExp)[];
-        credentials?: boolean;
-    }): this;
+    constructor({ controllers, middlewares, globalPrefix, logger, cluster }?: TApplication);
+    get instance(): this;
+    get routers(): findMyWayRouter.Instance<findMyWayRouter.HTTPVersion.V1>;
     /**
      * The 'use' method is used to add the middleware into the request pipeline.
      *
@@ -50,13 +45,17 @@ declare class Application {
      */
     use(middleware: (ctx: TContext, next: TNextFunction) => void): this;
     /**
-     * The 'useRouter' method is used to add the router in the request context.
+     * The 'useLogger' method is used to add the middleware view logger response.
      *
-     * @parms {Function} router
-     * @property  {Function} router - get() , post() , put() , patch() , delete()
+     * @callback {Function} middleware
+     * @property  {Object} ctx - context { req , res , query , params , cookies , files , body}
+     * @property  {Function} next  - go to next function
      * @returns {this}
      */
-    useRouter(router: Router): this;
+    useLogger({ methods, exceptPath }?: {
+        methods?: ('GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE')[];
+        exceptPath?: string[] | RegExp;
+    }): this;
     /**
      * The 'useBodyParser' method is a middleware used to parse the request body of incoming HTTP requests.
      *
@@ -69,27 +68,79 @@ declare class Application {
      * @returns {this}
      */
     useCookiesParser(): 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: Router): 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 }?: {
-        limits?: number;
-        useTempFiles?: boolean;
+    useFileUpload({ limit, tempFileDir, removeTempFile }?: {
+        limit?: number;
         tempFileDir?: string;
         removeTempFile?: {
             remove: boolean;
             ms: number;
         };
     }): 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 }?: {
+        path?: `/${string}`;
+        servers?: {
+            url: string;
+            description?: string;
+        }[];
+        tags?: string[];
+        info?: {
+            title?: string;
+            description?: string;
+            version?: string;
+        };
+    }): this;
+    /**
+     * The 'listen' method is used to bind and start a server to a particular port and optionally a hostname.
+     *
+     * @param {number} port
+     * @param {function} callback
+     * @returns
+     */
+    listen(port: (number | (() => ServerResponse)) | undefined, callback: (callback: {
+        server: Server;
+        port: number;
+    }) => void): Promise<void>;
+    /**
+     * 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 }?: {
+        origins?: (string | RegExp)[];
+        credentials?: boolean;
+    }): this;
     /**
      * The 'formatResponse' method is used to format the response
      *
@@ -98,7 +149,9 @@ declare class Application {
      */
     formatResponse(format: (r: unknown, statusCode: number) => any): this;
     /**
-     * The 'errorHandler' method is middleware that is specifically designed to handle errors that occur during the processing of requests
+     * The 'errorHandler' method is middleware that is specifically designed to handle errors.
+     *
+     * that occur during the processing of requests
      *
      * @param {function} error
      * @returns
@@ -162,7 +215,7 @@ declare class Application {
      */
     delete(path: string, ...handlers: ((ctx: TContext, next: TNextFunction) => any)[]): this;
     /**
-     * The 'all' method is used to add the request handler to the router for the 'all' method.
+     * The 'all' method is used to add the request handler to the router for 'GET' 'POST' 'PUT' 'PATCH' 'DELETE' methods.
      *
      * @param {string} path
      * @callback {...Function[]} handlers of the middlewares
@@ -171,26 +224,19 @@ declare class Application {
      * @returns {this}
      */
     all(path: string, ...handlers: ((ctx: TContext, next: TNextFunction) => any)[]): this;
-    /**
-     * The 'listen' method is used to bind and start a server to a particular port and optionally a hostname.
-     *
-     * @param {number} port
-     * @param {function} cb
-     * @returns
-     */
-    listen(port: number | (() => ServerResponse) | undefined, cb: () => void): Promise<void>;
-    private _logger;
+    private _clusterMode;
     private _import;
     private _registerControllers;
     private _registerMiddlewares;
-    private _filesParser;
-    private _bodyParser;
-    private _cookiesParser;
     private _customizeResponse;
     private _nextFunction;
     private _wrapHandlers;
     private _wrapResponse;
     private _createServer;
+    private _normalizePath;
+    private _swaggerHandler;
+}
+export declare class Application extends Spear {
 }
-export { Application };
-export default Application;
+export { Spear };
+export default Spear;