@itwin/ecschema-editing 4.7.0-dev.9 → 4.8.0-dev.1

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

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module Editing
  */
-import { CustomAttribute, Schema, SchemaContext, SchemaItemKey, SchemaKey } from "@itwin/ecschema-metadata";
+import { CustomAttribute, Schema, SchemaContext, SchemaKey } from "@itwin/ecschema-metadata";
 import { MutableSchema } from "./Mutable/MutableSchema";
 import { Constants } from "./Constants";
 import { CustomAttributes } from "./CustomAttributes";
@@ -17,29 +17,6 @@ import { RelationshipClasses } from "./RelationshipClasses";
 import { Structs } from "./Structs";
 import { Units } from "./Units";
 import { UnitSystems } from "./UnitSystems";
-import { SchemaItems } from "./SchemaItems";
-/**
- * @alpha
- */
-export interface SchemaEditResults {
-    schemaKey?: SchemaKey;
-    errorMessage?: string;
-}
-/**
- * @alpha
- */
-export interface SchemaItemEditResults {
-    itemKey?: SchemaItemKey;
-    errorMessage?: string;
-}
-/**
- * @alpha
- */
-export interface PropertyEditResults {
-    itemKey?: SchemaItemKey;
-    propertyName?: string;
-    errorMessage?: string;
-}
 /**
  * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.
  * @alpha
@@ -61,7 +38,6 @@ export declare class SchemaContextEditor {
     readonly propertyCategories: PropertyCategories;
     readonly invertedUnits: InvertedUnits;
     /** @internal */
-    readonly schemaItems: SchemaItems;
     /**
      * Creates a new SchemaContextEditor instance.
      * @param schemaContext The SchemaContext the Editor will use to edit in.
@@ -82,35 +58,38 @@ export declare class SchemaContextEditor {
      * @param readVersion The read version number of the schema.
      * @param writeVersion The write version number of the schema.
      * @param minorVersion The minor version number of the schema.
-     * @returns Resolves to a SchemaEditResults object.
+     * @returns Resolves to the SchemaKey of created schema.
      */
-    createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaEditResults>;
+    createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaKey>;
     /**
      * Adds a referenced schema to the schema identified by the given SchemaKey.
      * @param schemaKey The SchemaKey identifying the schema.
      * @param refSchema The referenced schema to add.
      */
-    addSchemaReference(schemaKey: SchemaKey, refSchema: Schema): Promise<SchemaEditResults>;
+    addSchemaReference(schemaKey: SchemaKey, refSchema: Schema): Promise<void>;
     /**
      * Adds a CustomAttribute instance to the schema identified by the given SchemaKey
      * @param schemaKey The SchemaKey identifying the schema.
      * @param customAttribute The CustomAttribute instance to add.
      */
-    addCustomAttribute(schemaKey: SchemaKey, customAttribute: CustomAttribute): Promise<SchemaEditResults>;
+    addCustomAttribute(schemaKey: SchemaKey, customAttribute: CustomAttribute): Promise<void>;
     /**
      * Sets the schema version.
      * @param schemaKey The SchemaKey identifying the schema.
      * @param readVersion The read version of the schema. If not specified, the existing read version will be maintained.
      * @param writeVersion The write version of the schema. If not specified, the existing write version will be maintained.
      * @param minorVersion The minor version of the schema. If not specified, the existing minor version will be maintained.
+     * @returns Resolves to the new SchemaKey containing version updates.
      */
-    setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaEditResults>;
+    setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaKey>;
     /**
      * Increments the minor version of a schema.
      * @param schemaKey The SchemaKey identifying the schema.
+     * @returns Resolves to the new SchemaKey containing version updates.
      */
-    incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaEditResults>;
+    incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaKey>;
     private removeReference;
     private removeCustomAttribute;
+    private lookupSchema;
 }
 //# sourceMappingURL=Editor.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Editor.d.ts","sourceRoot":"","sources":["../../../src/Editing/Editor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,SAAS,EAAmB,MAAM,0BAA0B,CAAC;AAC7H,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,cAAc,CAAgB;IACtC,SAAgB,QAAQ,WAAsB;IAC9C,SAAgB,MAAM,SAAoB;IAC1C,SAAgB,OAAO,UAAqB;IAC5C,SAAgB,gBAAgB,mBAA8B;IAC9D,SAAgB,aAAa,sBAAiC;IAC9D,SAAgB,SAAS,YAAuB;IAChD,SAAgB,YAAY,eAA0B;IACtD,SAAgB,OAAO,UAAqB;IAC5C,SAAgB,gBAAgB,mBAA8B;IAC9D,SAAgB,KAAK,QAAmB;IACxC,SAAgB,WAAW,YAAuB;IAClD,SAAgB,WAAW,cAAyB;IACpD,SAAgB,kBAAkB,qBAAgC;IAClE,SAAgB,aAAa,gBAA2B;IAExD,gBAAgB;IAChB,SAAgB,WAAW,cAAyB;IAEpD;;;OAGG;gBACS,aAAa,EAAE,aAAa;IAKxC,wFAAwF;IACxF,IAAW,aAAa,IAAI,aAAa,CAAgC;IAE5D,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;IAI7C;;;MAGE;IACW,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAOhF;;;;;;;;OAQG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAMnJ;;;;OAIG;IACU,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyBpG;;;;OAIG;IACU,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBnH;;;;;;OAMG;IACU,UAAU,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAS7I;;;OAGG;IACU,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASpF,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,qBAAqB;CAK9B"}
