@itwin/presentation-common 3.4.0 → 3.4.1

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

@@ -1,186 +1,186 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Content
- */
-import { assert } from "@itwin/core-bentley";
-import { RelatedClassInfo, RelatedClassInfoWithOptionalRelationship, } from "../EC";
-import { CategoryDescription } from "./Category";
-import { Field, getFieldByName } from "./Fields";
-/** @public */
-export var SelectClassInfo;
-(function (SelectClassInfo) {
-    /** Deserialize [[SelectClassInfo]] from compressed JSON */
-    function fromCompressedJSON(json, classesMap) {
-        assert(classesMap.hasOwnProperty(json.selectClassInfo));
-        return {
-            selectClassInfo: { id: json.selectClassInfo, ...classesMap[json.selectClassInfo] },
-            isSelectPolymorphic: json.isSelectPolymorphic,
-            ...(json.navigationPropertyClasses ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap)) } : undefined),
-            ...(json.relatedInstancePaths ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),
-            ...(json.pathFromInputToSelectClass ? { pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap)) } : undefined),
-            ...(json.relatedPropertyPaths ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),
-        };
-    }
-    SelectClassInfo.fromCompressedJSON = fromCompressedJSON;
-    /** Serialize [[SelectClassInfo]] to compressed JSON */
-    function toCompressedJSON(selectClass, classesMap) {
-        const { id, ...leftOverClassInfo } = selectClass.selectClassInfo;
-        classesMap[id] = leftOverClassInfo;
-        return {
-            selectClassInfo: id,
-            isSelectPolymorphic: selectClass.isSelectPolymorphic,
-            ...(selectClass.relatedInstancePaths ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.toCompressedJSON(item, classesMap))) } : undefined),
-            ...(selectClass.navigationPropertyClasses ? { navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) => RelatedClassInfo.toCompressedJSON(propertyClass, classesMap)) } : undefined),
-            ...(selectClass.pathFromInputToSelectClass ? { pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap)) } : undefined),
-            ...(selectClass.relatedPropertyPaths ? { relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) => path.map((relatedClass) => 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 || (SelectClassInfo = {}));
-/**
- * Flags that control content format.
- * @public
- */
-export 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 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)) */
-    ContentFlags[ContentFlags["MergeResults"] = 8] = "MergeResults";
-    /** Content has only distinct values */
-    ContentFlags[ContentFlags["DistinctValues"] = 16] = "DistinctValues";
-    /** Doesn't create property or calculated fields. Can be used in conjunction with [[ShowLabels]]. */
-    ContentFlags[ContentFlags["NoFields"] = 32] = "NoFields";
-    /**
-     * Set related input keys on [[Item]] objects when creating content. This helps identify which [[Item]] is associated to which
-     * given input key at the cost of performance creating those items.
-     *
-     * @beta
-     */
-    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 || (ContentFlags = {}));
-/**
- * Data sorting direction
- * @public
- */
-export var SortDirection;
-(function (SortDirection) {
-    SortDirection[SortDirection["Ascending"] = 0] = "Ascending";
-    SortDirection[SortDirection["Descending"] = 1] = "Descending";
-})(SortDirection || (SortDirection = {}));
-/**
- * Data structure that describes content: fields, sorting, filtering, format, etc.
- * Descriptor may be changed to control how content is created.
- *
- * @public
- */
-export class Descriptor {
-    /** Construct a new Descriptor using a [[DescriptorSource]] */
-    constructor(source) {
-        this.connectionId = source.connectionId;
-        this.inputKeysHash = source.inputKeysHash;
-        this.selectionInfo = source.selectionInfo;
-        this.displayType = source.displayType;
-        this.contentFlags = source.contentFlags;
-        this.selectClasses = [...source.selectClasses];
-        this.categories = [...source.categories];
-        this.fields = [...source.fields];
-        this.sortingField = source.sortingField;
-        this.sortDirection = source.sortDirection;
-        this.filterExpression = source.filterExpression;
-    }
-    /** Serialize [[Descriptor]] to JSON */
-    toJSON() {
-        const classesMap = {};
-        const selectClasses = this.selectClasses.map((selectClass) => SelectClassInfo.toCompressedJSON(selectClass, classesMap));
-        const fields = this.fields.map((field) => field.toCompressedJSON(classesMap));
-        return Object.assign({
-            connectionId: this.connectionId,
-            inputKeysHash: this.inputKeysHash,
-            contentOptions: this.contentOptions,
-            displayType: this.displayType,
-            contentFlags: this.contentFlags,
-            categories: this.categories.map(CategoryDescription.toJSON),
-            fields,
-            selectClasses,
-            classesMap,
-        }, this.sortingField !== undefined && { sortingFieldName: this.sortingField.name }, this.sortDirection !== undefined && { sortDirection: this.sortDirection }, this.filterExpression !== undefined && { filterExpression: this.filterExpression }, this.selectionInfo !== undefined && { selectionInfo: this.selectionInfo });
-    }
-    /** Deserialize [[Descriptor]] from JSON */
-    static fromJSON(json) {
-        if (!json)
-            return undefined;
-        const { classesMap, ...leftOverJson } = json;
-        const categories = CategoryDescription.listFromJSON(json.categories);
-        const selectClasses = SelectClassInfo.listFromCompressedJSON(json.selectClasses, classesMap);
-        const fields = this.getFieldsFromJSON(json.fields, (fieldJson) => Field.fromCompressedJSON(fieldJson, classesMap, categories));
-        return new Descriptor({
-            ...leftOverJson,
-            selectClasses,
-            categories,
-            fields,
-            sortingField: getFieldByName(fields, json.sortingFieldName, true),
-        });
-    }
-    static getFieldsFromJSON(json, factory) {
-        return json.map((fieldJson) => {
-            const field = factory(fieldJson);
-            if (field)
-                field.rebuildParentship();
-            return field;
-        }).filter((field) => !!field);
-    }
-    /**
-     * Get field by its name
-     * @param name Name of the field to find
-     * @param recurse Recurse into nested fields
-     */
-    getFieldByName(name, recurse) {
-        return getFieldByName(this.fields, name, recurse);
-    }
-    /**
-     * Create descriptor overrides object from this descriptor.
-     * @public
-     */
-    createDescriptorOverrides() {
-        var _a;
-        const overrides = {};
-        if (this.displayType)
-            overrides.displayType = this.displayType;
-        if (this.contentFlags !== 0)
-            overrides.contentFlags = this.contentFlags;
-        if (this.filterExpression)
-            overrides.filterExpression = this.filterExpression;
-        if (this.sortingField)
-            overrides.sorting = { field: this.sortingField.getFieldDescriptor(), direction: (_a = this.sortDirection) !== null && _a !== void 0 ? _a : SortDirection.Ascending };
-        return overrides;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Content
+ */
+import { assert } from "@itwin/core-bentley";
+import { RelatedClassInfo, RelatedClassInfoWithOptionalRelationship, } from "../EC";
+import { CategoryDescription } from "./Category";
+import { Field, getFieldByName } from "./Fields";
+/** @public */
+export var SelectClassInfo;
+(function (SelectClassInfo) {
+    /** Deserialize [[SelectClassInfo]] from compressed JSON */
+    function fromCompressedJSON(json, classesMap) {
+        assert(classesMap.hasOwnProperty(json.selectClassInfo));
+        return {
+            selectClassInfo: { id: json.selectClassInfo, ...classesMap[json.selectClassInfo] },
+            isSelectPolymorphic: json.isSelectPolymorphic,
+            ...(json.navigationPropertyClasses ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap)) } : undefined),
+            ...(json.relatedInstancePaths ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),
+            ...(json.pathFromInputToSelectClass ? { pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap)) } : undefined),
+            ...(json.relatedPropertyPaths ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),
+        };
+    }
+    SelectClassInfo.fromCompressedJSON = fromCompressedJSON;
+    /** Serialize [[SelectClassInfo]] to compressed JSON */
+    function toCompressedJSON(selectClass, classesMap) {
+        const { id, ...leftOverClassInfo } = selectClass.selectClassInfo;
+        classesMap[id] = leftOverClassInfo;
+        return {
+            selectClassInfo: id,
+            isSelectPolymorphic: selectClass.isSelectPolymorphic,
+            ...(selectClass.relatedInstancePaths ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.toCompressedJSON(item, classesMap))) } : undefined),
+            ...(selectClass.navigationPropertyClasses ? { navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) => RelatedClassInfo.toCompressedJSON(propertyClass, classesMap)) } : undefined),
+            ...(selectClass.pathFromInputToSelectClass ? { pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap)) } : undefined),
+            ...(selectClass.relatedPropertyPaths ? { relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) => path.map((relatedClass) => 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 || (SelectClassInfo = {}));
+/**
+ * Flags that control content format.
+ * @public
+ */
+export 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 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)) */
+    ContentFlags[ContentFlags["MergeResults"] = 8] = "MergeResults";
+    /** Content has only distinct values */
+    ContentFlags[ContentFlags["DistinctValues"] = 16] = "DistinctValues";
+    /** Doesn't create property or calculated fields. Can be used in conjunction with [[ShowLabels]]. */
+    ContentFlags[ContentFlags["NoFields"] = 32] = "NoFields";
+    /**
+     * Set related input keys on [[Item]] objects when creating content. This helps identify which [[Item]] is associated to which
+     * given input key at the cost of performance creating those items.
+     *
+     * @beta
+     */
+    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 || (ContentFlags = {}));
+/**
+ * Data sorting direction
+ * @public
+ */
+export var SortDirection;
+(function (SortDirection) {
+    SortDirection[SortDirection["Ascending"] = 0] = "Ascending";
+    SortDirection[SortDirection["Descending"] = 1] = "Descending";
+})(SortDirection || (SortDirection = {}));
+/**
+ * Data structure that describes content: fields, sorting, filtering, format, etc.
+ * Descriptor may be changed to control how content is created.
+ *
+ * @public
+ */
+export class Descriptor {
+    /** Construct a new Descriptor using a [[DescriptorSource]] */
+    constructor(source) {
+        this.connectionId = source.connectionId;
+        this.inputKeysHash = source.inputKeysHash;
+        this.selectionInfo = source.selectionInfo;
+        this.displayType = source.displayType;
+        this.contentFlags = source.contentFlags;
+        this.selectClasses = [...source.selectClasses];
+        this.categories = [...source.categories];
+        this.fields = [...source.fields];
+        this.sortingField = source.sortingField;
+        this.sortDirection = source.sortDirection;
+        this.filterExpression = source.filterExpression;
+    }
+    /** Serialize [[Descriptor]] to JSON */
+    toJSON() {
+        const classesMap = {};
+        const selectClasses = this.selectClasses.map((selectClass) => SelectClassInfo.toCompressedJSON(selectClass, classesMap));
+        const fields = this.fields.map((field) => field.toCompressedJSON(classesMap));
+        return Object.assign({
+            connectionId: this.connectionId,
+            inputKeysHash: this.inputKeysHash,
+            contentOptions: this.contentOptions,
+            displayType: this.displayType,
+            contentFlags: this.contentFlags,
+            categories: this.categories.map(CategoryDescription.toJSON),
+            fields,
+            selectClasses,
+            classesMap,
+        }, this.sortingField !== undefined && { sortingFieldName: this.sortingField.name }, this.sortDirection !== undefined && { sortDirection: this.sortDirection }, this.filterExpression !== undefined && { filterExpression: this.filterExpression }, this.selectionInfo !== undefined && { selectionInfo: this.selectionInfo });
+    }
+    /** Deserialize [[Descriptor]] from JSON */
+    static fromJSON(json) {
+        if (!json)
+            return undefined;
+        const { classesMap, ...leftOverJson } = json;
+        const categories = CategoryDescription.listFromJSON(json.categories);
+        const selectClasses = SelectClassInfo.listFromCompressedJSON(json.selectClasses, classesMap);
+        const fields = this.getFieldsFromJSON(json.fields, (fieldJson) => Field.fromCompressedJSON(fieldJson, classesMap, categories));
+        return new Descriptor({
+            ...leftOverJson,
+            selectClasses,
+            categories,
+            fields,
+            sortingField: getFieldByName(fields, json.sortingFieldName, true),
+        });
+    }
+    static getFieldsFromJSON(json, factory) {
+        return json.map((fieldJson) => {
+            const field = factory(fieldJson);
+            if (field)
+                field.rebuildParentship();
+            return field;
+        }).filter((field) => !!field);
+    }
+    /**
+     * Get field by its name
+     * @param name Name of the field to find
+     * @param recurse Recurse into nested fields
+     */
+    getFieldByName(name, recurse) {
+        return getFieldByName(this.fields, name, recurse);
+    }
+    /**
+     * Create descriptor overrides object from this descriptor.
+     * @public
+     */
+    createDescriptorOverrides() {
+        var _a;
+        const overrides = {};
+        if (this.displayType)
+            overrides.displayType = this.displayType;
+        if (this.contentFlags !== 0)
+            overrides.contentFlags = this.contentFlags;
+        if (this.filterExpression)
+            overrides.filterExpression = this.filterExpression;
+        if (this.sortingField)
+            overrides.sorting = { field: this.sortingField.getFieldDescriptor(), direction: (_a = this.sortDirection) !== null && _a !== void 0 ? _a : SortDirection.Ascending };
+        return overrides;
+    }
+}
 //# sourceMappingURL=Descriptor.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Descriptor.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Descriptor.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAC8C,gBAAgB,EAAwB,wCAAwC,GAEpI,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,mBAAmB,EAA2B,MAAM,YAAY,CAAC;AAC1E,OAAO,EAAE,KAAK,EAA8B,cAAc,EAAE,MAAM,UAAU,CAAC;AAuC7E,cAAc;AACd,MAAM,KAAW,eAAe,CAsC/B;AAtCD,WAAiB,eAAe;IAC9B,2DAA2D;IAC3D,SAAgB,kBAAkB,CAAC,IAAiC,EAAE,UAAqD;QACzH,MAAM,CAAC,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,CAAC,CAAC,CAAC,EAAE,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACpL,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,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,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACvL,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,0BAA0B,EAAE,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/M,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,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,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAC1L,CAAC;IACJ,CAAC;IAVe,kCAAkB,qBAUjC,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,CAAC,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,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACnM,GAAG,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,yBAAyB,EAAE,WAAW,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAClN,GAAG,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,0BAA0B,EAAE,WAAW,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wCAAwC,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3N,GAAG,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SACtN,CAAC;IACJ,CAAC;IAXe,gCAAgB,mBAW/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,EAtCgB,eAAe,KAAf,eAAe,QAsC/B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,YAoCX;AApCD,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;;;;;OAKG;IACH,yEAAyB,CAAA;IAEzB;;;;OAIG;IACH,qEAAuB,CAAA;AACzB,CAAC,EApCW,YAAY,KAAZ,YAAY,QAoCvB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,2DAAS,CAAA;IACT,6DAAU,CAAA;AACZ,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAkGD;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IA0BrB,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,gBAAgB,CAAC;IAClD,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,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,mBAAmB,CAAC,MAAM,CAAC;YAC3D,MAAM;YACN,aAAa;YACb,UAAU;SACX,EACD,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,EAClF,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAC1E,CAAC;IACJ,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,QAAQ,CAAC,IAAgC;QACrD,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QAEnB,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC;QAC7C,MAAM,UAAU,GAAG,mBAAmB,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,KAAK,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,cAAc,CAAC,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,CAAC,GAAG,CAAC,CAAC,SAAoB,EAAE,EAAE;YACvC,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;YACjC,IAAI,KAAK;gBACP,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAkB,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAAY,EAAE,OAAiB;QACnD,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,yBAAyB;;QAC9B,MAAM,SAAS,GAAwB,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW;YAClB,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC3C,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC;YACzB,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7C,IAAI,IAAI,CAAC,gBAAgB;YACvB,SAAS,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACrD,IAAI,IAAI,CAAC,YAAY;YACnB,SAAS,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE,SAAS,EAAE,MAAA,IAAI,CAAC,aAAa,mCAAI,aAAa,CAAC,SAAS,EAAE,CAAC;QAClI,OAAO,SAAS,CAAC;IACnB,CAAC;CACF","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, ClassInfoJSON, CompressedClassInfoJSON, RelatedClassInfo, RelatedClassInfoJSON, RelatedClassInfoWithOptionalRelationship,\r\n  RelatedClassInfoWithOptionalRelationshipJSON, RelationshipPath, RelationshipPathJSON,\r\n} from \"../EC\";\r\nimport { CategoryDescription, CategoryDescriptionJSON } from \"./Category\";\r\nimport { Field, FieldDescriptor, FieldJSON, 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\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 ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap)) } : undefined),\r\n      ...(json.relatedInstancePaths ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),\r\n      ...(json.pathFromInputToSelectClass ? { pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap)) } : undefined),\r\n      ...(json.relatedPropertyPaths ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : 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 ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.toCompressedJSON(item, classesMap))) } : undefined),\r\n      ...(selectClass.navigationPropertyClasses ? { navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) => RelatedClassInfo.toCompressedJSON(propertyClass, classesMap)) } : undefined),\r\n      ...(selectClass.pathFromInputToSelectClass ? { pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap)) } : undefined),\r\n      ...(selectClass.relatedPropertyPaths ? { relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) => path.map((relatedClass) => RelatedClassInfo.toCompressedJSON(relatedClass, classesMap))) } : 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 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   * @beta\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  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  filterExpression?: string;\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  /** [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content */\r\n  filterExpression?: string;\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  /** Content filtering [ECExpression]($docs/presentation/advanced/ECExpressions) */\r\n  readonly filterExpression?: string;\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  /** Extended options used to create the descriptor */\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  /** Field used to sort the content */\r\n  public sortingField?: Field;\r\n  /** Sorting direction */\r\n  public sortDirection?: SortDirection;\r\n  /** Content filtering [ECExpression]($docs/presentation/advanced/ECExpressions) */\r\n  public filterExpression?: string;\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.filterExpression;\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        connectionId: this.connectionId,\r\n        inputKeysHash: this.inputKeysHash,\r\n        contentOptions: this.contentOptions,\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.sortingField !== undefined && { sortingFieldName: this.sortingField.name },\r\n      this.sortDirection !== undefined && { sortDirection: this.sortDirection },\r\n      this.filterExpression !== undefined && { filterExpression: this.filterExpression },\r\n      this.selectionInfo !== undefined && { selectionInfo: this.selectionInfo },\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    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.map((fieldJson: FieldJSON) => {\r\n      const field = factory(fieldJson);\r\n      if (field)\r\n        field.rebuildParentship();\r\n      return field;\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   * 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    if (this.contentFlags !== 0)\r\n      overrides.contentFlags = this.contentFlags;\r\n    if (this.filterExpression)\r\n      overrides.filterExpression = this.filterExpression;\r\n    if (this.sortingField)\r\n      overrides.sorting = { field: this.sortingField.getFieldDescriptor(), direction: this.sortDirection ?? SortDirection.Ascending };\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;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAc,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAC8C,gBAAgB,EAAwB,wCAAwC,GAEpI,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,mBAAmB,EAA2B,MAAM,YAAY,CAAC;AAC1E,OAAO,EAAE,KAAK,EAA8B,cAAc,EAAE,MAAM,UAAU,CAAC;AAuC7E,cAAc;AACd,MAAM,KAAW,eAAe,CAsC/B;AAtCD,WAAiB,eAAe;IAC9B,2DAA2D;IAC3D,SAAgB,kBAAkB,CAAC,IAAiC,EAAE,UAAqD;QACzH,MAAM,CAAC,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,CAAC,CAAC,CAAC,EAAE,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACpL,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,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,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACvL,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,0BAA0B,EAAE,IAAI,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wCAAwC,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/M,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,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,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAC1L,CAAC;IACJ,CAAC;IAVe,kCAAkB,qBAUjC,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,CAAC,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,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YACnM,GAAG,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,yBAAyB,EAAE,WAAW,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAClN,GAAG,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,0BAA0B,EAAE,WAAW,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,wCAAwC,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3N,GAAG,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SACtN,CAAC;IACJ,CAAC;IAXe,gCAAgB,mBAW/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,EAtCgB,eAAe,KAAf,eAAe,QAsC/B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,YAoCX;AApCD,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;;;;;OAKG;IACH,yEAAyB,CAAA;IAEzB;;;;OAIG;IACH,qEAAuB,CAAA;AACzB,CAAC,EApCW,YAAY,KAAZ,YAAY,QAoCvB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,2DAAS,CAAA;IACT,6DAAU,CAAA;AACZ,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAkGD;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IA0BrB,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,gBAAgB,CAAC;IAClD,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,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,mBAAmB,CAAC,MAAM,CAAC;YAC3D,MAAM;YACN,aAAa;YACb,UAAU;SACX,EACD,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,EAClF,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAC1E,CAAC;IACJ,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,QAAQ,CAAC,IAAgC;QACrD,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QAEnB,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC;QAC7C,MAAM,UAAU,GAAG,mBAAmB,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,KAAK,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,cAAc,CAAC,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,CAAC,GAAG,CAAC,CAAC,SAAoB,EAAE,EAAE;YACvC,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;YACjC,IAAI,KAAK;gBACP,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAkB,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,IAAY,EAAE,OAAiB;QACnD,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,yBAAyB;;QAC9B,MAAM,SAAS,GAAwB,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW;YAClB,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC3C,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC;YACzB,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7C,IAAI,IAAI,CAAC,gBAAgB;YACvB,SAAS,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACrD,IAAI,IAAI,CAAC,YAAY;YACnB,SAAS,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE,SAAS,EAAE,MAAA,IAAI,CAAC,aAAa,mCAAI,aAAa,CAAC,SAAS,EAAE,CAAC;QAClI,OAAO,SAAS,CAAC;IACnB,CAAC;CACF","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 Content\n */\n\nimport { assert, Id64String } from \"@itwin/core-bentley\";\nimport {\n  ClassInfo, ClassInfoJSON, CompressedClassInfoJSON, RelatedClassInfo, RelatedClassInfoJSON, RelatedClassInfoWithOptionalRelationship,\n  RelatedClassInfoWithOptionalRelationshipJSON, RelationshipPath, RelationshipPathJSON,\n} from \"../EC\";\nimport { CategoryDescription, CategoryDescriptionJSON } from \"./Category\";\nimport { Field, FieldDescriptor, FieldJSON, getFieldByName } from \"./Fields\";\n\n/**\n * Data structure that describes an ECClass in content [[Descriptor]].\n * @public\n */\nexport interface SelectClassInfo {\n  /** Information about the ECClass */\n  selectClassInfo: ClassInfo;\n\n  /** Is the class handled polymorphically */\n  isSelectPolymorphic: boolean;\n\n  /** Relationship path from input class to the select class. */\n  pathFromInputToSelectClass?: RelatedClassInfoWithOptionalRelationship[];\n\n  /** Relationship paths to [related property]($docs/presentation/content/Terminology#related-properties) classes */\n  relatedPropertyPaths?: RelationshipPath[];\n\n  /** Relationship paths to navigation property classes */\n  navigationPropertyClasses?: RelatedClassInfo[];\n\n  /** Relationship paths to [related instance]($docs/presentation/content/Terminology#related-instance) classes. */\n  relatedInstancePaths?: RelationshipPath[];\n}\n\n/**\n * Serialized [[SelectClassInfo]] JSON representation\n * @public\n */\nexport interface SelectClassInfoJSON<TClassInfoJSON = ClassInfoJSON> {\n  selectClassInfo: TClassInfoJSON;\n  isSelectPolymorphic: boolean;\n  pathFromInputToSelectClass?: RelatedClassInfoWithOptionalRelationshipJSON<TClassInfoJSON>[];\n  relatedPropertyPaths?: RelationshipPathJSON<TClassInfoJSON>[];\n  navigationPropertyClasses?: RelatedClassInfoJSON<TClassInfoJSON>[];\n  relatedInstancePaths?: RelationshipPathJSON<TClassInfoJSON>[];\n}\n\n/** @public */\nexport namespace SelectClassInfo {\n  /** Deserialize [[SelectClassInfo]] from compressed JSON */\n  export function fromCompressedJSON(json: SelectClassInfoJSON<string>, classesMap: { [id: string]: CompressedClassInfoJSON }): SelectClassInfo {\n    assert(classesMap.hasOwnProperty(json.selectClassInfo));\n    return {\n      selectClassInfo: { id: json.selectClassInfo, ...classesMap[json.selectClassInfo] },\n      isSelectPolymorphic: json.isSelectPolymorphic,\n      ...(json.navigationPropertyClasses ? { navigationPropertyClasses: json.navigationPropertyClasses.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap)) } : undefined),\n      ...(json.relatedInstancePaths ? { relatedInstancePaths: json.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),\n      ...(json.pathFromInputToSelectClass ? { pathFromInputToSelectClass: json.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.fromCompressedJSON(item, classesMap)) } : undefined),\n      ...(json.relatedPropertyPaths ? { relatedPropertyPaths: json.relatedPropertyPaths.map((path) => path.map((item) => RelatedClassInfo.fromCompressedJSON(item, classesMap))) } : undefined),\n    };\n  }\n\n  /** Serialize [[SelectClassInfo]] to compressed JSON */\n  export function toCompressedJSON(selectClass: SelectClassInfo, classesMap: { [id: string]: CompressedClassInfoJSON }): SelectClassInfoJSON<string> {\n    const { id, ...leftOverClassInfo } = selectClass.selectClassInfo;\n    classesMap[id] = leftOverClassInfo;\n    return {\n      selectClassInfo: id,\n      isSelectPolymorphic: selectClass.isSelectPolymorphic,\n      ...(selectClass.relatedInstancePaths ? { relatedInstancePaths: selectClass.relatedInstancePaths.map((rip) => rip.map((item) => RelatedClassInfo.toCompressedJSON(item, classesMap))) } : undefined),\n      ...(selectClass.navigationPropertyClasses ? { navigationPropertyClasses: selectClass.navigationPropertyClasses.map((propertyClass) => RelatedClassInfo.toCompressedJSON(propertyClass, classesMap)) } : undefined),\n      ...(selectClass.pathFromInputToSelectClass ? { pathFromInputToSelectClass: selectClass.pathFromInputToSelectClass.map((item) => RelatedClassInfoWithOptionalRelationship.toCompressedJSON(item, classesMap)) } : undefined),\n      ...(selectClass.relatedPropertyPaths ? { relatedPropertyPaths: selectClass.relatedPropertyPaths.map((path) => path.map((relatedClass) => RelatedClassInfo.toCompressedJSON(relatedClass, classesMap))) } : undefined),\n    };\n  }\n\n  /**\n   * Deserialize [[SelectClassInfo]] list from JSON\n   * @param json JSON or JSON serialized to string to deserialize from\n   * @returns Deserialized [[SelectClassInfo]] objects list\n   *\n   * @internal\n   */\n  export function listFromCompressedJSON(json: SelectClassInfoJSON<Id64String>[], classesMap: { [id: string]: CompressedClassInfoJSON }): SelectClassInfo[] {\n    return json.map((sci) => fromCompressedJSON(sci, classesMap));\n  }\n}\n\n/**\n * Flags that control content format.\n * @public\n */\nexport enum ContentFlags {\n  /** Each content record only has [[InstanceKey]] and no data */\n  KeysOnly = 1 << 0,\n\n  /**\n   * Each content record additionally has an image id\n   * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  ShowImages = 1 << 1,\n\n  /** Each content record additionally has a display label */\n  ShowLabels = 1 << 2,\n\n  /** All content records are merged into a single record (see [Merging values]($docs/presentation/content/terminology#value-merging)) */\n  MergeResults = 1 << 3,\n\n  /** Content has only distinct values */\n  DistinctValues = 1 << 4,\n\n  /** Doesn't create property or calculated fields. Can be used in conjunction with [[ShowLabels]]. */\n  NoFields = 1 << 5,\n\n  /**\n   * Set related input keys on [[Item]] objects when creating content. This helps identify which [[Item]] is associated to which\n   * given input key at the cost of performance creating those items.\n   *\n   * @beta\n   */\n  IncludeInputKeys = 1 << 8,\n\n  /**\n   * Produce content descriptor that is not intended for querying content. Allows the implementation to omit certain\n   * operations to make obtaining content descriptor faster.\n   * @internal\n   */\n  DescriptorOnly = 1 << 9,\n}\n\n/**\n * Data sorting direction\n * @public\n */\nexport enum SortDirection {\n  Ascending,\n  Descending,\n}\n\n/**\n * Data structure that contains selection information. Used\n * for cases when requesting content after a selection change.\n *\n * @public\n */\nexport interface SelectionInfo {\n  /** Name of selection provider which cause the selection change */\n  providerName: string;\n  /** Level of selection that changed */\n  level?: number;\n}\n\n/**\n * Serialized [[Descriptor]] JSON representation.\n * @public\n */\nexport interface DescriptorJSON {\n  classesMap: { [id: string]: CompressedClassInfoJSON };\n  connectionId: string;\n  inputKeysHash: string;\n  contentOptions: any;\n  selectionInfo?: SelectionInfo;\n  displayType: string;\n  selectClasses: SelectClassInfoJSON<Id64String>[];\n  categories: CategoryDescriptionJSON[];\n  fields: FieldJSON<Id64String>[];\n  sortingFieldName?: string;\n  sortDirection?: SortDirection;\n  contentFlags: number;\n  filterExpression?: string;\n}\n\n/**\n * Descriptor overrides that can be used to customize content\n * @public\n */\nexport interface DescriptorOverrides {\n  /**\n   * Content display type. Can be accessed in presentation rules and used\n   * to modify content in various ways. Defaults to empty string.\n   */\n  displayType?: string;\n\n  /** Content flags used for content customization. See [[ContentFlags]] */\n  contentFlags?: number;\n\n  /** Fields selector that allows excluding or including only specified fields. */\n  fieldsSelector?: {\n    /** Should the specified fields be included or excluded */\n    type: \"include\" | \"exclude\";\n    /** A list of field descriptors that identify fields to include / exclude */\n    fields: FieldDescriptor[];\n  };\n\n  /** Specification for sorting data. */\n  sorting?: {\n    /** Identifier of the field to use for sorting */\n    field: FieldDescriptor;\n    /** Sort direction */\n    direction: SortDirection;\n  };\n\n  /** [ECExpression]($docs/presentation/advanced/ECExpressions.md) for filtering content */\n  filterExpression?: string;\n}\n\n/**\n * Descriptor properties\n * @public\n */\nexport interface DescriptorSource {\n  /** Id of the connection used to create the descriptor */\n  readonly connectionId?: string;\n  /** Hash of the input keys used to create the descriptor */\n  readonly inputKeysHash?: string;\n  /** Selection info used to create the descriptor */\n  readonly selectionInfo?: SelectionInfo;\n  /** Display type used to create the descriptor */\n  readonly displayType: string;\n  /** A list of classes that will be selected from when creating content with this descriptor */\n  readonly selectClasses: SelectClassInfo[];\n  /** A list of content field categories used in this descriptor */\n  readonly categories: CategoryDescription[];\n  /** A list of fields contained in the descriptor */\n  readonly fields: Field[];\n  /** [[ContentFlags]] used to create the descriptor */\n  readonly contentFlags: number;\n  /** Field used to sort the content */\n  readonly sortingField?: Field;\n  /** Sorting direction */\n  readonly sortDirection?: SortDirection;\n  /** Content filtering [ECExpression]($docs/presentation/advanced/ECExpressions) */\n  readonly filterExpression?: string;\n}\n\n/**\n * Data structure that describes content: fields, sorting, filtering, format, etc.\n * Descriptor may be changed to control how content is created.\n *\n * @public\n */\nexport class Descriptor implements DescriptorSource {\n  /** Id of the connection used to create the descriptor */\n  public readonly connectionId?: string;\n  /** Hash of the input keys used to create the descriptor */\n  public readonly inputKeysHash?: string;\n  /** Extended options used to create the descriptor */\n  public readonly contentOptions: any;\n  /** Selection info used to create the descriptor */\n  public readonly selectionInfo?: SelectionInfo;\n  /** Display type used to create the descriptor */\n  public readonly displayType: string;\n  /** A list of classes that will be selected when creating content with this descriptor */\n  public readonly selectClasses: SelectClassInfo[];\n  /** A list of content field categories used in this descriptor */\n  public readonly categories: CategoryDescription[];\n  /** A list of fields contained in the descriptor */\n  public readonly fields: Field[];\n  /** [[ContentFlags]] used to create the descriptor */\n  public readonly contentFlags: number;\n  /** Field used to sort the content */\n  public sortingField?: Field;\n  /** Sorting direction */\n  public sortDirection?: SortDirection;\n  /** Content filtering [ECExpression]($docs/presentation/advanced/ECExpressions) */\n  public filterExpression?: string;\n\n  /** Construct a new Descriptor using a [[DescriptorSource]] */\n  public constructor(source: DescriptorSource) {\n    this.connectionId = source.connectionId;\n    this.inputKeysHash = source.inputKeysHash;\n    this.selectionInfo = source.selectionInfo;\n    this.displayType = source.displayType;\n    this.contentFlags = source.contentFlags;\n    this.selectClasses = [...source.selectClasses];\n    this.categories = [...source.categories];\n    this.fields = [...source.fields];\n    this.sortingField = source.sortingField;\n    this.sortDirection = source.sortDirection;\n    this.filterExpression = source.filterExpression;\n  }\n\n  /** Serialize [[Descriptor]] to JSON */\n  public toJSON(): DescriptorJSON {\n    const classesMap: { [id: string]: CompressedClassInfoJSON } = {};\n    const selectClasses: SelectClassInfoJSON<string>[] = this.selectClasses.map((selectClass) => SelectClassInfo.toCompressedJSON(selectClass, classesMap));\n    const fields: FieldJSON<string>[] = this.fields.map((field) => field.toCompressedJSON(classesMap));\n    return Object.assign(\n      {\n        connectionId: this.connectionId,\n        inputKeysHash: this.inputKeysHash,\n        contentOptions: this.contentOptions,\n        displayType: this.displayType,\n        contentFlags: this.contentFlags,\n        categories: this.categories.map(CategoryDescription.toJSON),\n        fields,\n        selectClasses,\n        classesMap,\n      },\n      this.sortingField !== undefined && { sortingFieldName: this.sortingField.name },\n      this.sortDirection !== undefined && { sortDirection: this.sortDirection },\n      this.filterExpression !== undefined && { filterExpression: this.filterExpression },\n      this.selectionInfo !== undefined && { selectionInfo: this.selectionInfo },\n    );\n  }\n\n  /** Deserialize [[Descriptor]] from JSON */\n  public static fromJSON(json: DescriptorJSON | undefined): Descriptor | undefined {\n    if (!json)\n      return undefined;\n\n    const { classesMap, ...leftOverJson } = json;\n    const categories = CategoryDescription.listFromJSON(json.categories);\n    const selectClasses = SelectClassInfo.listFromCompressedJSON(json.selectClasses, classesMap);\n    const fields = this.getFieldsFromJSON(json.fields, (fieldJson) => Field.fromCompressedJSON(fieldJson, classesMap, categories));\n    return new Descriptor({\n      ...leftOverJson,\n      selectClasses,\n      categories,\n      fields,\n      sortingField: getFieldByName(fields, json.sortingFieldName, true),\n    });\n  }\n\n  private static getFieldsFromJSON(json: FieldJSON[], factory: (json: FieldJSON) => Field | undefined): Field[] {\n    return json.map((fieldJson: FieldJSON) => {\n      const field = factory(fieldJson);\n      if (field)\n        field.rebuildParentship();\n      return field;\n    }).filter((field): field is Field => !!field);\n  }\n\n  /**\n   * Get field by its name\n   * @param name Name of the field to find\n   * @param recurse Recurse into nested fields\n   */\n  public getFieldByName(name: string, recurse?: boolean): Field | undefined {\n    return getFieldByName(this.fields, name, recurse);\n  }\n\n  /**\n   * Create descriptor overrides object from this descriptor.\n   * @public\n   */\n  public createDescriptorOverrides(): DescriptorOverrides {\n    const overrides: DescriptorOverrides = {};\n    if (this.displayType)\n      overrides.displayType = this.displayType;\n    if (this.contentFlags !== 0)\n      overrides.contentFlags = this.contentFlags;\n    if (this.filterExpression)\n      overrides.filterExpression = this.filterExpression;\n    if (this.sortingField)\n      overrides.sorting = { field: this.sortingField.getFieldDescriptor(), direction: this.sortDirection ?? SortDirection.Ascending };\n    return overrides;\n  }\n}\n"]}

