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

package/packages/web-sdk/packages/typings/rapi-types.d.ts

@@ -0,0 +1,510 @@
+import { Enumify } from '../common-core/src/types';
+import { InitDataDefinition } from '../common-core/src/utils/shims';
+
+export type RapiId = string;
+export type AssetUrl = string;
+export type ConfigurationString = string;
+export type ConfigurationHash = string;
+export type Base64String = string;
+export type RapiServerUrlType = 'live' | 'test';
+export type HexColorString = string;
+export type HexColorNumber = number;
+export type PriceId = string;
+export type ArticleNumber = string;
+export interface LinksCollection {
+    [key: string]: string;
+}
+export interface RoomleSortable {
+    sort?: number;
+}
+export interface RapiJsonBox {
+    meta?: RapiMeta;
+    [key: string]: RapiMeta | RapiJson | RapiJson[];
+}
+export interface RapiMeta {
+    serverTime: string;
+    total: number;
+    [key: string]: string | number;
+}
+export interface RapiJson {
+    id?: RapiId | number;
+    isLocally?: boolean;
+    __rapi_path__?: string;
+    [key: string]: any;
+    links?: LinksCollection;
+}
+export interface RapiPackage extends RapiJson {
+    components: RapiComponent[];
+    materials: RapiMaterial[];
+    textures: RapiTexture[];
+}
+export interface RapiBaseColor {
+    r: number;
+    g: number;
+    b: number;
+    [key: string]: number;
+}
+export interface RapiMesh extends RapiJson {
+    catalog: RapiId;
+    id: RapiId;
+}
+export interface RapiMeshData {
+    format: string;
+    quality: number;
+    url: string;
+    created: string;
+    changed: string;
+    meshId: RapiId;
+    [key: string]: number | string | RapiId;
+}
+export interface RapiMaterialShading {
+    version?: string;
+    alpha: number;
+    metallic: number;
+    specularity?: number;
+    basecolor: RapiBaseColor;
+    roughness: number;
+    doubleSided: boolean;
+    alphaCutoff?: number;
+    occlusion?: number;
+    transmission?: number;
+    reflectivity?: number;
+    transmissionIOR?: number;
+    emissiveColor?: RapiBaseColor;
+    emissiveIntensity?: number;
+    clearcoatIntensity?: number;
+    clearcoatRoughness?: number;
+    clearcoatNormalScale?: number;
+    sheenColor?: RapiBaseColor;
+    sheenIntensity?: number;
+    sheenRoughness?: number;
+    specularColor?: RapiBaseColor;
+    thicknessFactor?: number;
+    attenuationColor?: RapiBaseColor;
+    attenuationDistance?: number;
+    [key: string]: number | boolean | string | RapiBaseColor;
+}
+export interface RapiMaterial extends RapiJson {
+    id: RapiId;
+    name: string;
+    externalIdentifier: string;
+    group: string;
+    groupLabel: string;
+    color: string;
+    thumbnail: AssetUrl;
+    label: string;
+    textures: number[];
+    shading: RapiMaterialShading;
+    tags: RapiId[];
+    active: boolean;
+    additionalInfos?: AdditionalInfo[];
+    properties?: Record<string, string>;
+    sort?: number;
+    [key: string]: string | RapiMaterialShading | AssetUrl | RapiId | number[] | AdditionalInfo[] | boolean | number | LinksCollection | RapiId[] | Record<string, string>;
+}
+export interface RapiMaterialGroup extends RapiJson {
+    id: RapiId;
+    label: string;
+    materials: RapiMaterial[];
+    legacyId?: RapiId;
+    sort?: number;
+    [key: string]: string | RapiMaterial[] | RapiId | boolean | LinksCollection | number;
+}
+export declare const enum RAPI_TEXTURE_TYPE {
+    RGB = "RGB",// diffuse color texture
+    RGBA = "RGBA",// Diffuse color texture and opacity map
+    XYZ = "XYZ",// normal vectors encoded in the 3 color channels
+    ORM = "ORM",// ambient Occlusion, roughness and metalness stored in the red, green and blue channels of the texture (in this order)
+    EMRGB = "EMRGB",// emissive color texture
+    CCRG = "CCRG",// clear coat intensity and clear coat roughness stored in the red and green channels of the texture  (in this order)
+    CCXYZ = "CCXYZ",// separate normal vectors for the clear coat effect
+    SHRGBA = "SHRGBA",// sheen effect color texture and sheen roughness, the color is stored in the RGB channels and the roughness is stored in the alpha channel
+    SPRGBA = "SPRGBA",// specular color texture and specular intensity, the color is stored in the RGB channels and the intensity is stored in the alpha channel
+    TTRG = "TTRG"
+}
+export interface RapiTexture extends RapiJson {
+    mapping: RAPI_TEXTURE_TYPE;
+    url: AssetUrl;
+    image: AssetUrl;
+    height: number;
+    width: number;
+    mmHeight: number;
+    mmWidth: number;
+    tileable: boolean;
+    material: RapiId;
+    [key: string]: string | number | boolean | AssetUrl | RapiId | LinksCollection;
+}
+export interface RapiCatalog extends RapiJson {
+    id: RapiId;
+    name: string;
+    featuredImage: string;
+    externalIdentifier: string;
+    cover: string;
+    brandIcon: string;
+    description: string;
+    free: boolean;
+    public: boolean;
+    featured: boolean;
+    sort: number;
+    created: string;
+    updated: string;
+    hidden: boolean;
+    hiddenByUser: boolean;
+    hiddenByTenant: boolean;
+    tenantIsOwner: boolean;
+    orderable: boolean;
+    active: boolean;
+    purchased: boolean;
+    branded: boolean;
+    tenant: RapiTenant;
+    items: RapiItem[];
+    allItems: RapiItem[];
+    components: RapiComponent[];
+    materials: RapiMaterial[];
+    tags: RapiId[];
+    allTags: RapiTag[];
+    rootTags: RapiTag[];
+    retailers: RapiRetailer[];
+    [key: string]: string | number | boolean | RapiRetailer | RapiTag | RapiMaterial | RapiComponent | RapiItem | RapiTenant;
+}
+export interface RapiTenant extends RapiJson {
+    name: string;
+    label: string;
+    defaultLanguage: string;
+    active: boolean;
+    showLanguageSwitch: boolean;
+    branded: boolean;
+    authenticationRequired: boolean;
+    configuration: string;
+    privacyUrl: string;
+    catalogs: RapiCatalog[];
+    users: RapiUser[];
+    roles: RapiRole[];
+    skin: RapiSkin[];
+    plans: RapiPlan[];
+}
+export interface RapiUser extends RapiJson {
+    username: string;
+    salutationCode: number;
+    firstname: string;
+    lastname: string;
+    email: string;
+    street: string;
+    zipcode: string;
+    city: string;
+    countryCode: string;
+    birthdate: string;
+    phone: string;
+    locale: string;
+    registerDate: string;
+    password: string;
+    lastLogin: string;
+    active: boolean;
+    newsletter: boolean;
+    emailValidated: string;
+    termsChanged: boolean;
+    providedConsentInTenant: boolean;
+    priceLists: any;
+    tenants: RapiTenant[];
+    roles: RapiRole[];
+    catalogs: RapiCatalog[];
+    plans: RapiPlan[];
+    favorites: RapiFavorite[];
+    setting: RapiUserSetting;
+}
+export declare const enum RapiFavoriteType {
+    ITEM = 1,
+    CONFIG = 2,
+    AFFILIATE = 3
+}
+export interface RapiFavorite extends RapiJson {
+    objectId: string;
+    type: RapiFavoriteType;
+    created: string;
+    user: RapiUser;
+}
+export interface RapiUserSetting extends RapiJson {
+    metric: boolean;
+    measurements: boolean;
+    area: boolean;
+    furnitureSnap: boolean;
+    user: RapiUser;
+}
+export interface RapiRole extends RapiJson {
+    role: number;
+    allowedModules: any;
+    tenantId: RapiTenant;
+    userId: RapiUser;
+}
+export interface RapiSkin extends RapiJson {
+    accentColor: string;
+    appIcon: string;
+    backgroundImage: string;
+    btnColorDark: string;
+    btnColorLight: string;
+    ciColor: string;
+    dashboardBackground: string;
+    loginBackground: string;
+    dashboardLogo: string;
+    fontColor: string;
+    headerBackgroundColor: string;
+    headerForegroundColor: string;
+    logo: string;
+    mailBackgroundColor: string;
+    mailHeaderImage: string;
+    planBackground: string;
+    planLogo: string;
+    splashScreenImage: string;
+    tenantUrl: string;
+    watermarkImage: string;
+    brandedCatalogsIcon: string;
+    planNote: string;
+    inquiryImage: string;
+    inquiryLink: string;
+    hideMadeByRoomle: boolean;
+    hidePressLink: boolean;
+    hideShareButton: boolean;
+    translationPath: string;
+    hideFeedbackButton: boolean;
+    referralUrl: string;
+    hideCatalogOverview: boolean;
+    tenant: RapiTenant;
+    catalogEntryTags: RapiTag;
+}
+export interface RapiPlan extends RapiJson {
+    name: string;
+    description: string;
+    changeDate: string;
+    created: string;
+    draftId: number;
+    thumbnail: string;
+    planObjects: string;
+    active: boolean;
+    right?: number;
+    draft?: number;
+    open: number;
+    planDirectory: number;
+    changed: number;
+    version: number;
+    floorLevel: number;
+    visibility: number;
+    user: RapiUser | RapiId;
+    tenant: RapiTenant | RapiId;
+    assets: RapiPlanAsset[];
+    parent: RapiPlan | RapiId;
+    setting: RapiPlanSetting;
+}
+export interface RapiPlanAsset extends RapiJson {
+    image: string;
+}
+export interface RapiPlanSetting extends RapiJson {
+    metric: boolean;
+    measurements: boolean;
+    area: boolean;
+    furnitureSnap: boolean;
+    plan: RapiPlan;
+}
+export type RapiPlanSnapshotId = `ps_${string}`;
+export interface RapiPlanSnapshotPostData extends RapiJson {
+    parentId: RapiId;
+    planObjects: Array<{
+        combinedId: RapiId;
+        position: string;
+    }>;
+    plan: string;
+}
+export interface RapiPlanSnapshotGetData extends RapiPlanSnapshotPostData {
+    combinedIds: RapiId[];
+    embedId: RapiId;
+    perspectiveImage: string;
+    topImage: string;
+}
+export interface RapiPlanSnapshotGetDataWith3dUrls extends RapiPlanSnapshotGetData {
+    glb: string;
+    usdz: string;
+}
+export interface RapiRetailer extends RapiJson {
+}
+export interface RapiConfiguration extends RapiJson {
+    id: RapiId;
+    created: string;
+    lastAccess: string;
+    configuration: ConfigurationString;
+    configurationHash: string;
+    parts: string;
+    perspectiveImage?: AssetUrl;
+    topImage?: AssetUrl;
+    rootComponentId: RapiId;
+    orderable?: boolean;
+    requestable?: boolean;
+    width: number;
+    height: number;
+    depth: number;
+    catalog?: RapiId;
+    assets?: AssetItem;
+    [key: string]: string | number | boolean | AssetUrl | RapiId | LinksCollection | AssetItem;
+}
+export interface RapiConfigurationEnhanced extends RapiConfiguration {
+    label: string;
+}
+export interface Element {
+    id: string;
+    label: string;
+    perspectiveImage: AssetUrl;
+}
+export interface RapiElement extends RapiJson, RoomleSortable, Element {
+    id: RapiId;
+    configuration?: ConfigurationString;
+    externalIdentifier: string;
+    tags: RapiId[];
+    [key: string]: string | number | boolean | AssetUrl | RapiId | RapiId[] | LinksCollection | AdditionalInfo[] | AssetItem;
+}
+export declare const CATALOG_INFOS_TYPES: {
+    readonly PARAMETER: "parameter";
+    readonly PARAMETER_VALUE: "paramValue";
+    readonly MATERIAL: "material";
+    readonly COMPONENT: "component";
+    readonly ITEM: "item";
+};
+export interface AdditionalInfo {
+    type: Enumify<typeof CATALOG_INFOS_TYPES>;
+    key: string;
+    parentIdFilter: string;
+    catalog: string;
+    tooltip: {
+        [key: string]: string;
+    };
+    fullInfo: {
+        type: string;
+        url: {
+            [key: string]: string;
+        };
+    };
+}
+export interface RapiComponent extends RapiElement {
+    active: boolean;
+    additionalInfos: AdditionalInfo[];
+}
+export interface Asset {
+    format: string;
+    url: string;
+}
+export interface AssetItem {
+    [key: string]: Asset;
+}
+export interface RapiItem extends RapiElement {
+    width: number;
+    height: number;
+    depth: number;
+    basecolor: number;
+    displayedWidth: number;
+    displayedHeight: number;
+    displayedDepth: number;
+    perspectiveImageHD: AssetUrl;
+    topImage: AssetUrl;
+    threeDimensionalAssetWeb: AssetUrl;
+    threeDimensionalAssetIOS: AssetUrl;
+    threeDimensionalAsset: AssetUrl;
+    flipable: boolean;
+    scaleable: boolean;
+    meta: string;
+    hidden: boolean;
+    link?: string;
+    colorable: boolean;
+    layer: number;
+    language: string;
+    type: string;
+    detailType: string;
+    currencySymbol?: string;
+    customerPrice?: number;
+    sort: number;
+    orderable: boolean;
+    requestable: boolean;
+    catalog: RapiId;
+    assets?: AssetItem;
+    rootComponentId?: string;
+}
+export declare const enum RAPI_ADDITIONAL_CONTENTS {
+    UNKNOWN = 0,
+    LINK = 1,
+    TEXT = 2,
+    VIDEO = 3,
+    DOWNLOAD = 4,
+    IMAGE = 5,
+    SKETCH = 6
+}
+export interface RapiAdditionalContent extends RapiJson {
+    changed: string;
+    content: string;
+    created: string;
+    itemId: RapiId;
+    label: string;
+    language: string;
+    type: RAPI_ADDITIONAL_CONTENTS;
+}
+export interface RapiTagGeneric extends RapiJson {
+    label?: string;
+    externalIdentifier: string;
+    pngIcon?: AssetUrl;
+    svgIcon?: AssetUrl;
+    inspirationImage?: AssetUrl;
+    global: boolean;
+    sort?: number;
+    created: string;
+    updated: string;
+    language: string;
+    description?: string;
+    catalog: RapiId;
+    tags: RapiId[];
+    parents: RapiId[];
+    [key: string]: string | number | boolean | AssetUrl | RapiId | RapiId[] | RapiElement[] | RapiMaterial[] | LinksCollection;
+}
+export interface RapiTag extends RapiTagGeneric {
+    id: RapiId;
+    items: RapiId[];
+    materials: RapiId[];
+}
+export interface RapiTagForUi extends RapiTagGeneric {
+    materials: RapiMaterial[];
+    items: RapiItem[];
+}
+export interface RapiShortId {
+    shortId: string;
+    referencedId: string;
+    url: string;
+    type: number;
+    created: string;
+    lastAccess: string;
+    [key: string]: string | number;
+}
+export interface RapiPrice {
+    priceId: PriceId;
+    price: number;
+    currencySymbol: string;
+}
+export interface RapiConfiguratorSettings {
+    id: string;
+    tenant: number;
+    allowedHosts: string;
+    settings: InitDataDefinition;
+}
+export interface UserAction {
+    module: number;
+    action: number;
+    planId: RapiId;
+    actionId: RapiId;
+    actionValue: number;
+    actionLabel: number;
+}
+export declare const enum MAIL_TYPE {
+    STANDARD = 1,
+    AUGMENTED_REALITY = 2,
+    SAVE_DRAFT = 3,
+    PLANNER_SHARE = 13
+}
+export interface RapiAuth {
+    token: string;
+    lastActionDate: string;
+    loginDate: string;
+    userId: RapiId;
+}

