@roomle/embedding-lib 5.31.0 → 5.32.0

package/src/common/components/overlays/PartList.vue.d.ts

@@ -33,14 +33,31 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         }>;
         currencySymbol: import('vue').Ref<string, string>;
         price: import('vue').Ref<number, number>;
+        label: import('vue').Ref<string, string>;
+        componentHasChildren: import('vue').Ref<boolean, boolean>;
+        componentRuntimeId: import('vue').Ref<number, number>;
+        catalogLabel: import('vue').Ref<string, string>;
+        initialHash: import('vue').Ref<string, string>;
+        currentHash: import('vue').Ref<string, string>;
+        currentPlanElement: import('vue').Ref<UiPlanObject, UiPlanObject>;
         currentPrice: import('vue').ComputedRef<string>;
         hasNonGroupAddons: import('vue').ComputedRef<boolean>;
+        safeLabel: import('vue').ComputedRef<string>;
+        hasConfigurationChange: import('vue').ComputedRef<boolean>;
         updatePrice: (priceData: {
             currencySymbol: string;
             price: number;
         }) => void;
         setPiniaVuexReference: (store: Store<import('../../store').StoreState>) => void;
-    }, "parameters" | "groups" | "addons" | "partList" | "bounds" | "currencySymbol" | "price">, Pick<{
+        setLabel: (newLabel: string) => void;
+        setCatalogLabel: (newLabel: string) => void;
+        setComponentHasChildren: (hasChildren: boolean) => void;
+        setComponentRuntimeId: (runtimeId: number) => void;
+        setInitialHash: (hash: string) => void;
+        setCurrentHash: (hash: string) => void;
+        setCurrentPlanElement: (planElement: any) => void;
+        updateHash: (hash: string) => void;
+    }, "label" | "parameters" | "groups" | "addons" | "partList" | "bounds" | "currencySymbol" | "price" | "componentHasChildren" | "componentRuntimeId" | "catalogLabel" | "initialHash" | "currentHash" | "currentPlanElement">, Pick<{
         groups: import('vue').Ref<{
             parameters: any[];
         }[], import('../../../configurator/store/core-data-store').ParameterGroup[] | {
@@ -60,14 +77,31 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         }>;
         currencySymbol: import('vue').Ref<string, string>;
         price: import('vue').Ref<number, number>;
+        label: import('vue').Ref<string, string>;
+        componentHasChildren: import('vue').Ref<boolean, boolean>;
+        componentRuntimeId: import('vue').Ref<number, number>;
+        catalogLabel: import('vue').Ref<string, string>;
+        initialHash: import('vue').Ref<string, string>;
+        currentHash: import('vue').Ref<string, string>;
+        currentPlanElement: import('vue').Ref<UiPlanObject, UiPlanObject>;
         currentPrice: import('vue').ComputedRef<string>;
         hasNonGroupAddons: import('vue').ComputedRef<boolean>;
+        safeLabel: import('vue').ComputedRef<string>;
+        hasConfigurationChange: import('vue').ComputedRef<boolean>;
         updatePrice: (priceData: {
             currencySymbol: string;
             price: number;
         }) => void;
         setPiniaVuexReference: (store: Store<import('../../store').StoreState>) => void;
-    }, "currentPrice" | "hasNonGroupAddons">, Pick<{
+        setLabel: (newLabel: string) => void;
+        setCatalogLabel: (newLabel: string) => void;
+        setComponentHasChildren: (hasChildren: boolean) => void;
+        setComponentRuntimeId: (runtimeId: number) => void;
+        setInitialHash: (hash: string) => void;
+        setCurrentHash: (hash: string) => void;
+        setCurrentPlanElement: (planElement: any) => void;
+        updateHash: (hash: string) => void;
+    }, "currentPrice" | "hasNonGroupAddons" | "safeLabel" | "hasConfigurationChange">, Pick<{
         groups: import('vue').Ref<{
             parameters: any[];
         }[], import('../../../configurator/store/core-data-store').ParameterGroup[] | {
@@ -87,14 +121,31 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         }>;
         currencySymbol: import('vue').Ref<string, string>;
         price: import('vue').Ref<number, number>;
+        label: import('vue').Ref<string, string>;
+        componentHasChildren: import('vue').Ref<boolean, boolean>;
+        componentRuntimeId: import('vue').Ref<number, number>;
+        catalogLabel: import('vue').Ref<string, string>;
+        initialHash: import('vue').Ref<string, string>;
+        currentHash: import('vue').Ref<string, string>;
+        currentPlanElement: import('vue').Ref<UiPlanObject, UiPlanObject>;
         currentPrice: import('vue').ComputedRef<string>;
         hasNonGroupAddons: import('vue').ComputedRef<boolean>;
+        safeLabel: import('vue').ComputedRef<string>;
+        hasConfigurationChange: import('vue').ComputedRef<boolean>;
         updatePrice: (priceData: {
             currencySymbol: string;
             price: number;
         }) => void;
         setPiniaVuexReference: (store: Store<import('../../store').StoreState>) => void;
-    }, "setPiniaVuexReference" | "updatePrice">>;
+        setLabel: (newLabel: string) => void;
+        setCatalogLabel: (newLabel: string) => void;
+        setComponentHasChildren: (hasChildren: boolean) => void;
+        setComponentRuntimeId: (runtimeId: number) => void;
+        setInitialHash: (hash: string) => void;
+        setCurrentHash: (hash: string) => void;
+        setCurrentPlanElement: (planElement: any) => void;
+        updateHash: (hash: string) => void;
+    }, "setPiniaVuexReference" | "updatePrice" | "setLabel" | "setCatalogLabel" | "setComponentHasChildren" | "setComponentRuntimeId" | "setInitialHash" | "setCurrentHash" | "setCurrentPlanElement" | "updateHash">>;
     store: any;
     label: import('vue').ComputedRef<any>;
     price: import('vue').ComputedRef<string>;

