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

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaUnitProvider.js","sourceRoot":"","sources":["../../../src/UnitProvider/SchemaUnitProvider.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,sDAAkE;AAElE,wCAA2D;AAC3D,uDAAoD;AACpD,4CAAwD;AACxD,2CAAwC;AACxC,4CAA8C;AAC9C,mEAAgE;AAEhE;;;GAGG;AACH,MAAa,kBAAkB;IAI7B;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAU,iBAAkC,EAAE;QAApC,mBAAc,GAAd,cAAc,CAAsB;QACxF,IAAI,gBAAgB,YAAY,uBAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,6BAAa,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,uBAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,IAAI,qBAAS,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,2BAAY,CAAC,4BAAa,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,yBAAa,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,2BAAY,CAAC,4BAAa,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,0BAAc,CAAC,UAAU;YACrD,MAAM,IAAI,2BAAY,CAAC,4BAAa,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,WAAI,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,2BAAY,CAAC,4BAAa,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,uBAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,IAAI,qBAAS,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,2BAAY,CAAC,4BAAa,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,yBAAa,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,2BAAY,CAAC,4BAAa,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,0BAAc,CAAC,IAAI;YAC7C,OAAO,IAAI,CAAC;QAEd,MAAM,IAAI,2BAAY,CAAC,4BAAa,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,WAAI,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,2BAAY,CAAC,4BAAa,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,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,+CAA+C,EAAE,GAAG,EAAE;YAChG,OAAO,EAAE,eAAe,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA5OD,gDA4OC","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 * @alpha\r\n */\r\nexport class SchemaUnitProvider implements UnitsProvider {\r\n  private _unitConverter: UnitConverter;\r\n  private _context: SchemaContext;\r\n\r\n  /**\r\n   *\r\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\r\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\r\n   * created and the locater will be added.\r\n   * @param _unitExtraData Additional data like alternate display label not found in Units Schema to match with Units; Defaults to empty array.\r\n   */\r\n  constructor(contextOrLocater: ISchemaLocater, private _unitExtraData: UnitExtraData[] = []){\r\n    if (contextOrLocater instanceof SchemaContext) {\r\n      this._context = contextOrLocater;\r\n    } else {\r\n      this._context = new SchemaContext();\r\n      this._context.addLocater(contextOrLocater);\r\n    }\r\n    this._unitConverter = new UnitConverter(this._context);\r\n  }\r\n\r\n  /**\r\n   * Find unit in a schema that has unitName.\r\n   * @param unitName Full name of unit.\r\n   * @returns UnitProps interface from @itwin/core-quantity whose name matches unitName.\r\n   */\r\n  public async findUnitByName(unitName: string): Promise<UnitProps> {\r\n    const unit = await this.findECUnitByName(unitName);\r\n    return this.getUnitsProps(unit);\r\n  }\r\n\r\n  /**\r\n   * Find all units in context that belongs to given phenomenon.\r\n   * @param phenomenon Full name of phenomenon.\r\n   * @returns Array of UnitProps (from @itwin/core-quantity) interface objects whose name matches phenomenon param.\r\n   */\r\n  public async getUnitsByFamily(phenomenon: string): Promise<Array<UnitProps>> {\r\n    // Check if schema exists and phenomenon exists in schema\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(phenomenon);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema for phenomenon\", () => {\r\n        return { phenomenon, schema: schemaName };\r\n      });\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const phenom = await this._context.getSchemaItem(itemKey);\r\n    if (!phenom)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema item/phenomenon\", () => {\r\n        return { item: schemaItemName, schema: schemaName };\r\n      });\r\n\r\n    if (phenom.schemaItemType !== SchemaItemType.Phenomenon)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Item is not a phenomenon\", () => {\r\n        return { itemType: phenom.key.fullName };\r\n      });\r\n\r\n    // Find units' full name that match given phenomenon param.\r\n    const filteredUnits: Array<UnitProps> = [];\r\n    const schemaItems = this._context.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (Unit.isUnit(value)) {\r\n        const foundPhenomenon = await value.phenomenon;\r\n        if (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)) {\r\n          const unitProps = this.getUnitsProps(value);\r\n          filteredUnits.push(unitProps);\r\n        }\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    return filteredUnits;\r\n  }\r\n\r\n  /**\r\n   * Find alternate display labels associated with unitName, if any.\r\n   * @param unitName Full name of Unit.\r\n   */\r\n  public getAlternateDisplayLabels(unitName: string): Array<string> {\r\n    let alternateLabels: Array<string> = [];\r\n    for (const entry of this._unitExtraData) {\r\n      if (entry.name.toLowerCase() === unitName.toLowerCase()) {\r\n        alternateLabels = entry.altDisplayLabels;\r\n      }\r\n    }\r\n\r\n    return alternateLabels;\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by unitLabel, which could be a display label in the schema or alternate an display label defined in\r\n   * this._unitExtraData. If there are duplicates of the same display label in the context or teh same alternate display\r\n   * labels, specify schemaName, phenomenon, or unitSystem to get a specific unit.\r\n   *\r\n   * @param unitLabel Display label or alternate display label to query unit by.\r\n   * @param schemaName Ensure Unit with unitLabel belongs to Schema with schemaName.\r\n   * @param phenomenon Full name of phenomenon that Unit belongs to.\r\n   * @param unitSystem Full name of unitSystem that Unit belongs to.\r\n   * @returns The UnitProps interface from the @itwin/core-quantity package.\r\n   */\r\n  public async findUnit(unitLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<UnitProps> {\r\n    const findLabel = unitLabel.toLowerCase();\r\n    const findSchema = schemaName ? schemaName.toLowerCase() : undefined;\r\n    const findPhenomenon = phenomenon ? phenomenon.toLowerCase() : undefined;\r\n    const findUnitSystem = unitSystem ? unitSystem.toLowerCase() : undefined;\r\n    let foundUnit: Unit | undefined;\r\n\r\n    try {\r\n      try {\r\n        foundUnit = await this.findUnitByDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);\r\n      } catch (err) {\r\n        // If there is no Unit with display label that matches label, then check for alternate display labels that may match\r\n        foundUnit = await this.findUnitByAltDisplayLabel(findLabel, findSchema, findPhenomenon, findUnitSystem);\r\n      }\r\n    } catch (err) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with label\", () => {\r\n        return { unitLabel };\r\n      });\r\n    }\r\n\r\n    return this.getUnitsProps(foundUnit);\r\n  }\r\n\r\n  /**\r\n   * Gets the @itwin/core-quantity UnitConversionProps for the given fromUnit and toUnit.\r\n   * @param fromUnit The UnitProps of the 'from' unit.\r\n   * @param toUnit The UnitProps of the 'to' unit.\r\n   * @returns The UnitConversionProps interface from the @itwin/core-quantity package.\r\n   */\r\n  public async getConversion(fromUnit: UnitProps, toUnit: UnitProps): Promise<UnitConversionProps> {\r\n    const conversion = await this._unitConverter.calculateConversion(fromUnit.name, toUnit.name);\r\n    return {\r\n      factor: conversion.factor,\r\n      offset: conversion.offset,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Find unit in a schema that has unitName.\r\n   * @param unitName Full name of unit.\r\n   * @returns Unit whose full name matches unitName.\r\n   */\r\n  private async findECUnitByName(unitName: string): Promise<Unit> {\r\n    // Check if schema exists and unit exists in schema\r\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(unitName);\r\n    const schemaKey = new SchemaKey(schemaName);\r\n    const schema = await this._context.getSchema(schemaKey);\r\n\r\n    if (!schema) {\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema for unit\", () => {\r\n        return { schema: schemaName, unit: unitName };\r\n      });\r\n    }\r\n\r\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\r\n    const item = await this._context.getSchemaItem<Unit>(itemKey);\r\n    if (!item)\r\n      throw new BentleyError(BentleyStatus.ERROR, \"Cannot find schema item/unit\", () => {\r\n        return { item: schemaItemName, schema: schemaName };\r\n      });\r\n\r\n    if (item.schemaItemType === SchemaItemType.Unit)\r\n      return item;\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Item is not a unit\", () => {\r\n      return { itemType: item.key.fullName };\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Gets the @itwin/core UnitProps for the given Unit.\r\n   * @param unit The Unit to convert.\r\n   * @returns UnitProps interface from @itwin/core.\r\n   */\r\n  private getUnitsProps(unit: Unit): UnitProps {\r\n    return {\r\n      name: unit.fullName,\r\n      label: unit.label ?? \"\",\r\n      phenomenon: unit.phenomenon ? unit.phenomenon.fullName : \"\",\r\n      isValid: true,\r\n      system: unit.unitSystem === undefined ? \"\" : unit.unitSystem.fullName,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by displayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.\r\n   * @internal\r\n   */\r\n  private async findUnitByDisplayLabel(displayLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<Unit> {\r\n    const schemaItems = this._context.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (Unit.isUnit(value) && value.label?.toLowerCase() === displayLabel) {\r\n        const currPhenomenon = await value.phenomenon;\r\n        const currUnitSystem = await value.unitSystem;\r\n        if (!schemaName || value.schema.name.toLowerCase() === schemaName)\r\n          if (!phenomenon || (currPhenomenon && currPhenomenon.key.matchesFullName(phenomenon)))\r\n            if (!unitSystem || (currUnitSystem && currUnitSystem.key.matchesFullName(unitSystem)))\r\n              return value;\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with display label\", () => {\r\n      return { displayLabel };\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Finds Unit by altDisplayLabel and that it belongs to schemaName, phenomenon, and unitSystem if defined.\r\n   * @internal\r\n   */\r\n  private async findUnitByAltDisplayLabel(altDisplayLabel: string, schemaName?: string, phenomenon?: string, unitSystem?: string): Promise<Unit> {\r\n    for (const entry of this._unitExtraData) {\r\n      if (entry.altDisplayLabels && entry.altDisplayLabels.length > 0) {\r\n        if (entry.altDisplayLabels.findIndex((ref: string) => ref.toLowerCase() === altDisplayLabel) !== -1) {\r\n          // Found altDisplayLabel that matches label to find\r\n          const unit = await this.findECUnitByName(entry.name);\r\n          const foundPhenomenon = await unit.phenomenon;\r\n          const foundUnitSystem = await unit.unitSystem;\r\n          if (!schemaName || unit.schema.name.toLowerCase() === schemaName)\r\n            if (!phenomenon || (foundPhenomenon && foundPhenomenon.key.matchesFullName(phenomenon)))\r\n              if (!unitSystem || (foundUnitSystem && foundUnitSystem.key.matchesFullName(unitSystem)))\r\n                return unit;\r\n        }\r\n      }\r\n    }\r\n\r\n    throw new BentleyError(BentleyStatus.ERROR, \"Cannot find unit with alternate display label\", () => {\r\n      return { altDisplayLabel };\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SchemaUnitProvider.js","sourceRoot":"","sources":["../../../src/UnitProvider/SchemaUnitProvider.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,sDAAkE;AAElE,wCAA2D;AAC3D,uDAAoD;AACpD,4CAAwD;AACxD,2CAAwC;AACxC,4CAA8C;AAC9C,mEAAgE;AAEhE;;;GAGG;AACH,MAAa,kBAAkB;IAI7B;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAU,iBAAkC,EAAE;QAApC,mBAAc,GAAd,cAAc,CAAsB;QACxF,IAAI,gBAAgB,YAAY,uBAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,6BAAa,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,uBAAU,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,IAAI,qBAAS,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,2BAAY,CAAC,4BAAa,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,yBAAa,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,2BAAY,CAAC,4BAAa,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,0BAAc,CAAC,UAAU;YACrD,MAAM,IAAI,2BAAY,CAAC,4BAAa,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,WAAI,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,2BAAY,CAAC,4BAAa,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,uBAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,IAAI,qBAAS,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,2BAAY,CAAC,4BAAa,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,yBAAa,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,2BAAY,CAAC,4BAAa,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,0BAAc,CAAC,IAAI;YAC7C,OAAO,IAAI,CAAC;QAEd,MAAM,IAAI,2BAAY,CAAC,4BAAa,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,WAAI,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,2BAAY,CAAC,4BAAa,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,2BAAY,CAAC,4BAAa,CAAC,KAAK,EAAE,+CAA+C,EAAE,GAAG,EAAE;YAChG,OAAO,EAAE,eAAe,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA5OD,gDA4OC","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/Constants.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @internal
+ */
+export declare class ECStringConstants {
+    static readonly RELATIONSHIP_END_SOURCE: string;
+    static readonly RELATIONSHIP_END_TARGET: string;
+    static readonly CONTAINERTYPE_SCHEMA: string;
+    static readonly CONTAINERTYPE_ENTITYCLASS: string;
+    static readonly CONTAINERTYPE_CUSTOMATTRIBUTECLASS: string;
+    static readonly CONTAINERTYPE_STRUCTCLASS: string;
+    static readonly CONTAINERTYPE_RELATIONSHIPCLASS: string;
+    static readonly CONTAINERTYPE_ANYCLASS: string;
+    static readonly CONTAINERTYPE_PRIMITIVEPROPERTY: string;
+    static readonly CONTAINERTYPE_STRUCTPROPERTY: string;
+    static readonly CONTAINERTYPE_PRIMITIVEARRAYPROPERTY: string;
+    static readonly CONTAINERTYPE_STRUCTARRAYPROPERTY: string;
+    static readonly CONTAINERTYPE_NAVIGATIONPROPERTY: string;
+    static readonly CONTAINERTYPE_ANYPROPERTY: string;
+    static readonly CONTAINERTYPE_SOURCERELATIONSHIPCONSTRAINT: string;
+    static readonly CONTAINERTYPE_TARGETRELATIONSHIPCONSTRAINT: string;
+    static readonly CONTAINERTYPE_ANYRELATIONSHIPCONSTRAINT: string;
+    static readonly CONTAINERTYPE_ANY: string;
+}
+//# sourceMappingURL=Constants.d.ts.map

package/lib/esm/Constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constants.d.ts","sourceRoot":"","sources":["../../src/Constants.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,qBAAa,iBAAiB;IAE5B,gBAAuB,uBAAuB,EAAE,MAAM,CAAY;IAClE,gBAAuB,uBAAuB,EAAE,MAAM,CAAY;IAGlE,gBAAuB,oBAAoB,EAAE,MAAM,CAAY;IAC/D,gBAAuB,yBAAyB,EAAE,MAAM,CAAiB;IACzE,gBAAuB,kCAAkC,EAAE,MAAM,CAA0B;IAC3F,gBAAuB,yBAAyB,EAAE,MAAM,CAAiB;IACzE,gBAAuB,+BAA+B,EAAE,MAAM,CAAuB;IACrF,gBAAuB,sBAAsB,EAAE,MAAM,CAAc;IAEnE,gBAAuB,+BAA+B,EAAE,MAAM,CAAuB;IACrF,gBAAuB,4BAA4B,EAAE,MAAM,CAAoB;IAC/E,gBAAuB,oCAAoC,EAAE,MAAM,CAAmB;IACtF,gBAAuB,iCAAiC,EAAE,MAAM,CAAyB;IACzF,gBAAuB,gCAAgC,EAAE,MAAM,CAAwB;IACvF,gBAAuB,yBAAyB,EAAE,MAAM,CAAiB;IAEzE,gBAAuB,0CAA0C,EAAE,MAAM,CAAkC;IAC3G,gBAAuB,0CAA0C,EAAE,MAAM,CAAkC;IAC3G,gBAAuB,uCAAuC,EAAE,MAAM,CAA+B;IAErG,gBAAuB,iBAAiB,EAAE,MAAM,CAAS;CAC1D"}

package/lib/esm/Constants.js

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/**
+ * @internal
+ */
+export class ECStringConstants {
+}
+// Relationship End
+ECStringConstants.RELATIONSHIP_END_SOURCE = "Source";
+ECStringConstants.RELATIONSHIP_END_TARGET = "Target";
+// Container Type
+ECStringConstants.CONTAINERTYPE_SCHEMA = "Schema";
+ECStringConstants.CONTAINERTYPE_ENTITYCLASS = "EntityClass";
+ECStringConstants.CONTAINERTYPE_CUSTOMATTRIBUTECLASS = "CustomAttributeClass";
+ECStringConstants.CONTAINERTYPE_STRUCTCLASS = "StructClass";
+ECStringConstants.CONTAINERTYPE_RELATIONSHIPCLASS = "RelationshipClass";
+ECStringConstants.CONTAINERTYPE_ANYCLASS = "AnyClass";
+ECStringConstants.CONTAINERTYPE_PRIMITIVEPROPERTY = "PrimitiveProperty";
+ECStringConstants.CONTAINERTYPE_STRUCTPROPERTY = "StructProperty";
+ECStringConstants.CONTAINERTYPE_PRIMITIVEARRAYPROPERTY = "ArrayProperty";
+ECStringConstants.CONTAINERTYPE_STRUCTARRAYPROPERTY = "StructArrayProperty";
+ECStringConstants.CONTAINERTYPE_NAVIGATIONPROPERTY = "NavigationProperty";
+ECStringConstants.CONTAINERTYPE_ANYPROPERTY = "AnyProperty";
+ECStringConstants.CONTAINERTYPE_SOURCERELATIONSHIPCONSTRAINT = "SourceRelationshipConstraint";
+ECStringConstants.CONTAINERTYPE_TARGETRELATIONSHIPCONSTRAINT = "TargetRelationshipConstraint";
+ECStringConstants.CONTAINERTYPE_ANYRELATIONSHIPCONSTRAINT = "AnyRelationshipConstraint";
+ECStringConstants.CONTAINERTYPE_ANY = "Any";
+//# sourceMappingURL=Constants.js.map

package/lib/esm/Constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constants.js","sourceRoot":"","sources":["../../src/Constants.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AACH,MAAM,OAAO,iBAAiB;;AAC5B,mBAAmB;AACI,yCAAuB,GAAW,QAAQ,CAAC;AAC3C,yCAAuB,GAAW,QAAQ,CAAC;AAElE,iBAAiB;AACM,sCAAoB,GAAW,QAAQ,CAAC;AACxC,2CAAyB,GAAW,aAAa,CAAC;AAClD,oDAAkC,GAAW,sBAAsB,CAAC;AACpE,2CAAyB,GAAW,aAAa,CAAC;AAClD,iDAA+B,GAAW,mBAAmB,CAAC;AAC9D,wCAAsB,GAAW,UAAU,CAAC;AAE5C,iDAA+B,GAAW,mBAAmB,CAAC;AAC9D,8CAA4B,GAAW,gBAAgB,CAAC;AACxD,sDAAoC,GAAW,eAAe,CAAC;AAC/D,mDAAiC,GAAW,qBAAqB,CAAC;AAClE,kDAAgC,GAAW,oBAAoB,CAAC;AAChE,2CAAyB,GAAW,aAAa,CAAC;AAElD,4DAA0C,GAAW,8BAA8B,CAAC;AACpF,4DAA0C,GAAW,8BAA8B,CAAC;AACpF,yDAAuC,GAAW,2BAA2B,CAAC;AAE9E,mCAAiB,GAAW,KAAK,CAAC","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\n/**\r\n * @internal\r\n */\r\nexport class ECStringConstants {\r\n  // Relationship End\r\n  public static readonly RELATIONSHIP_END_SOURCE: string = \"Source\";\r\n  public static readonly RELATIONSHIP_END_TARGET: string = \"Target\";\r\n\r\n  // Container Type\r\n  public static readonly CONTAINERTYPE_SCHEMA: string = \"Schema\";\r\n  public static readonly CONTAINERTYPE_ENTITYCLASS: string = \"EntityClass\";\r\n  public static readonly CONTAINERTYPE_CUSTOMATTRIBUTECLASS: string = \"CustomAttributeClass\";\r\n  public static readonly CONTAINERTYPE_STRUCTCLASS: string = \"StructClass\";\r\n  public static readonly CONTAINERTYPE_RELATIONSHIPCLASS: string = \"RelationshipClass\";\r\n  public static readonly CONTAINERTYPE_ANYCLASS: string = \"AnyClass\";\r\n\r\n  public static readonly CONTAINERTYPE_PRIMITIVEPROPERTY: string = \"PrimitiveProperty\";\r\n  public static readonly CONTAINERTYPE_STRUCTPROPERTY: string = \"StructProperty\";\r\n  public static readonly CONTAINERTYPE_PRIMITIVEARRAYPROPERTY: string = \"ArrayProperty\";\r\n  public static readonly CONTAINERTYPE_STRUCTARRAYPROPERTY: string = \"StructArrayProperty\";\r\n  public static readonly CONTAINERTYPE_NAVIGATIONPROPERTY: string = \"NavigationProperty\";\r\n  public static readonly CONTAINERTYPE_ANYPROPERTY: string = \"AnyProperty\";\r\n\r\n  public static readonly CONTAINERTYPE_SOURCERELATIONSHIPCONSTRAINT: string = \"SourceRelationshipConstraint\";\r\n  public static readonly CONTAINERTYPE_TARGETRELATIONSHIPCONSTRAINT: string = \"TargetRelationshipConstraint\";\r\n  public static readonly CONTAINERTYPE_ANYRELATIONSHIPCONSTRAINT: string = \"AnyRelationshipConstraint\";\r\n\r\n  public static readonly CONTAINERTYPE_ANY: string = \"Any\";\r\n}\r\n"]}

package/lib/esm/Context.d.ts

@@ -0,0 +1,219 @@
+import { SchemaMatchType } from "./ECObjects";
+import { SchemaInfo } from "./Interfaces";
+import { Schema } from "./Metadata/Schema";
+import { SchemaItem } from "./Metadata/SchemaItem";
+import { SchemaItemKey, SchemaKey } from "./SchemaKey";
+/**
+ * The interface defines what is needed to be an `ISchemaLocater`.
+ * A Schema Locater loads the requested schema if it can or returns undefined.
+ * Schema Locaters should always load the schema on each request and should not hold a cache of schemas.
+ * Schema locaters should never be used directly to load a schema, they should be added to a `SchemaContext`
+ * and the context should be used to load schemas.  The `SchemaContext` caches schemas and manages schema life time.
+ * @beta
+ */
+export interface ISchemaLocater {
+    /**
+     * Attempts to get a schema from the locater. Yields undefined if no matching schema is found.
+     * For schemas that may have references, construct and call through a SchemaContext instead.
+     * @param schemaKey key to look up
+     * @param matchType how to match key against candidate schemas
+     * @param context context for loading schema references
+     */
+    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
+    /**
+    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+    * May return the entire Schema so long as it is completely loaded as it satisfies the SchemaInfo interface.
+    * @param schemaKey The SchemaKey describing the schema to get from the cache.
+    * @param matchType The match type to use when locating the schema
+    */
+    getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    /**
+     * Attempts to get a schema from the locater. Yields undefined if no matching schema is found.
+     * For schemas that may have references, construct and call through a SchemaContext instead.
+     * @param schemaKey key to look up
+     * @param matchType how to match key against candidate schemas
+     * @param context context for loading schema references
+     */
+    getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
+}
+/**
+ * @beta
+ */
+export interface ISchemaItemLocater {
+    getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined>;
+}
+/**
+ * @internal
+ */
+export declare class SchemaCache implements ISchemaLocater {
+    private _schema;
+    constructor();
+    get count(): number;
+    private loadedSchemaExists;
+    private schemaPromiseExists;
+    private findEntry;
+    private removeSchemaPromise;
+    private removeEntry;
+    /**
+     * Returns true if the schema exists in either the schema cache or the promise cache.  SchemaMatchType.Latest used.
+     * @param schemaKey The key to search for.
+     */
+    schemaExists(schemaKey: Readonly<SchemaKey>): boolean;
+    /**
+     * Adds a promise to load the schema to the cache. Does not allow for duplicate schemas in the cache of schemas or cache of promises, checks using SchemaMatchType.Latest.
+     * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache
+     * @param schemaInfo An object with the schema key for the schema being loaded and it's references
+     * @param schema The partially loaded schema that the promise will fulfill
+     * @param schemaPromise The schema promise to add to the cache.
+     */
+    addSchemaPromise(schemaInfo: SchemaInfo, schema: Schema, schemaPromise: Promise<Schema>): Promise<void>;
+    /**
+     * Adds a schema to the cache. Does not allow for duplicate schemas, checks using SchemaMatchType.Latest.
+     * @param schema The schema to add to the cache.
+     */
+    addSchema<T extends Schema>(schema: T): Promise<void>;
+    /**
+     * Adds a schema to the cache. Does not allow for duplicate schemas, checks using SchemaMatchType.Latest.
+     * @param schema The schema to add to the cache.
+     */
+    addSchemaSync<T extends Schema>(schema: T): void;
+    /**
+     * Gets the schema which matches the provided SchemaKey.
+     * @param schemaKey The SchemaKey describing the schema to get from the cache.
+     * @param matchType The match type to use when locating the schema
+     */
+    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      */
+    getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<SchemaInfo | undefined>;
+    /**
+     * Gets the schema which matches the provided SchemaKey.  If the schema is partially loaded an exception will be thrown.
+     * @param schemaKey The SchemaKey describing the schema to get from the cache.
+     * @param matchType The match type to use when locating the schema
+     */
+    getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): T | undefined;
+    /**
+     * Generator function that can iterate through each schema in _schema SchemaMap and items for each Schema.
+     * Does not include schema items from schemas that are not completely loaded yet.
+     */
+    getSchemaItems(): IterableIterator<SchemaItem>;
+    /**
+     * Gets all the schemas from the schema cache.
+     * Does not include schemas from schemas that are not completely loaded yet.
+     * @returns An array of Schema objects.
+     */
+    getAllSchemas(): Schema[];
+}
+/**
+ * The SchemaContext, context object is used to facilitate schema and schema item location.
+ *
+ * The context controls the lifetime of each schema that it knows about. It has to be explicitly removed from the context to delete a schema object.
+ *
+ * The context is made up of a group of Schema Locators.
+ * @beta
+ */
+export declare class SchemaContext implements ISchemaItemLocater {
+    private _locaters;
+    private _knownSchemas;
+    constructor();
+    addLocater(locater: ISchemaLocater): void;
+    /**
+     * Adds the schema to this context.  Use addSchemaPromise instead when asynchronously loading schemas.
+     * @param schema The schema to add to this context
+     */
+    addSchema(schema: Schema): Promise<void>;
+    /**
+     * Adds the schema to this context
+     * @param schema The schema to add to this context
+     */
+    addSchemaSync(schema: Schema): void;
+    /**
+     * Adds the given SchemaItem to the the SchemaContext by locating the schema, with the best match of SchemaMatchType.Exact, and
+     * @param schemaItem The SchemaItem to add
+     * @deprecated in 4.0 use ecschema-editing package
+     */
+    addSchemaItem(schemaItem: SchemaItem): Promise<void>;
+    /**
+     * Returns true if the schema is already in the context.  SchemaMatchType.Latest is used to find a match.
+     * @param schemaKey
+     */
+    schemaExists(schemaKey: Readonly<SchemaKey>): boolean;
+    /**
+     * Adds a promise to load the schema to the cache. Does not allow for duplicate schemas in the cache of schemas or cache of promises, checks using SchemaMatchType.Latest.
+     * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache.
+     * Use this method over addSchema when asynchronously loading schemas
+     * @param schemaInfo An object with the schema key for the schema being loaded and it's references
+     * @param schema The partially loaded schema that the promise will fulfill
+     * @param schemaPromise The schema promise to add to the cache.
+     */
+    addSchemaPromise(schemaInfo: SchemaInfo, schema: Schema, schemaPromise: Promise<Schema>): Promise<void>;
+    /** Attempts to obtain a schema from this context that matches the specified criteria.
+     * @param schemaKey Identifies the schema to obtain.
+     * @param matchType Criteria by which to identify potentially matching schemas.
+     * @returns the schema matching the input criteria, or `undefined` if no such schema could be located.
+     */
+    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
+    /**
+     * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+     * The fully loaded schema can be gotten later from the context using [[getSchema]].
+     * @param schemaKey The SchemaKey describing the schema to get from the cache.
+     * @param matchType The match type to use when locating the schema
+     */
+    getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType): Promise<SchemaInfo | undefined>;
+    /** Attempts to obtain a schema from this context that matches the specified criteria.
+     * Will return undefined if the schema is partially loaded.  Use [[getSchema]] to await until the schema is completely loaded.
+     * @param schemaKey Identifies the schema to obtain.
+     * @param matchType Criteria by which to identify potentially matching schemas.
+     * @returns the schema matching the input criteria, or `undefined` if no such schema could be located.
+     */
+    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType?: SchemaMatchType): T | undefined;
+    /**
+     * Attempts to get a Schema from the context's cache.
+     * Will await a partially loaded schema then return when it is completely loaded.
+     * @param schemaKey The SchemaKey to identify the Schema.
+     * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.
+     * @internal
+     */
+    getCachedSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
+    /**
+     * Attempts to get a Schema from the context's cache.
+     * Will return undefined if the cached schema is partially loaded.  Use [[getCachedSchema]] to await until the schema is completely loaded.
+     * @param schemaKey The SchemaKey to identify the Schema.
+     * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.
+     * @internal
+     */
+    getCachedSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): T | undefined;
+    /**
+     * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].
+     * Will await a partially loaded schema then look in it for the requested item
+     * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.
+     * @returns The requested schema item
+     */
+    getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined>;
+    /**
+     * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].
+     * Will skip a partially loaded schema and return undefined if the item belongs to that schema.  Use the async method to await partially loaded schemas.
+     * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.
+     * @returns The requested schema item
+     */
+    getSchemaItemSync<T extends SchemaItem>(schemaItemKey: SchemaItemKey): T | undefined;
+    /**
+     * Iterates through the items of each schema known to the context.  This includes schemas added to the
+     * context using [[SchemaContext.addSchema]]. This does not include schemas that
+     * can be located by an ISchemaLocater instance added to the context.
+     * Does not include schema items from schemas that are not completely loaded yet.
+     */
+    getSchemaItems(): IterableIterator<SchemaItem>;
+    /**
+     * Gets all the Schemas known by the context. This includes schemas added to the
+     * context using [[SchemaContext.addSchema]]. This does not include schemas that
+     * can be located by an ISchemaLocater instance added to the context.  Does not
+     * include schemas that are partially loaded.
+     * @returns An array of Schema objects.
+     */
+    getKnownSchemas(): Schema[];
+}
+//# sourceMappingURL=Context.d.ts.map