package/packages/web-sdk/packages/typings/shims.d.ts

@@ -0,0 +1,12 @@
+import { InitDataDefinition } from '../common-core/src/utils/shims';
+
+export interface ExternalEnv {
+    assetPath?: string;
+    initData?: InitDataDefinition;
+    locale?: string;
+}
+declare global {
+    interface Window {
+        __RML__ENV__: ExternalEnv;
+    }
+}

package/packages/web-sdk/packages/typings/stats.d.ts

@@ -0,0 +1,4 @@
+export declare class Panel {
+    constructor(name: string, accentColor: string, backgroundColor: string);
+    update(value: number, maxNumber: number): void;
+}

package/packages/web-sdk/packages/workers/__tests__/asset-loader.d.ts

@@ -0,0 +1 @@
+export {};

package/packages/web-sdk/packages/workers/__tests__/budgeteer.sw.d.ts

@@ -0,0 +1 @@
+export {};

package/packages/web-sdk/packages/workers/__tests__/communication-interface.d.ts

@@ -0,0 +1 @@
+export {};

package/packages/web-sdk/packages/workers/src/asset-loader.d.ts

@@ -0,0 +1,8 @@
+import { CommunicationInterfaceCallback, WORKER_MESSAGE } from './communication-interface';
+
+export default class AssetLoaderMain implements CommunicationInterfaceCallback {
+    private _loader;
+    private _communicationInterface;
+    constructor();
+    onCommand(command: WORKER_MESSAGE, conversationId: number, data: any): void;
+}

