@itwin/ecschema-metadata 4.8.0-dev.4 → 4.8.0-dev.41

package/lib/esm/UnitProvider/SchemaUnitProvider.js

@@ -0,0 +1,231 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { 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";
+/**
+ * Class used to find Units in SchemaContext by attributes such as Phenomenon and DisplayLabel.
+ * @beta
+ */
+export class SchemaUnitProvider {
+    /**
+     *
+     * @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, _unitExtraData = []) {
+        this._unitExtraData = _unitExtraData;
+        if (contextOrLocater instanceof SchemaContext) {
+            this._context = contextOrLocater;
+        }
+        else {
+            this._context = new SchemaContext();
+            this._context.addLocater(contextOrLocater);
+        }
+        this._unitConverter = new UnitConverter(this._context);
+    }
+    /**
+     * 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.
+     */
+    async findUnitByName(unitName) {
+        const unit = await this.findECUnitByName(unitName);
+        return this.getUnitsProps(unit);
+    }
+    /**
+     * 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.
+     */
+    async getUnitsByFamily(phenomenon) {
+        // Check if schema exists and phenomenon exists in schema
+        const [schemaName, schemaItemName] = SchemaItem.parseFullName(phenomenon);
+        const schemaKey = new SchemaKey(schemaName);
+        const schema = await this._context.getSchema(schemaKey);
+        if (!schema) {
+            throw new BentleyError(BentleyStatus.ERROR, "Cannot find schema for phenomenon", () => {
+                return { phenomenon, schema: schemaName };
+            });
+        }
+        const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);
+        const phenom = await this._context.getSchemaItem(itemKey);
+        if (!phenom)
+            throw new BentleyError(BentleyStatus.ERROR, "Cannot find schema item/phenomenon", () => {
+                return { item: schemaItemName, schema: schemaName };
+            });
+        if (phenom.schemaItemType !== SchemaItemType.Phenomenon)
+            throw new BentleyError(BentleyStatus.ERROR, "Item is not a phenomenon", () => {
+                return { itemType: phenom.key.fullName };
+            });
+        // Find units' full name that match given phenomenon param.
+        const filteredUnits = [];
+        const schemaItems = this._context.getSchemaItems();
+        let { value, done } = schemaItems.next();
+        while (!done) {
+            if (Unit.isUnit(value)) {
+                const foundPhenomenon = await value.phenomenon;
+                if (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)) {
+                    const unitProps = this.getUnitsProps(value);
+                    filteredUnits.push(unitProps);
+                }
+            }
+            ({ value, done } = schemaItems.next());
+        }
+        return filteredUnits;
+    }
+    /**
+     * Find alternate display labels associated with unitName, if any.
+     * @param unitName Full name of Unit.
+     */
+    getAlternateDisplayLabels(unitName) {
+        let alternateLabels = [];
+        for (const entry of this._unitExtraData) {
+            if (entry.name.toLowerCase() === unitName.toLowerCase()) {
+                alternateLabels = entry.altDisplayLabels;
+            }
+        }
+        return alternateLabels;
+    }
+    /**
+     * 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.
+     */
+    async findUnit(unitLabel, schemaName, phenomenon, unitSystem) {
+        const findLabel = unitLabel.toLowerCase();
+        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);
+    }
+    /**
+     * 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.
+     */
+    async getConversion(fromUnit, toUnit) {
+        const conversion = await this._unitConverter.calculateConversion(fromUnit.name, toUnit.name);
+        return {
+            factor: conversion.factor,
+            offset: conversion.offset,
+        };
+    }
+    /**
+     * 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);
+        const schemaKey = new SchemaKey(schemaName);
+        const schema = await this._context.getSchema(schemaKey);
+        if (!schema) {
+            throw new BentleyError(BentleyStatus.ERROR, "Cannot find schema for unit", () => {
+                return { schema: schemaName, unit: unitName };
+            });
+        }
+        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 };
+        });
+    }
+    /**
+     * Gets the @itwin/core UnitProps for the given Unit.
+     * @param unit The Unit to convert.
+     * @returns UnitProps interface from @itwin/core.
+     */
+    getUnitsProps(unit) {
+        return {
+            name: unit.fullName,
+            label: unit.label ?? "",
+            phenomenon: unit.phenomenon ? unit.phenomenon.fullName : "",
+            isValid: true,
+            system: unit.unitSystem === undefined ? "" : unit.unitSystem.fullName,
+        };
+    }
+    /**
+     * Finds Unit by displayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.
+     * @internal
+     */
+    async findUnitByDisplayLabel(displayLabel, schemaName, phenomenon, unitSystem) {
+        const schemaItems = this._context.getSchemaItems();
+        let { value, done } = schemaItems.next();
+        while (!done) {
+            if (Unit.isUnit(value) && value.label?.toLowerCase() === displayLabel) {
+                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;
+            }
+            ({ value, done } = schemaItems.next());
+        }
+        throw new BentleyError(BentleyStatus.ERROR, "Cannot find unit with display label", () => {
+            return { displayLabel };
+        });
+    }
+    /**
+     * Finds Unit by altDisplayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.
+     * @internal
+     */
+    async findUnitByAltDisplayLabel(altDisplayLabel, schemaName, phenomenon, unitSystem) {
+        for (const entry of this._unitExtraData) {
+            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;
+                }
+            }
+        }
+        throw new BentleyError(BentleyStatus.ERROR, "Cannot find unit with alternate display label", () => {
+            return { altDisplayLabel };
+        });
+    }
+}
+//# sourceMappingURL=SchemaUnitProvider.js.map

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

