@itwin/ecschema-editing 5.0.0-dev.90 → 5.0.0-dev.93

package/lib/esm/Editing/Exception.js

@@ -0,0 +1,471 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Editing
+ */
+import { PrimitiveType, primitiveTypeToString, Property, SchemaItemKey } from "@itwin/ecschema-metadata";
+/** @alpha */
+export var ECEditingStatus;
+(function (ECEditingStatus) {
+    ECEditingStatus[ECEditingStatus["EC_EDITING_ERROR_BASE"] = 196608] = "EC_EDITING_ERROR_BASE";
+    ECEditingStatus[ECEditingStatus["Unknown"] = 0] = "Unknown";
+    ECEditingStatus[ECEditingStatus["RuleViolation"] = 196609] = "RuleViolation";
+    ECEditingStatus[ECEditingStatus["SchemaNotFound"] = 196610] = "SchemaNotFound";
+    ECEditingStatus[ECEditingStatus["SchemaItemNotFound"] = 196611] = "SchemaItemNotFound";
+    ECEditingStatus[ECEditingStatus["SchemaItemNotFoundInContext"] = 196612] = "SchemaItemNotFoundInContext";
+    ECEditingStatus[ECEditingStatus["PropertyAlreadyExists"] = 196613] = "PropertyAlreadyExists";
+    ECEditingStatus[ECEditingStatus["PropertyNotFound"] = 196614] = "PropertyNotFound";
+    ECEditingStatus[ECEditingStatus["InvalidPropertyType"] = 196615] = "InvalidPropertyType";
+    ECEditingStatus[ECEditingStatus["BaseClassIsNotElement"] = 196616] = "BaseClassIsNotElement";
+    ECEditingStatus[ECEditingStatus["BaseClassIsNotElementUniqueAspect"] = 196617] = "BaseClassIsNotElementUniqueAspect";
+    ECEditingStatus[ECEditingStatus["BaseClassIsNotElementMultiAspect"] = 196618] = "BaseClassIsNotElementMultiAspect";
+    ECEditingStatus[ECEditingStatus["SchemaItemNameNotSpecified"] = 196619] = "SchemaItemNameNotSpecified";
+    ECEditingStatus[ECEditingStatus["InvalidSchemaItemType"] = 196620] = "InvalidSchemaItemType";
+    ECEditingStatus[ECEditingStatus["SchemaItemNameAlreadyExists"] = 196621] = "SchemaItemNameAlreadyExists";
+    ECEditingStatus[ECEditingStatus["InvalidEnumeratorType"] = 196622] = "InvalidEnumeratorType";
+    ECEditingStatus[ECEditingStatus["InvalidBaseClass"] = 196623] = "InvalidBaseClass";
+    ECEditingStatus[ECEditingStatus["EnumeratorDoesNotExist"] = 196624] = "EnumeratorDoesNotExist";
+    ECEditingStatus[ECEditingStatus["InvalidECName"] = 196625] = "InvalidECName";
+    ECEditingStatus[ECEditingStatus["InvalidSchemaAlias"] = 196626] = "InvalidSchemaAlias";
+    ECEditingStatus[ECEditingStatus["InvalidFormatUnitsSpecified"] = 196627] = "InvalidFormatUnitsSpecified";
+    ECEditingStatus[ECEditingStatus["SchemaAliasAlreadyExists"] = 196628] = "SchemaAliasAlreadyExists";
+    // Outer Errors
+    ECEditingStatus[ECEditingStatus["CreateSchemaItemFailed"] = 196629] = "CreateSchemaItemFailed";
+    ECEditingStatus[ECEditingStatus["CreateSchemaItemFromProps"] = 196630] = "CreateSchemaItemFromProps";
+    ECEditingStatus[ECEditingStatus["CreateElement"] = 196631] = "CreateElement";
+    ECEditingStatus[ECEditingStatus["CreateElementUniqueAspect"] = 196632] = "CreateElementUniqueAspect";
+    ECEditingStatus[ECEditingStatus["CreateElementMultiAspect"] = 196633] = "CreateElementMultiAspect";
+    ECEditingStatus[ECEditingStatus["SetBaseClass"] = 196634] = "SetBaseClass";
+    ECEditingStatus[ECEditingStatus["SetSourceConstraint"] = 196635] = "SetSourceConstraint";
+    ECEditingStatus[ECEditingStatus["SetTargetConstraint"] = 196636] = "SetTargetConstraint";
+    ECEditingStatus[ECEditingStatus["AddConstraintClass"] = 196637] = "AddConstraintClass";
+    ECEditingStatus[ECEditingStatus["RemoveConstraintClass"] = 196638] = "RemoveConstraintClass";
+    ECEditingStatus[ECEditingStatus["SetAbstractConstraint"] = 196639] = "SetAbstractConstraint";
+    ECEditingStatus[ECEditingStatus["AddCustomAttributeToConstraint"] = 196640] = "AddCustomAttributeToConstraint";
+    ECEditingStatus[ECEditingStatus["AddCustomAttributeToProperty"] = 196641] = "AddCustomAttributeToProperty";
+    ECEditingStatus[ECEditingStatus["AddCustomAttributeToClass"] = 196642] = "AddCustomAttributeToClass";
+    ECEditingStatus[ECEditingStatus["CreateNavigationProperty"] = 196643] = "CreateNavigationProperty";
+    ECEditingStatus[ECEditingStatus["CreateNavigationPropertyFromProps"] = 196644] = "CreateNavigationPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["SetInvertsUnit"] = 196645] = "SetInvertsUnit";
+    ECEditingStatus[ECEditingStatus["SetUnitSystem"] = 196646] = "SetUnitSystem";
+    ECEditingStatus[ECEditingStatus["SetDescription"] = 196647] = "SetDescription";
+    ECEditingStatus[ECEditingStatus["SetLabel"] = 196648] = "SetLabel";
+    ECEditingStatus[ECEditingStatus["SetIsReadOnly"] = 196649] = "SetIsReadOnly";
+    ECEditingStatus[ECEditingStatus["SetPriority"] = 196650] = "SetPriority";
+    ECEditingStatus[ECEditingStatus["SetCategory"] = 196651] = "SetCategory";
+    ECEditingStatus[ECEditingStatus["SetKindOfQuantity"] = 196652] = "SetKindOfQuantity";
+    ECEditingStatus[ECEditingStatus["SetMinOccurs"] = 196653] = "SetMinOccurs";
+    ECEditingStatus[ECEditingStatus["SetMaxOccurs"] = 196654] = "SetMaxOccurs";
+    ECEditingStatus[ECEditingStatus["SetExtendedTypeName"] = 196655] = "SetExtendedTypeName";
+    ECEditingStatus[ECEditingStatus["SetMinLength"] = 196656] = "SetMinLength";
+    ECEditingStatus[ECEditingStatus["SetMaxLength"] = 196657] = "SetMaxLength";
+    ECEditingStatus[ECEditingStatus["SetMinValue"] = 196658] = "SetMinValue";
+    ECEditingStatus[ECEditingStatus["SetMaxValue"] = 196659] = "SetMaxValue";
+    ECEditingStatus[ECEditingStatus["SetPropertyName"] = 196660] = "SetPropertyName";
+    ECEditingStatus[ECEditingStatus["AddMixin"] = 196661] = "AddMixin";
+    ECEditingStatus[ECEditingStatus["AddEnumerator"] = 196662] = "AddEnumerator";
+    ECEditingStatus[ECEditingStatus["SetEnumeratorLabel"] = 196663] = "SetEnumeratorLabel";
+    ECEditingStatus[ECEditingStatus["SetEnumeratorDescription"] = 196664] = "SetEnumeratorDescription";
+    ECEditingStatus[ECEditingStatus["AddPresentationUnit"] = 196665] = "AddPresentationUnit";
+    ECEditingStatus[ECEditingStatus["AddPresentationOverride"] = 196666] = "AddPresentationOverride";
+    ECEditingStatus[ECEditingStatus["CreateFormatOverride"] = 196667] = "CreateFormatOverride";
+    ECEditingStatus[ECEditingStatus["SetPropertyCategoryPriority"] = 196668] = "SetPropertyCategoryPriority";
+    ECEditingStatus[ECEditingStatus["CreatePrimitiveProperty"] = 196669] = "CreatePrimitiveProperty";
+    ECEditingStatus[ECEditingStatus["CreatePrimitivePropertyFromProps"] = 196670] = "CreatePrimitivePropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreateEnumerationProperty"] = 196671] = "CreateEnumerationProperty";
+    ECEditingStatus[ECEditingStatus["CreateEnumerationPropertyFromProps"] = 196672] = "CreateEnumerationPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreatePrimitiveArrayProperty"] = 196673] = "CreatePrimitiveArrayProperty";
+    ECEditingStatus[ECEditingStatus["CreatePrimitiveArrayPropertyFromProps"] = 196674] = "CreatePrimitiveArrayPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreateEnumerationArrayProperty"] = 196675] = "CreateEnumerationArrayProperty";
+    ECEditingStatus[ECEditingStatus["CreateEnumerationArrayPropertyFromProps"] = 196676] = "CreateEnumerationArrayPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreateStructProperty"] = 196677] = "CreateStructProperty";
+    ECEditingStatus[ECEditingStatus["CreateStructPropertyFromProps"] = 196678] = "CreateStructPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreateStructArrayProperty"] = 196679] = "CreateStructArrayProperty";
+    ECEditingStatus[ECEditingStatus["CreateStructArrayPropertyFromProps"] = 196680] = "CreateStructArrayPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["DeleteProperty"] = 196681] = "DeleteProperty";
+    ECEditingStatus[ECEditingStatus["DeleteClass"] = 196682] = "DeleteClass";
+    ECEditingStatus[ECEditingStatus["SetClassName"] = 196683] = "SetClassName";
+    ECEditingStatus[ECEditingStatus["AddSchemaReference"] = 196684] = "AddSchemaReference";
+    ECEditingStatus[ECEditingStatus["SetSchemaVersion"] = 196685] = "SetSchemaVersion";
+    ECEditingStatus[ECEditingStatus["IncrementSchemaMinorVersion"] = 196686] = "IncrementSchemaMinorVersion";
+    ECEditingStatus[ECEditingStatus["SetSchemaAlias"] = 196687] = "SetSchemaAlias";
+})(ECEditingStatus || (ECEditingStatus = {}));
+/**
+ * Defines the possible property type names.
+ * @alpha
+ */
+export var PropertyTypeName;
+(function (PropertyTypeName) {
+    PropertyTypeName["ArrayProperty"] = "ArrayProperty";
+    PropertyTypeName["PrimitiveProperty"] = "PrimitiveProperty";
+    PropertyTypeName["EnumerationProperty"] = "EnumerationProperty";
+    PropertyTypeName["NavigationProperty"] = "NavigationProperty";
+    PropertyTypeName["StructProperty"] = "StructProperty";
+})(PropertyTypeName || (PropertyTypeName = {}));
+/**
+ * Defines the possible schema type identifiers.
+ * @alpha
+ */
+export var SchemaTypeIdentifiers;
+(function (SchemaTypeIdentifiers) {
+    SchemaTypeIdentifiers["SchemaIdentifier"] = "Schema";
+    SchemaTypeIdentifiers["SchemaItemIdentifier"] = "SchemaItem";
+    SchemaTypeIdentifiers["ClassIdentifier"] = "Class";
+    SchemaTypeIdentifiers["PropertyIdentifier"] = "Property";
+    SchemaTypeIdentifiers["EnumeratorIdentifier"] = "Enumerator";
+    SchemaTypeIdentifiers["CustomAttributeIdentifier"] = "CustomAttribute";
+    SchemaTypeIdentifiers["RelationshipConstraintIdentifier"] = "RelationshipConstraint";
+})(SchemaTypeIdentifiers || (SchemaTypeIdentifiers = {}));
+/**
+ * An ISchemaIdentifier implementation to identify Schemas
+ * @alpha
+ */
+export class SchemaId {
+    typeIdentifier = SchemaTypeIdentifiers.SchemaIdentifier;
+    name;
+    schemaKey;
+    constructor(schemaKey) {
+        this.name = schemaKey.name;
+        this.schemaKey = schemaKey;
+    }
+}
+/**
+ * An ISchemItemIdentifier implementation to identify SchemaItems
+ * @alpha
+ */
+export class SchemaItemId {
+    typeIdentifier;
+    name;
+    schemaKey;
+    schemaItemType;
+    schemaItemKey;
+    constructor(schemaItemType, schemaItemKeyOrName, schemaKey) {
+        if (typeof (schemaItemKeyOrName) === "string") {
+            if (!schemaKey)
+                throw new Error("schemaKey if required if the specified schemaItem the name of the schema item.");
+            this.schemaKey = schemaKey;
+            this.schemaItemKey = new SchemaItemKey(schemaItemKeyOrName, schemaKey);
+        }
+        else {
+            this.schemaKey = schemaItemKeyOrName.schemaKey;
+            this.schemaItemKey = schemaItemKeyOrName;
+        }
+        this.schemaItemType = schemaItemType;
+        this.name = this.schemaItemKey.fullName;
+        this.typeIdentifier = SchemaTypeIdentifiers.SchemaItemIdentifier;
+    }
+}
+/**
+ * An IClassIdentifier implementation to identify Class instances.
+ * @alpha
+ */
+export class ClassId extends SchemaItemId {
+    typeIdentifier = SchemaTypeIdentifiers.ClassIdentifier;
+    schemaItemType;
+    constructor(schemaItemType, schemaItemKeyOrName, schemaKey) {
+        super(schemaItemType, schemaItemKeyOrName, schemaKey);
+        this.schemaItemType = schemaItemType;
+    }
+}
+/**
+ * An IPropertyIdentifier implementation to identify Property instances.
+ * @alpha
+ */
+export class PropertyId {
+    typeIdentifier = SchemaTypeIdentifiers.PropertyIdentifier;
+    name;
+    fullName;
+    ecClass;
+    schemaKey;
+    typeName;
+    constructor(schemaItemType, classKey, property, typeName) {
+        this.name = property instanceof Property ? property.name : property;
+        this.fullName = property instanceof Property ? property.fullName : `${classKey.name}.${property}`;
+        this.ecClass = new ClassId(schemaItemType, classKey);
+        this.schemaKey = classKey.schemaKey;
+        this.typeName = typeName;
+    }
+}
+/**
+ * An IEnumeratorIdentifier implementation to identify Enumerator instances.
+ * @alpha
+ */
+export class EnumeratorId {
+    typeIdentifier = SchemaTypeIdentifiers.EnumeratorIdentifier;
+    enumeration;
+    enumerationType;
+    enumeratorType;
+    name;
+    schemaKey;
+    constructor(enumerator, enumeration) {
+        this.enumeration = enumeration.key;
+        this.enumerationType = enumeration.type ? primitiveTypeToString(enumeration.type) : "string";
+        this.enumeratorType = getEnumeratorType(enumeration ?? PrimitiveType.String, enumerator);
+        this.name = typeof (enumerator) === "string" ? enumerator : enumerator.name;
+        this.schemaKey = enumeration.schema.schemaKey;
+    }
+}
+/**
+ * An ICustomAttributeIdentifier implementation to identify CustomAttribute instances.
+ * @alpha
+ */
+export class CustomAttributeId {
+    typeIdentifier = SchemaTypeIdentifiers.CustomAttributeIdentifier;
+    name;
+    schemaKey;
+    containerFullName;
+    constructor(name, container) {
+        this.name = name;
+        this.schemaKey = container.schema.schemaKey;
+        this.containerFullName = container.fullName;
+    }
+}
+/**
+ * An IRelationshipConstraintIdentifier implementation to identify RelationshipConstraints.
+ * @alpha
+ */
+export class RelationshipConstraintId {
+    typeIdentifier = SchemaTypeIdentifiers.RelationshipConstraintIdentifier;
+    name;
+    relationshipKey;
+    schemaKey;
+    constructor(constraint) {
+        this.name = constraint.isSource ? "Source" : "Target";
+        this.relationshipKey = constraint.relationshipClass.key;
+        this.schemaKey = this.relationshipKey.schemaKey;
+    }
+}
+/**
+ * An exception class for the ecschema-editing API. Contains identifiers for schema types involved in the
+ * exception. An example being SchemaItemId which contains the name of the SchemaItem, SchemaItemKey, SchemaItemType, etc.
+ * Typically will contain an innerError of type SchemaEditingError containing the identifier of the schema item that
+ * caused the exception. The containing error instance will identify the method called (identified by the errorNumber)
+ * and the identifier of the schema item being modified/created.
+ * @alpha
+ */
+export class SchemaEditingError extends Error {
+    errorNumber;
+    identifier;
+    innerError;
+    _ruleViolations;
+    _schemaKey;
+    /**
+     * Constructs a new SchemaEditingError instance.
+     * @param errorNumber The unique ECEditingStatus code identifying the error.
+     * @param identifier The identifier instance containing information about the EC object involved with the exception.
+     * @param innerError The SchemaEditingError containing the identifier of the EC object that caused the initial exception.
+     * @param ruleViolations Will contain EC rule violations of type [[AnyDiagnostic]] for exceptions with the error code ECEditingStatus.RuleViolation.
+     * @param message Optional error message. Most messages on automatically generated by this class based on the ECEditingStatus code.
+     */
+    constructor(errorNumber, identifier, innerError, ruleViolations, message) {
+        super(message);
+        this.errorNumber = errorNumber;
+        this.identifier = identifier;
+        this.innerError = innerError;
+        this._ruleViolations = ruleViolations;
+        this._schemaKey = identifier.schemaKey,
+            this.generateMessage();
+    }
+    /**
+     * Gets the SchemaId instance.
+     * @throws Error if the identifier is not an instance of SchemaId.
+     */
+    get _schemaId() {
+        if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.SchemaIdentifier)
+            throw new Error("identifier is not a SchemaId.");
+        return this.identifier;
+    }
+    /**
+     * Gets the SchemaItemId instance.
+     * @throws Error if the identifier is not an instance of SchemaItemId.
+     */
+    get _schemaItemId() {
+        if (this.isSchemaItemIdentifier(this.identifier))
+            throw new Error("identifier is not a SchemaItemId.");
+        return this.identifier;
+    }
+    /**
+     * Gets the ClassId instance.
+     * @throws Error if the identifier is not an instance of ClassId.
+     */
+    get _classId() {
+        if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.ClassIdentifier)
+            throw new Error("identifier is not a ClassId.");
+        return this.identifier;
+    }
+    /**
+     * Gets the PropertyId instance.
+     * @throws Error if the identifier is not an instance of PropertyId.
+     */
+    get _propertyId() {
+        if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.PropertyIdentifier)
+            throw new Error("identifier is not a PropertyId.");
+        return this.identifier;
+    }
+    /**
+     * Gets the EnumeratorId instance.
+     * @throws Error if the identifier is not an instance of EnumeratorId.
+     */
+    get _enumeratorId() {
+        if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.EnumeratorIdentifier)
+            throw new Error("identifier is not a EnumerationId.");
+        return this.identifier;
+    }
+    /**
+     * Gets the CustomAttributeId instance.
+     * @throws Error if the identifier is not an instance of CustomAttributeId.
+     */
+    get _customAttributeId() {
+        if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.CustomAttributeIdentifier)
+            throw new Error("identifier is not a CustomAttributeId.");
+        return this.identifier;
+    }
+    /**
+     * Gets the RelationshipConstraintId instance.
+     * @throws Error if the identifier is not an instance of RelationshipConstraintId.
+     */
+    get _relationshipConstraintId() {
+        if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.RelationshipConstraintIdentifier)
+            throw new Error("identifier is not a RelationshipConstraintId.");
+        return this.identifier;
+    }
+    /** Gets rule violations that were reported during validation. Returns an array of [[AnyDiagnostic]] if
+     * the errorNumber is ECEditingStatus.RuleViolation, otherwise undefined.
+     */
+    get ruleViolations() {
+        return this._ruleViolations;
+    }
+    /**
+     * Returns a readable string containing the ECEditingStatus along with the error message. Any
+     * innerError will also be appended.
+     * @returns
+     */
+    toDebugString() {
+        let innerMessage = "";
+        if (this.innerError) {
+            if (this.innerError instanceof SchemaEditingError)
+                innerMessage = ` Inner error: ${this.innerError.toDebugString()}`;
+            else
+                innerMessage = ` Inner error: ${this.innerError.message}`;
+        }
+        return this._appendMessage(`ECEditingStatus.${ECEditingStatus[this.errorNumber]}`) + innerMessage;
+    }
+    generateMessage() {
+        if (this.message)
+            return;
+        switch (this.errorNumber) {
+            case ECEditingStatus.SchemaNotFound:
+                this.message = `Schema Key ${this._schemaKey.toString(true)} could not be found in the context.`;
+                return;
+            case ECEditingStatus.SchemaItemNotFound:
+                this.message = `${this._schemaItemId.schemaItemType} ${this._schemaItemId.name} could not be found in the schema ${this._schemaKey.name}.`;
+                return;
+            case ECEditingStatus.SchemaItemNotFoundInContext:
+                this.message = `${this._schemaItemId.schemaItemType} ${this._schemaItemId.name} could not be found in the schema context.`;
+                return;
+            case ECEditingStatus.InvalidSchemaItemType:
+                this.message = `Expected ${this._schemaItemId.name} to be of type ${this._schemaItemId.schemaItemType}.`;
+                return;
+            case ECEditingStatus.SchemaItemNameNotSpecified:
+                this.message = `Could not create a new ${this._schemaItemId.schemaItemType} in schema ${this._schemaKey.name}. No name was supplied within props.`;
+                return;
+            case ECEditingStatus.SchemaItemNameAlreadyExists:
+                this.message = `${this._schemaItemId.schemaItemType} ${this._schemaItemId.name} already exists in the schema ${this._schemaKey.name}.`;
+                return;
+            case ECEditingStatus.RuleViolation:
+                this.message = this._getRuleViolationMessage();
+                return;
+            case ECEditingStatus.PropertyNotFound:
+                this.message = `An ECProperty with the name ${this._propertyId.name} could not be found in the class ${this._propertyId.ecClass.name}.`;
+                return;
+            case ECEditingStatus.PropertyAlreadyExists:
+                this.message = `An ECProperty with the name ${this._propertyId.name} already exists in the class ${this._propertyId.ecClass.name}.`;
+                return;
+            case ECEditingStatus.InvalidPropertyType:
+                this.message = `Expected property ${this._propertyId.name} to be of type ${this._propertyId.typeName}.`;
+                return;
+            case ECEditingStatus.BaseClassIsNotElement:
+                this.message = `Expected base class ${this._schemaItemId.name} to derive from BisCore.Element.`;
+                return;
+            case ECEditingStatus.BaseClassIsNotElementUniqueAspect:
+                this.message = `Expected base class ${this._schemaItemId.name} to derive from BisCore.ElementUniqueAspect.`;
+                return;
+            case ECEditingStatus.BaseClassIsNotElementMultiAspect:
+                this.message = `Expected base class ${this._schemaItemId.name} to derive from BisCore.ElementMultiAspect.`;
+                return;
+            case ECEditingStatus.InvalidFormatUnitsSpecified:
+                this.message = `The specified Format unit ${this._schemaItemId.name} is not of type Unit or InvertedUnit`;
+                return;
+            case ECEditingStatus.InvalidEnumeratorType:
+                this.message = `The Enumeration ${this._enumeratorId.enumeration.fullName} has type ${this._enumeratorId.enumerationType}, while Enumerator ${this._enumeratorId.name} has type ${this._enumeratorId.enumeratorType}.`;
+                return;
+            case ECEditingStatus.EnumeratorDoesNotExist:
+                this.message = `Enumerator ${this._enumeratorId.name} does not exists in Enumeration ${this._enumeratorId.enumeration.name}.`;
+                return;
+            case ECEditingStatus.InvalidECName:
+                this.message = `Could not rename class ${this._schemaItemId.name} because the specified name is not a valid ECName.`;
+                return;
+            case ECEditingStatus.InvalidSchemaAlias:
+                this.message = `Could not set the alias for schema ${this._schemaKey.name} because the specified alias is not a valid ECName.`;
+                return;
+            default:
+                this.message = this._createTaskErrorMessage();
+        }
+    }
+    _appendMessage(e) {
+        return this.message ? `${e}: ${this.message}` : e;
+    }
+    _getRuleViolationMessage() {
+        if (!this._ruleViolations)
+            return "";
+        let violations = "";
+        for (const diagnostic of this._ruleViolations) {
+            violations += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
+        }
+        switch (this.identifier.typeIdentifier) {
+            case SchemaTypeIdentifiers.SchemaIdentifier:
+                return `Rule violations occurred from Schema ${this._schemaId.name}: ${violations}`;
+            case SchemaTypeIdentifiers.SchemaItemIdentifier:
+                return `Rule violations occurred from ${this._schemaItemId.schemaItemType} ${this._schemaItemId.name}: ${violations}`;
+            case SchemaTypeIdentifiers.ClassIdentifier:
+                return `Rule violations occurred from ${this._schemaItemId.schemaItemType} ${this._schemaItemId.name}: ${violations}`;
+            case SchemaTypeIdentifiers.CustomAttributeIdentifier:
+                return `Rule violations occurred from CustomAttribute ${this._customAttributeId.name}, container ${this._customAttributeId.containerFullName}: ${violations}`;
+            case SchemaTypeIdentifiers.RelationshipConstraintIdentifier:
+                return `Rule violations occurred from ${this._relationshipConstraintId.name} constraint of RelationshipClass ${this._relationshipConstraintId.relationshipKey.fullName}: ${violations}`;
+            default:
+                throw new Error("Invalid identifier.");
+        }
+    }
+    _createTaskErrorMessage() {
+        // Make sure we have an inner error or else it is not a task error
+        if (!this.innerError)
+            return "";
+        switch (this.identifier.typeIdentifier) {
+            case SchemaTypeIdentifiers.SchemaIdentifier:
+            case SchemaTypeIdentifiers.SchemaItemIdentifier:
+            case SchemaTypeIdentifiers.ClassIdentifier:
+            case SchemaTypeIdentifiers.RelationshipConstraintIdentifier:
+                return `While performing task '${ECEditingStatus[this.errorNumber]}' an error occurred editing ${this.identifier.typeIdentifier} ${this.identifier.name}.`;
+            case SchemaTypeIdentifiers.PropertyIdentifier:
+                return `While performing task '${ECEditingStatus[this.errorNumber]}' an error occurred editing ${this.identifier.typeIdentifier} ${this.identifier.fullName}.`;
+            default:
+                throw new Error("Invalid identifier.");
+        }
+    }
+    isSchemaItemIdentifier(identifier) {
+        if (identifier.typeIdentifier !== SchemaTypeIdentifiers.SchemaItemIdentifier &&
+            identifier.typeIdentifier !== SchemaTypeIdentifiers.ClassIdentifier)
+            return true;
+        return false;
+    }
+}
+function getEnumeratorType(enumeration, enumerator) {
+    if (typeof (enumerator) === "string") {
+        return enumeration.type ? primitiveTypeToString(enumeration.type) : "string";
+    }
+    return typeof (enumerator.value) === "string" ? "string" : "int";
+}
+//# sourceMappingURL=Exception.js.map