package/packages/web-sdk/packages/workers/src/asset-loader.worker.d.ts

@@ -0,0 +1 @@
+export {};

package/packages/web-sdk/packages/workers/src/budgeteer/constants.d.ts

@@ -0,0 +1,41 @@
+export interface ContentMeta {
+    type: BUDGETEER_TYPES;
+    contentLength: number;
+    elemCount: number;
+}
+export declare const enum BUDGETEER_CATEGORY {
+    JS = "js",
+    CSS = "css",
+    VARIOUS = "various",
+    CONTENT = "content",
+    IMAGES = "images",
+    WASM = "wasm",
+    ASSETS_3D = "assets3d",
+    JSON = "json"
+}
+export declare const enum BUDGETEER_TYPES {
+    WASM = "wasm",
+    JS = "js",
+    CSS = "css",
+    JSON = "json",
+    CRT = "crt",
+    JPG = "jpg",
+    PNG = "png",
+    GIF = "gif",
+    COMPONENTS = "components",
+    TEXTURES = "textures",
+    MATERIALS = "materials",
+    CONFIGURATIONS = "configurations",
+    ITEMS = "items",
+    TAGS = "tags",
+    UNKNOWN = "unknown",
+    GLB = "glb",
+    PLANS = "plans"
+}
+export interface BudgeteerEntry {
+    type: BUDGETEER_TYPES;
+    size: number;
+    count: number;
+    timing: number;
+}
+export declare const RAPI_URL_PATTERN: RegExp;

