@itwin/ecschema-editing 4.5.0-dev.9 → 4.5.0

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

@@ -0,0 +1,150 @@
+/** @packageDocumentation
+ * @module Differencing
+ */
+import { SchemaChanges } from "../Validation/SchemaChanges";
+import { SchemaDifferenceConflict } from "./SchemaConflicts";
+import type { AnyEnumerator, AnyPropertyProps, AnySchemaItemProps, CustomAttribute, RelationshipConstraintProps, Schema, SchemaProps, SchemaReferenceProps } from "@itwin/ecschema-metadata";
+/**
+ * Defines the type of the difference operation.
+ * @internal
+ */
+export type DifferenceType = "add" | "modify";
+/**
+ * Defines a set of SchemaItem names.
+ * @internal
+ */
+export type SchemaItemTypeName = "EntityClass" | "Mixin" | "StructClass" | "CustomAttributeClass" | "RelationshipClass" | "Enumeration" | "KindOfQuantity" | "PropertyCategory" | "Unit" | "InvertedUnit" | "Constant" | "Phenomenon" | "UnitSystem" | "Format";
+/**
+ * Defines the possible values SchemaTypes that can occur in SchemaDifferences or Conflicts.
+ * @internal
+ */
+export type SchemaType = "Schema" | SchemaItemTypeName | "Property" | "RelationshipConstraint";
+/**
+ * @internal
+ */
+export declare namespace SchemaDifference {
+    /**
+     * Creates a [[SchemaDifference]] for two given schemas.
+     * @param targetSchema  The schema the differences gets merged into.
+     * @param sourceSchema  The schema to get merged in the target.
+     * @returns             An [[SchemaDifference]] object.
+     * @internal
+     */
+    function fromSchemas(targetSchema: Schema, sourceSchema: Schema): Promise<SchemaDifferences>;
+    /**
+     * Creates a [[SchemaDifference]] for a given [[SchemaChanges]] report.
+     * @param targetSchema
+     * @param schemaChanges   A changes report of two schemas.
+     * @returns               An [[SchemaDifference]] object.
+     * @internal
+     */
+    function fromSchemaChanges(targetSchema: Schema, schemaChanges: SchemaChanges): Promise<SchemaDifferences>;
+}
+type MutualPartial<T> = {
+    -readonly [P in keyof T]?: T[P];
+};
+/**
+ * @internal
+ */
+export interface SchemaDifferences {
+    readonly sourceSchemaName: string;
+    readonly targetSchemaName: string;
+    readonly changes: AnySchemaDifference[];
+    readonly conflicts: SchemaDifferenceConflict[];
+}
+/**
+ * @internal
+ */
+export type AnySchemaDifference = SchemaDifference | SchemaItemDifference | SchemaPropertyDifference | SchemaReferenceDifference | SchemaEnumeratorDifference | SchemaClassMixinDifference | SchemaRelationshipConstraintDifference | SchemaRelationshipConstraintClassDifference | SchemaCustomAttributeDifference;
+/**
+ * @internal
+ */
+export interface SchemaDifference {
+    changeType: "modify";
+    schemaType: "Schema";
+    itemName?: undefined;
+    path?: undefined;
+    json: MutualPartial<SchemaProps>;
+}
+/**
+ * @internal
+ */
+export interface SchemaItemDifference<T extends AnySchemaItemProps = AnySchemaItemProps> {
+    changeType: "add" | "modify" | "remove";
+    schemaType: SchemaItemTypeName;
+    itemName: string;
+    path?: string;
+    json: MutualPartial<T>;
+}
+/**
+ * @internal
+ */
+export interface SchemaPropertyDifference<T extends AnyPropertyProps = AnyPropertyProps> {
+    changeType: "add" | "modify" | "remove";
+    schemaType: "Property";
+    itemName: string;
+    path: string;
+    json: MutualPartial<T>;
+}
+/**
+ * @internal
+ */
+export interface SchemaReferenceDifference {
+    changeType: "add" | "modify" | "remove";
+    schemaType: "Schema";
+    itemName?: undefined;
+    path: "$references";
+    json: MutualPartial<SchemaReferenceProps>;
+}
+/**
+ * @internal
+ */
+export interface SchemaEnumeratorDifference {
+    changeType: "add" | "modify" | "remove";
+    schemaType: "Enumeration";
+    itemName: string;
+    path: string;
+    json: MutualPartial<AnyEnumerator>;
+}
+/**
+ * @internal
+ */
+export interface SchemaClassMixinDifference {
+    changeType: "modify";
+    schemaType: "EntityClass";
+    itemName: string;
+    path: "$mixins";
+    json: string[];
+}
+/**
+ * @internal
+ */
+export interface SchemaRelationshipConstraintDifference {
+    changeType: "modify";
+    schemaType: "RelationshipConstraint";
+    itemName: string;
+    path: string;
+    json: MutualPartial<RelationshipConstraintProps>;
+}
+/**
+ * @internal
+ */
+export interface SchemaRelationshipConstraintClassDifference {
+    changeType: "modify";
+    schemaType: "RelationshipClass";
+    itemName: string;
+    path: string;
+    json: string[];
+}
+/**
+ * @internal
+ */
+export interface SchemaCustomAttributeDifference {
+    changeType: "add" | "modify";
+    schemaType: "Schema" | "EnitityClass" | "Properties" | "RelationshipConstraint";
+    itemName?: string;
+    path?: string;
+    json: MutualPartial<CustomAttribute>;
+}
+export {};
+//# sourceMappingURL=SchemaDifference.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaDifference.d.ts","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifference.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAC;AAE7D,OAAO,KAAK,EACV,aAAa,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,EACzG,WAAW,EAAE,oBAAoB,EAClC,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC5B,aAAa,GACb,OAAO,GACP,aAAa,GACb,sBAAsB,GACtB,mBAAmB,GACnB,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,MAAM,GACN,cAAc,GACd,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,QAAQ,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,kBAAkB,GAAG,UAAU,GAAG,wBAAwB,CAAC;AAE/F;;GAEG;AACH,yBAAiB,gBAAgB,CAAC;IAChC;;;;;;OAMG;IACH,SAAsB,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAMxG;IAED;;;;;;OAMG;IACH,SAAsB,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,CActH;CACF;AAED,KAAK,aAAa,CAAC,CAAC,IAAI;IACtB,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAEhC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC,QAAQ,CAAC,OAAO,EAAE,mBAAmB,EAAE,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,wBAAwB,EAAE,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC7B,gBAAgB,GAChB,oBAAoB,GACpB,wBAAwB,GACxB,yBAAyB,GACzB,0BAA0B,GAC1B,0BAA0B,GAC1B,sCAAsC,GACtC,2CAA2C,GAC3C,+BAA+B,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB;IACrF,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACxC,UAAU,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB;IACrF,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACxC,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACxC,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACxC,UAAU,EAAE,aAAa,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,aAAa,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACrD,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,wBAAwB,CAAC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC,2BAA2B,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,2CAA2C;IAC1D,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,mBAAmB,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,UAAU,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC7B,UAAU,EAAE,QAAQ,GAAG,cAAc,GAAG,YAAY,GAAG,wBAAwB,CAAC;IAChF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;CACtC"}

package/lib/cjs/Differencing/SchemaDifference.js

