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

package/lib/cjs/Metadata/EntityClass.js

@@ -1,231 +1,231 @@
-"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.createNavigationPropertySync = exports.createNavigationProperty = exports.MutableEntityClass = exports.EntityClass = void 0;
-const DelayedPromise_1 = require("../DelayedPromise");
-const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
-const ECObjects_1 = require("../ECObjects");
-const Exception_1 = require("../Exception");
-const Class_1 = require("./Class");
-const Property_1 = require("./Property");
-/**
- * A Typescript class representation of an ECEntityClass.
- * @beta
- */
-class EntityClass extends Class_1.ECClass {
-    constructor(schema, name, modifier) {
-        super(schema, name, modifier);
-        this.schemaItemType = ECObjects_1.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 DelayedPromise_1.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) {
-            Class_1.ECClass.mergeProperties(result, existingValues, await (await this.baseClass).getProperties(resetBaseCaches), false);
-        }
-        for (const mixin of this.mixins) {
-            Class_1.ECClass.mergeProperties(result, existingValues, await (await mixin).getProperties(resetBaseCaches), false);
-        }
-        if (!this.properties)
-            return;
-        Class_1.ECClass.mergeProperties(result, existingValues, [...this.properties], true);
-    }
-    buildPropertyCacheSync(result, existingValues, resetBaseCaches = false) {
-        if (!existingValues) {
-            existingValues = new Map();
-        }
-        const baseClass = this.getBaseClassSync();
-        if (baseClass) {
-            Class_1.ECClass.mergeProperties(result, existingValues, baseClass.getPropertiesSync(resetBaseCaches), false);
-        }
-        for (const mixin of this.getMixinsSync()) {
-            Class_1.ECClass.mergeProperties(result, existingValues, mixin.getPropertiesSync(resetBaseCaches), false);
-        }
-        if (!this.properties)
-            return;
-        Class_1.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_1.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 Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin ("${name}") that cannot be found.`);
-                this._mixins.push(new DelayedPromise_1.DelayedPromiseWithProps(mixinSchemaItemKey, async () => {
-                    const mixin = await this.schema.lookupItem(mixinSchemaItemKey);
-                    if (undefined === mixin)
-                        throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin ("${name}") that cannot be found.`);
-                    return mixin;
-                }));
-            }
-        }
-    }
-}
-exports.EntityClass = EntityClass;
-/**
- * Hackish approach that works like a "friend class" so we can access protected members without making them public.
- * @internal
- */
-class MutableEntityClass extends EntityClass {
-}
-exports.MutableEntityClass = MutableEntityClass;
-/** @internal */
-async function createNavigationProperty(ecClass, name, relationship, direction) {
-    if (await ecClass.getProperty(name))
-        throw new Exception_1.ECObjectsError(Exception_1.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 Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);
-    if (typeof (direction) === "string") {
-        const tmpDirection = (0, ECObjects_1.parseStrengthDirection)(direction);
-        if (undefined === tmpDirection)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);
-        direction = tmpDirection;
-    }
-    const lazyRelationship = new DelayedPromise_1.DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);
-    return new Property_1.NavigationProperty(ecClass, name, lazyRelationship, direction);
-}
-exports.createNavigationProperty = createNavigationProperty;
-/** @internal */
-function createNavigationPropertySync(ecClass, name, relationship, direction) {
-    if (ecClass.getPropertySync(name))
-        throw new Exception_1.ECObjectsError(Exception_1.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 Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);
-    if (typeof (direction) === "string") {
-        const tmpDirection = (0, ECObjects_1.parseStrengthDirection)(direction);
-        if (undefined === tmpDirection)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);
-        direction = tmpDirection;
-    }
-    const lazyRelationship = new DelayedPromise_1.DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);
-    return new Property_1.NavigationProperty(ecClass, name, lazyRelationship, direction);
-}
-exports.createNavigationPropertySync = createNavigationPropertySync;
+"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.createNavigationPropertySync = exports.createNavigationProperty = exports.MutableEntityClass = exports.EntityClass = void 0;
+const DelayedPromise_1 = require("../DelayedPromise");
+const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
+const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
+const Class_1 = require("./Class");
+const Property_1 = require("./Property");
+/**
+ * A Typescript class representation of an ECEntityClass.
+ * @beta
+ */
+class EntityClass extends Class_1.ECClass {
+    constructor(schema, name, modifier) {
+        super(schema, name, modifier);
+        this.schemaItemType = ECObjects_1.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 DelayedPromise_1.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) {
+            Class_1.ECClass.mergeProperties(result, existingValues, await (await this.baseClass).getProperties(resetBaseCaches), false);
+        }
+        for (const mixin of this.mixins) {
+            Class_1.ECClass.mergeProperties(result, existingValues, await (await mixin).getProperties(resetBaseCaches), false);
+        }
+        if (!this.properties)
+            return;
+        Class_1.ECClass.mergeProperties(result, existingValues, [...this.properties], true);
+    }
+    buildPropertyCacheSync(result, existingValues, resetBaseCaches = false) {
+        if (!existingValues) {
+            existingValues = new Map();
+        }
+        const baseClass = this.getBaseClassSync();
+        if (baseClass) {
+            Class_1.ECClass.mergeProperties(result, existingValues, baseClass.getPropertiesSync(resetBaseCaches), false);
+        }
+        for (const mixin of this.getMixinsSync()) {
+            Class_1.ECClass.mergeProperties(result, existingValues, mixin.getPropertiesSync(resetBaseCaches), false);
+        }
+        if (!this.properties)
+            return;
+        Class_1.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_1.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 Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin ("${name}") that cannot be found.`);
+                this._mixins.push(new DelayedPromise_1.DelayedPromiseWithProps(mixinSchemaItemKey, async () => {
+                    const mixin = await this.schema.lookupItem(mixinSchemaItemKey);
+                    if (undefined === mixin)
+                        throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The ECEntityClass ${this.name} has a mixin ("${name}") that cannot be found.`);
+                    return mixin;
+                }));
+            }
+        }
+    }
+}
+exports.EntityClass = EntityClass;
+/**
+ * Hackish approach that works like a "friend class" so we can access protected members without making them public.
+ * @internal
+ */
+class MutableEntityClass extends EntityClass {
+}
+exports.MutableEntityClass = MutableEntityClass;
+/** @internal */
+async function createNavigationProperty(ecClass, name, relationship, direction) {
+    if (await ecClass.getProperty(name))
+        throw new Exception_1.ECObjectsError(Exception_1.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 Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);
+    if (typeof (direction) === "string") {
+        const tmpDirection = (0, ECObjects_1.parseStrengthDirection)(direction);
+        if (undefined === tmpDirection)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);
+        direction = tmpDirection;
+    }
+    const lazyRelationship = new DelayedPromise_1.DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);
+    return new Property_1.NavigationProperty(ecClass, name, lazyRelationship, direction);
+}
+exports.createNavigationProperty = createNavigationProperty;
+/** @internal */
+function createNavigationPropertySync(ecClass, name, relationship, direction) {
+    if (ecClass.getPropertySync(name))
+        throw new Exception_1.ECObjectsError(Exception_1.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 Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `The provided RelationshipClass, ${relationship}, is not a valid RelationshipClassInterface.`);
+    if (typeof (direction) === "string") {
+        const tmpDirection = (0, ECObjects_1.parseStrengthDirection)(direction);
+        if (undefined === tmpDirection)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidStrengthDirection, `The provided StrengthDirection, ${direction}, is not a valid StrengthDirection.`);
+        direction = tmpDirection;
+    }
+    const lazyRelationship = new DelayedPromise_1.DelayedPromiseWithProps(resolvedRelationship.key, async () => resolvedRelationship);
+    return new Property_1.NavigationProperty(ecClass, name, lazyRelationship, direction);
+}
+exports.createNavigationPropertySync = createNavigationPropertySync;
 //# sourceMappingURL=EntityClass.js.map

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

@@ -1,87 +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 declare 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;
-}
+/** @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/cjs/Metadata/Enumeration.d.ts.map

@@ -1 +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,oBAAY,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"}
+{"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"}