+{"version":3,"file":"Editor.d.ts","sourceRoot":"","sources":["../../../src/Editing/Editor.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAmB,MAAM,0BAA0B,CAAC;AAC9G,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAI5C;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,cAAc,CAAgB;IACtC,SAAgB,QAAQ,WAAsB;IAC9C,SAAgB,MAAM,SAAoB;IAC1C,SAAgB,OAAO,UAAqB;IAC5C,SAAgB,gBAAgB,mBAA8B;IAC9D,SAAgB,aAAa,sBAAiC;IAC9D,SAAgB,SAAS,YAAuB;IAChD,SAAgB,YAAY,eAA0B;IACtD,SAAgB,OAAO,UAAqB;IAC5C,SAAgB,gBAAgB,mBAA8B;IAC9D,SAAgB,KAAK,QAAmB;IACxC,SAAgB,WAAW,YAAuB;IAClD,SAAgB,WAAW,cAAyB;IACpD,SAAgB,kBAAkB,qBAAgC;IAClE,SAAgB,aAAa,gBAA2B;IAExD,gBAAgB;IAGhB;;;OAGG;gBACS,aAAa,EAAE,aAAa;IAKxC,wFAAwF;IACxF,IAAW,aAAa,IAAI,aAAa,CAAgC;IAE5D,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC;IAI7C;;;MAGE;IACW,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAQhF;;;;;;;;OAQG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAM3I;;;;OAIG;IACU,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBvF;;;;OAIG;IACU,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBtG;;;;;;;OAOG;IACU,UAAU,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAWrI;;;;OAIG;IACU,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAW5E,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,qBAAqB;YAMf,YAAY;CAO3B"}

package/lib/cjs/Editing/Editor.js

@@ -25,12 +25,14 @@ const RelationshipClasses_1 = require("./RelationshipClasses");
 const Structs_1 = require("./Structs");
 const Units_1 = require("./Units");
 const UnitSystems_1 = require("./UnitSystems");
-const SchemaItems_1 = require("./SchemaItems");
+const Exception_1 = require("./Exception");
 /**
  * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.
  * @alpha
  */
 class SchemaContextEditor {
+    /** @internal */
+    // public readonly schemaItems = new SchemaItems(this);
     /**
      * Creates a new SchemaContextEditor instance.
      * @param schemaContext The SchemaContext the Editor will use to edit in.
@@ -50,8 +52,6 @@ class SchemaContextEditor {
         this.unitSystems = new UnitSystems_1.UnitSystems(this);
         this.propertyCategories = new PropertyCategories_1.PropertyCategories(this);
         this.invertedUnits = new InvertedUnits_1.InvertedUnits(this);
-        /** @internal */
-        this.schemaItems = new SchemaItems_1.SchemaItems(this);
         // TODO: Make copy
         this._schemaContext = schemaContext;
     }
@@ -65,7 +65,7 @@ class SchemaContextEditor {
      * @param schemaKey The SchemaKey identifying the schema.
     */
     async getSchema(schemaKey) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
+        const schema = await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest);
         if (schema === undefined)
             return undefined;
         return schema;
@@ -77,12 +77,12 @@ class SchemaContextEditor {
      * @param readVersion The read version number of the schema.
      * @param writeVersion The write version number of the schema.
      * @param minorVersion The minor version number of the schema.
-     * @returns Resolves to a SchemaEditResults object.
+     * @returns Resolves to the SchemaKey of created schema.
      */
     async createSchema(name, alias, readVersion, writeVersion, minorVersion) {
         const newSchema = new ecschema_metadata_1.Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);
         await this._schemaContext.addSchema(newSchema);
-        return { schemaKey: newSchema.schemaKey };
+        return newSchema.schemaKey;
     }
     /**
      * Adds a referenced schema to the schema identified by the given SchemaKey.
@@ -90,23 +90,24 @@ class SchemaContextEditor {
      * @param refSchema The referenced schema to add.
      */
     async addSchemaReference(schemaKey, refSchema) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact));
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        await schema.addReference(refSchema);
-        const diagnostics = Rules.validateSchemaReferences(schema);
-        const result = { errorMessage: "" };
-        for await (const diagnostic of diagnostics) {
-            result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
-        }
-        if (result.errorMessage) {
-            this.removeReference(schema, refSchema);
-            return result;
+        try {
+            const schema = await this.lookupSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact);
+            await schema.addReference(refSchema);
+            const diagnostics = [];
+            for await (const diagnostic of Rules.validateSchemaReferences(schema)) {
+                diagnostics.push(diagnostic);
+            }
+            if (diagnostics.length > 0) {
+                this.removeReference(schema, refSchema);
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.RuleViolation, new Exception_1.SchemaId(schemaKey), undefined, diagnostics);
+            }
+            if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {
+                await this.schemaContext.addSchema(refSchema);
+            }
         }
-        if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {
-            await this.schemaContext.addSchema(refSchema);
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.AddSchemaReference, new Exception_1.SchemaId(schemaKey), e);
         }
-        return {};
     }
     /**
      * Adds a CustomAttribute instance to the schema identified by the given SchemaKey
@@ -114,20 +115,21 @@ class SchemaContextEditor {
      * @param customAttribute The CustomAttribute instance to add.
      */
     async addCustomAttribute(schemaKey, customAttribute) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        schema.addCustomAttribute(customAttribute);
-        const diagnostics = Rules.validateCustomAttributeInstance(schema, customAttribute);
-        const result = { errorMessage: "" };
-        for await (const diagnostic of diagnostics) {
-            result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
+        try {
+            const schema = await this.lookupSchema(schemaKey);
+            schema.addCustomAttribute(customAttribute);
+            const diagnostics = [];
+            for await (const diagnostic of Rules.validateCustomAttributeInstance(schema, customAttribute)) {
+                diagnostics.push(diagnostic);
+            }
+            if (diagnostics.length > 0) {
+                this.removeCustomAttribute(schema, customAttribute);
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.RuleViolation, new Exception_1.CustomAttributeId(customAttribute.className, schema), undefined, diagnostics);
+            }
         }
-        if (result.errorMessage) {
-            this.removeCustomAttribute(schema, customAttribute);
-            return result;
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.AddCustomAttributeToClass, new Exception_1.SchemaId(schemaKey), e);
         }
