@salesforce/sdk-chat 1.22.0 → 1.30.0

package/dist/index.d.ts

@@ -1,4 +1,9 @@
 import type { ChatSDK } from "@salesforce/sdk-core";
-export declare const sdk: ChatSDK;
-export type { ChatMessage, ChatSDK, ResourceRequest, ToolCall, ToolState, } from "@salesforce/sdk-core";
+/**
+ * Create and initialize a ChatSDK instance based on the detected surface
+ *
+ * @returns Promise resolving to an initialized ChatSDK instance
+ */
+export declare function createChatSDK(): Promise<ChatSDK>;
+export type { ChatMessage, ChatSDK, DisplayMode, ResourceRequest, ToolCall, ToolState, } from "@salesforce/sdk-core";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAoBpD,eAAO,MAAM,GAAG,SAAe,CAAC;AAChC,YAAY,EACX,WAAW,EACX,OAAO,EACP,eAAe,EACf,QAAQ,EACR,SAAS,GACT,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAKpD;;;;GAIG;AACH,wBAAsB,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,CAetD;AAED,YAAY,EACX,WAAW,EACX,OAAO,EACP,WAAW,EACX,eAAe,EACf,QAAQ,EACR,SAAS,GACT,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -7,18 +7,24 @@ import { getSurface, Surface } from "@salesforce/sdk-core";
 import { MCPAppsChatSDK } from "./mcpapps.js";
 import { OpenAIChatSDK } from "./openai.js";
 import { SalesforceACCChatSDK } from "./salesforce-acc.js";
