@itwin/presentation-common 4.0.0-dev.8 → 4.0.0-dev.81

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

@@ -0,0 +1,20 @@
+/** @packageDocumentation
+ * @module Core
+ */
+import { FormatterSpec, ParserSpec, UnitSystemKey } from "@itwin/core-quantity";
+import { SchemaContext } from "@itwin/ecschema-metadata";
+/** @alpha */
+export interface FormatOptions {
+    koqName: string;
+    unitSystem?: UnitSystemKey;
+}
+/** @alpha */
+export declare class KoqPropertyValueFormatter {
+    private _schemaContext;
+    private _unitsProvider;
+    constructor(_schemaContext: SchemaContext);
+    format(value: number, options: FormatOptions): Promise<string | undefined>;
+    getFormatterSpec(options: FormatOptions): Promise<FormatterSpec | undefined>;
+    getParserSpec(options: FormatOptions): Promise<ParserSpec | undefined>;
+}
+//# sourceMappingURL=KoqPropertyValueFormatter.d.ts.map

package/lib/esm/presentation-common/KoqPropertyValueFormatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KoqPropertyValueFormatter.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/KoqPropertyValueFormatter.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAuB,aAAa,EAAE,UAAU,EAAiB,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAC6E,aAAa,EAEhG,MAAM,0BAA0B,CAAC;AAElC,aAAa;AACb,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,aAAa,CAAC;CAC5B;AAED,aAAa;AACb,qBAAa,yBAAyB;IAGxB,OAAO,CAAC,cAAc;IAFlC,OAAO,CAAC,cAAc,CAAgB;gBAElB,cAAc,EAAE,aAAa;IAIpC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa;IAO5C,gBAAgB,CAAC,OAAO,EAAE,aAAa;IAUvC,aAAa,CAAC,OAAO,EAAE,aAAa;CASlD"}

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

