@autofleet/sheilta 1.3.8 → 1.3.10-beta-34f81272.0

package/lib/formatter/index.d.ts

@@ -7,7 +7,7 @@ export declare type FormatPayloadOptions = {
     DBFormatter?: any;
     skipSearchTermFormat?: boolean;
 };
-declare const formatPayload: ({ order, page, perPage, include, query, attributes, searchTerm, }: {
+declare const formatPayload: ({ order, page, perPage, include, query, attributes, searchTerm, allowedSearchableAttributes, }: {
     order?: any[];
     page?: number;
     perPage?: number;
@@ -15,6 +15,7 @@ declare const formatPayload: ({ order, page, perPage, include, query, attributes
     query?: {};
     attributes?: any;
     searchTerm?: any;
+    allowedSearchableAttributes?: any;
 }, model?: any, options?: any) => {
     attributes: any[] | {
         include: any[];
@@ -24,8 +25,6 @@ declare const formatPayload: ({ order, page, perPage, include, query, attributes
     page: any;
     perPage: any;
     include: any;
-    scopes: (string | {
-        method: any[];
-    })[];
+    scopes: any[];
 };
 export default formatPayload;

package/lib/formatter/index.js

@@ -9,8 +9,9 @@ const utils_1 = require("../utils");
 const operators_1 = require("../operators");
 const DEFAULT_ORDER = 'id';
 const DESCENDING_KEY = 'DESC';
+const ASCENDING_KEY = 'ASC';
 const CUSTOM_FIELDS_QUERY_PREFIX = 'customFields.';
-const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
+const { CUSTOM_FIELDS_FILTER_SCOPE, CUSTOM_FIELDS_SORT_SCOPE } = common_types_1.customFields;
 const parseCustomFieldScopeQueryValue = (value) => {
     if (typeof value === 'string') {
         return value;
@@ -36,20 +37,43 @@ const getAttributeFromOrder = (order, options = {}) => {
     }, [[], []]);
     return [formattedOrder, attributes];
 };
-const formatOrder = ({ order, associationModels = [], }) => order.map((o) => {
-    const formattedOrder = [utils_1.extractAttributeNameFromOrder(o, associationModels)];
-    const isOrderDescOrder = utils_1.isOrderDesc(o);
-    const isOrderAssociation = utils_1.isAttributeByAssociation(isOrderDescOrder
-        ? o.split(utils_1.ORDER_PREFIX)[1]
-        : o, associationModels);
-    if (isOrderAssociation) {
-        formattedOrder.push(utils_1.extractAssociatedAttributeNameFromOrder(o));
-    }
-    if (isOrderDescOrder) {
-        formattedOrder.push(DESCENDING_KEY);
-    }
-    return formattedOrder;
-});
+const formatOrder = ({ order, associationModels = [], }) => {
+    const formattedOrders = [];
+    const orderScopesMap = new Map();
+    order.forEach((o) => {
+        if ([o, o.substring(1)].some(t => t.startsWith(CUSTOM_FIELDS_QUERY_PREFIX))) {
+            if (!orderScopesMap.has(CUSTOM_FIELDS_SORT_SCOPE)) {
+                orderScopesMap.set(CUSTOM_FIELDS_SORT_SCOPE, {});
+            }
+            const scopeKey = o.split(CUSTOM_FIELDS_QUERY_PREFIX)[1];
+            orderScopesMap.get(CUSTOM_FIELDS_SORT_SCOPE)[scopeKey] = (utils_1.isOrderDesc(o) ?
+                DESCENDING_KEY :
+                ASCENDING_KEY);
+            return;
+        }
+        const formattedOrder = [utils_1.extractAttributeNameFromOrder(o, associationModels)];
+        const isOrderDescOrder = utils_1.isOrderDesc(o);
+        const isOrderAssociation = utils_1.isAttributeByAssociation(isOrderDescOrder
+            ? o.split(utils_1.ORDER_PREFIX)[1]
+            : o, associationModels);
+        if (isOrderAssociation) {
+            formattedOrder.push(utils_1.extractAssociatedAttributeNameFromOrder(o));
+        }
+        if (isOrderDescOrder) {
+            formattedOrder.push(DESCENDING_KEY);
+        }
+        formattedOrders.push(formattedOrder);
+    });
+    return {
+        formattedOrders,
+        orderScopes: Array.from(orderScopesMap.entries()).map(([scopeName, scopeValue]) => {
+            if (!scopeValue) {
+                return scopeName;
+            }
+            return { method: [scopeName, scopeValue] };
+        }),
+    };
+};
 const formatPage = page => page || utils_1.PAGE_DEFAULT;
 const formatPerPage = perPage => perPage || utils_1.PER_PAGE_DEFAULT;
 const formatInclude = (include, associationsMap = {}) => {
@@ -94,29 +118,30 @@ const formatQuery = (query, associationModels) => {
 };
 const formatSearchTerm = (searchTerm, attributesToSend, rawAttributes) => ({
     $and: searchTerm.split(' ').map(term => ({
-        $or: attributesToSend.filter(attrKey => rawAttributes[attrKey].type.key === 'STRING').map(attr => ({
+        $or: attributesToSend.filter(attrKey => { var _a; return ((_a = rawAttributes[attrKey]) === null || _a === void 0 ? void 0 : _a.type.key) === 'STRING'; }).map(attr => ({
             [attr]: {
                 $iLike: `%${term}%`,
             },
         })),
     })),
 });
-const formatPayload = ({ order = [], page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, include = [], query = {}, attributes = null, searchTerm = null, }, model, options) => {
+const formatPayload = ({ order = [], page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, include = [], query = {}, attributes = null, searchTerm = null, allowedSearchableAttributes = null, }, model, options) => {
     const associationModels = Object.keys((model === null || model === void 0 ? void 0 : model.associations) || {});
-    const formattedOrder = formatOrder({
+    const { formattedOrders, orderScopes } = formatOrder({
         order: [...order, DEFAULT_ORDER],
         associationModels,
     });
-    const [filteredFormattedOrder, filteredLiteralAttributes] = getAttributeFromOrder(formattedOrder, options);
+    const [filteredFormattedOrder, filteredLiteralAttributes] = getAttributeFromOrder(formattedOrders, options);
     const allAttributes = [...filteredLiteralAttributes, ...(attributes || [])];
     const formattedAttribute = (attributes === null || attributes === void 0 ? void 0 : attributes.length) ? allAttributes : { include: allAttributes };
     const formattedInclude = formatInclude(include, model === null || model === void 0 ? void 0 : model.associations);
     const formattedPage = formatPage(page);
     const formattedPerPage = formatPerPage(perPage);
     const result = formatQuery(query, associationModels);
+    const queryScopes = result.formattedScopes;
     let { formattedQuery } = result;
     if (searchTerm && !(options === null || options === void 0 ? void 0 : options.skipSearchTermFormat)) {
-        const attributesToSend = (attributes === null || attributes === void 0 ? void 0 : attributes.length) ? attributes : Object.keys(model.rawAttributes);
+        const attributesToSend = allowedSearchableAttributes || ((attributes === null || attributes === void 0 ? void 0 : attributes.length) ? attributes : Object.keys(model.rawAttributes));
         const queryWithSearchTerm = formatSearchTerm(searchTerm, attributesToSend, model.rawAttributes);
         formattedQuery = lodash_1.default.isEmpty(formattedQuery) ? queryWithSearchTerm : {
             $and: [
@@ -125,6 +150,6 @@ const formatPayload = ({ order = [], page = utils_1.PAGE_DEFAULT, perPage = util
             ],
         };
     }
-    return Object.assign({ query: formattedQuery, order: filteredFormattedOrder, page: formattedPage, perPage: formattedPerPage, include: formattedInclude, scopes: result.formattedScopes }, (formattedAttribute && { attributes: formattedAttribute }));
+    return Object.assign({ query: formattedQuery, order: filteredFormattedOrder, page: formattedPage, perPage: formattedPerPage, include: formattedInclude, scopes: [...queryScopes, ...orderScopes] }, (formattedAttribute && { attributes: formattedAttribute }));
 };
 exports.default = formatPayload;

package/lib/middleware/index.js

@@ -25,6 +25,7 @@ const querySchema = joi_1.object({
     perPage: joi_1.number(),
     include: joi_1.array().items(joi_1.any()),
     searchTerm: joi_1.string(),
+    allowedSearchableAttributes: joi_1.array().items(joi_1.string()),
 });
 exports.newQueryValidationMiddleware = (inner = 'body') => (model, options = {}) => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
     const { query, attributes, order, page, perPage, include, } = req[inner];
@@ -56,7 +57,7 @@ exports.newQueryValidationMiddleware = (inner = 'body') => (model, options = {})
     }
 });
 exports.newQueryFormatMiddleware = (inner = 'body') => (model, options = {}) => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
-    const { order, page, perPage, include, query, attributes, searchTerm, } = req[inner];
+    const { order, page, perPage, include, query, attributes, searchTerm, allowedSearchableAttributes, } = req[inner];
     const { query: formattedQuery, order: formattedOrder, page: formattedPage, perPage: formattedPerPage, include: formattedInclude, scopes: formattedScopes, attributes: formattedAttribute, } = formatter_1.default({
         query,
         order,
@@ -65,6 +66,7 @@ exports.newQueryFormatMiddleware = (inner = 'body') => (model, options = {}) =>
         include,
         attributes,
         searchTerm,
+        allowedSearchableAttributes,
     }, model, options);
     req[inner].query = formattedQuery;
     req[inner].order = formattedOrder;
@@ -73,6 +75,7 @@ exports.newQueryFormatMiddleware = (inner = 'body') => (model, options = {}) =>
     req[inner].perPage = formattedPerPage;
     req[inner].include = formattedInclude;
     req[inner].scopes = formattedScopes;
+    req[inner].allowedSearchableAttributes = new Set(allowedSearchableAttributes);
     if (options.includeRawPayload) {
         req[inner].rawPayload = {
             order,

package/lib/validations/index.js

@@ -7,10 +7,23 @@ exports.validatePayload = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 const utils_1 = require("../utils");
 const operators_1 = require("../operators");
+const cleanAttributeFromPrefix = (attr, prefix) => {
+    if (attr.startsWith(prefix)) {
+        return attr.slice(1);
+    }
+    return attr.endsWith(prefix) ? attr.slice(0, -1) : attr;
+};
 const validateOperator = (operator) => operators_1.OPERATORS.includes(operator.split(operators_1.OPERATOR_PREFIX)[1]);
-const validateQueryAttribute = (attribute, modelAttributes = [], associationModels = []) => [...modelAttributes, ...associationModels]
-    .includes(attribute.includes(utils_1.ASSOCIATION_PREFIX)
-    ? attribute.split(utils_1.ASSOCIATION_PREFIX)[0] : attribute);
+const validateQueryAttribute = (attribute, modelAttributes = [], associationModels = []) => {
+    const attributes = [...modelAttributes, ...associationModels];
+    if (attribute.includes(utils_1.ASSOCIATION_PREFIX) && attribute.includes(operators_1.OPERATOR_PREFIX)) {
+        const parts = attribute.split(utils_1.ASSOCIATION_PREFIX);
+        return parts.every(part => attributes.includes(cleanAttributeFromPrefix(part, operators_1.OPERATOR_PREFIX)));
+    }
+    return attributes
+        .includes(attribute.includes(utils_1.ASSOCIATION_PREFIX)
+        ? attribute.split(utils_1.ASSOCIATION_PREFIX)[0] : attribute);
+};
 const validateSingleOrder = (currentOrder, rawAttributes, associationModels, options = {}) => {
     var _a, _b;
     const isOrderDescOrder = utils_1.isOrderDesc(currentOrder);
@@ -42,9 +55,8 @@ const validateAttributes = (attributes, rawAttributes) => {
 };
 const validateQueryPayload = (query, rawAttributes, associationModels = []) => {
     // eslint-disable-next-line array-callback-return
-    Object.keys(query).map((key) => {
-        const value = query[key];
-        if (lodash_1.default.isArray(value)) {
+    Object.entries(query).map(([key, value]) => {
+        if (Array.isArray(value)) {
             if (lodash_1.default.isObject(value[0])) {
                 value.map(v => validateQueryPayload(v, rawAttributes, associationModels));
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sheilta",
-  "version": "1.3.8",
+  "version": "1.3.10-beta-34f81272.0",
   "description": "manage cache",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -44,10 +44,12 @@
   },
   "homepage": "https://github.com/Autofleet/sheilta",
   "dependencies": {
-    "@autofleet/common-types": "^1.7.29",
+    "@autofleet/common-types": "^1.7.42",
     "@autofleet/errors": "^1.0.10",
+    "@autofleet/sadot": "^0.6.6",
     "joi": "^17.9.2",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "npm-watch": "^0.13.0"
   },
   "devDependencies": {
     "@types/jest": "^24.9.0",