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

package/lib/cjs/Editing/Entities.js.map

@@ -1 +1 @@
-{"version":3,"file":"Entities.js","sourceRoot":"","sources":["../../../src/Editing/Entities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAGkC;AAElC,2CAAwC;AAExC,6CAAoD;AAEpD;;;GAGG;AACH,MAAa,QAAS,SAAQ,qBAAS;IACrC,YAAmB,YAAiC;QAClD,KAAK,CAAC,kCAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAGlD;;WAEG;QACa,yBAAoB,GAAG,IAAI,iCAAoB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IALzG,CAAC;IAOM,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QAC5J,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS;YACZ,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,sBAAsB,CAAC,CAAC;QAE1I,IAAI,SAAS,EAAE,cAAc,KAAK,kCAAc,CAAC,WAAW;YAC1D,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,yBAAyB,CAAC,CAAC;QAE7I,IAAI,CAAC,CAAC,MAAO,SAAyB,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;YACjE,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,qBAAqB,CAAC,CAAC;QACzI,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QACxK,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS;YACZ,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,sBAAsB,CAAC,CAAC;QAE1I,IAAI,SAAS,EAAE,cAAc,KAAK,kCAAc,CAAC,WAAW;YAC1D,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,yBAAyB,CAAC,CAAC;QAE7I,IAAI,CAAC,CAAC,MAAO,SAAyB,CAAC,EAAE,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;YAC7E,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,iCAAiC,CAAC,CAAC;QACrJ,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QACvK,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QACrF,IAAI,CAAC,SAAS;YACZ,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,kBAAkB,CAAC,CAAC;QAEtI,IAAI,SAAS,EAAE,cAAc,KAAK,kCAAc,CAAC,WAAW;YAC1D,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,yBAAyB,CAAC,CAAC;QAE7I,IAAI,CAAC,CAAC,MAAO,SAAyB,CAAC,EAAE,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;YAC5E,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0DAA0D,YAAY,CAAC,QAAQ,gCAAgC,CAAC,CAAC;QACpJ,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAAqB,EAAE,YAA4B,EAAE,MAAgB;QACtJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAuB,CAAC;QACxF,IAAI,QAAQ,KAAK,SAAS;YACxB,OAAO,EAAE,YAAY,EAAE,0BAA0B,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAEnG,8BAA8B;QAC9B,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,eAAe,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAChJ,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;gBAClC,OAAO,EAAE,YAAY,EAAE,cAAc,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACtG,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,UAAU,CAAc,YAAY,CAAC,CAAC;YAClF,IAAI,aAAa,KAAK,SAAS;gBAC7B,OAAO,EAAE,YAAY,EAAE,+BAA+B,YAAY,CAAC,QAAQ,cAAc,eAAe,CAAC,QAAQ,GAAG,EAAE,CAAC;YAEzH,IAAI,aAAa,CAAC,cAAc,KAAK,kCAAc,CAAC,WAAW;gBAC7D,OAAO,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC,QAAQ,+BAA+B,EAAE,CAAC;YAEpF,QAAQ,CAAC,SAAS,GAAG,IAAI,2CAAuB,CAA6B,YAAY,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC;QACxH,CAAC;QAED,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9C,IAAI,YAAY;YACd,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEzC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,WAA6B;QAC9E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS;YAChC,OAAO,EAAE,YAAY,EAAE,oCAAoC,EAAE,CAAC;QAEhE,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAuB,CAAC;QAC1F,IAAI,QAAQ,KAAK,SAAS;YACxB,OAAO,EAAE,YAAY,EAAE,0BAA0B,WAAW,CAAC,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAE/G,MAAM,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAErC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,SAAwB,EAAE,QAAuB;QACrE,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC,CAAC;QACrG,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,EAAE,YAAY,EAAE,gBAAgB,SAAS,CAAC,QAAQ,+BAA+B,EAAE,CAAC;QAC7F,CAAC;QACD,IAAI,MAAM,CAAC,cAAc,KAAK,kCAAc,CAAC,WAAW,EAAE,CAAC;YACzD,OAAO,EAAE,YAAY,EAAE,YAAY,SAAS,CAAC,QAAQ,8BAA8B,EAAE,CAAC;QACxF,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAQ,QAAQ,CAAC,CAAC,CAAC;QACtF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,EAAE,YAAY,EAAE,eAAe,QAAQ,CAAC,QAAQ,+BAA+B,EAAE,CAAC;QAC3F,CAAC;QACD,IAAI,KAAK,CAAC,cAAc,KAAK,kCAAc,CAAC,KAAK,EAAE,CAAC;YAClD,OAAO,EAAE,YAAY,EAAE,YAAY,QAAQ,CAAC,QAAQ,uBAAuB,EAAC,CAAC;QAC/E,CAAC;QAED,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,SAAwB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAC3J,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;QAEnG,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,gBAAgB,SAAS,CAAC,QAAQ,+BAA+B,CAAC,CAAC;QAE7H,IAAI,MAAM,CAAC,cAAc,KAAK,kCAAc,CAAC,WAAW;YACtD,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,qBAAqB,EAAE,YAAY,SAAS,CAAC,QAAQ,8BAA8B,CAAC,CAAC;QAEhI,MAAM,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QACrE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iCAAiC,CAAC,QAAuB,EAAE,eAAwC;QAC9G,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAqB,QAAQ,CAAC,CAAC;QAClG,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,gBAAgB,QAAQ,CAAC,QAAQ,+BAA+B,EAAC,CAAC;QAElJ,IAAI,MAAM,CAAC,cAAc,KAAK,kCAAc,CAAC,WAAW;YACtD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,QAAQ,CAAC,QAAQ,6BAA6B,EAAE,CAAC;QAE7I,MAAM,kBAAkB,GAAI,MAAM,MAAM,CAAC,wBAAwB,CAAC,eAAe,CAAC,IAAI,EAAE,eAAe,CAAC,gBAAgB,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;QACrJ,MAAM,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAEnD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,EAAE,CAAC;IACnE,CAAC;CACF;AApKD,4BAoKC","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 {\n  DelayedPromiseWithProps, ECClassModifier, ECObjectsError, ECObjectsStatus, EntityClass, EntityClassProps,\n  Mixin, NavigationPropertyProps, RelationshipClass, SchemaItemKey, SchemaItemType, SchemaKey, StrengthDirection,\n} from \"@itwin/ecschema-metadata\";\nimport { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\nimport { ECClasses } from \"./ECClasses\";\nimport { MutableEntityClass } from \"./Mutable/MutableEntityClass\";\nimport { NavigationProperties } from \"./Properties\";\n\n/**\n * @alpha\n * A class extending ECClasses allowing you to create schema items of type EntityClass.\n */\nexport class Entities extends ECClasses {\n  public constructor(schemaEditor: SchemaContextEditor) {\n    super(SchemaItemType.EntityClass, schemaEditor);\n  }\n\n  /**\n   * Allows access for editing of NavigationProperty attributes.\n   */\n  public readonly navigationProperties = new NavigationProperties(this.schemaItemType, this._schemaEditor);\n\n  public async createElement(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemEditResults> {\n    const baseClass = await this._schemaEditor.schemaContext.getSchemaItem(baseClassKey);\n    if (!baseClass)\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} could not be found.`);\n\n    if (baseClass?.schemaItemType !== SchemaItemType.EntityClass)\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an EntityClass.`);\n\n    if (!(await (baseClass as EntityClass).is(\"Element\", \"BisCore\"))) {\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an Element.`);\n    }\n\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\n  }\n\n  public async createElementUniqueAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemEditResults> {\n    const baseClass = await this._schemaEditor.schemaContext.getSchemaItem(baseClassKey);\n    if (!baseClass)\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} could not be found.`);\n\n    if (baseClass?.schemaItemType !== SchemaItemType.EntityClass)\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an EntityClass.`);\n\n    if (!(await (baseClass as EntityClass).is(\"ElementUniqueAspect\", \"BisCore\"))) {\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an ElementUniqueAspect.`);\n    }\n\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\n  }\n\n  public async createElementMultiAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemEditResults> {\n    const baseClass = await this._schemaEditor.schemaContext.getSchemaItem(baseClassKey);\n    if (!baseClass)\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} could be found.`);\n\n    if (baseClass?.schemaItemType !== SchemaItemType.EntityClass)\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an EntityClass.`);\n\n    if (!(await (baseClass as EntityClass).is(\"ElementMultiAspect\", \"BisCore\"))) {\n      throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an ElementMultiAspect.`);\n    }\n\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\n  }\n\n  public async create(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, displayLabel?: string, baseClassKey?: SchemaItemKey, mixins?: Mixin[]): Promise<SchemaItemEditResults> {\n    const schema = await this._schemaEditor.getSchema(schemaKey);\n    if (schema === undefined)\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    const newClass = (await schema.createEntityClass(name, modifier)) as MutableEntityClass;\n    if (newClass === undefined)\n      return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };\n\n    // Add a deserializing method.\n    if (baseClassKey !== undefined) {\n      const baseClassSchema = !baseClassKey.schemaKey.matches(schema.schemaKey) ? await this._schemaEditor.getSchema(baseClassKey.schemaKey) : schema;\n      if (baseClassSchema === undefined) {\n        return { errorMessage: `Schema Key ${baseClassKey.schemaKey.toString(true)} not found in context` };\n      }\n\n      const baseClassItem = await baseClassSchema.lookupItem<EntityClass>(baseClassKey);\n      if (baseClassItem === undefined)\n        return { errorMessage: `Unable to locate base class ${baseClassKey.fullName} in schema ${baseClassSchema.fullName}.` };\n\n      if (baseClassItem.schemaItemType !== SchemaItemType.EntityClass)\n        return { errorMessage: `${baseClassItem.fullName} is not of type Entity Class.` };\n\n      newClass.baseClass = new DelayedPromiseWithProps<SchemaItemKey, EntityClass>(baseClassKey, async () => baseClassItem);\n    }\n\n    if (mixins !== undefined)\n      mixins.forEach((m) => newClass.addMixin(m));\n\n    if (displayLabel)\n      newClass.setDisplayLabel(displayLabel);\n\n    return { itemKey: newClass.key };\n  }\n\n  /**\n   * Creates an EntityClass through an EntityClassProps.\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\n   * @param entityProps a json object that will be used to populate the new EntityClass. Needs a name value passed in.\n   */\n  public async createFromProps(schemaKey: SchemaKey, entityProps: EntityClassProps): Promise<SchemaItemEditResults> {\n    const schema = await this._schemaEditor.getSchema(schemaKey);\n    if (schema === undefined)\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    if (entityProps.name === undefined)\n      return { errorMessage: `No name was supplied within props.` };\n\n    const newClass = (await schema.createEntityClass(entityProps.name)) as MutableEntityClass;\n    if (newClass === undefined)\n      return { errorMessage: `Failed to create class ${entityProps.name} in schema ${schemaKey.toString(true)}.` };\n\n    await newClass.fromJSON(entityProps);\n\n    return { itemKey: newClass.key };\n  }\n\n  public async addMixin(entityKey: SchemaItemKey, mixinKey: SchemaItemKey): Promise<SchemaItemEditResults> {\n    const entity = (await this._schemaEditor.schemaContext.getSchemaItem<MutableEntityClass>(entityKey));\n    if (entity === undefined) {\n      return { errorMessage: `Entity Class ${entityKey.fullName} not found in schema context.` };\n    }\n    if (entity.schemaItemType !== SchemaItemType.EntityClass) {\n      return { errorMessage: `Expected ${entityKey.fullName} to be of type Entity Class.` };\n    }\n\n    const mixin = (await this._schemaEditor.schemaContext.getSchemaItem<Mixin>(mixinKey));\n    if (mixin === undefined) {\n      return { errorMessage: `Mixin Class ${mixinKey.fullName} not found in schema context.` };\n    }\n    if (mixin.schemaItemType !== SchemaItemType.Mixin) {\n      return { errorMessage: `Expected ${mixinKey.fullName} to be of type Mixin.`};\n    }\n\n    entity.addMixin(mixin);\n    return { itemKey: entityKey };\n  }\n\n  public async createNavigationProperty(entityKey: SchemaItemKey, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<PropertyEditResults> {\n    const entity = await this._schemaEditor.schemaContext.getSchemaItem<MutableEntityClass>(entityKey);\n\n    if (entity === undefined)\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Entity Class ${entityKey.fullName} not found in schema context.`);\n\n    if (entity.schemaItemType !== SchemaItemType.EntityClass)\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Expected ${entityKey.fullName} to be of type Entity Class.`);\n\n    await entity.createNavigationProperty(name, relationship, direction);\n    return { itemKey: entityKey, propertyName: name };\n  }\n\n  /**\n   * Creates a Navigation Property through a NavigationPropertyProps.\n   * @param classKey a SchemaItemKey of the Entity Class that will house the new property.\n   * @param navigationProps a json object that will be used to populate the new Navigation Property.\n   */\n  public async createNavigationPropertyFromProps(classKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<PropertyEditResults> {\n    const entity = await this._schemaEditor.schemaContext.getSchemaItem<MutableEntityClass>(classKey);\n    if (entity === undefined)\n      return { itemKey: classKey, propertyName: navigationProps.name, errorMessage: `Entity Class ${classKey.fullName} not found in schema context.`};\n\n    if (entity.schemaItemType !== SchemaItemType.EntityClass)\n      return { itemKey: classKey, propertyName: navigationProps.name, errorMessage: `Expected ${classKey.fullName} to be of type EntityClass.` };\n\n    const navigationProperty  = await entity.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);\n    await navigationProperty.fromJSON(navigationProps);\n\n    return { itemKey: classKey, propertyName: navigationProps.name };\n  }\n}\n"]}
+{"version":3,"file":"Entities.js","sourceRoot":"","sources":["../../../src/Editing/Entities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAGkC;AAElC,2CAAwC;AAExC,6CAAoD;AACpD,2CAA2E;AAE3E;;;GAGG;AACH,MAAa,QAAS,SAAQ,qBAAS;IACrC,YAAmB,YAAiC;QAClD,KAAK,CAAC,kCAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAGlD;;WAEG;QACa,yBAAoB,GAAG,IAAI,iCAAoB,CAAC,kCAAc,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAL/G,CAAC;IAOM,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QAC5J,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACzD,IAAI,CAAC,CAAC,MAAO,SAAyB,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;gBACjE,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,qBAAqB,EAAE,IAAI,mBAAO,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;YACtH,CAAC;QACH,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,aAAa,EAAE,IAAI,mBAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACpH,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QACxK,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACzD,IAAI,CAAC,CAAC,MAAO,SAAyB,CAAC,EAAE,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC7E,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,iCAAiC,EAAE,IAAI,mBAAO,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;YAClI,CAAC;QACH,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,aAAa,EAAE,IAAI,mBAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACpH,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QACvK,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACzD,IAAI,CAAC,CAAC,MAAO,SAAyB,CAAC,EAAE,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC5E,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,gCAAgC,EAAE,IAAI,mBAAO,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;YACjI,CAAC;QACH,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,aAAa,EAAE,IAAI,mBAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACpH,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAAqB,EAAE,YAA4B,EAAE,MAAgB;QACtJ,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAc,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAuB,CAAC;YAE5L,IAAI,MAAM,KAAK,SAAS;gBACtB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAE9C,IAAI,YAAY;gBACd,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAEzC,OAAO,QAAQ,CAAC,GAAG,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,sBAAsB,EAAE,IAAI,mBAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7H,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,WAA6B;QAC9E,IAAI,CAAC;YACH,MAAM,QAAQ,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,WAAW,CAAC,CAAC;YACtJ,OAAO,QAAQ,CAAC,GAAG,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,yBAAyB,EAAE,IAAI,mBAAO,CAAC,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,IAAK,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7I,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,SAAwB,EAAE,QAAuB;QACrE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;YACvE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAQ,QAAQ,EAAE,kCAAc,CAAC,KAAK,CAAC,CAAC;YAC9E,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,QAAQ,EAAE,IAAI,mBAAO,CAAC,kCAAc,CAAC,WAAW,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAChH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,SAAwB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAC3J,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;YACvE,MAAM,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QACvE,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,wBAAwB,EAAE,IAAI,mBAAO,CAAC,kCAAc,CAAC,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACtI,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iCAAiC,CAAC,QAAuB,EAAE,eAAwC;QAC9G,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAqB,QAAQ,CAAC,CAAC;YACtE,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,eAAe,CAAC,IAAI,EAAE,eAAe,CAAC,gBAAgB,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;YAC1I,MAAM,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,iCAAiC,EAAE,IAAI,mBAAO,CAAC,kCAAc,CAAC,WAAW,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QACxI,CAAC;IACH,CAAC;CACF;AAhHD,4BAgHC","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 {\r\n  ECClassModifier, EntityClass, EntityClassProps,\r\n  Mixin, NavigationPropertyProps, RelationshipClass, SchemaItemKey, SchemaItemType, SchemaKey, StrengthDirection,\r\n} from \"@itwin/ecschema-metadata\";\r\nimport { SchemaContextEditor } from \"./Editor\";\r\nimport { ECClasses } from \"./ECClasses\";\r\nimport { MutableEntityClass } from \"./Mutable/MutableEntityClass\";\r\nimport { NavigationProperties } from \"./Properties\";\r\nimport { ClassId, ECEditingStatus, SchemaEditingError } from \"./Exception\";\r\n\r\n/**\r\n * @alpha\r\n * A class extending ECClasses allowing you to create schema items of type EntityClass.\r\n */\r\nexport class Entities extends ECClasses {\r\n  public constructor(schemaEditor: SchemaContextEditor) {\r\n    super(SchemaItemType.EntityClass, schemaEditor);\r\n  }\r\n\r\n  /**\r\n   * Allows access for editing of NavigationProperty attributes.\r\n   */\r\n  public readonly navigationProperties = new NavigationProperties(SchemaItemType.EntityClass, this.schemaEditor);\r\n\r\n  public async createElement(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey> {\r\n    try {\r\n      const baseClass = await this.getSchemaItem(baseClassKey);\r\n      if (!(await (baseClass as EntityClass).is(\"Element\", \"BisCore\"))) {\r\n        throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElement, new ClassId(this.schemaItemType, baseClassKey));\r\n      }\r\n    } catch(e: any){\r\n      throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);\r\n    }\r\n\r\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\r\n  }\r\n\r\n  public async createElementUniqueAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey> {\r\n    try {\r\n      const baseClass = await this.getSchemaItem(baseClassKey);\r\n      if (!(await (baseClass as EntityClass).is(\"ElementUniqueAspect\", \"BisCore\"))) {\r\n        throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElementUniqueAspect, new ClassId(this.schemaItemType, baseClassKey));\r\n      }\r\n    } catch(e: any){\r\n      throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);\r\n    }\r\n\r\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\r\n  }\r\n\r\n  public async createElementMultiAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey> {\r\n    try {\r\n      const baseClass = await this.getSchemaItem(baseClassKey);\r\n      if (!(await (baseClass as EntityClass).is(\"ElementMultiAspect\", \"BisCore\"))) {\r\n        throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElementMultiAspect, new ClassId(this.schemaItemType, baseClassKey));\r\n      }\r\n    } catch(e: any){\r\n      throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);\r\n    }\r\n\r\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\r\n  }\r\n\r\n  public async create(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, displayLabel?: string, baseClassKey?: SchemaItemKey, mixins?: Mixin[]): Promise<SchemaItemKey> {\r\n    try {\r\n      const newClass = await this.createClass<EntityClass>(schemaKey, this.schemaItemType, (schema) => schema.createEntityClass.bind(schema), name, baseClassKey, modifier) as MutableEntityClass;\r\n\r\n      if (mixins !== undefined)\r\n        mixins.forEach((m) => newClass.addMixin(m));\r\n\r\n      if (displayLabel)\r\n        newClass.setDisplayLabel(displayLabel);\r\n\r\n      return newClass.key;\r\n    } catch (e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new ClassId(this.schemaItemType, name, schemaKey), e);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Creates an EntityClass through an EntityClassProps.\r\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\r\n   * @param entityProps a json object that will be used to populate the new EntityClass. Needs a name value passed in.\r\n   */\r\n  public async createFromProps(schemaKey: SchemaKey, entityProps: EntityClassProps): Promise<SchemaItemKey> {\r\n    try {\r\n      const newClass = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createEntityClass.bind(schema), entityProps);\r\n      return newClass.key;\r\n    } catch (e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new ClassId(this.schemaItemType, entityProps.name!, schemaKey), e);\r\n    }\r\n  }\r\n\r\n  public async addMixin(entityKey: SchemaItemKey, mixinKey: SchemaItemKey): Promise<void> {\r\n    try {\r\n      const entity = await this.getSchemaItem<MutableEntityClass>(entityKey);\r\n      const mixin = await this.getSchemaItem<Mixin>(mixinKey, SchemaItemType.Mixin);\r\n      entity.addMixin(mixin);\r\n    } catch(e: any){\r\n      throw new SchemaEditingError(ECEditingStatus.AddMixin, new ClassId(SchemaItemType.EntityClass, entityKey), e);\r\n    }\r\n  }\r\n\r\n  public async createNavigationProperty(entityKey: SchemaItemKey, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<void> {\r\n    try {\r\n      const entity = await this.getSchemaItem<MutableEntityClass>(entityKey);\r\n      await entity.createNavigationProperty(name, relationship, direction);\r\n    } catch(e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.CreateNavigationProperty, new ClassId(SchemaItemType.RelationshipClass, entityKey), e);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Creates a Navigation Property through a NavigationPropertyProps.\r\n   * @param classKey a SchemaItemKey of the Entity Class that will house the new property.\r\n   * @param navigationProps a json object that will be used to populate the new Navigation Property.\r\n   */\r\n  public async createNavigationPropertyFromProps(classKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<void> {\r\n    try {\r\n      const entity = await this.getSchemaItem<MutableEntityClass>(classKey);\r\n      const property = await entity.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);\r\n      await property.fromJSON(navigationProps);\r\n    } catch(e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.CreateNavigationPropertyFromProps, new ClassId(SchemaItemType.EntityClass, classKey), e);\r\n    }\r\n  }\r\n}\r\n"]}

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

