@itwin/ecschema-editing 4.6.0-dev.7 → 4.6.0-dev.8

package/lib/cjs/Differencing/SchemaConflicts.d.ts

@@ -30,7 +30,7 @@ import type { SchemaType } from "./SchemaDifference";
  * - Unit:                      1800-1899
  * - UnitSystem:                1900-1999
  *
- * @internal
+ * @alpha
  */
 export declare enum ConflictCode {
     ConflictingItemName = "C-001",
@@ -51,7 +51,7 @@ export declare enum ConflictCode {
  * while comparing the changed elements. Conflicts in the whole schema context are not found
  * on that level.
  *
- * @internal
+ * @alpha
  */
 export interface SchemaDifferenceConflict {
     /**

package/lib/cjs/Differencing/SchemaConflicts.js

@@ -36,7 +36,7 @@ exports.ConflictCode = void 0;
  * - Unit:                      1800-1899
  * - UnitSystem:                1900-1999
  *
- * @internal
+ * @alpha
  */
 var ConflictCode;
 (function (ConflictCode) {

package/lib/cjs/Differencing/SchemaConflicts.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaConflicts.js","sourceRoot":"","sources":["../../../src/Differencing/SchemaConflicts.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,IAAY,YAmBX;AAnBD,WAAY,YAAY;IAEtB,6CAA6B,CAAA;IAC7B,mDAAmC,CAAA;IAEnC,8CAA8B,CAAA;IAC9B,2CAA2B,CAAA;IAC3B,yCAAyB,CAAA;IAEzB,oDAAoC,CAAA;IACpC,oDAAoC,CAAA;IAEpC,+DAA+C,CAAA;IAE/C,kDAAkC,CAAA;IAElC,sEAAsD,CAAA;IACtD,sEAAsD,CAAA;IACtD,wEAAwD,CAAA;AAC1D,CAAC,EAnBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAmBvB","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 Differencing\r\n */\r\n\r\nimport type { SchemaType } from \"./SchemaDifference\";\r\n\r\n/**\r\n * The unique conflicts codes for Schema differencing.\r\n *\r\n * To provide meaning to code values, with anticipation\r\n * of future rules for all current EC Types, the following\r\n * value ranges should be used:\r\n *\r\n * - Schema:                    000-099\r\n * - Class:                     100-199\r\n * - Constant:                  200-299\r\n * - CustomAttribute            300-399\r\n * - CustomAttributeClass:      400-499\r\n * - CustomAttributeContainer:  500-599\r\n * - EntityClass:               600-699\r\n * - Enumeration:               700-799\r\n * - Format:                    800-899\r\n * - InvertedUnit:              900-999\r\n * - KindOfQuantity:            1000-1099\r\n * - Mixin:                     1100-1199\r\n * - Phenomenon:                1200-1299\r\n * - Property:                  1300-1399\r\n * - PropertyCategory:          1400-1499\r\n * - RelationshipClass:         1500-1599\r\n * - RelationshipConstraint:    1600-1699\r\n * - StructClass:               1700-1799\r\n * - Unit:                      1800-1899\r\n * - UnitSystem:                1900-1999\r\n *\r\n * @internal\r\n */\r\nexport enum ConflictCode {\r\n\r\n  ConflictingItemName = \"C-001\",\r\n  ConflictingReferenceAlias = \"C-002\",\r\n\r\n  ConflictingBaseClass = \"C-100\",\r\n  RemovingBaseClass = \"C-101\",\r\n  SealedBaseClass = \"C-102\",\r\n\r\n  ConflictingEnumerationType = \"C-700\",\r\n  ConflictingEnumeratorValue = \"C-701\",\r\n\r\n  MixinAppliedMustDeriveFromConstraint = \"C-1100\",\r\n\r\n  ConflictingPropertyName = \"C-1300\",\r\n\r\n  AbstractConstraintMustNarrowBaseConstraints = \"C-1500\",\r\n  DerivedConstraintsMustNarrowBaseConstraints = \"C-1501\",\r\n  ConstraintClassesDeriveFromAbstractConstraint = \"C-1502\",\r\n}\r\n\r\n/**\r\n * Defines the interface for a conflict during Schema Differencing. Conflicts were discovered\r\n * while comparing the changed elements. Conflicts in the whole schema context are not found\r\n * on that level.\r\n *\r\n * @internal\r\n */\r\nexport interface SchemaDifferenceConflict {\r\n  /**\r\n   * The name of the schema type which is \"Schema\" for a conflict on the schema, on schema items\r\n   * or objects that are related to schema items (properties, relationship constraints) it is the\r\n   * name of the related schema item.\r\n   */\r\n  readonly schemaType: SchemaType;\r\n\r\n  /** The name of the schema item the conflict appears on. */\r\n  readonly itemName?: string;\r\n\r\n  /** Optional path what on the item was conflicting. */\r\n  readonly path?: string;\r\n\r\n  /** The unique conflicting code. */\r\n  readonly code: ConflictCode;\r\n\r\n  /** A description of the conflict. */\r\n  readonly description: string;\r\n\r\n  /** The value in the source schema. */\r\n  readonly source: unknown;\r\n\r\n  /** The value in the target schema. */\r\n  readonly target: unknown;\r\n}\r\n"]}
+{"version":3,"file":"SchemaConflicts.js","sourceRoot":"","sources":["../../../src/Differencing/SchemaConflicts.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,IAAY,YAmBX;AAnBD,WAAY,YAAY;IAEtB,6CAA6B,CAAA;IAC7B,mDAAmC,CAAA;IAEnC,8CAA8B,CAAA;IAC9B,2CAA2B,CAAA;IAC3B,yCAAyB,CAAA;IAEzB,oDAAoC,CAAA;IACpC,oDAAoC,CAAA;IAEpC,+DAA+C,CAAA;IAE/C,kDAAkC,CAAA;IAElC,sEAAsD,CAAA;IACtD,sEAAsD,CAAA;IACtD,wEAAwD,CAAA;AAC1D,CAAC,EAnBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAmBvB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Differencing\n */\n\nimport type { SchemaType } from \"./SchemaDifference\";\n\n/**\n * The unique conflicts codes for Schema differencing.\n *\n * To provide meaning to code values, with anticipation\n * of future rules for all current EC Types, the following\n * value ranges should be used:\n *\n * - Schema:                    000-099\n * - Class:                     100-199\n * - Constant:                  200-299\n * - CustomAttribute            300-399\n * - CustomAttributeClass:      400-499\n * - CustomAttributeContainer:  500-599\n * - EntityClass:               600-699\n * - Enumeration:               700-799\n * - Format:                    800-899\n * - InvertedUnit:              900-999\n * - KindOfQuantity:            1000-1099\n * - Mixin:                     1100-1199\n * - Phenomenon:                1200-1299\n * - Property:                  1300-1399\n * - PropertyCategory:          1400-1499\n * - RelationshipClass:         1500-1599\n * - RelationshipConstraint:    1600-1699\n * - StructClass:               1700-1799\n * - Unit:                      1800-1899\n * - UnitSystem:                1900-1999\n *\n * @alpha\n */\nexport enum ConflictCode {\n\n  ConflictingItemName = \"C-001\",\n  ConflictingReferenceAlias = \"C-002\",\n\n  ConflictingBaseClass = \"C-100\",\n  RemovingBaseClass = \"C-101\",\n  SealedBaseClass = \"C-102\",\n\n  ConflictingEnumerationType = \"C-700\",\n  ConflictingEnumeratorValue = \"C-701\",\n\n  MixinAppliedMustDeriveFromConstraint = \"C-1100\",\n\n  ConflictingPropertyName = \"C-1300\",\n\n  AbstractConstraintMustNarrowBaseConstraints = \"C-1500\",\n  DerivedConstraintsMustNarrowBaseConstraints = \"C-1501\",\n  ConstraintClassesDeriveFromAbstractConstraint = \"C-1502\",\n}\n\n/**\n * Defines the interface for a conflict during Schema Differencing. Conflicts were discovered\n * while comparing the changed elements. Conflicts in the whole schema context are not found\n * on that level.\n *\n * @alpha\n */\nexport interface SchemaDifferenceConflict {\n  /**\n   * The name of the schema type which is \"Schema\" for a conflict on the schema, on schema items\n   * or objects that are related to schema items (properties, relationship constraints) it is the\n   * name of the related schema item.\n   */\n  readonly schemaType: SchemaType;\n\n  /** The name of the schema item the conflict appears on. */\n  readonly itemName?: string;\n\n  /** Optional path what on the item was conflicting. */\n  readonly path?: string;\n\n  /** The unique conflicting code. */\n  readonly code: ConflictCode;\n\n  /** A description of the conflict. */\n  readonly description: string;\n\n  /** The value in the source schema. */\n  readonly source: unknown;\n\n  /** The value in the target schema. */\n  readonly target: unknown;\n}\n"]}

package/lib/cjs/Differencing/SchemaDiagnosticVisitor.d.ts

@@ -2,7 +2,8 @@
  * @module Differencing
  */
 import type { AnyDiagnostic } from "../Validation/Diagnostic";
-import { SchemaDifferences } from "./SchemaDifference";
+import { type AnySchemaItemDifference, type AnySchemaItemPathDifference, type CustomAttributeDifference, type SchemaDifference, type SchemaReferenceDifference } from "./SchemaDifference";
+import { SchemaDifferenceConflict } from "./SchemaConflicts";
 /**
  * The SchemaDiagnosticVisitor is a visitor implementation for diagnostic entries
  * from the schema comparer api. Depending on the diagnostic code, the difference
@@ -10,16 +11,18 @@ import { SchemaDifferences } from "./SchemaDifference";
  * @internal
  */
 export declare class SchemaDiagnosticVisitor {
-    private readonly _differenceReport;
-    constructor(differenceReport: SchemaDifferences);
-    private addEntry;
-    private lookupEntry;
+    readonly schemaChanges: Array<SchemaDifference | SchemaReferenceDifference>;
+    readonly schemaItemChanges: Array<AnySchemaItemDifference>;
+    readonly schemaItemPathChanges: Array<AnySchemaItemPathDifference>;
+    readonly customAttributeChanges: Array<CustomAttributeDifference>;
+    readonly conflicts: Array<SchemaDifferenceConflict>;
+    constructor();
     private addConflict;
     /**
      * Visitor function to process the schema change diagnostic object.
      * @internal
      */
-    visit(diagnostic: AnyDiagnostic): void;
+    visit(diagnostic: AnyDiagnostic): number | void;
     private visitChangedSchemaProperties;
     private visitMissingSchemaItem;
     private visitChangedSchemaItem;

package/lib/cjs/Differencing/SchemaDiagnosticVisitor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaDiagnosticVisitor.d.ts","sourceRoot":"","sources":["../../../src/Differencing/SchemaDiagnosticVisitor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAM9D,OAAO,EAKL,iBAAiB,EAQlB,MAAM,oBAAoB,CAAC;AA0B5B;;;;;GAKG;AACH,qBAAa,uBAAuB;IAElC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;gBAE1C,gBAAgB,EAAE,iBAAiB;IAI/C,OAAO,CAAC,QAAQ;IAKhB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,WAAW;IAInB;;;OAGG;IACI,KAAK,CAAC,UAAU,EAAE,aAAa;IA6DtC,OAAO,CAAC,4BAA4B;IA+BpC,OAAO,CAAC,sBAAsB;IAU9B,OAAO,CAAC,sBAAsB;IAmC9B,OAAO,CAAC,uBAAuB;IAqB/B,OAAO,CAAC,sBAAsB;IAgB9B,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,sBAAsB;IAgC9B,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,oBAAoB;IA2B5B,OAAO,CAAC,sBAAsB;IAgB9B,OAAO,CAAC,qBAAqB;IAwB7B,OAAO,CAAC,uBAAuB;IA0C/B,OAAO,CAAC,wBAAwB;IAyBhC,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,uCAAuC;IAuB/C,OAAO,CAAC,kCAAkC;IAyB1C,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,mCAAmC;CAe5C"}
+{"version":3,"file":"SchemaDiagnosticVisitor.d.ts","sourceRoot":"","sources":["../../../src/Differencing/SchemaDiagnosticVisitor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAO9D,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAGhC,KAAK,yBAAyB,EAM9B,KAAK,gBAAgB,EAErB,KAAK,yBAAyB,EAC/B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAgB,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAgB3E;;;;;GAKG;AACH,qBAAa,uBAAuB;IAElC,SAAgB,aAAa,EAAE,KAAK,CAAC,gBAAgB,GAAC,yBAAyB,CAAC,CAAC;IACjF,SAAgB,iBAAiB,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAClE,SAAgB,qBAAqB,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC1E,SAAgB,sBAAsB,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;IACzE,SAAgB,SAAS,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;;IAU3D,OAAO,CAAC,WAAW;IAInB;;;OAGG;IACI,KAAK,CAAC,UAAU,EAAE,aAAa;IA6DtC,OAAO,CAAC,4BAA4B;IAiCpC,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,sBAAsB;IA4C9B,OAAO,CAAC,uBAAuB;IAqB/B,OAAO,CAAC,sBAAsB;IAkB9B,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,sBAAsB;IAqC9B,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,oBAAoB;IAiB5B,OAAO,CAAC,oBAAoB;IAqC5B,OAAO,CAAC,sBAAsB;IAgB9B,OAAO,CAAC,qBAAqB;IA8B7B,OAAO,CAAC,uBAAuB;IA0C/B,OAAO,CAAC,wBAAwB;IA6BhC,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,uCAAuC;IA6B/C,OAAO,CAAC,kCAAkC;IAsC1C,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,mCAAmC;CA+D5C"}