@itwin/core-backend 5.1.0-dev.9 → 5.2.0-dev.2

package/lib/cjs/Element.js

@@ -16,6 +16,7 @@ const Entity_1 = require("./Entity");
 const Model_1 = require("./Model");
 const NavigationRelationship_1 = require("./NavigationRelationship");
 const Symbols_1 = require("./internal/Symbols");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
 /** The smallest individually identifiable building block for modeling the real world in an iModel.
  * Each element represents an [[Entity]] in the real world. Sets of Elements (contained in [[Model]]s) are used to model
  * other Elements that represent larger scale real world entities. Using this recursive modeling strategy,
@@ -38,7 +39,7 @@ const Symbols_1 = require("./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
  */
 class Element extends Entity_1.Entity {
     static get className() { return "Element"; }
@@ -343,7 +344,7 @@ class Element extends Entity_1.Entity {
         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.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `getMetaData` provided by the parent class `Entity` instead.
      *
      * @example
      * ```typescript
@@ -356,6 +357,20 @@ class Element extends Entity_1.Entity {
      */
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     getClassMetaData() { return this.iModel.classMetaDataRegistry.find(this.classFullName); }
+    /** Query metadata for this entity class from the iModel's schema. Returns cached metadata if available.*/
+    async getMetaData() {
+        if (this._metadata && ecschema_metadata_1.EntityClass.isEntityClass(this._metadata)) {
+            return this._metadata;
+        }
+        const entity = await this.iModel.schemaContext.getSchemaItem(this.schemaItemKey, ecschema_metadata_1.EntityClass);
+        if (entity !== undefined) {
+            this._metadata = entity;
+            return this._metadata;
+        }
+        else {
+            throw new Error(`Cannot get metadata for ${this.classFullName}`);
+        }
+    }
     getAllUserProperties() {
         if (!this.jsonProperties.UserProps)
             this.jsonProperties.UserProps = new Object();
@@ -403,7 +418,7 @@ class Element extends Entity_1.Entity {
 }
 exports.Element = Element;
 /** An abstract base class to model real world entities that intrinsically have geometry.
- * @public
+ * @public @preview
  */
 class GeometricElement extends Element {
     static get className() { return "GeometricElement"; }
@@ -470,7 +485,7 @@ class GeometricElement extends Element {
 exports.GeometricElement = GeometricElement;
 /** 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
  */
 class GeometricElement3d extends GeometricElement {
     static get className() { return "GeometricElement3d"; }
@@ -614,7 +629,7 @@ class GeometricElement3d extends GeometricElement {
 }
 exports.GeometricElement3d = GeometricElement3d;
 /** A 3d Graphical Element
- * @public
+ * @public @preview
  */
 class GraphicalElement3d extends GeometricElement3d {
     static get className() { return "GraphicalElement3d"; }
@@ -622,7 +637,7 @@ class GraphicalElement3d extends GeometricElement3d {
 }
 exports.GraphicalElement3d = GraphicalElement3d;
 /** An abstract base class to model information entities that intrinsically have 2d geometry.
- * @public
+ * @public @preview
  */
 class GeometricElement2d extends GeometricElement {
     static get className() { return "GeometricElement2d"; }
@@ -766,7 +781,7 @@ class GeometricElement2d extends GeometricElement {
 }
 exports.GeometricElement2d = GeometricElement2d;
 /** An abstract base class for 2d Geometric Elements that are used to convey information within graphical presentations (like drawings).
- * @public
+ * @public @preview
  */
 class GraphicalElement2d extends GeometricElement2d {
     static get className() { return "GraphicalElement2d"; }
@@ -774,7 +789,7 @@ class GraphicalElement2d extends GeometricElement2d {
 }
 exports.GraphicalElement2d = GraphicalElement2d;
 /** 2d element used to annotate drawings and sheets.
- * @public
+ * @public @preview
  */
 class AnnotationElement2d extends GraphicalElement2d {
     static get className() { return "AnnotationElement2d"; }
@@ -782,7 +797,7 @@ class AnnotationElement2d extends GraphicalElement2d {
 }
 exports.AnnotationElement2d = AnnotationElement2d;
 /** 2d element used to persist graphics for use in drawings.
- * @public
+ * @public @preview
  */
 class DrawingGraphic extends GraphicalElement2d {
     static get className() { return "DrawingGraphic"; }
@@ -790,7 +805,7 @@ class DrawingGraphic extends GraphicalElement2d {
 }
 exports.DrawingGraphic = DrawingGraphic;
 /** An Element that occupies real world space. Its coordinates are in the project space of its iModel.
- * @public
+ * @public @preview
  */
 class SpatialElement extends GeometricElement3d {
     static get className() { return "SpatialElement"; }
@@ -798,7 +813,7 @@ class SpatialElement extends GeometricElement3d {
 }
 exports.SpatialElement = SpatialElement;
 /** An Element that is spatially located, has mass, and can be *touched*.
- * @public
+ * @public @preview
  */
 class PhysicalElement extends SpatialElement {
     static get className() { return "PhysicalElement"; }
@@ -816,7 +831,7 @@ class PhysicalElement extends SpatialElement {
 }
 exports.PhysicalElement = PhysicalElement;
 /** Identifies a *tracked* real world location but has no mass and cannot be *touched*.
- * @public
+ * @public @preview
  */
 class SpatialLocationElement extends SpatialElement {
     static get className() { return "SpatialLocationElement"; }
@@ -824,7 +839,7 @@ class SpatialLocationElement extends SpatialElement {
 }
 exports.SpatialLocationElement = SpatialLocationElement;
 /** A Volume Element is a Spatial Location Element that is restricted to defining a volume.
- * @public
+ * @public @preview
  */
 class VolumeElement extends SpatialLocationElement {
     static get className() { return "VolumeElement"; }
@@ -834,7 +849,7 @@ exports.VolumeElement = VolumeElement;
 /** 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
  */
 class SectionDrawingLocation extends SpatialLocationElement {
     /** The Id of the [[ViewDefinition]] to which this location refers. */
@@ -855,7 +870,7 @@ exports.SectionDrawingLocation = SectionDrawingLocation;
 /** 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
  */
 class InformationContentElement extends Element {
     static get className() { return "InformationContentElement"; }
@@ -872,7 +887,7 @@ class DriverBundleElement extends InformationContentElement {
 }
 exports.DriverBundleElement = DriverBundleElement;
 /** Information Reference is an abstract base class for modeling entities whose main purpose is to reference something else.
- * @public
+ * @public @preview
  */
 class InformationReferenceElement extends InformationContentElement {
     static get className() { return "InformationReferenceElement"; }
@@ -880,7 +895,7 @@ class InformationReferenceElement extends InformationContentElement {
 }
 exports.InformationReferenceElement = InformationReferenceElement;
 /** A Subject is an information element that describes what this repository (or part thereof) is about.
- * @public
+ * @public @preview
  */
 class Subject extends InformationReferenceElement {
     static get className() { return "Subject"; }
@@ -938,7 +953,7 @@ exports.Subject = Subject;
  * 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
  */
 class Document extends InformationContentElement {
     static get className() { return "Document"; }
@@ -946,7 +961,7 @@ class Document extends InformationContentElement {
 }
 exports.Document = Document;
 /** 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
  */
 class Drawing extends Document {
     _scaleFactor;
@@ -954,7 +969,7 @@ 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) {
@@ -1025,7 +1040,7 @@ exports.Drawing = Drawing;
 /** 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
  */
 class SectionDrawing extends Drawing {
     /** The type of section used to generate the drawing. */
@@ -1077,7 +1092,7 @@ class SectionDrawing extends Drawing {
 }
 exports.SectionDrawing = SectionDrawing;
 /** The template for a SheetBorder
- * @public
+ * @public @preview
  */
 class SheetBorderTemplate extends Document {
     static get className() { return "SheetBorderTemplate"; }
@@ -1091,7 +1106,7 @@ class SheetBorderTemplate extends Document {
 }
 exports.SheetBorderTemplate = SheetBorderTemplate;
 /** The template for a [[Sheet]]
- * @public
+ * @public @preview
  */
 class SheetTemplate extends Document {
     static get className() { return "SheetTemplate"; }
@@ -1112,7 +1127,7 @@ class SheetTemplate extends Document {
 }
 exports.SheetTemplate = SheetTemplate;
 /** A digital representation of a *sheet of paper*. Modeled by a [[SheetModel]].
- * @public
+ * @public @preview
  */
 class Sheet extends Document {
     static get className() { return "Sheet"; }
@@ -1145,7 +1160,7 @@ class Sheet extends Document {
 exports.Sheet = Sheet;
 /** 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
  */
 class InformationRecordElement extends InformationContentElement {
     static get className() { return "InformationRecordElement"; }
@@ -1153,7 +1168,7 @@ class InformationRecordElement extends InformationContentElement {
 }
 exports.InformationRecordElement = InformationRecordElement;
 /** A Definition Element holds configuration-related information that is meant to be referenced / shared.
- * @public
+ * @public @preview
  */
 class DefinitionElement extends InformationContentElement {
     static get className() { return "DefinitionElement"; }
@@ -1203,7 +1218,7 @@ class DefinitionElement extends InformationContentElement {
 exports.DefinitionElement = DefinitionElement;
 /** 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
  */
 class DefinitionSet extends DefinitionElement {
     static get className() { return "DefinitionSet"; }
@@ -1211,7 +1226,7 @@ class DefinitionSet extends DefinitionElement {
 exports.DefinitionSet = 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
  */
 class DefinitionContainer extends DefinitionSet {
     static get className() { return "DefinitionContainer"; }
@@ -1257,7 +1272,7 @@ class DefinitionContainer extends DefinitionSet {
 exports.DefinitionContainer = DefinitionContainer;
 /** 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
  */
 class DefinitionGroup extends DefinitionSet {
     static get className() { return "DefinitionGroup"; }
@@ -1282,14 +1297,14 @@ class DefinitionGroup extends DefinitionSet {
 }
 exports.DefinitionGroup = DefinitionGroup;
 /** Defines a set of properties (the *type*) that may be associated with an element.
- * @public
+ * @public @preview
  */
 class TypeDefinitionElement extends DefinitionElement {
     static get className() { return "TypeDefinitionElement"; }
     recipe;
     constructor(props, iModel) {
         super(props, iModel);
-        this.recipe = this.recipe;
+        this.recipe = core_common_1.RelatedElement.fromJSON(props.recipe);
     }
     collectReferenceIds(referenceIds) {
         super.collectReferenceIds(referenceIds);
@@ -1309,7 +1324,7 @@ exports.RecipeDefinitionElement = RecipeDefinitionElement;
 /** 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
  */
 class PhysicalType extends TypeDefinitionElement {
     static get className() { return "PhysicalType"; }
@@ -1336,7 +1351,7 @@ class PhysicalType extends TypeDefinitionElement {
 }
 exports.PhysicalType = PhysicalType;
 /** Defines a set of properties (the *type*) that can be associated with a spatial location.
- * @public
+ * @public @preview
  */
 class SpatialLocationType extends TypeDefinitionElement {
     static get className() { return "SpatialLocationType"; }
@@ -1403,7 +1418,7 @@ class TemplateRecipe3d extends RecipeDefinitionElement {
 }
 exports.TemplateRecipe3d = TemplateRecipe3d;
 /** Defines a set of properties (the *type*) that can be associated with a 2D Graphical Element.
- * @public
+ * @public @preview
  */
 class GraphicalType2d extends TypeDefinitionElement {
     static get className() { return "GraphicalType2d"; }
@@ -1472,7 +1487,7 @@ exports.TemplateRecipe2d = TemplateRecipe2d;
 /** 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
  */
 class InformationPartitionElement extends InformationContentElement {
     static get className() { return "InformationPartitionElement"; }
@@ -1499,7 +1514,7 @@ exports.InformationPartitionElement = InformationPartitionElement;
 /** 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
  */
 class DefinitionPartition extends InformationPartitionElement {
     static get className() { return "DefinitionPartition"; }
@@ -1508,7 +1523,7 @@ exports.DefinitionPartition = DefinitionPartition;
 /** 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
  */
 class DocumentPartition extends InformationPartitionElement {
     static get className() { return "DocumentPartition"; }
@@ -1517,7 +1532,7 @@ exports.DocumentPartition = DocumentPartition;
 /** 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
  */
 class GroupInformationPartition extends InformationPartitionElement {
     static get className() { return "GroupInformationPartition"; }
@@ -1527,7 +1542,7 @@ exports.GroupInformationPartition = GroupInformationPartition;
  * 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
  */
 class GraphicalPartition3d extends InformationPartitionElement {
     static get className() { return "GraphicalPartition3d"; }
@@ -1536,7 +1551,7 @@ exports.GraphicalPartition3d = GraphicalPartition3d;
 /** 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
  */
 class InformationRecordPartition extends InformationPartitionElement {
     static get className() { return "InformationRecordPartition"; }
@@ -1544,7 +1559,7 @@ class InformationRecordPartition extends InformationPartitionElement {
 exports.InformationRecordPartition = 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
  */
 class LinkPartition extends InformationPartitionElement {
     static get className() { return "LinkPartition"; }
@@ -1552,7 +1567,7 @@ class LinkPartition extends InformationPartitionElement {
 exports.LinkPartition = 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
  */
 class PhysicalPartition extends InformationPartitionElement {
     static get className() { return "PhysicalPartition"; }
@@ -1561,7 +1576,7 @@ exports.PhysicalPartition = PhysicalPartition;
 /** 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
  */
 class SpatialLocationPartition extends InformationPartitionElement {
     static get className() { return "SpatialLocationPartition"; }
@@ -1576,14 +1591,14 @@ class SheetIndexPartition extends InformationPartitionElement {
 }
 exports.SheetIndexPartition = 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
  */
 class GroupInformationElement extends InformationReferenceElement {
     static get className() { return "GroupInformationElement"; }
 }
 exports.GroupInformationElement = GroupInformationElement;
 /** An information element that specifies a link.
- * @public
+ * @public @preview
  */
 class LinkElement extends InformationReferenceElement {
     static get className() { return "LinkElement"; }
@@ -1599,7 +1614,7 @@ class LinkElement extends InformationReferenceElement {
 }
 exports.LinkElement = LinkElement;
 /** An information element that specifies a URL link.
- * @public
+ * @public @preview
  */
 class UrlLink extends LinkElement {
     static get className() { return "UrlLink"; }
@@ -1657,7 +1672,7 @@ class FolderLink extends UrlLink {
 }
 exports.FolderLink = FolderLink;
 /** An information element that links to a repository.
- * @public
+ * @public @preview
  */
 class RepositoryLink extends UrlLink {
     static get className() { return "RepositoryLink"; }
@@ -1678,7 +1693,7 @@ class RepositoryLink extends UrlLink {
 }
 exports.RepositoryLink = RepositoryLink;
 /** An information element that links to an embedded file.
- * @public
+ * @public @preview
  */
 class EmbeddedFileLink extends LinkElement {
     static get className() { return "EmbeddedFileLink"; }
@@ -1687,7 +1702,7 @@ exports.EmbeddedFileLink = EmbeddedFileLink;
 /** 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
  */
 class RoleElement extends Element {
     static get className() { return "RoleElement"; }
@@ -1695,7 +1710,7 @@ class RoleElement extends Element {
 exports.RoleElement = 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
  */
 class GeometryPart extends DefinitionElement {
     static get className() { return "GeometryPart"; }
@@ -1792,7 +1807,7 @@ class GeometryPart extends DefinitionElement {
 }
 exports.GeometryPart = GeometryPart;
 /** The definition element for a line style
- * @public
+ * @public @preview
  */
 class LineStyle extends DefinitionElement {
     static get className() { return "LineStyle"; }
@@ -1845,7 +1860,7 @@ class LineStyle extends DefinitionElement {
 exports.LineStyle = LineStyle;
 /** 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
  */
 class RenderTimeline extends InformationRecordElement {
     static get className() { return "RenderTimeline"; }