@thatopen/components 2.2.5 → 2.3.0-alpha.1

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

@@ -1,12 +1,13 @@
 import { XMLParser } from "fast-xml-parser";
-import { Component, Configurable, Disposable, Event, World, DataMap } from "../../core/Types";
-import { BCFTopic, BCFTopicsConfig, Topic } from "./src";
+import { Component, Configurable, Disposable, Event, World, DataMap } from "../../core";
+import { BCFTopic, Topic, BCFTopicsConfigManager, BCFTopicsConfig } from "./src";
 import { Viewpoint } from "../../core/Viewpoints";
-export declare class BCFTopics extends Component implements Disposable, Configurable<BCFTopicsConfig> {
+export declare class BCFTopics extends Component implements Disposable, Configurable<BCFTopicsConfigManager, BCFTopicsConfig> {
     static uuid: "de977976-e4f6-4e4f-a01a-204727839802";
     enabled: boolean;
     static xmlParser: XMLParser;
-    config: Required<BCFTopicsConfig>;
+    protected _defaultConfig: Required<BCFTopicsConfig>;
+    config: BCFTopicsConfigManager;
     readonly list: DataMap<string, Topic>;
     readonly onSetup: Event<unknown>;
     isSetup: boolean;

package/dist/openbim/BCFTopics/src/bcf-topics-config.d.ts

@@ -0,0 +1,181 @@
+import { BCFTopics, BCFVersion } from "../index";
+import { BooleanSettingsControl, ConfigManager, SelectSettingControl, TextSetSettingControl, TextSettingsControl } from "../../../core";
+/**
+ * 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;
+}
+type BCFTopicsConfigType = {
+    version: SelectSettingControl;
+    author: TextSettingsControl;
+    types: TextSetSettingControl;
+    statuses: TextSetSettingControl;
+    priorities: TextSetSettingControl;
+    labels: TextSetSettingControl;
+    stages: TextSetSettingControl;
+    users: TextSetSettingControl;
+    includeSelectionTag: BooleanSettingsControl;
+    updateExtensionsOnImport: BooleanSettingsControl;
+    strict: BooleanSettingsControl;
+    includeAllExtensionsOnExport: BooleanSettingsControl;
+    fallbackVersionOnImport: SelectSettingControl;
+    ignoreIncompleteTopicsOnImport: BooleanSettingsControl;
+};
+export declare class BCFTopicsConfigManager extends ConfigManager<BCFTopics, BCFTopicsConfigType> {
+    protected _list: {
+        version: {
+            type: "Select";
+            options: Set<string>;
+            value: string;
+        };
+        author: {
+            type: "Text";
+            value: string;
+        };
+        types: {
+            type: "TextSet";
+            value: Set<string>;
+        };
+        statuses: {
+            type: "TextSet";
+            value: Set<string>;
+        };
+        priorities: {
+            type: "TextSet";
+            value: Set<string>;
+        };
+        labels: {
+            type: "TextSet";
+            value: Set<string>;
+        };
+        stages: {
+            type: "TextSet";
+            value: Set<string>;
+        };
+        users: {
+            type: "TextSet";
+            value: Set<string>;
+        };
+        includeSelectionTag: {
+            type: "Boolean";
+            value: boolean;
+        };
+        updateExtensionsOnImport: {
+            type: "Boolean";
+            value: boolean;
+        };
+        strict: {
+            type: "Boolean";
+            value: boolean;
+        };
+        includeAllExtensionsOnExport: {
+            type: "Boolean";
+            value: boolean;
+        };
+        fallbackVersionOnImport: {
+            type: "Select";
+            options: Set<string>;
+            value: string;
+        };
+        ignoreIncompleteTopicsOnImport: {
+            type: "Boolean";
+            value: boolean;
+        };
+    };
+    get version(): string;
+    set version(value: string);
+    get author(): string;
+    set author(value: string);
+    get types(): Set<string>;
+    set types(value: Set<string>);
+    get statuses(): Set<string>;
+    set statuses(value: Set<string>);
+    get priorities(): Set<string>;
+    set priorities(value: Set<string>);
+    get labels(): Set<string>;
+    set labels(value: Set<string>);
+    get stages(): Set<string>;
+    set stages(value: Set<string>);
+    get users(): Set<string>;
+    set users(value: Set<string>);
+    get includeSelectionTag(): boolean;
+    set includeSelectionTag(value: boolean);
+    get updateExtensionsOnImport(): boolean;
+    set updateExtensionsOnImport(value: boolean);
+    get strict(): boolean;
+    set strict(value: boolean);
+    get includeAllExtensionsOnExport(): boolean;
+    set includeAllExtensionsOnExport(value: boolean);
+    get fallbackVersionOnImport(): string;
+    set fallbackVersionOnImport(value: string);
+    get ignoreIncompleteTopicsOnImport(): boolean;
+    set ignoreIncompleteTopicsOnImport(value: boolean);
+}
+export {};

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

@@ -2,3 +2,4 @@ export * from "./Topic";
 export * from "./types";
 export * from "./Comment";
 export * from "./importers";
+export * from "./bcf-topics-config";

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

@@ -17,75 +17,3 @@ 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,7 +1,7 @@
 {
   "name": "@thatopen/components",
   "description": "Collection of core functionalities to author BIM apps.",
-  "version": "2.2.5",
+  "version": "2.3.0-alpha.1",
   "author": "That Open Company",
   "contributors": [
     "Antonio Gonzalez Viegas (https://github.com/agviegas)",