@itwin/presentation-common 5.1.0-dev.9 → 5.1.0

package/lib/esm/presentation-common/KoqPropertyValueFormatter.js

@@ -5,8 +5,9 @@
 /** @packageDocumentation
  * @module Core
  */
+import { assert } from "@itwin/core-bentley";
 import { Format, FormatterSpec, ParserSpec } from "@itwin/core-quantity";
-import { getFormatProps, InvertedUnit, KindOfQuantity, SchemaKey, SchemaMatchType, SchemaUnitProvider, } from "@itwin/ecschema-metadata";
+import { InvertedUnit, KindOfQuantity, SchemaContext, SchemaFormatsProvider, SchemaKey, SchemaMatchType, SchemaUnitProvider } from "@itwin/ecschema-metadata";
 /**
  * An utility for formatting property values based on `KindOfQuantity` and unit system.
  * @public
@@ -14,14 +15,35 @@ import { getFormatProps, InvertedUnit, KindOfQuantity, SchemaKey, SchemaMatchTyp
 export class KoqPropertyValueFormatter {
     _schemaContext;
     _unitsProvider;
+    _formatsProvider;
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     _defaultFormats;
-    constructor(_schemaContext, defaultFormats) {
-        this._schemaContext = _schemaContext;
-        this._unitsProvider = new SchemaUnitProvider(_schemaContext);
-        this._defaultFormats = defaultFormats
-            ? Object.entries(defaultFormats).reduce((acc, [phenomenon, unitSystemFormats]) => ({ ...acc, [phenomenon.toUpperCase()]: unitSystemFormats }), {})
-            : /* c8 ignore next */ undefined;
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    constructor(schemaContextOrProps, defaultFormats, formatsProvider) {
+        if (schemaContextOrProps instanceof SchemaContext) {
+            this._schemaContext = schemaContextOrProps;
+            this._formatsProvider = formatsProvider;
+            this.defaultFormats = defaultFormats;
+        }
+        else {
+            this._schemaContext = schemaContextOrProps.schemaContext;
+            this._formatsProvider = schemaContextOrProps.formatsProvider;
+        }
+        this._unitsProvider = new SchemaUnitProvider(this._schemaContext);
+    }
+    /* c8 ignore start */
+    /** @internal */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    get defaultFormats() {
+        return this._defaultFormats;
     }
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    set defaultFormats(value) {
+        this._defaultFormats = value
+            ? Object.entries(value).reduce((acc, [phenomenon, unitSystemFormats]) => ({ ...acc, [phenomenon.toUpperCase()]: unitSystemFormats }), {})
+            : undefined;
+    }
+    /* c8 ignore end */
     async format(value, options) {
         const formatterSpec = await this.getFormatterSpec(options);
         if (!formatterSpec) {
@@ -30,7 +52,7 @@ export class KoqPropertyValueFormatter {
         return formatterSpec.applyFormatting(value);
     }
     async getFormatterSpec(options) {
-        const formattingProps = await getFormattingProps(this._schemaContext, this._defaultFormats, options);
+        const formattingProps = await this.#getFormattingProps(options);
         if (!formattingProps) {
             return undefined;
         }
@@ -40,7 +62,7 @@ export class KoqPropertyValueFormatter {
         return FormatterSpec.create("", format, this._unitsProvider, persistenceUnit);
     }
     async getParserSpec(options) {
-        const formattingProps = await getFormattingProps(this._schemaContext, this._defaultFormats, options);
+        const formattingProps = await this.#getFormattingProps(options);
         if (!formattingProps) {
             return undefined;
         }
@@ -49,23 +71,37 @@ export class KoqPropertyValueFormatter {
         const format = await Format.createFromJSON("", this._unitsProvider, formatProps);
         return ParserSpec.create(format, this._unitsProvider, persistenceUnit);
     }
-}
-async function getFormattingProps(schemaLocater, defaultFormats, options) {
-    const { koqName, unitSystem } = options;
-    const koq = await getKoq(schemaLocater, koqName);
-    if (!koq) {
-        return undefined;
-    }
-    const persistenceUnit = await koq.persistenceUnit;
-    /* c8 ignore next 3 */
-    if (!persistenceUnit) {
-        return undefined;
-    }
-    const formatProps = await getKoqFormatProps(koq, persistenceUnit, defaultFormats, unitSystem);
-    if (!formatProps) {
+    async #getFormattingProps(options) {
+        const { koqName } = options;
+        const koq = await getKoq(this._schemaContext, koqName);
+        if (!koq) {
+            return undefined;
+        }
+        const persistenceUnit = await koq.persistenceUnit;
+        assert(!!persistenceUnit);
+        // default to metric as it's the persistence unit system
+        const unitSystem = options.unitSystem ?? "metric";
+        const formatsProvider = this._formatsProvider ?? new SchemaFormatsProvider(this._schemaContext, unitSystem);
+        const formatProps = await formatsProvider.getFormat(koqName);
+        // `SchemaFormatsProvider` will fall back to default presentation format, but we want to fall back
+        // to default formats' map first, and only then to the default presentation format. All of this can
+        // be removed with the removal of default formats map.
+        if (this._defaultFormats && (!formatProps || (await getUnitSystemKey(this._unitsProvider, formatProps)) !== unitSystem)) {
+            const defaultFormatProps = await getFormatPropsFromDefaultFormats({
+                schemaContext: this._schemaContext,
+                formatsMap: this._defaultFormats,
+                unitSystem,
+                koqName,
+            });
+            if (defaultFormatProps) {
+                return { formatProps: defaultFormatProps, persistenceUnitName: persistenceUnit.fullName };
+            }
+        }
+        if (formatProps) {
+            return { formatProps, persistenceUnitName: persistenceUnit.fullName };
+        }
         return undefined;
     }
-    return { formatProps, persistenceUnitName: persistenceUnit.fullName };
 }
 async function getKoq(schemaLocater, fullName) {
     const [schemaName, propKoqName] = fullName.split(":");
@@ -75,92 +111,49 @@ async function getKoq(schemaLocater, fullName) {
     }
     return schema.getItem(propKoqName, KindOfQuantity);
 }
-async function getKoqFormatProps(koq, persistenceUnit, defaultFormats, unitSystem) {
-    const unitSystemMatchers = getUnitSystemGroupMatchers(unitSystem);
-    // use one of KOQ presentation format that matches requested unit system
-    const presentationFormat = await getKoqPresentationFormat(koq, unitSystemMatchers);
-    if (presentationFormat) {
-        return getFormatProps(presentationFormat);
-    }
-    // use one of the formats in default formats map if there is one for matching phenomena and requested unit
-    // system combination
-    if (defaultFormats && unitSystem) {
-        const actualPersistenceUnit = persistenceUnit instanceof InvertedUnit ? /* c8 ignore next */ await persistenceUnit.invertsUnit : persistenceUnit;
-        const phenomenon = await actualPersistenceUnit?.phenomenon;
-        if (phenomenon && defaultFormats[phenomenon.name.toUpperCase()]) {
-            const defaultPhenomenonFormats = defaultFormats[phenomenon.name.toUpperCase()];
-            for (const defaultUnitSystemFormat of Array.isArray(defaultPhenomenonFormats)
-                ? /* c8 ignore next */ defaultPhenomenonFormats
-                : [defaultPhenomenonFormats]) {
-                if (defaultUnitSystemFormat.unitSystems.includes(unitSystem)) {
-                    return defaultUnitSystemFormat.format;
-                }
-            }
-        }
+async function getUnitSystemKey(unitsProvider, formatProps) {
+    const unitName = formatProps.composite?.units[0].name;
+    assert(!!unitName);
+    const unit = await unitsProvider.findUnitByName(unitName);
+    assert(!!unit);
+    const [_, unitSystemName] = unit.system.split(/[\.:]/);
+    switch (unitSystemName.toUpperCase()) {
+        case "METRIC":
+            return "metric";
+        case "IMPERIAL":
+            return "imperial";
+        case "USCUSTOM":
+            return "usCustomary";
+        case "USSURVEY":
+            return "usSurvey";
+        /* c8 ignore next 2 */
+        default:
+            return undefined;
     }
-    // use persistence unit format if it matches requested unit system and matching presentation format was not found
-    const persistenceUnitSystem = await persistenceUnit.unitSystem;
-    if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {
-        return getPersistenceUnitFormatProps(persistenceUnit);
+}
+async function getFormatPropsFromDefaultFormats({ schemaContext, formatsMap, unitSystem, koqName, }) {
+    const koq = await getKoq(schemaContext, koqName);
+    /* c8 ignore next 3 */
+    if (!koq) {
+        return undefined;
     }
-    // use default presentation format if persistence unit does not match requested unit system
-    if (koq.defaultPresentationFormat) {
-        return getFormatProps(await koq.defaultPresentationFormat);
+    const persistenceUnit = await koq.persistenceUnit;
+    /* c8 ignore next 3 */
+    if (!persistenceUnit) {
+        return undefined;
     }
-    return undefined;
-}
-async function getKoqPresentationFormat(koq, unitSystemMatchers) {
-    const presentationFormats = koq.presentationFormats;
-    for (const matcher of unitSystemMatchers) {
-        for (const lazyFormat of presentationFormats) {
-            const format = await lazyFormat;
-            const lazyUnit = format.units && format.units[0][0];
-            /* c8 ignore next 3 */
-            if (!lazyUnit) {
-                continue;
-            }
-            const unit = await lazyUnit;
-            const currentUnitSystem = await unit.unitSystem;
-            if (currentUnitSystem && matcher(currentUnitSystem)) {
-                return format;
+    const actualPersistenceUnit = persistenceUnit instanceof InvertedUnit ? /* c8 ignore next */ await persistenceUnit.invertsUnit : persistenceUnit;
+    const phenomenon = await actualPersistenceUnit?.phenomenon;
+    if (phenomenon && formatsMap[phenomenon.name.toUpperCase()]) {
+        const defaultPhenomenonFormats = formatsMap[phenomenon.name.toUpperCase()];
+        for (const defaultUnitSystemFormat of Array.isArray(defaultPhenomenonFormats)
+            ? /* c8 ignore next */ defaultPhenomenonFormats
+            : [defaultPhenomenonFormats]) {
+            if (defaultUnitSystemFormat.unitSystems.includes(unitSystem)) {
+                return defaultUnitSystemFormat.format;
             }
         }
     }
     return undefined;
 }
-function getPersistenceUnitFormatProps(persistenceUnit) {
-    // Same as Format "DefaultRealU" in Formats ecschema
-    return {
-        formatTraits: ["keepSingleZero", "keepDecimalPoint", "showUnitLabel"],
-        precision: 6,
-        type: "Decimal",
-        uomSeparator: " ",
-        decimalSeparator: ".",
-        composite: {
-            units: [
-                {
-                    name: persistenceUnit.fullName,
-                    label: persistenceUnit.label,
-                },
-            ],
-        },
-    };
-}
-function getUnitSystemGroupMatchers(groupKey) {
-    function createMatcher(name) {
-        const names = Array.isArray(name) ? name : [name];
-        return (unitSystem) => names.some((n) => n === unitSystem.name.toUpperCase());
-    }
-    switch (groupKey) {
-        case "imperial":
-            return ["IMPERIAL", "USCUSTOM", "INTERNATIONAL", "FINANCE"].map(createMatcher);
-        case "metric":
-            return [["SI", "METRIC"], "INTERNATIONAL", "FINANCE"].map(createMatcher);
-        case "usCustomary":
-            return ["USCUSTOM", "INTERNATIONAL", "FINANCE"].map(createMatcher);
-        case "usSurvey":
-            return ["USSURVEY", "USCUSTOM", "INTERNATIONAL", "FINANCE"].map(createMatcher);
-    }
-    return [];
-}
 //# sourceMappingURL=KoqPropertyValueFormatter.js.map

package/lib/esm/presentation-common/KoqPropertyValueFormatter.js.map

@@ -1 +1 @@
-{"version":3,"file":"KoqPropertyValueFormatter.js","sourceRoot":"","sources":["../../../src/presentation-common/KoqPropertyValueFormatter.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAe,aAAa,EAAE,UAAU,EAAgC,MAAM,sBAAsB,CAAC;AACpH,OAAO,EACL,cAAc,EACd,YAAY,EACZ,cAAc,EAEd,SAAS,EACT,eAAe,EACf,kBAAkB,GAGnB,MAAM,0BAA0B,CAAC;AAiDlC;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IAK1B;IAJF,cAAc,CAAgB;IAC9B,eAAe,CAAc;IAErC,YACU,cAA6B,EACrC,cAA2B;QADnB,mBAAc,GAAd,cAAc,CAAe;QAGrC,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,cAAc,CAAC,CAAC;QAC7D,IAAI,CAAC,eAAe,GAAG,cAAc;YACnC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,EAAE,CAAC;YAClJ,CAAC,CAAC,oBAAoB,CAAC,SAAS,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAsB;QACvD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,aAAa,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAsB;QAClD,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QACrG,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAC;QAC7D,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QACtF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACjF,OAAO,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAAsB;QAC/C,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QACrG,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAC;QAC7D,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QACtF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACjF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;CACF;AAOD,KAAK,UAAU,kBAAkB,CAC/B,aAA4B,EAC5B,cAAsC,EACtC,OAAsB;IAEtB,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAExC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACjD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC;IAClD,sBAAsB;IACtB,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,eAAe,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IAC9F,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC;AACxE,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,aAA4B,EAAE,QAAgB;IAClE,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAChG,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,GAAmB,EACnB,eAAoC,EACpC,cAAsC,EACtC,UAA0B;IAE1B,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IAClE,wEAAwE;IACxE,MAAM,kBAAkB,GAAG,MAAM,wBAAwB,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;IACnF,IAAI,kBAAkB,EAAE,CAAC;QACvB,OAAO,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAC5C,CAAC;IAED,0GAA0G;IAC1G,qBAAqB;IACrB,IAAI,cAAc,IAAI,UAAU,EAAE,CAAC;QACjC,MAAM,qBAAqB,GAAG,eAAe,YAAY,YAAY,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC;QACjJ,MAAM,UAAU,GAAG,MAAM,qBAAqB,EAAE,UAAU,CAAC;QAC3D,IAAI,UAAU,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAChE,MAAM,wBAAwB,GAAG,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAC/E,KAAK,MAAM,uBAAuB,IAAI,KAAK,CAAC,OAAO,CAAC,wBAAwB,CAAC;gBAC3E,CAAC,CAAC,oBAAoB,CAAC,wBAAwB;gBAC/C,CAAC,CAAC,CAAC,wBAAwB,CAAC,EAAE,CAAC;gBAC/B,IAAI,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC7D,OAAO,uBAAuB,CAAC,MAAM,CAAC;gBACxC,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,iHAAiH;IACjH,MAAM,qBAAqB,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC;IAC/D,IAAI,qBAAqB,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC;QAClG,OAAO,6BAA6B,CAAC,eAAe,CAAC,CAAC;IACxD,CAAC;IAED,2FAA2F;IAC3F,IAAI,GAAG,CAAC,yBAAyB,EAAE,CAAC;QAClC,OAAO,cAAc,CAAC,MAAM,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,wBAAwB,CAAC,GAAmB,EAAE,kBAA8D;IACzH,MAAM,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IACpD,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;QACzC,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;YAC7C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;YAChC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,sBAAsB;YACtB,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC;YAC5B,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;YAChD,IAAI,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACpD,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoC;IACzE,oDAAoD;IACpD,OAAO;QACL,YAAY,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,CAAC;QACrE,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,GAAG;QACjB,gBAAgB,EAAE,GAAG;QACrB,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,0BAA0B,CAAC,QAAwB;IAC1D,SAAS,aAAa,CAAC,IAAuB;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,CAAC,UAAsB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACjF,KAAK,QAAQ;YACX,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC3E,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACrE,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC","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 { Format, FormatProps, FormatterSpec, ParserSpec, UnitsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\nimport {\n  getFormatProps,\n  InvertedUnit,\n  KindOfQuantity,\n  SchemaContext,\n  SchemaKey,\n  SchemaMatchType,\n  SchemaUnitProvider,\n  Unit,\n  UnitSystem,\n} from \"@itwin/ecschema-metadata\";\n\n/**\n * A data structure that associates unit systems with property value formatting props. The associations are used for\n * assigning formatting props for specific phenomenon and unit system combinations (see [[FormatsMap]]).\n *\n * @public\n */\nexport interface UnitSystemFormat {\n  unitSystems: UnitSystemKey[];\n  format: FormatProps;\n}\n\n/**\n * A data structure that associates specific phenomenon with one or more formatting props for specific unit system.\n *\n * Example:\n * ```json\n * {\n *   length: [{\n *     unitSystems: [\"metric\"],\n *     format: formatForCentimeters,\n *   }, {\n *     unitSystems: [\"imperial\", \"usCustomary\"],\n *     format: formatForInches,\n *   }, {\n *     unitSystems: [\"usSurvey\"],\n *     format: formatForUsSurveyInches,\n *   }]\n * }\n * ```\n *\n * @public\n */\nexport interface FormatsMap {\n  [phenomenon: string]: UnitSystemFormat | UnitSystemFormat[];\n}\n\n/**\n * Options for finding a formatter spec to use in [[KoqPropertyValueFormatter]].\n * @public\n */\nexport interface FormatOptions {\n  /** Full name of the `KindOfQuantity`, e.g. `SchemaName:KoqName`. */\n  koqName: string;\n  /** Unit system to use for formatting. */\n  unitSystem?: UnitSystemKey;\n}\n\n/**\n * An utility for formatting property values based on `KindOfQuantity` and unit system.\n * @public\n */\nexport class KoqPropertyValueFormatter {\n  private _unitsProvider: UnitsProvider;\n  private _defaultFormats?: FormatsMap;\n\n  constructor(\n    private _schemaContext: SchemaContext,\n    defaultFormats?: FormatsMap,\n  ) {\n    this._unitsProvider = new SchemaUnitProvider(_schemaContext);\n    this._defaultFormats = defaultFormats\n      ? Object.entries(defaultFormats).reduce((acc, [phenomenon, unitSystemFormats]) => ({ ...acc, [phenomenon.toUpperCase()]: unitSystemFormats }), {})\n      : /* c8 ignore next */ undefined;\n  }\n\n  public async format(value: number, options: FormatOptions) {\n    const formatterSpec = await this.getFormatterSpec(options);\n    if (!formatterSpec) {\n      return undefined;\n    }\n    return formatterSpec.applyFormatting(value);\n  }\n\n  public async getFormatterSpec(options: FormatOptions) {\n    const formattingProps = await getFormattingProps(this._schemaContext, this._defaultFormats, options);\n    if (!formattingProps) {\n      return undefined;\n    }\n    const { formatProps, persistenceUnitName } = formattingProps;\n    const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);\n    const format = await Format.createFromJSON(\"\", this._unitsProvider, formatProps);\n    return FormatterSpec.create(\"\", format, this._unitsProvider, persistenceUnit);\n  }\n\n  public async getParserSpec(options: FormatOptions) {\n    const formattingProps = await getFormattingProps(this._schemaContext, this._defaultFormats, options);\n    if (!formattingProps) {\n      return undefined;\n    }\n    const { formatProps, persistenceUnitName } = formattingProps;\n    const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);\n    const format = await Format.createFromJSON(\"\", this._unitsProvider, formatProps);\n    return ParserSpec.create(format, this._unitsProvider, persistenceUnit);\n  }\n}\n\ninterface FormattingProps {\n  formatProps: FormatProps;\n  persistenceUnitName: string;\n}\n\nasync function getFormattingProps(\n  schemaLocater: SchemaContext,\n  defaultFormats: FormatsMap | undefined,\n  options: FormatOptions,\n): Promise<FormattingProps | undefined> {\n  const { koqName, unitSystem } = options;\n\n  const koq = await getKoq(schemaLocater, koqName);\n  if (!koq) {\n    return undefined;\n  }\n\n  const persistenceUnit = await koq.persistenceUnit;\n  /* c8 ignore next 3 */\n  if (!persistenceUnit) {\n    return undefined;\n  }\n\n  const formatProps = await getKoqFormatProps(koq, persistenceUnit, defaultFormats, unitSystem);\n  if (!formatProps) {\n    return undefined;\n  }\n\n  return { formatProps, persistenceUnitName: persistenceUnit.fullName };\n}\n\nasync function getKoq(schemaLocater: SchemaContext, fullName: string) {\n  const [schemaName, propKoqName] = fullName.split(\":\");\n  const schema = await schemaLocater.getSchema(new SchemaKey(schemaName), SchemaMatchType.Latest);\n  if (!schema) {\n    return undefined;\n  }\n  return schema.getItem(propKoqName, KindOfQuantity);\n}\n\nasync function getKoqFormatProps(\n  koq: KindOfQuantity,\n  persistenceUnit: Unit | InvertedUnit,\n  defaultFormats: FormatsMap | undefined,\n  unitSystem?: UnitSystemKey,\n) {\n  const unitSystemMatchers = getUnitSystemGroupMatchers(unitSystem);\n  // use one of KOQ presentation format that matches requested unit system\n  const presentationFormat = await getKoqPresentationFormat(koq, unitSystemMatchers);\n  if (presentationFormat) {\n    return getFormatProps(presentationFormat);\n  }\n\n  // use one of the formats in default formats map if there is one for matching phenomena and requested unit\n  // system combination\n  if (defaultFormats && unitSystem) {\n    const actualPersistenceUnit = persistenceUnit instanceof InvertedUnit ? /* c8 ignore next */ await persistenceUnit.invertsUnit : persistenceUnit;\n    const phenomenon = await actualPersistenceUnit?.phenomenon;\n    if (phenomenon && defaultFormats[phenomenon.name.toUpperCase()]) {\n      const defaultPhenomenonFormats = defaultFormats[phenomenon.name.toUpperCase()];\n      for (const defaultUnitSystemFormat of Array.isArray(defaultPhenomenonFormats)\n        ? /* c8 ignore next */ defaultPhenomenonFormats\n        : [defaultPhenomenonFormats]) {\n        if (defaultUnitSystemFormat.unitSystems.includes(unitSystem)) {\n          return defaultUnitSystemFormat.format;\n        }\n      }\n    }\n  }\n\n  // use persistence unit format if it matches requested unit system and matching presentation format was not found\n  const persistenceUnitSystem = await persistenceUnit.unitSystem;\n  if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {\n    return getPersistenceUnitFormatProps(persistenceUnit);\n  }\n\n  // use default presentation format if persistence unit does not match requested unit system\n  if (koq.defaultPresentationFormat) {\n    return getFormatProps(await koq.defaultPresentationFormat);\n  }\n\n  return undefined;\n}\n\nasync function getKoqPresentationFormat(koq: KindOfQuantity, unitSystemMatchers: Array<(unitSystem: UnitSystem) => boolean>) {\n  const presentationFormats = koq.presentationFormats;\n  for (const matcher of unitSystemMatchers) {\n    for (const lazyFormat of presentationFormats) {\n      const format = await lazyFormat;\n      const lazyUnit = format.units && format.units[0][0];\n      /* c8 ignore next 3 */\n      if (!lazyUnit) {\n        continue;\n      }\n      const unit = await lazyUnit;\n      const currentUnitSystem = await unit.unitSystem;\n      if (currentUnitSystem && matcher(currentUnitSystem)) {\n        return format;\n      }\n    }\n  }\n  return undefined;\n}\n\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\n  // Same as Format \"DefaultRealU\" in Formats ecschema\n  return {\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\n    precision: 6,\n    type: \"Decimal\",\n    uomSeparator: \" \",\n    decimalSeparator: \".\",\n    composite: {\n      units: [\n        {\n          name: persistenceUnit.fullName,\n          label: persistenceUnit.label,\n        },\n      ],\n    },\n  };\n}\n\nfunction getUnitSystemGroupMatchers(groupKey?: UnitSystemKey) {\n  function createMatcher(name: string | string[]) {\n    const names = Array.isArray(name) ? name : [name];\n    return (unitSystem: UnitSystem) => names.some((n) => n === unitSystem.name.toUpperCase());\n  }\n  switch (groupKey) {\n    case \"imperial\":\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"metric\":\n      return [[\"SI\", \"METRIC\"], \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usCustomary\":\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usSurvey\":\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n  }\n  return [];\n}\n"]}
+{"version":3,"file":"KoqPropertyValueFormatter.js","sourceRoot":"","sources":["../../../src/presentation-common/KoqPropertyValueFormatter.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAgC,aAAa,EAAE,UAAU,EAAgC,MAAM,sBAAsB,CAAC;AACrI,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,qBAAqB,EAAE,SAAS,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAiE9J;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IAC5B,cAAc,CAAgB;IAC9B,cAAc,CAAgB;IAC9B,gBAAgB,CAAmB;IAC3C,4DAA4D;IACpD,eAAe,CAAc;IAMrC,4DAA4D;IAC5D,YAAY,oBAAoE,EAAE,cAA2B,EAAE,eAAiC;QAC9I,IAAI,oBAAoB,YAAY,aAAa,EAAE,CAAC;YAClD,IAAI,CAAC,cAAc,GAAG,oBAAoB,CAAC;YAC3C,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;YACxC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,oBAAoB,CAAC,aAAa,CAAC;YACzD,IAAI,CAAC,gBAAgB,GAAG,oBAAoB,CAAC,eAAe,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED,qBAAqB;IACrB,gBAAgB;IAChB,4DAA4D;IAC5D,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IACD,4DAA4D;IAC5D,IAAW,cAAc,CAAC,KAA6B;QACrD,IAAI,CAAC,eAAe,GAAG,KAAK;YAC1B,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,EAAE,CAAC;YACzI,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IACD,mBAAmB;IAEZ,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAsB;QACvD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,aAAa,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAsB;QAClD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAC;QAC7D,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QACtF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACjF,OAAO,aAAa,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAAsB;QAC/C,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAChE,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAC;QAC7D,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QACtF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACjF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,OAAsB;QAC9C,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAC5B,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,eAAe,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC;QAClD,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QAE1B,wDAAwD;QACxD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,QAAQ,CAAC;QAElD,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,IAAI,IAAI,qBAAqB,CAAC,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;QAC5G,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE7D,kGAAkG;QAClG,mGAAmG;QACnG,sDAAsD;QACtD,IAAI,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,MAAM,gBAAgB,CAAC,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,KAAK,UAAU,CAAC,EAAE,CAAC;YACxH,MAAM,kBAAkB,GAAG,MAAM,gCAAgC,CAAC;gBAChE,aAAa,EAAE,IAAI,CAAC,cAAc;gBAClC,UAAU,EAAE,IAAI,CAAC,eAAe;gBAChC,UAAU;gBACV,OAAO;aACR,CAAC,CAAC;YACH,IAAI,kBAAkB,EAAE,CAAC;gBACvB,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC;YAC5F,CAAC;QACH,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC;QACxE,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAOD,KAAK,UAAU,MAAM,CAAC,aAA4B,EAAE,QAAgB;IAClE,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAChG,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,aAA4B,EAAE,WAAwB;IACpF,MAAM,QAAQ,GAAG,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACtD,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACnB,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC1D,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,MAAM,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACvD,QAAQ,cAAc,CAAC,WAAW,EAAE,EAAE,CAAC;QACrC,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC;QAClB,KAAK,UAAU;YACb,OAAO,UAAU,CAAC;QACpB,KAAK,UAAU;YACb,OAAO,aAAa,CAAC;QACvB,KAAK,UAAU;YACb,OAAO,UAAU,CAAC;QACpB,sBAAsB;QACtB;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,gCAAgC,CAAC,EAC9C,aAAa,EACb,UAAU,EACV,UAAU,EACV,OAAO,GAOR;IACC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACjD,sBAAsB;IACtB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC;IAClD,sBAAsB;IACtB,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,qBAAqB,GAAG,eAAe,YAAY,YAAY,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC;IACjJ,MAAM,UAAU,GAAG,MAAM,qBAAqB,EAAE,UAAU,CAAC;IAC3D,IAAI,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAC5D,MAAM,wBAAwB,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC3E,KAAK,MAAM,uBAAuB,IAAI,KAAK,CAAC,OAAO,CAAC,wBAAwB,CAAC;YAC3E,CAAC,CAAC,oBAAoB,CAAC,wBAAwB;YAC/C,CAAC,CAAC,CAAC,wBAAwB,CAAC,EAAE,CAAC;YAC/B,IAAI,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7D,OAAO,uBAAuB,CAAC,MAAM,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,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 { assert } from \"@itwin/core-bentley\";\r\nimport { Format, FormatProps, FormatsProvider, FormatterSpec, ParserSpec, UnitsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\r\nimport { InvertedUnit, KindOfQuantity, SchemaContext, SchemaFormatsProvider, SchemaKey, SchemaMatchType, SchemaUnitProvider } from \"@itwin/ecschema-metadata\";\r\n\r\n/**\r\n * A data structure that associates unit systems with property value formatting props. The associations are used for\r\n * assigning formatting props for specific phenomenon and unit system combinations (see [[FormatsMap]]).\r\n *\r\n * @public\r\n *\r\n * @deprecated in 5.1 - will not be removed until after 2026-08-08. `FormatsMap` and related APIs have been deprecated in favor of [FormatsProvider]($core-quantity).\r\n */\r\nexport interface UnitSystemFormat {\r\n  unitSystems: UnitSystemKey[];\r\n  format: FormatProps;\r\n}\r\n\r\n/**\r\n * A data structure that associates specific phenomenon with one or more formatting props for specific unit system.\r\n *\r\n * Example:\r\n * ```json\r\n * {\r\n *   length: [{\r\n *     unitSystems: [\"metric\"],\r\n *     format: formatForCentimeters,\r\n *   }, {\r\n *     unitSystems: [\"imperial\", \"usCustomary\"],\r\n *     format: formatForInches,\r\n *   }, {\r\n *     unitSystems: [\"usSurvey\"],\r\n *     format: formatForUsSurveyInches,\r\n *   }]\r\n * }\r\n * ```\r\n *\r\n * @public\r\n *\r\n * @deprecated in 5.1 - will not be removed until after 2026-08-08. `FormatsMap` and related APIs have been deprecated in favor of [FormatsProvider]($core-quantity).\r\n */\r\nexport interface FormatsMap {\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  [phenomenon: string]: UnitSystemFormat | UnitSystemFormat[];\r\n}\r\n\r\n/**\r\n * Options for finding a formatter spec to use in [[KoqPropertyValueFormatter]].\r\n * @public\r\n */\r\nexport interface FormatOptions {\r\n  /** Full name of the `KindOfQuantity`, e.g. `SchemaName:KoqName`. */\r\n  koqName: string;\r\n  /** Unit system to use for formatting. */\r\n  unitSystem?: UnitSystemKey;\r\n}\r\n\r\n/**\r\n * Props for creating [[KoqPropertyValueFormatter]].\r\n * @public\r\n */\r\ninterface KoqPropertyValueFormatterProps {\r\n  /** Schema context to use for locating units, formats, etc. Generally retrieved through the `schemaContext` getter on an iModel. */\r\n  schemaContext: SchemaContext;\r\n  /** Formats provider to use for finding formatting props. Defaults to [SchemaFormatsProvider]($ecschema-metadata) when not supplied. */\r\n  formatsProvider?: FormatsProvider;\r\n}\r\n\r\n/**\r\n * An utility for formatting property values based on `KindOfQuantity` and unit system.\r\n * @public\r\n */\r\nexport class KoqPropertyValueFormatter {\r\n  private _schemaContext: SchemaContext;\r\n  private _unitsProvider: UnitsProvider;\r\n  private _formatsProvider?: FormatsProvider;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  private _defaultFormats?: FormatsMap;\r\n\r\n  /** @deprecated in 5.1 - will not be removed until after 2026-08-08. Use the overload that takes a props object. */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  constructor(schemaContext: SchemaContext, defaultFormats?: FormatsMap, formatsProvider?: FormatsProvider);\r\n  constructor(props: KoqPropertyValueFormatterProps);\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  constructor(schemaContextOrProps: SchemaContext | KoqPropertyValueFormatterProps, defaultFormats?: FormatsMap, formatsProvider?: FormatsProvider) {\r\n    if (schemaContextOrProps instanceof SchemaContext) {\r\n      this._schemaContext = schemaContextOrProps;\r\n      this._formatsProvider = formatsProvider;\r\n      this.defaultFormats = defaultFormats;\r\n    } else {\r\n      this._schemaContext = schemaContextOrProps.schemaContext;\r\n      this._formatsProvider = schemaContextOrProps.formatsProvider;\r\n    }\r\n    this._unitsProvider = new SchemaUnitProvider(this._schemaContext);\r\n  }\r\n\r\n  /* c8 ignore start */\r\n  /** @internal */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public get defaultFormats(): FormatsMap | undefined {\r\n    return this._defaultFormats;\r\n  }\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public set defaultFormats(value: FormatsMap | undefined) {\r\n    this._defaultFormats = value\r\n      ? Object.entries(value).reduce((acc, [phenomenon, unitSystemFormats]) => ({ ...acc, [phenomenon.toUpperCase()]: unitSystemFormats }), {})\r\n      : undefined;\r\n  }\r\n  /* c8 ignore end */\r\n\r\n  public async format(value: number, options: FormatOptions) {\r\n    const formatterSpec = await this.getFormatterSpec(options);\r\n    if (!formatterSpec) {\r\n      return undefined;\r\n    }\r\n    return formatterSpec.applyFormatting(value);\r\n  }\r\n\r\n  public async getFormatterSpec(options: FormatOptions) {\r\n    const formattingProps = await this.#getFormattingProps(options);\r\n    if (!formattingProps) {\r\n      return undefined;\r\n    }\r\n    const { formatProps, persistenceUnitName } = formattingProps;\r\n    const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);\r\n    const format = await Format.createFromJSON(\"\", this._unitsProvider, formatProps);\r\n    return FormatterSpec.create(\"\", format, this._unitsProvider, persistenceUnit);\r\n  }\r\n\r\n  public async getParserSpec(options: FormatOptions) {\r\n    const formattingProps = await this.#getFormattingProps(options);\r\n    if (!formattingProps) {\r\n      return undefined;\r\n    }\r\n    const { formatProps, persistenceUnitName } = formattingProps;\r\n    const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);\r\n    const format = await Format.createFromJSON(\"\", this._unitsProvider, formatProps);\r\n    return ParserSpec.create(format, this._unitsProvider, persistenceUnit);\r\n  }\r\n\r\n  async #getFormattingProps(options: FormatOptions): Promise<FormattingProps | undefined> {\r\n    const { koqName } = options;\r\n    const koq = await getKoq(this._schemaContext, koqName);\r\n    if (!koq) {\r\n      return undefined;\r\n    }\r\n    const persistenceUnit = await koq.persistenceUnit;\r\n    assert(!!persistenceUnit);\r\n\r\n    // default to metric as it's the persistence unit system\r\n    const unitSystem = options.unitSystem ?? \"metric\";\r\n\r\n    const formatsProvider = this._formatsProvider ?? new SchemaFormatsProvider(this._schemaContext, unitSystem);\r\n    const formatProps = await formatsProvider.getFormat(koqName);\r\n\r\n    // `SchemaFormatsProvider` will fall back to default presentation format, but we want to fall back\r\n    // to default formats' map first, and only then to the default presentation format. All of this can\r\n    // be removed with the removal of default formats map.\r\n    if (this._defaultFormats && (!formatProps || (await getUnitSystemKey(this._unitsProvider, formatProps)) !== unitSystem)) {\r\n      const defaultFormatProps = await getFormatPropsFromDefaultFormats({\r\n        schemaContext: this._schemaContext,\r\n        formatsMap: this._defaultFormats,\r\n        unitSystem,\r\n        koqName,\r\n      });\r\n      if (defaultFormatProps) {\r\n        return { formatProps: defaultFormatProps, persistenceUnitName: persistenceUnit.fullName };\r\n      }\r\n    }\r\n\r\n    if (formatProps) {\r\n      return { formatProps, persistenceUnitName: persistenceUnit.fullName };\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n}\r\n\r\ninterface FormattingProps {\r\n  formatProps: FormatProps;\r\n  persistenceUnitName: string;\r\n}\r\n\r\nasync function getKoq(schemaLocater: SchemaContext, fullName: string) {\r\n  const [schemaName, propKoqName] = fullName.split(\":\");\r\n  const schema = await schemaLocater.getSchema(new SchemaKey(schemaName), SchemaMatchType.Latest);\r\n  if (!schema) {\r\n    return undefined;\r\n  }\r\n  return schema.getItem(propKoqName, KindOfQuantity);\r\n}\r\n\r\nasync function getUnitSystemKey(unitsProvider: UnitsProvider, formatProps: FormatProps): Promise<UnitSystemKey | undefined> {\r\n  const unitName = formatProps.composite?.units[0].name;\r\n  assert(!!unitName);\r\n  const unit = await unitsProvider.findUnitByName(unitName);\r\n  assert(!!unit);\r\n  const [_, unitSystemName] = unit.system.split(/[\\.:]/);\r\n  switch (unitSystemName.toUpperCase()) {\r\n    case \"METRIC\":\r\n      return \"metric\";\r\n    case \"IMPERIAL\":\r\n      return \"imperial\";\r\n    case \"USCUSTOM\":\r\n      return \"usCustomary\";\r\n    case \"USSURVEY\":\r\n      return \"usSurvey\";\r\n    /* c8 ignore next 2 */\r\n    default:\r\n      return undefined;\r\n  }\r\n}\r\n\r\nasync function getFormatPropsFromDefaultFormats({\r\n  schemaContext,\r\n  formatsMap,\r\n  unitSystem,\r\n  koqName,\r\n}: {\r\n  schemaContext: SchemaContext;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  formatsMap: FormatsMap;\r\n  unitSystem: UnitSystemKey;\r\n  koqName: string;\r\n}): Promise<FormatProps | undefined> {\r\n  const koq = await getKoq(schemaContext, koqName);\r\n  /* c8 ignore next 3 */\r\n  if (!koq) {\r\n    return undefined;\r\n  }\r\n\r\n  const persistenceUnit = await koq.persistenceUnit;\r\n  /* c8 ignore next 3 */\r\n  if (!persistenceUnit) {\r\n    return undefined;\r\n  }\r\n  const actualPersistenceUnit = persistenceUnit instanceof InvertedUnit ? /* c8 ignore next */ await persistenceUnit.invertsUnit : persistenceUnit;\r\n  const phenomenon = await actualPersistenceUnit?.phenomenon;\r\n  if (phenomenon && formatsMap[phenomenon.name.toUpperCase()]) {\r\n    const defaultPhenomenonFormats = formatsMap[phenomenon.name.toUpperCase()];\r\n    for (const defaultUnitSystemFormat of Array.isArray(defaultPhenomenonFormats)\r\n      ? /* c8 ignore next */ defaultPhenomenonFormats\r\n      : [defaultPhenomenonFormats]) {\r\n      if (defaultUnitSystemFormat.unitSystems.includes(unitSystem)) {\r\n        return defaultUnitSystemFormat.format;\r\n      }\r\n    }\r\n  }\r\n  return undefined;\r\n}\r\n"]}

package/lib/esm/presentation-common/LabelDefinition.js.map

@@ -1 +1 @@
-{"version":3,"file":"LabelDefinition.js","sourceRoot":"","sources":["../../../src/presentation-common/LabelDefinition.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AA8BH,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAAG,WAAW,CAAC;AAE/D,cAAc;AACd,MAAM,KAAW,eAAe,CAoB/B;AApBD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,SAAgB,qBAAqB,CAAC,GAAoB;QACxD,OAAO,GAAG,CAAC,QAAQ,KAAK,mCAAmC,CAAC;IAC9D,CAAC;IAFe,qCAAqB,wBAEpC,CAAA;IAED;;;OAGG;IACH,SAAgB,eAAe,CAAC,KAAa;QAC3C,OAAO;YACL,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,QAAQ;SACnB,CAAC;IACJ,CAAC;IANe,+BAAe,kBAM9B,CAAA;AACH,CAAC,EApBgB,eAAe,KAAf,eAAe,QAoB/B","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 Hierarchies\n */\n\n/**\n * Data structure that describes raw composite label value.\n * @public\n */\nexport interface LabelCompositeValue {\n  separator: string;\n  values: LabelDefinition[];\n}\n\n/**\n * Type definition of label raw value.\n * @public\n */\nexport type LabelRawValue = string | number | boolean | LabelCompositeValue;\n\n/**\n * Data structure that describes label definition.\n * @public\n */\nexport interface LabelDefinition {\n  /** Display value of label */\n  displayValue: string;\n  /** Raw value of label */\n  rawValue: LabelRawValue;\n  /** Type name of raw value */\n  typeName: string;\n}\n\n/** @internal */\nexport const COMPOSITE_LABEL_DEFINITION_TYPENAME = \"composite\";\n\n/** @public */\nexport namespace LabelDefinition {\n  /**\n   * Checks if provided [[LabelDefinition]] has raw value of type [[LabelCompositeValue]].\n   * @public\n   */\n  export function isCompositeDefinition(def: LabelDefinition): def is LabelDefinition & { rawValue: LabelCompositeValue } {\n    return def.typeName === COMPOSITE_LABEL_DEFINITION_TYPENAME;\n  }\n\n  /**\n   * Creates [[LabelDefinition]] from string value.\n   * @public\n   */\n  export function fromLabelString(label: string): LabelDefinition {\n    return {\n      displayValue: label,\n      rawValue: label,\n      typeName: \"string\",\n    };\n  }\n}\n"]}
+{"version":3,"file":"LabelDefinition.js","sourceRoot":"","sources":["../../../src/presentation-common/LabelDefinition.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AA8BH,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAAG,WAAW,CAAC;AAE/D,cAAc;AACd,MAAM,KAAW,eAAe,CAoB/B;AApBD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,SAAgB,qBAAqB,CAAC,GAAoB;QACxD,OAAO,GAAG,CAAC,QAAQ,KAAK,mCAAmC,CAAC;IAC9D,CAAC;IAFe,qCAAqB,wBAEpC,CAAA;IAED;;;OAGG;IACH,SAAgB,eAAe,CAAC,KAAa;QAC3C,OAAO;YACL,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,QAAQ;SACnB,CAAC;IACJ,CAAC;IANe,+BAAe,kBAM9B,CAAA;AACH,CAAC,EApBgB,eAAe,KAAf,eAAe,QAoB/B","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 Hierarchies\r\n */\r\n\r\n/**\r\n * Data structure that describes raw composite label value.\r\n * @public\r\n */\r\nexport interface LabelCompositeValue {\r\n  separator: string;\r\n  values: LabelDefinition[];\r\n}\r\n\r\n/**\r\n * Type definition of label raw value.\r\n * @public\r\n */\r\nexport type LabelRawValue = string | number | boolean | LabelCompositeValue;\r\n\r\n/**\r\n * Data structure that describes label definition.\r\n * @public\r\n */\r\nexport interface LabelDefinition {\r\n  /** Display value of label */\r\n  displayValue: string;\r\n  /** Raw value of label */\r\n  rawValue: LabelRawValue;\r\n  /** Type name of raw value */\r\n  typeName: string;\r\n}\r\n\r\n/** @internal */\r\nexport const COMPOSITE_LABEL_DEFINITION_TYPENAME = \"composite\";\r\n\r\n/** @public */\r\nexport namespace LabelDefinition {\r\n  /**\r\n   * Checks if provided [[LabelDefinition]] has raw value of type [[LabelCompositeValue]].\r\n   * @public\r\n   */\r\n  export function isCompositeDefinition(def: LabelDefinition): def is LabelDefinition & { rawValue: LabelCompositeValue } {\r\n    return def.typeName === COMPOSITE_LABEL_DEFINITION_TYPENAME;\r\n  }\r\n\r\n  /**\r\n   * Creates [[LabelDefinition]] from string value.\r\n   * @public\r\n   */\r\n  export function fromLabelString(label: string): LabelDefinition {\r\n    return {\r\n      displayValue: label,\r\n      rawValue: label,\r\n      typeName: \"string\",\r\n    };\r\n  }\r\n}\r\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"LocalizationHelper.js","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD,OAAO,EAAE,YAAY,EAAqB,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAI5E,OAAO,EAAE,mCAAmC,EAAwC,MAAM,sBAAsB,CAAC;AAEjH,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAMlD,gBAAgB;AAChB,MAAM,OAAO,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;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,mCAAmC,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,UAAU,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,OAAO,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,KAAK,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,KAAK,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,KAAK,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,KAAK,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;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;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,YAAY,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","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.js\";\nimport { Content } from \"./content/Content.js\";\nimport { Descriptor } from \"./content/Descriptor.js\";\nimport { Field } from \"./content/Fields.js\";\nimport { Item } from \"./content/Item.js\";\nimport { DisplayValue, DisplayValueGroup, Value } from \"./content/Value.js\";\nimport { ElementProperties } from \"./ElementProperties.js\";\nimport { Node } from \"./hierarchy/Node.js\";\nimport { NodePathElement } from \"./hierarchy/NodePathElement.js\";\nimport { COMPOSITE_LABEL_DEFINITION_TYPENAME, LabelCompositeValue, LabelDefinition } from \"./LabelDefinition.js\";\n\nconst KEY_PATTERN = /@[\\w\\d\\-_]+:[\\w\\d\\-\\._]+?@/g;\n\ninterface 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 === COMPOSITE_LABEL_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    if (Value.isArray(value)) {\n      return value.map((v) => this.getLocalizedRawValue(v));\n    }\n    if (Value.isMap(value)) {\n      return Object.entries(value).reduce((o, [k, v]) => ({ ...o, [k]: this.getLocalizedRawValue(v) }), {});\n    }\n    return value;\n  }\n\n  // warning: this function mutates the field\n  private getLocalizedContentField<TField extends Field>(field: TField) {\n    field.label = this.getLocalizedString(field.label);\n    if (field.isPropertiesField()) {\n      if (field.isStructPropertiesField()) {\n        field.memberFields = field.memberFields.map((m) => this.getLocalizedContentField(m));\n      } else if (field.isArrayPropertiesField()) {\n        field.itemsField = this.getLocalizedContentField(field.itemsField);\n      }\n    } else if (field.isNestedContentField()) {\n      field.nestedFields = field.nestedFields.map((m) => this.getLocalizedContentField(m));\n    }\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  public getLocalizedNode(node: 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 (DisplayValue.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"]}
+{"version":3,"file":"LocalizationHelper.js","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD,OAAO,EAAE,YAAY,EAAqB,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAI5E,OAAO,EAAE,mCAAmC,EAAwC,MAAM,sBAAsB,CAAC;AAEjH,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAMlD,gBAAgB;AAChB,MAAM,OAAO,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;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,mCAAmC,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,UAAU,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,OAAO,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,KAAK,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,KAAK,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,KAAK,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,KAAK,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;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;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,YAAY,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","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  public getLocalizedNodes(nodes: Node[]): Node[] {\r\n    return nodes.map((n) => this.getLocalizedNode(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\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  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  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"]}

package/lib/esm/presentation-common/PresentationIpcInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"PresentationIpcInterface.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationIpcInterface.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAIH,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GAAG,oCAAoC,CAAC;AAyBlF,gBAAgB;AAChB,MAAM,CAAN,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,yDAAgC,CAAA;AAClC,CAAC,EALW,qBAAqB,KAArB,qBAAqB,QAKhC","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 { RulesetVariableJSON } from \"./RulesetVariables.js\";\n\n/** @internal */\nexport const PRESENTATION_IPC_CHANNEL_NAME = \"itwinjs-presentation/ipc-interface\";\n\ninterface CommonIpcParams {\n  clientId: string;\n}\n\ninterface SetRulesetVariableParams<TVariable> extends CommonIpcParams {\n  rulesetId: string;\n  variable: TVariable;\n}\n\ninterface UnsetRulesetVariableParams extends CommonIpcParams {\n  rulesetId: string;\n  variableId: string;\n}\n\n/** @internal */\nexport interface PresentationIpcInterface {\n  /** Sets ruleset variable value. */\n  setRulesetVariable(params: SetRulesetVariableParams<RulesetVariableJSON>): Promise<void>;\n\n  /** Unsets ruleset variable value. */\n  unsetRulesetVariable(params: UnsetRulesetVariableParams): Promise<void>;\n}\n\n/** @internal */\nexport enum PresentationIpcEvents {\n  /**\n   * ID of an event that's emitted when backend detects changes in presented data.\n   */\n  Update = \"presentation.onUpdate\",\n}\n"]}
+{"version":3,"file":"PresentationIpcInterface.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationIpcInterface.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAIH,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GAAG,oCAAoC,CAAC;AAyBlF,gBAAgB;AAChB,MAAM,CAAN,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,yDAAgC,CAAA;AAClC,CAAC,EALW,qBAAqB,KAArB,qBAAqB,QAKhC","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 { RulesetVariableJSON } from \"./RulesetVariables.js\";\r\n\r\n/** @internal */\r\nexport const PRESENTATION_IPC_CHANNEL_NAME = \"itwinjs-presentation/ipc-interface\";\r\n\r\ninterface CommonIpcParams {\r\n  clientId: string;\r\n}\r\n\r\ninterface SetRulesetVariableParams<TVariable> extends CommonIpcParams {\r\n  rulesetId: string;\r\n  variable: TVariable;\r\n}\r\n\r\ninterface UnsetRulesetVariableParams extends CommonIpcParams {\r\n  rulesetId: string;\r\n  variableId: string;\r\n}\r\n\r\n/** @internal */\r\nexport interface PresentationIpcInterface {\r\n  /** Sets ruleset variable value. */\r\n  setRulesetVariable(params: SetRulesetVariableParams<RulesetVariableJSON>): Promise<void>;\r\n\r\n  /** Unsets ruleset variable value. */\r\n  unsetRulesetVariable(params: UnsetRulesetVariableParams): Promise<void>;\r\n}\r\n\r\n/** @internal */\r\nexport enum PresentationIpcEvents {\r\n  /**\r\n   * ID of an event that's emitted when backend detects changes in presented data.\r\n   */\r\n  Update = \"presentation.onUpdate\",\r\n}\r\n"]}

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

@@ -152,7 +152,7 @@ export interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRu
 /**
  * Request type for element properties requests
  * @public
- * @deprecated in 4.x. Use [[SingleElementPropertiesRequestOptions]] or [[MultiElementPropertiesRequestOptions]] directly.
+ * @deprecated in 4.4.0 - will not be removed until after 2026-06-13. Use [[SingleElementPropertiesRequestOptions]] or [[MultiElementPropertiesRequestOptions]] directly.
  */
 export type ElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>;
 /**
@@ -244,14 +244,14 @@ export interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends Requ
 /**
  * Request options used for selection scope related requests
  * @public
- * @deprecated in 5.0. Use `computeSelection` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `computeSelection` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.
  */
 export interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> {
 }
 /**
  * Request options used for calculating selection based on given instance keys and selection scope.
  * @public
- * @deprecated in 5.0. Use `computeSelection` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `computeSelection` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.
  */
 export interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {
     elementIds: Id64String[];

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

@@ -1 +1 @@
-{"version":3,"file":"PresentationManagerOptions.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationManagerOptions.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAuVH;;;GAGG;AACH,MAAM,UAAU,uCAAuC,CACrD,OAAuH;IAEvH,OAAQ,OAA0D,CAAC,SAAS,KAAK,SAAS,CAAC;AAC7F,CAAC","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.js\";\nimport { FieldDescriptor } from \"./content/Fields.js\";\nimport { Item } from \"./content/Item.js\";\nimport { InstanceKey } from \"./EC.js\";\nimport { ElementProperties } from \"./ElementProperties.js\";\nimport { InstanceFilterDefinition } from \"./InstanceFilterDefinition.js\";\nimport { Ruleset } from \"./rules/Ruleset.js\";\nimport { RulesetVariable } from \"./RulesetVariables.js\";\nimport { SelectionScopeProps } from \"./selection/SelectionScope.js\";\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/**\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  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   */\n  sizeLimit?: number;\n}\n\n/**\n * Params for hierarchy level descriptor requests.\n * @public\n */\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable>\n  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>\n  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>\n  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>\n  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 omitted or not.\n   * Content is returned without `displayValues` when this is set to `true`.\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>\n  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> =\n  | SingleElementPropertiesRequestOptions<TIModel>\n  | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>;\n\n/**\n * Request type for single element properties requests.\n * @public\n */\nexport interface SingleElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> extends RequestOptions<TIModel> {\n  /** ID of the element to get properties for. */\n  elementId: Id64String;\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   */\n  contentParser?: (descriptor: Descriptor, item: Item) => TParsedContent;\n}\n\n/**\n * Base request type for multiple elements properties requests.\n * @public\n */\nexport interface MultiElementPropertiesBaseRequestOptions<TIModel, TParsedContent = ElementProperties> extends RequestOptions<TIModel> {\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   */\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 * Request type for multiple elements properties requests, where elements are specified by class.\n * @public\n */\nexport interface MultiElementPropertiesByClassRequestOptions<TIModel, TParsedContent = ElementProperties>\n  extends MultiElementPropertiesBaseRequestOptions<TIModel, TParsedContent> {\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 * Request type for multiple elements properties requests, where elements are specified by element id.\n * @public\n */\nexport interface MultiElementPropertiesByIdsRequestOptions<TIModel, TParsedContent = ElementProperties>\n  extends MultiElementPropertiesBaseRequestOptions<TIModel, TParsedContent> {\n  /**\n   * A list of `bis.Element` IDs to get properties for.\n   */\n  elementIds?: Id64String[];\n}\n/**\n * Request type for multiple elements properties requests.\n * @public\n */\nexport type MultiElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> =\n  | MultiElementPropertiesByClassRequestOptions<TIModel, TParsedContent>\n  | MultiElementPropertiesByIdsRequestOptions<TIModel, TParsedContent>;\n\n/**\n * Request type for content instance keys' requests.\n * @public\n */\nexport interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable>\n  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 * @deprecated in 5.0. Use `computeSelection` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.\n */\nexport interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> {} // eslint-disable-line @typescript-eslint/no-empty-object-type\n\n/**\n * Request options used for calculating selection based on given instance keys and selection scope.\n * @public\n * @deprecated in 5.0. Use `computeSelection` from [@itwin/unified-selection](https://github.com/iTwin/presentation/blob/master/packages/unified-selection/README.md#selection-scopes) package instead.\n */\nexport interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  elementIds: Id64String[];\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  scope: SelectionScopeProps;\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 object> = 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 object> = 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>(\n  options: SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>,\n): 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 object> = 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;;;gGAGgG;AAChG;;GAEG;AAuVH;;;GAGG;AACH,MAAM,UAAU,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, 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 */\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 */\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 */\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 */\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 - will not be removed until after 2026-06-13. 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   * 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 to fine tune 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 - will not be removed until after 2026-06-13. 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 - will not be removed until after 2026-06-13. 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 */\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"]}