@@ -0,0 +1,152 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+import { Format, FormatterSpec, ParserSpec } from "@itwin/core-quantity";
+import { OverrideFormat, SchemaKey, SchemaMatchType, SchemaUnitProvider, } from "@itwin/ecschema-metadata";
+/** @alpha */
+export class KoqPropertyValueFormatter {
+    constructor(_schemaContext) {
+        this._schemaContext = _schemaContext;
+        this._unitsProvider = new SchemaUnitProvider(_schemaContext);
+    }
+    async format(value, options) {
+        const formatterSpec = await this.getFormatterSpec(options);
+        if (!formatterSpec)
+            return undefined;
+        return formatterSpec.applyFormatting(value);
+    }
+    async getFormatterSpec(options) {
+        const formattingProps = await getFormattingProps(this._schemaContext, options);
+        if (!formattingProps)
+            return undefined;
+        const { formatProps, persistenceUnitName } = formattingProps;
+        const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);
+        const format = await Format.createFromJSON("", this._unitsProvider, formatProps);
+        return FormatterSpec.create("", format, this._unitsProvider, persistenceUnit);
+    }
+    async getParserSpec(options) {
+        const formattingProps = await getFormattingProps(this._schemaContext, options);
+        if (!formattingProps)
+            return undefined;
+        const { formatProps, persistenceUnitName } = formattingProps;
+        const persistenceUnit = await this._unitsProvider.findUnitByName(persistenceUnitName);
+        const format = await Format.createFromJSON("", this._unitsProvider, formatProps);
+        return ParserSpec.create(format, this._unitsProvider, persistenceUnit);
+    }
+}
+async function getFormattingProps(schemaLocater, options) {
+    const { koqName, unitSystem } = options;
+    const koq = await getKoq(schemaLocater, koqName);
+    if (!koq)
+        return undefined;
+    const persistenceUnit = await koq.persistenceUnit;
+    // istanbul ignore if
+    if (!persistenceUnit)
+        return undefined;
+    const formatProps = await getKoqFormatProps(koq, persistenceUnit, unitSystem);
+    if (!formatProps)
+        return undefined;
+    return { formatProps, persistenceUnitName: persistenceUnit.fullName };
+}
+async function getKoq(schemaLocater, fullName) {
+    const [schemaName, propKoqName] = fullName.split(":");
+    const schema = await schemaLocater.getSchema(new SchemaKey(schemaName), SchemaMatchType.Latest);
+    if (!schema)
+        return undefined;
+    return schema.getItem(propKoqName);
+}
+async function getKoqFormatProps(koq, persistenceUnit, unitSystem) {
+    const unitSystems = getUnitSystemGroupNames(unitSystem);
+    // use one of KOQ presentation format that matches requested unit system
+    const presentationFormat = await getKoqPresentationFormat(koq, unitSystems);
+    if (presentationFormat)
+        return formatToFormatProps(presentationFormat);
+    // use persistence unit format if it matches requested unit system and matching presentation format was not found
+    const persistenceUnitSystem = await persistenceUnit.unitSystem;
+    if (persistenceUnitSystem && unitSystems.includes(persistenceUnitSystem.name.toUpperCase()))
+        return getPersistenceUnitFormatProps(persistenceUnit);
+    // use default presentation format if persistence unit does not match requested unit system
+    if (koq.defaultPresentationFormat)
+        return formatToFormatProps(koq.defaultPresentationFormat);
+    return undefined;
+}
+async function getKoqPresentationFormat(koq, unitSystems) {
+    const presentationFormats = koq.presentationFormats;
+    for (const system of unitSystems) {
+        for (const format of presentationFormats) {
+            const unit = format.units && format.units[0][0];
+            // istanbul ignore if
+            if (!unit)
+                continue;
+            const currentUnitSystem = await unit.unitSystem;
+            if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system)
+                return format;
+        }
+    }
+    return undefined;
+}
+function formatToFormatProps(format) {
+    // istanbul ignore if
+    if (OverrideFormat.isOverrideFormat(format)) {
+        const baseFormat = baseFormatToFormatProps(format.parent);
+        return {
+            ...baseFormat,
+            composite: format.units
+                ? {
+                    ...baseFormat.composite,
+                    units: format.units.map(([unit, _]) => ({ name: unit.fullName, label: unit.label })),
+                    spacer: format.spacer,
+                    includeZero: format.includeZero,
+                }
+                : baseFormat.composite,
+        };
+    }
+    return baseFormatToFormatProps(format);
+}
+function baseFormatToFormatProps(format) {
+    const json = format.toJSON();
+    return {
+        ...json,
+        composite: json.composite
+            ? {
+                ...json.composite,
+                spacer: format.spacer,
+                includeZero: format.includeZero,
+            }
+            : /* istanbul ignore next */ 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 getUnitSystemGroupNames(unitSystem) {
+    switch (unitSystem) {
+        case "imperial":
+            return ["IMPERIAL", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "metric":
+            return ["SI", "METRIC", "INTERNATIONAL", "FINANCE"];
+        case "usCustomary":
+            return ["USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "usSurvey":
+            return ["USSURVEY", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+    }
+    return [];
+}
+//# sourceMappingURL=KoqPropertyValueFormatter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KoqPropertyValueFormatter.js","sourceRoot":"","sources":["../../../src/presentation-common/KoqPropertyValueFormatter.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAe,aAAa,EAAE,UAAU,EAAgC,MAAM,sBAAsB,CAAC;AACpH,OAAO,EAC6D,cAAc,EAAiB,SAAS,EAAE,eAAe,EAAE,kBAAkB,GAEhJ,MAAM,0BAA0B,CAAC;AAQlC,aAAa;AACb,MAAM,OAAO,yBAAyB;IAGpC,YAAoB,cAA6B;QAA7B,mBAAc,GAAd,cAAc,CAAe;QAC/C,IAAI,CAAC,cAAc,GAAG,IAAI,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAC/D,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;YAChB,OAAO,SAAS,CAAC;QACnB,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,OAAO,CAAC,CAAC;QAC/E,IAAI,CAAC,eAAe;YAClB,OAAO,SAAS,CAAC;QACnB,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,OAAO,CAAC,CAAC;QAC/E,IAAI,CAAC,eAAe;YAClB,OAAO,SAAS,CAAC;QACnB,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,CAAC,aAA6B,EAAE,OAAsB;IACrF,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;QACN,OAAO,SAAS,CAAC;IAEnB,MAAM,eAAe,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC;IAClD,qBAAqB;IACrB,IAAI,CAAC,eAAe;QAClB,OAAO,SAAS,CAAC;IAEnB,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;IAC9E,IAAI,CAAC,WAAW;QACd,OAAO,SAAS,CAAC;IAEnB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC;AACxE,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,aAA6B,EAAE,QAAgB;IACnE,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;QACT,OAAO,SAAS,CAAC;IAEnB,OAAO,MAAM,CAAC,OAAO,CAAiB,WAAW,CAAC,CAAC;AACrD,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,GAAmB,EAAE,eAAoC,EAAE,UAA0B;IACpH,MAAM,WAAW,GAAG,uBAAuB,CAAC,UAAU,CAAC,CAAC;IACxD,wEAAwE;IACxE,MAAM,kBAAkB,GAAG,MAAM,wBAAwB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAC5E,IAAI,kBAAkB;QACpB,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;IAEjD,iHAAiH;IACjH,MAAM,qBAAqB,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC;IAC/D,IAAI,qBAAqB,IAAI,WAAW,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACzF,OAAO,6BAA6B,CAAC,eAAe,CAAC,CAAC;IAExD,2FAA2F;IAC3F,IAAI,GAAG,CAAC,yBAAyB;QAC/B,OAAO,mBAAmB,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAE5D,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,wBAAwB,CAAC,GAAmB,EAAE,WAAqB;IAChF,MAAM,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IACpD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE;QAChC,KAAK,MAAM,MAAM,IAAI,mBAAmB,EAAE;YACxC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChD,qBAAqB;YACrB,IAAI,CAAC,IAAI;gBACP,SAAS;YAEX,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;YAChD,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,MAAM;gBACtE,OAAO,MAAM,CAAC;SACjB;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAiC;IAC5D,qBAAqB;IACrB,IAAI,cAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;QAC3C,MAAM,UAAU,GAAG,uBAAuB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO;YACL,GAAG,UAAU;YACb,SAAS,EAAE,MAAM,CAAC,KAAK;gBACrB,CAAC,CAAC;oBACA,GAAG,UAAU,CAAC,SAAS;oBACvB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;oBACpF,MAAM,EAAE,MAAM,CAAC,MAAM;oBACrB,WAAW,EAAE,MAAM,CAAC,WAAW;iBAChC;gBACD,CAAC,CAAC,UAAU,CAAC,SAAS;SACzB,CAAC;KACH;IACD,OAAO,uBAAuB,CAAC,MAAM,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAgB;IAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;IAC7B,OAAO;QACL,GAAG,IAAI;QACP,SAAS,EAAE,IAAI,CAAC,SAAS;YACvB,CAAC,CAAC;gBACA,GAAG,IAAI,CAAC,SAAS;gBACjB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,WAAW,EAAE,MAAM,CAAC,WAAW;aAChC;YACD,CAAC,CAAC,0BAA0B,CAAC,SAAS;KACzC,CAAC;AACJ,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,CAAC;oBACN,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B,CAAC;SACH;KACF,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,UAA0B;IACzD,QAAQ,UAAU,EAAE;QAClB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QAC9D,KAAK,QAAQ;YACX,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtD,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QAClD,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;KAC/D;IACD,OAAO,EAAE,CAAC;AACZ,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 { Format, FormatProps, FormatterSpec, ParserSpec, UnitsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\r\nimport {\r\n  Format as ECFormat, InvertedUnit, ISchemaLocater, KindOfQuantity, OverrideFormat, SchemaContext, SchemaKey, SchemaMatchType, SchemaUnitProvider,\r\n  Unit,\r\n} from \"@itwin/ecschema-metadata\";\r\n\r\n/** @alpha */\r\nexport interface FormatOptions {\r\n  koqName: string;\r\n  unitSystem?: UnitSystemKey;\r\n}\r\n\r\n/** @alpha */\r\nexport class KoqPropertyValueFormatter {\r\n  private _unitsProvider: UnitsProvider;\r\n\r\n  constructor(private _schemaContext: SchemaContext) {\r\n    this._unitsProvider = new SchemaUnitProvider(_schemaContext);\r\n  }\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    return formatterSpec.applyFormatting(value);\r\n  }\r\n\r\n  public async getFormatterSpec(options: FormatOptions) {\r\n    const formattingProps = await getFormattingProps(this._schemaContext, options);\r\n    if (!formattingProps)\r\n      return undefined;\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 getFormattingProps(this._schemaContext, options);\r\n    if (!formattingProps)\r\n      return undefined;\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\r\ninterface FormattingProps {\r\n  formatProps: FormatProps;\r\n  persistenceUnitName: string;\r\n}\r\n\r\nasync function getFormattingProps(schemaLocater: ISchemaLocater, options: FormatOptions): Promise<FormattingProps | undefined> {\r\n  const { koqName, unitSystem } = options;\r\n\r\n  const koq = await getKoq(schemaLocater, koqName);\r\n  if (!koq)\r\n    return undefined;\r\n\r\n  const persistenceUnit = await koq.persistenceUnit;\r\n  // istanbul ignore if\r\n  if (!persistenceUnit)\r\n    return undefined;\r\n\r\n  const formatProps = await getKoqFormatProps(koq, persistenceUnit, unitSystem);\r\n  if (!formatProps)\r\n    return undefined;\r\n\r\n  return { formatProps, persistenceUnitName: persistenceUnit.fullName };\r\n}\r\n\r\nasync function getKoq(schemaLocater: ISchemaLocater, 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<KindOfQuantity>(propKoqName);\r\n}\r\n\r\nasync function getKoqFormatProps(koq: KindOfQuantity, persistenceUnit: Unit | InvertedUnit, unitSystem?: UnitSystemKey) {\r\n  const unitSystems = getUnitSystemGroupNames(unitSystem);\r\n  // use one of KOQ presentation format that matches requested unit system\r\n  const presentationFormat = await getKoqPresentationFormat(koq, unitSystems);\r\n  if (presentationFormat)\r\n    return formatToFormatProps(presentationFormat);\r\n\r\n  // use persistence unit format if it matches requested unit system and matching presentation format was not found\r\n  const persistenceUnitSystem = await persistenceUnit.unitSystem;\r\n  if (persistenceUnitSystem && unitSystems.includes(persistenceUnitSystem.name.toUpperCase()))\r\n    return getPersistenceUnitFormatProps(persistenceUnit);\r\n\r\n  // use default presentation format if persistence unit does not match requested unit system\r\n  if (koq.defaultPresentationFormat)\r\n    return formatToFormatProps(koq.defaultPresentationFormat);\r\n\r\n  return undefined;\r\n}\r\n\r\nasync function getKoqPresentationFormat(koq: KindOfQuantity, unitSystems: string[]) {\r\n  const presentationFormats = koq.presentationFormats;\r\n  for (const system of unitSystems) {\r\n    for (const format of presentationFormats) {\r\n      const unit = format.units && format.units[0][0];\r\n      // istanbul ignore if\r\n      if (!unit)\r\n        continue;\r\n\r\n      const currentUnitSystem = await unit.unitSystem;\r\n      if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system)\r\n        return format;\r\n    }\r\n  }\r\n  return undefined;\r\n}\r\n\r\nfunction formatToFormatProps(format: ECFormat | OverrideFormat): FormatProps {\r\n  // istanbul ignore if\r\n  if (OverrideFormat.isOverrideFormat(format)) {\r\n    const baseFormat = baseFormatToFormatProps(format.parent);\r\n    return {\r\n      ...baseFormat,\r\n      composite: format.units\r\n        ? {\r\n          ...baseFormat.composite,\r\n          units: format.units.map(([unit, _]) => ({ name: unit.fullName, label: unit.label })),\r\n          spacer: format.spacer,\r\n          includeZero: format.includeZero,\r\n        }\r\n        : baseFormat.composite,\r\n    };\r\n  }\r\n  return baseFormatToFormatProps(format);\r\n}\r\n\r\nfunction baseFormatToFormatProps(format: ECFormat): FormatProps {\r\n  const json = format.toJSON();\r\n  return {\r\n    ...json,\r\n    composite: json.composite\r\n      ? {\r\n        ...json.composite,\r\n        spacer: format.spacer,\r\n        includeZero: format.includeZero,\r\n      }\r\n      : /* istanbul ignore next */ undefined,\r\n  };\r\n}\r\n\r\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\r\n  // Same as Format \"DefaultRealU\" in Formats ecschema\r\n  return {\r\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\r\n    precision: 6,\r\n    type: \"Decimal\",\r\n    uomSeparator: \" \",\r\n    decimalSeparator: \".\",\r\n    composite: {\r\n      units: [{\r\n        name: persistenceUnit.fullName,\r\n        label: persistenceUnit.label,\r\n      }],\r\n    },\r\n  };\r\n}\r\n\r\nfunction getUnitSystemGroupNames(unitSystem?: UnitSystemKey) {\r\n  switch (unitSystem) {\r\n    case \"imperial\":\r\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\r\n    case \"metric\":\r\n      return [\"SI\", \"METRIC\", \"INTERNATIONAL\", \"FINANCE\"];\r\n    case \"usCustomary\":\r\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\r\n    case \"usSurvey\":\r\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\r\n  }\r\n  return [];\r\n}\r\n"]}

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

@@ -1,88 +1,94 @@
-/** @packageDocumentation
- * @module Hierarchies
- */
-/**
- * Data structure that describes raw composite label value.
- * @public
- */
-export interface LabelCompositeValue {
-    separator: string;
-    values: LabelDefinition[];
-}
-/**
- * JSON representation of [[LabelCompositeValue]]
- * @public
- * @deprecated in 3.x. Use [[LabelCompositeValue]].
- */
-export interface LabelCompositeValueJSON {
-    separator: string;
-    values: LabelDefinition[];
-}
-/** @public */
-export declare namespace LabelCompositeValue {
-    /**
-     * Serialize given [[LabelCompositeValue]] to JSON
-     * @deprecated in 3.x. Use [[LabelCompositeValue]].
-     */
-    function toJSON(compositeValue: LabelCompositeValue): LabelCompositeValueJSON;
-    /**
-     * Deserialize [[LabelCompositeValue]] from JSON
-     * @deprecated in 3.x. Use [[LabelCompositeValue]].
-     */
-    function fromJSON(json: LabelCompositeValueJSON): LabelCompositeValue;
-}
-/**
- * Type definition of label raw value.
- * @public
- */
-export declare type LabelRawValue = string | number | boolean | LabelCompositeValue;
-/**
- * JSON representation of [[LabelRawValue]]
- * @public
- * @deprecated in 3.x. Use [[LabelRawValue]].
- */
-export declare type LabelRawValueJSON = LabelRawValue;
-/**
- * Data structure that describes label definition.
- * @public
- */
-export interface LabelDefinition {
-    /** Display value of label */
-    displayValue: string;
-    /** Raw value of label */
-    rawValue: LabelRawValue;
-    /** Type name of raw value */
-    typeName: string;
-}
-/**
- * JSON representation of [[LabelDefinition]]
- * @public
- * @deprecated in 3.x. Use [[LabelDefinition]].
- */
-export interface LabelDefinitionJSON {
-    displayValue: string;
-    rawValue: LabelRawValue;
-    typeName: string;
-}
-/** @public */
-export declare namespace LabelDefinition {
-    /**
-     * Serialize given [[LabelDefinition]] to JSON
-     * @deprecated in 3.x. Use [[LabelDefinition]].
-     */
-    function toJSON(labelDefinition: LabelDefinition): LabelDefinitionJSON;
-    /**
-     * Deserialize [[LabelDefinition]] from JSON
-     * @deprecated in 3.x. Use [[LabelDefinition]].
-     */
-    function fromJSON(json: LabelDefinitionJSON | string): LabelDefinition;
-    /** @internal */
-    const COMPOSITE_DEFINITION_TYPENAME = "composite";
-    /** @internal */
-    function isCompositeDefinition(def: LabelDefinition): def is LabelDefinition & {
-        rawValue: LabelCompositeValue;
-    };
-    /** @internal */
-    function fromLabelString(label: string): LabelDefinition;
-}
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+/**
+ * Data structure that describes raw composite label value.
+ * @public
+ */
+export interface LabelCompositeValue {
+    separator: string;
+    values: LabelDefinition[];
+}
+/**
+ * JSON representation of [[LabelCompositeValue]]
+ * @public
+ * @deprecated in 3.x. Use [[LabelCompositeValue]].
+ */
+export interface LabelCompositeValueJSON {
+    separator: string;
+    values: LabelDefinition[];
+}
+/** @public */
+export declare namespace LabelCompositeValue {
+    /**
+     * Serialize given [[LabelCompositeValue]] to JSON
+     * @deprecated in 3.x. Use [[LabelCompositeValue]].
+     */
+    function toJSON(compositeValue: LabelCompositeValue): LabelCompositeValueJSON;
+    /**
+     * Deserialize [[LabelCompositeValue]] from JSON
+     * @deprecated in 3.x. Use [[LabelCompositeValue]].
+     */
+    function fromJSON(json: LabelCompositeValueJSON): LabelCompositeValue;
+}
+/**
+ * Type definition of label raw value.
+ * @public
+ */
+export type LabelRawValue = string | number | boolean | LabelCompositeValue;
+/**
+ * JSON representation of [[LabelRawValue]]
+ * @public
+ * @deprecated in 3.x. Use [[LabelRawValue]].
+ */
+export type LabelRawValueJSON = LabelRawValue;
+/**
+ * Data structure that describes label definition.
+ * @public
+ */
+export interface LabelDefinition {
+    /** Display value of label */
+    displayValue: string;
+    /** Raw value of label */
+    rawValue: LabelRawValue;
+    /** Type name of raw value */
+    typeName: string;
+}
+/**
+ * JSON representation of [[LabelDefinition]]
+ * @public
+ * @deprecated in 3.x. Use [[LabelDefinition]].
+ */
+export interface LabelDefinitionJSON {
+    displayValue: string;
+    rawValue: LabelRawValue;
+    typeName: string;
+}
+/** @public */
+export declare namespace LabelDefinition {
+    /**
+     * Serialize given [[LabelDefinition]] to JSON
+     * @deprecated in 3.x. Use [[LabelDefinition]].
+     */
+    function toJSON(labelDefinition: LabelDefinition): LabelDefinitionJSON;
+    /**
+     * Deserialize [[LabelDefinition]] from JSON
+     * @deprecated in 3.x. Use [[LabelDefinition]].
+     */
+    function fromJSON(json: LabelDefinitionJSON | string): LabelDefinition;
+    /** @internal */
+    const COMPOSITE_DEFINITION_TYPENAME = "composite";
+    /**
+     * Checks if provided [[LabelDefinition]] has raw value of type [[LabelCompositeValue]].
+     * @public
+     */
+    function isCompositeDefinition(def: LabelDefinition): def is LabelDefinition & {
+        rawValue: LabelCompositeValue;
+    };
+    /**
+     * Creates [[LabelDefinition]] from string value.
+     * @public
+     */
+    function fromLabelString(label: string): LabelDefinition;
+}
 //# sourceMappingURL=LabelDefinition.d.ts.map

package/lib/esm/presentation-common/LabelDefinition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LabelDefinition.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/LabelDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,cAAc;AACd,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IAEH,SAAgB,MAAM,CAAC,cAAc,EAAE,mBAAmB,GAAG,uBAAuB,CAEnF;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,uBAAuB,GAAG,mBAAmB,CAE3E;CACF;AAED;;;GAGG;AACH,oBAAY,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,mBAAmB,CAAC;AAE5E;;;;GAIG;AACH,oBAAY,iBAAiB,GAAG,aAAa,CAAC;AAE9C;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,yBAAyB;IACzB,QAAQ,EAAE,aAAa,CAAC;IACxB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,cAAc;AACd,yBAAiB,eAAe,CAAC;IAC/B;;;OAGG;IAEH,SAAgB,MAAM,CAAC,eAAe,EAAE,eAAe,GAAG,mBAAmB,CAE5E;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,GAAG,eAAe,CAI5E;IAED,gBAAgB;IACT,MAAM,6BAA6B,cAAc,CAAC;IAEzD,gBAAgB;IAEhB,SAAgB,qBAAqB,CAAC,GAAG,EAAE,eAAe,GAAG,GAAG,IAAI,eAAe,GAAG;QAAE,QAAQ,EAAE,mBAAmB,CAAA;KAAE,CAEtH;IAED,gBAAgB;IAChB,SAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAM9D;CACF"}
+{"version":3,"file":"LabelDefinition.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/LabelDefinition.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B;AAED,cAAc;AACd,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IAEH,SAAgB,MAAM,CAAC,cAAc,EAAE,mBAAmB,GAAG,uBAAuB,CAEnF;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,uBAAuB,GAAG,mBAAmB,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,mBAAmB,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAE9C;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,yBAAyB;IACzB,QAAQ,EAAE,aAAa,CAAC;IACxB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,aAAa,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,cAAc;AACd,yBAAiB,eAAe,CAAC;IAC/B;;;OAGG;IAEH,SAAgB,MAAM,CAAC,eAAe,EAAE,eAAe,GAAG,mBAAmB,CAE5E;IAED;;;OAGG;IAEH,SAAgB,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM,GAAG,eAAe,CAI5E;IAED,gBAAgB;IACT,MAAM,6BAA6B,cAAc,CAAC;IAEzD;;;OAGG;IACH,SAAgB,qBAAqB,CAAC,GAAG,EAAE,eAAe,GAAG,GAAG,IAAI,eAAe,GAAG;QAAE,QAAQ,EAAE,mBAAmB,CAAA;KAAE,CAEtH;IAED;;;OAGG;IACH,SAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAM9D;CACF"}

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

@@ -1,71 +1,76 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Hierarchies
- */
-/** @public */
-export var LabelCompositeValue;
-(function (LabelCompositeValue) {
-    /**
-     * Serialize given [[LabelCompositeValue]] to JSON
-     * @deprecated in 3.x. Use [[LabelCompositeValue]].
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function toJSON(compositeValue) {
-        return { ...compositeValue };
-    }
-    LabelCompositeValue.toJSON = toJSON;
-    /**
-     * Deserialize [[LabelCompositeValue]] from JSON
-     * @deprecated in 3.x. Use [[LabelCompositeValue]].
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromJSON(json) {
-        return { ...json };
-    }
-    LabelCompositeValue.fromJSON = fromJSON;
-})(LabelCompositeValue || (LabelCompositeValue = {}));
-/** @public */
-export var LabelDefinition;
-(function (LabelDefinition) {
-    /**
-     * Serialize given [[LabelDefinition]] to JSON
-     * @deprecated in 3.x. Use [[LabelDefinition]].
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function toJSON(labelDefinition) {
-        return { ...labelDefinition };
-    }
-    LabelDefinition.toJSON = toJSON;
-    /**
-     * Deserialize [[LabelDefinition]] from JSON
-     * @deprecated in 3.x. Use [[LabelDefinition]].
-     */
-    // eslint-disable-next-line deprecation/deprecation
-    function fromJSON(json) {
-        if (typeof json === "string")
-            return JSON.parse(json);
-        return { ...json };
-    }
-    LabelDefinition.fromJSON = fromJSON;
-    /** @internal */
-    LabelDefinition.COMPOSITE_DEFINITION_TYPENAME = "composite";
-    /** @internal */
-    // istanbul ignore next
-    function isCompositeDefinition(def) {
-        return def.typeName === LabelDefinition.COMPOSITE_DEFINITION_TYPENAME;
-    }
-    LabelDefinition.isCompositeDefinition = isCompositeDefinition;
-    /** @internal */
-    function fromLabelString(label) {
-        return {
-            displayValue: label,
-            rawValue: label,
-            typeName: "string",
-        };
-    }
-    LabelDefinition.fromLabelString = fromLabelString;
-})(LabelDefinition || (LabelDefinition = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hierarchies
+ */
+/** @public */
+export var LabelCompositeValue;
+(function (LabelCompositeValue) {
+    /**
+     * Serialize given [[LabelCompositeValue]] to JSON
+     * @deprecated in 3.x. Use [[LabelCompositeValue]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function toJSON(compositeValue) {
+        return { ...compositeValue };
+    }
+    LabelCompositeValue.toJSON = toJSON;
+    /**
+     * Deserialize [[LabelCompositeValue]] from JSON
+     * @deprecated in 3.x. Use [[LabelCompositeValue]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        return { ...json };
+    }
+    LabelCompositeValue.fromJSON = fromJSON;
+})(LabelCompositeValue || (LabelCompositeValue = {}));
+/** @public */
+export var LabelDefinition;
+(function (LabelDefinition) {
+    /**
+     * Serialize given [[LabelDefinition]] to JSON
+     * @deprecated in 3.x. Use [[LabelDefinition]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function toJSON(labelDefinition) {
+        return { ...labelDefinition };
+    }
+    LabelDefinition.toJSON = toJSON;
+    /**
+     * Deserialize [[LabelDefinition]] from JSON
+     * @deprecated in 3.x. Use [[LabelDefinition]].
+     */
+    // eslint-disable-next-line deprecation/deprecation
+    function fromJSON(json) {
+        if (typeof json === "string")
+            return JSON.parse(json);
+        return { ...json };
+    }
+    LabelDefinition.fromJSON = fromJSON;
+    /** @internal */
+    LabelDefinition.COMPOSITE_DEFINITION_TYPENAME = "composite";
+    /**
+     * Checks if provided [[LabelDefinition]] has raw value of type [[LabelCompositeValue]].
+     * @public
+     */
+    function isCompositeDefinition(def) {
+        return def.typeName === LabelDefinition.COMPOSITE_DEFINITION_TYPENAME;
+    }
+    LabelDefinition.isCompositeDefinition = isCompositeDefinition;
+    /**
+     * Creates [[LabelDefinition]] from string value.
+     * @public
+     */
+    function fromLabelString(label) {
+        return {
+            displayValue: label,
+            rawValue: label,
+            typeName: "string",
+        };
+    }
+    LabelDefinition.fromLabelString = fromLabelString;
+})(LabelDefinition || (LabelDefinition = {}));
 //# sourceMappingURL=LabelDefinition.js.map

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;;;+FAG+F;AAC/F;;GAEG;AAqBH,cAAc;AACd,MAAM,KAAW,mBAAmB,CAkBnC;AAlBD,WAAiB,mBAAmB;IAClC;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,cAAmC;QACxD,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;IAC/B,CAAC;IAFe,0BAAM,SAErB,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAA6B;QACpD,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IAFe,4BAAQ,WAEvB,CAAA;AACH,CAAC,EAlBgB,mBAAmB,KAAnB,mBAAmB,QAkBnC;AAuCD,cAAc;AACd,MAAM,KAAW,eAAe,CAsC/B;AAtCD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,eAAgC;QACrD,OAAO,EAAE,GAAG,eAAe,EAAE,CAAC;IAChC,CAAC;IAFe,sBAAM,SAErB,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAkC;QACzD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IAJe,wBAAQ,WAIvB,CAAA;IAED,gBAAgB;IACH,6CAA6B,GAAG,WAAW,CAAC;IAEzD,gBAAgB;IAChB,uBAAuB;IACvB,SAAgB,qBAAqB,CAAC,GAAoB;QACxD,OAAO,GAAG,CAAC,QAAQ,KAAK,gBAAA,6BAA6B,CAAC;IACxD,CAAC;IAFe,qCAAqB,wBAEpC,CAAA;IAED,gBAAgB;IAChB,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,EAtCgB,eAAe,KAAf,eAAe,QAsC/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 * JSON representation of [[LabelCompositeValue]]\r\n * @public\r\n * @deprecated in 3.x. Use [[LabelCompositeValue]].\r\n */\r\nexport interface LabelCompositeValueJSON {\r\n  separator: string;\r\n  values: LabelDefinition[];\r\n}\r\n\r\n/** @public */\r\nexport namespace LabelCompositeValue {\r\n  /**\r\n   * Serialize given [[LabelCompositeValue]] to JSON\r\n   * @deprecated in 3.x. Use [[LabelCompositeValue]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(compositeValue: LabelCompositeValue): LabelCompositeValueJSON {\r\n    return { ...compositeValue };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[LabelCompositeValue]] from JSON\r\n   * @deprecated in 3.x. Use [[LabelCompositeValue]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: LabelCompositeValueJSON): LabelCompositeValue {\r\n    return { ...json };\r\n  }\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 * JSON representation of [[LabelRawValue]]\r\n * @public\r\n * @deprecated in 3.x. Use [[LabelRawValue]].\r\n */\r\nexport type LabelRawValueJSON = LabelRawValue;\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/**\r\n * JSON representation of [[LabelDefinition]]\r\n * @public\r\n * @deprecated in 3.x. Use [[LabelDefinition]].\r\n */\r\nexport interface LabelDefinitionJSON {\r\n  displayValue: string;\r\n  rawValue: LabelRawValue;\r\n  typeName: string;\r\n}\r\n\r\n/** @public */\r\nexport namespace LabelDefinition {\r\n  /**\r\n   * Serialize given [[LabelDefinition]] to JSON\r\n   * @deprecated in 3.x. Use [[LabelDefinition]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(labelDefinition: LabelDefinition): LabelDefinitionJSON {\r\n    return { ...labelDefinition };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[LabelDefinition]] from JSON\r\n   * @deprecated in 3.x. Use [[LabelDefinition]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: LabelDefinitionJSON | string): LabelDefinition {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json);\r\n    return { ...json };\r\n  }\r\n\r\n  /** @internal */\r\n  export const COMPOSITE_DEFINITION_TYPENAME = \"composite\";\r\n\r\n  /** @internal */\r\n  // istanbul ignore next\r\n  export function isCompositeDefinition(def: LabelDefinition): def is LabelDefinition & { rawValue: LabelCompositeValue } {\r\n    return def.typeName === COMPOSITE_DEFINITION_TYPENAME;\r\n  }\r\n\r\n  /** @internal */\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"]}
+{"version":3,"file":"LabelDefinition.js","sourceRoot":"","sources":["../../../src/presentation-common/LabelDefinition.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAqBH,cAAc;AACd,MAAM,KAAW,mBAAmB,CAkBnC;AAlBD,WAAiB,mBAAmB;IAClC;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,cAAmC;QACxD,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;IAC/B,CAAC;IAFe,0BAAM,SAErB,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAA6B;QACpD,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IAFe,4BAAQ,WAEvB,CAAA;AACH,CAAC,EAlBgB,mBAAmB,KAAnB,mBAAmB,QAkBnC;AAuCD,cAAc;AACd,MAAM,KAAW,eAAe,CA2C/B;AA3CD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,MAAM,CAAC,eAAgC;QACrD,OAAO,EAAE,GAAG,eAAe,EAAE,CAAC;IAChC,CAAC;IAFe,sBAAM,SAErB,CAAA;IAED;;;OAGG;IACH,mDAAmD;IACnD,SAAgB,QAAQ,CAAC,IAAkC;QACzD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;IACrB,CAAC;IAJe,wBAAQ,WAIvB,CAAA;IAED,gBAAgB;IACH,6CAA6B,GAAG,WAAW,CAAC;IAEzD;;;OAGG;IACH,SAAgB,qBAAqB,CAAC,GAAoB;QACxD,OAAO,GAAG,CAAC,QAAQ,KAAK,gBAAA,6BAA6B,CAAC;IACxD,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,EA3CgB,eAAe,KAAf,eAAe,QA2C/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 * JSON representation of [[LabelCompositeValue]]\r\n * @public\r\n * @deprecated in 3.x. Use [[LabelCompositeValue]].\r\n */\r\nexport interface LabelCompositeValueJSON {\r\n  separator: string;\r\n  values: LabelDefinition[];\r\n}\r\n\r\n/** @public */\r\nexport namespace LabelCompositeValue {\r\n  /**\r\n   * Serialize given [[LabelCompositeValue]] to JSON\r\n   * @deprecated in 3.x. Use [[LabelCompositeValue]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(compositeValue: LabelCompositeValue): LabelCompositeValueJSON {\r\n    return { ...compositeValue };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[LabelCompositeValue]] from JSON\r\n   * @deprecated in 3.x. Use [[LabelCompositeValue]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: LabelCompositeValueJSON): LabelCompositeValue {\r\n    return { ...json };\r\n  }\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 * JSON representation of [[LabelRawValue]]\r\n * @public\r\n * @deprecated in 3.x. Use [[LabelRawValue]].\r\n */\r\nexport type LabelRawValueJSON = LabelRawValue;\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/**\r\n * JSON representation of [[LabelDefinition]]\r\n * @public\r\n * @deprecated in 3.x. Use [[LabelDefinition]].\r\n */\r\nexport interface LabelDefinitionJSON {\r\n  displayValue: string;\r\n  rawValue: LabelRawValue;\r\n  typeName: string;\r\n}\r\n\r\n/** @public */\r\nexport namespace LabelDefinition {\r\n  /**\r\n   * Serialize given [[LabelDefinition]] to JSON\r\n   * @deprecated in 3.x. Use [[LabelDefinition]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function toJSON(labelDefinition: LabelDefinition): LabelDefinitionJSON {\r\n    return { ...labelDefinition };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[LabelDefinition]] from JSON\r\n   * @deprecated in 3.x. Use [[LabelDefinition]].\r\n   */\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  export function fromJSON(json: LabelDefinitionJSON | string): LabelDefinition {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json);\r\n    return { ...json };\r\n  }\r\n\r\n  /** @internal */\r\n  export const COMPOSITE_DEFINITION_TYPENAME = \"composite\";\r\n\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_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.d.ts

@@ -1,30 +1,30 @@
-/** @packageDocumentation
- * @module Core
- */
-import { Node } from "./hierarchy/Node";
-import { Content } from "./content/Content";
-import { LabelDefinition } from "./LabelDefinition";
-import { ElementProperties } from "./ElementProperties";
-/** @internal */
-export interface LocalizationHelperProps {
-    getLocalizedString: (key: string) => string;
-}
-/** @internal */
-export declare class LocalizationHelper {
-    private _getLocalizedString;
-    constructor(props: LocalizationHelperProps);
-    getLocalizedString(text: string): string;
-    getLocalizedNodes(nodes: Node[]): Node[];
-    getLocalizedLabelDefinition(labelDefinition: LabelDefinition): LabelDefinition;
-    getLocalizedLabelDefinitions(labelDefinitions: LabelDefinition[]): LabelDefinition[];
-    getLocalizedContent(content: Content): Content;
-    getLocalizedElementProperties(elem: ElementProperties): ElementProperties;
-    private translateContentItem;
-    private translateContentItemDisplayValue;
-    private translateContentItemValue;
-    private translateContentDescriptorField;
-    private translateContentDescriptorCategory;
-    private translateNode;
-    private translateLabelDefinition;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { Node } from "./hierarchy/Node";
+import { Content } from "./content/Content";
+import { LabelDefinition } from "./LabelDefinition";
+import { ElementProperties } from "./ElementProperties";
+/** @internal */
+export interface LocalizationHelperProps {
+    getLocalizedString: (key: string) => string;
+}
+/** @internal */
+export declare class LocalizationHelper {
+    private _getLocalizedString;
+    constructor(props: LocalizationHelperProps);
+    getLocalizedString(text: string): string;
+    getLocalizedNodes(nodes: Node[]): Node[];
+    getLocalizedLabelDefinition(labelDefinition: LabelDefinition): LabelDefinition;
+    getLocalizedLabelDefinitions(labelDefinitions: LabelDefinition[]): LabelDefinition[];
+    getLocalizedContent(content: Content): Content;
+    getLocalizedElementProperties(elem: ElementProperties): ElementProperties;
+    private translateContentItem;
+    private translateContentItemDisplayValue;
+    private translateContentItemValue;
+    private translateContentDescriptorField;
+    private translateContentDescriptorCategory;
+    private translateNode;
+    private translateLabelDefinition;
+}
 //# sourceMappingURL=LocalizationHelper.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"LocalizationHelper.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAuB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD,gBAAgB;AAChB,MAAM,WAAW,uBAAuB;IACtC,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;CAC7C;AAED,gBAAgB;AAChB,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,mBAAmB,CAA0B;gBAEzC,KAAK,EAAE,uBAAuB;IAInC,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAI/B,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE;IAMxC,2BAA2B,CAAC,eAAe,EAAE,eAAe,GAAG,eAAe;IAK9E,4BAA4B,CAAC,gBAAgB,EAAE,eAAe,EAAE;IAKhE,mBAAmB,CAAC,OAAO,EAAE,OAAO;IAOpC,6BAA6B,CAAC,IAAI,EAAE,iBAAiB;IAK5D,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,gCAAgC;IAQxC,OAAO,CAAC,yBAAyB;IAoBjC,OAAO,CAAC,+BAA+B;IAIvC,OAAO,CAAC,kCAAkC;IAK1C,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,wBAAwB;CAajC"}
+{"version":3,"file":"LocalizationHelper.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/LocalizationHelper.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAuB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD,gBAAgB;AAChB,MAAM,WAAW,uBAAuB;IACtC,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;CAC7C;AAED,gBAAgB;AAChB,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,mBAAmB,CAA0B;gBAEzC,KAAK,EAAE,uBAAuB;IAInC,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAI/B,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE;IAMxC,2BAA2B,CAAC,eAAe,EAAE,eAAe,GAAG,eAAe;IAK9E,4BAA4B,CAAC,gBAAgB,EAAE,eAAe,EAAE;IAKhE,mBAAmB,CAAC,OAAO,EAAE,OAAO;IAOpC,6BAA6B,CAAC,IAAI,EAAE,iBAAiB;IAK5D,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,gCAAgC;IAQxC,OAAO,CAAC,yBAAyB;IAsBjC,OAAO,CAAC,+BAA+B;IAIvC,OAAO,CAAC,kCAAkC;IAK1C,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,wBAAwB;CAYjC"}