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

package/lib/cjs/Metadata/Enumeration.js

@@ -15,15 +15,21 @@ const ECName_1 = require("../ECName");
 const SchemaItem_1 = require("./SchemaItem");
 /**
  * A Typescript class representation of an ECEnumeration.
- * @beta
+ * @public @preview
  */
 class Enumeration extends SchemaItem_1.SchemaItem {
+    schemaItemType = Enumeration.schemaItemType;
+    /** @internal */
+    static get schemaItemType() { return ECObjects_1.SchemaItemType.Enumeration; }
+    _type;
+    _isStrict;
+    _enumerators;
     get enumerators() { return this._enumerators; }
     get type() { return this._type; }
     get isStrict() { return this._isStrict; }
+    /** @internal */
     constructor(schema, name, primitiveType) {
         super(schema, name);
-        this.schemaItemType = ECObjects_1.SchemaItemType.Enumeration;
         this._type = primitiveType;
         this._isStrict = true;
         this._enumerators = [];
@@ -49,9 +55,9 @@ class Enumeration extends SchemaItem_1.SchemaItem {
     findDuplicateEnumerators(name, value) {
         this._enumerators.forEach((element) => {
             if (element.name.toLowerCase() === name.toLowerCase())
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);
             if (element.value === value)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);
         });
     }
     /**
@@ -61,23 +67,25 @@ class Enumeration extends SchemaItem_1.SchemaItem {
      * @param label A localized display label that is used instead of the name in a GUI.
      * @param description A localized description for the enumerator.
      * @return AnyEnumerator object
+     * @internal
      */
     createEnumerator(name, value, label, description) {
         if (this.isInt && typeof (value) === "string") // throws if backing type is int and value is string
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'integer' and an enumerator with value of type 'string'.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'integer' and an enumerator with value of type 'string'.`);
         if (!this.isInt && typeof (value) === "number") // also throws if backing type is string and value is number
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'string' and an enumerator with value of type 'integer'.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'string' and an enumerator with value of type 'integer'.`);
         this.findDuplicateEnumerators(name, value); // check for duplicates; throw if there are any
         if (!ECName_1.ECName.validate(name))
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECName, `The Enumeration ${this.name} has an enumerator with an invalid 'name' attribute. ${name} is not a valid ECName.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECName, `The Enumeration ${this.name} has an enumerator with an invalid 'name' attribute. ${name} is not a valid ECName.`);
         return { name, value, label, description };
     }
     /**
      * Adds enumerator to list of enumerators on this Enumeration
      * @param enumerator The enumerator to add
+     * @internal
      */
     addEnumerator(enumerator) {
-        this.enumerators.push(enumerator);
+        this._enumerators.push(enumerator);
     }
     /**
      * Save this Enumeration's properties to an object for serializing to JSON.
@@ -130,19 +138,19 @@ class Enumeration extends SchemaItem_1.SchemaItem {
                 if (Helper_1.SchemaReadHelper.isECSpecVersionNewer({ readVersion: enumerationProps.originalECSpecMajorVersion, writeVersion: enumerationProps.originalECSpecMinorVersion }))
                     this._type = ECObjects_1.PrimitiveType.String;
                 else
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either "int" or "string".`);
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either "int" or "string".`);
             }
         }
         else {
             const primitiveTypePattern = (this.isInt) ? /int/i : /string/i;
             if (!primitiveTypePattern.test(enumerationProps.type))
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an incompatible type. It must be "${(this.isInt) ? "int" : "string"}", not "${(this.isInt) ? "string" : "int"}".`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has an incompatible type. It must be "${(this.isInt) ? "int" : "string"}", not "${(this.isInt) ? "string" : "int"}".`);
         }
         this._isStrict = enumerationProps.isStrict;
         if (undefined !== enumerationProps.enumerators) {
             enumerationProps.enumerators.forEach((enumerator) => {
                 // Creates a new enumerator (with the specified name, value, label and description- label and description are optional) and adds to the list of enumerators.
-                // Throws ECObjectsError if there are duplicate names or values present in the enumeration
+                // Throws ECSchemaError if there are duplicate names or values present in the enumeration
                 this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));
             });
         }
@@ -151,15 +159,35 @@ class Enumeration extends SchemaItem_1.SchemaItem {
         this.fromJSONSync(enumerationProps);
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setIsStrict(isStrict) {
         this._isStrict = isStrict;
     }
+    /**
+     * Type guard to check if the SchemaItem is of type Enumeration.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is an Enumeration, false otherwise.
+     */
+    static isEnumeration(item) {
+        return item?.schemaItemType === ECObjects_1.SchemaItemType.Enumeration;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type Enumeration.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Enumeration if it is an Enumeration, undefined otherwise.
+     * @internal
+     */
+    static assertIsEnumeration(item) {
+        if (!this.isEnumeration(item))
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Enumeration}' (Enumeration)`);
+    }
 }
 exports.Enumeration = Enumeration;
-/** @internal
+/**
  * An abstract class used for schema editing.
+ *
+ * @internal
  */
 class MutableEnumeration extends Enumeration {
 }

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

