my-q-format-response-aws-lambda 1.0.1

package/README.md

@@ -0,0 +1 @@
+my-q-format-response-aws-lambda

package/index.js

@@ -0,0 +1,322 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.controlResponseNull = exports.normaliseMongoPaginate = exports.normaliseMongoFilter = exports.optionsPaginationParams = exports.messagesREST = exports.CreateResponse = exports.ResponseVO = exports.ResponseBodyVO = exports.StatusCode = exports.StatusResult = void 0;
+class StatusResult {
+}
+exports.StatusResult = StatusResult;
+StatusResult.ok = 'Ok';
+StatusResult.error = 'Error';
+StatusResult.notFound = 'NotFound';
+class StatusCode {
+}
+exports.StatusCode = StatusCode;
+// static SwitchingProtocols = 101;
+// static Continue = 100;
+// static Processing = 102;
+StatusCode.OK = 200;
+StatusCode.Created = 201;
+StatusCode.Accepted = 202;
+StatusCode.NonAuthoritativeInformation = 203;
+StatusCode.NoContent = 204;
+// static ResetContent = 205;
+// static PartialContent = 206;
+// static MultiStatus = 207;
+// static MultipleChoices = 300;
+// static MovedPermanently = 301;
+// static MovedTemporarily = 302;
+// static SeeOther = 303;
+// static UseProxy = 305;
+// static NotModified = 304;
+// static TemporaryRedirect = 307;
+StatusCode.BadRequest = 400;
+StatusCode.Unauthorized = 401;
+StatusCode.PaymentRequired = 402;
+StatusCode.NotFound = 404;
+StatusCode.Forbidden = 403;
+// static MethodNotAllowed = 405;
+// static ProxyAuthenticationRequired = 407;
+// static NotAcceptable = 406;
+// static RequestTimeOut = 408;
+// static Gone = 410;
+// static Conflict = 409;
+// static LengthRequired = 411;
+// static RequestEntityTooLarge = 413;
+// static PreconditionFailed = 412;
+// static RequestURITooLarge = 414;
+// static RequestedRangeNotSatisfiable = 416;
+// static UnsupportedMediaType = 415;
+// static ExpectationFailed = 417;
+// static UnprocessableEntity = 422;
+// static ImATeapot = 418;
+// static Locked = 423;
+// static FailedDependency = 424;
+// static UnorderedCollection = 425;
+// static UpgradeRequired = 426;
+// static PreconditionRequired = 428;
+// static TooManyRequests = 429;
+// static RequestHeaderFieldsTooLarge = 431;
+StatusCode.InternalServerError = 500;
+StatusCode.NotImplemented = 501;
+StatusCode.BadGateway = 502;
+class ResponseBodyVO {
+    constructor() {
+        this.statusResult = StatusResult.ok;
+        this.message = '';
+        this.data = null;
+        this.count = null;
+        this.error = null;
+    }
+}
+exports.ResponseBodyVO = ResponseBodyVO;
+class ResponseVO {
+    constructor() {
+        this.statusCode = StatusCode.OK;
+        this.body = '';
+    }
+}
+exports.ResponseVO = ResponseVO;
+class Result {
+    constructor({ statusCode = StatusCode.OK, statusResult = StatusResult.ok, message, data = null, count = null, error = null, bodyWrap = true, }) {
+        this.statusCode = statusCode;
+        this.statusResult = statusResult;
+        this.message = !message ? '' : message;
+        this.count = count;
+        this.data = data;
+        this.error = error;
+        this.bodyWrap = bodyWrap;
+    }
+    /**
+     * Serverless: According to the API Gateway specs, the body content must be stringified
+     * If use to AWS Appsync need response value without body wrap
+     */
+    bodyToString() {
+        let _err = this.error && this.error.message ? this.error.message : !this.error ? null : JSON.stringify(this.error);
+        const valueBody = {
+            statusResult: this.statusResult, message: this.message, data: this.data, count: this.count, error: _err,
+        };
+        const valueBodyWrap = {
+            statusCode: this.statusCode, body: JSON.stringify(valueBody),
+        };
+        return this.bodyWrap ? valueBodyWrap : valueBody;
+    }
+}
+class CreateResponse {
+    /**
+     * Success
+     * @param data
+     * @param count
+     * @param message
+     * @param bodyWrap
+     */
+    static success({ data = null, count = null, message = 'success', bodyWrap = true }) {
+        const result = new Result({
+            statusCode: StatusCode.OK, statusResult: StatusResult.ok, message, data, count, bodyWrap,
+        });
+        return result.bodyToString();
+    }
+    /**
+     * Created
+     * @param data
+     * @param message
+     * @param bodyWrap
+     */
+    static created({ data, message = 'created', bodyWrap = true }) {
+        const result = new Result({
+            statusCode: StatusCode.Created, statusResult: StatusResult.ok, message, data, bodyWrap,
+        });
+        return result.bodyToString();
+    }
+    /**
+     * Update
+     * @param data
+     * @param message
+     * @param bodyWrap
+     */
+    static updated({ data, message = 'updated', bodyWrap = true }) {
+        const result = new Result({
+            statusCode: StatusCode.OK, statusResult: StatusResult.ok, message, data, bodyWrap,
+        });
+        return result.bodyToString();
+    }
+    /**
+     * Not Found
+     * @param error
+     * @param message
+     * @param bodyWrap
+     */
+    static notFound({ error = null, message = '', bodyWrap = true }) {
+        const result = new Result({
+            statusCode: StatusCode.NotFound, statusResult: StatusResult.notFound, message, error, bodyWrap,
+        });
+        return result.bodyToString();
+    }
+    /**
+     * Error
+     * @param error
+     * @param statusCode
+     * @param message
+     * @param bodyWrap
+     */
+    static error({ error = null, statusCode = StatusCode.BadRequest, message = 'Error', bodyWrap = true, }) {
+        const result = new Result({
+            statusCode, statusResult: StatusResult.error, error, message, bodyWrap,
+        });
+        return result.bodyToString();
+    }
+    /**
+     * Custom
+     * @param statusCode
+     * @param statusResult
+     * @param message
+     * @param error
+     * @param data
+     * @param count
+     * @param bodyWrap
+     */
+    static custom({ statusCode = StatusCode.OK, statusResult = StatusResult.ok, message = '', error = null, data = null, count = null, bodyWrap = true, }) {
+        const result = new Result({
+            statusCode, statusResult, message, error, data, count, bodyWrap,
+        });
+        return result.bodyToString();
+    }
+}
+exports.CreateResponse = CreateResponse;
+const messagesREST = (prefix, suffix = '') => {
+    return {
+        TOTAL: `${prefix}_TOTAL${suffix}`,
+        CREATE: `${prefix}_ITEM_CREATE${suffix}`,
+        NOT_CREATE: `${prefix}_ITEM_NOT_CREATE${suffix}`,
+        ERROR_CREATE: `${prefix}_ITEM_ERROR_CREATE${suffix}`,
+        UPDATE: `${prefix}_ITEM_UPDATE${suffix}`,
+        UPDATE_MANY: `${prefix}_ITEM_UPDATE_MANY${suffix}`,
+        NOT_UPDATE: `${prefix}_ITEM_NOT_UPDATE${suffix}`,
+        NOT_UPDATE_MANY: `${prefix}_ITEM_NOT_UPDATE_MANY${suffix}`,
+        ERROR_UPDATE: `${prefix}_ITEM_ERROR_UPDATE${suffix}`,
+        ERROR_UPDATE_MANY: `${prefix}_ITEM_ERROR_UPDATE_MANY${suffix}`,
+        GET: `${prefix}_ITEM_GET${suffix}`,
+        NOT_GET: `${prefix}_ITEM_NOT_GET${suffix}`,
+        ERROR_GET: `${prefix}_ITEM_ERROR_GET${suffix}`,
+        GET_MANY: `${prefix}_GET_MANY${suffix}`,
+        NOT_GET_MANY: `${prefix}_NOT_GET_MANY${suffix}`,
+        ERROR_GET_MANY: `${prefix}_ERROR_GET_MANY${suffix}`,
+        GET_MANY_AND_COUNT: `${prefix}_GET_MANY_AND_COUNT${suffix}`,
+        NOT_GET_MANY_AND_COUNT: `${prefix}_NOT_GET_MANY_AND_COUNT${suffix}`,
+        ERROR_GET_MANY_AND_COUNT: `${prefix}_ERROR_GET_MANY_AND_COUNT${suffix}`,
+        GET_COUNT: `${prefix}_GET_COUNT${suffix}`,
+        NOT_GET_COUNT: `${prefix}_NOT_GET_COUNT${suffix}`,
+        ERROR_GET_COUNT: `${prefix}_ERROR_GET_COUNT${suffix}`,
+        DELETE: `${prefix}_ITEM_DELETE${suffix}`,
+        NOT_DELETE: `${prefix}_ITEM_NOT_DELETE${suffix}`,
+        ERROR_DELETE: `${prefix}_ITEM_ERROR_DELETE${suffix}`,
+        DELETE_MANY: `${prefix}_DELETE_MANY${suffix}`,
+        NOT_DELETE_MANY: `${prefix}_NOT_DELETE_MANY${suffix}`,
+        ERROR_DELETE_MANY: `${prefix}_ERROR_DELETE_MANY${suffix}`,
+        NOT_FOUND: `${prefix}_NOT_FOUND${suffix}`,
+        INITIALISE: `${prefix}_INITIALISE${suffix}`,
+        NOT_INITIALISE: `${prefix}_NOT_INITIALISE${suffix}`,
+        ERROR_INITIALISE: `${prefix}_ERROR_INITIALISE${suffix}`,
+        INCREMENT: `${prefix}_INCREMENT${suffix}`,
+        NOT_INCREMENT: `${prefix}_NOT_INCREMENT${suffix}`,
+        ERROR_INCREMENT: `${prefix}_ERROR_INCREMENT${suffix}`,
+        DECREMENT: `${prefix}_DECREMENT${suffix}`,
+        NOT_DECREMENT: `${prefix}_NOT_DECREMENT${suffix}`,
+        ERROR_DECREMENT: `${prefix}_ERROR_DECREMENT${suffix}`,
+        COUNTER_DAY: `${prefix}_COUNTER_DAY${suffix}`,
+        NOT_COUNTER_DAY: `${prefix}_NOT_COUNTER_DAY${suffix}`,
+        ERROR_COUNTER_DAY: `${prefix}_ERROR_COUNTER_DAY${suffix}`,
+        COUNTER_MONTH: `${prefix}_COUNTER_MONTH${suffix}`,
+        NOT_COUNTER_MONTH: `${prefix}_NOT_COUNTER_MONTH${suffix}`,
+        ERROR_COUNTER_MONTH: `${prefix}_ERROR_COUNTER_MONTH${suffix}`,
+        COUNTER_YEAR: `${prefix}_COUNTER_YEAR${suffix}`,
+        NOT_COUNTER_YEAR: `${prefix}_NOT_COUNTER_YEAR${suffix}`,
+        TEST: `${prefix}_TEST${suffix}`,
+        NOT_TEST: `${prefix}_NOT_TEST${suffix}`,
+        ERROR_TEST: `${prefix}_ERROR_TEST${suffix}`,
+        AGGREGATION: `${prefix}_AGGREGATION${suffix}`,
+        NOT_AGGREGATION: `${prefix}_NOT_AGGREGATION${suffix}`,
+        ERROR_AGGREGATION: `${prefix}_ERROR_AGGREGATION${suffix}`,
+    };
+};
+exports.messagesREST = messagesREST;
+exports.optionsPaginationParams = ['limit', 'skip', 'count'];
+/**
+ * Normalise filter for mongoose
+ * @param regexFields
+ * @param filter
+ * @param excludeFields
+ */
+const normaliseMongoFilter = (filter, regexFields, excludeFields) => {
+    const _filter = {};
+    const excludeParams = excludeFields && Array.isArray(excludeFields) && excludeFields.length > 0 ? excludeFields : exports.optionsPaginationParams;
+    Object.keys(filter).forEach((f) => {
+        const v = filter[f];
+        if (!(v === null || (typeof v === 'number' && isNaN(v)) || v === Infinity || v === undefined || excludeParams.includes(f))) {
+            _filter[f] = filter[f];
+            if (regexFields.includes(f))
+                _filter[f] = { $regex: filter[f] };
+        }
+    });
+    return _filter;
+};
+exports.normaliseMongoFilter = normaliseMongoFilter;
+/**
+ * Normalise Mongo Paginate params
+ * @param filter
+ */
+const normaliseMongoPaginate = (filter) => {
+    let res = {
+        skip: 0, limit: 50,
+    };
+    res.skip = filter && filter.skip ? parseInt(filter.skip, 10) || 0 : 0;
+    res.limit = filter && filter.limit ? parseInt(filter.limit, 10) || 50 : 50;
+    return res;
+};
+exports.normaliseMongoPaginate = normaliseMongoPaginate;
+const controlResponseNull = (data, okResultOf, prefix, bodyWrap = true) => {
+    let result;
+    if (data) {
+        if (okResultOf === 'create') {
+            result = CreateResponse.created({
+                data, message: (0, exports.messagesREST)(prefix).CREATE, bodyWrap,
+            });
+        }
+        if (okResultOf === 'update') {
+            result = CreateResponse.updated({
+                data, message: (0, exports.messagesREST)(prefix).UPDATE, bodyWrap,
+            });
+        }
+        if (okResultOf === 'update_many') {
+            result = CreateResponse.updated({
+                data, message: (0, exports.messagesREST)(prefix).UPDATE_MANY, bodyWrap,
+            });
+        }
+        if (okResultOf === 'increment') {
+            result = CreateResponse.updated({
+                data, message: (0, exports.messagesREST)(prefix).INCREMENT, bodyWrap,
+            });
+        }
+        if (okResultOf === 'decrement') {
+            result = CreateResponse.updated({
+                data, message: (0, exports.messagesREST)(prefix).DECREMENT, bodyWrap,
+            });
+        }
+    }
+    else {
+        let messageErr = '';
+        if (okResultOf === 'create')
+            messageErr = (0, exports.messagesREST)(prefix).NOT_CREATE;
+        if (okResultOf === 'update')
+            messageErr = (0, exports.messagesREST)(prefix).NOT_UPDATE;
+        if (okResultOf === 'update_many')
+            messageErr = (0, exports.messagesREST)(prefix).NOT_UPDATE_MANY;
+        if (okResultOf === 'increment')
+            messageErr = (0, exports.messagesREST)(prefix).NOT_INCREMENT;
+        if (okResultOf === 'decrement')
+            messageErr = (0, exports.messagesREST)(prefix).NOT_DECREMENT;
+        result = CreateResponse.error({
+            data: data, message: messageErr, bodyWrap,
+        });
+    }
+    return result;
+};
+exports.controlResponseNull = controlResponseNull;

