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

package/packages/web-sdk/packages/homag-intelligence/src/model/oc-scripts-domain.model.d.ts

@@ -0,0 +1,312 @@
+export declare const enum PosUserRight {
+    Simple = "Simple",
+    Advanced = "Advanced",
+    Master = "Master"
+}
+export declare const enum UserRightLevel {
+    Simple = 0,
+    Advanced = 1,
+    Master = 2
+}
+export declare const getUserRightLevel: (right?: PosUserRight | null) => UserRightLevel;
+export interface PosArticleInfo {
+    /**
+     * Defined the library that is used / must match the MasterData
+     */
+    libraryId: string;
+    /**
+     * Defined the library that is used / must match the MasterData
+     */
+    catalog: string;
+    /**
+     * The id of the initial article
+     */
+    articleId: string;
+    /**
+     * The name of the initial article
+     */
+    articleName?: string;
+    desc?: string;
+    imageUrl?: string;
+    category?: string;
+}
+export interface PosPartData {
+    id: string;
+    hidden?: boolean;
+    relPos: number[];
+    dim: number[];
+    fullMatrix: number[];
+    openfullMatrix?: number[];
+    name: string;
+    material?: PosFaceMaterial[] | string;
+    extrude?: PosPartExtrudeInfo;
+    model?: PosPartModelInfo;
+    hideModelWhenOpen?: boolean;
+    modelOpen?: PosPartModelInfo;
+}
+export interface PosPartExtrudeInfo {
+    svg: string;
+    direction: string;
+}
+export interface PosFaceMaterial {
+    materialId: string;
+    faceKey?: PosFaceKey;
+    uvRotation?: number;
+    uvOffset?: number[];
+    uvScale?: number[];
+}
+export declare enum PosFaceKey {
+    Default = "default",
+    Bottom = "bottom",
+    Top = "top",
+    Left = "left",
+    Right = "right",
+    Front = "front",
+    Back = "back",
+    Side = "side"
+}
+export interface PosPartModelInfo {
+    url: string;
+    params?: string;
+}
+export interface PosModuleAttribute {
+    id: string;
+    value?: number | string | boolean;
+    isInput?: boolean;
+}
+export interface PosModuleData {
+    id: string;
+    name: string;
+    modules?: PosModuleData[];
+    parts?: PosPartData[];
+    imageUrl?: string;
+    attributes?: PosModuleAttribute[];
+    canBeDeleted?: boolean;
+    isGenerated?: boolean;
+    checkAttributes?: Map<string, string | number | boolean | undefined>;
+}
+export interface PosModuleRootData extends PosModuleData, PosArticleInfo {
+    /**
+     * Additional text for this root module
+     */
+    additionalText?: string;
+    /**
+     * Position of this article; if not set it is always 0,0,0 (x/y/z)
+     */
+    articlePos?: number[];
+    /**
+     * Rotation on the vertical axis in degree (0-359)
+     */
+    rotationY?: number;
+    logMessages: PosErrorMsg[];
+    dockInfos: PosDockInfo[];
+    insertLevelInfos?: PosInsertLevelInfo[];
+    insertLevelFixed?: boolean;
+}
+export interface PosInsertLevelInfo {
+    height: number;
+    isDefault?: boolean;
+}
+export interface PosDockInfo {
+    id: PosDock;
+    start: number[];
+    end: number[];
+}
+export declare const enum PosDock {
+    RightTop = "RightTop",
+    BackTop = "BackTop",
+    LeftTop = "LeftTop",
+    RightBottom = "RightBottom",
+    BackBottom = "BackBottom",
+    LeftBottom = "LeftBottom",
+    LeftBackTop = "LeftBackTop",
+    RightBackTop = "RightBackTop",
+    LeftBackBottom = "LeftBackBottom",
+    RightBackBottom = "RightBackBottom"
+}
+export interface PosErrorMsg {
+    category: LogMessageCategoryType;
+    msg: string;
+    seqNo: number;
+    timestamp: string;
+    scope?: LogMessageScope;
+}
+export interface LogMessageScope {
+    moduleUniqueId?: string;
+    attrId?: string;
+}
+export declare const enum LogMessageCategoryType {
+    Fatal = "Fatal",
+    Error = "Error",
+    Warning = "Warning",
+    Info = "Info",
+    Debug = "Debug"
+}
+export interface PosContourSegment {
+    cmd: string;
+    x: number;
+    y: number;
+    angle: number;
+    type?: string;
+}
+export interface PosContour {
+    level: number;
+    segments: PosContourSegment[];
+}
+export interface PosGroup {
+    /**
+     * The unique id of the Group
+     */
+    id: string;
+    /**
+     * One or multiple roots for this article group
+     */
+    roots: PosModuleRootData[];
+    /**
+     * Global (error) messages
+     */
+    logMessages: PosErrorMsg[];
+    /**
+     * Position/Orientation inside the room
+     */
+    /**
+     * Optional a position of this group
+     */
+    pos?: number[];
+    /**
+     * The rotation on the vertical axis in degree (0-360)
+     */
+    rotationY?: number;
+    /**
+     * Optional a contour list of the surrounding elements
+     */
+    contours?: PosContour[];
+    /**
+     * The version used for this data structure
+     */
+    ver?: number;
+}
+export interface PosArticle extends PosArticleInfo {
+    roots: PosModuleRootData[];
+}
+export interface PosSaveData {
+    groups: PosGroup[];
+    roomlePlannerId?: string;
+    perspectiveImageLink?: string;
+    topImageLink?: string;
+    room3dLink?: string;
+    room3dFullLink?: string;
+}
+export interface PosPriceData {
+    Groups: PosPriceGroup[];
+    LogMessages: PosErrorMsg[];
+}
+export interface PosPriceGroup {
+    Id: string;
+    Roots: PosRootPrice[];
+}
+export interface PosRootPrice {
+    Id: string;
+    TotalPrice?: number;
+    Currency?: string;
+}
+export interface PosArticleCalculation {
+    /**
+     * Calculates the article group
+     * @param article
+     * @returns calc
+     */
+    calc(article: PosGroup): PosGroup;
+}
+export type MDAttributeSelection = MDBoolAttributeSelection | MDTextAttributeSelection | MDIntegerAttributeSelection | MDRealAttributeSelection | MDDimAttributeSelection;
+interface BaseAttributeSelection {
+    imageUrl?: string;
+    desc?: string;
+    name?: string;
+}
+export interface MDBoolAttributeSelection extends BaseAttributeSelection {
+    value?: boolean;
+}
+export interface MDTextAttributeSelection extends BaseAttributeSelection {
+    value?: string;
+}
+export interface MDIntegerAttributeSelection extends BaseAttributeSelection {
+    value?: number;
+}
+export interface MDRealAttributeSelection extends BaseAttributeSelection {
+    value?: number;
+}
+export interface MDDimAttributeSelection extends BaseAttributeSelection {
+    value?: number;
+}
+export interface MDNumberMinMaxAttributeSelection {
+    min?: number;
+    max?: string;
+    desc?: string;
+}
+export declare const enum MDType {
+    Dim = "Dim",
+    Integer = "Integer",
+    Real = "Real",
+    Bool = "Bool",
+    Text = "Text"
+}
+export type MDAttributeInfo = MDBoolAttributeInfo | MDTextAttributeInfo | MDIntegerAttributeInfo | MDRealAttributeInfo | MDDimAttributeInfo;
+interface BaseMDAttributeInfo {
+    id: string;
+    name: string;
+    isMain?: boolean;
+    desc?: string;
+    group?: string;
+    imageUrl?: string;
+    type: MDType;
+    userRight?: PosUserRight | null;
+    userView?: string | null;
+    implicitRelevant?: boolean;
+    sorting?: number;
+}
+export interface MDBoolAttributeInfo extends BaseMDAttributeInfo {
+    selections?: MDBoolAttributeSelection[];
+    type: MDType.Bool;
+}
+export interface MDTextAttributeInfo extends BaseMDAttributeInfo {
+    selections?: MDTextAttributeSelection[];
+    type: MDType.Text;
+}
+export interface MDIntegerAttributeInfo extends BaseMDAttributeInfo {
+    selections?: (MDIntegerAttributeSelection | MDNumberMinMaxAttributeSelection)[];
+    type: MDType.Integer;
+}
+export interface MDRealAttributeInfo extends BaseMDAttributeInfo {
+    selections?: (MDRealAttributeSelection | MDNumberMinMaxAttributeSelection)[];
+    type: MDType.Real;
+}
+export interface MDDimAttributeInfo extends BaseMDAttributeInfo {
+    selections?: (MDDimAttributeSelection | MDNumberMinMaxAttributeSelection)[];
+    type: MDType.Dim;
+}
+export interface MDModuleInfo {
+    id: string;
+    name: string;
+    desc?: string;
+    group?: string;
+    imageUrl?: string;
+    assignedAttributes: string[];
+}
+export interface MasterData {
+    libraryId: string;
+    modules: MDModuleInfo[];
+    attributes: MDAttributeInfo[];
+}
+export interface CheckResult {
+    calcResult: CheckDropDownEntry[];
+}
+export interface CheckDropDownEntry {
+    value: string | number | boolean;
+    kind: CheckDropDownEntryKind;
+}
+export declare enum CheckDropDownEntryKind {
+    Normal = 0,
+    Conflicting = 1
+}
+export {};