package/lib/esm/Editing/Exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Exception.js","sourceRoot":"","sources":["../../../src/Editing/Exception.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAA6D,aAAa,EAAE,qBAAqB,EAAE,QAAQ,EAA0B,aAAa,EAA6B,MAAM,0BAA0B,CAAC;AAEvN,aAAa;AACb,MAAM,CAAN,IAAY,eAmFX;AAnFD,WAAY,eAAe;IACzB,4FAA+B,CAAA;IAC/B,2DAAW,CAAA;IACX,4EAAyC,CAAA;IACzC,8EAAc,CAAA;IACd,sFAAkB,CAAA;IAClB,wGAA2B,CAAA;IAC3B,4FAAqB,CAAA;IACrB,kFAAgB,CAAA;IAChB,wFAAmB,CAAA;IACnB,4FAAqB,CAAA;IACrB,oHAAiC,CAAA;IACjC,kHAAgC,CAAA;IAChC,sGAA0B,CAAA;IAC1B,4FAAqB,CAAA;IACrB,wGAA2B,CAAA;IAC3B,4FAAqB,CAAA;IACrB,kFAAgB,CAAA;IAChB,8FAAsB,CAAA;IACtB,4EAAa,CAAA;IACb,sFAAkB,CAAA;IAClB,wGAA2B,CAAA;IAC3B,kGAAwB,CAAA;IACxB,eAAe;IACf,8FAAsB,CAAA;IACtB,oGAAyB,CAAA;IACzB,4EAAa,CAAA;IACb,oGAAyB,CAAA;IACzB,kGAAwB,CAAA;IACxB,0EAAY,CAAA;IACZ,wFAAmB,CAAA;IACnB,wFAAmB,CAAA;IACnB,sFAAkB,CAAA;IAClB,4FAAqB,CAAA;IACrB,4FAAqB,CAAA;IACrB,8GAA8B,CAAA;IAC9B,0GAA4B,CAAA;IAC5B,oGAAyB,CAAA;IACzB,kGAAwB,CAAA;IACxB,oHAAiC,CAAA;IACjC,8EAAc,CAAA;IACd,4EAAa,CAAA;IACb,8EAAc,CAAA;IACd,kEAAQ,CAAA;IACR,4EAAa,CAAA;IACb,wEAAW,CAAA;IACX,wEAAW,CAAA;IACX,oFAAiB,CAAA;IACjB,0EAAY,CAAA;IACZ,0EAAY,CAAA;IACZ,wFAAmB,CAAA;IACnB,0EAAY,CAAA;IACZ,0EAAY,CAAA;IACZ,wEAAW,CAAA;IACX,wEAAW,CAAA;IACX,gFAAe,CAAA;IACf,kEAAQ,CAAA;IACR,4EAAa,CAAA;IACb,sFAAkB,CAAA;IAClB,kGAAwB,CAAA;IACxB,wFAAmB,CAAA;IACnB,gGAAuB,CAAA;IACvB,0FAAoB,CAAA;IACpB,wGAA2B,CAAA;IAC3B,gGAAuB,CAAA;IACvB,kHAAgC,CAAA;IAChC,oGAAyB,CAAA;IACzB,sHAAkC,CAAA;IAClC,0GAA4B,CAAA;IAC5B,4HAAqC,CAAA;IACrC,8GAA8B,CAAA;IAC9B,gIAAuC,CAAA;IACvC,0FAAoB,CAAA;IACpB,4GAA6B,CAAA;IAC7B,oGAAyB,CAAA;IACzB,sHAAkC,CAAA;IAClC,8EAAc,CAAA;IACd,wEAAW,CAAA;IACX,0EAAY,CAAA;IACZ,sFAAkB,CAAA;IAClB,kFAAgB,CAAA;IAChB,wGAA2B,CAAA;IAC3B,8EAAc,CAAA;AAChB,CAAC,EAnFW,eAAe,KAAf,eAAe,QAmF1B;AAQD;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,mDAA+B,CAAA;IAC/B,2DAAuC,CAAA;IACvC,+DAA2C,CAAA;IAC3C,6DAAyC,CAAA;IACzC,qDAAiC,CAAA;AACnC,CAAC,EANW,gBAAgB,KAAhB,gBAAgB,QAM3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,oDAA2B,CAAA;IAC3B,4DAAmC,CAAA;IACnC,kDAAyB,CAAA;IACzB,wDAA+B,CAAA;IAC/B,4DAAmC,CAAA;IACnC,sEAA6C,CAAA;IAC7C,oFAA2D,CAAA;AAC7D,CAAC,EARW,qBAAqB,KAArB,qBAAqB,QAQhC;AAkGD;;;GAGG;AACH,MAAM,OAAO,QAAQ;IACH,cAAc,GAAG,qBAAqB,CAAC,gBAAgB,CAAC;IACxD,IAAI,CAAS;IACb,SAAS,CAAY;IACrC,YAAY,SAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,YAAY;IACP,cAAc,CAA8B;IAC5C,IAAI,CAAS;IACb,SAAS,CAAY;IACrB,cAAc,CAAiB;IAC/B,aAAa,CAAgB;IAE7C,YAAY,cAA8B,EAAE,mBAA2C,EAAE,SAAqB;QAC5G,IAAI,OAAM,CAAC,mBAAmB,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC7C,IAAI,CAAC,SAAS;gBACZ,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;YAEpG,IAAI,CAAC,SAAS,GAAG,SAAU,CAAC;YAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACzE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,mBAAmB,CAAC,SAAS,CAAC;YAC/C,IAAI,CAAC,aAAa,GAAG,mBAAmB,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;QACxC,IAAI,CAAC,cAAc,GAAG,qBAAqB,CAAC,oBAAoB,CAAC;IACnE,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACd,cAAc,GAAG,qBAAqB,CAAC,eAAe,CAAC;IACvD,cAAc,CAAqB;IAC5D,YAAY,cAAkC,EAAE,mBAA2C,EAAE,SAAqB;QAChH,KAAK,CAAC,cAAc,EAAE,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,UAAU;IACL,cAAc,GAAG,qBAAqB,CAAC,kBAAkB,CAAC;IAC1D,IAAI,CAAS;IACb,QAAQ,CAAS;IACjB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,QAAQ,CAAoB;IAE5C,YAAY,cAAkC,EAAE,QAAuB,EAAE,QAA2B,EAAE,QAA2B;QAC/H,IAAI,CAAC,IAAI,GAAG,QAAQ,YAAY,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;QACpE,IAAI,CAAC,QAAQ,GAAG,QAAQ,YAAY,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;QAClG,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QACrD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;QACpC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,YAAY;IACP,cAAc,GAAG,qBAAqB,CAAC,oBAAoB,CAAC;IAC5D,WAAW,CAAgB;IAC3B,eAAe,CAAS;IACxB,cAAc,CAAS;IACvB,IAAI,CAAS;IACb,SAAS,CAAY;IAErC,YAAY,UAAkC,EAAE,WAAwB;QACtE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC;QACnC,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA,CAAC,CAAC,QAAQ,CAAC;QAC5F,IAAI,CAAC,cAAc,GAAG,iBAAiB,CAAC,WAAW,IAAI,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACzF,IAAI,CAAC,IAAI,GAAG,OAAM,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;QAC3E,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC;IAChD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IACZ,cAAc,GAAG,qBAAqB,CAAC,yBAAyB,CAAC;IACjE,IAAI,CAAS;IACb,SAAS,CAAY;IACrB,iBAAiB,CAAS;IAC1C,YAAY,IAAY,EAAE,SAAwC;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC;QAC5C,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC;IAC9C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IACnB,cAAc,GAAG,qBAAqB,CAAC,gCAAgC,CAAC;IACxE,IAAI,CAAS;IACb,eAAe,CAAgB;IAC/B,SAAS,CAAY;IACrC,YAAY,UAAkC;QAC5C,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QACtD,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;IAClD,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAYR;IAA8C;IAA2C;IAXpH,eAAe,CAAmB;IAClC,UAAU,CAAY;IAE9B;;;;;;;OAOG;IACH,YAAmC,WAA4B,EAAkB,UAAyB,EAAkB,UAA4B,EAAE,cAAgC,EAAE,OAAgB;QAC1M,KAAK,CAAC,OAAO,CAAC,CAAC;QADkB,gBAAW,GAAX,WAAW,CAAiB;QAAkB,eAAU,GAAV,UAAU,CAAe;QAAkB,eAAU,GAAV,UAAU,CAAkB;QAEtJ,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,SAAS;YACtC,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAY,SAAS;QACnB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,KAAK,qBAAqB,CAAC,gBAAgB;YAC3E,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,UAAsB,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,IAAY,aAAa;QACvB,IAAI,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,UAA0B,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,IAAY,QAAQ;QAClB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,KAAK,qBAAqB,CAAC,eAAe;YAC1E,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,UAAqB,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAY,WAAW;QACrB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,KAAK,qBAAqB,CAAC,kBAAkB;YAC7E,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAY,aAAa;QACvB,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,KAAK,qBAAqB,CAAC,oBAAoB;YAC/E,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,UAA0B,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,IAAY,kBAAkB;QAC5B,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,KAAK,qBAAqB,CAAC,yBAAyB;YACpF,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAY,yBAAyB;QACnC,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,KAAK,qBAAqB,CAAC,gCAAgC;YAC3F,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,aAAa;QAClB,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,IAAI,CAAC,UAAU,YAAY,kBAAkB;gBAC/C,YAAY,GAAG,iBAAiB,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC;;gBAElE,YAAY,GAAG,iBAAiB,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;IACpG,CAAC;IAEO,eAAe;QACrB,IAAI,IAAI,CAAC,OAAO;YACd,OAAO;QAET,QAAO,IAAI,CAAC,WAAW,EAAE,CAAC;YACxB,KAAK,eAAe,CAAC,cAAc;gBACjC,IAAI,CAAC,OAAO,GAAG,cAAc,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,qCAAqC,CAAC;gBACjG,OAAO;YACT,KAAK,eAAe,CAAC,kBAAkB;gBACrC,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,qCAAqC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC;gBAC3I,OAAO;YACT,KAAK,eAAe,CAAC,2BAA2B;gBAC9C,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,4CAA4C,CAAC;gBAC3H,OAAO;YACT,KAAK,eAAe,CAAC,qBAAqB;gBACxC,IAAI,CAAC,OAAO,GAAG,YAAY,IAAI,CAAC,aAAa,CAAC,IAAI,kBAAkB,IAAI,CAAC,aAAa,CAAC,cAAc,GAAG,CAAC;gBACzG,OAAO;YACT,KAAK,eAAe,CAAC,0BAA0B;gBAC7C,IAAI,CAAC,OAAO,GAAG,0BAA0B,IAAI,CAAC,aAAa,CAAC,cAAc,cAAc,IAAI,CAAC,UAAU,CAAC,IAAI,sCAAsC,CAAC;gBACnJ,OAAO;YACT,KAAK,eAAe,CAAC,2BAA2B;gBAC9C,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,iCAAiC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC;gBACvI,OAAO;YACT,KAAK,eAAe,CAAC,aAAa;gBAChC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBAC/C,OAAO;YACT,KAAK,eAAe,CAAC,gBAAgB;gBACnC,IAAI,CAAC,OAAO,GAAG,+BAA+B,IAAI,CAAC,WAAW,CAAC,IAAI,oCAAoC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;gBACxI,OAAO;YACT,KAAK,eAAe,CAAC,qBAAqB;gBACxC,IAAI,CAAC,OAAO,GAAG,+BAA+B,IAAI,CAAC,WAAW,CAAC,IAAI,gCAAgC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;gBACpI,OAAO;YACT,KAAK,eAAe,CAAC,mBAAmB;gBACtC,IAAI,CAAC,OAAO,GAAG,qBAAqB,IAAI,CAAC,WAAW,CAAC,IAAI,kBAAkB,IAAI,CAAC,WAAW,CAAC,QAAQ,GAAG,CAAC;gBACxG,OAAO;YACT,KAAK,eAAe,CAAC,qBAAqB;gBACxC,IAAI,CAAC,OAAO,GAAG,uBAAuB,IAAI,CAAC,aAAa,CAAC,IAAI,kCAAkC,CAAC;gBAChG,OAAO;YACT,KAAK,eAAe,CAAC,iCAAiC;gBACpD,IAAI,CAAC,OAAO,GAAG,uBAAuB,IAAI,CAAC,aAAa,CAAC,IAAI,8CAA8C,CAAC;gBAC5G,OAAO;YACT,KAAK,eAAe,CAAC,gCAAgC;gBACnD,IAAI,CAAC,OAAO,GAAG,uBAAuB,IAAI,CAAC,aAAa,CAAC,IAAI,6CAA6C,CAAC;gBAC3G,OAAO;YACT,KAAK,eAAe,CAAC,2BAA2B;gBAC9C,IAAI,CAAC,OAAO,GAAG,6BAA6B,IAAI,CAAC,aAAa,CAAC,IAAI,sCAAsC,CAAC;gBAC1G,OAAO;YACT,KAAK,eAAe,CAAC,qBAAqB;gBACxC,IAAI,CAAC,OAAO,GAAG,mBAAmB,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,QAAQ,aAAa,IAAI,CAAC,aAAa,CAAC,eAAe,sBAAsB,IAAI,CAAC,aAAa,CAAC,IAAI,aAAa,IAAI,CAAC,aAAa,CAAC,cAAc,GAAG,CAAC;gBACvN,OAAO;YACT,KAAK,eAAe,CAAC,sBAAsB;gBACzC,IAAI,CAAC,OAAO,GAAG,cAAc,IAAI,CAAC,aAAa,CAAC,IAAI,mCAAmC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC;gBAC9H,OAAO;YACT,KAAK,eAAe,CAAC,aAAa;gBAChC,IAAI,CAAC,OAAO,GAAG,0BAA0B,IAAI,CAAC,aAAa,CAAC,IAAI,oDAAoD,CAAC;gBACrH,OAAO;YACT,KAAK,eAAe,CAAC,kBAAkB;gBACrC,IAAI,CAAC,OAAO,GAAG,sCAAsC,IAAI,CAAC,UAAU,CAAC,IAAI,qDAAqD,CAAC;gBAC/H,OAAO;YACT;gBACE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAClD,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,CAAS;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IAEO,wBAAwB;QAC9B,IAAI,CAAC,IAAI,CAAC,eAAe;YACvB,OAAO,EAAE,CAAC;QAEZ,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC9C,UAAU,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;QACpE,CAAC;QAED,QAAQ,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;YACvC,KAAK,qBAAqB,CAAC,gBAAgB;gBACzC,OAAO,wCAAwC,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACtF,KAAK,qBAAqB,CAAC,oBAAoB;gBAC7C,OAAO,iCAAiC,IAAI,CAAC,aAAa,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACxH,KAAK,qBAAqB,CAAC,eAAe;gBACxC,OAAO,iCAAiC,IAAI,CAAC,aAAa,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACxH,KAAK,qBAAqB,CAAC,yBAAyB;gBAClD,OAAO,iDAAiD,IAAI,CAAC,kBAAkB,CAAC,IAAI,eAAe,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAChK,KAAK,qBAAqB,CAAC,gCAAgC;gBACzD,OAAO,iCAAiC,IAAI,CAAC,yBAAyB,CAAC,IAAI,oCAAoC,IAAI,CAAC,yBAAyB,CAAC,eAAe,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC1L;gBACE,MAAM,IAAI,KAAK,CAAE,qBAAqB,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAEO,uBAAuB;QAC7B,kEAAkE;QAClE,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,OAAO,EAAE,CAAC;QAEZ,QAAQ,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;YACvC,KAAK,qBAAqB,CAAC,gBAAgB,CAAC;YAC5C,KAAK,qBAAqB,CAAC,oBAAoB,CAAC;YAChD,KAAK,qBAAqB,CAAC,eAAe,CAAC;YAC3C,KAAK,qBAAqB,CAAC,gCAAgC;gBACzD,OAAO,0BAA0B,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,+BAA+B,IAAI,CAAC,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC;YAC7J,KAAK,qBAAqB,CAAC,kBAAkB;gBAC3C,OAAO,0BAA0B,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,+BAA+B,IAAI,CAAC,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,CAAC;YACjK;gBACE,MAAM,IAAI,KAAK,CAAE,qBAAqB,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAEO,sBAAsB,CAAC,UAAyB;QACtD,IAAI,UAAU,CAAC,cAAc,KAAK,qBAAqB,CAAC,oBAAoB;YAC1E,UAAU,CAAC,cAAc,KAAK,qBAAqB,CAAC,eAAe;YACnE,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,SAAS,iBAAiB,CAAC,WAAwB,EAAE,UAAkC;IACrF,IAAI,OAAM,CAAC,UAAU,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC/E,CAAC;IAED,OAAO,OAAM,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;AAClE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Editing\n */\n\nimport { AnyDiagnostic } from \"../Validation/Diagnostic\";\nimport { AnyEnumerator, CustomAttributeContainerProps, Enumeration, PrimitiveType, primitiveTypeToString, Property, RelationshipConstraint, SchemaItemKey, SchemaItemType, SchemaKey } from \"@itwin/ecschema-metadata\";\n\n/** @alpha */\nexport enum ECEditingStatus {\n  EC_EDITING_ERROR_BASE = 0x30000,\n  Unknown = 0,\n  RuleViolation = EC_EDITING_ERROR_BASE + 1,\n  SchemaNotFound,\n  SchemaItemNotFound,\n  SchemaItemNotFoundInContext,\n  PropertyAlreadyExists,\n  PropertyNotFound,\n  InvalidPropertyType,\n  BaseClassIsNotElement,\n  BaseClassIsNotElementUniqueAspect,\n  BaseClassIsNotElementMultiAspect,\n  SchemaItemNameNotSpecified,\n  InvalidSchemaItemType,\n  SchemaItemNameAlreadyExists,\n  InvalidEnumeratorType,\n  InvalidBaseClass,\n  EnumeratorDoesNotExist,\n  InvalidECName,\n  InvalidSchemaAlias,\n  InvalidFormatUnitsSpecified,\n  SchemaAliasAlreadyExists,\n  // Outer Errors\n  CreateSchemaItemFailed,\n  CreateSchemaItemFromProps,\n  CreateElement,\n  CreateElementUniqueAspect,\n  CreateElementMultiAspect,\n  SetBaseClass,\n  SetSourceConstraint,\n  SetTargetConstraint,\n  AddConstraintClass,\n  RemoveConstraintClass,\n  SetAbstractConstraint,\n  AddCustomAttributeToConstraint,\n  AddCustomAttributeToProperty,\n  AddCustomAttributeToClass,\n  CreateNavigationProperty,\n  CreateNavigationPropertyFromProps,\n  SetInvertsUnit,\n  SetUnitSystem,\n  SetDescription,\n  SetLabel,\n  SetIsReadOnly,\n  SetPriority,\n  SetCategory,\n  SetKindOfQuantity,\n  SetMinOccurs,\n  SetMaxOccurs,\n  SetExtendedTypeName,\n  SetMinLength,\n  SetMaxLength,\n  SetMinValue,\n  SetMaxValue,\n  SetPropertyName,\n  AddMixin,\n  AddEnumerator,\n  SetEnumeratorLabel,\n  SetEnumeratorDescription,\n  AddPresentationUnit,\n  AddPresentationOverride,\n  CreateFormatOverride,\n  SetPropertyCategoryPriority,\n  CreatePrimitiveProperty,\n  CreatePrimitivePropertyFromProps,\n  CreateEnumerationProperty,\n  CreateEnumerationPropertyFromProps,\n  CreatePrimitiveArrayProperty,\n  CreatePrimitiveArrayPropertyFromProps,\n  CreateEnumerationArrayProperty,\n  CreateEnumerationArrayPropertyFromProps,\n  CreateStructProperty,\n  CreateStructPropertyFromProps,\n  CreateStructArrayProperty,\n  CreateStructArrayPropertyFromProps,\n  DeleteProperty,\n  DeleteClass,\n  SetClassName,\n  AddSchemaReference,\n  SetSchemaVersion,\n  IncrementSchemaMinorVersion,\n  SetSchemaAlias\n}\n\n/**\n * A type that constrains the possible error types handled by SchemaEditingError\n * @alpha\n */\nexport type AnyEditingError = SchemaEditingError | Error;\n\n/**\n * Defines the possible property type names.\n * @alpha\n */\nexport enum PropertyTypeName {\n  ArrayProperty = \"ArrayProperty\",\n  PrimitiveProperty = \"PrimitiveProperty\",\n  EnumerationProperty = \"EnumerationProperty\",\n  NavigationProperty = \"NavigationProperty\",\n  StructProperty = \"StructProperty\"\n}\n\n/**\n * Defines the possible schema type identifiers.\n * @alpha\n */\nexport enum SchemaTypeIdentifiers {\n  SchemaIdentifier = \"Schema\",\n  SchemaItemIdentifier = \"SchemaItem\",\n  ClassIdentifier = \"Class\",\n  PropertyIdentifier = \"Property\",\n  EnumeratorIdentifier = \"Enumerator\",\n  CustomAttributeIdentifier = \"CustomAttribute\",\n  RelationshipConstraintIdentifier = \"RelationshipConstraint\"\n}\n\n/**\n * Type that constrains SchemaItemType enum to those used by EC Class types.\n * @alpha\n */\nexport type ECClassSchemaItems = SchemaItemType.EntityClass | SchemaItemType.StructClass | SchemaItemType.RelationshipClass | SchemaItemType.Mixin | SchemaItemType.CustomAttributeClass;\n\n/**\n * Type that defines the possible SchemaTypeIdentifiers for SchemaItemId classes.\n * @alpha\n */\nexport type AnySchemaItemTypeIdentifier = SchemaTypeIdentifiers.SchemaItemIdentifier | SchemaTypeIdentifiers.ClassIdentifier;\n\n/**\n * Type that encompasses all ISchemaTypeIdentifier interfaces\n * @alpha\n */\nexport type AnyIdentifier = ISchemaIdentifier | ISchemaItemIdentifier | IClassIdentifier | IPropertyIdentifier | ICustomAttributeIdentifier | IRelationshipConstraintIdentifier | IEnumeratorIdentifier;\n\n/**\n * A base interface that defines what is needed to identity any schema type.\n * @alpha\n */\nexport interface ISchemaTypeIdentifier {\n  readonly name: string;\n  readonly schemaKey: SchemaKey;\n  readonly typeIdentifier: SchemaTypeIdentifiers;\n}\n\n/**\n * Interface that defines the data needed to identify a Schema.\n * @alpha\n */\nexport interface ISchemaIdentifier extends ISchemaTypeIdentifier {\n  readonly typeIdentifier: SchemaTypeIdentifiers.SchemaIdentifier;\n}\n\n/**\n * Interface that defines the data needed to identify a SchemaItem.\n * @alpha\n */\nexport interface ISchemaItemIdentifier extends ISchemaTypeIdentifier {\n  readonly schemaItemType: SchemaItemType;\n  readonly schemaItemKey: SchemaItemKey;\n  readonly typeIdentifier: AnySchemaItemTypeIdentifier;\n}\n\n/**\n * Interface that defines the data needed to identify an EC Class.\n * @alpha\n */\nexport interface IClassIdentifier extends ISchemaTypeIdentifier {\n  readonly schemaItemType: ECClassSchemaItems;\n  readonly schemaItemKey: SchemaItemKey;\n  readonly typeIdentifier: SchemaTypeIdentifiers.ClassIdentifier;\n}\n\n/**\n * Interface that defines the data needed to identify an EC Property.\n * @alpha\n */\nexport interface IPropertyIdentifier extends ISchemaTypeIdentifier {\n  readonly fullName: string;\n  readonly ecClass: ClassId;\n  readonly typeName?: PropertyTypeName;\n  readonly typeIdentifier: SchemaTypeIdentifiers.PropertyIdentifier;\n}\n\n/**\n * Interface that defines the data needed to identify an Enumerator.\n * @alpha\n */\ninterface IEnumeratorIdentifier extends ISchemaTypeIdentifier {\n  readonly enumeratorType: string;\n  readonly enumeration: SchemaItemKey;\n  readonly enumerationType: string;\n  readonly typeIdentifier: SchemaTypeIdentifiers.EnumeratorIdentifier;\n}\n\n/**\n * Interface that defines the data needed to identify a CustomAttribute.\n * @alpha\n */\nexport interface ICustomAttributeIdentifier extends ISchemaTypeIdentifier {\n  readonly containerFullName: string;\n  readonly typeIdentifier: SchemaTypeIdentifiers.CustomAttributeIdentifier;\n}\n\n/**\n * Interface that defines the data needed to identify a RelationshipConstraint.\n * @alpha\n */\nexport interface IRelationshipConstraintIdentifier extends ISchemaTypeIdentifier {\n  readonly relationshipKey: SchemaItemKey;\n  readonly typeIdentifier: SchemaTypeIdentifiers.RelationshipConstraintIdentifier;\n}\n\n/**\n * An ISchemaIdentifier implementation to identify Schemas\n * @alpha\n */\nexport class SchemaId implements ISchemaIdentifier {\n  public readonly typeIdentifier = SchemaTypeIdentifiers.SchemaIdentifier;\n  public readonly name: string;\n  public readonly schemaKey: SchemaKey;\n  constructor(schemaKey: SchemaKey) {\n    this.name = schemaKey.name;\n    this.schemaKey = schemaKey;\n  }\n}\n\n/**\n * An ISchemItemIdentifier implementation to identify SchemaItems\n * @alpha\n */\nexport class SchemaItemId implements ISchemaItemIdentifier {\n  public readonly typeIdentifier: AnySchemaItemTypeIdentifier;\n  public readonly name: string;\n  public readonly schemaKey: SchemaKey;\n  public readonly schemaItemType: SchemaItemType;\n  public readonly schemaItemKey: SchemaItemKey;\n\n  constructor(schemaItemType: SchemaItemType, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey) {\n    if (typeof(schemaItemKeyOrName) === \"string\") {\n      if (!schemaKey)\n        throw new Error(\"schemaKey if required if the specified schemaItem the name of the schema item.\");\n\n      this.schemaKey = schemaKey!;\n      this.schemaItemKey = new SchemaItemKey(schemaItemKeyOrName, schemaKey);\n    } else {\n      this.schemaKey = schemaItemKeyOrName.schemaKey;\n      this.schemaItemKey = schemaItemKeyOrName;\n    }\n\n    this.schemaItemType = schemaItemType;\n    this.name = this.schemaItemKey.fullName;\n    this.typeIdentifier = SchemaTypeIdentifiers.SchemaItemIdentifier;\n  }\n}\n\n/**\n * An IClassIdentifier implementation to identify Class instances.\n * @alpha\n */\nexport class ClassId extends SchemaItemId implements IClassIdentifier {\n  public override readonly typeIdentifier = SchemaTypeIdentifiers.ClassIdentifier;\n  public override readonly schemaItemType: ECClassSchemaItems;\n  constructor(schemaItemType: ECClassSchemaItems, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey) {\n    super(schemaItemType, schemaItemKeyOrName, schemaKey);\n    this.schemaItemType = schemaItemType;\n  }\n}\n\n/**\n * An IPropertyIdentifier implementation to identify Property instances.\n * @alpha\n */\nexport class PropertyId implements IPropertyIdentifier {\n  public readonly typeIdentifier = SchemaTypeIdentifiers.PropertyIdentifier;\n  public readonly name: string;\n  public readonly fullName: string;\n  public readonly ecClass: ClassId;\n  public readonly schemaKey: SchemaKey;\n  public readonly typeName?: PropertyTypeName;\n\n  constructor(schemaItemType: ECClassSchemaItems, classKey: SchemaItemKey, property: Property | string, typeName?: PropertyTypeName) {\n    this.name = property instanceof Property ? property.name : property;\n    this.fullName = property instanceof Property ? property.fullName : `${classKey.name}.${property}`;\n    this.ecClass = new ClassId(schemaItemType, classKey);\n    this.schemaKey = classKey.schemaKey;\n    this.typeName = typeName;\n  }\n}\n\n/**\n * An IEnumeratorIdentifier implementation to identify Enumerator instances.\n * @alpha\n */\nexport class EnumeratorId implements IEnumeratorIdentifier{\n  public readonly typeIdentifier = SchemaTypeIdentifiers.EnumeratorIdentifier;\n  public readonly enumeration: SchemaItemKey;\n  public readonly enumerationType: string;\n  public readonly enumeratorType: string;\n  public readonly name: string;\n  public readonly schemaKey: SchemaKey;\n\n  constructor(enumerator: AnyEnumerator | string, enumeration: Enumeration) {\n    this.enumeration = enumeration.key;\n    this.enumerationType = enumeration.type ? primitiveTypeToString(enumeration.type): \"string\";\n    this.enumeratorType = getEnumeratorType(enumeration ?? PrimitiveType.String, enumerator);\n    this.name = typeof(enumerator) === \"string\" ? enumerator : enumerator.name;\n    this.schemaKey = enumeration.schema.schemaKey;\n  }\n}\n\n/**\n * An ICustomAttributeIdentifier implementation to identify CustomAttribute instances.\n * @alpha\n */\nexport class CustomAttributeId implements ICustomAttributeIdentifier {\n  public readonly typeIdentifier = SchemaTypeIdentifiers.CustomAttributeIdentifier;\n  public readonly name: string;\n  public readonly schemaKey: SchemaKey;\n  public readonly containerFullName: string;\n  constructor(name: string, container: CustomAttributeContainerProps) {\n    this.name = name;\n    this.schemaKey = container.schema.schemaKey;\n    this.containerFullName = container.fullName;\n  }\n}\n\n/**\n * An IRelationshipConstraintIdentifier implementation to identify RelationshipConstraints.\n * @alpha\n */\nexport class RelationshipConstraintId implements IRelationshipConstraintIdentifier {\n  public readonly typeIdentifier = SchemaTypeIdentifiers.RelationshipConstraintIdentifier;\n  public readonly name: string;\n  public readonly relationshipKey: SchemaItemKey;\n  public readonly schemaKey: SchemaKey;\n  constructor(constraint: RelationshipConstraint) {\n    this.name = constraint.isSource ? \"Source\" : \"Target\";\n    this.relationshipKey = constraint.relationshipClass.key;\n    this.schemaKey = this.relationshipKey.schemaKey;\n  }\n}\n\n/**\n * An exception class for the ecschema-editing API. Contains identifiers for schema types involved in the\n * exception. An example being SchemaItemId which contains the name of the SchemaItem, SchemaItemKey, SchemaItemType, etc.\n * Typically will contain an innerError of type SchemaEditingError containing the identifier of the schema item that\n * caused the exception. The containing error instance will identify the method called (identified by the errorNumber)\n * and the identifier of the schema item being modified/created.\n * @alpha\n */\nexport class SchemaEditingError extends Error {\n  private _ruleViolations?: AnyDiagnostic[];\n  private _schemaKey: SchemaKey;\n\n  /**\n   * Constructs a new SchemaEditingError instance.\n   * @param errorNumber The unique ECEditingStatus code identifying the error.\n   * @param identifier The identifier instance containing information about the EC object involved with the exception.\n   * @param innerError The SchemaEditingError containing the identifier of the EC object that caused the initial exception.\n   * @param ruleViolations Will contain EC rule violations of type [[AnyDiagnostic]] for exceptions with the error code ECEditingStatus.RuleViolation.\n   * @param message Optional error message. Most messages on automatically generated by this class based on the ECEditingStatus code.\n   */\n  public constructor(public readonly errorNumber: ECEditingStatus, public readonly identifier: AnyIdentifier, public readonly innerError?: AnyEditingError, ruleViolations?: AnyDiagnostic[], message?: string) {\n    super(message);\n    this._ruleViolations = ruleViolations;\n    this._schemaKey = identifier.schemaKey,\n    this.generateMessage();\n  }\n\n  /**\n   * Gets the SchemaId instance.\n   * @throws Error if the identifier is not an instance of SchemaId.\n   */\n  private get _schemaId(): SchemaId {\n    if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.SchemaIdentifier)\n      throw new Error(\"identifier is not a SchemaId.\");\n    return this.identifier as SchemaId;\n  }\n\n  /**\n   * Gets the SchemaItemId instance.\n   * @throws Error if the identifier is not an instance of SchemaItemId.\n   */\n  private get _schemaItemId(): SchemaItemId {\n    if (this.isSchemaItemIdentifier(this.identifier))\n      throw new Error(\"identifier is not a SchemaItemId.\");\n    return this.identifier as SchemaItemId;\n  }\n\n  /**\n   * Gets the ClassId instance.\n   * @throws Error if the identifier is not an instance of ClassId.\n   */\n  private get _classId(): ClassId {\n    if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.ClassIdentifier)\n      throw new Error(\"identifier is not a ClassId.\");\n    return this.identifier as ClassId;\n  }\n\n  /**\n   * Gets the PropertyId instance.\n   * @throws Error if the identifier is not an instance of PropertyId.\n   */\n  private get _propertyId(): PropertyId {\n    if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.PropertyIdentifier)\n      throw new Error(\"identifier is not a PropertyId.\");\n    return this.identifier;\n  }\n\n  /**\n   * Gets the EnumeratorId instance.\n   * @throws Error if the identifier is not an instance of EnumeratorId.\n   */\n  private get _enumeratorId(): EnumeratorId {\n    if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.EnumeratorIdentifier)\n      throw new Error(\"identifier is not a EnumerationId.\");\n    return this.identifier as EnumeratorId;\n  }\n\n  /**\n   * Gets the CustomAttributeId instance.\n   * @throws Error if the identifier is not an instance of CustomAttributeId.\n   */\n  private get _customAttributeId(): CustomAttributeId {\n    if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.CustomAttributeIdentifier)\n      throw new Error(\"identifier is not a CustomAttributeId.\");\n    return this.identifier;\n  }\n\n  /**\n   * Gets the RelationshipConstraintId instance.\n   * @throws Error if the identifier is not an instance of RelationshipConstraintId.\n   */\n  private get _relationshipConstraintId(): RelationshipConstraintId {\n    if (this.identifier.typeIdentifier !== SchemaTypeIdentifiers.RelationshipConstraintIdentifier)\n      throw new Error(\"identifier is not a RelationshipConstraintId.\");\n    return this.identifier;\n  }\n\n  /** Gets rule violations that were reported during validation. Returns an array of [[AnyDiagnostic]] if\n   * the errorNumber is ECEditingStatus.RuleViolation, otherwise undefined.\n   */\n  public get ruleViolations(): AnyDiagnostic[] | undefined {\n    return this._ruleViolations;\n  }\n\n  /**\n   * Returns a readable string containing the ECEditingStatus along with the error message. Any\n   * innerError will also be appended.\n   * @returns\n   */\n  public toDebugString(): string {\n    let innerMessage = \"\";\n    if (this.innerError) {\n      if (this.innerError instanceof SchemaEditingError)\n        innerMessage = ` Inner error: ${this.innerError.toDebugString()}`;\n      else\n        innerMessage = ` Inner error: ${this.innerError.message}`;\n    }\n    return this._appendMessage(`ECEditingStatus.${ECEditingStatus[this.errorNumber]}`) + innerMessage;\n  }\n\n  private generateMessage() {\n    if (this.message)\n      return;\n\n    switch(this.errorNumber) {\n      case ECEditingStatus.SchemaNotFound:\n        this.message = `Schema Key ${this._schemaKey.toString(true)} could not be found in the context.`;\n        return;\n      case ECEditingStatus.SchemaItemNotFound:\n        this.message = `${this._schemaItemId.schemaItemType} ${this._schemaItemId.name} could not be found in the schema ${this._schemaKey.name}.`;\n        return;\n      case ECEditingStatus.SchemaItemNotFoundInContext:\n        this.message = `${this._schemaItemId.schemaItemType} ${this._schemaItemId.name} could not be found in the schema context.`;\n        return;\n      case ECEditingStatus.InvalidSchemaItemType:\n        this.message = `Expected ${this._schemaItemId.name} to be of type ${this._schemaItemId.schemaItemType}.`;\n        return;\n      case ECEditingStatus.SchemaItemNameNotSpecified:\n        this.message = `Could not create a new ${this._schemaItemId.schemaItemType} in schema ${this._schemaKey.name}. No name was supplied within props.`;\n        return;\n      case ECEditingStatus.SchemaItemNameAlreadyExists:\n        this.message = `${this._schemaItemId.schemaItemType} ${this._schemaItemId.name} already exists in the schema ${this._schemaKey.name}.`;\n        return;\n      case ECEditingStatus.RuleViolation:\n        this.message = this._getRuleViolationMessage();\n        return;\n      case ECEditingStatus.PropertyNotFound:\n        this.message = `An ECProperty with the name ${this._propertyId.name} could not be found in the class ${this._propertyId.ecClass.name}.`;\n        return;\n      case ECEditingStatus.PropertyAlreadyExists:\n        this.message = `An ECProperty with the name ${this._propertyId.name} already exists in the class ${this._propertyId.ecClass.name}.`;\n        return;\n      case ECEditingStatus.InvalidPropertyType:\n        this.message = `Expected property ${this._propertyId.name} to be of type ${this._propertyId.typeName}.`;\n        return;\n      case ECEditingStatus.BaseClassIsNotElement:\n        this.message = `Expected base class ${this._schemaItemId.name} to derive from BisCore.Element.`;\n        return;\n      case ECEditingStatus.BaseClassIsNotElementUniqueAspect:\n        this.message = `Expected base class ${this._schemaItemId.name} to derive from BisCore.ElementUniqueAspect.`;\n        return;\n      case ECEditingStatus.BaseClassIsNotElementMultiAspect:\n        this.message = `Expected base class ${this._schemaItemId.name} to derive from BisCore.ElementMultiAspect.`;\n        return;\n      case ECEditingStatus.InvalidFormatUnitsSpecified:\n        this.message = `The specified Format unit ${this._schemaItemId.name} is not of type Unit or InvertedUnit`;\n        return;\n      case ECEditingStatus.InvalidEnumeratorType:\n        this.message = `The Enumeration ${this._enumeratorId.enumeration.fullName} has type ${this._enumeratorId.enumerationType}, while Enumerator ${this._enumeratorId.name} has type ${this._enumeratorId.enumeratorType}.`;\n        return;\n      case ECEditingStatus.EnumeratorDoesNotExist:\n        this.message = `Enumerator ${this._enumeratorId.name} does not exists in Enumeration ${this._enumeratorId.enumeration.name}.`;\n        return;\n      case ECEditingStatus.InvalidECName:\n        this.message = `Could not rename class ${this._schemaItemId.name} because the specified name is not a valid ECName.`;\n        return;\n      case ECEditingStatus.InvalidSchemaAlias:\n        this.message = `Could not set the alias for schema ${this._schemaKey.name} because the specified alias is not a valid ECName.`;\n        return;\n      default:\n        this.message = this._createTaskErrorMessage();\n    }\n  }\n\n  private _appendMessage(e: string) {\n    return this.message ? `${e}: ${this.message}` : e;\n  }\n\n  private _getRuleViolationMessage(): string {\n    if (!this._ruleViolations)\n      return \"\";\n\n    let violations = \"\";\n    for (const diagnostic of this._ruleViolations) {\n      violations += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\n    }\n\n    switch (this.identifier.typeIdentifier) {\n      case SchemaTypeIdentifiers.SchemaIdentifier:\n        return `Rule violations occurred from Schema ${this._schemaId.name}: ${violations}`;\n      case SchemaTypeIdentifiers.SchemaItemIdentifier:\n        return `Rule violations occurred from ${this._schemaItemId.schemaItemType} ${this._schemaItemId.name}: ${violations}`;\n      case SchemaTypeIdentifiers.ClassIdentifier:\n        return `Rule violations occurred from ${this._schemaItemId.schemaItemType} ${this._schemaItemId.name}: ${violations}`;\n      case SchemaTypeIdentifiers.CustomAttributeIdentifier:\n        return `Rule violations occurred from CustomAttribute ${this._customAttributeId.name}, container ${this._customAttributeId.containerFullName}: ${violations}`;\n      case SchemaTypeIdentifiers.RelationshipConstraintIdentifier:\n        return `Rule violations occurred from ${this._relationshipConstraintId.name} constraint of RelationshipClass ${this._relationshipConstraintId.relationshipKey.fullName}: ${violations}`;\n      default:\n        throw new Error (\"Invalid identifier.\");\n    }\n  }\n\n  private _createTaskErrorMessage() {\n    // Make sure we have an inner error or else it is not a task error\n    if (!this.innerError)\n      return \"\";\n\n    switch (this.identifier.typeIdentifier) {\n      case SchemaTypeIdentifiers.SchemaIdentifier:\n      case SchemaTypeIdentifiers.SchemaItemIdentifier:\n      case SchemaTypeIdentifiers.ClassIdentifier:\n      case SchemaTypeIdentifiers.RelationshipConstraintIdentifier:\n        return `While performing task '${ECEditingStatus[this.errorNumber]}' an error occurred editing ${this.identifier.typeIdentifier} ${this.identifier.name}.`;\n      case SchemaTypeIdentifiers.PropertyIdentifier:\n        return `While performing task '${ECEditingStatus[this.errorNumber]}' an error occurred editing ${this.identifier.typeIdentifier} ${this.identifier.fullName}.`;\n      default:\n        throw new Error (\"Invalid identifier.\");\n    }\n  }\n\n  private isSchemaItemIdentifier(identifier: AnyIdentifier) {\n    if (identifier.typeIdentifier !== SchemaTypeIdentifiers.SchemaItemIdentifier &&\n      identifier.typeIdentifier !== SchemaTypeIdentifiers.ClassIdentifier)\n      return true;\n\n    return false;\n  }\n}\n\nfunction getEnumeratorType(enumeration: Enumeration, enumerator: AnyEnumerator | string) {\n  if (typeof(enumerator) === \"string\") {\n    return enumeration.type ? primitiveTypeToString(enumeration.type) : \"string\";\n  }\n\n  return typeof(enumerator.value) === \"string\" ? \"string\" : \"int\";\n}\n"]}

