npm - @itwin/presentation-common - Versions diffs - 5.15.0-dev.1 → 5.15.0-dev.10 - Mend

@itwin/presentation-common 5.15.0-dev.1 → 5.15.0-dev.10

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

Files changed (105) hide show

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

@@ -12,26 +12,32 @@ import { LabelDefinition } from "./LabelDefinition.js";
 interface LocalizationHelperProps {
     getLocalizedString: (key: string) => string;
 }
-/** @internal */
+/**
+ * Localizes presentation data structures **in place**. Callers must pass a mutable graph owned by the current
+ * operation and must not reuse it as untranslated data for another locale.
+ * @internal
+ */
 export declare class LocalizationHelper {
     private _getLocalizedString;
     constructor(props: LocalizationHelperProps);
     getLocalizedString(text: string): string;
-    getLocalizedNodes(nodes: Node[]): Node[];
-    getLocalizedNode(node: 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 getLocalizedContentItem;
-    private getLocalizedRawValue;
-    private getLocalizedContentField;
-    private getLocalizedCategoryDescription;
-    private getLocalizedDisplayValue;
+    localizeNodes(nodes: Node[]): Node[];
+    localizeNode(node: Node): Node;
+    localizeNodePathElement(npe: NodePathElement): NodePathElement;
+    localizeDisplayValueGroup(group: DisplayValueGroup): DisplayValueGroup;
+    localizeLabelDefinition(labelDefinition: LabelDefinition): LabelDefinition;
+    localizeLabelDefinitions(labelDefinitions: LabelDefinition[]): LabelDefinition[];
+    localizeContentDescriptor(descriptor: Descriptor): Descriptor;
+    localizeContentItems(items: Item[]): Item[];
+    localizeContent(content: Content): Content;
+    localizeElementProperties(elem: ElementProperties): ElementProperties;
+    private localizeContentItem;
+    private localizeRawValuesDictionary;
+    private localizeDisplayValuesDictionary;
+    private localizeRawValue;
+    private localizeContentField;
+    private localizeCategoryDescription;
+    private localizeDisplayValue;
 }
 export {};
 //# sourceMappingURL=LocalizationHelper.d.ts.map

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

	@@ -1 +1 @@
1	- {"version":3,"file":"LocalizationHelper.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAgB,iBAAiB,EAAS,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAA4D,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAIjH,UAAU,uBAAuB;IAC/B,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;IAK/B,~~iBAAiB~~,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE;~~IAIxC~~,~~gBAAgB~~,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;~~IAQlC~~,~~2BAA2B~~,CAAC,GAAG,EAAE,eAAe,GAAG,eAAe;~~IASlE~~,~~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~~;~~IA2B5B~~,OAAO,CAAC,~~wBAAwB~~;~~IAehC~~,OAAO,CAAC~~,+BAA+B~~;~~IAMvC~~,OAAO,CAAC,~~wBAAwB~~;~~CAYjC~~"}
1	+ {"version":3,"file":"LocalizationHelper.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAgB,iBAAiB,EAAS,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAA4D,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAIjH,UAAU,uBAAuB;IAC/B,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;CAC7C;AAED;;;;GAIG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,mBAAmB,CAA0B;gBAEzC,KAAK,EAAE,uBAAuB;IAInC,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAK/B,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE;IAKpC,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAQ9B,uBAAuB,CAAC,GAAG,EAAE,eAAe,GAAG,eAAe;IAO9D,yBAAyB,CAAC,KAAK,EAAE,iBAAiB,GAAG,iBAAiB;IAKtE,uBAAuB,CAAC,eAAe,EAAE,eAAe,GAAG,eAAe;IAU1E,wBAAwB,CAAC,gBAAgB,EAAE,eAAe,EAAE;IAK5D,yBAAyB,CAAC,UAAU,EAAE,UAAU;IAMhD,oBAAoB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE;IAK3C,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAM1C,yBAAyB,CAAC,IAAI,EAAE,iBAAiB,GAAG,iBAAiB;IAK5E,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,2BAA2B;IAMnC,OAAO,CAAC,+BAA+B;IAMvC,OAAO,CAAC,gBAAgB;IA2BxB,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,2BAA2B;IAMnC,OAAO,CAAC,oBAAoB;CAgB7B"}

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

@@ -8,12 +8,14 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalizationHelper = void 0;
-const Content_js_1 = require("./content/Content.js");
-const Descriptor_js_1 = require("./content/Descriptor.js");
 const Value_js_1 = require("./content/Value.js");
 const LabelDefinition_js_1 = require("./LabelDefinition.js");
 const KEY_PATTERN = /@[\w\d\-_]+:[\w\d\-\._]+?@/g;
-/** @internal */
+/**
+ * Localizes presentation data structures **in place**. Callers must pass a mutable graph owned by the current
+ * operation and must not reuse it as untranslated data for another locale.
+ * @internal
+ */
 class LocalizationHelper {
     _getLocalizedString;
     constructor(props) {
@@ -23,126 +25,122 @@ class LocalizationHelper {
         return text.replace(KEY_PATTERN, (key) => this._getLocalizedString(key.replace(/^@|@$/g, "")));
     }
     /* eslint-disable @typescript-eslint/no-deprecated */
-    getLocalizedNodes(nodes) {
-        return nodes.map((n) => this.getLocalizedNode(n));
-    }
-    getLocalizedNode(node) {
-        return {
-            ...node,
-            label: this.getLocalizedLabelDefinition(node.label),
-            ...(node.description ? { description: this.getLocalizedString(node.description) } : undefined),
-        };
-    }
-    getLocalizedNodePathElement(npe) {
-        return {
-            ...npe,
-            node: this.getLocalizedNode(npe.node),
-            children: npe.children.map((c) => this.getLocalizedNodePathElement(c)),
-        };
+    localizeNodes(nodes) {
+        nodes.forEach((n) => this.localizeNode(n));
+        return nodes;
+    }
+    localizeNode(node) {
+        this.localizeLabelDefinition(node.label);
+        if (node.description) {
+            node.description = this.getLocalizedString(node.description);
+        }
+        return node;
+    }
+    localizeNodePathElement(npe) {
+        this.localizeNode(npe.node);
+        npe.children.forEach((c) => this.localizeNodePathElement(c));
+        return npe;
     }
     /* eslint-enable @typescript-eslint/no-deprecated */
-    getLocalizedDisplayValueGroup(group) {
-        return {
-            ...group,
-            displayValue: this.getLocalizedDisplayValue(group.displayValue),
-        };
-    }
-    getLocalizedLabelDefinition(labelDefinition) {
-        const getLocalizedComposite = (compositeValue) => ({
-            ...compositeValue,
-            values: compositeValue.values.map((value) => this.getLocalizedLabelDefinition(value)),
-        });
+    localizeDisplayValueGroup(group) {
+        group.displayValue = this.localizeDisplayValue(group.displayValue);
+        return group;
+    }
+    localizeLabelDefinition(labelDefinition) {
         if (labelDefinition.typeName === LabelDefinition_js_1.COMPOSITE_LABEL_DEFINITION_TYPENAME) {
-            return {
-                ...labelDefinition,
-                rawValue: getLocalizedComposite(labelDefinition.rawValue),
-            };
+            labelDefinition.rawValue.values.forEach((value) => this.localizeLabelDefinition(value));
         }
-        if (labelDefinition.typeName === "string") {
-            return {
-                ...labelDefinition,
-                rawValue: this.getLocalizedString(labelDefinition.rawValue),
-                displayValue: this.getLocalizedString(labelDefinition.displayValue),
-            };
+        else if (labelDefinition.typeName === "string") {
+            labelDefinition.rawValue = this.getLocalizedString(labelDefinition.rawValue);
+            labelDefinition.displayValue = this.getLocalizedString(labelDefinition.displayValue);
         }
         return labelDefinition;
     }
-    getLocalizedLabelDefinitions(labelDefinitions) {
-        return labelDefinitions.map((labelDefinition) => this.getLocalizedLabelDefinition(labelDefinition));
+    localizeLabelDefinitions(labelDefinitions) {
+        labelDefinitions.forEach((labelDefinition) => this.localizeLabelDefinition(labelDefinition));
+        return labelDefinitions;
     }
-    getLocalizedContentDescriptor(descriptor) {
-        const clone = new Descriptor_js_1.Descriptor(descriptor);
-        clone.fields.forEach((field) => this.getLocalizedContentField(field));
-        clone.categories.forEach((category) => this.getLocalizedCategoryDescription(category));
-        return clone;
+    localizeContentDescriptor(descriptor) {
+        descriptor.fields.forEach((field) => this.localizeContentField(field));
+        descriptor.categories.forEach((category) => this.localizeCategoryDescription(category));
+        return descriptor;
     }
-    getLocalizedContentItems(items) {
-        return items.map((item) => this.getLocalizedContentItem(item));
+    localizeContentItems(items) {
+        items.forEach((item) => this.localizeContentItem(item));
+        return items;
     }
-    getLocalizedContent(content) {
-        return new Content_js_1.Content(this.getLocalizedContentDescriptor(content.descriptor), this.getLocalizedContentItems(content.contentSet));
+    localizeContent(content) {
+        this.localizeContentDescriptor(content.descriptor);
+        this.localizeContentItems(content.contentSet);
+        return content;
     }
-    getLocalizedElementProperties(elem) {
-        return {
-            ...elem,
-            label: this.getLocalizedString(elem.label),
-        };
+    localizeElementProperties(elem) {
+        elem.label = this.getLocalizedString(elem.label);
+        return elem;
     }
-    // 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) }), {});
+    localizeContentItem(item) {
+        this.localizeLabelDefinition(item.label);
+        this.localizeRawValuesDictionary(item.values);
+        this.localizeDisplayValuesDictionary(item.displayValues);
         return item;
     }
-    getLocalizedRawValue(value) {
+    localizeRawValuesDictionary(values) {
+        for (const key of Object.keys(values)) {
+            values[key] = this.localizeRawValue(values[key]);
+        }
+    }
+    localizeDisplayValuesDictionary(values) {
+        for (const key of Object.keys(values)) {
+            values[key] = this.localizeDisplayValue(values[key]);
+        }
+    }
+    localizeRawValue(value) {
         if (typeof value === "string") {
             return this.getLocalizedString(value);
         }
         if (Value_js_1.Value.isNavigationValue(value)) {
-            return {
-                ...value,
-                label: this.getLocalizedLabelDefinition(value.label),
-            };
+            this.localizeLabelDefinition(value.label);
+            return value;
         }
         if (Value_js_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) }), {}),
-            }));
+            value.forEach((item) => {
+                this.localizeRawValuesDictionary(item.values);
+                this.localizeDisplayValuesDictionary(item.displayValues);
+            });
+            return value;
         }
         if (Value_js_1.Value.isArray(value)) {
-            return value.map((v) => this.getLocalizedRawValue(v));
+            for (let i = 0; i < value.length; ++i) {
+                value[i] = this.localizeRawValue(value[i]);
+            }
+            return value;
         }
         if (Value_js_1.Value.isMap(value)) {
-            return Object.entries(value).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {});
+            this.localizeRawValuesDictionary(value);
         }
         return value;
     }
-    // warning: this function mutates the field
-    getLocalizedContentField(field) {
+    localizeContentField(field) {
         field.label = this.getLocalizedString(field.label);
         if (field.isPropertiesField()) {
             if (field.isStructPropertiesField()) {
-                field.memberFields = field.memberFields.map((m) => this.getLocalizedContentField(m));
+                field.memberFields.forEach((m) => this.localizeContentField(m));
             }
             else if (field.isArrayPropertiesField()) {
-                field.itemsField = this.getLocalizedContentField(field.itemsField);
+                this.localizeContentField(field.itemsField);
             }
         }
         else if (field.isNestedContentField()) {
-            field.nestedFields = field.nestedFields.map((m) => this.getLocalizedContentField(m));
+            field.nestedFields.forEach((m) => this.localizeContentField(m));
         }
         return field;
     }
-    // warning: this function mutates the category
-    getLocalizedCategoryDescription(category) {
+    localizeCategoryDescription(category) {
         category.label = this.getLocalizedString(category.label);
         category.description = this.getLocalizedString(category.description);
         return category;
     }
-    getLocalizedDisplayValue(value) {
+    localizeDisplayValue(value) {
         if (typeof value === "undefined") {
             return undefined;
         }
@@ -150,9 +148,13 @@ class LocalizationHelper {
             return this.getLocalizedString(value);
         }
         if (Value_js_1.DisplayValue.isArray(value)) {
-            return value.map((v) => this.getLocalizedDisplayValue(v));
+            for (let i = 0; i < value.length; ++i) {
+                value[i] = this.localizeDisplayValue(value[i]);
+            }
+            return value;
         }
-        return Object.entries(value).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {});
+        this.localizeDisplayValuesDictionary(value);
+        return value;
     }
 }
 exports.LocalizationHelper = LocalizationHelper;

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

	@@ -1 +1 @@
1	- {"version":3,"file":"LocalizationHelper.js","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAGH,qDAA+C;AAC/C,2DAAqD;AAGrD,iDAA4E;AAI5E,6DAAiH;AAEjH,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAMlD,gBAAgB;AAChB,MAAa,kBAAkB;IACrB,mBAAmB,CAA0B;IAErD,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;IAED,qDAAqD;IAC9C,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,gBAAgB,CAAC,IAAU;QAChC,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;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;IACD,oDAAoD;IAE7C,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,wDAAmC,EAAE,CAAC;YACrE,OAAO;gBACL,GAAG,eAAe;gBAClB,QAAQ,EAAE,qBAAqB,CAAC,eAAe,CAAC,QAA+B,CAAC;aACjF,CAAC;QACJ,CAAC;QACD,IAAI,eAAe,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC1C,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;QACJ,CAAC;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,0BAAU,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,oBAAO,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,CAAC;YAC9B,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,gBAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,KAAK,CAAC;aACrD,CAAC;QACJ,CAAC;QACD,IAAI,gBAAK,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,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;QACN,CAAC;QACD,IAAI,gBAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,gBAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACvB,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,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,2CAA2C;IACnC,wBAAwB,CAAuB,KAAa;QAClE,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC9B,IAAI,KAAK,CAAC,uBAAuB,EAAE,EAAE,CAAC;gBACpC,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;YACvF,CAAC;iBAAM,IAAI,KAAK,CAAC,sBAAsB,EAAE,EAAE,CAAC;gBAC1C,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,CAAC,oBAAoB,EAAE,EAAE,CAAC;YACxC,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;QACvF,CAAC;QACD,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,wBAAwB,CAAC,KAAmB;QAClD,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YACjC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,uBAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;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;AA5JD,gDA4JC","sourcesContent":["/---------------------------------------------------------------------------------------------\r\n Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n --------------------------------------------------------------------------------------------/\r\n/** @packageDocumentation\r\n * @module Core\r\n /\r\n\r\nimport { CategoryDescription } from \"./content/Category.js\";\r\nimport { Content } from \"./content/Content.js\";\r\nimport { Descriptor } from \"./content/Descriptor.js\";\r\nimport { Field } from \"./content/Fields.js\";\r\nimport { Item } from \"./content/Item.js\";\r\nimport { DisplayValue, DisplayValueGroup, Value } from \"./content/Value.js\";\r\nimport { ElementProperties } from \"./ElementProperties.js\";\r\nimport { Node } from \"./hierarchy/Node.js\";\r\nimport { NodePathElement } from \"./hierarchy/NodePathElement.js\";\r\nimport { COMPOSITE_LABEL_DEFINITION_TYPENAME, LabelCompositeValue, LabelDefinition } from \"./LabelDefinition.js\";\r\n\r\nconst KEY_PATTERN = /@[\\w\\d\\-_]+:[\\w\\d\\-\\._]+?@/g;\r\n\r\ninterface LocalizationHelperProps {\r\n getLocalizedString: (key: string) => string;\r\n}\r\n\r\n/* @internal /\r\nexport class LocalizationHelper {\r\n private _getLocalizedString: (key: string) => string;\r\n\r\n constructor(props: LocalizationHelperProps) {\r\n this._getLocalizedString = props.getLocalizedString;\r\n }\r\n\r\n public getLocalizedString(text: string) {\r\n return text.replace(KEY_PATTERN, (key) => this._getLocalizedString(key.replace(/^@\|@$/g, \"\")));\r\n }\r\n\r\n / eslint-disable @typescript-eslint/no-deprecated /\r\n public getLocalizedNodes(nodes: Node[]): Node[] {\r\n return nodes.map((n) => this.getLocalizedNode(n));\r\n }\r\n\r\n public getLocalizedNode(node: Node): Node {\r\n return {\r\n ...node,\r\n label: this.getLocalizedLabelDefinition(node.label),\r\n ...(node.description ? { description: this.getLocalizedString(node.description) } : undefined),\r\n };\r\n }\r\n\r\n public getLocalizedNodePathElement(npe: NodePathElement): NodePathElement {\r\n return {\r\n ...npe,\r\n node: this.getLocalizedNode(npe.node),\r\n children: npe.children.map((c) => this.getLocalizedNodePathElement(c)),\r\n };\r\n }\r\n / eslint-enable @typescript-eslint/no-deprecated */\r\n\r\n public getLocalizedDisplayValueGroup(group: DisplayValueGroup): DisplayValueGroup {\r\n return {\r\n ...group,\r\n displayValue: this.getLocalizedDisplayValue(group.displayValue),\r\n };\r\n }\r\n\r\n public getLocalizedLabelDefinition(labelDefinition: LabelDefinition): LabelDefinition {\r\n const getLocalizedComposite = (compositeValue: LabelCompositeValue) => ({\r\n ...compositeValue,\r\n values: compositeValue.values.map((value) => this.getLocalizedLabelDefinition(value)),\r\n });\r\n\r\n if (labelDefinition.typeName === COMPOSITE_LABEL_DEFINITION_TYPENAME) {\r\n return {\r\n ...labelDefinition,\r\n rawValue: getLocalizedComposite(labelDefinition.rawValue as LabelCompositeValue),\r\n };\r\n }\r\n if (labelDefinition.typeName === \"string\") {\r\n return {\r\n ...labelDefinition,\r\n rawValue: this.getLocalizedString(labelDefinition.rawValue as string),\r\n displayValue: this.getLocalizedString(labelDefinition.displayValue),\r\n };\r\n }\r\n return labelDefinition;\r\n }\r\n\r\n public getLocalizedLabelDefinitions(labelDefinitions: LabelDefinition[]) {\r\n return labelDefinitions.map((labelDefinition) => this.getLocalizedLabelDefinition(labelDefinition));\r\n }\r\n\r\n public getLocalizedContentDescriptor(descriptor: Descriptor) {\r\n const clone = new Descriptor(descriptor);\r\n clone.fields.forEach((field) => this.getLocalizedContentField(field));\r\n clone.categories.forEach((category) => this.getLocalizedCategoryDescription(category));\r\n return clone;\r\n }\r\n\r\n public getLocalizedContentItems(items: Item[]): Item[] {\r\n return items.map((item) => this.getLocalizedContentItem(item));\r\n }\r\n\r\n public getLocalizedContent(content: Content): Content {\r\n return new Content(this.getLocalizedContentDescriptor(content.descriptor), this.getLocalizedContentItems(content.contentSet));\r\n }\r\n\r\n public getLocalizedElementProperties(elem: ElementProperties): ElementProperties {\r\n return {\r\n ...elem,\r\n label: this.getLocalizedString(elem.label),\r\n };\r\n }\r\n\r\n // warning: this function mutates the item\r\n private getLocalizedContentItem(item: Item): Item {\r\n item.label = this.getLocalizedLabelDefinition(item.label);\r\n item.values = Object.entries(item.values).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {});\r\n item.displayValues = Object.entries(item.displayValues).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {});\r\n return item;\r\n }\r\n\r\n private getLocalizedRawValue(value: Value): Value {\r\n if (typeof value === \"string\") {\r\n return this.getLocalizedString(value);\r\n }\r\n if (Value.isNavigationValue(value)) {\r\n return {\r\n ...value,\r\n label: this.getLocalizedLabelDefinition(value.label),\r\n };\r\n }\r\n if (Value.isNestedContent(value)) {\r\n return value.map((item) => ({\r\n ...item,\r\n values: Object.entries(item.values).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {}),\r\n displayValues: Object.entries(item.displayValues).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {}),\r\n }));\r\n }\r\n if (Value.isArray(value)) {\r\n return value.map((v) => this.getLocalizedRawValue(v));\r\n }\r\n if (Value.isMap(value)) {\r\n return Object.entries(value).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {});\r\n }\r\n return value;\r\n }\r\n\r\n // warning: this function mutates the field\r\n private getLocalizedContentField<TField extends Field>(field: TField) {\r\n field.label = this.getLocalizedString(field.label);\r\n if (field.isPropertiesField()) {\r\n if (field.isStructPropertiesField()) {\r\n field.memberFields = field.memberFields.map((m) => this.getLocalizedContentField(m));\r\n } else if (field.isArrayPropertiesField()) {\r\n field.itemsField = this.getLocalizedContentField(field.itemsField);\r\n }\r\n } else if (field.isNestedContentField()) {\r\n field.nestedFields = field.nestedFields.map((m) => this.getLocalizedContentField(m));\r\n }\r\n return field;\r\n }\r\n\r\n // warning: this function mutates the category\r\n private getLocalizedCategoryDescription(category: CategoryDescription) {\r\n category.label = this.getLocalizedString(category.label);\r\n category.description = this.getLocalizedString(category.description);\r\n return category;\r\n }\r\n\r\n private getLocalizedDisplayValue(value: DisplayValue): DisplayValue {\r\n if (typeof value === \"undefined\") {\r\n return undefined;\r\n }\r\n if (typeof value === \"string\") {\r\n return this.getLocalizedString(value);\r\n }\r\n if (DisplayValue.isArray(value)) {\r\n return value.map((v) => this.getLocalizedDisplayValue(v));\r\n }\r\n return Object.entries(value).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedDisplayValue(v) }), {});\r\n }\r\n}\r\n"]}
1	+ {"version":3,"file":"LocalizationHelper.js","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAOH,iDAA4E;AAI5E,6DAAiH;AAEjH,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAMlD;;;;GAIG;AACH,MAAa,kBAAkB;IACrB,mBAAmB,CAA0B;IAErD,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;IAED,qDAAqD;IAC9C,aAAa,CAAC,KAAa;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,YAAY,CAAC,IAAU;QAC5B,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,uBAAuB,CAAC,GAAoB;QACjD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7D,OAAO,GAAG,CAAC;IACb,CAAC;IACD,oDAAoD;IAE7C,yBAAyB,CAAC,KAAwB;QACvD,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACnE,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,uBAAuB,CAAC,eAAgC;QAC7D,IAAI,eAAe,CAAC,QAAQ,KAAK,wDAAmC,EAAE,CAAC;YACpE,eAAe,CAAC,QAAgC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC;QACnH,CAAC;aAAM,IAAI,eAAe,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjD,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;QACvF,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAEM,wBAAwB,CAAC,gBAAmC;QACjE,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC,CAAC;QAC7F,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEM,yBAAyB,CAAC,UAAsB;QACrD,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;QACvE,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC,CAAC;QACxF,OAAO,UAAU,CAAC;IACpB,CAAC;IAEM,oBAAoB,CAAC,KAAa;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;QACxD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,eAAe,CAAC,OAAgB;QACrC,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC9C,OAAO,OAAO,CAAC;IACjB,CAAC;IAEM,yBAAyB,CAAC,IAAuB;QACtD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,mBAAmB,CAAC,IAAU;QACpC,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,2BAA2B,CAAC,MAAgC;QAClE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAEO,+BAA+B,CAAC,MAAuC;QAC7E,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,KAAY;QACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,gBAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,gBAAK,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACrB,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC9C,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;YACH,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,gBAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACtC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,gBAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,oBAAoB,CAAC,KAAY;QACvC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC9B,IAAI,KAAK,CAAC,uBAAuB,EAAE,EAAE,CAAC;gBACpC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;YAClE,CAAC;iBAAM,IAAI,KAAK,CAAC,sBAAsB,EAAE,EAAE,CAAC;gBAC1C,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,CAAC,oBAAoB,EAAE,EAAE,CAAC;YACxC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,2BAA2B,CAAC,QAA6B;QAC/D,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,oBAAoB,CAAC,KAAmB;QAC9C,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YACjC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,uBAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACtC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA5JD,gDA4JC","sourcesContent":["/---------------------------------------------------------------------------------------------\r\n Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n --------------------------------------------------------------------------------------------/\r\n/** @packageDocumentation\r\n * @module Core\r\n /\r\n\r\nimport { CategoryDescription } from \"./content/Category.js\";\r\nimport { Content } from \"./content/Content.js\";\r\nimport { Descriptor } from \"./content/Descriptor.js\";\r\nimport { Field } from \"./content/Fields.js\";\r\nimport { Item } from \"./content/Item.js\";\r\nimport { DisplayValue, DisplayValueGroup, Value } from \"./content/Value.js\";\r\nimport { ElementProperties } from \"./ElementProperties.js\";\r\nimport { Node } from \"./hierarchy/Node.js\";\r\nimport { NodePathElement } from \"./hierarchy/NodePathElement.js\";\r\nimport { COMPOSITE_LABEL_DEFINITION_TYPENAME, LabelCompositeValue, LabelDefinition } from \"./LabelDefinition.js\";\r\n\r\nconst KEY_PATTERN = /@[\\w\\d\\-_]+:[\\w\\d\\-\\._]+?@/g;\r\n\r\ninterface LocalizationHelperProps {\r\n getLocalizedString: (key: string) => string;\r\n}\r\n\r\n/\r\n Localizes presentation data structures in place. Callers must pass a mutable graph owned by the current\r\n * operation and must not reuse it as untranslated data for another locale.\r\n * @internal\r\n /\r\nexport class LocalizationHelper {\r\n private _getLocalizedString: (key: string) => string;\r\n\r\n constructor(props: LocalizationHelperProps) {\r\n this._getLocalizedString = props.getLocalizedString;\r\n }\r\n\r\n public getLocalizedString(text: string) {\r\n return text.replace(KEY_PATTERN, (key) => this._getLocalizedString(key.replace(/^@\|@$/g, \"\")));\r\n }\r\n\r\n / eslint-disable @typescript-eslint/no-deprecated /\r\n public localizeNodes(nodes: Node[]): Node[] {\r\n nodes.forEach((n) => this.localizeNode(n));\r\n return nodes;\r\n }\r\n\r\n public localizeNode(node: Node): Node {\r\n this.localizeLabelDefinition(node.label);\r\n if (node.description) {\r\n node.description = this.getLocalizedString(node.description);\r\n }\r\n return node;\r\n }\r\n\r\n public localizeNodePathElement(npe: NodePathElement): NodePathElement {\r\n this.localizeNode(npe.node);\r\n npe.children.forEach((c) => this.localizeNodePathElement(c));\r\n return npe;\r\n }\r\n / eslint-enable @typescript-eslint/no-deprecated */\r\n\r\n public localizeDisplayValueGroup(group: DisplayValueGroup): DisplayValueGroup {\r\n group.displayValue = this.localizeDisplayValue(group.displayValue);\r\n return group;\r\n }\r\n\r\n public localizeLabelDefinition(labelDefinition: LabelDefinition): LabelDefinition {\r\n if (labelDefinition.typeName === COMPOSITE_LABEL_DEFINITION_TYPENAME) {\r\n (labelDefinition.rawValue as LabelCompositeValue).values.forEach((value) => this.localizeLabelDefinition(value));\r\n } else if (labelDefinition.typeName === \"string\") {\r\n labelDefinition.rawValue = this.getLocalizedString(labelDefinition.rawValue as string);\r\n labelDefinition.displayValue = this.getLocalizedString(labelDefinition.displayValue);\r\n }\r\n return labelDefinition;\r\n }\r\n\r\n public localizeLabelDefinitions(labelDefinitions: LabelDefinition[]) {\r\n labelDefinitions.forEach((labelDefinition) => this.localizeLabelDefinition(labelDefinition));\r\n return labelDefinitions;\r\n }\r\n\r\n public localizeContentDescriptor(descriptor: Descriptor) {\r\n descriptor.fields.forEach((field) => this.localizeContentField(field));\r\n descriptor.categories.forEach((category) => this.localizeCategoryDescription(category));\r\n return descriptor;\r\n }\r\n\r\n public localizeContentItems(items: Item[]): Item[] {\r\n items.forEach((item) => this.localizeContentItem(item));\r\n return items;\r\n }\r\n\r\n public localizeContent(content: Content): Content {\r\n this.localizeContentDescriptor(content.descriptor);\r\n this.localizeContentItems(content.contentSet);\r\n return content;\r\n }\r\n\r\n public localizeElementProperties(elem: ElementProperties): ElementProperties {\r\n elem.label = this.getLocalizedString(elem.label);\r\n return elem;\r\n }\r\n\r\n private localizeContentItem(item: Item): Item {\r\n this.localizeLabelDefinition(item.label);\r\n this.localizeRawValuesDictionary(item.values);\r\n this.localizeDisplayValuesDictionary(item.displayValues);\r\n return item;\r\n }\r\n\r\n private localizeRawValuesDictionary(values: { [key: string]: Value }) {\r\n for (const key of Object.keys(values)) {\r\n values[key] = this.localizeRawValue(values[key]);\r\n }\r\n }\r\n\r\n private localizeDisplayValuesDictionary(values: { [key: string]: DisplayValue }) {\r\n for (const key of Object.keys(values)) {\r\n values[key] = this.localizeDisplayValue(values[key]);\r\n }\r\n }\r\n\r\n private localizeRawValue(value: Value): Value {\r\n if (typeof value === \"string\") {\r\n return this.getLocalizedString(value);\r\n }\r\n if (Value.isNavigationValue(value)) {\r\n this.localizeLabelDefinition(value.label);\r\n return value;\r\n }\r\n if (Value.isNestedContent(value)) {\r\n value.forEach((item) => {\r\n this.localizeRawValuesDictionary(item.values);\r\n this.localizeDisplayValuesDictionary(item.displayValues);\r\n });\r\n return value;\r\n }\r\n if (Value.isArray(value)) {\r\n for (let i = 0; i < value.length; ++i) {\r\n value[i] = this.localizeRawValue(value[i]);\r\n }\r\n return value;\r\n }\r\n if (Value.isMap(value)) {\r\n this.localizeRawValuesDictionary(value);\r\n }\r\n return value;\r\n }\r\n\r\n private localizeContentField(field: Field) {\r\n field.label = this.getLocalizedString(field.label);\r\n if (field.isPropertiesField()) {\r\n if (field.isStructPropertiesField()) {\r\n field.memberFields.forEach((m) => this.localizeContentField(m));\r\n } else if (field.isArrayPropertiesField()) {\r\n this.localizeContentField(field.itemsField);\r\n }\r\n } else if (field.isNestedContentField()) {\r\n field.nestedFields.forEach((m) => this.localizeContentField(m));\r\n }\r\n return field;\r\n }\r\n\r\n private localizeCategoryDescription(category: CategoryDescription) {\r\n category.label = this.getLocalizedString(category.label);\r\n category.description = this.getLocalizedString(category.description);\r\n return category;\r\n }\r\n\r\n private localizeDisplayValue(value: DisplayValue): DisplayValue {\r\n if (typeof value === \"undefined\") {\r\n return undefined;\r\n }\r\n if (typeof value === \"string\") {\r\n return this.getLocalizedString(value);\r\n }\r\n if (DisplayValue.isArray(value)) {\r\n for (let i = 0; i < value.length; ++i) {\r\n value[i] = this.localizeDisplayValue(value[i]);\r\n }\r\n return value;\r\n }\r\n this.localizeDisplayValuesDictionary(value);\r\n return value;\r\n }\r\n}\r\n"]}

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

@@ -42,7 +42,7 @@ export interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVa
 /**
  * Request type for hierarchy requests.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
@@ -70,7 +70,7 @@ export interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = R
 /**
  * Params for hierarchy level descriptor requests.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
@@ -80,7 +80,7 @@ export interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRule
 /**
  * Request type of filtering hierarchies by given ECInstance paths.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
@@ -95,7 +95,7 @@ export interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetV
 /**
  * Request type of filtering hierarchies by given text.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
@@ -274,7 +274,7 @@ export interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<
 /**
  * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {

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

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

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

@@ -56,28 +56,28 @@ export type PresentationRpcResponse<TResult = undefined> = Promise<PresentationR
 /**
  * Data structure for hierarchy request options.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export type HierarchyRpcRequestOptions = PresentationRpcRequestOptions<HierarchyRequestOptions<never, NodeKey, RulesetVariableJSON>>;
 /**
  * Data structure for hierarchy level descriptor RPC request options.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export type HierarchyLevelDescriptorRpcRequestOptions = PresentationRpcRequestOptions<HierarchyLevelDescriptorRequestOptions<never, NodeKey, RulesetVariableJSON>>;
 /**
  * Data structure for filtering hierarchy by ECInstance paths request options.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export type FilterByInstancePathsHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByInstancePathsHierarchyRequestOptions<never, RulesetVariableJSON>>;
 /**
  * Data structure for filtering hierarchy by text request options.
  * @public
- * @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
+ * @deprecated in 5.2 - might be removed in next major version. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
  * package for creating hierarchies.
  */
 export type FilterByTextHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByTextHierarchyRequestOptions<never, RulesetVariableJSON>>;