package/packages/web-sdk/packages/homag-intelligence/src/orders.d.ts

@@ -0,0 +1,39 @@
+import { default as RoomlePlanner } from '../../planner-core/src/roomle-planner';
+import { GlueLogic } from './emulator';
+import { ApiOptions } from './loader';
+
+export declare const createEmptyOrder: () => {
+    id: any;
+    state: string;
+    orderNumber: string;
+    orderName: string;
+    orderDescription: string;
+    project: string;
+    personInCharge: string;
+    orderDate: string;
+    deliveryDatePlanned: string;
+    addresses: {
+        type: string;
+        street: string;
+        houseNumber: string;
+        postalCode: string;
+        city: string;
+        country: string;
+    }[];
+    customerName: string;
+    customerNumber: string;
+    createdAt: string;
+    changedAt: string;
+    changedBy: string;
+    items: any[];
+};
+export declare const sendToOM: (apiOptions: ApiOptions, roomlePlanner: RoomlePlanner, gluLogic: GlueLogic, withPrice?: boolean) => Promise<void>;
+export declare const fetchPrice: (apiOptions: ApiOptions, gluLogic: GlueLogic, planId?: string) => Promise<any>;
+export default class Orders {
+    private _roomlePlanner;
+    private _gluLogic;
+    private _apiOptions;
+    constructor(roomlePlanner: RoomlePlanner, gluLogic: GlueLogic, apiOptions: ApiOptions);
+    sendToOM(withPrice?: boolean): Promise<void>;
+    fetchPrice(planId?: string): Promise<any>;
+}

