@helpway/react 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -7,40 +7,6 @@ import react__default, { ReactNode } from 'react';
 import * as _helpway_types from '@helpway/types';
 import { TimelineItem, RealtimeEvent, TimelineItemPart } from '@helpway/types';
 
-/**
- * `<HelpwayWidget />` — one-line drop-in React component that loads
- * the Helpway widget script and tears it down on unmount.
- *
- * This is the lowest-friction integration path for React / Next.js /
- * Vite apps that don't need to render custom chat UI themselves. Under
- * the hood it just injects `https://api.helpway.ai/widget.js` with the
- * provided public key, exactly like the plain `<script>` snippet — but
- * wrapped in a React lifecycle so it participates in StrictMode double
- * mounts, SSR boundaries, and component cleanup without footguns.
- *
- * Power-user alternative: import `{ SupportProvider, useWidget, … }`
- * from this same package for full programmatic control.
- */
-interface HelpwayWidgetProps {
-    /**
-     * Public API key from the Helpway dashboard. Required.
-     * Format: `pk_live_…` or `pk_test_…`.
-     */
-    apiKey: string;
-    /**
-     * Override the default widget loader URL. Almost no one needs this —
-     * exposed for staging / self-hosted setups.
-     * @default "https://api.helpway.ai/widget.js"
-     */
-    src?: string;
-}
-/**
- * Render this once at the root of your app (e.g. in `_app.tsx`,
- * `layout.tsx`, or `main.tsx`). Unmounting removes the script and
- * collapses the widget iframe — useful for route-scoped mounts.
- */
-declare function HelpwayWidget({ apiKey, src, }: HelpwayWidgetProps): null;
-
 interface IdentifyData {
     externalId: string;
     email?: string;
@@ -77,6 +43,50 @@ interface SupportProviderProps {
  */
 declare function SupportProvider({ apiKey, apiUrl, locale, initialConversationId, onReady, children, }: SupportProviderProps): react_jsx_runtime.JSX.Element;
 
+interface HelpwayWidgetProps {
+    /**
+     * Public API key from the Helpway dashboard. Required.
+     * Format: `pk_live_…` or `pk_test_…`.
+     */
+    apiKey: string;
+    /**
+     * Override the default API URL. Almost no one needs this —
+     * exposed for staging / self-hosted setups.
+     * @default "https://api.helpway.ai"
+     */
+    apiUrl?: string;
+    /**
+     * Widget locale (e.g. "tr", "en", "de"). Falls back to server-side
+     * detection (Accept-Language + CF-IPCountry) then widget-core default.
+     */
+    locale?: string;
+    /**
+     * Deep link: auto-open this conversation after bootstrap.
+     * Usually sourced from `?hw_conv=` URL param for email CTAs.
+     */
+    initialConversationId?: string;
+    /**
+     * Called once after the widget has bootstrapped and exposes
+     * programmatic APIs (identify, openConversation).
+     */
+    onReady?: (api: {
+        identify: (data: IdentifyData) => Promise<void>;
+        openConversation: (id: string) => void;
+    }) => void;
+    /**
+     * @deprecated Legacy prop from the v0.1 script-loader era. If set,
+     * the `/widget.js` suffix is stripped to derive `apiUrl`. New code
+     * should use `apiUrl` instead.
+     */
+    src?: string;
+}
+/**
+ * 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, src, }: HelpwayWidgetProps): react_jsx_runtime.JSX.Element;
+
 /**
  * Core widget state — connection status, visitor identity, website info.
  *