@itwin/ecschema-editing 5.0.0-dev.90 → 5.0.0-dev.93

package/lib/esm/Editing/RelationshipClasses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelationshipClasses.d.ts","sourceRoot":"","sources":["../../../src/Editing/RelationshipClasses.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,eAAe,EAAoC,eAAe,EAAE,WAAW,EAAyC,KAAK,EAAE,uBAAuB,EACtJ,iBAAiB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,eAAe,EAAE,wBAAwB,EAAE,aAAa,EAC3H,SAAS,EAAE,iBAAiB,EAAE,YAAY,EAC3C,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAIpD;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;IAChD,cAAuB,aAAa,IAAI,OAAO,iBAAiB,CAE/D;gBAEkB,YAAY,EAAE,mBAAmB;IAIpD;;OAEG;IACH,SAAgB,oBAAoB,uBAAoE;IAExG;;;;;;;;OAQG;IACU,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAa9L;;;;OAIG;IACU,mBAAmB,CAAC,eAAe,EAAE,aAAa,EAAE,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAS/G;;;;OAIG;IACU,mBAAmB,CAAC,eAAe,EAAE,aAAa,EAAE,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAS/G;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC;IAarH;;;;OAIG;IACmB,YAAY,CAAC,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB1F,wBAAwB,CAAC,eAAe,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IASnL;;;;OAIG;IACU,iCAAiC,CAAC,eAAe,EAAE,aAAa,EAAE,eAAe,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU1H,yBAAyB,CAAC,UAAU,EAAE,sBAAsB,EAAE,YAAY,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpH,wBAAwB,CAAC,UAAU,EAAE,sBAAsB,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjG,4BAA4B,CAAC,UAAU,EAAE,sBAAsB,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjH,qBAAqB,CAAC,UAAU,EAAE,sBAAsB,EAAE,kBAAkB,CAAC,EAAE,WAAW,GAAG,KAAK,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBtI,kBAAkB,CAAC,UAAU,EAAE,sBAAsB,EAAE,OAAO,EAAE,WAAW,GAAG,KAAK,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBvH,qBAAqB,CAAC,UAAU,EAAE,sBAAsB,EAAE,OAAO,EAAE,WAAW,GAAG,KAAK,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAY1H,8BAA8B,CAAC,UAAU,EAAE,sBAAsB,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;YAkBlH,QAAQ;CAyBvB"}

package/lib/esm/Editing/RelationshipClasses.js

