@heliosjs/middlewares 1.0.2 → 1.3.0

package/README.md

@@ -45,8 +45,8 @@ import {
   Response,
   Status,
   ANY,
-  Request,
-  Response
+  IRequest,
+  IResponse
 } from 'quantum-flow/core';
 import {IsString} from  'class-validator'
 import { Catch, Cors, Sanitize, Use, SANITIZER } from 'quantum-flow/middlewares';
@@ -83,8 +83,8 @@ export class User {
     @Query() query: Record<string, string | string[]>,
     @Headers() headers: Record<string, string | string[]>,
     @Params(ParamDTO, 'param') params: string,
-    @Req() req: Response,
-    @Response() resp: Request,
+    @Request() req: IResponse,
+    @Response() resp: IRequest,
     @InjectWS() ws: IWebSocketService,
   ) {}
 
@@ -138,7 +138,7 @@ server.listen().catch(console.error);
 - Use `@Params` to access route parameters.
 - Use `@Files` to access files sent within multipart/form-data requests.
   Text sent as multipart/form-data is exposed with `@Body` decorators
-- Use `@Req` to access the original request object.
+- Use `@Request` to access the original request object.
 - Use `@Response` to access the original object.
 - Use `@InjectWS` to access the websocket service.
 - Use `@InjectSSE` to access the server-side-event service.
@@ -150,7 +150,7 @@ Use `LambdaAdapter` to convert API Gateway events to requests and responses. Cre
 ```typescript
 Example Lambda handler creation
 import { LambdaAdapter, LambdaRequest, LambdaResponse } from 'quantum-flow/aws';
-import { Request, Query, Headers, Params, Response, Response, Request } from  'quantum-flow/core'
+import { Request, Query, Headers, Params, Response, IResponse, IRequest } from  'quantum-flow/core'
 
 @Controller({ prefix: 'user' })
 class UserController {
@@ -158,16 +158,16 @@ class UserController {
     @Query() query: Record<string, string | string[]>,
     @Headers() headers: Record<string, string | string[]>,
     @Params(ParamDTO, 'param') params: string,
-    @Req() req: Request,
-    @Response() res: Response
+    @Request() req: IRequest,
+    @Response() res: IResponse
   ) { }
 }
 const lambdaAdapter = new LambdaAdapter(UserController);
 export const handler = lambdaAdapter.handler;
 ```
 
-You can access context and event throught @Req() decorator:
-@Req() request: LambdaRequest
+You can access context and event throught @Request() decorator:
+@Request() request: LambdaRequest
 request.context
 request.event
 
