@itwin/ecschema-editing 5.0.0-dev.56 → 5.0.0-dev.57

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

@@ -10,6 +10,8 @@ exports.NameMapping = exports.PropertyKey = void 0;
  */
 const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
 class PropertyKey {
+    propertyName;
+    classKey;
     get fullName() {
         return `${this.classKey.fullName}.${this.propertyName}`;
     }
@@ -23,6 +25,7 @@ exports.PropertyKey = PropertyKey;
  * @internal
  */
 class NameMapping {
+    _map;
     constructor() {
         this._map = new Map();
     }

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

@@ -1 +1 @@
-{"version":3,"file":"NameMapping.js","sourceRoot":"","sources":["../../../../src/Merging/Edits/NameMapping.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,gEAAyD;AAMzD,MAAa,WAAW;IAItB,IAAW,QAAQ;QACjB,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;IAC1D,CAAC;IAED,YAAY,YAAoB,EAAE,QAAuB;QACvD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAZD,kCAYC;AAED;;GAEG;AACH,MAAa,WAAW;IAGtB;QACE,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC9C,CAAC;IAEM,cAAc,CAAC,OAAe,EAAE,OAAe;QACpD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;IAEM,kBAAkB,CAAC,WAAmB,EAAE,OAAe;QAC5D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1C,CAAC;IAEM,cAAc,CAAC,OAAgC;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,iCAAa,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;IAEM,kBAAkB,CAAC,WAAkC;QAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC9D,CAAC;CACF;AAhCD,kCAgCC","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 */\nimport { SchemaItemKey } from \"@itwin/ecschema-metadata\";\n\ninterface MappingEntry {\n  readonly newName: string;\n}\n\nexport class PropertyKey {\n  public readonly propertyName: string;\n  public readonly classKey: SchemaItemKey;\n\n  public get fullName(): string {\n    return `${this.classKey.fullName}.${this.propertyName}`;\n  }\n\n  constructor(propertyName: string, classKey: SchemaItemKey) {\n    this.propertyName = propertyName;\n    this.classKey = classKey;\n  }\n}\n\n/**\n * @internal\n */\nexport class NameMapping {\n  private readonly _map: Map<string, MappingEntry>;\n\n  constructor() {\n    this._map = new Map<string, MappingEntry>();\n  }\n\n  public addItemMapping(itemKey: string, newName: string) {\n    this._map.set(itemKey, { newName });\n  }\n\n  public addPropertyMapping(propertyKey: string, newName: string) {\n    this._map.set(propertyKey, { newName });\n  }\n\n  public resolveItemKey(itemKey: Readonly<SchemaItemKey>): Readonly<SchemaItemKey> {\n    const entry = this._map.get(itemKey.fullName);\n    if(entry === undefined) {\n      return itemKey;\n    }\n\n    return new SchemaItemKey(entry.newName, itemKey.schemaKey);\n  }\n\n  public resolvePropertyKey(propertyKey: Readonly<PropertyKey>): Readonly<PropertyKey> {\n    const entry = this._map.get(propertyKey.fullName);\n    if(entry === undefined) {\n      return propertyKey;\n    }\n\n    return new PropertyKey(entry.newName, propertyKey.classKey);\n  }\n}\n"]}
+{"version":3,"file":"NameMapping.js","sourceRoot":"","sources":["../../../../src/Merging/Edits/NameMapping.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,gEAAyD;AAMzD,MAAa,WAAW;IACN,YAAY,CAAS;IACrB,QAAQ,CAAgB;IAExC,IAAW,QAAQ;QACjB,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;IAC1D,CAAC;IAED,YAAY,YAAoB,EAAE,QAAuB;QACvD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAZD,kCAYC;AAED;;GAEG;AACH,MAAa,WAAW;IACL,IAAI,CAA4B;IAEjD;QACE,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC9C,CAAC;IAEM,cAAc,CAAC,OAAe,EAAE,OAAe;QACpD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;IAEM,kBAAkB,CAAC,WAAmB,EAAE,OAAe;QAC5D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1C,CAAC;IAEM,cAAc,CAAC,OAAgC;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,iCAAa,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;IAEM,kBAAkB,CAAC,WAAkC;QAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC9D,CAAC;CACF;AAhCD,kCAgCC","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 */\nimport { SchemaItemKey } from \"@itwin/ecschema-metadata\";\n\ninterface MappingEntry {\n  readonly newName: string;\n}\n\nexport class PropertyKey {\n  public readonly propertyName: string;\n  public readonly classKey: SchemaItemKey;\n\n  public get fullName(): string {\n    return `${this.classKey.fullName}.${this.propertyName}`;\n  }\n\n  constructor(propertyName: string, classKey: SchemaItemKey) {\n    this.propertyName = propertyName;\n    this.classKey = classKey;\n  }\n}\n\n/**\n * @internal\n */\nexport class NameMapping {\n  private readonly _map: Map<string, MappingEntry>;\n\n  constructor() {\n    this._map = new Map<string, MappingEntry>();\n  }\n\n  public addItemMapping(itemKey: string, newName: string) {\n    this._map.set(itemKey, { newName });\n  }\n\n  public addPropertyMapping(propertyKey: string, newName: string) {\n    this._map.set(propertyKey, { newName });\n  }\n\n  public resolveItemKey(itemKey: Readonly<SchemaItemKey>): Readonly<SchemaItemKey> {\n    const entry = this._map.get(itemKey.fullName);\n    if(entry === undefined) {\n      return itemKey;\n    }\n\n    return new SchemaItemKey(entry.newName, itemKey.schemaKey);\n  }\n\n  public resolvePropertyKey(propertyKey: Readonly<PropertyKey>): Readonly<PropertyKey> {\n    const entry = this._map.get(propertyKey.fullName);\n    if(entry === undefined) {\n      return propertyKey;\n    }\n\n    return new PropertyKey(entry.newName, propertyKey.classKey);\n  }\n}\n"]}

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

@@ -21,6 +21,7 @@ var SchemaEditType;
     SchemaEditType["Skip"] = "Skip";
 })(SchemaEditType || (exports.SchemaEditType = SchemaEditType = {}));
 class Editor {
+    _edits;
     constructor(edits) {
         this._edits = edits;
     }
@@ -72,6 +73,9 @@ class ItemEditor extends Editor {
  * @alpha
  */
 class SchemaEdits {
+    _edits;
+    properties;
+    items;
     /**
      * @alpha
      */

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaEdits.js","sourceRoot":"","sources":["../../../../src/Merging/Edits/SchemaEdits.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,2DAAyF;AACzF,uDAAkD;AAElD;;;GAGG;AACH,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uDAAqC,CAAA;IACrC,mDAAiC,CAAA;IACjC,+BAAa,CAAA;AACf,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AAwCD,MAAe,MAAM;IAGnB,YAAY,KAA4B;QACtC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAES,GAAG,CAAC,IAAoB;QAChC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YACpD,OAAO,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,IAAI,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;CACF;AAED,MAAM,cAAe,SAAQ,MAAM;IAE1B,MAAM,CAAC,OAAgB,EAAE,YAAoB,EAAE,OAAe;QACnE,IAAI,CAAC,GAAG,CAAC;YACP,IAAI,EAAE,cAAc,CAAC,cAAc;YACnC,GAAG,EAAE,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,EAAE;YAC1C,KAAK,EAAE,OAAO;SACf,CAAC,CAAC;IACL,CAAC;IAEM,IAAI,CAAC,OAAgB,EAAE,YAAoB;QAChD,IAAI,CAAC,GAAG,CAAC;YACP,IAAI,EAAE,cAAc,CAAC,IAAI;YACzB,GAAG,EAAE,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,EAAE;SAC3C,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,UAAW,SAAQ,MAAM;IACtB,MAAM,CAAC,UAAsB,EAAE,OAAe;QACnD,IAAI,CAAC,GAAG,CAAC;YACP,IAAI,EAAE,cAAc,CAAC,gBAAgB;YACrC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,QAAQ;YAC5B,KAAK,EAAE,OAAO;SACf,CAAC,CAAC;IACL,CAAC;IAEM,IAAI,CAAC,UAAsB;QAChC,IAAI,CAAC,GAAG,CAAC;YACP,IAAI,EAAE,cAAc,CAAC,IAAI;YACzB,GAAG,EAAE,UAAU,CAAC,QAAQ;SACzB,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;GAIG;AACH,MAAa,WAAW;IAMtB;;OAEG;IACH,YAAY,UAA0C;QACpD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QAEjB,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,gBAAwC,EAAE,WAAwB;QACrF,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACrC,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;gBACxD,IAAA,6CAAyB,EAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;gBACxD,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC/D,CAAC;YACD,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,cAAc,EAAE,CAAC;gBACtD,IAAA,2CAAuB,EAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;gBACtD,WAAW,CAAC,kBAAkB,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;gBAC5C,IAAA,+BAAa,EAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC,CAAC;CACF;AA9CD,kCA8CC","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 type { ECClass, SchemaItem } from \"@itwin/ecschema-metadata\";\nimport type { SchemaDifferenceResult } from \"../../Differencing/SchemaDifference\";\nimport { NameMapping } from \"./NameMapping\";\nimport { applyRenamePropertyEdit, applyRenameSchemaItemEdit } from \"./RenameEditHandler\";\nimport { applySkipEdit } from \"./SkipEditHandler\";\n\n/**\n * An enumeration that has all the schema edit names.\n * @alpha\n */\nexport enum SchemaEditType {\n  RenameSchemaItem = \"RenameSchemaItem\",\n  RenameProperty = \"RenameProperty\",\n  Skip = \"Skip\",\n}\n\n/**\n * Schema edit entry to rename a schema item.\n * @alpha\n */\nexport interface RenameSchemaItemEdit {\n  type: SchemaEditType.RenameSchemaItem;\n  key: string;\n  value: string;\n}\n\n/**\n * Schema edit entry to rename a property of a class.\n * @alpha\n */\nexport interface RenamePropertyEdit {\n  type: SchemaEditType.RenameProperty;\n  key: string;\n  value: string;\n}\n\n/**\n * Schema edit entry to skip a certain schema element matching the given key.\n * @alpha\n */\nexport interface SkipEdit {\n  type: SchemaEditType.Skip;\n  key: string;\n}\n\n/**\n * Union for all supported edits that can be applied to a schema.\n * @alpha\n */\nexport type AnySchemaEdits =\n  SkipEdit |\n  RenameSchemaItemEdit |\n  RenamePropertyEdit;\n\nabstract class Editor {\n  private readonly _edits: Array<AnySchemaEdits>;\n\n  constructor(edits: Array<AnySchemaEdits>) {\n    this._edits = edits;\n  }\n\n  protected add(edit: AnySchemaEdits) {\n    const overrideEntry = this._edits.findIndex((entry) => {\n      return entry.type === edit.type && entry.key === edit.key;\n    });\n\n    if (overrideEntry > -1) {\n      this._edits[overrideEntry] = edit;\n    } else {\n      this._edits.push(edit);\n    }\n  }\n}\n\nclass PropertyEditor extends Editor {\n\n  public rename(ecClass: ECClass, propertyName: string, newName: string) {\n    this.add({\n      type: SchemaEditType.RenameProperty,\n      key: `${ecClass.fullName}.${propertyName}`,\n      value: newName,\n    });\n  }\n\n  public skip(ecClass: ECClass, propertyName: string) {\n    this.add({\n      type: SchemaEditType.Skip,\n      key: `${ecClass.fullName}.${propertyName}`,\n    });\n  }\n}\n\nclass ItemEditor extends Editor {\n  public rename(schemaItem: SchemaItem, newName: string) {\n    this.add({\n      type: SchemaEditType.RenameSchemaItem,\n      key: schemaItem.key.fullName,\n      value: newName,\n    });\n  }\n\n  public skip(schemaItem: SchemaItem) {\n    this.add({\n      type: SchemaEditType.Skip,\n      key: schemaItem.fullName,\n    });\n  }\n}\n\n/**\n * Defines a set of edits of a schema that can be applied to a schema during merging. The intention of this class\n * is to support saving of edits and load them again if needed.\n * @alpha\n */\nexport class SchemaEdits implements Iterable<AnySchemaEdits> {\n  private readonly _edits: Array<AnySchemaEdits>;\n\n  public readonly properties: PropertyEditor;\n  public readonly items: ItemEditor;\n\n  /**\n   * @alpha\n   */\n  constructor(initialize?: ReadonlyArray<AnySchemaEdits>) {\n    this._edits = [];\n\n    if (initialize) {\n      this._edits.push(...initialize);\n    }\n\n    this.items = new ItemEditor(this._edits);\n    this.properties = new PropertyEditor(this._edits);\n  }\n\n  /**\n   * @internal\n   */\n  public async applyTo(differenceResult: SchemaDifferenceResult, nameMapping: NameMapping): Promise<void> {\n    for (const schemaEdit of this._edits) {\n      if (schemaEdit.type === SchemaEditType.RenameSchemaItem) {\n        applyRenameSchemaItemEdit(differenceResult, schemaEdit);\n        nameMapping.addItemMapping(schemaEdit.key, schemaEdit.value);\n      }\n      if (schemaEdit.type === SchemaEditType.RenameProperty) {\n        applyRenamePropertyEdit(differenceResult, schemaEdit);\n        nameMapping.addPropertyMapping(schemaEdit.key, schemaEdit.value);\n      }\n      if (schemaEdit.type === SchemaEditType.Skip) {\n        applySkipEdit(differenceResult, schemaEdit);\n      }\n    }\n  }\n\n  public toJSON(): ReadonlyArray<AnySchemaEdits> {\n    return this._edits;\n  }\n\n  public [Symbol.iterator](): Iterator<AnySchemaEdits> {\n    return this._edits[Symbol.iterator]();\n  }\n}\n"]}
+{"version":3,"file":"SchemaEdits.js","sourceRoot":"","sources":["../../../../src/Merging/Edits/SchemaEdits.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,2DAAyF;AACzF,uDAAkD;AAElD;;;GAGG;AACH,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uDAAqC,CAAA;IACrC,mDAAiC,CAAA;IACjC,+BAAa,CAAA;AACf,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AAwCD,MAAe,MAAM;IACF,MAAM,CAAwB;IAE/C,YAAY,KAA4B;QACtC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAES,GAAG,CAAC,IAAoB;QAChC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YACpD,OAAO,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,IAAI,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;CACF;AAED,MAAM,cAAe,SAAQ,MAAM;IAE1B,MAAM,CAAC,OAAgB,EAAE,YAAoB,EAAE,OAAe;QACnE,IAAI,CAAC,GAAG,CAAC;YACP,IAAI,EAAE,cAAc,CAAC,cAAc;YACnC,GAAG,EAAE,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,EAAE;YAC1C,KAAK,EAAE,OAAO;SACf,CAAC,CAAC;IACL,CAAC;IAEM,IAAI,CAAC,OAAgB,EAAE,YAAoB;QAChD,IAAI,CAAC,GAAG,CAAC;YACP,IAAI,EAAE,cAAc,CAAC,IAAI;YACzB,GAAG,EAAE,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,EAAE;SAC3C,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,UAAW,SAAQ,MAAM;IACtB,MAAM,CAAC,UAAsB,EAAE,OAAe;QACnD,IAAI,CAAC,GAAG,CAAC;YACP,IAAI,EAAE,cAAc,CAAC,gBAAgB;YACrC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,QAAQ;YAC5B,KAAK,EAAE,OAAO;SACf,CAAC,CAAC;IACL,CAAC;IAEM,IAAI,CAAC,UAAsB;QAChC,IAAI,CAAC,GAAG,CAAC;YACP,IAAI,EAAE,cAAc,CAAC,IAAI;YACzB,GAAG,EAAE,UAAU,CAAC,QAAQ;SACzB,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;GAIG;AACH,MAAa,WAAW;IACL,MAAM,CAAwB;IAE/B,UAAU,CAAiB;IAC3B,KAAK,CAAa;IAElC;;OAEG;IACH,YAAY,UAA0C;QACpD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QAEjB,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,gBAAwC,EAAE,WAAwB;QACrF,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACrC,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;gBACxD,IAAA,6CAAyB,EAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;gBACxD,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC/D,CAAC;YACD,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,cAAc,EAAE,CAAC;gBACtD,IAAA,2CAAuB,EAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;gBACtD,WAAW,CAAC,kBAAkB,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YACnE,CAAC;YACD,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI,EAAE,CAAC;gBAC5C,IAAA,+BAAa,EAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC,CAAC;CACF;AA9CD,kCA8CC","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 type { ECClass, SchemaItem } from \"@itwin/ecschema-metadata\";\nimport type { SchemaDifferenceResult } from \"../../Differencing/SchemaDifference\";\nimport { NameMapping } from \"./NameMapping\";\nimport { applyRenamePropertyEdit, applyRenameSchemaItemEdit } from \"./RenameEditHandler\";\nimport { applySkipEdit } from \"./SkipEditHandler\";\n\n/**\n * An enumeration that has all the schema edit names.\n * @alpha\n */\nexport enum SchemaEditType {\n  RenameSchemaItem = \"RenameSchemaItem\",\n  RenameProperty = \"RenameProperty\",\n  Skip = \"Skip\",\n}\n\n/**\n * Schema edit entry to rename a schema item.\n * @alpha\n */\nexport interface RenameSchemaItemEdit {\n  type: SchemaEditType.RenameSchemaItem;\n  key: string;\n  value: string;\n}\n\n/**\n * Schema edit entry to rename a property of a class.\n * @alpha\n */\nexport interface RenamePropertyEdit {\n  type: SchemaEditType.RenameProperty;\n  key: string;\n  value: string;\n}\n\n/**\n * Schema edit entry to skip a certain schema element matching the given key.\n * @alpha\n */\nexport interface SkipEdit {\n  type: SchemaEditType.Skip;\n  key: string;\n}\n\n/**\n * Union for all supported edits that can be applied to a schema.\n * @alpha\n */\nexport type AnySchemaEdits =\n  SkipEdit |\n  RenameSchemaItemEdit |\n  RenamePropertyEdit;\n\nabstract class Editor {\n  private readonly _edits: Array<AnySchemaEdits>;\n\n  constructor(edits: Array<AnySchemaEdits>) {\n    this._edits = edits;\n  }\n\n  protected add(edit: AnySchemaEdits) {\n    const overrideEntry = this._edits.findIndex((entry) => {\n      return entry.type === edit.type && entry.key === edit.key;\n    });\n\n    if (overrideEntry > -1) {\n      this._edits[overrideEntry] = edit;\n    } else {\n      this._edits.push(edit);\n    }\n  }\n}\n\nclass PropertyEditor extends Editor {\n\n  public rename(ecClass: ECClass, propertyName: string, newName: string) {\n    this.add({\n      type: SchemaEditType.RenameProperty,\n      key: `${ecClass.fullName}.${propertyName}`,\n      value: newName,\n    });\n  }\n\n  public skip(ecClass: ECClass, propertyName: string) {\n    this.add({\n      type: SchemaEditType.Skip,\n      key: `${ecClass.fullName}.${propertyName}`,\n    });\n  }\n}\n\nclass ItemEditor extends Editor {\n  public rename(schemaItem: SchemaItem, newName: string) {\n    this.add({\n      type: SchemaEditType.RenameSchemaItem,\n      key: schemaItem.key.fullName,\n      value: newName,\n    });\n  }\n\n  public skip(schemaItem: SchemaItem) {\n    this.add({\n      type: SchemaEditType.Skip,\n      key: schemaItem.fullName,\n    });\n  }\n}\n\n/**\n * Defines a set of edits of a schema that can be applied to a schema during merging. The intention of this class\n * is to support saving of edits and load them again if needed.\n * @alpha\n */\nexport class SchemaEdits implements Iterable<AnySchemaEdits> {\n  private readonly _edits: Array<AnySchemaEdits>;\n\n  public readonly properties: PropertyEditor;\n  public readonly items: ItemEditor;\n\n  /**\n   * @alpha\n   */\n  constructor(initialize?: ReadonlyArray<AnySchemaEdits>) {\n    this._edits = [];\n\n    if (initialize) {\n      this._edits.push(...initialize);\n    }\n\n    this.items = new ItemEditor(this._edits);\n    this.properties = new PropertyEditor(this._edits);\n  }\n\n  /**\n   * @internal\n   */\n  public async applyTo(differenceResult: SchemaDifferenceResult, nameMapping: NameMapping): Promise<void> {\n    for (const schemaEdit of this._edits) {\n      if (schemaEdit.type === SchemaEditType.RenameSchemaItem) {\n        applyRenameSchemaItemEdit(differenceResult, schemaEdit);\n        nameMapping.addItemMapping(schemaEdit.key, schemaEdit.value);\n      }\n      if (schemaEdit.type === SchemaEditType.RenameProperty) {\n        applyRenamePropertyEdit(differenceResult, schemaEdit);\n        nameMapping.addPropertyMapping(schemaEdit.key, schemaEdit.value);\n      }\n      if (schemaEdit.type === SchemaEditType.Skip) {\n        applySkipEdit(differenceResult, schemaEdit);\n      }\n    }\n  }\n\n  public toJSON(): ReadonlyArray<AnySchemaEdits> {\n    return this._edits;\n  }\n\n  public [Symbol.iterator](): Iterator<AnySchemaEdits> {\n    return this._edits[Symbol.iterator]();\n  }\n}\n"]}

package/lib/cjs/Merging/SchemaMerger.js

@@ -22,6 +22,7 @@ const NameMapping_1 = require("./Edits/NameMapping");
  * @beta
  */
 class SchemaMerger {
+    _editingContext;
     /**
      * Constructs a new instance of the SchemaMerger object.
      * @param editingContext  The schema contexts that holds the schema to be edited.
@@ -89,6 +90,8 @@ exports.SchemaMerger = SchemaMerger;
  * @internal
  */
 class MergingSchemaContext extends ecschema_metadata_1.SchemaContext {
+    _internalContext;
+    _nameMappings;
     constructor(internalContext, nameMapping) {
         super();
         this._internalContext = internalContext;

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;;;AAEH,gEAAwH;AACxH,8CAAwD;AACxD,mDAA8D;AAC9D,uEAAqG;AACrG,iEAA8D;AAC9D,+DAA4D;AAE5D,oDAA2E;AAC3E,qDAAkD;AAclD;;;;GAIG;AACH,MAAa,YAAY;IAIvB;;;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,IAAA,uCAAoB,EAAC,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,6BAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QACjF,MAAM,eAAe,GAAG,6BAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAEjF,MAAM,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAI,4BAAmB,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,6BAAoB,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,8BAAkB,IAAI,KAAK,CAAC,WAAW,KAAK,2BAAe,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,2CAAoB,CAAC;YACvC,MAAM;YACN,YAAY,EAAE,MAAM;YACpB,eAAe;YACf,eAAe;YACf,WAAW;SACZ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,yCAAmB,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;AA7ED,oCA6EC;AAED;;;;;GAKG;AACH,MAAM,oBAAqB,SAAQ,iCAAa;IAI9C,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,CAAmB,SAA8B,EAAE,SAA2B;QACjH,OAAO,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAI,SAAS,EAAE,SAAS,CAAC,CAAC;IACxE,CAAC;IAEe,KAAK,CAAC,SAAS,CAAmB,SAA8B,EAAE,SAA2B;QAC3G,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAI,SAAS,EAAE,SAAS,CAAC,CAAC;IAClE,CAAC;IAEe,KAAK,CAAC,aAAa,CAAuB,aAA4B;QACpF,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;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAI,aAAa,CAAC,CAAC;IAC/D,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<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined> {\n    return this._internalContext.getCachedSchema<T>(schemaKey, matchType);\n  }\n\n  public override async getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined> {\n    return this._internalContext.getSchema<T>(schemaKey, matchType);\n  }\n\n  public override async getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined> {\n    const mappedKey = this._nameMappings.resolveItemKey(schemaItemKey);\n    if(mappedKey !== undefined) {\n      schemaItemKey = mappedKey as SchemaItemKey;\n    }\n    return this._internalContext.getSchemaItem<T>(schemaItemKey);\n  }\n}\n"]}
+{"version":3,"file":"SchemaMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaMerger.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAAwH;AACxH,8CAAwD;AACxD,mDAA8D;AAC9D,uEAAqG;AACrG,iEAA8D;AAC9D,+DAA4D;AAE5D,oDAA2E;AAC3E,qDAAkD;AAclD;;;;GAIG;AACH,MAAa,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,IAAA,uCAAoB,EAAC,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,6BAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QACjF,MAAM,eAAe,GAAG,6BAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;QAEjF,MAAM,WAAW,GAAG,IAAI,yBAAW,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAI,4BAAmB,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,6BAAoB,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,8BAAkB,IAAI,KAAK,CAAC,WAAW,KAAK,2BAAe,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,2CAAoB,CAAC;YACvC,MAAM;YACN,YAAY,EAAE,MAAM;YACpB,eAAe;YACf,eAAe;YACf,WAAW;SACZ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,yCAAmB,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;AA7ED,oCA6EC;AAED;;;;;GAKG;AACH,MAAM,oBAAqB,SAAQ,iCAAa;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,CAAmB,SAA8B,EAAE,SAA2B;QACjH,OAAO,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAI,SAAS,EAAE,SAAS,CAAC,CAAC;IACxE,CAAC;IAEe,KAAK,CAAC,SAAS,CAAmB,SAA8B,EAAE,SAA2B;QAC3G,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAI,SAAS,EAAE,SAAS,CAAC,CAAC;IAClE,CAAC;IAEe,KAAK,CAAC,aAAa,CAAuB,aAA4B;QACpF,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;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAI,aAAa,CAAC,CAAC;IAC/D,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<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined> {\n    return this._internalContext.getCachedSchema<T>(schemaKey, matchType);\n  }\n\n  public override async getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined> {\n    return this._internalContext.getSchema<T>(schemaKey, matchType);\n  }\n\n  public override async getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined> {\n    const mappedKey = this._nameMappings.resolveItemKey(schemaItemKey);\n    if(mappedKey !== undefined) {\n      schemaItemKey = mappedKey as SchemaItemKey;\n    }\n    return this._internalContext.getSchemaItem<T>(schemaItemKey);\n  }\n}\n"]}

package/lib/cjs/Merging/SchemaMergingVisitor.js

@@ -27,6 +27,7 @@ const FormatMerger_1 = require("./FormatMerger");
  * @internal
  */
 class SchemaMergingVisitor {
+    _context;
     /**
      * Initializes a new instance of SchemaMergingVisitor class.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaMergingVisitor.js","sourceRoot":"","sources":["../../../src/Merging/SchemaMergingVisitor.ts"],"names":[],"mappings":";;;AAWA,qDAA+D;AAC/D,mEAA6D;AAC7D,6EAAmG;AACnG,2DAAwF;AACxF,2DAAwE;AACxE,yDAAqE;AACrE,iEAAwG;AACxG,+CAAgE;AAChE,yDAAqE;AACrE,qEAAuF;AACvF,uEAAyJ;AACzJ,mEAAsF;AACtF,2DAAwE;AACxE,yDAAqE;AACrE,qDAA2D;AAC3D,iDAA0D;AAI1D,mCAAoC;AACpC,6CAAmD;AACnD,6DAA2E;AAC3E,iDAAkG;AAQlG;;;;GAIG;AACH,MAAa,oBAAoB;IAI/B;;OAEG;IACH,YAAY,OAA2B;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,oBAAoB,CAAmC,KAAQ,EAAE,KAAa,EAAE,KAA4B,EAAE,OAAiC;QAC3J,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBACrB,iGAAiG;gBACjG,mGAAmG;gBACnG,+DAA+D;gBAC/D,IAAG,KAAK,CAAC,UAAU,KAAK,KAAK,IAAI,CAAC,MAAM,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACrF,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE;wBAC/B,GAAG,KAAK;wBACR,UAAU,EAAE;4BACV,GAAG,KAAK,CAAC,UAAU;4BACnB,8FAA8F;4BAC9F,SAAS,EAAE,SAAS;4BACpB,MAAM,EAAE,SAAS;4BACjB,UAAU,EAAE,SAAS;4BACrB,gBAAgB,EAAE,SAAS;yBAC5B;qBACF,CAAC,CAAC;oBAEH,gFAAgF;oBAChF,qEAAqE;oBACrE,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAA,yBAAiB,EAAC,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC;oBAC5F,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;oBAEpC,OAAO;gBACT,CAAC;gBAED,qGAAqG;gBACrG,8DAA8D;gBAC9D,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;YACxF,CAAC;YACD,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,uBAAuB,CAAC,KAAyB;QAC5D,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,4BAAW;YAChB,MAAM,EAAE,+BAAc;SACvB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mCAAmC,CAAC,KAAqC,EAAE,KAAa,EAAE,KAA4B;QACjI,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,oDAAuB;YAC5B,MAAM,EAAE,uDAA0B;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,sCAAsC,CAAC,KAAgC;QAClF,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,0CAAkB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B,EAAE,KAAa,EAAE,KAA4B;QAC/G,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,kCAAc;YACnB,MAAM,EAAE,qCAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B,CAAC,KAAiC;QAC5E,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,kCAAc,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B;QAClE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,kCAAc;YACnB,MAAM,EAAE,qCAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,gCAAa,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YACvD,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAA,mCAAgB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzG,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,KAAuB;QACxD,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,wBAAS;YACd,MAAM,EAAE,2BAAY;SACrB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAA,+BAAgB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzG,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,8BAA8B,CAAC,KAAgC;QAC1E,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAA,oCAAqB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,2BAA2B,CAAC,KAA6B;QACpE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,oCAAe;YACpB,MAAM,EAAE,uCAAkB;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,6BAA6B,CAAC,KAA+B;QACxE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,wCAAiB;YACtB,MAAM,EAAE,2CAAoB;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,KAA2B,EAAE,KAAa,EAAE,KAA4B;QACxG,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,2BAAa;YAClB,MAAM,EAAE,8BAAgB;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,gCAAa;YAClB,MAAM,EAAE,mCAAgB;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B,CAAC,KAAiC;QAC5E,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,4CAAmB;YACxB,MAAM,EAAE,+CAAsB;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,uBAAuB,CAAC,KAA8B;QACjE,MAAM,IAAA,wCAAuB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gCAAgC,CAAC,KAAkC,EAAE,KAAa,EAAE,KAA4B;QAC3H,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,8CAAoB;YACzB,MAAM,EAAE,iDAAuB;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0CAA0C,CAAC,KAA4C;QAClG,MAAM,IAAA,0DAAgC,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qCAAqC,CAAC,KAAuC;QACxF,MAAM,IAAA,qDAA2B,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,EAAE,UAAU,EAAoB;QACjE,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QAC9F,CAAC;QACD,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;QACnG,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,yBAAyB,CAAoC,KAAQ,EAAE,OAAiC;QACpH,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC3C,CAAC;YACD,KAAK,QAAQ;gBAAE,CAAC;oBACd,IAAG,gBAAgB,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc,KAAK,KAAK,CAAC,UAAU,EAAE,CAAC;wBAChG,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,CAAC,QAAQ,kBAAkB,CAAC,CAAC;oBAClF,CAAC;oBAED,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACxF,CAAC;gBAAA,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,8BAA8B,CAAC,KAAgC;QAC1E,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,2CAAmB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC7D,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAA,8CAAsB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B,EAAE,KAAa,EAAE,KAA4B;QAC/G,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,kCAAc;YACnB,MAAM,EAAE,qCAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mBAAmB,CAAC,KAAqB;QACpD,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,oBAAO;YACZ,MAAM,EAAE,uBAAU;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,gCAAa;YAClB,MAAM,EAAE,mCAAgB;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;MAGE;IACK,KAAK,CAAC,+CAA+C,CAAC,KAAiD;QAC5G,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,4CAAqB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;CACF;AAzUD,oDAyUC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,KAA4B,EAAE,SAAkD,EAAE,SAAiB;IACtH,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9C,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACrB,OAAO,CAAC,CAAC;IACb,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC","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*--------------------------------------------------------------------------------------------*/\nimport { AnyClassItemDifference, AnySchemaDifference, AnySchemaItemDifference, ClassPropertyDifference, \n  ConstantDifference, CustomAttributeClassDifference, CustomAttributeDifference, EntityClassDifference, \n  EntityClassMixinDifference, EnumerationDifference, EnumeratorDifference, FormatDifference, FormatUnitDifference, \n  FormatUnitLabelDifference, InvertedUnitDifference, KindOfQuantityDifference, KindOfQuantityPresentationFormatDifference, \n  MixinClassDifference, PhenomenonDifference, PropertyCategoryDifference, RelationshipClassDifference, \n  RelationshipConstraintClassDifference, RelationshipConstraintDifference, SchemaDifference, SchemaReferenceDifference, \n  StructClassDifference, UnitDifference, UnitSystemDifference } from \"../Differencing/SchemaDifference\";\nimport { addConstant, modifyConstant } from \"./ConstantMerger\";\nimport { addCustomAttribute } from \"./CustomAttributeMerger\";\nimport { addCustomAttributeClass, modifyCustomAttributeClass } from \"./CustomAttributeClassMerger\";\nimport { addClassMixins, addEntityClass, modifyEntityClass } from \"./EntityClassMerger\";\nimport { addEnumeration, modifyEnumeration } from \"./EnumerationMerger\";\nimport { addEnumerator, modifyEnumerator } from \"./EnumeratorMerger\";\nimport { addKindOfQuantity, addPresentationFormat, modifyKindOfQuantity } from \"./KindOfQuantityMerger\";\nimport { addMixinClass, modifyMixinClass } from \"./MixinMerger\";\nimport { addPhenomenon, modifyPhenomenon } from \"./PhenomenonMerger\";\nimport { addPropertyCategory, modifyPropertyCategory } from \"./PropertyCategoryMerger\";\nimport { addRelationshipClass, mergeRelationshipClassConstraint, mergeRelationshipConstraint, modifyRelationshipClass } from \"./RelationshipClassMerger\";\nimport { addSchemaReferences, modifySchemaReferences } from \"./SchemaReferenceMerger\";\nimport { addStructClass, modifyStructClass } from \"./StructClassMerger\";\nimport { addUnitSystem, modifyUnitSystem } from \"./UnitSystemMerger\";\nimport { mergePropertyDifference } from \"./PropertyMerger\";\nimport { isClassDifference } from \"../Differencing/Utils\";\nimport { SchemaDifferenceVisitor } from \"../Differencing/SchemaDifferenceVisitor\";\nimport { SchemaItemKey } from \"@itwin/ecschema-metadata\";\nimport { SchemaMergeContext } from \"./SchemaMerger\";\nimport { toItemKey } from \"./Utils\";\nimport { addUnit, modifyUnit } from \"./UnitMerger\";\nimport { addInvertedUnit, modifyInvertedUnit } from \"./InvertedUnitMerger\";\nimport { addFormat, modifyFormat, modifyFormatUnit, modifyFormatUnitLabel } from \"./FormatMerger\";\n\n/** Definition of schema items change type handler array. */\ninterface ItemChangeTypeHandler<T extends AnySchemaDifference> {\n  add: (context: SchemaMergeContext, entry: T) => Promise<void>;\n  modify: (context: SchemaMergeContext, entry: T, key: SchemaItemKey) => Promise<void>;\n}\n\n/**\n * Implementation of ISchemaDifferenceVisitor that can be used to traverse schema\n * differences to call the appropriated merger methods.\n * @internal\n */\nexport class SchemaMergingVisitor implements SchemaDifferenceVisitor {\n\n  private readonly _context: SchemaMergeContext;\n\n  /**\n   * Initializes a new instance of SchemaMergingVisitor class.\n   */\n  constructor(context: SchemaMergeContext) {\n    this._context = context;\n  }\n\n  /**\n   * Shared merging logic for all types of ClassItemDifference union.\n   */\n  private async visitClassDifference<T extends AnyClassItemDifference>(entry: T, index: number, array: AnySchemaDifference[], handler: ItemChangeTypeHandler<T>) {\n    return this.visitSchemaItemDifference(entry, {\n      add: async (context) => {\n        // To add classes a slightly different approach is done. In fact the class entries gets processed\n        // two times. The first time, a stub with the bare minimum is added to the schema. The second time,\n        // the class gets completed with all properties, mixins, etc...\n        if(entry.changeType === \"add\" && !await context.targetSchema.getItem(entry.itemName)) {\n          await handler.add(this._context, {\n            ...entry,\n            difference: {\n              ...entry.difference,\n              // Remove everything we want to validate before setting, this is done in the second iteration.\n              baseClass: undefined,\n              mixins: undefined,\n              properties: undefined,\n              customAttributes: undefined,\n            },\n          });\n\n          // Searches for the last class difference and adds the entry after it. That way,\n          // the class is completed before class related entries get processed.\n          const insertIndex = findIndexOf(array, (e) => !isClassDifference(e), index) || array.length;\n          array.splice(insertIndex, 0, entry);\n\n          return;\n        }\n\n        // Now both a modification change or the second add iteration is a modification of an existing class.\n        // So, regardless of the actual change type, modify is called.\n        return handler.modify(this._context, entry, toItemKey(this._context, entry.itemName));\n      },\n      modify: handler.modify,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling ConstantDifference.\n   * @internal\n   */\n  public async visitConstantDifference(entry: ConstantDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addConstant,\n      modify: modifyConstant,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling CustomAttributeClassDifference.\n   * @internal\n   */\n  public async visitCustomAttributeClassDifference(entry: CustomAttributeClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addCustomAttributeClass,\n      modify: modifyCustomAttributeClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling CustomAttributeDifference.\n   * @internal\n   */\n  public async visitCustomAttributeInstanceDifference(entry: CustomAttributeDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addCustomAttribute(this._context, entry);\n    }\n  }\n\n  /**\n   * Visitor implementation for handling EntityClassDifference.\n   * @internal\n   */\n  public async visitEntityClassDifference(entry: EntityClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addEntityClass,\n      modify: modifyEntityClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling EntityClassMixinDifference.\n   * @internal\n   */\n  public async visitEntityClassMixinDifference(entry: EntityClassMixinDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addClassMixins(this._context, entry);\n    }\n  }\n\n  /**\n   * Visitor implementation for handling EnumerationDifference.\n   * @internal\n   */\n  public async visitEnumerationDifference(entry: EnumerationDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addEnumeration,\n      modify: modifyEnumeration,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling EnumeratorDifference.\n   * @internal\n   */\n  public async visitEnumeratorDifference(entry: EnumeratorDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addEnumerator(this._context, entry);\n      case \"modify\": return modifyEnumerator(this._context, entry, toItemKey(this._context, entry.itemName));\n    }\n  }\n\n  /**\n   * Visitor implementation for handling FormatDifference.\n   * @internal\n   */\n  public async visitFormatDifference(entry: FormatDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addFormat,\n      modify: modifyFormat,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling FormatUnitDifference.\n   * @internal\n   */\n  public async visitFormatUnitDifference(entry: FormatUnitDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"modify\": return modifyFormatUnit(this._context, entry, toItemKey(this._context, entry.itemName));\n    }\n  }\n\n  /**\n   * Visitor implementation for handling FormatUnitLabelDifference.\n   * @internal\n   */\n  public async visitFormatUnitLabelDifference(entry: FormatUnitLabelDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"modify\": return modifyFormatUnitLabel(this._context, entry, toItemKey(this._context, entry.itemName));\n    }\n  }\n\n  /**\n   * Visitor implementation for handling InvertedUnitDifference.\n   * @internal\n   */\n  public async visitInvertedUnitDifference(entry: InvertedUnitDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addInvertedUnit,\n      modify: modifyInvertedUnit,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling KindOfQuantityDifference.\n   * @internal\n   */\n  public async visitKindOfQuantityDifference(entry: KindOfQuantityDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addKindOfQuantity,\n      modify: modifyKindOfQuantity,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling MixinClassDifference.\n   * @internal\n   */\n  public async visitMixinDifference(entry: MixinClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addMixinClass,\n      modify: modifyMixinClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling PhenomenonDifference.\n   * @internal\n   */\n  public async visitPhenomenonDifference(entry: PhenomenonDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addPhenomenon,\n      modify: modifyPhenomenon,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling PropertyCategoryDifference.\n   * @internal\n   */\n  public async visitPropertyCategoryDifference(entry: PropertyCategoryDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addPropertyCategory,\n      modify: modifyPropertyCategory,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling ClassPropertyDifference.\n   * @internal\n   */\n  public async visitPropertyDifference(entry: ClassPropertyDifference): Promise<void> {\n    await mergePropertyDifference(this._context, entry);\n  }\n\n  /**\n   * Visitor implementation for handling RelationshipClassDifference.\n   * @internal\n   */\n  public async visitRelationshipClassDifference(entry: RelationshipClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addRelationshipClass,\n      modify: modifyRelationshipClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling RelationshipConstraintClassDifference.\n   * @internal\n   */\n  public async visitRelationshipConstraintClassDifference(entry: RelationshipConstraintClassDifference): Promise<void> {\n    await mergeRelationshipClassConstraint(this._context, entry);\n  }\n\n  /**\n   * Visitor implementation for handling RelationshipConstraintDifference.\n   * @internal\n   */\n  public async visitRelationshipConstraintDifference(entry: RelationshipConstraintDifference): Promise<void> {\n    await mergeRelationshipConstraint(this._context, entry);\n  }\n\n  /**\n   * Visitor implementation for handling SchemaDifference.\n   * @internal\n   */\n  public async visitSchemaDifference({ difference }: SchemaDifference): Promise<void> {\n    if (difference.label !== undefined) {\n      await this._context.editor.setDisplayLabel(this._context.targetSchemaKey, difference.label);\n    }\n    if (difference.description !== undefined) {\n      await this._context.editor.setDescription(this._context.targetSchemaKey, difference.description);\n    }\n  }\n\n  /**\n   * Shared merging logic for all types of AnySchemaItemDifference union.\n   */\n  private async visitSchemaItemDifference<T extends AnySchemaItemDifference>(entry: T, handler: ItemChangeTypeHandler<T>) {\n    switch(entry.changeType) {\n      case \"add\": {\n        return handler.add(this._context, entry);\n      }\n      case \"modify\": {\n        if(\"schemaItemType\" in entry.difference && entry.difference.schemaItemType !== entry.schemaType) {\n          throw new Error(`Changing the type of item '${entry.itemName}' not supported.`);\n        }\n\n        return handler.modify(this._context, entry, toItemKey(this._context, entry.itemName));\n      };\n    }\n  }\n\n  /**\n   * Visitor implementation for handling SchemaReferenceDifference.\n   * @internal\n   */\n  public async visitSchemaReferenceDifference(entry: SchemaReferenceDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addSchemaReferences(this._context, entry);\n      case \"modify\": return modifySchemaReferences(this._context, entry);\n    }\n  }\n\n  /**\n   * Visitor implementation for handling StructClassDifference.\n   * @internal\n   */\n  public async visitStructClassDifference(entry: StructClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addStructClass,\n      modify: modifyStructClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling UnitDifference.\n   * @internal\n   */\n  public async visitUnitDifference(entry: UnitDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addUnit,\n      modify: modifyUnit,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling UnitSystemDifference.\n   * @internal\n   */\n  public async visitUnitSystemDifference(entry: UnitSystemDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addUnitSystem,\n      modify: modifyUnitSystem,\n    });\n  }\n\n  /**\n  * Visitor implementation for handling KindOfQuantityPresentationFormatDifference.\n  * @internal\n  */\n  public async visitKindOfQuantityPresentationFormatDifference(entry: KindOfQuantityPresentationFormatDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addPresentationFormat(this._context, entry, toItemKey(this._context, entry.itemName));\n    }\n  }\n}\n\n/**\n * Helper method to get the index of the first element in the array that satisfies the provided testing function.\n * @param array     Array to search.\n * @param predicate Function to execute on each value in the array.\n * @param fromIndex The index to start the search at.\n * @returns         An index in the array if an element passes the test; otherwise, false.\n */\nfunction findIndexOf(array: AnySchemaDifference[], predicate: (entry: AnySchemaDifference) => boolean, fromIndex: number) {\n  for (let i = fromIndex; i < array.length; i++) {\n    if (predicate(array[i]))\n      return i;\n  }\n  return false;\n}\n"]}
+{"version":3,"file":"SchemaMergingVisitor.js","sourceRoot":"","sources":["../../../src/Merging/SchemaMergingVisitor.ts"],"names":[],"mappings":";;;AAWA,qDAA+D;AAC/D,mEAA6D;AAC7D,6EAAmG;AACnG,2DAAwF;AACxF,2DAAwE;AACxE,yDAAqE;AACrE,iEAAwG;AACxG,+CAAgE;AAChE,yDAAqE;AACrE,qEAAuF;AACvF,uEAAyJ;AACzJ,mEAAsF;AACtF,2DAAwE;AACxE,yDAAqE;AACrE,qDAA2D;AAC3D,iDAA0D;AAI1D,mCAAoC;AACpC,6CAAmD;AACnD,6DAA2E;AAC3E,iDAAkG;AAQlG;;;;GAIG;AACH,MAAa,oBAAoB;IAEd,QAAQ,CAAqB;IAE9C;;OAEG;IACH,YAAY,OAA2B;QACrC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,oBAAoB,CAAmC,KAAQ,EAAE,KAAa,EAAE,KAA4B,EAAE,OAAiC;QAC3J,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBACrB,iGAAiG;gBACjG,mGAAmG;gBACnG,+DAA+D;gBAC/D,IAAG,KAAK,CAAC,UAAU,KAAK,KAAK,IAAI,CAAC,MAAM,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACrF,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE;wBAC/B,GAAG,KAAK;wBACR,UAAU,EAAE;4BACV,GAAG,KAAK,CAAC,UAAU;4BACnB,8FAA8F;4BAC9F,SAAS,EAAE,SAAS;4BACpB,MAAM,EAAE,SAAS;4BACjB,UAAU,EAAE,SAAS;4BACrB,gBAAgB,EAAE,SAAS;yBAC5B;qBACF,CAAC,CAAC;oBAEH,gFAAgF;oBAChF,qEAAqE;oBACrE,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAA,yBAAiB,EAAC,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC;oBAC5F,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;oBAEpC,OAAO;gBACT,CAAC;gBAED,qGAAqG;gBACrG,8DAA8D;gBAC9D,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;YACxF,CAAC;YACD,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,uBAAuB,CAAC,KAAyB;QAC5D,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,4BAAW;YAChB,MAAM,EAAE,+BAAc;SACvB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mCAAmC,CAAC,KAAqC,EAAE,KAAa,EAAE,KAA4B;QACjI,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,oDAAuB;YAC5B,MAAM,EAAE,uDAA0B;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,sCAAsC,CAAC,KAAgC;QAClF,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,0CAAkB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B,EAAE,KAAa,EAAE,KAA4B;QAC/G,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,kCAAc;YACnB,MAAM,EAAE,qCAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B,CAAC,KAAiC;QAC5E,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,kCAAc,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B;QAClE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,kCAAc;YACnB,MAAM,EAAE,qCAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,gCAAa,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YACvD,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAA,mCAAgB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzG,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,KAAuB;QACxD,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,wBAAS;YACd,MAAM,EAAE,2BAAY;SACrB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAA,+BAAgB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzG,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,8BAA8B,CAAC,KAAgC;QAC1E,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAA,oCAAqB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9G,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,2BAA2B,CAAC,KAA6B;QACpE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,oCAAe;YACpB,MAAM,EAAE,uCAAkB;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,6BAA6B,CAAC,KAA+B;QACxE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,wCAAiB;YACtB,MAAM,EAAE,2CAAoB;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,KAA2B,EAAE,KAAa,EAAE,KAA4B;QACxG,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,2BAAa;YAClB,MAAM,EAAE,8BAAgB;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,gCAAa;YAClB,MAAM,EAAE,mCAAgB;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B,CAAC,KAAiC;QAC5E,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,4CAAmB;YACxB,MAAM,EAAE,+CAAsB;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,uBAAuB,CAAC,KAA8B;QACjE,MAAM,IAAA,wCAAuB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gCAAgC,CAAC,KAAkC,EAAE,KAAa,EAAE,KAA4B;QAC3H,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,8CAAoB;YACzB,MAAM,EAAE,iDAAuB;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0CAA0C,CAAC,KAA4C;QAClG,MAAM,IAAA,0DAAgC,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qCAAqC,CAAC,KAAuC;QACxF,MAAM,IAAA,qDAA2B,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,EAAE,UAAU,EAAoB;QACjE,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QAC9F,CAAC;QACD,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;QACnG,CAAC;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,yBAAyB,CAAoC,KAAQ,EAAE,OAAiC;QACpH,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC3C,CAAC;YACD,KAAK,QAAQ;gBAAE,CAAC;oBACd,IAAG,gBAAgB,IAAI,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc,KAAK,KAAK,CAAC,UAAU,EAAE,CAAC;wBAChG,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,CAAC,QAAQ,kBAAkB,CAAC,CAAC;oBAClF,CAAC;oBAED,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACxF,CAAC;gBAAA,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,8BAA8B,CAAC,KAAgC;QAC1E,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,2CAAmB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC7D,KAAK,QAAQ,CAAC,CAAC,OAAO,IAAA,8CAAsB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAA4B,EAAE,KAAa,EAAE,KAA4B;QAC/G,OAAO,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;YACpD,GAAG,EAAE,kCAAc;YACnB,MAAM,EAAE,qCAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mBAAmB,CAAC,KAAqB;QACpD,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,oBAAO;YACZ,MAAM,EAAE,uBAAU;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CAAC,KAA2B;QAChE,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE;YAC3C,GAAG,EAAE,gCAAa;YAClB,MAAM,EAAE,mCAAgB;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;MAGE;IACK,KAAK,CAAC,+CAA+C,CAAC,KAAiD;QAC5G,QAAO,KAAK,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC,CAAC,OAAO,IAAA,4CAAqB,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAA,iBAAS,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;CACF;AAzUD,oDAyUC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,KAA4B,EAAE,SAAkD,EAAE,SAAiB;IACtH,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9C,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACrB,OAAO,CAAC,CAAC;IACb,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC","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*--------------------------------------------------------------------------------------------*/\nimport { AnyClassItemDifference, AnySchemaDifference, AnySchemaItemDifference, ClassPropertyDifference, \n  ConstantDifference, CustomAttributeClassDifference, CustomAttributeDifference, EntityClassDifference, \n  EntityClassMixinDifference, EnumerationDifference, EnumeratorDifference, FormatDifference, FormatUnitDifference, \n  FormatUnitLabelDifference, InvertedUnitDifference, KindOfQuantityDifference, KindOfQuantityPresentationFormatDifference, \n  MixinClassDifference, PhenomenonDifference, PropertyCategoryDifference, RelationshipClassDifference, \n  RelationshipConstraintClassDifference, RelationshipConstraintDifference, SchemaDifference, SchemaReferenceDifference, \n  StructClassDifference, UnitDifference, UnitSystemDifference } from \"../Differencing/SchemaDifference\";\nimport { addConstant, modifyConstant } from \"./ConstantMerger\";\nimport { addCustomAttribute } from \"./CustomAttributeMerger\";\nimport { addCustomAttributeClass, modifyCustomAttributeClass } from \"./CustomAttributeClassMerger\";\nimport { addClassMixins, addEntityClass, modifyEntityClass } from \"./EntityClassMerger\";\nimport { addEnumeration, modifyEnumeration } from \"./EnumerationMerger\";\nimport { addEnumerator, modifyEnumerator } from \"./EnumeratorMerger\";\nimport { addKindOfQuantity, addPresentationFormat, modifyKindOfQuantity } from \"./KindOfQuantityMerger\";\nimport { addMixinClass, modifyMixinClass } from \"./MixinMerger\";\nimport { addPhenomenon, modifyPhenomenon } from \"./PhenomenonMerger\";\nimport { addPropertyCategory, modifyPropertyCategory } from \"./PropertyCategoryMerger\";\nimport { addRelationshipClass, mergeRelationshipClassConstraint, mergeRelationshipConstraint, modifyRelationshipClass } from \"./RelationshipClassMerger\";\nimport { addSchemaReferences, modifySchemaReferences } from \"./SchemaReferenceMerger\";\nimport { addStructClass, modifyStructClass } from \"./StructClassMerger\";\nimport { addUnitSystem, modifyUnitSystem } from \"./UnitSystemMerger\";\nimport { mergePropertyDifference } from \"./PropertyMerger\";\nimport { isClassDifference } from \"../Differencing/Utils\";\nimport { SchemaDifferenceVisitor } from \"../Differencing/SchemaDifferenceVisitor\";\nimport { SchemaItemKey } from \"@itwin/ecschema-metadata\";\nimport { SchemaMergeContext } from \"./SchemaMerger\";\nimport { toItemKey } from \"./Utils\";\nimport { addUnit, modifyUnit } from \"./UnitMerger\";\nimport { addInvertedUnit, modifyInvertedUnit } from \"./InvertedUnitMerger\";\nimport { addFormat, modifyFormat, modifyFormatUnit, modifyFormatUnitLabel } from \"./FormatMerger\";\n\n/** Definition of schema items change type handler array. */\ninterface ItemChangeTypeHandler<T extends AnySchemaDifference> {\n  add: (context: SchemaMergeContext, entry: T) => Promise<void>;\n  modify: (context: SchemaMergeContext, entry: T, key: SchemaItemKey) => Promise<void>;\n}\n\n/**\n * Implementation of ISchemaDifferenceVisitor that can be used to traverse schema\n * differences to call the appropriated merger methods.\n * @internal\n */\nexport class SchemaMergingVisitor implements SchemaDifferenceVisitor {\n\n  private readonly _context: SchemaMergeContext;\n\n  /**\n   * Initializes a new instance of SchemaMergingVisitor class.\n   */\n  constructor(context: SchemaMergeContext) {\n    this._context = context;\n  }\n\n  /**\n   * Shared merging logic for all types of ClassItemDifference union.\n   */\n  private async visitClassDifference<T extends AnyClassItemDifference>(entry: T, index: number, array: AnySchemaDifference[], handler: ItemChangeTypeHandler<T>) {\n    return this.visitSchemaItemDifference(entry, {\n      add: async (context) => {\n        // To add classes a slightly different approach is done. In fact the class entries gets processed\n        // two times. The first time, a stub with the bare minimum is added to the schema. The second time,\n        // the class gets completed with all properties, mixins, etc...\n        if(entry.changeType === \"add\" && !await context.targetSchema.getItem(entry.itemName)) {\n          await handler.add(this._context, {\n            ...entry,\n            difference: {\n              ...entry.difference,\n              // Remove everything we want to validate before setting, this is done in the second iteration.\n              baseClass: undefined,\n              mixins: undefined,\n              properties: undefined,\n              customAttributes: undefined,\n            },\n          });\n\n          // Searches for the last class difference and adds the entry after it. That way,\n          // the class is completed before class related entries get processed.\n          const insertIndex = findIndexOf(array, (e) => !isClassDifference(e), index) || array.length;\n          array.splice(insertIndex, 0, entry);\n\n          return;\n        }\n\n        // Now both a modification change or the second add iteration is a modification of an existing class.\n        // So, regardless of the actual change type, modify is called.\n        return handler.modify(this._context, entry, toItemKey(this._context, entry.itemName));\n      },\n      modify: handler.modify,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling ConstantDifference.\n   * @internal\n   */\n  public async visitConstantDifference(entry: ConstantDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addConstant,\n      modify: modifyConstant,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling CustomAttributeClassDifference.\n   * @internal\n   */\n  public async visitCustomAttributeClassDifference(entry: CustomAttributeClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addCustomAttributeClass,\n      modify: modifyCustomAttributeClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling CustomAttributeDifference.\n   * @internal\n   */\n  public async visitCustomAttributeInstanceDifference(entry: CustomAttributeDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addCustomAttribute(this._context, entry);\n    }\n  }\n\n  /**\n   * Visitor implementation for handling EntityClassDifference.\n   * @internal\n   */\n  public async visitEntityClassDifference(entry: EntityClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addEntityClass,\n      modify: modifyEntityClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling EntityClassMixinDifference.\n   * @internal\n   */\n  public async visitEntityClassMixinDifference(entry: EntityClassMixinDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addClassMixins(this._context, entry);\n    }\n  }\n\n  /**\n   * Visitor implementation for handling EnumerationDifference.\n   * @internal\n   */\n  public async visitEnumerationDifference(entry: EnumerationDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addEnumeration,\n      modify: modifyEnumeration,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling EnumeratorDifference.\n   * @internal\n   */\n  public async visitEnumeratorDifference(entry: EnumeratorDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addEnumerator(this._context, entry);\n      case \"modify\": return modifyEnumerator(this._context, entry, toItemKey(this._context, entry.itemName));\n    }\n  }\n\n  /**\n   * Visitor implementation for handling FormatDifference.\n   * @internal\n   */\n  public async visitFormatDifference(entry: FormatDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addFormat,\n      modify: modifyFormat,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling FormatUnitDifference.\n   * @internal\n   */\n  public async visitFormatUnitDifference(entry: FormatUnitDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"modify\": return modifyFormatUnit(this._context, entry, toItemKey(this._context, entry.itemName));\n    }\n  }\n\n  /**\n   * Visitor implementation for handling FormatUnitLabelDifference.\n   * @internal\n   */\n  public async visitFormatUnitLabelDifference(entry: FormatUnitLabelDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"modify\": return modifyFormatUnitLabel(this._context, entry, toItemKey(this._context, entry.itemName));\n    }\n  }\n\n  /**\n   * Visitor implementation for handling InvertedUnitDifference.\n   * @internal\n   */\n  public async visitInvertedUnitDifference(entry: InvertedUnitDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addInvertedUnit,\n      modify: modifyInvertedUnit,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling KindOfQuantityDifference.\n   * @internal\n   */\n  public async visitKindOfQuantityDifference(entry: KindOfQuantityDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addKindOfQuantity,\n      modify: modifyKindOfQuantity,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling MixinClassDifference.\n   * @internal\n   */\n  public async visitMixinDifference(entry: MixinClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addMixinClass,\n      modify: modifyMixinClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling PhenomenonDifference.\n   * @internal\n   */\n  public async visitPhenomenonDifference(entry: PhenomenonDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addPhenomenon,\n      modify: modifyPhenomenon,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling PropertyCategoryDifference.\n   * @internal\n   */\n  public async visitPropertyCategoryDifference(entry: PropertyCategoryDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addPropertyCategory,\n      modify: modifyPropertyCategory,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling ClassPropertyDifference.\n   * @internal\n   */\n  public async visitPropertyDifference(entry: ClassPropertyDifference): Promise<void> {\n    await mergePropertyDifference(this._context, entry);\n  }\n\n  /**\n   * Visitor implementation for handling RelationshipClassDifference.\n   * @internal\n   */\n  public async visitRelationshipClassDifference(entry: RelationshipClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addRelationshipClass,\n      modify: modifyRelationshipClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling RelationshipConstraintClassDifference.\n   * @internal\n   */\n  public async visitRelationshipConstraintClassDifference(entry: RelationshipConstraintClassDifference): Promise<void> {\n    await mergeRelationshipClassConstraint(this._context, entry);\n  }\n\n  /**\n   * Visitor implementation for handling RelationshipConstraintDifference.\n   * @internal\n   */\n  public async visitRelationshipConstraintDifference(entry: RelationshipConstraintDifference): Promise<void> {\n    await mergeRelationshipConstraint(this._context, entry);\n  }\n\n  /**\n   * Visitor implementation for handling SchemaDifference.\n   * @internal\n   */\n  public async visitSchemaDifference({ difference }: SchemaDifference): Promise<void> {\n    if (difference.label !== undefined) {\n      await this._context.editor.setDisplayLabel(this._context.targetSchemaKey, difference.label);\n    }\n    if (difference.description !== undefined) {\n      await this._context.editor.setDescription(this._context.targetSchemaKey, difference.description);\n    }\n  }\n\n  /**\n   * Shared merging logic for all types of AnySchemaItemDifference union.\n   */\n  private async visitSchemaItemDifference<T extends AnySchemaItemDifference>(entry: T, handler: ItemChangeTypeHandler<T>) {\n    switch(entry.changeType) {\n      case \"add\": {\n        return handler.add(this._context, entry);\n      }\n      case \"modify\": {\n        if(\"schemaItemType\" in entry.difference && entry.difference.schemaItemType !== entry.schemaType) {\n          throw new Error(`Changing the type of item '${entry.itemName}' not supported.`);\n        }\n\n        return handler.modify(this._context, entry, toItemKey(this._context, entry.itemName));\n      };\n    }\n  }\n\n  /**\n   * Visitor implementation for handling SchemaReferenceDifference.\n   * @internal\n   */\n  public async visitSchemaReferenceDifference(entry: SchemaReferenceDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addSchemaReferences(this._context, entry);\n      case \"modify\": return modifySchemaReferences(this._context, entry);\n    }\n  }\n\n  /**\n   * Visitor implementation for handling StructClassDifference.\n   * @internal\n   */\n  public async visitStructClassDifference(entry: StructClassDifference, index: number, array: AnySchemaDifference[]): Promise<void> {\n    return this.visitClassDifference(entry, index, array, {\n      add: addStructClass,\n      modify: modifyStructClass,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling UnitDifference.\n   * @internal\n   */\n  public async visitUnitDifference(entry: UnitDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addUnit,\n      modify: modifyUnit,\n    });\n  }\n\n  /**\n   * Visitor implementation for handling UnitSystemDifference.\n   * @internal\n   */\n  public async visitUnitSystemDifference(entry: UnitSystemDifference): Promise<void> {\n    return this.visitSchemaItemDifference(entry, {\n      add: addUnitSystem,\n      modify: modifyUnitSystem,\n    });\n  }\n\n  /**\n  * Visitor implementation for handling KindOfQuantityPresentationFormatDifference.\n  * @internal\n  */\n  public async visitKindOfQuantityPresentationFormatDifference(entry: KindOfQuantityPresentationFormatDifference): Promise<void> {\n    switch(entry.changeType) {\n      case \"add\": return addPresentationFormat(this._context, entry, toItemKey(this._context, entry.itemName));\n    }\n  }\n}\n\n/**\n * Helper method to get the index of the first element in the array that satisfies the provided testing function.\n * @param array     Array to search.\n * @param predicate Function to execute on each value in the array.\n * @param fromIndex The index to start the search at.\n * @returns         An index in the array if an element passes the test; otherwise, false.\n */\nfunction findIndexOf(array: AnySchemaDifference[], predicate: (entry: AnySchemaDifference) => boolean, fromIndex: number) {\n  for (let i = fromIndex; i < array.length; i++) {\n    if (predicate(array[i]))\n      return i;\n  }\n  return false;\n}\n"]}

