@itwin/ecschema-editing 4.7.0-dev.8 → 4.7.0

package/lib/cjs/Editing/Exception.js

@@ -0,0 +1,426 @@
+"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 Editing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaEditingError = exports.isRelationshipConstraintIdentifier = exports.isCustomAttributeIdentifier = exports.isEnumerationIdentifier = exports.isPropertyIdentifier = exports.isClassIdentifier = exports.isSchemaItemIdentifier = exports.isSchemaIdentifier = exports.RelationshipConstraintId = exports.CustomAttributeId = exports.EnumerationId = exports.PropertyId = exports.ClassId = exports.SchemaItemId = exports.SchemaId = exports.PropertyTypeName = exports.TaskType = exports.ECEditingStatus = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+/** @alpha */
+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["InvalidStrengthDirection"] = 196625] = "InvalidStrengthDirection";
+    ECEditingStatus[ECEditingStatus["InvalidECName"] = 196626] = "InvalidECName";
+    ECEditingStatus[ECEditingStatus["InvalidFormatUnitsSpecified"] = 196627] = "InvalidFormatUnitsSpecified";
+    // Outer Errors
+    ECEditingStatus[ECEditingStatus["CreateSchemaItemFailed"] = 196628] = "CreateSchemaItemFailed";
+    ECEditingStatus[ECEditingStatus["CreateSchemaItemFromProps"] = 196629] = "CreateSchemaItemFromProps";
+    ECEditingStatus[ECEditingStatus["CreateElement"] = 196630] = "CreateElement";
+    ECEditingStatus[ECEditingStatus["CreateElementUniqueAspect"] = 196631] = "CreateElementUniqueAspect";
+    ECEditingStatus[ECEditingStatus["CreateElementMultiAspect"] = 196632] = "CreateElementMultiAspect";
+    ECEditingStatus[ECEditingStatus["SetBaseClass"] = 196633] = "SetBaseClass";
+    ECEditingStatus[ECEditingStatus["SetSourceConstraint"] = 196634] = "SetSourceConstraint";
+    ECEditingStatus[ECEditingStatus["SetTargetConstraint"] = 196635] = "SetTargetConstraint";
+    ECEditingStatus[ECEditingStatus["AddConstraintClass"] = 196636] = "AddConstraintClass";
+    ECEditingStatus[ECEditingStatus["RemoveConstraintClass"] = 196637] = "RemoveConstraintClass";
+    ECEditingStatus[ECEditingStatus["SetAbstractConstraint"] = 196638] = "SetAbstractConstraint";
+    ECEditingStatus[ECEditingStatus["AddCustomAttributeToConstraint"] = 196639] = "AddCustomAttributeToConstraint";
+    ECEditingStatus[ECEditingStatus["AddCustomAttributeToProperty"] = 196640] = "AddCustomAttributeToProperty";
+    ECEditingStatus[ECEditingStatus["AddCustomAttributeToClass"] = 196641] = "AddCustomAttributeToClass";
+    ECEditingStatus[ECEditingStatus["CreateNavigationProperty"] = 196642] = "CreateNavigationProperty";
+    ECEditingStatus[ECEditingStatus["CreateNavigationPropertyFromProps"] = 196643] = "CreateNavigationPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["SetInvertsUnit"] = 196644] = "SetInvertsUnit";
+    ECEditingStatus[ECEditingStatus["SetUnitSystem"] = 196645] = "SetUnitSystem";
+    ECEditingStatus[ECEditingStatus["SetDescription"] = 196646] = "SetDescription";
+    ECEditingStatus[ECEditingStatus["SetLabel"] = 196647] = "SetLabel";
+    ECEditingStatus[ECEditingStatus["SetIsReadOnly"] = 196648] = "SetIsReadOnly";
+    ECEditingStatus[ECEditingStatus["SetPriority"] = 196649] = "SetPriority";
+    ECEditingStatus[ECEditingStatus["SetCategory"] = 196650] = "SetCategory";
+    ECEditingStatus[ECEditingStatus["SetMinOccurs"] = 196651] = "SetMinOccurs";
+    ECEditingStatus[ECEditingStatus["SetMaxOccurs"] = 196652] = "SetMaxOccurs";
+    ECEditingStatus[ECEditingStatus["SetExtendedTypeName"] = 196653] = "SetExtendedTypeName";
+    ECEditingStatus[ECEditingStatus["SetMinLength"] = 196654] = "SetMinLength";
+    ECEditingStatus[ECEditingStatus["SetMaxLength"] = 196655] = "SetMaxLength";
+    ECEditingStatus[ECEditingStatus["SetMinValue"] = 196656] = "SetMinValue";
+    ECEditingStatus[ECEditingStatus["SetMaxValue"] = 196657] = "SetMaxValue";
+    ECEditingStatus[ECEditingStatus["SetPropertyName"] = 196658] = "SetPropertyName";
+    ECEditingStatus[ECEditingStatus["AddMixin"] = 196659] = "AddMixin";
+    ECEditingStatus[ECEditingStatus["AddEnumerator"] = 196660] = "AddEnumerator";
+    ECEditingStatus[ECEditingStatus["SetEnumeratorLabel"] = 196661] = "SetEnumeratorLabel";
+    ECEditingStatus[ECEditingStatus["SetEnumeratorDescription"] = 196662] = "SetEnumeratorDescription";
+    ECEditingStatus[ECEditingStatus["AddPresentationUnit"] = 196663] = "AddPresentationUnit";
+    ECEditingStatus[ECEditingStatus["AddPresentationOverride"] = 196664] = "AddPresentationOverride";
+    ECEditingStatus[ECEditingStatus["CreateFormatOverride"] = 196665] = "CreateFormatOverride";
+    ECEditingStatus[ECEditingStatus["SetPropertyCategoryPriority"] = 196666] = "SetPropertyCategoryPriority";
+    ECEditingStatus[ECEditingStatus["CreatePrimitiveProperty"] = 196667] = "CreatePrimitiveProperty";
+    ECEditingStatus[ECEditingStatus["CreatePrimitivePropertyFromProps"] = 196668] = "CreatePrimitivePropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreateEnumerationProperty"] = 196669] = "CreateEnumerationProperty";
+    ECEditingStatus[ECEditingStatus["CreateEnumerationPropertyFromProps"] = 196670] = "CreateEnumerationPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreatePrimitiveArrayProperty"] = 196671] = "CreatePrimitiveArrayProperty";
+    ECEditingStatus[ECEditingStatus["CreatePrimitiveArrayPropertyFromProps"] = 196672] = "CreatePrimitiveArrayPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreateEnumerationArrayProperty"] = 196673] = "CreateEnumerationArrayProperty";
+    ECEditingStatus[ECEditingStatus["CreateEnumerationArrayPropertyFromProps"] = 196674] = "CreateEnumerationArrayPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreateStructProperty"] = 196675] = "CreateStructProperty";
+    ECEditingStatus[ECEditingStatus["CreateStructPropertyFromProps"] = 196676] = "CreateStructPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["CreateStructArrayProperty"] = 196677] = "CreateStructArrayProperty";
+    ECEditingStatus[ECEditingStatus["CreateStructArrayPropertyFromProps"] = 196678] = "CreateStructArrayPropertyFromProps";
+    ECEditingStatus[ECEditingStatus["DeleteProperty"] = 196679] = "DeleteProperty";
+    ECEditingStatus[ECEditingStatus["DeleteClass"] = 196680] = "DeleteClass";
+    ECEditingStatus[ECEditingStatus["SetClassName"] = 196681] = "SetClassName";
+    ECEditingStatus[ECEditingStatus["AddSchemaReference"] = 196682] = "AddSchemaReference";
+    ECEditingStatus[ECEditingStatus["SetSchemaVersion"] = 196683] = "SetSchemaVersion";
+    ECEditingStatus[ECEditingStatus["IncrementSchemaMinorVersion"] = 196684] = "IncrementSchemaMinorVersion";
+})(ECEditingStatus || (exports.ECEditingStatus = ECEditingStatus = {}));
+var TaskType;
+(function (TaskType) {
+    TaskType[TaskType["Add"] = 0] = "Add";
+    TaskType[TaskType["Create"] = 1] = "Create";
+    TaskType[TaskType["Update"] = 2] = "Update";
+    TaskType[TaskType["Change"] = 3] = "Change";
+    TaskType[TaskType["Delete"] = 4] = "Delete";
+})(TaskType || (exports.TaskType = TaskType = {}));
+var PropertyTypeName;
+(function (PropertyTypeName) {
+    PropertyTypeName["ArrayProperty"] = "ArrayProperty";
+    PropertyTypeName["PrimitiveProperty"] = "PrimitiveProperty";
+    PropertyTypeName["EnumerationProperty"] = "EnumerationProperty";
+    PropertyTypeName["NavigationProperty"] = "NavigationProperty";
+    PropertyTypeName["StructProperty"] = "StructProperty";
+})(PropertyTypeName || (exports.PropertyTypeName = PropertyTypeName = {}));
+class SchemaId {
+    constructor(schemaKey) {
+        this.name = schemaKey.name;
+        this.schemaKey = schemaKey;
+    }
+}
+exports.SchemaId = SchemaId;
+class SchemaItemId {
+    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 ecschema_metadata_1.SchemaItemKey(schemaItemKeyOrName, schemaKey);
+        }
+        else {
+            this.schemaKey = schemaItemKeyOrName.schemaKey;
+            this.schemaItemKey = schemaItemKeyOrName;
+        }
+        this.type = schemaItemType;
+        this.name = this.schemaItemKey.fullName;
+    }
+}
+exports.SchemaItemId = SchemaItemId;
+class ClassId extends SchemaItemId {
+    constructor(schemaItemType, schemaItemKeyOrName, schemaKey) {
+        super(schemaItemType, schemaItemKeyOrName, schemaKey);
+    }
+}
+exports.ClassId = ClassId;
+class PropertyId {
+    constructor(schemaItemType, classKey, property, typeName) {
+        this.name = property instanceof ecschema_metadata_1.Property ? property.name : property;
+        this.fullName = property instanceof ecschema_metadata_1.Property ? property.fullName : `${classKey.name}.${property}`;
+        this.ecClass = new ClassId(schemaItemType, classKey);
+        this.schemaKey = classKey.schemaKey;
+        this.typeName = typeName;
+    }
+}
+exports.PropertyId = PropertyId;
+class EnumerationId extends SchemaItemId {
+    constructor(enumeration, enumerator) {
+        super(ecschema_metadata_1.SchemaItemType.Enumeration, enumeration.key);
+        this.enumerationType = enumeration.type ? (0, ecschema_metadata_1.primitiveTypeToString)(enumeration.type) : "string";
+        this.enumeratorName = typeof (enumerator) === "string" ? enumerator : enumerator.name;
+        this.enumeratorType = this.getEnumeratorType(enumeration, enumerator);
+    }
+    getEnumeratorType(enumeration, enumerator) {
+        if (typeof (enumerator) === "string")
+            return enumeration.isString ? "string" : "int";
+        return typeof (enumerator.value) === "string" ? "string" : "int";
+    }
+}
+exports.EnumerationId = EnumerationId;
+class CustomAttributeId {
+    constructor(name, container) {
+        this.name = name;
+        this.schemaKey = container.schema.schemaKey;
+        this.containerFullName = container.fullName;
+    }
+}
+exports.CustomAttributeId = CustomAttributeId;
+class RelationshipConstraintId {
+    constructor(constraint) {
+        this.name = constraint.fullName;
+        this.relationshipKey = constraint.relationshipClass.key;
+        this.schemaKey = this.relationshipKey.schemaKey;
+    }
+}
+exports.RelationshipConstraintId = RelationshipConstraintId;
+/**
+ * Indicates if the given identifier is a SchemaId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+function isSchemaIdentifier(identifier) {
+    return identifier instanceof SchemaId;
+}
+exports.isSchemaIdentifier = isSchemaIdentifier;
+/**
+ * Indicates if the given identifier is a SchemaId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+function isSchemaItemIdentifier(identifier) {
+    return identifier instanceof SchemaItemId;
+}
+exports.isSchemaItemIdentifier = isSchemaItemIdentifier;
+/**
+ * Indicates if the given identifier is a ClassId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+function isClassIdentifier(identifier) {
+    return identifier instanceof ClassId;
+}
+exports.isClassIdentifier = isClassIdentifier;
+/**
+ * Indicates if the given identifier is a PropertyId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+function isPropertyIdentifier(identifier) {
+    return identifier instanceof PropertyId;
+}
+exports.isPropertyIdentifier = isPropertyIdentifier;
+/**
+ * Indicates if the given identifier is a EnumerationId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+function isEnumerationIdentifier(identifier) {
+    return identifier instanceof EnumerationId;
+}
+exports.isEnumerationIdentifier = isEnumerationIdentifier;
+/**
+ * Indicates if the given identifier is a CustomAttributeId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+function isCustomAttributeIdentifier(identifier) {
+    return identifier instanceof CustomAttributeId;
+}
+exports.isCustomAttributeIdentifier = isCustomAttributeIdentifier;
+/**
+ * Indicates if the given identifier is a RelationshipConstraintId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+function isRelationshipConstraintIdentifier(identifier) {
+    return identifier instanceof RelationshipConstraintId;
+}
+exports.isRelationshipConstraintIdentifier = isRelationshipConstraintIdentifier;
+/**
+ * @internal
+ * 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.
+ */
+class SchemaEditingError extends core_bentley_1.BentleyError {
+    /**
+     * 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(errorNumber, 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 (!isSchemaIdentifier(this.identifier))
+            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 (!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 (!isClassIdentifier(this.identifier))
+            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 (!isPropertyIdentifier(this.identifier))
+            throw new Error("identifier is not a PropertyId.");
+        return this.identifier;
+    }
+    /**
+     * Gets the EnumerationId instance.
+     * @throws Error if the identifier is not an instance of EnumerationId.
+     */
+    get enumerationId() {
+        if (!isEnumerationIdentifier(this.identifier))
+            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 (!isCustomAttributeIdentifier(this.identifier))
+            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 (!isRelationshipConstraintIdentifier(this.identifier))
+            throw new Error("identifier is not a RelationshipConstraintId.");
+        return this.identifier;
+    }
+    get ruleViolations() {
+        return this._ruleViolations;
+    }
+    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;
+    }
+    _appendMessage(e) {
+        return this.message ? `${e}: ${this.message}` : e;
+    }
+    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.type} ${this.schemaItemId.name} could not be found in the schema ${this._schemaKey.name}.`;
+                return;
+            case ECEditingStatus.SchemaItemNotFoundInContext:
+                this.message = `${this.schemaItemId.type} ${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.type}.`;
+                return;
+            case ECEditingStatus.SchemaItemNameNotSpecified:
+                this.message = `Could not create a new ${this.schemaItemId.type} in schema ${this._schemaKey.name}. No name was supplied within props.`;
+                return;
+            case ECEditingStatus.SchemaItemNameAlreadyExists:
+                this.message = `${this.schemaItemId.type} ${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.enumerationId.name} has type ${this.enumerationId.enumerationType}, while Enumerator ${this.enumerationId.enumeratorName} has type ${this.enumerationId.enumeratorType}.`;
+                return;
+            case ECEditingStatus.EnumeratorDoesNotExist:
+                this.message = `Enumerator ${this.enumerationId.enumeratorName} does not exists in Enumeration ${this.enumerationId.name}.`;
+                return;
+            case ECEditingStatus.InvalidECName:
+                this.message = `Could not rename class ${this.schemaItemId.name} because the specified name is not a valid ECName.`;
+                return;
+        }
+    }
+    getRuleViolationMessage() {
+        if (!this._ruleViolations)
+            return "";
+        let violations = "";
+        for (const diagnostic of this._ruleViolations) {
+            violations += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
+        }
+        if (isSchemaIdentifier(this.identifier))
+            return `Rule violations occurred from Schema ${this.schemaId.name}: ${violations}`;
+        if (isSchemaItemIdentifier(this.identifier))
+            return `Rule violations occurred from ${this.schemaItemId.type} ${this.schemaItemId.name}: ${violations}`;
+        if (isCustomAttributeIdentifier(this.identifier))
+            return `Rule violations occurred from CustomAttribute ${this.customAttributeId.name}, container ${this.customAttributeId.containerFullName}: ${violations}`;
+        if (isRelationshipConstraintIdentifier(this.identifier))
+            return `Rule violations occurred from constraint ${this.relationshipConstraintId.name} of RelationshipClass ${this.relationshipConstraintId.relationshipKey.fullName}: ${violations}`;
+        throw new Error("Could not generate rule violation message due to invalid identifier.");
+    }
+}
+exports.SchemaEditingError = SchemaEditingError;
+//# sourceMappingURL=Exception.js.map

package/lib/cjs/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;;;AAEH,sDAAmD;AAEnD,gEAAwM;AAExM,aAAa;AACb,IAAY,eAgFX;AAhFD,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,kGAAwB,CAAA;IACxB,4EAAa,CAAA;IACb,wGAA2B,CAAA;IAC3B,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,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;AAC7B,CAAC,EAhFW,eAAe,+BAAf,eAAe,QAgF1B;AAID,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,qCAAG,CAAA;IACH,2CAAM,CAAA;IACN,2CAAM,CAAA;IACN,2CAAM,CAAA;IACN,2CAAM,CAAA;AACR,CAAC,EANW,QAAQ,wBAAR,QAAQ,QAMnB;AAED,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,gCAAhB,gBAAgB,QAM3B;AAQD,MAAa,QAAQ;IAGnB,YAAY,SAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;CACF;AAPD,4BAOC;AAED,MAAa,YAAY;IAKvB,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,iCAAa,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,IAAI,GAAG,cAAc,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;IAC1C,CAAC;CACF;AApBD,oCAoBC;AAED,MAAa,OAAQ,SAAQ,YAAY;IACvC,YAAY,cAAkC,EAAE,mBAA2C,EAAE,SAAqB;QAChH,KAAK,CAAC,cAAc,EAAE,mBAAmB,EAAE,SAAS,CAAC,CAAC;IACxD,CAAC;CACF;AAJD,0BAIC;AAED,MAAa,UAAU;IAOrB,YAAY,cAAkC,EAAE,QAAuB,EAAE,QAA2B,EAAE,QAA2B;QAC/H,IAAI,CAAC,IAAI,GAAG,QAAQ,YAAY,4BAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;QACpE,IAAI,CAAC,QAAQ,GAAG,QAAQ,YAAY,4BAAQ,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;AAdD,gCAcC;AAED,MAAa,aAAc,SAAQ,YAAY;IAI7C,YAAY,WAAwB,EAAE,UAAkC;QACtE,KAAK,CAAC,kCAAc,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,yCAAqB,EAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC7F,IAAI,CAAC,cAAc,GAAG,OAAM,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;QACrF,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;IAEO,iBAAiB,CAAC,WAAwB,EAAE,UAAkC;QACpF,IAAI,OAAM,CAAC,UAAU,CAAC,KAAK,QAAQ;YACjC,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;QAEjD,OAAO,OAAM,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;IAClE,CAAC;CACF;AAjBD,sCAiBC;AAED,MAAa,iBAAiB;IAI5B,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;AATD,8CASC;AAED,MAAa,wBAAwB;IAInC,YAAY,UAAkC;QAC5C,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;IAClD,CAAC;CACF;AATD,4DASC;AAID;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,UAAyB;IAC1D,OAAO,UAAU,YAAY,QAAQ,CAAC;AACxC,CAAC;AAFD,gDAEC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,UAAyB;IAC9D,OAAO,UAAU,YAAY,YAAY,CAAC;AAC5C,CAAC;AAFD,wDAEC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,UAAyB;IACzD,OAAO,UAAU,YAAY,OAAO,CAAC;AACvC,CAAC;AAFD,8CAEC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,UAAyB;IAC5D,OAAO,UAAU,YAAY,UAAU,CAAC;AAC1C,CAAC;AAFD,oDAEC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,UAAyB;IAC/D,OAAO,UAAU,YAAY,aAAa,CAAC;AAC7C,CAAC;AAFD,0DAEC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CAAC,UAAyB;IACnE,OAAO,UAAU,YAAY,iBAAiB,CAAC;AACjD,CAAC;AAFD,kEAEC;AAED;;;;GAIG;AACH,SAAgB,kCAAkC,CAAC,UAAyB;IAC1E,OAAO,UAAU,YAAY,wBAAwB,CAAC;AACxD,CAAC;AAFD,gFAEC;AAED;;;;;;;GAOG;AACH,MAAa,kBAAmB,SAAQ,2BAAY;IAIlD;;;;;;;OAOG;IACH,YAA4C,WAAmB,EAAkB,UAAyB,EAAkB,UAA4B,EAAE,cAAgC,EAAE,OAAgB;QAC1M,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QADc,gBAAW,GAAX,WAAW,CAAQ;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,IAAW,QAAQ;QACjB,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,UAA0B,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACrB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,UAA0B,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,IAAW,OAAO;QAChB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,UAAU;QACnB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,aAAa;QACtB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,iBAAiB;QAC1B,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,wBAAwB;QACjC,IAAI,CAAC,kCAAkC,CAAC,IAAI,CAAC,UAAU,CAAC;YACtD,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAEM,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,kBAAkB,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC;;gBAEnE,YAAY,GAAG,kBAAkB,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;IACpG,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,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,YAAY,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,qCAAqC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC;gBAC/H,OAAO;YACT,KAAK,eAAe,CAAC,2BAA2B;gBAC9C,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,4CAA4C,CAAC;gBAC/G,OAAO;YACT,KAAK,eAAe,CAAC,qBAAqB;gBACxC,IAAI,CAAC,OAAO,GAAG,YAAY,IAAI,CAAC,YAAY,CAAC,IAAI,kBAAkB,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC;gBAC7F,OAAO;YACT,KAAK,eAAe,CAAC,0BAA0B;gBAC7C,IAAI,CAAC,OAAO,GAAG,0BAA0B,IAAI,CAAC,YAAY,CAAC,IAAI,cAAc,IAAI,CAAC,UAAU,CAAC,IAAI,sCAAsC,CAAC;gBACxI,OAAO;YACT,KAAK,eAAe,CAAC,2BAA2B;gBAC9C,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,iCAAiC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC;gBAC3H,OAAO;YACT,KAAK,eAAe,CAAC,aAAa;gBAChC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;gBAC9C,OAAO;YACT,KAAK,eAAe,CAAC,gBAAgB;gBACnC,IAAI,CAAC,OAAO,GAAG,+BAA+B,IAAI,CAAC,UAAU,CAAC,IAAI,oCAAoC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;gBACtI,OAAO;YACT,KAAK,eAAe,CAAC,qBAAqB;gBACxC,IAAI,CAAC,OAAO,GAAG,+BAA+B,IAAI,CAAC,UAAU,CAAC,IAAI,gCAAgC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;gBAClI,OAAO;YACT,KAAK,eAAe,CAAC,mBAAmB;gBACtC,IAAI,CAAC,OAAO,GAAG,qBAAqB,IAAI,CAAC,UAAU,CAAC,IAAI,kBAAkB,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,CAAC;gBACtG,OAAO;YACT,KAAK,eAAe,CAAC,qBAAqB;gBACxC,IAAI,CAAC,OAAO,GAAG,uBAAuB,IAAI,CAAC,YAAY,CAAC,IAAI,kCAAkC,CAAC;gBAC/F,OAAO;YACT,KAAK,eAAe,CAAC,iCAAiC;gBACpD,IAAI,CAAC,OAAO,GAAG,uBAAuB,IAAI,CAAC,YAAY,CAAC,IAAI,8CAA8C,CAAC;gBAC3G,OAAO;YACT,KAAK,eAAe,CAAC,gCAAgC;gBACnD,IAAI,CAAC,OAAO,GAAG,uBAAuB,IAAI,CAAC,YAAY,CAAC,IAAI,6CAA6C,CAAC;gBAC1G,OAAO;YACT,KAAK,eAAe,CAAC,2BAA2B;gBAC9C,IAAI,CAAC,OAAO,GAAG,6BAA6B,IAAI,CAAC,YAAY,CAAC,IAAI,sCAAsC,CAAC;gBACzG,OAAO;YACT,KAAK,eAAe,CAAC,qBAAqB;gBACxC,IAAI,CAAC,OAAO,GAAG,mBAAmB,IAAI,CAAC,aAAa,CAAC,IAAI,aAAa,IAAI,CAAC,aAAa,CAAC,eAAe,sBAAsB,IAAI,CAAC,aAAa,CAAC,cAAc,aAAa,IAAI,CAAC,aAAa,CAAC,cAAc,GAAG,CAAC;gBACjN,OAAO;YACT,KAAK,eAAe,CAAC,sBAAsB;gBACzC,IAAI,CAAC,OAAO,GAAG,cAAc,IAAI,CAAC,aAAa,CAAC,cAAc,mCAAmC,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC;gBAC5H,OAAO;YACT,KAAK,eAAe,CAAC,aAAa;gBAChC,IAAI,CAAC,OAAO,GAAG,0BAA0B,IAAI,CAAC,YAAY,CAAC,IAAI,oDAAoD,CAAC;gBACpH,OAAO;QACX,CAAC;IACH,CAAC;IAEO,uBAAuB;QAC7B,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,IAAI,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;YACrC,OAAO,wCAAwC,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAErF,IAAI,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YACzC,OAAO,iCAAiC,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAE5G,IAAI,2BAA2B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC9C,OAAO,iDAAiD,IAAI,CAAC,iBAAiB,CAAC,IAAI,eAAe,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;QAE9J,IAAI,kCAAkC,CAAC,IAAI,CAAC,UAAU,CAAC;YACrD,OAAO,4CAA4C,IAAI,CAAC,wBAAwB,CAAC,IAAI,yBAAyB,IAAI,CAAC,wBAAwB,CAAC,eAAe,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QAExL,MAAM,IAAI,KAAK,CAAE,sEAAsE,CAAC,CAAC;IAC3F,CAAC;CACF;AA9LD,gDA8LC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Editing\r\n */\r\n\r\nimport { BentleyError } from \"@itwin/core-bentley\";\r\nimport { AnyDiagnostic } from \"../Validation/Diagnostic\";\r\nimport { AnyEnumerator, CustomAttributeContainerProps, Enumeration, primitiveTypeToString, Property, RelationshipConstraint, SchemaItemKey, SchemaItemType, SchemaKey } from \"@itwin/ecschema-metadata\";\r\n\r\n/** @alpha */\r\nexport enum ECEditingStatus {\r\n  EC_EDITING_ERROR_BASE = 0x30000,\r\n  Unknown = 0,\r\n  RuleViolation = EC_EDITING_ERROR_BASE + 1,\r\n  SchemaNotFound,\r\n  SchemaItemNotFound,\r\n  SchemaItemNotFoundInContext,\r\n  PropertyAlreadyExists,\r\n  PropertyNotFound,\r\n  InvalidPropertyType,\r\n  BaseClassIsNotElement,\r\n  BaseClassIsNotElementUniqueAspect,\r\n  BaseClassIsNotElementMultiAspect,\r\n  SchemaItemNameNotSpecified,\r\n  InvalidSchemaItemType,\r\n  SchemaItemNameAlreadyExists,\r\n  InvalidEnumeratorType,\r\n  InvalidBaseClass,\r\n  EnumeratorDoesNotExist,\r\n  InvalidStrengthDirection,\r\n  InvalidECName,\r\n  InvalidFormatUnitsSpecified,\r\n  // Outer Errors\r\n  CreateSchemaItemFailed,\r\n  CreateSchemaItemFromProps,\r\n  CreateElement,\r\n  CreateElementUniqueAspect,\r\n  CreateElementMultiAspect,\r\n  SetBaseClass,\r\n  SetSourceConstraint,\r\n  SetTargetConstraint,\r\n  AddConstraintClass,\r\n  RemoveConstraintClass,\r\n  SetAbstractConstraint,\r\n  AddCustomAttributeToConstraint,\r\n  AddCustomAttributeToProperty,\r\n  AddCustomAttributeToClass,\r\n  CreateNavigationProperty,\r\n  CreateNavigationPropertyFromProps,\r\n  SetInvertsUnit,\r\n  SetUnitSystem,\r\n  SetDescription,\r\n  SetLabel,\r\n  SetIsReadOnly,\r\n  SetPriority,\r\n  SetCategory,\r\n  SetMinOccurs,\r\n  SetMaxOccurs,\r\n  SetExtendedTypeName,\r\n  SetMinLength,\r\n  SetMaxLength,\r\n  SetMinValue,\r\n  SetMaxValue,\r\n  SetPropertyName,\r\n  AddMixin,\r\n  AddEnumerator,\r\n  SetEnumeratorLabel,\r\n  SetEnumeratorDescription,\r\n  AddPresentationUnit,\r\n  AddPresentationOverride,\r\n  CreateFormatOverride,\r\n  SetPropertyCategoryPriority,\r\n  CreatePrimitiveProperty,\r\n  CreatePrimitivePropertyFromProps,\r\n  CreateEnumerationProperty,\r\n  CreateEnumerationPropertyFromProps,\r\n  CreatePrimitiveArrayProperty,\r\n  CreatePrimitiveArrayPropertyFromProps,\r\n  CreateEnumerationArrayProperty,\r\n  CreateEnumerationArrayPropertyFromProps,\r\n  CreateStructProperty,\r\n  CreateStructPropertyFromProps,\r\n  CreateStructArrayProperty,\r\n  CreateStructArrayPropertyFromProps,\r\n  DeleteProperty,\r\n  DeleteClass,\r\n  SetClassName,\r\n  AddSchemaReference,\r\n  SetSchemaVersion,\r\n  IncrementSchemaMinorVersion,\r\n}\r\n\r\nexport type AnyEditingError = SchemaEditingError | Error;\r\n\r\nexport enum TaskType {\r\n  Add,\r\n  Create,\r\n  Update,\r\n  Change,\r\n  Delete\r\n}\r\n\r\nexport enum PropertyTypeName {\r\n  ArrayProperty = \"ArrayProperty\",\r\n  PrimitiveProperty = \"PrimitiveProperty\",\r\n  EnumerationProperty = \"EnumerationProperty\",\r\n  NavigationProperty = \"NavigationProperty\",\r\n  StructProperty = \"StructProperty\"\r\n}\r\n\r\ntype ECClassSchemaItems = SchemaItemType.EntityClass | SchemaItemType.StructClass | SchemaItemType.RelationshipClass | SchemaItemType.Mixin | SchemaItemType.CustomAttributeClass;\r\n\r\nexport interface SchemaTypeIdentifier {\r\n  name: string;\r\n}\r\n\r\nexport class SchemaId implements SchemaTypeIdentifier {\r\n  public readonly name: string;\r\n  public readonly schemaKey: SchemaKey;\r\n  constructor(schemaKey: SchemaKey) {\r\n    this.name = schemaKey.name;\r\n    this.schemaKey = schemaKey;\r\n  }\r\n}\r\n\r\nexport class SchemaItemId implements SchemaTypeIdentifier {\r\n  public readonly name: string;\r\n  public readonly type: SchemaItemType;\r\n  public readonly schemaKey: SchemaKey;\r\n  public readonly schemaItemKey: SchemaItemKey;\r\n  constructor(schemaItemType: SchemaItemType, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey) {\r\n    if (typeof(schemaItemKeyOrName) === \"string\") {\r\n      if (!schemaKey)\r\n        throw new Error(\"schemaKey if required if the specified schemaItem the name of the schema item.\");\r\n\r\n      this.schemaKey = schemaKey!;\r\n      this.schemaItemKey = new SchemaItemKey(schemaItemKeyOrName, schemaKey);\r\n    } else {\r\n      this.schemaKey = schemaItemKeyOrName.schemaKey;\r\n      this.schemaItemKey = schemaItemKeyOrName;\r\n    }\r\n\r\n    this.type = schemaItemType;\r\n    this.name = this.schemaItemKey.fullName;\r\n  }\r\n}\r\n\r\nexport class ClassId extends SchemaItemId {\r\n  constructor(schemaItemType: ECClassSchemaItems, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey) {\r\n    super(schemaItemType, schemaItemKeyOrName, schemaKey);\r\n  }\r\n}\r\n\r\nexport class PropertyId implements SchemaTypeIdentifier {\r\n  public readonly name: string;\r\n  public readonly fullName: string;\r\n  public readonly ecClass: ClassId;\r\n  public readonly schemaKey: SchemaKey;\r\n  public readonly typeName?: PropertyTypeName;\r\n\r\n  constructor(schemaItemType: ECClassSchemaItems, classKey: SchemaItemKey, property: Property | string, typeName?: PropertyTypeName) {\r\n    this.name = property instanceof Property ? property.name : property;\r\n    this.fullName = property instanceof Property ? property.fullName : `${classKey.name}.${property}`;\r\n    this.ecClass = new ClassId(schemaItemType, classKey);\r\n    this.schemaKey = classKey.schemaKey;\r\n    this.typeName = typeName;\r\n  }\r\n}\r\n\r\nexport class EnumerationId extends SchemaItemId {\r\n  public readonly enumerationType: string;\r\n  public readonly enumeratorName: string;\r\n  public readonly enumeratorType: string;\r\n  constructor(enumeration: Enumeration, enumerator: AnyEnumerator | string) {\r\n    super(SchemaItemType.Enumeration, enumeration.key);\r\n    this.enumerationType = enumeration.type ? primitiveTypeToString(enumeration.type) : \"string\";\r\n    this.enumeratorName = typeof(enumerator) === \"string\" ? enumerator : enumerator.name;\r\n    this.enumeratorType = this.getEnumeratorType(enumeration, enumerator);\r\n  }\r\n\r\n  private getEnumeratorType(enumeration: Enumeration, enumerator: AnyEnumerator | string) {\r\n    if (typeof(enumerator) === \"string\")\r\n      return enumeration.isString ? \"string\" : \"int\";\r\n\r\n    return typeof(enumerator.value) === \"string\" ? \"string\" : \"int\";\r\n  }\r\n}\r\n\r\nexport class CustomAttributeId implements SchemaTypeIdentifier {\r\n  public readonly name: string;\r\n  public readonly schemaKey: SchemaKey;\r\n  public readonly containerFullName: string;\r\n  constructor(name: string, container: CustomAttributeContainerProps) {\r\n    this.name = name;\r\n    this.schemaKey = container.schema.schemaKey;\r\n    this.containerFullName = container.fullName;\r\n  }\r\n}\r\n\r\nexport class RelationshipConstraintId implements SchemaTypeIdentifier {\r\n  public readonly name: string;\r\n  public readonly relationshipKey: SchemaItemKey;\r\n  public readonly schemaKey: SchemaKey;\r\n  constructor(constraint: RelationshipConstraint) {\r\n    this.name = constraint.fullName;\r\n    this.relationshipKey = constraint.relationshipClass.key;\r\n    this.schemaKey = this.relationshipKey.schemaKey;\r\n  }\r\n}\r\n\r\ntype AnyIdentifier = SchemaId | PropertyId | CustomAttributeId | RelationshipConstraintId | EnumerationId;\r\n\r\n/**\r\n * Indicates if the given identifier is a SchemaId instance.\r\n * @param identifier The identifier to check.\r\n * @returns true if the identifier is the correct type.\r\n */\r\nexport function isSchemaIdentifier(identifier: AnyIdentifier): identifier is SchemaId {\r\n  return identifier instanceof SchemaId;\r\n}\r\n\r\n/**\r\n * Indicates if the given identifier is a SchemaId instance.\r\n * @param identifier The identifier to check.\r\n * @returns true if the identifier is the correct type.\r\n */\r\nexport function isSchemaItemIdentifier(identifier: AnyIdentifier): identifier is SchemaItemId {\r\n  return identifier instanceof SchemaItemId;\r\n}\r\n\r\n/**\r\n * Indicates if the given identifier is a ClassId instance.\r\n * @param identifier The identifier to check.\r\n * @returns true if the identifier is the correct type.\r\n */\r\nexport function isClassIdentifier(identifier: AnyIdentifier): identifier is ClassId {\r\n  return identifier instanceof ClassId;\r\n}\r\n\r\n/**\r\n * Indicates if the given identifier is a PropertyId instance.\r\n * @param identifier The identifier to check.\r\n * @returns true if the identifier is the correct type.\r\n */\r\nexport function isPropertyIdentifier(identifier: AnyIdentifier): identifier is PropertyId {\r\n  return identifier instanceof PropertyId;\r\n}\r\n\r\n/**\r\n * Indicates if the given identifier is a EnumerationId instance.\r\n * @param identifier The identifier to check.\r\n * @returns true if the identifier is the correct type.\r\n */\r\nexport function isEnumerationIdentifier(identifier: AnyIdentifier): identifier is EnumerationId {\r\n  return identifier instanceof EnumerationId;\r\n}\r\n\r\n/**\r\n * Indicates if the given identifier is a CustomAttributeId instance.\r\n * @param identifier The identifier to check.\r\n * @returns true if the identifier is the correct type.\r\n */\r\nexport function isCustomAttributeIdentifier(identifier: AnyIdentifier): identifier is CustomAttributeId {\r\n  return identifier instanceof CustomAttributeId;\r\n}\r\n\r\n/**\r\n * Indicates if the given identifier is a RelationshipConstraintId instance.\r\n * @param identifier The identifier to check.\r\n * @returns true if the identifier is the correct type.\r\n */\r\nexport function isRelationshipConstraintIdentifier(identifier: AnyIdentifier): identifier is RelationshipConstraintId {\r\n  return identifier instanceof RelationshipConstraintId;\r\n}\r\n\r\n/**\r\n * @internal\r\n * An exception class for the ecschema-editing API. Contains identifiers for schema types involved in the\r\n * exception. An example being SchemaItemId which contains the name of the SchemaItem, SchemaItemKey, SchemaItemType, etc.\r\n * Typically will contain an innerError of type SchemaEditingError containing the identifier of the schema item that\r\n * caused the exception. The containing error instance will identify the method called (identified by the errorNumber)\r\n * and the identifier of the schema item being modified/created.\r\n */\r\nexport class SchemaEditingError extends BentleyError {\r\n  private _ruleViolations?: AnyDiagnostic[];\r\n  private _schemaKey: SchemaKey;\r\n\r\n  /**\r\n   * Constructs a new SchemaEditingError instance.\r\n   * @param errorNumber The unique ECEditingStatus code identifying the error.\r\n   * @param identifier The identifier instance containing information about the EC object involved with the exception.\r\n   * @param innerError The SchemaEditingError containing the identifier of the EC object that caused the initial exception.\r\n   * @param ruleViolations Will contain EC rule violations of type [[AnyDiagnostic]] for exceptions with the error code ECEditingStatus.RuleViolation.\r\n   * @param message Optional error message. Most messages on automatically generated by this class based on the ECEditingStatus code.\r\n   */\r\n  public constructor(public override readonly errorNumber: number, public readonly identifier: AnyIdentifier, public readonly innerError?: AnyEditingError, ruleViolations?: AnyDiagnostic[], message?: string) {\r\n    super(errorNumber, message);\r\n    this._ruleViolations = ruleViolations;\r\n    this._schemaKey = identifier.schemaKey,\r\n    this.generateMessage();\r\n  }\r\n\r\n  /**\r\n   * Gets the SchemaId instance.\r\n   * @throws Error if the identifier is not an instance of SchemaId.\r\n   */\r\n  public get schemaId(): SchemaId {\r\n    if (!isSchemaIdentifier(this.identifier))\r\n      throw new Error(\"identifier is not a SchemaId.\");\r\n    return this.identifier as SchemaItemId;\r\n  }\r\n\r\n  /**\r\n   * Gets the SchemaItemId instance.\r\n   * @throws Error if the identifier is not an instance of SchemaItemId.\r\n   */\r\n  public get schemaItemId(): SchemaItemId {\r\n    if (!isSchemaItemIdentifier(this.identifier))\r\n      throw new Error(\"identifier is not a SchemaItemId.\");\r\n    return this.identifier as SchemaItemId;\r\n  }\r\n\r\n  /**\r\n   * Gets the ClassId instance.\r\n   * @throws Error if the identifier is not an instance of ClassId.\r\n   */\r\n  public get classId(): ClassId {\r\n    if (!isClassIdentifier(this.identifier))\r\n      throw new Error(\"identifier is not a ClassId.\");\r\n    return this.identifier;\r\n  }\r\n\r\n  /**\r\n   * Gets the PropertyId instance.\r\n   * @throws Error if the identifier is not an instance of PropertyId.\r\n   */\r\n  public get propertyId(): PropertyId {\r\n    if (!isPropertyIdentifier(this.identifier))\r\n      throw new Error(\"identifier is not a PropertyId.\");\r\n    return this.identifier;\r\n  }\r\n\r\n  /**\r\n   * Gets the EnumerationId instance.\r\n   * @throws Error if the identifier is not an instance of EnumerationId.\r\n   */\r\n  public get enumerationId(): EnumerationId {\r\n    if (!isEnumerationIdentifier(this.identifier))\r\n      throw new Error(\"identifier is not a EnumerationId.\");\r\n    return this.identifier;\r\n  }\r\n\r\n  /**\r\n   * Gets the CustomAttributeId instance.\r\n   * @throws Error if the identifier is not an instance of CustomAttributeId.\r\n   */\r\n  public get customAttributeId(): CustomAttributeId {\r\n    if (!isCustomAttributeIdentifier(this.identifier))\r\n      throw new Error(\"identifier is not a CustomAttributeId.\");\r\n    return this.identifier;\r\n  }\r\n\r\n  /**\r\n   * Gets the RelationshipConstraintId instance.\r\n   * @throws Error if the identifier is not an instance of RelationshipConstraintId.\r\n   */\r\n  public get relationshipConstraintId(): RelationshipConstraintId {\r\n    if (!isRelationshipConstraintIdentifier(this.identifier))\r\n      throw new Error(\"identifier is not a RelationshipConstraintId.\");\r\n    return this.identifier;\r\n  }\r\n\r\n  public get ruleViolations(): AnyDiagnostic[] | undefined {\r\n    return this._ruleViolations;\r\n  }\r\n\r\n  public toDebugString(): string {\r\n    let innerMessage = \"\";\r\n    if (this.innerError) {\r\n      if (this.innerError instanceof SchemaEditingError)\r\n        innerMessage = `: Inner error: ${this.innerError.toDebugString()}`;\r\n      else\r\n        innerMessage = `: Inner error: ${this.innerError.message}`;\r\n    }\r\n    return this._appendMessage(`ECEditingStatus.${ECEditingStatus[this.errorNumber]}`) + innerMessage;\r\n  }\r\n\r\n  private _appendMessage(e: string) {\r\n    return this.message ? `${e}: ${this.message}` : e;\r\n  }\r\n\r\n  private generateMessage() {\r\n    if (this.message)\r\n      return;\r\n\r\n    switch(this.errorNumber) {\r\n      case ECEditingStatus.SchemaNotFound:\r\n        this.message = `Schema Key ${this._schemaKey.toString(true)} could not be found in the context.`;\r\n        return;\r\n      case ECEditingStatus.SchemaItemNotFound:\r\n        this.message = `${this.schemaItemId.type} ${this.schemaItemId.name} could not be found in the schema ${this._schemaKey.name}.`;\r\n        return;\r\n      case ECEditingStatus.SchemaItemNotFoundInContext:\r\n        this.message = `${this.schemaItemId.type} ${this.schemaItemId.name} could not be found in the schema context.`;\r\n        return;\r\n      case ECEditingStatus.InvalidSchemaItemType:\r\n        this.message = `Expected ${this.schemaItemId.name} to be of type ${this.schemaItemId.type}.`;\r\n        return;\r\n      case ECEditingStatus.SchemaItemNameNotSpecified:\r\n        this.message = `Could not create a new ${this.schemaItemId.type} in schema ${this._schemaKey.name}. No name was supplied within props.`;\r\n        return;\r\n      case ECEditingStatus.SchemaItemNameAlreadyExists:\r\n        this.message = `${this.schemaItemId.type} ${this.schemaItemId.name} already exists in the schema ${this._schemaKey.name}.`;\r\n        return;\r\n      case ECEditingStatus.RuleViolation:\r\n        this.message = this.getRuleViolationMessage();\r\n        return;\r\n      case ECEditingStatus.PropertyNotFound:\r\n        this.message = `An ECProperty with the name ${this.propertyId.name} could not be found in the class ${this.propertyId.ecClass.name}.`;\r\n        return;\r\n      case ECEditingStatus.PropertyAlreadyExists:\r\n        this.message = `An ECProperty with the name ${this.propertyId.name} already exists in the class ${this.propertyId.ecClass.name}.`;\r\n        return;\r\n      case ECEditingStatus.InvalidPropertyType:\r\n        this.message = `Expected property ${this.propertyId.name} to be of type ${this.propertyId.typeName}.`;\r\n        return;\r\n      case ECEditingStatus.BaseClassIsNotElement:\r\n        this.message = `Expected base class ${this.schemaItemId.name} to derive from BisCore.Element.`;\r\n        return;\r\n      case ECEditingStatus.BaseClassIsNotElementUniqueAspect:\r\n        this.message = `Expected base class ${this.schemaItemId.name} to derive from BisCore.ElementUniqueAspect.`;\r\n        return;\r\n      case ECEditingStatus.BaseClassIsNotElementMultiAspect:\r\n        this.message = `Expected base class ${this.schemaItemId.name} to derive from BisCore.ElementMultiAspect.`;\r\n        return;\r\n      case ECEditingStatus.InvalidFormatUnitsSpecified:\r\n        this.message = `The specified Format unit ${this.schemaItemId.name} is not of type Unit or InvertedUnit`;\r\n        return;\r\n      case ECEditingStatus.InvalidEnumeratorType:\r\n        this.message = `The Enumeration ${this.enumerationId.name} has type ${this.enumerationId.enumerationType}, while Enumerator ${this.enumerationId.enumeratorName} has type ${this.enumerationId.enumeratorType}.`;\r\n        return;\r\n      case ECEditingStatus.EnumeratorDoesNotExist:\r\n        this.message = `Enumerator ${this.enumerationId.enumeratorName} does not exists in Enumeration ${this.enumerationId.name}.`;\r\n        return;\r\n      case ECEditingStatus.InvalidECName:\r\n        this.message = `Could not rename class ${this.schemaItemId.name} because the specified name is not a valid ECName.`;\r\n        return;\r\n    }\r\n  }\r\n\r\n  private getRuleViolationMessage(): string {\r\n    if (!this._ruleViolations)\r\n      return \"\";\r\n\r\n    let violations = \"\";\r\n    for (const diagnostic of this._ruleViolations) {\r\n      violations += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\r\n    }\r\n\r\n    if (isSchemaIdentifier(this.identifier))\r\n      return `Rule violations occurred from Schema ${this.schemaId.name}: ${violations}`;\r\n\r\n    if (isSchemaItemIdentifier(this.identifier))\r\n      return `Rule violations occurred from ${this.schemaItemId.type} ${this.schemaItemId.name}: ${violations}`;\r\n\r\n    if (isCustomAttributeIdentifier(this.identifier))\r\n      return `Rule violations occurred from CustomAttribute ${this.customAttributeId.name}, container ${this.customAttributeId.containerFullName}: ${violations}`;\r\n\r\n    if (isRelationshipConstraintIdentifier(this.identifier))\r\n      return `Rule violations occurred from constraint ${this.relationshipConstraintId.name} of RelationshipClass ${this.relationshipConstraintId.relationshipKey.fullName}: ${violations}`;\r\n\r\n    throw new Error (\"Could not generate rule violation message due to invalid identifier.\");\r\n  }\r\n}\r\n"]}

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

@@ -3,20 +3,20 @@
  */
 import { SchemaItemFormatProps, SchemaItemKey, SchemaKey } from "@itwin/ecschema-metadata";
 import { FormatType } from "@itwin/core-quantity";
-import { SchemaContextEditor, SchemaItemEditResults } from "./Editor";
+import { SchemaContextEditor } from "./Editor";
+import { SchemaItems } from "./SchemaItems";
 /**
  * @alpha
  * A class allowing you to create schema items of type Format.
  */
-export declare class Formats {
-    protected _schemaEditor: SchemaContextEditor;
-    constructor(_schemaEditor: SchemaContextEditor);
-    create(schemaKey: SchemaKey, name: string, formatType: FormatType, displayLabel?: string, units?: SchemaItemKey[]): Promise<SchemaItemEditResults>;
+export declare class Formats extends SchemaItems {
+    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<SchemaItemEditResults>;
+    createFromProps(schemaKey: SchemaKey, formatProps: SchemaItemFormatProps): Promise<SchemaItemKey>;
 }
 //# sourceMappingURL=Formats.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Formats.d.ts","sourceRoot":"","sources":["../../../src/Editing/Formats.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAA4B,qBAAqB,EAAE,aAAa,EAAkB,SAAS,EAAQ,MAAM,0BAA0B,CAAC;AAC3I,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAGtE;;;GAGG;AACH,qBAAa,OAAO;IACC,SAAS,CAAC,aAAa,EAAE,mBAAmB;gBAAlC,aAAa,EAAE,mBAAmB;IAClD,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,qBAAqB,CAAC;IA8B/J;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAevH"}
+{"version":3,"file":"Formats.d.ts","sourceRoot":"","sources":["../../../src/Editing/Formats.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAoC,qBAAqB,EAAE,aAAa,EAAkB,SAAS,EAAQ,MAAM,0BAA0B,CAAC;AACnJ,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;gBACnB,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;IA0BvJ;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC;CAQ/G"}

package/lib/cjs/Editing/Formats.js

@@ -9,38 +9,36 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Formats = void 0;
 const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const Exception_1 = require("./Exception");
+const SchemaItems_1 = require("./SchemaItems");
 /**
  * @alpha
  * A class allowing you to create schema items of type Format.
  */
-class Formats {
-    constructor(_schemaEditor) {
-        this._schemaEditor = _schemaEditor;
+class Formats extends SchemaItems_1.SchemaItems {
+    constructor(schemaEditor) {
+        super(ecschema_metadata_1.SchemaItemType.Format, schemaEditor);
     }
     async create(schemaKey, name, formatType, displayLabel, units) {
-        const schema = await this._schemaEditor.getSchema(schemaKey);
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        const newFormat = (await schema.createFormat(name));
-        if (newFormat === undefined) {
-            return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };
-        }
-        if (units !== undefined) {
-            for (const unit of units) {
-                const unitItem = await this._schemaEditor.schemaContext.getSchemaItem(unit);
-                if (unitItem === undefined) {
-                    return { errorMessage: `Failed to locate unit ${unit.name} in Schema Context.` };
+        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.getSchemaItem(unit, null);
+                    if (unitItem.schemaItemType !== ecschema_metadata_1.SchemaItemType.Unit && unitItem.schemaItemType !== ecschema_metadata_1.SchemaItemType.InvertedUnit)
+                        throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.InvalidFormatUnitsSpecified, new Exception_1.SchemaItemId(unitItem.schemaItemType, unitItem.key));
+                    newFormat.addUnit(unitItem);
                 }
-                if (unitItem.schemaItemType !== ecschema_metadata_1.SchemaItemType.Unit && unitItem.schemaItemType !== ecschema_metadata_1.SchemaItemType.InvertedUnit)
-                    return { errorMessage: `${unitItem.fullName} is not of type Unit or InvertedUnit.` };
-                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 Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateSchemaItemFailed, new Exception_1.SchemaItemId(this.schemaItemType, name, schemaKey), e);
         }
-        if (displayLabel)
-            newFormat.setDisplayLabel(displayLabel);
-        // TODO: Handle the setting of format traits, separators, etc....
-        newFormat.setFormatType(formatType);
-        return { itemKey: newFormat.key };
     }
     /**
      * Creates a format through a SchemaItemFormatProps.
@@ -48,16 +46,13 @@ class Formats {
      * @param relationshipProps a json object that will be used to populate the new RelationshipClass. Needs a name value passed in.
      */
     async createFromProps(schemaKey, formatProps) {
-        const schema = await this._schemaEditor.getSchema(schemaKey);
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        if (formatProps.name === undefined)
-            return { errorMessage: `No name was supplied within props.` };
-        const newFormat = (await schema.createFormat(formatProps.name));
-        if (newFormat === undefined)
-            return { errorMessage: `Failed to create class ${formatProps.name} in schema ${schemaKey.toString(true)}.` };
-        await newFormat.fromJSON(formatProps);
-        return { itemKey: newFormat.key };
+        try {
+            const newFormat = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createFormat.bind(schema), formatProps);
+            return newFormat.key;
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateSchemaItemFromProps, new Exception_1.SchemaItemId(this.schemaItemType, formatProps.name, schemaKey), e);
+        }
     }
 }
 exports.Formats = Formats;