-
Notifications
You must be signed in to change notification settings - Fork 0
/
PresentationInstanceFilter.ts
574 lines (501 loc) · 20.2 KB
/
PresentationInstanceFilter.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
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module InstancesFilter
*/
import { Primitives, PrimitiveValue, PropertyValueFormat } from "@itwin/appui-abstract";
import {
isPropertyFilterRuleGroup,
PropertyFilter,
PropertyFilterRule,
PropertyFilterRuleGroup,
PropertyFilterRuleGroupOperator,
PropertyFilterRuleOperator,
} from "@itwin/components-react";
import { assert } from "@itwin/core-bentley";
import {
GenericInstanceFilter,
GenericInstanceFilterRelatedInstanceDescription,
GenericInstanceFilterRelationshipStep,
GenericInstanceFilterRule,
GenericInstanceFilterRuleGroup,
GenericInstanceFilterRuleValue,
} from "@itwin/core-common";
import {
ClassInfo,
Descriptor,
Field,
NestedContentField,
PresentationError,
PresentationStatus,
PropertiesField,
RelationshipPath,
Value,
} from "@itwin/presentation-common";
import { deserializeUniqueValues, findField, serializeUniqueValues, UniqueValue } from "../common/Utils";
import { createPropertyInfoFromPropertiesField, getInstanceFilterFieldName } from "./Utils";
/**
* Type that describes instance filter based on [Descriptor]($presentation-common) fields. It can be
* one filter condition or group of filter conditions joined by logical operator.
* @beta
*/
export type PresentationInstanceFilter = PresentationInstanceFilterConditionGroup | PresentationInstanceFilterCondition;
/**
* Data structure that describes group of filter condition joined by logical operator.
* @beta
*/
export interface PresentationInstanceFilterConditionGroup {
/** Operator that should be used to join conditions. */
operator: `${PropertyFilterRuleGroupOperator}`;
/** Conditions in this group. */
conditions: PresentationInstanceFilter[];
}
/**
* Data structure that describes single filter condition.
* @beta
*/
export interface PresentationInstanceFilterCondition {
/** [PropertiesField]($presentation-common) that contains property used in this condition. */
field: PropertiesField;
/** Operator that should be used to compare property value. */
operator: `${PropertyFilterRuleOperator}`;
/** Value that property should be compared to. */
value?: PrimitiveValue;
}
/** @beta */
// eslint-disable-next-line @typescript-eslint/no-redeclare
export namespace PresentationInstanceFilter {
/**
* Converts filter built by [usePropertyFilterBuilder]($components-react) into presentation specific format.
* @throws if presentation data cannot be found for properties used in `filter`.
*
* @beta
*/
export function fromComponentsPropertyFilter(descriptor: Descriptor, filter: PropertyFilter): PresentationInstanceFilter {
if (isPropertyFilterRuleGroup(filter)) {
return createPresentationInstanceFilterConditionGroup(descriptor, filter);
}
return createPresentationInstanceFilterCondition(descriptor, filter);
}
/**
* Converts [[PresentationInstanceFilter]] into format used by [usePropertyFilterBuilder]($components-react).
* @throws if fields used in filter cannot be found in `descriptor`.
*
* @beta
*/
export function toComponentsPropertyFilter(descriptor: Descriptor, filter: PresentationInstanceFilter): PropertyFilter {
if (PresentationInstanceFilter.isConditionGroup(filter)) {
return createPropertyFilterRuleGroup(filter, descriptor);
}
return createPropertyFilterRule(filter, descriptor);
}
/**
* Extracts information from [[PresentationInstanceFilter]] and creates a [GenericInstanceFilter]($common) for building queries.
* @beta
*/
export function toGenericInstanceFilter(filter: PresentationInstanceFilter, filteredClasses?: ClassInfo[]): GenericInstanceFilter {
const context: ConvertContext = { relatedInstances: [], propertyClasses: [], usedRelatedAliases: new Map<string, number>() };
const rules = createGenericInstanceFilter(filter, context);
return {
rules,
relatedInstances: context.relatedInstances.map((instance) => ({ path: toRelationshipStep(instance.path), alias: instance.alias })),
propertyClassNames: context.propertyClasses.map((classInfo) => classInfo.name),
filteredClassNames: filteredClasses?.map((classInfo) => classInfo.name),
};
}
/**
* Creates [[PresentationInstanceFilter]] from given [GenericInstanceFilter]($common).
* @throws if fields used in `filter` cannot be found in `descriptor`.
* @beta
*/
export function fromGenericInstanceFilter(descriptor: Descriptor, filter: GenericInstanceFilter): PresentationInstanceFilter {
return parseGenericFilter(filter, descriptor);
}
/**
* Function that checks if supplied [[PresentationInstanceFilter]] is [[PresentationInstanceFilterConditionGroup]].
* @beta
*/
export function isConditionGroup(filter: PresentationInstanceFilter): filter is PresentationInstanceFilterConditionGroup {
return (filter as any).conditions !== undefined;
}
/**
* Function that creates equality condition based on supplied [[PropertiesField]] and [[PrimitiveValue]] that is compatible
* with `UniquePropertyValuesSelector`.
* If [[PrimitiveValue.value]] is `undefined` created condition uses `is-null` or `is-not-null` operator.
* @beta
*/
export function createPrimitiveValueEqualityCondition(
field: PropertiesField,
operator: "is-equal" | "is-not-equal",
value: PrimitiveValue,
): PresentationInstanceFilterCondition {
if (!isValidPrimitiveValue(value)) {
return {
field,
operator: operator === "is-equal" ? "is-null" : "is-not-null",
};
}
return {
field,
operator,
value: createUniqueValue(value),
};
}
}
function createPresentationInstanceFilterConditionGroup(descriptor: Descriptor, group: PropertyFilterRuleGroup): PresentationInstanceFilterConditionGroup {
return {
operator: group.operator,
conditions: group.rules.map((rule) => PresentationInstanceFilter.fromComponentsPropertyFilter(descriptor, rule)),
};
}
function createPresentationInstanceFilterCondition(descriptor: Descriptor, condition: PropertyFilterRule): PresentationInstanceFilterCondition {
const field = findField(descriptor, getInstanceFilterFieldName(condition.property));
if (!field || !field.isPropertiesField()) {
throw new PresentationError(PresentationStatus.Error, `Failed to find properties field for property - ${condition.property.name}`);
}
if (condition.value && condition.value.valueFormat !== PropertyValueFormat.Primitive) {
throw new PresentationError(PresentationStatus.Error, `Property '${condition.property.name}' cannot be compared with non primitive value.`);
}
return {
operator: condition.operator,
field,
value: condition.value,
};
}
function createPropertyFilterRule(condition: PresentationInstanceFilterCondition, descriptor: Descriptor): PropertyFilterRule {
const field = descriptor.getFieldByName(condition.field.name, true);
if (!field || !field.isPropertiesField()) {
throw new PresentationError(PresentationStatus.Error, `Failed to find properties field - ${condition.field.name} in descriptor`);
}
return {
property: createPropertyInfoFromPropertiesField(field).propertyDescription,
operator: condition.operator,
value: condition.value,
};
}
function createPropertyFilterRuleGroup(group: PresentationInstanceFilterConditionGroup, descriptor: Descriptor): PropertyFilterRuleGroup {
return {
operator: group.operator,
rules: group.conditions.map((condition) => PresentationInstanceFilter.toComponentsPropertyFilter(descriptor, condition)),
};
}
interface ConvertContext {
relatedInstances: RelatedInstance[];
propertyClasses: ClassInfo[];
usedRelatedAliases: Map<string, number>;
}
interface RelatedInstance {
path: RelationshipPath;
alias: string;
}
function createGenericInstanceFilter(filter: PresentationInstanceFilter, ctx: ConvertContext) {
if (PresentationInstanceFilter.isConditionGroup(filter)) {
return createGenericInstanceFilterRuleGroup(filter, ctx);
}
const result = createGenericInstanceFilterUniqueValueRules(filter, ctx);
if (result !== undefined) {
return result;
}
return createGenericInstanceFilterRule(filter, ctx);
}
function createGenericInstanceFilterUniqueValueRules(filter: PresentationInstanceFilterCondition, ctx: ConvertContext) {
// Unique values works only with `IsEqual` and `IsNotEqual` operators.
if (filter.operator !== "is-equal" && filter.operator !== "is-not-equal") {
return undefined;
}
if (typeof filter.value?.value !== "string" || typeof filter.value?.displayValue !== "string") {
return undefined;
}
const result = createUniqueValueConditions(filter, filter.value.displayValue, filter.value.value);
if (result === undefined) {
return undefined;
}
return createGenericInstanceFilterRuleGroup(result, ctx);
}
function createGenericInstanceFilterRuleGroup(group: PresentationInstanceFilterConditionGroup, ctx: ConvertContext): GenericInstanceFilterRuleGroup {
const convertedConditions = group.conditions.map((condition) => createGenericInstanceFilter(condition, ctx));
return {
operator: group.operator,
rules: convertedConditions,
};
}
function createGenericInstanceFilterRule(condition: PresentationInstanceFilterCondition, ctx: ConvertContext): GenericInstanceFilterRule {
const { field, operator, value } = condition;
// we can use first property when creating `GenericInstanceFilterRule` because all properties in this field will have same name.
const property = field.properties[0].property;
const relatedInstance = getRelatedInstanceDescription(field, property.classInfo.name, ctx);
addClassInfoToContext(relatedInstance ? [relatedInstance.path[0].sourceClassInfo] : field.properties.map((prop) => prop.property.classInfo), ctx);
const propertyAlias = relatedInstance?.alias ?? "this";
return {
operator,
value: toGenericInstanceFilterRuleValue(value),
sourceAlias: propertyAlias,
propertyName: property.name,
propertyTypeName: field.type.typeName,
};
}
function createUniqueValueConditions(filter: PresentationInstanceFilterCondition, serializedDisplayValues: string, serializedGroupedRawValues: string) {
const { field, operator } = filter;
const uniqueValues = deserializeUniqueValues(serializedDisplayValues, serializedGroupedRawValues);
if (uniqueValues === undefined) {
return undefined;
}
const conditionGroup: PresentationInstanceFilterConditionGroup = {
operator: operator === "is-equal" ? "or" : "and",
conditions: [],
};
for (const { displayValue, groupedRawValues } of uniqueValues) {
for (const value of groupedRawValues) {
conditionGroup.conditions.push({
field,
operator,
value: { valueFormat: PropertyValueFormat.Primitive, displayValue, value },
});
}
}
return conditionGroup;
}
function getRelatedInstanceDescription(field: PropertiesField, propClassName: string, ctx: ConvertContext): RelatedInstance | undefined {
if (!field.parent) {
return undefined;
}
const pathToProperty = RelationshipPath.reverse(getPathToPrimaryClass(field.parent));
const existing = ctx.relatedInstances.find((instance) => RelationshipPath.equals(pathToProperty, instance.path));
if (existing) {
return existing;
}
const baseAlias = `rel_${propClassName.split(":")[1]}`;
const index = getAliasIndex(baseAlias, ctx.usedRelatedAliases);
const newRelated = {
path: pathToProperty,
alias: `${baseAlias}_${index}`,
};
ctx.relatedInstances.push(newRelated);
return newRelated;
}
function addClassInfoToContext(classInfos: ClassInfo[], ctx: ConvertContext) {
for (const classInfo of classInfos) {
if (ctx.propertyClasses.find((existing) => existing.id === classInfo.id)) {
return;
}
ctx.propertyClasses.push(classInfo);
}
}
function getPathToPrimaryClass(field: NestedContentField): RelationshipPath {
if (field.parent) {
return [...field.pathToPrimaryClass, ...getPathToPrimaryClass(field.parent)];
}
return [...field.pathToPrimaryClass];
}
function getAliasIndex(alias: string, usedAliases: Map<string, number>) {
const index = usedAliases.has(alias) ? usedAliases.get(alias)! + 1 : 0;
usedAliases.set(alias, index);
return index;
}
interface GenericFilterParsingContext {
findField: (propName: string, alias: string) => PropertiesField;
}
function parseGenericFilter(filter: GenericInstanceFilter, descriptor: Descriptor): PresentationInstanceFilter {
const ctx: GenericFilterParsingContext = {
findField: (propName, alias) => {
const field =
alias === "this" ? findDirectField(descriptor.fields, propName) : findRelatedField(descriptor.fields, propName, alias, filter.relatedInstances);
if (!field) {
throw new PresentationError(PresentationStatus.Error, `Failed to find field for property - ${alias}.${propName}`);
}
return field;
},
};
return parseGenericFilterRules(filter.rules, ctx);
}
function parseGenericFilterRules(
rules: GenericInstanceFilterRule | GenericInstanceFilterRuleGroup,
ctx: GenericFilterParsingContext,
): PresentationInstanceFilter {
if (GenericInstanceFilter.isFilterRuleGroup(rules)) {
return parseGenericFilterRuleGroup(rules, ctx);
}
return parseGenericFilterRule(rules, ctx);
}
function parseGenericFilterRuleGroup(
group: GenericInstanceFilterRuleGroup,
ctx: GenericFilterParsingContext,
): PresentationInstanceFilterConditionGroup | PresentationInstanceFilterCondition {
if (group.rules.every((rule) => !GenericInstanceFilter.isFilterRuleGroup(rule) && (rule.operator === "is-equal" || rule.operator === "is-not-equal"))) {
const uniqueValueRule = parseUniqueValuesRule(group.rules as GenericInstanceFilterRule[], ctx);
if (uniqueValueRule) {
return uniqueValueRule;
}
}
return {
operator: group.operator,
conditions: group.rules.map((rule) => parseGenericFilterRules(rule, ctx)),
};
}
function parseGenericFilterRule(rule: GenericInstanceFilterRule, ctx: GenericFilterParsingContext): PresentationInstanceFilterCondition {
const field = ctx.findField(rule.propertyName, rule.sourceAlias);
return {
field,
operator: rule.operator,
value: rule.value ? { valueFormat: PropertyValueFormat.Primitive, displayValue: rule.value.displayValue, value: rule.value.rawValue } : undefined,
};
}
function parseUniqueValuesRule(rules: GenericInstanceFilterRule[], ctx: GenericFilterParsingContext): PresentationInstanceFilterCondition | undefined {
if (rules.length === 0) {
return undefined;
}
// check if all rules in group use same property and operator
const ruleInfo = { propName: rules[0].propertyName, alias: rules[0].sourceAlias, operator: rules[0].operator };
if (!rules.every((rule) => rule.operator === ruleInfo.operator && rule.propertyName === ruleInfo.propName && rule.sourceAlias === ruleInfo.alias)) {
return undefined;
}
const field = ctx.findField(rules[0].propertyName, rules[0].sourceAlias);
const uniqueValues: UniqueValue[] = [];
for (const rule of rules) {
assert(rule.value?.displayValue !== undefined && rule.value.rawValue !== undefined);
const displayValue = rule.value.displayValue;
const value = rule.value.rawValue as Value;
const currentValue = uniqueValues.find((val) => val.displayValue === displayValue);
if (currentValue) {
currentValue.groupedRawValues.push(value);
} else {
uniqueValues.push({
displayValue,
groupedRawValues: [value],
});
}
}
const { displayValues, groupedRawValues } = serializeUniqueValues(uniqueValues);
return {
operator: rules[0].operator,
field,
value: { valueFormat: PropertyValueFormat.Primitive, displayValue: displayValues, value: groupedRawValues },
};
}
function findDirectField(fields: Field[], propName: string): PropertiesField | undefined {
for (const field of fields) {
if (!field.isPropertiesField()) {
continue;
}
// check only the name of the first property because only properties with the same name can be merged under single field.
if (field.properties[0].property.name === propName) {
return field;
}
}
return undefined;
}
function findRelatedField(
fields: Field[],
propName: string,
alias: string,
relatedInstances: GenericInstanceFilterRelatedInstanceDescription[],
): PropertiesField | undefined {
const relatedInstance = relatedInstances.find((rel) => alias === rel.alias);
if (!relatedInstance) {
return undefined;
}
const relatedField = findFieldByPath(fields, relatedInstance.path);
return relatedField ? findDirectField(relatedField.nestedFields, propName) : undefined;
}
function findFieldByPath(fields: Field[], pathToField: GenericInstanceFilterRelationshipStep[]): NestedContentField | undefined {
for (const field of fields) {
if (!field.isNestedContentField()) {
continue;
}
const pathMatchResult = pathStartsWith(pathToField, RelationshipPath.reverse(field.pathToPrimaryClass));
if (!pathMatchResult.matches) {
continue;
}
if (pathMatchResult.leftOver.length === 0) {
return field;
}
const nestedField = findFieldByPath(field.nestedFields, pathMatchResult.leftOver);
// istanbul ignore else
if (nestedField) {
return nestedField;
}
}
return undefined;
}
function pathStartsWith(
prefix: GenericInstanceFilterRelationshipStep[],
path: RelationshipPath,
):
| {
matches: false;
}
| {
matches: true;
leftOver: GenericInstanceFilterRelationshipStep[];
} {
if (prefix.length < path.length) {
return { matches: false };
}
for (let i = 0; i < path.length; ++i) {
const prefixStep = prefix[i];
const pathStep = path[i];
if (
prefixStep.sourceClassName !== pathStep.sourceClassInfo.name ||
prefixStep.targetClassName !== pathStep.targetClassInfo.name ||
prefixStep.relationshipClassName !== pathStep.relationshipInfo.name ||
prefixStep.isForwardRelationship !== pathStep.isForwardRelationship
) {
return { matches: false };
}
}
const leftOver = prefix.slice(path.length);
return {
matches: true,
leftOver,
};
}
function toRelationshipStep(path: RelationshipPath): GenericInstanceFilterRelationshipStep[] {
return path.map((step) => ({
sourceClassName: step.sourceClassInfo.name,
targetClassName: step.targetClassInfo.name,
relationshipClassName: step.relationshipInfo.name,
isForwardRelationship: step.isForwardRelationship,
}));
}
function toGenericInstanceFilterRuleValue(primitiveValue?: PrimitiveValue): GenericInstanceFilterRuleValue | undefined {
if (!primitiveValue || primitiveValue.value === undefined || !isGenericPrimitiveValueLike(primitiveValue.value)) {
return undefined;
}
return { displayValue: primitiveValue.displayValue ?? "", rawValue: primitiveValue.value };
}
function isGenericPrimitiveValueLike(value: Primitives.Value): value is GenericInstanceFilterRuleValue.Values {
switch (typeof value) {
case "string":
case "number":
case "boolean":
return true;
}
return isPoint3dLike(value) || isPoint2dLike(value) || isInstanceKeyLike(value);
}
function isPoint2dLike(value: object): value is { x: number; y: number } {
return (value as any).x !== undefined && (value as any).y !== undefined;
}
function isPoint3dLike(value: object): value is { x: number; y: number; z: number } {
return isPoint2dLike(value) && (value as any).z !== undefined;
}
function isInstanceKeyLike(value: object): value is { id: string; className: string } {
return (value as any).id !== undefined && (value as any).className !== undefined;
}
function isValidPrimitiveValue(val: PrimitiveValue): val is Required<PrimitiveValue> {
return val.value !== undefined && val.displayValue !== undefined;
}
function createUniqueValue(value: Required<PrimitiveValue>): PrimitiveValue | undefined {
const { displayValues, groupedRawValues } = serializeUniqueValues([
{
displayValue: value.displayValue,
groupedRawValues: [value.value as Value],
},
]);
return {
displayValue: displayValues,
value: groupedRawValues,
valueFormat: PropertyValueFormat.Primitive,
};
}