@itwin/ecschema-metadata 3.6.0-dev.36 → 3.6.0-dev.40

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

@@ -1,40 +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;
-}
+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/cjs/UnitConversion/UnitConverter.js

@@ -1,117 +1,117 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnitConverter = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-const core_bentley_1 = require("@itwin/core-bentley");
-const SchemaItem_1 = require("../Metadata/SchemaItem");
-const Unit_1 = require("../Metadata/Unit");
-const SchemaKey_1 = require("../SchemaKey");
-const UnitConversion_1 = require("./UnitConversion");
-const UnitTree_1 = require("./UnitTree");
-/**
- * Class constructed with SchemaContext and used to calculate [[UnitConversion]] between Units
- * @internal
- */
-class UnitConverter {
-    /**
-     * Create Converter context
-     * @param _context SchemaContext with contexts added to it.
-     */
-    constructor(_context) {
-        this._context = _context;
-        this._uGraph = new UnitTree_1.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_1.SchemaItem.parseFullName(fromUnit);
-        const [toSchemaName, toSchemaItemName] = SchemaItem_1.SchemaItem.parseFullName(toUnit);
-        const fromSchemaKey = new SchemaKey_1.SchemaKey(fromSchemaName);
-        const toSchemaKey = new SchemaKey_1.SchemaKey(toSchemaName);
-        const fromSchema = await this._context.getSchema(fromSchemaKey);
-        const toSchema = await this._context.getSchema(toSchemaKey);
-        if (!fromSchema || !toSchema) {
-            throw new core_bentley_1.BentleyError(core_bentley_1.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_1.UnitConversion.identity;
-        const areCompatible = await Unit_1.Unit.areCompatible(from, to);
-        if (!areCompatible)
-            throw new core_bentley_1.BentleyError(core_bentley_1.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 core_bentley_1.BentleyError(core_bentley_1.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_1.UnitConversion.identity;
-        const toMap = toMapStore.get(to.key.fullName) || UnitConversion_1.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_1.SchemaItem.parseFullName(key);
-            if (schemaItemName === "ONE" || value === 0) {
-                fromBaseUnits.delete(key);
-            }
-        }
-        for (const [key, value] of toBaseUnits.entries()) {
-            const [, schemaItemName] = SchemaItem_1.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;
-    }
-}
-exports.UnitConverter = UnitConverter;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnitConverter = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const core_bentley_1 = require("@itwin/core-bentley");
+const SchemaItem_1 = require("../Metadata/SchemaItem");
+const Unit_1 = require("../Metadata/Unit");
+const SchemaKey_1 = require("../SchemaKey");
+const UnitConversion_1 = require("./UnitConversion");
+const UnitTree_1 = require("./UnitTree");
+/**
+ * Class constructed with SchemaContext and used to calculate [[UnitConversion]] between Units
+ * @internal
+ */
+class UnitConverter {
+    /**
+     * Create Converter context
+     * @param _context SchemaContext with contexts added to it.
+     */
+    constructor(_context) {
+        this._context = _context;
+        this._uGraph = new UnitTree_1.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_1.SchemaItem.parseFullName(fromUnit);
+        const [toSchemaName, toSchemaItemName] = SchemaItem_1.SchemaItem.parseFullName(toUnit);
+        const fromSchemaKey = new SchemaKey_1.SchemaKey(fromSchemaName);
+        const toSchemaKey = new SchemaKey_1.SchemaKey(toSchemaName);
+        const fromSchema = await this._context.getSchema(fromSchemaKey);
+        const toSchema = await this._context.getSchema(toSchemaKey);
+        if (!fromSchema || !toSchema) {
+            throw new core_bentley_1.BentleyError(core_bentley_1.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_1.UnitConversion.identity;
+        const areCompatible = await Unit_1.Unit.areCompatible(from, to);
+        if (!areCompatible)
+            throw new core_bentley_1.BentleyError(core_bentley_1.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 core_bentley_1.BentleyError(core_bentley_1.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_1.UnitConversion.identity;
+        const toMap = toMapStore.get(to.key.fullName) || UnitConversion_1.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_1.SchemaItem.parseFullName(key);
+            if (schemaItemName === "ONE" || value === 0) {
+                fromBaseUnits.delete(key);
+            }
+        }
+        for (const [key, value] of toBaseUnits.entries()) {
+            const [, schemaItemName] = SchemaItem_1.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;
+    }
+}
+exports.UnitConverter = UnitConverter;
 //# sourceMappingURL=UnitConverter.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"UnitConverter.js","sourceRoot":"","sources":["../../../src/UnitConversion/UnitConverter.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,sDAAkE;AAGlE,uDAAoD;AACpD,2CAAwC;AACxC,4CAAyC;AACzC,qDAAkD;AAClD,yCAAuC;AAEvC;;;GAGG;AACH,MAAa,aAAa;IAGxB;;;OAGG;IACH,YAA6B,QAAuB;QAAvB,aAAQ,GAAR,QAAQ,CAAe;QAClD,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAS,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,uBAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChF,MAAM,CAAC,YAAY,EAAE,gBAAgB,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC1E,MAAM,aAAa,GAAG,IAAI,qBAAS,CAAC,cAAc,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,IAAI,qBAAS,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;YAC5B,MAAM,IAAI,2BAAY,CAAC,4BAAa,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;SACJ;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,+BAAc,CAAC,QAAQ,CAAC;QAEjC,MAAM,aAAa,GAAG,MAAM,WAAI,CAAC,aAAa,CAAC,IAAY,EAAE,EAAU,CAAC,CAAC;QACzE,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,2BAAY,CAAC,4BAAa,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,2BAAY,CAAC,4BAAa,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,+BAAc,CAAC,QAAQ,CAAC;QAC/E,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,+BAAc,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;YAClD,MAAM,CAAC,EAAE,cAAc,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,cAAc,KAAK,KAAK,IAAI,KAAK,KAAK,CAAC,EAAE;gBAC3C,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE;YAChD,MAAM,CAAC,EAAE,cAAc,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,cAAc,KAAK,KAAK,IAAI,KAAK,KAAK,CAAC,EAAE;gBAC3C,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACzB;SACF;QAED,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI;YACzC,OAAO,KAAK,CAAC;QAEf,KAAK,MAAM,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,EAAE;YACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAC5E,2BAA2B;gBAC3B,OAAO,KAAK,CAAC;aACd;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAlHD,sCAkHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { BentleyError, BentleyStatus } from \"@itwin/core-bentley\";\nimport { SchemaContext } from \"../Context\";\nimport { Constant } from \"../Metadata/Constant\";\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\nimport { Unit } from \"../Metadata/Unit\";\nimport { SchemaKey } from \"../SchemaKey\";\nimport { UnitConversion } from \"./UnitConversion\";\nimport { UnitGraph } from \"./UnitTree\";\n\n/**\n * Class constructed with SchemaContext and used to calculate [[UnitConversion]] between Units\n * @internal\n */\nexport class UnitConverter {\n  private _uGraph: UnitGraph;\n\n  /**\n   * Create Converter context\n   * @param _context SchemaContext with contexts added to it.\n   */\n  constructor(private readonly _context: SchemaContext) {\n    this._uGraph = new UnitGraph(this._context);\n  }\n\n  /**\n   * Find conversion between from and to units, formatted {schemaName}.{schemaItemName} or {schemaName}:{schemaItemName}\n   * @param fromUnit SchemaItem full name of source unit\n   * @param toUnit SchemaItem full name of target unit\n   * @returns [[UnitConversion]] converting fromUnit -> toUnit with a factor and an offset\n   * @throws Error if from and to Units' SchemaItem is not found in Schema or Schema prefix is not found in SchemaContext\n   * @throws Error if from and to Units do not belong to the same phenomenon\n   * @throws Error if definitions' SchemaItems cannot be found in its own or referenced Schemas\n   * @throws Error if base units of source and target unit do not match\n   */\n  public async calculateConversion(fromUnit: string, toUnit: string): Promise<UnitConversion> {\n    const [fromSchemaName, fromSchemaItemName] = SchemaItem.parseFullName(fromUnit);\n    const [toSchemaName, toSchemaItemName] = SchemaItem.parseFullName(toUnit);\n    const fromSchemaKey = new SchemaKey(fromSchemaName);\n    const toSchemaKey = new SchemaKey(toSchemaName);\n\n    const fromSchema = await this._context.getSchema(fromSchemaKey);\n    const toSchema = await this._context.getSchema(toSchemaKey);\n\n    if (!fromSchema || !toSchema) {\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find from's and/or to's schema\", () => {\n        return { from: fromUnit, fromSchema: fromSchemaName, to: toUnit, toSchema: toSchemaName };\n      });\n    }\n\n    const from = await this._uGraph.resolveUnit(fromSchemaItemName, fromSchema);\n    const to = await this._uGraph.resolveUnit(toSchemaItemName, toSchema);\n\n    return this.processUnits(from, to);\n  }\n\n  /**\n   * @param from Source unit converted from\n   * @param to Target unit converted to\n   * @internal\n   */\n  private async processUnits(from: Unit | Constant, to: Unit | Constant): Promise<UnitConversion> {\n    if (from.key.matches(to.key))\n      return UnitConversion.identity;\n\n    const areCompatible = await Unit.areCompatible(from as Unit, to as Unit);\n    if (!areCompatible)\n      throw new BentleyError(BentleyStatus.ERROR, `Source and target units do not belong to same phenomenon`, () => {\n        return { from, to };\n      });\n\n    // Add nodes and subsequent children to graph\n    await this._uGraph.addUnit(from);\n    await this._uGraph.addUnit(to);\n\n    const fromBaseUnits = new Map<string, number>();\n    const toBaseUnits = new Map<string, number>();\n    // Calculate map of UnitConversions to get between from -> base\n    const fromMapStore = this._uGraph.reduce(from, fromBaseUnits);\n    // Calculate map of UnitConversions to get between base -> to\n    const toMapStore = this._uGraph.reduce(to, toBaseUnits);\n\n    if (!this.checkBaseUnitsMatch(fromBaseUnits, toBaseUnits))\n      throw new BentleyError(BentleyStatus.ERROR, `Source and target units do not have matching base units`, () => {\n        return { from, to };\n      });\n\n    // Final calculations to get singular UnitConversion between from -> to\n    const fromMap = fromMapStore.get(from.key.fullName) || UnitConversion.identity;\n    const toMap = toMapStore.get(to.key.fullName) || UnitConversion.identity;\n    const fromInverse = fromMap.inverse();\n    return fromInverse.compose(toMap);\n  }\n\n  /**\n   * Check if fromBaseUnits's base units and exponents matches toBaseUnits's\n   * @param fromBaseUnits Map of base units for source unit\n   * @param toBaseUnits Map of base units for target unit\n   * @internal\n   */\n  private checkBaseUnitsMatch(fromBaseUnits: Map<string, number>, toBaseUnits: Map<string, number>): boolean {\n    // Trim maps of \"One\" and value that equal zero as they do not affect the base units and calculations\n    for (const [key, value] of fromBaseUnits.entries()) {\n      const [, schemaItemName] = SchemaItem.parseFullName(key);\n      if (schemaItemName === \"ONE\" || value === 0) {\n        fromBaseUnits.delete(key);\n      }\n    }\n\n    for (const [key, value] of toBaseUnits.entries()) {\n      const [, schemaItemName] = SchemaItem.parseFullName(key);\n      if (schemaItemName === \"ONE\" || value === 0) {\n        toBaseUnits.delete(key);\n      }\n    }\n\n    if (fromBaseUnits.size !== toBaseUnits.size)\n      return false;\n\n    for (const key of fromBaseUnits.keys()) {\n      if (!toBaseUnits.has(key) || fromBaseUnits.get(key) !== toBaseUnits.get(key)) {\n        // Mismatching key or value\n        return false;\n      }\n    }\n\n    return true;\n  }\n}\n"]}
+{"version":3,"file":"UnitConverter.js","sourceRoot":"","sources":["../../../src/UnitConversion/UnitConverter.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,sDAAkE;AAGlE,uDAAoD;AACpD,2CAAwC;AACxC,4CAAyC;AACzC,qDAAkD;AAClD,yCAAuC;AAEvC;;;GAGG;AACH,MAAa,aAAa;IAGxB;;;OAGG;IACH,YAA6B,QAAuB;QAAvB,aAAQ,GAAR,QAAQ,CAAe;QAClD,IAAI,CAAC,OAAO,GAAG,IAAI,oBAAS,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,uBAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAChF,MAAM,CAAC,YAAY,EAAE,gBAAgB,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC1E,MAAM,aAAa,GAAG,IAAI,qBAAS,CAAC,cAAc,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,IAAI,qBAAS,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;YAC5B,MAAM,IAAI,2BAAY,CAAC,4BAAa,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;SACJ;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,+BAAc,CAAC,QAAQ,CAAC;QAEjC,MAAM,aAAa,GAAG,MAAM,WAAI,CAAC,aAAa,CAAC,IAAY,EAAE,EAAU,CAAC,CAAC;QACzE,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,2BAAY,CAAC,4BAAa,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,2BAAY,CAAC,4BAAa,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,+BAAc,CAAC,QAAQ,CAAC;QAC/E,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,+BAAc,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;YAClD,MAAM,CAAC,EAAE,cAAc,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,cAAc,KAAK,KAAK,IAAI,KAAK,KAAK,CAAC,EAAE;gBAC3C,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aAC3B;SACF;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE;YAChD,MAAM,CAAC,EAAE,cAAc,CAAC,GAAG,uBAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,cAAc,KAAK,KAAK,IAAI,KAAK,KAAK,CAAC,EAAE;gBAC3C,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACzB;SACF;QAED,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI;YACzC,OAAO,KAAK,CAAC;QAEf,KAAK,MAAM,GAAG,IAAI,aAAa,CAAC,IAAI,EAAE,EAAE;YACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAC5E,2BAA2B;gBAC3B,OAAO,KAAK,CAAC;aACd;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAlHD,sCAkHC","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/cjs/UnitConversion/UnitTree.d.ts

@@ -1,44 +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;
-}
+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