@cuylabs/channel-slack-agent-core 0.10.0 → 0.12.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.
Files changed (56) hide show
  1. package/README.md +18 -11
  2. package/dist/{chunk-L5RAGYVJ.js → chunk-U6RC4SXN.js} +87 -1
  3. package/dist/history/index.d.ts +7 -17
  4. package/dist/index.d.ts +2 -29
  5. package/dist/index.js +12 -64
  6. package/dist/shared/index.d.ts +146 -10
  7. package/dist/shared/index.js +4 -4
  8. package/docs/README.md +2 -4
  9. package/docs/concepts/final-response-artifacts.md +9 -7
  10. package/docs/concepts/interactive-requests.md +31 -26
  11. package/docs/concepts/tool-task-rendering.md +2 -0
  12. package/docs/reference/boundary.md +6 -4
  13. package/docs/reference/exports.md +14 -20
  14. package/package.json +4 -59
  15. package/dist/adapter/index.d.ts +0 -26
  16. package/dist/adapter/index.js +0 -9
  17. package/dist/adapter-vbqtraAr.d.ts +0 -31
  18. package/dist/app-surface.d.ts +0 -82
  19. package/dist/app-surface.js +0 -10
  20. package/dist/app.d.ts +0 -60
  21. package/dist/app.js +0 -11
  22. package/dist/artifacts/index.d.ts +0 -57
  23. package/dist/artifacts/index.js +0 -6
  24. package/dist/assistant/index.d.ts +0 -22
  25. package/dist/assistant/index.js +0 -14
  26. package/dist/chunk-6EMFBOXD.js +0 -67
  27. package/dist/chunk-A2PLAVW6.js +0 -75
  28. package/dist/chunk-C7CHMYV6.js +0 -226
  29. package/dist/chunk-DS6E5OEJ.js +0 -85
  30. package/dist/chunk-ELR6MQD7.js +0 -12
  31. package/dist/chunk-GEFK72VO.js +0 -921
  32. package/dist/chunk-KQPUQJ57.js +0 -482
  33. package/dist/chunk-NNCVHQC4.js +0 -94
  34. package/dist/chunk-OP27SSZU.js +0 -409
  35. package/dist/chunk-P2DIC42J.js +0 -77
  36. package/dist/chunk-Q2GU4QLZ.js +0 -187
  37. package/dist/chunk-QFDXKCAQ.js +0 -82
  38. package/dist/express-assistant.d.ts +0 -106
  39. package/dist/express-assistant.js +0 -9
  40. package/dist/express.d.ts +0 -103
  41. package/dist/express.js +0 -8
  42. package/dist/feedback/index.d.ts +0 -1
  43. package/dist/feedback/index.js +0 -10
  44. package/dist/interactive/index.d.ts +0 -11
  45. package/dist/interactive/index.js +0 -6
  46. package/dist/interactive-BigrPKnu.d.ts +0 -30
  47. package/dist/options-ByNm2o89.d.ts +0 -323
  48. package/dist/options-CGUfVStV.d.ts +0 -119
  49. package/dist/socket.d.ts +0 -143
  50. package/dist/socket.js +0 -13
  51. package/dist/types-BeGPexio.d.ts +0 -381
  52. package/dist/types-Bz4OYEAV.d.ts +0 -87
  53. package/dist/types-CiwGU6zC.d.ts +0 -56
  54. package/dist/views/index.d.ts +0 -8
  55. package/dist/views/index.js +0 -10
  56. package/docs/concepts/view-workflows.md +0 -52