@@ -0,0 +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"]}

package/lib/esm/Validation/SchemaWalker.d.ts

@@ -0,0 +1,24 @@
+import { Schema } from "../Metadata/Schema";
+import { ISchemaPartVisitor } from "../SchemaPartVisitorDelegate";
+/**
+ * The purpose of this class is to traverse a given schema, allowing clients to hook into
+ * the traversal process via Visitors to allow for custom processing of the schema elements.
+ * @internal
+ */
+export declare class SchemaWalker {
+    private _visitorHelper;
+    private _schema?;
+    /**
+     * Initializes a new SchemaWalker instance.
+     * @param visitor An ISchemaWalkerVisitor implementation whose methods will be called during schema traversal.
+     */
+    constructor(visitor: ISchemaPartVisitor);
+    /**
+     * Traverses the given Schema, calling ISchemaWalkerVisitor methods along the way.
+     * @param schema The Schema to traverse.
+     */
+    traverseSchema<T extends Schema>(schema: T): Promise<T>;
+    private traverseSchemaItem;
+    private traverseClass;
+}
+//# sourceMappingURL=SchemaWalker.d.ts.map

package/lib/esm/Validation/SchemaWalker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaWalker.d.ts","sourceRoot":"","sources":["../../../src/Validation/SchemaWalker.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,kBAAkB,EAA6B,MAAM,8BAA8B,CAAC;AAE7F;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,cAAc,CAA4B;IAIlD,OAAO,CAAC,OAAO,CAAC,CAAS;IAEzB;;;OAGG;gBACS,OAAO,EAAE,kBAAkB;IAIvC;;;OAGG;IACU,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;YAWtD,kBAAkB;YAOlB,aAAa;CAY5B"}

package/lib/esm/Validation/SchemaWalker.js

@@ -0,0 +1,50 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { SchemaItemType } from "../ECObjects";
+import { ECClass } from "../Metadata/Class";
+import { SchemaPartVisitorDelegate } from "../SchemaPartVisitorDelegate";
+/**
+ * The purpose of this class is to traverse a given schema, allowing clients to hook into
+ * the traversal process via Visitors to allow for custom processing of the schema elements.
+ * @internal
+ */
+export class SchemaWalker {
+    /**
+     * Initializes a new SchemaWalker instance.
+     * @param visitor An ISchemaWalkerVisitor implementation whose methods will be called during schema traversal.
+     */
+    constructor(visitor) {
+        this._visitorHelper = new SchemaPartVisitorDelegate(visitor);
+    }
+    /**
+     * Traverses the given Schema, calling ISchemaWalkerVisitor methods along the way.
+     * @param schema The Schema to traverse.
+     */
+    async traverseSchema(schema) {
+        this._schema = schema;
+        await this._visitorHelper.visitSchema(schema);
+        await this._visitorHelper.visitSchemaPart(schema);
+        for (const item of this._schema.getItems())
+            await this.traverseSchemaItem(item);
+        return schema;
+    }
+    async traverseSchemaItem(schemaItem) {
+        await this._visitorHelper.visitSchemaPart(schemaItem);
+        if (ECClass.isECClass(schemaItem))
+            await this.traverseClass(schemaItem);
+    }
+    async traverseClass(ecClass) {
+        if (ecClass.properties) {
+            for (const property of ecClass.properties) {
+                await this._visitorHelper.visitSchemaPart(property);
+            }
+        }
+        if (ecClass.schemaItemType === SchemaItemType.RelationshipClass) {
+            await this._visitorHelper.visitSchemaPart(ecClass.source);
+            await this._visitorHelper.visitSchemaPart(ecClass.target);
+        }
+    }
+}
+//# sourceMappingURL=SchemaWalker.js.map