@@ -0,0 +1,236 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Editing
+ */
+import { DelayedPromiseWithProps, RelationshipClass, SchemaItemType, } from "@itwin/ecschema-metadata";
+import { ECClasses } from "./ECClasses";
+import { MutableRelationshipClass } from "./Mutable/MutableRelationshipClass";
+import * as Rules from "../Validation/ECRules";
+import { NavigationProperties } from "./Properties";
+import { ClassId, CustomAttributeId, ECEditingStatus, RelationshipConstraintId, SchemaEditingError } from "./Exception";
+/**
+ * @alpha
+ * A class extending ECClasses allowing you to create schema items of type RelationshipClass.
+ */
+export class RelationshipClasses extends ECClasses {
+    get itemTypeClass() {
+        return RelationshipClass;
+    }
+    constructor(schemaEditor) {
+        super(SchemaItemType.RelationshipClass, schemaEditor);
+    }
+    /**
+     * Allows access for editing of NavigationProperty attributes.
+     */
+    navigationProperties = new NavigationProperties(this.schemaItemType, this.schemaEditor);
+    /**
+     * Creates a RelationshipClass.
+     * @param schemaKey a SchemaKey of the Schema that will house the new object.
+     * @param name The name of the new class.
+     * @param modifier The ECClassModifier of the new class.
+     * @param strength The relationship StrengthType of the class.
+     * @param StrengthDirection The relationship StrengthDirection of the class.
+     * @param baseClassKey An optional SchemaItemKey that specifies the base relationship class.
+     */
+    async create(schemaKey, name, modifier, strength, direction, baseClassKey) {
+        try {
+            const newClass = await this.createClass(schemaKey, this.schemaItemType, (schema) => schema.createRelationshipClass.bind(schema), name, baseClassKey, modifier);
+            newClass.setStrength(strength);
+            newClass.setStrengthDirection(direction);
+            return newClass.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new ClassId(this.schemaItemType, name, schemaKey), e);
+        }
+    }
+    /**
+     * Sets the source RelationshipConstraint on the relationship.
+     * @param relationshipKey The SchemaItemKey for the relationship.
+     * @param source The RelationshipConstraint to add.
+     */
+    async setSourceConstraint(relationshipKey, source) {
+        const relationship = await this.getSchemaItem(relationshipKey, MutableRelationshipClass)
+            .catch((e) => {
+            throw new SchemaEditingError(ECEditingStatus.SetSourceConstraint, new ClassId(this.schemaItemType, relationshipKey), e);
+        });
+        relationship.setSourceConstraint(source);
+    }
+    /**
+     * Sets the target RelationshipConstraint on the relationship.
+     * @param relationshipKey The SchemaItemKey for the relationship.
+     * @param target The RelationshipConstraint to add.
+     */
+    async setTargetConstraint(relationshipKey, target) {
+        const relationship = await this.getSchemaItem(relationshipKey, MutableRelationshipClass)
+            .catch((e) => {
+            throw new SchemaEditingError(ECEditingStatus.SetTargetConstraint, new ClassId(this.schemaItemType, relationshipKey), e);
+        });
+        relationship.setTargetConstraint(target);
+    }
+    /**
+     * Creates a RelationshipClass through a RelationshipClassProps.
+     * @param schemaKey a SchemaKey of the Schema that will house the new object.
+     * @param relationshipProps a json object that will be used to populate the new RelationshipClass. Needs a name value passed in.
+     */
+    async createFromProps(schemaKey, relationshipProps) {
+        try {
+            const newClass = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createRelationshipClass.bind(schema), relationshipProps);
+            await newClass.source.fromJSON(relationshipProps.source);
+            await newClass.target.fromJSON(relationshipProps.target);
+            return newClass.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new ClassId(this.schemaItemType, relationshipProps.name, schemaKey), e);
+        }
+    }
+    /**
+     * Sets the base class of a RelationshipClass.
+     * @param relationshipKey The SchemaItemKey of the RelationshipClass.
+     * @param baseClassKey The SchemaItemKey of the base class. Specifying 'undefined' removes the base class.
+     */
+    async setBaseClass(itemKey, baseClassKey) {
+        const relClass = await this.schemaEditor.schemaContext.getSchemaItem(itemKey, RelationshipClass)
+            .catch((e) => {
+            throw new SchemaEditingError(ECEditingStatus.SetBaseClass, new ClassId(this.schemaItemType, itemKey), e);
+        });
+        const baseClass = relClass?.baseClass;
+        await super.setBaseClass(itemKey, baseClassKey);
+        try {
+            await this.validate(relClass);
+        }
+        catch (e) {
+            await relClass.setBaseClass(baseClass);
+            throw new SchemaEditingError(ECEditingStatus.SetBaseClass, new ClassId(SchemaItemType.RelationshipClass, itemKey), e);
+        }
+    }
+    async createNavigationProperty(relationshipKey, name, relationship, direction) {
+        try {
+            const relationshipClass = await this.getSchemaItem(relationshipKey, MutableRelationshipClass);
+            await relationshipClass.createNavigationProperty(name, relationship, direction);
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateNavigationProperty, new ClassId(SchemaItemType.RelationshipClass, relationshipKey), e);
+        }
+    }
+    /**
+     * Creates a Navigation Property through a NavigationPropertyProps.
+     * @param classKey a SchemaItemKey of the Relationship Class that will house the new property.
+     * @param navigationProps a json object that will be used to populate the new Navigation Property.
+     */
+    async createNavigationPropertyFromProps(relationshipKey, navigationProps) {
+        try {
+            const relationshipClass = await this.getSchemaItem(relationshipKey, MutableRelationshipClass);
+            const property = await relationshipClass.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);
+            await property.fromJSON(navigationProps);
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateNavigationPropertyFromProps, new ClassId(SchemaItemType.RelationshipClass, relationshipKey), e);
+        }
+    }
+    async setConstraintMultiplicity(constraint, multiplicity) {
+        const mutableConstraint = constraint;
+        mutableConstraint.multiplicity = multiplicity;
+    }
+    async setConstraintPolymorphic(constraint, polymorphic) {
+        const mutableConstraint = constraint;
+        mutableConstraint.polymorphic = polymorphic;
+    }
+    async setConstraintRelationshipEnd(constraint, relationshipEnd) {
+        const mutableConstraint = constraint;
+        mutableConstraint.relationshipEnd = relationshipEnd;
+    }
+    async setAbstractConstraint(constraint, abstractConstraint) {
+        const existing = constraint.abstractConstraint;
+        const mutableConstraint = constraint;
+        if (undefined === abstractConstraint) {
+            mutableConstraint.abstractConstraint = undefined;
+        }
+        else {
+            mutableConstraint.abstractConstraint = new DelayedPromiseWithProps(abstractConstraint.key, async () => abstractConstraint);
+        }
+        try {
+            await this.validate(constraint.relationshipClass);
+        }
+        catch (e) {
+            mutableConstraint.abstractConstraint = existing;
+            throw new SchemaEditingError(ECEditingStatus.SetAbstractConstraint, new RelationshipConstraintId(constraint), e);
+        }
+        try {
+            await this.validate(constraint);
+        }
+        catch (e) {
+            mutableConstraint.abstractConstraint = existing;
+            throw new SchemaEditingError(ECEditingStatus.SetAbstractConstraint, new RelationshipConstraintId(constraint), e);
+        }
+    }
+    async addConstraintClass(constraint, ecClass) {
+        const mutableConstraint = constraint;
+        mutableConstraint.addClass(ecClass);
+        try {
+            await this.validate(constraint.relationshipClass);
+        }
+        catch (e) {
+            mutableConstraint.removeClass(ecClass);
+            throw new SchemaEditingError(ECEditingStatus.AddConstraintClass, new RelationshipConstraintId(constraint), e);
+        }
+        try {
+            await this.validate(constraint);
+        }
+        catch (e) {
+            mutableConstraint.removeClass(ecClass);
+            throw new SchemaEditingError(ECEditingStatus.AddConstraintClass, new RelationshipConstraintId(constraint), e);
+        }
+    }
+    async removeConstraintClass(constraint, ecClass) {
+        const mutableConstraint = constraint;
+        mutableConstraint.removeClass(ecClass);
+        try {
+            await this.validate(constraint);
+        }
+        catch (e) {
+            mutableConstraint.addClass(ecClass);
+            throw new SchemaEditingError(ECEditingStatus.RemoveConstraintClass, new RelationshipConstraintId(constraint), e);
+        }
+    }
+    async addCustomAttributeToConstraint(constraint, customAttribute) {
+        const mutableConstraint = constraint;
+        mutableConstraint.addCustomAttribute(customAttribute);
+        const diagnosticIterable = Rules.validateCustomAttributeInstance(constraint, customAttribute);
+        const diagnostics = [];
+        for await (const diagnostic of diagnosticIterable) {
+            diagnostics.push(diagnostic);
+        }
+        if (diagnostics.length > 0) {
+            this.removeCustomAttribute(constraint, customAttribute);
+            throw new SchemaEditingError(ECEditingStatus.AddCustomAttributeToConstraint, new RelationshipConstraintId(constraint), new SchemaEditingError(ECEditingStatus.RuleViolation, new CustomAttributeId(customAttribute.className, constraint), undefined, diagnostics));
+        }
+    }
+    async validate(relationshipOrConstraint) {
+        let diagnosticIterable;
+        let relationshipKey;
+        if (relationshipOrConstraint instanceof RelationshipClass) {
+            diagnosticIterable = Rules.validateRelationship(relationshipOrConstraint);
+            relationshipKey = relationshipOrConstraint.key;
+        }
+        else {
+            diagnosticIterable = Rules.validateRelationshipConstraint(relationshipOrConstraint);
+            relationshipKey = relationshipOrConstraint.relationshipClass.key;
+        }
+        const diagnostics = [];
+        for await (const diagnostic of diagnosticIterable) {
+            diagnostics.push(diagnostic);
+        }
+        if (diagnostics.length > 0) {
+            if (relationshipOrConstraint instanceof RelationshipClass) {
+                throw new SchemaEditingError(ECEditingStatus.RuleViolation, new ClassId(SchemaItemType.RelationshipClass, relationshipKey), undefined, diagnostics);
+            }
+            else {
+                throw new SchemaEditingError(ECEditingStatus.RuleViolation, new RelationshipConstraintId(relationshipOrConstraint), undefined, diagnostics);
+            }
+        }
+    }
+}
+//# sourceMappingURL=RelationshipClasses.js.map

