@itwin/ecschema-metadata 4.0.0-dev.7 → 4.0.0-dev.70

package/lib/cjs/Metadata/Enumeration.js

@@ -1,160 +1,160 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MutableEnumeration = exports.Enumeration = void 0;
-const ECObjects_1 = require("../ECObjects");
-const Exception_1 = require("../Exception");
-const ECName_1 = require("../ECName");
-const SchemaItem_1 = require("./SchemaItem");
-/**
- * A Typescript class representation of an ECEnumeration.
- * @beta
- */
-class Enumeration extends SchemaItem_1.SchemaItem {
-    constructor(schema, name, primitiveType) {
-        super(schema, name);
-        this.schemaItemType = ECObjects_1.SchemaItemType.Enumeration;
-        this._type = primitiveType;
-        this._isStrict = true;
-        this._enumerators = [];
-    }
-    get enumerators() { return this._enumerators; }
-    get type() { return this._type; }
-    get isStrict() { return this._isStrict; }
-    get isInt() { return this._type === ECObjects_1.PrimitiveType.Integer; }
-    get isString() { return this._type === ECObjects_1.PrimitiveType.String; }
-    /**
-     * Gets an enumerator that matches the name provided.
-     * @param name The ECName of the Enumerator to find.
-     */
-    getEnumeratorByName(name) {
-        return this.enumerators.find((item) => item.name.toLowerCase() === name.toLowerCase());
-    }
-    getEnumerator(value) {
-        return this.enumerators.find((item) => item.value === value);
-    }
-    /**
-     * Checks whether there already exists an enumerator with this name or this value
-     * @param name The name of the enumerator we are trying to create
-     * @param value The value of the enumerator we are trying to create
-     * @internal
-     */
-    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}'.`);
-            if (element.value === value)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);
-        });
-    }
-    /**
-     * Creates an Enumerator with the provided name and value as well as optional parameters label and description
-     * @param name The name of the enumerator
-     * @param value The value of the enumerator. The type of this value is dependent on the backing type of the this Enumeration.
-     * @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
-     */
-    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'.`);
-        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'.`);
-        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.`);
-        return { name, value, label, description };
-    }
-    /**
-     * Adds enumerator to list of enumerators on this Enumeration
-     * @param enumerator The enumerator to add
-     */
-    addEnumerator(enumerator) {
-        this.enumerators.push(enumerator);
-    }
-    /**
-     * Save this Enumeration's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone = false, includeSchemaVersion = false) {
-        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
-        schemaJson.type = (this.isInt) ? "int" : "string";
-        schemaJson.isStrict = this.isStrict;
-        schemaJson.enumerators = this._enumerators.map(({ name, label, value, description }) => {
-            const enumJson = { name, value };
-            if (undefined !== label)
-                enumJson.label = label;
-            if (undefined !== description)
-                enumJson.description = description;
-            return enumJson;
-        });
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        if (undefined !== this.type)
-            itemElement.setAttribute("backingTypeName", (0, ECObjects_1.primitiveTypeToString)(this.type));
-        itemElement.setAttribute("isStrict", String(this.isStrict));
-        for (const enumerator of this.enumerators) {
-            const enumElement = schemaXml.createElement("ECEnumerator");
-            enumElement.setAttribute("name", enumerator.name);
-            const enumValue = typeof enumerator.value === "string" ? enumerator.value : enumerator.value.toString();
-            enumElement.setAttribute("value", enumValue);
-            if (undefined !== enumerator.label)
-                enumElement.setAttribute("displayLabel", enumerator.label);
-            if (undefined !== enumerator.description)
-                enumElement.setAttribute("description", enumerator.description);
-            itemElement.appendChild(enumElement);
-        }
-        return itemElement;
-    }
-    fromJSONSync(enumerationProps) {
-        super.fromJSONSync(enumerationProps);
-        if (undefined === this._type) {
-            if (/int/i.test(enumerationProps.type))
-                this._type = ECObjects_1.PrimitiveType.Integer;
-            else if (/string/i.test(enumerationProps.type))
-                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".`);
-        }
-        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"}".`);
-        }
-        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
-                this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));
-            });
-        }
-    }
-    async fromJSON(enumerationProps) {
-        this.fromJSONSync(enumerationProps);
-    }
-    /**
-     * @alpha Used in schema editing.
-     */
-    setIsStrict(isStrict) {
-        this._isStrict = isStrict;
-    }
-}
-exports.Enumeration = Enumeration;
-/** @internal
- * An abstract class used for schema editing.
- */
-class MutableEnumeration extends Enumeration {
-}
-exports.MutableEnumeration = MutableEnumeration;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MutableEnumeration = exports.Enumeration = void 0;
+const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
+const ECName_1 = require("../ECName");
+const SchemaItem_1 = require("./SchemaItem");
+/**
+ * A Typescript class representation of an ECEnumeration.
+ * @beta
+ */
+class Enumeration extends SchemaItem_1.SchemaItem {
+    get enumerators() { return this._enumerators; }
+    get type() { return this._type; }
+    get isStrict() { return this._isStrict; }
+    constructor(schema, name, primitiveType) {
+        super(schema, name);
+        this.schemaItemType = ECObjects_1.SchemaItemType.Enumeration;
+        this._type = primitiveType;
+        this._isStrict = true;
+        this._enumerators = [];
+    }
+    get isInt() { return this._type === ECObjects_1.PrimitiveType.Integer; }
+    get isString() { return this._type === ECObjects_1.PrimitiveType.String; }
+    /**
+     * Gets an enumerator that matches the name provided.
+     * @param name The ECName of the Enumerator to find.
+     */
+    getEnumeratorByName(name) {
+        return this.enumerators.find((item) => item.name.toLowerCase() === name.toLowerCase());
+    }
+    getEnumerator(value) {
+        return this.enumerators.find((item) => item.value === value);
+    }
+    /**
+     * Checks whether there already exists an enumerator with this name or this value
+     * @param name The name of the enumerator we are trying to create
+     * @param value The value of the enumerator we are trying to create
+     * @internal
+     */
+    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}'.`);
+            if (element.value === value)
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with value '${value}'.`);
+        });
+    }
+    /**
+     * Creates an Enumerator with the provided name and value as well as optional parameters label and description
+     * @param name The name of the enumerator
+     * @param value The value of the enumerator. The type of this value is dependent on the backing type of the this Enumeration.
+     * @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
+     */
+    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'.`);
+        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'.`);
+        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.`);
+        return { name, value, label, description };
+    }
+    /**
+     * Adds enumerator to list of enumerators on this Enumeration
+     * @param enumerator The enumerator to add
+     */
+    addEnumerator(enumerator) {
+        this.enumerators.push(enumerator);
+    }
+    /**
+     * Save this Enumeration's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        schemaJson.type = (this.isInt) ? "int" : "string";
+        schemaJson.isStrict = this.isStrict;
+        schemaJson.enumerators = this._enumerators.map(({ name, label, value, description }) => {
+            const enumJson = { name, value };
+            if (undefined !== label)
+                enumJson.label = label;
+            if (undefined !== description)
+                enumJson.description = description;
+            return enumJson;
+        });
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        if (undefined !== this.type)
+            itemElement.setAttribute("backingTypeName", (0, ECObjects_1.primitiveTypeToString)(this.type));
+        itemElement.setAttribute("isStrict", String(this.isStrict));
+        for (const enumerator of this.enumerators) {
+            const enumElement = schemaXml.createElement("ECEnumerator");
+            enumElement.setAttribute("name", enumerator.name);
+            const enumValue = typeof enumerator.value === "string" ? enumerator.value : enumerator.value.toString();
+            enumElement.setAttribute("value", enumValue);
+            if (undefined !== enumerator.label)
+                enumElement.setAttribute("displayLabel", enumerator.label);
+            if (undefined !== enumerator.description)
+                enumElement.setAttribute("description", enumerator.description);
+            itemElement.appendChild(enumElement);
+        }
+        return itemElement;
+    }
+    fromJSONSync(enumerationProps) {
+        super.fromJSONSync(enumerationProps);
+        if (undefined === this._type) {
+            if (/int/i.test(enumerationProps.type))
+                this._type = ECObjects_1.PrimitiveType.Integer;
+            else if (/string/i.test(enumerationProps.type))
+                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".`);
+        }
+        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"}".`);
+        }
+        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
+                this.addEnumerator(this.createEnumerator(enumerator.name, enumerator.value, enumerator.label, enumerator.description));
+            });
+        }
+    }
+    async fromJSON(enumerationProps) {
+        this.fromJSONSync(enumerationProps);
+    }
+    /**
+     * @alpha Used in schema editing.
+     */
+    setIsStrict(isStrict) {
+        this._isStrict = isStrict;
+    }
+}
+exports.Enumeration = Enumeration;
+/** @internal
+ * An abstract class used for schema editing.
+ */
+class MutableEnumeration extends Enumeration {
+}
+exports.MutableEnumeration = MutableEnumeration;
 //# sourceMappingURL=Enumeration.js.map

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;;;AAGH,4CAAoF;AACpF,4CAA+D;AAC/D,sCAAmC;AAEnC,6CAA0C;AAa1C;;;GAGG;AACH,MAAa,WAAY,SAAQ,uBAAU;IAUzC,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;IAVD,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;IAUhD,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;YACzC,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;SACtC;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;YAC5B,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACpC,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,OAAO,CAAC;iBAChC,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAC5C,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;;gBAElC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;SACnK;aAAM;YACL,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;SAChN;QACD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE3C,IAAI,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE;YAC9C,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;SACJ;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;AA/JD,kCA+JC;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 { 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; // eslint-disable-line\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        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either \"int\" or \"string\".`);\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;;;AAGH,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;YACzC,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;SACtC;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;YAC5B,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBACpC,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,OAAO,CAAC;iBAChC,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAC5C,IAAI,CAAC,KAAK,GAAG,yBAAa,CAAC,MAAM,CAAC;;gBAElC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;SACnK;aAAM;YACL,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;SAChN;QACD,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,CAAC;QAE3C,IAAI,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE;YAC9C,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;SACJ;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;AA/JD,kCA+JC;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 { 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; // eslint-disable-line\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        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has an invalid 'type' attribute. It should be either \"int\" or \"string\".`);\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"]}

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

@@ -1,99 +1,99 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { FormatProps } from "../Deserialization/JsonProps";
-import { SchemaItemType } from "../ECObjects";
-import { BaseFormat, DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
-import { InvertedUnit } from "./InvertedUnit";
-import { Schema } from "./Schema";
-import { SchemaItem } from "./SchemaItem";
-import { Unit } from "./Unit";
-/**
- * @beta
- */
-export declare class Format extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.Format;
-    protected _base: BaseFormat;
-    protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;
-    constructor(schema: Schema, name: string);
-    get roundFactor(): number;
-    get type(): FormatType;
-    get precision(): DecimalPrecision | FractionalPrecision;
-    get minWidth(): number | undefined;
-    get scientificType(): ScientificType | undefined;
-    get showSignOption(): ShowSignOption;
-    get decimalSeparator(): string;
-    get thousandSeparator(): string;
-    get uomSeparator(): string;
-    get stationSeparator(): string;
-    get stationOffsetSize(): number | undefined;
-    get formatTraits(): FormatTraits;
-    get spacer(): string | undefined;
-    get includeZero(): boolean | undefined;
-    get units(): Array<[Unit | InvertedUnit, 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.
-     */
-    protected addUnit(unit: Unit | InvertedUnit, label?: string): void;
-    protected setPrecision(precision: number): void;
-    private typecheck;
-    fromJSONSync(formatProps: FormatProps): void;
-    fromJSON(formatProps: FormatProps): Promise<void>;
-    /**
-     * Save this Format's properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): FormatProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setFormatType(formatType: FormatType): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setRoundFactor(roundFactor: number): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setShowSignOption(signOption: ShowSignOption): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setDecimalSeparator(separator: string): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setThousandSeparator(separator: string): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setUomSeparator(separator: string): void;
-    /**
-     * @alpha Used in schema editing.
-     */
-    protected setStationSeparator(separator: string): void;
-}
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-export declare abstract class MutableFormat extends Format {
-    abstract addUnit(unit: Unit | InvertedUnit, label?: string): void;
-    abstract setPrecision(precision: number): void;
-    abstract setFormatType(formatType: FormatType): void;
-    abstract setRoundFactor(roundFactor: number): void;
-    abstract setShowSignOption(signOption: ShowSignOption): void;
-    abstract setDecimalSeparator(separator: string): void;
-    abstract setThousandSeparator(separator: string): void;
-    abstract setUomSeparator(separator: string): void;
-    abstract setStationSeparator(separator: string): void;
-    abstract setDisplayLabel(displayLabel: string): void;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { FormatProps } from "../Deserialization/JsonProps";
+import { SchemaItemType } from "../ECObjects";
+import { BaseFormat, DecimalPrecision, FormatTraits, FormatType, FractionalPrecision, ScientificType, ShowSignOption } from "@itwin/core-quantity";
+import { InvertedUnit } from "./InvertedUnit";
+import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
+import { Unit } from "./Unit";
+/**
+ * @beta
+ */
+export declare class Format extends SchemaItem {
+    readonly schemaItemType: SchemaItemType.Format;
+    protected _base: BaseFormat;
+    protected _units?: Array<[Unit | InvertedUnit, string | undefined]>;
+    constructor(schema: Schema, name: string);
+    get roundFactor(): number;
+    get type(): FormatType;
+    get precision(): DecimalPrecision | FractionalPrecision;
+    get minWidth(): number | undefined;
+    get scientificType(): ScientificType | undefined;
+    get showSignOption(): ShowSignOption;
+    get decimalSeparator(): string;
+    get thousandSeparator(): string;
+    get uomSeparator(): string;
+    get stationSeparator(): string;
+    get stationOffsetSize(): number | undefined;
+    get formatTraits(): FormatTraits;
+    get spacer(): string | undefined;
+    get includeZero(): boolean | undefined;
+    get units(): Array<[Unit | InvertedUnit, 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.
+     */
+    protected addUnit(unit: Unit | InvertedUnit, label?: string): void;
+    protected setPrecision(precision: number): void;
+    private typecheck;
+    fromJSONSync(formatProps: FormatProps): void;
+    fromJSON(formatProps: FormatProps): Promise<void>;
+    /**
+     * Save this Format's properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): FormatProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setFormatType(formatType: FormatType): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setRoundFactor(roundFactor: number): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setShowSignOption(signOption: ShowSignOption): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setDecimalSeparator(separator: string): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setThousandSeparator(separator: string): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setUomSeparator(separator: string): void;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setStationSeparator(separator: string): void;
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableFormat extends Format {
+    abstract addUnit(unit: Unit | InvertedUnit, label?: string): void;
+    abstract setPrecision(precision: number): void;
+    abstract setFormatType(formatType: FormatType): void;
+    abstract setRoundFactor(roundFactor: number): void;
+    abstract setShowSignOption(signOption: ShowSignOption): void;
+    abstract setDecimalSeparator(separator: string): void;
+    abstract setThousandSeparator(separator: string): void;
+    abstract setUomSeparator(separator: string): void;
+    abstract setStationSeparator(separator: string): void;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
 //# sourceMappingURL=Format.d.ts.map