@itwin/ecschema-editing 3.0.0-dev.72

package/lib/Validation/SchemaCompareVisitor.js

@@ -0,0 +1,207 @@
+"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 Comparison
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaCompareVisitor = void 0;
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+/**
+ * An ISchemaPartVisitor interface implementation that is used to compare to Schemas.
+ * @internal
+ */
+class SchemaCompareVisitor {
+    /**
+     * Initializes a new SchemaCompareVisitor instance.
+     * @param schemaComparer The [[SchemaComparer]] to use to compare each item of the schema.
+     * @param schemaToCompare The second or 'B' schema to compare against the schema being traversed (Schema A).
+     */
+    constructor(schemaComparer, schemaToCompare) {
+        this._schemaComparer = schemaComparer;
+        this._schemaB = schemaToCompare;
+    }
+    /**
+     * Called before schema traversal.
+     * @param schema a Schema object.
+     */
+    async visitFullSchema(schemaA) {
+        this._schemaComparer.compareSchemaProps(schemaA, this._schemaB);
+    }
+    /**
+     * Called for each [[SchemaItem]] instance found during schema traversal.
+     * @param schemaItem a SchemaItem object.
+     */
+    async visitSchemaItem(schemaItemA) {
+        const schemaItemB = await this._schemaB.lookupItem(schemaItemA.key);
+        this._schemaComparer.compareSchemaItems(schemaItemA, schemaItemB);
+    }
+    /**
+     * Called for each [[AnyClass]] instance found during schema traversal.
+     * @param ecClass an ECClass object.
+     */
+    async visitClass(classA) {
+        const classB = await this._schemaB.lookupItem(classA.key);
+        this._schemaComparer.compareClasses(classA, classB);
+    }
+    /**
+     * Called for each [[AnyProperty]] instance of an ECClass.
+     * @param property an AnyProperty object.
+     */
+    async visitProperty(propertyA) {
+        let propertyB;
+        const classB = await this._schemaB.lookupItem(propertyA.class.key);
+        if (classB)
+            propertyB = await classB.getProperty(propertyA.name);
+        this._schemaComparer.compareProperties(propertyA, propertyB);
+    }
+    /**
+     * Called for each [[EntityClass]] instance found during schema traversal.
+     * @param entityClass an EntityClass object.
+     */
+    async visitEntityClass(entityA) {
+        const entityB = await this._schemaB.lookupItem(entityA.key);
+        this._schemaComparer.compareEntityClasses(entityA, entityB);
+    }
+    /**
+     * Called for each [[StructClass]] instance found during schema traversal.
+     * @param structClass a StructClass object.
+     */
+    async visitStructClass(_structA) {
+        // No comparison to make specifically on StructClasses
+    }
+    /**
+     * Called for each [[Mixin]] instance found during schema traversal.
+     * @param mixin a Mixin object.
+     */
+    async visitMixin(mixinA) {
+        const mixinB = await this._schemaB.lookupItem(mixinA.key);
+        this._schemaComparer.compareMixins(mixinA, mixinB);
+    }
+    /**
+     * Called for each [[RelationshipClass]] instance found during schema traversal.
+     * @param relationshipClass a RelationshipClass object.
+     */
+    async visitRelationshipClass(relationshipA) {
+        const relationshipB = await this._schemaB.lookupItem(relationshipA.key);
+        this._schemaComparer.compareRelationshipClasses(relationshipA, relationshipB);
+    }
+    /**
+     * Called for each [[RelationshipConstraint]] of each RelationshipClass found during schema traversal.
+     * @param relationshipConstraint a RelationshipConstraint object.
+     */
+    async visitRelationshipConstraint(constraintA) {
+        let constraintB;
+        const relationshipB = await this._schemaB.lookupItem(constraintA.relationshipClass.key);
+        if (relationshipB)
+            constraintB = constraintA.isSource ? relationshipB.source : relationshipB.target;
+        this._schemaComparer.compareRelationshipConstraints(constraintA, constraintB);
+    }
+    /**
+     * Called for each [[CustomAttributeClass]] instance found during schema traversal.
+     * @param customAttributeClass a CustomAttributeClass object.
+     */
+    async visitCustomAttributeClass(customAttributeA) {
+        const customAttributeB = await this._schemaB.lookupItem(customAttributeA.key);
+        this._schemaComparer.compareCustomAttributeClasses(customAttributeA, customAttributeB);
+    }
+    /**
+     * Called for each [[CustomAttribute]] container in the schema.
+     * @param customAttributeContainer a [[CustomAttributeContainerProps]] object.
+     */
+    async visitCustomAttributeContainer(containerA) {
+        const nameParts = containerA.fullName.split(".");
+        const shortName = nameParts.length === 1 ? nameParts[0] : nameParts[1];
+        let containerB;
+        if (ecschema_metadata_1.Schema.isSchema(containerA)) {
+            containerB = this._schemaB;
+        }
+        else if (ecschema_metadata_1.ECClass.isECClass(containerA)) {
+            containerB = await this._schemaB.lookupItem(shortName);
+        }
+        else if (ecschema_metadata_1.Property.isProperty(containerA)) {
+            const parent = await this._schemaB.lookupItem(containerA.class.key);
+            containerB = parent ? await parent.getProperty(shortName) : undefined;
+        }
+        else if (ecschema_metadata_1.RelationshipConstraint.isRelationshipConstraint(containerA)) {
+            const parent = await this._schemaB.lookupItem(containerA.relationshipClass.key);
+            containerB = parent ? await parent.getProperty(shortName) : undefined;
+        }
+        this._schemaComparer.compareCustomAttributeContainers(containerA, containerB);
+    }
+    /**
+     * Called for each [[Enumeration]] instance found during schema traversal.
+     * @param enumeration an Enumeration object.
+     */
+    async visitEnumeration(enumA) {
+        const enumB = await this._schemaB.lookupItem(enumA.key);
+        this._schemaComparer.compareEnumerations(enumA, enumB);
+    }
+    /**
+     * Called for each [[KindOfQuantity]] instance found during schema traversal.
+     * @param koq a KindOfQuantity object.
+     */
+    async visitKindOfQuantity(koqA) {
+        const koqB = await this._schemaB.lookupItem(koqA.key);
+        this._schemaComparer.compareKindOfQuantities(koqA, koqB);
+    }
+    /**
+     * Called for each [[PropertyCategory]] instance found during schema traversal.
+     * @param category a PropertyCategory object.
+     */
+    async visitPropertyCategory(categoryA) {
+        const categoryB = await this._schemaB.lookupItem(categoryA.key);
+        this._schemaComparer.comparePropertyCategories(categoryA, categoryB);
+    }
+    /**
+     * Called for each [[Format]] instance found during schema traversal.
+     * @param format a Format object.
+     */
+    async visitFormat(formatA) {
+        const formatB = await this._schemaB.lookupItem(formatA.key);
+        this._schemaComparer.compareFormats(formatA, formatB);
+    }
+    /**
+     * Called for each [[Unit]] instance found during schema traversal.
+     * @param unit a Unit object.
+     */
+    async visitUnit(unitA) {
+        const unitB = await this._schemaB.lookupItem(unitA.key);
+        this._schemaComparer.compareUnits(unitA, unitB);
+    }
+    /**
+     * Called for each [[InvertedUnit]] instance found during schema traversal.
+     * @param invertedUnit an InvertedUnit object.
+     */
+    async visitInvertedUnit(invertedUnitA) {
+        const invertedUnitB = await this._schemaB.lookupItem(invertedUnitA.key);
+        this._schemaComparer.compareInvertedUnits(invertedUnitA, invertedUnitB);
+    }
+    /**
+     * Called for each [[UnitSystem]] instance found during schema traversal.
+     * @param unitSystem a UnitSystem object.
+     */
+    async visitUnitSystem(_unitSystemA) {
+        // No comparison to make specifically on unitSystem
+    }
+    /**
+     * Called for each [[Phenomenon]] instance found during schema traversal.
+     * @param phenomena a Phenomenon object.
+     */
+    async visitPhenomenon(phenomenonA) {
+        const phenomenonB = await this._schemaB.lookupItem(phenomenonA.key);
+        this._schemaComparer.comparePhenomenons(phenomenonA, phenomenonB);
+    }
+    /**
+     * Called for each [[Constant]] instance found during schema traversal.
+     * @param constant a Constant object.
+     */
+    async visitConstant(constantA) {
+        const constantB = await this._schemaB.lookupItem(constantA.key);
+        this._schemaComparer.compareConstants(constantA, constantB);
+    }
+}
+exports.SchemaCompareVisitor = SchemaCompareVisitor;
+//# sourceMappingURL=SchemaCompareVisitor.js.map

