@shopware-ag/dive 1.19.0 → 1.19.1-beta.1

package/src/helper/isInterface/__test__/implementsInterface.test.ts

@@ -1,19 +0,0 @@
-import { Object3D } from 'three';
-import { implementsInterface } from '../implementsInterface.ts';
-
-describe('dive/helper/implementsInterface', () => {
-    it('should not find interface', () => {
-        expect(implementsInterface(undefined, 'isInterface')).toBe(false);
-
-        expect(implementsInterface(null, 'isInterface')).toBe(false);
-
-        const obj = {} as unknown as Object3D;
-
-        expect(implementsInterface(obj, 'isInterface')).toBe(false);
-    });
-
-    it('should find interface', () => {
-        const obj = { isInterface: true } as unknown as Object3D;
-        expect(implementsInterface(obj, 'isInterface')).toBe(true);
-    });
-});

package/src/helper/isInterface/implementsInterface.ts

@@ -1,9 +0,0 @@
-import { type Object3D } from 'three';
-
-export function implementsInterface<T>(
-    object: Object3D | null | undefined,
-    discriminator: string,
-): object is Object3D & T {
-    if (!object) return false;
-    return discriminator in object;
-}

package/src/info/Info.ts

@@ -1,154 +0,0 @@
-export enum WebXRUnsupportedReason {
-    'UNKNWON_ERROR' = 0,
-    'NO_HTTPS' = 1,
-    'IMMERSIVE_AR_NOT_SUPPORTED_BY_DEVICE' = 2,
-    'AR_SESSION_NOT_ALLOWED' = 3,
-}
-
-export class DIVEInfo {
-    private static _supportsWebXR: boolean | null = null;
-    private static _webXRUnsupportedReason: WebXRUnsupportedReason | null =
-        null;
-
-    /**
-     *
-     * @returns The system the user is using. Possible values are "Android", "iOS", "Windows", "MacOS", "Linux" or "Unknown".
-     */
-    public static GetSystem(): string {
-        const platform = navigator.platform;
-        if (/Android/.test(navigator.userAgent)) {
-            return 'Android';
-        } else if (/iPhone|iPad|iPod/.test(navigator.userAgent)) {
-            return 'iOS';
-        } else if (platform.startsWith('Win')) {
-            return 'Windows';
-        } else if (platform.startsWith('Mac')) {
-            return 'MacOS';
-        } else if (platform.startsWith('Linux')) {
-            return 'Linux';
-        } else {
-            return 'Unknown';
-        }
-    }
-
-    /**
-     * @returns A promise that resolves to a boolean indicating whether the user's device supports WebXR.
-     */
-    public static async GetSupportsWebXR(): Promise<boolean> {
-        if (this._supportsWebXR !== null) {
-            return this._supportsWebXR;
-        }
-
-        // check if XRSystem is available && if https enabled
-        if (!navigator.xr) {
-            this._supportsWebXR = false;
-
-            if (window.isSecureContext === false) {
-                this._webXRUnsupportedReason = WebXRUnsupportedReason.NO_HTTPS;
-            } else {
-                this._webXRUnsupportedReason =
-                    WebXRUnsupportedReason.UNKNWON_ERROR;
-            }
-
-            return this._supportsWebXR;
-        }
-
-        // Check if immersive-vr session mode is supported
-        try {
-            const supported =
-                await navigator.xr!.isSessionSupported('immersive-ar');
-            if (!supported) {
-                this._webXRUnsupportedReason =
-                    WebXRUnsupportedReason.IMMERSIVE_AR_NOT_SUPPORTED_BY_DEVICE;
-            }
-            this._supportsWebXR = supported;
-        } catch (error) {
-            this._supportsWebXR = false;
-            this._webXRUnsupportedReason =
-                WebXRUnsupportedReason.AR_SESSION_NOT_ALLOWED;
-        }
-        return this._supportsWebXR;
-    }
-
-    /**
-     * @returns The reason why WebXR is not supported on the user's device. Returns null if WebXR is supported nor not has been checked yet.
-     */
-    public static GetWebXRUnsupportedReason(): WebXRUnsupportedReason | null {
-        if (this._supportsWebXR === null) {
-            console.log('WebXR support has not been checked yet.');
-            return null;
-        }
-        return this._webXRUnsupportedReason;
-    }
-
-    /**
-     * @returns A boolean indicating whether the user's device supports AR Quick Look.
-     */
-    public static GetSupportsARQuickLook(): boolean {
-        const a = document.createElement('a');
-        if (a.relList.supports('ar')) {
-            return true;
-        }
-
-        // fallback check
-        const userAgent = navigator.userAgent;
-
-        // Check if the device is running iOS
-        const isIOS =
-            /iPad|iPhone|iPod/.test(userAgent) &&
-            !(window as unknown as Window & { MSStream?: string }).MSStream;
-        if (!isIOS) {
-            return false;
-        }
-
-        // Extract iOS version
-        const match = userAgent.match(/OS (\d+)_/);
-        if (!match || match.length < 2) {
-            return false;
-        }
-        const iOSVersion = parseInt(match[1], 10);
-
-        // Minimum iOS version for QuickLook support
-        const minQuickLookVersion = 12;
-
-        // Check if the iOS version is supported
-        if (iOSVersion < minQuickLookVersion) {
-            return false;
-        }
-
-        // Check for supported browser
-        const isSupportedBrowser =
-            /^((?!chrome|android).)*safari|CriOS|FxiOS/i.test(userAgent);
-        if (isSupportedBrowser) {
-            return true;
-        }
-
-        // Default to false if none of the conditions are met
-        return false;
-    }
-
-    /**
-     * @returns A boolean indicating whether the user's device is a mobile device.
-     */
-    public static get isMobile(): boolean {
-        return this.GetSystem() === 'Android' || this.GetSystem() === 'iOS';
-    }
-
-    /**
-     * @returns A boolean indicating whether the user's device is a desktop device.
-     */
-    public static get isDesktop(): boolean {
-        return !this.isMobile;
-    }
-
-    /**
-     * @returns A promise that resolves to a boolean indicating whether the user's device is capable of AR.
-     */
-    public static async GetIsARCapable(): Promise<boolean> {
-        if (this.GetSupportsARQuickLook()) {
-            return true;
-        }
-
-        return await this.GetSupportsWebXR();
-    }
-}

