@thatopen/components 2.1.26 → 2.2.0-alpha.0

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

@@ -0,0 +1,86 @@
+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;
+    config: Required<BCFTopicsConfig>;
+    readonly list: DataMap<string, Topic>;
+    readonly onSetup: Event<unknown>;
+    isSetup: boolean;
+    setup(config?: Partial<BCFTopicsConfig>): void;
+    readonly onBCFImported: Event<Topic[]>;
+    /**
+     * Creates a new BCFTopic instance and adds it to the list.
+     *
+     * @param data - Optional partial BCFTopic object to initialize the new topic with.
+     * If not provided, default values will be used.
+     * @returns The newly created BCFTopic instance.
+     */
+    create(data?: Partial<BCFTopic>): Topic;
+    readonly onDisposed: Event<unknown>;
+    dispose(): void;
+    /**
+     * Retrieves the unique set of topic types used across all topics.
+     *
+     * @returns A Set containing the unique topic types.
+     */
+    get usedTypes(): Set<string>;
+    /**
+     * Retrieves the unique set of topic statuses used across all topics.
+     *
+     * @returns A Set containing the unique topic statuses.
+     */
+    get usedStatuses(): Set<string>;
+    /**
+     * Retrieves the unique set of topic priorities used across all topics.
+     *
+     * @returns A Set containing the unique topic priorities.
+     * Note: This method filters out any null or undefined priorities.
+     */
+    get usedPriorities(): Set<string | undefined>;
+    /**
+     * Retrieves the unique set of topic stages used across all topics.
+     *
+     * @returns A Set containing the unique topic stages.
+     * Note: This method filters out any null or undefined stages.
+     */
+    get usedStages(): Set<string | undefined>;
+    /**
+     * Retrieves the unique set of users associated with topics.
+     *
+     * @returns A Set containing the unique users.
+     * Note: This method collects users from the creation author, assigned to, modified author, and comment authors.
+     */
+    get usedUsers(): Set<string>;
+    /**
+     * Retrieves the unique set of labels used across all topics.
+     *
+     * @returns A Set containing the unique labels.
+     */
+    get usedLabels(): Set<string>;
+    /**
+     * Updates the set of extensions (types, statuses, priorities, labels, stages, users) based on the current topics.
+     * This method iterates through each topic in the list and adds its properties to the corresponding sets in the config.
+     */
+    updateExtensions(): void;
+    /**
+     * Exports the given topics to a BCF (Building Collaboration Format) zip file.
+     *
+     * @param topics - The topics to export. Defaults to all topics in the list.
+     * @returns A promise that resolves to a Blob containing the exported BCF zip file.
+     */
+    export(topics?: Iterable<Topic>): Promise<Blob>;
+    private serializeExtensions;
+    private processMarkupComment;
+    private getMarkupComments;
+    private getMarkupLabels;
+    private getMarkupViewpoints;
+    private getMarkupRelatedTopics;
+    load(world: World, data: Uint8Array): Promise<{
+        viewpoints: Viewpoint[];
+        topics: Topic[];
+    }>;
+}
+export * from "./src";

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

@@ -0,0 +1,33 @@
+import { Viewpoint } from "../../../core/Viewpoints";
+import { Components } from "../../../core/Components";
+/**
+ * Represents a comment in a BCF Topic.
+ */
+export declare class Comment {
+    date: Date;
+    author: string;
+    guid: string;
+    viewpoint?: Viewpoint;
+    modifiedAuthor?: string;
+    modifiedDate?: Date;
+    private _components;
+    private _comment;
+    /**
+     * Sets the comment text and updates the modified date and author.
+     * The author will be the one defined in BCFTopics.config.author
+     * @param value - The new comment text.
+     */
+    set comment(value: string);
+    /**
+     * Gets the comment text.
+     * @returns The comment text.
+     */
+    get comment(): string;
+    /**
+     * Constructs a new BCF Topic Comment instance.
+     * @param components - The Components instance.
+     * @param text - The initial comment text.
+     */
+    constructor(components: Components, text: string);
+    serialize(): string;
+}

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

