@thatopen/components 2.4.11 → 3.1.0

package/dist/ifc/IfcFinder/src/ifc-property-query.d.ts

@@ -1,36 +0,0 @@
-import * as FRAGS from "@thatopen/fragments";
-import { IfcFinderQuery } from "./ifc-finder-query";
-import { IfcOperatorRule, IfcPropertyRule, SerializedQuery } from "./types";
-import { Components } from "../../../core";
-/**
- * A query that checks the properties in the property sets assigned to IFC items.
- */
-export declare class IfcPropertyQuery extends IfcFinderQuery {
-    /**
-     * {@link IfcFinderQuery.name}
-     */
-    name: string;
-    /**
-     * The type of this query.
-     */
-    static type: "IfcPropertyQuery";
-    private psets;
-    /**
-     * {@link IfcFinderQuery.items}
-     */
-    get items(): FRAGS.FragmentIdMap;
-    constructor(components: Components, data: {
-        name: string;
-        inclusive: boolean;
-        rules: (IfcPropertyRule | IfcOperatorRule)[];
-    });
-    /**
-     * {@link IfcFinderQuery.export}
-     */
-    export(): SerializedQuery;
-    /**
-     * {@link IfcFinderQuery.update}
-     */
-    update(modelID: string, file: File): Promise<void>;
-    protected findInLines(modelID: string, lines: string[]): void;
-}

package/dist/ifc/IfcFinder/src/ifc-query-group.d.ts

@@ -1,69 +0,0 @@
-import * as FRAGS from "@thatopen/fragments";
-import { IfcFinderQuery } from "./ifc-finder-query";
-import { Components } from "../../../core";
-/**
- * A group of queries to perform searches in one or many IFC files.
- */
-export declare class IfcQueryGroup {
-    /**
-     * The list of queries contained in this group.
-     */
-    list: Map<string, IfcFinderQuery>;
-    /**
-     * A unique string to identify this group instance.
-     */
-    id: string;
-    /**
-     * The way this group works when retrieving items.
-     * - Combine: returns the sum of all items of all queries.
-     * - Intersect: returns only the common elements of all queries.
-     */
-    mode: "combine" | "intersect";
-    private _components;
-    /**
-     * The list of unique queries contained in this group.
-     */
-    get queries(): Set<IfcFinderQuery>;
-    /**
-     * The items of all the queries contained in this group. The returned data depends on {@link IfcQueryGroup.mode}.
-     */
-    get items(): FRAGS.FragmentIdMap;
-    constructor(components: Components);
-    /**
-     * Adds a new query to this group.
-     * @param query the query to add.
-     */
-    add(query: IfcFinderQuery): void;
-    /**
-     * Clears the data of the given modelID of all queries contained in this group. If no modelID is provided, clears all data.
-     * @param modelID the model whose data to remove.
-     */
-    clear(modelID?: string): void;
-    /**
-     * Imports data that has been previously exported through {@link IfcQueryGroup.export}.
-     * @param data the serializable object used to persist a group's data.
-     */
-    import(data: {
-        mode: "combine" | "intersect";
-        id: string;
-        queries: {
-            [guid: string]: any;
-        };
-    }): void;
-    /**
-     * Exports all the data of this group, so that it can be persisted and imported later using {@link IfcQueryGroup.import}.
-     */
-    export(): {
-        mode: "combine" | "intersect";
-        id: string;
-        queries: {
-            [guid: string]: any;
-        };
-    };
-    /**
-     * Updates all the queries contained in this group that need an update for the given file. It will skip those where {@link IfcFinderQuery.needsUpdate} is false.
-     * @param modelID the identifier used to refer to the given file.
-     * @param file the file to process.
-     */
-    update(modelID: string, file: File): Promise<void>;
-}

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

@@ -1,4 +0,0 @@
-export * from "./types";
-export * from "./ifc-finder-query";
-export * from "./ifc-basic-query";
-export * from "./ifc-property-query";

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

@@ -1,84 +0,0 @@
-/**
- * A rule for the {@link IfcFinder} to search items based on their category.
- */
-export interface IfcCategoryRule {
-    /**
-     * The type of this rule. All rules have a fixed type.
-     */
-    type: "category";
-    /**
-     * The category value. It's a regular expression, so you can make complex queries and use ".*" to match all categories.
-     */
-    value: RegExp;
-}
-/**
- * A rule for the {@link IfcFinder} to search items based on the properties defined in their property sets.
- */
-export interface IfcPropertyRule {
-    /**
-     * The type of this rule. All rules have a fixed type.
-     */
-    type: "property";
-    /**
-     * The name of the property. It's a regular expression, so you can make complex queries and use ".*" to match all names.
-     */
-    name: RegExp;
-    /**
-     * The value of the property. It's a regular expression, so you can make complex queries and use ".*" to match all values.
-     */
-    value: RegExp;
-}
-/**
- * A rule for the {@link IfcFinder} to search items based on the value of a numeric property defined in their property sets.
- */
-export interface IfcOperatorRule {
-    /**
-     * The type of this rule. All rules have a fixed type.
-     */
-    type: "operator";
-    /**
-     * The name of the property. It's a regular expression, so you can make complex queries and use ".*" to match all names.
-     */
-    name: RegExp;
-    /**
-     * The value of the property.
-     */
-    value: number;
-    /**
-     * The operator to apply to the numeric value.
-     */
-    operator: "<" | ">" | "=" | "<=" | ">=";
-}
-/**
- * The type of rules that can be used in the queries of the {@link IfcFinder}.
- */
-export type IfcFinderRule = IfcCategoryRule | IfcPropertyRule | IfcOperatorRule;
-/**
- * The data type used when the queries of the {@link IfcFinder} export or import query data to persist it.
- */
-export type SerializedQuery = {
-    /**
-     * {@link IfcFinderQuery.name}
-     */
-    name: string;
-    /**
-     * {@link IfcFinderQuery.inclusive}
-     */
-    inclusive: boolean;
-    /**
-     * The type of query.
-     */
-    type: string;
-    /**
-     * {@link IfcFinderQuery.ids}
-     */
-    ids: {
-        [modelID: string]: number[];
-    };
-    /**
-     * {@link IfcFinderQuery.rules}
-     */
-    rules: {
-        [key: string]: any;
-    }[];
-};

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

