@itwin/presentation-common 5.0.0-dev.99 → 5.1.0-dev.1

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @itwin/presentation-common
 
-This log was last generated on Wed, 02 Apr 2025 19:38:36 GMT and should not be manually modified.
+This log was last generated on Thu, 10 Apr 2025 17:50:15 GMT and should not be manually modified.
+
+## 4.10.13
+Thu, 10 Apr 2025 17:47:21 GMT
+
+_Version update only_
 
 ## 4.10.12
 Wed, 02 Apr 2025 19:35:47 GMT

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

@@ -109,19 +109,21 @@ async function getKoqFormatProps(koq, persistenceUnit, defaultFormats, unitSyste
     }
     // use default presentation format if persistence unit does not match requested unit system
     if (koq.defaultPresentationFormat) {
-        return (0, ecschema_metadata_1.getFormatProps)(koq.defaultPresentationFormat);
+        return (0, ecschema_metadata_1.getFormatProps)(await koq.defaultPresentationFormat);
     }
     return undefined;
 }
 async function getKoqPresentationFormat(koq, unitSystemMatchers) {
     const presentationFormats = koq.presentationFormats;
     for (const matcher of unitSystemMatchers) {
-        for (const format of presentationFormats) {
-            const unit = format.units && format.units[0][0];
+        for (const lazyFormat of presentationFormats) {
+            const format = await lazyFormat;
+            const lazyUnit = format.units && format.units[0][0];
             /* c8 ignore next 3 */
-            if (!unit) {
+            if (!lazyUnit) {
                 continue;
             }
+            const unit = await lazyUnit;
             const currentUnitSystem = await unit.unitSystem;
             if (currentUnitSystem && matcher(currentUnitSystem)) {
                 return format;

package/lib/cjs/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,wDAAoH;AACpH,gEAUkC;AAiDlC;;;GAGG;AACH,MAAa,yBAAyB;IAK1B;IAJF,cAAc,CAAgB;IAC9B,eAAe,CAAc;IAErC,YACU,cAA6B,EACrC,cAA2B;QADnB,mBAAc,GAAd,cAAc,CAAe;QAGrC,IAAI,CAAC,cAAc,GAAG,IAAI,sCAAkB,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,sBAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACjF,OAAO,6BAAa,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,sBAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACjF,OAAO,0BAAU,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;CACF;AA3CD,8DA2CC;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,6BAAS,CAAC,UAAU,CAAC,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC;IAChG,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,kCAAc,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,IAAA,kCAAc,EAAC,kBAAkB,CAAC,CAAC;IAC5C,CAAC;IAED,0GAA0G;IAC1G,qBAAqB;IACrB,IAAI,cAAc,IAAI,UAAU,EAAE,CAAC;QACjC,MAAM,qBAAqB,GAAG,eAAe,YAAY,gCAAY,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,IAAA,kCAAc,EAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IACvD,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,MAAM,IAAI,mBAAmB,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChD,sBAAsB;YACtB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,SAAS;YACX,CAAC;YACD,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(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 format of presentationFormats) {\n      const unit = format.units && format.units[0][0];\n      /* c8 ignore next 3 */\n      if (!unit) {\n        continue;\n      }\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,wDAAoH;AACpH,gEAUkC;AAiDlC;;;GAGG;AACH,MAAa,yBAAyB;IAK1B;IAJF,cAAc,CAAgB;IAC9B,eAAe,CAAc;IAErC,YACU,cAA6B,EACrC,cAA2B;QADnB,mBAAc,GAAd,cAAc,CAAe;QAGrC,IAAI,CAAC,cAAc,GAAG,IAAI,sCAAkB,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,sBAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACjF,OAAO,6BAAa,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,sBAAM,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACjF,OAAO,0BAAU,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;CACF;AA3CD,8DA2CC;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,6BAAS,CAAC,UAAU,CAAC,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC;IAChG,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,kCAAc,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,IAAA,kCAAc,EAAC,kBAAkB,CAAC,CAAC;IAC5C,CAAC;IAED,0GAA0G;IAC1G,qBAAqB;IACrB,IAAI,cAAc,IAAI,UAAU,EAAE,CAAC;QACjC,MAAM,qBAAqB,GAAG,eAAe,YAAY,gCAAY,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,IAAA,kCAAc,EAAC,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"]}

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

@@ -105,19 +105,21 @@ async function getKoqFormatProps(koq, persistenceUnit, defaultFormats, unitSyste
     }
     // use default presentation format if persistence unit does not match requested unit system
     if (koq.defaultPresentationFormat) {
-        return getFormatProps(koq.defaultPresentationFormat);
+        return getFormatProps(await koq.defaultPresentationFormat);
     }
     return undefined;
 }
 async function getKoqPresentationFormat(koq, unitSystemMatchers) {
     const presentationFormats = koq.presentationFormats;
     for (const matcher of unitSystemMatchers) {
-        for (const format of presentationFormats) {
-            const unit = format.units && format.units[0][0];
+        for (const lazyFormat of presentationFormats) {
+            const format = await lazyFormat;
+            const lazyUnit = format.units && format.units[0][0];
             /* c8 ignore next 3 */
-            if (!unit) {
+            if (!lazyUnit) {
                 continue;
             }
+            const unit = await lazyUnit;
             const currentUnitSystem = await unit.unitSystem;
             if (currentUnitSystem && matcher(currentUnitSystem)) {
                 return format;

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,GAAG,CAAC,yBAAyB,CAAC,CAAC;IACvD,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,MAAM,IAAI,mBAAmB,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChD,sBAAsB;YACtB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,SAAS;YACX,CAAC;YACD,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(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 format of presentationFormats) {\n      const unit = format.units && format.units[0][0];\n      /* c8 ignore next 3 */\n      if (!unit) {\n        continue;\n      }\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,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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/presentation-common",
-  "version": "5.0.0-dev.99",
+  "version": "5.1.0-dev.1",
   "description": "Common pieces for iModel.js presentation packages",
   "license": "MIT",
   "repository": {
@@ -42,10 +42,10 @@
     "./package.json": "./package.json"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "5.0.0-dev.99",
-    "@itwin/core-quantity": "5.0.0-dev.99",
-    "@itwin/ecschema-metadata": "5.0.0-dev.99",
-    "@itwin/core-common": "5.0.0-dev.99"
+    "@itwin/ecschema-metadata": "5.1.0-dev.1",
+    "@itwin/core-quantity": "5.1.0-dev.1",
+    "@itwin/core-bentley": "5.1.0-dev.1",
+    "@itwin/core-common": "5.1.0-dev.1"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "5.0.0-dev.1",
@@ -77,12 +77,12 @@
     "typescript": "~5.6.2",
     "typescript-json-schema": "^0.55.0",
     "yargs": "^17.4.0",
-    "@itwin/build-tools": "5.0.0-dev.99",
-    "@itwin/ecschema-metadata": "5.0.0-dev.99",
-    "@itwin/core-bentley": "5.0.0-dev.99",
-    "@itwin/core-common": "5.0.0-dev.99",
+    "@itwin/build-tools": "5.1.0-dev.1",
+    "@itwin/core-quantity": "5.1.0-dev.1",
+    "@itwin/core-common": "5.1.0-dev.1",
     "internal-tools": "3.0.0-dev.69",
-    "@itwin/core-quantity": "5.0.0-dev.99"
+    "@itwin/ecschema-metadata": "5.1.0-dev.1",
+    "@itwin/core-bentley": "5.1.0-dev.1"
   },
   "scripts": {
     "build": "npm run -s ruleset-json-schema && npm run -s build:assets && npm run -s build:public && npm run -s build:cjs && npm run -s build:esm",