package/lib/esm/Editing/RelationshipClasses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelationshipClasses.js","sourceRoot":"","sources":["../../../src/Editing/RelationshipClasses.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACY,uBAAuB,EACxC,iBAAiB,EAA4G,cAAc,GAE5I,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,wBAAwB,EAAiC,MAAM,oCAAoC,CAAC;AAC7G,OAAO,KAAK,KAAK,MAAM,uBAAuB,CAAC;AAE/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGxH;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,SAAS;IAChD,IAAuB,aAAa;QAClC,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,YAAmB,YAAiC;QAClD,KAAK,CAAC,cAAc,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACa,oBAAoB,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAExG;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,QAAsB,EAAE,SAA4B,EAAE,YAA4B;QACnK,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAoB,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,CAA6B,CAAC;YAE9M,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC/B,QAAQ,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEzC,OAAO,QAAQ,CAAC,GAAG,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,sBAAsB,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7H,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,eAA8B,EAAE,MAA8B;QAC7F,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,wBAAwB,CAAC;aACrF,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,mBAAmB,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1H,CAAC,CAAC,CAAC;QAEL,YAAY,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,eAA8B,EAAE,MAA8B;QAC7F,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,wBAAwB,CAAC;aACrF,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,mBAAmB,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1H,CAAC,CAAC,CAAC;QAEL,YAAY,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,iBAAyC;QAC1F,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,uBAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC,CAAC;YAElK,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;YAEzD,OAAO,QAAQ,CAAC,GAAG,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,yBAAyB,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC,IAAK,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACnJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACa,KAAK,CAAC,YAAY,CAAC,OAAsB,EAAE,YAA4B;QACrF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC;aAC7F,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,YAAY,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3G,CAAC,CAAC,CAAC;QACL,MAAM,SAAS,GAAG,QAAQ,EAAE,SAAS,CAAC;QAEtC,MAAM,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAEhD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAS,CAAC,CAAC;QACjC,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAO,QAAqC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YACrE,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,YAAY,EAAE,IAAI,OAAO,CAAC,cAAc,CAAC,iBAAiB,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACxH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,eAA8B,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;QACjK,IAAI,CAAC;YACH,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,wBAAwB,CAAC,CAAC;YAC9F,MAAM,iBAAiB,CAAC,wBAAwB,CAAC,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QAClF,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,wBAAwB,EAAE,IAAI,OAAO,CAAC,cAAc,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5I,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iCAAiC,CAAC,eAA8B,EAAE,eAAwC;QACrH,IAAI,CAAC;YACH,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,wBAAwB,CAAC,CAAC;YAC9F,MAAM,QAAQ,GAAG,MAAM,iBAAiB,CAAC,wBAAwB,CAAC,eAAe,CAAC,IAAI,EAAE,eAAe,CAAC,gBAAgB,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;YACrJ,MAAM,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,iCAAiC,EAAE,IAAI,OAAO,CAAC,cAAc,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;QACrJ,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,UAAkC,EAAE,YAAsC;QAC/G,MAAM,iBAAiB,GAAG,UAA2C,CAAC;QACtE,iBAAiB,CAAC,YAAY,GAAG,YAAY,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,UAAkC,EAAE,WAAoB;QAC5F,MAAM,iBAAiB,GAAG,UAA2C,CAAC;QACtE,iBAAiB,CAAC,WAAW,GAAG,WAAW,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,4BAA4B,CAAC,UAAkC,EAAE,eAAgC;QAC5G,MAAM,iBAAiB,GAAG,UAA2C,CAAC;QACtE,iBAAiB,CAAC,eAAe,GAAG,eAAe,CAAC;IACtD,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,UAAkC,EAAE,kBAA4D;QACjI,MAAM,QAAQ,GAAuD,UAAU,CAAC,kBAAkB,CAAC;QACnG,MAAM,iBAAiB,GAAG,UAA2C,CAAC;QAEtE,IAAI,SAAS,KAAK,kBAAkB,EAAE,CAAC;YACrC,iBAAiB,CAAC,kBAAkB,GAAG,SAAS,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,iBAAiB,CAAC,kBAAkB,GAAG,IAAI,uBAAuB,CAAC,kBAAkB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,kBAAkB,CAAC,CAAC;QAC7H,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;QACpD,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,iBAAiB,CAAC,kBAAkB,GAAG,QAAQ,CAAC;YAChD,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,qBAAqB,EAAE,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnH,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,iBAAiB,CAAC,kBAAkB,GAAG,QAAQ,CAAC;YAChD,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,qBAAqB,EAAE,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,UAAkC,EAAE,OAAgD;QAClH,MAAM,iBAAiB,GAAG,UAA2C,CAAC;QACtE,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEpC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;QACpD,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QAChH,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QAChH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,UAAkC,EAAE,OAAgD;QACrH,MAAM,iBAAiB,GAAG,UAA2C,CAAC;QACtE,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEvC,IAAG,CAAC;YACF,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,qBAAqB,EAAE,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,8BAA8B,CAAC,UAAkC,EAAE,eAAgC;QAC9G,MAAM,iBAAiB,GAAG,UAA2C,CAAC;QACtE,iBAAiB,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAEtD,MAAM,kBAAkB,GAAG,KAAK,CAAC,+BAA+B,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QAE9F,MAAM,WAAW,GAAoB,EAAE,CAAC;QACxC,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,kBAAkB,EAAE,CAAC;YAClD,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;YACxD,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,8BAA8B,EAAE,IAAI,wBAAwB,CAAC,UAAU,CAAC,EACnH,IAAI,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,iBAAiB,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;QACjJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,wBAAoE;QACzF,IAAI,kBAA0I,CAAC;QAC/I,IAAI,eAAuC,CAAC;QAE5C,IAAI,wBAAwB,YAAY,iBAAiB,EAAE,CAAC;YAC1D,kBAAkB,GAAG,KAAK,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;YAC1E,eAAe,GAAG,wBAAwB,CAAC,GAAG,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,kBAAkB,GAAG,KAAK,CAAC,8BAA8B,CAAC,wBAAwB,CAAC,CAAC;YACpF,eAAe,GAAG,wBAAwB,CAAC,iBAAiB,CAAC,GAAG,CAAC;QACnE,CAAC;QAED,MAAM,WAAW,GAAoB,EAAE,CAAC;QACxC,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,kBAAkB,EAAE,CAAC;YAClD,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC;QAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,wBAAwB,YAAY,iBAAiB,EAAE,CAAC;gBAC1D,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,OAAO,CAAC,cAAc,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;YACtJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,wBAAwB,CAAC,wBAAwB,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;YAC9I,CAAC;QACH,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Editing\n */\n\nimport {\n  CustomAttribute, DelayedPromiseWithProps, ECClass, ECClassModifier, EntityClass, LazyLoadedRelationshipConstraintClass, Mixin, NavigationPropertyProps,\n  RelationshipClass, RelationshipClassProps, RelationshipConstraint, RelationshipEnd, RelationshipMultiplicity, SchemaItemKey, SchemaItemType,\n  SchemaKey, StrengthDirection, StrengthType,\n} from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor } from \"./Editor\";\nimport { ECClasses } from \"./ECClasses\";\nimport { MutableRelationshipClass, MutableRelationshipConstraint } from \"./Mutable/MutableRelationshipClass\";\nimport * as Rules from \"../Validation/ECRules\";\nimport { AnyDiagnostic, RelationshipConstraintDiagnostic, SchemaItemDiagnostic } from \"../Validation/Diagnostic\";\nimport { NavigationProperties } from \"./Properties\";\nimport { ClassId, CustomAttributeId, ECEditingStatus, RelationshipConstraintId, SchemaEditingError } from \"./Exception\";\nimport { MutableClass } from \"./Mutable/MutableClass\";\n\n/**\n * @alpha\n * A class extending ECClasses allowing you to create schema items of type RelationshipClass.\n */\nexport class RelationshipClasses extends ECClasses {\n  protected override get itemTypeClass(): typeof RelationshipClass {\n    return RelationshipClass;\n  }\n\n  public constructor(schemaEditor: SchemaContextEditor) {\n    super(SchemaItemType.RelationshipClass, schemaEditor);\n  }\n\n  /**\n   * Allows access for editing of NavigationProperty attributes.\n   */\n  public readonly navigationProperties = new NavigationProperties(this.schemaItemType, this.schemaEditor);\n\n  /**\n   * Creates a RelationshipClass.\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\n   * @param name The name of the new class.\n   * @param modifier The ECClassModifier of the new class.\n   * @param strength The relationship StrengthType of the class.\n   * @param StrengthDirection The relationship StrengthDirection of the class.\n   * @param baseClassKey An optional SchemaItemKey that specifies the base relationship class.\n   */\n  public async create(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, strength: StrengthType, direction: StrengthDirection, baseClassKey?: SchemaItemKey): Promise<SchemaItemKey> {\n    try {\n      const newClass = await this.createClass<RelationshipClass>(schemaKey, this.schemaItemType, (schema) => schema.createRelationshipClass.bind(schema), name, baseClassKey, modifier) as MutableRelationshipClass;\n\n      newClass.setStrength(strength);\n      newClass.setStrengthDirection(direction);\n\n      return newClass.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new ClassId(this.schemaItemType, name, schemaKey), e);\n    }\n  }\n\n  /**\n   * Sets the source RelationshipConstraint on the relationship.\n   * @param relationshipKey The SchemaItemKey for the relationship.\n   * @param source The RelationshipConstraint to add.\n   */\n  public async setSourceConstraint(relationshipKey: SchemaItemKey, source: RelationshipConstraint): Promise<void> {\n    const relationship = await this.getSchemaItem(relationshipKey, MutableRelationshipClass)\n      .catch((e) => {\n        throw new SchemaEditingError(ECEditingStatus.SetSourceConstraint, new ClassId(this.schemaItemType, relationshipKey), e);\n      });\n\n    relationship.setSourceConstraint(source);\n  }\n\n  /**\n   * Sets the target RelationshipConstraint on the relationship.\n   * @param relationshipKey The SchemaItemKey for the relationship.\n   * @param target The RelationshipConstraint to add.\n   */\n  public async setTargetConstraint(relationshipKey: SchemaItemKey, target: RelationshipConstraint): Promise<void> {\n    const relationship = await this.getSchemaItem(relationshipKey, MutableRelationshipClass)\n      .catch((e) => {\n        throw new SchemaEditingError(ECEditingStatus.SetTargetConstraint, new ClassId(this.schemaItemType, relationshipKey), e);\n      });\n\n    relationship.setTargetConstraint(target);\n  }\n\n  /**\n   * Creates a RelationshipClass through a RelationshipClassProps.\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\n   * @param relationshipProps a json object that will be used to populate the new RelationshipClass. Needs a name value passed in.\n   */\n  public async createFromProps(schemaKey: SchemaKey, relationshipProps: RelationshipClassProps): Promise<SchemaItemKey> {\n    try {\n      const newClass = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createRelationshipClass.bind(schema), relationshipProps);\n\n      await newClass.source.fromJSON(relationshipProps.source);\n      await newClass.target.fromJSON(relationshipProps.target);\n\n      return newClass.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new ClassId(this.schemaItemType, relationshipProps.name!, schemaKey), e);\n    }\n  }\n\n  /**\n   * Sets the base class of a RelationshipClass.\n   * @param relationshipKey The SchemaItemKey of the RelationshipClass.\n   * @param baseClassKey The SchemaItemKey of the base class. Specifying 'undefined' removes the base class.\n   */\n  public override async setBaseClass(itemKey: SchemaItemKey, baseClassKey?: SchemaItemKey): Promise<void> {\n    const relClass = await this.schemaEditor.schemaContext.getSchemaItem(itemKey, RelationshipClass)\n      .catch((e) => {\n        throw new SchemaEditingError(ECEditingStatus.SetBaseClass, new ClassId(this.schemaItemType, itemKey), e);\n      });\n    const baseClass = relClass?.baseClass;\n\n    await super.setBaseClass(itemKey, baseClassKey);\n\n    try {\n      await this.validate(relClass!);\n    } catch(e: any) {\n      await (relClass! as ECClass as MutableClass).setBaseClass(baseClass);\n      throw new SchemaEditingError(ECEditingStatus.SetBaseClass, new ClassId(SchemaItemType.RelationshipClass, itemKey), e);\n    }\n  }\n\n  public async createNavigationProperty(relationshipKey: SchemaItemKey, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<void> {\n    try {\n      const relationshipClass = await this.getSchemaItem(relationshipKey, MutableRelationshipClass);\n      await relationshipClass.createNavigationProperty(name, relationship, direction);\n    } catch(e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateNavigationProperty, new ClassId(SchemaItemType.RelationshipClass, relationshipKey), e);\n    }\n  }\n\n  /**\n   * Creates a Navigation Property through a NavigationPropertyProps.\n   * @param classKey a SchemaItemKey of the Relationship Class that will house the new property.\n   * @param navigationProps a json object that will be used to populate the new Navigation Property.\n   */\n  public async createNavigationPropertyFromProps(relationshipKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<void> {\n    try {\n      const relationshipClass = await this.getSchemaItem(relationshipKey, MutableRelationshipClass);\n      const property = await relationshipClass.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);\n      await property.fromJSON(navigationProps);\n    } catch(e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateNavigationPropertyFromProps, new ClassId(SchemaItemType.RelationshipClass, relationshipKey), e);\n    }\n  }\n\n  public async setConstraintMultiplicity(constraint: RelationshipConstraint, multiplicity: RelationshipMultiplicity): Promise<void> {\n    const mutableConstraint = constraint as MutableRelationshipConstraint;\n    mutableConstraint.multiplicity = multiplicity;\n  }\n\n  public async setConstraintPolymorphic(constraint: RelationshipConstraint, polymorphic: boolean): Promise<void> {\n    const mutableConstraint = constraint as MutableRelationshipConstraint;\n    mutableConstraint.polymorphic = polymorphic;\n  }\n\n  public async setConstraintRelationshipEnd(constraint: RelationshipConstraint, relationshipEnd: RelationshipEnd): Promise<void> {\n    const mutableConstraint = constraint as MutableRelationshipConstraint;\n    mutableConstraint.relationshipEnd = relationshipEnd;\n  }\n\n  public async setAbstractConstraint(constraint: RelationshipConstraint, abstractConstraint?: EntityClass | Mixin | RelationshipClass): Promise<void> {\n    const existing: LazyLoadedRelationshipConstraintClass | undefined  = constraint.abstractConstraint;\n    const mutableConstraint = constraint as MutableRelationshipConstraint;\n\n    if (undefined === abstractConstraint) {\n      mutableConstraint.abstractConstraint = undefined;\n    } else {\n      mutableConstraint.abstractConstraint = new DelayedPromiseWithProps(abstractConstraint.key, async () => abstractConstraint);\n    }\n\n    try {\n      await this.validate(constraint.relationshipClass);\n    } catch(e: any){\n      mutableConstraint.abstractConstraint = existing;\n      throw new SchemaEditingError(ECEditingStatus.SetAbstractConstraint, new RelationshipConstraintId(constraint), e);\n    }\n\n    try {\n      await this.validate(constraint);\n    } catch(e: any){\n      mutableConstraint.abstractConstraint = existing;\n      throw new SchemaEditingError(ECEditingStatus.SetAbstractConstraint, new RelationshipConstraintId(constraint), e);\n    }\n  }\n\n  public async addConstraintClass(constraint: RelationshipConstraint, ecClass: EntityClass | Mixin | RelationshipClass): Promise<void> {\n    const mutableConstraint = constraint as MutableRelationshipConstraint;\n    mutableConstraint.addClass(ecClass);\n\n    try {\n      await this.validate(constraint.relationshipClass);\n    } catch(e: any){\n      mutableConstraint.removeClass(ecClass);\n      throw new SchemaEditingError(ECEditingStatus.AddConstraintClass, new RelationshipConstraintId(constraint), e);\n    }\n\n    try {\n      await this.validate(constraint);\n    } catch(e: any){\n      mutableConstraint.removeClass(ecClass);\n      throw new SchemaEditingError(ECEditingStatus.AddConstraintClass, new RelationshipConstraintId(constraint), e);\n    }\n  }\n\n  public async removeConstraintClass(constraint: RelationshipConstraint, ecClass: EntityClass | Mixin | RelationshipClass): Promise<void> {\n    const mutableConstraint = constraint as MutableRelationshipConstraint;\n    mutableConstraint.removeClass(ecClass);\n\n    try{\n      await this.validate(constraint);\n    } catch(e: any) {\n      mutableConstraint.addClass(ecClass);\n      throw new SchemaEditingError(ECEditingStatus.RemoveConstraintClass, new RelationshipConstraintId(constraint), e);\n    }\n  }\n\n  public async addCustomAttributeToConstraint(constraint: RelationshipConstraint, customAttribute: CustomAttribute): Promise<void> {\n    const mutableConstraint = constraint as MutableRelationshipConstraint;\n    mutableConstraint.addCustomAttribute(customAttribute);\n\n    const diagnosticIterable = Rules.validateCustomAttributeInstance(constraint, customAttribute);\n\n    const diagnostics: AnyDiagnostic[] = [];\n    for await (const diagnostic of diagnosticIterable) {\n      diagnostics.push(diagnostic);\n    }\n\n    if (diagnostics.length > 0) {\n      this.removeCustomAttribute(constraint, customAttribute);\n      throw new SchemaEditingError(ECEditingStatus.AddCustomAttributeToConstraint, new RelationshipConstraintId(constraint),\n        new SchemaEditingError(ECEditingStatus.RuleViolation, new CustomAttributeId(customAttribute.className, constraint), undefined, diagnostics));\n    }\n  }\n\n  private async validate(relationshipOrConstraint: RelationshipClass | RelationshipConstraint): Promise<void> {\n    let diagnosticIterable: AsyncIterable<SchemaItemDiagnostic<RelationshipClass, any[]>> | AsyncIterable<RelationshipConstraintDiagnostic<any[]>>;\n    let relationshipKey: SchemaItemKey | string;\n\n    if (relationshipOrConstraint instanceof RelationshipClass) {\n      diagnosticIterable = Rules.validateRelationship(relationshipOrConstraint);\n      relationshipKey = relationshipOrConstraint.key;\n    } else {\n      diagnosticIterable = Rules.validateRelationshipConstraint(relationshipOrConstraint);\n      relationshipKey = relationshipOrConstraint.relationshipClass.key;\n    }\n\n    const diagnostics: AnyDiagnostic[] = [];\n    for await (const diagnostic of diagnosticIterable) {\n      diagnostics.push(diagnostic);\n    }\n\n    if (diagnostics.length > 0) {\n      if (relationshipOrConstraint instanceof RelationshipClass) {\n        throw new SchemaEditingError(ECEditingStatus.RuleViolation, new ClassId(SchemaItemType.RelationshipClass, relationshipKey), undefined, diagnostics);\n      } else {\n        throw new SchemaEditingError(ECEditingStatus.RuleViolation, new RelationshipConstraintId(relationshipOrConstraint), undefined, diagnostics);\n      }\n    }\n  }\n}\n"]}

