@itwin/presentation-common 4.4.0-dev.8 → 4.4.0

package/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Change Log - @itwin/presentation-common
 
-This log was last generated on Thu, 14 Dec 2023 20:24:02 GMT and should not be manually modified.
+This log was last generated on Mon, 12 Feb 2024 18:15:58 GMT and should not be manually modified.
+
+## 4.4.0
+Mon, 12 Feb 2024 18:15:58 GMT
+
+### Updates
+
+- Handle SI and METRIC unit systems as a single unit system. This fixes a problem where temperatures are formatted in Kelvin even though metric was requested.
+- Provide an option to control batch size for `PresentationManager.getElementProperties` multi-elements case.
+- Add formatting for kind of quantity point properties.
+- Add support for default formats in `KoqPropertyValueFormatter`.
+
+## 4.3.3
+Wed, 03 Jan 2024 19:28:38 GMT
+
+_Version update only_
 
 ## 4.3.2
 Thu, 14 Dec 2023 20:23:02 GMT

package/lib/cjs/presentation-common/LocalizationHelper.d.ts

@@ -1,10 +1,14 @@
 /** @packageDocumentation
  * @module Core
  */
-import { Node } from "./hierarchy/Node";
 import { Content } from "./content/Content";
-import { LabelDefinition } from "./LabelDefinition";
+import { Descriptor } from "./content/Descriptor";
+import { Item } from "./content/Item";
+import { DisplayValueGroup } from "./content/Value";
 import { ElementProperties } from "./ElementProperties";