package/lib/esm/Validation/SchemaWalker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaWalker.js","sourceRoot":"","sources":["../../../src/Validation/SchemaWalker.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI5C,OAAO,EAAsB,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AAE7F;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAOvB;;;OAGG;IACH,YAAY,OAA2B;QACrC,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc,CAAmB,MAAS;QACrD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAElD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;YACxC,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,UAAsB;QACrD,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEtD,IAAI,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC;YAC/B,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,OAAgB;QAC1C,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,cAAc,KAAK,cAAc,CAAC,iBAAiB,EAAE,CAAC;YAChE,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CAAE,OAA6B,CAAC,MAAM,CAAC,CAAC;YACjF,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CAAE,OAA6B,CAAC,MAAM,CAAC,CAAC;QACnF,CAAC;IACH,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\n\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECClass } from \"../Metadata/Class\";\r\nimport { RelationshipClass } from \"../Metadata/RelationshipClass\";\r\nimport { Schema } from \"../Metadata/Schema\";\r\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\r\nimport { ISchemaPartVisitor, SchemaPartVisitorDelegate } from \"../SchemaPartVisitorDelegate\";\r\n\r\n/**\r\n * The purpose of this class is to traverse a given schema, allowing clients to hook into\r\n * the traversal process via Visitors to allow for custom processing of the schema elements.\r\n * @internal\r\n */\r\nexport class SchemaWalker {\r\n  private _visitorHelper: SchemaPartVisitorDelegate;\r\n\r\n  // This is a cache of the schema we are traversing. The schema also exists within the _context but in order\r\n  // to not have to go back to the context every time we use this cache.\r\n  private _schema?: Schema;\r\n\r\n  /**\r\n   * Initializes a new SchemaWalker instance.\r\n   * @param visitor An ISchemaWalkerVisitor implementation whose methods will be called during schema traversal.\r\n   */\r\n  constructor(visitor: ISchemaPartVisitor) {\r\n    this._visitorHelper = new SchemaPartVisitorDelegate(visitor);\r\n  }\r\n\r\n  /**\r\n   * Traverses the given Schema, calling ISchemaWalkerVisitor methods along the way.\r\n   * @param schema The Schema to traverse.\r\n   */\r\n  public async traverseSchema<T extends Schema>(schema: T): Promise<T> {\r\n    this._schema = schema;\r\n\r\n    await this._visitorHelper.visitSchema(schema);\r\n    await this._visitorHelper.visitSchemaPart(schema);\r\n\r\n    for (const item of this._schema.getItems())\r\n      await this.traverseSchemaItem(item);\r\n    return schema;\r\n  }\r\n\r\n  private async traverseSchemaItem(schemaItem: SchemaItem): Promise<void> {\r\n    await this._visitorHelper.visitSchemaPart(schemaItem);\r\n\r\n    if (ECClass.isECClass(schemaItem))\r\n      await this.traverseClass(schemaItem);\r\n  }\r\n\r\n  private async traverseClass(ecClass: ECClass): Promise<void> {\r\n    if (ecClass.properties) {\r\n      for (const property of ecClass.properties) {\r\n        await this._visitorHelper.visitSchemaPart(property);\r\n      }\r\n    }\r\n\r\n    if (ecClass.schemaItemType === SchemaItemType.RelationshipClass) {\r\n      await this._visitorHelper.visitSchemaPart((ecClass as RelationshipClass).source);\r\n      await this._visitorHelper.visitSchemaPart((ecClass as RelationshipClass).target);\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/esm/ecschema-metadata.d.ts

