@thatopen/components 2.3.0-alpha.9 → 2.3.0

package/dist/openbim/BCFTopics/index.d.ts

@@ -2,6 +2,10 @@ import { XMLParser } from "fast-xml-parser";
 import { Component, Configurable, Disposable, Event, World, DataMap } from "../../core";
 import { BCFTopic, Topic, BCFTopicsConfigManager, BCFTopicsConfig } from "./src";
 import { Viewpoint } from "../../core/Viewpoints";
+/**
+ * BCFTopics manages Building Collaboration Format (BCF) data the engine.
+ * It provides functionality for importing, exporting, and manipulating BCF data.
+ */
 export declare class BCFTopics extends Component implements Disposable, Configurable<BCFTopicsConfigManager, BCFTopicsConfig> {
     static uuid: "de977976-e4f6-4e4f-a01a-204727839802";
     enabled: boolean;

package/dist/openbim/IDSSpecifications/index.d.ts

@@ -0,0 +1,61 @@
+import * as FRAGS from "@thatopen/fragments";
+import { XMLParser } from "fast-xml-parser";
+import { Component, DataMap } from "../../core/Types";
+import { IDSCheckResult, IDSInfo, IDSSpecification, IfcVersion } from "./src";
+import { Components } from "../../core";
+/**
+ * Component that manages Information Delivery Specification (IDS) data.
+ * It provides functionality for importing, exporting, and manipulating IDS data.
+ */
+export declare class IDSSpecifications extends Component {
+    static uuid: "9f0b9f78-9b2e-481a-b766-2fbfd01f342c";
+    enabled: boolean;
+    static xmlParser: XMLParser;
+    constructor(components: Components);
+    readonly list: DataMap<string, IDSSpecification>;
+    /**
+     * Retrieves a FragmentIdMap based on the given IDSCheckResult array.
+     * The map separates the IDs into two categories: pass and fail.
+     *
+     * @param model - The FragmentsGroup model from which to retrieve the fragment map.
+     * @param result - An array of IDSCheckResult objects, each representing a check result.
+     *
+     * @returns An object containing two properties:
+     * - `pass`: A FragmentIdMap that passed the checks.
+     * - `fail`: A FragmentIdMap that failed the checks.
+     */
+    getFragmentIdMap(model: FRAGS.FragmentsGroup, result: IDSCheckResult[]): {
+        pass: FRAGS.FragmentIdMap;
+        fail: FRAGS.FragmentIdMap;
+    };
+    /**
+     * Creates a new IDSSpecification instance and adds it to the list.
+     *
+     * @param name - The name of the IDSSpecification.
+     * @param ifcVersion - An array of IfcVersion values that the specification supports.
+     *
+     * @returns The newly created IDSSpecification instance.
+     */
+    create(name: string, ifcVersion: IfcVersion[]): IDSSpecification;
+    /**
+     * Parses and processes an XML string containing Information Delivery Specification (IDS) data.
+     * It creates IDSSpecification instances based on the parsed data and returns them in an array.
+     * Also, the instances are added to the list array.
+     *
+     * @param data - The XML string to parse.
+     *
+     * @returns An array of IDSSpecification instances created from the parsed data.
+     */
+    load(data: string): IDSSpecification[];
+    /**
+     * Exports the IDSSpecifications data into an XML string.
+     *
+     * @param info - The metadata information for the exported XML.
+     * @param specifications - An optional iterable of IDSSpecification instances to export.
+     * If not provided, all specifications in the list will be exported.
+     *
+     * @returns A string containing the exported IDSSpecifications data in XML format.
+     */
+    export(info: IDSInfo, specifications?: Iterable<IDSSpecification>): string;
+}
+export * from "./src";

package/dist/openbim/IDSSpecifications/src/Specification.d.ts

@@ -0,0 +1,39 @@
+import * as FRAGS from "@thatopen/fragments";
+import { Components } from "../../../core/Components";
+import { DataSet } from "../../../core/Types";
+import { IDSCheckResult, IfcVersion } from "./types";
+import { IDSFacet } from "./facets";
+/**
+ * Represents a single specification from the Information Delivery Specification (IDS) standard.
+ *
+ * @remarks This class provides methods for testing a model against the specification,
+ * as well as serializing the specification into XML format.
+ */
+export declare class IDSSpecification {
+    name: string;
+    ifcVersion: Set<IfcVersion>;
+    identifier: string;
+    description?: string;
+    instructions?: string;
+    requirementsDescription?: string;
+    applicability: DataSet<IDSFacet>;
+    requirements: DataSet<IDSFacet>;
+    protected components: Components;
+    constructor(components: Components, name: string, ifcVersion: IfcVersion[]);
+    /**
+     * Tests the model to test against the specification's requirements.
+     *
+     * @param model - The model to be tested.
+     * @returns An array representing the test results.
+     * If no requirements are defined for the specification, an empty array is returned.
+     */
+    test(model: FRAGS.FragmentsGroup): Promise<IDSCheckResult[]>;
+    /**
+     * Serializes the IDSSpecification instance into XML format.
+     *
+     * @remarks This method is not meant to be used directly. It is used by the IDSSpecifications component.
+     *
+     * @returns The XML representation of the IDSSpecification.
+     */
+    serialize(): string;
+}

package/dist/openbim/IDSSpecifications/src/exporters/parameter.d.ts

@@ -0,0 +1,2 @@
+import { IDSFacetParameterName, IDSFacetParameter } from "../types";
+export declare const getParameterXML: (name: IDSFacetParameterName, parameter?: IDSFacetParameter) => string;

package/dist/openbim/IDSSpecifications/src/facets/Attribute.d.ts

@@ -0,0 +1,12 @@
+import * as FRAGS from "@thatopen/fragments";
+import { IDSCheckResult, IDSFacetParameter } from "../types";
+import { Components } from "../../../../core/Components";
+import { IDSFacet } from "./Facet";
+export declare class IDSAttribute extends IDSFacet {
+    name: IDSFacetParameter;
+    value?: IDSFacetParameter;
+    constructor(components: Components, name: IDSFacetParameter);
+    serialize(type: "applicability" | "requirement"): string;
+    getEntities(): Promise<never[]>;
+    test(entities: FRAGS.IfcProperties): Promise<IDSCheckResult[]>;
+}

package/dist/openbim/IDSSpecifications/src/facets/Classification.d.ts

@@ -0,0 +1,20 @@
+import * as FRAGS from "@thatopen/fragments";
+import { Components } from "../../../../core/Components";
+import { IDSCheckResult, IDSFacetParameter } from "../types";
+import { IDSFacet } from "./Facet";
+export declare class IDSClassification extends IDSFacet {
+    system: IDSFacetParameter;
+    value?: IDSFacetParameter;
+    uri?: string;
+    constructor(components: Components, system: IDSFacetParameter);
+    serialize(type: "applicability" | "requirement"): string;
+    getEntities(model: FRAGS.FragmentsGroup, collector?: FRAGS.IfcProperties): Promise<number[]>;
+    test(entities: FRAGS.IfcProperties, model: FRAGS.FragmentsGroup): Promise<IDSCheckResult[]>;
+    private processReferencedSource;
+    private getSystems;
+    private getSystemName;
+    private getAllReferenceIdentifications;
+    private evalSystem;
+    private evalValue;
+    private evalURI;
+}

package/dist/openbim/IDSSpecifications/src/facets/Entity.d.ts

@@ -0,0 +1,14 @@
+import * as FRAGS from "@thatopen/fragments";
+import { Components } from "../../../../core/Components";
+import { IDSFacet } from "./Facet";
+import { IDSCheck, IDSCheckResult, IDSFacetParameter } from "../types";
+export declare class IDSEntity extends IDSFacet {
+    name: IDSFacetParameter;
+    predefinedType?: IDSFacetParameter;
+    constructor(components: Components, name: IDSFacetParameter);
+    serialize(type: "applicability" | "requirement"): string;
+    getEntities(model: FRAGS.FragmentsGroup, collector?: FRAGS.IfcProperties): Promise<number[]>;
+    test(entities: FRAGS.IfcProperties, model: FRAGS.FragmentsGroup): Promise<IDSCheckResult[]>;
+    protected evalName(attrs: any, checks?: IDSCheck[]): Promise<boolean>;
+    protected evalPredefinedType(model: FRAGS.FragmentsGroup, attrs: any, checks?: IDSCheck[]): Promise<boolean | null>;
+}

package/dist/openbim/IDSSpecifications/src/facets/Facet.d.ts

@@ -0,0 +1,25 @@
+import * as FRAGS from "@thatopen/fragments";
+import { Components } from "../../../../core/Components";
+import { IDSFacetParameter, IDSCheckResult, IDSFacetParameterName, IDSCheck, IDSConditionalCardinaltiy, IDSSimpleCardinality } from "../types";
+export declare abstract class IDSFacet {
+    protected components: Components;
+    cardinality: IDSSimpleCardinality | IDSConditionalCardinaltiy;
+    instructions?: string;
+    constructor(components: Components);
+    protected addCheckResult(check: IDSCheck, checks: IDSCheck[]): void;
+    protected evalRequirement: (value: string | number | boolean | null, facetParameter: IDSFacetParameter, parameter: IDSFacetParameterName, checks?: IDSCheck[]) => boolean;
+    protected testResult: IDSCheckResult[];
+    protected saveResult(attrs: any, pass: boolean): void;
+    /**
+     * Returns the list of expressIDs that pass the criteria of this facet.
+     * @param model - The IFC model to retrieve entities from.
+     * @param collector - An optional object to collect the retrieved entities.
+     * @remarks
+     * If the collector already includes the entity, it won't get processed any further.
+     *
+     * @returns An array of express IDs of the retrieved entities.
+     */
+    abstract getEntities(model: FRAGS.FragmentsGroup, collector: FRAGS.IfcProperties): Promise<number[]>;
+    abstract test(entities: FRAGS.IfcProperties, model?: FRAGS.FragmentsGroup): Promise<IDSCheckResult[]>;
+    abstract serialize(type: "applicability" | "requirement"): string;
+}

package/dist/openbim/IDSSpecifications/src/facets/Material.d.ts

@@ -0,0 +1,9 @@
+import { IDSFacetParameter } from "../types";
+import { IDSFacet } from "./Facet";
+export declare class IdsMaterialFacet extends IDSFacet {
+    value?: IDSFacetParameter;
+    uri?: string;
+    serialize(type: "applicability" | "requirement"): string;
+    getEntities(): Promise<number[]>;
+    test(): Promise<import("../types").IDSCheckResult[]>;
+}

package/dist/openbim/IDSSpecifications/src/facets/PartOf.d.ts

@@ -0,0 +1,25 @@
+import * as FRAGS from "@thatopen/fragments";
+import { Components } from "../../../../core/Components";
+import { IDSFacet } from "./Facet";
+import { IDSFacetParameter, IDSSimpleCardinality } from "../types";
+export declare class IDSPartOf extends IDSFacet {
+    private _entityFacet;
+    private _entity;
+    set entity(value: {
+        name: IDSFacetParameter;
+        predefinedType?: IDSFacetParameter;
+    });
+    get entity(): {
+        name: IDSFacetParameter;
+        predefinedType?: IDSFacetParameter;
+    };
+    relation?: number;
+    cardinality: IDSSimpleCardinality;
+    constructor(components: Components, entity: {
+        name: IDSFacetParameter;
+        predefinedType?: IDSFacetParameter;
+    });
+    serialize(): string;
+    getEntities(model: FRAGS.FragmentsGroup, collector?: FRAGS.IfcProperties): Promise<number[]>;
+    test(entities: FRAGS.IfcProperties, model: FRAGS.FragmentsGroup): Promise<import("../types").IDSCheckResult[]>;
+}

package/dist/openbim/IDSSpecifications/src/facets/Property.d.ts

@@ -0,0 +1,22 @@
+import * as FRAGS from "@thatopen/fragments";
+import { IDSCheckResult, IDSFacetParameter } from "../types";
+import { Components } from "../../../../core/Components";
+import { IDSFacet } from "./Facet";
+export declare class IDSProperty extends IDSFacet {
+    propertySet: IDSFacetParameter;
+    baseName: IDSFacetParameter;
+    value?: IDSFacetParameter;
+    dataType?: string;
+    uri?: string;
+    private _unsupportedTypes;
+    constructor(components: Components, propertySet: IDSFacetParameter, baseName: IDSFacetParameter);
+    serialize(type: "applicability" | "requirement"): string;
+    getEntities(model: FRAGS.FragmentsGroup, collector?: FRAGS.IfcProperties): Promise<never[]>;
+    test(entities: FRAGS.IfcProperties, model: FRAGS.FragmentsGroup): Promise<IDSCheckResult[]>;
+    private getItemsAttrName;
+    private getValueKey;
+    private getPsets;
+    private evalValue;
+    private evalDataType;
+    private evalURI;
+}

package/dist/openbim/IDSSpecifications/src/facets/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./Attribute";
+export * from "./Classification";
+export * from "./Entity";
+export * from "./Property";
+export * from "./Facet";

package/dist/openbim/IDSSpecifications/src/importers/attribute.d.ts

@@ -0,0 +1,3 @@
+import { Components } from "../../../../core/Components";
+import { IDSFacet } from "../facets";
+export declare const createAttributeFacets: (components: Components, elements: any) => IDSFacet[];

package/dist/openbim/IDSSpecifications/src/importers/classification.d.ts

@@ -0,0 +1,3 @@
+import { Components } from "../../../../core/Components";
+import { IDSFacet } from "../facets";
+export declare const createClassificationFacets: (components: Components, elements: any) => IDSFacet[];

package/dist/openbim/IDSSpecifications/src/importers/entity.d.ts

@@ -0,0 +1,3 @@
+import { Components } from "../../../../core/Components";
+import { IDSFacet } from "../facets";
+export declare const createEntityFacets: (components: Components, elements: any) => IDSFacet[];

package/dist/openbim/IDSSpecifications/src/importers/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./entity";
+export * from "./attribute";
+export * from "./classification";

package/dist/openbim/IDSSpecifications/src/importers/parameter.d.ts

@@ -0,0 +1,2 @@
+import { IDSFacetParameter } from "../types";
+export declare const getParameterValue: (property: any) => IDSFacetParameter | undefined;

package/dist/openbim/IDSSpecifications/src/importers/property.d.ts

@@ -0,0 +1,3 @@
+import { Components } from "../../../../core/Components";
+import { IDSFacet } from "../facets";
+export declare const createPropertyFacets: (components: Components, elements: any) => IDSFacet[];

package/dist/openbim/IDSSpecifications/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./facets";
+export * from "./Specification";

package/dist/openbim/IDSSpecifications/src/types.d.ts

@@ -0,0 +1,51 @@
+export type IfcVersion = "IFC2X3" | "IFC4" | "IFC4X3_ADD2";
+export type IDSFacetParameterName = "Name" | "PredefinedType" | "Value" | "System" | "URI" | "PropertySet" | "BaseName" | "DataType" | "Value" | "Entity" | "Relation";
+export type IDSSimpleCardinality = "required" | "prohibited";
+export type IDSConditionalCardinaltiy = IDSSimpleCardinality | "optional";
+export type IDSSimpleParameter = string | number | boolean;
+export type IDSEnumerationParameter = string[] | number[] | boolean[];
+export type IDSPatternParameter = string;
+export type IDSBoundsParameter = {
+    min?: number;
+    minInclusive?: boolean;
+    max?: number;
+    maxInclusive?: boolean;
+};
+export type IDSLengthParameter = {
+    min?: number;
+    length?: number;
+    max?: number;
+};
+export interface IDSRestrictionParameter {
+}
+export type IDSFacetParameterType = "simple" | "enumeration" | "pattern" | "bounds" | "length";
+export interface IDSFacetParameter {
+    type: IDSFacetParameterType;
+    parameter: IDSSimpleParameter | IDSEnumerationParameter | IDSPatternParameter | IDSBoundsParameter | IDSLengthParameter;
+}
+export interface IDSCheck {
+    parameter: IDSFacetParameterName;
+    currentValue: string | number | boolean | null;
+    requiredValue: any;
+    pass: boolean;
+}
+/**
+ * Represents the result of a check performed by an IDSFacet test.
+ */
+export interface IDSCheckResult {
+    guid?: string;
+    expressID: number;
+    pass: boolean;
+    checks: IDSCheck[];
+    cardinality: IDSConditionalCardinaltiy;
+}
+export interface IDSInfo {
+    title: string;
+    description?: string;
+    copyright?: string;
+    version?: string;
+    author?: string;
+    date?: Date;
+    purpose?: string;
+    milestone?: string;
+}

package/dist/openbim/index.d.ts

@@ -1 +1,2 @@
 export * from "./BCFTopics";
+export * from "./IDSSpecifications";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thatopen/components",
   "description": "Collection of core functionalities to author BIM apps.",
-  "version": "2.3.0-alpha.9",
+  "version": "2.3.0",
   "author": "That Open Company",
   "contributors": [
     "Antonio Gonzalez Viegas (https://github.com/agviegas)",
@@ -37,12 +37,12 @@
     "access": "public"
   },
   "devDependencies": {
-    "@thatopen/fragments": ">=2.3.0-alpha.5",
+    "@thatopen/fragments": "~2.3.0",
     "@thatopen/ui": "~2.2.0",
     "@types/three": "0.160.0",
     "stats.js": "^0.17.0",
     "three": "^0.160.1",
-    "web-ifc": "0.0.57"
+    "web-ifc": "0.0.59"
   },
   "dependencies": {
     "camera-controls": "2.7.3",
@@ -51,8 +51,8 @@
     "three-mesh-bvh": "0.7.0"
   },
   "peerDependencies": {
-    "@thatopen/fragments": ">=2.3.0-alpha.5",
+    "@thatopen/fragments": "~2.3.0",
     "three": "^0.160.1",
-    "web-ifc": "0.0.57"
+    "web-ifc": "0.0.59"
   }
 }