package/lib/cjs/Validation/Diagnostic.js

@@ -64,6 +64,12 @@ class BaseDiagnostic {
         this.messageArgs = messageArgs;
         this.category = category;
     }
+    /** The EC object to associate with the diagnostic. */
+    ecDefinition;
+    /** The arguments used when formatting the diagnostic message.  */
+    messageArgs;
+    /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+    category;
 }
 exports.BaseDiagnostic = BaseDiagnostic;
 /**
@@ -71,7 +77,7 @@ exports.BaseDiagnostic = BaseDiagnostic;
  * @beta
  */
 class SchemaDiagnostic extends BaseDiagnostic {
-    static { this.diagnosticType = DiagnosticType.SchemaItem; }
+    static diagnosticType = DiagnosticType.SchemaItem;
     /**
      * Initializes a new SchemaDiagnostic.
      * @param ecDefinition The EC object to associate with the diagnostic.
@@ -92,7 +98,7 @@ exports.SchemaDiagnostic = SchemaDiagnostic;
  * @beta
  */
 class SchemaItemDiagnostic extends BaseDiagnostic {
-    static { this.diagnosticType = DiagnosticType.SchemaItem; }
+    static diagnosticType = DiagnosticType.SchemaItem;
     /**
      * Initializes a new SchemaItemDiagnostic.
      * @param ecDefinition The EC object to associate with the diagnostic.
@@ -195,7 +201,7 @@ exports.CustomAttributeContainerDiagnostic = CustomAttributeContainerDiagnostic;
 function createSchemaDiagnosticClass(code, messageText) {
     validateCode(code);
     return class extends SchemaDiagnostic {
-        static { this.code = code; }
+        static code = code;
         get code() { return code; }
         get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
     };
@@ -235,7 +241,7 @@ function createClassDiagnosticClass(code, messageText) {
 function createPropertyDiagnosticClass(code, messageText) {
     validateCode(code);
     return class extends PropertyDiagnostic {
-        static { this.code = code; }
+        static code = code;
         get code() { return code; }
         get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
     };

package/lib/cjs/Validation/Diagnostic.js.map

@@ -1 +1 @@
-{"version":3,"file":"Diagnostic.js","sourceRoot":"","sources":["../../../src/Validation/Diagnostic.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA6OH,kEAOC;AAQD,0EAMC;AAQD,gEAMC;AAQD,sEAOC;AAQD,kGAMC;AAQD,sGAMC;AAGD,gEAWC;AAGD,wDAeC;AAvVD,iDAAiD;AAEjD,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,IAAc,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACrD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,mDAAI,CAAA;IACJ,uDAAM,CAAA;IACN,+DAAU,CAAA;IACV,2DAAQ,CAAA;IACR,2FAAwB,CAAA;IACxB,uFAAsB,CAAA;AACxB,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iEAAO,CAAA;IACP,6DAAK,CAAA;IACL,uEAAU,CAAA;IACV,iEAAO,CAAA;AACT,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AA6BD;;;GAGG;AACH,MAAsB,cAAc;IAClC;;;;;OAKG;IACH,YAAY,YAAkB,EAAE,WAAkB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACzG,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CAiBF;AA5BD,wCA4BC;AAED;;;GAGG;AACH,MAAsB,gBAAqC,SAAQ,cAA4B;aAC/E,mBAAc,GAAG,cAAc,CAAC,UAAU,CAAC;IAEzD;;;;;OAKG;IACH,YAAY,MAAc,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACpG,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAEzD,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;;AAjB/E,4CAkBC;AAED;;;GAGG;AACH,MAAsB,oBAAkE,SAAQ,cAA0B;aAC1G,mBAAc,GAAG,cAAc,CAAC,UAAU,CAAC;IACzD;;;;;OAKG;IACH,YAAY,YAAwB,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC9G,KAAK,CAAC,YAAoB,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;;AAhBnF,oDAiBC;AAED;;;GAGG;AACH,MAAsB,eAAoC,SAAQ,oBAAoC;IACpG;;;;;OAKG;IACH,YAAY,OAAiB,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACvG,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,uDAAuD;IACvD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;CAC1E;AAbD,0CAaC;AAED;;;GAGG;AACH,MAAsB,kBAAuC,SAAQ,cAAiC;IACpG;;;;;OAKG;IACH,YAAY,QAAqB,EAAE,WAAkB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC5G,KAAK,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;CAChF;AAhBD,gDAgBC;AAED;;;GAGG;AACH,MAAsB,gCAAqD,SAAQ,cAA4C;IAC7H;;;;;OAKG;IACH,YAAY,UAAkC,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACxH,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC;CAC9F;AAhBD,4EAgBC;AAED;;;GAGG;AACH,MAAsB,kCAAuD,SAAQ,cAAmD;IACtI;;;;;OAKG;IACH,YAAY,SAAwC,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC9H,KAAK,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,wBAAwB,CAAC,CAAC,CAAC;CAChG;AAhBD,gFAgBC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAqB,IAAY,EAAE,WAAmB;IAC/F,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,gBAAsB;iBAC3B,SAAI,GAAG,IAAI,CAAC;QAC1B,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B,CAA8C,IAAY,EAAE,WAAmB;IAC5H,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,oBAAgC;QACnD,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CAAqB,IAAY,EAAE,WAAmB;IAC9F,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,eAAqB;QACxC,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,6BAA6B,CAAqB,IAAY,EAAE,WAAmB;IACjG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,kBAAwB;iBAC7B,SAAI,GAAG,IAAI,CAAC;QAC1B,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,2CAA2C,CAAqB,IAAY,EAAE,WAAmB;IAC/G,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,gCAAsC;QACzD,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,6CAA6C,CAAqB,IAAY,EAAE,WAAmB;IACjH,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,kCAAwC;QAC3D,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED,YAAY;AACZ,SAAgB,0BAA0B,CAAC,QAA4B;IACrE,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,kBAAkB,CAAC,KAAK;YAC3B,OAAO,OAAO,CAAC;QACjB,KAAK,kBAAkB,CAAC,OAAO;YAC7B,OAAO,SAAS,CAAC;QACnB,KAAK,kBAAkB,CAAC,OAAO;YAC7B,OAAO,SAAS,CAAC;QACnB,KAAK,kBAAkB,CAAC,UAAU;YAChC,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC;AAED,YAAY;AACZ,SAAgB,sBAAsB,CAAC,IAAoB;IACzD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,cAAc,CAAC,wBAAwB;YAC1C,OAAO,0BAA0B,CAAC;QACpC,KAAK,cAAc,CAAC,IAAI;YACtB,OAAO,MAAM,CAAC;QAChB,KAAK,cAAc,CAAC,QAAQ;YAC1B,OAAO,UAAU,CAAC;QACpB,KAAK,cAAc,CAAC,sBAAsB;YACxC,OAAO,wBAAwB,CAAC;QAClC,KAAK,cAAc,CAAC,MAAM;YACxB,OAAO,QAAQ,CAAC;QAClB,KAAK,cAAc,CAAC,UAAU;YAC5B,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,GAAG,GAAG,mBAAmB,IAAI,0DAA0D,CAAC;IAC9F,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvB,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC","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 Diagnostic\n */\n\nimport { AnyClass, AnyECType, AnyProperty, CustomAttributeContainerProps, RelationshipConstraint, Schema, SchemaItem } from \"@itwin/ecschema-metadata\";\n\n/* eslint-disable @typescript-eslint/no-shadow */\n\nconst formatString = (format: string, ...args: string[]) => {\n  return format.replace(/{(\\d+)}/g, (match, theNumber) => {\n    return typeof args[theNumber] !== \"undefined\"\n      ? args[theNumber]\n      : match;\n  });\n};\n\n/**\n * Defines the possible diagnostic types.\n * @beta\n */\nexport enum DiagnosticType {\n  None,\n  Schema,\n  SchemaItem,\n  Property,\n  CustomAttributeContainer,\n  RelationshipConstraint,\n}\n\n/**\n * Defines the possible diagnostic categories.\n * @beta\n */\nexport enum DiagnosticCategory {\n  Warning,\n  Error,\n  Suggestion,\n  Message,\n}\n\n/**\n * The interface implemented by all diagnostics used during schema validation.\n * @beta\n */\nexport interface IDiagnostic<TYPE extends AnyECType, ARGS extends any[]> {\n  /** The diagnostic category (error, warning, etc...). Value is static across all instances. */\n  category: DiagnosticCategory;\n  /** The unique string identifier of the diagnostic in the format '<ruleSetName>:<number>. Value is static across all instances. */\n  code: string;\n  /** The context type of diagnostic (schema, schema item, property, etc...). Value is static across all instances. */\n  diagnosticType: DiagnosticType;\n  /** The unformatted message text associated with the diagnostic. Value is static across all instances. */\n  messageText: string;\n  /** The arguments used when formatted the diagnostic instance's message. */\n  messageArgs?: ARGS;\n  /** The EC object associated with the diagnostic instance. */\n  ecDefinition: TYPE;\n  /** The schema where the diagnostic originated. */\n  schema: Schema;\n}\n\n/**\n * Type which encapsulates all possible diagnostics.\n * @beta\n */\nexport type AnyDiagnostic = IDiagnostic<AnyECType, any[]>;\n\n/**\n * The abstract base class for all [[IDiagnostic]] implementations.\n * @beta\n */\nexport abstract class BaseDiagnostic<TYPE extends AnyECType, ARGS extends any[]> implements IDiagnostic<TYPE, ARGS> {\n  /**\n   * Initializes a new BaseDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecDefinition: TYPE, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    this.ecDefinition = ecDefinition;\n    this.messageArgs = messageArgs;\n    this.category = category;\n  }\n\n  /** Gets the unique string identifier for the diagnostic in the format '<ruleSetName>:<number>'. */\n  public abstract get code(): string;\n  /** Gets the context type of the diagnostic (schema, schema item, property, etc...) */\n  public abstract get diagnosticType(): DiagnosticType;\n  /** Gets the message associated with the diagnostic. */\n  public abstract get messageText(): string;\n  /** Gets the schema where the diagnostic originated. */\n  public abstract get schema(): Schema;\n\n  /** The EC object to associate with the diagnostic. */\n  public ecDefinition: TYPE;\n  /** The arguments used when formatting the diagnostic message.  */\n  public messageArgs?: ARGS;\n  /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */\n  public category: DiagnosticCategory;\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[Schema]] diagnostics.\n * @beta\n */\nexport abstract class SchemaDiagnostic<ARGS extends any[]> extends BaseDiagnostic<Schema, ARGS> {\n  public static diagnosticType = DiagnosticType.SchemaItem;\n\n  /**\n   * Initializes a new SchemaDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(schema: Schema, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(schema, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.Schema; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[SchemaItem]] diagnostics.\n * @beta\n */\nexport abstract class SchemaItemDiagnostic<TYPE extends SchemaItem, ARGS extends any[]> extends BaseDiagnostic<TYPE, ARGS> {\n  public static diagnosticType = DiagnosticType.SchemaItem;\n  /**\n   * Initializes a new SchemaItemDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecDefinition: SchemaItem, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(ecDefinition as TYPE, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.SchemaItem; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[ECClass]] diagnostics.\n * @beta\n */\nexport abstract class ClassDiagnostic<ARGS extends any[]> extends SchemaItemDiagnostic<AnyClass, ARGS> {\n  /**\n   * Initializes a new ClassDiagnostic.\n   * @param ecClass The class to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecClass: AnyClass, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(ecClass, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public override get schema(): Schema { return this.ecDefinition.schema; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[Property]] diagnostics.\n * @beta\n */\nexport abstract class PropertyDiagnostic<ARGS extends any[]> extends BaseDiagnostic<AnyProperty, ARGS> {\n  /**\n   * Initializes a new PropertyDiagnostic.\n   * @param property The property to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(property: AnyProperty, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(property, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.Property; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[RelationshipConstraint]] diagnostics.\n * @beta\n */\nexport abstract class RelationshipConstraintDiagnostic<ARGS extends any[]> extends BaseDiagnostic<RelationshipConstraint, ARGS> {\n  /**\n   * Initializes a new RelationshipConstraintDiagnostic.\n   * @param constraint The Relationship Constraint to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(constraint: RelationshipConstraint, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(constraint, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.RelationshipConstraint; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[CustomAttributeContainerProps]] diagnostics.\n * @beta\n */\nexport abstract class CustomAttributeContainerDiagnostic<ARGS extends any[]> extends BaseDiagnostic<CustomAttributeContainerProps, ARGS> {\n  /**\n   * Initializes a new CustomAttributeContainerDiagnostic.\n   * @param constraint The Custom Attribute Container to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(container: CustomAttributeContainerProps, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(container, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.CustomAttributeContainer; }\n}\n\n/**\n * Helper method for creating [[SchemaDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createSchemaDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends SchemaDiagnostic<ARGS> {\n    public static code = code;\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[SchemaItemDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createSchemaItemDiagnosticClass<ITEM extends SchemaItem, ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends SchemaItemDiagnostic<ITEM, ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[ClassDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createClassDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends ClassDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[PropertyDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createPropertyDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends PropertyDiagnostic<ARGS> {\n    public static code = code;\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[RelationshipConstraintDiagnostic]] child classes.\n * @param code The string that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createRelationshipConstraintDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends RelationshipConstraintDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[CustomAttributeContainerDiagnostic]] child classes.\n * @param code The that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createCustomAttributeContainerDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends CustomAttributeContainerDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/** @beta */\nexport function diagnosticCategoryToString(category: DiagnosticCategory) {\n  switch (category) {\n    case DiagnosticCategory.Error:\n      return \"Error\";\n    case DiagnosticCategory.Warning:\n      return \"Warning\";\n    case DiagnosticCategory.Message:\n      return \"Message\";\n    case DiagnosticCategory.Suggestion:\n      return \"Suggestion\";\n  }\n}\n\n/** @beta */\nexport function diagnosticTypeToString(type: DiagnosticType) {\n  switch (type) {\n    case DiagnosticType.CustomAttributeContainer:\n      return \"CustomAttributeContainer\";\n    case DiagnosticType.None:\n      return \"None\";\n    case DiagnosticType.Property:\n      return \"Property\";\n    case DiagnosticType.RelationshipConstraint:\n      return \"RelationshipConstraint\";\n    case DiagnosticType.Schema:\n      return \"Schema\";\n    case DiagnosticType.SchemaItem:\n      return \"SchemaItem\";\n  }\n}\n\nfunction validateCode(code: string) {\n  const msg = `Diagnostic code ${code} is invalid. Expected the format <ruleSetName>-<number>.`;\n  const parts = code.split(\"-\");\n  if (parts.length !== 2)\n    throw new Error(msg);\n\n  if (isNaN(Number(parts[1])))\n    throw new Error(msg);\n}\n"]}
+{"version":3,"file":"Diagnostic.js","sourceRoot":"","sources":["../../../src/Validation/Diagnostic.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA6OH,kEAOC;AAQD,0EAMC;AAQD,gEAMC;AAQD,sEAOC;AAQD,kGAMC;AAQD,sGAMC;AAGD,gEAWC;AAGD,wDAeC;AAvVD,iDAAiD;AAEjD,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,IAAc,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACrD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,mDAAI,CAAA;IACJ,uDAAM,CAAA;IACN,+DAAU,CAAA;IACV,2DAAQ,CAAA;IACR,2FAAwB,CAAA;IACxB,uFAAsB,CAAA;AACxB,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iEAAO,CAAA;IACP,6DAAK,CAAA;IACL,uEAAU,CAAA;IACV,iEAAO,CAAA;AACT,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AA6BD;;;GAGG;AACH,MAAsB,cAAc;IAClC;;;;;OAKG;IACH,YAAY,YAAkB,EAAE,WAAkB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACzG,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAWD,sDAAsD;IAC/C,YAAY,CAAO;IAC1B,kEAAkE;IAC3D,WAAW,CAAQ;IAC1B,4GAA4G;IACrG,QAAQ,CAAqB;CACrC;AA5BD,wCA4BC;AAED;;;GAGG;AACH,MAAsB,gBAAqC,SAAQ,cAA4B;IACtF,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC;IAEzD;;;;;OAKG;IACH,YAAY,MAAc,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACpG,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAEzD,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;;AAjB/E,4CAkBC;AAED;;;GAGG;AACH,MAAsB,oBAAkE,SAAQ,cAA0B;IACjH,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC;IACzD;;;;;OAKG;IACH,YAAY,YAAwB,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC9G,KAAK,CAAC,YAAoB,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;;AAhBnF,oDAiBC;AAED;;;GAGG;AACH,MAAsB,eAAoC,SAAQ,oBAAoC;IACpG;;;;;OAKG;IACH,YAAY,OAAiB,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACvG,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,uDAAuD;IACvD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;CAC1E;AAbD,0CAaC;AAED;;;GAGG;AACH,MAAsB,kBAAuC,SAAQ,cAAiC;IACpG;;;;;OAKG;IACH,YAAY,QAAqB,EAAE,WAAkB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC5G,KAAK,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;CAChF;AAhBD,gDAgBC;AAED;;;GAGG;AACH,MAAsB,gCAAqD,SAAQ,cAA4C;IAC7H;;;;;OAKG;IACH,YAAY,UAAkC,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACxH,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC;CAC9F;AAhBD,4EAgBC;AAED;;;GAGG;AACH,MAAsB,kCAAuD,SAAQ,cAAmD;IACtI;;;;;OAKG;IACH,YAAY,SAAwC,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC9H,KAAK,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,wBAAwB,CAAC,CAAC,CAAC;CAChG;AAhBD,gFAgBC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CAAqB,IAAY,EAAE,WAAmB;IAC/F,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,gBAAsB;QAClC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAC1B,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B,CAA8C,IAAY,EAAE,WAAmB;IAC5H,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,oBAAgC;QACnD,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CAAqB,IAAY,EAAE,WAAmB;IAC9F,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,eAAqB;QACxC,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,6BAA6B,CAAqB,IAAY,EAAE,WAAmB;IACjG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,kBAAwB;QACpC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAC1B,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,2CAA2C,CAAqB,IAAY,EAAE,WAAmB;IAC/G,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,gCAAsC;QACzD,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,6CAA6C,CAAqB,IAAY,EAAE,WAAmB;IACjH,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,kCAAwC;QAC3D,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED,YAAY;AACZ,SAAgB,0BAA0B,CAAC,QAA4B;IACrE,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,kBAAkB,CAAC,KAAK;YAC3B,OAAO,OAAO,CAAC;QACjB,KAAK,kBAAkB,CAAC,OAAO;YAC7B,OAAO,SAAS,CAAC;QACnB,KAAK,kBAAkB,CAAC,OAAO;YAC7B,OAAO,SAAS,CAAC;QACnB,KAAK,kBAAkB,CAAC,UAAU;YAChC,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC;AAED,YAAY;AACZ,SAAgB,sBAAsB,CAAC,IAAoB;IACzD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,cAAc,CAAC,wBAAwB;YAC1C,OAAO,0BAA0B,CAAC;QACpC,KAAK,cAAc,CAAC,IAAI;YACtB,OAAO,MAAM,CAAC;QAChB,KAAK,cAAc,CAAC,QAAQ;YAC1B,OAAO,UAAU,CAAC;QACpB,KAAK,cAAc,CAAC,sBAAsB;YACxC,OAAO,wBAAwB,CAAC;QAClC,KAAK,cAAc,CAAC,MAAM;YACxB,OAAO,QAAQ,CAAC;QAClB,KAAK,cAAc,CAAC,UAAU;YAC5B,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,GAAG,GAAG,mBAAmB,IAAI,0DAA0D,CAAC;IAC9F,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvB,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC","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 Diagnostic\n */\n\nimport { AnyClass, AnyECType, AnyProperty, CustomAttributeContainerProps, RelationshipConstraint, Schema, SchemaItem } from \"@itwin/ecschema-metadata\";\n\n/* eslint-disable @typescript-eslint/no-shadow */\n\nconst formatString = (format: string, ...args: string[]) => {\n  return format.replace(/{(\\d+)}/g, (match, theNumber) => {\n    return typeof args[theNumber] !== \"undefined\"\n      ? args[theNumber]\n      : match;\n  });\n};\n\n/**\n * Defines the possible diagnostic types.\n * @beta\n */\nexport enum DiagnosticType {\n  None,\n  Schema,\n  SchemaItem,\n  Property,\n  CustomAttributeContainer,\n  RelationshipConstraint,\n}\n\n/**\n * Defines the possible diagnostic categories.\n * @beta\n */\nexport enum DiagnosticCategory {\n  Warning,\n  Error,\n  Suggestion,\n  Message,\n}\n\n/**\n * The interface implemented by all diagnostics used during schema validation.\n * @beta\n */\nexport interface IDiagnostic<TYPE extends AnyECType, ARGS extends any[]> {\n  /** The diagnostic category (error, warning, etc...). Value is static across all instances. */\n  category: DiagnosticCategory;\n  /** The unique string identifier of the diagnostic in the format '<ruleSetName>:<number>. Value is static across all instances. */\n  code: string;\n  /** The context type of diagnostic (schema, schema item, property, etc...). Value is static across all instances. */\n  diagnosticType: DiagnosticType;\n  /** The unformatted message text associated with the diagnostic. Value is static across all instances. */\n  messageText: string;\n  /** The arguments used when formatted the diagnostic instance's message. */\n  messageArgs?: ARGS;\n  /** The EC object associated with the diagnostic instance. */\n  ecDefinition: TYPE;\n  /** The schema where the diagnostic originated. */\n  schema: Schema;\n}\n\n/**\n * Type which encapsulates all possible diagnostics.\n * @beta\n */\nexport type AnyDiagnostic = IDiagnostic<AnyECType, any[]>;\n\n/**\n * The abstract base class for all [[IDiagnostic]] implementations.\n * @beta\n */\nexport abstract class BaseDiagnostic<TYPE extends AnyECType, ARGS extends any[]> implements IDiagnostic<TYPE, ARGS> {\n  /**\n   * Initializes a new BaseDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecDefinition: TYPE, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    this.ecDefinition = ecDefinition;\n    this.messageArgs = messageArgs;\n    this.category = category;\n  }\n\n  /** Gets the unique string identifier for the diagnostic in the format '<ruleSetName>:<number>'. */\n  public abstract get code(): string;\n  /** Gets the context type of the diagnostic (schema, schema item, property, etc...) */\n  public abstract get diagnosticType(): DiagnosticType;\n  /** Gets the message associated with the diagnostic. */\n  public abstract get messageText(): string;\n  /** Gets the schema where the diagnostic originated. */\n  public abstract get schema(): Schema;\n\n  /** The EC object to associate with the diagnostic. */\n  public ecDefinition: TYPE;\n  /** The arguments used when formatting the diagnostic message.  */\n  public messageArgs?: ARGS;\n  /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */\n  public category: DiagnosticCategory;\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[Schema]] diagnostics.\n * @beta\n */\nexport abstract class SchemaDiagnostic<ARGS extends any[]> extends BaseDiagnostic<Schema, ARGS> {\n  public static diagnosticType = DiagnosticType.SchemaItem;\n\n  /**\n   * Initializes a new SchemaDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(schema: Schema, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(schema, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.Schema; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[SchemaItem]] diagnostics.\n * @beta\n */\nexport abstract class SchemaItemDiagnostic<TYPE extends SchemaItem, ARGS extends any[]> extends BaseDiagnostic<TYPE, ARGS> {\n  public static diagnosticType = DiagnosticType.SchemaItem;\n  /**\n   * Initializes a new SchemaItemDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecDefinition: SchemaItem, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(ecDefinition as TYPE, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.SchemaItem; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[ECClass]] diagnostics.\n * @beta\n */\nexport abstract class ClassDiagnostic<ARGS extends any[]> extends SchemaItemDiagnostic<AnyClass, ARGS> {\n  /**\n   * Initializes a new ClassDiagnostic.\n   * @param ecClass The class to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecClass: AnyClass, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(ecClass, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public override get schema(): Schema { return this.ecDefinition.schema; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[Property]] diagnostics.\n * @beta\n */\nexport abstract class PropertyDiagnostic<ARGS extends any[]> extends BaseDiagnostic<AnyProperty, ARGS> {\n  /**\n   * Initializes a new PropertyDiagnostic.\n   * @param property The property to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(property: AnyProperty, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(property, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.Property; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[RelationshipConstraint]] diagnostics.\n * @beta\n */\nexport abstract class RelationshipConstraintDiagnostic<ARGS extends any[]> extends BaseDiagnostic<RelationshipConstraint, ARGS> {\n  /**\n   * Initializes a new RelationshipConstraintDiagnostic.\n   * @param constraint The Relationship Constraint to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(constraint: RelationshipConstraint, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(constraint, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.RelationshipConstraint; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[CustomAttributeContainerProps]] diagnostics.\n * @beta\n */\nexport abstract class CustomAttributeContainerDiagnostic<ARGS extends any[]> extends BaseDiagnostic<CustomAttributeContainerProps, ARGS> {\n  /**\n   * Initializes a new CustomAttributeContainerDiagnostic.\n   * @param constraint The Custom Attribute Container to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(container: CustomAttributeContainerProps, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(container, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.CustomAttributeContainer; }\n}\n\n/**\n * Helper method for creating [[SchemaDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createSchemaDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends SchemaDiagnostic<ARGS> {\n    public static code = code;\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[SchemaItemDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createSchemaItemDiagnosticClass<ITEM extends SchemaItem, ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends SchemaItemDiagnostic<ITEM, ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[ClassDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createClassDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends ClassDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[PropertyDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createPropertyDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends PropertyDiagnostic<ARGS> {\n    public static code = code;\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[RelationshipConstraintDiagnostic]] child classes.\n * @param code The string that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createRelationshipConstraintDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends RelationshipConstraintDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[CustomAttributeContainerDiagnostic]] child classes.\n * @param code The that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createCustomAttributeContainerDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends CustomAttributeContainerDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/** @beta */\nexport function diagnosticCategoryToString(category: DiagnosticCategory) {\n  switch (category) {\n    case DiagnosticCategory.Error:\n      return \"Error\";\n    case DiagnosticCategory.Warning:\n      return \"Warning\";\n    case DiagnosticCategory.Message:\n      return \"Message\";\n    case DiagnosticCategory.Suggestion:\n      return \"Suggestion\";\n  }\n}\n\n/** @beta */\nexport function diagnosticTypeToString(type: DiagnosticType) {\n  switch (type) {\n    case DiagnosticType.CustomAttributeContainer:\n      return \"CustomAttributeContainer\";\n    case DiagnosticType.None:\n      return \"None\";\n    case DiagnosticType.Property:\n      return \"Property\";\n    case DiagnosticType.RelationshipConstraint:\n      return \"RelationshipConstraint\";\n    case DiagnosticType.Schema:\n      return \"Schema\";\n    case DiagnosticType.SchemaItem:\n      return \"SchemaItem\";\n  }\n}\n\nfunction validateCode(code: string) {\n  const msg = `Diagnostic code ${code} is invalid. Expected the format <ruleSetName>-<number>.`;\n  const parts = code.split(\"-\");\n  if (parts.length !== 2)\n    throw new Error(msg);\n\n  if (isNaN(Number(parts[1])))\n    throw new Error(msg);\n}\n"]}

