@itwin/ecschema-metadata 3.1.0-dev.6 → 3.1.0

package/lib/cjs/Metadata/OverrideFormat.js.map

@@ -1 +1 @@
-{"version":3,"file":"OverrideFormat.js","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oFAAiF;AACjF,4CAA8C;AAO9C;;;GAGG;AACH,MAAa,cAAc;IAazB,YAAY,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC9I,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,4BAA4B,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC1F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;IAC9B,CAAC;IAED,mCAAmC;IACnC,IAAW,SAAS,KAA6C,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACpJ,IAAW,KAAK,KAAK,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE5F,sCAAsC;IACtC,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IACpE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1E,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAClF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChF,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACtE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC5F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC5E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1E,cAAc,CAAC,WAAyB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC,KAAK,WAAW,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,SAAiB;QAClC,IAAI,QAAQ,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzG,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,QAAQ,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE/C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;YAC3C,QAAQ,IAAI,GAAG,CAAC;YAChB,QAAQ,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxF,QAAQ,IAAI,IAAI,SAAS,GAAG,CAAC;SAC9B;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC7K,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAE/B,IAAI,SAAS;YACX,QAAQ,IAAI,IAAI,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE1C,IAAI,SAAS,KAAK,aAAa;YAC7B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,aAAa;YAC3C,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;;gBAEjC,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,IAAI,SAAS,GAAG,CAAC;QAClD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAW;QACxC,MAAM,cAAc,GAAG,MAAwB,CAAC;QAEhD,OAAO,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS;YACtG,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM,CAAC;IAC1E,CAAC;CACF;AA7FD,wCA6FC","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/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from \"../utils/FormatEnums\";\r\nimport { Format } from \"./Format\";\r\nimport { InvertedUnit } from \"./InvertedUnit\";\r\nimport { Schema } from \"./Schema\";\r\nimport { Unit } from \"./Unit\";\r\n\r\n/**\r\n * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.\r\n * @beta\r\n */\r\nexport class OverrideFormat {\r\n  private _precision?: DecimalPrecision | FractionalPrecision;\r\n  private _units?: Array<[Unit | InvertedUnit, string | undefined]>;\r\n\r\n  /** The Format that this OverrideFormat is extending */\r\n  public readonly parent: Format;\r\n\r\n  /** The name of this OverrideFormat.\r\n   *\r\n   * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.\r\n   */\r\n  public readonly name: string;\r\n\r\n  constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>) {\r\n    this.parent = parent;\r\n    this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);\r\n    this._precision = precision;\r\n    this._units = unitAndLabels;\r\n  }\r\n\r\n  // Properties that can be overriden\r\n  public get precision(): DecimalPrecision | FractionalPrecision { return (undefined === this._precision) ? this.parent.precision : this._precision; }\r\n  public get units() { return (undefined === this._units) ? this.parent.units : this._units; }\r\n\r\n  // Properties that cannot be overriden\r\n  public get fullName(): string { return this.name; }\r\n  public get roundFactor(): number { return this.parent.roundFactor; }\r\n  public get type(): FormatType { return this.parent.type; }\r\n  public get minWidth(): number | undefined { return this.parent.minWidth; }\r\n  public get scientificType(): ScientificType | undefined { return this.parent.scientificType; }\r\n  public get showSignOption(): ShowSignOption { return this.parent.showSignOption; }\r\n  public get decimalSeparator(): string { return this.parent.decimalSeparator; }\r\n  public get thousandSeparator(): string { return this.parent.thousandSeparator; }\r\n  public get uomSeparator(): string { return this.parent.uomSeparator; }\r\n  public get stationSeparator(): string { return this.parent.stationSeparator; }\r\n  public get stationOffsetSize(): number | undefined { return this.parent.stationOffsetSize; }\r\n  public get formatTraits(): FormatTraits { return this.parent.formatTraits; }\r\n  public get spacer(): string | undefined { return this.parent.spacer; }\r\n  public get includeZero(): boolean | undefined { return this.parent.includeZero; }\r\n\r\n  public hasFormatTrait(formatTrait: FormatTraits) {\r\n    return (this.parent.formatTraits & formatTrait) === formatTrait;\r\n  }\r\n\r\n  /** Returns the format string of this override in the Xml full name format.\r\n   * @alpha\r\n   */\r\n  public fullNameXml(koqSchema: Schema): string {\r\n    let fullName = XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);\r\n\r\n    if (undefined !== this.precision)\r\n      fullName += `(${this.precision.toString()})`;\r\n\r\n    if (undefined === this._units)\r\n      return fullName;\r\n    for (const [unit, unitLabel] of this._units) {\r\n      fullName += \"[\";\r\n      fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);\r\n      fullName += `|${unitLabel}]`;\r\n    }\r\n    return fullName;\r\n  }\r\n\r\n  /**\r\n   * Creates a valid OverrideFormat fullName from the parent Format and overridden units.\r\n   * @param parent The parent Format.\r\n   * @param unitAndLabels The overridden unit and labels collection.\r\n   */\r\n  public static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string {\r\n    let fullName = parent.fullName;\r\n\r\n    if (precision)\r\n      fullName += `(${precision.toString()})`;\r\n\r\n    if (undefined === unitAndLabels)\r\n      return fullName;\r\n    for (const [unit, unitLabel] of unitAndLabels)\r\n      if (undefined === unitLabel)\r\n        fullName += `[${unit.fullName}]`;\r\n      else\r\n        fullName += `[${unit.fullName}|${unitLabel}]`;\r\n    return fullName;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public static isOverrideFormat(object: any): object is OverrideFormat {\r\n    const overrideFormat = object as OverrideFormat;\r\n\r\n    return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined &&\r\n             overrideFormat.parent.schemaItemType === SchemaItemType.Format;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"OverrideFormat.js","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oFAAiF;AACjF,4CAA8C;AAO9C;;;GAGG;AACH,MAAa,cAAc;IAazB,YAAY,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC9I,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,4BAA4B,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC1F,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;IAC9B,CAAC;IAED,mCAAmC;IACnC,IAAW,SAAS,KAA6C,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACpJ,IAAW,KAAK,KAAK,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAE5F,sCAAsC;IACtC,IAAW,QAAQ,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IACpE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1E,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IAClF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChF,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACtE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC9E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC5F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC5E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1E,cAAc,CAAC,WAAyB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,WAAW,CAAC,KAAK,WAAW,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,SAAiB;QAClC,IAAI,QAAQ,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzG,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,QAAQ,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE/C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;YAC3C,QAAQ,IAAI,GAAG,CAAC;YAChB,QAAQ,IAAI,6CAAqB,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACxF,QAAQ,IAAI,IAAI,SAAS,GAAG,CAAC;SAC9B;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,4BAA4B,CAAC,MAAc,EAAE,SAAkD,EAAE,aAAgE;QAC7K,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAE/B,IAAI,SAAS;YACX,QAAQ,IAAI,IAAI,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC;QAE1C,IAAI,SAAS,KAAK,aAAa;YAC7B,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,aAAa;YAC3C,IAAI,SAAS,KAAK,SAAS;gBACzB,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;;gBAEjC,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,IAAI,SAAS,GAAG,CAAC;QAClD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,MAAW;QACxC,MAAM,cAAc,GAAG,MAAwB,CAAC;QAEhD,OAAO,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS;YACtG,cAAc,CAAC,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM,CAAC;IAC1E,CAAC;CACF;AA7FD,wCA6FC","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/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from \"@itwin/core-quantity\";\r\nimport { Format } from \"./Format\";\r\nimport { InvertedUnit } from \"./InvertedUnit\";\r\nimport { Schema } from \"./Schema\";\r\nimport { Unit } from \"./Unit\";\r\n\r\n/**\r\n * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.\r\n * @beta\r\n */\r\nexport class OverrideFormat {\r\n  private _precision?: DecimalPrecision | FractionalPrecision;\r\n  private _units?: Array<[Unit | InvertedUnit, string | undefined]>;\r\n\r\n  /** The Format that this OverrideFormat is extending */\r\n  public readonly parent: Format;\r\n\r\n  /** The name of this OverrideFormat.\r\n   *\r\n   * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.\r\n   */\r\n  public readonly name: string;\r\n\r\n  constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>) {\r\n    this.parent = parent;\r\n    this.name = OverrideFormat.createOverrideFormatFullName(parent, precision, unitAndLabels);\r\n    this._precision = precision;\r\n    this._units = unitAndLabels;\r\n  }\r\n\r\n  // Properties that can be overriden\r\n  public get precision(): DecimalPrecision | FractionalPrecision { return (undefined === this._precision) ? this.parent.precision : this._precision; }\r\n  public get units() { return (undefined === this._units) ? this.parent.units : this._units; }\r\n\r\n  // Properties that cannot be overriden\r\n  public get fullName(): string { return this.name; }\r\n  public get roundFactor(): number { return this.parent.roundFactor; }\r\n  public get type(): FormatType { return this.parent.type; }\r\n  public get minWidth(): number | undefined { return this.parent.minWidth; }\r\n  public get scientificType(): ScientificType | undefined { return this.parent.scientificType; }\r\n  public get showSignOption(): ShowSignOption { return this.parent.showSignOption; }\r\n  public get decimalSeparator(): string { return this.parent.decimalSeparator; }\r\n  public get thousandSeparator(): string { return this.parent.thousandSeparator; }\r\n  public get uomSeparator(): string { return this.parent.uomSeparator; }\r\n  public get stationSeparator(): string { return this.parent.stationSeparator; }\r\n  public get stationOffsetSize(): number | undefined { return this.parent.stationOffsetSize; }\r\n  public get formatTraits(): FormatTraits { return this.parent.formatTraits; }\r\n  public get spacer(): string | undefined { return this.parent.spacer; }\r\n  public get includeZero(): boolean | undefined { return this.parent.includeZero; }\r\n\r\n  public hasFormatTrait(formatTrait: FormatTraits) {\r\n    return (this.parent.formatTraits & formatTrait) === formatTrait;\r\n  }\r\n\r\n  /** Returns the format string of this override in the Xml full name format.\r\n   * @alpha\r\n   */\r\n  public fullNameXml(koqSchema: Schema): string {\r\n    let fullName = XmlSerializationUtils.createXmlTypedName(koqSchema, this.parent.schema, this.parent.name);\r\n\r\n    if (undefined !== this.precision)\r\n      fullName += `(${this.precision.toString()})`;\r\n\r\n    if (undefined === this._units)\r\n      return fullName;\r\n    for (const [unit, unitLabel] of this._units) {\r\n      fullName += \"[\";\r\n      fullName += XmlSerializationUtils.createXmlTypedName(koqSchema, unit.schema, unit.name);\r\n      fullName += `|${unitLabel}]`;\r\n    }\r\n    return fullName;\r\n  }\r\n\r\n  /**\r\n   * Creates a valid OverrideFormat fullName from the parent Format and overridden units.\r\n   * @param parent The parent Format.\r\n   * @param unitAndLabels The overridden unit and labels collection.\r\n   */\r\n  public static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string {\r\n    let fullName = parent.fullName;\r\n\r\n    if (precision)\r\n      fullName += `(${precision.toString()})`;\r\n\r\n    if (undefined === unitAndLabels)\r\n      return fullName;\r\n    for (const [unit, unitLabel] of unitAndLabels)\r\n      if (undefined === unitLabel)\r\n        fullName += `[${unit.fullName}]`;\r\n      else\r\n        fullName += `[${unit.fullName}|${unitLabel}]`;\r\n    return fullName;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public static isOverrideFormat(object: any): object is OverrideFormat {\r\n    const overrideFormat = object as OverrideFormat;\r\n\r\n    return overrideFormat !== undefined && overrideFormat.name !== undefined && overrideFormat.parent !== undefined &&\r\n             overrideFormat.parent.schemaItemType === SchemaItemType.Format;\r\n  }\r\n}\r\n"]}

