@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/cjs/Element.js

@@ -6,7 +6,6 @@
 /** @packageDocumentation
  * @module Elements
  */
-var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RepositoryLink = exports.FolderLink = exports.UrlLink = exports.LinkElement = exports.GroupInformationElement = exports.SheetIndexPartition = exports.SpatialLocationPartition = exports.PhysicalPartition = exports.LinkPartition = exports.InformationRecordPartition = exports.GraphicalPartition3d = exports.GroupInformationPartition = exports.DocumentPartition = exports.DefinitionPartition = exports.InformationPartitionElement = exports.TemplateRecipe2d = exports.GraphicalType2d = exports.TemplateRecipe3d = exports.SpatialLocationType = exports.PhysicalType = exports.RecipeDefinitionElement = exports.TypeDefinitionElement = exports.DefinitionGroup = exports.DefinitionContainer = exports.DefinitionSet = exports.DefinitionElement = exports.InformationRecordElement = exports.Sheet = exports.SheetTemplate = exports.SheetBorderTemplate = exports.SectionDrawing = exports.Drawing = exports.Document = exports.Subject = exports.InformationReferenceElement = exports.DriverBundleElement = exports.InformationContentElement = exports.SectionDrawingLocation = exports.VolumeElement = exports.SpatialLocationElement = exports.PhysicalElement = exports.SpatialElement = exports.DrawingGraphic = exports.AnnotationElement2d = exports.GraphicalElement2d = exports.GeometricElement2d = exports.GraphicalElement3d = exports.GeometricElement3d = exports.GeometricElement = exports.Element = void 0;
 exports.RenderTimeline = exports.LineStyle = exports.GeometryPart = exports.RoleElement = exports.EmbeddedFileLink = void 0;
