@memberjunction/messaging-adapters 0.0.1 → 5.17.0

package/dist/slack/slack-block-builder.d.ts

@@ -0,0 +1,133 @@
+/**
+ * @module @memberjunction/messaging-adapters
+ * @description Rich Slack Block Kit builder functions for agent responses.
+ *
+ * Composes structured Block Kit layouts from agent execution results,
+ * including agent identity headers, artifact cards, action buttons,
+ * media blocks, and metadata footers.
+ *
+ * @see https://api.slack.com/reference/block-kit
+ */
+import { ExecuteAgentResult, MJAIAgentEntityExtended, ActionableCommand, AutomaticCommand, AgentResponseForm } from '@memberjunction/ai-core-plus';
+/**
+ * Retrieve full response text by store key.
+ * Returns null if expired or not found.
+ */
+export declare function getFullResponseText(key: string): string | null;
+/**
+ * Structured payload detected in an agent result.
+ * Used for rendering rich artifact cards.
+ */
+export interface ArtifactPayload {
+    Title?: string;
+    Summary?: string;
+    Sections?: ArtifactSection[];
+    Sources?: ArtifactSource[];
+    URL?: string;
+}
+export interface ArtifactSection {
+    Heading: string;
+    Content: string;
+}
+export interface ArtifactSource {
+    Title: string;
+    URL: string;
+}
+/**
+ * Options for building a rich response layout.
+ */
+export interface BuildRichResponseOptions {
+    /** Base URL of MJ Explorer for deep-linking `open:resource` commands. */
+    explorerBaseURL?: string;
+    /** MJ Conversation Artifact ID — when provided, the Explorer link points to the artifact viewer. */
+    artifactId?: string;
+    /** MJ Conversation ID — when no artifact exists, links to the conversation in MJ Explorer. */
+    conversationId?: string;
+}
+/**
+ * Build the complete Block Kit layout for an agent response.
+ *
+ * Layout:
+ * ```
+ * [Agent Context Header]     — agent avatar + name
+ * [Divider]
+ * [Text Content Blocks]      — markdown → mrkdwn sections
+ * [Artifact Card]            — if structured payload detected
+ * [Media Blocks]             — if mediaOutputs present
+ * [Notification Blocks]      — if automatic notification commands present
+ * [Divider]
+ * [Action Buttons]           — if actionableCommands present
+ * [Metadata Footer]          — timing and token info
+ * ```
+ *
+ * Enforces Slack's 50-block limit. If exceeded, truncates text blocks
+ * and adds a truncation notice.
+ */
+export declare function buildRichResponse(result: ExecuteAgentResult | null, agent: MJAIAgentEntityExtended, responseText: string, options?: BuildRichResponseOptions): Record<string, unknown>[];
+/**
+ * Build a context block showing the agent's avatar and name.
+ */
+export declare function buildAgentContextBlock(agent: MJAIAgentEntityExtended): Record<string, unknown>;
+/**
+ * Convert markdown response text to Block Kit text sections.
+ * Reuses the existing `markdownToBlocks` logic from `slack-formatter.ts`.
+ */
+export declare function buildTextBlocks(markdown: string): Record<string, unknown>[];
+/**
+ * Build a rich artifact card from a structured payload.
+ * Renders title, summary, source links, and an optional "View Full" button.
+ */
+export declare function buildArtifactCard(artifact: ArtifactPayload): Record<string, unknown>[];
+/**
+ * Build action buttons from agent actionable commands.
+ *
+ * Handles both command types:
+ * - `open:url` → Slack URL button (opens external link)
+ * - `open:resource` → Deep-link button to MJ Explorer if `explorerBaseURL` is configured,
+ *   otherwise rendered as an informational context block showing entity/resource info
+ *
+ * Returns an array of blocks (may include both action and context blocks).
+ */
+export declare function buildActionButtons(commands: ActionableCommand[], explorerBaseURL?: string): Record<string, unknown>[];
+/**
+ * Build notification blocks from automatic commands.
+ *
+ * Only handles `notification` type automatic commands — other types
+ * (like `refresh:data`) have no meaningful Slack representation.
+ *
+ * Renders notifications as styled context blocks with severity icons.
+ */
+export declare function buildNotificationBlocks(commands: AutomaticCommand[] | undefined): Record<string, unknown>[];
+/**
+ * Build image blocks from media outputs.
+ */
+export declare function buildMediaBlocks(mediaOutputs: Record<string, unknown>[]): Record<string, unknown>[];
+/**
+ * Build a warning-styled error display block.
+ */
+export declare function buildErrorBlocks(errorMessage: string): Record<string, unknown>[];
+/**
+ * Build a metadata footer with timing and token information.
+ */
+export declare function buildMetadataFooter(result: ExecuteAgentResult): Record<string, unknown>;
+/**
+ * Build a divider block.
+ */
+export declare function buildDivider(): Record<string, unknown>;
+/**
+ * Build response form blocks from an AgentResponseForm.
+ *
+ * All forms render as a summary + a single green button that opens a Slack modal.
+ * This is agent-agnostic and avoids partial submissions — the user fills out
+ * everything in the modal and submits once.
+ */
+export declare function buildResponseForm(form: AgentResponseForm): Record<string, unknown>[];
+/**
+ * Build a Slack modal view definition from an AgentResponseForm.
+ * Used when the form contains non-choice questions that need input fields.
+ *
+ * Slack modals support: plain_text_input, number_input, datepicker, checkboxes,
+ * radio_buttons, static_select, and multi_static_select.
+ */
+export declare function buildFormModal(form: AgentResponseForm): Record<string, unknown>;
+//# sourceMappingURL=slack-block-builder.d.ts.map

package/dist/slack/slack-block-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slack-block-builder.d.ts","sourceRoot":"","sources":["../../src/slack/slack-block-builder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,iBAAiB,EAAuB,gBAAgB,EAAE,iBAAiB,EAA6B,MAAM,8BAA8B,CAAC;AAqCnM;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAQ9D;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oGAAoG;IACpG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,kBAAkB,GAAG,IAAI,EACjC,KAAK,EAAE,uBAAuB,EAC9B,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,wBAAwB,GACjC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAoD3B;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAsB9F;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAE3E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAyFtF;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAoCrH;AAkGD;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAkB3G;AAUD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAUnG;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAUhF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CA0CvF;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEtD;AAaD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAwCpF;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAwB/E"}