package/lib/Validation/SchemaCompareVisitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaCompareVisitor.js","sourceRoot":"","sources":["../../src/Validation/SchemaCompareVisitor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAIkC;AAGlC;;;GAGG;AACH,MAAa,oBAAoB;IAI/B;;;;OAIG;IACH,YAAY,cAA+B,EAAE,eAAuB;QAClE,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,eAAe,CAAC,OAAe;QAC1C,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,eAAe,CAAC,WAAuB;QAClD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACpE,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU,CAAC,MAAgB;QACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAW,MAAM,CAAC,GAAG,CAAC,CAAC;QACpE,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa,CAAC,SAAsB;QAC/C,IAAI,SAAkC,CAAC;QAEvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAU,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5E,IAAI,MAAM;YACR,SAAS,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAgB,CAAC;QAEtE,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAAoB;QAChD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAc,OAAO,CAAC,GAAG,CAAC,CAAC;QACzE,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,QAAqB;QACjD,sDAAsD;IACxD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU,CAAC,MAAa;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAQ,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,sBAAsB,CAAC,aAAgC;QAClE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAoB,aAAa,CAAC,GAAG,CAAC,CAAC;QAC3F,IAAI,CAAC,eAAe,CAAC,0BAA0B,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,2BAA2B,CAAC,WAAmC;QAC1E,IAAI,WAA+C,CAAC;QACpD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAoB,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC3G,IAAI,aAAa;YACf,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC;QACnF,IAAI,CAAC,eAAe,CAAC,8BAA8B,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,gBAAsC;QAC3E,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAuB,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACpG,IAAI,CAAC,eAAe,CAAC,6BAA6B,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;IACzF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,6BAA6B,CAAC,UAAyC;QAClF,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACvE,IAAI,UAAqD,CAAC;QAE1D,IAAI,0BAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YAC/B,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC;SAC5B;aAAM,IAAI,2BAAO,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;YACxC,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;SACxD;aAAM,IAAI,4BAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAU,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC7E,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;SACvE;aAAM,IAAI,0CAAsB,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE;YACtE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAoB,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACnG,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;SACvE;QAED,IAAI,CAAC,eAAe,CAAC,gCAAgC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,KAAkB;QAC9C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAc,KAAK,CAAC,GAAG,CAAC,CAAC;QACrE,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mBAAmB,CAAC,IAAoB;QACnD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,SAA2B;QAC5D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAmB,SAAS,CAAC,GAAG,CAAC,CAAC;QAClF,IAAI,CAAC,eAAe,CAAC,yBAAyB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,OAAe;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAS,OAAO,CAAC,GAAG,CAAC,CAAC;QACpE,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,KAAW;QAChC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAO,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,aAA2B;QACxD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAe,aAAa,CAAC,GAAG,CAAC,CAAC;QACtF,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,eAAe,CAAC,YAAwB;QACnD,mDAAmD;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,eAAe,CAAC,WAAuB;QAClD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAa,WAAW,CAAC,GAAG,CAAC,CAAC;QAChF,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa,CAAC,SAAmB;QAC5C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAW,SAAS,CAAC,GAAG,CAAC,CAAC;QAC1E,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC9D,CAAC;CACF;AArND,oDAqNC","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 Comparison\n */\n\nimport { AnyClass, AnyProperty, Constant, CustomAttributeClass, CustomAttributeContainerProps,\n  ECClass, EntityClass, Enumeration, Format, InvertedUnit, ISchemaPartVisitor, KindOfQuantity, Mixin,\n  Phenomenon, Property, PropertyCategory, RelationshipClass, RelationshipConstraint, Schema, SchemaItem,\n  StructClass, Unit, UnitSystem,\n} from \"@itwin/ecschema-metadata\";\nimport { ISchemaComparer } from \"./SchemaComparer\";\n\n/**\n * An ISchemaPartVisitor interface implementation that is used to compare to Schemas.\n * @internal\n */\nexport class SchemaCompareVisitor implements ISchemaPartVisitor {\n  private _schemaB: Schema;\n  private _schemaComparer: ISchemaComparer;\n\n  /**\n   * Initializes a new SchemaCompareVisitor instance.\n   * @param schemaComparer The [[SchemaComparer]] to use to compare each item of the schema.\n   * @param schemaToCompare The second or 'B' schema to compare against the schema being traversed (Schema A).\n   */\n  constructor(schemaComparer: ISchemaComparer, schemaToCompare: Schema) {\n    this._schemaComparer = schemaComparer;\n    this._schemaB = schemaToCompare;\n  }\n\n  /**\n   * Called before schema traversal.\n   * @param schema a Schema object.\n   */\n  public async visitFullSchema(schemaA: Schema) {\n    this._schemaComparer.compareSchemaProps(schemaA, this._schemaB);\n  }\n\n  /**\n   * Called for each [[SchemaItem]] instance found during schema traversal.\n   * @param schemaItem a SchemaItem object.\n   */\n  public async visitSchemaItem(schemaItemA: SchemaItem) {\n    const schemaItemB = await this._schemaB.lookupItem(schemaItemA.key);\n    this._schemaComparer.compareSchemaItems(schemaItemA, schemaItemB);\n  }\n\n  /**\n   * Called for each [[AnyClass]] instance found during schema traversal.\n   * @param ecClass an ECClass object.\n   */\n  public async visitClass(classA: AnyClass): Promise<void> {\n    const classB = await this._schemaB.lookupItem<AnyClass>(classA.key);\n    this._schemaComparer.compareClasses(classA, classB);\n  }\n\n  /**\n   * Called for each [[AnyProperty]] instance of an ECClass.\n   * @param property an AnyProperty object.\n   */\n  public async visitProperty(propertyA: AnyProperty): Promise<void> {\n    let propertyB: AnyProperty | undefined;\n\n    const classB = await this._schemaB.lookupItem<ECClass>(propertyA.class.key);\n    if (classB)\n      propertyB = await classB.getProperty(propertyA.name) as AnyProperty;\n\n    this._schemaComparer.compareProperties(propertyA, propertyB);\n  }\n\n  /**\n   * Called for each [[EntityClass]] instance found during schema traversal.\n   * @param entityClass an EntityClass object.\n   */\n  public async visitEntityClass(entityA: EntityClass): Promise<void> {\n    const entityB = await this._schemaB.lookupItem<EntityClass>(entityA.key);\n    this._schemaComparer.compareEntityClasses(entityA, entityB);\n  }\n\n  /**\n   * Called for each [[StructClass]] instance found during schema traversal.\n   * @param structClass a StructClass object.\n   */\n  public async visitStructClass(_structA: StructClass): Promise<void> {\n    // No comparison to make specifically on StructClasses\n  }\n\n  /**\n   * Called for each [[Mixin]] instance found during schema traversal.\n   * @param mixin a Mixin object.\n   */\n  public async visitMixin(mixinA: Mixin): Promise<void> {\n    const mixinB = await this._schemaB.lookupItem<Mixin>(mixinA.key);\n    this._schemaComparer.compareMixins(mixinA, mixinB);\n  }\n\n  /**\n   * Called for each [[RelationshipClass]] instance found during schema traversal.\n   * @param relationshipClass a RelationshipClass object.\n   */\n  public async visitRelationshipClass(relationshipA: RelationshipClass): Promise<void> {\n    const relationshipB = await this._schemaB.lookupItem<RelationshipClass>(relationshipA.key);\n    this._schemaComparer.compareRelationshipClasses(relationshipA, relationshipB);\n  }\n\n  /**\n   * Called for each [[RelationshipConstraint]] of each RelationshipClass found during schema traversal.\n   * @param relationshipConstraint a RelationshipConstraint object.\n   */\n  public async visitRelationshipConstraint(constraintA: RelationshipConstraint): Promise<void> {\n    let constraintB: RelationshipConstraint | undefined;\n    const relationshipB = await this._schemaB.lookupItem<RelationshipClass>(constraintA.relationshipClass.key);\n    if (relationshipB)\n      constraintB = constraintA.isSource ? relationshipB.source : relationshipB.target;\n    this._schemaComparer.compareRelationshipConstraints(constraintA, constraintB);\n  }\n\n  /**\n   * Called for each [[CustomAttributeClass]] instance found during schema traversal.\n   * @param customAttributeClass a CustomAttributeClass object.\n   */\n  public async visitCustomAttributeClass(customAttributeA: CustomAttributeClass): Promise<void> {\n    const customAttributeB = await this._schemaB.lookupItem<CustomAttributeClass>(customAttributeA.key);\n    this._schemaComparer.compareCustomAttributeClasses(customAttributeA, customAttributeB);\n  }\n\n  /**\n   * Called for each [[CustomAttribute]] container in the schema.\n   * @param customAttributeContainer a [[CustomAttributeContainerProps]] object.\n   */\n  public async visitCustomAttributeContainer(containerA: CustomAttributeContainerProps): Promise<void> {\n    const nameParts = containerA.fullName.split(\".\");\n    const shortName = nameParts.length === 1 ? nameParts[0] : nameParts[1];\n    let containerB: CustomAttributeContainerProps | undefined;\n\n    if (Schema.isSchema(containerA)) {\n      containerB = this._schemaB;\n    } else if (ECClass.isECClass(containerA)) {\n      containerB = await this._schemaB.lookupItem(shortName);\n    } else if (Property.isProperty(containerA)) {\n      const parent = await this._schemaB.lookupItem<ECClass>(containerA.class.key);\n      containerB = parent ? await parent.getProperty(shortName) : undefined;\n    } else if (RelationshipConstraint.isRelationshipConstraint(containerA)) {\n      const parent = await this._schemaB.lookupItem<RelationshipClass>(containerA.relationshipClass.key);\n      containerB = parent ? await parent.getProperty(shortName) : undefined;\n    }\n\n    this._schemaComparer.compareCustomAttributeContainers(containerA, containerB);\n  }\n\n  /**\n   * Called for each [[Enumeration]] instance found during schema traversal.\n   * @param enumeration an Enumeration object.\n   */\n  public async visitEnumeration(enumA: Enumeration) {\n    const enumB = await this._schemaB.lookupItem<Enumeration>(enumA.key);\n    this._schemaComparer.compareEnumerations(enumA, enumB);\n  }\n\n  /**\n   * Called for each [[KindOfQuantity]] instance found during schema traversal.\n   * @param koq a KindOfQuantity object.\n   */\n  public async visitKindOfQuantity(koqA: KindOfQuantity) {\n    const koqB = await this._schemaB.lookupItem<KindOfQuantity>(koqA.key);\n    this._schemaComparer.compareKindOfQuantities(koqA, koqB);\n  }\n\n  /**\n   * Called for each [[PropertyCategory]] instance found during schema traversal.\n   * @param category a PropertyCategory object.\n   */\n  public async visitPropertyCategory(categoryA: PropertyCategory) {\n    const categoryB = await this._schemaB.lookupItem<PropertyCategory>(categoryA.key);\n    this._schemaComparer.comparePropertyCategories(categoryA, categoryB);\n  }\n\n  /**\n   * Called for each [[Format]] instance found during schema traversal.\n   * @param format a Format object.\n   */\n  public async visitFormat(formatA: Format): Promise<void> {\n    const formatB = await this._schemaB.lookupItem<Format>(formatA.key);\n    this._schemaComparer.compareFormats(formatA, formatB);\n  }\n\n  /**\n   * Called for each [[Unit]] instance found during schema traversal.\n   * @param unit a Unit object.\n   */\n  public async visitUnit(unitA: Unit): Promise<void> {\n    const unitB = await this._schemaB.lookupItem<Unit>(unitA.key);\n    this._schemaComparer.compareUnits(unitA, unitB);\n  }\n\n  /**\n   * Called for each [[InvertedUnit]] instance found during schema traversal.\n   * @param invertedUnit an InvertedUnit object.\n   */\n  public async visitInvertedUnit(invertedUnitA: InvertedUnit): Promise<void> {\n    const invertedUnitB = await this._schemaB.lookupItem<InvertedUnit>(invertedUnitA.key);\n    this._schemaComparer.compareInvertedUnits(invertedUnitA, invertedUnitB);\n  }\n\n  /**\n   * Called for each [[UnitSystem]] instance found during schema traversal.\n   * @param unitSystem a UnitSystem object.\n   */\n  public async visitUnitSystem(_unitSystemA: UnitSystem): Promise<void> {\n    // No comparison to make specifically on unitSystem\n  }\n\n  /**\n   * Called for each [[Phenomenon]] instance found during schema traversal.\n   * @param phenomena a Phenomenon object.\n   */\n  public async visitPhenomenon(phenomenonA: Phenomenon): Promise<void> {\n    const phenomenonB = await this._schemaB.lookupItem<Phenomenon>(phenomenonA.key);\n    this._schemaComparer.comparePhenomenons(phenomenonA, phenomenonB);\n  }\n\n  /**\n   * Called for each [[Constant]] instance found during schema traversal.\n   * @param constant a Constant object.\n   */\n  public async visitConstant(constantA: Constant): Promise<void> {\n    const constantB = await this._schemaB.lookupItem<Constant>(constantA.key);\n    this._schemaComparer.compareConstants(constantA, constantB);\n  }\n}\n"]}

