@itwin/ecschema-metadata 4.10.0-dev.9 → 5.0.0-dev.1

package/lib/esm/UnitProvider/SchemaUnitProvider.js

@@ -3,12 +3,14 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 import { BentleyError, BentleyStatus } from "@itwin/core-bentley";
+import { BadUnit, UnitConversionInvert } from "@itwin/core-quantity";
 import { SchemaContext } from "../Context";
 import { SchemaItem } from "../Metadata/SchemaItem";
 import { SchemaItemKey, SchemaKey } from "../SchemaKey";
 import { Unit } from "../Metadata/Unit";
 import { SchemaItemType } from "../ECObjects";
 import { UnitConverter } from "../UnitConversion/UnitConverter";
+import { InvertedUnit } from "../Metadata/InvertedUnit";
 /**
  * Class used to find Units in SchemaContext by attributes such as Phenomenon and DisplayLabel.
  * @beta
@@ -38,8 +40,22 @@ export class SchemaUnitProvider {
      * @returns UnitProps interface from @itwin/core-quantity whose name matches unitName.
      */
     async findUnitByName(unitName) {
-        const unit = await this.findECUnitByName(unitName);
-        return this.getUnitsProps(unit);
+        // Check if schema exists and unit exists in schema
+        const [schemaName, schemaItemName] = SchemaItem.parseFullName(unitName);
+        const schemaKey = new SchemaKey(schemaName);
+        const schema = await this._context.getSchema(schemaKey);
+        if (!schema) {
+            return new BadUnit(); // return BadUnit if schema does not exist
+        }
+        const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);
+        const unit = await this._context.getSchemaItem(itemKey);
+        if (unit && unit.schemaItemType === SchemaItemType.Unit)
+            return this.getUnitsProps(unit);
+        const invertedUnit = await this._context.getSchemaItem(itemKey);
+        if (invertedUnit && invertedUnit.schemaItemType === SchemaItemType.InvertedUnit) {
+            return this.getUnitsProps(invertedUnit);
+        }
+        return new BadUnit();
     }
     /**
      * Find all units in context that belongs to given phenomenon.
@@ -74,10 +90,20 @@ export class SchemaUnitProvider {
             if (Unit.isUnit(value)) {
                 const foundPhenomenon = await value.phenomenon;
                 if (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)) {
-                    const unitProps = this.getUnitsProps(value);
+                    const unitProps = await this.getUnitsProps(value);
                     filteredUnits.push(unitProps);
                 }
             }
+            else if (InvertedUnit.isInvertedUnit(value) && value.invertsUnit) {
+                const invertsUnit = await value.invertsUnit;
+                if (invertsUnit) {
+                    const foundPhenomenon = await invertsUnit.phenomenon;
+                    if (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)) {
+                        const unitProps = await this.getUnitsProps(value);
+                        filteredUnits.push(unitProps);
+                    }
+                }
+            }
             ({ value, done } = schemaItems.next());
         }
         return filteredUnits;
@@ -111,22 +137,11 @@ export class SchemaUnitProvider {
         const findSchema = schemaName ? schemaName.toLowerCase() : undefined;
         const findPhenomenon = phenomenon ? phenomenon.toLowerCase() : undefined;
         const findUnitSystem = unitSystem ? unitSystem.toLowerCase() : undefined;
-        let foundUnit;
-        try {
-            try {
-                foundUnit = await this.findUnitByDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);
-            }
-            catch (err) {
-                // If there is no Unit with display label that matches label, then check for alternate display labels that may match
-                foundUnit = await this.findUnitByAltDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);
-            }
-        }
-        catch (err) {
-            throw new BentleyError(BentleyStatus.ERROR, "Cannot find unit with label", () => {
-                return { unitLabel };
-            });
-        }
-        return this.getUnitsProps(foundUnit);
+        const foundUnit = await this.findUnitByDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);
+        if (foundUnit.isValid)
+            return foundUnit;
+        // If there is no Unit with display label that matches label, then check for alternate display labels that may match
+        return this.findUnitByAltDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);
     }
     /**
      * Gets the @itwin/core-quantity UnitConversionProps for the given fromUnit and toUnit.
@@ -135,49 +150,63 @@ export class SchemaUnitProvider {
      * @returns The UnitConversionProps interface from the @itwin/core-quantity package.
      */
     async getConversion(fromUnit, toUnit) {
-        const conversion = await this._unitConverter.calculateConversion(fromUnit.name, toUnit.name);
-        return {
+        // need to check if either side is an inverted unit. The UnitConverter can only handle Units
+        if (!fromUnit.isValid || !toUnit.isValid)
+            throw new BentleyError(BentleyStatus.ERROR, "Both provided units must be valid.", () => {
+                return { fromUnit, toUnit };
+            });
+        const { unitName: fromUnitName, isInverted: fromIsInverted } = await this.checkUnitPropsForConversion(fromUnit, this._context);
+        const { unitName: toUnitName, isInverted: toIsInverted } = await this.checkUnitPropsForConversion(toUnit, this._context);
+        const conversion = await this._unitConverter.calculateConversion(fromUnitName, toUnitName);
+        const result = {
             factor: conversion.factor,
             offset: conversion.offset,
         };
+        if (fromIsInverted && !toIsInverted)
+            result.inversion = UnitConversionInvert.InvertPreConversion;
+        else if (!fromIsInverted && toIsInverted)
+            result.inversion = UnitConversionInvert.InvertPostConversion;
+        return result;
     }
-    /**
-     * Find unit in a schema that has unitName.
-     * @param unitName Full name of unit.
-     * @returns Unit whose full name matches unitName.
-     */
-    async findECUnitByName(unitName) {
-        // Check if schema exists and unit exists in schema
-        const [schemaName, schemaItemName] = SchemaItem.parseFullName(unitName);
+    async checkUnitPropsForConversion(input, context) {
+        const [schemaName, schemaItemName] = SchemaItem.parseFullName(input.name);
         const schemaKey = new SchemaKey(schemaName);
-        const schema = await this._context.getSchema(schemaKey);
+        const schema = await context.getSchema(schemaKey);
         if (!schema) {
-            throw new BentleyError(BentleyStatus.ERROR, "Cannot find schema for unit", () => {
-                return { schema: schemaName, unit: unitName };
+            throw new BentleyError(BentleyStatus.ERROR, "Could not obtain schema for unit.", () => {
+                return { name: input.name };
             });
         }
         const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);
-        const item = await this._context.getSchemaItem(itemKey);
-        if (!item)
-            throw new BentleyError(BentleyStatus.ERROR, "Cannot find schema item/unit", () => {
-                return { item: schemaItemName, schema: schemaName };
-            });
-        if (item.schemaItemType === SchemaItemType.Unit)
-            return item;
-        throw new BentleyError(BentleyStatus.ERROR, "Item is not a unit", () => {
-            return { itemType: item.key.fullName };
-        });
+        const invertedUnit = await context.getSchemaItem(itemKey);
+        // Check if we found an item, the item is an inverted unit, and it has its invertsUnit property set
+        if (invertedUnit && InvertedUnit.isInvertedUnit(invertedUnit) && invertedUnit.invertsUnit) {
+            return { unitName: invertedUnit.invertsUnit.fullName, isInverted: true };
+        }
+        return { unitName: input.name, isInverted: false };
     }
     /**
      * Gets the @itwin/core UnitProps for the given Unit.
      * @param unit The Unit to convert.
      * @returns UnitProps interface from @itwin/core.
      */
-    getUnitsProps(unit) {
+    async getUnitsProps(unit) {
+        if (Unit.isUnit(unit)) {
+            return {
+                name: unit.fullName,
+                label: unit.label ?? "",
+                phenomenon: unit.phenomenon ? unit.phenomenon.fullName : "",
+                isValid: true,
+                system: unit.unitSystem === undefined ? "" : unit.unitSystem.fullName,
+            };
+        }
+        const invertsUnit = await unit.invertsUnit;
+        if (!invertsUnit)
+            return new BadUnit();
         return {
             name: unit.fullName,
             label: unit.label ?? "",
-            phenomenon: unit.phenomenon ? unit.phenomenon.fullName : "",
+            phenomenon: invertsUnit.phenomenon ? invertsUnit.phenomenon.fullName : "",
             isValid: true,
             system: unit.unitSystem === undefined ? "" : unit.unitSystem.fullName,
         };
@@ -187,22 +216,33 @@ export class SchemaUnitProvider {
      * @internal
      */
     async findUnitByDisplayLabel(displayLabel, schemaName, phenomenon, unitSystem) {
+        // TODO: Known bug: This only looks through loaded schemas. If schema name is provided, we can attempt to load that schema
         const schemaItems = this._context.getSchemaItems();
         let { value, done } = schemaItems.next();
         while (!done) {
             if (Unit.isUnit(value) && value.label?.toLowerCase() === displayLabel) {
+                // TODO: this can be optimized. We don't have to await these if we don't want to check for them
                 const currPhenomenon = await value.phenomenon;
                 const currUnitSystem = await value.unitSystem;
                 if (!schemaName || value.schema.name.toLowerCase() === schemaName)
                     if (!phenomenon || (currPhenomenon && currPhenomenon.key.matchesFullName(phenomenon)))
                         if (!unitSystem || (currUnitSystem && currUnitSystem.key.matchesFullName(unitSystem)))
-                            return value;
+                            return this.getUnitsProps(value);
+            }
+            else if (InvertedUnit.isInvertedUnit(value) && value.label?.toLowerCase() === displayLabel && value.invertsUnit) {
+                const invertsUnit = await value.invertsUnit;
+                if (invertsUnit) {
+                    const currPhenomenon = await invertsUnit.phenomenon;
+                    const currUnitSystem = await invertsUnit.unitSystem;
+                    if (!schemaName || value.schema.name.toLowerCase() === schemaName)
+                        if (!phenomenon || (currPhenomenon && currPhenomenon.key.matchesFullName(phenomenon)))
+                            if (!unitSystem || (currUnitSystem && currUnitSystem.key.matchesFullName(unitSystem)))
+                                return this.getUnitsProps(value);
+                }
             }
             ({ value, done } = schemaItems.next());
         }
-        throw new BentleyError(BentleyStatus.ERROR, "Cannot find unit with display label", () => {
-            return { displayLabel };
-        });
+        return new BadUnit();
     }
     /**
      * Finds Unit by altDisplayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.
@@ -213,19 +253,21 @@ export class SchemaUnitProvider {
             if (entry.altDisplayLabels && entry.altDisplayLabels.length > 0) {
                 if (entry.altDisplayLabels.findIndex((ref) => ref.toLowerCase() === altDisplayLabel) !== -1) {
                     // Found altDisplayLabel that matches label to find
-                    const unit = await this.findECUnitByName(entry.name);
-                    const foundPhenomenon = await unit.phenomenon;
-                    const foundUnitSystem = await unit.unitSystem;
-                    if (!schemaName || unit.schema.name.toLowerCase() === schemaName)
-                        if (!phenomenon || (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)))
-                            if (!unitSystem || (foundUnitSystem && foundUnitSystem.key.matchesFullName(unitSystem)))
-                                return unit;
+                    const unitProps = await this.findUnitByName(entry.name);
+                    // If no schemaName, phenomenon, or unitSystem are provided, return unitProps
+                    if (!schemaName && !phenomenon && !unitSystem)
+                        return unitProps;
+                    // Check if the provided values match unitProps
+                    const schemaNameMatches = !schemaName || unitProps.name.toLowerCase().startsWith(schemaName);
+                    const phenomenonMatches = !phenomenon || unitProps.phenomenon.toLowerCase() === phenomenon;
+                    const unitSystemMatches = !unitSystem || unitProps.system.toLowerCase() === unitSystem;
+                    // If all provided values match, return unitProps
+                    if (schemaNameMatches && phenomenonMatches && unitSystemMatches)
+                        return unitProps;
                 }
             }
         }
-        throw new BentleyError(BentleyStatus.ERROR, "Cannot find unit with alternate display label", () => {
-            return { altDisplayLabel };
-        });
+        return new BadUnit();
     }
 }
 //# sourceMappingURL=SchemaUnitProvider.js.map

package/lib/esm/UnitProvider/SchemaUnitProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaUnitProvider.js","sourceRoot":"","sources":["../../../src/UnitProvider/SchemaUnitProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAElE,OAAO,EAAkB,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEhE;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IAI7B;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAU,iBAAkC,EAAE;QAApC,mBAAc,GAAd,cAAc,CAAsB;QACxF,IAAI,gBAAgB,YAAY,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QAC9C,yDAAyD;QACzD,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,mCAAmC,EAAE,GAAG,EAAE;gBACpF,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,oCAAoC,EAAE,GAAG,EAAE;gBACrF,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YACtD,CAAC,CAAC,CAAC;QAEL,IAAI,MAAM,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU;YACrD,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,0BAA0B,EAAE,GAAG,EAAE;gBAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC3C,CAAC,CAAC,CAAC;QAEL,2DAA2D;QAC3D,MAAM,aAAa,GAAqB,EAAE,CAAC;QAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QACnD,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACzC,OAAO,CAAC,IAAI,EAAE,CAAC;YACb,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC/C,IAAI,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;oBACvE,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;oBAC5C,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;YACD,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,yBAAyB,CAAC,QAAgB;QAC/C,IAAI,eAAe,GAAkB,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxD,eAAe,GAAG,KAAK,CAAC,gBAAgB,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QACpG,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,IAAI,SAA2B,CAAC;QAEhC,IAAI,CAAC;YACH,IAAI,CAAC;gBACH,SAAS,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;YACvG,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,oHAAoH;gBACpH,SAAS,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;YAC1G,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,GAAG,EAAE;gBAC9E,OAAO,EAAE,SAAS,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,QAAmB,EAAE,MAAiB;QAC/D,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7F,OAAO;YACL,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,gBAAgB,CAAC,QAAgB;QAC7C,mDAAmD;QACnD,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,6BAA6B,EAAE,GAAG,EAAE;gBAC9E,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAO,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,8BAA8B,EAAE,GAAG,EAAE;gBAC/E,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YACtD,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI;YAC7C,OAAO,IAAI,CAAC;QAEd,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,oBAAoB,EAAE,GAAG,EAAE;YACrE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,aAAa,CAAC,IAAU;QAC9B,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,QAAQ;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAC3D,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ;SACtE,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,sBAAsB,CAAC,YAAoB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QACtH,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QACnD,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACzC,OAAO,CAAC,IAAI,EAAE,CAAC;YACb,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,CAAC;gBACtE,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC9C,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC9C,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU;oBAC/D,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;wBACnF,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;4BACnF,OAAO,KAAK,CAAC;YACrB,CAAC;YACD,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,qCAAqC,EAAE,GAAG,EAAE;YACtF,OAAO,EAAE,YAAY,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,yBAAyB,CAAC,eAAuB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QAC5H,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,gBAAgB,IAAI,KAAK,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChE,IAAI,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;oBACpG,mDAAmD;oBACnD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACrD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;oBAC9C,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;oBAC9C,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU;wBAC9D,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;4BACrF,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;gCACrF,OAAO,IAAI,CAAC;gBACpB,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,+CAA+C,EAAE,GAAG,EAAE;YAChG,OAAO,EAAE,eAAe,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { BentleyError, BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { UnitConversionProps, UnitExtraData, UnitProps, UnitsProvider } from \"@itwin/core-quantity\";\r\nimport { ISchemaLocater, SchemaContext } from \"../Context\";\r\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\r\nimport { SchemaItemKey, SchemaKey } from \"../SchemaKey\";\r\nimport { Unit } from \"../Metadata/Unit\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { UnitConverter } from \"../UnitConversion/UnitConverter\";\r\n\r\n/**\r\n * Class used to find Units in SchemaContext by attributes such as Phenomenon and DisplayLabel.\r\n * @beta\r\n */\r\nexport class SchemaUnitProvider implements UnitsProvider {\r\n  private _unitConverter: UnitConverter;\r\n  private _context: SchemaContext;\r\n\r\n  /**\r\n   *\r\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\r\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\r\n   * created and the locater will be added.\r\n   * @param _unitExtraData Additional data like alternate display label not found in Units Schema to match with Units; Defaults to empty array.\r\n   */\r\n  constructor(contextOrLocater: ISchemaLocater, private _unitExtraData: UnitExtraData[] = []){\r\n    if (contextOrLocater instanceof SchemaContext) {\r\n      this._context = contextOrLocater;\r\n    } else {\r\n      this._context = new SchemaContext();\r\n      this._context.addLocater(contextOrLocater);\r\n    }\r\n    this._unitConverter = new UnitConverter(this._context);\r\n  }\r\n\r\n  /**\r\n   * Find unit in a schema that has unitName.\r\n   * @param unitName Full name of unit.\r\n   * @returns UnitProps interface from @itwin/core-quantity whose name matches unitName.\r\n   */\r\n  public async findUnitByName(unitName: string): Promise<UnitProps> {\r\n    const unit = await this.findECUnitByName(unitName);\r\n    return this.getUnitsProps(unit);\r\n  }\r\n\r\n  /**\r\n   * Find all units in context that belongs to given phenomenon.\r\n   * @param phenomenon Full name of phenomenon.\r\n   * @returns Array of UnitProps (from @itwin/core-quantity) interface objects whose name matches phenomenon param.\r\n   */\r\n  public async getUnitsByFamily(phenomenon: string): Promise<Array<UnitProps>> {\r\n    // Check if schema exists and phenomenon exists in schema\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(phenomenon);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema for phenomenon\", () => {\r\n        return { phenomenon, schema: schemaName };\r\n      });\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const phenom = await this._context.getSchemaItem(itemKey);\r\n    if (!phenom)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema item/phenomenon\", () => {\r\n        return { item: schemaItemName, schema: schemaName };\r\n      });\r\n\r\n    if (phenom.schemaItemType !== SchemaItemType.Phenomenon)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Item is not a phenomenon\", () => {\r\n        return { itemType: phenom.key.fullName };\r\n      });\r\n\r\n    // Find units' full name that match given phenomenon param.\r\n    const filteredUnits: Array<UnitProps> = [];\r\n    const schemaItems = this._context.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (Unit.isUnit(value)) {\r\n        const foundPhenomenon = await value.phenomenon;\r\n        if (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)) {\r\n          const unitProps = this.getUnitsProps(value);\r\n          filteredUnits.push(unitProps);\r\n        }\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    return filteredUnits;\r\n  }\r\n\r\n  /**\r\n   * Find alternate display labels associated with unitName, if any.\r\n   * @param unitName Full name of Unit.\r\n   */\r\n  public getAlternateDisplayLabels(unitName: string): Array<string> {\r\n    let alternateLabels: Array<string> = [];\r\n    for (const entry of this._unitExtraData) {\r\n      if (entry.name.toLowerCase() === unitName.toLowerCase()) {\r\n        alternateLabels = entry.altDisplayLabels;\r\n      }\r\n    }\r\n\r\n    return alternateLabels;\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by unitLabel, which could be a display label in the schema or alternate an display label defined in\r\n   * this._unitExtraData. If there are duplicates of the same display label in the context or teh same alternate display\r\n   * labels, specify schemaName, phenomenon, or unitSystem to get a specific unit.\r\n   *\r\n   * @param unitLabel Display label or alternate display label to query unit by.\r\n   * @param schemaName Ensure Unit with unitLabel belongs to Schema with schemaName.\r\n   * @param phenomenon Full name of phenomenon that Unit belongs to.\r\n   * @param unitSystem Full name of unitSystem that Unit belongs to.\r\n   * @returns The UnitProps interface from the @itwin/core-quantity package.\r\n   */\r\n  public async findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\r\n    const findLabel = unitLabel.toLowerCase();\r\n    const findSchema = schemaName ? schemaName.toLowerCase() : undefined;\r\n    const findPhenomenon = phenomenon ? phenomenon.toLowerCase() : undefined;\r\n    const findUnitSystem = unitSystem ? unitSystem.toLowerCase() : undefined;\r\n    let foundUnit: Unit | undefined;\r\n\r\n    try {\r\n      try {\r\n        foundUnit = await this.findUnitByDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);\r\n      } catch (err) {\r\n        // If there is no Unit with display label that matches label, then check for alternate display labels that may match\r\n        foundUnit = await this.findUnitByAltDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);\r\n      }\r\n    } catch (err) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with label\", () => {\r\n        return { unitLabel };\r\n      });\r\n    }\r\n\r\n    return this.getUnitsProps(foundUnit);\r\n  }\r\n\r\n  /**\r\n   * Gets the @itwin/core-quantity UnitConversionProps for the given fromUnit and toUnit.\r\n   * @param fromUnit The UnitProps of the 'from' unit.\r\n   * @param toUnit The UnitProps of the 'to' unit.\r\n   * @returns The UnitConversionProps interface from the @itwin/core-quantity package.\r\n   */\r\n  public async getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversionProps> {\r\n    const conversion = await this._unitConverter.calculateConversion(fromUnit.name, toUnit.name);\r\n    return {\r\n      factor: conversion.factor,\r\n      offset: conversion.offset,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Find unit in a schema that has unitName.\r\n   * @param unitName Full name of unit.\r\n   * @returns Unit whose full name matches unitName.\r\n   */\r\n  private async findECUnitByName(unitName: string): Promise<Unit> {\r\n    // Check if schema exists and unit exists in schema\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(unitName);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema for unit\", () => {\r\n        return { schema: schemaName, unit: unitName };\r\n      });\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const item = await this._context.getSchemaItem<Unit>(itemKey);\r\n    if (!item)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema item/unit\", () => {\r\n        return { item: schemaItemName, schema: schemaName };\r\n      });\r\n\r\n    if (item.schemaItemType === SchemaItemType.Unit)\r\n      return item;\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Item is not a unit\", () => {\r\n      return { itemType: item.key.fullName };\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Gets the @itwin/core UnitProps for the given Unit.\r\n   * @param unit The Unit to convert.\r\n   * @returns UnitProps interface from @itwin/core.\r\n   */\r\n  private getUnitsProps(unit: Unit): UnitProps {\r\n    return {\r\n      name: unit.fullName,\r\n      label: unit.label ?? \"\",\r\n      phenomenon: unit.phenomenon ? unit.phenomenon.fullName : \"\",\r\n      isValid: true,\r\n      system: unit.unitSystem === undefined ? \"\" : unit.unitSystem.fullName,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by displayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.\r\n   * @internal\r\n   */\r\n  private async findUnitByDisplayLabel(displayLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<Unit> {\r\n    const schemaItems = this._context.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (Unit.isUnit(value) && value.label?.toLowerCase() === displayLabel) {\r\n        const currPhenomenon = await value.phenomenon;\r\n        const currUnitSystem = await value.unitSystem;\r\n        if (!schemaName || value.schema.name.toLowerCase() === schemaName)\r\n          if (!phenomenon || (currPhenomenon && currPhenomenon.key.matchesFullName(phenomenon)))\r\n            if (!unitSystem || (currUnitSystem && currUnitSystem.key.matchesFullName(unitSystem)))\r\n              return value;\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with display label\", () => {\r\n      return { displayLabel };\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by altDisplayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.\r\n   * @internal\r\n   */\r\n  private async findUnitByAltDisplayLabel(altDisplayLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<Unit> {\r\n    for (const entry of this._unitExtraData) {\r\n      if (entry.altDisplayLabels && entry.altDisplayLabels.length > 0) {\r\n        if (entry.altDisplayLabels.findIndex((ref: string) => ref.toLowerCase() === altDisplayLabel) !== -1) {\r\n          // Found altDisplayLabel that matches label to find\r\n          const unit = await this.findECUnitByName(entry.name);\r\n          const foundPhenomenon = await unit.phenomenon;\r\n          const foundUnitSystem = await unit.unitSystem;\r\n          if (!schemaName || unit.schema.name.toLowerCase() === schemaName)\r\n            if (!phenomenon || (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)))\r\n              if (!unitSystem || (foundUnitSystem && foundUnitSystem.key.matchesFullName(unitSystem)))\r\n                return unit;\r\n        }\r\n      }\r\n    }\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with alternate display label\", () => {\r\n      return { altDisplayLabel };\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SchemaUnitProvider.js","sourceRoot":"","sources":["../../../src/UnitProvider/SchemaUnitProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAgE,MAAM,sBAAsB,CAAC;AACnI,OAAO,EAAkB,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IAI7B;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAU,iBAAkC,EAAE;QAApC,mBAAc,GAAd,cAAc,CAAsB;QACxF,IAAI,gBAAgB,YAAY,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC1C,mDAAmD;QACnD,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,0CAA0C;QAClE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAO,OAAO,CAAC,CAAC;QAC9D,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI;YACrD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAElC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAe,OAAO,CAAC,CAAC;QAC9E,IAAI,YAAY,IAAI,YAAY,CAAC,cAAc,KAAK,cAAc,CAAC,YAAY,EAAE,CAAC;YAChF,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QAC9C,yDAAyD;QACzD,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAExD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,mCAAmC,EAAE,GAAG,EAAE;gBACpF,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YAC5C,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,oCAAoC,EAAE,GAAG,EAAE;gBACrF,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YACtD,CAAC,CAAC,CAAC;QAEL,IAAI,MAAM,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU;YACrD,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,0BAA0B,EAAE,GAAG,EAAE;gBAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC3C,CAAC,CAAC,CAAC;QAEL,2DAA2D;QAC3D,MAAM,aAAa,GAAqB,EAAE,CAAC;QAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QACnD,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACzC,OAAO,CAAC,IAAI,EAAE,CAAC;YACb,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC/C,IAAI,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;oBACvE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;oBAClD,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;iBAAM,IAAI,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;gBACnE,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,WAAW,CAAC;gBAC5C,IAAI,WAAW,EAAE,CAAC;oBAChB,MAAM,eAAe,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC;oBACrD,IAAI,eAAe,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;wBACvE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;wBAClD,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAChC,CAAC;gBACH,CAAC;YACH,CAAC;YACD,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,yBAAyB,CAAC,QAAgB;QAC/C,IAAI,eAAe,GAAkB,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxD,eAAe,GAAG,KAAK,CAAC,gBAAgB,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QACpG,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEzE,MAAM,SAAS,GAAc,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;QACtH,IAAI,SAAS,CAAC,OAAO;YACnB,OAAO,SAAS,CAAC;QAEnB,oHAAoH;QACpH,OAAO,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,QAAmB,EAAE,MAAiB;QAC/D,4FAA4F;QAC5F,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO;YACtC,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,oCAAoC,EAAE,GAAG,EAAE;gBACrF,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QAEL,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/H,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEzH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QAC3F,MAAM,MAAM,GAAwB;YAClC,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC;QACF,IAAI,cAAc,IAAI,CAAC,YAAY;YACjC,MAAM,CAAC,SAAS,GAAG,oBAAoB,CAAC,mBAAmB,CAAC;aACzD,IAAI,CAAC,cAAc,IAAI,YAAY;YACtC,MAAM,CAAC,SAAS,GAAG,oBAAoB,CAAC,oBAAoB,CAAC;QAE/D,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,2BAA2B,CAAC,KAAgB,EAAE,OAAsB;QAChF,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,mCAAmC,EAAE,GAAG,EAAE;gBACpF,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACpE,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,aAAa,CAAe,OAAO,CAAC,CAAC;QACxE,mGAAmG;QACnG,IAAI,YAAY,IAAI,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC;YAC1F,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QAC3E,CAAC;QAED,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,aAAa,CAAC,IAAyB;QACnD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO;gBACL,IAAI,EAAE,IAAI,CAAC,QAAQ;gBACnB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;gBACvB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;gBAC3D,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ;aACtE,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,WAAW;YACd,OAAO,IAAI,OAAO,EAAE,CAAC;QAEvB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,QAAQ;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;YACvB,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YACzE,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ;SACtE,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,sBAAsB,CAAC,YAAoB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QACtH,0HAA0H;QAC1H,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QACnD,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACzC,OAAO,CAAC,IAAI,EAAE,CAAC;YACb,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,CAAC;gBACtE,+FAA+F;gBAC/F,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC9C,MAAM,cAAc,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;gBAC9C,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU;oBAC/D,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;wBACnF,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;4BACnF,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACzC,CAAC;iBAAM,IAAI,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,YAAY,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;gBAClH,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,WAAW,CAAC;gBAC5C,IAAI,WAAW,EAAE,CAAC;oBAChB,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC;oBACpD,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC;oBACpD,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU;wBAC/D,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;4BACnF,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;gCACnF,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;YACD,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,CAAC;QAED,OAAO,IAAI,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,yBAAyB,CAAC,eAAuB,EAAE,UAAmB,EAAE,UAAmB,EAAE,UAAmB;QAC5H,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,gBAAgB,IAAI,KAAK,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChE,IAAI,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;oBACpG,mDAAmD;oBACnD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACxD,6EAA6E;oBAC7E,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU;wBAC3C,OAAO,SAAS,CAAC;oBAEnB,+CAA+C;oBAC/C,MAAM,iBAAiB,GAAG,CAAC,UAAU,IAAI,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;oBAC7F,MAAM,iBAAiB,GAAG,CAAC,UAAU,IAAI,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC;oBAC3F,MAAM,iBAAiB,GAAG,CAAC,UAAU,IAAI,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC;oBACvF,iDAAiD;oBACjD,IAAI,iBAAiB,IAAI,iBAAiB,IAAI,iBAAiB;wBAC7D,OAAO,SAAS,CAAC;gBACrB,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAI,OAAO,EAAE,CAAC;IACvB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { BentleyError, BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { BadUnit, UnitConversionInvert, UnitConversionProps, UnitExtraData, UnitProps, UnitsProvider } from \"@itwin/core-quantity\";\r\nimport { ISchemaLocater, SchemaContext } from \"../Context\";\r\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\r\nimport { SchemaItemKey, SchemaKey } from \"../SchemaKey\";\r\nimport { Unit } from \"../Metadata/Unit\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { UnitConverter } from \"../UnitConversion/UnitConverter\";\r\nimport { InvertedUnit } from \"../Metadata/InvertedUnit\";\r\n\r\n/**\r\n * Class used to find Units in SchemaContext by attributes such as Phenomenon and DisplayLabel.\r\n * @beta\r\n */\r\nexport class SchemaUnitProvider implements UnitsProvider {\r\n  private _unitConverter: UnitConverter;\r\n  private _context: SchemaContext;\r\n\r\n  /**\r\n   *\r\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\r\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\r\n   * created and the locater will be added.\r\n   * @param _unitExtraData Additional data like alternate display label not found in Units Schema to match with Units; Defaults to empty array.\r\n   */\r\n  constructor(contextOrLocater: ISchemaLocater, private _unitExtraData: UnitExtraData[] = []) {\r\n    if (contextOrLocater instanceof SchemaContext) {\r\n      this._context = contextOrLocater;\r\n    } else {\r\n      this._context = new SchemaContext();\r\n      this._context.addLocater(contextOrLocater);\r\n    }\r\n    this._unitConverter = new UnitConverter(this._context);\r\n  }\r\n\r\n  /**\r\n   * Find unit in a schema that has unitName.\r\n   * @param unitName Full name of unit.\r\n   * @returns UnitProps interface from @itwin/core-quantity whose name matches unitName.\r\n   */\r\n  public async findUnitByName(unitName: string): Promise<UnitProps> {\r\n    // Check if schema exists and unit exists in schema\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(unitName);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      return new BadUnit(); // return BadUnit if schema does not exist\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const unit = await this._context.getSchemaItem<Unit>(itemKey);\r\n    if (unit && unit.schemaItemType === SchemaItemType.Unit)\r\n      return this.getUnitsProps(unit);\r\n\r\n    const invertedUnit = await this._context.getSchemaItem<InvertedUnit>(itemKey);\r\n    if (invertedUnit && invertedUnit.schemaItemType === SchemaItemType.InvertedUnit) {\r\n      return this.getUnitsProps(invertedUnit);\r\n    }\r\n\r\n    return new BadUnit();\r\n  }\r\n\r\n  /**\r\n   * Find all units in context that belongs to given phenomenon.\r\n   * @param phenomenon Full name of phenomenon.\r\n   * @returns Array of UnitProps (from @itwin/core-quantity) interface objects whose name matches phenomenon param.\r\n   */\r\n  public async getUnitsByFamily(phenomenon: string): Promise<Array<UnitProps>> {\r\n    // Check if schema exists and phenomenon exists in schema\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(phenomenon);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema for phenomenon\", () => {\r\n        return { phenomenon, schema: schemaName };\r\n      });\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const phenom = await this._context.getSchemaItem(itemKey);\r\n    if (!phenom)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema item/phenomenon\", () => {\r\n        return { item: schemaItemName, schema: schemaName };\r\n      });\r\n\r\n    if (phenom.schemaItemType !== SchemaItemType.Phenomenon)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Item is not a phenomenon\", () => {\r\n        return { itemType: phenom.key.fullName };\r\n      });\r\n\r\n    // Find units' full name that match given phenomenon param.\r\n    const filteredUnits: Array<UnitProps> = [];\r\n    const schemaItems = this._context.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (Unit.isUnit(value)) {\r\n        const foundPhenomenon = await value.phenomenon;\r\n        if (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)) {\r\n          const unitProps = await this.getUnitsProps(value);\r\n          filteredUnits.push(unitProps);\r\n        }\r\n      } else if (InvertedUnit.isInvertedUnit(value) && value.invertsUnit) {\r\n        const invertsUnit = await value.invertsUnit;\r\n        if (invertsUnit) {\r\n          const foundPhenomenon = await invertsUnit.phenomenon;\r\n          if (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)) {\r\n            const unitProps = await this.getUnitsProps(value);\r\n            filteredUnits.push(unitProps);\r\n          }\r\n        }\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    return filteredUnits;\r\n  }\r\n\r\n  /**\r\n   * Find alternate display labels associated with unitName, if any.\r\n   * @param unitName Full name of Unit.\r\n   */\r\n  public getAlternateDisplayLabels(unitName: string): Array<string> {\r\n    let alternateLabels: Array<string> = [];\r\n    for (const entry of this._unitExtraData) {\r\n      if (entry.name.toLowerCase() === unitName.toLowerCase()) {\r\n        alternateLabels = entry.altDisplayLabels;\r\n      }\r\n    }\r\n\r\n    return alternateLabels;\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by unitLabel, which could be a display label in the schema or alternate an display label defined in\r\n   * this._unitExtraData. If there are duplicates of the same display label in the context or teh same alternate display\r\n   * labels, specify schemaName, phenomenon, or unitSystem to get a specific unit.\r\n   *\r\n   * @param unitLabel Display label or alternate display label to query unit by.\r\n   * @param schemaName Ensure Unit with unitLabel belongs to Schema with schemaName.\r\n   * @param phenomenon Full name of phenomenon that Unit belongs to.\r\n   * @param unitSystem Full name of unitSystem that Unit belongs to.\r\n   * @returns The UnitProps interface from the @itwin/core-quantity package.\r\n   */\r\n  public async findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\r\n    const findLabel = unitLabel.toLowerCase();\r\n    const findSchema = schemaName ? schemaName.toLowerCase() : undefined;\r\n    const findPhenomenon = phenomenon ? phenomenon.toLowerCase() : undefined;\r\n    const findUnitSystem = unitSystem ? unitSystem.toLowerCase() : undefined;\r\n\r\n    const foundUnit: UnitProps = await this.findUnitByDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);\r\n    if (foundUnit.isValid)\r\n      return foundUnit;\r\n\r\n    // If there is no Unit with display label that matches label, then check for alternate display labels that may match\r\n    return this.findUnitByAltDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);\r\n  }\r\n\r\n  /**\r\n   * Gets the @itwin/core-quantity UnitConversionProps for the given fromUnit and toUnit.\r\n   * @param fromUnit The UnitProps of the 'from' unit.\r\n   * @param toUnit The UnitProps of the 'to' unit.\r\n   * @returns The UnitConversionProps interface from the @itwin/core-quantity package.\r\n   */\r\n  public async getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversionProps> {\r\n    // need to check if either side is an inverted unit. The UnitConverter can only handle Units\r\n    if (!fromUnit.isValid || !toUnit.isValid)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Both provided units must be valid.\", () => {\r\n        return { fromUnit, toUnit };\r\n      });\r\n\r\n    const { unitName: fromUnitName, isInverted: fromIsInverted } = await this.checkUnitPropsForConversion(fromUnit, this._context);\r\n    const { unitName: toUnitName, isInverted: toIsInverted } = await this.checkUnitPropsForConversion(toUnit, this._context);\r\n\r\n    const conversion = await this._unitConverter.calculateConversion(fromUnitName, toUnitName);\r\n    const result: UnitConversionProps = {\r\n      factor: conversion.factor,\r\n      offset: conversion.offset,\r\n    };\r\n    if (fromIsInverted && !toIsInverted)\r\n      result.inversion = UnitConversionInvert.InvertPreConversion;\r\n    else if (!fromIsInverted && toIsInverted)\r\n      result.inversion = UnitConversionInvert.InvertPostConversion;\r\n\r\n    return result;\r\n  }\r\n\r\n  private async checkUnitPropsForConversion(input: UnitProps, context: SchemaContext): Promise<{ unitName: string, isInverted: boolean }> {\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(input.name);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Could not obtain schema for unit.\", () => {\r\n        return { name: input.name };\r\n      });\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const invertedUnit = await context.getSchemaItem<InvertedUnit>(itemKey);\r\n    // Check if we found an item, the item is an inverted unit, and it has its invertsUnit property set\r\n    if (invertedUnit && InvertedUnit.isInvertedUnit(invertedUnit) && invertedUnit.invertsUnit) {\r\n      return { unitName: invertedUnit.invertsUnit.fullName, isInverted: true };\r\n    }\r\n\r\n    return { unitName: input.name, isInverted: false };\r\n  }\r\n\r\n  /**\r\n   * Gets the @itwin/core UnitProps for the given Unit.\r\n   * @param unit The Unit to convert.\r\n   * @returns UnitProps interface from @itwin/core.\r\n   */\r\n  private async getUnitsProps(unit: Unit | InvertedUnit): Promise<UnitProps> {\r\n    if (Unit.isUnit(unit)) {\r\n      return {\r\n        name: unit.fullName,\r\n        label: unit.label ?? \"\",\r\n        phenomenon: unit.phenomenon ? unit.phenomenon.fullName : \"\",\r\n        isValid: true,\r\n        system: unit.unitSystem === undefined ? \"\" : unit.unitSystem.fullName,\r\n      };\r\n    }\r\n\r\n    const invertsUnit = await unit.invertsUnit;\r\n    if (!invertsUnit)\r\n      return new BadUnit();\r\n\r\n    return {\r\n      name: unit.fullName,\r\n      label: unit.label ?? \"\",\r\n      phenomenon: invertsUnit.phenomenon ? invertsUnit.phenomenon.fullName : \"\",\r\n      isValid: true,\r\n      system: unit.unitSystem === undefined ? \"\" : unit.unitSystem.fullName,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by displayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.\r\n   * @internal\r\n   */\r\n  private async findUnitByDisplayLabel(displayLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\r\n    // TODO: Known bug: This only looks through loaded schemas. If schema name is provided, we can attempt to load that schema\r\n    const schemaItems = this._context.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (Unit.isUnit(value) && value.label?.toLowerCase() === displayLabel) {\r\n        // TODO: this can be optimized. We don't have to await these if we don't want to check for them\r\n        const currPhenomenon = await value.phenomenon;\r\n        const currUnitSystem = await value.unitSystem;\r\n        if (!schemaName || value.schema.name.toLowerCase() === schemaName)\r\n          if (!phenomenon || (currPhenomenon && currPhenomenon.key.matchesFullName(phenomenon)))\r\n            if (!unitSystem || (currUnitSystem && currUnitSystem.key.matchesFullName(unitSystem)))\r\n              return this.getUnitsProps(value);\r\n      } else if (InvertedUnit.isInvertedUnit(value) && value.label?.toLowerCase() === displayLabel && value.invertsUnit) {\r\n        const invertsUnit = await value.invertsUnit;\r\n        if (invertsUnit) {\r\n          const currPhenomenon = await invertsUnit.phenomenon;\r\n          const currUnitSystem = await invertsUnit.unitSystem;\r\n          if (!schemaName || value.schema.name.toLowerCase() === schemaName)\r\n            if (!phenomenon || (currPhenomenon && currPhenomenon.key.matchesFullName(phenomenon)))\r\n              if (!unitSystem || (currUnitSystem && currUnitSystem.key.matchesFullName(unitSystem)))\r\n                return this.getUnitsProps(value);\r\n        }\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    return new BadUnit();\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by altDisplayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.\r\n   * @internal\r\n   */\r\n  private async findUnitByAltDisplayLabel(altDisplayLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\r\n    for (const entry of this._unitExtraData) {\r\n      if (entry.altDisplayLabels && entry.altDisplayLabels.length > 0) {\r\n        if (entry.altDisplayLabels.findIndex((ref: string) => ref.toLowerCase() === altDisplayLabel) !== -1) {\r\n          // Found altDisplayLabel that matches label to find\r\n          const unitProps = await this.findUnitByName(entry.name);\r\n          // If no schemaName, phenomenon, or unitSystem are provided, return unitProps\r\n          if (!schemaName && !phenomenon && !unitSystem)\r\n            return unitProps;\r\n\r\n          // Check if the provided values match unitProps\r\n          const schemaNameMatches = !schemaName || unitProps.name.toLowerCase().startsWith(schemaName);\r\n          const phenomenonMatches = !phenomenon || unitProps.phenomenon.toLowerCase() === phenomenon;\r\n          const unitSystemMatches = !unitSystem || unitProps.system.toLowerCase() === unitSystem;\r\n          // If all provided values match, return unitProps\r\n          if (schemaNameMatches && phenomenonMatches && unitSystemMatches)\r\n            return unitProps;\r\n        }\r\n      }\r\n    }\r\n    return new BadUnit();\r\n  }\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/ecschema-metadata",
-  "version": "4.10.0-dev.9",
+  "version": "5.0.0-dev.1",
   "description": "ECObjects core concepts in typescript",
   "license": "MIT",
   "main": "lib/cjs/ecschema-metadata.js",
@@ -24,7 +24,7 @@
   },
   "devDependencies": {
     "@bentley/units-schema": "^1.0.8",
-    "@itwin/eslint-plugin": "^4.0.2",
+    "@itwin/eslint-plugin": "5.0.0-dev.1",
     "@types/benchmark": "^2.1.0",
     "@types/chai": "4.3.1",
     "@types/chai-as-promised": "^7",
@@ -36,19 +36,19 @@
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
     "cpx2": "^3.0.0",
-    "eslint": "^8.56.0",
+    "eslint": "^9.13.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
     "sinon": "^17.0.2",
-    "typescript": "~5.3.3",
-    "@itwin/build-tools": "4.10.0-dev.9",
-    "@itwin/core-bentley": "4.10.0-dev.9",
-    "@itwin/core-quantity": "4.10.0-dev.9"
+    "typescript": "~5.6.2",
+    "@itwin/build-tools": "5.0.0-dev.1",
+    "@itwin/core-bentley": "5.0.0-dev.1",
+    "@itwin/core-quantity": "5.0.0-dev.1"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^4.10.0-dev.9",
-    "@itwin/core-quantity": "^4.10.0-dev.9"
+    "@itwin/core-bentley": "^5.0.0-dev.1",
+    "@itwin/core-quantity": "^5.0.0-dev.1"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc"
@@ -60,7 +60,7 @@
     "clean": "rimraf lib .rush/temp/package-deps*.json",
     "copy:test-assets": "cpx \"./src/test/assets/**/*\" ./lib/cjs/test/assets",
     "extract-api": "betools extract-api --entry=ecschema-metadata",
-    "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
+    "lint": "eslint \"./src/**/*.ts\" 1>&2",
     "test": "mocha",
     "docs": "betools docs --includes=../../generated-docs/extract --json=../../generated-docs/core/ecschema-metadata/file.json --tsIndexFile=./ecschema-metadata.ts --onlyJson",
     "cover": "nyc npm -s test",