@salesforce/agentforce-conversation-client 11.67.1 → 11.68.0

package/dist/types.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+import type { RenderingModeValue } from "./constants.js";
+export type StyleTokens = Record<string, string>;
+export interface TypewriterConfig {
+    charsPerFrame?: number;
+    charsPerFrameMarkdown?: number;
+    queueThresholdMedium?: number;
+    queueThresholdHigh?: number;
+    queueThresholdCritical?: number;
+    frameDelayMs?: number;
+    idleCursorTimeoutMs?: number;
+    rushToEndMs?: number;
+}
+export interface AgentforceClientConfig {
+    styleTokens?: StyleTokens;
+    agentId?: string;
+    agentLabel?: string;
+    renderingConfig?: {
+        mode?: RenderingModeValue;
+        width?: string | number;
+        height?: string | number;
+        headerEnabled?: boolean;
+        showHeaderIcon?: boolean;
+        showAvatar?: boolean;
+        agentAvatarUrl?: string;
+        agentAvatarAltText?: string;
+        headerIconName?: string;
+        headerIconSize?: string;
+        headerImageUrl?: string;
+        headerImageAlt?: string;
+    };
+    channel?: string;
+    messageInputPlaceholderText?: string;
+    isHistoryIntroNeeded?: boolean;
+    isFileBased?: boolean;
+    typewriterConfig?: TypewriterConfig;
+    floatingButtonLabel?: string;
+    floatingButtonIcon?: string;
+    floatingButtonImage?: string;
+    floatingButtonImageAlt?: string;
+    iconPosition?: "left" | "right";
+}
+export interface AgentforceLoErrorEvent {
+    type: "lo.application.error" | "lo.iframe.error" | "lo.session.error";
+    detail: unknown;
+}
+export type AgentforceErrorHandler = (error: AgentforceLoErrorEvent) => void;
+export type AgentforceReadyHandler = (detail: unknown) => void;
+/** Why ACC stopped keepalive and needs the host to mint a frontdoor URL. */
+export interface AgentforceSessionRecoveryRequest {
+    reason: "expired" | "refresh-failed" | "expiry-unavailable";
+    /** Seconds remaining, when known. Absent if the TTL query itself failed. */
+    ttlSeconds?: number;
+    /** The underlying Lightning Out error, when one triggered the request. */
+    error?: unknown;
+}
+/**
+ * Optional keepalive tuning for frontdoor-URL-only embeds. Keepalive
+ * (`sessionRefresh`) is on by default in that mode; use this to override
+ * thresholds or handle frontdoor regeneration.
+ */
+export interface AgentforceSessionManagementConfig {
+    /**
+     * Optional convenience callback with the same payload as
+     * `agentforce:frontdoorurlrequired`. Prefer listening for the event on the
+     * container. May be async; rejections are logged and forwarded to `onError`.
+     */
+    onFrontdoorUrlRequired?: (request: AgentforceSessionRecoveryRequest) => void | Promise<void>;
+    /** How often to inspect the session TTL. Defaults to 60 seconds for now. */
+    checkIntervalMs?: number;
+    /** Do nothing while the TTL is above this value. Defaults to 10 minutes. */
+    skipThresholdSeconds?: number;
+    /**
+     * Below this TTL (and above zero), ACC calls `sessionRefresh()`. At or below
+     * this value ACC asks the host for a new frontdoor URL. Defaults to 5 minutes.
+     */
+    refreshThresholdSeconds?: number;
+}
+export interface EmbedAgentforceClientOptions {
+    container: string | HTMLElement;
+    salesforceOrigin?: string;
+    appId?: string;
+    frontdoorUrl?: string;
+    sitePrefix?: string;
+    agentforceClientConfig?: AgentforceClientConfig;
+    /**
+     * Optional keepalive overrides / regeneration hook. Keepalive runs by default
+     * in frontdoor-URL-only mode; omit this unless you need to tune or handle recovery.
+     */
+    sessionManagement?: AgentforceSessionManagementConfig;
+    onError?: AgentforceErrorHandler;
+    onReady?: AgentforceReadyHandler;
+}
+/**
+ * Lightning Out application element with the session primitives LO already owns.
+ * In frontdoor-URL-only mode ACC calls `sessionRefresh()` for keepalive by default;
+ * the host still owns minting a new frontdoor URL when the session is dead.
+ */
+export interface AgentforceLightningOutApplication extends HTMLElement {
+    sessionExpiry(): Promise<number>;
+    sessionRefresh(): Promise<void>;
+    frontdoorUrl: string;
+}
+export interface EmbedAgentforceClientResult {
+    loApp: AgentforceLightningOutApplication;
+    chatClientComponent: HTMLElement;
+    /**
+     * Hands a freshly minted frontdoor URL to Lightning Out. Only the hidden auth
+     * iframe reloads, so the conversation stays mounted. Rejects empty URLs and
+     * org-url mode; ignores writes after logout.
+     */
+    setFrontdoorUrl: (frontdoorUrl: string) => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEjD,MAAM,WAAW,gBAAgB;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACtC,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE;QACjB,IAAI,CAAC,EAAE,kBAAkB,CAAC;QAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACzB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,cAAc,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,sBAAsB,GAAG,iBAAiB,GAAG,kBAAkB,CAAC;IACtE,MAAM,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;AAC7E,MAAM,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;AAE/D,4EAA4E;AAC5E,MAAM,WAAW,gCAAgC;IAChD,MAAM,EAAE,SAAS,GAAG,gBAAgB,GAAG,oBAAoB,CAAC;IAC5D,4EAA4E;IAC5E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0EAA0E;IAC1E,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IACjD;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,gCAAgC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7F,4EAA4E;IAC5E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,4BAA4B;IAC5C,SAAS,EAAE,MAAM,GAAG,WAAW,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAChD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,iCAAiC,CAAC;IACtD,OAAO,CAAC,EAAE,sBAAsB,CAAC;IACjC,OAAO,CAAC,EAAE,sBAAsB,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAkC,SAAQ,WAAW;IACrE,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACjC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC3C,KAAK,EAAE,iCAAiC,CAAC;IACzC,mBAAmB,EAAE,WAAW,CAAC;IACjC;;;;OAIG;IACH,eAAe,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;CAChD"}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

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": "11.67.1",
+  "version": "11.68.0",
   "license": "SEE LICENSE IN LICENSE.txt",
   "type": "module",
   "main": "./dist/index.js",