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

package/lib/esm/Metadata/KindOfQuantity.js

@@ -0,0 +1,229 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { formatStringRgx } from "@itwin/core-quantity";
+import { OverrideFormat } from "./OverrideFormat";
+import { SchemaItem } from "./SchemaItem";
+/** A Typescript class representation of a KindOfQuantity.
+ * @beta
+ */
+export class KindOfQuantity extends SchemaItem {
+    /** The first presentation format in the list of Formats. */
+    get defaultPresentationFormat() { return this.presentationFormats[0]; }
+    /** A list of presentation formats. */
+    get presentationFormats() { return this._presentationFormats; }
+    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
+     * @param isDefault
+     */
+    addPresentationFormat(format, isDefault = false) {
+        // TODO: Add some sort of validation?
+        (isDefault) ? this._presentationFormats.splice(0, 0, format) : this._presentationFormats.push(format);
+    }
+    /** Parses the format string into the parts that make up an Override Format
+     * @param formatString
+     */
+    parseFormatString(formatString) {
+        const match = formatString.split(formatStringRgx); // split string based on regex groups
+        if (undefined === match[1])
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity '${this.fullName}' is missing a format.`);
+        const returnValue = { name: match[1] };
+        if (undefined !== match[2] && undefined !== match[3]) {
+            const overrideString = match[2];
+            const tokens = [];
+            let prevPos = 1; // Initial position is the character directly after the opening '(' in the override string.
+            let currPos;
+            // TODO need to include `,` as a valid search argument.
+            while (-1 !== (currPos = overrideString.indexOf(")", prevPos))) { // eslint-disable-line
+                tokens.push(overrideString.substring(prevPos, currPos));
+                prevPos = currPos + 1;
+            }
+            if (overrideString.length > 0 && undefined === tokens.find((token) => {
+                return "" !== token; // there is at least one token that is not empty.
+            })) {
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
+            }
+            // The first override parameter overrides the default precision of the format
+            const precisionIndx = 0;
+            if (tokens.length >= precisionIndx + 1) {
+                if (tokens[precisionIndx].length > 0) {
+                    const precision = Number.parseInt(tokens[precisionIndx], 10);
+                    if (Number.isNaN(precision))
+                        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity '${this.fullName}' has a precision override '${tokens[precisionIndx]}' that is not number.`);
+                    returnValue.precision = precision;
+                }
+            }
+        }
+        let i = 4;
+        while (i < match.length - 1) { // The regex match ends with an empty last value, which causes problems when exactly 4 unit overrides as specified, so ignore this last empty value
+            if (undefined === match[i])
+                break;
+            // Unit override required
+            if (undefined === match[i + 1])
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
+            if (undefined === returnValue.unitAndLabels)
+                returnValue.unitAndLabels = [];
+            if (undefined !== match[i + 2]) // matches '|'
+                returnValue.unitAndLabels.push([match[i + 1], match[i + 3] ?? ""]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)
+            else
+                returnValue.unitAndLabels.push([match[i + 1], undefined]); // add unit name
+            i += 4;
+        }
+        return returnValue;
+    }
+    /** 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.
+     */
+    createFormatOverride(parent, precision, unitLabelOverrides) {
+        if (unitLabelOverrides && parent.units && parent.units.length !== unitLabelOverrides.length)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Cannot add presentation format to KindOfQuantity '${this.name}' because the number of unit overrides is inconsistent with the number in the Format '${parent.name}'.`);
+        if (parent.units && 0 === parent.units.length && unitLabelOverrides && 0 < unitLabelOverrides.length)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Cannot add a presentation format to KindOfQuantity '${this.name}' without any units and no unit overrides.`);
+        // TODO: Check compatibility of Unit overrides with the persistence unit
+        return new OverrideFormat(parent, precision, unitLabelOverrides);
+    }
+    async processPresentationUnits(presentationUnitsJson) {
+        const presUnitsArr = Array.isArray(presentationUnitsJson) ? presentationUnitsJson : presentationUnitsJson.split(";");
+        for (const formatString of presUnitsArr) {
+            const presFormatOverride = this.parseFormatString(formatString);
+            const format = await this.schema.lookupItem(presFormatOverride.name);
+            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) {
+                this.addPresentationFormat(format);
+                continue;
+            }
+            let unitAndLabels;
+            if (undefined !== presFormatOverride.unitAndLabels) {
+                if (4 < presFormatOverride.unitAndLabels.length)
+                    throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
+                unitAndLabels = [];
+                for (const unitOverride of presFormatOverride.unitAndLabels) {
+                    const unit = await this.schema.lookupItem(unitOverride[0]);
+                    if (undefined === unit)
+                        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);
+                    unitAndLabels.push([unit, unitOverride[1]]);
+                }
+            }
+            const overrideFormat = this.createFormatOverride(format, presFormatOverride.precision, unitAndLabels);
+            this.addPresentationFormat(overrideFormat);
+        }
+    }
+    processPresentationUnitsSync(presentationUnitsJson) {
+        const presUnitsArr = Array.isArray(presentationUnitsJson) ? presentationUnitsJson : presentationUnitsJson.split(";");
+        for (const formatString of presUnitsArr) {
+            const presFormatOverride = this.parseFormatString(formatString);
+            const format = this.schema.lookupItemSync(presFormatOverride.name);
+            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) {
+                this.addPresentationFormat(format);
+                continue;
+            }
+            let unitAndLabels;
+            if (undefined !== presFormatOverride.unitAndLabels) {
+                if (4 < presFormatOverride.unitAndLabels.length)
+                    throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);
+                unitAndLabels = [];
+                for (const unitOverride of presFormatOverride.unitAndLabels) {
+                    const unit = this.schema.lookupItemSync(unitOverride[0]);
+                    if (undefined === unit)
+                        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);
+                    unitAndLabels.push([unit, unitOverride[1]]);
+                }
+            }
+            const overrideFormat = this.createFormatOverride(format, presFormatOverride.precision, unitAndLabels);
+            this.addPresentationFormat(overrideFormat);
+        }
+    }
+    /**
+     * 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 = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        schemaJson.relativeError = this.relativeError;
+        schemaJson.persistenceUnit = this.persistenceUnit.fullName;
+        if (undefined !== this.presentationFormats && 0 < this.presentationFormats.length)
+            schemaJson.presentationUnits = this.presentationFormats.map((format) => format.fullName);
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        const persistenceUnit = await this.persistenceUnit;
+        if (undefined !== persistenceUnit) {
+            const unitName = XmlSerializationUtils.createXmlTypedName(this.schema, persistenceUnit.schema, persistenceUnit.name);
+            itemElement.setAttribute("persistenceUnit", unitName);
+        }
+        if (undefined !== this.presentationFormats) {
+            const presUnitStrings = this.presentationFormats.map((format) => {
+                if (!OverrideFormat.isOverrideFormat(format))
+                    return XmlSerializationUtils.createXmlTypedName(this.schema, format.schema, format.name);
+                return format.fullNameXml(this.schema);
+            });
+            itemElement.setAttribute("presentationUnits", presUnitStrings.join(";"));
+        }
+        itemElement.setAttribute("relativeError", this.relativeError.toString());
+        return itemElement;
+    }
+    fromJSONSync(kindOfQuantityProps) {
+        super.fromJSONSync(kindOfQuantityProps);
+        this._relativeError = kindOfQuantityProps.relativeError;
+        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)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);
+        this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+        if (undefined !== kindOfQuantityProps.presentationUnits)
+            this.processPresentationUnitsSync(kindOfQuantityProps.presentationUnits);
+    }
+    async fromJSON(kindOfQuantityProps) {
+        await super.fromJSON(kindOfQuantityProps);
+        this._relativeError = kindOfQuantityProps.relativeError;
+        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)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);
+        this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+        if (undefined !== kindOfQuantityProps.presentationUnits)
+            await this.processPresentationUnits(kindOfQuantityProps.presentationUnits);
+    }
+    /**
+     * @alpha
+     * Used for schema editing.
+     */
+    setRelativeError(relativeError) {
+        this._relativeError = relativeError;
+    }
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export class MutableKindOfQuantity extends KindOfQuantity {
+}
+//# sourceMappingURL=KindOfQuantity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KindOfQuantity.js","sourceRoot":"","sources":["../../../src/Metadata/KindOfQuantity.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;AAE/D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAS1C;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;IAM5C,4DAA4D;IAC5D,IAAW,yBAAyB,KAA0C,OAAO,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnH,sCAAsC;IACtC,IAAW,mBAAmB,KAAqC,OAAO,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAEtG,IAAW,eAAe,KAA0D,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACnH,IAAc,eAAe,CAAC,KAA0D,IAAK,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,CAAC,CAAC;IAE7H,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAE1D,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAhBZ,mBAAc,GAAW,GAAG,CAAC;QAC7B,yBAAoB,GAAmC,IAAI,KAAK,EAA2B,CAAC;QAgBpG,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,cAAc,CAAC,CAAC,wDAAwD;IAC/G,CAAC;IAED;;;;OAIG;IACO,qBAAqB,CAAC,MAA+B,EAAE,YAAqB,KAAK;QACzF,qCAAqC;QACrC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxG,CAAC;IAED;;OAEG;IACK,iBAAiB,CAAC,YAAoB;QAC5C,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,qCAAqC;QACxF,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;YACxB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,sBAAsB,YAAY,wBAAwB,IAAI,CAAC,QAAQ,wBAAwB,CAAC,CAAC;QAE3J,MAAM,WAAW,GAAwB,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAE5D,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,2FAA2F;YAC5G,IAAI,OAAO,CAAC;YAEZ,uDAAuD;YACvD,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,sBAAsB;gBACtF,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACxD,OAAO,GAAG,OAAO,GAAG,CAAC,CAAC;YACxB,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACnE,OAAO,EAAE,KAAK,KAAK,CAAC,CAAC,iDAAiD;YACxE,CAAC,CAAC,EAAE,CAAC;gBACH,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAC9D,CAAC;YAED,6EAA6E;YAC7E,MAAM,aAAa,GAAW,CAAC,CAAC;YAEhC,IAAI,MAAM,CAAC,MAAM,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACvC,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC7D,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;wBACzB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,sBAAsB,YAAY,wBAAwB,IAAI,CAAC,QAAQ,+BAA+B,MAAM,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;oBAC9M,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;gBACpC,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAE,mJAAmJ;YACjL,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC;gBACxB,MAAM;YACR,yBAAyB;YACzB,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAE9D,IAAI,SAAS,KAAK,WAAW,CAAC,aAAa;gBACzC,WAAW,CAAC,aAAa,GAAG,EAAE,CAAC;YAEjC,IAAI,SAAS,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc;gBAC5C,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,4GAA4G;;gBAEhL,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,gBAAgB;YAE7E,CAAC,IAAI,CAAC,CAAC;QACT,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACO,oBAAoB,CAAC,MAAc,EAAE,SAAkB,EAAE,kBAAqE;QACtI,IAAI,kBAAkB,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,kBAAkB,CAAC,MAAM;YACzF,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,qDAAqD,IAAI,CAAC,IAAI,yFAAyF,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC;QAElO,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,kBAAkB,IAAI,CAAC,GAAG,kBAAkB,CAAC,MAAM;YAClG,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,uDAAuD,IAAI,CAAC,IAAI,4CAA4C,CAAC,CAAC;QAExK,wEAAwE;QAExE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,kBAAkB,CAAC,CAAC;IACnE,CAAC;IAEO,KAAK,CAAC,wBAAwB,CAAC,qBAAwC;QAC7E,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,qBAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrH,KAAK,MAAM,YAAY,IAAI,YAAY,EAAE,CAAC;YACxC,MAAM,kBAAkB,GAAwB,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAErF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAS,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC7E,IAAI,SAAS,KAAK,MAAM,IAAI,MAAM,CAAC,cAAc,KAAK,cAAc,CAAC,MAAM;gBACzE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,4BAA4B,kBAAkB,CAAC,IAAI,iDAAiD,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;YAEhL,IAAI,SAAS,KAAK,kBAAkB,CAAC,SAAS,IAAI,SAAS,KAAK,kBAAkB,CAAC,aAAa,EAAE,CAAC;gBACjG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;gBACnC,SAAS;YACX,CAAC;YAED,IAAI,aAA2E,CAAC;YAChF,IAAI,SAAS,KAAK,kBAAkB,CAAC,aAAa,EAAE,CAAC;gBACnD,IAAI,CAAC,GAAG,kBAAkB,CAAC,aAAa,CAAC,MAAM;oBAC7C,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBAE9D,aAAa,GAAG,EAAE,CAAC;gBACnB,KAAK,MAAM,YAAY,IAAI,kBAAkB,CAAC,aAAa,EAAE,CAAC;oBAC5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAsB,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;oBAChF,IAAI,SAAS,KAAK,IAAI;wBACpB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,+BAA+B,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;oBAE7G,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;YAED,MAAM,cAAc,GAAmB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACtH,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAEO,4BAA4B,CAAC,qBAAwC;QAC3E,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,qBAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrH,KAAK,MAAM,YAAY,IAAI,YAAY,EAAE,CAAC;YACxC,MAAM,kBAAkB,GAAwB,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAErF,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAS,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,SAAS,KAAK,MAAM,IAAI,MAAM,CAAC,cAAc,KAAK,cAAc,CAAC,MAAM;gBACzE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,4BAA4B,kBAAkB,CAAC,IAAI,iDAAiD,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;YAEhL,IAAI,SAAS,KAAK,kBAAkB,CAAC,SAAS,IAAI,SAAS,KAAK,kBAAkB,CAAC,aAAa,EAAE,CAAC;gBACjG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;gBACnC,SAAS;YACX,CAAC;YAED,IAAI,aAA2E,CAAC;YAChF,IAAI,SAAS,KAAK,kBAAkB,CAAC,aAAa,EAAE,CAAC;gBACnD,IAAI,CAAC,GAAG,kBAAkB,CAAC,aAAa,CAAC,MAAM;oBAC7C,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBAE9D,aAAa,GAAG,EAAE,CAAC;gBACnB,KAAK,MAAM,YAAY,IAAI,kBAAkB,CAAC,aAAa,EAAE,CAAC;oBAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAsB,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC9E,IAAI,SAAS,KAAK,IAAI;wBACpB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,+BAA+B,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;oBAE7G,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;YAED,MAAM,cAAc,GAAmB,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACtH,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAC7C,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,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAC9C,UAAU,CAAC,eAAe,GAAG,IAAI,CAAC,eAAgB,CAAC,QAAQ,CAAC;QAC5D,IAAI,SAAS,KAAK,IAAI,CAAC,mBAAmB,IAAI,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM;YAC/E,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,MAA+B,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpH,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,eAAe,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC;QACnD,IAAI,SAAS,KAAK,eAAe,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;YACrH,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,SAAS,KAAK,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3C,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,MAA+B,EAAE,EAAE;gBACvF,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC;oBAC1C,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3F,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACzC,CAAC,CAAC,CAAC;YACH,WAAW,CAAC,YAAY,CAAC,mBAAmB,EAAE,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,WAAW,CAAC,YAAY,CAAC,eAAe,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEzE,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,mBAAwC;QACnE,KAAK,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;QACxC,IAAI,CAAC,cAAc,GAAG,mBAAmB,CAAC,aAAa,CAAC;QAExD,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAO,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAC9F,IAAI,SAAS,KAAK,eAAe;YAC/B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,kBAAkB,CAAC,CAAC;QAE7H,IAAI,eAAe,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,IAAI,eAAe,CAAC,cAAc,KAAK,cAAc,CAAC,YAAY;YAC1H,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,iCAAiC,CAAC,CAAC;QAE5I,IAAI,CAAC,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC;QAEtG,IAAI,SAAS,KAAK,mBAAmB,CAAC,iBAAiB;YACrD,IAAI,CAAC,4BAA4B,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IAC7E,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,mBAAwC;QACrE,MAAM,KAAK,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,GAAG,mBAAmB,CAAC,aAAa,CAAC;QAExD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAO,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAChG,IAAI,SAAS,KAAK,eAAe;YAC/B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,kBAAkB,CAAC,CAAC;QAE7H,IAAI,eAAe,CAAC,cAAc,KAAK,cAAc,CAAC,IAAI,IAAI,eAAe,CAAC,cAAc,KAAK,cAAc,CAAC,YAAY;YAC1H,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,iCAAiC,CAAC,CAAC;QAE5I,IAAI,CAAC,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC;QAEtG,IAAI,SAAS,KAAK,mBAAmB,CAAC,iBAAiB;YACrD,MAAM,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACO,gBAAgB,CAAC,aAAqB;QAC9C,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,cAAc;CAIjE","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 { KindOfQuantityProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedInvertedUnit, LazyLoadedUnit } from \"../Interfaces\";\r\nimport { formatStringRgx } from \"@itwin/core-quantity\";\r\nimport { Format } from \"./Format\";\r\nimport { InvertedUnit } from \"./InvertedUnit\";\r\nimport { OverrideFormat } from \"./OverrideFormat\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { Unit } from \"./Unit\";\r\n\r\ninterface OverrideFormatProps {\r\n  name: string;\r\n  precision?: number;\r\n  unitAndLabels?: Array<[string, string | undefined]>; // Tuple of [unit name | unit label]\r\n}\r\n\r\n/** A Typescript class representation of a KindOfQuantity.\r\n * @beta\r\n */\r\nexport class KindOfQuantity extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.KindOfQuantity; // eslint-disable-line\r\n  protected _relativeError: number = 1.0;\r\n  protected _presentationFormats: Array<Format | OverrideFormat> = new Array<Format | OverrideFormat>();\r\n  protected _persistenceUnit?: LazyLoadedUnit | LazyLoadedInvertedUnit;\r\n\r\n  /** The first presentation format in the list of Formats. */\r\n  public get defaultPresentationFormat(): Format | OverrideFormat | undefined { return this.presentationFormats[0]; }\r\n\r\n  /** A list of presentation formats. */\r\n  public get presentationFormats(): Array<Format | OverrideFormat> { return this._presentationFormats; }\r\n\r\n  public get persistenceUnit(): LazyLoadedUnit | LazyLoadedInvertedUnit | undefined { return this._persistenceUnit; }\r\n  protected set persistenceUnit(value: LazyLoadedUnit | LazyLoadedInvertedUnit | undefined) {  this._persistenceUnit = value; }\r\n\r\n  public get relativeError() { return this._relativeError; }\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.KindOfQuantity; // Needed to allow both run-time and compile-time check.\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param format The Format to add to this KindOfQuantity\r\n   * @param isDefault\r\n   */\r\n  protected addPresentationFormat(format: Format | OverrideFormat, isDefault: boolean = false) {\r\n    // TODO: Add some sort of validation?\r\n    (isDefault) ? this._presentationFormats.splice(0, 0, format) : this._presentationFormats.push(format);\r\n  }\r\n\r\n  /** Parses the format string into the parts that make up an Override Format\r\n   * @param formatString\r\n   */\r\n  private parseFormatString(formatString: string): OverrideFormatProps {\r\n    const match = formatString.split(formatStringRgx); // split string based on regex groups\r\n    if (undefined === match[1])\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string, ${formatString}, on KindOfQuantity '${this.fullName}' is missing a format.`);\r\n\r\n    const returnValue: OverrideFormatProps = { name: match[1] };\r\n\r\n    if (undefined !== match[2] && undefined !== match[3]) {\r\n      const overrideString = match[2];\r\n      const tokens: string[] = [];\r\n      let prevPos = 1; // Initial position is the character directly after the opening '(' in the override string.\r\n      let currPos;\r\n\r\n      // TODO need to include `,` as a valid search argument.\r\n      while (-1 !== (currPos = overrideString.indexOf(\")\", prevPos))) { // eslint-disable-line\r\n        tokens.push(overrideString.substring(prevPos, currPos));\r\n        prevPos = currPos + 1;\r\n      }\r\n\r\n      if (overrideString.length > 0 && undefined === tokens.find((token) => {\r\n        return \"\" !== token; // there is at least one token that is not empty.\r\n      })) {\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\r\n      }\r\n\r\n      // The first override parameter overrides the default precision of the format\r\n      const precisionIndx: number = 0;\r\n\r\n      if (tokens.length >= precisionIndx + 1) {\r\n        if (tokens[precisionIndx].length > 0) {\r\n          const precision = Number.parseInt(tokens[precisionIndx], 10);\r\n          if (Number.isNaN(precision))\r\n            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The format string '${formatString}' on KindOfQuantity '${this.fullName}' has a precision override '${tokens[precisionIndx]}' that is not number.`);\r\n          returnValue.precision = precision;\r\n        }\r\n      }\r\n    }\r\n\r\n    let i = 4;\r\n    while (i < match.length - 1) {  // The regex match ends with an empty last value, which causes problems when exactly 4 unit overrides as specified, so ignore this last empty value\r\n      if (undefined === match[i])\r\n        break;\r\n      // Unit override required\r\n      if (undefined === match[i + 1])\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\r\n\r\n      if (undefined === returnValue.unitAndLabels)\r\n        returnValue.unitAndLabels = [];\r\n\r\n      if (undefined !== match[i + 2]) // matches '|'\r\n        returnValue.unitAndLabels.push([match[i + 1], match[i + 3] ?? \"\"]); // add unit name and label override (if '|' matches and next value is undefined, save it as an empty string)\r\n      else\r\n        returnValue.unitAndLabels.push([match[i + 1], undefined]); // add unit name\r\n\r\n      i += 4;\r\n    }\r\n\r\n    return returnValue;\r\n  }\r\n\r\n  /** Creates an OverrideFormat in the context of this KindOfQuantity.\r\n   * @param parent The Format to override.\r\n   * @param precision The precision override\r\n   * @param unitLabelOverrides The list of unit and label overrides.\r\n   */\r\n  protected createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[Unit | InvertedUnit, string | undefined]>): OverrideFormat {\r\n    if (unitLabelOverrides && parent.units && parent.units.length !== unitLabelOverrides.length)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Cannot add presentation format to KindOfQuantity '${this.name}' because the number of unit overrides is inconsistent with the number in the Format '${parent.name}'.`);\r\n\r\n    if (parent.units && 0 === parent.units.length && unitLabelOverrides && 0 < unitLabelOverrides.length)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Cannot add a presentation format to KindOfQuantity '${this.name}' without any units and no unit overrides.`);\r\n\r\n    // TODO: Check compatibility of Unit overrides with the persistence unit\r\n\r\n    return new OverrideFormat(parent, precision, unitLabelOverrides);\r\n  }\r\n\r\n  private async processPresentationUnits(presentationUnitsJson: string | string[]): Promise<void> {\r\n    const presUnitsArr = Array.isArray(presentationUnitsJson) ? presentationUnitsJson : presentationUnitsJson.split(\";\");\r\n    for (const formatString of presUnitsArr) {\r\n      const presFormatOverride: OverrideFormatProps = this.parseFormatString(formatString);\r\n\r\n      const format = await this.schema.lookupItem<Format>(presFormatOverride.name);\r\n      if (undefined === format || format.schemaItemType !== SchemaItemType.Format)\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate Format '${presFormatOverride.name}' for the presentation unit on KindOfQuantity ${this.fullName}.`);\r\n\r\n      if (undefined === presFormatOverride.precision && undefined === presFormatOverride.unitAndLabels) {\r\n        this.addPresentationFormat(format);\r\n        continue;\r\n      }\r\n\r\n      let unitAndLabels: Array<[Unit | InvertedUnit, string | undefined]> | undefined;\r\n      if (undefined !== presFormatOverride.unitAndLabels) {\r\n        if (4 < presFormatOverride.unitAndLabels.length)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\r\n\r\n        unitAndLabels = [];\r\n        for (const unitOverride of presFormatOverride.unitAndLabels) {\r\n          const unit = await this.schema.lookupItem<Unit | InvertedUnit>(unitOverride[0]);\r\n          if (undefined === unit)\r\n            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);\r\n\r\n          unitAndLabels.push([unit, unitOverride[1]]);\r\n        }\r\n      }\r\n\r\n      const overrideFormat: OverrideFormat = this.createFormatOverride(format, presFormatOverride.precision, unitAndLabels);\r\n      this.addPresentationFormat(overrideFormat);\r\n    }\r\n  }\r\n\r\n  private processPresentationUnitsSync(presentationUnitsJson: string | string[]): void {\r\n    const presUnitsArr = Array.isArray(presentationUnitsJson) ? presentationUnitsJson : presentationUnitsJson.split(\";\");\r\n    for (const formatString of presUnitsArr) {\r\n      const presFormatOverride: OverrideFormatProps = this.parseFormatString(formatString);\r\n\r\n      const format = this.schema.lookupItemSync<Format>(presFormatOverride.name);\r\n      if (undefined === format || format.schemaItemType !== SchemaItemType.Format)\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate Format '${presFormatOverride.name}' for the presentation unit on KindOfQuantity ${this.fullName}.`);\r\n\r\n      if (undefined === presFormatOverride.precision && undefined === presFormatOverride.unitAndLabels) {\r\n        this.addPresentationFormat(format);\r\n        continue;\r\n      }\r\n\r\n      let unitAndLabels: Array<[Unit | InvertedUnit, string | undefined]> | undefined;\r\n      if (undefined !== presFormatOverride.unitAndLabels) {\r\n        if (4 < presFormatOverride.unitAndLabels.length)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, ``);\r\n\r\n        unitAndLabels = [];\r\n        for (const unitOverride of presFormatOverride.unitAndLabels) {\r\n          const unit = this.schema.lookupItemSync<Unit | InvertedUnit>(unitOverride[0]);\r\n          if (undefined === unit)\r\n            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);\r\n\r\n          unitAndLabels.push([unit, unitOverride[1]]);\r\n        }\r\n      }\r\n\r\n      const overrideFormat: OverrideFormat = this.createFormatOverride(format, presFormatOverride.precision, unitAndLabels);\r\n      this.addPresentationFormat(overrideFormat);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Save this KindOfQuantity'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): KindOfQuantityProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.relativeError = this.relativeError;\r\n    schemaJson.persistenceUnit = this.persistenceUnit!.fullName;\r\n    if (undefined !== this.presentationFormats && 0 < this.presentationFormats.length)\r\n      schemaJson.presentationUnits = this.presentationFormats.map((format: Format | OverrideFormat) => format.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 persistenceUnit = await this.persistenceUnit;\r\n    if (undefined !== persistenceUnit) {\r\n      const unitName = XmlSerializationUtils.createXmlTypedName(this.schema, persistenceUnit.schema, persistenceUnit.name);\r\n      itemElement.setAttribute(\"persistenceUnit\", unitName);\r\n    }\r\n\r\n    if (undefined !== this.presentationFormats) {\r\n      const presUnitStrings = this.presentationFormats.map((format: Format | OverrideFormat) => {\r\n        if (!OverrideFormat.isOverrideFormat(format))\r\n          return XmlSerializationUtils.createXmlTypedName(this.schema, format.schema, format.name);\r\n        return format.fullNameXml(this.schema);\r\n      });\r\n      itemElement.setAttribute(\"presentationUnits\", presUnitStrings.join(\";\"));\r\n    }\r\n    itemElement.setAttribute(\"relativeError\", this.relativeError.toString());\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(kindOfQuantityProps: KindOfQuantityProps): void {\r\n    super.fromJSONSync(kindOfQuantityProps);\r\n    this._relativeError = kindOfQuantityProps.relativeError;\r\n\r\n    const persistenceUnit = this.schema.lookupItemSync<Unit>(kindOfQuantityProps.persistenceUnit);\r\n    if (undefined === persistenceUnit)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);\r\n\r\n    if (persistenceUnit.schemaItemType !== SchemaItemType.Unit && persistenceUnit.schemaItemType !== SchemaItemType.InvertedUnit)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);\r\n\r\n    this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);\r\n\r\n    if (undefined !== kindOfQuantityProps.presentationUnits)\r\n      this.processPresentationUnitsSync(kindOfQuantityProps.presentationUnits);\r\n  }\r\n\r\n  public override async fromJSON(kindOfQuantityProps: KindOfQuantityProps): Promise<void> {\r\n    await super.fromJSON(kindOfQuantityProps);\r\n    this._relativeError = kindOfQuantityProps.relativeError;\r\n\r\n    const persistenceUnit = await this.schema.lookupItem<Unit>(kindOfQuantityProps.persistenceUnit);\r\n    if (undefined === persistenceUnit)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);\r\n\r\n    if (persistenceUnit.schemaItemType !== SchemaItemType.Unit && persistenceUnit.schemaItemType !== SchemaItemType.InvertedUnit)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);\r\n\r\n    this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);\r\n\r\n    if (undefined !== kindOfQuantityProps.presentationUnits)\r\n      await this.processPresentationUnits(kindOfQuantityProps.presentationUnits);\r\n  }\r\n\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected setRelativeError(relativeError: number): void {\r\n    this._relativeError = relativeError;\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableKindOfQuantity extends KindOfQuantity {\r\n  public abstract override addPresentationFormat(format: Format | OverrideFormat, isDefault: boolean): void;\r\n  public abstract override createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[Unit | InvertedUnit, string | undefined]>): OverrideFormat;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

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