@@ -45,6 +44,18 @@ class Element extends Entity_1.Entity {
     static get className() { return "Element"; }
     /** @internal */
     static get protectedOperations() { return ["onInsert", "onUpdate", "onDelete"]; }
+    /** The ModelId of the [Model]($docs/bis/guide/fundamentals/model-fundamentals.md) containing this element */
+    model;
+    /** The [Code]($docs/bis/guide/fundamentals/codes.md) for this element */
+    code;
+    /** The parent element, if present, of this element. */
+    parent;
+    /** A [FederationGuid]($docs/bis/guide/fundamentals/element-fundamentals.md#federationguid) assigned to this element by some other federated database */
+    federationGuid;
+    /** A [user-assigned label]($docs/bis/guide/fundamentals/element-fundamentals.md#userlabel) for this element. */
+    userLabel;
+    /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this element. */
+    jsonProperties;
     constructor(props, iModel) {
         super(props, iModel);
         this.code = core_common_1.Code.fromJSON(props.code); // TODO: Validate props.code - don't silently fail if it is the wrong type
@@ -54,6 +65,51 @@ class Element extends Entity_1.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[Symbols_1._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.
@@ -78,6 +134,7 @@ class Element extends Entity_1.Entity {
         const locks = arg.iModel.locks;
         if (locks && !locks.holdsExclusiveLock(arg.model))
             locks[Symbols_1._elementWasCreated](arg.id);
+        arg.iModel.models[Symbols_1._cache].delete(arg.model);
     }
     /** Called before an Element is updated.
      * @note throw an exception to disallow the update
@@ -96,7 +153,10 @@ class Element extends Entity_1.Entity {
      * @note `this` is the class of the Element that was updated
      * @beta
      */
-    static onUpdated(_arg) { }
+    static onUpdated(arg) {
+        arg.iModel.elements[Symbols_1._cache].delete({ id: arg.id });
+        arg.iModel.models[Symbols_1._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.
@@ -112,7 +172,10 @@ class Element extends Entity_1.Entity {
      * @note `this` is the class of the Element that was deleted
      * @beta
      */
-    static onDeleted(_arg) { }
+    static onDeleted(arg) {
+        arg.iModel.elements[Symbols_1._cache].delete(arg);
+        arg.iModel.models[Symbols_1._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,
@@ -125,7 +188,10 @@ class Element extends Entity_1.Entity {
      * @note `this` is the class of the parent Element whose child was deleted
      * @beta
      */
-    static onChildDeleted(_arg) { }
+    static onChildDeleted(arg) {
+        arg.iModel.elements[Symbols_1._cache].delete({ id: arg.parentId });
+        arg.iModel.elements[Symbols_1._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.
@@ -136,7 +202,9 @@ class Element extends Entity_1.Entity {
      * @note `this` is the class of the parent Element.
      * @beta
      */
-    static onChildInserted(_arg) { }
+    static onChildInserted(arg) {
+        arg.iModel.elements[Symbols_1._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.
@@ -147,7 +215,9 @@ class Element extends Entity_1.Entity {
      * @note `this` is the class of the parent Element.
      * @beta
      */
-    static onChildUpdated(_arg) { }
+    static onChildUpdated(arg) {
+        arg.iModel.elements[Symbols_1._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.
@@ -158,7 +228,9 @@ class Element extends Entity_1.Entity {
      * @note `this` is the class of the new parent Element.
      * @beta
      */
-    static onChildAdded(_arg) { }
+    static onChildAdded(arg) {
+        arg.iModel.elements[Symbols_1._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.
@@ -169,7 +241,9 @@ class Element extends Entity_1.Entity {
      * @note `this` is the class of the previous parent Element.
      * @beta
      */
-    static onChildDropped(_arg) { }
+    static onChildDropped(arg) {
+        arg.iModel.elements[Symbols_1._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.
@@ -180,7 +254,11 @@ class Element extends Entity_1.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[Symbols_1._cache].delete({ id });
+        arg.iModel.models[Symbols_1._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.
@@ -191,7 +269,11 @@ class Element extends Entity_1.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[Symbols_1._cache].delete({ id });
+        arg.iModel.models[Symbols_1._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.
@@ -237,13 +319,6 @@ class Element extends Entity_1.Entity {
             val.jsonProperties = this.jsonProperties;
         return val;
     }
-    /** Collect the Ids of this element's *references* at this level of the class hierarchy.
-     * @deprecated in 3.x. use [[collectReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
-     * @beta
-     */
-    collectPredecessorIds(predecessorIds) {
-        return this.collectReferenceIds(predecessorIds);
-    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         referenceIds.addModel(this.model); // The modeledElement is a reference
@@ -252,15 +327,34 @@ class Element extends Entity_1.Entity {
         if (this.parent)
             referenceIds.addElement(this.parent.id); // A parent element is a reference
     }
-    /** Get the Ids of this element's *references*. A *reference* is any element whose id is stored in the EC data of this element
-     * This is important for cloning operations but can be useful in other situations as well.
+    /** A *required reference* is an element that had to be inserted before this element could have been inserted.
+     * This is the list of property keys on this element that store references to those elements
+     * @note This should be overridden (with `super` called) at each level of the class hierarchy that introduces required references.
+     * @note any property listed here must be added to the reference ids in [[collectReferenceIds]]
      * @beta
-     * @deprecated in 3.x. use [[getReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
      */
-    getPredecessorIds() {
-        return this.getReferenceIds();
-    }
-    /** Get the class metadata for this element. */
+    static requiredReferenceKeys = ["parent", "model"];
+    /** A map of every [[requiredReferenceKeys]] on this class to their entity type.
+     * @note This should be overridden (with `super` called) at each level of the class hierarchy that introduces required references.
+     * @alpha
+     */
+    static requiredReferenceKeyTypeMap = {
+        parent: core_common_1.ConcreteEntityTypes.Element,
+        model: core_common_1.ConcreteEntityTypes.Model,
+    };
+    /** Get the class metadata for this element.
+     * @deprecated in 5.0. Please use `getMetaData` provided by the parent class `Entity` instead.
+     *
+     * @example
+     * ```typescript
+     * // Current usage:
+     * const metaData: EntityMetaData | undefined = element.getClassMetaData();
+     *
+     * // Replacement:
+     * const metaData: EntityClass = await element.getMetaData();
+     * ```
+     */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     getClassMetaData() { return this.iModel.classMetaDataRegistry.find(this.classFullName); }
     getAllUserProperties() {
         if (!this.jsonProperties.UserProps)
@@ -308,26 +402,15 @@ class Element extends Entity_1.Entity {
     delete() { this.iModel.elements.deleteElement(this.id); }
 }
 exports.Element = Element;
-/** A *required reference* is an element that had to be inserted before this element could have been inserted.
- * This is the list of property keys on this element that store references to those elements
- * @note This should be overridden (with `super` called) at each level of the class hierarchy that introduces required references.
- * @note any property listed here must be added to the reference ids in [[collectReferenceIds]]
- * @beta
- */
-Element.requiredReferenceKeys = ["parent", "model"];
-/** A map of every [[requiredReferenceKeys]] on this class to their entity type.
- * @note This should be overridden (with `super` called) at each level of the class hierarchy that introduces required references.
- * @alpha
- */
-Element.requiredReferenceKeyTypeMap = {
-    parent: core_common_1.ConcreteEntityTypes.Element,
-    model: core_common_1.ConcreteEntityTypes.Model,
-};
 /** An abstract base class to model real world entities that intrinsically have geometry.
  * @public
  */
-class GeometricElement extends (_b = Element) {
+class GeometricElement extends Element {
     static get className() { return "GeometricElement"; }
+    /** The Id of the [[Category]] for this GeometricElement. */
+    category;
+    /** The GeometryStream for this GeometricElement. */
+    geom;
     constructor(props, iModel) {
         super(props, iModel);
         this.category = core_bentley_1.Id64.fromJSON(props.category);
@@ -352,22 +435,47 @@ class GeometricElement extends (_b = Element) {
         referenceIds.addElement(this.category);
         // TODO: GeometryPartIds?
     }
+    /** @beta */
+    static requiredReferenceKeys = [...super.requiredReferenceKeys, "category"];
+    /** @alpha */
+    static requiredReferenceKeyTypeMap = {
+        ...super.requiredReferenceKeyTypeMap,
+        category: core_common_1.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);
+    }
 }
 exports.GeometricElement = GeometricElement;
-_a = GeometricElement;
-/** @beta */
-GeometricElement.requiredReferenceKeys = [...Reflect.get(_b, "requiredReferenceKeys", _a), "category"];
-/** @alpha */
-GeometricElement.requiredReferenceKeyTypeMap = {
-    ...Reflect.get(_b, "requiredReferenceKeyTypeMap", _a),
-    category: core_common_1.ConcreteEntityTypes.Element,
-};
 /** 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
  */
 class GeometricElement3d extends GeometricElement {
     static get className() { return "GeometricElement3d"; }
+    placement;
+    typeDefinition;
     constructor(props, iModel) {
         super(props, iModel);
         this.placement = core_common_1.Placement3d.fromJSON(props.placement);
@@ -386,6 +494,123 @@ 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: core_geometry_1.YawPitchRollAngles.createDegrees(instance.yaw ?? 0, instance.pitch ?? 0, instance.roll ?? 0).toJSON(),
+            bbox
+        };
+        if (instance.geometryStream) {
+            elProps.geom = props.iModel[Symbols_1._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[Symbols_1._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[Symbols_1._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;
+    }
 }
 exports.GeometricElement3d = GeometricElement3d;
 /** A 3d Graphical Element
@@ -401,6 +626,8 @@ exports.GraphicalElement3d = GraphicalElement3d;
  */
 class GeometricElement2d extends GeometricElement {
     static get className() { return "GeometricElement2d"; }
+    placement;
+    typeDefinition;
     constructor(props, iModel) {
         super(props, iModel);
         this.placement = core_common_1.Placement2d.fromJSON(props.placement);
@@ -414,6 +641,123 @@ 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[Symbols_1._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[Symbols_1._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[Symbols_1._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)
@@ -458,6 +802,8 @@ exports.SpatialElement = SpatialElement;
  */
 class PhysicalElement extends SpatialElement {
     static get className() { return "PhysicalElement"; }
+    /** If defined, the [[PhysicalMaterial]] that makes up this PhysicalElement. */
+    physicalMaterial;
     constructor(props, iModel) {
         super(props, iModel);
         this.physicalMaterial = core_common_1.RelatedElement.fromJSON(props.physicalMaterial);
@@ -491,6 +837,8 @@ exports.VolumeElement = VolumeElement;
  * @public
  */
 class SectionDrawingLocation extends SpatialLocationElement {
+    /** The Id of the [[ViewDefinition]] to which this location refers. */
+    sectionView;
     static get className() { return "SectionDrawingLocation"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -532,12 +880,15 @@ class InformationReferenceElement extends InformationContentElement {
 }
 exports.InformationReferenceElement = InformationReferenceElement;
 /** A Subject is an information element that describes what this repository (or part thereof) is about.
- * See [how to create a Subject element]($docs/learning/backend/CreateElements.md#Subject).
  * @public
  */
 class Subject extends InformationReferenceElement {
     static get className() { return "Subject"; }
-    constructor(props, iModel) { super(props, iModel); }
+    description;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.description = props.description;
+    }
     toJSON() {
         return super.toJSON(); // Entity.toJSON takes care of auto-handled properties
     }
@@ -598,8 +949,38 @@ exports.Document = Document;
  * @public
  */
 class Drawing extends Document {
+    _scaleFactor;
+    /** A factor used by tools to adjust the size of text in [GeometricElement2d]($backend)s in the associated [DrawingModel]($backend) and to compute the
+     * 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
+     */
+    get scaleFactor() { return this._scaleFactor; }
+    set scaleFactor(factor) {
+        if (factor <= 0) {
+            if (this._scaleFactor === undefined) {
+                // Entity constructor calls our setter before our constructor runs...don't throw an exception at that time,
+                // because somebody may have persisted the value as zero.
+                return;
+            }
+            throw new Error("Drawing.scaleFactor must be greater than zero");
+        }
+        this._scaleFactor = factor;
+    }
     static get className() { return "Drawing"; }
-    constructor(props, iModel) { super(props, iModel); }
+    constructor(props, iModel) {
+        super(props, iModel);
+        this._scaleFactor = typeof props.scaleFactor === "number" && props.scaleFactor > 0 ? props.scaleFactor : 1;
+    }
+    toJSON() {
+        const drawingProps = super.toJSON();
+        // Entity.toJSON auto-magically sets drawingProps.scaleFactor from this.scaleFactor - unset if default value of 1.
+        if (drawingProps.scaleFactor === 1) {
+            delete drawingProps.scaleFactor;
+        }
+        return drawingProps;
+    }
     /** The name of the DrawingModel class modeled by this element type. */
     static get drawingModelFullClassName() { return Model_1.DrawingModel.classFullName; }
     /** Create a Code for a Drawing given a name that is meant to be unique within the scope of the specified DocumentListModel.
@@ -615,15 +996,23 @@ class Drawing extends Document {
      * @param iModelDb Insert into this iModel
      * @param documentListModelId Insert the new Drawing into this DocumentListModel
      * @param name The name of the Drawing.
+     * @param scaleFactor See [[scaleFactor]]. Must be greater than zero.
      * @returns The Id of the newly inserted Drawing element and the DrawingModel that breaks it down (same value).
      * @throws [[IModelError]] if unable to insert the element.
+     * @throws Error if `scaleFactor` is less than or equal to zero.
      */
-    static insert(iModelDb, documentListModelId, name) {
+    static insert(iModelDb, documentListModelId, name, scaleFactor) {
         const drawingProps = {
             classFullName: this.classFullName,
             model: documentListModelId,
             code: this.createCode(iModelDb, documentListModelId, name),
         };
+        if (scaleFactor !== undefined) {
+            if (scaleFactor <= 0) {
+                throw new Error("Drawing.scaleFactor must be greater than zero");
+            }
+            drawingProps.scaleFactor = scaleFactor;
+        }
         const drawingId = iModelDb.elements.insertElement(drawingProps);
         const model = iModelDb.models.createModel({
             classFullName: this.drawingModelFullClassName,
@@ -639,6 +1028,21 @@ exports.Drawing = Drawing;
  * @public
  */
 class SectionDrawing extends Drawing {
+    /** The type of section used to generate the drawing. */
+    sectionType;
+    /** The spatial view from which the section was generated. */
+    spatialView;
+    /** A transform from the section drawing model's coordinates to spatial coordinates. */
+    drawingToSpatialTransform;
+    /** If the section drawing is placed onto a [[Sheet]] via a [[ViewAttachment]], a transform from the sheet's coordinates to spatial coordinates. */
+    sheetToSpatialTransform;
+    /** If the section drawing is placed onto a [[Sheet]] via a [[ViewAttachment]], the clip to apply to the sheet graphics when drawn in the context
+     * of the spatial view.
+     * @note The ClipVector is defined in spatial coordinates.
+     */
+    drawingBoundaryClip;
+    /** If true, when displaying the section drawing as a [DrawingViewState]($frontend), the [[spatialView]] will also be displayed. */
+    displaySpatialView;
     static get className() { return "SectionDrawing"; }
     static get drawingModelFullClassName() { return Model_1.SectionDrawingModel.classFullName; }
     constructor(props, iModel) {
@@ -677,7 +1081,13 @@ exports.SectionDrawing = SectionDrawing;
  */
 class SheetBorderTemplate extends Document {
     static get className() { return "SheetBorderTemplate"; }
-    constructor(props, iModel) { super(props, iModel); }
+    height;
+    width;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.height = props.height;
+        this.width = props.width;
+    }
 }
 exports.SheetBorderTemplate = SheetBorderTemplate;
 /** The template for a [[Sheet]]
@@ -685,7 +1095,15 @@ exports.SheetBorderTemplate = SheetBorderTemplate;
  */
 class SheetTemplate extends Document {
     static get className() { return "SheetTemplate"; }
-    constructor(props, iModel) { super(props, iModel); }
+    height;
+    width;
+    border;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.height = props.height;
+        this.width = props.width;
+        this.border = props.border;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         if (undefined !== this.border)
@@ -698,6 +1116,10 @@ exports.SheetTemplate = SheetTemplate;
  */
 class Sheet extends Document {
     static get className() { return "Sheet"; }
+    height;
+    width;
+    scale;
+    sheetTemplate;
     constructor(props, iModel) {
         super(props, iModel);
         this.height = core_bentley_1.JsonUtils.asDouble(props.height);
@@ -735,10 +1157,43 @@ exports.InformationRecordElement = InformationRecordElement;
  */
 class DefinitionElement extends InformationContentElement {
     static get className() { return "DefinitionElement"; }
+    /** If true, don't show this DefinitionElement in user interface lists. */
+    isPrivate;
     constructor(props, iModel) {
         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;
@@ -831,7 +1286,11 @@ exports.DefinitionGroup = DefinitionGroup;
  */
 class TypeDefinitionElement extends DefinitionElement {
     static get className() { return "TypeDefinitionElement"; }
-    constructor(props, iModel) { super(props, iModel); }
+    recipe;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.recipe = this.recipe;
+    }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
         if (undefined !== this.recipe)
@@ -854,6 +1313,8 @@ exports.RecipeDefinitionElement = RecipeDefinitionElement;
  */
 class PhysicalType extends TypeDefinitionElement {
     static get className() { return "PhysicalType"; }
+    /** If defined, the [[PhysicalMaterial]] that makes up this PhysicalType. */
+    physicalMaterial;
     constructor(props, iModel) {
         super(props, iModel);
         this.physicalMaterial = core_common_1.RelatedElement.fromJSON(props.physicalMaterial);
@@ -1015,7 +1476,12 @@ exports.TemplateRecipe2d = TemplateRecipe2d;
  */
 class InformationPartitionElement extends InformationContentElement {
     static get className() { return "InformationPartitionElement"; }
-    constructor(props, iModel) { super(props, iModel); }
+    /** A human-readable string describing the intent of the partition. */
+    description;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.description = props.description;
+    }
     toJSON() {
         return super.toJSON(); // Entity.toJSON takes care of auto-handled properties
     }
@@ -1137,11 +1603,43 @@ exports.LinkElement = LinkElement;
  */
 class UrlLink extends LinkElement {
     static get className() { return "UrlLink"; }
+    description;
+    url;
     constructor(props, iModel) {
         super(props, iModel);
         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;
@@ -1163,6 +1661,9 @@ exports.FolderLink = FolderLink;
  */
 class RepositoryLink extends UrlLink {
     static get className() { return "RepositoryLink"; }
+    repositoryGuid;
+    /** @note This property was added to the BisCore schema in version 1.0.13 */
+    format;
     constructor(props, iModel) {
         super(props, iModel);
         this.repositoryGuid = props.repositoryGuid;
@@ -1198,11 +1699,80 @@ exports.RoleElement = RoleElement;
  */
 class GeometryPart extends DefinitionElement {
     static get className() { return "GeometryPart"; }
+    geom;
+    bbox;
     constructor(props, iModel) {
         super(props, iModel);
         this.geom = props.geom;
         this.bbox = core_geometry_1.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[Symbols_1._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[Symbols_1._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;
@@ -1226,7 +1796,42 @@ exports.GeometryPart = GeometryPart;
  */
 class LineStyle extends DefinitionElement {
     static get className() { return "LineStyle"; }
-    constructor(props, iModel) { super(props, iModel); }
+    description;
+    data;
+    constructor(props, iModel) {
+        super(props, iModel);
+        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.
@@ -1244,6 +1849,12 @@ exports.LineStyle = LineStyle;
  */
 class RenderTimeline extends InformationRecordElement {
     static get className() { return "RenderTimeline"; }
+    /** A human-readable description of the timeline, which may be an empty string. */
+    description;
+    /** The JSON representation of the instructions for visualizing change over time.
+     * @see [RenderSchedule.Script]($common) for the API for working with the script.
+     */
+    scriptProps;
     constructor(props, iModel) {
         super(props, iModel);
         this.description = props.description ?? "";
@@ -1259,6 +1870,21 @@ 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(core_common_1.RenderSchedule.Script.removeScheduleScriptElementIds(scriptProps));
+        }
+        return elProps;
+    }
     static parseScriptProps(json) {
         try {
             return JSON.parse(json);