@shopware-ag/dive 1.16.4 → 1.16.6

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shopware-ag/dive",
-    "version": "1.16.4",
+    "version": "1.16.6",
     "description": "Shopware Spatial Framework",
     "type": "module",
     "main": "./build/dive.cjs",

package/src/__test__/DIVE.test.ts

@@ -208,6 +208,14 @@ describe('dive/DIVE', () => {
         expect(() => (window as any).DIVE.PrintScene()).not.toThrow();
     });
 
+    it('should instantiate in development NODE_ENV', () => {
+        process.env.NODE_ENV = 'development';
+        const dive = new DIVE();
+        expect(dive).toBeDefined();
+        expect((window as any).DIVE.PrintScene).toBeDefined();
+        expect(() => (window as any).DIVE.PrintScene()).not.toThrow();
+    });
+
     it('should dispose', () => {
         let dive = new DIVE();
         expect(() => dive.Dispose()).not.toThrow();

package/src/com/Communication.ts

@@ -516,9 +516,10 @@ export class DIVECommunication {
     private placeOnFloor(
         payload: Actions['PLACE_ON_FLOOR']['PAYLOAD'],
     ): Actions['PLACE_ON_FLOOR']['RETURN'] {
-        if (!this.registered.get(payload.id)) return false;
+        const object = this.registered.get(payload.id);
+        if (!object) return false;
 
-        this.scene.PlaceOnFloor(payload);
+        this.scene.PlaceOnFloor(object);
 
         return true;
     }

package/src/dive.ts

@@ -277,7 +277,9 @@ export default class DIVE {
             },
         };
 
-        console.log(`DIVE ${pkgjson.version} initialized`);
+        console.log(
+            `DIVE ${pkgjson.version} initialized ${process.env.NODE_ENV === 'development' ? 'in development mode' : ''}`,
+        );
     }
 
     public Dispose(): void {

package/src/model/Model.ts

@@ -1,6 +1,5 @@
 import { Mesh, MeshStandardMaterial, Raycaster, Vector3 } from 'three';
 import { PRODUCT_LAYER_MASK } from '../constant/VisibilityLayerMask';
-import { DIVECommunication } from '../com/Communication';
 import type { GLTF } from 'three/examples/jsm/Addons.js';
 import { findSceneRecursive } from '../helper/findSceneRecursive/findSceneRecursive';
 import { type COMMaterial } from '../com/types';
@@ -111,16 +110,11 @@ export class DIVEModel extends DIVENode {
     }
 
     public PlaceOnFloor(): void {
+        const oldPos = this.position.clone();
         this.position.y = -this._boundingBox.min.y * this.scale.y;
-        DIVECommunication.get(this.userData.id)?.PerformAction(
-            'UPDATE_OBJECT',
-            {
-                id: this.userData.id,
-                position: this.position,
-                rotation: this.rotation,
-                scale: this.scale,
-            },
-        );
+        if (this.position.y === oldPos.y) return;
+
+        this.onMove();
     }
 
     public DropIt(): void {
@@ -163,15 +157,8 @@ export class DIVEModel extends DIVENode {
 
             // if the position changed, update the object in communication
             if (this.position.y === oldPos.y) return;
-            DIVECommunication.get(this.userData.id)?.PerformAction(
-                'UPDATE_OBJECT',
-                {
-                    id: this.userData.id,
-                    position: this.position,
-                    rotation: this.rotation,
-                    scale: this.scale,
-                },
-            );
+
+            this.onMove();
         }
     }
 }

package/src/model/__test__/Model.test.ts

@@ -228,10 +228,14 @@ describe('dive/model/DIVEModel', () => {
     it('should place on floor', () => {
         model.userData.id = 'something';
 
+        const spy = jest.spyOn(model, 'onMove').mockImplementation(() => {});
+
         expect(() => model.PlaceOnFloor()).not.toThrow();
+        expect(spy).toHaveBeenCalledTimes(1);
 
         jest.spyOn(DIVECommunication, 'get').mockReturnValueOnce(undefined);
         expect(() => model.PlaceOnFloor()).not.toThrow();
+        expect(spy).toHaveBeenCalledTimes(1);
     });
 
     it('should drop it', () => {
@@ -240,6 +244,8 @@ describe('dive/model/DIVEModel', () => {
         } as unknown as DIVECommunication;
         jest.spyOn(DIVECommunication, 'get').mockReturnValue(comMock);
 
+        const spy = jest.spyOn(model, 'onMove').mockImplementation(() => {});
+
         const size = {
             x: 1,
             y: 1,
@@ -284,16 +290,16 @@ describe('dive/model/DIVEModel', () => {
 
         expect(() => model.DropIt()).not.toThrow();
         expect(model.position.y).toBe(2.5);
-        expect(comMock.PerformAction).toHaveBeenCalledTimes(1);
+        expect(spy).toHaveBeenCalledTimes(1);
 
         expect(() => model.DropIt()).not.toThrow();
-        expect(comMock.PerformAction).toHaveBeenCalledTimes(1);
+        expect(spy).toHaveBeenCalledTimes(1);
 
-        // reset for PerformAction to be called again
+        // alter position so onMove will be called again
         model.position.y = 2;
         jest.spyOn(DIVECommunication, 'get').mockReturnValueOnce(undefined);
         expect(() => model.DropIt()).not.toThrow();
-        expect(comMock.PerformAction).toHaveBeenCalledTimes(1);
+        expect(spy).toHaveBeenCalledTimes(2);
     });
 
     it('should set material', () => {

package/src/primitive/Primitive.ts

@@ -10,7 +10,6 @@ import {
     SphereGeometry,
     Vector3,
 } from 'three';
-import { DIVECommunication } from '../com/Communication';
 import { PRODUCT_LAYER_MASK } from '../constant/VisibilityLayerMask';
 import { findSceneRecursive } from '../helper/findSceneRecursive/findSceneRecursive';
 import { DIVENode } from '../node/Node';
@@ -107,16 +106,11 @@ export class DIVEPrimitive extends DIVENode {
     }
 
     public PlaceOnFloor(): void {
+        const oldPos = this.position.clone();
         this.position.y = -this._boundingBox.min.y * this.scale.y;
-        DIVECommunication.get(this.userData.id)?.PerformAction(
-            'UPDATE_OBJECT',
-            {
-                id: this.userData.id,
-                position: this.position,
-                rotation: this.rotation,
-                scale: this.scale,
-            },
-        );
+        if (this.position.y === oldPos.y) return;
+
+        this.onMove();
     }
 
     public DropIt(): void {
@@ -159,15 +153,8 @@ export class DIVEPrimitive extends DIVENode {
 
             // if the position changed, update the object in communication
             if (this.position.y === oldPos.y) return;
-            DIVECommunication.get(this.userData.id)?.PerformAction(
-                'UPDATE_OBJECT',
-                {
-                    id: this.userData.id,
-                    position: this.position,
-                    rotation: this.rotation,
-                    scale: this.scale,
-                },
-            );
+
+            this.onMove();
         }
     }
 

package/src/primitive/__test__/Primitive.test.ts

@@ -255,6 +255,10 @@ describe('dive/primitive/DIVEPrimitive', () => {
         } as unknown as DIVECommunication;
         jest.spyOn(DIVECommunication, 'get').mockReturnValue(comMock);
 
+        const spy = jest
+            .spyOn(primitive, 'onMove')
+            .mockImplementation(() => {});
+
         const size = {
             x: 1,
             y: 1,
@@ -299,16 +303,16 @@ describe('dive/primitive/DIVEPrimitive', () => {
 
         expect(() => primitive.DropIt()).not.toThrow();
         expect(primitive.position.y).toBe(2.5);
-        expect(comMock.PerformAction).toHaveBeenCalledTimes(1);
+        expect(spy).toHaveBeenCalledTimes(1);
 
         expect(() => primitive.DropIt()).not.toThrow();
-        expect(comMock.PerformAction).toHaveBeenCalledTimes(1);
+        expect(spy).toHaveBeenCalledTimes(1);
 
-        // reset for PerformAction to be called again
+        // alter position so onMove will be called again
         primitive.position.y = 2;
         jest.spyOn(DIVECommunication, 'get').mockReturnValueOnce(undefined);
         expect(() => primitive.DropIt()).not.toThrow();
-        expect(comMock.PerformAction).toHaveBeenCalledTimes(1);
+        expect(spy).toHaveBeenCalledTimes(2);
     });
 
     it('should set geometry', () => {

package/src/scene/Scene.ts

@@ -64,18 +64,20 @@ export class DIVEScene extends Scene {
     }
 
     public UpdateSceneObject(
-        object: Partial<COMEntity> & { id: string },
+        object: Partial<COMEntity> & { id: string; entityType: string },
     ): void {
         this.Root.UpdateSceneObject(object);
     }
 
     public DeleteSceneObject(
-        object: Partial<COMEntity> & { id: string },
+        object: Partial<COMEntity> & { id: string; entityType: string },
     ): void {
         this.Root.DeleteSceneObject(object);
     }
 
-    public PlaceOnFloor(object: Partial<COMModel> & { id: string }): void {
+    public PlaceOnFloor(
+        object: Partial<COMModel> & { id: string; entityType: string },
+    ): void {
         this.Root.PlaceOnFloor(object);
     }
 }

package/src/scene/root/Root.ts

@@ -66,7 +66,7 @@ export class DIVERoot extends Object3D {
                 break;
             }
             case 'light': {
-                this.updateLight(object);
+                this.updateLight(object as COMLight);
                 break;
             }
             case 'model': {
@@ -90,14 +90,14 @@ export class DIVERoot extends Object3D {
     }
 
     public UpdateSceneObject(
-        object: Partial<COMEntity> & { id: string },
+        object: Partial<COMEntity> & { id: string; entityType: string },
     ): void {
         switch (object.entityType) {
             case 'pov': {
                 break;
             }
             case 'light': {
-                this.updateLight(object);
+                this.updateLight(object as COMLight);
                 break;
             }
             case 'model': {
@@ -121,7 +121,7 @@ export class DIVERoot extends Object3D {
     }
 
     public DeleteSceneObject(
-        object: Partial<COMEntity> & { id: string },
+        object: Partial<COMEntity> & { id: string; entityType: string },
     ): void {
         switch (object.entityType) {
             case 'pov': {
@@ -151,7 +151,9 @@ export class DIVERoot extends Object3D {
         }
     }
 
-    public PlaceOnFloor(object: Partial<COMEntity> & { id: string }): void {
+    public PlaceOnFloor(
+        object: Partial<COMEntity> & { id: string; entityType: string },
+    ): void {
         switch (object.entityType) {
             case 'pov':
             case 'light': {
@@ -170,7 +172,13 @@ export class DIVERoot extends Object3D {
         }
     }
 
-    private updateLight(light: Partial<COMLight> & { id: string }): void {
+    private updateLight(
+        light: Partial<COMLight> & {
+            id: string;
+            entityType: string;
+            type: string;
+        },
+    ): void {
         let sceneObject = this.GetSceneObject(light);
         if (!sceneObject) {
             switch (light.type) {

package/src/scene/root/__test__/Root.test.ts

@@ -413,8 +413,6 @@ jest.mock('../../../group/Group.ts', () => {
 
 let root: DIVERoot;
 
-jest.spyOn(console, 'warn').mockImplementation(() => {});
-
 describe('DIVE/scene/root/DIVERoot', () => {
     beforeEach(() => {
         root = new DIVERoot();
@@ -714,6 +712,22 @@ describe('DIVE/scene/root/DIVERoot', () => {
                 parentId: 'does_not_exist',
             } as COMGroup),
         ).not.toThrow();
+
+        jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
+        expect(() =>
+            root.UpdateSceneObject({
+                entityType: 'INVALID' as COMEntityType,
+            } as COMPrimitive),
+        ).not.toThrow();
+        expect(console.warn).toHaveBeenCalled();
+
+        jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
+        expect(() =>
+            root.UpdateSceneObject({
+                entityType: undefined,
+            } as unknown as COMPrimitive),
+        ).not.toThrow();
+        expect(console.warn).toHaveBeenCalled();
     });
 
     it('should delete object', () => {
@@ -846,6 +860,22 @@ describe('DIVE/scene/root/DIVERoot', () => {
                 visible: true,
             } as COMGroup),
         ).not.toThrow();
+
+        jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
+        expect(() =>
+            root.DeleteSceneObject({
+                entityType: 'INVALID' as COMEntityType,
+            } as COMPrimitive),
+        ).not.toThrow();
+        expect(console.warn).toHaveBeenCalled();
+
+        jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
+        expect(() =>
+            root.DeleteSceneObject({
+                entityType: undefined,
+            } as unknown as COMPrimitive),
+        ).not.toThrow();
+        expect(console.warn).toHaveBeenCalled();
     });
 
     it('should place object on floor', () => {
@@ -928,10 +958,28 @@ describe('DIVE/scene/root/DIVERoot', () => {
                 visible: true,
             } as COMPrimitive),
         ).not.toThrow();
+
+        jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
+        expect(() =>
+            root.PlaceOnFloor({
+                entityType: 'INVALID' as COMEntityType,
+            } as COMPrimitive),
+        ).not.toThrow();
+        expect(console.warn).toHaveBeenCalled();
+
+        jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
+        expect(() =>
+            root.PlaceOnFloor({
+                entityType: undefined,
+            } as unknown as COMPrimitive),
+        ).not.toThrow();
+        expect(console.warn).toHaveBeenCalled();
     });
 
     it('should warn if entity type is invalid while adding object', () => {
-        const spy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+        const spy = jest
+            .spyOn(console, 'warn')
+            .mockImplementationOnce(() => {});
         expect(() =>
             root.AddSceneObject({
                 id: 'id',
@@ -944,7 +992,9 @@ describe('DIVE/scene/root/DIVERoot', () => {
     });
 
     it('should warn if entity type is invalid while updating object', () => {
-        const spy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+        const spy = jest
+            .spyOn(console, 'warn')
+            .mockImplementationOnce(() => {});
         expect(() =>
             root.UpdateSceneObject({
                 id: 'id',
@@ -957,7 +1007,9 @@ describe('DIVE/scene/root/DIVERoot', () => {
     });
 
     it('should warn if entity type is invalid while deleting object', () => {
-        const spy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+        const spy = jest
+            .spyOn(console, 'warn')
+            .mockImplementationOnce(() => {});
         expect(() =>
             root.DeleteSceneObject({
                 id: 'id',
@@ -970,7 +1022,9 @@ describe('DIVE/scene/root/DIVERoot', () => {
     });
 
     it('should warn if entity type is invalid while placing on floor', () => {
-        const spy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+        const spy = jest
+            .spyOn(console, 'warn')
+            .mockImplementationOnce(() => {});
         expect(() =>
             root.PlaceOnFloor({
                 id: 'id',