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

package/lib/esm/Editing/Editor.js

@@ -0,0 +1,264 @@
+/*---------------------------------------------------------------------------------------------
+* 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 * as Rules from "../Validation/ECRules";
+import { ECObjectsError, ECObjectsStatus, isSupportedSchemaItemType, Schema, SchemaItemType, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { assert } from "@itwin/core-bentley";
+import { Constants } from "./Constants";
+import { CustomAttributes } from "./CustomAttributes";
+import { Entities } from "./Entities";
+import { Enumerations } from "./Enumerations";
+import { Formats } from "./Formats";
+import { InvertedUnits } from "./InvertedUnits";
+import { KindOfQuantities } from "./KindOfQuantities";
+import { Mixins } from "./Mixins";
+import { Phenomena } from "./Phenomena";
+import { PropertyCategories } from "./PropertyCategories";
+import { RelationshipClasses } from "./RelationshipClasses";
+import { Structs } from "./Structs";
+import { Units } from "./Units";
+import { UnitSystems } from "./UnitSystems";
+import { CustomAttributeId, ECEditingStatus, SchemaEditingError, SchemaId, SchemaItemId } from "./Exception";
+/**
+ * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.
+ * @alpha
+ */
+export class SchemaContextEditor {
+    _schemaContext;
+    entities = new Entities(this);
+    mixins = new Mixins(this);
+    structs = new Structs(this);
+    customAttributes = new CustomAttributes(this);
+    relationships = new RelationshipClasses(this);
+    constants = new Constants(this);
+    enumerations = new Enumerations(this);
+    formats = new Formats(this);
+    kindOfQuantities = new KindOfQuantities(this);
+    units = new Units(this);
+    phenomenons = new Phenomena(this);
+    unitSystems = new UnitSystems(this);
+    propertyCategories = new PropertyCategories(this);
+    invertedUnits = new InvertedUnits(this);
+    /**
+     * Creates a new SchemaContextEditor instance.
+     * @param schemaContext The SchemaContext the Editor will use to edit in.
+     */
+    constructor(schemaContext) {
+        // TODO: Make copy
+        this._schemaContext = schemaContext;
+    }
+    /** Allows you to get schema classes and items through regular SchemaContext methods. */
+    get schemaContext() {
+        return this._schemaContext;
+    }
+    async finish() {
+        return this._schemaContext;
+    }
+    /**
+     * Helper method for retrieving a schema, previously added, from the SchemaContext.
+     * @param schemaKey The SchemaKey identifying the schema.
+     * @internal
+    */
+    async getSchema(schemaKey) {
+        const schema = await this.schemaContext.getCachedSchema(schemaKey, SchemaMatchType.Latest);
+        if (schema === undefined)
+            throw new SchemaEditingError(ECEditingStatus.SchemaNotFound, new SchemaId(schemaKey));
+        return schema;
+    }
+    /**
+     * Creates a Schema with the given properties and adds it to the current schema context.
+     * @param name The name given to the new schema.
+     * @param alias The alias of the new schema.
+     * @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 the SchemaKey of created schema.
+     */
+    async createSchema(name, alias, readVersion, writeVersion, minorVersion) {
+        const newSchema = new Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);
+        await this._schemaContext.addSchema(newSchema);
+        return newSchema.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.
+     */
+    async addSchemaReference(schemaKey, refSchema) {
+        try {
+            const schema = await this.lookupSchema(schemaKey, 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 SchemaEditingError(ECEditingStatus.RuleViolation, new SchemaId(schemaKey), undefined, diagnostics);
+            }
+            if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {
+                await this.schemaContext.addSchema(refSchema);
+            }
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.AddSchemaReference, new SchemaId(schemaKey), e);
+        }
+    }
+    /**
+     * 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.
+     */
+    async addCustomAttribute(schemaKey, customAttribute) {
+        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 SchemaEditingError(ECEditingStatus.RuleViolation, new CustomAttributeId(customAttribute.className, schema), undefined, diagnostics);
+            }
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.AddCustomAttributeToClass, new SchemaId(schemaKey), e);
+        }
+    }
+    /**
+     * 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.
+     */
+    async setVersion(schemaKey, readVersion, writeVersion, minorVersion) {
+        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 SchemaEditingError(ECEditingStatus.SetSchemaVersion, new 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) {
+        try {
+            const schema = await this.lookupSchema(schemaKey);
+            schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);
+            return schema.schemaKey;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.IncrementSchemaMinorVersion, new SchemaId(schemaKey), e);
+        }
+    }
+    /** @internal */
+    async lookupSchemaItem(schemaOrKey, schemaItemKey, schemaItemType) {
+        if (Schema.isSchema(schemaOrKey)) {
+            schemaOrKey = schemaOrKey.schemaKey;
+        }
+        const schemaItem = await this.schemaContext.getSchemaItem(schemaItemKey);
+        if (schemaItem === undefined)
+            throw new SchemaEditingError(ECEditingStatus.SchemaItemNotFound, new SchemaItemId(schemaItemType, schemaItemKey));
+        if (schemaItemType !== schemaItem.schemaItemType)
+            throw new SchemaEditingError(ECEditingStatus.InvalidSchemaItemType, new SchemaItemId(schemaItemType, schemaItemKey));
+        return schemaItem;
+    }
+    /** @internal */
+    async getSchemaItem(schemaItemKey, itemConstructor) {
+        const schemaItem = await this.schemaContext.getSchemaItem(schemaItemKey);
+        const schemaItemType = itemConstructor.schemaItemType;
+        if (!isSchemaItemType(schemaItemType)) {
+            // This block should never be hit, as the editor components always pass in the itemConstructor with a valid schemaItemType.
+            throw new Error(`Invalid schema item lookup for: ${schemaItemType}`);
+        }
+        if (!schemaItem) {
+            throw new SchemaEditingError(ECEditingStatus.SchemaItemNotFoundInContext, new SchemaItemId(schemaItemType, schemaItemKey));
+        }
+        if (!isSupportedSchemaItemType(schemaItem.schemaItemType, itemConstructor.schemaItemType))
+            throw new SchemaEditingError(ECEditingStatus.InvalidSchemaItemType, new SchemaItemId(schemaItemType, schemaItemKey));
+        return schemaItem;
+    }
+    removeReference(schema, refSchema) {
+        const index = schema.references.indexOf(refSchema);
+        if (index !== -1) {
+            schema.references.splice(index, 1);
+        }
+    }
+    removeCustomAttribute(schema, customAttribute) {
+        assert(schema.customAttributes !== undefined);
+        const map = schema.customAttributes;
+        map.delete(customAttribute.className);
+    }
+    async lookupSchema(schemaKey, matchType = SchemaMatchType.Latest) {
+        const schema = await this.schemaContext.getCachedSchema(schemaKey, matchType);
+        if (schema === undefined)
+            throw new SchemaEditingError(ECEditingStatus.SchemaNotFound, new SchemaId(schemaKey));
+        return schema;
+    }
+    /**
+     * Sets the Schemas description.
+     * @param schemaKey The SchemaKey identifying the schema.
+     * @param description The new description to set.
+     */
+    async setDescription(schemaKey, description) {
+        const schema = await this.lookupSchema(schemaKey)
+            .catch((e) => {
+            throw new SchemaEditingError(ECEditingStatus.SetDescription, new SchemaId(schemaKey), e);
+        });
+        schema.setDescription(description);
+    }
+    /**
+     * Sets the Schemas display label.
+     * @param schemaKey The SchemaKey identifying the schema.
+     * @param label The new label to set.
+     */
+    async setDisplayLabel(schemaKey, label) {
+        const schema = await this.lookupSchema(schemaKey)
+            .catch((e) => {
+            throw new SchemaEditingError(ECEditingStatus.SetLabel, new SchemaId(schemaKey), e);
+        });
+        schema.setDisplayLabel(label);
+    }
+    /**
+     * Sets the Schemas alias.
+     * @param schemaKey The SchemaKey identifying the schema.
+     * @param alias The new alias to set.
+     */
+    async setAlias(schemaKey, alias) {
+        const schema = await this.lookupSchema(schemaKey)
+            .catch((e) => {
+            throw new SchemaEditingError(ECEditingStatus.SetSchemaAlias, new SchemaId(schemaKey), e);
+        });
+        try {
+            for (const currentSchema of this.schemaContext.getKnownSchemas()) {
+                if (currentSchema.schemaKey.matches(schemaKey))
+                    continue;
+                if (currentSchema.alias.toLowerCase() === alias.toLowerCase())
+                    throw new SchemaEditingError(ECEditingStatus.SchemaAliasAlreadyExists, new SchemaId(schemaKey), undefined, undefined, `Schema ${currentSchema.name} already uses the alias '${alias}'.`);
+            }
+            schema.setAlias(alias);
+        }
+        catch (e) {
+            if (e instanceof ECObjectsError && e.errorNumber === ECObjectsStatus.InvalidECName) {
+                throw new SchemaEditingError(ECEditingStatus.SetSchemaAlias, new SchemaId(schemaKey), new SchemaEditingError(ECEditingStatus.InvalidSchemaAlias, new SchemaId(schemaKey)));
+            }
+            throw new SchemaEditingError(ECEditingStatus.SetSchemaAlias, new SchemaId(schemaKey), e);
+        }
+    }
+}
+function isSchemaItemType(type) {
+    return Object.values(SchemaItemType).includes(type);
+}
+//# sourceMappingURL=Editor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Editor.js","sourceRoot":"","sources":["../../../src/Editing/Editor.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAmB,cAAc,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,EAA4C,cAAc,EAAa,eAAe,EAA2B,MAAM,0BAA0B,CAAC;AAE9O,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,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,iBAAiB,EAAE,eAAe,EAAE,kBAAkB,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG7G;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IACtB,cAAc,CAAgB;IACtB,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC9C,aAAa,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC9C,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IAChC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IACtC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC9C,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;IACxB,WAAW,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IAClC,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IACpC,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAClD,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IAExD;;;OAGG;IACH,YAAY,aAA4B;QACtC,kBAAkB;QAClB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED,wFAAwF;IACxF,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;MAIE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QAC3F,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAExF,OAAO,MAAuB,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,KAAa,EAAE,WAAmB,EAAE,YAAoB,EAAE,YAAoB;QACpH,MAAM,SAAS,GAAG,IAAI,MAAM,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,eAAe,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,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,QAAQ,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,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,IAAI,QAAQ,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,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,iBAAiB,CAAC,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;YAChJ,CAAC;QACH,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,yBAAyB,EAAE,IAAI,QAAQ,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,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,gBAAgB,EAAE,IAAI,QAAQ,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,kBAAkB,CAAC,eAAe,CAAC,2BAA2B,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACxG,CAAC;IACH,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,gBAAgB,CAAC,WAA+B,EAAE,aAA4B,EAAE,cAA8B;QACzH,IAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAChC,WAAW,GAAG,WAAW,CAAC,SAAS,CAAC;QACtC,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACzE,IAAI,UAAU,KAAK,SAAS;YAC1B,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,IAAI,YAAY,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;QAEpH,IAAI,cAAc,KAAK,UAAU,CAAC,cAAc;YAC9C,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,qBAAqB,EAAE,IAAI,YAAY,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;QAEvH,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,aAAa,CAA8B,aAA4B,EAAE,eAAkB;QACtG,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACzE,MAAM,cAAc,GAAG,eAAe,CAAC,cAAc,CAAC;QACtD,IAAG,CAAC,gBAAgB,CAAC,cAAc,CAAC,EAAE,CAAC;YACrC,2HAA2H;YAC3H,MAAM,IAAI,KAAK,CAAC,mCAAmC,cAAc,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,2BAA2B,EAAE,IAAI,YAAY,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;QAC7H,CAAC;QAED,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,cAAc,EAAE,eAAe,CAAC,cAAc,CAAC;YACvF,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,qBAAqB,EAAE,IAAI,YAAY,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;QAEvH,OAAO,UAA6B,CAAC;IACvC,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,MAAM,CAAC,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,eAAe,CAAC,MAAM;QAClG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC9E,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAExF,OAAO,MAAuB,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,SAAoB,EAAE,WAAmB;QACnE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;aAC9C,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;QACL,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,KAAa;QAC9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;aAC9C,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC;QACL,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CAAC,SAAoB,EAAE,KAAa;QACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;aAC9C,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE;YAChB,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC;YACH,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,EAAE,CAAC;gBACjE,IAAI,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC;oBAC5C,SAAS;gBAEX,IAAI,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE;oBAC3D,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,wBAAwB,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,aAAa,CAAC,IAAI,4BAA4B,KAAK,IAAI,CAAC,CAAC;YAC7L,CAAC;YACD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,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,cAAc,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,EAClF,IAAI,kBAAkB,CAAC,eAAe,CAAC,kBAAkB,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACzF,CAAC;YAED,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,cAAc,EAAG,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAC5F,CAAC;IACH,CAAC;CACF;AAED,SAAS,gBAAgB,CAAC,IAA6B;IACrD,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,IAAsB,CAAC,CAAC;AACxE,CAAC","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 * as Rules from \"../Validation/ECRules\";\nimport { CustomAttribute, ECObjectsError, ECObjectsStatus, isSupportedSchemaItemType, Schema, SchemaContext, SchemaItem, SchemaItemKey, SchemaItemType, SchemaKey, SchemaMatchType, SupportedSchemaItemType } from \"@itwin/ecschema-metadata\";\nimport { MutableSchema } from \"./Mutable/MutableSchema\";\nimport { assert } from \"@itwin/core-bentley\";\nimport { Constants } from \"./Constants\";\nimport { CustomAttributes } from \"./CustomAttributes\";\nimport { Entities } from \"./Entities\";\nimport { Enumerations } from \"./Enumerations\";\nimport { Formats } from \"./Formats\";\nimport { InvertedUnits } from \"./InvertedUnits\";\nimport { KindOfQuantities } from \"./KindOfQuantities\";\nimport { Mixins } from \"./Mixins\";\nimport { Phenomena } from \"./Phenomena\";\nimport { PropertyCategories } from \"./PropertyCategories\";\nimport { RelationshipClasses } from \"./RelationshipClasses\";\nimport { Structs } from \"./Structs\";\nimport { Units } from \"./Units\";\nimport { UnitSystems } from \"./UnitSystems\";\nimport { CustomAttributeId, ECEditingStatus, SchemaEditingError, SchemaId, SchemaItemId } from \"./Exception\";\nimport { AnyDiagnostic } from \"../Validation/Diagnostic\";\n\n/**\n * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.\n * @alpha\n */\nexport class SchemaContextEditor {\n  private _schemaContext: SchemaContext;\n  public readonly entities = new Entities(this);\n  public readonly mixins = new Mixins(this);\n  public readonly structs = new Structs(this);\n  public readonly customAttributes = new CustomAttributes(this);\n  public readonly relationships = new RelationshipClasses(this);\n  public readonly constants = new Constants(this);\n  public readonly enumerations = new Enumerations(this);\n  public readonly formats = new Formats(this);\n  public readonly kindOfQuantities = new KindOfQuantities(this);\n  public readonly units = new Units(this);\n  public readonly phenomenons = new Phenomena(this);\n  public readonly unitSystems = new UnitSystems(this);\n  public readonly propertyCategories = new PropertyCategories(this);\n  public readonly invertedUnits = new InvertedUnits(this);\n\n  /**\n   * Creates a new SchemaContextEditor instance.\n   * @param schemaContext The SchemaContext the Editor will use to edit in.\n   */\n  constructor(schemaContext: SchemaContext) {\n    // TODO: Make copy\n    this._schemaContext = schemaContext;\n  }\n\n  /** Allows you to get schema classes and items through regular SchemaContext methods. */\n  public get schemaContext(): SchemaContext {\n    return this._schemaContext;\n  }\n\n  public async finish(): Promise<SchemaContext> {\n    return this._schemaContext;\n  }\n\n  /**\n   * Helper method for retrieving a schema, previously added, from the SchemaContext.\n   * @param schemaKey The SchemaKey identifying the schema.\n   * @internal\n  */\n  public async getSchema(schemaKey: SchemaKey): Promise<MutableSchema> {\n    const schema = await this.schemaContext.getCachedSchema(schemaKey, SchemaMatchType.Latest);\n    if (schema === undefined)\n      throw new SchemaEditingError(ECEditingStatus.SchemaNotFound, new SchemaId(schemaKey));\n\n    return schema as MutableSchema;\n  }\n\n  /**\n   * Creates a Schema with the given properties and adds it to the current schema context.\n   * @param name The name given to the new schema.\n   * @param alias The alias of the new schema.\n   * @param readVersion The read version number of the schema.\n   * @param writeVersion The write version number of the schema.\n   * @param minorVersion The minor version number of the schema.\n   * @returns Resolves to the SchemaKey of created schema.\n   */\n  public async createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaKey> {\n    const newSchema = new Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);\n    await this._schemaContext.addSchema(newSchema);\n    return newSchema.schemaKey;\n  }\n\n  /**\n   * Adds a referenced schema to the schema identified by the given SchemaKey.\n   * @param schemaKey The SchemaKey identifying the schema.\n   * @param refSchema The referenced schema to add.\n   */\n  public async addSchemaReference(schemaKey: SchemaKey, refSchema: Schema): Promise<void> {\n    try {\n      const schema = await this.lookupSchema(schemaKey, SchemaMatchType.Exact);\n      await schema.addReference(refSchema);\n\n      const diagnostics: AnyDiagnostic[] = [];\n      for await (const diagnostic of Rules.validateSchemaReferences(schema)) {\n        diagnostics.push(diagnostic);\n      }\n\n      if (diagnostics.length > 0) {\n        this.removeReference(schema, refSchema);\n        throw new SchemaEditingError(ECEditingStatus.RuleViolation, new SchemaId(schemaKey), undefined, diagnostics);\n      }\n\n      if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {\n        await this.schemaContext.addSchema(refSchema);\n      }\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.AddSchemaReference, new SchemaId(schemaKey), e);\n    }\n  }\n\n  /**\n   * Adds a CustomAttribute instance to the schema identified by the given SchemaKey\n   * @param schemaKey The SchemaKey identifying the schema.\n   * @param customAttribute The CustomAttribute instance to add.\n   */\n  public async addCustomAttribute(schemaKey: SchemaKey, customAttribute: CustomAttribute): Promise<void> {\n    try {\n      const schema = await this.lookupSchema(schemaKey);\n      schema.addCustomAttribute(customAttribute);\n\n      const diagnostics: AnyDiagnostic[] = [];\n      for await (const diagnostic of Rules.validateCustomAttributeInstance(schema, customAttribute)) {\n        diagnostics.push(diagnostic);\n      }\n\n      if (diagnostics.length > 0) {\n        this.removeCustomAttribute(schema, customAttribute);\n        throw new SchemaEditingError(ECEditingStatus.RuleViolation, new CustomAttributeId(customAttribute.className, schema), undefined, diagnostics);\n      }\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.AddCustomAttributeToClass, new SchemaId(schemaKey), e);\n    }\n  }\n\n  /**\n   * Sets the schema version.\n   * @param schemaKey The SchemaKey identifying the schema.\n   * @param readVersion The read version of the schema. If not specified, the existing read version will be maintained.\n   * @param writeVersion The write version of the schema. If not specified, the existing write version will be maintained.\n   * @param minorVersion The minor version of the schema. If not specified, the existing minor version will be maintained.\n   * @returns Resolves to the new SchemaKey containing version updates.\n   */\n  public async setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaKey> {\n    try {\n      const schema = await this.lookupSchema(schemaKey);\n      schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);\n\n      return schema.schemaKey;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.SetSchemaVersion, new SchemaId(schemaKey), e);\n    }\n  }\n\n  /**\n   * Increments the minor version of a schema.\n   * @param schemaKey The SchemaKey identifying the schema.\n   * @returns Resolves to the new SchemaKey containing version updates.\n   */\n  public async incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaKey> {\n    try {\n      const schema = await this.lookupSchema(schemaKey);\n      schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);\n\n      return schema.schemaKey;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.IncrementSchemaMinorVersion, new SchemaId(schemaKey), e);\n    }\n  }\n\n  /** @internal */\n  public async lookupSchemaItem(schemaOrKey: Schema | SchemaKey, schemaItemKey: SchemaItemKey, schemaItemType: SchemaItemType): Promise<SchemaItem> {\n    if(Schema.isSchema(schemaOrKey)) {\n      schemaOrKey = schemaOrKey.schemaKey;\n    }\n\n    const schemaItem = await this.schemaContext.getSchemaItem(schemaItemKey);\n    if (schemaItem === undefined)\n      throw new SchemaEditingError(ECEditingStatus.SchemaItemNotFound, new SchemaItemId(schemaItemType, schemaItemKey));\n\n    if (schemaItemType !== schemaItem.schemaItemType)\n      throw new SchemaEditingError(ECEditingStatus.InvalidSchemaItemType, new SchemaItemId(schemaItemType, schemaItemKey));\n\n    return schemaItem;\n  }\n\n  /** @internal */\n  public async getSchemaItem<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): Promise<InstanceType<T>> {\n    const schemaItem = await this.schemaContext.getSchemaItem(schemaItemKey);\n    const schemaItemType = itemConstructor.schemaItemType;\n    if(!isSchemaItemType(schemaItemType)) {\n      // This block should never be hit, as the editor components always pass in the itemConstructor with a valid schemaItemType.\n      throw new Error(`Invalid schema item lookup for: ${schemaItemType}`);\n    }\n\n    if (!schemaItem) {\n      throw new SchemaEditingError(ECEditingStatus.SchemaItemNotFoundInContext, new SchemaItemId(schemaItemType, schemaItemKey));\n    }\n\n    if (!isSupportedSchemaItemType(schemaItem.schemaItemType, itemConstructor.schemaItemType))\n      throw new SchemaEditingError(ECEditingStatus.InvalidSchemaItemType, new SchemaItemId(schemaItemType, schemaItemKey));\n\n    return schemaItem as InstanceType<T>;\n  }\n\n  private removeReference(schema: Schema, refSchema: Schema) {\n    const index: number = schema.references.indexOf(refSchema);\n    if (index !== -1) {\n      schema.references.splice(index, 1);\n    }\n  }\n\n  private removeCustomAttribute(schema: Schema, customAttribute: CustomAttribute) {\n    assert(schema.customAttributes !== undefined);\n    const map = schema.customAttributes as Map<string, CustomAttribute>;\n    map.delete(customAttribute.className);\n  }\n\n  private async lookupSchema(schemaKey: SchemaKey, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<MutableSchema> {\n    const schema = await this.schemaContext.getCachedSchema(schemaKey, matchType);\n    if (schema === undefined)\n      throw new SchemaEditingError(ECEditingStatus.SchemaNotFound, new SchemaId(schemaKey));\n\n    return schema as MutableSchema;\n  }\n\n  /**\n   * Sets the Schemas description.\n   * @param schemaKey The SchemaKey identifying the schema.\n   * @param description The new description to set.\n   */\n  public async setDescription(schemaKey: SchemaKey, description: string) {\n    const schema = await this.lookupSchema(schemaKey)\n      .catch((e: any) => {\n        throw new SchemaEditingError(ECEditingStatus.SetDescription, new SchemaId(schemaKey), e);\n      });\n    schema.setDescription(description);\n  }\n\n  /**\n   * Sets the Schemas display label.\n   * @param schemaKey The SchemaKey identifying the schema.\n   * @param label The new label to set.\n   */\n  public async setDisplayLabel(schemaKey: SchemaKey, label: string) {\n    const schema = await this.lookupSchema(schemaKey)\n      .catch((e: any) => {\n        throw new SchemaEditingError(ECEditingStatus.SetLabel, new SchemaId(schemaKey), e);\n      });\n    schema.setDisplayLabel(label);\n  }\n\n  /**\n   * Sets the Schemas alias.\n   * @param schemaKey The SchemaKey identifying the schema.\n   * @param alias The new alias to set.\n   */\n  public async setAlias(schemaKey: SchemaKey, alias: string) {\n    const schema = await this.lookupSchema(schemaKey)\n      .catch((e: any) => {\n        throw new SchemaEditingError(ECEditingStatus.SetSchemaAlias, new SchemaId(schemaKey), e);\n      });\n\n    try {\n      for (const currentSchema of this.schemaContext.getKnownSchemas()) {\n        if (currentSchema.schemaKey.matches(schemaKey))\n          continue;\n\n        if (currentSchema.alias.toLowerCase() === alias.toLowerCase())\n          throw new SchemaEditingError(ECEditingStatus.SchemaAliasAlreadyExists, new SchemaId(schemaKey), undefined, undefined, `Schema ${currentSchema.name} already uses the alias '${alias}'.`);\n      }\n      schema.setAlias(alias);\n    } catch(e: any) {\n      if (e instanceof ECObjectsError && e.errorNumber === ECObjectsStatus.InvalidECName) {\n        throw new SchemaEditingError(ECEditingStatus.SetSchemaAlias, new SchemaId(schemaKey),\n          new SchemaEditingError(ECEditingStatus.InvalidSchemaAlias, new SchemaId(schemaKey)));\n      }\n\n      throw new SchemaEditingError(ECEditingStatus.SetSchemaAlias,  new SchemaId(schemaKey), e);\n    }\n  }\n}\n\nfunction isSchemaItemType(type: SupportedSchemaItemType): type is SchemaItemType {\n  return Object.values(SchemaItemType).includes(type as SchemaItemType);\n}"]}

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

