@shopware-ag/dive 1.16.0 → 1.16.2

package/src/com/actions/camera/computeencompassingview.ts

@@ -1,9 +1,10 @@
-import { Vector3Like } from "three";
+import { Vector3Like } from 'three';
 
 export default interface COMPUTE_ENCOMPASSING_VIEW {
-    'PAYLOAD': object,
-    'RETURN': {
-        position: Vector3Like,
-        target: Vector3Like
-    },
-};
+    DESCRIPTION: 'Calculates the camera position and target to view the whole scene. (experimental)';
+    PAYLOAD: object;
+    RETURN: {
+        position: Vector3Like;
+        target: Vector3Like;
+    };
+}

package/src/com/actions/camera/getcameratransform.ts

@@ -1,9 +1,10 @@
-import { Vector3Like } from "three";
+import { Vector3Like } from 'three';
 
 export default interface GET_CAMERA_TRANSFORM {
-    'PAYLOAD': object,
-    'RETURN': {
-        position: Vector3Like,
-        target: Vector3Like
-    },
-};
+    DESCRIPTION: 'Returns the current camera position and target.';
+    PAYLOAD: object;
+    RETURN: {
+        position: Vector3Like;
+        target: Vector3Like;
+    };
+}

package/src/com/actions/camera/movecamera.ts

@@ -1,15 +1,18 @@
-import { Vector3Like } from "three";
+import { Vector3Like } from 'three';
 
 export default interface MOVE_CAMERA {
-    'PAYLOAD': {
-        position: Vector3Like,
-        target: Vector3Like,
-        locked: boolean,
-        duration: number,
-    } | {
-        id: string,
-        locked: boolean,
-        duration: number
-    },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Moves the camera to a new position and target.';
+    PAYLOAD:
+        | {
+              position: Vector3Like;
+              target: Vector3Like;
+              locked: boolean;
+              duration: number;
+          }
+        | {
+              id: string;
+              locked: boolean;
+              duration: number;
+          };
+    RETURN: boolean;
+}

package/src/com/actions/camera/resetcamera.ts

@@ -1,4 +1,5 @@
 export default interface RESET_CAMERA {
-    'PAYLOAD': { duration: number },
-    'RETURN': boolean,
-}
+    DESCRIPTION: 'Reset the camera to its initial position and rotation.';
+    PAYLOAD: { duration: number };
+    RETURN: boolean;
+}

package/src/com/actions/camera/setcameralayer.ts

@@ -1,4 +1,5 @@
 export default interface SET_CAMERA_LAYER {
-    'PAYLOAD': { layer: 'LIVE' | 'EDITOR' },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Sets the camera layer to a certain layer.';
+    PAYLOAD: { layer: 'LIVE' | 'EDITOR' };
+    RETURN: boolean;
+}

package/src/com/actions/camera/setcameratransform.ts

@@ -1,9 +1,10 @@
-import { Vector3Like } from "three";
+import { Vector3Like } from 'three';
 
 export default interface SET_CAMERA_TRANSFORM {
-    'PAYLOAD': {
-        position: Vector3Like,
-        target: Vector3Like,
-    },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Sets the camera position and target.';
+    PAYLOAD: {
+        position: Vector3Like;
+        target: Vector3Like;
+    };
+    RETURN: boolean;
+}

package/src/com/actions/camera/zoomcamera.ts

@@ -1,4 +1,5 @@
 export default interface ZOOM_CAMERA {
-    'PAYLOAD': { direction: 'IN' | 'OUT', by: number },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Zooms the camera in or out by a certain amount.';
+    PAYLOAD: { direction: 'IN' | 'OUT'; by: number };
+    RETURN: boolean;
+}

package/src/com/actions/index.ts

