@itwin/core-backend 5.1.0-dev.3 → 5.1.0-dev.32

package/lib/esm/Element.js

@@ -6,12 +6,12 @@
  * @module Elements
  */
 import { CompressedId64Set, Id64, JsonUtils, OrderedId64Array } from "@itwin/core-bentley";
-import { BisCodeSpec, Code, ConcreteEntityTypes, IModel, Placement2d, Placement3d, RelatedElement, RenderSchedule, SectionType, TypeDefinition, } from "@itwin/core-common";
-import { ClipVector, Range3d, Transform } from "@itwin/core-geometry";
+import { BisCodeSpec, Code, ConcreteEntityTypes, IModel, Placement2d, Placement3d, RelatedElement, RenderSchedule, SectionType, TypeDefinition } from "@itwin/core-common";
+import { ClipVector, Range3d, Transform, YawPitchRollAngles } from "@itwin/core-geometry";
 import { Entity } from "./Entity";
 import { DefinitionModel, DrawingModel, PhysicalModel, SectionDrawingModel } from "./Model";
 import { SubjectOwnsSubjects } from "./NavigationRelationship";
-import { _elementWasCreated, _verifyChannel } from "./internal/Symbols";
+import { _cache, _elementWasCreated, _nativeDb, _verifyChannel } from "./internal/Symbols";
 /** 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
  * other Elements that represent larger scale real world entities. Using this recursive modeling strategy,
@@ -34,7 +34,7 @@ import { _elementWasCreated, _verifyChannel } from "./internal/Symbols";
  * * [Element Fundamentals]($docs/bis/guide/fundamentals/element-fundamentals.md)
  * * [Working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md)
  * * [Creating elements]($docs/learning/backend/CreateElements.md)
- * @public
+ * @public @preview
  */
 export class Element extends Entity {
     static get className() { return "Element"; }
@@ -61,6 +61,51 @@ export class Element extends Entity {
         this.userLabel = props.userLabel;
         this.jsonProperties = { ...props.jsonProperties }; // make sure we have our own copy
     }
+    /**
+     * Element custom HandledProps include 'codeValue', 'codeSpec', 'codeScope', 'model', 'parent', 'federationGuid', and 'lastMod'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "codeValue", source: "Class" },
+        { propertyName: "codeSpec", source: "Class" },
+        { propertyName: "codeScope", source: "Class" },
+        { propertyName: "model", source: "Class" },
+        { propertyName: "parent", source: "Class" },
+        { propertyName: "federationGuid", source: "Class" },
+        { propertyName: "lastMod", source: "Class" },
+    ];
+    /**
+     * Element deserializes 'codeValue', 'codeSpec', 'codeScope', 'model', 'parent', and 'federationGuid'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        elProps.code = { value: instance.codeValue ?? "", spec: instance.codeSpec.id, scope: instance.codeScope.id };
+        elProps.model = instance.model.id;
+        if (instance.parent)
+            elProps.parent = instance.parent;
+        if (instance.federationGuid)
+            elProps.federationGuid = instance.federationGuid;
+        return elProps;
+    }
+    /**
+     * Element serialize 'codeValue', 'codeSpec', 'codeScope', 'model', 'parent', and 'federationGuid'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        inst.codeValue = props.code.value;
+        inst.codeSpec = { id: props.code.spec };
+        inst.codeScope = { id: props.code.scope };
+        inst.model = { id: props.model };
+        inst.parent = props.parent;
+        inst.federationGuid = props.federationGuid ?? iModel[_nativeDb].newBeGuid();
+        return inst;
+    }
     /** Called before a new Element is inserted.
      * @note throw an exception to disallow the insert
      * @note If you override this method, you must call super.
@@ -85,6 +130,7 @@ export class Element extends Entity {
         const locks = arg.iModel.locks;
         if (locks && !locks.holdsExclusiveLock(arg.model))
             locks[_elementWasCreated](arg.id);
+        arg.iModel.models[_cache].delete(arg.model);
     }
     /** Called before an Element is updated.
      * @note throw an exception to disallow the update
@@ -103,7 +149,10 @@ export class Element extends Entity {
      * @note `this` is the class of the Element that was updated
      * @beta
      */
-    static onUpdated(_arg) { }
+    static onUpdated(arg) {
+        arg.iModel.elements[_cache].delete({ id: arg.id });
+        arg.iModel.models[_cache].delete(arg.model);
+    }
     /** Called before an Element is deleted.
      * @note throw an exception to disallow the delete
      * @note If you override this method, you must call super.
@@ -119,7 +168,10 @@ export class Element extends Entity {
      * @note `this` is the class of the Element that was deleted
      * @beta
      */
-    static onDeleted(_arg) { }
+    static onDeleted(arg) {
+        arg.iModel.elements[_cache].delete(arg);
+        arg.iModel.models[_cache].delete(arg.model);
+    }
     /** Called when an element with an instance of this class as its parent is about to be deleted.
      * @note throw an exception if the element should not be deleted
      * @note implementers should not presume that the element was deleted if this method does not throw,
@@ -132,7 +184,10 @@ export class Element extends Entity {
      * @note `this` is the class of the parent Element whose child was deleted
      * @beta
      */
-    static onChildDeleted(_arg) { }
+    static onChildDeleted(arg) {
+        arg.iModel.elements[_cache].delete({ id: arg.parentId });
+        arg.iModel.elements[_cache].delete({ id: arg.childId });
+    }
     /** Called when a *new element* with an instance of this class as its parent is about to be inserted.
      * @note throw an exception if the element should not be inserted
      * @note `this` is the class of the prospective parent Element.
@@ -143,7 +198,9 @@ export class Element extends Entity {
      * @note `this` is the class of the parent Element.
      * @beta
      */
-    static onChildInserted(_arg) { }
+    static onChildInserted(arg) {
+        arg.iModel.elements[_cache].delete({ id: arg.parentId });
+    }
     /** Called when an element with an instance of this class as its parent is about to be updated.
      * @note throw an exception if the element should not be updated
      * @note `this` is the class of the parent Element.
@@ -154,7 +211,9 @@ export class Element extends Entity {
      * @note `this` is the class of the parent Element.
      * @beta
      */
-    static onChildUpdated(_arg) { }
+    static onChildUpdated(arg) {
+        arg.iModel.elements[_cache].delete({ id: arg.parentId });
+    }
     /** Called when an *existing element* is about to be updated so that an instance of this class will become its new parent.
      * @note throw an exception if the element should not be added
      * @note `this` is the class of the prospective parent Element.
@@ -165,7 +224,9 @@ export class Element extends Entity {
      * @note `this` is the class of the new parent Element.
      * @beta
      */
-    static onChildAdded(_arg) { }
+    static onChildAdded(arg) {
+        arg.iModel.elements[_cache].delete({ id: arg.parentId });
+    }
     /** Called when an element with an instance of this class as its parent is about to be updated change to a different parent.
      * @note throw an exception if the element should not be dropped
      * @note `this` is the class of the parent Element.
@@ -176,7 +237,9 @@ export class Element extends Entity {
      * @note `this` is the class of the previous parent Element.
      * @beta
      */
-    static onChildDropped(_arg) { }
+    static onChildDropped(arg) {
+        arg.iModel.elements[_cache].delete({ id: arg.parentId });
+    }
     /** Called when an instance of this class is being *sub-modeled* by a new Model.
      * @note throw an exception if model should not be inserted
      * @note `this` is the class of Element to be sub-modeled.
@@ -187,7 +250,11 @@ export class Element extends Entity {
      * @note `this` is the class of Element that is now sub-modeled.
      * @beta
      */
-    static onSubModelInserted(_arg) { }
+    static onSubModelInserted(arg) {
+        const id = arg.subModelId;
+        arg.iModel.elements[_cache].delete({ id });
+        arg.iModel.models[_cache].delete(id);
+    }
     /** Called when a sub-model of an instance of this class is being deleted.
      * @note throw an exception if model should not be deleted
      * @note `this` is the class of Element that is sub-modeled.
@@ -198,7 +265,11 @@ export class Element extends Entity {
      * @note `this` is the class of Element that was sub-modeled.
      * @beta
      */
-    static onSubModelDeleted(_arg) { }
+    static onSubModelDeleted(arg) {
+        const id = arg.subModelId;
+        arg.iModel.elements[_cache].delete({ id });
+        arg.iModel.models[_cache].delete(id);
+    }
     /** Called during the iModel transformation process after an Element from the source iModel was *cloned* for the target iModel.
      * The transformation process automatically handles remapping BisCore properties and those that are properly described in ECSchema.
      * This callback is only meant to be overridden if there are other Ids in non-standard locations that need to be remapped or other data that needs to be fixed up after the clone.
@@ -327,7 +398,7 @@ export class Element extends Entity {
     delete() { this.iModel.elements.deleteElement(this.id); }
 }
 /** An abstract base class to model real world entities that intrinsically have geometry.
- * @public
+ * @public @preview
  */
 export class GeometricElement extends Element {
     static get className() { return "GeometricElement"; }
@@ -366,10 +437,34 @@ export class GeometricElement extends Element {
         ...super.requiredReferenceKeyTypeMap,
         category: ConcreteEntityTypes.Element,
     };
+    /**
+     * GeometricElement custom HandledProps includes 'inSpatialIndex'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "inSpatialIndex", source: "Class" },
+    ];
+    /**
+     * GeometricElement deserializes 'inSpatialIndex'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        return super.deserialize(props);
+    }
+    /**
+     * GeometricElement serialize 'inSpatialIndex'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        return super.serialize(props, iModel);
+    }
 }
 /** An abstract base class to model real world entities that intrinsically have 3d geometry.
  * See [how to create a GeometricElement3d]($docs/learning/backend/CreateElements.md#GeometricElement3d).
- * @public
+ * @public @preview
  */
 export class GeometricElement3d extends GeometricElement {
     static get className() { return "GeometricElement3d"; }
@@ -393,16 +488,133 @@ export class GeometricElement3d extends GeometricElement {
         if (undefined !== this.typeDefinition)
             referenceIds.addElement(this.typeDefinition.id);
     }
+    /**
+     * GeometricElement3d custom HandledProps includes 'category', 'geometryStream', 'origin', 'yaw', 'pitch', 'roll',
+     * 'bBoxLow', 'bBoxHigh', and 'typeDefinition'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "category", source: "Class" },
+        { propertyName: "geometryStream", source: "Class" },
+        { propertyName: "origin", source: "Class" },
+        { propertyName: "yaw", source: "Class" },
+        { propertyName: "pitch", source: "Class" },
+        { propertyName: "roll", source: "Class" },
+        { propertyName: "bBoxLow", source: "Class" },
+        { propertyName: "bBoxHigh", source: "Class" },
+        { propertyName: "typeDefinition", source: "Class" }
+    ];
+    /**
+     * GeometricElement3d deserializes 'category', 'geometryStream', 'origin', 'yaw', 'pitch', 'roll',
+     * 'bBoxLow', 'bBoxHigh', and 'typeDefinition'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        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) {
+            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.geometryStream) {
+            elProps.geom = props.iModel[_nativeDb].convertOrUpdateGeometrySource({
+                is2d: false,
+                geom: instance.geometryStream,
+                placement: elProps.placement,
+                categoryId: elProps.category
+            }, "GeometryStreamProps", props.options?.element ?? {}).geom;
+        }
+        if (instance.typeDefinition) {
+            elProps.typeDefinition = instance.typeDefinition;
+        }
+        return elProps;
+    }
+    /**
+     * GeometricElement3d serializes 'category', 'geometryStream', 'origin', 'yaw', 'pitch', 'roll',
+     * 'bBoxLow', 'bBoxHigh', and 'typeDefinition'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        inst.category = { id: props.category };
+        const assignPlacement = (placement) => {
+            if (Array.isArray(placement.origin)) {
+                inst.origin = { x: placement.origin[0], y: placement.origin[1], z: placement.origin[2] };
+            }
+            else {
+                inst.origin = placement.origin;
+            }
+            inst.yaw = placement.angles.yaw;
+            inst.pitch = placement.angles.pitch;
+            inst.roll = placement.angles.roll;
+            if (placement.bbox) {
+                if (Array.isArray(placement.bbox.low)) {
+                    inst.bBoxLow = { x: placement.bbox.low[0], y: placement.bbox.low[1], z: placement.bbox.low[2] };
+                }
+                else {
+                    inst.bBoxLow = placement.bbox.low;
+                }
+                if (Array.isArray(placement.bbox.high)) {
+                    inst.bBoxHigh = { x: placement.bbox.high[0], y: placement.bbox.high[1], z: placement.bbox.high[2] };
+                }
+                else {
+                    inst.bBoxHigh = placement.bbox.high;
+                }
+            }
+        };
+        if (props.placement) {
+            assignPlacement(props.placement);
+        }
+        if (props.elementGeometryBuilderParams) {
+            const source = iModel[_nativeDb].convertOrUpdateGeometrySource({
+                builder: props.elementGeometryBuilderParams,
+                is2d: true,
+                placement: props.placement,
+                categoryId: props.category,
+            }, "BinaryStream", {});
+            inst.geometryStream = source.geom;
+            if (source.placement) {
+                assignPlacement(source.placement);
+            }
+        }
+        if (props.geom) {
+            const source = iModel[_nativeDb].convertOrUpdateGeometrySource({
+                geom: props.geom,
+                is2d: false,
+                placement: props.placement,
+                categoryId: props.category,
+            }, "BinaryStream", {});
+            inst.geometryStream = source.geom;
+            if (source.placement) {
+                assignPlacement(source.placement);
+            }
+        }
+        inst.typeDefinition = props.typeDefinition;
+        return inst;
+    }
 }
 /** A 3d Graphical Element
- * @public
+ * @public @preview
  */
 export class GraphicalElement3d extends GeometricElement3d {
     static get className() { return "GraphicalElement3d"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** An abstract base class to model information entities that intrinsically have 2d geometry.
- * @public
+ * @public @preview
  */
 export class GeometricElement2d extends GeometricElement {
     static get className() { return "GeometricElement2d"; }
@@ -421,6 +633,123 @@ export class GeometricElement2d extends GeometricElement {
             val.typeDefinition = this.typeDefinition;
         return val;
     }
+    /**
+     * GeometricElement2d custom HandledProps includes 'category', 'geometryStream', 'origin', 'rotation',
+     * 'bBoxLow', 'bBoxHigh', and 'typeDefinition'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "category", source: "Class" },
+        { propertyName: "geometryStream", source: "Class" },
+        { propertyName: "origin", source: "Class" },
+        { propertyName: "rotation", source: "Class" },
+        { propertyName: "bBoxLow", source: "Class" },
+        { propertyName: "bBoxHigh", source: "Class" },
+        { propertyName: "typeDefinition", source: "Class" }
+    ];
+    /**
+     * GeometricElement2d deserialize 'category', 'geometryStream', 'origin', 'rotation',
+     * 'bBoxLow', 'bBoxHigh', and 'typeDefinition'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        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) {
+            bbox = {
+                low: [instance.bBoxLow.x, instance.bBoxLow.y],
+                high: [instance.bBoxHigh.x, instance.bBoxHigh.y],
+            };
+        }
+        elProps.placement = {
+            origin,
+            angle: instance.rotation,
+            bbox,
+        };
+        if (instance.geometryStream) {
+            const source = props.iModel[_nativeDb].convertOrUpdateGeometrySource({
+                is2d: true,
+                geom: instance.geometryStream,
+                placement: elProps.placement,
+                categoryId: elProps.category
+            }, "GeometryStreamProps", props.options?.element ?? {});
+            elProps.geom = source.geom;
+            if (source.placement) {
+                elProps.placement = source.placement;
+            }
+        }
+        if (instance.typeDefinition) {
+            elProps.typeDefinition = instance.typeDefinition;
+        }
+        return elProps;
+    }
+    /**
+     * GeometricElement2d serializes 'category', 'geometryStream', 'origin', 'rotation',
+     * 'bBoxLow', 'bBoxHigh', and 'typeDefinition'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        inst.category = { id: props.category };
+        const assignPlacement = (placement) => {
+            if (Array.isArray(placement.origin)) {
+                inst.origin = { x: placement.origin[0], y: placement.origin[1] };
+            }
+            else {
+                inst.origin = placement.origin;
+            }
+            inst.rotation = placement.angle;
+            if (placement.bbox) {
+                if (Array.isArray(placement.bbox.low)) {
+                    inst.bBoxLow = { x: placement.bbox.low[0], y: placement.bbox.low[1] };
+                }
+                else {
+                    inst.bBoxLow = placement.bbox.low;
+                }
+                if (Array.isArray(placement.bbox.high)) {
+                    inst.bBoxHigh = { x: placement.bbox.high[0], y: placement.bbox.high[1] };
+                }
+                else {
+                    inst.bBoxHigh = placement.bbox.high;
+                }
+            }
+        };
+        if (props.placement) {
+            assignPlacement(props.placement);
+        }
+        if (props.elementGeometryBuilderParams) {
+            const source = iModel[_nativeDb].convertOrUpdateGeometrySource({
+                builder: props.elementGeometryBuilderParams,
+                is2d: true,
+                placement: props.placement,
+                categoryId: props.category,
+            }, "BinaryStream", {});
+            inst.geometryStream = source.geom;
+            if (source.placement) {
+                assignPlacement(source.placement);
+            }
+        }
+        if (props.geom) {
+            const source = iModel[_nativeDb].convertOrUpdateGeometrySource({
+                geom: props.geom,
+                is2d: true,
+                placement: props.placement,
+                categoryId: props.category,
+            }, "BinaryStream", {});
+            inst.geometryStream = source.geom;
+            if (source.placement) {
+                assignPlacement(source.placement);
+            }
+        }
+        inst.typeDefinition = props.typeDefinition;
+        return inst;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         if (undefined !== this.typeDefinition)
@@ -428,35 +757,35 @@ export class GeometricElement2d extends GeometricElement {
     }
 }
 /** An abstract base class for 2d Geometric Elements that are used to convey information within graphical presentations (like drawings).
- * @public
+ * @public @preview
  */
 export class GraphicalElement2d extends GeometricElement2d {
     static get className() { return "GraphicalElement2d"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** 2d element used to annotate drawings and sheets.
- * @public
+ * @public @preview
  */
 export class AnnotationElement2d extends GraphicalElement2d {
     static get className() { return "AnnotationElement2d"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** 2d element used to persist graphics for use in drawings.
- * @public
+ * @public @preview
  */
 export class DrawingGraphic extends GraphicalElement2d {
     static get className() { return "DrawingGraphic"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** An Element that occupies real world space. Its coordinates are in the project space of its iModel.
- * @public
+ * @public @preview
  */
 export class SpatialElement extends GeometricElement3d {
     static get className() { return "SpatialElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** An Element that is spatially located, has mass, and can be *touched*.
- * @public
+ * @public @preview
  */
 export class PhysicalElement extends SpatialElement {
     static get className() { return "PhysicalElement"; }
@@ -473,14 +802,14 @@ export class PhysicalElement extends SpatialElement {
     }
 }
 /** Identifies a *tracked* real world location but has no mass and cannot be *touched*.
- * @public
+ * @public @preview
  */
 export class SpatialLocationElement extends SpatialElement {
     static get className() { return "SpatialLocationElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** A Volume Element is a Spatial Location Element that is restricted to defining a volume.
- * @public
+ * @public @preview
  */
 export class VolumeElement extends SpatialLocationElement {
     static get className() { return "VolumeElement"; }
@@ -489,7 +818,7 @@ export class VolumeElement extends SpatialLocationElement {
 /** A SectionDrawingLocation element identifies the location of a [[SectionDrawing]] in the context of a [[SpatialModel]],
  * enabling [HyperModeling]($hypermodeling).
  * @note The associated ECClass was added to the BisCore schema in version 1.0.11.
- * @public
+ * @public @preview
  */
 export class SectionDrawingLocation extends SpatialLocationElement {
     /** The Id of the [[ViewDefinition]] to which this location refers. */
@@ -509,7 +838,7 @@ export class SectionDrawingLocation extends SpatialLocationElement {
 /** Information Content Element is an abstract base class for modeling pure information entities. Only the
  * core framework should directly subclass from Information Content Element. Domain and application developers
  * should start with the most appropriate subclass of Information Content Element.
- * @public
+ * @public @preview
  */
 export class InformationContentElement extends Element {
     static get className() { return "InformationContentElement"; }
@@ -524,14 +853,14 @@ export class DriverBundleElement extends InformationContentElement {
     constructor(props, iModel) { super(props, iModel); }
 }
 /** Information Reference is an abstract base class for modeling entities whose main purpose is to reference something else.
- * @public
+ * @public @preview
  */
 export class InformationReferenceElement extends InformationContentElement {
     static get className() { return "InformationReferenceElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** A Subject is an information element that describes what this repository (or part thereof) is about.
- * @public
+ * @public @preview
  */
 export class Subject extends InformationReferenceElement {
     static get className() { return "Subject"; }
@@ -588,14 +917,14 @@ export class Subject extends InformationReferenceElement {
  * For example, a will is a legal document. The will published into a PDF file is an ElectronicDocumentCopy.
  * The will printed onto paper is a PrintedDocumentCopy.
  * In this example, the Document only identifies, names, and tracks the content of the will.
- * @public
+ * @public @preview
  */
 export class Document extends InformationContentElement {
     static get className() { return "Document"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** A document that represents a drawing, that is, a two-dimensional graphical representation of engineering data. A Drawing element is usually modelled by a [[DrawingModel]].
- * @public
+ * @public @preview
  */
 export class Drawing extends Document {
     _scaleFactor;
@@ -603,7 +932,7 @@ export class Drawing extends Document {
      * size of the [ViewAttachment]($backend) created when attaching the [Drawing]($backend) to a [Sheet]($backend).
      * Default: 1.
      * @note Attempting to set this property to a value less than or equal to zero will produce an exception.
-     * @public
+     * @public @preview
      */
     get scaleFactor() { return this._scaleFactor; }
     set scaleFactor(factor) {
@@ -673,7 +1002,7 @@ export class Drawing extends Document {
 /** A document that represents a section drawing, that is, a graphical documentation derived from a planar
  * section of a spatial view. A SectionDrawing element is modelled by a [[SectionDrawingModel]] or a [[GraphicalModel3d]].
  * A [[SectionDrawingLocation]] can associate the drawing with a spatial location, enabling [HyperModeling]($hypermodeling).
- * @public
+ * @public @preview
  */
 export class SectionDrawing extends Drawing {
     /** The type of section used to generate the drawing. */
@@ -724,7 +1053,7 @@ export class SectionDrawing extends Drawing {
     }
 }
 /** The template for a SheetBorder
- * @public
+ * @public @preview
  */
 export class SheetBorderTemplate extends Document {
     static get className() { return "SheetBorderTemplate"; }
@@ -737,7 +1066,7 @@ export class SheetBorderTemplate extends Document {
     }
 }
 /** The template for a [[Sheet]]
- * @public
+ * @public @preview
  */
 export class SheetTemplate extends Document {
     static get className() { return "SheetTemplate"; }
@@ -757,7 +1086,7 @@ export class SheetTemplate extends Document {
     }
 }
 /** A digital representation of a *sheet of paper*. Modeled by a [[SheetModel]].
- * @public
+ * @public @preview
  */
 export class Sheet extends Document {
     static get className() { return "Sheet"; }
@@ -789,14 +1118,14 @@ export class Sheet extends Document {
 }
 /** Information Record Element is an abstract base class for modeling information records. Information Record
  * Element is the default choice if no other subclass of Information Content Element makes sense.
- * @public
+ * @public @preview
  */
 export class InformationRecordElement extends InformationContentElement {
     static get className() { return "InformationRecordElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
 /** A Definition Element holds configuration-related information that is meant to be referenced / shared.
- * @public
+ * @public @preview
  */
 export class DefinitionElement extends InformationContentElement {
     static get className() { return "DefinitionElement"; }
@@ -806,6 +1135,37 @@ export class DefinitionElement extends InformationContentElement {
         super(props, iModel);
         this.isPrivate = true === props.isPrivate;
     }
+    /**
+     * DefinitionElement custom HandledProps includes 'isPrivate'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "isPrivate", source: "Class" },
+    ];
+    /**
+     * DefinitionElement deserializes 'isPrivate'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        if (props.row.isPrivate !== undefined)
+            elProps.isPrivate = props.row.isPrivate;
+        return elProps;
+    }
+    /**
+     * DefinitionElement serialize 'isPrivate'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        if (undefined !== props.isPrivate) {
+            inst.isPrivate = props.isPrivate;
+        }
+        return inst;
+    }
     toJSON() {
         const val = super.toJSON();
         val.isPrivate = this.isPrivate;
@@ -814,14 +1174,14 @@ export class DefinitionElement extends InformationContentElement {
 }
 /** This abstract class unifies DefinitionGroup and DefinitionContainer for relationship endpoint purposes.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.10
- * @public
+ * @public @preview
  */
 export class DefinitionSet extends DefinitionElement {
     static get className() { return "DefinitionSet"; }
 }
 /** 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
- * @public
+ * @public @preview
  */
 export class DefinitionContainer extends DefinitionSet {
     static get className() { return "DefinitionContainer"; }
@@ -866,7 +1226,7 @@ export class DefinitionContainer extends DefinitionSet {
 }
 /** A non-exclusive set of DefinitionElements grouped using the DefinitionGroupGroupsDefinitions relationship.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.10
- * @public
+ * @public @preview
  */
 export class DefinitionGroup extends DefinitionSet {
     static get className() { return "DefinitionGroup"; }
@@ -890,7 +1250,7 @@ export class DefinitionGroup extends DefinitionSet {
     }
 }
 /** Defines a set of properties (the *type*) that may be associated with an element.
- * @public
+ * @public @preview
  */
 export class TypeDefinitionElement extends DefinitionElement {
     static get className() { return "TypeDefinitionElement"; }
@@ -915,7 +1275,7 @@ export class RecipeDefinitionElement extends DefinitionElement {
 /** Defines a set of properties (the *type*) that can be associated with a Physical Element. A Physical
  * Type has a strong correlation with something that can be ordered from a catalog since all instances
  * share a common set of properties.
- * @public
+ * @public @preview
  */
 export class PhysicalType extends TypeDefinitionElement {
     static get className() { return "PhysicalType"; }
@@ -941,7 +1301,7 @@ export class PhysicalType extends TypeDefinitionElement {
     }
 }
 /** Defines a set of properties (the *type*) that can be associated with a spatial location.
- * @public
+ * @public @preview
  */
 export class SpatialLocationType extends TypeDefinitionElement {
     static get className() { return "SpatialLocationType"; }
@@ -1006,7 +1366,7 @@ export class TemplateRecipe3d extends RecipeDefinitionElement {
     }
 }
 /** Defines a set of properties (the *type*) that can be associated with a 2D Graphical Element.
- * @public
+ * @public @preview
  */
 export class GraphicalType2d extends TypeDefinitionElement {
     static get className() { return "GraphicalType2d"; }
@@ -1073,7 +1433,7 @@ export class TemplateRecipe2d extends RecipeDefinitionElement {
 /** An abstract base class for elements that establishes a particular modeling perspective for its parent Subject.
  * Instances are always sub-modeled by a specialization of Model of the appropriate modeling perspective.
  * @see [iModel Information Hierarchy]($docs/bis/guide/data-organization/top-of-the-world), [[Subject]], [[Model]]
- * @public
+ * @public @preview
  */
 export class InformationPartitionElement extends InformationContentElement {
     static get className() { return "InformationPartitionElement"; }
@@ -1099,7 +1459,7 @@ export class InformationPartitionElement extends InformationContentElement {
 /** A DefinitionPartition element establishes a *Definition* modeling perspective for its parent Subject.
  * A DefinitionPartition is always sub-modeled by a DefinitionModel.
  * @see [[DefinitionModel]]
- * @public
+ * @public @preview
  */
 export class DefinitionPartition extends InformationPartitionElement {
     static get className() { return "DefinitionPartition"; }
@@ -1107,7 +1467,7 @@ export class DefinitionPartition extends InformationPartitionElement {
 /** A DocumentPartition element establishes a *Document* modeling perspective for its parent Subject.
  * A DocumentPartition is always sub-modeled by a DocumentListModel.
  * @see [[DocumentListModel]]
- * @public
+ * @public @preview
  */
 export class DocumentPartition extends InformationPartitionElement {
     static get className() { return "DocumentPartition"; }
@@ -1115,7 +1475,7 @@ export class DocumentPartition extends InformationPartitionElement {
 /** A GroupInformationPartition element establishes a *Group Information* modeling perspective for its parent Subject.
  * A GroupInformationPartition is always sub-modeled by a GroupInformationModel.
  * @see [[GroupInformationModel]]
- * @public
+ * @public @preview
  */
 export class GroupInformationPartition extends InformationPartitionElement {
     static get className() { return "GroupInformationPartition"; }
@@ -1124,7 +1484,7 @@ export class GroupInformationPartition extends InformationPartitionElement {
  * A GraphicalPartition3d is always sub-modeled by a GraphicalModel3d.
  * @note The associated ECClass was added to the BisCore schema in version 1.0.8
  * @see [[GraphicalModel3d]]
- * @public
+ * @public @preview
  */
 export class GraphicalPartition3d extends InformationPartitionElement {
     static get className() { return "GraphicalPartition3d"; }
@@ -1132,21 +1492,21 @@ export class GraphicalPartition3d extends InformationPartitionElement {
 /** An InformationRecordPartition element establishes a *Information Record* modeling perspective for its parent Subject.
  * A InformationRecordPartition is always sub-modeled by an InformationRecordModel.
  * @see [[InformationRecordModel]]
- * @public
+ * @public @preview
  */
 export class InformationRecordPartition extends InformationPartitionElement {
     static get className() { return "InformationRecordPartition"; }
 }
 /** A LinkPartition element establishes a *Link* modeling perspective for its parent Subject. A LinkPartition is always sub-modeled by a LinkModel.
  * @see [[LinkModel]]
- * @public
+ * @public @preview
  */
 export class LinkPartition extends InformationPartitionElement {
     static get className() { return "LinkPartition"; }
 }
 /** A PhysicalPartition element establishes a *Physical* modeling perspective for its parent Subject. A PhysicalPartition is always sub-modeled by a PhysicalModel.
  * @see [[PhysicalModel]]
- * @public
+ * @public @preview
  */
 export class PhysicalPartition extends InformationPartitionElement {
     static get className() { return "PhysicalPartition"; }
@@ -1154,7 +1514,7 @@ export class PhysicalPartition extends InformationPartitionElement {
 /** A SpatialLocationPartition element establishes a *SpatialLocation* modeling perspective for its parent Subject.
  * A SpatialLocationPartition is always sub-modeled by a SpatialLocationModel.
  * @see [[SpatialLocationModel]]
- * @public
+ * @public @preview
  */
 export class SpatialLocationPartition extends InformationPartitionElement {
     static get className() { return "SpatialLocationPartition"; }
@@ -1167,13 +1527,13 @@ export class SheetIndexPartition extends InformationPartitionElement {
     static get className() { return "SheetIndexPartition"; }
 }
 /** Group Information is an abstract base class for modeling entities whose main purpose is to reference a group of related elements.
- * @public
+ * @public @preview
  */
 export class GroupInformationElement extends InformationReferenceElement {
     static get className() { return "GroupInformationElement"; }
 }
 /** An information element that specifies a link.
- * @public
+ * @public @preview
  */
 export class LinkElement extends InformationReferenceElement {
     static get className() { return "LinkElement"; }
@@ -1188,7 +1548,7 @@ export class LinkElement extends InformationReferenceElement {
     }
 }
 /** An information element that specifies a URL link.
- * @public
+ * @public @preview
  */
 export class UrlLink extends LinkElement {
     static get className() { return "UrlLink"; }
@@ -1199,6 +1559,36 @@ export class UrlLink extends LinkElement {
         this.description = props.description;
         this.url = props.url;
     }
+    /**
+     * UrlLink custom HandledProps includes 'description', and 'url'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "description", source: "Class" },
+        { propertyName: "url", source: "Class" },
+    ];
+    /**
+     * UrlLink deserializes 'description', and 'url'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        elProps.description = props.row.description ?? "";
+        elProps.url = props.row.url;
+        return elProps;
+    }
+    /**
+     * UrlLink serializes 'description', and 'url'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        inst.description = props.description;
+        return inst;
+    }
     toJSON() {
         const val = super.toJSON();
         val.description = this.description;
@@ -1214,7 +1604,7 @@ export class FolderLink extends UrlLink {
     static get className() { return "FolderLink"; }
 }
 /** An information element that links to a repository.
- * @public
+ * @public @preview
  */
 export class RepositoryLink extends UrlLink {
     static get className() { return "RepositoryLink"; }
@@ -1234,7 +1624,7 @@ export class RepositoryLink extends UrlLink {
     }
 }
 /** An information element that links to an embedded file.
- * @public
+ * @public @preview
  */
 export class EmbeddedFileLink extends LinkElement {
     static get className() { return "EmbeddedFileLink"; }
@@ -1242,14 +1632,14 @@ export class EmbeddedFileLink extends LinkElement {
 /** A real world entity is modeled as a Role Element when a set of external circumstances define an important
  * role (one that is worth tracking) that is not intrinsic to the entity playing the role. For example,
  * a person can play the role of a teacher or a rock can play the role of a boundary marker.
- * @public
+ * @public @preview
  */
 export class RoleElement extends Element {
     static get className() { return "RoleElement"; }
 }
 /** A Definition Element that specifies a collection of geometry that is meant to be reused across Geometric
  * Element instances. Leveraging Geometry Parts can help reduce file size and improve display performance.
- * @public
+ * @public @preview
  */
 export class GeometryPart extends DefinitionElement {
     static get className() { return "GeometryPart"; }
@@ -1260,6 +1650,73 @@ export class GeometryPart extends DefinitionElement {
         this.geom = props.geom;
         this.bbox = Range3d.fromJSON(props.bbox);
     }
+    /**
+     * GeometryPart custom HandledProps includes 'geometryStream', 'bBoxHigh', and 'bBoxLow'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "geometryStream", source: "Class" },
+        { propertyName: "bBoxLow", source: "Class" },
+        { propertyName: "bBoxHigh", source: "Class" },
+    ];
+    /**
+     * GeometryPart deserializes 'geometryStream', 'bBoxHigh', and 'bBoxLow'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        if ("bBoxHigh" in instance && instance.bBoxHigh !== undefined && "bBoxLow" in instance && instance.bBoxLow !== undefined) {
+            elProps.bbox = {
+                low: [instance.bBoxLow.x, instance.bBoxLow.y, instance.bBoxLow.z],
+                high: [instance.bBoxHigh.x, instance.bBoxHigh.y, instance.bBoxHigh.z],
+            };
+        }
+        if (instance.geometryStream) {
+            elProps.geom = props.iModel[_nativeDb].convertOrUpdateGeometryPart({
+                geom: instance.geometryStream,
+                is2d: false,
+                bbox: elProps.bbox,
+            }, "GeometryStreamProps", props.options?.element ?? {}).geom;
+        }
+        return elProps;
+    }
+    /**
+     * GeometryPart serialize 'geometryStream', 'bBoxHigh', and 'bBoxLow'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        if (undefined !== props.geom) {
+            const source = inst.geometryStream = iModel[_nativeDb].convertOrUpdateGeometryPart({
+                geom: props.geom,
+                is2d: false,
+                bbox: props.bbox,
+            }, "BinaryStream", {});
+            inst.geometryStream = source.geom;
+            if (source.bbox) {
+                props.bbox = source.bbox;
+            }
+        }
+        if (undefined !== props.bbox) {
+            if (Array.isArray(props.bbox.low)) {
+                inst.bBoxLow = { x: props.bbox.low[0], y: props.bbox.low[1], z: props.bbox.low[2] };
+            }
+            else {
+                inst.bBoxLow = props.bbox.low;
+            }
+            if (Array.isArray(props.bbox.high)) {
+                inst.bBoxHigh = { x: props.bbox.high[0], y: props.bbox.high[1], z: props.bbox.high[2] };
+            }
+            else {
+                inst.bBoxHigh = props.bbox.high;
+            }
+        }
+        return inst;
+    }
     toJSON() {
         const val = super.toJSON();
         val.geom = this.geom;
@@ -1278,7 +1735,7 @@ export class GeometryPart extends DefinitionElement {
     }
 }
 /** The definition element for a line style
- * @public
+ * @public @preview
  */
 export class LineStyle extends DefinitionElement {
     static get className() { return "LineStyle"; }
@@ -1289,6 +1746,35 @@ export class LineStyle extends DefinitionElement {
         this.description = props.description;
         this.data = props.data;
     }
+    /**
+     * LineStyle custom HandledProps includes 'data'.
+     * @inheritdoc
+     * @beta
+     */
+    static _customHandledProps = [
+        { propertyName: "data", source: "Class" },
+    ];
+    /**
+     * LineStyle deserializes 'data'.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const instance = props.row;
+        elProps.data = instance.data ?? "";
+        return elProps;
+    }
+    /**
+     * LineStyle serializes 'data'.
+     * @inheritdoc
+     * @beta
+     */
+    static serialize(props, iModel) {
+        const inst = super.serialize(props, iModel);
+        inst.data = props.data;
+        return inst;
+    }
     /** Create a Code for a LineStyle definition given a name that is meant to be unique within the scope of the specified model.
      * @param iModel The IModel
      * @param scopeModelId The Id of the DefinitionModel that contains the LineStyle and provides the scope for its name.
@@ -1301,7 +1787,7 @@ export class LineStyle extends DefinitionElement {
 }
 /** Describes how to animate a view of a [[GeometricModel]] to show change over time using a [RenderSchedule.Script]($common).
  * @note This class was introduced in version 01.00.13 of the BisCore ECSchema. It should only be used with [[IModelDb]]s containing that version or newer.
- * @public
+ * @public @preview
  */
 export class RenderTimeline extends InformationRecordElement {
     static get className() { return "RenderTimeline"; }
@@ -1326,6 +1812,21 @@ export class RenderTimeline extends InformationRecordElement {
         props.script = JSON.stringify(this.scriptProps);
         return props;
     }
+    /**
+     * RenderTimeline deserialize checks if Schedule Script Element Ids need to be omitted, and if so, removes them.
+     * @inheritdoc
+     * @beta
+     */
+    static deserialize(props) {
+        const elProps = super.deserialize(props);
+        const options = props.options?.element?.renderTimeline;
+        // Omit Schedule Script Element Ids if the option is set
+        if (options?.omitScriptElementIds && elProps.script) {
+            const scriptProps = RenderTimeline.parseScriptProps(elProps.script);
+            elProps.script = JSON.stringify(RenderSchedule.Script.removeScheduleScriptElementIds(scriptProps));
+        }
+        return elProps;
+    }
     static parseScriptProps(json) {
         try {
             return JSON.parse(json);