@itwin/ecschema-metadata 4.8.0-dev.9 → 4.9.0-dev.1

package/lib/esm/UnitConversion/UnitConverter.d.ts

@@ -0,0 +1,40 @@
+import { SchemaContext } from "../Context";
+import { UnitConversion } from "./UnitConversion";
+/**
+ * Class constructed with SchemaContext and used to calculate [[UnitConversion]] between Units
+ * @internal
+ */
+export declare class UnitConverter {
+    private readonly _context;
+    private _uGraph;
+    /**
+     * Create Converter context
+     * @param _context SchemaContext with contexts added to it.
+     */
+    constructor(_context: SchemaContext);
+    /**
+     * Find conversion between from and to units, formatted {schemaName}.{schemaItemName} or {schemaName}:{schemaItemName}
+     * @param fromUnit SchemaItem full name of source unit
+     * @param toUnit SchemaItem full name of target unit
+     * @returns [[UnitConversion]] converting fromUnit -> toUnit with a factor and an offset
+     * @throws Error if from and to Units' SchemaItem is not found in Schema or Schema prefix is not found in SchemaContext
+     * @throws Error if from and to Units do not belong to the same phenomenon
+     * @throws Error if definitions' SchemaItems cannot be found in its own or referenced Schemas
+     * @throws Error if base units of source and target unit do not match
+     */
+    calculateConversion(fromUnit: string, toUnit: string): Promise<UnitConversion>;
+    /**
+     * @param from Source unit converted from
+     * @param to Target unit converted to
+     * @internal
+     */
+    private processUnits;
+    /**
+     * Check if fromBaseUnits's base units and exponents matches toBaseUnits's
+     * @param fromBaseUnits Map of base units for source unit
+     * @param toBaseUnits Map of base units for target unit
+     * @internal
+     */
+    private checkBaseUnitsMatch;
+}
+//# sourceMappingURL=UnitConverter.d.ts.map

package/lib/esm/UnitConversion/UnitConverter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnitConverter.d.ts","sourceRoot":"","sources":["../../../src/UnitConversion/UnitConverter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGlD;;;GAGG;AACH,qBAAa,aAAa;IAOZ,OAAO,CAAC,QAAQ,CAAC,QAAQ;IANrC,OAAO,CAAC,OAAO,CAAY;IAE3B;;;OAGG;gBAC0B,QAAQ,EAAE,aAAa;IAIpD;;;;;;;;;OASG;IACU,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAqB3F;;;;OAIG;YACW,YAAY;IAiC1B;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;CA4B5B"}

package/lib/esm/UnitConversion/UnitConverter.js