package/lib/esm/presentation-common/content/DisplayTypes.d.ts

@@ -1,22 +1,22 @@
-/** @packageDocumentation
- * @module Content
- */
-/**
- * Displayed content types. Affects how the content is formatted, e.g.
- * the [[ContentFlags]].
- *
- * @public
- */
-export declare enum DefaultContentDisplayTypes {
-    /** Unknown content type. */
-    Undefined = "Undefined",
-    /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */
-    Grid = "Grid",
-    /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */
-    PropertyPane = "PropertyPane",
-    /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */
-    List = "List",
-    /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */
-    Viewport = "Graphics"
-}
+/** @packageDocumentation
+ * @module Content
+ */
+/**
+ * Displayed content types. Affects how the content is formatted, e.g.
+ * the [[ContentFlags]].
+ *
+ * @public
+ */
+export declare enum DefaultContentDisplayTypes {
+    /** Unknown content type. */
+    Undefined = "Undefined",
+    /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */
+    Grid = "Grid",
+    /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */
+    PropertyPane = "PropertyPane",
+    /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */
+    List = "List",
+    /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */
+    Viewport = "Graphics"
+}
 //# sourceMappingURL=DisplayTypes.d.ts.map

package/lib/esm/presentation-common/content/DisplayTypes.js

