@liveroom-tech/react-immersive 3.0.0 → 4.0.1

package/dist/utils-BUwXD_DX.d.mts

@@ -0,0 +1,563 @@
+declare const LIGHT_TYPES: readonly ["none", "directional", "point", "spot", "hemisphere"];
+type SceneLightType = (typeof LIGHT_TYPES)[number];
+type SceneLightAttachment = {
+    /** Binding key, binding id, modelObjectId, or raw model node name. */
+    objectId: string;
+    /** Local-space offset from the attached model object. */
+    offset: [number, number, number];
+};
+type SceneLight = {
+    id: string;
+    type: SceneLightType;
+    color: string;
+    intensity: number;
+    position: [number, number, number];
+    /** Point-light range. Zero means no distance limit. */
+    distance?: number;
+    /** Point-light physically correct decay. */
+    decay?: number;
+    angle?: number;
+    penumbra?: number;
+    attachedToCamera: boolean;
+    /** Follow a model object instead of using the world-space position. */
+    attachment?: SceneLightAttachment;
+    castShadow: boolean;
+    shadowBias: number;
+    visible: boolean;
+};
+type SceneLightingConfig = {
+    ambient: {
+        intensity: number;
+        color: string;
+    };
+    lights: SceneLight[];
+};
+declare const SCENE_MODEL_RENDERERS: readonly ["pbr", "matcap", "uv-checker"];
+type SceneModelRenderer = (typeof SCENE_MODEL_RENDERERS)[number];
+type SceneModelConfig = {
+    rotation: [number, number, number];
+    showAdvancedRotation: boolean;
+    renderer: SceneModelRenderer;
+    shading: "lit" | "unlit" | "normals";
+};
+type SceneCameraConfig = {
+    fieldOfView: number;
+    showAdvancedSettings: boolean;
+};
+type SceneShadowConfig = {
+    enabled: boolean;
+    mapSize: number;
+    bias: number;
+    normalBias: number;
+    radius: number;
+};
+declare const ENVIRONMENT_PRESETS: readonly ["apartment", "city", "dawn", "forest", "lobby", "night", "park", "studio", "sunset", "warehouse"];
+type EnvironmentPreset = (typeof ENVIRONMENT_PRESETS)[number];
+type SceneEnvironmentConfig = {
+    source: "preset" | "custom";
+    preset: EnvironmentPreset;
+    customEnvironmentUrl: string;
+    intensity: number;
+    rotation: number;
+    shadowLight: {
+        enabled: boolean;
+        intensity: number;
+        bias: number;
+    };
+};
+type SceneWireframeConfig = {
+    enabled: boolean;
+    color: string;
+    opacity: number;
+};
+type SceneBackgroundConfig = {
+    enabled: boolean;
+    type: "environment" | "image" | "color";
+    color: string;
+    imageUrl: string;
+};
+type SceneGroundShadowConfig = {
+    enabled: boolean;
+    mode: "shadowCatcher" | "bakedAO";
+    intensity: number;
+    borderFade: number;
+    height: number;
+    size: number;
+};
+declare const ANIMATION_LOOP_MODES: readonly ["repeat", "once"];
+type AnimationLoopMode = (typeof ANIMATION_LOOP_MODES)[number];
+type SceneAnimationClipConfig = {
+    sourceName: string;
+    displayName: string;
+    hidden: boolean;
+    loopMode: AnimationLoopMode;
+    speed: number;
+};
+type SceneAnimationConfig = {
+    clips: SceneAnimationClipConfig[];
+    autoplayClip: string | null;
+};
+declare const GLITCH_MODES: readonly ["sporadic", "constantMild", "constantWild"];
+type GlitchModeName = (typeof GLITCH_MODES)[number];
+declare const RAMP_TYPES: readonly ["linear", "radial", "mirroredLinear"];
+type RampTypeName = (typeof RAMP_TYPES)[number];
+declare const KERNEL_SIZE_NAMES: readonly ["verySmall", "small", "medium", "large", "veryLarge", "huge"];
+type KernelSizeName = (typeof KERNEL_SIZE_NAMES)[number];
+type ScenePostProcessingConfig = {
+    autofocus: {
+        enabled: boolean;
+        focusDistance: number;
+        focusRange: number;
+        focalLength: number;
+        bokehScale: number;
+        target: [number, number, number];
+        mouse: boolean;
+        debug: number;
+        manual: boolean;
+        smoothTime: number;
+    };
+    toneMapping: {
+        enabled: boolean;
+        mode: "linear" | "reinhard" | "aces";
+        exposure: number;
+        resolution: number;
+        whitePoint: number;
+        middleGrey: number;
+        minLuminance: number;
+        averageLuminance: number;
+        adaptationRate: number;
+    };
+    brightnessContrast: {
+        enabled: boolean;
+        brightness: number;
+        contrast: number;
+    };
+    hueSaturation: {
+        enabled: boolean;
+        hue: number;
+        saturation: number;
+    };
+    colorAverage: {
+        enabled: boolean;
+    };
+    dotScreen: {
+        enabled: boolean;
+        angle: number;
+        scale: number;
+    };
+    glitch: {
+        enabled: boolean;
+        mode: GlitchModeName;
+        delay: [number, number];
+        duration: [number, number];
+        strength: [number, number];
+        chromaticAberrationOffset: [number, number];
+        columns: number;
+        ratio: number;
+    };
+    ssao: {
+        enabled: boolean;
+        samples: number;
+        rings: number;
+        intensity: number;
+        radius: number;
+        bias: number;
+        luminanceInfluence: number;
+        fade: number;
+        minRadiusScale: number;
+        worldDistanceThreshold: number;
+        worldDistanceFalloff: number;
+        worldProximityThreshold: number;
+        worldProximityFalloff: number;
+    };
+    bloom: {
+        enabled: boolean;
+        intensity: number;
+        luminanceThreshold: number;
+        luminanceSmoothing: number;
+        mipmapBlur: boolean;
+        radius: number;
+        levels: number;
+    };
+    godRays: {
+        enabled: boolean;
+        sunPosition: [number, number, number];
+        samples: number;
+        density: number;
+        decay: number;
+        weight: number;
+        exposure: number;
+        clampMax: number;
+        blur: boolean;
+        kernelSize: KernelSizeName;
+    };
+    grid: {
+        enabled: boolean;
+        scale: number;
+        lineWidth: number;
+    };
+    noise: {
+        enabled: boolean;
+        opacity: number;
+        premultiply: boolean;
+    };
+    depthOfField: {
+        enabled: boolean;
+        focusDistance: number;
+        focusRange: number;
+        focalLength: number;
+        bokehScale: number;
+    };
+    chromaticAberration: {
+        enabled: boolean;
+        offsetX: number;
+        offsetY: number;
+        radialModulation: boolean;
+        modulationOffset: number;
+    };
+    lensflare: {
+        enabled: boolean;
+        lensPosition: [number, number, number];
+        smoothTime: number;
+        glareSize: number;
+        flareSize: number;
+        flareSpeed: number;
+        flareShape: number;
+        animated: boolean;
+        anamorphic: boolean;
+        colorGain: string;
+        haloScale: number;
+        secondaryGhosts: boolean;
+        aditionalStreaks: boolean;
+        ghostScale: number;
+        opacity: number;
+        starBurst: boolean;
+    };
+    vignette: {
+        enabled: boolean;
+        offset: number;
+        darkness: number;
+        eskil: boolean;
+    };
+    smaa: {
+        enabled: boolean;
+    };
+    sepia: {
+        enabled: boolean;
+        intensity: number;
+    };
+    scanline: {
+        enabled: boolean;
+        density: number;
+    };
+    pixelation: {
+        enabled: boolean;
+        granularity: number;
+    };
+    outline: {
+        enabled: boolean;
+        selectionLayer: number;
+        edgeStrength: number;
+        pulseSpeed: number;
+        visibleEdgeColor: string;
+        hiddenEdgeColor: string;
+        kernelSize: KernelSizeName;
+        blur: boolean;
+        xRay: boolean;
+    };
+    selectiveBloom: {
+        enabled: boolean;
+        selectionLayer: number;
+        intensity: number;
+        luminanceThreshold: number;
+        luminanceSmoothing: number;
+        kernelSize: KernelSizeName;
+        mipmapBlur: boolean;
+        inverted: boolean;
+        ignoreBackground: boolean;
+    };
+    ramp: {
+        enabled: boolean;
+        rampType: RampTypeName;
+        rampStart: [number, number];
+        rampEnd: [number, number];
+        startColor: string;
+        endColor: string;
+        opacity?: number;
+        rampBias: number;
+        rampGain: number;
+        rampMask: boolean;
+        rampInvert: boolean;
+    };
+};
+type SceneAnnotationMarker = {
+    id: number;
+    worldPosition: [number, number, number];
+    localPosition: [number, number, number];
+    worldNormal?: [number, number, number];
+    anchorNodeName?: string;
+    anchorLocalPosition?: [number, number, number];
+    title: string;
+    description: string;
+};
+type SceneCinematicWaypoint = {
+    position: [number, number, number];
+    target: [number, number, number];
+    azimuthAngle?: number;
+    polarAngle?: number;
+    segmentDuration?: number;
+};
+type SceneCinematicConfig = {
+    enabled: boolean;
+    waypoints: SceneCinematicWaypoint[];
+    duration?: number;
+    loop: boolean;
+    autoPlay: boolean;
+};
+type SceneConfig = {
+    model: SceneModelConfig;
+    camera: SceneCameraConfig;
+    lighting: SceneLightingConfig;
+    wireframe: SceneWireframeConfig;
+    shadows: SceneShadowConfig;
+    environment: SceneEnvironmentConfig;
+    background: SceneBackgroundConfig;
+    groundShadows: SceneGroundShadowConfig;
+    postProcessing: ScenePostProcessingConfig;
+    animations: SceneAnimationConfig;
+    annotations: SceneAnnotationMarker[];
+    cinematic?: SceneCinematicConfig;
+};
+declare const DEFAULT_SCENE_CONFIG: SceneConfig;
+
+type ViewerCameraState = {
+    position: [number, number, number];
+    target: [number, number, number];
+    fov: number | null;
+    zoom: number;
+    azimuthAngle?: number;
+    polarAngle?: number;
+};
+
+type DeepPartial<T> = T extends readonly unknown[] ? T : T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+
+type ObjectBindingSelector = {
+    group: string;
+} | {
+    tag: string;
+} | {
+    type: ObjectBindingType;
+};
+type ObjectBindingTarget = string | readonly string[] | ObjectBindingSelector;
+/**
+ * Resolves IDs and selectors to binding-map keys in stable record order.
+ * Explicit ID arrays keep their supplied order. Duplicate matches are removed.
+ */
+declare function selectBindingKeys(bindings: Record<string, ObjectBinding>, target: ObjectBindingTarget): string[];
+/** Selects bindings by ID, group, tag, or binding type. */
+declare function selectBindings(bindings: Record<string, ObjectBinding>, target: ObjectBindingTarget): ObjectBinding[];
+
+type ObjectBindingPatch = DeepPartial<ObjectBinding>;
+type BindingEdit = {
+    ids: ObjectBindingTarget;
+    patch: ObjectBindingPatch;
+};
+/**
+ * Applies field-level patches to object bindings and returns the updated
+ * record. Pure — nothing is mutated, and the original reference comes back
+ * untouched when no id matched, so React can skip the re-render.
+ *
+ * Ids resolve the same way everywhere else in the library: binding key first,
+ * then `binding.id`, then `binding.modelObjectId`.
+ */
+declare function patchBindings(bindings: Record<string, ObjectBinding>, target: ObjectBindingTarget, patch: ObjectBindingPatch): Record<string, ObjectBinding>;
+declare function patchBindings(bindings: Record<string, ObjectBinding>, edits: BindingEdit[]): Record<string, ObjectBinding>;
+/** Shorthand for the common `{ style: { material: … } }` nesting. */
+declare function material(value: ObjectBindingMaterial): ObjectBindingPatch;
+
+type SceneConfigPatch = DeepPartial<SceneConfig>;
+/**
+ * Applies a nested scene-config patch without mutating either input. Objects
+ * are merged recursively, while arrays and tuples are replaced wholesale.
+ */
+declare function patchSceneConfig(sceneConfig: SceneConfig, patch: SceneConfigPatch): SceneConfig;
+
+type ObjectBindingsActionEffect = {
+    target: ObjectBindingTarget;
+    objectBindings: ObjectBindingPatch;
+};
+type SceneConfigActionEffect = {
+    sceneConfig: SceneConfigPatch;
+};
+type VisibilityActionEffect = {
+    target: ObjectBindingTarget;
+    visibility: "show" | "hide" | "toggle";
+};
+type CameraAction = {
+    type: "focus-object";
+    objectId?: string;
+} | {
+    type: "fit-scene";
+} | {
+    type: "reset";
+} | {
+    type: "set-target";
+    target: [number, number, number];
+    transition?: boolean;
+} | {
+    type: "set-state";
+    state: ViewerCameraState;
+    transition?: boolean;
+};
+type CameraActionEffect = {
+    camera: CameraAction;
+};
+type AnimationAction = {
+    type: "play";
+    clip: string;
+} | {
+    type: "pause";
+} | {
+    type: "stop";
+} | {
+    type: "set-speed";
+    speed: number;
+} | {
+    type: "seek";
+    time: number;
+};
+type AnimationActionEffect = {
+    animation: AnimationAction;
+};
+type ObjectActionEffect = ObjectBindingsActionEffect | SceneConfigActionEffect | VisibilityActionEffect | CameraActionEffect | AnimationActionEffect;
+
+type ObjectBindingAction = {
+    id: "change-color" | "apply-texture" | "toggle-visibility" | string;
+    label: string;
+    type: "command";
+    effects?: ObjectActionEffect[];
+};
+type ObjectBindingType = "body" | "other" | "glass" | "windshield" | "rear-windshield" | "window" | "sunroof" | "wheel" | "rim" | "tire" | "brake-caliper" | "brake-disc" | "suspension" | "spring" | "shock-absorber" | "axle" | "control-arm" | "interior" | "seat" | "headrest" | "seatbelt" | "dashboard" | "steering-wheel" | "gear-shift" | "center-console" | "armrest" | "door-panel" | "carpet" | "headliner" | "sun-visor" | "pedal" | "instrument-cluster" | "infotainment" | "glove-box" | "engine" | "gearbox" | "radiator" | "battery" | "fuel-tank" | "air-filter" | "intercooler" | "alternator" | "turbo" | "light" | "headlight" | "taillight" | "fog-light" | "indicator" | "daytime-running-light" | "interior-light" | "ambient-light" | "floor" | "floor-tile" | "floor-board" | "floor-mat" | "ceiling" | "ceiling-tile" | "wall" | "wall-tile" | "wall-panel" | "wall-trim" | "baseboard" | "crown-molding" | "column" | "pillar" | "beam" | "arch" | "stairs" | "step" | "railing" | "balustrade" | "window-frame" | "window-sill" | "blind" | "curtain" | "shutter" | "door" | "door-frame" | "door-knob" | "furniture" | "sofa" | "armchair" | "ottoman" | "bed" | "headboard" | "mattress" | "nightstand" | "dresser" | "wardrobe" | "closet" | "shelf" | "bookcase" | "desk" | "office-chair" | "dining-table" | "dining-chair" | "bar-stool" | "bench" | "cabinet" | "sideboard" | "coffee-table" | "side-table" | "tv-stand" | "kitchen-island" | "countertop" | "sink" | "bathtub" | "shower" | "toilet" | "vanity" | "decor" | "rug" | "cushion" | "throw" | "curtain-rod" | "artwork" | "mirror" | "vase" | "plant" | "pot" | "candle" | "frame" | "sculpture" | "clock" | "lamp" | "floor-lamp" | "table-lamp" | "pendant-light" | "chandelier" | "sconce" | "ceiling-fan" | "electronics" | "tv" | "monitor" | "speaker" | "soundbar" | "projector" | "remote" | "console" | "router" | "smart-hub" | "thermostat" | "appliance" | "refrigerator" | "oven" | "microwave" | "dishwasher" | "washing-machine" | "dryer" | "air-conditioner" | "heater" | "ventilation" | "root" | "bone" | "joint" | "socket" | "pivot" | "head" | "face" | "eye" | "eyelid" | "eyebrow" | "mouth" | "teeth" | "tongue" | "ear" | "nose" | "hair" | "beard" | "neck" | "torso" | "chest" | "abdomen" | "back" | "shoulder" | "upper-arm" | "forearm" | "hand" | "finger" | "thumb" | "hip" | "thigh" | "shin" | "foot" | "toe" | "tail" | "wing" | "tentacle" | "clothing" | "hat" | "helmet" | "visor" | "mask" | "goggles" | "glasses" | "jacket" | "shirt" | "pants" | "skirt" | "shoes" | "boots" | "gloves" | "belt" | "watch" | "bag" | "backpack" | "jewelry" | "necklace" | "ring" | "armor" | "chest-plate" | "pauldron" | "gauntlet" | "greave" | "shield" | "weapon" | "blade" | "edge" | "tip" | "guard" | "grip" | "pommel" | "barrel" | "stock" | "scope" | "trigger" | "magazine" | "muzzle" | "gear" | "piston" | "lever" | "valve" | "pump" | "motor" | "rotor" | "blade-prop" | "nozzle" | "pipe" | "tube" | "cable" | "wire" | "connector" | "panel" | "hatch" | "vent" | "antenna" | "sensor" | "camera" | "screen" | "dial" | "button" | "knob" | "switch" | "gauge" | "terrain" | "ground" | "rock" | "cliff" | "water" | "ocean" | "river" | "lake" | "wave" | "foam" | "sky" | "cloud" | "sun" | "moon" | "star" | "fog" | "foliage" | "tree" | "branch" | "leaf" | "grass" | "bush" | "flower" | "soil" | "sand" | "snow" | "ice" | "facade" | "foundation" | "roof-structure" | "chimney" | "balcony" | "porch" | "pathway" | "fence" | "gate" | "wall-exterior";
+type ObjectBindingStatus = "normal" | "hidden" | "selected" | "disabled";
+type ObjectBindingTextureSlot = {
+    path: string;
+};
+type ObjectBindingTextureChannel = "baseColor" | "metalness" | "roughness" | "emissive" | "alpha" | "normal" | "bump" | "ao" | "displacement" | "clearcoat" | "clearcoatRoughness" | "clearcoatNormal" | "anisotropy" | "transmission" | "thickness" | "sheenColor" | "sheenRoughness" | "specularIntensity" | "specularColor";
+type ObjectBindingTransform = {
+    /** Local-space position in model units. */
+    position?: [number, number, number];
+    /** Local-space Euler rotation in radians. */
+    rotation?: [number, number, number];
+    /** Local-space scale. */
+    scale?: [number, number, number];
+};
+declare const MATERIAL_SIDES: readonly ["front", "back", "double"];
+type ObjectBindingMaterialSide = (typeof MATERIAL_SIDES)[number];
+declare const MATERIAL_BLENDING_MODES: readonly ["normal", "additive"];
+type ObjectBindingMaterialBlendingMode = (typeof MATERIAL_BLENDING_MODES)[number];
+type ObjectBindingMaterial = {
+    texture?: ObjectBindingTextureSlot;
+    baseColor?: string;
+    metalness?: number;
+    metalnessMap?: ObjectBindingTextureSlot;
+    roughness?: number;
+    roughnessMap?: ObjectBindingTextureSlot;
+    emissive?: string;
+    emissiveIntensity?: number;
+    emissiveMap?: ObjectBindingTextureSlot;
+    opacity?: number;
+    alphaMap?: ObjectBindingTextureSlot;
+    alphaTest?: number;
+    alphaHash?: boolean;
+    dithering?: boolean;
+    blendingMode?: ObjectBindingMaterialBlendingMode;
+    side?: ObjectBindingMaterialSide;
+    normalMap?: ObjectBindingTextureSlot;
+    normalScale?: number;
+    flipNormalY?: boolean;
+    bumpMap?: ObjectBindingTextureSlot;
+    bumpScale?: number;
+    aoMap?: ObjectBindingTextureSlot;
+    aoMapIntensity?: number;
+    displacementMap?: ObjectBindingTextureSlot;
+    displacementScale?: number;
+    displacementBias?: number;
+    clearcoat?: number;
+    clearcoatMap?: ObjectBindingTextureSlot;
+    clearcoatRoughness?: number;
+    clearcoatRoughnessMap?: ObjectBindingTextureSlot;
+    clearcoatNormalMap?: ObjectBindingTextureSlot;
+    clearcoatNormalScale?: number;
+    flipClearcoatNormalY?: boolean;
+    sheen?: number;
+    sheenColor?: string;
+    sheenColorMap?: ObjectBindingTextureSlot;
+    sheenRoughness?: number;
+    sheenRoughnessMap?: ObjectBindingTextureSlot;
+    anisotropy?: number;
+    anisotropyRotation?: number;
+    anisotropyMap?: ObjectBindingTextureSlot;
+    transmission?: number;
+    transmissionMap?: ObjectBindingTextureSlot;
+    thickness?: number;
+    thicknessMap?: ObjectBindingTextureSlot;
+    attenuationColor?: string;
+    attenuationDistance?: number;
+    reflectivity?: number;
+    specularIntensity?: number;
+    specularIntensityMap?: ObjectBindingTextureSlot;
+    specularColor?: string;
+    specularColorMap?: ObjectBindingTextureSlot;
+};
+type ObjectBindingCameraState = {
+    position?: [number, number, number];
+    target?: [number, number, number];
+    fov?: number;
+    zoom?: number;
+};
+type ObjectBindingStyle = {
+    material?: ObjectBindingMaterial;
+};
+type ObjectBinding = {
+    id: string;
+    type: ObjectBindingType;
+    modelObjectId: string;
+    label?: string;
+    group?: string;
+    tags?: string[];
+    status?: ObjectBindingStatus;
+    visible?: boolean;
+    selectable?: boolean;
+    hoverable?: boolean;
+    transform?: ObjectBindingTransform;
+    style?: ObjectBindingStyle;
+    actions?: ObjectBindingAction[];
+    metrics?: Record<string, number>;
+    metadata?: Record<string, unknown>;
+    cameraState?: ObjectBindingCameraState;
+};
+type ObjectActionEvent = {
+    objectId: string;
+    action: ObjectBindingAction;
+    binding?: ObjectBinding;
+    screenX?: number;
+    screenY?: number;
+};
+
+/**
+ * Validates an object-bindings literal while preserving its exact keys and
+ * literal values for TypeScript autocomplete and derived union types.
+ *
+ * This is an identity function at runtime.
+ */
+declare function defineObjectBindings<const TBindings extends Record<string, ObjectBinding>>(bindings: TBindings): TBindings;
+/** Binding-map keys preserved by defineObjectBindings. */
+type ObjectBindingKey<TBindings extends Record<string, ObjectBinding>> = Extract<keyof TBindings, string>;
+/** Action ids declared on one binding in a defined bindings map. */
+type ObjectBindingActionId<TBindings extends Record<string, ObjectBinding>, TKey extends ObjectBindingKey<TBindings>> = TBindings[TKey]["actions"] extends readonly (infer TAction)[] ? TAction extends {
+    id: infer TId extends string;
+} ? TId : never : never;
+
+export { type AnimationAction as A, type BindingEdit as B, type CameraAction as C, DEFAULT_SCENE_CONFIG as D, type SceneLight as E, type SceneLightAttachment as F, type SceneLightType as G, type SceneModelRenderer as H, type VisibilityActionEffect as I, defineObjectBindings as J, material as K, patchBindings as L, MATERIAL_BLENDING_MODES as M, patchSceneConfig as N, type ObjectActionEffect as O, selectBindingKeys as P, selectBindings as Q, type SceneAnimationClipConfig as S, type ViewerCameraState as V, type AnimationActionEffect as a, type AnimationLoopMode as b, type CameraActionEffect as c, MATERIAL_SIDES as d, type ObjectActionEvent as e, type ObjectBinding as f, type ObjectBindingAction as g, type ObjectBindingActionId as h, type ObjectBindingKey as i, type ObjectBindingMaterial as j, type ObjectBindingMaterialBlendingMode as k, type ObjectBindingMaterialSide as l, type ObjectBindingPatch as m, type ObjectBindingSelector as n, type ObjectBindingTarget as o, type ObjectBindingTextureChannel as p, type ObjectBindingTextureSlot as q, type ObjectBindingTransform as r, type ObjectBindingsActionEffect as s, type SceneAnimationConfig as t, type SceneAnnotationMarker as u, type SceneCinematicConfig as v, type SceneCinematicWaypoint as w, type SceneConfig as x, type SceneConfigActionEffect as y, type SceneConfigPatch as z };