@itwin/ecschema-metadata 5.0.0-dev.11 → 5.0.0-dev.110

package/lib/cjs/Metadata/KindOfQuantity.js

@@ -12,44 +12,50 @@ const DelayedPromise_1 = require("../DelayedPromise");
 const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
 const ECObjects_1 = require("../ECObjects");
 const Exception_1 = require("../Exception");
+const Format_1 = require("./Format");
+const InvertedUnit_1 = require("./InvertedUnit");
 const OverrideFormat_1 = require("./OverrideFormat");
 const SchemaItem_1 = require("./SchemaItem");
+const Unit_1 = require("./Unit");
 /** A Typescript class representation of a KindOfQuantity.
- * @beta
+ * @public @preview
  */
 class KindOfQuantity extends SchemaItem_1.SchemaItem {
+    schemaItemType = KindOfQuantity.schemaItemType;
+    /** @internal */
+    static get schemaItemType() { return ECObjects_1.SchemaItemType.KindOfQuantity; }
+    _relativeError = 1.0;
+    _presentationFormats = [];
+    _persistenceUnit;
     /** 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; }
+    /** Persistence unit */
     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 = ECObjects_1.SchemaItemType.KindOfQuantity; // Needed to allow both run-time and compile-time check.
-    }
     /**
      *
      * @param format The Format to add to this KindOfQuantity
      * @param isDefault
+     * @internal
      */
     addPresentationFormat(format, isDefault = false) {
         // TODO: Add some sort of validation?
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         (isDefault) ? this._presentationFormats.splice(0, 0, format) : this._presentationFormats.push(format);
     }
     /** 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.
+     * @internal
      */
     createFormatOverride(parent, precision, unitLabelOverrides) {
         if (unitLabelOverrides && parent.units && parent.units.length !== unitLabelOverrides.length)
-            throw new Exception_1.ECObjectsError(Exception_1.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}'.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.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 Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Cannot add a presentation format to KindOfQuantity '${this.name}' without any units and no unit overrides.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.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_1.OverrideFormat(parent, precision, unitLabelOverrides);
     }
@@ -57,23 +63,26 @@ class KindOfQuantity extends SchemaItem_1.SchemaItem {
         const presUnitsArr = Array.isArray(presentationUnitsJson) ? presentationUnitsJson : presentationUnitsJson.split(";");
         for (const formatString of presUnitsArr) {
             const presFormatOverride = OverrideFormat_1.OverrideFormat.parseFormatString(formatString);
-            const format = await this.schema.lookupItem(presFormatOverride.name);
+            const format = await this.schema.lookupItem(presFormatOverride.name, Format_1.Format);
             if (undefined === format || format.schemaItemType !== ECObjects_1.SchemaItemType.Format)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate Format '${presFormatOverride.name}' for the presentation unit on KindOfQuantity ${this.fullName}.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.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);
+                this.addPresentationFormat(new DelayedPromise_1.DelayedPromiseWithProps(format.key, async () => format));
                 continue;
             }
             let unitAndLabels;
             if (undefined !== presFormatOverride.unitAndLabels) {
                 if (4 < presFormatOverride.unitAndLabels.length)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
                 unitAndLabels = [];
                 for (const unitOverride of presFormatOverride.unitAndLabels) {
-                    const unit = await this.schema.lookupItem(unitOverride[0]);
-                    if (undefined === unit)
-                        throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);
-                    unitAndLabels.push([unit, unitOverride[1]]);
+                    const unitOrInverted = await this.schema.lookupItem(unitOverride[0]);
+                    if (Unit_1.Unit.isUnit(unitOrInverted))
+                        unitAndLabels.push([new DelayedPromise_1.DelayedPromiseWithProps(unitOrInverted.key, async () => unitOrInverted), unitOverride[1]]);
+                    else if (InvertedUnit_1.InvertedUnit.isInvertedUnit(unitOrInverted))
+                        unitAndLabels.push([new DelayedPromise_1.DelayedPromiseWithProps(unitOrInverted.key, async () => unitOrInverted), unitOverride[1]]);
+                    else
+                        throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);
                 }
             }
             const overrideFormat = this.createFormatOverride(format, presFormatOverride.precision, unitAndLabels);
