@autofleet/sheilta 1.1.1 → 1.2.1

package/lib/formatter/index.d.ts

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

package/lib/formatter/index.js

@@ -2,28 +2,38 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const DESCENDING_KEY = 'DESC';
-const formatOrder = ({ order = [], }) => (order.length === 0 ? undefined :
+const formatOrder = ({ order = [], associationModels = [], }) => (order.length === 0 ? undefined :
     order.map((o) => {
+        const formattedOrder = [utils_1.extractAttributeNameFromOrder(o, associationModels)];
         const isOrderDescOrder = utils_1.isOrderDesc(o);
-        let column = o;
+        const isOrderAssociation = utils_1.isOrderByAssociation(isOrderDescOrder
+            ? o.split(utils_1.ORDER_PREFIX)[1]
+            : o, associationModels);
+        if (isOrderAssociation) {
+            formattedOrder.push(utils_1.extractAssociatedAttributeNameFromOrder(o));
+        }
         if (isOrderDescOrder) {
-            column = utils_1.extractAttributeNameFromOrder(o);
-            return [column, DESCENDING_KEY];
+            formattedOrder.push(DESCENDING_KEY);
         }
-        return [column];
+        return formattedOrder;
     }));
 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 formatInclude = (include, associationsMap = {}) => include.map(i => associationsMap[i.model]);
+const formatPayload = ({ order, page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, include = [], }, model) => {
+    const associationModels = Object.keys((model === null || model === void 0 ? void 0 : model.associations) || {});
     const formattedOrder = formatOrder({
         order,
+        associationModels,
     });
+    const formattedInclude = formatInclude(include, model === null || model === void 0 ? void 0 : model.associations);
     const formattedPage = formatPage(page);
     const formattedPerPage = formatPerPage(perPage);
     return {
         order: formattedOrder,
         page: formattedPage,
         perPage: formattedPerPage,
+        include: formattedInclude,
     };
 };
 exports.default = formatPayload;

package/lib/formatter/index.test.js

@@ -17,4 +17,50 @@ describe('formatting test', () => {
         });
         expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime']]));
     });
+    it('check order formatting - by included model', () => {
+        const { order } = _1.default({
+            order: ['status.name'],
+        }, {
+            rawAttributes: {
+                startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
+            },
+            associations: {
+                status: {},
+            },
+        });
+        expect(JSON.stringify(order)).toBe(JSON.stringify([['status', 'name']]));
+    });
+    it('check order formatting - by included model descending', () => {
+        const { order } = _1.default({
+            order: ['-status.name'],
+        }, {
+            rawAttributes: {
+                startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
+            },
+            associations: {
+                status: {},
+            },
+        });
+        expect(JSON.stringify(order)).toBe(JSON.stringify([['status', 'name', 'DESC']]));
+    });
+    it('check order formatting - by json field', () => {
+        const { order } = _1.default({
+            order: ['status.name'],
+        }, {
+            rawAttributes: {
+                startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', json: '',
+            },
+        });
+        expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name']]));
+    });
+    it('check order formatting - by json field descending', () => {
+        const { order } = _1.default({
+            order: ['-status.name'],
+        }, {
+            rawAttributes: {
+                startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', json: '',
+            },
+        });
+        expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name', 'DESC']]));
+    });
 });

package/lib/middleware/index.d.ts

@@ -1,4 +1,4 @@
 export declare const newQueryValidationMiddleware: (inner?: string) => (model: any) => (req: any, res: any, next: any) => Promise<any>;
-export declare const newQueryFormatMiddleware: (inner?: string) => () => (req: any, res: any, next: any) => Promise<any>;
+export declare const newQueryFormatMiddleware: (inner?: string) => (model: any) => (req: any, res: any, next: any) => Promise<any>;
 export declare const queryValidationMiddleware: (model: any) => (req: any, res: any, next: any) => Promise<any>;
-export declare const queryFormatMiddleware: () => (req: any, res: any, next: any) => Promise<any>;
+export declare const queryFormatMiddleware: (model: any) => (req: any, res: any, next: any) => Promise<any>;

package/lib/middleware/index.js

@@ -17,7 +17,7 @@ const errors_1 = require("@autofleet/errors");
 const formatter_1 = __importDefault(require("../formatter"));
 const validations_1 = require("../validations");
 exports.newQueryValidationMiddleware = (inner = 'body') => model => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