-function initialize() {
+/**
+ * Create and initialize a ChatSDK instance based on the detected surface
+ *
+ * @returns Promise resolving to an initialized ChatSDK instance
+ */
+export async function createChatSDK() {
     const surface = getSurface();
     switch (surface) {
         case Surface.OpenAI:
             return new OpenAIChatSDK();
-        case Surface.Webapp:
+        case Surface.WebApp:
         case Surface.MicroFrontend:
-            return new MCPAppsChatSDK();
+            return {};
         case Surface.SalesforceACC:
             return new SalesforceACCChatSDK();
+        case Surface.MCPApps:
+            return new MCPAppsChatSDK();
         default:
             return {};
     }
 }
-export const sdk = initialize();

package/dist/mcpapps.d.ts

@@ -7,15 +7,17 @@ import type { ChatSDK, ChatMessage, ResourceRequest, ToolCall, ToolState } from
 /**
  * Chat SDK implementation for Webapp and MicroFrontend surfaces using MCP Apps protocol
  * Supports: sendMessageToHost, callTool, readResource, accessToolInput, accessToolOutput,
- * accessToolMetadata (stub), onToolCanceled (stub)
+ * accessToolMetadata (stub), onToolCanceled (stub), subscribe
  */
 export declare class MCPAppsChatSDK implements ChatSDK {
     private nextMessageId;
     private pending;
     private globals;
     private canceledCallbacks;
+    private subscriptions;
     constructor();
     private onMessage;
+    private notifySubscribers;
     private request;
     sendMessageToHost(message: ChatMessage): Promise<void>;
     callTool<T>(toolCall: ToolCall): Promise<T>;
@@ -24,5 +26,6 @@ export declare class MCPAppsChatSDK implements ChatSDK {
     accessToolOutput<T>(): ToolState<T> | null;
     accessToolMetadata<T>(): T | null;
     onToolCanceled(callback: () => void): void;
+    subscribe(callback: () => void): () => void;
 }
 //# sourceMappingURL=mcpapps.d.ts.map

package/dist/mcpapps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mcpapps.d.ts","sourceRoot":"","sources":["../src/mcpapps.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EACX,OAAO,EACP,WAAW,EACX,eAAe,EACf,QAAQ,EACR,SAAS,EACT,MAAM,sBAAsB,CAAC;AAqB9B;;;;GAIG;AACH,qBAAa,cAAe,YAAW,OAAO;IAC7C,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,OAAO,CAGX;IACJ,OAAO,CAAC,OAAO,CAIR;IACP,OAAO,CAAC,iBAAiB,CAAsB;;IAY/C,OAAO,CAAC,SAAS,CA+Bf;IAEF,OAAO,CAAC,OAAO;IAUT,iBAAiB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC;IAQ3C,YAAY,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC;IAK3D,eAAe,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAMzC,gBAAgB,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAM1C,kBAAkB,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI;IAOjC,cAAc,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;CAI1C"}
+{"version":3,"file":"mcpapps.d.ts","sourceRoot":"","sources":["../src/mcpapps.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EACX,OAAO,EACP,WAAW,EACX,eAAe,EACf,QAAQ,EACR,SAAS,EACT,MAAM,sBAAsB,CAAC;AAqB9B;;;;GAIG;AACH,qBAAa,cAAe,YAAW,OAAO;IAC7C,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,OAAO,CAGX;IACJ,OAAO,CAAC,OAAO,CAIR;IACP,OAAO,CAAC,iBAAiB,CAAsB;IAC/C,OAAO,CAAC,aAAa,CAAyB;;IAY9C,OAAO,CAAC,SAAS,CAmCf;IAEF,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,OAAO;IAUT,iBAAiB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC;IAQ3C,YAAY,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC;IAK3D,eAAe,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAMzC,gBAAgB,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAM1C,kBAAkB,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI;IAOjC,cAAc,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI;IAK1C,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;CAS3C"}

package/dist/mcpapps.js

@@ -1,13 +1,14 @@
 /**
  * Chat SDK implementation for Webapp and MicroFrontend surfaces using MCP Apps protocol
  * Supports: sendMessageToHost, callTool, readResource, accessToolInput, accessToolOutput,
- * accessToolMetadata (stub), onToolCanceled (stub)
+ * accessToolMetadata (stub), onToolCanceled (stub), subscribe
  */
 export class MCPAppsChatSDK {
     nextMessageId = 1;
     pending = new Map();
     globals = {};
     canceledCallbacks = [];
+    subscriptions = new Set();
     constructor() {
         // Listen for messages from parent window
         window.addEventListener("message", this.onMessage);
@@ -29,6 +30,8 @@ export class MCPAppsChatSDK {
                     this.globals.toolOutput = renderData.toolOutput;
                 }
             }
+            // Notify subscribers of data change
+            this.notifySubscribers();
         }
         // Handle message responses
         if (data.type === "ui-message-response" || data.type === "ui-message-received") {
@@ -43,9 +46,14 @@ export class MCPAppsChatSDK {
                 else {
                     slot.resolve(response.payload?.response);
                 }
+                // Notify subscribers of data change
+                this.notifySubscribers();
             }
         }
     };
+    notifySubscribers() {
+        this.subscriptions.forEach((callback) => callback());
+    }
     request(type, payload) {
         const id = String(this.nextMessageId++);
         const message = { type, messageId: id, payload };
@@ -91,4 +99,12 @@ export class MCPAppsChatSDK {
         // TODO: Implement once MCP Apps protocol specifies cancellation event
         this.canceledCallbacks.push(callback);
     }
+    subscribe(callback) {
+        // Add callback to subscriptions set
+        this.subscriptions.add(callback);
+        // Return cleanup function
+        return () => {
+            this.subscriptions.delete(callback);
+        };
+    }
 }

package/dist/openai.d.ts

@@ -3,11 +3,15 @@
  * All rights reserved.
  * For full license text, see the LICENSE.txt file
  */
-import type { ChatSDK, ChatMessage, ToolCall, ToolState } from "@salesforce/sdk-core";
+import type { ChatSDK, ChatMessage, DisplayMode, ToolCall, ToolState } from "@salesforce/sdk-core";
+/**
+ * Event type emitted by OpenAI platform when global data changes
+ */
+export declare const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
 /**
  * Chat SDK implementation for OpenAI surface
  * Supports: sendMessageToHost, callTool, accessToolInput, accessToolOutput,
- * accessToolMetadata, getWidgetState, setWidgetState
+ * accessToolMetadata, getWidgetState, setWidgetState, setDisplayMode, subscribe
  */
 export declare class OpenAIChatSDK implements ChatSDK {
     sendMessageToHost(message: ChatMessage): Promise<void>;
@@ -17,5 +21,9 @@ export declare class OpenAIChatSDK implements ChatSDK {
     accessToolMetadata<T>(): T | null;
     getWidgetState<T>(): T | null;
     setWidgetState<T>(state: T): void;
+    setDisplayMode(mode: DisplayMode): Promise<{
+        mode: DisplayMode;
+    }>;
+    subscribe(callback: () => void): () => void;
 }
 //# sourceMappingURL=openai.d.ts.map

package/dist/openai.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEtF;;;;GAIG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC5C,iBAAiB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC;IAI3C,eAAe,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAMzC,gBAAgB,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAM1C,kBAAkB,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI;IAMjC,cAAc,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI;IAM7B,cAAc,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;CAGjC"}
+{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEnG;;GAEG;AACH,eAAO,MAAM,sBAAsB,uBAAuB,CAAC;AAE3D;;;;GAIG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC5C,iBAAiB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC;IAI3C,eAAe,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAMzC,gBAAgB,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI;IAM1C,kBAAkB,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI;IAMjC,cAAc,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI;IAM7B,cAAc,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAI3B,cAAc,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,CAAC;IAIvE,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;CAW3C"}

package/dist/openai.js

@@ -1,7 +1,11 @@
+/**
+ * Event type emitted by OpenAI platform when global data changes
+ */
+export const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
 /**
  * Chat SDK implementation for OpenAI surface
  * Supports: sendMessageToHost, callTool, accessToolInput, accessToolOutput,
- * accessToolMetadata, getWidgetState, setWidgetState
+ * accessToolMetadata, getWidgetState, setWidgetState, setDisplayMode, subscribe
  */
 export class OpenAIChatSDK {
     sendMessageToHost(message) {
@@ -37,4 +41,17 @@ export class OpenAIChatSDK {
     setWidgetState(state) {
         window.openai.setWidgetState(state);
     }
+    async setDisplayMode(mode) {
+        return window.openai.requestDisplayMode({ mode });
+    }
+    subscribe(callback) {
+        // OpenAI surface emits custom event when data changes
+        const handler = () => callback();
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        window.addEventListener(SET_GLOBALS_EVENT_TYPE, handler);
+        return () => {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            window.removeEventListener(SET_GLOBALS_EVENT_TYPE, handler);
+        };
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/sdk-chat",
-  "version": "1.22.0",
+  "version": "1.30.0",
   "license": "SEE LICENSE IN LICENSE.txt",
   "type": "module",
   "main": "./dist/index.js",
@@ -26,7 +26,7 @@
     "test:coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "@salesforce/sdk-core": "^1.22.0"
+    "@salesforce/sdk-core": "^1.30.0"
   },
   "devDependencies": {
     "vitest": "^4.0.6"
@@ -34,5 +34,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f27c2343d0181dbca3f954174e89a7fa65b04274"
+  "gitHead": "544598e5263d2ea42f968854afb609359f5053b4"
 }