@thatopen/components 2.1.5 → 2.1.6

package/dist/core/Components/index.d.ts

@@ -6,7 +6,7 @@ export declare class Components implements Disposable {
     /**
      * The version of the @thatopen/components library.
      */
-    static readonly release = "2.1.5";
+    static readonly release = "2.1.6";
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<void>;
     /**

package/dist/ifc/IfcPropertiesManager/index.d.ts

@@ -118,7 +118,7 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      * Each object must have an `expressID` property, which is the express ID of the entity in the model.
      * The rest of the properties will be set as the properties of the entity.
      *
-     * @returns {Promise<void>} A promise that resolves when all the properties have been set.
+     * @returns A promise that resolves when all the properties have been set.
      *
      * @throws Will throw an error if any of the `expressID` properties are missing in the `dataToSave` array.
      */
@@ -145,7 +145,7 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      * @param model - The FragmentsGroup model from which to remove the Pset.
      * @param psetID - The express IDs of the Psets to be removed.
      *
-     * @returns {Promise<void>} A promise that resolves when all the Psets have been removed.
+     * @returns A promise that resolves when all the Psets have been removed.
      *
      * @throws Will throw an error if any of the `expressID` properties are missing in the `psetID` array.
      * @throws Will throw an error if the Pset to be removed is not of type `IFCPROPERTYSET`.
@@ -201,13 +201,13 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      * @param psetID - The express ID of the Pset from which to remove the property.
      * @param propID - The express ID of the property to be removed.
      *
-     * @returns {Promise<void>} A promise that resolves when the property has been removed.
+     * @returns A promise that resolves when the property has been removed.
      *
      * @throws Will throw an error if the Pset or the property to be removed are not found in the model.
      * @throws Will throw an error if the Pset to be removed is not of type `IFCPROPERTYSET`.
      */
     removePsetProp(model: FragmentsGroup, psetID: number, propID: number): Promise<void>;
-    addElementToPset(model: FragmentsGroup, psetID: number, ...elementID: number[]): Promise<void>;
+    addElementToPset(model: FragmentsGroup, psetID: number, ...expressIDs: number[]): Promise<void>;
     /**
      * Adds elements to a Property Set (Pset) in the given model.
      *
@@ -215,7 +215,7 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      * @param psetID - The express ID of the Pset to which to add the elements.
      * @param elementID - The express IDs of the elements to be added.
      *
-     * @returns {Promise<void>} A promise that resolves when all the elements have been added.
+     * @returns A promise that resolves when all the elements have been added.
      *
      * @throws Will throw an error if the Pset or the elements to be added are not found in the model.
      * @throws Will throw an error if the Pset to be added to is not of type `IFCPROPERTYSET`.

package/dist/ifc/IfcRelationsIndexer/index.d.ts

@@ -43,6 +43,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
     constructor(components: Components);
     private onFragmentsDisposed;
     private indexRelations;
+    private getAttributeIndex;
     /**
      * Adds a relation map to the model's relations map.
      *
@@ -138,14 +139,25 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
     getRelationsMapFromJSON(json: string): RelationsMap;
     /** {@link Disposable.dispose} */
     dispose(): void;
+    /**
+     * Adds relations between an entity and other entities in a BIM model.
+     *
+     * @param model - The BIM model to which the relations will be added.
+     * @param expressID - The expressID of the entity within the model.
+     * @param relationName - The IFC schema inverse attribute of the relation to add (e.g., "IsDefinedBy", "ContainsElements").
+     * @param relIDs - The expressIDs of the related entities within the model.
+     *
+     * @throws An error if the relation name is not a valid relation name.
+     */
+    addEntityRelations(model: FragmentsGroup, expressID: number, relationName: InverseAttribute, ...relIDs: number[]): void;
     /**
      * Gets the children of the given element recursively. E.g. in a model with project - site - building - storeys - rooms, passing a storey will include all its children and the children of the rooms contained in it.
      *
      * @param model The BIM model whose children to get.
-     * @param id The expressID of the item whose children to get.
+     * @param expressID The expressID of the item whose children to get.
      * @param found An optional parameter that includes a set of expressIDs where the found element IDs will be added.
      *
      * @returns A `Set` with the expressIDs of the found items.
      */
-    getElementsChildren(model: FragmentsGroup, id: number, found?: Set<number>): Set<number>;
+    getEntityChildren(model: FragmentsGroup, expressID: number, found?: Set<number>): Set<number>;
 }