@liveroom-tech/react-immersive 5.2.0 → 6.0.0

package/dist/hosted.d.mts

@@ -1,11 +1,9 @@
 import * as react from 'react';
-import { RefObject } from 'react';
-import { o as ObjectBinding, a1 as SceneConfig } from './rendererBackend-QwMzISTn.mjs';
-import { B as BindingBuilderProps } from './publicProps-tJuWZgT3.mjs';
+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 { Object3D } from 'three';
-import { l as ModelViewerProps } from './modelViewerProps-DoRiTZMn.mjs';
-import './materialVariants-DnZe9eMC.mjs';
-import './modelInfo-BYebMPdZ.mjs';
+import './modelFileResolver-Co7j1tdQ.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"];
@@ -23,6 +21,8 @@ type ProjectModelViewerProps = ModelViewerProps & {
      * service, so this cannot approve a licence by itself.
      */
     licenseValidationUrl?: string;
+    /** An explicit clear command, distinct from clicking empty canvas space. */
+    onSelectionClear?: () => void;
     /** Reports transform-gizmo edit leases for collaborative hosts. */
     onObjectEditLeaseChange?: (binding: ObjectBinding, editing: boolean) => void;
     /** The loaded three.js scene, which the editor builds bindings from. */
@@ -40,11 +40,17 @@ type ProjectModelViewerProps = ModelViewerProps & {
      * Receives a function that ends Move/Zoom mode the way a plain canvas click
      * does, for the editor's own "Done positioning" button.
      */
-    endTexturePositioningRef?: RefObject<(() => void) | null>;
+    endTexturePositioningRef?: MutableRefObject<(() => void) | null>;
 };
 declare function ProjectModelViewer(props: ProjectModelViewerProps): react.JSX.Element;
 
-type BindingBuilderProjectModel = {
+/** Settings whose names or positions belong to a particular model. */
+type ModelSettings = Pick<SceneConfig, "annotations" | "animations" | "measurements" | "selectionSets" | "sequences"> & {
+    activeVariants?: string[];
+};
+
+/** Where a model's files are: what an upload returns. */
+type BindingBuilderModelSource = {
     url: string;
     name?: string;
     assetId?: string | null;
@@ -56,18 +62,33 @@ type BindingBuilderProjectModel = {
     tilesetUrl?: string | null;
     assetVersion?: string | null;
 };
+/** One model of a project. Its `url` identifies it within the project. */
+type BindingBuilderProjectModel = BindingBuilderModelSource & {
+    objectBindings: Record<string, ObjectBinding>;
+    /** Files whose nodes were spliced into this model. */
+    mergeModels?: {
+        url: string;
+        assetId?: string | null;
+        namePrefix: string;
+    }[];
+    /** The scene settings that belong to this model, such as its annotations. */
+    modelSettings?: ModelSettings;
+};
 type BindingBuilderProject = {
     id: string;
     revision: number;
-    model: BindingBuilderProjectModel;
-    objectBindings: Record<string, ObjectBinding>;
+    /** In display order. A removed model stays, marked deleted in `composition`. */
+    models: BindingBuilderProjectModel[];
+    /** Each model's placement, keyed by `url:<model url>`. */
+    composition: SceneComposition;
+    /** The settings all the models share. */
     sceneConfig: SceneConfig;
 };
 type BindingBuilderProjectSnapshot = {
     projectId: string;
     baseRevision: number;
-    model: BindingBuilderProjectModel;
-    objectBindings: Record<string, ObjectBinding>;
+    models: BindingBuilderProjectModel[];
+    composition: SceneComposition;
     sceneConfig: SceneConfig;
 };
 type BindingBuilderProjectChangeOrigin = "local" | "remote";
@@ -101,18 +122,26 @@ type ProjectBindingBuilderProps = BindingBuilderProps & {
      * Lets a hosted editor upload a selected model before it is loaded. Return
      * the durable model URL/version that should be saved with the project.
      */
-    onModelUpload?: (file: File) => Promise<BindingBuilderProject["model"]>;
+    onModelUpload?: (file: File) => Promise<BindingBuilderModelSource>;
+    /**
+     * Saves an image chosen in the editor and returns its durable URL. With a
+     * `project`, every image goes through this before it is reported.
+     */
     onTextureUpload?: (file: File, objectId: string) => Promise<string>;
     /** Requests/releases a short collaborative lease around gizmo edits. */
     onEditLeaseChange?: (featureId: string, editing: boolean) => void;
     /**
-     * Whether the model itself may be replaced or removed. False hides the
-     * Remove model and Upload controls and ignores picked or dropped files;
-     * bindings and scene settings stay editable. Defaults to true. Remove model
-     * never appears with a `project`, which always has a model.
+     * Whether models may be replaced, added or removed. False hides those
+     * controls and ignores picked or dropped files; bindings and scene settings
+     * stay editable. Defaults to true.
      */
     allowModelChange?: boolean;
 };
-declare function ProjectBindingBuilder({ licenseKey, licenseValidationUrl, dracoDecoderPath, ktx2TranscoderPath, meshopt, project, onProjectChange, projectChangeDebounceMs, onModelUpload, onTextureUpload, onEditLeaseChange, allowModelChange, }: ProjectBindingBuilderProps): react.JSX.Element;
+declare function ProjectBindingBuilder({ licenseKey, licenseValidationUrl, arHandoff, mobileHandoffUrl, dracoDecoderPath, ktx2TranscoderPath, meshopt, project, onProjectChange, projectChangeDebounceMs, onModelUpload, onTextureUpload, 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;
+/** The models to hand ModelViewer, or undefined for a project of one. */
+declare function viewerModelsFromProject(project: Pick<BindingBuilderProject, "models" | "composition" | "sceneConfig">): ModelViewerModelEntry[] | undefined;
 
-export { type BindingBuilderProject, type BindingBuilderProjectChangeOrigin, type BindingBuilderProjectModel, type BindingBuilderProjectSnapshot, ProjectBindingBuilder, type ProjectBindingBuilderProps, ProjectModelViewer, type ProjectModelViewerProps };
+export { type BindingBuilderModelSource, type BindingBuilderProject, type BindingBuilderProjectChangeOrigin, type BindingBuilderProjectModel, type BindingBuilderProjectSnapshot, ProjectBindingBuilder, type ProjectBindingBuilderProps, ProjectModelViewer, type ProjectModelViewerProps, sceneConfigForModel, viewerModelsFromProject };

package/dist/hosted.d.ts

@@ -1,11 +1,9 @@
 import * as react from 'react';
-import { RefObject } from 'react';
-import { o as ObjectBinding, a1 as SceneConfig } from './rendererBackend-QwMzISTn.js';
-import { B as BindingBuilderProps } from './publicProps-tJuWZgT3.js';
+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 { Object3D } from 'three';
-import { l as ModelViewerProps } from './modelViewerProps-CIZ2R_Fv.js';
-import './materialVariants-DnZe9eMC.js';
-import './modelInfo-XfUQO7C_.js';
+import './modelFileResolver-Co7j1tdQ.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"];
@@ -23,6 +21,8 @@ type ProjectModelViewerProps = ModelViewerProps & {
      * service, so this cannot approve a licence by itself.
      */
     licenseValidationUrl?: string;
+    /** An explicit clear command, distinct from clicking empty canvas space. */
+    onSelectionClear?: () => void;
     /** Reports transform-gizmo edit leases for collaborative hosts. */
     onObjectEditLeaseChange?: (binding: ObjectBinding, editing: boolean) => void;
     /** The loaded three.js scene, which the editor builds bindings from. */
@@ -40,11 +40,17 @@ type ProjectModelViewerProps = ModelViewerProps & {
      * Receives a function that ends Move/Zoom mode the way a plain canvas click
      * does, for the editor's own "Done positioning" button.
      */
-    endTexturePositioningRef?: RefObject<(() => void) | null>;
+    endTexturePositioningRef?: MutableRefObject<(() => void) | null>;
 };
 declare function ProjectModelViewer(props: ProjectModelViewerProps): react.JSX.Element;
 
-type BindingBuilderProjectModel = {
+/** Settings whose names or positions belong to a particular model. */
+type ModelSettings = Pick<SceneConfig, "annotations" | "animations" | "measurements" | "selectionSets" | "sequences"> & {
+    activeVariants?: string[];
+};
+
+/** Where a model's files are: what an upload returns. */
+type BindingBuilderModelSource = {
     url: string;
     name?: string;
     assetId?: string | null;
@@ -56,18 +62,33 @@ type BindingBuilderProjectModel = {
     tilesetUrl?: string | null;
     assetVersion?: string | null;
 };
+/** One model of a project. Its `url` identifies it within the project. */
+type BindingBuilderProjectModel = BindingBuilderModelSource & {
+    objectBindings: Record<string, ObjectBinding>;
+    /** Files whose nodes were spliced into this model. */
+    mergeModels?: {
+        url: string;
+        assetId?: string | null;
+        namePrefix: string;
+    }[];
+    /** The scene settings that belong to this model, such as its annotations. */
+    modelSettings?: ModelSettings;
+};
 type BindingBuilderProject = {
     id: string;
     revision: number;
-    model: BindingBuilderProjectModel;
-    objectBindings: Record<string, ObjectBinding>;
+    /** In display order. A removed model stays, marked deleted in `composition`. */
+    models: BindingBuilderProjectModel[];
+    /** Each model's placement, keyed by `url:<model url>`. */
+    composition: SceneComposition;
+    /** The settings all the models share. */
     sceneConfig: SceneConfig;
 };
 type BindingBuilderProjectSnapshot = {
     projectId: string;
     baseRevision: number;
-    model: BindingBuilderProjectModel;
-    objectBindings: Record<string, ObjectBinding>;
+    models: BindingBuilderProjectModel[];
+    composition: SceneComposition;
     sceneConfig: SceneConfig;
 };
 type BindingBuilderProjectChangeOrigin = "local" | "remote";
@@ -101,18 +122,26 @@ type ProjectBindingBuilderProps = BindingBuilderProps & {
      * Lets a hosted editor upload a selected model before it is loaded. Return
      * the durable model URL/version that should be saved with the project.
      */
-    onModelUpload?: (file: File) => Promise<BindingBuilderProject["model"]>;
+    onModelUpload?: (file: File) => Promise<BindingBuilderModelSource>;
+    /**
+     * Saves an image chosen in the editor and returns its durable URL. With a
+     * `project`, every image goes through this before it is reported.
+     */
     onTextureUpload?: (file: File, objectId: string) => Promise<string>;
     /** Requests/releases a short collaborative lease around gizmo edits. */
     onEditLeaseChange?: (featureId: string, editing: boolean) => void;
     /**
-     * Whether the model itself may be replaced or removed. False hides the
-     * Remove model and Upload controls and ignores picked or dropped files;
-     * bindings and scene settings stay editable. Defaults to true. Remove model
-     * never appears with a `project`, which always has a model.
+     * Whether models may be replaced, added or removed. False hides those
+     * controls and ignores picked or dropped files; bindings and scene settings
+     * stay editable. Defaults to true.
      */
     allowModelChange?: boolean;
 };
-declare function ProjectBindingBuilder({ licenseKey, licenseValidationUrl, dracoDecoderPath, ktx2TranscoderPath, meshopt, project, onProjectChange, projectChangeDebounceMs, onModelUpload, onTextureUpload, onEditLeaseChange, allowModelChange, }: ProjectBindingBuilderProps): react.JSX.Element;
+declare function ProjectBindingBuilder({ licenseKey, licenseValidationUrl, arHandoff, mobileHandoffUrl, dracoDecoderPath, ktx2TranscoderPath, meshopt, project, onProjectChange, projectChangeDebounceMs, onModelUpload, onTextureUpload, 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;
+/** The models to hand ModelViewer, or undefined for a project of one. */
+declare function viewerModelsFromProject(project: Pick<BindingBuilderProject, "models" | "composition" | "sceneConfig">): ModelViewerModelEntry[] | undefined;
 
-export { type BindingBuilderProject, type BindingBuilderProjectChangeOrigin, type BindingBuilderProjectModel, type BindingBuilderProjectSnapshot, ProjectBindingBuilder, type ProjectBindingBuilderProps, ProjectModelViewer, type ProjectModelViewerProps };
+export { type BindingBuilderModelSource, type BindingBuilderProject, type BindingBuilderProjectChangeOrigin, type BindingBuilderProjectModel, type BindingBuilderProjectSnapshot, ProjectBindingBuilder, type ProjectBindingBuilderProps, ProjectModelViewer, type ProjectModelViewerProps, sceneConfigForModel, viewerModelsFromProject };