package/packages/web-sdk/packages/homag-intelligence/src/rml-plugin.d.ts

@@ -0,0 +1,3 @@
+export declare abstract class RmlPlugin {
+    abstract init(...args: any[]): Promise<this>;
+}

package/packages/web-sdk/packages/homag-intelligence/src/util.d.ts

@@ -0,0 +1,5 @@
+type Logable = string | number | boolean | object | null | undefined;
+export declare const logApiCallback: (...args: Logable[]) => void;
+export declare const logMessage: (...args: Logable[]) => void;
+export declare const logApiCall: (...args: Logable[]) => void;
+export {};

package/packages/web-sdk/packages/material-viewer/src/material-viewer.d.ts

@@ -7,7 +7,7 @@ export declare class MaterialViewer extends Main {
     protected setupDependencies(): void;
     protected cleanUpGlobals(): void;
     protected cleanUpDependencies(): void;
-    protected bootFinished(): void;
+    protected bootFinished(): Promise<void>;
     getApi(): RoomleMaterialViewer;
     protected getContextName(): string;
 }

package/packages/web-sdk/packages/planner-core/src/planner.d.ts

@@ -10,7 +10,7 @@ export declare class Planner<P extends readonly PluginName[] = readonly []> exte
     protected setupDependencies(): void;
     protected cleanUpGlobals(): void;
     protected cleanUpDependencies(): void;
-    protected bootFinished(): void;
+    protected bootFinished(): Promise<void>;
     getApi(): RoomlePlanner<P>;
     protected getContextName(): string;
 }

package/packages/web-sdk/packages/planner-core/src/roomle-planner.d.ts

@@ -1,3 +1,4 @@
+import { default as RapiAccess } from '../../common-core/src/rapi-access';
 import { default as RoomlePlannerUiCallback } from './roomle-planner-ui-callback';
 import { GlbViewer } from '../../glb-viewer-core/src/glb-viewer';
 import { ExternalEmbeddable, GlobalAPI, KernelUtilityForUi, RubensAPI, default as Main } from '../../common-core/src/main';
@@ -26,6 +27,7 @@ import { ExternalGroupData, ExternalObject, ExtObjId } from '../../typings/exter
 import { PluginName } from '../../configurator-core/src/utils/plugin-types';
 import { Nullable } from '../../typings/helper';
 import { MaybePromise } from '../../common-core/src/utils/common-utils';
+import { HomagIntelligence } from '../../homag-intelligence/src/homag-intelligence';
 
 export type ID_TYPE = 'rml_id' | 'tc_id' | 'rml_serialized' | 'tc_serialized';
 export declare const EXT_OBJ_EXCEPTION = "Could not retrieve configuration for external object! Did you implement onGetConfigurationForExternalObject?";
