@roomle/web-sdk 2.90.0 → 2.91.0-alpha.2

package/lib/definitions/packages/common-core/src/utils/local-storage-helper.d.ts

@@ -0,0 +1,22 @@
+import type { Context } from '../di/context';
+interface LocalStorageEntry {
+    id: string;
+    date: number;
+    payload: any;
+}
+interface Store {
+    entries: LocalStorageEntry[];
+}
+export declare const DEFAULT_STORE = "rml_default";
+export declare const DEFAULT_STORE_SIZE = 5;
+export default class LocalStorageHelper implements Context {
+    _context_: string;
+    _creator_: string;
+    private _localStorage;
+    constructor(_context_: string);
+    getStore(storeId?: string): Store;
+    saveStore(storeId: string, store: Store): void;
+    addItem(id: string, payload: any, storeId?: string, limit?: number): void;
+    getItem(id: string, storeId?: string): any;
+}
+export {};

package/lib/definitions/packages/common-core/src/utils/local-storage.d.ts

@@ -0,0 +1,9 @@
+import type { Context } from '../di/context';
+export default class LocalStorage implements Context {
+    _context_: string;
+    _creator_: string;
+    constructor(_context_: string);
+    private get _localStorage();
+    getItem(key: string): any;
+    setItem<T>(key: string, value: T): void;
+}

package/lib/definitions/packages/common-core/src/utils/material-creator.d.ts

@@ -0,0 +1,9 @@
+import { MeshPhysicalMaterial, MeshStandardMaterial } from 'three';
+export default class MaterialCreator {
+    static createMeshPhysicalMaterial(params: {
+        [key: string]: any;
+    }): MeshPhysicalMaterial;
+    static createMeshStandardMaterial(params: {
+        [key: string]: any;
+    }): MeshStandardMaterial;
+}

package/lib/definitions/packages/common-core/src/utils/math-helper.d.ts

@@ -0,0 +1,9 @@
+import type { Position2 } from '../common-interfaces';
+export declare const toRadiant: (degree: number) => number;
+export declare const toDegrees: (radians: number) => number;
+export declare const getIdealDistance: (width: number, height: number, depth: number, fov: number, screenWidth: number, screenHeight: number) => number;
+export declare const round: (x: number) => number;
+export declare const getDelta: (v1: Position2, v2: Position2) => number;
+export declare const getAngle: (v1: Position2, v2: Position2) => number;
+export declare const to360Degrees: (radians: number) => number;
+export declare const angleToKernelRotation: (angle: number) => number;

package/lib/definitions/packages/common-core/src/utils/parameter-types.d.ts

@@ -0,0 +1,15 @@
+export declare const enum PARAMETER_UNIT_TYPES {
+    UNKNOWN_UNIT = "unknown",
+    LENGTH = "length",
+    AREA = "area",
+    ANGLE = "angle",
+    COUNT = "count"
+}
+export declare const enum PARAMETER_KERNEL_TYPE {
+    UNKNOWN = "",
+    INTEGER = "Integer",
+    DECIMAL = "Decimal",
+    STRING = "String",
+    BOOLTYPE = "Boolean",
+    MATERIAL = "Material"
+}

package/lib/definitions/packages/common-core/src/utils/promise-queue.d.ts

@@ -0,0 +1,21 @@
+export declare class PromiseQueue<T> {
+    private _waitingPromises;
+    private _callback;
+    private _finishPromiseExecutor;
+    private _errorCallback;
+    constructor(callback?: (results: T[]) => void, errorCallback?: (e: Error) => void);
+    push(promise: Promise<T>): void;
+    /**
+     * Wait for current queue to finish
+     */
+    finished(ignoreErrors?: boolean): Promise<T[]>;
+    /**
+     * Callback whenever queue is finished
+     */
+    registerCallback(callback: (results: T[]) => void): void;
+    unregisterCallback(): void;
+    private _resolveAllExecutors;
+    private _rejectAllExecutors;
+    clear(): void;
+    get length(): number;
+}

