@itwin/ecschema-editing 4.5.0-dev.30 → 4.5.0-dev.32

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

@@ -0,0 +1,76 @@
+/** @packageDocumentation
+ * @module Differencing
+ */
+import type { SchemaType } from "./SchemaDifference";
+/**
+ * The unique conflicts codes for Schema differencing.
+ *
+ * To provide meaning to code values, with anticipation
+ * of future rules for all current EC Types, the following
+ * value ranges should be used:
+ *
+ * - Schema:                    000-099
+ * - Class:                     100-199
+ * - Constant:                  200-299
+ * - CustomAttribute            300-399
+ * - CustomAttributeClass:      400-499
+ * - CustomAttributeContainer:  500-599
+ * - EntityClass:               600-699
+ * - Enumeration:               700-799
+ * - Format:                    800-899
+ * - InvertedUnit:              900-999
+ * - KindOfQuantity:            1000-1099
+ * - Mixin:                     1100-1199
+ * - Phenomenon:                1200-1299
+ * - Property:                  1300-1399
+ * - PropertyCategory:          1400-1499
+ * - RelationshipClass:         1500-1599
+ * - RelationshipConstraint:    1600-1699
+ * - StructClass:               1700-1799
+ * - Unit:                      1800-1899
+ * - UnitSystem:                1900-1999
+ *
+ * @internal
+ */
+export declare enum ConflictCode {
+    ConflictingItemName = "C-001",
+    ConflictingReferenceAlias = "C-002",
+    ConflictingBaseClass = "C-100",
+    RemovingBaseClass = "C-101",
+    SealedBaseClass = "C-102",
+    ConflictingEnumerationType = "C-700",
+    ConflictingEnumeratorValue = "C-701",
+    MixinAppliedMustDeriveFromConstraint = "C-1100",
+    ConflictingPropertyName = "C-1300",
+    AbstractConstraintMustNarrowBaseConstraints = "C-1500",
+    DerivedConstraintsMustNarrowBaseConstraints = "C-1501",
+    ConstraintClassesDeriveFromAbstractConstraint = "C-1502"
+}
+/**
+ * Defines the interface for a conflict during Schema Differencing. Conflicts were discovered
+ * while comparing the changed elements. Conflicts in the whole schema context are not found
+ * on that level.
+ *
+ * @internal
+ */
+export interface SchemaDifferenceConflict {
+    /**
+     * The name of the schema type which is "Schema" for a conflict on the schema, on schema items
+     * or objects that are related to schema items (properties, relationship constraints) it is the
+     * name of the related schema item.
+     */
+    readonly schemaType: SchemaType;
+    /** The name of the schema item the conflict appears on. */
+    readonly itemName?: string;
+    /** Optional path what on the item was conflicting. */
+    readonly path?: string;
+    /** The unique conflicting code. */
+    readonly code: ConflictCode;
+    /** A description of the conflict. */
+    readonly description: string;
+    /** The value in the source schema. */
+    readonly source: unknown;
+    /** The value in the target schema. */
+    readonly target: unknown;
+}
+//# sourceMappingURL=SchemaConflicts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaConflicts.d.ts","sourceRoot":"","sources":["../../../src/Differencing/SchemaConflicts.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,oBAAY,YAAY;IAEtB,mBAAmB,UAAU;IAC7B,yBAAyB,UAAU;IAEnC,oBAAoB,UAAU;IAC9B,iBAAiB,UAAU;IAC3B,eAAe,UAAU;IAEzB,0BAA0B,UAAU;IACpC,0BAA0B,UAAU;IAEpC,oCAAoC,WAAW;IAE/C,uBAAuB,WAAW;IAElC,2CAA2C,WAAW;IACtD,2CAA2C,WAAW;IACtD,6CAA6C,WAAW;CACzD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC,2DAA2D;IAC3D,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE3B,sDAAsD;IACtD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAE5B,qCAAqC;IACrC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B"}

package/lib/cjs/Differencing/SchemaConflicts.js

