@recursyve/nestjs-data-filter 11.4.0 → 11.5.0

package/lib/filter/controllers/dynamic-filter.controller.js

@@ -33,7 +33,7 @@ class DynamicFilterController {
     async filterCount(query, request) {
         query = this.transformQuery(query, request);
         const user = await this.getUser(request);
-        return this.filterService.count({ options: query, user });
+        return this.filterService.count({ options: query, request, user });
     }
     async downloadData(query, type, request) {
         query = this.transformQuery(query, request);

package/lib/filter/controllers/filter.controller.js

@@ -31,7 +31,7 @@ class FilterController {
     }
     async filterCount(query, request) {
         const user = await this.getUser(request);
-        return this.filterService.count({ options: query, user });
+        return this.filterService.count({ options: query, request, user });
     }
     async downloadData(query, type, request) {
         const user = await this.getUser(request);

package/lib/filter/filter.service.d.ts

@@ -15,6 +15,7 @@ import { FilterConfigurationModel } from "./models/filter-configuration.model";
 import { FilterResourceValueModel } from "./models/filter-resource-value.model";
 interface CountParams<Users extends DataFilterUserModel> {
     options: FilterQueryModel;
+    request: Request;
     user?: Users | null;
 }
 interface DownloadDataParams<Users extends DataFilterUserModel, Request> {
@@ -49,7 +50,7 @@ export declare class FilterService<Data> {
     count<Users extends DataFilterUserModel>(params: CountParams<Users>): Promise<number>;
     filter<Request, Users extends DataFilterUserModel>(params: FilterParams<DataFilterUserModel, Request>): Promise<FilterResultModel<Data>>;
     downloadData<Request>(params: DownloadDataParams<DataFilterUserModel, Request>): Promise<Buffer | string>;
-    getFindOptions(model: typeof M, query: QueryModel | undefined, data?: object): Promise<FindOptions>;
+    getFindOptions<Request>(model: typeof M, query: QueryModel | undefined, request: Request, user: DataFilterUserModel | null, data?: object): Promise<FindOptions>;
     private convertNumber;
     private init;
     private getInclude;

package/lib/filter/filter.service.js

@@ -90,7 +90,7 @@ let FilterService = FilterService_1 = class FilterService {
         var _a, _b;
         const { options } = params;
         const user = (_a = params.user) !== null && _a !== void 0 ? _a : null;
-        const countOptions = await this.getFindOptions(this.repository.model, options.query);
+        const countOptions = await this.getFindOptions(this.repository.model, options.query, params.request, user);
         if (options.search) {
             this.addSearchCondition(options.search, countOptions, (_b = user === null || user === void 0 ? void 0 : user.language) !== null && _b !== void 0 ? _b : null);
         }
@@ -103,7 +103,7 @@ let FilterService = FilterService_1 = class FilterService {
         if (options.order) {
             options.order = this.normalizeOrder(options.order);
         }
-        const countOptions = await this.getFindOptions(this.repository.model, options.query, options.data);
+        const countOptions = await this.getFindOptions(this.repository.model, options.query, request, user, options.data);
         if (options.search) {
             this.addSearchCondition(options.search, countOptions, (_b = user === null || user === void 0 ? void 0 : user.language) !== null && _b !== void 0 ? _b : null);
         }
@@ -124,7 +124,7 @@ let FilterService = FilterService_1 = class FilterService {
     async downloadData(params) {
         var _a, _b, _c;
         const { exportOptions, options, request, type, user } = params;
-        const findOptions = await this.getFindOptions(this.exportRepository.model, options.query);
+        const findOptions = await this.getFindOptions(this.exportRepository.model, options.query, request, user);
         if (options.order) {
             options.order = this.normalizeOrder(options.order);
         }
@@ -151,7 +151,7 @@ let FilterService = FilterService_1 = class FilterService {
             return await this.repository.downloadData(values, type, (_c = user === null || user === void 0 ? void 0 : user.language) !== null && _c !== void 0 ? _c : "fr", exportOptions);
         }
     }
-    async getFindOptions(model, query, data) {
+    async getFindOptions(model, query, request, user, data) {
         /**
          * Reset Geo localization filter state
          */
@@ -163,7 +163,7 @@ let FilterService = FilterService_1 = class FilterService {
             const havingConditions = [];
             option = {
                 ...option,
-                include: await this.getInclude(model, query, data),
+                include: await this.getInclude(model, query, request, user, data),
                 where: query.condition === "and" ? { [sequelize_1.Op.and]: whereConditions } : { [sequelize_1.Op.or]: whereConditions },
                 having: query.condition === "and" ? { [sequelize_1.Op.and]: havingConditions } : { [sequelize_1.Op.or]: havingConditions }
             };
@@ -203,7 +203,7 @@ let FilterService = FilterService_1 = class FilterService {
             this.definitions[key] = this.model[key];
         }
     }
-    async getInclude(model, query, data) {
+    async getInclude(model, query, request, user, data) {
         if (!query.rules) {
             return [];
         }
@@ -211,7 +211,7 @@ let FilterService = FilterService_1 = class FilterService {
         for (const rule of query.rules) {
             const m = rule;
             if (m.condition) {
-                includes.push(await this.getInclude(model, m, data));
+                includes.push(await this.getInclude(model, m, request, user, data));
                 continue;
             }
             const r = rule;
@@ -221,19 +221,19 @@ let FilterService = FilterService_1 = class FilterService {
             const filter = this.definitions[r.id];
             if (filter.rootFilter) {
                 const f = filter;
-                includes.push(...this.getFilterInclude(model, f.rootFilter, r, data));
+                includes.push(...this.getFilterInclude(model, f.rootFilter, r, request, user, data));
                 if (!f.lazyLoading) {
                     if (f.valueFilter) {
-                        includes.push(...this.getFilterInclude(model, f.valueFilter, r, data));
+                        includes.push(...this.getFilterInclude(model, f.valueFilter, r, request, user, data));
                     }
                 }
                 else if (f.getValueFilter && Array.isArray(r.value)) {
                     const valueFiler = await f.getValueFilter(r.value[0]);
-                    includes.push(...this.getFilterInclude(model, valueFiler, r, data));
+                    includes.push(...this.getFilterInclude(model, valueFiler, r, request, user, data));
                 }
             }
             else {
-                includes.push(...this.getFilterInclude(model, filter, r, data));
+                includes.push(...this.getFilterInclude(model, filter, r, request, user, data));
             }
         }
         return sequelize_utils_1.SequelizeUtils.reduceIncludes(includes, true);
@@ -386,7 +386,7 @@ let FilterService = FilterService_1 = class FilterService {
         const customAttributes = filter.order ? this.getOrderCustomAttribute(filter.order, filter.data) : [];
         const values = await repository.model.findAll({
             ...options,
-            attributes: [[sequelize_typescript_1.Sequelize.literal(`DISTINCT \`${this.repository.model.name}\`.\`id\``), "_id"], ...customAttributes],
+            attributes: [[sequelize_typescript_1.Sequelize.literal(`DISTINCT \`${this.repository.model.name}\`.\`id\``), "id"], ...customAttributes],
             limit: (_d = filter.page) === null || _d === void 0 ? void 0 : _d.size,
             offset: filter.page ? filter.page.number * filter.page.size + ((_e = filter.page.offset) !== null && _e !== void 0 ? _e : 0) : undefined,
             subQuery: false,
@@ -428,9 +428,9 @@ let FilterService = FilterService_1 = class FilterService {
         }
         return where;
     }
-    getFilterInclude(model, filter, rule, data) {
+    getFilterInclude(model, filter, rule, request, user, data) {
         const includes = [];
-        const paths = filter.getIncludePaths(rule, data);
+        const paths = filter.getIncludePaths(rule, request, user, data);
         for (const path of paths) {
             includes.push(this.sequelizeModelScanner.getIncludes(model, path, [], [], true));
         }
@@ -440,6 +440,9 @@ let FilterService = FilterService_1 = class FilterService {
             }
             return includes;
         }
+        if (typeof filter.where === "function") {
+            filter.where = filter.where({ request, user });
+        }
         return [
             ...includes,
             this.sequelizeModelScanner.getIncludes(model, {

package/lib/filter/filters/filter.d.ts

@@ -14,8 +14,13 @@ export interface FilterConditionRule {
     path?: string;
     operation: FilterOperators;
     value?: (unknown | unknown[]) | ((value: unknown | unknown[]) => unknown | unknown[]);
-    where?: IncludeWhereModel;
+    where?: IncludeWhereModel | IncludeWhereModalCallback;
 }
+export interface IncludeWhereModelContext<Request = unknown> {
+    request: Request;
+    user: DataFilterUserModel | null;
+}
+type IncludeWhereModalCallback = (context: IncludeWhereModelContext) => IncludeWhereModel;
 export interface FilterCondition {
     condition: Condition;
     rules: (FilterConditionRule | FilterCondition)[];
@@ -39,7 +44,7 @@ export interface BaseFilterDefinition {
     paranoid?: boolean;
     condition?: FilterCondition;
     group?: string;
-    where?: IncludeWhereModel;
+    where?: IncludeWhereModel | IncludeWhereModalCallback;
     pathCondition?: PathCondition;
     json?: JsonConfig;
     enabled?: ({ user, request }: EnabledConfig) => Promise<boolean>;
@@ -52,7 +57,7 @@ export interface FilterDefinition extends BaseFilterDefinition, IRule {
     type: FilterType;
     operators: (FilterOperatorTypes | CustomOperator)[];
     getConfig<Request>(key: string, req: Request, user?: DataFilterUserModel): Promise<FilterBaseConfigurationModel | null>;
-    getIncludePaths(rule: QueryRuleModel, data?: object): PathModel[];
+    getIncludePaths<Request>(rule: QueryRuleModel, request: Request, user: DataFilterUserModel | null, data?: object): PathModel[];
     getWhereOptions(rule: QueryRuleModel): Promise<WhereOptions | undefined>;
     getHavingOptions(rule: QueryRuleModel): Promise<WhereOptions | undefined>;
     usePathCondition(query: QueryModel): boolean;
@@ -79,7 +84,7 @@ export declare abstract class Filter implements FilterDefinition {
     removeOperators(...operator: (FilterOperatorTypes | CustomOperator)[]): Filter;
     setOperators(...operator: (FilterOperatorTypes | CustomOperator)[]): Filter;
     getConfig<Request = any>(key: string, request: Request, user?: DataFilterUserModel): Promise<FilterBaseConfigurationModel | null>;
-    getIncludePaths(rule: QueryRuleModel, data?: object): PathModel[];
+    getIncludePaths<Request>(rule: QueryRuleModel, request: Request, user: DataFilterUserModel | null, data?: object): PathModel[];
     getWhereOptions(rule: QueryRuleModel, name?: string): Promise<WhereOptions | undefined>;
     getHavingOptions(rule: QueryRuleModel): Promise<WhereOptions | undefined>;
     usePathCondition(query: QueryModel): boolean;

package/lib/filter/filters/filter.js

@@ -63,7 +63,7 @@ class Filter {
         }
         return config;
     }
-    getIncludePaths(rule, data) {
+    getIncludePaths(rule, request, user, data) {
         return [];
     }
     async getWhereOptions(rule, name) {

package/lib/filter/filters/options.filter.d.ts

@@ -33,7 +33,7 @@ export declare class OptionsFilter extends Filter implements OptionsFilterDefini
     options: OptionsFilterOption[];
     constructor(definition: BaseFilterDefinition & OptionsFilterDefinition);
     getConfig<Request>(key: string, request: Request, user?: DataFilterUserModel): Promise<OptionsFilterConfigurationModel | null>;
-    getIncludePaths(rule: QueryRuleModel, data?: object): PathModel[];
+    getIncludePaths<Request>(rule: QueryRuleModel, request: Request, user: DataFilterUserModel | null, data?: object): PathModel[];
     getWhereOptions(rule: QueryRuleModel): Promise<WhereOptions | undefined>;
     getHavingOptions(rule: QueryRuleModel): Promise<WhereOptions | undefined>;
     private getRulePaths;

package/lib/filter/filters/options.filter.js

@@ -51,13 +51,13 @@ class OptionsFilter extends filter_1.Filter {
             }))
         };
     }
-    getIncludePaths(rule, data) {
+    getIncludePaths(rule, request, user, data) {
         const option = this.options.find(x => x.key === rule.value);
         const condition = option === null || option === void 0 ? void 0 : option.condition;
         if (!condition) {
-            return super.getIncludePaths(rule);
+            return super.getIncludePaths(rule, request, user);
         }
-        return this.getRulePaths(condition.rules, data);
+        return this.getRulePaths(condition.rules, request, user, data);
     }
     async getWhereOptions(rule) {
         const option = this.options.find(x => x.key === rule.value);
@@ -93,11 +93,11 @@ class OptionsFilter extends filter_1.Filter {
             operation: (_a = option.operator) !== null && _a !== void 0 ? _a : rule.operation
         });
     }
-    getRulePaths(rules, data) {
+    getRulePaths(rules, request, user, data) {
         const paths = [];
         for (const rule of rules) {
             if (rule.rules) {
-                paths.push(...this.getRulePaths(rule.rules, data));
+                paths.push(...this.getRulePaths(rule.rules, request, user, data));
             }
             else if (rule.path) {
                 if (paths.every((path) => path.path !== rule.path)) {
@@ -105,6 +105,9 @@ class OptionsFilter extends filter_1.Filter {
                     if (!r.path) {
                         continue;
                     }
+                    if (typeof r.where === "function") {
+                        r.where = r.where({ request, user });
+                    }
                     paths.push({
                         path: r.path,
                         where: filter_utils_1.FilterUtils.generateWhereConditions(r.where, data)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@recursyve/nestjs-data-filter",
-    "version": "11.4.0",
+    "version": "11.5.0",
     "description": "NestJs DataFilter library",
     "main": "index.js",
     "scripts": {
@@ -10,7 +10,10 @@
         "pack:lib": "npm run build:lib && cd dist && npm pack",
         "publish-package": "npm run build:lib && npm run copy:lib && npm publish ./dist --access public",
         "publish-package:beta": "npm run publish-package -- --tag beta --access public",
-        "publish-package:dry-run": "npm run publish-package -- --dry-run"
+        "publish-package:dry-run": "npm run publish-package -- --dry-run",
+        "test": "jest",
+        "test:watch": "jest --watch",
+        "test:coverage": "jest --coverage"
     },
     "repository": {
         "type": "git",