@neurodyn/react-model-viewer 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -3,15 +3,33 @@ import { JSX } from 'react/jsx-runtime';
 import type { default as React_2 } from 'react';
 import * as React_3 from 'react';
 
+/** What the host needs to open its own AR experience for the shown model. */
+export declare interface ArLaunchTarget {
+    /** Material collection currently shown, which may differ from the entry url. */
+    hid?: string;
+    tinuuid: string;
+}
+
 declare type DialogProps = React_3.ComponentProps<typeof DialogPrimitive.Root>
 
-export declare function ModelViewer({ tinuuid, apiKey, hid, layout, background, className, ...props }: ModelViewerProps & React_2.ComponentProps<'div'>): JSX.Element;
+/**
+ * Lets the host open its own AR experience instead of the native one.
+ *
+ * Returning `true` means the host took the launch over: the viewer then skips
+ * both the native handoff and its own `ar_launched`, so one tap stays one
+ * event. Anything else falls through to the usual behaviour.
+ */
+export declare type LaunchArOverride = (target: ArLaunchTarget) => boolean | Promise<boolean>;
+
+export declare function ModelViewer({ tinuuid, apiKey, appClipBundleId, arExperience, hid, apiBaseUrl, legacyApiBaseUrl, mode, initialWidgetSessionToken, handoffUrl, launchAr, sizeType, layout, background, viewerSurface, className, ...props }: ModelViewerProps & React_2.ComponentProps<'div'>): JSX.Element;
+
+export declare type ModelViewerArExperience = 'advanced' | 'standard';
 
 declare type ModelViewerBackground = 'default' | 'transparent';
 
-export declare function ModelViewerDialog({ tinuuid, apiKey, hid, ...props }: ModelViewerDialogProps): JSX.Element;
+export declare function ModelViewerDialog({ tinuuid, apiKey, apiBaseUrl, legacyApiBaseUrl, initialWidgetSessionToken, handoffUrl, hid, sizeType, ...props }: ModelViewerDialogProps): JSX.Element;
 
-declare interface ModelViewerDialogProps extends Pick<ModelViewerRootProps, 'tinuuid' | 'apiKey' | 'hid'>, Omit<DialogProps, 'children'> {
+declare interface ModelViewerDialogProps extends Pick<ModelViewerRootProps, 'apiBaseUrl' | 'apiKey' | 'handoffUrl' | 'hid' | 'initialWidgetSessionToken' | 'legacyApiBaseUrl' | 'sizeType' | 'tinuuid'>, Omit<DialogProps, 'children'> {
 }
 
 declare type ModelViewerLayout = 'default' | 'model';
@@ -22,16 +40,42 @@ export declare interface ModelViewerProps extends Omit<ModelViewerRootProps, 'sh
 declare interface ModelViewerRootProps {
     /** The unique identifier of a Vizbl object. */
     tinuuid: string;
-    /** Public API key. */
-    apiKey: string;
+    /** Public API key. Without it, the viewer uses the legacy `/obj/Fetch` API. */
+    apiKey?: string | null;
+    /** App Clip bundle used by automatic Advanced AR handoffs. */
+    appClipBundleId?: string;
+    /** Standard or Advanced launch behavior for the shared QR backend mode. */
+    arExperience?: ModelViewerArExperience;
     /** The identifier of a material variant. */
     hid?: string | null;
+    /** Node Public API base URL. */
+    apiBaseUrl?: string;
+    /** Legacy Go API base URL used only when `apiKey` is missing. */
+    legacyApiBaseUrl?: string;
+    /** Widget integration mode recorded by the backend session. */
+    mode?: ModelViewerWidgetMode;
+    /** Existing token used to preserve the same widget session across a handoff. */
+    initialWidgetSessionToken?: string;
+    /** Hosted viewer URL encoded into the desktop-to-mobile QR handoff. */
+    handoffUrl?: string;
+    /** Lets the host open its own AR experience instead of the native handoff. */
+    launchAr?: LaunchArOverride;
+    /** Display unit for model dimensions. */
+    sizeType?: SizeType;
     /** Controls which viewer UI elements are shown. */
     layout?: ModelViewerLayout;
     /** Controls the viewer container background. */
     background?: ModelViewerBackground;
     /** Enables dialog-only close controls. */
     showDialogCloseButton?: boolean;
+    /** Controls open-event semantics for inline, dialog, and hosted-page viewers. */
+    viewerSurface?: ModelViewerSurface;
 }
 
+declare type ModelViewerSurface = 'dialog' | 'inline' | 'page';
+
+export declare type ModelViewerWidgetMode = 'advanced-ar-view' | 'ar-view' | 'embedded-3d-viewer' | 'ar-viewer' | 'qr-code';
+
+declare type SizeType = 'cm' | 'inch';
+
 export { }