@autofleet/sheilta 1.2.9-beta → 1.3.0

package/lib/formatter/index.d.ts

@@ -17,5 +17,8 @@ declare const formatPayload: ({ order, page, perPage, include, query, attributes
     page: any;
     perPage: any;
     include: any;
+    scopes: (string | {
+        method: any[];
+    })[];
 };
 export default formatPayload;

package/lib/formatter/index.js

@@ -4,9 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const lodash_1 = __importDefault(require("lodash"));
+const common_types_1 = require("@autofleet/common-types");
 const utils_1 = require("../utils");
 const DEFAULT_ORDER = 'id';
 const DESCENDING_KEY = 'DESC';
+const CUSTOM_FIELDS_QUERY_PREFIX = 'customFields.';
+const { CUSTOM_FIELDS_FILTER_SCOPE } = common_types_1.customFields;
 const formatOrder = ({ order, associationModels = [], }) => order.map((o) => {
     const formattedOrder = [utils_1.extractAttributeNameFromOrder(o, associationModels)];
     const isOrderDescOrder = utils_1.isOrderDesc(o);
@@ -28,8 +31,33 @@ const formatInclude = (include, associationsMap = {}) => {
     formattedInclude = formattedInclude.map(i => lodash_1.default.omit(i, ['model']));
     return formattedInclude;
 };
-const formatQuery = (query, associationModels) => Object.keys(query).reduce((acc, queryItemKey) => (Object.assign(Object.assign({}, acc), { [utils_1.isAttributeByAssociation(queryItemKey, associationModels)
-        ? utils_1.wrapAttributeWithOperator(queryItemKey) : queryItemKey]: query[queryItemKey] })), {});
+const formatQuery = (query, associationModels) => {
+    const formattedQuery = {};
+    const formattedScopeMap = new Map();
+    Object.entries(query).forEach(([queryItemKey, queryItemValue]) => {
+        if (queryItemKey.startsWith(CUSTOM_FIELDS_QUERY_PREFIX)) {
+            if (!formattedScopeMap.has(CUSTOM_FIELDS_FILTER_SCOPE)) {
+                formattedScopeMap.set(CUSTOM_FIELDS_FILTER_SCOPE, {});
+            }
+            formattedScopeMap.get(CUSTOM_FIELDS_FILTER_SCOPE)[queryItemKey] = queryItemValue;
+            return;
+        }
+        const key = utils_1.isAttributeByAssociation(queryItemKey, associationModels) ?
+            utils_1.wrapAttributeWithOperator(queryItemKey) :
+            queryItemKey;
+        formattedQuery[key] = queryItemValue;
+    });
+    const formattedScopes = Array.from(formattedScopeMap.entries()).map(([scopeName, scopeValue]) => {
+        if (!scopeValue) {
+            return scopeName;
+        }
+        return { method: [scopeName, scopeValue] };
+    });
+    return {
+        formattedQuery,
+        formattedScopes,
+    };
+};
 const formatSearchTerm = (searchTerm, attributesToSend, rawAttributes) => ({
     $and: searchTerm.split(' ').map(term => ({
         $or: attributesToSend.filter(attrKey => rawAttributes[attrKey].type.key === 'STRING').map(attr => ({
@@ -48,7 +76,8 @@ const formatPayload = ({ order = [], page = utils_1.PAGE_DEFAULT, perPage = util
     const formattedInclude = formatInclude(include, model === null || model === void 0 ? void 0 : model.associations);
     const formattedPage = formatPage(page);
     const formattedPerPage = formatPerPage(perPage);
-    let formattedQuery = formatQuery(query, associationModels);
+    const result = formatQuery(query, associationModels);
+    let { formattedQuery } = result;
     if (searchTerm) {
         const attributesToSend = (attributes === null || attributes === void 0 ? void 0 : attributes.length) ? attributes : Object.keys(model.rawAttributes);
         const queryWithSearchTerm = formatSearchTerm(searchTerm, attributesToSend, model.rawAttributes);
@@ -65,6 +94,7 @@ const formatPayload = ({ order = [], page = utils_1.PAGE_DEFAULT, perPage = util
         page: formattedPage,
         perPage: formattedPerPage,
         include: formattedInclude,
+        scopes: result.formattedScopes,
     };
 };
 exports.default = formatPayload;

package/lib/formatter/index.test.js

@@ -135,13 +135,13 @@ describe('formatting test', () => {
             const { order } = _1.default({
                 order: ['startTime', '-endTime'],
             });
-            expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime', 'DESC']]));
+            expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime', 'DESC'], ['id']]));
         });
         it('simple check asc', () => {
             const { order } = _1.default({
                 order: ['startTime', 'endTime'],
             });
-            expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime']]));
+            expect(JSON.stringify(order)).toBe(JSON.stringify([['startTime'], ['endTime'], ['id']]));
         });
         it('by included model', () => {
             const { order } = _1.default({
@@ -154,7 +154,7 @@ describe('formatting test', () => {
                     status: {},
                 },
             });
-            expect(JSON.stringify(order)).toBe(JSON.stringify([['status', 'name']]));
+            expect(JSON.stringify(order)).toBe(JSON.stringify([['status', 'name'], ['id']]));
         });
         it('by included model descending', () => {
             const { order } = _1.default({
@@ -167,7 +167,7 @@ describe('formatting test', () => {
                     status: {},
                 },
             });
-            expect(JSON.stringify(order)).toBe(JSON.stringify([['status', 'name', 'DESC']]));
+            expect(JSON.stringify(order)).toBe(JSON.stringify([['status', 'name', 'DESC'], ['id']]));
         });
         it('by json field', () => {
             const { order } = _1.default({
@@ -177,7 +177,7 @@ describe('formatting test', () => {
                     startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', json: '',
                 },
             });
-            expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name']]));
+            expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name'], ['id']]));
         });
         it('by json field descending', () => {
             const { order } = _1.default({
@@ -187,7 +187,7 @@ describe('formatting test', () => {
                     startTime: '', endTime: '', currencySymbol: '', currencyCode: '', startStationId: '', json: '',
                 },
             });
-            expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name', 'DESC']]));
+            expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name', 'DESC'], ['id']]));
         });
     });
     describe('include formatting', () => {

package/lib/middleware/index.d.ts

@@ -1,5 +1,5 @@
 import { FormatPayloadOptions } from '../formatter';
-export declare const newQueryValidationMiddleware: (inner?: string) => (model: any) => (req: any, res: any, next: any) => Promise<any>;
-export declare const newQueryFormatMiddleware: (inner?: string) => (model: any, options?: FormatPayloadOptions) => (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, options?: FormatPayloadOptions) => (req: any, res: any, next: any) => Promise<any>;
+export declare const newQueryValidationMiddleware: (inner?: string) => (model: any) => (req: any, res: any, next: any) => Promise<void>;
+export declare const newQueryFormatMiddleware: (inner?: string) => (model: any, options?: FormatPayloadOptions) => (req: any, res: any, next: any) => Promise<void>;
+export declare const queryValidationMiddleware: (model: any) => (req: any, res: any, next: any) => Promise<void>;
+export declare const queryFormatMiddleware: (model: any, options?: FormatPayloadOptions) => (req: any, res: any, next: any) => Promise<void>;

package/lib/middleware/index.js

@@ -57,7 +57,7 @@ exports.newQueryValidationMiddleware = (inner = 'body') => model => (req, res, n
 });
 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 { query: formattedQuery, order: formattedOrder, page: formattedPage, perPage: formattedPerPage, include: formattedInclude, } = formatter_1.default({
+    const { query: formattedQuery, order: formattedOrder, page: formattedPage, perPage: formattedPerPage, include: formattedInclude, scopes: formattedScopes, } = formatter_1.default({
         query,
         order,
         page,
@@ -71,6 +71,7 @@ exports.newQueryFormatMiddleware = (inner = 'body') => (model, options = {}) =>
     req[inner].page = formattedPage;
     req[inner].perPage = formattedPerPage;
     req[inner].include = formattedInclude;
+    req[inner].scopes = formattedScopes;
     if (options.includeRawPayload) {
         req[inner].rawPayload = {
             order,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/sheilta",
-  "version": "1.2.9-beta",
+  "version": "1.3.0",
   "description": "manage cache",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -27,13 +27,14 @@
   },
   "homepage": "https://github.com/Autofleet/sheilta",
   "dependencies": {
+    "@autofleet/common-types": "^1.7.29",
     "@autofleet/errors": "^1.0.10",
-    "@types/node": "^14.14.20",
     "joi": "^17.9.2",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@types/jest": "^24.9.0",
+    "@types/node": "^16.11.68",
     "@typescript-eslint/eslint-plugin": "^2.34.0",
     "@typescript-eslint/parser": "^2.23.0",
     "eslint": "^6.8.0",