package/lib/Validation/SchemaComparer.d.ts

@@ -0,0 +1,172 @@
+/** @packageDocumentation
+ * @module Comparison
+ */
+import { AnyClass, AnyProperty, Constant, CustomAttributeClass, CustomAttributeContainerProps, EntityClass, Enumeration, Format, InvertedUnit, KindOfQuantity, Mixin, Phenomenon, PropertyCategory, RelationshipClass, RelationshipConstraint, Schema, SchemaItem, Unit } from "@itwin/ecschema-metadata";
+import { ISchemaCompareReporter } from "./SchemaCompareReporter";
+/**
+ * Enum that identifies if Schema A is being iterated (Forward) or
+ * Schema B is being iterated (Backward);
+ * @alpha
+ */
+export declare enum SchemaCompareDirection {
+    Forward = 0,
+    Backward = 1
+}
+/**
+ * Interface for comparing EC Schemas.
+ * @alpha
+ */
+export interface ISchemaComparer {
+    compareSchemas(schemaA: Schema, schemaB: Schema): void;
+    compareSchemaProps(schemaA: Schema, schemaB: Schema): void;
+    compareSchemaItems(schemaItemA: SchemaItem, schemaItemB: SchemaItem | undefined): void;
+    compareClasses(classA: AnyClass, classB: AnyClass | undefined): void;
+    compareProperties(propertyA: AnyProperty, propertyB: AnyProperty | undefined): void;
+    compareEntityClasses(entityA: EntityClass, entityB: EntityClass | undefined): void;
+    compareMixins(mixinA: Mixin, mixinB: Mixin | undefined): void;
+    compareRelationshipClasses(relationshipClassA: RelationshipClass, relationshipClassB: RelationshipClass | undefined): void;
+    compareRelationshipConstraints(relationshipConstraintA: RelationshipConstraint, relationshipConstraintB: RelationshipConstraint | undefined): void;
+    compareCustomAttributeClasses(customAttributeClassA: CustomAttributeClass, customAttributeClassB: CustomAttributeClass | undefined): void;
+    compareCustomAttributeContainers(containerA: CustomAttributeContainerProps, containerB: CustomAttributeContainerProps | undefined): void;
+    compareEnumerations(enumA: Enumeration, enumB: Enumeration | undefined): void;
+    compareKindOfQuantities(koqA: KindOfQuantity, koqB: KindOfQuantity | undefined): void;
+    comparePropertyCategories(categoryA: PropertyCategory, categoryB: PropertyCategory | undefined): void;
+    compareFormats(formatA: Format, formatB: Format | undefined): void;
+    compareUnits(unitA: Unit, unitB: Unit | undefined): void;
+    compareInvertedUnits(invertedUnitA: InvertedUnit, invertedUnitB: InvertedUnit | undefined): void;
+    comparePhenomenons(phenomenonA: Phenomenon, phenomenonB: Phenomenon | undefined): void;
+    compareConstants(constantA: Constant, constantB: Constant | undefined): void;
+}
+/**
+ * Compares EC Schemas and reports differences using the [[IDiagnosticReporter]] objects
+ * specified.
+ * @alpha
+ */
+export declare class SchemaComparer {
+    private _compareDirection;
+    private _reporter;
+    private _reporters;
+    /**
+     * Initializes a new SchemaComparer instance.
+     * @param reporters The [[IDiagnosticReporter]] object(s) to use to report the results.
+     */
+    constructor(...reporters: ISchemaCompareReporter[]);
+    /**
+     * Compares two schemas to identify differences.
+     * @param schemaA The first Schema.
+     * @param schemaB The second Schema.
+     */
+    compareSchemas(schemaA: Schema, schemaB: Schema): Promise<void>;
+    /**
+     * Compares two schemas to identify differences between property values.
+     * @param schemaA The first Schema.
+     * @param schemaB The second Schema.
+     */
+    compareSchemaProps(schemaA: Schema, schemaB: Schema): Promise<void>;
+    /**
+     * Compares two SchemaItems to identify differences between property values.
+     * @param schemaItemA The first SchemaItem.
+     * @param schemaItemB The second SchemaItem.
+     */
+    compareSchemaItems(schemaItemA: SchemaItem, schemaItemB: SchemaItem | undefined): Promise<void>;
+    /**
+     * Compares two ECClasses to identify differences between property values.
+     * @param classA The first ECClass.
+     * @param classB The second ECClass.
+     */
+    compareClasses(classA: AnyClass, classB: AnyClass | undefined): Promise<void>;
+    /**
+     * Compares two ECProperties to identify differences between property values.
+     * @param propertyA The first ECProperty.
+     * @param propertyB The second ECProperty.
+     */
+    compareProperties(propertyA: AnyProperty, propertyB: AnyProperty | undefined): Promise<void>;
+    /**
+     * Compares two EntityClass objects to identify differences between property values.
+     * @param entityA
+     * @param entityB
+     */
+    compareEntityClasses(entityA: EntityClass, entityB: EntityClass | undefined): Promise<void>;
+    /**
+     * Compares two Mixin objects to identify differences between property values.
+     * @param mixinA
+     * @param mixinB
+     */
+    compareMixins(mixinA: Mixin, mixinB: Mixin | undefined): Promise<void>;
+    /**
+     * Compares two RelationshipClass objects to identify differences between property values.
+     * @param relationshipA
+     * @param relationshipB
+     */
+    compareRelationshipClasses(relationshipA: RelationshipClass, relationshipB: RelationshipClass | undefined): Promise<void>;
+    /**
+     * Compares two RelationshipConstraint objects to identify differences between property values.
+     * @param relationshipConstraintA
+     * @param relationshipConstraintB
+     */
+    compareRelationshipConstraints(constraintA: RelationshipConstraint, constraintB: RelationshipConstraint | undefined): Promise<void>;
+    /**
+     * Compares two CustomAttributeClass objects to identify differences between property values.
+     * @param customAttributeClassA
+     * @param customAttributeClassB
+     */
+    compareCustomAttributeClasses(customAttributeClassA: CustomAttributeClass, customAttributeClassB: CustomAttributeClass | undefined): Promise<void>;
+    /**
+     * Compares two CustomAttributeContainerProps objects to identify differences between property values.
+     * @param containerA
+     * @param containerB
+     */
+    compareCustomAttributeContainers(containerA: CustomAttributeContainerProps, containerB: CustomAttributeContainerProps | undefined): Promise<void>;
+    /**
+     * Compares two Enumeration objects to identify differences between property values.
+     * @param enumA
+     * @param enumB
+     */
+    compareEnumerations(enumA: Enumeration, enumB: Enumeration | undefined): Promise<void>;
+    /**
+     * Compares two KindOfQuantity objects to identify differences between property values.
+     * @param koqA
+     * @param koqB
+     */
+    compareKindOfQuantities(koqA: KindOfQuantity, koqB: KindOfQuantity | undefined): Promise<void>;
+    /**
+     * Compares two PropertyCategory objects to identify differences between property values.
+     * @param categoryA
+     * @param categoryB
+     */
+    comparePropertyCategories(categoryA: PropertyCategory, categoryB: PropertyCategory | undefined): Promise<void>;
+    /**
+     * Compares two Format objects to identify differences between property values.
+     * @param formatA
+     * @param formatB
+     */
+    compareFormats(formatA: Format, formatB: Format | undefined): Promise<void>;
+    /**
+     * Compares two Unit objects to identify differences between property values.
+     * @param unitA
+     * @param unitB
+     */
+    compareUnits(unitA: Unit, unitB: Unit | undefined): Promise<void>;
+    /**
+     * Compares two InvertedUnit objects to identify differences between property values.
+     * @param invertedUnitA
+     * @param invertedUnitB
+     */
+    compareInvertedUnits(invertedUnitA: InvertedUnit, invertedUnitB: InvertedUnit | undefined): Promise<void>;
+    /**
+     * Compares two Phenomenon objects to identify differences between property values.
+     * @param phenomenonA
+     * @param phenomenonB
+     */
+    comparePhenomenons(phenomenonA: Phenomenon, phenomenonB: Phenomenon | undefined): Promise<void>;
+    /**
+     * Compares two Constant objects to identify differences between property values.
+     * @param constantA
+     * @param constantB
+     */
+    compareConstants(constantA: Constant, constantB: Constant | undefined): Promise<void>;
+    private comparePropertyType;
+    private compareEnumerators;
+    private compareFormatUnits;
+}
+//# sourceMappingURL=SchemaComparer.d.ts.map