@@ -0,0 +1,113 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { BentleyError, BentleyStatus } from "@itwin/core-bentley";
+import { SchemaItem } from "../Metadata/SchemaItem";
+import { Unit } from "../Metadata/Unit";
+import { SchemaKey } from "../SchemaKey";
+import { UnitConversion } from "./UnitConversion";
+import { UnitGraph } from "./UnitTree";
+/**
+ * Class constructed with SchemaContext and used to calculate [[UnitConversion]] between Units
+ * @internal
+ */
+export class UnitConverter {
+    /**
+     * Create Converter context
+     * @param _context SchemaContext with contexts added to it.
+     */
+    constructor(_context) {
+        this._context = _context;
+        this._uGraph = new UnitGraph(this._context);
+    }
+    /**
+     * Find conversion between from and to units, formatted {schemaName}.{schemaItemName} or {schemaName}:{schemaItemName}
+     * @param fromUnit SchemaItem full name of source unit
+     * @param toUnit SchemaItem full name of target unit
+     * @returns [[UnitConversion]] converting fromUnit -> toUnit with a factor and an offset
+     * @throws Error if from and to Units' SchemaItem is not found in Schema or Schema prefix is not found in SchemaContext
+     * @throws Error if from and to Units do not belong to the same phenomenon
+     * @throws Error if definitions' SchemaItems cannot be found in its own or referenced Schemas
+     * @throws Error if base units of source and target unit do not match
+     */
+    async calculateConversion(fromUnit, toUnit) {
+        const [fromSchemaName, fromSchemaItemName] = SchemaItem.parseFullName(fromUnit);
+        const [toSchemaName, toSchemaItemName] = SchemaItem.parseFullName(toUnit);
+        const fromSchemaKey = new SchemaKey(fromSchemaName);
+        const toSchemaKey = new SchemaKey(toSchemaName);
+        const fromSchema = await this._context.getSchema(fromSchemaKey);
+        const toSchema = await this._context.getSchema(toSchemaKey);
+        if (!fromSchema || !toSchema) {
+            throw new BentleyError(BentleyStatus.ERROR, "Cannot find from's and/or to's schema", () => {
+                return { from: fromUnit, fromSchema: fromSchemaName, to: toUnit, toSchema: toSchemaName };
+            });
+        }
+        const from = await this._uGraph.resolveUnit(fromSchemaItemName, fromSchema);
+        const to = await this._uGraph.resolveUnit(toSchemaItemName, toSchema);
+        return this.processUnits(from, to);
+    }
+    /**
+     * @param from Source unit converted from
+     * @param to Target unit converted to
+     * @internal
+     */
+    async processUnits(from, to) {
+        if (from.key.matches(to.key))
+            return UnitConversion.identity;
+        const areCompatible = await Unit.areCompatible(from, to);
+        if (!areCompatible)
+            throw new BentleyError(BentleyStatus.ERROR, `Source and target units do not belong to same phenomenon`, () => {
+                return { from, to };
+            });
+        // Add nodes and subsequent children to graph
+        await this._uGraph.addUnit(from);
+        await this._uGraph.addUnit(to);
+        const fromBaseUnits = new Map();
+        const toBaseUnits = new Map();
+        // Calculate map of UnitConversions to get between from -> base
+        const fromMapStore = this._uGraph.reduce(from, fromBaseUnits);
+        // Calculate map of UnitConversions to get between base -> to
+        const toMapStore = this._uGraph.reduce(to, toBaseUnits);
+        if (!this.checkBaseUnitsMatch(fromBaseUnits, toBaseUnits))
+            throw new BentleyError(BentleyStatus.ERROR, `Source and target units do not have matching base units`, () => {
+                return { from, to };
+            });
+        // Final calculations to get singular UnitConversion between from -> to
+        const fromMap = fromMapStore.get(from.key.fullName) || UnitConversion.identity;
+        const toMap = toMapStore.get(to.key.fullName) || UnitConversion.identity;
+        const fromInverse = fromMap.inverse();
+        return fromInverse.compose(toMap);
+    }
+    /**
+     * Check if fromBaseUnits's base units and exponents matches toBaseUnits's
+     * @param fromBaseUnits Map of base units for source unit
+     * @param toBaseUnits Map of base units for target unit
+     * @internal
+     */
+    checkBaseUnitsMatch(fromBaseUnits, toBaseUnits) {
+        // Trim maps of "One" and value that equal zero as they do not affect the base units and calculations
+        for (const [key, value] of fromBaseUnits.entries()) {
+            const [, schemaItemName] = SchemaItem.parseFullName(key);
+            if (schemaItemName === "ONE" || value === 0) {
+                fromBaseUnits.delete(key);
+            }
+        }
+        for (const [key, value] of toBaseUnits.entries()) {
+            const [, schemaItemName] = SchemaItem.parseFullName(key);
+            if (schemaItemName === "ONE" || value === 0) {
+                toBaseUnits.delete(key);
+            }
+        }
+        if (fromBaseUnits.size !== toBaseUnits.size)
+            return false;
+        for (const key of fromBaseUnits.keys()) {
+            if (!toBaseUnits.has(key) || fromBaseUnits.get(key) !== toBaseUnits.get(key)) {
+                // Mismatching key or value
+                return false;
+            }
+        }
+        return true;
+    }
+}
+//# sourceMappingURL=UnitConverter.js.map