package/lib/cjs/Metadata/Unit.d.ts

@@ -31,6 +31,10 @@ export declare class Unit extends SchemaItem {
      * @alpha
      */
     static areCompatible(unitA: Unit, unitB: Unit): Promise<boolean>;
+    /**
+     * @alpha
+     */
+    static isUnit(object: any): object is Unit;
     /**
      * Save this Unit's properties to an object for serializing to JSON.
      * @param standalone Serialization includes only this object (as opposed to the full schema).

package/lib/cjs/Metadata/Unit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Unit.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Unit.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAG3E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;;;GAIG;AACH,qBAAa,IAAK,SAAQ,UAAU;IAClC,SAAyB,cAAc,EAAG,cAAc,CAAC,IAAI,CAAC;IAC9D,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IASxC,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,MAAM,CAA6B;IAC5D,IAAW,SAAS,IAAI,MAAM,CAA4B;IAC1D,IAAW,MAAM,IAAI,MAAM,CAAyB;IACpD,IAAW,WAAW,IAAI,MAAM,CAA8B;IAE9D;;;OAGG;WACiB,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7E;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,SAAS;IAcrG,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBlD,YAAY,CAAC,SAAS,EAAE,SAAS;IA8C3B,QAAQ,CAAC,SAAS,EAAE,SAAS;IAInD;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAI9D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAI9D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,MAAM;CAGjD;AACD;;;GAGG;AACH,8BAAsB,WAAY,SAAQ,IAAI;aACnB,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9D,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9D,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAChD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"Unit.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Unit.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAG3E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;;;GAIG;AACH,qBAAa,IAAK,SAAQ,UAAU;IAClC,SAAyB,cAAc,EAAG,cAAc,CAAC,IAAI,CAAC;IAC9D,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC7C,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IASxC,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IACtF,IAAW,UAAU,IAAI,MAAM,CAA6B;IAC5D,IAAW,SAAS,IAAI,MAAM,CAA4B;IAC1D,IAAW,MAAM,IAAI,MAAM,CAAyB;IACpD,IAAW,WAAW,IAAI,MAAM,CAA8B;IAE9D;;;OAGG;WACiB,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7E;;OAEG;WACW,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,IAAI;IAIjD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,SAAS;IAcrG,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBlD,YAAY,CAAC,SAAS,EAAE,SAAS;IA8C3B,QAAQ,CAAC,SAAS,EAAE,SAAS;IAInD;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAI9D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,oBAAoB;IAI9D;;;OAGG;cACa,aAAa,CAAC,UAAU,EAAE,MAAM;CAGjD;AACD;;;GAGG;AACH,8BAAsB,WAAY,SAAQ,IAAI;aACnB,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9D,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;aAC9D,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;aAChD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/cjs/Metadata/Unit.js

@@ -44,6 +44,12 @@ class Unit extends SchemaItem_1.SchemaItem {
             return false;
         return true;
     }
+    /**
+     * @alpha
+     */
+    static isUnit(object) {
+        return SchemaItem_1.SchemaItem.isSchemaItem(object) && object.schemaItemType === ECObjects_1.SchemaItemType.Unit;
+    }
     /**
      * Save this Unit's properties to an object for serializing to JSON.
      * @param standalone Serialization includes only this object (as opposed to the full schema).

package/lib/cjs/Metadata/Unit.js.map

@@ -1 +1 @@
-{"version":3,"file":"Unit.js","sourceRoot":"","sources":["../../../src/Metadata/Unit.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4D;AAE5D,oFAAiF;AACjF,4CAA8C;AAC9C,4CAA+D;AAK/D,6CAA0C;AAG1C;;;;GAIG;AACH,MAAa,IAAK,SAAQ,uBAAU;IASlC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,0BAAc,CAAC,IAAI,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACrB,CAAC;IAED,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC1D,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAE9D;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,KAAW,EAAE,KAAW;QACxD,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;QAC/C,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;QAE/C,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC;YAC3F,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACxC,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;YAChC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAClC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEjD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE;YAC5B,MAAM,cAAc,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjH,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;SACxD;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE;YAC5B,MAAM,cAAc,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjH,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;SACxD;QAED,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrE,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,SAAoB;QAC/C,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAE9B,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACtH,IAAI,CAAC,WAAW,GAAG,IAAI,wCAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAa,uBAAuB,CAAC,CAAC;YACjF,IAAI,SAAS,KAAK,MAAM;gBACtB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACtH,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEL,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACtH,IAAI,CAAC,WAAW,GAAG,IAAI,wCAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAa,uBAAuB,CAAC,CAAC;YACrF,IAAI,SAAS,KAAK,UAAU;gBAC1B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACtH,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YAClG,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,YAAY,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACrH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC;QAE1C,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE;YACrC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;gBACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,SAAS,CAAC;SACzC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,WAAW,EAAE;YACvC,IAAI,SAAS,CAAC,WAAW,KAAK,IAAI,CAAC,YAAY;gBAC7C,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC;SAC7C;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE;YAClC,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO;gBACnC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;SACnC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,SAAoB;QACjD,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;CACF;AA1JD,oBA0JC;AACD;;;GAGG;AACH,MAAsB,WAAY,SAAQ,IAAI;CAK7C;AALD,kCAKC","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/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { DelayedPromiseWithProps } from \"../DelayedPromise\";\r\nimport { UnitProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedPhenomenon, LazyLoadedUnitSystem } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { Phenomenon } from \"./Phenomenon\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { UnitSystem } from \"./UnitSystem\";\r\n\r\n/**\r\n * An abstract class that adds the ability to define Units and everything that goes with them, within an ECSchema as a\r\n * first-class concept is to allow the iModel to not be dependent on any hard-coded Units\r\n * @beta\r\n */\r\nexport class Unit extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.Unit; // eslint-disable-line\r\n  protected _phenomenon?: LazyLoadedPhenomenon;\r\n  protected _unitSystem?: LazyLoadedUnitSystem;\r\n  protected _definition: string;\r\n  protected _numerator: number;\r\n  protected _denominator: number;\r\n  protected _offset: number;\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.Unit;\r\n    this._definition = \"\";\r\n    this._numerator = 1.0;\r\n    this._denominator = 1.0;\r\n    this._offset = 0.0;\r\n  }\r\n\r\n  public get phenomenon(): LazyLoadedPhenomenon | undefined { return this._phenomenon; }\r\n  public get unitSystem(): LazyLoadedUnitSystem | undefined { return this._unitSystem; }\r\n  public get definition(): string { return this._definition; }\r\n  public get numerator(): number { return this._numerator; }\r\n  public get offset(): number { return this._offset; }\r\n  public get denominator(): number { return this._denominator; }\r\n\r\n  /**\r\n   * Returns true if a conversion can be calculated between the input units\r\n   * @alpha\r\n   */\r\n  public static async areCompatible(unitA: Unit, unitB: Unit): Promise<boolean> {\r\n    const unitAPhenomenon = await unitA.phenomenon;\r\n    const unitBPhenomenon = await unitB.phenomenon;\r\n\r\n    if (!unitAPhenomenon || !unitBPhenomenon || !unitAPhenomenon.key.matches(unitBPhenomenon.key))\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * Save this Unit's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): UnitProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.phenomenon = this.phenomenon!.fullName;\r\n    schemaJson.unitSystem = this.unitSystem!.fullName;\r\n    schemaJson.definition = this.definition;\r\n    if (undefined !== this.numerator)\r\n      schemaJson.numerator = this.numerator;\r\n    if (undefined !== this.denominator)\r\n      schemaJson.denominator = this.denominator;\r\n    if (undefined !== this.offset)\r\n      schemaJson.offset = this.offset;\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n\r\n    const phenomenon = await this.phenomenon;\r\n    if (undefined !== phenomenon) {\r\n      const phenomenonName = XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);\r\n      itemElement.setAttribute(\"phenomenon\", phenomenonName);\r\n    }\r\n\r\n    const unitSystem = await this.unitSystem;\r\n    if (undefined !== unitSystem) {\r\n      const unitSystemName = XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);\r\n      itemElement.setAttribute(\"unitSystem\", unitSystemName);\r\n    }\r\n\r\n    itemElement.setAttribute(\"definition\", this.definition);\r\n    itemElement.setAttribute(\"numerator\", this.numerator.toString());\r\n    itemElement.setAttribute(\"denominator\", this.denominator.toString());\r\n    itemElement.setAttribute(\"offset\", this.offset.toString());\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(unitProps: UnitProps) {\r\n    super.fromJSONSync(unitProps);\r\n\r\n    const phenomenonSchemaItemKey = this.schema.getSchemaItemKey(unitProps.phenomenon);\r\n    if (!phenomenonSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);\r\n    this._phenomenon = new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(phenomenonSchemaItemKey,\r\n      async () => {\r\n        const phenom = await this.schema.lookupItem<Phenomenon>(phenomenonSchemaItemKey);\r\n        if (undefined === phenom)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);\r\n        return phenom;\r\n      });\r\n\r\n    const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(unitProps.unitSystem);\r\n    if (!unitSystemSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);\r\n    this._unitSystem = new DelayedPromiseWithProps<SchemaItemKey, UnitSystem>(unitSystemSchemaItemKey,\r\n      async () => {\r\n        const unitSystem = await this.schema.lookupItem<UnitSystem>(unitSystemSchemaItemKey);\r\n        if (undefined === unitSystem)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);\r\n        return unitSystem;\r\n      });\r\n\r\n    if (this._definition !== \"\" && unitProps.definition.toLowerCase() !== this._definition.toLowerCase())\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Unit ${this.name} has an invalid 'definition' attribute.`);\r\n    else if (this._definition === \"\")\r\n      this._definition = unitProps.definition;\r\n\r\n    if (undefined !== unitProps.numerator) {\r\n      if (unitProps.numerator !== this._numerator)\r\n        this._numerator = unitProps.numerator;\r\n    }\r\n\r\n    if (undefined !== unitProps.denominator) {\r\n      if (unitProps.denominator !== this._denominator)\r\n        this._denominator = unitProps.denominator;\r\n    }\r\n\r\n    if (undefined !== unitProps.offset) {\r\n      if (unitProps.offset !== this._offset)\r\n        this._offset = unitProps.offset;\r\n    }\r\n  }\r\n\r\n  public override async fromJSON(unitProps: UnitProps) {\r\n    this.fromJSONSync(unitProps);\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setPhenomenon(phenomenon: LazyLoadedPhenomenon) {\r\n    this._phenomenon = phenomenon;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setUnitSystem(unitSystem: LazyLoadedUnitSystem) {\r\n    this._unitSystem = unitSystem;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setDefinition(definition: string) {\r\n    this._definition = definition;\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableUnit extends Unit {\r\n  public abstract override setPhenomenon(phenomenon: LazyLoadedPhenomenon): Promise<void>;\r\n  public abstract override setUnitSystem(unitSystem: LazyLoadedUnitSystem): Promise<void>;\r\n  public abstract override setDefinition(definition: string): Promise<void>;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}
+{"version":3,"file":"Unit.js","sourceRoot":"","sources":["../../../src/Metadata/Unit.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4D;AAE5D,oFAAiF;AACjF,4CAA8C;AAC9C,4CAA+D;AAK/D,6CAA0C;AAG1C;;;;GAIG;AACH,MAAa,IAAK,SAAQ,uBAAU;IASlC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,0BAAc,CAAC,IAAI,CAAC;QAC1C,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;IACrB,CAAC;IAED,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,IAAW,SAAS,KAAa,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC1D,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAE9D;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,KAAW,EAAE,KAAW;QACxD,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;QAC/C,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC;QAE/C,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC;YAC3F,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,MAAW;QAC9B,OAAO,uBAAU,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,IAAI,CAAC;IAC1F,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACxC,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACxC,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;YAChC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAClC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEjD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE;YAC5B,MAAM,cAAc,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjH,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;SACxD;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE;YAC5B,MAAM,cAAc,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACjH,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;SACxD;QAED,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrE,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE3D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,SAAoB;QAC/C,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAE9B,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACtH,IAAI,CAAC,WAAW,GAAG,IAAI,wCAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAa,uBAAuB,CAAC,CAAC;YACjF,IAAI,SAAS,KAAK,MAAM;gBACtB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACtH,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEL,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACtH,IAAI,CAAC,WAAW,GAAG,IAAI,wCAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAa,uBAAuB,CAAC,CAAC;YACrF,IAAI,SAAS,KAAK,UAAU;gBAC1B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACtH,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;QAEL,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE,IAAI,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;YAClG,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,YAAY,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACrH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC;QAE1C,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE;YACrC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;gBACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,SAAS,CAAC;SACzC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,WAAW,EAAE;YACvC,IAAI,SAAS,CAAC,WAAW,KAAK,IAAI,CAAC,YAAY;gBAC7C,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC;SAC7C;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE;YAClC,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO;gBACnC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;SACnC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,SAAoB;QACjD,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;CACF;AAjKD,oBAiKC;AACD;;;GAGG;AACH,MAAsB,WAAY,SAAQ,IAAI;CAK7C;AALD,kCAKC","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/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { DelayedPromiseWithProps } from \"../DelayedPromise\";\r\nimport { UnitProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedPhenomenon, LazyLoadedUnitSystem } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { Phenomenon } from \"./Phenomenon\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { UnitSystem } from \"./UnitSystem\";\r\n\r\n/**\r\n * An abstract class that adds the ability to define Units and everything that goes with them, within an ECSchema as a\r\n * first-class concept is to allow the iModel to not be dependent on any hard-coded Units\r\n * @beta\r\n */\r\nexport class Unit extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.Unit; // eslint-disable-line\r\n  protected _phenomenon?: LazyLoadedPhenomenon;\r\n  protected _unitSystem?: LazyLoadedUnitSystem;\r\n  protected _definition: string;\r\n  protected _numerator: number;\r\n  protected _denominator: number;\r\n  protected _offset: number;\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.Unit;\r\n    this._definition = \"\";\r\n    this._numerator = 1.0;\r\n    this._denominator = 1.0;\r\n    this._offset = 0.0;\r\n  }\r\n\r\n  public get phenomenon(): LazyLoadedPhenomenon | undefined { return this._phenomenon; }\r\n  public get unitSystem(): LazyLoadedUnitSystem | undefined { return this._unitSystem; }\r\n  public get definition(): string { return this._definition; }\r\n  public get numerator(): number { return this._numerator; }\r\n  public get offset(): number { return this._offset; }\r\n  public get denominator(): number { return this._denominator; }\r\n\r\n  /**\r\n   * Returns true if a conversion can be calculated between the input units\r\n   * @alpha\r\n   */\r\n  public static async areCompatible(unitA: Unit, unitB: Unit): Promise<boolean> {\r\n    const unitAPhenomenon = await unitA.phenomenon;\r\n    const unitBPhenomenon = await unitB.phenomenon;\r\n\r\n    if (!unitAPhenomenon || !unitBPhenomenon || !unitAPhenomenon.key.matches(unitBPhenomenon.key))\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   */\r\n  public static isUnit(object: any): object is Unit {\r\n    return SchemaItem.isSchemaItem(object) && object.schemaItemType === SchemaItemType.Unit;\r\n  }\r\n\r\n  /**\r\n   * Save this Unit's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): UnitProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.phenomenon = this.phenomenon!.fullName;\r\n    schemaJson.unitSystem = this.unitSystem!.fullName;\r\n    schemaJson.definition = this.definition;\r\n    if (undefined !== this.numerator)\r\n      schemaJson.numerator = this.numerator;\r\n    if (undefined !== this.denominator)\r\n      schemaJson.denominator = this.denominator;\r\n    if (undefined !== this.offset)\r\n      schemaJson.offset = this.offset;\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n\r\n    const phenomenon = await this.phenomenon;\r\n    if (undefined !== phenomenon) {\r\n      const phenomenonName = XmlSerializationUtils.createXmlTypedName(this.schema, phenomenon.schema, phenomenon.name);\r\n      itemElement.setAttribute(\"phenomenon\", phenomenonName);\r\n    }\r\n\r\n    const unitSystem = await this.unitSystem;\r\n    if (undefined !== unitSystem) {\r\n      const unitSystemName = XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);\r\n      itemElement.setAttribute(\"unitSystem\", unitSystemName);\r\n    }\r\n\r\n    itemElement.setAttribute(\"definition\", this.definition);\r\n    itemElement.setAttribute(\"numerator\", this.numerator.toString());\r\n    itemElement.setAttribute(\"denominator\", this.denominator.toString());\r\n    itemElement.setAttribute(\"offset\", this.offset.toString());\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(unitProps: UnitProps) {\r\n    super.fromJSONSync(unitProps);\r\n\r\n    const phenomenonSchemaItemKey = this.schema.getSchemaItemKey(unitProps.phenomenon);\r\n    if (!phenomenonSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);\r\n    this._phenomenon = new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(phenomenonSchemaItemKey,\r\n      async () => {\r\n        const phenom = await this.schema.lookupItem<Phenomenon>(phenomenonSchemaItemKey);\r\n        if (undefined === phenom)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);\r\n        return phenom;\r\n      });\r\n\r\n    const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(unitProps.unitSystem);\r\n    if (!unitSystemSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);\r\n    this._unitSystem = new DelayedPromiseWithProps<SchemaItemKey, UnitSystem>(unitSystemSchemaItemKey,\r\n      async () => {\r\n        const unitSystem = await this.schema.lookupItem<UnitSystem>(unitSystemSchemaItemKey);\r\n        if (undefined === unitSystem)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);\r\n        return unitSystem;\r\n      });\r\n\r\n    if (this._definition !== \"\" && unitProps.definition.toLowerCase() !== this._definition.toLowerCase())\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Unit ${this.name} has an invalid 'definition' attribute.`);\r\n    else if (this._definition === \"\")\r\n      this._definition = unitProps.definition;\r\n\r\n    if (undefined !== unitProps.numerator) {\r\n      if (unitProps.numerator !== this._numerator)\r\n        this._numerator = unitProps.numerator;\r\n    }\r\n\r\n    if (undefined !== unitProps.denominator) {\r\n      if (unitProps.denominator !== this._denominator)\r\n        this._denominator = unitProps.denominator;\r\n    }\r\n\r\n    if (undefined !== unitProps.offset) {\r\n      if (unitProps.offset !== this._offset)\r\n        this._offset = unitProps.offset;\r\n    }\r\n  }\r\n\r\n  public override async fromJSON(unitProps: UnitProps) {\r\n    this.fromJSONSync(unitProps);\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setPhenomenon(phenomenon: LazyLoadedPhenomenon) {\r\n    this._phenomenon = phenomenon;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setUnitSystem(unitSystem: LazyLoadedUnitSystem) {\r\n    this._unitSystem = unitSystem;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected async setDefinition(definition: string) {\r\n    this._definition = definition;\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableUnit extends Unit {\r\n  public abstract override setPhenomenon(phenomenon: LazyLoadedPhenomenon): Promise<void>;\r\n  public abstract override setUnitSystem(unitSystem: LazyLoadedUnitSystem): Promise<void>;\r\n  public abstract override setDefinition(definition: string): Promise<void>;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

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

@@ -2,12 +2,11 @@ import { Constant } from "../Metadata/Constant";
 import { Unit } from "../Metadata/Unit";
 /**
  * Class used for storing calculated conversion between two Units [[UnitConverter.calculateConversion]] and converting values from one Unit to another [[UnitConverter.evaluate]]
- * @alpha
+ * @internal
  */
 export declare class UnitConversion {
     readonly factor: number;
     readonly offset: number;
-    /** @internal */
     constructor(factor?: number, offset?: number);
     /**
      * Converts x using UnitConversion

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

@@ -1 +1 @@
-{"version":3,"file":"UnitConversion.d.ts","sourceRoot":"","sources":["../../../src/UnitConversion/UnitConversion.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC;;;GAGG;AACH,qBAAa,cAAc;aAEG,MAAM,EAAE,MAAM;aAAwB,MAAM,EAAE,MAAM;IADhF,gBAAgB;gBACY,MAAM,GAAE,MAAY,EAAkB,MAAM,GAAE,MAAY;IAEtF;;;;OAIG;IACI,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAIlC;;;OAGG;IACI,OAAO,IAAI,cAAc;IAKhC;;;;OAIG;IACI,OAAO,CAAC,UAAU,EAAE,cAAc,GAAG,cAAc;IAO1D;;;OAGG;IACI,QAAQ,CAAC,UAAU,EAAE,cAAc,GAAG,cAAc;IAO3D;;;OAGG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc;IAY3C,gBAAgB;IAChB,OAAc,QAAQ,iBAAwB;IAE9C;;;OAGG;WACW,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,GAAG,cAAc;CAM1D"}
+{"version":3,"file":"UnitConversion.d.ts","sourceRoot":"","sources":["../../../src/UnitConversion/UnitConversion.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC;;;GAGG;AACH,qBAAa,cAAc;aACG,MAAM,EAAE,MAAM;aAAwB,MAAM,EAAE,MAAM;gBAApD,MAAM,GAAE,MAAY,EAAkB,MAAM,GAAE,MAAY;IAEtF;;;;OAIG;IACI,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAIlC;;;OAGG;IACI,OAAO,IAAI,cAAc;IAKhC;;;;OAIG;IACI,OAAO,CAAC,UAAU,EAAE,cAAc,GAAG,cAAc;IAO1D;;;OAGG;IACI,QAAQ,CAAC,UAAU,EAAE,cAAc,GAAG,cAAc;IAO3D;;;OAGG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc;IAY3C,gBAAgB;IAChB,OAAc,QAAQ,iBAAwB;IAE9C;;;OAGG;WACW,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,GAAG,cAAc;CAM1D"}

package/lib/cjs/UnitConversion/UnitConversion.js

@@ -9,10 +9,9 @@ const almostEqual = require("almost-equal");
 const ECObjects_1 = require("../ECObjects");
 /**
  * Class used for storing calculated conversion between two Units [[UnitConverter.calculateConversion]] and converting values from one Unit to another [[UnitConverter.evaluate]]
- * @alpha
+ * @internal
  */
 class UnitConversion {
-    /** @internal */
     constructor(factor = 1.0, offset = 0.0) {
         this.factor = factor;
         this.offset = offset;

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

@@ -1 +1 @@
-{"version":3,"file":"UnitConversion.js","sourceRoot":"","sources":["../../../src/UnitConversion/UnitConversion.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,4CAA4C;AAG5C,4CAA8C;AAE9C;;;GAGG;AACH,MAAa,cAAc;IACzB,gBAAgB;IAChB,YAA4B,SAAiB,GAAG,EAAkB,SAAiB,GAAG;QAA1D,WAAM,GAAN,MAAM,CAAc;QAAkB,WAAM,GAAN,MAAM,CAAc;IAAG,CAAC;IAE1F;;;;OAIG;IACI,QAAQ,CAAC,CAAS;QACvB,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,MAAM,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QACxC,OAAO,IAAI,cAAc,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,UAA0B;QACvC,OAAO,IAAI,cAAc,CACvB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,EAC/B,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CACpD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,UAA0B;QACxC,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC;YACtE,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAElE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAa;QACxB,IAAI,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC;YACzB,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACjD,IAAI,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC;YAC9B,OAAO,IAAI,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAEtC,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC;YAC/B,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,GAAG,CAAC,CAAC;QAEvD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,IAAI,CAAC,IAAqB;QACtC,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,IAAI;YAC7C,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE7E,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACpE,CAAC;;AAzEH,wCA0EC;AAbC,gBAAgB;AACF,uBAAQ,GAAG,IAAI,cAAc,EAAE,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\nimport * as almostEqual from \"almost-equal\";\r\nimport { Constant } from \"../Metadata/Constant\";\r\nimport { Unit } from \"../Metadata/Unit\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\n\r\n/**\r\n * Class used for storing calculated conversion between two Units [[UnitConverter.calculateConversion]] and converting values from one Unit to another [[UnitConverter.evaluate]]\r\n * @alpha\r\n */\r\nexport class UnitConversion {\r\n  /** @internal */\r\n  constructor(public readonly factor: number = 1.0, public readonly offset: number = 0.0) {}\r\n\r\n  /**\r\n   * Converts x using UnitConversion\r\n   * @param x Input magnitude to be converted\r\n   * @returns Output magnitude after conversion\r\n   */\r\n  public evaluate(x: number): number {\r\n    return this.factor * x + this.offset;\r\n  }\r\n\r\n  /**\r\n   * Used to invert source's UnitConversion so that it can be composed with target's UnitConversion cleanly\r\n   * @internal\r\n   */\r\n  public inverse(): UnitConversion {\r\n    const inverseFactor = 1.0 / this.factor;\r\n    return new UnitConversion(inverseFactor, -this.offset * inverseFactor);\r\n  }\r\n\r\n  /**\r\n   * Combines two UnitConversions\r\n   * Used to combine source's UnitConversion and target's UnitConversion for a final UnitConversion that can be evaluated\r\n   * @internal\r\n   */\r\n  public compose(conversion: UnitConversion): UnitConversion {\r\n    return new UnitConversion(\r\n      this.factor * conversion.factor,\r\n      conversion.factor * this.offset + conversion.offset\r\n    );\r\n  }\r\n\r\n  /**\r\n   * Multiples two UnitConversions together to calculate factor during reducing\r\n   * @internal\r\n   */\r\n  public multiply(conversion: UnitConversion): UnitConversion {\r\n    if (almostEqual(conversion.offset, 0.0) && almostEqual(this.offset, 0.0))\r\n      return new UnitConversion(this.factor * conversion.factor, 0.0);\r\n\r\n    throw new Error(\"Cannot multiply two maps with non-zero offsets\");\r\n  }\r\n\r\n  /**\r\n   * Raise UnitConversion's factor with power exponent to calculate factor during reducing\r\n   * @internal\r\n   */\r\n  public raise(power: number): UnitConversion {\r\n    if (almostEqual(power, 1.0))\r\n      return new UnitConversion(this.factor, this.offset);\r\n    else if (almostEqual(power, 0.0))\r\n      return new UnitConversion(1.0, 0.0);\r\n\r\n    if (almostEqual(this.offset, 0.0))\r\n      return new UnitConversion(this.factor ** power, 0.0);\r\n\r\n    throw new Error(\"Cannot raise map with non-zero offset\");\r\n  }\r\n\r\n  /** @internal */\r\n  public static identity = new UnitConversion();\r\n\r\n  /**\r\n   * Returns UnitConversion with unit's numerator and denominator in factor and unit's offset in offset for reducing\r\n   * @internal\r\n   */\r\n  public static from(unit: Unit | Constant): UnitConversion {\r\n    if (unit.schemaItemType === SchemaItemType.Unit)\r\n      return new UnitConversion(unit.denominator / unit.numerator, -unit.offset);\r\n\r\n    return new UnitConversion(unit.denominator / unit.numerator, 0.0);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"UnitConversion.js","sourceRoot":"","sources":["../../../src/UnitConversion/UnitConversion.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,4CAA4C;AAG5C,4CAA8C;AAE9C;;;GAGG;AACH,MAAa,cAAc;IACzB,YAA4B,SAAiB,GAAG,EAAkB,SAAiB,GAAG;QAA1D,WAAM,GAAN,MAAM,CAAc;QAAkB,WAAM,GAAN,MAAM,CAAc;IAAG,CAAC;IAE1F;;;;OAIG;IACI,QAAQ,CAAC,CAAS;QACvB,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,MAAM,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QACxC,OAAO,IAAI,cAAc,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,UAA0B;QACvC,OAAO,IAAI,cAAc,CACvB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,EAC/B,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CACpD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,UAA0B;QACxC,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC;YACtE,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAElE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAa;QACxB,IAAI,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC;YACzB,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACjD,IAAI,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC;YAC9B,OAAO,IAAI,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAEtC,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC;YAC/B,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,GAAG,CAAC,CAAC;QAEvD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,IAAI,CAAC,IAAqB;QACtC,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,IAAI;YAC7C,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE7E,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACpE,CAAC;;AAxEH,wCAyEC;AAbC,gBAAgB;AACF,uBAAQ,GAAG,IAAI,cAAc,EAAE,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\nimport * as almostEqual from \"almost-equal\";\r\nimport { Constant } from \"../Metadata/Constant\";\r\nimport { Unit } from \"../Metadata/Unit\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\n\r\n/**\r\n * Class used for storing calculated conversion between two Units [[UnitConverter.calculateConversion]] and converting values from one Unit to another [[UnitConverter.evaluate]]\r\n * @internal\r\n */\r\nexport class UnitConversion {\r\n  constructor(public readonly factor: number = 1.0, public readonly offset: number = 0.0) {}\r\n\r\n  /**\r\n   * Converts x using UnitConversion\r\n   * @param x Input magnitude to be converted\r\n   * @returns Output magnitude after conversion\r\n   */\r\n  public evaluate(x: number): number {\r\n    return this.factor * x + this.offset;\r\n  }\r\n\r\n  /**\r\n   * Used to invert source's UnitConversion so that it can be composed with target's UnitConversion cleanly\r\n   * @internal\r\n   */\r\n  public inverse(): UnitConversion {\r\n    const inverseFactor = 1.0 / this.factor;\r\n    return new UnitConversion(inverseFactor, -this.offset * inverseFactor);\r\n  }\r\n\r\n  /**\r\n   * Combines two UnitConversions\r\n   * Used to combine source's UnitConversion and target's UnitConversion for a final UnitConversion that can be evaluated\r\n   * @internal\r\n   */\r\n  public compose(conversion: UnitConversion): UnitConversion {\r\n    return new UnitConversion(\r\n      this.factor * conversion.factor,\r\n      conversion.factor * this.offset + conversion.offset\r\n    );\r\n  }\r\n\r\n  /**\r\n   * Multiples two UnitConversions together to calculate factor during reducing\r\n   * @internal\r\n   */\r\n  public multiply(conversion: UnitConversion): UnitConversion {\r\n    if (almostEqual(conversion.offset, 0.0) && almostEqual(this.offset, 0.0))\r\n      return new UnitConversion(this.factor * conversion.factor, 0.0);\r\n\r\n    throw new Error(\"Cannot multiply two maps with non-zero offsets\");\r\n  }\r\n\r\n  /**\r\n   * Raise UnitConversion's factor with power exponent to calculate factor during reducing\r\n   * @internal\r\n   */\r\n  public raise(power: number): UnitConversion {\r\n    if (almostEqual(power, 1.0))\r\n      return new UnitConversion(this.factor, this.offset);\r\n    else if (almostEqual(power, 0.0))\r\n      return new UnitConversion(1.0, 0.0);\r\n\r\n    if (almostEqual(this.offset, 0.0))\r\n      return new UnitConversion(this.factor ** power, 0.0);\r\n\r\n    throw new Error(\"Cannot raise map with non-zero offset\");\r\n  }\r\n\r\n  /** @internal */\r\n  public static identity = new UnitConversion();\r\n\r\n  /**\r\n   * Returns UnitConversion with unit's numerator and denominator in factor and unit's offset in offset for reducing\r\n   * @internal\r\n   */\r\n  public static from(unit: Unit | Constant): UnitConversion {\r\n    if (unit.schemaItemType === SchemaItemType.Unit)\r\n      return new UnitConversion(unit.denominator / unit.numerator, -unit.offset);\r\n\r\n    return new UnitConversion(unit.denominator / unit.numerator, 0.0);\r\n  }\r\n}\r\n"]}

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

@@ -2,7 +2,7 @@ import { SchemaContext } from "../Context";
 import { UnitConversion } from "./UnitConversion";
 /**
  * Class constructed with SchemaContext and used to calculate [[UnitConversion]] between Units
- * @alpha
+ * @internal
  */
 export declare class UnitConverter {
     private readonly _context;

package/lib/cjs/UnitConversion/UnitConverter.js

@@ -13,7 +13,7 @@ const UnitConversion_1 = require("./UnitConversion");
 const UnitTree_1 = require("./UnitTree");
 /**
  * Class constructed with SchemaContext and used to calculate [[UnitConversion]] between Units
- * @alpha
+ * @internal
  */
 class UnitConverter {
     /**

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

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

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

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

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

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

package/lib/cjs/UnitProvider/SchemaUnitProvider.js

@@ -0,0 +1,237 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaUnitProvider = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const core_bentley_1 = require("@itwin/core-bentley");
+const Context_1 = require("../Context");
+const SchemaItem_1 = require("../Metadata/SchemaItem");
+const SchemaKey_1 = require("../SchemaKey");
+const Unit_1 = require("../Metadata/Unit");
+const ECObjects_1 = require("../ECObjects");
+const UnitConverter_1 = require("../UnitConversion/UnitConverter");
+/**
+ * Class used to find Units in SchemaContext by attributes such as Phenomenon and DisplayLabel.
+ * @alpha
+ */
+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 Context_1.SchemaContext) {
+            this._context = contextOrLocater;
+        }
+        else {
+            this._context = new Context_1.SchemaContext();
+            this._context.addLocater(contextOrLocater);
+        }
+        this._unitConverter = new UnitConverter_1.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_1.SchemaItem.parseFullName(phenomenon);
+        const schemaKey = new SchemaKey_1.SchemaKey(schemaName);
+        const schema = await this._context.getSchema(schemaKey);
+        if (!schema) {
+            throw new core_bentley_1.BentleyError(core_bentley_1.BentleyStatus.ERROR, "Cannot find schema for phenomenon", () => {
+                return { phenomenon, schema: schemaName };
+            });
+        }
+        const itemKey = new SchemaKey_1.SchemaItemKey(schemaItemName, schema.schemaKey);
+        const phenom = await this._context.getSchemaItem(itemKey);
+        if (!phenom)
+            throw new core_bentley_1.BentleyError(core_bentley_1.BentleyStatus.ERROR, "Cannot find schema item/phenomenon", () => {
+                return { item: schemaItemName, schema: schemaName };
+            });
+        if (phenom.schemaItemType !== ECObjects_1.SchemaItemType.Phenomenon)
+            throw new core_bentley_1.BentleyError(core_bentley_1.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_1.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 core_bentley_1.BentleyError(core_bentley_1.BentleyStatus.ERROR, "Cannot find unit with label", () => {
+                return { unitLabel };
+            });
+        }
+        return this.getUnitsProps(foundUnit);
+    }
+    /**
+     * Gets the @itwin/core-quantity UnitConversion for the given fromUnit and toUnit.
+     * @param fromUnit The UnitProps of the 'from' unit.
+     * @param toUnit The UnitProps of the 'to' unit.
+     * @returns The UnitConversion 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_1.SchemaItem.parseFullName(unitName);
+        const schemaKey = new SchemaKey_1.SchemaKey(schemaName);
+        const schema = await this._context.getSchema(schemaKey);
+        if (!schema) {
+            throw new core_bentley_1.BentleyError(core_bentley_1.BentleyStatus.ERROR, "Cannot find schema for unit", () => {
+                return { schema: schemaName, unit: unitName };
+            });
+        }
+        const itemKey = new SchemaKey_1.SchemaItemKey(schemaItemName, schema.schemaKey);
+        const item = await this._context.getSchemaItem(itemKey);
+        if (!item)
+            throw new core_bentley_1.BentleyError(core_bentley_1.BentleyStatus.ERROR, "Cannot find schema item/unit", () => {
+                return { item: schemaItemName, schema: schemaName };
+            });
+        if (item.schemaItemType === ECObjects_1.SchemaItemType.Unit)
+            return item;
+        throw new core_bentley_1.BentleyError(core_bentley_1.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) {
+        var _a;
+        return {
+            name: unit.fullName,
+            label: (_a = unit.label) !== null && _a !== void 0 ? _a : "",
+            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) {
+        var _a;
+        const schemaItems = this._context.getSchemaItems();
+        let { value, done } = schemaItems.next();
+        while (!done) {
+            if (Unit_1.Unit.isUnit(value) && ((_a = value.label) === null || _a === void 0 ? void 0 : _a.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 core_bentley_1.BentleyError(core_bentley_1.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 core_bentley_1.BentleyError(core_bentley_1.BentleyStatus.ERROR, "Cannot find unit with alternate display label", () => {
+            return { altDisplayLabel };
+        });
+    }
+}
+exports.SchemaUnitProvider = SchemaUnitProvider;
+//# sourceMappingURL=SchemaUnitProvider.js.map