@shopware-ag/dive 1.16.1 → 1.16.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shopware-ag/dive",
-    "version": "1.16.1",
+    "version": "1.16.2",
     "description": "Shopware Spatial Framework",
     "type": "module",
     "main": "./build/dive.cjs",
@@ -49,18 +49,26 @@
         "prettier-plugin-multiline-arrays": "^3.0.6",
         "ts-jest": "^29.1.2",
         "ts-node": "^10.9.2",
+        "tsc": "^2.0.4",
         "tsup": "^8.0.2",
         "typescript": "^5.4.5",
         "typescript-eslint": "^7.7.1"
     },
     "scripts": {
-        "build": "tsup && yarn genmd",
-        "watch": "tsup --watch",
+        "build": "tsup",
+        "dev": "tsup --watch",
         "lint": "eslint",
-        "prettier-check": "prettier --check .",
-        "prettier-fix": "prettier --write .",
+        "lint:actions": "yarn lint:actions:transpile && yarn lint:actions:check && yarn lint:actions:cleanup",
+        "lint:actions:transpile": "yarn tsc --resolveJsonModule --esModuleInterop ci/lint/lint-actions.ts && mv ci/lint/lint-actions.js ci/lint/lint-actions.cjs",
+        "lint:actions:check": "yarn node ci/lint/lint-actions.cjs",
+        "lint:actions:cleanup": "node -e \"require('fs').unlinkSync('ci/lint/lint-actions.cjs')\"",
+        "prettier:check": "prettier --check .",
+        "prettier:fix": "prettier --write .",
         "unit": "jest",
         "coverage": "jest --coverage",
-        "genmd": "node ./scripts/genmd.js"
+        "generate-readme": "yarn generate-readme:transpile && yarn generate-readme:write && yarn generate-readme:cleanup",
+        "generate-readme:transpile": "yarn tsc --resolveJsonModule --esModuleInterop ci/readme/generate-readme.ts && mv ci/readme/generate-readme.js ci/readme/generate-readme.cjs",
+        "generate-readme:write": "node ci/readme/generate-readme.cjs",
+        "generate-readme:cleanup": "node -e \"require('fs').unlinkSync('ci/readme/generate-readme.cjs')\""
     }
 }

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

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

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

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

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

@@ -1,6 +1,7 @@
 import { Vector3Like } from 'three';
 
 export default interface MOVE_CAMERA {
+    DESCRIPTION: 'Moves the camera to a new position and target.';
     PAYLOAD:
         | {
               position: Vector3Like;

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

@@ -1,4 +1,5 @@
 export default interface RESET_CAMERA {
+    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 {
+    DESCRIPTION: 'Sets the camera layer to a certain layer.';
     PAYLOAD: { layer: 'LIVE' | 'EDITOR' };
     RETURN: boolean;
 }

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

@@ -1,6 +1,7 @@
 import { Vector3Like } from 'three';
 
 export default interface SET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Sets the camera position and target.';
     PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;

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

@@ -1,4 +1,5 @@
 export default interface ZOOM_CAMERA {
+    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

@@ -25,7 +25,7 @@ import USE_TOOL from './toolbox/usetool.ts';
 import SET_PARENT from './object/setparent.ts';
 import EXPORT_SCENE from './scene/exportscene.ts';
 
-export type Actions = {
+export interface Actions {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
     GET_ALL_OBJECTS: GET_ALL_OBJECTS;
     GET_OBJECTS: GET_OBJECTS;
@@ -52,4 +52,4 @@ export type Actions = {
     GENERATE_MEDIA: GENERATE_MEDIA;
     SET_PARENT: SET_PARENT;
     EXPORT_SCENE: EXPORT_SCENE;
-};
+}

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

@@ -1,6 +1,7 @@
 import { Vector3Like } from 'three';
 
 export default interface GENERATE_MEDIA {
+    DESCRIPTION: 'Generates a screenshot, stores it in a Blob and writes the URL into the payload.';
     PAYLOAD: (
         | {
               position: Vector3Like;

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

@@ -1,6 +1,7 @@
 import { COMEntity } from '../../types';
 
 export default interface ADD_OBJECT {
+    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';
 
 export default interface DELETE_OBJECT {
+    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';
 
 export default interface DESELECT_OBJECT {
+    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';
 
 export default interface GET_ALL_OBJECTS {
+    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';
 
 export default interface GET_OBJECTS {
+    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 {
+    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 {
+    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 {
+    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';
 
 export default interface SELECT_OBJECT {
+    DESCRIPTION: 'Selects an existing object.';
     PAYLOAD: Partial<COMEntity> & { id: string };
     RETURN: boolean;
 }

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

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

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

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

@@ -24,6 +24,7 @@ type SceneData = {
 };
 
 export default interface GET_ALL_SCENE_DATA {
+    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 {
+    DESCRIPTION: 'Set the background color of the scene.';
     PAYLOAD: { color: string | number };
     RETURN: boolean;
 }

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

@@ -1,4 +1,5 @@
 export default interface UPDATE_SCENE {
+    DESCRIPTION: 'Updates global scene data.';
     PAYLOAD: {
         name?: string;
         backgroundColor?: string | number;

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

@@ -1,4 +1,5 @@
 export default interface SET_GIZMO_MODE {
+    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 {
+    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';
 
 export default interface USE_TOOL {
+    DESCRIPTION: 'Activates a specific tool from the toolbox.';
     PAYLOAD: { tool: ToolType };
     RETURN: boolean;
 }