@roomle/embedding-lib 5.24.0 → 5.25.0-alpha.1

package/packages/web-sdk/packages/common-core/src/environment/dynamic-environment-setting-loader.d.ts

@@ -0,0 +1,83 @@
+import { default as Environment } from './environment';
+import { SceneSettings } from '../scene-settings-loader';
+import { Scene } from 'three';
+
+export interface EnvironmentDetails {
+    imageUrl: string;
+    color: string;
+    material: string;
+    fog: boolean;
+}
+/**
+ * Dynamic environment settings can be used to select which environment is used.
+
+ Example
+
+ ```
+ {
+"environment": {
+    "type": "image",
+    "details": {
+      "imageUrl": "https://storage.googleapis.com/roomle-static/test/bg/bg_grey.jpg"
+    }
+  }
+}
+ ```
+
+ Available environment types
+
+ "type": "floor"/"image"/"color"/"gltf"
+
+ Type floor
+
+ ```
+ "details": {
+    "material": "roomle_floor:DresdenEiche"
+ }
+ ```
+
+ Currently available floor materials, for others get in touch with us
+
+ ```
+ roomle_floor:DresdenEiche
+ roomle_floor:Ibiza
+ roomle_floor:Palma
+ roomle_floor:Elba
+ roomle_floor:Manacor
+ roomle_floor:KernEiche
+ roomle_floor:KieferScandic
+ roomle_floor:EicheHabsburg
+ roomle_floor:FuldaKiefer
+ roomle_floor:Ashton
+ roomle_floor:EicheLondon
+ ```
+
+ Type image
+
+ ```
+ "details": {
+    "imageUrl": "https://storage.googleapis.com/roomle-static/test/bg/bg_grey_shine.jpg"
+}
+ ```
+
+ Type color
+
+ ```
+ "details": {
+    "color": "#ff0000"
+}
+ ```
+
+ Type gltf
+
+ Type gltf does not have any details yet
+ */
+export interface EnvironmentSetting {
+    type: string;
+    details: EnvironmentDetails;
+}
+export default class DynamicEnvironmentSettingLoader {
+    private _rapiAccess;
+    parse(scene: Scene, canvas: HTMLCanvasElement, oldEnvironment: Environment, json: string, maxAnisotropy: number): Promise<Environment>;
+    load(scene: Scene, canvas: HTMLCanvasElement, oldEnvironment: Environment, jsonObject: SceneSettings, maxAnisotropy: number): Promise<Environment>;
+}

package/packages/web-sdk/packages/common-core/src/environment/environment.d.ts

@@ -0,0 +1,16 @@
+import { PerspectiveCamera, Scene, Vector3 } from 'three';
+
+export default abstract class Environment {
+    protected _scene: Scene;
+    protected _bounds: Vector3;
+    constructor(scene: Scene, oldEnvironment?: Environment);
+    abstract needsBounds(): boolean;
+    abstract needsCamera(): boolean;
+    updateCamera(_camera: PerspectiveCamera): void;
+    abstract addToScene(): void;
+    abstract removeFromScene(): void;
+    abstract showGUI(updateCallback: () => void): void;
+    reload(): void;
+    updateBounds(bounds: Vector3, _force?: boolean): void;
+    cleanUp(): void;
+}

package/packages/web-sdk/packages/common-core/src/environment/ground-projected-environment.d.ts

@@ -0,0 +1,15 @@
+import { default as Environment } from './environment';
+import { Scene, Texture } from 'three';
+
+export default class GroundProjectedEnvironment extends Environment {
+    private _environmentTexture;
+    private _skybox;
+    constructor(scene: Scene, oldEnvironment: Environment, texture: Texture);
+    updateEnvironmentTexture(texture: Texture): void;
+    needsBounds(): boolean;
+    needsCamera(): boolean;
+    needsRotation(): boolean;
+    addToScene(): void;
+    removeFromScene(): void;
+    showGUI(updateCallback: () => void): void;
+}

package/packages/web-sdk/packages/common-core/src/error-handler.d.ts