@@ -0,0 +1,55 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { MixinProps } from "../Deserialization/JsonProps";
+import { SchemaItemType, StrengthDirection } from "../ECObjects";
+import { LazyLoadedEntityClass } from "../Interfaces";
+import { ECClass } from "./Class";
+import { EntityClass } from "./EntityClass";
+import { NavigationProperty } from "./Property";
+import { RelationshipClass } from "./RelationshipClass";
+import { Schema } from "./Schema";
+/**
+ * A Typescript class representation of a Mixin.
+ * @beta
+ */
+export declare class Mixin extends ECClass {
+    readonly schemaItemType: SchemaItemType.Mixin;
+    protected _appliesTo?: LazyLoadedEntityClass;
+    get appliesTo(): LazyLoadedEntityClass | undefined;
+    constructor(schema: Schema, name: string);
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
+    /**
+     * @alpha Used for schema editing.
+     */
+    protected setAppliesTo(appliesTo: LazyLoadedEntityClass): void;
+    /**
+     * Save this Mixin'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): MixinProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(mixinProps: MixinProps): void;
+    fromJSON(mixinProps: MixinProps): Promise<void>;
+    applicableTo(entityClass: EntityClass): Promise<boolean>;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableMixin extends Mixin {
+    abstract setAppliesTo(entityClass: LazyLoadedEntityClass): void;
+    abstract createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    abstract createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
+//# sourceMappingURL=Mixin.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Mixin.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Mixin.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,OAAO,EAAmB,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAElF,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAA0D,WAAW,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;GAGG;AACH,qBAAa,KAAM,SAAQ,OAAO;IAChC,SAAyB,cAAc,EAAG,cAAc,CAAC,KAAK,CAAC;IAC/D,SAAS,CAAC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IAE7C,IAAW,SAAS,IAAI,qBAAqB,GAAG,SAAS,CAExD;gBAEW,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC;;;;;OAKG;cACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIpK,SAAS,CAAC,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;IAIzJ;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,qBAAqB;IAGvD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,UAAU;IAQtG,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA2BlD,YAAY,CAAC,UAAU,EAAE,UAAU;IAc7B,QAAQ,CAAC,UAAU,EAAE,UAAU;IAIxC,YAAY,CAAC,WAAW,EAAE,WAAW;CAUnD;AACD;;;GAGG;AACH,8BAAsB,YAAa,SAAQ,KAAK;aACrB,YAAY,CAAC,WAAW,EAAE,qBAAqB,GAAG,IAAI;aACtD,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;aACpJ,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;aAC/I,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/Mixin.js

@@ -0,0 +1,109 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { ECClassModifier, SchemaItemType } from "../ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { ECClass } from "./Class";
+import { createNavigationProperty, createNavigationPropertySync } from "./EntityClass";
+/**
+ * A Typescript class representation of a Mixin.
+ * @beta
+ */
+export class Mixin extends ECClass {
+    get appliesTo() {
+        return this._appliesTo;
+    }
+    constructor(schema, name) {
+        super(schema, name, ECClassModifier.Abstract);
+        this.schemaItemType = SchemaItemType.Mixin;
+    }
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    async createNavigationProperty(name, relationship, direction) {
+        return this.addProperty(await createNavigationProperty(this, name, relationship, direction));
+    }
+    createNavigationPropertySync(name, relationship, direction) {
+        return this.addProperty(createNavigationPropertySync(this, name, relationship, direction));
+    }
+    /**
+     * @alpha Used for schema editing.
+     */
+    setAppliesTo(appliesTo) {
+        this._appliesTo = appliesTo;
+    }
+    /**
+     * Save this Mixin'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);
+        if (undefined !== this.appliesTo) {
+            schemaJson.appliesTo = this.appliesTo.fullName;
+        }
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        // When CustomAttributes are added, there must be a check to see if the ECCustomAttributes
+        // already exist for this item before creating a new one to apply IsMixin
+        const customAttributes = schemaXml.createElement("ECCustomAttributes");
+        const isMixinElement = schemaXml.createElement("IsMixin");
+        const coreCustomSchema = this.schema.getReferenceSync("CoreCustomAttributes");
+        if (undefined !== coreCustomSchema) {
+            const xmlns = `CoreCustomAttributes.${coreCustomSchema.schemaKey.version.toString()}`;
+            isMixinElement.setAttribute("xmlns", xmlns);
+        }
+        const appliesToElement = schemaXml.createElement("AppliesToEntityClass");
+        const appliesTo = await this.appliesTo;
+        if (undefined !== appliesTo) {
+            const appliesToName = XmlSerializationUtils.createXmlTypedName(this.schema, appliesTo.schema, appliesTo.name);
+            appliesToElement.textContent = appliesToName;
+            isMixinElement.appendChild(appliesToElement);
+        }
+        customAttributes.appendChild(isMixinElement);
+        itemElement.appendChild(customAttributes);
+        return itemElement;
+    }
+    fromJSONSync(mixinProps) {
+        super.fromJSONSync(mixinProps);
+        const entityClassSchemaItemKey = this.schema.getSchemaItemKey(mixinProps.appliesTo);
+        if (!entityClassSchemaItemKey)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
+        this._appliesTo = new DelayedPromiseWithProps(entityClassSchemaItemKey, async () => {
+            const appliesTo = await this.schema.lookupItem(entityClassSchemaItemKey);
+            if (undefined === appliesTo)
+                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
+            return appliesTo;
+        });
+    }
+    async fromJSON(mixinProps) {
+        this.fromJSONSync(mixinProps);
+    }
+    async applicableTo(entityClass) {
+        if (!this.appliesTo)
+            throw new ECObjectsError(ECObjectsStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);
+        const appliesTo = await this.appliesTo;
+        if (appliesTo === undefined)
+            throw new ECObjectsError(ECObjectsStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);
+        return appliesTo.is(entityClass);
+    }
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export class MutableMixin extends Mixin {
+}
+//# sourceMappingURL=Mixin.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Mixin.js","sourceRoot":"","sources":["../../../src/Metadata/Mixin.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,eAAe,EAAE,cAAc,EAAqB,MAAM,cAAc,CAAC;AAClF,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,wBAAwB,EAAE,4BAA4B,EAAe,MAAM,eAAe,CAAC;AAKpG;;;GAGG;AACH,MAAM,OAAO,KAAM,SAAQ,OAAO;IAIhC,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,wBAAwB,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACpI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAES,4BAA4B,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAClI,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACO,YAAY,CAAC,SAAgC;QACrD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IACD;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACjD,CAAC;QACD,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,0FAA0F;QAC1F,yEAAyE;QACzE,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QACvE,MAAM,cAAc,GAAG,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;QAC9E,IAAI,SAAS,KAAK,gBAAgB,EAAE,CAAC;YACnC,MAAM,KAAK,GAAG,wBAAwB,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtF,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;QACzE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,aAAa,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;YAC9G,gBAAgB,CAAC,WAAW,GAAG,aAAa,CAAC;YAC7C,cAAc,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC/C,CAAC;QAED,gBAAgB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QAC7C,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAE1C,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,UAAsB;QACjD,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC/B,MAAM,wBAAwB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACpF,IAAI,CAAC,wBAAwB;YAC3B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;QACrH,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAuB,CAA6B,wBAAwB,EAChG,KAAK,IAAI,EAAE;YACT,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAc,wBAAwB,CAAC,CAAC;YACtF,IAAI,SAAS,KAAK,SAAS;gBACzB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;YACrH,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACP,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,UAAsB;QACnD,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,WAAwB;QAChD,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,uCAAuC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEjH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,kCAAkC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEtH,OAAO,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAgB,YAAa,SAAQ,KAAK;CAK/C","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 { MixinProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { ECClassModifier, SchemaItemType, StrengthDirection } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedEntityClass } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { ECClass } from \"./Class\";\r\nimport { createNavigationProperty, createNavigationPropertySync, EntityClass } from \"./EntityClass\";\r\nimport { NavigationProperty } from \"./Property\";\r\nimport { RelationshipClass } from \"./RelationshipClass\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/**\r\n * A Typescript class representation of a Mixin.\r\n * @beta\r\n */\r\nexport class Mixin extends ECClass {\r\n  public override readonly schemaItemType!: SchemaItemType.Mixin; // eslint-disable-line\r\n  protected _appliesTo?: LazyLoadedEntityClass;\r\n\r\n  public get appliesTo(): LazyLoadedEntityClass | undefined {\r\n    return this._appliesTo;\r\n  }\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name, ECClassModifier.Abstract);\r\n    this.schemaItemType = SchemaItemType.Mixin;\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param name\r\n   * @param relationship\r\n   * @param direction\r\n   */\r\n  protected async createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty> {\r\n    return this.addProperty(await createNavigationProperty(this, name, relationship, direction));\r\n  }\r\n\r\n  protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\r\n    return this.addProperty(createNavigationPropertySync(this, name, relationship, direction));\r\n  }\r\n\r\n  /**\r\n   * @alpha Used for schema editing.\r\n   */\r\n  protected setAppliesTo(appliesTo: LazyLoadedEntityClass) {\r\n    this._appliesTo = appliesTo;\r\n  }\r\n  /**\r\n   * Save this Mixin'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): MixinProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    if (undefined !== this.appliesTo) {\r\n      schemaJson.appliesTo = this.appliesTo.fullName;\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\r\n    // When CustomAttributes are added, there must be a check to see if the ECCustomAttributes\r\n    // already exist for this item before creating a new one to apply IsMixin\r\n    const customAttributes = schemaXml.createElement(\"ECCustomAttributes\");\r\n    const isMixinElement = schemaXml.createElement(\"IsMixin\");\r\n    const coreCustomSchema = this.schema.getReferenceSync(\"CoreCustomAttributes\");\r\n    if (undefined !== coreCustomSchema) {\r\n      const xmlns = `CoreCustomAttributes.${coreCustomSchema.schemaKey.version.toString()}`;\r\n      isMixinElement.setAttribute(\"xmlns\", xmlns);\r\n    }\r\n\r\n    const appliesToElement = schemaXml.createElement(\"AppliesToEntityClass\");\r\n    const appliesTo = await this.appliesTo;\r\n    if (undefined !== appliesTo) {\r\n      const appliesToName = XmlSerializationUtils.createXmlTypedName(this.schema, appliesTo.schema, appliesTo.name);\r\n      appliesToElement.textContent = appliesToName;\r\n      isMixinElement.appendChild(appliesToElement);\r\n    }\r\n\r\n    customAttributes.appendChild(isMixinElement);\r\n    itemElement.appendChild(customAttributes);\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(mixinProps: MixinProps) {\r\n    super.fromJSONSync(mixinProps);\r\n    const entityClassSchemaItemKey = this.schema.getSchemaItemKey(mixinProps.appliesTo);\r\n    if (!entityClassSchemaItemKey)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);\r\n    this._appliesTo = new DelayedPromiseWithProps<SchemaItemKey, EntityClass>(entityClassSchemaItemKey,\r\n      async () => {\r\n        const appliesTo = await this.schema.lookupItem<EntityClass>(entityClassSchemaItemKey);\r\n        if (undefined === appliesTo)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);\r\n        return appliesTo;\r\n      });\r\n  }\r\n\r\n  public override async fromJSON(mixinProps: MixinProps) {\r\n    this.fromJSONSync(mixinProps);\r\n  }\r\n\r\n  public async applicableTo(entityClass: EntityClass) {\r\n    if (!this.appliesTo)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);\r\n\r\n    const appliesTo = await this.appliesTo;\r\n    if (appliesTo === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);\r\n\r\n    return appliesTo.is(entityClass);\r\n  }\r\n}\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableMixin extends Mixin {\r\n  public abstract override setAppliesTo(entityClass: LazyLoadedEntityClass): void;\r\n  public abstract override createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;\r\n  public abstract override createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

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

@@ -0,0 +1,68 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { DecimalPrecision, FormatProps, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
+import { Format } from "./Format";
+import { InvertedUnit } from "./InvertedUnit";
+import { Schema } from "./Schema";
+import { SchemaItemOverrideFormatProps } from "../Deserialization/JsonProps";
+import { Unit } from "./Unit";
+/**
+ * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
+ * @beta
+ */
+export declare class OverrideFormat {
+    private _precision?;
+    private _units?;
+    /** The Format that this OverrideFormat is extending */
+    readonly parent: Format;
+    /** The name of this OverrideFormat.
+     *
+     * This should be set to the [FormatString]($docs/bis/ec/kindofquantity/#format-string) which represents the format override.
+     */
+    readonly name: string;
+    constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>);
+    get precision(): DecimalPrecision | FractionalPrecision;
+    get units(): [Unit | InvertedUnit, string | undefined][] | undefined;
+    get fullName(): string;
+    get roundFactor(): number;
+    get type(): FormatType;
+    get minWidth(): number | undefined;
+    get scientificType(): ScientificType | undefined;
+    get showSignOption(): ShowSignOption;
+    get decimalSeparator(): string;
+    get thousandSeparator(): string;
+    get uomSeparator(): string;
+    get stationSeparator(): string;
+    get stationOffsetSize(): number | undefined;
+    get formatTraits(): FormatTraits;
+    get spacer(): string | undefined;
+    get includeZero(): boolean | undefined;
+    hasFormatTrait(formatTrait: FormatTraits): boolean;
+    /** Returns the format string of this override in the Xml full name format.
+     * @alpha
+     */
+    fullNameXml(koqSchema: Schema): string;
+    /**
+     * Creates a valid OverrideFormat fullName from the parent Format and overridden units.
+     * @param parent The parent Format.
+     * @param unitAndLabels The overridden unit and labels collection.
+     */
+    static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[Unit | InvertedUnit, string | undefined]>): string;
+    /**
+     * @internal
+     */
+    static isOverrideFormat(object: any): object is OverrideFormat;
+    /**
+     * Returns a JSON object that contains the specification for the OverrideFormat where the precision and units properties have been overriden.
+     * If the precision and/or units properties have been overriden, the returned object will contain a "name" and a "parent" property.
+     * The "name" property identifies the OverrideFormat object itself and the "parent" property identifies the Format that has been overriden.
+     * This method is not intended for complete serialization as it does not serialize any of the schema item properties.
+     */
+    getFormatProps(): SchemaItemOverrideFormatProps;
+}
+/**
+ * @internal
+ */
+export declare function getFormatProps(format: Format | OverrideFormat): FormatProps;
+//# sourceMappingURL=OverrideFormat.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OverrideFormat.d.ts","sourceRoot":"","sources":["../../../src/Metadata/OverrideFormat.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACpJ,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAG9B;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAC,CAAyC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAmD;IAElE,uDAAuD;IACvD,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAQhJ,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAsF;IACpJ,IAAW,KAAK,4DAA4E;IAG5F,IAAW,QAAQ,IAAI,MAAM,CAAsB;IACnD,IAAW,WAAW,IAAI,MAAM,CAAoC;IACpE,IAAW,IAAI,IAAI,UAAU,CAA6B;IAC1D,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAiC;IAC1E,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAuC;IAC9F,IAAW,cAAc,IAAI,cAAc,CAAuC;IAClF,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,CAA0C;IAChF,IAAW,YAAY,IAAI,MAAM,CAAqC;IACtE,IAAW,gBAAgB,IAAI,MAAM,CAAyC;IAC9E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAA0C;IAC5F,IAAW,YAAY,IAAI,YAAY,CAAqC;IAC5E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA+B;IACtE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAoC;IAE1E,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;OAEG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;IAkB7C;;;;OAIG;WACW,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,MAAM;IAgBxL;;OAEG;WACW,gBAAgB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,cAAc;IAMrE;;;;;OAKG;IACI,cAAc,IAAI,6BAA6B;CA+BvD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,WAAW,CAE3E"}