@@ -0,0 +1,54 @@
+"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.SchemaDifference = void 0;
+const SchemaComparer_1 = require("../Validation/SchemaComparer");
+const SchemaDiagnosticVisitor_1 = require("./SchemaDiagnosticVisitor");
+/**
+ * @internal
+ */
+var SchemaDifference;
+(function (SchemaDifference) {
+    /**
+     * Creates a [[SchemaDifference]] for two given schemas.
+     * @param targetSchema  The schema the differences gets merged into.
+     * @param sourceSchema  The schema to get merged in the target.
+     * @returns             An [[SchemaDifference]] object.
+     * @internal
+     */
+    async function fromSchemas(targetSchema, sourceSchema) {
+        const changesList = [];
+        const schemaComparer = new SchemaComparer_1.SchemaComparer({ report: changesList.push.bind(changesList) });
+        await schemaComparer.compareSchemas(sourceSchema, targetSchema);
+        return fromSchemaChanges(targetSchema, changesList[0]);
+    }
+    SchemaDifference.fromSchemas = fromSchemas;
+    /**
+     * Creates a [[SchemaDifference]] for a given [[SchemaChanges]] report.
+     * @param targetSchema
+     * @param schemaChanges   A changes report of two schemas.
+     * @returns               An [[SchemaDifference]] object.
+     * @internal
+     */
+    async function fromSchemaChanges(targetSchema, schemaChanges) {
+        const schemaDifference = {
+            sourceSchemaName: schemaChanges.schema.schemaKey.toString(),
+            targetSchemaName: targetSchema.schemaKey.toString(),
+            changes: [],
+            conflicts: [],
+        };
+        const visitor = new SchemaDiagnosticVisitor_1.SchemaDiagnosticVisitor(schemaDifference);
+        for (const diagnostic of schemaChanges.allDiagnostics) {
+            visitor.visit(diagnostic);
+        }
+        return schemaDifference;
+    }
+    SchemaDifference.fromSchemaChanges = fromSchemaChanges;
+})(SchemaDifference = exports.SchemaDifference || (exports.SchemaDifference = {}));
+//# sourceMappingURL=SchemaDifference.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaDifference.js","sourceRoot":"","sources":["../../../src/Differencing/SchemaDifference.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,iEAA8D;AAE9D,uEAAoE;AAsCpE;;GAEG;AACH,IAAiB,gBAAgB,CAsChC;AAtCD,WAAiB,gBAAgB;IAC/B;;;;;;OAMG;IACI,KAAK,UAAU,WAAW,CAAC,YAAoB,EAAE,YAAoB;QAC1E,MAAM,WAAW,GAAoB,EAAE,CAAC;QACxC,MAAM,cAAc,GAAG,IAAI,+BAAc,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC1F,MAAM,cAAc,CAAC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAEhE,OAAO,iBAAiB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IANqB,4BAAW,cAMhC,CAAA;IAED;;;;;;OAMG;IACI,KAAK,UAAU,iBAAiB,CAAC,YAAoB,EAAE,aAA4B;QACxF,MAAM,gBAAgB,GAAsB;YAC1C,gBAAgB,EAAE,aAAa,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;YAC3D,gBAAgB,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;YACnD,OAAO,EAAE,EAAE;YACX,SAAS,EAAE,EAAE;SACd,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,iDAAuB,CAAC,gBAAgB,CAAC,CAAC;QAC9D,KAAI,MAAM,UAAU,IAAI,aAAa,CAAC,cAAc,EAAE;YACpD,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;SAC3B;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAdqB,kCAAiB,oBActC,CAAA;AACH,CAAC,EAtCgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAsChC","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 { SchemaChanges } from \"../Validation/SchemaChanges\";\r\nimport { SchemaComparer } from \"../Validation/SchemaComparer\";\r\nimport { SchemaDifferenceConflict } from \"./SchemaConflicts\";\r\nimport { SchemaDiagnosticVisitor } from \"./SchemaDiagnosticVisitor\";\r\nimport type {\r\n  AnyEnumerator, AnyPropertyProps, AnySchemaItemProps, CustomAttribute, RelationshipConstraintProps, Schema,\r\n  SchemaProps, SchemaReferenceProps,\r\n} from \"@itwin/ecschema-metadata\";\r\n\r\n/**\r\n * Defines the type of the difference operation.\r\n * @internal\r\n */\r\nexport type DifferenceType = \"add\" | \"modify\";\r\n\r\n/**\r\n * Defines a set of SchemaItem names.\r\n * @internal\r\n */\r\nexport type SchemaItemTypeName =\r\n  \"EntityClass\" |\r\n  \"Mixin\" |\r\n  \"StructClass\" |\r\n  \"CustomAttributeClass\" |\r\n  \"RelationshipClass\" |\r\n  \"Enumeration\" |\r\n  \"KindOfQuantity\" |\r\n  \"PropertyCategory\" |\r\n  \"Unit\" |\r\n  \"InvertedUnit\" |\r\n  \"Constant\" |\r\n  \"Phenomenon\" |\r\n  \"UnitSystem\" |\r\n  \"Format\";\r\n\r\n/**\r\n * Defines the possible values SchemaTypes that can occur in SchemaDifferences or Conflicts.\r\n * @internal\r\n */\r\nexport type SchemaType = \"Schema\" | SchemaItemTypeName | \"Property\" | \"RelationshipConstraint\";\r\n\r\n/**\r\n * @internal\r\n */\r\nexport namespace SchemaDifference {\r\n  /**\r\n   * Creates a [[SchemaDifference]] for two given schemas.\r\n   * @param targetSchema  The schema the differences gets merged into.\r\n   * @param sourceSchema  The schema to get merged in the target.\r\n   * @returns             An [[SchemaDifference]] object.\r\n   * @internal\r\n   */\r\n  export async function fromSchemas(targetSchema: Schema, sourceSchema: Schema): Promise<SchemaDifferences> {\r\n    const changesList: SchemaChanges[] = [];\r\n    const schemaComparer = new SchemaComparer({ report: changesList.push.bind(changesList) });\r\n    await schemaComparer.compareSchemas(sourceSchema, targetSchema);\r\n\r\n    return fromSchemaChanges(targetSchema, changesList[0]);\r\n  }\r\n\r\n  /**\r\n   * Creates a [[SchemaDifference]] for a given [[SchemaChanges]] report.\r\n   * @param targetSchema\r\n   * @param schemaChanges   A changes report of two schemas.\r\n   * @returns               An [[SchemaDifference]] object.\r\n   * @internal\r\n   */\r\n  export async function fromSchemaChanges(targetSchema: Schema, schemaChanges: SchemaChanges): Promise<SchemaDifferences> {\r\n    const schemaDifference: SchemaDifferences = {\r\n      sourceSchemaName: schemaChanges.schema.schemaKey.toString(),\r\n      targetSchemaName: targetSchema.schemaKey.toString(),\r\n      changes: [],\r\n      conflicts: [],\r\n    };\r\n\r\n    const visitor = new SchemaDiagnosticVisitor(schemaDifference);\r\n    for(const diagnostic of schemaChanges.allDiagnostics) {\r\n      visitor.visit(diagnostic);\r\n    }\r\n\r\n    return schemaDifference;\r\n  }\r\n}\r\n\r\ntype MutualPartial<T> = {\r\n  -readonly [P in keyof T]?: T[P];\r\n};\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaDifferences {\r\n\r\n  readonly sourceSchemaName: string;\r\n  readonly targetSchemaName: string;\r\n\r\n  readonly changes: AnySchemaDifference[];\r\n  readonly conflicts: SchemaDifferenceConflict[];\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport type AnySchemaDifference =\r\n  SchemaDifference |\r\n  SchemaItemDifference |\r\n  SchemaPropertyDifference |\r\n  SchemaReferenceDifference |\r\n  SchemaEnumeratorDifference |\r\n  SchemaClassMixinDifference |\r\n  SchemaRelationshipConstraintDifference |\r\n  SchemaRelationshipConstraintClassDifference |\r\n  SchemaCustomAttributeDifference;\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaDifference {\r\n  changeType: \"modify\";\r\n  schemaType: \"Schema\";\r\n  itemName?: undefined;\r\n  path?: undefined;\r\n  json: MutualPartial<SchemaProps>;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaItemDifference<T extends AnySchemaItemProps = AnySchemaItemProps> {\r\n  changeType: \"add\" | \"modify\" | \"remove\";\r\n  schemaType: SchemaItemTypeName;\r\n  itemName: string;\r\n  path?: string;\r\n  json: MutualPartial<T>;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaPropertyDifference<T extends AnyPropertyProps = AnyPropertyProps> {\r\n  changeType: \"add\" | \"modify\" | \"remove\";\r\n  schemaType: \"Property\";\r\n  itemName: string;\r\n  path: string;\r\n  json: MutualPartial<T>;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaReferenceDifference {\r\n  changeType: \"add\" | \"modify\" | \"remove\";\r\n  schemaType: \"Schema\";\r\n  itemName?: undefined;\r\n  path: \"$references\";\r\n  json: MutualPartial<SchemaReferenceProps>;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaEnumeratorDifference {\r\n  changeType: \"add\" | \"modify\" | \"remove\";\r\n  schemaType: \"Enumeration\";\r\n  itemName: string;\r\n  path: string;\r\n  json: MutualPartial<AnyEnumerator>;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaClassMixinDifference {\r\n  changeType: \"modify\";\r\n  schemaType: \"EntityClass\";\r\n  itemName: string;\r\n  path: \"$mixins\";\r\n  json: string[];\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaRelationshipConstraintDifference {\r\n  changeType: \"modify\";\r\n  schemaType: \"RelationshipConstraint\";\r\n  itemName: string;\r\n  path: string;\r\n  json: MutualPartial<RelationshipConstraintProps>;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaRelationshipConstraintClassDifference {\r\n  changeType: \"modify\";\r\n  schemaType: \"RelationshipClass\";\r\n  itemName: string;\r\n  path: string;\r\n  json: string[];\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface SchemaCustomAttributeDifference {\r\n  changeType: \"add\" | \"modify\";\r\n  schemaType: \"Schema\" | \"EnitityClass\" | \"Properties\" | \"RelationshipConstraint\";\r\n  itemName?: string;\r\n  path?: string;\r\n  json: MutualPartial<CustomAttribute>;\r\n}\r\n"]}