@@ -84,23 +93,26 @@ class KindOfQuantity extends SchemaItem_1.SchemaItem {
         const presUnitsArr = Array.isArray(presentationUnitsJson) ? presentationUnitsJson : presentationUnitsJson.split(";");
         for (const formatString of presUnitsArr) {
             const presFormatOverride = OverrideFormat_1.OverrideFormat.parseFormatString(formatString);
-            const format = this.schema.lookupItemSync(presFormatOverride.name);
+            const format = this.schema.lookupItemSync(presFormatOverride.name, Format_1.Format);
             if (undefined === format || format.schemaItemType !== ECObjects_1.SchemaItemType.Format)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate Format '${presFormatOverride.name}' for the presentation unit on KindOfQuantity ${this.fullName}.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.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);
+                this.addPresentationFormat(new DelayedPromise_1.DelayedPromiseWithProps(format.key, async () => format));
                 continue;
             }
             let unitAndLabels;
             if (undefined !== presFormatOverride.unitAndLabels) {
                 if (4 < presFormatOverride.unitAndLabels.length)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
                 unitAndLabels = [];
                 for (const unitOverride of presFormatOverride.unitAndLabels) {
-                    const unit = this.schema.lookupItemSync(unitOverride[0]);
-                    if (undefined === unit)
-                        throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);
-                    unitAndLabels.push([unit, unitOverride[1]]);
+                    const unitOrInverted = this.schema.lookupItemSync(unitOverride[0]);
+                    if (Unit_1.Unit.isUnit(unitOrInverted))
+                        unitAndLabels.push([new DelayedPromise_1.DelayedPromiseWithProps(unitOrInverted.key, async () => unitOrInverted), unitOverride[1]]);
+                    else if (InvertedUnit_1.InvertedUnit.isInvertedUnit(unitOrInverted))
+                        unitAndLabels.push([new DelayedPromise_1.DelayedPromiseWithProps(unitOrInverted.key, async () => unitOrInverted), unitOverride[1]]);
+                    else
+                        throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);
                 }
             }
             const overrideFormat = this.createFormatOverride(format, presFormatOverride.precision, unitAndLabels);
@@ -129,11 +141,16 @@ class KindOfQuantity extends SchemaItem_1.SchemaItem {
             itemElement.setAttribute("persistenceUnit", unitName);
         }
         if (undefined !== this.presentationFormats) {
-            const presUnitStrings = this.presentationFormats.map((format) => {
-                if (!OverrideFormat_1.OverrideFormat.isOverrideFormat(format))
-                    return XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, format.schema, format.name);
-                return format.fullNameXml(this.schema);
-            });
+            const presUnitStrings = [];
+            for (const format of this.presentationFormats) {
+                if (!OverrideFormat_1.OverrideFormat.isOverrideFormat(format)) {
+                    const resolvedFormat = await format;
+                    presUnitStrings.push(XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, resolvedFormat.schema, format.name));
+                    continue;
+                }
+                presUnitStrings.push(format.fullNameXml(this.schema));
+            }
+            ;
             itemElement.setAttribute("presentationUnits", presUnitStrings.join(";"));
         }
         itemElement.setAttribute("relativeError", this.relativeError.toString());
@@ -144,10 +161,13 @@ class KindOfQuantity extends SchemaItem_1.SchemaItem {
         this._relativeError = kindOfQuantityProps.relativeError;
         const persistenceUnit = this.schema.lookupItemSync(kindOfQuantityProps.persistenceUnit);
         if (undefined === persistenceUnit)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);
-        if (persistenceUnit.schemaItemType !== ECObjects_1.SchemaItemType.Unit && persistenceUnit.schemaItemType !== ECObjects_1.SchemaItemType.InvertedUnit)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);
-        this._persistenceUnit = new DelayedPromise_1.DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);
+        if (!Unit_1.Unit.isUnit(persistenceUnit) && !InvertedUnit_1.InvertedUnit.isInvertedUnit(persistenceUnit))
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);
+        if (Unit_1.Unit.isUnit(persistenceUnit))
+            this._persistenceUnit = new DelayedPromise_1.DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+        else
+            this._persistenceUnit = new DelayedPromise_1.DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
         if (undefined !== kindOfQuantityProps.presentationUnits)
             this.processPresentationUnitsSync(kindOfQuantityProps.presentationUnits);
     }
@@ -156,20 +176,50 @@ class KindOfQuantity extends SchemaItem_1.SchemaItem {
         this._relativeError = kindOfQuantityProps.relativeError;
         const persistenceUnit = await this.schema.lookupItem(kindOfQuantityProps.persistenceUnit);
         if (undefined === persistenceUnit)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);
-        if (persistenceUnit.schemaItemType !== ECObjects_1.SchemaItemType.Unit && persistenceUnit.schemaItemType !== ECObjects_1.SchemaItemType.InvertedUnit)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);
-        this._persistenceUnit = new DelayedPromise_1.DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);
+        if (!Unit_1.Unit.isUnit(persistenceUnit) && !InvertedUnit_1.InvertedUnit.isInvertedUnit(persistenceUnit))
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);
+        if (Unit_1.Unit.isUnit(persistenceUnit))
+            this._persistenceUnit = new DelayedPromise_1.DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
+        else
+            this._persistenceUnit = new DelayedPromise_1.DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);
         if (undefined !== kindOfQuantityProps.presentationUnits)
             await this.processPresentationUnits(kindOfQuantityProps.presentationUnits);
     }
     /**
-     * @alpha
      * Used for schema editing.
+     * @internal
      */
     setRelativeError(relativeError) {
         this._relativeError = relativeError;
     }
