@itwin/ecschema-metadata 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/Metadata/Format.js

@@ -9,14 +9,19 @@ import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils"
 import { SchemaItemType } from "../ECObjects";
 import { ECObjectsError, ECObjectsStatus } from "../Exception";
 import { BaseFormat, FormatTraits, formatTraitsToArray, FormatType, ShowSignOption, } from "@itwin/core-quantity";
+import { InvertedUnit } from "./InvertedUnit";
 import { SchemaItem } from "./SchemaItem";
+import { Unit } from "./Unit";
 /**
  * @beta
  */
 export class Format extends SchemaItem {
+    schemaItemType = Format.schemaItemType;
+    static get schemaItemType() { return SchemaItemType.Format; }
+    _base;
+    _units;
     constructor(schema, name) {
         super(schema, name);
-        this.schemaItemType = SchemaItemType.Format;
         this._base = new BaseFormat(name);
     }
     get roundFactor() { return this._base.roundFactor; }
@@ -80,7 +85,7 @@ export class Format extends SchemaItem {
         // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation
         for (const unit of formatProps.composite.units) {
             const newUnit = this.schema.lookupItemSync(unit.name);
-            if (undefined === newUnit)
+            if (undefined === newUnit || (!Unit.isUnit(newUnit) && !InvertedUnit.isInvertedUnit(newUnit)))
                 throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
             this.addUnit(newUnit, unit.label);
         }
@@ -93,7 +98,7 @@ export class Format extends SchemaItem {
         // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation
         for (const unit of formatProps.composite.units) {
             const newUnit = await this.schema.lookupItem(unit.name);
-            if (undefined === newUnit)
+            if (undefined === newUnit || (!Unit.isUnit(newUnit) && !InvertedUnit.isInvertedUnit(newUnit)))
                 throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
             this.addUnit(newUnit, unit.label);
         }
@@ -228,6 +233,66 @@ export class Format extends SchemaItem {
     setStationSeparator(separator) {
         this._base.stationSeparator = separator;
     }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setStationOffsetSize(stationOffsetSize) {
+        this._base.stationOffsetSize = stationOffsetSize;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setScientificType(scientificType) {
+        this._base.scientificType = scientificType;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setMinWidth(minWidth) {
+        this._base.minWidth = minWidth;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setSpacer(spacer) {
+        this._base.spacer = spacer;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setIncludeZero(includeZero) {
+        this._base.includeZero = includeZero;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setFormatTraits(formatTraits) {
+        this._base.formatTraits = formatTraits;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setUnits(units) {
+        this._units = units;
+    }
+    /** Type guard to check if the SchemaItem is of type Format.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a Format, false otherwise.
+     */
+    static isFormat(item) {
+        if (item && item.schemaItemType === SchemaItemType.Format)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type Format.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Format if it is a Format, undefined otherwise.
+     */
+    static assertIsFormat(item) {
+        if (!this.isFormat(item))
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Format}' (Format)`);
+    }
 }
 /**
  * @internal

package/lib/esm/Metadata/Format.js.map

@@ -1 +1 @@
-{"version":3,"file":"Format.js","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EACL,UAAU,EAAoB,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAC3D,cAAc,GAC/B,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,UAAU;IAKpC,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC;QAE5C,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACzD,IAAW,SAAS,KAA6C,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/F,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzE,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IACjF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC/E,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IACrE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC3F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAC3E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAChF,IAAW,KAAK,KAAmE,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhG,iBAAiB,CAAC,oBAAuC;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;IAC5D,CAAC;IAEM,cAAc,CAAC,WAAyB;QAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACO,OAAO,CAAC,IAAyB,EAAE,KAAc;QACzD,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;aACd,CAAC,CAAC,0CAA0C;YAC/C,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE;oBACxE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,0BAA0B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,2EAA2E;YAChN,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAClC,CAAC;IAES,YAAY,CAAC,SAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC;IAEvE,SAAS,CAAC,WAAkC;QAClD,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAE7C,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,wEAAwE;YACjH,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,CAAC,WAAW;gBACjD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC;YAE7D,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;gBAC/C,IAAI,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;oBACzC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,qGAAqG,CAAC,CAAC;gBAC5L,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC;YACnD,CAAC;YAED,+BAA+B;YAC/B,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBACnF,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,kEAAkE,CAAC,CAAC;QAC3J,CAAC;IACH,CAAC;IAEe,YAAY,CAAC,WAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS;YACrC,OAAO;QAET,8HAA8H;QAC9H,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAsB,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,SAAS,KAAK,OAAO;gBACvB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,WAAkC;QAC/D,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS;YACrC,OAAO;QAET,8HAA8H;QAC9H,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAsB,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7E,IAAI,SAAS,KAAK,OAAO;gBACvB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,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,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC5B,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,sBAAsB;QACtB,4BAA4B;QAE5B,oHAAoH;QACpH,IAAI,GAAG,KAAK,IAAI,CAAC,WAAW;YAC1B,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,cAAc,CAAC,YAAY,KAAK,IAAI,CAAC,cAAc;YACrD,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAClD,IAAI,YAAY,CAAC,aAAa,KAAK,IAAI,CAAC,YAAY;YAClD,UAAU,CAAC,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI,GAAG,KAAK,IAAI,CAAC,gBAAgB;YAC/B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACtD,IAAI,GAAG,KAAK,IAAI,CAAC,iBAAiB;YAChC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACxD,IAAI,GAAG,KAAK,IAAI,CAAC,YAAY;YAC3B,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAE9C,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEtC,IAAI,UAAU,CAAC,UAAU,KAAK,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YAC1E,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAElD,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;gBACtC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;YACxD,IAAI,GAAG,KAAK,IAAI,CAAC,gBAAgB;gBAC/B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACxD,CAAC;QAED,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,OAAO,UAAU,CAAC;QAEpB,UAAU,CAAC,SAAS,GAAG,EAAE,CAAC;QAE1B,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM;YACrB,UAAU,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE5C,IAAI,IAAI,KAAK,IAAI,CAAC,WAAW;YAC3B,UAAU,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEtD,UAAU,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE,CAAC;QAChC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC9B,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;gBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;aACf,CAAC,CAAC;QACL,CAAC;QAED,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;QACjD,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,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,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAChE,WAAW,CAAC,YAAY,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpE,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACtE,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,WAAW,CAAC,YAAY,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEpE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACnC,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAClE,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;YACtC,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEnF,MAAM,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC;YACzB,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEnE,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAC9D,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;gBAC3B,gBAAgB,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACvD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;gBAChC,gBAAgB,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE5E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;gBACnC,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACpD,IAAI,SAAS,KAAK,KAAK;oBACrB,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/F,WAAW,CAAC,WAAW,GAAG,QAAQ,CAAC;gBACnC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;YAEH,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,UAAsB;QAC5C,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAmB;QAC1C,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACvC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,UAA0B;QACpD,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,UAAU,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAiB;QAC7C,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,oBAAoB,CAAC,SAAiB;QAC9C,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,eAAe,CAAC,SAAiB;QACzC,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAiB;QAC7C,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAC1C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,aAAc,SAAQ,MAAM;CAWjD","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 { SchemaItemFormatProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport {\r\n  BaseFormat, DecimalPrecision, FormatTraits, formatTraitsToArray, FormatType, FractionalPrecision,\r\n  ScientificType, ShowSignOption,\r\n} from \"@itwin/core-quantity\";\r\nimport { InvertedUnit } from \"./InvertedUnit\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { Unit } from \"./Unit\";\r\n\r\n/**\r\n * @beta\r\n */\r\nexport class Format extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.Format;\r\n  protected _base: BaseFormat;\r\n  protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.Format;\r\n\r\n    this._base = new BaseFormat(name);\r\n  }\r\n\r\n  public get roundFactor(): number { return this._base.roundFactor; }\r\n  public get type(): FormatType { return this._base.type; }\r\n  public get precision(): DecimalPrecision | FractionalPrecision { return this._base.precision; }\r\n  public get minWidth(): number | undefined { return this._base.minWidth; }\r\n  public get scientificType(): ScientificType | undefined { return this._base.scientificType; }\r\n  public get showSignOption(): ShowSignOption { return this._base.showSignOption; }\r\n  public get decimalSeparator(): string { return this._base.decimalSeparator; }\r\n  public get thousandSeparator(): string { return this._base.thousandSeparator; }\r\n  public get uomSeparator(): string { return this._base.uomSeparator; }\r\n  public get stationSeparator(): string { return this._base.stationSeparator; }\r\n  public get stationOffsetSize(): number | undefined { return this._base.stationOffsetSize; }\r\n  public get formatTraits(): FormatTraits { return this._base.formatTraits; }\r\n  public get spacer(): string | undefined { return this._base.spacer; }\r\n  public get includeZero(): boolean | undefined { return this._base.includeZero; }\r\n  public get units(): Array<[Unit | InvertedUnit, string | undefined]> | undefined { return this._units; }\r\n\r\n  private parseFormatTraits(formatTraitsFromJson: string | string[]) {\r\n    return this._base.parseFormatTraits(formatTraitsFromJson);\r\n  }\r\n\r\n  public hasFormatTrait(formatTrait: FormatTraits) {\r\n    return this._base.hasFormatTraitSet(formatTrait);\r\n  }\r\n\r\n  /**\r\n   * Adds a Unit, or InvertedUnit, with an optional label override.\r\n   * @param unit The Unit, or InvertedUnit, to add to this Format.\r\n   * @param label A label that overrides the label defined within the Unit when a value is formatted.\r\n   */\r\n  protected addUnit(unit: Unit | InvertedUnit, label?: string) {\r\n    if (undefined === this._units)\r\n      this._units = [];\r\n    else { // Validate that a duplicate is not added.\r\n      for (const existingUnit of this._units) {\r\n        if (unit.fullName.toLowerCase() === existingUnit[0].fullName.toLowerCase())\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has duplicate units, '${unit.fullName}'.`); // TODO: Validation - this should be a validation error not a hard failure.\r\n      }\r\n    }\r\n\r\n    this._units.push([unit, label]);\r\n  }\r\n\r\n  protected setPrecision(precision: number) { this._base.precision = precision; }\r\n\r\n  private typecheck(formatProps: SchemaItemFormatProps) {\r\n    this._base.loadFormatProperties(formatProps);\r\n\r\n    if (undefined !== formatProps.composite) { // TODO: This is duplicated below when the units need to be processed...\r\n      if (undefined !== formatProps.composite.includeZero)\r\n        this._base.includeZero = formatProps.composite.includeZero;\r\n\r\n      if (undefined !== formatProps.composite.spacer) {\r\n        if (formatProps.composite.spacer.length > 1)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has a composite with an invalid 'spacer' attribute. It should be an empty or one character string.`);\r\n        this._base.spacer = formatProps.composite.spacer;\r\n      }\r\n\r\n      // Composite requires 1-4 units\r\n      if (formatProps.composite.units.length <= 0 || formatProps.composite.units.length > 4)\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);\r\n    }\r\n  }\r\n\r\n  public override fromJSONSync(formatProps: SchemaItemFormatProps) {\r\n    super.fromJSONSync(formatProps);\r\n    this.typecheck(formatProps);\r\n    if (undefined === formatProps.composite)\r\n      return;\r\n\r\n    // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation\r\n    for (const unit of formatProps.composite.units) {\r\n      const newUnit = this.schema.lookupItemSync<Unit | InvertedUnit>(unit.name);\r\n      if (undefined === newUnit)\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\r\n      this.addUnit(newUnit, unit.label);\r\n    }\r\n  }\r\n\r\n  public override async fromJSON(formatProps: SchemaItemFormatProps) {\r\n    await super.fromJSON(formatProps);\r\n    this.typecheck(formatProps);\r\n    if (undefined === formatProps.composite)\r\n      return;\r\n\r\n    // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation\r\n    for (const unit of formatProps.composite.units) {\r\n      const newUnit = await this.schema.lookupItem<Unit | InvertedUnit>(unit.name);\r\n      if (undefined === newUnit)\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\r\n      this.addUnit(newUnit, unit.label);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Save this Format'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): SchemaItemFormatProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.type = this.type;\r\n    schemaJson.precision = this.precision;\r\n\r\n    // this._spacer = \" \";\r\n    // this._includeZero = true;\r\n\r\n    // Serialize the minimal amount of information needed so anything that is the same as the default, do not serialize.\r\n    if (0.0 !== this.roundFactor)\r\n      schemaJson.roundFactor = this.roundFactor;\r\n    if (ShowSignOption.OnlyNegative !== this.showSignOption)\r\n      schemaJson.showSignOption = this.showSignOption;\r\n    if (FormatTraits.Uninitialized !== this.formatTraits)\r\n      schemaJson.formatTraits = formatTraitsToArray(this.formatTraits);\r\n    if (\".\" !== this.decimalSeparator)\r\n      schemaJson.decimalSeparator = this.decimalSeparator;\r\n    if (\",\" !== this.thousandSeparator)\r\n      schemaJson.thousandSeparator = this.thousandSeparator;\r\n    if (\" \" !== this.uomSeparator)\r\n      schemaJson.uomSeparator = this.uomSeparator;\r\n\r\n    if (undefined !== this.minWidth)\r\n      schemaJson.minWidth = this.minWidth;\r\n\r\n    if (FormatType.Scientific === this.type && undefined !== this.scientificType)\r\n      schemaJson.scientificType = this.scientificType;\r\n\r\n    if (FormatType.Station === this.type) {\r\n      if (undefined !== this.stationOffsetSize)\r\n        schemaJson.stationOffsetSize = this.stationOffsetSize;\r\n      if (\" \" !== this.stationSeparator)\r\n        schemaJson.stationSeparator = this.stationSeparator;\r\n    }\r\n\r\n    if (undefined === this.units)\r\n      return schemaJson;\r\n\r\n    schemaJson.composite = {};\r\n\r\n    if (\" \" !== this.spacer)\r\n      schemaJson.composite.spacer = this.spacer;\r\n\r\n    if (true !== this.includeZero)\r\n      schemaJson.composite.includeZero = this.includeZero;\r\n\r\n    schemaJson.composite.units = [];\r\n    for (const unit of this.units) {\r\n      schemaJson.composite.units.push({\r\n        name: unit[0].fullName,\r\n        label: unit[1],\r\n      });\r\n    }\r\n\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    itemElement.setAttribute(\"type\", this.type.toLowerCase());\r\n    itemElement.setAttribute(\"precision\", this.precision.toString());\r\n    itemElement.setAttribute(\"roundFactor\", this.roundFactor.toString());\r\n    itemElement.setAttribute(\"showSignOption\", this.showSignOption);\r\n    itemElement.setAttribute(\"decimalSeparator\", this.decimalSeparator);\r\n    itemElement.setAttribute(\"thousandSeparator\", this.thousandSeparator);\r\n    itemElement.setAttribute(\"uomSeparator\", this.uomSeparator);\r\n    itemElement.setAttribute(\"stationSeparator\", this.stationSeparator);\r\n\r\n    if (undefined !== this.minWidth)\r\n      itemElement.setAttribute(\"minWidth\", this.minWidth.toString());\r\n    if (undefined !== this.scientificType)\r\n      itemElement.setAttribute(\"scientificType\", this.scientificType);\r\n    if (undefined !== this.stationOffsetSize)\r\n      itemElement.setAttribute(\"stationOffsetSize\", this.stationOffsetSize.toString());\r\n\r\n    const formatTraits = formatTraitsToArray(this.formatTraits);\r\n    if (formatTraits.length > 0)\r\n      itemElement.setAttribute(\"formatTraits\", formatTraits.join(\"|\"));\r\n\r\n    if (undefined !== this.units) {\r\n      const compositeElement = schemaXml.createElement(\"Composite\");\r\n      if (undefined !== this.spacer)\r\n        compositeElement.setAttribute(\"spacer\", this.spacer);\r\n      if (undefined !== this.includeZero)\r\n        compositeElement.setAttribute(\"includeZero\", this.includeZero.toString());\r\n\r\n      this.units.forEach(([unit, label]) => {\r\n        const unitElement = schemaXml.createElement(\"Unit\");\r\n        if (undefined !== label)\r\n          unitElement.setAttribute(\"label\", label);\r\n        const unitName = XmlSerializationUtils.createXmlTypedName(this.schema, unit.schema, unit.name);\r\n        unitElement.textContent = unitName;\r\n        compositeElement.appendChild(unitElement);\r\n      });\r\n\r\n      itemElement.appendChild(compositeElement);\r\n    }\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setFormatType(formatType: FormatType) {\r\n    this._base.type = formatType;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setRoundFactor(roundFactor: number) {\r\n    this._base.roundFactor = roundFactor;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setShowSignOption(signOption: ShowSignOption) {\r\n    this._base.showSignOption = signOption;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setDecimalSeparator(separator: string) {\r\n    this._base.decimalSeparator = separator;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setThousandSeparator(separator: string) {\r\n    this._base.thousandSeparator = separator;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setUomSeparator(separator: string) {\r\n    this._base.uomSeparator = separator;\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setStationSeparator(separator: string) {\r\n    this._base.stationSeparator = separator;\r\n  }\r\n}\r\n\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableFormat extends Format {\r\n  public abstract override addUnit(unit: Unit | InvertedUnit, label?: string): void;\r\n  public abstract override setPrecision(precision: number): void;\r\n  public abstract override setFormatType(formatType: FormatType): void;\r\n  public abstract override setRoundFactor(roundFactor: number): void;\r\n  public abstract override setShowSignOption(signOption: ShowSignOption): void;\r\n  public abstract override setDecimalSeparator(separator: string): void;\r\n  public abstract override setThousandSeparator(separator: string): void;\r\n  public abstract override setUomSeparator(separator: string): void;\r\n  public abstract override setStationSeparator(separator: string): void;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}
+{"version":3,"file":"Format.js","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EACL,UAAU,EAAoB,YAAY,EAAE,mBAAmB,EAAE,UAAU,EAC3D,cAAc,GAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,UAAU;IACX,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IACzD,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,KAAK,CAAa;IAClB,MAAM,CAAoD;IAEpE,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,IAAW,WAAW,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,IAAW,IAAI,KAAiB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACzD,IAAW,SAAS,KAA6C,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/F,IAAW,QAAQ,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzE,IAAW,cAAc,KAAiC,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7F,IAAW,cAAc,KAAqB,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IACjF,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,IAAW,iBAAiB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC/E,IAAW,YAAY,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IACrE,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7E,IAAW,iBAAiB,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC3F,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAC3E,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACrE,IAAW,WAAW,KAA0B,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAChF,IAAW,KAAK,KAAmE,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhG,iBAAiB,CAAC,oBAAuC;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;IAC5D,CAAC;IAEM,cAAc,CAAC,WAAyB;QAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACO,OAAO,CAAC,IAAyB,EAAE,KAAc;QACzD,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;YAC3B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;aACd,CAAC,CAAC,0CAA0C;YAC/C,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE;oBACxE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,0BAA0B,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,2EAA2E;YAChN,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAClC,CAAC;IAES,YAAY,CAAC,SAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC;IAEvE,SAAS,CAAC,WAAkC;QAClD,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAE7C,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,wEAAwE;YACjH,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,CAAC,WAAW;gBACjD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC;YAE7D,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;gBAC/C,IAAI,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;oBACzC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,qGAAqG,CAAC,CAAC;gBAC5L,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC;YACnD,CAAC;YAED,+BAA+B;YAC/B,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBACnF,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,cAAc,IAAI,CAAC,QAAQ,kEAAkE,CAAC,CAAC;QAC3J,CAAC;IACH,CAAC;IAEe,YAAY,CAAC,WAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAChC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS;YACrC,OAAO;QAET,8HAA8H;QAC9H,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC3F,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,WAAkC;QAC/D,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAC5B,IAAI,SAAS,KAAK,WAAW,CAAC,SAAS;YACrC,OAAO;QAET,8HAA8H;QAC9H,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxD,IAAI,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC3F,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,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,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC5B,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEtC,sBAAsB;QACtB,4BAA4B;QAE5B,oHAAoH;QACpH,IAAI,GAAG,KAAK,IAAI,CAAC,WAAW;YAC1B,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5C,IAAI,cAAc,CAAC,YAAY,KAAK,IAAI,CAAC,cAAc;YACrD,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAClD,IAAI,YAAY,CAAC,aAAa,KAAK,IAAI,CAAC,YAAY;YAClD,UAAU,CAAC,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACnE,IAAI,GAAG,KAAK,IAAI,CAAC,gBAAgB;YAC/B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACtD,IAAI,GAAG,KAAK,IAAI,CAAC,iBAAiB;YAChC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACxD,IAAI,GAAG,KAAK,IAAI,CAAC,YAAY;YAC3B,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAE9C,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEtC,IAAI,UAAU,CAAC,UAAU,KAAK,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YAC1E,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAElD,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;gBACtC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;YACxD,IAAI,GAAG,KAAK,IAAI,CAAC,gBAAgB;gBAC/B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACxD,CAAC;QAED,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK;YAC1B,OAAO,UAAU,CAAC;QAEpB,UAAU,CAAC,SAAS,GAAG,EAAE,CAAC;QAE1B,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM;YACrB,UAAU,CAAC,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE5C,IAAI,IAAI,KAAK,IAAI,CAAC,WAAW;YAC3B,UAAU,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEtD,UAAU,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE,CAAC;QAChC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC9B,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;gBACtB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;aACf,CAAC,CAAC;QACL,CAAC;QAED,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;QACjD,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,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,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAChE,WAAW,CAAC,YAAY,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACpE,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACtE,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,WAAW,CAAC,YAAY,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEpE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACnC,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAClE,IAAI,SAAS,KAAK,IAAI,CAAC,iBAAiB;YACtC,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEnF,MAAM,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5D,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC;YACzB,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEnE,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAC9D,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM;gBAC3B,gBAAgB,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACvD,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW;gBAChC,gBAAgB,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE5E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;gBACnC,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACpD,IAAI,SAAS,KAAK,KAAK;oBACrB,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/F,WAAW,CAAC,WAAW,GAAG,QAAQ,CAAC;gBACnC,gBAAgB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;YAEH,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,UAAsB;QAC5C,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAmB;QAC1C,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACvC,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,UAA0B;QACpD,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,UAAU,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAiB;QAC7C,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,oBAAoB,CAAC,SAAiB;QAC9C,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,eAAe,CAAC,SAAiB;QACzC,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,SAAiB;QAC7C,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAC1C,CAAC;IAED;;OAEG;IACO,oBAAoB,CAAC,iBAAyB;QACtD,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IACnD,CAAC;IAED;;OAEG;IACO,iBAAiB,CAAC,cAA8B;QACxD,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC;IAC7C,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAgB;QACpC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACjC,CAAC;IAED;;OAEG;IACO,SAAS,CAAC,MAAc;QAChC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;IAC7B,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,WAAoB;QAC3C,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACvC,CAAC;IAED;;OAEG;IACO,eAAe,CAAC,YAA0B;QAClD,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,KAAuD;QACxE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAiB;QACxC,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,MAAM;YACvD,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,IAAiB;QAC5C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YACtB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,MAAM,YAAY,CAAC,CAAC;IACpH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,aAAc,SAAQ,MAAM;CAWjD","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 { SchemaItemFormatProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport {\n  BaseFormat, DecimalPrecision, FormatTraits, formatTraitsToArray, FormatType, FractionalPrecision,\n  ScientificType, ShowSignOption,\n} from \"@itwin/core-quantity\";\nimport { InvertedUnit } from \"./InvertedUnit\";\nimport { Schema } from \"./Schema\";\nimport { SchemaItem } from \"./SchemaItem\";\nimport { Unit } from \"./Unit\";\n\n/**\n * @beta\n */\nexport class Format extends SchemaItem {\n  public override readonly schemaItemType = Format.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.Format; }\n  protected _base: BaseFormat;\n  protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;\n\n  constructor(schema: Schema, name: string) {\n    super(schema, name);\n    this._base = new BaseFormat(name);\n  }\n\n  public get roundFactor(): number { return this._base.roundFactor; }\n  public get type(): FormatType { return this._base.type; }\n  public get precision(): DecimalPrecision | FractionalPrecision { return this._base.precision; }\n  public get minWidth(): number | undefined { return this._base.minWidth; }\n  public get scientificType(): ScientificType | undefined { return this._base.scientificType; }\n  public get showSignOption(): ShowSignOption { return this._base.showSignOption; }\n  public get decimalSeparator(): string { return this._base.decimalSeparator; }\n  public get thousandSeparator(): string { return this._base.thousandSeparator; }\n  public get uomSeparator(): string { return this._base.uomSeparator; }\n  public get stationSeparator(): string { return this._base.stationSeparator; }\n  public get stationOffsetSize(): number | undefined { return this._base.stationOffsetSize; }\n  public get formatTraits(): FormatTraits { return this._base.formatTraits; }\n  public get spacer(): string | undefined { return this._base.spacer; }\n  public get includeZero(): boolean | undefined { return this._base.includeZero; }\n  public get units(): Array<[Unit | InvertedUnit, string | undefined]> | undefined { return this._units; }\n\n  private parseFormatTraits(formatTraitsFromJson: string | string[]) {\n    return this._base.parseFormatTraits(formatTraitsFromJson);\n  }\n\n  public hasFormatTrait(formatTrait: FormatTraits) {\n    return this._base.hasFormatTraitSet(formatTrait);\n  }\n\n  /**\n   * Adds a Unit, or InvertedUnit, with an optional label override.\n   * @param unit The Unit, or InvertedUnit, to add to this Format.\n   * @param label A label that overrides the label defined within the Unit when a value is formatted.\n   */\n  protected addUnit(unit: Unit | InvertedUnit, label?: string) {\n    if (undefined === this._units)\n      this._units = [];\n    else { // Validate that a duplicate is not added.\n      for (const existingUnit of this._units) {\n        if (unit.fullName.toLowerCase() === existingUnit[0].fullName.toLowerCase())\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has duplicate units, '${unit.fullName}'.`); // TODO: Validation - this should be a validation error not a hard failure.\n      }\n    }\n\n    this._units.push([unit, label]);\n  }\n\n  protected setPrecision(precision: number) { this._base.precision = precision; }\n\n  private typecheck(formatProps: SchemaItemFormatProps) {\n    this._base.loadFormatProperties(formatProps);\n\n    if (undefined !== formatProps.composite) { // TODO: This is duplicated below when the units need to be processed...\n      if (undefined !== formatProps.composite.includeZero)\n        this._base.includeZero = formatProps.composite.includeZero;\n\n      if (undefined !== formatProps.composite.spacer) {\n        if (formatProps.composite.spacer.length > 1)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has a composite with an invalid 'spacer' attribute. It should be an empty or one character string.`);\n        this._base.spacer = formatProps.composite.spacer;\n      }\n\n      // Composite requires 1-4 units\n      if (formatProps.composite.units.length <= 0 || formatProps.composite.units.length > 4)\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);\n    }\n  }\n\n  public override fromJSONSync(formatProps: SchemaItemFormatProps) {\n    super.fromJSONSync(formatProps);\n    this.typecheck(formatProps);\n    if (undefined === formatProps.composite)\n      return;\n\n    // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation\n    for (const unit of formatProps.composite.units) {\n      const newUnit = this.schema.lookupItemSync(unit.name);\n      if (undefined === newUnit || (!Unit.isUnit(newUnit) && !InvertedUnit.isInvertedUnit(newUnit)))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\n      this.addUnit(newUnit, unit.label);\n    }\n  }\n\n  public override async fromJSON(formatProps: SchemaItemFormatProps) {\n    await super.fromJSON(formatProps);\n    this.typecheck(formatProps);\n    if (undefined === formatProps.composite)\n      return;\n\n    // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation\n    for (const unit of formatProps.composite.units) {\n      const newUnit = await this.schema.lookupItem(unit.name);\n      if (undefined === newUnit || (!Unit.isUnit(newUnit) && !InvertedUnit.isInvertedUnit(newUnit)))\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\n      this.addUnit(newUnit, unit.label);\n    }\n  }\n\n  /**\n   * Save this Format's properties to an object for serializing to JSON.\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\n   */\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): SchemaItemFormatProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.type = this.type;\n    schemaJson.precision = this.precision;\n\n    // this._spacer = \" \";\n    // this._includeZero = true;\n\n    // Serialize the minimal amount of information needed so anything that is the same as the default, do not serialize.\n    if (0.0 !== this.roundFactor)\n      schemaJson.roundFactor = this.roundFactor;\n    if (ShowSignOption.OnlyNegative !== this.showSignOption)\n      schemaJson.showSignOption = this.showSignOption;\n    if (FormatTraits.Uninitialized !== this.formatTraits)\n      schemaJson.formatTraits = formatTraitsToArray(this.formatTraits);\n    if (\".\" !== this.decimalSeparator)\n      schemaJson.decimalSeparator = this.decimalSeparator;\n    if (\",\" !== this.thousandSeparator)\n      schemaJson.thousandSeparator = this.thousandSeparator;\n    if (\" \" !== this.uomSeparator)\n      schemaJson.uomSeparator = this.uomSeparator;\n\n    if (undefined !== this.minWidth)\n      schemaJson.minWidth = this.minWidth;\n\n    if (FormatType.Scientific === this.type && undefined !== this.scientificType)\n      schemaJson.scientificType = this.scientificType;\n\n    if (FormatType.Station === this.type) {\n      if (undefined !== this.stationOffsetSize)\n        schemaJson.stationOffsetSize = this.stationOffsetSize;\n      if (\" \" !== this.stationSeparator)\n        schemaJson.stationSeparator = this.stationSeparator;\n    }\n\n    if (undefined === this.units)\n      return schemaJson;\n\n    schemaJson.composite = {};\n\n    if (\" \" !== this.spacer)\n      schemaJson.composite.spacer = this.spacer;\n\n    if (true !== this.includeZero)\n      schemaJson.composite.includeZero = this.includeZero;\n\n    schemaJson.composite.units = [];\n    for (const unit of this.units) {\n      schemaJson.composite.units.push({\n        name: unit[0].fullName,\n        label: unit[1],\n      });\n    }\n\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n    itemElement.setAttribute(\"type\", this.type.toLowerCase());\n    itemElement.setAttribute(\"precision\", this.precision.toString());\n    itemElement.setAttribute(\"roundFactor\", this.roundFactor.toString());\n    itemElement.setAttribute(\"showSignOption\", this.showSignOption);\n    itemElement.setAttribute(\"decimalSeparator\", this.decimalSeparator);\n    itemElement.setAttribute(\"thousandSeparator\", this.thousandSeparator);\n    itemElement.setAttribute(\"uomSeparator\", this.uomSeparator);\n    itemElement.setAttribute(\"stationSeparator\", this.stationSeparator);\n\n    if (undefined !== this.minWidth)\n      itemElement.setAttribute(\"minWidth\", this.minWidth.toString());\n    if (undefined !== this.scientificType)\n      itemElement.setAttribute(\"scientificType\", this.scientificType);\n    if (undefined !== this.stationOffsetSize)\n      itemElement.setAttribute(\"stationOffsetSize\", this.stationOffsetSize.toString());\n\n    const formatTraits = formatTraitsToArray(this.formatTraits);\n    if (formatTraits.length > 0)\n      itemElement.setAttribute(\"formatTraits\", formatTraits.join(\"|\"));\n\n    if (undefined !== this.units) {\n      const compositeElement = schemaXml.createElement(\"Composite\");\n      if (undefined !== this.spacer)\n        compositeElement.setAttribute(\"spacer\", this.spacer);\n      if (undefined !== this.includeZero)\n        compositeElement.setAttribute(\"includeZero\", this.includeZero.toString());\n\n      this.units.forEach(([unit, label]) => {\n        const unitElement = schemaXml.createElement(\"Unit\");\n        if (undefined !== label)\n          unitElement.setAttribute(\"label\", label);\n        const unitName = XmlSerializationUtils.createXmlTypedName(this.schema, unit.schema, unit.name);\n        unitElement.textContent = unitName;\n        compositeElement.appendChild(unitElement);\n      });\n\n      itemElement.appendChild(compositeElement);\n    }\n\n    return itemElement;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setFormatType(formatType: FormatType) {\n    this._base.type = formatType;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setRoundFactor(roundFactor: number) {\n    this._base.roundFactor = roundFactor;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setShowSignOption(signOption: ShowSignOption) {\n    this._base.showSignOption = signOption;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setDecimalSeparator(separator: string) {\n    this._base.decimalSeparator = separator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setThousandSeparator(separator: string) {\n    this._base.thousandSeparator = separator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setUomSeparator(separator: string) {\n    this._base.uomSeparator = separator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setStationSeparator(separator: string) {\n    this._base.stationSeparator = separator;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setStationOffsetSize(stationOffsetSize: number) {\n    this._base.stationOffsetSize = stationOffsetSize;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setScientificType(scientificType: ScientificType) {\n    this._base.scientificType = scientificType;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setMinWidth(minWidth: number) {\n    this._base.minWidth = minWidth;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setSpacer(spacer: string) {\n    this._base.spacer = spacer;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setIncludeZero(includeZero: boolean) {\n    this._base.includeZero = includeZero;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setFormatTraits(formatTraits: FormatTraits) {\n    this._base.formatTraits = formatTraits;\n  }\n\n  /**\n   * @alpha Used in schema editing.\n   */\n  protected setUnits(units: Array<[Unit | InvertedUnit, string | undefined]>) {\n    this._units = units;\n  }\n\n  /** Type guard to check if the SchemaItem is of type Format.\n   * @param item The SchemaItem to check.\n   * @returns True if the item is a Format, false otherwise.\n   */\n  public static isFormat(item?: SchemaItem): item is Format {\n  if (item && item.schemaItemType === SchemaItemType.Format)\n    return true;\n\n  return false;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type Format.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to Format if it is a Format, undefined otherwise.\n   */\n  public static assertIsFormat(item?: SchemaItem): asserts item is Format {\n    if (!this.isFormat(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Format}' (Format)`);\n  }\n}\n\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableFormat extends Format {\n  public abstract override addUnit(unit: Unit | InvertedUnit, label?: string): void;\n  public abstract override setPrecision(precision: number): void;\n  public abstract override setFormatType(formatType: FormatType): void;\n  public abstract override setRoundFactor(roundFactor: number): void;\n  public abstract override setShowSignOption(signOption: ShowSignOption): void;\n  public abstract override setDecimalSeparator(separator: string): void;\n  public abstract override setThousandSeparator(separator: string): void;\n  public abstract override setUomSeparator(separator: string): void;\n  public abstract override setStationSeparator(separator: string): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}

package/lib/esm/Metadata/InvertedUnit.d.ts

@@ -4,23 +4,28 @@
 import { InvertedUnitProps } from "../Deserialization/JsonProps";
 import { SchemaItemType } from "../ECObjects";
 import { LazyLoadedUnit, LazyLoadedUnitSystem } from "../Interfaces";
-import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
 /**
  * An InvertedUnit is a specific type of Unit that describes the inverse of a single Unit whose dimensional derivation is unit-less.
  * @beta
  */
 export declare class InvertedUnit extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.InvertedUnit;
+    readonly schemaItemType: SchemaItemType;
+    static get schemaItemType(): SchemaItemType;
     protected _invertsUnit?: LazyLoadedUnit;
     protected _unitSystem?: LazyLoadedUnitSystem;
-    constructor(schema: Schema, name: string);
     get invertsUnit(): LazyLoadedUnit | undefined;
     get unitSystem(): LazyLoadedUnitSystem | undefined;
     /**
      * @alpha
      */
     static isInvertedUnit(object: any): object is InvertedUnit;
+    /**
+     * Type assertion to check if the SchemaItem is of type InvertedUnit.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to InvertedUnit if it is an InvertedUnit, undefined otherwise.
+     */
+    static assertIsInvertedUnit(item?: SchemaItem): asserts item is InvertedUnit;
     /**
      * Save this InvertedUnit's properties to an object for serializing to JSON.
      * @param standalone Serialization includes only this object (as opposed to the full schema).

package/lib/esm/Metadata/InvertedUnit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InvertedUnit.d.ts","sourceRoot":"","sources":["../../../src/Metadata/InvertedUnit.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C;;;GAGG;AACH,qBAAa,YAAa,SAAQ,UAAU;IAC1C,SAAyB,cAAc,EAAG,cAAc,CAAC,YAAY,CAAC;IACtE,SAAS,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC;IACxC,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;gBAEjC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,WAAW,IAAI,cAAc,GAAG,SAAS,CAA8B;IAClF,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IAEtF;;OAEG;WACW,cAAc,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,YAAY;IAIjE;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,iBAAiB;IAO7G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAkBlD,YAAY,CAAC,iBAAiB,EAAE,iBAAiB;IAuB3C,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB;IAInE;;;OAGG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc;IAIpD;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,oBAAoB;CAGzD;AAED;;;GAGG;AACH,8BAAsB,mBAAoB,SAAQ,YAAY;aACnC,cAAc,CAAC,WAAW,EAAE,cAAc,GAAG,IAAI;aACjD,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,IAAI;aACrD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"InvertedUnit.d.ts","sourceRoot":"","sources":["../../../src/Metadata/InvertedUnit.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C;;;GAGG;AACH,qBAAa,YAAa,SAAQ,UAAU;IAC1C,SAAyB,cAAc,iBAA+B;IACtE,WAA2B,cAAc,mBAA0C;IACnF,SAAS,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC;IACxC,SAAS,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAE7C,IAAW,WAAW,IAAI,cAAc,GAAG,SAAS,CAA8B;IAClF,IAAW,UAAU,IAAI,oBAAoB,GAAG,SAAS,CAA6B;IAEtF;;OAEG;WACW,cAAc,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,YAAY;IAIjE;;;;OAIG;WACW,oBAAoB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,YAAY;IAKnF;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,iBAAiB;IAO7G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAkBlD,YAAY,CAAC,iBAAiB,EAAE,iBAAiB;IAuB3C,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB;IAInE;;;OAGG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,cAAc;IAIpD;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,oBAAoB;CAGzD;AAED;;;GAGG;AACH,8BAAsB,mBAAoB,SAAQ,YAAY;aACnC,cAAc,CAAC,WAAW,EAAE,cAAc,GAAG,IAAI;aACjD,aAAa,CAAC,UAAU,EAAE,oBAAoB,GAAG,IAAI;aACrD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/InvertedUnit.js

@@ -10,15 +10,17 @@ import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils"
 import { SchemaItemType } from "../ECObjects";
 import { ECObjectsError, ECObjectsStatus } from "../Exception";
 import { SchemaItem } from "./SchemaItem";
+import { Unit } from "./Unit";
+import { UnitSystem } from "./UnitSystem";
 /**
  * An InvertedUnit is a specific type of Unit that describes the inverse of a single Unit whose dimensional derivation is unit-less.
  * @beta
  */
 export class InvertedUnit extends SchemaItem {
-    constructor(schema, name) {
-        super(schema, name);
-        this.schemaItemType = SchemaItemType.InvertedUnit;
-    }
+    schemaItemType = InvertedUnit.schemaItemType;
+    static get schemaItemType() { return SchemaItemType.InvertedUnit; }
+    _invertsUnit; // required
+    _unitSystem; // required
     get invertsUnit() { return this._invertsUnit; }
     get unitSystem() { return this._unitSystem; }
     /**
@@ -27,6 +29,15 @@ export class InvertedUnit extends SchemaItem {
     static isInvertedUnit(object) {
         return SchemaItem.isSchemaItem(object) && object.schemaItemType === SchemaItemType.InvertedUnit;
     }
+    /**
+     * Type assertion to check if the SchemaItem is of type InvertedUnit.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to InvertedUnit if it is an InvertedUnit, undefined otherwise.
+     */
+    static assertIsInvertedUnit(item) {
+        if (!this.isInvertedUnit(item))
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.InvertedUnit}' (InvertedUnit)`);
+    }
     /**
      * Save this InvertedUnit's properties to an object for serializing to JSON.
      * @param standalone Serialization includes only this object (as opposed to the full schema).
@@ -57,7 +68,7 @@ export class InvertedUnit extends SchemaItem {
         super.fromJSONSync(invertedUnitProps);
         const unitSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.invertsUnit);
         this._invertsUnit = new DelayedPromiseWithProps(unitSchemaItemKey, async () => {
-            const invertsUnit = await this.schema.lookupItem(unitSchemaItemKey);
+            const invertsUnit = await this.schema.lookupItem(unitSchemaItemKey, Unit);
             if (undefined === invertsUnit)
                 throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the invertsUnit ${invertedUnitProps.invertsUnit}.`);
             return invertsUnit;
@@ -66,7 +77,7 @@ export class InvertedUnit extends SchemaItem {
         if (!unitSystemSchemaItemKey)
             throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);
         this._unitSystem = new DelayedPromiseWithProps(unitSystemSchemaItemKey, async () => {
-            const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey);
+            const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey, UnitSystem);
             if (undefined === unitSystem)
                 throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);
             return unitSystem;

package/lib/esm/Metadata/InvertedUnit.js.map

@@ -1 +1 @@
-{"version":3,"file":"InvertedUnit.js","sourceRoot":"","sources":["../../../src/Metadata/InvertedUnit.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAI/D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,UAAU;IAK1C,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,YAAY,CAAC;IACpD,CAAC;IAED,IAAW,WAAW,KAAiC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAClF,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEtF;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,MAAW;QACtC,OAAO,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,cAAc,KAAK,cAAc,CAAC,YAAY,CAAC;IAClG,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,WAAW,GAAG,IAAI,CAAC,WAAY,CAAC,QAAQ,CAAC;QACpD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,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,qBAAqB,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,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;QAC3C,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;YAC9B,MAAM,eAAe,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;YACpH,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,iBAAoC;QAC/D,KAAK,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACtF,IAAI,CAAC,YAAY,GAAG,IAAI,uBAAuB,CAAsB,iBAAiB,EACpF,KAAK,IAAI,EAAE;YACT,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAO,iBAAiB,CAAC,CAAC;YAC1E,IAAI,SAAS,KAAK,WAAW;gBAC3B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,oCAAoC,iBAAiB,CAAC,WAAW,GAAG,CAAC,CAAC;YAChI,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC,CAAC;QAEL,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC3F,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,iBAAiB,CAAC,UAAU,GAAG,CAAC,CAAC;QAC9H,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAuB,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,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,iBAAiB,CAAC,UAAU,GAAG,CAAC,CAAC;YAC9H,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,iBAAoC;QACjE,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACO,cAAc,CAAC,WAA2B;QAClD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,UAAgC;QACtD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,mBAAoB,SAAQ,YAAY;CAI7D","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 { InvertedUnitProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedUnit, LazyLoadedUnitSystem } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { Unit } from \"./Unit\";\r\nimport { UnitSystem } from \"./UnitSystem\";\r\n\r\n/**\r\n * An InvertedUnit is a specific type of Unit that describes the inverse of a single Unit whose dimensional derivation is unit-less.\r\n * @beta\r\n */\r\nexport class InvertedUnit extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.InvertedUnit;\r\n  protected _invertsUnit?: LazyLoadedUnit; // required\r\n  protected _unitSystem?: LazyLoadedUnitSystem; // required\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.InvertedUnit;\r\n  }\r\n\r\n  public get invertsUnit(): LazyLoadedUnit | undefined { return this._invertsUnit; }\r\n  public get unitSystem(): LazyLoadedUnitSystem | undefined { return this._unitSystem; }\r\n\r\n  /**\r\n   * @alpha\r\n   */\r\n  public static isInvertedUnit(object: any): object is InvertedUnit {\r\n    return SchemaItem.isSchemaItem(object) && object.schemaItemType === SchemaItemType.InvertedUnit;\r\n  }\r\n\r\n  /**\r\n   * Save this InvertedUnit'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): InvertedUnitProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.invertsUnit = this.invertsUnit!.fullName;\r\n    schemaJson.unitSystem = this.unitSystem!.fullName;\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 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    const invertsUnit = await this.invertsUnit;\r\n    if (undefined !== invertsUnit) {\r\n      const invertsUnitName = XmlSerializationUtils.createXmlTypedName(this.schema, invertsUnit.schema, invertsUnit.name);\r\n      itemElement.setAttribute(\"invertsUnit\", invertsUnitName);\r\n    }\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(invertedUnitProps: InvertedUnitProps) {\r\n    super.fromJSONSync(invertedUnitProps);\r\n    const unitSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.invertsUnit);\r\n    this._invertsUnit = new DelayedPromiseWithProps<SchemaItemKey, Unit>(unitSchemaItemKey,\r\n      async () => {\r\n        const invertsUnit = await this.schema.lookupItem<Unit>(unitSchemaItemKey);\r\n        if (undefined === invertsUnit)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the invertsUnit ${invertedUnitProps.invertsUnit}.`);\r\n        return invertsUnit;\r\n      });\r\n\r\n    const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.unitSystem);\r\n    if (!unitSystemSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.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 ${invertedUnitProps.unitSystem}.`);\r\n        return unitSystem;\r\n      });\r\n  }\r\n\r\n  public override async fromJSON(invertedUnitProps: InvertedUnitProps) {\r\n    this.fromJSONSync(invertedUnitProps);\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing\r\n   */\r\n  protected setInvertsUnit(invertsUnit: LazyLoadedUnit) {\r\n    this._invertsUnit = invertsUnit;\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing\r\n   */\r\n  protected setUnitSystem(unitSystem: LazyLoadedUnitSystem) {\r\n    this._unitSystem = unitSystem;\r\n  }\r\n}\r\n\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableInvertedUnit extends InvertedUnit {\r\n  public abstract override setInvertsUnit(invertsUnit: LazyLoadedUnit): void;\r\n  public abstract override setUnitSystem(unitSystem: LazyLoadedUnitSystem): void;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}
+{"version":3,"file":"InvertedUnit.js","sourceRoot":"","sources":["../../../src/Metadata/InvertedUnit.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,UAAU;IACjB,cAAc,GAAG,YAAY,CAAC,cAAc,CAAC;IAC/D,MAAM,KAAc,cAAc,KAAK,OAAO,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;IACzE,YAAY,CAAkB,CAAC,WAAW;IAC1C,WAAW,CAAwB,CAAC,WAAW;IAEzD,IAAW,WAAW,KAAiC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAClF,IAAW,UAAU,KAAuC,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEtF;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,MAAW;QACtC,OAAO,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,cAAc,KAAK,cAAc,CAAC,YAAY,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,IAAiB;QAClD,IAAG,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,qBAAqB,EAAE,aAAa,cAAc,CAAC,YAAY,kBAAkB,CAAC,CAAC;IAChI,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,WAAW,GAAG,IAAI,CAAC,WAAY,CAAC,QAAQ,CAAC;QACpD,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAW,CAAC,QAAQ,CAAC;QAClD,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,qBAAqB,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,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;QAC3C,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;YAC9B,MAAM,eAAe,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;YACpH,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,iBAAoC;QAC/D,KAAK,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACtF,IAAI,CAAC,YAAY,GAAG,IAAI,uBAAuB,CAAsB,iBAAiB,EACpF,KAAK,IAAI,EAAE;YACT,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;YAC1E,IAAI,SAAS,KAAK,WAAW;gBAC3B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,oCAAoC,iBAAiB,CAAC,WAAW,GAAG,CAAC,CAAC;YAChI,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC,CAAC;QAEL,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC3F,IAAI,CAAC,uBAAuB;YAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,iBAAiB,CAAC,UAAU,GAAG,CAAC,CAAC;QAC9H,IAAI,CAAC,WAAW,GAAG,IAAI,uBAAuB,CAA4B,uBAAuB,EAC/F,KAAK,IAAI,EAAE;YACT,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,UAAU,CAAC,CAAC;YACrF,IAAI,SAAS,KAAK,UAAU;gBAC1B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mCAAmC,iBAAiB,CAAC,UAAU,GAAG,CAAC,CAAC;YAC9H,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,iBAAoC;QACjE,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACO,cAAc,CAAC,WAA2B;QAClD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,UAAgC;QACtD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,mBAAoB,SAAQ,YAAY;CAI7D","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 { DelayedPromiseWithProps } from \"../DelayedPromise\";\nimport { InvertedUnitProps } from \"../Deserialization/JsonProps\";\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\nimport { LazyLoadedUnit, LazyLoadedUnitSystem } from \"../Interfaces\";\nimport { SchemaItemKey } from \"../SchemaKey\";\nimport { SchemaItem } from \"./SchemaItem\";\nimport { Unit } from \"./Unit\";\nimport { UnitSystem } from \"./UnitSystem\";\n\n/**\n * An InvertedUnit is a specific type of Unit that describes the inverse of a single Unit whose dimensional derivation is unit-less.\n * @beta\n */\nexport class InvertedUnit extends SchemaItem {\n  public override readonly schemaItemType = InvertedUnit.schemaItemType;\n  public static override get schemaItemType() { return SchemaItemType.InvertedUnit; }\n  protected _invertsUnit?: LazyLoadedUnit; // required\n  protected _unitSystem?: LazyLoadedUnitSystem; // required\n\n  public get invertsUnit(): LazyLoadedUnit | undefined { return this._invertsUnit; }\n  public get unitSystem(): LazyLoadedUnitSystem | undefined { return this._unitSystem; }\n\n  /**\n   * @alpha\n   */\n  public static isInvertedUnit(object: any): object is InvertedUnit {\n    return SchemaItem.isSchemaItem(object) && object.schemaItemType === SchemaItemType.InvertedUnit;\n  }\n\n  /**\n   * Type assertion to check if the SchemaItem is of type InvertedUnit.\n   * @param item The SchemaItem to check.\n   * @returns The item cast to InvertedUnit if it is an InvertedUnit, undefined otherwise.\n   */\n  public static assertIsInvertedUnit(item?: SchemaItem): asserts item is InvertedUnit {\n    if(!this.isInvertedUnit(item))\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.InvertedUnit}' (InvertedUnit)`);\n  }\n\n  /**\n   * Save this InvertedUnit's properties to an object for serializing to JSON.\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\n   */\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): InvertedUnitProps {\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\n    schemaJson.invertsUnit = this.invertsUnit!.fullName;\n    schemaJson.unitSystem = this.unitSystem!.fullName;\n    return schemaJson;\n  }\n\n  /** @internal */\n  public override async toXml(schemaXml: Document): Promise<Element> {\n    const itemElement = await super.toXml(schemaXml);\n\n    const unitSystem = await this.unitSystem;\n    if (undefined !== unitSystem) {\n      const unitSystemName = XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);\n      itemElement.setAttribute(\"unitSystem\", unitSystemName);\n    }\n\n    const invertsUnit = await this.invertsUnit;\n    if (undefined !== invertsUnit) {\n      const invertsUnitName = XmlSerializationUtils.createXmlTypedName(this.schema, invertsUnit.schema, invertsUnit.name);\n      itemElement.setAttribute(\"invertsUnit\", invertsUnitName);\n    }\n\n    return itemElement;\n  }\n\n  public override fromJSONSync(invertedUnitProps: InvertedUnitProps) {\n    super.fromJSONSync(invertedUnitProps);\n    const unitSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.invertsUnit);\n    this._invertsUnit = new DelayedPromiseWithProps<SchemaItemKey, Unit>(unitSchemaItemKey,\n      async () => {\n        const invertsUnit = await this.schema.lookupItem(unitSchemaItemKey, Unit);\n        if (undefined === invertsUnit)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the invertsUnit ${invertedUnitProps.invertsUnit}.`);\n        return invertsUnit;\n      });\n\n    const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.unitSystem);\n    if (!unitSystemSchemaItemKey)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);\n    this._unitSystem = new DelayedPromiseWithProps<SchemaItemKey, UnitSystem>(unitSystemSchemaItemKey,\n      async () => {\n        const unitSystem = await this.schema.lookupItem(unitSystemSchemaItemKey, UnitSystem);\n        if (undefined === unitSystem)\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);\n        return unitSystem;\n      });\n  }\n\n  public override async fromJSON(invertedUnitProps: InvertedUnitProps) {\n    this.fromJSONSync(invertedUnitProps);\n  }\n\n  /**\n   * @alpha\n   * Used for schema editing\n   */\n  protected setInvertsUnit(invertsUnit: LazyLoadedUnit) {\n    this._invertsUnit = invertsUnit;\n  }\n\n  /**\n   * @alpha\n   * Used for schema editing\n   */\n  protected setUnitSystem(unitSystem: LazyLoadedUnitSystem) {\n    this._unitSystem = unitSystem;\n  }\n}\n\n/**\n * @internal\n * An abstract class used for schema editing.\n */\nexport abstract class MutableInvertedUnit extends InvertedUnit {\n  public abstract override setInvertsUnit(invertsUnit: LazyLoadedUnit): void;\n  public abstract override setUnitSystem(unitSystem: LazyLoadedUnitSystem): void;\n  public abstract override setDisplayLabel(displayLabel: string): void;\n}\n"]}

package/lib/esm/Metadata/KindOfQuantity.d.ts

@@ -7,14 +7,14 @@ import { LazyLoadedInvertedUnit, LazyLoadedUnit } from "../Interfaces";
 import { Format } from "./Format";
 import { InvertedUnit } from "./InvertedUnit";
 import { OverrideFormat } from "./OverrideFormat";
-import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
 import { Unit } from "./Unit";
 /** A Typescript class representation of a KindOfQuantity.
  * @beta
  */
 export declare class KindOfQuantity extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.KindOfQuantity;
+    readonly schemaItemType: SchemaItemType;
+    static get schemaItemType(): SchemaItemType;
     protected _relativeError: number;
     protected _presentationFormats: Array<Format | OverrideFormat>;
     protected _persistenceUnit?: LazyLoadedUnit | LazyLoadedInvertedUnit;
@@ -25,7 +25,6 @@ export declare class KindOfQuantity extends SchemaItem {
     get persistenceUnit(): LazyLoadedUnit | LazyLoadedInvertedUnit | undefined;
     protected set persistenceUnit(value: LazyLoadedUnit | LazyLoadedInvertedUnit | undefined);
     get relativeError(): number;
-    constructor(schema: Schema, name: string);
     /**
      *
      * @param format The Format to add to this KindOfQuantity
@@ -55,6 +54,18 @@ export declare class KindOfQuantity extends SchemaItem {
      * Used for schema editing.
      */
     protected setRelativeError(relativeError: number): void;
+    /**
+     * Type guard to check if the SchemaItem is of type KindOfQuantity.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a KindOfQuantity, false otherwise.
+     */
+    static isKindOfQuantity(item?: SchemaItem): item is KindOfQuantity;
+    /**
+     * Type assertion to check if the SchemaItem is of type KindOfQuantity.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to KindOfQuantity if it is a KindOfQuantity, undefined otherwise.
+     */
+    static assertIsKindOfQuantity(item?: SchemaItem): asserts item is KindOfQuantity;
 }
 /**
  * @internal

package/lib/esm/Metadata/KindOfQuantity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KindOfQuantity.d.ts","sourceRoot":"","sources":["../../../src/Metadata/KindOfQuantity.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAuB,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAC5C,SAAyB,cAAc,EAAG,cAAc,CAAC,cAAc,CAAC;IACxE,SAAS,CAAC,cAAc,EAAE,MAAM,CAAO;IACvC,SAAS,CAAC,oBAAoB,EAAE,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC,CAAwC;IACtG,SAAS,CAAC,gBAAgB,CAAC,EAAE,cAAc,GAAG,sBAAsB,CAAC;IAErE,4DAA4D;IAC5D,IAAW,yBAAyB,IAAI,MAAM,GAAG,cAAc,GAAG,SAAS,CAAwC;IAEnH,sCAAsC;IACtC,IAAW,mBAAmB,IAAI,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC,CAAsC;IAEtG,IAAW,eAAe,IAAI,cAAc,GAAG,sBAAsB,GAAG,SAAS,CAAkC;IACnH,SAAS,KAAK,eAAe,CAAC,KAAK,EAAE,cAAc,GAAG,sBAAsB,GAAG,SAAS,EAAqC;IAE7H,IAAW,aAAa,WAAkC;gBAE9C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,EAAE,SAAS,GAAE,OAAe;IAK3F;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,cAAc;YAY3I,wBAAwB;IAkCtC,OAAO,CAAC,4BAA4B;IAkCpC;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,mBAAmB;IAS/G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBlD,YAAY,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,IAAI;IAiBtD,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBvF;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;CAGxD;AACD;;;GAGG;AACH,8BAAsB,qBAAsB,SAAQ,cAAc;aACvC,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;aAChF,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,cAAc;aAC/I,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"KindOfQuantity.d.ts","sourceRoot":"","sources":["../../../src/Metadata/KindOfQuantity.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAuB,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAC5C,SAAyB,cAAc,iBAAiC;IACxE,WAA2B,cAAc,mBAA4C;IACrF,SAAS,CAAC,cAAc,EAAE,MAAM,CAAO;IACvC,SAAS,CAAC,oBAAoB,EAAE,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC,CAAwC;IACtG,SAAS,CAAC,gBAAgB,CAAC,EAAE,cAAc,GAAG,sBAAsB,CAAC;IAErE,4DAA4D;IAC5D,IAAW,yBAAyB,IAAI,MAAM,GAAG,cAAc,GAAG,SAAS,CAAwC;IAEnH,sCAAsC;IACtC,IAAW,mBAAmB,IAAI,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC,CAAsC;IAEtG,IAAW,eAAe,IAAI,cAAc,GAAG,sBAAsB,GAAG,SAAS,CAAkC;IACnH,SAAS,KAAK,eAAe,CAAC,KAAK,EAAE,cAAc,GAAG,sBAAsB,GAAG,SAAS,EAAoC;IAE5H,IAAW,aAAa,WAAkC;IAE1D;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,EAAE,SAAS,GAAE,OAAe;IAK3F;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,cAAc;YAY3I,wBAAwB;IAkCtC,OAAO,CAAC,4BAA4B;IAkCpC;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,mBAAmB;IAS/G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBlD,YAAY,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,IAAI;IAoBtD,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBvF;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAIvD;;;;OAIG;WACW,gBAAgB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,cAAc;IAIzE;;;;OAIG;WACW,sBAAsB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,cAAc;CAIxF;AACD;;;GAGG;AACH,8BAAsB,qBAAsB,SAAQ,cAAc;aACvC,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI;aAChF,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,cAAc;aAC/I,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/KindOfQuantity.js

@@ -9,12 +9,20 @@ import { DelayedPromiseWithProps } from "../DelayedPromise";
 import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils";
 import { SchemaItemType } from "../ECObjects";
 import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { Format } from "./Format";
+import { InvertedUnit } from "./InvertedUnit";
 import { OverrideFormat } from "./OverrideFormat";
 import { SchemaItem } from "./SchemaItem";
+import { Unit } from "./Unit";
 /** A Typescript class representation of a KindOfQuantity.
  * @beta
  */
 export class KindOfQuantity extends SchemaItem {
+    schemaItemType = KindOfQuantity.schemaItemType;
+    static get schemaItemType() { return SchemaItemType.KindOfQuantity; }
+    _relativeError = 1.0;
+    _presentationFormats = new Array();
+    _persistenceUnit;
     /** The first presentation format in the list of Formats. */
     get defaultPresentationFormat() { return this.presentationFormats[0]; }
     /** A list of presentation formats. */
@@ -22,12 +30,6 @@ export class KindOfQuantity extends SchemaItem {
     get persistenceUnit() { return this._persistenceUnit; }
     set persistenceUnit(value) { this._persistenceUnit = value; }
     get relativeError() { return this._relativeError; }
-    constructor(schema, name) {
-        super(schema, name);
-        this._relativeError = 1.0;
-        this._presentationFormats = new Array();
-        this.schemaItemType = SchemaItemType.KindOfQuantity; // Needed to allow both run-time and compile-time check.
-    }
     /**
      *
      * @param format The Format to add to this KindOfQuantity
@@ -54,7 +56,7 @@ export class KindOfQuantity extends SchemaItem {
         const presUnitsArr = Array.isArray(presentationUnitsJson) ? presentationUnitsJson : presentationUnitsJson.split(";");
         for (const formatString of presUnitsArr) {
             const presFormatOverride = OverrideFormat.parseFormatString(formatString);
-            const format = await this.schema.lookupItem(presFormatOverride.name);
+            const format = await this.schema.lookupItem(presFormatOverride.name, Format);
             if (undefined === format || format.schemaItemType !== SchemaItemType.Format)
                 throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate Format '${presFormatOverride.name}' for the presentation unit on KindOfQuantity ${this.fullName}.`);
             if (undefined === presFormatOverride.precision && undefined === presFormatOverride.unitAndLabels) {
@@ -67,10 +69,10 @@ export class KindOfQuantity extends SchemaItem {
                     throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
                 unitAndLabels = [];
                 for (const unitOverride of presFormatOverride.unitAndLabels) {
-                    const unit = await this.schema.lookupItem(unitOverride[0]);
-                    if (undefined === unit)
+                    const unitOrInverted = await this.schema.lookupItem(unitOverride[0]);
+                    if (undefined === unitOrInverted || (!Unit.isUnit(unitOrInverted) && !InvertedUnit.isInvertedUnit(unitOrInverted)))
                         throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);
-                    unitAndLabels.push([unit, unitOverride[1]]);
+                    unitAndLabels.push([unitOrInverted, unitOverride[1]]);
                 }
             }
             const overrideFormat = this.createFormatOverride(format, presFormatOverride.precision, unitAndLabels);
@@ -81,7 +83,7 @@ export class KindOfQuantity extends SchemaItem {
         const presUnitsArr = Array.isArray(presentationUnitsJson) ? presentationUnitsJson : presentationUnitsJson.split(";");
         for (const formatString of presUnitsArr) {
             const presFormatOverride = OverrideFormat.parseFormatString(formatString);
-            const format = this.schema.lookupItemSync(presFormatOverride.name);
+            const format = this.schema.lookupItemSync(presFormatOverride.name, Format);
             if (undefined === format || format.schemaItemType !== SchemaItemType.Format)
                 throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate Format '${presFormatOverride.name}' for the presentation unit on KindOfQuantity ${this.fullName}.`);
             if (undefined === presFormatOverride.precision && undefined === presFormatOverride.unitAndLabels) {
@@ -94,10 +96,10 @@ export class KindOfQuantity extends SchemaItem {
                     throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
                 unitAndLabels = [];
                 for (const unitOverride of presFormatOverride.unitAndLabels) {
-                    const unit = this.schema.lookupItemSync(unitOverride[0]);
-                    if (undefined === unit)
+                    const unitOrInverted = this.schema.lookupItemSync(unitOverride[0]);
+                    if (undefined === unitOrInverted || (!Unit.isUnit(unitOrInverted) && !InvertedUnit.isInvertedUnit(unitOrInverted)))
                         throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);
-                    unitAndLabels.push([unit, unitOverride[1]]);
+                    unitAndLabels.push([unitOrInverted, unitOverride[1]]);
                 }
             }
             const overrideFormat = this.createFormatOverride(format, presFormatOverride.precision, unitAndLabels);
@@ -142,9 +144,12 @@ export class KindOfQuantity extends SchemaItem {
         const persistenceUnit = this.schema.lookupItemSync(kindOfQuantityProps.persistenceUnit);
         if (undefined === persistenceUnit)
             throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);
-        if (persistenceUnit.schemaItemType !== SchemaItemType.Unit && persistenceUnit.schemaItemType !== SchemaItemType.InvertedUnit)
+        if (!Unit.isUnit(persistenceUnit) && !InvertedUnit.isInvertedUnit(persistenceUnit))
             throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);
-        this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+        if (Unit.isUnit(persistenceUnit))
+            this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+        else
+            this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
         if (undefined !== kindOfQuantityProps.presentationUnits)
             this.processPresentationUnitsSync(kindOfQuantityProps.presentationUnits);
     }
@@ -154,9 +159,12 @@ export class KindOfQuantity extends SchemaItem {
         const persistenceUnit = await this.schema.lookupItem(kindOfQuantityProps.persistenceUnit);
         if (undefined === persistenceUnit)
             throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);
-        if (persistenceUnit.schemaItemType !== SchemaItemType.Unit && persistenceUnit.schemaItemType !== SchemaItemType.InvertedUnit)
+        if (!Unit.isUnit(persistenceUnit) && !InvertedUnit.isInvertedUnit(persistenceUnit))
             throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);
-        this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+        if (Unit.isUnit(persistenceUnit))
+            this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+        else
+            this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
         if (undefined !== kindOfQuantityProps.presentationUnits)
             await this.processPresentationUnits(kindOfQuantityProps.presentationUnits);
     }
@@ -167,6 +175,23 @@ export class KindOfQuantity extends SchemaItem {
     setRelativeError(relativeError) {
         this._relativeError = relativeError;
     }
+    /**
+     * Type guard to check if the SchemaItem is of type KindOfQuantity.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a KindOfQuantity, false otherwise.
+     */
+    static isKindOfQuantity(item) {
+        return item?.schemaItemType === SchemaItemType.KindOfQuantity;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type KindOfQuantity.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to KindOfQuantity if it is a KindOfQuantity, undefined otherwise.
+     */
+    static assertIsKindOfQuantity(item) {
+        if (!this.isKindOfQuantity(item))
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.KindOfQuantity}' (KindOfQuantity)`);
+    }
 }
 /**
  * @internal