@@ -0,0 +1,18 @@
+export declare const enum ERROR_CODES {
+    OFFLINE = 0,
+    GENERIC_RAPI_ERROR = 1,
+    CONTENT_PROBLEM = 2
+}
+type ErrorListener = (...args: any[]) => void;
+export declare class RoomleError extends Error {
+    rmlErrorCode: ERROR_CODES;
+}
+export default class ErrorHandler {
+    private _listeners;
+    private _subscribe;
+    subscribe(errorCode: ERROR_CODES, callback: ErrorListener): void;
+    dispatch(errorCode: ERROR_CODES, args?: any[]): void;
+    unsubscribe(errorCode: ERROR_CODES, callback: ErrorListener): void;
+    softReject(resolve: (...args: any[]) => any, errorMessage: string, errorCode: ERROR_CODES): any;
+}
+export {};

package/packages/web-sdk/packages/common-core/src/form-data-util.d.ts

@@ -0,0 +1,16 @@
+import { Base64String } from '../../typings/rapi-types';
+
+interface ImagesTypes {
+    JPG: string;
+    JPEG: string;
+    PNG: string;
+    GIF: string;
+    [key: string]: string;
+}
+export declare const IMAGE_FORMATS: ImagesTypes;
+export default class FormDataUtil {
+    private _base64toBlob;
+    private _createFormData;
+    create(base64: Base64String, hash: string, fileExtension: string, formfield: string): FormData;
+}
+export {};

package/packages/web-sdk/packages/common-core/src/input/input-manager.d.ts

@@ -0,0 +1,115 @@
+import { Position2 } from '../common-interfaces';
+import { default as EventDispatcher } from '../../../configurator-core/src/utils/event-dispatcher';
+import { Context } from '../di/context';
+
+export declare const BROWSER_EVENTS: {
+    [key: string]: string;
+};
+export declare const WINDOW_EVENTS: {
+    [key: string]: string;
+};
+export declare const enum INPUT_EVENT {
+    DRAG_START = 0,
+    DRAG = 1,
+    DRAG_END = 2,
+    DOWN = 3,
+    UP = 4,
+    CLICK = 5,
+    MOVE = 6,
+    ZOOM_IN = 7,
+    ZOOM_OUT = 8,
+    ROTATE = 9,
+    ROTATE_END = 10,
+    PAN = 11,
+    DOUBLE_CLICK = 12,
+    TOUCH_END = 13,
+    LONG_TOUCH = 14,
+    MOUSE_LEAVE = 15,
+    KEY_DOWN = 16,
+    KEY_UP = 17
+}
+export declare const enum INPUT_EVENT_TYPE {
+    UNKNOWN = 0,
+    MOUSE = 1,
+    TOUCH = 2,
+    AUTO = 3,
+    KEYBOARD = 4
+}
+export declare const EVENT_TYPE: {
+    readonly CLICK: 1;
+    readonly DOUBLE_CLICK: 2;
+};
+export declare const INPUT_DELAY_TYPE: {
+    readonly DRAG: 50;
+};
+export declare class InputEvent {
+    position: Position2;
+    positionRelative: Position2;
+    type: INPUT_EVENT_TYPE;
+    rotation: number;
+    event: Event;
+    constructor(position?: Position2, positionRelative?: Position2, type?: INPUT_EVENT_TYPE, rotation?: number, event?: Event);
+}
+export declare const MIN_MOVE_DISTANCE: number;
+export default class InputManager extends EventDispatcher<InputEvent> implements Context, EventListenerObject {
+    _creator_: string;
+    private _domHelper;
+    private _downPosition;
+    private _downPositionRelative;
+    private _elementHit;
+    private _longClickTimer;
+    private _delta;
+    private _state;
+    private _pinchDistance;
+    private _rotationAngle;
+    private _firefoxDragPosition;
+    private _lastMouseWheelEvent;
+    private _lastTouchEvent;
+    private _events;
+    private _windowEvents;
+    private _dragEnabled;
+    private _dragTarget;
+    private _dragMVName;
+    private _dragMV;
+    private _dragEVName;
+    private _dragEV;
+    private _boundingClientRect;
+    private _boundingClientRectInvalid;
+    constructor(creator: string);
+    enableDragIn(dragEvent?: DragEvent): void;
+    isMouseUp(): boolean;
+    private _dragM;
+    private _dragE;
+    addEvents(element: HTMLElement): void;
+    removeEvents(element: HTMLElement): void;
+    private _move2;
+    private _setState;
+    private _move;
+    private _longClick;
+    private _onUp;
+    private _getTouchPosition;
+    private _getTouchPositionRelative;
+    private _getMousePosition;
+    private _getFireFoxMousePosition;
+    private _getMousePositionRelative;
+    private _getDelta;
+    setDragEnabled(enabled: boolean): void;
+    handleEvent(evt: Event): void;
+    private _onKeyDown;
+    private _onKeyUp;
+    private _onMouseDown;
+    private _onMouseUp;
+    private _onMouseMove;
+    private _onDoubleClick;
+    private _onMouseLeave;
+    private _onMouseEnter;
+    private _onMouseWheel;
+    private _onTouchMove;
+    private _onTouchStart;
+    private _onTouchEnd;
+    private _onContextMenu;
+    protected _canDrag(_type: INPUT_EVENT_TYPE): boolean;
+    onElementHit(): void;
+    private _getBoundingClientRect;
+    updateSize(): void;
+}

