vim-web 0.3.44-dev.47 → 0.3.44-dev.51

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

@@ -0,0 +1,36 @@
+import { RefObject } from "react";
+import { StateRef } from "../helpers/reactUtils";
+import { ISignal } from "ste-signals";
+export type VisibilityStatus = 'all' | 'allButSelection' | 'onlySelection' | 'some' | 'none';
+export interface IsolationRef {
+    adapter: RefObject<IsolationAdapter>;
+    visibility: StateRef<VisibilityStatus>;
+    autoIsolate: StateRef<boolean>;
+    showPanel: StateRef<boolean>;
+    showGhost: StateRef<boolean>;
+    ghostOpacity: StateRef<string>;
+    showRooms: StateRef<boolean>;
+}
+export interface IsolationAdapter {
+    onSelectionChanged: ISignal;
+    onVisibilityChange: ISignal;
+    computeVisibility: () => VisibilityStatus;
+    hasSelection(): boolean;
+    hasVisibleSelection: () => boolean;
+    hasHiddenSelection: () => boolean;
+    clearSelection(): void;
+    isolateSelection(): void;
+    hideSelection(): void;
+    showSelection(): void;
+    isolate(instances: number[]): void;
+    show(instances: number[]): void;
+    hide(instances: number[]): void;
+    hideAll(): void;
+    showAll(): void;
+    showGhost(show: boolean): void;
+    getGhostOpacity(): number;
+    setGhostOpacity(opacity: number): void;
+    getShowRooms(): boolean;
+    setShowRooms(show: boolean): void;
+}
+export declare function useSharedIsolation(adapter: IsolationAdapter): IsolationRef;

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

@@ -1,3 +1,3 @@
-import { CoreInputHandler } from "../../core-viewers/webgl";
+import { InputHandler } from "../../core-viewers/shared";
 import { CameraRef } from "./cameraState";
-export declare function useViewerInput(handler: CoreInputHandler, camera: CameraRef): void;
+export declare function useViewerInput(handler: InputHandler, camera: CameraRef): void;

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

@@ -0,0 +1,3 @@
+import * as Core from "../../core-viewers/ultra";
+import { SectionBoxRef } from "../state/sectionBoxState";
+export declare function useUltraCamera(viewer: Core.Viewer, section: SectionBoxRef): import("../state/cameraState").CameraRef;

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

@@ -0,0 +1,6 @@
+import * as Core from '../../core-viewers/ultra';
+import { ControlBarCustomization } from '../controlbar/controlBar';
+import { CameraRef } from '../state/cameraState';
+import { SectionBoxRef } from '../state/sectionBoxState';
+import { IsolationRef } from '../state/sharedIsolation';
+export declare function useUltraControlBar(viewer: Core.Viewer, section: SectionBoxRef, isolation: IsolationRef, camera: CameraRef, customization: ControlBarCustomization | undefined): import("../controlbar").IControlBarSection[];

package/dist/types/react-viewers/ultra/errors/ultraErrors.d.ts

@@ -1,3 +1,3 @@
-import * as Ultra from '../../../core-viewers/ultra';
-export declare function getErrorMessage(state: Ultra.ClientState): import("../..").MessageBoxProps;
-export declare function getRequestErrorMessage(serverUrl: string, source: Ultra.VimSource, error: Ultra.VimRequestErrorType): import("../..").MessageBoxProps;
+import * as Core from '../../../core-viewers';
+export declare function getErrorMessage(state: Core.Ultra.ClientState): import("../..").MessageBoxProps;
+export declare function getRequestErrorMessage(serverUrl: string, source: Core.Ultra.VimSource, error: Core.Ultra.VimRequestErrorType): import("../..").MessageBoxProps;

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

@@ -1,2 +1,2 @@
-export * from './ultraComponent';
-export * from './ultraComponentRef';
+export * from './viewer';
+export * from './viewerRef';

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

@@ -0,0 +1,3 @@
+import * as Core from "../../core-viewers";
+import Viewer = Core.Ultra.Viewer;
+export declare function useUltraIsolation(viewer: Viewer): import("../state/sharedIsolation").IsolationRef;

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

@@ -0,0 +1,5 @@
+import { ModalRef } 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>;

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

@@ -0,0 +1,3 @@
+import * as Core from '../../core-viewers';
+import { SectionBoxRef } from '../state/sectionBoxState';
+export declare function useUltraSectionBox(viewer: Core.Ultra.Viewer): SectionBoxRef;

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

