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

package/lib/esm/Differencing/SchemaDifference.d.ts

@@ -0,0 +1,357 @@
+/** @packageDocumentation
+ * @module Differencing
+ */
+import { AnySchemaDifferenceConflict } from "./SchemaConflicts";
+import { AnySchemaEdits } from "../Merging/Edits/SchemaEdits";
+import { AnyEnumerator, AnyPropertyProps, ConstantProps, CustomAttribute, CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps, MixinProps, PhenomenonProps, PropertyCategoryProps, RelationshipClassProps, RelationshipConstraintProps, type Schema, SchemaItemFormatProps, SchemaItemProps, SchemaItemType, SchemaItemUnitProps, SchemaReferenceProps, StructClassProps, UnitSystemProps } from "@itwin/ecschema-metadata";
+/** Utility-Type to remove possible readonly flags on the given type. */
+type PartialEditable<T> = {
+    -readonly [P in keyof T]?: T[P];
+};
+/**
+ * Utility-Type to simplify the expected SchemaItem props by omitting the base properties
+ * that are not needed for the schema differencing. Also all properties are made mutable
+ * by removing the readonly flag if present.
+ */
+type SchemaItemProperties<T extends SchemaItemProps> = {
+    [P in keyof PartialEditable<Omit<T, keyof Omit<SchemaItemProps, "label" | "description" | "customAttributes">>>]: T[P];
+};
+/**
+ * Defines the type of the difference operation.
+ * @alpha
+ */
+export type DifferenceType = "add" | "modify";
+/**
+ * Defines the SchemaTypes that are not SchemaItems.
+ * @alpha
+ */
+export declare enum SchemaOtherTypes {
+    Schema = "Schema",
+    SchemaReference = "SchemaReference",
+    Property = "Property",
+    Enumerator = "Enumerator",
+    CustomAttributeInstance = "CustomAttributeInstance",
+    RelationshipConstraint = "RelationshipConstraint",
+    RelationshipConstraintClass = "RelationshipConstraintClass",
+    EntityClassMixin = "EntityClassMixin",
+    KindOfQuantityPresentationFormat = "KindOfQuantityPresentationFormat",
+    FormatUnit = "FormatUnit",
+    FormatUnitLabel = "FormatUnitLabel"
+}
+/**
+ * Defines the possible values SchemaTypes that can occur in SchemaDifferences or Conflicts.
+ * @alpha
+ */
+export type SchemaType = SchemaOtherTypes | SchemaItemType;
+/**
+ * Definition of the difference result between two Schemas.
+ * @alpha
+ */
+export interface SchemaDifferenceResult {
+    /** Full name of the source schema */
+    readonly sourceSchemaName: string;
+    /** Full name of the target schema */
+    readonly targetSchemaName: string;
+    /** List of differences between the compared schemas. */
+    readonly differences: AnySchemaDifference[];
+    /** List of conflicts found while comparing the schemas. */
+    readonly conflicts?: AnySchemaDifferenceConflict[];
+}
+/**
+ * Union of all supported schema differencing types.
+ * @alpha
+ */
+export type AnySchemaDifference = SchemaDifference | SchemaReferenceDifference | AnySchemaItemDifference | AnySchemaItemPathDifference | EntityClassMixinDifference | CustomAttributeDifference | KindOfQuantityPresentationFormatDifference | FormatUnitDifference;
+/**
+ * Differencing entry for changes on a Schema.
+ * @alpha
+ */
+export interface SchemaDifference {
+    readonly changeType: "modify";
+    readonly schemaType: SchemaOtherTypes.Schema;
+    readonly difference: {
+        label?: string;
+        description?: string;
+    };
+}
+/**
+ * Differencing entry for added or changed Schema References of a Schema.
+ * @alpha
+ */
+export interface SchemaReferenceDifference {
+    readonly changeType: "add" | "modify";
+    readonly schemaType: SchemaOtherTypes.SchemaReference;
+    readonly difference: SchemaReferenceProps;
+}
+/**
+ * Union of all supported schema item differencing types.
+ * @alpha
+ */
+export type AnySchemaItemDifference = AnyClassItemDifference | ConstantDifference | EnumerationDifference | FormatDifference | KindOfQuantityDifference | InvertedUnitDifference | PhenomenonDifference | PropertyCategoryDifference | UnitDifference | UnitSystemDifference;
+/**
+ * Union for supported class Schema Items.
+ * @alpha
+ */
+export type AnyClassItemDifference = EntityClassDifference | MixinClassDifference | StructClassDifference | CustomAttributeClassDifference | RelationshipClassDifference;
+/**
+ * Union of all differences that have a path pointing inside a schema item.
+ * @alpha
+ */
+export type AnySchemaItemPathDifference = RelationshipConstraintDifference | RelationshipConstraintClassDifference | CustomAttributePropertyDifference | EnumeratorDifference | ClassPropertyDifference | FormatUnitLabelDifference;
+/**
+ * Internal base class for all Schema Item differencing entries.
+ * @alpha
+ */
+interface SchemaItemDifference<T extends SchemaItemProps> {
+    readonly changeType: "add" | "modify";
+    readonly itemName: string;
+    readonly difference: SchemaItemProperties<T>;
+}
+/**
+ * Differencing entry for Constant Schema Items.
+ * @alpha
+ */
+export interface ConstantDifference extends SchemaItemDifference<ConstantProps> {
+    readonly schemaType: SchemaItemType.Constant;
+}
+/**
+ * Differencing entry for Custom Attribute Class Schema Items.
+ * @alpha
+ */
+export interface CustomAttributeClassDifference extends SchemaItemDifference<CustomAttributeClassProps> {
+    readonly schemaType: SchemaItemType.CustomAttributeClass;
+}
+/**
+ * Differencing entry for Entity Class Schema Items.
+ * @alpha
+ */
+export interface EntityClassDifference extends SchemaItemDifference<EntityClassProps> {
+    readonly schemaType: SchemaItemType.EntityClass;
+}
+/**
+ * Differencing entry for Enumerator Schema Items.
+ * @alpha
+ */
+export interface EnumerationDifference extends SchemaItemDifference<EnumerationProps> {
+    readonly schemaType: SchemaItemType.Enumeration;
+}
+/**
+ * Differencing entry for Kind-Of-Quantities Schema Items.
+ * @alpha
+ */
+export interface KindOfQuantityDifference extends SchemaItemDifference<KindOfQuantityProps> {
+    readonly schemaType: SchemaItemType.KindOfQuantity;
+}
+/**
+ * Differencing entry for Mixin Class Schema Items.
+ * @alpha
+ */
+export interface MixinClassDifference extends SchemaItemDifference<MixinProps> {
+    readonly schemaType: SchemaItemType.Mixin;
+}
+/**
+ * Differencing entry for Phenomenon Schema Items.
+ * @alpha
+ */
+export interface PhenomenonDifference extends SchemaItemDifference<PhenomenonProps> {
+    readonly schemaType: SchemaItemType.Phenomenon;
+}
+/**
+ * Differencing entry for Property Category Schema Items.
+ * @alpha
+ */
+export interface PropertyCategoryDifference extends SchemaItemDifference<PropertyCategoryProps> {
+    readonly schemaType: SchemaItemType.PropertyCategory;
+}
+/**
+ * Differencing entry for Relationship Class Schema Items.
+ * @alpha
+ */
+export interface RelationshipClassDifference extends SchemaItemDifference<RelationshipClassProps> {
+    readonly schemaType: SchemaItemType.RelationshipClass;
+}
+/**
+ * Differencing entry for Struct Class Schema Items.
+ * @alpha
+ */
+export interface StructClassDifference extends SchemaItemDifference<StructClassProps> {
+    readonly schemaType: SchemaItemType.StructClass;
+}
+/**
+ * Differencing entry for Unit System Schema Items.
+ * @alpha
+ */
+export interface UnitSystemDifference extends SchemaItemDifference<UnitSystemProps> {
+    readonly schemaType: SchemaItemType.UnitSystem;
+}
+/**
+ * Differencing entry for Unit Schema Items.
+ * @alpha
+ */
+export interface UnitDifference extends SchemaItemDifference<SchemaItemUnitProps> {
+    readonly schemaType: SchemaItemType.Unit;
+}
+/**
+ * Differencing entry for Inverted Unit Schema Items.
+ * @alpha
+ */
+export interface InvertedUnitDifference extends SchemaItemDifference<InvertedUnitProps> {
+    readonly schemaType: SchemaItemType.InvertedUnit;
+}
+/**
+ * Differencing entry for Format Schema Items.
+ * @alpha
+ */
+export interface FormatDifference extends SchemaItemDifference<SchemaItemFormatProps> {
+    readonly schemaType: SchemaItemType.Format;
+}
+/**
+ * Differencing entry for added or changed Properties.
+ * @alpha
+ */
+export interface ClassPropertyDifference {
+    readonly changeType: "add" | "modify";
+    readonly schemaType: SchemaOtherTypes.Property;
+    readonly itemName: string;
+    readonly path: string;
+    readonly difference: PartialEditable<AnyPropertyProps>;
+}
+/**
+ * Union of supported Custom Attribute Differences.
+ * @alpha
+ */
+export type CustomAttributeDifference = CustomAttributeSchemaDifference | CustomAttributeSchemaItemDifference | CustomAttributePropertyDifference | CustomAttributeRelationshipConstraintDifference;
+/**
+ * Differencing entry for Custom Attributes on Schema.
+ * @alpha
+ */
+export interface CustomAttributeSchemaDifference {
+    readonly changeType: "add";
+    readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;
+    readonly appliedTo: "Schema";
+    readonly difference: PartialEditable<CustomAttribute>;
+}
+/**
+ * Differencing entry for Custom Attributes on Schema Items.
+ * @alpha
+ */
+export interface CustomAttributeSchemaItemDifference {
+    readonly changeType: "add";
+    readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;
+    readonly appliedTo: "SchemaItem";
+    readonly itemName: string;
+    readonly difference: PartialEditable<CustomAttribute>;
+}
+/**
+ * Differencing entry for Custom Attributes on Properties.
+ * @alpha
+ */
+export interface CustomAttributePropertyDifference {
+    readonly changeType: "add";
+    readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;
+    readonly appliedTo: "Property";
+    readonly itemName: string;
+    readonly path: string;
+    readonly difference: PartialEditable<CustomAttribute>;
+}
+/**
+ * Differencing entry for Custom Attributes on Relationship Constraints.
+ * @alpha
+ */
+export interface CustomAttributeRelationshipConstraintDifference {
+    readonly changeType: "add";
+    readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;
+    readonly appliedTo: "RelationshipConstraint";
+    readonly itemName: string;
+    readonly path: "$source" | "$target";
+    readonly difference: PartialEditable<CustomAttribute>;
+}
+/**
+ * Differencing entry for changed mixins on EntityClasses.
+ * @alpha
+ */
+export interface EntityClassMixinDifference {
+    readonly changeType: "add";
+    readonly schemaType: SchemaOtherTypes.EntityClassMixin;
+    readonly itemName: string;
+    readonly difference: string[];
+}
+/**
+ * Differencing entry for changed Enumerators on Enumerable Schema Items.
+ * @alpha
+ */
+export interface EnumeratorDifference {
+    readonly changeType: "add" | "modify";
+    readonly schemaType: SchemaOtherTypes.Enumerator;
+    readonly itemName: string;
+    readonly path: string;
+    readonly difference: PartialEditable<AnyEnumerator>;
+}
+/**
+ * Differencing entry for Relationship Constraints.
+ * @alpha
+ */
+export interface RelationshipConstraintDifference {
+    readonly changeType: "modify";
+    readonly schemaType: SchemaOtherTypes.RelationshipConstraint;
+    readonly itemName: string;
+    readonly path: "$source" | "$target";
+    readonly difference: PartialEditable<Omit<RelationshipConstraintProps, "constraintClasses">>;
+}
+/**
+ * Differencing entry for constraint classes added to Relationship Constrains.
+ * @alpha
+ */
+export interface RelationshipConstraintClassDifference {
+    readonly changeType: "add";
+    readonly schemaType: SchemaOtherTypes.RelationshipConstraintClass;
+    readonly itemName: string;
+    readonly path: "$source" | "$target";
+    readonly difference: string[];
+}
+/**
+ * Differencing entry for presentation formats added to KindOfQuantities.
+ * @alpha
+ */
+export interface KindOfQuantityPresentationFormatDifference {
+    readonly changeType: "add";
+    readonly schemaType: SchemaOtherTypes.KindOfQuantityPresentationFormat;
+    readonly itemName: string;
+    readonly difference: string[];
+}
+/**
+ * Differencing entry for changed Units on Formats.
+ * @alpha
+ */
+export interface FormatUnitDifference {
+    readonly changeType: "modify";
+    readonly schemaType: SchemaOtherTypes.FormatUnit;
+    readonly itemName: string;
+    readonly difference: {
+        name: string;
+        label?: string;
+    }[];
+}
+/**
+ * Differencing entry for changed labels on Format Units.
+ * @alpha
+ */
+export interface FormatUnitLabelDifference {
+    readonly changeType: "modify";
+    readonly schemaType: SchemaOtherTypes.FormatUnitLabel;
+    readonly itemName: string;
+    readonly path: string;
+    readonly difference: {
+        label?: string;
+    };
+}
+/**
+ * Creates a [[SchemaDifferenceResult]] for two given schemas.
+ * @param targetSchema  The schema the differences gets merged into.
+ * @param sourceSchema  The schema to get merged in the target.
+ * @returns             An [[SchemaDifferenceResult]] object.
+ * @alpha
+ */
+export declare function getSchemaDifferences(targetSchema: Schema, sourceSchema: Schema, schemaEdits?: Iterable<AnySchemaEdits>): Promise<SchemaDifferenceResult>;
+export {};
+//# sourceMappingURL=SchemaDifference.d.ts.map

