@itwin/ecschema-editing 4.8.0-dev.4 → 4.8.0-dev.40

package/lib/cjs/Merging/Edits/SkipEditHandler.js

@@ -0,0 +1,60 @@
+"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 Merging
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applySkipEdit = void 0;
+/**
+ * Applies a skip edit to the schema differences. It basically removes all entries that
+ * that are associated with the item to skip.
+ * @param result  The result of a schema differencing run
+ * @param edit    The skip edit to be applied.
+ * @internal
+ */
+function applySkipEdit(result, edit) {
+    const [itemName, pathName] = edit.key.split(".");
+    const foundIndices = pathName !== undefined
+        ? findRelatedItemEntries(result, itemName, pathName)
+        : findItemEntries(result, itemName);
+    for (const index of foundIndices.reverse()) {
+        result.differences.splice(index, 1);
+    }
+    if (result.conflicts) {
+        removeRelatedConflicts(result.conflicts, itemName, pathName);
+    }
+}
+exports.applySkipEdit = applySkipEdit;
+function removeRelatedConflicts(conflicts, itemName, path) {
+    const indices = [];
+    conflicts.forEach((conflict, index) => {
+        if (conflict.itemName === itemName && conflict.path === path) {
+            indices.push(index);
+        }
+    });
+    for (const index of indices.reverse()) {
+        conflicts.splice(index, 1);
+    }
+}
+function findItemEntries({ differences }, itemName) {
+    const found = [];
+    differences.forEach((difference, index) => {
+        if ("itemName" in difference && difference.itemName === itemName) {
+            found.push(index);
+        }
+    });
+    return found;
+}
+function findRelatedItemEntries({ differences }, itemName, pathName) {
+    const found = [];
+    differences.forEach((difference, index) => {
+        if ("itemName" in difference && difference.itemName === itemName && "path" in difference && difference.path === pathName) {
+            found.push(index);
+        }
+    });
+    return found;
+}
+//# sourceMappingURL=SkipEditHandler.js.map

package/lib/cjs/Merging/Edits/SkipEditHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SkipEditHandler.js","sourceRoot":"","sources":["../../../../src/Merging/Edits/SkipEditHandler.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAMH;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,MAA8B,EAAE,IAAc;IAC1E,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAiC,CAAC;IACjF,MAAM,YAAY,GAAG,QAAQ,KAAK,SAAS;QACzC,CAAC,CAAC,sBAAsB,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;QACpD,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAEtC,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,OAAO,EAAE,EAAE,CAAC;QAC3C,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,sBAAsB,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAbD,sCAaC;AAED,SAAS,sBAAsB,CAAC,SAAqC,EAAE,QAAgB,EAAE,IAAa;IACpG,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QACpC,IAAI,QAAQ,CAAC,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC7D,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACtC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,EAAE,WAAW,EAA0B,EAAE,QAAgB;IAChF,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;QACxC,IAAI,UAAU,IAAI,UAAU,IAAI,UAAU,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,sBAAsB,CAAC,EAAE,WAAW,EAA0B,EAAE,QAAgB,EAAE,QAAgB;IACzG,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;QACxC,IAAI,UAAU,IAAI,UAAU,IAAI,UAAU,CAAC,QAAQ,KAAK,QAAQ,IAAI,MAAM,IAAI,UAAU,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACzH,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,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 Merging\r\n */\r\n\r\nimport type { SchemaDifferenceResult } from \"../../Differencing/SchemaDifference\";\r\nimport type { SchemaDifferenceConflict } from \"../../ecschema-editing\";\r\nimport type { SkipEdit } from \"./SchemaEdits\";\r\n\r\n/**\r\n * Applies a skip edit to the schema differences. It basically removes all entries that\r\n * that are associated with the item to skip.\r\n * @param result  The result of a schema differencing run\r\n * @param edit    The skip edit to be applied.\r\n * @internal\r\n */\r\nexport function applySkipEdit(result: SchemaDifferenceResult, edit: SkipEdit) {\r\n  const [itemName, pathName] = edit.key.split(\".\") as [string, string | undefined];\r\n  const foundIndices = pathName !== undefined\r\n    ? findRelatedItemEntries(result, itemName, pathName)\r\n    : findItemEntries(result, itemName);\r\n\r\n  for (const index of foundIndices.reverse()) {\r\n    result.differences.splice(index, 1);\r\n  }\r\n\r\n  if (result.conflicts) {\r\n    removeRelatedConflicts(result.conflicts, itemName, pathName);\r\n  }\r\n}\r\n\r\nfunction removeRelatedConflicts(conflicts: SchemaDifferenceConflict[], itemName: string, path?: string) {\r\n  const indices: number[] = [];\r\n  conflicts.forEach((conflict, index) => {\r\n    if (conflict.itemName === itemName && conflict.path === path) {\r\n      indices.push(index);\r\n    }\r\n  });\r\n\r\n  for (const index of indices.reverse()) {\r\n    conflicts.splice(index, 1);\r\n  }\r\n}\r\n\r\nfunction findItemEntries({ differences }: SchemaDifferenceResult, itemName: string): number[] {\r\n  const found: number[] = [];\r\n  differences.forEach((difference, index) => {\r\n    if (\"itemName\" in difference && difference.itemName === itemName) {\r\n      found.push(index);\r\n    }\r\n  });\r\n  return found;\r\n}\r\n\r\nfunction findRelatedItemEntries({ differences }: SchemaDifferenceResult, itemName: string, pathName: string): number[] {\r\n  const found: number[] = [];\r\n  differences.forEach((difference, index) => {\r\n    if (\"itemName\" in difference && difference.itemName === itemName && \"path\" in difference && difference.path === pathName) {\r\n      found.push(index);\r\n    }\r\n  });\r\n  return found;\r\n}\r\n\r\n"]}

package/lib/cjs/Merging/SchemaItemMerger.d.ts

@@ -5,8 +5,8 @@ import { SchemaItem, SchemaItemKey } from "@itwin/ecschema-metadata";
  * @internal
  */
 export interface SchemaItemMergerHandler<T extends AnySchemaItemDifference | AnySchemaItemPathDifference> {
-    add: (context: SchemaMergeContext, change: T) => Promise<SchemaItemKey>;
-    modify: (context: SchemaMergeContext, change: T, itemKey: SchemaItemKey, item: any) => Promise<void>;
+    add: (context: SchemaMergeContext, difference: T) => Promise<SchemaItemKey>;
+    modify: (context: SchemaMergeContext, difference: T, itemKey: SchemaItemKey, item: any) => Promise<void>;
 }
 /**
  * @internal
@@ -16,11 +16,11 @@ export declare function locateSchemaItem(context: SchemaMergeContext, itemName:
  * Merges the given set of schema items. As schema items may depend or relate with other
  * schema items, the list gets filtered to ensure the items get merged in a certain order.
  * @param context       The current merging context.
- * @param itemChanges   Set of schema item that differed.
+ * @param differences   Set of schema item that differed.
  * @returns             An async iterable with the merge result for each schema item.
  * @internal
  */