@@ -0,0 +1,56 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Differencing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConflictCode = void 0;
+/**
+ * The unique conflicts codes for Schema differencing.
+ *
+ * To provide meaning to code values, with anticipation
+ * of future rules for all current EC Types, the following
+ * value ranges should be used:
+ *
+ * - Schema:                    000-099
+ * - Class:                     100-199
+ * - Constant:                  200-299
+ * - CustomAttribute            300-399
+ * - CustomAttributeClass:      400-499
+ * - CustomAttributeContainer:  500-599
+ * - EntityClass:               600-699
+ * - Enumeration:               700-799
+ * - Format:                    800-899
+ * - InvertedUnit:              900-999
+ * - KindOfQuantity:            1000-1099
+ * - Mixin:                     1100-1199
+ * - Phenomenon:                1200-1299
+ * - Property:                  1300-1399
+ * - PropertyCategory:          1400-1499
+ * - RelationshipClass:         1500-1599
+ * - RelationshipConstraint:    1600-1699
+ * - StructClass:               1700-1799
+ * - Unit:                      1800-1899
+ * - UnitSystem:                1900-1999
+ *
+ * @internal
+ */
+var ConflictCode;
+(function (ConflictCode) {
+    ConflictCode["ConflictingItemName"] = "C-001";
+    ConflictCode["ConflictingReferenceAlias"] = "C-002";
+    ConflictCode["ConflictingBaseClass"] = "C-100";
+    ConflictCode["RemovingBaseClass"] = "C-101";
+    ConflictCode["SealedBaseClass"] = "C-102";
+    ConflictCode["ConflictingEnumerationType"] = "C-700";
+    ConflictCode["ConflictingEnumeratorValue"] = "C-701";
+    ConflictCode["MixinAppliedMustDeriveFromConstraint"] = "C-1100";
+    ConflictCode["ConflictingPropertyName"] = "C-1300";
+    ConflictCode["AbstractConstraintMustNarrowBaseConstraints"] = "C-1500";
+    ConflictCode["DerivedConstraintsMustNarrowBaseConstraints"] = "C-1501";
+    ConflictCode["ConstraintClassesDeriveFromAbstractConstraint"] = "C-1502";
+})(ConflictCode = exports.ConflictCode || (exports.ConflictCode = {}));
+//# sourceMappingURL=SchemaConflicts.js.map

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

@@ -0,0 +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"]}

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

@@ -0,0 +1,43 @@
+/** @packageDocumentation
+ * @module Differencing
+ */
+import type { AnyDiagnostic } from "../Validation/Diagnostic";
+import { SchemaDifferences } from "./SchemaDifference";
+/**
+ * The SchemaDiagnosticVisitor is a visitor implementation for diagnostic entries
+ * from the schema comparer api. Depending on the diagnostic code, the difference
+ * result is build together.
+ * @internal
+ */
+export declare class SchemaDiagnosticVisitor {
+    private readonly _differenceReport;
+    constructor(differenceReport: SchemaDifferences);
+    private addEntry;
+    private lookupEntry;
+    private addConflict;
+    /**
+     * Visitor function to process the schema change diagnostic object.
+     * @internal
+     */
+    visit(diagnostic: AnyDiagnostic): void;
+    private visitChangedSchemaProperties;
+    private visitMissingSchemaItem;
+    private visitChangedSchemaItem;
+    private visitChangedEnumeration;
+    private visitMissingEnumerator;
+    private lookupEnumeratorEntry;
+    private visitChangedEnumerator;
+    private validateEnumerator;
+    private visitMissingProperty;
+    private visitChangedProperty;
+    private validatePropertyChange;
+    private visitMissingBaseClass;
+    private validateBaseClassChange;
+    private visitMissingMixinOnClass;
+    private validateMixin;
+    private visitMissingRelationshipConstraintClass;
+    private visitChangedRelationshipConstraint;
+    private visitSchemaReference;
+    private visitMissingCustomAttributeInstance;
+}
+//# sourceMappingURL=SchemaDiagnosticVisitor.d.ts.map

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

@@ -0,0 +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"}