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

package/lib/esm/Merging/SchemaMerger.js

@@ -0,0 +1,117 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { SchemaContext, SchemaItemKey, SchemaKey } from "@itwin/ecschema-metadata";
+import { SchemaContextEditor } from "../Editing/Editor";
+import { SchemaConflictsError } from "../Differencing/Errors";
+import { getSchemaDifferences } from "../Differencing/SchemaDifference";
+import { SchemaMergingVisitor } from "./SchemaMergingVisitor";
+import { SchemaMergingWalker } from "./SchemaMergingWalker";
+import { ECEditingStatus, SchemaEditingError } from "../Editing/Exception";
+import { NameMapping } from "./Edits/NameMapping";
+/**
+ * Class to merge two schemas together.
+ * @see [[merge]] or [[mergeSchemas]] to merge two schemas together.
+ * @beta
+ */
+export class SchemaMerger {
+    _editingContext;
+    /**
+     * Constructs a new instance of the SchemaMerger object.
+     * @param editingContext  The schema contexts that holds the schema to be edited.
+     */
+    constructor(editingContext) {
+        this._editingContext = editingContext;
+    }
+    /**
+     * 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 mergeSchemas(targetSchema, sourceSchema, edits) {
+        return this.merge(await getSchemaDifferences(targetSchema, sourceSchema, edits), edits);
+    }
+    /**
+     * 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 merge(differenceResult, edits) {
+        const targetSchemaKey = SchemaKey.parseString(differenceResult.targetSchemaName);
+        const sourceSchemaKey = SchemaKey.parseString(differenceResult.sourceSchemaName);
+        const nameMapping = new NameMapping();
+        const editor = new SchemaContextEditor(new MergingSchemaContext(this._editingContext, nameMapping));
+        // 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 }, nameMapping);
+        }
+        if (differenceResult.conflicts && differenceResult.conflicts.length > 0) {
+            throw new SchemaConflictsError("Schema's can't be merged if there are unresolved conflicts.", differenceResult.conflicts, sourceSchemaKey, targetSchemaKey);
+        }
+        const schema = await editor.getSchema(targetSchemaKey).catch((error) => {
+            if (error instanceof SchemaEditingError && error.errorNumber === ECEditingStatus.SchemaNotFound) {
+                throw new Error(`The target schema '${targetSchemaKey.name}' could not be found in the editing context.`);
+            }
+            throw error;
+        });
+        if (!schema.customAttributes || !schema.customAttributes.has("CoreCustomAttributes.DynamicSchema")) {
+            throw new Error(`The target schema '${targetSchemaKey.name}' is not dynamic. Only dynamic schemas are supported for merging.`);
+        }
+        const visitor = new SchemaMergingVisitor({
+            editor,
+            targetSchema: schema,
+            targetSchemaKey,
+            sourceSchemaKey,
+            nameMapping,
+        });
+        const walker = new SchemaMergingWalker(visitor);
+        await walker.traverse(differenceResult.differences, "add");
+        await walker.traverse(differenceResult.differences, "modify");
+        return schema;
+    }
+}
+/**
+ * SchemaContext implementation that overrides certain methods to allow to apply name mappings
+ * for certain schema elements during the schema merging process.
+ *
+ * @internal
+ */
+class MergingSchemaContext extends SchemaContext {
+    _internalContext;
+    _nameMappings;
+    constructor(internalContext, nameMapping) {
+        super();
+        this._internalContext = internalContext;
+        this._nameMappings = nameMapping;
+    }
+    async getCachedSchema(schemaKey, matchType) {
+        return this._internalContext.getCachedSchema(schemaKey, matchType);
+    }
+    async getSchema(schemaKey, matchType) {
+        return this._internalContext.getSchema(schemaKey, matchType);
+    }
+    async getSchemaItem(schemaNameOrKey, itemNameOrCtor, itemConstructor) {
+        let schemaItemKey;
+        if (typeof schemaNameOrKey === "string")
+            schemaItemKey = new SchemaItemKey(itemNameOrCtor, new SchemaKey(schemaNameOrKey));
+        else
+            schemaItemKey = schemaNameOrKey;
+        const mappedKey = this._nameMappings.resolveItemKey(schemaItemKey);
+        if (mappedKey !== undefined) {
+            schemaItemKey = mappedKey;
+        }
+        if (itemConstructor === undefined)
+            return this._internalContext.getSchemaItem(schemaItemKey);
+        return this._internalContext.getSchemaItem(schemaItemKey, itemConstructor);
+    }
+}
+//# sourceMappingURL=SchemaMerger.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaMerger.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAU,aAAa,EAAc,aAAa,EAAE,SAAS,EAAmB,MAAM,0BAA0B,CAAC;AACxH,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAA+B,MAAM,kCAAkC,CAAC;AACrG,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAclD;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAEN,eAAe,CAAgB;IAEhD;;;OAGG;IACH,YAAY,cAA6B;QACvC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,YAAY,CAAC,YAAoB,EAAE,YAAoB,EAAE,KAAmB;QACvF,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,oBAAoB,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAAC,gBAAwC,EAAE,KAAmB;QAC9E,MAAM,eAAe,GAAG,SAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QACjF,MAAM,eAAe,GAAG,SAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAEjF,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC,CAAC;QAEpG,oGAAoG;QACpG,iEAAiE;QACjE,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,OAAO,CAAC,gBAAgB,GAAG,EAAE,GAAG,gBAAgB,EAAE,EAAE,WAAW,CAAC,CAAC;QAC/E,CAAC;QAED,IAAI,gBAAgB,CAAC,SAAS,IAAI,gBAAgB,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxE,MAAM,IAAI,oBAAoB,CAC5B,6DAA6D,EAC7D,gBAAgB,CAAC,SAAS,EAC1B,eAAe,EACf,eAAe,CAChB,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;YAC5E,IAAI,KAAK,YAAY,kBAAkB,IAAI,KAAK,CAAC,WAAW,KAAK,eAAe,CAAC,cAAc,EAAE,CAAC;gBAChG,MAAM,IAAI,KAAK,CAAC,sBAAsB,eAAe,CAAC,IAAI,8CAA8C,CAAC,CAAC;YAC5G,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,oCAAoC,CAAC,EAAE,CAAC;YACnG,MAAM,IAAI,KAAK,CAAC,sBAAsB,eAAe,CAAC,IAAI,mEAAmE,CAAC,CAAC;QACjI,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC;YACvC,MAAM;YACN,YAAY,EAAE,MAAM;YACpB,eAAe;YACf,eAAe;YACf,WAAW;SACZ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAC3D,MAAM,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAE9D,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,oBAAqB,SAAQ,aAAa;IACtC,gBAAgB,CAAgB;IAChC,aAAa,CAAc;IAEnC,YAAmB,eAA8B,EAAE,WAAwB;QACzE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC;IACnC,CAAC;IAEe,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,SAA2B;QACrF,OAAO,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACrE,CAAC;IAEe,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA2B;QAC/E,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IAEe,KAAK,CAAC,aAAa,CAA8B,eAAuC,EAAE,cAA2B,EAAE,eAAmB;QACxJ,IAAI,aAA4B,CAAC;QACjC,IAAI,OAAO,eAAe,KAAK,QAAQ;YACrC,aAAa,GAAG,IAAI,aAAa,CAAC,cAAwB,EAAE,IAAI,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;;YAE5F,aAAa,GAAG,eAAe,CAAC;QAElC,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACnE,IAAG,SAAS,KAAK,SAAS,EAAE,CAAC;YAC3B,aAAa,GAAG,SAA0B,CAAC;QAC7C,CAAC;QAED,IAAG,eAAe,KAAK,SAAS;YAC9B,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAE5D,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IAC7E,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 Merging\n */\n\nimport { Schema, SchemaContext, SchemaItem, SchemaItemKey, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor } from \"../Editing/Editor\";\nimport { SchemaConflictsError } from \"../Differencing/Errors\";\nimport { getSchemaDifferences, type SchemaDifferenceResult } from \"../Differencing/SchemaDifference\";\nimport { SchemaMergingVisitor } from \"./SchemaMergingVisitor\";\nimport { SchemaMergingWalker } from \"./SchemaMergingWalker\";\nimport { SchemaEdits } from \"./Edits/SchemaEdits\";\nimport { ECEditingStatus, SchemaEditingError } from \"../Editing/Exception\";\nimport { NameMapping } from \"./Edits/NameMapping\";\n\n/**\n * Defines the context of a Schema merging run.\n * @internal\n */\nexport interface SchemaMergeContext {\n  readonly targetSchema: Schema;\n  readonly targetSchemaKey: SchemaKey;\n  readonly sourceSchemaKey: SchemaKey;\n  readonly editor: SchemaContextEditor;\n  readonly nameMapping: NameMapping;\n}\n\n/**\n * Class to merge two schemas together.\n * @see [[merge]] or [[mergeSchemas]] to merge two schemas together.\n * @beta\n */\nexport class SchemaMerger {\n\n  private readonly _editingContext: SchemaContext;\n\n  /**\n   * Constructs a new instance of the SchemaMerger object.\n   * @param editingContext  The schema contexts that holds the schema to be edited.\n   */\n  constructor(editingContext: SchemaContext) {\n    this._editingContext = editingContext;\n  }\n\n  /**\n   * Copy the SchemaItems of the source schemas to the target schema.\n   * @param targetSchema  The schema the SchemaItems gets merged to.\n   * @param sourceSchema  The schema the SchemaItems gets copied from.\n   * @param edits         An optional instance of schema edits that shall be applied before the schemas get merged.\n   * @returns             The merged target schema.\n   * @alpha\n   */\n  public async mergeSchemas(targetSchema: Schema, sourceSchema: Schema, edits?: SchemaEdits): Promise<Schema> {\n    return this.merge(await getSchemaDifferences(targetSchema, sourceSchema, edits), edits);\n  }\n\n  /**\n   * Merges the schema differences into the target schema context.\n   * @param differenceResult  The differences that shall be applied to the target schema.\n   * @param edits             An optional instance of schema edits that shall be applied before the schemas get merged.\n   * @alpha\n   */\n  public async merge(differenceResult: SchemaDifferenceResult, edits?: SchemaEdits): Promise<Schema> {\n    const targetSchemaKey = SchemaKey.parseString(differenceResult.targetSchemaName);\n    const sourceSchemaKey = SchemaKey.parseString(differenceResult.sourceSchemaName);\n\n    const nameMapping = new NameMapping();\n    const editor = new SchemaContextEditor(new MergingSchemaContext(this._editingContext, nameMapping));\n\n    // If schema changes were provided, they'll get applied and a new SchemaDifferenceResult is returned\n    // to prevent altering the differenceResult the caller passed in.\n    if (edits) {\n      await edits.applyTo(differenceResult = { ...differenceResult }, nameMapping);\n    }\n\n    if (differenceResult.conflicts && differenceResult.conflicts.length > 0) {\n      throw new SchemaConflictsError(\n        \"Schema's can't be merged if there are unresolved conflicts.\",\n        differenceResult.conflicts,\n        sourceSchemaKey,\n        targetSchemaKey,\n      );\n    }\n\n    const schema = await editor.getSchema(targetSchemaKey).catch((error: Error) => {\n      if (error instanceof SchemaEditingError && error.errorNumber === ECEditingStatus.SchemaNotFound) {\n        throw new Error(`The target schema '${targetSchemaKey.name}' could not be found in the editing context.`);\n      }\n      throw error;\n    });\n\n    if (!schema.customAttributes || !schema.customAttributes.has(\"CoreCustomAttributes.DynamicSchema\")) {\n      throw new Error(`The target schema '${targetSchemaKey.name}' is not dynamic. Only dynamic schemas are supported for merging.`);\n    }\n\n    const visitor = new SchemaMergingVisitor({\n      editor,\n      targetSchema: schema,\n      targetSchemaKey,\n      sourceSchemaKey,\n      nameMapping,\n    });\n\n    const walker = new SchemaMergingWalker(visitor);\n    await walker.traverse(differenceResult.differences, \"add\");\n    await walker.traverse(differenceResult.differences, \"modify\");\n\n    return schema;\n  }\n}\n\n/**\n * SchemaContext implementation that overrides certain methods to allow to apply name mappings\n * for certain schema elements during the schema merging process.\n *\n * @internal\n */\nclass MergingSchemaContext extends SchemaContext {\n  private _internalContext: SchemaContext;\n  private _nameMappings: NameMapping;\n\n  public constructor(internalContext: SchemaContext, nameMapping: NameMapping) {\n    super();\n    this._internalContext = internalContext;\n    this._nameMappings = nameMapping;\n  }\n\n  public override async getCachedSchema(schemaKey: SchemaKey, matchType?: SchemaMatchType): Promise<Schema | undefined> {\n    return this._internalContext.getCachedSchema(schemaKey, matchType);\n  }\n\n  public override async getSchema(schemaKey: SchemaKey, matchType?: SchemaMatchType): Promise<Schema | undefined> {\n    return this._internalContext.getSchema(schemaKey, matchType);\n  }\n\n  public override async getSchemaItem<T extends typeof SchemaItem>(schemaNameOrKey: string | SchemaItemKey, itemNameOrCtor?: string | T, itemConstructor?: T): Promise<SchemaItem | InstanceType<T> | undefined> {\n    let schemaItemKey: SchemaItemKey;\n    if (typeof schemaNameOrKey === \"string\")\n      schemaItemKey = new SchemaItemKey(itemNameOrCtor as string, new SchemaKey(schemaNameOrKey));\n    else\n      schemaItemKey = schemaNameOrKey;\n\n    const mappedKey = this._nameMappings.resolveItemKey(schemaItemKey);\n    if(mappedKey !== undefined) {\n      schemaItemKey = mappedKey as SchemaItemKey;\n    }\n\n    if(itemConstructor === undefined)\n      return this._internalContext.getSchemaItem(schemaItemKey);\n\n    return this._internalContext.getSchemaItem(schemaItemKey, itemConstructor);\n  }\n}\n"]}

package/lib/esm/Merging/SchemaMergingVisitor.d.ts

@@ -0,0 +1,149 @@
+import { AnySchemaDifference, ClassPropertyDifference, ConstantDifference, CustomAttributeClassDifference, CustomAttributeDifference, EntityClassDifference, EntityClassMixinDifference, EnumerationDifference, EnumeratorDifference, FormatDifference, FormatUnitDifference, FormatUnitLabelDifference, InvertedUnitDifference, KindOfQuantityDifference, KindOfQuantityPresentationFormatDifference, MixinClassDifference, PhenomenonDifference, PropertyCategoryDifference, RelationshipClassDifference, RelationshipConstraintClassDifference, RelationshipConstraintDifference, SchemaDifference, SchemaReferenceDifference, StructClassDifference, UnitDifference, UnitSystemDifference } from "../Differencing/SchemaDifference";
+import { SchemaDifferenceVisitor } from "../Differencing/SchemaDifferenceVisitor";
+import { SchemaMergeContext } from "./SchemaMerger";
+/**
+ * Implementation of ISchemaDifferenceVisitor that can be used to traverse schema
+ * differences to call the appropriated merger methods.
+ * @internal
+ */
+export declare class SchemaMergingVisitor implements SchemaDifferenceVisitor {
+    private readonly _context;
+    /**
+     * Initializes a new instance of SchemaMergingVisitor class.
+     */
+    constructor(context: SchemaMergeContext);
+    /**
+     * Shared merging logic for all types of ClassItemDifference union.
+     */
+    private visitClassDifference;
+    /**
+     * Visitor implementation for handling ConstantDifference.
+     * @internal
+     */
+    visitConstantDifference(entry: ConstantDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling CustomAttributeClassDifference.
+     * @internal
+     */
+    visitCustomAttributeClassDifference(entry: CustomAttributeClassDifference, index: number, array: AnySchemaDifference[]): Promise<void>;
+    /**
+     * Visitor implementation for handling CustomAttributeDifference.
+     * @internal
+     */
+    visitCustomAttributeInstanceDifference(entry: CustomAttributeDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling EntityClassDifference.
+     * @internal
+     */
+    visitEntityClassDifference(entry: EntityClassDifference, index: number, array: AnySchemaDifference[]): Promise<void>;
+    /**
+     * Visitor implementation for handling EntityClassMixinDifference.
+     * @internal
+     */
+    visitEntityClassMixinDifference(entry: EntityClassMixinDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling EnumerationDifference.
+     * @internal
+     */
+    visitEnumerationDifference(entry: EnumerationDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling EnumeratorDifference.
+     * @internal
+     */
+    visitEnumeratorDifference(entry: EnumeratorDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling FormatDifference.
+     * @internal
+     */
+    visitFormatDifference(entry: FormatDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling FormatUnitDifference.
+     * @internal
+     */
+    visitFormatUnitDifference(entry: FormatUnitDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling FormatUnitLabelDifference.
+     * @internal
+     */
+    visitFormatUnitLabelDifference(entry: FormatUnitLabelDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling InvertedUnitDifference.
+     * @internal
+     */
+    visitInvertedUnitDifference(entry: InvertedUnitDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling KindOfQuantityDifference.
+     * @internal
+     */
+    visitKindOfQuantityDifference(entry: KindOfQuantityDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling MixinClassDifference.
+     * @internal
+     */
+    visitMixinDifference(entry: MixinClassDifference, index: number, array: AnySchemaDifference[]): Promise<void>;
+    /**
+     * Visitor implementation for handling PhenomenonDifference.
+     * @internal
+     */
+    visitPhenomenonDifference(entry: PhenomenonDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling PropertyCategoryDifference.
+     * @internal
+     */
+    visitPropertyCategoryDifference(entry: PropertyCategoryDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling ClassPropertyDifference.
+     * @internal
+     */
+    visitPropertyDifference(entry: ClassPropertyDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling RelationshipClassDifference.
+     * @internal
+     */
+    visitRelationshipClassDifference(entry: RelationshipClassDifference, index: number, array: AnySchemaDifference[]): Promise<void>;
+    /**
+     * Visitor implementation for handling RelationshipConstraintClassDifference.
+     * @internal
+     */
+    visitRelationshipConstraintClassDifference(entry: RelationshipConstraintClassDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling RelationshipConstraintDifference.
+     * @internal
+     */
+    visitRelationshipConstraintDifference(entry: RelationshipConstraintDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling SchemaDifference.
+     * @internal
+     */
+    visitSchemaDifference({ difference }: SchemaDifference): Promise<void>;
+    /**
+     * Shared merging logic for all types of AnySchemaItemDifference union.
+     */
+    private visitSchemaItemDifference;
+    /**
+     * Visitor implementation for handling SchemaReferenceDifference.
+     * @internal
+     */
+    visitSchemaReferenceDifference(entry: SchemaReferenceDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling StructClassDifference.
+     * @internal
+     */
+    visitStructClassDifference(entry: StructClassDifference, index: number, array: AnySchemaDifference[]): Promise<void>;
+    /**
+     * Visitor implementation for handling UnitDifference.
+     * @internal
+     */
+    visitUnitDifference(entry: UnitDifference): Promise<void>;
+    /**
+     * Visitor implementation for handling UnitSystemDifference.
+     * @internal
+     */
+    visitUnitSystemDifference(entry: UnitSystemDifference): Promise<void>;
+    /**
+    * Visitor implementation for handling KindOfQuantityPresentationFormatDifference.
+    * @internal
+    */
+    visitKindOfQuantityPresentationFormatDifference(entry: KindOfQuantityPresentationFormatDifference): Promise<void>;
+}
+//# sourceMappingURL=SchemaMergingVisitor.d.ts.map

package/lib/esm/Merging/SchemaMergingVisitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaMergingVisitor.d.ts","sourceRoot":"","sources":["../../../src/Merging/SchemaMergingVisitor.ts"],"names":[],"mappings":"AAIA,OAAO,EAA0B,mBAAmB,EAA2B,uBAAuB,EACpG,kBAAkB,EAAE,8BAA8B,EAAE,yBAAyB,EAAE,qBAAqB,EACpG,0BAA0B,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,oBAAoB,EAC/G,yBAAyB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,0CAA0C,EACvH,oBAAoB,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,2BAA2B,EACnG,qCAAqC,EAAE,gCAAgC,EAAE,gBAAgB,EAAE,yBAAyB,EACpH,qBAAqB,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAiBxG,OAAO,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAElF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAYpD;;;;GAIG;AACH,qBAAa,oBAAqB,YAAW,uBAAuB;IAElE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAE9C;;OAEG;gBACS,OAAO,EAAE,kBAAkB;IAIvC;;OAEG;YACW,oBAAoB;IAmClC;;;OAGG;IACU,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9E;;;OAGG;IACU,mCAAmC,CAAC,KAAK,EAAE,8BAA8B,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOnJ;;;OAGG;IACU,sCAAsC,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpG;;;OAGG;IACU,0BAA0B,CAAC,KAAK,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjI;;;OAGG;IACU,+BAA+B,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAM9F;;;OAGG;IACU,0BAA0B,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOpF;;;OAGG;IACU,yBAAyB,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlF;;;OAGG;IACU,qBAAqB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAO1E;;;OAGG;IACU,yBAAyB,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMlF;;;OAGG;IACU,8BAA8B,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5F;;;OAGG;IACU,2BAA2B,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOtF;;;OAGG;IACU,6BAA6B,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;IAO1F;;;OAGG;IACU,oBAAoB,CAAC,KAAK,EAAE,oBAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAO1H;;;OAGG;IACU,yBAAyB,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlF;;;OAGG;IACU,+BAA+B,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9F;;;OAGG;IACU,uBAAuB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAInF;;;OAGG;IACU,gCAAgC,CAAC,KAAK,EAAE,2BAA2B,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7I;;;OAGG;IACU,0CAA0C,CAAC,KAAK,EAAE,qCAAqC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpH;;;OAGG;IACU,qCAAqC,CAAC,KAAK,EAAE,gCAAgC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1G;;;OAGG;IACU,qBAAqB,CAAC,EAAE,UAAU,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IASnF;;OAEG;YACW,yBAAyB;IAevC;;;OAGG;IACU,8BAA8B,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5F;;;OAGG;IACU,0BAA0B,CAAC,KAAK,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjI;;;OAGG;IACU,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAOtE;;;OAGG;IACU,yBAAyB,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlF;;;MAGE;IACW,+CAA+C,CAAC,KAAK,EAAE,0CAA0C,GAAG,OAAO,CAAC,IAAI,CAAC;CAK/H"}

package/lib/esm/Merging/SchemaMergingVisitor.js

@@ -0,0 +1,339 @@
+import { addConstant, modifyConstant } from "./ConstantMerger";
+import { addCustomAttribute } from "./CustomAttributeMerger";
+import { addCustomAttributeClass, modifyCustomAttributeClass } from "./CustomAttributeClassMerger";
+import { addClassMixins, addEntityClass, modifyEntityClass } from "./EntityClassMerger";
+import { addEnumeration, modifyEnumeration } from "./EnumerationMerger";
+import { addEnumerator, modifyEnumerator } from "./EnumeratorMerger";
+import { addKindOfQuantity, addPresentationFormat, modifyKindOfQuantity } from "./KindOfQuantityMerger";
+import { addMixinClass, modifyMixinClass } from "./MixinMerger";
+import { addPhenomenon, modifyPhenomenon } from "./PhenomenonMerger";
+import { addPropertyCategory, modifyPropertyCategory } from "./PropertyCategoryMerger";
+import { addRelationshipClass, mergeRelationshipClassConstraint, mergeRelationshipConstraint, modifyRelationshipClass } from "./RelationshipClassMerger";
+import { addSchemaReferences, modifySchemaReferences } from "./SchemaReferenceMerger";
+import { addStructClass, modifyStructClass } from "./StructClassMerger";
+import { addUnitSystem, modifyUnitSystem } from "./UnitSystemMerger";
+import { mergePropertyDifference } from "./PropertyMerger";
+import { isClassDifference } from "../Differencing/Utils";
+import { toItemKey } from "./Utils";
+import { addUnit, modifyUnit } from "./UnitMerger";
+import { addInvertedUnit, modifyInvertedUnit } from "./InvertedUnitMerger";
+import { addFormat, modifyFormat, modifyFormatUnit, modifyFormatUnitLabel } from "./FormatMerger";
+/**
+ * Implementation of ISchemaDifferenceVisitor that can be used to traverse schema
+ * differences to call the appropriated merger methods.
+ * @internal
+ */
+export class SchemaMergingVisitor {
+    _context;
+    /**
+     * Initializes a new instance of SchemaMergingVisitor class.
+     */
+    constructor(context) {
+        this._context = context;
+    }
+    /**
+     * Shared merging logic for all types of ClassItemDifference union.
+     */
+    async visitClassDifference(entry, index, array, handler) {
+        return this.visitSchemaItemDifference(entry, {
+            add: async (context) => {
+                // To add classes a slightly different approach is done. In fact the class entries gets processed
+                // two times. The first time, a stub with the bare minimum is added to the schema. The second time,
+                // the class gets completed with all properties, mixins, etc...
+                if (entry.changeType === "add" && !await context.targetSchema.getItem(entry.itemName)) {
+                    await handler.add(this._context, {
+                        ...entry,
+                        difference: {
+                            ...entry.difference,
+                            // Remove everything we want to validate before setting, this is done in the second iteration.
+                            baseClass: undefined,
+                            mixins: undefined,
+                            properties: undefined,
+                            customAttributes: undefined,
+                        },
+                    });
+                    // Searches for the last class difference and adds the entry after it. That way,
+                    // the class is completed before class related entries get processed.
+                    const insertIndex = findIndexOf(array, (e) => !isClassDifference(e), index) || array.length;
+                    array.splice(insertIndex, 0, entry);
+                    return;
+                }
+                // Now both a modification change or the second add iteration is a modification of an existing class.
+                // So, regardless of the actual change type, modify is called.
+                return handler.modify(this._context, entry, toItemKey(this._context, entry.itemName));
+            },
+            modify: handler.modify,
+        });
+    }
+    /**
+     * Visitor implementation for handling ConstantDifference.
+     * @internal
+     */
+    async visitConstantDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addConstant,
+            modify: modifyConstant,
+        });
+    }
+    /**
+     * Visitor implementation for handling CustomAttributeClassDifference.
+     * @internal
+     */
+    async visitCustomAttributeClassDifference(entry, index, array) {
+        return this.visitClassDifference(entry, index, array, {
+            add: addCustomAttributeClass,
+            modify: modifyCustomAttributeClass,
+        });
+    }
+    /**
+     * Visitor implementation for handling CustomAttributeDifference.
+     * @internal
+     */
+    async visitCustomAttributeInstanceDifference(entry) {
+        switch (entry.changeType) {
+            case "add": return addCustomAttribute(this._context, entry);
+        }
+    }
+    /**
+     * Visitor implementation for handling EntityClassDifference.
+     * @internal
+     */
+    async visitEntityClassDifference(entry, index, array) {
+        return this.visitClassDifference(entry, index, array, {
+            add: addEntityClass,
+            modify: modifyEntityClass,
+        });
+    }
+    /**
+     * Visitor implementation for handling EntityClassMixinDifference.
+     * @internal
+     */
+    async visitEntityClassMixinDifference(entry) {
+        switch (entry.changeType) {
+            case "add": return addClassMixins(this._context, entry);
+        }
+    }
+    /**
+     * Visitor implementation for handling EnumerationDifference.
+     * @internal
+     */
+    async visitEnumerationDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addEnumeration,
+            modify: modifyEnumeration,
+        });
+    }
+    /**
+     * Visitor implementation for handling EnumeratorDifference.
+     * @internal
+     */
+    async visitEnumeratorDifference(entry) {
+        switch (entry.changeType) {
+            case "add": return addEnumerator(this._context, entry);
+            case "modify": return modifyEnumerator(this._context, entry, toItemKey(this._context, entry.itemName));
+        }
+    }
+    /**
+     * Visitor implementation for handling FormatDifference.
+     * @internal
+     */
+    async visitFormatDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addFormat,
+            modify: modifyFormat,
+        });
+    }
+    /**
+     * Visitor implementation for handling FormatUnitDifference.
+     * @internal
+     */
+    async visitFormatUnitDifference(entry) {
+        switch (entry.changeType) {
+            case "modify": return modifyFormatUnit(this._context, entry, toItemKey(this._context, entry.itemName));
+        }
+    }
+    /**
+     * Visitor implementation for handling FormatUnitLabelDifference.
+     * @internal
+     */
+    async visitFormatUnitLabelDifference(entry) {
+        switch (entry.changeType) {
+            case "modify": return modifyFormatUnitLabel(this._context, entry, toItemKey(this._context, entry.itemName));
+        }
+    }
+    /**
+     * Visitor implementation for handling InvertedUnitDifference.
+     * @internal
+     */
+    async visitInvertedUnitDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addInvertedUnit,
+            modify: modifyInvertedUnit,
+        });
+    }
+    /**
+     * Visitor implementation for handling KindOfQuantityDifference.
+     * @internal
+     */
+    async visitKindOfQuantityDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addKindOfQuantity,
+            modify: modifyKindOfQuantity,
+        });
+    }
+    /**
+     * Visitor implementation for handling MixinClassDifference.
+     * @internal
+     */
+    async visitMixinDifference(entry, index, array) {
+        return this.visitClassDifference(entry, index, array, {
+            add: addMixinClass,
+            modify: modifyMixinClass,
+        });
+    }
+    /**
+     * Visitor implementation for handling PhenomenonDifference.
+     * @internal
+     */
+    async visitPhenomenonDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addPhenomenon,
+            modify: modifyPhenomenon,
+        });
+    }
+    /**
+     * Visitor implementation for handling PropertyCategoryDifference.
+     * @internal
+     */
+    async visitPropertyCategoryDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addPropertyCategory,
+            modify: modifyPropertyCategory,
+        });
+    }
+    /**
+     * Visitor implementation for handling ClassPropertyDifference.
+     * @internal
+     */
+    async visitPropertyDifference(entry) {
+        await mergePropertyDifference(this._context, entry);
+    }
+    /**
+     * Visitor implementation for handling RelationshipClassDifference.
+     * @internal
+     */
+    async visitRelationshipClassDifference(entry, index, array) {
+        return this.visitClassDifference(entry, index, array, {
+            add: addRelationshipClass,
+            modify: modifyRelationshipClass,
+        });
+    }
+    /**
+     * Visitor implementation for handling RelationshipConstraintClassDifference.
+     * @internal
+     */
+    async visitRelationshipConstraintClassDifference(entry) {
+        await mergeRelationshipClassConstraint(this._context, entry);
+    }
+    /**
+     * Visitor implementation for handling RelationshipConstraintDifference.
+     * @internal
+     */
+    async visitRelationshipConstraintDifference(entry) {
+        await mergeRelationshipConstraint(this._context, entry);
+    }
+    /**
+     * Visitor implementation for handling SchemaDifference.
+     * @internal
+     */
+    async visitSchemaDifference({ difference }) {
+        if (difference.label !== undefined) {
+            await this._context.editor.setDisplayLabel(this._context.targetSchemaKey, difference.label);
+        }
+        if (difference.description !== undefined) {
+            await this._context.editor.setDescription(this._context.targetSchemaKey, difference.description);
+        }
+    }
+    /**
+     * Shared merging logic for all types of AnySchemaItemDifference union.
+     */
+    async visitSchemaItemDifference(entry, handler) {
+        switch (entry.changeType) {
+            case "add": {
+                return handler.add(this._context, entry);
+            }
+            case "modify":
+                {
+                    if ("schemaItemType" in entry.difference && entry.difference.schemaItemType !== entry.schemaType) {
+                        throw new Error(`Changing the type of item '${entry.itemName}' not supported.`);
+                    }
+                    return handler.modify(this._context, entry, toItemKey(this._context, entry.itemName));
+                }
+                ;
+        }
+    }
+    /**
+     * Visitor implementation for handling SchemaReferenceDifference.
+     * @internal
+     */
+    async visitSchemaReferenceDifference(entry) {
+        switch (entry.changeType) {
+            case "add": return addSchemaReferences(this._context, entry);
+            case "modify": return modifySchemaReferences(this._context, entry);
+        }
+    }
+    /**
+     * Visitor implementation for handling StructClassDifference.
+     * @internal
+     */
+    async visitStructClassDifference(entry, index, array) {
+        return this.visitClassDifference(entry, index, array, {
+            add: addStructClass,
+            modify: modifyStructClass,
+        });
+    }
+    /**
+     * Visitor implementation for handling UnitDifference.
+     * @internal
+     */
+    async visitUnitDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addUnit,
+            modify: modifyUnit,
+        });
+    }
+    /**
+     * Visitor implementation for handling UnitSystemDifference.
+     * @internal
+     */
+    async visitUnitSystemDifference(entry) {
+        return this.visitSchemaItemDifference(entry, {
+            add: addUnitSystem,
+            modify: modifyUnitSystem,
+        });
+    }
+    /**
+    * Visitor implementation for handling KindOfQuantityPresentationFormatDifference.
+    * @internal
+    */
+    async visitKindOfQuantityPresentationFormatDifference(entry) {
+        switch (entry.changeType) {
+            case "add": return addPresentationFormat(this._context, entry, toItemKey(this._context, entry.itemName));
+        }
+    }
+}
+/**
+ * Helper method to get the index of the first element in the array that satisfies the provided testing function.
+ * @param array     Array to search.
+ * @param predicate Function to execute on each value in the array.
+ * @param fromIndex The index to start the search at.
+ * @returns         An index in the array if an element passes the test; otherwise, false.
+ */
+function findIndexOf(array, predicate, fromIndex) {
+    for (let i = fromIndex; i < array.length; i++) {
+        if (predicate(array[i]))
+            return i;
+    }
+    return false;
+}
+//# sourceMappingURL=SchemaMergingVisitor.js.map