package/lib/esm/Editing/SchemaItems.d.ts

@@ -0,0 +1,42 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { SchemaItem, SchemaItemKey, SchemaItemProps, SchemaItemType, SchemaKey } from "@itwin/ecschema-metadata";
+import { SchemaContextEditor } from "./Editor";
+import { MutableSchema } from "./Mutable/MutableSchema";
+export type CreateSchemaItem<T extends SchemaItem> = (schema: MutableSchema) => (name: string, ...args: any[]) => Promise<T>;
+export type CreateSchemaItemFromProps<T extends SchemaItem> = (props: SchemaItemProps, ...args: any[]) => Promise<T>;
+/**
+ * @internal
+ * A class allowing you to edit the schema item base class.
+ */
+export declare abstract class SchemaItems {
+    protected schemaItemType: SchemaItemType;
+    protected schemaEditor: SchemaContextEditor;
+    protected abstract get itemTypeClass(): typeof SchemaItem;
+    constructor(schemaItemType: SchemaItemType, schemaEditor: SchemaContextEditor);
+    /**
+     * Sets the name of the SchemaItem.
+     * @param itemKey The SchemaItemKey of the SchemaItem.
+     * @param name The new name of the SchemaItem.
+     * @throws ECObjectsError if `name` does not meet the criteria for a valid EC name
+     */
+    setName(itemKey: SchemaItemKey, name: string): Promise<SchemaItemKey>;
+    /**
+     * Sets the SchemaItem description.
+     * @param schemaItemKey The SchemaItemKey of the SchemaItem
+     * @param description The new description to set.
+     */
+    setDescription(schemaItemKey: SchemaItemKey, description: string): Promise<void>;
+    /**
+     * Sets the SchemaItem display label.
+     * @param schemaItemKey The SchemaItemKey of the SchemaItem
+     * @param label The new label to set.
+     */
+    setDisplayLabel(schemaItemKey: SchemaItemKey, label: string): Promise<void>;
+    protected getSchema(schemaKey: SchemaKey): Promise<MutableSchema>;
+    protected getSchemaItem<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): Promise<InstanceType<T>>;
+    protected createSchemaItem<T extends SchemaItem>(schemaKey: SchemaKey, type: SchemaItemType, create: CreateSchemaItem<T>, name: string, ...args: any[]): Promise<T>;
+    protected createSchemaItemFromProps<T extends SchemaItem>(schemaKey: SchemaKey, type: SchemaItemType, create: CreateSchemaItem<T>, props: SchemaItemProps): Promise<T>;
+}
+//# sourceMappingURL=SchemaItems.d.ts.map

