vim-web 0.6.0-dev.3 → 0.6.0-dev.5

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "vim-web",
-  "version": "0.6.0-dev.3", 
+  "version": "0.6.0-dev.5",
   "description": "A demonstration app built on top of the vim-webgl-viewer",
   "type": "module",
   "files": [
-    "dist"
+    "dist",
+    "!dist/types"
   ],
   "readme": "README.md",
   "main": "./dist/vim-web.iife.js",
-  "types": "./dist/types/index.d.ts",
+  "types": "./dist/vim-web.d.ts",
   "module": "./dist/vim-web.js",
   "homepage": "https://github.com/vimaec/vim-web.git",
   "bugs": {
@@ -25,7 +26,9 @@
     "eslint": "eslint --ext .js,.ts,.tsx src --fix",
     "documentation": "typedoc --entryPoints src/vim-web/index.ts --entryPointStrategy expand --out docs2 --excludeProtected --excludeExternals --excludePrivate",
     "declarations": "tsc -p tsconfig.types.json",
-    "build": "vite build && npm run declarations",
+    "bundle-dts": "rollup -c rollup.dts.config.mjs",
+    "bundle-bim-dts": "rollup -c rollup.bim-dts.config.mjs",
+    "build": "vite build && npm run declarations && npm run bundle-dts && npm run bundle-bim-dts",
     "publish:package": "npm run build && npm publish",
     "publish:documentation": "npm run documentation && gh-pages -d docs2",
     "publish:both": "npm run publish:package && npm run publish:documentation"
@@ -36,6 +39,7 @@
     "@types/react-dom": "^18.3.1",
     "@typescript-eslint/eslint-plugin": "^8.17.0",
     "@typescript-eslint/parser": "^8.17.0",
+    "@vitejs/plugin-react": "^4.3.4",
     "autoprefixer": "^10.4.20",
     "eslint": "^8.23.1",
     "eslint-config-prettier": "^8.5.0",
@@ -43,22 +47,21 @@
     "eslint-plugin-promise": "^6.0.1",
     "eslint-plugin-react": "^7.37.2",
     "eslint-plugin-react-hooks": "^5.0.0",
-    "fs-extra": "^11.2.0",
+    "gh-pages": "^6.3.0",
     "postcss": "^8.4.49",
     "prettier": "^3.4.2",
     "prettier-plugin-tailwindcss": "^0.6.9",
-    "react-router-dom": "^7.0.2",
+    "rollup": "^4.57.1",
+    "rollup-plugin-dts": "^6.3.0",
     "tailwindcss": "^3.4.16",
     "tailwindcss-scoped-preflight": "^3.4.9",
     "typedoc": "^0.27.3",
     "typescript": "^5.7.2",
-    "vite": "^6.0.2",
-    "gh-pages": "^6.3.0"
+    "vite": "^6.0.2"
   },
   "dependencies": {
     "@firefox-devtools/react-contextmenu": "^5.1.1",
     "@types/three": "0.170.0",
-    "@vitejs/plugin-react": "^4.3.4",
     "deepmerge": "^4.3.1",
     "is-plain-object": "^5.0.0",
     "re-resizable": "^6.9.9",

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

@@ -1,3 +0,0 @@
-export * as Webgl from './webgl';
-export * as Ultra from './ultra';
-export * from './shared';

package/dist/types/core-viewers/shared/baseInputHandler.d.ts

@@ -1,28 +0,0 @@
-/**
- * @module viw-webgl-viewer/inputs
- */
-/**
- * Base class for various input handlers.
- * It provides convenience to register to and unregister from events.
- */
-export declare class BaseInputHandler {
-    protected _canvas: HTMLCanvasElement;
-    protected _disconnect: Function[];
-    constructor(canvas: HTMLCanvasElement);
-    protected reg<T extends Event>(element: Document | HTMLElement | Window, eventType: string, callback: (event: T) => void): void;
-    /**
-     * Register handler to related browser events
-     * Prevents double registrations
-     */
-    register(): void;
-    protected addListeners(): void;
-    /**
-     * Unregister handler from related browser events
-     * Prevents double unregistration
-     */
-    unregister(): void;
-    /**
-     * Reset handler states such as button down, drag, etc.
-     */
-    reset(): void;
-}

package/dist/types/core-viewers/shared/index.d.ts

@@ -1,11 +0,0 @@
-export * from './inputHandler';
-export * from './loadResult';
-export { PointerMode } from './inputHandler';
-export type * from './baseInputHandler';
-export type * from './keyboardHandler';
-export type * from './mouseHandler';
-export type * from './raycaster';
-export type * from './selection';
-export type * from './touchHandler';
-export type * from './vim';
-export type * from './vimCollection';

package/dist/types/core-viewers/shared/inputAdapter.d.ts

@@ -1,22 +0,0 @@
-import * as THREE from 'three';
-export interface IInputAdapter {
-    init: () => void;
-    toggleOrthographic: () => void;
-    toggleCameraOrbitMode: () => void;
-    resetCamera: () => void;
-    clearSelection: () => void;
-    frameCamera: () => void;
-    moveCamera: (value: THREE.Vector3) => void;
-    orbitCamera: (value: THREE.Vector2) => void;
-    rotateCamera: (value: THREE.Vector2) => void;
-    panCamera: (value: THREE.Vector2) => void;
-    dollyCamera: (value: THREE.Vector2) => void;
-    keyDown: (keyCode: string) => boolean;
-    keyUp: (keyCode: string) => boolean;
-    mouseDown: (pos: THREE.Vector2, button: number) => void;
-    mouseUp: (pos: THREE.Vector2, button: number) => void;
-    mouseMove: (pos: THREE.Vector2) => void;
-    selectAtPointer: (pos: THREE.Vector2, add: boolean) => void;
-    frameAtPointer: (pos: THREE.Vector2) => void;
-    zoom: (value: number, pos?: THREE.Vector2) => void;
-}

package/dist/types/core-viewers/shared/inputHandler.d.ts

@@ -1,99 +0,0 @@
-import * as THREE from 'three';
-import { BaseInputHandler } from './baseInputHandler';
-import { KeyboardHandler } from './keyboardHandler';
-import { MouseHandler } from './mouseHandler';
-import { TouchHandler } from './touchHandler';
-import { IInputAdapter } from './inputAdapter';
-export declare enum PointerMode {
-    ORBIT = "orbit",
-    LOOK = "look",
-    PAN = "pan",
-    ZOOM = "zoom",
-    RECT = "rect"
-}
-interface InputSettings {
-    orbit: boolean;
-    scrollSpeed: number;
-    moveSpeed: number;
-    rotateSpeed: number;
-    orbitSpeed: number;
-}
-export declare class InputHandler extends BaseInputHandler {
-    /**
-     * Touch input handler
-     */
-    touch: TouchHandler;
-    /**
-     * Mouse input handler
-     */
-    mouse: MouseHandler;
-    /**
-     * Keyboard input handler
-     */
-    keyboard: KeyboardHandler;
-    scrollSpeed: number;
-    private _moveSpeed;
-    rotateSpeed: number;
-    orbitSpeed: number;
-    private _pointerActive;
-    private _pointerFallback;
-    private _pointerOverride;
-    private _onPointerOverrideChanged;
-    private _onPointerModeChanged;
-    private _onSettingsChanged;
-    private _adapter;
-    constructor(canvas: HTMLCanvasElement, adapter: IInputAdapter, settings?: Partial<InputSettings>);
-    getZoomValue(value: number): number;
-    init(): void;
-    get moveSpeed(): number;
-    set moveSpeed(value: number);
-    get onSettingsChanged(): import("ste-signals").ISignal;
-    /**
-     * Returns the last main mode (orbit, look) that was active.
-     */
-    get pointerFallback(): PointerMode;
-    /**
-     * Returns current pointer mode.
-     */
-    get pointerActive(): PointerMode;
-    /**
-     * A temporary pointer mode used for temporary icons.
-     */
-    get pointerOverride(): PointerMode;
-    set pointerOverride(value: PointerMode | undefined);
-    /**
-     * Changes pointer interaction mode. Look mode will set camera orbitMode to false.
-     */
-    set pointerActive(value: PointerMode);
-    /**
-     * Event called when pointer interaction mode changes.
-     */
-    get onPointerModeChanged(): import("ste-signals").ISignal;
-    /**
-     * Event called when the pointer is temporarily overriden.
-     */
-    get onPointerOverrideChanged(): import("ste-signals").ISignal;
-    private _onContextMenu;
-    /**
-     * Event called when when context menu could be displayed
-     */
-    get onContextMenu(): import("ste-simple-events").ISimpleEvent<THREE.Vector2>;
-    /**
-     * Calls context menu action
-     */
-    ContextMenu(position: THREE.Vector2 | undefined): void;
-    /**
-   * Register inputs handlers for default viewer behavior
-   */
-    registerAll(): void;
-    /**
-     * Unregisters all input handlers
-     */
-    unregisterAll: () => void;
-    /**
-     * Resets all input state
-     */
-    resetAll(): void;
-    dispose(): void;
-}
-export {};

package/dist/types/core-viewers/shared/keyboardHandler.d.ts

@@ -1,96 +0,0 @@
-/**
- * @module viw-webgl-viewer/inputs
- */
-import * as THREE from 'three';
-import { BaseInputHandler } from './baseInputHandler';
-type CallbackMode = 'replace' | 'append' | 'prepend';
-/**
- * KeyboardHandler
- *
- * A modern keyboard handler that manages keyboard events using a stateful pattern.
- * It supports separate handlers for key down, key up, and continuous key pressed events.
- * The handler calculates a movement vector based on currently pressed keys.
- */
-export declare class KeyboardHandler extends BaseInputHandler {
-    /**
-     * Callback invoked whenever the calculated movement vector is updated.
-     */
-    onMove: (value: THREE.Vector3) => void;
-    onKeyUp: (code: string) => boolean;
-    onKeyDown: (code: string) => boolean;
-    /**
-     * Speed multiplier applied when the Shift key is held.
-     * @private
-     */
-    private readonly SHIFT_MULTIPLIER;
-    /**
-     * Set of currently pressed key codes.
-     * @private
-     */
-    private pressedKeys;
-    /**
-     * Map of key down event handlers (invoked once on key down).
-     * @private
-     */
-    private keyDownHandlers;
-    /**
-     * Map of key up event handlers (invoked once on key up).
-     * @private
-     */
-    private keyUpHandlers;
-    /**
-     * Creates an instance of KeyboardHandler.
-     * @param canvas The HTMLCanvasElement to attach keyboard events to.
-     */
-    constructor(canvas: HTMLCanvasElement);
-    /**
-     * Registers the necessary keyboard event listeners.
-     * @protected
-     */
-    protected addListeners(): void;
-    private registerMovementHandlers;
-    /**
-     * Checks if a key is currently pressed.
-     * @param key The event.code of the key.
-     * @returns {boolean} True if the key is pressed, false otherwise.
-     * @private
-     */
-    isKeyPressed(key: string): boolean;
-    /**
-     * Resets the handler state by clearing all pressed keys and recalculating movement.
-     * @override
-     */
-    reset(): void;
-    /**
-     * Registers a handler for a key down event.
-     * @param code The event.code of the key.
-     * @param handler Callback invoked on key down.
-     */
-    registerKeyDown(code: string, mode: CallbackMode, handler: () => void): void;
-    /**
-     * Registers a handler for a key up event.
-     * @param code The event.code of the key.
-     * @param handler Callback invoked on key up.
-     */
-    registerKeyUp(code: string | string[], mode: CallbackMode, handler: () => void): void;
-    private registerKey;
-    /**
-     * Internal key down event handler.
-     * @param event The KeyboardEvent object.
-     * @private
-     */
-    private _onKeyDown;
-    /**
-     * Internal key up event handler.
-     * @param event The KeyboardEvent object.
-     * @private
-     */
-    private _onKeyUp;
-    /**
-     * Calculates and applies the movement vector based on currently pressed keys.
-     * Also calls any continuous key pressed handlers for keys that are held down.
-     * @private
-     */
-    private applyMove;
-}
-export {};

package/dist/types/core-viewers/shared/loadResult.d.ts

@@ -1,55 +0,0 @@
-export interface ILoadSuccess<T> {
-    readonly isSuccess: true;
-    readonly isError: false;
-    readonly vim: T;
-}
-export interface ILoadError {
-    readonly isSuccess: false;
-    readonly isError: true;
-    readonly error: string;
-    readonly details?: string;
-}
-export type ProgressType = 'bytes' | 'percent';
-export interface IProgress {
-    type: ProgressType;
-    current: number;
-    total?: number;
-}
-export type LoadResult<TValue, TError extends ILoadError = ILoadError> = ILoadSuccess<TValue> | TError;
-export declare class LoadSuccess<T> implements ILoadSuccess<T> {
-    readonly vim: T;
-    readonly isSuccess: true;
-    readonly isError: false;
-    constructor(vim: T);
-}
-export declare class LoadError implements ILoadError {
-    readonly error: string;
-    readonly details?: string;
-    readonly isSuccess: false;
-    readonly isError: true;
-    constructor(error: string, details?: string);
-}
-/**
- * Interface for load requests that can be used as a type constraint.
- */
-export interface ILoadRequest<TVim, TError extends ILoadError = ILoadError> {
-    readonly isCompleted: boolean;
-    getProgress(): AsyncGenerator<IProgress>;
-    getResult(): Promise<LoadResult<TVim, TError>>;
-    abort(): void;
-}
-/**
- * Base class for loading requests that provides progress tracking via AsyncQueue.
- * Both WebGL and Ultra extend this class with their specific loading logic.
- */
-export declare class LoadRequest<TVim, TError extends ILoadError = ILoadError> implements ILoadRequest<TVim, TError> {
-    private _progressQueue;
-    private _result;
-    private _resultPromise;
-    get isCompleted(): boolean;
-    getProgress(): AsyncGenerator<IProgress>;
-    getResult(): Promise<LoadResult<TVim, TError>>;
-    pushProgress(progress: IProgress): void;
-    complete(result: LoadResult<TVim, TError>): void;
-    abort(): void;
-}

package/dist/types/core-viewers/shared/mouseHandler.d.ts

@@ -1,30 +0,0 @@
-import { BaseInputHandler } from "./baseInputHandler";
-import * as THREE from 'three';
-type DragCallback = (delta: THREE.Vector2, button: number) => void;
-export declare class MouseHandler extends BaseInputHandler {
-    private _lastMouseDownPosition;
-    private _capture;
-    private _dragHandler;
-    private _doubleClickHandler;
-    private _clickHandler;
-    onButtonDown: (pos: THREE.Vector2, button: number) => void;
-    onButtonUp: (pos: THREE.Vector2, button: number) => void;
-    onMouseMove: (event: THREE.Vector2) => void;
-    onDrag: DragCallback;
-    onClick: (position: THREE.Vector2, ctrl: boolean) => void;
-    onDoubleClick: (position: THREE.Vector2) => void;
-    onWheel: (value: number, ctrl: boolean, pos: THREE.Vector2) => void;
-    onContextMenu: (position: THREE.Vector2) => void;
-    constructor(canvas: HTMLCanvasElement);
-    protected addListeners(): void;
-    dispose(): void;
-    private handlePointerDown;
-    private handlePointerUp;
-    private handleMouseClick;
-    private handleContextMenu;
-    private handlePointerMove;
-    private handleDoubleClick;
-    private onMouseScroll;
-    private relativePosition;
-}
-export {};

package/dist/types/core-viewers/shared/raycaster.d.ts

@@ -1,27 +0,0 @@
-import { THREE } from "../..";
-export interface IRaycastResult<T> {
-    /** The model Object hit */
-    object: T | undefined;
-    /** The 3D world position of the hit point */
-    worldPosition: THREE.Vector3;
-    /** The surface normal at the hit point */
-    worldNormal: THREE.Vector3;
-}
-/**
- * Interface for raycasting against a 3D scene.
- * @template T - The type of object to raycast against.
- */
-export interface IRaycaster<T> {
-    /**
-     * Raycasts from camera to the screen position to find the first object hit.
-     * @param position - The screen position to raycast from.
-     * @returns A promise that resolves to the raycast result, or undefined if no hit.
-     */
-    raycastFromScreen(position: THREE.Vector2): Promise<IRaycastResult<T> | undefined>;
-    /**
-     * Raycasts from camera to world position to find the first object hit.
-     * @param position - The world position to raycast through.
-     * @returns A promise that resolves to the raycast result, or undefined if no hit.
-     */
-    raycastFromWorld(position: THREE.Vector3): Promise<IRaycastResult<T> | undefined>;
-}

package/dist/types/core-viewers/shared/selection.d.ts

@@ -1,105 +0,0 @@
-import { ISignal } from "ste-signals";
-import { IVimElement, IVim } from "./vim";
-import { THREE } from "../..";
-export interface ISelectionAdapter<T extends IVimElement> {
-    outline(target: T, state: boolean): void;
-}
-/**
- * Selection manager that supports adding, removing, toggling, and querying selected objects.
- * The selection change signal is debounced to dispatch only once per animation frame.
- */
-export declare class Selection<T extends IVimElement> {
-    private _onSelectionChanged;
-    private _selection;
-    private _adapter;
-    /**
-     * If true, reselecting the currently selected single target will toggle it instead of doing nothing.
-     */
-    toggleOnRepeatSelect: boolean;
-    /**
-     * If true, the selection manager is enabled and can modify the selection.
-     */
-    enabled: boolean;
-    /**
-     * Creates a new Selection manager.
-     * @param adapter - Adapter responsible for visual selection feedback.
-     */
-    constructor(adapter: ISelectionAdapter<T>);
-    /**
-     * Checks whether a specific object is currently selected.
-     * @param target - The target to check.
-     * @returns `true` if the object is selected; otherwise, `false`.
-     */
-    has(target: T): boolean;
-    /**
-     * Returns the number of selected objects.
-     * @returns The count of selected items.
-     */
-    count(): number;
-    /**
-     * Checks if there is at least one selected object.
-     * @returns `true` if the selection is not empty.
-     */
-    any(): boolean;
-    /**
-     * Signal that fires when the selection changes.
-     */
-    get onSelectionChanged(): ISignal;
-    /**
-     * Normalizes a value to an array of objects.
-     * @param oneOrMore - A single object or an array of objects.
-     * @returns An array of objects.
-     */
-    private toArray;
-    /**
-     * Replaces the current selection with the given object(s).
-     * If `toggleOnRepeatSelect` is true and the object is already the only selected one, it toggles it instead.
-     * @param objectOrObjects - Object(s) to select, or `undefined` to clear the selection.
-     */
-    select(object: T): void;
-    select(objects: T[]): void;
-    /**
-     * Toggles the selection state of the given object(s).
-     * @param objectOrObjects - Object(s) to toggle.
-     */
-    toggle(object: T): void;
-    toggle(objects: T[]): void;
-    /**
-     * Adds the given object(s) to the selection.
-     * @param objectOrObjects - Object(s) to add.
-     */
-    add(object: T): void;
-    add(objects: T[]): void;
-    /**
-     * Removes the given object(s) from the selection.
-     * @param objectOrObjects - Object(s) to remove.
-     */
-    remove(object: T): void;
-    remove(objects: T[]): void;
-    /**
-     * Clears the entire selection.
-     */
-    clear(): void;
-    /**
-     * Returns an array of all currently selected objects.
-     * @returns An array of selected objects.
-     */
-    getAll(): T[];
-    /**
-     * Returns all selected objects belonging to a specific VIM model.
-     * @param vim - The VIM instance to filter by.
-     * @returns An array of selected objects from the specified VIM.
-     */
-    getFromVim(vim: IVim<T>): T[];
-    /**
-     * Removes all selected objects that belong to a specific VIM model.
-     * @param vim - The VIM instance to remove selections from.
-     */
-    removeFromVim(vim: IVim<T>): void;
-    /**
-     * Computes the bounding box that contains all selected objects.
-     * Skips objects that do not implement `getBoundingBox()`.
-     * @returns A promise resolving to the combined bounding box.
-     */
-    getBoundingBox(): Promise<THREE.Box3 | undefined>;
-}

package/dist/types/core-viewers/shared/touchHandler.d.ts

@@ -1,42 +0,0 @@
-/**
- * @module viw-webgl-viewer/inputs
- */
-import * as THREE from 'three';
-import { BaseInputHandler } from './baseInputHandler';
-/**
- * Manages user touch inputs.
- */
-export declare class TouchHandler extends BaseInputHandler {
-    private readonly TAP_DURATION_MS;
-    private readonly DOUBLE_TAP_DELAY_MS;
-    private readonly TAP_MAX_MOVE_PIXEL;
-    private readonly ZOOM_SPEED;
-    private readonly MOVE_SPEED;
-    onTap: (position: THREE.Vector2) => void;
-    onDoubleTap: (position: THREE.Vector2) => void;
-    onDrag: (delta: THREE.Vector2) => void;
-    onDoubleDrag: (delta: THREE.Vector2) => void;
-    onPinchOrSpread: (delta: number) => void;
-    constructor(canvas: HTMLCanvasElement);
-    private _touch;
-    private _touch1;
-    private _touch2;
-    private _touchStartTime;
-    private _lastTapMs;
-    private _touchStart;
-    protected addListeners(): void;
-    reset: () => void;
-    private _onTap;
-    private onTouchStart;
-    private toRotation;
-    private onTouchMove;
-    private onTouchEnd;
-    private isSingleTouch;
-    private touchToVector;
-    private average;
-    /**
-     * Returns the pixel size of the canvas.
-     * @returns {THREE.Vector2} The pixel size of the canvas.
-     */
-    getCanvasSize(): THREE.Vector2;
-}

package/dist/types/core-viewers/shared/vim.d.ts

@@ -1,48 +0,0 @@
-import { THREE } from "../..";
-/**
- * Interface for a Vim element.
- */
-export interface IVimElement {
-    /**
-     * The vim from which this object came.
-     */
-    vim: IVim<IVimElement>;
-    /**
-     * The bounding box of the object.
-     */
-    getBoundingBox(): Promise<THREE.Box3 | undefined>;
-}
-/**
- * Interface for a Vim object.
- * @template T - The type of element contained in the Vim.
- */
-export interface IVim<T extends IVimElement> {
-    /**
-     * Retrieves the element associated with the specified instance index.
-     * @param instance - The instance index of the of one of the instance included in the element.
-     * @returns The object corresponding to the instance, or undefined if not found.
-     */
-    getElement(instance: number): T | undefined;
-    /**
-     * Retrieves the element associated with the specified id.
-     * @param id - The element ID to retrieve objects for.
-     * @returns An array of element corresponding to the given id.
-     */
-    getElementsFromId(id: number): T[];
-    /**
-     * Retrieves the element associated with the given index.
-     * @param element - The index of the element.
-     * @returns The element corresponding to the element index, or undefined if not found.
-     */
-    getElementFromIndex(element: number): T | undefined;
-    /**
-     * Retrieves all elements within the Vim.
-     * @returns An array of all Vim objects.
-     */
-    getAllElements(): T[];
-    /**
-     * Retrieves the bounding box of the Vim object.
-     * @returns The bounding box of the Vim object.
-     */
-    getBoundingBox(): Promise<THREE.Box3>;
-}

package/dist/types/core-viewers/shared/vimCollection.d.ts

@@ -1,25 +0,0 @@
-import { ISignal } from 'ste-signals';
-import { IVim, IVimElement } from './vim';
-/**
- * Readonly interface for a collection of vims.
- */
-export interface IReadonlyVimCollection<T extends IVim<IVimElement>> {
-    /** Number of vims in the collection */
-    readonly count: number;
-    /** Signal dispatched when collection changes */
-    readonly onChanged: ISignal;
-    /** Get vim by its stable ID */
-    getFromId(id: number): T | undefined;
-    /** Get all vims as an array */
-    getAll(): ReadonlyArray<T>;
-    /** Check if vim is in collection */
-    has(vim: T): boolean;
-}
-/**
- * Mutable interface for a collection of vims.
- */
-export interface IVimCollection<T extends IVim<IVimElement>> extends IReadonlyVimCollection<T> {
-    add(vim: T): void;
-    remove(vim: T): void;
-    clear(): void;
-}