@webspatial/react-sdk 1.1.0 → 1.2.1

package/dist/default/index.d.ts

@@ -1,4 +1,4 @@
-import { SpatialSceneCreationOptions, SpatialSceneType, SpatialTapEvent as SpatialTapEvent$1, SpatialDragEvent as SpatialDragEvent$1, SpatialRotateEvent as SpatialRotateEvent$1, SpatialMagnifyEvent as SpatialMagnifyEvent$1, SpatializedElement, Point3D, SpatialObject, SpatialSession, SpatializedDynamic3DElement, Vec3, SpatialEntity, SpatialRotateEndEvent as SpatialRotateEndEvent$1, SpatialMagnifyEndEvent as SpatialMagnifyEndEvent$1, SpatialBoxGeometryOptions, SpatialUnlitMaterialOptions, SpatialSphereGeometryOptions, SpatialConeGeometryOptions, SpatialCylinderGeometryOptions, SpatialPlaneGeometryOptions } from '@webspatial/core-sdk';
+import { SpatialSceneCreationOptions, SpatialSceneType, SpatialTapEvent as SpatialTapEvent$1, SpatialDragStartEvent as SpatialDragStartEvent$1, SpatialDragEvent as SpatialDragEvent$1, SpatialDragEndEvent as SpatialDragEndEvent$1, SpatialRotateEvent as SpatialRotateEvent$1, SpatialRotateEndEvent as SpatialRotateEndEvent$1, SpatialMagnifyEvent as SpatialMagnifyEvent$1, SpatialMagnifyEndEvent as SpatialMagnifyEndEvent$1, SpatializedElement, Point3D, SpatialObject, SpatialSession, SpatializedDynamic3DElement, Vec3, SpatialEntity, SpatialBoxGeometryOptions, SpatialUnlitMaterialOptions, SpatialSphereGeometryOptions, SpatialConeGeometryOptions, SpatialCylinderGeometryOptions, SpatialPlaneGeometryOptions } from '@webspatial/core-sdk';
 export { Point3D, Vec3 } from '@webspatial/core-sdk';
 import * as React$1 from 'react';
 import React__default, { ElementType, ForwardedRef } from 'react';
@@ -17,10 +17,8 @@ type SpatialEventProps<T extends SpatializedElementRef> = {
     onSpatialDragStart?: (event: SpatialDragStartEvent<T>) => void;
     onSpatialDrag?: (event: SpatialDragEvent<T>) => void;
     onSpatialDragEnd?: (event: SpatialDragEndEvent<T>) => void;
-    onSpatialRotateStart?: (event: SpatialRotateStartEvent<T>) => void;
     onSpatialRotate?: (event: SpatialRotateEvent<T>) => void;
     onSpatialRotateEnd?: (event: SpatialRotateEndEvent<T>) => void;
-    onSpatialMagnifyStart?: (event: SpatialMagnifyStartEvent<T>) => void;
     onSpatialMagnify?: (event: SpatialMagnifyEvent<T>) => void;
     onSpatialMagnifyEnd?: (event: SpatialMagnifyEndEvent<T>) => void;
 };
@@ -29,7 +27,17 @@ interface StandardSpatializedContainerProps extends React__default.ComponentProp
     inStandardSpatializedContainer?: boolean;
     [SpatialID]: string;
 }