-export declare function mergeSchemaItems(context: SchemaMergeContext, itemChanges: AnySchemaDifference[]): AsyncGenerator<void, void, unknown>;
+export declare function mergeSchemaItems(context: SchemaMergeContext, differences: AnySchemaDifference[]): AsyncGenerator<void, void, unknown>;
 /**
  * Convenience-method around updateSchemaItemKey that returns the full name instead of a SchemaItemKey.
  * @internal

package/lib/cjs/Merging/SchemaItemMerger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaItemMerger.d.ts","sourceRoot":"","sources":["../../../src/Merging/SchemaItemMerger.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,2BAA2B,EAAoB,MAAM,kCAAkC,CAAC;AAC/I,OAAO,EAAkD,UAAU,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AASrH;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,uBAAuB,GAAG,2BAA2B;IACtG,GAAG,EAAK,CAAC,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3E,MAAM,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtG;AAoBD;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,uBAQvG;AAED;;;;;;;GAOG;AACH,wBAAuB,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,mBAAmB,EAAE,uCAwCtG;AAED;;;GAGG;AACH,wBAAsB,wBAAwB,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,mBAG5F;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,0BAYvF"}
+{"version":3,"file":"SchemaItemMerger.d.ts","sourceRoot":"","sources":["../../../src/Merging/SchemaItemMerger.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC7H,OAAO,EAAkD,UAAU,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAUrH;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,uBAAuB,GAAG,2BAA2B;IACtG,GAAG,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5E,MAAM,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1G;AAoBD;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,uBAQvG;AAED;;;;;;;GAOG;AACH,wBAAuB,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,mBAAmB,EAAE,uCAwCtG;AAED;;;GAGG;AACH,wBAAsB,wBAAwB,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,mBAG5F;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,0BAYvF"}

package/lib/cjs/Merging/SchemaItemMerger.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateSchemaItemKey = exports.updateSchemaItemFullName = exports.mergeSchemaItems = exports.locateSchemaItem = void 0;
-const SchemaDifference_1 = require("../Differencing/SchemaDifference");
 const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
 const EnumerationMerger_1 = require("./EnumerationMerger");
 const PhenomenonMerger_1 = require("./PhenomenonMerger");
@@ -10,20 +9,21 @@ const UnitSystemMerger_1 = require("./UnitSystemMerger");
 const KindOfQuantityMerger_1 = require("./KindOfQuantityMerger");
 const ConstantMerger_1 = require("./ConstantMerger");
 const ClassMerger_1 = require("./ClassMerger");
+const Utils = require("../Differencing/Utils");
 /**
  * Handles the merging logic for everything that is same for all schema items such as labels or descriptions
  * @internal
  */
