@neurodyn/react-room-viewer 0.0.5 → 0.0.7

package/dist/index.d.ts

@@ -5,6 +5,31 @@ import * as React_3 from 'react';
 
 declare type DialogProps = React_3.ComponentProps<typeof DialogPrimitive.Root>
 
+declare type IssueWidgetToken = (data: {
+    token?: string;
+}, config?: WidgetSessionApiConfig) => Promise<IssueWidgetTokenResponseDtoOutput>;
+
+/**
+ * Generated by Kubb (https://kubb.dev/).
+ * Do not edit manually.
+ */
+declare type IssueWidgetTokenResponseDtoOutput = {
+    /**
+     * @type string
+     */
+    token: string;
+    /**
+     * @type string
+     */
+    sid: string;
+    /**
+     * @minLength -9007199254740991
+     * @maxLength 9007199254740991
+     * @type integer
+     */
+    expiresIn: number;
+};
+
 declare const resources: {
     en: {
         translation: {
@@ -26,10 +51,17 @@ declare const resources: {
             readonly ar: {
                 readonly viewInPlace: "View in place";
                 readonly scanQrCode: "Scan this QR code with your phone's camera to view the object in Augmented Reality";
+                readonly deviceRequirementsDisclaimer: "*Requires AR-supported device and browser. We recommend iOS 12 or later with Safari, or Android 7.0 or later with Chrome.";
+            };
+            readonly legal: {
+                readonly termsOfUse: "Terms of Use";
+                readonly conjunction: "and";
+                readonly privacyPolicy: "Privacy Policy";
             };
             readonly shareMessage: {
-                readonly poster: "Preview poster";
-                readonly carpet: "Preview carpet";
+                readonly wallart: "Preview wall art";
+                readonly rugs: "Preview rug";
+                readonly flooring: "Preview flooring";
             };
             readonly rooms: {
                 readonly 'room-example-11': "Room Example 11";
@@ -54,6 +86,62 @@ declare const resources: {
                 readonly unauthorized: "Invalid API key";
                 readonly 'payment-required': "Viewer temporarily unavailable";
             };
+            readonly resourceType: {
+                readonly rugs: {
+                    readonly productCategory: "Rug";
+                    readonly productCardTitle: "Selected rug";
+                    readonly replaceProduct: "Replace rug";
+                    readonly replaceProductShort: "Replace";
+                };
+                readonly flooring: {
+                    readonly productCategory: "Flooring";
+                    readonly productCardTitle: "Selected flooring";
+                    readonly replaceProduct: "Replace flooring";
+                    readonly replaceProductShort: "Replace";
+                };
+            };
+            readonly floor: {
+                readonly scene: {
+                    readonly companyFallback: "Company name";
+                    readonly share: "Share";
+                    readonly download: "Download";
+                    readonly hideCatalog: "Hide catalog";
+                    readonly interiorCardTitle: "Interior";
+                    readonly tryAtHome: "Try at home";
+                    readonly tryAtHomeBody: "Through your phone camera";
+                };
+                readonly materialSelection: {
+                    readonly title: "Material Selection";
+                };
+                readonly interiorSelection: {
+                    readonly title: "Choose interior";
+                    readonly uploadPhoto: "Upload your photo";
+                    readonly invalidFile: "Could not upload photo, please try again";
+                    readonly customTitle: "Your photos";
+                    readonly presetsTitle: "Preset interiors";
+                    readonly currentInterior: "Current interior";
+                    readonly chooseInterior: "Choose interior";
+                    readonly chooseInteriorShort: "Choose";
+                };
+                readonly processing: {
+                    readonly title: "Preparing your room";
+                    readonly progressLabel: "Room preparation progress";
+                    readonly stages: {
+                        readonly reading: "Reading your photo...";
+                        readonly mapping: "Finding floors and walls...";
+                        readonly lighting: "Balancing light and perspective...";
+                        readonly finalizing: "Building your preview...";
+                        readonly ready: "Room is ready...";
+                    };
+                };
+                readonly error: {
+                    readonly title: "Something went wrong";
+                    readonly processingBody: "This time we could not upload and process the photo";
+                    readonly loadBody: "We could not load the viewer. Please try again.";
+                    readonly tryAgain: "Try again";
+                    readonly cancel: "Cancel";
+                };
+            };
         };
     };
     ru: {
@@ -76,10 +164,17 @@ declare const resources: {
             readonly ar: {
                 readonly viewInPlace: "Примерить в комнате";
                 readonly scanQrCode: "Отсканируйте этот QR-код камерой телефона, чтобы просмотреть объект в дополненной реальности";
+                readonly deviceRequirementsDisclaimer: "*Требуется устройство и браузер с поддержкой AR. Рекомендуем iOS 12 или новее с Safari либо Android 7.0 или новее с Chrome.";
+            };
+            readonly legal: {
+                readonly termsOfUse: "Условия использования";
+                readonly conjunction: "и";
+                readonly privacyPolicy: "Политика конфиденциальности";
             };
             readonly shareMessage: {
-                readonly poster: "Примерить постер";
-                readonly carpet: "Примерить ковер";
+                readonly wallart: "Примерить настенный декор";
+                readonly rugs: "Примерить ковер";
+                readonly flooring: "Примерить напольное покрытие";
             };
             readonly rooms: {
                 readonly 'room-example-11': "Пример комнаты 11";
@@ -104,15 +199,71 @@ declare const resources: {
                 readonly unauthorized: "Неверный API-ключ";
                 readonly 'payment-required': "Просмотр временно недоступен";
             };
+            readonly resourceType: {
+                readonly rugs: {
+                    readonly productCategory: "Ковер";
+                    readonly productCardTitle: "Выбранный ковер";
+                    readonly replaceProduct: "Заменить ковер";
+                    readonly replaceProductShort: "Заменить";
+                };
+                readonly flooring: {
+                    readonly productCategory: "Напольное покрытие";
+                    readonly productCardTitle: "Выбранное напольное покрытие";
+                    readonly replaceProduct: "Заменить";
+                    readonly replaceProductShort: "Заменить";
+                };
+            };
+            readonly floor: {
+                readonly scene: {
+                    readonly companyFallback: "Компания";
+                    readonly share: "Поделиться";
+                    readonly download: "Скачать";
+                    readonly hideCatalog: "Скрыть каталог";
+                    readonly interiorCardTitle: "Интерьер";
+                    readonly tryAtHome: "Примерить дома";
+                    readonly tryAtHomeBody: "Через камеру телефона";
+                };
+                readonly materialSelection: {
+                    readonly title: "Выбор материала";
+                };
+                readonly interiorSelection: {
+                    readonly title: "Выберите интерьер";
+                    readonly uploadPhoto: "Загрузить свое фото";
+                    readonly invalidFile: "Не получилось загрузить фото, попробуйте еще раз";
+                    readonly customTitle: "Ваши фото";
+                    readonly presetsTitle: "Готовые интерьеры";
+                    readonly currentInterior: "Текущий интерьер";
+                    readonly chooseInterior: "Выбрать интерьер";
+                    readonly chooseInteriorShort: "Выбрать";
+                };
+                readonly processing: {
+                    readonly title: "Готовим вашу комнату";
+                    readonly progressLabel: "Прогресс подготовки комнаты";
+                    readonly stages: {
+                        readonly reading: "Читаем ваше фото...";
+                        readonly mapping: "Ищем пол и стены...";
+                        readonly lighting: "Настраиваем свет и перспективу...";
+                        readonly finalizing: "Собираем превью...";
+                        readonly ready: "Комната готова...";
+                    };
+                };
+                readonly error: {
+                    readonly title: "Что-то пошло не так";
+                    readonly processingBody: "В этот раз не получилось загрузить обработать фотографию";
+                    readonly loadBody: "Не удалось загрузить просмотр. Попробуйте снова.";
+                    readonly tryAgain: "Попробовать еще раз";
+                    readonly cancel: "Отменить";
+                };
+            };
         };
     };
 };
 
-export declare function RoomViewer({ type, src, tinuuid, name, language, width, height, dimensionUnit, displayUnit, rooms, apiKey, source, className, ...props }: RoomViewerProps & React_2.ComponentProps<'div'>): JSX.Element;
+export declare function RoomViewer({ type, src, tinuuid, name, language, width, height, dimensionUnit, displayUnit, apiKey, source, widgetSession, className, ...props }: RoomViewerProps & React_2.ComponentProps<'div'>): JSX.Element;
 
-export declare function RoomViewerDialog({ type, src, tinuuid, width, height, dimensionUnit, displayUnit, name, language, rooms, apiKey, source, ...props }: RoomViewerDialogProps): JSX.Element;
+export declare function RoomViewerDialog({ type, src, tinuuid, width, height, dimensionUnit, displayUnit, name, language, apiKey, source, widgetSession, open, defaultOpen, onOpenChange, ...props }: RoomViewerDialogProps): JSX.Element;
 
-declare interface RoomViewerDialogProps extends Omit<RoomViewerRootProps, 'showDialogCloseButton'>, Omit<DialogProps, 'children' | 'modal'> {
+declare interface RoomViewerDialogProps extends Omit<RoomViewerRootProps, 'showDialogCloseButton' | 'viewerSurface' | 'dialogPortalContainer' | 'viewerDialogOpen' | 'onViewerDialogOpenChange'>, Omit<DialogProps, 'children' | 'modal'> {
     /** The controlled open state of the dialog. */
     open?: boolean;
     /** The open state of the dialog when it is initially rendered. */
@@ -127,16 +278,27 @@ export declare type RoomViewerDisplayUnit = 'cm' | 'in';
 
 declare type RoomViewerLanguage = keyof typeof resources;
 
+/**
+ * Legacy Resource Type values kept working as deprecated aliases.
+ *
+ * @deprecated Use canonical Resource Type values instead: `poster` → `wallart`,
+ * `carpet` → `rugs`.
+ */
+export declare type RoomViewerLegacyResourceType = 'poster' | 'carpet';
+
 export declare type RoomViewerPlaneKind = 'floor' | 'wall' | 'ceiling';
 
-export declare interface RoomViewerProps extends Omit<RoomViewerRootProps, 'showDialogCloseButton'> {
+export declare interface RoomViewerProps extends Omit<RoomViewerRootProps, 'showDialogCloseButton' | 'viewerSurface'> {
 }
 
-declare type RoomViewerResourceCarpet = 'carpet';
+/**
+ * Canonical Resource Type values. Internal code only ever sees these — legacy
+ * inputs are normalized to canonical at the viewer entry.
+ */
+export declare type RoomViewerResourceType = 'wallart' | 'rugs' | 'flooring';
 
-declare type RoomViewerResourcePoster = 'poster';
-
-declare type RoomViewerResourceType = RoomViewerResourcePoster | RoomViewerResourceCarpet;
+/** Resource Type values accepted at the public boundary (canonical ∪ legacy). */
+export declare type RoomViewerResourceTypeInput = RoomViewerResourceType | RoomViewerLegacyResourceType;
 
 export declare interface RoomViewerRoom {
     id: string;
@@ -146,11 +308,18 @@ export declare interface RoomViewerRoom {
 }
 
 declare interface RoomViewerRootProps {
-    /** Resource display mode. */
-    type: RoomViewerResourceType;
-    /** Poster image URL. Used when `type` is `poster`. */
+    /**
+     * Resource Type. Canonical values are `wallart`, `rugs`, and `flooring`.
+     *
+     * @remarks
+     * `poster` and `carpet` are accepted as deprecated aliases (`poster` →
+     * `wallart`, `carpet` → `rugs`) and still work unchanged, but emit a
+     * development-only console warning. Migrate to the canonical values.
+     */
+    type: RoomViewerResourceTypeInput;
+    /** Wall-art image URL. Used for wall products (`wallart`). */
     src?: string;
-    /** The object's tinuuid. Used when `type` is `carpet`. */
+    /** The object's tinuuid. Used for floor products (`rugs`, `flooring`). */
     tinuuid?: string;
     /** Title shown in the dialog header. */
     name: string;
@@ -160,12 +329,12 @@ declare interface RoomViewerRootProps {
      * @defaultValue User locale.
      */
     language?: RoomViewerLanguage;
-    /** Poster width. Used when `type` is `poster`. */
+    /** Wall-art width. Used for wall products (`wallart`). */
     width?: number;
-    /** Poster height. Used when `type` is `poster`. */
+    /** Wall-art height. Used for wall products (`wallart`). */
     height?: number;
     /**
-     * Unit used by the poster width and height.
+     * Unit used by the wall-art width and height.
      *
      * @defaultValue 'm'
      */
@@ -176,7 +345,6 @@ declare interface RoomViewerRootProps {
      * @defaultValue 'cm'
      */
     displayUnit?: RoomViewerDisplayUnit;
-    rooms?: RoomViewerRoom[];
     /**
      * API key used by Public API requests.
      */
@@ -189,6 +357,16 @@ declare interface RoomViewerRootProps {
     source?: RoomViewerSource;
     /** Enables dialog-only close controls. */
     showDialogCloseButton?: boolean;
+    /** Internal surface boundary for dialog and Inline QR entry behavior. */
+    viewerSurface?: RoomViewerSurface;
+    /** Internal portal container for dialog-surface floor flow dialogs. */
+    dialogPortalContainer?: HTMLDivElement | null;
+    /** Internal controlled open state for dialog-surface floor flow. */
+    viewerDialogOpen?: boolean;
+    /** Internal controlled open-state handler for dialog-surface floor flow. */
+    onViewerDialogOpenChange?: (open: boolean) => void;
+    /** Existing Widget Session from an embedding surface such as Shopify activation. */
+    widgetSession?: WidgetSessionActivationData | WidgetSessionClient | null;
 }
 
 export declare interface RoomViewerScene {
@@ -239,4 +417,53 @@ export declare interface RoomViewerSceneShading {
 
 declare type RoomViewerSource = 'default' | 'shopify';
 
+declare type RoomViewerSurface = 'dialog' | 'inline';
+
+declare const WIDGET_SESSION_TOKEN_HEADER = "x-widget-session-token";
+
+export declare interface WidgetSessionActivationData {
+    token: string;
+    sid: string;
+    expiresIn: number;
+}
+
+declare interface WidgetSessionApiConfig {
+    baseURL?: string;
+    headers?: Record<string, string | undefined>;
+    signal?: AbortSignal;
+}
+
+declare class WidgetSessionClient {
+    private apiConfig;
+    private issueWidgetToken;
+    private now;
+    private refreshPromise;
+    private refreshThresholdMs;
+    private session;
+    constructor(activationData: WidgetSessionActivationData, options?: WidgetSessionClientOptions);
+    get snapshot(): WidgetSessionSnapshot;
+    get token(): string;
+    get sid(): string;
+    get expiresAt(): number;
+    isCloseToExpiry(): boolean;
+    getTokenForRequest(): Promise<string>;
+    getHeadersForRequest(): Promise<Record<typeof WIDGET_SESSION_TOKEN_HEADER, string>>;
+    getApiConfigForRequest(apiConfig?: WidgetSessionApiConfig): Promise<WidgetSessionApiConfig>;
+    private refresh;
+    private toSnapshot;
+}
+
+declare interface WidgetSessionClientOptions {
+    apiConfig?: WidgetSessionApiConfig;
+    issueWidgetToken?: IssueWidgetToken;
+    now?: () => number;
+    refreshThresholdMs?: number;
+}
+
+declare interface WidgetSessionSnapshot {
+    token: string;
+    sid: string;
+    expiresAt: number;
+}
+
 export { }