@@ -0,0 +1,52 @@
+export * from "./Constants";
+export * from "./Context";
+export * from "./DelayedPromise";
+export * from "./Deserialization/SchemaGraphUtil";
+export * from "./Deserialization/JsonProps";
+export * from "./Deserialization/Helper";
+export * from "./Deserialization/XmlParser";
+export * from "./ECName";
+export * from "./ECObjects";
+export * from "./Exception";
+export * from "./Interfaces";
+export { ECClass, StructClass } from "./Metadata/Class";
+export { Constant } from "./Metadata/Constant";
+export { CustomAttributeClass } from "./Metadata/CustomAttributeClass";
+export { EntityClass } from "./Metadata/EntityClass";
+export { AnyEnumerator, Enumeration, Enumerator } from "./Metadata/Enumeration";
+export { Format } from "./Metadata/Format";
+export { InvertedUnit } from "./Metadata/InvertedUnit";
+export { KindOfQuantity } from "./Metadata/KindOfQuantity";
+export { Mixin } from "./Metadata/Mixin";
+export * from "./Metadata/OverrideFormat";
+export { Phenomenon } from "./Metadata/Phenomenon";
+export { Property, PrimitiveProperty, PrimitiveArrayProperty, EnumerationProperty, StructProperty, StructArrayProperty, EnumerationArrayProperty, NavigationProperty, AnyArrayProperty, AnyEnumerationProperty, AnyPrimitiveProperty, AnyProperty, AnyStructProperty, ArrayProperty, PrimitiveOrEnumPropertyBase, } from "./Metadata/Property";
+export { PropertyCategory } from "./Metadata/PropertyCategory";
+export { RelationshipClass, RelationshipConstraint, RelationshipMultiplicity } from "./Metadata/RelationshipClass";
+export { Schema } from "./Metadata/Schema";
+export * from "./Metadata/SchemaItem";
+export { Unit } from "./Metadata/Unit";
+export { UnitSystem } from "./Metadata/UnitSystem";
+export * from "./PropertyTypes";
+export * from "./SchemaJsonLocater";
+export * from "./SchemaKey";
+export * from "./SchemaLoader";
+export * from "./UnitConversion/UnitConversion";
+export * from "./UnitConversion/UnitConverter";
+export * from "./UnitProvider/SchemaUnitProvider";
+export * from "./Validation/SchemaWalker";
+export * from "./SchemaPartVisitorDelegate";
+export { CustomAttribute, CustomAttributeContainerProps } from "./Metadata/CustomAttribute";
+export { SchemaGraph } from "./utils/SchemaGraph";
+/** @docs-package-description
+ * The ecschema-metadata package contains classes for working with ECSchemas that can be used in both [frontend]($docs/learning/frontend/index.md) and [backend]($docs/learning/backend/index.md).
+ */
+/**
+ * @docs-group-description Metadata
+ * Definitions of classes and interfaces that represent all [EC elements]($docs/bis/ec/index.md).
+ */
+/**
+ * @docs-group-description Utils
+ * A set of utility classes used throughout the package.
+ */
+//# sourceMappingURL=ecschema-metadata.d.ts.map

package/lib/esm/ecschema-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecschema-metadata.d.ts","sourceRoot":"","sources":["../../src/ecschema-metadata.ts"],"names":[],"mappings":"AAKA,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EACL,QAAQ,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,cAAc,EACxF,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,sBAAsB,EAC3G,oBAAoB,EAAE,WAAW,EAAE,iBAAiB,EAAE,aAAa,EAAE,2BAA2B,GACjG,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACnH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,6BAA6B,EAAC,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;GAEG;AACH;;;GAGG;AACH;;;GAGG"}

package/lib/esm/ecschema-metadata.js

