@itwin/presentation-common 4.0.0-dev.15 → 4.0.0-dev.17

package/lib/cjs/presentation-common/RulesetsFactory.js

@@ -1,224 +1,224 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Core
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RulesetsFactory = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const TypeDescription_1 = require("./content/TypeDescription");
-const Value_1 = require("./content/Value");
-const EC_1 = require("./EC");
-const ContentSpecification_1 = require("./rules/content/ContentSpecification");
-const RelationshipDirection_1 = require("./rules/RelationshipDirection");
-const Rule_1 = require("./rules/Rule");
-/**
- * A factory class that can be used to create presentation rulesets targeted towards
- * specific use cases.
- *
- * @public
- */
-class RulesetsFactory {
-    createSimilarInstancesRulesetInfo(field, record) {
-        if (!field.isPropertiesField())
-            throw new Error("Can only create 'similar instances' ruleset for properties-based records");
-        if (field.type.valueFormat !== TypeDescription_1.PropertyValueFormat.Primitive)
-            throw new Error("Can only create 'similar instances' ruleset for primitive properties");
-        if (field.properties.length === 0)
-            throw new Error("Invalid properties' field with no properties");
-        if (record.isFieldMerged(field.name))
-            throw new Error("Can't create 'similar instances' ruleset for merged values");
-        if (!record.classInfo)
-            throw new Error("Can't create 'similar instances' for records based on multiple different ECClass instances");
-        const propertyName = getPropertyName(field);
-        const propertyValue = getPropertyValue(record, field);
-        const relatedInstanceInfo = createRelatedInstanceSpecInfo(field);
-        const relatedClass = relatedInstanceInfo === null || relatedInstanceInfo === void 0 ? void 0 : relatedInstanceInfo.class;
-        const ruleset = {
-            id: `SimilarInstances/${propertyName}/${core_bentley_1.Guid.createValue()}`,
-            rules: [],
-        };
-        ruleset.rules.push({
-            ruleType: Rule_1.RuleTypes.Content,
-            specifications: [{
-                    specType: ContentSpecification_1.ContentSpecificationTypes.ContentInstancesOfSpecificClasses,
-                    classes: createMultiClassSpecification(record.classInfo),
-                    handleInstancesPolymorphically: true,
-                    relatedInstances: relatedInstanceInfo ? [relatedInstanceInfo.spec] : [],
-                    instanceFilter: createInstanceFilter(relatedInstanceInfo === null || relatedInstanceInfo === void 0 ? void 0 : relatedInstanceInfo.spec, field.type, propertyName, propertyValue.raw),
-                }],
-        });
-        return { ruleset, relatedClass, propertyName, propertyValue };
-    }
-    /**
-     * Create a ruleset with content rules for getting instances are of the
-     * same ECClass and have the same property value as the provided `record`.
-     * @param field A field identifying which property of the record we should use
-     * @param record A record whose similar instances should be found
-     * @param computeDisplayValue Optional callback function to calculate display value that's
-     * used in ruleset's description. If not provided, display value from record is used instead.
-     */
-    async createSimilarInstancesRuleset(field, record, computeDisplayValue) {
-        const info = this.createSimilarInstancesRulesetInfo(field, record);
-        const description = await createDescriptionAsync(record, info.relatedClass, field, info.propertyValue, computeDisplayValue);
-        return { ruleset: info.ruleset, description };
-    }
-}
-exports.RulesetsFactory = RulesetsFactory;
-const toString = (displayValue) => {
-    if (!displayValue)
-        return "NULL";
-    return displayValue.toString();
-};
-const createDescription = (record, relatedClass, field, value) => {
-    const classInfo = relatedClass !== null && relatedClass !== void 0 ? relatedClass : record.classInfo;
-    return `[${classInfo.label}].[${field.label}] = ${value}`;
-};
-const createDescriptionAsync = async (record, relatedClass, field, value, computeDisplayValue) => {
-    const displayValue = computeDisplayValue ? await computeDisplayValue(field.type.typeName, value.raw, value.display) : toString(value.display);
-    return createDescription(record, relatedClass, field, displayValue);
-};
-const getPropertyName = (field) => {
-    let name = field.properties[0].property.name;
-    if (field.type.typeName === "navigation")
-        name += ".Id";
-    return name;
-};
-const isPrimitivePropertyValue = (value) => {
-    if (Value_1.Value.isPrimitive(value)) {
-        return true;
-    }
-    if (Value_1.Value.isMap(value)) {
-        if (typeof value.x === "number"
-            && typeof value.y === "number"
-            && (value.z === undefined || typeof value.z === "number")) {
-            return true;
-        }
-        if (typeof value.className === "string" && typeof value.id === "string") {
-            return true;
-        }
-    }
-    return false;
-};
-const getPropertyValue = (record, field) => {
-    const fieldNamesStack = [];
-    let currField = field;
-    while (currField) {
-        fieldNamesStack.push(currField.name);
-        currField = currField.parent;
-    }
-    let currFieldName = fieldNamesStack.pop();
-    let displayValue = record.displayValues[currFieldName];
-    let value = record.values[currFieldName];
-    currFieldName = fieldNamesStack.pop();
-    while (currFieldName) {
-        if (!Value_1.Value.isNestedContent(value) || value.length === 0)
-            throw new Error("Invalid record value");
-        if (value.length > 1)
-            throw new Error("Can't create 'similar instances' for records related through many part of *-to-many relationship");
-        if (value[0].mergedFieldNames.indexOf(currFieldName) !== -1)
-            throw new Error("Can't create 'similar instances' ruleset for merged values");
-        displayValue = value[0].displayValues[currFieldName];
-        value = value[0].values[currFieldName];
-        currFieldName = fieldNamesStack.pop();
-    }
-    if (!isPrimitivePropertyValue(value))
-        throw new Error("Can only create 'similar instances' ruleset for primitive values");
-    return { raw: value, display: toString(displayValue) };
-};
-const createInstanceFilter = (relatedInstanceSpec, propertyType, propertyName, propertyValue) => {
-    const alias = relatedInstanceSpec ? relatedInstanceSpec.alias : "this";
-    return createComparison(propertyType, `${alias}.${propertyName}`, "=", propertyValue);
-};
-const createComparison = (type, name, operator, value) => {
-    let compareValue = "";
-    switch (typeof value) {
-        case "undefined":
-            compareValue = "NULL";
-            break;
-        case "string":
-            compareValue = `"${value.replace(/"/g, `""`)}"`;
-            break;
-        case "boolean":
-            compareValue = value ? "TRUE" : "FALSE";
-            break;
-        case "number":
-            compareValue = value.toString();
-            break;
-    }
-    if (type.typeName === "navigation" && typeof value === "object" && core_bentley_1.Id64.isId64(value.id))
-        // note: this is temporary until we support hex ids in instance filters
-        compareValue = hexToDec(value.id);
-    if (type.typeName === "point2d" || type.typeName === "point3d") {
-        if (typeof value !== "object")
-            throw new Error("Expecting point values to be supplied as objects");
-        const dimensionType = {
-            valueFormat: TypeDescription_1.PropertyValueFormat.Primitive,
-            typeName: "double",
-        };
-        const pointValue = value;
-        let comparison = `${createComparison(dimensionType, `${name}.x`, operator, pointValue.x)}`;
-        comparison += ` AND ${createComparison(dimensionType, `${name}.y`, operator, pointValue.y)}`;
-        if (type.typeName === "point3d" && pointValue.z !== undefined)
-            comparison += ` AND ${createComparison(dimensionType, `${name}.z`, operator, pointValue.z)}`;
-        return comparison;
-    }
-    if (type.typeName === "double")
-        return `CompareDoubles(${name}, ${compareValue}) ${operator} 0`;
-    if (type.typeName === "dateTime")
-        return `CompareDateTimes(${name}, ${compareValue}) ${operator} 0`;
-    return `${name} ${operator} ${compareValue}`;
-};
-const createMultiClassSpecification = (classInfo) => {
-    const [schemaName, className] = classInfo.name.split(":");
-    return { schemaName, classNames: [className] };
-};
-const createSingleClassSpecification = (classInfo) => {
-    const [schemaName, className] = classInfo.name.split(":");
-    return { schemaName, className };
-};
-const createRelatedInstanceSpec = (pathFromSelectToPropertyClass, index) => ({
-    spec: {
-        relationshipPath: pathFromSelectToPropertyClass.map((step) => ({
-            relationship: createSingleClassSpecification(step.relationshipInfo),
-            direction: step.isForwardRelationship ? RelationshipDirection_1.RelationshipDirection.Forward : RelationshipDirection_1.RelationshipDirection.Backward,
-            targetClass: createSingleClassSpecification(step.targetClassInfo),
-        })),
-        isRequired: true,
-        alias: `related_${index}`,
-    },
-    class: pathFromSelectToPropertyClass[pathFromSelectToPropertyClass.length - 1].targetClassInfo,
-});
-const createPathFromSelectToPropertyClass = (field) => {
-    let currField = field;
-    const pathFromPropertyToSelectClass = [];
-    while (currField.parent) {
-        pathFromPropertyToSelectClass.push(...currField.parent.pathToPrimaryClass);
-        currField = currField.parent;
-    }
-    return EC_1.RelationshipPath.reverse(pathFromPropertyToSelectClass);
-};
-const createRelatedInstanceSpecInfo = (field) => {
-    const path = createPathFromSelectToPropertyClass(field);
-    return path.length ? createRelatedInstanceSpec(path, 0) : undefined;
-};
-const hexToDec = (id) => {
-    const digits = [0];
-    for (let i = 2; i < id.length; ++i) {
-        let carry = parseInt(id.charAt(i), 16);
-        for (let j = 0; j < digits.length; ++j) {
-            digits[j] = digits[j] * 16 + carry;
-            carry = digits[j] / 10 | 0;
-            digits[j] %= 10;
-        }
-        while (carry > 0) {
-            digits.push(carry % 10);
-            carry = carry / 10 | 0;
-        }
-    }
-    return digits.reverse().join("");
-};
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RulesetsFactory = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const TypeDescription_1 = require("./content/TypeDescription");
+const Value_1 = require("./content/Value");
+const EC_1 = require("./EC");
+const ContentSpecification_1 = require("./rules/content/ContentSpecification");
+const RelationshipDirection_1 = require("./rules/RelationshipDirection");
+const Rule_1 = require("./rules/Rule");
+/**
+ * A factory class that can be used to create presentation rulesets targeted towards
+ * specific use cases.
+ *
+ * @public
+ */
+class RulesetsFactory {
+    createSimilarInstancesRulesetInfo(field, record) {
+        if (!field.isPropertiesField())
+            throw new Error("Can only create 'similar instances' ruleset for properties-based records");
+        if (field.type.valueFormat !== TypeDescription_1.PropertyValueFormat.Primitive)
+            throw new Error("Can only create 'similar instances' ruleset for primitive properties");
+        if (field.properties.length === 0)
+            throw new Error("Invalid properties' field with no properties");
+        if (record.isFieldMerged(field.name))
+            throw new Error("Can't create 'similar instances' ruleset for merged values");
+        if (!record.classInfo)
+            throw new Error("Can't create 'similar instances' for records based on multiple different ECClass instances");
+        const propertyName = getPropertyName(field);
+        const propertyValue = getPropertyValue(record, field);
+        const relatedInstanceInfo = createRelatedInstanceSpecInfo(field);
+        const relatedClass = relatedInstanceInfo === null || relatedInstanceInfo === void 0 ? void 0 : relatedInstanceInfo.class;
+        const ruleset = {
+            id: `SimilarInstances/${propertyName}/${core_bentley_1.Guid.createValue()}`,
+            rules: [],
+        };
+        ruleset.rules.push({
+            ruleType: Rule_1.RuleTypes.Content,
+            specifications: [{
+                    specType: ContentSpecification_1.ContentSpecificationTypes.ContentInstancesOfSpecificClasses,
+                    classes: createMultiClassSpecification(record.classInfo),
+                    handleInstancesPolymorphically: true,
+                    relatedInstances: relatedInstanceInfo ? [relatedInstanceInfo.spec] : [],
+                    instanceFilter: createInstanceFilter(relatedInstanceInfo === null || relatedInstanceInfo === void 0 ? void 0 : relatedInstanceInfo.spec, field.type, propertyName, propertyValue.raw),
+                }],
+        });
+        return { ruleset, relatedClass, propertyName, propertyValue };
+    }
+    /**
+     * Create a ruleset with content rules for getting instances are of the
+     * same ECClass and have the same property value as the provided `record`.
+     * @param field A field identifying which property of the record we should use
+     * @param record A record whose similar instances should be found
+     * @param computeDisplayValue Optional callback function to calculate display value that's
+     * used in ruleset's description. If not provided, display value from record is used instead.
+     */
+    async createSimilarInstancesRuleset(field, record, computeDisplayValue) {
+        const info = this.createSimilarInstancesRulesetInfo(field, record);
+        const description = await createDescriptionAsync(record, info.relatedClass, field, info.propertyValue, computeDisplayValue);
+        return { ruleset: info.ruleset, description };
+    }
+}
+exports.RulesetsFactory = RulesetsFactory;
+const toString = (displayValue) => {
+    if (!displayValue)
+        return "NULL";
+    return displayValue.toString();
+};
+const createDescription = (record, relatedClass, field, value) => {
+    const classInfo = relatedClass !== null && relatedClass !== void 0 ? relatedClass : record.classInfo;
+    return `[${classInfo.label}].[${field.label}] = ${value}`;
+};
+const createDescriptionAsync = async (record, relatedClass, field, value, computeDisplayValue) => {
+    const displayValue = computeDisplayValue ? await computeDisplayValue(field.type.typeName, value.raw, value.display) : toString(value.display);
+    return createDescription(record, relatedClass, field, displayValue);
+};
+const getPropertyName = (field) => {
+    let name = field.properties[0].property.name;
+    if (field.type.typeName === "navigation")
+        name += ".Id";
+    return name;
+};
+const isPrimitivePropertyValue = (value) => {
+    if (Value_1.Value.isPrimitive(value)) {
+        return true;
+    }
+    if (Value_1.Value.isMap(value)) {
+        if (typeof value.x === "number"
+            && typeof value.y === "number"
+            && (value.z === undefined || typeof value.z === "number")) {
+            return true;
+        }
+        if (typeof value.className === "string" && typeof value.id === "string") {
+            return true;
+        }
+    }
+    return false;
+};
+const getPropertyValue = (record, field) => {
+    const fieldNamesStack = [];
+    let currField = field;
+    while (currField) {
+        fieldNamesStack.push(currField.name);
+        currField = currField.parent;
+    }
+    let currFieldName = fieldNamesStack.pop();
+    let displayValue = record.displayValues[currFieldName];
+    let value = record.values[currFieldName];
+    currFieldName = fieldNamesStack.pop();
+    while (currFieldName) {
+        if (!Value_1.Value.isNestedContent(value) || value.length === 0)
+            throw new Error("Invalid record value");
+        if (value.length > 1)
+            throw new Error("Can't create 'similar instances' for records related through many part of *-to-many relationship");
+        if (value[0].mergedFieldNames.indexOf(currFieldName) !== -1)
+            throw new Error("Can't create 'similar instances' ruleset for merged values");
+        displayValue = value[0].displayValues[currFieldName];
+        value = value[0].values[currFieldName];
+        currFieldName = fieldNamesStack.pop();
+    }
+    if (!isPrimitivePropertyValue(value))
+        throw new Error("Can only create 'similar instances' ruleset for primitive values");
+    return { raw: value, display: toString(displayValue) };
+};
+const createInstanceFilter = (relatedInstanceSpec, propertyType, propertyName, propertyValue) => {
+    const alias = relatedInstanceSpec ? relatedInstanceSpec.alias : "this";
+    return createComparison(propertyType, `${alias}.${propertyName}`, "=", propertyValue);
+};
+const createComparison = (type, name, operator, value) => {
+    let compareValue = "";
+    switch (typeof value) {
+        case "undefined":
+            compareValue = "NULL";
+            break;
+        case "string":
+            compareValue = `"${value.replace(/"/g, `""`)}"`;
+            break;
+        case "boolean":
+            compareValue = value ? "TRUE" : "FALSE";
+            break;
+        case "number":
+            compareValue = value.toString();
+            break;
+    }
+    if (type.typeName === "navigation" && typeof value === "object" && core_bentley_1.Id64.isId64(value.id))
+        // note: this is temporary until we support hex ids in instance filters
+        compareValue = hexToDec(value.id);
+    if (type.typeName === "point2d" || type.typeName === "point3d") {
+        if (typeof value !== "object")
+            throw new Error("Expecting point values to be supplied as objects");
+        const dimensionType = {
+            valueFormat: TypeDescription_1.PropertyValueFormat.Primitive,
+            typeName: "double",
+        };
+        const pointValue = value;
+        let comparison = `${createComparison(dimensionType, `${name}.x`, operator, pointValue.x)}`;
+        comparison += ` AND ${createComparison(dimensionType, `${name}.y`, operator, pointValue.y)}`;
+        if (type.typeName === "point3d" && pointValue.z !== undefined)
+            comparison += ` AND ${createComparison(dimensionType, `${name}.z`, operator, pointValue.z)}`;
+        return comparison;
+    }
+    if (type.typeName === "double")
+        return `CompareDoubles(${name}, ${compareValue}) ${operator} 0`;
+    if (type.typeName === "dateTime")
+        return `CompareDateTimes(${name}, ${compareValue}) ${operator} 0`;
+    return `${name} ${operator} ${compareValue}`;
+};
+const createMultiClassSpecification = (classInfo) => {
+    const [schemaName, className] = classInfo.name.split(":");
+    return { schemaName, classNames: [className] };
+};
+const createSingleClassSpecification = (classInfo) => {
+    const [schemaName, className] = classInfo.name.split(":");
+    return { schemaName, className };
+};
+const createRelatedInstanceSpec = (pathFromSelectToPropertyClass, index) => ({
+    spec: {
+        relationshipPath: pathFromSelectToPropertyClass.map((step) => ({
+            relationship: createSingleClassSpecification(step.relationshipInfo),
+            direction: step.isForwardRelationship ? RelationshipDirection_1.RelationshipDirection.Forward : RelationshipDirection_1.RelationshipDirection.Backward,
+            targetClass: createSingleClassSpecification(step.targetClassInfo),
+        })),
+        isRequired: true,
+        alias: `related_${index}`,
+    },
+    class: pathFromSelectToPropertyClass[pathFromSelectToPropertyClass.length - 1].targetClassInfo,
+});
+const createPathFromSelectToPropertyClass = (field) => {
+    let currField = field;
+    const pathFromPropertyToSelectClass = [];
+    while (currField.parent) {
+        pathFromPropertyToSelectClass.push(...currField.parent.pathToPrimaryClass);
+        currField = currField.parent;
+    }
+    return EC_1.RelationshipPath.reverse(pathFromPropertyToSelectClass);
+};
+const createRelatedInstanceSpecInfo = (field) => {
+    const path = createPathFromSelectToPropertyClass(field);
+    return path.length ? createRelatedInstanceSpec(path, 0) : undefined;
+};
+const hexToDec = (id) => {
+    const digits = [0];
+    for (let i = 2; i < id.length; ++i) {
+        let carry = parseInt(id.charAt(i), 16);
+        for (let j = 0; j < digits.length; ++j) {
+            digits[j] = digits[j] * 16 + carry;
+            carry = digits[j] / 10 | 0;
+            digits[j] %= 10;
+        }
+        while (carry > 0) {
+            digits.push(carry % 10);
+            carry = carry / 10 | 0;
+        }
+    }
+    return digits.reverse().join("");
+};
 //# sourceMappingURL=RulesetsFactory.js.map

