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

package/build/src/converter/Converter.d.ts

@@ -1,21 +1,12 @@
-import { FileType, ExportOptions } from '../types';
-export declare class ConversionError extends Error {
-    readonly cause?: unknown | undefined;
-    constructor(message: string, cause?: unknown | undefined);
-}
-export declare class FileTypeError extends ConversionError {
-    constructor(extension: string);
-}
-export declare class NetworkError extends ConversionError {
-    constructor(uri: string, cause?: unknown);
-}
+import { FileTypeToExporterOptions } from '../exporter/Exporter';
+import { FileType } from '../types/file';
 export declare class Converter {
     private readonly _uri;
     private _loader;
     private _exporter;
     constructor(_uri: string);
     static convert(uri: string): Converter;
-    to<T extends FileType>(type: T, options?: ExportOptions<T>): Promise<ArrayBuffer>;
     private _getFileTypeFromUri;
     private _loadFile;
+    to<T extends FileType>(type: T, options?: FileTypeToExporterOptions[T]): Promise<ArrayBuffer>;
 }

package/build/src/dive.d.ts

@@ -60,6 +60,7 @@ export default class DIVE {
 }
 export { DIVE, DIVECommunication };
 export * from './math/index.ts';
+export * from './ar/AR';
 export type * from './com/actions/index.ts';
 export type * from './com/types';
 export type * from './types';

package/build/src/exporter/Exporter.d.ts

@@ -1,10 +1,28 @@
 import { Object3D } from 'three';