+import { Node } from "./hierarchy/Node";
+import { NodePathElement } from "./hierarchy/NodePathElement";
+import { LabelDefinition } from "./LabelDefinition";
 /** @internal */
 export interface LocalizationHelperProps {
     getLocalizedString: (key: string) => string;
@@ -15,16 +19,19 @@ export declare class LocalizationHelper {
     constructor(props: LocalizationHelperProps);
     getLocalizedString(text: string): string;
     getLocalizedNodes(nodes: Node[]): Node[];
+    getLocalizedNodePathElement(npe: NodePathElement): NodePathElement;
+    getLocalizedDisplayValueGroup(group: DisplayValueGroup): DisplayValueGroup;
     getLocalizedLabelDefinition(labelDefinition: LabelDefinition): LabelDefinition;
     getLocalizedLabelDefinitions(labelDefinitions: LabelDefinition[]): LabelDefinition[];
+    getLocalizedContentDescriptor(descriptor: Descriptor): Descriptor;
+    getLocalizedContentItems(items: Item[]): Item[];
     getLocalizedContent(content: Content): Content;
     getLocalizedElementProperties(elem: ElementProperties): ElementProperties;
-    private translateContentItem;
-    private translateContentItemDisplayValue;
-    private translateContentItemValue;
-    private translateContentDescriptorField;
-    private translateContentDescriptorCategory;
-    private translateNode;
-    private translateLabelDefinition;
+    private getLocalizedContentItem;
+    private getLocalizedRawValue;
+    private getLocalizedContentField;
+    private getLocalizedCategoryDescription;
+    private getLocalizedNode;
+    private getLocalizedDisplayValue;
 }
 //# sourceMappingURL=LocalizationHelper.d.ts.map

package/lib/cjs/presentation-common/LocalizationHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LocalizationHelper.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAuB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD,gBAAgB;AAChB,MAAM,WAAW,uBAAuB;IACtC,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;CAC7C;AAED,gBAAgB;AAChB,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,mBAAmB,CAA0B;gBAEzC,KAAK,EAAE,uBAAuB;IAInC,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAI/B,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE;IAMxC,2BAA2B,CAAC,eAAe,EAAE,eAAe,GAAG,eAAe;IAK9E,4BAA4B,CAAC,gBAAgB,EAAE,eAAe,EAAE;IAKhE,mBAAmB,CAAC,OAAO,EAAE,OAAO;IAOpC,6BAA6B,CAAC,IAAI,EAAE,iBAAiB;IAK5D,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,gCAAgC;IAQxC,OAAO,CAAC,yBAAyB;IAsBjC,OAAO,CAAC,+BAA+B;IAIvC,OAAO,CAAC,kCAAkC;IAK1C,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,wBAAwB;CAYjC"}
+{"version":3,"file":"LocalizationHelper.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAgB,iBAAiB,EAAS,MAAM,iBAAiB,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAuB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIzE,gBAAgB;AAChB,MAAM,WAAW,uBAAuB;IACtC,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;CAC7C;AAED,gBAAgB;AAChB,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,mBAAmB,CAA0B;gBAEzC,KAAK,EAAE,uBAAuB;IAInC,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAI/B,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE;IAIxC,2BAA2B,CAAC,GAAG,EAAE,eAAe,GAAG,eAAe;IAQlE,6BAA6B,CAAC,KAAK,EAAE,iBAAiB,GAAG,iBAAiB;IAO1E,2BAA2B,CAAC,eAAe,EAAE,eAAe,GAAG,eAAe;IAsB9E,4BAA4B,CAAC,gBAAgB,EAAE,eAAe,EAAE;IAIhE,6BAA6B,CAAC,UAAU,EAAE,UAAU;IAOpD,wBAAwB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE;IAI/C,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAI9C,6BAA6B,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB;IAQhF,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,oBAAoB;IAqB5B,OAAO,CAAC,wBAAwB;IAMhC,OAAO,CAAC,+BAA+B;IAMvC,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,wBAAwB;CAYjC"}

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

@@ -1,15 +1,17 @@
 "use strict";
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
 /** @packageDocumentation
  * @module Core
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalizationHelper = void 0;
-const LabelDefinition_1 = require("./LabelDefinition");
+const Content_1 = require("./content/Content");
+const Descriptor_1 = require("./content/Descriptor");
 const Value_1 = require("./content/Value");
+const LabelDefinition_1 = require("./LabelDefinition");
 const KEY_PATTERN = /@[\w\d\-_]+:[\w\d\-\._]+?@/g;
 /** @internal */
 class LocalizationHelper {
@@ -20,94 +22,117 @@ class LocalizationHelper {
         return text.replace(KEY_PATTERN, (key) => this._getLocalizedString(key.replace(/^@|@$/g, "")));
     }
     getLocalizedNodes(nodes) {
-        for (const node of nodes)
-            this.translateNode(node);
-        return nodes;
+        return nodes.map((n) => this.getLocalizedNode(n));
+    }
+    getLocalizedNodePathElement(npe) {
+        return {
+            ...npe,
+            node: this.getLocalizedNode(npe.node),
+            children: npe.children.map((c) => this.getLocalizedNodePathElement(c)),
+        };
+    }
+    getLocalizedDisplayValueGroup(group) {
+        return {
+            ...group,
+            displayValue: this.getLocalizedDisplayValue(group.displayValue),
+        };
     }
     getLocalizedLabelDefinition(labelDefinition) {
-        this.translateLabelDefinition(labelDefinition);
+        const getLocalizedComposite = (compositeValue) => ({
+            ...compositeValue,
+            values: compositeValue.values.map((value) => this.getLocalizedLabelDefinition(value)),
+        });
+        if (labelDefinition.typeName === LabelDefinition_1.LabelDefinition.COMPOSITE_DEFINITION_TYPENAME) {
+            return {
+                ...labelDefinition,
+                rawValue: getLocalizedComposite(labelDefinition.rawValue),
+            };
+        }
+        if (labelDefinition.typeName === "string") {
+            return {
+                ...labelDefinition,
+                rawValue: this.getLocalizedString(labelDefinition.rawValue),
+                displayValue: this.getLocalizedString(labelDefinition.displayValue),
+            };
+        }
         return labelDefinition;
     }
     getLocalizedLabelDefinitions(labelDefinitions) {
-        labelDefinitions.forEach((labelDefinition) => this.translateLabelDefinition(labelDefinition));
-        return labelDefinitions;
+        return labelDefinitions.map((labelDefinition) => this.getLocalizedLabelDefinition(labelDefinition));
+    }
+    getLocalizedContentDescriptor(descriptor) {
+        const clone = new Descriptor_1.Descriptor(descriptor);
+        clone.fields.forEach((field) => this.getLocalizedContentField(field));
+        clone.categories.forEach((category) => this.getLocalizedCategoryDescription(category));
+        return clone;
+    }
+    getLocalizedContentItems(items) {
+        return items.map((item) => this.getLocalizedContentItem(item));
     }
     getLocalizedContent(content) {
-        content.contentSet.forEach((item) => this.translateContentItem(item));
-        content.descriptor.fields.forEach((field) => this.translateContentDescriptorField(field));
-        content.descriptor.categories.forEach((category) => this.translateContentDescriptorCategory(category));
-        return content;
+        return new Content_1.Content(this.getLocalizedContentDescriptor(content.descriptor), this.getLocalizedContentItems(content.contentSet));
     }
     getLocalizedElementProperties(elem) {
-        elem.label = this.getLocalizedString(elem.label);
-        return elem;
-    }
-    translateContentItem(item) {
-        for (const key in item.displayValues) {
-            // istanbul ignore else
-            if (key)
-                item.displayValues[key] = this.translateContentItemDisplayValue(item.displayValues[key]);
-        }
-        for (const key in item.values) {
-            // istanbul ignore else
-            if (key)
-                item.values[key] = this.translateContentItemValue(item.values[key]);
-        }
-        this.translateLabelDefinition(item.label);
+        return {
+            ...elem,
+            label: this.getLocalizedString(elem.label),
+        };
     }
-    translateContentItemDisplayValue(value) {
-        // istanbul ignore else
-        if (typeof value === "string") {
-            value = this.getLocalizedString(value);
-        }
-        return value;
+    // warning: this function mutates the item
+    getLocalizedContentItem(item) {
+        item.label = this.getLocalizedLabelDefinition(item.label);
+        item.values = Object.entries(item.values).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {});
+        item.displayValues = Object.entries(item.displayValues).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {});
+        return item;
     }
-    translateContentItemValue(value) {
+    getLocalizedRawValue(value) {
         if (typeof value === "string") {
-            value = this.getLocalizedString(value);
+            return this.getLocalizedString(value);
         }
-        else if (Value_1.Value.isNavigationValue(value)) {
-            this.translateLabelDefinition(value.label);
+        if (Value_1.Value.isNavigationValue(value)) {
+            return {
+                ...value,
+                label: this.getLocalizedLabelDefinition(value.label),
+            };
         }
-        else if (Value_1.Value.isNestedContent(value)) {
-            for (const nestedValue of value) {
-                for (const key in nestedValue.values) {
-                    // istanbul ignore else
-                    if (key)
-                        nestedValue.values[key] = this.translateContentItemValue(nestedValue.values[key]);
-                }
-                for (const key in nestedValue.displayValues) {
-                    // istanbul ignore else
-                    if (key)
-                        nestedValue.displayValues[key] = this.translateContentItemDisplayValue(nestedValue.displayValues[key]);
-                }
-            }
+        if (Value_1.Value.isNestedContent(value)) {
+            return value.map((item) => ({
+                ...item,
+                values: Object.entries(item.values).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {}),
+                displayValues: Object.entries(item.displayValues).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {}),
+            }));
         }
         return value;
     }
-    translateContentDescriptorField(field) {
+    // warning: this function mutates the field
+    getLocalizedContentField(field) {
         field.label = this.getLocalizedString(field.label);
+        return field;
     }
-    translateContentDescriptorCategory(category) {
+    // warning: this function mutates the category
+    getLocalizedCategoryDescription(category) {
         category.label = this.getLocalizedString(category.label);
         category.description = this.getLocalizedString(category.description);
+        return category;
     }
-    translateNode(node) {
-        this.translateLabelDefinition(node.label);
-        // istanbul ignore else
-        if (node.description)
-            node.description = this.getLocalizedString(node.description);
-    }
-    translateLabelDefinition(labelDefinition) {
-        const translateComposite = (compositeValue) => {
-            compositeValue.values.map((value) => this.translateLabelDefinition(value));
+    getLocalizedNode(node) {
+        return {
+            ...node,
+            label: this.getLocalizedLabelDefinition(node.label),
+            ...(node.description ? { description: this.getLocalizedString(node.description) } : undefined),
         };
-        if (labelDefinition.typeName === LabelDefinition_1.LabelDefinition.COMPOSITE_DEFINITION_TYPENAME)
-            translateComposite(labelDefinition.rawValue);
-        else if (labelDefinition.typeName === "string") {
-            labelDefinition.rawValue = this.getLocalizedString(labelDefinition.rawValue);
-            labelDefinition.displayValue = this.getLocalizedString(labelDefinition.displayValue);
+    }
+    getLocalizedDisplayValue(value) {
+        if (typeof value === "undefined") {
+            return undefined;
+        }
+        if (typeof value === "string") {
+            return this.getLocalizedString(value);
+        }
+        if (Array.isArray(value)) {
+            return value.map((v) => this.getLocalizedDisplayValue(v));
         }
+        return Object.entries(value).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {});
     }
 }
 exports.LocalizationHelper = LocalizationHelper;

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

@@ -1 +1 @@
-{"version":3,"file":"LocalizationHelper.js","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,uDAAyE;AACzE,2CAAsD;AAKtD,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAOlD,gBAAgB;AAChB,MAAa,kBAAkB;IAG7B,YAAY,KAA8B;QACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACtD,CAAC;IAEM,kBAAkB,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACjG,CAAC;IAEM,iBAAiB,CAAC,KAAa;QACpC,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,2BAA2B,CAAC,eAAgC;QACjE,IAAI,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC;QAC/C,OAAO,eAAe,CAAC;IACzB,CAAC;IAEM,4BAA4B,CAAC,gBAAmC;QACrE,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC,CAAC;QAC9F,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEM,mBAAmB,CAAC,OAAgB;QACzC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;QACtE,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1F,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvG,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,6BAA6B,CAAC,IAAuB;QAC1D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB,CAAC,IAAU;QACrC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,aAAa,EAAE;YACpC,uBAAuB;YACvB,IAAI,GAAG;gBACL,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;SAC5F;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;YAC7B,uBAAuB;YACvB,IAAI,GAAG;gBACL,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;SACvE;QACD,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAEO,gCAAgC,CAAC,KAAmB;QAC1D,uBAAuB;QACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;SACxC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,yBAAyB,CAAC,KAAY;QAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;SACxC;aAAM,IAAI,aAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;YACzC,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC5C;aAAM,IAAI,aAAK,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE;YACvC,KAAK,MAAM,WAAW,IAAI,KAAK,EAAE;gBAC/B,KAAK,MAAM,GAAG,IAAI,WAAW,CAAC,MAAM,EAAE;oBACpC,uBAAuB;oBACvB,IAAI,GAAG;wBACL,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;iBACrF;gBACD,KAAK,MAAM,GAAG,IAAI,WAAW,CAAC,aAAa,EAAE;oBAC3C,uBAAuB;oBACvB,IAAI,GAAG;wBACL,WAAW,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,gCAAgC,CAAC,WAAW,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;iBAC1G;aACF;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,+BAA+B,CAAC,KAAY;QAClD,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAEO,kCAAkC,CAAC,QAA6B;QACtE,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzD,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACvE,CAAC;IAEO,aAAa,CAAC,IAAU;QAC9B,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,uBAAuB;QACvB,IAAI,IAAI,CAAC,WAAW;YAClB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACjE,CAAC;IAEO,wBAAwB,CAAC,eAAgC;QAC/D,MAAM,kBAAkB,GAAG,CAAC,cAAmC,EAAE,EAAE;YACjE,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7E,CAAC,CAAC;QAEF,IAAI,eAAe,CAAC,QAAQ,KAAK,iCAAe,CAAC,6BAA6B;YAC5E,kBAAkB,CAAC,eAAe,CAAC,QAA+B,CAAC,CAAC;aACjE,IAAI,eAAe,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAC9C,eAAe,CAAC,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,QAAkB,CAAC,CAAC;YACvF,eAAe,CAAC,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;SACtF;IACH,CAAC;CACF;AA/GD,gDA+GC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Core\n */\n\nimport { Node } from \"./hierarchy/Node\";\nimport { Content } from \"./content/Content\";\nimport { Item } from \"./content/Item\";\nimport { LabelCompositeValue, LabelDefinition } from \"./LabelDefinition\";\nimport { DisplayValue, Value } from \"./content/Value\";\nimport { Field } from \"./content/Fields\";\nimport { CategoryDescription } from \"./content/Category\";\nimport { ElementProperties } from \"./ElementProperties\";\n\nconst KEY_PATTERN = /@[\\w\\d\\-_]+:[\\w\\d\\-\\._]+?@/g;\n\n/** @internal */\nexport interface LocalizationHelperProps {\n  getLocalizedString: (key: string) => string;\n}\n\n/** @internal */\nexport class LocalizationHelper {\n  private _getLocalizedString: (key: string) => string;\n\n  constructor(props: LocalizationHelperProps) {\n    this._getLocalizedString = props.getLocalizedString;\n  }\n\n  public getLocalizedString(text: string) {\n    return text.replace(KEY_PATTERN, (key) => this._getLocalizedString(key.replace(/^@|@$/g, \"\")));\n  }\n\n  public getLocalizedNodes(nodes: Node[]): Node[] {\n    for (const node of nodes)\n      this.translateNode(node);\n    return nodes;\n  }\n\n  public getLocalizedLabelDefinition(labelDefinition: LabelDefinition): LabelDefinition {\n    this.translateLabelDefinition(labelDefinition);\n    return labelDefinition;\n  }\n\n  public getLocalizedLabelDefinitions(labelDefinitions: LabelDefinition[]) {\n    labelDefinitions.forEach((labelDefinition) => this.translateLabelDefinition(labelDefinition));\n    return labelDefinitions;\n  }\n\n  public getLocalizedContent(content: Content) {\n    content.contentSet.forEach((item) => this.translateContentItem(item));\n    content.descriptor.fields.forEach((field) => this.translateContentDescriptorField(field));\n    content.descriptor.categories.forEach((category) => this.translateContentDescriptorCategory(category));\n    return content;\n  }\n\n  public getLocalizedElementProperties(elem: ElementProperties) {\n    elem.label = this.getLocalizedString(elem.label);\n    return elem;\n  }\n\n  private translateContentItem(item: Item) {\n    for (const key in item.displayValues) {\n      // istanbul ignore else\n      if (key)\n        item.displayValues[key] = this.translateContentItemDisplayValue(item.displayValues[key]);\n    }\n    for (const key in item.values) {\n      // istanbul ignore else\n      if (key)\n        item.values[key] = this.translateContentItemValue(item.values[key]);\n    }\n    this.translateLabelDefinition(item.label);\n  }\n\n  private translateContentItemDisplayValue(value: DisplayValue): DisplayValue {\n    // istanbul ignore else\n    if (typeof value === \"string\") {\n      value = this.getLocalizedString(value);\n    }\n    return value;\n  }\n\n  private translateContentItemValue(value: Value): Value {\n    if (typeof value === \"string\") {\n      value = this.getLocalizedString(value);\n    } else if (Value.isNavigationValue(value)) {\n      this.translateLabelDefinition(value.label);\n    } else if (Value.isNestedContent(value)) {\n      for (const nestedValue of value) {\n        for (const key in nestedValue.values) {\n          // istanbul ignore else\n          if (key)\n            nestedValue.values[key] = this.translateContentItemValue(nestedValue.values[key]);\n        }\n        for (const key in nestedValue.displayValues) {\n          // istanbul ignore else\n          if (key)\n            nestedValue.displayValues[key] = this.translateContentItemDisplayValue(nestedValue.displayValues[key]);\n        }\n      }\n    }\n    return value;\n  }\n\n  private translateContentDescriptorField(field: Field) {\n    field.label = this.getLocalizedString(field.label);\n  }\n\n  private translateContentDescriptorCategory(category: CategoryDescription) {\n    category.label = this.getLocalizedString(category.label);\n    category.description = this.getLocalizedString(category.description);\n  }\n\n  private translateNode(node: Node) {\n    this.translateLabelDefinition(node.label);\n    // istanbul ignore else\n    if (node.description)\n      node.description = this.getLocalizedString(node.description);\n  }\n\n  private translateLabelDefinition(labelDefinition: LabelDefinition) {\n    const translateComposite = (compositeValue: LabelCompositeValue) => {\n      compositeValue.values.map((value) => this.translateLabelDefinition(value));\n    };\n\n    if (labelDefinition.typeName === LabelDefinition.COMPOSITE_DEFINITION_TYPENAME)\n      translateComposite(labelDefinition.rawValue as LabelCompositeValue);\n    else if (labelDefinition.typeName === \"string\") {\n      labelDefinition.rawValue = this.getLocalizedString(labelDefinition.rawValue as string);\n      labelDefinition.displayValue = this.getLocalizedString(labelDefinition.displayValue);\n    }\n  }\n}\n"]}
+{"version":3,"file":"LocalizationHelper.js","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAGH,+CAA4C;AAC5C,qDAAkD;AAGlD,2CAAyE;AAIzE,uDAAyE;AAEzE,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAOlD,gBAAgB;AAChB,MAAa,kBAAkB;IAG7B,YAAY,KAA8B;QACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACtD,CAAC;IAEM,kBAAkB,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACjG,CAAC;IAEM,iBAAiB,CAAC,KAAa;QACpC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IAEM,2BAA2B,CAAC,GAAoB;QACrD,OAAO;YACL,GAAG,GAAG;YACN,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC;YACrC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC;SACvE,CAAC;IACJ,CAAC;IAEM,6BAA6B,CAAC,KAAwB;QAC3D,OAAO;YACL,GAAG,KAAK;YACR,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,YAAY,CAAC;SAChE,CAAC;IACJ,CAAC;IAEM,2BAA2B,CAAC,eAAgC;QACjE,MAAM,qBAAqB,GAAG,CAAC,cAAmC,EAAE,EAAE,CAAC,CAAC;YACtE,GAAG,cAAc;YACjB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;SACtF,CAAC,CAAC;QAEH,IAAI,eAAe,CAAC,QAAQ,KAAK,iCAAe,CAAC,6BAA6B,EAAE;YAC9E,OAAO;gBACL,GAAG,eAAe;gBAClB,QAAQ,EAAE,qBAAqB,CAAC,eAAe,CAAC,QAA+B,CAAC;aACjF,CAAC;SACH;QACD,IAAI,eAAe,CAAC,QAAQ,KAAK,QAAQ,EAAE;YACzC,OAAO;gBACL,GAAG,eAAe;gBAClB,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,QAAkB,CAAC;gBACrE,YAAY,EAAE,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,YAAY,CAAC;aACpE,CAAC;SACH;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAEM,4BAA4B,CAAC,gBAAmC;QACrE,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,IAAI,CAAC,2BAA2B,CAAC,eAAe,CAAC,CAAC,CAAC;IACtG,CAAC;IAEM,6BAA6B,CAAC,UAAsB;QACzD,MAAM,KAAK,GAAG,IAAI,uBAAU,CAAC,UAAU,CAAC,CAAC;QACzC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;QACtE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,+BAA+B,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvF,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,wBAAwB,CAAC,KAAa;QAC3C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,CAAC;IAEM,mBAAmB,CAAC,OAAgB;QACzC,OAAO,IAAI,iBAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAChI,CAAC;IAEM,6BAA6B,CAAC,IAAuB;QAC1D,OAAO;YACL,GAAG,IAAI;YACP,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,0CAA0C;IAClC,uBAAuB,CAAC,IAAU;QACxC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACnH,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACrI,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB,CAAC,KAAY;QACvC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;SACvC;QACD,IAAI,aAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;YAClC,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,KAAK,CAAC;aACrD,CAAC;SACH;QACD,IAAI,aAAK,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE;YAChC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBAC1B,GAAG,IAAI;gBACP,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5G,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;aAC/H,CAAC,CAAC,CAAC;SACL;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,2CAA2C;IACnC,wBAAwB,CAAC,KAAY;QAC3C,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8CAA8C;IACtC,+BAA+B,CAAC,QAA6B;QACnE,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzD,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACrE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,gBAAgB,CAAC,IAAU;QACjC,OAAO;YACL,GAAG,IAAI;YACP,KAAK,EAAE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC;YACnD,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAC/F,CAAC;IACJ,CAAC;IAEO,wBAAwB,CAAC,KAAmB;QAClD,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;YAChC,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;SACvC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;SAC3D;QACD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5G,CAAC;CACF;AA3ID,gDA2IC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Core\n */\n\nimport { CategoryDescription } from \"./content/Category\";\nimport { Content } from \"./content/Content\";\nimport { Descriptor } from \"./content/Descriptor\";\nimport { Field } from \"./content/Fields\";\nimport { Item } from \"./content/Item\";\nimport { DisplayValue, DisplayValueGroup, Value } from \"./content/Value\";\nimport { ElementProperties } from \"./ElementProperties\";\nimport { Node } from \"./hierarchy/Node\";\nimport { NodePathElement } from \"./hierarchy/NodePathElement\";\nimport { LabelCompositeValue, LabelDefinition } from \"./LabelDefinition\";\n\nconst KEY_PATTERN = /@[\\w\\d\\-_]+:[\\w\\d\\-\\._]+?@/g;\n\n/** @internal */\nexport interface LocalizationHelperProps {\n  getLocalizedString: (key: string) => string;\n}\n\n/** @internal */\nexport class LocalizationHelper {\n  private _getLocalizedString: (key: string) => string;\n\n  constructor(props: LocalizationHelperProps) {\n    this._getLocalizedString = props.getLocalizedString;\n  }\n\n  public getLocalizedString(text: string) {\n    return text.replace(KEY_PATTERN, (key) => this._getLocalizedString(key.replace(/^@|@$/g, \"\")));\n  }\n\n  public getLocalizedNodes(nodes: Node[]): Node[] {\n    return nodes.map((n) => this.getLocalizedNode(n));\n  }\n\n  public getLocalizedNodePathElement(npe: NodePathElement): NodePathElement {\n    return {\n      ...npe,\n      node: this.getLocalizedNode(npe.node),\n      children: npe.children.map((c) => this.getLocalizedNodePathElement(c)),\n    };\n  }\n\n  public getLocalizedDisplayValueGroup(group: DisplayValueGroup): DisplayValueGroup {\n    return {\n      ...group,\n      displayValue: this.getLocalizedDisplayValue(group.displayValue),\n    };\n  }\n\n  public getLocalizedLabelDefinition(labelDefinition: LabelDefinition): LabelDefinition {\n    const getLocalizedComposite = (compositeValue: LabelCompositeValue) => ({\n      ...compositeValue,\n      values: compositeValue.values.map((value) => this.getLocalizedLabelDefinition(value)),\n    });\n\n    if (labelDefinition.typeName === LabelDefinition.COMPOSITE_DEFINITION_TYPENAME) {\n      return {\n        ...labelDefinition,\n        rawValue: getLocalizedComposite(labelDefinition.rawValue as LabelCompositeValue),\n      };\n    }\n    if (labelDefinition.typeName === \"string\") {\n      return {\n        ...labelDefinition,\n        rawValue: this.getLocalizedString(labelDefinition.rawValue as string),\n        displayValue: this.getLocalizedString(labelDefinition.displayValue),\n      };\n    }\n    return labelDefinition;\n  }\n\n  public getLocalizedLabelDefinitions(labelDefinitions: LabelDefinition[]) {\n    return labelDefinitions.map((labelDefinition) => this.getLocalizedLabelDefinition(labelDefinition));\n  }\n\n  public getLocalizedContentDescriptor(descriptor: Descriptor) {\n    const clone = new Descriptor(descriptor);\n    clone.fields.forEach((field) => this.getLocalizedContentField(field));\n    clone.categories.forEach((category) => this.getLocalizedCategoryDescription(category));\n    return clone;\n  }\n\n  public getLocalizedContentItems(items: Item[]): Item[] {\n    return items.map((item) => this.getLocalizedContentItem(item));\n  }\n\n  public getLocalizedContent(content: Content): Content {\n    return new Content(this.getLocalizedContentDescriptor(content.descriptor), this.getLocalizedContentItems(content.contentSet));\n  }\n\n  public getLocalizedElementProperties(elem: ElementProperties): ElementProperties {\n    return {\n      ...elem,\n      label: this.getLocalizedString(elem.label),\n    };\n  }\n\n  // warning: this function mutates the item\n  private getLocalizedContentItem(item: Item): Item {\n    item.label = this.getLocalizedLabelDefinition(item.label);\n    item.values = Object.entries(item.values).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {});\n    item.displayValues = Object.entries(item.displayValues).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {});\n    return item;\n  }\n\n  private getLocalizedRawValue(value: Value): Value {\n    if (typeof value === \"string\") {\n      return this.getLocalizedString(value);\n    }\n    if (Value.isNavigationValue(value)) {\n      return {\n        ...value,\n        label: this.getLocalizedLabelDefinition(value.label),\n      };\n    }\n    if (Value.isNestedContent(value)) {\n      return value.map((item) => ({\n        ...item,\n        values: Object.entries(item.values).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {}),\n        displayValues: Object.entries(item.displayValues).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {}),\n      }));\n    }\n    return value;\n  }\n\n  // warning: this function mutates the field\n  private getLocalizedContentField(field: Field) {\n    field.label = this.getLocalizedString(field.label);\n    return field;\n  }\n\n  // warning: this function mutates the category\n  private getLocalizedCategoryDescription(category: CategoryDescription) {\n    category.label = this.getLocalizedString(category.label);\n    category.description = this.getLocalizedString(category.description);\n    return category;\n  }\n\n  private getLocalizedNode(node: Node) {\n    return {\n      ...node,\n      label: this.getLocalizedLabelDefinition(node.label),\n      ...(node.description ? { description: this.getLocalizedString(node.description) } : undefined),\n    };\n  }\n\n  private getLocalizedDisplayValue(value: DisplayValue): DisplayValue {\n    if (typeof value === \"undefined\") {\n      return undefined;\n    }\n    if (typeof value === \"string\") {\n      return this.getLocalizedString(value);\n    }\n    if (Array.isArray(value)) {\n      return value.map((v) => this.getLocalizedDisplayValue(v));\n    }\n    return Object.entries(value).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {});\n  }\n}\n"]}

package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts

@@ -3,13 +3,15 @@
  */
 import { BeEvent, Id64String } from "@itwin/core-bentley";
 import { UnitSystemKey } from "@itwin/core-quantity";
-import { SelectionInfo } from "./content/Descriptor";
+import { Descriptor, SelectionInfo } from "./content/Descriptor";
 import { FieldDescriptor } from "./content/Fields";
 import { InstanceKey } from "./EC";
 import { InstanceFilterDefinition } from "./InstanceFilterDefinition";
 import { Ruleset } from "./rules/Ruleset";
 import { RulesetVariable } from "./RulesetVariables";
 import { SelectionScopeProps } from "./selection/SelectionScope";
+import { Item } from "./content/Item";
+import { ElementProperties } from "./ElementProperties";
 /**
  * A generic request options type used for both hierarchy and content requests.
  * @public
@@ -119,6 +121,11 @@ export interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVaria
      * @see [[DefaultContentDisplayTypes]]
      */
     displayType: string;
+    /**
+     * Content flags used for content customization.
+     * @see [[ContentFlags]]
+     */
+    contentFlags?: number;
     /** Input keys for getting the content */
     keys: TKeySet;
     /** Information about the selection event that was the cause of this content request */
@@ -155,8 +162,9 @@ export interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRu
 /**
  * Request type for element properties requests
  * @public
+ * @deprecated in 4.x. Use [[SingleElementPropertiesRequestOptions]] or [[MultiElementPropertiesRequestOptions]] directly.
  */
-export type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;
+export type ElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>;
 /**
  * Request type for single element properties requests.
  * @public
@@ -169,13 +177,25 @@ export interface SingleElementPropertiesRequestOptions<TIModel> extends RequestO
  * Request type for multiple elements properties requests.
  * @public
  */
-export interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
+export interface MultiElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> extends RequestOptions<TIModel> {
     /**
      * Classes of the elements to get properties for. If [[elementClasses]] is `undefined`, all classes
      * are used. Classes should be specified in one of these formats: "<schema name or alias>.<class_name>" or
      * "<schema name or alias>:<class_name>".
      */
     elementClasses?: string[];
+    /**
+     * Content parser that creates a result item based on given content descriptor and content item. Defaults
+     * to a parser that creates [[ElementProperties]] objects.
+     * @beta
+     */
+    contentParser?: (descriptor: Descriptor, item: Item) => TParsedContent;
+    /**
+     * The properties of multiple elements are going to be retrieved and returned in batches. Depending on the batch
+     * size load on CPU vs MEMORY load may vary, so changing this attribute allows to fine tune the performance.
+     * Defaults to `1000`.
+     */
+    batchSize?: number;
 }
 /**
  * Request type for content instance keys' requests.
@@ -268,7 +288,7 @@ export type Prioritized<TOptions extends {}> = TOptions & {
  * Checks if supplied request options are for single or multiple element properties.
  * @internal
  */
-export declare function isSingleElementPropertiesRequestOptions<TIModel>(options: ElementPropertiesRequestOptions<TIModel>): options is SingleElementPropertiesRequestOptions<TIModel>;
+export declare function isSingleElementPropertiesRequestOptions<TIModel, TParsedContent = any>(options: SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>): options is SingleElementPropertiesRequestOptions<TIModel>;
 /**
  * A wrapper type that injects cancelEvent into supplied type.
  * @public

package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PresentationManagerOptions.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/PresentationManagerOptions.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO;IACrC,kCAAkC;IAClC,MAAM,EAAE,OAAO,CAAC;IAEhB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAE3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IACrH,+DAA+D;IAC/D,WAAW,EAAE,OAAO,GAAG,MAAM,CAAC;IAE9B,oDAAoD;IACpD,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IAC1J,iDAAiD;IACjD,SAAS,CAAC,EAAE,QAAQ,CAAC;IAErB;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAE1C;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC,CAAC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACzK,oEAAoE;IACpE,SAAS,CAAC,EAAE,QAAQ,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,4CAA4C,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACrK,iEAAiE;IACjE,aAAa,EAAE,WAAW,EAAE,EAAE,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mCAAmC,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IAC5J,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IACpF,8GAA8G;IAC9G,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B,CAAC,OAAO,EAAE,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACjK;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,yCAAyC;IACzC,IAAI,EAAE,OAAO,CAAC;IACd,uFAAuF;IACvF,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACpK,8DAA8D;IAC9D,UAAU,EAAE,WAAW,CAAC;IACxB,yCAAyC;IACzC,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,KAAK,CAAC,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAClL,8DAA8D;IAC9D,UAAU,EAAE,WAAW,CAAC;IACxB,yCAAyC;IACzC,IAAI,EAAE,OAAO,CAAC;IACd,+DAA+D;IAC/D,eAAe,EAAE,eAAe,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,CAAC,OAAO,IAAI,qCAAqC,CAAC,OAAO,CAAC,GAAG,oCAAoC,CAAC,OAAO,CAAC,CAAC;AAEtJ;;;GAGG;AACH,MAAM,WAAW,qCAAqC,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IAC7F,+CAA+C;IAC/C,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oCAAoC,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IAC5F;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC,CAAC,OAAO,EAAE,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,KAAK,CAAC,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAC1K;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B,CAAC,OAAO,EAAE,YAAY,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IAChG,yCAAyC;IACzC,GAAG,EAAE,YAAY,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B,CAAC,OAAO,EAAE,YAAY,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IACjG,4CAA4C;IAC5C,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;CAAI;AAE1F;;;GAGG;AACH,MAAM,WAAW,8BAA8B,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IACtF,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AACD,gBAAgB;AAChB,wBAAgB,gCAAgC,CAAC,OAAO,EAAE,OAAO,EAAE,8BAA8B,CAAC,OAAO,CAAC,GAAG,4BAA4B,CAAC,OAAO,CAAC,GAAG,OAAO,IAAI,8BAA8B,CAAC,OAAO,CAAC,CAEtM;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IAC1J,IAAI,EAAE;QACJ,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;QAC/B,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC;KACvC,CAAC;IACF,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC9B,iBAAiB,CAAC,EAAE;QAClB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,KAAK,CAAC,QAAQ,SAAS,EAAE,IAAI,QAAQ,GAAG;IAClD,iCAAiC;IACjC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,EAAE,IAAI,QAAQ,GAAG;IACxD,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,uCAAuC,CAAC,OAAO,EAAE,OAAO,EAAE,+BAA+B,CAAC,OAAO,CAAC,GAAG,OAAO,IAAI,qCAAqC,CAAC,OAAO,CAAC,CAE7K;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,QAAQ,SAAS,EAAE,IAAI,QAAQ,GAAG;IAC5D,4DAA4D;IAC5D,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;CACnC,CAAC"}
+{"version":3,"file":"PresentationManagerOptions.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/PresentationManagerOptions.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO;IACrC,kCAAkC;IAClC,MAAM,EAAE,OAAO,CAAC;IAEhB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAE3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IACrH,+DAA+D;IAC/D,WAAW,EAAE,OAAO,GAAG,MAAM,CAAC;IAE9B,oDAAoD;IACpD,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IAC1J,iDAAiD;IACjD,SAAS,CAAC,EAAE,QAAQ,CAAC;IAErB;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAE1C;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC,CAAC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACzK,oEAAoE;IACpE,SAAS,CAAC,EAAE,QAAQ,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,4CAA4C,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACrK,iEAAiE;IACjE,aAAa,EAAE,WAAW,EAAE,EAAE,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mCAAmC,CAAC,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IAC5J,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IACpF,8GAA8G;IAC9G,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B,CAAC,OAAO,EAAE,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACjK;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,IAAI,EAAE,OAAO,CAAC;IACd,uFAAuF;IACvF,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACpK,8DAA8D;IAC9D,UAAU,EAAE,WAAW,CAAC;IACxB,yCAAyC;IACzC,IAAI,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,KAAK,CAAC,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAClL,8DAA8D;IAC9D,UAAU,EAAE,WAAW,CAAC;IACxB,yCAAyC;IACzC,IAAI,EAAE,OAAO,CAAC;IACd,+DAA+D;IAC/D,eAAe,EAAE,eAAe,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,MAAM,+BAA+B,CAAC,OAAO,EAAE,cAAc,GAAG,iBAAiB,IAAI,qCAAqC,CAAC,OAAO,CAAC,GAAG,oCAAoC,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;AAE1M;;;GAGG;AACH,MAAM,WAAW,qCAAqC,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IAC7F,+CAA+C;IAC/C,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oCAAoC,CAAC,OAAO,EAAE,cAAc,GAAG,iBAAiB,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IAChI;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,KAAK,cAAc,CAAC;IAEvE;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC,CAAC,OAAO,EAAE,OAAO,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,KAAK,CAAC,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAC1K;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B,CAAC,OAAO,EAAE,YAAY,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IAChG,yCAAyC;IACzC,GAAG,EAAE,YAAY,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B,CAAC,OAAO,EAAE,YAAY,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IACjG,4CAA4C;IAC5C,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;CAAI;AAE1F;;;GAGG;AACH,MAAM,WAAW,8BAA8B,CAAC,OAAO,CAAE,SAAQ,cAAc,CAAC,OAAO,CAAC;IACtF,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB,KAAK,EAAE,mBAAmB,CAAC;CAC5B;AACD,gBAAgB;AAChB,wBAAgB,gCAAgC,CAAC,OAAO,EAAE,OAAO,EAAE,8BAA8B,CAAC,OAAO,CAAC,GAAG,4BAA4B,CAAC,OAAO,CAAC,GAAG,OAAO,IAAI,8BAA8B,CAAC,OAAO,CAAC,CAEtM;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,OAAO,EAAE,QAAQ,EAAE,gBAAgB,GAAG,eAAe,CAAE,SAAQ,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC;IAC1J,IAAI,EAAE;QACJ,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;QAC/B,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAC;KACvC,CAAC;IACF,gBAAgB,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC9B,iBAAiB,CAAC,EAAE;QAClB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,KAAK,CAAC,QAAQ,SAAS,EAAE,IAAI,QAAQ,GAAG;IAClD,iCAAiC;IACjC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,EAAE,IAAI,QAAQ,GAAG;IACxD,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,uCAAuC,CAAC,OAAO,EAAE,cAAc,GAAG,GAAG,EAAE,OAAO,EAAE,qCAAqC,CAAC,OAAO,CAAC,GAAG,oCAAoC,CAAC,OAAO,EAAE,cAAc,CAAC,GAAG,OAAO,IAAI,qCAAqC,CAAC,OAAO,CAAC,CAEzQ;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,QAAQ,SAAS,EAAE,IAAI,QAAQ,GAAG;IAC5D,4DAA4D;IAC5D,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC;CACnC,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"PresentationManagerOptions.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationManagerOptions.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqPH,gBAAgB;AAChB,SAAgB,gCAAgC,CAAU,OAAwF;IAChJ,OAAO,CAAC,CAAE,OAAmD,CAAC,UAAU,CAAC;AAC3E,CAAC;AAFD,4EAEC;AAgDD;;;GAGG;AACH,SAAgB,uCAAuC,CAAU,OAAiD;IAChH,OAAQ,OAA0D,CAAC,SAAS,KAAK,SAAS,CAAC;AAC7F,CAAC;AAFD,0FAEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Core\n */\n\nimport { BeEvent, Id64String } from \"@itwin/core-bentley\";\nimport { UnitSystemKey } from \"@itwin/core-quantity\";\nimport { SelectionInfo } from \"./content/Descriptor\";\nimport { FieldDescriptor } from \"./content/Fields\";\nimport { InstanceKey } from \"./EC\";\nimport { InstanceFilterDefinition } from \"./InstanceFilterDefinition\";\nimport { Ruleset } from \"./rules/Ruleset\";\nimport { RulesetVariable } from \"./RulesetVariables\";\nimport { SelectionScopeProps } from \"./selection/SelectionScope\";\n\n/**\n * A generic request options type used for both hierarchy and content requests.\n * @public\n */\nexport interface RequestOptions<TIModel> {\n  /** iModel to request data from */\n  imodel: TIModel;\n\n  /** Optional locale to use when formatting / localizing data */\n  locale?: string;\n\n  /**\n   * Unit system to use when formatting property values with units. Default presentation\n   * unit is used if unit system is not specified.\n   */\n  unitSystem?: UnitSystemKey;\n\n  /**\n   * Expected form of response. This property is set automatically on newer frontends.\n   * `unparsed-json` — deliver response from native addon without parsing it.\n   * @internal\n   */\n  transport?: \"unparsed-json\";\n}\n\n/**\n * Options for requests that require presentation ruleset. Not\n * meant to be used directly, see one of the subclasses.\n *\n * @public\n */\nexport interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptions<TIModel> {\n  /** Ruleset or id of the ruleset to use when requesting data */\n  rulesetOrId: Ruleset | string;\n\n  /** Ruleset variables to use when requesting data */\n  rulesetVariables?: TRulesetVariable[];\n}\n\n/**\n * Request type for hierarchy requests.\n * @public\n */\nexport interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Key of the parent node to get children for */\n  parentKey?: TNodeKey;\n\n  /**\n   * An instance filter that should be applied for this hierarchy level.\n   *\n   * **Note:** May only be used on hierarchy levels that support filtering - check [[NavNode.supportsFiltering]] before\n   * requesting filtered children.\n   *\n   * @beta\n   */\n  instanceFilter?: InstanceFilterDefinition;\n\n  /**\n   * A limit to how many instances at most should be loaded for a hierarchy level. If the limit is exceeded,\n   * the request fails with [[PresentationError]] having [[PresentationStatus.ResultSetTooLarge]] error number.\n   *\n   * Specifying the limit is useful when creating unlimited size result sets is not meaningful - this allows the library\n   * to return early as soon as the limit is reached, instead of creating a very large result that's possibly too large to\n   * be useful to be displayed to end users.\n   *\n   * @see [Hierarchies' filtering and limiting]($docs/presentation/hierarchies/FilteringLimiting.md)\n   * @beta\n   */\n  sizeLimit?: number;\n}\n\n/**\n * Params for hierarchy level descriptor requests.\n * @beta\n */\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Key of the parent node to get hierarchy level descriptor for. */\n  parentKey?: TNodeKey;\n}\n\n/**\n * Request type of filtering hierarchies by given ECInstance paths.\n * @public\n */\nexport interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** A list of paths from root ECInstance to target ECInstance. */\n  instancePaths: InstanceKey[][];\n\n  /**\n   * An optional index (`0 <= markedIndex < instancePaths.length`) to mark one of the instance paths. The\n   * path is marked using `NodePathElement.isMarked` flag in the result.\n   */\n  markedIndex?: number;\n}\n\n/**\n * Request type of filtering hierarchies by given text.\n * @public\n */\nexport interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Text to filter the hierarchy by. */\n  filterText: string;\n}\n\n/**\n * Request type for content sources requests.\n * @public\n */\nexport interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /** Full names of classes to get content sources for. Format for a full class name: `SchemaName:ClassName`. */\n  classes: string[];\n}\n\n/**\n * Request type for content descriptor requests.\n * @public\n */\nexport interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /**\n   * Content display type.\n   * @see [[DefaultContentDisplayTypes]]\n   */\n  displayType: string;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n  /** Information about the selection event that was the cause of this content request */\n  selection?: SelectionInfo;\n}\n\n/**\n * Request type for content requests.\n * @public\n */\nexport interface ContentRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Content descriptor for customizing the returned content */\n  descriptor: TDescriptor;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n  /**\n   * Flag that specifies whether value formatting should be emitted or not.\n   * Content is returned without `displayValues` when this is set to `true`.\n   * @alpha\n   */\n  omitFormattedValues?: boolean;\n}\n\n/**\n * Request type for distinct values' requests.\n * @public\n */\nexport interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {\n  /** Content descriptor for customizing the returned content */\n  descriptor: TDescriptor;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n  /** Descriptor for a field distinct values are requested for */\n  fieldDescriptor: FieldDescriptor;\n}\n\n/**\n * Request type for element properties requests\n * @public\n */\nexport type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;\n\n/**\n * Request type for single element properties requests.\n * @public\n */\nexport interface SingleElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /** ID of the element to get properties for. */\n  elementId: Id64String;\n}\n\n/**\n * Request type for multiple elements properties requests.\n * @public\n */\nexport interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /**\n   * Classes of the elements to get properties for. If [[elementClasses]] is `undefined`, all classes\n   * are used. Classes should be specified in one of these formats: \"<schema name or alias>.<class_name>\" or\n   * \"<schema name or alias>:<class_name>\".\n   */\n  elementClasses?: string[];\n}\n\n/**\n * Request type for content instance keys' requests.\n * @public\n */\nexport interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {\n  /**\n   * Content display type.\n   * @see [[DefaultContentDisplayTypes]]\n   */\n  displayType?: string;\n  /** Input keys for getting the content. */\n  keys: TKeySet;\n}\n\n/**\n * Request type for label requests\n * @public\n */\nexport interface DisplayLabelRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {\n  /** Key of ECInstance to get label for */\n  key: TInstanceKey;\n}\n\n/**\n * Request type for labels requests\n * @public\n */\nexport interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {\n  /** Keys of ECInstances to get labels for */\n  keys: TInstanceKey[];\n}\n\n/**\n * Request options used for selection scope related requests\n * @public\n */\nexport interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> { } // eslint-disable-line @typescript-eslint/no-empty-interface\n\n/**\n * Request options used for calculating selection based on given instance keys and selection scope.\n * @public\n */\nexport interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  elementIds: Id64String[];\n  scope: SelectionScopeProps;\n}\n/** @internal */\nexport function isComputeSelectionRequestOptions<TIModel>(options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>): options is ComputeSelectionRequestOptions<TIModel> {\n  return !!(options as ComputeSelectionRequestOptions<TIModel>).elementIds;\n}\n\n/**\n * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.\n * @public\n */\nexport interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  prev: {\n    rulesetOrId?: Ruleset | string;\n    rulesetVariables?: TRulesetVariable[];\n  };\n  expandedNodeKeys?: TNodeKey[];\n  continuationToken?: {\n    prevHierarchyNode: string;\n    currHierarchyNode: string;\n  };\n  resultSetSize?: number;\n}\n\n/**\n * Paging options\n * @public\n */\nexport interface PageOptions {\n  /** Inclusive start 0-based index of the page */\n  start?: number;\n  /** Maximum size of the page */\n  size?: number;\n}\n\n/**\n * A wrapper type that injects [[PageOptions]] into supplied type\n * @public\n */\nexport type Paged<TOptions extends {}> = TOptions & {\n  /** Optional paging parameters */\n  paging?: PageOptions;\n};\n\n/**\n * A wrapper type that injects priority into supplied type.\n * @public\n */\nexport type Prioritized<TOptions extends {}> = TOptions & {\n  /** Optional priority */\n  priority?: number;\n};\n\n/**\n * Checks if supplied request options are for single or multiple element properties.\n * @internal\n */\nexport function isSingleElementPropertiesRequestOptions<TIModel>(options: ElementPropertiesRequestOptions<TIModel>): options is SingleElementPropertiesRequestOptions<TIModel> {\n  return (options as SingleElementPropertiesRequestOptions<TIModel>).elementId !== undefined;\n}\n\n/**\n * A wrapper type that injects cancelEvent into supplied type.\n * @public\n */\nexport type WithCancelEvent<TOptions extends {}> = TOptions & {\n  /** Event which is triggered when the request is canceled */\n  cancelEvent?: BeEvent<() => void>;\n};\n"]}
+{"version":3,"file":"PresentationManagerOptions.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationManagerOptions.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA2QH,gBAAgB;AAChB,SAAgB,gCAAgC,CAAU,OAAwF;IAChJ,OAAO,CAAC,CAAE,OAAmD,CAAC,UAAU,CAAC;AAC3E,CAAC;AAFD,4EAEC;AAgDD;;;GAGG;AACH,SAAgB,uCAAuC,CAAgC,OAAuH;IAC5M,OAAQ,OAA0D,CAAC,SAAS,KAAK,SAAS,CAAC;AAC7F,CAAC;AAFD,0FAEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Core\n */\n\nimport { BeEvent, Id64String } from \"@itwin/core-bentley\";\nimport { UnitSystemKey } from \"@itwin/core-quantity\";\nimport { Descriptor, SelectionInfo } from \"./content/Descriptor\";\nimport { FieldDescriptor } from \"./content/Fields\";\nimport { InstanceKey } from \"./EC\";\nimport { InstanceFilterDefinition } from \"./InstanceFilterDefinition\";\nimport { Ruleset } from \"./rules/Ruleset\";\nimport { RulesetVariable } from \"./RulesetVariables\";\nimport { SelectionScopeProps } from \"./selection/SelectionScope\";\nimport { Item } from \"./content/Item\";\nimport { ElementProperties } from \"./ElementProperties\";\n\n/**\n * A generic request options type used for both hierarchy and content requests.\n * @public\n */\nexport interface RequestOptions<TIModel> {\n  /** iModel to request data from */\n  imodel: TIModel;\n\n  /** Optional locale to use when formatting / localizing data */\n  locale?: string;\n\n  /**\n   * Unit system to use when formatting property values with units. Default presentation\n   * unit is used if unit system is not specified.\n   */\n  unitSystem?: UnitSystemKey;\n\n  /**\n   * Expected form of response. This property is set automatically on newer frontends.\n   * `unparsed-json` — deliver response from native addon without parsing it.\n   * @internal\n   */\n  transport?: \"unparsed-json\";\n}\n\n/**\n * Options for requests that require presentation ruleset. Not\n * meant to be used directly, see one of the subclasses.\n *\n * @public\n */\nexport interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptions<TIModel> {\n  /** Ruleset or id of the ruleset to use when requesting data */\n  rulesetOrId: Ruleset | string;\n\n  /** Ruleset variables to use when requesting data */\n  rulesetVariables?: TRulesetVariable[];\n}\n\n/**\n * Request type for hierarchy requests.\n * @public\n */\nexport interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Key of the parent node to get children for */\n  parentKey?: TNodeKey;\n\n  /**\n   * An instance filter that should be applied for this hierarchy level.\n   *\n   * **Note:** May only be used on hierarchy levels that support filtering - check [[NavNode.supportsFiltering]] before\n   * requesting filtered children.\n   *\n   * @beta\n   */\n  instanceFilter?: InstanceFilterDefinition;\n\n  /**\n   * A limit to how many instances at most should be loaded for a hierarchy level. If the limit is exceeded,\n   * the request fails with [[PresentationError]] having [[PresentationStatus.ResultSetTooLarge]] error number.\n   *\n   * Specifying the limit is useful when creating unlimited size result sets is not meaningful - this allows the library\n   * to return early as soon as the limit is reached, instead of creating a very large result that's possibly too large to\n   * be useful to be displayed to end users.\n   *\n   * @see [Hierarchies' filtering and limiting]($docs/presentation/hierarchies/FilteringLimiting.md)\n   * @beta\n   */\n  sizeLimit?: number;\n}\n\n/**\n * Params for hierarchy level descriptor requests.\n * @beta\n */\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Key of the parent node to get hierarchy level descriptor for. */\n  parentKey?: TNodeKey;\n}\n\n/**\n * Request type of filtering hierarchies by given ECInstance paths.\n * @public\n */\nexport interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** A list of paths from root ECInstance to target ECInstance. */\n  instancePaths: InstanceKey[][];\n\n  /**\n   * An optional index (`0 <= markedIndex < instancePaths.length`) to mark one of the instance paths. The\n   * path is marked using `NodePathElement.isMarked` flag in the result.\n   */\n  markedIndex?: number;\n}\n\n/**\n * Request type of filtering hierarchies by given text.\n * @public\n */\nexport interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Text to filter the hierarchy by. */\n  filterText: string;\n}\n\n/**\n * Request type for content sources requests.\n * @public\n */\nexport interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /** Full names of classes to get content sources for. Format for a full class name: `SchemaName:ClassName`. */\n  classes: string[];\n}\n\n/**\n * Request type for content descriptor requests.\n * @public\n */\nexport interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /**\n   * Content display type.\n   * @see [[DefaultContentDisplayTypes]]\n   */\n  displayType: string;\n  /**\n   * Content flags used for content customization.\n   * @see [[ContentFlags]]\n   */\n  contentFlags?: number;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n  /** Information about the selection event that was the cause of this content request */\n  selection?: SelectionInfo;\n}\n\n/**\n * Request type for content requests.\n * @public\n */\nexport interface ContentRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Content descriptor for customizing the returned content */\n  descriptor: TDescriptor;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n  /**\n   * Flag that specifies whether value formatting should be emitted or not.\n   * Content is returned without `displayValues` when this is set to `true`.\n   * @alpha\n   */\n  omitFormattedValues?: boolean;\n}\n\n/**\n * Request type for distinct values' requests.\n * @public\n */\nexport interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {\n  /** Content descriptor for customizing the returned content */\n  descriptor: TDescriptor;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n  /** Descriptor for a field distinct values are requested for */\n  fieldDescriptor: FieldDescriptor;\n}\n\n/**\n * Request type for element properties requests\n * @public\n * @deprecated in 4.x. Use [[SingleElementPropertiesRequestOptions]] or [[MultiElementPropertiesRequestOptions]] directly.\n */\nexport type ElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>;\n\n/**\n * Request type for single element properties requests.\n * @public\n */\nexport interface SingleElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /** ID of the element to get properties for. */\n  elementId: Id64String;\n}\n\n/**\n * Request type for multiple elements properties requests.\n * @public\n */\nexport interface MultiElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> extends RequestOptions<TIModel> {\n  /**\n   * Classes of the elements to get properties for. If [[elementClasses]] is `undefined`, all classes\n   * are used. Classes should be specified in one of these formats: \"<schema name or alias>.<class_name>\" or\n   * \"<schema name or alias>:<class_name>\".\n   */\n  elementClasses?: string[];\n\n  /**\n   * Content parser that creates a result item based on given content descriptor and content item. Defaults\n   * to a parser that creates [[ElementProperties]] objects.\n   * @beta\n   */\n  contentParser?: (descriptor: Descriptor, item: Item) => TParsedContent;\n\n  /**\n   * The properties of multiple elements are going to be retrieved and returned in batches. Depending on the batch\n   * size load on CPU vs MEMORY load may vary, so changing this attribute allows to fine tune the performance.\n   * Defaults to `1000`.\n   */\n  batchSize?: number;\n}\n\n/**\n * Request type for content instance keys' requests.\n * @public\n */\nexport interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {\n  /**\n   * Content display type.\n   * @see [[DefaultContentDisplayTypes]]\n   */\n  displayType?: string;\n  /** Input keys for getting the content. */\n  keys: TKeySet;\n}\n\n/**\n * Request type for label requests\n * @public\n */\nexport interface DisplayLabelRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {\n  /** Key of ECInstance to get label for */\n  key: TInstanceKey;\n}\n\n/**\n * Request type for labels requests\n * @public\n */\nexport interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {\n  /** Keys of ECInstances to get labels for */\n  keys: TInstanceKey[];\n}\n\n/**\n * Request options used for selection scope related requests\n * @public\n */\nexport interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> { } // eslint-disable-line @typescript-eslint/no-empty-interface\n\n/**\n * Request options used for calculating selection based on given instance keys and selection scope.\n * @public\n */\nexport interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  elementIds: Id64String[];\n  scope: SelectionScopeProps;\n}\n/** @internal */\nexport function isComputeSelectionRequestOptions<TIModel>(options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>): options is ComputeSelectionRequestOptions<TIModel> {\n  return !!(options as ComputeSelectionRequestOptions<TIModel>).elementIds;\n}\n\n/**\n * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.\n * @public\n */\nexport interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  prev: {\n    rulesetOrId?: Ruleset | string;\n    rulesetVariables?: TRulesetVariable[];\n  };\n  expandedNodeKeys?: TNodeKey[];\n  continuationToken?: {\n    prevHierarchyNode: string;\n    currHierarchyNode: string;\n  };\n  resultSetSize?: number;\n}\n\n/**\n * Paging options\n * @public\n */\nexport interface PageOptions {\n  /** Inclusive start 0-based index of the page */\n  start?: number;\n  /** Maximum size of the page */\n  size?: number;\n}\n\n/**\n * A wrapper type that injects [[PageOptions]] into supplied type\n * @public\n */\nexport type Paged<TOptions extends {}> = TOptions & {\n  /** Optional paging parameters */\n  paging?: PageOptions;\n};\n\n/**\n * A wrapper type that injects priority into supplied type.\n * @public\n */\nexport type Prioritized<TOptions extends {}> = TOptions & {\n  /** Optional priority */\n  priority?: number;\n};\n\n/**\n * Checks if supplied request options are for single or multiple element properties.\n * @internal\n */\nexport function isSingleElementPropertiesRequestOptions<TIModel, TParsedContent = any>(options: SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>): options is SingleElementPropertiesRequestOptions<TIModel> {\n  return (options as SingleElementPropertiesRequestOptions<TIModel>).elementId !== undefined;\n}\n\n/**\n * A wrapper type that injects cancelEvent into supplied type.\n * @public\n */\nexport type WithCancelEvent<TOptions extends {}> = TOptions & {\n  /** Event which is triggered when the request is canceled */\n  cancelEvent?: BeEvent<() => void>;\n};\n"]}