@@ -75,9 +77,9 @@ export interface InsertItemResult {
 export default class RoomlePlanner<P extends readonly PluginName[] = readonly []> implements KernelAccessCallbackI, RoomlePlannerCallback, GlobalAPI, Context, KernelUtilityForUi, ExternalEmbeddable<RoomlePlannerUiCallback>, RubensAPI, ExternalObjectAPI {
     _creator_: string;
     private _activePlugins;
+    private _homagIntelligence;
     private _configuratorContext;
     private _domHelper;
-    private _scriptLoader;
     private _kernelAccessCallback;
     private _plannerKernelAccess;
     private _rapiAccess;
@@ -263,6 +265,11 @@ export default class RoomlePlanner<P extends readonly PluginName[] = readonly []
     disableMultiselect(): void;
     private _insertExternalObject;
     dragInObject(idOrSerializedConfigString: string, dragEvent: DragEvent, type?: ID_TYPE): Promise<RuntimeId>;
+    /**
+     * Will remove an element that was dragged into the scene while still dragging it.
+     * This is mainly used in the context of pressing ESC while dragging or dragging the element away from the scene again.
+     */
+    cancelDragIn(): void;
     /**
      * enable snapping of object to object and object to wall
      */
@@ -513,4 +520,9 @@ export default class RoomlePlanner<P extends readonly PluginName[] = readonly []
      * only possible if undo was called before
      */
     redo(): Promise<void>;
+    setHomagIntelligence(homagIntelligence: HomagIntelligence): void;
+    newPosDataFromId(id: string): any;
+    sendToOM(withPrice?: boolean): Promise<void>;
+    fetchPrice(planId?: string): Promise<any>;
+    getRapiAccess(): RapiAccess;
 }

package/packages/web-sdk/packages/planner-core/src/webgl/planner-scene-manager.d.ts

@@ -184,6 +184,7 @@ export default class PlannerSceneManager extends ConfiguratorSceneManager implem
     enableWallDrawing(): void;
     disableWallDrawing(): void;
     escapeDrawing(cancelDrawing: boolean): void;
+    cancelDragIn(): void;
     setSceneEvents(sceneEvents: SceneEvents): void;
     /**
      * called by kernel

package/packages/web-sdk/packages/test-helpers/unit/global-setup.d.ts

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

package/packages/web-sdk/packages/tools-core/src/tools-core.d.ts

@@ -7,7 +7,7 @@ export declare class ToolsCore extends Main {
     protected setupDependencies(): void;
     protected cleanUpGlobals(): void;
     protected cleanUpDependencies(): void;
-    protected bootFinished(): void;
+    protected bootFinished(): Promise<void>;
     getApi(): RoomleToolsCore;
     protected getContextName(): string;
 }

package/packages/web-sdk/packages/typings/external-objects.d.ts

@@ -1,4 +1,6 @@
 import { RapiItem, RapiConfigurationEnhanced, Element, RapiTag } from './rapi-types';
+import { default as RoomlePlanner } from '../planner-core/src/roomle-planner';
+import { default as RoomleConfigurator } from '../configurator-core/src/roomle-configurator';
 
 export declare const EXTERNAL_ID_PREFIX = "__ext__obj__#";
 export type ExtObjId = `${typeof EXTERNAL_ID_PREFIX}${string}`;
@@ -17,4 +19,10 @@ export type ExternalTag = Partial<RapiTag> & Pick<RapiTag, 'label'> & {
     id: ExtObjId;
 };
 export type ExternalGroupData = object | string | string[];
+export type RoomlePlannerWithExtObjs = RoomlePlanner<['external-objects']>;
+export type RoomlePlannerType = RoomlePlanner | RoomlePlannerWithExtObjs;
+export type RoomleConfiguratorWithExtObjs = RoomleConfigurator<[
+    'external-objects'
+]>;
+export type RoomleConfiguratorType = RoomleConfigurator | RoomleConfiguratorWithExtObjs;
 export {};

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

@@ -284,7 +284,7 @@ export interface KernelObjectConfiguration {
     serializedDefinition: string;
     uniqueId: string;
 }
-declare class KernelObjectConfigurationArray extends EmsArray<KernelObjectConfiguration> {
+export declare class KernelObjectConfigurationArray extends EmsArray<KernelObjectConfiguration> {
 }
 export interface LightSourceConfiguration {
     lightSourceAreaInSquareMeters: number;

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

@@ -1,2 +1,4 @@
-export { default as ASSET_LOADER_FILE_NAME } from '../../generated/asset-loader.worker.js?url';
-export { default as BUDGETEER_FILE_NAME } from '../../generated/budgeteer.sw.js?url';
+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 };