package/lib/esm/Editing/SchemaItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaItems.d.ts","sourceRoot":"","sources":["../../../src/Editing/SchemaItems.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAmC,UAAU,EAAE,aAAa,EAAE,eAAe,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAClJ,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAE/C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,MAAM,EAAE,aAAa,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAC7H,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAErH;;;GAGG;AACH,8BAAsB,WAAW;IAC/B,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC;IACzC,SAAS,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAE5C,SAAS,CAAC,QAAQ,KAAK,aAAa,IAAI,OAAO,UAAU,CAAC;gBAEvC,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,mBAAmB;IAKpF;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IA0BlF;;;;OAIG;IACU,cAAc,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM;IAQ7E;;;;OAIG;IACU,eAAe,CAAC,aAAa,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM;cAQxD,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC;cAQvD,aAAa,CAAC,CAAC,SAAS,OAAO,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;cAItH,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;cAczJ,yBAAyB,CAAC,CAAC,SAAS,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC;CAS7K"}

package/lib/esm/Editing/SchemaItems.js

@@ -0,0 +1,104 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Editing
+ */
+import { ECObjectsError, ECObjectsStatus } from "@itwin/ecschema-metadata";
+import { ECEditingStatus, SchemaEditingError, SchemaId, SchemaItemId } from "./Exception";
+/**
+ * @internal
+ * A class allowing you to edit the schema item base class.
+ */
+export class SchemaItems {
+    schemaItemType;
+    schemaEditor;
+    constructor(schemaItemType, schemaEditor) {
+        this.schemaItemType = schemaItemType;
+        this.schemaEditor = schemaEditor;
+    }
+    /**
+     * Sets the name of the SchemaItem.
+     * @param itemKey The SchemaItemKey of the SchemaItem.
+     * @param name The new name of the SchemaItem.
+     * @throws ECObjectsError if `name` does not meet the criteria for a valid EC name
+     */
+    async setName(itemKey, name) {
+        try {
+            const schema = await this.getSchema(itemKey.schemaKey);
+            const ecClass = await schema.getItem(name, this.itemTypeClass);
+            if (ecClass !== undefined)
+                throw new SchemaEditingError(ECEditingStatus.SchemaItemNameAlreadyExists, new SchemaItemId(this.schemaItemType, name, schema.schemaKey));
+            const mutableItem = await this.getSchemaItem(itemKey, this.itemTypeClass);
+            const existingName = itemKey.name;
+            mutableItem.setName(name);
+            // Must reset in schema item map
+            await schema.deleteSchemaItem(existingName);
+            schema.addItem(mutableItem);
+            return mutableItem.key;
+        }
+        catch (e) {
+            if (e instanceof ECObjectsError && e.errorNumber === ECObjectsStatus.InvalidECName) {
+                throw new SchemaEditingError(ECEditingStatus.SetClassName, new SchemaItemId(this.schemaItemType, itemKey), new SchemaEditingError(ECEditingStatus.InvalidECName, new SchemaItemId(this.schemaItemType, itemKey)));
+            }
+            throw new SchemaEditingError(ECEditingStatus.SetClassName, new SchemaItemId(this.schemaItemType, itemKey), e);
+        }
+    }
+    /**
+     * Sets the SchemaItem description.
+     * @param schemaItemKey The SchemaItemKey of the SchemaItem
+     * @param description The new description to set.
+     */
+    async setDescription(schemaItemKey, description) {
+        const item = await this.getSchemaItem(schemaItemKey, this.itemTypeClass)
+            .catch((e) => {
+            throw new SchemaEditingError(ECEditingStatus.SetDescription, new SchemaItemId(this.schemaItemType, schemaItemKey), e);
+        });
+        item.setDescription(description);
+    }
+    /**
+     * Sets the SchemaItem display label.
+     * @param schemaItemKey The SchemaItemKey of the SchemaItem
+     * @param label The new label to set.
+     */
+    async setDisplayLabel(schemaItemKey, label) {
+        const item = await this.getSchemaItem(schemaItemKey, this.itemTypeClass)
+            .catch((e) => {
+            throw new SchemaEditingError(ECEditingStatus.SetLabel, new SchemaItemId(this.schemaItemType, schemaItemKey), e);
+        });
+        item.setDisplayLabel(label);
+    }
+    async getSchema(schemaKey) {
+        const schema = await this.schemaEditor.getSchema(schemaKey);
+        if (schema === undefined)
+            throw new SchemaEditingError(ECEditingStatus.SchemaNotFound, new SchemaId(schemaKey));
+        return schema;
+    }
+    async getSchemaItem(schemaItemKey, itemConstructor) {
+        return this.schemaEditor.getSchemaItem(schemaItemKey, itemConstructor);
+    }
+    async createSchemaItem(schemaKey, type, create, name, ...args) {
+        const schema = await this.getSchema(schemaKey);
+        try {
+            const boundCreate = create(schema);
+            return await boundCreate(name, ...args);
+        }
+        catch (e) {
+            if (e instanceof ECObjectsError && e.errorNumber === ECObjectsStatus.DuplicateItem) {
+                throw new SchemaEditingError(ECEditingStatus.SchemaItemNameAlreadyExists, new SchemaItemId(type, name, schema.schemaKey));
+            }
+            else {
+                throw new Error(`Failed to create class ${name} in schema ${schema.fullName}.`);
+            }
+        }
+    }
+    async createSchemaItemFromProps(schemaKey, type, create, props) {
+        if (props.name === undefined)
+            throw new SchemaEditingError(ECEditingStatus.SchemaItemNameNotSpecified, new SchemaItemId(type, "", schemaKey));
+        const newItem = await this.createSchemaItem(schemaKey, type, create, props.name);
+        await newItem.fromJSON(props);
+        return newItem;
+    }
+}
+//# sourceMappingURL=SchemaItems.js.map

