@itwin/ecschema-editing 4.9.0-dev.9 → 4.10.0-dev.1

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,uEAAoE;AAEpE,iEAA8D;AA4B9D;;;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;AAiVD;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CAAC,YAAoB,EAAE,YAAoB;IACnF,MAAM,WAAW,GAAoB,EAAE,CAAC;IACxC,MAAM,cAAc,GAAG,IAAI,+BAAc,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC1F,MAAM,cAAc,CAAC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,IAAI,iDAAuB,EAAE,CAAC;IAC9C,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC;QACvD,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,WAAW,GAA0B;QACzC,GAAG,OAAO,CAAC,iBAAiB;QAC5B,GAAG,OAAO,CAAC,qBAAqB;QAChC,GAAG,OAAO,CAAC,yBAAyB;QACpC,GAAG,OAAO,CAAC,0BAA0B;KACtC,CAAC;IAEF,OAAO;QACL,gBAAgB,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;QACnD,gBAAgB,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;QACnD,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QACvE,WAAW;KACZ,CAAC;AACJ,CAAC;AAvBD,oDAuBC","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 Differencing\r\n */\r\n\r\nimport { SchemaDifferenceConflict } from \"./SchemaConflicts\";\r\nimport { SchemaDiagnosticVisitor } from \"./SchemaDiagnosticVisitor\";\r\nimport { SchemaChanges } from \"../Validation/SchemaChanges\";\r\nimport { SchemaComparer } from \"../Validation/SchemaComparer\";\r\nimport {\r\n  AnyEnumerator, AnyPropertyProps, ConstantProps, CustomAttribute,\r\n  CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps,\r\n  MixinProps, PhenomenonProps, PropertyCategoryProps, RelationshipClassProps, RelationshipConstraintProps,\r\n  type Schema, SchemaItemFormatProps, SchemaItemProps, SchemaItemType, SchemaItemUnitProps, SchemaReferenceProps, StructClassProps, UnitSystemProps,\r\n} from \"@itwin/ecschema-metadata\";\r\n\r\n/** Utility-Type to remove possible readonly flags on the given type. */\r\ntype PartialEditable<T> = {\r\n  -readonly [P in keyof T]?: T[P];\r\n};\r\n\r\n/**\r\n * Utility-Type to simplify the expected SchemaItem props by omitting the base properties\r\n * that are not needed for the schema differencing. Also all properties are made mutable\r\n * by removing the readonly flag if present.\r\n */\r\ntype SchemaItemProperties<T extends SchemaItemProps> = {\r\n  [P in keyof PartialEditable<Omit<T, keyof Omit<SchemaItemProps, \"label\" | \"description\" | \"customAttributes\">>>]: T[P]\r\n};\r\n\r\n/**\r\n * Defines the type of the difference operation.\r\n * @alpha\r\n */\r\nexport type DifferenceType = \"add\" | \"modify\";\r\n\r\n/**\r\n * Defines the SchemaTypes that are not SchemaItems.\r\n * @alpha\r\n */\r\nexport enum SchemaOtherTypes {\r\n  Schema = \"Schema\",\r\n  SchemaReference = \"SchemaReference\",\r\n  Property = \"Property\",\r\n  Enumerator = \"Enumerator\",\r\n  CustomAttributeInstance = \"CustomAttributeInstance\",\r\n  RelationshipConstraint = \"RelationshipConstraint\",\r\n  RelationshipConstraintClass = \"RelationshipConstraintClass\",\r\n  EntityClassMixin = \"EntityClassMixin\",\r\n}\r\n\r\n/**\r\n * Defines the possible values SchemaTypes that can occur in SchemaDifferences or Conflicts.\r\n * @alpha\r\n */\r\nexport type SchemaType = SchemaOtherTypes | SchemaItemType;\r\n\r\n/**\r\n * Definition of the difference result between two Schemas.\r\n * @alpha\r\n */\r\nexport interface SchemaDifferenceResult {\r\n  /** Full name of the source schema */\r\n  readonly sourceSchemaName: string;\r\n  /** Full name of the target schema */\r\n  readonly targetSchemaName: string;\r\n\r\n  /** List of differences between the compared schemas. */\r\n  readonly differences: AnySchemaDifference[];\r\n\r\n  /** List of conflicts found while comparing the schemas. */\r\n  readonly conflicts?: SchemaDifferenceConflict[];\r\n}\r\n\r\n/**\r\n * Union of all supported schema differencing types.\r\n * @alpha\r\n */\r\nexport type AnySchemaDifference =\r\n  SchemaDifference |\r\n  SchemaReferenceDifference |\r\n  AnySchemaItemDifference |\r\n  AnySchemaItemPathDifference |\r\n  CustomAttributeDifference;\r\n\r\n/**\r\n * Differencing entry for changes on a Schema.\r\n * @alpha\r\n */\r\nexport interface SchemaDifference {\r\n  readonly changeType: \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.Schema;\r\n  readonly difference: {\r\n    label?: string;\r\n    description?: string;\r\n  };\r\n}\r\n\r\n/**\r\n * Differencing entry for added or changed Schema References of a Schema.\r\n * @alpha\r\n */\r\nexport interface SchemaReferenceDifference {\r\n  readonly changeType: \"add\" | \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.SchemaReference;\r\n  readonly difference: SchemaReferenceProps;\r\n}\r\n\r\n/**\r\n * Union of all supported schema item differencing types.\r\n * @alpha\r\n */\r\nexport type AnySchemaItemDifference =\r\n  ClassItemDifference |\r\n  ConstantDifference |\r\n  EnumerationDifference |\r\n  EntityClassMixinDifference |\r\n  FormatDifference |\r\n  KindOfQuantityDifference |\r\n  InvertedUnitDifference |\r\n  PhenomenonDifference |\r\n  PropertyCategoryDifference |\r\n  UnitDifference |\r\n  UnitSystemDifference;\r\n\r\n/**\r\n * Union for supported class Schema Items.\r\n * @alpha\r\n */\r\nexport type ClassItemDifference =\r\n  EntityClassDifference |\r\n  MixinClassDifference |\r\n  StructClassDifference |\r\n  CustomAttributeClassDifference |\r\n  RelationshipClassDifference;\r\n\r\n/**\r\n * Union of all differences that have a path pointing inside a schema item.\r\n * @alpha\r\n */\r\nexport type AnySchemaItemPathDifference =\r\n  RelationshipConstraintDifference |\r\n  RelationshipConstraintClassDifference |\r\n  CustomAttributePropertyDifference |\r\n  EnumeratorDifference |\r\n  ClassPropertyDifference;\r\n\r\n/**\r\n * Internal base class for all Schema Item differencing entries.\r\n * @alpha\r\n */\r\ninterface SchemaItemDifference<T extends SchemaItemProps> {\r\n  readonly changeType: \"add\" | \"modify\";\r\n  readonly itemName: string;\r\n  readonly difference: SchemaItemProperties<T>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Constant Schema Items.\r\n * @alpha\r\n */\r\nexport interface ConstantDifference extends SchemaItemDifference<ConstantProps> {\r\n  readonly schemaType: SchemaItemType.Constant;\r\n}\r\n\r\n/**\r\n * Differencing entry for Custom Attribute Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface CustomAttributeClassDifference extends SchemaItemDifference<CustomAttributeClassProps> {\r\n  readonly schemaType: SchemaItemType.CustomAttributeClass;\r\n}\r\n\r\n/**\r\n * Differencing entry for Entity Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface EntityClassDifference extends SchemaItemDifference<EntityClassProps> {\r\n  readonly schemaType: SchemaItemType.EntityClass;\r\n}\r\n\r\n/**\r\n * Differencing entry for Enumerator Schema Items.\r\n * @alpha\r\n */\r\nexport interface EnumerationDifference extends SchemaItemDifference<EnumerationProps> {\r\n  readonly schemaType: SchemaItemType.Enumeration;\r\n}\r\n\r\n/**\r\n * Differencing entry for Kind-Of-Quantities Schema Items.\r\n * @alpha\r\n */\r\nexport interface KindOfQuantityDifference extends SchemaItemDifference<KindOfQuantityProps> {\r\n  readonly schemaType: SchemaItemType.KindOfQuantity;\r\n}\r\n\r\n/**\r\n * Differencing entry for Mixin Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface MixinClassDifference extends SchemaItemDifference<MixinProps> {\r\n  readonly schemaType: SchemaItemType.Mixin;\r\n}\r\n\r\n/**\r\n * Differencing entry for Phenomenon Schema Items.\r\n * @alpha\r\n */\r\nexport interface PhenomenonDifference extends SchemaItemDifference<PhenomenonProps> {\r\n  readonly schemaType: SchemaItemType.Phenomenon;\r\n}\r\n\r\n/**\r\n * Differencing entry for Property Category Schema Items.\r\n * @alpha\r\n */\r\nexport interface PropertyCategoryDifference extends SchemaItemDifference<PropertyCategoryProps> {\r\n  readonly schemaType: SchemaItemType.PropertyCategory;\r\n}\r\n\r\n/**\r\n * Differencing entry for Relationship Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface RelationshipClassDifference extends SchemaItemDifference<RelationshipClassProps> {\r\n  readonly schemaType: SchemaItemType.RelationshipClass;\r\n}\r\n\r\n/**\r\n * Differencing entry for Struct Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface StructClassDifference extends SchemaItemDifference<StructClassProps> {\r\n  readonly schemaType: SchemaItemType.StructClass;\r\n}\r\n\r\n/**\r\n * Differencing entry for Unit System Schema Items.\r\n * @alpha\r\n */\r\nexport interface UnitSystemDifference extends SchemaItemDifference<UnitSystemProps> {\r\n  readonly schemaType: SchemaItemType.UnitSystem;\r\n}\r\n\r\n/**\r\n * Differencing entry for Unit Schema Items.\r\n * @alpha\r\n */\r\nexport interface UnitDifference extends SchemaItemDifference<SchemaItemUnitProps> {\r\n  readonly schemaType: SchemaItemType.Unit;\r\n}\r\n\r\n/**\r\n * Differencing entry for Inverted Unit Schema Items.\r\n * @alpha\r\n */\r\nexport interface InvertedUnitDifference extends SchemaItemDifference<InvertedUnitProps> {\r\n  readonly schemaType: SchemaItemType.InvertedUnit;\r\n}\r\n/**\r\n * Differencing entry for Format Schema Items.\r\n * @alpha\r\n */\r\nexport interface FormatDifference extends SchemaItemDifference<SchemaItemFormatProps> {\r\n  readonly schemaType: SchemaItemType.Format;\r\n}\r\n\r\n/**\r\n * Differencing entry for added or changed Properties.\r\n * @alpha\r\n */\r\nexport interface ClassPropertyDifference {\r\n  readonly changeType: \"add\" | \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.Property;\r\n  readonly itemName: string;\r\n  readonly path: string;\r\n  readonly difference: PartialEditable<AnyPropertyProps>;\r\n}\r\n\r\n/**\r\n * Union of supported Custom Attribute Differences.\r\n * @alpha\r\n */\r\nexport type CustomAttributeDifference =\r\n  CustomAttributeSchemaDifference |\r\n  CustomAttributeSchemaItemDifference |\r\n  CustomAttributePropertyDifference |\r\n  CustomAttributeRelationshipConstraintDifference;\r\n\r\n/**\r\n * Differencing entry for Custom Attributes on Schema.\r\n * @alpha\r\n */\r\nexport interface CustomAttributeSchemaDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\r\n  readonly appliedTo: \"Schema\";\r\n  readonly difference: PartialEditable<CustomAttribute>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Custom Attributes on Schema Items.\r\n * @alpha\r\n */\r\nexport interface CustomAttributeSchemaItemDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\r\n  readonly appliedTo: \"SchemaItem\";\r\n  readonly itemName: string;\r\n  readonly difference: PartialEditable<CustomAttribute>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Custom Attributes on Properties.\r\n * @alpha\r\n */\r\nexport interface CustomAttributePropertyDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\r\n  readonly appliedTo: \"Property\";\r\n  readonly itemName: string;\r\n  readonly path: string;\r\n  readonly difference: PartialEditable<CustomAttribute>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Custom Attributes on Relationship Constraints.\r\n * @alpha\r\n */\r\nexport interface CustomAttributeRelationshipConstraintDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\r\n  readonly appliedTo: \"RelationshipConstraint\";\r\n  readonly itemName: string;\r\n  readonly path: \"$source\" | \"$target\";\r\n  readonly difference: PartialEditable<CustomAttribute>;\r\n}\r\n\r\n/**\r\n * Differencing entry for changed mixins on EntityClasses.\r\n * @alpha\r\n */\r\nexport interface EntityClassMixinDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.EntityClassMixin;\r\n  readonly itemName: string;\r\n  readonly difference: string[];\r\n}\r\n\r\n/**\r\n * Differencing entry for changed Enumerators on Enumerable Schema Items.\r\n * @alpha\r\n */\r\nexport interface EnumeratorDifference {\r\n  readonly changeType: \"add\" | \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.Enumerator;\r\n  readonly itemName: string;\r\n  readonly path: string;\r\n  readonly difference: PartialEditable<AnyEnumerator>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Relationship Constraints.\r\n * @alpha\r\n */\r\nexport interface RelationshipConstraintDifference {\r\n  readonly changeType: \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraint;\r\n  readonly itemName: string;\r\n  readonly path: \"$source\" | \"$target\";\r\n  readonly difference: PartialEditable<Omit<RelationshipConstraintProps, \"constraintClasses\">>;\r\n}\r\n\r\n/**\r\n * Differencing entry for constraint classes added to Relationship Constrains.\r\n * @alpha\r\n */\r\nexport interface RelationshipConstraintClassDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraintClass;\r\n  readonly itemName: string;\r\n  readonly path: \"$source\" | \"$target\";\r\n  readonly difference: string[];\r\n}\r\n\r\n/**\r\n * Creates a [[SchemaDifferenceResult]] for two given schemas.\r\n * @param targetSchema  The schema the differences gets merged into.\r\n * @param sourceSchema  The schema to get merged in the target.\r\n * @returns             An [[SchemaDifferenceResult]] object.\r\n * @alpha\r\n */\r\nexport async function getSchemaDifferences(targetSchema: Schema, sourceSchema: Schema): Promise<SchemaDifferenceResult> {\r\n  const changesList: SchemaChanges[] = [];\r\n  const schemaComparer = new SchemaComparer({ report: changesList.push.bind(changesList) });\r\n  await schemaComparer.compareSchemas(sourceSchema, targetSchema);\r\n\r\n  const visitor = new SchemaDiagnosticVisitor();\r\n  for (const diagnostic of changesList[0].allDiagnostics) {\r\n    visitor.visit(diagnostic);\r\n  }\r\n\r\n  const differences: AnySchemaDifference[] = [\r\n    ...visitor.schemaDifferences,\r\n    ...visitor.schemaItemDifferences,\r\n    ...visitor.schemaItemPathDifferences,\r\n    ...visitor.customAttributeDifferences,\r\n  ];\r\n\r\n  return {\r\n    sourceSchemaName: sourceSchema.schemaKey.toString(),\r\n    targetSchemaName: targetSchema.schemaKey.toString(),\r\n    conflicts: visitor.conflicts.length > 0 ? visitor.conflicts : undefined,\r\n    differences,\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"SchemaDifference.js","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifference.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,uEAAoE;AAEpE,iEAA8D;AAO9D,2EAAkE;AAsBlE;;;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;AAiVD;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CAAC,YAAoB,EAAE,YAAoB;IACnF,MAAM,WAAW,GAAoB,EAAE,CAAC;IACxC,MAAM,cAAc,GAAG,IAAI,+BAAc,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC1F,MAAM,cAAc,CAAC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,IAAI,iDAAuB,EAAE,CAAC;IAC9C,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC;QACvD,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,WAAW,GAA0B;QACzC,GAAG,OAAO,CAAC,iBAAiB;QAC5B,GAAG,OAAO,CAAC,qBAAqB;QAChC,GAAG,OAAO,CAAC,yBAAyB;QACpC,GAAG,OAAO,CAAC,0BAA0B;KACtC,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,IAAA,+CAAmB,EAAC,WAAW,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;IAErF,OAAO;QACL,gBAAgB,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;QACnD,gBAAgB,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;QACnD,SAAS,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QACvD,WAAW;KACZ,CAAC;AACJ,CAAC;AAzBD,oDAyBC","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 Differencing\r\n */\r\n\r\nimport { SchemaDifferenceConflict } from \"./SchemaConflicts\";\r\nimport { SchemaDiagnosticVisitor } from \"./SchemaDiagnosticVisitor\";\r\nimport { SchemaChanges } from \"../Validation/SchemaChanges\";\r\nimport { SchemaComparer } from \"../Validation/SchemaComparer\";\r\nimport {\r\n  AnyEnumerator, AnyPropertyProps, ConstantProps, CustomAttribute,\r\n  CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps,\r\n  MixinProps, PhenomenonProps, PropertyCategoryProps, RelationshipClassProps, RelationshipConstraintProps,\r\n  type Schema, SchemaItemFormatProps, SchemaItemProps, SchemaItemType, SchemaItemUnitProps, SchemaReferenceProps, StructClassProps, UnitSystemProps,\r\n} from \"@itwin/ecschema-metadata\";\r\nimport { validateDifferences } from \"./SchemaDifferenceValidator\";\r\n\r\n/** Utility-Type to remove possible readonly flags on the given type. */\r\ntype PartialEditable<T> = {\r\n  -readonly [P in keyof T]?: T[P];\r\n};\r\n\r\n/**\r\n * Utility-Type to simplify the expected SchemaItem props by omitting the base properties\r\n * that are not needed for the schema differencing. Also all properties are made mutable\r\n * by removing the readonly flag if present.\r\n */\r\ntype SchemaItemProperties<T extends SchemaItemProps> = {\r\n  [P in keyof PartialEditable<Omit<T, keyof Omit<SchemaItemProps, \"label\" | \"description\" | \"customAttributes\">>>]: T[P]\r\n};\r\n\r\n/**\r\n * Defines the type of the difference operation.\r\n * @alpha\r\n */\r\nexport type DifferenceType = \"add\" | \"modify\";\r\n\r\n/**\r\n * Defines the SchemaTypes that are not SchemaItems.\r\n * @alpha\r\n */\r\nexport enum SchemaOtherTypes {\r\n  Schema = \"Schema\",\r\n  SchemaReference = \"SchemaReference\",\r\n  Property = \"Property\",\r\n  Enumerator = \"Enumerator\",\r\n  CustomAttributeInstance = \"CustomAttributeInstance\",\r\n  RelationshipConstraint = \"RelationshipConstraint\",\r\n  RelationshipConstraintClass = \"RelationshipConstraintClass\",\r\n  EntityClassMixin = \"EntityClassMixin\",\r\n}\r\n\r\n/**\r\n * Defines the possible values SchemaTypes that can occur in SchemaDifferences or Conflicts.\r\n * @alpha\r\n */\r\nexport type SchemaType = SchemaOtherTypes | SchemaItemType;\r\n\r\n/**\r\n * Definition of the difference result between two Schemas.\r\n * @alpha\r\n */\r\nexport interface SchemaDifferenceResult {\r\n  /** Full name of the source schema */\r\n  readonly sourceSchemaName: string;\r\n  /** Full name of the target schema */\r\n  readonly targetSchemaName: string;\r\n\r\n  /** List of differences between the compared schemas. */\r\n  readonly differences: AnySchemaDifference[];\r\n\r\n  /** List of conflicts found while comparing the schemas. */\r\n  readonly conflicts?: SchemaDifferenceConflict[];\r\n}\r\n\r\n/**\r\n * Union of all supported schema differencing types.\r\n * @alpha\r\n */\r\nexport type AnySchemaDifference =\r\n  SchemaDifference |\r\n  SchemaReferenceDifference |\r\n  AnySchemaItemDifference |\r\n  AnySchemaItemPathDifference |\r\n  CustomAttributeDifference;\r\n\r\n/**\r\n * Differencing entry for changes on a Schema.\r\n * @alpha\r\n */\r\nexport interface SchemaDifference {\r\n  readonly changeType: \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.Schema;\r\n  readonly difference: {\r\n    label?: string;\r\n    description?: string;\r\n  };\r\n}\r\n\r\n/**\r\n * Differencing entry for added or changed Schema References of a Schema.\r\n * @alpha\r\n */\r\nexport interface SchemaReferenceDifference {\r\n  readonly changeType: \"add\" | \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.SchemaReference;\r\n  readonly difference: SchemaReferenceProps;\r\n}\r\n\r\n/**\r\n * Union of all supported schema item differencing types.\r\n * @alpha\r\n */\r\nexport type AnySchemaItemDifference =\r\n  ClassItemDifference |\r\n  ConstantDifference |\r\n  EnumerationDifference |\r\n  EntityClassMixinDifference |\r\n  FormatDifference |\r\n  KindOfQuantityDifference |\r\n  InvertedUnitDifference |\r\n  PhenomenonDifference |\r\n  PropertyCategoryDifference |\r\n  UnitDifference |\r\n  UnitSystemDifference;\r\n\r\n/**\r\n * Union for supported class Schema Items.\r\n * @alpha\r\n */\r\nexport type ClassItemDifference =\r\n  EntityClassDifference |\r\n  MixinClassDifference |\r\n  StructClassDifference |\r\n  CustomAttributeClassDifference |\r\n  RelationshipClassDifference;\r\n\r\n/**\r\n * Union of all differences that have a path pointing inside a schema item.\r\n * @alpha\r\n */\r\nexport type AnySchemaItemPathDifference =\r\n  RelationshipConstraintDifference |\r\n  RelationshipConstraintClassDifference |\r\n  CustomAttributePropertyDifference |\r\n  EnumeratorDifference |\r\n  ClassPropertyDifference;\r\n\r\n/**\r\n * Internal base class for all Schema Item differencing entries.\r\n * @alpha\r\n */\r\ninterface SchemaItemDifference<T extends SchemaItemProps> {\r\n  readonly changeType: \"add\" | \"modify\";\r\n  readonly itemName: string;\r\n  readonly difference: SchemaItemProperties<T>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Constant Schema Items.\r\n * @alpha\r\n */\r\nexport interface ConstantDifference extends SchemaItemDifference<ConstantProps> {\r\n  readonly schemaType: SchemaItemType.Constant;\r\n}\r\n\r\n/**\r\n * Differencing entry for Custom Attribute Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface CustomAttributeClassDifference extends SchemaItemDifference<CustomAttributeClassProps> {\r\n  readonly schemaType: SchemaItemType.CustomAttributeClass;\r\n}\r\n\r\n/**\r\n * Differencing entry for Entity Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface EntityClassDifference extends SchemaItemDifference<EntityClassProps> {\r\n  readonly schemaType: SchemaItemType.EntityClass;\r\n}\r\n\r\n/**\r\n * Differencing entry for Enumerator Schema Items.\r\n * @alpha\r\n */\r\nexport interface EnumerationDifference extends SchemaItemDifference<EnumerationProps> {\r\n  readonly schemaType: SchemaItemType.Enumeration;\r\n}\r\n\r\n/**\r\n * Differencing entry for Kind-Of-Quantities Schema Items.\r\n * @alpha\r\n */\r\nexport interface KindOfQuantityDifference extends SchemaItemDifference<KindOfQuantityProps> {\r\n  readonly schemaType: SchemaItemType.KindOfQuantity;\r\n}\r\n\r\n/**\r\n * Differencing entry for Mixin Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface MixinClassDifference extends SchemaItemDifference<MixinProps> {\r\n  readonly schemaType: SchemaItemType.Mixin;\r\n}\r\n\r\n/**\r\n * Differencing entry for Phenomenon Schema Items.\r\n * @alpha\r\n */\r\nexport interface PhenomenonDifference extends SchemaItemDifference<PhenomenonProps> {\r\n  readonly schemaType: SchemaItemType.Phenomenon;\r\n}\r\n\r\n/**\r\n * Differencing entry for Property Category Schema Items.\r\n * @alpha\r\n */\r\nexport interface PropertyCategoryDifference extends SchemaItemDifference<PropertyCategoryProps> {\r\n  readonly schemaType: SchemaItemType.PropertyCategory;\r\n}\r\n\r\n/**\r\n * Differencing entry for Relationship Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface RelationshipClassDifference extends SchemaItemDifference<RelationshipClassProps> {\r\n  readonly schemaType: SchemaItemType.RelationshipClass;\r\n}\r\n\r\n/**\r\n * Differencing entry for Struct Class Schema Items.\r\n * @alpha\r\n */\r\nexport interface StructClassDifference extends SchemaItemDifference<StructClassProps> {\r\n  readonly schemaType: SchemaItemType.StructClass;\r\n}\r\n\r\n/**\r\n * Differencing entry for Unit System Schema Items.\r\n * @alpha\r\n */\r\nexport interface UnitSystemDifference extends SchemaItemDifference<UnitSystemProps> {\r\n  readonly schemaType: SchemaItemType.UnitSystem;\r\n}\r\n\r\n/**\r\n * Differencing entry for Unit Schema Items.\r\n * @alpha\r\n */\r\nexport interface UnitDifference extends SchemaItemDifference<SchemaItemUnitProps> {\r\n  readonly schemaType: SchemaItemType.Unit;\r\n}\r\n\r\n/**\r\n * Differencing entry for Inverted Unit Schema Items.\r\n * @alpha\r\n */\r\nexport interface InvertedUnitDifference extends SchemaItemDifference<InvertedUnitProps> {\r\n  readonly schemaType: SchemaItemType.InvertedUnit;\r\n}\r\n/**\r\n * Differencing entry for Format Schema Items.\r\n * @alpha\r\n */\r\nexport interface FormatDifference extends SchemaItemDifference<SchemaItemFormatProps> {\r\n  readonly schemaType: SchemaItemType.Format;\r\n}\r\n\r\n/**\r\n * Differencing entry for added or changed Properties.\r\n * @alpha\r\n */\r\nexport interface ClassPropertyDifference {\r\n  readonly changeType: \"add\" | \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.Property;\r\n  readonly itemName: string;\r\n  readonly path: string;\r\n  readonly difference: PartialEditable<AnyPropertyProps>;\r\n}\r\n\r\n/**\r\n * Union of supported Custom Attribute Differences.\r\n * @alpha\r\n */\r\nexport type CustomAttributeDifference =\r\n  CustomAttributeSchemaDifference |\r\n  CustomAttributeSchemaItemDifference |\r\n  CustomAttributePropertyDifference |\r\n  CustomAttributeRelationshipConstraintDifference;\r\n\r\n/**\r\n * Differencing entry for Custom Attributes on Schema.\r\n * @alpha\r\n */\r\nexport interface CustomAttributeSchemaDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\r\n  readonly appliedTo: \"Schema\";\r\n  readonly difference: PartialEditable<CustomAttribute>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Custom Attributes on Schema Items.\r\n * @alpha\r\n */\r\nexport interface CustomAttributeSchemaItemDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\r\n  readonly appliedTo: \"SchemaItem\";\r\n  readonly itemName: string;\r\n  readonly difference: PartialEditable<CustomAttribute>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Custom Attributes on Properties.\r\n * @alpha\r\n */\r\nexport interface CustomAttributePropertyDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\r\n  readonly appliedTo: \"Property\";\r\n  readonly itemName: string;\r\n  readonly path: string;\r\n  readonly difference: PartialEditable<CustomAttribute>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Custom Attributes on Relationship Constraints.\r\n * @alpha\r\n */\r\nexport interface CustomAttributeRelationshipConstraintDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\r\n  readonly appliedTo: \"RelationshipConstraint\";\r\n  readonly itemName: string;\r\n  readonly path: \"$source\" | \"$target\";\r\n  readonly difference: PartialEditable<CustomAttribute>;\r\n}\r\n\r\n/**\r\n * Differencing entry for changed mixins on EntityClasses.\r\n * @alpha\r\n */\r\nexport interface EntityClassMixinDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.EntityClassMixin;\r\n  readonly itemName: string;\r\n  readonly difference: string[];\r\n}\r\n\r\n/**\r\n * Differencing entry for changed Enumerators on Enumerable Schema Items.\r\n * @alpha\r\n */\r\nexport interface EnumeratorDifference {\r\n  readonly changeType: \"add\" | \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.Enumerator;\r\n  readonly itemName: string;\r\n  readonly path: string;\r\n  readonly difference: PartialEditable<AnyEnumerator>;\r\n}\r\n\r\n/**\r\n * Differencing entry for Relationship Constraints.\r\n * @alpha\r\n */\r\nexport interface RelationshipConstraintDifference {\r\n  readonly changeType: \"modify\";\r\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraint;\r\n  readonly itemName: string;\r\n  readonly path: \"$source\" | \"$target\";\r\n  readonly difference: PartialEditable<Omit<RelationshipConstraintProps, \"constraintClasses\">>;\r\n}\r\n\r\n/**\r\n * Differencing entry for constraint classes added to Relationship Constrains.\r\n * @alpha\r\n */\r\nexport interface RelationshipConstraintClassDifference {\r\n  readonly changeType: \"add\";\r\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraintClass;\r\n  readonly itemName: string;\r\n  readonly path: \"$source\" | \"$target\";\r\n  readonly difference: string[];\r\n}\r\n\r\n/**\r\n * Creates a [[SchemaDifferenceResult]] for two given schemas.\r\n * @param targetSchema  The schema the differences gets merged into.\r\n * @param sourceSchema  The schema to get merged in the target.\r\n * @returns             An [[SchemaDifferenceResult]] object.\r\n * @alpha\r\n */\r\nexport async function getSchemaDifferences(targetSchema: Schema, sourceSchema: Schema): Promise<SchemaDifferenceResult> {\r\n  const changesList: SchemaChanges[] = [];\r\n  const schemaComparer = new SchemaComparer({ report: changesList.push.bind(changesList) });\r\n  await schemaComparer.compareSchemas(sourceSchema, targetSchema);\r\n\r\n  const visitor = new SchemaDiagnosticVisitor();\r\n  for (const diagnostic of changesList[0].allDiagnostics) {\r\n    visitor.visit(diagnostic);\r\n  }\r\n\r\n  const differences: AnySchemaDifference[] = [\r\n    ...visitor.schemaDifferences,\r\n    ...visitor.schemaItemDifferences,\r\n    ...visitor.schemaItemPathDifferences,\r\n    ...visitor.customAttributeDifferences,\r\n  ];\r\n\r\n  const conflicts = await validateDifferences(differences, targetSchema, sourceSchema);\r\n\r\n  return {\r\n    sourceSchemaName: sourceSchema.schemaKey.toString(),\r\n    targetSchemaName: targetSchema.schemaKey.toString(),\r\n    conflicts: conflicts.length > 0 ? conflicts : undefined,\r\n    differences,\r\n  };\r\n}\r\n"]}

