@itwin/ecschema-metadata 4.8.0-dev.9 → 4.9.0-dev.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EACL,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAsB,mBAAmB,EACpH,cAAc,EAA0B,cAAc,EACvD,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,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,MAAO,SAAQ,UAAU;IACpC,SAAyB,cAAc,EAAG,cAAc,CAAC,MAAM,CAAC;IAChE,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC;IAC5B,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;gBAExD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAOxC,IAAW,WAAW,IAAI,MAAM,CAAmC;IACnE,IAAW,IAAI,IAAI,UAAU,CAA4B;IACzD,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAiC;IAC/F,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAgC;IACzE,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAsC;IAC7F,IAAW,cAAc,IAAI,cAAc,CAAsC;IACjF,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,CAAyC;IAC/E,IAAW,YAAY,IAAI,MAAM,CAAoC;IACrE,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAyC;IAC3F,IAAW,YAAY,IAAI,YAAY,CAAoC;IAC3E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA8B;IACrE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAmC;IAChF,IAAW,KAAK,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAwB;IAExG,OAAO,CAAC,iBAAiB;IAIlB,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM;IAa3D,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IAExC,OAAO,CAAC,SAAS;IAmBD,YAAY,CAAC,WAAW,EAAE,qBAAqB;IAezC,QAAQ,CAAC,WAAW,EAAE,qBAAqB;IAejE;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,qBAAqB;IAyDjH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA4ClE;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU;IAI9C;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc;IAItD;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAIhD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM;IAI3C;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;CAGhD;AAED;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,MAAM;aACvB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;aACxD,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACrC,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;aAC3C,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,iBAAiB,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;aACnD,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC7C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACxC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/Format.js