package/lib/cjs/presentation-common/content/Item.d.ts

@@ -82,5 +82,18 @@ export declare class Item {
      * @internal
      */
     static reviver(key: string, value: any): any;
+    /**
+     * Deserialize items list from JSON
+     * @param json JSON or JSON serialized to string to deserialize from
+     * @returns Deserialized items list
+     * @internal
+     */
+    static listFromJSON(json: ItemJSON[] | string): Item[];
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing [[Item]][] objects.
+     * @internal
+     */
+    static listReviver(key: string, value: any): any;
 }
 //# sourceMappingURL=Item.d.ts.map

package/lib/cjs/presentation-common/content/Item.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Item.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/content/Item.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAwB,KAAK,EAAE,SAAS,EAAiB,MAAM,SAAS,CAAC;AAEhH;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;IAC1B,WAAW,EAAE,WAAW,EAAE,CAAC;IAG3B,eAAe,EAAE,mBAAmB,CAAC;IACrC,gKAAgK;IAChK,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAEpC,aAAa,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;IAClD,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACvC;AAED;;;GAGG;AACH,qBAAa,IAAI;IACf;;;OAGG;IACI,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;IACjC,6DAA6D;IACtD,WAAW,EAAE,WAAW,EAAE,CAAC;IAClC,gCAAgC;IACzB,KAAK,EAAE,eAAe,CAAC;IAC9B;;;OAGG;IACI,OAAO,EAAE,MAAM,CAAC;IACvB,+FAA+F;IACxF,SAAS,CAAC,EAAE,SAAS,CAAC;IAC7B,4BAA4B;IACrB,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACvC,gCAAgC;IACzB,aAAa,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACrD,+HAA+H;IACxH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAClC,oDAAoD;IAC7C,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE7C;;;;;;;;;;OAUG;gBACgB,WAAW,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,GAAG,SAAS,EAC/H,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,gBAAgB,CAAC,YAAY,CAAC,EAAE,gBAAgB,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAWnJ;;OAEG;IACI,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAIhD,oCAAoC;IAC7B,MAAM,IAAI,QAAQ;IAazB,qCAAqC;WACvB,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,SAAS;IAiB7E;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG;CAGpD"}
+{"version":3,"file":"Item.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/content/Item.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAwB,KAAK,EAAE,SAAS,EAAiB,MAAM,SAAS,CAAC;AAEhH;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;IAC1B,WAAW,EAAE,WAAW,EAAE,CAAC;IAG3B,eAAe,EAAE,mBAAmB,CAAC;IACrC,gKAAgK;IAChK,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAEpC,aAAa,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;IAClD,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACvC;AAED;;;GAGG;AACH,qBAAa,IAAI;IACf;;;OAGG;IACI,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;IACjC,6DAA6D;IACtD,WAAW,EAAE,WAAW,EAAE,CAAC;IAClC,gCAAgC;IACzB,KAAK,EAAE,eAAe,CAAC;IAC9B;;;OAGG;IACI,OAAO,EAAE,MAAM,CAAC;IACvB,+FAA+F;IACxF,SAAS,CAAC,EAAE,SAAS,CAAC;IAC7B,4BAA4B;IACrB,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACvC,gCAAgC;IACzB,aAAa,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACrD,+HAA+H;IACxH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAClC,oDAAoD;IAC7C,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE7C;;;;;;;;;;OAUG;gBACgB,WAAW,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,GAAG,SAAS,EAC/H,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,gBAAgB,CAAC,YAAY,CAAC,EAAE,gBAAgB,EAAE,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAWnJ;;OAEG;IACI,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAIhD,oCAAoC;IAC7B,MAAM,IAAI,QAAQ;IAazB,qCAAqC;WACvB,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,SAAS;IAiB7E;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG;IAInD;;;;;OAKG;WACW,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,GAAG,IAAI,EAAE;IAS7D;;;;OAIG;WACW,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,GAAG;CAGxD"}

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