-    const { query, attributes, order, page, perPage, } = req[inner];
+    const { query, attributes, order, page, perPage, include, } = req[inner];
     try {
         validations_1.validatePayload({
             query,
@@ -25,6 +25,7 @@ exports.newQueryValidationMiddleware = (inner = 'body') => model => (req, res, n
             order,
             page,
             perPage,
+            include,
         }, model);
         return next();
     }
@@ -40,16 +41,18 @@ exports.newQueryValidationMiddleware = (inner = 'body') => model => (req, res, n
         });
     }
 });
-exports.newQueryFormatMiddleware = (inner = 'body') => () => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
-    const { order, page, perPage, } = req[inner];
-    const { order: formattedOrder, page: formattedPage, perPage: formattedPerPage, } = formatter_1.default({
+exports.newQueryFormatMiddleware = (inner = 'body') => model => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+    const { order, page, perPage, include, } = req[inner];
+    const { order: formattedOrder, page: formattedPage, perPage: formattedPerPage, include: formattedInclude, } = formatter_1.default({
         order,
         page,
         perPage,
-    });
+        include,
+    }, model);
     req[inner].order = formattedOrder;
     req[inner].page = formattedPage;
     req[inner].perPage = formattedPerPage;
+    req[inner].include = formattedInclude;
     return next();
 });
 exports.queryValidationMiddleware = exports.newQueryValidationMiddleware();

package/lib/utils.d.ts

@@ -1,9 +1,12 @@
 export declare const ORDER_PREFIX = "-";
+export declare const ASSOCIATION_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 isOrderByAssociation: (attributeName: any, associatedModels: any) => boolean;
+export declare const extractAttributeNameFromOrder: (order: any, associationModels: any) => string;
 export declare const isOrderDesc: (order: any) => boolean;
 export declare const throwBadRequestError: (message: string) => never;
+export declare const extractAssociatedAttributeNameFromOrder: (order: any) => string;

package/lib/utils.js

@@ -1,13 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.extractAssociatedAttributeNameFromOrder = exports.throwBadRequestError = exports.isOrderDesc = exports.extractAttributeNameFromOrder = exports.isOrderByAssociation = exports.PAGE_MIN = exports.PER_PAGE_MIN_LIMIT = exports.PER_PAGE_MAX_LIMIT = exports.PAGE_DEFAULT = exports.PER_PAGE_DEFAULT = exports.ASSOCIATION_PREFIX = exports.ORDER_PREFIX = void 0;
 const errors_1 = require("@autofleet/errors");
 exports.ORDER_PREFIX = '-';
+exports.ASSOCIATION_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.isOrderByAssociation = (attributeName, associatedModels) => attributeName.includes(exports.ASSOCIATION_PREFIX)
+    && associatedModels.includes(attributeName.split(exports.ASSOCIATION_PREFIX)[0]);
+exports.extractAttributeNameFromOrder = (order, associationModels) => {
+    let formattedOrder = order;
+    if (order.includes(exports.ORDER_PREFIX)) {
+        // eslint-disable-next-line prefer-destructuring
+        formattedOrder = formattedOrder.split(exports.ORDER_PREFIX)[1];
+    }
+    if (exports.isOrderByAssociation(formattedOrder, associationModels)) {
+        [formattedOrder] = formattedOrder.split(exports.ASSOCIATION_PREFIX);
+    }
+    return formattedOrder;
+};
 exports.isOrderDesc = (order) => order.includes(exports.ORDER_PREFIX);
-exports.throwBadRequestError = (message) => { throw new errors_1.BadRequest([{ message }], null); };
+exports.throwBadRequestError = (message) => {
+    throw new errors_1.BadRequest([{ message }], null);
+};
+exports.extractAssociatedAttributeNameFromOrder = (order) => order.split(exports.ASSOCIATION_PREFIX)[1];

package/lib/validations/index.d.ts

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

package/lib/validations/index.js

@@ -9,15 +9,19 @@ const utils_1 = require("../utils");
 const operators_1 = require("../operators");
 const validateOperator = (operator) => operators_1.OPERATORS.includes(operator.split(operators_1.OPERATOR_PREFIX)[1]);
 const validateQueryAttribute = (attribute, modelAttributes) => modelAttributes.includes(attribute);