package/lib/esm/UnitConversion/UnitConverter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnitConverter.js","sourceRoot":"","sources":["../../../src/UnitConversion/UnitConverter.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGlE,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC;;;GAGG;AACH,MAAM,OAAO,aAAa;IAGxB;;;OAGG;IACH,YAA6B,QAAuB;QAAvB,aAAQ,GAAR,QAAQ,CAAe;QAClD,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,mBAAmB,CAAC,QAAgB,EAAE,MAAc;QAC/D,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChF,MAAM,CAAC,YAAY,EAAE,gBAAgB,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC1E,MAAM,aAAa,GAAG,IAAI,SAAS,CAAC,cAAc,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,IAAI,SAAS,CAAC,YAAY,CAAC,CAAC;QAEhD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAE5D,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC7B,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,uCAAuC,EAAE,GAAG,EAAE;gBACxF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;YAC5F,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;QAC5E,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAEtE,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,YAAY,CAAC,IAAqB,EAAE,EAAmB;QACnE,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC;YAC1B,OAAO,cAAc,CAAC,QAAQ,CAAC;QAEjC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAY,EAAE,EAAU,CAAC,CAAC;QACzE,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,0DAA0D,EAAE,GAAG,EAAE;gBAC3G,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YACtB,CAAC,CAAC,CAAC;QAEL,6CAA6C;QAC7C,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE/B,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;QAChD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC9C,+DAA+D;QAC/D,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC9D,6DAA6D;QAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAExD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,WAAW,CAAC;YACvD,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,yDAAyD,EAAE,GAAG,EAAE;gBAC1G,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;YACtB,CAAC,CAAC,CAAC;QAEL,uEAAuE;QACvE,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC;QAC/E,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC;QACzE,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,OAAO,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACK,mBAAmB,CAAC,aAAkC,EAAE,WAAgC;QAC9F,qGAAqG;QACrG,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC;YACnD,MAAM,CAAC,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,cAAc,KAAK,KAAK,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAC5C,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,MAAM,CAAC,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,cAAc,KAAK,KAAK,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAC5C,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;QAED,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI;YACzC,OAAO,KAAK,CAAC;QAEf,KAAK,MAAM,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7E,2BAA2B;gBAC3B,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,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 { SchemaContext } from \"../Context\";\r\nimport { Constant } from \"../Metadata/Constant\";\r\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\r\nimport { Unit } from \"../Metadata/Unit\";\r\nimport { SchemaKey } from \"../SchemaKey\";\r\nimport { UnitConversion } from \"./UnitConversion\";\r\nimport { UnitGraph } from \"./UnitTree\";\r\n\r\n/**\r\n * Class constructed with SchemaContext and used to calculate [[UnitConversion]] between Units\r\n * @internal\r\n */\r\nexport class UnitConverter {\r\n  private _uGraph: UnitGraph;\r\n\r\n  /**\r\n   * Create Converter context\r\n   * @param _context SchemaContext with contexts added to it.\r\n   */\r\n  constructor(private readonly _context: SchemaContext) {\r\n    this._uGraph = new UnitGraph(this._context);\r\n  }\r\n\r\n  /**\r\n   * Find conversion between from and to units, formatted {schemaName}.{schemaItemName} or {schemaName}:{schemaItemName}\r\n   * @param fromUnit SchemaItem full name of source unit\r\n   * @param toUnit SchemaItem full name of target unit\r\n   * @returns [[UnitConversion]] converting fromUnit -> toUnit with a factor and an offset\r\n   * @throws Error if from and to Units' SchemaItem is not found in Schema or Schema prefix is not found in SchemaContext\r\n   * @throws Error if from and to Units do not belong to the same phenomenon\r\n   * @throws Error if definitions' SchemaItems cannot be found in its own or referenced Schemas\r\n   * @throws Error if base units of source and target unit do not match\r\n   */\r\n  public async calculateConversion(fromUnit: string, toUnit: string): Promise<UnitConversion> {\r\n    const [fromSchemaName, fromSchemaItemName] = SchemaItem.parseFullName(fromUnit);\r\n    const [toSchemaName, toSchemaItemName] = SchemaItem.parseFullName(toUnit);\r\n    const fromSchemaKey = new SchemaKey(fromSchemaName);\r\n    const toSchemaKey = new SchemaKey(toSchemaName);\r\n\r\n    const fromSchema = await this._context.getSchema(fromSchemaKey);\r\n    const toSchema = await this._context.getSchema(toSchemaKey);\r\n\r\n    if (!fromSchema || !toSchema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find from's and/or to's schema\", () => {\r\n        return { from: fromUnit, fromSchema: fromSchemaName, to: toUnit, toSchema: toSchemaName };\r\n      });\r\n    }\r\n\r\n    const from = await this._uGraph.resolveUnit(fromSchemaItemName, fromSchema);\r\n    const to = await this._uGraph.resolveUnit(toSchemaItemName, toSchema);\r\n\r\n    return this.processUnits(from, to);\r\n  }\r\n\r\n  /**\r\n   * @param from Source unit converted from\r\n   * @param to Target unit converted to\r\n   * @internal\r\n   */\r\n  private async processUnits(from: Unit | Constant, to: Unit | Constant): Promise<UnitConversion> {\r\n    if (from.key.matches(to.key))\r\n      return UnitConversion.identity;\r\n\r\n    const areCompatible = await Unit.areCompatible(from as Unit, to as Unit);\r\n    if (!areCompatible)\r\n      throw new BentleyError(BentleyStatus.ERROR, `Source and target units do not belong to same phenomenon`, () => {\r\n        return { from, to };\r\n      });\r\n\r\n    // Add nodes and subsequent children to graph\r\n    await this._uGraph.addUnit(from);\r\n    await this._uGraph.addUnit(to);\r\n\r\n    const fromBaseUnits = new Map<string, number>();\r\n    const toBaseUnits = new Map<string, number>();\r\n    // Calculate map of UnitConversions to get between from -> base\r\n    const fromMapStore = this._uGraph.reduce(from, fromBaseUnits);\r\n    // Calculate map of UnitConversions to get between base -> to\r\n    const toMapStore = this._uGraph.reduce(to, toBaseUnits);\r\n\r\n    if (!this.checkBaseUnitsMatch(fromBaseUnits, toBaseUnits))\r\n      throw new BentleyError(BentleyStatus.ERROR, `Source and target units do not have matching base units`, () => {\r\n        return { from, to };\r\n      });\r\n\r\n    // Final calculations to get singular UnitConversion between from -> to\r\n    const fromMap = fromMapStore.get(from.key.fullName) || UnitConversion.identity;\r\n    const toMap = toMapStore.get(to.key.fullName) || UnitConversion.identity;\r\n    const fromInverse = fromMap.inverse();\r\n    return fromInverse.compose(toMap);\r\n  }\r\n\r\n  /**\r\n   * Check if fromBaseUnits's base units and exponents matches toBaseUnits's\r\n   * @param fromBaseUnits Map of base units for source unit\r\n   * @param toBaseUnits Map of base units for target unit\r\n   * @internal\r\n   */\r\n  private checkBaseUnitsMatch(fromBaseUnits: Map<string, number>, toBaseUnits: Map<string, number>): boolean {\r\n    // Trim maps of \"One\" and value that equal zero as they do not affect the base units and calculations\r\n    for (const [key, value] of fromBaseUnits.entries()) {\r\n      const [, schemaItemName] = SchemaItem.parseFullName(key);\r\n      if (schemaItemName === \"ONE\" || value === 0) {\r\n        fromBaseUnits.delete(key);\r\n      }\r\n    }\r\n\r\n    for (const [key, value] of toBaseUnits.entries()) {\r\n      const [, schemaItemName] = SchemaItem.parseFullName(key);\r\n      if (schemaItemName === \"ONE\" || value === 0) {\r\n        toBaseUnits.delete(key);\r\n      }\r\n    }\r\n\r\n    if (fromBaseUnits.size !== toBaseUnits.size)\r\n      return false;\r\n\r\n    for (const key of fromBaseUnits.keys()) {\r\n      if (!toBaseUnits.has(key) || fromBaseUnits.get(key) !== toBaseUnits.get(key)) {\r\n        // Mismatching key or value\r\n        return false;\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}

