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

package/build/src/ar/AR.d.ts

@@ -1,21 +1,44 @@
-import { DIVEScene } from '../scene/Scene';
-import { DIVERenderer } from '../renderer/Renderer';
-import { default as DIVEOrbitControls } from '../controls/OrbitControls';
-export type DIVEAROptions = {
+/**
+ * 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 declare class ARSystem {
     /**
-     * experimental, currently deactivated
+     * 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
+     */
+    launch(uri: string, options?: ARSystemOptions): Promise<void>;
+    /**
+     * 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
      */
-    useWebXR: false;
-};
-export declare class DIVEAR {
-    private _renderer;
-    private _scene;
-    private _controller;
-    constructor(renderer: DIVERenderer, scene: DIVEScene, controller: DIVEOrbitControls);
-    Launch(options?: DIVEAROptions): Promise<void>;
     private tryARQuickLook;
-    private tryWebXR;
+    /**
+     * 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 trySceneViewer;
 }

package/build/src/ar/arquicklook/ARQuickLook.d.ts

@@ -1,7 +1,6 @@
-import { DIVEScene } from '../../scene/Scene';
-import { DIVEAROptions } from '../AR';
-export declare class DIVEARQuickLook {
-    static Launch(scene: DIVEScene, options?: DIVEAROptions): Promise<void>;
-    private static launchARQuickLook;
-    private static findARQuickLookSrc;
+import { ARSystemOptions } from '../AR';
+export declare class ARQuickLook {
+    launch(uri: string, options?: ARSystemOptions): Promise<void>;
+    private convertToUSDZ;
+    private launchARQuickLook;
 }

package/build/src/ar/sceneviewer/SceneViewer.d.ts

@@ -1,7 +1,43 @@
-import { DIVEScene } from '../../scene/Scene';
-import { DIVEAROptions } from '../AR';
-export declare class DIVESceneViewer {
-    static Launch(scene: DIVEScene, options?: DIVEAROptions): void;
-    private static launchSceneViewer;
-    private static findSceneViewerSrc;
+import { ARSystemOptions } from '../AR';
+export declare class SceneViewer {
+    launch(uri: string, options?: ARSystemOptions): void;
+    /**
+     * Creates the base URL parameters for SceneViewer
+     * @param location Current page location URL
+     * @returns URLSearchParams with base configuration
+     */
+    private _createParams;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
 }

package/build/src/com/actions/scene/launchar.d.ts

@@ -1,6 +1,9 @@
-import { DIVEAROptions } from '../../../ar/AR';
+import { ARSystemOptions } from '../../../ar/AR';
 export default interface LAUNCH_AR {
     DESCRIPTION: 'Launches AR mode in native capabilities. (iOS: AR Quick Look, Android: Google Scene Viewer)';
-    PAYLOAD?: DIVEAROptions;
+    PAYLOAD: {
+        uri: string;
+        options?: ARSystemOptions;
+    };
     RETURN: Promise<void>;
 }

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

@@ -0,0 +1,21 @@
+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);
+}
+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;
+}

package/build/src/dive.d.ts

@@ -2,7 +2,7 @@ import { DIVERendererSettings } from './renderer/Renderer.ts';
 import { DIVEPerspectiveCameraSettings } from './camera/PerspectiveCamera.ts';
 import { DIVEOrbitControlsSettings } from './controls/OrbitControls.ts';
 import { DIVECommunication } from './com/Communication.ts';