@@ -1,55 +1,55 @@
-import SET_BACKGROUND from "./scene/setbackground.ts";
-import RESET_CAMERA from "./camera/resetcamera.ts";
-import SET_CAMERA_LAYER from "./camera/setcameralayer.ts";
-import ZOOM_CAMERA from "./camera/zoomcamera.ts";
-import SET_GIZMO_MODE from "./toolbox/select/setgizmomode.ts";
-import SET_CAMERA_TRANSFORM from "./camera/setcameratransform.ts";
-import MOVE_CAMERA from "./camera/movecamera.ts";
-import PLACE_ON_FLOOR from "./object/model/placeonfloor.ts";
-import GET_ALL_OBJECTS from "./object/getallobjects.ts";
-import GET_OBJECTS from "./object/getobjects.ts";
-import ADD_OBJECT from "./object/addobject.ts";
-import DELETE_OBJECT from "./object/deleteobject.ts";
-import UPDATE_OBJECT from "./object/updateobject.ts";
-import MODEL_LOADED from "./object/model/modelloaded.ts";
-import UPDATE_SCENE from "./scene/updatescene.ts";
-import GENERATE_MEDIA from "./media/generatemedia.ts";
-import GET_ALL_SCENE_DATA from "./scene/getallscenedata.ts";
-import SELECT_OBJECT from "./object/selectobject.ts";
-import DESELECT_OBJECT from "./object/deselectobject.ts";
-import GET_CAMERA_TRANSFORM from "./camera/getcameratransform.ts";
-import DROP_IT from "./object/model/dropit.ts";
-import SET_GIZMO_VISIBILITY from "./toolbox/transform/setgizmovisible.js";
-import COMPUTE_ENCOMPASSING_VIEW from "./camera/computeencompassingview.ts";
-import USE_TOOL from "./toolbox/usetool.ts";
-import SET_PARENT from "./object/setparent.ts";
-import EXPORT_SCENE from "./scene/exportscene.ts";
+import SET_BACKGROUND from './scene/setbackground.ts';
+import RESET_CAMERA from './camera/resetcamera.ts';
+import SET_CAMERA_LAYER from './camera/setcameralayer.ts';
+import ZOOM_CAMERA from './camera/zoomcamera.ts';
+import SET_GIZMO_MODE from './toolbox/select/setgizmomode.ts';
+import SET_CAMERA_TRANSFORM from './camera/setcameratransform.ts';
+import MOVE_CAMERA from './camera/movecamera.ts';
+import PLACE_ON_FLOOR from './object/model/placeonfloor.ts';
+import GET_ALL_OBJECTS from './object/getallobjects.ts';
+import GET_OBJECTS from './object/getobjects.ts';
+import ADD_OBJECT from './object/addobject.ts';
+import DELETE_OBJECT from './object/deleteobject.ts';
+import UPDATE_OBJECT from './object/updateobject.ts';
+import MODEL_LOADED from './object/model/modelloaded.ts';
+import UPDATE_SCENE from './scene/updatescene.ts';
+import GENERATE_MEDIA from './media/generatemedia.ts';
+import GET_ALL_SCENE_DATA from './scene/getallscenedata.ts';
+import SELECT_OBJECT from './object/selectobject.ts';
+import DESELECT_OBJECT from './object/deselectobject.ts';
+import GET_CAMERA_TRANSFORM from './camera/getcameratransform.ts';
+import DROP_IT from './object/model/dropit.ts';
+import SET_GIZMO_VISIBILITY from './toolbox/transform/setgizmovisible.js';
+import COMPUTE_ENCOMPASSING_VIEW from './camera/computeencompassingview.ts';
+import USE_TOOL from './toolbox/usetool.ts';
+import SET_PARENT from './object/setparent.ts';
+import EXPORT_SCENE from './scene/exportscene.ts';
 