package/lib/Validation/SchemaComparer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaComparer.d.ts","sourceRoot":"","sources":["../../src/Validation/SchemaComparer.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,QAAQ,EAAiB,WAAW,EAAyB,QAAQ,EAC9C,oBAAoB,EAAE,6BAA6B,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EACxF,YAAY,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAyB,gBAAgB,EAAwB,iBAAiB,EACrJ,sBAAsB,EAAE,MAAM,EAAE,UAAU,EACR,IAAI,EACvC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAKjE;;;;GAIG;AACH,oBAAY,sBAAsB;IAChC,OAAO,IAAI;IACX,QAAQ,IAAI;CACb;AACD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvD,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3D,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,CAAC;IACvF,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;IACrE,iBAAiB,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI,CAAC;IACpF,oBAAoB,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI,CAAC;IACnF,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;IAC9D,0BAA0B,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,GAAG,SAAS,GAAG,IAAI,CAAC;IAC3H,8BAA8B,CAAC,uBAAuB,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,sBAAsB,GAAG,SAAS,GAAG,IAAI,CAAC;IACnJ,6BAA6B,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,oBAAoB,GAAG,SAAS,GAAG,IAAI,CAAC;IAC1I,gCAAgC,CAAC,UAAU,EAAE,6BAA6B,EAAE,UAAU,EAAE,6BAA6B,GAAG,SAAS,GAAG,IAAI,CAAC;IACzI,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI,CAAC;IAC9E,uBAAuB,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI,CAAC;IACtF,yBAAyB,CAAC,SAAS,EAAE,gBAAgB,EAAE,SAAS,EAAE,gBAAgB,GAAG,SAAS,GAAG,IAAI,CAAC;IACtG,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IACnE,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC;IACzD,oBAAoB,CAAC,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI,CAAC;IACjG,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,CAAC;IACvF,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAC;CAC9E;AAQD;;;;GAIG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,SAAS,CAA+B;IAChD,OAAO,CAAC,UAAU,CAA2B;IAE7C;;;OAGG;gBACS,GAAG,SAAS,EAAE,sBAAsB,EAAE;IAKlD;;;;OAIG;IACU,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAgB5D;;;;OAIG;IACU,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BhF;;;;OAIG;IACU,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA6B5G;;;;OAIG;IACU,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B1F;;;;OAIG;IACU,iBAAiB,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmEzG;;;;OAIG;IACU,oBAAoB,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAUxG;;;;OAIG;IACU,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAYnF;;;;OAIG;IACU,0BAA0B,CAAC,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,iBAAiB,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBtI;;;;OAIG;IACU,8BAA8B,CAAC,WAAW,EAAE,sBAAsB,EAAE,WAAW,EAAE,sBAAsB,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA2ChJ;;;;OAIG;IACU,6BAA6B,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,oBAAoB,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAY/J;;;;OAIG;IACU,gCAAgC,CAAC,UAAU,EAAE,6BAA6B,EAAE,UAAU,EAAE,6BAA6B,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAa9J;;;;OAIG;IACU,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAgCnG;;;;OAIG;IACU,uBAAuB,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC3G;;;;OAIG;IACU,yBAAyB,CAAC,SAAS,EAAE,gBAAgB,EAAE,SAAS,EAAE,gBAAgB,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAS3H;;;;OAIG;IACU,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiFxF;;;;OAIG;IACU,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAyC9E;;;;OAIG;IACU,oBAAoB,CAAC,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBtH;;;;OAIG;IACU,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAS5G;;;;OAIG;IACU,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;YA6BpF,mBAAmB;YAuEnB,kBAAkB;YAuBlB,kBAAkB;CAyBjC"}