@@ -1 +1 @@
-{"version":3,"file":"Enumeration.js","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4E;AAE5E,4CAAoF;AACpF,4CAA+D;AAC/D,sCAAmC;AAEnC,6CAA0C;AAa1C;;;GAGG;AACH,MAAa,WAAY,SAAQ,uBAAU;IAMzC,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACtD,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,YAAY,MAAc,EAAE,IAAY,EAAE,aAA4D;QACpG,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,0BAAc,CAAC,WAAW,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,IAAW,KAAK,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,yBAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,yBAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAY;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACzF,CAAC;IAQM,aAAa,CAAC,KAAsB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,IAAY,EAAE,KAAsB;QACnE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAsB,EAAE,EAAE;YACnD,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;gBACnD,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,IAAI,IAAI,CAAC,CAAC;YAC1I,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK;gBACzB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,2CAA2C,KAAK,IAAI,CAAC,CAAC;QAC9I,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAY,EAAE,KAAsB,EAAE,KAAc,EAAE,WAAoB;QAChG,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,oDAAoD;YACjG,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACtK,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,4DAA4D;YAC1G,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACtK,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,+CAA+C;QAC3F,IAAI,CAAC,eAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,wDAAwD,IAAI,yBAAyB,CAAC,CAAC;QAC7K,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,UAAyB;QAC/C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;YACrF,MAAM,QAAQ,GAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACtC,IAAI,SAAS,KAAK,KAAK;gBACrB,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;YACzB,IAAI,SAAS,KAAK,WAAW;gBAC3B,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;YACrC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YACzB,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,IAAA,iCAAqB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE5D,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAC5D,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACxG,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,UAAU,CAAC,KAAK;gBAChC,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,UAAU,CAAC,WAAW;gBACtC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAClE,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,OAAO,CAAC;YACrC,CAAC;iBAAM,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,IAAI,yBAAgB,CAAC,oBAAoB,CAAC,EAAC,WAAW,EAAE,gBAAgB,CAAC,0BAA0B,EAAE,YAAY,EAAE,gBAAgB,CAAC,0BAA0B,EAAkB,CAAC;oBAC/K,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;;oBAElC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;YACpK,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,oBAAoB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACnD,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QACjN,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE3C,IAAI,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;YAC/C,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;gBACnE,4JAA4J;gBAC5J,0FAA0F;gBAC1F,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;YACzH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAiB;QACrC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;CAEF;AAnKD,kCAmKC;AAED;;GAEG;AACH,MAAsB,kBAAmB,SAAQ,WAAW;CAI3D;AAJD,gDAIC","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 { ECSpecVersion, SchemaReadHelper } from \"../Deserialization/Helper\";\r\nimport { EnumerationProps, EnumeratorProps } from \"../Deserialization/JsonProps\";\r\nimport { PrimitiveType, primitiveTypeToString, SchemaItemType } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { ECName } from \"../ECName\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/** @beta */\r\nexport interface Enumerator<T> {\r\n  readonly name: string;\r\n  readonly value: T;\r\n  readonly label?: string;\r\n  readonly description?: string;\r\n}\r\n\r\n/** @beta */\r\nexport type AnyEnumerator = Enumerator<string | number>;\r\n\r\n/**\r\n * A Typescript class representation of an ECEnumeration.\r\n * @beta\r\n */\r\nexport class Enumeration extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.Enumeration;\r\n  protected _type?: PrimitiveType.Integer | PrimitiveType.String;\r\n  protected _isStrict: boolean;\r\n  protected _enumerators: AnyEnumerator[];\r\n\r\n  public get enumerators() { return this._enumerators; }\r\n  public get type() { return this._type; }\r\n  public get isStrict() { return this._isStrict; }\r\n\r\n  constructor(schema: Schema, name: string, primitiveType?: PrimitiveType.Integer | PrimitiveType.String) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.Enumeration;\r\n    this._type = primitiveType;\r\n    this._isStrict = true;\r\n    this._enumerators = [];\r\n  }\r\n\r\n  public get isInt(): boolean { return this._type === PrimitiveType.Integer; }\r\n  public get isString(): boolean { return this._type === PrimitiveType.String; }\r\n\r\n  /**\r\n   * Gets an enumerator that matches the name provided.\r\n   * @param name The ECName of the Enumerator to find.\r\n   */\r\n  public getEnumeratorByName(name: string): AnyEnumerator | undefined {\r\n    return this.enumerators.find((item) => item.name.toLowerCase() === name.toLowerCase());\r\n  }\r\n\r\n  /**\r\n   * Gets an enumerator that matches the value provided.\r\n   * @param value The value of the Enumerator to find.\r\n   */\r\n  public getEnumerator(value: string): Enumerator<string> | undefined;\r\n  public getEnumerator(value: number): Enumerator<number> | undefined;\r\n  public getEnumerator(value: string | number): AnyEnumerator | undefined {\r\n    return this.enumerators.find((item) => item.value === value);\r\n  }\r\n\r\n  /**\r\n   * Checks whether there already exists an enumerator with this name or this value\r\n   * @param name The name of the enumerator we are trying to create\r\n   * @param value The value of the enumerator we are trying to create\r\n   * @internal\r\n   */\r\n  private findDuplicateEnumerators(name: string, value: string | number) {\r\n    this._enumerators.forEach((element: AnyEnumerator) => { // Name and value must be unique within the ECEnumerations\r\n      if (element.name.toLowerCase() === name.toLowerCase())\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);\r\n      if (element.value === value)\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Creates an Enumerator with the provided name and value as well as optional parameters label and description\r\n   * @param name The name of the enumerator\r\n   * @param value The value of the enumerator. The type of this value is dependent on the backing type of the this Enumeration.\r\n   * @param label A localized display label that is used instead of the name in a GUI.\r\n   * @param description A localized description for the enumerator.\r\n   * @return AnyEnumerator object\r\n   */\r\n  public createEnumerator(name: string, value: string | number, label?: string, description?: string): AnyEnumerator {\r\n    if (this.isInt && typeof (value) === \"string\") // throws if backing type is int and value is string\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'integer' and an enumerator with value of type 'string'.`);\r\n    if (!this.isInt && typeof (value) === \"number\") // also throws if backing type is string and value is number\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'string' and an enumerator with value of type 'integer'.`);\r\n    this.findDuplicateEnumerators(name, value); // check for duplicates; throw if there are any\r\n    if (!ECName.validate(name))\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECName, `The Enumeration ${this.name} has an enumerator with an invalid 'name' attribute. ${name} is not a valid ECName.`);\r\n    return { name, value, label, description };\r\n  }\r\n\r\n  /**\r\n   * Adds enumerator to list of enumerators on this Enumeration\r\n   * @param enumerator The enumerator to add\r\n   */\r\n  protected addEnumerator(enumerator: AnyEnumerator) {\r\n    this.enumerators.push(enumerator);\r\n  }\r\n\r\n  /**\r\n   * Save this Enumeration'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): EnumerationProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.type = (this.isInt) ? \"int\" : \"string\";\r\n    schemaJson.isStrict = this.isStrict;\r\n    schemaJson.enumerators = this._enumerators.map(({ name, label, value, description }) => {\r\n      const enumJson: any = { name, value };\r\n      if (undefined !== label)\r\n        enumJson.label = label;\r\n      if (undefined !== description)\r\n        enumJson.description = description;\r\n      return enumJson;\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    if (undefined !== this.type)\r\n      itemElement.setAttribute(\"backingTypeName\", primitiveTypeToString(this.type));\r\n    itemElement.setAttribute(\"isStrict\", String(this.isStrict));\r\n\r\n    for (const enumerator of this.enumerators) {\r\n      const enumElement = schemaXml.createElement(\"ECEnumerator\");\r\n      enumElement.setAttribute(\"name\", enumerator.name);\r\n      const enumValue = typeof enumerator.value === \"string\" ? enumerator.value : enumerator.value.toString();\r\n      enumElement.setAttribute(\"value\", enumValue);\r\n      if (undefined !== enumerator.label)\r\n        enumElement.setAttribute(\"displayLabel\", enumerator.label);\r\n      if (undefined !== enumerator.description)\r\n        enumElement.setAttribute(\"description\", enumerator.description);\r\n      itemElement.appendChild(enumElement);\r\n    }\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(enumerationProps: EnumerationProps) {\r\n    super.fromJSONSync(enumerationProps);\r\n    if (undefined === this._type) {\r\n      if (/int/i.test(enumerationProps.type)) {\r\n        this._type = PrimitiveType.Integer;\r\n      } else if (/string/i.test(enumerationProps.type)) {\r\n        this._type = PrimitiveType.String;\r\n      } else {\r\n        if (SchemaReadHelper.isECSpecVersionNewer({readVersion: enumerationProps.originalECSpecMajorVersion, writeVersion: enumerationProps.originalECSpecMinorVersion} as ECSpecVersion))\r\n          this._type = PrimitiveType.String;\r\n        else\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either \"int\" or \"string\".`);\r\n      }\r\n    } else {\r\n      const primitiveTypePattern = (this.isInt) ? /int/i : /string/i;\r\n      if (!primitiveTypePattern.test(enumerationProps.type))\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an incompatible type. It must be \"${(this.isInt) ? \"int\" : \"string\"}\", not \"${(this.isInt) ? \"string\" : \"int\"}\".`);\r\n    }\r\n    this._isStrict = enumerationProps.isStrict;\r\n\r\n    if (undefined !== enumerationProps.enumerators) {\r\n      enumerationProps.enumerators.forEach((enumerator: EnumeratorProps) => {\r\n        // Creates a new enumerator (with the specified name, value, label and description- label and description are optional) and adds to the list of enumerators.\r\n        // Throws ECObjectsError if there are duplicate names or values present in the enumeration\r\n        this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));\r\n      });\r\n    }\r\n  }\r\n\r\n  public override async fromJSON(enumerationProps: EnumerationProps) {\r\n    this.fromJSONSync(enumerationProps);\r\n  }\r\n\r\n  /**\r\n   * @alpha Used in schema editing.\r\n   */\r\n  protected setIsStrict(isStrict: boolean) {\r\n    this._isStrict = isStrict;\r\n  }\r\n\r\n}\r\n\r\n/** @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutableEnumeration extends Enumeration {\r\n  public abstract override addEnumerator(enumerator: AnyEnumerator): void;\r\n  public abstract override setIsStrict(isStrict: boolean): void;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}
+{"version":3,"file":"Enumeration.js","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4E;AAE5E,4CAAoF;AACpF,4CAA6D;AAC7D,sCAAmC;AAEnC,6CAA0C;AAa1C;;;GAGG;AACH,MAAa,WAAY,SAAQ,uBAAU;IAChB,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC;IACrE,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1E,KAAK,CAAgD;IACrD,SAAS,CAAU;IACnB,YAAY,CAAkB;IAEtC,IAAW,WAAW,KAAmC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACpF,IAAW,IAAI,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY,EAAE,aAA4D;QACpG,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,IAAW,KAAK,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,yBAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,yBAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAY;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACzF,CAAC;IAQM,aAAa,CAAC,KAAsB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,IAAY,EAAE,KAAsB;QACnE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAsB,EAAE,EAAE;YACnD,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;gBACnD,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,IAAI,IAAI,CAAC,CAAC;YACxI,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK;gBACzB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,2CAA2C,KAAK,IAAI,CAAC,CAAC;QAC5I,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACI,gBAAgB,CAAC,IAAY,EAAE,KAAsB,EAAE,KAAc,EAAE,WAAoB;QAChG,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,oDAAoD;YACjG,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACpK,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,4DAA4D;YAC1G,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,8EAA8E,CAAC,CAAC;QACpK,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,+CAA+C;QAC3F,IAAI,CAAC,eAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,wDAAwD,IAAI,yBAAyB,CAAC,CAAC;QAC3K,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,UAAyB;QAC/C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClD,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;YACrF,MAAM,QAAQ,GAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACtC,IAAI,SAAS,KAAK,KAAK;gBACrB,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;YACzB,IAAI,SAAS,KAAK,WAAW;gBAC3B,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;YACrC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YACzB,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,IAAA,iCAAqB,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE5D,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAC5D,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,SAAS,GAAG,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACxG,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,UAAU,CAAC,KAAK;gBAChC,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,UAAU,CAAC,WAAW;gBACtC,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;YAClE,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACrC,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,OAAO,CAAC;YACrC,CAAC;iBAAM,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjD,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,IAAI,yBAAgB,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,gBAAgB,CAAC,0BAA0B,EAAE,YAAY,EAAE,gBAAgB,CAAC,0BAA0B,EAAmB,CAAC;oBACjL,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;;oBAElC,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;YAClK,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,oBAAoB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/D,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACnD,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;QAC/M,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE3C,IAAI,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC;YAC/C,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAA2B,EAAE,EAAE;gBACnE,4JAA4J;gBAC5J,yFAAyF;gBACzF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;YACzH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,QAAiB;QACrC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,IAAiB;QAC3C,OAAO,IAAI,EAAE,cAAc,KAAK,0BAAc,CAAC,WAAW,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,mBAAmB,CAAC,IAAiB;QACjD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YAC3B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,WAAW,iBAAiB,CAAC,CAAC;IAC5H,CAAC;CACF;AA1LD,kCA0LC;AAED;;;;GAIG;AACH,MAAsB,kBAAmB,SAAQ,WAAW;CAI3D;AAJD,gDAIC","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 { ECSpecVersion, SchemaReadHelper } from \"../Deserialization/Helper\";\r\nimport { EnumerationProps, EnumeratorProps } from \"../Deserialization/JsonProps\";\r\nimport { PrimitiveType, primitiveTypeToString, SchemaItemType } from \"../ECObjects\";\r\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\r\nimport { ECName } from \"../ECName\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/** @public @preview */\r\nexport interface Enumerator<T> {\r\n  readonly name: string;\r\n  readonly value: T;\r\n  readonly label?: string;\r\n  readonly description?: string;\r\n}\r\n\r\n/** @public @preview */\r\nexport type AnyEnumerator = Enumerator<string | number>;\r\n\r\n/**\r\n * A Typescript class representation of an ECEnumeration.\r\n * @public @preview\r\n */\r\nexport class Enumeration extends SchemaItem {\r\n  public override readonly schemaItemType = Enumeration.schemaItemType;\r\n  /** @internal */\r\n  public static override get schemaItemType() { return SchemaItemType.Enumeration; }\r\n  private _type?: PrimitiveType.Integer | PrimitiveType.String;\r\n  private _isStrict: boolean;\r\n  private _enumerators: AnyEnumerator[];\r\n\r\n  public get enumerators(): ReadonlyArray<AnyEnumerator> { return this._enumerators; }\r\n  public get type() { return this._type; }\r\n  public get isStrict() { return this._isStrict; }\r\n\r\n  /** @internal */\r\n  constructor(schema: Schema, name: string, primitiveType?: PrimitiveType.Integer | PrimitiveType.String) {\r\n    super(schema, name);\r\n    this._type = primitiveType;\r\n    this._isStrict = true;\r\n    this._enumerators = [];\r\n  }\r\n\r\n  public get isInt(): boolean { return this._type === PrimitiveType.Integer; }\r\n  public get isString(): boolean { return this._type === PrimitiveType.String; }\r\n\r\n  /**\r\n   * Gets an enumerator that matches the name provided.\r\n   * @param name The ECName of the Enumerator to find.\r\n   */\r\n  public getEnumeratorByName(name: string): AnyEnumerator | undefined {\r\n    return this.enumerators.find((item) => item.name.toLowerCase() === name.toLowerCase());\r\n  }\r\n\r\n  /**\r\n   * Gets an enumerator that matches the value provided.\r\n   * @param value The value of the Enumerator to find.\r\n   */\r\n  public getEnumerator(value: string): Enumerator<string> | undefined;\r\n  public getEnumerator(value: number): Enumerator<number> | undefined;\r\n  public getEnumerator(value: string | number): AnyEnumerator | undefined {\r\n    return this.enumerators.find((item) => item.value === value);\r\n  }\r\n\r\n  /**\r\n   * Checks whether there already exists an enumerator with this name or this value\r\n   * @param name The name of the enumerator we are trying to create\r\n   * @param value The value of the enumerator we are trying to create\r\n   * @internal\r\n   */\r\n  private findDuplicateEnumerators(name: string, value: string | number) {\r\n    this._enumerators.forEach((element: AnyEnumerator) => { // Name and value must be unique within the ECEnumerations\r\n      if (element.name.toLowerCase() === name.toLowerCase())\r\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);\r\n      if (element.value === value)\r\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Creates an Enumerator with the provided name and value as well as optional parameters label and description\r\n   * @param name The name of the enumerator\r\n   * @param value The value of the enumerator. The type of this value is dependent on the backing type of the this Enumeration.\r\n   * @param label A localized display label that is used instead of the name in a GUI.\r\n   * @param description A localized description for the enumerator.\r\n   * @return AnyEnumerator object\r\n   * @internal\r\n   */\r\n  public createEnumerator(name: string, value: string | number, label?: string, description?: string): AnyEnumerator {\r\n    if (this.isInt && typeof (value) === \"string\") // throws if backing type is int and value is string\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'integer' and an enumerator with value of type 'string'.`);\r\n    if (!this.isInt && typeof (value) === \"number\") // also throws if backing type is string and value is number\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has a backing type 'string' and an enumerator with value of type 'integer'.`);\r\n    this.findDuplicateEnumerators(name, value); // check for duplicates; throw if there are any\r\n    if (!ECName.validate(name))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidECName, `The Enumeration ${this.name} has an enumerator with an invalid 'name' attribute. ${name} is not a valid ECName.`);\r\n    return { name, value, label, description };\r\n  }\r\n\r\n  /**\r\n   * Adds enumerator to list of enumerators on this Enumeration\r\n   * @param enumerator The enumerator to add\r\n   * @internal\r\n   */\r\n  protected addEnumerator(enumerator: AnyEnumerator) {\r\n    this._enumerators.push(enumerator);\r\n  }\r\n\r\n  /**\r\n   * Save this Enumeration'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): EnumerationProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.type = (this.isInt) ? \"int\" : \"string\";\r\n    schemaJson.isStrict = this.isStrict;\r\n    schemaJson.enumerators = this._enumerators.map(({ name, label, value, description }) => {\r\n      const enumJson: any = { name, value };\r\n      if (undefined !== label)\r\n        enumJson.label = label;\r\n      if (undefined !== description)\r\n        enumJson.description = description;\r\n      return enumJson;\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    if (undefined !== this.type)\r\n      itemElement.setAttribute(\"backingTypeName\", primitiveTypeToString(this.type));\r\n    itemElement.setAttribute(\"isStrict\", String(this.isStrict));\r\n\r\n    for (const enumerator of this.enumerators) {\r\n      const enumElement = schemaXml.createElement(\"ECEnumerator\");\r\n      enumElement.setAttribute(\"name\", enumerator.name);\r\n      const enumValue = typeof enumerator.value === \"string\" ? enumerator.value : enumerator.value.toString();\r\n      enumElement.setAttribute(\"value\", enumValue);\r\n      if (undefined !== enumerator.label)\r\n        enumElement.setAttribute(\"displayLabel\", enumerator.label);\r\n      if (undefined !== enumerator.description)\r\n        enumElement.setAttribute(\"description\", enumerator.description);\r\n      itemElement.appendChild(enumElement);\r\n    }\r\n\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(enumerationProps: EnumerationProps) {\r\n    super.fromJSONSync(enumerationProps);\r\n    if (undefined === this._type) {\r\n      if (/int/i.test(enumerationProps.type)) {\r\n        this._type = PrimitiveType.Integer;\r\n      } else if (/string/i.test(enumerationProps.type)) {\r\n        this._type = PrimitiveType.String;\r\n      } else {\r\n        if (SchemaReadHelper.isECSpecVersionNewer({ readVersion: enumerationProps.originalECSpecMajorVersion, writeVersion: enumerationProps.originalECSpecMinorVersion } as ECSpecVersion))\r\n          this._type = PrimitiveType.String;\r\n        else\r\n          throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either \"int\" or \"string\".`);\r\n      }\r\n    } else {\r\n      const primitiveTypePattern = (this.isInt) ? /int/i : /string/i;\r\n      if (!primitiveTypePattern.test(enumerationProps.type))\r\n        throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Enumeration ${this.name} has an incompatible type. It must be \"${(this.isInt) ? \"int\" : \"string\"}\", not \"${(this.isInt) ? \"string\" : \"int\"}\".`);\r\n    }\r\n    this._isStrict = enumerationProps.isStrict;\r\n\r\n    if (undefined !== enumerationProps.enumerators) {\r\n      enumerationProps.enumerators.forEach((enumerator: EnumeratorProps) => {\r\n        // Creates a new enumerator (with the specified name, value, label and description- label and description are optional) and adds to the list of enumerators.\r\n        // Throws ECSchemaError if there are duplicate names or values present in the enumeration\r\n        this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));\r\n      });\r\n    }\r\n  }\r\n\r\n  public override async fromJSON(enumerationProps: EnumerationProps) {\r\n    this.fromJSONSync(enumerationProps);\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  protected setIsStrict(isStrict: boolean) {\r\n    this._isStrict = isStrict;\r\n  }\r\n\r\n  /**\r\n   * Type guard to check if the SchemaItem is of type Enumeration.\r\n   * @param item The SchemaItem to check.\r\n   * @returns True if the item is an Enumeration, false otherwise.\r\n   */\r\n  public static isEnumeration(item?: SchemaItem): item is Enumeration {\r\n    return item?.schemaItemType === SchemaItemType.Enumeration;\r\n  }\r\n\r\n  /**\r\n   * Type assertion to check if the SchemaItem is of type Enumeration.\r\n   * @param item The SchemaItem to check.\r\n   * @returns The item cast to Enumeration if it is an Enumeration, undefined otherwise.\r\n   * @internal\r\n   */\r\n  public static assertIsEnumeration(item?: SchemaItem): asserts item is Enumeration {\r\n    if (!this.isEnumeration(item))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.Enumeration}' (Enumeration)`);\r\n  }\r\n}\r\n\r\n/**\r\n * An abstract class used for schema editing.\r\n *\r\n * @internal\r\n */\r\nexport abstract class MutableEnumeration extends Enumeration {\r\n  public abstract override addEnumerator(enumerator: AnyEnumerator): void;\r\n  public abstract override setIsStrict(isStrict: boolean): void;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

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

@@ -3,18 +3,20 @@
  */
 import { SchemaItemFormatProps } from "../Deserialization/JsonProps";
 import { SchemaItemType } from "../ECObjects";
-import { BaseFormat, DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
-import { InvertedUnit } from "./InvertedUnit";
+import { DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
 import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
-import { Unit } from "./Unit";
+import { LazyLoadedInvertedUnit, LazyLoadedUnit } from "../Interfaces";
 /**
- * @beta
+ * @public @preview
  */
 export declare class Format extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.Format;
-    protected _base: BaseFormat;
-    protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;
+    readonly schemaItemType: SchemaItemType;
+    /** @internal */
+    static get schemaItemType(): SchemaItemType;
+    private _base;
+    private _units?;
+    /** @internal */
     constructor(schema: Schema, name: string);
     get roundFactor(): number;
     get type(): FormatType;
@@ -30,15 +32,21 @@ export declare class Format extends SchemaItem {
     get formatTraits(): FormatTraits;
     get spacer(): string | undefined;
     get includeZero(): boolean | undefined;
-    get units(): Array<[Unit | InvertedUnit, string | undefined]> | undefined;
+    get units(): ReadonlyArray<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]> | undefined;
     private parseFormatTraits;
     hasFormatTrait(formatTrait: FormatTraits): boolean;
     /**
      * Adds a Unit, or InvertedUnit, with an optional label override.
      * @param unit The Unit, or InvertedUnit, to add to this Format.
      * @param label A label that overrides the label defined within the Unit when a value is formatted.
+     * @internal
+     */
+    protected addUnit(unit: LazyLoadedUnit | LazyLoadedInvertedUnit, label?: string): void;
+    /**
+     *
+     * @param precision
+     * @internal
      */
-    protected addUnit(unit: Unit | InvertedUnit, label?: string): void;
     protected setPrecision(precision: number): void;
     private typecheck;
     fromJSONSync(formatProps: SchemaItemFormatProps): void;
@@ -52,40 +60,80 @@ export declare class Format extends SchemaItem {
     /** @internal */
     toXml(schemaXml: Document): Promise<Element>;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setFormatType(formatType: FormatType): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setRoundFactor(roundFactor: number): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setShowSignOption(signOption: ShowSignOption): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setDecimalSeparator(separator: string): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setThousandSeparator(separator: string): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setUomSeparator(separator: string): void;
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     protected setStationSeparator(separator: string): void;
+    /**
+     * @internal
+     */
+    protected setStationOffsetSize(stationOffsetSize: number): void;
+    /**
+     * @internal
+     */
+    protected setScientificType(scientificType: ScientificType): void;
+    /**
+     * @internal
+     */
+    protected setMinWidth(minWidth: number): void;
+    /**
+     * @internal
+     */
+    protected setSpacer(spacer: string): void;
+    /**
+     * @internal
+     */
+    protected setIncludeZero(includeZero: boolean): void;
+    /**
+     * @internal
+     */
+    protected setFormatTraits(formatTraits: FormatTraits): void;
+    /**
+     * @internal
+     */
+    protected setUnits(units: Array<[LazyLoadedUnit | LazyLoadedInvertedUnit, string | undefined]>): void;
+    /** Type guard to check if the SchemaItem is of type Format.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a Format, false otherwise.
+     */
+    static isFormat(item?: SchemaItem): item is Format;
+    /**
+     * Type assertion to check if the SchemaItem is of type Format.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Format if it is a Format, undefined otherwise.
+     * @internal
+     */
+    static assertIsFormat(item?: SchemaItem): asserts item is Format;
 }
 /**
  * @internal
  * An abstract class used for schema editing.
  */
 export declare abstract class MutableFormat extends Format {
-    abstract addUnit(unit: Unit | InvertedUnit, label?: string): void;
+    abstract addUnit(unit: LazyLoadedUnit | LazyLoadedInvertedUnit, label?: string): void;
     abstract setPrecision(precision: number): void;
     abstract setFormatType(formatType: FormatType): void;
     abstract setRoundFactor(roundFactor: number): void;

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

@@ -1 +1 @@
-{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EACL,UAAU,EAAE,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAE,mBAAmB,EAChG,cAAc,EAAE,cAAc,EAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,qBAAa,MAAO,SAAQ,UAAU;IACpC,SAAyB,cAAc,EAAG,cAAc,CAAC,MAAM,CAAC;IAChE,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC;IAC5B,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;gBAExD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAOxC,IAAW,WAAW,IAAI,MAAM,CAAmC;IACnE,IAAW,IAAI,IAAI,UAAU,CAA4B;IACzD,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAiC;IAC/F,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAgC;IACzE,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAsC;IAC7F,IAAW,cAAc,IAAI,cAAc,CAAsC;IACjF,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,CAAyC;IAC/E,IAAW,YAAY,IAAI,MAAM,CAAoC;IACrE,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAyC;IAC3F,IAAW,YAAY,IAAI,YAAY,CAAoC;IAC3E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA8B;IACrE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAmC;IAChF,IAAW,KAAK,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAwB;IAExG,OAAO,CAAC,iBAAiB;IAIlB,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;;;OAIG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM;IAa3D,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IAExC,OAAO,CAAC,SAAS;IAmBD,YAAY,CAAC,WAAW,EAAE,qBAAqB;IAezC,QAAQ,CAAC,WAAW,EAAE,qBAAqB;IAejE;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,qBAAqB;IAyDjH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA4ClE;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU;IAI9C;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc;IAItD;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAIhD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM;IAI3C;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;CAGhD;AAED;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,MAAM;aACvB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;aACxD,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACrC,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;aAC3C,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,iBAAiB,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;aACnD,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC7C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACxC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Format.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EACO,gBAAgB,EAAE,YAAY,EAAuB,UAAU,EAAE,mBAAmB,EAChG,cAAc,EAAE,cAAc,EAC/B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGvE;;GAEG;AACH,qBAAa,MAAO,SAAQ,UAAU;IACpC,SAAyB,cAAc,iBAAyB;IAChE,gBAAgB;IAChB,WAA2B,cAAc,mBAAoC;IAC7E,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,MAAM,CAAC,CAAuE;IAEtF,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC,IAAW,WAAW,IAAI,MAAM,CAAmC;IACnE,IAAW,IAAI,IAAI,UAAU,CAA4B;IACzD,IAAW,SAAS,IAAI,gBAAgB,GAAG,mBAAmB,CAAiC;IAC/F,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAgC;IACzE,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAsC;IAC7F,IAAW,cAAc,IAAI,cAAc,CAAsC;IACjF,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,CAAyC;IAC/E,IAAW,YAAY,IAAI,MAAM,CAAoC;IACrE,IAAW,gBAAgB,IAAI,MAAM,CAAwC;IAC7E,IAAW,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAAyC;IAC3F,IAAW,YAAY,IAAI,YAAY,CAAoC;IAC3E,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAA8B;IACrE,IAAW,WAAW,IAAI,OAAO,GAAG,SAAS,CAAmC;IAChF,IAAW,KAAK,IAAI,aAAa,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAE3G;IAED,OAAO,CAAC,iBAAiB;IAIlB,cAAc,CAAC,WAAW,EAAE,YAAY;IAI/C;;;;;OAKG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,sBAAsB,EAAE,KAAK,CAAC,EAAE,MAAM;IAa/E;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IAExC,OAAO,CAAC,SAAS;IAmBD,YAAY,CAAC,WAAW,EAAE,qBAAqB;IAmBzC,QAAQ,CAAC,WAAW,EAAE,qBAAqB;IAmBjE;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,qBAAqB;IAyDjH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IA6ClE;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU;IAI9C;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,cAAc;IAItD;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAIhD;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM;IAI3C;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,MAAM;IAI/C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,MAAM;IAIxD;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,cAAc,EAAE,cAAc;IAI1D;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM;IAItC;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM;IAIlC;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,OAAO;IAI7C;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,YAAY,EAAE,YAAY;IAIpD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,cAAc,GAAG,sBAAsB,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAI9F;;;OAGG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,MAAM;IAOzD;;;;;OAKG;WACW,cAAc,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,MAAM;CAIxE;AAED;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,MAAM;aACvB,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,sBAAsB,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;aAC5E,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACrC,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;aAC3C,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;aACzC,iBAAiB,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI;aACnD,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC7C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aACxC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;aAC5C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/cjs/Metadata/Format.js

@@ -12,14 +12,22 @@ const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtil
 const ECObjects_1 = require("../ECObjects");
 const Exception_1 = require("../Exception");
 const core_quantity_1 = require("@itwin/core-quantity");
+const InvertedUnit_1 = require("./InvertedUnit");
 const SchemaItem_1 = require("./SchemaItem");
+const Unit_1 = require("./Unit");
+const DelayedPromise_1 = require("../DelayedPromise");
 /**
- * @beta
+ * @public @preview
  */
 class Format extends SchemaItem_1.SchemaItem {
+    schemaItemType = Format.schemaItemType;
+    /** @internal */
+    static get schemaItemType() { return ECObjects_1.SchemaItemType.Format; }
+    _base;
+    _units;
+    /** @internal */
     constructor(schema, name) {
         super(schema, name);
-        this.schemaItemType = ECObjects_1.SchemaItemType.Format;
         this._base = new core_quantity_1.BaseFormat(name);
     }
     get roundFactor() { return this._base.roundFactor; }
@@ -36,7 +44,9 @@ class Format extends SchemaItem_1.SchemaItem {
     get formatTraits() { return this._base.formatTraits; }
     get spacer() { return this._base.spacer; }
     get includeZero() { return this._base.includeZero; }
-    get units() { return this._units; }
+    get units() {
+        return this._units;
+    }
     parseFormatTraits(formatTraitsFromJson) {
         return this._base.parseFormatTraits(formatTraitsFromJson);
     }
@@ -47,6 +57,7 @@ class Format extends SchemaItem_1.SchemaItem {
      * Adds a Unit, or InvertedUnit, with an optional label override.
      * @param unit The Unit, or InvertedUnit, to add to this Format.
      * @param label A label that overrides the label defined within the Unit when a value is formatted.
+     * @internal
      */
     addUnit(unit, label) {
         if (undefined === this._units)
@@ -54,11 +65,16 @@ class Format extends SchemaItem_1.SchemaItem {
         else { // Validate that a duplicate is not added.
             for (const existingUnit of this._units) {
                 if (unit.fullName.toLowerCase() === existingUnit[0].fullName.toLowerCase())
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has duplicate units, '${unit.fullName}'.`); // TODO: Validation - this should be a validation error not a hard failure.
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has duplicate units, '${unit.fullName}'.`); // TODO: Validation - this should be a validation error not a hard failure.
             }
         }
         this._units.push([unit, label]);
     }
+    /**
+     *
+     * @param precision
+     * @internal
+     */
     setPrecision(precision) { this._base.precision = precision; }
     typecheck(formatProps) {
         this._base.loadFormatProperties(formatProps);
@@ -67,12 +83,12 @@ class Format extends SchemaItem_1.SchemaItem {
                 this._base.includeZero = formatProps.composite.includeZero;
             if (undefined !== formatProps.composite.spacer) {
                 if (formatProps.composite.spacer.length > 1)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has a composite with an invalid 'spacer' attribute. It should be an empty or one character string.`);
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has a composite with an invalid 'spacer' attribute. It should be an empty or one character string.`);
                 this._base.spacer = formatProps.composite.spacer;
             }
             // Composite requires 1-4 units
             if (formatProps.composite.units.length <= 0 || formatProps.composite.units.length > 4)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `The Format ${this.fullName} has an invalid 'Composite' attribute. It should have 1-4 units.`);
         }
     }
     fromJSONSync(formatProps) {
@@ -83,9 +99,12 @@ class Format extends SchemaItem_1.SchemaItem {
         // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation
         for (const unit of formatProps.composite.units) {
             const newUnit = this.schema.lookupItemSync(unit.name);
-            if (undefined === newUnit)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
-            this.addUnit(newUnit, unit.label);
+            if (undefined === newUnit || (!Unit_1.Unit.isUnit(newUnit) && !InvertedUnit_1.InvertedUnit.isInvertedUnit(newUnit)))
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
+            if (Unit_1.Unit.isUnit(newUnit))
+                this.addUnit(new DelayedPromise_1.DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);
+            else if (InvertedUnit_1.InvertedUnit.isInvertedUnit(newUnit))
+                this.addUnit(new DelayedPromise_1.DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);
         }
     }
     async fromJSON(formatProps) {
@@ -96,9 +115,12 @@ class Format extends SchemaItem_1.SchemaItem {
         // Units are separated from the rest of the deserialization because of the need to have separate sync and async implementation
         for (const unit of formatProps.composite.units) {
             const newUnit = await this.schema.lookupItem(unit.name);
-            if (undefined === newUnit)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
-            this.addUnit(newUnit, unit.label);
+            if (undefined === newUnit || (!Unit_1.Unit.isUnit(newUnit) && !InvertedUnit_1.InvertedUnit.isInvertedUnit(newUnit)))
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
+            if (Unit_1.Unit.isUnit(newUnit))
+                this.addUnit(new DelayedPromise_1.DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);
+            else if (InvertedUnit_1.InvertedUnit.isInvertedUnit(newUnit))
+                this.addUnit(new DelayedPromise_1.DelayedPromiseWithProps(newUnit.key, async () => newUnit), unit.label);
         }
     }
     /**
@@ -177,60 +199,123 @@ class Format extends SchemaItem_1.SchemaItem {
                 compositeElement.setAttribute("spacer", this.spacer);
             if (undefined !== this.includeZero)
                 compositeElement.setAttribute("includeZero", this.includeZero.toString());
-            this.units.forEach(([unit, label]) => {
+            for (const [unit, label] of this.units) {
+                const resolvedUnit = await unit;
                 const unitElement = schemaXml.createElement("Unit");
                 if (undefined !== label)
                     unitElement.setAttribute("label", label);
-                const unitName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, unit.schema, unit.name);
+                const unitName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, resolvedUnit.schema, resolvedUnit.name);
                 unitElement.textContent = unitName;
                 compositeElement.appendChild(unitElement);
-            });
+            }
+            ;
             itemElement.appendChild(compositeElement);
         }
         return itemElement;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setFormatType(formatType) {
         this._base.type = formatType;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setRoundFactor(roundFactor) {
         this._base.roundFactor = roundFactor;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setShowSignOption(signOption) {
         this._base.showSignOption = signOption;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setDecimalSeparator(separator) {
         this._base.decimalSeparator = separator;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setThousandSeparator(separator) {
         this._base.thousandSeparator = separator;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setUomSeparator(separator) {
         this._base.uomSeparator = separator;
     }
     /**
-     * @alpha Used in schema editing.
+     * @internal
      */
     setStationSeparator(separator) {
         this._base.stationSeparator = separator;
     }
+    /**
+     * @internal
+     */
+    setStationOffsetSize(stationOffsetSize) {
+        this._base.stationOffsetSize = stationOffsetSize;
+    }
+    /**
+     * @internal
+     */
+    setScientificType(scientificType) {
+        this._base.scientificType = scientificType;
+    }
+    /**
+     * @internal
+     */
+    setMinWidth(minWidth) {
+        this._base.minWidth = minWidth;
+    }
+    /**
+     * @internal
+     */
+    setSpacer(spacer) {
+        this._base.spacer = spacer;
+    }
+    /**
+     * @internal
+     */
+    setIncludeZero(includeZero) {
+        this._base.includeZero = includeZero;
+    }
+    /**
+     * @internal
+     */
+    setFormatTraits(formatTraits) {
+        this._base.formatTraits = formatTraits;
+    }
+    /**
+     * @internal
+     */
+    setUnits(units) {
+        this._units = units;
+    }
+    /** Type guard to check if the SchemaItem is of type Format.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a Format, false otherwise.
+     */
+    static isFormat(item) {
+        if (item && item.schemaItemType === ECObjects_1.SchemaItemType.Format)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type Format.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to Format if it is a Format, undefined otherwise.
+     * @internal
+     */
+    static assertIsFormat(item) {
+        if (!this.isFormat(item))
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.Format}' (Format)`);
+    }
 }
 exports.Format = Format;
 /**