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

package/lib/esm/Metadata/EntityClass.js

@@ -0,0 +1,224 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { DelayedPromiseWithProps } from "../DelayedPromise";
+import { XmlSerializationUtils } from "../Deserialization/XmlSerializationUtils";
+import { parseStrengthDirection, SchemaItemType } from "../ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { ECClass } from "./Class";
+import { NavigationProperty } from "./Property";
+/**
+ * A Typescript class representation of an ECEntityClass.
+ * @beta
+ */
+export class EntityClass extends ECClass {
+    constructor(schema, name, modifier) {
+        super(schema, name, modifier);
+        this.schemaItemType = SchemaItemType.EntityClass;
+    }
+    get mixins() {
+        if (!this._mixins)
+            return [];
+        return this._mixins;
+    }
+    *getMixinsSync() {
+        if (!this._mixins)
+            return function* () { }(); // empty iterable
+        for (const mixin of this._mixins) {
+            const mObj = this.schema.lookupItemSync(mixin);
+            if (mObj) {
+                yield mObj;
+            }
+        }
+    }
+    /**
+     *
+     * @param mixin
+     */
+    addMixin(mixin) {
+        if (!this._mixins)
+            this._mixins = [];
+        this._mixins.push(new DelayedPromiseWithProps(mixin.key, async () => mixin));
+        return;
+    }
+    /**
+     * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.
+     * @param name The name of the property to find.
+     */
+    async getInheritedProperty(name) {
+        let inheritedProperty = await super.getInheritedProperty(name);
+        if (!inheritedProperty && this._mixins) {
+            const mixinProps = await Promise.all(this._mixins.map(async (mixin) => (await mixin).getProperty(name)));
+            mixinProps.some((prop) => {
+                inheritedProperty = prop;
+                return inheritedProperty !== undefined;
+            });
+        }
+        return inheritedProperty;
+    }
+    /**
+     * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.
+     * @param name The name of the property to find.
+     */
+    getInheritedPropertySync(name) {
+        const inheritedProperty = super.getInheritedPropertySync(name);
+        if (inheritedProperty)
+            return inheritedProperty;
+        if (!this._mixins) {
+            return undefined;
+        }
+        for (const mixin of this._mixins) {
+            const mObj = this.schema.lookupItemSync(mixin);
+            if (mObj) {
+                const result = mObj.getPropertySync(name, true);
+                if (result) {
+                    return result;
+                }
+            }
+        }
+        return undefined;
+    }
+    async buildPropertyCache(result, existingValues, resetBaseCaches = false) {
+        if (!existingValues) {
+            existingValues = new Map();
+        }
+        if (this.baseClass) {
+            ECClass.mergeProperties(result, existingValues, await (await this.baseClass).getProperties(resetBaseCaches), false);
+        }
+        for (const mixin of this.mixins) {
+            ECClass.mergeProperties(result, existingValues, await (await mixin).getProperties(resetBaseCaches), false);
+        }
+        if (!this.properties)
+            return;
+        ECClass.mergeProperties(result, existingValues, [...this.properties], true);
+    }
+    buildPropertyCacheSync(result, existingValues, resetBaseCaches = false) {
+        if (!existingValues) {
+            existingValues = new Map();
+        }
+        const baseClass = this.getBaseClassSync();
+        if (baseClass) {
+            ECClass.mergeProperties(result, existingValues, baseClass.getPropertiesSync(resetBaseCaches), false);
+        }
+        for (const mixin of this.getMixinsSync()) {
+            ECClass.mergeProperties(result, existingValues, mixin.getPropertiesSync(resetBaseCaches), false);
+        }
+        if (!this.properties)
+            return;
+        ECClass.mergeProperties(result, existingValues, [...this.properties], true);
+    }
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    async createNavigationProperty(name, relationship, direction) {
+        return this.addProperty(await createNavigationProperty(this, name, relationship, direction));
+    }
+    /**
+     *
+     * @param name
+     * @param relationship
+     * @param direction
+     */
+    createNavigationPropertySync(name, relationship, direction) {
+        return this.addProperty(createNavigationPropertySync(this, name, relationship, direction));
+    }
+    /**
+     * Save this EntityClass' properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone = false, includeSchemaVersion = false) {
+        const schemaJson = super.toJSON(standalone, includeSchemaVersion);
+        if (this.mixins.length > 0)
+            schemaJson.mixins = this.mixins.map((mixin) => mixin.fullName);
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        for (const mixin of this.getMixinsSync()) {
+            const mixinElement = schemaXml.createElement("BaseClass");
+            const mixinName = XmlSerializationUtils.createXmlTypedName(this.schema, mixin.schema, mixin.name);
+            mixinElement.textContent = mixinName;
+            itemElement.appendChild(mixinElement);
+        }
+        return itemElement;
+    }
+    async fromJSON(entityClassProps) {
+        this.fromJSONSync(entityClassProps);
+    }
+    fromJSONSync(entityClassProps) {
+        super.fromJSONSync(entityClassProps);
+        if (undefined !== entityClassProps.mixins) {
+            if (!this._mixins)
+                this._mixins = [];
+            for (const name of entityClassProps.mixins) {
+                const mixinSchemaItemKey = this.schema.getSchemaItemKey(name);
+                if (!mixinSchemaItemKey)
+                    throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin ("${name}") that cannot be found.`);
+                this._mixins.push(new DelayedPromiseWithProps(mixinSchemaItemKey, async () => {
+                    const mixin = await this.schema.lookupItem(mixinSchemaItemKey);
+                    if (undefined === mixin)
+                        throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin ("${name}") that cannot be found.`);
+                    return mixin;
+                }));
+            }
+        }
+    }
+}
+/**
+ * Hackish approach that works like a "friend class" so we can access protected members without making them public.
+ * @internal
+ */
+export class MutableEntityClass extends EntityClass {
+}
+/** @internal */
+export async function createNavigationProperty(ecClass, name, relationship, direction) {
+    if (await ecClass.getProperty(name))
+        throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);
+    let resolvedRelationship;
+    if (typeof (relationship) === "string") {
+        resolvedRelationship = await ecClass.schema.lookupItem(relationship);
+    }
+    else
+        resolvedRelationship = relationship;
+    if (!resolvedRelationship)
+        throw new ECObjectsError(ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`); // eslint-disable-line @typescript-eslint/no-base-to-string
+    if (typeof (direction) === "string") {
+        const tmpDirection = parseStrengthDirection(direction);
+        if (undefined === tmpDirection)
+            throw new ECObjectsError(ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);
+        direction = tmpDirection;
+    }
+    const lazyRelationship = new DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);
+    return new NavigationProperty(ecClass, name, lazyRelationship, direction);
+}
+/** @internal */
+export function createNavigationPropertySync(ecClass, name, relationship, direction) {
+    if (ecClass.getPropertySync(name))
+        throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);
+    let resolvedRelationship;
+    if (typeof (relationship) === "string") {
+        resolvedRelationship = ecClass.schema.lookupItemSync(relationship);
+    }
+    else
+        resolvedRelationship = relationship;
+    if (!resolvedRelationship)
+        throw new ECObjectsError(ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`); // eslint-disable-line @typescript-eslint/no-base-to-string
+    if (typeof (direction) === "string") {
+        const tmpDirection = parseStrengthDirection(direction);
+        if (undefined === tmpDirection)
+            throw new ECObjectsError(ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);
+        direction = tmpDirection;
+    }
+    const lazyRelationship = new DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);
+    return new NavigationProperty(ecClass, name, lazyRelationship, direction);
+}
+//# sourceMappingURL=EntityClass.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EntityClass.js","sourceRoot":"","sources":["../../../src/Metadata/EntityClass.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAmB,sBAAsB,EAAE,cAAc,EAAqB,MAAM,cAAc,CAAC;AAC1G,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,OAAO,EAAe,kBAAkB,EAAY,MAAM,YAAY,CAAC;AAIvE;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,OAAO;IAItC,YAAY,MAAc,EAAE,IAAY,EAAE,QAA0B;QAClE,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,WAAW,CAAC;IACnD,CAAC;IAED,IAAW,MAAM;QACf,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,OAAO,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,CAAC,aAAa;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,OAAO,QAAQ,CAAC,MAAuB,CAAC,EAAE,CAAC,CAAC,iBAAiB;QAE/D,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAQ,KAAK,CAAC,CAAC;YACtD,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,IAAI,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,QAAQ,CAAC,KAAY;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7E,OAAO;IACT,CAAC;IAED;;;OAGG;IACa,KAAK,CAAC,oBAAoB,CAAC,IAAY;QACrD,IAAI,iBAAiB,GAAG,MAAM,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAE/D,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACzG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACvB,iBAAiB,GAAG,IAAmB,CAAC;gBACxC,OAAO,iBAAiB,KAAK,SAAS,CAAC;YACzC,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,iBAA4C,CAAC;IACtD,CAAC;IAED;;;OAGG;IACa,wBAAwB,CAAC,IAAY;QACnD,MAAM,iBAAiB,GAAG,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,iBAAiB;YACnB,OAAO,iBAAiB,CAAC;QAE3B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAU,KAAK,CAAC,CAAC;YACxD,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAChD,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEkB,KAAK,CAAC,kBAAkB,CAAC,MAAkB,EAAE,cAAoC,EAAE,kBAA2B,KAAK;QACpI,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC7C,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACtH,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QAC7G,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,OAAO;QAET,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAEkB,sBAAsB,CAAC,MAAkB,EAAE,cAAoC,EAAE,kBAA2B,KAAK;QAClI,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC7C,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1C,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACvG,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC;QACnG,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,OAAO;QAET,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,wBAAwB,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACpI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;OAKG;IACO,4BAA4B,CAAC,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAClI,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YACxB,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEjD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACzC,MAAM,YAAY,GAAG,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAC1D,MAAM,SAAS,GAAG,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAClG,YAAY,CAAC,WAAW,GAAG,SAAS,CAAC;YACrC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,gBAAkC;QAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IACtC,CAAC;IAEe,YAAY,CAAC,gBAAkC;QAC7D,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;QAErC,IAAI,SAAS,KAAK,gBAAgB,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAC3C,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAC9D,IAAI,CAAC,kBAAkB;oBACrB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,qBAAqB,IAAI,CAAC,IAAI,kBAAkB,IAAI,0BAA0B,CAAC,CAAC;gBAC1I,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAuB,kBAAkB,EACpF,KAAK,IAAI,EAAE;oBACT,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAQ,kBAAkB,CAAC,CAAC;oBACtE,IAAI,SAAS,KAAK,KAAK;wBACrB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,qBAAqB,IAAI,CAAC,IAAI,kBAAkB,IAAI,0BAA0B,CAAC,CAAC;oBAC1I,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC,CAAC;YACR,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,WAAW;CAK3D;AAED,gBAAgB;AAChB,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,OAAgB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;IAC5J,IAAI,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;QACjC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,IAAI,gCAAgC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAElJ,IAAI,oBAAmD,CAAC;IACxD,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,QAAQ,EAAE,CAAC;QACvC,oBAAoB,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAoB,YAAY,CAAC,CAAC;IAC1F,CAAC;;QACC,oBAAoB,GAAG,YAAY,CAAC;IAEtC,IAAI,CAAC,oBAAoB;QACvB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,mCAAmC,YAAY,8CAA8C,CAAC,CAAC,CAAE,2DAA2D;IAEpN,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,SAAS,KAAK,YAAY;YAC5B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,wBAAwB,EAAE,mCAAmC,SAAS,qCAAqC,CAAC,CAAC;QACxJ,SAAS,GAAG,YAAY,CAAC;IAC3B,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,oBAAqB,CAAC,CAAC;IAClH,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAC5E,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,4BAA4B,CAAC,OAAgB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;IAC1J,IAAI,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC;QAC/B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,iBAAiB,EAAE,+BAA+B,IAAI,gCAAgC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAElJ,IAAI,oBAAmD,CAAC;IACxD,IAAI,OAAO,CAAC,YAAY,CAAC,KAAK,QAAQ,EAAE,CAAC;QACvC,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAoB,YAAY,CAAC,CAAC;IACxF,CAAC;;QACC,oBAAoB,GAAG,YAAY,CAAC;IAEtC,IAAI,CAAC,oBAAoB;QACvB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,WAAW,EAAE,mCAAmC,YAAY,8CAA8C,CAAC,CAAC,CAAE,2DAA2D;IAEpN,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,YAAY,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,SAAS,KAAK,YAAY;YAC5B,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,wBAAwB,EAAE,mCAAmC,SAAS,qCAAqC,CAAC,CAAC;QACxJ,SAAS,GAAG,YAAY,CAAC;IAC3B,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,oBAAqB,CAAC,CAAC;IAClH,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,CAAC,CAAC;AAC5E,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { DelayedPromiseWithProps } from \"../DelayedPromise\";\r\nimport { EntityClassProps } from \"../Deserialization/JsonProps\";\r\nimport { XmlSerializationUtils } from \"../Deserialization/XmlSerializationUtils\";\r\nimport { ECClassModifier, parseStrengthDirection, SchemaItemType, StrengthDirection } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { LazyLoadedMixin } from \"../Interfaces\";\r\nimport { SchemaItemKey } from \"../SchemaKey\";\r\nimport { ECClass } from \"./Class\";\r\nimport { Mixin } from \"./Mixin\";\r\nimport { AnyProperty, NavigationProperty, Property } from \"./Property\";\r\nimport { RelationshipClass } from \"./RelationshipClass\";\r\nimport { Schema } from \"./Schema\";\r\n\r\n/**\r\n * A Typescript class representation of an ECEntityClass.\r\n * @beta\r\n */\r\nexport class EntityClass extends ECClass {\r\n  public override readonly schemaItemType!: SchemaItemType.EntityClass; // eslint-disable-line\r\n  protected _mixins?: LazyLoadedMixin[];\r\n\r\n  constructor(schema: Schema, name: string, modifier?: ECClassModifier) {\r\n    super(schema, name, modifier);\r\n    this.schemaItemType = SchemaItemType.EntityClass;\r\n  }\r\n\r\n  public get mixins(): LazyLoadedMixin[] {\r\n    if (!this._mixins)\r\n      return [];\r\n    return this._mixins;\r\n  }\r\n\r\n  public *getMixinsSync(): Iterable<Mixin> {\r\n    if (!this._mixins)\r\n      return function* (): Iterable<Mixin> { }(); // empty iterable\r\n\r\n    for (const mixin of this._mixins) {\r\n      const mObj = this.schema.lookupItemSync<Mixin>(mixin);\r\n      if (mObj) {\r\n        yield mObj;\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param mixin\r\n   */\r\n  protected addMixin(mixin: Mixin) {\r\n    if (!this._mixins)\r\n      this._mixins = [];\r\n\r\n    this._mixins.push(new DelayedPromiseWithProps(mixin.key, async () => mixin));\r\n    return;\r\n  }\r\n\r\n  /**\r\n   * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.\r\n   * @param name The name of the property to find.\r\n   */\r\n  public override async getInheritedProperty(name: string): Promise<AnyProperty | undefined> {\r\n    let inheritedProperty = await super.getInheritedProperty(name);\r\n\r\n    if (!inheritedProperty && this._mixins) {\r\n      const mixinProps = await Promise.all(this._mixins.map(async (mixin) => (await mixin).getProperty(name)));\r\n      mixinProps.some((prop) => {\r\n        inheritedProperty = prop as AnyProperty;\r\n        return inheritedProperty !== undefined;\r\n      });\r\n    }\r\n\r\n    return inheritedProperty as AnyProperty | undefined;\r\n  }\r\n\r\n  /**\r\n   * Searches the base class, if one exists, first then any mixins that exist for the property with the name provided.\r\n   * @param name The name of the property to find.\r\n   */\r\n  public override getInheritedPropertySync(name: string): Property | undefined {\r\n    const inheritedProperty = super.getInheritedPropertySync(name);\r\n    if (inheritedProperty)\r\n      return inheritedProperty;\r\n\r\n    if (!this._mixins) {\r\n      return undefined;\r\n    }\r\n\r\n    for (const mixin of this._mixins) {\r\n      const mObj = this.schema.lookupItemSync<ECClass>(mixin);\r\n      if (mObj) {\r\n        const result = mObj.getPropertySync(name, true);\r\n        if (result) {\r\n          return result;\r\n        }\r\n      }\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  protected override async buildPropertyCache(result: Property[], existingValues?: Map<string, number>, resetBaseCaches: boolean = false): Promise<void> {\r\n    if (!existingValues) {\r\n      existingValues = new Map<string, number>();\r\n    }\r\n\r\n    if (this.baseClass) {\r\n      ECClass.mergeProperties(result, existingValues, await (await this.baseClass).getProperties(resetBaseCaches), false);\r\n    }\r\n\r\n    for (const mixin of this.mixins) {\r\n      ECClass.mergeProperties(result, existingValues, await (await mixin).getProperties(resetBaseCaches), false);\r\n    }\r\n\r\n    if (!this.properties)\r\n      return;\r\n\r\n    ECClass.mergeProperties(result, existingValues, [...this.properties], true);\r\n  }\r\n\r\n  protected override buildPropertyCacheSync(result: Property[], existingValues?: Map<string, number>, resetBaseCaches: boolean = false): void {\r\n    if (!existingValues) {\r\n      existingValues = new Map<string, number>();\r\n    }\r\n\r\n    const baseClass = this.getBaseClassSync();\r\n    if (baseClass) {\r\n      ECClass.mergeProperties(result, existingValues, baseClass.getPropertiesSync(resetBaseCaches), false);\r\n    }\r\n\r\n    for (const mixin of this.getMixinsSync()) {\r\n      ECClass.mergeProperties(result, existingValues, mixin.getPropertiesSync(resetBaseCaches), false);\r\n    }\r\n\r\n    if (!this.properties)\r\n      return;\r\n\r\n    ECClass.mergeProperties(result, existingValues, [...this.properties], true);\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param name\r\n   * @param relationship\r\n   * @param direction\r\n   */\r\n  protected async createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty> {\r\n    return this.addProperty(await createNavigationProperty(this, name, relationship, direction));\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param name\r\n   * @param relationship\r\n   * @param direction\r\n   */\r\n  protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\r\n    return this.addProperty(createNavigationPropertySync(this, name, relationship, direction));\r\n  }\r\n\r\n  /**\r\n   * Save this EntityClass' 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): EntityClassProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    if (this.mixins.length > 0)\r\n      schemaJson.mixins = this.mixins.map((mixin) => mixin.fullName);\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n\r\n    for (const mixin of this.getMixinsSync()) {\r\n      const mixinElement = schemaXml.createElement(\"BaseClass\");\r\n      const mixinName = XmlSerializationUtils.createXmlTypedName(this.schema, mixin.schema, mixin.name);\r\n      mixinElement.textContent = mixinName;\r\n      itemElement.appendChild(mixinElement);\r\n    }\r\n    return itemElement;\r\n  }\r\n\r\n  public override async fromJSON(entityClassProps: EntityClassProps) {\r\n    this.fromJSONSync(entityClassProps);\r\n  }\r\n\r\n  public override fromJSONSync(entityClassProps: EntityClassProps) {\r\n    super.fromJSONSync(entityClassProps);\r\n\r\n    if (undefined !== entityClassProps.mixins) {\r\n      if (!this._mixins)\r\n        this._mixins = [];\r\n      for (const name of entityClassProps.mixins) {\r\n        const mixinSchemaItemKey = this.schema.getSchemaItemKey(name);\r\n        if (!mixinSchemaItemKey)\r\n          throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin (\"${name}\") that cannot be found.`);\r\n        this._mixins.push(new DelayedPromiseWithProps<SchemaItemKey, Mixin>(mixinSchemaItemKey,\r\n          async () => {\r\n            const mixin = await this.schema.lookupItem<Mixin>(mixinSchemaItemKey);\r\n            if (undefined === mixin)\r\n              throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin (\"${name}\") that cannot be found.`);\r\n            return mixin;\r\n          }));\r\n      }\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Hackish approach that works like a \"friend class\" so we can access protected members without making them public.\r\n * @internal\r\n */\r\nexport abstract class MutableEntityClass extends EntityClass {\r\n  public abstract override addMixin(mixin: Mixin): any;\r\n  public abstract override createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;\r\n  public abstract override createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n\r\n/** @internal */\r\nexport async function createNavigationProperty(ecClass: ECClass, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty> {\r\n  if (await ecClass.getProperty(name))\r\n    throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);\r\n\r\n  let resolvedRelationship: RelationshipClass | undefined;\r\n  if (typeof (relationship) === \"string\") {\r\n    resolvedRelationship = await ecClass.schema.lookupItem<RelationshipClass>(relationship);\r\n  } else\r\n    resolvedRelationship = relationship;\r\n\r\n  if (!resolvedRelationship)\r\n    throw new ECObjectsError(ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);  // eslint-disable-line @typescript-eslint/no-base-to-string\r\n\r\n  if (typeof (direction) === \"string\") {\r\n    const tmpDirection = parseStrengthDirection(direction);\r\n    if (undefined === tmpDirection)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);\r\n    direction = tmpDirection;\r\n  }\r\n\r\n  const lazyRelationship = new DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship!);\r\n  return new NavigationProperty(ecClass, name, lazyRelationship, direction);\r\n}\r\n\r\n/** @internal */\r\nexport function createNavigationPropertySync(ecClass: ECClass, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty {\r\n  if (ecClass.getPropertySync(name))\r\n    throw new ECObjectsError(ECObjectsStatus.DuplicateProperty, `An ECProperty with the name ${name} already exists in the class ${ecClass.name}.`);\r\n\r\n  let resolvedRelationship: RelationshipClass | undefined;\r\n  if (typeof (relationship) === \"string\") {\r\n    resolvedRelationship = ecClass.schema.lookupItemSync<RelationshipClass>(relationship);\r\n  } else\r\n    resolvedRelationship = relationship;\r\n\r\n  if (!resolvedRelationship)\r\n    throw new ECObjectsError(ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);  // eslint-disable-line @typescript-eslint/no-base-to-string\r\n\r\n  if (typeof (direction) === \"string\") {\r\n    const tmpDirection = parseStrengthDirection(direction);\r\n    if (undefined === tmpDirection)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);\r\n    direction = tmpDirection;\r\n  }\r\n\r\n  const lazyRelationship = new DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship!);\r\n  return new NavigationProperty(ecClass, name, lazyRelationship, direction);\r\n}\r\n"]}

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