-        return {};
     }
     /**
      * Sets the schema version.
@@ -135,24 +137,32 @@ class SchemaContextEditor {
      * @param readVersion The read version of the schema. If not specified, the existing read version will be maintained.
      * @param writeVersion The write version of the schema. If not specified, the existing write version will be maintained.
      * @param minorVersion The minor version of the schema. If not specified, the existing minor version will be maintained.
+     * @returns Resolves to the new SchemaKey containing version updates.
      */
     async setVersion(schemaKey, readVersion, writeVersion, minorVersion) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);
-        return {};
+        try {
+            const schema = await this.lookupSchema(schemaKey);
+            schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);
+            return schema.schemaKey;
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.SetSchemaVersion, new Exception_1.SchemaId(schemaKey), e);
+        }
     }
     /**
      * Increments the minor version of a schema.
      * @param schemaKey The SchemaKey identifying the schema.
+     * @returns Resolves to the new SchemaKey containing version updates.
      */
     async incrementMinorVersion(schemaKey) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);
-        return {};
+        try {
+            const schema = await this.lookupSchema(schemaKey);
+            schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);
+            return schema.schemaKey;
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.IncrementSchemaMinorVersion, new Exception_1.SchemaId(schemaKey), e);
+        }
     }
     removeReference(schema, refSchema) {
         const index = schema.references.indexOf(refSchema);
@@ -165,6 +175,12 @@ class SchemaContextEditor {
         const map = schema.customAttributes;
         map.delete(customAttribute.className);
     }
+    async lookupSchema(schemaKey, matchType = ecschema_metadata_1.SchemaMatchType.Latest) {
+        const schema = await this.schemaContext.getCachedSchema(schemaKey, matchType);
+        if (schema === undefined)
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.SchemaNotFound, new Exception_1.SchemaId(schemaKey));
+        return schema;
+    }
 }
 exports.SchemaContextEditor = SchemaContextEditor;
 //# sourceMappingURL=Editor.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Editor.js","sourceRoot":"","sources":["../../../src/Editing/Editor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+CAA+C;AAC/C,gEAA6H;AAE7H,sDAA6C;AAC7C,2CAAwC;AACxC,yDAAsD;AACtD,yCAAsC;AACtC,iDAA8C;AAC9C,uCAAoC;AACpC,mDAAgD;AAChD,yDAAsD;AACtD,qCAAkC;AAClC,2CAAwC;AACxC,6DAA0D;AAC1D,+DAA4D;AAC5D,uCAAoC;AACpC,mCAAgC;AAChC,+CAA4C;AAC5C,+CAA4C;AA6B5C;;;GAGG;AACH,MAAa,mBAAmB;IAoB9B;;;OAGG;IACH,YAAY,aAA4B;QAtBxB,aAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,WAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,YAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,qBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,kBAAa,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,cAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAChC,iBAAY,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;QACtC,YAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,qBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,UAAK,GAAG,IAAI,aAAK,CAAC,IAAI,CAAC,CAAC;QACxB,gBAAW,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAClC,gBAAW,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,CAAC;QACpC,uBAAkB,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,CAAC;QAClD,kBAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAExD,gBAAgB;QACA,gBAAW,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,CAAC;QAOlD,kBAAkB;QAClB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED,wFAAwF;IACxF,IAAW,aAAa,KAAoB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAElE,KAAK,CAAC,MAAM;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;MAGE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB;QACzC,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5G,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,SAAS,CAAC;QAEnB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,KAAa,EAAE,WAAmB,EAAE,YAAoB,EAAE,YAAoB;QACpH,MAAM,SAAS,GAAG,IAAI,0BAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QACxG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC/C,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,SAAoB,EAAE,SAAiB;QACrE,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3G,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,WAAW,GAAG,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAE3D,MAAM,MAAM,GAAsB,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YAC3C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;QAC7E,CAAC;QAED,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACxC,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,SAAoB,EAAE,eAAgC;QACpF,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5G,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAE3C,MAAM,WAAW,GAAG,KAAK,CAAC,+BAA+B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAEnF,MAAM,MAAM,GAAsB,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YAC3C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;QAC7E,CAAC;QAED,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;YACpD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,SAAoB,EAAE,WAAoB,EAAE,YAAqB,EAAE,YAAqB;QAC9G,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7F,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,UAAU,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,EAAE,YAAY,IAAI,MAAM,CAAC,YAAY,EAAE,YAAY,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/H,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,SAAoB;QACrD,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7F,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACpF,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,eAAe,CAAC,MAAc,EAAE,SAAiB;QACvD,MAAM,KAAK,GAAW,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAEO,qBAAqB,CAAC,MAAc,EAAE,eAAgC;QAC5E,IAAA,qBAAM,EAAC,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,MAAM,CAAC,gBAAgD,CAAC;QACpE,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;CACF;AAhKD,kDAgKC","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 * as Rules from \"../Validation/ECRules\";\r\nimport { CustomAttribute, Schema, SchemaContext, SchemaItemKey, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { MutableSchema } from \"./Mutable/MutableSchema\";\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { Constants } from \"./Constants\";\r\nimport { CustomAttributes } from \"./CustomAttributes\";\r\nimport { Entities } from \"./Entities\";\r\nimport { Enumerations } from \"./Enumerations\";\r\nimport { Formats } from \"./Formats\";\r\nimport { InvertedUnits } from \"./InvertedUnits\";\r\nimport { KindOfQuantities } from \"./KindOfQuantities\";\r\nimport { Mixins } from \"./Mixins\";\r\nimport { Phenomena } from \"./Phenomena\";\r\nimport { PropertyCategories } from \"./PropertyCategories\";\r\nimport { RelationshipClasses } from \"./RelationshipClasses\";\r\nimport { Structs } from \"./Structs\";\r\nimport { Units } from \"./Units\";\r\nimport { UnitSystems } from \"./UnitSystems\";\r\nimport { SchemaItems } from \"./SchemaItems\";\r\n\r\n// We can either add validation in Editor, or in the protected methods of Schema.\r\n// TODO: Add an error code so we can do something programmatic with the error.\r\n/**\r\n * @alpha\r\n */\r\nexport interface SchemaEditResults {\r\n  schemaKey?: SchemaKey;\r\n  errorMessage?: string;\r\n}\r\n\r\n/**\r\n * @alpha\r\n */\r\nexport interface SchemaItemEditResults {\r\n  itemKey?: SchemaItemKey;\r\n  errorMessage?: string;\r\n}\r\n\r\n/**\r\n * @alpha\r\n */\r\nexport interface PropertyEditResults {\r\n  itemKey?: SchemaItemKey;\r\n  propertyName?: string;\r\n  errorMessage?: string;\r\n}\r\n\r\n/**\r\n * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.\r\n * @alpha\r\n */\r\nexport class SchemaContextEditor {\r\n  private _schemaContext: SchemaContext;\r\n  public readonly entities = new Entities(this);\r\n  public readonly mixins = new Mixins(this);\r\n  public readonly structs = new Structs(this);\r\n  public readonly customAttributes = new CustomAttributes(this);\r\n  public readonly relationships = new RelationshipClasses(this);\r\n  public readonly constants = new Constants(this);\r\n  public readonly enumerations = new Enumerations(this);\r\n  public readonly formats = new Formats(this);\r\n  public readonly kindOfQuantities = new KindOfQuantities(this);\r\n  public readonly units = new Units(this);\r\n  public readonly phenomenons = new Phenomena(this);\r\n  public readonly unitSystems = new UnitSystems(this);\r\n  public readonly propertyCategories = new PropertyCategories(this);\r\n  public readonly invertedUnits = new InvertedUnits(this);\r\n\r\n  /** @internal */\r\n  public readonly schemaItems = new SchemaItems(this);\r\n\r\n  /**\r\n   * Creates a new SchemaContextEditor instance.\r\n   * @param schemaContext The SchemaContext the Editor will use to edit in.\r\n   */\r\n  constructor(schemaContext: SchemaContext) {\r\n    // TODO: Make copy\r\n    this._schemaContext = schemaContext;\r\n  }\r\n\r\n  /** Allows you to get schema classes and items through regular SchemaContext methods. */\r\n  public get schemaContext(): SchemaContext { return this._schemaContext; }\r\n\r\n  public async finish(): Promise<SchemaContext> {\r\n    return this._schemaContext;\r\n  }\r\n\r\n  /**\r\n   * Helper method for retrieving a schema, previously added, from the SchemaContext.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n  */\r\n  public async getSchema(schemaKey: SchemaKey): Promise<MutableSchema | undefined> {\r\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Latest));\r\n    if (schema === undefined)\r\n      return undefined;\r\n\r\n    return schema;\r\n  }\r\n  /**\r\n   * Creates a Schema with the given properties and adds it to the current schema context.\r\n   * @param name The name given to the new schema.\r\n   * @param alias The alias of the new schema.\r\n   * @param readVersion The read version number of the schema.\r\n   * @param writeVersion The write version number of the schema.\r\n   * @param minorVersion The minor version number of the schema.\r\n   * @returns Resolves to a SchemaEditResults object.\r\n   */\r\n  public async createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaEditResults> {\r\n    const newSchema = new Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);\r\n    await this._schemaContext.addSchema(newSchema);\r\n    return { schemaKey: newSchema.schemaKey };\r\n  }\r\n\r\n  /**\r\n   * Adds a referenced schema to the schema identified by the given SchemaKey.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param refSchema The referenced schema to add.\r\n   */\r\n  public async addSchemaReference(schemaKey: SchemaKey, refSchema: Schema): Promise<SchemaEditResults> {\r\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Exact));\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\r\n\r\n    await schema.addReference(refSchema);\r\n    const diagnostics = Rules.validateSchemaReferences(schema);\r\n\r\n    const result: SchemaEditResults = { 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.removeReference(schema, refSchema);\r\n      return result;\r\n    }\r\n\r\n    if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {\r\n      await this.schemaContext.addSchema(refSchema);\r\n    }\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Adds a CustomAttribute instance to the schema identified by the given SchemaKey\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param customAttribute The CustomAttribute instance to add.\r\n   */\r\n  public async addCustomAttribute(schemaKey: SchemaKey, customAttribute: CustomAttribute): Promise<SchemaEditResults> {\r\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Latest));\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\r\n\r\n    schema.addCustomAttribute(customAttribute);\r\n\r\n    const diagnostics = Rules.validateCustomAttributeInstance(schema, customAttribute);\r\n\r\n    const result: SchemaEditResults = { 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(schema, customAttribute);\r\n      return result;\r\n    }\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Sets the schema version.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param readVersion The read version of the schema. If not specified, the existing read version will be maintained.\r\n   * @param writeVersion The write version of the schema. If not specified, the existing write version will be maintained.\r\n   * @param minorVersion The minor version of the schema. If not specified, the existing minor version will be maintained.\r\n   */\r\n  public async setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaEditResults> {\r\n    const schema = (await this.schemaContext.getCachedSchema(schemaKey, SchemaMatchType.Latest));\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\r\n\r\n    schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Increments the minor version of a schema.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   */\r\n  public async incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaEditResults> {\r\n    const schema = (await this.schemaContext.getCachedSchema(schemaKey, SchemaMatchType.Latest));\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\r\n\r\n    schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);\r\n    return {};\r\n  }\r\n\r\n  private removeReference(schema: Schema, refSchema: Schema) {\r\n    const index: number = schema.references.indexOf(refSchema);\r\n    if (index !== -1) {\r\n      schema.references.splice(index, 1);\r\n    }\r\n  }\r\n\r\n  private removeCustomAttribute(schema: Schema, customAttribute: CustomAttribute) {\r\n    assert(schema.customAttributes !== undefined);\r\n    const map = schema.customAttributes as Map<string, CustomAttribute>;\r\n    map.delete(customAttribute.className);\r\n  }\r\n}\r\n\r\n"]}
