@helpway/react 0.4.0 → 0.4.1

package/README.md

@@ -1,129 +1,112 @@
 # @helpway/react
 
-Official React SDK for [Helpway](https://helpway.ai) — AI-powered customer support in a single component.
-
-Two integration levels in one package:
-
-- **Drop-in**: mount `<HelpwayWidget apiKey="..." />` anywhere in your tree and you're done.
-- **Headless**: use `SupportProvider` + hooks (`useWidget`, `useConversations`, `useTimeline`, `useComposer`) to build your own chat UI against the same realtime backend.
+Official React SDK for [Helpway](https://helpway.ai) — AI-powered customer support widget with full programmatic control.
 
 ## Install
 
 ```bash
 npm install @helpway/react
-# or
-bun add @helpway/react
-# or
-pnpm add @helpway/react
 ```
 
 Peer dependencies: `react` ≥ 18 and `react-dom` ≥ 18.
 
-## Drop-in
-
-Grab your public API key from the Helpway dashboard → Settings → API keys (format: `pk_live_…`).
+## Quick start
 
 ```tsx
-// app/layout.tsx (Next.js App Router)
 import { HelpwayWidget } from "@helpway/react";
 
-export default function RootLayout({ children }: { children: React.ReactNode }) {
+export default function App() {
   return (
-    <html>
-      <body>
-        {children}
-        <HelpwayWidget apiKey="pk_live_XXXXXXXX" />
-      </body>
-    </html>
+    <>
+      <YourApp />
+      <HelpwayWidget apiKey="pk_live_xxx" />
+    </>
   );
 }
 ```
 
-```tsx
-// main.tsx (Vite / CRA)
-import { HelpwayWidget } from "@helpway/react";
-import { StrictMode } from "react";
-import { createRoot } from "react-dom/client";
-import App from "./App";
-
-createRoot(document.getElementById("root")!).render(
-  <StrictMode>
-    <App />
-    <HelpwayWidget apiKey="pk_live_XXXXXXXX" />
-  </StrictMode>,
-);
+## Programmatic API (`window.Helpway`)
+
+After the widget bootstraps, a type-safe global API is available:
+
+```ts
+window.Helpway.open()                        // open panel
+window.Helpway.close()                       // close panel
+window.Helpway.toggle()                      // toggle open/close
+window.Helpway.dismiss()                     // hide launcher + panel
+window.Helpway.show()                        // re-show after dismiss
+window.Helpway.shutdown()                    // full session reset
+
+window.Helpway.identify({                    // link visitor to contact
+  externalId: "u_123",
+  email: "jane@acme.com",
+  name: "Jane Doe",
+})
+
+window.Helpway.newConversation("Help!")      // open new conversation
+window.Helpway.openConversation("conv_abc")  // open specific conversation
+
+window.Helpway.unreadCount                   // getter: number
+window.Helpway.isOpen                        // getter: boolean
+
+window.Helpway.on("open", () => {})          // subscribe to events
+window.Helpway.on("unreadChange", (n) => {})
+window.Helpway.on("messageReceived", (msg) => {})
+window.Helpway.off("open", handler)          // unsubscribe
 ```
 
-The component injects the Helpway widget loader script into `document.body`, handles StrictMode double-mounts, and removes the script on unmount.
+TypeScript users get full auto-complete — the package augments `Window` automatically.
 
-### Props
+## Props
 
-| Prop     | Type     | Default                              | Description                                   |
-| -------- | -------- | ------------------------------------ | --------------------------------------------- |
-| `apiKey` | `string` | —                                    | Public key from the dashboard. Required.      |
-| `src`    | `string` | `https://api.helpway.ai/widget.js` | Override for staging / self-hosted setups.    |
+| Prop | Type | Default | Description |
+|---|---|---|---|
+| `apiKey` | `string` | — | **Required.** Public key from dashboard. |
+| `apiUrl` | `string` | `https://api.helpway.ai` | Override for staging / self-hosted. |
+| `locale` | `string` | auto-detect | Widget language (`"en"`, `"tr"`, `"de"`…). |
+| `hideLauncher` | `boolean` | `false` | Hide the default floating bubble. |
+| `customLauncherSelector` | `string` | — | CSS selector for custom trigger element. |
+| `onReady` | `(api: HelpwayAPI) => void` | — | Full API object after bootstrap. |
+| `onOpen` | `() => void` | — | Panel opened. |
+| `onClose` | `() => void` | — | Panel closed. |
+| `onUnreadChange` | `(count: number) => void` | — | Unread count changed. |
 
-### Identifying logged-in users
+## Custom launcher
 
-After your user signs in, call the global `Helpway` identify function so the dashboard sees their real name and email instead of `Anonymous`:
+```tsx
+<HelpwayWidget
+  apiKey="pk_live_xxx"
+  hideLauncher
+  customLauncherSelector="#my-btn"
+/>
 
-```ts
-window.Helpway("identify", {
-  uniqueId: user.id,
-  name: user.name,
-  email: user.email,
-});
+<button id="my-btn">Support</button>
 ```
 
-## Headless
+## Headless hooks
 
-If you want to render your own chat UI (custom bubbles, different layout, embedded in your app instead of a floating button), use the provider + hooks:
+Build your own chat UI with the same realtime backend:
 
 ```tsx
 import { SupportProvider, useConversations, useTimeline, useComposer } from "@helpway/react";
 
-function ChatSurface() {
-  const { conversations, activeConversationId, setActive } = useConversations();
-  const { items } = useTimeline();
-  const { draft, setDraft, send } = useComposer();
-
-  return (
-    <div>
-      {/* render conversations, messages, composer — full control */}
-    </div>
-  );
+function Chat() {
+  const { conversations } = useConversations();
+  const { items } = useTimeline(conversations[0]?.id);
+  const { text, setText, submit } = useComposer(conversations[0]?.id);
+  // ...render your own UI
 }
 
-export default function App() {
-  return (
-    <SupportProvider apiKey="pk_live_XXXXXXXX">
-      <ChatSurface />
-    </SupportProvider>
-  );
-}
+<SupportProvider apiKey="pk_live_xxx">
+  <Chat />
+</SupportProvider>
 ```
 
-Exported hooks:
+Available hooks: `useWidget`, `useConversations`, `useTimeline`, `useComposer`, `usePresence`, `useUnread`, `useRealtime`.
 
-- `useWidget()` — global state, openers/closers
-- `useConversations()` — list + active conversation
-- `useTimeline()` — messages + events for the active conversation
-- `useComposer()` — draft state + send/attach
-- `usePresence()` — online team members
-- `useUnread()` — unread counts
-- `useRealtime()` — raw WebSocket event stream
-
-Full API docs: [helpway.ai/docs/react](https://helpway.ai/docs/react)
-
-## Styling
-
-The default themed widget ships opinionated styles. If you use `DefaultWidget`, pull in the stylesheet once:
-
-```ts
-import "@helpway/react/styles.css";
-```
+## Docs
 
-The headless hooks have no styles — bring your own.
+Full documentation: [helpway.ai/docs](https://helpway.ai/docs)
 
 ## License
 

package/dist/index.js

@@ -898,9 +898,6 @@ function SupportProvider({
       }
     };
     const api2 = createHelpwayAPI({ store: store2, emitter: emitter2, identify: identify2, apiKey });
-    if (typeof window !== "undefined") {
-      window.Helpway = api2;
-    }
     initRef.current = { client: client2, store: store2, ws: ws2, identify: identify2, api: api2, emitter: emitter2 };
   }
   const { client, store, ws, identify, api, emitter } = initRef.current;
@@ -1060,6 +1057,8 @@ function SupportProvider({
     };
   }, [customLauncherSelector, api]);
   useEffect(() => {
+    if (typeof window === "undefined") return;
+    window.Helpway = api;
     return () => {
       if (window.Helpway === api) {
         window.Helpway = void 0;