@liveroom-tech/react-immersive 5.3.0 → 6.0.1

package/dist/index.d.ts

@@ -1,14 +1,10 @@
 import * as react from 'react';
-import { n as ModelViewerProps, t as ViewerCameraProps, v as ViewerReadyState, b as CaptureImageOptions, c as CaptureVideoOptions, U as UseViewerCameraOptions, k as ModelViewerModelEntry } from './modelViewerProps-BalkRDni.js';
-export { A as AnnotationMarker, C as CameraControllerType, a as CameraLimits, d as CinematicConfig, e as CinematicWaypoint, f as CustomObjectBindingDataPanelProps, g as CustomSceneObjectsPanelProps, D as DecalMoveTarget, G as GroupedModelViewerProps, H as HomeCameraState, M as MODEL_VIEWER_PRESETS, h as ModelMergeSource, i as ModelViewerControlsOptions, j as ModelViewerDecoderOptions, l as ModelViewerPerfOptions, m as ModelViewerPreset, o as ModelViewerTilesOptions, p as ModelViewerToolsOptions, q as ModelViewerUiOptions, r as ModelViewerXrOptions, s as MouseControllerPosition, O as ObjectTransformSpace, P as PerformanceProfile, T as TexturePositioningControls, V as ViewerCameraPreset, u as ViewerEngagementEvent, X as XRScaleMode, w as useViewerCamera } from './modelViewerProps-BalkRDni.js';
-import { o as ObjectBinding, z as ObjectBindingTarget, v as ObjectBindingPatch, B as BindingEdit, s as ObjectBindingMaterial, H as ObjectBindingTextureSlot, F as ObjectBindingTextureChannel, J as ObjectBindingTransform, r as ObjectBindingDecal, a1 as SceneConfig, a3 as SceneConfigPatch, a6 as SceneLight, a7 as SceneLightAttachment, aq as ViewerIsolation, p as ObjectBindingAction, n as ObjectActionEvent, an as ViewerAnimationsProps, ar as ViewerObjectInfo, ap as ViewerCameraState } from './rendererBackend-C_Jb4_Jy.js';
-export { A as AnimationAction, a as AnimationActionEffect, b as AnimationClipInfo, c as AnimationClipState, d as AnimationClipStatus, e as AnimationControls, f as AnimationLoopMode, g as AnimationPlayOptions, h as AnimationPlaybackState, C as CameraAction, i as CameraActionEffect, D as DEFAULT_SCENE_CONFIG, j as DEFAULT_SECTION_CONFIG, k as DeepPartial, E as EnvironmentPreset, G as GlitchModeName, I as IsolatedObjectBindings, l as IsolationActionEffect, K as KernelSizeName, M as MATERIAL_BLENDING_MODES, m as MATERIAL_SIDES, O as ObjectActionEffect, q as ObjectBindingCameraState, t as ObjectBindingMaterialBlendingMode, u as ObjectBindingMaterialSide, w as ObjectBindingSelector, x as ObjectBindingStatus, y as ObjectBindingStyle, L as ObjectBindingType, N as ObjectBindingsActionEffect, P as ObjectPointerEvent, Q as ObjectSurfacePoint, R as RampTypeName, S as RendererBackend, T as SceneAnimationClipConfig, U as SceneAnimationConfig, V as SceneAnnotationCameraView, W as SceneAnnotationImage, X as SceneAnnotationLink, Y as SceneAnnotationMarker, Z as SceneBackgroundConfig, _ as SceneCameraConfig, $ as SceneCinematicConfig, a0 as SceneCinematicWaypoint, a2 as SceneConfigActionEffect, a4 as SceneEnvironmentConfig, a5 as SceneGroundShadowConfig, a8 as SceneLightType, a9 as SceneLightingConfig, aa as SceneModelConfig, ab as SceneModelRenderer, ac as ScenePostProcessingConfig, ad as SceneSectionAxis, ae as SceneSectionConfig, af as SceneShadowConfig, ag as SceneStyleColorScale, ah as SceneStyleCondition, ai as SceneStylePulse, aj as SceneStyleRule, ak as SceneWireframeConfig, al as StyledObjectBindings, am as StyledObjectPulse, ao as ViewerCameraConfig, as as VisibilityActionEffect, at as applyIsolation, au as applyStyleRules, av as colorScaleValue, aw as isolatedBindingKeys, ax as material, ay as patchBindings, az as patchSceneConfig, aA as selectBindingKeys, aB as selectBindings, aC as useViewerAnimations } from './rendererBackend-C_Jb4_Jy.js';
+import { ag as ModelViewerProps, bk as SemanticComparisonOptions, K as ConfigurationComparisonReport, ao as ObjectBinding, az as ObjectBindingTarget, av as ObjectBindingPatch, B as BindingEdit, as as ObjectBindingMaterial, aB as ObjectBindingTextureSlot, aA as ObjectBindingTextureChannel, aC as ObjectBindingTransform, ar as ObjectBindingDecal, aX as SceneConfig, aZ as SceneConfigPatch, b0 as SceneLight, b1 as SceneLightAttachment, bI as ViewerIsolation, ap as ObjectBindingAction, an as ObjectActionEvent, bB as ViewerAnimationsProps, bE as ViewerCameraProps, bK as ViewerReadyState, x as CaptureImageOptions, y as CaptureVideoOptions, bJ as ViewerObjectInfo, bA as UseViewerCameraOptions, bv as ShareableViewerState, bF as ViewerCameraState, bG as ViewerConfiguration, bM as ViewerStateStorage, ad as ModelViewerModelEntry, t as AssetTransform, q as AssetDiagnosticsReport, bL as ViewerRuntimeStats, bm as SequenceControls, bq as SequencePlaybackState } from './modelViewerProps-BibuMND7.js';
+export { A as ARExportOptions, a as ARHandoffOptions, b as ARHandoffRequest, c as ARHandoffStatus, d as ARSnapshot, e as ARSnapshotSource, f as AnimationAction, g as AnimationActionEffect, h as AnimationClipInfo, i as AnimationClipState, j as AnimationClipStatus, k as AnimationControls, l as AnimationLoopMode, m as AnimationPlayOptions, n as AnimationPlaybackState, o as AnnotationMarker, p as AssetDiagnosticIssue, r as AssetDiagnosticsSource, s as AssetTextureDiagnostic, C as CameraAction, u as CameraActionEffect, v as CameraControllerType, w as CameraLimits, z as CinematicConfig, D as CinematicWaypoint, E as ComparisonCategory, F as ComparisonChange, G as ComparisonHighlight, H as ComparisonObject, I as ComparisonStatus, J as ConfigurationComparisonInput, L as CustomObjectBindingDataPanelProps, M as CustomSceneObjectsPanelProps, N as DEFAULT_SCENE_CONFIG, O as DEFAULT_SECTION_CONFIG, P as DecalMoveTarget, Q as DeepPartial, R as EnvironmentPreset, S as GlitchModeName, T as GroupedModelViewerProps, U as HomeCameraState, V as InspectAssetOptions, W as IsolatedObjectBindings, X as IsolationActionEffect, Y as KernelSizeName, Z as MATERIAL_BLENDING_MODES, _ as MATERIAL_SIDES, $ as MAX_VIEWER_STATE_BYTES, a0 as MODEL_VIEWER_PRESETS, a1 as MeasurementAnchor, a2 as MeasurementCollection, a3 as MeasurementPoint, a4 as MeasurementPosition, a5 as MeasurementResult, a6 as MeasurementSettings, a7 as MeasurementStatus, a8 as MeasurementTool, a9 as MeasurementUnit, aa as ModelMergeSource, ab as ModelViewerControlsOptions, ac as ModelViewerDecoderOptions, ae as ModelViewerPerfOptions, af as ModelViewerPreset, ah as ModelViewerTilesOptions, ai as ModelViewerToolsOptions, aj as ModelViewerUiOptions, ak as ModelViewerXrOptions, al as MouseControllerPosition, am as ObjectActionEffect, aq as ObjectBindingCameraState, at as ObjectBindingMaterialBlendingMode, au as ObjectBindingMaterialSide, aw as ObjectBindingSelector, ax as ObjectBindingStatus, ay as ObjectBindingStyle, aD as ObjectBindingType, aE as ObjectBindingsActionEffect, aF as ObjectPointerEvent, aG as ObjectSurfacePoint, aH as ObjectTransformSpace, aI as PerformanceProfile, aJ as RampTypeName, aK as RendererBackend, aL as SavedMeasurement, aM as SceneAnimationClipConfig, aN as SceneAnimationConfig, aO as SceneAnnotationCameraView, aP as SceneAnnotationImage, aQ as SceneAnnotationLink, aR as SceneAnnotationMarker, aS as SceneBackgroundConfig, aT as SceneCameraConfig, aU as SceneCinematicConfig, aV as SceneCinematicWaypoint, aY as SceneConfigActionEffect, a_ as SceneEnvironmentConfig, a$ as SceneGroundShadowConfig, b2 as SceneLightType, b3 as SceneLightingConfig, b4 as SceneModelConfig, b5 as SceneModelRenderer, b6 as ScenePostProcessingConfig, b7 as SceneSectionAxis, b8 as SceneSectionConfig, b9 as SceneSectionPlane, ba as SceneSectionPreset, bb as SceneSectionSettings, bc as SceneSelectionSet, bd as SceneSequence, be as SceneShadowConfig, bf as SceneStyleColorScale, bg as SceneStyleCondition, bh as SceneStylePulse, bi as SceneStyleRule, bj as SceneWireframeConfig, bl as SequenceCameraView, bn as SequenceEasing, bo as SequenceKeyframe, bp as SequenceObjectProperty, br as SequenceTarget, bs as SequenceTrack, bt as SequenceValue, bu as SequenceVector3, bw as StreamingDiagnostics, bx as StyledObjectBindings, by as StyledObjectPulse, bz as TexturePositioningControls, bC as ViewerCameraConfig, bD as ViewerCameraPreset, bH as ViewerEngagementEvent, bN as VisibilityActionEffect, bO as XRScaleMode, bP as applyIsolation, bQ as applyStyleRules, bR as colorScaleValue, bS as compareViewerConfigurations, bT as groundAsset, bU as isolatedBindingKeys, bV as material, bW as parseAssetTransform, bX as parseSelectionSets, bY as parseViewerState, bZ as patchBindings, b_ as patchSceneConfig, b$ as prepareViewerState, c0 as selectBindingKeys, c1 as selectBindings, c2 as serializeViewerState, c3 as snapAssetToGrid, c4 as useViewerAnimations, c5 as useViewerCamera } from './modelViewerProps-BibuMND7.js';
 import { SceneLightInput } from './utils.js';
