@itwin/ecschema-editing 3.5.3 → 3.5.4

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

@@ -1,113 +1,113 @@
-/** @packageDocumentation
- * @module Editing
- */
-import { CustomAttribute, Schema, SchemaContext, SchemaItemKey, SchemaKey } from "@itwin/ecschema-metadata";
-import { MutableSchema } from "./Mutable/MutableSchema";
-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";
-/**
- * @alpha
- */
-export interface SchemaEditResults {
-    schemaKey?: SchemaKey;
-    errorMessage?: string;
-}
-/**
- * @alpha
- */
-export interface SchemaItemEditResults {
-    itemKey?: SchemaItemKey;
-    errorMessage?: string;
-}
-/**
- * @alpha
- */
-export interface PropertyEditResults {
-    itemKey?: SchemaItemKey;
-    propertyName?: string;
-    errorMessage?: string;
-}
-/**
- * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.
- * @alpha
- */
-export declare class SchemaContextEditor {
-    private _schemaContext;
-    readonly entities: Entities;
-    readonly mixins: Mixins;
-    readonly structs: Structs;
-    readonly customAttributes: CustomAttributes;
-    readonly relationships: RelationshipClasses;
-    readonly constants: Constants;
-    readonly enumerations: Enumerations;
-    readonly formats: Formats;
-    readonly kindOfQuantities: KindOfQuantities;
-    readonly units: Units;
-    readonly phenomenons: Phenomena;
-    readonly unitSystems: UnitSystems;
-    readonly propertyCategories: PropertyCategories;
-    readonly invertedUnits: InvertedUnits;
-    /**
-     * Creates a new SchemaContextEditor instance.
-     * @param schemaContext The SchemaContext the Editor will use to edit in.
-     */
-    constructor(schemaContext: SchemaContext);
-    /** Allows you to get schema classes and items through regular SchemaContext methods. */
-    get schemaContext(): SchemaContext;
-    finish(): Promise<SchemaContext>;
-    /**
-     * Helper method for retrieving a schema, previously added, from the SchemaContext.
-     * @param schemaKey The SchemaKey identifying the schema.
-    */
-    getSchema(schemaKey: SchemaKey): Promise<MutableSchema>;
-    /**
-     * 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 a SchemaEditResults object.
-     */
-    createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaEditResults>;
-    /**
-     * Adds a referenced schema to the schema identified by the given SchemaKey.
-     * @param schemaKey The SchemaKey identifying the schema.
-     * @param refSchema The referenced schema to add.
-     */
-    addSchemaReference(schemaKey: SchemaKey, refSchema: Schema): Promise<SchemaEditResults>;
-    /**
-     * Adds a CustomAttribute instance to the schema identified by the given SchemaKey
-     * @param schemaKey The SchemaKey identifying the schema.
-     * @param customAttribute The CustomAttribute instance to add.
-     */
-    addCustomAttribute(schemaKey: SchemaKey, customAttribute: CustomAttribute): Promise<SchemaEditResults>;
-    /**
-     * 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.
-     */
-    setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaEditResults>;
-    /**
-     * Increments the minor version of a schema.
-     * @param schemaKey The SchemaKey identifying the schema.
-     */
-    incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaEditResults>;
-    private removeReference;
-    private removeCustomAttribute;
-}
+/** @packageDocumentation
+ * @module Editing
+ */
+import { CustomAttribute, Schema, SchemaContext, SchemaItemKey, SchemaKey } from "@itwin/ecschema-metadata";
+import { MutableSchema } from "./Mutable/MutableSchema";
+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";
+/**
+ * @alpha
+ */
+export interface SchemaEditResults {
+    schemaKey?: SchemaKey;
+    errorMessage?: string;
+}
+/**
+ * @alpha
+ */
+export interface SchemaItemEditResults {
+    itemKey?: SchemaItemKey;
+    errorMessage?: string;
+}
+/**
+ * @alpha
+ */
+export interface PropertyEditResults {
+    itemKey?: SchemaItemKey;
+    propertyName?: string;
+    errorMessage?: string;
+}
+/**
+ * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.
+ * @alpha
+ */
+export declare class SchemaContextEditor {
+    private _schemaContext;
+    readonly entities: Entities;
+    readonly mixins: Mixins;
+    readonly structs: Structs;
+    readonly customAttributes: CustomAttributes;
+    readonly relationships: RelationshipClasses;
+    readonly constants: Constants;
+    readonly enumerations: Enumerations;
+    readonly formats: Formats;
+    readonly kindOfQuantities: KindOfQuantities;
+    readonly units: Units;
+    readonly phenomenons: Phenomena;
+    readonly unitSystems: UnitSystems;
+    readonly propertyCategories: PropertyCategories;
+    readonly invertedUnits: InvertedUnits;
+    /**
+     * Creates a new SchemaContextEditor instance.
+     * @param schemaContext The SchemaContext the Editor will use to edit in.
+     */
+    constructor(schemaContext: SchemaContext);
+    /** Allows you to get schema classes and items through regular SchemaContext methods. */
+    get schemaContext(): SchemaContext;
+    finish(): Promise<SchemaContext>;
+    /**
+     * Helper method for retrieving a schema, previously added, from the SchemaContext.
+     * @param schemaKey The SchemaKey identifying the schema.
+    */
+    getSchema(schemaKey: SchemaKey): Promise<MutableSchema>;
+    /**
+     * 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 a SchemaEditResults object.
+     */
+    createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaEditResults>;
+    /**
+     * Adds a referenced schema to the schema identified by the given SchemaKey.
+     * @param schemaKey The SchemaKey identifying the schema.
+     * @param refSchema The referenced schema to add.
+     */
+    addSchemaReference(schemaKey: SchemaKey, refSchema: Schema): Promise<SchemaEditResults>;
+    /**
+     * Adds a CustomAttribute instance to the schema identified by the given SchemaKey
+     * @param schemaKey The SchemaKey identifying the schema.
+     * @param customAttribute The CustomAttribute instance to add.
+     */
+    addCustomAttribute(schemaKey: SchemaKey, customAttribute: CustomAttribute): Promise<SchemaEditResults>;
+    /**
+     * 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.
+     */
+    setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaEditResults>;
+    /**
+     * Increments the minor version of a schema.
+     * @param schemaKey The SchemaKey identifying the schema.
+     */
+    incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaEditResults>;
+    private removeReference;
+    private removeCustomAttribute;
+}
 //# sourceMappingURL=Editor.d.ts.map