package/lib/esm/Context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAiB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAgBvD;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAExI;;;;;MAKE;IACF,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAEnI;;;;;;OAMG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS,CAAC;CACpI;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CAC3F;AAED;;GAEG;AACH,qBAAa,WAAY,YAAW,cAAc;IAChD,OAAO,CAAC,OAAO,CAAY;;IAM3B,IAAW,KAAK,WAAkC;IAElD,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,mBAAmB;IAM3B,OAAO,CAAC,WAAW;IAInB;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO;IAI5D;;;;;;OAMG;IACU,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC;IAepG;;;OAGG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC;IAOlD;;;OAGG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC;IAOhD;;;;OAIG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAqBrJ;;;;QAII;IACS,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAWhJ;;;;OAIG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,CAAC,GAAG,SAAS;IAe1I;;;OAGG;IACM,cAAc,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAQvD;;;;OAIG;IACI,aAAa,IAAI,MAAM,EAAE;CAGjC;AAED;;;;;;;GAOG;AACH,qBAAa,aAAc,YAAW,kBAAkB;IACtD,OAAO,CAAC,SAAS,CAAmB;IAEpC,OAAO,CAAC,aAAa,CAAc;;IAS5B,UAAU,CAAC,OAAO,EAAE,cAAc;IAIzC;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM;IAIrC;;;OAGG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM;IAInC;;;;OAIG;IACU,aAAa,CAAC,UAAU,EAAE,UAAU;IAQjD;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO;IAI5D;;;;;;;OAOG;IACU,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC;IAIpG;;;;OAIG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAWrJ;;;;;OAKG;IACU,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAUvH;;;;;OAKG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,CAAC,GAAG,SAAS;IAWhI;;;;;;OAMG;IACU,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAI3J;;;;;;OAMG;IACI,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,CAAC,GAAG,SAAS;IAIhJ;;;;;OAKG;IACU,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAOtG;;;;;OAKG;IACI,iBAAiB,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;IAO3F;;;;;OAKG;IACI,cAAc,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAIrD;;;;;;OAMG;IACI,eAAe,IAAI,MAAM,EAAE;CAGnC"}