-export { ACTION_CATALOG, ActionCatalogEntry, ActionHandling, ObjectBindingActionId, ObjectBindingKey, buildBindingsFromNodes, createDefaultBinding, defineObjectBindings, findCatalogAction, inferType, sceneLight } from './utils.js';
-import { a as ViewerModelBounds, b as ViewerModelInfo } from './modelInfo-BQ5UZu95.js';
-export { M as ModelFormat, V as ViewerLoading, c as ViewerReveal } from './modelInfo-BQ5UZu95.js';
-import { M as MaterialVariantGroup } from './materialVariants-DjTuiWmN.js';
-export { D as DEFAULT_MODEL_VIEWER_LABELS, a as MaterialVariantOption, b as ModelViewerLabelKey, c as ModelViewerLabels, R as ReducedMotionSetting, d as chooseMaterialVariant } from './materialVariants-DjTuiWmN.js';
+export { ACTION_CATALOG, ActionCatalogEntry, ActionHandling, MEASUREMENT_UNITS, ObjectBindingActionId, ObjectBindingKey, SEQUENCE_EASINGS, SEQUENCE_OBJECT_PROPERTIES, ViewerHierarchyNode, buildBindingsFromNodes, calibrateMeasurements, collectObjectHierarchy, copyBindingStyle, createARHandoffUrl, createDefaultBinding, defineObjectBindings, exportConfiguredUSDZ, findCatalogAction, inferType, inspectAsset, measurementResult, measurementScale, measurementValue, measurementsToCsv, parseMeasurements, parseSectionConfig, parseSequences, pasteBindingStyle, readARHandoffUrl, sampleSequenceTrack, sceneLight, sectionSnapshot, serializeMeasurements, upsertSequenceKeyframe } from './utils.js';
+import { e as ViewerModelBounds, M as MaterialVariantGroup, f as ViewerModelInfo } from './modelFileResolver-Co7j1tdQ.js';
+export { D as DEFAULT_MODEL_VIEWER_LABELS, a as MaterialVariantOption, b as ModelFormat, c as ModelViewerLabelKey, d as ModelViewerLabels, R as ReducedMotionSetting, V as ViewerLoading, g as ViewerReveal, h as chooseMaterialVariant } from './modelFileResolver-Co7j1tdQ.js';
 import 'three';
 import '@react-three/drei';
 
