npm - @itwin/presentation-common - Versions diffs - 5.0.0-dev.7 → 5.0.0-dev.72 - Mend

@itwin/presentation-common 5.0.0-dev.7 → 5.0.0-dev.72

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (287) hide show

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

@@ -12,6 +12,7 @@ const core_bentley_1 = require("@itwin/core-bentley");
 const EC_1 = require("../EC");
 const Category_1 = require("./Category");
 const Fields_1 = require("./Fields");
+const Utils_1 = require("../Utils");
 /** @public */
 var SelectClassInfo;
 (function (SelectClassInfo) {
@@ -86,11 +87,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)) */
@@ -127,6 +123,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 +182,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 +191,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_1.omitUndefined)({
             displayType: this.displayType,
             contentFlags: this.contentFlags,
             categories: this.categories.map(Category_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_1.CategoryDescription.listFromJSON(jsonCategories);
+        const selectClasses = SelectClassInfo.listFromCompressedJSON(jsonSelectClasses, classesMap);
+        const fields = this.getFieldsFromJSON(jsonFields, (fieldJson) => Fields_1.Field.fromCompressedJSON(fieldJson, classesMap, categories));
         return new Descriptor({
             ...leftOverJson,
+            ...(connectionId ? /* istanbul ignore next */ { connectionId } : undefined),
+            ...(inputKeysHash ? /* istanbul ignore next */ { inputKeysHash } : undefined),
             selectClasses,
             categories,
             fields,
-            sortingField: (0, Fields_1.getFieldByName)(fields, json.sortingFieldName, true),
+            sortingField: (0, Fields_1.getFieldByName)(fields, sortingFieldName, true),
         });
     }
     static getFieldsFromJSON(json, factory) {
@@ -216,10 +264,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 CHANGED Viewed

	@@ -1 +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"]}
1	+ {"version":3,"file":"Descriptor.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Descriptor.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAEH,sDAAyD;AACzD,8BASe;AAGf,yCAA0E;AAC1E,qCAAmG;AACnG,oCAAyC;AAuCzC,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,YA4BX;AA5BD,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;IAEzB;;;;OAIG;IACH,qEAAuB,CAAA;AACzB,CAAC,EA5BW,YAAY,4BAAZ,YAAY,QA4BvB;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,qBAAa,EAAC;YACnB,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;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,8BAAmB,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,aAAa,GAAG,eAAe,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;QAC5F,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,cAAK,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,0BAA0B,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3E,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAC7E,aAAa;YACb,UAAU;YACV,MAAM;YACN,YAAY,EAAE,IAAA,uBAAc,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,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,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\";\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\nimport { omitUndefined } from \"../Utils\";\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 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 /* 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 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 = SelectClassInfo.listFromCompressedJSON(jsonSelectClasses, 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 ? / istanbul ignore next / { connectionId } : undefined),\r\n ...(inputKeysHash ? / istanbul 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"]}

package/lib/cjs/presentation-common/content/Fields.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * @module Content
  */
 import { Id64String } from "@itwin/core-bentley";
-import { ClassInfo, ClassInfoJSON, CompressedClassInfoJSON, RelationshipPath, RelationshipPathJSON, StrippedRelationshipPath } from "../EC";
+import { ClassInfo, CompressedClassInfoJSON, RelationshipPath, RelationshipPathJSON, StrippedRelationshipPath } from "../EC";
 import { RelationshipMeaning } from "../rules/content/modifiers/RelatedPropertiesSpecification";
 import { CategoryDescription } from "./Category";
 import { EditorDescription } from "./Editor";
@@ -30,7 +30,7 @@ export interface BaseFieldJSON {
  * Data structure for a [[PropertiesField]] serialized to JSON.
  * @public
  */
-export interface PropertiesFieldJSON<TClassInfoJSON = ClassInfoJSON> extends BaseFieldJSON {
+export interface PropertiesFieldJSON<TClassInfoJSON = ClassInfo> extends BaseFieldJSON {
     properties: PropertyJSON<TClassInfoJSON>[];
 }
 /**
@@ -51,7 +51,7 @@ export interface StructPropertiesFieldJSON<TClassInfoJSON = ClassInfo> extends P
  * Data structure for a [[NestedContentField]] serialized to JSON.
  * @public
  */
-export interface NestedContentFieldJSON<TClassInfoJSON = ClassInfoJSON> extends BaseFieldJSON {
+export interface NestedContentFieldJSON<TClassInfoJSON = ClassInfo> extends BaseFieldJSON {
     contentClassInfo: TClassInfoJSON;
     pathToPrimaryClass: RelationshipPathJSON<TClassInfoJSON>;
     relationshipMeaning?: RelationshipMeaning;
@@ -63,7 +63,33 @@ export interface NestedContentFieldJSON<TClassInfoJSON = ClassInfoJSON> extends
  * JSON representation of a [[Field]]
  * @public
  */
-export type FieldJSON<TClassInfoJSON = ClassInfoJSON> = BaseFieldJSON | PropertiesFieldJSON<TClassInfoJSON> | ArrayPropertiesFieldJSON<TClassInfoJSON> | StructPropertiesFieldJSON<TClassInfoJSON> | NestedContentFieldJSON<TClassInfoJSON>;
+export type FieldJSON<TClassInfoJSON = ClassInfo> = BaseFieldJSON | PropertiesFieldJSON<TClassInfoJSON> | ArrayPropertiesFieldJSON<TClassInfoJSON> | StructPropertiesFieldJSON<TClassInfoJSON> | NestedContentFieldJSON<TClassInfoJSON>;
+/**
+ * Props for creating [[Field]].
+ * @public
+ */
+interface FieldProps {
+    /** Category information */
+    category: CategoryDescription;
+    /** Unique name */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Description of this field's values data type */
+    type: TypeDescription;
+    /** Are values in this field read-only */
+    isReadonly: boolean;
+    /** Priority of the field */
+    priority: number;
+    /** Property editor used to edit values of this field */
+    editor?: EditorDescription;
+    /** Property renderer used to render values of this field */
+    renderer?: RendererDescription;
+    /** Extended data associated with this field */
+    extendedData?: {
+        [key: string]: unknown;
+    };
+}
 /**
  * Describes a single content field. A field is usually represented as a grid column
  * or a property pane row.
@@ -94,7 +120,7 @@ export declare class Field {
     /** Parent field */
     private _parent?;
     /**
-     * Creates an instance of Field.
+     * Creates an instance of [[Field]].
      * @param category Category information
      * @param name Unique name
      * @param label Display label
@@ -104,10 +130,13 @@ export declare class Field {
      * @param editor Property editor used to edit values of this field
      * @param renderer Property renderer used to render values of this field
      * @param extendedData Extended data associated with this field
+     * @deprecated in 5.0. Use an overload with `FieldProps` instead.
      */
     constructor(category: CategoryDescription, name: string, label: string, type: TypeDescription, isReadonly: boolean, priority: number, editor?: EditorDescription, renderer?: RendererDescription, extendedData?: {
         [key: string]: unknown;
     });
+    /** Creates an instance of [[Field]]. */
+    constructor(props: FieldProps);
     /**
      * Is this a [[PropertiesField]]
      */
@@ -121,13 +150,19 @@ export declare class Field {
      */
     get parent(): NestedContentField | undefined;
     clone(): Field;
-    /** Serialize this object to JSON */
+    /**
+     * Serialize this object to JSON.
+     * @deprecated in 5.x. Use [[toCompressedJSON]] instead.
+     */
     toJSON(): FieldJSON;
     /** Serialize this object to compressed JSON */
     toCompressedJSON(_classesMap: {
         [id: string]: CompressedClassInfoJSON;
     }): FieldJSON<string>;
-    /** Deserialize [[Field]] from JSON */
+    /**
+     * Deserialize [[Field]] from JSON.
+     * @deprecated in 5.x. Use [[fromCompressedJSON]] instead.
+     */
     static fromJSON(json: FieldJSON | undefined, categories: CategoryDescription[]): Field | undefined;
     /** Deserialize a [[Field]] from compressed JSON. */
     static fromCompressedJSON(json: FieldJSON<string> | undefined, classesMap: {
@@ -149,6 +184,14 @@ export declare class Field {
      */
     matchesDescriptor(descriptor: FieldDescriptor): boolean;
 }
+/**
+ * Props for creating [[PropertiesField]].
+ * @public
+ */
+interface PropertiesFieldProps extends FieldProps {
+    /** A list of properties this field is created from */
+    properties: Property[];
+}
 /**
  * Describes a content field that's based on one or more similar
  * EC properties.
@@ -159,7 +202,7 @@ export declare class PropertiesField extends Field {
     /** A list of properties this field is created from */
     properties: Property[];
     /**
-     * Creates an instance of PropertiesField.
+     * Creates an instance of [[PropertiesField]].
      * @param category Category information
      * @param name Unique name
      * @param label Display label
@@ -169,20 +212,29 @@ export declare class PropertiesField extends Field {
      * @param properties A list of properties this field is created from
      * @param editor Property editor used to edit values of this field
      * @param renderer Property renderer used to render values of this field
+     * @deprecated in 5.0. Use an overload with `PropertiesFieldProps` instead.
      */
-    constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription);
+    constructor(category: CategoryDescription, name: string, label: string, type: TypeDescription, isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription);
+    /** Creates an instance of [[PropertiesField]]. */
+    constructor(props: PropertiesFieldProps);
     /** Is this a an array property field */
     isArrayPropertiesField(): this is ArrayPropertiesField;
     /** Is this a an struct property field */
     isStructPropertiesField(): this is StructPropertiesField;
     clone(): PropertiesField;
-    /** Serialize this object to JSON */
+    /**
+     * Serialize this object to JSON
+     * @deprecated in 5.x. Use [[toCompressedJSON]] instead.
+     */
     toJSON(): PropertiesFieldJSON;
     /** Serialize this object to compressed JSON */
     toCompressedJSON(classesMap: {
         [id: string]: CompressedClassInfoJSON;
     }): PropertiesFieldJSON<string>;
-    /** Deserialize [[PropertiesField]] from JSON */
+    /**
+     * Deserialize [[PropertiesField]] from JSON.
+     * @deprecated in 5.x. Use [[fromCompressedJSON]] instead.
+     */
     static fromJSON(json: PropertiesFieldJSON | undefined, categories: CategoryDescription[]): PropertiesField | undefined;
     /**
      * Deserialize a [[PropertiesField]] from compressed JSON.
@@ -202,22 +254,41 @@ export declare class PropertiesField extends Field {
      */
     matchesDescriptor(descriptor: FieldDescriptor): boolean;
 }
+/**
+ * Props for creating [[ArrayPropertiesField]].
+ * @public
+ */
+interface ArrayPropertiesFieldProps extends PropertiesFieldProps {
+    itemsField: PropertiesField;
+}
 /**
  * Describes a content field that's based on one or more similar EC array properties.
  * @public
  */
 export declare class ArrayPropertiesField extends PropertiesField {
     itemsField: PropertiesField;
-    constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, itemsField: PropertiesField, isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription);
+    /**
+     * Creates an instance of [[ArrayPropertiesField]].
+     * @deprecated in 5.0. Use an overload with `ArrayPropertiesFieldProps` instead.
+     */
+    constructor(category: CategoryDescription, name: string, label: string, type: TypeDescription, itemsField: PropertiesField, isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription);
+    /** Creates an instance of [[ArrayPropertiesField]]. */
+    constructor(props: ArrayPropertiesFieldProps);
     isArrayPropertiesField(): this is ArrayPropertiesField;
     clone(): ArrayPropertiesField;
-    /** Serialize this object to JSON */
+    /**
+     * Serialize this object to JSON.
+     * @deprecated in 5.x. Use [[toCompressedJSON]] instead.
+     */
     toJSON(): ArrayPropertiesFieldJSON;
     /** Serialize this object to compressed JSON */
     toCompressedJSON(classesMap: {
         [id: string]: CompressedClassInfoJSON;
     }): ArrayPropertiesFieldJSON<string>;
-    /** Deserialize [[ArrayPropertiesField]] from JSON */
+    /**
+     * Deserialize [[ArrayPropertiesField]] from JSON.
+     * @deprecated in 5.x. Use [[fromCompressedJSON]] instead.
+     */
     static fromJSON(json: ArrayPropertiesFieldJSON, categories: CategoryDescription[]): ArrayPropertiesField;
     /**
      * Deserialize an [[ArrayPropertiesField]] from compressed JSON.
@@ -227,22 +298,41 @@ export declare class ArrayPropertiesField extends PropertiesField {
         [id: string]: CompressedClassInfoJSON;
     }, categories: CategoryDescription[]): ArrayPropertiesField;
 }
+/**
+ * Props for creating [[StructPropertiesField]].
+ * @public
+ */
+interface StructPropertiesFieldProps extends PropertiesFieldProps {
+    memberFields: PropertiesField[];
+}
 /**
  * Describes a content field that's based on one or more similar EC struct properties.
  * @public
  */
 export declare class StructPropertiesField extends PropertiesField {
     memberFields: PropertiesField[];
-    constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, memberFields: PropertiesField[], isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription);
+    /**
+     * Creates an instance of [[StructPropertiesField]].
+     * @deprecated in 5.0. Use an overload with `StructPropertiesFieldProps` instead.
+     */
+    constructor(category: CategoryDescription, name: string, label: string, type: TypeDescription, memberFields: PropertiesField[], isReadonly: boolean, priority: number, properties: Property[], editor?: EditorDescription, renderer?: RendererDescription);
+    /** Creates an instance of [[StructPropertiesField]]. */
+    constructor(props: StructPropertiesFieldProps);
     isStructPropertiesField(): this is StructPropertiesField;
     clone(): StructPropertiesField;
-    /** Serialize this object to JSON */
+    /**
+     * Serialize this object to JSON.
+     * @deprecated in 5.x. Use [[toCompressedJSON]] instead.
+     */
     toJSON(): StructPropertiesFieldJSON;
     /** Serialize this object to compressed JSON */
     toCompressedJSON(classesMap: {
         [id: string]: CompressedClassInfoJSON;
     }): StructPropertiesFieldJSON<string>;
-    /** Deserialize [[StructPropertiesField]] from JSON */
+    /**
+     * Deserialize [[StructPropertiesField]] from JSON.
+     * @deprecated in 5.x. Use [[fromCompressedJSON]] instead.
+     */
     static fromJSON(json: StructPropertiesFieldJSON, categories: CategoryDescription[]): StructPropertiesField;
     /**
      * Deserialize a [[StructPropertiesField]] from compressed JSON.
@@ -252,6 +342,39 @@ export declare class StructPropertiesField extends PropertiesField {
         [id: string]: CompressedClassInfoJSON;
     }, categories: CategoryDescription[]): StructPropertiesField;
 }
+/**
+ * Props for creating [[NestedContentField]].
+ * @public
+ */
+interface NestedContentFieldProps extends FieldProps {
+    /** Information about an ECClass whose properties are nested inside this field */
+    contentClassInfo: ClassInfo;
+    /** Relationship path to [Primary class]($docs/presentation/content/Terminology#primary-class) */
+    pathToPrimaryClass: RelationshipPath;
+    /**
+     * Meaning of the relationship between the [primary class]($docs/presentation/content/Terminology#primary-class)
+     * and content class of this field.
+     *
+     * The value is set up through [[RelatedPropertiesSpecification.relationshipMeaning]] attribute when setting up
+     * presentation rules for creating the content.
+     */
+    relationshipMeaning?: RelationshipMeaning;
+    /**
+     * When content descriptor is requested in a polymorphic fashion, fields get created if at least one of the concrete classes
+     * has it. In certain situations it's necessary to know which concrete classes caused that and this attribute is
+     * here to help.
+     *
+     * **Example:** There's a base class `A` and it has two derived classes `B` and `C` and class `B` has a relationship to class `D`.
+     * When content descriptor is requested for class `A` polymorphically, it's going to contain fields for all properties of class `B`,
+     * class `C` and a nested content field for the `B -> D` relationship. The nested content field's `actualPrimaryClassIds` attribute
+     * will contain ID of class `B`, identifying that only this specific class has the relationship.
+     */
+    actualPrimaryClassIds?: Id64String[];
+    /** Contained nested fields */
+    nestedFields: Field[];
+    /** Flag specifying whether field should be expanded */
+    autoExpand?: boolean;
+}
 /**
  * Describes a content field that contains [Nested content]($docs/presentation/content/Terminology#nested-content).
  *
@@ -286,7 +409,7 @@ export declare class NestedContentField extends Field {
     /** Flag specifying whether field should be expanded */
     autoExpand?: boolean;
     /**
-     * Creates an instance of NestedContentField.
+     * Creates an instance of [[NestedContentField]].
      * @param category Category information
      * @param name Unique name
      * @param label Display label
@@ -300,8 +423,11 @@ export declare class NestedContentField extends Field {
      * @param autoExpand Flag specifying whether field should be expanded
      * @param relationshipMeaning RelationshipMeaning of the field
      * @param renderer Property renderer used to render values of this field
+     * @deprecated in 5.0. Use an overload with `NestedContentFieldProps` instead.
      */
-    constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, contentClassInfo: ClassInfo, pathToPrimaryClass: RelationshipPath, nestedFields: Field[], editor?: EditorDescription, autoExpand?: boolean, renderer?: RendererDescription);
+    constructor(category: CategoryDescription, name: string, label: string, type: TypeDescription, isReadonly: boolean, priority: number, contentClassInfo: ClassInfo, pathToPrimaryClass: RelationshipPath, nestedFields: Field[], editor?: EditorDescription, autoExpand?: boolean, renderer?: RendererDescription);
+    /** Creates an instance of [[NestedContentField]]. */
+    constructor(props: NestedContentFieldProps);
     clone(): NestedContentField;
     /**
      * Get field by its name
@@ -309,22 +435,19 @@ export declare class NestedContentField extends Field {
      * @param recurse Recurse into nested fields
      */
     getFieldByName(name: string, recurse?: boolean): Field | undefined;
-    /** Serialize this object to JSON */
+    /**
+     * Serialize this object to JSON.
+     * @deprecated in 5.x. Use [[toCompressedJSON]] instead.
+     */
     toJSON(): NestedContentFieldJSON;
     /** Serialize this object to compressed JSON */
     toCompressedJSON(classesMap: {
         [id: string]: CompressedClassInfoJSON;
     }): NestedContentFieldJSON<string>;
-    /**
-     * Deserialize [[NestedContentField]] from JSON
-     * @deprecated in 3.x. Use [[NestedContentField.fromCompressedJSON]]
-     */
-    static fromJSON(json: NestedContentFieldJSON | undefined, categories: CategoryDescription[]): NestedContentField | undefined;
     /** Deserialize a [[NestedContentField]] from compressed JSON. */
     static fromCompressedJSON(json: NestedContentFieldJSON<Id64String>, classesMap: {
         [id: string]: CompressedClassInfoJSON;
-    }, categories: CategoryDescription[]): any;
-    private static fromCommonJSON;
+    }, categories: CategoryDescription[]): NestedContentField;
     /** Resets parent of this field and all nested fields. */
     resetParentship(): void;
     /**
@@ -391,4 +514,5 @@ export interface PropertiesFieldDescriptor extends FieldDescriptorBase {
         name: string;
     }>;
 }
+export {};
 //# sourceMappingURL=Fields.d.ts.map