Merge branch 'master' into native/4.5.4

common/changes/@itwin/ecschema-editing/ecschema-merging-PropertyMerger_2024-02-26-14-22.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/ecschema-editing",
+      "comment": "Added navigation property merging",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/ecschema-editing"
+}

common/config/rush/version-policies.json

@@ -2,7 +2,7 @@
   {
     "policyName": "prerelease-monorepo-lockStep",
     "definitionName": "lockStepVersion",
-    "version": "4.5.0-dev.18",
+    "version": "4.5.0-dev.19",
     "nextBump": "prerelease"
   }
 ]

core/backend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-backend",
-  "version": "4.5.0-dev.18",
+  "version": "4.5.0-dev.19",
   "description": "iTwin.js backend components",
   "main": "lib/cjs/core-backend.js",
   "typings": "lib/cjs/core-backend",
@@ -44,9 +44,9 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "workspace:^4.5.0-dev.18",
-    "@itwin/core-common": "workspace:^4.5.0-dev.18",
-    "@itwin/core-geometry": "workspace:^4.5.0-dev.18",
+    "@itwin/core-bentley": "workspace:^4.5.0-dev.19",
+    "@itwin/core-common": "workspace:^4.5.0-dev.19",
+    "@itwin/core-geometry": "workspace:^4.5.0-dev.19",
     "@opentelemetry/api": "^1.0.4"
   },
   "peerDependenciesMeta": {

core/bentley/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-bentley",
-  "version": "4.5.0-dev.18",
+  "version": "4.5.0-dev.19",
   "description": "Bentley JavaScript core components",
   "main": "lib/cjs/core-bentley.js",
   "module": "lib/esm/core-bentley.js",

core/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-common",
-  "version": "4.5.0-dev.18",
+  "version": "4.5.0-dev.19",
   "description": "iTwin.js components common to frontend and backend",
   "main": "lib/cjs/core-common.js",
   "module": "lib/esm/core-common.js",
@@ -40,8 +40,8 @@
     "js-base64": "^3.6.1"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "workspace:^4.5.0-dev.18",
-    "@itwin/core-geometry": "workspace:^4.5.0-dev.18"
+    "@itwin/core-bentley": "workspace:^4.5.0-dev.19",
+    "@itwin/core-geometry": "workspace:^4.5.0-dev.19"
   },
   "devDependencies": {
     "@itwin/build-tools": "workspace:*",

core/ecschema-editing/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/ecschema-editing",
-  "version": "4.5.0-dev.18",
+  "version": "4.5.0-dev.19",
   "description": "ECSchema editing and validation API",
   "license": "MIT",
   "main": "lib/cjs/ecschema-editing.js",
@@ -62,9 +62,9 @@
     "typescript": "~5.0.2"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "workspace:^4.5.0-dev.18",
-    "@itwin/core-quantity": "workspace:^4.5.0-dev.18",
-    "@itwin/ecschema-metadata": "workspace:^4.5.0-dev.18"
+    "@itwin/core-bentley": "workspace:^4.5.0-dev.19",
+    "@itwin/core-quantity": "workspace:^4.5.0-dev.19",
+    "@itwin/ecschema-metadata": "workspace:^4.5.0-dev.19"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc"

core/ecschema-editing/src/Editing/ECClasses.ts

@@ -9,8 +9,9 @@
 import {
   CustomAttribute,
   CustomAttributeContainerProps,
+  DelayedPromiseWithProps,
   ECClass, ECName, ECObjectsError, ECObjectsStatus, Enumeration, EnumerationPropertyProps, PrimitiveArrayPropertyProps,
-  PrimitivePropertyProps, PrimitiveType, SchemaItemKey, SchemaItemType, StructArrayPropertyProps,
+  PrimitivePropertyProps, PrimitiveType, PropertyCategory, SchemaItemKey, SchemaItemType, StructArrayPropertyProps,
   StructClass, StructPropertyProps,
 } from "@itwin/ecschema-metadata";
 import { assert } from "@itwin/core-bentley";
@@ -386,6 +387,34 @@ export class ECClasses {
     return {};
   }
 
+  /**
+   * Sets the Category to the Property.
+   * @param classKey The SchemaItemKey of the class.
+   * @param propertyName The name of the property.
+   * @param categoryKey The SchemaItemKey of the PropertyCategory assigned to the property.
+   */
+  public async setPropertyCategory(classKey: SchemaItemKey, propertyName: string, categoryKey: SchemaItemKey): Promise<PropertyEditResults> {
+    let mutableClass: MutableClass;
+    try {
+      mutableClass = await this.getClass(classKey);
+    } catch (e: any) {
+      return { errorMessage: e.message };
+    }
+
+    const property = await mutableClass.getProperty(propertyName) as MutableProperty;
+    if (property === undefined) {
+      return { errorMessage: `An ECProperty with the name ${propertyName} could not be found in the class ${classKey.fullName}.` };
+    }
+
+    const category = await mutableClass.schema.lookupItem<PropertyCategory>(categoryKey);
+    if (category === undefined) {
+      return { errorMessage: `Can't locate the Property Category ${categoryKey.fullName} in the schema ${mutableClass.schema.fullName}.` };
+    }
+
+    property.setCategory(new DelayedPromiseWithProps<SchemaItemKey, PropertyCategory>(categoryKey, async () => category));
+    return { itemKey: classKey, propertyName };
+  }
+
   private async getClass(classKey: SchemaItemKey): Promise<MutableClass> {
     const schema = await this._schemaEditor.getSchema(classKey.schemaKey);
     if (schema === undefined)

core/ecschema-editing/src/Editing/Entities.ts

@@ -8,7 +8,7 @@
 
 import {
   DelayedPromiseWithProps, ECClassModifier, ECObjectsError, ECObjectsStatus, EntityClass, EntityClassProps,
-  Mixin, RelationshipClass, SchemaItemKey, SchemaItemType, SchemaKey, StrengthDirection,
+  Mixin, NavigationPropertyProps, RelationshipClass, SchemaItemKey, SchemaItemType, SchemaKey, StrengthDirection,
 } from "@itwin/ecschema-metadata";
 import { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from "./Editor";
 import { ECClasses } from "./ECClasses";
@@ -140,7 +140,7 @@ export class Entities extends ECClasses {
   }
 
   public async createNavigationProperty(entityKey: SchemaItemKey, name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<PropertyEditResults> {
-    const entity = (await this._schemaEditor.schemaContext.getSchemaItem<MutableEntityClass>(entityKey));
+    const entity = await this._schemaEditor.schemaContext.getSchemaItem<MutableEntityClass>(entityKey);
 
     if (entity === undefined)
       throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `Entity Class ${entityKey.fullName} not found in schema context.`);
@@ -152,6 +152,25 @@ export class Entities extends ECClasses {
     return { itemKey: entityKey, propertyName: name };
   }
 
+  /**
+   * Creates a Navigation Property through a NavigationPropertyProps.
+   * @param classKey a SchemaItemKey of the Entity Class that will house the new property.
+   * @param navigationProps a json object that will be used to populate the new Navigation Property.
+   */
+  public async createNavigationPropertyFromProps(classKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<PropertyEditResults> {
+    const entity = await this._schemaEditor.schemaContext.getSchemaItem<MutableEntityClass>(classKey);
+    if (entity === undefined)
+      return { itemKey: classKey, propertyName: navigationProps.name, errorMessage: `Entity Class ${classKey.fullName} not found in schema context.`};
+
+    if (entity.schemaItemType !== SchemaItemType.EntityClass)
+      return { itemKey: classKey, propertyName: navigationProps.name, errorMessage: `Expected ${classKey.fullName} to be of type EntityClass.` };
+
+    const navigationProperty  = await entity.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);
+    await navigationProperty.fromJSON(navigationProps);
+
+    return { itemKey: classKey, propertyName: navigationProps.name };
+  }
+
   /**
    * Sets the base class of an Entity.
    * @param entityKey The SchemaItemKey of the Entity.

core/ecschema-editing/src/Editing/Mixins.ts

@@ -7,7 +7,7 @@
  */
 
 import {
-  DelayedPromiseWithProps, ECObjectsError, ECObjectsStatus, EntityClass, Mixin, MixinProps, RelationshipClass,
+  DelayedPromiseWithProps, ECObjectsError, ECObjectsStatus, EntityClass, Mixin, MixinProps, NavigationPropertyProps, RelationshipClass,
   SchemaItemKey, SchemaItemType, SchemaKey, StrengthDirection,
 } from "@itwin/ecschema-metadata";
 import { PropertyEditResults, SchemaContextEditor, SchemaItemEditResults } from "./Editor";
@@ -109,6 +109,25 @@ export class Mixins extends ECClasses {
     return { itemKey: mixinKey, propertyName: name };
   }
 
+  /**
+   * Creates a Navigation Property through a NavigationPropertyProps.
+   * @param classKey a SchemaItemKey of the Mixin that will house the new property.
+   * @param navigationProps a json object that will be used to populate the new Navigation Property.
+   */
+  public async createNavigationPropertyFromProps(classKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<PropertyEditResults> {
+    const mixin = await this._schemaEditor.schemaContext.getSchemaItem<MutableMixin>(classKey);
+    if (mixin === undefined)
+      return { itemKey: classKey, propertyName: navigationProps.name, errorMessage: `Mixin ${classKey.fullName} not found in schema context.`};
+
+    if (mixin.schemaItemType !== SchemaItemType.Mixin)
+      return { itemKey: classKey, propertyName: navigationProps.name, errorMessage: `Expected ${classKey.fullName} to be of type Mixin.`};
+
+    const navigationProperty  = await mixin.createNavigationProperty(navigationProps.name, navigationProps.relationshipName, navigationProps.direction);
+    await navigationProperty.fromJSON(navigationProps);
+
+    return { itemKey: classKey, propertyName: navigationProps.name };
+  }
+
   public async setMixinBaseClass(mixinKey: SchemaItemKey, baseClassKey?: SchemaItemKey): Promise<SchemaItemEditResults>{
     const mixin = (await this._schemaEditor.schemaContext.getSchemaItem<MutableMixin>(mixinKey));
 

core/ecschema-editing/src/Editing/RelationshipClasses.ts

@@ -130,8 +130,13 @@ export class RelationshipClasses extends ECClasses {
     return { itemKey: relationshipKey, propertyName: name };
   }
 
+  /**
+   * Creates a Navigation Property through a NavigationPropertyProps.
+   * @param classKey a SchemaItemKey of the Relationship Class that will house the new property.
+   * @param navigationProps a json object that will be used to populate the new Navigation Property.
+   */
   public async createNavigationPropertyFromProps(relationshipKey: SchemaItemKey, navigationProps: NavigationPropertyProps): Promise<PropertyEditResults> {
-    const relationshipClass = (await this._schemaEditor.schemaContext.getSchemaItem<MutableRelationshipClass>(relationshipKey));
+    const relationshipClass = await this._schemaEditor.schemaContext.getSchemaItem<MutableRelationshipClass>(relationshipKey);
 
     if (relationshipClass === undefined)
       return { itemKey: relationshipKey, propertyName: navigationProps.name, errorMessage: `Relationship Class ${relationshipKey.fullName} not found in schema context.` };