@thatopen/components 2.2.5 → 2.2.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.2.5";
+    static readonly release = "2.2.6";
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<void>;
     /**

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

@@ -1,6 +1,7 @@
 import * as WEBIFC from "web-ifc";
 import { FragmentsGroup } from "@thatopen/fragments";
 import { Component, Disposable, Event, Components } from "../../core";
+import { IfcRelation } from "../IfcRelationsIndexer";
 /**
  * Types for boolean properties in IFC schema.
  */
@@ -207,7 +208,10 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      * @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, ...expressIDs: number[]): Promise<void>;
+    /**
+     * @deprecated Use indexer.addEntitiesRelation instead. This will be removed in future releases.
+     */
+    addElementToPset(model: FragmentsGroup, psetID: number, ...expressIDs: number[]): void;
     /**
      * Adds elements to a Property Set (Pset) in the given model.
      *
@@ -222,6 +226,19 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      * @throws Will throw an error if no relation is found between the Pset and the model.
      */
     addPropToPset(model: FragmentsGroup, psetID: number, ...propID: number[]): Promise<void>;
+    /**
+     * Creates a new instance of a relationship between entities in the IFC model.
+     *
+     * @param model - The FragmentsGroup model in which to create the relationship.
+     * @param type - The type of the relationship to create.
+     * @param relatingID - The express ID of the entity that is related to the other entities.
+     * @param relatedIDs - The express IDs of the entities that are related to the relating entity.
+     *
+     * @returns A promise that resolves with the newly created relationship.
+     *
+     * @throws Will throw an error if the relationship type is unsupported.
+     */
+    createIfcRel(model: FragmentsGroup, type: IfcRelation, relatingID: number, relatedIDs: number[]): Promise<any>;
     /**
      * Saves the changes made to the model to a new IFC file.
      *
@@ -265,3 +282,4 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
     private registerChange;
     private newSingleProperty;
 }
+export * from "./src";

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

@@ -0,0 +1,3 @@
+export * from "./rel-attrs";
+export * from "./rel-names";
+export * from "./types";

package/dist/ifc/IfcPropertiesManager/src/rel-attrs.d.ts

@@ -0,0 +1,7 @@
+import { IfcRelName } from "./types";
+type IfcRelAttributePosition = {
+    related: number;
+    relating: number;
+};
+export declare const ifcRelAttrsPosition: Record<IfcRelName, IfcRelAttributePosition>;
+export {};

package/dist/ifc/IfcPropertiesManager/src/rel-names.d.ts

@@ -0,0 +1,3 @@
+import { IfcRelName } from "./types";
+import { IfcRelation } from "../../IfcRelationsIndexer";
+export declare const ifcRelClassNames: Record<IfcRelation, IfcRelName>;

package/dist/ifc/IfcPropertiesManager/src/types.d.ts

@@ -0,0 +1,18 @@
+export type IfcRelationNames = [
+    "IfcRelAssignsToControl",
+    "IfcRelAssignsToGroup",
+    "IfcRelAssignsToProduct",
+    "IfcRelAssociatesClassification",
+    "IfcRelAssociatesMaterial",
+    "IfcRelAssociatesDocument",
+    "IfcRelContainedInSpatialStructure",
+    "IfcRelFlowControlElements",
+    "IfcRelConnectsElements",
+    "IfcRelDeclares",
+    "IfcRelAggregates",
+    "IfcRelNests",
+    "IfcRelDefinesByProperties",
+    "IfcRelDefinesByType",
+    "IfcRelDefinesByTemplate"
+];
+export type IfcRelName = IfcRelationNames[number];

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

@@ -1,8 +1,7 @@
 import * as WEBIFC from "web-ifc";
 import { FragmentsGroup } from "@thatopen/fragments";
 import { Disposable, Event, Component, Components } from "../../core";
-import { RelationsMap, ModelsRelationMap, InverseAttribute } from "./src/types";
-export type { InverseAttribute, RelationsMap } from "./src/types";
+import { RelationsMap, ModelsRelationMap, InverseAttribute, IfcRelation } from "./src";
 /**
  * Indexer component for IFC entities, facilitating the indexing and retrieval of IFC entity relationships. It is designed to process models properties by indexing their IFC entities' relations based on predefined inverse attributes, and provides methods to query these relations. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcRelationsIndexer). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcRelationsIndexer).
  */