package/lib/cjs/Editing/ECClasses.d.ts

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module Editing
  */
-import { CustomAttribute, Enumeration, EnumerationPropertyProps, PrimitiveArrayPropertyProps, PrimitivePropertyProps, PrimitiveType, SchemaItemKey, StructArrayPropertyProps, StructClass, StructPropertyProps } from "@itwin/ecschema-metadata";
+import { CustomAttribute, CustomAttributeContainerProps, Enumeration, EnumerationPropertyProps, PrimitiveArrayPropertyProps, PrimitivePropertyProps, PrimitiveType, SchemaItemKey, StructArrayPropertyProps, StructClass, StructPropertyProps } from "@itwin/ecschema-metadata";
 import { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from "./Editor";
 /**
  * @alpha
@@ -67,8 +67,15 @@ export declare class ECClasses {
      * @throws ECObjectsError if `name` does not meet the criteria for a valid EC name
      */
     setName(classKey: SchemaItemKey, name: string): Promise<SchemaItemEditResults>;
+    /**
+     * Sets the Category to the Property.
+     * @param classKey The SchemaItemKey of the class.
+     * @param propertyName The name of the property.
+     * @param categoryKey The SchemaItemKey of the PropertyCategory assigned to the property.
+     */
+    setPropertyCategory(classKey: SchemaItemKey, propertyName: string, categoryKey: SchemaItemKey): Promise<PropertyEditResults>;
     private getClass;
-    private removeCustomAttribute;
+    protected removeCustomAttribute(container: CustomAttributeContainerProps, customAttribute: CustomAttribute): void;
     private findDerivedClasses;
 }
 //# sourceMappingURL=ECClasses.d.ts.map

