@nebula-spatial/viewer 0.1.0 → 0.2.1

package/dist/types.d.ts

@@ -1,5 +1,43 @@
 import type { Box3, ColorRepresentation, Object3D, Vector3 } from 'three';
+import type { CadViewerCapability, CameraStateStore, ViewerUiOptions } from './cad/types';
+export type { CadBlockModel, CadDocumentHandle, CadFontResolver, CadResolvedTextFont, CadHudModel, CadInspectorModel, CadLayerModel, CadLoadSource, CadOpenOptions, CadTextDetails, CadTextSelection, CadTextSelectionId, CadViewerCapability, ResolveTextFont, CadViewerEventMap, CameraStateStore, ViewerUiOptions, ViewerUiParts, ViewerUiPreset, ViewerUiTheme, } from './cad/types';
 export type ViewerViewMode = '2d' | '3d';
+export type ViewerEnvironment = 'room' | {
+    /** Load an external equirectangular HDR texture for image-based lighting. */
+    readonly type: 'hdr';
+    readonly url: string;
+};
+export interface ViewerDocumentRect {
+    readonly minX: number;
+    readonly minY: number;
+    readonly maxX: number;
+    readonly maxY: number;
+}
+export interface ViewerOrthographicSnapshot {
+    readonly left: number;
+    readonly right: number;
+    readonly top: number;
+    readonly bottom: number;
+    readonly zoom: number;
+    readonly positionX: number;
+    readonly positionY: number;
+    readonly targetX: number;
+    readonly targetY: number;
+}
+export interface ViewerOrbitSnapshot {
+    readonly targetX: number;
+    readonly targetY: number;
+    readonly targetZ: number;
+    readonly distance: number;
+    readonly yaw: number;
+    readonly pitch: number;
+}
+export interface ViewerCameraSnapshot {
+    readonly schemaVersion: number;
+    readonly viewMode: ViewerViewMode;
+    readonly orthographic?: ViewerOrthographicSnapshot;
+    readonly orbit?: ViewerOrbitSnapshot;
+}
 export interface ViewerOptions {
     viewport: HTMLElement;
     canvas: HTMLCanvasElement;
@@ -8,8 +46,14 @@ export interface ViewerOptions {
     alpha?: boolean;
     powerPreference?: WebGLPowerPreference;
     initialViewMode?: ViewerViewMode;
+    /** Image-based lighting environment. Defaults to the built-in room environment. */
+    environment?: ViewerEnvironment;
     autoSelectOnPick?: boolean;
     pointerPick?: boolean;
+    cameraStateStore?: CameraStateStore | false;
+    /** Max delay for merged viewport demands while the interaction is active. Default 160ms. */
+    viewportDemandCoalesceMs?: number;
+    ui?: ViewerUiOptions;
 }
 export interface ViewerFitViewOptions {
     padding?: number;
@@ -31,20 +75,24 @@ export interface ViewerPickResult {
 export interface ViewerHighlightOptions {
     color?: ColorRepresentation;
 }
+export interface ViewerRenderStats {
+    readonly drawCalls: number;
+    readonly submittedVertexRefs: number;
+    readonly fps: number;
+}
+export interface ViewerPointerEvent {
+    clientX: number;
+    clientY: number;
+    buttons: number;
+    shiftKey: boolean;
+    ctrlKey: boolean;
+    metaKey: boolean;
+}
 export interface ViewerEventMap {
-    'pointer-click': {
-        clientX: number;
-        clientY: number;
-        shiftKey: boolean;
-        ctrlKey: boolean;
-        metaKey: boolean;
-    };
-    pick: {
-        clientX: number;
-        clientY: number;
-        shiftKey: boolean;
-        ctrlKey: boolean;
-        metaKey: boolean;
+    'pointer-move': ViewerPointerEvent;
+    'pointer-leave': ViewerPointerEvent;
+    'pointer-click': ViewerPointerEvent;
+    pick: ViewerPointerEvent & {
         result: ViewerPickResult | null;
     };
     'selection-change': {
@@ -59,6 +107,21 @@ export interface ViewerEventMap {
     resize: {
         resized: boolean;
     };
+    'viewport-change': {
+        viewportWidthPx: number;
+        viewportHeightPx: number;
+        worldUnitsPerPixel: number;
+        interaction: 'active' | 'idle';
+    };
+    'interaction-change': {
+        interaction: 'active' | 'idle';
+    };
+    'content-change': {
+        source: 'object' | 'cad';
+    };
+    'camera-change': {
+        viewMode: ViewerViewMode;
+    };
 }
 export interface Viewer {
     readonly viewport: HTMLElement;
@@ -67,10 +130,13 @@ export interface Viewer {
     readonly selectedObject: Object3D | null;
     readonly highlightedObject: Object3D | null;
     readonly isDisposed: boolean;
+    readonly cad: CadViewerCapability;
     addObject(object: Object3D): void;
     removeObject(object: Object3D): boolean;
     setVisible(object: Object3D, visible: boolean): void;
-    setViewMode(mode: ViewerViewMode): void;
+    setViewMode(mode: ViewerViewMode, options?: {
+        preserveOrbit?: boolean;
+    }): void;
     fitView(target?: Object3D | Box3, options?: ViewerFitViewOptions): boolean;
     screenToWorldOnPlane(clientX: number, clientY: number, planeZ?: number): Vector3 | null;
     pick(clientX: number, clientY: number, options?: ViewerPickOptions): ViewerPickResult | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula-spatial/viewer",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Read-only Three.js viewer facade",
   "license": "ISC",
   "engines": {
@@ -10,6 +10,7 @@
   "files": [
     "dist",
     "README.md",
+    "CHANGELOG.md",
     "package.json"
   ],
   "main": "./dist/index.js",
@@ -26,7 +27,7 @@
   "scripts": {
     "build": "npm run check:boundary && npm run typecheck && npm run build:bundle && npm run build:types && npm run check:dist",
     "build:bundle": "vite build --config vite.config.ts",
-    "build:types": "tsc --project tsconfig.build.json",
+    "build:types": "tsc --project tsconfig.build.json && node scripts/prune-dist-types.mjs",
     "check:boundary": "node scripts/check-boundary.mjs",
     "check:dist": "node scripts/check-dist.mjs",
     "typecheck": "tsc --project tsconfig.json --noEmit",
@@ -34,14 +35,19 @@
     "pack:dry": "npm pack --dry-run",
     "prepack": "npm run build"
   },
+  "dependencies": {
+    "@nebula-spatial/cad-loader": "^0.2.1"
+  },
   "peerDependencies": {
     "three": "0.182.0"
   },
   "devDependencies": {
     "@types/node": "^25.6.0",
+    "@types/jsdom": "^27.0.0",
     "@types/three": "0.182.0",
     "three": "0.182.0",
     "typescript": "^5.6.3",
+    "jsdom": "^29.0.2",
     "vite": "^5.4.10",
     "vitest": "^2.1.8"
   }