@@ -1,482 +0,0 @@
1
- import {
2
- UnsupportedSlackInteractiveRequestError,
3
- bridgeAgentEventsToSlack,
4
- resolveSlackEventBridgeOptions
5
- } from "./chunk-L5RAGYVJ.js";
6
-
7
- // src/adapter/adapter.ts
8
- import { withinScope } from "@cuylabs/agent-core";
9
- import {
10
- extractSlackAuthContext,
11
- extractSlackUserIdentity,
12
- isProcessableMessage,
13
- parseSlackMentionActivity,
14
- parseSlackMessageActivity,
15
- resolveSlackMessageFormatter,
16
- runWithSlackTurnContext
17
- } from "@cuylabs/channel-slack/core";
18
-
19
- // src/adapter/session-map.ts
20
- import {
21
- resolveThreadAwareSlackSessionId
22
- } from "@cuylabs/channel-slack/core";
23
- function createSlackSessionMap(options) {
24
- const strategy = options.sessionStrategy ?? "thread-aware";
25
- if (strategy === "custom") {
26
- if (!options.resolveSessionId) {
27
- throw new Error(
28
- "SlackChannelOptions.resolveSessionId is required when sessionStrategy is 'custom'"
29
- );
30
- }
31
- const customResolve = options.resolveSessionId;
32
- return {
33
- resolve(info) {
34
- return customResolve(info);
35
- }
36
- };
37
- }
38
- if (strategy === "channel-id") {
39
- return {
40
- resolve(info) {
41
- return info.channelId;
42
- }
43
- };
44
- }
45
- if (strategy === "user-per-channel") {
46
- return {
47
- resolve(info) {
48
- return `${info.channelId}:${info.userId}`;
49
- }
50
- };
51
- }
52
- if (strategy === "user-per-thread") {
53
- return {
54
- resolve(info) {
55
- if (info.channelType === "dm") {
56
- return `${info.channelId}:${info.userId}`;
57
- }
58
- return `${info.channelId}:${info.threadTs ?? info.messageTs ?? info.channelId}:${info.userId}`;
59
- }
60
- };
61
- }
62
- return {
63
- resolve: resolveThreadAwareSlackSessionId
64
- };
65
- }
66
-
67
- // src/adapter/sink.ts
68
- function buildThreadPayload(info, respondInThread) {
69
- if (!respondInThread || info.channelType === "dm") return {};
70
- const threadTs = info.threadTs ?? info.messageTs;
71
- return threadTs ? { thread_ts: threadTs } : {};
72
- }
73
- function buildResponseSink(say, client, info, respondInThread, chatStreamStartArgs, sayStream) {
74
- const threadPayload = buildThreadPayload(info, respondInThread);
75
- return {
76
- artifactClient: client,
77
- artifactTarget: {
78
- channelId: info.channelId,
79
- ...threadPayload.thread_ts ? { threadTs: threadPayload.thread_ts } : {}
80
- },
81
- async postMessage(text) {
82
- const result = await say({ text, ...threadPayload });
83
- const response = result;
84
- const { channel, ts } = response;
85
- if (!channel || !ts) {
86
- throw new Error("Slack say() response did not include channel and ts.");
87
- }
88
- return { channel, ts };
89
- },
90
- async updateMessage(channel, ts, text) {
91
- await client.chat.update({ channel, ts, text });
92
- },
93
- createChatStream({ bufferSize }) {
94
- const threadTs = threadPayload.thread_ts ?? info.messageTs;
95
- if (!threadTs) {
96
- throw new Error(
97
- "Slack chat-stream mode requires a source message timestamp."
98
- );
99
- }
100
- const streamArgs = {
101
- ...chatStreamStartArgs ?? {},
102
- buffer_size: bufferSize
103
- };
104
- if (typeof sayStream === "function") {
105
- return sayStream(streamArgs);
106
- }
107
- const streamer = client.chatStream({
108
- channel: info.channelId,
109
- thread_ts: threadTs,
110
- ...info.teamId ? { recipient_team_id: info.teamId } : {},
111
- recipient_user_id: info.userId,
112
- ...streamArgs
113
- });
114
- return streamer;
115
- }
116
- };
117
- }
118
- function buildInteractiveResponder(say, client, info, respondInThread) {
119
- const threadPayload = buildThreadPayload(info, respondInThread);
120
- return {
121
- async postMessage(message) {
122
- const result = await say({
123
- text: message.text,
124
- ...message.blocks ? { blocks: message.blocks } : {},
125
- ...threadPayload
126
- });
127
- const response = result;
128
- const channel = response.channel ?? info.channelId;
129
- const ts = response.ts;
130
- if (!channel || !ts) {
131
- throw new Error("Slack say() response did not include channel and ts.");
132
- }
133
- return { channel, ts };
134
- },
135
- async updateMessage(ref, message) {
136
- await client.chat.update({
137
- channel: ref.channel,
138
- ts: ref.ts,
139
- text: message.text,
140
- ...message.blocks ? { blocks: message.blocks } : {}
141
- });
142
- }
143
- };
144
- }
145
-
146
- // src/adapter/scope-attributes.ts
147
- function buildScopeAttributes(info, user, prep) {
148
- return {
149
- slackChannelId: info.channelId,
150
- slackChannelType: info.channelType,
151
- slackUserId: user.userId,
152
- slackTeamId: user.teamId,
153
- slackThreadTs: info.threadTs,
154
- slackIsMention: info.isMention,
155
- ...prep.scopeAttributes ?? {}
156
- };
157
- }
158
-
159
- // src/adapter/adapter.ts
160
- var DEFAULT_CLASSIC_INITIAL_STATUS = {
161
- status: "Thinking..."
162
- };
163
- function createSlackChannelAdapter(options) {
164
- const source = resolveTurnSource(options);
165
- const sessionMap = createSlackSessionMap(options);
166
- const bridgeOptions = resolveSlackEventBridgeOptions(
167
- {
168
- showReasoning: options.showReasoning,
169
- showToolUsage: options.showToolUsage,
170
- showSubagentToolUsage: options.showSubagentToolUsage,
171
- showSubagentResultInTask: options.showSubagentResultInTask,
172
- formatToolTitle: options.formatToolTitle,
173
- formatToolUpdate: options.formatToolUpdate,
174
- formatToolDetails: options.formatToolDetails,
175
- formatToolResultOutput: options.formatToolResultOutput,
176
- formatToolError: options.formatToolError,
177
- formatReasoningUpdate: options.formatReasoningUpdate,
178
- interactiveMode: options.interactiveMode,
179
- formatApprovalRequired: options.formatApprovalRequired,
180
- formatHumanInputRequired: options.formatHumanInputRequired,
181
- formatMessageText: resolveSlackMessageFormatter(options),
182
- streamingMode: options.streamingMode,
183
- progressiveUpdateThreshold: options.progressiveUpdateThreshold,
184
- progressiveUpdateIntervalMs: options.progressiveUpdateIntervalMs,
185
- chatStreamBufferSize: options.chatStreamBufferSize,
186
- maxTaskUpdates: options.maxTaskUpdates,
187
- maxTaskUpdateTextChars: options.maxTaskUpdateTextChars,
188
- maxTaskUpdateFieldChars: options.maxTaskUpdateFieldChars,
189
- chatStreamFinalArgs: options.chatStreamFinalArgs,
190
- publishFinalResponseArtifact: options.publishFinalResponseArtifact,
191
- finalResponseArtifactMode: options.finalResponseArtifactMode,
192
- finalResponseArtifactStreamThreshold: options.finalResponseArtifactStreamThreshold,
193
- formatFinalResponseArtifactContinuationNotice: options.formatFinalResponseArtifactContinuationNotice,
194
- formatFinalResponseArtifactMessage: options.formatFinalResponseArtifactMessage,
195
- onFinalResponseArtifactError: options.onFinalResponseArtifactError
196
- }
197
- );
198
- const timeout = options.timeout ?? 12e4;
199
- const respondInThread = options.respondInThread ?? true;
200
- const respondToMentions = options.respondToMentions ?? true;
201
- const respondToMessages = options.respondToMessages ?? true;
202
- const respondToChannelMessages = options.respondToChannelMessages ?? false;
203
- async function processTurn(slackActivity, say, client, context, utilities = {}) {
204
- const rawText = slackActivity.text.trim();
205
- const userText = options.resolveMessage ? await options.resolveMessage(slackActivity) : rawText;
206
- if (!userText) return;
207
- const initialSessionId = await sessionMap.resolve(slackActivity);
208
- const userIdentity = extractSlackUserIdentity(slackActivity);
209
- const auth = extractSlackAuthContext(context, slackActivity.userId);
210
- const hasSayStream = typeof utilities.sayStream === "function";
211
- const hasSetStatus = typeof utilities.setStatus === "function";
212
- options.logger?.debug?.("slack classic turn utilities", {
213
- channelId: slackActivity.channelId,
214
- channelType: slackActivity.channelType,
215
- isMention: slackActivity.isMention,
216
- threadTs: slackActivity.threadTs,
217
- messageTs: slackActivity.messageTs,
218
- hasSayStream,
219
- hasSetStatus
220
- });
221
- const baseTurnRequest = {
222
- slackActivity,
223
- user: userIdentity,
224
- sessionId: initialSessionId,
225
- message: userText,
226
- auth,
227
- ...utilities.setStatus ? { setStatus: utilities.setStatus } : {}
228
- };
229
- if (utilities.setStatus) {
230
- const initialStatus = await resolveClassicInitialStatus(
231
- options,
232
- baseTurnRequest
233
- );
234
- if (initialStatus) {
235
- try {
236
- await utilities.setStatus(initialStatus);
237
- } catch (error) {
238
- options.logger?.warn?.("slack classic setStatus failed", {
239
- error: formatErrorForLog(error)
240
- });
241
- }
242
- }
243
- }
244
- const resolvedSessionId = await options.resolveSession?.(baseTurnRequest);
245
- const sessionId = resolvedSessionId && resolvedSessionId.length > 0 ? resolvedSessionId : initialSessionId;
246
- const turnRequest = {
247
- ...baseTurnRequest,
248
- sessionId
249
- };
250
- const preparedTurn = await resolveTurnPreparation(
251
- options,
252
- turnRequest,
253
- userIdentity
254
- );
255
- const finalSessionId = preparedTurn.sessionId && preparedTurn.sessionId.length > 0 ? preparedTurn.sessionId : sessionId;
256
- const finalUserText = preparedTurn.message ?? userText;
257
- const sink = buildResponseSink(
258
- say,
259
- client,
260
- slackActivity,
261
- respondInThread,
262
- options.chatStreamStartArgs,
263
- utilities.sayStream
264
- );
265
- const abortController = new AbortController();
266
- const chatOptions = {
267
- abort: abortController.signal
268
- };
269
- if (preparedTurn.system) {
270
- chatOptions.system = preparedTurn.system;
271
- }
272
- const timeoutId = timeout > 0 ? setTimeout(() => abortController.abort(), timeout) : void 0;
273
- try {
274
- const scopeAttributes = buildScopeAttributes(
275
- slackActivity,
276
- userIdentity,
277
- preparedTurn
278
- );
279
- await runWithSlackTurnContext(
280
- {
281
- ...turnRequest,
282
- sessionId: finalSessionId,
283
- message: finalUserText,
284
- ...utilities.setStatus ? { setStatus: utilities.setStatus } : {},
285
- ...preparedTurn.context ? { context: preparedTurn.context } : {}
286
- },
287
- () => withinScope(
288
- {
289
- kind: "activity",
290
- name: preparedTurn.scopeName?.trim() || "slack-activity",
291
- sessionId: finalSessionId,
292
- attributes: scopeAttributes
293
- },
294
- async () => {
295
- const events = source.chat(
296
- finalSessionId,
297
- finalUserText,
298
- chatOptions
299
- );
300
- const baseTurnBridgeOptions = options.handleInteractiveRequest ? {
301
- ...bridgeOptions,
302
- handleInteractiveRequest: (interactive) => options.handleInteractiveRequest({
303
- ...interactive,
304
- slackActivity,
305
- user: userIdentity,
306
- sessionId: finalSessionId,
307
- message: finalUserText,
308
- responder: buildInteractiveResponder(
309
- say,
310
- client,
311
- slackActivity,
312
- respondInThread
313
- )
314
- })
315
- } : bridgeOptions;
316
- const turnBridgeOptions = withClassicStatusUpdates(
317
- baseTurnBridgeOptions,
318
- utilities.setStatus
319
- );
320
- await bridgeAgentEventsToSlack(events, sink, turnBridgeOptions);
321
- }
322
- )
323
- );
324
- } catch (error) {
325
- const errorInstance = error instanceof Error ? error : new Error(String(error));
326
- if (!(errorInstance instanceof UnsupportedSlackInteractiveRequestError)) {
327
- await say({
328
- text: `I encountered an error while processing your request: ${errorInstance.message}`,
329
- ...buildThreadPayload(slackActivity, respondInThread)
330
- }).catch(() => void 0);
331
- }
332
- if (options.onError) {
333
- await options.onError(errorInstance, slackActivity);
334
- }
335
- } finally {
336
- if (timeoutId) {
337
- clearTimeout(timeoutId);
338
- }
339
- if (utilities.setStatus) {
340
- await utilities.setStatus({ status: "" }).catch(
341
- (error) => options.logger?.warn?.("slack classic clear status failed", {
342
- error: formatErrorForLog(error)
343
- })
344
- );
345
- }
346
- }
347
- }
348
- function mount(app) {
349
- if (respondToMessages) {
350
- app.message(
351
- async ({
352
- message,
353
- say,
354
- client,
355
- context,
356
- sayStream,
357
- setStatus
358
- }) => {
359
- const raw = message;
360
- if (!isProcessableMessage(
361
- raw
362
- )) {
363
- return;
364
- }
365
- const info = parseSlackMessageActivity(
366
- raw
367
- );
368
- if (info.channelType !== "dm" && !respondToChannelMessages) {
369
- return;
370
- }
371
- if (!info.text) return;
372
- await processTurn(info, say, client, context, {
373
- ...typeof sayStream === "function" ? { sayStream } : {},
374
- ...typeof setStatus === "function" ? { setStatus } : {}
375
- });
376
- }
377
- );
378
- }
379
- if (respondToMentions) {
380
- app.event(
381
- "app_mention",
382
- async ({
383
- event,
384
- say,
385
- client,
386
- context,
387
- sayStream,
388
- setStatus
389
- }) => {
390
- const info = parseSlackMentionActivity(
391
- event
392
- );
393
- if (!info.text) return;
394
- await processTurn(info, say, client, context, {
395
- ...typeof sayStream === "function" ? { sayStream } : {},
396
- ...typeof setStatus === "function" ? { setStatus } : {}
397
- });
398
- }
399
- );
400
- }
401
- if (options.welcomeMessage != null) {
402
- app.event("member_joined_channel", async ({ event, client }) => {
403
- const channelId = event.channel;
404
- const userId = event.user;
405
- const botInfo = await client.auth.test().catch(() => void 0);
406
- if (botInfo?.user_id === userId) return;
407
- await client.chat.postMessage({
408
- channel: userId,
409
- // DM the new member
410
- text: options.welcomeMessage
411
- }).catch(() => void 0);
412
- await client.chat.postMessage({
413
- channel: channelId,
414
- text: options.welcomeMessage
415
- }).catch(() => void 0);
416
- });
417
- }
418
- }
419
- return {
420
- mount,
421
- getSessionId: (info) => sessionMap.resolve(info)
422
- };
423
- }
424
- function formatClassicSlackStatusUpdate(status) {
425
- return { status };
426
- }
427
- async function resolveClassicInitialStatus(options, request) {
428
- if (options.initialStatus === void 0) {
429
- return DEFAULT_CLASSIC_INITIAL_STATUS;
430
- }
431
- if (typeof options.initialStatus === "function") {
432
- return await options.initialStatus(request) ?? void 0;
433
- }
434
- return options.initialStatus;
435
- }
436
- function withClassicStatusUpdates(options, setStatus) {
437
- if (!setStatus) {
438
- return options;
439
- }
440
- return {
441
- ...options,
442
- onStatusChange: async (label, event) => {
443
- await options.onStatusChange?.(label, event);
444
- await setStatus(formatClassicSlackStatusUpdate(label));
445
- }
446
- };
447
- }
448
- function resolveTurnSource(options) {
449
- const hasAgent = options.agent !== void 0;
450
- const hasSource = options.source !== void 0;
451
- if (hasAgent === hasSource) {
452
- throw new Error(
453
- "Provide exactly one of SlackChannelOptions.agent or SlackChannelOptions.source."
454
- );
455
- }
456
- if (options.source) return options.source;
457
- if (options.agent) return options.agent;
458
- throw new Error(
459
- "Provide exactly one of SlackChannelOptions.agent or SlackChannelOptions.source."
460
- );
461
- }
462
- async function resolveTurnPreparation(options, request, user) {
463
- if (options.prepareTurn) {
464
- return await options.prepareTurn(request) ?? {};
465
- }
466
- if (options.resolveUserContext) {
467
- const ctx = await options.resolveUserContext(user);
468
- return ctx ?? {};
469
- }
470
- return {};
471
- }
472
- function formatErrorForLog(error) {
473
- if (error instanceof Error) {
474
- return error.stack ?? error.message;
475
- }
476
- return String(error);
477
- }
478
-
479
- export {
480
- createSlackSessionMap,
481
- createSlackChannelAdapter
482
- };
@@ -1,94 +0,0 @@
1
- // src/artifacts/final-response.ts
2
- import {
3
- publishSlackCanvasArtifact,
4
- publishSlackTextArtifact
5
- } from "@cuylabs/channel-slack/artifacts";
6
- var DEFAULT_MIN_CHARACTERS = 4e3;
7
- var DEFAULT_TITLE = "Agent response";
8
- function createSlackFinalResponseArtifactPublisher({
9
- minCharacters = DEFAULT_MIN_CHARACTERS,
10
- title = DEFAULT_TITLE,
11
- summary,
12
- channelCanvas = true,
13
- fallback = "file",
14
- onPublished,
15
- onError
16
- } = {}) {
17
- const configuredThreshold = Math.floor(minCharacters);
18
- const threshold = Number.isFinite(configuredThreshold) && configuredThreshold > 0 ? configuredThreshold : DEFAULT_MIN_CHARACTERS;
19
- return async (context) => {
20
- const text = context.text.trim();
21
- if (text.length < threshold) {
22
- return void 0;
23
- }
24
- const resolvedTitle = normalizeText(await resolveValue(title, context)) ?? DEFAULT_TITLE;
25
- const resolvedSummary = normalizeText(await resolveValue(summary, context));
26
- let lastError;
27
- try {
28
- const publication = await publishSlackCanvasArtifact({
29
- client: context.client,
30
- channelId: context.channelId,
31
- ...context.threadTs ? { threadTs: context.threadTs } : {},
32
- artifact: {
33
- kind: "canvas",
34
- title: resolvedTitle,
35
- markdown: text,
36
- channelCanvas,
37
- ...resolvedSummary ? { summary: resolvedSummary } : {},
38
- metadata: {
39
- source: "slack-final-response",
40
- characterCount: text.length
41
- }
42
- }
43
- });
44
- const result = { publication };
45
- await onPublished?.(result, context);
46
- return result;
47
- } catch (error) {
48
- lastError = error;
49
- }
50
- if (fallback === "file") {
51
- try {
52
- const publication = await publishSlackTextArtifact({
53
- client: context.client,
54
- channelId: context.channelId,
55
- ...context.threadTs ? { threadTs: context.threadTs } : {},
56
- artifact: {
57
- kind: "text",
58
- title: resolvedTitle,
59
- text,
60
- filename: filenameFromTitle(resolvedTitle),
61
- ...resolvedSummary ? { summary: resolvedSummary } : {},
62
- metadata: {
63
- source: "slack-final-response",
64
- characterCount: text.length,
65
- canvasFallback: true
66
- }
67
- }
68
- });
69
- const result = { publication };
70
- await onPublished?.(result, context);
71
- return result;
72
- } catch (error) {
73
- lastError = error;
74
- }
75
- }
76
- await onError?.(lastError, context);
77
- return void 0;
78
- };
79
- }
80
- async function resolveValue(value, context) {
81
- return typeof value === "function" ? await value(context) : value;
82
- }
83
- function normalizeText(value) {
84
- const trimmed = value?.trim();
85
- return trimmed ? trimmed : void 0;
86
- }
87
- function filenameFromTitle(title) {
88
- const slug = title.trim().toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
89
- return `${slug || "agent-response"}.txt`;
90
- }
91
-
92
- export {
93
- createSlackFinalResponseArtifactPublisher
94
- };