-export type Actions = {
-    GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA,
-    GET_ALL_OBJECTS: GET_ALL_OBJECTS,
-    GET_OBJECTS: GET_OBJECTS,
-    ADD_OBJECT: ADD_OBJECT,
-    UPDATE_OBJECT: UPDATE_OBJECT,
-    DELETE_OBJECT: DELETE_OBJECT,
-    SELECT_OBJECT: SELECT_OBJECT,
-    DESELECT_OBJECT: DESELECT_OBJECT,
-    SET_BACKGROUND: SET_BACKGROUND,
-    DROP_IT: DROP_IT,
-    PLACE_ON_FLOOR: PLACE_ON_FLOOR,
-    SET_CAMERA_TRANSFORM: SET_CAMERA_TRANSFORM,
-    GET_CAMERA_TRANSFORM: GET_CAMERA_TRANSFORM,
-    MOVE_CAMERA: MOVE_CAMERA,
-    RESET_CAMERA: RESET_CAMERA,
-    COMPUTE_ENCOMPASSING_VIEW: COMPUTE_ENCOMPASSING_VIEW,
-    SET_CAMERA_LAYER: SET_CAMERA_LAYER,
-    ZOOM_CAMERA: ZOOM_CAMERA,
-    SET_GIZMO_MODE: SET_GIZMO_MODE,
-    SET_GIZMO_VISIBILITY: SET_GIZMO_VISIBILITY,
-    USE_TOOL: USE_TOOL,
-    MODEL_LOADED: MODEL_LOADED,
-    UPDATE_SCENE: UPDATE_SCENE,
-    GENERATE_MEDIA: GENERATE_MEDIA,
-    SET_PARENT: SET_PARENT,
-    EXPORT_SCENE: EXPORT_SCENE,
-};
+export interface Actions {
+    GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
+    GET_ALL_OBJECTS: GET_ALL_OBJECTS;
+    GET_OBJECTS: GET_OBJECTS;
+    ADD_OBJECT: ADD_OBJECT;
+    UPDATE_OBJECT: UPDATE_OBJECT;
+    DELETE_OBJECT: DELETE_OBJECT;
+    SELECT_OBJECT: SELECT_OBJECT;
+    DESELECT_OBJECT: DESELECT_OBJECT;
+    SET_BACKGROUND: SET_BACKGROUND;
+    DROP_IT: DROP_IT;
+    PLACE_ON_FLOOR: PLACE_ON_FLOOR;
+    SET_CAMERA_TRANSFORM: SET_CAMERA_TRANSFORM;
+    GET_CAMERA_TRANSFORM: GET_CAMERA_TRANSFORM;
+    MOVE_CAMERA: MOVE_CAMERA;
+    RESET_CAMERA: RESET_CAMERA;
+    COMPUTE_ENCOMPASSING_VIEW: COMPUTE_ENCOMPASSING_VIEW;
+    SET_CAMERA_LAYER: SET_CAMERA_LAYER;
+    ZOOM_CAMERA: ZOOM_CAMERA;
+    SET_GIZMO_MODE: SET_GIZMO_MODE;
+    SET_GIZMO_VISIBILITY: SET_GIZMO_VISIBILITY;
+    USE_TOOL: USE_TOOL;
+    MODEL_LOADED: MODEL_LOADED;
+    UPDATE_SCENE: UPDATE_SCENE;
+    GENERATE_MEDIA: GENERATE_MEDIA;
+    SET_PARENT: SET_PARENT;
+    EXPORT_SCENE: EXPORT_SCENE;
+}

package/src/com/actions/media/generatemedia.ts

@@ -1,15 +1,19 @@
-import { Vector3Like } from "three";
+import { Vector3Like } from 'three';
 
 export default interface GENERATE_MEDIA {
-    'PAYLOAD': ({
-        position: Vector3Like,
-        target: Vector3Like,
-    } | {
-        id: string,
-    }) & {
-        width: number, // image width in pixels
-        height: number, // image height in pixels
-        dataUri: string
-    },
-    'RETURN': boolean,
-}
+    DESCRIPTION: 'Generates a screenshot, stores it in a Blob and writes the URL into the payload.';
+    PAYLOAD: (
+        | {
+              position: Vector3Like;
+              target: Vector3Like;
+          }
+        | {
+              id: string;
+          }
+    ) & {
+        width: number; // image width in pixels
+        height: number; // image height in pixels
+        dataUri: string;
+    };
+    RETURN: boolean;
+}