package/src/common/composables/use-shared-sidebar-setup.d.ts

@@ -51,7 +51,7 @@ export declare const useSharedSidebarSetup: (topBar: Ref<HTMLElement> | null) =>
     showArButton: import('vue').ComputedRef<boolean>;
     showConfigureInRoomButton: import('vue').ComputedRef<boolean>;
     showPartlistButton: import('vue').ComputedRef<boolean>;
-    showMultiselectButton: import('vue').ComputedRef<any>;
+    showMultiselectButton: import('vue').ComputedRef<boolean>;
     enableMultiselectButton: import('vue').ComputedRef<boolean>;
     showDimensionsButton: import('vue').ComputedRef<boolean>;
     showFullscreenButton: import('vue').ComputedRef<boolean>;

package/src/common/store/index.d.ts

@@ -1,4 +1,3 @@
-import { CoreState } from '../../configurator/store/core-state';
 import { BUTTON_ACTIONS, UiState } from '../../configurator/store/ui-state';
 import { PlannerUiState } from '../../planner/store/planner-ui-state';
 import { Nullable } from '../utils/types';
@@ -14,13 +13,12 @@ export interface SharedUiState {
     topBarSelectedActions: BUTTON_ACTIONS[];
 }
 export declare const MUTATIONS: {
-    [x: string]: `UI_STATE_${string}` | `PLANNER_UI_STATE_${string}` | `CORE_STATE_${string}` | `PLANNER_CORE_STATE_${string}`;
+    [x: string]: `UI_STATE_${string}` | `PLANNER_UI_STATE_${string}` | `PLANNER_CORE_STATE_${string}`;
 };
 export declare const ACTIONS: {
-    [x: string]: `UI_STATE_${string}` | `PLANNER_UI_STATE_${string}` | `CORE_STATE_${string}` | `PLANNER_CORE_STATE_${string}`;
+    [x: string]: `UI_STATE_${string}` | `PLANNER_UI_STATE_${string}` | `PLANNER_CORE_STATE_${string}`;
 };
 export interface StoreState {
-    coreState: CoreState;
     uiState: UiState;
     plannerUiState: PlannerUiState;
     plannerCoreData: PlannerCoreData;

package/src/configurator/business-logic/sdk-connector.d.ts

@@ -23,6 +23,7 @@ import { Translator } from '../../common/composables/use-intl';
 import { Libs } from '../plugins/libs-plugin';
 import { ExternalConfiguration, RoomleConfiguratorType, RoomlePlannerWithExtObjs } from '@roomle/web-sdk/typings/external-objects';
 import { default as PlanElementViewModel } from '@roomle/web-sdk/common-core/src/view-model/plan-element-view-model';
+import { LoadExternalObjectGroupResult } from '@roomle/web-sdk/homag-intelligence/src/external-object-api';
 
 export declare enum SDK_MODULES {
     VIEWER = 0,
@@ -91,6 +92,11 @@ export declare class SdkConnector {
     hasActivePackage(): Promise<boolean>;
     isCorrectConfiguratorDomain(): Promise<boolean>;
     private _createPlanAndSelectObj;
+    /**
+     * Load an external object configuration
+     * @param data
+     */
+    loadExternalObject(data?: object): Promise<Nullable<LoadExternalObjectGroupResult[]>>;
     /**
      * Load a object which can be one of the following:
      * - Component (use your component id and prefix it with 'component@', e.g. component@demoCatalogId:externalMeshes)

package/src/configurator/embedding/exposed-api.d.ts

@@ -19,6 +19,7 @@ import { CustomViewSettingsForIframe, PossibleCustomViews } from './types';
 import { default as RapiAccess } from '@roomle/web-sdk/common-core/src/rapi-access';
 import { ID_TYPE } from '@roomle/web-sdk/planner-core/src/roomle-planner';
 import { RapiId } from '@roomle/web-sdk/typings/rapi-types';
+import { LoadExternalObjectGroupResult } from '@roomle/web-sdk/homag-intelligence/src/external-object-api';
 
 export declare class ExposedApi {
     private _sdk;
@@ -44,6 +45,11 @@ export declare class ExposedApi {
      * @param id database ID of the object you want to load
      */
     loadObject(id: string): Promise<Nullable<LoadResponse>>;
+    /**
+     * call this method to load the object you want into the 3d Scene
+     * @param data the external object configuration
+     */
+    loadExternalObject(data: object): Promise<Nullable<LoadExternalObjectGroupResult[]>>;
     /**
      * Calling this method while dragging an item in from a catalog (or external catalog)
      * will cancel the drag-in and remove the item from the scene.

package/src/configurator/store/core-data-store.d.ts

@@ -1,5 +1,5 @@
 import { StoreState } from '../../common/store';
-import { KernelParameterGroup, UiKernelParameter } from '@roomle/web-sdk/typings/kernel';
+import { KernelParameterGroup, UiKernelParameter, UiPlanObject } from '@roomle/web-sdk/typings/kernel';
 import { KernelBoundsFormatted } from '../../common/utils/helper';
 
 export interface ParameterGroup extends KernelParameterGroup {
@@ -25,14 +25,31 @@ export declare const useCoreDataStore: import('pinia').StoreDefinition<"coreData
     }>;
     currencySymbol: import('vue').Ref<string, string>;
     price: import('vue').Ref<number, number>;
+    label: import('vue').Ref<string, string>;
+    componentHasChildren: import('vue').Ref<boolean, boolean>;
+    componentRuntimeId: import('vue').Ref<number, number>;
+    catalogLabel: import('vue').Ref<string, string>;
+    initialHash: import('vue').Ref<string, string>;
+    currentHash: import('vue').Ref<string, string>;
+    currentPlanElement: import('vue').Ref<UiPlanObject, UiPlanObject>;
     currentPrice: import('vue').ComputedRef<string>;
     hasNonGroupAddons: import('vue').ComputedRef<boolean>;
+    safeLabel: import('vue').ComputedRef<string>;
+    hasConfigurationChange: import('vue').ComputedRef<boolean>;
     updatePrice: (priceData: {
         currencySymbol: string;
         price: number;
     }) => void;
     setPiniaVuexReference: (store: Store<StoreState>) => void;
-}, "parameters" | "groups" | "addons" | "partList" | "bounds" | "currencySymbol" | "price">, Pick<{
+    setLabel: (newLabel: string) => void;
+    setCatalogLabel: (newLabel: string | null) => void;
+    setComponentHasChildren: (hasChildren: boolean) => void;
+    setComponentRuntimeId: (runtimeId: number | null) => void;
+    setInitialHash: (hash: string | null) => void;
+    setCurrentHash: (hash: string | null) => void;
+    setCurrentPlanElement: (planElement: UiPlanObject | null) => void;
+    updateHash: (hash: string) => void;
+}, "label" | "parameters" | "groups" | "addons" | "partList" | "bounds" | "currencySymbol" | "price" | "componentHasChildren" | "componentRuntimeId" | "catalogLabel" | "initialHash" | "currentHash" | "currentPlanElement">, Pick<{
     groups: import('vue').Ref<{
         parameters: any[];
     }[], ParameterGroup[] | {
@@ -52,14 +69,31 @@ export declare const useCoreDataStore: import('pinia').StoreDefinition<"coreData
     }>;
     currencySymbol: import('vue').Ref<string, string>;
     price: import('vue').Ref<number, number>;
+    label: import('vue').Ref<string, string>;
+    componentHasChildren: import('vue').Ref<boolean, boolean>;
+    componentRuntimeId: import('vue').Ref<number, number>;
+    catalogLabel: import('vue').Ref<string, string>;
+    initialHash: import('vue').Ref<string, string>;
+    currentHash: import('vue').Ref<string, string>;
+    currentPlanElement: import('vue').Ref<UiPlanObject, UiPlanObject>;
     currentPrice: import('vue').ComputedRef<string>;
     hasNonGroupAddons: import('vue').ComputedRef<boolean>;
+    safeLabel: import('vue').ComputedRef<string>;
+    hasConfigurationChange: import('vue').ComputedRef<boolean>;
     updatePrice: (priceData: {
         currencySymbol: string;
         price: number;
     }) => void;
     setPiniaVuexReference: (store: Store<StoreState>) => void;
-}, "currentPrice" | "hasNonGroupAddons">, Pick<{
+    setLabel: (newLabel: string) => void;
+    setCatalogLabel: (newLabel: string | null) => void;
+    setComponentHasChildren: (hasChildren: boolean) => void;
+    setComponentRuntimeId: (runtimeId: number | null) => void;
+    setInitialHash: (hash: string | null) => void;
+    setCurrentHash: (hash: string | null) => void;
+    setCurrentPlanElement: (planElement: UiPlanObject | null) => void;
+    updateHash: (hash: string) => void;
+}, "currentPrice" | "hasNonGroupAddons" | "safeLabel" | "hasConfigurationChange">, Pick<{
     groups: import('vue').Ref<{
         parameters: any[];
     }[], ParameterGroup[] | {
@@ -79,12 +113,29 @@ export declare const useCoreDataStore: import('pinia').StoreDefinition<"coreData
     }>;
     currencySymbol: import('vue').Ref<string, string>;
     price: import('vue').Ref<number, number>;
+    label: import('vue').Ref<string, string>;
+    componentHasChildren: import('vue').Ref<boolean, boolean>;
+    componentRuntimeId: import('vue').Ref<number, number>;
+    catalogLabel: import('vue').Ref<string, string>;
+    initialHash: import('vue').Ref<string, string>;
+    currentHash: import('vue').Ref<string, string>;
+    currentPlanElement: import('vue').Ref<UiPlanObject, UiPlanObject>;
     currentPrice: import('vue').ComputedRef<string>;
     hasNonGroupAddons: import('vue').ComputedRef<boolean>;
+    safeLabel: import('vue').ComputedRef<string>;
+    hasConfigurationChange: import('vue').ComputedRef<boolean>;
     updatePrice: (priceData: {
         currencySymbol: string;
         price: number;
     }) => void;
     setPiniaVuexReference: (store: Store<StoreState>) => void;
-}, "setPiniaVuexReference" | "updatePrice">>;
+    setLabel: (newLabel: string) => void;
+    setCatalogLabel: (newLabel: string | null) => void;
+    setComponentHasChildren: (hasChildren: boolean) => void;
+    setComponentRuntimeId: (runtimeId: number | null) => void;
+    setInitialHash: (hash: string | null) => void;
+    setCurrentHash: (hash: string | null) => void;
+    setCurrentPlanElement: (planElement: UiPlanObject | null) => void;
+    updateHash: (hash: string) => void;
+}, "setPiniaVuexReference" | "updatePrice" | "setLabel" | "setCatalogLabel" | "setComponentHasChildren" | "setComponentRuntimeId" | "setInitialHash" | "setCurrentHash" | "setCurrentPlanElement" | "updateHash">>;
 export type CoreDataStore = ReturnType<typeof useCoreDataStore>;

package/src/planner/components/overlays/rooms/RoomGeneralSettings.vue.d.ts

@@ -4,11 +4,15 @@ import { BUTTON_ACTIONS } from '../../../../configurator/store/ui-state';
 declare const _default: import('vue').DefineComponent<{
     onClose: (_buttonAction: BUTTON_ACTIONS, _reason: CloseReason) => Promise<void>;
     onToggleExpand?: () => void;
+    onExpand?: () => void;
+    onCollapse?: () => void;
     interactionHandler: PlanInteractionHandler;
     api: RoomlePlanner;
 }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
     onClose: (_buttonAction: BUTTON_ACTIONS, _reason: CloseReason) => Promise<void>;
     onToggleExpand?: () => void;
+    onExpand?: () => void;
+    onCollapse?: () => void;
     interactionHandler: PlanInteractionHandler;
     api: RoomlePlanner;
 }> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;

package/src/planner/utils/planner-sidebar.d.ts

@@ -1,5 +1,4 @@
 import { UiPlanObject } from '@roomle/web-sdk/typings/kernel';
-import { StoreState } from '../../common/store';
 import { RapiConfiguration, RapiItem } from '@roomle/web-sdk/typings/rapi-types';
 import { Ref } from 'vue';
 
@@ -16,4 +15,4 @@ export declare const PLANNER_SIDEBAR_STATE_KEYS: {
     readonly LAYER_STATE: "planner_sidebar_layer_state";
 };
 export declare const matchProductListAndQuantity: (productList: UiPlanObject[]) => ProductListItem[];
-export declare const fillPartList: (data: RapiItem | RapiConfiguration, partList: KernelPartList, hash: string, plannerApi: RoomlePlannerWithExtObjs, store: Store<StoreState>) => Promise<void>;
+export declare const fillPartList: (data: RapiItem | RapiConfiguration, partList: KernelPartList, hash: string, plannerApi: RoomlePlannerWithExtObjs) => Promise<void>;

package/src/configurator/store/core-state.d.ts

@@ -1,21 +0,0 @@
-import { Module } from 'vuex';
-import { StoreState } from '../../common/store';
-import { Nullable } from '../../common/utils/types';
-import { EnsurePrefix } from './ui-state';
-import { UiPlanObject } from '@roomle/web-sdk/typings/kernel';
-
-type CoreStateIdentifier = EnsurePrefix<'CORE_STATE_'>;
-export interface CoreState {
-    label: string;
-    componentHasChildren: boolean;
-    componentRuntimeId: Nullable<number>;
-    catalogLabel: Nullable<string>;
-    initialHash: Nullable<string>;
-    currentHash: Nullable<string>;
-    currentPlanElement: Nullable<UiPlanObject>;
-}
-export declare const CORE_STATE_MUTATIONS: CoreStateIdentifier;
-export declare const CORE_STATE_ACTIONS: CoreStateIdentifier;
-export declare const CORE_STATE_GETTERS: CoreStateIdentifier;
-export declare const coreState: Module<CoreState, StoreState>;
-export {};