@@ -0,0 +1,38 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { ECClassModifier, EntityClass, EntityClassProps, Mixin, NavigationPropertyProps, RelationshipClass, SchemaItemKey, SchemaKey, StrengthDirection } from "@itwin/ecschema-metadata";
+import { SchemaContextEditor } from "./Editor";
+import { ECClasses } from "./ECClasses";
+import { NavigationProperties } from "./Properties";
+/**
+ * @alpha
+ * A class extending ECClasses allowing you to create schema items of type EntityClass.
+ */
+export declare class Entities extends ECClasses {
+    protected get itemTypeClass(): typeof EntityClass;
+    constructor(schemaEditor: SchemaContextEditor);
+    /**
+     * Allows access for editing of NavigationProperty attributes.
+     */
+    readonly navigationProperties: NavigationProperties;
+    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<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<void>;
+}
+//# sourceMappingURL=Entities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Entities.d.ts","sourceRoot":"","sources":["../../../src/Editing/Entities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,eAAe,EAAE,WAAW,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;IACrC,cAAuB,aAAa,IAAI,OAAO,WAAW,CAEzD;gBAEkB,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/esm/Editing/Entities.js

@@ -0,0 +1,126 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { EntityClass, Mixin, SchemaItemType, } from "@itwin/ecschema-metadata";
+import { ECClasses } from "./ECClasses";
+import { MutableEntityClass } from "./Mutable/MutableEntityClass";
+import { NavigationProperties } from "./Properties";
+import { ClassId, ECEditingStatus, SchemaEditingError } from "./Exception";
+/**
+ * @alpha
+ * A class extending ECClasses allowing you to create schema items of type EntityClass.
+ */
+export class Entities extends ECClasses {
+    get itemTypeClass() {
+        return EntityClass;
+    }
+    constructor(schemaEditor) {
+        super(SchemaItemType.EntityClass, schemaEditor);
+    }
+    /**
+     * Allows access for editing of NavigationProperty attributes.
+     */
+    navigationProperties = new NavigationProperties(SchemaItemType.EntityClass, this.schemaEditor);
+    async createElement(schemaKey, name, modifier, baseClassKey, displayLabel, mixins) {
+        try {
+            const baseClass = await this.getSchemaItem(baseClassKey, EntityClass);
+            if (!(await (baseClass).is("Element", "BisCore"))) {
+                throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElement, new ClassId(this.schemaItemType, baseClassKey));
+            }
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);
+        }
+        return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);
+    }
+    async createElementUniqueAspect(schemaKey, name, modifier, baseClassKey, displayLabel, mixins) {
+        try {
+            const baseClass = await this.getSchemaItem(baseClassKey, EntityClass);
+            if (!(await (baseClass).is("ElementUniqueAspect", "BisCore"))) {
+                throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElementUniqueAspect, new ClassId(this.schemaItemType, baseClassKey));
+            }
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);
+        }
+        return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);
+    }
+    async createElementMultiAspect(schemaKey, name, modifier, baseClassKey, displayLabel, mixins) {
+        try {
+            const baseClass = await this.getSchemaItem(baseClassKey, EntityClass);
+            if (!(await (baseClass).is("ElementMultiAspect", "BisCore"))) {
+                throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElementMultiAspect, new ClassId(this.schemaItemType, baseClassKey));
+            }
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);
+        }
+        return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);
+    }
+    async create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins) {
+        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 SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new ClassId(this.schemaItemType, name, schemaKey), e);
+        }
+    }
+    /**
+     * 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.
+     */
+    async createFromProps(schemaKey, entityProps) {
+        try {
+            const newClass = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createEntityClass.bind(schema), entityProps);
+            return newClass.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new ClassId(this.schemaItemType, entityProps.name, schemaKey), e);
+        }
+    }
+    async addMixin(entityKey, mixinKey) {
+        try {
+            const entity = await this.getSchemaItem(entityKey, MutableEntityClass);
+            const mixin = await this.getSchemaItem(mixinKey, Mixin);
+            entity.addMixin(mixin);
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.AddMixin, new ClassId(SchemaItemType.EntityClass, entityKey), e);
+        }
+    }
+    async createNavigationProperty(entityKey, name, relationship, direction) {
+        try {
+            const entity = await this.getSchemaItem(entityKey, MutableEntityClass);
+            await entity.createNavigationProperty(name, relationship, direction);
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateNavigationProperty, new ClassId(SchemaItemType.RelationshipClass, entityKey), e);
+        }
+    }
+    /**
+     * Creates a Navigation Property through a NavigationPropertyProps.
+     * @param classKey a SchemaItemKey of the Entity Class that will house the new property.
+     * @param navigationProps a json object that will be used to populate the new Navigation Property.
+     */
+    async createNavigationPropertyFromProps(classKey, navigationProps) {
+        try {
+            const entity = await this.getSchemaItem(classKey, MutableEntityClass);
+            const property = await entity.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);
+            await property.fromJSON(navigationProps);
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateNavigationPropertyFromProps, new ClassId(SchemaItemType.EntityClass, classKey), e);
+        }
+    }
+}
+//# sourceMappingURL=Entities.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Entities.js","sourceRoot":"","sources":["../../../src/Editing/Entities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACY,WAAW,EAC5B,KAAK,EAA6D,cAAc,GACjF,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAE3E;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,SAAS;IACrC,IAAuB,aAAa;QAClC,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,YAAmB,YAAiC;QAClD,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACa,oBAAoB,GAAG,IAAI,oBAAoB,CAAC,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAExG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QAC5J,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YACtE,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,qBAAqB,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;YACtH,CAAC;QACH,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACpH,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QACxK,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YACtE,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC9D,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,iCAAiC,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;YAClI,CAAC;QACH,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACpH,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAA2B,EAAE,YAAqB,EAAE,MAAgB;QACvK,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YACtE,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC7D,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,gCAAgC,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;YACjI,CAAC;QACH,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACpH,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,QAAyB,EAAE,YAAqB,EAAE,YAA4B,EAAE,MAAgB;QACtJ,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,EAAE,QAAQ,CAAuB,CAAC;YAE5L,IAAI,MAAM,KAAK,SAAS;gBACtB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAE9C,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;IAEM,KAAK,CAAC,QAAQ,CAAC,SAAwB,EAAE,QAAuB;QACrE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;YACvE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YACxD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QAAC,OAAM,CAAM,EAAC,CAAC;YACd,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAChH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,SAAwB,EAAE,IAAY,EAAE,YAAwC,EAAE,SAAqC;QAC3J,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;YACvE,MAAM,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;QACvE,CAAC;QAAC,OAAM,CAAM,EAAE,CAAC;YACf,MAAM,IAAI,kBAAkB,CAAC,eAAe,CAAC,wBAAwB,EAAE,IAAI,OAAO,CAAC,cAAc,CAAC,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACtI,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,iCAAiC,CAAC,QAAuB,EAAE,eAAwC;QAC9G,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;YACtE,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,wBAAwB,CAAC,eAAe,CAAC,IAAI,EAAE,eAAe,CAAC,gBAAgB,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;YAC1I,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,WAAW,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QACxI,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  ECClassModifier, EntityClass, EntityClassProps,\n  Mixin, NavigationPropertyProps, RelationshipClass, SchemaItemKey, SchemaItemType, SchemaKey, StrengthDirection,\n} from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor } from \"./Editor\";\nimport { ECClasses } from \"./ECClasses\";\nimport { MutableEntityClass } from \"./Mutable/MutableEntityClass\";\nimport { NavigationProperties } from \"./Properties\";\nimport { ClassId, ECEditingStatus, SchemaEditingError } from \"./Exception\";\n\n/**\n * @alpha\n * A class extending ECClasses allowing you to create schema items of type EntityClass.\n */\nexport class Entities extends ECClasses {\n  protected override get itemTypeClass(): typeof EntityClass {\n    return EntityClass;\n  }\n\n  public constructor(schemaEditor: SchemaContextEditor) {\n    super(SchemaItemType.EntityClass, schemaEditor);\n  }\n\n  /**\n   * Allows access for editing of NavigationProperty attributes.\n   */\n  public readonly navigationProperties = new NavigationProperties(SchemaItemType.EntityClass, this.schemaEditor);\n\n  public async createElement(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey> {\n    try {\n      const baseClass = await this.getSchemaItem(baseClassKey, EntityClass);\n      if (!(await (baseClass).is(\"Element\", \"BisCore\"))) {\n        throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElement, new ClassId(this.schemaItemType, baseClassKey));\n      }\n    } catch(e: any){\n      throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);\n    }\n\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\n  }\n\n  public async createElementUniqueAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey> {\n    try {\n      const baseClass = await this.getSchemaItem(baseClassKey, EntityClass);\n      if (!(await (baseClass).is(\"ElementUniqueAspect\", \"BisCore\"))) {\n        throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElementUniqueAspect, new ClassId(this.schemaItemType, baseClassKey));\n      }\n    } catch(e: any){\n      throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);\n    }\n\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\n  }\n\n  public async createElementMultiAspect(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, baseClassKey: SchemaItemKey, displayLabel?: string, mixins?: Mixin[]): Promise<SchemaItemKey> {\n    try {\n      const baseClass = await this.getSchemaItem(baseClassKey, EntityClass);\n      if (!(await (baseClass).is(\"ElementMultiAspect\", \"BisCore\"))) {\n        throw new SchemaEditingError(ECEditingStatus.BaseClassIsNotElementMultiAspect, new ClassId(this.schemaItemType, baseClassKey));\n      }\n    } catch(e: any){\n      throw new SchemaEditingError(ECEditingStatus.CreateElement, new ClassId(this.schemaItemType, name, schemaKey), e);\n    }\n\n    return this.create(schemaKey, name, modifier, displayLabel, baseClassKey, mixins);\n  }\n\n  public async create(schemaKey: SchemaKey, name: string, modifier: ECClassModifier, displayLabel?: string, baseClassKey?: SchemaItemKey, mixins?: Mixin[]): Promise<SchemaItemKey> {\n    try {\n      const newClass = await this.createClass<EntityClass>(schemaKey, this.schemaItemType, (schema) => schema.createEntityClass.bind(schema), name, baseClassKey, modifier) as MutableEntityClass;\n\n      if (mixins !== undefined)\n        mixins.forEach((m) => newClass.addMixin(m));\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 an EntityClass through an EntityClassProps.\n   * @param schemaKey a SchemaKey of the Schema that will house the new object.\n   * @param entityProps a json object that will be used to populate the new EntityClass. Needs a name value passed in.\n   */\n  public async createFromProps(schemaKey: SchemaKey, entityProps: EntityClassProps): Promise<SchemaItemKey> {\n    try {\n      const newClass = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createEntityClass.bind(schema), entityProps);\n      return newClass.key;\n    } catch (e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new ClassId(this.schemaItemType, entityProps.name!, schemaKey), e);\n    }\n  }\n\n  public async addMixin(entityKey: SchemaItemKey, mixinKey: SchemaItemKey): Promise<void> {\n    try {\n      const entity = await this.getSchemaItem(entityKey, MutableEntityClass);\n      const mixin = await this.getSchemaItem(mixinKey, Mixin);\n      entity.addMixin(mixin);\n    } catch(e: any){\n      throw new SchemaEditingError(ECEditingStatus.AddMixin, new ClassId(SchemaItemType.EntityClass, entityKey), e);\n    }\n  }\n\n  public async createNavigationProperty(entityKey: SchemaItemKey, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<void> {\n    try {\n      const entity = await this.getSchemaItem(entityKey, MutableEntityClass);\n      await entity.createNavigationProperty(name, relationship, direction);\n    } catch(e: any) {\n      throw new SchemaEditingError(ECEditingStatus.CreateNavigationProperty, new ClassId(SchemaItemType.RelationshipClass, entityKey), e);\n    }\n  }\n\n  /**\n   * Creates a Navigation Property through a NavigationPropertyProps.\n   * @param classKey a SchemaItemKey of the Entity 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(classKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<void> {\n    try {\n      const entity = await this.getSchemaItem(classKey, MutableEntityClass);\n      const property = await entity.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.EntityClass, classKey), e);\n    }\n  }\n}\n"]}

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