package/src/com/actions/object/addobject.ts

@@ -1,6 +1,7 @@
-import { COMEntity } from "../../types";
+import { COMEntity } from '../../types';
 
 export default interface ADD_OBJECT {
-    'PAYLOAD': COMEntity,
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Adds an object to the scene.';
+    PAYLOAD: COMEntity;
+    RETURN: boolean;
+}

package/src/com/actions/object/deleteobject.ts

@@ -1,6 +1,7 @@
-import { COMEntity } from "../../types";
+import { COMEntity } from '../../types';
 
 export default interface DELETE_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & { id: string },
-    'RETURN': boolean,
-}
+    DESCRIPTION: 'Deletes an object from the scene.';
+    PAYLOAD: Partial<COMEntity> & { id: string };
+    RETURN: boolean;
+}

package/src/com/actions/object/deselectobject.ts

@@ -1,6 +1,7 @@
-import { COMEntity } from "../../types";
+import { COMEntity } from '../../types';
 
 export default interface DESELECT_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & { id: string },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Deselects an existing object.';
+    PAYLOAD: Partial<COMEntity> & { id: string };
+    RETURN: boolean;
+}

package/src/com/actions/object/getallobjects.ts

@@ -1,6 +1,7 @@
-import { COMEntity } from "../../types";
+import { COMEntity } from '../../types';
 
 export default 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>;
+}

package/src/com/actions/object/getobjects.ts

@@ -1,6 +1,7 @@
-import { COMEntity } from "../../types";
+import { COMEntity } from '../../types';
 
 export default interface GET_OBJECTS {
-    'PAYLOAD': { ids: string[] },
-    'RETURN': COMEntity[],
-};
+    DESCRIPTION: 'Returns a list of objects of given IDs.';
+    PAYLOAD: { ids: string[] };
+    RETURN: COMEntity[];
+}

package/src/com/actions/object/model/dropit.ts

@@ -1,4 +1,5 @@
 export default interface DROP_IT {
-    'PAYLOAD': { id: string },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Places an object on top of an underlying object or the floor.';
+    PAYLOAD: { id: string };
+    RETURN: boolean;
+}

package/src/com/actions/object/model/modelloaded.ts

@@ -1,4 +1,5 @@
 export default interface MODEL_LOADED {
-    'PAYLOAD': { id: string },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Is triggered when a model is loaded.';
+    PAYLOAD: { id: string };
+    RETURN: boolean;
+}

package/src/com/actions/object/model/placeonfloor.ts

@@ -1,4 +1,5 @@
 export default interface PLACE_ON_FLOOR {
-    'PAYLOAD': { id: string },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Places an object on the floor.';
+    PAYLOAD: { id: string };
+    RETURN: boolean;
+}

package/src/com/actions/object/selectobject.ts

@@ -1,6 +1,7 @@
-import { COMEntity } from "../../types";
+import { COMEntity } from '../../types';
 
 export default interface SELECT_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & { id: string },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Selects an existing object.';
+    PAYLOAD: Partial<COMEntity> & { id: string };
+    RETURN: boolean;
+}

package/src/com/actions/object/setparent.ts

@@ -1,9 +1,10 @@
-import { type COMEntity } from "../../types";
+import { type COMEntity } from '../../types';
 
 export default interface SET_PARENT {
-    'PAYLOAD': {
-        object: Partial<COMEntity> & { id: string },
-        parent: Partial<COMEntity> & { id: string } | null,
-    },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Attach an object to another object.';
+    PAYLOAD: {
+        object: Partial<COMEntity> & { id: string };
+        parent: (Partial<COMEntity> & { id: string }) | null;
+    };
+    RETURN: boolean;
+}

package/src/com/actions/object/updateobject.ts