package/src/info/__test__/Info.test.ts

@@ -1,338 +0,0 @@
-import { DIVEInfo, WebXRUnsupportedReason } from '../Info';
-
-const mockNavigator = (navigator: any) => {
-    Object.defineProperty(global, 'navigator', {
-        value: navigator,
-        writable: true,
-    });
-};
-
-describe('dive/info/DIVEInfo', () => {
-    beforeEach(() => {
-        DIVEInfo['_supportsWebXR'] = null;
-        jest.clearAllMocks();
-    });
-
-    it('should get system: Windows', () => {
-        mockNavigator({
-            platform: 'Win64',
-        });
-        expect(DIVEInfo.GetSystem()).toBe('Windows');
-    });
-
-    it('should get system: MacOS', () => {
-        mockNavigator({
-            platform: 'MacIntel',
-        });
-        expect(DIVEInfo.GetSystem()).toBe('MacOS');
-    });
-
-    it('should get system: Linux', () => {
-        mockNavigator({
-            platform: 'Linux',
-        });
-        expect(DIVEInfo.GetSystem()).toBe('Linux');
-    });
-
-    it('should get system: Android', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3',
-            platform: 'Linux',
-        });
-        expect(DIVEInfo.GetSystem()).toBe('Android');
-    });
-
-    it('should get system: iOS', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS 17_0_1 like Mac OS X) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3',
-            platform: 'iPhone',
-        });
-        expect(DIVEInfo.GetSystem()).toBe('iOS');
-    });
-
-    it('should get system: Unknown', () => {
-        mockNavigator({
-            platform: 'Unknown',
-        });
-        expect(DIVEInfo.GetSystem()).toBe('Unknown');
-    });
-
-    it('should support webXR', async () => {
-        mockNavigator({
-            xr: {
-                isSessionSupported: jest.fn().mockResolvedValue(true),
-            },
-        });
-        const supports = await DIVEInfo.GetSupportsWebXR();
-        expect(supports).toBe(true);
-    });
-
-    it('should not support webXR (xr undefined)', async () => {
-        mockNavigator({
-            xr: undefined,
-        });
-        const supports = await DIVEInfo.GetSupportsWebXR();
-        expect(supports).toBe(false);
-
-        const reason = DIVEInfo.GetWebXRUnsupportedReason();
-        expect(reason).toBe(WebXRUnsupportedReason.UNKNWON_ERROR);
-    });
-
-    it('should not support webXR (xr undefined & isSecureContext false)', async () => {
-        window.isSecureContext = false;
-        mockNavigator({
-            xr: undefined,
-        });
-        const supports = await DIVEInfo.GetSupportsWebXR();
-        expect(supports).toBe(false);
-
-        const reason = DIVEInfo.GetWebXRUnsupportedReason();
-        expect(reason).toBe(WebXRUnsupportedReason.NO_HTTPS);
-    });
-
-    it('should get empty reason (not checked)', async () => {
-        mockNavigator({
-            xr: {
-                isSessionSupported: jest.fn().mockResolvedValue(true),
-            },
-        });
-        console.log = jest.fn();
-        const reason = DIVEInfo.GetWebXRUnsupportedReason();
-        expect(reason).toBe(null);
-    });
-
-    it('should get empty reason (webXR supported)', async () => {
-        mockNavigator({
-            xr: {
-                isSessionSupported: jest.fn().mockResolvedValue(true),
-            },
-        });
-        const reason = DIVEInfo.GetWebXRUnsupportedReason();
-        expect(reason).toBe(null);
-    });
-
-    it('should not support webXR', async () => {
-        mockNavigator({
-            xr: {
-                isSessionSupported: jest.fn().mockResolvedValue(false),
-            },
-        });
-        const supports = await DIVEInfo.GetSupportsWebXR();
-        expect(supports).toBe(false);
-
-        const reason = DIVEInfo.GetWebXRUnsupportedReason();
-        expect(reason).toBe(
-            WebXRUnsupportedReason.IMMERSIVE_AR_NOT_SUPPORTED_BY_DEVICE,
-        );
-    });
-
-    it('should not support webXR on error', async () => {
-        mockNavigator({
-            xr: {
-                isSessionSupported: jest.fn().mockRejectedValue('error'),
-            },
-        });
-        const supports = await DIVEInfo.GetSupportsWebXR();
-        expect(supports).toBe(false);
-
-        const reason = DIVEInfo.GetWebXRUnsupportedReason();
-        expect(reason).toBe(WebXRUnsupportedReason.AR_SESSION_NOT_ALLOWED);
-    });
-
-    it('should return cached value', async () => {
-        DIVEInfo['_supportsWebXR'] = true;
-        mockNavigator({
-            xr: {
-                isSessionSupported: jest.fn().mockRejectedValue('error'),
-            },
-        });
-        const supports = await DIVEInfo.GetSupportsWebXR();
-        expect(supports).toBe(true);
-    });
-
-    it('should return cached value (false)', async () => {
-        DIVEInfo['_supportsWebXR'] = false;
-        mockNavigator({
-            xr: {
-                isSessionSupported: jest.fn().mockRejectedValue('error'),
-            },
-        });
-        const supports = await DIVEInfo.GetSupportsWebXR();
-        expect(supports).toBe(false);
-    });
-
-    it('should support ARQuickLook with feature detection', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS 15_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.1 Mobile/15E148 Safari/604.',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => true },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(true);
-    });
-
-    it('should support ARQuickLook (iPhone, iOS 15, Safari)', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS 15_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.1 Mobile/15E148 Safari/604.',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(true);
-    });
-
-    it('should support ARQuickLook (iPhone, iOS 17, Google)', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS 17_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) GSA/277.0.555192628 Mobile/15E148 Safari/604.',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(true);
-    });
-
-    it('should support ARQuickLook (iPhone, iOS 17, Chrome)', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS 17_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/126.0.6478.153 Mobile/15E148 Safari/604.',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(true);
-    });
-
-    it('should support ARQuickLook (iPhone, iOS 17, Chrome)', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS 17_1 like Mac OS X) AppleWebKit/605.1.11 (KHTML, like Gecko) Version/11.1 Mobile/11E148 CriOS/604.',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(true);
-    });
-
-    it('should support ARQuickLook (iPhone, iOS 17, Firefox)', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS 17_1 like Mac OS X) AppleWebKit/605.1.11 (KHTML, like Gecko) Version/11.1 Mobile/11E148 FxiOS/604.',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(true);
-    });
-
-    it('should not support ARQuickLook (Android)', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Mobile Safari/537.3',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(false);
-    });
-
-    it('should not support ARQuickLook (iPhone, no iOS version)', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS like Mac OS X) AppleWebKit/605.1.11 (KHTML, like Gecko) Version/11.1 Mobile/11E148 Safari/604.',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(false);
-    });
-
-    it('should not support ARQuickLook (iPhone, iOS 17, no browser)', () => {
-        mockNavigator({
-            userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 17_1 like Mac OS X)',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(false);
-    });
-
-    it('should not support ARQuickLook (iPhone, iOS <12, Safari)', () => {
-        mockNavigator({
-            userAgent:
-                'Mozilla/5.0 (iPhone; CPU iPhone OS 11_1 like Mac OS X) AppleWebKit/605.1.11 (KHTML, like Gecko) Version/11.1 Mobile/11E148 Safari/604.',
-        });
-        jest.spyOn(document, 'createElement').mockReturnValue({
-            relList: { supports: () => false },
-        } as unknown as HTMLAnchorElement);
-        const supports = DIVEInfo.GetSupportsARQuickLook();
-        expect(supports).toBe(false);
-    });
-
-    it('should be mobile (iOS)', () => {
-        jest.spyOn(DIVEInfo, 'GetSystem').mockReturnValue('iOS');
-        expect(DIVEInfo.isMobile).toBe(true);
-        expect(DIVEInfo.isDesktop).toBe(false);
-    });
-
-    it('should be mobile (Android)', () => {
-        jest.spyOn(DIVEInfo, 'GetSystem').mockReturnValue('Android');
-        expect(DIVEInfo.isMobile).toBe(true);
-        expect(DIVEInfo.isDesktop).toBe(false);
-    });
-
-    it('should be desktop (Windows)', () => {
-        jest.spyOn(DIVEInfo, 'GetSystem').mockReturnValue('Windows');
-        expect(DIVEInfo.isMobile).toBe(false);
-        expect(DIVEInfo.isDesktop).toBe(true);
-    });
-
-    it('should be desktop (MacOS)', () => {
-        jest.spyOn(DIVEInfo, 'GetSystem').mockReturnValue('MacOS');
-        expect(DIVEInfo.isMobile).toBe(false);
-        expect(DIVEInfo.isDesktop).toBe(true);
-    });
-
-    it('should be desktop (Linux)', () => {
-        jest.spyOn(DIVEInfo, 'GetSystem').mockReturnValue('Linux');
-        expect(DIVEInfo.isMobile).toBe(false);
-        expect(DIVEInfo.isDesktop).toBe(true);
-    });
-
-    it('should be desktop (Unknown)', () => {
-        jest.spyOn(DIVEInfo, 'GetSystem').mockReturnValue('Unknown');
-        expect(DIVEInfo.isMobile).toBe(false);
-        expect(DIVEInfo.isDesktop).toBe(true);
-    });
-
-    it('should be capable of AR (ARQuickLook)', async () => {
-        jest.spyOn(DIVEInfo, 'GetSupportsARQuickLook').mockReturnValue(true);
-        jest.spyOn(DIVEInfo, 'GetSupportsWebXR').mockResolvedValue(false);
-        expect(await DIVEInfo.GetIsARCapable()).toBe(true);
-    });
-
-    it('should be capable of AR (WebXR)', async () => {
-        jest.spyOn(DIVEInfo, 'GetSupportsARQuickLook').mockReturnValue(false);
-        jest.spyOn(DIVEInfo, 'GetSupportsWebXR').mockResolvedValue(true);
-        expect(await DIVEInfo.GetIsARCapable()).toBe(true);
-    });
-
-    it('should not be capable of AR', async () => {
-        jest.spyOn(DIVEInfo, 'GetSupportsARQuickLook').mockReturnValue(false);
-        jest.spyOn(DIVEInfo, 'GetSupportsWebXR').mockResolvedValue(false);
-        expect(await DIVEInfo.GetIsARCapable()).toBe(false);
-    });
-});