@@ -80,6 +80,28 @@ class Item {
     static reviver(key, value) {
         return key === "" ? Item.fromJSON(value) : value;
     }
+    /**
+     * Deserialize items list from JSON
+     * @param json JSON or JSON serialized to string to deserialize from
+     * @returns Deserialized items list
+     * @internal
+     */
+    static listFromJSON(json) {
+        if (typeof json === "string") {
+            // eslint-disable-next-line @typescript-eslint/unbound-method
+            return JSON.parse(json, Item.listReviver);
+        }
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        return json.map(Item.fromJSON).filter((item) => !!item);
+    }
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing [[Item]][] objects.
+     * @internal
+     */
+    static listReviver(key, value) {
+        return key === "" ? Item.listFromJSON(value) : value;
+    }
 }
 exports.Item = Item;
 //# sourceMappingURL=Item.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Item.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Item.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAA0E;AAE1E,mCAAgH;AAuBhH;;;GAGG;AACH,MAAa,IAAI;IA0Bf;;;;;;;;;;OAUG;IACH,YAAmB,WAA0B,EAAE,KAA+B,EAAE,OAAe,EAAE,SAAgC,EAC/H,MAA+B,EAAE,aAA6C,EAAE,gBAA0B,EAAE,YAAqC;QACjJ,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,8CAA8C;QACtE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,iCAAe,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,SAAiB;QACpC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;IAED,oCAAoC;IAC7B,MAAM;QACX,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO;YACL,GAAG,QAAQ;YACX,mDAAmD;YACnD,MAAM,EAAE,aAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAkB;YAClD,mDAAmD;YACnD,aAAa,EAAE,oBAAY,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAyB;YAC9E,mDAAmD;YACnD,eAAe,EAAE,iCAAe,CAAC,MAAM,CAAC,KAAK,CAAC;SAC/C,CAAC;IACJ,CAAC;IAED,qCAAqC;IAC9B,MAAM,CAAC,QAAQ,CAAC,IAAmC;QACxD,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QACnB,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACpE,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE;YACnC,mDAAmD;YACnD,MAAM,EAAE,aAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;YACnC,mDAAmD;YACnD,aAAa,EAAE,oBAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;YACxD,mDAAmD;YACnD,KAAK,EAAE,iCAAe,CAAC,QAAQ,CAAC,eAAe,CAAC;SAChC,CAAC,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,KAAU;QAC3C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACnD,CAAC;CACF;AAhGD,oBAgGC","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 { ClassInfo, InstanceKey } from \"../EC\";\nimport { LabelDefinition, LabelDefinitionJSON } from \"../LabelDefinition\";\nimport { ValuesDictionary } from \"../Utils\";\nimport { DisplayValue, DisplayValueJSON, DisplayValuesMapJSON, Value, ValueJSON, ValuesMapJSON } from \"./Value\";\n\n/**\n * Serialized [[Item]] JSON representation.\n * @public\n */\nexport interface ItemJSON {\n  inputKeys?: InstanceKey[];\n  primaryKeys: InstanceKey[];\n  // TODO: rename to `label`\n  // eslint-disable-next-line deprecation/deprecation\n  labelDefinition: LabelDefinitionJSON;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  imageId: string;\n  classInfo?: ClassInfo;\n  // eslint-disable-next-line deprecation/deprecation\n  values: ValuesDictionary<ValueJSON>;\n  // eslint-disable-next-line deprecation/deprecation\n  displayValues: ValuesDictionary<DisplayValueJSON>;\n  mergedFieldNames: string[];\n  extendedData?: { [key: string]: any };\n}\n\n/**\n * A data structure that represents a single content record.\n * @public\n */\nexport class Item {\n  /**\n   * Keys of input instances that caused this item to be included in content. Only set if the content is\n   * created with [[ContentFlags.IncludeInputKeys]] flag.\n   */\n  public inputKeys?: InstanceKey[];\n  /** Keys of instances whose data is contained in this item */\n  public primaryKeys: InstanceKey[];\n  /** Display label of the item */\n  public label: LabelDefinition;\n  /**\n   * ID of the image associated with this item\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  public imageId: string;\n  /** For cases when item consists only of same class instances, information about the ECClass */\n  public classInfo?: ClassInfo;\n  /** Raw values dictionary */\n  public values: ValuesDictionary<Value>;\n  /** Display values dictionary */\n  public displayValues: ValuesDictionary<DisplayValue>;\n  /** List of field names whose values are merged (see [Merging values]($docs/presentation/content/Terminology#value-merging)) */\n  public mergedFieldNames: string[];\n  /** Extended data injected into this content item */\n  public extendedData?: { [key: string]: any };\n\n  /**\n   * Creates an instance of Item.\n   * @param primaryKeys Keys of instances whose data is contained in this item\n   * @param label Display label of the item\n   * @param imageId ID of the image associated with this item\n   * @param classInfo For cases when item consists only of same class instances, information about the ECClass\n   * @param values Raw values dictionary\n   * @param displayValues Display values dictionary\n   * @param mergedFieldNames List of field names whose values are merged (see [Merging values]($docs/presentation/content/Terminology#value-merging))\n   * @param extendedData Extended data injected into this content item\n   */\n  public constructor(primaryKeys: InstanceKey[], label: string | LabelDefinition, imageId: string, classInfo: ClassInfo | undefined,\n    values: ValuesDictionary<Value>, displayValues: ValuesDictionary<DisplayValue>, mergedFieldNames: string[], extendedData?: { [key: string]: any }) {\n    this.primaryKeys = primaryKeys;\n    this.imageId = imageId; // eslint-disable-line deprecation/deprecation\n    this.classInfo = classInfo;\n    this.values = values;\n    this.displayValues = displayValues;\n    this.mergedFieldNames = mergedFieldNames;\n    this.extendedData = extendedData;\n    this.label = (typeof label === \"string\") ? LabelDefinition.fromLabelString(label) : label;\n  }\n\n  /**\n   * Is value of field with the specified name merged in this record.\n   */\n  public isFieldMerged(fieldName: string): boolean {\n    return -1 !== this.mergedFieldNames.indexOf(fieldName);\n  }\n\n  /** Serialize this object to JSON */\n  public toJSON(): ItemJSON {\n    const { label, ...baseItem } = this;\n    return {\n      ...baseItem,\n      // eslint-disable-next-line deprecation/deprecation\n      values: Value.toJSON(this.values) as ValuesMapJSON,\n      // eslint-disable-next-line deprecation/deprecation\n      displayValues: DisplayValue.toJSON(this.displayValues) as DisplayValuesMapJSON,\n      // eslint-disable-next-line deprecation/deprecation\n      labelDefinition: LabelDefinition.toJSON(label),\n    };\n  }\n\n  /** Deserialize [[Item]] from JSON */\n  public static fromJSON(json: ItemJSON | string | undefined): Item | undefined {\n    if (!json)\n      return undefined;\n    if (typeof json === \"string\")\n      return JSON.parse(json, (key, value) => Item.reviver(key, value));\n    const item = Object.create(Item.prototype);\n    const { labelDefinition, ...baseJson } = json;\n    return Object.assign(item, baseJson, {\n      // eslint-disable-next-line deprecation/deprecation\n      values: Value.fromJSON(json.values),\n      // eslint-disable-next-line deprecation/deprecation\n      displayValues: DisplayValue.fromJSON(json.displayValues),\n      // eslint-disable-next-line deprecation/deprecation\n      label: LabelDefinition.fromJSON(labelDefinition),\n    } as Partial<Item>);\n  }\n\n  /**\n   * Reviver function that can be used as a second argument for\n   * `JSON.parse` method when parsing Item objects.\n   * @internal\n   */\n  public static reviver(key: string, value: any): any {\n    return key === \"\" ? Item.fromJSON(value) : value;\n  }\n}\n"]}
