@liveroom-tech/react-immersive 6.0.2 → 6.1.1

package/dist/hosted.d.mts

@@ -1,9 +1,9 @@
 import * as react from 'react';
-import { MutableRefObject } from 'react';
-import { ag as ModelViewerProps, ao as ObjectBinding, aX as SceneConfig, aW as SceneComposition, ad as ModelViewerModelEntry } from './modelViewerProps-Ce4-wb57.mjs';
-import { B as BindingBuilderProps } from './publicProps-BaJHCDa_.mjs';
+import { MutableRefObject, ReactNode } from 'react';
+import { ag as ModelViewerProps, ao as ObjectBinding, bg as SceneConfig, bf as SceneComposition, ad as ModelViewerModelEntry } from './modelViewerProps-DBwh-fmu.mjs';
+import { B as BindingBuilderProps } from './publicProps-Clr1nSE6.mjs';
 import { Object3D } from 'three';
-import './modelFileResolver-Co7j1tdQ.mjs';
+import './modelFileResolver-B8ADn9Nl.mjs';
 import '@react-three/drei';
 
 declare const TEXTURE_KEYS: readonly ["texture", "metalnessMap", "roughnessMap", "emissiveMap", "alphaMap", "normalMap", "bumpMap", "aoMap", "displacementMap", "clearcoatMap", "clearcoatRoughnessMap", "clearcoatNormalMap", "anisotropyMap", "transmissionMap", "thicknessMap", "sheenColorMap", "sheenRoughnessMap", "specularIntensityMap", "specularColorMap"];