package/lib/cjs/presentation-common/RulesetsFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"RulesetsFactory.js","sourceRoot":"","sources":["../../../src/presentation-common/RulesetsFactory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6D;AAG7D,+DAA0F;AAC1F,2CAAsD;AACtD,6BAAgE;AAEhE,+EAAiF;AAEjF,yEAAsE;AACtE,uCAAyC;AAGzC;;;;;GAKG;AACH,MAAa,eAAe;IAClB,iCAAiC,CAAC,KAAY,EAAE,MAAY;QAClE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAC9F,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,qCAAmB,CAAC,SAAS;YAC1D,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,IAAI,CAAC,MAAM,CAAC,SAAS;YACnB,MAAM,IAAI,KAAK,CAAC,4FAA4F,CAAC,CAAC;QAChH,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,mBAAmB,GAAG,6BAA6B,CAAC,KAAK,CAAC,CAAC;QACjE,MAAM,YAAY,GAAG,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,KAAK,CAAC;QAChD,MAAM,OAAO,GAAY;YACvB,EAAE,EAAE,oBAAoB,YAAY,IAAI,mBAAI,CAAC,WAAW,EAAE,EAAE;YAC5D,KAAK,EAAE,EAAE;SACV,CAAC;QACF,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;YACjB,QAAQ,EAAE,gBAAS,CAAC,OAAO;YAC3B,cAAc,EAAE,CAAC;oBACf,QAAQ,EAAE,gDAAyB,CAAC,iCAAiC;oBACrE,OAAO,EAAE,6BAA6B,CAAC,MAAM,CAAC,SAAS,CAAC;oBACxD,8BAA8B,EAAE,IAAI;oBACpC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;oBACvE,cAAc,EAAE,oBAAoB,CAAC,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,GAAG,CAAC;iBAC7G,CAAC;SACH,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,6BAA6B,CAAC,KAAY,EAAE,MAAY,EAAE,mBAAiD;QACtH,MAAM,IAAI,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACnE,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;QAC5H,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC;IAChD,CAAC;CACF;AA9CD,0CA8CC;AAsBD,MAAM,QAAQ,GAAG,CAAC,YAAkC,EAAU,EAAE;IAC9D,IAAI,CAAC,YAAY;QACf,OAAO,MAAM,CAAC;IAChB,OAAO,YAAY,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,MAAY,EAAE,YAAmC,EAAE,KAAY,EAAE,KAAa,EAAU,EAAE;IACnH,MAAM,SAAS,GAAG,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,MAAM,CAAC,SAAU,CAAC;IACpD,OAAO,IAAI,SAAS,CAAC,KAAK,MAAM,KAAK,CAAC,KAAK,OAAO,KAAK,EAAE,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,KAAK,EAAE,MAAY,EAAE,YAAmC,EAAE,KAAY,EAAE,KAAwB,EAAE,mBAAiD,EAAmB,EAAE;IACrM,MAAM,YAAY,GAAG,mBAAmB,CAAC,CAAC,CAAC,MAAM,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9I,OAAO,iBAAiB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAE,EAAE;IACjD,IAAI,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC7C,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY;QACtC,IAAI,IAAI,KAAK,CAAC;IAChB,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,KAAY,EAAmC,EAAE;IACjF,IAAI,aAAK,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;QAC5B,OAAO,IAAI,CAAC;KACb;IAED,IAAI,aAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACtB,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ;eAC1B,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ;eAC3B,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,CAAC,EAAE;YAC3D,OAAO,IAAI,CAAC;SACb;QAED,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE;YACvE,OAAO,IAAI,CAAC;SACb;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAY,EAAE,KAAY,EAAqB,EAAE;IACzE,MAAM,eAAe,GAAG,EAAE,CAAC;IAC3B,IAAI,SAAS,GAAsB,KAAK,CAAC;IACzC,OAAO,SAAS,EAAE;QAChB,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;KAC9B;IACD,IAAI,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IAC1C,IAAI,YAAY,GAAiB,MAAM,CAAC,aAAa,CAAC,aAAc,CAAC,CAAC;IACtE,IAAI,KAAK,GAAU,MAAM,CAAC,MAAM,CAAC,aAAc,CAAC,CAAC;IACjD,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IACtC,OAAO,aAAa,EAAE;QACpB,IAAI,CAAC,aAAK,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAC;QACtH,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACrD,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACvC,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;KACvC;IACD,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;IACtF,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAC3B,mBAAuE,EACvE,YAAsC,EACtC,YAAoB,EACpB,aAAqC,EAC7B,EAAE;IACV,MAAM,KAAK,GAAG,mBAAmB,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACvE,OAAO,gBAAgB,CAAC,YAAY,EAAE,GAAG,KAAK,IAAI,YAAY,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;AACxF,CAAC,CAAC;AAGF,MAAM,gBAAgB,GAAG,CAAC,IAA8B,EAAE,IAAY,EAAE,QAAkB,EAAE,KAA6B,EAAU,EAAE;IACnI,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,QAAQ,OAAO,KAAK,EAAE;QACpB,KAAK,WAAW;YACd,YAAY,GAAG,MAAM,CAAC;YACtB,MAAM;QACR,KAAK,QAAQ;YACX,YAAY,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;YAChD,MAAM;QACR,KAAK,SAAS;YACZ,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YACxC,MAAM;QACR,KAAK,QAAQ;YACX,YAAY,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAChC,MAAM;KACT;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,YAAY,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,mBAAI,CAAC,MAAM,CAAE,KAAqB,CAAC,EAAE,CAAC;QACvG,uEAAuE;QACvE,YAAY,GAAG,QAAQ,CAAE,KAAqB,CAAC,EAAE,CAAC,CAAC;IAErD,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;QAC9D,IAAI,OAAO,KAAK,KAAK,QAAQ;YAC3B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEtE,MAAM,aAAa,GAA6B;YAC9C,WAAW,EAAE,qCAAmB,CAAC,SAAS;YAC1C,QAAQ,EAAE,QAAQ;SACnB,CAAC;QAEF,MAAM,UAAU,GAAG,KAAc,CAAC;QAClC,IAAI,UAAU,GAAG,GAAG,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3F,UAAU,IAAI,QAAQ,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,CAAC,KAAK,SAAS;YAC3D,UAAU,IAAI,QAAQ,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAE/F,OAAO,UAAU,CAAC;KACnB;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ;QAC5B,OAAO,kBAAkB,IAAI,KAAK,YAAY,KAAK,QAAQ,IAAI,CAAC;IAElE,IAAI,IAAI,CAAC,QAAQ,KAAK,UAAU;QAC9B,OAAO,oBAAoB,IAAI,KAAK,YAAY,KAAK,QAAQ,IAAI,CAAC;IAEpE,OAAO,GAAG,IAAI,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,SAA8B,EAAmC,EAAE;IACxG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,8BAA8B,GAAG,CAAC,SAA8B,EAAkC,EAAE;IACxG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,6BAA+C,EAAE,KAAa,EAA4D,EAAE,CAAC,CAAC;IAC/J,IAAI,EAAE;QACJ,gBAAgB,EAAE,6BAA6B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC7D,YAAY,EAAE,8BAA8B,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACnE,SAAS,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,6CAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,6CAAqB,CAAC,QAAQ;YACtG,WAAW,EAAE,8BAA8B,CAAC,IAAI,CAAC,eAAe,CAAC;SAClE,CAAC,CAAC;QACH,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,WAAW,KAAK,EAAE;KAC1B;IACD,KAAK,EAAE,6BAA6B,CAAC,6BAA6B,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,eAAe;CAC/F,CAAC,CAAC;AAEH,MAAM,mCAAmC,GAAG,CAAC,KAAsB,EAAoB,EAAE;IACvF,IAAI,SAAS,GAAU,KAAK,CAAC;IAC7B,MAAM,6BAA6B,GAAqB,EAAE,CAAC;IAC3D,OAAO,SAAS,CAAC,MAAM,EAAE;QACvB,6BAA6B,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC3E,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;KAC9B;IACD,OAAO,qBAAgB,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,KAAsB,EAAwE,EAAE;IACrI,MAAM,IAAI,GAAG,mCAAmC,CAAC,KAAK,CAAC,CAAC;IACxD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,EAAc,EAAE,EAAE;IAClC,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QAClC,IAAI,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACtC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACnC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAC3B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACjB;QACD,OAAO,KAAK,GAAG,CAAC,EAAE;YAChB,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;YACxB,KAAK,GAAG,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC;SACxB;KACF;IACD,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { Guid, Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Field, PropertiesField } from \"./content/Fields\";\r\nimport { Item } from \"./content/Item\";\r\nimport { PrimitiveTypeDescription, PropertyValueFormat } from \"./content/TypeDescription\";\r\nimport { DisplayValue, Value } from \"./content/Value\";\r\nimport { ClassInfo, InstanceKey, RelationshipPath } from \"./EC\";\r\nimport { MultiSchemaClassesSpecification, SingleSchemaClassSpecification } from \"./rules/ClassSpecifications\";\r\nimport { ContentSpecificationTypes } from \"./rules/content/ContentSpecification\";\r\nimport { RelatedInstanceSpecification } from \"./rules/RelatedInstanceSpecification\";\r\nimport { RelationshipDirection } from \"./rules/RelationshipDirection\";\r\nimport { RuleTypes } from \"./rules/Rule\";\r\nimport { Ruleset } from \"./rules/Ruleset\";\r\n\r\n/**\r\n * A factory class that can be used to create presentation rulesets targeted towards\r\n * specific use cases.\r\n *\r\n * @public\r\n */\r\nexport class RulesetsFactory {\r\n  private createSimilarInstancesRulesetInfo(field: Field, record: Item) {\r\n    if (!field.isPropertiesField())\r\n      throw new Error(\"Can only create 'similar instances' ruleset for properties-based records\");\r\n    if (field.type.valueFormat !== PropertyValueFormat.Primitive)\r\n      throw new Error(\"Can only create 'similar instances' ruleset for primitive properties\");\r\n    if (field.properties.length === 0)\r\n      throw new Error(\"Invalid properties' field with no properties\");\r\n    if (record.isFieldMerged(field.name))\r\n      throw new Error(\"Can't create 'similar instances' ruleset for merged values\");\r\n    if (!record.classInfo)\r\n      throw new Error(\"Can't create 'similar instances' for records based on multiple different ECClass instances\");\r\n    const propertyName = getPropertyName(field);\r\n    const propertyValue = getPropertyValue(record, field);\r\n    const relatedInstanceInfo = createRelatedInstanceSpecInfo(field);\r\n    const relatedClass = relatedInstanceInfo?.class;\r\n    const ruleset: Ruleset = {\r\n      id: `SimilarInstances/${propertyName}/${Guid.createValue()}`,\r\n      rules: [],\r\n    };\r\n    ruleset.rules.push({\r\n      ruleType: RuleTypes.Content,\r\n      specifications: [{\r\n        specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses,\r\n        classes: createMultiClassSpecification(record.classInfo),\r\n        handleInstancesPolymorphically: true,\r\n        relatedInstances: relatedInstanceInfo ? [relatedInstanceInfo.spec] : [],\r\n        instanceFilter: createInstanceFilter(relatedInstanceInfo?.spec, field.type, propertyName, propertyValue.raw),\r\n      }],\r\n    });\r\n    return { ruleset, relatedClass, propertyName, propertyValue };\r\n  }\r\n\r\n  /**\r\n   * Create a ruleset with content rules for getting instances are of the\r\n   * same ECClass and have the same property value as the provided `record`.\r\n   * @param field A field identifying which property of the record we should use\r\n   * @param record A record whose similar instances should be found\r\n   * @param computeDisplayValue Optional callback function to calculate display value that's\r\n   * used in ruleset's description. If not provided, display value from record is used instead.\r\n   */\r\n  public async createSimilarInstancesRuleset(field: Field, record: Item, computeDisplayValue?: ComputeDisplayValueCallback): Promise<{ ruleset: Ruleset, description: string }> {\r\n    const info = this.createSimilarInstancesRulesetInfo(field, record);\r\n    const description = await createDescriptionAsync(record, info.relatedClass, field, info.propertyValue, computeDisplayValue);\r\n    return { ruleset: info.ruleset, description };\r\n  }\r\n}\r\n\r\n/**\r\n * Definition of a function for calculating a display value.\r\n * @public\r\n */\r\nexport type ComputeDisplayValueCallback = (type: string, value: PrimitivePropertyValue, displayValue: string) => Promise<string>;\r\n\r\ninterface PrimitiveValueDef {\r\n  raw: PrimitivePropertyValue;\r\n  display: string;\r\n}\r\n\r\n/**\r\n * Value of a primitive property.\r\n * @public\r\n */\r\nexport type PrimitivePropertyValue = string | number | boolean | Point | InstanceKey | undefined;\r\n\r\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\r\ntype Point = { x: number, y: number, z?: number };\r\n\r\nconst toString = (displayValue: Value | DisplayValue): string => {\r\n  if (!displayValue)\r\n    return \"NULL\";\r\n  return displayValue.toString();\r\n};\r\n\r\nconst createDescription = (record: Item, relatedClass: ClassInfo | undefined, field: Field, value: string): string => {\r\n  const classInfo = relatedClass ?? record.classInfo!;\r\n  return `[${classInfo.label}].[${field.label}] = ${value}`;\r\n};\r\n\r\nconst createDescriptionAsync = async (record: Item, relatedClass: ClassInfo | undefined, field: Field, value: PrimitiveValueDef, computeDisplayValue?: ComputeDisplayValueCallback): Promise<string> => {\r\n  const displayValue = computeDisplayValue ? await computeDisplayValue(field.type.typeName, value.raw, value.display) : toString(value.display);\r\n  return createDescription(record, relatedClass, field, displayValue);\r\n};\r\n\r\nconst getPropertyName = (field: PropertiesField) => {\r\n  let name = field.properties[0].property.name;\r\n  if (field.type.typeName === \"navigation\")\r\n    name += \".Id\";\r\n  return name;\r\n};\r\n\r\nconst isPrimitivePropertyValue = (value: Value): value is PrimitivePropertyValue => {\r\n  if (Value.isPrimitive(value)) {\r\n    return true;\r\n  }\r\n\r\n  if (Value.isMap(value)) {\r\n    if (typeof value.x === \"number\"\r\n      && typeof value.y === \"number\"\r\n      && (value.z === undefined || typeof value.z === \"number\")) {\r\n      return true;\r\n    }\r\n\r\n    if (typeof value.className === \"string\" && typeof value.id === \"string\") {\r\n      return true;\r\n    }\r\n  }\r\n\r\n  return false;\r\n};\r\n\r\nconst getPropertyValue = (record: Item, field: Field): PrimitiveValueDef => {\r\n  const fieldNamesStack = [];\r\n  let currField: Field | undefined = field;\r\n  while (currField) {\r\n    fieldNamesStack.push(currField.name);\r\n    currField = currField.parent;\r\n  }\r\n  let currFieldName = fieldNamesStack.pop();\r\n  let displayValue: DisplayValue = record.displayValues[currFieldName!];\r\n  let value: Value = record.values[currFieldName!];\r\n  currFieldName = fieldNamesStack.pop();\r\n  while (currFieldName) {\r\n    if (!Value.isNestedContent(value) || value.length === 0)\r\n      throw new Error(\"Invalid record value\");\r\n    if (value.length > 1)\r\n      throw new Error(\"Can't create 'similar instances' for records related through many part of *-to-many relationship\");\r\n    if (value[0].mergedFieldNames.indexOf(currFieldName) !== -1)\r\n      throw new Error(\"Can't create 'similar instances' ruleset for merged values\");\r\n    displayValue = value[0].displayValues[currFieldName];\r\n    value = value[0].values[currFieldName];\r\n    currFieldName = fieldNamesStack.pop();\r\n  }\r\n  if (!isPrimitivePropertyValue(value))\r\n    throw new Error(\"Can only create 'similar instances' ruleset for primitive values\");\r\n  return { raw: value, display: toString(displayValue) };\r\n};\r\n\r\nconst createInstanceFilter = (\r\n  relatedInstanceSpec: Readonly<RelatedInstanceSpecification> | undefined,\r\n  propertyType: PrimitiveTypeDescription,\r\n  propertyName: string,\r\n  propertyValue: PrimitivePropertyValue,\r\n): string => {\r\n  const alias = relatedInstanceSpec ? relatedInstanceSpec.alias : \"this\";\r\n  return createComparison(propertyType, `${alias}.${propertyName}`, \"=\", propertyValue);\r\n};\r\n\r\ntype Operator = \"=\" | \"!=\" | \">\" | \">=\" | \"<\" | \"<=\";\r\nconst createComparison = (type: PrimitiveTypeDescription, name: string, operator: Operator, value: PrimitivePropertyValue): string => {\r\n  let compareValue = \"\";\r\n  switch (typeof value) {\r\n    case \"undefined\":\r\n      compareValue = \"NULL\";\r\n      break;\r\n    case \"string\":\r\n      compareValue = `\"${value.replace(/\"/g, `\"\"`)}\"`;\r\n      break;\r\n    case \"boolean\":\r\n      compareValue = value ? \"TRUE\" : \"FALSE\";\r\n      break;\r\n    case \"number\":\r\n      compareValue = value.toString();\r\n      break;\r\n  }\r\n\r\n  if (type.typeName === \"navigation\" && typeof value === \"object\" && Id64.isId64((value as InstanceKey).id))\r\n    // note: this is temporary until we support hex ids in instance filters\r\n    compareValue = hexToDec((value as InstanceKey).id);\r\n\r\n  if (type.typeName === \"point2d\" || type.typeName === \"point3d\") {\r\n    if (typeof value !== \"object\")\r\n      throw new Error(\"Expecting point values to be supplied as objects\");\r\n\r\n    const dimensionType: PrimitiveTypeDescription = {\r\n      valueFormat: PropertyValueFormat.Primitive,\r\n      typeName: \"double\",\r\n    };\r\n\r\n    const pointValue = value as Point;\r\n    let comparison = `${createComparison(dimensionType, `${name}.x`, operator, pointValue.x)}`;\r\n    comparison += ` AND ${createComparison(dimensionType, `${name}.y`, operator, pointValue.y)}`;\r\n    if (type.typeName === \"point3d\" && pointValue.z !== undefined)\r\n      comparison += ` AND ${createComparison(dimensionType, `${name}.z`, operator, pointValue.z)}`;\r\n\r\n    return comparison;\r\n  }\r\n\r\n  if (type.typeName === \"double\")\r\n    return `CompareDoubles(${name}, ${compareValue}) ${operator} 0`;\r\n\r\n  if (type.typeName === \"dateTime\")\r\n    return `CompareDateTimes(${name}, ${compareValue}) ${operator} 0`;\r\n\r\n  return `${name} ${operator} ${compareValue}`;\r\n};\r\n\r\nconst createMultiClassSpecification = (classInfo: Readonly<ClassInfo>): MultiSchemaClassesSpecification => {\r\n  const [schemaName, className] = classInfo.name.split(\":\");\r\n  return { schemaName, classNames: [className] };\r\n};\r\n\r\nconst createSingleClassSpecification = (classInfo: Readonly<ClassInfo>): SingleSchemaClassSpecification => {\r\n  const [schemaName, className] = classInfo.name.split(\":\");\r\n  return { schemaName, className };\r\n};\r\n\r\nconst createRelatedInstanceSpec = (pathFromSelectToPropertyClass: RelationshipPath, index: number): { spec: RelatedInstanceSpecification, class: ClassInfo } => ({\r\n  spec: {\r\n    relationshipPath: pathFromSelectToPropertyClass.map((step) => ({\r\n      relationship: createSingleClassSpecification(step.relationshipInfo),\r\n      direction: step.isForwardRelationship ? RelationshipDirection.Forward : RelationshipDirection.Backward,\r\n      targetClass: createSingleClassSpecification(step.targetClassInfo),\r\n    })),\r\n    isRequired: true,\r\n    alias: `related_${index}`,\r\n  },\r\n  class: pathFromSelectToPropertyClass[pathFromSelectToPropertyClass.length - 1].targetClassInfo,\r\n});\r\n\r\nconst createPathFromSelectToPropertyClass = (field: PropertiesField): RelationshipPath => {\r\n  let currField: Field = field;\r\n  const pathFromPropertyToSelectClass: RelationshipPath = [];\r\n  while (currField.parent) {\r\n    pathFromPropertyToSelectClass.push(...currField.parent.pathToPrimaryClass);\r\n    currField = currField.parent;\r\n  }\r\n  return RelationshipPath.reverse(pathFromPropertyToSelectClass);\r\n};\r\n\r\nconst createRelatedInstanceSpecInfo = (field: PropertiesField): { spec: RelatedInstanceSpecification, class: ClassInfo } | undefined => {\r\n  const path = createPathFromSelectToPropertyClass(field);\r\n  return path.length ? createRelatedInstanceSpec(path, 0) : undefined;\r\n};\r\n\r\nconst hexToDec = (id: Id64String) => {\r\n  const digits = [0];\r\n  for (let i = 2; i < id.length; ++i) {\r\n    let carry = parseInt(id.charAt(i), 16);\r\n    for (let j = 0; j < digits.length; ++j) {\r\n      digits[j] = digits[j] * 16 + carry;\r\n      carry = digits[j] / 10 | 0;\r\n      digits[j] %= 10;\r\n    }\r\n    while (carry > 0) {\r\n      digits.push(carry % 10);\r\n      carry = carry / 10 | 0;\r\n    }\r\n  }\r\n  return digits.reverse().join(\"\");\r\n};\r\n"]}
+{"version":3,"file":"RulesetsFactory.js","sourceRoot":"","sources":["../../../src/presentation-common/RulesetsFactory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6D;AAG7D,+DAA0F;AAC1F,2CAAsD;AACtD,6BAAgE;AAEhE,+EAAiF;AAEjF,yEAAsE;AACtE,uCAAyC;AAGzC;;;;;GAKG;AACH,MAAa,eAAe;IAClB,iCAAiC,CAAC,KAAY,EAAE,MAAY;QAClE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAC9F,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,qCAAmB,CAAC,SAAS;YAC1D,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,IAAI,CAAC,MAAM,CAAC,SAAS;YACnB,MAAM,IAAI,KAAK,CAAC,4FAA4F,CAAC,CAAC;QAChH,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,mBAAmB,GAAG,6BAA6B,CAAC,KAAK,CAAC,CAAC;QACjE,MAAM,YAAY,GAAG,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,KAAK,CAAC;QAChD,MAAM,OAAO,GAAY;YACvB,EAAE,EAAE,oBAAoB,YAAY,IAAI,mBAAI,CAAC,WAAW,EAAE,EAAE;YAC5D,KAAK,EAAE,EAAE;SACV,CAAC;QACF,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;YACjB,QAAQ,EAAE,gBAAS,CAAC,OAAO;YAC3B,cAAc,EAAE,CAAC;oBACf,QAAQ,EAAE,gDAAyB,CAAC,iCAAiC;oBACrE,OAAO,EAAE,6BAA6B,CAAC,MAAM,CAAC,SAAS,CAAC;oBACxD,8BAA8B,EAAE,IAAI;oBACpC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;oBACvE,cAAc,EAAE,oBAAoB,CAAC,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,GAAG,CAAC;iBAC7G,CAAC;SACH,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,6BAA6B,CAAC,KAAY,EAAE,MAAY,EAAE,mBAAiD;QACtH,MAAM,IAAI,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACnE,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;QAC5H,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC;IAChD,CAAC;CACF;AA9CD,0CA8CC;AAsBD,MAAM,QAAQ,GAAG,CAAC,YAAkC,EAAU,EAAE;IAC9D,IAAI,CAAC,YAAY;QACf,OAAO,MAAM,CAAC;IAChB,OAAO,YAAY,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,MAAY,EAAE,YAAmC,EAAE,KAAY,EAAE,KAAa,EAAU,EAAE;IACnH,MAAM,SAAS,GAAG,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,MAAM,CAAC,SAAU,CAAC;IACpD,OAAO,IAAI,SAAS,CAAC,KAAK,MAAM,KAAK,CAAC,KAAK,OAAO,KAAK,EAAE,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,KAAK,EAAE,MAAY,EAAE,YAAmC,EAAE,KAAY,EAAE,KAAwB,EAAE,mBAAiD,EAAmB,EAAE;IACrM,MAAM,YAAY,GAAG,mBAAmB,CAAC,CAAC,CAAC,MAAM,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9I,OAAO,iBAAiB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAE,EAAE;IACjD,IAAI,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC7C,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY;QACtC,IAAI,IAAI,KAAK,CAAC;IAChB,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,KAAY,EAAmC,EAAE;IACjF,IAAI,aAAK,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;QAC5B,OAAO,IAAI,CAAC;KACb;IAED,IAAI,aAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACtB,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ;eAC1B,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ;eAC3B,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,CAAC,EAAE;YAC3D,OAAO,IAAI,CAAC;SACb;QAED,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE;YACvE,OAAO,IAAI,CAAC;SACb;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAY,EAAE,KAAY,EAAqB,EAAE;IACzE,MAAM,eAAe,GAAG,EAAE,CAAC;IAC3B,IAAI,SAAS,GAAsB,KAAK,CAAC;IACzC,OAAO,SAAS,EAAE;QAChB,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;KAC9B;IACD,IAAI,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IAC1C,IAAI,YAAY,GAAiB,MAAM,CAAC,aAAa,CAAC,aAAc,CAAC,CAAC;IACtE,IAAI,KAAK,GAAU,MAAM,CAAC,MAAM,CAAC,aAAc,CAAC,CAAC;IACjD,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IACtC,OAAO,aAAa,EAAE;QACpB,IAAI,CAAC,aAAK,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAC;QACtH,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACrD,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACvC,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;KACvC;IACD,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;IACtF,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAC3B,mBAAuE,EACvE,YAAsC,EACtC,YAAoB,EACpB,aAAqC,EAC7B,EAAE;IACV,MAAM,KAAK,GAAG,mBAAmB,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACvE,OAAO,gBAAgB,CAAC,YAAY,EAAE,GAAG,KAAK,IAAI,YAAY,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;AACxF,CAAC,CAAC;AAGF,MAAM,gBAAgB,GAAG,CAAC,IAA8B,EAAE,IAAY,EAAE,QAAkB,EAAE,KAA6B,EAAU,EAAE;IACnI,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,QAAQ,OAAO,KAAK,EAAE;QACpB,KAAK,WAAW;YACd,YAAY,GAAG,MAAM,CAAC;YACtB,MAAM;QACR,KAAK,QAAQ;YACX,YAAY,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;YAChD,MAAM;QACR,KAAK,SAAS;YACZ,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YACxC,MAAM;QACR,KAAK,QAAQ;YACX,YAAY,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAChC,MAAM;KACT;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,YAAY,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,mBAAI,CAAC,MAAM,CAAE,KAAqB,CAAC,EAAE,CAAC;QACvG,uEAAuE;QACvE,YAAY,GAAG,QAAQ,CAAE,KAAqB,CAAC,EAAE,CAAC,CAAC;IAErD,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;QAC9D,IAAI,OAAO,KAAK,KAAK,QAAQ;YAC3B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEtE,MAAM,aAAa,GAA6B;YAC9C,WAAW,EAAE,qCAAmB,CAAC,SAAS;YAC1C,QAAQ,EAAE,QAAQ;SACnB,CAAC;QAEF,MAAM,UAAU,GAAG,KAAc,CAAC;QAClC,IAAI,UAAU,GAAG,GAAG,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3F,UAAU,IAAI,QAAQ,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,CAAC,KAAK,SAAS;YAC3D,UAAU,IAAI,QAAQ,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAE/F,OAAO,UAAU,CAAC;KACnB;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ;QAC5B,OAAO,kBAAkB,IAAI,KAAK,YAAY,KAAK,QAAQ,IAAI,CAAC;IAElE,IAAI,IAAI,CAAC,QAAQ,KAAK,UAAU;QAC9B,OAAO,oBAAoB,IAAI,KAAK,YAAY,KAAK,QAAQ,IAAI,CAAC;IAEpE,OAAO,GAAG,IAAI,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,SAA8B,EAAmC,EAAE;IACxG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,8BAA8B,GAAG,CAAC,SAA8B,EAAkC,EAAE;IACxG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,6BAA+C,EAAE,KAAa,EAA4D,EAAE,CAAC,CAAC;IAC/J,IAAI,EAAE;QACJ,gBAAgB,EAAE,6BAA6B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC7D,YAAY,EAAE,8BAA8B,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACnE,SAAS,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,6CAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,6CAAqB,CAAC,QAAQ;YACtG,WAAW,EAAE,8BAA8B,CAAC,IAAI,CAAC,eAAe,CAAC;SAClE,CAAC,CAAC;QACH,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,WAAW,KAAK,EAAE;KAC1B;IACD,KAAK,EAAE,6BAA6B,CAAC,6BAA6B,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,eAAe;CAC/F,CAAC,CAAC;AAEH,MAAM,mCAAmC,GAAG,CAAC,KAAsB,EAAoB,EAAE;IACvF,IAAI,SAAS,GAAU,KAAK,CAAC;IAC7B,MAAM,6BAA6B,GAAqB,EAAE,CAAC;IAC3D,OAAO,SAAS,CAAC,MAAM,EAAE;QACvB,6BAA6B,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC3E,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;KAC9B;IACD,OAAO,qBAAgB,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,KAAsB,EAAwE,EAAE;IACrI,MAAM,IAAI,GAAG,mCAAmC,CAAC,KAAK,CAAC,CAAC;IACxD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,EAAc,EAAE,EAAE;IAClC,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QAClC,IAAI,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACtC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACnC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAC3B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACjB;QACD,OAAO,KAAK,GAAG,CAAC,EAAE;YAChB,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;YACxB,KAAK,GAAG,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC;SACxB;KACF;IACD,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Core\n */\n\nimport { Guid, Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Field, PropertiesField } from \"./content/Fields\";\nimport { Item } from \"./content/Item\";\nimport { PrimitiveTypeDescription, PropertyValueFormat } from \"./content/TypeDescription\";\nimport { DisplayValue, Value } from \"./content/Value\";\nimport { ClassInfo, InstanceKey, RelationshipPath } from \"./EC\";\nimport { MultiSchemaClassesSpecification, SingleSchemaClassSpecification } from \"./rules/ClassSpecifications\";\nimport { ContentSpecificationTypes } from \"./rules/content/ContentSpecification\";\nimport { RelatedInstanceSpecification } from \"./rules/RelatedInstanceSpecification\";\nimport { RelationshipDirection } from \"./rules/RelationshipDirection\";\nimport { RuleTypes } from \"./rules/Rule\";\nimport { Ruleset } from \"./rules/Ruleset\";\n\n/**\n * A factory class that can be used to create presentation rulesets targeted towards\n * specific use cases.\n *\n * @public\n */\nexport class RulesetsFactory {\n  private createSimilarInstancesRulesetInfo(field: Field, record: Item) {\n    if (!field.isPropertiesField())\n      throw new Error(\"Can only create 'similar instances' ruleset for properties-based records\");\n    if (field.type.valueFormat !== PropertyValueFormat.Primitive)\n      throw new Error(\"Can only create 'similar instances' ruleset for primitive properties\");\n    if (field.properties.length === 0)\n      throw new Error(\"Invalid properties' field with no properties\");\n    if (record.isFieldMerged(field.name))\n      throw new Error(\"Can't create 'similar instances' ruleset for merged values\");\n    if (!record.classInfo)\n      throw new Error(\"Can't create 'similar instances' for records based on multiple different ECClass instances\");\n    const propertyName = getPropertyName(field);\n    const propertyValue = getPropertyValue(record, field);\n    const relatedInstanceInfo = createRelatedInstanceSpecInfo(field);\n    const relatedClass = relatedInstanceInfo?.class;\n    const ruleset: Ruleset = {\n      id: `SimilarInstances/${propertyName}/${Guid.createValue()}`,\n      rules: [],\n    };\n    ruleset.rules.push({\n      ruleType: RuleTypes.Content,\n      specifications: [{\n        specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses,\n        classes: createMultiClassSpecification(record.classInfo),\n        handleInstancesPolymorphically: true,\n        relatedInstances: relatedInstanceInfo ? [relatedInstanceInfo.spec] : [],\n        instanceFilter: createInstanceFilter(relatedInstanceInfo?.spec, field.type, propertyName, propertyValue.raw),\n      }],\n    });\n    return { ruleset, relatedClass, propertyName, propertyValue };\n  }\n\n  /**\n   * Create a ruleset with content rules for getting instances are of the\n   * same ECClass and have the same property value as the provided `record`.\n   * @param field A field identifying which property of the record we should use\n   * @param record A record whose similar instances should be found\n   * @param computeDisplayValue Optional callback function to calculate display value that's\n   * used in ruleset's description. If not provided, display value from record is used instead.\n   */\n  public async createSimilarInstancesRuleset(field: Field, record: Item, computeDisplayValue?: ComputeDisplayValueCallback): Promise<{ ruleset: Ruleset, description: string }> {\n    const info = this.createSimilarInstancesRulesetInfo(field, record);\n    const description = await createDescriptionAsync(record, info.relatedClass, field, info.propertyValue, computeDisplayValue);\n    return { ruleset: info.ruleset, description };\n  }\n}\n\n/**\n * Definition of a function for calculating a display value.\n * @public\n */\nexport type ComputeDisplayValueCallback = (type: string, value: PrimitivePropertyValue, displayValue: string) => Promise<string>;\n\ninterface PrimitiveValueDef {\n  raw: PrimitivePropertyValue;\n  display: string;\n}\n\n/**\n * Value of a primitive property.\n * @public\n */\nexport type PrimitivePropertyValue = string | number | boolean | Point | InstanceKey | undefined;\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\ntype Point = { x: number, y: number, z?: number };\n\nconst toString = (displayValue: Value | DisplayValue): string => {\n  if (!displayValue)\n    return \"NULL\";\n  return displayValue.toString();\n};\n\nconst createDescription = (record: Item, relatedClass: ClassInfo | undefined, field: Field, value: string): string => {\n  const classInfo = relatedClass ?? record.classInfo!;\n  return `[${classInfo.label}].[${field.label}] = ${value}`;\n};\n\nconst createDescriptionAsync = async (record: Item, relatedClass: ClassInfo | undefined, field: Field, value: PrimitiveValueDef, computeDisplayValue?: ComputeDisplayValueCallback): Promise<string> => {\n  const displayValue = computeDisplayValue ? await computeDisplayValue(field.type.typeName, value.raw, value.display) : toString(value.display);\n  return createDescription(record, relatedClass, field, displayValue);\n};\n\nconst getPropertyName = (field: PropertiesField) => {\n  let name = field.properties[0].property.name;\n  if (field.type.typeName === \"navigation\")\n    name += \".Id\";\n  return name;\n};\n\nconst isPrimitivePropertyValue = (value: Value): value is PrimitivePropertyValue => {\n  if (Value.isPrimitive(value)) {\n    return true;\n  }\n\n  if (Value.isMap(value)) {\n    if (typeof value.x === \"number\"\n      && typeof value.y === \"number\"\n      && (value.z === undefined || typeof value.z === \"number\")) {\n      return true;\n    }\n\n    if (typeof value.className === \"string\" && typeof value.id === \"string\") {\n      return true;\n    }\n  }\n\n  return false;\n};\n\nconst getPropertyValue = (record: Item, field: Field): PrimitiveValueDef => {\n  const fieldNamesStack = [];\n  let currField: Field | undefined = field;\n  while (currField) {\n    fieldNamesStack.push(currField.name);\n    currField = currField.parent;\n  }\n  let currFieldName = fieldNamesStack.pop();\n  let displayValue: DisplayValue = record.displayValues[currFieldName!];\n  let value: Value = record.values[currFieldName!];\n  currFieldName = fieldNamesStack.pop();\n  while (currFieldName) {\n    if (!Value.isNestedContent(value) || value.length === 0)\n      throw new Error(\"Invalid record value\");\n    if (value.length > 1)\n      throw new Error(\"Can't create 'similar instances' for records related through many part of *-to-many relationship\");\n    if (value[0].mergedFieldNames.indexOf(currFieldName) !== -1)\n      throw new Error(\"Can't create 'similar instances' ruleset for merged values\");\n    displayValue = value[0].displayValues[currFieldName];\n    value = value[0].values[currFieldName];\n    currFieldName = fieldNamesStack.pop();\n  }\n  if (!isPrimitivePropertyValue(value))\n    throw new Error(\"Can only create 'similar instances' ruleset for primitive values\");\n  return { raw: value, display: toString(displayValue) };\n};\n\nconst createInstanceFilter = (\n  relatedInstanceSpec: Readonly<RelatedInstanceSpecification> | undefined,\n  propertyType: PrimitiveTypeDescription,\n  propertyName: string,\n  propertyValue: PrimitivePropertyValue,\n): string => {\n  const alias = relatedInstanceSpec ? relatedInstanceSpec.alias : \"this\";\n  return createComparison(propertyType, `${alias}.${propertyName}`, \"=\", propertyValue);\n};\n\ntype Operator = \"=\" | \"!=\" | \">\" | \">=\" | \"<\" | \"<=\";\nconst createComparison = (type: PrimitiveTypeDescription, name: string, operator: Operator, value: PrimitivePropertyValue): string => {\n  let compareValue = \"\";\n  switch (typeof value) {\n    case \"undefined\":\n      compareValue = \"NULL\";\n      break;\n    case \"string\":\n      compareValue = `\"${value.replace(/\"/g, `\"\"`)}\"`;\n      break;\n    case \"boolean\":\n      compareValue = value ? \"TRUE\" : \"FALSE\";\n      break;\n    case \"number\":\n      compareValue = value.toString();\n      break;\n  }\n\n  if (type.typeName === \"navigation\" && typeof value === \"object\" && Id64.isId64((value as InstanceKey).id))\n    // note: this is temporary until we support hex ids in instance filters\n    compareValue = hexToDec((value as InstanceKey).id);\n\n  if (type.typeName === \"point2d\" || type.typeName === \"point3d\") {\n    if (typeof value !== \"object\")\n      throw new Error(\"Expecting point values to be supplied as objects\");\n\n    const dimensionType: PrimitiveTypeDescription = {\n      valueFormat: PropertyValueFormat.Primitive,\n      typeName: \"double\",\n    };\n\n    const pointValue = value as Point;\n    let comparison = `${createComparison(dimensionType, `${name}.x`, operator, pointValue.x)}`;\n    comparison += ` AND ${createComparison(dimensionType, `${name}.y`, operator, pointValue.y)}`;\n    if (type.typeName === \"point3d\" && pointValue.z !== undefined)\n      comparison += ` AND ${createComparison(dimensionType, `${name}.z`, operator, pointValue.z)}`;\n\n    return comparison;\n  }\n\n  if (type.typeName === \"double\")\n    return `CompareDoubles(${name}, ${compareValue}) ${operator} 0`;\n\n  if (type.typeName === \"dateTime\")\n    return `CompareDateTimes(${name}, ${compareValue}) ${operator} 0`;\n\n  return `${name} ${operator} ${compareValue}`;\n};\n\nconst createMultiClassSpecification = (classInfo: Readonly<ClassInfo>): MultiSchemaClassesSpecification => {\n  const [schemaName, className] = classInfo.name.split(\":\");\n  return { schemaName, classNames: [className] };\n};\n\nconst createSingleClassSpecification = (classInfo: Readonly<ClassInfo>): SingleSchemaClassSpecification => {\n  const [schemaName, className] = classInfo.name.split(\":\");\n  return { schemaName, className };\n};\n\nconst createRelatedInstanceSpec = (pathFromSelectToPropertyClass: RelationshipPath, index: number): { spec: RelatedInstanceSpecification, class: ClassInfo } => ({\n  spec: {\n    relationshipPath: pathFromSelectToPropertyClass.map((step) => ({\n      relationship: createSingleClassSpecification(step.relationshipInfo),\n      direction: step.isForwardRelationship ? RelationshipDirection.Forward : RelationshipDirection.Backward,\n      targetClass: createSingleClassSpecification(step.targetClassInfo),\n    })),\n    isRequired: true,\n    alias: `related_${index}`,\n  },\n  class: pathFromSelectToPropertyClass[pathFromSelectToPropertyClass.length - 1].targetClassInfo,\n});\n\nconst createPathFromSelectToPropertyClass = (field: PropertiesField): RelationshipPath => {\n  let currField: Field = field;\n  const pathFromPropertyToSelectClass: RelationshipPath = [];\n  while (currField.parent) {\n    pathFromPropertyToSelectClass.push(...currField.parent.pathToPrimaryClass);\n    currField = currField.parent;\n  }\n  return RelationshipPath.reverse(pathFromPropertyToSelectClass);\n};\n\nconst createRelatedInstanceSpecInfo = (field: PropertiesField): { spec: RelatedInstanceSpecification, class: ClassInfo } | undefined => {\n  const path = createPathFromSelectToPropertyClass(field);\n  return path.length ? createRelatedInstanceSpec(path, 0) : undefined;\n};\n\nconst hexToDec = (id: Id64String) => {\n  const digits = [0];\n  for (let i = 2; i < id.length; ++i) {\n    let carry = parseInt(id.charAt(i), 16);\n    for (let j = 0; j < digits.length; ++j) {\n      digits[j] = digits[j] * 16 + carry;\n      carry = digits[j] / 10 | 0;\n      digits[j] %= 10;\n    }\n    while (carry > 0) {\n      digits.push(carry % 10);\n      carry = carry / 10 | 0;\n    }\n  }\n  return digits.reverse().join(\"\");\n};\n"]}