package/packages/web-sdk/packages/workers/src/budgeteer.sw.d.ts

@@ -0,0 +1,16 @@
+import { BudgeteerEntry, ContentMeta, BUDGETEER_CATEGORY, BUDGETEER_TYPES } from './budgeteer/constants';
+
+export type BudgeteerOverview = Map<BUDGETEER_CATEGORY, Map<string, BudgeteerEntry>>;
+export declare const getCategory: (url: string, contentType: string) => BUDGETEER_CATEGORY.JS | BUDGETEER_CATEGORY.VARIOUS | BUDGETEER_CATEGORY.CONTENT | BUDGETEER_CATEGORY.IMAGES | BUDGETEER_CATEGORY.WASM | BUDGETEER_CATEGORY.ASSETS_3D | BUDGETEER_CATEGORY.JSON;
+export declare const getType: (url: string, category: BUDGETEER_CATEGORY) => BUDGETEER_TYPES.WASM | BUDGETEER_TYPES.JS | BUDGETEER_TYPES.CSS | BUDGETEER_TYPES.CRT | BUDGETEER_TYPES.JPG | BUDGETEER_TYPES.PNG | BUDGETEER_TYPES.GIF | BUDGETEER_TYPES.UNKNOWN | BUDGETEER_TYPES.GLB;
+export declare const extractTypeFromFileExtension: (url: string) => BUDGETEER_TYPES.CRT | BUDGETEER_TYPES.JPG | BUDGETEER_TYPES.PNG | BUDGETEER_TYPES.GIF | BUDGETEER_TYPES.UNKNOWN | BUDGETEER_TYPES.GLB;
+export declare const getTypeFromRapiModel: (modelname: string) => BUDGETEER_TYPES.COMPONENTS | BUDGETEER_TYPES.TEXTURES | BUDGETEER_TYPES.MATERIALS | BUDGETEER_TYPES.CONFIGURATIONS | BUDGETEER_TYPES.ITEMS | BUDGETEER_TYPES.TAGS | BUDGETEER_TYPES.UNKNOWN | BUDGETEER_TYPES.PLANS;
+export declare const handleContent: (response: Response) => Promise<ContentMeta>;
+export declare const getContentSizeOf: (category: BUDGETEER_CATEGORY) => number;
+export declare const resetOverview: () => void;
+export declare const getSizeOf: (category: BUDGETEER_CATEGORY) => number;
+export declare const printCategoryTable: (category: BUDGETEER_CATEGORY) => void;
+export declare const printStats: (details: boolean) => void;
+export declare const getOverview: () => BudgeteerOverview;
+export declare const getRequestCount: () => number;
+export declare const handleFetchEvent: (event: any) => void;