-import { FileType, ExportOptions } from '../types';
+import { GLTFExporterOptions as THREEGLTFExporterOptions } from 'three/examples/jsm/exporters/GLTFExporter';
+import { USDZExporterOptions as THREEUSDZExporterOptions } from 'three/examples/jsm/exporters/USDZExporter';
+import { FileType } from '../types/file/FileTypes';
+export type USDZExporterOptions = THREEUSDZExporterOptions & {
+    ar?: {
+        anchoring: {
+            type: 'plane' | 'image' | 'face' | 'none';
+        };
+        planeAnchoring: {
+            alignment: 'horizontal' | 'vertical' | 'any';
+        };
+    };
+};
+export type GLTFExporterOptions = THREEGLTFExporterOptions;
+export type FileTypeToExporterOptions = {
+    glb: GLTFExporterOptions;
+    gltf: GLTFExporterOptions;
+    usdz: USDZExporterOptions;
+};
 export declare class Exporter {
     private _gltfExporter;
     private _usdzExporter;
     constructor();
-    export<T extends FileType>(object: Object3D, type: T, options?: ExportOptions<T>): Promise<ArrayBuffer>;
+    export<T extends FileType>(object: Object3D, type: T, options?: FileTypeToExporterOptions[T]): Promise<ArrayBuffer>;
     private _exportGlb;
     private _exportGltf;
     private _exportUsdz;

package/build/src/loader/Loader.d.ts

@@ -4,8 +4,4 @@ export declare class Loader {
     private _usdzLoader;
     constructor();
     load(uri: string): Promise<Object3D>;
-    private _getFileTypeFromUri;
-    private _load;
-    private _loadGltf;
-    private _loadUsdz;
 }

package/build/src/types/error/index.d.ts

@@ -0,0 +1,12 @@
+export declare class ConversionError extends Error {
+    readonly cause?: unknown | undefined;
+    constructor(message: string, cause?: unknown | undefined);
+}
+export declare class FileTypeError extends Error {
+    constructor(message: string);
+}
+export declare class NetworkError extends Error {
+    readonly url: string;
+    readonly cause?: unknown | undefined;
+    constructor(url: string, message: string, cause?: unknown | undefined);
+}

package/build/src/types/file/FileTypes.d.ts

@@ -0,0 +1,17 @@
+declare const FILE_TYPES: {
+    readonly glb: {
+        readonly key: "glb";
+        readonly extension: "glb";
+    };
+    readonly gltf: {
+        readonly key: "gltf";
+        readonly extension: "gltf";
+    };
+    readonly usdz: {
+        readonly key: "usdz";
+        readonly extension: "usdz";
+    };
+};
+export type FileType = keyof typeof FILE_TYPES;
+export declare const SUPPORTED_FILE_TYPES: readonly string[];
+export {};

package/build/src/types/file/index.d.ts

@@ -0,0 +1 @@
+export * from './FileTypes';

package/build/src/types/index.d.ts

@@ -1,8 +1,5 @@
-import { DIVESceneObject } from './SceneObjects';
-import { DIVESceneFileType } from './SceneType';
-import { DIVESceneData } from './SceneData';
-import { FileType, FileTypeKey, FileTypeOptions, FileTypeDefinition, FILE_TYPES, SUPPORTED_FILE_TYPES } from './FileTypes';
-import { GLTFExporterOptions, USDZExporterOptions, ExportOptions } from './ExporterOptions';
-export { type DIVESceneObject, type DIVESceneFileType, type DIVESceneData };
-export { type FileType, type FileTypeKey, type FileTypeOptions, type FileTypeDefinition, FILE_TYPES, SUPPORTED_FILE_TYPES, };
-export { type GLTFExporterOptions, type USDZExporterOptions, type ExportOptions, };
+export * from './SceneData';
+export * from './SceneObjects';
+export * from './SceneType';
+export * from './file';
+export * from './info';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shopware-ag/dive",
-    "version": "1.19.1-beta.0",
+    "version": "1.19.1-beta.2",
     "description": "Shopware Spatial Framework",
     "type": "module",
     "main": "build/dive.cjs",
@@ -25,8 +25,7 @@
         "build",
         "LICENSE",
         "package.json",
-        "README.md",
-        "src"
+        "README.md"
     ],
     "keywords": [
         "dive",

package/build/src/types/ExporterOptions.d.ts

@@ -1,15 +0,0 @@
-import { GLTFExporterOptions as THREEGLTFExporterOptions } from 'three/examples/jsm/exporters/GLTFExporter';
-import { USDZExporterOptions as THREEUSDZExporterOptions } from 'three/examples/jsm/exporters/USDZExporter';
-import { FileType, FileTypeOptions } from './FileTypes';
-export type USDZExporterOptions = THREEUSDZExporterOptions & {
-    ar?: {
-        anchoring: {
-            type: 'plane' | 'image' | 'face' | 'none';
-        };
-        planeAnchoring: {
-            alignment: 'horizontal' | 'vertical' | 'any';
-        };
-    };
-};
-export type GLTFExporterOptions = THREEGLTFExporterOptions;
-export type ExportOptions<T extends FileType> = FileTypeOptions<T>;

package/build/src/types/FileTypes.d.ts

@@ -1,27 +0,0 @@
-import { GLTFExporterOptions, USDZExporterOptions } from './ExporterOptions';
-export type FileTypeDefinition<T extends string, O> = {
-    key: T;
-    extension: string;
-    options: O;
-};
-export declare const FILE_TYPES: {
-    readonly glb: {
-        readonly key: "glb";
-        readonly extension: ".glb";
-        readonly options: GLTFExporterOptions;
-    };
-    readonly gltf: {
-        readonly key: "gltf";
-        readonly extension: ".gltf";
-        readonly options: GLTFExporterOptions;
-    };
-    readonly usdz: {
-        readonly key: "usdz";
-        readonly extension: ".usdz";
-        readonly options: USDZExporterOptions;
-    };
-};
-export type FileType = keyof typeof FILE_TYPES;
-export type FileTypeKey = (typeof FILE_TYPES)[FileType]['key'];
-export type FileTypeOptions<T extends FileType> = (typeof FILE_TYPES)[T]['options'];
-export declare const SUPPORTED_FILE_TYPES: readonly string[];

package/src/__test__/DIVE.test.ts

@@ -1,274 +0,0 @@
-import DIVE, { DIVESettings } from '../dive.ts';
-
-jest.mock('../com/Communication.ts', () => {
-    return {
-        DIVECommunication: jest.fn(function () {
-            this.PerformAction = jest.fn().mockReturnValue({
-                position: { x: 0, y: 0, z: 0 },
-                target: { x: 0, y: 0, z: 0 },
-            });
-            this.Subscribe = jest.fn(
-                (action: string, callback: (data: { id: string }) => void) => {
-                    callback({ id: 'incorrect id' });
-                    callback({ id: 'test_uuid' });
-                },
-            );
-            this.DestroyInstance = jest.fn();
-
-            return this;
-        }),
-    };
-});
-
-jest.mock('../renderer/Renderer.ts', () => {
-    return {
-        DIVERenderer: jest.fn(function () {
-            this.domElement = {
-                clientWidth: 800,
-                clientHeight: 600,
-                style: {
-                    position: 'absolute',
-                },
-            };
-            this.domElement.parentElement = this.domElement;
-            this.AddPreRenderCallback = (callback: () => void) => {
-                callback();
-            };
-            this.RemovePreRenderCallback = jest.fn();
-            this.AddPostRenderCallback = (callback: () => void) => {
-                callback();
-            };
-            this.getViewport = jest.fn();
-            this.setViewport = jest.fn();
-            this.autoClear = false;
-            this.render = jest.fn();
-            this.StartRenderer = jest.fn();
-            this.OnResize = jest.fn();
-            this.Dispose = jest.fn();
-            return this;
-        }),
-    };
-});
-
-jest.mock('../scene/Scene.ts', () => {
-    return {
-        DIVEScene: jest.fn(function () {
-            this.add = jest.fn();
-            this.isObject3D = true;
-            this.parent = null;
-            this.dispatchEvent = jest.fn();
-            this.position = {
-                set: jest.fn(),
-            };
-            this.SetIntensity = jest.fn();
-            this.SetEnabled = jest.fn();
-            this.SetColor = jest.fn();
-            this.userData = {
-                id: undefined,
-            };
-            this.removeFromParent = jest.fn();
-            return this;
-        }),
-    };
-});
-
-jest.mock('../camera/PerspectiveCamera.ts', () => {
-    return jest.fn(function () {
-        this.isObject3D = true;
-        this.parent = null;
-        this.dispatchEvent = jest.fn();
-        this.position = {
-            set: jest.fn(),
-        };
-        this.SetIntensity = jest.fn();
-        this.SetEnabled = jest.fn();
-        this.SetColor = jest.fn();
-        this.userData = {
-            id: undefined,
-        };
-        this.removeFromParent = jest.fn();
-        this.OnResize = jest.fn();
-        return this;
-    });
-});
-
-jest.mock('../controls/OrbitControls.ts', () => {
-    return jest.fn(function () {
-        this.isObject3D = true;
-        this.parent = null;
-        this.dispatchEvent = jest.fn();
-        this.position = {
-            set: jest.fn(),
-        };
-        this.SetIntensity = jest.fn();
-        this.SetEnabled = jest.fn();
-        this.SetColor = jest.fn();
-        this.userData = {
-            id: undefined,
-        };
-        this.removeFromParent = jest.fn();
-        this.Dispose = jest.fn();
-        return this;
-    });
-});
-
-jest.mock('../toolbox/Toolbox.ts', () => {
-    return jest.fn(function () {
-        this.isObject3D = true;
-        this.parent = null;
-        this.dispatchEvent = jest.fn();
-        this.position = {
-            set: jest.fn(),
-        };
-        this.SetIntensity = jest.fn();
-        this.SetEnabled = jest.fn();
-        this.SetColor = jest.fn();
-        this.userData = {
-            id: undefined,
-        };
-        this.Dispose = jest.fn();
-        this.removeFromParent = jest.fn();
-        return this;
-    });
-});
-
-jest.mock('../axiscamera/AxisCamera.ts', () => {
-    return jest.fn(function () {
-        this.isObject3D = true;
-        this.parent = null;
-        this.dispatchEvent = jest.fn();
-        this.position = {
-            set: jest.fn(),
-        };
-        this.SetIntensity = jest.fn();
-        this.SetEnabled = jest.fn();
-        this.SetColor = jest.fn();
-        this.userData = {
-            id: undefined,
-        };
-        this.removeFromParent = jest.fn();
-        this.SetFromCameraMatrix = jest.fn();
-        this.Dispose = jest.fn();
-        return this;
-    });
-});
-
-console.log = jest.fn();
-
-describe('dive/DIVE', () => {
-    it('should QuickView', () => {
-        const dive = DIVE.QuickView('test_uri');
-        expect(dive).toBeDefined();
-    });
-
-    it('should instantiate', () => {
-        const dive = new DIVE();
-        expect(dive).toBeDefined();
-        expect((window as any).DIVE.PrintScene).toBeDefined();
-        expect(() => (window as any).DIVE.PrintScene()).not.toThrow();
-    });
-
-    it('should instantiate in development DIVE_NODE_ENV', () => {
-        process.env.DIVE_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();
-
-        const settings = {
-            displayAxes: true,
-        };
-        dive = new DIVE(settings);
-        expect(() => dive.Dispose()).not.toThrow();
-    });
-
-    it('should instantiate with settings', () => {
-        const settings = {
-            autoResize: false,
-            displayAxes: true,
-            renderer: {
-                antialias: false,
-                alpha: false,
-                stencil: false,
-                shadowMapEnabled: false,
-                shadowMapType: 0,
-                toneMapping: 0,
-            },
-            perspectiveCamera: {
-                fov: 0,
-                near: 0,
-                far: 0,
-            },
-            orbitControls: {
-                enableDamping: false,
-                dampingFactor: 0,
-            },
-        } as DIVESettings;
-        const dive = new DIVE(settings);
-        expect(dive).toBeDefined();
-    });
-
-    it('should have Canvas', () => {
-        const dive = new DIVE();
-        expect(dive.Canvas).toBeDefined();
-    });
-
-    it('should have Communication', () => {
-        const dive = new DIVE();
-        expect(dive.Communication).toBeDefined();
-    });
-
-    it('should have Info', () => {
-        const dive = new DIVE();
-        expect(dive.Info).toBeDefined();
-    });
-
-    it('should resize', () => {
-        const dive = new DIVE();
-        expect(() => dive.OnResize(800, 600)).not.toThrow();
-    });
-
-    it('should update settings', () => {
-        const dive = new DIVE();
-        dive.Settings = {
-            autoResize: false,
-            displayAxes: true,
-            renderer: {
-                antialias: false,
-                alpha: false,
-                stencil: false,
-                shadowMapEnabled: false,
-                shadowMapType: 0,
-                toneMapping: 0,
-            },
-            perspectiveCamera: {
-                fov: 0,
-                near: 0,
-                far: 0,
-            },
-            orbitControls: {
-                enableDamping: false,
-                dampingFactor: 0,
-            },
-        };
-
-        dive.Settings = {
-            autoResize: true,
-        };
-
-        Object.assign(dive.Canvas, { parentElement: null });
-
-        dive.Settings = {
-            autoResize: false,
-        };
-
-        dive.Settings = {
-            autoResize: true,
-        };
-    });
-});

package/src/animation/AnimationSystem.ts

@@ -1,34 +0,0 @@
-import { Tween, update as updateTween } from '@tweenjs/tween.js';
-import { DIVERenderer } from '../renderer/Renderer';
-
-/**
- * Updates all animations.
- * DIVE uses Tween.js to handle animations.
- *
- * @module
- */
-
-export class DIVEAnimationSystem {
-    private _renderer: DIVERenderer;
-    private _rendererCallbackId: string;
-
-    constructor(renderer: DIVERenderer) {
-        this._renderer = renderer;
-
-        this._rendererCallbackId = this._renderer.AddPreRenderCallback(() => {
-            this.Update();
-        });
-    }
-
-    public Dispose(): void {
-        this._renderer.RemovePreRenderCallback(this._rendererCallbackId);
-    }
-
-    public Update(): void {
-        updateTween();
-    }
-
-    public Animate<T extends object>(object: T): Tween<T> {
-        return new Tween<T>(object);
-    }
-}

package/src/animation/__test__/AnimationSystem.test.ts

@@ -1,40 +0,0 @@
-import { DIVERenderer } from '../../renderer/Renderer';
-import { DIVEAnimationSystem } from '../AnimationSystem';
-
-const mockRenderer = {
-    render: jest.fn(),
-    OnResize: jest.fn(),
-    getViewport: jest.fn(),
-    setViewport: jest.fn(),
-    AddPreRenderCallback: jest.fn((callback) => {
-        callback();
-    }),
-    AddPostRenderCallback: jest.fn((callback) => {
-        callback();
-    }),
-    RemovePreRenderCallback: jest.fn(),
-    RemovePostRenderCallback: jest.fn(),
-} as unknown as DIVERenderer;
-
-describe('dive/animation/DIVEAnimationSystem', () => {
-    it('should instantiate', () => {
-        const anim = new DIVEAnimationSystem(mockRenderer);
-        expect(anim).toBeDefined();
-    });
-
-    it('should Animate', () => {
-        const anim = new DIVEAnimationSystem(mockRenderer);
-        const tween = anim.Animate({});
-        expect(tween).toBeDefined();
-    });
-
-    it('should update', () => {
-        const anim = new DIVEAnimationSystem(mockRenderer);
-        expect(() => anim.Update()).not.toThrow();
-    });
-
-    it('should dispose', () => {
-        const anim = new DIVEAnimationSystem(mockRenderer);
-        expect(() => anim.Dispose()).not.toThrow();
-    });
-});

package/src/ar/AR.ts

@@ -1,101 +0,0 @@
-import { SystemInfo } from '../info/Info';
-import { ESystem } from '../types/info';
-import { ARQuickLook } from './arquicklook/ARQuickLook';
-import { SceneViewer } from './sceneviewer/SceneViewer';
-
-/**
- * Options for configuring the AR system behavior
- */
-export type ARSystemOptions = {
-    /** The placement orientation for AR content - either horizontal or vertical */
-    arPlacement: 'horizontal' | 'vertical';
-    /** The scaling behavior for AR content - either automatic or fixed */
-    arScale: 'auto' | 'fixed';
-};
-
-/**
- * Main class for handling AR functionality across different platforms
- * Provides methods to launch AR experiences using platform-specific implementations
- */
-export class ARSystem {
-    /**
-     * Launches an AR experience using the appropriate platform-specific implementation
-     *
-     * @param uri - The URI of the 3D model to display in AR
-     * @param options - Optional configuration for the AR experience
-     * @returns Promise that resolves when AR is launched successfully
-     * @throws Error if AR is not supported on the current platform
-     */
-    public async launch(uri: string, options?: ARSystemOptions): Promise<void> {
-        const system = SystemInfo.GetSystem();
-
-        if (system === ESystem.IOS) {
-            return this.tryARQuickLook(uri, options);
-        }
-
-        if (system === ESystem.ANDROID) {
-            return this.trySceneViewer(uri, options);
-        }
-
-        console.log(
-            'DIVE: AR not supported. Not a mobile system. (System is ' +
-                system +
-                ')',
-        );
-        return Promise.reject(
-            new Error('AR not supported on non-mobile systems'),
-        );
-    }
-
-    /**
-     * Attempts to launch AR using ARQuickLook (iOS-specific implementation)
-     *
-     * @param uri - The URI of the 3D model to display in AR
-     * @param options - Optional configuration for the AR experience
-     * @returns Promise that resolves when ARQuickLook is launched successfully
-     * @throws Error if ARQuickLook is not supported on the device
-     */
-    private async tryARQuickLook(
-        uri: string,
-        options?: ARSystemOptions,
-    ): Promise<void> {
-        const support = SystemInfo.GetSupportsARQuickLook();
-        if (!support) {
-            console.log('ARQuickLook not supported');
-            return Promise.reject(new Error('ARQuickLook not supported'));
-        }
-
-        console.log('DIVE: Launching AR with ARQuickLook ...');
-
-        try {
-            return new ARQuickLook().launch(uri, options);
-        } catch (error) {
-            console.error('Error launching ARQuickLook:', error);
-            return Promise.reject(error);
-        }
-    }
-
-    /**
-     * Launches AR using SceneViewer (Android-specific implementation)
-     * Note: SceneViewer is supported on all Android devices. If ARCore is not installed,
-     * the model will be displayed in 3D view mode instead of AR mode.
-     *
-     * @param uri - The URI of the 3D model to display in AR
-     * @param options - Optional configuration for the AR experience
-     * @returns Promise that resolves when SceneViewer is launched successfully
-     * @throws Error if there's an issue launching SceneViewer
-     */
-    private async trySceneViewer(
-        uri: string,
-        options?: ARSystemOptions,
-    ): Promise<void> {
-        console.log('DIVE: Launching AR with SceneViewer ...');
-
-        try {
-            return new SceneViewer().launch(uri, options);
-        } catch (error) {
-            console.error('Error launching SceneViewer:', error);
-            return Promise.reject(error);
-        }
-    }
-}