package/src/interface/Draggable.ts

@@ -1,14 +0,0 @@
-/**
- * Interface for objects that can be hovered in the scene.
- *
- * @module
- */
-
-import { type DraggableEvent } from '../toolbox/BaseTool';
-
-export interface DIVEDraggable {
-    isDraggable: true;
-    onDragStart?: (e: DraggableEvent) => void;
-    onDrag?: (e: DraggableEvent) => void;
-    onDragEnd?: (e: DraggableEvent) => void;
-}

package/src/interface/Hoverable.ts

@@ -1,14 +0,0 @@
-/**
- * Interface for objects that can be hovered in the scene.
- *
- * @module
- */
-
-import { type Intersection } from 'three';
-
-export interface DIVEHoverable {
-    isHoverable: true;
-    onPointerEnter?: (i: Intersection) => void;
-    onPointerOver?: (i: Intersection) => void;
-    onPointerLeave?: () => void;
-}

package/src/interface/Movable.ts

@@ -1,12 +0,0 @@
-/**
- * Interface for objects that can be moved in the scene.
- *
- * @module
- */
-
-export interface DIVEMovable {
-    isMovable: true;
-    onMoveStart?: () => void;
-    onMove?: () => void;
-    onMoveEnd?: () => void;
-}

package/src/interface/Rotatable.ts

