@salesforce/sdk-core 1.9.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1 -25
- package/dist/index.d.ts.map +1 -1
- package/dist/types.d.ts +208 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +6 -0
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -3,31 +3,6 @@
|
|
|
3
3
|
* All rights reserved.
|
|
4
4
|
* For full license text, see the LICENSE.txt file
|
|
5
5
|
*/
|
|
6
|
-
/**
|
|
7
|
-
* OpenAI SDK interface exposed on window
|
|
8
|
-
*/
|
|
9
|
-
export interface OpenAISDK {
|
|
10
|
-
sendFollowUpMessage?: (options: {
|
|
11
|
-
prompt: string;
|
|
12
|
-
}) => Promise<void>;
|
|
13
|
-
callTool?: (toolName: string, args: Record<string, unknown>) => Promise<unknown>;
|
|
14
|
-
toolInput?: Record<string, unknown>;
|
|
15
|
-
toolOutput?: Record<string, unknown> | null;
|
|
16
|
-
toolResponseMetadata?: Record<string, unknown>;
|
|
17
|
-
widgetState?: Record<string, unknown>;
|
|
18
|
-
setWidgetState?: (state: Record<string, unknown>) => void;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Salesforce ACC SDK interface exposed on window (stub)
|
|
22
|
-
* TODO: Define actual interface once specification is available
|
|
23
|
-
*/
|
|
24
|
-
export type SalesforceACCSDK = Record<string, unknown>;
|
|
25
|
-
declare global {
|
|
26
|
-
interface Window {
|
|
27
|
-
openai?: OpenAISDK;
|
|
28
|
-
salesforceACC?: SalesforceACCSDK;
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
6
|
/**
|
|
32
7
|
* Enumeration of possible runtime surfaces
|
|
33
8
|
*/
|
|
@@ -38,4 +13,5 @@ export declare enum Surface {
|
|
|
38
13
|
SalesforceACC = "Salesforce-ACC"
|
|
39
14
|
}
|
|
40
15
|
export declare function getSurface(): Surface;
|
|
16
|
+
export type { AlertOptions, ChatMessage, ChatSDK, DataSDK, GraphQLResponse, ModalOptions, OpenAISDK, ResourceRequest, SalesforceACCSDK, ToastOptions, ToolCall, ToolState, ViewSDK, } from "./types.js";
|
|
41
17
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,oBAAY,OAAO;IAClB,MAAM,WAAW;IACjB,aAAa,mBAAmB;IAChC,MAAM,WAAW;IACjB,aAAa,mBAAmB;CAChC;AAqBD,wBAAgB,UAAU,YAEzB;AAED,YAAY,EACX,YAAY,EACZ,WAAW,EACX,OAAO,EACP,OAAO,EACP,eAAe,EACf,YAAY,EACZ,SAAS,EACT,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,OAAO,GACP,MAAM,YAAY,CAAC"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2026, Salesforce, Inc.,
|
|
3
|
+
* All rights reserved.
|
|
4
|
+
* For full license text, see the LICENSE.txt file
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* OpenAI SDK interface exposed on window
|
|
8
|
+
*/
|
|
9
|
+
export interface OpenAISDK {
|
|
10
|
+
sendFollowUpMessage?: (options: {
|
|
11
|
+
prompt: string;
|
|
12
|
+
}) => Promise<void>;
|
|
13
|
+
callTool?: (toolName: string, args: Record<string, unknown>) => Promise<unknown>;
|
|
14
|
+
toolInput?: Record<string, unknown>;
|
|
15
|
+
toolOutput?: Record<string, unknown> | null;
|
|
16
|
+
toolResponseMetadata?: Record<string, unknown>;
|
|
17
|
+
widgetState?: Record<string, unknown>;
|
|
18
|
+
setWidgetState?: (state: Record<string, unknown>) => void;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Salesforce ACC SDK interface exposed on window (stub)
|
|
22
|
+
* TODO: Define actual interface once specification is available
|
|
23
|
+
*/
|
|
24
|
+
export type SalesforceACCSDK = Record<string, unknown>;
|
|
25
|
+
declare global {
|
|
26
|
+
interface Window {
|
|
27
|
+
openai?: OpenAISDK;
|
|
28
|
+
salesforceACC?: SalesforceACCSDK;
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Message payload for chat stream
|
|
33
|
+
*/
|
|
34
|
+
export interface ChatMessage {
|
|
35
|
+
content: string;
|
|
36
|
+
metadata?: Record<string, unknown>;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Tool execution payload
|
|
40
|
+
*/
|
|
41
|
+
export interface ToolCall {
|
|
42
|
+
toolName: string;
|
|
43
|
+
params?: Record<string, unknown>;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Resource read request
|
|
47
|
+
*/
|
|
48
|
+
export interface ResourceRequest {
|
|
49
|
+
uri: string;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Tool input/output state
|
|
53
|
+
*/
|
|
54
|
+
export interface ToolState<T = unknown> {
|
|
55
|
+
data: T;
|
|
56
|
+
timestamp?: number;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Chat SDK API with optional methods based on surface capabilities
|
|
60
|
+
*/
|
|
61
|
+
export interface ChatSDK {
|
|
62
|
+
/**
|
|
63
|
+
* Send a message to the host
|
|
64
|
+
*
|
|
65
|
+
* @param message - The message to send
|
|
66
|
+
*/
|
|
67
|
+
sendMessageToHost?: (message: ChatMessage) => Promise<void>;
|
|
68
|
+
/**
|
|
69
|
+
* Execute a tool on the MCP Server
|
|
70
|
+
*
|
|
71
|
+
* @param toolCall - The tool to call with parameters
|
|
72
|
+
*/
|
|
73
|
+
callTool?: <T>(toolCall: ToolCall) => Promise<T>;
|
|
74
|
+
/**
|
|
75
|
+
* Access the current tool input data
|
|
76
|
+
*
|
|
77
|
+
* @returns The tool input data or null if not available
|
|
78
|
+
*/
|
|
79
|
+
accessToolInput?: <T>() => ToolState<T> | null;
|
|
80
|
+
/**
|
|
81
|
+
* Set the tool output data
|
|
82
|
+
*
|
|
83
|
+
* @param state - The tool output state to set
|
|
84
|
+
*/
|
|
85
|
+
accessToolOutput?: <T>(state: ToolState<T>) => void;
|
|
86
|
+
/**
|
|
87
|
+
* Access metadata about the current tool
|
|
88
|
+
*
|
|
89
|
+
* @returns Tool metadata including schema, description, etc.
|
|
90
|
+
*/
|
|
91
|
+
accessToolMetadata?: <T>() => T | null;
|
|
92
|
+
/**
|
|
93
|
+
* Get the current widget state
|
|
94
|
+
*
|
|
95
|
+
* @returns The widget state or null if not available
|
|
96
|
+
*/
|
|
97
|
+
getWidgetState?: <T>() => T | null;
|
|
98
|
+
/**
|
|
99
|
+
* Set the widget state
|
|
100
|
+
*
|
|
101
|
+
* @param state - The widget state to persist
|
|
102
|
+
*/
|
|
103
|
+
setWidgetState?: <T>(state: T) => void;
|
|
104
|
+
/**
|
|
105
|
+
* Read resource content by URI
|
|
106
|
+
*
|
|
107
|
+
* @param request - The resource request with URI
|
|
108
|
+
*/
|
|
109
|
+
readResource?: <T>(request: ResourceRequest) => Promise<T>;
|
|
110
|
+
/**
|
|
111
|
+
* Register a callback for when tool execution is canceled
|
|
112
|
+
*
|
|
113
|
+
* @param callback - Function to call when tool is canceled
|
|
114
|
+
*/
|
|
115
|
+
onToolCanceled?: (callback: () => void) => void;
|
|
116
|
+
/**
|
|
117
|
+
* Get available follow-up actions
|
|
118
|
+
*
|
|
119
|
+
* @returns Array of available actions
|
|
120
|
+
*/
|
|
121
|
+
followUpActions?: <T>() => T[];
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* Alert options
|
|
125
|
+
*/
|
|
126
|
+
export interface AlertOptions {
|
|
127
|
+
/**
|
|
128
|
+
* The message to display
|
|
129
|
+
*/
|
|
130
|
+
message: string;
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Toast options
|
|
134
|
+
*/
|
|
135
|
+
export interface ToastOptions {
|
|
136
|
+
/**
|
|
137
|
+
* The message to display
|
|
138
|
+
*/
|
|
139
|
+
message: string;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Modal options
|
|
143
|
+
*/
|
|
144
|
+
export interface ModalOptions {
|
|
145
|
+
/**
|
|
146
|
+
* Modal title
|
|
147
|
+
*/
|
|
148
|
+
title: string;
|
|
149
|
+
/**
|
|
150
|
+
* Modal content (can be HTML string or component reference)
|
|
151
|
+
*/
|
|
152
|
+
content: string | unknown;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* ViewSDK API
|
|
156
|
+
*/
|
|
157
|
+
export interface ViewSDK {
|
|
158
|
+
/**
|
|
159
|
+
* Display an alert in the host
|
|
160
|
+
*
|
|
161
|
+
* @param options - Alert configuration options
|
|
162
|
+
* @returns Promise that resolves when the alert is displayed
|
|
163
|
+
*/
|
|
164
|
+
displayAlert?(options: AlertOptions): Promise<void>;
|
|
165
|
+
/**
|
|
166
|
+
* Display a toast notification in the host
|
|
167
|
+
*
|
|
168
|
+
* @param options - Toast configuration options
|
|
169
|
+
* @returns Promise that resolves when the toast is displayed
|
|
170
|
+
*/
|
|
171
|
+
displayToast?(options: ToastOptions): Promise<void>;
|
|
172
|
+
/**
|
|
173
|
+
* Display a modal in the host
|
|
174
|
+
*
|
|
175
|
+
* @param options - Modal configuration options
|
|
176
|
+
* @returns Promise that resolves when the modal is displayed
|
|
177
|
+
*/
|
|
178
|
+
displayModal?(options: ModalOptions): Promise<void>;
|
|
179
|
+
}
|
|
180
|
+
export interface DataSDK {
|
|
181
|
+
/**
|
|
182
|
+
* Run a GraphQL query
|
|
183
|
+
*
|
|
184
|
+
* @param query
|
|
185
|
+
* @param variables
|
|
186
|
+
*/
|
|
187
|
+
graphql?: <T, V = Record<string, unknown>>(query: string, variables?: V) => Promise<GraphQLResponse<T>>;
|
|
188
|
+
/**
|
|
189
|
+
* Make a request using the Fetch API.
|
|
190
|
+
*
|
|
191
|
+
* @param input - The URL or Request object
|
|
192
|
+
* @param init - Optional RequestInit configuration
|
|
193
|
+
* @returns Promise resolving to Response
|
|
194
|
+
*/
|
|
195
|
+
fetch?: typeof fetch;
|
|
196
|
+
}
|
|
197
|
+
export interface GraphQLResponse<T> {
|
|
198
|
+
data: T;
|
|
199
|
+
errors?: {
|
|
200
|
+
message: string;
|
|
201
|
+
locations?: {
|
|
202
|
+
line: number;
|
|
203
|
+
column: number;
|
|
204
|
+
}[];
|
|
205
|
+
path?: string[];
|
|
206
|
+
}[];
|
|
207
|
+
}
|
|
208
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,mBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACrE,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACjF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5C,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;CAC1D;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEvD,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,MAAM;QACf,MAAM,CAAC,EAAE,SAAS,CAAC;QACnB,aAAa,CAAC,EAAE,gBAAgB,CAAC;KACjC;CACD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,GAAG,OAAO;IACrC,IAAI,EAAE,CAAC,CAAC;IACR,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACvB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;OAIG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAE/C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAEpD;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAEvC;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAEvC;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3D;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAEhD;;;;OAIG;IACH,eAAe,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACvB;;;;;OAKG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;OAKG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;OAKG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,OAAO;IACvB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,CAAC,KACT,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACrB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,CAAC,EAAE;QACR,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAC/C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KAChB,EAAE,CAAC;CACJ"}
|
package/dist/types.js
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/sdk-core",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.10.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.js",
|
|
@@ -27,5 +27,5 @@
|
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"vitest": "^4.0.6"
|
|
29
29
|
},
|
|
30
|
-
"gitHead": "
|
|
30
|
+
"gitHead": "841b3229286b09a45f6f98af1674dc6edaab6807"
|
|
31
31
|
}
|