package/packages/web-sdk/packages/workers/src/communication-interface.d.ts

@@ -0,0 +1,29 @@
+export declare const enum WORKER_CONSTANTS {
+    PREFIX = "rml",
+    SEPERATOR = "."
+}
+export declare const enum WORKER_MESSAGE {
+    PREFIX = 0,
+    INIT = 1,
+    ERROR = 2,
+    ASSET_LOADED = 3,
+    INIT_DONE = 4,
+    LOAD_ASSET = 5,
+    SW_CLAIMED_CONTROL = 6
+}
+export declare const NO_CONVERSATION_ID = -1;
+export interface CommunicationInterfaceCallback {
+    onCommand(command: WORKER_MESSAGE, conversationId: number, data: any): void;
+}
+export declare const resetConversationIds: () => void;
+export declare abstract class CommunicationInterface {
+    private _callbacks;
+    protected eventListener: any;
+    private _eventPoster;
+    protected get eventPoster(): any;
+    protected hasEventPoster(): boolean;
+    constructor(_callbacks: CommunicationInterfaceCallback, eventListener: any);
+    protected nextConversationId(): number;
+    setEventPoster(eventPoster: any): void;
+    handleEvent(e: MessageEvent): void;
+}

package/packages/web-sdk/packages/workers/src/main-thread-to-worker.d.ts

