vim-web 0.3.27-dev.1 → 0.3.27-dev.2

package/dist/types/react-viewers/bim/bimInfoData.d.ts

@@ -1,40 +1,100 @@
+/**
+ * @fileoverview This file exports types and a React hook for customizing the rendering
+ * and data handling of a BIM info panel. The hook provides references for customizing
+ * how data is processed and rendered in different sections of the BIM info panel.
+ */
 import * as VIM from '../../core-viewers/webgl/index';
+/**
+ * Represents an entry in the BIM info panel, such as a key-value pair in a header or body section.
+ */
 export type Entry = {
+    /**
+     * The key of the entry, often used as a label or an identifier for the data.
+     */
     key: string | undefined;
+    /**
+     * The label or display name for the entry, shown to the user.
+     */
     label: string | undefined;
+    /**
+     * The value of the entry, displayed to the user.
+     */
     value: string | undefined;
 };
+/**
+ * Represents a group of entries within a body section of the BIM info panel.
+ */
 export type Group = {
+    /**
+     * The unique identifier for this group.
+     */
     key: string | undefined;
+    /**
+     * The title or name displayed for this group.
+     */
     title: string | undefined;
+    /**
+     * An array of entries that belong to this group.
+     */
     content: Entry[];
 };
+/**
+ * Represents a section of the body, containing one or more groups of entries.
+ */
 export type Section = {
+    /**
+     * The unique identifier for this section.
+     */
     key: string | undefined;
+    /**
+     * The title displayed for this section.
+     */
     title: string;
+    /**
+     * An array of groups that this section contains.
+     */
     content: Group[];
 };
+/**
+ * Represents the entire data set for the BIM info panel, including the header and body sections.
+ */
 export type Data = {
+    /**
+     * The header of the BIM info panel, typically a list of entries summarizing key information.
+     */
     header: Entry[] | undefined;
+    /**
+     * The body of the BIM info panel, typically containing one or more sections of grouped entries.
+     */
     body: Section[] | undefined;
 };
 /**
- * Data customization function for the BIM info panel.
- * @data The data to customize.
- * @source The VIM.Object or VIM.Vim from which the data was pulled.
+ * A customization function for modifying the panel data before rendering. It allows
+ * developers to transform, filter, or augment the data pulled from a VIM source.
+ *
+ * @param data - The data to customize.
+ * @param source - The VIM.Object or VIM.Vim instance from which the data was originally extracted.
+ * @returns A promise that resolves to the modified Data object.
  */
 export type DataCustomization = (data: Data, source: VIM.Vim | VIM.Object3D) => Promise<Data>;
 /**
- * Rendering customization function for the BIM info panel.
- * @data The data to render.
- * @standard The standard rendering function for the data.
+ * A rendering customization function that takes props containing data and a standard
+ * rendering function, and returns a custom JSX element. This function enables developers
+ * to override how data is rendered in different parts of the BIM info panel.
+ *
+ * @typeParam T - The type of data to render.
+ * @param props.data - The data to render.
+ * @param props.standard - The standard rendering function for the data.
+ * @returns A custom JSX element to render, or `undefined` to use the default rendering.
  */
 export type DataRender<T> = ((props: {
     data: T;
     standard: () => JSX.Element;
 }) => JSX.Element) | undefined;
 /**
- * Reference object for customizing the rendering of the BIM info panel.
+ * A reference object exposing multiple customization callbacks for transforming data and rendering
+ * different parts of the BIM info panel. These callbacks can be updated at runtime and will be used
+ * the next time the panel re-renders.
  */
 export type BimInfoPanelRef = {
     /**
@@ -74,4 +134,11 @@ export type BimInfoPanelRef = {
      */
     onRenderBodyEntryValue: DataRender<Entry>;
 };
-export declare function createBimInfoState(): BimInfoPanelRef;
+/**
+ * A React hook that provides a reference object for customizing the data and rendering
+ * of a BIM info panel. This hook maintains internal state for each customization callback,
+ * allowing dynamic updates at runtime.
+ *
+ * @returns A {@link BimInfoPanelRef} object containing getters and setters for each customization callback.
+ */
+export declare function useBimInfo(): BimInfoPanelRef;

package/dist/types/react-viewers/container.d.ts

@@ -4,7 +4,7 @@
 /**
  * Basic HTML structure that the webgl component expects
  */