@@ -0,0 +1,25 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { AnyEnumerator, Enumeration, EnumerationProps, PrimitiveType, SchemaItemKey, SchemaKey } from "@itwin/ecschema-metadata";
+import { SchemaContextEditor } from "./Editor";
+import { SchemaItems } from "./SchemaItems";
+/**
+ * @alpha
+ * A class allowing you to create schema items of type Enumeration.
+ */
+export declare class Enumerations extends SchemaItems {
+    protected get itemTypeClass(): typeof Enumeration;
+    constructor(schemaEditor: SchemaContextEditor);
+    create(schemaKey: SchemaKey, name: string, type: PrimitiveType.Integer | PrimitiveType.String, displayLabel?: string, isStrict?: boolean, enumerators?: AnyEnumerator[]): Promise<SchemaItemKey>;
+    /**
+     * Creates an Enumeration through an EnumeratorProps.
+     * @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.
+     */
+    createFromProps(schemaKey: SchemaKey, enumProps: EnumerationProps): Promise<SchemaItemKey>;
+    addEnumerator(enumerationKey: SchemaItemKey, enumerator: AnyEnumerator): Promise<void>;
+    setEnumeratorLabel(enumerationKey: SchemaItemKey, enumeratorName: string, label: string | undefined): Promise<void>;
+    setEnumeratorDescription(enumerationKey: SchemaItemKey, enumeratorName: string, description: string | undefined): Promise<void>;
+}
+//# sourceMappingURL=Enumerations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Enumerations.d.ts","sourceRoot":"","sources":["../../../src/Editing/Enumerations.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAkB,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACjJ,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAG/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAM5C;;;GAGG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C,cAAuB,aAAa,IAAI,OAAO,WAAW,CAEzD;gBAEkB,YAAY,EAAE,mBAAmB;IAIvC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAoB7M;;;;OAIG;IACU,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAS1F,aAAa,CAAC,cAAc,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBtF,kBAAkB,CAAC,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnH,wBAAwB,CAAC,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAa7I"}