-const validateSingleOrder = (currentOrder, rawAttributes) => {
+const validateSingleOrder = (currentOrder, rawAttributes, associationModels) => {
     const isOrderDescOrder = utils_1.isOrderDesc(currentOrder);
     if (isOrderDescOrder && currentOrder[0] !== utils_1.ORDER_PREFIX) {
         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)) {
+    const orderStringWithoutDesc = isOrderDescOrder ?
+        currentOrder.split(utils_1.ORDER_PREFIX)[1] : currentOrder;
+    const isOrderAssociation = utils_1.isOrderByAssociation(orderStringWithoutDesc, associationModels);
+    let formattedOrderString = utils_1.extractAttributeNameFromOrder(currentOrder, associationModels);
+    if (!isOrderAssociation && formattedOrderString.includes(utils_1.ASSOCIATION_PREFIX)) {
+        [formattedOrderString] = formattedOrderString.split(utils_1.ASSOCIATION_PREFIX);
+    }
+    if (!(rawAttributes.includes(formattedOrderString) || isOrderAssociation)) {
         utils_1.throwBadRequestError(`${currentOrder} is invalid`);
     }
 };
@@ -26,8 +30,8 @@ const validateSingleAttribute = (currentAttribute, rawAttributes) => {
         utils_1.throwBadRequestError(`${currentAttribute} is invalid`);
     }
 };
-const validateOrderAttributes = (order, rawAttributes) => {
-    order.map(o => validateSingleOrder(o, rawAttributes));
+const validateOrderAttributes = (order, rawAttributes, associationModels = []) => {
+    order.map(o => validateSingleOrder(o, rawAttributes, associationModels));
 };
 const validateAttributes = (attributes, rawAttributes) => {
     attributes.map(a => validateSingleAttribute(a, rawAttributes));
@@ -59,8 +63,25 @@ const validatePagination = ({ page, perPage, }) => {
         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 validateIncludePayload = (include, associations) => {
+    const associationsKeys = Object.keys(associations);
+    include.forEach((i) => {
+        validateQueryAttribute(i.model, associationsKeys);
+        const { rawAttributes } = associations[i.model].target;
+        if (include.where) {
+            validateQueryPayload(i.where, rawAttributes);
+        }
+        if (include.order) {
+            validateOrderAttributes(i.order, rawAttributes);
+        }
+        if (!lodash_1.default.isNil(include.required) && !lodash_1.default.isBoolean(include.required)) {
+            utils_1.throwBadRequestError('include.required must be a boolean');
+        }
+    });
+};
+exports.validatePayload = ({ query = {}, order = [], attributes = [], include = [], page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, }, model) => {
     const rawAttributes = Object.keys(model.rawAttributes);
+    const associationModels = Object.keys((model === null || model === void 0 ? void 0 : model.associations) || {});
     if (!attributes || attributes.length === 0) {
         // eslint-disable-next-line no-param-reassign
         attributes = rawAttributes;
@@ -68,8 +89,11 @@ exports.validatePayload = ({ query = {}, order = [], attributes = [], page = uti
     else {
         validateAttributes(attributes, rawAttributes);
     }
-    validateOrderAttributes(order, rawAttributes);
+    validateOrderAttributes(order, rawAttributes, associationModels);
     validateQueryPayload(query, rawAttributes);
+    if (include.length) {
+        validateIncludePayload(include, model === null || model === void 0 ? void 0 : model.associations);
+    }
     validatePagination({
         page,
         perPage,

package/lib/validations/index.test.js

@@ -78,4 +78,54 @@ describe('validations test', () => {
             expect(error.statusCode).toBe(400);
         }
     });
+    it('check order validation - order by included model', () => {
+        const payload = _1.validatePayload({ order: ['status.title'] }, {
+            rawAttributes: {
+                startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
+            },
+            associations: {
+                status: {},
+            },
+        });
+        expect(payload).toBe(true);
+    });
+    it('check order validation - order by included model descending', () => {
+        const payload = _1.validatePayload({ order: ['-status.title'] }, {
+            rawAttributes: {
+                startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '',
+            },
+            associations: {
+                status: {},
+            },
+        });
+        expect(payload).toBe(true);
+    });
+    it('check order validation - order by json field', () => {
+        const payload = _1.validatePayload({ order: ['status.title'] }, {
+            rawAttributes: {
+                startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', status: '',
+            },
+        });
+        expect(payload).toBe(true);
+    });
+    it('check order validation - order by json field desc', () => {
+        const payload = _1.validatePayload({ order: ['-status.title'] }, {
+            rawAttributes: {
+                startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', status: '',
+            },
+        });
+        expect(payload).toBe(true);
+    });
+    it('check order validation - try order by json field that doesnt exist', () => {
+        try {
+            _1.validatePayload({ order: ['-stas.title'] }, {
+                rawAttributes: {
+                    startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', status: '',
+                },
+            });
+        }
+        catch (error) {
+            expect(error.statusCode).toBe(400);
+        }
+    });
 });

package/package.json

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