@shopware-ag/dive 1.19.1-beta.0 → 1.19.1-beta.2

package/src/ar/__test__/AR.test.ts

@@ -1,276 +0,0 @@
-import { ARSystem, type ARSystemOptions } from '../AR';
-import { SystemInfo } from '../../info/Info';
-import { ARQuickLook } from '../arquicklook/ARQuickLook';
-import { SceneViewer } from '../sceneviewer/SceneViewer';
-
-// Mock Info
-jest.mock('../../info/Info', () => ({
-    SystemInfo: {
-        GetSystem: jest.fn(),
-        GetSupportsARQuickLook: jest.fn(),
-    },
-}));
-
-// Mock ARQuickLook
-const mockLaunchARQuickLook = jest.fn().mockResolvedValue(undefined);
-jest.mock('../arquicklook/ARQuickLook', () => ({
-    ARQuickLook: jest.fn().mockImplementation(() => ({
-        launch: mockLaunchARQuickLook,
-    })),
-}));
-
-// Mock SceneViewer
-const mockSceneViewerLaunch = jest.fn().mockResolvedValue(undefined);
-jest.mock('../sceneviewer/SceneViewer', () => ({
-    SceneViewer: jest.fn().mockImplementation(() => ({
-        launch: mockSceneViewerLaunch,
-    })),
-}));
-
-describe('ARSystem', () => {
-    let diveAR: ARSystem;
-    const mockUri = 'https://example.com/model.glb';
-
-    beforeEach(() => {
-        diveAR = new ARSystem();
-        jest.clearAllMocks();
-    });
-
-    describe('launch', () => {
-        describe('AR Quick Look', () => {
-            it('should launch ARQuickLook on iOS', async () => {
-                (SystemInfo.GetSystem as jest.Mock).mockReturnValue('iOS');
-                (
-                    SystemInfo.GetSupportsARQuickLook as jest.Mock
-                ).mockReturnValue(true);
-
-                const consoleLogSpy = jest
-                    .spyOn(console, 'log')
-                    .mockImplementation();
-
-                await diveAR.launch(mockUri);
-
-                expect(mockLaunchARQuickLook).toHaveBeenCalledWith(
-                    mockUri,
-                    undefined,
-                );
-                expect(consoleLogSpy).toHaveBeenCalledWith(
-                    'DIVE: Launching AR with ARQuickLook ...',
-                );
-                consoleLogSpy.mockRestore();
-            });
-
-            it('should launch ARQuickLook on iOS with options', async () => {
-                (SystemInfo.GetSystem as jest.Mock).mockReturnValue('iOS');
-                (
-                    SystemInfo.GetSupportsARQuickLook as jest.Mock
-                ).mockReturnValue(true);
-
-                const options: ARSystemOptions = {
-                    arPlacement: 'vertical',
-                    arScale: 'fixed',
-                };
-
-                const consoleLogSpy = jest
-                    .spyOn(console, 'log')
-                    .mockImplementation();
-
-                await diveAR.launch(mockUri, options);
-
-                expect(mockLaunchARQuickLook).toHaveBeenCalledWith(
-                    mockUri,
-                    options,
-                );
-                expect(consoleLogSpy).toHaveBeenCalledWith(
-                    'DIVE: Launching AR with ARQuickLook ...',
-                );
-                consoleLogSpy.mockRestore();
-            });
-
-            it('should not launch ARQuickLook on iOS if not supported', async () => {
-                (SystemInfo.GetSystem as jest.Mock).mockReturnValue('iOS');
-                (
-                    SystemInfo.GetSupportsARQuickLook as jest.Mock
-                ).mockReturnValue(false);
-
-                const consoleLogSpy = jest
-                    .spyOn(console, 'log')
-                    .mockImplementation();
-
-                try {
-                    await diveAR.launch(mockUri);
-                    fail('Expected launch to reject');
-                } catch (error: unknown) {
-                    if (error instanceof Error) {
-                        expect(error.message).toBe('ARQuickLook not supported');
-                    } else {
-                        fail('Expected error to be an Error instance');
-                    }
-                }
-                expect(consoleLogSpy).toHaveBeenCalledWith(
-                    'ARQuickLook not supported',
-                );
-                consoleLogSpy.mockRestore();
-            });
-
-            it('should handle ARQuickLook launch errors', async () => {
-                (SystemInfo.GetSystem as jest.Mock).mockReturnValue('iOS');
-                (
-                    SystemInfo.GetSupportsARQuickLook as jest.Mock
-                ).mockReturnValue(true);
-
-                const mockError = new Error('Launch failed');
-                const mockInstance = {
-                    launch: jest.fn().mockImplementation(() => {
-                        throw mockError;
-                    }),
-                };
-                (ARQuickLook as jest.Mock).mockImplementation(
-                    () => mockInstance,
-                );
-
-                const consoleLogSpy = jest
-                    .spyOn(console, 'log')
-                    .mockImplementation();
-                const consoleErrorSpy = jest
-                    .spyOn(console, 'error')
-                    .mockImplementation();
-
-                try {
-                    await diveAR.launch(mockUri);
-                    fail('Expected launch to reject');
-                } catch (error: unknown) {
-                    if (error instanceof Error) {
-                        expect(error.message).toBe('Launch failed');
-                    } else {
-                        fail('Expected error to be an Error instance');
-                    }
-                }
-
-                expect(consoleLogSpy).toHaveBeenCalledWith(
-                    'DIVE: Launching AR with ARQuickLook ...',
-                );
-                expect(consoleErrorSpy).toHaveBeenCalledWith(
-                    'Error launching ARQuickLook:',
-                    mockError,
-                );
-
-                consoleLogSpy.mockRestore();
-                consoleErrorSpy.mockRestore();
-            });
-        });
-
-        describe('Scene Viewer', () => {
-            it('should launch SceneViewer on Android', async () => {
-                (SystemInfo.GetSystem as jest.Mock).mockReturnValue('Android');
-
-                const consoleLogSpy = jest
-                    .spyOn(console, 'log')
-                    .mockImplementation();
-
-                await diveAR.launch(mockUri);
-
-                expect(mockSceneViewerLaunch).toHaveBeenCalledWith(
-                    mockUri,
-                    undefined,
-                );
-                expect(consoleLogSpy).toHaveBeenCalledWith(
-                    'DIVE: Launching AR with SceneViewer ...',
-                );
-                consoleLogSpy.mockRestore();
-            });
-
-            it('should launch SceneViewer on Android with options', async () => {
-                (SystemInfo.GetSystem as jest.Mock).mockReturnValue('Android');
-
-                const options: ARSystemOptions = {
-                    arPlacement: 'vertical',
-                    arScale: 'fixed',
-                };
-
-                const consoleLogSpy = jest
-                    .spyOn(console, 'log')
-                    .mockImplementation();
-
-                await diveAR.launch(mockUri, options);
-
-                expect(mockSceneViewerLaunch).toHaveBeenCalledWith(
-                    mockUri,
-                    options,
-                );
-                expect(consoleLogSpy).toHaveBeenCalledWith(
-                    'DIVE: Launching AR with SceneViewer ...',
-                );
-                consoleLogSpy.mockRestore();
-            });
-
-            it('should handle SceneViewer launch errors', async () => {
-                (SystemInfo.GetSystem as jest.Mock).mockReturnValue('Android');
-
-                const mockError = new Error('Launch failed');
-                const mockInstance = {
-                    launch: jest.fn().mockImplementation(() => {
-                        throw mockError;
-                    }),
-                };
-                (SceneViewer as jest.Mock).mockImplementation(
-                    () => mockInstance,
-                );
-
-                const consoleLogSpy = jest
-                    .spyOn(console, 'log')
-                    .mockImplementation();
-                const consoleErrorSpy = jest
-                    .spyOn(console, 'error')
-                    .mockImplementation();
-
-                try {
-                    await diveAR.launch(mockUri);
-                    fail('Expected launch to reject');
-                } catch (error: unknown) {
-                    if (error instanceof Error) {
-                        expect(error.message).toBe('Launch failed');
-                    } else {
-                        fail('Expected error to be an Error instance');
-                    }
-                }
-
-                expect(consoleLogSpy).toHaveBeenCalledWith(
-                    'DIVE: Launching AR with SceneViewer ...',
-                );
-                expect(consoleErrorSpy).toHaveBeenCalledWith(
-                    'Error launching SceneViewer:',
-                    mockError,
-                );
-
-                consoleLogSpy.mockRestore();
-                consoleErrorSpy.mockRestore();
-            });
-        });
-
-        it('should reject on non-mobile systems', async () => {
-            (SystemInfo.GetSystem as jest.Mock).mockReturnValue('Windows');
-
-            const consoleLogSpy = jest
-                .spyOn(console, 'log')
-                .mockImplementation();
-
-            try {
-                await diveAR.launch(mockUri);
-                fail('Expected launch to reject');
-            } catch (error: unknown) {
-                if (error instanceof Error) {
-                    expect(error.message).toBe(
-                        'AR not supported on non-mobile systems',
-                    );
-                } else {
-                    fail('Expected error to be an Error instance');
-                }
-            }
-            expect(consoleLogSpy).toHaveBeenCalledWith(
-                'DIVE: AR not supported. Not a mobile system. (System is Windows)',
-            );
-            consoleLogSpy.mockRestore();
-        });
-    });
-});