package/lib/esm/UnitConversion/UnitTree.d.ts

@@ -0,0 +1,44 @@
+import { SchemaContext } from "../Context";
+import { Constant } from "../Metadata/Constant";
+import { Schema } from "../Metadata/Schema";
+import { Unit } from "../Metadata/Unit";
+import { UnitConversion } from "./UnitConversion";
+import { Graph } from "./Graph";
+/** @internal */
+export declare class GraphUtils {
+    /**
+     * DFS traversal - Post order
+     * @param _graph Graph to traverse
+     * @param start Starting node
+     * @param keyFrom Get key from label
+     * @param op Reducing function
+     * @param initial Initial label
+     */
+    static dfsReduce<T>(_graph: Graph<Unit | Constant>, key: string, op: (previous: T, current: string) => T, initial: T, baseUnitsMap: Map<string, number>, accumulatedExponent: number): T;
+}
+/** @internal */
+export declare class UnitGraph {
+    private _context;
+    private _graph;
+    constructor(_context: SchemaContext);
+    /**
+     * Tries to find the unit/constant given by name in currentSchema
+     * @param name SchemaItem name or parsed definition to find unit of; Could be {schemaName}:{schemaItemName} or {alias}:{schemaItemName} or {schemaItemName}
+     * @param currentSchema schema to find name in; name could also be in a referenced schema of current schema
+     */
+    resolveUnit(name: string, currentSchema: Schema): Promise<Unit | Constant>;
+    /**
+     * Adds unit and corresponding children to graph as well as edges between units
+     * @param unit Current unit to be added to graph
+     */
+    addUnit(unit: Unit | Constant): Promise<void>;
+    private isIdentity;
+    /**
+     * Reduce the tree to produce a single map
+     * @param unit Unit to be processed
+     * @param stopNodes The tree exploration should stop here
+     */
+    reduce(unit: Unit | Constant, baseUnitsMap: Map<string, number>): Map<string, UnitConversion>;
+    private reducingFunction;
+}
+//# sourceMappingURL=UnitTree.d.ts.map

package/lib/esm/UnitConversion/UnitTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnitTree.d.ts","sourceRoot":"","sources":["../../../src/UnitConversion/UnitTree.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,gBAAgB;AAChB,qBAAa,UAAU;IACrB;;;;;;;OAOG;WACW,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,EAAE,MAAM,GAAG,CAAC;CAuBhM;AAED,gBAAgB;AAChB,qBAAa,SAAS;IAGR,OAAO,CAAC,QAAQ;IAF5B,OAAO,CAAC,MAAM,CAAgC;gBAE1B,QAAQ,EAAE,aAAa;IAI3C;;;;OAIG;IACU,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;IAqDvF;;;OAGG;IACU,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B1D,OAAO,CAAC,UAAU;IAIlB;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,EAAE,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC;IAOpG,OAAO,CAAC,gBAAgB;CAmBzB"}

package/lib/esm/UnitConversion/UnitTree.js