@@ -0,0 +1,8 @@
+import { CommunicationInterfaceCallback, WORKER_MESSAGE, CommunicationInterface } from './communication-interface';
+
+export declare class MainThreadToWorker extends CommunicationInterface {
+    private _promiseCallbacks;
+    constructor(callback: CommunicationInterfaceCallback, eventListener: Worker | ServiceWorker | ServiceWorkerContainer);
+    sendToWorker(command: WORKER_MESSAGE, data?: any, resolve?: (...args: any[]) => void, reject?: (...args: any[]) => void): void;
+    resolvePromises(conversationId: number, data: any[]): void;
+}

package/packages/web-sdk/packages/workers/src/static-files/workers.d.ts

@@ -0,0 +1,4 @@
+import { default as BUDGETEER_FILE_NAME } from '../../generated/budgeteer.sw.js?no-inline?url';
+import { default as ASSET_LOADER_FILE_NAME } from '../../generated/asset-loader.worker.js?no-inline?url';
+
+export { BUDGETEER_FILE_NAME, ASSET_LOADER_FILE_NAME };

package/packages/web-sdk/packages/workers/src/worker-to-main-thread.d.ts

@@ -0,0 +1,6 @@
+import { CommunicationInterfaceCallback, WORKER_MESSAGE, CommunicationInterface } from './communication-interface';
+
+export declare class WorkerToMainThread extends CommunicationInterface {
+    constructor(callback: CommunicationInterfaceCallback, eventListener?: Worker);
+    sendToMainThread(command: WORKER_MESSAGE, conversationId: number, data: any): void;
+}