vim-web 0.3.44-dev.70 → 0.3.44-dev.72

package/dist/types/react-viewers/generic/genericField.d.ts

@@ -0,0 +1,26 @@
+import React from "react";
+import { StateRef } from "../helpers/reactUtils";
+interface BaseGenericEntry {
+    id: string;
+    label: string;
+}
+export interface GenericTextEntry extends BaseGenericEntry {
+    type: "text";
+    state: StateRef<string>;
+}
+export interface GenericNumberEntry extends BaseGenericEntry {
+    type: "number";
+    state: StateRef<number>;
+}
+export interface GenericBoolEntry extends BaseGenericEntry {
+    type: "bool";
+    state: StateRef<boolean>;
+}
+export type GenericEntryType = GenericTextEntry | GenericBoolEntry | GenericNumberEntry;
+/**
+ * Renders a panel field based on its type.
+ * @param field - The panel field to render.
+ * @returns The rendered field element.
+ */
+export declare function GenericEntry(field: GenericEntryType): React.ReactNode;
+export {};

package/dist/types/react-viewers/generic/genericPanel.d.ts

@@ -0,0 +1,12 @@
+import { StateRef } from "../helpers/reactUtils";
+import { GenericEntryType } from "./genericField";
+import { Customizer } from "../helpers/customizer";
+export interface GenericPanelProps {
+    showPanel: StateRef<boolean>;
+    header?: React.ReactNode;
+    entries: GenericEntryType[];
+    onClose?: () => void;
+    anchorElement: HTMLElement | null;
+}
+export type GenericPanelHandle = Customizer<GenericEntryType[]>;
+export declare const GenericPanel: import("react").ForwardRefExoticComponent<GenericPanelProps & import("react").RefAttributes<GenericPanelHandle>>;

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

@@ -0,0 +1,2 @@
+export type * from './genericField';
+export { type GenericPanelHandle } from './genericPanel';

package/dist/types/react-viewers/helpers/customizer.d.ts

@@ -0,0 +1,4 @@
+export interface Customizer<TData> {
+    customize(fn: (entries: TData) => TData): any;
+}
+export declare function useCustomizer<TData>(baseEntries: TData, ref: React.Ref<Customizer<TData>>): TData;

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

@@ -1,10 +1,7 @@
-export * from './cameraObserver';
-export * from './cursor';
-export * from './data';
+export * as ReactUtils from './reactUtils';
 export * from './deferredPromise';
-export * from './element';
-export * from './fullScreenObserver';
-export * from './loadRequest';
-export * from './reactUtils';
-export * from './requestResult';
-export * from './utils';
+export type * from './cursor';
+export type * from './data';
+export type * from './element';
+export type * from './loadRequest';
+export type * from './requestResult';

package/dist/types/react-viewers/helpers/layout.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Computes a position for a floating element relative to a target, with smart fallback
+ * if it overflows the top or sides of the screen.
+ *
+ * @param originRect - The bounding rect of the origin element.
+ * @param panelRect - The bounding rect of the panel to position.
+ * @returns The top-left position for the panel.
+ */
+export declare function computeFloatingPosition(originRect: DOMRect, panelRect: DOMRect): {
+    top: number;
+    left: number;
+};
+/**
+ * Tracks and computes the screen position of a floating panel relative to a given anchor element.
+ *
+ * @param panelRef - Ref to the panel element to position
+ * @param anchorElement - The element the panel should be positioned relative to
+ * @param enabled - Whether the positioning logic is active
+ * @returns The top-left screen position for the panel
+ */
+export declare function useFloatingPanelPosition(panelRef: React.RefObject<HTMLElement>, anchorElement: HTMLElement | null, enabled: boolean): {
+    top: number;
+    left: number;
+};

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

@@ -9,5 +9,6 @@ export * as Errors from './errors';
 export * as Urls from './urls';
 export * from './container';
 export * from './panels';
-export type * from './helpers';
+export * from './helpers';
+export * from './generic';
 export type * from './state';

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

@@ -4,7 +4,7 @@
 import React from 'react';
 import { CameraRef } from '../state/cameraState';
 import { TreeActionRef } from '../bim/bimTree';
