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

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
@@ -237,13 +248,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 +256,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 +331,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 +364,23 @@ 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,
+    };
 }
 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);
@@ -401,6 +414,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);
@@ -458,6 +473,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 +508,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 +551,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 +620,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 +667,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 +699,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 +752,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 +766,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 +787,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,6 +828,8 @@ 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;
@@ -831,7 +926,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 +953,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 +1116,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,6 +1243,8 @@ exports.LinkElement = LinkElement;
  */
 class UrlLink extends LinkElement {
     static get className() { return "UrlLink"; }
+    description;
+    url;
     constructor(props, iModel) {
         super(props, iModel);
         this.description = props.description;
@@ -1163,6 +1271,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,6 +1309,8 @@ exports.RoleElement = RoleElement;
  */
 class GeometryPart extends DefinitionElement {
     static get className() { return "GeometryPart"; }
+    geom;
+    bbox;
     constructor(props, iModel) {
         super(props, iModel);
         this.geom = props.geom;
@@ -1226,7 +1339,13 @@ 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;
+    }
     /** 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 +1363,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 ?? "";