@@ -310,19 +310,19 @@ import { OnSSEConnection, OnSSEError, OnSSEClose } from 'quantum-flow/sse';
 @Controller('user')
 export class User {
   @OnSSEConnection()
-  async onsseconnection(@Req() req, @Response() res) {
+  async onsseconnection(@Request() req, @Response() res) {
     console.log('SSE connection established');
     return req.body;
   }
 
   @OnSSEError()
-  async onsseerror(@Req() req, @Response() res) {
+  async onsseerror(@Request() req, @Response() res) {
     console.log('SSE error occurred');
     return req.body;
   }
 
   @OnSSEClose()
-  async onsseclose(@Req() req, @Response() res) {
+  async onsseclose(@Request() req, @Response() res) {
     console.log('SSE connection closed');
     return req.body;
   }

package/dist/types/core/common.d.ts

@@ -1,8 +1,8 @@
 import { ServerResponse } from 'http';
 import { AppError } from './error';
-import { Request } from './request';
-import { Response } from './response';
-export type Router = (req: Request, res?: ServerResponse) => Promise<{
+import { IRequest } from './request';
+import { IResponse } from './response';
+export type Router = (req: IRequest, res?: ServerResponse) => Promise<{
     status: number;
     data: any;
     message?: string;
@@ -10,9 +10,9 @@ export type Router = (req: Request, res?: ServerResponse) => Promise<{
 export interface IController {
     handleRequest: Router;
 }
-export type MiddlewareCB = (request: Request, response: Response, next: (args?: any) => any) => void | Promise<Request> | Request | Promise<void> | void;
-export type InterceptorCB = (data: any, req?: Request, res?: Response) => Promise<unknown> | unknown;
-export type ErrorCB = (error: AppError, req?: Request, res?: Response) => any;
+export type MiddlewareCB = (request: IRequest, response: IResponse, next: (args?: any) => any) => void | Promise<IRequest> | IRequest | Promise<void> | void;
+export type InterceptorCB = (data: any, req?: IRequest, res?: IResponse) => Promise<unknown> | unknown;
+export type ErrorCB = (error: AppError, req?: IRequest, res?: IResponse) => any;
 export type ParamDecoratorType = 'body' | 'params' | 'query' | 'request' | 'headers' | 'cookies' | 'response' | 'multipart' | 'event' | 'context' | 'sse' | 'ws';
 export interface ParamMetadata {
     index: number;

package/dist/types/core/controller.d.ts

@@ -1,7 +1,7 @@
 import { ServerResponse } from 'http';
 import { ErrorCB, HTTP_METHODS, InterceptorCB, MiddlewareCB } from './common';
 import { CORSConfig } from './cors';
-import { Request } from './request';
+import { IRequest } from './request';
 import { SanitizerConfig } from './sanitize';
 export type ControllerClass = {
     new (...args: any[]): any;
@@ -13,7 +13,7 @@ export type ControllerMethods = Array<{
     middlewares?: MiddlewareCB[];
 }>;
 export type ControllerType = {
-    handleRequest?(request: Request, response: ServerResponse): Promise<any>;
+    handleRequest?(request: IRequest, response: ServerResponse): Promise<any>;
     ws?: WsControllerHandlers;
     sse?: SeeControllerHandlers;
     new (...args: any[]): any;

package/dist/types/core/error.d.ts

@@ -1,5 +1,5 @@
-import { Request } from './request';
-import { Response } from './response';
+import { IRequest } from './request';
+import { IResponse } from './response';
 export declare enum ErrorCode {
     BAD_REQUEST = "BAD_REQUEST",
     UNAUTHORIZED = "UNAUTHORIZED",
@@ -69,4 +69,4 @@ export interface ErrorHandlerConfig {
     logStack?: boolean;
     customHandlers?: Record<ErrorCode, (error: AppError) => any>;
 }
-export type ErorrHandler = (error: Error, req: Request, response: Response) => any;
+export type ErorrHandler = (error: Error, req: IRequest, response: IResponse) => any;

package/dist/types/core/request.d.ts

@@ -23,7 +23,7 @@ export interface RequestOptions {
     isBase64Encoded?: boolean;
     source: RequestSource;
 }
-export interface Request {
+export interface IRequest {
     method: string;
     path: string;
     url: string;
@@ -60,6 +60,6 @@ export interface Request {
     getClientIp(): string;
     getHost(): string;
     getFullUrl(): string;
-    clone(overrides?: Partial<RequestOptions>): Request;
+    clone(overrides?: Partial<RequestOptions>): IRequest;
     toJSON(): Record<string, any>;
 }

package/dist/types/core/response.d.ts

@@ -18,7 +18,7 @@ export interface ResponseOptions {
     isBase64Encoded?: boolean;
     encoding?: BufferEncoding;
 }
-export interface Response {
+export interface IResponse {
     headers: Record<string, string | string[]>;
     data: any;
     cookies: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heliosjs/middlewares",
-  "version": "1.0.2",
+  "version": "1.3.0",
   "description": "Core functionality for Quantum Flow",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,13 +13,13 @@
     "README.md"
   ],
   "scripts": {
-    "build": "yarn clean && tsc -p tsconfig.build.json",
+    "build": "yarn clean && tsc -p tsconfig.build.json && resolve-tspaths",
     "clean": "rm -rf dist",
     "prepublishOnly": "yarn build",
-    "publish:public": "yarn publish --access public --no-git-tag-version",
-    "publish:patch": "yarn version --patch --no-git-tag-version && yarn publish --access public",
-    "publish:minor": "yarn version --minor --no-git-tag-version && yarn publish --access public",
-    "publish:major": "yarn version --major --no-git-tag-version && yarn publish --access public"
+    "publish:public": "yarn publish --access public",
+    "publish:patch": "yarn version --patch && yarn build && npm pack && npm publish *.tgz --access public && rm *.tgz",
+    "publish:minor": "yarn version --minor && yarn publish --access public",
+    "publish:major": "yarn version --major && yarn publish --access public"
   },
   "dependencies": {
     "reflect-metadata": "^0.2.2"