@helpway/react 0.4.1 → 0.5.0

package/README.md

@@ -2,6 +2,13 @@
 
 Official React SDK for [Helpway](https://helpway.ai) — AI-powered customer support widget with full programmatic control.
 
+> **📚 Full documentation:** https://helpway.ai/docs
+> · [Quick start](https://helpway.ai/docs/quick-start)
+> · [React SDK](https://helpway.ai/docs/react-sdk)
+> · [Customization & theming](https://helpway.ai/docs/customization)
+> · [Widget API](https://helpway.ai/docs/widget-api)
+> · [Integration notes (CSP, SSR, multi-tenant)](https://helpway.ai/docs/integration-notes)
+
 ## Install
 
 ```bash

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _helpway_widget_core from '@helpway/widget-core';
-import { HelpwayAPI, WidgetStore } from '@helpway/widget-core';
-export { ConversationSummary, HelpwayAPI, RealtimeEvent, TimelineItem, WidgetEventName, WidgetEvents, WidgetState, WidgetStore, clearVisitorId, formatRelativeTime, formatTime, getInitials, getOrCreateVisitorId } from '@helpway/widget-core';
+import { HelpwayMethods, WidgetTheme, WidgetStore } from '@helpway/widget-core';
+export { ConversationSummary, HelpwayAPI, RealtimeEvent, TimelineItem, WidgetEventName, WidgetEvents, WidgetPosition, WidgetState, WidgetStore, WidgetTheme, clearVisitorId, formatRelativeTime, formatTime, getInitials, getOrCreateVisitorId } from '@helpway/widget-core';
 import * as react from 'react';
 import react__default, { ReactNode } from 'react';
 import * as _helpway_types from '@helpway/types';
@@ -52,6 +52,16 @@ interface HelpwayWidgetProps {
     onClose?: () => void;
     /** Fires when the unread count changes */
     onUnreadChange?: (count: number) => void;
+    /**
+     * Developer-side theme override. Most consumers should configure
+     * appearance from the dashboard so changes apply without a redeploy
+     * — see https://helpway.ai/docs/customization. Use this prop only
+     * for runtime-resolved theming (multi-tenant brand colors, dark/
+     * light sync with the host app, etc). Values map to CSS custom
+     * properties on the widget host. See the `WidgetTheme` type for
+     * the full set of supported keys.
+     */
+    theme?: WidgetTheme;
     /**
      * @deprecated Legacy prop from the v0.1 script-loader era. If set,
      * the `/widget.js` suffix is stripped to derive `apiUrl`. New code
@@ -60,13 +70,13 @@ interface HelpwayWidgetProps {
     src?: string;
 }
 
-type HelpwayPublicAPI = HelpwayAPI;
+type HelpwayPublicAPI = HelpwayMethods;
 /**
  * Render this once at the root of your app (e.g. in `_app.tsx`,
  * `layout.tsx`, or `main.tsx`). Unmounting cleanly tears down the
  * widget and its WebSocket connection — useful for route-scoped mounts.
  */
-declare function HelpwayWidget({ apiKey, apiUrl, locale, initialConversationId, onReady, hideLauncher, customLauncherSelector, onOpen, onClose, onUnreadChange, src, }: HelpwayWidgetProps): react_jsx_runtime.JSX.Element;
+declare function HelpwayWidget({ apiKey, apiUrl, locale, initialConversationId, onReady, hideLauncher, customLauncherSelector, onOpen, onClose, onUnreadChange, theme, src, }: HelpwayWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface IdentifyData {
     externalId: string;
@@ -84,11 +94,22 @@ interface SupportProviderProps {
     apiUrl?: string;
     locale?: string;
     initialConversationId?: string;
-    onReady?: (api: HelpwayAPI) => void;
+    onReady?: (api: HelpwayMethods) => void;
     customLauncherSelector?: string;
     onOpen?: () => void;
     onClose?: () => void;
     onUnreadChange?: (count: number) => void;
+    /**
+     * Developer-side theme override. Most consumers should configure
+     * appearance in the Helpway dashboard (see
+     * https://helpway.ai/docs/customization) so changes apply without
+     * a redeploy. Use this prop only when you need the widget to inherit
+     * a host-app theme that the dashboard can't see (e.g. a tenant-
+     * specific brand color resolved at runtime). Values here are written
+     * as CSS custom properties on the widget host and override the
+     * dashboard config for this mount only.
+     */
+    theme?: WidgetTheme;
     children: ReactNode;
 }
 /**
@@ -98,7 +119,7 @@ interface SupportProviderProps {
  * Visitor identity is managed via server-side cookies (hw_visitor).
  * No localStorage or client-side ID management needed.
  */
-declare function SupportProvider({ apiKey, apiUrl, locale, initialConversationId, onReady, customLauncherSelector, onOpen, onClose, onUnreadChange, children, }: SupportProviderProps): react_jsx_runtime.JSX.Element;
+declare function SupportProvider({ apiKey, apiUrl, locale, initialConversationId, onReady, customLauncherSelector, onOpen, onClose, onUnreadChange, theme, children, }: SupportProviderProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Core widget state — connection status, visitor identity, website info.
@@ -238,9 +259,10 @@ interface MessageBubbleProps {
     sender: "visitor" | "team" | "ai";
     senderName?: string;
     parts?: TimelineItemPart[] | null;
+    timestamp?: string;
 }
 /** Single message bubble — Intercom-style, renders text + image/file parts */
-declare function MessageBubble({ text, sender, senderName, parts }: MessageBubbleProps): react_jsx_runtime.JSX.Element;
+declare function MessageBubble({ text, sender, senderName, parts, timestamp }: MessageBubbleProps): react_jsx_runtime.JSX.Element;
 
 interface MessageListProps {
     items: TimelineItem[];