@@ -0,0 +1,21 @@
+import * as Core from '../../core-viewers';
+import { Container } from '../container';
+import { ViewerRef } from './viewerRef';
+/**
+ * Creates a UI container along with a VIM.Viewer and its associated React viewer.
+ * @param container An optional container object. If none is provided, a container will be created.
+ * @returns An object containing the resulting container, reactRoot, and viewer.
+ */
+export declare function createViewer(container?: Container | HTMLElement): Promise<ViewerRef>;
+/**
+ * Represents a React viewer providing UI for the Vim viewer.
+ * @param container The container object containing root, gfx, and UI elements for the Vim viewer.
+ * @param viewer The Vim viewer instance for which UI is provided.
+ * @param onMount A callback function triggered when the viewer is mounted. Receives a reference to the Vim viewer.
+ * @param settings Optional settings for configuring the Vim viewer's behavior.
+ */
+export declare function Viewer(props: {
+    container: Container;
+    viewer: Core.Ultra.Viewer;
+    onMount: (viewer: ViewerRef) => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/types/react-viewers/ultra/{ultraComponentRef.d.ts → viewerRef.d.ts}

@@ -1,13 +1,14 @@
-import * as Ultra from '../../core-viewers/ultra';
+import * as Core from '../../core-viewers/ultra';
 import { ModalRef } from '../panels/modal';
 import { CameraRef } from '../state/cameraState';
 import { SectionBoxRef } from '../state/sectionBoxState';
-import { ControlBarRef } from '../webgl/webglComponentRef';
-export type UltraComponentRef = {
+import { IsolationRef } from '../state/sharedIsolation';
+import { ControlBarRef } from '../webgl/viewerRef';
+export type ViewerRef = {
     /**
-     * The Vim viewer instance associated with the component.
+     * The Vim viewer instance associated with the viewer.
      */
-    viewer: Ultra.UltraCoreViewer;
+    viewer: Core.Viewer;
     /**
      * API to manage the modal dialog.
      */
@@ -24,13 +25,14 @@ export type UltraComponentRef = {
      * Camera API to interact with the viewer camera at a higher level.
      */
     camera: CameraRef;
+    isolation: IsolationRef;
     /**
-     * Disposes of the component and its resources.
+     * Disposes of the viewer and its resources.
      */
     dispose: () => void;
     /**
      * Loads a file into the viewer.
      * @param url The URL of the file to load.
      */
-    load(url: Ultra.VimSource): Ultra.ILoadRequest;
+    load(url: Core.VimSource): Core.ILoadRequest;
 };

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

@@ -0,0 +1,3 @@
+import * as Core from "../../core-viewers";
+import { SectionBoxRef } from "../state/sectionBoxState";
+export declare function useWebglCamera(viewer: Core.Webgl.Viewer, section: SectionBoxRef): import("../state/cameraState").CameraRef;

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

@@ -1,8 +1,3 @@
-export * from './webglComponent';
-export * as ContextMenu from '../panels/contextMenu';
-export * as BimInfo from '../bim/bimInfoData';
-export * as ControlBar from '../controlbar/controlBar';
-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 './viewer';
+export * from './viewerRef';
+export type * from './loading';

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

@@ -0,0 +1,8 @@
+/**
+ * @module viw-webgl-react
+ */
+import * as Core from '../../core-viewers';
+import { SideState } from '../state/sideState';
+import { CameraRef } from '../state/cameraState';
+import { IsolationRef } from '../state/sharedIsolation';
+export declare function applyWebglBindings(viewer: Core.Webgl.Viewer, camera: CameraRef, isolation: IsolationRef, sideState: SideState): void;

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

@@ -0,0 +1,2 @@
+import * as Core from "../../core-viewers";
+export declare function useWebglIsolation(viewer: Core.Webgl.Viewer): import("../state/sharedIsolation").IsolationRef;

package/dist/types/react-viewers/webgl/{webglLoading.d.ts → loading.d.ts}

@@ -1,7 +1,7 @@
 /**
  * @module viw-webgl-react
  */
-import * as VIM from '../../core-viewers/webgl/index';
+import * as Core from '../../core-viewers';
 import { LoadRequest } from '../helpers/loadRequest';
 import { ModalRef } from '../panels/modal';
 type AddSettings = {
@@ -16,7 +16,7 @@ type AddSettings = {
      */
     loadEmpty?: boolean;
 };
-export type OpenSettings = VIM.VimPartialSettings & AddSettings;
+export type OpenSettings = Core.Webgl.VimPartialSettings & AddSettings;
 export type LoadingError = {
     url: string;
     error: string;
@@ -28,11 +28,11 @@ export type LoadingError = {
 export declare class ComponentLoader {
     private _viewer;
     private _modal;
-    constructor(viewer: VIM.Viewer, modal: ModalRef);
+    constructor(viewer: Core.Webgl.Viewer, modal: React.RefObject<ModalRef>);
     /**
      * Event emitter for progress updates.
      */
-    onProgress(p: VIM.IProgressLogs): void;
+    onProgress(p: Core.Webgl.IProgressLogs): void;
     /**
        * Event emitter for completion notifications.
      */
@@ -48,20 +48,20 @@ export declare class ComponentLoader {
      * @param onProgress Optional callback function to track progress during opening.
      * Receives progress logs as input.
      */
-    open(source: VIM.RequestSource, settings: OpenSettings, onProgress?: (p: VIM.IProgressLogs) => void): Promise<VIM.Vim>;
+    open(source: Core.Webgl.RequestSource, settings: OpenSettings, onProgress?: (p: Core.Webgl.IProgressLogs) => void): Promise<Core.Webgl.Vim>;
     /**
      * Creates a new load request for the provided source and settings.
      * @param source The url to the vim file or a buffer of the file.
      * @param settings Settings to apply to vim file.
      * @returns A new load request instance to track progress and get result.
      */
-    request(source: VIM.RequestSource, settings?: VIM.VimPartialSettings): LoadRequest;
-    add(vim: VIM.Vim, settings?: AddSettings): void;
+    request(source: Core.Webgl.RequestSource, settings?: Core.Webgl.VimPartialSettings): LoadRequest;
+    add(vim: Core.Webgl.Vim, settings?: AddSettings): void;
     /**
      * Removes the vim from the viewer and disposes it.
      * @param vim Vim to remove from the viewer.
      */
-    remove(vim: VIM.Vim): void;
+    remove(vim: Core.Webgl.Vim): void;
     private initVim;
 }
 export {};

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

@@ -0,0 +1,3 @@
+import * as Core from '../../core-viewers';
+import { SectionBoxRef } from '../state/sectionBoxState';
+export declare function useWebglSectionBox(viewer: Core.Webgl.Viewer): SectionBoxRef;

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

@@ -0,0 +1,28 @@
+/**
+ * @module public-api
+ */
+import * as Core from '../../core-viewers';
+import { PartialSettings } from '../settings';
+import { Container } from '../container';
+import { ViewerRef } from './viewerRef';
+/**
+ * Creates a UI container along with a VIM.Viewer and its associated React viewer.
+ * @param container An optional container object. If none is provided, a container will be created.
+ * @param settings UI Component settings.
+*  @param coreSettings Viewer settings.
+ * @returns An object containing the resulting container, reactRoot, and viewer.
+ */
+export declare function createViewer(container?: Container | HTMLElement, settings?: PartialSettings, coreSettings?: Core.Webgl.PartialViewerSettings): Promise<ViewerRef>;
+/**
+ * Represents a React viewer providing UI for the Vim viewer.
+ * @param container The container object containing root, gfx, and UI elements for the Vim viewer.
+ * @param viewer The Vim viewer instance for which UI is provided.
+ * @param onMount A callback function triggered when the viewer is mounted. Receives a reference to the Vim viewer.
+ * @param settings Optional settings for configuring the Vim viewer's behavior.
+ */
+export declare function Viewer(props: {
+    container: Container;
+    viewer: Core.Webgl.Viewer;
+    onMount: (viewer: ViewerRef) => void;
+    settings?: PartialSettings;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/types/react-viewers/webgl/{webglComponentRef.d.ts → viewerRef.d.ts}

@@ -1,34 +1,34 @@
 /**
  * @module public-api
  */
-import * as VIM from '../../core-viewers/webgl/index';
+import * as Core from '../../core-viewers';
 import { ContextMenuCustomization } from '../panels/contextMenu';
-import { ComponentSettings } from '../settings/settings';
-import { Isolation } from '../helpers/isolation';
+import { Settings } from '../settings/settings';
 import { CameraRef } from '../state/cameraState';
 import { Container } from '../container';
 import { BimInfoPanelRef } from '../bim/bimInfoData';
 import { ControlBarCustomization } from '../controlbar/controlBar';
-import { ComponentLoader } from './webglLoading';
+import { ComponentLoader } from './loading';
 import { ModalRef } from '../panels/modal';
 import { SectionBoxRef } from '../state/sectionBoxState';
+import { IsolationRef } from '../state/sharedIsolation';
 /**
-* Settings API managing settings applied to the component.
+* Settings API managing settings applied to the viewer.
 */
 export type SettingsRef = {
     /**
      * Allows updating settings by providing a callback function.
      * @param updater A function that updates the current settings.
      */
-    update: (updater: (settings: ComponentSettings) => void) => void;
+    update: (updater: (settings: Settings) => void) => void;
     /**
      * Registers a callback function to be notified when settings are updated.
      * @param callback A function to be called when settings are updated, receiving the updated settings.
      */
-    register: (callback: (settings: ComponentSettings) => void) => void;
+    register: (callback: (settings: Settings) => void) => void;
 };
 /**
- * Reference to manage context menu functionality in the component.
+ * Reference to manage context menu functionality in the viewer.
  */
 export type ContextMenuRef = {
     /**
@@ -38,7 +38,7 @@ export type ContextMenuRef = {
     customize: (customization: ContextMenuCustomization) => void;
 };
 /**
- * Reference to manage control bar functionality in the component.
+ * Reference to manage control bar functionality in the viewer.
  */
 export type ControlBarRef = {
     /**
@@ -48,7 +48,7 @@ export type ControlBarRef = {
     customize: (customization: ControlBarCustomization) => void;
 };
 /**
- * Reference to manage help message functionality in the component.
+ * Reference to manage help message functionality in the viewer.
  */
 export type HelpRef = {
     /**
@@ -64,27 +64,27 @@ export type HelpRef = {
     isShow(): boolean;
 };
 /**
- * Root-level API of the Vim component.
+ * Root-level API of the Vim viewer.
  */
-export type VimComponentRef = {
+export type ViewerRef = {
     /**
-     * HTML structure containing the component.
+     * HTML structure containing the viewer.
      */
     container: Container;
     /**
-     * Vim WebGL viewer around which the WebGL component is built.
+     * Vim WebGL viewer around which the WebGL viewer is built.
      */
-    viewer: VIM.Viewer;
+    core: Core.Webgl.Viewer;
     /**
      * Vim WebGL loader to download VIMs.
      */
     loader: ComponentLoader;
     /**
-     * Isolation API managing isolation state in the component.
+     * Isolation API managing isolation state in the viewer.
      */
-    isolation: Isolation;
+    isolation: IsolationRef;
     /**
-     * Section box API managing the section box in the component.
+     * Section box API managing the section box in the viewer.
      */
     sectionBox: SectionBoxRef;
     /**
@@ -96,7 +96,7 @@ export type VimComponentRef = {
      */
     controlBar: ControlBarRef;
     /**
-     * Settings API managing settings applied to the component.
+     * Settings API managing settings applied to the viewer.
      */
     settings: SettingsRef;
     /**
@@ -112,7 +112,7 @@ export type VimComponentRef = {
      */
     bimInfo: BimInfoPanelRef;
     /**
-     * Cleans up and releases resources used by the component.
+     * Cleans up and releases resources used by the viewer.
      */
     dispose: () => void;
 };

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

@@ -1,11 +1,13 @@
 /**
  * @module viw-webgl-react
  */
-import * as VIM from '../../core-viewers/webgl/index';
+import * as Core from '../../core-viewers';
 import { AugmentedElement } from '../helpers/element';
+import { StateRef } from '../helpers';
 export type ViewerState = {
-    vim: VIM.Vim;
-    selection: VIM.Object3D[];
-    elements: AugmentedElement[];
+    vim: StateRef<Core.Webgl.Vim>;
+    selection: StateRef<Core.Webgl.Element3D[]>;
+    elements: StateRef<AugmentedElement[]>;
+    filter: StateRef<string>;
 };
-export declare function useViewerState(viewer: VIM.Viewer): ViewerState;
+export declare function useViewerState(viewer: Core.Webgl.Viewer): ViewerState;

package/dist/types/utils/index.d.ts

@@ -0,0 +1,11 @@
+export * from './array';
+export * from './debounce';
+export * from './interfaces';
+export * from './math3d';
+export * from './partial';
+export * from './promise';
+export * from './result';
+export * from './strings';
+export * from './threeUtils';
+export * from './url';
+export * from './validation';

package/dist/types/utils/interfaces.d.ts

@@ -0,0 +1,3 @@
+export interface ForEachable<T> {
+    forEach(callback: (value: T) => void): void;
+}

package/dist/types/utils/math3d.d.ts

@@ -0,0 +1,19 @@
+export { Matrix4 as Matrix44, } from 'three';
+export { Vector2, Vector3, Box3 } from 'three';
+import { Vector2 } from 'three';
+/**
+ * Checks if two Vector2 objects are approximately equal.
+ * @param v1 - First Vector2.
+ * @param v2 - Second Vector2.
+ * @param epsilon - Tolerance for floating-point comparisons.
+ * @returns True if vectors are almost equal, false otherwise.
+ */
+export declare function almostEqual(v1: Vector2, v2: Vector2, epsilon?: number): boolean;
+/**
+ * Remaps the given value from the range [0-1] to [0-max].
+ */
+export declare function remap(value: number, max: number): number;
+/**
+ * Clamps the given value between the given min and max.
+ */
+export declare function clamp(value: number, min: number, max: number): number;

package/dist/types/utils/partial.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Makes all field optional recursively
+ * https://stackoverflow.com/questions/41980195/recursive-partialt-in-typescript
+ */
+export type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object ? RecursivePartial<T[P]> : T[P];
+};

package/dist/types/{core-viewers/utils/requestResult.d.ts → utils/result.d.ts}

@@ -10,4 +10,4 @@ export declare class ErrorResult {
     isSuccess(): false;
     isError(): this is ErrorResult;
 }
-export type RequestResult<T> = SuccessResult<T> | ErrorResult;
+export type Result<T> = SuccessResult<T> | ErrorResult;

package/dist/types/utils/strings.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * @param value
+ * @param strict
+ * @returns
+ */
+export declare function sanitize(value: string, strict: boolean, fallback: number): string;

package/dist/types/{core-viewers/ultra/viewer → utils}/validation.d.ts

@@ -1,4 +1,5 @@
-import { Box3, RGB, RGBA, Segment, Vector2, Vector3 } from '../../utils/math3d';
+import * as THREE from 'three';
+import * as Core from '../core-viewers';
 export declare class Validation {
     static isNumber(value: number): boolean;
     static isPositiveNumber(value: number): boolean;
@@ -9,13 +10,13 @@ export declare class Validation {
     static isComponentHandle(handle: number): boolean;
     static areComponentHandles(handles: number[]): boolean;
     static isMaterialHandle(handle: number): boolean;
-    static isValidVector2(value: Vector2): boolean;
-    static isRelativeVector2(value: Vector2): boolean;
-    static isValidVector3(value: Vector3): boolean;
-    static isValidBox(box: Box3): boolean;
-    static isValidSegment(segment: Segment): boolean;
-    static isRelativeRGBA(color: RGBA): boolean;
-    static isRelativeRGB(color: RGB): boolean;
+    static isValidVector2(value: THREE.Vector2): boolean;
+    static isRelativeVector2(value: THREE.Vector2): boolean;
+    static isValidVector3(value: THREE.Vector3): boolean;
+    static isValidBox(box: THREE.Box3): boolean;
+    static isValidSegment(segment: Core.Ultra.Segment): boolean;
+    static isRelativeRGBA(color: Core.Ultra.RGBA): boolean;
+    static isRelativeRGB(color: Core.Ultra.RGB): boolean;
     static isNonEmptyString(value: string): boolean;
     static isURL(value: string): boolean;
     static areSameLength<T1, T2>(array: T1[], array2: T2[]): boolean;
@@ -23,6 +24,6 @@ export declare class Validation {
     static clamp(min: number, max: number, value: number): number;
     static clamp01(value: number): number;
     static min0(value: number): number;
-    static clampRGBA01(value: RGBA): RGBA;
-    static clampRGB01(value: RGBA): RGBA;
+    static clampRGBA01(value: Core.Ultra.RGBA): Core.Ultra.RGBA;
+    static clampRGB01(value: Core.Ultra.RGBA): Core.Ultra.RGBA;
 }