+{"version":3,"file":"Editor.js","sourceRoot":"","sources":["../../../src/Editing/Editor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+CAA+C;AAC/C,gEAA8G;AAE9G,sDAA6C;AAC7C,2CAAwC;AACxC,yDAAsD;AACtD,yCAAsC;AACtC,iDAA8C;AAC9C,uCAAoC;AACpC,mDAAgD;AAChD,yDAAsD;AACtD,qCAAkC;AAClC,2CAAwC;AACxC,6DAA0D;AAC1D,+DAA4D;AAC5D,uCAAoC;AACpC,mCAAgC;AAChC,+CAA4C;AAC5C,2CAA+F;AAG/F;;;GAGG;AACH,MAAa,mBAAmB;IAiB9B,gBAAgB;IAChB,uDAAuD;IAEvD;;;OAGG;IACH,YAAY,aAA4B;QAtBxB,aAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,WAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,YAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,qBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,kBAAa,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,cAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAChC,iBAAY,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;QACtC,YAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,qBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,UAAK,GAAG,IAAI,aAAK,CAAC,IAAI,CAAC,CAAC;QACxB,gBAAW,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAClC,gBAAW,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,CAAC;QACpC,uBAAkB,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,CAAC;QAClD,kBAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAUtD,kBAAkB;QAClB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED,wFAAwF;IACxF,IAAW,aAAa,KAAoB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAElE,KAAK,CAAC,MAAM;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;MAGE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC;QAC1G,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,SAAS,CAAC;QAEnB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,KAAa,EAAE,WAAmB,EAAE,YAAoB,EAAE,YAAoB;QACpH,MAAM,SAAS,GAAG,IAAI,0BAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QACxG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC/C,OAAO,SAAS,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,SAAoB,EAAE,SAAiB;QACrE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;YACzE,MAAM,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YAErC,MAAM,WAAW,GAAoB,EAAE,CAAC;YACxC,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtE,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC/B,CAAC;YAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;gBACxC,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,aAAa,EAAE,IAAI,oBAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;YAC/G,CAAC;YAED,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;gBACnE,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,kBAAkB,EAAE,IAAI,oBAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,SAAoB,EAAE,eAAgC;QACpF,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;YAE3C,MAAM,WAAW,GAAoB,EAAE,CAAC;YACxC,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,KAAK,CAAC,+BAA+B,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,CAAC;gBAC9F,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC/B,CAAC;YAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;gBACpD,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,aAAa,EAAE,IAAI,6BAAiB,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;YAChJ,CAAC;QACH,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,yBAAyB,EAAE,IAAI,oBAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACtG,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU,CAAC,SAAoB,EAAE,WAAoB,EAAE,YAAqB,EAAE,YAAqB;QAC9G,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,UAAU,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,EAAE,YAAY,IAAI,MAAM,CAAC,YAAY,EAAE,YAAY,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;YAE/H,OAAO,MAAM,CAAC,SAAS,CAAC;QAC1B,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,gBAAgB,EAAE,IAAI,oBAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7F,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAAC,SAAoB;QACrD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YAClD,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YAEpF,OAAO,MAAM,CAAC,SAAS,CAAC;QAC1B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,2BAA2B,EAAE,IAAI,oBAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACxG,CAAC;IACH,CAAC;IAEO,eAAe,CAAC,MAAc,EAAE,SAAiB;QACvD,MAAM,KAAK,GAAW,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAEO,qBAAqB,CAAC,MAAc,EAAE,eAAgC;QAC5E,IAAA,qBAAM,EAAC,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,MAAM,CAAC,gBAAgD,CAAC;QACpE,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,SAAoB,EAAE,YAA6B,mCAAe,CAAC,MAAM;QAClG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,SAAS,CAAC,CAAC;QAC7F,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,8BAAkB,CAAC,2BAAe,CAAC,cAAc,EAAE,IAAI,oBAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAExF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA1KD,kDA0KC","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 * as Rules from \"../Validation/ECRules\";\r\nimport { CustomAttribute, Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { MutableSchema } from \"./Mutable/MutableSchema\";\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { Constants } from \"./Constants\";\r\nimport { CustomAttributes } from \"./CustomAttributes\";\r\nimport { Entities } from \"./Entities\";\r\nimport { Enumerations } from \"./Enumerations\";\r\nimport { Formats } from \"./Formats\";\r\nimport { InvertedUnits } from \"./InvertedUnits\";\r\nimport { KindOfQuantities } from \"./KindOfQuantities\";\r\nimport { Mixins } from \"./Mixins\";\r\nimport { Phenomena } from \"./Phenomena\";\r\nimport { PropertyCategories } from \"./PropertyCategories\";\r\nimport { RelationshipClasses } from \"./RelationshipClasses\";\r\nimport { Structs } from \"./Structs\";\r\nimport { Units } from \"./Units\";\r\nimport { UnitSystems } from \"./UnitSystems\";\r\nimport { CustomAttributeId, ECEditingStatus, SchemaEditingError, SchemaId } from \"./Exception\";\r\nimport { AnyDiagnostic } from \"../Validation/Diagnostic\";\r\n\r\n/**\r\n * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.\r\n * @alpha\r\n */\r\nexport class SchemaContextEditor {\r\n  private _schemaContext: SchemaContext;\r\n  public readonly entities = new Entities(this);\r\n  public readonly mixins = new Mixins(this);\r\n  public readonly structs = new Structs(this);\r\n  public readonly customAttributes = new CustomAttributes(this);\r\n  public readonly relationships = new RelationshipClasses(this);\r\n  public readonly constants = new Constants(this);\r\n  public readonly enumerations = new Enumerations(this);\r\n  public readonly formats = new Formats(this);\r\n  public readonly kindOfQuantities = new KindOfQuantities(this);\r\n  public readonly units = new Units(this);\r\n  public readonly phenomenons = new Phenomena(this);\r\n  public readonly unitSystems = new UnitSystems(this);\r\n  public readonly propertyCategories = new PropertyCategories(this);\r\n  public readonly invertedUnits = new InvertedUnits(this);\r\n\r\n  /** @internal */\r\n  // public readonly schemaItems = new SchemaItems(this);\r\n\r\n  /**\r\n   * Creates a new SchemaContextEditor instance.\r\n   * @param schemaContext The SchemaContext the Editor will use to edit in.\r\n   */\r\n  constructor(schemaContext: SchemaContext) {\r\n    // TODO: Make copy\r\n    this._schemaContext = schemaContext;\r\n  }\r\n\r\n  /** Allows you to get schema classes and items through regular SchemaContext methods. */\r\n  public get schemaContext(): SchemaContext { return this._schemaContext; }\r\n\r\n  public async finish(): Promise<SchemaContext> {\r\n    return this._schemaContext;\r\n  }\r\n\r\n  /**\r\n   * Helper method for retrieving a schema, previously added, from the SchemaContext.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n  */\r\n  public async getSchema(schemaKey: SchemaKey): Promise<MutableSchema | undefined> {\r\n    const schema = await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Latest);\r\n    if (schema === undefined)\r\n      return undefined;\r\n\r\n    return schema;\r\n  }\r\n\r\n  /**\r\n   * Creates a Schema with the given properties and adds it to the current schema context.\r\n   * @param name The name given to the new schema.\r\n   * @param alias The alias of the new schema.\r\n   * @param readVersion The read version number of the schema.\r\n   * @param writeVersion The write version number of the schema.\r\n   * @param minorVersion The minor version number of the schema.\r\n   * @returns Resolves to the SchemaKey of created schema.\r\n   */\r\n  public async createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaKey> {\r\n    const newSchema = new Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);\r\n    await this._schemaContext.addSchema(newSchema);\r\n    return newSchema.schemaKey;\r\n  }\r\n\r\n  /**\r\n   * Adds a referenced schema to the schema identified by the given SchemaKey.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param refSchema The referenced schema to add.\r\n   */\r\n  public async addSchemaReference(schemaKey: SchemaKey, refSchema: Schema): Promise<void> {\r\n    try {\r\n      const schema = await this.lookupSchema(schemaKey, SchemaMatchType.Exact);\r\n      await schema.addReference(refSchema);\r\n\r\n      const diagnostics: AnyDiagnostic[] = [];\r\n      for await (const diagnostic of Rules.validateSchemaReferences(schema)) {\r\n        diagnostics.push(diagnostic);\r\n      }\r\n\r\n      if (diagnostics.length > 0) {\r\n        this.removeReference(schema, refSchema);\r\n        throw new SchemaEditingError(ECEditingStatus.RuleViolation, new SchemaId(schemaKey), undefined, diagnostics);\r\n      }\r\n\r\n      if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {\r\n        await this.schemaContext.addSchema(refSchema);\r\n      }\r\n    } catch(e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.AddSchemaReference, new SchemaId(schemaKey), e);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adds a CustomAttribute instance to the schema identified by the given SchemaKey\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param customAttribute The CustomAttribute instance to add.\r\n   */\r\n  public async addCustomAttribute(schemaKey: SchemaKey, customAttribute: CustomAttribute): Promise<void> {\r\n    try {\r\n      const schema = await this.lookupSchema(schemaKey);\r\n      schema.addCustomAttribute(customAttribute);\r\n\r\n      const diagnostics: AnyDiagnostic[] = [];\r\n      for await (const diagnostic of Rules.validateCustomAttributeInstance(schema, customAttribute)) {\r\n        diagnostics.push(diagnostic);\r\n      }\r\n\r\n      if (diagnostics.length > 0) {\r\n        this.removeCustomAttribute(schema, customAttribute);\r\n        throw new SchemaEditingError(ECEditingStatus.RuleViolation, new CustomAttributeId(customAttribute.className, schema), undefined, diagnostics);\r\n      }\r\n    } catch(e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.AddCustomAttributeToClass, new SchemaId(schemaKey), e);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Sets the schema version.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param readVersion The read version of the schema. If not specified, the existing read version will be maintained.\r\n   * @param writeVersion The write version of the schema. If not specified, the existing write version will be maintained.\r\n   * @param minorVersion The minor version of the schema. If not specified, the existing minor version will be maintained.\r\n   * @returns Resolves to the new SchemaKey containing version updates.\r\n   */\r\n  public async setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaKey> {\r\n    try {\r\n      const schema = await this.lookupSchema(schemaKey);\r\n      schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);\r\n\r\n      return schema.schemaKey;\r\n    } catch(e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.SetSchemaVersion, new SchemaId(schemaKey), e);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Increments the minor version of a schema.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @returns Resolves to the new SchemaKey containing version updates.\r\n   */\r\n  public async incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaKey> {\r\n    try {\r\n      const schema = await this.lookupSchema(schemaKey);\r\n      schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);\r\n\r\n      return schema.schemaKey;\r\n    } catch (e: any) {\r\n      throw new SchemaEditingError(ECEditingStatus.IncrementSchemaMinorVersion, new SchemaId(schemaKey), e);\r\n    }\r\n  }\r\n\r\n  private removeReference(schema: Schema, refSchema: Schema) {\r\n    const index: number = schema.references.indexOf(refSchema);\r\n    if (index !== -1) {\r\n      schema.references.splice(index, 1);\r\n    }\r\n  }\r\n\r\n  private removeCustomAttribute(schema: Schema, customAttribute: CustomAttribute) {\r\n    assert(schema.customAttributes !== undefined);\r\n    const map = schema.customAttributes as Map<string, CustomAttribute>;\r\n    map.delete(customAttribute.className);\r\n  }\r\n\r\n  private async lookupSchema(schemaKey: SchemaKey, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<MutableSchema> {\r\n    const schema = await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, matchType);\r\n    if (schema === undefined)\r\n      throw new SchemaEditingError(ECEditingStatus.SchemaNotFound, new SchemaId(schemaKey));\r\n\r\n    return schema;\r\n  }\r\n}\r\n\r\n"]}

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

