@itwin/ecschema-editing 4.8.0-dev.8 → 4.9.0-dev.1

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

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

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

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

package/lib/cjs/Merging/SchemaMerger.js

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

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaReferenceMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaReferenceMerger.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,gEAAyF;AAKzF;;;;;GAKG;AACI,KAAK,UAAU,qBAAqB,CAAC,OAA2B,EAAE,MAAiC;IACxG,kFAAkF;IAClF,4FAA4F;IAC5F,IAAG,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QAC/B,MAAM,gBAAgB,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC/G,MAAM,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;IACrF,CAAC;IAED,iFAAiF;IACjF,qFAAqF;IACrF,qFAAqF;IACrF,8BAA8B;IAC9B,IAAG,MAAM,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,gBAAgB,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC/G,MAAM,cAAc,GAAI,CAAC,MAAM,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAE,CAAC;QAE1F,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QACzE,IAAG,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,mCAAe,CAAC,qBAAqB,CAAC,EAAE,CAAC;YACrF,MAAM,IAAI,KAAK,CAAC,yBAAyB,gBAAgB,CAAC,IAAI,gCAAgC,KAAK,CAAC,SAAS,CAAC,OAAO,QAAQ,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3J,CAAC;QAED,IAAG,MAAM,KAAK,cAAc,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,cAAc,CAAC,CAAC;QACrG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAEjD,MAAM,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AA9BD,sDA8BC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,YAAY,CAAC,MAA2B,EAAE,UAAmB,EAAE,OAAgB;IAC5F,IAAG,UAAU,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,6BAAS,CAAC,UAAU,EAAE,6BAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,qBAAqB,CAAC,CAAC;IACtG,IAAG,MAAM,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,qBAAqB,SAAS,CAAC,QAAQ,EAAE,uCAAuC,CAAC,CAAC;IACpG,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,IAAY,EAAE,KAAa;IACjD,OAAO,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC;QACzD,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC;QACf,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACpB,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 { ECVersion, Schema, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\nimport { type SchemaMergeContext } from \"./SchemaMerger\";\nimport { type SchemaReferenceDifference } from \"../Differencing/SchemaDifference\";\nimport { type SchemaContextEditor } from \"../Editing/Editor\";\n\n/**\n * Merges the schema references of two schemas.\n * @param context  current merge context\n * @param change       schema changes.\n * @internal\n */\nexport async function mergeSchemaReferences(context: SchemaMergeContext, change: SchemaReferenceDifference) {\n  // If the target schema does not have a reference to a schema yet, it can be added\n  // but should be checked if it's schema references have collisions with existing references.\n  if(change.changeType === \"add\") {\n    const referencedSchema = await locateSchema(context.editor, change.difference.name, change.difference.version);\n    await context.editor.addSchemaReference(context.targetSchemaKey, referencedSchema);\n  }\n\n  // If the source schema referenced a schema that is also referenced by the target\n  // schema but in a different version, it is marked as delta. Here we need to check if\n  // the source schema is compatible to the existing one. This is not be checked by the\n  // schema instance when added.\n  if(change.changeType === \"modify\") {\n    const referencedSchema = await locateSchema(context.editor, change.difference.name, change.difference.version);\n    const existingSchema  = (await context.targetSchema.getReference(referencedSchema.name))!;\n\n    const [older, latest] = compareSchemas(existingSchema, referencedSchema);\n    if(!latest.schemaKey.matches(older.schemaKey, SchemaMatchType.LatestWriteCompatible)) {\n      throw new Error(`Schemas references of ${referencedSchema.name} have incompatible versions: ${older.schemaKey.version} and ${latest.schemaKey.version}`);\n    }\n\n    if(latest === existingSchema) {\n      return;\n    }\n\n    const index = context.targetSchema.references.findIndex((reference) => reference === existingSchema);\n    context.targetSchema.references.splice(index, 1);\n\n    await context.editor.addSchemaReference(context.targetSchema.schemaKey, referencedSchema);\n  }\n}\n\n/**\n * Tries to locate the Schema in the current Context\n * @param editor      Current editor context.\n * @param schemaName  The schema name to be looked up.\n * @param version     The schemas version to beo looked up.\n * @returns           The schema found in the context.\n */\nasync function locateSchema(editor: SchemaContextEditor, schemaName?: string, version?: string): Promise<Schema> {\n  if(schemaName === undefined || version === undefined) {\n    throw new Error(\"Schema name and version must not be undefined.\");\n  }\n\n  const schemaKey = new SchemaKey(schemaName, ECVersion.fromString(version));\n  const schema = await editor.schemaContext.getSchema(schemaKey, SchemaMatchType.LatestWriteCompatible);\n  if(schema === undefined) {\n    throw new Error(`Referenced schema ${schemaKey.toString()} could not be found in target context`);\n  }\n  return schema;\n}\n\n/**\n * Compares the schemas and return them in order of their versions [older, latest].\n * @param left    The first schema to be added.\n * @param right   The second schema to be added.\n * @returns       The schemas in order.\n */\nfunction compareSchemas(left: Schema, right: Schema): [Schema, Schema] {\n  return left.schemaKey.compareByVersion(right.schemaKey) < 0\n    ? [left, right]\n    : [right, left];\n}\n"]}
+{"version":3,"file":"SchemaReferenceMerger.js","sourceRoot":"","sources":["../../../src/Merging/SchemaReferenceMerger.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,gEAAyF;AAKzF;;;;;GAKG;AACI,KAAK,UAAU,qBAAqB,CAAC,OAA2B,EAAE,MAAiC;IACxG,kFAAkF;IAClF,4FAA4F;IAC5F,IAAG,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QAC/B,MAAM,gBAAgB,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC/G,MAAM,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;IACrF,CAAC;IAED,iFAAiF;IACjF,qFAAqF;IACrF,qFAAqF;IACrF,8BAA8B;IAC9B,IAAG,MAAM,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,gBAAgB,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC/G,MAAM,cAAc,GAAI,CAAC,MAAM,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAE,CAAC;QAE1F,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;QACzE,IAAG,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,mCAAe,CAAC,qBAAqB,CAAC,EAAE,CAAC;YACrF,MAAM,IAAI,KAAK,CAAC,yBAAyB,gBAAgB,CAAC,IAAI,gCAAgC,KAAK,CAAC,SAAS,CAAC,OAAO,QAAQ,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3J,CAAC;QAED,IAAG,MAAM,KAAK,cAAc,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,cAAc,CAAC,CAAC;QACrG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAEjD,MAAM,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AA9BD,sDA8BC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,YAAY,CAAC,MAA2B,EAAE,UAAmB,EAAE,OAAgB;IAC5F,IAAG,UAAU,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,6BAAS,CAAC,UAAU,EAAE,6BAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,qBAAqB,CAAC,CAAC;IACtG,IAAG,MAAM,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,qBAAqB,SAAS,CAAC,QAAQ,EAAE,uCAAuC,CAAC,CAAC;IACpG,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,IAAY,EAAE,KAAa;IACjD,OAAO,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC;QACzD,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC;QACf,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACpB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { ECVersion, Schema, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { type SchemaMergeContext } from \"./SchemaMerger\";\r\nimport { type SchemaReferenceDifference } from \"../Differencing/SchemaDifference\";\r\nimport { type SchemaContextEditor } from \"../Editing/Editor\";\r\n\r\n/**\r\n * Merges the schema references of two schemas.\r\n * @param context  current merge context\r\n * @param change       schema changes.\r\n * @internal\r\n */\r\nexport async function mergeSchemaReferences(context: SchemaMergeContext, change: SchemaReferenceDifference) {\r\n  // If the target schema does not have a reference to a schema yet, it can be added\r\n  // but should be checked if it's schema references have collisions with existing references.\r\n  if(change.changeType === \"add\") {\r\n    const referencedSchema = await locateSchema(context.editor, change.difference.name, change.difference.version);\r\n    await context.editor.addSchemaReference(context.targetSchemaKey, referencedSchema);\r\n  }\r\n\r\n  // If the source schema referenced a schema that is also referenced by the target\r\n  // schema but in a different version, it is marked as delta. Here we need to check if\r\n  // the source schema is compatible to the existing one. This is not be checked by the\r\n  // schema instance when added.\r\n  if(change.changeType === \"modify\") {\r\n    const referencedSchema = await locateSchema(context.editor, change.difference.name, change.difference.version);\r\n    const existingSchema  = (await context.targetSchema.getReference(referencedSchema.name))!;\r\n\r\n    const [older, latest] = compareSchemas(existingSchema, referencedSchema);\r\n    if(!latest.schemaKey.matches(older.schemaKey, SchemaMatchType.LatestWriteCompatible)) {\r\n      throw new Error(`Schemas references of ${referencedSchema.name} have incompatible versions: ${older.schemaKey.version} and ${latest.schemaKey.version}`);\r\n    }\r\n\r\n    if(latest === existingSchema) {\r\n      return;\r\n    }\r\n\r\n    const index = context.targetSchema.references.findIndex((reference) => reference === existingSchema);\r\n    context.targetSchema.references.splice(index, 1);\r\n\r\n    await context.editor.addSchemaReference(context.targetSchema.schemaKey, referencedSchema);\r\n  }\r\n}\r\n\r\n/**\r\n * Tries to locate the Schema in the current Context\r\n * @param editor      Current editor context.\r\n * @param schemaName  The schema name to be looked up.\r\n * @param version     The schemas version to beo looked up.\r\n * @returns           The schema found in the context.\r\n */\r\nasync function locateSchema(editor: SchemaContextEditor, schemaName?: string, version?: string): Promise<Schema> {\r\n  if(schemaName === undefined || version === undefined) {\r\n    throw new Error(\"Schema name and version must not be undefined.\");\r\n  }\r\n\r\n  const schemaKey = new SchemaKey(schemaName, ECVersion.fromString(version));\r\n  const schema = await editor.schemaContext.getSchema(schemaKey, SchemaMatchType.LatestWriteCompatible);\r\n  if(schema === undefined) {\r\n    throw new Error(`Referenced schema ${schemaKey.toString()} could not be found in target context`);\r\n  }\r\n  return schema;\r\n}\r\n\r\n/**\r\n * Compares the schemas and return them in order of their versions [older, latest].\r\n * @param left    The first schema to be added.\r\n * @param right   The second schema to be added.\r\n * @returns       The schemas in order.\r\n */\r\nfunction compareSchemas(left: Schema, right: Schema): [Schema, Schema] {\r\n  return left.schemaKey.compareByVersion(right.schemaKey) < 0\r\n    ? [left, right]\r\n    : [right, left];\r\n}\r\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"UnitSystemMerger.js","sourceRoot":"","sources":["../../../src/Merging/UnitSystemMerger.ts"],"names":[],"mappings":";;;AAQA;;;GAGG;AACU,QAAA,gBAAgB,GAAkD;IAC7E,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM;QACvB,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,eAAe,EAAE;YACzE,GAAG,MAAM,CAAC,UAAU;YACpB,IAAI,EAAE,MAAM,CAAC,QAAQ;YACrB,cAAc,EAAE,MAAM,CAAC,UAAU;SAClC,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAuB;QAC9D,IAAG,MAAM,CAAC,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;QACD,IAAG,MAAM,CAAC,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YAC/C,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF,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 { type MutableUnitSystem } from \"../Editing/Mutable/MutableUnitSystem\";\nimport { type SchemaItemMergerHandler } from \"./SchemaItemMerger\";\nimport { type UnitSystemDifference } from \"../Differencing/SchemaDifference\";\n\n/**\n * Defines a merge handler to merge UnitSystem schema items.\n * @internal\n */\nexport const unitSystemMerger: SchemaItemMergerHandler<UnitSystemDifference> = {\n  async add(context, change) {\n    return context.editor.unitSystems.createFromProps(context.targetSchemaKey, {\n      ...change.difference,\n      name: change.itemName,\n      schemaItemType: change.schemaType,\n    });\n  },\n  async modify(_context, change, _itemKey, item: MutableUnitSystem) {\n    if(change.difference.label !== undefined) {\n      item.setDisplayLabel(change.difference.label);\n    }\n    if(change.difference.description !== undefined) {\n      item.setDescription(change.difference.description);\n    }\n  },\n};\n"]}
+{"version":3,"file":"UnitSystemMerger.js","sourceRoot":"","sources":["../../../src/Merging/UnitSystemMerger.ts"],"names":[],"mappings":";;;AAQA;;;GAGG;AACU,QAAA,gBAAgB,GAAkD;IAC7E,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM;QACvB,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,eAAe,EAAE;YACzE,GAAG,MAAM,CAAC,UAAU;YACpB,IAAI,EAAE,MAAM,CAAC,QAAQ;YACrB,cAAc,EAAE,MAAM,CAAC,UAAU;SAClC,CAAC,CAAC;IACL,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAuB;QAC9D,IAAG,MAAM,CAAC,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;QACD,IAAG,MAAM,CAAC,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YAC/C,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;CACF,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { type MutableUnitSystem } from \"../Editing/Mutable/MutableUnitSystem\";\r\nimport { type SchemaItemMergerHandler } from \"./SchemaItemMerger\";\r\nimport { type UnitSystemDifference } from \"../Differencing/SchemaDifference\";\r\n\r\n/**\r\n * Defines a merge handler to merge UnitSystem schema items.\r\n * @internal\r\n */\r\nexport const unitSystemMerger: SchemaItemMergerHandler<UnitSystemDifference> = {\r\n  async add(context, change) {\r\n    return context.editor.unitSystems.createFromProps(context.targetSchemaKey, {\r\n      ...change.difference,\r\n      name: change.itemName,\r\n      schemaItemType: change.schemaType,\r\n    });\r\n  },\r\n  async modify(_context, change, _itemKey, item: MutableUnitSystem) {\r\n    if(change.difference.label !== undefined) {\r\n      item.setDisplayLabel(change.difference.label);\r\n    }\r\n    if(change.difference.description !== undefined) {\r\n      item.setDescription(change.difference.description);\r\n    }\r\n  },\r\n};\r\n"]}

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;;;AAIH,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;IAG7F;;;;;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;AAjBe,+BAAc,GAAG,cAAc,CAAC,UAAU,CAAC;AAmB3D;;;GAGG;AACH,MAAsB,oBAAkE,SAAQ,cAA0B;IAExH;;;;;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;AAhBe,mCAAc,GAAG,cAAc,CAAC,UAAU,CAAC;AAkB3D;;;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,YAAO,KAAM,SAAQ,gBAAsB;YAEzC,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;YAC1C,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;SAC3I;QAHe,OAAI,GAAG,IAAK;WAG1B;AACJ,CAAC;AAPD,kEAOC;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;AAND,0EAMC;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;AAND,gEAMC;AAED;;;;;GAKG;AACH,SAAgB,6BAA6B,CAAqB,IAAY,EAAE,WAAmB;;IACjG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,YAAO,KAAM,SAAQ,kBAAwB;YAE3C,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;YAC1C,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;SAC3I;QAHe,OAAI,GAAG,IAAK;WAG1B;AACJ,CAAC;AAPD,sEAOC;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;AAND,kGAMC;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;AAND,sGAMC;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;AAXD,gEAWC;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;AAfD,wDAeC;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, // eslint-disable-line @typescript-eslint/no-shadow\n  SchemaItem, // eslint-disable-line @typescript-eslint/no-shadow\n  Property,\n  CustomAttributeContainer,\n  RelationshipConstraint, // eslint-disable-line @typescript-eslint/no-shadow\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;;;AAIH,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;IAG7F;;;;;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;AAjBe,+BAAc,GAAG,cAAc,CAAC,UAAU,CAAC;AAmB3D;;;GAGG;AACH,MAAsB,oBAAkE,SAAQ,cAA0B;IAExH;;;;;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;AAhBe,mCAAc,GAAG,cAAc,CAAC,UAAU,CAAC;AAkB3D;;;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,YAAO,KAAM,SAAQ,gBAAsB;YAEzC,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;YAC1C,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;SAC3I;QAHe,OAAI,GAAG,IAAK;WAG1B;AACJ,CAAC;AAPD,kEAOC;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;AAND,0EAMC;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;AAND,gEAMC;AAED;;;;;GAKG;AACH,SAAgB,6BAA6B,CAAqB,IAAY,EAAE,WAAmB;;IACjG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,YAAO,KAAM,SAAQ,kBAAwB;YAE3C,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;YAC1C,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;SAC3I;QAHe,OAAI,GAAG,IAAK;WAG1B;AACJ,CAAC;AAPD,sEAOC;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;AAND,kGAMC;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;AAND,sGAMC;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;AAXD,gEAWC;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;AAfD,wDAeC;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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Diagnostic\r\n */\r\n\r\nimport { AnyClass, AnyECType, AnyProperty, CustomAttributeContainerProps, RelationshipConstraint, Schema, SchemaItem } from \"@itwin/ecschema-metadata\";\r\n\r\n/* eslint-disable @typescript-eslint/no-shadow */\r\n\r\nconst formatString = (format: string, ...args: string[]) => {\r\n  return format.replace(/{(\\d+)}/g, (match, theNumber) => {\r\n    return typeof args[theNumber] !== \"undefined\"\r\n      ? args[theNumber]\r\n      : match;\r\n  });\r\n};\r\n\r\n/**\r\n * Defines the possible diagnostic types.\r\n * @beta\r\n */\r\nexport enum DiagnosticType {\r\n  None,\r\n  Schema, // eslint-disable-line @typescript-eslint/no-shadow\r\n  SchemaItem, // eslint-disable-line @typescript-eslint/no-shadow\r\n  Property,\r\n  CustomAttributeContainer,\r\n  RelationshipConstraint, // eslint-disable-line @typescript-eslint/no-shadow\r\n}\r\n\r\n/**\r\n * Defines the possible diagnostic categories.\r\n * @beta\r\n */\r\nexport enum DiagnosticCategory {\r\n  Warning,\r\n  Error,\r\n  Suggestion,\r\n  Message,\r\n}\r\n\r\n/**\r\n * The interface implemented by all diagnostics used during schema validation.\r\n * @beta\r\n */\r\nexport interface IDiagnostic<TYPE extends AnyECType, ARGS extends any[]> {\r\n  /** The diagnostic category (error, warning, etc...). Value is static across all instances. */\r\n  category: DiagnosticCategory;\r\n  /** The unique string identifier of the diagnostic in the format '<ruleSetName>:<number>. Value is static across all instances. */\r\n  code: string;\r\n  /** The context type of diagnostic (schema, schema item, property, etc...). Value is static across all instances. */\r\n  diagnosticType: DiagnosticType;\r\n  /** The unformatted message text associated with the diagnostic. Value is static across all instances. */\r\n  messageText: string;\r\n  /** The arguments used when formatted the diagnostic instance's message. */\r\n  messageArgs?: ARGS;\r\n  /** The EC object associated with the diagnostic instance. */\r\n  ecDefinition: TYPE;\r\n  /** The schema where the diagnostic originated. */\r\n  schema: Schema;\r\n}\r\n\r\n/**\r\n * Type which encapsulates all possible diagnostics.\r\n * @beta\r\n */\r\nexport type AnyDiagnostic = IDiagnostic<AnyECType, any[]>;\r\n\r\n/**\r\n * The abstract base class for all [[IDiagnostic]] implementations.\r\n * @beta\r\n */\r\nexport abstract class BaseDiagnostic<TYPE extends AnyECType, ARGS extends any[]> implements IDiagnostic<TYPE, ARGS> {\r\n  /**\r\n   * Initializes a new BaseDiagnostic.\r\n   * @param ecDefinition The EC object to associate with the diagnostic.\r\n   * @param messageArgs The arguments used when formatting the diagnostic message.\r\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\r\n   */\r\n  constructor(ecDefinition: TYPE, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\r\n    this.ecDefinition = ecDefinition;\r\n    this.messageArgs = messageArgs;\r\n    this.category = category;\r\n  }\r\n\r\n  /** Gets the unique string identifier for the diagnostic in the format '<ruleSetName>:<number>'. */\r\n  public abstract get code(): string;\r\n  /** Gets the context type of the diagnostic (schema, schema item, property, etc...) */\r\n  public abstract get diagnosticType(): DiagnosticType;\r\n  /** Gets the message associated with the diagnostic. */\r\n  public abstract get messageText(): string;\r\n  /** Gets the schema where the diagnostic originated. */\r\n  public abstract get schema(): Schema;\r\n\r\n  /** The EC object to associate with the diagnostic. */\r\n  public ecDefinition: TYPE;\r\n  /** The arguments used when formatting the diagnostic message.  */\r\n  public messageArgs?: ARGS;\r\n  /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */\r\n  public category: DiagnosticCategory;\r\n}\r\n\r\n/**\r\n * An [[IDiagnostic]] implementation used for [[Schema]] diagnostics.\r\n * @beta\r\n */\r\nexport abstract class SchemaDiagnostic<ARGS extends any[]> extends BaseDiagnostic<Schema, ARGS> {\r\n  public static diagnosticType = DiagnosticType.SchemaItem;\r\n\r\n  /**\r\n   * Initializes a new SchemaDiagnostic.\r\n   * @param ecDefinition The EC object to associate with the diagnostic.\r\n   * @param messageArgs The arguments used when formatting the diagnostic message.\r\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\r\n   */\r\n  constructor(schema: Schema, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\r\n    super(schema, messageArgs, category);\r\n  }\r\n\r\n  /** Gets the schema where the diagnostic originated. */\r\n  public get schema(): Schema { return this.ecDefinition; }\r\n\r\n  /** Gets the DiagnosticType. */\r\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.Schema; }\r\n}\r\n\r\n/**\r\n * An [[IDiagnostic]] implementation used for [[SchemaItem]] diagnostics.\r\n * @beta\r\n */\r\nexport abstract class SchemaItemDiagnostic<TYPE extends SchemaItem, ARGS extends any[]> extends BaseDiagnostic<TYPE, ARGS> {\r\n  public static diagnosticType = DiagnosticType.SchemaItem;\r\n  /**\r\n   * Initializes a new SchemaItemDiagnostic.\r\n   * @param ecDefinition The EC object to associate with the diagnostic.\r\n   * @param messageArgs The arguments used when formatting the diagnostic message.\r\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\r\n   */\r\n  constructor(ecDefinition: SchemaItem, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\r\n    super(ecDefinition as TYPE, messageArgs, category);\r\n  }\r\n\r\n  /** Gets the schema where the diagnostic originated. */\r\n  public get schema(): Schema { return this.ecDefinition.schema; }\r\n\r\n  /** Gets the DiagnosticType. */\r\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.SchemaItem; }\r\n}\r\n\r\n/**\r\n * An [[IDiagnostic]] implementation used for [[ECClass]] diagnostics.\r\n * @beta\r\n */\r\nexport abstract class ClassDiagnostic<ARGS extends any[]> extends SchemaItemDiagnostic<AnyClass, ARGS> {\r\n  /**\r\n   * Initializes a new ClassDiagnostic.\r\n   * @param ecClass The class to associate with the diagnostic.\r\n   * @param messageArgs The arguments used when formatting the diagnostic message.\r\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\r\n   */\r\n  constructor(ecClass: AnyClass, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\r\n    super(ecClass, messageArgs, category);\r\n  }\r\n\r\n  /** Gets the schema where the diagnostic originated. */\r\n  public override get schema(): Schema { return this.ecDefinition.schema; }\r\n}\r\n\r\n/**\r\n * An [[IDiagnostic]] implementation used for [[Property]] diagnostics.\r\n * @beta\r\n */\r\nexport abstract class PropertyDiagnostic<ARGS extends any[]> extends BaseDiagnostic<AnyProperty, ARGS> {\r\n  /**\r\n   * Initializes a new PropertyDiagnostic.\r\n   * @param property The property to associate with the diagnostic.\r\n   * @param messageArgs The arguments used when formatting the diagnostic message.\r\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\r\n   */\r\n  constructor(property: AnyProperty, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\r\n    super(property, messageArgs, category);\r\n  }\r\n\r\n  /** Gets the schema where the diagnostic originated. */\r\n  public get schema(): Schema { return this.ecDefinition.schema; }\r\n\r\n  /** Gets the DiagnosticType. */\r\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.Property; }\r\n}\r\n\r\n/**\r\n * An [[IDiagnostic]] implementation used for [[RelationshipConstraint]] diagnostics.\r\n * @beta\r\n */\r\nexport abstract class RelationshipConstraintDiagnostic<ARGS extends any[]> extends BaseDiagnostic<RelationshipConstraint, ARGS> {\r\n  /**\r\n   * Initializes a new RelationshipConstraintDiagnostic.\r\n   * @param constraint The Relationship Constraint to associate with the diagnostic.\r\n   * @param messageArgs The arguments used when formatting the diagnostic message.\r\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\r\n   */\r\n  constructor(constraint: RelationshipConstraint, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\r\n    super(constraint, messageArgs, category);\r\n  }\r\n\r\n  /** Gets the schema where the diagnostic originated. */\r\n  public get schema(): Schema { return this.ecDefinition.schema; }\r\n\r\n  /** Gets the DiagnosticType. */\r\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.RelationshipConstraint; }\r\n}\r\n\r\n/**\r\n * An [[IDiagnostic]] implementation used for [[CustomAttributeContainerProps]] diagnostics.\r\n * @beta\r\n */\r\nexport abstract class CustomAttributeContainerDiagnostic<ARGS extends any[]> extends BaseDiagnostic<CustomAttributeContainerProps, ARGS> {\r\n  /**\r\n   * Initializes a new CustomAttributeContainerDiagnostic.\r\n   * @param constraint The Custom Attribute Container to associate with the diagnostic.\r\n   * @param messageArgs The arguments used when formatting the diagnostic message.\r\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\r\n   */\r\n  constructor(container: CustomAttributeContainerProps, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\r\n    super(container, messageArgs, category);\r\n  }\r\n\r\n  /** Gets the schema where the diagnostic originated. */\r\n  public get schema(): Schema { return this.ecDefinition.schema; }\r\n\r\n  /** Gets the DiagnosticType. */\r\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.CustomAttributeContainer; }\r\n}\r\n\r\n/**\r\n * Helper method for creating [[SchemaDiagnostic]] child classes.\r\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\r\n * @param messageText The message to associate with the diagnostic class.\r\n * @beta\r\n */\r\nexport function createSchemaDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\r\n  validateCode(code);\r\n  return class extends SchemaDiagnostic<ARGS> {\r\n    public static code = code;\r\n    public get code(): string { return code; }\r\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\r\n  };\r\n}\r\n\r\n/**\r\n * Helper method for creating [[SchemaItemDiagnostic]] child classes.\r\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\r\n * @param messageText The message to associate with the diagnostic class.\r\n * @beta\r\n */\r\nexport function createSchemaItemDiagnosticClass<ITEM extends SchemaItem, ARGS extends any[]>(code: string, messageText: string) {\r\n  validateCode(code);\r\n  return class extends SchemaItemDiagnostic<ITEM, ARGS> {\r\n    public get code(): string { return code; }\r\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\r\n  };\r\n}\r\n\r\n/**\r\n * Helper method for creating [[ClassDiagnostic]] child classes.\r\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\r\n * @param messageText The message to associate with the diagnostic class.\r\n * @beta\r\n */\r\nexport function createClassDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\r\n  validateCode(code);\r\n  return class extends ClassDiagnostic<ARGS> {\r\n    public get code(): string { return code; }\r\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\r\n  };\r\n}\r\n\r\n/**\r\n * Helper method for creating [[PropertyDiagnostic]] child classes.\r\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\r\n * @param messageText The message to associate with the diagnostic class.\r\n * @beta\r\n */\r\nexport function createPropertyDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\r\n  validateCode(code);\r\n  return class extends PropertyDiagnostic<ARGS> {\r\n    public static code = code;\r\n    public get code(): string { return code; }\r\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\r\n  };\r\n}\r\n\r\n/**\r\n * Helper method for creating [[RelationshipConstraintDiagnostic]] child classes.\r\n * @param code The string that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.\r\n * @param messageText The message to associate with the diagnostic class.\r\n * @beta\r\n */\r\nexport function createRelationshipConstraintDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\r\n  validateCode(code);\r\n  return class extends RelationshipConstraintDiagnostic<ARGS> {\r\n    public get code(): string { return code; }\r\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\r\n  };\r\n}\r\n\r\n/**\r\n * Helper method for creating [[CustomAttributeContainerDiagnostic]] child classes.\r\n * @param code The that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.\r\n * @param messageText The message to associate with the diagnostic class.\r\n * @beta\r\n */\r\nexport function createCustomAttributeContainerDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\r\n  validateCode(code);\r\n  return class extends CustomAttributeContainerDiagnostic<ARGS> {\r\n    public get code(): string { return code; }\r\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\r\n  };\r\n}\r\n\r\n/** @beta */\r\nexport function diagnosticCategoryToString(category: DiagnosticCategory) {\r\n  switch (category) {\r\n    case DiagnosticCategory.Error:\r\n      return \"Error\";\r\n    case DiagnosticCategory.Warning:\r\n      return \"Warning\";\r\n    case DiagnosticCategory.Message:\r\n      return \"Message\";\r\n    case DiagnosticCategory.Suggestion:\r\n      return \"Suggestion\";\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport function diagnosticTypeToString(type: DiagnosticType) {\r\n  switch (type) {\r\n    case DiagnosticType.CustomAttributeContainer:\r\n      return \"CustomAttributeContainer\";\r\n    case DiagnosticType.None:\r\n      return \"None\";\r\n    case DiagnosticType.Property:\r\n      return \"Property\";\r\n    case DiagnosticType.RelationshipConstraint:\r\n      return \"RelationshipConstraint\";\r\n    case DiagnosticType.Schema:\r\n      return \"Schema\";\r\n    case DiagnosticType.SchemaItem:\r\n      return \"SchemaItem\";\r\n  }\r\n}\r\n\r\nfunction validateCode(code: string) {\r\n  const msg = `Diagnostic code ${code} is invalid. Expected the format <ruleSetName>-<number>.`;\r\n  const parts = code.split(\"-\");\r\n  if (parts.length !== 2)\r\n    throw new Error(msg);\r\n\r\n  if (isNaN(Number(parts[1])))\r\n    throw new Error(msg);\r\n}\r\n"]}

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;AAElC,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\");\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;AAElC,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":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Diagnostic\r\n */\r\n\r\nimport { Localization } from \"@itwin/core-common\";\r\nimport { AnyDiagnostic } from \"./Diagnostic\";\r\n\r\nimport assert = require(\"assert\");\r\n\r\nconst translationNamespace = \"ECSchemaMetaData\";\r\nconst subTranslationNamespace = \"Diagnostics\";\r\nconst baseTranslationKey = `${translationNamespace}:${subTranslationNamespace}`;\r\n\r\n/**\r\n * Interface used to report [[IDiagnostic]] objects created during schema validation.\r\n * @beta\r\n */\r\nexport interface IDiagnosticReporter {\r\n  /**\r\n   * A map where the key is a schema full name and the value is a collection\r\n   * of diagnostics codes identifying which rules violations to ignore during validation.\r\n   */\r\n  suppressions?: Map<string, string[]>;\r\n\r\n  /** The localization object to use for message translation. */\r\n  localization?: Localization;\r\n\r\n  /**\r\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\r\n   * given reporter.\r\n   * @param diagnostic The diagnostic to report.\r\n   */\r\n  report(diagnostic: AnyDiagnostic): void;\r\n}\r\n\r\n/**\r\n * An abstract base class for [[IDiagnosticReporter]] implementation that used the\r\n * provided Map to suppress certain rule violations from being reported. The Map's key\r\n * a schema full name, and the Map's value is a collection of rule codes to suppress.\r\n * @beta\r\n */\r\nexport abstract class SuppressionDiagnosticReporter implements IDiagnosticReporter {\r\n  private _suppressions?: Map<string, string[]>;\r\n\r\n  /**\r\n   * Initializes a new SuppressionDiagnosticReporter\r\n   * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.\r\n   */\r\n  constructor(suppressions?: Map<string, string[]>) {\r\n    this._suppressions = suppressions;\r\n  }\r\n\r\n  /**\r\n   * Gets the collection of ISchemaDiagnosticSuppression objects that identify\r\n   * rules violations to ignore during validation.\r\n   */\r\n  public get suppressions(): Map<string, string[]> | undefined {\r\n    return this._suppressions;\r\n  }\r\n\r\n  /**\r\n   * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)\r\n   * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.\r\n   * @param diagnostic The diagnostic to report.\r\n   */\r\n  public report(diagnostic: AnyDiagnostic) {\r\n    if (this._suppressions && this._suppressions.has(diagnostic.schema.fullName)) {\r\n      const suppressedCodes = this._suppressions.get(diagnostic.schema.fullName);\r\n      if (suppressedCodes!.includes(diagnostic.code))\r\n        return;\r\n    }\r\n\r\n    this.reportInternal(diagnostic);\r\n  }\r\n\r\n  /**\r\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\r\n   * given reporter.\r\n   * @param diagnostic The diagnostic to report.\r\n   */\r\n  protected abstract reportInternal(diagnostic: AnyDiagnostic): void;\r\n}\r\n\r\n/**\r\n * An abstract [[SuppressionDiagnosticReporter]] implementation that formats the\r\n * diagnostic message with the message args. If a Localization implementation is specified,\r\n * the message will also be translated.\r\n * @beta\r\n */\r\nexport abstract class FormatDiagnosticReporter extends SuppressionDiagnosticReporter {\r\n  /**\r\n   * Initializes a new FormatDiagnosticReporter\r\n   * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.\r\n   * @param localization The Localization instance to use to translate validation messages.\r\n   */\r\n  constructor(suppressions?: Map<string, string[]>, localization?: Localization) {\r\n    super(suppressions);\r\n    this.localization = localization;\r\n  }\r\n\r\n  /** The Localization object to use for message translation. If undefined, no translation will occur. */\r\n  public localization?: Localization;\r\n\r\n  /**\r\n   * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)\r\n   * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.\r\n   * @param diagnostic The diagnostic to report.\r\n   */\r\n  public reportInternal(diagnostic: AnyDiagnostic) {\r\n    const message = this.formatMessage(diagnostic);\r\n    this.reportDiagnostic(diagnostic, message);\r\n  }\r\n\r\n  /**\r\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\r\n   * given reporter.\r\n   * @param diagnostic The diagnostic to report.\r\n   * @param messageText The formatted message.\r\n   */\r\n  protected abstract reportDiagnostic(diagnostic: AnyDiagnostic, messageText: string): void;\r\n\r\n  /**\r\n   * Helper method that formats string with provided arguments where the place holders\r\n   * are in the the format '{0}', '{1}', etc.\r\n   * @param text The text to format.\r\n   * @param args The arguments to place in the text.\r\n   * @param baseIndex The base index for the args, used for validation (typically 0, which is the default).\r\n   */\r\n  protected formatStringFromArgs(text: string, args: ArrayLike<string>, baseIndex = 0): string {\r\n    return text.replace(/{(\\d+)}/g, (_match, index: string) => this.assertDefined(args[+index + baseIndex]));\r\n  }\r\n\r\n  private formatMessage(diagnostic: AnyDiagnostic): string {\r\n    let translatedMessage = this.translateMessage(diagnostic);\r\n\r\n    if (diagnostic.messageArgs && diagnostic.messageArgs.length > 0)\r\n      translatedMessage = this.formatStringFromArgs(translatedMessage, diagnostic.messageArgs);\r\n    return translatedMessage;\r\n  }\r\n\r\n  private translateMessage(diagnostic: AnyDiagnostic): string {\r\n    if (!this.localization)\r\n      return diagnostic.messageText;\r\n\r\n    return this.localization.getLocalizedString(this.getTranslationKey(diagnostic));\r\n  }\r\n\r\n  private getTranslationKey(diagnostic: AnyDiagnostic): string {\r\n    return `${baseTranslationKey}.${diagnostic.code}`;\r\n  }\r\n\r\n  private assertDefined<T>(value: T | null | undefined, message?: string): T {\r\n    if (value === undefined || value === null)\r\n      return assert(false, message) as never;\r\n\r\n    return value;\r\n  }\r\n}\r\n"]}