@breautek/storm 9.3.1 → 9.5.0

package/src/Handler.ts

@@ -138,8 +138,17 @@ export class Handler<
         response.error(error);
     }
 
-    public async get(request: Request<TGetRequest>, response: Response<TGetResponse>): Promise<void> {
+    protected _logRequestStart(request: Request<unknown>): void {
         this.getApplication().getLogger().info(TAG, `${request.getForwardedIP()} (${request.getIP()}) - ${request.getMethod()} ${request.getURL()} - UA(${request.getHeader('user-agent')})`);
+    }
+
+    protected _logRequestEnd(request: Request<unknown>, response: Response<any>, elapsed: number): void {
+        this.$app.getLogger().info(TAG, `API ${request.getURL()} (${response.getStatus()}) responded in ${elapsed}ms`);
+    }
+
+    public async get(request: Request<TGetRequest>, response: Response<TGetResponse>): Promise<void> {
+        let startTime: Date = new Date();
+        this._logRequestStart(request);
 
         try {
             let result: IRequestResponse<TGetRequest, TGetResponse> = await this.$executeMiddlewares(request, response);
@@ -149,10 +158,13 @@ export class Handler<
         catch (ex) {
             this.$handleResponseError(response as Response<StormError>, ex);
         }
+
+        this._logRequestEnd(request, response, new Date().getTime() - startTime.getTime());
     }
 
     public async put(request: Request<TPutRequest>, response: Response<TPutResponse>): Promise<void> {
-        this.getApplication().getLogger().info(TAG, `${request.getForwardedIP()} (${request.getIP()}) - ${request.getMethod()} ${request.getURL()} - UA(${request.getHeader('user-agent')})`);
+        let startTime: Date = new Date();
+        this._logRequestStart(request);
 
         try {
             let result: IRequestResponse<TPutRequest, TPutResponse> = await this.$executeMiddlewares(request, response);
@@ -162,10 +174,13 @@ export class Handler<
         catch (ex) {
             this.$handleResponseError(response as Response<StormError>, ex);
         }
+
+        this._logRequestEnd(request, response, new Date().getTime() - startTime.getTime());
     }
 
     public async post(request: Request<TPostRequest>, response: Response<TPostResponse>): Promise<void> {
-        this.getApplication().getLogger().info(TAG, `${request.getForwardedIP()} (${request.getIP()}) - ${request.getMethod()} ${request.getURL()} - UA(${request.getHeader('user-agent')})`);
+        let startTime: Date = new Date();
+        this._logRequestStart(request);
 
         try {
             let result: IRequestResponse<TPostRequest, TPostResponse> = await this.$executeMiddlewares(request, response);
@@ -175,10 +190,13 @@ export class Handler<
         catch (ex) {
             this.$handleResponseError(response as Response<StormError>, ex);
         }
+
+        this._logRequestEnd(request, response, new Date().getTime() - startTime.getTime());
     }
 
     public async delete(request: Request<TDeleteRequest>, response: Response<TDeleteResponse>): Promise<void> {
-        this.getApplication().getLogger().info(TAG, `${request.getForwardedIP()} (${request.getIP()}) - ${request.getMethod()} ${request.getURL()} - UA(${request.getHeader('user-agent')})`);
+        let startTime: Date = new Date();
+        this._logRequestStart(request);
 
         try {
             let result: IRequestResponse<TDeleteRequest, TDeleteResponse> = await this.$executeMiddlewares(request, response);
@@ -188,6 +206,8 @@ export class Handler<
         catch (ex) {
             this.$handleResponseError(response as Response<StormError>, ex);
         }
+
+        this._logRequestEnd(request, response, new Date().getTime() - startTime.getTime());
     }
 
     protected async _get(request: Request<TGetRequest>): Promise<TGetResponse | ResponseData<TGetResponse>> {

package/src/Request.ts

@@ -34,8 +34,12 @@ import { InternalError } from './InternalError';
 import IncomingForm = require('formidable/Formidable');
 import { IDatabasePosition } from './IDatabasePosition';
 
+export interface IQueryParams {
+    [key: string]: undefined | string | IQueryParams | (string | IQueryParams)[];
+}
+
 export interface IParameterMap {
-    [key: string]: string;
+    [key: string]: string | string[];
 }
 
 export class Request<TBody = any, TAuthToken extends IAuthTokenData = IAuthTokenData> {
@@ -83,7 +87,7 @@ export class Request<TBody = any, TAuthToken extends IAuthTokenData = IAuthToken
         }
     }
 
-    public getQueryVariables(): any {
+    public getQueryVariables(): IQueryParams {
         return this.$request.query;
     }
 
@@ -91,10 +95,41 @@ export class Request<TBody = any, TAuthToken extends IAuthTokenData = IAuthToken
         return this.$request.params;
     }
 
-    public getParam(name: string): string {
+    public getParam(name: string): string | string[] {
         return this.$request.params[name];
     }
 
+    /**
+     * Gets a URL parameter as string. If the value is multiple
+     * then only the first value is returned.
+     * This is a convenience method over `getParam` which returns a union.
+     */
+    public getURLSingleParam(name: string): string {
+        let v: string | string[] = this.getParam(name);
+
+        if (typeof v === 'string') {
+            return v;
+        }
+        else {
+            return v[0];
+        }
+    }
+
+    /**
+     * Gets a URL parameter as string[].
+     * This is a convenience method over `getParam` which returns a union.
+     */
+    public getURLMultiParam(name: string): string[] {
+        let v: string | string[] = this.getParam(name);
+
+        if (typeof v === 'string') {
+            return [v];
+        }
+        else {
+            return v;
+        }
+    }
+
     public getIP(): string {
         return this.$request.ip;
     }

package/src/TokenManager.ts

@@ -78,6 +78,22 @@ export class TokenManager<TAuthToken extends IAuthTokenData = IAuthTokenData> {
         });
     }
 
+    /**
+     * Decodes the token. Use this method only on verified tokens as this does not verify against tampering
+     * 
+     * @param token 
+     * @returns 
+     */
+    public decodeSync(token: Token): TAuthToken {
+        return jwt.decode(token.getSignature()) as TAuthToken;
+    }
+
+    /**
+     * Decodes the token. Use this method only on verified tokens as this does not verify against tampering
+     *
+     * @param token 
+     * @returns 
+     */
     public decode(token: Token): Promise<TAuthToken> {
         return new Promise<any>((resolve, reject) => {
             try {