@autofleet/sheilta 1.0.5 → 1.0.6

package/lib/formatter/index.d.ts

@@ -1,6 +1,12 @@
 declare type OrderItem = string | [string, string];
 declare type SequelizeOrder = string | OrderItem[];
-export declare const formatOrder: ({ order, }: {
-    order?: any[];
-}) => SequelizeOrder[] | undefined;
-export {};
+declare const formatPayload: ({ order, page, perPage, }: {
+    order: any;
+    page?: number;
+    perPage?: number;
+}) => {
+    order: SequelizeOrder[];
+    page: any;
+    perPage: any;
+};
+export default formatPayload;

package/lib/formatter/index.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatOrder = void 0;
 const utils_1 = require("../utils");
 const DESCENDING_KEY = 'DESC';
-exports.formatOrder = ({ order = [], }) => (order.length === 0 ? undefined :
+const formatOrder = ({ order = [], }) => (order.length === 0 ? undefined :
     order.map((o) => {
         const isOrderDescOrder = utils_1.isOrderDesc(o);
         let column = o;
@@ -13,3 +12,18 @@ exports.formatOrder = ({ order = [], }) => (order.length === 0 ? undefined :
         }
         return [column];
     }));
+const formatPage = page => page || utils_1.PAGE_DEFAULT;
+const formatPerPage = perPage => perPage || utils_1.PER_PAGE_DEFAULT;
+const formatPayload = ({ order, page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, }) => {
+    const formattedOrder = formatOrder({
+        order,
+    });
+    const formattedPage = formatPage(page);
+    const formattedPerPage = formatPerPage(perPage);
+    return {
+        order: formattedOrder,
+        page: formattedPage,
+        perPage: formattedPerPage,
+    };
+};
+exports.default = formatPayload;

package/lib/formatter/index.test.js

@@ -1,17 +1,20 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
+const _1 = __importDefault(require("."));
 describe('formatting test', () => {
     it('check order formatting', () => {
-        const payload = _1.formatOrder({
+        const { order } = _1.default({
             order: ['startTime', '-endTime'],
         });
-        expect(JSON.stringify(payload)).toBe(JSON.stringify([['startTime'], ['endTime', 'DESC']]));
+        expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime', 'DESC']]));
     });
     it('check order formatting', () => {
-        const payload = _1.formatOrder({
+        const { order } = _1.default({
             order: ['startTime', 'endTime'],
         });
-        expect(JSON.stringify(payload)).toBe(JSON.stringify([['startTime'], ['endTime']]));
+        expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime']]));
     });
 });

package/lib/middleware/index.js

@@ -8,18 +8,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.queryFormatMiddleware = exports.queryValidationMiddleware = void 0;
 const errors_1 = require("@autofleet/errors");
-const formatter_1 = require("../formatter");
+const formatter_1 = __importDefault(require("../formatter"));
 const validations_1 = require("../validations");
 exports.queryValidationMiddleware = model => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
-    const { query, attributes, order, } = req.body;
+    const { query, attributes, order, page, perPage, } = req.body;
     try {
         validations_1.validatePayload({
             query,
             attributes,
             order,
+            page,
+            perPage,
         }, model);
         return next();
     }
@@ -36,10 +41,14 @@ exports.queryValidationMiddleware = model => (req, res, next) => __awaiter(void
     }
 });
 exports.queryFormatMiddleware = () => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
-    const { order, } = req.body;
-    const formattedOrder = formatter_1.formatOrder({
+    const { order, page, perPage, } = req.body;
+    const { order: formattedOrder, page: formattedPage, perPage: formattedPerPage, } = formatter_1.default({
         order,
+        page,
+        perPage,
     });
     req.body.order = formattedOrder;
+    req.body.page = formattedPage;
+    req.body.perPage = formattedPerPage;
     return next();
 });

package/lib/utils.d.ts

@@ -1,3 +1,9 @@
 export declare const ORDER_PREFIX = "-";
+export declare const PER_PAGE_DEFAULT = 20;
+export declare const PAGE_DEFAULT = 1;
+export declare const PER_PAGE_MAX_LIMIT = 100;
+export declare const PER_PAGE_MIN_LIMIT = 1;
+export declare const PAGE_MIN = 1;
 export declare const extractAttributeNameFromOrder: (order: any) => string;
 export declare const isOrderDesc: (order: any) => boolean;
+export declare const throwBadRequestError: (message: string) => never;

package/lib/utils.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isOrderDesc = exports.extractAttributeNameFromOrder = exports.ORDER_PREFIX = void 0;
+exports.throwBadRequestError = exports.isOrderDesc = exports.extractAttributeNameFromOrder = exports.PAGE_MIN = exports.PER_PAGE_MIN_LIMIT = exports.PER_PAGE_MAX_LIMIT = exports.PAGE_DEFAULT = exports.PER_PAGE_DEFAULT = exports.ORDER_PREFIX = void 0;
+const errors_1 = require("@autofleet/errors");
 exports.ORDER_PREFIX = '-';
+exports.PER_PAGE_DEFAULT = 20;
+exports.PAGE_DEFAULT = 1;
+exports.PER_PAGE_MAX_LIMIT = 100;
+exports.PER_PAGE_MIN_LIMIT = 1;
+exports.PAGE_MIN = 1;
 exports.extractAttributeNameFromOrder = (order) => order.split(exports.ORDER_PREFIX)[1];
 exports.isOrderDesc = (order) => order.includes(exports.ORDER_PREFIX);
+exports.throwBadRequestError = (message) => { throw new errors_1.BadRequest(message, null); };

package/lib/validations/index.d.ts

@@ -1,5 +1,7 @@
-export declare const validatePayload: ({ query, order, attributes, }: {
+export declare const validatePayload: ({ query, order, attributes, page, perPage, }: {
     query?: {};
     order?: any[];
     attributes?: any[];
+    page?: number;
+    perPage?: number;
 }, model: any) => boolean;

package/lib/validations/index.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validatePayload = void 0;
-const errors_1 = require("@autofleet/errors");
 const lodash_1 = __importDefault(require("lodash"));
 const utils_1 = require("../utils");
 const operators_1 = require("../operators");
@@ -13,18 +12,18 @@ const validateQueryAttribute = (attribute, modelAttributes) => modelAttributes.i
 const validateSingleOrder = (currentOrder, rawAttributes) => {
     const isOrderDescOrder = utils_1.isOrderDesc(currentOrder);
     if (isOrderDescOrder && currentOrder[0] !== utils_1.ORDER_PREFIX) {
-        throw new errors_1.BadRequest(`${utils_1.ORDER_PREFIX} must be only at the beginning of the word`, null);
+        utils_1.throwBadRequestError(`${utils_1.ORDER_PREFIX} must be only at the beginning of the word`);
     }
     const formattedOrderString = isOrderDescOrder ?
         utils_1.extractAttributeNameFromOrder(currentOrder) :
         currentOrder;
     if (!rawAttributes.includes(formattedOrderString)) {
-        throw new errors_1.BadRequest(`${currentOrder} is invalid`, null);
+        utils_1.throwBadRequestError(`${currentOrder} is invalid`);
     }
 };
 const validateSingleAttribute = (currentAttribute, rawAttributes) => {
     if (!rawAttributes.includes(currentAttribute)) {
-        throw new errors_1.BadRequest(`${currentAttribute} is invalid`, null);
+        utils_1.throwBadRequestError(`${currentAttribute} is invalid`);
     }
 };
 const validateOrderAttributes = (order, rawAttributes) => {
@@ -48,11 +47,19 @@ const validateQueryPayload = (query, rawAttributes) => {
             }
         }
         else {
-            throw new errors_1.BadRequest(`invalid key: ${key}`, null);
+            utils_1.throwBadRequestError(`invalid key: ${key}`);
         }
     });
 };
-exports.validatePayload = ({ query = {}, order = [], attributes = [], }, model) => {
+const validatePagination = ({ page, perPage, }) => {
+    if (page < utils_1.PAGE_MIN) {
+        utils_1.throwBadRequestError('Page must be greater than 0');
+    }
+    if (perPage >= utils_1.PER_PAGE_MAX_LIMIT || perPage <= utils_1.PER_PAGE_MIN_LIMIT) {
+        utils_1.throwBadRequestError(`PerPage must be between ${utils_1.PER_PAGE_MIN_LIMIT} to ${utils_1.PER_PAGE_MAX_LIMIT}`);
+    }
+};
+exports.validatePayload = ({ query = {}, order = [], attributes = [], page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, }, model) => {
     const rawAttributes = Object.keys(model.rawAttributes);
     if (!attributes || attributes.length === 0) {
         // eslint-disable-next-line no-param-reassign
@@ -63,5 +70,9 @@ exports.validatePayload = ({ query = {}, order = [], attributes = [], }, model)
     }
     validateOrderAttributes(order, rawAttributes);
     validateQueryPayload(query, rawAttributes);
+    validatePagination({
+        page,
+        perPage,
+    });
     return true;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sheilta",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "manage cache",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",