-type RealityProps = SpatialEventProps<SpatializedElementRef> & React__default.ComponentPropsWithRef<'div'>;
+type RealityForbiddenSpatialEventProps = {
+    onSpatialTap?: never;
+    onSpatialDragStart?: never;
+    onSpatialDrag?: never;
+    onSpatialDragEnd?: never;
+    onSpatialRotate?: never;
+    onSpatialRotateEnd?: never;
+    onSpatialMagnify?: never;
+    onSpatialMagnifyEnd?: never;
+};
+type RealityProps = React__default.ComponentPropsWithRef<'div'> & RealityForbiddenSpatialEventProps;
 type PortalSpatializedContainerProps<T extends SpatializedElementRef> = SpatialEventProps<T> & React__default.ComponentPropsWithoutRef<'div'> & {
     component: ElementType;
     spatializedContent: ElementType;
@@ -38,7 +46,7 @@ type PortalSpatializedContainerProps<T extends SpatializedElementRef> = SpatialE
     [SpatialID]: string;
 };
 type SpatializedContainerProps<T extends SpatializedElementRef> = Omit<StandardSpatializedContainerProps & PortalSpatializedContainerProps<T>, typeof SpatialID | 'onLoad' | 'onError'> & {
-    extraRefProps?: (domProxy: T) => Record<string, () => any>;
+    extraRefProps?: (domProxy: T) => Record<string, unknown>;
 };
 type Spatialized2DElementContainerProps<P extends ElementType> = SpatialEventProps<SpatializedElementRef> & React__default.ComponentPropsWithRef<'div'> & {
     component: P;
@@ -53,26 +61,31 @@ type SpatializedDivElementRef = SpatializedElementRef<HTMLDivElement>;
 type SpatializedStatic3DElementRef = SpatializedDivElementRef & {
     currentSrc: string;
     ready: Promise<ModelLoadEvent>;
-    entityTransform: DOMMatrix;
+    entityTransform: DOMMatrixReadOnly;
 };
 type CurrentTarget<T extends SpatializedElementRef> = {
     currentTarget: T;
 };
-type SpatialTapEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialTapEvent$1 & CurrentTarget<T>;
-type SpatialDragStartEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragEvent$1 & CurrentTarget<T>;
+type SpatialTapEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialTapEvent$1 & CurrentTarget<T> & {
+    readonly offsetX: number;
+    readonly offsetY: number;
+    readonly offsetZ: number;
+};
+type SpatialDragStartEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragStartEvent$1 & CurrentTarget<T> & {
+    readonly offsetX: number;
+    readonly offsetY: number;
+    readonly offsetZ: number;
+};
 type SpatialDragEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragEvent$1 & CurrentTarget<T>;
-type SpatialDragEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragEvent$1 & CurrentTarget<T>;
-type SpatialRotateStartEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialRotateEvent$1 & CurrentTarget<T>;
+type SpatialDragEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragEndEvent$1 & CurrentTarget<T>;
 type SpatialRotateEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialRotateEvent$1 & CurrentTarget<T>;
-type SpatialRotateEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialRotateEvent$1 & CurrentTarget<T>;
-type SpatialMagnifyStartEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialMagnifyEvent$1 & CurrentTarget<T>;
+type SpatialRotateEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialRotateEndEvent$1 & CurrentTarget<T>;
 type SpatialMagnifyEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialMagnifyEvent$1 & CurrentTarget<T>;
-type SpatialMagnifyEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialMagnifyEvent$1 & CurrentTarget<T>;
+type SpatialMagnifyEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialMagnifyEndEvent$1 & CurrentTarget<T>;
 type ModelSpatialTapEvent = SpatialTapEvent<SpatializedStatic3DElementRef>;
 type ModelSpatialDragStartEvent = SpatialDragStartEvent<SpatializedStatic3DElementRef>;
 type ModelSpatialDragEvent = SpatialDragEvent<SpatializedStatic3DElementRef>;
 type ModelSpatialDragEndEvent = SpatialDragEndEvent<SpatializedStatic3DElementRef>;
-type ModelSpatialRotateStartEvent = SpatialRotateStartEvent<SpatializedStatic3DElementRef>;
 type ModelSpatialRotateEvent = SpatialRotateEvent<SpatializedStatic3DElementRef>;
 type ModelSpatialRotateEndEvent = SpatialRotateEndEvent<SpatializedStatic3DElementRef>;
 type ModelSpatialMagnifyEvent = SpatialMagnifyEvent<SpatializedStatic3DElementRef>;
@@ -94,10 +107,8 @@ declare const SpatializedStatic3DElementContainer: React$1.ForwardRefExoticCompo
     onSpatialDragStart?: ((event: SpatialDragStartEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialDrag?: ((event: SpatialDragEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialDragEnd?: ((event: SpatialDragEndEvent<SpatializedStatic3DElementRef>) => void) | undefined;
-    onSpatialRotateStart?: ((event: SpatialRotateStartEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialRotate?: ((event: SpatialRotateEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialRotateEnd?: ((event: SpatialRotateEndEvent<SpatializedStatic3DElementRef>) => void) | undefined;
-    onSpatialMagnifyStart?: ((event: SpatialMagnifyStartEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialMagnify?: ((event: SpatialMagnifyEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialMagnifyEnd?: ((event: SpatialMagnifyEndEvent<SpatializedStatic3DElementRef>) => void) | undefined;
 } & Omit<Omit<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "onLoad" | "onError"> & {
@@ -169,21 +180,29 @@ type allTarget<T extends EntityRefShape> = {
     target: T;
     currentTarget: T;
 };
-type SpatialTapEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialTapEvent$1 & allTarget<T>;
+type SpatialTapEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialTapEvent$1 & allTarget<T> & {
+    readonly offsetX: number;
+    readonly offsetY: number;
+    readonly offsetZ: number;
+};
+type SpatialDragStartEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialDragStartEvent$1 & allTarget<T> & {
+    readonly offsetX: number;
+    readonly offsetY: number;
+    readonly offsetZ: number;
+};
 type SpatialDragEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialDragEvent$1 & allTarget<T>;
+type SpatialDragEndEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialDragEndEvent$1 & allTarget<T>;
 type SpatialRotateEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialRotateEvent$1 & allTarget<T>;
 type SpatialRotateEndEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialRotateEndEvent$1 & allTarget<T>;
 type SpatialMagnifyEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialMagnifyEvent$1 & allTarget<T>;
 type SpatialMagnifyEndEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialMagnifyEndEvent$1 & allTarget<T>;
 type EntityEventHandler = {
     onSpatialTap?: (event: SpatialTapEntityEvent) => void;
-    onSpatialDragStart?: (event: SpatialDragEntityEvent) => void;
+    onSpatialDragStart?: (event: SpatialDragStartEntityEvent) => void;
     onSpatialDrag?: (event: SpatialDragEntityEvent) => void;
-    onSpatialDragEnd?: (event: SpatialDragEntityEvent) => void;
-    onSpatialRotateStart?: (event: SpatialRotateEntityEvent) => void;
+    onSpatialDragEnd?: (event: SpatialDragEndEntityEvent) => void;
     onSpatialRotate?: (event: SpatialRotateEntityEvent) => void;
     onSpatialRotateEnd?: (event: SpatialRotateEndEntityEvent) => void;
-    onSpatialMagnifyStart?: (event: SpatialMagnifyEntityEvent) => void;
     onSpatialMagnify?: (event: SpatialMagnifyEntityEvent) => void;
     onSpatialMagnifyEnd?: (event: SpatialMagnifyEndEntityEvent) => void;
 };
@@ -266,10 +285,8 @@ declare const Model: React$1.ForwardRefExoticComponent<Omit<{
     onSpatialDragStart?: ((event: SpatialDragStartEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialDrag?: ((event: SpatialDragEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialDragEnd?: ((event: SpatialDragEndEvent<SpatializedStatic3DElementRef>) => void) | undefined;
-    onSpatialRotateStart?: ((event: SpatialRotateStartEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialRotate?: ((event: SpatialRotateEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialRotateEnd?: ((event: SpatialRotateEndEvent<SpatializedStatic3DElementRef>) => void) | undefined;
-    onSpatialMagnifyStart?: ((event: SpatialMagnifyStartEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialMagnify?: ((event: SpatialMagnifyEvent<SpatializedStatic3DElementRef>) => void) | undefined;
     onSpatialMagnifyEnd?: ((event: SpatialMagnifyEndEvent<SpatializedStatic3DElementRef>) => void) | undefined;
 } & Omit<Omit<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "onLoad" | "onError"> & {
@@ -287,4 +304,4 @@ declare const SSRProvider: ({ isSSR: initialIsSSR, children, }: {
 
 declare const version: string;
 
-export { BoxEntity, ConeEntity, CylinderEntity, Entity, type EntityEventHandler, type EntityProps, EntityRef, Model, ModelAsset, ModelEntity, type ModelLoadEvent, type ModelProps, type ModelRef, type ModelSpatialDragEndEvent, type ModelSpatialDragEvent, type ModelSpatialDragStartEvent, type ModelSpatialMagnifyEndEvent, type ModelSpatialMagnifyEvent, type ModelSpatialRotateEndEvent, type ModelSpatialRotateEvent, type ModelSpatialRotateStartEvent, type ModelSpatialTapEvent, PlaneEntity, Reality, SSRProvider, SceneGraph, type SpatialDragEndEvent, type SpatialDragEntityEvent, type SpatialDragEvent, type SpatialDragStartEvent, type SpatialMagnifyEndEntityEvent, type SpatialMagnifyEndEvent, type SpatialMagnifyEntityEvent, type SpatialMagnifyEvent, type SpatialMagnifyStartEvent, SpatialMonitor, type SpatialRotateEndEntityEvent, type SpatialRotateEndEvent, type SpatialRotateEntityEvent, type SpatialRotateEvent, type SpatialRotateStartEvent, type SpatialTapEntityEvent, type SpatialTapEvent, Spatialized2DElementContainer, type Spatialized2DElementContainerProps, SpatializedContainer, type SpatializedElementRef, type SpatializedStatic3DContainerProps, SpatializedStatic3DElementContainer, type SpatializedStatic3DElementRef, SphereEntity, UnlitMaterial, enableDebugTool, eventMap, initPolyfill, initScene, toLocalSpace, toSceneSpatial, version, withSpatialMonitor, withSpatialized2DElementContainer };
+export { BoxEntity, ConeEntity, CylinderEntity, Entity, type EntityEventHandler, type EntityProps, EntityRef, Model, ModelAsset, ModelEntity, type ModelLoadEvent, type ModelProps, type ModelRef, type ModelSpatialDragEndEvent, type ModelSpatialDragEvent, type ModelSpatialDragStartEvent, type ModelSpatialMagnifyEndEvent, type ModelSpatialMagnifyEvent, type ModelSpatialRotateEndEvent, type ModelSpatialRotateEvent, type ModelSpatialTapEvent, PlaneEntity, Reality, SSRProvider, SceneGraph, type SpatialDragEndEntityEvent, type SpatialDragEndEvent, type SpatialDragEntityEvent, type SpatialDragEvent, type SpatialDragStartEntityEvent, type SpatialDragStartEvent, type SpatialMagnifyEndEntityEvent, type SpatialMagnifyEndEvent, type SpatialMagnifyEntityEvent, type SpatialMagnifyEvent, SpatialMonitor, type SpatialRotateEndEntityEvent, type SpatialRotateEndEvent, type SpatialRotateEntityEvent, type SpatialRotateEvent, type SpatialTapEntityEvent, type SpatialTapEvent, Spatialized2DElementContainer, type Spatialized2DElementContainerProps, SpatializedContainer, type SpatializedElementRef, type SpatializedStatic3DContainerProps, SpatializedStatic3DElementContainer, type SpatializedStatic3DElementRef, SphereEntity, UnlitMaterial, enableDebugTool, eventMap, initPolyfill, initScene, toLocalSpace, toSceneSpatial, version, withSpatialMonitor, withSpatialized2DElementContainer };