package/src/ar/arquicklook/ARQuickLook.ts

@@ -1,53 +0,0 @@
-import { type ARSystemOptions } from '../AR';
-import { Converter } from '../../converter/Converter';
-import { type USDZExporterOptions } from '../../types';
-
-export class ARQuickLook {
-    public async launch(uri: string, options?: ARSystemOptions): Promise<void> {
-        const usdzUrl = await this.convertToUSDZ(uri, options);
-        return this.launchARQuickLook(usdzUrl, options);
-    }
-
-    private async convertToUSDZ(
-        uri: string,
-        options?: ARSystemOptions,
-    ): Promise<string> {
-        // Convert the file to USDZ format
-        const usdzBuffer = await Converter.convert(uri).to('usdz', {
-            quickLookCompatible: true,
-            ar: {
-                anchoring: { type: 'plane' },
-                planeAnchoring: {
-                    alignment:
-                        options?.arPlacement === 'vertical'
-                            ? 'vertical'
-                            : 'horizontal',
-                },
-            },
-        } as USDZExporterOptions);
-
-        // Create a blob from the USDZ buffer
-        const blob = new Blob([usdzBuffer], { type: 'model/vnd.usdz+zip' });
-        return URL.createObjectURL(blob);
-    }
-
-    private launchARQuickLook(
-        uri: string,
-        options?: ARSystemOptions,
-    ): Promise<void> {
-        return new Promise((resolve) => {
-            if (options?.arScale === 'fixed') {
-                uri = uri.concat('#allowsContentScaling=0');
-            }
-
-            // launch ARQuickLook
-            const a = document.createElement('a');
-            a.innerHTML = '<picture></picture>'; // This is actually needed so the viewer opens instantly
-            a.rel = 'ar';
-            a.href = uri;
-            a.download = 'scene.usdz';
-            resolve();
-            a.click();
-        });
-    }
-}

