@itwin/ecschema-editing 5.0.0-dev.9 → 5.0.0-dev.92

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

@@ -0,0 +1 @@
+{"version":3,"file":"Enumerations.js","sourceRoot":"","sources":["../../../src/Editing/Enumerations.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAiB,WAAW,EAAkD,cAAc,EAAa,MAAM,0BAA0B,CAAC;AAGjJ,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAM5C;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C,IAAuB,aAAa;QAClC,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,YAAmB,YAAiC;QAClD,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,IAAkD,EAAE,YAAqB,EAAE,QAAkB,EAAE,WAA6B;QAClL,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAc,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAuB,CAAC;YAE9K,IAAI,SAAS,KAAK,QAAQ;gBACxB,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAEhC,IAAI,SAAS,KAAK,WAAW;gBAC3B,KAAK,MAAM,UAAU,IAAI,WAAW;oBAClC,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;YAEtD,IAAI,YAAY;gBACd,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAExC,OAAO,OAAO,CAAC,GAAG,CAAC;QACrB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,sBAAsB,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAClI,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,SAA2B;QAC5E,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;YACnJ,OAAO,OAAO,CAAC,GAAG,CAAC;QACrB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,yBAAyB,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,IAAK,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAChJ,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,cAA6B,EAAE,UAAyB;QACjF,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;YAE1E,IAAI,WAAW,CAAC,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,QAAQ;gBAC7D,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,qBAAqB,EAAE,IAAI,YAAY,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;YAEjH,IAAI,WAAW,CAAC,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,QAAQ;gBAChE,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,qBAAqB,EAAE,IAAI,YAAY,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;YAEhH,WAAkC,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAChE,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;QACxH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,cAA6B,EAAE,cAAsB,EAAE,KAAyB;QAC9G,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;YAE1E,MAAM,UAAU,GAAG,WAAW,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;YACnE,IAAI,UAAU,KAAK,SAAS;gBAC1B,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,sBAAsB,EAAE,IAAI,YAAY,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC;YAErH,UAAgC,CAAC,KAAK,GAAG,KAAK,CAAC;QAClD,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7H,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,cAA6B,EAAE,cAAsB,EAAE,WAA+B;QAC1H,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;YAE1E,MAAM,UAAU,GAAG,WAAW,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;YACnE,IAAI,UAAU,KAAK,SAAS;gBAC1B,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,sBAAsB,EAAE,IAAI,YAAY,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC;YAErH,UAAgC,CAAC,WAAW,GAAG,WAAW,CAAC;QAC9D,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7H,CAAC;IACH,CAAC;CACF","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 { AnyEnumerator, Enumeration, EnumerationProps, PrimitiveType, SchemaItemKey, SchemaItemType, SchemaKey } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor } from \"./Editor\";\nimport { MutableEnumeration } from \"./Mutable/MutableEnumeration\";\nimport { ECEditingStatus, EnumeratorId, SchemaEditingError, SchemaItemId } from \"./Exception\";\nimport { SchemaItems } from \"./SchemaItems\";\n\ntype MutableEnumerator = {\n  -readonly [P in keyof AnyEnumerator]: AnyEnumerator[P]\n};\n\n/**\n * @alpha\n * A class allowing you to create schema items of type Enumeration.\n */\nexport class Enumerations extends SchemaItems {\n  protected override get itemTypeClass(): typeof Enumeration {\n    return Enumeration;\n  }\n\n  public constructor(schemaEditor: SchemaContextEditor) {\n    super(SchemaItemType.Enumeration, schemaEditor);\n  }\n\n  public async create(schemaKey: SchemaKey, name: string, type: PrimitiveType.Integer | PrimitiveType.String, displayLabel?: string, isStrict?: boolean, enumerators?: AnyEnumerator[]): Promise<SchemaItemKey> {\n    try {\n      const newEnum = await this.createSchemaItem<Enumeration>(schemaKey, this.schemaItemType, (schema) => schema.createEnumeration.bind(schema), name, type) as MutableEnumeration;\n\n      if (undefined !== isStrict)\n        newEnum.setIsStrict(isStrict);\n\n      if (undefined !== enumerators)\n        for (const enumerator of enumerators)\n          await this.addEnumerator(newEnum.key, enumerator);\n\n      if (displayLabel)\n        newEnum.setDisplayLabel(displayLabel);\n\n      return newEnum.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new SchemaItemId(this.schemaItemType, name, schemaKey), e);\n    }\n  }\n\n  /**\n   * Creates an Enumeration through an EnumeratorProps.\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\n   * @param relationshipProps a json object that will be used to populate the new RelationshipClass. Needs a name value passed in.\n   */\n  public async createFromProps(schemaKey: SchemaKey, enumProps: EnumerationProps): Promise<SchemaItemKey> {\n    try {\n      const newEnum = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createEnumeration.bind(schema), enumProps);\n      return newEnum.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new SchemaItemId(this.schemaItemType, enumProps.name!, schemaKey), e);\n    }\n  }\n\n  public async addEnumerator(enumerationKey: SchemaItemKey, enumerator: AnyEnumerator): Promise<void> {\n    try {\n      const enumeration = await this.getSchemaItem(enumerationKey, Enumeration);\n\n      if (enumeration.isInt && typeof (enumerator.value) !== \"number\")\n        throw new SchemaEditingError(ECEditingStatus.InvalidEnumeratorType, new EnumeratorId(enumerator, enumeration));\n\n      if (enumeration.isString && typeof (enumerator.value) !== \"string\")\n        throw new SchemaEditingError(ECEditingStatus.InvalidEnumeratorType, new EnumeratorId(enumerator, enumeration));\n\n      (enumeration as MutableEnumeration).addEnumerator(enumerator);\n    } catch(e: any) {\n      throw new SchemaEditingError(ECEditingStatus.AddEnumerator, new SchemaItemId(this.schemaItemType, enumerationKey), e);\n    }\n  }\n\n  public async setEnumeratorLabel(enumerationKey: SchemaItemKey, enumeratorName: string, label: string | undefined): Promise<void> {\n    try {\n      const enumeration = await this.getSchemaItem(enumerationKey, Enumeration);\n\n      const enumerator = enumeration.getEnumeratorByName(enumeratorName);\n      if (enumerator === undefined)\n        throw new SchemaEditingError(ECEditingStatus.EnumeratorDoesNotExist, new EnumeratorId(enumeratorName, enumeration));\n\n      (enumerator as MutableEnumerator).label = label;\n    } catch(e: any) {\n      throw new SchemaEditingError(ECEditingStatus.SetEnumeratorLabel, new SchemaItemId(this.schemaItemType, enumerationKey), e);\n    }\n  }\n\n  public async setEnumeratorDescription(enumerationKey: SchemaItemKey, enumeratorName: string, description: string | undefined): Promise<void> {\n    try {\n      const enumeration = await this.getSchemaItem(enumerationKey, Enumeration);\n\n      const enumerator = enumeration.getEnumeratorByName(enumeratorName);\n      if (enumerator === undefined)\n        throw new SchemaEditingError(ECEditingStatus.EnumeratorDoesNotExist, new EnumeratorId(enumeratorName, enumeration));\n\n      (enumerator as MutableEnumerator).description = description;\n    } catch(e: any) {\n      throw new SchemaEditingError(ECEditingStatus.SetEnumeratorLabel, new SchemaItemId(this.schemaItemType, enumerationKey), e);\n    }\n  }\n}\n"]}

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

