ESM entry
Package exports exposed by @customer-agent/sdk.
The ESM entry is the package-import version of the SDK. It exposes the same browser singleton as the script entry, plus React hooks and message catalog assets.
Package Exports
| Export path | Exports | Purpose |
|---|---|---|
@customer-agent/sdk | default, CustomerAgent, named SDK methods, types, CUSTOMER_AGENT_EVENTS | Browser SDK control surface. |
@customer-agent/sdk/react | useCustomerAgent, useCustomerAgentState, useCustomerAgentEvent | React hook surface. |
@customer-agent/sdk/sdk.js | Browser script asset | Script SDK file. |
@customer-agent/sdk/runtime.es.js | Browser runtime asset | Public runtime module artifact. |
@customer-agent/sdk/messages/* | Message catalog JSON files | Built-in locale message catalogs. |
Main Export
import CustomerAgent, {
CUSTOMER_AGENT_EVENTS,
boot,
chooseInvitation,
ensureInvitation,
getInterviewState,
getInterviewSession,
getSession,
getState,
getSupportState,
hide,
identify,
openEntry,
on,
loadInterviewReward,
sendInterviewMessage,
setContext,
show,
shutdown,
startInvitation,
toggle,
update
} from "@customer-agent/sdk"See JavaScript SDK for method signatures.
Type Exports
| Type | Meaning |
|---|---|
CustomerAgentGlobal | Command function and method namespace. |
CustomerAgentOptions | Options accepted by boot and update. |
CustomerAgentWidget | Controller returned by boot. |
CustomerAgentState | State returned by getState. |
CustomerAgentSupportState | State returned by getSupportState. |
CustomerAgentInterviewState | State returned by getInterviewState. |
CustomerAgentTarget | Target accepted by show and toggle. |
CustomerAgentEventMap | Event payload map. |
CustomerAgentEventName | Union of event names. |
SetContextOptions | Options accepted by setContext. |
CustomerAgentInterviewSession | Session returned by getInterviewSession. |
WidgetContextJson | JSON object accepted as user context. |
Message Catalog Exports
Built-in message catalogs are available under @customer-agent/sdk/messages/<locale>.json.
Self-hosted Assets
When serving built SDK files yourself, publish the complete dist output instead of copying individual entry files.
| Locale | Export path |
|---|---|
de | @customer-agent/sdk/messages/de.json |
en | @customer-agent/sdk/messages/en.json |
es | @customer-agent/sdk/messages/es.json |
fr | @customer-agent/sdk/messages/fr.json |
it | @customer-agent/sdk/messages/it.json |
ja | @customer-agent/sdk/messages/ja.json |
ko | @customer-agent/sdk/messages/ko.json |
pt-BR | @customer-agent/sdk/messages/pt-BR.json |
zh | @customer-agent/sdk/messages/zh.json |
zh-TW | @customer-agent/sdk/messages/zh-TW.json |