@@ -0,0 +1,165 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { BentleyError, BentleyStatus } from "@itwin/core-bentley";
+import { SchemaItem } from "../Metadata/SchemaItem";
+import { SchemaItemKey, SchemaKey } from "../SchemaKey";
+import { SchemaItemType } from "../ECObjects";
+import { UnitConversion } from "./UnitConversion";
+import { parseDefinition } from "./Parser";
+import { Graph } from "./Graph";
+/** @internal */
+export class GraphUtils {
+    /**
+     * DFS traversal - Post order
+     * @param _graph Graph to traverse
+     * @param start Starting node
+     * @param keyFrom Get key from label
+     * @param op Reducing function
+     * @param initial Initial label
+     */
+    static dfsReduce(_graph, key, op, initial, baseUnitsMap, accumulatedExponent) {
+        const outEdges = _graph.outEdges(key);
+        let t = initial;
+        if (outEdges.length > 0) {
+            t = outEdges.reduce((p, edge) => {
+                const { v, w } = edge;
+                const edgeExponent = _graph.edge(v, w).exponent;
+                return GraphUtils.dfsReduce(_graph, edge.w, op, p, baseUnitsMap, accumulatedExponent * edgeExponent);
+            }, t);
+        }
+        else {
+            if (baseUnitsMap.has(key)) {
+                const oldExponent = baseUnitsMap.get(key);
+                baseUnitsMap.set(key, oldExponent + accumulatedExponent);
+            }
+            else {
+                baseUnitsMap.set(key, accumulatedExponent);
+            }
+        }
+        return op(t, key);
+    }
+}
+/** @internal */
+export class UnitGraph {
+    constructor(_context) {
+        this._context = _context;
+        this._graph = new Graph();
+        this._graph.setGraph("Unit tree processor");
+    }
+    /**
+     * Tries to find the unit/constant given by name in currentSchema
+     * @param name SchemaItem name or parsed definition to find unit of; Could be {schemaName}:{schemaItemName} or {alias}:{schemaItemName} or {schemaItemName}
+     * @param currentSchema schema to find name in; name could also be in a referenced schema of current schema
+     */
+    async resolveUnit(name, currentSchema) {
+        let [schemaName] = SchemaItem.parseFullName(name);
+        const [, schemaItemName] = SchemaItem.parseFullName(name);
+        if (schemaName !== "") {
+            // Check if schemaName is schemaName or alias
+            const ref = currentSchema.getReferenceSync(schemaName);
+            const refName = currentSchema.getReferenceNameByAlias(schemaName);
+            if (ref) {
+                // Got schema by schemaName
+                schemaName = ref.name;
+            }
+            else if (refName) {
+                // Got schema by alias
+                schemaName = refName;
+            }
+            else {
+                // Didn't match any referenced schema, check if it is current schemaName or alias
+                if (schemaName === currentSchema.name || schemaName === currentSchema.alias)
+                    schemaName = currentSchema.name;
+            }
+            // Create schema key with schema name
+            const schemaKey = new SchemaKey(schemaName);
+            // Get schema with schema key
+            const schema = await this._context.getSchema(schemaKey);
+            if (!schema) {
+                throw new BentleyError(BentleyStatus.ERROR, "Cannot find schema", () => {
+                    return { schema: schemaName };
+                });
+            }
+            else {
+                // Set currentSchema to look up schemaItem to be whatever is prefixed in name
+                currentSchema = schema;
+            }
+            // Update name to not have prefix
+            name = schemaItemName;
+        }
+        // Create schema item key with name and schema
+        const itemKey = new SchemaItemKey(name, currentSchema.schemaKey);
+        // Get schema item with schema item key
+        const item = await this._context.getSchemaItem(itemKey);
+        if (!item)
+            throw new BentleyError(BentleyStatus.ERROR, "Cannot find schema item", () => {
+                return { item: name };
+            });
+        if (item.schemaItemType === SchemaItemType.Unit || item.schemaItemType === SchemaItemType.Constant)
+            return item;
+        throw new BentleyError(BentleyStatus.ERROR, "Item is neither a unit or a constant", () => {
+            return { itemType: item.key.fullName };
+        });
+    }
+    /**
+     * Adds unit and corresponding children to graph as well as edges between units
+     * @param unit Current unit to be added to graph
+     */
+    async addUnit(unit) {
+        if (this._graph.hasNode(unit.key.fullName))
+            return;
+        this._graph.setNode(unit.key.fullName, unit);
+        if (this.isIdentity(unit))
+            return;
+        const umap = parseDefinition(unit.definition);
+        const promiseArray = [];
+        for (const [key, value] of umap) {
+            promiseArray.push(this.resolveUnit(key, unit.schema).then((u) => [u, value]));
+        }
+        const resolved = await Promise.all(promiseArray);
+        const children = resolved.map(async ([u, def]) => {
+            await this.addUnit(u);
+            this._graph.setEdge(unit.key.fullName, u.key.fullName, {
+                exponent: def.exponent,
+            });
+        });
+        await Promise.all(children);
+    }
+    isIdentity(unit) {
+        return unit.definition === unit.name;
+    }
+    /**
+     * Reduce the tree to produce a single map
+     * @param unit Unit to be processed
+     * @param stopNodes The tree exploration should stop here
+     */
+    reduce(unit, baseUnitsMap) {
+        const unitFullName = unit.key.fullName;
+        const innerMapStore = new Map();
+        const outerMapStore = GraphUtils.dfsReduce(this._graph, unitFullName, (p, c) => this.reducingFunction(p, c), innerMapStore, baseUnitsMap, 1);
+        return outerMapStore;
+    }
+    reducingFunction(innermapStore, unitFullName) {
+        const outEdges = this._graph.outEdges(unitFullName);
+        if (outEdges) {
+            const cmap = outEdges.reduce((pm, e) => {
+                const { exponent } = this._graph.edge(e.v, e.w);
+                const stored = innermapStore.get(e.w);
+                const map = stored ? stored : UnitConversion.identity;
+                const emap = map.raise(exponent);
+                return pm ? pm.multiply(emap) : emap;
+            }, undefined);
+            const thisMap = this._graph.node(unitFullName) ? UnitConversion.from(this._graph.node(unitFullName)) : UnitConversion.identity;
+            const other = cmap || UnitConversion.identity;
+            const result = other.compose(thisMap);
+            innermapStore.set(unitFullName, result);
+        }
+        else {
+            innermapStore.set(unitFullName, UnitConversion.identity);
+        }
+        return innermapStore;
+    }
+}
+//# sourceMappingURL=UnitTree.js.map