@@ -2,21 +2,21 @@
  * @module Editing
  */
 import { AnyEnumerator, EnumerationProps, PrimitiveType, SchemaItemKey, SchemaKey } from "@itwin/ecschema-metadata";
-import { SchemaContextEditor, SchemaItemEditResults } from "./Editor";
+import { SchemaContextEditor } from "./Editor";
+import { SchemaItems } from "./SchemaItems";
 /**
  * @alpha
  * A class allowing you to create schema items of type Enumeration.
  */
-export declare class Enumerations {
-    protected _schemaEditor: SchemaContextEditor;
-    constructor(_schemaEditor: SchemaContextEditor);
-    create(schemaKey: SchemaKey, name: string, type: PrimitiveType.Integer | PrimitiveType.String, displayLabel?: string, isStrict?: boolean, enumerators?: AnyEnumerator[]): Promise<SchemaItemEditResults>;
+export declare class Enumerations extends SchemaItems {
+    constructor(schemaEditor: SchemaContextEditor);
+    create(schemaKey: SchemaKey, name: string, type: PrimitiveType.Integer | PrimitiveType.String, displayLabel?: string, isStrict?: boolean, enumerators?: AnyEnumerator[]): Promise<SchemaItemKey>;
     /**
      * Creates an Enumeration through an EnumeratorProps.
      * @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, enumProps: EnumerationProps): Promise<SchemaItemEditResults>;
+    createFromProps(schemaKey: SchemaKey, enumProps: EnumerationProps): Promise<SchemaItemKey>;
     addEnumerator(enumerationKey: SchemaItemKey, enumerator: AnyEnumerator): Promise<void>;
     setEnumeratorLabel(enumerationKey: SchemaItemKey, enumeratorName: string, label: string | undefined): Promise<void>;
     setEnumeratorDescription(enumerationKey: SchemaItemKey, enumeratorName: string, description: string | undefined): Promise<void>;

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

@@ -1 +1 @@
-{"version":3,"file":"Enumerations.d.ts","sourceRoot":"","sources":["../../../src/Editing/Enumerations.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAgD,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAkB,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAClL,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAOtE;;;GAGG;AACH,qBAAa,YAAY;IACJ,SAAS,CAAC,aAAa,EAAE,mBAAmB;gBAAlC,aAAa,EAAE,mBAAmB;IAElD,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAsBrN;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAgBlG,aAAa,CAAC,cAAc,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBtF,kBAAkB,CAAC,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBnH,wBAAwB,CAAC,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAe7I"}
+{"version":3,"file":"Enumerations.d.ts","sourceRoot":"","sources":["../../../src/Editing/Enumerations.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAe,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAkB,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACjJ,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAM5C;;;GAGG;AACH,qBAAa,YAAa,SAAQ,WAAW;gBACxB,YAAY,EAAE,mBAAmB;IAIvC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAoB7M;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAS1F,aAAa,CAAC,cAAc,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBtF,kBAAkB,CAAC,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnH,wBAAwB,CAAC,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAa7I"}

package/lib/cjs/Editing/Enumerations.js

@@ -9,29 +9,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Enumerations = 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 Enumeration.
  */
-class Enumerations {
-    constructor(_schemaEditor) {
-        this._schemaEditor = _schemaEditor;
+class Enumerations extends SchemaItems_1.SchemaItems {
+    constructor(schemaEditor) {
+        super(ecschema_metadata_1.SchemaItemType.Enumeration, schemaEditor);
     }
     async create(schemaKey, name, type, displayLabel, isStrict, enumerators) {
-        const schema = await this._schemaEditor.getSchema(schemaKey);
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        const newEnum = (await schema.createEnumeration(name, type));
-        if (newEnum === undefined)
-            return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };
-        if (undefined !== isStrict)
-            newEnum.setIsStrict(isStrict);
-        if (undefined !== enumerators)
-            for (const enumerator of enumerators)
-                await this.addEnumerator(newEnum.key, enumerator);
-        if (displayLabel)
-            newEnum.setDisplayLabel(displayLabel);
-        return { itemKey: newEnum.key };
+        try {
+            const newEnum = await this.createSchemaItem(schemaKey, this.schemaItemType, (schema) => schema.createEnumeration.bind(schema), name, type);
+            if (undefined !== isStrict)
+                newEnum.setIsStrict(isStrict);
+            if (undefined !== enumerators)
+                for (const enumerator of enumerators)
+                    await this.addEnumerator(newEnum.key, enumerator);
+            if (displayLabel)
+                newEnum.setDisplayLabel(displayLabel);
+            return newEnum.key;
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateSchemaItemFailed, new Exception_1.SchemaItemId(this.schemaItemType, name, schemaKey), e);
+        }
     }
     /**
      * Creates an Enumeration through an EnumeratorProps.
@@ -39,50 +41,50 @@ class Enumerations {
      * @param relationshipProps a json object that will be used to populate the new RelationshipClass. Needs a name value passed in.
      */
     async createFromProps(schemaKey, enumProps) {
-        const schema = await this._schemaEditor.getSchema(schemaKey);
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        if (enumProps.name === undefined)
-            return { errorMessage: `No name was supplied within props.` };
-        const newEnum = (await schema.createEnumeration(enumProps.name));
-        if (newEnum === undefined)
-            return { errorMessage: `Failed to create class ${enumProps.name} in schema ${schemaKey.toString(true)}.` };
-        await newEnum.fromJSON(enumProps);
-        return { itemKey: newEnum.key };
+        try {
+            const newEnum = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createEnumeration.bind(schema), enumProps);
+            return newEnum.key;
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateSchemaItemFromProps, new Exception_1.SchemaItemId(this.schemaItemType, enumProps.name, schemaKey), e);
+        }
     }
     async addEnumerator(enumerationKey, enumerator) {
-        const enumeration = (await this._schemaEditor.schemaContext.getSchemaItem(enumerationKey));
-        if (enumeration === undefined)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.ClassNotFound, `Unable to locate Enumeration class ${enumerationKey.fullName}.`);
-        if (enumeration.schemaItemType !== ecschema_metadata_1.SchemaItemType.Enumeration)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidType, `${enumeration.fullName} is not of type Enumerator class.`);
-        if (enumeration.isInt && typeof (enumerator.value) !== "number")
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidPrimitiveType, `The Enumeration ${enumeration.name} has type integer, while ${enumerator.name} has type ${typeof (enumerator.value)}.`);
-        if (enumeration.isString && typeof (enumerator.value) !== "string")
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidPrimitiveType, `The Enumeration ${enumeration.name} has type string, while ${enumerator.name} has type ${typeof (enumerator.value)}.`);
-        enumeration.addEnumerator(enumerator);
+        try {
+            const enumeration = await this.getSchemaItem(enumerationKey, ecschema_metadata_1.SchemaItemType.Enumeration);
+            if (enumeration.isInt && typeof (enumerator.value) !== "number")
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.InvalidEnumeratorType, new Exception_1.EnumerationId(enumeration, enumerator));
+            if (enumeration.isString && typeof (enumerator.value) !== "string")
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.InvalidEnumeratorType, new Exception_1.EnumerationId(enumeration, enumerator));
+            enumeration.addEnumerator(enumerator);
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.AddEnumerator, new Exception_1.SchemaItemId(this.schemaItemType, enumerationKey), e);
+        }
     }
     async setEnumeratorLabel(enumerationKey, enumeratorName, label) {
-        const enumeration = (await this._schemaEditor.schemaContext.getSchemaItem(enumerationKey));
-        if (enumeration === undefined)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.ClassNotFound, `Unable to locate Enumeration class ${enumerationKey.fullName}.`);
-        if (enumeration.schemaItemType !== ecschema_metadata_1.SchemaItemType.Enumeration)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidType, `${enumeration.fullName} is not of type Enumerator class.`);
-        const enumerator = enumeration.getEnumeratorByName(enumeratorName);
-        if (enumerator === undefined)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.ClassNotFound, `Enumerator ${enumeratorName} does not exists in Enumeration ${enumeration.fullName}.`);
-        enumerator.label = label;
+        try {
+            const enumeration = await this.getSchemaItem(enumerationKey, ecschema_metadata_1.SchemaItemType.Enumeration);
+            const enumerator = enumeration.getEnumeratorByName(enumeratorName);
+            if (enumerator === undefined)
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.EnumeratorDoesNotExist, new Exception_1.EnumerationId(enumeration, enumeratorName));
+            enumerator.label = label;
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.SetEnumeratorLabel, new Exception_1.SchemaItemId(this.schemaItemType, enumerationKey), e);
+        }
     }
     async setEnumeratorDescription(enumerationKey, enumeratorName, description) {
-        const enumeration = (await this._schemaEditor.schemaContext.getSchemaItem(enumerationKey));
-        if (enumeration === undefined)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.ClassNotFound, `Unable to locate Enumeration class ${enumerationKey.fullName}.`);
-        if (enumeration.schemaItemType !== ecschema_metadata_1.SchemaItemType.Enumeration)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidType, `${enumeration.fullName} is not of type Enumerator class.`);
-        const enumerator = enumeration.getEnumeratorByName(enumeratorName);
-        if (enumerator === undefined)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.ClassNotFound, `Enumerator ${enumeratorName} does not exists in Enumeration ${enumeration.fullName}.`);
-        enumerator.description = description;
+        try {
+            const enumeration = await this.getSchemaItem(enumerationKey, ecschema_metadata_1.SchemaItemType.Enumeration);
+            const enumerator = enumeration.getEnumeratorByName(enumeratorName);
+            if (enumerator === undefined)
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.EnumeratorDoesNotExist, new Exception_1.EnumerationId(enumeration, enumeratorName));
+            enumerator.description = description;
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.SetEnumeratorLabel, new Exception_1.SchemaItemId(this.schemaItemType, enumerationKey), e);
+        }
     }
 }
 exports.Enumerations = Enumerations;

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