@@ -1,10 +0,0 @@
-/**
- * Interface for objects that can be rotated in the scene.
- *
- * @module
- */
-
-export interface DIVERotatable {
-    isRotatable: true;
-    onRotate?: () => void;
-}

package/src/interface/Scalable.ts

@@ -1,10 +0,0 @@
-/**
- * Interface for objects that can be scaled in the scene.
- *
- * @module
- */
-
-export interface DIVEScalable {
-    isScalable: true;
-    onScale?: () => void;
-}

package/src/interface/Selectable.ts

@@ -1,11 +0,0 @@
-/**
- * Interface for objects that can be selected in the scene.
- *
- * @module
- */
-
-export interface DIVESelectable {
-    isSelectable: true;
-    onSelect?: () => void;
-    onDeselect?: () => void;
-}

package/src/io/IO.ts

@@ -1,62 +0,0 @@
-import { DIVEGLTFIO } from './gltf/GLTFIO';
-
-import { type DIVESceneFileType } from '../types';
-import { type DIVEScene } from '../scene/Scene';
-
-export class DIVEIO {
-    private _scene: DIVEScene;
-
-    private _gltfIO: DIVEGLTFIO;
-
-    constructor(scene: DIVEScene) {
-        this._scene = scene;
-
-        this._gltfIO = new DIVEGLTFIO();
-    }
-
-    public Import<FileType extends keyof DIVESceneFileType>(
-        type: FileType,
-        url: string,
-    ): Promise<DIVESceneFileType[FileType] | null> {
-        switch (type) {
-            case 'glb': {
-                return this._gltfIO.Import(url).catch((error) => {
-                    console.error(error);
-                    return null;
-                });
-            }
-
-            default: {
-                console.error('DIVEIO.Import: Unsupported file type: ' + type);
-                return Promise.reject();
-            }
-        }
-    }
-
-    public Export<FileType extends keyof DIVESceneFileType>(
-        type: FileType,
-    ): Promise<string | null> {
-        switch (type) {
-            case 'glb': {
-                return this._gltfIO
-                    .Export(this._scene, true, true)
-                    .then((data) => {
-                        return this._createBlobURL(data);
-                    })
-                    .catch((error) => {
-                        console.error(error);
-                        return null;
-                    });
-            }
-
-            default: {
-                console.error('DIVEIO.Export: Unsupported file type: ' + type);
-                return Promise.reject();
-            }
-        }
-    }
-
-    private _createBlobURL(data: ArrayBuffer): string {
-        return URL.createObjectURL(new Blob([data]));
-    }
-}