eh-commons 0.0.1-testing.21 → 0.0.1-testing.23

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eh-commons",
   "type": "commonjs",
-  "version": "0.0.1-testing.21",
+  "version": "0.0.1-testing.23",
   "description": "eh-commons",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -10,9 +10,11 @@ import { StateParamDTO } from './models/dtos/state-params.dto';
 import { RecordState } from './models/enums/record-state.enum';
 import { IRecord } from './models/interfaces/record.interface';
 import {
+  IMongoPage,
   RESTError,
   RESTPage,
   RESTPaging,
+  RESTQueryParams,
   RESTRequestBody,
   RESTResponseBody,
   RESTResult,
@@ -265,4 +267,6 @@ export {
   Dictionary,
   DictionarySchema,
   DictionaryDocument,
+  RESTQueryParams,
+  IMongoPage,
 };

package/src/models/wrappers/rest-wrapper.class.ts

@@ -1,6 +1,6 @@
 import { HttpStatus } from '@nestjs/common';
 import { Type } from 'class-transformer';
-import { IsArray, IsEnum, IsNotEmpty, IsNumber, IsOptional, IsString, ValidateNested } from 'class-validator';
+import { IsArray, IsEnum, IsInt, IsNotEmpty, IsNumber, IsOptional, IsString, Max, Min, ValidateNested } from 'class-validator';
 
 export enum SortDirection {
   asc = 1,
@@ -18,19 +18,34 @@ export class RESTSort {
   direction: SortDirection;
 }
 
+export interface IMongoPage {
+  skip: number;
+  limit: number;
+}
+
 export class RESTPaging {
   @IsNotEmpty()
-  @IsNumber()
+  @IsInt()
+  @Type(() => Number)
+  @Min(1)
   page: number;
 
   @IsNotEmpty()
-  @IsNumber()
+  @IsInt()
+  @Type(() => Number)
+  @Min(1)
+  @Max(100)
   size: number;
 
   public extract() {
     const skip = (this.page - 1) * this.size;
     return { skip, limit: this.size };
   }
+
+  public static generate(page: number, size: number): IMongoPage {
+    const skip = (page - 1) * size;
+    return { skip, limit: size };
+  }
 }
 
 export abstract class RESTRequestBody {
@@ -121,11 +136,15 @@ export class RESTError {
   validation?: any;
   statusCode?: HttpStatus;
 
-  constructor(keyword: string, debug?: any) {
+  constructor(keyword: string, debug?: any, statusCode?: HttpStatus) {
     this.keyword = keyword;
     this.debug = debug;
+    this.statusCode = statusCode;
   }
 
+  /**
+   * @deprecated The method should not be used.. use new RESTError('error_keyword', 'debug message', HttpStatus.BAD_REQUEST);
+   */
   public static throw(keyword: string, statusCode?: HttpStatus, debug?: any) {
     const error = new RESTError(keyword, debug);
     error.statusCode = statusCode || HttpStatus.BAD_REQUEST;
@@ -133,7 +152,7 @@ export class RESTError {
   }
 
   public static dataValidation(validation: any) {
-    const error = new RESTError('body_validation_error', null);
+    const error = new RESTError('body_validation_error', null, 422);
     error.validation = validation;
     return error;
   }
@@ -170,3 +189,49 @@ export class RESTResponseBody<T> {
     return response;
   }
 }
+
+export class RESTQueryParams extends RESTPaging {
+
+  @IsOptional()
+  @IsString({ each: true })
+  sort: string[];
+
+  public getRESTSort(): RESTSort[] {
+    const result = [];
+    const items = [];
+    if (this.sort) {
+      if (this.sort instanceof Array) {
+        items.push(...this.sort);
+      } else {
+        items.push(this.sort);
+      }
+    }
+
+    for (let item of items) {
+      const pair = item.split(':');
+      if (pair.length != 2) {
+        throw new RESTError('invalid_sorting_pair', pair, 422);
+      }
+
+      if (['asc', 'desc'].indexOf(pair[1]) === -1) {
+        throw new RESTError('invalid_sorting_direction', pair[1], 422);
+      }
+
+      result.push({
+        property: pair[0],
+        direction: pair[1] === 'asc' ? 1 : -1,
+      });
+    }
+
+    return result;
+  }
+
+  public extractSort() {
+    const sorts = this.getRESTSort();
+    const result = {};
+    for (let item of sorts) {
+      result[item.property] = item.direction;
+    }
+    return result;
+  }
+}