@marketrix.ai/widget 3.8.142 → 3.8.144

package/dist/src/services/StorageService.d.ts

@@ -1,24 +1,12 @@
 /**
- * StorageService - Unified localStorage management for widget
+ * Unified widget localStorage under a single key (`marketrix_chat_context`): chat_id, messages, widget state, config.
  *
- * Consolidates all widget localStorage into a single key: marketrix_chat_context
- * Contains: chat_id, messages, widget state, and config
- *
- * **Canonical implementation.** This file is the source of truth for the
- * `StorageService` mirror pair. The matching `app/src/services/StorageService.ts`
- * in the dashboard repo should be byte-identical to this file (modulo its
- * own `'../types'` import path). When updating storage semantics, change
- * this file first and copy the result over to the app mirror.
- *
- * Why widget is canonical: the chat context object (chat_id, messages,
- * task progress, widget config) originates in the embeddable widget — the
- * widget owns the read/write lifecycle, and the dashboard only ever reads
- * the same shape for parity.
+ * **Canonical implementation** of the `StorageService` mirror pair — the widget owns the read/write
+ * lifecycle; `app/src/services/StorageService.ts` must stay byte-identical (modulo its `'../types'`
+ * import path). Change storage semantics here first, then copy over to the app mirror.
  */
 import type { ChatMessage, InstructionType, MarketrixConfig } from '../types';
-/**
- * Serializable version of ChatMessage (timestamp as string, no videoStream)
- */
+/** Serializable ChatMessage: timestamp as string, no videoStream. */
 type StoredMessage = Omit<ChatMessage, 'videoStream' | 'timestamp'> & {
     timestamp: string;
 };
@@ -34,12 +22,7 @@ export interface MarketrixChatContext {
     config: MarketrixConfig | null;
     timestamp: number;
 }