-import { DIVEInfo } from './info/Info.ts';
+import { SystemInfo } from './info/Info.ts';
 export type DIVESettings = {
     autoResize: boolean;
     autoStart: boolean;
@@ -50,7 +50,7 @@ export default class DIVE {
     private axisCamera;
     get Communication(): DIVECommunication;
     get Canvas(): HTMLCanvasElement;
-    get Info(): DIVEInfo;
+    get Info(): SystemInfo;
     set Settings(settings: Partial<DIVESettings>);
     constructor(settings?: Partial<DIVESettings>);
     Dispose(): void;
@@ -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

@@ -0,0 +1,11 @@
+import { Object3D } from 'three';
+import { FileType, ExportOptions } from '../types';
+export declare class Exporter {
+    private _gltfExporter;
+    private _usdzExporter;
+    constructor();
+    export<T extends FileType>(object: Object3D, type: T, options?: ExportOptions<T>): Promise<ArrayBuffer>;
+    private _exportGlb;
+    private _exportGltf;
+    private _exportUsdz;
+}

package/build/src/helper/applyMixins/applyMixins.d.ts

@@ -1,8 +1,24 @@
+type Constructor<T = {}> = new (...args: any[]) => T;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+type MixedInstance<T extends Constructor, K extends readonly Constructor[]> = InstanceType<T> & UnionToIntersection<InstanceType<K[number]>>;
+type FlattenConstructorParams<T extends readonly Constructor[]> = T extends readonly [infer First, ...infer Rest] ? First extends Constructor ? Rest extends readonly Constructor[] ? [
+    ...ConstructorParameters<First>,
+    ...FlattenConstructorParams<Rest>
+] : ConstructorParameters<First> : [] : [];
+type MixedConstructor<T extends Constructor, K extends readonly Constructor[]> = new (...args: [...ConstructorParameters<T>, ...FlattenConstructorParams<K>]) => MixedInstance<T, K>;
 /**
- * Merges two class prototypes to a new one.
+ * Applies mixins to a base class.
+ *
+ * @param derivedCtor Base class constructor
+ * @param constructors Additional constructors that get mixed into the base class
+ * @returns A mixed constructor with the instance type of the base class and all mixin classes
+ * @example
+ * ```
+ * const SelectableMovableObject3D = applyMixins(Object3D, [DIVESelectable, DIVEMovable]);
+ * const instance = new SelectableMovableObject3D();
+ * instance.onMove();
+ * instance.onSelect();
+ * ```
  */
-export declare const applyMixins: (derivedCtor: {
-    prototype: object;
-}, constructors: {
-    prototype: object;
-}[]) => void;
+export declare function applyMixins<T extends Constructor, K extends readonly Constructor[]>(derivedCtor: T, constructors: K): MixedConstructor<T, K>;
+export {};

package/build/src/info/Info.d.ts

@@ -1,29 +1,53 @@
-export declare enum WebXRUnsupportedReason {
-    'UNKNWON_ERROR' = 0,
-    'NO_HTTPS' = 1,
-    'IMMERSIVE_AR_NOT_SUPPORTED_BY_DEVICE' = 2,
-    'AR_SESSION_NOT_ALLOWED' = 3
-}
-export declare class DIVEInfo {
+import { ESystem, EWebXRUnsupportedReason } from '../types/info';
+export declare class SystemInfo {
     private static _supportsWebXR;
     private static _webXRUnsupportedReason;
     /**
-     *
-     * @returns The system the user is using. Possible values are "Android", "iOS", "Windows", "MacOS", "Linux" or "Unknown".
+     * Gets the current system (iOS, Android, Windows, etc.)
+     * @returns DIVESystem The current system
      */
-    static GetSystem(): string;
+    static GetSystem(): ESystem;
     /**
      * @returns A promise that resolves to a boolean indicating whether the user's device supports WebXR.
      */
     static GetSupportsWebXR(): Promise<boolean>;
     /**
-     * @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.
+     * @returns The reason why WebXR is not supported on the user's device. Returns null if WebXR is supported.
      */
-    static GetWebXRUnsupportedReason(): WebXRUnsupportedReason | null;
+    static GetWebXRUnsupportedReason(): EWebXRUnsupportedReason | null;
     /**
-     * @returns A boolean indicating whether the user's device supports AR Quick Look.
+     * Checks if ARQuickLook is supported on the current device
+     * This checks for:
+     * 1. AR support via relList
+     *
+     * Requirements:
+     * - iOS 13.0 or later
+     * - Safari browser (ARQuickLook is only supported in Safari)
+     * - Device with AR capabilities (iPhone/iPad with LiDAR scanner or ARKit support)
+     *
+     * Note: ARQuickLook is only available in Safari on iOS. Other browsers
+     * (Chrome, Firefox, etc.) do not support ARQuickLook, even on iOS.
+     *
+     * @returns boolean indicating if ARQuickLook is supported
      */
     static GetSupportsARQuickLook(): boolean;
+    /**
+     * Checks if SceneViewer is supported on the current device
+     * This checks for:
+     * 1. Android device
+     * 2. Chrome browser (version 89 or later)
+     *
+     * Requirements:
+     * - Android 7.0 (API level 24) or later
+     * - Chrome for Android 89 or later
+     *
+     * Note: According to Google's documentation, if these requirements are met,
+     * SceneViewer will be available. If ARCore is not installed, SceneViewer will
+     * fall back to showing the model in 3D.
+     *
+     * @returns boolean indicating if SceneViewer is supported
+     */
+    static GetSupportsSceneViewer(): boolean;
     /**
      * @returns A boolean indicating whether the user's device is a mobile device.
      */

package/build/src/interface/Movable.d.ts

@@ -3,9 +3,9 @@
  *
  * @module
  */
-export interface DIVEMovable {
-    isMovable: true;
-    onMoveStart?: () => void;
-    onMove?: () => void;
-    onMoveEnd?: () => void;
+export declare class DIVEMovable {
+    readonly isMovable: true;
+    onMoveStart?(): void;
+    onMove?(): void;
+    onMoveEnd?(): void;
 }

package/build/src/interface/Selectable.d.ts

@@ -3,8 +3,8 @@
  *
  * @module
  */
-export interface DIVESelectable {
-    isSelectable: true;
-    onSelect?: () => void;
-    onDeselect?: () => void;
+export declare class DIVESelectable {
+    readonly isSelectable: true;
+    onSelect?(): void;
+    onDeselect?(): void;
 }

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

@@ -0,0 +1,11 @@
+import { Object3D } from 'three';
+export declare class Loader {
+    private _gltfLoader;
+    private _usdzLoader;
+    constructor();
+    load(uri: string): Promise<Object3D>;
+    private _getFileTypeFromUri;
+    private _load;
+    private _loadGltf;
+    private _loadUsdz;
+}

package/build/src/model/Model.d.ts

@@ -1,4 +1,4 @@
-import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader';
+import { Object3D } from 'three';
 import { COMMaterial } from '../com/types';
 import { DIVENode } from '../node/Node';
 /**
@@ -14,7 +14,7 @@ export declare class DIVEModel extends DIVENode {
     readonly isDIVEModel: true;
     private _mesh;
     private _material;
-    SetModel(gltf: GLTF): void;
+    SetModel(gltf: Object3D): void;
     SetMaterial(material: Partial<COMMaterial>): void;
     PlaceOnFloor(): void;
     DropIt(): void;

package/build/src/node/Node.d.ts

@@ -2,10 +2,9 @@ import { Box3, Object3D, Vector3, Vector3Like } from 'three';
 import { DIVEMovable } from '../interface/Movable';
 import { DIVESelectable } from '../interface/Selectable';
 import { TransformControls } from 'three/examples/jsm/controls/TransformControls';
-export declare class DIVENode extends Object3D implements DIVESelectable, DIVEMovable {
+declare const DIVENode_base: new () => Object3D<import('three').Object3DEventMap> & DIVEMovable & DIVESelectable;
+export declare class DIVENode extends DIVENode_base {
     readonly isDIVENode: true;
-    readonly isSelectable: true;
-    readonly isMovable: true;
     gizmo: TransformControls | null;
     protected _positionWorldBuffer: Vector3;
     protected _boundingBox: Box3;
@@ -22,3 +21,4 @@ export declare class DIVENode extends Object3D implements DIVESelectable, DIVEMo
     onSelect(): void;
     onDeselect(): void;
 }
+export {};

package/build/src/scene/root/Root.d.ts

@@ -8,7 +8,7 @@ import { DIVESceneObject } from '../../types';
  */
 export declare class DIVERoot extends Object3D {
     readonly isDIVERoot: true;
-    private loadingManager;
+    private loader;
     constructor();
     ComputeSceneBB(): Box3;
     GetSceneObject<T extends DIVESceneObject>(object: Partial<COMEntity> & {

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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,27 @@
+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/build/src/types/index.d.ts

@@ -1,4 +1,8 @@
 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, };

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

@@ -0,0 +1,66 @@
+/**
+ * Enum representing supported operating systems
+ */
+export declare 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 declare 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/package.json

@@ -1,17 +1,31 @@
 {
     "name": "@shopware-ag/dive",
-    "version": "1.19.0",
+    "version": "1.19.1-beta.1",
     "description": "Shopware Spatial Framework",
     "type": "module",
     "main": "build/dive.cjs",
     "module": "build/dive.js",
     "types": "build/dive.d.ts",
+    "exports": {
+        ".": {
+            "types": "./build/dive.d.ts",
+            "node": {
+                "import": {
+                    "default": "./build/dive.mjs"
+                },
+                "require": {
+                    "default": "./build/dive.cjs"
+                }
+            },
+            "import": "./build/dive.mjs",
+            "require": "./build/dive.cjs"
+        }
+    },
     "files": [
         "build",
         "LICENSE",
         "package.json",
-        "README.md",
-        "src"
+        "README.md"
     ],
     "keywords": [
         "dive",

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;
-}