package/lib/esm/Editing/Enumerations.js

@@ -0,0 +1,90 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { Enumeration, SchemaItemType } from "@itwin/ecschema-metadata";
+import { ECEditingStatus, EnumeratorId, SchemaEditingError, SchemaItemId } from "./Exception";
+import { SchemaItems } from "./SchemaItems";
+/**
+ * @alpha
+ * A class allowing you to create schema items of type Enumeration.
+ */
+export class Enumerations extends SchemaItems {
+    get itemTypeClass() {
+        return Enumeration;
+    }
+    constructor(schemaEditor) {
+        super(SchemaItemType.Enumeration, schemaEditor);
+    }
+    async create(schemaKey, name, type, displayLabel, isStrict, enumerators) {
+        try {
+            const newEnum = await this.createSchemaItem(schemaKey, this.schemaItemType, (schema) => schema.createEnumeration.bind(schema), name, type);
+            if (undefined !== isStrict)
+                newEnum.setIsStrict(isStrict);
+            if (undefined !== enumerators)
+                for (const enumerator of enumerators)
+                    await this.addEnumerator(newEnum.key, enumerator);
+            if (displayLabel)
+                newEnum.setDisplayLabel(displayLabel);
+            return newEnum.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFailed, new SchemaItemId(this.schemaItemType, name, schemaKey), e);
+        }
+    }
+    /**
+     * Creates an Enumeration through an EnumeratorProps.
+     * @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, enumProps) {
+        try {
+            const newEnum = await this.createSchemaItemFromProps(schemaKey, this.schemaItemType, (schema) => schema.createEnumeration.bind(schema), enumProps);
+            return newEnum.key;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.CreateSchemaItemFromProps, new SchemaItemId(this.schemaItemType, enumProps.name, schemaKey), e);
+        }
+    }
+    async addEnumerator(enumerationKey, enumerator) {
+        try {
+            const enumeration = await this.getSchemaItem(enumerationKey, Enumeration);
+            if (enumeration.isInt && typeof (enumerator.value) !== "number")
+                throw new SchemaEditingError(ECEditingStatus.InvalidEnumeratorType, new EnumeratorId(enumerator, enumeration));
+            if (enumeration.isString && typeof (enumerator.value) !== "string")
+                throw new SchemaEditingError(ECEditingStatus.InvalidEnumeratorType, new EnumeratorId(enumerator, enumeration));
+            enumeration.addEnumerator(enumerator);
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.AddEnumerator, new SchemaItemId(this.schemaItemType, enumerationKey), e);
+        }
+    }
+    async setEnumeratorLabel(enumerationKey, enumeratorName, label) {
+        try {
+            const enumeration = await this.getSchemaItem(enumerationKey, Enumeration);
+            const enumerator = enumeration.getEnumeratorByName(enumeratorName);
+            if (enumerator === undefined)
+                throw new SchemaEditingError(ECEditingStatus.EnumeratorDoesNotExist, new EnumeratorId(enumeratorName, enumeration));
+            enumerator.label = label;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.SetEnumeratorLabel, new SchemaItemId(this.schemaItemType, enumerationKey), e);
+        }
+    }
+    async setEnumeratorDescription(enumerationKey, enumeratorName, description) {
+        try {
+            const enumeration = await this.getSchemaItem(enumerationKey, Enumeration);
+            const enumerator = enumeration.getEnumeratorByName(enumeratorName);
+            if (enumerator === undefined)
+                throw new SchemaEditingError(ECEditingStatus.EnumeratorDoesNotExist, new EnumeratorId(enumeratorName, enumeration));
+            enumerator.description = description;
+        }
+        catch (e) {
+            throw new SchemaEditingError(ECEditingStatus.SetEnumeratorLabel, new SchemaItemId(this.schemaItemType, enumerationKey), e);
+        }
+    }
+}
+//# sourceMappingURL=Enumerations.js.map