package/lib/esm/Editing/SchemaItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaItems.js","sourceRoot":"","sources":["../../../src/Editing/SchemaItems.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAyE,MAAM,0BAA0B,CAAC;AAElJ,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAO1F;;;GAGG;AACH,MAAM,OAAgB,WAAW;IACrB,cAAc,CAAiB;IAC/B,YAAY,CAAsB;IAI5C,YAAmB,cAA8B,EAAE,YAAiC;QAClF,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,OAAsB,EAAE,IAAY;QACvD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACvD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAC/D,IAAI,OAAO,KAAK,SAAS;gBACvB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,2BAA2B,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YAE3I,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAsB,CAAC;YAE/F,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;YAClC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAE1B,gCAAgC;YAChC,MAAM,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;YAC5C,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAC5B,OAAO,WAAW,CAAC,GAAG,CAAC;QACzB,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,IAAI,CAAC,YAAY,cAAc,IAAI,CAAC,CAAC,WAAW,KAAK,eAAe,CAAC,aAAa,EAAE,CAAC;gBACnF,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,YAAY,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,EACvG,IAAI,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;YAC3G,CAAC;YAED,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,YAAY,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QAChH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,aAA4B,EAAE,WAAmB;QAC3E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;aACrE,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;QACxH,CAAC,CAAC,CAAC;QACJ,IAA0B,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,aAA4B,EAAE,KAAa;QACtE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;aACrE,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;QAClH,CAAC,CAAC,CAAC;QACJ,IAA0B,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,SAAoB;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC5D,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAExF,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,KAAK,CAAC,aAAa,CAA8B,aAA4B,EAAE,eAAkB;QACzG,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;IAES,KAAK,CAAC,gBAAgB,CAAuB,SAAoB,EAAE,IAAoB,EAAE,MAA2B,EAAE,IAAY,EAAE,GAAG,IAAW;QAC1J,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,OAAO,MAAM,WAAW,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,cAAc,IAAI,CAAC,CAAC,WAAW,KAAK,eAAe,CAAC,aAAa,EAAE,CAAC;gBACnF,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,2BAA2B,EAAE,IAAI,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5H,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,cAAc,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC;YAClF,CAAC;QACH,CAAC;IACH,CAAC;IAES,KAAK,CAAC,yBAAyB,CAAuB,SAAoB,EAAE,IAAoB,EAAE,MAA2B,EAAE,KAAsB;QAC7J,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAC1B,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,0BAA0B,EAAE,IAAI,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QAElH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAI,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACpF,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE9B,OAAO,OAAO,CAAC;IACjB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Editing\n */\n\nimport { ECObjectsError, ECObjectsStatus, SchemaItem, SchemaItemKey, SchemaItemProps, SchemaItemType, SchemaKey } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor } from \"./Editor\";\nimport { ECEditingStatus, SchemaEditingError, SchemaId, SchemaItemId } from \"./Exception\";\nimport { MutableSchema } from \"./Mutable/MutableSchema\";\nimport { MutableSchemaItem } from \"./Mutable/MutableSchemaItem\";\n\nexport type CreateSchemaItem<T extends SchemaItem> = (schema: MutableSchema) => (name: string, ...args: any[]) => Promise<T>;\nexport type CreateSchemaItemFromProps<T extends SchemaItem> = (props: SchemaItemProps, ...args: any[]) => Promise<T>;\n\n/**\n * @internal\n * A class allowing you to edit the schema item base class.\n */\nexport abstract class SchemaItems {\n  protected schemaItemType: SchemaItemType;\n  protected schemaEditor: SchemaContextEditor;\n\n  protected abstract get itemTypeClass(): typeof SchemaItem;\n\n  public constructor(schemaItemType: SchemaItemType, schemaEditor: SchemaContextEditor) {\n    this.schemaItemType = schemaItemType;\n    this.schemaEditor = schemaEditor;\n  }\n\n  /**\n   * Sets the name of the SchemaItem.\n   * @param itemKey The SchemaItemKey of the SchemaItem.\n   * @param name The new name of the SchemaItem.\n   * @throws ECObjectsError if `name` does not meet the criteria for a valid EC name\n   */\n  public async setName(itemKey: SchemaItemKey, name: string): Promise<SchemaItemKey> {\n    try {\n      const schema = await this.getSchema(itemKey.schemaKey);\n      const ecClass = await schema.getItem(name, this.itemTypeClass);\n      if (ecClass !== undefined)\n        throw new SchemaEditingError(ECEditingStatus.SchemaItemNameAlreadyExists, new SchemaItemId(this.schemaItemType, name, schema.schemaKey));\n\n      const mutableItem = await this.getSchemaItem(itemKey, this.itemTypeClass) as MutableSchemaItem;\n\n      const existingName = itemKey.name;\n      mutableItem.setName(name);\n\n      // Must reset in schema item map\n      await schema.deleteSchemaItem(existingName);\n      schema.addItem(mutableItem);\n      return mutableItem.key;\n    } catch(e: any) {\n      if (e instanceof ECObjectsError && e.errorNumber === ECObjectsStatus.InvalidECName) {\n        throw new SchemaEditingError(ECEditingStatus.SetClassName, new SchemaItemId(this.schemaItemType, itemKey),\n          new SchemaEditingError(ECEditingStatus.InvalidECName, new SchemaItemId(this.schemaItemType, itemKey)));\n      }\n\n      throw new SchemaEditingError(ECEditingStatus.SetClassName, new SchemaItemId(this.schemaItemType, itemKey), e);\n    }\n  }\n\n  /**\n   * Sets the SchemaItem description.\n   * @param schemaItemKey The SchemaItemKey of the SchemaItem\n   * @param description The new description to set.\n   */\n  public async setDescription(schemaItemKey: SchemaItemKey, description: string) {\n    const item = await this.getSchemaItem(schemaItemKey, this.itemTypeClass)\n      .catch((e: any) => {\n        throw new SchemaEditingError(ECEditingStatus.SetDescription, new SchemaItemId(this.schemaItemType, schemaItemKey), e);\n      });\n    (item as MutableSchemaItem).setDescription(description);\n  }\n\n  /**\n   * Sets the SchemaItem display label.\n   * @param schemaItemKey The SchemaItemKey of the SchemaItem\n   * @param label The new label to set.\n   */\n  public async setDisplayLabel(schemaItemKey: SchemaItemKey, label: string) {\n    const item = await this.getSchemaItem(schemaItemKey, this.itemTypeClass)\n      .catch((e: any) => {\n        throw new SchemaEditingError(ECEditingStatus.SetLabel, new SchemaItemId(this.schemaItemType, schemaItemKey), e);\n      });\n    (item as MutableSchemaItem).setDisplayLabel(label);\n  }\n\n  protected async getSchema(schemaKey: SchemaKey): Promise<MutableSchema> {\n    const schema = await this.schemaEditor.getSchema(schemaKey);\n    if (schema === undefined)\n      throw new SchemaEditingError(ECEditingStatus.SchemaNotFound, new SchemaId(schemaKey));\n\n    return schema;\n  }\n\n  protected async getSchemaItem<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): Promise<InstanceType<T>> {\n    return this.schemaEditor.getSchemaItem(schemaItemKey, itemConstructor);\n  }\n\n  protected async createSchemaItem<T extends SchemaItem>(schemaKey: SchemaKey, type: SchemaItemType, create: CreateSchemaItem<T>, name: string, ...args: any[]): Promise<T> {\n    const schema = await this.getSchema(schemaKey);\n    try {\n      const boundCreate = create(schema);\n      return await boundCreate(name, ...args);\n    } catch (e) {\n      if (e instanceof ECObjectsError && e.errorNumber === ECObjectsStatus.DuplicateItem) {\n        throw new SchemaEditingError(ECEditingStatus.SchemaItemNameAlreadyExists, new SchemaItemId(type, name, schema.schemaKey));\n      } else {\n        throw new Error(`Failed to create class ${name} in schema ${schema.fullName}.`);\n      }\n    }\n  }\n\n  protected async createSchemaItemFromProps<T extends SchemaItem>(schemaKey: SchemaKey, type: SchemaItemType, create: CreateSchemaItem<T>, props: SchemaItemProps): Promise<T> {\n    if (props.name === undefined)\n      throw new SchemaEditingError(ECEditingStatus.SchemaItemNameNotSpecified, new SchemaItemId(type, \"\", schemaKey));\n\n    const newItem = await this.createSchemaItem<T>(schemaKey, type, create, props.name);\n    await newItem.fromJSON(props);\n\n    return newItem;\n  }\n}\n"]}

