@thatopen/components 2.3.13 → 2.3.15

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.3.13";
+    static readonly release = "2.3.15";
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<void>;
     /**

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

@@ -138,7 +138,6 @@ export declare class IfcPropertiesManager extends Component implements Disposabl
      */
     newPset(model: FragmentsGroup, name: string, description?: string): Promise<{
         pset: WEBIFC.IFC4.IfcPropertySet | WEBIFC.IFC2X3.IfcPropertySet | WEBIFC.IFC4X3.IfcPropertySet;
-        rel: WEBIFC.IFC4X3.IfcRelDefinesByProperties | WEBIFC.IFC2X3.IfcRelDefinesByProperties | WEBIFC.IFC4.IfcRelDefinesByProperties;
     }>;
     /**
      * Removes a Property Set (Pset) from the given model.

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

@@ -1,7 +1,7 @@
 import * as WEBIFC from "web-ifc";
 import { FragmentsGroup } from "@thatopen/fragments";
 import { Disposable, Event, Component, Components } from "../../core";
-import { RelationsMap, ModelsRelationMap, InverseAttribute, IfcRelation } from "./src";
+import { RelationsMap, ModelsRelationMap, InverseAttribute, IfcRelation, RelationsProcessingConfig, EntitiesRelatedEvent } 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).
  */
@@ -42,7 +42,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
     constructor(components: Components);
     private onFragmentsDisposed;
     private indexRelations;
-    getAttributeIndex(inverseAttribute: InverseAttribute): number | null;
+    getAttributeIndex(inverseAttribute: InverseAttribute): number;
     /**
      * Adds a relation map to the model's relations map.
      *
@@ -68,7 +68,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * representation of the relations indexed by entity expressIDs and relation types.
      * @throws An error if the model does not have properties loaded.
      */
-    process(model: FragmentsGroup): Promise<RelationsMap>;
+    process(model: FragmentsGroup, config?: Partial<RelationsProcessingConfig>): Promise<RelationsMap>;
     /**
      * Processes a given model from a WebIfc API to index its IFC entities relations.
      *
@@ -85,11 +85,10 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      *
      * @param model The `FragmentsGroup` model containing the entity, or its UUID.
      * @param expressID The unique identifier of the entity within the model.
-     * @param relationName The IFC schema inverse attribute of the relation to search for (e.g., "IsDefinedBy", "ContainsElements").
-     * @returns An array of express IDs representing the related entities, or `null` if no relations are found
-     * or the specified relation name is not indexed.
+     * @param attribute The IFC schema inverse attribute of the relation to search for (e.g., "IsDefinedBy", "ContainsElements").
+     * @returns An array of express IDs representing the related entities. If the array is empty, no relations were found.
      */
-    getEntityRelations(model: FragmentsGroup | string, expressID: number, relationName: InverseAttribute): number[] | null;
+    getEntityRelations(model: FragmentsGroup | string | RelationsMap, expressID: number, attribute: InverseAttribute): number[];
     /**
      * Serializes the relations of a given relation map into a JSON string.
      * This method iterates through the relations in the given map, organizing them into a structured object where each key is an expressID of an entity,
@@ -166,7 +165,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * 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.
+     * It only make sense to use it if the relations need to be write in the IFC file.
      *
      * @returns A promise that resolves when all the relation changes have been applied.
      */
@@ -177,16 +176,7 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * 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[];
-    }>;
+    readonly onEntitiesRelated: Event<EntitiesRelatedEvent>;
     addEntitiesRelation(model: FragmentsGroup, relatingID: number, rel: {
         type: IfcRelation;
         inv: InverseAttribute;

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

@@ -0,0 +1,51 @@
+declare const actual: {
+    186: {
+        7: number[];
+    };
+    250: {
+        8: number[];
+    };
+    253: {
+        8: number[];
+    };
+    257: {
+        8: number[];
+    };
+};
+declare const newVersion: {
+    186: {
+        7: ({
+            259: number[];
+            263?: undefined;
+            266?: undefined;
+        } | {
+            263: number[];
+            259?: undefined;
+            266?: undefined;
+        } | {
+            266: number[];
+            259?: undefined;
+            263?: undefined;
+        })[];
+    };
+    190: {
+        7: {
+            259: number[];
+        }[];
+    };
+    250: {
+        8: {
+            259: number[];
+        }[];
+    };
+};
+interface V2Schema {
+    [expressID: number]: {
+        [invAttrIndex: number]: {
+            [IfcRelationship: number]: number[];
+        };
+    };
+}
+type RelationsMap = Map<number, Map<number, {
+    [ifcRel: number]: number[];
+}>>;

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

@@ -55,3 +55,20 @@ export type IfcRelations = [
     typeof WEBIFC.IFCRELASSOCIATESDOCUMENT
 ];
 export type IfcRelation = IfcRelations[number];
+export interface RelationsProcessingConfig {
+    relationsToProcess: IfcRelation[];
+}
+/**
+ * Interface definition of an Entities Related Event from the IfcRelationsIndexer.
+ * This event gets triggered when two or more entities has been related with each other.
+ */
+export interface EntitiesRelatedEvent {
+    /** 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[];
+}