@shopware-ag/dive 1.16.1 → 1.16.2

package/build/dive.d.cts

@@ -141,6 +141,7 @@ declare class DIVEOrbitControls extends OrbitControls {
 }
 
 interface SET_BACKGROUND {
+    DESCRIPTION: 'Set the background color of the scene.';
     PAYLOAD: {
         color: string | number;
     };
@@ -148,6 +149,7 @@ interface SET_BACKGROUND {
 }
 
 interface RESET_CAMERA {
+    DESCRIPTION: 'Reset the camera to its initial position and rotation.';
     PAYLOAD: {
         duration: number;
     };
@@ -155,6 +157,7 @@ interface RESET_CAMERA {
 }
 
 interface SET_CAMERA_LAYER {
+    DESCRIPTION: 'Sets the camera layer to a certain layer.';
     PAYLOAD: {
         layer: 'LIVE' | 'EDITOR';
     };
@@ -162,6 +165,7 @@ interface SET_CAMERA_LAYER {
 }
 
 interface ZOOM_CAMERA {
+    DESCRIPTION: 'Zooms the camera in or out by a certain amount.';
     PAYLOAD: {
         direction: 'IN' | 'OUT';
         by: number;
@@ -170,6 +174,7 @@ interface ZOOM_CAMERA {
 }
 
 interface SET_GIZMO_MODE {
+    DESCRIPTION: "Sets the gizmo's mode.";
     PAYLOAD: {
         mode: 'translate' | 'rotate' | 'scale';
     };
@@ -177,6 +182,7 @@ interface SET_GIZMO_MODE {
 }
 
 interface SET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Sets the camera position and target.';
     PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;
@@ -185,6 +191,7 @@ interface SET_CAMERA_TRANSFORM {
 }
 
 interface MOVE_CAMERA {
+    DESCRIPTION: 'Moves the camera to a new position and target.';
     PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;
@@ -199,6 +206,7 @@ interface MOVE_CAMERA {
 }
 
 interface PLACE_ON_FLOOR {
+    DESCRIPTION: 'Places an object on the floor.';
     PAYLOAD: {
         id: string;
     };
@@ -274,11 +282,13 @@ type COMGroup = COMBaseEntity & {
 type COMEntity = COMPov | COMLight | COMModel | COMPrimitive | COMGroup;
 
 interface GET_ALL_OBJECTS {
+    readonly DESCRIPTION: 'Retrieves all objects in the scene.';
     PAYLOAD: Map<string, COMEntity>;
     RETURN: Map<string, COMEntity>;
 }
 
 interface GET_OBJECTS {
+    DESCRIPTION: 'Returns a list of objects of given IDs.';
     PAYLOAD: {
         ids: string[];
     };
@@ -286,11 +296,13 @@ interface GET_OBJECTS {
 }
 
 interface ADD_OBJECT {
+    DESCRIPTION: 'Adds an object to the scene.';
     PAYLOAD: COMEntity;
     RETURN: boolean;
 }
 
 interface DELETE_OBJECT {
+    DESCRIPTION: 'Deletes an object from the scene.';
     PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
@@ -298,6 +310,7 @@ interface DELETE_OBJECT {
 }
 
 interface UPDATE_OBJECT {
+    DESCRIPTION: 'Updates an existing object.';
     PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
@@ -305,6 +318,7 @@ interface UPDATE_OBJECT {
 }
 
 interface MODEL_LOADED {
+    DESCRIPTION: 'Is triggered when a model is loaded.';
     PAYLOAD: {
         id: string;
     };
@@ -312,6 +326,7 @@ interface MODEL_LOADED {
 }
 
 interface UPDATE_SCENE {
+    DESCRIPTION: 'Updates global scene data.';
     PAYLOAD: {
         name?: string;
         backgroundColor?: string | number;
@@ -323,6 +338,7 @@ interface UPDATE_SCENE {
 }
 
 interface GENERATE_MEDIA {
+    DESCRIPTION: 'Generates a screenshot, stores it in a Blob and writes the URL into the payload.';
     PAYLOAD: ({
         position: Vector3Like;
         target: Vector3Like;
@@ -353,11 +369,13 @@ type SceneData = {
     primitives: COMPrimitive[];
 };
 interface GET_ALL_SCENE_DATA {
+    DESCRIPTION: 'Retrieves all current scene data.';
     PAYLOAD: object;
     RETURN: SceneData;
 }
 
 interface SELECT_OBJECT {
+    DESCRIPTION: 'Selects an existing object.';
     PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
@@ -365,6 +383,7 @@ interface SELECT_OBJECT {
 }
 
 interface DESELECT_OBJECT {
+    DESCRIPTION: 'Deselects an existing object.';
     PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
@@ -372,6 +391,7 @@ interface DESELECT_OBJECT {
 }
 
 interface GET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Returns the current camera position and target.';
     PAYLOAD: object;
     RETURN: {
         position: Vector3Like;
@@ -380,6 +400,7 @@ interface GET_CAMERA_TRANSFORM {
 }
 
 interface DROP_IT {
+    DESCRIPTION: 'Places an object on top of an underlying object or the floor.';
     PAYLOAD: {
         id: string;
     };
@@ -387,11 +408,13 @@ interface DROP_IT {
 }
 
 interface SET_GIZMO_VISIBILITY {
+    DESCRIPTION: "Sets the gizmo's visibility.";
     PAYLOAD: boolean;
     RETURN: boolean;
 }
 
 interface COMPUTE_ENCOMPASSING_VIEW {
+    DESCRIPTION: 'Calculates the camera position and target to view the whole scene. (experimental)';
     PAYLOAD: object;
     RETURN: {
         position: Vector3Like;
@@ -796,6 +819,7 @@ declare class DIVEToolbox {
 }
 
 interface USE_TOOL {
+    DESCRIPTION: 'Activates a specific tool from the toolbox.';
     PAYLOAD: {
         tool: ToolType;
     };
@@ -803,6 +827,7 @@ interface USE_TOOL {
 }
 
 interface SET_PARENT {
+    DESCRIPTION: 'Attach an object to another object.';
     PAYLOAD: {
         object: Partial<COMEntity> & {
             id: string;
@@ -815,13 +840,14 @@ interface SET_PARENT {
 }
 
 interface EXPORT_SCENE {
+    DESCRIPTION: 'Exports the current scene to a blob and returns the URL.';
     PAYLOAD: {
         type: keyof DIVESceneFileType;
     };
     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,6 +141,7 @@ declare class DIVEOrbitControls extends OrbitControls {
 }
 
 interface SET_BACKGROUND {
+    DESCRIPTION: 'Set the background color of the scene.';
     PAYLOAD: {
         color: string | number;
     };
@@ -148,6 +149,7 @@ interface SET_BACKGROUND {
 }
 
 interface RESET_CAMERA {
+    DESCRIPTION: 'Reset the camera to its initial position and rotation.';
     PAYLOAD: {
         duration: number;
     };
@@ -155,6 +157,7 @@ interface RESET_CAMERA {
 }
 
 interface SET_CAMERA_LAYER {
+    DESCRIPTION: 'Sets the camera layer to a certain layer.';
     PAYLOAD: {
         layer: 'LIVE' | 'EDITOR';
     };
@@ -162,6 +165,7 @@ interface SET_CAMERA_LAYER {
 }
 
 interface ZOOM_CAMERA {
+    DESCRIPTION: 'Zooms the camera in or out by a certain amount.';
     PAYLOAD: {
         direction: 'IN' | 'OUT';
         by: number;
@@ -170,6 +174,7 @@ interface ZOOM_CAMERA {
 }
 
 interface SET_GIZMO_MODE {
+    DESCRIPTION: "Sets the gizmo's mode.";
     PAYLOAD: {
         mode: 'translate' | 'rotate' | 'scale';
     };
@@ -177,6 +182,7 @@ interface SET_GIZMO_MODE {
 }
 
 interface SET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Sets the camera position and target.';
     PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;
@@ -185,6 +191,7 @@ interface SET_CAMERA_TRANSFORM {
 }
 
 interface MOVE_CAMERA {
+    DESCRIPTION: 'Moves the camera to a new position and target.';
     PAYLOAD: {
         position: Vector3Like;
         target: Vector3Like;
@@ -199,6 +206,7 @@ interface MOVE_CAMERA {
 }
 
 interface PLACE_ON_FLOOR {
+    DESCRIPTION: 'Places an object on the floor.';
     PAYLOAD: {
         id: string;
     };
@@ -274,11 +282,13 @@ type COMGroup = COMBaseEntity & {
 type COMEntity = COMPov | COMLight | COMModel | COMPrimitive | COMGroup;
 
 interface GET_ALL_OBJECTS {
+    readonly DESCRIPTION: 'Retrieves all objects in the scene.';
     PAYLOAD: Map<string, COMEntity>;
     RETURN: Map<string, COMEntity>;
 }
 
 interface GET_OBJECTS {
+    DESCRIPTION: 'Returns a list of objects of given IDs.';
     PAYLOAD: {
         ids: string[];
     };
@@ -286,11 +296,13 @@ interface GET_OBJECTS {
 }
 
 interface ADD_OBJECT {
+    DESCRIPTION: 'Adds an object to the scene.';
     PAYLOAD: COMEntity;
     RETURN: boolean;
 }
 
 interface DELETE_OBJECT {
+    DESCRIPTION: 'Deletes an object from the scene.';
     PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
@@ -298,6 +310,7 @@ interface DELETE_OBJECT {
 }
 
 interface UPDATE_OBJECT {
+    DESCRIPTION: 'Updates an existing object.';
     PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
@@ -305,6 +318,7 @@ interface UPDATE_OBJECT {
 }
 
 interface MODEL_LOADED {
+    DESCRIPTION: 'Is triggered when a model is loaded.';
     PAYLOAD: {
         id: string;
     };
@@ -312,6 +326,7 @@ interface MODEL_LOADED {
 }
 
 interface UPDATE_SCENE {
+    DESCRIPTION: 'Updates global scene data.';
     PAYLOAD: {
         name?: string;
         backgroundColor?: string | number;
@@ -323,6 +338,7 @@ interface UPDATE_SCENE {
 }
 
 interface GENERATE_MEDIA {
+    DESCRIPTION: 'Generates a screenshot, stores it in a Blob and writes the URL into the payload.';
     PAYLOAD: ({
         position: Vector3Like;
         target: Vector3Like;
@@ -353,11 +369,13 @@ type SceneData = {
     primitives: COMPrimitive[];
 };
 interface GET_ALL_SCENE_DATA {
+    DESCRIPTION: 'Retrieves all current scene data.';
     PAYLOAD: object;
     RETURN: SceneData;
 }
 
 interface SELECT_OBJECT {
+    DESCRIPTION: 'Selects an existing object.';
     PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
@@ -365,6 +383,7 @@ interface SELECT_OBJECT {
 }
 
 interface DESELECT_OBJECT {
+    DESCRIPTION: 'Deselects an existing object.';
     PAYLOAD: Partial<COMEntity> & {
         id: string;
     };
@@ -372,6 +391,7 @@ interface DESELECT_OBJECT {
 }
 
 interface GET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Returns the current camera position and target.';
     PAYLOAD: object;
     RETURN: {
         position: Vector3Like;
@@ -380,6 +400,7 @@ interface GET_CAMERA_TRANSFORM {
 }
 
 interface DROP_IT {
+    DESCRIPTION: 'Places an object on top of an underlying object or the floor.';
     PAYLOAD: {
         id: string;
     };
@@ -387,11 +408,13 @@ interface DROP_IT {
 }
 
 interface SET_GIZMO_VISIBILITY {
+    DESCRIPTION: "Sets the gizmo's visibility.";
     PAYLOAD: boolean;
     RETURN: boolean;
 }
 
 interface COMPUTE_ENCOMPASSING_VIEW {
+    DESCRIPTION: 'Calculates the camera position and target to view the whole scene. (experimental)';
     PAYLOAD: object;
     RETURN: {
         position: Vector3Like;
@@ -796,6 +819,7 @@ declare class DIVEToolbox {
 }
 
 interface USE_TOOL {
+    DESCRIPTION: 'Activates a specific tool from the toolbox.';
     PAYLOAD: {
         tool: ToolType;
     };
@@ -803,6 +827,7 @@ interface USE_TOOL {
 }
 
 interface SET_PARENT {
+    DESCRIPTION: 'Attach an object to another object.';
     PAYLOAD: {
         object: Partial<COMEntity> & {
             id: string;
@@ -815,13 +840,14 @@ interface SET_PARENT {
 }
 
 interface EXPORT_SCENE {
+    DESCRIPTION: 'Exports the current scene to a blob and returns the URL.';
     PAYLOAD: {
         type: keyof DIVESceneFileType;
     };
     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.js

@@ -2863,7 +2863,7 @@ DIVEInfo._supportsWebXR = null;
 // package.json
 var package_default = {
   name: "@shopware-ag/dive",
-  version: "1.16.1",
+  version: "1.16.2",
   description: "Shopware Spatial Framework",
   type: "module",
   main: "./build/dive.cjs",
@@ -2912,19 +2912,27 @@ var package_default = {
     "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')"`
   }
 };