package/lib/esm/Editing/Formats.d.ts

@@ -0,0 +1,23 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { Format, SchemaItemFormatProps, SchemaItemKey, SchemaKey } from "@itwin/ecschema-metadata";
+import { FormatType } from "@itwin/core-quantity";
+import { SchemaContextEditor } from "./Editor";
+import { SchemaItems } from "./SchemaItems";
+/**
+ * @alpha
+ * A class allowing you to create schema items of type Format.
+ */
+export declare class Formats extends SchemaItems {
+    protected get itemTypeClass(): typeof Format;
+    constructor(schemaEditor: SchemaContextEditor);
+    create(schemaKey: SchemaKey, name: string, formatType: FormatType, displayLabel?: string, units?: SchemaItemKey[]): Promise<SchemaItemKey>;
+    /**
+     * Creates a format through a SchemaItemFormatProps.
+     * @param schemaKey a SchemaKey of the Schema that will house the new object.
+     * @param relationshipProps a json object that will be used to populate the new RelationshipClass. Needs a name value passed in.
+     */
+    createFromProps(schemaKey: SchemaKey, formatProps: SchemaItemFormatProps): Promise<SchemaItemKey>;
+}
+//# sourceMappingURL=Formats.d.ts.map

package/lib/esm/Editing/Formats.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Formats.d.ts","sourceRoot":"","sources":["../../../src/Editing/Formats.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAgB,qBAAqB,EAAE,aAAa,EAAkB,SAAS,EAAQ,MAAM,0BAA0B,CAAC;AACvI,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC,cAAuB,aAAa,IAAI,OAAO,MAAM,CAEpD;gBAEkB,YAAY,EAAE,mBAAmB;IAIvC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IA8BvJ;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC;CAQ/G"}