@@ -1,24 +0,0 @@
-import * as WEBIFC from "web-ifc";
-import { Component, Components } from "../../core";
-/**
- * Component to isolate certain elements from an IFC and export to another IFC. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/IfcIsolator). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/IfcIsolator).
- */
-export declare class IfcIsolator extends Component {
-    /**
-     * A unique identifier for the component.
-     * This UUID is used to register the component within the Components system.
-     */
-    static readonly uuid: "6eb0ba2f-71c0-464e-bcec-2d7c335186b2";
-    /** {@link Component.enabled} */
-    enabled: boolean;
-    constructor(components: Components);
-    getIsolatedElements(webIfc: WEBIFC.IfcAPI, modelID: number, elementIDs: Array<number>): Promise<any[]>;
-    /**
-     * Exports isolated elements to the new model.
-     * @param webIfc The instance of [web-ifc](https://github.com/ThatOpen/engine_web-ifc) to use.
-     * @param modelID ID of the new IFC model.
-     * @param isolatedElements The array of isolated elements
-     */
-    export(webIfc: WEBIFC.IfcAPI, modelID: number, isolatedElements: Array<any>): Promise<Uint8Array>;
-    splitIfc(webIfc: WEBIFC.IfcAPI, ifcFile: ArrayBuffer, idsToExtract: Array<number>): Promise<Uint8Array>;
-}

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

@@ -1,26 +0,0 @@
-import * as WEBIFC from "web-ifc";
-import * as FRAG from "@thatopen/fragments";
-import { Component, Components } from "../../core";
-export * from "./src";
-/**
- * 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](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
-     * to make the location data available (e.g. absolute position of building).
-     */
-    export(webIfc: WEBIFC.IfcAPI, modelID: number, indirect?: boolean, recursiveSpatial?: boolean): Promise<FRAG.IfcProperties>;
-}

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

@@ -1,4 +0,0 @@
-/**
- * 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

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

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

@@ -1,289 +0,0 @@
-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.
- */
-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 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;
-    /**
-     * 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;
-    /**
-     * Method to add or update entity attributes 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 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.IFC4.IfcPropertySet | WEBIFC.IFC2X3.IfcPropertySet | WEBIFC.IFC4X3.IfcPropertySet;
-    }>;
-    /**
-     * 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 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>;
-    /**
-     * 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.IFC4.IfcPropertySingleValue | WEBIFC.IFC2X3.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.IFC4.IfcPropertySingleValue | WEBIFC.IFC2X3.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.IFC4.IfcPropertySingleValue | WEBIFC.IFC2X3.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 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>;
-    /**
-     * @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.
-     *
-     * @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 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>;
-    /**
-     * 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.
-     *
-     * @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>;
-    /**
-     * Retrieves all the entities of a specific type from the model and returns their express IDs wrapped in Handles.
-     * This is used to make references of an entity inside another entity attributes.
-     *
-     * @param model - The FragmentsGroup model from which to retrieve the entities.
-     * @param type - The type of the entities to retrieve. This should be the express ID of the IFC type.
-     *
-     * @returns A promise that resolves with an array of Handles, each containing the express ID of an entity of the specified type.
-     * @returns null if the model doesn't have any entity of that type
-     */
-    getEntityRef(model: FragmentsGroup, type: number): Promise<WEBIFC.Handle<unknown>[] | null>;
-    /**
-     * 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 getNewExpressID;
-    private newGUID;
-    getOwnerHistory(model: FragmentsGroup): Promise<{
-        entity: {
-            [attribute: string]: any;
-        };
-        handle: WEBIFC.Handle<unknown>;
-    }>;
-    registerChange(model: FragmentsGroup, ...expressID: number[]): void;
-    newSingleProperty(model: FragmentsGroup, type: string, name: string, value: string | number | boolean): Promise<WEBIFC.IFC4.IfcPropertySingleValue | WEBIFC.IFC2X3.IfcPropertySingleValue | WEBIFC.IFC4X3.IfcPropertySingleValue>;
-}
-export * from "./src";

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

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

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

@@ -1,7 +0,0 @@
-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

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

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

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