-/**
- * Singleton wrapper around `localStorage` for the unified widget chat context.
- *
- * Canonical implementation — see file header. Mirror in `app/src/services/StorageService.ts`
- * must be byte-identical (modulo the relative path of the `../types` import).
- */
+/** Singleton wrapper around `localStorage` for the unified widget chat context. Canonical — see file header. */
 declare class StorageService {
     private static instance;
     private context;
@@ -50,15 +33,9 @@ declare class StorageService {
     getContext(): MarketrixChatContext;
     updateContext(updates: Partial<MarketrixChatContext>): void;
     private isValidChatId;
-    /**
-     * Get chat_id with window.name fallback for cross-page navigation
-     * Priority: window.name (if valid) -> localStorage
-     */
+    /** window.name takes priority over localStorage — it persists across page navigations. */
     getChatId(): string | null;
-    /**
-     * Set chat_id in both localStorage and window.name.
-     * Dispatches a 'marketrix:chatid' event so other services (e.g. RrwebSessionRecorder) can react.
-     */
+    /** Dispatches a 'marketrix:chatid' event so other services (e.g. RrwebSessionRecorder) can react. */
     setChatId(chatId: string | null): void;
     getMessages(): StoredMessage[];
     setMessages(messages: StoredMessage[]): void;

package/dist/src/services/ValidationService.d.ts

@@ -7,18 +7,12 @@ export interface WidgetValidationResult {
     application?: ApplicationData;
 }
 /**
- * ValidationService
- *
- * Validates widget configuration by checking:
- * 1. Widget exists (via marketrix_id and marketrix_key) and its application exists, OR
- * 2. The application ID exists
+ * Validates widget config: either the widget (marketrix_id + marketrix_key) and its application exist,
+ * or the application id exists.
  */
 export declare class ValidationService {
     private config?;
-    /**
-     * Validate widget configuration
-     * Handles both mtxId+mtxKey and mtxApp cases
-     */
+    /** Handles both the mtxId+mtxKey and mtxApp cases. */
     validateConfig(config: MarketrixConfig): Promise<WidgetValidationResult>;
     private validateByMarketrixId;
     private validateByApplication;

package/dist/src/services/WidgetService.d.ts

@@ -4,15 +4,7 @@ export declare class WidgetService {
     private mtxKey?;
     private mtxApp?;
     constructor(mtxId?: string, mtxKey?: string, mtxApp?: number);
-    /**
-     * Fetch widget settings from the API
-     * Always returns default settings merged with existing widget settings if found
-     * Returns null if no credentials provided (for preview mode)
-     */
+    /** Default settings merged with the matched widget's settings; null with no credentials (preview mode). */
     widgetSettingsGet(): Promise<WidgetData | null>;
-    /**
-     * Get widget settings from widget data
-     * Settings are always objects (current API format)
-     */
     getWidgetSettings(widget: WidgetData): WidgetSettingsData | null;
 }

package/dist/src/test/a11y-utils.d.ts

@@ -1,6 +1 @@
-/**
- * Run axe-core on a container and assert no a11y violations.
- * Use in tests: await assertNoA11yViolations(container);
- * Color-contrast is disabled in jsdom (no canvas).
- */
 export declare function assertNoA11yViolations(container: Element): Promise<void>;

package/dist/src/test/fixtures.d.ts

@@ -1,6 +1,2 @@
 import type { MarketrixConfig } from '../types';
-/**
- * Minimal valid widget config for tests (satisfies WidgetSettingsDataSchema).
- * Use with WidgetProviders previewMode to avoid network calls.
- */
 export declare function getMockWidgetConfig(overrides?: Partial<MarketrixConfig>): MarketrixConfig;

package/dist/src/types/browserTools.d.ts

@@ -1,10 +1,3 @@
-/**
- * Browser Use Tools - widget tool registry.
- *
- * IMPORTANT: This file is the single source of truth for widget tool metadata.
- * ALLOWED_TOOLS in ChatContext.tsx and TOOL_NAME_MAPPING in chat.ts are
- * derived from BROWSER_TOOLS below.
- */
 interface BrowserToolMetadata {
     id: string;
     name: string;

package/dist/src/types/index.d.ts

@@ -1,21 +1,5 @@
 import type { InstructionType, WidgetSettingsData } from '../sdk';
 export type { ApplicationData, InstructionType, UserData, WidgetChip, WidgetData, WidgetSettingsData, WorkspaceData, } from '../sdk';
-/**
- * MarketrixConfig - Single source of truth for all widget configuration
- *
- * This type extends WidgetSettingsData (with all fields optional) with additional
- * widget-specific fields, allowing API settings to be spread directly:
- * { ...config, ...apiSettings }
- *
- * All fields are at the top level for easy merging and access.
- *
- * Component-level defaults (not in config):
- * - Input placeholder: 'Ask anything'
- * - Live agent header: 'Live Agent'
- * - Live agent body: 'A live agent will be with you shortly.'
- * - Position offset default: { x: 20, y: 20 }
- * - Z-index default: 40
- */
 export type MarketrixConfig = Partial<WidgetSettingsData> & {
     mtxId?: string;
     mtxKey?: string;
@@ -28,9 +12,9 @@ export type MarketrixConfig = Partial<WidgetSettingsData> & {
     };
     widget_position_z_index?: number;
     isPreviewMode?: boolean;
-    /** Controls visual rendering of the widget. When false, widget initializes fully but UI is hidden. Default: true */
+    /** When false, widget initializes fully but UI is hidden. Default: true */
     show_widget?: boolean;
-    /** Controls screen sharing prompts and button. When false, screen access requests are auto-denied and Share Screen button is hidden. Default: true */
+    /** When false, screen access requests are auto-denied and Share Screen button is hidden. Default: true */
     use_screenshare?: boolean;
 };
 export interface ChatMessage {

package/dist/src/utils/apiUtils.d.ts

@@ -1,9 +1,5 @@
 /** Error-handling helpers for API calls. */
 import type { MarketrixConfig } from '../types';
-/**
- * Extract error message from unknown error type
- * Consolidates error instanceof Error ? error.message : String(error)
- */
 export declare function extractErrorMessage(error: unknown, fallback?: string): string;
 export declare function handleApiError(error: unknown, context?: string, config?: Partial<MarketrixConfig>): {
     isValid: false;

package/dist/src/utils/bootstrap.d.ts

@@ -1,29 +1,10 @@
-/**
- * Widget Initialization, Lifecycle, and Loader Utilities
- *
- * Handles widget container creation, shadow DOM setup, mounting, lifecycle management,
- * and loader display. Consolidates all widget-related DOM manipulation and state management.
- */
 import { type Root } from 'react-dom/client';
 import type { MarketrixConfig } from '../types';
-/**
- * Create widget container and shadow DOM
- * Returns the container element and shadow root
- * @param parentContainer - Optional parent container to mount within. If provided, shadow DOM will be created within this container.
- * @param containerId - Optional unique container ID. If not provided, a unique ID will be generated.
- */
 export declare const createWidgetContainer: (parentContainer?: HTMLElement, containerId?: string) => {
     container: HTMLElement;
     shadowRoot: ShadowRoot;
     mountEl: HTMLElement;
 };
-/**
- * Mount widget component to the provided mount element
- * Returns the React root instance
- * @param mountEl - The mount element inside shadow DOM
- * @param config - Widget configuration
- * @param previewMode - If true, disables network operations (for integration previews)
- */
 export declare const mountWidgetToContainer: (mountEl: HTMLElement, config: MarketrixConfig, previewMode?: boolean) => Root;
 export declare const destroyWidgetContainer: (container: HTMLElement) => void;
 export declare const getWidgetInstance: () => Root | null;
@@ -36,14 +17,5 @@ export declare const setProgrammaticInitInProgress: (inProgress: boolean) => voi
 export declare const isProgrammaticInitInProgress: () => boolean;
 export declare const showWidgetSettingsLoader: (message?: string) => void;
 export declare const hideWidgetSettingsLoader: () => void;
-/**
- * Auto-initialize widget from script tag attributes
- * Retries if script tag not found to handle timing issues with ES module loading
- */
 export declare const autoInitializeWidget: (retryCount?: number) => void;
-/**
- * Register the widget initialization function and set up auto-initialization
- *
- * @param initWidget - Function to initialize the widget (passed to avoid circular dependency)
- */
 export declare const registerAutoInit: (initWidget: (config: MarketrixConfig) => Promise<void>) => void;

package/dist/src/utils/chat.d.ts

@@ -1,60 +1,22 @@
-/**
- * Message Content Utilities
- *
- * Centralized utilities for message content transformation, including:
- * - Removing thinking markers
- */
 import type { ChatMessage, InstructionType } from '../types';
 export declare function removeThinkingMarkers(content: string): string;
 export declare function removeThinkingMarkerFromEnd(content: string): string;
 export declare function hasThinkingMarker(content: string): boolean;
 export declare function addThinkingMarker(content: string): string;
-/**
- * Message Finder Utility
- *
- * Centralized logic for finding messages in the chat that should receive
- * progress updates, tool call results, or errors. Eliminates duplicate
- * message finding code across stream handlers.
- */
 export interface FindMessageOptions {
     messages: ChatMessage[];
     isSimulationRunning: boolean;
     currentMode: InstructionType;
     requireContent?: boolean;
 }
-/**
- * Find the message that should receive progress updates
- * ALWAYS returns the LAST (most recent) matching message by searching backwards.
- * Priority order for active show/do tasks:
- * 1. Placeholder message in show/do mode that has content (the "Let me try this" message)
- * 2. Placeholder message in show/do mode (even without content yet)
- * 3. Non-placeholder agent message in show/do mode
- * For other cases:
- * 4. Last placeholder message
- * 5. Last task message
- * 6. Any agent message as fallback
- */
 export declare function findMessageForProgress(options: FindMessageOptions): {
     index: number;
     message: ChatMessage;
 } | null;
-/**
- * Tools that, in `show` mode, pause for the user to perform the action
- * themselves (DOM-mutating "mouse and keyboard" actions, minus `scroll`).
- * Also the set that requires element highlighting in BrowserToolService.
- */
 export declare const WAIT_FOR_USER_TOOLS: Set<string>;
 export declare function addProgressLine(message: ChatMessage, browserToolName: string, explanation: string): ChatMessage;
 export declare function markProgressLineComplete(message: ChatMessage, browserToolName?: string): ChatMessage;
 export declare function markProgressLineFailed(message: ChatMessage, browserToolName: string, error: string): ChatMessage;
 export declare function updateThinkingMarker(message: ChatMessage, isSimulationRunning: boolean, currentMode: 'show' | 'tell' | 'do', isWaitingForUser?: boolean): ChatMessage;
-/**
- * Tool Name Mapping — derived from BROWSER_TOOLS (single source of truth).
- * Provides friendly display names for technical tool names.
- */
 export declare const TOOL_NAME_MAPPING: Record<string, string>;
-/**
- * Get a friendly display name for a tool
- * Converts snake_case to Title Case if no mapping exists
- */
 export declare function getFriendlyToolName(browserToolName: string): string;

package/dist/src/utils/color.d.ts

@@ -1,16 +1,9 @@
-/**
- * Color utility functions for widget theming
- */
 export declare function hexToRgb(hex: string): {
     r: number;
     g: number;
     b: number;
 } | null;
 export declare function getContrastingColor(color: string): string;
-/**
- * Adds opacity to a color
- * Supports hex colors (with or without #) and rgb/rgba strings
- */
 export declare function addOpacity(color: string, opacity: number): string;
 export declare function darkenColor(color: string, amount: number): string;
 export declare const formatMessageTime: (date: Date | undefined) => string;

package/dist/src/utils/dom.d.ts

@@ -1,7 +1 @@
-/**
- * DOM Manipulation Utilities
- *
- * Centralized utilities for common DOM operations to reduce code duplication
- * and ensure consistent error handling.
- */
 export declare function isInteractable(el: Element | null): boolean;

package/dist/src/utils/logger.d.ts

@@ -1,9 +1,3 @@
-/**
- * Logger Utility
- *
- * Centralized logging utility with log levels and environment-based filtering.
- * Only logs in development mode to reduce noise in production.
- */
 export declare function createLogger(prefix: string): {
     debug: (message: string, ...args: unknown[]) => void;
     info: (message: string, ...args: unknown[]) => void;

package/dist/src/utils/validation.d.ts

@@ -1,9 +1,3 @@
-/**
- * Type Guard Utilities
- *
- * Generic type guard functions for data validation and type checking.
- * These are shared utilities used across the codebase.
- */
 import type { WidgetSettingsData } from '../sdk';
 export declare function isWidgetSettingsData(data: unknown): data is WidgetSettingsData;
 export declare function isHTMLElement(element: Element | null): element is HTMLElement;