@itwin/ecschema-metadata 5.0.0-dev.99 → 5.1.0-dev.1

package/lib/cjs/Metadata/Unit.js

@@ -18,10 +18,11 @@ const UnitSystem_1 = require("./UnitSystem");
 /**
  * An abstract class that adds the ability to define Units and everything that goes with them, within an ECSchema as a
  * first-class concept is to allow the iModel to not be dependent on any hard-coded Units
- * @beta
+ * @public @preview
  */
 class Unit extends SchemaItem_1.SchemaItem {
     schemaItemType = Unit.schemaItemType;
+    /** @internal */
     static get schemaItemType() { return ECObjects_1.SchemaItemType.Unit; }
     _phenomenon;
     _unitSystem;
@@ -29,6 +30,7 @@ class Unit extends SchemaItem_1.SchemaItem {
     _numerator;
     _denominator;
     _offset;
+    /** @internal */
     constructor(schema, name) {
         super(schema, name);
         this._definition = "";
@@ -54,10 +56,14 @@ class Unit extends SchemaItem_1.SchemaItem {
         return true;
     }
     /**
-     * @alpha
+     * Type guard to check if the SchemaItem is of type Unit.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a Unit, false otherwise.
      */
-    static isUnit(object) {
-        return SchemaItem_1.SchemaItem.isSchemaItem(object) && object.schemaItemType === ECObjects_1.SchemaItemType.Unit;
+    static isUnit(item) {
+        if (item && item.schemaItemType === ECObjects_1.SchemaItemType.Unit)
+            return true;
+        return false;
     }
     /**
      * Save this Unit's properties to an object for serializing to JSON.
@@ -103,24 +109,24 @@ class Unit extends SchemaItem_1.SchemaItem {
         super.fromJSONSync(unitProps);
         const phenomenonSchemaItemKey = this.schema.getSchemaItemKey(unitProps.phenomenon);
         if (!phenomenonSchemaItemKey)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
         this._phenomenon = new DelayedPromise_1.DelayedPromiseWithProps(phenomenonSchemaItemKey, async () => {
             const phenom = await this.schema.lookupItem(phenomenonSchemaItemKey, Phenomenon_1.Phenomenon);
             if (undefined === phenom)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the phenomenon ${unitProps.phenomenon}.`);
             return phenom;
         });
         const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(unitProps.unitSystem);
         if (!unitSystemSchemaItemKey)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
         this._unitSystem = new DelayedPromise_1.DelayedPromiseWithProps(unitSystemSchemaItemKey, async () => {
             const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey, UnitSystem_1.UnitSystem);
             if (undefined === unitSystem)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the unitSystem ${unitProps.unitSystem}.`);
             return unitSystem;
         });
         if (this._definition !== "" && unitProps.definition.toLowerCase() !== this._definition.toLowerCase())
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Unit ${this.name} has an invalid 'definition' attribute.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Unit ${this.name} has an invalid 'definition' attribute.`);
         else if (this._definition === "")
             this._definition = unitProps.definition;
         if (undefined !== unitProps.numerator) {
@@ -139,24 +145,15 @@ class Unit extends SchemaItem_1.SchemaItem {
     async fromJSON(unitProps) {
         this.fromJSONSync(unitProps);
     }
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
+    /** @internal */
     async setPhenomenon(phenomenon) {
         this._phenomenon = phenomenon;
     }
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
+    /** @internal */
     async setUnitSystem(unitSystem) {
         this._unitSystem = unitSystem;
     }
-    /**
-     * @alpha
-     * Used for schema editing.
-     */
+    /** @internal */
     async setDefinition(definition) {
         this._definition = definition;
     }
@@ -164,10 +161,11 @@ class Unit extends SchemaItem_1.SchemaItem {
      * Type assertion to check if the SchemaItem is of type Unit.
      * @param item The SchemaItem to check.
      * @returns The item cast to Unit if it is a Unit, undefined otherwise.
+     * @internal
      */
     static assertIsUnit(item) {
         if (!this.isUnit(item))
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Unit}' (Unit)`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Unit}' (Unit)`);
     }
 }
 exports.Unit = Unit;

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;AAG/D,6CAA0C;AAE1C,6CAA0C;AAC1C,6CAA0C;AAE1C;;;;GAIG;AACH,MAAa,IAAK,SAAQ,uBAAU;IACT,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IACvD,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,WAAW,CAAwB;IACnC,WAAW,CAAwB;IACnC,WAAW,CAAS;IACpB,UAAU,CAAU;IACpB,YAAY,CAAU;IACtB,OAAO,CAAU;IAE3B,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,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,IAAI,GAAG,CAAC,CAAC,CAAC;IACjE,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC;IAC3D,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;IACrE,IAAW,YAAY,KAAc,OAAO,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAC9E,IAAW,SAAS,KAAc,OAAO,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IACxE,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAElF;;;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,IAAI,CAAC,YAAY;YACnB,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACxC,IAAI,IAAI,CAAC,cAAc;YACrB,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,IAAI,CAAC,SAAS;YAChB,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,CAAC;YAC7B,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;QACzD,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,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;QACzD,CAAC;QAED,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY;YACnB,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,IAAI,IAAI,CAAC,cAAc;YACrB,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,IAAI,CAAC,SAAS;YAChB,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,SAA8B;QACzD,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,CAAC,uBAAuB,EAAE,uBAAU,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,CAAC,uBAAuB,EAAE,uBAAU,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,CAAC;YACtC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;gBACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,SAAS,CAAC;QAC1C,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC;YACxC,IAAI,SAAS,CAAC,WAAW,KAAK,IAAI,CAAC,YAAY;gBAC7C,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC;QAC9C,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO;gBACnC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;QACpC,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,SAA8B;QAC3D,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;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACnB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,IAAI,UAAU,CAAC,CAAC;IAChH,CAAC;CACF;AA9KD,oBA8KC;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 { SchemaItemUnitProps } 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 = Unit.schemaItemType;\r\n  public static override get schemaItemType() { return SchemaItemType.Unit; }\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._definition = \"\";\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 ?? 1.0; }\r\n  public get offset(): number { return this._offset ?? 0.0; }\r\n  public get denominator(): number { return this._denominator ?? 1.0; }\r\n  public get hasNumerator(): boolean { return (this._numerator !== undefined); }\r\n  public get hasOffset(): boolean { return (this._offset !== undefined); }\r\n  public get hasDenominator(): boolean { return (this._denominator !== undefined); }\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): SchemaItemUnitProps {\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 (this.hasNumerator)\r\n      schemaJson.numerator = this.numerator;\r\n    if (this.hasDenominator)\r\n      schemaJson.denominator = this.denominator;\r\n    if (this.hasOffset)\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    if (this.hasNumerator)\r\n      itemElement.setAttribute(\"numerator\", this.numerator.toString());\r\n    if (this.hasDenominator)\r\n      itemElement.setAttribute(\"denominator\", this.denominator.toString());\r\n    if (this.hasOffset)\r\n      itemElement.setAttribute(\"offset\", this.offset.toString());\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(unitProps: SchemaItemUnitProps) {\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(phenomenonSchemaItemKey, Phenomenon);\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(unitSystemSchemaItemKey, UnitSystem);\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: SchemaItemUnitProps) {\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   * Type assertion to check if the SchemaItem is of type Unit.\r\n   * @param item The SchemaItem to check.\r\n   * @returns The item cast to Unit if it is a Unit, undefined otherwise.\r\n   */\r\n  public static assertIsUnit(item?: SchemaItem): asserts item is Unit {\r\n    if(!this.isUnit(item))\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Unit}' (Unit)`);\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,4CAA6D;AAG7D,6CAA0C;AAE1C,6CAA0C;AAC1C,6CAA0C;AAE1C;;;;GAIG;AACH,MAAa,IAAK,SAAQ,uBAAU;IACT,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAC9D,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IACnE,WAAW,CAAwB;IACnC,WAAW,CAAwB;IACnC,WAAW,CAAS;IACpB,UAAU,CAAU;IACpB,YAAY,CAAU;IACtB,OAAO,CAAU;IAEzB,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,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,IAAI,GAAG,CAAC,CAAC,CAAC;IACjE,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC;IAC3D,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC;IACrE,IAAW,YAAY,KAAc,OAAO,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAC9E,IAAW,SAAS,KAAc,OAAO,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IACxE,IAAW,cAAc,KAAc,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAElF;;;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;IACI,MAAM,CAAC,MAAM,CAAC,IAAiB;QACpC,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,IAAI;YACrD,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,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,IAAI,CAAC,YAAY;YACnB,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACxC,IAAI,IAAI,CAAC,cAAc;YACrB,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,IAAI,CAAC,SAAS;YAChB,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,CAAC;YAC7B,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;QACzD,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,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;QACzD,CAAC;QAED,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY;YACnB,WAAW,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnE,IAAI,IAAI,CAAC,cAAc;YACrB,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvE,IAAI,IAAI,CAAC,SAAS;YAChB,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,SAA8B;QACzD,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,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACpH,IAAI,CAAC,WAAW,GAAG,IAAI,wCAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,uBAAU,CAAC,CAAC;YACjF,IAAI,SAAS,KAAK,MAAM;gBACtB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACpH,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,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;QACpH,IAAI,CAAC,WAAW,GAAG,IAAI,wCAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,uBAAU,CAAC,CAAC;YACrF,IAAI,SAAS,KAAK,UAAU;gBAC1B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mCAAmC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YACpH,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,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,YAAY,IAAI,CAAC,IAAI,yCAAyC,CAAC,CAAC;aACnH,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;YAC9B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC;QAE1C,IAAI,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC;YACtC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,UAAU;gBACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,SAAS,CAAC;QAC1C,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,WAAW,EAAE,CAAC;YACxC,IAAI,SAAS,CAAC,WAAW,KAAK,IAAI,CAAC,YAAY;gBAC7C,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC;QAC9C,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO;gBACnC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;QACpC,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,SAA8B;QAC3D,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED,gBAAgB;IACN,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,gBAAgB;IACN,KAAK,CAAC,aAAa,CAAC,UAAgC;QAC5D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,gBAAgB;IACN,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC9C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACpB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,IAAI,UAAU,CAAC,CAAC;IAC9G,CAAC;CACF;AA7KD,oBA6KC;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 { SchemaItemUnitProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECSchemaError, ECSchemaStatus } 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 * @public @preview\r\n */\r\nexport class Unit extends SchemaItem {\r\n  public override readonly schemaItemType = Unit.schemaItemType;\r\n  /** @internal */\r\n  public static override get schemaItemType() { return SchemaItemType.Unit; }\r\n  private _phenomenon?: LazyLoadedPhenomenon;\r\n  private _unitSystem?: LazyLoadedUnitSystem;\r\n  private _definition: string;\r\n  private _numerator?: number;\r\n  private _denominator?: number;\r\n  private _offset?: number;\r\n\r\n  /** @internal */\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this._definition = \"\";\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 ?? 1.0; }\r\n  public get offset(): number { return this._offset ?? 0.0; }\r\n  public get denominator(): number { return this._denominator ?? 1.0; }\r\n  public get hasNumerator(): boolean { return (this._numerator !== undefined); }\r\n  public get hasOffset(): boolean { return (this._offset !== undefined); }\r\n  public get hasDenominator(): boolean { return (this._denominator !== undefined); }\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   * Type guard to check if the SchemaItem is of type Unit.\r\n   * @param item The SchemaItem to check.\r\n   * @returns True if the item is a Unit, false otherwise.\r\n   */\r\n  public static isUnit(item?: SchemaItem): item is Unit {\r\n    if (item && item.schemaItemType === SchemaItemType.Unit)\r\n      return true;\r\n\r\n    return false;\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): SchemaItemUnitProps {\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 (this.hasNumerator)\r\n      schemaJson.numerator = this.numerator;\r\n    if (this.hasDenominator)\r\n      schemaJson.denominator = this.denominator;\r\n    if (this.hasOffset)\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    if (this.hasNumerator)\r\n      itemElement.setAttribute(\"numerator\", this.numerator.toString());\r\n    if (this.hasDenominator)\r\n      itemElement.setAttribute(\"denominator\", this.denominator.toString());\r\n    if (this.hasOffset)\r\n      itemElement.setAttribute(\"offset\", this.offset.toString());\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(unitProps: SchemaItemUnitProps) {\r\n    super.fromJSONSync(unitProps);\r\n\r\n    const phenomenonSchemaItemKey = this.schema.getSchemaItemKey(unitProps.phenomenon);\r\n    if (!phenomenonSchemaItemKey)\r\n      throw new ECSchemaError(ECSchemaStatus.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(phenomenonSchemaItemKey, Phenomenon);\r\n        if (undefined === phenom)\r\n          throw new ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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(unitSystemSchemaItemKey, UnitSystem);\r\n        if (undefined === unitSystem)\r\n          throw new ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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: SchemaItemUnitProps) {\r\n    this.fromJSONSync(unitProps);\r\n  }\r\n\r\n  /** @internal */\r\n  protected async setPhenomenon(phenomenon: LazyLoadedPhenomenon) {\r\n    this._phenomenon = phenomenon;\r\n  }\r\n\r\n  /** @internal */\r\n  protected async setUnitSystem(unitSystem: LazyLoadedUnitSystem) {\r\n    this._unitSystem = unitSystem;\r\n  }\r\n\r\n  /** @internal */\r\n  protected async setDefinition(definition: string) {\r\n    this._definition = definition;\r\n  }\r\n\r\n  /**\r\n   * Type assertion to check if the SchemaItem is of type Unit.\r\n   * @param item The SchemaItem to check.\r\n   * @returns The item cast to Unit if it is a Unit, undefined otherwise.\r\n   * @internal\r\n   */\r\n  public static assertIsUnit(item?: SchemaItem): asserts item is Unit {\r\n    if (!this.isUnit(item))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Unit}' (Unit)`);\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/Metadata/UnitSystem.d.ts

@@ -4,10 +4,11 @@
 import { SchemaItemType } from "../ECObjects";
 import { SchemaItem } from "./SchemaItem";
 /**
- * @beta
+ * @public @preview
  */
 export declare class UnitSystem extends SchemaItem {
     readonly schemaItemType: SchemaItemType;
+    /** @internal */
     static get schemaItemType(): SchemaItemType;
     /**
      * Type guard to check if the SchemaItem is of type UnitSystem.
@@ -19,6 +20,7 @@ export declare class UnitSystem extends SchemaItem {
      * Type assertion to check if the SchemaItem is of type UnitSystem.
      * @param item The SchemaItem to check.
      * @returns The item cast to UnitSystem if it is a UnitSystem, undefined otherwise.
+     * @internal
      */
     static assertIsUnitSystem(item?: SchemaItem): asserts item is UnitSystem;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"UnitSystem.d.ts","sourceRoot":"","sources":["../../../src/Metadata/UnitSystem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAyB,cAAc,iBAA6B;IACpE,WAA2B,cAAc,mBAAwC;IAEjF;;;;OAIG;WACW,YAAY,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,UAAU;IAOjE;;;;OAIG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU;CAIhF;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,UAAU;aAC/B,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"UnitSystem.d.ts","sourceRoot":"","sources":["../../../src/Metadata/UnitSystem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,SAAyB,cAAc,iBAA6B;IACpE,gBAAgB;IAChB,WAA2B,cAAc,mBAAwC;IAEjF;;;;OAIG;WACW,YAAY,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,UAAU;IAOjE;;;;;OAKG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,UAAU;CAIhF;AAED;;;GAGG;AACH,8BAAsB,iBAAkB,SAAQ,UAAU;aAC/B,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/cjs/Metadata/UnitSystem.js

@@ -12,10 +12,11 @@ const ECObjects_1 = require("../ECObjects");
 const Exception_1 = require("../Exception");
 const SchemaItem_1 = require("./SchemaItem");
 /**
- * @beta
+ * @public @preview
  */
 class UnitSystem extends SchemaItem_1.SchemaItem {
     schemaItemType = UnitSystem.schemaItemType;
+    /** @internal */
     static get schemaItemType() { return ECObjects_1.SchemaItemType.UnitSystem; }
     /**
      * Type guard to check if the SchemaItem is of type UnitSystem.
@@ -31,10 +32,11 @@ class UnitSystem extends SchemaItem_1.SchemaItem {
      * Type assertion to check if the SchemaItem is of type UnitSystem.
      * @param item The SchemaItem to check.
      * @returns The item cast to UnitSystem if it is a UnitSystem, undefined otherwise.
+     * @internal
      */
     static assertIsUnitSystem(item) {
         if (!this.isUnitSystem(item))
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.UnitSystem}' (UnitSystem)`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.UnitSystem}' (UnitSystem)`);
     }
 }
 exports.UnitSystem = UnitSystem;

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

@@ -1 +1 @@
-{"version":3,"file":"UnitSystem.js","sourceRoot":"","sources":["../../../src/Metadata/UnitSystem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,4CAA8C;AAC9C,4CAA+D;AAC/D,6CAA0C;AAE1C;;GAEG;AACH,MAAa,UAAW,SAAQ,uBAAU;IACf,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAC7D,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjF;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,UAAU;YAC3D,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAiB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAC1B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,UAAU,gBAAgB,CAAC,CAAC;IAC5H,CAAC;CACF;AAzBD,gCAyBC;AAED;;;GAGG;AACH,MAAsB,iBAAkB,SAAQ,UAAU;CAEzD;AAFD,8CAEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * @beta\n */\nexport class UnitSystem extends SchemaItem {\n  public override readonly schemaItemType = UnitSystem.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.UnitSystem; }\n\n  /**\n   * Type guard to check if the SchemaItem is of type UnitSystem.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a UnitSystem, false otherwise.\n   */\n  public static isUnitSystem(item?: SchemaItem): item is UnitSystem {\n    if (item && item.schemaItemType === SchemaItemType.UnitSystem)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type UnitSystem.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to UnitSystem if it is a UnitSystem, undefined otherwise.\n   */\n  public static assertIsUnitSystem(item?: SchemaItem): asserts item is UnitSystem {\n    if (!this.isUnitSystem(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.UnitSystem}' (UnitSystem)`);\n  }\n}\n\n/**\n * @internal\n * Used for schema editing.\n */\nexport abstract class MutableUnitSystem extends UnitSystem {\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}
+{"version":3,"file":"UnitSystem.js","sourceRoot":"","sources":["../../../src/Metadata/UnitSystem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,4CAA8C;AAC9C,4CAA6D;AAC7D,6CAA0C;AAE1C;;GAEG;AACH,MAAa,UAAW,SAAQ,uBAAU;IACf,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IACpE,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjF;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,IAAiB;QAC1C,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,UAAU;YAC3D,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAiB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAC1B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,UAAU,gBAAgB,CAAC,CAAC;IAC1H,CAAC;CACF;AA3BD,gCA2BC;AAED;;;GAGG;AACH,MAAsB,iBAAkB,SAAQ,UAAU;CAEzD;AAFD,8CAEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\nimport { SchemaItem } from \"./SchemaItem\";\n\n/**\n * @public @preview\n */\nexport class UnitSystem extends SchemaItem {\n  public override readonly schemaItemType = UnitSystem.schemaItemType;\n  /** @internal */\n  public static override get schemaItemType() { return SchemaItemType.UnitSystem; }\n\n  /**\n   * Type guard to check if the SchemaItem is of type UnitSystem.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a UnitSystem, false otherwise.\n   */\n  public static isUnitSystem(item?: SchemaItem): item is UnitSystem {\n    if (item && item.schemaItemType === SchemaItemType.UnitSystem)\n      return true;\n\n    return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type UnitSystem.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to UnitSystem if it is a UnitSystem, undefined otherwise.\n   * @internal\n   */\n  public static assertIsUnitSystem(item?: SchemaItem): asserts item is UnitSystem {\n    if (!this.isUnitSystem(item))\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.UnitSystem}' (UnitSystem)`);\n  }\n}\n\n/**\n * @internal\n * Used for schema editing.\n */\nexport abstract class MutableUnitSystem extends UnitSystem {\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}

package/lib/cjs/PropertyTypes.d.ts

@@ -3,7 +3,7 @@
  */
 import { PrimitiveType } from "./ECObjects";
 /**
- * @beta
+ * @public @preview
  */
 export declare enum PropertyType {
     Struct = 2,// PropertyFlags.Struct
@@ -34,17 +34,17 @@ export declare enum PropertyType {
     IGeometry = 2561,// PrimitiveType.IGeometry
     IGeometry_Array = 2565
 }
-/** @beta */
+/** @internal */
 export declare namespace PropertyTypeUtils {
-    function isArray(t: PropertyType): boolean;
-    function isPrimitive(t: PropertyType): boolean;
-    function isStruct(t: PropertyType): boolean;
-    function isNavigation(t: PropertyType): boolean;
-    function isEnumeration(t: PropertyType): boolean;
-    function asArray(t: PropertyType): PropertyType;
-    function getPrimitiveType(t: PropertyType): PrimitiveType;
-    function fromPrimitiveType(t: PrimitiveType): PropertyType;
+    function isArray(type: PropertyType): boolean;
+    function isPrimitive(type: PropertyType): boolean;
+    function isStruct(type: PropertyType): boolean;
+    function isNavigation(type: PropertyType): boolean;
+    function isEnumeration(type: PropertyType): boolean;
+    function asArray(type: PropertyType): PropertyType;
+    function getPrimitiveType(type: PropertyType): PrimitiveType;
+    function fromPrimitiveType(type: PrimitiveType): PropertyType;
 }
-/** @beta */
+/** @internal */
 export declare function propertyTypeToString(type: PropertyType): "PrimitiveProperty" | "StructProperty" | "StructArrayProperty" | "NavigationProperty" | "PrimitiveArrayProperty";
 //# sourceMappingURL=PropertyTypes.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PropertyTypes.d.ts","sourceRoot":"","sources":["../../src/PropertyTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAY5C;;GAEG;AACH,oBAAY,YAAY;IACtB,MAAM,IAAO,CAAE,uBAAuB;IACtC,YAAY,IAAO,CAAE,6CAA6C;IAClE,UAAU,IAAO,CAAE,2BAA2B;IAC9C,MAAM,MAAQ,CAAE,uBAAuB;IACvC,YAAY,MAAQ,CAAE,6CAA6C;IACnE,OAAO,MAAQ,CAAE,wBAAwB;IACzC,aAAa,MAAQ,CAAE,8CAA8C;IACrE,QAAQ,MAAQ,CAAE,yBAAyB;IAC3C,cAAc,MAAQ,CAAE,+CAA+C;IACvE,MAAM,OAAQ,CAAE,uBAAuB;IACvC,YAAY,OAAQ,CAAE,6CAA6C;IACnE,OAAO,OAAQ,CAAE,wBAAwB;IACzC,aAAa,OAAQ,CAAE,8CAA8C;IACrE,mBAAmB,OAAQ,CAAE,oDAAoD;IACjF,yBAAyB,OAAQ,CAAE,0EAA0E;IAC7G,IAAI,OAAQ,CAAE,qBAAqB;IACnC,UAAU,OAAQ,CAAE,2CAA2C;IAC/D,OAAO,OAAQ,CAAE,wBAAwB;IACzC,aAAa,OAAQ,CAAE,8CAA8C;IACrE,OAAO,OAAQ,CAAE,wBAAwB;IACzC,aAAa,OAAQ,CAAE,8CAA8C;IACrE,MAAM,OAAQ,CAAE,uBAAuB;IACvC,YAAY,OAAQ,CAAE,6CAA6C;IACnE,kBAAkB,OAAQ,CAAE,mDAAmD;IAC/E,wBAAwB,OAAQ,CAAE,yEAAyE;IAC3G,SAAS,OAAQ,CAAE,0BAA0B;IAC7C,eAAe,OAAQ;CACxB;AAED,YAAY;AACZ,yBAAiB,iBAAiB,CAAC;IACjC,SAAgB,OAAO,CAAC,CAAC,EAAE,YAAY,WAEtC;IACD,SAAgB,WAAW,CAAC,CAAC,EAAE,YAAY,WAE1C;IACD,SAAgB,QAAQ,CAAC,CAAC,EAAE,YAAY,WAEvC;IACD,SAAgB,YAAY,CAAC,CAAC,EAAE,YAAY,WAE3C;IACD,SAAgB,aAAa,CAAC,CAAC,EAAE,YAAY,WAE5C;IACD,SAAgB,OAAO,CAAC,CAAC,EAAE,YAAY,GAAG,YAAY,CAErD;IACD,SAAgB,gBAAgB,CAAC,CAAC,EAAE,YAAY,GAAG,aAAa,CAE/D;IACD,SAAgB,iBAAiB,CAAC,CAAC,EAAE,aAAa,GAAG,YAAY,CAEhE;CACF;AAED,YAAY;AACZ,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,oHAQtD"}
+{"version":3,"file":"PropertyTypes.d.ts","sourceRoot":"","sources":["../../src/PropertyTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAW5C;;GAEG;AACH,oBAAY,YAAY;IACtB,MAAM,IAAO,CAAE,uBAAuB;IACtC,YAAY,IAAO,CAAE,6CAA6C;IAClE,UAAU,IAAO,CAAE,2BAA2B;IAC9C,MAAM,MAAQ,CAAE,uBAAuB;IACvC,YAAY,MAAQ,CAAE,6CAA6C;IACnE,OAAO,MAAQ,CAAE,wBAAwB;IACzC,aAAa,MAAQ,CAAE,8CAA8C;IACrE,QAAQ,MAAQ,CAAE,yBAAyB;IAC3C,cAAc,MAAQ,CAAE,+CAA+C;IACvE,MAAM,OAAQ,CAAE,uBAAuB;IACvC,YAAY,OAAQ,CAAE,6CAA6C;IACnE,OAAO,OAAQ,CAAE,wBAAwB;IACzC,aAAa,OAAQ,CAAE,8CAA8C;IACrE,mBAAmB,OAAQ,CAAE,oDAAoD;IACjF,yBAAyB,OAAQ,CAAE,0EAA0E;IAC7G,IAAI,OAAQ,CAAE,qBAAqB;IACnC,UAAU,OAAQ,CAAE,2CAA2C;IAC/D,OAAO,OAAQ,CAAE,wBAAwB;IACzC,aAAa,OAAQ,CAAE,8CAA8C;IACrE,OAAO,OAAQ,CAAE,wBAAwB;IACzC,aAAa,OAAQ,CAAE,8CAA8C;IACrE,MAAM,OAAQ,CAAE,uBAAuB;IACvC,YAAY,OAAQ,CAAE,6CAA6C;IACnE,kBAAkB,OAAQ,CAAE,mDAAmD;IAC/E,wBAAwB,OAAQ,CAAE,yEAAyE;IAC3G,SAAS,OAAQ,CAAE,0BAA0B;IAC7C,eAAe,OAAQ;CACxB;AAED,gBAAgB;AAChB,yBAAiB,iBAAiB,CAAC;IACjC,SAAgB,OAAO,CAAC,IAAI,EAAE,YAAY,WAEzC;IACD,SAAgB,WAAW,CAAC,IAAI,EAAE,YAAY,WAE7C;IACD,SAAgB,QAAQ,CAAC,IAAI,EAAE,YAAY,WAE1C;IACD,SAAgB,YAAY,CAAC,IAAI,EAAE,YAAY,WAE9C;IACD,SAAgB,aAAa,CAAC,IAAI,EAAE,YAAY,WAE/C;IACD,SAAgB,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY,CAExD;IACD,SAAgB,gBAAgB,CAAC,IAAI,EAAE,YAAY,GAAG,aAAa,CAElE;IACD,SAAgB,iBAAiB,CAAC,IAAI,EAAE,aAAa,GAAG,YAAY,CAEnE;CACF;AAED,gBAAgB;AAChB,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,oHAQtD"}

package/lib/cjs/PropertyTypes.js

@@ -10,8 +10,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PropertyTypeUtils = exports.PropertyType = void 0;
 exports.propertyTypeToString = propertyTypeToString;
 const Exception_1 = require("./Exception");
+var PropertyFlags;
+(function (PropertyFlags) {
+    PropertyFlags[PropertyFlags["Primitive"] = 1] = "Primitive";
+    PropertyFlags[PropertyFlags["Struct"] = 2] = "Struct";
+    PropertyFlags[PropertyFlags["Array"] = 4] = "Array";
+    PropertyFlags[PropertyFlags["Navigation"] = 8] = "Navigation";
+    PropertyFlags[PropertyFlags["Enumeration"] = 16] = "Enumeration";
+})(PropertyFlags || (PropertyFlags = {}));
 /**
- * @beta
+ * @public @preview
  */
 var PropertyType;
 (function (PropertyType) {
@@ -43,43 +51,43 @@ var PropertyType;
     PropertyType[PropertyType["IGeometry"] = 2561] = "IGeometry";
     PropertyType[PropertyType["IGeometry_Array"] = 2565] = "IGeometry_Array";
 })(PropertyType || (exports.PropertyType = PropertyType = {}));
-/** @beta */
+/** @internal */
 var PropertyTypeUtils;
 (function (PropertyTypeUtils) {
-    function isArray(t) {
-        return (t === (4 /* PropertyFlags.Array */ | t));
+    function isArray(type) {
+        return (type === (PropertyFlags.Array | type));
     }
     PropertyTypeUtils.isArray = isArray;
-    function isPrimitive(t) {
-        return (t === (1 /* PropertyFlags.Primitive */ | t));
+    function isPrimitive(type) {
+        return (type === (PropertyFlags.Primitive | type));
     }
     PropertyTypeUtils.isPrimitive = isPrimitive;
-    function isStruct(t) {
-        return (t === (2 /* PropertyFlags.Struct */ | t));
+    function isStruct(type) {
+        return (type === (PropertyFlags.Struct | type));
     }
     PropertyTypeUtils.isStruct = isStruct;
-    function isNavigation(t) {
-        return (t === (8 /* PropertyFlags.Navigation */ | t));
+    function isNavigation(type) {
+        return (type === (PropertyFlags.Navigation | type));
     }
     PropertyTypeUtils.isNavigation = isNavigation;
-    function isEnumeration(t) {
-        return (t === (16 /* PropertyFlags.Enumeration */ | t));
+    function isEnumeration(type) {
+        return (type === (PropertyFlags.Enumeration | type));
     }
     PropertyTypeUtils.isEnumeration = isEnumeration;
-    function asArray(t) {
-        return t | 4 /* PropertyFlags.Array */;
+    function asArray(type) {
+        return type | PropertyFlags.Array;
     }
     PropertyTypeUtils.asArray = asArray;
-    function getPrimitiveType(t) {
-        return (0xFF01 & t);
+    function getPrimitiveType(type) {
+        return (0xFF01 & type);
     }
     PropertyTypeUtils.getPrimitiveType = getPrimitiveType;
-    function fromPrimitiveType(t) {
-        return t | 0;
+    function fromPrimitiveType(type) {
+        return type | 0;
     }
     PropertyTypeUtils.fromPrimitiveType = fromPrimitiveType;
 })(PropertyTypeUtils || (exports.PropertyTypeUtils = PropertyTypeUtils = {}));
-/** @beta */
+/** @internal */
 function propertyTypeToString(type) {
     if (PropertyTypeUtils.isPrimitive(type))
         return (PropertyTypeUtils.isArray(type)) ? "PrimitiveArrayProperty" : "PrimitiveProperty";
@@ -87,6 +95,6 @@ function propertyTypeToString(type) {
         return (PropertyTypeUtils.isArray(type)) ? "StructArrayProperty" : "StructProperty";
     if (PropertyTypeUtils.isNavigation(type))
         return "NavigationProperty";
-    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, "Invalid propertyType");
+    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidType, "Invalid propertyType");
 }
 //# sourceMappingURL=PropertyTypes.js.map

package/lib/cjs/PropertyTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyTypes.js","sourceRoot":"","sources":["../../src/PropertyTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA4EH,oDAQC;AAjFD,2CAA8D;AAW9D;;GAEG;AACH,IAAY,YA4BX;AA5BD,WAAY,YAAY;IACtB,mDAAa,CAAA;IACb,+DAAmB,CAAA;IACnB,2DAAiB,CAAA;IACjB,qDAAc,CAAA;IACd,iEAAoB,CAAA;IACpB,uDAAe,CAAA;IACf,mEAAqB,CAAA;IACrB,yDAAgB,CAAA;IAChB,qEAAsB,CAAA;IACtB,sDAAc,CAAA;IACd,kEAAoB,CAAA;IACpB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,gFAA2B,CAAA;IAC3B,4FAAiC,CAAA;IACjC,kDAAY,CAAA;IACZ,8DAAkB,CAAA;IAClB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,sDAAc,CAAA;IACd,kEAAoB,CAAA;IACpB,8EAA0B,CAAA;IAC1B,0FAAgC,CAAA;IAChC,4DAAiB,CAAA;IACjB,wEAAuB,CAAA;AACzB,CAAC,EA5BW,YAAY,4BAAZ,YAAY,QA4BvB;AAED,YAAY;AACZ,IAAiB,iBAAiB,CAyBjC;AAzBD,WAAiB,iBAAiB;IAChC,SAAgB,OAAO,CAAC,CAAe;QACrC,OAAO,CAAC,CAAC,KAAK,CAAC,8BAAsB,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAFe,yBAAO,UAEtB,CAAA;IACD,SAAgB,WAAW,CAAC,CAAe;QACzC,OAAO,CAAC,CAAC,KAAK,CAAC,kCAA0B,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAFe,6BAAW,cAE1B,CAAA;IACD,SAAgB,QAAQ,CAAC,CAAe;QACtC,OAAO,CAAC,CAAC,KAAK,CAAC,+BAAuB,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC;IAFe,0BAAQ,WAEvB,CAAA;IACD,SAAgB,YAAY,CAAC,CAAe;QAC1C,OAAO,CAAC,CAAC,KAAK,CAAC,mCAA2B,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;IAFe,8BAAY,eAE3B,CAAA;IACD,SAAgB,aAAa,CAAC,CAAe;QAC3C,OAAO,CAAC,CAAC,KAAK,CAAC,qCAA4B,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAFe,+BAAa,gBAE5B,CAAA;IACD,SAAgB,OAAO,CAAC,CAAe;QACrC,OAAO,CAAC,8BAAsB,CAAC;IACjC,CAAC;IAFe,yBAAO,UAEtB,CAAA;IACD,SAAgB,gBAAgB,CAAC,CAAe;QAC9C,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtB,CAAC;IAFe,kCAAgB,mBAE/B,CAAA;IACD,SAAgB,iBAAiB,CAAC,CAAgB;QAChD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAFe,mCAAiB,oBAEhC,CAAA;AACH,CAAC,EAzBgB,iBAAiB,iCAAjB,iBAAiB,QAyBjC;AAED,YAAY;AACZ,SAAgB,oBAAoB,CAAC,IAAkB;IACrD,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC;QACrC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,mBAAmB,CAAC;IAC5F,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC;QAClC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,gBAAgB,CAAC;IACtF,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC;QACtC,OAAO,oBAAoB,CAAC;IAC9B,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;AAChF,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { PrimitiveType } from \"./ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\n\n/** @beta */\nconst enum PropertyFlags { // eslint-disable-line no-restricted-syntax\n  Primitive = 0x01,\n  Struct = 0x02,\n  Array = 0x04,\n  Navigation = 0x08,\n  Enumeration = 0x10,\n}\n\n/**\n * @beta\n */\nexport enum PropertyType {\n  Struct = 0x02, // PropertyFlags.Struct\n  Struct_Array = 0x06, // PropertyFlags.Struct | PropertyFlags.Array\n  Navigation = 0x08, // PropertyFlags.Navigation\n  Binary = 0x101, // PrimitiveType.Binary\n  Binary_Array = 0x105, // PrimitiveType.Binary | PropertyFlags.Array\n  Boolean = 0x201, // PrimitiveType.Boolean\n  Boolean_Array = 0x205, // PrimitiveType.Boolean | PropertyFlags.Array\n  DateTime = 0x301, // PrimitiveType.DateTime\n  DateTime_Array = 0x305, // PrimitiveType.DateTime | PropertyFlags.Array\n  Double = 0x401, // PrimitiveType.Double\n  Double_Array = 0x405, // PrimitiveType.Double | PropertyFlags.Array\n  Integer = 0x501, // PrimitiveType.Integer\n  Integer_Array = 0x505, // PrimitiveType.Integer | PropertyFlags.Array\n  Integer_Enumeration = 0x511, // PrimitiveType.Integer | PropertyFlags.Enumeration\n  Integer_Enumeration_Array = 0x515, // PrimitiveType.Integer | PropertyFlags.Enumeration | PropertyFlags.Array\n  Long = 0x601, // PrimitiveType.Long\n  Long_Array = 0x605, // PrimitiveType.Long | PropertyFlags.Array\n  Point2d = 0x701, // PrimitiveType.Point2d\n  Point2d_Array = 0x705, // PrimitiveType.Point2d | PropertyFlags.Array\n  Point3d = 0x801, // PrimitiveType.Point3d\n  Point3d_Array = 0x805, // PrimitiveType.Point3d | PropertyFlags.Array\n  String = 0x901, // PrimitiveType.String\n  String_Array = 0x905, // PrimitiveType.String | PropertyFlags.Array\n  String_Enumeration = 0x911, // PrimitiveType.String | PropertyFlags.Enumeration\n  String_Enumeration_Array = 0x915, // PrimitiveType.String | PropertyFlags.Enumeration | PropertyFlags.Array\n  IGeometry = 0xA01, // PrimitiveType.IGeometry\n  IGeometry_Array = 0xA05, // PrimitiveType.IGeometry | PropertyFlags.Array\n}\n\n/** @beta */\nexport namespace PropertyTypeUtils {\n  export function isArray(t: PropertyType) {\n    return (t === (PropertyFlags.Array | t));\n  }\n  export function isPrimitive(t: PropertyType) {\n    return (t === (PropertyFlags.Primitive | t));\n  }\n  export function isStruct(t: PropertyType) {\n    return (t === (PropertyFlags.Struct | t));\n  }\n  export function isNavigation(t: PropertyType) {\n    return (t === (PropertyFlags.Navigation | t));\n  }\n  export function isEnumeration(t: PropertyType) {\n    return (t === (PropertyFlags.Enumeration | t));\n  }\n  export function asArray(t: PropertyType): PropertyType {\n    return t | PropertyFlags.Array;\n  }\n  export function getPrimitiveType(t: PropertyType): PrimitiveType {\n    return (0xFF01 & t);\n  }\n  export function fromPrimitiveType(t: PrimitiveType): PropertyType {\n    return t | 0;\n  }\n}\n\n/** @beta */\nexport function propertyTypeToString(type: PropertyType) {\n  if (PropertyTypeUtils.isPrimitive(type))\n    return (PropertyTypeUtils.isArray(type)) ? \"PrimitiveArrayProperty\" : \"PrimitiveProperty\";\n  if (PropertyTypeUtils.isStruct(type))\n    return (PropertyTypeUtils.isArray(type)) ? \"StructArrayProperty\" : \"StructProperty\";\n  if (PropertyTypeUtils.isNavigation(type))\n    return \"NavigationProperty\";\n  throw new ECObjectsError(ECObjectsStatus.InvalidType, \"Invalid propertyType\");\n}\n"]}
+{"version":3,"file":"PropertyTypes.js","sourceRoot":"","sources":["../../src/PropertyTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA2EH,oDAQC;AAhFD,2CAA4D;AAE5D,IAAK,aAMJ;AAND,WAAK,aAAa;IAChB,2DAAgB,CAAA;IAChB,qDAAa,CAAA;IACb,mDAAY,CAAA;IACZ,6DAAiB,CAAA;IACjB,gEAAkB,CAAA;AACpB,CAAC,EANI,aAAa,KAAb,aAAa,QAMjB;AAED;;GAEG;AACH,IAAY,YA4BX;AA5BD,WAAY,YAAY;IACtB,mDAAa,CAAA;IACb,+DAAmB,CAAA;IACnB,2DAAiB,CAAA;IACjB,qDAAc,CAAA;IACd,iEAAoB,CAAA;IACpB,uDAAe,CAAA;IACf,mEAAqB,CAAA;IACrB,yDAAgB,CAAA;IAChB,qEAAsB,CAAA;IACtB,sDAAc,CAAA;IACd,kEAAoB,CAAA;IACpB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,gFAA2B,CAAA;IAC3B,4FAAiC,CAAA;IACjC,kDAAY,CAAA;IACZ,8DAAkB,CAAA;IAClB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,wDAAe,CAAA;IACf,oEAAqB,CAAA;IACrB,sDAAc,CAAA;IACd,kEAAoB,CAAA;IACpB,8EAA0B,CAAA;IAC1B,0FAAgC,CAAA;IAChC,4DAAiB,CAAA;IACjB,wEAAuB,CAAA;AACzB,CAAC,EA5BW,YAAY,4BAAZ,YAAY,QA4BvB;AAED,gBAAgB;AAChB,IAAiB,iBAAiB,CAyBjC;AAzBD,WAAiB,iBAAiB;IAChC,SAAgB,OAAO,CAAC,IAAkB;QACxC,OAAO,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;IACjD,CAAC;IAFe,yBAAO,UAEtB,CAAA;IACD,SAAgB,WAAW,CAAC,IAAkB;QAC5C,OAAO,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAFe,6BAAW,cAE1B,CAAA;IACD,SAAgB,QAAQ,CAAC,IAAkB;QACzC,OAAO,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IAFe,0BAAQ,WAEvB,CAAA;IACD,SAAgB,YAAY,CAAC,IAAkB;QAC7C,OAAO,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;IAFe,8BAAY,eAE3B,CAAA;IACD,SAAgB,aAAa,CAAC,IAAkB;QAC9C,OAAO,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC;IACvD,CAAC;IAFe,+BAAa,gBAE5B,CAAA;IACD,SAAgB,OAAO,CAAC,IAAkB;QACxC,OAAO,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC;IACpC,CAAC;IAFe,yBAAO,UAEtB,CAAA;IACD,SAAgB,gBAAgB,CAAC,IAAkB;QACjD,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACzB,CAAC;IAFe,kCAAgB,mBAE/B,CAAA;IACD,SAAgB,iBAAiB,CAAC,IAAmB;QACnD,OAAO,IAAI,GAAE,CAAC,CAAC;IACjB,CAAC;IAFe,mCAAiB,oBAEhC,CAAA;AACH,CAAC,EAzBgB,iBAAiB,iCAAjB,iBAAiB,QAyBjC;AAED,gBAAgB;AAChB,SAAgB,oBAAoB,CAAC,IAAkB;IACrD,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC;QACrC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,mBAAmB,CAAC;IAC5F,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC;QAClC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,gBAAgB,CAAC;IACtF,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC;QACtC,OAAO,oBAAoB,CAAC;IAC9B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;AAC9E,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { PrimitiveType } from \"./ECObjects\";\nimport { ECSchemaError, ECSchemaStatus } from \"./Exception\";\n\nenum PropertyFlags {\n  Primitive = 0x01,\n  Struct = 0x02,\n  Array = 0x04,\n  Navigation = 0x08,\n  Enumeration = 0x10,\n}\n\n/**\n * @public @preview\n */\nexport enum PropertyType {\n  Struct = 0x02, // PropertyFlags.Struct\n  Struct_Array = 0x06, // PropertyFlags.Struct | PropertyFlags.Array\n  Navigation = 0x08, // PropertyFlags.Navigation\n  Binary = 0x101, // PrimitiveType.Binary\n  Binary_Array = 0x105, // PrimitiveType.Binary | PropertyFlags.Array\n  Boolean = 0x201, // PrimitiveType.Boolean\n  Boolean_Array = 0x205, // PrimitiveType.Boolean | PropertyFlags.Array\n  DateTime = 0x301, // PrimitiveType.DateTime\n  DateTime_Array = 0x305, // PrimitiveType.DateTime | PropertyFlags.Array\n  Double = 0x401, // PrimitiveType.Double\n  Double_Array = 0x405, // PrimitiveType.Double | PropertyFlags.Array\n  Integer = 0x501, // PrimitiveType.Integer\n  Integer_Array = 0x505, // PrimitiveType.Integer | PropertyFlags.Array\n  Integer_Enumeration = 0x511, // PrimitiveType.Integer | PropertyFlags.Enumeration\n  Integer_Enumeration_Array = 0x515, // PrimitiveType.Integer | PropertyFlags.Enumeration | PropertyFlags.Array\n  Long = 0x601, // PrimitiveType.Long\n  Long_Array = 0x605, // PrimitiveType.Long | PropertyFlags.Array\n  Point2d = 0x701, // PrimitiveType.Point2d\n  Point2d_Array = 0x705, // PrimitiveType.Point2d | PropertyFlags.Array\n  Point3d = 0x801, // PrimitiveType.Point3d\n  Point3d_Array = 0x805, // PrimitiveType.Point3d | PropertyFlags.Array\n  String = 0x901, // PrimitiveType.String\n  String_Array = 0x905, // PrimitiveType.String | PropertyFlags.Array\n  String_Enumeration = 0x911, // PrimitiveType.String | PropertyFlags.Enumeration\n  String_Enumeration_Array = 0x915, // PrimitiveType.String | PropertyFlags.Enumeration | PropertyFlags.Array\n  IGeometry = 0xA01, // PrimitiveType.IGeometry\n  IGeometry_Array = 0xA05, // PrimitiveType.IGeometry | PropertyFlags.Array\n}\n\n/** @internal */\nexport namespace PropertyTypeUtils {\n  export function isArray(type: PropertyType) {\n    return (type === (PropertyFlags.Array | type));\n  }\n  export function isPrimitive(type: PropertyType) {\n    return (type === (PropertyFlags.Primitive | type));\n  }\n  export function isStruct(type: PropertyType) {\n    return (type === (PropertyFlags.Struct | type));\n  }\n  export function isNavigation(type: PropertyType) {\n    return (type === (PropertyFlags.Navigation | type));\n  }\n  export function isEnumeration(type: PropertyType) {\n    return (type === (PropertyFlags.Enumeration | type));\n  }\n  export function asArray(type: PropertyType): PropertyType {\n    return type | PropertyFlags.Array;\n  }\n  export function getPrimitiveType(type: PropertyType): PrimitiveType {\n    return (0xFF01 & type);\n  }\n  export function fromPrimitiveType(type: PrimitiveType): PropertyType {\n    return type| 0;\n  }\n}\n\n/** @internal */\nexport function propertyTypeToString(type: PropertyType) {\n  if (PropertyTypeUtils.isPrimitive(type))\n    return (PropertyTypeUtils.isArray(type)) ? \"PrimitiveArrayProperty\" : \"PrimitiveProperty\";\n  if (PropertyTypeUtils.isStruct(type))\n    return (PropertyTypeUtils.isArray(type)) ? \"StructArrayProperty\" : \"StructProperty\";\n  if (PropertyTypeUtils.isNavigation(type))\n    return \"NavigationProperty\";\n  throw new ECSchemaError(ECSchemaStatus.InvalidType, \"Invalid propertyType\");\n}\n"]}

package/lib/cjs/SchemaFormatsProvider.d.ts

@@ -0,0 +1,39 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { ISchemaLocater, SchemaContext } from "./Context";
+import { SchemaItemFormatProps } from "./Deserialization/JsonProps";
+import { BeEvent } from "@itwin/core-bentley";
+import { FormatsChangedArgs, FormatsProvider, UnitSystemKey } from "@itwin/core-quantity";
+/**
+ * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.
+ * @beta
+ */
+export declare class SchemaFormatsProvider implements FormatsProvider {
+    private _context;
+    private _unitSystem;
+    private _formatsRetrieved;
+    onFormatsChanged: BeEvent<(args: FormatsChangedArgs) => void>;
+    /**
+     *
+     * @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 unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.
+     */
+    constructor(contextOrLocater: ISchemaLocater, unitSystem: UnitSystemKey);
+    get context(): SchemaContext;
+    get unitSystem(): UnitSystemKey;
+    set unitSystem(unitSystem: UnitSystemKey);
+    private clear;
+    private getKindOfQuantityFormatFromSchema;
+    /**
+     * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.
+     * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.
+     * Else, the default presentation format will be retrieved.
+     * @param name The full name of the Format or KindOfQuantity.
+     * @returns
+     */
+    getFormat(name: string): Promise<SchemaItemFormatProps | undefined>;
+}
+//# sourceMappingURL=SchemaFormatsProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaFormatsProvider.d.ts","sourceRoot":"","sources":["../../src/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAI1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,OAAO,EAAe,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAIvG;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,eAAe;IAC3D,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,iBAAiB,CAA0B;IAC5C,gBAAgB,iBAAsB,kBAAkB,KAAK,IAAI,EAAI;IAC5E;;;;;;OAMG;gBACS,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,aAAa;IAUvE,IAAW,OAAO,kBAA4B;IAC9C,IAAW,UAAU,IAEa,aAAa,CAFK;IAEpD,IAAW,UAAU,CAAC,UAAU,EAAE,aAAa,EAG9C;IAED,OAAO,CAAC,KAAK;YAMC,iCAAiC;IA0C/C;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC;CAkBjF"}

package/lib/cjs/SchemaFormatsProvider.js

@@ -0,0 +1,146 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaFormatsProvider = void 0;
+const Context_1 = require("./Context");
+const SchemaKey_1 = require("./SchemaKey");
+const SchemaItem_1 = require("./Metadata/SchemaItem");
+const Format_1 = require("./Metadata/Format");
+const core_bentley_1 = require("@itwin/core-bentley");
+const KindOfQuantity_1 = require("./Metadata/KindOfQuantity");
+const OverrideFormat_1 = require("./Metadata/OverrideFormat");
+/**
+ * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.
+ * @beta
+ */
+class SchemaFormatsProvider {
+    _context;
+    _unitSystem;
+    _formatsRetrieved = new Set();
+    onFormatsChanged = new core_bentley_1.BeEvent();
+    /**
+     *
+     * @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 unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.
+     */
+    constructor(contextOrLocater, unitSystem) {
+        if (contextOrLocater instanceof Context_1.SchemaContext) {
+            this._context = contextOrLocater;
+        }
+        else {
+            this._context = new Context_1.SchemaContext();
+            this._context.addLocater(contextOrLocater);
+        }
+        this._unitSystem = unitSystem;
+    }
+    get context() { return this._context; }
+    get unitSystem() { return this._unitSystem; }
+    set unitSystem(unitSystem) {
+        this._unitSystem = unitSystem;
+        this.clear();
+    }
+    clear() {
+        const formatsChanged = Array.from(this._formatsRetrieved);
+        this._formatsRetrieved.clear();
+        this.onFormatsChanged.raiseEvent({ formatsChanged });
+    }
+    async getKindOfQuantityFormatFromSchema(itemKey) {
+        const kindOfQuantity = await this._context.getSchemaItem(itemKey, KindOfQuantity_1.KindOfQuantity);
+        if (!kindOfQuantity) {
+            return undefined;
+        }
+        // Find the first presentation format that matches the provided unit system.
+        const unitSystemGroupNames = getUnitSystemGroupNames(this._unitSystem);
+        const presentationFormats = kindOfQuantity.presentationFormats;
+        for (const system of unitSystemGroupNames) {
+            for (const lazyFormat of presentationFormats) {
+                const format = await lazyFormat;
+                const unit = await (format.units && format.units[0][0]);
+                if (!unit) {
+                    continue;
+                }
+                const currentUnitSystem = unit.unitSystem;
+                if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system) {
+                    this._formatsRetrieved.add(itemKey.fullName);
+                    return (0, OverrideFormat_1.getFormatProps)(format);
+                }
+            }
+        }
+        // If no matching presentation format was found, use persistence unit format if it matches unit system.
+        const persistenceUnit = await kindOfQuantity.persistenceUnit;
+        const persistenceUnitSystem = await persistenceUnit?.unitSystem;
+        if (persistenceUnitSystem && unitSystemGroupNames.includes(persistenceUnitSystem.name.toUpperCase())) {
+            this._formatsRetrieved.add(itemKey.fullName);
+            return getPersistenceUnitFormatProps(persistenceUnit);
+        }
+        const defaultFormat = kindOfQuantity.defaultPresentationFormat;
+        if (!defaultFormat) {
+            return undefined;
+        }
+        this._formatsRetrieved.add(itemKey.fullName);
+        return (0, OverrideFormat_1.getFormatProps)(await defaultFormat);
+    }
+    /**
+     * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.
+     * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.
+     * Else, the default presentation format will be retrieved.
+     * @param name The full name of the Format or KindOfQuantity.
+     * @returns
+     */
+    async getFormat(name) {
+        const [schemaName, schemaItemName] = SchemaItem_1.SchemaItem.parseFullName(name);
+        const schemaKey = new SchemaKey_1.SchemaKey(schemaName);
+        const schema = await this._context.getSchema(schemaKey);
+        if (!schema) {
+            return undefined;
+        }
+        const itemKey = new SchemaKey_1.SchemaItemKey(schemaItemName, schema.schemaKey);
+        if (schema.name === "Formats") {
+            const format = await this._context.getSchemaItem(itemKey, Format_1.Format);
+            if (!format) {
+                return undefined;
+            }
+            return format.toJSON(true);
+        }
+        return this.getKindOfQuantityFormatFromSchema(itemKey);
+    }
+}
+exports.SchemaFormatsProvider = SchemaFormatsProvider;
+function getUnitSystemGroupNames(unitSystem) {
+    switch (unitSystem) {
+        case "imperial":
+            return ["IMPERIAL", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "metric":
+            return ["SI", "METRIC", "INTERNATIONAL", "FINANCE"];
+        case "usCustomary":
+            return ["USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "usSurvey":
+            return ["USSURVEY", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+    }
+    return [];
+}
+function getPersistenceUnitFormatProps(persistenceUnit) {
+    // Same as Format "DefaultRealU" in Formats ecschema
+    return {
+        formatTraits: ["keepSingleZero", "keepDecimalPoint", "showUnitLabel"],
+        precision: 6,
+        type: "Decimal",
+        composite: {
+            units: [
+                {
+                    name: persistenceUnit.fullName,
+                    label: persistenceUnit.label,
+                },
+            ],
+        },
+    };
+}
+//# sourceMappingURL=SchemaFormatsProvider.js.map