package/packages/web-sdk/packages/common-core/src/kernel-access-callback.d.ts

@@ -0,0 +1,15 @@
+import { Context } from './di/context';
+
+export interface KernelAccessCallbackI {
+    isReady(): void;
+    loadError(error?: any): void;
+}
+export default class KernelAccessCallback implements Context, KernelAccessCallbackI {
+    _creator_: string;
+    private _callbackListener;
+    constructor(creator: string);
+    addListener(listener: KernelAccessCallbackI): void;
+    removeListener(listener: KernelAccessCallbackI): void;
+    isReady(): void;
+    loadError(error?: any): void;
+}

package/packages/web-sdk/packages/common-core/src/kernel-io.d.ts

@@ -0,0 +1,28 @@
+import { Context } from './di/context';
+import { default as Logger } from './logger';
+import { ValuesFromObject } from './utils/common-utils';
+import { RapiId } from '../../typings/rapi-types';
+
+export interface KernelMessageMetaInfo {
+    componentId?: RapiId;
+    rapiId?: RapiId;
+    parentId?: number;
+}
+export declare const KERNEL_MESSAGE_TYPE: {
+    readonly EXCEPTION: "exception";
+    readonly ERROR: "error";
+    readonly WARNING: "warning";
+    readonly LOG: "log";
+};
+export type KernelMessageType = ValuesFromObject<typeof KERNEL_MESSAGE_TYPE>;
+export default class KernelIo extends Logger implements Context {
+    _creator_: string;
+    private _globalCallback;
+    private _meta;
+    constructor(creator: string);
+    setMeta(meta: object): void;
+    get meta(): KernelMessageMetaInfo;
+    throw(msg: string): void;
+    error(msg: string): void;
+    warn(msg: string): void;
+}

package/packages/web-sdk/packages/common-core/src/life-cycle-manager.d.ts

@@ -0,0 +1,13 @@
+export interface LifeCycleCallbacks {
+    pause: () => void;
+    resume: () => void;
+    destroy: () => void;
+}
+export default class LifeCycleManager implements LifeCycleCallbacks {
+    private _listeners;
+    addEventListener(listener: LifeCycleCallbacks): void;
+    removeEventListener(listener: LifeCycleCallbacks): void;
+    pause(): void;
+    resume(): void;
+    destroy(): void;
+}

package/packages/web-sdk/packages/common-core/src/light/light-source.d.ts

@@ -0,0 +1,13 @@
+import { Light, Object3D } from 'three';
+import { KernelLightSourceAttributes } from '../../../typings/kernel';
+
+export declare const generateLightSource: (lightSourceAttributes: KernelLightSourceAttributes) => Light | null;
+export declare class RoomleLightSource {
+    private _lightSourceId;
+    private _light;
+    constructor(lightSourceId: number, lightSource: Light);
+    get lightSourceId(): number;
+    addToScene(object3d: Object3D): void;
+    removeFromScene(): void;
+    updateLightSource(lightSourceAttributes: any): void;
+}

package/packages/web-sdk/packages/common-core/src/lightsetting/dynamic-light-setting-loader.d.ts

