@paymanai/payman-ask-sdk 4.0.4 → 4.0.6

package/README.md

@@ -283,6 +283,7 @@ type ChatCallbacks = {
 | `placeholder`                   | `ui.input.placeholder`                           |
 | `emptyStateText` / `showEmptyStateIcon` / `emptyStateComponent` | `ui.emptyState.{ text, icon, content }`          |
 | `showResetSession`              | `ui.input.showResetButton`                       |
+| `enableDeepModeToggle`          | `ui.input.deepModeToggle`                        |
 | `showAttachmentButton` / `showUploadImageButton` / `showAttachFileButton` | `ui.input.attachments: boolean \| { uploadImage, attachFile }` |
 | `messageActions`                | `ui.messages.actions`                            |
 | `showAvatars` / `showUserAvatar` / `showAssistantAvatar` | `ui.messages.avatars: boolean \| { user, assistant }` |

package/dist/index.d.mts

@@ -4,6 +4,43 @@ import { MessageDisplay, AgentStage, ChatCallbacks as ChatCallbacks$1, ChatConfi
 export { APIConfig, AgentStage, ChunkDisplay, MessageDisplay, MessageRole, SessionParams, StreamEvent, StreamOptions, StreamProgress, StreamingStep, UseChatV2Return, UseVoiceReturn, UserActionRequest, UserActionResult, UserActionState, UserActionType, V2EventProcessorState, VoiceCallbacks, VoiceConfig, VoicePermissions, VoiceResult, VoiceState, buildFormattedThinking, cancelUserAction, createInitialV2State, generateId, processStreamEventV2, resendUserAction, streamWorkflowEvents, submitUserAction, useChatV2, useVoice } from '@paymanai/payman-typescript-ask-sdk';
 import { ClassValue } from 'clsx';
 
+declare const NEGATIVE_FEEDBACK_REASONS: readonly [{
+    readonly value: "NOT_FACTUALLY_CORRECT";
+    readonly label: "Not factually correct";
+}, {
+    readonly value: "INCOMPLETE_RESPONSE";
+    readonly label: "Incomplete response";
+}, {
+    readonly value: "DID_NOT_FOLLOW_REQUEST";
+    readonly label: "Did not follow my request";
+}, {
+    readonly value: "OVERACTIVE_REFUSAL";
+    readonly label: "Refused unnecessarily";
+}, {
+    readonly value: "ISSUE_WITH_THOUGHT_PROCESS";
+    readonly label: "Issue with reasoning";
+}, {
+    readonly value: "REPORT_CONTENT";
+    readonly label: "Report content";
+}, {
+    readonly value: "OTHER";
+    readonly label: "Other";
+}];
+type NegativeFeedbackReason = (typeof NEGATIVE_FEEDBACK_REASONS)[number]["value"];
+/** The full feedback value sent to the backend. */
+type FeedbackValue = "POSITIVE" | NegativeFeedbackReason;
+/**
+ * Handler threaded down to the message components. Resolves when the
+ * feedback is durably saved and rejects when the POST fails, so the UI can
+ * revert its optimistic state or surface an error.
+ */
+type SubmitFeedbackHandler = (data: {
+    messageId: string;
+    executionId?: string;
+    feedback: FeedbackValue;
+    details?: string;
+}) => Promise<void>;
+
 type UserMessageActionsConfig = {
     /** Show copy action on user messages (default: true) */
     copy?: boolean;
@@ -49,6 +86,8 @@ type ChatConfig = ChatConfig$1 & {
     voiceContinuous?: boolean;
     /** Show a "New Session" reset button inside the input bar (default: false) */
     showResetSession?: boolean;
+    /** Show the Fast/Deep analysis mode toggle in the v2 input bar (default: true). */
+    enableDeepModeToggle?: boolean;
     /** Show the v2 attachment (+) menu button in the input bar (default: true) */
     showAttachmentButton?: boolean;
     /** Show the v2 "Upload image" attachment option (default: true) */
@@ -65,6 +104,19 @@ type ChatConfig = ChatConfig$1 & {
     commandPermissions?: string[];
     /** Sentry DSN for error monitoring. */
     sentryDsn?: string;
+    /**
+     * Diagnostic mode. When `true`, the per-message Trace button opens a
+     * built-in latency timeline (fetched from
+     * `GET ${api.baseUrl}/api/ask/executions/{executionId}/trace`) that
+     * shows wall-clock duration per pipeline step. Intended for local
+     * development; off by default so production embeds never leak the
+     * trace endpoint or surface the viewer.
+     *
+     * If the consuming app passes its own `onExecutionTraceClick`
+     * callback, that wins — `debug` only installs a default handler when
+     * the consumer hasn't wired one.
+     */
+    debug?: boolean;
     /**
      * UI version to render.
      *   1 = original component set
@@ -293,11 +345,8 @@ type MessageListV2Props = {
     onRejectAction?: (messageId: string) => Promise<void>;
     /** Resend a user action */
     onResendAction?: (messageId: string) => Promise<void>;
-    /** Called when the user gives thumbs-up/down feedback */
-    onMessageFeedback?: (data: {
-        messageId: string;
-        feedback: "up" | "down";
-    }) => void;
+    /** Persist thumbs-up/down feedback (rejects on failure). */
+    onSubmitFeedback?: SubmitFeedbackHandler;
     /**
      * Speed multiplier for the typing-reveal animation.
      *   1 = default, 2 = 2x faster, 0.5 = half speed, 0 = instant reveal.

package/dist/index.d.ts

@@ -4,6 +4,43 @@ import { MessageDisplay, AgentStage, ChatCallbacks as ChatCallbacks$1, ChatConfi
 export { APIConfig, AgentStage, ChunkDisplay, MessageDisplay, MessageRole, SessionParams, StreamEvent, StreamOptions, StreamProgress, StreamingStep, UseChatV2Return, UseVoiceReturn, UserActionRequest, UserActionResult, UserActionState, UserActionType, V2EventProcessorState, VoiceCallbacks, VoiceConfig, VoicePermissions, VoiceResult, VoiceState, buildFormattedThinking, cancelUserAction, createInitialV2State, generateId, processStreamEventV2, resendUserAction, streamWorkflowEvents, submitUserAction, useChatV2, useVoice } from '@paymanai/payman-typescript-ask-sdk';
 import { ClassValue } from 'clsx';
 
+declare const NEGATIVE_FEEDBACK_REASONS: readonly [{
+    readonly value: "NOT_FACTUALLY_CORRECT";
+    readonly label: "Not factually correct";
+}, {
+    readonly value: "INCOMPLETE_RESPONSE";
+    readonly label: "Incomplete response";
+}, {
+    readonly value: "DID_NOT_FOLLOW_REQUEST";
+    readonly label: "Did not follow my request";
+}, {
+    readonly value: "OVERACTIVE_REFUSAL";
+    readonly label: "Refused unnecessarily";
+}, {
+    readonly value: "ISSUE_WITH_THOUGHT_PROCESS";
+    readonly label: "Issue with reasoning";
+}, {
+    readonly value: "REPORT_CONTENT";
+    readonly label: "Report content";
+}, {
+    readonly value: "OTHER";
+    readonly label: "Other";
+}];
+type NegativeFeedbackReason = (typeof NEGATIVE_FEEDBACK_REASONS)[number]["value"];
+/** The full feedback value sent to the backend. */
+type FeedbackValue = "POSITIVE" | NegativeFeedbackReason;
+/**
+ * Handler threaded down to the message components. Resolves when the
+ * feedback is durably saved and rejects when the POST fails, so the UI can
+ * revert its optimistic state or surface an error.
+ */
+type SubmitFeedbackHandler = (data: {
+    messageId: string;
+    executionId?: string;
+    feedback: FeedbackValue;
+    details?: string;
+}) => Promise<void>;
+
 type UserMessageActionsConfig = {
     /** Show copy action on user messages (default: true) */
     copy?: boolean;
@@ -49,6 +86,8 @@ type ChatConfig = ChatConfig$1 & {
     voiceContinuous?: boolean;
     /** Show a "New Session" reset button inside the input bar (default: false) */
     showResetSession?: boolean;
+    /** Show the Fast/Deep analysis mode toggle in the v2 input bar (default: true). */
+    enableDeepModeToggle?: boolean;
     /** Show the v2 attachment (+) menu button in the input bar (default: true) */
     showAttachmentButton?: boolean;
     /** Show the v2 "Upload image" attachment option (default: true) */
@@ -65,6 +104,19 @@ type ChatConfig = ChatConfig$1 & {
     commandPermissions?: string[];
     /** Sentry DSN for error monitoring. */
     sentryDsn?: string;
+    /**
+     * Diagnostic mode. When `true`, the per-message Trace button opens a
+     * built-in latency timeline (fetched from
+     * `GET ${api.baseUrl}/api/ask/executions/{executionId}/trace`) that
+     * shows wall-clock duration per pipeline step. Intended for local
+     * development; off by default so production embeds never leak the
+     * trace endpoint or surface the viewer.
+     *
+     * If the consuming app passes its own `onExecutionTraceClick`
+     * callback, that wins — `debug` only installs a default handler when
+     * the consumer hasn't wired one.
+     */
+    debug?: boolean;
     /**
      * UI version to render.
      *   1 = original component set
@@ -293,11 +345,8 @@ type MessageListV2Props = {
     onRejectAction?: (messageId: string) => Promise<void>;
     /** Resend a user action */
     onResendAction?: (messageId: string) => Promise<void>;
-    /** Called when the user gives thumbs-up/down feedback */
-    onMessageFeedback?: (data: {
-        messageId: string;
-        feedback: "up" | "down";
-    }) => void;
+    /** Persist thumbs-up/down feedback (rejects on failure). */
+    onSubmitFeedback?: SubmitFeedbackHandler;
     /**
      * Speed multiplier for the typing-reveal animation.
      *   1 = default, 2 = 2x faster, 0.5 = half speed, 0 = instant reveal.