package/lib/esm/Editing/Formats.js

@@ -0,0 +1,62 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Editing
+ */
+import { Format, InvertedUnit, SchemaItemType, Unit } from "@itwin/ecschema-metadata";
+import { ECEditingStatus, SchemaEditingError, SchemaItemId } from "./Exception";
+import { SchemaItems } from "./SchemaItems";
+/**
+ * @alpha
+ * A class allowing you to create schema items of type Format.
+ */
+export class Formats extends SchemaItems {
+    get itemTypeClass() {
+        return Format;
+    }
+    constructor(schemaEditor) {
+        super(SchemaItemType.Format, schemaEditor);
+    }
+    async create(schemaKey, name, formatType, displayLabel, units) {
+        try {
+            const newFormat = await this.createSchemaItem(schemaKey, this.schemaItemType, (schema) => schema.createFormat.bind(schema), name);
+            if (units !== undefined) {
+                for (const unit of units) {
+                    const unitItem = await this.schemaEditor.schemaContext.getSchemaItem(unit);
+                    if (!unitItem) {
+                        throw new SchemaEditingError(ECEditingStatus.SchemaItemNotFoundInContext, new SchemaItemId(SchemaItemType.Unit, unit));
+                    }
+                    if (!Unit.isUnit(unitItem) && !InvertedUnit.isInvertedUnit(unitItem)) {
+                        throw new SchemaEditingError(ECEditingStatus.InvalidFormatUnitsSpecified, new SchemaItemId(unitItem.schemaItemType, unitItem.key));
+                    }
+                    newFormat.addUnit(unitItem);
+                }
+            }
+            if (displayLabel)
+                newFormat.setDisplayLabel(displayLabel);
+            // TODO: Handle the setting of format traits, separators, etc....
+            newFormat.setFormatType(formatType);
+            return newFormat.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new SchemaItemId(this.schemaItemType, name, schemaKey), e);
+        }
+    }
+    /**
+     * Creates a format through a SchemaItemFormatProps.
+     * @param schemaKey a SchemaKey of the Schema that will house the new object.
+     * @param relationshipProps a json object that will be used to populate the new RelationshipClass. Needs a name value passed in.
+     */
+    async createFromProps(schemaKey, formatProps) {
+        try {
+            const newFormat = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createFormat.bind(schema), formatProps);
+            return newFormat.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new SchemaItemId(this.schemaItemType, formatProps.name, schemaKey), e);
+        }
+    }
+}
+//# sourceMappingURL=Formats.js.map