@thatopen/components 2.0.11 → 2.0.12

package/dist/fragments/IfcGeometryTiler/src/streaming-settings.d.ts

@@ -1,10 +1,16 @@
 import { IfcFragmentSettings } from "../../IfcLoader/src";
-/** Configuration of the IFC-fragment streaming. */
+/**
+ * Settings for streaming IFC geometry and assets. Extends {@link IfcFragmentSettings} to inherit common settings.
+ */
 export declare class IfcStreamingSettings extends IfcFragmentSettings {
+    /**
+     * Minimum number of geometries to be streamed.
+     * Defaults to 10 geometries.
+     */
     minGeometrySize: number;
+    /**
+     * Minimum amount of assets to be streamed.
+     * Defaults to 1000 assets.
+     */
     minAssetsSize: number;
 }
-/** Configuration of the IFC-fragment streaming. */
-export declare class PropertiesStreamingSettings extends IfcFragmentSettings {
-    propertiesSize: number;
-}

package/dist/fragments/IfcLoader/index.d.ts

@@ -2,15 +2,37 @@ import * as WEBIFC from "web-ifc";
 import * as FRAGS from "@thatopen/fragments";
 import { IfcFragmentSettings } from "./src";
 import { Component, Components, Event, Disposable } from "../../core";
+export * from "./src/ifc-fragment-settings";
+/**
+ * The IfcLoader component is responsible for loading and processing IFC files. It utilizes the Web-IFC library to handle the IFC data and the Three.js library for 3D rendering. The class provides methods for setting up, loading, and cleaning up IFC files. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcLoader). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcLoader).
+ */
 export declare class IfcLoader extends Component implements Disposable {
+    /**
+     * A unique identifier for the component.
+     * This UUID is used to register the component within the Components system.
+     */
     static readonly uuid: "a659add7-1418-4771-a0d6-7d4d438e4624";
-    readonly onIfcStartedLoading: Event<void>;
-    readonly onSetup: Event<void>;
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<string>;
+    /**
+     * An event triggered when the IFC file starts loading.
+     */
+    readonly onIfcStartedLoading: Event<void>;
+    /**
+     * An event triggered when the setup process is completed.
+     */
+    readonly onSetup: Event<void>;
+    /**
+     * The settings for the IfcLoader.
+     * It includes options for excluding categories, setting WASM paths, and more.
+     */
     settings: IfcFragmentSettings;
-    enabled: boolean;
+    /**
+     * The instance of the Web-IFC library used for handling IFC data.
+     */
     webIfc: WEBIFC.IfcAPI;
+    /** {@link Component.enabled} */
+    enabled: boolean;
     private _material;
     private _spatialTree;
     private _metaData;
@@ -19,12 +41,75 @@ export declare class IfcLoader extends Component implements Disposable {
     private _visitedFragments;
     private _materialT;
     constructor(components: Components);
+    /** {@link Disposable.dispose} */
     dispose(): void;
+    /**
+     * Sets up the IfcLoader component with the provided configuration.
+     *
+     * @param config - Optional configuration settings for the IfcLoader.
+     * If not provided, the existing settings will be used.
+     *
+     * @returns A Promise that resolves when the setup process is completed.
+     *
+     * @remarks
+     * If the `autoSetWasm` option is enabled in the configuration,
+     * the method will automatically set the WASM paths for the Web-IFC library.
+     *
+     * @example
+     * ```typescript
+     * const ifcLoader = new IfcLoader(components);
+     * await ifcLoader.setup({ autoSetWasm: true });
+     * ```
+     */
     setup(config?: Partial<IfcFragmentSettings>): Promise<void>;
+    /**
+     * Loads an IFC file and processes it for 3D visualization.
+     *
+     * @param data - The Uint8Array containing the IFC file data.
+     * @param coordinate - Optional boolean indicating whether to coordinate the loaded IFC data. Default is true.
+     *
+     * @returns A Promise that resolves to the FragmentsGroup containing the loaded and processed IFC data.
+     *
+     * @example
+     * ```typescript
+     * const ifcLoader = components.get(IfcLoader);
+     * const group = await ifcLoader.load(ifcData);
+     * ```
+     */
     load(data: Uint8Array, coordinate?: boolean): Promise<FRAGS.FragmentsGroup>;
+    /**
+     * Reads an IFC file and initializes the Web-IFC library.
+     *
+     * @param data - The Uint8Array containing the IFC file data.
+     *
+     * @returns A Promise that resolves when the IFC file is opened and initialized.
+     *
+     * @remarks
+     * This method sets the WASM path and initializes the Web-IFC library based on the provided settings.
+     * It also opens the IFC model using the provided data and settings.
+     *
+     * @example
+     * ```typescript
+     * const ifcLoader = components.get(IfcLoader);
+     * await ifcLoader.readIfcFile(ifcData);
+     * ```
+     */
     readIfcFile(data: Uint8Array): Promise<number>;
-    private getAllGeometries;
+    /**
+     * Cleans up the IfcLoader component by resetting the Web-IFC library,
+     * clearing the visited fragments and fragment instances maps, and creating a new instance of the Web-IFC library.
+     *
+     * @remarks
+     * This method is called automatically after using the .load() method, so usually you don't need to use it manually.
+     *
+     * @example
+     * ```typescript
+     * const ifcLoader = components.get(IfcLoader);
+     * ifcLoader.cleanUp();
+     * ```
+     */
     cleanUp(): void;
+    private getAllGeometries;
     private getMesh;
     private getGeometry;
     private autoSetWasm;

package/dist/fragments/IfcLoader/src/ifc-fragment-settings.d.ts

@@ -22,6 +22,20 @@ export declare class IfcFragmentSettings {
     saveLocations: boolean;
     /** Loader settings for [web-ifc](https://github.com/ThatOpen/engine_web-ifc). */
     webIfc: WEBIFC.LoaderSettings;
+    /**
+     * Whether to automatically set the path to the WASM file for [web-ifc](https://github.com/ThatOpen/engine_web-ifc).
+     * If set to true, the path will be set to the default path of the WASM file.
+     * If set to false, the path must be provided manually in the `wasm.path` property.
+     * Default value is true.
+     */
     autoSetWasm: boolean;
+    /**
+     * Custom function to handle the file location for [web-ifc](https://github.com/ThatOpen/engine_web-ifc).
+     * This function will be called when [web-ifc](https://github.com/ThatOpen/engine_web-ifc) needs to locate a file.
+     * If set to null, the default file location handler will be used.
+     *
+     * @param url - The URL of the file to locate.
+     * @returns The absolute path of the file.
+     */
     customLocateFileHandler: WEBIFC.LocateFileHandlerFn | null;
 }

package/dist/fragments/IfcPropertiesTiler/index.d.ts

@@ -1,23 +1,63 @@
 import * as WEBIFC from "web-ifc";
 import { AsyncEvent, Component, Disposable, Event } from "../../core";
-import { PropertiesStreamingSettings } from "../IfcGeometryTiler";
+import { PropertiesStreamingSettings } from "./src";
+export * from "./src";
+/**
+ * A component that converts the properties of an IFC file to tiles. It uses the Web-IFC library to read and process the IFC data. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcPropertiesTiler). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcPropertiesTiler).
+ */
 export declare class IfcPropertiesTiler extends Component implements Disposable {
+    /**
+     * A unique identifier for the component.
+     * This UUID is used to register the component within the Components system.
+     */
     static readonly uuid: "88d2c89c-ce32-47d7-8cb6-d51e4b311a0b";
-    onPropertiesStreamed: AsyncEvent<{
+    /**
+     * An event that is triggered when properties are streamed from the IFC file.
+     * The event provides the type of the IFC entity and the corresponding data.
+     */
+    readonly onPropertiesStreamed: AsyncEvent<{
         type: number;
         data: {
             [id: number]: any;
         };
     }>;
-    onProgress: AsyncEvent<number>;
-    onIndicesStreamed: AsyncEvent<Map<number, Map<number, number[]>>>;
+    /**
+     * An event that is triggered to indicate the progress of the streaming process.
+     * The event provides a number between 0 and 1 representing the progress percentage.
+     */
+    readonly onProgress: AsyncEvent<number>;
+    /**
+     * An event that is triggered when indices are streamed from the IFC file.
+     * The event provides a map of indices, where the key is the entity type and the value is another map of indices.
+     */
+    readonly onIndicesStreamed: AsyncEvent<Map<number, Map<number, number[]>>>;
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<string>;
+    /** {@link Component.enabled} */
     enabled: boolean;
+    /**
+     * An instance of the PropertiesStreamingSettings class, which holds the settings for the streaming process.
+     */
     settings: PropertiesStreamingSettings;
+    /**
+     * An instance of the IfcAPI class from the Web-IFC library, which provides methods for reading and processing IFC data.
+     */
     webIfc: WEBIFC.IfcAPI;
+    /** {@link Disposable.dispose} */
     dispose(): Promise<void>;
+    /**
+     * This method converts properties from an IFC file to tiles given its data as a Uint8Array.
+     *
+     * @param data - The Uint8Array containing the IFC file data.
+     * @returns A Promise that resolves when the streaming process is complete.
+     */
     streamFromBuffer(data: Uint8Array): Promise<void>;
+    /**
+     * This method converts properties from an IFC file to tiles using a given callback function to read the file.
+     *
+     * @param loadCallback - A callback function that loads the IFC file data.
+     * @returns A Promise that resolves when the streaming process is complete.
+     */
     streamFromCallBack(loadCallback: WEBIFC.ModelLoadCallback): Promise<void>;
     private readIfcFile;
     private streamIfcFile;

package/dist/fragments/IfcPropertiesTiler/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./streaming-settings";

package/dist/fragments/IfcPropertiesTiler/src/streaming-settings.d.ts

@@ -0,0 +1,11 @@
+import { IfcFragmentSettings } from "../../IfcLoader/src";
+/**
+ * Settings for streaming properties. Extends {@link IfcFragmentSettings} to inherit common settings.
+ */
+export declare class PropertiesStreamingSettings extends IfcFragmentSettings {
+    /**
+     * Amount of properties to be streamed.
+     * Defaults to 100 properties.
+     */
+    propertiesSize: number;
+}

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

@@ -1,17 +1,22 @@
 import * as WEBIFC from "web-ifc";
 import * as FRAG from "@thatopen/fragments";
 import { Component, Components } from "../../core";
+export * from "./src";
 /**
- * Object to export all the properties from an IFC to a JS object.
+ * Component to export all the properties from an IFC to a JS object. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcJsonExporter). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcJsonExporter).
  */
 export declare class IfcJsonExporter extends Component {
+    /**
+     * A unique identifier for the component.
+     * This UUID is used to register the component within the Components system.
+     */
     static readonly uuid: "b32c4332-cd67-436e-ba7f-196646c7a635";
     /** {@link Component.enabled} */
     enabled: boolean;
     constructor(components: Components);
     /**
      * Exports all the properties of an IFC into an array of JS objects.
-     * @param webIfc The instance of [web-ifc]{@link https://github.com/ThatOpen/engine_web-ifc} to use.
+     * @param webIfc The instance of [web-ifc](https://github.com/ThatOpen/engine_web-ifc) to use.
      * @param modelID ID of the IFC model whose properties to extract.
      * @param indirect whether to get the indirect relationships as well.
      * @param recursiveSpatial whether to get the properties of spatial items recursively

package/dist/ifc/IfcJsonExporter/src/ifc-geometry-types.d.ts

@@ -1 +1,4 @@
+/**
+ * A Set of unique numbers representing different types of IFC geometries.
+ */
 export declare const GeometryTypes: Set<number>;

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

@@ -0,0 +1 @@
+export * from "./ifc-geometry-types";

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

@@ -1,72 +1,256 @@
 import * as WEBIFC from "web-ifc";
 import { FragmentsGroup } from "@thatopen/fragments";
 import { Component, Disposable, Event, Components } from "../../core";
-type BooleanPropTypes = "IfcBoolean" | "IfcLogical";
-type StringPropTypes = "IfcText" | "IfcLabel" | "IfcIdentifier";
-type NumericPropTypes = "IfcInteger" | "IfcReal";
-interface ChangeMap {
+/**
+ * Types for boolean properties in IFC schema.
+ */
+export type BooleanPropTypes = "IfcBoolean" | "IfcLogical";
+/**
+ * Types for string properties in IFC schema.
+ */
+export type StringPropTypes = "IfcText" | "IfcLabel" | "IfcIdentifier";
+/**
+ * Types for numeric properties in IFC schema.
+ */
+export type NumericPropTypes = "IfcInteger" | "IfcReal";
+/**
+ * Interface representing a map of changed entities in a model. The keys are model UUIDs, and the values are sets of express IDs of changed entities.
+ */
+export interface ChangeMap {
     [modelID: string]: Set<number>;
 }
-interface AttributeListener {
+/**
+ * Interface representing a map of attribute listeners. The keys are model UUIDs, and the values are objects with express IDs as keys, and objects with attribute names as keys, and Event objects as values.
+ */
+export interface AttributeListener {
     [modelID: string]: {
         [expressID: number]: {
             [attributeName: string]: Event<String | Boolean | Number>;
         };
     };
 }
+/**
+ * Component to manage and edit properties and Psets in IFC files.
+ */
 export declare class IfcPropertiesManager extends Component implements Disposable {
+    /**
+     * A unique identifier for the component.
+     * This UUID is used to register the component within the Components system.
+     */
     static readonly uuid: "58c2d9f0-183c-48d6-a402-dfcf5b9a34df";
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<string>;
+    /**
+     * Event triggered when a file is requested for export.
+     */
     readonly onRequestFile: Event<unknown>;
+    /**
+     * ArrayBuffer containing the IFC data to be exported.
+     */
     ifcToExport: ArrayBuffer | null;
+    /**
+     * Event triggered when an element is added to a Pset.
+     */
     readonly onElementToPset: Event<{
         model: FragmentsGroup;
         psetID: number;
         elementID: number;
     }>;
+    /**
+     * Event triggered when a property is added to a Pset.
+     */
     readonly onPropToPset: Event<{
         model: FragmentsGroup;
         psetID: number;
         propID: number;
     }>;
+    /**
+     * Event triggered when a Pset is removed.
+     */
     readonly onPsetRemoved: Event<{
         model: FragmentsGroup;
         psetID: number;
     }>;
+    /**
+     * Event triggered when data in the model changes.
+     */
     readonly onDataChanged: Event<{
         model: FragmentsGroup;
         expressID: number;
     }>;
+    /**
+     * Configuration for the WebAssembly module.
+     */
     wasm: {
         path: string;
         absolute: boolean;
     };
+    /** {@link Component.enabled} */
     enabled: boolean;
+    /**
+     * Map of attribute listeners.
+     */
     attributeListeners: AttributeListener;
+    /**
+     * The currently selected model.
+     */
     selectedModel?: FragmentsGroup;
+    /**
+     * Map of changed entities in the model.
+     */
     changeMap: ChangeMap;
     constructor(components: Components);
+    /** {@link Disposable.dispose} */
     dispose(): void;
-    private increaseMaxID;
+    /**
+     * Static method to retrieve the IFC schema from a given model.
+     *
+     * @param model - The FragmentsGroup model from which to retrieve the IFC schema.
+     * @throws Will throw an error if the IFC schema is not found in the model.
+     * @returns The IFC schema associated with the given model.
+     */
     static getIFCSchema(model: FragmentsGroup): import("@thatopen/fragments").IfcSchema;
-    private newGUID;
-    private getOwnerHistory;
-    private registerChange;
+    /**
+     * Method to set properties data in the model.
+     *
+     * @param model - The FragmentsGroup model in which to set the properties.
+     * @param dataToSave - An array of objects representing the properties to be saved.
+     * 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.
+     *
+     * @throws Will throw an error if any of the `expressID` properties are missing in the `dataToSave` array.
+     */
     setData(model: FragmentsGroup, ...dataToSave: Record<string, any>[]): Promise<void>;
+    /**
+     * Creates a new Property Set (Pset) in the given model.
+     *
+     * @param model - The FragmentsGroup model in which to create the Pset.
+     * @param name - The name of the Pset.
+     * @param description - (Optional) The description of the Pset.
+     *
+     * @returns A promise that resolves with an object containing the newly created Pset and its relation.
+     *
+     * @throws Will throw an error if the IFC schema is not found in the model.
+     * @throws Will throw an error if no OwnerHistory is found in the model.
+     */
     newPset(model: FragmentsGroup, name: string, description?: string): Promise<{
         pset: WEBIFC.IFC2X3.IfcPropertySet | WEBIFC.IFC4.IfcPropertySet | WEBIFC.IFC4X3.IfcPropertySet;
         rel: WEBIFC.IFC4X3.IfcRelDefinesByProperties | WEBIFC.IFC4.IfcRelDefinesByProperties | WEBIFC.IFC2X3.IfcRelDefinesByProperties;
     }>;
+    /**
+     * Removes a Property Set (Pset) from the given model.
+     *
+     * @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.
+     *
+     * @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`.
+     * @throws Will throw an error if no relation is found between the Pset and the model.
+     */
     removePset(model: FragmentsGroup, ...psetID: number[]): Promise<void>;
-    private newSingleProperty;
+    /**
+     * Creates a new single-value property of type string in the given model.
+     *
+     * @param model - The FragmentsGroup model in which to create the property.
+     * @param type - The type of the property value. Must be a string property type.
+     * @param name - The name of the property.
+     * @param value - The value of the property. Must be a string.
+     *
+     * @returns The newly created single-value property.
+     *
+     * @throws Will throw an error if the IFC schema is not found in the model.
+     * @throws Will throw an error if no OwnerHistory is found in the model.
+     */
     newSingleStringProperty(model: FragmentsGroup, type: StringPropTypes, name: string, value: string): Promise<WEBIFC.IFC2X3.IfcPropertySingleValue | WEBIFC.IFC4.IfcPropertySingleValue | WEBIFC.IFC4X3.IfcPropertySingleValue>;
+    /**
+     * Creates a new single-value property of type numeric in the given model.
+     *
+     * @param model - The FragmentsGroup model in which to create the property.
+     * @param type - The type of the property value. Must be a numeric property type.
+     * @param name - The name of the property.
+     * @param value - The value of the property. Must be a number.
+     *
+     * @returns The newly created single-value property.
+     *
+     * @throws Will throw an error if the IFC schema is not found in the model.
+     * @throws Will throw an error if no OwnerHistory is found in the model.
+     */
     newSingleNumericProperty(model: FragmentsGroup, type: NumericPropTypes, name: string, value: number): Promise<WEBIFC.IFC2X3.IfcPropertySingleValue | WEBIFC.IFC4.IfcPropertySingleValue | WEBIFC.IFC4X3.IfcPropertySingleValue>;
+    /**
+     * Creates a new single-value property of type boolean in the given model.
+     *
+     * @param model - The FragmentsGroup model in which to create the property.
+     * @param type - The type of the property value. Must be a boolean property type.
+     * @param name - The name of the property.
+     * @param value - The value of the property. Must be a boolean.
+     *
+     * @returns The newly created single-value property.
+     *
+     * @throws Will throw an error if the IFC schema is not found in the model.
+     * @throws Will throw an error if no OwnerHistory is found in the model.
+     */
     newSingleBooleanProperty(model: FragmentsGroup, type: BooleanPropTypes, name: string, value: boolean): Promise<WEBIFC.IFC2X3.IfcPropertySingleValue | WEBIFC.IFC4.IfcPropertySingleValue | WEBIFC.IFC4X3.IfcPropertySingleValue>;
+    /**
+     * Removes a property from a Property Set (Pset) in the given model.
+     *
+     * @param model - The FragmentsGroup model from which to remove the property.
+     * @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.
+     *
+     * @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>;
+    /**
+     * Adds elements to a Property Set (Pset) in the given model.
+     *
+     * @param model - The FragmentsGroup model in which to add the elements.
+     * @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.
+     *
+     * @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`.
+     * @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>;
+    /**
+     * Saves the changes made to the model to a new IFC file.
+     *
+     * @param model - The FragmentsGroup model from which to save the changes.
+     * @param ifcToSaveOn - The Uint8Array representing the original IFC file.
+     *
+     * @returns A promise that resolves with the modified IFC data as a Uint8Array.
+     *
+     * @throws Will throw an error if any issues occur during the saving process.
+     */
     saveToIfc(model: FragmentsGroup, ifcToSaveOn: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Sets an attribute listener for a specific attribute of an entity in the model.
+     * The listener will trigger an event whenever the attribute's value changes.
+     *
+     * @param model - The FragmentsGroup model in which to set the attribute listener.
+     * @param expressID - The express ID of the entity for which to set the listener.
+     * @param attributeName - The name of the attribute for which to set the listener.
+     *
+     * @returns The event that will be triggered when the attribute's value changes.
+     *
+     * @throws Will throw an error if the entity with the given expressID doesn't exist.
+     * @throws Will throw an error if the attribute is an array or null, and it can't have a listener.
+     * @throws Will throw an error if the attribute has a badly defined handle.
+     */
     setAttributeListener(model: FragmentsGroup, expressID: number, attributeName: string): Promise<Event<String | Number | Boolean>>;
+    private increaseMaxID;
+    private newGUID;
+    private getOwnerHistory;
+    private registerChange;
+    private newSingleProperty;
 }
-export {};

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

@@ -2,21 +2,30 @@ 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";
 /**
- * Indexer 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.
+ * 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).
  */
 export declare class IfcRelationsIndexer extends Component implements Disposable {
+    /**
+     * A unique identifier for the component.
+     * This UUID is used to register the component within the Components system.
+     */
     static readonly uuid: "23a889ab-83b3-44a4-8bee-ead83438370b";
     /** {@link Disposable.onDisposed} */
     readonly onDisposed: Event<string>;
-    enabled: boolean;
+    /**
+     * Event triggered when relations for a model have been indexed.
+     * This event provides the model's UUID and the relations map generated for that model.
+     *
+     * @property {string} modelID - The UUID of the model for which relations have been indexed.
+     * @property {RelationsMap} relationsMap - The relations map generated for the specified model.
+     * The map keys are expressIDs of entities, and the values are maps where each key is a relation type ID and its value is an array of expressIDs of entities related through that relation type.
+     */
     readonly onRelationsIndexed: Event<{
         modelID: string;
         relationsMap: RelationsMap;
     }>;
-    private _relToAttributesMap;
-    private _inverseAttributes;
-    private _ifcRels;
     /**
      * Holds the relationship mappings for each model processed by the indexer.
      * The structure is a map where each key is a model's UUID, and the value is another map.
@@ -26,6 +35,11 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * of entity relationships within a model.
      */
     readonly relationMaps: ModelsRelationMap;
+    /** {@link Component.enabled} */
+    enabled: boolean;
+    private _relToAttributesMap;
+    private _inverseAttributes;
+    private _ifcRels;
     constructor(components: Components);
     private onFragmentsDisposed;
     private indexRelations;
@@ -122,11 +136,6 @@ export declare class IfcRelationsIndexer extends Component implements Disposable
      * is an array of express IDs (as numbers) of entities related through that relation type.
      */
     getRelationsMapFromJSON(json: string): RelationsMap;
-    /**
-     * Disposes the component, cleaning up resources and detaching event listeners.
-     * This ensures that the component is properly cleaned up and does not leave behind any
-     * references that could prevent garbage collection.
-     */
+    /** {@link Disposable.dispose} */
     dispose(): void;
 }
-export type { InverseAttribute, RelationsMap } from "./src/types";

package/dist/ifc/Utils/ifc-category-map.d.ts

@@ -1,3 +1,6 @@
+/**
+ * A map that associates each unique integer identifier (IFC Entity ID) with its corresponding category name. This map is used to map IFC entities to their respective categories for easier identification and processing.
+ */
 export declare const IfcCategoryMap: {
     [key: number]: string;
 };

package/dist/ifc/Utils/ifc-elements-map.d.ts

@@ -1,3 +1,11 @@
+/**
+ * A map of IFC element types to their corresponding names. The keys are the IFC entity type numbers, and the values are the names of the IFC entities.
+ *
+ * @remarks
+ * This map is used to provide a mapping between IFC entity type numbers and their names.
+ * It is useful for identifying and processing different types of IFC elements in a project.
+ *
+ */
 export declare const IfcElements: {
     [key: number]: string;
 };