@@ -0,0 +1,55 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+export * from "./Constants";
+export * from "./Context";
+export * from "./DelayedPromise";
+export * from "./Deserialization/SchemaGraphUtil";
+export * from "./Deserialization/JsonProps";
+export * from "./Deserialization/Helper";
+export * from "./Deserialization/XmlParser";
+export * from "./ECName";
+export * from "./ECObjects";
+export * from "./Exception";
+export * from "./Interfaces";
+export { ECClass, StructClass } from "./Metadata/Class";
+export { Constant } from "./Metadata/Constant";
+export { CustomAttributeClass } from "./Metadata/CustomAttributeClass";
+export { EntityClass } from "./Metadata/EntityClass";
+export { Enumeration } from "./Metadata/Enumeration";
+export { Format } from "./Metadata/Format";
+export { InvertedUnit } from "./Metadata/InvertedUnit";
+export { KindOfQuantity } from "./Metadata/KindOfQuantity";
+export { Mixin } from "./Metadata/Mixin";
+export * from "./Metadata/OverrideFormat";
+export { Phenomenon } from "./Metadata/Phenomenon";
+export { Property, PrimitiveProperty, PrimitiveArrayProperty, EnumerationProperty, StructProperty, StructArrayProperty, EnumerationArrayProperty, NavigationProperty, ArrayProperty, PrimitiveOrEnumPropertyBase, } from "./Metadata/Property";
+export { PropertyCategory } from "./Metadata/PropertyCategory";
+export { RelationshipClass, RelationshipConstraint, RelationshipMultiplicity } from "./Metadata/RelationshipClass";
+export { Schema } from "./Metadata/Schema";
+export * from "./Metadata/SchemaItem";
+export { Unit } from "./Metadata/Unit";
+export { UnitSystem } from "./Metadata/UnitSystem";
+export * from "./PropertyTypes";
+export * from "./SchemaJsonLocater";
+export * from "./SchemaKey";
+export * from "./SchemaLoader";
+export * from "./UnitConversion/UnitConversion";
+export * from "./UnitConversion/UnitConverter";
+export * from "./UnitProvider/SchemaUnitProvider";
+export * from "./Validation/SchemaWalker";
+export * from "./SchemaPartVisitorDelegate";
+export { SchemaGraph } from "./utils/SchemaGraph";
+/** @docs-package-description
+ * The ecschema-metadata package contains classes for working with ECSchemas that can be used in both [frontend]($docs/learning/frontend/index.md) and [backend]($docs/learning/backend/index.md).
+ */
+/**
+ * @docs-group-description Metadata
+ * Definitions of classes and interfaces that represent all [EC elements]($docs/bis/ec/index.md).
+ */
+/**
+ * @docs-group-description Utils
+ * A set of utility classes used throughout the package.
+ */
+//# sourceMappingURL=ecschema-metadata.js.map

package/lib/esm/ecschema-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecschema-metadata.js","sourceRoot":"","sources":["../../src/ecschema-metadata.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAiB,WAAW,EAAc,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EACL,QAAQ,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,cAAc,EACxF,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EACX,aAAa,EAAE,2BAA2B,GACjG,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACnH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;GAEG;AACH;;;GAGG;AACH;;;GAGG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport * from \"./Constants\";\r\nexport * from \"./Context\";\r\nexport * from \"./DelayedPromise\";\r\nexport * from \"./Deserialization/SchemaGraphUtil\";\r\nexport * from \"./Deserialization/JsonProps\";\r\nexport * from \"./Deserialization/Helper\";\r\nexport * from \"./Deserialization/XmlParser\";\r\nexport * from \"./ECName\";\r\nexport * from \"./ECObjects\";\r\nexport * from \"./Exception\";\r\nexport * from \"./Interfaces\";\r\nexport { ECClass, StructClass } from \"./Metadata/Class\";\r\nexport { Constant } from \"./Metadata/Constant\";\r\nexport { CustomAttributeClass } from \"./Metadata/CustomAttributeClass\";\r\nexport { EntityClass } from \"./Metadata/EntityClass\";\r\nexport { AnyEnumerator, Enumeration, Enumerator } from \"./Metadata/Enumeration\";\r\nexport { Format } from \"./Metadata/Format\";\r\nexport { InvertedUnit } from \"./Metadata/InvertedUnit\";\r\nexport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\r\nexport { Mixin } from \"./Metadata/Mixin\";\r\nexport * from \"./Metadata/OverrideFormat\";\r\nexport { Phenomenon } from \"./Metadata/Phenomenon\";\r\nexport {\r\n  Property, PrimitiveProperty, PrimitiveArrayProperty, EnumerationProperty, StructProperty,\r\n  StructArrayProperty, EnumerationArrayProperty, NavigationProperty, AnyArrayProperty, AnyEnumerationProperty,\r\n  AnyPrimitiveProperty, AnyProperty, AnyStructProperty, ArrayProperty, PrimitiveOrEnumPropertyBase,\r\n} from \"./Metadata/Property\";\r\nexport { PropertyCategory } from \"./Metadata/PropertyCategory\";\r\nexport { RelationshipClass, RelationshipConstraint, RelationshipMultiplicity } from \"./Metadata/RelationshipClass\";\r\nexport { Schema } from \"./Metadata/Schema\";\r\nexport * from \"./Metadata/SchemaItem\";\r\nexport { Unit } from \"./Metadata/Unit\";\r\nexport { UnitSystem } from \"./Metadata/UnitSystem\";\r\nexport * from \"./PropertyTypes\";\r\nexport * from \"./SchemaJsonLocater\";\r\nexport * from \"./SchemaKey\";\r\nexport * from \"./SchemaLoader\";\r\nexport * from \"./UnitConversion/UnitConversion\";\r\nexport * from \"./UnitConversion/UnitConverter\";\r\nexport * from \"./UnitProvider/SchemaUnitProvider\";\r\nexport * from \"./Validation/SchemaWalker\";\r\nexport * from \"./SchemaPartVisitorDelegate\";\r\nexport { CustomAttribute, CustomAttributeContainerProps} from \"./Metadata/CustomAttribute\";\r\nexport { SchemaGraph } from \"./utils/SchemaGraph\";\r\n\r\n/** @docs-package-description\r\n * The ecschema-metadata package contains classes for working with ECSchemas that can be used in both [frontend]($docs/learning/frontend/index.md) and [backend]($docs/learning/backend/index.md).\r\n */\r\n/**\r\n * @docs-group-description Metadata\r\n * Definitions of classes and interfaces that represent all [EC elements]($docs/bis/ec/index.md).\r\n */\r\n/**\r\n * @docs-group-description Utils\r\n * A set of utility classes used throughout the package.\r\n */\r\n"]}

