@variantic/player 0.0.24 → 0.0.26

package/libs/schemas/web-component/api/player/viewer/src/lib/viewer.d.ts

@@ -1,471 +0,0 @@
-import type Emittery from 'emittery';
-import type { TSettings } from '@variantic/schemas/engine';
-import type { TTimestampEventPayload, TWebComponentEvents, TMouseClickedPayload, TMouseMovedPayload } from '@variantic/schemas/web-component-apis/player/events';
-/**
- * @category Addons API
- */
-export type TViewerApi = {
-    events: Emittery<TViewerApiEvents>;
-    getPlayerInstance(): any;
-    get isLoaded(): boolean;
-    /**
-     * Returns the current configuration formatted for rendering.
-     */
-    getConfiguration(options?: TGetConfigurationParams): TConfiguration | null;
-    /**
-     *  Returns the current price value.
-     */
-    getPrice(): number;
-    /**
-     *  Returns the current price formatted with set rounding settings.
-     */
-    getRoundedPrice(): number;
-    /**
-     * Returns the current price formatted with the appropriate currency symbol.
-     */
-    getPriceWithCurrency(): string | undefined;
-    /**
-     * Overrides the current price with the specified value.
-     *
-     * @param value value to replace price with
-     */
-    setPrice(value: number | string): void;
-    /**
-     * If enabled, returns price components calculated based on the selected pricing rule. Otherwise, returns null.
-     */
-    getPricing(): TPricingData | null;
-    /** @ignore */
-    getScene(): any;
-    /** @ignore */
-    getModel3D(): any;
-    /** @ignore */
-    getModelContainer3D(): any;
-    /**
-     * Returns the WebGL canvas element.
-     */
-    getCanvas(): HTMLCanvasElement;
-    /**
-     * Returns all available material groups.
-     */
-    getMaterialGroups(): Promise<TMaterialGroup[]>;
-    /**
-     * Returns a mapping of group IDs to their selected material IDs.
-     */
-    getSelectedMaterialByGroup(): {
-        [key: number]: number;
-    };
-    /**
-     * Returns the material definition for the specified material ID.
-     */
-    getMaterialDataById(materialId: number): TMaterial;
-    /**
-     * Returns a list of materials matching the given filter ID, optionally grouped by the specified query ID.
-     */
-    getMaterialsList({ filterId, groupingQueryId, page, perPage, searchPhrase, searchProps, }: TGetMaterialsListParams): Promise<TMaterialsList>;
-    getMaterialsList(filterId: number, groupingQueryId?: number, page?: number, perPage?: number): Promise<TMaterialsList>;
-    /**
-     * Returns the current layout settings configuration.
-     */
-    getLayoutSettings(): TLayoutSettings;
-    /**
-     * Assigns the specified material ID to the given group ID.
-     */
-    assignMaterial(groupId: number, materialId: number): Promise<void>;
-    /**
-     * Assigns the specified material ID to the given group ID.
-     */
-    assignMaterials(materials: Record<string, number>): Promise<void>;
-    /**
-     * Changes the camera projection type to either orthographic or perspective.
-     */
-    changeCameraType(type: 'orthographic' | 'perspective'): void;
-    /**
-     * Applies the specified camera settings.
-     */
-    setCameraSettings(settings: TCameraSettings): void;
-    /**
-     * Applies a subset of viewer settings without reloading the whole player.
-     */
-    applySettings(settings: Partial<TSettings>): Promise<void>;
-    /**
-     * Moves the camera based on the provided parameters.
-     */
-    moveCamera(params: TMoveCameraParams): Promise<void>;
-    /**
-     * Adjusts the camera to fit the current object within view.
-     */
-    autoFitCamera(): Promise<void>;
-    /**
-     * Generates a bill of materials for the specified template ID and filter ID.
-     */
-    generateBom({ templateId, filterId, }: {
-        templateId: number;
-        filterId: number;
-    }): Promise<TBom>;
-    /**
-     * Returns the current floor settings.
-     */
-    getSetFloorSettings(): TFloorSettings;
-    /**
-     * Returns the target unit for value transformation.
-     */
-    getTargetUnit(): string;
-    /**
-     * Returns the list of available units.
-     */
-    getUnits(): TUnit[];
-    /** @ignore */
-    getDimensions(filter?: 'default' | 'defaultNotControlledByEvent'): any[];
-    /**
-     * Changes the current unit to the specified unit.
-     */
-    changeUnit(unit: string): void;
-    /**
-     * Converts a value from millimeters to the current set target unit.
-     */
-    convertFromMillimeters(value: number | string, baseUnit: string): number | string;
-    /**
-     * Converts a value from the current set target unit to millimeters.
-     */
-    convertToMillimeters(value: number | string, baseUnit: string): number | string;
-    /**
-     * Returns the localized string for the given key
-     */
-    translate(key: string): string;
-    /**
-     * Switches the interface view to either preview or edit mode.
-     */
-    changeView(view: 'preview' | 'edit'): void;
-    /**
-     * Updates the parameter identified by the code with the specified value.
-     */
-    changeParameter(code: string, value: string | number): Promise<void>;
-    /**
-     * Updates multiple parameters in a single call.
-     */
-    changeParameters(parameters: Record<string, string | number>): Promise<void>;
-    /**
-     * Normalizes the given value for a parameter, returning the value and its corresponding label.
-     */
-    normalizeParameterValue(parameter: TParameter, value: string | number): {
-        value: string | number;
-        label: string;
-    };
-    /**
-     * Enables all layers in the current context.
-     */
-    enableAllLayers(): void;
-    /**
-     * Disables all layers in the current context.
-     */
-    disableAllLayers(): void;
-    /**
-     * Enables the layer with the specified ID.
-     */
-    enableLayer(id: number): void;
-    /**
-     * Disables the layer with the specified ID.
-     */
-    disableLayer(id: number): void;
-    /**
-     * Toggles dimension visibility based on the state and optional dimension IDs or presets.
-     */
-    toggleDimensions(state: boolean, dimensions?: number[] | 'default' | 'defaultNotControlledByEvent'): void;
-    /**
-     * Loads preset with given ID and reloads the viewer
-     */
-    loadPreset(id: string | TPreset): Promise<void>;
-};
-export type TViewerApiEvents = TWebComponentEvents<{
-    loaded: TTimestampEventPayload;
-    reloaded: TTimestampEventPayload;
-    reloadedAfterLoad: TTimestampEventPayload;
-    configurationUpdating: TTimestampEventPayload;
-    sceneReloaded: TTimestampEventPayload;
-    configurationUpdated: TConfiguration;
-    priceChanged: {
-        price: number;
-        priceWithCurrency: string;
-    };
-    bomGenerated: {
-        templateId: number;
-        filterId: number;
-        bom: TBom;
-    };
-    materialAssigned: {
-        groupId: number;
-        materialId: number;
-    };
-    materialAssignedAfterLoad: {
-        groupId: number;
-        materialId: number;
-    };
-    mouseClicked: TMouseClickedPayload;
-    mouseMoved: TMouseMovedPayload;
-    dimensionToggled: {
-        state: boolean;
-    };
-}>;
-export type TGetMaterialsListParams = {
-    filterId: number;
-    groupingQueryId?: number;
-    page?: number;
-    perPage?: number;
-    searchPhrase?: string;
-    searchProps?: TMaterialSearchProp[];
-    langCode?: string;
-};
-export type TMaterialSearchProp = 'name' | 'code';
-export type TGetConfigurationParams = {
-    /**
-     * Specifies whether to include hidden items
-     * @defaultValue `true`
-     */
-    includeHidden?: boolean;
-};
-export type TMoveCameraParams = {
-    /**
-     * Target camera angle
-     * @defaultValue `default`
-     */
-    angle?: TCameraAngle;
-    /**
-     * Whether to move with animation
-     * @defaultValue `true`
-     */
-    animation?: boolean;
-};
-export type TCameraAngle = 'default' | '-x+z' | '+x+z' | '-x-z' | '+x-z' | '+z' | '-z' | '+y' | '-y' | '+x' | '-x';
-export type TMaterial = {
-    id: number;
-    name: string;
-    code: string;
-    price: number;
-    group: string;
-    type: string;
-    mass: number;
-    mass_unit: string;
-    dim_x: number;
-    dim_y: number;
-    dim_z: number;
-    dim_unit: string;
-    data_1: string;
-    data_2: string;
-    data_3: string;
-    data_4: string;
-    url: string;
-    photo: string;
-    enabled: boolean;
-    grain: boolean;
-};
-export type TMeta = {
-    totalItems: number;
-    itemCount: number;
-    itemsPerPage: number;
-    totalPages: number;
-    currentPage: number;
-};
-export type TMaterialsList = {
-    items: TMaterial[];
-    meta: TMeta;
-};
-export type TLayoutSettings = {
-    colors: {
-        primaryColor: string;
-        secondaryColor: string;
-    };
-    defaultConfigurationMode: 'configuration' | 'materials';
-};
-export type TFilterGroupingQuery = {
-    name: string;
-    default: boolean;
-};
-export type TFilter = {
-    name: string;
-    id: number;
-    groupingQueries: TFilterGroupingQuery[];
-};
-export type TMaterialGroup = {
-    id: number;
-    name: string;
-    filterData: TFilter;
-    filters: TFilter[];
-    showType: string;
-};
-export type TBom = {
-    name: string;
-    head: string[];
-    body: string[][];
-};
-export type TCameraSettings = {
-    autoCameraFit?: boolean;
-    fitAngle?: TCameraAngle;
-    cameraFitToSelected?: boolean;
-    cameraSnapToAngle?: boolean;
-    cameraType?: 'orthographic' | 'perspective';
-    enablePan?: boolean;
-    enableRotate?: boolean;
-    blockRotationAxes?: {
-        x?: boolean;
-        y?: boolean;
-        z?: boolean;
-    };
-    blockMoveUnderFloor?: boolean;
-    zoomBoundaries?: {
-        max?: number;
-        min?: number;
-    };
-    rotateBoundaries?: {
-        x?: {
-            min?: number;
-            max?: number;
-        };
-        y?: {
-            min?: number;
-            max?: number;
-        };
-    };
-    enableCameraOptimization?: boolean;
-    enableAutoRotate?: boolean;
-    autoRotateActivationTime?: number;
-    autoRotateSpeed?: number;
-    infinityRotationAxes?: {
-        x?: boolean;
-        y?: boolean;
-    };
-    isCameraSet?: boolean;
-    defaultFar?: boolean;
-};
-export type TFloorSettings = {
-    activeFloor: boolean;
-    activeFloorShadow: boolean;
-    useFloorInAR: boolean;
-    floorSize: {
-        x: number;
-        y: number;
-    };
-    floorSizeType: 'infinity' | 'likeObject' | 'custom';
-    selectedMaterialGroup: number | null;
-    selectedDefaultMaterial: number | null;
-};
-export type TUnit = {
-    unit: string;
-    label: string;
-};
-export type TParameterTypes = 'number-range' | 'number-predefined' | 'number-constant' | 'text-constant' | 'text-input' | 'boolean' | 'list-options' | 'list-buttons' | 'list-image-options' | 'list-image-buttons' | 'list-images' | 'button';
-export type TParameterEvents = {
-    [K in keyof GlobalEventHandlersEventMap]?: (event: GlobalEventHandlersEventMap[K]) => void;
-};
-export type TParameterBase<TType extends TParameterTypes = TParameterTypes, TSettings = undefined> = {
-    code: string;
-    name: string;
-    type: TType;
-    unit: string;
-    unitLabel: string;
-    value: string;
-    valueLabel: string;
-    settings: TSettings;
-    events?: TParameterEvents;
-    isHidden?: boolean;
-};
-export type TParameterNumberRange = TParameterBase<'number-range', {
-    min: number;
-    minLabel: string;
-    max: number;
-    maxLabel: string;
-    preferred?: number[];
-    step: number;
-}>;
-type TNumberPredefinedStyleSettings = {
-    align?: 'content' | 'responsive';
-};
-export type TParameterNumberPredefined = TParameterBase<'number-predefined', {
-    options: string[];
-    optionLabels: string[];
-    styleSettings?: TNumberPredefinedStyleSettings;
-}>;
-export type TParameterNumberConstant = TParameterBase<'number-constant'>;
-type TListStyleSettings = {
-    size?: 'sm' | 'md' | 'lg';
-    shape?: 'square' | 'portrait' | 'landscape';
-    align?: 'content' | 'responsive';
-};
-export type TParameterListOptions = TParameterBase<'list-options', {
-    defaultValue: string;
-    options: Record<string, string>;
-    optionsOrdered: {
-        key: string;
-        value: string;
-    }[];
-    styleSettings?: TListStyleSettings;
-}>;
-export type TParameterListButtons = TParameterBase<'list-buttons', {
-    defaultValue: string;
-    options: Record<string, string>;
-    optionsOrdered: {
-        key: string;
-        value: string;
-    }[];
-    styleSettings?: TListStyleSettings;
-}>;
-export type TParameterListImageOptions = TParameterBase<'list-image-options', {
-    defaultValue: string;
-    options: Record<string, string>;
-    optionsOrdered: {
-        key: string;
-        value: string;
-    }[];
-    optionsImages: Record<string, string>;
-    styleSettings?: TListStyleSettings;
-}>;
-export type TParameterListImageButtons = TParameterBase<'list-image-buttons', {
-    defaultValue: string;
-    options: Record<string, string>;
-    optionsOrdered: {
-        key: string;
-        value: string;
-    }[];
-    optionsImages: Record<string, string>;
-    styleSettings?: TListStyleSettings;
-}>;
-export type TParameterListImages = TParameterBase<'list-images', {
-    defaultValue: string | null;
-    options: Record<string, {
-        image: string | null;
-        label: string;
-    }>;
-}>;
-export type TParameterText = TParameterBase<'text-constant'>;
-export type TParameterTextInput = TParameterBase<'text-input', {
-    maxLength: number;
-    placeholder: string;
-}>;
-export type TParameterBoolean = TParameterBase<'boolean'>;
-export type TParameterButton = TParameterBase<'button'>;
-export type TParameter = TParameterNumberRange | TParameterNumberPredefined | TParameterNumberConstant | TParameterListOptions | TParameterListButtons | TParameterListImageOptions | TParameterListImageButtons | TParameterListImages | TParameterText | TParameterTextInput | TParameterBoolean | TParameterButton;
-export type TCategory = {
-    id: number;
-    name: string;
-    parameters: TParameter[];
-    isHidden?: boolean;
-};
-export type TConfiguration = {
-    categories: TCategory[];
-};
-export type TPricingSection = {
-    name: string;
-    table: string[][];
-    price: number;
-    priceColumnIndex: number;
-};
-export type TPricingData = {
-    finalPrice: number;
-    sections: TPricingSection[];
-};
-export type TPreset = {
-    id: string;
-    name: string;
-    configuration: any;
-    ignore?: string[];
-};
-export {};