@@ -1 +1 @@
-{"version":3,"file":"Enumerations.js","sourceRoot":"","sources":["../../../src/Editing/Enumerations.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAAkL;AAQlL;;;GAGG;AACH,MAAa,YAAY;IACvB,YAA6B,aAAkC;QAAlC,kBAAa,GAAb,aAAa,CAAqB;IAAI,CAAC;IAE7D,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,IAAkD,EAAE,YAAqB,EAAE,QAAkB,EAAE,WAA6B;QAClL,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,EAAE,YAAY,EAAE,0BAA0B,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAEnG,IAAI,SAAS,KAAK,QAAQ;YACvB,OAA8B,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,SAAS,KAAK,WAAW;YAC3B,KAAK,MAAM,UAAU,IAAI,WAAW;gBAClC,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAEtD,IAAI,YAAY;YACb,OAA8B,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEhE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,SAA2B;QAC5E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS;YAC9B,OAAO,EAAE,YAAY,EAAE,oCAAoC,EAAE,CAAC;QAEhE,MAAM,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACjE,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,EAAE,YAAY,EAAE,0BAA0B,SAAS,CAAC,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7G,MAAM,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAClC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,cAA6B,EAAE,UAAyB;QACjF,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAc,cAAc,CAAC,CAAC,CAAC;QAExG,IAAI,WAAW,KAAK,SAAS;YAC3B,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,sCAAsC,cAAc,CAAC,QAAQ,GAAG,CAAC,CAAC;QAE5H,IAAI,WAAW,CAAC,cAAc,KAAK,kCAAc,CAAC,WAAW;YAC3D,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,WAAW,EAAE,GAAG,WAAW,CAAC,QAAQ,mCAAmC,CAAC,CAAC;QAEpH,IAAI,WAAW,CAAC,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,QAAQ;YAC7D,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAE,mBAAmB,WAAW,CAAC,IAAI,4BAA4B,UAAU,CAAC,IAAI,aAAa,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE1L,IAAI,WAAW,CAAC,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,QAAQ;YAChE,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAE,mBAAmB,WAAW,CAAC,IAAI,2BAA2B,UAAU,CAAC,IAAI,aAAa,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAExL,WAAkC,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,cAA6B,EAAE,cAAsB,EAAE,KAAyB;QAC9G,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAc,cAAc,CAAC,CAAC,CAAC;QAExG,IAAI,WAAW,KAAK,SAAS;YAC3B,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,sCAAsC,cAAc,CAAC,QAAQ,GAAG,CAAC,CAAC;QAE5H,IAAI,WAAW,CAAC,cAAc,KAAK,kCAAc,CAAC,WAAW;YAC3D,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,WAAW,EAAE,GAAG,WAAW,CAAC,QAAQ,mCAAmC,CAAC,CAAC;QAEpH,MAAM,UAAU,GAAG,WAAW,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QACnE,IAAI,UAAU,KAAK,SAAS;YAC1B,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,cAAc,cAAc,mCAAmC,WAAW,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEjJ,UAAgC,CAAC,KAAK,GAAG,KAAK,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,cAA6B,EAAE,cAAsB,EAAE,WAA+B;QAC1H,MAAM,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAc,cAAc,CAAC,CAAC,CAAC;QAExG,IAAI,WAAW,KAAK,SAAS;YAC3B,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,sCAAsC,cAAc,CAAC,QAAQ,GAAG,CAAC,CAAC;QAE5H,IAAI,WAAW,CAAC,cAAc,KAAK,kCAAc,CAAC,WAAW;YAC3D,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,WAAW,EAAE,GAAG,WAAW,CAAC,QAAQ,mCAAmC,CAAC,CAAC;QAEpH,MAAM,UAAU,GAAG,WAAW,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QACnE,IAAI,UAAU,KAAK,SAAS;YAC1B,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,cAAc,cAAc,mCAAmC,WAAW,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEjJ,UAAgC,CAAC,WAAW,GAAG,WAAW,CAAC;IAC9D,CAAC;CACF;AA/FD,oCA+FC","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, ECObjectsError, ECObjectsStatus, Enumeration, EnumerationProps, PrimitiveType, SchemaItemKey, SchemaItemType, SchemaKey } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\nimport { MutableEnumeration } from \"./Mutable/MutableEnumeration\";\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 {\n  public constructor(protected _schemaEditor: SchemaContextEditor) { }\n\n  public async create(schemaKey: SchemaKey, name: string, type: PrimitiveType.Integer | PrimitiveType.String, displayLabel?: string, isStrict?: boolean, enumerators?: AnyEnumerator[]): Promise<SchemaItemEditResults> {\n    const schema = await this._schemaEditor.getSchema(schemaKey);\n    if (schema === undefined)\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    const newEnum = (await schema.createEnumeration(name, type));\n    if (newEnum === undefined)\n      return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };\n\n    if (undefined !== isStrict)\n      (newEnum as MutableEnumeration).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 as MutableEnumeration).setDisplayLabel(displayLabel);\n\n    return { itemKey: newEnum.key };\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<SchemaItemEditResults> {\n    const schema = await this._schemaEditor.getSchema(schemaKey);\n    if (schema === undefined)\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    if (enumProps.name === undefined)\n      return { errorMessage: `No name was supplied within props.` };\n\n    const newEnum = (await schema.createEnumeration(enumProps.name));\n    if (newEnum === undefined)\n      return { errorMessage: `Failed to create class ${enumProps.name} in schema ${schemaKey.toString(true)}.` };\n\n    await newEnum.fromJSON(enumProps);\n    return { itemKey: newEnum.key };\n  }\n\n  public async addEnumerator(enumerationKey: SchemaItemKey, enumerator: AnyEnumerator): Promise<void> {\n    const enumeration = (await this._schemaEditor.schemaContext.getSchemaItem<Enumeration>(enumerationKey));\n\n    if (enumeration === undefined)\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Unable to locate Enumeration class ${enumerationKey.fullName}.`);\n\n    if (enumeration.schemaItemType !== SchemaItemType.Enumeration)\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `${enumeration.fullName} is not of type Enumerator class.`);\n\n    if (enumeration.isInt && typeof (enumerator.value) !== \"number\")\n      throw new ECObjectsError(ECObjectsStatus.InvalidPrimitiveType, `The Enumeration ${enumeration.name} has type integer, while ${enumerator.name} has type ${typeof (enumerator.value)}.`);\n\n    if (enumeration.isString && typeof (enumerator.value) !== \"string\")\n      throw new ECObjectsError(ECObjectsStatus.InvalidPrimitiveType, `The Enumeration ${enumeration.name} has type string, while ${enumerator.name} has type ${typeof (enumerator.value)}.`);\n\n    (enumeration as MutableEnumeration).addEnumerator(enumerator);\n  }\n\n  public async setEnumeratorLabel(enumerationKey: SchemaItemKey, enumeratorName: string, label: string | undefined): Promise<void> {\n    const enumeration = (await this._schemaEditor.schemaContext.getSchemaItem<Enumeration>(enumerationKey));\n\n    if (enumeration === undefined)\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Unable to locate Enumeration class ${enumerationKey.fullName}.`);\n\n    if (enumeration.schemaItemType !== SchemaItemType.Enumeration)\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `${enumeration.fullName} is not of type Enumerator class.`);\n\n    const enumerator = enumeration.getEnumeratorByName(enumeratorName);\n    if (enumerator === undefined)\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Enumerator ${enumeratorName} does not exists in Enumeration ${enumeration.fullName}.`);\n\n    (enumerator as MutableEnumerator).label = label;\n  }\n\n  public async setEnumeratorDescription(enumerationKey: SchemaItemKey, enumeratorName: string, description: string | undefined): Promise<void> {\n    const enumeration = (await this._schemaEditor.schemaContext.getSchemaItem<Enumeration>(enumerationKey));\n\n    if (enumeration === undefined)\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Unable to locate Enumeration class ${enumerationKey.fullName}.`);\n\n    if (enumeration.schemaItemType !== SchemaItemType.Enumeration)\n      throw new ECObjectsError(ECObjectsStatus.InvalidType, `${enumeration.fullName} is not of type Enumerator class.`);\n\n    const enumerator = enumeration.getEnumeratorByName(enumeratorName);\n    if (enumerator === undefined)\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Enumerator ${enumeratorName} does not exists in Enumeration ${enumeration.fullName}.`);\n\n    (enumerator as MutableEnumerator).description = description;\n  }\n}\n"]}
+{"version":3,"file":"Enumerations.js","sourceRoot":"","sources":["../../../src/Editing/Enumerations.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAAiJ;AAGjJ,2CAA+F;AAC/F,+CAA4C;AAM5C;;;GAGG;AACH,MAAa,YAAa,SAAQ,yBAAW;IAC3C,YAAmB,YAAiC;QAClD,KAAK,CAAC,kCAAc,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,8BAAkB,CAAC,2BAAe,CAAC,sBAAsB,EAAE,IAAI,wBAAY,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,8BAAkB,CAAC,2BAAe,CAAC,yBAAyB,EAAE,IAAI,wBAAY,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,kCAAc,CAAC,WAAW,CAAC,CAAC;YAEtG,IAAI,WAAW,CAAC,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,QAAQ;gBAC7D,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,qBAAqB,EAAE,IAAI,yBAAa,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;YAElH,IAAI,WAAW,CAAC,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,QAAQ;gBAChE,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,qBAAqB,EAAE,IAAI,yBAAa,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;YAEjH,WAAkC,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAChE,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,aAAa,EAAE,IAAI,wBAAY,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,kCAAc,CAAC,WAAW,CAAC,CAAC;YAEtG,MAAM,UAAU,GAAG,WAAW,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;YACnE,IAAI,UAAU,KAAK,SAAS;gBAC1B,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,sBAAsB,EAAE,IAAI,yBAAa,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC;YAEtH,UAAgC,CAAC,KAAK,GAAG,KAAK,CAAC;QAClD,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,kBAAkB,EAAE,IAAI,wBAAY,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,kCAAc,CAAC,WAAW,CAAC,CAAC;YAEtG,MAAM,UAAU,GAAG,WAAW,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;YACnE,IAAI,UAAU,KAAK,SAAS;gBAC1B,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,sBAAsB,EAAE,IAAI,yBAAa,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC;YAEtH,UAAgC,CAAC,WAAW,GAAG,WAAW,CAAC;QAC9D,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,kBAAkB,EAAE,IAAI,wBAAY,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7H,CAAC;IACH,CAAC;CACF;AAlFD,oCAkFC","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 { AnyEnumerator, Enumeration, EnumerationProps, PrimitiveType, SchemaItemKey, SchemaItemType, SchemaKey } from \"@itwin/ecschema-metadata\";\r\nimport { SchemaContextEditor } from \"./Editor\";\r\nimport { MutableEnumeration } from \"./Mutable/MutableEnumeration\";\r\nimport { ECEditingStatus, EnumerationId, SchemaEditingError, SchemaItemId } from \"./Exception\";\r\nimport { SchemaItems } from \"./SchemaItems\";\r\n\r\ntype MutableEnumerator = {\r\n  -readonly [P in keyof AnyEnumerator]: AnyEnumerator[P]\r\n};\r\n\r\n/**\r\n * @alpha\r\n * A class allowing you to create schema items of type Enumeration.\r\n */\r\nexport class Enumerations extends SchemaItems {\r\n  public constructor(schemaEditor: SchemaContextEditor) {\r\n    super(SchemaItemType.Enumeration, schemaEditor);\r\n  }\r\n\r\n  public async create(schemaKey: SchemaKey, name: string, type: PrimitiveType.Integer | PrimitiveType.String, displayLabel?: string, isStrict?: boolean, enumerators?: AnyEnumerator[]): Promise<SchemaItemKey> {\r\n    try {\r\n      const newEnum = await this.createSchemaItem<Enumeration>(schemaKey, this.schemaItemType, (schema) => schema.createEnumeration.bind(schema), name, type) as MutableEnumeration;\r\n\r\n      if (undefined !== isStrict)\r\n        newEnum.setIsStrict(isStrict);\r\n\r\n      if (undefined !== enumerators)\r\n        for (const enumerator of enumerators)\r\n          await this.addEnumerator(newEnum.key, enumerator);\r\n\r\n      if (displayLabel)\r\n        newEnum.setDisplayLabel(displayLabel);\r\n\r\n      return newEnum.key;\r\n    } catch (e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new SchemaItemId(this.schemaItemType, name, schemaKey), e);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Creates an Enumeration through an EnumeratorProps.\r\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\r\n   * @param relationshipProps a json object that will be used to populate the new RelationshipClass. Needs a name value passed in.\r\n   */\r\n  public async createFromProps(schemaKey: SchemaKey, enumProps: EnumerationProps): Promise<SchemaItemKey> {\r\n    try {\r\n      const newEnum = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createEnumeration.bind(schema), enumProps);\r\n      return newEnum.key;\r\n    } catch (e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new SchemaItemId(this.schemaItemType, enumProps.name!, schemaKey), e);\r\n    }\r\n  }\r\n\r\n  public async addEnumerator(enumerationKey: SchemaItemKey, enumerator: AnyEnumerator): Promise<void> {\r\n    try {\r\n      const enumeration = await this.getSchemaItem<Enumeration>(enumerationKey, SchemaItemType.Enumeration);\r\n\r\n      if (enumeration.isInt && typeof (enumerator.value) !== \"number\")\r\n        throw new SchemaEditingError(ECEditingStatus.InvalidEnumeratorType, new EnumerationId(enumeration, enumerator));\r\n\r\n      if (enumeration.isString && typeof (enumerator.value) !== \"string\")\r\n        throw new SchemaEditingError(ECEditingStatus.InvalidEnumeratorType, new EnumerationId(enumeration, enumerator));\r\n\r\n      (enumeration as MutableEnumeration).addEnumerator(enumerator);\r\n    } catch(e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.AddEnumerator, new SchemaItemId(this.schemaItemType, enumerationKey), e);\r\n    }\r\n  }\r\n\r\n  public async setEnumeratorLabel(enumerationKey: SchemaItemKey, enumeratorName: string, label: string | undefined): Promise<void> {\r\n    try {\r\n      const enumeration = await this.getSchemaItem<Enumeration>(enumerationKey, SchemaItemType.Enumeration);\r\n\r\n      const enumerator = enumeration.getEnumeratorByName(enumeratorName);\r\n      if (enumerator === undefined)\r\n        throw new SchemaEditingError(ECEditingStatus.EnumeratorDoesNotExist, new EnumerationId(enumeration, enumeratorName));\r\n\r\n      (enumerator as MutableEnumerator).label = label;\r\n    } catch(e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.SetEnumeratorLabel, new SchemaItemId(this.schemaItemType, enumerationKey), e);\r\n    }\r\n  }\r\n\r\n  public async setEnumeratorDescription(enumerationKey: SchemaItemKey, enumeratorName: string, description: string | undefined): Promise<void> {\r\n    try {\r\n      const enumeration = await this.getSchemaItem<Enumeration>(enumerationKey, SchemaItemType.Enumeration);\r\n\r\n      const enumerator = enumeration.getEnumeratorByName(enumeratorName);\r\n      if (enumerator === undefined)\r\n        throw new SchemaEditingError(ECEditingStatus.EnumeratorDoesNotExist, new EnumerationId(enumeration, enumeratorName));\r\n\r\n      (enumerator as MutableEnumerator).description = description;\r\n    } catch(e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.SetEnumeratorLabel, new SchemaItemId(this.schemaItemType, enumerationKey), e);\r\n    }\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,257 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { BentleyError } from "@itwin/core-bentley";
+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,
+    InvalidStrengthDirection = 196625,
+    InvalidECName = 196626,
+    InvalidFormatUnitsSpecified = 196627,
+    CreateSchemaItemFailed = 196628,
+    CreateSchemaItemFromProps = 196629,
+    CreateElement = 196630,
+    CreateElementUniqueAspect = 196631,
+    CreateElementMultiAspect = 196632,
+    SetBaseClass = 196633,
+    SetSourceConstraint = 196634,
+    SetTargetConstraint = 196635,
+    AddConstraintClass = 196636,
+    RemoveConstraintClass = 196637,
+    SetAbstractConstraint = 196638,
+    AddCustomAttributeToConstraint = 196639,
+    AddCustomAttributeToProperty = 196640,
+    AddCustomAttributeToClass = 196641,
+    CreateNavigationProperty = 196642,
+    CreateNavigationPropertyFromProps = 196643,
+    SetInvertsUnit = 196644,
+    SetUnitSystem = 196645,
+    SetDescription = 196646,
+    SetLabel = 196647,
+    SetIsReadOnly = 196648,
+    SetPriority = 196649,
+    SetCategory = 196650,
+    SetMinOccurs = 196651,
+    SetMaxOccurs = 196652,
+    SetExtendedTypeName = 196653,
+    SetMinLength = 196654,
+    SetMaxLength = 196655,
+    SetMinValue = 196656,
+    SetMaxValue = 196657,
+    SetPropertyName = 196658,
+    AddMixin = 196659,
+    AddEnumerator = 196660,
+    SetEnumeratorLabel = 196661,
+    SetEnumeratorDescription = 196662,
+    AddPresentationUnit = 196663,
+    AddPresentationOverride = 196664,
+    CreateFormatOverride = 196665,
+    SetPropertyCategoryPriority = 196666,
+    CreatePrimitiveProperty = 196667,
+    CreatePrimitivePropertyFromProps = 196668,
+    CreateEnumerationProperty = 196669,
+    CreateEnumerationPropertyFromProps = 196670,
+    CreatePrimitiveArrayProperty = 196671,
+    CreatePrimitiveArrayPropertyFromProps = 196672,
+    CreateEnumerationArrayProperty = 196673,
+    CreateEnumerationArrayPropertyFromProps = 196674,
+    CreateStructProperty = 196675,
+    CreateStructPropertyFromProps = 196676,
+    CreateStructArrayProperty = 196677,
+    CreateStructArrayPropertyFromProps = 196678,
+    DeleteProperty = 196679,
+    DeleteClass = 196680,
+    SetClassName = 196681,
+    AddSchemaReference = 196682,
+    SetSchemaVersion = 196683,
+    IncrementSchemaMinorVersion = 196684
+}
+export type AnyEditingError = SchemaEditingError | Error;
+export declare enum TaskType {
+    Add = 0,
+    Create = 1,
+    Update = 2,
+    Change = 3,
+    Delete = 4
+}
+export declare enum PropertyTypeName {
+    ArrayProperty = "ArrayProperty",
+    PrimitiveProperty = "PrimitiveProperty",
+    EnumerationProperty = "EnumerationProperty",
+    NavigationProperty = "NavigationProperty",
+    StructProperty = "StructProperty"
+}
+type ECClassSchemaItems = SchemaItemType.EntityClass | SchemaItemType.StructClass | SchemaItemType.RelationshipClass | SchemaItemType.Mixin | SchemaItemType.CustomAttributeClass;
+export interface SchemaTypeIdentifier {
+    name: string;
+}
+export declare class SchemaId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    constructor(schemaKey: SchemaKey);
+}
+export declare class SchemaItemId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly type: SchemaItemType;
+    readonly schemaKey: SchemaKey;
+    readonly schemaItemKey: SchemaItemKey;
+    constructor(schemaItemType: SchemaItemType, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey);
+}
+export declare class ClassId extends SchemaItemId {
+    constructor(schemaItemType: ECClassSchemaItems, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey);
+}
+export declare class PropertyId implements SchemaTypeIdentifier {
+    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);
+}
+export declare class EnumerationId extends SchemaItemId {
+    readonly enumerationType: string;
+    readonly enumeratorName: string;
+    readonly enumeratorType: string;
+    constructor(enumeration: Enumeration, enumerator: AnyEnumerator | string);
+    private getEnumeratorType;
+}
+export declare class CustomAttributeId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    readonly containerFullName: string;
+    constructor(name: string, container: CustomAttributeContainerProps);
+}
+export declare class RelationshipConstraintId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly relationshipKey: SchemaItemKey;
+    readonly schemaKey: SchemaKey;
+    constructor(constraint: RelationshipConstraint);
+}
+type AnyIdentifier = SchemaId | PropertyId | CustomAttributeId | RelationshipConstraintId | EnumerationId;
+/**
+ * Indicates if the given identifier is a SchemaId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isSchemaIdentifier(identifier: AnyIdentifier): identifier is SchemaId;
+/**
+ * Indicates if the given identifier is a SchemaId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isSchemaItemIdentifier(identifier: AnyIdentifier): identifier is SchemaItemId;
+/**
+ * Indicates if the given identifier is a ClassId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isClassIdentifier(identifier: AnyIdentifier): identifier is ClassId;
+/**
+ * Indicates if the given identifier is a PropertyId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isPropertyIdentifier(identifier: AnyIdentifier): identifier is PropertyId;
+/**
+ * Indicates if the given identifier is a EnumerationId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isEnumerationIdentifier(identifier: AnyIdentifier): identifier is EnumerationId;
+/**
+ * Indicates if the given identifier is a CustomAttributeId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isCustomAttributeIdentifier(identifier: AnyIdentifier): identifier is CustomAttributeId;
+/**
+ * Indicates if the given identifier is a RelationshipConstraintId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isRelationshipConstraintIdentifier(identifier: AnyIdentifier): identifier is RelationshipConstraintId;
+/**
+ * @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.
+ */
+export declare class SchemaEditingError extends BentleyError {
+    readonly errorNumber: number;
+    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: number, identifier: AnyIdentifier, innerError?: AnyEditingError | undefined, ruleViolations?: AnyDiagnostic[], message?: string);
+    /**
+     * Gets the SchemaId instance.
+     * @throws Error if the identifier is not an instance of SchemaId.
+     */
+    get schemaId(): SchemaId;
+    /**
+     * Gets the SchemaItemId instance.
+     * @throws Error if the identifier is not an instance of SchemaItemId.
+     */
+    get schemaItemId(): SchemaItemId;
+    /**
+     * Gets the ClassId instance.
+     * @throws Error if the identifier is not an instance of ClassId.
+     */
+    get classId(): ClassId;
+    /**
+     * Gets the PropertyId instance.
+     * @throws Error if the identifier is not an instance of PropertyId.
+     */
+    get propertyId(): PropertyId;
+    /**
+     * Gets the EnumerationId instance.
+     * @throws Error if the identifier is not an instance of EnumerationId.
+     */
+    get enumerationId(): EnumerationId;
+    /**
+     * Gets the CustomAttributeId instance.
+     * @throws Error if the identifier is not an instance of CustomAttributeId.
+     */
+    get customAttributeId(): CustomAttributeId;
+    /**
+     * Gets the RelationshipConstraintId instance.
+     * @throws Error if the identifier is not an instance of RelationshipConstraintId.
+     */
+    get relationshipConstraintId(): RelationshipConstraintId;
+    get ruleViolations(): AnyDiagnostic[] | undefined;
+    toDebugString(): string;
+    private _appendMessage;
+    private generateMessage;
+    private getRuleViolationMessage;
+}
+export {};
+//# sourceMappingURL=Exception.d.ts.map