package/lib/definitions/packages/common-core/src/utils/query-params-helper.d.ts

@@ -0,0 +1,3 @@
+export declare const getAllParameters: (url?: string) => {
+    [key: string]: any;
+};

package/lib/definitions/packages/common-core/src/utils/rapi-utils.d.ts

@@ -0,0 +1,10 @@
+import type { RapiId } from '../../../typings/rapi-types';
+import type { KernelPart } from '../../../typings/kernel';
+export declare const isInIframe: () => boolean;
+export declare const getHostname: () => string;
+export declare const NAMES_FOR_LOCALHOST: string[];
+export declare const isDemoHostname: (hostname: string) => boolean;
+export declare const isIdItemId: (id: RapiId) => boolean;
+export declare const getCatalogIdFromItemOrConfigurationId: (id: RapiId) => RapiId;
+export declare const kernelPartToPriceId: ({ articleNr, componentId }: KernelPart) => string;
+export declare const wasRequestSuccess: (ok: boolean | string, status: number | string) => boolean;

package/lib/definitions/packages/common-core/src/utils/shims.d.ts

@@ -0,0 +1,459 @@
+import type { CanvasOffset } from '../common-interfaces';
+import type { ROOMLE_COLORS } from './common-utils';
+import type { HexColorNumber, HexColorString, RapiId, RapiServerUrlType } from '../../../typings/rapi-types';
+import type { CAMERA_TYPE } from '../cameracontrol/camera-type';
+import type { Enumify } from '../types';
+import type { ROOMLE_HIGHLIGHTNG } from './common-utils';
+import type { DefaultEnvironmentSceneType } from '../webgl/renderer/environment-scene';
+import type { CustomShadingParameters, SceneShadingType } from '../webgl/renderer/shading-settings';
+import type { Color } from 'three';
+export declare const enum WINDOW_EVENT {
+    RESIZE = "resize",
+    KEY_DOWN = "keydown",
+    KEY_UP = "keyup",
+    VISIBILITY_CHANGE = "visibilitychange"
+}
+export declare const DRAW_PREVIEW_MODES: {
+    readonly DEFAULT: "default";
+    readonly VECTOR: "vector";
+};
+/**
+ * Init data parameters which are not context specific
+ */
+export interface GlobalInitDataDefinition {
+    /**
+     * @description locale to use for the
+     * embedding instance
+     */
+    locale?: string;
+    /**
+     * @internal
+     * @deprecated
+     * @description Can be used for content testing
+     */
+    overrideTenant?: number;
+    /**
+     * @description Set country to use for the Roomle price service. If not used the customer IP address will be used to determine the location. usage: overrideCountry=de
+     */
+    overrideCountry?: string;
+    /**
+     * @internal
+     * @description Set which RAPI (Roomle API) backend should be used options: live, test
+     */
+    overrideRapi?: RapiServerUrlType;
+    /**
+     * @internal
+     * @description The id which should be used for this embedding instance. When this id is set all InitData parameter can be set and changed in Rubens Admin. This is the way we recommend to set init data params. Ask your Roomle contact for your configuratorId.
+     */
+    configuratorId?: string;
+    /**
+     * @deprecated
+     * @description when set to true and assets were prechaced by the asset loader they are returned from cache. Otherwise we always return a fresh copy from network usage: alwaysUseCache=true default: not set -> assets fetched from url, set -> assets from cache
+     */
+    alwaysUseCache?: boolean;
+    /**
+     * @internal
+     * @description Set which RAPI (Roomle API) backend should be used usage: customApiUrl=https://www.roomle.com/api/v2
+     */
+    customApiUrl?: string;
+    /**
+     * @internal
+     * @description Can be set to true if started as an end-to-end test. This will disable post-processing
+     */
+    e2e?: boolean;
+    /**
+     * @internal
+     * @description If set to true, the Roomle Renderer is used for perspective and top images this should help the E2E tests of Joe to migrate from comparing Roomle Renderer images to Three.js Renderer images
+     */
+    e2eRoomleRendererForImages?: boolean;
+    /**
+     * @internal
+     * @description When loading a plan, the external objects from the plan XML are discarded
+     */
+    discardExternalObjectsWhenLoadingPlan?: boolean;
+}
+export interface FeatureFlags {
+    pulsePreview?: boolean;
+    reDock?: boolean;
+    /**
+     * @description If set to true we will not hide other items while configuring in the planner
+     */
+    configureInRoom?: boolean;
+    /**
+     * @internal
+     * @description If true, the advanced docking behavior is enabled (for test purposes only)
+     */
+    advancedDocking?: boolean;
+    /**
+     * @internal
+     * @description If “vector”, the vector preview is activated when drawing walls (for test purposes only).
+     * By default, the walls are immediately drawn with their actual thickness,
+     * but this leads to problems when displaying the dimensions of the walls,
+     * as it is not possible to guess which side of the wall of the room currently being entered is the inside of the wall.
+     */
+    drawPreviewMode?: Enumify<typeof DRAW_PREVIEW_MODES>;
+}
+export type RoomleColors = keyof typeof ROOMLE_COLORS;
+export type ColorsIn3dScene = Record<RoomleColors, HexColorString | HexColorNumber>;
+export type ThreeJsColorsIn3dScene = Record<keyof typeof ROOMLE_COLORS, Color>;
+/**
+ * Init data parameter which can be used in configurator AND planner
+ */
+export interface CommonInitData {
+    /**
+     * @description If set to true the configurator will make sure every device has great user experience  with fluid frame rate.
+     * If set to false the configurator will always show the highest quality possible.
+     * That could lead to stutter and other problems on low-end devices. We advise you to only turn off "autoQuality" if you really know what you are doing.
+     * usage: autoQuality=false
+     * @groups scene-settings
+     */
+    autoQuality?: boolean;
+    /**
+     * @description Can be used to personalize colors used in the 3D scene
+     * @groups scene-settings
+     */
+    colors?: ColorsIn3dScene;
+    /**
+     * @deprecated
+     * @description Set if the currently loaded id is an item or a configuration.
+     * In the new configurator UI this is determined automatically based on the id.
+     */
+    isItem?: boolean;
+    /**
+     * @description The item id or configuration id of the item which should be loaded.
+     * Examples:
+     * Configuration id: usm:frame:2449773A7F54278EBB61A67A10EF6A10E8BB6F38BE775B028AC050B438414507
+     * Item id: usm:frame
+     */
+    id?: RapiId;
+    /**
+     * @deprecated
+     * @internal
+     * @description Same as preloadHint, both call getPreloadForItem or getPreloadForConfiguration to pre load things needed
+     * for the configuration so that there are less XHR calls and the cache is pre-warmed
+     * Will no longer be used in the new configurator UI.
+     */
+    preloadId?: RapiId;
+    /**
+     * @deprecated
+     * @description Set if the AR button should be shown.
+     * In the new configurator UI this is in the configurator settings object called buttons.
+     */
+    showArButton?: boolean;
+    /**
+     * @internal
+     * @deprecated
+     * @description Use prices which are hardcoded in the configuration script.
+     * Only used for trade show demos.
+     */
+    useRoomlePrice?: boolean;
+    /**
+     * @description Set how many positions after the decimal point should be shown.
+     * For example:
+     * 8' 1.68" -> precisionCm=2 -> 8' 1.68"
+     * 8' 1.68" -> precisionCm=1 -> 8' 1.7"
+     * 8' 1.68" -> precisionCm=0 -> 8' 2"
+     */
+    precisionInch?: string;
+    /**
+     * @description Set how many positions after the decimal point should be shown.
+     * For example:
+     * 123,45 -> precisionCm=2 -> 123,45
+     * 123,45 -> precisionCm=1 -> 123,5
+     * 123,45 -> precisionCm=0 -> 124
+     */
+    precisionCm?: string;
+    /**
+     * @description Defines which unit should be used for measurements/dimensions
+     * Options: 'cm', 'mm', 'inchfeet'
+     */
+    unit?: string;
+    /**
+     * @description How the current unit should be formatted
+     * Options:
+     *   - 'none': No unit string added, for example '200'
+     *   - 'long': Long unit string, for example '200 meters'
+     *   - 'short': Short unit string, for example '200 m'
+     */
+    unitStringType?: string;
+    /**
+     * @description Add a tag id which is used to show different variations for the current item/configuration
+     * @deprecated
+     */
+    typeChangeTag?: RapiId;
+    /**
+     * @deprecated
+     * @internal
+     * @description Same as preloadId, both call getPreloadForItem or getPreloadForConfiguration to pre load things needed
+     * for the configuration so that there are less XHR calls and the cache is pre-warmed
+     * Will no longer be used in the new configurator UI.
+     */
+    preloadHint?: RapiId;
+    /**
+     * @deprecated
+     * @description Change the offset of the camera. For example if you add a margin left (0.1 means 10%) then
+     * the item moves to the right.
+     * This value is overridden in the new configurator UI.
+     * */
+    offset?: CanvasOffset;
+    /**
+     * @deprecated
+     * @description Add a tag id which is used to show different variations when opening the configurator
+     */
+    startTag?: RapiId;
+    /**
+     * @description When mesh selection is enabled, the meshes of the object are used directly for highlighting.
+     * Setting it to false could be useful for square/rectangular (shelf) items.
+     */
+    meshSelection?: boolean;
+    /**
+     * @description if set to true it shows a little overlay with performance stats
+     */
+    stats?: boolean;
+    /**
+     * @internal
+     * @description Enable service worker which tracks performance and request size (content, materials, etc)
+     */
+    _measureTraffic?: boolean;
+    /**
+     * @description This flag enables:
+     *   - Scripter debug logs (e.g. which parameter is not assigned to a parameter group)
+     *   - Free camera movement (no restrictions, camera stays after reload, panning using Shift key)
+     */
+    debug?: boolean;
+    /**
+     * @description If set to true, prices are calculated using the Roomle price service.
+     * For more information ask your Roomle contact.
+     */
+    usePriceService?: boolean;
+    /**
+     * @internal
+     * @description If set to true, it will disable the environment map completely
+     */
+    disableEnvMap?: boolean;
+    /**
+     * @description Url to an exr or hdr env map
+     * @groups scene-settings
+     */
+    envMapUrl?: string;
+    /**
+     * @description Set the intensity of the environment map
+     * @groups scene-settings
+     */
+    envMapIntensity?: number;
+    /**
+     * @description Set the rotation of the environment map in radians, between 0 and 2 * PI, rotates counter-clockwise
+     * @groups scene-settings
+     */
+    envMapRotation?: number;
+    /**
+     * @description Set the maximum number of light sources extracted from the environment map
+     * @groups scene-settings
+     */
+    maxLightSources?: number;
+    /**
+     * @description Use old light setting instead of env maps
+     * @groups scene-settings
+     */
+    legacyLight?: boolean;
+    /**
+     * @description Generate environment map from a scene instead of env maps
+     * use all_around for an surrounding light
+     * use front for a mainly frontal light
+     * @groups scene-settings
+     */
+    sceneLight?: DefaultEnvironmentSceneType;
+    /**
+     * @description General shading properties for the overall appearance
+     * default: for planner and a configurator with colorful, metallic or wooden materials
+     * bright: for a configurator with white and bright materials
+     * @groups scene-settings
+     */
+    shading?: SceneShadingType;
+    /**
+     * @description Customized shading properties for the overall appearance
+     * @groups scene-settings
+     */
+    customShading?: CustomShadingParameters;
+    /**
+     * @description Customized shading properties for the overall appearance in MOC
+     * @groups scene-settings
+     */
+    customShadingMoc?: CustomShadingParameters;
+    /**
+     * @description restrictionLevel defines visibility of parameters and possible children
+     */
+    restrictionLevel?: number;
+}
+export interface ConfiguratorInitData {
+    /**
+     * @deprecated
+     * @description Download all necessary files to run the configurator in offline mode
+     */
+    offlineSync?: string;
+    /**
+     * @description Sets the behavior of the highlighting of a hovered component.
+     * usage: highlighting=smart
+     */
+    highlighting?: Enumify<typeof ROOMLE_HIGHLIGHTNG>;
+    /**
+     * @deprecated
+     * @description Set the floor material which is used when loading the configurator
+     * For different options see {@link @roomle/web-sdk/configurator-core/src/environment/dynamic-environment-setting-loader#EnvironmentSetting}
+     */
+    initialFloorMaterial?: string;
+    /**
+     * @internal
+     * @description Load a light setting using an URL.
+     * Check lights in {@link @roomle/web-sdk/configurator-core/src/scene-settings-loader#SceneSettings} for an example.
+     * value is a dynamic light setting url
+     */
+    dls?: string;
+    /**
+     * @description Load a predefined light setting, eg: ls=sofa
+     * @groups scene-settings
+     */
+    ls?: string;
+    /**
+     * @deprecated
+     * @description define which floors to load
+     */
+    floorMaterialsTag?: RapiId;
+    /**
+     * @description Set the distance to which the user can zoom (in centimeters).
+     * default: object size divided by 10 or 10 cm
+     * usage: zoomDistance=3
+     * @groups scene-settings
+     */
+    zoomDistance?: number;
+    /**
+     * @description When set this param restricts the camera rotation to the given angle (e.g. 45 degree), this overrides minHorizontalCameraAngle and maxHorizontalCameraAngle
+     * default: not set -> no camera restriction
+     * usage: cameraRestriction=45
+     * @groups scene-settings
+     */
+    cameraRestriction?: number;
+    /**
+     * @description Sets the default/initial vertical camera angle (pitch)
+     * default: 10
+     * usage: verticalCameraAngle=45
+     * @groups scene-settings
+     */
+    verticalCameraAngle?: number;
+    /**
+     * @description When set this param restricts the down/vertical camera rotation to the given angle (e.g. 45 degree)
+     * default: not set -> no camera angle restriction
+     * usage: minVerticalCameraAngle=45
+     * @groups scene-settings
+     */
+    minVerticalCameraAngle?: number;
+    /**
+     * @description When set this param restricts the up/vertical camera rotation to the given angle (e.g. 45 degree)
+     * default: not set -> no camera angle restriction
+     * usage: maxVerticalCameraAngle=45
+     * @groups scene-settings
+     */
+    maxVerticalCameraAngle?: number;
+    /**
+     * @description Sets the default/initial horizontal camera angle (yaw)
+     * default: -30
+     * usage: horizontalCameraAngle=45
+     * @groups scene-settings
+     */
+    horizontalCameraAngle?: number;
+    /**
+     * @description When set this param restricts the left/horizontal camera rotation to the given angle (e.g. 45 degree)
+     * default: not set -> no camera angle restriction
+     * usage: minHorizontalCameraAngle=45
+     * @groups scene-settings
+     */
+    minHorizontalCameraAngle?: number;
+    /**
+     * @description When set this param restricts the right/horizontal camera rotation to the given angle (e.g. 45 degree)
+     * default: not set -> no camera angle restriction
+     * usage: maxHorizontalCameraAngle=45
+     * @groups scene-settings
+     */
+    maxHorizontalCameraAngle?: number;
+    /**
+     * @description If set to false the camera will just jump to a new position
+     * default: true
+     * usage: animateCamera=false
+     * @groups scene-settings
+     */
+    animateCamera?: boolean;
+    /**
+     * @internal
+     * @description Easter Egg
+     * */
+    bananaForScale?: boolean;
+    /**
+     * @description If set to true, components which are between the camera and the selected component/preview will be rendered transparent
+     * usage: transparentHighlighting=true
+     * @groups scene-settings
+     */
+    transparentHighlighting?: boolean;
+    /**
+     * @description If set to true, the background is transparent and allows elements behind the configurator to be visible through the scene.
+     * usage: transparentBackground=true
+     * @groups scene-settings
+     */
+    transparentBackground?: boolean;
+    /**
+     * @deprecated
+     * @description Shows partlist if there are no prices
+     */
+    showInfos?: boolean;
+    /**
+     * @deprecated
+     * @description Show price label using prices from configuration script
+     */
+    showPrice?: boolean;
+    /**
+     * @description If set to true it will try to apply all current global parameters to the loaded object
+     */
+    applyCurrentGlobalParameters?: boolean;
+    /**
+     * @description Adds the given spacing (in centimeters) to the loaded object. This is then used to calculate the initial camera distance
+     * default: 0
+     * usage:
+     *  cameraSpacing=100, zoom out further by increasing camera spacing by 100 centimeters
+     *  cameraSpacing=-30, zoom in further by decreasing camera spacing by 30 centimeters
+     * @groups scene-settings
+     */
+    cameraSpacing?: number;
+    /**
+     * @internal
+     * @description If set to true, screen space reflections are enabled
+     */
+    ssr?: boolean;
+    /**
+     * @internal
+     * @description features that can be enabled/disabled
+     */
+    featureFlags?: FeatureFlags;
+}
+export interface PlannerInitData {
+    /**
+     * @description Select with which camera mode to start initially.
+     * usage: mode=2D
+     * options: 2D, 3D, FP
+     */
+    mode?: Enumify<typeof CAMERA_TYPE>;
+    /**
+     * @internal
+     * @description If set to true the plan can be edited.
+     */
+    edit?: boolean;
+    /**
+     * @internal
+     * @description If set to true it will treat the planner as a multi object configurator (moc).
+     * This means:
+     *  - do not merge geometries
+     *  - set configurator environment & lights in planner
+     *  - reduce initial spacing of camera (higher zoom)
+     */
+    moc?: boolean;
+}
+export interface InitDataDefinition extends CommonInitData, ConfiguratorInitData, PlannerInitData {
+}