@@ -140,7 +139,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
     /** {@link Disposable.dispose} */
     dispose(): void;
     /**
-     * Retrieves the entities within a given model that have a specific relation with a given entity.
+     * Retrieves the entities within a model that have a specific relation with a given entity.
      *
      * @param model - The BIM model to search for related entities.
      * @param inv - The IFC schema inverse attribute of the relation to search for (e.g., "IsDefinedBy", "ContainsElements").
@@ -158,10 +157,40 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * @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.
+     * @deprecated Use addEntitiesRelation instead. This will be removed in future versions.
      *
      * @throws An error if the relation name is not a valid relation name.
      */
     addEntityRelations(model: FragmentsGroup, expressID: number, relationName: InverseAttribute, ...relIDs: number[]): void;
+    /**
+     * Converts the relations made into actual IFC data.
+     *
+     * @remarks This function iterates through the changes made to the relations and applies them to the corresponding BIM model.
+     * It only make sense to use if the relations need to be write in the IFC file.
+     *
+     * @returns A promise that resolves when all the relation changes have been applied.
+     */
+    applyRelationChanges(): Promise<void>;
+    private readonly _changeMap;
+    /**
+     * An event that is triggered when entities are related in a BIM model.
+     * The event provides information about the type of relation, the inverse attribute,
+     * the IDs of the entities related, and the IDs of the entities that are being related.
+     */
+    readonly onEntitiesRelated: Event<{
+        /** The type of the IFC relation. */
+        relType: IfcRelation;
+        /** The inverse attribute of the relation. */
+        invAttribute: InverseAttribute;
+        /** The IDs of the entities that are relating. */
+        relatingIDs: number[];
+        /** The IDs of the entities that are being related. */
+        relatedIDs: number[];
+    }>;
+    addEntitiesRelation(model: FragmentsGroup, relatingID: number, rel: {
+        type: IfcRelation;
+        inv: InverseAttribute;
+    }, ...relatedIDs: 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.
      *
@@ -173,3 +202,4 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      */
     getEntityChildren(model: FragmentsGroup, expressID: number, found?: Set<number>): Set<number>;
 }
+export * from "./src";

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

@@ -0,0 +1,2 @@
+export * from "./relToAttributesMap";
+export * from "./types";

package/dist/ifc/IfcRelationsIndexer/src/relToAttributesMap.d.ts

@@ -1,5 +1,5 @@
 import { InverseAttribute } from "./types";
-export declare const relToAttributesMap: Map<160246688 | 2655215786 | 919958153 | 1307041759 | 4186316022 | 781010003 | 307848117 | 3242617779 | 279856033 | 1204542856 | 2857406711 | 2565941209 | 2495723537 | 3268803585, {
+export declare const relToAttributesMap: Map<160246688 | 2655215786 | 919958153 | 1307041759 | 4186316022 | 781010003 | 307848117 | 3242617779 | 279856033 | 1204542856 | 2857406711 | 2565941209 | 2495723537 | 3268803585 | 982818633, {
     forRelating: InverseAttribute;
     forRelated: InverseAttribute;
 }>;

package/dist/ifc/IfcRelationsIndexer/src/types.d.ts

@@ -30,7 +30,8 @@ export type InverseAttributes = [
     "HasContext",
     "Controls",
     "IsNestedBy",
-    "Nests"
+    "Nests",
+    "DocumentRefForObjects"
 ];
 export type InverseAttribute = InverseAttributes[number];
 /**
@@ -50,6 +51,7 @@ export type IfcRelations = [
     typeof WEBIFC.IFCRELASSIGNSTOPRODUCT,
     typeof WEBIFC.IFCRELDECLARES,
     typeof WEBIFC.IFCRELASSIGNSTOCONTROL,
-    typeof WEBIFC.IFCRELNESTS
+    typeof WEBIFC.IFCRELNESTS,
+    typeof WEBIFC.IFCRELASSOCIATESDOCUMENT
 ];
 export type IfcRelation = IfcRelations[number];