@itwin/core-backend 4.8.0-dev.9 → 4.9.0-dev.2

package/lib/cjs/Element.js

@@ -16,6 +16,7 @@ const core_geometry_1 = require("@itwin/core-geometry");
 const Entity_1 = require("./Entity");
 const Model_1 = require("./Model");
 const NavigationRelationship_1 = require("./NavigationRelationship");
+const Symbols_1 = require("./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,
@@ -41,7 +42,6 @@ const NavigationRelationship_1 = require("./NavigationRelationship");
  * @public
  */
 class Element extends Entity_1.Entity {
-    /** @internal */
     static get className() { return "Element"; }
     /** @internal */
     static get protectedOperations() { return ["onInsert", "onUpdate", "onDelete"]; }
@@ -63,7 +63,7 @@ class Element extends Entity_1.Entity {
     static onInsert(arg) {
         const { iModel, props } = arg;
         const operation = "insert";
-        iModel.channels.verifyChannel(arg.props.model);
+        iModel.channels[Symbols_1._verifyChannel](arg.props.model);
         iModel.locks.checkSharedLock(props.model, "model", operation); // inserting requires shared lock on model
         if (props.parent) // inserting requires shared lock on parent, if present
             iModel.locks.checkSharedLock(props.parent.id, "parent", operation);
@@ -77,7 +77,7 @@ class Element extends Entity_1.Entity {
     static onInserted(arg) {
         const locks = arg.iModel.locks;
         if (locks && !locks.holdsExclusiveLock(arg.model))
-            locks.elementWasCreated(arg.id);
+            locks[Symbols_1._elementWasCreated](arg.id);
     }
     /** Called before an Element is updated.
      * @note throw an exception to disallow the update
@@ -87,7 +87,7 @@ class Element extends Entity_1.Entity {
      */
     static onUpdate(arg) {
         const { iModel, props } = arg;
-        iModel.channels.verifyChannel(props.model);
+        iModel.channels[Symbols_1._verifyChannel](props.model);
         iModel.locks.checkExclusiveLock(props.id, "element", "update"); // eslint-disable-line @typescript-eslint/no-non-null-assertion
         iModel.codeService?.verifyCode(arg);
     }
@@ -104,7 +104,7 @@ class Element extends Entity_1.Entity {
      * @beta
      */
     static onDelete(arg) {
-        arg.iModel.channels.verifyChannel(arg.model);
+        arg.iModel.channels[Symbols_1._verifyChannel](arg.model);
         arg.iModel.locks.checkExclusiveLock(arg.id, "element", "delete");
     }
     /** Called after an Element was deleted.
@@ -327,7 +327,6 @@ Element.requiredReferenceKeyTypeMap = {
  * @public
  */
 class GeometricElement extends (_b = Element) {
-    /** @internal */
     static get className() { return "GeometricElement"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -368,7 +367,6 @@ GeometricElement.requiredReferenceKeyTypeMap = {
  * @public
  */
 class GeometricElement3d extends GeometricElement {
-    /** @internal */
     static get className() { return "GeometricElement3d"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -394,7 +392,6 @@ exports.GeometricElement3d = GeometricElement3d;
  * @public
  */
 class GraphicalElement3d extends GeometricElement3d {
-    /** @internal */
     static get className() { return "GraphicalElement3d"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -403,7 +400,6 @@ exports.GraphicalElement3d = GraphicalElement3d;
  * @public
  */
 class GeometricElement2d extends GeometricElement {
-    /** @internal */
     static get className() { return "GeometricElement2d"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -429,7 +425,6 @@ exports.GeometricElement2d = GeometricElement2d;
  * @public
  */
 class GraphicalElement2d extends GeometricElement2d {
-    /** @internal */
     static get className() { return "GraphicalElement2d"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -438,7 +433,6 @@ exports.GraphicalElement2d = GraphicalElement2d;
  * @public
  */
 class AnnotationElement2d extends GraphicalElement2d {
-    /** @internal */
     static get className() { return "AnnotationElement2d"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -447,7 +441,6 @@ exports.AnnotationElement2d = AnnotationElement2d;
  * @public
  */
 class DrawingGraphic extends GraphicalElement2d {
-    /** @internal */
     static get className() { return "DrawingGraphic"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -456,7 +449,6 @@ exports.DrawingGraphic = DrawingGraphic;
  * @public
  */
 class SpatialElement extends GeometricElement3d {
-    /** @internal */
     static get className() { return "SpatialElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -465,7 +457,6 @@ exports.SpatialElement = SpatialElement;
  * @public
  */
 class PhysicalElement extends SpatialElement {
-    /** @internal */
     static get className() { return "PhysicalElement"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -482,7 +473,6 @@ exports.PhysicalElement = PhysicalElement;
  * @public
  */
 class SpatialLocationElement extends SpatialElement {
-    /** @internal */
     static get className() { return "SpatialLocationElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -491,7 +481,6 @@ exports.SpatialLocationElement = SpatialLocationElement;
  * @public
  */
 class VolumeElement extends SpatialLocationElement {
-    /** @internal */
     static get className() { return "VolumeElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -502,7 +491,6 @@ exports.VolumeElement = VolumeElement;
  * @public
  */
 class SectionDrawingLocation extends SpatialLocationElement {
-    /** @internal */
     static get className() { return "SectionDrawingLocation"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -522,7 +510,6 @@ exports.SectionDrawingLocation = SectionDrawingLocation;
  * @public
  */
 class InformationContentElement extends Element {
-    /** @internal */
     static get className() { return "InformationContentElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -532,7 +519,6 @@ exports.InformationContentElement = InformationContentElement;
  * @beta
  */
 class DriverBundleElement extends InformationContentElement {
-    /** @internal */
     static get className() { return "DriverBundleElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -541,7 +527,6 @@ exports.DriverBundleElement = DriverBundleElement;
  * @public
  */
 class InformationReferenceElement extends InformationContentElement {
-    /** @internal */
     static get className() { return "InformationReferenceElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -551,7 +536,6 @@ exports.InformationReferenceElement = InformationReferenceElement;
  * @public
  */
 class Subject extends InformationReferenceElement {
-    /** @internal */
     static get className() { return "Subject"; }
     constructor(props, iModel) { super(props, iModel); }
     toJSON() {
@@ -606,7 +590,6 @@ exports.Subject = Subject;
  * @public
  */
 class Document extends InformationContentElement {
-    /** @internal */
     static get className() { return "Document"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -615,12 +598,9 @@ exports.Document = Document;
  * @public
  */
 class Drawing extends Document {
-    /** @internal */
     static get className() { return "Drawing"; }
     constructor(props, iModel) { super(props, iModel); }
-    /** The name of the DrawingModel class modeled by this element type.
-     * @internal
-     */
+    /** 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.
      * @param iModel  The IModelDb
@@ -659,9 +639,7 @@ exports.Drawing = Drawing;
  * @public
  */
 class SectionDrawing extends Drawing {
-    /** @internal */
     static get className() { return "SectionDrawing"; }
-    /** @internal */
     static get drawingModelFullClassName() { return Model_1.SectionDrawingModel.classFullName; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -698,7 +676,6 @@ exports.SectionDrawing = SectionDrawing;
  * @public
  */
 class SheetBorderTemplate extends Document {
-    /** @internal */
     static get className() { return "SheetBorderTemplate"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -707,7 +684,6 @@ exports.SheetBorderTemplate = SheetBorderTemplate;
  * @public
  */
 class SheetTemplate extends Document {
-    /** @internal */
     static get className() { return "SheetTemplate"; }
     constructor(props, iModel) { super(props, iModel); }
     collectReferenceIds(referenceIds) {
@@ -721,7 +697,6 @@ exports.SheetTemplate = SheetTemplate;
  * @public
  */
 class Sheet extends Document {
-    /** @internal */
     static get className() { return "Sheet"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -751,7 +726,6 @@ exports.Sheet = Sheet;
  * @public
  */
 class InformationRecordElement extends InformationContentElement {
-    /** @internal */
     static get className() { return "InformationRecordElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -760,7 +734,6 @@ exports.InformationRecordElement = InformationRecordElement;
  * @public
  */
 class DefinitionElement extends InformationContentElement {
-    /** @internal */
     static get className() { return "DefinitionElement"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -778,7 +751,6 @@ exports.DefinitionElement = DefinitionElement;
  * @public
  */
 class DefinitionSet extends DefinitionElement {
-    /** @internal */
     static get className() { return "DefinitionSet"; }
 }
 exports.DefinitionSet = DefinitionSet;
@@ -787,7 +759,6 @@ exports.DefinitionSet = DefinitionSet;
  * @public
  */
 class DefinitionContainer extends DefinitionSet {
-    /** @internal */
     static get className() { return "DefinitionContainer"; }
     /** Create a DefinitionContainer
      * @param iModelDb The IModelDb
@@ -834,7 +805,6 @@ exports.DefinitionContainer = DefinitionContainer;
  * @public
  */
 class DefinitionGroup extends DefinitionSet {
-    /** @internal */
     static get className() { return "DefinitionGroup"; }
     /** Create a DefinitionGroup
      * @param iModelDb The IModelDb
@@ -860,7 +830,6 @@ exports.DefinitionGroup = DefinitionGroup;
  * @public
  */
 class TypeDefinitionElement extends DefinitionElement {
-    /** @internal */
     static get className() { return "TypeDefinitionElement"; }
     constructor(props, iModel) { super(props, iModel); }
     collectReferenceIds(referenceIds) {
@@ -874,7 +843,6 @@ exports.TypeDefinitionElement = TypeDefinitionElement;
  * @beta
  */
 class RecipeDefinitionElement extends DefinitionElement {
-    /** @internal */
     static get className() { return "RecipeDefinitionElement"; }
     constructor(props, iModel) { super(props, iModel); }
 }
@@ -885,7 +853,6 @@ exports.RecipeDefinitionElement = RecipeDefinitionElement;
  * @public
  */
 class PhysicalType extends TypeDefinitionElement {
-    /** @internal */
     static get className() { return "PhysicalType"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -911,7 +878,6 @@ exports.PhysicalType = PhysicalType;
  * @public
  */
 class SpatialLocationType extends TypeDefinitionElement {
-    /** @internal */
     static get className() { return "SpatialLocationType"; }
     constructor(props, iModel) { super(props, iModel); }
     /** Create a Code for a SpatialLocationType element given a name that is meant to be unique within the scope of the specified DefinitionModel.
@@ -929,7 +895,6 @@ exports.SpatialLocationType = SpatialLocationType;
  * @beta
  */
 class TemplateRecipe3d extends RecipeDefinitionElement {
-    /** @internal */
     static get className() { return "TemplateRecipe3d"; }
     constructor(props, iModel) { super(props, iModel); }
     /** Create a Code for a TemplateRecipe3d given a name that is meant to be unique within the scope of its Model.
@@ -980,7 +945,6 @@ exports.TemplateRecipe3d = TemplateRecipe3d;
  * @public
  */
 class GraphicalType2d extends TypeDefinitionElement {
-    /** @internal */
     static get className() { return "GraphicalType2d"; }
     constructor(props, iModel) { super(props, iModel); }
     /** Create a Code for a GraphicalType2d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
@@ -998,7 +962,6 @@ exports.GraphicalType2d = GraphicalType2d;
  * @beta
  */
 class TemplateRecipe2d extends RecipeDefinitionElement {
-    /** @internal */
     static get className() { return "TemplateRecipe2d"; }
     constructor(props, iModel) { super(props, iModel); }
     /** Create a Code for a TemplateRecipe2d given a name that is meant to be unique within the scope of its Model.
@@ -1051,7 +1014,6 @@ exports.TemplateRecipe2d = TemplateRecipe2d;
  * @public
  */
 class InformationPartitionElement extends InformationContentElement {
-    /** @internal */
     static get className() { return "InformationPartitionElement"; }
     constructor(props, iModel) { super(props, iModel); }
     toJSON() {
@@ -1074,7 +1036,6 @@ exports.InformationPartitionElement = InformationPartitionElement;
  * @public
  */
 class DefinitionPartition extends InformationPartitionElement {
-    /** @internal */
     static get className() { return "DefinitionPartition"; }
 }
 exports.DefinitionPartition = DefinitionPartition;
@@ -1084,7 +1045,6 @@ exports.DefinitionPartition = DefinitionPartition;
  * @public
  */
 class DocumentPartition extends InformationPartitionElement {
-    /** @internal */
     static get className() { return "DocumentPartition"; }
 }
 exports.DocumentPartition = DocumentPartition;
@@ -1094,7 +1054,6 @@ exports.DocumentPartition = DocumentPartition;
  * @public
  */
 class GroupInformationPartition extends InformationPartitionElement {
-    /** @internal */
     static get className() { return "GroupInformationPartition"; }
 }
 exports.GroupInformationPartition = GroupInformationPartition;
@@ -1105,7 +1064,6 @@ exports.GroupInformationPartition = GroupInformationPartition;
  * @public
  */
 class GraphicalPartition3d extends InformationPartitionElement {
-    /** @internal */
     static get className() { return "GraphicalPartition3d"; }
 }
 exports.GraphicalPartition3d = GraphicalPartition3d;
@@ -1115,7 +1073,6 @@ exports.GraphicalPartition3d = GraphicalPartition3d;
  * @public
  */
 class InformationRecordPartition extends InformationPartitionElement {
-    /** @internal */
     static get className() { return "InformationRecordPartition"; }
 }
 exports.InformationRecordPartition = InformationRecordPartition;
@@ -1124,7 +1081,6 @@ exports.InformationRecordPartition = InformationRecordPartition;
  * @public
  */
 class LinkPartition extends InformationPartitionElement {
-    /** @internal */
     static get className() { return "LinkPartition"; }
 }
 exports.LinkPartition = LinkPartition;
@@ -1133,7 +1089,6 @@ exports.LinkPartition = LinkPartition;
  * @public
  */
 class PhysicalPartition extends InformationPartitionElement {
-    /** @internal */
     static get className() { return "PhysicalPartition"; }
 }
 exports.PhysicalPartition = PhysicalPartition;
@@ -1143,7 +1098,6 @@ exports.PhysicalPartition = PhysicalPartition;
  * @public
  */
 class SpatialLocationPartition extends InformationPartitionElement {
-    /** @internal */
     static get className() { return "SpatialLocationPartition"; }
 }
 exports.SpatialLocationPartition = SpatialLocationPartition;
@@ -1151,7 +1105,6 @@ exports.SpatialLocationPartition = SpatialLocationPartition;
  * @public
  */
 class GroupInformationElement extends InformationReferenceElement {
-    /** @internal */
     static get className() { return "GroupInformationElement"; }
 }
 exports.GroupInformationElement = GroupInformationElement;
@@ -1159,7 +1112,6 @@ exports.GroupInformationElement = GroupInformationElement;
  * @public
  */
 class LinkElement extends InformationReferenceElement {
-    /** @internal */
     static get className() { return "LinkElement"; }
     /** Create a Code for a LinkElement given a name that is meant to be unique within the scope of the specified Model.
      * @param iModel  The IModelDb
@@ -1176,7 +1128,6 @@ exports.LinkElement = LinkElement;
  * @public
  */
 class UrlLink extends LinkElement {
-    /** @internal */
     static get className() { return "UrlLink"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -1196,7 +1147,6 @@ exports.UrlLink = UrlLink;
  * @alpha
  */
 class FolderLink extends UrlLink {
-    /** @internal */
     static get className() { return "FolderLink"; }
 }
 exports.FolderLink = FolderLink;
@@ -1204,7 +1154,6 @@ exports.FolderLink = FolderLink;
  * @public
  */
 class RepositoryLink extends UrlLink {
-    /** @internal */
     static get className() { return "RepositoryLink"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -1223,7 +1172,6 @@ exports.RepositoryLink = RepositoryLink;
  * @public
  */
 class EmbeddedFileLink extends LinkElement {
-    /** @internal */
     static get className() { return "EmbeddedFileLink"; }
 }
 exports.EmbeddedFileLink = EmbeddedFileLink;
@@ -1233,7 +1181,6 @@ exports.EmbeddedFileLink = EmbeddedFileLink;
  * @public
  */
 class RoleElement extends Element {
-    /** @internal */
     static get className() { return "RoleElement"; }
 }
 exports.RoleElement = RoleElement;
@@ -1242,7 +1189,6 @@ exports.RoleElement = RoleElement;
  * @public
  */
 class GeometryPart extends DefinitionElement {
-    /** @internal */
     static get className() { return "GeometryPart"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -1271,7 +1217,6 @@ exports.GeometryPart = GeometryPart;
  * @public
  */
 class LineStyle extends DefinitionElement {
-    /** @internal */
     static get className() { return "LineStyle"; }
     constructor(props, iModel) { super(props, iModel); }
     /** Create a Code for a LineStyle definition given a name that is meant to be unique within the scope of the specified model.
@@ -1290,7 +1235,6 @@ exports.LineStyle = LineStyle;
  * @public
  */
 class RenderTimeline extends InformationRecordElement {
-    /** @internal */
     static get className() { return "RenderTimeline"; }
     constructor(props, iModel) {
         super(props, iModel);
@@ -1327,7 +1271,7 @@ class RenderTimeline extends InformationRecordElement {
             targetProps.script = JSON.stringify(this.remapScript(context, this.parseScriptProps(targetProps.script)));
     }
     /** Remap Ids when cloning a RenderSchedule.Script between iModels on a DisplayStyle or RenderTimeline.
-     * @internal
+     * @beta
      */
     static remapScript(context, input) {
         const scriptProps = [];