@shopware-ag/dive 1.16.0 → 1.16.2

package/build/dive.d.cts

@@ -141,51 +141,58 @@ declare class DIVEOrbitControls extends OrbitControls {
 }
 
 interface SET_BACKGROUND {
-    'PAYLOAD': {
+    DESCRIPTION: 'Set the background color of the scene.';
+    PAYLOAD: {
         color: string | number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface RESET_CAMERA {
-    'PAYLOAD': {
+    DESCRIPTION: 'Reset the camera to its initial position and rotation.';
+    PAYLOAD: {
         duration: number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_CAMERA_LAYER {
-    'PAYLOAD': {
+    DESCRIPTION: 'Sets the camera layer to a certain layer.';
+    PAYLOAD: {
         layer: 'LIVE' | 'EDITOR';
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface ZOOM_CAMERA {
-    'PAYLOAD': {
+    DESCRIPTION: 'Zooms the camera in or out by a certain amount.';
+    PAYLOAD: {
         direction: 'IN' | 'OUT';
         by: number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_GIZMO_MODE {
-    'PAYLOAD': {
+    DESCRIPTION: "Sets the gizmo's mode.";
+    PAYLOAD: {
         mode: 'translate' | 'rotate' | 'scale';
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_CAMERA_TRANSFORM {
-    'PAYLOAD': {
+    DESCRIPTION: 'Sets the camera position and target.';
+    PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface MOVE_CAMERA {
-    'PAYLOAD': {
+    DESCRIPTION: 'Moves the camera to a new position and target.';
+    PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;
         locked: boolean;
@@ -195,14 +202,15 @@ interface MOVE_CAMERA {
         locked: boolean;
         duration: number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface PLACE_ON_FLOOR {
-    'PAYLOAD': {
+    DESCRIPTION: 'Places an object on the floor.';
+    PAYLOAD: {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 type COMEntityType = 'pov' | 'light' | 'model' | 'primitive' | 'group';
@@ -274,56 +282,64 @@ type COMGroup = COMBaseEntity & {
 type COMEntity = COMPov | COMLight | COMModel | COMPrimitive | COMGroup;
 
 interface GET_ALL_OBJECTS {
-    'PAYLOAD': Map<string, COMEntity>;
-    'RETURN': Map<string, COMEntity>;
+    readonly DESCRIPTION: 'Retrieves all objects in the scene.';
+    PAYLOAD: Map<string, COMEntity>;
+    RETURN: Map<string, COMEntity>;
 }
 
 interface GET_OBJECTS {
-    'PAYLOAD': {
+    DESCRIPTION: 'Returns a list of objects of given IDs.';
+    PAYLOAD: {
         ids: string[];
     };
-    'RETURN': COMEntity[];
+    RETURN: COMEntity[];
 }
 
 interface ADD_OBJECT {
-    'PAYLOAD': COMEntity;
-    'RETURN': boolean;
+    DESCRIPTION: 'Adds an object to the scene.';
+    PAYLOAD: COMEntity;
+    RETURN: boolean;
 }
 
 interface DELETE_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & {
+    DESCRIPTION: 'Deletes an object from the scene.';
+    PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface UPDATE_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & {
+    DESCRIPTION: 'Updates an existing object.';
+    PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface MODEL_LOADED {
-    'PAYLOAD': {
+    DESCRIPTION: 'Is triggered when a model is loaded.';
+    PAYLOAD: {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface UPDATE_SCENE {
-    'PAYLOAD': {
+    DESCRIPTION: 'Updates global scene data.';
+    PAYLOAD: {
         name?: string;
         backgroundColor?: string | number;
         gridEnabled?: boolean;
         floorEnabled?: boolean;
         floorColor?: string | number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface GENERATE_MEDIA {
-    'PAYLOAD': ({
+    DESCRIPTION: 'Generates a screenshot, stores it in a Blob and writes the URL into the payload.';
+    PAYLOAD: ({
         position: Vector3Like;
         target: Vector3Like;
     } | {
@@ -333,7 +349,7 @@ interface GENERATE_MEDIA {
         height: number;
         dataUri: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 type SceneData = {
@@ -353,47 +369,54 @@ type SceneData = {
     primitives: COMPrimitive[];
 };
 interface GET_ALL_SCENE_DATA {
-    'PAYLOAD': object;
-    'RETURN': SceneData;
+    DESCRIPTION: 'Retrieves all current scene data.';
+    PAYLOAD: object;
+    RETURN: SceneData;
 }
 
 interface SELECT_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & {
+    DESCRIPTION: 'Selects an existing object.';
+    PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface DESELECT_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & {
+    DESCRIPTION: 'Deselects an existing object.';
+    PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface GET_CAMERA_TRANSFORM {
-    'PAYLOAD': object;
-    'RETURN': {
+    DESCRIPTION: 'Returns the current camera position and target.';
+    PAYLOAD: object;
+    RETURN: {
         position: Vector3Like;
         target: Vector3Like;
     };
 }
 
 interface DROP_IT {
-    'PAYLOAD': {
+    DESCRIPTION: 'Places an object on top of an underlying object or the floor.';
+    PAYLOAD: {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_GIZMO_VISIBILITY {
-    'PAYLOAD': boolean;
-    'RETURN': boolean;
+    DESCRIPTION: "Sets the gizmo's visibility.";
+    PAYLOAD: boolean;
+    RETURN: boolean;
 }
 
 interface COMPUTE_ENCOMPASSING_VIEW {
-    'PAYLOAD': object;
-    'RETURN': {
+    DESCRIPTION: 'Calculates the camera position and target to view the whole scene. (experimental)';
+    PAYLOAD: object;
+    RETURN: {
         position: Vector3Like;
         target: Vector3Like;
     };
@@ -568,7 +591,7 @@ declare class DIVEPrimitive extends DIVENode {
 type DIVESceneObject = DIVEModel | DIVEGroup | DIVEPrimitive | DIVEAmbientLight | DIVEPointLight | DIVESceneLight;
 
 type DIVESceneFileType = {
-    'glb': GLTF$1;
+    glb: GLTF$1;
 };
 
 /**
@@ -796,32 +819,35 @@ declare class DIVEToolbox {
 }
 
 interface USE_TOOL {
-    'PAYLOAD': {
+    DESCRIPTION: 'Activates a specific tool from the toolbox.';
+    PAYLOAD: {
         tool: ToolType;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_PARENT {
-    'PAYLOAD': {
+    DESCRIPTION: 'Attach an object to another object.';
+    PAYLOAD: {
         object: Partial<COMEntity> & {
             id: string;
         };
-        parent: Partial<COMEntity> & {
+        parent: (Partial<COMEntity> & {
             id: string;
-        } | null;
+        }) | null;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface EXPORT_SCENE {
-    'PAYLOAD': {
+    DESCRIPTION: 'Exports the current scene to a blob and returns the URL.';
+    PAYLOAD: {
         type: keyof DIVESceneFileType;
     };
-    'RETURN': Promise<string | null>;
+    RETURN: Promise<string | null>;
 }
 
-type Actions = {
+interface Actions {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
     GET_ALL_OBJECTS: GET_ALL_OBJECTS;
     GET_OBJECTS: GET_OBJECTS;
@@ -848,7 +874,7 @@ type Actions = {
     GENERATE_MEDIA: GENERATE_MEDIA;
     SET_PARENT: SET_PARENT;
     EXPORT_SCENE: EXPORT_SCENE;
-};
+}
 
 type EventListener<Action extends keyof Actions> = (payload: Actions[Action]['PAYLOAD']) => void;
 type Unsubscribe = () => boolean;

package/build/dive.d.ts

@@ -141,51 +141,58 @@ declare class DIVEOrbitControls extends OrbitControls {
 }
 
 interface SET_BACKGROUND {
-    'PAYLOAD': {
+    DESCRIPTION: 'Set the background color of the scene.';
+    PAYLOAD: {
         color: string | number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface RESET_CAMERA {
-    'PAYLOAD': {
+    DESCRIPTION: 'Reset the camera to its initial position and rotation.';
+    PAYLOAD: {
         duration: number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_CAMERA_LAYER {
-    'PAYLOAD': {
+    DESCRIPTION: 'Sets the camera layer to a certain layer.';
+    PAYLOAD: {
         layer: 'LIVE' | 'EDITOR';
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface ZOOM_CAMERA {
-    'PAYLOAD': {
+    DESCRIPTION: 'Zooms the camera in or out by a certain amount.';
+    PAYLOAD: {
         direction: 'IN' | 'OUT';
         by: number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_GIZMO_MODE {
-    'PAYLOAD': {
+    DESCRIPTION: "Sets the gizmo's mode.";
+    PAYLOAD: {
         mode: 'translate' | 'rotate' | 'scale';
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_CAMERA_TRANSFORM {
-    'PAYLOAD': {
+    DESCRIPTION: 'Sets the camera position and target.';
+    PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface MOVE_CAMERA {
-    'PAYLOAD': {
+    DESCRIPTION: 'Moves the camera to a new position and target.';
+    PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;
         locked: boolean;
@@ -195,14 +202,15 @@ interface MOVE_CAMERA {
         locked: boolean;
         duration: number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface PLACE_ON_FLOOR {
-    'PAYLOAD': {
+    DESCRIPTION: 'Places an object on the floor.';
+    PAYLOAD: {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 type COMEntityType = 'pov' | 'light' | 'model' | 'primitive' | 'group';
@@ -274,56 +282,64 @@ type COMGroup = COMBaseEntity & {
 type COMEntity = COMPov | COMLight | COMModel | COMPrimitive | COMGroup;
 
 interface GET_ALL_OBJECTS {
-    'PAYLOAD': Map<string, COMEntity>;
-    'RETURN': Map<string, COMEntity>;
+    readonly DESCRIPTION: 'Retrieves all objects in the scene.';
+    PAYLOAD: Map<string, COMEntity>;
+    RETURN: Map<string, COMEntity>;
 }
 
 interface GET_OBJECTS {
-    'PAYLOAD': {
+    DESCRIPTION: 'Returns a list of objects of given IDs.';
+    PAYLOAD: {
         ids: string[];
     };
-    'RETURN': COMEntity[];
+    RETURN: COMEntity[];
 }
 
 interface ADD_OBJECT {
-    'PAYLOAD': COMEntity;
-    'RETURN': boolean;
+    DESCRIPTION: 'Adds an object to the scene.';
+    PAYLOAD: COMEntity;
+    RETURN: boolean;
 }
 
 interface DELETE_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & {
+    DESCRIPTION: 'Deletes an object from the scene.';
+    PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface UPDATE_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & {
+    DESCRIPTION: 'Updates an existing object.';
+    PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface MODEL_LOADED {
-    'PAYLOAD': {
+    DESCRIPTION: 'Is triggered when a model is loaded.';
+    PAYLOAD: {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface UPDATE_SCENE {
-    'PAYLOAD': {
+    DESCRIPTION: 'Updates global scene data.';
+    PAYLOAD: {
         name?: string;
         backgroundColor?: string | number;
         gridEnabled?: boolean;
         floorEnabled?: boolean;
         floorColor?: string | number;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface GENERATE_MEDIA {
-    'PAYLOAD': ({
+    DESCRIPTION: 'Generates a screenshot, stores it in a Blob and writes the URL into the payload.';
+    PAYLOAD: ({
         position: Vector3Like;
         target: Vector3Like;
     } | {
@@ -333,7 +349,7 @@ interface GENERATE_MEDIA {
         height: number;
         dataUri: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 type SceneData = {
@@ -353,47 +369,54 @@ type SceneData = {
     primitives: COMPrimitive[];
 };
 interface GET_ALL_SCENE_DATA {
-    'PAYLOAD': object;
-    'RETURN': SceneData;
+    DESCRIPTION: 'Retrieves all current scene data.';
+    PAYLOAD: object;
+    RETURN: SceneData;
 }
 
 interface SELECT_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & {
+    DESCRIPTION: 'Selects an existing object.';
+    PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface DESELECT_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & {
+    DESCRIPTION: 'Deselects an existing object.';
+    PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface GET_CAMERA_TRANSFORM {
-    'PAYLOAD': object;
-    'RETURN': {
+    DESCRIPTION: 'Returns the current camera position and target.';
+    PAYLOAD: object;
+    RETURN: {
         position: Vector3Like;
         target: Vector3Like;
     };
 }
 
 interface DROP_IT {
-    'PAYLOAD': {
+    DESCRIPTION: 'Places an object on top of an underlying object or the floor.';
+    PAYLOAD: {
         id: string;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_GIZMO_VISIBILITY {
-    'PAYLOAD': boolean;
-    'RETURN': boolean;
+    DESCRIPTION: "Sets the gizmo's visibility.";
+    PAYLOAD: boolean;
+    RETURN: boolean;
 }
 
 interface COMPUTE_ENCOMPASSING_VIEW {
-    'PAYLOAD': object;
-    'RETURN': {
+    DESCRIPTION: 'Calculates the camera position and target to view the whole scene. (experimental)';
+    PAYLOAD: object;
+    RETURN: {
         position: Vector3Like;
         target: Vector3Like;
     };
@@ -568,7 +591,7 @@ declare class DIVEPrimitive extends DIVENode {
 type DIVESceneObject = DIVEModel | DIVEGroup | DIVEPrimitive | DIVEAmbientLight | DIVEPointLight | DIVESceneLight;
 
 type DIVESceneFileType = {
-    'glb': GLTF$1;
+    glb: GLTF$1;
 };
 
 /**
@@ -796,32 +819,35 @@ declare class DIVEToolbox {
 }
 
 interface USE_TOOL {
-    'PAYLOAD': {
+    DESCRIPTION: 'Activates a specific tool from the toolbox.';
+    PAYLOAD: {
         tool: ToolType;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface SET_PARENT {
-    'PAYLOAD': {
+    DESCRIPTION: 'Attach an object to another object.';
+    PAYLOAD: {
         object: Partial<COMEntity> & {
             id: string;
         };
-        parent: Partial<COMEntity> & {
+        parent: (Partial<COMEntity> & {
             id: string;
-        } | null;
+        }) | null;
     };
-    'RETURN': boolean;
+    RETURN: boolean;
 }
 
 interface EXPORT_SCENE {
-    'PAYLOAD': {
+    DESCRIPTION: 'Exports the current scene to a blob and returns the URL.';
+    PAYLOAD: {
         type: keyof DIVESceneFileType;
     };
-    'RETURN': Promise<string | null>;
+    RETURN: Promise<string | null>;
 }
 
-type Actions = {
+interface Actions {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
     GET_ALL_OBJECTS: GET_ALL_OBJECTS;
     GET_OBJECTS: GET_OBJECTS;
@@ -848,7 +874,7 @@ type Actions = {
     GENERATE_MEDIA: GENERATE_MEDIA;
     SET_PARENT: SET_PARENT;
     EXPORT_SCENE: EXPORT_SCENE;
-};
+}
 
 type EventListener<Action extends keyof Actions> = (payload: Actions[Action]['PAYLOAD']) => void;
 type Unsubscribe = () => boolean;