@autofleet/sheilta 1.4.0 → 1.4.1-beta-test

package/lib/middleware/index.d.ts

@@ -7,6 +7,7 @@ export declare type LiteralAttribute = {
 };
 export declare type MiddlewareValidationOption = {
     literalAttributes?: LiteralAttribute[];
+    enrichmentAttributes?: string[];
 };
 export declare const newQueryValidationMiddleware: (inner?: string) => (model: any, options?: MiddlewareValidationOption) => (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>;

package/lib/middleware/index.js

@@ -25,9 +25,10 @@ const querySchema = joi_1.object({
     perPage: joi_1.number(),
     include: joi_1.array().items(joi_1.any()),
     searchTerm: joi_1.string(),
+    enrichments: 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];
+    const { query, attributes, order, page, perPage, include, enrichments, } = req[inner];
     try {
         const result = querySchema.validate(req[inner]);
         if (result.error) {
@@ -40,6 +41,7 @@ exports.newQueryValidationMiddleware = (inner = 'body') => (model, options = {})
             page,
             perPage,
             include,
+            enrichments,
         }, model, options);
         return next();
     }

package/lib/validations/index.d.ts

@@ -1,9 +1,10 @@
 import type { MiddlewareValidationOption } from '../middleware';
-export declare const validatePayload: ({ query, order, attributes, include, page, perPage, }: {
+export declare const validatePayload: ({ query, order, attributes, include, page, perPage, enrichments, }: {
     query?: {};
     order?: any[];
     attributes?: any[];
     include?: any[];
     page?: number;
     perPage?: number;
+    enrichments?: any[];
 }, model?: any, options?: MiddlewareValidationOption) => boolean;

package/lib/validations/index.js

@@ -40,6 +40,16 @@ const validateOrderAttributes = (order, rawAttributes, associationModels = [], o
 const validateAttributes = (attributes, rawAttributes) => {
     attributes.map(a => validateSingleAttribute(a, rawAttributes));
 };
+const validateEnrichments = (enrichments, options) => {
+    if (!(enrichments === null || enrichments === void 0 ? void 0 : enrichments.length)) {
+        return;
+    }
+    const invalidEnrichment = enrichments
+        .find(enrichment => { var _a; return !((_a = options === null || options === void 0 ? void 0 : options.enrichmentAttributes) === null || _a === void 0 ? void 0 : _a.includes(enrichment)); });
+    if (invalidEnrichment) {
+        utils_1.throwBadRequestError(`enrichment attribute ${invalidEnrichment} is invalid`);
+    }
+};
 const validateQueryPayload = (query, rawAttributes, associationModels = []) => {
     // eslint-disable-next-line array-callback-return
     Object.keys(query).map((key) => {
@@ -93,7 +103,7 @@ const validateIncludePayload = (include, associations) => {
         }
     });
 };
-exports.validatePayload = ({ query = {}, order = [], attributes = [], include = [], page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, }, model, options = {}) => {
+exports.validatePayload = ({ query = {}, order = [], attributes = [], include = [], page = utils_1.PAGE_DEFAULT, perPage = utils_1.PER_PAGE_DEFAULT, enrichments = [], }, model, options = {}) => {
     const rawAttributes = Object.keys(model.rawAttributes);
     const associationModels = Object.keys((model === null || model === void 0 ? void 0 : model.associations) || {});
     if (!attributes || attributes.length === 0) {
@@ -105,6 +115,7 @@ exports.validatePayload = ({ query = {}, order = [], attributes = [], include =
     }
     validateOrderAttributes(order, rawAttributes, associationModels, options);
     validateQueryPayload(query, rawAttributes, associationModels);
+    validateEnrichments(enrichments, options);
     if (include.length && typeof include === 'object') {
         validateIncludePayload(include, model === null || model === void 0 ? void 0 : model.associations);
     }

package/package.json

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