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

package/lib/cjs/Differencing/SchemaDifference.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaDifference.js","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifference.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,iEAA8D;AAE9D,uEAAoE;AACpE,gEAKkC;AAsBlC;;;GAGG;AACH,IAAY,gBASX;AATD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,uDAAmC,CAAA;IACnC,yCAAqB,CAAA;IACrB,6CAAyB,CAAA;IACzB,uEAAmD,CAAA;IACnD,qEAAiD,CAAA;IACjD,+EAA2D,CAAA;IAC3D,yDAAqC,CAAA;AACvC,CAAC,EATW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAS3B;AAQD;;GAEG;AACH,IAAiB,gBAAgB,CAoMhC;AApMD,WAAiB,gBAAgB;IAC/B;;;;;;OAMG;IACI,KAAK,UAAU,WAAW,CAAC,YAAoB,EAAE,YAAoB;QAC1E,MAAM,WAAW,GAAoB,EAAE,CAAC;QACxC,MAAM,cAAc,GAAG,IAAI,+BAAc,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC1F,MAAM,cAAc,CAAC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAEhE,OAAO,iBAAiB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IANqB,4BAAW,cAMhC,CAAA;IAED;;;;;;OAMG;IACI,KAAK,UAAU,iBAAiB,CAAC,YAAoB,EAAE,aAA4B;QACxF,MAAM,OAAO,GAAG,IAAI,iDAAuB,EAAE,CAAC;QAC9C,KAAK,MAAM,UAAU,IAAI,aAAa,CAAC,cAAc,EAAE;YACrD,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;SAC3B;QAED,MAAM,OAAO,GAA0B;YACrC,GAAG,OAAO,CAAC,aAAa;YACxB,GAAG,OAAO,CAAC,iBAAiB;YAC5B,GAAG,OAAO,CAAC,qBAAqB;YAChC,GAAG,OAAO,CAAC,sBAAsB;SAClC,CAAC;QAEF,OAAO;YACL,gBAAgB,EAAE,aAAa,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;YAC3D,gBAAgB,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;YACnD,OAAO,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;YACjD,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;SACxE,CAAC;IACJ,CAAC;IAnBqB,kCAAiB,oBAmBtC,CAAA;IAED;;;OAGG;IACH,SAAgB,oBAAoB,CAAC,UAA+B;QAClE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,QAAQ,CAAC;IAC3D,CAAC;IAFe,qCAAoB,uBAEnC,CAAA;IAED;;;OAGG;IACH,SAAgB,yBAAyB,CAAC,UAA+B;QACvE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,QAAQ,CAAC;IAC7D,CAAC;IAFe,0CAAyB,4BAExC,CAAA;IAED;;;OAGG;IACH,SAAgB,gCAAgC,CAAC,UAA+B;QAC9E,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,oBAAoB,CAAC;IACvE,CAAC;IAFe,iDAAgC,mCAE/C,CAAA;IAED;;;OAGG;IACH,SAAgB,2BAA2B,CAAC,UAA+B;QACzE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,uBAAuB,CAAC;IAC5E,CAAC;IAFe,4CAA2B,8BAE1C,CAAA;IAED;;;OAGG;IACH,SAAgB,uBAAuB,CAAC,UAA+B;QACrE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,WAAW,CAAC;IAC9D,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED;;;OAGG;IACH,SAAgB,4BAA4B,CAAC,UAA+B;QAC1E,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,gBAAgB,CAAC;IACrE,CAAC;IAFe,6CAA4B,+BAE3C,CAAA;IAED;;;OAGG;IACH,SAAgB,uBAAuB,CAAC,UAA+B;QACrE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,WAAW,CAAC;IAC9D,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED;;;OAGG;IACH,SAAgB,sBAAsB,CAAC,UAA+B;QACpE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,UAAU,CAAC;IAC/D,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED;;;OAGG;IACH,SAAgB,0BAA0B,CAAC,UAA+B;QACxE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,cAAc,CAAC;IACjE,CAAC;IAFe,2CAA0B,6BAEzC,CAAA;IAED;;;OAGG;IACH,SAAgB,sBAAsB,CAAC,UAA+B;QACpE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,KAAK,CAAC;IACxD,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED;;;OAGG;IACH,SAAgB,sBAAsB,CAAC,UAA+B;QACpE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,UAAU,CAAC;IAC7D,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED;;;OAGG;IACH,SAAgB,4BAA4B,CAAC,UAA+B;QAC1E,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,gBAAgB,CAAC;IACnE,CAAC;IAFe,6CAA4B,+BAE3C,CAAA;IAED;;;OAGG;IACH,SAAgB,kBAAkB,CAAC,UAA+B;QAChE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,MAAM,CAAC;IAC3D,CAAC;IAFe,mCAAkB,qBAEjC,CAAA;IAED;;;OAGG;IACH,SAAgB,2BAA2B,CAAC,UAA+B;QACzE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,eAAe,CAAC;IACpE,CAAC;IAFe,4CAA2B,8BAE1C,CAAA;IAED;;;OAGG;IACH,SAAgB,uBAAuB,CAAC,UAA+B;QACrE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,WAAW,CAAC;IAC9D,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED;;;OAGG;IACH,SAAgB,sBAAsB,CAAC,UAA+B;QACpE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,UAAU,CAAC;IAC7D,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED;;;OAGG;IACH,SAAgB,6BAA6B,CAAC,UAA+B;QAC3E,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,iBAAiB,CAAC;IACpE,CAAC;IAFe,8CAA6B,gCAE5C,CAAA;IAED;;;OAGG;IACH,SAAgB,kCAAkC,CAAC,UAA+B;QAChF,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,sBAAsB,CAAC;IAC3E,CAAC;IAFe,mDAAkC,qCAEjD,CAAA;IAED;;;OAGG;IACH,SAAgB,uCAAuC,CAAC,UAA+B;QACrF,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,2BAA2B,CAAC;IAChF,CAAC;IAFe,wDAAuC,0CAEtD,CAAA;AAEH,CAAC,EApMgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAoMhC","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 Differencing\n */\n\nimport { SchemaChanges } from \"../Validation/SchemaChanges\";\nimport { SchemaComparer } from \"../Validation/SchemaComparer\";\nimport { SchemaDifferenceConflict } from \"./SchemaConflicts\";\nimport { SchemaDiagnosticVisitor } from \"./SchemaDiagnosticVisitor\";\nimport {\n  AnyEnumerator, AnyPropertyProps, ConstantProps, CustomAttribute,\n  CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps,\n  MixinProps, PhenomenonProps, PropertyCategoryProps, RelationshipClassProps, RelationshipConstraintProps,\n  type Schema, SchemaItemFormatProps, SchemaItemProps, SchemaItemType, SchemaItemUnitProps, SchemaReferenceProps, StructClassProps, UnitSystemProps,\n} from \"@itwin/ecschema-metadata\";\n\n/** Utility-Type to remove possible readonly flags on the given type. */\ntype PartialEditable<T> = {\n  -readonly [P in keyof T]?: T[P];\n};\n\n/**\n * Utility-Type to simplify the expected SchemaItem props by omitting the base properties\n * that are not needed for the schema differencing. Also all properties are made mutable\n * by removing the readonly flag if present.\n */\ntype SchemaItemProperties<T extends SchemaItemProps> = {\n  [P in keyof PartialEditable<Omit<T, keyof Omit<SchemaItemProps, \"label\" | \"description\" | \"customAttributes\">>>]: T[P]\n};\n\n/**\n * Defines the type of the difference operation.\n * @alpha\n */\nexport type DifferenceType = \"add\" | \"modify\";\n\n/**\n * Defines the SchemaTypes that are not SchemaItems.\n * @alpha\n */\nexport enum SchemaOtherTypes {\n  Schema = \"Schema\",\n  SchemaReference = \"SchemaReference\",\n  Property = \"Property\",\n  Enumerator = \"Enumerator\",\n  CustomAttributeInstance = \"CustomAttributeInstance\",\n  RelationshipConstraint = \"RelationshipConstraint\",\n  RelationshipConstraintClass = \"RelationshipConstraintClass\",\n  EntityClassMixin = \"EntityClassMixin\",\n}\n\n/**\n * Defines the possible values SchemaTypes that can occur in SchemaDifferences or Conflicts.\n * @alpha\n */\nexport type SchemaType = SchemaOtherTypes | SchemaItemType;\n\n/**\n * @alpha\n */\nexport namespace SchemaDifference {\n  /**\n   * Creates a [[SchemaDifference]] for two given schemas.\n   * @param targetSchema  The schema the differences gets merged into.\n   * @param sourceSchema  The schema to get merged in the target.\n   * @returns             An [[SchemaDifference]] object.\n   * @alpha\n   */\n  export async function fromSchemas(targetSchema: Schema, sourceSchema: Schema): Promise<SchemaDifferences> {\n    const changesList: SchemaChanges[] = [];\n    const schemaComparer = new SchemaComparer({ report: changesList.push.bind(changesList) });\n    await schemaComparer.compareSchemas(sourceSchema, targetSchema);\n\n    return fromSchemaChanges(targetSchema, changesList[0]);\n  }\n\n  /**\n   * Creates a [[SchemaDifference]] for a given [[SchemaChanges]] report.\n   * @param targetSchema\n   * @param schemaChanges   A changes report of two schemas.\n   * @returns               An [[SchemaDifference]] object.\n   * @internal\n   */\n  export async function fromSchemaChanges(targetSchema: Schema, schemaChanges: SchemaChanges): Promise<SchemaDifferences> {\n    const visitor = new SchemaDiagnosticVisitor();\n    for (const diagnostic of schemaChanges.allDiagnostics) {\n      visitor.visit(diagnostic);\n    }\n\n    const changes: AnySchemaDifference[] = [\n      ...visitor.schemaChanges,\n      ...visitor.schemaItemChanges,\n      ...visitor.schemaItemPathChanges,\n      ...visitor.customAttributeChanges,\n    ];\n\n    return {\n      sourceSchemaName: schemaChanges.schema.schemaKey.toString(),\n      targetSchemaName: targetSchema.schemaKey.toString(),\n      changes: changes.length > 0 ? changes : undefined,\n      conflicts: visitor.conflicts.length > 0 ? visitor.conflicts : undefined,\n    };\n  }\n\n  /**\n   * Indicates whether the given difference is type of ConstantDifference.\n   * @alpha\n   */\n  export function isConstantDifference(difference: AnySchemaDifference): difference is ConstantDifference {\n    return difference.schemaType === SchemaItemType.Constant;\n  }\n\n  /**\n   * Indicates whether the given difference is type of ClassPropertyDifference.\n   * @alpha\n   */\n  export function isClassPropertyDifference(difference: AnySchemaDifference): difference is ClassPropertyDifference {\n    return difference.schemaType === SchemaOtherTypes.Property;\n  }\n\n  /**\n   * Indicates whether the given difference is type of CustomAttributeClassDifference.\n   * @alpha\n   */\n  export function isCustomAttributeClassDifference(difference: AnySchemaDifference): difference is CustomAttributeClassDifference {\n    return difference.schemaType === SchemaItemType.CustomAttributeClass;\n  }\n\n  /**\n   * Indicates whether the given difference is type of CustomAttributeDifference.\n   * @alpha\n   */\n  export function isCustomAttributeDifference(difference: AnySchemaDifference): difference is CustomAttributeDifference {\n    return difference.schemaType === SchemaOtherTypes.CustomAttributeInstance;\n  }\n\n  /**\n   * Indicates whether the given difference is type of EntityClassDifference.\n   * @alpha\n   */\n  export function isEntityClassDifference(difference: AnySchemaDifference): difference is EntityClassDifference {\n    return difference.schemaType === SchemaItemType.EntityClass;\n  }\n\n  /**\n   * Indicates whether the given difference is type of EntityClassMixinDifference.\n   * @alpha\n   */\n  export function isEntityClassMixinDifference(difference: AnySchemaDifference): difference is EntityClassMixinDifference {\n    return difference.schemaType === SchemaOtherTypes.EntityClassMixin;\n  }\n\n  /**\n   * Indicates whether the given difference is type of EnumerationDifference.\n   * @alpha\n   */\n  export function isEnumerationDifference(difference: AnySchemaDifference): difference is EnumerationDifference {\n    return difference.schemaType === SchemaItemType.Enumeration;\n  }\n\n  /**\n   * Indicates whether the given difference is type of EnumeratorDifference.\n   * @alpha\n   */\n  export function isEnumeratorDifference(difference: AnySchemaDifference): difference is EnumeratorDifference {\n    return difference.schemaType === SchemaOtherTypes.Enumerator;\n  }\n\n  /**\n   * Indicates whether the given difference is type of KindOfQuantityDifference.\n   * @alpha\n   */\n  export function isKindOfQuantityDifference(difference: AnySchemaDifference): difference is KindOfQuantityDifference {\n    return difference.schemaType === SchemaItemType.KindOfQuantity;\n  }\n\n  /**\n   * Indicates whether the given difference is type of MixinClassDifference.\n   * @alpha\n   */\n  export function isMixinClassDifference(difference: AnySchemaDifference): difference is MixinClassDifference {\n    return difference.schemaType === SchemaItemType.Mixin;\n  }\n\n  /**\n   * Indicates whether the given difference is type of PhenomenonDifference.\n   * @alpha\n   */\n  export function isPhenomenonDifference(difference: AnySchemaDifference): difference is PhenomenonDifference {\n    return difference.schemaType === SchemaItemType.Phenomenon;\n  }\n\n  /**\n   * Indicates whether the given difference is type of PropertyCategoryDifference.\n   * @alpha\n   */\n  export function isPropertyCategoryDifference(difference: AnySchemaDifference): difference is PropertyCategoryDifference {\n    return difference.schemaType === SchemaItemType.PropertyCategory;\n  }\n\n  /**\n   * Indicates whether the given difference is type of SchemaDifference.\n   * @alpha\n   */\n  export function isSchemaDifference(difference: AnySchemaDifference): difference is SchemaDifference {\n    return difference.schemaType === SchemaOtherTypes.Schema;\n  }\n\n  /**\n   * Indicates whether the given difference is type of SchemaReferenceDifference.\n   * @alpha\n   */\n  export function isSchemaReferenceDifference(difference: AnySchemaDifference): difference is SchemaReferenceDifference {\n    return difference.schemaType === SchemaOtherTypes.SchemaReference;\n  }\n\n  /**\n   * Indicates whether the given difference is type of CustomAttributeDifference.\n   * @alpha\n   */\n  export function isStructClassDifference(difference: AnySchemaDifference): difference is StructClassDifference {\n    return difference.schemaType === SchemaItemType.StructClass;\n  }\n\n  /**\n   * Indicates whether the given difference is type of UnitSystemDifference.\n   * @alpha\n   */\n  export function isUnitSystemDifference(difference: AnySchemaDifference): difference is UnitSystemDifference {\n    return difference.schemaType === SchemaItemType.UnitSystem;\n  }\n\n  /**\n   * Indicates whether the given difference is type of RelationshipClassDifference.\n   * @alpha\n   */\n  export function isRelationshipClassDifference(difference: AnySchemaDifference): difference is RelationshipClassDifference {\n    return difference.schemaType === SchemaItemType.RelationshipClass;\n  }\n\n  /**\n   * Indicates whether the given difference is type of RelationshipConstraintDifference.\n   * @alpha\n   */\n  export function isRelationshipConstraintDifference(difference: AnySchemaDifference): difference is RelationshipConstraintDifference {\n    return difference.schemaType === SchemaOtherTypes.RelationshipConstraint;\n  }\n\n  /**\n   * Indicates whether the given difference is type of RelationshipConstraintClassDifference.\n   * @alpha\n   */\n  export function isRelationshipConstraintClassDifference(difference: AnySchemaDifference): difference is RelationshipConstraintClassDifference {\n    return difference.schemaType === SchemaOtherTypes.RelationshipConstraintClass;\n  }\n\n}\n\n/**\n * Definition of the differences between two Schemas.\n * @alpha\n */\nexport interface SchemaDifferences {\n  /** Full name of the source schema */\n  readonly sourceSchemaName: string;\n  /** Full name of the target schema */\n  readonly targetSchemaName: string;\n\n  /** List of differences between the compared schemas. */\n  readonly changes?: AnySchemaDifference[];\n  /** List of conflicts found while comparing the schemas. */\n  readonly conflicts?: SchemaDifferenceConflict[];\n}\n\n/**\n * Union of all supported schema differencing types.\n * @alpha\n */\nexport type AnySchemaDifference =\n  SchemaDifference |\n  SchemaReferenceDifference |\n  AnySchemaItemDifference |\n  AnySchemaItemPathDifference |\n  CustomAttributeDifference;\n\n/**\n * Differencing entry for changes on a Schema.\n * @alpha\n */\nexport interface SchemaDifference {\n  readonly changeType: \"modify\";\n  readonly schemaType: SchemaOtherTypes.Schema;\n  readonly difference: {\n    label?: string;\n    description?: string;\n  };\n}\n\n/**\n * Differencing entry for added or changed Schema References of a Schema.\n * @alpha\n */\nexport interface SchemaReferenceDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.SchemaReference;\n  readonly difference: SchemaReferenceProps;\n}\n\n/**\n * Union of all supported schema item differencing types.\n * @alpha\n */\nexport type AnySchemaItemDifference =\n  ClassItemDifference |\n  ConstantDifference |\n  EnumerationDifference |\n  EntityClassMixinDifference |\n  FormatDifference |\n  KindOfQuantityDifference |\n  InvertedUnitDifference |\n  PhenomenonDifference |\n  PropertyCategoryDifference |\n  UnitDifference |\n  UnitSystemDifference;\n\n/**\n * Union for supported class Schema Items.\n * @internal\n */\nexport type ClassItemDifference =\n  EntityClassDifference |\n  MixinClassDifference |\n  StructClassDifference |\n  CustomAttributeClassDifference |\n  RelationshipClassDifference;\n\n/**\n * Union of all differences that have a path pointing inside a schema item.\n * @alpha\n */\nexport type AnySchemaItemPathDifference =\n  RelationshipConstraintDifference |\n  RelationshipConstraintClassDifference |\n  CustomAttributePropertyDifference |\n  EnumeratorDifference |\n  ClassPropertyDifference;\n\n/**\n * Internal base class for all Schema Item differencing entries.\n * @alpha\n */\ninterface SchemaItemDifference<T extends SchemaItemProps> {\n  readonly changeType: \"add\" | \"modify\";\n  readonly itemName: string;\n  readonly difference: SchemaItemProperties<T>;\n}\n\n/**\n * Differencing entry for Constant Schema Items.\n * @alpha\n */\nexport interface ConstantDifference extends SchemaItemDifference<ConstantProps> {\n  readonly schemaType: SchemaItemType.Constant;\n}\n\n/**\n * Differencing entry for Custom Attribute Class Schema Items.\n * @alpha\n */\nexport interface CustomAttributeClassDifference extends SchemaItemDifference<CustomAttributeClassProps> {\n  readonly schemaType: SchemaItemType.CustomAttributeClass;\n}\n\n/**\n * Differencing entry for Entity Class Schema Items.\n * @alpha\n */\nexport interface EntityClassDifference extends SchemaItemDifference<EntityClassProps> {\n  readonly schemaType: SchemaItemType.EntityClass;\n}\n\n/**\n * Differencing entry for Enumerator Schema Items.\n * @alpha\n */\nexport interface EnumerationDifference extends SchemaItemDifference<EnumerationProps> {\n  readonly schemaType: SchemaItemType.Enumeration;\n}\n\n/**\n * Differencing entry for Kind-Of-Quantities Schema Items.\n * @alpha\n */\nexport interface KindOfQuantityDifference extends SchemaItemDifference<KindOfQuantityProps> {\n  readonly schemaType: SchemaItemType.KindOfQuantity;\n}\n\n/**\n * Differencing entry for Mixin Class Schema Items.\n * @alpha\n */\nexport interface MixinClassDifference extends SchemaItemDifference<MixinProps> {\n  readonly schemaType: SchemaItemType.Mixin;\n}\n\n/**\n * Differencing entry for Phenomenon Schema Items.\n * @alpha\n */\nexport interface PhenomenonDifference extends SchemaItemDifference<PhenomenonProps> {\n  readonly schemaType: SchemaItemType.Phenomenon;\n}\n\n/**\n * Differencing entry for Property Category Schema Items.\n * @alpha\n */\nexport interface PropertyCategoryDifference extends SchemaItemDifference<PropertyCategoryProps> {\n  readonly schemaType: SchemaItemType.PropertyCategory;\n}\n\n/**\n * Differencing entry for Relationship Class Schema Items.\n * @alpha\n */\nexport interface RelationshipClassDifference extends SchemaItemDifference<RelationshipClassProps> {\n  readonly schemaType: SchemaItemType.RelationshipClass;\n}\n\n/**\n * Differencing entry for Struct Class Schema Items.\n * @alpha\n */\nexport interface StructClassDifference extends SchemaItemDifference<StructClassProps> {\n  readonly schemaType: SchemaItemType.StructClass;\n}\n\n/**\n * Differencing entry for Unit System Schema Items.\n * @alpha\n */\nexport interface UnitSystemDifference extends SchemaItemDifference<UnitSystemProps> {\n  readonly schemaType: SchemaItemType.UnitSystem;\n}\n\n/**\n * Differencing entry for Unit Schema Items.\n * @alpha\n */\nexport interface UnitDifference extends SchemaItemDifference<SchemaItemUnitProps> {\n  readonly schemaType: SchemaItemType.Unit;\n}\n\n/**\n * Differencing entry for Inverted Unit Schema Items.\n * @alpha\n */\nexport interface InvertedUnitDifference extends SchemaItemDifference<InvertedUnitProps> {\n  readonly schemaType: SchemaItemType.InvertedUnit;\n}\n/**\n * Differencing entry for Format Schema Items.\n * @alpha\n */\nexport interface FormatDifference extends SchemaItemDifference<SchemaItemFormatProps> {\n  readonly schemaType: SchemaItemType.Format;\n}\n\n/**\n * Differencing entry for added or changed Properties.\n * @alpha\n */\nexport interface ClassPropertyDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.Property;\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<AnyPropertyProps>;\n}\n\n/**\n * Union of supported Custom Attribute Differences.\n * @alpha\n */\nexport type CustomAttributeDifference =\n  CustomAttributeSchemaDifference |\n  CustomAttributeSchemaItemDifference |\n  CustomAttributePropertyDifference |\n  CustomAttributeRelationshipConstraintDifference;\n\n/**\n * Differencing entry for Custom Attributes on Schema.\n * @alpha\n */\nexport interface CustomAttributeSchemaDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"Schema\";\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Schema Items.\n * @alpha\n */\nexport interface CustomAttributeSchemaItemDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"SchemaItem\";\n  readonly itemName: string;\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Properties.\n * @alpha\n */\nexport interface CustomAttributePropertyDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"Property\";\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Relationship Constraints.\n * @alpha\n */\nexport interface CustomAttributeRelationshipConstraintDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"RelationshipConstraint\";\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for changed mixins on EntityClasses.\n * @alpha\n */\nexport interface EntityClassMixinDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.EntityClassMixin;\n  readonly itemName: string;\n  readonly difference: string[];\n}\n\n/**\n * Differencing entry for changed Enumerators on Enumerable Schema Items.\n * @alpha\n */\nexport interface EnumeratorDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.Enumerator;\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<AnyEnumerator>;\n}\n\n/**\n * Differencing entry for Relationship Constraints.\n * @alpha\n */\nexport interface RelationshipConstraintDifference {\n  readonly changeType: \"modify\";\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraint;\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: PartialEditable<Omit<RelationshipConstraintProps, \"constraintClasses\">>;\n}\n\n/**\n * Differencing entry for constraint classes added to Relationship Constrains.\n * @alpha\n */\nexport interface RelationshipConstraintClassDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraintClass;\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: string[];\n}\n"]}
+{"version":3,"file":"SchemaDifference.js","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifference.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,iEAA8D;AAE9D,uEAAoE;AACpE,gEAKkC;AAsBlC;;;GAGG;AACH,IAAY,gBASX;AATD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,uDAAmC,CAAA;IACnC,yCAAqB,CAAA;IACrB,6CAAyB,CAAA;IACzB,uEAAmD,CAAA;IACnD,qEAAiD,CAAA;IACjD,+EAA2D,CAAA;IAC3D,yDAAqC,CAAA;AACvC,CAAC,EATW,gBAAgB,gCAAhB,gBAAgB,QAS3B;AAQD;;GAEG;AACH,IAAiB,gBAAgB,CAmMhC;AAnMD,WAAiB,gBAAgB;IAC/B;;;;;;OAMG;IACI,KAAK,UAAU,WAAW,CAAC,YAAoB,EAAE,YAAoB;QAC1E,MAAM,WAAW,GAAoB,EAAE,CAAC;QACxC,MAAM,cAAc,GAAG,IAAI,+BAAc,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC1F,MAAM,cAAc,CAAC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAEhE,OAAO,iBAAiB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IANqB,4BAAW,cAMhC,CAAA;IAED;;;;;;OAMG;IACI,KAAK,UAAU,iBAAiB,CAAC,YAAoB,EAAE,aAA4B;QACxF,MAAM,OAAO,GAAG,IAAI,iDAAuB,EAAE,CAAC;QAC9C,KAAK,MAAM,UAAU,IAAI,aAAa,CAAC,cAAc,EAAE,CAAC;YACtD,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC5B,CAAC;QAED,MAAM,OAAO,GAA0B;YACrC,GAAG,OAAO,CAAC,aAAa;YACxB,GAAG,OAAO,CAAC,iBAAiB;YAC5B,GAAG,OAAO,CAAC,qBAAqB;YAChC,GAAG,OAAO,CAAC,sBAAsB;SAClC,CAAC;QAEF,OAAO;YACL,gBAAgB,EAAE,aAAa,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;YAC3D,gBAAgB,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;YACnD,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;YACvE,OAAO;SACR,CAAC;IACJ,CAAC;IAnBqB,kCAAiB,oBAmBtC,CAAA;IAED;;;OAGG;IACH,SAAgB,oBAAoB,CAAC,UAA+B;QAClE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,QAAQ,CAAC;IAC3D,CAAC;IAFe,qCAAoB,uBAEnC,CAAA;IAED;;;OAGG;IACH,SAAgB,yBAAyB,CAAC,UAA+B;QACvE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,QAAQ,CAAC;IAC7D,CAAC;IAFe,0CAAyB,4BAExC,CAAA;IAED;;;OAGG;IACH,SAAgB,gCAAgC,CAAC,UAA+B;QAC9E,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,oBAAoB,CAAC;IACvE,CAAC;IAFe,iDAAgC,mCAE/C,CAAA;IAED;;;OAGG;IACH,SAAgB,2BAA2B,CAAC,UAA+B;QACzE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,uBAAuB,CAAC;IAC5E,CAAC;IAFe,4CAA2B,8BAE1C,CAAA;IAED;;;OAGG;IACH,SAAgB,uBAAuB,CAAC,UAA+B;QACrE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,WAAW,CAAC;IAC9D,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED;;;OAGG;IACH,SAAgB,4BAA4B,CAAC,UAA+B;QAC1E,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,gBAAgB,CAAC;IACrE,CAAC;IAFe,6CAA4B,+BAE3C,CAAA;IAED;;;OAGG;IACH,SAAgB,uBAAuB,CAAC,UAA+B;QACrE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,WAAW,CAAC;IAC9D,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED;;;OAGG;IACH,SAAgB,sBAAsB,CAAC,UAA+B;QACpE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,UAAU,CAAC;IAC/D,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED;;;OAGG;IACH,SAAgB,0BAA0B,CAAC,UAA+B;QACxE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,cAAc,CAAC;IACjE,CAAC;IAFe,2CAA0B,6BAEzC,CAAA;IAED;;;OAGG;IACH,SAAgB,sBAAsB,CAAC,UAA+B;QACpE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,KAAK,CAAC;IACxD,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED;;;OAGG;IACH,SAAgB,sBAAsB,CAAC,UAA+B;QACpE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,UAAU,CAAC;IAC7D,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED;;;OAGG;IACH,SAAgB,4BAA4B,CAAC,UAA+B;QAC1E,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,gBAAgB,CAAC;IACnE,CAAC;IAFe,6CAA4B,+BAE3C,CAAA;IAED;;;OAGG;IACH,SAAgB,kBAAkB,CAAC,UAA+B;QAChE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,MAAM,CAAC;IAC3D,CAAC;IAFe,mCAAkB,qBAEjC,CAAA;IAED;;;OAGG;IACH,SAAgB,2BAA2B,CAAC,UAA+B;QACzE,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,eAAe,CAAC;IACpE,CAAC;IAFe,4CAA2B,8BAE1C,CAAA;IAED;;;OAGG;IACH,SAAgB,uBAAuB,CAAC,UAA+B;QACrE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,WAAW,CAAC;IAC9D,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED;;;OAGG;IACH,SAAgB,sBAAsB,CAAC,UAA+B;QACpE,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,UAAU,CAAC;IAC7D,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED;;;OAGG;IACH,SAAgB,6BAA6B,CAAC,UAA+B;QAC3E,OAAO,UAAU,CAAC,UAAU,KAAK,kCAAc,CAAC,iBAAiB,CAAC;IACpE,CAAC;IAFe,8CAA6B,gCAE5C,CAAA;IAED;;;OAGG;IACH,SAAgB,kCAAkC,CAAC,UAA+B;QAChF,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,sBAAsB,CAAC;IAC3E,CAAC;IAFe,mDAAkC,qCAEjD,CAAA;IAED;;;OAGG;IACH,SAAgB,uCAAuC,CAAC,UAA+B;QACrF,OAAO,UAAU,CAAC,UAAU,KAAK,gBAAgB,CAAC,2BAA2B,CAAC;IAChF,CAAC;IAFe,wDAAuC,0CAEtD,CAAA;AACH,CAAC,EAnMgB,gBAAgB,gCAAhB,gBAAgB,QAmMhC","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 Differencing\n */\n\nimport { SchemaChanges } from \"../Validation/SchemaChanges\";\nimport { SchemaComparer } from \"../Validation/SchemaComparer\";\nimport { SchemaDifferenceConflict } from \"./SchemaConflicts\";\nimport { SchemaDiagnosticVisitor } from \"./SchemaDiagnosticVisitor\";\nimport {\n  AnyEnumerator, AnyPropertyProps, ConstantProps, CustomAttribute,\n  CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps,\n  MixinProps, PhenomenonProps, PropertyCategoryProps, RelationshipClassProps, RelationshipConstraintProps,\n  type Schema, SchemaItemFormatProps, SchemaItemProps, SchemaItemType, SchemaItemUnitProps, SchemaReferenceProps, StructClassProps, UnitSystemProps,\n} from \"@itwin/ecschema-metadata\";\n\n/** Utility-Type to remove possible readonly flags on the given type. */\ntype PartialEditable<T> = {\n  -readonly [P in keyof T]?: T[P];\n};\n\n/**\n * Utility-Type to simplify the expected SchemaItem props by omitting the base properties\n * that are not needed for the schema differencing. Also all properties are made mutable\n * by removing the readonly flag if present.\n */\ntype SchemaItemProperties<T extends SchemaItemProps> = {\n  [P in keyof PartialEditable<Omit<T, keyof Omit<SchemaItemProps, \"label\" | \"description\" | \"customAttributes\">>>]: T[P]\n};\n\n/**\n * Defines the type of the difference operation.\n * @alpha\n */\nexport type DifferenceType = \"add\" | \"modify\";\n\n/**\n * Defines the SchemaTypes that are not SchemaItems.\n * @alpha\n */\nexport enum SchemaOtherTypes {\n  Schema = \"Schema\",\n  SchemaReference = \"SchemaReference\",\n  Property = \"Property\",\n  Enumerator = \"Enumerator\",\n  CustomAttributeInstance = \"CustomAttributeInstance\",\n  RelationshipConstraint = \"RelationshipConstraint\",\n  RelationshipConstraintClass = \"RelationshipConstraintClass\",\n  EntityClassMixin = \"EntityClassMixin\",\n}\n\n/**\n * Defines the possible values SchemaTypes that can occur in SchemaDifferences or Conflicts.\n * @alpha\n */\nexport type SchemaType = SchemaOtherTypes | SchemaItemType;\n\n/**\n * @alpha\n */\nexport namespace SchemaDifference {\n  /**\n   * Creates a [[SchemaDifference]] for two given schemas.\n   * @param targetSchema  The schema the differences gets merged into.\n   * @param sourceSchema  The schema to get merged in the target.\n   * @returns             An [[SchemaDifference]] object.\n   * @alpha\n   */\n  export async function fromSchemas(targetSchema: Schema, sourceSchema: Schema): Promise<SchemaDifferences> {\n    const changesList: SchemaChanges[] = [];\n    const schemaComparer = new SchemaComparer({ report: changesList.push.bind(changesList) });\n    await schemaComparer.compareSchemas(sourceSchema, targetSchema);\n\n    return fromSchemaChanges(targetSchema, changesList[0]);\n  }\n\n  /**\n   * Creates a [[SchemaDifference]] for a given [[SchemaChanges]] report.\n   * @param targetSchema\n   * @param schemaChanges   A changes report of two schemas.\n   * @returns               An [[SchemaDifference]] object.\n   * @internal\n   */\n  export async function fromSchemaChanges(targetSchema: Schema, schemaChanges: SchemaChanges): Promise<SchemaDifferences> {\n    const visitor = new SchemaDiagnosticVisitor();\n    for (const diagnostic of schemaChanges.allDiagnostics) {\n      visitor.visit(diagnostic);\n    }\n\n    const changes: AnySchemaDifference[] = [\n      ...visitor.schemaChanges,\n      ...visitor.schemaItemChanges,\n      ...visitor.schemaItemPathChanges,\n      ...visitor.customAttributeChanges,\n    ];\n\n    return {\n      sourceSchemaName: schemaChanges.schema.schemaKey.toString(),\n      targetSchemaName: targetSchema.schemaKey.toString(),\n      conflicts: visitor.conflicts.length > 0 ? visitor.conflicts : undefined,\n      changes,\n    };\n  }\n\n  /**\n   * Indicates whether the given difference is type of ConstantDifference.\n   * @alpha\n   */\n  export function isConstantDifference(difference: AnySchemaDifference): difference is ConstantDifference {\n    return difference.schemaType === SchemaItemType.Constant;\n  }\n\n  /**\n   * Indicates whether the given difference is type of ClassPropertyDifference.\n   * @alpha\n   */\n  export function isClassPropertyDifference(difference: AnySchemaDifference): difference is ClassPropertyDifference {\n    return difference.schemaType === SchemaOtherTypes.Property;\n  }\n\n  /**\n   * Indicates whether the given difference is type of CustomAttributeClassDifference.\n   * @alpha\n   */\n  export function isCustomAttributeClassDifference(difference: AnySchemaDifference): difference is CustomAttributeClassDifference {\n    return difference.schemaType === SchemaItemType.CustomAttributeClass;\n  }\n\n  /**\n   * Indicates whether the given difference is type of CustomAttributeDifference.\n   * @alpha\n   */\n  export function isCustomAttributeDifference(difference: AnySchemaDifference): difference is CustomAttributeDifference {\n    return difference.schemaType === SchemaOtherTypes.CustomAttributeInstance;\n  }\n\n  /**\n   * Indicates whether the given difference is type of EntityClassDifference.\n   * @alpha\n   */\n  export function isEntityClassDifference(difference: AnySchemaDifference): difference is EntityClassDifference {\n    return difference.schemaType === SchemaItemType.EntityClass;\n  }\n\n  /**\n   * Indicates whether the given difference is type of EntityClassMixinDifference.\n   * @alpha\n   */\n  export function isEntityClassMixinDifference(difference: AnySchemaDifference): difference is EntityClassMixinDifference {\n    return difference.schemaType === SchemaOtherTypes.EntityClassMixin;\n  }\n\n  /**\n   * Indicates whether the given difference is type of EnumerationDifference.\n   * @alpha\n   */\n  export function isEnumerationDifference(difference: AnySchemaDifference): difference is EnumerationDifference {\n    return difference.schemaType === SchemaItemType.Enumeration;\n  }\n\n  /**\n   * Indicates whether the given difference is type of EnumeratorDifference.\n   * @alpha\n   */\n  export function isEnumeratorDifference(difference: AnySchemaDifference): difference is EnumeratorDifference {\n    return difference.schemaType === SchemaOtherTypes.Enumerator;\n  }\n\n  /**\n   * Indicates whether the given difference is type of KindOfQuantityDifference.\n   * @alpha\n   */\n  export function isKindOfQuantityDifference(difference: AnySchemaDifference): difference is KindOfQuantityDifference {\n    return difference.schemaType === SchemaItemType.KindOfQuantity;\n  }\n\n  /**\n   * Indicates whether the given difference is type of MixinClassDifference.\n   * @alpha\n   */\n  export function isMixinClassDifference(difference: AnySchemaDifference): difference is MixinClassDifference {\n    return difference.schemaType === SchemaItemType.Mixin;\n  }\n\n  /**\n   * Indicates whether the given difference is type of PhenomenonDifference.\n   * @alpha\n   */\n  export function isPhenomenonDifference(difference: AnySchemaDifference): difference is PhenomenonDifference {\n    return difference.schemaType === SchemaItemType.Phenomenon;\n  }\n\n  /**\n   * Indicates whether the given difference is type of PropertyCategoryDifference.\n   * @alpha\n   */\n  export function isPropertyCategoryDifference(difference: AnySchemaDifference): difference is PropertyCategoryDifference {\n    return difference.schemaType === SchemaItemType.PropertyCategory;\n  }\n\n  /**\n   * Indicates whether the given difference is type of SchemaDifference.\n   * @alpha\n   */\n  export function isSchemaDifference(difference: AnySchemaDifference): difference is SchemaDifference {\n    return difference.schemaType === SchemaOtherTypes.Schema;\n  }\n\n  /**\n   * Indicates whether the given difference is type of SchemaReferenceDifference.\n   * @alpha\n   */\n  export function isSchemaReferenceDifference(difference: AnySchemaDifference): difference is SchemaReferenceDifference {\n    return difference.schemaType === SchemaOtherTypes.SchemaReference;\n  }\n\n  /**\n   * Indicates whether the given difference is type of CustomAttributeDifference.\n   * @alpha\n   */\n  export function isStructClassDifference(difference: AnySchemaDifference): difference is StructClassDifference {\n    return difference.schemaType === SchemaItemType.StructClass;\n  }\n\n  /**\n   * Indicates whether the given difference is type of UnitSystemDifference.\n   * @alpha\n   */\n  export function isUnitSystemDifference(difference: AnySchemaDifference): difference is UnitSystemDifference {\n    return difference.schemaType === SchemaItemType.UnitSystem;\n  }\n\n  /**\n   * Indicates whether the given difference is type of RelationshipClassDifference.\n   * @alpha\n   */\n  export function isRelationshipClassDifference(difference: AnySchemaDifference): difference is RelationshipClassDifference {\n    return difference.schemaType === SchemaItemType.RelationshipClass;\n  }\n\n  /**\n   * Indicates whether the given difference is type of RelationshipConstraintDifference.\n   * @alpha\n   */\n  export function isRelationshipConstraintDifference(difference: AnySchemaDifference): difference is RelationshipConstraintDifference {\n    return difference.schemaType === SchemaOtherTypes.RelationshipConstraint;\n  }\n\n  /**\n   * Indicates whether the given difference is type of RelationshipConstraintClassDifference.\n   * @alpha\n   */\n  export function isRelationshipConstraintClassDifference(difference: AnySchemaDifference): difference is RelationshipConstraintClassDifference {\n    return difference.schemaType === SchemaOtherTypes.RelationshipConstraintClass;\n  }\n}\n\n/**\n * Definition of the differences between two Schemas.\n * @alpha\n */\nexport interface SchemaDifferences {\n  /** Full name of the source schema */\n  readonly sourceSchemaName: string;\n  /** Full name of the target schema */\n  readonly targetSchemaName: string;\n\n  /** List of differences between the compared schemas. */\n  readonly changes: AnySchemaDifference[];\n\n  /** List of conflicts found while comparing the schemas. */\n  readonly conflicts?: SchemaDifferenceConflict[];\n}\n\n/**\n * Union of all supported schema differencing types.\n * @alpha\n */\nexport type AnySchemaDifference =\n  SchemaDifference |\n  SchemaReferenceDifference |\n  AnySchemaItemDifference |\n  AnySchemaItemPathDifference |\n  CustomAttributeDifference;\n\n/**\n * Differencing entry for changes on a Schema.\n * @alpha\n */\nexport interface SchemaDifference {\n  readonly changeType: \"modify\";\n  readonly schemaType: SchemaOtherTypes.Schema;\n  readonly difference: {\n    label?: string;\n    description?: string;\n  };\n}\n\n/**\n * Differencing entry for added or changed Schema References of a Schema.\n * @alpha\n */\nexport interface SchemaReferenceDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.SchemaReference;\n  readonly difference: SchemaReferenceProps;\n}\n\n/**\n * Union of all supported schema item differencing types.\n * @alpha\n */\nexport type AnySchemaItemDifference =\n  ClassItemDifference |\n  ConstantDifference |\n  EnumerationDifference |\n  EntityClassMixinDifference |\n  FormatDifference |\n  KindOfQuantityDifference |\n  InvertedUnitDifference |\n  PhenomenonDifference |\n  PropertyCategoryDifference |\n  UnitDifference |\n  UnitSystemDifference;\n\n/**\n * Union for supported class Schema Items.\n * @alpha\n */\nexport type ClassItemDifference =\n  EntityClassDifference |\n  MixinClassDifference |\n  StructClassDifference |\n  CustomAttributeClassDifference |\n  RelationshipClassDifference;\n\n/**\n * Union of all differences that have a path pointing inside a schema item.\n * @alpha\n */\nexport type AnySchemaItemPathDifference =\n  RelationshipConstraintDifference |\n  RelationshipConstraintClassDifference |\n  CustomAttributePropertyDifference |\n  EnumeratorDifference |\n  ClassPropertyDifference;\n\n/**\n * Internal base class for all Schema Item differencing entries.\n * @alpha\n */\ninterface SchemaItemDifference<T extends SchemaItemProps> {\n  readonly changeType: \"add\" | \"modify\";\n  readonly itemName: string;\n  readonly difference: SchemaItemProperties<T>;\n}\n\n/**\n * Differencing entry for Constant Schema Items.\n * @alpha\n */\nexport interface ConstantDifference extends SchemaItemDifference<ConstantProps> {\n  readonly schemaType: SchemaItemType.Constant;\n}\n\n/**\n * Differencing entry for Custom Attribute Class Schema Items.\n * @alpha\n */\nexport interface CustomAttributeClassDifference extends SchemaItemDifference<CustomAttributeClassProps> {\n  readonly schemaType: SchemaItemType.CustomAttributeClass;\n}\n\n/**\n * Differencing entry for Entity Class Schema Items.\n * @alpha\n */\nexport interface EntityClassDifference extends SchemaItemDifference<EntityClassProps> {\n  readonly schemaType: SchemaItemType.EntityClass;\n}\n\n/**\n * Differencing entry for Enumerator Schema Items.\n * @alpha\n */\nexport interface EnumerationDifference extends SchemaItemDifference<EnumerationProps> {\n  readonly schemaType: SchemaItemType.Enumeration;\n}\n\n/**\n * Differencing entry for Kind-Of-Quantities Schema Items.\n * @alpha\n */\nexport interface KindOfQuantityDifference extends SchemaItemDifference<KindOfQuantityProps> {\n  readonly schemaType: SchemaItemType.KindOfQuantity;\n}\n\n/**\n * Differencing entry for Mixin Class Schema Items.\n * @alpha\n */\nexport interface MixinClassDifference extends SchemaItemDifference<MixinProps> {\n  readonly schemaType: SchemaItemType.Mixin;\n}\n\n/**\n * Differencing entry for Phenomenon Schema Items.\n * @alpha\n */\nexport interface PhenomenonDifference extends SchemaItemDifference<PhenomenonProps> {\n  readonly schemaType: SchemaItemType.Phenomenon;\n}\n\n/**\n * Differencing entry for Property Category Schema Items.\n * @alpha\n */\nexport interface PropertyCategoryDifference extends SchemaItemDifference<PropertyCategoryProps> {\n  readonly schemaType: SchemaItemType.PropertyCategory;\n}\n\n/**\n * Differencing entry for Relationship Class Schema Items.\n * @alpha\n */\nexport interface RelationshipClassDifference extends SchemaItemDifference<RelationshipClassProps> {\n  readonly schemaType: SchemaItemType.RelationshipClass;\n}\n\n/**\n * Differencing entry for Struct Class Schema Items.\n * @alpha\n */\nexport interface StructClassDifference extends SchemaItemDifference<StructClassProps> {\n  readonly schemaType: SchemaItemType.StructClass;\n}\n\n/**\n * Differencing entry for Unit System Schema Items.\n * @alpha\n */\nexport interface UnitSystemDifference extends SchemaItemDifference<UnitSystemProps> {\n  readonly schemaType: SchemaItemType.UnitSystem;\n}\n\n/**\n * Differencing entry for Unit Schema Items.\n * @alpha\n */\nexport interface UnitDifference extends SchemaItemDifference<SchemaItemUnitProps> {\n  readonly schemaType: SchemaItemType.Unit;\n}\n\n/**\n * Differencing entry for Inverted Unit Schema Items.\n * @alpha\n */\nexport interface InvertedUnitDifference extends SchemaItemDifference<InvertedUnitProps> {\n  readonly schemaType: SchemaItemType.InvertedUnit;\n}\n/**\n * Differencing entry for Format Schema Items.\n * @alpha\n */\nexport interface FormatDifference extends SchemaItemDifference<SchemaItemFormatProps> {\n  readonly schemaType: SchemaItemType.Format;\n}\n\n/**\n * Differencing entry for added or changed Properties.\n * @alpha\n */\nexport interface ClassPropertyDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.Property;\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<AnyPropertyProps>;\n}\n\n/**\n * Union of supported Custom Attribute Differences.\n * @alpha\n */\nexport type CustomAttributeDifference =\n  CustomAttributeSchemaDifference |\n  CustomAttributeSchemaItemDifference |\n  CustomAttributePropertyDifference |\n  CustomAttributeRelationshipConstraintDifference;\n\n/**\n * Differencing entry for Custom Attributes on Schema.\n * @alpha\n */\nexport interface CustomAttributeSchemaDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"Schema\";\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Schema Items.\n * @alpha\n */\nexport interface CustomAttributeSchemaItemDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"SchemaItem\";\n  readonly itemName: string;\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Properties.\n * @alpha\n */\nexport interface CustomAttributePropertyDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"Property\";\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Relationship Constraints.\n * @alpha\n */\nexport interface CustomAttributeRelationshipConstraintDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"RelationshipConstraint\";\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for changed mixins on EntityClasses.\n * @alpha\n */\nexport interface EntityClassMixinDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.EntityClassMixin;\n  readonly itemName: string;\n  readonly difference: string[];\n}\n\n/**\n * Differencing entry for changed Enumerators on Enumerable Schema Items.\n * @alpha\n */\nexport interface EnumeratorDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.Enumerator;\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<AnyEnumerator>;\n}\n\n/**\n * Differencing entry for Relationship Constraints.\n * @alpha\n */\nexport interface RelationshipConstraintDifference {\n  readonly changeType: \"modify\";\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraint;\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: PartialEditable<Omit<RelationshipConstraintProps, \"constraintClasses\">>;\n}\n\n/**\n * Differencing entry for constraint classes added to Relationship Constrains.\n * @alpha\n */\nexport interface RelationshipConstraintClassDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraintClass;\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: string[];\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"Constants.js","sourceRoot":"","sources":["../../../src/Editing/Constants.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAAwI;AAIxI;;;GAGG;AACH,MAAa,SAAS;IACpB,YAA6B,aAAkC;QAAlC,kBAAa,GAAb,aAAa,CAAqB;IAAI,CAAC;IAE7D,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,UAAyB,EAAE,UAAkB,EAAE,YAAqB,EAAE,SAAkB,EAAE,WAAoB;QACpK,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,WAAW,GAAG,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAoB,CAAC;QAC3E,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,OAAO,EAAE,YAAY,EAAE,0BAA0B,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SAClG;QAED,MAAM,aAAa,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAa,UAAU,CAAC,CAAC,CAAC;QACrG,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,cAAc,KAAK,kCAAc,CAAC,UAAU,EAAE;YAC7F,OAAO,EAAE,YAAY,EAAE,+BAA+B,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;SAC3E;QACD,WAAW,CAAC,aAAa,CAAC,IAAI,2CAAuB,CAA4B,aAAa,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;QAChI,WAAW,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEtC,IAAI,SAAS;YACX,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAEtC,IAAI,WAAW;YACb,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAE1C,IAAI,YAAY;YACd,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAE5C,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,aAA4B;QAC7E,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,aAAa,CAAC,IAAI,KAAK,SAAS;YAClC,OAAO,EAAE,YAAY,EAAE,oCAAoC,EAAE,CAAC;QAEhE,MAAM,WAAW,GAAG,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QACtE,IAAI,WAAW,KAAK,SAAS;YAC3B,OAAO,EAAE,YAAY,EAAE,0BAA0B,aAAa,CAAC,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAEjH,MAAM,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC1C,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC;IACtC,CAAC;CACF;AApDD,8BAoDC","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 { ConstantProps, DelayedPromiseWithProps, Phenomenon, SchemaItemKey, SchemaItemType, SchemaKey } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\nimport { MutableConstant } from \"./Mutable/MutableConstant\";\n\n/**\n * @alpha\n * A class allowing you to create schema items of type Constant.\n */\nexport class Constants {\n  public constructor(protected _schemaEditor: SchemaContextEditor) { }\n\n  public async create(schemaKey: SchemaKey, name: string, phenomenon: SchemaItemKey, definition: string, displayLabel?: string, numerator?: number, denominator?: number): 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 newConstant = (await schema.createConstant(name)) as MutableConstant;\n    if (newConstant === undefined) {\n      return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };\n    }\n\n    const newPhenomenon = (await this._schemaEditor.schemaContext.getSchemaItem<Phenomenon>(phenomenon));\n    if (newPhenomenon === undefined || newPhenomenon.schemaItemType !== SchemaItemType.Phenomenon) {\n      return { errorMessage: `Unable to locate phenomenon ${phenomenon.name}` };\n    }\n    newConstant.setPhenomenon(new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(newPhenomenon.key, async () => newPhenomenon));\n    newConstant.setDefinition(definition);\n\n    if (numerator)\n      newConstant.setNumerator(numerator);\n\n    if (denominator)\n      newConstant.setDenominator(denominator);\n\n    if (displayLabel)\n      newConstant.setDisplayLabel(displayLabel);\n\n    return { itemKey: newConstant.key };\n  }\n\n  /**\n   * Creates a Constant through a ConstantProps.\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, constantProps: ConstantProps): 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 (constantProps.name === undefined)\n      return { errorMessage: `No name was supplied within props.` };\n\n    const newConstant = (await schema.createConstant(constantProps.name));\n    if (newConstant === undefined)\n      return { errorMessage: `Failed to create class ${constantProps.name} in schema ${schemaKey.toString(true)}.` };\n\n    await newConstant.fromJSON(constantProps);\n    return { itemKey: newConstant.key };\n  }\n}\n"]}
+{"version":3,"file":"Constants.js","sourceRoot":"","sources":["../../../src/Editing/Constants.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAAwI;AAIxI;;;GAGG;AACH,MAAa,SAAS;IACpB,YAA6B,aAAkC;QAAlC,kBAAa,GAAb,aAAa,CAAqB;IAAI,CAAC;IAE7D,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,UAAyB,EAAE,UAAkB,EAAE,YAAqB,EAAE,SAAkB,EAAE,WAAoB;QACpK,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,WAAW,GAAG,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAoB,CAAC;QAC3E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,YAAY,EAAE,0BAA0B,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACnG,CAAC;QAED,MAAM,aAAa,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAa,UAAU,CAAC,CAAC,CAAC;QACrG,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,cAAc,KAAK,kCAAc,CAAC,UAAU,EAAE,CAAC;YAC9F,OAAO,EAAE,YAAY,EAAE,+BAA+B,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5E,CAAC;QACD,WAAW,CAAC,aAAa,CAAC,IAAI,2CAAuB,CAA4B,aAAa,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;QAChI,WAAW,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEtC,IAAI,SAAS;YACX,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAEtC,IAAI,WAAW;YACb,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAE1C,IAAI,YAAY;YACd,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAE5C,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,aAA4B;QAC7E,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,aAAa,CAAC,IAAI,KAAK,SAAS;YAClC,OAAO,EAAE,YAAY,EAAE,oCAAoC,EAAE,CAAC;QAEhE,MAAM,WAAW,GAAG,CAAC,MAAM,MAAM,CAAC,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QACtE,IAAI,WAAW,KAAK,SAAS;YAC3B,OAAO,EAAE,YAAY,EAAE,0BAA0B,aAAa,CAAC,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAEjH,MAAM,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC1C,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC;IACtC,CAAC;CACF;AApDD,8BAoDC","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 { ConstantProps, DelayedPromiseWithProps, Phenomenon, SchemaItemKey, SchemaItemType, SchemaKey } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\nimport { MutableConstant } from \"./Mutable/MutableConstant\";\n\n/**\n * @alpha\n * A class allowing you to create schema items of type Constant.\n */\nexport class Constants {\n  public constructor(protected _schemaEditor: SchemaContextEditor) { }\n\n  public async create(schemaKey: SchemaKey, name: string, phenomenon: SchemaItemKey, definition: string, displayLabel?: string, numerator?: number, denominator?: number): 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 newConstant = (await schema.createConstant(name)) as MutableConstant;\n    if (newConstant === undefined) {\n      return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };\n    }\n\n    const newPhenomenon = (await this._schemaEditor.schemaContext.getSchemaItem<Phenomenon>(phenomenon));\n    if (newPhenomenon === undefined || newPhenomenon.schemaItemType !== SchemaItemType.Phenomenon) {\n      return { errorMessage: `Unable to locate phenomenon ${phenomenon.name}` };\n    }\n    newConstant.setPhenomenon(new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(newPhenomenon.key, async () => newPhenomenon));\n    newConstant.setDefinition(definition);\n\n    if (numerator)\n      newConstant.setNumerator(numerator);\n\n    if (denominator)\n      newConstant.setDenominator(denominator);\n\n    if (displayLabel)\n      newConstant.setDisplayLabel(displayLabel);\n\n    return { itemKey: newConstant.key };\n  }\n\n  /**\n   * Creates a Constant through a ConstantProps.\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, constantProps: ConstantProps): 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 (constantProps.name === undefined)\n      return { errorMessage: `No name was supplied within props.` };\n\n    const newConstant = (await schema.createConstant(constantProps.name));\n    if (newConstant === undefined)\n      return { errorMessage: `Failed to create class ${constantProps.name} in schema ${schemaKey.toString(true)}.` };\n\n    await newConstant.fromJSON(constantProps);\n    return { itemKey: newConstant.key };\n  }\n}\n"]}

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