-import { ModalRef } from './modal';
+import { ModalHandle } from './modal';
 import { IsolationRef } from '../state/sharedIsolation';
 import * as Core from '../../core-viewers';
 type ClickCallback = React.MouseEvent<HTMLDivElement, MouseEvent>;
@@ -76,7 +76,7 @@ export declare const VimContextMenuMemo: React.MemoExoticComponent<typeof Contex
 export declare function ContextMenu(props: {
     viewer: Core.Webgl.Viewer;
     camera: CameraRef;
-    modal: ModalRef;
+    modal: ModalHandle;
     isolation: IsolationRef;
     selection: Core.Webgl.Element3D[];
     customization?: (e: ContextMenuElement[]) => ContextMenuElement[];

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

@@ -1,6 +1,5 @@
 export * as ContextMenu from './contextMenu';
 export type * from './axesPanel';
-export type * from './genericPanel';
 export type * from './help';
 export type * from './loadingBox';
 export type * from './logo';
@@ -8,7 +7,7 @@ export type * from './messageBox';
 export type * from './modal';
 export type * from './overlay';
 export type * from './performance';
-export type * from './renderSettingsPanel';
+export type * from './isolationPanel';
 export type * from './restOfScreen';
 export type * from './sectionBoxPanel';
 export type * from './toast';

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

@@ -0,0 +1,5 @@
+import { IsolationRef } from "../state/sharedIsolation";
+import { GenericPanelHandle } from "../generic/genericPanel";
+export declare const IsolationPanel: import("react").ForwardRefExoticComponent<{
+    state: IsolationRef;
+} & import("react").RefAttributes<GenericPanelHandle>>;

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

@@ -7,7 +7,7 @@ export type ModalPropsTyped = (MessageBoxPropsTyped | LoadingBoxPropsTyped | Hel
     canClose?: boolean;
     onClose?: () => void;
 };
-export type ModalRef = {
+export type ModalHandle = {
     getActiveState(): ModalPropsTyped | undefined;
     loading(content: LoadingBoxProps | undefined): void;
     message(content: MessageBoxProps | undefined): void;
@@ -15,4 +15,4 @@ export type ModalRef = {
 };
 export declare const Modal: React.ForwardRefExoticComponent<{
     canFollowLinks: boolean;
-} & React.RefAttributes<ModalRef>>;
+} & React.RefAttributes<ModalHandle>>;

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

@@ -1,4 +1,5 @@
 import { SectionBoxRef } from "../state/sectionBoxState";
-export declare function SectionBoxPanel(props: {
+import { GenericPanelHandle } from "../generic/genericPanel";
+export declare const SectionBoxPanel: import("react").ForwardRefExoticComponent<{
     state: SectionBoxRef;
-}): import("react/jsx-runtime").JSX.Element;
+} & import("react").RefAttributes<GenericPanelHandle>>;

package/dist/types/react-viewers/state/controlBarState.d.ts

@@ -6,7 +6,7 @@ import { SideState } from './sideState';
 import * as Icons from '../icons';
 import { SectionBoxRef } from './sectionBoxState';
 import { getMeasureState } from './measureState';
-import { ModalRef } from '../panels/modal';
+import { ModalHandle } from '../panels/modal';
 import { IsolationRef } from './sharedIsolation';
 import * as ControlBar from '../controlbar';
 /**
@@ -32,7 +32,7 @@ export declare function controlBarSelection(isolation: IsolationRef): ControlBar
 /**
  * Combines all control bar sections into one control bar.
  */
-export declare function useControlBar(viewer: Core.Webgl.Viewer, camera: CameraRef, modal: ModalRef, side: SideState, cursor: CursorManager, settings: Settings, section: SectionBoxRef, isolationRef: IsolationRef, customization: ControlBar.ControlBarCustomization | undefined): (ControlBar.IControlBarSection | {
+export declare function useControlBar(viewer: Core.Webgl.Viewer, camera: CameraRef, modal: ModalHandle, side: SideState, cursor: CursorManager, settings: Settings, section: SectionBoxRef, isolationRef: IsolationRef, customization: ControlBar.ControlBarCustomization | undefined): (ControlBar.IControlBarSection | {
     id: string;
     enable: () => boolean;
     style: string;

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

@@ -1,5 +1,5 @@
-import { ModalRef } from "../panels/modal";
+import { ModalHandle } from "../panels/modal";
 import * as Core from '../../core-viewers';
 import { RefObject } from "react";
-export declare function updateModal(modal: RefObject<ModalRef>, state: Core.Ultra.ClientState): void;
-export declare function updateProgress(request: Core.Ultra.ILoadRequest, modal: ModalRef): Promise<void>;
+export declare function updateModal(modal: RefObject<ModalHandle>, state: Core.Ultra.ClientState): void;
+export declare function updateProgress(request: Core.Ultra.ILoadRequest, modal: ModalHandle): Promise<void>;

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

@@ -1,9 +1,10 @@
 import * as Core from '../../core-viewers/ultra';
-import { ModalRef } from '../panels/modal';
+import { ModalHandle } from '../panels/modal';
 import { CameraRef } from '../state/cameraState';
 import { SectionBoxRef } from '../state/sectionBoxState';
 import { IsolationRef } from '../state/sharedIsolation';
 import { ControlBarRef } from '../controlbar';
+import { GenericPanelHandle } from '../generic/';
 export type ViewerRef = {
     /**
      * The Vim viewer instance associated with the viewer.
@@ -12,7 +13,7 @@ export type ViewerRef = {
     /**
      * API to manage the modal dialog.
      */
-    modal: ModalRef;
+    modal: ModalHandle;
     /**
      * API to manage the section box.
      */
@@ -26,6 +27,14 @@ export type ViewerRef = {
      */
     camera: CameraRef;
     isolation: IsolationRef;
+    /**
+     * API to interact with the isolation panel.
+     */
+    isolationPanel: GenericPanelHandle;
+    /**
+     * API to interact with the isolation panel.
+     */
+    sectionBoxPanel: GenericPanelHandle;
     /**
      * Disposes of the viewer and its resources.
      */

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

@@ -3,7 +3,7 @@
  */
 import * as Core from '../../core-viewers';
 import { LoadRequest } from '../helpers/loadRequest';
-import { ModalRef } from '../panels/modal';
+import { ModalHandle } from '../panels/modal';
 type AddSettings = {
     /**
      * Controls whether to frame the camera on a vim everytime it is updated.
@@ -28,7 +28,7 @@ export type LoadingError = {
 export declare class ComponentLoader {
     private _viewer;
     private _modal;
-    constructor(viewer: Core.Webgl.Viewer, modal: React.RefObject<ModalRef>);
+    constructor(viewer: Core.Webgl.Viewer, modal: React.RefObject<ModalHandle>);
     /**
      * Event emitter for progress updates.
      */

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

@@ -9,9 +9,10 @@ import { Container } from '../container';
 import { BimInfoPanelRef } from '../bim/bimInfoData';
 import { ControlBarRef } from '../controlbar';
 import { ComponentLoader } from './loading';
-import { ModalRef } from '../panels/modal';
+import { ModalHandle } from '../panels/modal';
 import { SectionBoxRef } from '../state/sectionBoxState';
 import { IsolationRef } from '../state/sharedIsolation';
+import { GenericPanelHandle } from '../generic';
 /**
 * Settings API managing settings applied to the viewer.
 */
@@ -82,7 +83,7 @@ export type ViewerRef = {
     /**
      * Message API to interact with the loading box.
      */
-    modal: ModalRef;
+    modal: ModalHandle;
     /**
      * Camera API to interact with the viewer camera at a higher level.
      */
@@ -91,6 +92,14 @@ export type ViewerRef = {
      * API To interact with the BIM info panel.
      */
     bimInfo: BimInfoPanelRef;
+    /**
+     * API to interact with the isolation panel.
+     */
+    isolationPanel: GenericPanelHandle;
+    /**
+     * API to interact with the isolation panel.
+     */
+    sectionBoxPanel: GenericPanelHandle;
     /**
      * Cleans up and releases resources used by the viewer.
      */

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

@@ -3,7 +3,7 @@
  */
 import * as Core from '../../core-viewers';
 import { AugmentedElement } from '../helpers/element';
-import { StateRef } from '../helpers';
+import { StateRef } from '../helpers/reactUtils';
 export type ViewerState = {
     vim: StateRef<Core.Webgl.Vim>;
     selection: StateRef<Core.Webgl.Element3D[]>;