package/src/ar/arquicklook/__test__/ARQuickLook.test.ts

@@ -1,144 +0,0 @@
-import { Box3, Color, Euler, Mesh, Object3D, Vector3 } from 'three';
-import { DIVEScene } from '../../../scene/Scene';
-import { ARSystemOptions } from '../../AR';
-import { ARQuickLook } from '../ARQuickLook';
-import { Converter } from '../../../converter/Converter';
-
-jest.mock('../../../scene/Scene', () => {
-    return {
-        DIVEScene: jest.fn(function () {
-            this.add = jest.fn();
-            this.children = [];
-            this.Root = {
-                children: [],
-            };
-            this.traverse = jest.fn((callback) => {
-                this.Root.children.forEach((child: Object3D) => {
-                    callback(child);
-                });
-            });
-            return this;
-        }),
-    };
-});
-
-// Mock the Converter class
-jest.mock('../../../converter/Converter', () => {
-    return {
-        Converter: {
-            convert: jest.fn().mockReturnThis(),
-            to: jest.fn().mockResolvedValue(new ArrayBuffer(0)),
-        },
-    };
-});
-
-// Mock URL.createObjectURL
-URL.createObjectURL = jest.fn(() => 'blob:http://localhost:8080/');
-
-// Mock document.createElement
-document.createElement = jest.fn().mockReturnValue({
-    innerHTML: '',
-    rel: '',
-    href: '',
-    download: '',
-    click: jest.fn(),
-});
-
-describe('ARQuickLook', () => {
-    let mockOptions: ARSystemOptions;
-    let mockModels: Object3D[];
-    let quickLook: ARQuickLook;
-    const mockUri = 'https://example.com/model.glb';
-
-    beforeEach(() => {
-        mockModels = [
-            new Object3D(),
-            new Object3D(),
-            new Object3D(),
-        ];
-        mockModels[1].userData = {
-            uri: 'https://example.com',
-        };
-        mockOptions = {
-            arPlacement: 'horizontal',
-            arScale: 'auto',
-        };
-        quickLook = new ARQuickLook();
-        jest.clearAllMocks();
-    });
-
-    describe('constructor', () => {
-        it('should create an instance', () => {
-            expect(quickLook).toBeInstanceOf(ARQuickLook);
-        });
-    });
-
-    describe('launch', () => {
-        it('should convert and launch with default options', async () => {
-            await quickLook.launch(mockUri);
-
-            expect(Converter.convert).toHaveBeenCalledWith(mockUri);
-            expect((Converter as any).to).toHaveBeenCalledWith('usdz', {
-                quickLookCompatible: true,
-                ar: {
-                    anchoring: { type: 'plane' },
-                    planeAnchoring: { alignment: 'horizontal' },
-                },
-            });
-            expect(URL.createObjectURL).toHaveBeenCalled();
-            expect(document.createElement).toHaveBeenCalledWith('a');
-        });
-
-        it('should convert and launch with custom options', async () => {
-            const options: ARSystemOptions = {
-                arPlacement: 'vertical',
-                arScale: 'fixed',
-            };
-            await quickLook.launch(mockUri, options);
-
-            expect(Converter.convert).toHaveBeenCalledWith(mockUri);
-            expect((Converter as any).to).toHaveBeenCalledWith('usdz', {
-                quickLookCompatible: true,
-                ar: {
-                    anchoring: { type: 'plane' },
-                    planeAnchoring: { alignment: 'vertical' },
-                },
-            });
-            expect(URL.createObjectURL).toHaveBeenCalled();
-            expect(document.createElement).toHaveBeenCalledWith('a');
-        });
-
-        it('should handle conversion errors', async () => {
-            const error = new Error('Conversion failed');
-            ((Converter as any).to as jest.Mock).mockRejectedValueOnce(error);
-
-            await expect(quickLook.launch(mockUri)).rejects.toThrow(error);
-        });
-
-        it('should create a blob with correct MIME type', async () => {
-            const mockBuffer = new ArrayBuffer(100);
-            ((Converter as any).to as jest.Mock).mockResolvedValueOnce(
-                mockBuffer,
-            );
-
-            await quickLook.launch(mockUri);
-
-            expect(URL.createObjectURL).toHaveBeenCalledWith(
-                expect.objectContaining({
-                    type: 'model/vnd.usdz+zip',
-                }),
-            );
-        });
-
-        it('should add scale parameter when arScale is fixed', async () => {
-            const options: ARSystemOptions = {
-                arPlacement: 'horizontal',
-                arScale: 'fixed',
-            };
-            await quickLook.launch(mockUri, options);
-
-            const anchor = document.createElement('a');
-            expect(anchor.href).toContain('#allowsContentScaling=0');
-        });
-    });
-});

