/
FilterBuilderState.ts
669 lines (603 loc) · 18.3 KB
/
FilterBuilderState.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module PropertyFilterBuilder
*/
import type { Draft } from "immer";
import { produce } from "immer";
import * as React from "react";
import type { PropertyDescription, PropertyValue } from "@itwin/appui-abstract";
import { PropertyValueFormat } from "@itwin/appui-abstract";
import { Guid } from "@itwin/core-bentley";
import type {
PropertyFilterBuilderRuleOperator,
PropertyFilterRuleGroupOperator,
} from "./Operators";
import {
isUnaryPropertyFilterBuilderOperator,
isUnaryPropertyFilterOperator,
} from "./Operators";
import type {
PropertyFilter,
PropertyFilterRule,
PropertyFilterRuleGroup,
} from "./Types";
import { isPropertyFilterRuleGroup } from "./Types";
import { UiComponents } from "../UiComponents";
import { PropertyFilterBuilderRuleRangeValue } from "./FilterBuilderRangeValue";
/**
* Data structure that describes [[PropertyFilterBuilder]] component state.
* @beta
*/
export interface PropertyFilterBuilderState {
/** Root group of rules in [[PropertyFilterBuilder]] component. */
rootGroup: PropertyFilterBuilderRuleGroup;
}
/**
* Type that describes [[PropertyFilterBuilder]] component group item.
* @beta
*/
export type PropertyFilterBuilderRuleGroupItem =
| PropertyFilterBuilderRuleGroup
| PropertyFilterBuilderRule;
/**
* Data structure that describes [[PropertyFilterBuilder]] component rule group.
* @beta
*/
export interface PropertyFilterBuilderRuleGroup {
/** Id of this rule group. */
id: string;
/** Id of rule group that this group is nested in. */
groupId?: string;
/** Operator that should join items in this group. */
operator: `${PropertyFilterRuleGroupOperator}`;
/** Items in this group. */
items: PropertyFilterBuilderRuleGroupItem[];
}
/**
* Data structure that describes [[PropertyFilterBuilder]] component single rule.
* @beta
*/
export interface PropertyFilterBuilderRule {
/** Id of this rule. */
id: string;
/** Id of rule group that this rule is nested in. */
groupId: string;
/** Property used in this rule. */
property?: PropertyDescription;
/** Operator that should be used to compare property value. */
operator?: PropertyFilterBuilderRuleOperator;
/** Value that property should be compared to. */
value?: PropertyValue;
/** Error message of this rule. */
errorMessage?: string;
}
/**
* Function to check if supplied [[PropertyFilterBuilderRuleGroupItem]] is [[PropertyFilterBuilderRuleGroup]].
* @beta
*/
export function isPropertyFilterBuilderRuleGroup(
item: PropertyFilterBuilderRuleGroupItem
): item is PropertyFilterBuilderRuleGroup {
return (item as any).items !== undefined;
}
/**
* Actions for controlling [[PropertyFilterBuilder]] component state.
* @beta
*/
export class PropertyFilterBuilderActions {
constructor(
private setState: (
setter: (
prevState: PropertyFilterBuilderState
) => PropertyFilterBuilderState
) => void
) {}
private updateState(
updater: (state: Draft<PropertyFilterBuilderState>) => void
) {
this.setState(produce(updater));
}
/** Adds new rule or group of rules to the group specified by path. */
public addItem(path: string[], itemType: "RULE_GROUP" | "RULE") {
this.updateState((state) => {
const parentGroup = findRuleGroup(state.rootGroup, path);
if (!parentGroup) return;
const item =
itemType === "RULE_GROUP"
? createEmptyRuleGroup(parentGroup.id)
: createEmptyRule(parentGroup.id);
parentGroup.items.push(item);
});
}
/** Removes item specified by path. */
public removeItem(path: string[]) {
function removeItemFromGroup(
state: Draft<PropertyFilterBuilderState>,
pathToItem: string[]
) {
const pathToParent = pathToItem.slice(0, -1);
const parentGroup = findRuleGroup(state.rootGroup, pathToParent);
if (!parentGroup) {
return;
}
const itemId = pathToItem[pathToItem.length - 1];
const itemIndex = parentGroup.items.findIndex(
(item) => item.id === itemId
);
if (itemIndex === -1) {
return;
}
if (parentGroup.items.length === 1) {
parentGroup.items[0] = createEmptyRule(parentGroup.id);
return;
}
parentGroup.items.splice(itemIndex, 1);
}
this.updateState((state) => {
removeItemFromGroup(state, path);
});
}
/** Removes all items from root group. */
public removeAllItems() {
this.updateState((state) => {
state.rootGroup = createEmptyRuleGroup();
});
}
/** Sets operator of rule group specified by the path. */
public setRuleGroupOperator(
path: string[],
operator: `${PropertyFilterRuleGroupOperator}`
) {
this.updateState((state) => {
const group = findRuleGroup(state.rootGroup, path);
if (!group) {
return;
}
group.operator = operator;
});
}
/** Sets property of rule specified by the path. */
public setRuleProperty(path: string[], property?: PropertyDescription) {
this.updateState((state) => {
const rule = findRule(state.rootGroup, path);
if (!rule) {
return;
}
rule.property = property;
rule.operator = undefined;
rule.value = undefined;
rule.errorMessage = undefined;
});
}
/** Sets operator of rule specified by the path. */
public setRuleOperator(
path: string[],
operator: PropertyFilterBuilderRuleOperator
) {
this.updateState((state) => {
const rule = findRule(state.rootGroup, path);
if (!rule) {
return;
}
if (isUnaryPropertyFilterBuilderOperator(operator)) {
rule.value = undefined;
}
if (
operator !== rule.operator &&
!areOperatorsSimilar(operator, rule.operator)
) {
rule.value = undefined;
}
rule.operator = operator;
});
}
/** Sets value of rule specified by the path. */
public setRuleValue(path: string[], value: PropertyValue) {
this.updateState((state) => {
const rule = findRule(state.rootGroup, path);
if (!rule) {
return;
}
rule.value = value;
});
}
/**
* Sets error messages of the rules specified by id.
* If rule id is not present in the map, then its error message will be cleared.
*/
public setRuleErrorMessages(ruleIdsAndErrorMessages: Map<string, string>) {
this.updateState((state) => {
const setErrorMessages = (item: PropertyFilterBuilderRuleGroupItem) => {
if (isPropertyFilterBuilderRuleGroup(item)) {
item.items.forEach((itm) => {
setErrorMessages(itm);
});
} else {
item.errorMessage = ruleIdsAndErrorMessages.get(item.id);
}
};
setErrorMessages(state.rootGroup);
});
}
}
/**
* Props for [[usePropertyFilterBuilder]]
* @beta
*/
export interface UsePropertyFilterBuilderProps {
/** Initial filter for [[PropertyFilterBuilder]] */
initialFilter?: PropertyFilter;
/** Custom rule validator to be used when [[UsePropertyFilterBuilderResult.buildFilter]] is invoked. Should return error message or `undefined`, if rule is valid. */
ruleValidator?: (rule: PropertyFilterBuilderRule) => string | undefined;
}
/**
* Options for [[UsePropertyFilterBuilderResult.buildFilter]].
* @beta
*/
export interface BuildFilterOptions {
/**
* Specifies whether errors encountered while validating filter rules should be ignored and not persisted in state.
* This is useful in case component needs to get filter matching rule validator but does not want to show errors in UI.
*/
ignoreErrors?: boolean;
}
/**
* Type for [[usePropertyFilterBuilder]] return object.
* @beta
*/
export interface UsePropertyFilterBuilderResult {
/** Root group of the [[PropertyFilterBuilder]]. */
rootGroup: PropertyFilterBuilderRuleGroup;
/** Actions for manipulating [[PropertyFilterBuilder]] state. */
actions: PropertyFilterBuilderActions;
/**
* Validates and builds [[PropertyFilter]] based on current state. It uses [[defaultPropertyFilterBuilderRuleValidator]] or
* custom validator provided through [[UsePropertyFilterBuilderProps]] to validate each rule.
* @returns [[PropertyFilter]] if all rules are valid, `undefined` otherwise.
*/
buildFilter: (options?: BuildFilterOptions) => PropertyFilter | undefined;
}
/**
* Custom hook that creates state for [[PropertyFilterBuilder]] component. It creates empty state or initializes
* state from supplied initial filter.
* @beta
*/
export function usePropertyFilterBuilder(
props?: UsePropertyFilterBuilderProps
): UsePropertyFilterBuilderResult {
const { initialFilter, ruleValidator } = props ?? {
initialFilter: undefined,
ruleValidator: undefined,
};
const [state, setState] = React.useState<PropertyFilterBuilderState>(
initialFilter
? convertFilterToState(initialFilter)
: { rootGroup: createEmptyRuleGroup() }
);
const [actions] = React.useState(
() => new PropertyFilterBuilderActions(setState)
);
const buildFilter = React.useCallback(
(options?: BuildFilterOptions) => {
const ruleErrors = validateRules(state.rootGroup, ruleValidator);
if (!options?.ignoreErrors) {
actions.setRuleErrorMessages(ruleErrors);
}
return ruleErrors.size === 0
? buildPropertyFilter(state.rootGroup)
: undefined;
},
[state.rootGroup, actions, ruleValidator]
);
return { rootGroup: state.rootGroup, actions, buildFilter };
}
function validateRules(
rule: PropertyFilterBuilderRuleGroupItem,
ruleValidator?: (item: PropertyFilterBuilderRule) => string | undefined
) {
const ruleIdsAndErrorMessages = new Map<string, string>();
const validateRulesInner = (item: PropertyFilterBuilderRuleGroupItem) => {
if (isPropertyFilterBuilderRuleGroup(item)) {
item.items.forEach((itm) => {
validateRulesInner(itm);
});
} else {
const errorMessage = ruleValidator
? ruleValidator(item)
: defaultPropertyFilterBuilderRuleValidator(item);
if (errorMessage) ruleIdsAndErrorMessages.set(item.id, errorMessage);
}
};
validateRulesInner(rule);
return ruleIdsAndErrorMessages;
}
/**
* Default rule validator.
* @beta
*/
export function defaultPropertyFilterBuilderRuleValidator(
item: PropertyFilterBuilderRule
): string | undefined {
if (
item.property === undefined ||
item.operator === undefined ||
isUnaryPropertyFilterBuilderOperator(item.operator)
) {
return undefined;
}
if (item.operator === "between" || item.operator === "not-between") {
return rangeRuleValidator(item.value);
}
if (isEmptyValue(item.value)) {
return UiComponents.translate("filterBuilder.errorMessages.emptyValue");
}
return undefined;
}
function rangeRuleValidator(value?: PropertyValue) {
const range = PropertyFilterBuilderRuleRangeValue.parse(value);
if (isEmptyValue(range.from) || isEmptyValue(range.to)) {
return UiComponents.translate("filterBuilder.errorMessages.emptyValue");
}
if (!PropertyFilterBuilderRuleRangeValue.isRangeValid(range)) {
return UiComponents.translate("filterBuilder.errorMessages.invalidRange");
}
return undefined;
}
/** @internal */
export function buildPropertyFilter(
groupItem: PropertyFilterBuilderRuleGroupItem
): PropertyFilter | undefined {
if (isPropertyFilterBuilderRuleGroup(groupItem))
return buildPropertyFilterFromRuleGroup(groupItem);
return buildPropertyFilterFromRule(groupItem);
}
function buildPropertyFilterFromRuleGroup(
rootGroup: PropertyFilterBuilderRuleGroup
): PropertyFilter | undefined {
const rules = new Array<PropertyFilter>();
for (const item of rootGroup.items) {
const rule = buildPropertyFilter(item);
if (rule) rules.push(rule);
}
if (rules.length === 0) return undefined;
if (rules.length === 1 && !isPropertyFilterRuleGroup(rules[0])) {
return rules[0];
}
return {
operator: rootGroup.operator,
rules,
};
}
function buildPropertyFilterFromRule(
rule: PropertyFilterBuilderRule
): PropertyFilter | undefined {
const { property, operator, value } = rule;
if (!property || operator === undefined) {
return undefined;
}
if (operator === "between" || operator === "not-between") {
return buildPropertyFilterFromRangeRule({
...rule,
property,
operator,
value,
});
}
if (!isUnaryPropertyFilterOperator(operator) && isEmptyValue(value)) {
return undefined;
}
return { property, operator, value };
}
function buildPropertyFilterFromRangeRule(
rule: PropertyFilterBuilderRule & {
property: PropertyDescription;
operator: "between" | "not-between";
}
): PropertyFilter | undefined {
const { property, operator, value } = rule;
if (
!value ||
value.valueFormat !== PropertyValueFormat.Primitive ||
typeof value.value !== "string"
) {
return undefined;
}
const { to, from } = PropertyFilterBuilderRuleRangeValue.parse(value);
if (isEmptyValue(to) || isEmptyValue(from)) {
return undefined;
}
return {
operator: operator === "between" ? "and" : "or",
rules: [
{
property,
operator: operator === "between" ? "greater-or-equal" : "less",
value: from,
},
{
property,
operator: operator === "between" ? "less-or-equal" : "greater",
value: to,
},
],
};
}
function createEmptyRule(groupId: string): PropertyFilterBuilderRule {
return {
id: Guid.createValue(),
groupId,
};
}
function createEmptyRuleGroup(
groupId?: string
): PropertyFilterBuilderRuleGroup {
const id = Guid.createValue();
return {
id,
groupId,
operator: "and",
items: [createEmptyRule(id)],
};
}
function findRuleGroup(
rootGroup: PropertyFilterBuilderRuleGroup,
path: string[]
): PropertyFilterBuilderRuleGroup | undefined {
if (path.length === 0) return rootGroup;
const [currentItemId, ...rest] = path;
const currentItem = rootGroup.items.find((item) => item.id === currentItemId);
if (!currentItem || !isPropertyFilterBuilderRuleGroup(currentItem))
return undefined;
return findRuleGroup(currentItem, rest);
}
function findRule(
rootGroup: PropertyFilterBuilderRuleGroup,
path: string[]
): PropertyFilterBuilderRule | undefined {
if (path.length === 0) return undefined;
const [currentItemId, ...rest] = path;
const currentItem = rootGroup.items.find((item) => item.id === currentItemId);
if (!currentItem) return undefined;
if (isPropertyFilterBuilderRuleGroup(currentItem))
return findRule(currentItem, rest);
return currentItem;
}
function getRuleGroupItem(
filter: PropertyFilter,
parentId: string
): PropertyFilterBuilderRuleGroupItem {
const id = Guid.createValue();
if (isPropertyFilterRuleGroup(filter)) {
const rangeRule = getRangeRuleItems(filter, parentId);
return rangeRule
? rangeRule
: {
id,
groupId: parentId,
operator: filter.operator,
items: filter.rules.map((rule) => getRuleGroupItem(rule, id)),
};
}
return getRuleItem(filter, id);
}
function getRuleItem(filter: PropertyFilterRule, parentId: string) {
return {
id: Guid.createValue(),
groupId: parentId,
property: filter.property,
operator: filter.operator,
value: filter.value,
};
}
function getRangeRuleItems(
group: PropertyFilterRuleGroup,
parentId: string
): PropertyFilterBuilderRuleGroupItem | undefined {
if (group.rules.length !== 2) {
return undefined;
}
const [from, to] = group.rules;
if (
isPropertyFilterRuleGroup(from) ||
!from.value ||
from.value.valueFormat !== PropertyValueFormat.Primitive ||
isPropertyFilterRuleGroup(to) ||
!to.value ||
to.value.valueFormat !== PropertyValueFormat.Primitive ||
from.property.name !== to.property.name
) {
return undefined;
}
if (
from.operator === "greater-or-equal" &&
to.operator === "less-or-equal" &&
group.operator === "and"
) {
return {
id: Guid.createValue(),
groupId: parentId,
operator: "between",
property: from.property,
value: PropertyFilterBuilderRuleRangeValue.serialize({
from: from.value,
to: to.value,
}),
};
}
if (
from.operator === "less" &&
to.operator === "greater" &&
group.operator === "or"
) {
return {
id: Guid.createValue(),
groupId: parentId,
operator: "not-between",
property: from.property,
value: PropertyFilterBuilderRuleRangeValue.serialize({
from: from.value,
to: to.value,
}),
};
}
return undefined;
}
function convertFilterToState(
filter: PropertyFilter
): PropertyFilterBuilderState {
const id = Guid.createValue();
if (isPropertyFilterRuleGroup(filter)) {
return {
rootGroup: {
id,
operator: filter.operator,
items: filter.rules.map((rule) => getRuleGroupItem(rule, id)),
},
};
}
return {
rootGroup: {
id,
operator: "and",
items: [getRuleItem(filter, id)],
},
};
}
function isEmptyValue(value?: PropertyValue) {
return (
value?.valueFormat !== PropertyValueFormat.Primitive ||
value.value === undefined ||
value.value === ""
);
}
function areOperatorsSimilar(
firstOperator?: PropertyFilterBuilderRuleOperator,
secondOperator?: PropertyFilterBuilderRuleOperator
) {
return (
(isOperatorEqualOrIsNotEqual(firstOperator) &&
isOperatorEqualOrIsNotEqual(secondOperator)) ||
(isInequalityOperator(firstOperator) &&
isInequalityOperator(secondOperator)) ||
(isRangeOperator(firstOperator) && isRangeOperator(secondOperator))
);
}
function isOperatorEqualOrIsNotEqual(
operator?: PropertyFilterBuilderRuleOperator
) {
return operator === "is-equal" || operator === "is-not-equal";
}
function isInequalityOperator(operator?: PropertyFilterBuilderRuleOperator) {
return (
operator === "less" ||
operator === "less-or-equal" ||
operator === "greater" ||
operator === "greater-or-equal"
);
}
function isRangeOperator(operator?: PropertyFilterBuilderRuleOperator) {
return operator === "between" || operator === "not-between";
}