package/lib/cjs/Editing/ECClasses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ECClasses.d.ts","sourceRoot":"","sources":["../../../src/Editing/ECClasses.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,eAAe,EAEmC,WAAW,EAAE,wBAAwB,EAAE,2BAA2B,EACpH,sBAAsB,EAAE,aAAa,EAAE,aAAa,EAAkB,wBAAwB,EAC9F,WAAW,EAAE,mBAAmB,EACjC,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAK3F;;;GAGG;AACH,qBAAa,SAAS;IAEE,SAAS,CAAC,aAAa,EAAE,mBAAmB;IAAlE,SAAS,aAAuB,aAAa,EAAE,mBAAmB;IAElE;;;;;;OAMG;IACU,cAAc,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAsBrI;;;;;OAKG;IACU,uBAAuB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYjH,gCAAgC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAalK,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgBjH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa/J,4BAA4B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYtH,qCAAqC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa5K,8BAA8B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYtH,uCAAuC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAanK,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY5G,6BAA6B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAavJ,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYjH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAajK,cAAc,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYnF,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAc5E;;;;OAIG;IACU,kBAAkB,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAyB1H;;;;;OAKG;IACU,4BAA4B,CAAC,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA8BxJ;;;;;;;OAOG;IACU,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA0C1I;;;;;OAKG;IACU,OAAO,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;YAsB7E,QAAQ;IAuBtB,OAAO,CAAC,qBAAqB;YAMf,kBAAkB;CAejC"}
+{"version":3,"file":"ECClasses.d.ts","sourceRoot":"","sources":["../../../src/Editing/ECClasses.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,eAAe,EACf,6BAA6B,EAEqB,WAAW,EAAE,wBAAwB,EAAE,2BAA2B,EACpH,sBAAsB,EAAE,aAAa,EAAoB,aAAa,EAAkB,wBAAwB,EAChH,WAAW,EAAE,mBAAmB,EACjC,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAK3F;;;GAGG;AACH,qBAAa,SAAS;IAEE,SAAS,CAAC,aAAa,EAAE,mBAAmB;IAAlE,SAAS,aAAuB,aAAa,EAAE,mBAAmB;IAElE;;;;;;OAMG;IACU,cAAc,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAsBrI;;;;;OAKG;IACU,uBAAuB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYjH,gCAAgC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAalK,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAgBjH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa/J,4BAA4B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYtH,qCAAqC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,cAAc,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa5K,8BAA8B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYtH,uCAAuC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAanK,oBAAoB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY5G,6BAA6B,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAavJ,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYjH,kCAAkC,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAajK,cAAc,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAYnF,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAc5E;;;;OAIG;IACU,kBAAkB,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAyB1H;;;;;OAKG;IACU,4BAA4B,CAAC,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA8BxJ;;;;;;;OAOG;IACU,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA0C1I;;;;;OAKG;IACU,OAAO,CAAC,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAsB3F;;;;;OAKG;IACU,mBAAmB,CAAC,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAsB3H,QAAQ;IAuBtB,SAAS,CAAC,qBAAqB,CAAC,SAAS,EAAE,6BAA6B,EAAE,eAAe,EAAE,eAAe;YAM5F,kBAAkB;CAejC"}

package/lib/cjs/Editing/ECClasses.js

@@ -332,6 +332,31 @@ class ECClasses {
         mutableClass.setName(name);
         return {};
     }
+    /**
+     * Sets the Category to the Property.
+     * @param classKey The SchemaItemKey of the class.
+     * @param propertyName The name of the property.
+     * @param categoryKey The SchemaItemKey of the PropertyCategory assigned to the property.
+     */
+    async setPropertyCategory(classKey, propertyName, categoryKey) {
+        let mutableClass;
+        try {
+            mutableClass = await this.getClass(classKey);
+        }
+        catch (e) {
+            return { errorMessage: e.message };
+        }
+        const property = await mutableClass.getProperty(propertyName);
+        if (property === undefined) {
+            return { errorMessage: `An ECProperty with the name ${propertyName} could not be found in the class ${classKey.fullName}.` };
+        }
+        const category = await mutableClass.schema.lookupItem(categoryKey);
+        if (category === undefined) {
+            return { errorMessage: `Can't locate the Property Category ${categoryKey.fullName} in the schema ${mutableClass.schema.fullName}.` };
+        }
+        property.setCategory(new ecschema_metadata_1.DelayedPromiseWithProps(categoryKey, async () => category));
+        return { itemKey: classKey, propertyName };
+    }
     async getClass(classKey) {
         const schema = await this._schemaEditor.getSchema(classKey.schemaKey);
         if (schema === undefined)

package/lib/cjs/Editing/ECClasses.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECClasses.js","sourceRoot":"","sources":["../../../src/Editing/ECClasses.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAMkC;AAClC,sDAA6C;AAG7C,+CAA+C;AAG/C;;;GAGG;AACH,MAAa,SAAS;IAEpB,YAAgC,aAAkC;QAAlC,kBAAa,GAAb,aAAa,CAAqB;IAAI,CAAC;IAEvE;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB,EAAE,MAAc;QACpG,IAAI,YAA0B,CAAC;QAE/B,IAAI,IAAI,KAAK,iCAAa,CAAC,MAAM,IAAI,IAAI,KAAK,iCAAa,CAAC,MAAM,IAAI,IAAI,KAAK,iCAAa,CAAC,QAAQ;eAChG,IAAI,KAAK,iCAAa,CAAC,OAAO;YACjC,MAAM,IAAI,KAAK,CAAE,gFAAgF,CAAC,CAAC;QAErG,IAAI,EAAE,KAAK,MAAM;YACf,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAEnE,MAAM,YAAY,GAAG,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;QAEzC,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,uBAAuB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAC/D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB;QAC7F,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB,EAAE,cAAsC;QAC9I,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3E,MAAM,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3C,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB;QAC7F,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,iBAAiB,GAAG,YAAY,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9E,IAAI,iBAAiB,KAAK,SAAS;YACjC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,oCAAoC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEhH,MAAM,YAAY,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,kCAAkC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB,EAAE,SAAmC;QAC3I,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3E,MAAM,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,4BAA4B,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB;QAClG,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,qCAAqC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB,EAAE,cAA2C;QACxJ,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChF,MAAM,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3C,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,8BAA8B,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB;QAClG,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,uCAAuC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB,EAAE,KAAkC;QAC/I,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChF,MAAM,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB;QACxF,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,6BAA6B,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB,EAAE,WAAgC;QACnI,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxE,MAAM,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACxC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB;QAC7F,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACzD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,kCAAkC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB,EAAE,WAAqC;QAC7I,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACxC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAAuB,EAAE,IAAY;QAC/D,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,QAAuB;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAElG,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAU,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,EAAE,CAAC;QAEZ,MAAM,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,QAAuB,EAAE,eAAgC;QACvF,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,YAAY,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAEjD,MAAM,WAAW,GAAG,KAAK,CAAC,+BAA+B,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAEzF,MAAM,MAAM,GAA0B,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAC3D,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;YAC1C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;SAC5E;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,qBAAqB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC;SACf;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,4BAA4B,CAAC,QAAuB,EAAE,YAAoB,EAAE,eAAgC;QACvH,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,YAAY,CAAoB,CAAC;QACjF,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,EAAE,YAAY,EAAE,0BAA0B,YAAY,oCAAoC,QAAQ,CAAC,QAAQ,GAAG,EAAE,CAAC;SACzH;QAED,QAAQ,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAE7C,MAAM,WAAW,GAAG,KAAK,CAAC,+BAA+B,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QAErF,MAAM,MAAM,GAA0B,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAC3D,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;YAC1C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;SAC5E;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;YACtD,OAAO,MAAM,CAAC;SACf;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,eAAe,CAAC,QAAuB,EAAE,oBAA4B,EAAE,eAAuB;QACzG,MAAM,OAAO,GAAG,IAAI,0BAAM,CAAC,eAAe,CAAC,CAAC;QAE5C,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,gBAAgB,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,oBAAoB,CAAoB,CAAC;QACjG,IAAI,CAAC,gBAAgB,EAAE;YACrB,OAAO,EAAE,YAAY,EAAE,+BAA+B,oBAAoB,oCAAoC,QAAQ,CAAC,QAAQ,GAAG,EAAE,CAAC;SACtI;QAED,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,eAAe,EAAE,IAAI,CAAoB,CAAC;QAC9F,IAAI,YAAY;YACd,OAAO,EAAE,YAAY,EAAE,+BAA+B,eAAe,gCAAgC,YAAY,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC;QAEpI,yBAAyB;QACzB,MAAM,iBAAiB,GAA2B,EAAE,CAAC;QACrD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACnE,KAAK,MAAM,YAAY,IAAI,cAAc,EAAE;YACzC,IAAI,MAAM,YAAY,CAAC,WAAW,CAAC,eAAe,CAAC;gBACjD,OAAO,EAAE,YAAY,EAAE,+BAA+B,eAAe,gCAAgC,YAAY,CAAC,QAAQ,GAAG,EAAE,CAAC;YAElI,MAAM,gBAAgB,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,oBAAoB,CAAoB,CAAC;YACjG,4DAA4D;YAC5D,IAAI,gBAAgB;gBAClB,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SAC5C;QAED,yDAAyD;QACzD,iBAAiB,CAAC,OAAO,CAAC,CAAC,IAAqB,EAAE,EAAE;YAClD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAElC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,QAAuB,EAAE,IAAY;QACxD,IAAI,YAA0B,CAAC;QAE/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,OAAO,EAAE,YAAY,EAAE,cAAc,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;SACjG;QAED,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAe,IAAI,CAAC,CAAC;QACzD,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,EAAE,YAAY,EAAE,6BAA6B,IAAI,qCAAqC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QAE/G,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QACD,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3B,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,QAAuB;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAC,cAAc,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAExI,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAe,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,OAAO,KAAK,SAAS;YACvB,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,SAAS,QAAQ,CAAC,IAAI,4BAA4B,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEjJ,QAAQ,OAAO,CAAC,cAAc,EAAE;YAC9B,KAAK,kCAAc,CAAC,WAAW,CAAC;YAChC,KAAK,kCAAc,CAAC,KAAK,CAAC;YAC1B,KAAK,kCAAc,CAAC,WAAW,CAAC;YAChC,KAAK,kCAAc,CAAC,oBAAoB,CAAC;YACzC,KAAK,kCAAc,CAAC,iBAAiB;gBACnC,MAAM;YACR;gBACE,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,qBAAqB,EAAE,gCAAgC,CAAC,CAAC;SACrG;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,qBAAqB,CAAC,SAAwC,EAAE,eAAgC;QACtG,IAAA,qBAAM,EAAC,SAAS,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,SAAS,CAAC,gBAAgD,CAAC;QACvE,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,YAA0B;QACzD,MAAM,cAAc,GAAwB,EAAE,CAAC;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;QACtE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACzC,OAAO,CAAC,IAAI,EAAE;YACZ,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE;gBAChC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;oBACxC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBAC5B;aACF;YACD,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;SACxC;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;CACF;AAvZD,8BAuZC","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 Editing\r\n */\r\n\r\nimport {\r\n  CustomAttribute,\r\n  CustomAttributeContainerProps,\r\n  ECClass, ECName, ECObjectsError, ECObjectsStatus, Enumeration, EnumerationPropertyProps, PrimitiveArrayPropertyProps,\r\n  PrimitivePropertyProps, PrimitiveType, SchemaItemKey, SchemaItemType, StructArrayPropertyProps,\r\n  StructClass, StructPropertyProps,\r\n} from \"@itwin/ecschema-metadata\";\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\r\nimport { MutableClass } from \"./Mutable/MutableClass\";\r\nimport * as Rules from \"../Validation/ECRules\";\r\nimport { MutableProperty } from \"./Mutable/MutableProperty\";\r\n\r\n/**\r\n * @alpha\r\n * Acts as a base class for schema class creation. Enables property creation.\r\n */\r\nexport class ECClasses {\r\n\r\n  protected constructor(protected _schemaEditor: SchemaContextEditor) { }\r\n\r\n  /**\r\n   * Creates a property on class identified by the given SchemaItemKey. This method restricts the\r\n   * property type to primitives of type Double, String, DateTime and Integer.\r\n   * @param classKey The SchemaItemKey of the class.\r\n   * @param name The name of the new property.\r\n   * @param type The PrimitiveType assigned to the new property.\r\n   */\r\n  public async createProperty(classKey: SchemaItemKey, name: string, type: PrimitiveType, prefix: string): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n\r\n    if (type !== PrimitiveType.Double && type !== PrimitiveType.String && type !== PrimitiveType.DateTime\r\n      && type !== PrimitiveType.Integer)\r\n      throw new Error (\"Property creation is restricted to type Double, String, DateTime, and Integer.\");\r\n\r\n    if (\"\" === prefix)\r\n      throw new Error(\"The specified property name prefix is invalid\");\r\n\r\n    const prefixedName = `${prefix}_${name}`;\r\n\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createPrimitiveProperty(prefixedName, type);\r\n    return { itemKey: classKey, propertyName: prefixedName };\r\n  }\r\n\r\n  /**\r\n   * Create a primitive property on class identified by the given SchemaItemKey.\r\n   * @param classKey The SchemaItemKey of the class.\r\n   * @param name The name of the new property.\r\n   * @param type The PrimitiveType assigned to the new property.\r\n   */\r\n  public async createPrimitiveProperty(classKey: SchemaItemKey, name: string, type: PrimitiveType): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createPrimitiveProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createPrimitivePropertyFromProps(classKey: SchemaItemKey, name: string, type: PrimitiveType, primitiveProps: PrimitivePropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createPrimitiveProperty(name, type);\r\n    await newProperty.fromJSON(primitiveProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createEnumerationProperty(classKey: SchemaItemKey, name: string, type: Enumeration): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const enumSchemaItemKey = mutableClass.schema.getSchemaItemKey(type.fullName);\r\n    if (enumSchemaItemKey === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the enumeration ${type.fullName}.`);\r\n\r\n    await mutableClass.createPrimitiveProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createEnumerationPropertyFromProps(classKey: SchemaItemKey, name: string, type: Enumeration, enumProps: EnumerationPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createPrimitiveProperty(name, type);\r\n    await newProperty.fromJSON(enumProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createPrimitiveArrayProperty(classKey: SchemaItemKey, name: string, type: PrimitiveType): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createPrimitiveArrayProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createPrimitiveArrayPropertyFromProps(classKey: SchemaItemKey, name: string, type: PrimitiveType, primitiveProps: PrimitiveArrayPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createPrimitiveArrayProperty(name, type);\r\n    await newProperty.fromJSON(primitiveProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createEnumerationArrayProperty(classKey: SchemaItemKey, name: string, type: Enumeration): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createPrimitiveArrayProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createEnumerationArrayPropertyFromProps(classKey: SchemaItemKey, name: string, type: Enumeration, props: PrimitiveArrayPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createPrimitiveArrayProperty(name, type);\r\n    await newProperty.fromJSON(props);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createStructProperty(classKey: SchemaItemKey, name: string, type: StructClass): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createStructProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createStructPropertyFromProps(classKey: SchemaItemKey, name: string, type: StructClass, structProps: StructPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createStructProperty(name, type);\r\n    await newProperty.fromJSON(structProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createStructArrayProperty(classKey: SchemaItemKey, name: string, type: StructClass): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createStructArrayProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createStructArrayPropertyFromProps(classKey: SchemaItemKey, name: string, type: StructClass, structProps: StructArrayPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createStructArrayProperty(name, type);\r\n    await newProperty.fromJSON(structProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async deleteProperty(classKey: SchemaItemKey, name: string): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.deleteProperty(name);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async delete(classKey: SchemaItemKey): Promise<SchemaItemEditResults> {\r\n    const schema = await this._schemaEditor.getSchema(classKey.schemaKey);\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${classKey.schemaKey.toString(true)} not found in context` };\r\n\r\n    const ecClass = await schema.getItem<ECClass>(classKey.name);\r\n    if (ecClass === undefined)\r\n      return {};\r\n\r\n    await schema.deleteClass(ecClass.name);\r\n\r\n    return { itemKey: classKey };\r\n  }\r\n\r\n  /**\r\n   * Adds a CustomAttribute instance to the Class identified by the given SchemaItemKey\r\n   * @param classKey The SchemaItemKey identifying the schema.\r\n   * @param customAttribute The CustomAttribute instance to add.\r\n   */\r\n  public async addCustomAttribute(classKey: SchemaItemKey, customAttribute: CustomAttribute): Promise<SchemaItemEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    mutableClass.addCustomAttribute(customAttribute);\r\n\r\n    const diagnostics = Rules.validateCustomAttributeInstance(mutableClass, customAttribute);\r\n\r\n    const result: SchemaItemEditResults = { errorMessage: \"\" };\r\n    for await (const diagnostic of diagnostics) {\r\n      result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\r\n    }\r\n\r\n    if (result.errorMessage) {\r\n      this.removeCustomAttribute(mutableClass, customAttribute);\r\n      return result;\r\n    }\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Adds a CustomAttribute instance to the Property identified by the given SchemaItemKey and property name.\r\n   * @param classKey The SchemaItemKey identifying the class.\r\n   * @param propertyName The name of the property.\r\n   * @param customAttribute The CustomAttribute instance to add.\r\n   */\r\n  public async addCustomAttributeToProperty(classKey: SchemaItemKey, propertyName: string, customAttribute: CustomAttribute): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const property = await mutableClass.getProperty(propertyName) as MutableProperty;\r\n    if (!property) {\r\n      return { errorMessage: `Property with the name ${propertyName} could not be found in the class ${classKey.fullName}.` };\r\n    }\r\n\r\n    property.addCustomAttribute(customAttribute);\r\n\r\n    const diagnostics = Rules.validateCustomAttributeInstance(property, customAttribute);\r\n\r\n    const result: SchemaItemEditResults = { errorMessage: \"\" };\r\n    for await (const diagnostic of diagnostics) {\r\n      result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\r\n    }\r\n\r\n    if (result.errorMessage) {\r\n      this.removeCustomAttribute(property, customAttribute);\r\n      return result;\r\n    }\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Renames the property on the specified class. The rename will fail if the new\r\n   * name causes a conflict with a base or derived property. All derived classes\r\n   * containing a property override will be renamed, as well.\r\n   * @param classKey  The SchemaItemKey identifying the class.\r\n   * @param existingPropertyName The name of the property.\r\n   * @param newPropertyName The new property name.\r\n   */\r\n  public async setPropertyName(classKey: SchemaItemKey, existingPropertyName: string, newPropertyName: string): Promise<PropertyEditResults> {\r\n    const newName = new ECName(newPropertyName);\r\n\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const existingProperty = await mutableClass.getProperty(existingPropertyName) as MutableProperty;\r\n    if (!existingProperty) {\r\n      return { errorMessage: `An ECProperty with the name ${existingPropertyName} could not be found in the class ${classKey.fullName}.` };\r\n    }\r\n\r\n    const baseProperty = await mutableClass.getProperty(newPropertyName, true) as MutableProperty;\r\n    if (baseProperty)\r\n      return { errorMessage: `An ECProperty with the name ${newPropertyName} already exists in the class ${baseProperty.class.name}.` };\r\n\r\n    // Handle derived classes\r\n    const derivedProperties: Array<MutableProperty> = [];\r\n    const derivedClasses = await this.findDerivedClasses(mutableClass);\r\n    for (const derivedClass of derivedClasses) {\r\n      if (await derivedClass.getProperty(newPropertyName))\r\n        return { errorMessage: `An ECProperty with the name ${newPropertyName} already exists in the class ${derivedClass.fullName}.` };\r\n\r\n      const propertyOverride = await derivedClass.getProperty(existingPropertyName) as MutableProperty;\r\n      // If found the property is overridden in the derived class.\r\n      if (propertyOverride)\r\n        derivedProperties.push(propertyOverride);\r\n    }\r\n\r\n    // Re-name the overridden property in all derived classes\r\n    derivedProperties.forEach((prop: MutableProperty) => {\r\n      prop.setName(newName);\r\n    });\r\n\r\n    existingProperty.setName(newName);\r\n\r\n    return { itemKey: classKey, propertyName: newName.name };\r\n  }\r\n\r\n  /**\r\n   * Sets the name of the ECClass.\r\n   * @param classKey The SchemaItemKey of the class.\r\n   * @param name The new name of the class.\r\n   * @throws ECObjectsError if `name` does not meet the criteria for a valid EC name\r\n   */\r\n  public async setName(classKey: SchemaItemKey, name: string): Promise<SchemaItemEditResults> {\r\n    let mutableClass: MutableClass;\r\n\r\n    const schema = await this._schemaEditor.getSchema(classKey.schemaKey);\r\n    if (schema === undefined) {\r\n      return { errorMessage: `Schema Key ${classKey.schemaKey.toString(true)} not found in context` };\r\n    }\r\n\r\n    const ecClass = await schema.getItem<MutableClass>(name);\r\n    if (ecClass !== undefined)\r\n      return { errorMessage: `An EC Class with the name ${name} already exists within the schema ${schema.name}` };\r\n\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n    mutableClass.setName(name);\r\n\r\n    return {};\r\n  }\r\n\r\n  private async getClass(classKey: SchemaItemKey): Promise<MutableClass> {\r\n    const schema = await this._schemaEditor.getSchema(classKey.schemaKey);\r\n    if (schema === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema,`Schema Key ${classKey.schemaKey.toString(true)} not found in context`);\r\n\r\n    const ecClass = await schema.getItem<MutableClass>(classKey.name);\r\n    if (ecClass === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Class ${classKey.name} was not found in schema ${classKey.schemaKey.toString(true)}`);\r\n\r\n    switch (ecClass.schemaItemType) {\r\n      case SchemaItemType.EntityClass:\r\n      case SchemaItemType.Mixin:\r\n      case SchemaItemType.StructClass:\r\n      case SchemaItemType.CustomAttributeClass:\r\n      case SchemaItemType.RelationshipClass:\r\n        break;\r\n      default:\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Schema item type not supported`);\r\n    }\r\n\r\n    return ecClass;\r\n  }\r\n\r\n  private removeCustomAttribute(container: CustomAttributeContainerProps, customAttribute: CustomAttribute) {\r\n    assert(container.customAttributes !== undefined);\r\n    const map = container.customAttributes as Map<string, CustomAttribute>;\r\n    map.delete(customAttribute.className);\r\n  }\r\n\r\n  private async findDerivedClasses(mutableClass: MutableClass): Promise<Array<MutableClass>>{\r\n    const derivedClasses: Array<MutableClass> = [];\r\n    const schemaItems = this._schemaEditor.schemaContext.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (await value.is(mutableClass)) {\r\n        if (!mutableClass.key.matches(value.key)) {\r\n          derivedClasses.push(value);\r\n        }\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    return derivedClasses;\r\n  }\r\n}\r\n\r\n"]}
+{"version":3,"file":"ECClasses.js","sourceRoot":"","sources":["../../../src/Editing/ECClasses.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAOkC;AAClC,sDAA6C;AAG7C,+CAA+C;AAG/C;;;GAGG;AACH,MAAa,SAAS;IAEpB,YAAgC,aAAkC;QAAlC,kBAAa,GAAb,aAAa,CAAqB;IAAI,CAAC;IAEvE;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB,EAAE,MAAc;QACpG,IAAI,YAA0B,CAAC;QAE/B,IAAI,IAAI,KAAK,iCAAa,CAAC,MAAM,IAAI,IAAI,KAAK,iCAAa,CAAC,MAAM,IAAI,IAAI,KAAK,iCAAa,CAAC,QAAQ;eAChG,IAAI,KAAK,iCAAa,CAAC,OAAO;YACjC,MAAM,IAAI,KAAK,CAAE,gFAAgF,CAAC,CAAC;QAErG,IAAI,EAAE,KAAK,MAAM;YACf,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAEnE,MAAM,YAAY,GAAG,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;QAEzC,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,uBAAuB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAC/D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB;QAC7F,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB,EAAE,cAAsC;QAC9I,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3E,MAAM,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3C,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB;QAC7F,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,iBAAiB,GAAG,YAAY,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9E,IAAI,iBAAiB,KAAK,SAAS;YACjC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,oCAAoC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEhH,MAAM,YAAY,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,kCAAkC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB,EAAE,SAAmC;QAC3I,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3E,MAAM,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,4BAA4B,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB;QAClG,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,qCAAqC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAmB,EAAE,cAA2C;QACxJ,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChF,MAAM,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC3C,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,8BAA8B,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB;QAClG,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,uCAAuC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB,EAAE,KAAkC;QAC/I,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,4BAA4B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChF,MAAM,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB;QACxF,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,6BAA6B,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB,EAAE,WAAgC;QACnI,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxE,MAAM,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACxC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB;QAC7F,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACzD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,kCAAkC,CAAC,QAAuB,EAAE,IAAY,EAAE,IAAiB,EAAE,WAAqC;QAC7I,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACxC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAAuB,EAAE,IAAY;QAC/D,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,QAAuB;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAElG,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAU,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,EAAE,CAAC;QAEZ,MAAM,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,QAAuB,EAAE,eAAgC;QACvF,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,YAAY,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAEjD,MAAM,WAAW,GAAG,KAAK,CAAC,+BAA+B,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAEzF,MAAM,MAAM,GAA0B,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAC3D,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;YAC1C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;SAC5E;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,qBAAqB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC;SACf;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,4BAA4B,CAAC,QAAuB,EAAE,YAAoB,EAAE,eAAgC;QACvH,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,YAAY,CAAoB,CAAC;QACjF,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,EAAE,YAAY,EAAE,0BAA0B,YAAY,oCAAoC,QAAQ,CAAC,QAAQ,GAAG,EAAE,CAAC;SACzH;QAED,QAAQ,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAE7C,MAAM,WAAW,GAAG,KAAK,CAAC,+BAA+B,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QAErF,MAAM,MAAM,GAA0B,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAC3D,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;YAC1C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;SAC5E;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;YACtD,OAAO,MAAM,CAAC;SACf;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,eAAe,CAAC,QAAuB,EAAE,oBAA4B,EAAE,eAAuB;QACzG,MAAM,OAAO,GAAG,IAAI,0BAAM,CAAC,eAAe,CAAC,CAAC;QAE5C,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,gBAAgB,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,oBAAoB,CAAoB,CAAC;QACjG,IAAI,CAAC,gBAAgB,EAAE;YACrB,OAAO,EAAE,YAAY,EAAE,+BAA+B,oBAAoB,oCAAoC,QAAQ,CAAC,QAAQ,GAAG,EAAE,CAAC;SACtI;QAED,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,eAAe,EAAE,IAAI,CAAoB,CAAC;QAC9F,IAAI,YAAY;YACd,OAAO,EAAE,YAAY,EAAE,+BAA+B,eAAe,gCAAgC,YAAY,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC;QAEpI,yBAAyB;QACzB,MAAM,iBAAiB,GAA2B,EAAE,CAAC;QACrD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACnE,KAAK,MAAM,YAAY,IAAI,cAAc,EAAE;YACzC,IAAI,MAAM,YAAY,CAAC,WAAW,CAAC,eAAe,CAAC;gBACjD,OAAO,EAAE,YAAY,EAAE,+BAA+B,eAAe,gCAAgC,YAAY,CAAC,QAAQ,GAAG,EAAE,CAAC;YAElI,MAAM,gBAAgB,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,oBAAoB,CAAoB,CAAC;YACjG,4DAA4D;YAC5D,IAAI,gBAAgB;gBAClB,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SAC5C;QAED,yDAAyD;QACzD,iBAAiB,CAAC,OAAO,CAAC,CAAC,IAAqB,EAAE,EAAE;YAClD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAElC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,QAAuB,EAAE,IAAY;QACxD,IAAI,YAA0B,CAAC;QAE/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,OAAO,EAAE,YAAY,EAAE,cAAc,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;SACjG;QAED,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAe,IAAI,CAAC,CAAC;QACzD,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,EAAE,YAAY,EAAE,6BAA6B,IAAI,qCAAqC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QAE/G,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QACD,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE3B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,mBAAmB,CAAC,QAAuB,EAAE,YAAoB,EAAE,WAA0B;QACxG,IAAI,YAA0B,CAAC;QAC/B,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACpC;QAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,YAAY,CAAoB,CAAC;QACjF,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,EAAE,YAAY,EAAE,+BAA+B,YAAY,oCAAoC,QAAQ,CAAC,QAAQ,GAAG,EAAE,CAAC;SAC9H;QAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,UAAU,CAAmB,WAAW,CAAC,CAAC;QACrF,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,EAAE,YAAY,EAAE,sCAAsC,WAAW,CAAC,QAAQ,kBAAkB,YAAY,CAAC,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;SACtI;QAED,QAAQ,CAAC,WAAW,CAAC,IAAI,2CAAuB,CAAkC,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,QAAuB;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAC,cAAc,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAExI,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAe,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,OAAO,KAAK,SAAS;YACvB,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,aAAa,EAAE,SAAS,QAAQ,CAAC,IAAI,4BAA4B,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEjJ,QAAQ,OAAO,CAAC,cAAc,EAAE;YAC9B,KAAK,kCAAc,CAAC,WAAW,CAAC;YAChC,KAAK,kCAAc,CAAC,KAAK,CAAC;YAC1B,KAAK,kCAAc,CAAC,WAAW,CAAC;YAChC,KAAK,kCAAc,CAAC,oBAAoB,CAAC;YACzC,KAAK,kCAAc,CAAC,iBAAiB;gBACnC,MAAM;YACR;gBACE,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,qBAAqB,EAAE,gCAAgC,CAAC,CAAC;SACrG;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,qBAAqB,CAAC,SAAwC,EAAE,eAAgC;QACxG,IAAA,qBAAM,EAAC,SAAS,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,SAAS,CAAC,gBAAgD,CAAC;QACvE,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,YAA0B;QACzD,MAAM,cAAc,GAAwB,EAAE,CAAC;QAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;QACtE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACzC,OAAO,CAAC,IAAI,EAAE;YACZ,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE;gBAChC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;oBACxC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBAC5B;aACF;YACD,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;SACxC;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;CACF;AAnbD,8BAmbC","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 Editing\r\n */\r\n\r\nimport {\r\n  CustomAttribute,\r\n  CustomAttributeContainerProps,\r\n  DelayedPromiseWithProps,\r\n  ECClass, ECName, ECObjectsError, ECObjectsStatus, Enumeration, EnumerationPropertyProps, PrimitiveArrayPropertyProps,\r\n  PrimitivePropertyProps, PrimitiveType, PropertyCategory, SchemaItemKey, SchemaItemType, StructArrayPropertyProps,\r\n  StructClass, StructPropertyProps,\r\n} from \"@itwin/ecschema-metadata\";\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\r\nimport { MutableClass } from \"./Mutable/MutableClass\";\r\nimport * as Rules from \"../Validation/ECRules\";\r\nimport { MutableProperty } from \"./Mutable/MutableProperty\";\r\n\r\n/**\r\n * @alpha\r\n * Acts as a base class for schema class creation. Enables property creation.\r\n */\r\nexport class ECClasses {\r\n\r\n  protected constructor(protected _schemaEditor: SchemaContextEditor) { }\r\n\r\n  /**\r\n   * Creates a property on class identified by the given SchemaItemKey. This method restricts the\r\n   * property type to primitives of type Double, String, DateTime and Integer.\r\n   * @param classKey The SchemaItemKey of the class.\r\n   * @param name The name of the new property.\r\n   * @param type The PrimitiveType assigned to the new property.\r\n   */\r\n  public async createProperty(classKey: SchemaItemKey, name: string, type: PrimitiveType, prefix: string): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n\r\n    if (type !== PrimitiveType.Double && type !== PrimitiveType.String && type !== PrimitiveType.DateTime\r\n      && type !== PrimitiveType.Integer)\r\n      throw new Error (\"Property creation is restricted to type Double, String, DateTime, and Integer.\");\r\n\r\n    if (\"\" === prefix)\r\n      throw new Error(\"The specified property name prefix is invalid\");\r\n\r\n    const prefixedName = `${prefix}_${name}`;\r\n\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createPrimitiveProperty(prefixedName, type);\r\n    return { itemKey: classKey, propertyName: prefixedName };\r\n  }\r\n\r\n  /**\r\n   * Create a primitive property on class identified by the given SchemaItemKey.\r\n   * @param classKey The SchemaItemKey of the class.\r\n   * @param name The name of the new property.\r\n   * @param type The PrimitiveType assigned to the new property.\r\n   */\r\n  public async createPrimitiveProperty(classKey: SchemaItemKey, name: string, type: PrimitiveType): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createPrimitiveProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createPrimitivePropertyFromProps(classKey: SchemaItemKey, name: string, type: PrimitiveType, primitiveProps: PrimitivePropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createPrimitiveProperty(name, type);\r\n    await newProperty.fromJSON(primitiveProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createEnumerationProperty(classKey: SchemaItemKey, name: string, type: Enumeration): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const enumSchemaItemKey = mutableClass.schema.getSchemaItemKey(type.fullName);\r\n    if (enumSchemaItemKey === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate the enumeration ${type.fullName}.`);\r\n\r\n    await mutableClass.createPrimitiveProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createEnumerationPropertyFromProps(classKey: SchemaItemKey, name: string, type: Enumeration, enumProps: EnumerationPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createPrimitiveProperty(name, type);\r\n    await newProperty.fromJSON(enumProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createPrimitiveArrayProperty(classKey: SchemaItemKey, name: string, type: PrimitiveType): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createPrimitiveArrayProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createPrimitiveArrayPropertyFromProps(classKey: SchemaItemKey, name: string, type: PrimitiveType, primitiveProps: PrimitiveArrayPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createPrimitiveArrayProperty(name, type);\r\n    await newProperty.fromJSON(primitiveProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createEnumerationArrayProperty(classKey: SchemaItemKey, name: string, type: Enumeration): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createPrimitiveArrayProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createEnumerationArrayPropertyFromProps(classKey: SchemaItemKey, name: string, type: Enumeration, props: PrimitiveArrayPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createPrimitiveArrayProperty(name, type);\r\n    await newProperty.fromJSON(props);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createStructProperty(classKey: SchemaItemKey, name: string, type: StructClass): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createStructProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createStructPropertyFromProps(classKey: SchemaItemKey, name: string, type: StructClass, structProps: StructPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createStructProperty(name, type);\r\n    await newProperty.fromJSON(structProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createStructArrayProperty(classKey: SchemaItemKey, name: string, type: StructClass): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.createStructArrayProperty(name, type);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async createStructArrayPropertyFromProps(classKey: SchemaItemKey, name: string, type: StructClass, structProps: StructArrayPropertyProps): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const newProperty = await mutableClass.createStructArrayProperty(name, type);\r\n    await newProperty.fromJSON(structProps);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async deleteProperty(classKey: SchemaItemKey, name: string): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    await mutableClass.deleteProperty(name);\r\n    return { itemKey: classKey, propertyName: name };\r\n  }\r\n\r\n  public async delete(classKey: SchemaItemKey): Promise<SchemaItemEditResults> {\r\n    const schema = await this._schemaEditor.getSchema(classKey.schemaKey);\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${classKey.schemaKey.toString(true)} not found in context` };\r\n\r\n    const ecClass = await schema.getItem<ECClass>(classKey.name);\r\n    if (ecClass === undefined)\r\n      return {};\r\n\r\n    await schema.deleteClass(ecClass.name);\r\n\r\n    return { itemKey: classKey };\r\n  }\r\n\r\n  /**\r\n   * Adds a CustomAttribute instance to the Class identified by the given SchemaItemKey\r\n   * @param classKey The SchemaItemKey identifying the schema.\r\n   * @param customAttribute The CustomAttribute instance to add.\r\n   */\r\n  public async addCustomAttribute(classKey: SchemaItemKey, customAttribute: CustomAttribute): Promise<SchemaItemEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    mutableClass.addCustomAttribute(customAttribute);\r\n\r\n    const diagnostics = Rules.validateCustomAttributeInstance(mutableClass, customAttribute);\r\n\r\n    const result: SchemaItemEditResults = { errorMessage: \"\" };\r\n    for await (const diagnostic of diagnostics) {\r\n      result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\r\n    }\r\n\r\n    if (result.errorMessage) {\r\n      this.removeCustomAttribute(mutableClass, customAttribute);\r\n      return result;\r\n    }\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Adds a CustomAttribute instance to the Property identified by the given SchemaItemKey and property name.\r\n   * @param classKey The SchemaItemKey identifying the class.\r\n   * @param propertyName The name of the property.\r\n   * @param customAttribute The CustomAttribute instance to add.\r\n   */\r\n  public async addCustomAttributeToProperty(classKey: SchemaItemKey, propertyName: string, customAttribute: CustomAttribute): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const property = await mutableClass.getProperty(propertyName) as MutableProperty;\r\n    if (!property) {\r\n      return { errorMessage: `Property with the name ${propertyName} could not be found in the class ${classKey.fullName}.` };\r\n    }\r\n\r\n    property.addCustomAttribute(customAttribute);\r\n\r\n    const diagnostics = Rules.validateCustomAttributeInstance(property, customAttribute);\r\n\r\n    const result: SchemaItemEditResults = { errorMessage: \"\" };\r\n    for await (const diagnostic of diagnostics) {\r\n      result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\r\n    }\r\n\r\n    if (result.errorMessage) {\r\n      this.removeCustomAttribute(property, customAttribute);\r\n      return result;\r\n    }\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Renames the property on the specified class. The rename will fail if the new\r\n   * name causes a conflict with a base or derived property. All derived classes\r\n   * containing a property override will be renamed, as well.\r\n   * @param classKey  The SchemaItemKey identifying the class.\r\n   * @param existingPropertyName The name of the property.\r\n   * @param newPropertyName The new property name.\r\n   */\r\n  public async setPropertyName(classKey: SchemaItemKey, existingPropertyName: string, newPropertyName: string): Promise<PropertyEditResults> {\r\n    const newName = new ECName(newPropertyName);\r\n\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const existingProperty = await mutableClass.getProperty(existingPropertyName) as MutableProperty;\r\n    if (!existingProperty) {\r\n      return { errorMessage: `An ECProperty with the name ${existingPropertyName} could not be found in the class ${classKey.fullName}.` };\r\n    }\r\n\r\n    const baseProperty = await mutableClass.getProperty(newPropertyName, true) as MutableProperty;\r\n    if (baseProperty)\r\n      return { errorMessage: `An ECProperty with the name ${newPropertyName} already exists in the class ${baseProperty.class.name}.` };\r\n\r\n    // Handle derived classes\r\n    const derivedProperties: Array<MutableProperty> = [];\r\n    const derivedClasses = await this.findDerivedClasses(mutableClass);\r\n    for (const derivedClass of derivedClasses) {\r\n      if (await derivedClass.getProperty(newPropertyName))\r\n        return { errorMessage: `An ECProperty with the name ${newPropertyName} already exists in the class ${derivedClass.fullName}.` };\r\n\r\n      const propertyOverride = await derivedClass.getProperty(existingPropertyName) as MutableProperty;\r\n      // If found the property is overridden in the derived class.\r\n      if (propertyOverride)\r\n        derivedProperties.push(propertyOverride);\r\n    }\r\n\r\n    // Re-name the overridden property in all derived classes\r\n    derivedProperties.forEach((prop: MutableProperty) => {\r\n      prop.setName(newName);\r\n    });\r\n\r\n    existingProperty.setName(newName);\r\n\r\n    return { itemKey: classKey, propertyName: newName.name };\r\n  }\r\n\r\n  /**\r\n   * Sets the name of the ECClass.\r\n   * @param classKey The SchemaItemKey of the class.\r\n   * @param name The new name of the class.\r\n   * @throws ECObjectsError if `name` does not meet the criteria for a valid EC name\r\n   */\r\n  public async setName(classKey: SchemaItemKey, name: string): Promise<SchemaItemEditResults> {\r\n    let mutableClass: MutableClass;\r\n\r\n    const schema = await this._schemaEditor.getSchema(classKey.schemaKey);\r\n    if (schema === undefined) {\r\n      return { errorMessage: `Schema Key ${classKey.schemaKey.toString(true)} not found in context` };\r\n    }\r\n\r\n    const ecClass = await schema.getItem<MutableClass>(name);\r\n    if (ecClass !== undefined)\r\n      return { errorMessage: `An EC Class with the name ${name} already exists within the schema ${schema.name}` };\r\n\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n    mutableClass.setName(name);\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Sets the Category to the Property.\r\n   * @param classKey The SchemaItemKey of the class.\r\n   * @param propertyName The name of the property.\r\n   * @param categoryKey The SchemaItemKey of the PropertyCategory assigned to the property.\r\n   */\r\n  public async setPropertyCategory(classKey: SchemaItemKey, propertyName: string, categoryKey: SchemaItemKey): Promise<PropertyEditResults> {\r\n    let mutableClass: MutableClass;\r\n    try {\r\n      mutableClass = await this.getClass(classKey);\r\n    } catch (e: any) {\r\n      return { errorMessage: e.message };\r\n    }\r\n\r\n    const property = await mutableClass.getProperty(propertyName) as MutableProperty;\r\n    if (property === undefined) {\r\n      return { errorMessage: `An ECProperty with the name ${propertyName} could not be found in the class ${classKey.fullName}.` };\r\n    }\r\n\r\n    const category = await mutableClass.schema.lookupItem<PropertyCategory>(categoryKey);\r\n    if (category === undefined) {\r\n      return { errorMessage: `Can't locate the Property Category ${categoryKey.fullName} in the schema ${mutableClass.schema.fullName}.` };\r\n    }\r\n\r\n    property.setCategory(new DelayedPromiseWithProps<SchemaItemKey, PropertyCategory>(categoryKey, async () => category));\r\n    return { itemKey: classKey, propertyName };\r\n  }\r\n\r\n  private async getClass(classKey: SchemaItemKey): Promise<MutableClass> {\r\n    const schema = await this._schemaEditor.getSchema(classKey.schemaKey);\r\n    if (schema === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema,`Schema Key ${classKey.schemaKey.toString(true)} not found in context`);\r\n\r\n    const ecClass = await schema.getItem<MutableClass>(classKey.name);\r\n    if (ecClass === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Class ${classKey.name} was not found in schema ${classKey.schemaKey.toString(true)}`);\r\n\r\n    switch (ecClass.schemaItemType) {\r\n      case SchemaItemType.EntityClass:\r\n      case SchemaItemType.Mixin:\r\n      case SchemaItemType.StructClass:\r\n      case SchemaItemType.CustomAttributeClass:\r\n      case SchemaItemType.RelationshipClass:\r\n        break;\r\n      default:\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidSchemaItemType, `Schema item type not supported`);\r\n    }\r\n\r\n    return ecClass;\r\n  }\r\n\r\n  protected removeCustomAttribute(container: CustomAttributeContainerProps, customAttribute: CustomAttribute) {\r\n    assert(container.customAttributes !== undefined);\r\n    const map = container.customAttributes as Map<string, CustomAttribute>;\r\n    map.delete(customAttribute.className);\r\n  }\r\n\r\n  private async findDerivedClasses(mutableClass: MutableClass): Promise<Array<MutableClass>>{\r\n    const derivedClasses: Array<MutableClass> = [];\r\n    const schemaItems = this._schemaEditor.schemaContext.getSchemaItems();\r\n    let { value, done } = schemaItems.next();\r\n    while (!done) {\r\n      if (await value.is(mutableClass)) {\r\n        if (!mutableClass.key.matches(value.key)) {\r\n          derivedClasses.push(value);\r\n        }\r\n      }\r\n      ({ value, done } = schemaItems.next());\r\n    }\r\n\r\n    return derivedClasses;\r\n  }\r\n}\r\n\r\n"]}