+    /**
+     * Used for schema editing.
+     * @internal
+     */
+    setPersistenceUnit(value) {
+        this._persistenceUnit = value;
+    }
+    /**
+     * Type guard to check if the SchemaItem is of type KindOfQuantity.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a KindOfQuantity, false otherwise.
+     */
+    static isKindOfQuantity(item) {
+        if (item && item.schemaItemType === ECObjects_1.SchemaItemType.KindOfQuantity)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type KindOfQuantity.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to KindOfQuantity if it is a KindOfQuantity, undefined otherwise.
+     * @internal
+     */
+    static assertIsKindOfQuantity(item) {
+        if (!this.isKindOfQuantity(item))
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.KindOfQuantity}' (KindOfQuantity)`);
+    }
 }
 exports.KindOfQuantity = KindOfQuantity;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"KindOfQuantity.js","sourceRoot":"","sources":["../../../src/Metadata/KindOfQuantity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4D;AAE5D,oFAAiF;AACjF,4CAA8C;AAC9C,4CAA+D;AAI/D,qDAAuE;AAEvE,6CAA0C;AAG1C;;GAEG;AACH,MAAa,cAAe,SAAQ,uBAAU;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,0BAAc,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;;;;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,0BAAc,CAAC,2BAAe,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,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,uDAAuD,IAAI,CAAC,IAAI,4CAA4C,CAAC,CAAC;QAExK,wEAAwE;QAExE,OAAO,IAAI,+BAAc,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,+BAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAE/F,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,0BAAc,CAAC,MAAM;gBACzE,MAAM,IAAI,0BAAc,CAAC,2BAAe,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,0BAAc,CAAC,2BAAe,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,0BAAc,CAAC,2BAAe,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,+BAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAE/F,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAS,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC3E,IAAI,SAAS,KAAK,MAAM,IAAI,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM;gBACzE,MAAM,IAAI,0BAAc,CAAC,2BAAe,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,0BAAc,CAAC,2BAAe,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,0BAAc,CAAC,2BAAe,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,6CAAqB,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,+BAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC;oBAC1C,OAAO,6CAAqB,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,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,kBAAkB,CAAC,CAAC;QAE7H,IAAI,eAAe,CAAC,cAAc,KAAK,0BAAc,CAAC,IAAI,IAAI,eAAe,CAAC,cAAc,KAAK,0BAAc,CAAC,YAAY;YAC1H,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,iCAAiC,CAAC,CAAC;QAE5I,IAAI,CAAC,gBAAgB,GAAG,IAAI,wCAAuB,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,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,kBAAkB,CAAC,CAAC;QAE7H,IAAI,eAAe,CAAC,cAAc,KAAK,0BAAc,CAAC,IAAI,IAAI,eAAe,CAAC,cAAc,KAAK,0BAAc,CAAC,YAAY;YAC1H,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,iCAAiC,CAAC,CAAC;QAE5I,IAAI,CAAC,gBAAgB,GAAG,IAAI,wCAAuB,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;AAnMD,wCAmMC;AACD;;;GAGG;AACH,MAAsB,qBAAsB,SAAQ,cAAc;CAIjE;AAJD,sDAIC","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 { Format } from \"./Format\";\r\nimport { InvertedUnit } from \"./InvertedUnit\";\r\nimport { OverrideFormat, OverrideFormatProps } from \"./OverrideFormat\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { Unit } from \"./Unit\";\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;\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  /** 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 = OverrideFormat.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 = OverrideFormat.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"]}