@@ -1,6 +1,7 @@
-import { COMEntity } from "../../types";
+import { COMEntity } from '../../types';
 
 export default interface UPDATE_OBJECT {
-    'PAYLOAD': Partial<COMEntity> & { id: string },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Updates an existing object.';
+    PAYLOAD: Partial<COMEntity> & { id: string };
+    RETURN: boolean;
+}

package/src/com/actions/scene/exportscene.ts

@@ -1,6 +1,7 @@
-import { type DIVESceneFileType } from "../../../types";
+import { type DIVESceneFileType } from '../../../types';
 
 export default interface EXPORT_SCENE {
-    'PAYLOAD': { type: keyof DIVESceneFileType },
-    'RETURN': Promise<string | null>,
-};
+    DESCRIPTION: 'Exports the current scene to a blob and returns the URL.';
+    PAYLOAD: { type: keyof DIVESceneFileType };
+    RETURN: Promise<string | null>;
+}

package/src/com/actions/scene/getallscenedata.ts

@@ -1,24 +1,30 @@
-import { Vector3Like } from "three";
-import { type COMLight, type COMModel, type COMPov, type COMPrimitive } from "../../types";
+import { Vector3Like } from 'three';
+import {
+    type COMLight,
+    type COMModel,
+    type COMPov,
+    type COMPrimitive,
+} from '../../types';
 
 type SceneData = {
-    name: string,
-    mediaItem: null,
-    backgroundColor: string,
-    floorEnabled: boolean,
-    floorColor: string,
+    name: string;
+    mediaItem: null;
+    backgroundColor: string;
+    floorEnabled: boolean;
+    floorColor: string;
     userCamera: {
-        position: Vector3Like,
-        target: Vector3Like,
-    },
-    spotmarks: object[],
-    lights: COMLight[],
-    objects: COMModel[],
-    cameras: COMPov[],
-    primitives: COMPrimitive[],
+        position: Vector3Like;
+        target: Vector3Like;
+    };
+    spotmarks: object[];
+    lights: COMLight[];
+    objects: COMModel[];
+    cameras: COMPov[];
+    primitives: COMPrimitive[];
 };
 
 export default interface GET_ALL_SCENE_DATA {
-    'PAYLOAD': object,
-    'RETURN': SceneData,
-};
+    DESCRIPTION: 'Retrieves all current scene data.';
+    PAYLOAD: object;
+    RETURN: SceneData;
+}

package/src/com/actions/scene/setbackground.ts

@@ -1,4 +1,5 @@
 export default interface SET_BACKGROUND {
-    'PAYLOAD': { color: string | number },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Set the background color of the scene.';
+    PAYLOAD: { color: string | number };
+    RETURN: boolean;
+}

package/src/com/actions/scene/updatescene.ts

@@ -1,10 +1,11 @@
 export default interface UPDATE_SCENE {
-    'PAYLOAD': {
-        name?: string,
-        backgroundColor?: string | number,
-        gridEnabled?: boolean,
-        floorEnabled?: boolean,
-        floorColor?: string | number
-    },
-    'RETURN': boolean,
-};
+    DESCRIPTION: 'Updates global scene data.';
+    PAYLOAD: {
+        name?: string;
+        backgroundColor?: string | number;
+        gridEnabled?: boolean;
+        floorEnabled?: boolean;
+        floorColor?: string | number;
+    };
+    RETURN: boolean;
+}

package/src/com/actions/toolbox/select/setgizmomode.ts

@@ -1,4 +1,5 @@
 export default interface SET_GIZMO_MODE {
-    'PAYLOAD': { mode: 'translate' | 'rotate' | 'scale' },
-    'RETURN': boolean,
-};
+    DESCRIPTION: "Sets the gizmo's mode.";
+    PAYLOAD: { mode: 'translate' | 'rotate' | 'scale' };
+    RETURN: boolean;
+}

package/src/com/actions/toolbox/transform/setgizmovisible.ts

