@itwin/core-backend 5.13.0-dev.9 → 5.13.0

package/lib/esm/Element.js

@@ -12,7 +12,7 @@ import { Entity } from "./Entity";
 import { EditTxn } from "./EditTxn";
 import { DefinitionModel, DrawingModel, PhysicalModel, SectionDrawingModel } from "./Model";
 import { SubjectOwnsProjectInformationRecord, SubjectOwnsSubjects } from "./NavigationRelationship";
-import { _cache, _elementWasCreated, _implicitTxn, _nativeDb, _verifyChannel } from "./internal/Symbols";
+import { _cache, _elementWasCreated, _implicitTxn, _nativeDb, _onReservedElementInsert, _verifyChannel } from "./internal/Symbols";
 import { ECVersion, EntityClass } from "@itwin/ecschema-metadata";
 /** The smallest individually identifiable building block for modeling the real world in an iModel.
  * Each element represents an [[Entity]] in the real world. Sets of Elements (contained in [[Model]]s) are used to model
@@ -122,6 +122,10 @@ export class Element extends Entity {
         if (props.parent) // inserting requires shared lock on parent, if present
             iModel.locks.checkSharedLock(props.parent.id, "parent", operation);
         iModel.codeService?.verifyCode(arg);
+        // Any element inserted with an explicitly-set federationGuid must first be reserved (when SchemaSync is enabled),
+        // unless the caller explicitly opts out. See [[SynchronousChannel.Reservations]].
+        if (props.federationGuid !== undefined && !arg.options?.skipReservationCheck)
+            iModel.reservations[_onReservedElementInsert](arg);
     }
     /** Called after a new Element was inserted.
      * @note If you override this method, you must call super.
@@ -337,7 +341,7 @@ export class Element extends Entity {
      * * none of the element's outputs have been processed.
      * @see [[ElementDrivesElement]] for more on element dependency graphs.
      * @beta
-     * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use onBeforeOutputsHandledArg instead.
+     * @deprecated in 5.9.0 - might be removed in next major version. Use onBeforeOutputsHandledArg instead.
      */
     static onBeforeOutputsHandled(_id, _iModel) { }
     /** Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
@@ -363,7 +367,7 @@ export class Element extends Entity {
      * This method is not called if none of the element's inputs were changed.
      * @see [[ElementDrivesElement]] for more on element dependency graphs.
      * @beta
-     * @deprecated in 5.9.0 - will not be removed until after 2026-08-04. Use onAllInputsHandledArg instead.
+     * @deprecated in 5.9.0 - might be removed in next major version. Use onAllInputsHandledArg instead.
      */
     static onAllInputsHandled(_id, _iModel) { }
     toJSON() {
@@ -545,17 +549,40 @@ export class GeometricElement extends Element {
  */
 export class GeometricElement3d extends GeometricElement {
     static get className() { return "GeometricElement3d"; }
-    placement;
+    _placement;
+    // Snapshot the default placement so nested mutations remain serializable without serializing an untouched absent placement.
+    _initialPlacement;
+    _hasPlacement;
     typeDefinition;
     constructor(props, iModel) {
         super(props, iModel);
-        this.placement = Placement3d.fromJSON(props.placement);
+        this._placement = Placement3d.fromJSON(props.placement);
+        this._initialPlacement = Placement3d.fromJSON(props.placement);
+        this._hasPlacement = props.placement !== undefined;
         if (props.typeDefinition)
             this.typeDefinition = TypeDefinition.fromJSON(props.typeDefinition);
     }
+    get placement() { return this._placement; }
+    set placement(value) {
+        this._placement = value;
+        this._hasPlacement = true;
+    }
     toJSON() {
         const val = super.toJSON();
-        val.placement = this.placement;
+        const placementChanged = this._placement.origin.x !== this._initialPlacement.origin.x
+            || this._placement.origin.y !== this._initialPlacement.origin.y
+            || this._placement.origin.z !== this._initialPlacement.origin.z
+            || this._placement.angles.yaw.radians !== this._initialPlacement.angles.yaw.radians
+            || this._placement.angles.pitch.radians !== this._initialPlacement.angles.pitch.radians
+            || this._placement.angles.roll.radians !== this._initialPlacement.angles.roll.radians
+            || this._placement.bbox.low.x !== this._initialPlacement.bbox.low.x
+            || this._placement.bbox.low.y !== this._initialPlacement.bbox.low.y
+            || this._placement.bbox.low.z !== this._initialPlacement.bbox.low.z
+            || this._placement.bbox.high.x !== this._initialPlacement.bbox.high.x
+            || this._placement.bbox.high.y !== this._initialPlacement.bbox.high.y
+            || this._placement.bbox.high.z !== this._initialPlacement.bbox.high.z;
+        if (this._hasPlacement || placementChanged)
+            val.placement = this._placement;
         if (undefined !== this.typeDefinition)
             val.typeDefinition = this.typeDefinition;
         return val;
@@ -592,26 +619,31 @@ export class GeometricElement3d extends GeometricElement {
         const elProps = super.deserialize(props);
         const instance = props.row;
         elProps.category = instance.category.id;
-        const origin = instance.origin ? [instance.origin.x, instance.origin.y, instance.origin.z] : [0, 0, 0];
         let bbox;
-        if ("bBoxHigh" in instance && instance.bBoxHigh !== undefined && "bBoxLow" in instance && instance.bBoxLow !== undefined) {
+        if ("bBoxHigh" in instance && instance.bBoxHigh !== undefined && instance.bBoxHigh !== null && "bBoxLow" in instance && instance.bBoxLow !== undefined && instance.bBoxLow !== null) {
             bbox = {
                 low: [instance.bBoxLow.x, instance.bBoxLow.y, instance.bBoxLow.z],
                 high: [instance.bBoxHigh.x, instance.bBoxHigh.y, instance.bBoxHigh.z],
             };
         }
-        elProps.placement = {
-            origin,
-            angles: YawPitchRollAngles.createDegrees(instance.yaw ?? 0, instance.pitch ?? 0, instance.roll ?? 0).toJSON(),
-            bbox
-        };
+        if (instance.origin !== undefined && instance.origin !== null) {
+            elProps.placement = {
+                origin: [instance.origin.x, instance.origin.y, instance.origin.z],
+                angles: YawPitchRollAngles.createDegrees(instance.yaw ?? 0, instance.pitch ?? 0, instance.roll ?? 0).toJSON(),
+                bbox
+            };
+        }
         if (instance.geometryStream) {
-            elProps.geom = props.iModel[_nativeDb].convertOrUpdateGeometrySource({
+            const source = props.iModel[_nativeDb].convertOrUpdateGeometrySource({
                 is2d: false,
                 geom: instance.geometryStream,
                 placement: elProps.placement,
                 categoryId: elProps.category
-            }, "GeometryStreamProps", props.options?.element ?? {}).geom;
+            }, "GeometryStreamProps", props.options?.element ?? {});
+            elProps.geom = source.geom;
+            if (source.placement) {
+                elProps.placement = source.placement;
+            }
         }
         if (instance.typeDefinition) {
             elProps.typeDefinition = instance.typeDefinition;
@@ -695,17 +727,35 @@ export class GraphicalElement3d extends GeometricElement3d {
  */
 export class GeometricElement2d extends GeometricElement {
     static get className() { return "GeometricElement2d"; }
-    placement;
+    _placement;
+    // Snapshot the default placement so nested mutations remain serializable without serializing an untouched absent placement.
+    _initialPlacement;
+    _hasPlacement;
     typeDefinition;
     constructor(props, iModel) {
         super(props, iModel);
-        this.placement = Placement2d.fromJSON(props.placement);
+        this._placement = Placement2d.fromJSON(props.placement);
+        this._initialPlacement = Placement2d.fromJSON(props.placement);
+        this._hasPlacement = props.placement !== undefined;
         if (props.typeDefinition)
             this.typeDefinition = TypeDefinition.fromJSON(props.typeDefinition);
     }
+    get placement() { return this._placement; }
+    set placement(value) {
+        this._placement = value;
+        this._hasPlacement = true;
+    }
     toJSON() {
         const val = super.toJSON();
-        val.placement = this.placement;
+        const placementChanged = this._placement.origin.x !== this._initialPlacement.origin.x
+            || this._placement.origin.y !== this._initialPlacement.origin.y
+            || this._placement.angle.radians !== this._initialPlacement.angle.radians
+            || this._placement.bbox.low.x !== this._initialPlacement.bbox.low.x
+            || this._placement.bbox.low.y !== this._initialPlacement.bbox.low.y
+            || this._placement.bbox.high.x !== this._initialPlacement.bbox.high.x
+            || this._placement.bbox.high.y !== this._initialPlacement.bbox.high.y;
+        if (this._hasPlacement || placementChanged)
+            val.placement = this._placement;
         if (undefined !== this.typeDefinition)
             val.typeDefinition = this.typeDefinition;
         return val;
@@ -735,19 +785,20 @@ export class GeometricElement2d extends GeometricElement {
         const elProps = super.deserialize(props);
         const instance = props.row;
         elProps.category = instance.category.id;
-        const origin = instance.origin ? [instance.origin.x, instance.origin.y] : [0, 0];
         let bbox;
-        if ("bBoxHigh" in instance && instance.bBoxHigh !== undefined && "bBoxLow" in instance && instance.bBoxLow !== undefined) {
+        if ("bBoxHigh" in instance && instance.bBoxHigh !== undefined && instance.bBoxHigh !== null && "bBoxLow" in instance && instance.bBoxLow !== undefined && instance.bBoxLow !== null) {
             bbox = {
                 low: [instance.bBoxLow.x, instance.bBoxLow.y],
                 high: [instance.bBoxHigh.x, instance.bBoxHigh.y],
             };
         }
-        elProps.placement = {
-            origin,
-            angle: instance.rotation,
-            bbox,
-        };
+        if (instance.origin !== undefined && instance.origin !== null) {
+            elProps.placement = {
+                origin: [instance.origin.x, instance.origin.y],
+                angle: instance.rotation,
+                bbox,
+            };
+        }
         if (instance.geometryStream) {
             const source = props.iModel[_nativeDb].convertOrUpdateGeometrySource({
                 is2d: true,
@@ -1240,6 +1291,51 @@ export class DefinitionElement extends InformationContentElement {
  */
 export class DefinitionSet extends DefinitionElement {
     static get className() { return "DefinitionSet"; }
+    /** The Rank of a DefinitionSet indicates how it was created, who is aware of it and where it can be used.
+     * @beta
+     */
+    rank;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.rank = props.rank;
+    }
+    /**
+     * DefinitionSet custom HandledProps include 'rank'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "rank", source: "Class" },
+    ];
+    /**
+     * DefinitionSet deserializes 'rank'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        if (props.row.rank !== undefined)
+            elProps.rank = JsonUtils.asInt(props.row.rank);
+        return elProps;
+    }
+    /**
+     * DefinitionSet serializes 'rank'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        if (undefined !== props.rank) {
+            inst.rank = props.rank;
+        }
+        return inst;
+    }
+    toJSON() {
+        const val = super.toJSON();
+        if (undefined !== this.rank)
+            val.rank = this.rank;
+        return val;
+    }
 }
 /** A DefinitionContainer exclusively owns a set of DefinitionElements contained within its sub-model (of type DefinitionModel).
  * @note The associated ECClass was added to the BisCore schema in version 1.0.10