@@ -1,27 +1,27 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Content
- */
-/**
- * Displayed content types. Affects how the content is formatted, e.g.
- * the [[ContentFlags]].
- *
- * @public
- */
-export var DefaultContentDisplayTypes;
-(function (DefaultContentDisplayTypes) {
-    /** Unknown content type. */
-    DefaultContentDisplayTypes["Undefined"] = "Undefined";
-    /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */
-    DefaultContentDisplayTypes["Grid"] = "Grid";
-    /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */
-    DefaultContentDisplayTypes["PropertyPane"] = "PropertyPane";
-    /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */
-    DefaultContentDisplayTypes["List"] = "List";
-    /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */
-    DefaultContentDisplayTypes["Viewport"] = "Graphics";
-})(DefaultContentDisplayTypes || (DefaultContentDisplayTypes = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Content
+ */
+/**
+ * Displayed content types. Affects how the content is formatted, e.g.
+ * the [[ContentFlags]].
+ *
+ * @public
+ */
+export var DefaultContentDisplayTypes;
+(function (DefaultContentDisplayTypes) {
+    /** Unknown content type. */
+    DefaultContentDisplayTypes["Undefined"] = "Undefined";
+    /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */
+    DefaultContentDisplayTypes["Grid"] = "Grid";
+    /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */
+    DefaultContentDisplayTypes["PropertyPane"] = "PropertyPane";
+    /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */
+    DefaultContentDisplayTypes["List"] = "List";
+    /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */
+    DefaultContentDisplayTypes["Viewport"] = "Graphics";
+})(DefaultContentDisplayTypes || (DefaultContentDisplayTypes = {}));
 //# sourceMappingURL=DisplayTypes.js.map

package/lib/esm/presentation-common/content/DisplayTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"DisplayTypes.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/DisplayTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,CAAN,IAAY,0BAeX;AAfD,WAAY,0BAA0B;IACpC,4BAA4B;IAC5B,qDAAuB,CAAA;IAEvB,yFAAyF;IACzF,2CAAa,CAAA;IAEb,sFAAsF;IACtF,2DAA6B,CAAA;IAE7B,yGAAyG;IACzG,2CAAa,CAAA;IAEb,6EAA6E;IAC7E,mDAAqB,CAAA;AACvB,CAAC,EAfW,0BAA0B,KAA1B,0BAA0B,QAerC","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\n/**\r\n * Displayed content types. Affects how the content is formatted, e.g.\r\n * the [[ContentFlags]].\r\n *\r\n * @public\r\n */\r\nexport enum DefaultContentDisplayTypes {\r\n  /** Unknown content type. */\r\n  Undefined = \"Undefined\", // eslint-disable-line id-blacklist\r\n\r\n  /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */\r\n  Grid = \"Grid\",\r\n\r\n  /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */\r\n  PropertyPane = \"PropertyPane\",\r\n\r\n  /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */\r\n  List = \"List\",\r\n\r\n  /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */\r\n  Viewport = \"Graphics\",\r\n}\r\n"]}
+{"version":3,"file":"DisplayTypes.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/DisplayTypes.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,CAAN,IAAY,0BAeX;AAfD,WAAY,0BAA0B;IACpC,4BAA4B;IAC5B,qDAAuB,CAAA;IAEvB,yFAAyF;IACzF,2CAAa,CAAA;IAEb,sFAAsF;IACtF,2DAA6B,CAAA;IAE7B,yGAAyG;IACzG,2CAAa,CAAA;IAEb,6EAA6E;IAC7E,mDAAqB,CAAA;AACvB,CAAC,EAfW,0BAA0B,KAA1B,0BAA0B,QAerC","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 Content\n */\n\n/**\n * Displayed content types. Affects how the content is formatted, e.g.\n * the [[ContentFlags]].\n *\n * @public\n */\nexport enum DefaultContentDisplayTypes {\n  /** Unknown content type. */\n  Undefined = \"Undefined\", // eslint-disable-line id-blacklist\n\n  /** Grid or table view content type. By default adds [[ContentFlags.ShowLabels]] flag. */\n  Grid = \"Grid\",\n\n  /** Property pane content type. By default adds [[ContentFlags.MergeResults]] flag. */\n  PropertyPane = \"PropertyPane\",\n\n  /** List content type. By default adds [[ContentFlags.NoFields]] and [[ContentFlags.ShowLabels]] flags */\n  List = \"List\",\n\n  /** Viewport content type. By default adds [[ContentFlags.KeysOnly]] flag. */\n  Viewport = \"Graphics\",\n}\n"]}

package/lib/esm/presentation-common/content/Editor.d.ts

@@ -1,16 +1,16 @@
-/** @packageDocumentation
- * @module Content
- */
-/**
- * A data structure which describes property editor used
- * for a content [[Field]].
- *
- * @public
- */
-export interface EditorDescription {
-    /** Unique name */
-    name: string;
-    /** Editor-specific parameters */
-    params?: any;
-}
+/** @packageDocumentation
+ * @module Content
+ */
+/**
+ * A data structure which describes property editor used
+ * for a content [[Field]].
+ *
+ * @public
+ */
+export interface EditorDescription {
+    /** Unique name */
+    name: string;
+    /** Editor-specific parameters */
+    params?: any;
+}
 //# sourceMappingURL=Editor.d.ts.map