@@ -0,0 +1,358 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { AnyDiagnostic } from "../Validation/Diagnostic";
+import { AnyEnumerator, CustomAttributeContainerProps, Enumeration, Property, RelationshipConstraint, SchemaItemKey, SchemaItemType, SchemaKey } from "@itwin/ecschema-metadata";
+/** @alpha */
+export declare enum ECEditingStatus {
+    EC_EDITING_ERROR_BASE = 196608,
+    Unknown = 0,
+    RuleViolation = 196609,
+    SchemaNotFound = 196610,
+    SchemaItemNotFound = 196611,
+    SchemaItemNotFoundInContext = 196612,
+    PropertyAlreadyExists = 196613,
+    PropertyNotFound = 196614,
+    InvalidPropertyType = 196615,
+    BaseClassIsNotElement = 196616,
+    BaseClassIsNotElementUniqueAspect = 196617,
+    BaseClassIsNotElementMultiAspect = 196618,
+    SchemaItemNameNotSpecified = 196619,
+    InvalidSchemaItemType = 196620,
+    SchemaItemNameAlreadyExists = 196621,
+    InvalidEnumeratorType = 196622,
+    InvalidBaseClass = 196623,
+    EnumeratorDoesNotExist = 196624,
+    InvalidECName = 196625,
+    InvalidSchemaAlias = 196626,
+    InvalidFormatUnitsSpecified = 196627,
+    SchemaAliasAlreadyExists = 196628,
+    CreateSchemaItemFailed = 196629,
+    CreateSchemaItemFromProps = 196630,
+    CreateElement = 196631,
+    CreateElementUniqueAspect = 196632,
+    CreateElementMultiAspect = 196633,
+    SetBaseClass = 196634,
+    SetSourceConstraint = 196635,
+    SetTargetConstraint = 196636,
+    AddConstraintClass = 196637,
+    RemoveConstraintClass = 196638,
+    SetAbstractConstraint = 196639,
+    AddCustomAttributeToConstraint = 196640,
+    AddCustomAttributeToProperty = 196641,
+    AddCustomAttributeToClass = 196642,
+    CreateNavigationProperty = 196643,
+    CreateNavigationPropertyFromProps = 196644,
+    SetInvertsUnit = 196645,
+    SetUnitSystem = 196646,
+    SetDescription = 196647,
+    SetLabel = 196648,
+    SetIsReadOnly = 196649,
+    SetPriority = 196650,
+    SetCategory = 196651,
+    SetKindOfQuantity = 196652,
+    SetMinOccurs = 196653,
+    SetMaxOccurs = 196654,
+    SetExtendedTypeName = 196655,
+    SetMinLength = 196656,
+    SetMaxLength = 196657,
+    SetMinValue = 196658,
+    SetMaxValue = 196659,
+    SetPropertyName = 196660,
+    AddMixin = 196661,
+    AddEnumerator = 196662,
+    SetEnumeratorLabel = 196663,
+    SetEnumeratorDescription = 196664,
+    AddPresentationUnit = 196665,
+    AddPresentationOverride = 196666,
+    CreateFormatOverride = 196667,
+    SetPropertyCategoryPriority = 196668,
+    CreatePrimitiveProperty = 196669,
+    CreatePrimitivePropertyFromProps = 196670,
+    CreateEnumerationProperty = 196671,
+    CreateEnumerationPropertyFromProps = 196672,
+    CreatePrimitiveArrayProperty = 196673,
+    CreatePrimitiveArrayPropertyFromProps = 196674,
+    CreateEnumerationArrayProperty = 196675,
+    CreateEnumerationArrayPropertyFromProps = 196676,
+    CreateStructProperty = 196677,
+    CreateStructPropertyFromProps = 196678,
+    CreateStructArrayProperty = 196679,
+    CreateStructArrayPropertyFromProps = 196680,
+    DeleteProperty = 196681,
+    DeleteClass = 196682,
+    SetClassName = 196683,
+    AddSchemaReference = 196684,
+    SetSchemaVersion = 196685,
+    IncrementSchemaMinorVersion = 196686,
+    SetSchemaAlias = 196687
+}
+/**
+ * A type that constrains the possible error types handled by SchemaEditingError
+ * @alpha
+ */
+export type AnyEditingError = SchemaEditingError | Error;
+/**
+ * Defines the possible property type names.
+ * @alpha
+ */
+export declare enum PropertyTypeName {
+    ArrayProperty = "ArrayProperty",
+    PrimitiveProperty = "PrimitiveProperty",
+    EnumerationProperty = "EnumerationProperty",
+    NavigationProperty = "NavigationProperty",
+    StructProperty = "StructProperty"
+}
+/**
+ * Defines the possible schema type identifiers.
+ * @alpha
+ */
+export declare enum SchemaTypeIdentifiers {
+    SchemaIdentifier = "Schema",
+    SchemaItemIdentifier = "SchemaItem",
+    ClassIdentifier = "Class",
+    PropertyIdentifier = "Property",
+    EnumeratorIdentifier = "Enumerator",
+    CustomAttributeIdentifier = "CustomAttribute",
+    RelationshipConstraintIdentifier = "RelationshipConstraint"
+}
+/**
+ * Type that constrains SchemaItemType enum to those used by EC Class types.
+ * @alpha
+ */
+export type ECClassSchemaItems = SchemaItemType.EntityClass | SchemaItemType.StructClass | SchemaItemType.RelationshipClass | SchemaItemType.Mixin | SchemaItemType.CustomAttributeClass;
+/**
+ * Type that defines the possible SchemaTypeIdentifiers for SchemaItemId classes.
+ * @alpha
+ */
+export type AnySchemaItemTypeIdentifier = SchemaTypeIdentifiers.SchemaItemIdentifier | SchemaTypeIdentifiers.ClassIdentifier;
+/**
+ * Type that encompasses all ISchemaTypeIdentifier interfaces
+ * @alpha
+ */
+export type AnyIdentifier = ISchemaIdentifier | ISchemaItemIdentifier | IClassIdentifier | IPropertyIdentifier | ICustomAttributeIdentifier | IRelationshipConstraintIdentifier | IEnumeratorIdentifier;
+/**
+ * A base interface that defines what is needed to identity any schema type.
+ * @alpha
+ */
+export interface ISchemaTypeIdentifier {
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    readonly typeIdentifier: SchemaTypeIdentifiers;
+}
+/**
+ * Interface that defines the data needed to identify a Schema.
+ * @alpha
+ */
+export interface ISchemaIdentifier extends ISchemaTypeIdentifier {
+    readonly typeIdentifier: SchemaTypeIdentifiers.SchemaIdentifier;
+}
+/**
+ * Interface that defines the data needed to identify a SchemaItem.
+ * @alpha
+ */
+export interface ISchemaItemIdentifier extends ISchemaTypeIdentifier {
+    readonly schemaItemType: SchemaItemType;
+    readonly schemaItemKey: SchemaItemKey;
+    readonly typeIdentifier: AnySchemaItemTypeIdentifier;
+}
+/**
+ * Interface that defines the data needed to identify an EC Class.
+ * @alpha
+ */
+export interface IClassIdentifier extends ISchemaTypeIdentifier {
+    readonly schemaItemType: ECClassSchemaItems;
+    readonly schemaItemKey: SchemaItemKey;
+    readonly typeIdentifier: SchemaTypeIdentifiers.ClassIdentifier;
+}
+/**
+ * Interface that defines the data needed to identify an EC Property.
+ * @alpha
+ */
+export interface IPropertyIdentifier extends ISchemaTypeIdentifier {
+    readonly fullName: string;
+    readonly ecClass: ClassId;
+    readonly typeName?: PropertyTypeName;
+    readonly typeIdentifier: SchemaTypeIdentifiers.PropertyIdentifier;
+}
+/**
+ * Interface that defines the data needed to identify an Enumerator.
+ * @alpha
+ */
+interface IEnumeratorIdentifier extends ISchemaTypeIdentifier {
+    readonly enumeratorType: string;
+    readonly enumeration: SchemaItemKey;
+    readonly enumerationType: string;
+    readonly typeIdentifier: SchemaTypeIdentifiers.EnumeratorIdentifier;
+}
+/**
+ * Interface that defines the data needed to identify a CustomAttribute.
+ * @alpha
+ */
+export interface ICustomAttributeIdentifier extends ISchemaTypeIdentifier {
+    readonly containerFullName: string;
+    readonly typeIdentifier: SchemaTypeIdentifiers.CustomAttributeIdentifier;
+}
+/**
+ * Interface that defines the data needed to identify a RelationshipConstraint.
+ * @alpha
+ */
+export interface IRelationshipConstraintIdentifier extends ISchemaTypeIdentifier {
+    readonly relationshipKey: SchemaItemKey;
+    readonly typeIdentifier: SchemaTypeIdentifiers.RelationshipConstraintIdentifier;
+}
+/**
+ * An ISchemaIdentifier implementation to identify Schemas
+ * @alpha
+ */
+export declare class SchemaId implements ISchemaIdentifier {
+    readonly typeIdentifier = SchemaTypeIdentifiers.SchemaIdentifier;
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    constructor(schemaKey: SchemaKey);
+}
+/**
+ * An ISchemItemIdentifier implementation to identify SchemaItems
+ * @alpha
+ */
+export declare class SchemaItemId implements ISchemaItemIdentifier {
+    readonly typeIdentifier: AnySchemaItemTypeIdentifier;
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    readonly schemaItemType: SchemaItemType;
+    readonly schemaItemKey: SchemaItemKey;
+    constructor(schemaItemType: SchemaItemType, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey);
+}
+/**
+ * An IClassIdentifier implementation to identify Class instances.
+ * @alpha
+ */
+export declare class ClassId extends SchemaItemId implements IClassIdentifier {
+    readonly typeIdentifier = SchemaTypeIdentifiers.ClassIdentifier;
+    readonly schemaItemType: ECClassSchemaItems;
+    constructor(schemaItemType: ECClassSchemaItems, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey);
+}
+/**
+ * An IPropertyIdentifier implementation to identify Property instances.
+ * @alpha
+ */
+export declare class PropertyId implements IPropertyIdentifier {
+    readonly typeIdentifier = SchemaTypeIdentifiers.PropertyIdentifier;
+    readonly name: string;
+    readonly fullName: string;
+    readonly ecClass: ClassId;
+    readonly schemaKey: SchemaKey;
+    readonly typeName?: PropertyTypeName;
+    constructor(schemaItemType: ECClassSchemaItems, classKey: SchemaItemKey, property: Property | string, typeName?: PropertyTypeName);
+}
+/**
+ * An IEnumeratorIdentifier implementation to identify Enumerator instances.
+ * @alpha
+ */
+export declare class EnumeratorId implements IEnumeratorIdentifier {
+    readonly typeIdentifier = SchemaTypeIdentifiers.EnumeratorIdentifier;
+    readonly enumeration: SchemaItemKey;
+    readonly enumerationType: string;
+    readonly enumeratorType: string;
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    constructor(enumerator: AnyEnumerator | string, enumeration: Enumeration);
+}
+/**
+ * An ICustomAttributeIdentifier implementation to identify CustomAttribute instances.
+ * @alpha
+ */
+export declare class CustomAttributeId implements ICustomAttributeIdentifier {
+    readonly typeIdentifier = SchemaTypeIdentifiers.CustomAttributeIdentifier;
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    readonly containerFullName: string;
+    constructor(name: string, container: CustomAttributeContainerProps);
+}
+/**
+ * An IRelationshipConstraintIdentifier implementation to identify RelationshipConstraints.
+ * @alpha
+ */
+export declare class RelationshipConstraintId implements IRelationshipConstraintIdentifier {
+    readonly typeIdentifier = SchemaTypeIdentifiers.RelationshipConstraintIdentifier;
+    readonly name: string;
+    readonly relationshipKey: SchemaItemKey;
+    readonly schemaKey: SchemaKey;
+    constructor(constraint: RelationshipConstraint);
+}
+/**
+ * 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 declare class SchemaEditingError extends Error {
+    readonly errorNumber: ECEditingStatus;
+    readonly identifier: AnyIdentifier;
+    readonly innerError?: AnyEditingError | undefined;
+    private _ruleViolations?;
+    private _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: ECEditingStatus, identifier: AnyIdentifier, innerError?: AnyEditingError | undefined, ruleViolations?: AnyDiagnostic[], message?: string);
+    /**
+     * Gets the SchemaId instance.
+     * @throws Error if the identifier is not an instance of SchemaId.
+     */
+    private get _schemaId();
+    /**
+     * Gets the SchemaItemId instance.
+     * @throws Error if the identifier is not an instance of SchemaItemId.
+     */
+    private get _schemaItemId();
+    /**
+     * Gets the ClassId instance.
+     * @throws Error if the identifier is not an instance of ClassId.
+     */
+    private get _classId();
+    /**
+     * Gets the PropertyId instance.
+     * @throws Error if the identifier is not an instance of PropertyId.
+     */
+    private get _propertyId();
+    /**
+     * Gets the EnumeratorId instance.
+     * @throws Error if the identifier is not an instance of EnumeratorId.
+     */
+    private get _enumeratorId();
+    /**
+     * Gets the CustomAttributeId instance.
+     * @throws Error if the identifier is not an instance of CustomAttributeId.
+     */
+    private get _customAttributeId();
+    /**
+     * Gets the RelationshipConstraintId instance.
+     * @throws Error if the identifier is not an instance of RelationshipConstraintId.
+     */
+    private get _relationshipConstraintId();
+    /** Gets rule violations that were reported during validation. Returns an array of [[AnyDiagnostic]] if
+     * the errorNumber is ECEditingStatus.RuleViolation, otherwise undefined.
+     */
+    get ruleViolations(): AnyDiagnostic[] | undefined;
+    /**
+     * Returns a readable string containing the ECEditingStatus along with the error message. Any
+     * innerError will also be appended.
+     * @returns
+     */
+    toDebugString(): string;
+    private generateMessage;
+    private _appendMessage;
+    private _getRuleViolationMessage;
+    private _createTaskErrorMessage;
+    private isSchemaItemIdentifier;
+}
+export {};
+//# sourceMappingURL=Exception.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Exception.d.ts","sourceRoot":"","sources":["../../../src/Editing/Exception.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,6BAA6B,EAAE,WAAW,EAAwC,QAAQ,EAAE,sBAAsB,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAEvN,aAAa;AACb,oBAAY,eAAe;IACzB,qBAAqB,SAAU;IAC/B,OAAO,IAAI;IACX,aAAa,SAA4B;IACzC,cAAc,SAAA;IACd,kBAAkB,SAAA;IAClB,2BAA2B,SAAA;IAC3B,qBAAqB,SAAA;IACrB,gBAAgB,SAAA;IAChB,mBAAmB,SAAA;IACnB,qBAAqB,SAAA;IACrB,iCAAiC,SAAA;IACjC,gCAAgC,SAAA;IAChC,0BAA0B,SAAA;IAC1B,qBAAqB,SAAA;IACrB,2BAA2B,SAAA;IAC3B,qBAAqB,SAAA;IACrB,gBAAgB,SAAA;IAChB,sBAAsB,SAAA;IACtB,aAAa,SAAA;IACb,kBAAkB,SAAA;IAClB,2BAA2B,SAAA;IAC3B,wBAAwB,SAAA;IAExB,sBAAsB,SAAA;IACtB,yBAAyB,SAAA;IACzB,aAAa,SAAA;IACb,yBAAyB,SAAA;IACzB,wBAAwB,SAAA;IACxB,YAAY,SAAA;IACZ,mBAAmB,SAAA;IACnB,mBAAmB,SAAA;IACnB,kBAAkB,SAAA;IAClB,qBAAqB,SAAA;IACrB,qBAAqB,SAAA;IACrB,8BAA8B,SAAA;IAC9B,4BAA4B,SAAA;IAC5B,yBAAyB,SAAA;IACzB,wBAAwB,SAAA;IACxB,iCAAiC,SAAA;IACjC,cAAc,SAAA;IACd,aAAa,SAAA;IACb,cAAc,SAAA;IACd,QAAQ,SAAA;IACR,aAAa,SAAA;IACb,WAAW,SAAA;IACX,WAAW,SAAA;IACX,iBAAiB,SAAA;IACjB,YAAY,SAAA;IACZ,YAAY,SAAA;IACZ,mBAAmB,SAAA;IACnB,YAAY,SAAA;IACZ,YAAY,SAAA;IACZ,WAAW,SAAA;IACX,WAAW,SAAA;IACX,eAAe,SAAA;IACf,QAAQ,SAAA;IACR,aAAa,SAAA;IACb,kBAAkB,SAAA;IAClB,wBAAwB,SAAA;IACxB,mBAAmB,SAAA;IACnB,uBAAuB,SAAA;IACvB,oBAAoB,SAAA;IACpB,2BAA2B,SAAA;IAC3B,uBAAuB,SAAA;IACvB,gCAAgC,SAAA;IAChC,yBAAyB,SAAA;IACzB,kCAAkC,SAAA;IAClC,4BAA4B,SAAA;IAC5B,qCAAqC,SAAA;IACrC,8BAA8B,SAAA;IAC9B,uCAAuC,SAAA;IACvC,oBAAoB,SAAA;IACpB,6BAA6B,SAAA;IAC7B,yBAAyB,SAAA;IACzB,kCAAkC,SAAA;IAClC,cAAc,SAAA;IACd,WAAW,SAAA;IACX,YAAY,SAAA;IACZ,kBAAkB,SAAA;IAClB,gBAAgB,SAAA;IAChB,2BAA2B,SAAA;IAC3B,cAAc,SAAA;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,GAAG,KAAK,CAAC;AAEzD;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,aAAa,kBAAkB;IAC/B,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAC3C,kBAAkB,uBAAuB;IACzC,cAAc,mBAAmB;CAClC;AAED;;;GAGG;AACH,oBAAY,qBAAqB;IAC/B,gBAAgB,WAAW;IAC3B,oBAAoB,eAAe;IACnC,eAAe,UAAU;IACzB,kBAAkB,aAAa;IAC/B,oBAAoB,eAAe;IACnC,yBAAyB,oBAAoB;IAC7C,gCAAgC,2BAA2B;CAC5D;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAAC,WAAW,GAAG,cAAc,CAAC,WAAW,GAAG,cAAc,CAAC,iBAAiB,GAAG,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,oBAAoB,CAAC;AAEzL;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,qBAAqB,CAAC,oBAAoB,GAAG,qBAAqB,CAAC,eAAe,CAAC;AAE7H;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,qBAAqB,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,0BAA0B,GAAG,iCAAiC,GAAG,qBAAqB,CAAC;AAExM;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;IAC9D,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC,gBAAgB,CAAC;CACjE;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,cAAc,EAAE,2BAA2B,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,qBAAqB;IAC7D,QAAQ,CAAC,cAAc,EAAE,kBAAkB,CAAC;IAC5C,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC,eAAe,CAAC;CAChE;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAChE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACrC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC,kBAAkB,CAAC;CACnE;AAED;;;GAGG;AACH,UAAU,qBAAsB,SAAQ,qBAAqB;IAC3D,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC;IACpC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC,oBAAoB,CAAC;CACrE;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC,yBAAyB,CAAC;CAC1E;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAkC,SAAQ,qBAAqB;IAC9E,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC;IACxC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC,gCAAgC,CAAC;CACjF;AAED;;;GAGG;AACH,qBAAa,QAAS,YAAW,iBAAiB;IAChD,SAAgB,cAAc,0CAA0C;IACxE,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,SAAS,CAAC;gBACzB,SAAS,EAAE,SAAS;CAIjC;AAED;;;GAGG;AACH,qBAAa,YAAa,YAAW,qBAAqB;IACxD,SAAgB,cAAc,EAAE,2BAA2B,CAAC;IAC5D,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,cAAc,EAAE,cAAc,CAAC;IAC/C,SAAgB,aAAa,EAAE,aAAa,CAAC;gBAEjC,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,aAAa,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;CAgB/G;AAED;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAa,YAAW,gBAAgB;IACnE,SAAyB,cAAc,yCAAyC;IAChF,SAAyB,cAAc,EAAE,kBAAkB,CAAC;gBAChD,cAAc,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,aAAa,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;CAInH;AAED;;;GAGG;AACH,qBAAa,UAAW,YAAW,mBAAmB;IACpD,SAAgB,cAAc,4CAA4C;IAC1E,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;gBAEhC,cAAc,EAAE,kBAAkB,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB;CAOlI;AAED;;;GAGG;AACH,qBAAa,YAAa,YAAW,qBAAqB;IACxD,SAAgB,cAAc,8CAA8C;IAC5E,SAAgB,WAAW,EAAE,aAAa,CAAC;IAC3C,SAAgB,eAAe,EAAE,MAAM,CAAC;IACxC,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,SAAS,CAAC;gBAEzB,UAAU,EAAE,aAAa,GAAG,MAAM,EAAE,WAAW,EAAE,WAAW;CAOzE;AAED;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,0BAA0B;IAClE,SAAgB,cAAc,mDAAmD;IACjF,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,iBAAiB,EAAE,MAAM,CAAC;gBAC9B,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,6BAA6B;CAKnE;AAED;;;GAGG;AACH,qBAAa,wBAAyB,YAAW,iCAAiC;IAChF,SAAgB,cAAc,0DAA0D;IACxF,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,eAAe,EAAE,aAAa,CAAC;IAC/C,SAAgB,SAAS,EAAE,SAAS,CAAC;gBACzB,UAAU,EAAE,sBAAsB;CAK/C;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;aAYR,WAAW,EAAE,eAAe;aAAkB,UAAU,EAAE,aAAa;aAAkB,UAAU,CAAC,EAAE,eAAe;IAXxJ,OAAO,CAAC,eAAe,CAAC,CAAkB;IAC1C,OAAO,CAAC,UAAU,CAAY;IAE9B;;;;;;;OAOG;gBACgC,WAAW,EAAE,eAAe,EAAkB,UAAU,EAAE,aAAa,EAAkB,UAAU,CAAC,EAAE,eAAe,YAAA,EAAE,cAAc,CAAC,EAAE,aAAa,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM;IAO5M;;;OAGG;IACH,OAAO,KAAK,SAAS,GAIpB;IAED;;;OAGG;IACH,OAAO,KAAK,aAAa,GAIxB;IAED;;;OAGG;IACH,OAAO,KAAK,QAAQ,GAInB;IAED;;;OAGG;IACH,OAAO,KAAK,WAAW,GAItB;IAED;;;OAGG;IACH,OAAO,KAAK,aAAa,GAIxB;IAED;;;OAGG;IACH,OAAO,KAAK,kBAAkB,GAI7B;IAED;;;OAGG;IACH,OAAO,KAAK,yBAAyB,GAIpC;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,aAAa,EAAE,GAAG,SAAS,CAEvD;IAED;;;;OAIG;IACI,aAAa,IAAI,MAAM;IAW9B,OAAO,CAAC,eAAe;IAgEvB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,wBAAwB;IAyBhC,OAAO,CAAC,uBAAuB;IAkB/B,OAAO,CAAC,sBAAsB;CAO/B"}