package/lib/cjs/Editing/Editor.js

@@ -1,167 +1,167 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Editing
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaContextEditor = void 0;
-const Rules = require("../Validation/ECRules");
-const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
-const core_bentley_1 = require("@itwin/core-bentley");
-const Constants_1 = require("./Constants");
-const CustomAttributes_1 = require("./CustomAttributes");
-const Entities_1 = require("./Entities");
-const Enumerations_1 = require("./Enumerations");
-const Formats_1 = require("./Formats");
-const InvertedUnits_1 = require("./InvertedUnits");
-const KindOfQuantities_1 = require("./KindOfQuantities");
-const Mixins_1 = require("./Mixins");
-const Phenomena_1 = require("./Phenomena");
-const PropertyCategories_1 = require("./PropertyCategories");
-const RelationshipClasses_1 = require("./RelationshipClasses");
-const Structs_1 = require("./Structs");
-const Units_1 = require("./Units");
-const UnitSystems_1 = require("./UnitSystems");
-/**
- * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.
- * @alpha
- */
-class SchemaContextEditor {
-    /**
-     * Creates a new SchemaContextEditor instance.
-     * @param schemaContext The SchemaContext the Editor will use to edit in.
-     */
-    constructor(schemaContext) {
-        this.entities = new Entities_1.Entities(this);
-        this.mixins = new Mixins_1.Mixins(this);
-        this.structs = new Structs_1.Structs(this);
-        this.customAttributes = new CustomAttributes_1.CustomAttributes(this);
-        this.relationships = new RelationshipClasses_1.RelationshipClasses(this);
-        this.constants = new Constants_1.Constants(this);
-        this.enumerations = new Enumerations_1.Enumerations(this);
-        this.formats = new Formats_1.Formats(this);
-        this.kindOfQuantities = new KindOfQuantities_1.KindOfQuantities(this);
-        this.units = new Units_1.Units(this);
-        this.phenomenons = new Phenomena_1.Phenomena(this);
-        this.unitSystems = new UnitSystems_1.UnitSystems(this);
-        this.propertyCategories = new PropertyCategories_1.PropertyCategories(this);
-        this.invertedUnits = new InvertedUnits_1.InvertedUnits(this);
-        // 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.
-    */
-    async getSchema(schemaKey) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
-        if (schema === undefined)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema, `Schema Key ${schemaKey.toString(true)} not found in context`);
-        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 a SchemaEditResults object.
-     */
-    async createSchema(name, alias, readVersion, writeVersion, minorVersion) {
-        const newSchema = new ecschema_metadata_1.Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);
-        await this._schemaContext.addSchema(newSchema);
-        return { schemaKey: newSchema.schemaKey };
-    }
-    /**
-     * 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) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact));
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        await schema.addReference(refSchema);
-        const diagnostics = Rules.validateSchemaReferences(schema);
-        const result = { errorMessage: "" };
-        for await (const diagnostic of diagnostics) {
-            result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
-        }
-        if (result.errorMessage) {
-            this.removeReference(schema, refSchema);
-            return result;
-        }
-        if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {
-            await this.schemaContext.addSchema(refSchema);
-        }
-        return {};
-    }
-    /**
-     * 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) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        schema.addCustomAttribute(customAttribute);
-        const diagnostics = Rules.validateCustomAttributeInstance(schema, customAttribute);
-        const result = { errorMessage: "" };
-        for await (const diagnostic of diagnostics) {
-            result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
-        }
-        if (result.errorMessage) {
-            this.removeCustomAttribute(schema, customAttribute);
-            return result;
-        }
-        return {};
-    }
-    /**
-     * 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.
-     */
-    async setVersion(schemaKey, readVersion, writeVersion, minorVersion) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);
-        return {};
-    }
-    /**
-     * Increments the minor version of a schema.
-     * @param schemaKey The SchemaKey identifying the schema.
-     */
-    async incrementMinorVersion(schemaKey) {
-        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
-        if (schema === undefined)
-            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
-        schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);
-        return {};
-    }
-    removeReference(schema, refSchema) {
-        const index = schema.references.indexOf(refSchema);
-        if (index !== -1) {
-            schema.references.splice(index, 1);
-        }
-    }
-    removeCustomAttribute(schema, customAttribute) {
-        (0, core_bentley_1.assert)(schema.customAttributes !== undefined);
-        const map = schema.customAttributes;
-        map.delete(customAttribute.className);
-    }
-}
-exports.SchemaContextEditor = SchemaContextEditor;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Editing
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaContextEditor = void 0;
+const Rules = require("../Validation/ECRules");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const core_bentley_1 = require("@itwin/core-bentley");
+const Constants_1 = require("./Constants");
+const CustomAttributes_1 = require("./CustomAttributes");
+const Entities_1 = require("./Entities");
+const Enumerations_1 = require("./Enumerations");
+const Formats_1 = require("./Formats");
+const InvertedUnits_1 = require("./InvertedUnits");
+const KindOfQuantities_1 = require("./KindOfQuantities");
+const Mixins_1 = require("./Mixins");
+const Phenomena_1 = require("./Phenomena");
+const PropertyCategories_1 = require("./PropertyCategories");
+const RelationshipClasses_1 = require("./RelationshipClasses");
+const Structs_1 = require("./Structs");
+const Units_1 = require("./Units");
+const UnitSystems_1 = require("./UnitSystems");
+/**
+ * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.
+ * @alpha
+ */
+class SchemaContextEditor {
+    /**
+     * Creates a new SchemaContextEditor instance.
+     * @param schemaContext The SchemaContext the Editor will use to edit in.
+     */
+    constructor(schemaContext) {
+        this.entities = new Entities_1.Entities(this);
+        this.mixins = new Mixins_1.Mixins(this);
+        this.structs = new Structs_1.Structs(this);
+        this.customAttributes = new CustomAttributes_1.CustomAttributes(this);
+        this.relationships = new RelationshipClasses_1.RelationshipClasses(this);
+        this.constants = new Constants_1.Constants(this);
+        this.enumerations = new Enumerations_1.Enumerations(this);
+        this.formats = new Formats_1.Formats(this);
+        this.kindOfQuantities = new KindOfQuantities_1.KindOfQuantities(this);
+        this.units = new Units_1.Units(this);
+        this.phenomenons = new Phenomena_1.Phenomena(this);
+        this.unitSystems = new UnitSystems_1.UnitSystems(this);
+        this.propertyCategories = new PropertyCategories_1.PropertyCategories(this);
+        this.invertedUnits = new InvertedUnits_1.InvertedUnits(this);
+        // 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.
+    */
+    async getSchema(schemaKey) {
+        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
+        if (schema === undefined)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema, `Schema Key ${schemaKey.toString(true)} not found in context`);
+        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 a SchemaEditResults object.
+     */
+    async createSchema(name, alias, readVersion, writeVersion, minorVersion) {
+        const newSchema = new ecschema_metadata_1.Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);
+        await this._schemaContext.addSchema(newSchema);
+        return { schemaKey: newSchema.schemaKey };
+    }
+    /**
+     * 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) {
+        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact));
+        if (schema === undefined)
+            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
+        await schema.addReference(refSchema);
+        const diagnostics = Rules.validateSchemaReferences(schema);
+        const result = { errorMessage: "" };
+        for await (const diagnostic of diagnostics) {
+            result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
+        }
+        if (result.errorMessage) {
+            this.removeReference(schema, refSchema);
+            return result;
+        }
+        if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {
+            await this.schemaContext.addSchema(refSchema);
+        }
+        return {};
+    }
+    /**
+     * 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) {
+        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
+        if (schema === undefined)
+            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
+        schema.addCustomAttribute(customAttribute);
+        const diagnostics = Rules.validateCustomAttributeInstance(schema, customAttribute);
+        const result = { errorMessage: "" };
+        for await (const diagnostic of diagnostics) {
+            result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\r\n`;
+        }
+        if (result.errorMessage) {
+            this.removeCustomAttribute(schema, customAttribute);
+            return result;
+        }
+        return {};
+    }
+    /**
+     * 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.
+     */
+    async setVersion(schemaKey, readVersion, writeVersion, minorVersion) {
+        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
+        if (schema === undefined)
+            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
+        schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);
+        return {};
+    }
+    /**
+     * Increments the minor version of a schema.
+     * @param schemaKey The SchemaKey identifying the schema.
+     */
+    async incrementMinorVersion(schemaKey) {
+        const schema = (await this.schemaContext.getCachedSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Latest));
+        if (schema === undefined)
+            return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };
+        schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);
+        return {};
+    }
+    removeReference(schema, refSchema) {
+        const index = schema.references.indexOf(refSchema);
+        if (index !== -1) {
+            schema.references.splice(index, 1);
+        }
+    }
+    removeCustomAttribute(schema, customAttribute) {
+        (0, core_bentley_1.assert)(schema.customAttributes !== undefined);
+        const map = schema.customAttributes;
+        map.delete(customAttribute.className);
+    }
+}
+exports.SchemaContextEditor = SchemaContextEditor;
 //# sourceMappingURL=Editor.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Editor.js","sourceRoot":"","sources":["../../../src/Editing/Editor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+CAA+C;AAC/C,gEAA8J;AAE9J,sDAA6C;AAC7C,2CAAwC;AACxC,yDAAsD;AACtD,yCAAsC;AACtC,iDAA8C;AAC9C,uCAAoC;AACpC,mDAAgD;AAChD,yDAAsD;AACtD,qCAAkC;AAClC,2CAAwC;AACxC,6DAA0D;AAC1D,+DAA4D;AAC5D,uCAAoC;AACpC,mCAAgC;AAChC,+CAA4C;AA6B5C;;;GAGG;AACH,MAAa,mBAAmB;IAiB9B;;;OAGG;IACH,YAAY,aAA4B;QAnBxB,aAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,WAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,YAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,qBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,kBAAa,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,cAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAChC,iBAAY,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;QACtC,YAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,qBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,UAAK,GAAG,IAAI,aAAK,CAAC,IAAI,CAAC,CAAC;QACxB,gBAAW,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAClC,gBAAW,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,CAAC;QACpC,uBAAkB,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,CAAC;QAClD,kBAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAOtD,kBAAkB;QAClB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED,wFAAwF;IACxF,IAAW,aAAa,KAAoB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAElE,KAAK,CAAC,MAAM;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;MAGE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB;QACzC,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5G,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAC,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAE/H,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,KAAa,EAAE,WAAmB,EAAE,YAAoB,EAAE,YAAoB;QACpH,MAAM,SAAS,GAAG,IAAI,0BAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QACxG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC/C,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,SAAoB,EAAE,SAAiB;QACrE,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3G,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,WAAW,GAAG,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAE3D,MAAM,MAAM,GAAsB,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;YAC1C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;SAC5E;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACxC,OAAO,MAAM,CAAC;SACf;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YAClE,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SAC/C;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,SAAoB,EAAE,eAAgC;QACpF,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5G,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAE3C,MAAM,WAAW,GAAG,KAAK,CAAC,+BAA+B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAEnF,MAAM,MAAM,GAAsB,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;YAC1C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;SAC5E;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;YACpD,OAAO,MAAM,CAAC;SACf;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,SAAoB,EAAE,WAAoB,EAAE,YAAqB,EAAE,YAAqB;QAC9G,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7F,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,UAAU,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,EAAE,YAAY,IAAI,MAAM,CAAC,YAAY,EAAE,YAAY,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/H,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,SAAoB;QACrD,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7F,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACpF,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,eAAe,CAAC,MAAc,EAAE,SAAiB;QACvD,MAAM,KAAK,GAAW,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACpC;IACH,CAAC;IAEO,qBAAqB,CAAC,MAAc,EAAE,eAAgC;QAC5E,IAAA,qBAAM,EAAC,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,MAAM,CAAC,gBAAgD,CAAC;QACpE,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;CACF;AA7JD,kDA6JC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Editing\r\n */\r\n\r\nimport * as Rules from \"../Validation/ECRules\";\r\nimport { CustomAttribute, ECObjectsError, ECObjectsStatus, Schema, SchemaContext, SchemaItemKey, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { MutableSchema } from \"./Mutable/MutableSchema\";\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { Constants } from \"./Constants\";\r\nimport { CustomAttributes } from \"./CustomAttributes\";\r\nimport { Entities } from \"./Entities\";\r\nimport { Enumerations } from \"./Enumerations\";\r\nimport { Formats } from \"./Formats\";\r\nimport { InvertedUnits } from \"./InvertedUnits\";\r\nimport { KindOfQuantities } from \"./KindOfQuantities\";\r\nimport { Mixins } from \"./Mixins\";\r\nimport { Phenomena } from \"./Phenomena\";\r\nimport { PropertyCategories } from \"./PropertyCategories\";\r\nimport { RelationshipClasses } from \"./RelationshipClasses\";\r\nimport { Structs } from \"./Structs\";\r\nimport { Units } from \"./Units\";\r\nimport { UnitSystems } from \"./UnitSystems\";\r\n\r\n// We can either add validation in Editor, or in the protected methods of Schema.\r\n// TODO: Add an error code so we can do something programmatic with the error.\r\n/**\r\n * @alpha\r\n */\r\nexport interface SchemaEditResults {\r\n  schemaKey?: SchemaKey;\r\n  errorMessage?: string;\r\n}\r\n\r\n/**\r\n * @alpha\r\n */\r\nexport interface SchemaItemEditResults {\r\n  itemKey?: SchemaItemKey;\r\n  errorMessage?: string;\r\n}\r\n\r\n/**\r\n * @alpha\r\n */\r\nexport interface PropertyEditResults {\r\n  itemKey?: SchemaItemKey;\r\n  propertyName?: string;\r\n  errorMessage?: string;\r\n}\r\n\r\n/**\r\n * A class that allows you to edit and create schemas, classes, and items from the SchemaContext level.\r\n * @alpha\r\n */\r\nexport class SchemaContextEditor {\r\n  private _schemaContext: SchemaContext;\r\n  public readonly entities = new Entities(this);\r\n  public readonly mixins = new Mixins(this);\r\n  public readonly structs = new Structs(this);\r\n  public readonly customAttributes = new CustomAttributes(this);\r\n  public readonly relationships = new RelationshipClasses(this);\r\n  public readonly constants = new Constants(this);\r\n  public readonly enumerations = new Enumerations(this);\r\n  public readonly formats = new Formats(this);\r\n  public readonly kindOfQuantities = new KindOfQuantities(this);\r\n  public readonly units = new Units(this);\r\n  public readonly phenomenons = new Phenomena(this);\r\n  public readonly unitSystems = new UnitSystems(this);\r\n  public readonly propertyCategories = new PropertyCategories(this);\r\n  public readonly invertedUnits = new InvertedUnits(this);\r\n\r\n  /**\r\n   * Creates a new SchemaContextEditor instance.\r\n   * @param schemaContext The SchemaContext the Editor will use to edit in.\r\n   */\r\n  constructor(schemaContext: SchemaContext) {\r\n    // TODO: Make copy\r\n    this._schemaContext = schemaContext;\r\n  }\r\n\r\n  /** Allows you to get schema classes and items through regular SchemaContext methods. */\r\n  public get schemaContext(): SchemaContext { return this._schemaContext; }\r\n\r\n  public async finish(): Promise<SchemaContext> {\r\n    return this._schemaContext;\r\n  }\r\n\r\n  /**\r\n   * Helper method for retrieving a schema, previously added, from the SchemaContext.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n  */\r\n  public async getSchema(schemaKey: SchemaKey): Promise<MutableSchema> {\r\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Latest));\r\n    if (schema === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema,`Schema Key ${schemaKey.toString(true)} not found in context`);\r\n\r\n    return schema;\r\n  }\r\n  /**\r\n   * Creates a Schema with the given properties and adds it to the current schema context.\r\n   * @param name The name given to the new schema.\r\n   * @param alias The alias of the new schema.\r\n   * @param readVersion The read version number of the schema.\r\n   * @param writeVersion The write version number of the schema.\r\n   * @param minorVersion The minor version number of the schema.\r\n   * @returns Resolves to a SchemaEditResults object.\r\n   */\r\n  public async createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaEditResults> {\r\n    const newSchema = new Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);\r\n    await this._schemaContext.addSchema(newSchema);\r\n    return { schemaKey: newSchema.schemaKey };\r\n  }\r\n\r\n  /**\r\n   * Adds a referenced schema to the schema identified by the given SchemaKey.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param refSchema The referenced schema to add.\r\n   */\r\n  public async addSchemaReference(schemaKey: SchemaKey, refSchema: Schema): Promise<SchemaEditResults> {\r\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Exact));\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\r\n\r\n    await schema.addReference(refSchema);\r\n    const diagnostics = Rules.validateSchemaReferences(schema);\r\n\r\n    const result: SchemaEditResults = { errorMessage: \"\" };\r\n    for await (const diagnostic of diagnostics) {\r\n      result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\r\n    }\r\n\r\n    if (result.errorMessage) {\r\n      this.removeReference(schema, refSchema);\r\n      return result;\r\n    }\r\n\r\n    if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {\r\n      await this.schemaContext.addSchema(refSchema);\r\n    }\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Adds a CustomAttribute instance to the schema identified by the given SchemaKey\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param customAttribute The CustomAttribute instance to add.\r\n   */\r\n  public async addCustomAttribute(schemaKey: SchemaKey, customAttribute: CustomAttribute): Promise<SchemaEditResults> {\r\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Latest));\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\r\n\r\n    schema.addCustomAttribute(customAttribute);\r\n\r\n    const diagnostics = Rules.validateCustomAttributeInstance(schema, customAttribute);\r\n\r\n    const result: SchemaEditResults = { errorMessage: \"\" };\r\n    for await (const diagnostic of diagnostics) {\r\n      result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\r\n    }\r\n\r\n    if (result.errorMessage) {\r\n      this.removeCustomAttribute(schema, customAttribute);\r\n      return result;\r\n    }\r\n\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Sets the schema version.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   * @param readVersion The read version of the schema. If not specified, the existing read version will be maintained.\r\n   * @param writeVersion The write version of the schema. If not specified, the existing write version will be maintained.\r\n   * @param minorVersion The minor version of the schema. If not specified, the existing minor version will be maintained.\r\n   */\r\n  public async setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaEditResults> {\r\n    const schema = (await this.schemaContext.getCachedSchema(schemaKey, SchemaMatchType.Latest));\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\r\n\r\n    schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);\r\n    return {};\r\n  }\r\n\r\n  /**\r\n   * Increments the minor version of a schema.\r\n   * @param schemaKey The SchemaKey identifying the schema.\r\n   */\r\n  public async incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaEditResults> {\r\n    const schema = (await this.schemaContext.getCachedSchema(schemaKey, SchemaMatchType.Latest));\r\n    if (schema === undefined)\r\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\r\n\r\n    schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);\r\n    return {};\r\n  }\r\n\r\n  private removeReference(schema: Schema, refSchema: Schema) {\r\n    const index: number = schema.references.indexOf(refSchema);\r\n    if (index !== -1) {\r\n      schema.references.splice(index, 1);\r\n    }\r\n  }\r\n\r\n  private removeCustomAttribute(schema: Schema, customAttribute: CustomAttribute) {\r\n    assert(schema.customAttributes !== undefined);\r\n    const map = schema.customAttributes as Map<string, CustomAttribute>;\r\n    map.delete(customAttribute.className);\r\n  }\r\n}\r\n\r\n"]}