package/lib/definitions/packages/common-core/src/utils/single-promise-factory.d.ts

@@ -0,0 +1,16 @@
+import type { Context } from '../di/context';
+export declare const enum PROMISE_CATEGORY {
+    OFFLINE_CATALOG_SYNC = 0,
+    OFFLINE_FLOOR_TAG_SYNC = 1,
+    OFFLINE_TPYE_CHANGE_TAG_SYNC = 2,
+    START_HSC = 3,
+    START_GLB = 4,
+    FETCH_SCRIPT = 5,
+    ASSIGN_MATERIAL = 6
+}
+export default class SinglePromiseFactory implements Context {
+    _creator_: string;
+    private _promises;
+    constructor(creator: string);
+    create<T>(promiseCategory: PROMISE_CATEGORY, promiseIdentifier: string, workToDo: (resolve: (data?: T) => void, reject: (error: Error) => void) => void): Promise<T>;
+}

package/lib/definitions/packages/common-core/src/utils/stats-helper.d.ts

@@ -0,0 +1,15 @@
+import type CacheHolder from '../services/cache-holder';
+import type { WebGLInfo } from 'three';
+export default class StatsHelper {
+    protected _cacheHolder: CacheHolder;
+    private _statPanels;
+    private _drawPanel;
+    private _trianglesPanel;
+    private _geometryPanel;
+    private _texturePanel;
+    private _materialPanel;
+    private _qualityPanel;
+    private _init;
+    updateRenderInfo(info: WebGLInfo): void;
+    updateQualityInfo(qualitySetting: any): void;
+}

package/lib/definitions/packages/common-core/src/utils/string-utils.d.ts

@@ -0,0 +1 @@
+export declare const dashCase: (str: string) => string;