@@ -21,9 +21,15 @@ type ProjectModelViewerProps = ModelViewerProps & {
      * service, so this cannot approve a licence by itself.
      */
     licenseValidationUrl?: string;
+    /** A phone handoff page with one action to start AR. */
+    arLanding?: boolean;
     /** An explicit clear command, distinct from clicking empty canvas space. */
     onSelectionClear?: () => void;
     /** Reports transform-gizmo edit leases for collaborative hosts. */
+    /** In the editor: a reference floor under the model. */
+    showFloorGrid?: boolean;
+    /** In the editor: show only move or only rotate handles. */
+    gizmoTool?: "move" | "rotate";
     onObjectEditLeaseChange?: (binding: ObjectBinding, editing: boolean) => void;
     /** The loaded three.js scene, which the editor builds bindings from. */
     onSceneLoaded?: (scene: Object3D) => void;
@@ -45,7 +51,7 @@ type ProjectModelViewerProps = ModelViewerProps & {
 declare function ProjectModelViewer(props: ProjectModelViewerProps): react.JSX.Element;
 
 /** Settings whose names or positions belong to a particular model. */
-type ModelSettings = Pick<SceneConfig, "annotations" | "animations" | "measurements" | "selectionSets" | "sequences"> & {
+type ModelSettings = Pick<SceneConfig, "annotations" | "animations" | "measurements" | "selectionSets" | "sequences" | "product"> & {
     activeVariants?: string[];
 };
 
@@ -99,6 +105,10 @@ type BindingBuilderProjectChangeOrigin = "local" | "remote";
  * (BindingBuilder.tsx) neither declares nor forwards the rest.
  */
 type ProjectBindingBuilderProps = BindingBuilderProps & {
+    /** The host's own status (collaboration, sharing), shown in the top bar. */
+    topBarStart?: ReactNode;
+    /** The host's own way to publish, such as its share dialog, in Configure's last step. */
+    configurePublish?: ReactNode;
     /**
      * Validates the licence against this deployment's own API rather than the
      * licence service, so the public demo licence works on local and preview
@@ -128,6 +138,14 @@ type ProjectBindingBuilderProps = BindingBuilderProps & {
      * `project`, every image goes through this before it is reported.
      */
     onTextureUpload?: (file: File, objectId: string) => Promise<string>;
+    /**
+     * Receives a 640x360 JPEG of the scene for a projects list: once the model
+     * has loaded if `hasThumbnail` is false, then after local edits, whenever the
+     * editor has gone quiet. Rejecting tries again later.
+     */
+    onThumbnailCapture?: (image: Blob) => Promise<void>;
+    /** Whether the project already has a picture. Defaults to false. */
+    hasThumbnail?: boolean;
     /** Requests/releases a short collaborative lease around gizmo edits. */
     onEditLeaseChange?: (featureId: string, editing: boolean) => void;
     /**
@@ -137,7 +155,7 @@ type ProjectBindingBuilderProps = BindingBuilderProps & {
      */
     allowModelChange?: boolean;
 };
-declare function ProjectBindingBuilder({ licenseKey, licenseValidationUrl, arHandoff, mobileHandoffUrl, dracoDecoderPath, ktx2TranscoderPath, meshopt, project, onProjectChange, projectChangeDebounceMs, onModelUpload, onTextureUpload, onEditLeaseChange, allowModelChange, hideLicenseCheckingOverlay, }: ProjectBindingBuilderProps): react.JSX.Element;
+declare function ProjectBindingBuilder({ topBarStart, configurePublish, licenseKey, licenseValidationUrl, arHandoff, mobileHandoffUrl, dracoDecoderPath, ktx2TranscoderPath, meshopt, project, onProjectChange, projectChangeDebounceMs, onModelUpload, onTextureUpload, onThumbnailCapture, hasThumbnail, onEditLeaseChange, allowModelChange, hideLicenseCheckingOverlay, }: ProjectBindingBuilderProps): react.JSX.Element;
 
 /** A model's view of the scene: the shared settings plus its own. */
 declare function sceneConfigForModel(sceneConfig: SceneConfig, model: BindingBuilderProjectModel): SceneConfig;

package/dist/hosted.d.ts

@@ -1,9 +1,9 @@
 import * as react from 'react';
-import { MutableRefObject } from 'react';
-import { ag as ModelViewerProps, ao as ObjectBinding, aX as SceneConfig, aW as SceneComposition, ad as ModelViewerModelEntry } from './modelViewerProps-BibuMND7.js';
-import { B as BindingBuilderProps } from './publicProps-CP18d_mt.js';
+import { MutableRefObject, ReactNode } from 'react';
+import { ag as ModelViewerProps, ao as ObjectBinding, bg as SceneConfig, bf as SceneComposition, ad as ModelViewerModelEntry } from './modelViewerProps-BE4D56Ti.js';
+import { B as BindingBuilderProps } from './publicProps-3LNTAskZ.js';
 import { Object3D } from 'three';
-import './modelFileResolver-Co7j1tdQ.js';
+import './modelFileResolver-B8ADn9Nl.js';
 import '@react-three/drei';
 
 declare const TEXTURE_KEYS: readonly ["texture", "metalnessMap", "roughnessMap", "emissiveMap", "alphaMap", "normalMap", "bumpMap", "aoMap", "displacementMap", "clearcoatMap", "clearcoatRoughnessMap", "clearcoatNormalMap", "anisotropyMap", "transmissionMap", "thicknessMap", "sheenColorMap", "sheenRoughnessMap", "specularIntensityMap", "specularColorMap"];
@@ -21,9 +21,15 @@ type ProjectModelViewerProps = ModelViewerProps & {
      * service, so this cannot approve a licence by itself.
      */
     licenseValidationUrl?: string;
+    /** A phone handoff page with one action to start AR. */
+    arLanding?: boolean;
     /** An explicit clear command, distinct from clicking empty canvas space. */
     onSelectionClear?: () => void;
     /** Reports transform-gizmo edit leases for collaborative hosts. */
+    /** In the editor: a reference floor under the model. */
+    showFloorGrid?: boolean;
+    /** In the editor: show only move or only rotate handles. */
+    gizmoTool?: "move" | "rotate";
     onObjectEditLeaseChange?: (binding: ObjectBinding, editing: boolean) => void;
     /** The loaded three.js scene, which the editor builds bindings from. */
     onSceneLoaded?: (scene: Object3D) => void;
@@ -45,7 +51,7 @@ type ProjectModelViewerProps = ModelViewerProps & {
 declare function ProjectModelViewer(props: ProjectModelViewerProps): react.JSX.Element;
 
 /** Settings whose names or positions belong to a particular model. */
-type ModelSettings = Pick<SceneConfig, "annotations" | "animations" | "measurements" | "selectionSets" | "sequences"> & {
+type ModelSettings = Pick<SceneConfig, "annotations" | "animations" | "measurements" | "selectionSets" | "sequences" | "product"> & {
     activeVariants?: string[];
 };
 
@@ -99,6 +105,10 @@ type BindingBuilderProjectChangeOrigin = "local" | "remote";
  * (BindingBuilder.tsx) neither declares nor forwards the rest.
  */
 type ProjectBindingBuilderProps = BindingBuilderProps & {
+    /** The host's own status (collaboration, sharing), shown in the top bar. */
+    topBarStart?: ReactNode;
+    /** The host's own way to publish, such as its share dialog, in Configure's last step. */
+    configurePublish?: ReactNode;
     /**
      * Validates the licence against this deployment's own API rather than the
      * licence service, so the public demo licence works on local and preview
@@ -128,6 +138,14 @@ type ProjectBindingBuilderProps = BindingBuilderProps & {
      * `project`, every image goes through this before it is reported.
      */
     onTextureUpload?: (file: File, objectId: string) => Promise<string>;
+    /**
+     * Receives a 640x360 JPEG of the scene for a projects list: once the model
+     * has loaded if `hasThumbnail` is false, then after local edits, whenever the
+     * editor has gone quiet. Rejecting tries again later.
+     */
+    onThumbnailCapture?: (image: Blob) => Promise<void>;
+    /** Whether the project already has a picture. Defaults to false. */
+    hasThumbnail?: boolean;
     /** Requests/releases a short collaborative lease around gizmo edits. */
     onEditLeaseChange?: (featureId: string, editing: boolean) => void;
     /**
@@ -137,7 +155,7 @@ type ProjectBindingBuilderProps = BindingBuilderProps & {
      */
     allowModelChange?: boolean;
 };
-declare function ProjectBindingBuilder({ licenseKey, licenseValidationUrl, arHandoff, mobileHandoffUrl, dracoDecoderPath, ktx2TranscoderPath, meshopt, project, onProjectChange, projectChangeDebounceMs, onModelUpload, onTextureUpload, onEditLeaseChange, allowModelChange, hideLicenseCheckingOverlay, }: ProjectBindingBuilderProps): react.JSX.Element;
+declare function ProjectBindingBuilder({ topBarStart, configurePublish, licenseKey, licenseValidationUrl, arHandoff, mobileHandoffUrl, dracoDecoderPath, ktx2TranscoderPath, meshopt, project, onProjectChange, projectChangeDebounceMs, onModelUpload, onTextureUpload, onThumbnailCapture, hasThumbnail, onEditLeaseChange, allowModelChange, hideLicenseCheckingOverlay, }: ProjectBindingBuilderProps): react.JSX.Element;
 
 /** A model's view of the scene: the shared settings plus its own. */
 declare function sceneConfigForModel(sceneConfig: SceneConfig, model: BindingBuilderProjectModel): SceneConfig;