@thatopen/components 2.2.0-alpha.1 → 2.2.0

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

@@ -1,10 +1,11 @@
+import { XMLParser } from "fast-xml-parser";
 import { Component, Configurable, Disposable, Event, World, DataMap } from "../../core/Types";
 import { BCFTopic, BCFTopicsConfig, Topic } from "./src";
 import { Viewpoint } from "../../core/Viewpoints";
 export declare class BCFTopics extends Component implements Disposable, Configurable<BCFTopicsConfig> {
     static uuid: "de977976-e4f6-4e4f-a01a-204727839802";
     enabled: boolean;
-    private _xmlParser;
+    static xmlParser: XMLParser;
     config: Required<BCFTopicsConfig>;
     readonly list: DataMap<string, Topic>;
     readonly onSetup: Event<unknown>;
@@ -20,6 +21,13 @@ export declare class BCFTopics extends Component implements Disposable, Configur
      */
     create(data?: Partial<BCFTopic>): Topic;
     readonly onDisposed: Event<unknown>;
+    /**
+     * Disposes of the BCFTopics component and triggers the onDisposed event.
+     *
+     * @remarks
+     * This method clears the list of topics and triggers the onDisposed event.
+     * It also resets the onDisposed event listener.
+     */
     dispose(): void;
     /**
      * Retrieves the unique set of topic types used across all topics.
@@ -84,7 +92,17 @@ export declare class BCFTopics extends Component implements Disposable, Configur
     private getMarkupLabels;
     private getMarkupViewpoints;
     private getMarkupRelatedTopics;
-    load(world: World, data: Uint8Array): Promise<{
+    /**
+     * Loads BCF (Building Collaboration Format) data into the engine.
+     *
+     * @param world - The default world where the viewpoints are going to be created.
+     * @param data - The BCF data to load.
+     *
+     * @returns A promise that resolves to an object containing the created viewpoints and topics.
+     *
+     * @throws An error if the BCF version is not supported.
+     */
+    load(data: Uint8Array, world: World): Promise<{
         viewpoints: Viewpoint[];
         topics: Topic[];
     }>;

package/dist/openbim/BCFTopics/src/Comment.d.ts

@@ -31,5 +31,10 @@ export declare class Comment {
      * @param text - The initial comment text.
      */
     constructor(components: Components, text: string);
+    /**
+     * Serializes the Comment instance into a BCF compliant XML string.
+     *
+     * @returns A string representing the Comment in BCFv2 XML format.
+     */
     serialize(): string;
 }

package/dist/openbim/BCFTopics/src/Topic.d.ts

@@ -13,12 +13,6 @@ export declare class Topic implements BCFTopic {
      *
      * @remarks
      * The `guid` is automatically generated upon topic creation and by no means it should change.
-     *
-     * @example
-     * ```typescript
-     * const topic = new Topic(components);
-     * console.log(topic.guid); // Output: "123e4567-e89b-12d3-a456-426614174000"
-     * ```
      */
     guid: string;
     title: string;

package/dist/openbim/BCFTopics/src/importers/extensions.d.ts

@@ -0,0 +1,2 @@
+import { BCFTopics } from "../..";
+export declare const extensionsImporter: (manager: BCFTopics, extensionsXML: string) => void;

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

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

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

@@ -1,7 +1,4 @@
 export * from "./Topic";
 export * from "./types";
 export * from "./Comment";
-export * from "./TopicForm";
-export * from "./TopicPanel";
-export * from "./TopicsList";
-export * from "./ViewpointsList";
+export * from "./importers";

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

@@ -17,19 +17,75 @@ export interface BCFTopic {
     description?: string;
     stage?: string;
 }
+/**
+ * Configuration settings for managing BCF topics.
+ * This interface defines the properties and their meanings used to control the behavior of exporting and importing BCF topics.
+ */
 export interface BCFTopicsConfig {
+    /**
+     * The BCF version used during export.
+     */
     version: BCFVersion;
+    /**
+     * The email of the user creating topics using this component.
+     */
     author: string;
+    /**
+     * The set of allowed topic types. This is exported inside the
+     * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure).
+     */
     types: Set<string>;
+    /**
+     * The set of allowed topic statuses. This is exported inside the
+     * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure).
+     */
     statuses: Set<string>;
+    /**
+     * The set of allowed topic priorities. This is exported inside the
+     * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure).
+     */
     priorities: Set<string>;
+    /**
+     * The set of allowed topic labels. This is exported inside the
+     * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure).
+     */
     labels: Set<string>;
+    /**
+     * The set of allowed topic stages. This is exported inside the
+     * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure).
+     */
     stages: Set<string>;
+    /**
+     * The set of allowed topic users. This is exported inside the
+     * [bcf.extensions](https://github.com/buildingSMART/BCF-XML/tree/release_3_0/Documentation#bcf-file-structure).
+     */
     users: Set<string>;
+    /**
+     * Whether or not to include the AuthoringSoftwareId in the viewpoint components during export.
+     */
     includeSelectionTag: boolean;
+    /**
+     * Updates the types, statuses, users, etc., after importing an external BCF.
+     */
     updateExtensionsOnImport: boolean;
+    /**
+     * Only allow to use the extensions (types, statuses, etc.) defined in the config when setting the corresponding data in a topic.
+     */
     strict: boolean;
+    /**
+     * If true, export the extensions (types, status, etc.) based on topics data. This doesn't update the extensions in the config.
+     * If false, only export the extensions defined in each collection of possibilities set in the config.
+     * In all cases, all the values from each collection of extensions defined in the config are going to be exported.
+     */
     includeAllExtensionsOnExport: boolean;
+    /**
+     * Version to be used when importing if no bcf.version file is present in the incoming data.
+     * When null, the importer will throw an error if the version is missing or is not supported.
+     */
     fallbackVersionOnImport: BCFVersion | null;
+    /**
+     * If true, do not import a topic with missing information (guid, type, status, title, creationDate or creationAuthor).
+     * If false, use default values for missing data.
+     */
     ignoreIncompleteTopicsOnImport: boolean;
 }

package/package.json

@@ -1,58 +1,58 @@
-{
-  "name": "@thatopen/components",
-  "description": "Collection of core functionalities to author BIM apps.",
-  "version": "2.2.0-alpha.1",
-  "author": "That Open Company",
-  "contributors": [
-    "Antonio Gonzalez Viegas (https://github.com/agviegas)",
-    "Juan Hoyos (https://github.com/HoyosJuan)",
-    "Harry Collin (https://github.com/harrycollin)"
-  ],
-  "license": "MIT",
-  "homepage": "https://github.com/ThatOpen/engine_components/tree/main/packages/components#readme",
-  "bugs": {
-    "url": "https://github.com/ThatOpen/engine_components/issues"
-  },
-  "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ThatOpen/engine_components/tree/main/packages/components.git"
-  },
-  "packageManager": "yarn@3.2.1",
-  "scripts": {
-    "dev": "vite --host",
-    "test": "jest",
-    "build": "tsc --p ./tsconfig-build.json && vite build",
-    "prepublishOnly": "node ./resources/updateComponentsVersion.mjs && yarn build",
-    "publish-repo": "npm publish",
-    "publish-alpha": "npm publish --tag alpha"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@thatopen/fragments": "~2.1.0",
-    "@thatopen/ui": "~2.1.0",
-    "@types/three": "0.160.0",
-    "stats.js": "^0.17.0",
-    "three": "^0.160.1",
-    "web-ifc": "0.0.57"
-  },
-  "dependencies": {
-    "camera-controls": "2.7.3",
-    "fast-xml-parser": "latest",
-    "jszip": "latest",
-    "three-mesh-bvh": "0.7.0"
-  },
-  "peerDependencies": {
-    "@thatopen/fragments": "~2.1.0",
-    "three": "^0.160.1",
-    "web-ifc": "0.0.57"
-  }
-}
+{
+  "name": "@thatopen/components",
+  "description": "Collection of core functionalities to author BIM apps.",
+  "version": "2.2.0",
+  "author": "That Open Company",
+  "contributors": [
+    "Antonio Gonzalez Viegas (https://github.com/agviegas)",
+    "Juan Hoyos (https://github.com/HoyosJuan)",
+    "Harry Collin (https://github.com/harrycollin)"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/ThatOpen/engine_components/tree/main/packages/components#readme",
+  "bugs": {
+    "url": "https://github.com/ThatOpen/engine_components/issues"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ThatOpen/engine_components/tree/main/packages/components.git"
+  },
+  "packageManager": "yarn@3.2.1",
+  "scripts": {
+    "dev": "vite --host",
+    "test": "jest",
+    "build": "tsc --p ./tsconfig-build.json && vite build",
+    "prepublishOnly": "node ./resources/updateComponentsVersion.mjs && yarn build",
+    "publish-repo": "npm publish",
+    "publish-alpha": "npm publish --tag alpha"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@thatopen/fragments": "~2.2.0",
+    "@thatopen/ui": "~2.1.0",
+    "@types/three": "0.160.0",
+    "stats.js": "^0.17.0",
+    "three": "^0.160.1",
+    "web-ifc": "0.0.57"
+  },
+  "dependencies": {
+    "camera-controls": "2.7.3",
+    "fast-xml-parser": "4.4.1",
+    "jszip": "3.10.1",
+    "three-mesh-bvh": "0.7.0"
+  },
+  "peerDependencies": {
+    "@thatopen/fragments": "~2.2.0",
+    "three": "^0.160.1",
+    "web-ifc": "0.0.57"
+  }
+}

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

@@ -1,12 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { TopicCommentsUI } from "./src/template";
-/**
- * Creates a Topic Comments List component with the given UI state.
- *
- * @param state - The initial state of the Topic Comments List component.
- * @param autoUpdate - A flag indicating whether the component should automatically update based on events happening in the BCFTopic component.
- * Default value is `true`.
- *
- * @returns A tuple containing the created Topic Comments List component and a function to update it.
- */
-export declare const topicComments: (state: TopicCommentsUI, autoUpdate?: boolean) => [element: BUI.Table, update: (state?: Partial<TopicCommentsUI> | undefined) => TopicCommentsUI, currentState: () => TopicCommentsUI];

package/dist/openbim/BCFTopics/src/TopicComments/src/template.d.ts

@@ -1,20 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { Topic } from "../../Topic";
-import { Viewpoint } from "../../../../../core";
-interface UserStyles {
-    [email: string]: {
-        name: string;
-        picture?: string;
-    };
-}
-interface TopicCommentsActions {
-    delete: boolean;
-}
-export interface TopicCommentsUI {
-    topic: Topic;
-    viewpoint?: Viewpoint;
-    styles?: UserStyles;
-    actions?: Partial<TopicCommentsActions>;
-}
-export declare const topicCommentsTemplate: (state: TopicCommentsUI) => BUI.TemplateResult<1>;
-export {};

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

@@ -1,10 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { TopicFormUI } from "./src/template";
-/**
- * Creates a Topic Form component with the given UI state.
- *
- * @param state - The initial state of the Topic Form component.
- *
- * @returns A tuple containing the created Topic Form component and a function to update it.
- */
-export declare const topicForm: (state: TopicFormUI) => [element: BUI.Table, update: (state?: Partial<TopicFormUI> | undefined) => TopicFormUI, currentState: () => TopicFormUI];

package/dist/openbim/BCFTopics/src/TopicForm/src/template.d.ts

@@ -1,20 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { Topic } from "../../Topic";
-import { Components } from "../../../../../core";
-interface DataStyles {
-    users: {
-        [email: string]: {
-            name: string;
-            picture?: string;
-        };
-    };
-}
-export interface TopicFormUI {
-    components: Components;
-    topic?: Topic;
-    onSubmit?: (topic: Topic) => void | Promise<void>;
-    onCancel?: () => void | Promise<void>;
-    styles?: Partial<DataStyles>;
-}
-export declare const topicFormTemplate: (state: TopicFormUI) => BUI.TemplateResult<1>;
-export {};

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

@@ -1,12 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { TopicPanelUI } from "./src/template";
-/**
- * Creates a Topic Panel component with the given UI state.
- *
- * @param state - The initial state of the Topic Panel component.
- * @param autoUpdate - A flag indicating whether the component should automatically update based on events happening in the BCFTopic component.
- * Default value is `true`.
- *
- * @returns A tuple containing the created Topic Panel component and a function to update it.
- */
-export declare const topicPanel: (state: TopicPanelUI, autoUpdate?: boolean) => [element: BUI.Table, update: (state?: Partial<TopicPanelUI> | undefined) => TopicPanelUI, currentState: () => TopicPanelUI];

package/dist/openbim/BCFTopics/src/TopicPanel/src/template.d.ts

@@ -1,46 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { Components, World } from "../../../../../core";
-import { Topic } from "../../Topic";
-interface DataStyles {
-    priorities: {
-        [name: string]: {
-            icon?: string;
-            style?: Record<string, string>;
-        };
-    };
-    statuses: {
-        [name: string]: {
-            icon?: string;
-            style?: Record<string, string>;
-        };
-    };
-    types: {
-        [name: string]: {
-            icon?: string;
-            style?: Record<string, string>;
-        };
-    };
-    users: {
-        [email: string]: {
-            name: string;
-            picture?: string;
-        };
-    };
-}
-interface TopicPanelActions {
-    update: boolean;
-    addComments: boolean;
-    addViewpoints: boolean;
-    linkViewpoints: boolean;
-    linkTopics: boolean;
-}
-export interface TopicPanelUI {
-    components: Components;
-    topic?: Topic;
-    styles?: Partial<DataStyles>;
-    onUpdateInformation?: (topic: Topic) => void | Promise<void>;
-    actions?: Partial<TopicPanelActions>;
-    world?: World;
-}
-export declare const topicPanelTemplate: (state: TopicPanelUI) => BUI.TemplateResult<1>;
-export {};

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

@@ -1,12 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { BCFTopicsUI } from "./src/template";
-/**
- * Creates a BCF Topics List component with the given UI state.
- *
- * @param state - The initial state of the BCF Topics List component.
- * @param autoUpdate - A flag indicating whether the component should automatically update based on events happening in the BCFTopic component.
- * Default value is `true`.
- *
- * @returns A tuple containing the created BCF Topics List component and a function to update it.
- */
-export declare const bcfTopicsList: (state: BCFTopicsUI, autoUpdate?: boolean) => [element: BUI.Table, update: (state?: Partial<BCFTopicsUI> | undefined) => BCFTopicsUI, currentState: () => BCFTopicsUI];

package/dist/openbim/BCFTopics/src/TopicsList/src/template.d.ts

@@ -1,29 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { Components } from "../../../../../core";
-import { Topic } from "../../Topic";
-interface DataStyles {
-    [name: string]: {
-        icon?: string;
-        style?: Record<string, string>;
-    };
-}
-interface UserStyles {
-    [email: string]: {
-        name: string;
-        picture?: string;
-    };
-}
-interface TopicDataStyles {
-    priorities?: DataStyles;
-    statuses?: DataStyles;
-    types?: DataStyles;
-    users?: UserStyles;
-}
-export interface BCFTopicsUI {
-    components: Components;
-    topics?: Iterable<Topic>;
-    dataStyles?: TopicDataStyles;
-    onTopicEnter?: (topic: Topic) => void | Promise<void>;
-}
-export declare const bcfTopicsListTemplate: (state: BCFTopicsUI) => BUI.TemplateResult<1>;
-export {};

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

@@ -1,12 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { ViewpointsUI } from "./src/template";
-/**
- * Creates a Viewpoints component with the given UI state.
- *
- * @param state - The initial state of the Viewpoints component.
- * @param autoUpdate - A flag indicating whether the component should automatically update based on events happening in the BCFTopic component.
- * Default value is `true`.
- *
- * @returns A tuple containing the created Viewpoints component and a function to update it.
- */
-export declare const viewpointsList: (state: ViewpointsUI, autoUpdate?: boolean) => [element: BUI.Table, update: (state?: Partial<ViewpointsUI> | undefined) => ViewpointsUI, currentState: () => ViewpointsUI];

package/dist/openbim/BCFTopics/src/ViewpointsList/src/template.d.ts

@@ -1,19 +0,0 @@
-import * as BUI from "@thatopen/ui";
-import { Components, Viewpoint } from "../../../../../core";
-import { Topic } from "../../Topic";
-interface ViewpointUIActions {
-    selectComponents: boolean;
-    colorizeComponent: boolean;
-    resetColors: boolean;
-    updateCamera: boolean;
-    delete: boolean;
-    unlink: boolean;
-}
-export interface ViewpointsUI {
-    components: Components;
-    topic?: Topic;
-    actions?: Partial<ViewpointUIActions>;
-    onViewpointEnter?: (viewpoint: Viewpoint) => void | Promise<void>;
-}
-export declare const viewpointsListTemplate: (state: ViewpointsUI) => BUI.TemplateResult<1>;
-export {};