@@ -0,0 +1,60 @@
+import { SceneSettings } from '../scene-settings-loader';
+import { Light, RectAreaLight, Vector3 } from 'three';
+
+export declare const PREDEFINED_LIGHTSETTING: {
+    readonly SOFA: "sofa";
+    readonly SHELF: "shelf";
+    readonly SHELF_FRONT: "shelf_front";
+    readonly BAKED: "baked";
+    readonly CAMERA: "camera";
+    readonly EQUAL: "equal";
+};
+/**
+ * Description of fields:
+ - type: 'ambient'/'rectarea'/'spot'/'directional'
+ - name: set a name for this light to identify it more easily
+ - intensity: light intensity/brightness
+ - color: light color as hex ('#ffffff')
+ - position: position of the light, for example `{"x": 0,"y": 0, "z": 0}`, coords are right hand y up
+ - target: position to which the light should shine, defaults to center
+ - castShadow: defines if this light casts shadows
+ - angle: used for spotlights, defines the light cone of the spotlight
+ - penumbra: used for spotlights, defines how hard the edges of the light are
+ - width: used for rect area light, width of the area
+ - height: used for rect area light, height of the area
+ - movesWithCamera: if true the light will always have the same position and angle as the camera
+ */
+export interface DynamicLight {
+    type: string;
+    name?: string;
+    intensity?: number;
+    color?: string;
+    position?: Vector3;
+    target?: Vector3;
+    castShadow?: boolean;
+    angle?: number;
+    penumbra?: number;
+    width?: number;
+    height?: number;
+    movesWithCamera?: boolean;
+}
+type PreDefinedLightSettings = (typeof PREDEFINED_LIGHTSETTING)[keyof typeof PREDEFINED_LIGHTSETTING];
+export interface DynamicLightSettingSource {
+    url?: string;
+    json?: string;
+    object?: SceneSettings;
+    ls?: PreDefinedLightSettings;
+}
+export default class DynamicLightSettingLoader {
+    static rectAreaLightReplacement: boolean;
+    static rectAreaLightLoadingListener: ((lightSource: RectAreaLight) => void) | undefined;
+    static createDynamicLightSettingSource(dls: string, ls: string): DynamicLightSettingSource;
+    parse(json: string): Light[];
+    load(jsonObject: SceneSettings): Light[];
+    private _parseAmbientLight;
+    private _parseRectAreaLight;
+    private _parseSpotLight;
+    private _parseDirectionalLight;
+    private _parseCommon;
+}
+export {};

package/packages/web-sdk/packages/common-core/src/lightsetting/dynamic-light-setting.d.ts

@@ -0,0 +1,26 @@
+import { default as LightSetting } from './light-setting';
+import { SceneSettings } from '../scene-settings-loader';
+import { Box3, PerspectiveCamera, Scene, Vector3 } from 'three';
+
+export default class DynamicLightSetting extends LightSetting {
+    private _lights;
+    private _cameraLight;
+    private _boundingSize;
+    private _dynamicLightSettingLoader;
+    constructor(scene: Scene, oldLightSetting?: LightSetting);
+    needsBounds(): boolean;
+    updateBounds(bounds: Box3): void;
+    loadFromJSON(json: string): Promise<void>;
+    loadFromObject(sceneSettings: SceneSettings): Promise<void>;
+    loadFromURL(url: string): Promise<void>;
+    addToScene(): void;
+    update(camera: PerspectiveCamera, target: Vector3): void;
+    removeFromScene(): void;
+    reload(): void;
+    showGUI(): void;
+    private _addToGUI;
+    private _addRectAreaLightToGUI;
+    private _addSpotLightToGUI;
+    private _addAmbientLightToGUI;
+    private _addDirectionalLightToGUI;
+}

package/packages/web-sdk/packages/common-core/src/lightsetting/light-setting.d.ts

@@ -0,0 +1,14 @@
+import { Box3, Scene, Object3D } from 'three';
+
+export default abstract class LightSetting {
+    protected _scene: Scene;
+    private _cameraContainer;
+    constructor(scene: Scene, oldLightSetting?: LightSetting);
+    needsBounds(): boolean;
+    updateBounds(_bounds: Box3): void;
+    abstract addToScene(): void;
+    abstract removeFromScene(): void;
+    abstract reload(): void;
+    abstract showGUI(): void;
+    getCameraContainer(): Object3D;
+}

package/packages/web-sdk/packages/common-core/src/logger.d.ts

