@itwin/presentation-common 5.0.0-dev.10 → 5.0.0-dev.102

package/lib/cjs/presentation-common/content/Descriptor.js

@@ -9,9 +9,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Descriptor = exports.SortDirection = exports.ContentFlags = exports.SelectClassInfo = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
-const EC_1 = require("../EC");
-const Category_1 = require("./Category");
-const Fields_1 = require("./Fields");
+const EC_js_1 = require("../EC.js");
+const Utils_js_1 = require("../Utils.js");
+const Category_js_1 = require("./Category.js");
+const Fields_js_1 = require("./Fields.js");
 /** @public */
 var SelectClassInfo;
 (function (SelectClassInfo) {
@@ -22,18 +23,18 @@ var SelectClassInfo;
             selectClassInfo: { id: json.selectClassInfo, ...classesMap[json.selectClassInfo] },
             isSelectPolymorphic: json.isSelectPolymorphic,
             ...(json.navigationPropertyClasses
-                ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => EC_1.RelatedClassInfo.fromCompressedJSON(item, classesMap)) }
+                ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => EC_js_1.RelatedClassInfo.fromCompressedJSON(item, classesMap)) }
                 : undefined),
             ...(json.relatedInstancePaths
-                ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => EC_1.RelatedClassInfo.fromCompressedJSON(item, classesMap))) }
+                ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => EC_js_1.RelatedClassInfo.fromCompressedJSON(item, classesMap))) }
                 : undefined),
             ...(json.pathFromInputToSelectClass
                 ? {
-                    pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) => EC_1.RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap)),
+                    pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) => EC_js_1.RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap)),
                 }
                 : undefined),
             ...(json.relatedPropertyPaths
-                ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => EC_1.RelatedClassInfo.fromCompressedJSON(item, classesMap))) }
+                ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => EC_js_1.RelatedClassInfo.fromCompressedJSON(item, classesMap))) }
                 : undefined),
         };
     }
@@ -46,37 +47,26 @@ var SelectClassInfo;
             selectClassInfo: id,
             isSelectPolymorphic: selectClass.isSelectPolymorphic,
             ...(selectClass.relatedInstancePaths
-                ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => EC_1.RelatedClassInfo.toCompressedJSON(item, classesMap))) }
+                ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => EC_js_1.RelatedClassInfo.toCompressedJSON(item, classesMap))) }
                 : undefined),
             ...(selectClass.navigationPropertyClasses
                 ? {
-                    navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) => EC_1.RelatedClassInfo.toCompressedJSON(propertyClass, classesMap)),
+                    navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) => EC_js_1.RelatedClassInfo.toCompressedJSON(propertyClass, classesMap)),
                 }
                 : undefined),
             ...(selectClass.pathFromInputToSelectClass
                 ? {
-                    pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) => EC_1.RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap)),
+                    pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) => EC_js_1.RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap)),
                 }
                 : undefined),
             ...(selectClass.relatedPropertyPaths
                 ? {
-                    relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) => path.map((relatedClass) => EC_1.RelatedClassInfo.toCompressedJSON(relatedClass, classesMap))),
+                    relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) => path.map((relatedClass) => EC_js_1.RelatedClassInfo.toCompressedJSON(relatedClass, classesMap))),
                 }
                 : undefined),
         };
     }
     SelectClassInfo.toCompressedJSON = toCompressedJSON;
-    /**
-     * Deserialize [[SelectClassInfo]] list from JSON
-     * @param json JSON or JSON serialized to string to deserialize from
-     * @returns Deserialized [[SelectClassInfo]] objects list
-     *
-     * @internal
-     */
-    function listFromCompressedJSON(json, classesMap) {
-        return json.map((sci) => fromCompressedJSON(sci, classesMap));
-    }
-    SelectClassInfo.listFromCompressedJSON = listFromCompressedJSON;
 })(SelectClassInfo || (exports.SelectClassInfo = SelectClassInfo = {}));
 /**
  * Flags that control content format.
@@ -86,11 +76,6 @@ var ContentFlags;
 (function (ContentFlags) {
     /** Each content record only has [[InstanceKey]] and no data */
     ContentFlags[ContentFlags["KeysOnly"] = 1] = "KeysOnly";
-    /**
-     * Each content record additionally has an image id
-     * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    ContentFlags[ContentFlags["ShowImages"] = 2] = "ShowImages";
     /** Each content record additionally has a display label */
     ContentFlags[ContentFlags["ShowLabels"] = 4] = "ShowLabels";
     /** All content records are merged into a single record (see [Merging values]($docs/presentation/content/terminology#value-merging)) */
@@ -104,12 +89,6 @@ var ContentFlags;
      * given input key at the cost of performance creating those items.
      */
     ContentFlags[ContentFlags["IncludeInputKeys"] = 256] = "IncludeInputKeys";
