@autofleet/sheilta 1.2.1 → 1.2.3-beta

package/lib/formatter/index.d.ts

@@ -1,14 +1,6 @@
 declare type OrderItem = string | [string, string];
 declare type SequelizeOrder = string | OrderItem[];
-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;
+export declare const formatOrder: ({ order, }: {
+    order?: any[];
+}) => SequelizeOrder[] | undefined;
+export {};

package/lib/formatter/index.js

@@ -1,39 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatOrder = void 0;
 const utils_1 = require("../utils");
 const DESCENDING_KEY = 'DESC';
-const formatOrder = ({ order = [], associationModels = [], }) => (order.length === 0 ? undefined :
+exports.formatOrder = ({ order = [], }) => (order.length === 0 ? undefined :
     order.map((o) => {
-        const formattedOrder = [utils_1.extractAttributeNameFromOrder(o, associationModels)];
         const isOrderDescOrder = utils_1.isOrderDesc(o);
-        const isOrderAssociation = utils_1.isOrderByAssociation(isOrderDescOrder
-            ? o.split(utils_1.ORDER_PREFIX)[1]
-            : o, associationModels);
-        if (isOrderAssociation) {
-            formattedOrder.push(utils_1.extractAssociatedAttributeNameFromOrder(o));
-        }
+        let column = o;
         if (isOrderDescOrder) {
-            formattedOrder.push(DESCENDING_KEY);
+            column = utils_1.extractAttributeNameFromOrder(o);
+            return [column, DESCENDING_KEY];
         }
-        return formattedOrder;
+        return [column];
     }));
-const formatPage = page => page || utils_1.PAGE_DEFAULT;
-const formatPerPage = perPage => 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

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

package/lib/middleware/index.d.ts

@@ -1,4 +1,2 @@
-export declare const newQueryValidationMiddleware: (inner?: string) => (model: any) => (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: (model: any) => (req: any, res: any, next: any) => Promise<any>;
+export declare const queryFormatMiddleware: () => (req: any, res: any, next: any) => Promise<any>;

package/lib/middleware/index.js

@@ -8,24 +8,18 @@ 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 = exports.newQueryFormatMiddleware = exports.newQueryValidationMiddleware = void 0;
+exports.queryFormatMiddleware = exports.queryValidationMiddleware = void 0;
 const errors_1 = require("@autofleet/errors");
-const formatter_1 = __importDefault(require("../formatter"));
+const formatter_1 = 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, include, } = req[inner];
+exports.queryValidationMiddleware = model => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+    const { query, attributes, order, } = req.body;
     try {
         validations_1.validatePayload({
             query,
             attributes,
             order,
-            page,
-            perPage,
-            include,
         }, model);
         return next();
     }
@@ -41,19 +35,11 @@ exports.newQueryValidationMiddleware = (inner = 'body') => model => (req, res, n
         });
     }
 });
-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({
+exports.queryFormatMiddleware = () => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+    const { order, } = req.body;
+    const formattedOrder = formatter_1.formatOrder({
         order,
-        page,
-        perPage,
-        include,
-    }, model);
-    req[inner].order = formattedOrder;
-    req[inner].page = formattedPage;
-    req[inner].perPage = formattedPerPage;
-    req[inner].include = formattedInclude;
+    });
+    req.body.order = formattedOrder;
     return next();
 });
-exports.queryValidationMiddleware = exports.newQueryValidationMiddleware();
-exports.queryFormatMiddleware = exports.newQueryFormatMiddleware();

package/lib/operators/index.js

@@ -17,8 +17,6 @@ exports.OPERATORS = [
     'between',
     'and',
     'or',
-    'overlap',
-    'contains',
 ];
 exports.OPERATOR_PREFIX = '$';
 exports.formatOperators = (Sequelize) => {

package/lib/utils.d.ts

@@ -1,12 +1,3 @@
 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 isOrderByAssociation: (attributeName: any, associatedModels: any) => boolean;
-export declare const extractAttributeNameFromOrder: (order: any, associationModels: any) => string;
+export declare const extractAttributeNameFromOrder: (order: 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,29 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.isOrderDesc = exports.extractAttributeNameFromOrder = exports.ORDER_PREFIX = void 0;
 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.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.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);
-};
-exports.extractAssociatedAttributeNameFromOrder = (order) => order.split(exports.ASSOCIATION_PREFIX)[1];

package/lib/validations/index.d.ts

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

package/lib/validations/index.js

@@ -4,34 +4,31 @@ 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");
 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, associationModels) => {
+const validateSingleOrder = (currentOrder, rawAttributes) => {
     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`);
+        throw new errors_1.BadRequest(`${utils_1.ORDER_PREFIX} must be only at the beginning of the word`, null);
     }
-    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`);
+    const formattedOrderString = isOrderDescOrder ?
+        utils_1.extractAttributeNameFromOrder(currentOrder) :
+        currentOrder;
+    if (!rawAttributes.includes(formattedOrderString)) {
+        throw new errors_1.BadRequest(`${currentOrder} is invalid`, null);
     }
 };
 const validateSingleAttribute = (currentAttribute, rawAttributes) => {
     if (!rawAttributes.includes(currentAttribute)) {
-        utils_1.throwBadRequestError(`${currentAttribute} is invalid`);
+        throw new errors_1.BadRequest(`${currentAttribute} is invalid`, null);
     }
 };
-const validateOrderAttributes = (order, rawAttributes, associationModels = []) => {
-    order.map(o => validateSingleOrder(o, rawAttributes, associationModels));
+const validateOrderAttributes = (order, rawAttributes) => {
+    order.map(o => validateSingleOrder(o, rawAttributes));
 };
 const validateAttributes = (attributes, rawAttributes) => {
     attributes.map(a => validateSingleAttribute(a, rawAttributes));
@@ -51,37 +48,12 @@ const validateQueryPayload = (query, rawAttributes) => {
             }
         }
         else {
-            utils_1.throwBadRequestError(`invalid key: ${key}`);
+            throw new errors_1.BadRequest(`invalid key: ${key}`, null);
         }
     });
 };
-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}`);
-    }
-};
-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) => {
+exports.validatePayload = ({ query = {}, order = [], attributes = [], }, 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;
@@ -89,14 +61,7 @@ exports.validatePayload = ({ query = {}, order = [], attributes = [], include =
     else {
         validateAttributes(attributes, rawAttributes);
     }
-    validateOrderAttributes(order, rawAttributes, associationModels);
+    validateOrderAttributes(order, rawAttributes);
     validateQueryPayload(query, rawAttributes);
-    if (include.length) {
-        validateIncludePayload(include, model === null || model === void 0 ? void 0 : model.associations);
-    }
-    validatePagination({
-        page,
-        perPage,
-    });
     return true;
 };

package/lib/validations/index.test.js

@@ -78,54 +78,4 @@ 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.2.1",
+  "version": "1.2.3-beta",
   "description": "manage cache",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",