@@ -0,0 +1,87 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { EnumerationProps } from "../Deserialization/JsonProps";
+import { PrimitiveType, SchemaItemType } from "../ECObjects";
+import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
+/** @beta */
+export interface Enumerator<T> {
+    readonly name: string;
+    readonly value: T;
+    readonly label?: string;
+    readonly description?: string;
+}
+/** @beta */
+export type AnyEnumerator = Enumerator<string | number>;
+/**
+ * A Typescript class representation of an ECEnumeration.
+ * @beta
+ */
+export declare class Enumeration extends SchemaItem {
+    readonly schemaItemType: SchemaItemType.Enumeration;
+    protected _type?: PrimitiveType.Integer | PrimitiveType.String;
+    protected _isStrict: boolean;
+    protected _enumerators: AnyEnumerator[];
+    get enumerators(): AnyEnumerator[];
+    get type(): PrimitiveType.Integer | PrimitiveType.String | undefined;
+    get isStrict(): boolean;
+    constructor(schema: Schema, name: string, primitiveType?: PrimitiveType.Integer | PrimitiveType.String);
+    get isInt(): boolean;
+    get isString(): boolean;
+    /**
+     * Gets an enumerator that matches the name provided.
+     * @param name The ECName of the Enumerator to find.
+     */
+    getEnumeratorByName(name: string): AnyEnumerator | undefined;
+    /**
+     * Gets an enumerator that matches the value provided.
+     * @param value The value of the Enumerator to find.
+     */
+    getEnumerator(value: string): Enumerator<string> | undefined;
+    getEnumerator(value: number): Enumerator<number> | undefined;
+    /**
+     * 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
+     */
+    private findDuplicateEnumerators;
+    /**
+     * 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: string, value: string | number, label?: string, description?: string): AnyEnumerator;
+    /**
+     * Adds enumerator to list of enumerators on this Enumeration
+     * @param enumerator The enumerator to add
+     */
+    protected addEnumerator(enumerator: AnyEnumerator): void;
+    /**
+     * 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?: boolean, includeSchemaVersion?: boolean): EnumerationProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(enumerationProps: EnumerationProps): void;
+    fromJSON(enumerationProps: EnumerationProps): Promise<void>;
+    /**
+     * @alpha Used in schema editing.
+     */
+    protected setIsStrict(isStrict: boolean): void;
+}
+/** @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableEnumeration extends Enumeration {
+    abstract addEnumerator(enumerator: AnyEnumerator): void;
+    abstract setIsStrict(isStrict: boolean): void;
+    abstract setDisplayLabel(displayLabel: string): void;
+}
+//# sourceMappingURL=Enumeration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Enumeration.d.ts","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAmB,MAAM,8BAA8B,CAAC;AACjF,OAAO,EAAE,aAAa,EAAyB,cAAc,EAAE,MAAM,cAAc,CAAC;AAGpF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,YAAY;AACZ,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAExD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,UAAU;IACzC,SAAyB,cAAc,EAAG,cAAc,CAAC,WAAW,CAAC;IACrE,SAAS,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC;IAC/D,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC;IAExC,IAAW,WAAW,oBAAgC;IACtD,IAAW,IAAI,6DAAyB;IACxC,IAAW,QAAQ,YAA6B;gBAEpC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM;IAQtG,IAAW,KAAK,IAAI,OAAO,CAAiD;IAC5E,IAAW,QAAQ,IAAI,OAAO,CAAgD;IAE9E;;;OAGG;IACI,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAInE;;;OAGG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,SAAS;IAC5D,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,SAAS;IAKnE;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAShC;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,aAAa;IAWlH;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,aAAa;IAIjD;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,gBAAgB;IAe5G,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAqBlD,YAAY,CAAC,gBAAgB,EAAE,gBAAgB;IAyBzC,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB;IAIjE;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO;CAIxC;AAED;;GAEG;AACH,8BAAsB,kBAAmB,SAAQ,WAAW;aACjC,aAAa,CAAC,UAAU,EAAE,aAAa,GAAG,IAAI;aAC9C,WAAW,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI;aACpC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/esm/Metadata/Enumeration.js

@@ -0,0 +1,155 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { PrimitiveType, primitiveTypeToString, SchemaItemType } from "../ECObjects";
+import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { ECName } from "../ECName";
+import { SchemaItem } from "./SchemaItem";
+/**
+ * A Typescript class representation of an ECEnumeration.
+ * @beta
+ */
+export class Enumeration extends 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 = SchemaItemType.Enumeration;
+        this._type = primitiveType;
+        this._isStrict = true;
+        this._enumerators = [];
+    }
+    get isInt() { return this._type === PrimitiveType.Integer; }
+    get isString() { return this._type === 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 ECObjectsError(ECObjectsStatus.InvalidECJson, `The Enumeration ${this.name} has a duplicate Enumerator with name '${name}'.`);
+            if (element.value === value)
+                throw new ECObjectsError(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 ECObjectsError(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 ECObjectsError(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.validate(name))
+            throw new ECObjectsError(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", 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 = PrimitiveType.Integer;
+            else if (/string/i.test(enumerationProps.type))
+                this._type = PrimitiveType.String;
+            else
+                throw new ECObjectsError(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 ECObjectsError(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;
+    }
+}
+/** @internal
+ * An abstract class used for schema editing.
+ */
+export class MutableEnumeration extends Enumeration {
+}
+//# sourceMappingURL=Enumeration.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Enumeration.js","sourceRoot":"","sources":["../../../src/Metadata/Enumeration.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAa1C;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,UAAU;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,cAAc,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,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5E,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,KAAK,KAAK,aAAa,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,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0CAA0C,IAAI,IAAI,CAAC,CAAC;YAC1I,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK;gBACzB,MAAM,IAAI,cAAc,CAAC,eAAe,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,cAAc,CAAC,eAAe,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,cAAc,CAAC,eAAe,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,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,cAAc,CAAC,eAAe,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,qBAAqB,CAAC,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;gBACpC,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC;iBAChC,IAAI,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAC5C,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;;gBAElC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,mBAAmB,IAAI,CAAC,IAAI,0EAA0E,CAAC,CAAC;QACpK,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,cAAc,CAAC,eAAe,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;AAED;;GAEG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,WAAW;CAI3D","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/esm/Metadata/Format.d.ts

@@ -0,0 +1,99 @@
+/** @packageDocumentation
+ * @module Metadata
+ */
+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 { 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: SchemaItemFormatProps): void;
+    fromJSON(formatProps: SchemaItemFormatProps): 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): SchemaItemFormatProps;
+    /** @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