@@ -2,7 +2,7 @@
  * @module Editing
  */
 import { ECClassModifier, EntityClassProps, Mixin, NavigationPropertyProps, RelationshipClass, SchemaItemKey, SchemaKey, StrengthDirection } from "@itwin/ecschema-metadata";
-import { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from "./Editor";
+import { SchemaContextEditor } from "./Editor";
 import { ECClasses } from "./ECClasses";
 import { NavigationProperties } from "./Properties";
 /**
@@ -15,23 +15,23 @@ export declare class Entities extends ECClasses {
      * Allows access for editing of NavigationProperty attributes.
      */
     readonly navigationProperties: NavigationProperties;
-    createElement(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemEditResults>;
-    createElementUniqueAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemEditResults>;
-    createElementMultiAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemEditResults>;
-    create(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, displayLabel?: string, baseClassKey?: SchemaItemKey, mixins?: Mixin[]): Promise<SchemaItemEditResults>;
+    createElement(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey>;
+    createElementUniqueAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey>;
+    createElementMultiAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey>;
+    create(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, displayLabel?: string, baseClassKey?: SchemaItemKey, mixins?: Mixin[]): Promise<SchemaItemKey>;
     /**
      * Creates an EntityClass through an EntityClassProps.
      * @param schemaKey a SchemaKey of the Schema that will house the new object.
      * @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<SchemaItemEditResults>;
-    createNavigationProperty(entityKey: SchemaItemKey, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<PropertyEditResults>;
+    createFromProps(schemaKey: SchemaKey, entityProps: EntityClassProps): Promise<SchemaItemKey>;
+    addMixin(entityKey: SchemaItemKey, mixinKey: SchemaItemKey): Promise<void>;
+    createNavigationProperty(entityKey: SchemaItemKey, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<void>;
     /**
      * 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>;
+    createNavigationPropertyFromProps(classKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<void>;
 }
 //# sourceMappingURL=Entities.d.ts.map

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,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;AAExC,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD;;;GAGG;AACH,qBAAa,QAAS,SAAQ,SAAS;gBAClB,YAAY,EAAE,mBAAmB;IAIpD;;OAEG;IACH,SAAgB,oBAAoB,uBAAqE;IAE5F,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;CAahJ"}
+{"version":3,"file":"Entities.d.ts","sourceRoot":"","sources":["../../../src/Editing/Entities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,eAAe,EAAe,gBAAgB,EAC9C,KAAK,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,aAAa,EAAkB,SAAS,EAAE,iBAAiB,EAC/G,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAGpD;;;GAGG;AACH,qBAAa,QAAS,SAAQ,SAAS;gBAClB,YAAY,EAAE,mBAAmB;IAIpD;;OAEG;IACH,SAAgB,oBAAoB,uBAA2E;IAElG,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,aAAa,CAAC;IAa1K,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,aAAa,CAAC;IAatL,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,aAAa,CAAC;IAarL,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,aAAa,CAAC;IAgBjL;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAS5F,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAU1E,wBAAwB,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAS7K;;;;OAIG;IACU,iCAAiC,CAAC,QAAQ,EAAE,aAAa,EAAE,eAAe,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;CASjI"}

package/lib/cjs/Editing/Entities.js

@@ -11,6 +11,7 @@ exports.Entities = void 0;
 const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
 const ECClasses_1 = require("./ECClasses");
 const Properties_1 = require("./Properties");
+const Exception_1 = require("./Exception");
 /**
  * @alpha
  * A class extending ECClasses allowing you to create schema items of type EntityClass.
@@ -21,66 +22,56 @@ class Entities extends ECClasses_1.ECClasses {
         /**
          * Allows access for editing of NavigationProperty attributes.
          */
-        this.navigationProperties = new Properties_1.NavigationProperties(this.schemaItemType, this._schemaEditor);
+        this.navigationProperties = new Properties_1.NavigationProperties(ecschema_metadata_1.SchemaItemType.EntityClass, this.schemaEditor);
     }
     async createElement(schemaKey, name, modifier, baseClassKey, displayLabel, mixins) {
-        const baseClass = await this._schemaEditor.schemaContext.getSchemaItem(baseClassKey);
-        if (!baseClass)
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} could not be found.`);
-        if (baseClass?.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass)
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an EntityClass.`);
-        if (!(await baseClass.is("Element", "BisCore"))) {
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an Element.`);
+        try {
+            const baseClass = await this.getSchemaItem(baseClassKey);
+            if (!(await baseClass.is("Element", "BisCore"))) {
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.BaseClassIsNotElement, new Exception_1.ClassId(this.schemaItemType, baseClassKey));
+            }
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateElement, new Exception_1.ClassId(this.schemaItemType, name, schemaKey), e);
         }
         return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);
     }
     async createElementUniqueAspect(schemaKey, name, modifier, baseClassKey, displayLabel, mixins) {
-        const baseClass = await this._schemaEditor.schemaContext.getSchemaItem(baseClassKey);
-        if (!baseClass)
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} could not be found.`);
-        if (baseClass?.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass)
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an EntityClass.`);
-        if (!(await baseClass.is("ElementUniqueAspect", "BisCore"))) {
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an ElementUniqueAspect.`);
+        try {
+            const baseClass = await this.getSchemaItem(baseClassKey);
+            if (!(await baseClass.is("ElementUniqueAspect", "BisCore"))) {
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.BaseClassIsNotElementUniqueAspect, new Exception_1.ClassId(this.schemaItemType, baseClassKey));
+            }
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateElement, new Exception_1.ClassId(this.schemaItemType, name, schemaKey), e);
         }
         return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);
     }
     async createElementMultiAspect(schemaKey, name, modifier, baseClassKey, displayLabel, mixins) {
-        const baseClass = await this._schemaEditor.schemaContext.getSchemaItem(baseClassKey);
-        if (!baseClass)
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} could be found.`);
-        if (baseClass?.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass)
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an EntityClass.`);
-        if (!(await baseClass.is("ElementMultiAspect", "BisCore"))) {
-            throw new Error(`The class ${name} could not be created because the specified base class ${baseClassKey.fullName} is not an ElementMultiAspect.`);
+        try {
+            const baseClass = await this.getSchemaItem(baseClassKey);
+            if (!(await baseClass.is("ElementMultiAspect", "BisCore"))) {
+                throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.BaseClassIsNotElementMultiAspect, new Exception_1.ClassId(this.schemaItemType, baseClassKey));
+            }
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateElement, new Exception_1.ClassId(this.schemaItemType, name, schemaKey), e);
         }
         return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);
     }
     async create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins) {
-        const schema = await this._schemaEditor.getSchema(schemaKey);
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        const newClass = (await schema.createEntityClass(name, modifier));
-        if (newClass === undefined)
-            return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };
-        // Add a deserializing method.
-        if (baseClassKey !== undefined) {
-            const baseClassSchema = !baseClassKey.schemaKey.matches(schema.schemaKey) ? await this._schemaEditor.getSchema(baseClassKey.schemaKey) : schema;
-            if (baseClassSchema === undefined) {
-                return { errorMessage: `Schema Key ${baseClassKey.schemaKey.toString(true)} not found in context` };
-            }
-            const baseClassItem = await baseClassSchema.lookupItem(baseClassKey);
-            if (baseClassItem === undefined)
-                return { errorMessage: `Unable to locate base class ${baseClassKey.fullName} in schema ${baseClassSchema.fullName}.` };
-            if (baseClassItem.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass)
-                return { errorMessage: `${baseClassItem.fullName} is not of type Entity Class.` };
-            newClass.baseClass = new ecschema_metadata_1.DelayedPromiseWithProps(baseClassKey, async () => baseClassItem);
-        }
-        if (mixins !== undefined)
-            mixins.forEach((m) => newClass.addMixin(m));
-        if (displayLabel)
-            newClass.setDisplayLabel(displayLabel);
-        return { itemKey: newClass.key };
+        try {
+            const newClass = await this.createClass(schemaKey, this.schemaItemType, (schema) => schema.createEntityClass.bind(schema), name, baseClassKey, modifier);
+            if (mixins !== undefined)
+                mixins.forEach((m) => newClass.addMixin(m));
+            if (displayLabel)
+                newClass.setDisplayLabel(displayLabel);
+            return newClass.key;
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateSchemaItemFailed, new Exception_1.ClassId(this.schemaItemType, name, schemaKey), e);
+        }
     }
     /**
      * Creates an EntityClass through an EntityClassProps.
@@ -88,43 +79,32 @@ class Entities extends ECClasses_1.ECClasses {
      * @param entityProps a json object that will be used to populate the new EntityClass. Needs a name value passed in.
      */
     async createFromProps(schemaKey, entityProps) {
-        const schema = await this._schemaEditor.getSchema(schemaKey);
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        if (entityProps.name === undefined)
-            return { errorMessage: `No name was supplied within props.` };
-        const newClass = (await schema.createEntityClass(entityProps.name));
-        if (newClass === undefined)
-            return { errorMessage: `Failed to create class ${entityProps.name} in schema ${schemaKey.toString(true)}.` };
-        await newClass.fromJSON(entityProps);
-        return { itemKey: newClass.key };
-    }
-    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.` };
+        try {
+            const newClass = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createEntityClass.bind(schema), entityProps);
+            return newClass.key;
         }
-        if (entity.schemaItemType !== ecschema_metadata_1.SchemaItemType.EntityClass) {
-            return { errorMessage: `Expected ${entityKey.fullName} to be of type Entity Class.` };
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateSchemaItemFromProps, new Exception_1.ClassId(this.schemaItemType, entityProps.name, schemaKey), e);
         }
-        const mixin = (await this._schemaEditor.schemaContext.getSchemaItem(mixinKey));
-        if (mixin === undefined) {
-            return { errorMessage: `Mixin Class ${mixinKey.fullName} not found in schema context.` };
+    }
+    async addMixin(entityKey, mixinKey) {
+        try {
+            const entity = await this.getSchemaItem(entityKey);
+            const mixin = await this.getSchemaItem(mixinKey, ecschema_metadata_1.SchemaItemType.Mixin);
+            entity.addMixin(mixin);
         }
-        if (mixin.schemaItemType !== ecschema_metadata_1.SchemaItemType.Mixin) {
-            return { errorMessage: `Expected ${mixinKey.fullName} to be of type Mixin.` };
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.AddMixin, new Exception_1.ClassId(ecschema_metadata_1.SchemaItemType.EntityClass, entityKey), e);
         }
-        entity.addMixin(mixin);
-        return { itemKey: entityKey };
     }
     async createNavigationProperty(entityKey, name, relationship, direction) {
-        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)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaItemType, `Expected ${entityKey.fullName} to be of type Entity Class.`);
-        await entity.createNavigationProperty(name, relationship, direction);
-        return { itemKey: entityKey, propertyName: name };
+        try {
+            const entity = await this.getSchemaItem(entityKey);
+            await entity.createNavigationProperty(name, relationship, direction);
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateNavigationProperty, new Exception_1.ClassId(ecschema_metadata_1.SchemaItemType.RelationshipClass, entityKey), e);
+        }
     }
     /**
      * Creates a Navigation Property through a NavigationPropertyProps.
@@ -132,14 +112,14 @@ class Entities extends ECClasses_1.ECClasses {
      * @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 };
+        try {
+            const entity = await this.getSchemaItem(classKey);
+            const property = await entity.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);
+            await property.fromJSON(navigationProps);
+        }
+        catch (e) {
+            throw new Exception_1.SchemaEditingError(Exception_1.ECEditingStatus.CreateNavigationPropertyFromProps, new Exception_1.ClassId(ecschema_metadata_1.SchemaItemType.EntityClass, classKey), e);
+        }
     }
 }
 exports.Entities = Entities;