package/lib/esm/UnitConversion/UnitTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnitTree.js","sourceRoot":"","sources":["../../../src/UnitConversion/UnitTree.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAIlE,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAsB,eAAe,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,gBAAgB;AAChB,MAAM,OAAO,UAAU;IACrB;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,CAAI,MAA8B,EAAE,GAAW,EAAE,EAAuC,EAAE,OAAU,EAAE,YAAiC,EAAE,mBAA2B;QACzL,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,GAAG,OAAO,CAAC;QAChB,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,CAAC,GAAG,QAAQ,CAAC,MAAM,CACjB,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE;gBACV,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC;gBACtB,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAChD,OAAO,UAAU,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,mBAAmB,GAAG,YAAY,CAAC,CAAC;YACvG,CAAC,EACD,CAAC,CACF,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;gBAC3C,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,GAAG,mBAAmB,CAAC,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACpB,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,OAAO,SAAS;IAGpB,YAAoB,QAAuB;QAAvB,aAAQ,GAAR,QAAQ,CAAe;QAFnC,WAAM,GAAG,IAAI,KAAK,EAAmB,CAAC;QAG5C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,aAAqB;QAC1D,IAAI,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAE1D,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YACtB,6CAA6C;YAC7C,MAAM,GAAG,GAAG,aAAa,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACvD,MAAM,OAAO,GAAG,aAAa,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;YAClE,IAAI,GAAG,EAAE,CAAC;gBACR,2BAA2B;gBAC3B,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC;YACxB,CAAC;iBAAM,IAAI,OAAO,EAAE,CAAC;gBACnB,sBAAsB;gBACtB,UAAU,GAAG,OAAO,CAAC;YACvB,CAAC;iBAAM,CAAC;gBACN,iFAAiF;gBACjF,IAAI,UAAU,KAAK,aAAa,CAAC,IAAI,IAAI,UAAU,KAAK,aAAa,CAAC,KAAK;oBACzE,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC;YACpC,CAAC;YAED,qCAAqC;YACrC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;YAC5C,6BAA6B;YAC7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YACxD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,oBAAoB,EAAE,GAAG,EAAE;oBACrE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;gBAChC,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,6EAA6E;gBAC7E,aAAa,GAAG,MAAM,CAAC;YACzB,CAAC;YACD,iCAAiC;YACjC,IAAI,GAAG,cAAc,CAAC;QACxB,CAAC;QAED,8CAA8C;QAC9C,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QACjE,uCAAuC;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,yBAAyB,EAAE,GAAG,EAAE;gBAC1E,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YACxB,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,QAAQ;YAChG,OAAO,IAAuB,CAAC;QAEjC,MAAM,IAAI,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,sCAAsC,EAAE,GAAG,EAAE;YACvF,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,IAAqB;QACxC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,OAAO;QAET,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACvB,OAAO;QAET,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE9C,MAAM,YAAY,GAAqD,EAAE,CAAC;QAC1E,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;YAChC,YAAY,CAAC,IAAI,CACf,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAC3D,CAAC;QACJ,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,YAAY,CACb,CAAC;QAEF,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE;YAC/C,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;gBACrD,QAAQ,EAAE,GAAG,CAAC,QAAQ;aACvB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAEO,UAAU,CAAC,IAAqB;QACtC,OAAO,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,IAAI,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAqB,EAAE,YAAiC;QACpE,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;QACvC,MAAM,aAAa,GAAG,IAAI,GAAG,EAA0B,CAAC;QACxD,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;QAC7I,OAAO,aAAa,CAAC;IACvB,CAAC;IAEO,gBAAgB,CAAC,aAA0C,EAAE,YAAoB;QACvF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACpD,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAA6B,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;gBACjE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChD,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACtC,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC;gBACtD,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACjC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACvC,CAAC,EAAE,SAAS,CAAC,CAAC;YACd,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC;YAC/H,MAAM,KAAK,GAAG,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC;YAC9C,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACtC,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,aAAa,CAAC,GAAG,CAAC,YAAY,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,aAAa,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 { SchemaContext } from \"../Context\";\r\nimport { Constant } from \"../Metadata/Constant\";\r\nimport { Schema } from \"../Metadata/Schema\";\r\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\r\nimport { Unit } from \"../Metadata/Unit\";\r\nimport { SchemaItemKey, SchemaKey } from \"../SchemaKey\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { UnitConversion } from \"./UnitConversion\";\r\nimport { DefinitionFragment, parseDefinition } from \"./Parser\";\r\nimport { Graph } from \"./Graph\";\r\n\r\n/** @internal */\r\nexport class GraphUtils {\r\n  /**\r\n   * DFS traversal - Post order\r\n   * @param _graph Graph to traverse\r\n   * @param start Starting node\r\n   * @param keyFrom Get key from label\r\n   * @param op Reducing function\r\n   * @param initial Initial label\r\n   */\r\n  public static dfsReduce<T>(_graph: Graph<Unit | Constant>, key: string, op: (previous: T, current: string) => T, initial: T, baseUnitsMap: Map<string, number>, accumulatedExponent: number): T {\r\n    const outEdges = _graph.outEdges(key);\r\n    let t = initial;\r\n    if (outEdges.length > 0) {\r\n      t = outEdges.reduce<T>(\r\n        (p, edge) => {\r\n          const { v, w } = edge;\r\n          const edgeExponent = _graph.edge(v, w).exponent;\r\n          return GraphUtils.dfsReduce(_graph, edge.w, op, p, baseUnitsMap, accumulatedExponent * edgeExponent);\r\n        },\r\n        t,\r\n      );\r\n    } else {\r\n      if (baseUnitsMap.has(key)) {\r\n        const oldExponent = baseUnitsMap.get(key)!;\r\n        baseUnitsMap.set(key, oldExponent + accumulatedExponent);\r\n      } else {\r\n        baseUnitsMap.set(key, accumulatedExponent);\r\n      }\r\n    }\r\n\r\n    return op(t, key);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class UnitGraph {\r\n  private _graph = new Graph<Unit | Constant>();\r\n\r\n  constructor(private _context: SchemaContext) {\r\n    this._graph.setGraph(\"Unit tree processor\");\r\n  }\r\n\r\n  /**\r\n   * Tries to find the unit/constant given by name in currentSchema\r\n   * @param name SchemaItem name or parsed definition to find unit of; Could be {schemaName}:{schemaItemName} or {alias}:{schemaItemName} or {schemaItemName}\r\n   * @param currentSchema schema to find name in; name could also be in a referenced schema of current schema\r\n   */\r\n  public async resolveUnit(name: string, currentSchema: Schema): Promise<Unit | Constant> {\r\n    let [schemaName] = SchemaItem.parseFullName(name);\r\n    const [, schemaItemName] = SchemaItem.parseFullName(name);\r\n\r\n    if (schemaName !== \"\") {\r\n      // Check if schemaName is schemaName or alias\r\n      const ref = currentSchema.getReferenceSync(schemaName);\r\n      const refName = currentSchema.getReferenceNameByAlias(schemaName);\r\n      if (ref) {\r\n        // Got schema by schemaName\r\n        schemaName = ref.name;\r\n      } else if (refName) {\r\n        // Got schema by alias\r\n        schemaName = refName;\r\n      } else {\r\n        // Didn't match any referenced schema, check if it is current schemaName or alias\r\n        if (schemaName === currentSchema.name || schemaName === currentSchema.alias)\r\n          schemaName = currentSchema.name;\r\n      }\r\n\r\n      // Create schema key with schema name\r\n      const schemaKey = new SchemaKey(schemaName);\r\n      // Get schema with schema key\r\n      const schema = await this._context.getSchema(schemaKey);\r\n      if (!schema) {\r\n        throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema\", () => {\r\n          return { schema: schemaName };\r\n        });\r\n      } else {\r\n        // Set currentSchema to look up schemaItem to be whatever is prefixed in name\r\n        currentSchema = schema;\r\n      }\r\n      // Update name to not have prefix\r\n      name = schemaItemName;\r\n    }\r\n\r\n    // Create schema item key with name and schema\r\n    const itemKey = new SchemaItemKey(name, currentSchema.schemaKey);\r\n    // Get schema item with schema item key\r\n    const item = await this._context.getSchemaItem(itemKey);\r\n    if (!item)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema item\", () => {\r\n        return { item: name };\r\n      });\r\n\r\n    if (item.schemaItemType === SchemaItemType.Unit || item.schemaItemType === SchemaItemType.Constant)\r\n      return item as Unit | Constant;\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Item is neither a unit or a constant\", () => {\r\n      return { itemType: item.key.fullName };\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Adds unit and corresponding children to graph as well as edges between units\r\n   * @param unit Current unit to be added to graph\r\n   */\r\n  public async addUnit(unit: Unit | Constant): Promise<void> {\r\n    if (this._graph.hasNode(unit.key.fullName))\r\n      return;\r\n\r\n    this._graph.setNode(unit.key.fullName, unit);\r\n    if (this.isIdentity(unit))\r\n      return;\r\n\r\n    const umap = parseDefinition(unit.definition);\r\n\r\n    const promiseArray: Promise<[Unit | Constant, DefinitionFragment]>[] = [];\r\n    for (const [key, value] of umap) {\r\n      promiseArray.push(\r\n        this.resolveUnit(key, unit.schema).then((u) => [u, value]),\r\n      );\r\n    }\r\n    const resolved = await Promise.all<[Unit | Constant, DefinitionFragment]>(\r\n      promiseArray,\r\n    );\r\n\r\n    const children = resolved.map(async ([u, def]) => {\r\n      await this.addUnit(u);\r\n      this._graph.setEdge(unit.key.fullName, u.key.fullName, {\r\n        exponent: def.exponent,\r\n      });\r\n    });\r\n\r\n    await Promise.all(children);\r\n  }\r\n\r\n  private isIdentity(unit: Unit | Constant) {\r\n    return unit.definition === unit.name;\r\n  }\r\n\r\n  /**\r\n   * Reduce the tree to produce a single map\r\n   * @param unit Unit to be processed\r\n   * @param stopNodes The tree exploration should stop here\r\n   */\r\n  public reduce(unit: Unit | Constant, baseUnitsMap: Map<string, number>): Map<string, UnitConversion> {\r\n    const unitFullName = unit.key.fullName;\r\n    const innerMapStore = new Map<string, UnitConversion>();\r\n    const outerMapStore = GraphUtils.dfsReduce(this._graph, unitFullName, (p, c) => this.reducingFunction(p, c), innerMapStore, baseUnitsMap, 1);\r\n    return outerMapStore;\r\n  }\r\n\r\n  private reducingFunction(innermapStore: Map<string, UnitConversion>, unitFullName: string) {\r\n    const outEdges = this._graph.outEdges(unitFullName);\r\n    if (outEdges) {\r\n      const cmap = outEdges.reduce<UnitConversion | undefined>((pm, e) => {\r\n        const { exponent } = this._graph.edge(e.v, e.w);\r\n        const stored = innermapStore.get(e.w);\r\n        const map = stored ? stored : UnitConversion.identity;\r\n        const emap = map.raise(exponent);\r\n        return pm ? pm.multiply(emap) : emap;\r\n      }, undefined);\r\n      const thisMap = this._graph.node(unitFullName) ? UnitConversion.from(this._graph.node(unitFullName)) : UnitConversion.identity;\r\n      const other = cmap || UnitConversion.identity;\r\n      const result = other.compose(thisMap);\r\n      innermapStore.set(unitFullName, result);\r\n    } else {\r\n      innermapStore.set(unitFullName, UnitConversion.identity);\r\n    }\r\n    return innermapStore;\r\n  }\r\n}\r\n"]}