-async function mergeSchemaItem(context, change, merger) {
-    if (change.changeType === "add") {
-        await merger.add(context, change);
+async function mergeSchemaItem(context, difference, merger) {
+    if (difference.changeType === "add") {
+        await merger.add(context, difference);
         return;
     }
-    if (change.changeType === "modify") {
-        const schemaItem = await locateSchemaItem(context, change.itemName, change.schemaType);
-        return merger.modify(context, change, schemaItem.key, schemaItem);
+    if (difference.changeType === "modify") {
+        const schemaItem = await locateSchemaItem(context, difference.itemName, difference.schemaType);
+        return merger.modify(context, difference, schemaItem.key, schemaItem);
     }
-    throw new Error(`The merger does not support ${change.changeType} of ${change.schemaType}.`);
+    throw new Error(`The merger does not support ${difference.changeType} of ${difference.schemaType}.`);
 }
 /**
  * @internal
@@ -41,24 +41,24 @@ exports.locateSchemaItem = locateSchemaItem;
  * Merges the given set of schema items. As schema items may depend or relate with other
  * schema items, the list gets filtered to ensure the items get merged in a certain order.
  * @param context       The current merging context.
- * @param itemChanges   Set of schema item that differed.
+ * @param differences   Set of schema item that differed.
  * @returns             An async iterable with the merge result for each schema item.
  * @internal
  */
-async function* mergeSchemaItems(context, itemChanges) {
-    for (const difference of itemChanges.filter(SchemaDifference_1.SchemaDifference.isUnitSystemDifference)) {
+async function* mergeSchemaItems(context, differences) {
+    for (const difference of differences.filter(Utils.isUnitSystemDifference)) {
         yield await mergeSchemaItem(context, difference, UnitSystemMerger_1.unitSystemMerger);
     }
-    for (const difference of itemChanges.filter(SchemaDifference_1.SchemaDifference.isPropertyCategoryDifference)) {
+    for (const difference of differences.filter(Utils.isPropertyCategoryDifference)) {
         yield await mergeSchemaItem(context, difference, PropertyCategoryMerger_1.propertyCategoryMerger);
     }
-    for (const difference of itemChanges.filter(SchemaDifference_1.SchemaDifference.isEnumerationDifference)) {
+    for (const difference of differences.filter(Utils.isEnumerationDifference)) {
         yield await mergeSchemaItem(context, difference, EnumerationMerger_1.enumerationMerger);
     }
-    for (const difference of itemChanges.filter(SchemaDifference_1.SchemaDifference.isEnumeratorDifference)) {
+    for (const difference of differences.filter(Utils.isEnumeratorDifference)) {
         yield await mergeSchemaItem(context, difference, EnumerationMerger_1.enumeratorMerger);
     }
-    for (const difference of itemChanges.filter(SchemaDifference_1.SchemaDifference.isPhenomenonDifference)) {
+    for (const difference of differences.filter(Utils.isPhenomenonDifference)) {
         yield await mergeSchemaItem(context, difference, PhenomenonMerger_1.phenomenonMerger);
     }
     // TODO:
@@ -66,15 +66,15 @@ async function* mergeSchemaItems(context, itemChanges) {
     // - Unit
     // - Inverted Unit
     // - Format
-    for (const difference of itemChanges.filter(SchemaDifference_1.SchemaDifference.isKindOfQuantityDifference)) {
+    for (const difference of differences.filter(Utils.isKindOfQuantityDifference)) {
         yield await mergeSchemaItem(context, difference, KindOfQuantityMerger_1.kindOfQuantityMerger);
     }
-    for (const difference of itemChanges.filter(SchemaDifference_1.SchemaDifference.isConstantDifference)) {
+    for (const difference of differences.filter(Utils.isConstantDifference)) {
         yield await mergeSchemaItem(context, difference, ConstantMerger_1.constantMerger);
     }
     // Classes are slightly differently merged, since they can refer each other the process
     // uses several stages to merge.
-    for await (const classMergeResult of (0, ClassMerger_1.mergeClassItems)(context, itemChanges)) {
+    for await (const classMergeResult of (0, ClassMerger_1.mergeClassItems)(context, differences)) {
         yield classMergeResult;
     }
 }

package/lib/cjs/Merging/SchemaItemMerger.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaItemMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaItemMerger.ts"],"names":[],"mappings":";;;AAKA,uEAA+I;AAC/I,gEAAqH;AACrH,2DAA0E;AAC1E,yDAAsD;AACtD,qEAAkE;AAClE,yDAAsD;AACtD,iEAA8D;AAC9D,qDAAkD;AAClD,+CAAgD;AAUhD;;;GAGG;AACH,KAAK,UAAU,eAAe,CAAgE,OAA2B,EAAE,MAAS,EAAE,MAAkC;IACtK,IAAG,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QAC/B,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAClC,OAAO;IACT,CAAC;IAED,IAAG,MAAM,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QACvF,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,CAAC,UAAU,OAAO,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC;AAC/F,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB,CAAC,OAA2B,EAAE,QAAgB,EAAE,UAAkB;IACtG,MAAM,aAAa,GAAG,IAAI,iCAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACnF,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,GAAG,UAAU,IAAI,aAAa,CAAC,QAAQ,+BAA+B,CAAC,CAAC;IAClI,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AARD,4CAQC;AAED;;;;;;;GAOG;AACI,KAAK,SAAS,CAAC,CAAC,gBAAgB,CAAC,OAA2B,EAAE,WAAkC;IACrG,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACrF,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,mCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,4BAA4B,CAAC,EAAE,CAAC;QAC3F,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,+CAAsB,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACtF,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,qCAAiB,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACrF,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,oCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACrF,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,mCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,QAAQ;IACR,uFAAuF;IACvF,SAAS;IACT,kBAAkB;IAClB,WAAW;IAEX,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,0BAA0B,CAAC,EAAE,CAAC;QACzF,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,2CAAoB,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACnF,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,+BAAc,CAAC,CAAC;IACnE,CAAC;IAED,uFAAuF;IACvF,gCAAgC;IAChC,IAAI,KAAK,EAAE,MAAM,gBAAgB,IAAI,IAAA,6BAAe,EAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;QAC3E,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,4CAwCC;AAED;;;GAGG;AACI,KAAK,UAAU,wBAAwB,CAAC,OAA2B,EAAE,SAAiB;IAC3F,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACpE,OAAO,aAAa,CAAC,QAAQ,CAAC;AAChC,CAAC;AAHD,4DAGC;AAED;;;;GAIG;AACI,KAAK,UAAU,mBAAmB,CAAC,OAA2B,EAAE,SAAiB;IACtF,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,8BAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACnE,IAAI,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QACtD,OAAO,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,iCAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;IAClH,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAC7E,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,iCAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;IACrH,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC;AACvE,CAAC;AAZD,kDAYC;AAED;;;;GAIG;AACH,KAAK,UAAU,oBAAoB,CAAC,aAA4B,EAAE,OAAsB;IACtF,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACxD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,mGAAmG;QACnG,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC;AAClB,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\nimport type { SchemaMergeContext } from \"./SchemaMerger\";\r\nimport { AnySchemaDifference, AnySchemaItemDifference, AnySchemaItemPathDifference, SchemaDifference } from \"../Differencing/SchemaDifference\";\r\nimport { ECObjectsError, ECObjectsStatus, SchemaContext, SchemaItem, SchemaItemKey } from \"@itwin/ecschema-metadata\";\r\nimport { enumerationMerger, enumeratorMerger } from \"./EnumerationMerger\";\r\nimport { phenomenonMerger } from \"./PhenomenonMerger\";\r\nimport { propertyCategoryMerger } from \"./PropertyCategoryMerger\";\r\nimport { unitSystemMerger } from \"./UnitSystemMerger\";\r\nimport { kindOfQuantityMerger } from \"./KindOfQuantityMerger\";\r\nimport { constantMerger } from \"./ConstantMerger\";\r\nimport { mergeClassItems } from \"./ClassMerger\";\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaItemMergerHandler<T extends AnySchemaItemDifference | AnySchemaItemPathDifference> {\r\n  add:    (context: SchemaMergeContext, change: T) => Promise<SchemaItemKey>;\r\n  modify: (context: SchemaMergeContext, change: T, itemKey: SchemaItemKey, item: any) => Promise<void>;\r\n}\r\n\r\n/**\r\n * Handles the merging logic for everything that is same for all schema items such as labels or descriptions\r\n * @internal\r\n */\r\nasync function mergeSchemaItem<T extends AnySchemaItemDifference|AnySchemaItemPathDifference>(context: SchemaMergeContext, change: T, merger: SchemaItemMergerHandler<T>): Promise<void> {\r\n  if(change.changeType === \"add\") {\r\n    await merger.add(context, change);\r\n    return;\r\n  }\r\n\r\n  if(change.changeType === \"modify\") {\r\n    const schemaItem = await locateSchemaItem(context, change.itemName, change.schemaType);\r\n    return merger.modify(context, change, schemaItem.key, schemaItem);\r\n  }\r\n\r\n  throw new Error(`The merger does not support ${change.changeType} of ${change.schemaType}.`);\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport async function locateSchemaItem(context: SchemaMergeContext, itemName: string, schemaType: string) {\r\n  const schemaItemKey = new SchemaItemKey(itemName, context.targetSchemaKey);\r\n  const schemaItem = await context.editor.schemaContext.getSchemaItem(schemaItemKey);\r\n  if (schemaItem === undefined) {\r\n    throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `${schemaType} ${schemaItemKey.fullName} not found in schema context.`);\r\n  }\r\n\r\n  return schemaItem;\r\n}\r\n\r\n/**\r\n * Merges the given set of schema items. As schema items may depend or relate with other\r\n * schema items, the list gets filtered to ensure the items get merged in a certain order.\r\n * @param context       The current merging context.\r\n * @param itemChanges   Set of schema item that differed.\r\n * @returns             An async iterable with the merge result for each schema item.\r\n * @internal\r\n */\r\nexport async function* mergeSchemaItems(context: SchemaMergeContext, itemChanges: AnySchemaDifference[]) {\r\n  for (const difference of itemChanges.filter(SchemaDifference.isUnitSystemDifference)) {\r\n    yield await mergeSchemaItem(context, difference, unitSystemMerger);\r\n  }\r\n\r\n  for (const difference of itemChanges.filter(SchemaDifference.isPropertyCategoryDifference)) {\r\n    yield await mergeSchemaItem(context, difference, propertyCategoryMerger);\r\n  }\r\n\r\n  for (const difference of itemChanges.filter(SchemaDifference.isEnumerationDifference)) {\r\n    yield await mergeSchemaItem(context, difference, enumerationMerger);\r\n  }\r\n\r\n  for (const difference of itemChanges.filter(SchemaDifference.isEnumeratorDifference)) {\r\n    yield await mergeSchemaItem(context, difference, enumeratorMerger);\r\n  }\r\n\r\n  for (const difference of itemChanges.filter(SchemaDifference.isPhenomenonDifference)) {\r\n    yield await mergeSchemaItem(context, difference, phenomenonMerger);\r\n  }\r\n\r\n  // TODO:\r\n  // The following schema items are not supported yet. Mentioned in the processing order:\r\n  // - Unit\r\n  // - Inverted Unit\r\n  // - Format\r\n\r\n  for (const difference of itemChanges.filter(SchemaDifference.isKindOfQuantityDifference)) {\r\n    yield await mergeSchemaItem(context, difference, kindOfQuantityMerger);\r\n  }\r\n\r\n  for (const difference of itemChanges.filter(SchemaDifference.isConstantDifference)) {\r\n    yield await mergeSchemaItem(context, difference, constantMerger);\r\n  }\r\n\r\n  // Classes are slightly differently merged, since they can refer each other the process\r\n  // uses several stages to merge.\r\n  for await (const classMergeResult of mergeClassItems(context, itemChanges)) {\r\n    yield classMergeResult;\r\n  }\r\n}\r\n\r\n/**\r\n * Convenience-method around updateSchemaItemKey that returns the full name instead of a SchemaItemKey.\r\n * @internal\r\n */\r\nexport async function updateSchemaItemFullName(context: SchemaMergeContext, reference: string) {\r\n  const schemaItemKey = await updateSchemaItemKey(context, reference);\r\n  return schemaItemKey.fullName;\r\n}\r\n\r\n/**\r\n * Updates the given reference if it refers to a SchemaItem in the source Schema and\r\n * returns a SchemaItemKey. If any other schema is referred the reference is not change.\r\n * @internal\r\n */\r\nexport async function updateSchemaItemKey(context: SchemaMergeContext, reference: string) {\r\n  const [schemaName, itemName] = SchemaItem.parseFullName(reference);\r\n  if (context.sourceSchemaKey.compareByName(schemaName)) {\r\n    return resolveSchemaItemKey(context.editor.schemaContext, new SchemaItemKey(itemName, context.targetSchemaKey));\r\n  }\r\n\r\n  const referencedSchema = await context.targetSchema.getReference(schemaName);\r\n  if (referencedSchema !== undefined) {\r\n    return resolveSchemaItemKey(context.editor.schemaContext, new SchemaItemKey(itemName, referencedSchema.schemaKey));\r\n  }\r\n\r\n  throw new Error(`Cannot locate referenced schema item ${reference}`);\r\n}\r\n\r\n/**\r\n * To support case insensitivity for schema items, the given key is checked if there\r\n * exists an item for it.\r\n * @internal\r\n */\r\nasync function resolveSchemaItemKey(schemaContext: SchemaContext, itemKey: SchemaItemKey): Promise<SchemaItemKey> {\r\n  const item = await schemaContext.getSchemaItem(itemKey);\r\n  if (item === undefined) {\r\n    // If the schema item hasn't been created yet, we have to trust the given key is correctly spelled.\r\n    return itemKey;\r\n  }\r\n  return item.key;\r\n}\r\n"]}
+{"version":3,"file":"SchemaItemMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaItemMerger.ts"],"names":[],"mappings":";;;AAMA,gEAAqH;AACrH,2DAA0E;AAC1E,yDAAsD;AACtD,qEAAkE;AAClE,yDAAsD;AACtD,iEAA8D;AAC9D,qDAAkD;AAClD,+CAAgD;AAChD,+CAA+C;AAU/C;;;GAGG;AACH,KAAK,UAAU,eAAe,CAAkE,OAA2B,EAAE,UAAa,EAAE,MAAkC;IAC5K,IAAI,UAAU,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QACpC,MAAM,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACtC,OAAO;IACT,CAAC;IAED,IAAI,UAAU,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;QAC/F,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,+BAA+B,UAAU,CAAC,UAAU,OAAO,UAAU,CAAC,UAAU,GAAG,CAAC,CAAC;AACvG,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB,CAAC,OAA2B,EAAE,QAAgB,EAAE,UAAkB;IACtG,MAAM,aAAa,GAAG,IAAI,iCAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACnF,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,GAAG,UAAU,IAAI,aAAa,CAAC,QAAQ,+BAA+B,CAAC,CAAC;IAClI,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AARD,4CAQC;AAED;;;;;;;GAOG;AACI,KAAK,SAAS,CAAC,CAAC,gBAAgB,CAAC,OAA2B,EAAE,WAAkC;IACrG,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC1E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,mCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,EAAE,CAAC;QAChF,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,+CAAsB,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE,CAAC;QAC3E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,qCAAiB,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC1E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,oCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC1E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,mCAAgB,CAAC,CAAC;IACrE,CAAC;IAED,QAAQ;IACR,uFAAuF;IACvF,SAAS;IACT,kBAAkB;IAClB,WAAW;IAEX,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAC9E,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,2CAAoB,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACxE,MAAM,MAAM,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,+BAAc,CAAC,CAAC;IACnE,CAAC;IAED,uFAAuF;IACvF,gCAAgC;IAChC,IAAI,KAAK,EAAE,MAAM,gBAAgB,IAAI,IAAA,6BAAe,EAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;QAC3E,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,4CAwCC;AAED;;;GAGG;AACI,KAAK,UAAU,wBAAwB,CAAC,OAA2B,EAAE,SAAiB;IAC3F,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACpE,OAAO,aAAa,CAAC,QAAQ,CAAC;AAChC,CAAC;AAHD,4DAGC;AAED;;;;GAIG;AACI,KAAK,UAAU,mBAAmB,CAAC,OAA2B,EAAE,SAAiB;IACtF,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,8BAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACnE,IAAI,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;QACtD,OAAO,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,iCAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;IAClH,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IAC7E,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,iCAAa,CAAC,QAAQ,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;IACrH,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC;AACvE,CAAC;AAZD,kDAYC;AAED;;;;GAIG;AACH,KAAK,UAAU,oBAAoB,CAAC,aAA4B,EAAE,OAAsB;IACtF,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACxD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,mGAAmG;QACnG,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC;AAClB,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\nimport type { SchemaMergeContext } from \"./SchemaMerger\";\r\nimport { AnySchemaDifference, AnySchemaItemDifference, AnySchemaItemPathDifference } from \"../Differencing/SchemaDifference\";\r\nimport { ECObjectsError, ECObjectsStatus, SchemaContext, SchemaItem, SchemaItemKey } from \"@itwin/ecschema-metadata\";\r\nimport { enumerationMerger, enumeratorMerger } from \"./EnumerationMerger\";\r\nimport { phenomenonMerger } from \"./PhenomenonMerger\";\r\nimport { propertyCategoryMerger } from \"./PropertyCategoryMerger\";\r\nimport { unitSystemMerger } from \"./UnitSystemMerger\";\r\nimport { kindOfQuantityMerger } from \"./KindOfQuantityMerger\";\r\nimport { constantMerger } from \"./ConstantMerger\";\r\nimport { mergeClassItems } from \"./ClassMerger\";\r\nimport * as Utils from \"../Differencing/Utils\";\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaItemMergerHandler<T extends AnySchemaItemDifference | AnySchemaItemPathDifference> {\r\n  add: (context: SchemaMergeContext, difference: T) => Promise<SchemaItemKey>;\r\n  modify: (context: SchemaMergeContext, difference: T, itemKey: SchemaItemKey, item: any) => Promise<void>;\r\n}\r\n\r\n/**\r\n * Handles the merging logic for everything that is same for all schema items such as labels or descriptions\r\n * @internal\r\n */\r\nasync function mergeSchemaItem<T extends AnySchemaItemDifference | AnySchemaItemPathDifference>(context: SchemaMergeContext, difference: T, merger: SchemaItemMergerHandler<T>): Promise<void> {\r\n  if (difference.changeType === \"add\") {\r\n    await merger.add(context, difference);\r\n    return;\r\n  }\r\n\r\n  if (difference.changeType === \"modify\") {\r\n    const schemaItem = await locateSchemaItem(context, difference.itemName, difference.schemaType);\r\n    return merger.modify(context, difference, schemaItem.key, schemaItem);\r\n  }\r\n\r\n  throw new Error(`The merger does not support ${difference.changeType} of ${difference.schemaType}.`);\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport async function locateSchemaItem(context: SchemaMergeContext, itemName: string, schemaType: string) {\r\n  const schemaItemKey = new SchemaItemKey(itemName, context.targetSchemaKey);\r\n  const schemaItem = await context.editor.schemaContext.getSchemaItem(schemaItemKey);\r\n  if (schemaItem === undefined) {\r\n    throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `${schemaType} ${schemaItemKey.fullName} not found in schema context.`);\r\n  }\r\n\r\n  return schemaItem;\r\n}\r\n\r\n/**\r\n * Merges the given set of schema items. As schema items may depend or relate with other\r\n * schema items, the list gets filtered to ensure the items get merged in a certain order.\r\n * @param context       The current merging context.\r\n * @param differences   Set of schema item that differed.\r\n * @returns             An async iterable with the merge result for each schema item.\r\n * @internal\r\n */\r\nexport async function* mergeSchemaItems(context: SchemaMergeContext, differences: AnySchemaDifference[]) {\r\n  for (const difference of differences.filter(Utils.isUnitSystemDifference)) {\r\n    yield await mergeSchemaItem(context, difference, unitSystemMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isPropertyCategoryDifference)) {\r\n    yield await mergeSchemaItem(context, difference, propertyCategoryMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isEnumerationDifference)) {\r\n    yield await mergeSchemaItem(context, difference, enumerationMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isEnumeratorDifference)) {\r\n    yield await mergeSchemaItem(context, difference, enumeratorMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isPhenomenonDifference)) {\r\n    yield await mergeSchemaItem(context, difference, phenomenonMerger);\r\n  }\r\n\r\n  // TODO:\r\n  // The following schema items are not supported yet. Mentioned in the processing order:\r\n  // - Unit\r\n  // - Inverted Unit\r\n  // - Format\r\n\r\n  for (const difference of differences.filter(Utils.isKindOfQuantityDifference)) {\r\n    yield await mergeSchemaItem(context, difference, kindOfQuantityMerger);\r\n  }\r\n\r\n  for (const difference of differences.filter(Utils.isConstantDifference)) {\r\n    yield await mergeSchemaItem(context, difference, constantMerger);\r\n  }\r\n\r\n  // Classes are slightly differently merged, since they can refer each other the process\r\n  // uses several stages to merge.\r\n  for await (const classMergeResult of mergeClassItems(context, differences)) {\r\n    yield classMergeResult;\r\n  }\r\n}\r\n\r\n/**\r\n * Convenience-method around updateSchemaItemKey that returns the full name instead of a SchemaItemKey.\r\n * @internal\r\n */\r\nexport async function updateSchemaItemFullName(context: SchemaMergeContext, reference: string) {\r\n  const schemaItemKey = await updateSchemaItemKey(context, reference);\r\n  return schemaItemKey.fullName;\r\n}\r\n\r\n/**\r\n * Updates the given reference if it refers to a SchemaItem in the source Schema and\r\n * returns a SchemaItemKey. If any other schema is referred the reference is not change.\r\n * @internal\r\n */\r\nexport async function updateSchemaItemKey(context: SchemaMergeContext, reference: string) {\r\n  const [schemaName, itemName] = SchemaItem.parseFullName(reference);\r\n  if (context.sourceSchemaKey.compareByName(schemaName)) {\r\n    return resolveSchemaItemKey(context.editor.schemaContext, new SchemaItemKey(itemName, context.targetSchemaKey));\r\n  }\r\n\r\n  const referencedSchema = await context.targetSchema.getReference(schemaName);\r\n  if (referencedSchema !== undefined) {\r\n    return resolveSchemaItemKey(context.editor.schemaContext, new SchemaItemKey(itemName, referencedSchema.schemaKey));\r\n  }\r\n\r\n  throw new Error(`Cannot locate referenced schema item ${reference}`);\r\n}\r\n\r\n/**\r\n * To support case insensitivity for schema items, the given key is checked if there\r\n * exists an item for it.\r\n * @internal\r\n */\r\nasync function resolveSchemaItemKey(schemaContext: SchemaContext, itemKey: SchemaItemKey): Promise<SchemaItemKey> {\r\n  const item = await schemaContext.getSchemaItem(itemKey);\r\n  if (item === undefined) {\r\n    // If the schema item hasn't been created yet, we have to trust the given key is correctly spelled.\r\n    return itemKey;\r\n  }\r\n  return item.key;\r\n}\r\n"]}

package/lib/cjs/Merging/SchemaMerger.d.ts

@@ -3,7 +3,8 @@
  */
 import { Schema, type SchemaContext, SchemaKey } from "@itwin/ecschema-metadata";
 import { SchemaContextEditor } from "../Editing/Editor";
-import { SchemaDifferences } from "../Differencing/SchemaDifference";
+import { type SchemaDifferenceResult } from "../Differencing/SchemaDifference";
+import { type SchemaEdits } from "./Edits/SchemaEdits";
 /**
  * Defines the context of a Schema merging run.
  * @internal
@@ -16,7 +17,7 @@ export interface SchemaMergeContext {
 }
 /**
  * Class to merge two schemas together.
- * @see [[merge]] to merge the schemas.
+ * @see [[merge]] or [[mergeSchemas]] to merge two schemas together.
  * @beta
  */
 export declare class SchemaMerger {
@@ -30,21 +31,17 @@ export declare class SchemaMerger {
      * Copy the SchemaItems of the source schemas to the target schema.
      * @param targetSchema  The schema the SchemaItems gets merged to.
      * @param sourceSchema  The schema the SchemaItems gets copied from.
+     * @param edits         An optional instance of schema edits that shall be applied before the schemas get merged.
      * @returns             The merged target schema.
+     * @alpha
      */
-    merge(targetSchema: Schema, sourceSchema: Schema): Promise<Schema>;
+    mergeSchemas(targetSchema: Schema, sourceSchema: Schema, edits?: SchemaEdits): Promise<Schema>;
     /**
      * Merges the schema differences into the target schema context.
-     * @param differences   The changes that shall be applied to the target schema.
+     * @param differenceResult  The differences that shall be applied to the target schema.
+     * @param edits             An optional instance of schema edits that shall be applied before the schemas get merged.
      * @alpha
      */
-    merge(differences: SchemaDifferences): Promise<Schema>;
-    /**
-     * Merges the schema differences in the target schema. The target schema is defined
-     * in the given differences object.
-     * @param differences   The differences between a source schema and the target schema.
-     * @returns             The modified Schema.
-     */
-    private mergeSchemas;
+    merge(differenceResult: SchemaDifferenceResult, edits?: SchemaEdits): Promise<Schema>;
 }
 //# sourceMappingURL=SchemaMerger.d.ts.map

package/lib/cjs/Merging/SchemaMerger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaMerger.d.ts","sourceRoot":"","sources":["../../../src/Merging/SchemaMerger.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAoB,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAKvF;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC;IACpC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;CACtC;AAED;;;;GAIG;AACH,qBAAa,YAAY;IAEvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C;;;OAGG;gBACS,cAAc,EAAE,aAAa;IAIzC;;;;;OAKG;IACI,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAEzE;;;;OAIG;IACI,KAAK,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IAsB7D;;;;;OAKG;YACW,YAAY;CAmD3B"}
+{"version":3,"file":"SchemaMerger.d.ts","sourceRoot":"","sources":["../../../src/Merging/SchemaMerger.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAExD,OAAO,EAAyE,KAAK,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AACtJ,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAMvD;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC;IACpC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;CACtC;AAED;;;;GAIG;AACH,qBAAa,YAAY;IAEvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C;;;OAGG;gBACS,cAAc,EAAE,aAAa;IAIzC;;;;;;;OAOG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAI3G;;;;;OAKG;IACU,KAAK,CAAC,gBAAgB,EAAE,sBAAsB,EAAE,KAAK,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;CAmCnG"}

package/lib/cjs/Merging/SchemaMerger.js

@@ -15,9 +15,10 @@ const SchemaDifference_1 = require("../Differencing/SchemaDifference");
 const CustomAttributeMerger_1 = require("./CustomAttributeMerger");
 const SchemaItemMerger_1 = require("./SchemaItemMerger");
 const SchemaReferenceMerger_1 = require("./SchemaReferenceMerger");
+const Utils = require("../Differencing/Utils");
 /**
  * Class to merge two schemas together.
- * @see [[merge]] to merge the schemas.
+ * @see [[merge]] or [[mergeSchemas]] to merge two schemas together.
  * @beta
  */
 class SchemaMerger {
@@ -29,78 +30,81 @@ class SchemaMerger {
         this._editor = new Editor_1.SchemaContextEditor(editingContext);
     }
     /**
-     * Merges the source and the target. If the target is a SchemaDifference, the
-     * source parameter must not be set. If it's a schema, it'll internally call
-     * the Differencing api and recall itself with the difference argument overload.
-     * @param input   The methods input either a schema or a SchemaDifferences
-     * @param source  A source schema.
-     * @returns       The merged schema.
+     * Copy the SchemaItems of the source schemas to the target schema.
+     * @param targetSchema  The schema the SchemaItems gets merged to.
+     * @param sourceSchema  The schema the SchemaItems gets copied from.
+     * @param edits         An optional instance of schema edits that shall be applied before the schemas get merged.
+     * @returns             The merged target schema.
      * @alpha
      */
-    async merge(input, source) {
-        if (ecschema_metadata_1.Schema.isSchema(input)) {
-            if (source === undefined) {
-                throw new Error("When merging two schemas, source must not be undefined.");
-            }
-            return this.merge(await SchemaDifference_1.SchemaDifference.fromSchemas(input, source));
-        }
-        return this.mergeSchemas(input);
+    async mergeSchemas(targetSchema, sourceSchema, edits) {
+        return this.merge(await (0, SchemaDifference_1.getSchemaDifferences)(targetSchema, sourceSchema), edits);
     }
     /**
-     * Merges the schema differences in the target schema. The target schema is defined
-     * in the given differences object.
-     * @param differences   The differences between a source schema and the target schema.
-     * @returns             The modified Schema.
+     * Merges the schema differences into the target schema context.
+     * @param differenceResult  The differences that shall be applied to the target schema.
+     * @param edits             An optional instance of schema edits that shall be applied before the schemas get merged.
+     * @alpha
      */
-    async mergeSchemas(differences) {
-        const targetSchemaKey = ecschema_metadata_1.SchemaKey.parseString(differences.targetSchemaName);
-        const sourceSchemaKey = ecschema_metadata_1.SchemaKey.parseString(differences.sourceSchemaName);
-        if (differences.conflicts && differences.conflicts.length > 0) {
-            throw new Errors_1.SchemaConflictsError("Schema's can't be merged if there are unresolved conflicts.", differences.conflicts, sourceSchemaKey, targetSchemaKey);
+    async merge(differenceResult, edits) {
+        const targetSchemaKey = ecschema_metadata_1.SchemaKey.parseString(differenceResult.targetSchemaName);
+        const sourceSchemaKey = ecschema_metadata_1.SchemaKey.parseString(differenceResult.sourceSchemaName);
+        // If schema changes were provided, they'll get applied and a new SchemaDifferenceResult is returned
+        // to prevent altering the differenceResult the caller passed in.
+        if (edits) {
+            await edits.applyTo(differenceResult = { ...differenceResult });
+        }
+        if (differenceResult.conflicts && differenceResult.conflicts.length > 0) {
+            throw new Errors_1.SchemaConflictsError("Schema's can't be merged if there are unresolved conflicts.", differenceResult.conflicts, sourceSchemaKey, targetSchemaKey);
         }
         const schema = await this._editor.getSchema(targetSchemaKey);
         if (schema === undefined) {
             throw new Error(`The target schema '${targetSchemaKey.name}' could not be found in the editing context.`);
         }
-        if (differences.differences === undefined || differences.differences.length === 0) {
-            return schema;
-        }
         const context = {
             editor: this._editor,
             targetSchema: schema,
             targetSchemaKey,
             sourceSchemaKey,
         };
-        for (const referenceChange of differences.differences.filter(SchemaDifference_1.SchemaDifference.isSchemaReferenceDifference)) {
-            await (0, SchemaReferenceMerger_1.mergeSchemaReferences)(context, referenceChange);
-        }
-        const schemaDifference = differences.differences.find(SchemaDifference_1.SchemaDifference.isSchemaDifference);
-        if (schemaDifference !== undefined) {
-            await mergeSchemaProperties(schema, schemaDifference);
-        }
-        // Filter a list of possible schema item changes. This list gets filtered and order in the
-        // mergeSchemaItems method.
-        for await (const _mergeResult of (0, SchemaItemMerger_1.mergeSchemaItems)(context, differences.differences)) {
-        }
-        // At last the custom attributes gets merged because it could be that the CustomAttributes
-        // depend on classes that has to get merged in as items before.
-        for (const customAttributeChange of differences.differences.filter(SchemaDifference_1.SchemaDifference.isCustomAttributeDifference)) {
-            await (0, CustomAttributeMerger_1.mergeCustomAttribute)(context, customAttributeChange);
-        }
+        await mergeSchemaDifferences(context, differenceResult.differences);
         return schema;
     }
 }
 exports.SchemaMerger = SchemaMerger;
+/**
+ * Merges the schema differences in the target schema.
+ * @param context       The current merging context.
+ * @param differences   The differences between a source schema and the target schema.
+ * @internal
+ */
+async function mergeSchemaDifferences(context, differences) {
+    for (const referenceDifference of differences.filter(Utils.isSchemaReferenceDifference)) {
+        await (0, SchemaReferenceMerger_1.mergeSchemaReferences)(context, referenceDifference);
+    }
+    for (const schemaDifference of differences.filter(Utils.isSchemaDifference)) {
+        await mergeSchemaProperties(context, schemaDifference);
+    }
+    // Filter a list of possible schema item changes. This list gets filtered and order in the
+    // mergeSchemaItems method.
+    for await (const _mergeResult of (0, SchemaItemMerger_1.mergeSchemaItems)(context, differences)) {
+    }
+    // At last the custom attributes gets merged because it could be that the CustomAttributes
+    // depend on classes that has to get merged in as items before.
+    for (const customAttributeDifference of differences.filter(Utils.isCustomAttributeDifference)) {
+        await (0, CustomAttributeMerger_1.mergeCustomAttribute)(context, customAttributeDifference);
+    }
+}
 /**
  * Sets the editable properties of a Schema.
  * @internal
  */
-async function mergeSchemaProperties(schema, changes) {
-    if (changes.difference.label !== undefined) {
-        schema.setDisplayLabel(changes.difference.label);
+async function mergeSchemaProperties(context, { difference }) {
+    if (difference.label !== undefined) {
+        await context.editor.setDisplayLabel(context.targetSchemaKey, difference.label);
     }
-    if (changes.difference.description !== undefined) {
-        schema.setDescription(changes.difference.description);
+    if (difference.description !== undefined) {
+        await context.editor.setDescription(context.targetSchemaKey, difference.description);
     }
 }
 //# sourceMappingURL=SchemaMerger.js.map

package/lib/cjs/Merging/SchemaMerger.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaMerger.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,gEAAiF;AACjF,8CAAwD;AACxD,mDAA8D;AAC9D,uEAAuF;AACvF,mEAA+D;AAC/D,yDAAsD;AACtD,mEAAgE;AAahE;;;;GAIG;AACH,MAAa,YAAY;IAIvB;;;OAGG;IACH,YAAY,cAA6B;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,4BAAmB,CAAC,cAAc,CAAC,CAAC;IACzD,CAAC;IAiBD;;;;;;;;OAQG;IACI,KAAK,CAAC,KAAK,CAAC,KAAiC,EAAE,MAAe;QACnE,IAAG,0BAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAG,MAAM,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;YAC7E,CAAC;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,mCAAgB,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;QACvE,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,YAAY,CAAC,WAA8B;QACvD,MAAM,eAAe,GAAG,6BAAS,CAAC,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC5E,MAAM,eAAe,GAAG,6BAAS,CAAC,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAE5E,IAAG,WAAW,CAAC,SAAS,IAAI,WAAW,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7D,MAAM,IAAI,6BAAoB,CAC5B,6DAA6D,EAC7D,WAAW,CAAC,SAAS,EACrB,eAAe,EACf,eAAe,CAChB,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,sBAAsB,eAAe,CAAC,IAAI,8CAA8C,CAAC,CAAC;QAC5G,CAAC;QAED,IAAG,WAAW,CAAC,WAAW,KAAK,SAAS,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjF,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,OAAO,GAAuB;YAClC,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,YAAY,EAAE,MAAM;YACpB,eAAe;YACf,eAAe;SAChB,CAAC;QAEF,KAAK,MAAM,eAAe,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,2BAA2B,CAAC,EAAE,CAAC;YAC3G,MAAM,IAAA,6CAAqB,EAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,gBAAgB,GAAG,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,mCAAgB,CAAC,kBAAkB,CAAC,CAAC;QAC3F,IAAG,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAClC,MAAM,qBAAqB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACxD,CAAC;QAED,0FAA0F;QAC1F,2BAA2B;QAC3B,IAAI,KAAK,EAAE,MAAM,YAAY,IAAI,IAAA,mCAAgB,EAAC,OAAO,EAAE,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;QACtF,CAAC;QAED,0FAA0F;QAC1F,+DAA+D;QAC/D,KAAK,MAAM,qBAAqB,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,mCAAgB,CAAC,2BAA2B,CAAC,EAAE,CAAC;YACjH,MAAM,IAAA,4CAAoB,EAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAxGD,oCAwGC;AAED;;;GAGG;AACH,KAAK,UAAU,qBAAqB,CAAC,MAAqB,EAAE,OAAyB;IACnF,IAAG,OAAO,CAAC,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IACD,IAAG,OAAO,CAAC,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IACxD,CAAC;AACH,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 Merging\r\n */\r\n\r\nimport { MutableSchema } from \"../Editing/Mutable/MutableSchema\";\r\nimport { Schema, type SchemaContext, SchemaKey } from \"@itwin/ecschema-metadata\";\r\nimport { SchemaContextEditor } from \"../Editing/Editor\";\r\nimport { SchemaConflictsError } from \"../Differencing/Errors\";\r\nimport { SchemaDifference, SchemaDifferences } from \"../Differencing/SchemaDifference\";\r\nimport { mergeCustomAttribute } from \"./CustomAttributeMerger\";\r\nimport { mergeSchemaItems } from \"./SchemaItemMerger\";\r\nimport { mergeSchemaReferences } from \"./SchemaReferenceMerger\";\r\n\r\n/**\r\n * Defines the context of a Schema merging run.\r\n * @internal\r\n */\r\nexport interface SchemaMergeContext {\r\n  readonly targetSchema: Schema;\r\n  readonly targetSchemaKey: SchemaKey;\r\n  readonly sourceSchemaKey: SchemaKey;\r\n  readonly editor: SchemaContextEditor;\r\n}\r\n\r\n/**\r\n * Class to merge two schemas together.\r\n * @see [[merge]] to merge the schemas.\r\n * @beta\r\n */\r\nexport class SchemaMerger {\r\n\r\n  private readonly _editor: SchemaContextEditor;\r\n\r\n  /**\r\n   * Constructs a new instance of the SchemaMerger object.\r\n   * @param editingContext  The schema contexts that holds the schema to be edited.\r\n   */\r\n  constructor(editingContext: SchemaContext) {\r\n    this._editor = new SchemaContextEditor(editingContext);\r\n  }\r\n\r\n  /**\r\n   * Copy the SchemaItems of the source schemas to the target schema.\r\n   * @param targetSchema  The schema the SchemaItems gets merged to.\r\n   * @param sourceSchema  The schema the SchemaItems gets copied from.\r\n   * @returns             The merged target schema.\r\n   */\r\n  public merge(targetSchema: Schema, sourceSchema: Schema): Promise<Schema>;\r\n\r\n  /**\r\n   * Merges the schema differences into the target schema context.\r\n   * @param differences   The changes that shall be applied to the target schema.\r\n   * @alpha\r\n   */\r\n  public merge(differences: SchemaDifferences): Promise<Schema>;\r\n\r\n  /**\r\n   * Merges the source and the target. If the target is a SchemaDifference, the\r\n   * source parameter must not be set. If it's a schema, it'll internally call\r\n   * the Differencing api and recall itself with the difference argument overload.\r\n   * @param input   The methods input either a schema or a SchemaDifferences\r\n   * @param source  A source schema.\r\n   * @returns       The merged schema.\r\n   * @alpha\r\n   */\r\n  public async merge(input: SchemaDifferences | Schema, source?: Schema): Promise<Schema> {\r\n    if(Schema.isSchema(input)) {\r\n      if(source === undefined) {\r\n        throw new Error(\"When merging two schemas, source must not be undefined.\");\r\n      }\r\n      return this.merge(await SchemaDifference.fromSchemas(input, source));\r\n    }\r\n\r\n    return this.mergeSchemas(input);\r\n  }\r\n\r\n  /**\r\n   * Merges the schema differences in the target schema. The target schema is defined\r\n   * in the given differences object.\r\n   * @param differences   The differences between a source schema and the target schema.\r\n   * @returns             The modified Schema.\r\n   */\r\n  private async mergeSchemas(differences: SchemaDifferences): Promise<Schema> {\r\n    const targetSchemaKey = SchemaKey.parseString(differences.targetSchemaName);\r\n    const sourceSchemaKey = SchemaKey.parseString(differences.sourceSchemaName);\r\n\r\n    if(differences.conflicts && differences.conflicts.length > 0) {\r\n      throw new SchemaConflictsError(\r\n        \"Schema's can't be merged if there are unresolved conflicts.\",\r\n        differences.conflicts,\r\n        sourceSchemaKey,\r\n        targetSchemaKey,\r\n      );\r\n    }\r\n\r\n    const schema = await this._editor.getSchema(targetSchemaKey);\r\n    if (schema === undefined) {\r\n      throw new Error(`The target schema '${targetSchemaKey.name}' could not be found in the editing context.`);\r\n    }\r\n\r\n    if(differences.differences === undefined || differences.differences.length === 0) {\r\n      return schema;\r\n    }\r\n\r\n    const context: SchemaMergeContext = {\r\n      editor: this._editor,\r\n      targetSchema: schema,\r\n      targetSchemaKey,\r\n      sourceSchemaKey,\r\n    };\r\n\r\n    for (const referenceChange of differences.differences.filter(SchemaDifference.isSchemaReferenceDifference)) {\r\n      await mergeSchemaReferences(context, referenceChange);\r\n    }\r\n\r\n    const schemaDifference = differences.differences.find(SchemaDifference.isSchemaDifference);\r\n    if(schemaDifference !== undefined) {\r\n      await mergeSchemaProperties(schema, schemaDifference);\r\n    }\r\n\r\n    // Filter a list of possible schema item changes. This list gets filtered and order in the\r\n    // mergeSchemaItems method.\r\n    for await (const _mergeResult of mergeSchemaItems(context, differences.differences)) {\r\n    }\r\n\r\n    // At last the custom attributes gets merged because it could be that the CustomAttributes\r\n    // depend on classes that has to get merged in as items before.\r\n    for (const customAttributeChange of differences.differences.filter(SchemaDifference.isCustomAttributeDifference)) {\r\n      await mergeCustomAttribute(context, customAttributeChange);\r\n    }\r\n\r\n    return schema;\r\n  }\r\n}\r\n\r\n/**\r\n * Sets the editable properties of a Schema.\r\n * @internal\r\n */\r\nasync function mergeSchemaProperties(schema: MutableSchema, changes: SchemaDifference) {\r\n  if(changes.difference.label !== undefined) {\r\n    schema.setDisplayLabel(changes.difference.label);\r\n  }\r\n  if(changes.difference.description !== undefined) {\r\n    schema.setDescription(changes.difference.description);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SchemaMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaMerger.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAAiF;AACjF,8CAAwD;AACxD,mDAA8D;AAC9D,uEAAsJ;AAEtJ,mEAA+D;AAC/D,yDAAsD;AACtD,mEAAgE;AAChE,+CAA+C;AAa/C;;;;GAIG;AACH,MAAa,YAAY;IAIvB;;;OAGG;IACH,YAAY,cAA6B;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,4BAAmB,CAAC,cAAc,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,YAAY,CAAC,YAAoB,EAAE,YAAoB,EAAE,KAAmB;QACvF,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,IAAA,uCAAoB,EAAC,YAAY,EAAE,YAAY,CAAC,EAAE,KAAK,CAAC,CAAC;IACnF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,gBAAwC,EAAE,KAAmB;QAC9E,MAAM,eAAe,GAAG,6BAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QACjF,MAAM,eAAe,GAAG,6BAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAEjF,oGAAoG;QACpG,iEAAiE;QACjE,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,OAAO,CAAC,gBAAgB,GAAG,EAAE,GAAG,gBAAgB,EAAE,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,gBAAgB,CAAC,SAAS,IAAI,gBAAgB,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,MAAM,IAAI,6BAAoB,CAC5B,6DAA6D,EAC7D,gBAAgB,CAAC,SAAS,EAC1B,eAAe,EACf,eAAe,CAChB,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,sBAAsB,eAAe,CAAC,IAAI,8CAA8C,CAAC,CAAC;QAC5G,CAAC;QAED,MAAM,OAAO,GAAuB;YAClC,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,YAAY,EAAE,MAAM;YACpB,eAAe;YACf,eAAe;SAChB,CAAC;QAEF,MAAM,sBAAsB,CAAC,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAEpE,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAjED,oCAiEC;AAED;;;;;GAKG;AACH,KAAK,UAAU,sBAAsB,CAAC,OAA2B,EAAE,WAAkC;IACnG,KAAK,MAAM,mBAAmB,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,EAAE,CAAC;QACxF,MAAM,IAAA,6CAAqB,EAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,MAAM,gBAAgB,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC5E,MAAM,qBAAqB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACzD,CAAC;IAED,0FAA0F;IAC1F,2BAA2B;IAC3B,IAAI,KAAK,EAAE,MAAM,YAAY,IAAI,IAAA,mCAAgB,EAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;IAC1E,CAAC;IAED,0FAA0F;IAC1F,+DAA+D;IAC/D,KAAK,MAAM,yBAAyB,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,EAAE,CAAC;QAC9F,MAAM,IAAA,4CAAoB,EAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;IACjE,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,qBAAqB,CAAC,OAA2B,EAAE,EAAE,UAAU,EAAoB;IAChG,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAClF,CAAC;IACD,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IACvF,CAAC;AACH,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 Merging\r\n */\r\n\r\nimport { Schema, type SchemaContext, SchemaKey } from \"@itwin/ecschema-metadata\";\r\nimport { SchemaContextEditor } from \"../Editing/Editor\";\r\nimport { SchemaConflictsError } from \"../Differencing/Errors\";\r\nimport { type AnySchemaDifference, getSchemaDifferences, type SchemaDifference, type SchemaDifferenceResult } from \"../Differencing/SchemaDifference\";\r\nimport { type SchemaEdits } from \"./Edits/SchemaEdits\";\r\nimport { mergeCustomAttribute } from \"./CustomAttributeMerger\";\r\nimport { mergeSchemaItems } from \"./SchemaItemMerger\";\r\nimport { mergeSchemaReferences } from \"./SchemaReferenceMerger\";\r\nimport * as Utils from \"../Differencing/Utils\";\r\n\r\n/**\r\n * Defines the context of a Schema merging run.\r\n * @internal\r\n */\r\nexport interface SchemaMergeContext {\r\n  readonly targetSchema: Schema;\r\n  readonly targetSchemaKey: SchemaKey;\r\n  readonly sourceSchemaKey: SchemaKey;\r\n  readonly editor: SchemaContextEditor;\r\n}\r\n\r\n/**\r\n * Class to merge two schemas together.\r\n * @see [[merge]] or [[mergeSchemas]] to merge two schemas together.\r\n * @beta\r\n */\r\nexport class SchemaMerger {\r\n\r\n  private readonly _editor: SchemaContextEditor;\r\n\r\n  /**\r\n   * Constructs a new instance of the SchemaMerger object.\r\n   * @param editingContext  The schema contexts that holds the schema to be edited.\r\n   */\r\n  constructor(editingContext: SchemaContext) {\r\n    this._editor = new SchemaContextEditor(editingContext);\r\n  }\r\n\r\n  /**\r\n   * Copy the SchemaItems of the source schemas to the target schema.\r\n   * @param targetSchema  The schema the SchemaItems gets merged to.\r\n   * @param sourceSchema  The schema the SchemaItems gets copied from.\r\n   * @param edits         An optional instance of schema edits that shall be applied before the schemas get merged.\r\n   * @returns             The merged target schema.\r\n   * @alpha\r\n   */\r\n  public async mergeSchemas(targetSchema: Schema, sourceSchema: Schema, edits?: SchemaEdits): Promise<Schema> {\r\n    return this.merge(await getSchemaDifferences(targetSchema, sourceSchema), edits);\r\n  }\r\n\r\n  /**\r\n   * Merges the schema differences into the target schema context.\r\n   * @param differenceResult  The differences that shall be applied to the target schema.\r\n   * @param edits             An optional instance of schema edits that shall be applied before the schemas get merged.\r\n   * @alpha\r\n   */\r\n  public async merge(differenceResult: SchemaDifferenceResult, edits?: SchemaEdits): Promise<Schema> {\r\n    const targetSchemaKey = SchemaKey.parseString(differenceResult.targetSchemaName);\r\n    const sourceSchemaKey = SchemaKey.parseString(differenceResult.sourceSchemaName);\r\n\r\n    // If schema changes were provided, they'll get applied and a new SchemaDifferenceResult is returned\r\n    // to prevent altering the differenceResult the caller passed in.\r\n    if (edits) {\r\n      await edits.applyTo(differenceResult = { ...differenceResult });\r\n    }\r\n\r\n    if (differenceResult.conflicts && differenceResult.conflicts.length > 0) {\r\n      throw new SchemaConflictsError(\r\n        \"Schema's can't be merged if there are unresolved conflicts.\",\r\n        differenceResult.conflicts,\r\n        sourceSchemaKey,\r\n        targetSchemaKey,\r\n      );\r\n    }\r\n\r\n    const schema = await this._editor.getSchema(targetSchemaKey);\r\n    if (schema === undefined) {\r\n      throw new Error(`The target schema '${targetSchemaKey.name}' could not be found in the editing context.`);\r\n    }\r\n\r\n    const context: SchemaMergeContext = {\r\n      editor: this._editor,\r\n      targetSchema: schema,\r\n      targetSchemaKey,\r\n      sourceSchemaKey,\r\n    };\r\n\r\n    await mergeSchemaDifferences(context, differenceResult.differences);\r\n\r\n    return schema;\r\n  }\r\n}\r\n\r\n/**\r\n * Merges the schema differences in the target schema.\r\n * @param context       The current merging context.\r\n * @param differences   The differences between a source schema and the target schema.\r\n * @internal\r\n */\r\nasync function mergeSchemaDifferences(context: SchemaMergeContext, differences: AnySchemaDifference[]): Promise<void> {\r\n  for (const referenceDifference of differences.filter(Utils.isSchemaReferenceDifference)) {\r\n    await mergeSchemaReferences(context, referenceDifference);\r\n  }\r\n\r\n  for (const schemaDifference of differences.filter(Utils.isSchemaDifference)) {\r\n    await mergeSchemaProperties(context, schemaDifference);\r\n  }\r\n\r\n  // Filter a list of possible schema item changes. This list gets filtered and order in the\r\n  // mergeSchemaItems method.\r\n  for await (const _mergeResult of mergeSchemaItems(context, differences)) {\r\n  }\r\n\r\n  // At last the custom attributes gets merged because it could be that the CustomAttributes\r\n  // depend on classes that has to get merged in as items before.\r\n  for (const customAttributeDifference of differences.filter(Utils.isCustomAttributeDifference)) {\r\n    await mergeCustomAttribute(context, customAttributeDifference);\r\n  }\r\n}\r\n\r\n/**\r\n * Sets the editable properties of a Schema.\r\n * @internal\r\n */\r\nasync function mergeSchemaProperties(context: SchemaMergeContext, { difference }: SchemaDifference) {\r\n  if (difference.label !== undefined) {\r\n    await context.editor.setDisplayLabel(context.targetSchemaKey, difference.label);\r\n  }\r\n  if (difference.description !== undefined) {\r\n    await context.editor.setDescription(context.targetSchemaKey, difference.description);\r\n  }\r\n}\r\n"]}

package/lib/cjs/Validation/SchemaCompareVisitor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaCompareVisitor.d.ts","sourceRoot":"","sources":["../../../src/Validation/SchemaCompareVisitor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,oBAAoB,EAAE,6BAA6B,EAClF,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,kBAAkB,EAAE,cAAc,EAAE,KAAK,EAClG,UAAU,EAAY,gBAAgB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,EAAE,UAAU,EACrF,WAAW,EAAE,IAAI,EAAE,UAAU,EAC9C,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;GAGG;AACH,qBAAa,oBAAqB,YAAW,kBAAkB;IAC7D,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,eAAe,CAAkB;IAEzC;;;;OAIG;gBACS,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM;IAKpE;;;OAGG;IACU,eAAe,CAAC,OAAO,EAAE,MAAM;IAI5C;;;OAGG;IACU,eAAe,CAAC,WAAW,EAAE,UAAU;IAKpD;;;OAGG;IACU,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxD;;;OAGG;IACU,aAAa,CAAC,SAAS,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAUjE;;;OAGG;IACU,gBAAgB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAKlE;;;OAGG;IACU,gBAAgB,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAInE;;;OAGG;IACU,UAAU,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD;;;OAGG;IACU,sBAAsB,CAAC,aAAa,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpF;;;OAGG;IACU,2BAA2B,CAAC,WAAW,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ5F;;;OAGG;IACU,yBAAyB,CAAC,gBAAgB,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7F;;;OAGG;IACU,6BAA6B,CAAC,UAAU,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBpG;;;OAGG;IACU,gBAAgB,CAAC,KAAK,EAAE,WAAW;IAMhD;;;OAGG;IACU,mBAAmB,CAAC,IAAI,EAAE,cAAc;IAMrD;;;OAGG;IACU,qBAAqB,CAAC,SAAS,EAAE,gBAAgB;IAM9D;;;OAGG;IACU,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxD;;;OAGG;IACU,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAMlD;;;OAGG;IACU,iBAAiB,CAAC,aAAa,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1E;;;OAGG;IACU,eAAe,CAAC,YAAY,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE;;;OAGG;IACU,eAAe,CAAC,WAAW,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpE;;;OAGG;IACU,aAAa,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAK/D"}
+{"version":3,"file":"SchemaCompareVisitor.d.ts","sourceRoot":"","sources":["../../../src/Validation/SchemaCompareVisitor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,oBAAoB,EAAE,6BAA6B,EAClF,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,kBAAkB,EAAE,cAAc,EAAE,KAAK,EAClG,UAAU,EAAY,gBAAgB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,EAAE,UAAU,EACrF,WAAW,EAAE,IAAI,EAAE,UAAU,EAC9C,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;GAGG;AACH,qBAAa,oBAAqB,YAAW,kBAAkB;IAC7D,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,eAAe,CAAkB;IAEzC;;;;OAIG;gBACS,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM;IAKpE;;;OAGG;IACU,eAAe,CAAC,OAAO,EAAE,MAAM;IAI5C;;;OAGG;IACU,eAAe,CAAC,WAAW,EAAE,UAAU;IAKpD;;;OAGG;IACU,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxD;;;OAGG;IACU,aAAa,CAAC,SAAS,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAUjE;;;OAGG;IACU,gBAAgB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAMlE;;;OAGG;IACU,gBAAgB,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAInE;;;OAGG;IACU,UAAU,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD;;;OAGG;IACU,sBAAsB,CAAC,aAAa,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpF;;;OAGG;IACU,2BAA2B,CAAC,WAAW,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAW5F;;;OAGG;IACU,yBAAyB,CAAC,gBAAgB,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7F;;;OAGG;IACU,6BAA6B,CAAC,UAAU,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBpG;;;OAGG;IACU,gBAAgB,CAAC,KAAK,EAAE,WAAW;IAMhD;;;OAGG;IACU,mBAAmB,CAAC,IAAI,EAAE,cAAc;IAMrD;;;OAGG;IACU,qBAAqB,CAAC,SAAS,EAAE,gBAAgB;IAM9D;;;OAGG;IACU,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxD;;;OAGG;IACU,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAMlD;;;OAGG;IACU,iBAAiB,CAAC,aAAa,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1E;;;OAGG;IACU,eAAe,CAAC,YAAY,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE;;;OAGG;IACU,eAAe,CAAC,WAAW,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpE;;;OAGG;IACU,aAAa,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAK/D"}