@itwin/ecschema-metadata 3.6.0-dev.8 → 3.7.0-dev.1

package/lib/cjs/Metadata/Property.js

@@ -1,492 +1,492 @@
-"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.MutableProperty = exports.StructArrayProperty = exports.EnumerationArrayProperty = exports.PrimitiveArrayProperty = exports.ArrayProperty = exports.NavigationProperty = exports.StructProperty = exports.EnumerationProperty = exports.PrimitiveProperty = exports.PrimitiveOrEnumPropertyBase = exports.Property = void 0;
-const DelayedPromise_1 = require("../DelayedPromise");
-const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
-const ECObjects_1 = require("../ECObjects");
-const Exception_1 = require("../Exception");
-const PropertyTypes_1 = require("../PropertyTypes");
-const ECName_1 = require("../ECName");
-const CustomAttribute_1 = require("./CustomAttribute");
-/**
- * A common abstract class for all ECProperty types.
- * @beta
- */
-class Property {
-    constructor(ecClass, name, type) {
-        this._class = ecClass;
-        this._name = new ECName_1.ECName(name);
-        this._type = type;
-    }
-    isArray() { return PropertyTypes_1.PropertyTypeUtils.isArray(this._type); }
-    isPrimitive() { return PropertyTypes_1.PropertyTypeUtils.isPrimitive(this._type); }
-    isStruct() { return PropertyTypes_1.PropertyTypeUtils.isStruct(this._type); }
-    isEnumeration() { return PropertyTypes_1.PropertyTypeUtils.isEnumeration(this._type); }
-    isNavigation() { return PropertyTypes_1.PropertyTypeUtils.isNavigation(this._type); }
-    get name() { return this._name.name; }
-    get class() { return this._class; }
-    get label() { return this._label; }
-    get description() { return this._description; }
-    get isReadOnly() { return this._isReadOnly || false; }
-    get priority() { return this._priority || 0; }
-    get category() { return this._category; }
-    get kindOfQuantity() { return this._kindOfQuantity; }
-    get propertyType() { return this._type; }
-    get customAttributes() { return this._customAttributes; }
-    /** Returns the name in the format 'ClassName.PropertyName'. */
-    get fullName() { return `${this._class.name}.${this.name}`; }
-    /** Returns the schema of the class holding the property. */
-    get schema() { return this._class.schema; }
-    getCategorySync() {
-        if (!this._category)
-            return undefined;
-        return this.class.schema.lookupItemSync(this._category);
-    }
-    getKindOfQuantitySync() {
-        if (!this._kindOfQuantity)
-            return undefined;
-        return this.class.schema.lookupItemSync(this._kindOfQuantity);
-    }
-    /**
-     * Save this Property's properties to an object for serializing to JSON.
-     */
-    toJSON() {
-        const schemaJson = {};
-        schemaJson.name = this.name;
-        schemaJson.type = (0, PropertyTypes_1.propertyTypeToString)(this._type);
-        if (this.description !== undefined)
-            schemaJson.description = this.description;
-        if (this.label !== undefined)
-            schemaJson.label = this.label;
-        if (this._isReadOnly !== undefined)
-            schemaJson.isReadOnly = this._isReadOnly;
-        if (this.category !== undefined)
-            schemaJson.category = this.category.fullName; // needs to be fully qualified name
-        if (this._priority !== undefined)
-            schemaJson.priority = this._priority;
-        if (this.kindOfQuantity !== undefined)
-            schemaJson.kindOfQuantity = this.kindOfQuantity.fullName;
-        const customAttributes = (0, CustomAttribute_1.serializeCustomAttributes)(this.customAttributes);
-        if (customAttributes !== undefined)
-            schemaJson.customAttributes = customAttributes;
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const propType = `EC${(0, PropertyTypes_1.propertyTypeToString)(this._type)}`.replace("Primitive", "");
-        const itemElement = schemaXml.createElement(propType);
-        itemElement.setAttribute("propertyName", this.name);
-        if (undefined !== this.description)
-            itemElement.setAttribute("description", this.description);
-        if (undefined !== this.label)
-            itemElement.setAttribute("displayLabel", this.label);
-        if (undefined !== this.isReadOnly)
-            itemElement.setAttribute("readOnly", String(this.isReadOnly));
-        if (undefined !== this.category) {
-            const category = await this.category;
-            const categoryName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, category.schema, category.name);
-            itemElement.setAttribute("category", categoryName);
-        }
-        if (undefined !== this.priority)
-            itemElement.setAttribute("priority", this.priority.toString());
-        if (undefined !== this.kindOfQuantity) {
-            const kindOfQuantity = await this.kindOfQuantity;
-            const kindOfQuantityName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, kindOfQuantity.schema, kindOfQuantity.name);
-            itemElement.setAttribute("kindOfQuantity", kindOfQuantityName);
-        }
-        if (this._customAttributes) {
-            const caContainerElement = schemaXml.createElement("ECCustomAttributes");
-            for (const [name, attribute] of this._customAttributes) {
-                const caElement = await XmlSerializationUtils_1.XmlSerializationUtils.writeCustomAttribute(name, attribute, schemaXml, this.schema);
-                caContainerElement.appendChild(caElement);
-            }
-            itemElement.appendChild(caContainerElement);
-        }
-        return itemElement;
-    }
-    fromJSONSync(propertyProps) {
-        if (undefined !== propertyProps.label) {
-            this._label = propertyProps.label;
-        }
-        if (undefined !== propertyProps.description) {
-            this._description = propertyProps.description;
-        }
-        if (undefined !== propertyProps.priority) {
-            this._priority = propertyProps.priority;
-        }
-        if (undefined !== propertyProps.isReadOnly) {
-            this._isReadOnly = propertyProps.isReadOnly;
-        }
-        if (undefined !== propertyProps.category) {
-            const propertyCategorySchemaItemKey = this.class.schema.getSchemaItemKey(propertyProps.category);
-            if (!propertyCategorySchemaItemKey)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Property ${this.name} has a 'category' ("${propertyProps.category}") that cannot be found.`);
-            this._category = new DelayedPromise_1.DelayedPromiseWithProps(propertyCategorySchemaItemKey, async () => {
-                const category = await this.class.schema.lookupItem(propertyCategorySchemaItemKey);
-                if (undefined === category)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Property ${this.name} has a 'category' ("${propertyProps.category}") that cannot be found.`);
-                return category;
-            });
-        }
-        if (undefined !== propertyProps.kindOfQuantity) {
-            const koqSchemaItemKey = this.class.schema.getSchemaItemKey(propertyProps.kindOfQuantity);
-            if (!koqSchemaItemKey)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Property ${this.name} has a 'kindOfQuantity' ("${propertyProps.kindOfQuantity}") that cannot be found.`);
-            this._kindOfQuantity = new DelayedPromise_1.DelayedPromiseWithProps(koqSchemaItemKey, async () => {
-                const koq = await this.class.schema.lookupItem(koqSchemaItemKey);
-                if (undefined === koq)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Property ${this.name} has a 'kindOfQuantity' ("${propertyProps.kindOfQuantity}") that cannot be found.`);
-                return koq;
-            });
-        }
-    }
-    async fromJSON(propertyProps) {
-        this.fromJSONSync(propertyProps);
-    }
-    addCustomAttribute(customAttribute) {
-        if (!this._customAttributes)
-            this._customAttributes = new Map();
-        this._customAttributes.set(customAttribute.className, customAttribute);
-    }
-    /**
-     * Retrieve all custom attributes in the current property and its base
-     * This is the async version of getCustomAttributesSync()
-     */
-    async getCustomAttributes() {
-        return this.getCustomAttributesSync();
-    }
-    /**
-     * Retrieve all custom attributes in the current property and its base.
-     */
-    getCustomAttributesSync() {
-        let customAttributes = this._customAttributes;
-        if (undefined === customAttributes) {
-            customAttributes = new Map();
-        }
-        const baseProperty = this.class.getInheritedPropertySync(this.name);
-        let baseCustomAttributes;
-        if (undefined !== baseProperty)
-            baseCustomAttributes = baseProperty.getCustomAttributesSync();
-        if (undefined !== baseCustomAttributes) {
-            customAttributes = new Map([...baseCustomAttributes, ...customAttributes]);
-        }
-        return customAttributes;
-    }
-    /**
-     * @internal
-     */
-    static isProperty(object) {
-        const property = object;
-        return property !== undefined && property.class !== undefined && property.name !== undefined
-            && property.propertyType !== undefined;
-    }
-}
-exports.Property = Property;
-/** @beta */
-class PrimitiveOrEnumPropertyBase extends Property {
-    constructor(ecClass, name, type) {
-        super(ecClass, name, type);
-    }
-    get extendedTypeName() { return this._extendedTypeName; }
-    get minLength() { return this._minLength; }
-    get maxLength() { return this._maxLength; }
-    get minValue() { return this._minValue; }
-    get maxValue() { return this._maxValue; }
-    /**
-     * Save this PrimitiveOrEnumPropertyBase's properties to an object for serializing to JSON.
-     */
-    toJSON() {
-        const schemaJson = super.toJSON();
-        if (this.extendedTypeName !== undefined)
-            schemaJson.extendedTypeName = this.extendedTypeName;
-        if (this._minLength !== undefined)
-            schemaJson.minLength = this.minLength;
-        if (this._maxLength !== undefined)
-            schemaJson.maxLength = this.maxLength;
-        if (this._minValue !== undefined)
-            schemaJson.minValue = this.minValue;
-        if (this._maxValue !== undefined)
-            schemaJson.maxValue = this.maxValue;
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        if (undefined !== this.extendedTypeName)
-            itemElement.setAttribute("extendedTypeName", this.extendedTypeName);
-        if (undefined !== this.minValue)
-            itemElement.setAttribute("minimumValue", this.minValue.toString());
-        if (undefined !== this.maxValue)
-            itemElement.setAttribute("maximumValue", this.maxValue.toString());
-        if (undefined !== this.minLength)
-            itemElement.setAttribute("minimumLength", this.minLength.toString());
-        if (undefined !== this.maxLength)
-            itemElement.setAttribute("maximumLength", this.maxLength.toString());
-        return itemElement;
-    }
-    fromJSONSync(propertyBaseProps) {
-        super.fromJSONSync(propertyBaseProps);
-        if (undefined !== propertyBaseProps.minLength) {
-            this._minLength = propertyBaseProps.minLength;
-        }
-        if (undefined !== propertyBaseProps.maxLength) {
-            this._maxLength = propertyBaseProps.maxLength;
-        }
-        if (undefined !== propertyBaseProps.minValue) {
-            this._minValue = propertyBaseProps.minValue;
-        }
-        if (undefined !== propertyBaseProps.maxValue) {
-            this._maxValue = propertyBaseProps.maxValue;
-        }
-        if (undefined !== propertyBaseProps.extendedTypeName) {
-            this._extendedTypeName = propertyBaseProps.extendedTypeName;
-        }
-    }
-    async fromJSON(propertyBaseProps) {
-        this.fromJSONSync(propertyBaseProps);
-    }
-}
-exports.PrimitiveOrEnumPropertyBase = PrimitiveOrEnumPropertyBase;
-/** @beta */
-class PrimitiveProperty extends PrimitiveOrEnumPropertyBase {
-    get primitiveType() { return PropertyTypes_1.PropertyTypeUtils.getPrimitiveType(this._type); }
-    constructor(ecClass, name, primitiveType = ECObjects_1.PrimitiveType.Integer) {
-        super(ecClass, name, PropertyTypes_1.PropertyTypeUtils.fromPrimitiveType(primitiveType));
-    }
-    fromJSONSync(primitivePropertyProps) {
-        super.fromJSONSync(primitivePropertyProps);
-        if (undefined !== primitivePropertyProps.typeName) {
-            if (this.primitiveType !== (0, ECObjects_1.parsePrimitiveType)(primitivePropertyProps.typeName))
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
-        }
-    }
-    async fromJSON(primitivePropertyProps) {
-        this.fromJSONSync(primitivePropertyProps);
-    }
-    /**
-     * Save this PrimitiveProperty's properties to an object for serializing to JSON.
-     */
-    toJSON() {
-        const schemaJson = super.toJSON();
-        schemaJson.typeName = (0, ECObjects_1.primitiveTypeToString)(this.primitiveType);
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        itemElement.setAttribute("typeName", (0, ECObjects_1.primitiveTypeToString)(this.primitiveType));
-        return itemElement;
-    }
-}
-exports.PrimitiveProperty = PrimitiveProperty;
-/** @beta */
-class EnumerationProperty extends PrimitiveOrEnumPropertyBase {
-    constructor(ecClass, name, type) {
-        // TODO: Should we allow specifying the backing type?
-        super(ecClass, name, PropertyTypes_1.PropertyType.Integer_Enumeration);
-        this._enumeration = type;
-    }
-    get enumeration() { return this._enumeration; }
-    /**
-     * Save this EnumerationProperty's properties to an object for serializing to JSON.
-     */
-    toJSON() {
-        const schemaJson = super.toJSON();
-        schemaJson.typeName = this.enumeration.fullName;
-        return schemaJson;
-    }
-    fromJSONSync(enumerationPropertyProps) {
-        super.fromJSONSync(enumerationPropertyProps);
-        if (undefined !== enumerationPropertyProps.typeName) {
-            if (!(this.enumeration.fullName).match(enumerationPropertyProps.typeName)) // need to match {schema}.{version}.{itemName} on typeName
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
-            const enumSchemaItemKey = this.class.schema.getSchemaItemKey(this.enumeration.fullName);
-            if (!enumSchemaItemKey)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the enumeration ${enumerationPropertyProps.typeName}.`);
-            this._enumeration = new DelayedPromise_1.DelayedPromiseWithProps(enumSchemaItemKey, async () => {
-                const enumeration = await this.class.schema.lookupItem(enumSchemaItemKey);
-                if (undefined === enumeration)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the enumeration ${enumerationPropertyProps.typeName}.`);
-                return enumeration;
-            });
-        }
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        const enumeration = await this.enumeration;
-        const enumerationName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, enumeration.schema, enumeration.name);
-        itemElement.setAttribute("typeName", enumerationName);
-        return itemElement;
-    }
-    async fromJSON(enumerationPropertyProps) {
-        this.fromJSONSync(enumerationPropertyProps);
-    }
-}
-exports.EnumerationProperty = EnumerationProperty;
-/** @beta */
-class StructProperty extends Property {
-    constructor(ecClass, name, type) {
-        super(ecClass, name, PropertyTypes_1.PropertyType.Struct);
-        this._structClass = type;
-    }
-    get structClass() { return this._structClass; }
-    /**
-     * Save this StructProperty's properties to an object for serializing to JSON.
-     */
-    toJSON() {
-        const schemaJson = super.toJSON();
-        schemaJson.typeName = this.structClass.fullName;
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        const structClassName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, this.structClass.schema, this.structClass.name);
-        itemElement.setAttribute("typeName", structClassName);
-        return itemElement;
-    }
-    fromJSONSync(structPropertyProps) {
-        super.fromJSONSync(structPropertyProps);
-        if (undefined !== structPropertyProps.typeName) {
-            if (!this.structClass.key.matchesFullName(structPropertyProps.typeName))
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
-        }
-    }
-    async fromJSON(structPropertyProps) {
-        this.fromJSONSync(structPropertyProps);
-    }
-}
-exports.StructProperty = StructProperty;
-/** @beta */
-class NavigationProperty extends Property {
-    constructor(ecClass, name, relationship, direction) {
-        super(ecClass, name, PropertyTypes_1.PropertyType.Navigation);
-        this._relationshipClass = relationship;
-        this._direction = (direction !== undefined) ? direction : ECObjects_1.StrengthDirection.Forward;
-    }
-    get relationshipClass() { return this._relationshipClass; }
-    getRelationshipClassSync() {
-        if (!this._relationshipClass) // eslint-disable-line @typescript-eslint/no-misused-promises
-            return undefined;
-        return this.class.schema.lookupItemSync(this._relationshipClass);
-    }
-    get direction() { return this._direction; }
-    /**
-     * Save this NavigationProperty's properties to an object for serializing to JSON.
-     */
-    toJSON() {
-        const schemaJson = super.toJSON();
-        schemaJson.relationshipName = this.relationshipClass.fullName;
-        schemaJson.direction = (0, ECObjects_1.strengthDirectionToString)(this.direction);
-        return schemaJson;
-    }
-    /** @internal */
-    async toXml(schemaXml) {
-        const itemElement = await super.toXml(schemaXml);
-        const relationshipClass = await this.relationshipClass;
-        const relationshipClassName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, relationshipClass.schema, relationshipClass.name);
-        itemElement.setAttribute("relationshipName", relationshipClassName);
-        itemElement.setAttribute("direction", (0, ECObjects_1.strengthDirectionToString)(this.direction));
-        return itemElement;
-    }
-}
-exports.NavigationProperty = NavigationProperty;
-// TODO: Consolidate all of the INT32_MAX variables.
-const INT32_MAX = 2147483647;
-/** @beta */
-class ArrayProperty extends Property {
-    constructor() {
-        super(...arguments);
-        this._minOccurs = 0;
-        this._maxOccurs = INT32_MAX;
-    }
-    get minOccurs() { return this._minOccurs; }
-    get maxOccurs() { return this._maxOccurs; }
-}
-exports.ArrayProperty = ArrayProperty;
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const ArrayPropertyMixin = (Base) => {
-    return class extends Base {
-        constructor(...args) {
-            super(...args);
-            this._minOccurs = 0;
-            this._maxOccurs = INT32_MAX;
-            this._type = PropertyTypes_1.PropertyTypeUtils.asArray(this._type);
-        }
-        get minOccurs() { return this._minOccurs; }
-        get maxOccurs() { return this._maxOccurs; }
-        fromJSONSync(arrayPropertyProps) {
-            super.fromJSONSync(arrayPropertyProps);
-            if (undefined !== arrayPropertyProps.minOccurs) {
-                this._minOccurs = arrayPropertyProps.minOccurs;
-            }
-            if (undefined !== arrayPropertyProps.maxOccurs) {
-                this._maxOccurs = arrayPropertyProps.maxOccurs;
-            }
-        }
-        async fromJSON(arrayPropertyProps) {
-            this.fromJSONSync(arrayPropertyProps);
-        }
-        /**
-         * Save this ArrayProperty's properties to an object for serializing to JSON.
-         */
-        toJSON() {
-            const schemaJson = super.toJSON();
-            schemaJson.minOccurs = this.minOccurs;
-            if (this.maxOccurs !== undefined)
-                schemaJson.maxOccurs = this.maxOccurs;
-            return schemaJson;
-        }
-        /** @internal */
-        async toXml(schemaXml) {
-            const itemElement = await super.toXml(schemaXml);
-            itemElement.setAttribute("minOccurs", this.minOccurs.toString());
-            if (this.maxOccurs)
-                itemElement.setAttribute("maxOccurs", this.maxOccurs.toString());
-            return itemElement;
-        }
-    };
-};
-/** @beta */
-class PrimitiveArrayProperty extends ArrayPropertyMixin(PrimitiveProperty) {
-    constructor(ecClass, name, primitiveType = ECObjects_1.PrimitiveType.Integer) {
-        super(ecClass, name, primitiveType);
-    }
-    /**
-     * Save this PrimitiveArrayProperty's properties to an object for serializing to JSON.
-     */
-    toJSON() {
-        return super.toJSON();
-    }
-}
-exports.PrimitiveArrayProperty = PrimitiveArrayProperty;
-/** @beta */
-class EnumerationArrayProperty extends ArrayPropertyMixin(EnumerationProperty) {
-    constructor(ecClass, name, type) {
-        super(ecClass, name, type);
-    }
-}
-exports.EnumerationArrayProperty = EnumerationArrayProperty;
-/** @beta */
-class StructArrayProperty extends ArrayPropertyMixin(StructProperty) {
-    constructor(ecClass, name, type) {
-        super(ecClass, name, type);
-    }
-}
-exports.StructArrayProperty = StructArrayProperty;
-/**
- * Hackish approach that works like a "friend class" so we can access protected members without making them public.
- * @internal
- */
-class MutableProperty extends Property {
-}
-exports.MutableProperty = MutableProperty;
+"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.MutableProperty = exports.StructArrayProperty = exports.EnumerationArrayProperty = exports.PrimitiveArrayProperty = exports.ArrayProperty = exports.NavigationProperty = exports.StructProperty = exports.EnumerationProperty = exports.PrimitiveProperty = exports.PrimitiveOrEnumPropertyBase = exports.Property = void 0;
+const DelayedPromise_1 = require("../DelayedPromise");
+const XmlSerializationUtils_1 = require("../Deserialization/XmlSerializationUtils");
+const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
+const PropertyTypes_1 = require("../PropertyTypes");
+const ECName_1 = require("../ECName");
+const CustomAttribute_1 = require("./CustomAttribute");
+/**
+ * A common abstract class for all ECProperty types.
+ * @beta
+ */
+class Property {
+    constructor(ecClass, name, type) {
+        this._class = ecClass;
+        this._name = new ECName_1.ECName(name);
+        this._type = type;
+    }
+    isArray() { return PropertyTypes_1.PropertyTypeUtils.isArray(this._type); }
+    isPrimitive() { return PropertyTypes_1.PropertyTypeUtils.isPrimitive(this._type); }
+    isStruct() { return PropertyTypes_1.PropertyTypeUtils.isStruct(this._type); }
+    isEnumeration() { return PropertyTypes_1.PropertyTypeUtils.isEnumeration(this._type); }
+    isNavigation() { return PropertyTypes_1.PropertyTypeUtils.isNavigation(this._type); }
+    get name() { return this._name.name; }
+    get class() { return this._class; }
+    get label() { return this._label; }
+    get description() { return this._description; }
+    get isReadOnly() { return this._isReadOnly || false; }
+    get priority() { return this._priority || 0; }
+    get category() { return this._category; }
+    get kindOfQuantity() { return this._kindOfQuantity; }
+    get propertyType() { return this._type; }
+    get customAttributes() { return this._customAttributes; }
+    /** Returns the name in the format 'ClassName.PropertyName'. */
+    get fullName() { return `${this._class.name}.${this.name}`; }
+    /** Returns the schema of the class holding the property. */
+    get schema() { return this._class.schema; }
+    getCategorySync() {
+        if (!this._category)
+            return undefined;
+        return this.class.schema.lookupItemSync(this._category);
+    }
+    getKindOfQuantitySync() {
+        if (!this._kindOfQuantity)
+            return undefined;
+        return this.class.schema.lookupItemSync(this._kindOfQuantity);
+    }
+    /**
+     * Save this Property's properties to an object for serializing to JSON.
+     */
+    toJSON() {
+        const schemaJson = {};
+        schemaJson.name = this.name;
+        schemaJson.type = (0, PropertyTypes_1.propertyTypeToString)(this._type);
+        if (this.description !== undefined)
+            schemaJson.description = this.description;
+        if (this.label !== undefined)
+            schemaJson.label = this.label;
+        if (this._isReadOnly !== undefined)
+            schemaJson.isReadOnly = this._isReadOnly;
+        if (this.category !== undefined)
+            schemaJson.category = this.category.fullName; // needs to be fully qualified name
+        if (this._priority !== undefined)
+            schemaJson.priority = this._priority;
+        if (this.kindOfQuantity !== undefined)
+            schemaJson.kindOfQuantity = this.kindOfQuantity.fullName;
+        const customAttributes = (0, CustomAttribute_1.serializeCustomAttributes)(this.customAttributes);
+        if (customAttributes !== undefined)
+            schemaJson.customAttributes = customAttributes;
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const propType = `EC${(0, PropertyTypes_1.propertyTypeToString)(this._type)}`.replace("Primitive", "");
+        const itemElement = schemaXml.createElement(propType);
+        itemElement.setAttribute("propertyName", this.name);
+        if (undefined !== this.description)
+            itemElement.setAttribute("description", this.description);
+        if (undefined !== this.label)
+            itemElement.setAttribute("displayLabel", this.label);
+        if (undefined !== this.isReadOnly)
+            itemElement.setAttribute("readOnly", String(this.isReadOnly));
+        if (undefined !== this.category) {
+            const category = await this.category;
+            const categoryName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, category.schema, category.name);
+            itemElement.setAttribute("category", categoryName);
+        }
+        if (undefined !== this.priority)
+            itemElement.setAttribute("priority", this.priority.toString());
+        if (undefined !== this.kindOfQuantity) {
+            const kindOfQuantity = await this.kindOfQuantity;
+            const kindOfQuantityName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, kindOfQuantity.schema, kindOfQuantity.name);
+            itemElement.setAttribute("kindOfQuantity", kindOfQuantityName);
+        }
+        if (this._customAttributes) {
+            const caContainerElement = schemaXml.createElement("ECCustomAttributes");
+            for (const [name, attribute] of this._customAttributes) {
+                const caElement = await XmlSerializationUtils_1.XmlSerializationUtils.writeCustomAttribute(name, attribute, schemaXml, this.schema);
+                caContainerElement.appendChild(caElement);
+            }
+            itemElement.appendChild(caContainerElement);
+        }
+        return itemElement;
+    }
+    fromJSONSync(propertyProps) {
+        if (undefined !== propertyProps.label) {
+            this._label = propertyProps.label;
+        }
+        if (undefined !== propertyProps.description) {
+            this._description = propertyProps.description;
+        }
+        if (undefined !== propertyProps.priority) {
+            this._priority = propertyProps.priority;
+        }
+        if (undefined !== propertyProps.isReadOnly) {
+            this._isReadOnly = propertyProps.isReadOnly;
+        }
+        if (undefined !== propertyProps.category) {
+            const propertyCategorySchemaItemKey = this.class.schema.getSchemaItemKey(propertyProps.category);
+            if (!propertyCategorySchemaItemKey)
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Property ${this.name} has a 'category' ("${propertyProps.category}") that cannot be found.`);
+            this._category = new DelayedPromise_1.DelayedPromiseWithProps(propertyCategorySchemaItemKey, async () => {
+                const category = await this.class.schema.lookupItem(propertyCategorySchemaItemKey);
+                if (undefined === category)
+                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Property ${this.name} has a 'category' ("${propertyProps.category}") that cannot be found.`);
+                return category;
+            });
+        }
+        if (undefined !== propertyProps.kindOfQuantity) {
+            const koqSchemaItemKey = this.class.schema.getSchemaItemKey(propertyProps.kindOfQuantity);
+            if (!koqSchemaItemKey)
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Property ${this.name} has a 'kindOfQuantity' ("${propertyProps.kindOfQuantity}") that cannot be found.`);
+            this._kindOfQuantity = new DelayedPromise_1.DelayedPromiseWithProps(koqSchemaItemKey, async () => {
+                const koq = await this.class.schema.lookupItem(koqSchemaItemKey);
+                if (undefined === koq)
+                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `The Property ${this.name} has a 'kindOfQuantity' ("${propertyProps.kindOfQuantity}") that cannot be found.`);
+                return koq;
+            });
+        }
+    }
+    async fromJSON(propertyProps) {
+        this.fromJSONSync(propertyProps);
+    }
+    addCustomAttribute(customAttribute) {
+        if (!this._customAttributes)
+            this._customAttributes = new Map();
+        this._customAttributes.set(customAttribute.className, customAttribute);
+    }
+    /**
+     * Retrieve all custom attributes in the current property and its base
+     * This is the async version of getCustomAttributesSync()
+     */
+    async getCustomAttributes() {
+        return this.getCustomAttributesSync();
+    }
+    /**
+     * Retrieve all custom attributes in the current property and its base.
+     */
+    getCustomAttributesSync() {
+        let customAttributes = this._customAttributes;
+        if (undefined === customAttributes) {
+            customAttributes = new Map();
+        }
+        const baseProperty = this.class.getInheritedPropertySync(this.name);
+        let baseCustomAttributes;
+        if (undefined !== baseProperty)
+            baseCustomAttributes = baseProperty.getCustomAttributesSync();
+        if (undefined !== baseCustomAttributes) {
+            customAttributes = new Map([...baseCustomAttributes, ...customAttributes]);
+        }
+        return customAttributes;
+    }
+    /**
+     * @internal
+     */
+    static isProperty(object) {
+        const property = object;
+        return property !== undefined && property.class !== undefined && property.name !== undefined
+            && property.propertyType !== undefined;
+    }
+}
+exports.Property = Property;
+/** @beta */
+class PrimitiveOrEnumPropertyBase extends Property {
+    constructor(ecClass, name, type) {
+        super(ecClass, name, type);
+    }
+    get extendedTypeName() { return this._extendedTypeName; }
+    get minLength() { return this._minLength; }
+    get maxLength() { return this._maxLength; }
+    get minValue() { return this._minValue; }
+    get maxValue() { return this._maxValue; }
+    /**
+     * Save this PrimitiveOrEnumPropertyBase's properties to an object for serializing to JSON.
+     */
+    toJSON() {
+        const schemaJson = super.toJSON();
+        if (this.extendedTypeName !== undefined)
+            schemaJson.extendedTypeName = this.extendedTypeName;
+        if (this._minLength !== undefined)
+            schemaJson.minLength = this.minLength;
+        if (this._maxLength !== undefined)
+            schemaJson.maxLength = this.maxLength;
+        if (this._minValue !== undefined)
+            schemaJson.minValue = this.minValue;
+        if (this._maxValue !== undefined)
+            schemaJson.maxValue = this.maxValue;
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        if (undefined !== this.extendedTypeName)
+            itemElement.setAttribute("extendedTypeName", this.extendedTypeName);
+        if (undefined !== this.minValue)
+            itemElement.setAttribute("minimumValue", this.minValue.toString());
+        if (undefined !== this.maxValue)
+            itemElement.setAttribute("maximumValue", this.maxValue.toString());
+        if (undefined !== this.minLength)
+            itemElement.setAttribute("minimumLength", this.minLength.toString());
+        if (undefined !== this.maxLength)
+            itemElement.setAttribute("maximumLength", this.maxLength.toString());
+        return itemElement;
+    }
+    fromJSONSync(propertyBaseProps) {
+        super.fromJSONSync(propertyBaseProps);
+        if (undefined !== propertyBaseProps.minLength) {
+            this._minLength = propertyBaseProps.minLength;
+        }
+        if (undefined !== propertyBaseProps.maxLength) {
+            this._maxLength = propertyBaseProps.maxLength;
+        }
+        if (undefined !== propertyBaseProps.minValue) {
+            this._minValue = propertyBaseProps.minValue;
+        }
+        if (undefined !== propertyBaseProps.maxValue) {
+            this._maxValue = propertyBaseProps.maxValue;
+        }
+        if (undefined !== propertyBaseProps.extendedTypeName) {
+            this._extendedTypeName = propertyBaseProps.extendedTypeName;
+        }
+    }
+    async fromJSON(propertyBaseProps) {
+        this.fromJSONSync(propertyBaseProps);
+    }
+}
+exports.PrimitiveOrEnumPropertyBase = PrimitiveOrEnumPropertyBase;
+/** @beta */
+class PrimitiveProperty extends PrimitiveOrEnumPropertyBase {
+    get primitiveType() { return PropertyTypes_1.PropertyTypeUtils.getPrimitiveType(this._type); }
+    constructor(ecClass, name, primitiveType = ECObjects_1.PrimitiveType.Integer) {
+        super(ecClass, name, PropertyTypes_1.PropertyTypeUtils.fromPrimitiveType(primitiveType));
+    }
+    fromJSONSync(primitivePropertyProps) {
+        super.fromJSONSync(primitivePropertyProps);
+        if (undefined !== primitivePropertyProps.typeName) {
+            if (this.primitiveType !== (0, ECObjects_1.parsePrimitiveType)(primitivePropertyProps.typeName))
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
+        }
+    }
+    async fromJSON(primitivePropertyProps) {
+        this.fromJSONSync(primitivePropertyProps);
+    }
+    /**
+     * Save this PrimitiveProperty's properties to an object for serializing to JSON.
+     */
+    toJSON() {
+        const schemaJson = super.toJSON();
+        schemaJson.typeName = (0, ECObjects_1.primitiveTypeToString)(this.primitiveType);
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        itemElement.setAttribute("typeName", (0, ECObjects_1.primitiveTypeToString)(this.primitiveType));
+        return itemElement;
+    }
+}
+exports.PrimitiveProperty = PrimitiveProperty;
+/** @beta */
+class EnumerationProperty extends PrimitiveOrEnumPropertyBase {
+    constructor(ecClass, name, type) {
+        // TODO: Should we allow specifying the backing type?
+        super(ecClass, name, PropertyTypes_1.PropertyType.Integer_Enumeration);
+        this._enumeration = type;
+    }
+    get enumeration() { return this._enumeration; }
+    /**
+     * Save this EnumerationProperty's properties to an object for serializing to JSON.
+     */
+    toJSON() {
+        const schemaJson = super.toJSON();
+        schemaJson.typeName = this.enumeration.fullName;
+        return schemaJson;
+    }
+    fromJSONSync(enumerationPropertyProps) {
+        super.fromJSONSync(enumerationPropertyProps);
+        if (undefined !== enumerationPropertyProps.typeName) {
+            if (!(this.enumeration.fullName).match(enumerationPropertyProps.typeName)) // need to match {schema}.{version}.{itemName} on typeName
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
+            const enumSchemaItemKey = this.class.schema.getSchemaItemKey(this.enumeration.fullName);
+            if (!enumSchemaItemKey)
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the enumeration ${enumerationPropertyProps.typeName}.`);
+            this._enumeration = new DelayedPromise_1.DelayedPromiseWithProps(enumSchemaItemKey, async () => {
+                const enumeration = await this.class.schema.lookupItem(enumSchemaItemKey);
+                if (undefined === enumeration)
+                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the enumeration ${enumerationPropertyProps.typeName}.`);
+                return enumeration;
+            });
+        }
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        const enumeration = await this.enumeration;
+        const enumerationName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, enumeration.schema, enumeration.name);
+        itemElement.setAttribute("typeName", enumerationName);
+        return itemElement;
+    }
+    async fromJSON(enumerationPropertyProps) {
+        this.fromJSONSync(enumerationPropertyProps);
+    }
+}
+exports.EnumerationProperty = EnumerationProperty;
+/** @beta */
+class StructProperty extends Property {
+    constructor(ecClass, name, type) {
+        super(ecClass, name, PropertyTypes_1.PropertyType.Struct);
+        this._structClass = type;
+    }
+    get structClass() { return this._structClass; }
+    /**
+     * Save this StructProperty's properties to an object for serializing to JSON.
+     */
+    toJSON() {
+        const schemaJson = super.toJSON();
+        schemaJson.typeName = this.structClass.fullName;
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        const structClassName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, this.structClass.schema, this.structClass.name);
+        itemElement.setAttribute("typeName", structClassName);
+        return itemElement;
+    }
+    fromJSONSync(structPropertyProps) {
+        super.fromJSONSync(structPropertyProps);
+        if (undefined !== structPropertyProps.typeName) {
+            if (!this.structClass.key.matchesFullName(structPropertyProps.typeName))
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
+        }
+    }
+    async fromJSON(structPropertyProps) {
+        this.fromJSONSync(structPropertyProps);
+    }
+}
+exports.StructProperty = StructProperty;
+/** @beta */
+class NavigationProperty extends Property {
+    constructor(ecClass, name, relationship, direction) {
+        super(ecClass, name, PropertyTypes_1.PropertyType.Navigation);
+        this._relationshipClass = relationship;
+        this._direction = (direction !== undefined) ? direction : ECObjects_1.StrengthDirection.Forward;
+    }
+    get relationshipClass() { return this._relationshipClass; }
+    getRelationshipClassSync() {
+        if (!this._relationshipClass) // eslint-disable-line @typescript-eslint/no-misused-promises
+            return undefined;
+        return this.class.schema.lookupItemSync(this._relationshipClass);
+    }
+    get direction() { return this._direction; }
+    /**
+     * Save this NavigationProperty's properties to an object for serializing to JSON.
+     */
+    toJSON() {
+        const schemaJson = super.toJSON();
+        schemaJson.relationshipName = this.relationshipClass.fullName;
+        schemaJson.direction = (0, ECObjects_1.strengthDirectionToString)(this.direction);
+        return schemaJson;
+    }
+    /** @internal */
+    async toXml(schemaXml) {
+        const itemElement = await super.toXml(schemaXml);
+        const relationshipClass = await this.relationshipClass;
+        const relationshipClassName = XmlSerializationUtils_1.XmlSerializationUtils.createXmlTypedName(this.schema, relationshipClass.schema, relationshipClass.name);
+        itemElement.setAttribute("relationshipName", relationshipClassName);
+        itemElement.setAttribute("direction", (0, ECObjects_1.strengthDirectionToString)(this.direction));
+        return itemElement;
+    }
+}
+exports.NavigationProperty = NavigationProperty;
+// TODO: Consolidate all of the INT32_MAX variables.
+const INT32_MAX = 2147483647;
+/** @beta */
+class ArrayProperty extends Property {
+    constructor() {
+        super(...arguments);
+        this._minOccurs = 0;
+        this._maxOccurs = INT32_MAX;
+    }
+    get minOccurs() { return this._minOccurs; }
+    get maxOccurs() { return this._maxOccurs; }
+}
+exports.ArrayProperty = ArrayProperty;
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ArrayPropertyMixin = (Base) => {
+    return class extends Base {
+        constructor(...args) {
+            super(...args);
+            this._minOccurs = 0;
+            this._maxOccurs = INT32_MAX;
+            this._type = PropertyTypes_1.PropertyTypeUtils.asArray(this._type);
+        }
+        get minOccurs() { return this._minOccurs; }
+        get maxOccurs() { return this._maxOccurs; }
+        fromJSONSync(arrayPropertyProps) {
+            super.fromJSONSync(arrayPropertyProps);
+            if (undefined !== arrayPropertyProps.minOccurs) {
+                this._minOccurs = arrayPropertyProps.minOccurs;
+            }
+            if (undefined !== arrayPropertyProps.maxOccurs) {
+                this._maxOccurs = arrayPropertyProps.maxOccurs;
+            }
+        }
+        async fromJSON(arrayPropertyProps) {
+            this.fromJSONSync(arrayPropertyProps);
+        }
+        /**
+         * Save this ArrayProperty's properties to an object for serializing to JSON.
+         */
+        toJSON() {
+            const schemaJson = super.toJSON();
+            schemaJson.minOccurs = this.minOccurs;
+            if (this.maxOccurs !== undefined)
+                schemaJson.maxOccurs = this.maxOccurs;
+            return schemaJson;
+        }
+        /** @internal */
+        async toXml(schemaXml) {
+            const itemElement = await super.toXml(schemaXml);
+            itemElement.setAttribute("minOccurs", this.minOccurs.toString());
+            if (this.maxOccurs)
+                itemElement.setAttribute("maxOccurs", this.maxOccurs.toString());
+            return itemElement;
+        }
+    };
+};
+/** @beta */
+class PrimitiveArrayProperty extends ArrayPropertyMixin(PrimitiveProperty) {
+    constructor(ecClass, name, primitiveType = ECObjects_1.PrimitiveType.Integer) {
+        super(ecClass, name, primitiveType);
+    }
+    /**
+     * Save this PrimitiveArrayProperty's properties to an object for serializing to JSON.
+     */
+    toJSON() {
+        return super.toJSON();
+    }
+}
+exports.PrimitiveArrayProperty = PrimitiveArrayProperty;
+/** @beta */
+class EnumerationArrayProperty extends ArrayPropertyMixin(EnumerationProperty) {
+    constructor(ecClass, name, type) {
+        super(ecClass, name, type);
+    }
+}
+exports.EnumerationArrayProperty = EnumerationArrayProperty;
+/** @beta */
+class StructArrayProperty extends ArrayPropertyMixin(StructProperty) {
+    constructor(ecClass, name, type) {
+        super(ecClass, name, type);
+    }
+}
+exports.StructArrayProperty = StructArrayProperty;
+/**
+ * Hackish approach that works like a "friend class" so we can access protected members without making them public.
+ * @internal
+ */
+class MutableProperty extends Property {
+}
+exports.MutableProperty = MutableProperty;
 //# sourceMappingURL=Property.js.map