package/lib/cjs/Differencing/SchemaDifferenceValidator.d.ts

@@ -0,0 +1,17 @@
+/** @packageDocumentation
+ * @module Differencing
+ */
+import { Schema } from "@itwin/ecschema-metadata";
+import { AnySchemaDifference } from "./SchemaDifference";
+import { SchemaDifferenceConflict } from "./SchemaConflicts";
+/**
+ * Validates the given array of schema differences and returns a list of conflicts if the
+ * validation finds violation against rules.
+ * @param differences   An array of schema differences.
+ * @param targetSchema  The target schema reference.
+ * @param sourceSchema  The source schema reference.
+ * @returns             An array of conflicts found when validating the difference.
+ * @internal
+ */
+export declare function validateDifferences(differences: AnySchemaDifference[], targetSchema: Schema, sourceSchema: Schema): Promise<SchemaDifferenceConflict[]>;
+//# sourceMappingURL=SchemaDifferenceValidator.d.ts.map

package/lib/cjs/Differencing/SchemaDifferenceValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaDifferenceValidator.d.ts","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifferenceValidator.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAqM,MAAM,EAA6C,MAAM,0BAA0B,CAAC;AAChS,OAAO,EAAE,mBAAmB,EAAsmB,MAAM,oBAAoB,CAAC;AAC7pB,OAAO,EAAgB,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAG3E;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CAAC,WAAW,EAAE,mBAAmB,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,uCAOvH"}