+{"version":3,"file":"Editor.js","sourceRoot":"","sources":["../../../src/Editing/Editor.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+CAA+C;AAC/C,gEAA8J;AAE9J,sDAA6C;AAC7C,2CAAwC;AACxC,yDAAsD;AACtD,yCAAsC;AACtC,iDAA8C;AAC9C,uCAAoC;AACpC,mDAAgD;AAChD,yDAAsD;AACtD,qCAAkC;AAClC,2CAAwC;AACxC,6DAA0D;AAC1D,+DAA4D;AAC5D,uCAAoC;AACpC,mCAAgC;AAChC,+CAA4C;AA6B5C;;;GAGG;AACH,MAAa,mBAAmB;IAiB9B;;;OAGG;IACH,YAAY,aAA4B;QAnBxB,aAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,WAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC;QAC1B,YAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,qBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,kBAAa,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,cAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAChC,iBAAY,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,CAAC;QACtC,YAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,qBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,CAAC;QAC9C,UAAK,GAAG,IAAI,aAAK,CAAC,IAAI,CAAC,CAAC;QACxB,gBAAW,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,CAAC;QAClC,gBAAW,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,CAAC;QACpC,uBAAkB,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,CAAC;QAClD,kBAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAOtD,kBAAkB;QAClB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED,wFAAwF;IACxF,IAAW,aAAa,KAAoB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAElE,KAAK,CAAC,MAAM;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;MAGE;IACK,KAAK,CAAC,SAAS,CAAC,SAAoB;QACzC,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5G,IAAI,MAAM,KAAK,SAAS;YACtB,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAC,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAE/H,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,KAAa,EAAE,WAAmB,EAAE,YAAoB,EAAE,YAAoB;QACpH,MAAM,SAAS,GAAG,IAAI,0BAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QACxG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC/C,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,SAAoB,EAAE,SAAiB;QACrE,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3G,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,WAAW,GAAG,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAE3D,MAAM,MAAM,GAAsB,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;YAC1C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;SAC5E;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACxC,OAAO,MAAM,CAAC;SACf;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YAClE,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;SAC/C;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,kBAAkB,CAAC,SAAoB,EAAE,eAAgC;QACpF,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAgB,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5G,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QAE3C,MAAM,WAAW,GAAG,KAAK,CAAC,+BAA+B,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAEnF,MAAM,MAAM,GAAsB,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QACvD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;YAC1C,MAAM,CAAC,YAAY,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,WAAW,MAAM,CAAC;SAC5E;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;YACpD,OAAO,MAAM,CAAC;SACf;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,SAAoB,EAAE,WAAoB,EAAE,YAAqB,EAAE,YAAqB;QAC9G,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7F,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,UAAU,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,EAAE,YAAY,IAAI,MAAM,CAAC,YAAY,EAAE,YAAY,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/H,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,SAAoB;QACrD,MAAM,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,SAAS,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7F,IAAI,MAAM,KAAK,SAAS;YACtB,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzF,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACpF,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,eAAe,CAAC,MAAc,EAAE,SAAiB;QACvD,MAAM,KAAK,GAAW,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACpC;IACH,CAAC;IAEO,qBAAqB,CAAC,MAAc,EAAE,eAAgC;QAC5E,IAAA,qBAAM,EAAC,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,MAAM,CAAC,gBAAgD,CAAC;QACpE,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;CACF;AA7JD,kDA6JC","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, Schema, SchemaContext, SchemaItemKey, SchemaKey, SchemaMatchType } 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\";\n\n// We can either add validation in Editor, or in the protected methods of Schema.\n// TODO: Add an error code so we can do something programmatic with the error.\n/**\n * @alpha\n */\nexport interface SchemaEditResults {\n  schemaKey?: SchemaKey;\n  errorMessage?: string;\n}\n\n/**\n * @alpha\n */\nexport interface SchemaItemEditResults {\n  itemKey?: SchemaItemKey;\n  errorMessage?: string;\n}\n\n/**\n * @alpha\n */\nexport interface PropertyEditResults {\n  itemKey?: SchemaItemKey;\n  propertyName?: string;\n  errorMessage?: string;\n}\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 { return this._schemaContext; }\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  */\n  public async getSchema(schemaKey: SchemaKey): Promise<MutableSchema> {\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Latest));\n    if (schema === undefined)\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema,`Schema Key ${schemaKey.toString(true)} not found in context`);\n\n    return schema;\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 a SchemaEditResults object.\n   */\n  public async createSchema(name: string, alias: string, readVersion: number, writeVersion: number, minorVersion: number): Promise<SchemaEditResults> {\n    const newSchema = new Schema(this._schemaContext, name, alias, readVersion, writeVersion, minorVersion);\n    await this._schemaContext.addSchema(newSchema);\n    return { schemaKey: 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<SchemaEditResults> {\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Exact));\n    if (schema === undefined)\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    await schema.addReference(refSchema);\n    const diagnostics = Rules.validateSchemaReferences(schema);\n\n    const result: SchemaEditResults = { errorMessage: \"\" };\n    for await (const diagnostic of diagnostics) {\n      result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\n    }\n\n    if (result.errorMessage) {\n      this.removeReference(schema, refSchema);\n      return result;\n    }\n\n    if (!await this.schemaContext.getCachedSchema(refSchema.schemaKey)) {\n      await this.schemaContext.addSchema(refSchema);\n    }\n\n    return {};\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<SchemaEditResults> {\n    const schema = (await this.schemaContext.getCachedSchema<MutableSchema>(schemaKey, SchemaMatchType.Latest));\n    if (schema === undefined)\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    schema.addCustomAttribute(customAttribute);\n\n    const diagnostics = Rules.validateCustomAttributeInstance(schema, customAttribute);\n\n    const result: SchemaEditResults = { errorMessage: \"\" };\n    for await (const diagnostic of diagnostics) {\n      result.errorMessage += `${diagnostic.code}: ${diagnostic.messageText}\\r\\n`;\n    }\n\n    if (result.errorMessage) {\n      this.removeCustomAttribute(schema, customAttribute);\n      return result;\n    }\n\n    return {};\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   */\n  public async setVersion(schemaKey: SchemaKey, readVersion?: number, writeVersion?: number, minorVersion?: number): Promise<SchemaEditResults> {\n    const schema = (await this.schemaContext.getCachedSchema(schemaKey, SchemaMatchType.Latest));\n    if (schema === undefined)\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    schema.setVersion(readVersion || schema.readVersion, writeVersion || schema.writeVersion, minorVersion || schema.minorVersion);\n    return {};\n  }\n\n  /**\n   * Increments the minor version of a schema.\n   * @param schemaKey The SchemaKey identifying the schema.\n   */\n  public async incrementMinorVersion(schemaKey: SchemaKey): Promise<SchemaEditResults> {\n    const schema = (await this.schemaContext.getCachedSchema(schemaKey, SchemaMatchType.Latest));\n    if (schema === undefined)\n      return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    schema.setVersion(schema.readVersion, schema.writeVersion, schema.minorVersion + 1);\n    return {};\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\n"]}