@salesforce/agentforce-conversation-client 1.122.0 → 1.122.1

package/README.md

@@ -2,18 +2,18 @@
 
 > **Beta**: This package is currently in beta. APIs and behavior may change in future releases.
 
-Agentforce Conversation Client SDK for embedding the Agentforce chat experience into external applications. By default, Lightning Out 2.0 is embedded within the target container.
+The Agentforce Conversation Client SDK enables embedding the Agentforce chat experience for employee agents into external applications.
 
 ## Overview
 
-This library embeds the Agentforce Conversation Client using Lightning Out 2.0. The `salesforceOrigin` option is passed to the Lightning Out application as the `org-url` attribute. You can also pass `appId` to set the Lightning Out `app-id` attribute. The `appId` is the 18-digit Lightning Out 2.0 app ID (for example, `1Usfi200000006TCAQ`). You can find this value in the Lightning Out 2.0 App Manager in Setup.
+This library embeds the Agentforce Conversation Client for employee agents using Lightning Out 2.0.
 
 ## Prerequisites
 
 - **One of `salesforceOrigin` or `frontdoorUrl` is required.**
 - Use `salesforceOrigin` when your app is hosted inside a Salesforce org and already has an authenticated session.
 - Use `frontdoorUrl` when embedding the chat client outside Salesforce (for example, a localhost or external app).
-- Lightning Out uses an existing session to initialize; without it, the embed will fail to start.
+- Lightning Out 2.0 uses an existing session to initialize; without it, the embed will fail to start.
 
 ## Installation
 
@@ -143,6 +143,10 @@ const { loApp, chatClientComponent } = embedAgentforceClient({
 });
 ```
 
+### Style Token Reference
+
+Share: [Style Token Reference](#style-token-tables)
+
 ### Container
 
 | Token name            | UI area themed              |
@@ -232,7 +236,7 @@ Use `renderingConfig.showAvatar` to control whether avatars are rendered in mess
 
 | Token name                                | UI area themed                    |
 | ----------------------------------------- | --------------------------------- |
-| `inboundMessgeTextColor`                  | Inbound message text color (base) |
+| `inboundMessageTextColor`                 | Inbound message text color (base) |
 | `messageBlockInboundBorderRadius`         | Inbound message border radius     |
 | `messageBlockInboundBackgroundColor`      | Inbound message background        |
 | `messageBlockInboundTextColor`            | Inbound message text color        |
@@ -325,7 +329,7 @@ const { loApp, chatClientComponent } = embedAgentforceClient({
 });
 ```
 
-### With Lightning Out App ID
+### With Lightning Out 2.0 App ID
 
 ```typescript
 import { embedAgentforceClient } from "@salesforce/agentforce-conversation-client";
@@ -346,7 +350,7 @@ const { loApp } = embedAgentforceClient({
 });
 
 loApp.addEventListener("lo.application.ready", () => {
-  console.log("Lightning Out is ready");
+  console.log("Lightning Out 2.0 is ready");
 });
 
 loApp.addEventListener("lo.component.ready", (event) => {
@@ -362,16 +366,18 @@ loApp.addEventListener("lo.application.error", (event) => {
 
 ### `embedAgentforceClient(options)`
 
-Embeds the Agentforce Conversation Client into a specified DOM container. By default, Lightning Out is embedded within the target container.
+Embeds the Agentforce Conversation Client by creating a Lightning Out 2.0 app and chat wrapper under the provided container. In floating mode, the chat is displayed as a fixed overlay; in inline mode, it renders within the container layout.
+
+> Note: The embed is initially hidden and becomes visible after the chat wrapper dispatches the `accready` event.
 
 #### Parameters
 
 | Parameter                                               | Type                     | Required | Description                                                                                                                                      |
 | ------------------------------------------------------- | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `options.container`                                     | `string \| HTMLElement`  | Yes      | CSS selector or HTMLElement to embed into                                                                                                        |
-| `options.salesforceOrigin`                              | `string`                 | No       | Salesforce org origin URL (use when hosted in a Salesforce org)                                                                                  |
+| `options.salesforceOrigin`                              | `string`                 | No       | Salesforce org origin URL (use when hosted in a Salesforce org). At least one of `salesforceOrigin` or `frontdoorUrl` is required                |
 | `options.appId`                                         | `string`                 | No       | 18-digit Lightning Out 2.0 app ID (`app-id`); find it in Lightning Out 2.0 App Manager in Setup; not required for apps created before Spring '26 |
-| `options.frontdoorUrl`                                  | `string`                 | No       | Frontdoor URL for authentication (use when embedding outside Salesforce)                                                                         |
+| `options.frontdoorUrl`                                  | `string`                 | No       | Frontdoor URL for authentication (use when embedding outside Salesforce). At least one of `salesforceOrigin` or `frontdoorUrl` is required       |
 | `options.agentforceClientConfig`                        | `AgentforceClientConfig` | No       | Configuration for the Agentforce client (see sub-properties below)                                                                               |
 | `agentforceClientConfig.agentId`                        | `string`                 | Yes\*    | The agent to load — required in practice, will not work without it                                                                               |
 | `agentforceClientConfig.agentLabel`                     | `string`                 | No       | Display name shown in the chat header. Falls back to the agent's configured name if omitted                                                      |
@@ -387,7 +393,7 @@ Embeds the Agentforce Conversation Client into a specified DOM container. By def
 
 | Property              | Type                      | Description                       |
 | --------------------- | ------------------------- | --------------------------------- |
-| `loApp`               | `LightningOutApplication` | The Lightning Out application     |
+| `loApp`               | `LightningOutApplication` | The Lightning Out 2.0 application |
 | `chatClientComponent` | `HTMLElement`             | The chat client component element |
 
 ## Types

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/agentforce-conversation-client",
   "description": "Agentforce Conversation Client SDK for embedding via Lightning Out 2.0",
-  "version": "1.122.0",
+  "version": "1.122.1",
   "license": "SEE LICENSE IN LICENSE.txt",
   "type": "module",
   "main": "./dist/index.js",