package/lib/esm/Differencing/SchemaDifference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaDifference.d.ts","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifference.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,cAAc,EAAkB,MAAM,8BAA8B,CAAC;AAI9E,OAAO,EAAE,aAAa,EAAe,gBAAgB,EAAE,aAAa,EAAE,eAAe,EACnF,yBAAyB,EAAW,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAC9G,UAAU,EAAE,eAAe,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,2BAA2B,EACvG,KAAK,MAAM,EAAc,qBAAqB,EAAiB,eAAe,EAAE,cAAc,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,eAAe,EAC7K,MAAM,0BAA0B,CAAC;AAKlC,wEAAwE;AACxE,KAAK,eAAe,CAAC,CAAC,IAAI;IACxB,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAChC,CAAC;AAEF;;;;GAIG;AACH,KAAK,oBAAoB,CAAC,CAAC,SAAS,eAAe,IAAI;KACpD,CAAC,IAAI,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,eAAe,EAAE,OAAO,GAAG,aAAa,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACvH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE9C;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,MAAM,WAAW;IACjB,eAAe,oBAAoB;IACnC,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,uBAAuB,4BAA4B;IACnD,sBAAsB,2BAA2B;IACjD,2BAA2B,gCAAgC;IAC3D,gBAAgB,qBAAqB;IACrC,gCAAgC,qCAAqC;IACrE,UAAU,eAAe;IACzB,eAAe,oBAAoB;CACpC;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,cAAc,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,qCAAqC;IACrC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,qCAAqC;IACrC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC,wDAAwD;IACxD,QAAQ,CAAC,WAAW,EAAE,mBAAmB,EAAE,CAAC;IAE5C,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,CAAC,EAAE,2BAA2B,EAAE,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC7B,gBAAgB,GAChB,yBAAyB,GACzB,uBAAuB,GACvB,2BAA2B,GAC3B,0BAA0B,GAC1B,yBAAyB,GACzB,0CAA0C,GAC1C,oBAAoB,CAAC;AAEvB;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC7C,QAAQ,CAAC,UAAU,EAAE;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,UAAU,EAAE,KAAK,GAAG,QAAQ,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,eAAe,CAAC;IACtD,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GACjC,sBAAsB,GACtB,kBAAkB,GAClB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,GACxB,sBAAsB,GACtB,oBAAoB,GACpB,0BAA0B,GAC1B,cAAc,GACd,oBAAoB,CAAC;AAEvB;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAChC,qBAAqB,GACrB,oBAAoB,GACpB,qBAAqB,GACrB,8BAA8B,GAC9B,2BAA2B,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GACrC,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,GACjC,oBAAoB,GACpB,uBAAuB,GACvB,yBAAyB,CAAC;AAE5B;;;GAGG;AACH,UAAU,oBAAoB,CAAC,CAAC,SAAS,eAAe;IACtD,QAAQ,CAAC,UAAU,EAAE,KAAK,GAAG,QAAQ,CAAC;IACtC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB,CAAC,aAAa,CAAC;IAC7E,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,QAAQ,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB,CAAC,yBAAyB,CAAC;IACrG,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,oBAAoB,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB,CAAC,gBAAgB,CAAC;IACnF,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,WAAW,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB,CAAC,gBAAgB,CAAC;IACnF,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,WAAW,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB,CAAC,mBAAmB,CAAC;IACzF,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,cAAc,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB,CAAC,UAAU,CAAC;IAC5E,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,KAAK,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB,CAAC,eAAe,CAAC;IACjF,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,UAAU,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB,CAAC,qBAAqB,CAAC;IAC7F,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,gBAAgB,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,oBAAoB,CAAC,sBAAsB,CAAC;IAC/F,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,iBAAiB,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB,CAAC,gBAAgB,CAAC;IACnF,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,WAAW,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB,CAAC,eAAe,CAAC;IACjF,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,UAAU,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,oBAAoB,CAAC,mBAAmB,CAAC;IAC/E,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,IAAI,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB,CAAC,iBAAiB,CAAC;IACrF,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC;CAClD;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB,CAAC,qBAAqB,CAAC;IACnF,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,MAAM,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,UAAU,EAAE,KAAK,GAAG,QAAQ,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;CACxD;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GACnC,+BAA+B,GAC/B,mCAAmC,GACnC,iCAAiC,GACjC,+CAA+C,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,uBAAuB,CAAC;IAC9D,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,uBAAuB,CAAC;IAC9D,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,uBAAuB,CAAC;IAC9D,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,+CAA+C;IAC9D,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,uBAAuB,CAAC;IAC9D,QAAQ,CAAC,SAAS,EAAE,wBAAwB,CAAC;IAC7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,eAAe,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,gBAAgB,CAAC;IACvD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,UAAU,EAAE,KAAK,GAAG,QAAQ,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,aAAa,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,sBAAsB,CAAC;IAC7D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,IAAI,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAC,CAAC;CAC9F;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAqC;IACpD,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,2BAA2B,CAAC;IAClE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,0CAA0C;IACzD,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,gCAAgC,CAAC;IACvE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,EAAE,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,eAAe,CAAC;IACtD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAmC9J"}