package/lib/esm/Editing/Structs.d.ts

@@ -0,0 +1,21 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { SchemaItemKey, SchemaKey, StructClass, StructClassProps } from "@itwin/ecschema-metadata";
+import { SchemaContextEditor } from "./Editor";
+import { ECClasses } from "./ECClasses";
+/**
+ * @alpha A class extending ECClasses allowing you to create schema items of type StructClass.
+ */
+export declare class Structs extends ECClasses {
+    protected get itemTypeClass(): typeof StructClass;
+    constructor(schemaEditor: SchemaContextEditor);
+    create(schemaKey: SchemaKey, name: string, displayLabel?: string, baseClassKey?: SchemaItemKey): Promise<SchemaItemKey>;
+    /**
+     *  Creates a StructClass through a StructClassProps.
+     * @param schemaKey a SchemaKey of the Schema that will house the new object.
+     * @param structProps a json object that will be used to populate the new StructClass. Needs a name value passed in.
+     */
+    createFromProps(schemaKey: SchemaKey, structProps: StructClassProps): Promise<SchemaItemKey>;
+}
+//# sourceMappingURL=Structs.d.ts.map

package/lib/esm/Editing/Structs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Structs.d.ts","sourceRoot":"","sources":["../../../src/Editing/Structs.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAkB,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACnH,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC;;GAEG;AACH,qBAAa,OAAQ,SAAQ,SAAS;IACpC,cAAuB,aAAa,IAAI,OAAO,WAAW,CAEzD;gBAEkB,YAAY,EAAE,mBAAmB;IAIvC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAapI;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;CAQ1G"}

package/lib/esm/Editing/Structs.js

@@ -0,0 +1,47 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Editing
+ */
+import { SchemaItemType, StructClass } from "@itwin/ecschema-metadata";
+import { ECClasses } from "./ECClasses";
+import { ClassId, ECEditingStatus, SchemaEditingError } from "./Exception";
+/**
+ * @alpha A class extending ECClasses allowing you to create schema items of type StructClass.
+ */
+export class Structs extends ECClasses {
+    get itemTypeClass() {
+        return StructClass;
+    }
+    constructor(schemaEditor) {
+        super(SchemaItemType.StructClass, schemaEditor);
+    }
+    async create(schemaKey, name, displayLabel, baseClassKey) {
+        try {
+            const newClass = await this.createClass(schemaKey, this.schemaItemType, (schema) => schema.createStructClass.bind(schema), name, baseClassKey);
+            if (displayLabel)
+                newClass.setDisplayLabel(displayLabel);
+            return newClass.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new ClassId(this.schemaItemType, name, schemaKey), e);
+        }
+    }
+    /**
+     *  Creates a StructClass through a StructClassProps.
+     * @param schemaKey a SchemaKey of the Schema that will house the new object.
+     * @param structProps a json object that will be used to populate the new StructClass. Needs a name value passed in.
+     */
+    async createFromProps(schemaKey, structProps) {
+        try {
+            const newClass = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createStructClass.bind(schema), structProps);
+            return newClass.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new ClassId(this.schemaItemType, structProps.name, schemaKey), e);
+        }
+    }
+}
+//# sourceMappingURL=Structs.js.map