package/lib/cjs/Differencing/SchemaDifferenceValidator.js

@@ -0,0 +1,450 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Differencing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDifferences = void 0;
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const SchemaDifference_1 = require("./SchemaDifference");
+const SchemaConflicts_1 = require("./SchemaConflicts");
+const SchemaDifferenceVisitor_1 = require("./SchemaDifferenceVisitor");
+/**
+ * Validates the given array of schema differences and returns a list of conflicts if the
+ * validation finds violation against rules.
+ * @param differences   An array of schema differences.
+ * @param targetSchema  The target schema reference.
+ * @param sourceSchema  The source schema reference.
+ * @returns             An array of conflicts found when validating the difference.
+ * @internal
+ */
+async function validateDifferences(differences, targetSchema, sourceSchema) {
+    const visitor = new SchemaDifferenceValidationVisitor(targetSchema, sourceSchema);
+    const walker = new SchemaDifferenceVisitor_1.SchemaDifferenceWalker(visitor);
+    await walker.traverse(differences);
+    return visitor.conflicts;
+}
+exports.validateDifferences = validateDifferences;
+/**
+ * The SchemaDifferenceValidationVisitor class is an implementation of ISchemaDifferenceVisitor and
+ * validates the given SchemaDifferences if the violate against some EC Rules.
+ */
+class SchemaDifferenceValidationVisitor {
+    /** Initializes a new instance of SchemaDifferenceValidationVisitor class. */
+    constructor(targetSchema, sourceSchema) {
+        this.conflicts = [];
+        this._targetSchema = targetSchema;
+        this._sourceSchema = sourceSchema;
+    }
+    addConflict(conflict) {
+        this.conflicts.push(conflict);
+    }
+    /**
+     * Visitor implementation for handling SchemaDifference.
+     * @internal
+     */
+    async visitSchemaDifference(_entry) {
+    }
+    /**
+     * Visitor implementation for handling SchemaReferenceDifference.
+     * @internal
+     */
+    async visitSchemaReferenceDifference(entry) {
+        const sourceSchemaReference = await this._sourceSchema.getReference(entry.difference.name);
+        const targetSchemaReference = this._targetSchema.getReferenceNameByAlias(sourceSchemaReference.alias);
+        if (targetSchemaReference && targetSchemaReference !== sourceSchemaReference.name) {
+            this.addConflict({
+                code: SchemaConflicts_1.ConflictCode.ConflictingReferenceAlias,
+                schemaType: SchemaDifference_1.SchemaOtherTypes.SchemaReference,
+                source: entry.difference.name,
+                target: targetSchemaReference,
+                description: "Target schema already references a different schema with this alias.",
+            });
+        }
+    }
+    /**
+     * Shared schema item validation for all types of AnySchemaItemDifference union.
+     */
+    async visitSchemaItemDifference(entry, targetSchemaItem) {
+        // If the item shall be added, but the target schema already has an item with this name,
+        // will produce an ConflictingItemName conflict.
+        if (entry.changeType === "add" && targetSchemaItem !== undefined) {
+            this.addConflict({
+                code: SchemaConflicts_1.ConflictCode.ConflictingItemName,
+                schemaType: targetSchemaItem.schemaItemType,
+                itemName: targetSchemaItem.name,
+                source: entry.schemaType,
+                target: targetSchemaItem.schemaItemType,
+                description: "Target schema already contains a schema item with the name but different type.",
+            });
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Shared base-class validation for all types of ClassItemDifference union.
+     */
+    async visitBaseClassDifference(entry, targetClassItem) {
+        if (entry.difference.baseClass === undefined && targetClassItem.baseClass !== undefined) {
+            return this.addConflict({
+                code: SchemaConflicts_1.ConflictCode.RemovingBaseClass,
+                schemaType: targetClassItem.schemaItemType,
+                itemName: targetClassItem.name,
+                path: "$baseClass",
+                source: null,
+                target: resolveLazyItemFullName(targetClassItem.baseClass),
+                description: "BaseClass cannot be removed, if there has been a baseClass before.",
+            });
+        }
+        if (entry.difference.baseClass === undefined) {
+            return;
+        }
+        const sourceBaseClass = await this._sourceSchema.lookupItem(entry.difference.baseClass);
+        if (sourceBaseClass.modifier === ecschema_metadata_1.ECClassModifier.Sealed) {
+            return this.addConflict({
+                code: SchemaConflicts_1.ConflictCode.SealedBaseClass,
+                schemaType: targetClassItem.schemaItemType,
+                itemName: targetClassItem.name,
+                path: "$baseClass",
+                source: sourceBaseClass.fullName,
+                target: resolveLazyItemFullName(targetClassItem.baseClass) || null,
+                description: "BaseClass is sealed.",
+            });
+        }
+        if (targetClassItem.baseClass && !await this.derivedFrom(sourceBaseClass, targetClassItem.baseClass)) {
+            return this.addConflict({
+                code: SchemaConflicts_1.ConflictCode.ConflictingBaseClass,
+                schemaType: targetClassItem.schemaItemType,
+                itemName: targetClassItem.name,
+                path: "$baseClass",
+                source: sourceBaseClass.fullName,
+                target: resolveLazyItemFullName(targetClassItem.baseClass),
+                description: "BaseClass is not valid, source class must derive from target.",
+            });
+        }
+    }
+    /**
+     * Shared validation for all types of ClassItemDifference union.
+     */
+    async visitClassDifference(entry) {
+        const targetClassItem = await this._targetSchema.getItem(entry.itemName);
+        if (!await this.visitSchemaItemDifference(entry, targetClassItem)) {
+            return;
+        }
+        if (entry.changeType === "modify" && targetClassItem !== undefined) {
+            await this.visitClassModifierDifference(entry, targetClassItem);
+            await this.visitBaseClassDifference(entry, targetClassItem);
+        }
+    }
+    /**
+     * Validation the modifiers of all types of ClassItemDifference union.
+     */
+    async visitClassModifierDifference(entry, targetClass) {
+        if (entry.difference.modifier) {
+            const changedModifier = (0, ecschema_metadata_1.parseClassModifier)(entry.difference.modifier);
+            if (changedModifier !== undefined && changedModifier !== ecschema_metadata_1.ECClassModifier.None) {
+                this.addConflict({
+                    code: SchemaConflicts_1.ConflictCode.ConflictingClassModifier,
+                    schemaType: targetClass.schemaItemType,
+                    itemName: targetClass.name,
+                    source: entry.difference.modifier,
+                    target: (0, ecschema_metadata_1.classModifierToString)(targetClass.modifier),
+                    description: "Class has conflicting modifiers.",
+                });
+            }
+        }
+    }
+    /**
+     * Visitor implementation for handling ConstantDifference.
+     * @internal
+     */
+    async visitConstantDifference(entry) {
+        await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));
+    }
+    /**
+     * Visitor implementation for handling CustomAttributeClassDifference.
+     * @internal
+     */
+    async visitCustomAttributeClassDifference(entry) {
+        await this.visitClassDifference(entry);
+    }
+    /**
+     * Visitor implementation for handling CustomAttributeDifference.
+     * @internal
+     */
+    async visitCustomAttributeInstanceDifference(_entry) {
+    }
+    /**
+     * Visitor implementation for handling EntityClassDifference.
+     * @internal
+     */
+    async visitEntityClassDifference(entry) {
+        await this.visitClassDifference(entry);
+    }
+    /**
+     * Visitor implementation for handling EntityClassMixinDifference.
+     * @internal
+     */
+    async visitEntityClassMixinDifference(entry) {
+        const targetEntityClass = await this._targetSchema.getItem(entry.itemName);
+        for (const addedMixin of entry.difference) {
+            // To validate the added mixins, the instance from the source schema it fetched,
+            // otherwise validation gets too complicated as the mixin must not be existing in
+            // the current target schema, it could also be added to the schema.
+            const sourceMixin = await this._sourceSchema.lookupItem(addedMixin);
+            const sourceSchemaItem = await this._sourceSchema.getItem(entry.itemName);
+            if (sourceMixin.appliesTo && !await sourceSchemaItem.is(await sourceMixin.appliesTo)) {
+                this.addConflict({
+                    code: SchemaConflicts_1.ConflictCode.MixinAppliedMustDeriveFromConstraint,
+                    schemaType: targetEntityClass.schemaItemType,
+                    itemName: targetEntityClass.name,
+                    path: "$mixins",
+                    source: addedMixin,
+                    target: undefined,
+                    description: "Mixin cannot applied to this class.",
+                });
+            }
+        }
+    }
+    /**
+     * Visitor implementation for handling EnumerationDifference.
+     * @internal
+     */
+    async visitEnumerationDifference(entry) {
+        const enumeration = await this._targetSchema.getItem(entry.itemName);
+        if (!await this.visitSchemaItemDifference(entry, enumeration)) {
+            return;
+        }
+        if (entry.changeType === "modify" && enumeration !== undefined) {
+            if (entry.difference.type) {
+                this.addConflict({
+                    code: SchemaConflicts_1.ConflictCode.ConflictingEnumerationType,
+                    schemaType: ecschema_metadata_1.SchemaItemType.Enumeration,
+                    itemName: enumeration.name,
+                    source: entry.difference.type,
+                    target: (0, ecschema_metadata_1.primitiveTypeToString)(enumeration.type),
+                    description: "Enumeration has a different primitive type.",
+                });
+            }
+        }
+    }
+    /**
+     * Visitor implementation for handling EnumeratorDifference.
+     * @internal
+     */
+    async visitEnumeratorDifference(entry) {
+        if (entry.changeType !== "modify") {
+            return;
+        }
+        const enumeration = await this._targetSchema.getItem(entry.itemName);
+        const enumerator = enumeration.getEnumeratorByName(entry.path);
+        if (!enumerator) {
+            return;
+        }
+        if (entry.difference.value) {
+            this.addConflict({
+                code: SchemaConflicts_1.ConflictCode.ConflictingEnumeratorValue,
+                schemaType: ecschema_metadata_1.SchemaItemType.Enumeration,
+                itemName: enumeration.name,
+                path: enumerator.name,
+                source: entry.difference.value,
+                target: enumerator.value,
+                description: "Enumerators must have unique values.",
+            });
+        }
+    }
+    /**
+     * Visitor implementation for handling FormatDifference.
+     * @internal
+     */
+    async visitFormatDifference(entry) {
+        await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));
+    }
+    /**
+     * Visitor implementation for handling InvertedUnitDifference.
+     * @internal
+     */
+    async visitInvertedUnitDifference(entry) {
+        await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));
+    }
+    /**
+     * Visitor implementation for handling KindOfQuantityDifference.
+     * @internal
+     */
+    async visitKindOfQuantityDifference(entry) {
+        const kindOfQuantity = await this._targetSchema.getItem(entry.itemName);
+        if (!await this.visitSchemaItemDifference(entry, kindOfQuantity)) {
+            return;
+        }
+        if (entry.changeType === "modify" && kindOfQuantity !== undefined) {
+            if (entry.difference.persistenceUnit) {
+                this.addConflict({
+                    code: SchemaConflicts_1.ConflictCode.ConflictingPersistenceUnit,
+                    schemaType: ecschema_metadata_1.SchemaItemType.KindOfQuantity,
+                    itemName: kindOfQuantity.name,
+                    source: entry.difference.persistenceUnit,
+                    target: resolveLazyItemFullName(kindOfQuantity.persistenceUnit),
+                    description: "Kind of Quantity has a different persistence unit.",
+                });
+            }
+        }
+    }
+    /**
+     * Visitor implementation for handling MixinClassDifference.
+     * @internal
+     */
+    async visitMixinDifference(entry) {
+        await this.visitClassDifference(entry);
+    }
+    /**
+     * Visitor implementation for handling PhenomenonDifference.
+     * @internal
+     */
+    async visitPhenomenonDifference(entry) {
+        await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));
+    }
+    /**
+     * Visitor implementation for handling ClassPropertyDifference.
+     * @internal
+     */
+    async visitPropertyDifference(entry) {
+        const targetClass = await this._targetSchema.getItem(entry.itemName);
+        const targetProperty = await targetClass.getProperty(entry.path);
+        const sourceClass = await this._sourceSchema.getItem(entry.itemName);
+        const sourceProperty = await sourceClass.getProperty(entry.path);
+        // If property shall be added but there is already a property with this name
+        // in target, a ConflictingPropertyName is issued.
+        if (entry.changeType === "add" && targetProperty !== undefined) {
+            return this.addConflict({
+                code: SchemaConflicts_1.ConflictCode.ConflictingPropertyName,
+                schemaType: targetProperty.class.schemaItemType,
+                itemName: targetProperty.class.name,
+                path: targetProperty.name,
+                source: resolvePropertyTypeName(sourceProperty),
+                target: resolvePropertyTypeName(targetProperty),
+                description: "Target class already contains a property with a different type.",
+            });
+        }
+        if (entry.changeType === "modify" && targetProperty !== undefined) {
+            if (entry.difference.kindOfQuantity) {
+                const sourceKoQ = await sourceProperty.kindOfQuantity;
+                const targetKoQ = await targetProperty.kindOfQuantity;
+                if (!targetKoQ || sourceKoQ && resolveLazyItemName(sourceKoQ.persistenceUnit) !== resolveLazyItemName(targetKoQ.persistenceUnit)) {
+                    this.addConflict({
+                        code: SchemaConflicts_1.ConflictCode.ConflictingPropertyKindOfQuantity,
+                        schemaType: targetClass.schemaItemType,
+                        itemName: targetClass.name,
+                        path: targetProperty.name,
+                        source: entry.difference.kindOfQuantity,
+                        target: resolveLazyItemFullName(targetProperty.kindOfQuantity),
+                        description: "The property has different kind of quantities with conflicting units defined.",
+                    });
+                }
+            }
+        }
+    }
+    /**
+     * Visitor implementation for handling PropertyCategoryDifference.
+     * @internal
+     */
+    async visitPropertyCategoryDifference(entry) {
+        await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));
+    }
+    /**
+     * Visitor implementation for handling RelationshipClassDifference.
+     * @internal
+     */
+    async visitRelationshipClassDifference(entry) {
+        await this.visitClassDifference(entry);
+    }
+    /**
+     * Visitor implementation for handling RelationshipConstraintDifference.
+     * @internal
+     */
+    async visitRelationshipConstraintDifference(_entry) {
+    }
+    /**
+     * Visitor implementation for handling RelationshipConstraintClassDifference.
+     * @internal
+     */
+    async visitRelationshipConstraintClassDifference(_entry) {
+    }
+    /**
+     * Visitor implementation for handling StructClassDifference.
+     * @internal
+     */
+    async visitStructClassDifference(entry) {
+        await this.visitClassDifference(entry);
+    }
+    /**
+     * Visitor implementation for handling UnitDifference.
+     * @internal
+     */
+    async visitUnitDifference(entry) {
+        await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));
+    }
+    /**
+     * Visitor implementation for handling UnitSystemDifference.
+     * @internal
+     */
+    async visitUnitSystemDifference(entry) {
+        await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));
+    }
+    /**
+     * Recursive synchronous function to figure whether a given class derived from
+     * a class with the given baseClass name.
+     */
+    async derivedFrom(ecClass, baseClassKey) {
+        if (ecClass === undefined) {
+            return false;
+        }
+        // First check for name which must be same in any case...
+        if (ecClass.name === baseClassKey.name) {
+            // ... then check if the class is in the same schema as the expected base class...
+            if (ecClass.schema.name === baseClassKey.schemaName)
+                return true;
+            // ... if not, whether it's in the source schema, but then we expect the baseclass
+            // to be in the target schema.
+            if (ecClass.schema.name === this._sourceSchema.name && baseClassKey.schemaName === this._targetSchema.name)
+                return true;
+        }
+        return this.derivedFrom(await ecClass.baseClass, baseClassKey);
+    }
+}
+/**
+ * Helper method to resolve the schema item name from lazy loaded schema items.
+ * @param lazyItem  LazyLoaded item
+ * @returns         The full name of the item or undefined item was not set.
+ */
+function resolveLazyItemFullName(lazyItem) {
+    return lazyItem && lazyItem.fullName;
+}
+/**
+ * Helper method to resolve the schema item name from lazy loaded schema items.
+ * @param lazyItem  LazyLoaded item
+ * @returns         The full name of the item or undefined item was not set.
+ */
+function resolveLazyItemName(lazyItem) {
+    return lazyItem && lazyItem.name;
+}
+/**
+ * Helper method to resolve the type name of a property.
+ * @param property  The property which's type shall be resolved.
+ * @returns         The (full) name of the properties type.
+ */
+function resolvePropertyTypeName(property) {
+    const [prefix, suffix] = property.isArray() ? ["[", "]"] : ["", ""];
+    if (property.isEnumeration())
+        return `${prefix}${resolveLazyItemFullName(property.enumeration)}${suffix}`;
+    if (property.isPrimitive())
+        return `${prefix}${(0, ecschema_metadata_1.primitiveTypeToString)(property.primitiveType)}${suffix}`;
+    if (property.isStruct())
+        return `${prefix}${property.structClass.fullName}${suffix}`;
+    if (property.isNavigation())
+        return `${prefix}${property.relationshipClass.fullName}${suffix}`;
+    return (0, ecschema_metadata_1.propertyTypeToString)(property.propertyType);
+}
+//# sourceMappingURL=SchemaDifferenceValidator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaDifferenceValidator.js","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifferenceValidator.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAAgS;AAChS,yDAA6pB;AAC7pB,uDAA2E;AAC3E,uEAA6F;AAE7F;;;;;;;;GAQG;AACI,KAAK,UAAU,mBAAmB,CAAC,WAAkC,EAAE,YAAoB,EAAE,YAAoB;IACtH,MAAM,OAAO,GAAG,IAAI,iCAAiC,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,IAAI,gDAAsB,CAAC,OAAO,CAAC,CAAC;IAEnD,MAAM,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAEnC,OAAO,OAAO,CAAC,SAAS,CAAC;AAC3B,CAAC;AAPD,kDAOC;AAED;;;GAGG;AACH,MAAM,iCAAiC;IAMrC,6EAA6E;IAC7E,YAAY,YAAoB,EAAE,YAAoB;QACpD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAEO,WAAW,CAAC,QAAkC;QACpD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,MAAwB;IAC3D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,8BAA8B,CAAC,KAAgC;QAC1E,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAW,CAAC;QACrG,MAAM,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACtG,IAAI,qBAAqB,IAAI,qBAAqB,KAAK,qBAAqB,CAAC,IAAI,EAAE,CAAC;YAClF,IAAI,CAAC,WAAW,CAAC;gBACf,IAAI,EAAE,8BAAY,CAAC,yBAAyB;gBAC5C,UAAU,EAAE,mCAAgB,CAAC,eAAe;gBAC5C,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI;gBAC7B,MAAM,EAAE,qBAAqB;gBAC7B,WAAW,EAAE,sEAAsE;aACpF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,yBAAyB,CAAC,KAA8B,EAAE,gBAAwC;QAC9G,wFAAwF;QACxF,gDAAgD;QAChD,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACjE,IAAI,CAAC,WAAW,CAAC;gBACf,IAAI,EAAE,8BAAY,CAAC,mBAAmB;gBACtC,UAAU,EAAE,gBAAgB,CAAC,cAAc;gBAC3C,QAAQ,EAAE,gBAAgB,CAAC,IAAI;gBAC/B,MAAM,EAAE,KAAK,CAAC,UAAU;gBACxB,MAAM,EAAE,gBAAgB,CAAC,cAAc;gBACvC,WAAW,EAAE,gFAAgF;aAC9F,CAAC,CAAC;YACH,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,wBAAwB,CAAC,KAA0B,EAAE,eAAwB;QACzF,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,KAAK,SAAS,IAAI,eAAe,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACxF,OAAO,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,8BAAY,CAAC,iBAAiB;gBACpC,UAAU,EAAE,eAAe,CAAC,cAAc;gBAC1C,QAAQ,EAAE,eAAe,CAAC,IAAI;gBAC9B,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,uBAAuB,CAAC,eAAe,CAAC,SAAS,CAAC;gBAC1D,WAAW,EAAE,oEAAoE;aAClF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC7C,OAAO;QACT,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAY,CAAC;QACnG,IAAI,eAAe,CAAC,QAAQ,KAAK,mCAAe,CAAC,MAAM,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,8BAAY,CAAC,eAAe;gBAClC,UAAU,EAAE,eAAe,CAAC,cAAc;gBAC1C,QAAQ,EAAE,eAAe,CAAC,IAAI;gBAC9B,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE,eAAe,CAAC,QAAQ;gBAChC,MAAM,EAAE,uBAAuB,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,IAAI;gBAClE,WAAW,EAAE,sBAAsB;aACpC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,eAAe,CAAC,SAAS,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;YACrG,OAAO,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,8BAAY,CAAC,oBAAoB;gBACvC,UAAU,EAAE,eAAe,CAAC,cAAc;gBAC1C,QAAQ,EAAE,eAAe,CAAC,IAAI;gBAC9B,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE,eAAe,CAAC,QAAQ;gBAChC,MAAM,EAAE,uBAAuB,CAAC,eAAe,CAAC,SAAS,CAAC;gBAC1D,WAAW,EAAE,+DAA+D;aAC7E,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,oBAAoB,CAAC,KAA0B;QAC3D,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAU,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,eAAe,CAAC,EAAE,CAAC;YAClE,OAAO;QACT,CAAC;QAED,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YACnE,MAAM,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;YAChE,MAAM,IAAI,CAAC,wBAAwB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,4BAA4B,CAAC,KAA0B,EAAE,WAAoB;QACzF,IAAI,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC9B,MAAM,eAAe,GAAG,IAAA,sCAAkB,EAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACtE,IAAI,eAAe,KAAK,SAAS,IAAI,eAAe,KAAK,mCAAe,CAAC,IAAI,EAAE,CAAC;gBAC9E,IAAI,CAAC,WAAW,CAAC;oBACf,IAAI,EAAE,8BAAY,CAAC,wBAAwB;oBAC3C,UAAU,EAAE,WAAW,CAAC,cAAc;oBACtC,QAAQ,EAAE,WAAW,CAAC,IAAI;oBAC1B,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,QAAQ;oBACjC,MAAM,EAAE,IAAA,yCAAqB,EAAC,WAAW,CAAC,QAAQ,CAAC;oBACnD,WAAW,EAAE,kCAAkC;iBAChD,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,uBAAuB,CAAC,KAAyB;QAC5D,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mCAAmC,CAAC,KAAqC;QACpF,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,sCAAsC,CAAC,MAAiC;IACrF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B;QAClE,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B,CAAC,KAAiC;QAC5E,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAgB,CAAC;QAC1F,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC1C,gFAAgF;YAChF,iFAAiF;YACjF,mEAAmE;YACnE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,UAAU,CAAU,CAAC;YAC7E,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAgB,CAAC;YACzF,IAAI,WAAW,CAAC,SAAS,IAAI,CAAC,MAAM,gBAAgB,CAAC,EAAE,CAAC,MAAM,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrF,IAAI,CAAC,WAAW,CAAC;oBACf,IAAI,EAAE,8BAAY,CAAC,oCAAoC;oBACvD,UAAU,EAAE,iBAAiB,CAAC,cAAc;oBAC5C,QAAQ,EAAE,iBAAiB,CAAC,IAAI;oBAChC,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,UAAU;oBAClB,MAAM,EAAE,SAAS;oBACjB,WAAW,EAAE,qCAAqC;iBACnD,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B;QAClE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAc,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC/D,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;gBAC1B,IAAI,CAAC,WAAW,CAAC;oBACf,IAAI,EAAE,8BAAY,CAAC,0BAA0B;oBAC7C,UAAU,EAAE,kCAAc,CAAC,WAAW;oBACtC,QAAQ,EAAE,WAAW,CAAC,IAAI;oBAC1B,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI;oBAC7B,MAAM,EAAE,IAAA,yCAAqB,EAAC,WAAW,CAAC,IAAK,CAAC;oBAChD,WAAW,EAAE,6CAA6C;iBAC3D,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO;QACT,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAgB,CAAC;QACpF,MAAM,UAAU,GAAG,WAAW,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QAED,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC;gBACf,IAAI,EAAE,8BAAY,CAAC,0BAA0B;gBAC7C,UAAU,EAAE,kCAAc,CAAC,WAAW;gBACtC,QAAQ,EAAE,WAAW,CAAC,IAAI;gBAC1B,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK;gBAC9B,MAAM,EAAE,UAAU,CAAC,KAAK;gBACxB,WAAW,EAAE,sCAAsC;aACpD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,KAAuB;QACxD,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,2BAA2B,CAAC,KAA6B;QACpE,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,6BAA6B,CAAC,KAA+B;QACxE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAiB,KAAK,CAAC,QAAQ,CAAC,CAAC;QACxF,IAAI,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,EAAE,CAAC;YACjE,OAAO;QACT,CAAC;QAED,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAClE,IAAI,KAAK,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;gBACrC,IAAI,CAAC,WAAW,CAAC;oBACf,IAAI,EAAE,8BAAY,CAAC,0BAA0B;oBAC7C,UAAU,EAAE,kCAAc,CAAC,cAAc;oBACzC,QAAQ,EAAE,cAAc,CAAC,IAAI;oBAC7B,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,eAAe;oBACxC,MAAM,EAAE,uBAAuB,CAAC,cAAc,CAAC,eAAe,CAAC;oBAC/D,WAAW,EAAE,oDAAoD;iBAClE,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,KAA2B;QAC3D,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,uBAAuB,CAAC,KAA8B;QACjE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAY,CAAC;QAChF,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEjE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAY,CAAC;QAChF,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAa,CAAC;QAE7E,4EAA4E;QAC5E,kDAAkD;QAClD,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAC/D,OAAO,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,8BAAY,CAAC,uBAAuB;gBAC1C,UAAU,EAAE,cAAc,CAAC,KAAK,CAAC,cAAc;gBAC/C,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI;gBACnC,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,MAAM,EAAE,uBAAuB,CAAC,cAAc,CAAC;gBAC/C,MAAM,EAAE,uBAAuB,CAAC,cAAc,CAAC;gBAC/C,WAAW,EAAE,iEAAiE;aAC/E,CAAC,CAAC;QACL,CAAC;QAED,IAAI,KAAK,CAAC,UAAU,KAAK,QAAQ,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAClE,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;gBACpC,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,cAAc,CAAC;gBACtD,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,cAAc,CAAC;gBACtD,IAAI,CAAC,SAAS,IAAI,SAAS,IAAI,mBAAmB,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,mBAAmB,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC;oBACjI,IAAI,CAAC,WAAW,CAAC;wBACf,IAAI,EAAE,8BAAY,CAAC,iCAAiC;wBACpD,UAAU,EAAE,WAAW,CAAC,cAAc;wBACtC,QAAQ,EAAE,WAAW,CAAC,IAAI;wBAC1B,IAAI,EAAE,cAAc,CAAC,IAAI;wBACzB,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,cAAc;wBACvC,MAAM,EAAE,uBAAuB,CAAC,cAAc,CAAC,cAAc,CAAC;wBAC9D,WAAW,EAAE,+EAA+E;qBAC7F,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B,CAAC,KAAiC;QAC5E,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gCAAgC,CAAC,KAAkC;QAC9E,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qCAAqC,CAAC,MAAwC;IAC3F,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0CAA0C,CAAC,MAA6C;IACrG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B;QAClE,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mBAAmB,CAAC,KAAqB;QACpD,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,WAAW,CAAC,OAA4B,EAAE,YAAqC;QAC3F,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,yDAAyD;QACzD,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;YACvC,kFAAkF;YAClF,IAAG,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,UAAU;gBAChD,OAAO,IAAI,CAAC;YACd,kFAAkF;YAClF,8BAA8B;YAC9B,IAAG,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,YAAY,CAAC,UAAU,KAAK,IAAI,CAAC,aAAa,CAAC,IAAI;gBACvG,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACjE,CAAC;CACF;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAAC,QAA2C;IAC1E,OAAO,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,QAA2C;IACtE,OAAO,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAAC,QAAkB;IACjD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACpE,IAAI,QAAQ,CAAC,aAAa,EAAE;QAC1B,OAAO,GAAG,MAAM,GAAG,uBAAuB,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,MAAM,EAAE,CAAC;IAC9E,IAAI,QAAQ,CAAC,WAAW,EAAE;QACxB,OAAO,GAAG,MAAM,GAAG,IAAA,yCAAqB,EAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,MAAM,EAAE,CAAC;IAC9E,IAAI,QAAQ,CAAC,QAAQ,EAAE;QACrB,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,QAAQ,GAAG,MAAM,EAAE,CAAC;IAC9D,IAAI,QAAQ,CAAC,YAAY,EAAE;QACzB,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC,iBAAiB,CAAC,QAAQ,GAAG,MAAM,EAAE,CAAC;IACpE,OAAO,IAAA,wCAAoB,EAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AACrD,CAAC","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 Differencing\r\n */\r\n\r\nimport { classModifierToString, ECClass, ECClassModifier, EntityClass, Enumeration, KindOfQuantity, LazyLoadedSchemaItem, Mixin, parseClassModifier, primitiveTypeToString, Property, propertyTypeToString, Schema, SchemaItem, SchemaItemKey, SchemaItemType } from \"@itwin/ecschema-metadata\";\r\nimport { AnySchemaDifference, AnySchemaItemDifference, ClassItemDifference, ClassPropertyDifference, ConstantDifference, CustomAttributeClassDifference, CustomAttributeDifference, EntityClassDifference, EntityClassMixinDifference, EnumerationDifference, EnumeratorDifference, FormatDifference, InvertedUnitDifference, KindOfQuantityDifference, MixinClassDifference, PhenomenonDifference, PropertyCategoryDifference, RelationshipClassDifference, RelationshipConstraintClassDifference, RelationshipConstraintDifference, SchemaDifference, SchemaOtherTypes, SchemaReferenceDifference, StructClassDifference, UnitDifference, UnitSystemDifference } from \"./SchemaDifference\";\r\nimport { ConflictCode, SchemaDifferenceConflict } from \"./SchemaConflicts\";\r\nimport { ISchemaDifferenceVisitor, SchemaDifferenceWalker } from \"./SchemaDifferenceVisitor\";\r\n\r\n/**\r\n * Validates the given array of schema differences and returns a list of conflicts if the\r\n * validation finds violation against rules.\r\n * @param differences   An array of schema differences.\r\n * @param targetSchema  The target schema reference.\r\n * @param sourceSchema  The source schema reference.\r\n * @returns             An array of conflicts found when validating the difference.\r\n * @internal\r\n */\r\nexport async function validateDifferences(differences: AnySchemaDifference[], targetSchema: Schema, sourceSchema: Schema) {\r\n  const visitor = new SchemaDifferenceValidationVisitor(targetSchema, sourceSchema);\r\n  const walker = new SchemaDifferenceWalker(visitor);\r\n\r\n  await walker.traverse(differences);\r\n\r\n  return visitor.conflicts;\r\n}\r\n\r\n/**\r\n * The SchemaDifferenceValidationVisitor class is an implementation of ISchemaDifferenceVisitor and\r\n * validates the given SchemaDifferences if the violate against some EC Rules.\r\n */\r\nclass SchemaDifferenceValidationVisitor implements ISchemaDifferenceVisitor {\r\n\r\n  public readonly conflicts: Array<SchemaDifferenceConflict>;\r\n  private readonly _sourceSchema: Schema;\r\n  private readonly _targetSchema: Schema;\r\n\r\n  /** Initializes a new instance of SchemaDifferenceValidationVisitor class. */\r\n  constructor(targetSchema: Schema, sourceSchema: Schema) {\r\n    this.conflicts = [];\r\n    this._targetSchema = targetSchema;\r\n    this._sourceSchema = sourceSchema;\r\n  }\r\n\r\n  private addConflict(conflict: SchemaDifferenceConflict) {\r\n    this.conflicts.push(conflict);\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling SchemaDifference.\r\n   * @internal\r\n   */\r\n  public async visitSchemaDifference(_entry: SchemaDifference) {\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling SchemaReferenceDifference.\r\n   * @internal\r\n   */\r\n  public async visitSchemaReferenceDifference(entry: SchemaReferenceDifference) {\r\n    const sourceSchemaReference = await this._sourceSchema.getReference(entry.difference.name) as Schema;\r\n    const targetSchemaReference = this._targetSchema.getReferenceNameByAlias(sourceSchemaReference.alias);\r\n    if (targetSchemaReference && targetSchemaReference !== sourceSchemaReference.name) {\r\n      this.addConflict({\r\n        code: ConflictCode.ConflictingReferenceAlias,\r\n        schemaType: SchemaOtherTypes.SchemaReference,\r\n        source: entry.difference.name,\r\n        target: targetSchemaReference,\r\n        description: \"Target schema already references a different schema with this alias.\",\r\n      });\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Shared schema item validation for all types of AnySchemaItemDifference union.\r\n   */\r\n  private async visitSchemaItemDifference(entry: AnySchemaItemDifference, targetSchemaItem: SchemaItem | undefined) {\r\n    // If the item shall be added, but the target schema already has an item with this name,\r\n    // will produce an ConflictingItemName conflict.\r\n    if (entry.changeType === \"add\" && targetSchemaItem !== undefined) {\r\n      this.addConflict({\r\n        code: ConflictCode.ConflictingItemName,\r\n        schemaType: targetSchemaItem.schemaItemType,\r\n        itemName: targetSchemaItem.name,\r\n        source: entry.schemaType,\r\n        target: targetSchemaItem.schemaItemType,\r\n        description: \"Target schema already contains a schema item with the name but different type.\",\r\n      });\r\n      return false;\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * Shared base-class validation for all types of ClassItemDifference union.\r\n   */\r\n  private async visitBaseClassDifference(entry: ClassItemDifference, targetClassItem: ECClass) {\r\n    if (entry.difference.baseClass === undefined && targetClassItem.baseClass !== undefined) {\r\n      return this.addConflict({\r\n        code: ConflictCode.RemovingBaseClass,\r\n        schemaType: targetClassItem.schemaItemType,\r\n        itemName: targetClassItem.name,\r\n        path: \"$baseClass\",\r\n        source: null,\r\n        target: resolveLazyItemFullName(targetClassItem.baseClass),\r\n        description: \"BaseClass cannot be removed, if there has been a baseClass before.\",\r\n      });\r\n    }\r\n\r\n    if (entry.difference.baseClass === undefined) {\r\n      return;\r\n    }\r\n\r\n    const sourceBaseClass = await this._sourceSchema.lookupItem(entry.difference.baseClass) as ECClass;\r\n    if (sourceBaseClass.modifier === ECClassModifier.Sealed) {\r\n      return this.addConflict({\r\n        code: ConflictCode.SealedBaseClass,\r\n        schemaType: targetClassItem.schemaItemType,\r\n        itemName: targetClassItem.name,\r\n        path: \"$baseClass\",\r\n        source: sourceBaseClass.fullName,\r\n        target: resolveLazyItemFullName(targetClassItem.baseClass) || null,\r\n        description: \"BaseClass is sealed.\",\r\n      });\r\n    }\r\n\r\n    if (targetClassItem.baseClass && !await this.derivedFrom(sourceBaseClass, targetClassItem.baseClass)) {\r\n      return this.addConflict({\r\n        code: ConflictCode.ConflictingBaseClass,\r\n        schemaType: targetClassItem.schemaItemType,\r\n        itemName: targetClassItem.name,\r\n        path: \"$baseClass\",\r\n        source: sourceBaseClass.fullName,\r\n        target: resolveLazyItemFullName(targetClassItem.baseClass),\r\n        description: \"BaseClass is not valid, source class must derive from target.\",\r\n      });\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Shared validation for all types of ClassItemDifference union.\r\n   */\r\n  private async visitClassDifference(entry: ClassItemDifference) {\r\n    const targetClassItem = await this._targetSchema.getItem<ECClass>(entry.itemName);\r\n    if (!await this.visitSchemaItemDifference(entry, targetClassItem)) {\r\n      return;\r\n    }\r\n\r\n    if (entry.changeType === \"modify\" && targetClassItem !== undefined) {\r\n      await this.visitClassModifierDifference(entry, targetClassItem);\r\n      await this.visitBaseClassDifference(entry, targetClassItem);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Validation the modifiers of all types of ClassItemDifference union.\r\n   */\r\n  private async visitClassModifierDifference(entry: ClassItemDifference, targetClass: ECClass) {\r\n    if (entry.difference.modifier) {\r\n      const changedModifier = parseClassModifier(entry.difference.modifier);\r\n      if (changedModifier !== undefined && changedModifier !== ECClassModifier.None) {\r\n        this.addConflict({\r\n          code: ConflictCode.ConflictingClassModifier,\r\n          schemaType: targetClass.schemaItemType,\r\n          itemName: targetClass.name,\r\n          source: entry.difference.modifier,\r\n          target: classModifierToString(targetClass.modifier),\r\n          description: \"Class has conflicting modifiers.\",\r\n        });\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling ConstantDifference.\r\n   * @internal\r\n   */\r\n  public async visitConstantDifference(entry: ConstantDifference) {\r\n    await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling CustomAttributeClassDifference.\r\n   * @internal\r\n   */\r\n  public async visitCustomAttributeClassDifference(entry: CustomAttributeClassDifference) {\r\n    await this.visitClassDifference(entry);\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling CustomAttributeDifference.\r\n   * @internal\r\n   */\r\n  public async visitCustomAttributeInstanceDifference(_entry: CustomAttributeDifference) {\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling EntityClassDifference.\r\n   * @internal\r\n   */\r\n  public async visitEntityClassDifference(entry: EntityClassDifference) {\r\n    await this.visitClassDifference(entry);\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling EntityClassMixinDifference.\r\n   * @internal\r\n   */\r\n  public async visitEntityClassMixinDifference(entry: EntityClassMixinDifference) {\r\n    const targetEntityClass = await this._targetSchema.getItem(entry.itemName) as EntityClass;\r\n    for (const addedMixin of entry.difference) {\r\n      // To validate the added mixins, the instance from the source schema it fetched,\r\n      // otherwise validation gets too complicated as the mixin must not be existing in\r\n      // the current target schema, it could also be added to the schema.\r\n      const sourceMixin = await this._sourceSchema.lookupItem(addedMixin) as Mixin;\r\n      const sourceSchemaItem = await this._sourceSchema.getItem(entry.itemName) as EntityClass;\r\n      if (sourceMixin.appliesTo && !await sourceSchemaItem.is(await sourceMixin.appliesTo)) {\r\n        this.addConflict({\r\n          code: ConflictCode.MixinAppliedMustDeriveFromConstraint,\r\n          schemaType: targetEntityClass.schemaItemType,\r\n          itemName: targetEntityClass.name,\r\n          path: \"$mixins\",\r\n          source: addedMixin,\r\n          target: undefined,\r\n          description: \"Mixin cannot applied to this class.\",\r\n        });\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling EnumerationDifference.\r\n   * @internal\r\n   */\r\n  public async visitEnumerationDifference(entry: EnumerationDifference) {\r\n    const enumeration = await this._targetSchema.getItem<Enumeration>(entry.itemName);\r\n    if (!await this.visitSchemaItemDifference(entry, enumeration)) {\r\n      return;\r\n    }\r\n\r\n    if (entry.changeType === \"modify\" && enumeration !== undefined) {\r\n      if (entry.difference.type) {\r\n        this.addConflict({\r\n          code: ConflictCode.ConflictingEnumerationType,\r\n          schemaType: SchemaItemType.Enumeration,\r\n          itemName: enumeration.name,\r\n          source: entry.difference.type,\r\n          target: primitiveTypeToString(enumeration.type!),\r\n          description: \"Enumeration has a different primitive type.\",\r\n        });\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling EnumeratorDifference.\r\n   * @internal\r\n   */\r\n  public async visitEnumeratorDifference(entry: EnumeratorDifference) {\r\n    if (entry.changeType !== \"modify\") {\r\n      return;\r\n    }\r\n\r\n    const enumeration = await this._targetSchema.getItem(entry.itemName) as Enumeration;\r\n    const enumerator = enumeration.getEnumeratorByName(entry.path);\r\n    if (!enumerator) {\r\n      return;\r\n    }\r\n\r\n    if (entry.difference.value) {\r\n      this.addConflict({\r\n        code: ConflictCode.ConflictingEnumeratorValue,\r\n        schemaType: SchemaItemType.Enumeration,\r\n        itemName: enumeration.name,\r\n        path: enumerator.name,\r\n        source: entry.difference.value,\r\n        target: enumerator.value,\r\n        description: \"Enumerators must have unique values.\",\r\n      });\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling FormatDifference.\r\n   * @internal\r\n   */\r\n  public async visitFormatDifference(entry: FormatDifference) {\r\n    await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling InvertedUnitDifference.\r\n   * @internal\r\n   */\r\n  public async visitInvertedUnitDifference(entry: InvertedUnitDifference) {\r\n    await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling KindOfQuantityDifference.\r\n   * @internal\r\n   */\r\n  public async visitKindOfQuantityDifference(entry: KindOfQuantityDifference) {\r\n    const kindOfQuantity = await this._targetSchema.getItem<KindOfQuantity>(entry.itemName);\r\n    if (!await this.visitSchemaItemDifference(entry, kindOfQuantity)) {\r\n      return;\r\n    }\r\n\r\n    if (entry.changeType === \"modify\" && kindOfQuantity !== undefined) {\r\n      if (entry.difference.persistenceUnit) {\r\n        this.addConflict({\r\n          code: ConflictCode.ConflictingPersistenceUnit,\r\n          schemaType: SchemaItemType.KindOfQuantity,\r\n          itemName: kindOfQuantity.name,\r\n          source: entry.difference.persistenceUnit,\r\n          target: resolveLazyItemFullName(kindOfQuantity.persistenceUnit),\r\n          description: \"Kind of Quantity has a different persistence unit.\",\r\n        });\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling MixinClassDifference.\r\n   * @internal\r\n   */\r\n  public async visitMixinDifference(entry: MixinClassDifference) {\r\n    await this.visitClassDifference(entry);\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling PhenomenonDifference.\r\n   * @internal\r\n   */\r\n  public async visitPhenomenonDifference(entry: PhenomenonDifference) {\r\n    await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling ClassPropertyDifference.\r\n   * @internal\r\n   */\r\n  public async visitPropertyDifference(entry: ClassPropertyDifference) {\r\n    const targetClass = await this._targetSchema.getItem(entry.itemName) as ECClass;\r\n    const targetProperty = await targetClass.getProperty(entry.path);\r\n\r\n    const sourceClass = await this._sourceSchema.getItem(entry.itemName) as ECClass;\r\n    const sourceProperty = await sourceClass.getProperty(entry.path) as Property;\r\n\r\n    // If property shall be added but there is already a property with this name\r\n    // in target, a ConflictingPropertyName is issued.\r\n    if (entry.changeType === \"add\" && targetProperty !== undefined) {\r\n      return this.addConflict({\r\n        code: ConflictCode.ConflictingPropertyName,\r\n        schemaType: targetProperty.class.schemaItemType,\r\n        itemName: targetProperty.class.name,\r\n        path: targetProperty.name,\r\n        source: resolvePropertyTypeName(sourceProperty),\r\n        target: resolvePropertyTypeName(targetProperty),\r\n        description: \"Target class already contains a property with a different type.\",\r\n      });\r\n    }\r\n\r\n    if (entry.changeType === \"modify\" && targetProperty !== undefined) {\r\n      if (entry.difference.kindOfQuantity) {\r\n        const sourceKoQ = await sourceProperty.kindOfQuantity;\r\n        const targetKoQ = await targetProperty.kindOfQuantity;\r\n        if (!targetKoQ || sourceKoQ && resolveLazyItemName(sourceKoQ.persistenceUnit) !== resolveLazyItemName(targetKoQ.persistenceUnit)) {\r\n          this.addConflict({\r\n            code: ConflictCode.ConflictingPropertyKindOfQuantity,\r\n            schemaType: targetClass.schemaItemType,\r\n            itemName: targetClass.name,\r\n            path: targetProperty.name,\r\n            source: entry.difference.kindOfQuantity,\r\n            target: resolveLazyItemFullName(targetProperty.kindOfQuantity),\r\n            description: \"The property has different kind of quantities with conflicting units defined.\",\r\n          });\r\n        }\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling PropertyCategoryDifference.\r\n   * @internal\r\n   */\r\n  public async visitPropertyCategoryDifference(entry: PropertyCategoryDifference) {\r\n    await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling RelationshipClassDifference.\r\n   * @internal\r\n   */\r\n  public async visitRelationshipClassDifference(entry: RelationshipClassDifference) {\r\n    await this.visitClassDifference(entry);\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling RelationshipConstraintDifference.\r\n   * @internal\r\n   */\r\n  public async visitRelationshipConstraintDifference(_entry: RelationshipConstraintDifference) {\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling RelationshipConstraintClassDifference.\r\n   * @internal\r\n   */\r\n  public async visitRelationshipConstraintClassDifference(_entry: RelationshipConstraintClassDifference) {\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling StructClassDifference.\r\n   * @internal\r\n   */\r\n  public async visitStructClassDifference(entry: StructClassDifference) {\r\n    await this.visitClassDifference(entry);\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling UnitDifference.\r\n   * @internal\r\n   */\r\n  public async visitUnitDifference(entry: UnitDifference) {\r\n    await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));\r\n  }\r\n\r\n  /**\r\n   * Visitor implementation for handling UnitSystemDifference.\r\n   * @internal\r\n   */\r\n  public async visitUnitSystemDifference(entry: UnitSystemDifference) {\r\n    await this.visitSchemaItemDifference(entry, await this._targetSchema.getItem(entry.itemName));\r\n  }\r\n\r\n  /**\r\n   * Recursive synchronous function to figure whether a given class derived from\r\n   * a class with the given baseClass name.\r\n   */\r\n  private async derivedFrom(ecClass: ECClass | undefined, baseClassKey: Readonly<SchemaItemKey>): Promise<boolean> {\r\n    if (ecClass === undefined) {\r\n      return false;\r\n    }\r\n\r\n    // First check for name which must be same in any case...\r\n    if (ecClass.name === baseClassKey.name) {\r\n      // ... then check if the class is in the same schema as the expected base class...\r\n      if(ecClass.schema.name === baseClassKey.schemaName)\r\n        return true;\r\n      // ... if not, whether it's in the source schema, but then we expect the baseclass\r\n      // to be in the target schema.\r\n      if(ecClass.schema.name === this._sourceSchema.name && baseClassKey.schemaName === this._targetSchema.name)\r\n        return true;\r\n    }\r\n    return this.derivedFrom(await ecClass.baseClass, baseClassKey);\r\n  }\r\n}\r\n\r\n/**\r\n * Helper method to resolve the schema item name from lazy loaded schema items.\r\n * @param lazyItem  LazyLoaded item\r\n * @returns         The full name of the item or undefined item was not set.\r\n */\r\nfunction resolveLazyItemFullName(lazyItem?: LazyLoadedSchemaItem<SchemaItem>) {\r\n  return lazyItem && lazyItem.fullName;\r\n}\r\n\r\n/**\r\n * Helper method to resolve the schema item name from lazy loaded schema items.\r\n * @param lazyItem  LazyLoaded item\r\n * @returns         The full name of the item or undefined item was not set.\r\n */\r\nfunction resolveLazyItemName(lazyItem?: LazyLoadedSchemaItem<SchemaItem>) {\r\n  return lazyItem && lazyItem.name;\r\n}\r\n\r\n/**\r\n * Helper method to resolve the type name of a property.\r\n * @param property  The property which's type shall be resolved.\r\n * @returns         The (full) name of the properties type.\r\n */\r\nfunction resolvePropertyTypeName(property: Property) {\r\n  const [prefix, suffix] = property.isArray() ? [\"[\", \"]\"] : [\"\", \"\"];\r\n  if (property.isEnumeration())\r\n    return `${prefix}${resolveLazyItemFullName(property.enumeration)}${suffix}`;\r\n  if (property.isPrimitive())\r\n    return `${prefix}${primitiveTypeToString(property.primitiveType)}${suffix}`;\r\n  if (property.isStruct())\r\n    return `${prefix}${property.structClass.fullName}${suffix}`;\r\n  if (property.isNavigation())\r\n    return `${prefix}${property.relationshipClass.fullName}${suffix}`;\r\n  return propertyTypeToString(property.propertyType);\r\n}\r\n"]}

package/lib/cjs/Differencing/SchemaDifferenceVisitor.d.ts

@@ -0,0 +1,29 @@
+/** @packageDocumentation
+ * @module Differencing
+ */
+import { type AnySchemaDifference } from "./SchemaDifference";
+/**
+ * Defines the interface for a visitor that can be used to traverse schema differences.
+ * It dynamically creates a method for each schema difference type.
+ * @internal
+ */
+export type ISchemaDifferenceVisitor = {
+    [Difference in AnySchemaDifference as `visit${Difference["schemaType"]}Difference`]: (entry: Difference) => Promise<void>;
+};
+/**
+ * Implementation of a walker that traverses schema differences and calls the appropriate
+ * method on the visitor.
+ * @internal
+ */
+export declare class SchemaDifferenceWalker {
+    private readonly _visitor;
+    /** Initializes a new instance of SchemaDifferenceWalker class. */
+    constructor(visitor: ISchemaDifferenceVisitor);
+    /**
+     * Traverses the schema differences and calls the appropriate method on the visitor.
+     * @param differences The differences to traverse.
+     */
+    traverse(differences: Iterable<AnySchemaDifference>): Promise<void>;
+    private visit;
+}
+//# sourceMappingURL=SchemaDifferenceVisitor.d.ts.map