package/lib/esm/UnitProvider/SchemaUnitProvider.d.ts

@@ -0,0 +1,78 @@
+import { UnitConversionProps, UnitExtraData, UnitProps, UnitsProvider } from "@itwin/core-quantity";
+import { ISchemaLocater } from "../Context";
+/**
+ * Class used to find Units in SchemaContext by attributes such as Phenomenon and DisplayLabel.
+ * @beta
+ */
+export declare class SchemaUnitProvider implements UnitsProvider {
+    private _unitExtraData;
+    private _unitConverter;
+    private _context;
+    /**
+     *
+     * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext
+     * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be
+     * created and the locater will be added.
+     * @param _unitExtraData Additional data like alternate display label not found in Units Schema to match with Units; Defaults to empty array.
+     */
+    constructor(contextOrLocater: ISchemaLocater, _unitExtraData?: UnitExtraData[]);
+    /**
+     * Find unit in a schema that has unitName.
+     * @param unitName Full name of unit.
+     * @returns UnitProps interface from @itwin/core-quantity whose name matches unitName.
+     */
+    findUnitByName(unitName: string): Promise<UnitProps>;
+    /**
+     * Find all units in context that belongs to given phenomenon.
+     * @param phenomenon Full name of phenomenon.
+     * @returns Array of UnitProps (from @itwin/core-quantity) interface objects whose name matches phenomenon param.
+     */
+    getUnitsByFamily(phenomenon: string): Promise<Array<UnitProps>>;
+    /**
+     * Find alternate display labels associated with unitName, if any.
+     * @param unitName Full name of Unit.
+     */
+    getAlternateDisplayLabels(unitName: string): Array<string>;
+    /**
+     * Finds Unit by unitLabel, which could be a display label in the schema or alternate an display label defined in
+     * this._unitExtraData. If there are duplicates of the same display label in the context or teh same alternate display
+     * labels, specify schemaName, phenomenon, or unitSystem to get a specific unit.
+     *
+     * @param unitLabel Display label or alternate display label to query unit by.
+     * @param schemaName Ensure Unit with unitLabel belongs to Schema with schemaName.
+     * @param phenomenon Full name of phenomenon that Unit belongs to.
+     * @param unitSystem Full name of unitSystem that Unit belongs to.
+     * @returns The UnitProps interface from the @itwin/core-quantity package.
+     */
+    findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps>;
+    /**
+     * Gets the @itwin/core-quantity UnitConversionProps for the given fromUnit and toUnit.
+     * @param fromUnit The UnitProps of the 'from' unit.
+     * @param toUnit The UnitProps of the 'to' unit.
+     * @returns The UnitConversionProps interface from the @itwin/core-quantity package.
+     */
+    getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversionProps>;
+    /**
+     * Find unit in a schema that has unitName.
+     * @param unitName Full name of unit.
+     * @returns Unit whose full name matches unitName.
+     */
+    private findECUnitByName;
+    /**
+     * Gets the @itwin/core UnitProps for the given Unit.
+     * @param unit The Unit to convert.
+     * @returns UnitProps interface from @itwin/core.
+     */
+    private getUnitsProps;
+    /**
+     * Finds Unit by displayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.
+     * @internal
+     */
+    private findUnitByDisplayLabel;
+    /**
+     * Finds Unit by altDisplayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.
+     * @internal
+     */
+    private findUnitByAltDisplayLabel;
+}
+//# sourceMappingURL=SchemaUnitProvider.d.ts.map

package/lib/esm/UnitProvider/SchemaUnitProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaUnitProvider.d.ts","sourceRoot":"","sources":["../../../src/UnitProvider/SchemaUnitProvider.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACpG,OAAO,EAAE,cAAc,EAAiB,MAAM,YAAY,CAAC;AAO3D;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,aAAa;IAWR,OAAO,CAAC,cAAc;IAVpE,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;OAMG;gBACS,gBAAgB,EAAE,cAAc,EAAU,cAAc,GAAE,aAAa,EAAO;IAU1F;;;;OAIG;IACU,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAKjE;;;;OAIG;IACU,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IA0C5E;;;OAGG;IACI,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAWjE;;;;;;;;;;OAUG;IACU,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAuB3H;;;;;OAKG;IACU,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQhG;;;;OAIG;YACW,gBAAgB;IA2B9B;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAUrB;;;OAGG;YACW,sBAAsB;IAoBpC;;;OAGG;YACW,yBAAyB;CAoBxC"}