package/lib/esm/Editing/Structs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Structs.js","sourceRoot":"","sources":["../../../src/Editing/Structs.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAiB,cAAc,EAAa,WAAW,EAAoB,MAAM,0BAA0B,CAAC;AAEnH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAE3E;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,SAAS;IACpC,IAAuB,aAAa;QAClC,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,YAAmB,YAAiC;QAClD,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,YAAqB,EAAE,YAA4B;QACzG,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAc,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,YAAY,CAAuB,CAAC;YAElL,IAAI,YAAY;gBACd,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAEzC,OAAO,QAAQ,CAAC,GAAG,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,sBAAsB,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7H,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,WAA6B;QAC9E,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC;YACtJ,OAAO,QAAQ,CAAC,GAAG,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,yBAAyB,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,IAAK,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7I,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Editing\n */\n\nimport { SchemaItemKey, SchemaItemType, SchemaKey, StructClass, StructClassProps } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor } from \"./Editor\";\nimport { ECClasses } from \"./ECClasses\";\nimport { MutableStructClass } from \"./Mutable/MutableClass\";\nimport { ClassId, ECEditingStatus, SchemaEditingError } from \"./Exception\";\n\n/**\n * @alpha A class extending ECClasses allowing you to create schema items of type StructClass.\n */\nexport class Structs extends ECClasses {\n  protected override get itemTypeClass(): typeof StructClass {\n    return StructClass;\n  }\n\n  public constructor(schemaEditor: SchemaContextEditor) {\n    super(SchemaItemType.StructClass, schemaEditor);\n  }\n\n  public async create(schemaKey: SchemaKey, name: string, displayLabel?: string, baseClassKey?: SchemaItemKey): Promise<SchemaItemKey> {\n    try {\n      const newClass = await this.createClass<StructClass>(schemaKey, this.schemaItemType, (schema) => schema.createStructClass.bind(schema), name, baseClassKey) as MutableStructClass;\n\n      if (displayLabel)\n        newClass.setDisplayLabel(displayLabel);\n\n      return newClass.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new ClassId(this.schemaItemType, name, schemaKey), e);\n    }\n  }\n\n  /**\n   *  Creates a StructClass through a StructClassProps.\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\n   * @param structProps a json object that will be used to populate the new StructClass. Needs a name value passed in.\n   */\n  public async createFromProps(schemaKey: SchemaKey, structProps: StructClassProps): Promise<SchemaItemKey> {\n    try {\n      const newClass = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createStructClass.bind(schema), structProps);\n      return newClass.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new ClassId(this.schemaItemType, structProps.name!, schemaKey), e);\n    }\n  }\n}\n"]}

package/lib/esm/Editing/UnitSystems.d.ts

@@ -0,0 +1,17 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { SchemaItemKey, SchemaKey, UnitSystem, UnitSystemProps } from "@itwin/ecschema-metadata";
+import { SchemaContextEditor } from "./Editor";
+import { SchemaItems } from "./SchemaItems";
+/**
+ * @alpha
+ * A class allowing you to create schema items of type UnitSystems.
+ */
+export declare class UnitSystems extends SchemaItems {
+    protected get itemTypeClass(): typeof UnitSystem;
+    constructor(schemaEditor: SchemaContextEditor);
+    create(schemaKey: SchemaKey, name: string, displayLabel?: string): Promise<SchemaItemKey>;
+    createFromProps(schemaKey: SchemaKey, unitSystemProps: UnitSystemProps): Promise<SchemaItemKey>;
+}
+//# sourceMappingURL=UnitSystems.d.ts.map

package/lib/esm/Editing/UnitSystems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnitSystems.d.ts","sourceRoot":"","sources":["../../../src/Editing/UnitSystems.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAkB,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACjH,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,cAAuB,aAAa,IAAI,OAAO,UAAU,CAExD;gBAEkB,YAAY,EAAE,mBAAmB;IAIvC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAczF,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;CAQ7G"}

package/lib/esm/Editing/UnitSystems.js

@@ -0,0 +1,43 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Editing
+ */
+import { SchemaItemType, UnitSystem } from "@itwin/ecschema-metadata";
+import { ECEditingStatus, SchemaEditingError, SchemaItemId } from "./Exception";
+import { SchemaItems } from "./SchemaItems";
+/**
+ * @alpha
+ * A class allowing you to create schema items of type UnitSystems.
+ */
+export class UnitSystems extends SchemaItems {
+    get itemTypeClass() {
+        return UnitSystem;
+    }
+    constructor(schemaEditor) {
+        super(SchemaItemType.UnitSystem, schemaEditor);
+    }
+    async create(schemaKey, name, displayLabel) {
+        try {
+            const newUnitSystem = await this.createSchemaItem(schemaKey, this.schemaItemType, (schema) => schema.createUnitSystem.bind(schema), name);
+            if (displayLabel)
+                newUnitSystem.setDisplayLabel(displayLabel);
+            return newUnitSystem.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new SchemaItemId(this.schemaItemType, name, schemaKey), e);
+        }
+    }
+    async createFromProps(schemaKey, unitSystemProps) {
+        try {
+            const newUnitSystem = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createUnitSystem.bind(schema), unitSystemProps);
+            return newUnitSystem.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new SchemaItemId(this.schemaItemType, unitSystemProps.name, schemaKey), e);
+        }
+    }
+}
+//# sourceMappingURL=UnitSystems.js.map

package/lib/esm/Editing/UnitSystems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UnitSystems.js","sourceRoot":"","sources":["../../../src/Editing/UnitSystems.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAiB,cAAc,EAAa,UAAU,EAAmB,MAAM,0BAA0B,CAAC;AAGjH,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C,IAAuB,aAAa;QAClC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,YAAmB,YAAiC;QAClD,KAAK,CAAC,cAAc,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IACjD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,YAAqB;QAE3E,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAa,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAsB,CAAC;YAE3K,IAAI,YAAY;gBACd,aAAa,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAE9C,OAAO,aAAa,CAAC,GAAG,CAAC;QAC3B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,sBAAsB,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAClI,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,eAAgC;QACjF,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,CAAC;YAC9J,OAAO,aAAa,CAAC,GAAG,CAAC;QAC3B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,yBAAyB,EAAE,IAAI,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC,IAAK,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACtJ,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Editing\n */\n\nimport { SchemaItemKey, SchemaItemType, SchemaKey, UnitSystem, UnitSystemProps } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor } from \"./Editor\";\nimport { MutableUnitSystem } from \"./Mutable/MutableUnitSystem\";\nimport { ECEditingStatus, SchemaEditingError, SchemaItemId } from \"./Exception\";\nimport { SchemaItems } from \"./SchemaItems\";\n\n/**\n * @alpha\n * A class allowing you to create schema items of type UnitSystems.\n */\nexport class UnitSystems extends SchemaItems {\n  protected override get itemTypeClass(): typeof UnitSystem {\n    return UnitSystem;\n  }\n\n  public constructor(schemaEditor: SchemaContextEditor) {\n    super(SchemaItemType.UnitSystem, schemaEditor);\n  }\n\n  public async create(schemaKey: SchemaKey, name: string, displayLabel?: string): Promise<SchemaItemKey> {\n\n    try {\n      const newUnitSystem = await this.createSchemaItem<UnitSystem>(schemaKey, this.schemaItemType, (schema) => schema.createUnitSystem.bind(schema), name) as MutableUnitSystem;\n\n      if (displayLabel)\n        newUnitSystem.setDisplayLabel(displayLabel);\n\n      return newUnitSystem.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new SchemaItemId(this.schemaItemType, name, schemaKey), e);\n    }\n  }\n\n  public async createFromProps(schemaKey: SchemaKey, unitSystemProps: UnitSystemProps): Promise<SchemaItemKey> {\n    try {\n      const newUnitSystem = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createUnitSystem.bind(schema), unitSystemProps);\n      return newUnitSystem.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new SchemaItemId(this.schemaItemType, unitSystemProps.name!, schemaKey), e);\n    }\n  }\n}\n"]}