@itwin/core-backend 3.5.0-dev.7 → 3.6.0-dev.1

package/lib/cjs/Element.js

@@ -236,21 +236,14 @@ class Element extends Entity_1.Entity {
     collectPredecessorIds(predecessorIds) {
         return this.collectReferenceIds(predecessorIds);
     }
-    /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
-     * A *reference* is any entity referenced by this entity's EC Data
-     * This is important for cloning operations but can be useful in other situations as well.
-     * @param referenceIds The Id64Set to populate with reference Ids.
-     * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
-     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
-     * @see getReferenceIds
-     * @beta
-     */
-    collectReferenceIds(referenceIds) {
-        referenceIds.add(this.model); // The modeledElement is a reference
+    /** @internal */
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
+        referenceIds.addModel(this.model); // The modeledElement is a reference
         if (this.code.scope && core_bentley_1.Id64.isValidId64(this.code.scope))
-            referenceIds.add(this.code.scope); // The element that scopes the code is a reference
+            referenceIds.addElement(this.code.scope); // The element that scopes the code is a reference
         if (this.parent)
-            referenceIds.add(this.parent.id); // A parent element is a reference
+            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.
@@ -260,16 +253,6 @@ class Element extends Entity_1.Entity {
     getPredecessorIds() {
         return this.getReferenceIds();
     }
-    /** Get the Ids of this element's *references*. A *reference* is an element that this element references.
-     * This is important for cloning operations but can be useful in other situations as well.
-     * @see collectReferenceIds
-     * @beta
-     */
-    getReferenceIds() {
-        const referenceIds = new Set();
-        this.collectReferenceIds(referenceIds);
-        return referenceIds;
-    }
     /** Get the class metadata for this element. */
     getClassMetaData() { return this.iModel.classMetaDataRegistry.find(this.classFullName); }
     getAllUserProperties() {
@@ -311,11 +294,19 @@ class Element extends Entity_1.Entity {
 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 the class hierarchy that introduces required references.
+ * @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
  */
@@ -344,9 +335,9 @@ class GeometricElement extends (_b = Element) {
         return val;
     }
     /** @internal */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
-        referenceIds.add(this.category);
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
+        referenceIds.addElement(this.category);
         // TODO: GeometryPartIds?
     }
 }
@@ -354,6 +345,11 @@ 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
@@ -377,10 +373,10 @@ class GeometricElement3d extends GeometricElement {
         return val;
     }
     /** @internal */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
         if (undefined !== this.typeDefinition)
-            referenceIds.add(this.typeDefinition.id);
+            referenceIds.addElement(this.typeDefinition.id);
     }
 }
 exports.GeometricElement3d = GeometricElement3d;
@@ -416,10 +412,10 @@ class GeometricElement2d extends GeometricElement {
         return val;
     }
     /** @internal */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
         if (undefined !== this.typeDefinition)
-            referenceIds.add(this.typeDefinition.id);
+            referenceIds.addElement(this.typeDefinition.id);
     }
 }
 exports.GeometricElement2d = GeometricElement2d;
@@ -747,10 +743,10 @@ class SheetTemplate extends Document {
     /** @internal */
     static get className() { return "SheetTemplate"; }
     /** @internal */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
         if (undefined !== this.border)
-            referenceIds.add(this.border);
+            referenceIds.addElement(this.border);
     }
 }
 exports.SheetTemplate = SheetTemplate;
@@ -769,10 +765,10 @@ class Sheet extends Document {
     /** @internal */
     static get className() { return "Sheet"; }
     /** @internal */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
         if (undefined !== this.sheetTemplate)
-            referenceIds.add(this.sheetTemplate);
+            referenceIds.addElement(this.sheetTemplate);
     }
     /** Create a Code for a Sheet given a name that is meant to be unique within the scope of the specified DocumentListModel.
      * @param iModel  The IModelDb
@@ -907,10 +903,10 @@ class TypeDefinitionElement extends DefinitionElement {
     /** @internal */
     static get className() { return "TypeDefinitionElement"; }
     /** @internal */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
+    collectReferenceConcreteIds(referenceIds) {
+        super.collectReferenceConcreteIds(referenceIds);
         if (undefined !== this.recipe)
-            referenceIds.add(this.recipe.id);
+            referenceIds.addElement(this.recipe.id);
     }
 }
 exports.TypeDefinitionElement = TypeDefinitionElement;
@@ -1378,11 +1374,11 @@ class RenderTimeline extends InformationRecordElement {
             return [];
         }
     }
-    /** @alpha */
-    collectReferenceIds(ids) {
-        super.collectReferenceIds(ids);
+    /** @internal */
+    collectReferenceConcreteIds(ids) {
+        super.collectReferenceConcreteIds(ids);
         const script = core_common_1.RenderSchedule.Script.fromJSON(this.scriptProps);
-        script === null || script === void 0 ? void 0 : script.discloseIds(ids);
+        script === null || script === void 0 ? void 0 : script.discloseIds(ids); // eslint-disable-line deprecation/deprecation
     }
     /** @alpha */
     static onCloned(context, sourceProps, targetProps) {