@@ -0,0 +1,6 @@
+export default class Logger {
+    info(...args: any[]): void;
+    log(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+}

package/packages/web-sdk/packages/common-core/src/main.d.ts

@@ -0,0 +1,110 @@
+import { AppState } from './utils/app-context';
+import { LifeCycleCallbacks } from './life-cycle-manager';
+import { default as RapiAccess } from './rapi-access';
+import { CanvasOffset } from './common-interfaces';
+import { default as UnitFormatter } from '../../configurator-core/src/services/unit-formatter';
+import { Scene } from 'three';
+import { default as IdbManager } from './services/idb-manager';
+import { GlobalCallback } from './services/global-callback';
+
+export interface EnvMapParams {
+    /**
+     * url of the env map (exr or hdr)
+     */
+    url?: string;
+    /**
+     * intensity of the env map (brightness of the scene). recommended value between 0.5 and 2
+     */
+    intensity?: number;
+    /**
+     * rotation of the environment map, influences also shadow direction
+     */
+    rotation?: number;
+    /**
+     * maximum number of light sources (and thus shadows) extracted form the env map
+     */
+    maxLightSources?: number;
+}
+export interface GlobalAPI {
+    updateSize(): void;
+    getMain(): Main;
+    /**
+     * Returns the three.js scene (https://threejs.org/docs/#api/en/scenes/Scene)
+     * WARNING: This is the actual scene (reference) and not a copy!
+     */
+    getScene(): Scene;
+    /**
+     * Updates the scene (recalculating bounds) and restart rendering
+     */
+    updateScene(): void;
+    /**
+     * Sets the available screen space for our item
+     * Example 1: right 0.9 means 10% padding on the right side
+     * Example 2: bottom 0.2 means 20% padding on the bottom side
+     * default: 'left: 0, top: 1, right: 1, bottom: 0'
+     * @param offset
+     */
+    setCameraOffset(offset: CanvasOffset): void;
+    /**
+     * Gets the available screen space for our item
+     * default: 'left: 0, top: 1, right: 1, bottom: 0'
+     */
+    getCameraOffset(): CanvasOffset;
+    getUnitFormatter(): UnitFormatter;
+    getStorage(): IdbManager;
+    setEnvironmentMap(params: EnvMapParams): void;
+    get globalCallbacks(): GlobalCallback;
+}
+/**
+ * Shared API between configurator and planner
+ */
+export interface RubensAPI {
+    resetCameraPosition(): void;
+    exportImageFromCamera(): Promise<void>;
+    exportCanvasScreenshot(quality?: number): Promise<string>;
+    enableMultiselect(): void;
+    getStorage(): IdbManager;
+    undo(): Promise<void>;
+    redo(): Promise<void>;
+}
+export interface ExternalEmbeddable<T = any> {
+    callbacks: T;
+}
+export interface KernelUtilityForUi {
+    getRuntimeComponentIdOfRootComponent(planObjectId?: number): number;
+}
+export declare const enum BASE_CONTEXT {
+    CONFIGURATOR = "configurator",
+    PLANNER = "planner",
+    GLB_VIEWER = "glb-viewer",
+    MATERIAL_VIEWER = "material-viewer",
+    TOOLS_CORE = "tools-core"
+}
+export default abstract class Main implements LifeCycleCallbacks {
+    protected _context: string;
+    protected abstract setupGlobals(settings?: AppState): void;
+    protected abstract setupDependencies(): void;
+    protected abstract cleanUpGlobals(): void;
+    protected abstract cleanUpDependencies(): void;
+    protected abstract bootFinished(): void;
+    protected abstract getContextName(): string;
+    abstract getApi(): ExternalEmbeddable;
+    constructor(creator?: string);
+    private _setupCommonGlobals;
+    private _setupCommonDependencies;
+    private _cleanUpCommonGlobals;
+    private _cleanUpCommonDependencies;
+    boot(settings?: object): void;
+    protected lookup<T>(specifier: string, context?: string): T;
+    teardown(): void;
+    pause(): void;
+    resume(element?: HTMLElement): void;
+    destroy(): void;
+    /**
+     * returns the instance of the rapi access so that
+     * the user of the SDK can fetch data from the Roomle backend
+     * @params none
+     * @return RapiAccess
+     */
+    getRapiAccess(): RapiAccess;
+}

package/packages/web-sdk/packages/common-core/src/network-layer.d.ts

@@ -0,0 +1,16 @@
+import { AssetUrl } from '../../typings/rapi-types';
+
+type NetworkResponseValidator = (response: Response) => Promise<boolean>;
+export interface NetworkRequestValidations {
+    checkResponse?: NetworkResponseValidator;
+}
+export default class NetworkLayer {
+    private _queue;
+    private _pendingRequests;
+    private _nextSlot;
+    private _fetch;
+    fetch(request: Request | AssetUrl, options?: {
+        [key: string]: string;
+    }, checks?: NetworkRequestValidations): Promise<any>;
+}
+export {};