-export type VimComponentContainer = {
+export type Container = {
     /**
      * Root of the viewer, all component ui should have this as an acestor.
      */
@@ -24,4 +24,4 @@ export type VimComponentContainer = {
  * The element is created if not provided. The element will be made position:absolute.
  * @element optional HTML element to use as root
  */
-export declare function createContainer(element?: HTMLElement): VimComponentContainer;
+export declare function createContainer(element?: HTMLElement): Container;

package/dist/types/react-viewers/panels/contextMenu.d.ts

@@ -7,8 +7,7 @@ import { Isolation } from '../helpers/isolation';
 import { ComponentCamera } from '../helpers/camera';
 import { TreeActionRef } from '../bim/bimTree';
 import { ModalRef } from './modal';
-export declare const VIM_CONTEXT_MENU_ID = "vim-context-menu-id";
-export type ClickCallback = React.MouseEvent<HTMLDivElement, MouseEvent>;
+type ClickCallback = React.MouseEvent<HTMLDivElement, MouseEvent>;
 export declare function showContextMenu(position: {
     x: number;
     y: number;
@@ -73,3 +72,4 @@ export declare function VimContextMenu(props: {
     customization?: (e: ContextMenuElement[]) => ContextMenuElement[];
     treeRef: React.MutableRefObject<TreeActionRef | undefined>;
 }): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/react-viewers/settings/settings.d.ts

@@ -1,22 +1,35 @@
 /**
  * @module viw-webgl-react
+ * Contains settings and type definitions for the Vim web component
  */
 /**
  * Makes all fields optional recursively
- * https://stackoverflow.com/questions/41980195/recursive-partialt-in-typescript
+ * @template T - The type to make recursively partial
+ * @returns A type with all nested properties made optional
  */
 export type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
 };
 /**
- * true, false or restricted
- * Restricted: is false and cannot be changed by the user.
+ * Represents a boolean value that can also be locked to always true or false
+ * @typedef {boolean | 'AlwaysTrue' | 'AlwaysFalse'} UserBoolean
  */
 export type UserBoolean = boolean | 'AlwaysTrue' | 'AlwaysFalse';
+/**
+ * Checks if a UserBoolean value is effectively true
+ * @param {UserBoolean | boolean} value - The value to check
+ * @returns {boolean} True if the value is true or 'AlwaysTrue'
+ */
 export declare function isTrue(value: UserBoolean | boolean): value is true | "AlwaysTrue";
+/**
+ * Checks if a UserBoolean value is effectively false
+ * @param {UserBoolean | boolean} value - The value to check
+ * @returns {boolean} True if the value is false or 'AlwaysFalse'
+ */
 export declare function isFalse(value: UserBoolean | boolean): value is false | "AlwaysFalse";
 /**
- * Vim component settings, can either be set at component intialization or by user using UI.
+ * Complete settings configuration for the Vim component
+ * @interface ComponentSettings
  */
 export type ComponentSettings = {
     peformance: {
@@ -57,9 +70,37 @@ export type ComponentSettings = {
         maximise: UserBoolean;
     };
 };
+/**
+ * Partial version of ComponentSettings where all properties are optional
+ */
 export type PartialComponentSettings = RecursivePartial<ComponentSettings>;
+/**
+ * Checks if any axes-related UI buttons are enabled
+ * @param {ComponentSettings} settings - The component settings to check
+ * @returns {boolean} True if any axes buttons are enabled
+ */
 export declare function anyUiAxesButton(settings: ComponentSettings): UserBoolean;
+/**
+ * Checks if any cursor-related UI buttons are enabled
+ * @param {ComponentSettings} settings - The component settings to check
+ * @returns {boolean} True if any cursor buttons are enabled
+ */
 export declare function anyUiCursorButton(settings: ComponentSettings): boolean;
+/**
+ * Checks if any tool-related UI buttons are enabled
+ * @param {ComponentSettings} settings - The component settings to check
+ * @returns {boolean} True if any tool buttons are enabled
+ */
 export declare function anyUiToolButton(settings: ComponentSettings): boolean;
+/**
+ * Checks if any settings-related UI buttons are enabled
+ * @param {ComponentSettings} settings - The component settings to check
+ * @returns {boolean} True if any settings buttons are enabled
+ */
 export declare function anyUiSettingButton(settings: ComponentSettings): boolean;
+/**
+ * Default settings configuration for the Vim component
+ * @constant
+ * @type {ComponentSettings}
+ */
 export declare const defaultSettings: ComponentSettings;

package/dist/types/react-viewers/settings/settingsStorage.d.ts

@@ -2,5 +2,14 @@
  * @module viw-webgl-react
  */
 import { ComponentSettings, PartialComponentSettings } from './settings';
+/**
+ * Retrieves component settings from localStorage and applies permissions
+ * @param settings - Partial component settings to apply permissions from
+ * @returns The stored settings with applied permissions, or empty object if retrieval fails
+ */
 export declare function getLocalSettings(settings?: PartialComponentSettings): {};
+/**
+ * Saves component settings to localStorage after removing permissions
+ * @param value - Component settings to save
+ */
 export declare function saveSettingsToLocal(value: ComponentSettings): void;

package/dist/types/react-viewers/sidePanel/sidePanel.d.ts

@@ -4,7 +4,7 @@
 import React from 'react';
 import * as VIM from '../../core-viewers/webgl/index';
 import { SideState } from './sideState';
-import { VimComponentContainer } from '../container';
+import { Container } from '../container';
 /**
  * Memoized version of the SidePanel.
  */
@@ -13,7 +13,7 @@ export declare const SidePanelMemo: React.MemoExoticComponent<typeof SidePanel>;
  * JSX Component for collapsible and resizable side panel.
  */
 export declare function SidePanel(props: {
-    container: VimComponentContainer;
+    container: Container;
     side: SideState;
     viewer: VIM.Viewer;
     content: () => JSX.Element;

package/dist/types/react-viewers/ultra/ultraComponent.d.ts

@@ -1,5 +1,5 @@
 import * as Ultra from '../../core-viewers/ultra/index';
-import { VimComponentContainer } from '../container';
+import { Container } from '../container';
 import { ModalRef } from '../panels/modal';
 export type UltraComponentRef = {
     viewer: Ultra.Viewer;
@@ -14,7 +14,7 @@ export type UltraComponentRef = {
 *  @param viewerSettings Viewer settings.
  * @returns An object containing the resulting container, reactRoot, and viewer.
  */
-export declare function createUltraComponent(container?: VimComponentContainer | HTMLElement): Promise<UltraComponentRef>;
+export declare function createUltraComponent(container?: Container | HTMLElement): Promise<UltraComponentRef>;
 /**
  * Represents a React component providing UI for the Vim viewer.
  * @param container The container object containing root, gfx, and UI elements for the Vim viewer.
@@ -23,7 +23,7 @@ export declare function createUltraComponent(container?: VimComponentContainer |
  * @param settings Optional settings for configuring the Vim component's behavior.
  */
 export declare function UltraComponent(props: {
-    container: VimComponentContainer;
+    container: Container;
     viewer: Ultra.Viewer;
     onMount: (component: UltraComponentRef) => void;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/types/react-viewers/webgl/index.d.ts

@@ -4,8 +4,8 @@ export * as ContextMenu from '../panels/contextMenu';
 export * as BimInfo from '../bim/bimInfoData';
 export * as ControlBar from '../controlbar/controlBar';
 export * as Icons from '../panels/icons';
-export * from '../helpers/loadRequest';
-export * from './webglComponentRef';
+export { LoadRequest } from '../helpers/loadRequest';
+export * as Refs from './webglComponentRef';
 export { getLocalSettings as getLocalSettings } from '../settings/settingsStorage';
 export { type ComponentSettings as Settings, type PartialComponentSettings as PartialSettings, defaultSettings } from '../settings/settings';
 export * from '../container';

package/dist/types/react-viewers/webgl/webglComponent.d.ts

@@ -3,7 +3,7 @@
  */
 import * as VIM from '../../core-viewers/webgl/index';
 import { PartialComponentSettings } from '../settings/settings';
-import { VimComponentContainer } from '../container';
+import { Container } from '../container';
 import { VimComponentRef } from './webglComponentRef';
 /**
  * Creates a UI container along with a VIM.Viewer and its associated React component.
@@ -12,7 +12,7 @@ import { VimComponentRef } from './webglComponentRef';
 *  @param viewerSettings Viewer settings.
  * @returns An object containing the resulting container, reactRoot, and viewer.
  */
-export declare function createWebglComponent(container?: VimComponentContainer | HTMLElement, componentSettings?: PartialComponentSettings, viewerSettings?: VIM.PartialViewerSettings): Promise<VimComponentRef>;
+export declare function createWebglComponent(container?: Container | HTMLElement, componentSettings?: PartialComponentSettings, viewerSettings?: VIM.PartialViewerSettings): Promise<VimComponentRef>;
 /**
  * Represents a React component providing UI for the Vim viewer.
  * @param container The container object containing root, gfx, and UI elements for the Vim viewer.
@@ -21,7 +21,7 @@ export declare function createWebglComponent(container?: VimComponentContainer |
  * @param settings Optional settings for configuring the Vim component's behavior.
  */
 export declare function VimComponent(props: {
-    container: VimComponentContainer;
+    container: Container;
     viewer: VIM.Viewer;
     onMount: (component: VimComponentRef) => void;
     settings?: PartialComponentSettings;

package/dist/types/react-viewers/webgl/webglComponentRef.d.ts

@@ -6,7 +6,7 @@ import { ContextMenuCustomization } from '../panels/contextMenu';
 import { ComponentSettings } from '../settings/settings';
 import { Isolation } from '../helpers/isolation';
 import { ComponentCamera } from '../helpers/camera';
-import { VimComponentContainer } from '../container';
+import { Container } from '../container';
 import { BimInfoPanelRef } from '../bim/bimInfoData';
 import { ControlBarCustomization } from '../controlbar/controlBar';
 import { ComponentLoader } from './webglLoading';
@@ -26,30 +26,41 @@ export type SettingsRef = {
      */
     register: (callback: (settings: ComponentSettings) => void) => void;
 };
+/**
+ * Reference to manage context menu functionality in the component.
+ */
 export type ContextMenuRef = {
     /**
-    * Defines a callback function to dynamically customize the context menu.
-    * @param customization The configuration object specifying the customization options for the context menu.
-    */
+     * Defines a callback function to dynamically customize the context menu.
+     * @param customization The configuration object specifying the customization options for the context menu.
+     */
     customize: (customization: ContextMenuCustomization) => void;
 };
+/**
+ * Reference to manage control bar functionality in the component.
+ */
 export type ControlBarRef = {
     /**
-    * Defines a callback function to dynamically customize the control bar.
-    * @param customization The configuration object specifying the customization options for the control bar.
-    */
+     * Defines a callback function to dynamically customize the control bar.
+     * @param customization The configuration object specifying the customization options for the control bar.
+     */
     customize: (customization: ControlBarCustomization) => void;
 };
+/**
+ * Reference to manage help message functionality in the component.
+ */
 export type HelpRef = {
     /**
      * Displays the help message.
      * @param value Boolean value to show or hide the help message.
+     * @returns void
      */
-    show(value: boolean): any;
+    show(value: boolean): void;
     /**
      * Returns the current state of the help message.
+     * @returns boolean indicating if help message is currently shown
      */
-    isShow(): any;
+    isShow(): boolean;
 };
 /**
  * Root-level API of the Vim component.
@@ -58,42 +69,45 @@ export type VimComponentRef = {
     /**
      * HTML structure containing the component.
      */
-    container: VimComponentContainer;
+    container: Container;
     /**
-    * Vim WebGL viewer around which the WebGL component is built.
-    */
+     * Vim WebGL viewer around which the WebGL component is built.
+     */
     viewer: VIM.Viewer;
     /**
-    * Vim WebGL loader to download VIMs.
-    */
+     * Vim WebGL loader to download VIMs.
+     */
     loader: ComponentLoader;
     /**
-    * Isolation API managing isolation state in the component.
-    */
+     * Isolation API managing isolation state in the component.
+     */
     isolation: Isolation;
     /**
-    * Context menu API managing the content and behavior of the context menu.
-    */
+     * Context menu API managing the content and behavior of the context menu.
+     */
     contextMenu: ContextMenuRef;
     /**
-  * Context menu API managing the content and behavior of the context menu.
-  */
+     * Control bar API managing the content and behavior of the control bar.
+     */
     controlBar: ControlBarRef;
     /**
-    * Settings API managing settings applied to the component.
-    */
+     * Settings API managing settings applied to the component.
+     */
     settings: SettingsRef;
     /**
-    * Message API to interact with the loading box.
-    */
+     * Message API to interact with the loading box.
+     */
     modal: ModalRef;
     /**
-    * Camera API to interact with the viewer camera at a higher level.
-    */
+     * Camera API to interact with the viewer camera at a higher level.
+     */
     camera: ComponentCamera;
     /**
      * API To interact with the BIM info panel.
      */
     bimInfo: BimInfoPanelRef;
+    /**
+     * Cleans up and releases resources used by the component.
+     */
     dispose: () => void;
 };