@@ -21,6 +17,14 @@ type CompareViewerSide = Partial<ModelViewerProps> & {
 };
 type CompareViewerProps = Partial<ModelViewerProps> & {
     licenseKey: string;
+    /** Opt in to authored object/scene change details and bounds outlines. */
+    semanticComparison?: boolean | SemanticComparisonOptions;
+    /** Show colored comparison bounds. Default true; controlled when supplied. */
+    showComparisonOutlines?: boolean;
+    onComparisonOutlinesChange?: (enabled: boolean) => void;
+    /** Inspect both sides with the same cut. Defaults to true with semantic comparison. */
+    linkSections?: boolean;
+    onComparisonChange?: (report: ConfigurationComparisonReport) => void;
     /** The left side: the shared props with these on top. */
     before: CompareViewerSide;
     /** The right side. */
@@ -414,23 +418,77 @@ type UseShareableViewerStateOptions = {
     onObjectBindingsChange: (next: Record<string, ObjectBinding>) => void;
     selectedObjectBinding: ObjectBinding | null;
     setSelectedObjectBinding: (binding: ObjectBinding | null) => void;
+    /** Controlled props to include: scene settings, model sources, isolation, etc. */
+    configuration?: ViewerConfiguration;
+    /** Apply configuration to the same controlled props passed to ModelViewer. */
+    onConfigurationChange?: (next: ViewerConfiguration) => void;
+    /** Set false while the active model is loading; restoration resumes when true. */
+    isReady?: boolean;
+    /** Defaults to configuration when configuration is supplied, otherwise compact legacy view mode. */
+    mode?: "configuration" | "view";
+    /** Application-owned storage for asynchronous short links. No server is required by the SDK. */
+    storage?: ViewerStateStorage;
+    /** Maximum inline URL length. Default 65536; use storage or JSON for larger states. */
+    maxUrlLength?: number;
+    /** Reports background auto-sync, hashchange and pending-restore failures. */
+    onError?: (error: Error) => void;
     paramKey?: string;
     debounceMs?: number;
+    /** Sync starts after the incoming link has been read and fully restored. */
     autoSync?: boolean;
 };
 type ShareableViewerStateProps = {
+    /** Detached, versioned snapshot for JSON saving or application persistence. */
+    getState: () => ShareableViewerState;
+    /** Includes live local texture/decal images as portable data URLs. */
+    getStateAsync: () => Promise<ShareableViewerState>;
+    /** Restore JSON or parsed saved state. False while waiting for the model/configuration. */
+    restoreState: (state: unknown) => Promise<boolean>;
     getShareUrl: () => string;
+    /** Uses storage when provided; otherwise returns an inline link. */
+    createShareUrl: () => Promise<string>;
     syncUrl: () => void;
     restoreFromUrl: () => Promise<boolean>;
 };
-declare function useShareableViewerState({ cameraState, setCameraState, objectBindings, onObjectBindingsChange, selectedObjectBinding, setSelectedObjectBinding, paramKey, debounceMs, autoSync, }: UseShareableViewerStateOptions): ShareableViewerStateProps;
+declare function useShareableViewerState(options: UseShareableViewerStateOptions): ShareableViewerStateProps;
 
+/** Owns independent instances, their bindings/settings, placement and active selection. */
 declare function useViewerModels(initialModels: ModelViewerModelEntry[]): {
     modelUrl: string;
     models: ModelViewerModelEntry[];
-    onModelChange: react.Dispatch<react.SetStateAction<string>>;
+    activeModelId: string;
+    onModelChange: (url: string) => void;
+    onActiveModelChange: react.Dispatch<react.SetStateAction<string>>;
     objectBindings: Record<string, ObjectBinding>;
     onObjectBindingsChange: (next: Record<string, ObjectBinding>) => void;
+    sceneConfig: SceneConfig | undefined;
+    onSceneConfigChange: (sceneConfig: SceneConfig) => void;
+    addModel: (model: ModelViewerModelEntry) => string;
+    duplicateModel: (id: string) => string | null;
+    removeModel: (id: string) => void;
+    updateModelTransform: (id: string, transform: AssetTransform) => void;
 };
 
-export { BindingEdit, CaptureImageOptions, CaptureVideoOptions, CompareViewer, type CompareViewerProps, type CompareViewerSide, type HiddenObjectsState, MaterialVariantGroup, PublicModelViewer as ModelViewer, ModelViewerModelEntry, ModelViewerProps, ObjectActionEvent, ObjectBinding, ObjectBindingAction, ObjectBindingDecal, ObjectBindingMaterial, ObjectBindingPatch, ObjectBindingTarget, ObjectBindingTextureChannel, ObjectBindingTextureSlot, ObjectBindingTransform, type ObjectBindingsController, type RuntimeMaterialPatch, type RuntimeMaterialRanges, type RuntimePointLightOptions, type RuntimePointLightPatch, type RuntimeTransformPatch, type RuntimeTransformRanges, SceneConfig, type SceneConfigController, SceneConfigPatch, type SceneConfigUpdate, SceneLight, SceneLightAttachment, SceneLightInput, type SceneLightPatch, type SceneLightsController, type ShareableViewerStateProps, type UseShareableViewerStateOptions, UseViewerCameraOptions, type UseViewerEffectsOptions, type UseViewerOptions, type UseViewerProps, type UseViewerResult, type ViewerActionAnimationController, type ViewerActionBindingsController, type ViewerActionCameraController, type ViewerActionIsolationController, type ViewerActionSceneController, type ViewerActionsOptions, type ViewerActionsProps, ViewerAnimationsProps, ViewerCameraProps, ViewerCameraState, type ViewerConnectionController, type ViewerEffectChannels, type ViewerEffectEasing, type ViewerEffectRange, type ViewerEffectTarget, type ViewerEffectsController, type ViewerFlickerOptions, type ViewerHoverProps, ViewerIsolation, type ViewerIsolationProps, type ViewerLightEffectChannel, type ViewerMaterialEffectChannel, ViewerModelBounds, ViewerModelInfo, type ViewerModelProps, ViewerObjectInfo, type ViewerPulseOptions, type ViewerReadyConsumer, type ViewerReadyHandler, ViewerReadyState, type ViewerSelectionProps, type ViewerTimelineOptions, type ViewerTimelineStep, type ViewerTransformEffectChannel, type ViewerTransitionOptions, type ViewerVector3, useObjectBinding, useObjectBindingIds, useObjectBindings, useSceneConfig, useShareableViewerState, useViewer, useViewerActions, useViewerConnection, useViewerEffects, useViewerHover, useViewerIsolation, useViewerModel, useViewerModels, useViewerSelection };
+type AssetDiagnosticsPanelProps = {
+    report: AssetDiagnosticsReport | null;
+    runtimeStats?: ViewerRuntimeStats | null;
+    onRefresh?: () => void;
+    onSelectObject?: (name: string) => void;
+};
+/** Read-only report UI, reusable outside the editor. No scene data is sent anywhere. */
+declare function AssetDiagnosticsPanel({ report, runtimeStats: runtime, onRefresh, onSelectObject }: AssetDiagnosticsPanelProps): react.JSX.Element;
+
+type ViewerSequencesProps = {
+    controls: SequenceControls | null;
+    playback: SequencePlaybackState;
+    handleSequencesReady: (controls: SequenceControls | null) => void;
+    play: (id?: string) => boolean;
+    pause: () => void;
+    stop: () => void;
+    seek: (time: number) => boolean;
+    select: (id: string) => boolean;
+};
+/** Connect to ModelViewer.onSequencesReady for programmatic sequence playback. */
+declare function useViewerSequences(): ViewerSequencesProps;
+
+export { AssetDiagnosticsPanel, type AssetDiagnosticsPanelProps, AssetDiagnosticsReport, AssetTransform, BindingEdit, CaptureImageOptions, CaptureVideoOptions, CompareViewer, type CompareViewerProps, type CompareViewerSide, ConfigurationComparisonReport, type HiddenObjectsState, MaterialVariantGroup, PublicModelViewer as ModelViewer, ModelViewerModelEntry, ModelViewerProps, ObjectActionEvent, ObjectBinding, ObjectBindingAction, ObjectBindingDecal, ObjectBindingMaterial, ObjectBindingPatch, ObjectBindingTarget, ObjectBindingTextureChannel, ObjectBindingTextureSlot, ObjectBindingTransform, type ObjectBindingsController, type RuntimeMaterialPatch, type RuntimeMaterialRanges, type RuntimePointLightOptions, type RuntimePointLightPatch, type RuntimeTransformPatch, type RuntimeTransformRanges, SceneConfig, type SceneConfigController, SceneConfigPatch, type SceneConfigUpdate, SceneLight, SceneLightAttachment, SceneLightInput, type SceneLightPatch, type SceneLightsController, SemanticComparisonOptions, SequenceControls, SequencePlaybackState, ShareableViewerState, type ShareableViewerStateProps, type UseShareableViewerStateOptions, UseViewerCameraOptions, type UseViewerEffectsOptions, type UseViewerOptions, type UseViewerProps, type UseViewerResult, type ViewerActionAnimationController, type ViewerActionBindingsController, type ViewerActionCameraController, type ViewerActionIsolationController, type ViewerActionSceneController, type ViewerActionsOptions, type ViewerActionsProps, ViewerAnimationsProps, ViewerCameraProps, ViewerCameraState, ViewerConfiguration, type ViewerConnectionController, type ViewerEffectChannels, type ViewerEffectEasing, type ViewerEffectRange, type ViewerEffectTarget, type ViewerEffectsController, type ViewerFlickerOptions, type ViewerHoverProps, ViewerIsolation, type ViewerIsolationProps, type ViewerLightEffectChannel, type ViewerMaterialEffectChannel, ViewerModelBounds, ViewerModelInfo, type ViewerModelProps, ViewerObjectInfo, type ViewerPulseOptions, type ViewerReadyConsumer, type ViewerReadyHandler, ViewerReadyState, ViewerRuntimeStats, type ViewerSelectionProps, type ViewerSequencesProps, ViewerStateStorage, type ViewerTimelineOptions, type ViewerTimelineStep, type ViewerTransformEffectChannel, type ViewerTransitionOptions, type ViewerVector3, useObjectBinding, useObjectBindingIds, useObjectBindings, useSceneConfig, useShareableViewerState, useViewer, useViewerActions, useViewerConnection, useViewerEffects, useViewerHover, useViewerIsolation, useViewerModel, useViewerModels, useViewerSelection, useViewerSequences };