@@ -9,7 +9,7 @@ import { ECClasses } from "./ECClasses";
  * A class extending ECClasses allowing you to create schema items of type CustomAttributeClass.
  */
 export declare class CustomAttributes extends ECClasses {
-    constructor(_schemaEditor: SchemaContextEditor);
+    constructor(schemaEditor: SchemaContextEditor);
     create(schemaKey: SchemaKey, name: string, containerType: CustomAttributeContainerType, displayLabel?: string, baseClass?: SchemaItemKey): Promise<SchemaItemEditResults>;
     /**
      * Creates a CustomAttributeClass through a CustomAttributeClassProps.

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

@@ -1 +1 @@
-{"version":3,"file":"CustomAttributes.d.ts","sourceRoot":"","sources":["../../../src/Editing/CustomAttributes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,yBAAyB,EAAE,4BAA4B,EACvD,aAAa,EAAkB,SAAS,EACzC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,SAAS;gBAC1B,aAAa,EAAE,mBAAmB;IAIxC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,4BAA4B,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA4BtL;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAgBvH"}
+{"version":3,"file":"CustomAttributes.d.ts","sourceRoot":"","sources":["../../../src/Editing/CustomAttributes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,yBAAyB,EAAE,4BAA4B,EACvD,aAAa,EAAkB,SAAS,EACzC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,SAAS;gBAC1B,YAAY,EAAE,mBAAmB;IAIvC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,4BAA4B,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA4BtL;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAgBvH"}

package/lib/cjs/Editing/CustomAttributes.js

@@ -15,8 +15,8 @@ const ECClasses_1 = require("./ECClasses");
  * A class extending ECClasses allowing you to create schema items of type CustomAttributeClass.
  */
 class CustomAttributes extends ECClasses_1.ECClasses {
-    constructor(_schemaEditor) {
-        super(_schemaEditor);
+    constructor(schemaEditor) {
+        super(ecschema_metadata_1.SchemaItemType.CustomAttributeClass, schemaEditor);
     }
     async create(schemaKey, name, containerType, displayLabel, baseClass) {
         const schema = await this._schemaEditor.getSchema(schemaKey);

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

@@ -1 +1 @@
-{"version":3,"file":"CustomAttributes.js","sourceRoot":"","sources":["../../../src/Editing/CustomAttributes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAGkC;AAElC,2CAAwC;AAGxC;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,qBAAS;IAC7C,YAAmB,aAAkC;QACnD,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,aAA2C,EAAE,YAAqB,EAAE,SAAyB;QACnJ,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,0BAA0B,CAAC,IAAI,CAAC,CAAmB,CAAC;QACnF,IAAI,QAAQ,KAAK,SAAS;YACxB,OAAO,EAAE,YAAY,EAAE,0BAA0B,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAEnG,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,UAAU,CAAU,SAAS,CAAC,CAAC;YAClE,IAAI,aAAa,KAAK,SAAS;gBAC7B,OAAO,EAAE,YAAY,EAAE,+BAA+B,SAAS,CAAC,QAAQ,cAAc,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;YAE7G,IAAI,aAAa,CAAC,cAAc,KAAK,kCAAc,CAAC,oBAAoB;gBACtE,OAAO,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC,QAAQ,wCAAwC,EAAE,CAAC;YAE7F,QAAQ,CAAC,SAAS,GAAG,IAAI,2CAAuB,CAAyB,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC;SAChH;QAED,IAAI,YAAY;YACd,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEzC,QAAQ,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAEzC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,OAAkC;QACnF,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,OAAO,CAAC,IAAI,KAAK,SAAS;YAC5B,OAAO,EAAE,YAAY,EAAE,oCAAoC,EAAE,CAAC;QAEhE,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,0BAA0B,CAAC,OAAO,CAAC,IAAI,CAAC,CAAmB,CAAC;QAC3F,IAAI,QAAQ,KAAK,SAAS;YACxB,OAAO,EAAE,YAAY,EAAE,0BAA0B,OAAO,CAAC,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAE3G,MAAM,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEjC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;CACF;AAtDD,4CAsDC","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  CustomAttributeClassProps, CustomAttributeContainerType, DelayedPromiseWithProps, ECClass,\n  SchemaItemKey, SchemaItemType, SchemaKey,\n} from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\nimport { ECClasses } from \"./ECClasses\";\nimport { MutableCAClass } from \"./Mutable/MutableCAClass\";\n\n/**\n * @alpha\n * A class extending ECClasses allowing you to create schema items of type CustomAttributeClass.\n */\nexport class CustomAttributes extends ECClasses {\n  public constructor(_schemaEditor: SchemaContextEditor) {\n    super(_schemaEditor);\n  }\n\n  public async create(schemaKey: SchemaKey, name: string, containerType: CustomAttributeContainerType, displayLabel?: string, baseClass?: SchemaItemKey): 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.createCustomAttributeClass(name)) as MutableCAClass;\n    if (newClass === undefined)\n      return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };\n\n    if (baseClass !== undefined) {\n      const baseClassItem = await schema.lookupItem<ECClass>(baseClass);\n      if (baseClassItem === undefined)\n        return { errorMessage: `Unable to locate base class ${baseClass.fullName} in schema ${schema.fullName}.` };\n\n      if (baseClassItem.schemaItemType !== SchemaItemType.CustomAttributeClass)\n        return { errorMessage: `${baseClassItem.fullName} is not of type CustomAttribute Class.` };\n\n      newClass.baseClass = new DelayedPromiseWithProps<SchemaItemKey, ECClass>(baseClass, async () => baseClassItem);\n    }\n\n    if (displayLabel)\n      newClass.setDisplayLabel(displayLabel);\n\n    newClass.setContainerType(containerType);\n\n    return { itemKey: newClass.key };\n  }\n\n  /**\n   * Creates a CustomAttributeClass through a CustomAttributeClassProps.\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\n   * @param caProps a json object that will be used to populate the new CustomAttributeClass. Needs a name value passed in.\n   */\n  public async createFromProps(schemaKey: SchemaKey, caProps: CustomAttributeClassProps): 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 (caProps.name === undefined)\n      return { errorMessage: `No name was supplied within props.` };\n\n    const newClass = (await schema.createCustomAttributeClass(caProps.name)) as MutableCAClass;\n    if (newClass === undefined)\n      return { errorMessage: `Failed to create class ${caProps.name} in schema ${schemaKey.toString(true)}.` };\n\n    await newClass.fromJSON(caProps);\n\n    return { itemKey: newClass.key };\n  }\n}\n"]}
+{"version":3,"file":"CustomAttributes.js","sourceRoot":"","sources":["../../../src/Editing/CustomAttributes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAGkC;AAElC,2CAAwC;AAGxC;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,qBAAS;IAC7C,YAAmB,YAAiC;QAClD,KAAK,CAAC,kCAAc,CAAC,oBAAoB,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,aAA2C,EAAE,YAAqB,EAAE,SAAyB;QACnJ,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,0BAA0B,CAAC,IAAI,CAAC,CAAmB,CAAC;QACnF,IAAI,QAAQ,KAAK,SAAS;YACxB,OAAO,EAAE,YAAY,EAAE,0BAA0B,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAEnG,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,UAAU,CAAU,SAAS,CAAC,CAAC;YAClE,IAAI,aAAa,KAAK,SAAS;gBAC7B,OAAO,EAAE,YAAY,EAAE,+BAA+B,SAAS,CAAC,QAAQ,cAAc,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;YAE7G,IAAI,aAAa,CAAC,cAAc,KAAK,kCAAc,CAAC,oBAAoB;gBACtE,OAAO,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC,QAAQ,wCAAwC,EAAE,CAAC;YAE7F,QAAQ,CAAC,SAAS,GAAG,IAAI,2CAAuB,CAAyB,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC;QACjH,CAAC;QAED,IAAI,YAAY;YACd,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEzC,QAAQ,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAEzC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,OAAkC;QACnF,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,OAAO,CAAC,IAAI,KAAK,SAAS;YAC5B,OAAO,EAAE,YAAY,EAAE,oCAAoC,EAAE,CAAC;QAEhE,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,0BAA0B,CAAC,OAAO,CAAC,IAAI,CAAC,CAAmB,CAAC;QAC3F,IAAI,QAAQ,KAAK,SAAS;YACxB,OAAO,EAAE,YAAY,EAAE,0BAA0B,OAAO,CAAC,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAE3G,MAAM,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEjC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;CACF;AAtDD,4CAsDC","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  CustomAttributeClassProps, CustomAttributeContainerType, DelayedPromiseWithProps, ECClass,\n  SchemaItemKey, SchemaItemType, SchemaKey,\n} from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\nimport { ECClasses } from \"./ECClasses\";\nimport { MutableCAClass } from \"./Mutable/MutableCAClass\";\n\n/**\n * @alpha\n * A class extending ECClasses allowing you to create schema items of type CustomAttributeClass.\n */\nexport class CustomAttributes extends ECClasses {\n  public constructor(schemaEditor: SchemaContextEditor) {\n    super(SchemaItemType.CustomAttributeClass, schemaEditor);\n  }\n\n  public async create(schemaKey: SchemaKey, name: string, containerType: CustomAttributeContainerType, displayLabel?: string, baseClass?: SchemaItemKey): 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.createCustomAttributeClass(name)) as MutableCAClass;\n    if (newClass === undefined)\n      return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };\n\n    if (baseClass !== undefined) {\n      const baseClassItem = await schema.lookupItem<ECClass>(baseClass);\n      if (baseClassItem === undefined)\n        return { errorMessage: `Unable to locate base class ${baseClass.fullName} in schema ${schema.fullName}.` };\n\n      if (baseClassItem.schemaItemType !== SchemaItemType.CustomAttributeClass)\n        return { errorMessage: `${baseClassItem.fullName} is not of type CustomAttribute Class.` };\n\n      newClass.baseClass = new DelayedPromiseWithProps<SchemaItemKey, ECClass>(baseClass, async () => baseClassItem);\n    }\n\n    if (displayLabel)\n      newClass.setDisplayLabel(displayLabel);\n\n    newClass.setContainerType(containerType);\n\n    return { itemKey: newClass.key };\n  }\n\n  /**\n   * Creates a CustomAttributeClass through a CustomAttributeClassProps.\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\n   * @param caProps a json object that will be used to populate the new CustomAttributeClass. Needs a name value passed in.\n   */\n  public async createFromProps(schemaKey: SchemaKey, caProps: CustomAttributeClassProps): 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 (caProps.name === undefined)\n      return { errorMessage: `No name was supplied within props.` };\n\n    const newClass = (await schema.createCustomAttributeClass(caProps.name)) as MutableCAClass;\n    if (newClass === undefined)\n      return { errorMessage: `Failed to create class ${caProps.name} in schema ${schemaKey.toString(true)}.` };\n\n    await newClass.fromJSON(caProps);\n\n    return { itemKey: newClass.key };\n  }\n}\n"]}

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

@@ -1,15 +1,38 @@
 /** @packageDocumentation
  * @module Editing
  */
-import { CustomAttribute, CustomAttributeContainerProps, Enumeration, EnumerationPropertyProps, PrimitiveArrayPropertyProps, PrimitivePropertyProps, PrimitiveType, SchemaItemKey, StructArrayPropertyProps, StructClass, StructPropertyProps } from "@itwin/ecschema-metadata";
+import { CustomAttribute, CustomAttributeContainerProps, Enumeration, EnumerationPropertyProps, PrimitiveArrayPropertyProps, PrimitivePropertyProps, PrimitiveType, SchemaItemKey, SchemaItemType, StructArrayPropertyProps, StructClass, StructPropertyProps } from "@itwin/ecschema-metadata";
 import { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from "./Editor";
+import { ArrayProperties, EnumerationProperties, PrimitiveProperties, Properties, StructProperties } from "./Properties";
+export type ECClassSchemaItems = SchemaItemType.EntityClass | SchemaItemType.StructClass | SchemaItemType.RelationshipClass | SchemaItemType.Mixin | SchemaItemType.CustomAttributeClass;
 /**
  * @alpha
  * Acts as a base class for schema class creation. Enables property creation.
  */
 export declare class ECClasses {
+    protected schemaItemType: ECClassSchemaItems;
     protected _schemaEditor: SchemaContextEditor;
-    protected constructor(_schemaEditor: SchemaContextEditor);
+    protected constructor(schemaItemType: ECClassSchemaItems, _schemaEditor: SchemaContextEditor);
+    /**
+     * Allows access for editing of base Property attributes.
+     */
+    readonly properties: Properties;
+    /**
+     * Allows access for editing of ArrayProperty attributes.
+     */
+    readonly arrayProperties: ArrayProperties;
+    /**
+     * Allows access for editing of PrimitiveProperty attributes.
+     */
+    readonly primitiveProperties: PrimitiveProperties;
+    /**
+     * Allows access for editing of EnumerationProperty attributes.
+     */
+    readonly enumerationProperties: EnumerationProperties;
+    /**
+     * Allows access for editing of StructProperty attributes.
+     */
+    readonly structProperties: StructProperties;
     /**
      * Creates a property on class identified by the given SchemaItemKey. This method restricts the
      * property type to primitives of type Double, String, DateTime and Integer.
@@ -44,22 +67,6 @@ export declare class ECClasses {
      * @param customAttribute The CustomAttribute instance to add.
      */
     addCustomAttribute(classKey: SchemaItemKey, customAttribute: CustomAttribute): Promise<SchemaItemEditResults>;
-    /**
-     * Adds a CustomAttribute instance to the Property identified by the given SchemaItemKey and property name.
-     * @param classKey The SchemaItemKey identifying the class.
-     * @param propertyName The name of the property.
-     * @param customAttribute The CustomAttribute instance to add.
-     */
-    addCustomAttributeToProperty(classKey: SchemaItemKey, propertyName: string, customAttribute: CustomAttribute): Promise<PropertyEditResults>;
-    /**
-     * Renames the property on the specified class. The rename will fail if the new
-     * name causes a conflict with a base or derived property. All derived classes
-     * containing a property override will be renamed, as well.
-     * @param classKey  The SchemaItemKey identifying the class.
-     * @param existingPropertyName The name of the property.
-     * @param newPropertyName The new property name.
-     */
-    setPropertyName(classKey: SchemaItemKey, existingPropertyName: string, newPropertyName: string): Promise<PropertyEditResults>;
     /**
      * Sets the name of the ECClass.
      * @param classKey The SchemaItemKey of the class.
@@ -68,12 +75,11 @@ export declare class ECClasses {
      */
     setName(classKey: SchemaItemKey, name: string): Promise<SchemaItemEditResults>;
     /**
-     * Sets the Category to the Property.
-     * @param classKey The SchemaItemKey of the class.
-     * @param propertyName The name of the property.
-     * @param categoryKey The SchemaItemKey of the PropertyCategory assigned to the property.
+     * Sets the base class of a SchemaItem.
+     * @param itemKey The SchemaItemKey of the Item.
+     * @param baseClassKey The SchemaItemKey of the base class. Specifying 'undefined' removes the base class.
      */
-    setPropertyCategory(classKey: SchemaItemKey, propertyName: string, categoryKey: SchemaItemKey): Promise<PropertyEditResults>;
+    setBaseClass(itemKey: SchemaItemKey, baseClassKey?: SchemaItemKey): Promise<SchemaItemEditResults>;
     private getClass;
     protected removeCustomAttribute(container: CustomAttributeContainerProps, customAttribute: CustomAttribute): void;
     private findDerivedClasses;

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

@@ -1 +1 @@
-{"version":3,"file":"ECClasses.d.ts","sourceRoot":"","sources":["../../../src/Editing/ECClasses.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,eAAe,EACf,6BAA6B,EAEqB,WAAW,EAAE,wBAAwB,EAAE,2BAA2B,EACpH,sBAAsB,EAAE,aAAa,EAAoB,aAAa,EAAkB,wBAAwB,EAChH,WAAW,EAAE,mBAAmB,EACjC,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAK3F;;;GAGG;AACH,qBAAa,SAAS;IAEE,SAAS,CAAC,aAAa,EAAE,mBAAmB;IAAlE,SAAS,aAAuB,aAAa,EAAE,mBAAmB;IAElE;;;;;;OAMG;IACU,cAAc,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAsBrI;;;;;OAKG;IACU,uBAAuB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYjH,gCAAgC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAalK,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgBjH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa/J,4BAA4B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYtH,qCAAqC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa5K,8BAA8B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYtH,uCAAuC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAanK,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY5G,6BAA6B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAavJ,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYjH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAajK,cAAc,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYnF,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAc5E;;;;OAIG;IACU,kBAAkB,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAyB1H;;;;;OAKG;IACU,4BAA4B,CAAC,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA8BxJ;;;;;;;OAOG;IACU,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA0C1I;;;;;OAKG;IACU,OAAO,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAsB3F;;;;;OAKG;IACU,mBAAmB,CAAC,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAsB3H,QAAQ;IAuBtB,SAAS,CAAC,qBAAqB,CAAC,SAAS,EAAE,6BAA6B,EAAE,eAAe,EAAE,eAAe;YAM5F,kBAAkB;CAejC"}
+{"version":3,"file":"ECClasses.d.ts","sourceRoot":"","sources":["../../../src/Editing/ECClasses.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,eAAe,EACf,6BAA6B,EAEa,WAAW,EAAE,wBAAwB,EAAE,2BAA2B,EAC5G,sBAAsB,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,wBAAwB,EAC9F,WAAW,EAAE,mBAAmB,EACjC,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAG3F,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEzH,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,qBAAa,SAAS;IAEE,SAAS,CAAC,cAAc,EAAE,kBAAkB;IAAE,SAAS,CAAC,aAAa,EAAE,mBAAmB;IAAhH,SAAS,aAAuB,cAAc,EAAE,kBAAkB,EAAY,aAAa,EAAE,mBAAmB;IAEhH;;OAEG;IACH,SAAgB,UAAU,aAA2D;IACrF;;OAEG;IACH,SAAgB,eAAe,kBAAgE;IAC/F;;OAEG;IACH,SAAgB,mBAAmB,sBAAoE;IACvG;;OAEG;IACH,SAAgB,qBAAqB,wBAAsE;IAC3G;;OAEG;IACH,SAAgB,gBAAgB,mBAAiE;IAEjG;;;;;;OAMG;IACU,cAAc,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAsBrI;;;;;OAKG;IACU,uBAAuB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYjH,gCAAgC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAalK,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgBjH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa/J,4BAA4B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYtH,qCAAqC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa5K,8BAA8B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYtH,uCAAuC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAanK,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY5G,6BAA6B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAavJ,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYjH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAajK,cAAc,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYnF,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAc5E;;;;OAIG;IACU,kBAAkB,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAyB1H;;;;;OAKG;IACU,OAAO,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA4B3F;;;;OAIG;IACU,YAAY,CAAC,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;YA8BjG,QAAQ;IAuBtB,SAAS,CAAC,qBAAqB,CAAC,SAAS,EAAE,6BAA6B,EAAE,eAAe,EAAE,eAAe;YAM5F,kBAAkB;CAejC"}

package/lib/cjs/Editing/ECClasses.js

@@ -11,13 +11,35 @@ exports.ECClasses = void 0;
 const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
 const core_bentley_1 = require("@itwin/core-bentley");
 const Rules = require("../Validation/ECRules");
+const Properties_1 = require("./Properties");
 /**
  * @alpha
  * Acts as a base class for schema class creation. Enables property creation.
  */
 class ECClasses {
-    constructor(_schemaEditor) {
+    constructor(schemaItemType, _schemaEditor) {
+        this.schemaItemType = schemaItemType;
         this._schemaEditor = _schemaEditor;
+        /**
+         * Allows access for editing of base Property attributes.
+         */
+        this.properties = new Properties_1.Properties(this.schemaItemType, this._schemaEditor);
+        /**
+         * Allows access for editing of ArrayProperty attributes.
+         */
+        this.arrayProperties = new Properties_1.ArrayProperties(this.schemaItemType, this._schemaEditor);
+        /**
+         * Allows access for editing of PrimitiveProperty attributes.
+         */
+        this.primitiveProperties = new Properties_1.PrimitiveProperties(this.schemaItemType, this._schemaEditor);
+        /**
+         * Allows access for editing of EnumerationProperty attributes.
+         */
+        this.enumerationProperties = new Properties_1.EnumerationProperties(this.schemaItemType, this._schemaEditor);
+        /**
+         * Allows access for editing of StructProperty attributes.
+         */
+        this.structProperties = new Properties_1.StructProperties(this.schemaItemType, this._schemaEditor);
     }
     /**
      * Creates a property on class identified by the given SchemaItemKey. This method restricts the
@@ -236,78 +258,6 @@ class ECClasses {
         }
         return {};
     }
-    /**
-     * Adds a CustomAttribute instance to the Property identified by the given SchemaItemKey and property name.
-     * @param classKey The SchemaItemKey identifying the class.
-     * @param propertyName The name of the property.
-     * @param customAttribute The CustomAttribute instance to add.
-     */
-    async addCustomAttributeToProperty(classKey, propertyName, customAttribute) {
-        let mutableClass;
-        try {
-            mutableClass = await this.getClass(classKey);
-        }
-        catch (e) {
-            return { errorMessage: e.message };
-        }
-        const property = await mutableClass.getProperty(propertyName);
-        if (!property) {
-            return { errorMessage: `Property with the name ${propertyName} could not be found in the class ${classKey.fullName}.` };
-        }
-        property.addCustomAttribute(customAttribute);
-        const diagnostics = Rules.validateCustomAttributeInstance(property, customAttribute);
-        const result = { errorMessage: "" };
-        for await (const diagnostic of diagnostics) {
-            result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
-        }
-        if (result.errorMessage) {
-            this.removeCustomAttribute(property, customAttribute);
-            return result;
-        }
-        return {};
-    }
-    /**
-     * Renames the property on the specified class. The rename will fail if the new
-     * name causes a conflict with a base or derived property. All derived classes
-     * containing a property override will be renamed, as well.
-     * @param classKey  The SchemaItemKey identifying the class.
-     * @param existingPropertyName The name of the property.
-     * @param newPropertyName The new property name.
-     */
-    async setPropertyName(classKey, existingPropertyName, newPropertyName) {
-        const newName = new ecschema_metadata_1.ECName(newPropertyName);
-        let mutableClass;
-        try {
-            mutableClass = await this.getClass(classKey);
-        }
-        catch (e) {
-            return { errorMessage: e.message };
-        }
-        const existingProperty = await mutableClass.getProperty(existingPropertyName);
-        if (!existingProperty) {
-            return { errorMessage: `An ECProperty with the name ${existingPropertyName} could not be found in the class ${classKey.fullName}.` };
-        }
-        const baseProperty = await mutableClass.getProperty(newPropertyName, true);
-        if (baseProperty)
-            return { errorMessage: `An ECProperty with the name ${newPropertyName} already exists in the class ${baseProperty.class.name}.` };
-        // Handle derived classes
-        const derivedProperties = [];
-        const derivedClasses = await this.findDerivedClasses(mutableClass);
-        for (const derivedClass of derivedClasses) {
-            if (await derivedClass.getProperty(newPropertyName))
-                return { errorMessage: `An ECProperty with the name ${newPropertyName} already exists in the class ${derivedClass.fullName}.` };
-            const propertyOverride = await derivedClass.getProperty(existingPropertyName);
-            // If found the property is overridden in the derived class.
-            if (propertyOverride)
-                derivedProperties.push(propertyOverride);
-        }
-        // Re-name the overridden property in all derived classes
-        derivedProperties.forEach((prop) => {
-            prop.setName(newName);
-        });
-        existingProperty.setName(newName);
-        return { itemKey: classKey, propertyName: newName.name };
-    }
     /**
      * Sets the name of the ECClass.
      * @param classKey The SchemaItemKey of the class.
@@ -329,33 +279,39 @@ class ECClasses {
         catch (e) {
             return { errorMessage: e.message };
         }
+        const existingName = classKey.name;
         mutableClass.setName(name);
+        // Must reset in schema item map
+        await schema.deleteClass(existingName);
+        schema.addItem(mutableClass);
         return {};
     }
     /**
-     * Sets the Category to the Property.
-     * @param classKey The SchemaItemKey of the class.
-     * @param propertyName The name of the property.
-     * @param categoryKey The SchemaItemKey of the PropertyCategory assigned to the property.
+     * Sets the base class of a SchemaItem.
+     * @param itemKey The SchemaItemKey of the Item.
+     * @param baseClassKey The SchemaItemKey of the base class. Specifying 'undefined' removes the base class.
      */
-    async setPropertyCategory(classKey, propertyName, categoryKey) {
-        let mutableClass;
-        try {
-            mutableClass = await this.getClass(classKey);
-        }
-        catch (e) {
-            return { errorMessage: e.message };
-        }
-        const property = await mutableClass.getProperty(propertyName);
-        if (property === undefined) {
-            return { errorMessage: `An ECProperty with the name ${propertyName} could not be found in the class ${classKey.fullName}.` };
-        }
-        const category = await mutableClass.schema.lookupItem(categoryKey);
-        if (category === undefined) {
-            return { errorMessage: `Can't locate the Property Category ${categoryKey.fullName} in the schema ${mutableClass.schema.fullName}.` };
-        }
-        property.setCategory(new ecschema_metadata_1.DelayedPromiseWithProps(categoryKey, async () => category));
-        return { itemKey: classKey, propertyName };
+    async setBaseClass(itemKey, baseClassKey) {
+        const classItem = await this._schemaEditor.schemaContext.getSchemaItem(itemKey);
+        if (classItem === undefined)
+            return { itemKey, errorMessage: `Class ${itemKey.fullName} not found in schema context.` };
+        if (baseClassKey === undefined) {
+            classItem.baseClass = undefined;
+            return { itemKey };
+        }
+        const baseClassSchema = !baseClassKey.schemaKey.matches(itemKey.schemaKey) ? await this._schemaEditor.getSchema(baseClassKey.schemaKey) : classItem.schema;
+        if (baseClassSchema === undefined) {
+            return { itemKey, errorMessage: `Schema Key ${baseClassKey.schemaKey.toString(true)} not found in context` };
+        }
+        const baseClassItem = await baseClassSchema.lookupItem(baseClassKey);
+        if (baseClassItem === undefined)
+            return { itemKey, errorMessage: `Unable to locate base class ${baseClassKey.fullName} in schema ${baseClassSchema.fullName}.` };
+        if (baseClassItem.schemaItemType !== classItem.schemaItemType)
+            return { itemKey, errorMessage: `${baseClassItem.fullName} is not of type ${classItem.schemaItemType}.` };
+        if (classItem.baseClass !== undefined && !await baseClassItem.is(await classItem.baseClass))
+            return { itemKey, errorMessage: `Baseclass ${baseClassItem.fullName} must derive from ${classItem.baseClass.fullName}.` };
+        classItem.baseClass = new ecschema_metadata_1.DelayedPromiseWithProps(baseClassKey, async () => baseClassItem);
+        return { itemKey };
     }
     async getClass(classKey) {
         const schema = await this._schemaEditor.getSchema(classKey.schemaKey);