@autofleet/sheilta 1.2.6 → 1.2.8

package/lib/formatter/index.d.ts

@@ -1,5 +1,8 @@
 declare type OrderItem = string | [string, string];
 declare type SequelizeOrder = string | OrderItem[];
+export declare type FormatPayloadOptions = {
+    includeRawPayload?: boolean;
+};
 declare const formatPayload: ({ order, page, perPage, include, query, attributes, searchTerm, }: {
     order: any;
     page?: number;

package/lib/formatter/index.js

@@ -24,7 +24,7 @@ const formatOrder = ({ order = [], associationModels = [], }) => (order.length =
 const formatPage = page => page || utils_1.PAGE_DEFAULT;
 const formatPerPage = perPage => perPage || utils_1.PER_PAGE_DEFAULT;
 const formatInclude = (include, associationsMap = {}) => {
-    let formattedInclude = include.map(i => (Object.assign(Object.assign({}, i), { association: associationsMap[i.association || i.model], required: i.required !== 'false' })));
+    let formattedInclude = include.map(i => (Object.assign(Object.assign({}, i), { association: associationsMap[i.association || i.model], required: i.required !== false })));
     formattedInclude = formattedInclude.map(i => lodash_1.default.omit(i, ['model']));
     return formattedInclude;
 };

package/lib/formatter/index.test.js

@@ -190,4 +190,33 @@ describe('formatting test', () => {
             expect(JSON.stringify(order)).toBe(JSON.stringify([['status.name', 'DESC']]));
         });
     });
+    describe('include formatting', () => {
+        it('include required should be true', () => {
+            const { include } = _1.default({
+                order: [],
+                include: [{
+                        model: 'status',
+                    }],
+            }, {
+                associations: {
+                    status: {},
+                },
+            });
+            expect(include[0].required).toBe(true);
+        });
+        it('include required should be false', () => {
+            const { include } = _1.default({
+                order: [],
+                include: [{
+                        model: 'status',
+                        required: false,
+                    }],
+            }, {
+                associations: {
+                    status: {},
+                },
+            });
+            expect(include[0].required).toBe(false);
+        });
+    });
 });

package/lib/middleware/index.d.ts

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

package/lib/middleware/index.js

@@ -24,6 +24,7 @@ const querySchema = joi_1.object({
     page: joi_1.number(),
     perPage: joi_1.number(),
     include: joi_1.array().items(joi_1.any()),
+    searchTerm: joi_1.string(),
 });
 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];
@@ -54,7 +55,7 @@ exports.newQueryValidationMiddleware = (inner = 'body') => model => (req, res, n
         });
     }
 });
-exports.newQueryFormatMiddleware = (inner = 'body') => model => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+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({
         query,
@@ -70,6 +71,17 @@ exports.newQueryFormatMiddleware = (inner = 'body') => model => (req, res, next)
     req[inner].page = formattedPage;
     req[inner].perPage = formattedPerPage;
     req[inner].include = formattedInclude;
+    if (options.includeRawPayload) {
+        req[inner].rawPayload = {
+            order,
+            page,
+            perPage,
+            include,
+            query,
+            attributes,
+            searchTerm,
+        };
+    }
     return next();
 });
 exports.queryValidationMiddleware = exports.newQueryValidationMiddleware();

package/package.json

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