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

package/src/node/Node.ts

@@ -2,15 +2,17 @@ import { Box3, Object3D, Vector3, type Vector3Like } from 'three';
 import { PRODUCT_LAYER_MASK } from '../constant/VisibilityLayerMask';
 import { DIVECommunication } from '../com/Communication';
 
-import { type DIVEMovable } from '../interface/Movable';
-import { type DIVESelectable } from '../interface/Selectable';
+import { DIVEMovable } from '../interface/Movable';
+import { DIVESelectable } from '../interface/Selectable';
 import { type TransformControls } from 'three/examples/jsm/controls/TransformControls';
 import { type DIVEGroup } from '../group/Group';
+import { applyMixins } from '../helper/applyMixins/applyMixins';
 
-export class DIVENode extends Object3D implements DIVESelectable, DIVEMovable {
+export class DIVENode extends applyMixins(Object3D, [
+    DIVESelectable,
+    DIVEMovable,
+]) {
     readonly isDIVENode: true = true;
-    readonly isSelectable: true = true;
-    readonly isMovable: true = true;
 
     public gizmo: TransformControls | null = null;
 

package/src/scene/root/Root.ts

@@ -3,7 +3,6 @@ import DIVEAmbientLight from '../../light/AmbientLight.ts';
 import DIVEPointLight from '../../light/PointLight.ts';
 import DIVESceneLight from '../../light/SceneLight.ts';
 import { DIVEModel } from '../../model/Model.ts';
-import { DIVELoadingManager } from '../../loadingmanager/LoadingManager.ts';
 import { DIVECommunication } from '../../com/Communication.ts';
 import { DIVEPrimitive } from '../../primitive/Primitive.ts';
 
@@ -18,6 +17,7 @@ import {
 } from '../../com/types';
 import { type DIVESceneObject } from '../../types';
 import { DIVEGroup } from '../../group/Group.ts';
+import { Loader } from '../../loader/Loader.ts';
 
 /**
  * A basic scene node to hold grid, floor and all lower level roots.
@@ -28,13 +28,13 @@ import { DIVEGroup } from '../../group/Group.ts';
 export class DIVERoot extends Object3D {
     readonly isDIVERoot: true = true;
 
-    private loadingManager: DIVELoadingManager;
+    private loader: Loader;
 
     constructor() {
         super();
         this.name = 'Root';
 
-        this.loadingManager = new DIVELoadingManager();
+        this.loader = new Loader();
     }
 
     public ComputeSceneBB(): Box3 {
@@ -243,7 +243,7 @@ export class DIVERoot extends Object3D {
         }
 
         if (model.uri !== undefined) {
-            this.loadingManager.LoadGLTF(model.uri).then((gltf) => {
+            this.loader.load(model.uri).then((gltf) => {
                 (sceneObject as DIVEModel).SetModel(gltf);
                 DIVECommunication.get(model.id!)?.PerformAction(
                     'MODEL_LOADED',

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

@@ -26,11 +26,11 @@ jest.mock('../../../com/Communication.ts', () => {
     };
 });
 
-const mock_LoadGLTF = jest.fn().mockResolvedValue({});
-jest.mock('../../../loadingmanager/LoadingManager.ts', () => {
+const mock_Load = jest.fn().mockResolvedValue({});
+jest.mock('../../../loader/Loader.ts', () => {
     return {
-        DIVELoadingManager: jest.fn(function () {
-            this.LoadGLTF = mock_LoadGLTF;
+        Loader: jest.fn(function () {
+            this.load = mock_Load;
             return this;
         }),
     };

package/src/toolbox/Toolbox.ts

@@ -1,7 +1,7 @@
 import type DIVEOrbitControls from '../controls/OrbitControls.ts';
 import { type DIVEScene } from '../scene/Scene.ts';
 import { type DIVEBaseTool } from './BaseTool.ts';
-import { type DIVESelectTool } from './select/SelectTool.ts';
+import { DIVESelectTool } from './select/SelectTool.ts';
 
 export type ToolType = 'select' | 'none';
 
@@ -22,8 +22,6 @@ export default class DIVEToolbox {
     private _selectTool: DIVESelectTool | null;
     public get selectTool(): DIVESelectTool {
         if (!this._selectTool) {
-            const DIVESelectTool = require('./select/SelectTool.ts')
-                .DIVESelectTool as typeof import('./select/SelectTool.ts').DIVESelectTool;
             this._selectTool = new DIVESelectTool(
                 this._scene,
                 this._controller,

package/src/types/ExporterOptions.ts

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

package/src/types/FileTypes.ts

@@ -0,0 +1,37 @@
+import {
+    type GLTFExporterOptions,
+    type USDZExporterOptions,
+} from './ExporterOptions';
+
+export type FileTypeDefinition<T extends string, O> = {
+    key: T;
+    extension: string;
+    options: O;
+};
+
+export const FILE_TYPES = {
+    glb: {
+        key: 'glb' as const,
+        extension: '.glb',
+        options: {} as GLTFExporterOptions,
+    },
+    gltf: {
+        key: 'gltf' as const,
+        extension: '.gltf',
+        options: {} as GLTFExporterOptions,
+    },
+    usdz: {
+        key: 'usdz' as const,
+        extension: '.usdz',
+        options: {} as USDZExporterOptions,
+    },
+} as const;
+
+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 const SUPPORTED_FILE_TYPES = Object.values(FILE_TYPES).map(
+    (type) => type.extension,
+) as readonly string[];

package/src/types/index.ts

@@ -1,5 +1,31 @@
 import { type DIVESceneObject } from './SceneObjects';
 import { type DIVESceneFileType } from './SceneType';
 import { type DIVESceneData } from './SceneData';
+import {
+    type FileType,
+    type FileTypeKey,
+    type FileTypeOptions,
+    type FileTypeDefinition,
+    FILE_TYPES,
+    SUPPORTED_FILE_TYPES,
+} from './FileTypes';
+import {
+    type GLTFExporterOptions,
+    type USDZExporterOptions,
+    type 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,
+};

package/src/types/info/index.ts

@@ -0,0 +1,76 @@
+/**
+ * Enum representing supported operating systems
+ */
+export enum ESystem {
+    /**
+     * iOS devices (iPhone, iPad)
+     */
+    IOS = 'iOS',
+
+    /**
+     * Android devices
+     */
+    ANDROID = 'Android',
+
+    /**
+     * Windows operating system
+     */
+    WINDOWS = 'Windows',
+
+    /**
+     * macOS operating system
+     */
+    MACOS = 'MacOS',
+
+    /**
+     * Linux operating system
+     */
+    LINUX = 'Linux',
+
+    /**
+     * Unknown or unsupported system
+     */
+    UNKNOWN = 'Unknown',
+}
+
+/**
+ * Enum representing reasons why WebXR AR might not be supported
+ */
+export enum EWebXRUnsupportedReason {
+    /**
+     * The browser doesn't implement the WebXR API at all.
+     * This typically means the browser is outdated or doesn't support WebXR.
+     */
+    NO_WEBXR_API = 'NO_WEBXR_API',
+
+    /**
+     * The page is not served over HTTPS.
+     * WebXR requires a secure context (HTTPS) to work.
+     */
+    NO_HTTPS = 'NO_HTTPS',
+
+    /**
+     * The device doesn't support immersive AR sessions.
+     * This could be because:
+     * - The device doesn't have AR capabilities
+     * - The browser doesn't support AR features
+     * - The device's AR features are disabled
+     */
+    IMMERSIVE_AR_NOT_SUPPORTED_BY_DEVICE = 'IMMERSIVE_AR_NOT_SUPPORTED_BY_DEVICE',
+
+    /**
+     * Access to AR features has been denied by the system or browser.
+     * This could be due to:
+     * - Privacy settings
+     * - System restrictions
+     * - Browser policies
+     * - Hardware limitations
+     */
+    AR_PERMISSION_DENIED = 'AR_PERMISSION_DENIED',
+
+    /**
+     * An unexpected error occurred while checking for WebXR support.
+     * This is a fallback for any unhandled cases.
+     */
+    UNKNOWN_ERROR = 'UNKNOWN_ERROR',
+}

package/build/src/exporters/usdz/USDZExporter.d.ts

@@ -1,15 +0,0 @@
-import { Object3D } from 'three';
-import { USDZExporter, USDZExporterOptions } from 'three/examples/jsm/exporters/USDZExporter';
-export type DIVEUSDZExporterOptions = USDZExporterOptions & {
-    ar?: {
-        anchoring: {
-            type: 'plane' | 'image' | 'face' | 'none';
-        };
-        planeAnchoring: {
-            alignment: 'horizontal' | 'vertical' | 'any';
-        };
-    };
-};
-export declare class DIVEUSDZExporter extends USDZExporter {
-    parse(scene: Object3D, options?: DIVEUSDZExporterOptions): Promise<Uint8Array>;
-}

package/build/src/loadingmanager/LoadingManager.d.ts

@@ -1,14 +0,0 @@
-import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
-/**
- * A basic loading manager.
- *
- * @module
- */
-export declare class DIVELoadingManager {
-    private gltfloader;
-    private dracoloader;
-    constructor();
-    private progress;
-    LoadGLTF(uri: string): Promise<GLTF>;
-    PollProgress(): number;
-}

package/src/exporters/usdz/USDZExporter.ts

@@ -1,21 +0,0 @@
-import { Object3D } from 'three';
-import {
-    USDZExporter,
-    USDZExporterOptions,
-} from 'three/examples/jsm/exporters/USDZExporter';
-
-export type DIVEUSDZExporterOptions = USDZExporterOptions & {
-    ar?: {
-        anchoring: { type: 'plane' | 'image' | 'face' | 'none' }; // source: https://developer.apple.com/documentation/realitykit/preliminary-anchoring-type
-        planeAnchoring: { alignment: 'horizontal' | 'vertical' | 'any' }; // source: https://developer.apple.com/documentation/realitykit/preliminary-planeanchoring-alignment
-    };
-};
-
-export class DIVEUSDZExporter extends USDZExporter {
-    public parse(
-        scene: Object3D,
-        options?: DIVEUSDZExporterOptions,
-    ): Promise<Uint8Array> {
-        return super.parse(scene, options);
-    }
-}

package/src/exporters/usdz/__test__/USDZExporter.test.ts

@@ -1,57 +0,0 @@
-import { Object3D } from 'three';
-import { DIVEUSDZExporter, DIVEUSDZExporterOptions } from '../USDZExporter';
-
-describe('DIVEUSDZExporter', () => {
-    let exporter: DIVEUSDZExporter;
-    let scene: Object3D;
-
-    beforeEach(() => {
-        exporter = new DIVEUSDZExporter();
-        scene = new Object3D();
-    });
-
-    test('should create an instance of DIVEUSDZExporter', () => {
-        expect(exporter).toBeInstanceOf(DIVEUSDZExporter);
-    });
-
-    test('should call parse method with scene and options', async () => {
-        const options: DIVEUSDZExporterOptions = {
-            ar: {
-                anchoring: { type: 'plane' },
-                planeAnchoring: { alignment: 'horizontal' },
-            },
-        };
-
-        const result = await exporter.parse(scene, options);
-        expect(result).toBeInstanceOf(Uint8Array);
-    });
-
-    test('should call parse method without options', async () => {
-        const result = await exporter.parse(scene);
-        expect(result).toBeInstanceOf(Uint8Array);
-    });
-
-    test('should handle parse method with different anchoring types', async () => {
-        const options: DIVEUSDZExporterOptions = {
-            ar: {
-                anchoring: { type: 'image' },
-                planeAnchoring: { alignment: 'vertical' },
-            },
-        };
-
-        const result = await exporter.parse(scene, options);
-        expect(result).toBeInstanceOf(Uint8Array);
-    });
-
-    test('should handle parse method with different plane anchoring alignments', async () => {
-        const options: DIVEUSDZExporterOptions = {
-            ar: {
-                anchoring: { type: 'face' },
-                planeAnchoring: { alignment: 'any' },
-            },
-        };
-
-        const result = await exporter.parse(scene, options);
-        expect(result).toBeInstanceOf(Uint8Array);
-    });
-});

package/src/loadingmanager/LoadingManager.ts

@@ -1,50 +0,0 @@
-import { DRACOLoader } from 'three/examples/jsm/loaders/DRACOLoader';
-import { GLTF, GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader';
-
-/**
- * A basic loading manager.
- *
- * @module
- */
-
-export class DIVELoadingManager {
-    private gltfloader: GLTFLoader;
-    private dracoloader: DRACOLoader;
-    // ... maybe extend with other loaders later
-
-    constructor() {
-        this.gltfloader = new GLTFLoader();
-        this.dracoloader = new DRACOLoader();
-        this.dracoloader.setDecoderPath(
-            'https://www.gstatic.com/draco/v1/decoders/',
-        );
-        this.gltfloader.setDRACOLoader(this.dracoloader);
-    }
-
-    private progress: Map<string, number> = new Map<string, number>();
-
-    public async LoadGLTF(uri: string): Promise<GLTF> {
-        const progEvent = (p: ProgressEvent<EventTarget>): void => {
-            this.progress.set(uri, p.loaded / p.total);
-        };
-
-        this.progress.set(uri, 0);
-
-        return new Promise<GLTF>((resolve, reject) => {
-            this.gltfloader
-                .loadAsync(uri, progEvent)
-                .then(resolve)
-                .catch(reject);
-        });
-    }
-
-    public PollProgress(): number {
-        let total = 0;
-        this.progress.forEach((progress: number) => {
-            total += progress;
-        });
-
-        if (this.progress.size === 0) return 1;
-        return total / this.progress.size;
-    }
-}

package/src/loadingmanager/__test__/LoadingManager.test.ts

@@ -1,27 +0,0 @@
-import { DIVELoadingManager } from '../LoadingManager';
-
-describe('dive/loadingmanager/DIVELoadingManager', () => {
-    it('should instantiate', () => {
-        const testLight = new DIVELoadingManager();
-        expect(testLight).toBeDefined();
-    });
-
-    it('should return GLTF promise', () => {
-        const testLight = new DIVELoadingManager();
-        const promise = testLight.LoadGLTF('test.gltf');
-        expect(promise).toBeDefined();
-    });
-
-    it('should return progress', () => {
-        const testLight = new DIVELoadingManager();
-        testLight.LoadGLTF('test.gltf');
-        const progress = testLight.PollProgress();
-        expect(progress).toBe(0);
-    });
-
-    it('should return done progress without load', () => {
-        const testLight = new DIVELoadingManager();
-        const progress = testLight.PollProgress();
-        expect(progress).toBe(1);
-    });
-});