package/index.ts

@@ -0,0 +1,405 @@
+export class StatusResult {
+  static ok = 'Ok';
+  static error = 'Error';
+  static notFound = 'NotFound';
+}
+
+export class StatusCode {
+  // static SwitchingProtocols = 101;
+  // static Continue = 100;
+  // static Processing = 102;
+
+  static OK = 200;
+  static Created = 201;
+  static Accepted = 202;
+  static NonAuthoritativeInformation = 203;
+  static NoContent = 204;
+  // static ResetContent = 205;
+  // static PartialContent = 206;
+  // static MultiStatus = 207;
+
+
+  // static MultipleChoices = 300;
+  // static MovedPermanently = 301;
+  // static MovedTemporarily = 302;
+  // static SeeOther = 303;
+  // static UseProxy = 305;
+  // static NotModified = 304;
+  // static TemporaryRedirect = 307;
+
+
+  static BadRequest = 400;
+  static Unauthorized = 401;
+  static PaymentRequired = 402;
+  static NotFound = 404;
+  static Forbidden = 403;
+  // static MethodNotAllowed = 405;
+  // static ProxyAuthenticationRequired = 407;
+  // static NotAcceptable = 406;
+  // static RequestTimeOut = 408;
+  // static Gone = 410;
+  // static Conflict = 409;
+  // static LengthRequired = 411;
+  // static RequestEntityTooLarge = 413;
+  // static PreconditionFailed = 412;
+  // static RequestURITooLarge = 414;
+  // static RequestedRangeNotSatisfiable = 416;
+  // static UnsupportedMediaType = 415;
+  // static ExpectationFailed = 417;
+  // static UnprocessableEntity = 422;
+  // static ImATeapot = 418;
+  // static Locked = 423;
+  // static FailedDependency = 424;
+  // static UnorderedCollection = 425;
+  // static UpgradeRequired = 426;
+  // static PreconditionRequired = 428;
+  // static TooManyRequests = 429;
+  // static RequestHeaderFieldsTooLarge = 431;
+
+  static InternalServerError = 500;
+  static NotImplemented = 501;
+  static BadGateway = 502;
+  // static ServiceUnavailable = 503;
+  // static GatewayTimeOut = 504;
+  // static HTTPVersionNotSupported = 505;
+  // static VariantAlsoNegotiates = 506;
+  // static InsufficientStorage = 507;
+  // static BandwidthLimitExceeded = 509;
+  // static NotExtended = 510;
+  // static NetworkAuthenticationRequire = 511;
+}
+
+type TData = object | boolean | string | null;
+type TCount = number | null;
+type TError = any | null;
+
+interface TResultIn {
+  statusCode?: StatusCode;
+  statusResult?: StatusResult;
+  message?: string;
+  data?: TData;
+  count?: TCount;
+  error?: TError;
+  bodyWrap: boolean;
+}
+
+interface TFuncParams {
+  statusCode?: StatusCode,
+  statusResult?: StatusResult,
+  message?: string,
+  error?: TError,
+  data?: TData,
+  count?: TCount,
+  bodyWrap?: boolean;
+}
+
+export class ResponseBodyVO {
+  statusResult: StatusResult = StatusResult.ok;
+  message: string = '';
+  data: TData = null;
+  count: TCount = null;
+  error: TError = null;
+}
+
+export class ResponseVO {
+  statusCode: StatusCode = StatusCode.OK;
+  body: string = '';
+}
+
+export type ResponseVoAWS = ResponseVO | ResponseBodyVO
+
+
+class Result {
+  private statusCode: StatusCode;
+  private statusResult: StatusResult;
+  private message: string;
+  private data: TData;
+  private count: TCount;
+  private error: any;
+  private bodyWrap: boolean;
+
+  constructor({
+    statusCode = StatusCode.OK,
+    statusResult = StatusResult.ok,
+    message,
+    data = null,
+    count = null,
+    error = null,
+    bodyWrap = true,
+  }: TResultIn) {
+    this.statusCode = statusCode;
+    this.statusResult = statusResult;
+    this.message = !message ? '' : message;
+    this.count = count;
+    this.data = data;
+    this.error = error;
+    this.bodyWrap = bodyWrap;
+  }
+
+  /**
+   * Serverless: According to the API Gateway specs, the body content must be stringified
+   * If use to AWS Appsync need response value without body wrap
+   */
+  bodyToString(): ResponseVoAWS {
+    let _err = this.error && this.error.message ? this.error.message : !this.error ? null : JSON.stringify(this.error);
+
+    const valueBody: ResponseBodyVO = {
+      statusResult: this.statusResult, message: this.message, data: this.data, count: this.count, error: _err,
+    };
+    const valueBodyWrap: ResponseVO = {
+      statusCode: this.statusCode, body: JSON.stringify(valueBody),
+    };
+
+    return this.bodyWrap ? valueBodyWrap : valueBody;
+  }
+}
+
+export class CreateResponse {
+
+  /**
+   * Success
+   * @param data
+   * @param count
+   * @param message
+   * @param bodyWrap
+   */
+  static success({ data = null, count = null, message = 'success', bodyWrap = true }: TFuncParams): ResponseVoAWS {
+    const result = new Result({
+      statusCode: StatusCode.OK, statusResult: StatusResult.ok, message, data, count, bodyWrap,
+    });
+    return result.bodyToString();
+  }
+
+  /**
+   * Created
+   * @param data
+   * @param message
+   * @param bodyWrap
+   */
+  static created({ data, message = 'created', bodyWrap = true }: TFuncParams): ResponseVoAWS {
+    const result = new Result({
+      statusCode: StatusCode.Created, statusResult: StatusResult.ok, message, data, bodyWrap,
+    });
+    return result.bodyToString();
+  }
+
+  /**
+   * Update
+   * @param data
+   * @param message
+   * @param bodyWrap
+   */
+  static updated({ data, message = 'updated', bodyWrap = true }: TFuncParams): ResponseVoAWS {
+    const result = new Result({
+      statusCode: StatusCode.OK, statusResult: StatusResult.ok, message, data, bodyWrap,
+    });
+    return result.bodyToString();
+  }
+
+  /**
+   * Not Found
+   * @param error
+   * @param message
+   * @param bodyWrap
+   */
+  static notFound({ error = null, message = '', bodyWrap = true }: TFuncParams): ResponseVoAWS {
+    const result = new Result({
+      statusCode: StatusCode.NotFound, statusResult: StatusResult.notFound, message, error, bodyWrap,
+    });
+    return result.bodyToString();
+  }
+
+  /**
+   * Error
+   * @param error
+   * @param statusCode
+   * @param message
+   * @param bodyWrap
+   */
+  static error({
+    error = null, statusCode = StatusCode.BadRequest, message = 'Error', bodyWrap = true,
+  }: TFuncParams): ResponseVoAWS {
+    const result = new Result({
+      statusCode, statusResult: StatusResult.error, error, message, bodyWrap,
+    });
+    return result.bodyToString();
+  }
+
+  /**
+   * Custom
+   * @param statusCode
+   * @param statusResult
+   * @param message
+   * @param error
+   * @param data
+   * @param count
+   * @param bodyWrap
+   */
+  static custom({
+    statusCode = StatusCode.OK,
+    statusResult = StatusResult.ok,
+    message = '',
+    error = null,
+    data = null,
+    count = null,
+    bodyWrap = true,
+  }: TFuncParams): ResponseVoAWS {
+    const result = new Result({
+      statusCode, statusResult, message, error, data, count, bodyWrap,
+    });
+    return result.bodyToString();
+  }
+}
+
+export const messagesREST = (prefix: string, suffix: string = '') => {
+  return {
+    TOTAL: `${prefix}_TOTAL${suffix}`,
+    CREATE: `${prefix}_ITEM_CREATE${suffix}`,
+    NOT_CREATE: `${prefix}_ITEM_NOT_CREATE${suffix}`,
+    ERROR_CREATE: `${prefix}_ITEM_ERROR_CREATE${suffix}`,
+    UPDATE: `${prefix}_ITEM_UPDATE${suffix}`,
+    UPDATE_MANY: `${prefix}_ITEM_UPDATE_MANY${suffix}`,
+    NOT_UPDATE: `${prefix}_ITEM_NOT_UPDATE${suffix}`,
+    NOT_UPDATE_MANY: `${prefix}_ITEM_NOT_UPDATE_MANY${suffix}`,
+    ERROR_UPDATE: `${prefix}_ITEM_ERROR_UPDATE${suffix}`,
+    ERROR_UPDATE_MANY: `${prefix}_ITEM_ERROR_UPDATE_MANY${suffix}`,
+    GET: `${prefix}_ITEM_GET${suffix}`,
+    NOT_GET: `${prefix}_ITEM_NOT_GET${suffix}`,
+    ERROR_GET: `${prefix}_ITEM_ERROR_GET${suffix}`,
+    GET_MANY: `${prefix}_GET_MANY${suffix}`,
+    NOT_GET_MANY: `${prefix}_NOT_GET_MANY${suffix}`,
+    ERROR_GET_MANY: `${prefix}_ERROR_GET_MANY${suffix}`,
+    GET_MANY_AND_COUNT: `${prefix}_GET_MANY_AND_COUNT${suffix}`,
+    NOT_GET_MANY_AND_COUNT: `${prefix}_NOT_GET_MANY_AND_COUNT${suffix}`,
+    ERROR_GET_MANY_AND_COUNT: `${prefix}_ERROR_GET_MANY_AND_COUNT${suffix}`,
+    GET_COUNT: `${prefix}_GET_COUNT${suffix}`,
+    NOT_GET_COUNT: `${prefix}_NOT_GET_COUNT${suffix}`,
+    ERROR_GET_COUNT: `${prefix}_ERROR_GET_COUNT${suffix}`,
+    DELETE: `${prefix}_ITEM_DELETE${suffix}`,
+    NOT_DELETE: `${prefix}_ITEM_NOT_DELETE${suffix}`,
+    ERROR_DELETE: `${prefix}_ITEM_ERROR_DELETE${suffix}`,
+    DELETE_MANY: `${prefix}_DELETE_MANY${suffix}`,
+    NOT_DELETE_MANY: `${prefix}_NOT_DELETE_MANY${suffix}`,
+    ERROR_DELETE_MANY: `${prefix}_ERROR_DELETE_MANY${suffix}`,
+    NOT_FOUND: `${prefix}_NOT_FOUND${suffix}`,
+    INITIALISE: `${prefix}_INITIALISE${suffix}`,
+    NOT_INITIALISE: `${prefix}_NOT_INITIALISE${suffix}`,
+    ERROR_INITIALISE: `${prefix}_ERROR_INITIALISE${suffix}`,
+    INCREMENT: `${prefix}_INCREMENT${suffix}`,
+    NOT_INCREMENT: `${prefix}_NOT_INCREMENT${suffix}`,
+    ERROR_INCREMENT: `${prefix}_ERROR_INCREMENT${suffix}`,
+    DECREMENT: `${prefix}_DECREMENT${suffix}`,
+    NOT_DECREMENT: `${prefix}_NOT_DECREMENT${suffix}`,
+    ERROR_DECREMENT: `${prefix}_ERROR_DECREMENT${suffix}`,
+    COUNTER_DAY: `${prefix}_COUNTER_DAY${suffix}`,
+    NOT_COUNTER_DAY: `${prefix}_NOT_COUNTER_DAY${suffix}`,
+    ERROR_COUNTER_DAY: `${prefix}_ERROR_COUNTER_DAY${suffix}`,
+    COUNTER_MONTH: `${prefix}_COUNTER_MONTH${suffix}`,
+    NOT_COUNTER_MONTH: `${prefix}_NOT_COUNTER_MONTH${suffix}`,
+    ERROR_COUNTER_MONTH: `${prefix}_ERROR_COUNTER_MONTH${suffix}`,
+    COUNTER_YEAR: `${prefix}_COUNTER_YEAR${suffix}`,
+    NOT_COUNTER_YEAR: `${prefix}_NOT_COUNTER_YEAR${suffix}`,
+    TEST: `${prefix}_TEST${suffix}`,
+    NOT_TEST: `${prefix}_NOT_TEST${suffix}`,
+    ERROR_TEST: `${prefix}_ERROR_TEST${suffix}`,
+    AGGREGATION: `${prefix}_AGGREGATION${suffix}`,
+    NOT_AGGREGATION: `${prefix}_NOT_AGGREGATION${suffix}`,
+    ERROR_AGGREGATION: `${prefix}_ERROR_AGGREGATION${suffix}`,
+  };
+};
+
+export const optionsPaginationParams = ['limit', 'skip', 'count'];
+
+export type TMongoFilterNormalise = {[fieldName: string]: any}
+
+/**
+ * Normalise filter for mongoose
+ * @param regexFields
+ * @param filter
+ * @param excludeFields
+ */
+export const normaliseMongoFilter = (filter: TMongoFilterNormalise, regexFields: string[], excludeFields?: string[]) => {
+  const _filter: TMongoFilterNormalise = {};
+  const excludeParams = excludeFields && Array.isArray(excludeFields) && excludeFields.length > 0 ? excludeFields : optionsPaginationParams;
+
+  Object.keys(filter).forEach((f) => {
+    const v = filter[f];
+    if (!(v === null || (typeof v === 'number' && isNaN(v)) || v === Infinity || v === undefined || excludeParams.includes(f))) {
+      _filter[f] = filter[f];
+
+      if (regexFields.includes(f)) _filter[f] = { $regex: filter[f] };
+    }
+  });
+
+  return _filter;
+};
+
+export interface TMongoPaginate {
+  skip: number;
+  limit: number;
+}
+
+/**
+ * Normalise Mongo Paginate params
+ * @param filter
+ */
+export const normaliseMongoPaginate = (filter: TMongoFilterNormalise): TMongoPaginate => {
+  let res: TMongoPaginate = {
+    skip: 0, limit: 50,
+  };
+
+  res.skip = filter && filter.skip ? parseInt(filter.skip, 10) || 0 : 0;
+  res.limit = filter && filter.limit ? parseInt(filter.limit, 10) || 50 : 50;
+
+  return res;
+};
+
+export const controlResponseNull = (data: object, okResultOf: 'create' | 'update' | 'update_many' | 'increment' | 'decrement', prefix: string, bodyWrap: boolean = true) => {
+  let result;
+
+  if (data) {
+    if (okResultOf === 'create') {
+      result = CreateResponse.created({
+        data, message: messagesREST(prefix).CREATE, bodyWrap,
+      });
+    }
+
+    if (okResultOf === 'update') {
+      result = CreateResponse.updated({
+        data, message: messagesREST(prefix).UPDATE, bodyWrap,
+      });
+    }
+
+    if (okResultOf === 'update_many') {
+      result = CreateResponse.updated({
+        data, message: messagesREST(prefix).UPDATE_MANY, bodyWrap,
+      });
+    }
+
+    if (okResultOf === 'increment') {
+      result = CreateResponse.updated({
+        data, message: messagesREST(prefix).INCREMENT, bodyWrap,
+      });
+    }
+
+    if (okResultOf === 'decrement') {
+      result = CreateResponse.updated({
+        data, message: messagesREST(prefix).DECREMENT, bodyWrap,
+      });
+    }
+
+  } else {
+    let messageErr = '';
+    if (okResultOf === 'create') messageErr = messagesREST(prefix).NOT_CREATE;
+    if (okResultOf === 'update') messageErr = messagesREST(prefix).NOT_UPDATE;
+    if (okResultOf === 'update_many') messageErr = messagesREST(prefix).NOT_UPDATE_MANY;
+    if (okResultOf === 'increment') messageErr = messagesREST(prefix).NOT_INCREMENT;
+    if (okResultOf === 'decrement') messageErr = messagesREST(prefix).NOT_DECREMENT;
+
+    result = CreateResponse.error({
+      data: data, message: messageErr, bodyWrap,
+    });
+  }
+
+  return result;
+};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "my-q-format-response-aws-lambda",
+  "version": "1.0.1",
+  "homepage": "https://github.com/zhukyuri/my-q-format-response-aws-lambda",
+  "description": "my-q-format-response-aws-lambda",
+  "main": "index.js",
+  "private": false,
+  "scripts": {
+    "build": "npx tsc",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepare": "npm run build",
+    "version": "git add .",
+    "postversion": "git push && git push --tags",
+    "publish": "npm publish"
+  },
+  "author": "zhukyuri",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^4.7.4"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+//     "outDir": "./build",                                /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}