package/lib/esm/Differencing/SchemaDifference.js

@@ -0,0 +1,106 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { SchemaEditType } from "../Merging/Edits/SchemaEdits";
+import { SchemaDiagnosticVisitor } from "./SchemaDiagnosticVisitor";
+import { SchemaComparer } from "../Validation/SchemaComparer";
+import { SchemaItem, } from "@itwin/ecschema-metadata";
+import { validateDifferences } from "./SchemaDifferenceValidator";
+import { NameMapping, PropertyKey } from "../Merging/Edits/NameMapping";
+/**
+ * Defines the SchemaTypes that are not SchemaItems.
+ * @alpha
+ */
+export var SchemaOtherTypes;
+(function (SchemaOtherTypes) {
+    SchemaOtherTypes["Schema"] = "Schema";
+    SchemaOtherTypes["SchemaReference"] = "SchemaReference";
+    SchemaOtherTypes["Property"] = "Property";
+    SchemaOtherTypes["Enumerator"] = "Enumerator";
+    SchemaOtherTypes["CustomAttributeInstance"] = "CustomAttributeInstance";
+    SchemaOtherTypes["RelationshipConstraint"] = "RelationshipConstraint";
+    SchemaOtherTypes["RelationshipConstraintClass"] = "RelationshipConstraintClass";
+    SchemaOtherTypes["EntityClassMixin"] = "EntityClassMixin";
+    SchemaOtherTypes["KindOfQuantityPresentationFormat"] = "KindOfQuantityPresentationFormat";
+    SchemaOtherTypes["FormatUnit"] = "FormatUnit";
+    SchemaOtherTypes["FormatUnitLabel"] = "FormatUnitLabel";
+})(SchemaOtherTypes || (SchemaOtherTypes = {}));
+/**
+ * Creates a [[SchemaDifferenceResult]] for two given schemas.
+ * @param targetSchema  The schema the differences gets merged into.
+ * @param sourceSchema  The schema to get merged in the target.
+ * @returns             An [[SchemaDifferenceResult]] object.
+ * @alpha
+ */
+export async function getSchemaDifferences(targetSchema, sourceSchema, schemaEdits) {
+    const schemaComparer = new DifferenceSchemaComparer();
+    if (schemaEdits) {
+        for (const edit of schemaEdits) {
+            if (edit.type === SchemaEditType.RenameSchemaItem) {
+                schemaComparer.nameMappings.addItemMapping(edit.key, edit.value);
+            }
+            if (edit.type === SchemaEditType.RenameProperty) {
+                schemaComparer.nameMappings.addPropertyMapping(edit.key, edit.value);
+            }
+        }
+    }
+    await schemaComparer.compareSchemas(sourceSchema, targetSchema);
+    const visitor = new SchemaDiagnosticVisitor();
+    for (const diagnostic of schemaComparer.diagnostics) {
+        visitor.visit(diagnostic);
+    }
+    const differences = [
+        ...visitor.schemaDifferences,
+        ...visitor.schemaItemDifferences,
+        ...visitor.schemaItemPathDifferences,
+        ...visitor.customAttributeDifferences,
+    ];
+    const conflicts = await validateDifferences(differences, targetSchema, sourceSchema, schemaComparer.nameMappings);
+    return {
+        sourceSchemaName: sourceSchema.schemaKey.toString(),
+        targetSchemaName: targetSchema.schemaKey.toString(),
+        conflicts: conflicts.length > 0 ? conflicts : undefined,
+        differences,
+    };
+}
+/**
+ * Implementation of a SchemaComparer that is used in the schema differencing process.
+ * It extends the SchemaComparer base class with additional functionality to store the
+ * name mappings of renamed schema items and properties.
+ *
+ * @internal
+ */
+class DifferenceSchemaComparer extends SchemaComparer {
+    nameMappings;
+    _changes;
+    get diagnostics() {
+        return this._changes[0].allDiagnostics;
+    }
+    constructor() {
+        super({ report: (changes) => this._changes.push(changes) });
+        this._changes = [];
+        this.nameMappings = new NameMapping();
+    }
+    async resolveItem(item, lookupSchema, itemConstructor) {
+        const classKey = this.nameMappings.resolveItemKey(item.key);
+        return lookupSchema.lookupItem(classKey.name, itemConstructor);
+    }
+    async resolveProperty(propertyA, ecClass) {
+        const propertyKey = this.nameMappings.resolvePropertyKey(new PropertyKey(propertyA.name, propertyA.class.key));
+        return ecClass.getProperty(propertyKey.propertyName);
+    }
+    areEqualByName(itemKeyA, itemKeyB) {
+        if (itemKeyA) {
+            if (SchemaItem.isSchemaItem(itemKeyA)) {
+                itemKeyA = itemKeyA.key;
+            }
+            itemKeyA = this.nameMappings.resolveItemKey(itemKeyA);
+        }
+        return super.areEqualByName(itemKeyA, itemKeyB);
+    }
+}
+//# sourceMappingURL=SchemaDifference.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaDifference.js","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifference.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAkB,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAGQ,UAAU,GACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAsBxE;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAYX;AAZD,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;IACrC,yFAAqE,CAAA;IACrE,6CAAyB,CAAA;IACzB,uDAAmC,CAAA;AACrC,CAAC,EAZW,gBAAgB,KAAhB,gBAAgB,QAY3B;AA2XD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,YAAoB,EAAE,YAAoB,EAAE,WAAsC;IAC3H,MAAM,cAAc,GAAG,IAAI,wBAAwB,EAAE,CAAC;IACtD,IAAG,WAAW,EAAE,CAAC;QACf,KAAI,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;YAC9B,IAAG,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;gBACjD,cAAc,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACnE,CAAC;YACD,IAAG,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,cAAc,EAAE,CAAC;gBAC/C,cAAc,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,cAAc,CAAC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,IAAI,uBAAuB,EAAE,CAAC;IAC9C,KAAK,MAAM,UAAU,IAAI,cAAc,CAAC,WAAW,EAAE,CAAC;QACpD,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,mBAAmB,CAAC,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;IAElH,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;AAED;;;;;;GAMG;AACH,MAAM,wBAAyB,SAAQ,cAAc;IACnC,YAAY,CAAc;IACzB,QAAQ,CAAuB;IAEhD,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;IACzC,CAAC;IAED;QACE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAwB,CAAC,EAAE,CAAC,CAAC;QAE7E,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC;IACxC,CAAC;IAEe,KAAK,CAAC,WAAW,CAAkC,IAAgB,EAAE,YAAoB,EAAE,eAAsB;QAC/H,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5D,OAAO,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACjE,CAAC;IAEe,KAAK,CAAC,eAAe,CAAC,SAAsB,EAAE,OAAgB;QAC5E,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/G,OAAO,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAqC,CAAC;IAC3F,CAAC;IAEe,cAAc,CAAC,QAA+C,EAAE,QAA+C;QAC7H,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACtC,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC;YAC1B,CAAC;YACD,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACxD,CAAC;QACD,OAAO,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Differencing\n */\n\nimport { AnySchemaDifferenceConflict } from \"./SchemaConflicts\";\nimport { AnySchemaEdits, SchemaEditType } from \"../Merging/Edits/SchemaEdits\";\nimport { SchemaDiagnosticVisitor } from \"./SchemaDiagnosticVisitor\";\nimport { SchemaChanges } from \"../Validation/SchemaChanges\";\nimport { SchemaComparer } from \"../Validation/SchemaComparer\";\nimport { AnyEnumerator, AnyProperty, AnyPropertyProps, ConstantProps, CustomAttribute,\n  CustomAttributeClassProps, ECClass, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps,\n  MixinProps, PhenomenonProps, PropertyCategoryProps, RelationshipClassProps, RelationshipConstraintProps,\n  type Schema, SchemaItem, SchemaItemFormatProps, SchemaItemKey, SchemaItemProps, SchemaItemType, SchemaItemUnitProps, SchemaReferenceProps, StructClassProps, UnitSystemProps,\n} from \"@itwin/ecschema-metadata\";\nimport { validateDifferences } from \"./SchemaDifferenceValidator\";\nimport { AnyDiagnostic } from \"../Validation/Diagnostic\";\nimport { NameMapping, PropertyKey } from \"../Merging/Edits/NameMapping\";\n\n/** Utility-Type to remove possible readonly flags on the given type. */\ntype PartialEditable<T> = {\n  -readonly [P in keyof T]?: T[P];\n};\n\n/**\n * Utility-Type to simplify the expected SchemaItem props by omitting the base properties\n * that are not needed for the schema differencing. Also all properties are made mutable\n * by removing the readonly flag if present.\n */\ntype SchemaItemProperties<T extends SchemaItemProps> = {\n  [P in keyof PartialEditable<Omit<T, keyof Omit<SchemaItemProps, \"label\" | \"description\" | \"customAttributes\">>>]: T[P]\n};\n\n/**\n * Defines the type of the difference operation.\n * @alpha\n */\nexport type DifferenceType = \"add\" | \"modify\";\n\n/**\n * Defines the SchemaTypes that are not SchemaItems.\n * @alpha\n */\nexport enum SchemaOtherTypes {\n  Schema = \"Schema\",\n  SchemaReference = \"SchemaReference\",\n  Property = \"Property\",\n  Enumerator = \"Enumerator\",\n  CustomAttributeInstance = \"CustomAttributeInstance\",\n  RelationshipConstraint = \"RelationshipConstraint\",\n  RelationshipConstraintClass = \"RelationshipConstraintClass\",\n  EntityClassMixin = \"EntityClassMixin\",\n  KindOfQuantityPresentationFormat = \"KindOfQuantityPresentationFormat\",\n  FormatUnit = \"FormatUnit\",\n  FormatUnitLabel = \"FormatUnitLabel\",\n}\n\n/**\n * Defines the possible values SchemaTypes that can occur in SchemaDifferences or Conflicts.\n * @alpha\n */\nexport type SchemaType = SchemaOtherTypes | SchemaItemType;\n\n/**\n * Definition of the difference result between two Schemas.\n * @alpha\n */\nexport interface SchemaDifferenceResult {\n  /** Full name of the source schema */\n  readonly sourceSchemaName: string;\n  /** Full name of the target schema */\n  readonly targetSchemaName: string;\n\n  /** List of differences between the compared schemas. */\n  readonly differences: AnySchemaDifference[];\n\n  /** List of conflicts found while comparing the schemas. */\n  readonly conflicts?: AnySchemaDifferenceConflict[];\n}\n\n/**\n * Union of all supported schema differencing types.\n * @alpha\n */\nexport type AnySchemaDifference =\n  SchemaDifference |\n  SchemaReferenceDifference |\n  AnySchemaItemDifference |\n  AnySchemaItemPathDifference |\n  EntityClassMixinDifference |\n  CustomAttributeDifference |\n  KindOfQuantityPresentationFormatDifference |\n  FormatUnitDifference;\n\n/**\n * Differencing entry for changes on a Schema.\n * @alpha\n */\nexport interface SchemaDifference {\n  readonly changeType: \"modify\";\n  readonly schemaType: SchemaOtherTypes.Schema;\n  readonly difference: {\n    label?: string;\n    description?: string;\n  };\n}\n\n/**\n * Differencing entry for added or changed Schema References of a Schema.\n * @alpha\n */\nexport interface SchemaReferenceDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.SchemaReference;\n  readonly difference: SchemaReferenceProps;\n}\n\n/**\n * Union of all supported schema item differencing types.\n * @alpha\n */\nexport type AnySchemaItemDifference =\n  AnyClassItemDifference |\n  ConstantDifference |\n  EnumerationDifference |\n  FormatDifference |\n  KindOfQuantityDifference |\n  InvertedUnitDifference |\n  PhenomenonDifference |\n  PropertyCategoryDifference |\n  UnitDifference |\n  UnitSystemDifference;\n\n/**\n * Union for supported class Schema Items.\n * @alpha\n */\nexport type AnyClassItemDifference =\n  EntityClassDifference |\n  MixinClassDifference |\n  StructClassDifference |\n  CustomAttributeClassDifference |\n  RelationshipClassDifference;\n\n/**\n * Union of all differences that have a path pointing inside a schema item.\n * @alpha\n */\nexport type AnySchemaItemPathDifference =\n  RelationshipConstraintDifference |\n  RelationshipConstraintClassDifference |\n  CustomAttributePropertyDifference |\n  EnumeratorDifference |\n  ClassPropertyDifference |\n  FormatUnitLabelDifference;\n\n/**\n * Internal base class for all Schema Item differencing entries.\n * @alpha\n */\ninterface SchemaItemDifference<T extends SchemaItemProps> {\n  readonly changeType: \"add\" | \"modify\";\n  readonly itemName: string;\n  readonly difference: SchemaItemProperties<T>;\n}\n\n/**\n * Differencing entry for Constant Schema Items.\n * @alpha\n */\nexport interface ConstantDifference extends SchemaItemDifference<ConstantProps> {\n  readonly schemaType: SchemaItemType.Constant;\n}\n\n/**\n * Differencing entry for Custom Attribute Class Schema Items.\n * @alpha\n */\nexport interface CustomAttributeClassDifference extends SchemaItemDifference<CustomAttributeClassProps> {\n  readonly schemaType: SchemaItemType.CustomAttributeClass;\n}\n\n/**\n * Differencing entry for Entity Class Schema Items.\n * @alpha\n */\nexport interface EntityClassDifference extends SchemaItemDifference<EntityClassProps> {\n  readonly schemaType: SchemaItemType.EntityClass;\n}\n\n/**\n * Differencing entry for Enumerator Schema Items.\n * @alpha\n */\nexport interface EnumerationDifference extends SchemaItemDifference<EnumerationProps> {\n  readonly schemaType: SchemaItemType.Enumeration;\n}\n\n/**\n * Differencing entry for Kind-Of-Quantities Schema Items.\n * @alpha\n */\nexport interface KindOfQuantityDifference extends SchemaItemDifference<KindOfQuantityProps> {\n  readonly schemaType: SchemaItemType.KindOfQuantity;\n}\n\n/**\n * Differencing entry for Mixin Class Schema Items.\n * @alpha\n */\nexport interface MixinClassDifference extends SchemaItemDifference<MixinProps> {\n  readonly schemaType: SchemaItemType.Mixin;\n}\n\n/**\n * Differencing entry for Phenomenon Schema Items.\n * @alpha\n */\nexport interface PhenomenonDifference extends SchemaItemDifference<PhenomenonProps> {\n  readonly schemaType: SchemaItemType.Phenomenon;\n}\n\n/**\n * Differencing entry for Property Category Schema Items.\n * @alpha\n */\nexport interface PropertyCategoryDifference extends SchemaItemDifference<PropertyCategoryProps> {\n  readonly schemaType: SchemaItemType.PropertyCategory;\n}\n\n/**\n * Differencing entry for Relationship Class Schema Items.\n * @alpha\n */\nexport interface RelationshipClassDifference extends SchemaItemDifference<RelationshipClassProps> {\n  readonly schemaType: SchemaItemType.RelationshipClass;\n}\n\n/**\n * Differencing entry for Struct Class Schema Items.\n * @alpha\n */\nexport interface StructClassDifference extends SchemaItemDifference<StructClassProps> {\n  readonly schemaType: SchemaItemType.StructClass;\n}\n\n/**\n * Differencing entry for Unit System Schema Items.\n * @alpha\n */\nexport interface UnitSystemDifference extends SchemaItemDifference<UnitSystemProps> {\n  readonly schemaType: SchemaItemType.UnitSystem;\n}\n\n/**\n * Differencing entry for Unit Schema Items.\n * @alpha\n */\nexport interface UnitDifference extends SchemaItemDifference<SchemaItemUnitProps> {\n  readonly schemaType: SchemaItemType.Unit;\n}\n\n/**\n * Differencing entry for Inverted Unit Schema Items.\n * @alpha\n */\nexport interface InvertedUnitDifference extends SchemaItemDifference<InvertedUnitProps> {\n  readonly schemaType: SchemaItemType.InvertedUnit;\n}\n/**\n * Differencing entry for Format Schema Items.\n * @alpha\n */\nexport interface FormatDifference extends SchemaItemDifference<SchemaItemFormatProps> {\n  readonly schemaType: SchemaItemType.Format;\n}\n\n/**\n * Differencing entry for added or changed Properties.\n * @alpha\n */\nexport interface ClassPropertyDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.Property;\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<AnyPropertyProps>;\n}\n\n/**\n * Union of supported Custom Attribute Differences.\n * @alpha\n */\nexport type CustomAttributeDifference =\n  CustomAttributeSchemaDifference |\n  CustomAttributeSchemaItemDifference |\n  CustomAttributePropertyDifference |\n  CustomAttributeRelationshipConstraintDifference;\n\n/**\n * Differencing entry for Custom Attributes on Schema.\n * @alpha\n */\nexport interface CustomAttributeSchemaDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"Schema\";\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Schema Items.\n * @alpha\n */\nexport interface CustomAttributeSchemaItemDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"SchemaItem\";\n  readonly itemName: string;\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Properties.\n * @alpha\n */\nexport interface CustomAttributePropertyDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"Property\";\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for Custom Attributes on Relationship Constraints.\n * @alpha\n */\nexport interface CustomAttributeRelationshipConstraintDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.CustomAttributeInstance;\n  readonly appliedTo: \"RelationshipConstraint\";\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: PartialEditable<CustomAttribute>;\n}\n\n/**\n * Differencing entry for changed mixins on EntityClasses.\n * @alpha\n */\nexport interface EntityClassMixinDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.EntityClassMixin;\n  readonly itemName: string;\n  readonly difference: string[];\n}\n\n/**\n * Differencing entry for changed Enumerators on Enumerable Schema Items.\n * @alpha\n */\nexport interface EnumeratorDifference {\n  readonly changeType: \"add\" | \"modify\";\n  readonly schemaType: SchemaOtherTypes.Enumerator;\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: PartialEditable<AnyEnumerator>;\n}\n\n/**\n * Differencing entry for Relationship Constraints.\n * @alpha\n */\nexport interface RelationshipConstraintDifference {\n  readonly changeType: \"modify\";\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraint;\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: PartialEditable<Omit<RelationshipConstraintProps, \"constraintClasses\">>;\n}\n\n/**\n * Differencing entry for constraint classes added to Relationship Constrains.\n * @alpha\n */\nexport interface RelationshipConstraintClassDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.RelationshipConstraintClass;\n  readonly itemName: string;\n  readonly path: \"$source\" | \"$target\";\n  readonly difference: string[];\n}\n\n/**\n * Differencing entry for presentation formats added to KindOfQuantities.\n * @alpha\n */\nexport interface KindOfQuantityPresentationFormatDifference {\n  readonly changeType: \"add\";\n  readonly schemaType: SchemaOtherTypes.KindOfQuantityPresentationFormat;\n  readonly itemName: string;\n  readonly difference: string[];\n}\n\n/**\n * Differencing entry for changed Units on Formats.\n * @alpha\n */\nexport interface FormatUnitDifference {\n  readonly changeType: \"modify\";\n  readonly schemaType: SchemaOtherTypes.FormatUnit;\n  readonly itemName: string;\n  readonly difference: {\n    name: string;\n    label?: string;\n  }[];\n}\n\n/**\n * Differencing entry for changed labels on Format Units.\n * @alpha\n */\nexport interface FormatUnitLabelDifference {\n  readonly changeType: \"modify\";\n  readonly schemaType: SchemaOtherTypes.FormatUnitLabel;\n  readonly itemName: string;\n  readonly path: string;\n  readonly difference: {\n    label?: string;\n  };\n}\n\n/**\n * Creates a [[SchemaDifferenceResult]] for two given schemas.\n * @param targetSchema  The schema the differences gets merged into.\n * @param sourceSchema  The schema to get merged in the target.\n * @returns             An [[SchemaDifferenceResult]] object.\n * @alpha\n */\nexport async function getSchemaDifferences(targetSchema: Schema, sourceSchema: Schema, schemaEdits?: Iterable<AnySchemaEdits>): Promise<SchemaDifferenceResult> {\n  const schemaComparer = new DifferenceSchemaComparer();\n  if(schemaEdits) {\n    for(const edit of schemaEdits) {\n      if(edit.type === SchemaEditType.RenameSchemaItem) {\n        schemaComparer.nameMappings.addItemMapping(edit.key, edit.value);\n      }\n      if(edit.type === SchemaEditType.RenameProperty) {\n        schemaComparer.nameMappings.addPropertyMapping(edit.key, edit.value);\n      }\n    }\n  }\n\n  await schemaComparer.compareSchemas(sourceSchema, targetSchema);\n\n  const visitor = new SchemaDiagnosticVisitor();\n  for (const diagnostic of schemaComparer.diagnostics) {\n    visitor.visit(diagnostic);\n  }\n\n  const differences: AnySchemaDifference[] = [\n    ...visitor.schemaDifferences,\n    ...visitor.schemaItemDifferences,\n    ...visitor.schemaItemPathDifferences,\n    ...visitor.customAttributeDifferences,\n  ];\n\n  const conflicts = await validateDifferences(differences, targetSchema, sourceSchema, schemaComparer.nameMappings);\n\n  return {\n    sourceSchemaName: sourceSchema.schemaKey.toString(),\n    targetSchemaName: targetSchema.schemaKey.toString(),\n    conflicts: conflicts.length > 0 ? conflicts : undefined,\n    differences,\n  };\n}\n\n/**\n * Implementation of a SchemaComparer that is used in the schema differencing process.\n * It extends the SchemaComparer base class with additional functionality to store the\n * name mappings of renamed schema items and properties.\n *\n * @internal\n */\nclass DifferenceSchemaComparer extends SchemaComparer {\n  public readonly nameMappings: NameMapping;\n  private readonly _changes: Array<SchemaChanges>;\n\n  public get diagnostics(): Iterable<AnyDiagnostic> {\n    return this._changes[0].allDiagnostics;\n  }\n\n  constructor() {\n    super({ report: (changes) => this._changes.push(changes as SchemaChanges) });\n\n    this._changes = [];\n    this.nameMappings = new NameMapping();\n  }\n\n  public override async resolveItem<TItem extends typeof SchemaItem>(item: SchemaItem, lookupSchema: Schema, itemConstructor: TItem): Promise<InstanceType<TItem> | undefined> {\n    const classKey = this.nameMappings.resolveItemKey(item.key);\n    return lookupSchema.lookupItem(classKey.name, itemConstructor);\n  }\n\n  public override async resolveProperty(propertyA: AnyProperty, ecClass: ECClass): Promise<AnyProperty | undefined> {\n    const propertyKey = this.nameMappings.resolvePropertyKey(new PropertyKey(propertyA.name, propertyA.class.key));\n    return ecClass.getProperty(propertyKey.propertyName) as Promise<AnyProperty | undefined>;\n  }\n\n  public override areEqualByName(itemKeyA?: Readonly<SchemaItemKey> | SchemaItem, itemKeyB?: Readonly<SchemaItemKey> | SchemaItem): boolean {\n    if (itemKeyA) {\n      if (SchemaItem.isSchemaItem(itemKeyA)) {\n        itemKeyA = itemKeyA.key;\n      }\n      itemKeyA = this.nameMappings.resolveItemKey(itemKeyA);\n    }\n    return super.areEqualByName(itemKeyA, itemKeyB);\n  }\n}\n"]}

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

@@ -0,0 +1,18 @@
+/** @packageDocumentation
+ * @module Differencing
+ */
+import { Schema } from "@itwin/ecschema-metadata";
+import { AnySchemaDifference } from "./SchemaDifference";
+import { AnySchemaDifferenceConflict } from "./SchemaConflicts";
+import { NameMapping } from "../Merging/Edits/NameMapping";
+/**
+ * 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, nameMappings: NameMapping): Promise<AnySchemaDifferenceConflict[]>;
+//# sourceMappingURL=SchemaDifferenceValidator.d.ts.map

package/lib/esm/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,EAA2N,MAAM,EAAoD,MAAM,0BAA0B,CAAC;AAC7T,OAAO,EAA0B,mBAAmB,EAA4pB,MAAM,oBAAoB,CAAC;AAC3uB,OAAO,EAAE,2BAA2B,EAAgB,MAAM,mBAAmB,CAAC;AAE9E,OAAO,EAAE,WAAW,EAAe,MAAM,8BAA8B,CAAC;AAExE;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CAAC,WAAW,EAAE,mBAAmB,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,0CAOlJ"}