+{"version":3,"file":"Item.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Item.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAA0E;AAE1E,mCAAgH;AAuBhH;;;GAGG;AACH,MAAa,IAAI;IA0Bf;;;;;;;;;;OAUG;IACH,YAAmB,WAA0B,EAAE,KAA+B,EAAE,OAAe,EAAE,SAAgC,EAC/H,MAA+B,EAAE,aAA6C,EAAE,gBAA0B,EAAE,YAAqC;QACjJ,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,8CAA8C;QACtE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,iCAAe,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,SAAiB;QACpC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;IAED,oCAAoC;IAC7B,MAAM;QACX,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO;YACL,GAAG,QAAQ;YACX,mDAAmD;YACnD,MAAM,EAAE,aAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAkB;YAClD,mDAAmD;YACnD,aAAa,EAAE,oBAAY,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAyB;YAC9E,mDAAmD;YACnD,eAAe,EAAE,iCAAe,CAAC,MAAM,CAAC,KAAK,CAAC;SAC/C,CAAC;IACJ,CAAC;IAED,qCAAqC;IAC9B,MAAM,CAAC,QAAQ,CAAC,IAAmC;QACxD,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QACnB,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACpE,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE;YACnC,mDAAmD;YACnD,MAAM,EAAE,aAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;YACnC,mDAAmD;YACnD,aAAa,EAAE,oBAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;YACxD,mDAAmD;YACnD,KAAK,EAAE,iCAAe,CAAC,QAAQ,CAAC,eAAe,CAAC;SAChC,CAAC,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,KAAU;QAC3C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,IAAyB;QAClD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,6DAA6D;YAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SAC3C;QACD,6DAA6D;QAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAgB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,GAAW,EAAE,KAAU;QAC/C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACvD,CAAC;CACF;AAxHD,oBAwHC","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 { ClassInfo, InstanceKey } from \"../EC\";\nimport { LabelDefinition, LabelDefinitionJSON } from \"../LabelDefinition\";\nimport { ValuesDictionary } from \"../Utils\";\nimport { DisplayValue, DisplayValueJSON, DisplayValuesMapJSON, Value, ValueJSON, ValuesMapJSON } from \"./Value\";\n\n/**\n * Serialized [[Item]] JSON representation.\n * @public\n */\nexport interface ItemJSON {\n  inputKeys?: InstanceKey[];\n  primaryKeys: InstanceKey[];\n  // TODO: rename to `label`\n  // eslint-disable-next-line deprecation/deprecation\n  labelDefinition: LabelDefinitionJSON;\n  /** @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. */\n  imageId: string;\n  classInfo?: ClassInfo;\n  // eslint-disable-next-line deprecation/deprecation\n  values: ValuesDictionary<ValueJSON>;\n  // eslint-disable-next-line deprecation/deprecation\n  displayValues: ValuesDictionary<DisplayValueJSON>;\n  mergedFieldNames: string[];\n  extendedData?: { [key: string]: any };\n}\n\n/**\n * A data structure that represents a single content record.\n * @public\n */\nexport class Item {\n  /**\n   * Keys of input instances that caused this item to be included in content. Only set if the content is\n   * created with [[ContentFlags.IncludeInputKeys]] flag.\n   */\n  public inputKeys?: InstanceKey[];\n  /** Keys of instances whose data is contained in this item */\n  public primaryKeys: InstanceKey[];\n  /** Display label of the item */\n  public label: LabelDefinition;\n  /**\n   * ID of the image associated with this item\n   * @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n   */\n  public imageId: string;\n  /** For cases when item consists only of same class instances, information about the ECClass */\n  public classInfo?: ClassInfo;\n  /** Raw values dictionary */\n  public values: ValuesDictionary<Value>;\n  /** Display values dictionary */\n  public displayValues: ValuesDictionary<DisplayValue>;\n  /** List of field names whose values are merged (see [Merging values]($docs/presentation/content/Terminology#value-merging)) */\n  public mergedFieldNames: string[];\n  /** Extended data injected into this content item */\n  public extendedData?: { [key: string]: any };\n\n  /**\n   * Creates an instance of Item.\n   * @param primaryKeys Keys of instances whose data is contained in this item\n   * @param label Display label of the item\n   * @param imageId ID of the image associated with this item\n   * @param classInfo For cases when item consists only of same class instances, information about the ECClass\n   * @param values Raw values dictionary\n   * @param displayValues Display values dictionary\n   * @param mergedFieldNames List of field names whose values are merged (see [Merging values]($docs/presentation/content/Terminology#value-merging))\n   * @param extendedData Extended data injected into this content item\n   */\n  public constructor(primaryKeys: InstanceKey[], label: string | LabelDefinition, imageId: string, classInfo: ClassInfo | undefined,\n    values: ValuesDictionary<Value>, displayValues: ValuesDictionary<DisplayValue>, mergedFieldNames: string[], extendedData?: { [key: string]: any }) {\n    this.primaryKeys = primaryKeys;\n    this.imageId = imageId; // eslint-disable-line deprecation/deprecation\n    this.classInfo = classInfo;\n    this.values = values;\n    this.displayValues = displayValues;\n    this.mergedFieldNames = mergedFieldNames;\n    this.extendedData = extendedData;\n    this.label = (typeof label === \"string\") ? LabelDefinition.fromLabelString(label) : label;\n  }\n\n  /**\n   * Is value of field with the specified name merged in this record.\n   */\n  public isFieldMerged(fieldName: string): boolean {\n    return -1 !== this.mergedFieldNames.indexOf(fieldName);\n  }\n\n  /** Serialize this object to JSON */\n  public toJSON(): ItemJSON {\n    const { label, ...baseItem } = this;\n    return {\n      ...baseItem,\n      // eslint-disable-next-line deprecation/deprecation\n      values: Value.toJSON(this.values) as ValuesMapJSON,\n      // eslint-disable-next-line deprecation/deprecation\n      displayValues: DisplayValue.toJSON(this.displayValues) as DisplayValuesMapJSON,\n      // eslint-disable-next-line deprecation/deprecation\n      labelDefinition: LabelDefinition.toJSON(label),\n    };\n  }\n\n  /** Deserialize [[Item]] from JSON */\n  public static fromJSON(json: ItemJSON | string | undefined): Item | undefined {\n    if (!json)\n      return undefined;\n    if (typeof json === \"string\")\n      return JSON.parse(json, (key, value) => Item.reviver(key, value));\n    const item = Object.create(Item.prototype);\n    const { labelDefinition, ...baseJson } = json;\n    return Object.assign(item, baseJson, {\n      // eslint-disable-next-line deprecation/deprecation\n      values: Value.fromJSON(json.values),\n      // eslint-disable-next-line deprecation/deprecation\n      displayValues: DisplayValue.fromJSON(json.displayValues),\n      // eslint-disable-next-line deprecation/deprecation\n      label: LabelDefinition.fromJSON(labelDefinition),\n    } as Partial<Item>);\n  }\n\n  /**\n   * Reviver function that can be used as a second argument for\n   * `JSON.parse` method when parsing Item objects.\n   * @internal\n   */\n  public static reviver(key: string, value: any): any {\n    return key === \"\" ? Item.fromJSON(value) : value;\n  }\n\n  /**\n   * Deserialize items list from JSON\n   * @param json JSON or JSON serialized to string to deserialize from\n   * @returns Deserialized items list\n   * @internal\n   */\n  public static listFromJSON(json: ItemJSON[] | string): Item[] {\n    if (typeof json === \"string\") {\n      // eslint-disable-next-line @typescript-eslint/unbound-method\n      return JSON.parse(json, Item.listReviver);\n    }\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    return json.map(Item.fromJSON).filter((item): item is Item => !!item);\n  }\n\n  /**\n   * Reviver function that can be used as a second argument for\n   * `JSON.parse` method when parsing [[Item]][] objects.\n   * @internal\n   */\n  public static listReviver(key: string, value: any): any {\n    return key === \"\" ? Item.listFromJSON(value) : value;\n  }\n}\n"]}

package/lib/cjs/presentation-common/content/PropertyValueFormatter.d.ts

@@ -4,7 +4,9 @@
 import { UnitSystemKey } from "@itwin/core-quantity";
 import { KoqPropertyValueFormatter } from "../KoqPropertyValueFormatter";
 import { Content } from "./Content";
+import { Descriptor } from "./Descriptor";
 import { Field } from "./Fields";
+import { Item } from "./Item";
 import { DisplayValue, Value } from "./Value";
 /** @alpha */
 export declare class ContentFormatter {
@@ -12,6 +14,7 @@ export declare class ContentFormatter {
     private _unitSystem?;
     constructor(_propertyValueFormatter: ContentPropertyValueFormatter, _unitSystem?: UnitSystemKey | undefined);
     formatContent(content: Content): Promise<Content>;
+    formatContentItems(items: Item[], descriptor: Descriptor): Promise<Item[]>;
     private formatValues;
     private formatNestedContentDisplayValues;
 }