package/lib/cjs/Editing/Entities.d.ts

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module Editing
  */
-import { ECClassModifier, EntityClassProps, Mixin, RelationshipClass, SchemaItemKey, SchemaKey, StrengthDirection } from "@itwin/ecschema-metadata";
+import { ECClassModifier, EntityClassProps, Mixin, NavigationPropertyProps, RelationshipClass, SchemaItemKey, SchemaKey, StrengthDirection } from "@itwin/ecschema-metadata";
 import { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from "./Editor";
 import { ECClasses } from "./ECClasses";
 /**
@@ -20,8 +20,14 @@ export declare class Entities extends ECClasses {
      * @param entityProps a json object that will be used to populate the new EntityClass. Needs a name value passed in.
      */
     createFromProps(schemaKey: SchemaKey, entityProps: EntityClassProps): Promise<SchemaItemEditResults>;
-    addMixin(entityKey: SchemaItemKey, mixinKey: SchemaItemKey): Promise<void>;
+    addMixin(entityKey: SchemaItemKey, mixinKey: SchemaItemKey): Promise<SchemaItemEditResults>;
     createNavigationProperty(entityKey: SchemaItemKey, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<PropertyEditResults>;
+    /**
+     * Creates a Navigation Property through a NavigationPropertyProps.
+     * @param classKey a SchemaItemKey of the Entity Class that will house the new property.
+     * @param navigationProps a json object that will be used to populate the new Navigation Property.
+     */
+    createNavigationPropertyFromProps(classKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<PropertyEditResults>;
     /**
      * Sets the base class of an Entity.
      * @param entityKey The SchemaItemKey of the Entity.

package/lib/cjs/Editing/Entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Entities.d.ts","sourceRoot":"","sources":["../../../src/Editing/Entities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACoB,eAAe,EAAgD,gBAAgB,EACxG,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAkB,SAAS,EAAE,iBAAiB,EACtF,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AACH,qBAAa,QAAS,SAAQ,SAAS;gBAClB,aAAa,EAAE,mBAAmB;IAIxC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAelL,yBAAyB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAe9L,wBAAwB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAe7L,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAmCzL;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAiBpG,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAc1E,wBAAwB,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa5L;;;;OAIG;IACU,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;CA0BlH"}
+{"version":3,"file":"Entities.d.ts","sourceRoot":"","sources":["../../../src/Editing/Entities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACoB,eAAe,EAAgD,gBAAgB,EACxG,KAAK,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,aAAa,EAAkB,SAAS,EAAE,iBAAiB,EAC/G,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;GAGG;AACH,qBAAa,QAAS,SAAQ,SAAS;gBAClB,aAAa,EAAE,mBAAmB;IAIxC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAelL,yBAAyB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAe9L,wBAAwB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAe7L,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAmCzL;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAiBpG,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAqB3F,wBAAwB,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa5L;;;;OAIG;IACU,iCAAiC,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,uBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAc/I;;;;OAIG;IACU,YAAY,CAAC,SAAS,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;CA0BlH"}

package/lib/cjs/Editing/Entities.js

@@ -96,16 +96,24 @@ class Entities extends ECClasses_1.ECClasses {
     }
     async addMixin(entityKey, mixinKey) {
         const entity = (await this._schemaEditor.schemaContext.getSchemaItem(entityKey));
+        if (entity === undefined) {
+            return { errorMessage: `Entity Class ${entityKey.fullName} not found in schema context.` };
+        }
+        if (entity.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass) {
+            return { errorMessage: `Expected ${entityKey.fullName} to be of type Entity Class.` };
+        }
         const mixin = (await this._schemaEditor.schemaContext.getSchemaItem(mixinKey));
-        // TODO: have a helpful returns
-        if (!entity || entity.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass)
-            return;
-        if (!mixin || mixin.schemaItemType !== ecschema_metadata_1.SchemaItemType.Mixin)
-            return;
+        if (mixin === undefined) {
+            return { errorMessage: `Mixin Class ${mixinKey.fullName} not found in schema context.` };
+        }
+        if (mixin.schemaItemType !== ecschema_metadata_1.SchemaItemType.Mixin) {
+            return { errorMessage: `Expected ${mixinKey.fullName} to be of type Mixin.` };
+        }
         entity.addMixin(mixin);
+        return { itemKey: entityKey };
     }
     async createNavigationProperty(entityKey, name, relationship, direction) {
-        const entity = (await this._schemaEditor.schemaContext.getSchemaItem(entityKey));
+        const entity = await this._schemaEditor.schemaContext.getSchemaItem(entityKey);
         if (entity === undefined)
             throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.ClassNotFound, `Entity Class ${entityKey.fullName} not found in schema context.`);
         if (entity.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass)
@@ -113,6 +121,21 @@ class Entities extends ECClasses_1.ECClasses {
         await entity.createNavigationProperty(name, relationship, direction);
         return { itemKey: entityKey, propertyName: name };
     }
+    /**
+     * Creates a Navigation Property through a NavigationPropertyProps.
+     * @param classKey a SchemaItemKey of the Entity Class that will house the new property.
+     * @param navigationProps a json object that will be used to populate the new Navigation Property.
+     */
+    async createNavigationPropertyFromProps(classKey, navigationProps) {
+        const entity = await this._schemaEditor.schemaContext.getSchemaItem(classKey);
+        if (entity === undefined)
+            return { itemKey: classKey, propertyName: navigationProps.name, errorMessage: `Entity Class ${classKey.fullName} not found in schema context.` };
+        if (entity.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass)
+            return { itemKey: classKey, propertyName: navigationProps.name, errorMessage: `Expected ${classKey.fullName} to be of type EntityClass.` };
+        const navigationProperty = await entity.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);
+        await navigationProperty.fromJSON(navigationProps);
+        return { itemKey: classKey, propertyName: navigationProps.name };
+    }
     /**
      * Sets the base class of an Entity.
      * @param entityKey The SchemaItemKey of the Entity.