+{"version":3,"file":"KindOfQuantity.js","sourceRoot":"","sources":["../../../src/Metadata/KindOfQuantity.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4D;AAE5D,oFAAiF;AACjF,4CAA8C;AAC9C,4CAA6D;AAE7D,qCAAkC;AAClC,iDAA8C;AAC9C,qDAAuE;AACvE,6CAA0C;AAC1C,iCAA8B;AAE9B;;GAEG;AACH,MAAa,cAAe,SAAQ,uBAAU;IACnB,cAAc,GAAG,cAAc,CAAC,cAAc,CAAC;IACxE,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7E,cAAc,GAAW,GAAG,CAAC;IAC7B,oBAAoB,GAA6C,EAAE,CAAC;IACpE,gBAAgB,CAA2C;IAEnE,4DAA4D;IAC5D,IAAW,yBAAyB,KAAoD,OAAO,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE7H,sCAAsC;IACtC,IAAW,mBAAmB,KAA+C,OAAO,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAEhH,uBAAuB;IACvB,IAAW,eAAe,KAA0D,OAAO,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEnH,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAE1D;;;;;OAKG;IACO,qBAAqB,CAAC,MAAyC,EAAE,YAAqB,KAAK;QACnG,qCAAqC;QACrC,mEAAmE;QACnE,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;;;;;OAKG;IACO,oBAAoB,CAAC,MAAc,EAAE,SAAkB,EAAE,kBAAyF;QAC1J,IAAI,kBAAkB,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,kBAAkB,CAAC,MAAM;YACzF,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,qDAAqD,IAAI,CAAC,IAAI,yFAAyF,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC;QAEhO,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,kBAAkB,IAAI,CAAC,GAAG,kBAAkB,CAAC,MAAM;YAClG,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,uDAAuD,IAAI,CAAC,IAAI,4CAA4C,CAAC,CAAC;QAEtK,wEAAwE;QAExE,OAAO,IAAI,+BAAc,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,+BAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAE/F,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,IAAI,EAAE,eAAM,CAAC,CAAC;YAC7E,IAAI,SAAS,KAAK,MAAM,IAAI,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM;gBACzE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,4BAA4B,kBAAkB,CAAC,IAAI,iDAAiD,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;YAE9K,IAAI,SAAS,KAAK,kBAAkB,CAAC,SAAS,IAAI,SAAS,KAAK,kBAAkB,CAAC,aAAa,EAAE,CAAC;gBACjG,IAAI,CAAC,qBAAqB,CAAC,IAAI,wCAAuB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;gBACxF,SAAS;YACX,CAAC;YAED,IAAI,aAA+F,CAAC;YACpG,IAAI,SAAS,KAAK,kBAAkB,CAAC,aAAa,EAAE,CAAC;gBACnD,IAAI,CAAC,GAAG,kBAAkB,CAAC,aAAa,CAAC,MAAM;oBAC7C,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBAE5D,aAAa,GAAG,EAAE,CAAC;gBACnB,KAAK,MAAM,YAAY,IAAI,kBAAkB,CAAC,aAAa,EAAE,CAAC;oBAC5D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;oBAErE,IAAG,WAAI,CAAC,MAAM,CAAC,cAAc,CAAC;wBAC5B,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,wCAAuB,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;yBAChH,IAAG,2BAAY,CAAC,cAAc,CAAC,cAAc,CAAC;wBACjD,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,wCAAuB,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;;wBAEnH,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,+BAA+B,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC7G,CAAC;YACH,CAAC;YAED,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACtG,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,+BAAc,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAE/F,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,kBAAkB,CAAC,IAAI,EAAE,eAAM,CAAC,CAAC;YAC3E,IAAI,SAAS,KAAK,MAAM,IAAI,MAAM,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM;gBACzE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,4BAA4B,kBAAkB,CAAC,IAAI,iDAAiD,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;YAE9K,IAAI,SAAS,KAAK,kBAAkB,CAAC,SAAS,IAAI,SAAS,KAAK,kBAAkB,CAAC,aAAa,EAAE,CAAC;gBACjG,IAAI,CAAC,qBAAqB,CAAC,IAAI,wCAAuB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;gBACxF,SAAS;YACX,CAAC;YAED,IAAI,aAA+F,CAAC;YACpG,IAAI,SAAS,KAAK,kBAAkB,CAAC,aAAa,EAAE,CAAC;gBACnD,IAAI,CAAC,GAAG,kBAAkB,CAAC,aAAa,CAAC,MAAM;oBAC7C,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBAE5D,aAAa,GAAG,EAAE,CAAC;gBACnB,KAAK,MAAM,YAAY,IAAI,kBAAkB,CAAC,aAAa,EAAE,CAAC;oBAC5D,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;oBACnE,IAAG,WAAI,CAAC,MAAM,CAAC,cAAc,CAAC;wBAC5B,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,wCAAuB,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;yBAChH,IAAG,2BAAY,CAAC,cAAc,CAAC,cAAc,CAAC;wBACjD,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,wCAAuB,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;;wBAErH,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,+BAA+B,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC3G,CAAC;YACH,CAAC;YAED,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACtG,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,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC3F,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,6CAAqB,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,GAAa,EAAE,CAAC;YACrC,KAAI,MAAM,MAAM,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC7C,IAAI,CAAC,+BAAc,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC7C,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC;oBACpC,eAAe,CAAC,IAAI,CAAC,6CAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBAChH,SAAS;gBACX,CAAC;gBACD,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACxD,CAAC;YAAA,CAAC;YACF,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,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QACxF,IAAI,SAAS,KAAK,eAAe;YAC/B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,kBAAkB,CAAC,CAAC;QAE3H,IAAI,CAAC,WAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,2BAAY,CAAC,cAAc,CAAC,eAAe,CAAC;YAChF,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,iCAAiC,CAAC,CAAC;QAE1I,IAAI,WAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YAC9B,IAAI,CAAC,gBAAgB,GAAG,IAAI,wCAAuB,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC;;YAEtG,IAAI,CAAC,gBAAgB,GAAG,IAAI,wCAAuB,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC;QAExG,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,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;QAC1F,IAAI,SAAS,KAAK,eAAe;YAC/B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,kBAAkB,CAAC,CAAC;QAE3H,IAAI,CAAC,WAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,2BAAY,CAAC,cAAc,CAAC,eAAe,CAAC;YAChF,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,YAAY,mBAAmB,CAAC,eAAe,iCAAiC,CAAC,CAAC;QAE1I,IAAI,WAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YAC9B,IAAI,CAAC,gBAAgB,GAAG,IAAI,wCAAuB,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC;;YAEtG,IAAI,CAAC,gBAAgB,GAAG,IAAI,wCAAuB,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC;QAGxG,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;IAED;;;OAGG;IACO,kBAAkB,CAAC,KAA0D;QACrF,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAiB;QAC9C,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,cAAc;YAC/D,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAAiB;QACpD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;YAC9B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,cAAc,oBAAoB,CAAC,CAAC;IAClI,CAAC;CACF;AAlPD,wCAkPC;AACD;;;GAGG;AACH,MAAsB,qBAAsB,SAAQ,cAAc;CAMjE;AAND,sDAMC","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 { ECSchemaError, ECSchemaStatus } from \"../Exception\";\r\nimport { LazyLoadedFormat, LazyLoadedInvertedUnit, LazyLoadedUnit } from \"../Interfaces\";\r\nimport { Format } from \"./Format\";\r\nimport { InvertedUnit } from \"./InvertedUnit\";\r\nimport { OverrideFormat, OverrideFormatProps } from \"./OverrideFormat\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\nimport { Unit } from \"./Unit\";\r\n\r\n/** A Typescript class representation of a KindOfQuantity.\r\n * @public @preview\r\n */\r\nexport class KindOfQuantity extends SchemaItem {\r\n  public override readonly schemaItemType = KindOfQuantity.schemaItemType;\r\n  /** @internal */\r\n  public static override get schemaItemType() { return SchemaItemType.KindOfQuantity; }\r\n  private _relativeError: number = 1.0;\r\n  private _presentationFormats: Array<LazyLoadedFormat | OverrideFormat> = [];\r\n  private _persistenceUnit?: LazyLoadedUnit | LazyLoadedInvertedUnit;\r\n\r\n  /** The first presentation format in the list of Formats. */\r\n  public get defaultPresentationFormat(): LazyLoadedFormat | OverrideFormat | undefined { return this.presentationFormats[0]; }\r\n\r\n  /** A list of presentation formats. */\r\n  public get presentationFormats(): Array<LazyLoadedFormat | OverrideFormat> { return this._presentationFormats; }\r\n\r\n  /** Persistence unit */\r\n  public get persistenceUnit(): LazyLoadedUnit | LazyLoadedInvertedUnit | undefined { return this._persistenceUnit; }\r\n\r\n  public get relativeError() { return this._relativeError; }\r\n\r\n  /**\r\n   *\r\n   * @param format The Format to add to this KindOfQuantity\r\n   * @param isDefault\r\n   * @internal\r\n   */\r\n  protected addPresentationFormat(format: LazyLoadedFormat | OverrideFormat, isDefault: boolean = false) {\r\n    // TODO: Add some sort of validation?\r\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n    (isDefault) ? this._presentationFormats.splice(0, 0, format) : this._presentationFormats.push(format);\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   * @internal\r\n   */\r\n  protected createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>): OverrideFormat {\r\n    if (unitLabelOverrides && parent.units && parent.units.length !== unitLabelOverrides.length)\r\n      throw new ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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 = OverrideFormat.parseFormatString(formatString);\r\n\r\n      const format = await this.schema.lookupItem(presFormatOverride.name, Format);\r\n      if (undefined === format || format.schemaItemType !== SchemaItemType.Format)\r\n        throw new ECSchemaError(ECSchemaStatus.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(new DelayedPromiseWithProps(format.key, async () => format));\r\n        continue;\r\n      }\r\n\r\n      let unitAndLabels: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined;\r\n      if (undefined !== presFormatOverride.unitAndLabels) {\r\n        if (4 < presFormatOverride.unitAndLabels.length)\r\n          throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);\r\n\r\n        unitAndLabels = [];\r\n        for (const unitOverride of presFormatOverride.unitAndLabels) {\r\n          const unitOrInverted = await this.schema.lookupItem(unitOverride[0]);\r\n          \r\n          if(Unit.isUnit(unitOrInverted))\r\n            unitAndLabels.push([new DelayedPromiseWithProps(unitOrInverted.key, async () => unitOrInverted), unitOverride[1]]);\r\n          else if(InvertedUnit.isInvertedUnit(unitOrInverted))\r\n            unitAndLabels.push([new DelayedPromiseWithProps(unitOrInverted.key, async () => unitOrInverted), unitOverride[1]]);\r\n          else\r\n            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);\r\n        }\r\n      }\r\n\r\n      const 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 = OverrideFormat.parseFormatString(formatString);\r\n\r\n      const format = this.schema.lookupItemSync(presFormatOverride.name, Format);\r\n      if (undefined === format || format.schemaItemType !== SchemaItemType.Format)\r\n        throw new ECSchemaError(ECSchemaStatus.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(new DelayedPromiseWithProps(format.key, async () => format));\r\n        continue;\r\n      }\r\n\r\n      let unitAndLabels: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined;\r\n      if (undefined !== presFormatOverride.unitAndLabels) {\r\n        if (4 < presFormatOverride.unitAndLabels.length)\r\n          throw new ECSchemaError(ECSchemaStatus.InvalidECJson, ``);\r\n\r\n        unitAndLabels = [];\r\n        for (const unitOverride of presFormatOverride.unitAndLabels) {\r\n          const unitOrInverted = this.schema.lookupItemSync(unitOverride[0]);\r\n          if(Unit.isUnit(unitOrInverted))\r\n            unitAndLabels.push([new DelayedPromiseWithProps(unitOrInverted.key, async () => unitOrInverted), unitOverride[1]]);\r\n          else if(InvertedUnit.isInvertedUnit(unitOrInverted))\r\n            unitAndLabels.push([new DelayedPromiseWithProps(unitOrInverted.key, async () => unitOrInverted), unitOverride[1]]);\r\n          else\r\n          throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${unitOverride[0]}.`);\r\n        }\r\n      }\r\n\r\n      const 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.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: string[] = [];\r\n      for(const format of this.presentationFormats) {\r\n        if (!OverrideFormat.isOverrideFormat(format)) {\r\n          const resolvedFormat = await format;\r\n          presUnitStrings.push(XmlSerializationUtils.createXmlTypedName(this.schema, resolvedFormat.schema, format.name));\r\n          continue;\r\n        }\r\n        presUnitStrings.push(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(kindOfQuantityProps.persistenceUnit);\r\n    if (undefined === persistenceUnit)\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);\r\n\r\n    if (!Unit.isUnit(persistenceUnit) && !InvertedUnit.isInvertedUnit(persistenceUnit))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);\r\n\r\n    if (Unit.isUnit(persistenceUnit))\r\n      this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);\r\n    else\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(kindOfQuantityProps.persistenceUnit);\r\n    if (undefined === persistenceUnit)\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Unit ${kindOfQuantityProps.persistenceUnit} does not exist.`);\r\n\r\n    if (!Unit.isUnit(persistenceUnit) && !InvertedUnit.isInvertedUnit(persistenceUnit))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The item ${kindOfQuantityProps.persistenceUnit} is not a Unit or InvertedUnit.`);\r\n\r\n    if (Unit.isUnit(persistenceUnit))\r\n      this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);\r\n    else\r\n      this._persistenceUnit = new DelayedPromiseWithProps(persistenceUnit.key, async () => persistenceUnit);\r\n\r\n\r\n    if (undefined !== kindOfQuantityProps.presentationUnits)\r\n      await this.processPresentationUnits(kindOfQuantityProps.presentationUnits);\r\n  }\r\n\r\n  /**\r\n   * Used for schema editing.\r\n   * @internal\r\n   */\r\n  protected setRelativeError(relativeError: number): void {\r\n    this._relativeError = relativeError;\r\n  }\r\n\r\n  /**\r\n   * Used for schema editing.\r\n   * @internal\r\n   */\r\n  protected setPersistenceUnit(value: LazyLoadedUnit | LazyLoadedInvertedUnit | undefined): void {\r\n    this._persistenceUnit = value;\r\n  }\r\n\r\n  /**\r\n   * Type guard to check if the SchemaItem is of type KindOfQuantity.\r\n   * @param item The SchemaItem to check.\r\n   * @returns True if the item is a KindOfQuantity, false otherwise.\r\n   */\r\n  public static isKindOfQuantity(item?: SchemaItem): item is KindOfQuantity {\r\n    if (item && item.schemaItemType === SchemaItemType.KindOfQuantity)\r\n      return true;\r\n\r\n    return false;\r\n  }\r\n\r\n  /**\r\n   * Type assertion to check if the SchemaItem is of type KindOfQuantity.\r\n   * @param item The SchemaItem to check.\r\n   * @returns The item cast to KindOfQuantity if it is a KindOfQuantity, undefined otherwise.\r\n   * @internal\r\n   */\r\n  public static assertIsKindOfQuantity(item?: SchemaItem): asserts item is KindOfQuantity {\r\n    if (!this.isKindOfQuantity(item))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.KindOfQuantity}' (KindOfQuantity)`);\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: LazyLoadedFormat | OverrideFormat, isDefault: boolean): void;\r\n  public abstract override createFormatOverride(parent: Format, precision?: number, unitLabelOverrides?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>): OverrideFormat;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n  public abstract override setPersistenceUnit(value: LazyLoadedUnit | LazyLoadedInvertedUnit | undefined): void;\r\n  public abstract override setRelativeError(relativeError: number): void;\r\n}\r\n"]}

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