package/lib/cjs/Validation/DiagnosticReporter.js

@@ -19,6 +19,7 @@ const baseTranslationKey = `${translationNamespace}:${subTranslationNamespace}`;
  * @beta
  */
 class SuppressionDiagnosticReporter {
+    _suppressions;
     /**
      * Initializes a new SuppressionDiagnosticReporter
      * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.
@@ -64,6 +65,8 @@ class FormatDiagnosticReporter extends SuppressionDiagnosticReporter {
         super(suppressions);
         this.localization = localization;
     }
+    /** The Localization object to use for message translation. If undefined, no translation will occur. */
+    localization;
     /**
      * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)
      * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.

package/lib/cjs/Validation/DiagnosticReporter.js.map

@@ -1 +1 @@
-{"version":3,"file":"DiagnosticReporter.js","sourceRoot":"","sources":["../../../src/Validation/DiagnosticReporter.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,iCAAkC,CAAC,4DAA4D;AAE/F,MAAM,oBAAoB,GAAG,kBAAkB,CAAC;AAChD,MAAM,uBAAuB,GAAG,aAAa,CAAC;AAC9C,MAAM,kBAAkB,GAAG,GAAG,oBAAoB,IAAI,uBAAuB,EAAE,CAAC;AAwBhF;;;;;GAKG;AACH,MAAsB,6BAA6B;IAGjD;;;OAGG;IACH,YAAY,YAAoC;QAC9C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAyB;QACrC,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7E,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC3E,IAAI,eAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC5C,OAAO;QACX,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;CAQF;AAxCD,sEAwCC;AAED;;;;;GAKG;AACH,MAAsB,wBAAyB,SAAQ,6BAA6B;IAClF;;;;OAIG;IACH,YAAY,YAAoC,EAAE,YAA2B;QAC3E,KAAK,CAAC,YAAY,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAKD;;;;OAIG;IACI,cAAc,CAAC,UAAyB;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAUD;;;;;;OAMG;IACO,oBAAoB,CAAC,IAAY,EAAE,IAAuB,EAAE,SAAS,GAAG,CAAC;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,aAAa,CAAC,UAAyB;QAC7C,IAAI,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAE1D,IAAI,UAAU,CAAC,WAAW,IAAI,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YAC7D,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3F,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEO,gBAAgB,CAAC,UAAyB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY;YACpB,OAAO,UAAU,CAAC,WAAW,CAAC;QAEhC,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;IAClF,CAAC;IAEO,iBAAiB,CAAC,UAAyB;QACjD,OAAO,GAAG,kBAAkB,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;IAEO,aAAa,CAAI,KAA2B,EAAE,OAAgB;QACpE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YACvC,OAAO,MAAM,CAAC,KAAK,EAAE,OAAO,CAAU,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AApED,4DAoEC","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 Diagnostic\n */\n\nimport { Localization } from \"@itwin/core-common\";\nimport { AnyDiagnostic } from \"./Diagnostic\";\n\nimport assert = require(\"assert\"); // eslint-disable-line @typescript-eslint/no-require-imports\n\nconst translationNamespace = \"ECSchemaMetaData\";\nconst subTranslationNamespace = \"Diagnostics\";\nconst baseTranslationKey = `${translationNamespace}:${subTranslationNamespace}`;\n\n/**\n * Interface used to report [[IDiagnostic]] objects created during schema validation.\n * @beta\n */\nexport interface IDiagnosticReporter {\n  /**\n   * A map where the key is a schema full name and the value is a collection\n   * of diagnostics codes identifying which rules violations to ignore during validation.\n   */\n  suppressions?: Map<string, string[]>;\n\n  /** The localization object to use for message translation. */\n  localization?: Localization;\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   */\n  report(diagnostic: AnyDiagnostic): void;\n}\n\n/**\n * An abstract base class for [[IDiagnosticReporter]] implementation that used the\n * provided Map to suppress certain rule violations from being reported. The Map's key\n * a schema full name, and the Map's value is a collection of rule codes to suppress.\n * @beta\n */\nexport abstract class SuppressionDiagnosticReporter implements IDiagnosticReporter {\n  private _suppressions?: Map<string, string[]>;\n\n  /**\n   * Initializes a new SuppressionDiagnosticReporter\n   * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.\n   */\n  constructor(suppressions?: Map<string, string[]>) {\n    this._suppressions = suppressions;\n  }\n\n  /**\n   * Gets the collection of ISchemaDiagnosticSuppression objects that identify\n   * rules violations to ignore during validation.\n   */\n  public get suppressions(): Map<string, string[]> | undefined {\n    return this._suppressions;\n  }\n\n  /**\n   * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)\n   * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.\n   * @param diagnostic The diagnostic to report.\n   */\n  public report(diagnostic: AnyDiagnostic) {\n    if (this._suppressions && this._suppressions.has(diagnostic.schema.fullName)) {\n      const suppressedCodes = this._suppressions.get(diagnostic.schema.fullName);\n      if (suppressedCodes!.includes(diagnostic.code))\n        return;\n    }\n\n    this.reportInternal(diagnostic);\n  }\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   */\n  protected abstract reportInternal(diagnostic: AnyDiagnostic): void;\n}\n\n/**\n * An abstract [[SuppressionDiagnosticReporter]] implementation that formats the\n * diagnostic message with the message args. If a Localization implementation is specified,\n * the message will also be translated.\n * @beta\n */\nexport abstract class FormatDiagnosticReporter extends SuppressionDiagnosticReporter {\n  /**\n   * Initializes a new FormatDiagnosticReporter\n   * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.\n   * @param localization The Localization instance to use to translate validation messages.\n   */\n  constructor(suppressions?: Map<string, string[]>, localization?: Localization) {\n    super(suppressions);\n    this.localization = localization;\n  }\n\n  /** The Localization object to use for message translation. If undefined, no translation will occur. */\n  public localization?: Localization;\n\n  /**\n   * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)\n   * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.\n   * @param diagnostic The diagnostic to report.\n   */\n  public reportInternal(diagnostic: AnyDiagnostic) {\n    const message = this.formatMessage(diagnostic);\n    this.reportDiagnostic(diagnostic, message);\n  }\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   * @param messageText The formatted message.\n   */\n  protected abstract reportDiagnostic(diagnostic: AnyDiagnostic, messageText: string): void;\n\n  /**\n   * Helper method that formats string with provided arguments where the place holders\n   * are in the the format '{0}', '{1}', etc.\n   * @param text The text to format.\n   * @param args The arguments to place in the text.\n   * @param baseIndex The base index for the args, used for validation (typically 0, which is the default).\n   */\n  protected formatStringFromArgs(text: string, args: ArrayLike<string>, baseIndex = 0): string {\n    return text.replace(/{(\\d+)}/g, (_match, index: string) => this.assertDefined(args[+index + baseIndex]));\n  }\n\n  private formatMessage(diagnostic: AnyDiagnostic): string {\n    let translatedMessage = this.translateMessage(diagnostic);\n\n    if (diagnostic.messageArgs && diagnostic.messageArgs.length > 0)\n      translatedMessage = this.formatStringFromArgs(translatedMessage, diagnostic.messageArgs);\n    return translatedMessage;\n  }\n\n  private translateMessage(diagnostic: AnyDiagnostic): string {\n    if (!this.localization)\n      return diagnostic.messageText;\n\n    return this.localization.getLocalizedString(this.getTranslationKey(diagnostic));\n  }\n\n  private getTranslationKey(diagnostic: AnyDiagnostic): string {\n    return `${baseTranslationKey}.${diagnostic.code}`;\n  }\n\n  private assertDefined<T>(value: T | null | undefined, message?: string): T {\n    if (value === undefined || value === null)\n      return assert(false, message) as never;\n\n    return value;\n  }\n}\n"]}
+{"version":3,"file":"DiagnosticReporter.js","sourceRoot":"","sources":["../../../src/Validation/DiagnosticReporter.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,iCAAkC,CAAC,4DAA4D;AAE/F,MAAM,oBAAoB,GAAG,kBAAkB,CAAC;AAChD,MAAM,uBAAuB,GAAG,aAAa,CAAC;AAC9C,MAAM,kBAAkB,GAAG,GAAG,oBAAoB,IAAI,uBAAuB,EAAE,CAAC;AAwBhF;;;;;GAKG;AACH,MAAsB,6BAA6B;IACzC,aAAa,CAAyB;IAE9C;;;OAGG;IACH,YAAY,YAAoC;QAC9C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAyB;QACrC,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7E,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC3E,IAAI,eAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC5C,OAAO;QACX,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;CAQF;AAxCD,sEAwCC;AAED;;;;;GAKG;AACH,MAAsB,wBAAyB,SAAQ,6BAA6B;IAClF;;;;OAIG;IACH,YAAY,YAAoC,EAAE,YAA2B;QAC3E,KAAK,CAAC,YAAY,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED,uGAAuG;IAChG,YAAY,CAAgB;IAEnC;;;;OAIG;IACI,cAAc,CAAC,UAAyB;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAUD;;;;;;OAMG;IACO,oBAAoB,CAAC,IAAY,EAAE,IAAuB,EAAE,SAAS,GAAG,CAAC;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,aAAa,CAAC,UAAyB;QAC7C,IAAI,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAE1D,IAAI,UAAU,CAAC,WAAW,IAAI,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YAC7D,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3F,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEO,gBAAgB,CAAC,UAAyB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY;YACpB,OAAO,UAAU,CAAC,WAAW,CAAC;QAEhC,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;IAClF,CAAC;IAEO,iBAAiB,CAAC,UAAyB;QACjD,OAAO,GAAG,kBAAkB,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;IAEO,aAAa,CAAI,KAA2B,EAAE,OAAgB;QACpE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YACvC,OAAO,MAAM,CAAC,KAAK,EAAE,OAAO,CAAU,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AApED,4DAoEC","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 Diagnostic\n */\n\nimport { Localization } from \"@itwin/core-common\";\nimport { AnyDiagnostic } from \"./Diagnostic\";\n\nimport assert = require(\"assert\"); // eslint-disable-line @typescript-eslint/no-require-imports\n\nconst translationNamespace = \"ECSchemaMetaData\";\nconst subTranslationNamespace = \"Diagnostics\";\nconst baseTranslationKey = `${translationNamespace}:${subTranslationNamespace}`;\n\n/**\n * Interface used to report [[IDiagnostic]] objects created during schema validation.\n * @beta\n */\nexport interface IDiagnosticReporter {\n  /**\n   * A map where the key is a schema full name and the value is a collection\n   * of diagnostics codes identifying which rules violations to ignore during validation.\n   */\n  suppressions?: Map<string, string[]>;\n\n  /** The localization object to use for message translation. */\n  localization?: Localization;\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   */\n  report(diagnostic: AnyDiagnostic): void;\n}\n\n/**\n * An abstract base class for [[IDiagnosticReporter]] implementation that used the\n * provided Map to suppress certain rule violations from being reported. The Map's key\n * a schema full name, and the Map's value is a collection of rule codes to suppress.\n * @beta\n */\nexport abstract class SuppressionDiagnosticReporter implements IDiagnosticReporter {\n  private _suppressions?: Map<string, string[]>;\n\n  /**\n   * Initializes a new SuppressionDiagnosticReporter\n   * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.\n   */\n  constructor(suppressions?: Map<string, string[]>) {\n    this._suppressions = suppressions;\n  }\n\n  /**\n   * Gets the collection of ISchemaDiagnosticSuppression objects that identify\n   * rules violations to ignore during validation.\n   */\n  public get suppressions(): Map<string, string[]> | undefined {\n    return this._suppressions;\n  }\n\n  /**\n   * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)\n   * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.\n   * @param diagnostic The diagnostic to report.\n   */\n  public report(diagnostic: AnyDiagnostic) {\n    if (this._suppressions && this._suppressions.has(diagnostic.schema.fullName)) {\n      const suppressedCodes = this._suppressions.get(diagnostic.schema.fullName);\n      if (suppressedCodes!.includes(diagnostic.code))\n        return;\n    }\n\n    this.reportInternal(diagnostic);\n  }\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   */\n  protected abstract reportInternal(diagnostic: AnyDiagnostic): void;\n}\n\n/**\n * An abstract [[SuppressionDiagnosticReporter]] implementation that formats the\n * diagnostic message with the message args. If a Localization implementation is specified,\n * the message will also be translated.\n * @beta\n */\nexport abstract class FormatDiagnosticReporter extends SuppressionDiagnosticReporter {\n  /**\n   * Initializes a new FormatDiagnosticReporter\n   * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.\n   * @param localization The Localization instance to use to translate validation messages.\n   */\n  constructor(suppressions?: Map<string, string[]>, localization?: Localization) {\n    super(suppressions);\n    this.localization = localization;\n  }\n\n  /** The Localization object to use for message translation. If undefined, no translation will occur. */\n  public localization?: Localization;\n\n  /**\n   * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)\n   * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.\n   * @param diagnostic The diagnostic to report.\n   */\n  public reportInternal(diagnostic: AnyDiagnostic) {\n    const message = this.formatMessage(diagnostic);\n    this.reportDiagnostic(diagnostic, message);\n  }\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   * @param messageText The formatted message.\n   */\n  protected abstract reportDiagnostic(diagnostic: AnyDiagnostic, messageText: string): void;\n\n  /**\n   * Helper method that formats string with provided arguments where the place holders\n   * are in the the format '{0}', '{1}', etc.\n   * @param text The text to format.\n   * @param args The arguments to place in the text.\n   * @param baseIndex The base index for the args, used for validation (typically 0, which is the default).\n   */\n  protected formatStringFromArgs(text: string, args: ArrayLike<string>, baseIndex = 0): string {\n    return text.replace(/{(\\d+)}/g, (_match, index: string) => this.assertDefined(args[+index + baseIndex]));\n  }\n\n  private formatMessage(diagnostic: AnyDiagnostic): string {\n    let translatedMessage = this.translateMessage(diagnostic);\n\n    if (diagnostic.messageArgs && diagnostic.messageArgs.length > 0)\n      translatedMessage = this.formatStringFromArgs(translatedMessage, diagnostic.messageArgs);\n    return translatedMessage;\n  }\n\n  private translateMessage(diagnostic: AnyDiagnostic): string {\n    if (!this.localization)\n      return diagnostic.messageText;\n\n    return this.localization.getLocalizedString(this.getTranslationKey(diagnostic));\n  }\n\n  private getTranslationKey(diagnostic: AnyDiagnostic): string {\n    return `${baseTranslationKey}.${diagnostic.code}`;\n  }\n\n  private assertDefined<T>(value: T | null | undefined, message?: string): T {\n    if (value === undefined || value === null)\n      return assert(false, message) as never;\n\n    return value;\n  }\n}\n"]}