@@ -0,0 +1,129 @@
+import { Components } from "../../../core/Components";
+import { Viewpoint } from "../../../core/Viewpoints";
+import { Comment } from "./Comment";
+import { BCFTopic } from "./types";
+import { DataSet } from "../../../core/Types";
+export declare class Topic implements BCFTopic {
+    /**
+     * Default values for a BCF Topic, excluding `guid`, `creationDate`, and `creationAuthor`.
+     */
+    static default: Omit<BCFTopic, "guid" | "creationDate" | "creationAuthor">;
+    /**
+     * A unique identifier for the topic.
+     *
+     * @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;
+    creationDate: Date;
+    creationAuthor: string;
+    readonly comments: DataSet<Comment>;
+    readonly viewpoints: DataSet<Viewpoint>;
+    readonly relatedTopics: DataSet<Topic>;
+    customData: Record<string, any>;
+    description?: string;
+    serverAssignedId?: string;
+    dueDate?: Date;
+    modifiedAuthor?: string;
+    modifiedDate?: Date;
+    index?: number;
+    private _type;
+    set type(value: string);
+    get type(): string;
+    private _status;
+    set status(value: string);
+    get status(): string;
+    private _priority?;
+    set priority(value: string | undefined);
+    get priority(): string | undefined;
+    private _stage?;
+    set stage(value: string | undefined);
+    get stage(): string | undefined;
+    private _assignedTo?;
+    set assignedTo(value: string | undefined);
+    get assignedTo(): string | undefined;
+    private _labels;
+    set labels(value: Set<string>);
+    get labels(): Set<string>;
+    private _components;
+    private get _managerVersion();
+    /**
+     * Initializes a new instance of the `Topic` class representing a BCF (BIM Collaboration Format) topic.
+     * It provides methods and properties to manage and serialize BCF topics.
+     *
+     * @remarks
+     * The default creationUser is the one set in BCFTopics.config.author
+     * It should not be created manually. Better use BCFTopics.create().
+     *
+     * @param components - The `Components` instance that provides access to other components and services.
+     */
+    constructor(components: Components);
+    /**
+     * Sets properties of the BCF Topic based on the provided data.
+     *
+     * @remarks
+     * This method iterates over the provided `data` object and updates the corresponding properties of the BCF Topic.
+     * It skips the `guid` property as it should not be modified.
+     *
+     * @param data - An object containing the properties to be updated.
+     * @returns The topic
+     *
+     * @example
+     * ```typescript
+     * const topic = new Topic(components);
+     * topic.set({
+     *   title: "New BCF Topic Title",
+     *   description: "This is a new description.",
+     *   status: "Resolved",
+     * });
+     * ```
+     */
+    set(data: Partial<BCFTopic>): this;
+    /**
+     * Creates a new comment associated with the current topic.
+     *
+     * @param text - The text content of the comment.
+     * @param viewpoint - (Optional) The viewpoint associated with the comment.
+     *
+     * @returns The newly created comment.
+     *
+     * @example
+     * ```typescript
+     * const viewpoint = viewpoints.create(world); // Created with an instance of Viewpoints
+     * const topic = topics.create(); // Created with an instance of BCFTopics
+     * topic.viewpoints.add(viewpoint);
+     * const comment = topic.createComment("This is a new comment", viewpoint);
+     * ```
+     */
+    createComment(text: string, viewpoint?: Viewpoint): Comment;
+    private createLabelTags;
+    private createCommentTags;
+    private createViewpointTags;
+    private createRelatedTopicTags;
+    /**
+     * Serializes the BCF Topic instance into an XML string representation based on the official schema.
+     *
+     * @remarks
+     * This method constructs an XML string based on the properties of the BCF Topic instance.
+     * It includes the topic's guid, type, status, creation date, creation author, priority, index,
+     * modified date, modified author, due date, assigned to, description, stage, labels, related topics,
+     * comments, and viewpoints.
+     *
+     * @returns A string representing the XML serialization of the BCF Topic.
+     *
+     * @example
+     * ```typescript
+     * const topic = bcfTopics.create(); // Created with an instance of BCFTopics
+     * const xml = topic.serialize();
+     * console.log(xml);
+     * ```
+     */
+    serialize(): string;
+}

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

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

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

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

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

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

@@ -0,0 +1,37 @@
+import * as BUI from "@thatopen/ui";
+import { Components } 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;
+        };
+    };
+}
+export interface TopicPanelUI {
+    components: Components;
+    topic?: Topic;
+    styles?: Partial<DataStyles>;
+    onUpdateInformation?: (topic: Topic) => void | Promise<void>;
+}
+export declare const topicPanelTemplate: (state: TopicPanelUI) => BUI.TemplateResult<1>;
+export {};

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

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

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

@@ -0,0 +1,37 @@
+import * as BUI from "@thatopen/ui";
+import { Components } 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;
+        };
+    };
+}
+export interface BCFTopicsUI {
+    components: Components;
+    topics?: Iterable<Topic>;
+    styles?: Partial<DataStyles>;
+    onTopicEnter?: (topic: Topic) => void | Promise<void>;
+}
+export declare const bcfTopicsListTemplate: (state: BCFTopicsUI) => BUI.TemplateResult<1>;
+export {};

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

@@ -0,0 +1,6 @@
+export * from "./Topic";
+export * from "./types";
+export * from "./Comment";
+export * from "./TopicForm";
+export * from "./TopicPanel";
+export * from "./TopicsList";

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

@@ -0,0 +1,35 @@
+export type BCFVersion = "2.1" | "3";
+export interface BCFTopic {
+    guid: string;
+    serverAssignedId?: string;
+    type: string;
+    status: string;
+    title: string;
+    priority?: string;
+    index?: number;
+    labels: Set<string>;
+    creationDate: Date;
+    creationAuthor: string;
+    modifiedDate?: Date;
+    modifiedAuthor?: string;
+    dueDate?: Date;
+    assignedTo?: string;
+    description?: string;
+    stage?: string;
+}
+export interface BCFTopicsConfig {
+    version: BCFVersion;
+    author: string;
+    types: Set<string>;
+    statuses: Set<string>;
+    priorities: Set<string>;
+    labels: Set<string>;
+    stages: Set<string>;
+    users: Set<string>;
+    includeSelectionTag: boolean;
+    updateExtensionsOnImport: boolean;
+    strict: boolean;
+    includeAllExtensionsOnExport: boolean;
+    fallbackVersionOnImport: BCFVersion | null;
+    ignoreIncompleteTopicsOnImport: boolean;
+}

package/dist/openbim/index.d.ts

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thatopen/components",
   "description": "Collection of core functionalities to author BIM apps.",
-  "version": "2.1.26",
+  "version": "2.2.0-alpha.0",
   "author": "That Open Company",
   "contributors": [
     "Antonio Gonzalez Viegas (https://github.com/agviegas)",
@@ -46,6 +46,8 @@
   },
   "dependencies": {
     "camera-controls": "2.7.3",
+    "fast-xml-parser": "latest",
+    "jszip": "latest",
     "three-mesh-bvh": "0.7.0"
   },
   "peerDependencies": {
@@ -53,4 +55,4 @@
     "three": "^0.160.1",
     "web-ifc": "0.0.57"
   }
-}
+}