package/src/ar/sceneviewer/SceneViewer.ts

@@ -1,119 +0,0 @@
-import { type ARSystemOptions } from '../AR';
-
-export class SceneViewer {
-    public launch(uri: string, options?: ARSystemOptions): void {
-        const location = self.location.toString();
-        const anchor = document.createElement('a');
-        const params = this._createParams(location, uri, options);
-        const intent = this._createIntent(location, uri, params);
-
-        anchor.setAttribute('href', intent);
-        anchor.click();
-    }
-
-    /**
-     * Creates the base URL parameters for SceneViewer
-     * @param location Current page location URL
-     * @returns URLSearchParams with base configuration
-     */
-    private _createParams(
-        location: string,
-        uri: string,
-        options?: ARSystemOptions,
-    ): URLSearchParams {
-        const modelUrl = new URL(uri, location);
-        const params = new URLSearchParams(modelUrl.search);
-
-        // Set AR mode as preferred
-        params.set('mode', 'ar_preferred');
-
-        // Apply any custom options
-        this._applyScaleOption(params, options);
-        this._applyPlacementOption(params, options);
-
-        // Apply additional parameters if present
-        this._applySoundOption(params, location);
-        this._applyLinkOption(params, location);
-
-        return params;
-    }
-
-    /**
-     * Applies the scale option to the parameters
-     * If scale is set to 'fixed', the model will not be resizable in AR
-     * @param params URLSearchParams to modify
-     */
-    private _applyScaleOption(
-        params: URLSearchParams,
-        options?: ARSystemOptions,
-    ): void {
-        if (options?.arScale === 'fixed') {
-            params.set('resizable', 'false');
-        }
-    }
-
-    /**
-     * Applies the placement option to the parameters
-     * If placement is set to 'vertical', vertical placement will be enabled
-     * @param params URLSearchParams to modify
-     */
-    private _applyPlacementOption(
-        params: URLSearchParams,
-        options?: ARSystemOptions,
-    ): void {
-        if (options?.arPlacement === 'vertical') {
-            params.set('enable_vertical_placement', 'true');
-        }
-    }
-
-    /**
-     * Applies the sound option to the parameters if present
-     * This will resolve any relative sound URLs to absolute URLs
-     * @param params URLSearchParams to modify
-     * @param location Current page location URL
-     */
-    private _applySoundOption(params: URLSearchParams, location: string): void {
-        if (params.has('sound')) {
-            const soundUrl = new URL(params.get('sound')!, location);
-            params.set('sound', soundUrl.toString());
-        }
-    }
-
-    /**
-     * Applies the link option to the parameters if present
-     * This will resolve any relative link URLs to absolute URLs
-     * @param params URLSearchParams to modify
-     * @param location Current page location URL
-     */
-    private _applyLinkOption(params: URLSearchParams, location: string): void {
-        if (params.has('link')) {
-            const linkUrl = new URL(params.get('link')!, location);
-            params.set('link', linkUrl.toString());
-        }
-    }
-
-    /**
-     * Creates the Android Intent URL for SceneViewer
-     * @param params URLSearchParams containing all configuration
-     * @param location Current page location URL
-     * @returns The complete Intent URL
-     */
-    private _createIntent(
-        location: string,
-        uri: string,
-        params: URLSearchParams,
-    ): string {
-        const locationUrl = new URL(location);
-        const modelUrl = new URL(uri, location);
-        const noArViewerSigil = '#model-viewer-no-ar-fallback';
-
-        locationUrl.hash = noArViewerSigil;
-
-        // Construct the intent URL with all parameters
-        return `intent://arvr.google.com/scene-viewer/1.2?${
-            params.toString() + '&file=' + modelUrl.toString()
-        }#Intent;scheme=https;package=com.google.android.googlequicksearchbox;action=android.intent.action.VIEW;S.browser_fallback_url=${encodeURIComponent(
-            locationUrl.toString(),
-        )};end;`;
-    }
-}