@@ -9,25 +9,39 @@ import { EntityClass } from "./EntityClass";
 import { NavigationProperty } from "./Property";
 import { RelationshipClass } from "./RelationshipClass";
 import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
 /**
  * A Typescript class representation of a Mixin.
- * @beta
+ * @public @preview
  */
 export declare class Mixin extends ECClass {
-    readonly schemaItemType: SchemaItemType.Mixin;
-    protected _appliesTo?: LazyLoadedEntityClass;
+    readonly schemaItemType: SchemaItemType;
+    /** @internal */
+    static get schemaItemType(): SchemaItemType;
+    private _appliesTo?;
     get appliesTo(): LazyLoadedEntityClass | undefined;
+    /** @internal */
     constructor(schema: Schema, name: string);
     /**
      *
      * @param name
      * @param relationship
      * @param direction
+     * @internal
      */
     protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     * @returns
+     *
+     * @internal
+     */
     protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
     /**
-     * @alpha Used for schema editing.
+     * @internal
      */
     protected setAppliesTo(appliesTo: LazyLoadedEntityClass): void;
     /**
@@ -41,6 +55,19 @@ export declare class Mixin extends ECClass {
     fromJSONSync(mixinProps: MixinProps): void;
     fromJSON(mixinProps: MixinProps): Promise<void>;
     applicableTo(entityClass: EntityClass): Promise<boolean>;
+    /**
+     * Type guard to check if the SchemaItem is of type Mixin.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a Mixin, false otherwise.
+     */
+    static isMixin(item?: SchemaItem): item is Mixin;
+    /**
+     * Type assertion to check if the SchemaItem is of type Mixin.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Mixin if it is a Mixin, undefined otherwise.
+     * @internal
+     */
+    static assertIsMixin(item?: SchemaItem): asserts item is Mixin;
 }
 /**
  * @internal

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

@@ -1 +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"}
+{"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;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,qBAAa,KAAM,SAAQ,OAAO;IAChC,SAAyB,cAAc,iBAAwB;IAC/D,gBAAgB;IAChB,WAA2B,cAAc,mBAAmC;IAC5E,OAAO,CAAC,UAAU,CAAC,CAAwB;IAE3C,IAAW,SAAS,IAAI,qBAAqB,GAAG,SAAS,CAExD;IAED,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAIxC;;;;;;OAMG;cACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIpK;;;;;;;;OAQG;IACH,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;IAIvD;;;;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;IAWlD;;;;OAIG;WACW,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,KAAK;IAOvD;;;;;OAKG;WACW,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK;CAItE;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/cjs/Metadata/Mixin.js

@@ -16,30 +16,44 @@ const Class_1 = require("./Class");
 const EntityClass_1 = require("./EntityClass");
 /**
  * A Typescript class representation of a Mixin.
- * @beta
+ * @public @preview
  */
 class Mixin extends Class_1.ECClass {
+    schemaItemType = Mixin.schemaItemType;
+    /** @internal */
+    static get schemaItemType() { return ECObjects_1.SchemaItemType.Mixin; }
+    _appliesTo;
     get appliesTo() {
         return this._appliesTo;
     }
+    /** @internal */
     constructor(schema, name) {
         super(schema, name, ECObjects_1.ECClassModifier.Abstract);
-        this.schemaItemType = ECObjects_1.SchemaItemType.Mixin;
     }
     /**
      *
      * @param name
      * @param relationship
      * @param direction
+     * @internal
      */
     async createNavigationProperty(name, relationship, direction) {
         return this.addProperty(await (0, EntityClass_1.createNavigationProperty)(this, name, relationship, direction));
     }
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     * @returns
+     *
+     * @internal
+     */
     createNavigationPropertySync(name, relationship, direction) {
         return this.addProperty((0, EntityClass_1.createNavigationPropertySync)(this, name, relationship, direction));
     }
     /**
-     * @alpha Used for schema editing.
+     * @internal
      */
     setAppliesTo(appliesTo) {
         this._appliesTo = appliesTo;
@@ -83,11 +97,11 @@ class Mixin extends Class_1.ECClass {
         super.fromJSONSync(mixinProps);
         const entityClassSchemaItemKey = this.schema.getSchemaItemKey(mixinProps.appliesTo);
         if (!entityClassSchemaItemKey)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
         this._appliesTo = new DelayedPromise_1.DelayedPromiseWithProps(entityClassSchemaItemKey, async () => {
-            const appliesTo = await this.schema.lookupItem(entityClassSchemaItemKey);
+            const appliesTo = await this.schema.lookupItem(entityClassSchemaItemKey, EntityClass_1.EntityClass);
             if (undefined === appliesTo)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the appliesTo ${mixinProps.appliesTo}.`);
             return appliesTo;
         });
     }
@@ -96,12 +110,32 @@ class Mixin extends Class_1.ECClass {
     }
     async applicableTo(entityClass) {
         if (!this.appliesTo)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidType, `appliesTo is undefined in the class ${this.fullName}.`);
         const appliesTo = await this.appliesTo;
         if (appliesTo === undefined)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidType, `Unable to locate the appliesTo ${this.appliesTo.fullName}.`);
         return appliesTo.is(entityClass);
     }
+    /**
+     * Type guard to check if the SchemaItem is of type Mixin.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a Mixin, false otherwise.
+     */
+    static isMixin(item) {
+        if (item && item.schemaItemType === ECObjects_1.SchemaItemType.Mixin)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type Mixin.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Mixin if it is a Mixin, undefined otherwise.
+     * @internal
+     */
+    static assertIsMixin(item) {
+        if (!this.isMixin(item))
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Mixin}' (Mixin)`);
+    }
 }
 exports.Mixin = Mixin;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"Mixin.js","sourceRoot":"","sources":["../../../src/Metadata/Mixin.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4D;AAE5D,oFAAiF;AACjF,4CAAkF;AAClF,4CAA+D;AAG/D,mCAAkC;AAClC,+CAAoG;AAKpG;;;GAGG;AACH,MAAa,KAAM,SAAQ,eAAO;IAIhC,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,2BAAe,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,0BAAc,CAAC,KAAK,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,wBAAwB,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACpI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,IAAA,sCAAwB,EAAC,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,IAAA,0CAA4B,EAAC,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,6CAAqB,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,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;QACrH,IAAI,CAAC,UAAU,GAAG,IAAI,wCAAuB,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,0BAAc,CAAC,2BAAe,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,0BAAc,CAAC,2BAAe,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,0BAAc,CAAC,2BAAe,CAAC,WAAW,EAAE,kCAAkC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEtH,OAAO,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;CACF;AAtGD,sBAsGC;AACD;;;GAGG;AACH,MAAsB,YAAa,SAAQ,KAAK;CAK/C;AALD,oCAKC","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;\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"]}
+{"version":3,"file":"Mixin.js","sourceRoot":"","sources":["../../../src/Metadata/Mixin.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4D;AAE5D,oFAAiF;AACjF,4CAAkF;AAClF,4CAA6D;AAG7D,mCAAkC;AAClC,+CAAoG;AAMpG;;;GAGG;AACH,MAAa,KAAM,SAAQ,eAAO;IACP,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC/D,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,UAAU,CAAyB;IAE3C,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,2BAAe,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,wBAAwB,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACpI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,IAAA,sCAAwB,EAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;OAQG;IACO,4BAA4B,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAClI,OAAO,IAAI,CAAC,WAAW,CAAC,IAAA,0CAA4B,EAAC,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;IAED;;;;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,6CAAqB,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,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;QACnH,IAAI,CAAC,UAAU,GAAG,IAAI,wCAAuB,CAA6B,wBAAwB,EAChG,KAAK,IAAI,EAAE;YACT,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,wBAAwB,EAAE,yBAAW,CAAC,CAAC;YACtF,IAAI,SAAS,KAAK,SAAS;gBACzB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,kCAAkC,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;YACnH,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,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,uCAAuC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAE/G,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS;YACzB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,kCAAkC,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEpH,OAAO,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,IAAiB;QACrC,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,KAAK;YACtD,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACrB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,KAAK,WAAW,CAAC,CAAC;IAChH,CAAC;CACF;AA1ID,sBA0IC;AACD;;;GAGG;AACH,MAAsB,YAAa,SAAQ,KAAK;CAK/C;AALD,oCAKC","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 { ECSchemaError, ECSchemaStatus } 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\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/**\r\n * A Typescript class representation of a Mixin.\r\n * @public @preview\r\n */\r\nexport class Mixin extends ECClass {\r\n  public override readonly schemaItemType = Mixin.schemaItemType;\r\n  /** @internal */\r\n  public static override get schemaItemType() { return SchemaItemType.Mixin; }\r\n  private _appliesTo?: LazyLoadedEntityClass;\r\n\r\n  public get appliesTo(): LazyLoadedEntityClass | undefined {\r\n    return this._appliesTo;\r\n  }\r\n\r\n  /** @internal */\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name, ECClassModifier.Abstract);\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param name\r\n   * @param relationship\r\n   * @param direction\r\n   * @internal\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  /**\r\n   *\r\n   * @param name\r\n   * @param relationship\r\n   * @param direction\r\n   * @returns\r\n   *\r\n   * @internal\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   * @internal\r\n   */\r\n  protected setAppliesTo(appliesTo: LazyLoadedEntityClass) {\r\n    this._appliesTo = appliesTo;\r\n  }\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 ECSchemaError(ECSchemaStatus.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(entityClassSchemaItemKey, EntityClass);\r\n        if (undefined === appliesTo)\r\n          throw new ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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   * Type guard to check if the SchemaItem is of type Mixin.\r\n   * @param item The SchemaItem to check.\r\n   * @returns True if the item is a Mixin, false otherwise.\r\n   */\r\n  public static isMixin(item?: SchemaItem): item is Mixin {\r\n    if (item && item.schemaItemType === SchemaItemType.Mixin)\r\n      return true;\r\n\r\n    return false;\r\n  }\r\n\r\n  /**\r\n   * Type assertion to check if the SchemaItem is of type Mixin.\r\n   * @param item The SchemaItem to check.\r\n   * @returns The item cast to Mixin if it is a Mixin, undefined otherwise.\r\n   * @internal\r\n   */\r\n  public static assertIsMixin(item?: SchemaItem): asserts item is Mixin {\r\n    if (!this.isMixin(item))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Mixin}' (Mixin)`);\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/cjs/Metadata/OverrideFormat.d.ts

@@ -3,21 +3,20 @@
  */
 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";
+import { LazyLoadedInvertedUnit, LazyLoadedUnit } from "../Interfaces";
 /**
- * @beta
+ * @public @preview
  */
 export interface OverrideFormatProps {
-    name: string;
-    precision?: number;
-    unitAndLabels?: Array<[string, string | undefined]>;
+    readonly name: string;
+    readonly precision?: number;
+    readonly unitAndLabels?: Array<[string, string | undefined]>;
 }
 /**
  * Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity.
- * @beta
+ * @public @preview
  */
 export declare class OverrideFormat {
     private _precision?;
@@ -29,9 +28,10 @@ export declare class 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]>);
+    /** @internal */
+    constructor(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>);
     get precision(): DecimalPrecision | FractionalPrecision;
-    get units(): [Unit | InvertedUnit, string | undefined][] | undefined;
+    get units(): ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined;
     get fullName(): string;
     get roundFactor(): number;
     get type(): FormatType;
@@ -48,7 +48,7 @@ export declare class OverrideFormat {
     get includeZero(): boolean | undefined;
     hasFormatTrait(formatTrait: FormatTraits): boolean;
     /** Returns the format string of this override in the Xml full name format.
-     * @alpha
+     * @internal
      */
     fullNameXml(koqSchema: Schema): string;
     /**
@@ -56,7 +56,7 @@ export declare class OverrideFormat {
      * @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;
+    static createOverrideFormatFullName(parent: Format, precision?: DecimalPrecision | FractionalPrecision, unitAndLabels?: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>): string;
     /** Parses the format string into the parts that make up an Override Format
      * @param formatString
      */
@@ -64,7 +64,7 @@ export declare class OverrideFormat {
     /**
      * @internal
      */
-    static isOverrideFormat(object: any): object is OverrideFormat;
+    static isOverrideFormat(format: unknown): format 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.