guideai-app 0.5.4-1 → 0.5.4-2

package/README.md

@@ -38,6 +38,8 @@ function App() {
 | --------------------------------- | ---------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `authKey`                         | `string`   | Yes (customer embed) | Widget access key; **not** persisted by the package. Exchanged once for a JWT via `POST /widget/session`. **Do not use React’s reserved `key` attribute** — use this prop name.     |
 | `workspace`                       | `string`   | No                   | Workspace slug to use for the realtime session. Forwarded on the `/initialize` body so the server can pick a non-default workspace per request. Omit to use the customer default.   |
+| `getUserInfo`                     | `function` | No                   | Lets Guide AI know who is signed in on your app (see **Signed-in users** below). |
+| `initializeUserId`               | `string`   | No                   | Advanced: optional fixed user id when you manage identity yourself. |
 | `adminConversationPersistenceKey` | `string`   | No                   | Optional stable key for transcript `localStorage` isolation. Omit to use a non-secret default from the page **origin** (same across SPA routes). Never use the raw access key here. |
 | `React`                           | `React`    | Yes                  | React instance from your application                                                                                                                                                |
 | `ReactDOM`                        | `ReactDOM` | Yes                  | ReactDOM instance from your application                                                                                                                                             |
@@ -317,6 +319,51 @@ function App() {
 export default App;
 ```
 
+## Signed-in users (`getUserInfo`)
+
+If people can sign in on your site, pass **`getUserInfo`** so Guide AI can treat them as the same person across visits and tie voice sessions to their account.
+
+- Your function should return something like **`{ username: user.email }`** when someone is logged in. Use whatever stable string identifies them (often an email).
+- When **no one is logged in yet**, you can **`return null`** (or omit **`username`**) so Guide AI keeps a normal anonymous experience without rotating identities on every check.
+- After login or logout, you can notify Guide AI right away by dispatching **`GUIDEAI_HOST_USERINFO_REFRESH_EVENT`** on `window` (import it from `guideai-app` alongside the component).
+
+Wrap **`getUserInfo`** in **`useCallback`** so it doesn’t change every render.
+
+More detail for integrations lives in **`docs/WIDGET_USER_IDENTITY.md`** and **`AUTHENTICATION.md`**.
+
+### Example
+
+```jsx
+import React, { useCallback } from 'react';
+import ReactDOM from 'react-dom';
+import GuideAI, { GUIDEAI_HOST_USERINFO_REFRESH_EVENT } from 'guideai-app';
+
+function App({ currentUser }) {
+	const getUserInfo = useCallback(() => {
+		if (!currentUser) return null;
+
+		return {
+			username: currentUser.email,
+			displayName: currentUser.name,
+		};
+	}, [currentUser]);
+
+	// Optional: after your auth state changes, run:
+	// window.dispatchEvent(new CustomEvent(GUIDEAI_HOST_USERINFO_REFRESH_EVENT));
+
+	return (
+		<GuideAI
+			authKey="your-access-key"
+			workspace="your-workspace"
+			React={React}
+			ReactDOM={ReactDOM}
+			getUserInfo={getUserInfo}
+			position={{ bottom: '20px', right: '20px' }}
+		/>
+	);
+}
+```
+
 ## Getting Your Access Key
 
 To use Guide AI, you'll need an access key and workspace slug. Contact the Guide AI team to get set up.

package/dist/GuideAI.d.ts

@@ -1,3 +1,6 @@
 import { GuideAIProps } from './types/GuideAI.types';
+/**
+ * Default export is the GuideAI React component.
+ */
 declare const GuideAI: (props: GuideAIProps) => import("react").JSX.Element | null;
 export default GuideAI;