@@ -0,0 +1,238 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils";
+import { SchemaItemType } from "../ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { BaseFormat, FormatTraits, formatTraitsToArray, FormatType, formatTypeToString, scientificTypeToString, ShowSignOption, showSignOptionToString, } from "@itwin/core-quantity";
+import { SchemaItem } from "./SchemaItem";
+/**
+ * @beta
+ */
+export class Format extends SchemaItem {
+    constructor(schema, name) {
+        super(schema, name);
+        this.schemaItemType = SchemaItemType.Format;
+        this._base = new BaseFormat(name);
+    }
+    get roundFactor() { return this._base.roundFactor; }
+    get type() { return this._base.type; }
+    get precision() { return this._base.precision; }
+    get minWidth() { return this._base.minWidth; }
+    get scientificType() { return this._base.scientificType; }
+    get showSignOption() { return this._base.showSignOption; }
+    get decimalSeparator() { return this._base.decimalSeparator; }
+    get thousandSeparator() { return this._base.thousandSeparator; }
+    get uomSeparator() { return this._base.uomSeparator; }
+    get stationSeparator() { return this._base.stationSeparator; }
+    get stationOffsetSize() { return this._base.stationOffsetSize; }
+    get formatTraits() { return this._base.formatTraits; }
+    get spacer() { return this._base.spacer; }
+    get includeZero() { return this._base.includeZero; }
+    get units() { return this._units; }
+    parseFormatTraits(formatTraitsFromJson) {
+        return this._base.parseFormatTraits(formatTraitsFromJson);
+    }
+    hasFormatTrait(formatTrait) {
+        return this._base.hasFormatTraitSet(formatTrait);
+    }
+    /**
+     * Adds a Unit, or InvertedUnit, with an optional label override.
+     * @param unit The Unit, or InvertedUnit, to add to this Format.
+     * @param label A label that overrides the label defined within the Unit when a value is formatted.
+     */
+    addUnit(unit, label) {
+        if (undefined === this._units)
+            this._units = [];
+        else { // Validate that a duplicate is not added.
+            for (const existingUnit of this._units) {
+                if (unit.fullName.toLowerCase() === existingUnit[0].fullName.toLowerCase())
+                    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.
+            }
+        }
+        this._units.push([unit, label]);
+    }
+    setPrecision(precision) { this._base.precision = precision; }
+    typecheck(formatProps) {
+        this._base.loadFormatProperties(formatProps);
+        if (undefined !== formatProps.composite) { // TODO: This is duplicated below when the units need to be processed...
+            if (undefined !== formatProps.composite.includeZero)
+                this._base.includeZero = formatProps.composite.includeZero;
+            if (undefined !== formatProps.composite.spacer) {
+                if (formatProps.composite.spacer.length > 1)
+                    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.`);
+                this._base.spacer = formatProps.composite.spacer;
+            }
+            // Composite requires 1-4 units
+            if (formatProps.composite.units.length <= 0 || formatProps.composite.units.length > 4)
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);
+        }
+    }
+    fromJSONSync(formatProps) {
+        super.fromJSONSync(formatProps);
+        this.typecheck(formatProps);
+        if (undefined === formatProps.composite)
+            return;
+        // 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)
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
+            this.addUnit(newUnit, unit.label);
+        }
+    }
+    async fromJSON(formatProps) {
+        await super.fromJSON(formatProps);
+        this.typecheck(formatProps);
+        if (undefined === formatProps.composite)
+            return;
+        // 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)
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
+            this.addUnit(newUnit, unit.label);
+        }
+    }
+    /**
+     * Save this Format's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        schemaJson.type = formatTypeToString(this.type);
+        schemaJson.precision = this.precision;
+        // this._spacer = " ";
+        // this._includeZero = true;
+        // Serialize the minimal amount of information needed so anything that is the same as the default, do not serialize.
+        if (0.0 !== this.roundFactor)
+            schemaJson.roundFactor = this.roundFactor;
+        if (ShowSignOption.OnlyNegative !== this.showSignOption)
+            schemaJson.showSignOption = showSignOptionToString(this.showSignOption);
+        if (FormatTraits.Uninitialized !== this.formatTraits)
+            schemaJson.formatTraits = formatTraitsToArray(this.formatTraits);
+        if ("." !== this.decimalSeparator)
+            schemaJson.decimalSeparator = this.decimalSeparator;
+        if ("," !== this.thousandSeparator)
+            schemaJson.thousandSeparator = this.thousandSeparator;
+        if (" " !== this.uomSeparator)
+            schemaJson.uomSeparator = this.uomSeparator;
+        if (undefined !== this.minWidth)
+            schemaJson.minWidth = this.minWidth;
+        if (FormatType.Scientific === this.type && undefined !== this.scientificType)
+            schemaJson.scientificType = scientificTypeToString(this.scientificType);
+        if (FormatType.Station === this.type) {
+            if (undefined !== this.stationOffsetSize)
+                schemaJson.stationOffsetSize = this.stationOffsetSize;
+            if (" " !== this.stationSeparator)
+                schemaJson.stationSeparator = this.stationSeparator;
+        }
+        if (undefined === this.units)
+            return schemaJson;
+        schemaJson.composite = {};
+        if (" " !== this.spacer)
+            schemaJson.composite.spacer = this.spacer;
+        if (true !== this.includeZero)
+            schemaJson.composite.includeZero = this.includeZero;
+        schemaJson.composite.units = [];
+        for (const unit of this.units) {
+            schemaJson.composite.units.push({
+                name: unit[0].fullName,
+                label: unit[1],
+            });
+        }
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        itemElement.setAttribute("type", formatTypeToString(this.type).toLowerCase());
+        itemElement.setAttribute("precision", this.precision.toString());
+        itemElement.setAttribute("roundFactor", this.roundFactor.toString());
+        itemElement.setAttribute("showSignOption", showSignOptionToString(this.showSignOption));
+        itemElement.setAttribute("decimalSeparator", this.decimalSeparator);
+        itemElement.setAttribute("thousandSeparator", this.thousandSeparator);
+        itemElement.setAttribute("uomSeparator", this.uomSeparator);
+        itemElement.setAttribute("stationSeparator", this.stationSeparator);
+        if (undefined !== this.minWidth)
+            itemElement.setAttribute("minWidth", this.minWidth.toString());
+        if (undefined !== this.scientificType)
+            itemElement.setAttribute("scientificType", scientificTypeToString(this.scientificType));
+        if (undefined !== this.stationOffsetSize)
+            itemElement.setAttribute("stationOffsetSize", this.stationOffsetSize.toString());
+        const formatTraits = formatTraitsToArray(this.formatTraits);
+        if (formatTraits.length > 0)
+            itemElement.setAttribute("formatTraits", formatTraits.join("|"));
+        if (undefined !== this.units) {
+            const compositeElement = schemaXml.createElement("Composite");
+            if (undefined !== this.spacer)
+                compositeElement.setAttribute("spacer", this.spacer);
+            if (undefined !== this.includeZero)
+                compositeElement.setAttribute("includeZero", this.includeZero.toString());
+            this.units.forEach(([unit, label]) => {
+                const unitElement = schemaXml.createElement("Unit");
+                if (undefined !== label)
+                    unitElement.setAttribute("label", label);
+                const unitName = XmlSerializationUtils.createXmlTypedName(this.schema, unit.schema, unit.name);
+                unitElement.textContent = unitName;
+                compositeElement.appendChild(unitElement);
+            });
+            itemElement.appendChild(compositeElement);
+        }
+        return itemElement;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setFormatType(formatType) {
+        this._base.type = formatType;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setRoundFactor(roundFactor) {
+        this._base.roundFactor = roundFactor;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setShowSignOption(signOption) {
+        this._base.showSignOption = signOption;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setDecimalSeparator(separator) {
+        this._base.decimalSeparator = separator;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setThousandSeparator(separator) {
+        this._base.thousandSeparator = separator;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setUomSeparator(separator) {
+        this._base.uomSeparator = separator;
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setStationSeparator(separator) {
+        this._base.stationSeparator = separator;
+    }
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export class MutableFormat extends Format {
+}
+//# sourceMappingURL=Format.js.map

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

@@ -0,0 +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,EAAE,kBAAkB,EAC/E,sBAAsB,EAAE,cAAc,EAAE,sBAAsB,GAC/E,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,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,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,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1E,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,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE1E,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,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC9E,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,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QACxF,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,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAC1F,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, formatTypeToString, FractionalPrecision,\r\n  ScientificType, scientificTypeToString, ShowSignOption, showSignOptionToString,\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; // eslint-disable-line\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 = formatTypeToString(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 = showSignOptionToString(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 = scientificTypeToString(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\", formatTypeToString(this.type).toLowerCase());\r\n    itemElement.setAttribute(\"precision\", this.precision.toString());\r\n    itemElement.setAttribute(\"roundFactor\", this.roundFactor.toString());\r\n    itemElement.setAttribute(\"showSignOption\", showSignOptionToString(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\", scientificTypeToString(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"]}

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

@@ -0,0 +1,50 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+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;
+    protected _invertsUnit?: LazyLoadedUnit;
+    protected _unitSystem?: LazyLoadedUnitSystem;
+    constructor(schema: Schema, name: string);
+    get invertsUnit(): LazyLoadedUnit | undefined;
+    get unitSystem(): LazyLoadedUnitSystem | undefined;
+    /**
+     * 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).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): InvertedUnitProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(invertedUnitProps: InvertedUnitProps): void;
+    fromJSON(invertedUnitProps: InvertedUnitProps): Promise<void>;
+    /**
+     * @alpha
+     * Used for schema editing
+     */
+    protected setInvertsUnit(invertsUnit: LazyLoadedUnit): void;
+    /**
+     * @alpha
+     * Used for schema editing
+     */
+    protected setUnitSystem(unitSystem: LazyLoadedUnitSystem): void;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableInvertedUnit extends InvertedUnit {
+    abstract setInvertsUnit(invertsUnit: LazyLoadedUnit): void;
+    abstract setUnitSystem(unitSystem: LazyLoadedUnitSystem): void;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
+//# sourceMappingURL=InvertedUnit.d.ts.map

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

@@ -0,0 +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;;;;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

@@ -0,0 +1,93 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { DelayedPromiseWithProps } from "../DelayedPromise";
+import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils";
+import { SchemaItemType } from "../ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "../Exception";
+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 class InvertedUnit extends SchemaItem {
+    constructor(schema, name) {
+        super(schema, name);
+        this.schemaItemType = SchemaItemType.InvertedUnit;
+    }
+    get invertsUnit() { return this._invertsUnit; }
+    get unitSystem() { return this._unitSystem; }
+    /**
+     * 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).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        schemaJson.invertsUnit = this.invertsUnit.fullName;
+        schemaJson.unitSystem = this.unitSystem.fullName;
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        const unitSystem = await this.unitSystem;
+        if (undefined !== unitSystem) {
+            const unitSystemName = XmlSerializationUtils.createXmlTypedName(this.schema, unitSystem.schema, unitSystem.name);
+            itemElement.setAttribute("unitSystem", unitSystemName);
+        }
+        const invertsUnit = await this.invertsUnit;
+        if (undefined !== invertsUnit) {
+            const invertsUnitName = XmlSerializationUtils.createXmlTypedName(this.schema, invertsUnit.schema, invertsUnit.name);
+            itemElement.setAttribute("invertsUnit", invertsUnitName);
+        }
+        return itemElement;
+    }
+    fromJSONSync(invertedUnitProps) {
+        super.fromJSONSync(invertedUnitProps);
+        const unitSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.invertsUnit);
+        this._invertsUnit = new DelayedPromiseWithProps(unitSchemaItemKey, async () => {
+            const invertsUnit = await this.schema.lookupItem(unitSchemaItemKey);
+            if (undefined === invertsUnit)
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the invertsUnit ${invertedUnitProps.invertsUnit}.`);
+            return invertsUnit;
+        });
+        const unitSystemSchemaItemKey = this.schema.getSchemaItemKey(invertedUnitProps.unitSystem);
+        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);
+            if (undefined === unitSystem)
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the unitSystem ${invertedUnitProps.unitSystem}.`);
+            return unitSystem;
+        });
+    }
+    async fromJSON(invertedUnitProps) {
+        this.fromJSONSync(invertedUnitProps);
+    }
+    /**
+     * @alpha
+     * Used for schema editing
+     */
+    setInvertsUnit(invertsUnit) {
+        this._invertsUnit = invertsUnit;
+    }
+    /**
+     * @alpha
+     * Used for schema editing
+     */
+    setUnitSystem(unitSystem) {
+        this._unitSystem = unitSystem;
+    }
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export class MutableInvertedUnit extends InvertedUnit {
+}
+//# sourceMappingURL=InvertedUnit.js.map

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

@@ -0,0 +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;;;;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; // eslint-disable-line\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   * 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"]}

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

@@ -0,0 +1,72 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { KindOfQuantityProps } from "../Deserialization/JsonProps";
+import { SchemaItemType } from "../ECObjects";
+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;
+    protected _relativeError: number;
+    protected _presentationFormats: Array<Format | OverrideFormat>;
+    protected _persistenceUnit?: LazyLoadedUnit | LazyLoadedInvertedUnit;
+    /** The first presentation format in the list of Formats. */
+    get defaultPresentationFormat(): Format | OverrideFormat | undefined;
+    /** A list of presentation formats. */
+    get presentationFormats(): Array<Format | OverrideFormat>;
+    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
+     * @param isDefault
+     */
+    protected addPresentationFormat(format: Format | OverrideFormat, isDefault?: boolean): void;
+    /** Parses the format string into the parts that make up an Override Format
+     * @param formatString
+     */
+    private parseFormatString;
+    /** Creates an OverrideFormat in the context of this KindOfQuantity.
+     * @param parent The Format to override.
+     * @param precision The precision override
+     * @param unitLabelOverrides The list of unit and label overrides.
+     */
+    protected createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[Unit | InvertedUnit, string | undefined]>): OverrideFormat;
+    private processPresentationUnits;
+    private processPresentationUnitsSync;
+    /**
+     * Save this KindOfQuantity's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): KindOfQuantityProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(kindOfQuantityProps: KindOfQuantityProps): void;
+    fromJSON(kindOfQuantityProps: KindOfQuantityProps): Promise<void>;
+    /**
+     * @alpha
+     * Used for schema editing.
+     */
+    protected setRelativeError(relativeError: number): void;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableKindOfQuantity extends KindOfQuantity {
+    abstract addPresentationFormat(format: Format | OverrideFormat, isDefault: boolean): void;
+    abstract createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[Unit | InvertedUnit, string | undefined]>): OverrideFormat;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
+//# sourceMappingURL=KindOfQuantity.d.ts.map

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

@@ -0,0 +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;AAEvE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAQ9B;;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;;OAEG;IACH,OAAO,CAAC,iBAAiB;IA4DzB;;;;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"}