package/lib/esm/utils/SchemaGraph.d.ts

@@ -0,0 +1,44 @@
+import { SchemaContext } from "../Context";
+import { SchemaInfo } from "../Interfaces";
+import { Schema } from "../Metadata/Schema";
+/**
+ * A schema and it's reference that make up part of a schema cycle
+ * @internal
+ */
+export interface ReferenceCycle {
+    schema: SchemaInfo;
+    refSchema: SchemaInfo;
+}
+/**
+ * Utility class for detecting cyclic references in a Schema graph.
+ * @internal
+ */
+export declare class SchemaGraph {
+    private _schemas;
+    private constructor();
+    private find;
+    /**
+     * Detected cyclic references in a schema and throw an exception if a cycle is found.
+     */
+    throwIfCycles(): void;
+    /**
+     * Detected cyclic references in a schema.
+     * @returns An array describing the cycle if there is a cycle or undefined if no cycles found.
+     */
+    detectCycles(): ReferenceCycle[] | undefined;
+    private detectCycleUtil;
+    /**
+     * Generates a SchemaGraph for the input schema using the context to find info on referenced schemas.  Use the generateGraphSync if you have the fully loaded Schema.
+     * @param schema The SchemaInfo to build the graph from
+     * @param context The SchemaContext used to locate info on the referenced schemas
+     * @returns A SchemaGraph that can be used to detect schema cycles
+     */
+    static generateGraph(schema: SchemaInfo, context: SchemaContext): Promise<SchemaGraph>;
+    /**
+     * Generates a SchemaGraph for the input schema.  Use the generateGraph if you just have schema info.
+     * @param schema The Schema to build the graph from.
+     * @returns A SchemaGraph that can be used to detect schema cycles
+     */
+    static generateGraphSync(schema: Schema): SchemaGraph;
+}
+//# sourceMappingURL=SchemaGraph.d.ts.map

package/lib/esm/utils/SchemaGraph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaGraph.d.ts","sourceRoot":"","sources":["../../../src/utils/SchemaGraph.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAoB;IAEpC,OAAO;IAEP,OAAO,CAAC,IAAI;IAIZ;;OAEG;IACI,aAAa;IAQpB;;;OAGG;IACI,YAAY,IAAI,cAAc,EAAE,GAAG,SAAS;IAcnD,OAAO,CAAC,eAAe;IA0BvB;;;;;OAKG;WACiB,aAAa,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;IAyBnG;;;;OAIG;WACW,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW;CAmB7D"}