-    /**
-     * Produce content descriptor that is not intended for querying content. Allows the implementation to omit certain
-     * operations to make obtaining content descriptor faster.
-     * @internal
-     */
-    ContentFlags[ContentFlags["DescriptorOnly"] = 512] = "DescriptorOnly";
 })(ContentFlags || (exports.ContentFlags = ContentFlags = {}));
 /**
  * Data sorting direction
@@ -127,6 +106,53 @@ var SortDirection;
  * @public
  */
 class Descriptor {
+    /** Id of the connection used to create the descriptor */
+    connectionId;
+    /** Hash of the input keys used to create the descriptor */
+    inputKeysHash;
+    /** Selection info used to create the descriptor */
+    selectionInfo;
+    /** Display type used to create the descriptor */
+    displayType;
+    /** A list of classes that will be selected when creating content with this descriptor */
+    selectClasses;
+    /** A list of content field categories used in this descriptor */
+    categories;
+    /** A list of fields contained in the descriptor */
+    fields;
+    /** [[ContentFlags]] used to create the descriptor */
+    contentFlags;
+    /**
+     * A ruleset used to create this descriptor.
+     * Only set if descriptor is created using a ruleset different from the input ruleset, e.g. when creating a hierarchy level descriptor.
+     */
+    ruleset;
+    /** Field used to sort the content */
+    sortingField;
+    /** Sorting direction */
+    sortDirection;
+    /**
+     * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content by
+     * select fields.
+     *
+     * This is different from [[instanceFilter]] as filtering is applied on the union of all selects,
+     * which removes access to content instance property values. Instead of referencing properties
+     * through `this.PropertyName` alias, the expression should reference them by field names. In cases
+     * when properties field merges multiple properties, this allows applying the filter on all of them
+     * at once. This is useful for filtering table rows by column value, when content is displayed in
+     * table format.
+     */
+    fieldsFilterExpression;
+    /**
+     * Instances filter that allows filtering content by class, properties of specific class
+     * or properties of instances related to the content instance.
+     *
+     * This is different from [[fieldsFilterExpression]] as filter is applied at a lower level - on
+     * specific select class rather than a union of multiple select classes. This means the filter has
+     * access to properties of that class and they can be referenced using symbols like `this.Property`.
+     * This is useful for filtering instances of specific class.
+     */
+    instanceFilter;
     /** Construct a new Descriptor using a [[DescriptorSource]] */
     constructor(source) {
         this.connectionId = source.connectionId;
@@ -139,8 +165,7 @@ class Descriptor {
         this.fields = [...source.fields];
         this.sortingField = source.sortingField;
         this.sortDirection = source.sortDirection;
-        this.filterExpression = source.fieldsFilterExpression ?? source.filterExpression; // eslint-disable-line @typescript-eslint/no-deprecated
-        this.fieldsFilterExpression = source.fieldsFilterExpression ?? source.filterExpression; // eslint-disable-line @typescript-eslint/no-deprecated
+        this.fieldsFilterExpression = source.fieldsFilterExpression;
         this.instanceFilter = source.instanceFilter;
         this.ruleset = source.ruleset;
     }
@@ -149,34 +174,40 @@ class Descriptor {
         const classesMap = {};
         const selectClasses = this.selectClasses.map((selectClass) => SelectClassInfo.toCompressedJSON(selectClass, classesMap));
         const fields = this.fields.map((field) => field.toCompressedJSON(classesMap));
-        return Object.assign({
+        return (0, Utils_js_1.omitUndefined)({
             displayType: this.displayType,
             contentFlags: this.contentFlags,
-            categories: this.categories.map(Category_1.CategoryDescription.toJSON),
+            categories: this.categories.map(Category_js_1.CategoryDescription.toJSON),
             fields,
             selectClasses,
             classesMap,
-        }, this.connectionId !== undefined && { connectionId: this.connectionId }, this.inputKeysHash !== undefined && { inputKeysHash: this.inputKeysHash }, 
-        // istanbul ignore next
-        this.contentOptions !== undefined && { contentOptions: this.contentOptions }, // eslint-disable-line @typescript-eslint/no-deprecated
-        this.sortingField !== undefined && { sortingFieldName: this.sortingField.name }, this.sortDirection !== undefined && { sortDirection: this.sortDirection }, this.filterExpression !== undefined && { filterExpression: this.filterExpression }, // eslint-disable-line @typescript-eslint/no-deprecated
-        this.fieldsFilterExpression !== undefined && { fieldsFilterExpression: this.fieldsFilterExpression }, this.instanceFilter !== undefined && { instanceFilter: this.instanceFilter }, this.selectionInfo !== undefined && { selectionInfo: this.selectionInfo }, this.ruleset !== undefined && { ruleset: this.ruleset });
+            connectionId: this.connectionId ?? "",
+            inputKeysHash: this.inputKeysHash ?? "",
+            sortingFieldName: this.sortingField?.name,
+            sortDirection: this.sortDirection,
+            fieldsFilterExpression: this.fieldsFilterExpression,
+            instanceFilter: this.instanceFilter,
+            selectionInfo: this.selectionInfo,
+            ruleset: this.ruleset,
+        });
     }
     /** Deserialize [[Descriptor]] from JSON */
     static fromJSON(json) {
         if (!json) {
             return undefined;
         }
-        const { classesMap, ...leftOverJson } = json;
-        const categories = Category_1.CategoryDescription.listFromJSON(json.categories);
-        const selectClasses = SelectClassInfo.listFromCompressedJSON(json.selectClasses, classesMap);
-        const fields = this.getFieldsFromJSON(json.fields, (fieldJson) => Fields_1.Field.fromCompressedJSON(fieldJson, classesMap, categories));
+        const { categories: jsonCategories, selectClasses: jsonSelectClasses, fields: jsonFields, connectionId, inputKeysHash, classesMap, sortingFieldName, ...leftOverJson } = json;
+        const categories = Category_js_1.CategoryDescription.listFromJSON(jsonCategories);
+        const selectClasses = jsonSelectClasses.map((jsc) => SelectClassInfo.fromCompressedJSON(jsc, classesMap));
+        const fields = this.getFieldsFromJSON(jsonFields, (fieldJson) => Fields_js_1.Field.fromCompressedJSON(fieldJson, classesMap, categories));
         return new Descriptor({
             ...leftOverJson,
+            ...(connectionId ? /* c8 ignore next */ { connectionId } : undefined),
+            ...(inputKeysHash ? /* c8 ignore next */ { inputKeysHash } : undefined),
             selectClasses,
             categories,
             fields,
-            sortingField: (0, Fields_1.getFieldByName)(fields, json.sortingFieldName, true),
+            sortingField: (0, Fields_js_1.getFieldByName)(fields, sortingFieldName, true),
         });
     }
     static getFieldsFromJSON(json, factory) {
@@ -196,13 +227,13 @@ class Descriptor {
      * @param recurse Recurse into nested fields
      */
     getFieldByName(name, recurse) {
-        return (0, Fields_1.getFieldByName)(this.fields, name, recurse);
+        return (0, Fields_js_1.getFieldByName)(this.fields, name, recurse);
     }
     /**
      * Get field by its descriptor.
      */
     getFieldByDescriptor(fieldDescriptor, recurse) {
-        return (0, Fields_1.getFieldByDescriptor)(this.fields, fieldDescriptor, recurse);
+        return (0, Fields_js_1.getFieldByDescriptor)(this.fields, fieldDescriptor, recurse);
     }
     /**
      * Create descriptor overrides object from this descriptor.
@@ -216,10 +247,8 @@ class Descriptor {
         if (this.contentFlags !== 0) {
             overrides.contentFlags = this.contentFlags;
         }
-        // eslint-disable-next-line @typescript-eslint/no-deprecated
-        if (this.filterExpression || this.fieldsFilterExpression) {
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            overrides.fieldsFilterExpression = this.fieldsFilterExpression ?? this.filterExpression;
+        if (this.fieldsFilterExpression) {
+            overrides.fieldsFilterExpression = this.fieldsFilterExpression;
         }
         if (this.instanceFilter) {
             overrides.instanceFilter = this.instanceFilter;

package/lib/cjs/presentation-common/content/Descriptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"Descriptor.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Descriptor.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,sDAAyD;AACzD,8BAUe;AAGf,yCAA0E;AAC1E,qCAAmG;AAwCnG,cAAc;AACd,IAAiB,eAAe,CAsE/B;AAtED,WAAiB,eAAe;IAC9B,2DAA2D;IAC3D,SAAgB,kBAAkB,CAAC,IAAiC,EAAE,UAAqD;QACzH,IAAA,qBAAM,EAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;QACxD,OAAO;YACL,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,eAAe,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE;YAClF,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,GAAG,CAAC,IAAI,CAAC,yBAAyB;gBAChC,CAAC,CAAC,EAAE,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE;gBACpI,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,oBAAoB;gBAC3B,CAAC,CAAC,EAAE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE;gBAC5I,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,0BAA0B;gBACjC,CAAC,CAAC;oBACE,0BAA0B,EAAE,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACvE,6CAAwC,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAC9E;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,oBAAoB;gBAC3B,CAAC,CAAC,EAAE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE;gBAC9I,CAAC,CAAC,SAAS,CAAC;SACf,CAAC;IACJ,CAAC;IAtBe,kCAAkB,qBAsBjC,CAAA;IAED,uDAAuD;IACvD,SAAgB,gBAAgB,CAAC,WAA4B,EAAE,UAAqD;QAClH,MAAM,EAAE,EAAE,EAAE,GAAG,iBAAiB,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC;QACjE,UAAU,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC;QACnC,OAAO;YACL,eAAe,EAAE,EAAE;YACnB,mBAAmB,EAAE,WAAW,CAAC,mBAAmB;YACpD,GAAG,CAAC,WAAW,CAAC,oBAAoB;gBAClC,CAAC,CAAC,EAAE,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAgB,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE;gBACjJ,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,WAAW,CAAC,yBAAyB;gBACvC,CAAC,CAAC;oBACE,yBAAyB,EAAE,WAAW,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CACrF,qBAAgB,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,CAAC,CAC7D;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,WAAW,CAAC,0BAA0B;gBACxC,CAAC,CAAC;oBACE,0BAA0B,EAAE,WAAW,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC9E,6CAAwC,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAC5E;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,WAAW,CAAC,oBAAoB;gBAClC,CAAC,CAAC;oBACE,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAClE,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,qBAAgB,CAAC,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CACxF;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;SACf,CAAC;IACJ,CAAC;IA/Be,gCAAgB,mBA+B/B,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,sBAAsB,CAAC,IAAuC,EAAE,UAAqD;QACnI,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC;IAChE,CAAC;IAFe,sCAAsB,yBAErC,CAAA;AACH,CAAC,EAtEgB,eAAe,+BAAf,eAAe,QAsE/B;AAED;;;GAGG;AACH,IAAY,YAkCX;AAlCD,WAAY,YAAY;IACtB,+DAA+D;IAC/D,uDAAiB,CAAA;IAEjB;;;OAGG;IACH,2DAAmB,CAAA;IAEnB,2DAA2D;IAC3D,2DAAmB,CAAA;IAEnB,uIAAuI;IACvI,+DAAqB,CAAA;IAErB,uCAAuC;IACvC,oEAAuB,CAAA;IAEvB,oGAAoG;IACpG,wDAAiB,CAAA;IAEjB;;;OAGG;IACH,yEAAyB,CAAA;IAEzB;;;;OAIG;IACH,qEAAuB,CAAA;AACzB,CAAC,EAlCW,YAAY,4BAAZ,YAAY,QAkCvB;AAED;;;GAGG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,2DAAS,CAAA;IACT,6DAAU,CAAA;AACZ,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AA8JD;;;;;GAKG;AACH,MAAa,UAAU;IA2DrB,8DAA8D;IAC9D,YAAmB,MAAwB;QACzC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,sBAAsB,IAAI,MAAM,CAAC,gBAAgB,CAAC,CAAC,uDAAuD;QACzI,IAAI,CAAC,sBAAsB,GAAG,MAAM,CAAC,sBAAsB,IAAI,MAAM,CAAC,gBAAgB,CAAC,CAAC,uDAAuD;QAC/I,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,uCAAuC;IAChC,MAAM;QACX,MAAM,UAAU,GAA8C,EAAE,CAAC;QACjE,MAAM,aAAa,GAAkC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,eAAe,CAAC,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;QACxJ,MAAM,MAAM,GAAwB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QACnG,OAAO,MAAM,CAAC,MAAM,CAClB;YACE,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,8BAAmB,CAAC,MAAM,CAAC;YAC3D,MAAM;YACN,aAAa;YACb,UAAU;SACX,EACD,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,EACtE,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE;QACzE,uBAAuB;QACvB,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,EAAE,uDAAuD;QACrI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,EAC/E,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,EACzE,IAAI,CAAC,gBAAgB,KAAK,SAAS,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EAAE,EAAE,uDAAuD;QAC3I,IAAI,CAAC,sBAAsB,KAAK,SAAS,IAAI,EAAE,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,EAAE,EACpG,IAAI,CAAC,cAAc,KAAK,SAAS,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,EAC5E,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,EACzE,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CACxD,CAAC;IACJ,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,QAAQ,CAAC,IAAgC;QACrD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC;QAC7C,MAAM,UAAU,GAAG,8BAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,MAAM,aAAa,GAAG,eAAe,CAAC,sBAAsB,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;QAC7F,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,cAAK,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;QAC/H,OAAO,IAAI,UAAU,CAAC;YACpB,GAAG,YAAY;YACf,aAAa;YACb,UAAU;YACV,MAAM;YACN,YAAY,EAAE,IAAA,uBAAc,EAAC,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC;SAClE,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,IAAiB,EAAE,OAA+C;QACjG,OAAO,IAAI;aACR,GAAG,CAAC,CAAC,SAAoB,EAAE,EAAE;YAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;YACjC,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,KAAK,EAAkB,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAAY,EAAE,OAAiB;QACnD,OAAO,IAAA,uBAAc,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,oBAAoB,CAAC,eAAgC,EAAE,OAAiB;QAC7E,OAAO,IAAA,6BAAoB,EAAC,IAAI,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,yBAAyB;QAC9B,MAAM,SAAS,GAAwB,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC3C,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;YAC5B,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7C,CAAC;QACD,4DAA4D;QAC5D,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YACzD,4DAA4D;YAC5D,SAAS,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,IAAI,IAAI,CAAC,gBAAgB,CAAC;QAC1F,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QACjD,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,SAAS,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;QAClI,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAjLD,gCAiLC","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 Content\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport {\r\n  ClassInfo,\r\n  ClassInfoJSON,\r\n  CompressedClassInfoJSON,\r\n  RelatedClassInfo,\r\n  RelatedClassInfoJSON,\r\n  RelatedClassInfoWithOptionalRelationship,\r\n  RelatedClassInfoWithOptionalRelationshipJSON,\r\n  RelationshipPath,\r\n  RelationshipPathJSON,\r\n} from \"../EC\";\r\nimport { InstanceFilterDefinition } from \"../InstanceFilterDefinition\";\r\nimport { Ruleset } from \"../rules/Ruleset\";\r\nimport { CategoryDescription, CategoryDescriptionJSON } from \"./Category\";\r\nimport { Field, FieldDescriptor, FieldJSON, getFieldByDescriptor, getFieldByName } from \"./Fields\";\r\n\r\n/**\r\n * Data structure that describes an ECClass in content [[Descriptor]].\r\n * @public\r\n */\r\nexport interface SelectClassInfo {\r\n  /** Information about the ECClass */\r\n  selectClassInfo: ClassInfo;\r\n\r\n  /** Is the class handled polymorphically */\r\n  isSelectPolymorphic: boolean;\r\n\r\n  /** Relationship path from input class to the select class. */\r\n  pathFromInputToSelectClass?: RelatedClassInfoWithOptionalRelationship[];\r\n\r\n  /** Relationship paths to [related property]($docs/presentation/content/Terminology#related-properties) classes */\r\n  relatedPropertyPaths?: RelationshipPath[];\r\n\r\n  /** Relationship paths to navigation property classes */\r\n  navigationPropertyClasses?: RelatedClassInfo[];\r\n\r\n  /** Relationship paths to [related instance]($docs/presentation/content/Terminology#related-instance) classes. */\r\n  relatedInstancePaths?: RelationshipPath[];\r\n}\r\n\r\n/**\r\n * Serialized [[SelectClassInfo]] JSON representation\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/no-deprecated\r\nexport interface SelectClassInfoJSON<TClassInfoJSON = ClassInfoJSON> {\r\n  selectClassInfo: TClassInfoJSON;\r\n  isSelectPolymorphic: boolean;\r\n  pathFromInputToSelectClass?: RelatedClassInfoWithOptionalRelationshipJSON<TClassInfoJSON>[];\r\n  relatedPropertyPaths?: RelationshipPathJSON<TClassInfoJSON>[];\r\n  navigationPropertyClasses?: RelatedClassInfoJSON<TClassInfoJSON>[];\r\n  relatedInstancePaths?: RelationshipPathJSON<TClassInfoJSON>[];\r\n}\r\n\r\n/** @public */\r\nexport namespace SelectClassInfo {\r\n  /** Deserialize [[SelectClassInfo]] from compressed JSON */\r\n  export function fromCompressedJSON(json: SelectClassInfoJSON<string>, classesMap: { [id: string]: CompressedClassInfoJSON }): SelectClassInfo {\r\n    assert(classesMap.hasOwnProperty(json.selectClassInfo));\r\n    return {\r\n      selectClassInfo: { id: json.selectClassInfo, ...classesMap[json.selectClassInfo] },\r\n      isSelectPolymorphic: json.isSelectPolymorphic,\r\n      ...(json.navigationPropertyClasses\r\n        ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap)) }\r\n        : undefined),\r\n      ...(json.relatedInstancePaths\r\n        ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) }\r\n        : undefined),\r\n      ...(json.pathFromInputToSelectClass\r\n        ? {\r\n            pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) =>\r\n              RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap),\r\n            ),\r\n          }\r\n        : undefined),\r\n      ...(json.relatedPropertyPaths\r\n        ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) }\r\n        : undefined),\r\n    };\r\n  }\r\n\r\n  /** Serialize [[SelectClassInfo]] to compressed JSON */\r\n  export function toCompressedJSON(selectClass: SelectClassInfo, classesMap: { [id: string]: CompressedClassInfoJSON }): SelectClassInfoJSON<string> {\r\n    const { id, ...leftOverClassInfo } = selectClass.selectClassInfo;\r\n    classesMap[id] = leftOverClassInfo;\r\n    return {\r\n      selectClassInfo: id,\r\n      isSelectPolymorphic: selectClass.isSelectPolymorphic,\r\n      ...(selectClass.relatedInstancePaths\r\n        ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.toCompressedJSON(item, classesMap))) }\r\n        : undefined),\r\n      ...(selectClass.navigationPropertyClasses\r\n        ? {\r\n            navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) =>\r\n              RelatedClassInfo.toCompressedJSON(propertyClass, classesMap),\r\n            ),\r\n          }\r\n        : undefined),\r\n      ...(selectClass.pathFromInputToSelectClass\r\n        ? {\r\n            pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) =>\r\n              RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap),\r\n            ),\r\n          }\r\n        : undefined),\r\n      ...(selectClass.relatedPropertyPaths\r\n        ? {\r\n            relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) =>\r\n              path.map((relatedClass) => RelatedClassInfo.toCompressedJSON(relatedClass, classesMap)),\r\n            ),\r\n          }\r\n        : undefined),\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[SelectClassInfo]] list from JSON\r\n   * @param json JSON or JSON serialized to string to deserialize from\r\n   * @returns Deserialized [[SelectClassInfo]] objects list\r\n   *\r\n   * @internal\r\n   */\r\n  export function listFromCompressedJSON(json: SelectClassInfoJSON<Id64String>[], classesMap: { [id: string]: CompressedClassInfoJSON }): SelectClassInfo[] {\r\n    return json.map((sci) => fromCompressedJSON(sci, classesMap));\r\n  }\r\n}\r\n\r\n/**\r\n * Flags that control content format.\r\n * @public\r\n */\r\nexport enum ContentFlags {\r\n  /** Each content record only has [[InstanceKey]] and no data */\r\n  KeysOnly = 1 << 0,\r\n\r\n  /**\r\n   * Each content record additionally has an image id\r\n   * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  ShowImages = 1 << 1,\r\n\r\n  /** Each content record additionally has a display label */\r\n  ShowLabels = 1 << 2,\r\n\r\n  /** All content records are merged into a single record (see [Merging values]($docs/presentation/content/terminology#value-merging)) */\r\n  MergeResults = 1 << 3,\r\n\r\n  /** Content has only distinct values */\r\n  DistinctValues = 1 << 4,\r\n\r\n  /** Doesn't create property or calculated fields. Can be used in conjunction with [[ShowLabels]]. */\r\n  NoFields = 1 << 5,\r\n\r\n  /**\r\n   * Set related input keys on [[Item]] objects when creating content. This helps identify which [[Item]] is associated to which\r\n   * given input key at the cost of performance creating those items.\r\n   */\r\n  IncludeInputKeys = 1 << 8,\r\n\r\n  /**\r\n   * Produce content descriptor that is not intended for querying content. Allows the implementation to omit certain\r\n   * operations to make obtaining content descriptor faster.\r\n   * @internal\r\n   */\r\n  DescriptorOnly = 1 << 9,\r\n}\r\n\r\n/**\r\n * Data sorting direction\r\n * @public\r\n */\r\nexport enum SortDirection {\r\n  Ascending,\r\n  Descending,\r\n}\r\n\r\n/**\r\n * Data structure that contains selection information. Used\r\n * for cases when requesting content after a selection change.\r\n *\r\n * @public\r\n */\r\nexport interface SelectionInfo {\r\n  /** Name of selection provider which cause the selection change */\r\n  providerName: string;\r\n  /** Level of selection that changed */\r\n  level?: number;\r\n}\r\n\r\n/**\r\n * Serialized [[Descriptor]] JSON representation.\r\n * @public\r\n */\r\nexport interface DescriptorJSON {\r\n  classesMap: { [id: string]: CompressedClassInfoJSON };\r\n  connectionId: string;\r\n  inputKeysHash: string;\r\n  /** @deprecated in 3.x. The attribute is not used anymore. */\r\n  contentOptions: any;\r\n  selectionInfo?: SelectionInfo;\r\n  displayType: string;\r\n  selectClasses: SelectClassInfoJSON<Id64String>[];\r\n  categories: CategoryDescriptionJSON[];\r\n  fields: FieldJSON<Id64String>[];\r\n  sortingFieldName?: string;\r\n  sortDirection?: SortDirection;\r\n  contentFlags: number;\r\n  /** @deprecated in 3.x. The attribute was replaced with [[fieldsFilterExpression]]. */\r\n  filterExpression?: string;\r\n  fieldsFilterExpression?: string;\r\n  instanceFilter?: InstanceFilterDefinition;\r\n  ruleset?: Ruleset;\r\n}\r\n\r\n/**\r\n * Descriptor overrides that can be used to customize content\r\n * @public\r\n */\r\nexport interface DescriptorOverrides {\r\n  /**\r\n   * Content display type. Can be accessed in presentation rules and used\r\n   * to modify content in various ways. Defaults to empty string.\r\n   */\r\n  displayType?: string;\r\n\r\n  /** Content flags used for content customization. See [[ContentFlags]] */\r\n  contentFlags?: number;\r\n\r\n  /** Fields selector that allows excluding or including only specified fields. */\r\n  fieldsSelector?: {\r\n    /** Should the specified fields be included or excluded */\r\n    type: \"include\" | \"exclude\";\r\n    /** A list of field descriptors that identify fields to include / exclude */\r\n    fields: FieldDescriptor[];\r\n  };\r\n\r\n  /** Specification for sorting data. */\r\n  sorting?: {\r\n    /** Identifier of the field to use for sorting */\r\n    field: FieldDescriptor;\r\n    /** Sort direction */\r\n    direction: SortDirection;\r\n  };\r\n\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content\r\n   * @deprecated in 3.x. The attribute was replaced with [[fieldsFilterExpression]].\r\n   */\r\n  filterExpression?: string;\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content by\r\n   * select fields.\r\n   *\r\n   * This is different from [[instanceFilter]] as filtering is applied on the union of all selects,\r\n   * which removes access to content instance property values. Instead of referencing properties\r\n   * through `this.PropertyName` alias, the expression should reference them by field names. In cases\r\n   * when properties field merges multiple properties, this allows applying the filter on all of them\r\n   * at once. This is useful for filtering table rows by column value, when content is displayed in\r\n   * table format.\r\n   */\r\n  fieldsFilterExpression?: string;\r\n  /**\r\n   * Instances filter that allows filtering content by class, properties of specific class\r\n   * or properties of instances related to the content instance.\r\n   *\r\n   * This is different from [[fieldsFilterExpression]] as filter is applied at a lower level - on\r\n   * specific select class rather than a union of multiple select classes. This means the filter has\r\n   * access to properties of that class and they can be referenced using symbols like `this.Property`.\r\n   * This is useful for filtering instances of specific class.\r\n   */\r\n  instanceFilter?: InstanceFilterDefinition;\r\n}\r\n\r\n/**\r\n * Descriptor properties\r\n * @public\r\n */\r\nexport interface DescriptorSource {\r\n  /** Id of the connection used to create the descriptor */\r\n  readonly connectionId?: string;\r\n  /** Hash of the input keys used to create the descriptor */\r\n  readonly inputKeysHash?: string;\r\n  /** Selection info used to create the descriptor */\r\n  readonly selectionInfo?: SelectionInfo;\r\n  /** Display type used to create the descriptor */\r\n  readonly displayType: string;\r\n  /** A list of classes that will be selected from when creating content with this descriptor */\r\n  readonly selectClasses: SelectClassInfo[];\r\n  /** A list of content field categories used in this descriptor */\r\n  readonly categories: CategoryDescription[];\r\n  /** A list of fields contained in the descriptor */\r\n  readonly fields: Field[];\r\n  /** [[ContentFlags]] used to create the descriptor */\r\n  readonly contentFlags: number;\r\n  /** Field used to sort the content */\r\n  readonly sortingField?: Field;\r\n  /** Sorting direction */\r\n  readonly sortDirection?: SortDirection;\r\n  /**\r\n   * A ruleset used to create this descriptor.\r\n   * Only set if descriptor is created using a ruleset different from the input ruleset, e.g. when creating a hierarchy level descriptor.\r\n   */\r\n  readonly ruleset?: Ruleset;\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content\r\n   * @deprecated in 3.x. The attribute was replaced with [[fieldsFilterExpression]].\r\n   */\r\n  filterExpression?: string;\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content by\r\n   * select fields.\r\n   *\r\n   * This is different from [[instanceFilter]] as filtering is applied on the union of all selects,\r\n   * which removes access to content instance property values. Instead of referencing properties\r\n   * through `this.PropertyName` alias, the expression should reference them by field names. In cases\r\n   * when properties field merges multiple properties, this allows applying the filter on all of them\r\n   * at once. This is useful for filtering table rows by column value, when content is displayed in\r\n   * table format.\r\n   */\r\n  fieldsFilterExpression?: string;\r\n  /**\r\n   * Instances filter that allows filtering content by class, properties of specific class\r\n   * or properties of instances related to the content instance.\r\n   *\r\n   * This is different from [[fieldsFilterExpression]] as filter is applied at a lower level - on\r\n   * specific select class rather than a union of multiple select classes. This means the filter has\r\n   * access to properties of that class and they can be referenced using symbols like `this.Property`.\r\n   * This is useful for filtering instances of specific class.\r\n   */\r\n  instanceFilter?: InstanceFilterDefinition;\r\n}\r\n\r\n/**\r\n * Data structure that describes content: fields, sorting, filtering, format, etc.\r\n * Descriptor may be changed to control how content is created.\r\n *\r\n * @public\r\n */\r\nexport class Descriptor implements DescriptorSource {\r\n  /** Id of the connection used to create the descriptor */\r\n  public readonly connectionId?: string;\r\n  /** Hash of the input keys used to create the descriptor */\r\n  public readonly inputKeysHash?: string;\r\n  /**\r\n   * Extended options used to create the descriptor.\r\n   * @deprecated in 3.6. The attribute is not used anymore.\r\n   */\r\n  public readonly contentOptions: any;\r\n  /** Selection info used to create the descriptor */\r\n  public readonly selectionInfo?: SelectionInfo;\r\n  /** Display type used to create the descriptor */\r\n  public readonly displayType: string;\r\n  /** A list of classes that will be selected when creating content with this descriptor */\r\n  public readonly selectClasses: SelectClassInfo[];\r\n  /** A list of content field categories used in this descriptor */\r\n  public readonly categories: CategoryDescription[];\r\n  /** A list of fields contained in the descriptor */\r\n  public readonly fields: Field[];\r\n  /** [[ContentFlags]] used to create the descriptor */\r\n  public readonly contentFlags: number;\r\n  /**\r\n   * A ruleset used to create this descriptor.\r\n   * Only set if descriptor is created using a ruleset different from the input ruleset, e.g. when creating a hierarchy level descriptor.\r\n   */\r\n  public readonly ruleset?: Ruleset;\r\n  /** Field used to sort the content */\r\n  public sortingField?: Field;\r\n  /** Sorting direction */\r\n  public sortDirection?: SortDirection;\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content\r\n   * @deprecated in 3.x. The attribute was replaced with [[fieldsFilterExpression]].\r\n   */\r\n  public filterExpression?: string;\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content by\r\n   * select fields.\r\n   *\r\n   * This is different from [[instanceFilter]] as filtering is applied on the union of all selects,\r\n   * which removes access to content instance property values. Instead of referencing properties\r\n   * through `this.PropertyName` alias, the expression should reference them by field names. In cases\r\n   * when properties field merges multiple properties, this allows applying the filter on all of them\r\n   * at once. This is useful for filtering table rows by column value, when content is displayed in\r\n   * table format.\r\n   */\r\n  public fieldsFilterExpression?: string;\r\n  /**\r\n   * Instances filter that allows filtering content by class, properties of specific class\r\n   * or properties of instances related to the content instance.\r\n   *\r\n   * This is different from [[fieldsFilterExpression]] as filter is applied at a lower level - on\r\n   * specific select class rather than a union of multiple select classes. This means the filter has\r\n   * access to properties of that class and they can be referenced using symbols like `this.Property`.\r\n   * This is useful for filtering instances of specific class.\r\n   */\r\n  public instanceFilter?: InstanceFilterDefinition;\r\n\r\n  /** Construct a new Descriptor using a [[DescriptorSource]] */\r\n  public constructor(source: DescriptorSource) {\r\n    this.connectionId = source.connectionId;\r\n    this.inputKeysHash = source.inputKeysHash;\r\n    this.selectionInfo = source.selectionInfo;\r\n    this.displayType = source.displayType;\r\n    this.contentFlags = source.contentFlags;\r\n    this.selectClasses = [...source.selectClasses];\r\n    this.categories = [...source.categories];\r\n    this.fields = [...source.fields];\r\n    this.sortingField = source.sortingField;\r\n    this.sortDirection = source.sortDirection;\r\n    this.filterExpression = source.fieldsFilterExpression ?? source.filterExpression; // eslint-disable-line @typescript-eslint/no-deprecated\r\n    this.fieldsFilterExpression = source.fieldsFilterExpression ?? source.filterExpression; // eslint-disable-line @typescript-eslint/no-deprecated\r\n    this.instanceFilter = source.instanceFilter;\r\n    this.ruleset = source.ruleset;\r\n  }\r\n\r\n  /** Serialize [[Descriptor]] to JSON */\r\n  public toJSON(): DescriptorJSON {\r\n    const classesMap: { [id: string]: CompressedClassInfoJSON } = {};\r\n    const selectClasses: SelectClassInfoJSON<string>[] = this.selectClasses.map((selectClass) => SelectClassInfo.toCompressedJSON(selectClass, classesMap));\r\n    const fields: FieldJSON<string>[] = this.fields.map((field) => field.toCompressedJSON(classesMap));\r\n    return Object.assign(\r\n      {\r\n        displayType: this.displayType,\r\n        contentFlags: this.contentFlags,\r\n        categories: this.categories.map(CategoryDescription.toJSON),\r\n        fields,\r\n        selectClasses,\r\n        classesMap,\r\n      },\r\n      this.connectionId !== undefined && { connectionId: this.connectionId },\r\n      this.inputKeysHash !== undefined && { inputKeysHash: this.inputKeysHash },\r\n      // istanbul ignore next\r\n      this.contentOptions !== undefined && { contentOptions: this.contentOptions }, // eslint-disable-line @typescript-eslint/no-deprecated\r\n      this.sortingField !== undefined && { sortingFieldName: this.sortingField.name },\r\n      this.sortDirection !== undefined && { sortDirection: this.sortDirection },\r\n      this.filterExpression !== undefined && { filterExpression: this.filterExpression }, // eslint-disable-line @typescript-eslint/no-deprecated\r\n      this.fieldsFilterExpression !== undefined && { fieldsFilterExpression: this.fieldsFilterExpression },\r\n      this.instanceFilter !== undefined && { instanceFilter: this.instanceFilter },\r\n      this.selectionInfo !== undefined && { selectionInfo: this.selectionInfo },\r\n      this.ruleset !== undefined && { ruleset: this.ruleset },\r\n    );\r\n  }\r\n\r\n  /** Deserialize [[Descriptor]] from JSON */\r\n  public static fromJSON(json: DescriptorJSON | undefined): Descriptor | undefined {\r\n    if (!json) {\r\n      return undefined;\r\n    }\r\n\r\n    const { classesMap, ...leftOverJson } = json;\r\n    const categories = CategoryDescription.listFromJSON(json.categories);\r\n    const selectClasses = SelectClassInfo.listFromCompressedJSON(json.selectClasses, classesMap);\r\n    const fields = this.getFieldsFromJSON(json.fields, (fieldJson) => Field.fromCompressedJSON(fieldJson, classesMap, categories));\r\n    return new Descriptor({\r\n      ...leftOverJson,\r\n      selectClasses,\r\n      categories,\r\n      fields,\r\n      sortingField: getFieldByName(fields, json.sortingFieldName, true),\r\n    });\r\n  }\r\n\r\n  private static getFieldsFromJSON(json: FieldJSON[], factory: (json: FieldJSON) => Field | undefined): Field[] {\r\n    return json\r\n      .map((fieldJson: FieldJSON) => {\r\n        const field = factory(fieldJson);\r\n        if (field) {\r\n          field.rebuildParentship();\r\n        }\r\n        return field;\r\n      })\r\n      .filter((field): field is Field => !!field);\r\n  }\r\n\r\n  /**\r\n   * Get field by its name\r\n   * @param name Name of the field to find\r\n   * @param recurse Recurse into nested fields\r\n   */\r\n  public getFieldByName(name: string, recurse?: boolean): Field | undefined {\r\n    return getFieldByName(this.fields, name, recurse);\r\n  }\r\n\r\n  /**\r\n   * Get field by its descriptor.\r\n   */\r\n  public getFieldByDescriptor(fieldDescriptor: FieldDescriptor, recurse?: boolean): Field | undefined {\r\n    return getFieldByDescriptor(this.fields, fieldDescriptor, recurse);\r\n  }\r\n\r\n  /**\r\n   * Create descriptor overrides object from this descriptor.\r\n   * @public\r\n   */\r\n  public createDescriptorOverrides(): DescriptorOverrides {\r\n    const overrides: DescriptorOverrides = {};\r\n    if (this.displayType) {\r\n      overrides.displayType = this.displayType;\r\n    }\r\n    if (this.contentFlags !== 0) {\r\n      overrides.contentFlags = this.contentFlags;\r\n    }\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    if (this.filterExpression || this.fieldsFilterExpression) {\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      overrides.fieldsFilterExpression = this.fieldsFilterExpression ?? this.filterExpression;\r\n    }\r\n    if (this.instanceFilter) {\r\n      overrides.instanceFilter = this.instanceFilter;\r\n    }\r\n    if (this.sortingField) {\r\n      overrides.sorting = { field: this.sortingField.getFieldDescriptor(), direction: this.sortDirection ?? SortDirection.Ascending };\r\n    }\r\n    return overrides;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Descriptor.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Descriptor.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,sDAAyD;AACzD,oCASkB;AAGlB,0CAA4C;AAC5C,+CAA6E;AAC7E,2CAAsG;AAuCtG,cAAc;AACd,IAAiB,eAAe,CA2D/B;AA3DD,WAAiB,eAAe;IAC9B,2DAA2D;IAC3D,SAAgB,kBAAkB,CAAC,IAAiC,EAAE,UAAqD;QACzH,IAAA,qBAAM,EAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;QACxD,OAAO;YACL,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,eAAe,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE;YAClF,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,GAAG,CAAC,IAAI,CAAC,yBAAyB;gBAChC,CAAC,CAAC,EAAE,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE;gBACpI,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,oBAAoB;gBAC3B,CAAC,CAAC,EAAE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE;gBAC5I,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,0BAA0B;gBACjC,CAAC,CAAC;oBACE,0BAA0B,EAAE,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACvE,gDAAwC,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAC9E;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,oBAAoB;gBAC3B,CAAC,CAAC,EAAE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE;gBAC9I,CAAC,CAAC,SAAS,CAAC;SACf,CAAC;IACJ,CAAC;IAtBe,kCAAkB,qBAsBjC,CAAA;IAED,uDAAuD;IACvD,SAAgB,gBAAgB,CAAC,WAA4B,EAAE,UAAqD;QAClH,MAAM,EAAE,EAAE,EAAE,GAAG,iBAAiB,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC;QACjE,UAAU,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC;QACnC,OAAO;YACL,eAAe,EAAE,EAAE;YACnB,mBAAmB,EAAE,WAAW,CAAC,mBAAmB;YACpD,GAAG,CAAC,WAAW,CAAC,oBAAoB;gBAClC,CAAC,CAAC,EAAE,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wBAAgB,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE;gBACjJ,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,WAAW,CAAC,yBAAyB;gBACvC,CAAC,CAAC;oBACE,yBAAyB,EAAE,WAAW,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CACrF,wBAAgB,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,CAAC,CAC7D;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,WAAW,CAAC,0BAA0B;gBACxC,CAAC,CAAC;oBACE,0BAA0B,EAAE,WAAW,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC9E,gDAAwC,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAC5E;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;YACd,GAAG,CAAC,WAAW,CAAC,oBAAoB;gBAClC,CAAC,CAAC;oBACE,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAClE,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,wBAAgB,CAAC,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CACxF;iBACF;gBACH,CAAC,CAAC,SAAS,CAAC;SACf,CAAC;IACJ,CAAC;IA/Be,gCAAgB,mBA+B/B,CAAA;AACH,CAAC,EA3DgB,eAAe,+BAAf,eAAe,QA2D/B;AAED;;;GAGG;AACH,IAAY,YAqBX;AArBD,WAAY,YAAY;IACtB,+DAA+D;IAC/D,uDAAiB,CAAA;IAEjB,2DAA2D;IAC3D,2DAAmB,CAAA;IAEnB,uIAAuI;IACvI,+DAAqB,CAAA;IAErB,uCAAuC;IACvC,oEAAuB,CAAA;IAEvB,oGAAoG;IACpG,wDAAiB,CAAA;IAEjB;;;OAGG;IACH,yEAAyB,CAAA;AAC3B,CAAC,EArBW,YAAY,4BAAZ,YAAY,QAqBvB;AAED;;;GAGG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,2DAAS,CAAA;IACT,6DAAU,CAAA;AACZ,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAgJD;;;;;GAKG;AACH,MAAa,UAAU;IACrB,yDAAyD;IACzC,YAAY,CAAU;IACtC,2DAA2D;IAC3C,aAAa,CAAU;IACvC,mDAAmD;IACnC,aAAa,CAAiB;IAC9C,iDAAiD;IACjC,WAAW,CAAS;IACpC,yFAAyF;IACzE,aAAa,CAAoB;IACjD,iEAAiE;IACjD,UAAU,CAAwB;IAClD,mDAAmD;IACnC,MAAM,CAAU;IAChC,qDAAqD;IACrC,YAAY,CAAS;IACrC;;;OAGG;IACa,OAAO,CAAW;IAClC,qCAAqC;IAC9B,YAAY,CAAS;IAC5B,wBAAwB;IACjB,aAAa,CAAiB;IACrC;;;;;;;;;;OAUG;IACI,sBAAsB,CAAU;IACvC;;;;;;;;OAQG;IACI,cAAc,CAA4B;IAEjD,8DAA8D;IAC9D,YAAmB,MAAwB;QACzC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC1C,IAAI,CAAC,sBAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;QAC5D,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,uCAAuC;IAChC,MAAM;QACX,MAAM,UAAU,GAA8C,EAAE,CAAC;QACjE,MAAM,aAAa,GAAkC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,eAAe,CAAC,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;QACxJ,MAAM,MAAM,GAAwB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QACnG,OAAO,IAAA,wBAAa,EAAC;YACnB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,iCAAmB,CAAC,MAAM,CAAC;YAC3D,MAAM;YACN,aAAa;YACb,UAAU;YACV,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI,EAAE;YACrC,aAAa,EAAE,IAAI,CAAC,aAAa,IAAI,EAAE;YACvC,gBAAgB,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,QAAQ,CAAC,IAAgC;QACrD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,EACJ,UAAU,EAAE,cAAc,EAC1B,aAAa,EAAE,iBAAiB,EAChC,MAAM,EAAE,UAAU,EAClB,YAAY,EACZ,aAAa,EACb,UAAU,EACV,gBAAgB,EAChB,GAAG,YAAY,EAChB,GAAG,IAAI,CAAC;QACT,MAAM,UAAU,GAAG,iCAAmB,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,kBAAkB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC;QAC1G,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,iBAAK,CAAC,kBAAkB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;QAC9H,OAAO,IAAI,UAAU,CAAC;YACpB,GAAG,YAAY;YACf,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACrE,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACvE,aAAa;YACb,UAAU;YACV,MAAM;YACN,YAAY,EAAE,IAAA,0BAAc,EAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,IAAiB,EAAE,OAA+C;QACjG,OAAO,IAAI;aACR,GAAG,CAAC,CAAC,SAAoB,EAAE,EAAE;YAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;YACjC,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,KAAK,EAAkB,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAAY,EAAE,OAAiB;QACnD,OAAO,IAAA,0BAAc,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,oBAAoB,CAAC,eAAgC,EAAE,OAAiB;QAC7E,OAAO,IAAA,gCAAoB,EAAC,IAAI,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,yBAAyB;QAC9B,MAAM,SAAS,GAAwB,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC3C,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;YAC5B,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7C,CAAC;QACD,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAChC,SAAS,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAC;QACjE,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QACjD,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,SAAS,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,SAAS,EAAE,CAAC;QAClI,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA1KD,gCA0KC","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 Content\r\n */\r\n\r\nimport { assert, Id64String } from \"@itwin/core-bentley\";\r\nimport {\r\n  ClassInfo,\r\n  CompressedClassInfoJSON,\r\n  RelatedClassInfo,\r\n  RelatedClassInfoJSON,\r\n  RelatedClassInfoWithOptionalRelationship,\r\n  RelatedClassInfoWithOptionalRelationshipJSON,\r\n  RelationshipPath,\r\n  RelationshipPathJSON,\r\n} from \"../EC.js\";\r\nimport { InstanceFilterDefinition } from \"../InstanceFilterDefinition.js\";\r\nimport { Ruleset } from \"../rules/Ruleset.js\";\r\nimport { omitUndefined } from \"../Utils.js\";\r\nimport { CategoryDescription, CategoryDescriptionJSON } from \"./Category.js\";\r\nimport { Field, FieldDescriptor, FieldJSON, getFieldByDescriptor, getFieldByName } from \"./Fields.js\";\r\n\r\n/**\r\n * Data structure that describes an ECClass in content [[Descriptor]].\r\n * @public\r\n */\r\nexport interface SelectClassInfo {\r\n  /** Information about the ECClass */\r\n  selectClassInfo: ClassInfo;\r\n\r\n  /** Is the class handled polymorphically */\r\n  isSelectPolymorphic: boolean;\r\n\r\n  /** Relationship path from input class to the select class. */\r\n  pathFromInputToSelectClass?: RelatedClassInfoWithOptionalRelationship[];\r\n\r\n  /** Relationship paths to [related property]($docs/presentation/content/Terminology#related-properties) classes */\r\n  relatedPropertyPaths?: RelationshipPath[];\r\n\r\n  /** Relationship paths to navigation property classes */\r\n  navigationPropertyClasses?: RelatedClassInfo[];\r\n\r\n  /** Relationship paths to [related instance]($docs/presentation/content/Terminology#related-instance) classes. */\r\n  relatedInstancePaths?: RelationshipPath[];\r\n}\r\n\r\n/**\r\n * Serialized [[SelectClassInfo]] JSON representation\r\n * @public\r\n */\r\nexport interface SelectClassInfoJSON<TClassInfoJSON = ClassInfo> {\r\n  selectClassInfo: TClassInfoJSON;\r\n  isSelectPolymorphic: boolean;\r\n  pathFromInputToSelectClass?: RelatedClassInfoWithOptionalRelationshipJSON<TClassInfoJSON>[];\r\n  relatedPropertyPaths?: RelationshipPathJSON<TClassInfoJSON>[];\r\n  navigationPropertyClasses?: RelatedClassInfoJSON<TClassInfoJSON>[];\r\n  relatedInstancePaths?: RelationshipPathJSON<TClassInfoJSON>[];\r\n}\r\n\r\n/** @public */\r\nexport namespace SelectClassInfo {\r\n  /** Deserialize [[SelectClassInfo]] from compressed JSON */\r\n  export function fromCompressedJSON(json: SelectClassInfoJSON<string>, classesMap: { [id: string]: CompressedClassInfoJSON }): SelectClassInfo {\r\n    assert(classesMap.hasOwnProperty(json.selectClassInfo));\r\n    return {\r\n      selectClassInfo: { id: json.selectClassInfo, ...classesMap[json.selectClassInfo] },\r\n      isSelectPolymorphic: json.isSelectPolymorphic,\r\n      ...(json.navigationPropertyClasses\r\n        ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap)) }\r\n        : undefined),\r\n      ...(json.relatedInstancePaths\r\n        ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) }\r\n        : undefined),\r\n      ...(json.pathFromInputToSelectClass\r\n        ? {\r\n            pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) =>\r\n              RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap),\r\n            ),\r\n          }\r\n        : undefined),\r\n      ...(json.relatedPropertyPaths\r\n        ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) }\r\n        : undefined),\r\n    };\r\n  }\r\n\r\n  /** Serialize [[SelectClassInfo]] to compressed JSON */\r\n  export function toCompressedJSON(selectClass: SelectClassInfo, classesMap: { [id: string]: CompressedClassInfoJSON }): SelectClassInfoJSON<string> {\r\n    const { id, ...leftOverClassInfo } = selectClass.selectClassInfo;\r\n    classesMap[id] = leftOverClassInfo;\r\n    return {\r\n      selectClassInfo: id,\r\n      isSelectPolymorphic: selectClass.isSelectPolymorphic,\r\n      ...(selectClass.relatedInstancePaths\r\n        ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.toCompressedJSON(item, classesMap))) }\r\n        : undefined),\r\n      ...(selectClass.navigationPropertyClasses\r\n        ? {\r\n            navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) =>\r\n              RelatedClassInfo.toCompressedJSON(propertyClass, classesMap),\r\n            ),\r\n          }\r\n        : undefined),\r\n      ...(selectClass.pathFromInputToSelectClass\r\n        ? {\r\n            pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) =>\r\n              RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap),\r\n            ),\r\n          }\r\n        : undefined),\r\n      ...(selectClass.relatedPropertyPaths\r\n        ? {\r\n            relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) =>\r\n              path.map((relatedClass) => RelatedClassInfo.toCompressedJSON(relatedClass, classesMap)),\r\n            ),\r\n          }\r\n        : undefined),\r\n    };\r\n  }\r\n}\r\n\r\n/**\r\n * Flags that control content format.\r\n * @public\r\n */\r\nexport enum ContentFlags {\r\n  /** Each content record only has [[InstanceKey]] and no data */\r\n  KeysOnly = 1 << 0,\r\n\r\n  /** Each content record additionally has a display label */\r\n  ShowLabels = 1 << 2,\r\n\r\n  /** All content records are merged into a single record (see [Merging values]($docs/presentation/content/terminology#value-merging)) */\r\n  MergeResults = 1 << 3,\r\n\r\n  /** Content has only distinct values */\r\n  DistinctValues = 1 << 4,\r\n\r\n  /** Doesn't create property or calculated fields. Can be used in conjunction with [[ShowLabels]]. */\r\n  NoFields = 1 << 5,\r\n\r\n  /**\r\n   * Set related input keys on [[Item]] objects when creating content. This helps identify which [[Item]] is associated to which\r\n   * given input key at the cost of performance creating those items.\r\n   */\r\n  IncludeInputKeys = 1 << 8,\r\n}\r\n\r\n/**\r\n * Data sorting direction\r\n * @public\r\n */\r\nexport enum SortDirection {\r\n  Ascending,\r\n  Descending,\r\n}\r\n\r\n/**\r\n * Data structure that contains selection information. Used\r\n * for cases when requesting content after a selection change.\r\n *\r\n * @public\r\n */\r\nexport interface SelectionInfo {\r\n  /** Name of selection provider which cause the selection change */\r\n  providerName: string;\r\n  /** Level of selection that changed */\r\n  level?: number;\r\n}\r\n\r\n/**\r\n * Serialized [[Descriptor]] JSON representation.\r\n * @public\r\n */\r\nexport interface DescriptorJSON {\r\n  classesMap: { [id: string]: CompressedClassInfoJSON };\r\n  connectionId: string;\r\n  inputKeysHash: string;\r\n  selectionInfo?: SelectionInfo;\r\n  displayType: string;\r\n  selectClasses: SelectClassInfoJSON<Id64String>[];\r\n  categories: CategoryDescriptionJSON[];\r\n  fields: FieldJSON<Id64String>[];\r\n  sortingFieldName?: string;\r\n  sortDirection?: SortDirection;\r\n  contentFlags: number;\r\n  fieldsFilterExpression?: string;\r\n  instanceFilter?: InstanceFilterDefinition;\r\n  ruleset?: Ruleset;\r\n}\r\n\r\n/**\r\n * Descriptor overrides that can be used to customize content\r\n * @public\r\n */\r\nexport interface DescriptorOverrides {\r\n  /**\r\n   * Content display type. Can be accessed in presentation rules and used\r\n   * to modify content in various ways. Defaults to empty string.\r\n   */\r\n  displayType?: string;\r\n\r\n  /** Content flags used for content customization. See [[ContentFlags]] */\r\n  contentFlags?: number;\r\n\r\n  /** Fields selector that allows excluding or including only specified fields. */\r\n  fieldsSelector?: {\r\n    /** Should the specified fields be included or excluded */\r\n    type: \"include\" | \"exclude\";\r\n    /** A list of field descriptors that identify fields to include / exclude */\r\n    fields: FieldDescriptor[];\r\n  };\r\n\r\n  /** Specification for sorting data. */\r\n  sorting?: {\r\n    /** Identifier of the field to use for sorting */\r\n    field: FieldDescriptor;\r\n    /** Sort direction */\r\n    direction: SortDirection;\r\n  };\r\n\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content by\r\n   * select fields.\r\n   *\r\n   * This is different from [[instanceFilter]] as filtering is applied on the union of all selects,\r\n   * which removes access to content instance property values. Instead of referencing properties\r\n   * through `this.PropertyName` alias, the expression should reference them by field names. In cases\r\n   * when properties field merges multiple properties, this allows applying the filter on all of them\r\n   * at once. This is useful for filtering table rows by column value, when content is displayed in\r\n   * table format.\r\n   */\r\n  fieldsFilterExpression?: string;\r\n  /**\r\n   * Instances filter that allows filtering content by class, properties of specific class\r\n   * or properties of instances related to the content instance.\r\n   *\r\n   * This is different from [[fieldsFilterExpression]] as filter is applied at a lower level - on\r\n   * specific select class rather than a union of multiple select classes. This means the filter has\r\n   * access to properties of that class and they can be referenced using symbols like `this.Property`.\r\n   * This is useful for filtering instances of specific class.\r\n   */\r\n  instanceFilter?: InstanceFilterDefinition;\r\n}\r\n\r\n/**\r\n * Descriptor properties\r\n * @public\r\n */\r\nexport interface DescriptorSource {\r\n  /** Id of the connection used to create the descriptor */\r\n  readonly connectionId?: string;\r\n  /** Hash of the input keys used to create the descriptor */\r\n  readonly inputKeysHash?: string;\r\n  /** Selection info used to create the descriptor */\r\n  readonly selectionInfo?: SelectionInfo;\r\n  /** Display type used to create the descriptor */\r\n  readonly displayType: string;\r\n  /** A list of classes that will be selected from when creating content with this descriptor */\r\n  readonly selectClasses: SelectClassInfo[];\r\n  /** A list of content field categories used in this descriptor */\r\n  readonly categories: CategoryDescription[];\r\n  /** A list of fields contained in the descriptor */\r\n  readonly fields: Field[];\r\n  /** [[ContentFlags]] used to create the descriptor */\r\n  readonly contentFlags: number;\r\n  /** Field used to sort the content */\r\n  readonly sortingField?: Field;\r\n  /** Sorting direction */\r\n  readonly sortDirection?: SortDirection;\r\n  /**\r\n   * A ruleset used to create this descriptor.\r\n   * Only set if descriptor is created using a ruleset different from the input ruleset, e.g. when creating a hierarchy level descriptor.\r\n   */\r\n  readonly ruleset?: Ruleset;\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content by\r\n   * select fields.\r\n   *\r\n   * This is different from [[instanceFilter]] as filtering is applied on the union of all selects,\r\n   * which removes access to content instance property values. Instead of referencing properties\r\n   * through `this.PropertyName` alias, the expression should reference them by field names. In cases\r\n   * when properties field merges multiple properties, this allows applying the filter on all of them\r\n   * at once. This is useful for filtering table rows by column value, when content is displayed in\r\n   * table format.\r\n   */\r\n  fieldsFilterExpression?: string;\r\n  /**\r\n   * Instances filter that allows filtering content by class, properties of specific class\r\n   * or properties of instances related to the content instance.\r\n   *\r\n   * This is different from [[fieldsFilterExpression]] as filter is applied at a lower level - on\r\n   * specific select class rather than a union of multiple select classes. This means the filter has\r\n   * access to properties of that class and they can be referenced using symbols like `this.Property`.\r\n   * This is useful for filtering instances of specific class.\r\n   */\r\n  instanceFilter?: InstanceFilterDefinition;\r\n}\r\n\r\n/**\r\n * Data structure that describes content: fields, sorting, filtering, format, etc.\r\n * Descriptor may be changed to control how content is created.\r\n *\r\n * @public\r\n */\r\nexport class Descriptor implements DescriptorSource {\r\n  /** Id of the connection used to create the descriptor */\r\n  public readonly connectionId?: string;\r\n  /** Hash of the input keys used to create the descriptor */\r\n  public readonly inputKeysHash?: string;\r\n  /** Selection info used to create the descriptor */\r\n  public readonly selectionInfo?: SelectionInfo;\r\n  /** Display type used to create the descriptor */\r\n  public readonly displayType: string;\r\n  /** A list of classes that will be selected when creating content with this descriptor */\r\n  public readonly selectClasses: SelectClassInfo[];\r\n  /** A list of content field categories used in this descriptor */\r\n  public readonly categories: CategoryDescription[];\r\n  /** A list of fields contained in the descriptor */\r\n  public readonly fields: Field[];\r\n  /** [[ContentFlags]] used to create the descriptor */\r\n  public readonly contentFlags: number;\r\n  /**\r\n   * A ruleset used to create this descriptor.\r\n   * Only set if descriptor is created using a ruleset different from the input ruleset, e.g. when creating a hierarchy level descriptor.\r\n   */\r\n  public readonly ruleset?: Ruleset;\r\n  /** Field used to sort the content */\r\n  public sortingField?: Field;\r\n  /** Sorting direction */\r\n  public sortDirection?: SortDirection;\r\n  /**\r\n   * [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content by\r\n   * select fields.\r\n   *\r\n   * This is different from [[instanceFilter]] as filtering is applied on the union of all selects,\r\n   * which removes access to content instance property values. Instead of referencing properties\r\n   * through `this.PropertyName` alias, the expression should reference them by field names. In cases\r\n   * when properties field merges multiple properties, this allows applying the filter on all of them\r\n   * at once. This is useful for filtering table rows by column value, when content is displayed in\r\n   * table format.\r\n   */\r\n  public fieldsFilterExpression?: string;\r\n  /**\r\n   * Instances filter that allows filtering content by class, properties of specific class\r\n   * or properties of instances related to the content instance.\r\n   *\r\n   * This is different from [[fieldsFilterExpression]] as filter is applied at a lower level - on\r\n   * specific select class rather than a union of multiple select classes. This means the filter has\r\n   * access to properties of that class and they can be referenced using symbols like `this.Property`.\r\n   * This is useful for filtering instances of specific class.\r\n   */\r\n  public instanceFilter?: InstanceFilterDefinition;\r\n\r\n  /** Construct a new Descriptor using a [[DescriptorSource]] */\r\n  public constructor(source: DescriptorSource) {\r\n    this.connectionId = source.connectionId;\r\n    this.inputKeysHash = source.inputKeysHash;\r\n    this.selectionInfo = source.selectionInfo;\r\n    this.displayType = source.displayType;\r\n    this.contentFlags = source.contentFlags;\r\n    this.selectClasses = [...source.selectClasses];\r\n    this.categories = [...source.categories];\r\n    this.fields = [...source.fields];\r\n    this.sortingField = source.sortingField;\r\n    this.sortDirection = source.sortDirection;\r\n    this.fieldsFilterExpression = source.fieldsFilterExpression;\r\n    this.instanceFilter = source.instanceFilter;\r\n    this.ruleset = source.ruleset;\r\n  }\r\n\r\n  /** Serialize [[Descriptor]] to JSON */\r\n  public toJSON(): DescriptorJSON {\r\n    const classesMap: { [id: string]: CompressedClassInfoJSON } = {};\r\n    const selectClasses: SelectClassInfoJSON<string>[] = this.selectClasses.map((selectClass) => SelectClassInfo.toCompressedJSON(selectClass, classesMap));\r\n    const fields: FieldJSON<string>[] = this.fields.map((field) => field.toCompressedJSON(classesMap));\r\n    return omitUndefined({\r\n      displayType: this.displayType,\r\n      contentFlags: this.contentFlags,\r\n      categories: this.categories.map(CategoryDescription.toJSON),\r\n      fields,\r\n      selectClasses,\r\n      classesMap,\r\n      connectionId: this.connectionId ?? \"\",\r\n      inputKeysHash: this.inputKeysHash ?? \"\",\r\n      sortingFieldName: this.sortingField?.name,\r\n      sortDirection: this.sortDirection,\r\n      fieldsFilterExpression: this.fieldsFilterExpression,\r\n      instanceFilter: this.instanceFilter,\r\n      selectionInfo: this.selectionInfo,\r\n      ruleset: this.ruleset,\r\n    });\r\n  }\r\n\r\n  /** Deserialize [[Descriptor]] from JSON */\r\n  public static fromJSON(json: DescriptorJSON | undefined): Descriptor | undefined {\r\n    if (!json) {\r\n      return undefined;\r\n    }\r\n\r\n    const {\r\n      categories: jsonCategories,\r\n      selectClasses: jsonSelectClasses,\r\n      fields: jsonFields,\r\n      connectionId,\r\n      inputKeysHash,\r\n      classesMap,\r\n      sortingFieldName,\r\n      ...leftOverJson\r\n    } = json;\r\n    const categories = CategoryDescription.listFromJSON(jsonCategories);\r\n    const selectClasses = jsonSelectClasses.map((jsc) => SelectClassInfo.fromCompressedJSON(jsc, classesMap));\r\n    const fields = this.getFieldsFromJSON(jsonFields, (fieldJson) => Field.fromCompressedJSON(fieldJson, classesMap, categories));\r\n    return new Descriptor({\r\n      ...leftOverJson,\r\n      ...(connectionId ? /* c8 ignore next */ { connectionId } : undefined),\r\n      ...(inputKeysHash ? /* c8 ignore next */ { inputKeysHash } : undefined),\r\n      selectClasses,\r\n      categories,\r\n      fields,\r\n      sortingField: getFieldByName(fields, sortingFieldName, true),\r\n    });\r\n  }\r\n\r\n  private static getFieldsFromJSON(json: FieldJSON[], factory: (json: FieldJSON) => Field | undefined): Field[] {\r\n    return json\r\n      .map((fieldJson: FieldJSON) => {\r\n        const field = factory(fieldJson);\r\n        if (field) {\r\n          field.rebuildParentship();\r\n        }\r\n        return field;\r\n      })\r\n      .filter((field): field is Field => !!field);\r\n  }\r\n\r\n  /**\r\n   * Get field by its name\r\n   * @param name Name of the field to find\r\n   * @param recurse Recurse into nested fields\r\n   */\r\n  public getFieldByName(name: string, recurse?: boolean): Field | undefined {\r\n    return getFieldByName(this.fields, name, recurse);\r\n  }\r\n\r\n  /**\r\n   * Get field by its descriptor.\r\n   */\r\n  public getFieldByDescriptor(fieldDescriptor: FieldDescriptor, recurse?: boolean): Field | undefined {\r\n    return getFieldByDescriptor(this.fields, fieldDescriptor, recurse);\r\n  }\r\n\r\n  /**\r\n   * Create descriptor overrides object from this descriptor.\r\n   * @public\r\n   */\r\n  public createDescriptorOverrides(): DescriptorOverrides {\r\n    const overrides: DescriptorOverrides = {};\r\n    if (this.displayType) {\r\n      overrides.displayType = this.displayType;\r\n    }\r\n    if (this.contentFlags !== 0) {\r\n      overrides.contentFlags = this.contentFlags;\r\n    }\r\n    if (this.fieldsFilterExpression) {\r\n      overrides.fieldsFilterExpression = this.fieldsFilterExpression;\r\n    }\r\n    if (this.instanceFilter) {\r\n      overrides.instanceFilter = this.instanceFilter;\r\n    }\r\n    if (this.sortingField) {\r\n      overrides.sorting = { field: this.sortingField.getFieldDescriptor(), direction: this.sortDirection ?? SortDirection.Ascending };\r\n    }\r\n    return overrides;\r\n  }\r\n}\r\n"]}