package/lib/cjs/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,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,6BAA6B,EAAE,WAAW,EAAyB,QAAQ,EAAE,sBAAsB,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAExM,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,wBAAwB,SAAA;IACxB,aAAa,SAAA;IACb,2BAA2B,SAAA;IAE3B,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,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;CAC5B;AAED,MAAM,MAAM,eAAe,GAAG,kBAAkB,GAAG,KAAK,CAAC;AAEzD,oBAAY,QAAQ;IAClB,GAAG,IAAA;IACH,MAAM,IAAA;IACN,MAAM,IAAA;IACN,MAAM,IAAA;IACN,MAAM,IAAA;CACP;AAED,oBAAY,gBAAgB;IAC1B,aAAa,kBAAkB;IAC/B,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAC3C,kBAAkB,uBAAuB;IACzC,cAAc,mBAAmB;CAClC;AAED,KAAK,kBAAkB,GAAG,cAAc,CAAC,WAAW,GAAG,cAAc,CAAC,WAAW,GAAG,cAAc,CAAC,iBAAiB,GAAG,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,oBAAoB,CAAC;AAElL,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,qBAAa,QAAS,YAAW,oBAAoB;IACnD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,SAAS,CAAC;gBACzB,SAAS,EAAE,SAAS;CAIjC;AAED,qBAAa,YAAa,YAAW,oBAAoB;IACvD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,IAAI,EAAE,cAAc,CAAC;IACrC,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,aAAa,EAAE,aAAa,CAAC;gBACjC,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,aAAa,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;CAe/G;AAED,qBAAa,OAAQ,SAAQ,YAAY;gBAC3B,cAAc,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,aAAa,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;CAGnH;AAED,qBAAa,UAAW,YAAW,oBAAoB;IACrD,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,qBAAa,aAAc,SAAQ,YAAY;IAC7C,SAAgB,eAAe,EAAE,MAAM,CAAC;IACxC,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC,SAAgB,cAAc,EAAE,MAAM,CAAC;gBAC3B,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,GAAG,MAAM;IAOxE,OAAO,CAAC,iBAAiB;CAM1B;AAED,qBAAa,iBAAkB,YAAW,oBAAoB;IAC5D,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,qBAAa,wBAAyB,YAAW,oBAAoB;IACnE,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,KAAK,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,iBAAiB,GAAG,wBAAwB,GAAG,aAAa,CAAC;AAE1G;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,QAAQ,CAEpF;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,YAAY,CAE5F;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,OAAO,CAElF;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,UAAU,CAExF;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,aAAa,CAE9F;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,iBAAiB,CAEtG;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,wBAAwB,CAEpH;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;aAYN,WAAW,EAAE,MAAM;aAAkB,UAAU,EAAE,aAAa;aAAkB,UAAU,CAAC;IAXvI,OAAO,CAAC,eAAe,CAAC,CAAkB;IAC1C,OAAO,CAAC,UAAU,CAAY;IAE9B;;;;;;;OAOG;gBACyC,WAAW,EAAE,MAAM,EAAkB,UAAU,EAAE,aAAa,EAAkB,UAAU,CAAC,6BAAiB,EAAE,cAAc,CAAC,EAAE,aAAa,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM;IAO5M;;;OAGG;IACH,IAAW,QAAQ,IAAI,QAAQ,CAI9B;IAED;;;OAGG;IACH,IAAW,YAAY,IAAI,YAAY,CAItC;IAED;;;OAGG;IACH,IAAW,OAAO,IAAI,OAAO,CAI5B;IAED;;;OAGG;IACH,IAAW,UAAU,IAAI,UAAU,CAIlC;IAED;;;OAGG;IACH,IAAW,aAAa,IAAI,aAAa,CAIxC;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,iBAAiB,CAIhD;IAED;;;OAGG;IACH,IAAW,wBAAwB,IAAI,wBAAwB,CAI9D;IAED,IAAW,cAAc,IAAI,aAAa,EAAE,GAAG,SAAS,CAEvD;IAEM,aAAa,IAAI,MAAM;IAW9B,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,eAAe;IA2DvB,OAAO,CAAC,uBAAuB;CAuBhC"}