@@ -1,4 +1,5 @@
 export default interface SET_GIZMO_VISIBILITY {
-    'PAYLOAD': boolean,
-    'RETURN': boolean,
-}
+    DESCRIPTION: "Sets the gizmo's visibility.";
+    PAYLOAD: boolean;
+    RETURN: boolean;
+}

package/src/com/actions/toolbox/usetool.ts

@@ -1,6 +1,7 @@
-import { type ToolType } from "../../../toolbox/Toolbox";
+import { type ToolType } from '../../../toolbox/Toolbox';
 
 export default interface USE_TOOL {
-    'PAYLOAD': { tool: ToolType },
-    'RETURN': boolean,
-}
+    DESCRIPTION: 'Activates a specific tool from the toolbox.';
+    PAYLOAD: { tool: ToolType };
+    RETURN: boolean;
+}

package/src/com/types/COMBaseEntity.ts

@@ -1,4 +1,4 @@
-import { COMEntityType } from "./COMEntityType";
+import { COMEntityType } from './COMEntityType';
 
 export type COMBaseEntity = {
     id: string;
@@ -6,4 +6,4 @@ export type COMBaseEntity = {
     entityType: COMEntityType;
     visible: boolean;
     parentId?: string | null;
-}
+};

package/src/com/types/COMEntity.ts

@@ -1,7 +1,7 @@
-import { type COMPov } from "./COMPov";
-import { type COMLight } from "./COMLight";
-import { type COMModel } from "./COMModel";
-import { type COMPrimitive } from "./COMPrimitive";
-import { type COMGroup } from "./COMGroup";
+import { type COMPov } from './COMPov';
+import { type COMLight } from './COMLight';
+import { type COMModel } from './COMModel';
+import { type COMPrimitive } from './COMPrimitive';
+import { type COMGroup } from './COMGroup';
 
-export type COMEntity = COMPov | COMLight | COMModel | COMPrimitive | COMGroup;
+export type COMEntity = COMPov | COMLight | COMModel | COMPrimitive | COMGroup;

package/src/com/types/COMEntityType.ts

@@ -1 +1 @@
-export type COMEntityType = 'pov' | 'light' | 'model' | 'primitive' | 'group';
+export type COMEntityType = 'pov' | 'light' | 'model' | 'primitive' | 'group';

package/src/com/types/COMGeometry.ts

@@ -1,6 +1,6 @@
 export type COMGeometry = {
-    name: string
+    name: string;
     width: number;
     height: number;
     depth: number;
-}
+};

package/src/com/types/COMGroup.ts

@@ -1,9 +1,9 @@
-import { type Vector3Like } from "three";
-import { type COMBaseEntity } from "./COMBaseEntity";
+import { type Vector3Like } from 'three';
+import { type COMBaseEntity } from './COMBaseEntity';
 
 export type COMGroup = COMBaseEntity & {
     position: Vector3Like;
     rotation: Vector3Like;
     scale: Vector3Like;
     bbVisible?: boolean;
-}
+};

package/src/com/types/COMLight.ts

@@ -1,5 +1,5 @@
-import { type Vector3Like } from "three";
-import { type COMBaseEntity } from "./COMBaseEntity";
+import { type Vector3Like } from 'three';
+import { type COMBaseEntity } from './COMBaseEntity';
 
 export type COMLight = COMBaseEntity & {
     type: 'ambient' | 'point' | 'scene';
@@ -7,4 +7,4 @@ export type COMLight = COMBaseEntity & {
     color: string | number;
     enabled: boolean;
     position?: Vector3Like;
-};
+};

package/src/com/types/COMMaterial.ts

@@ -1,4 +1,4 @@
-import { type Texture } from "three";
+import { type Texture } from 'three';
 
 export type COMMaterial = {
     vertexColors: boolean;
@@ -9,4 +9,4 @@ export type COMMaterial = {
     roughnessMap: Texture | null;
     metalness: number;
     metalnessMap: Texture | null;
-}
+};