@paymanai/payman-typescript-ask-sdk 1.2.8 → 1.2.10

package/dist/index.d.mts

@@ -126,6 +126,10 @@ type MessageDisplay = {
     activeThinkingText?: string;
     /** All thinking accumulated across blocks (for post-stream display) */
     allThinkingText?: string;
+    /** Pre-formatted thinking text built from steps + allThinkingText (v2 streaming format, matches demo) */
+    formattedThinkingText?: string;
+    /** True while RAG image URLs are being resolved after the final response is shown */
+    isResolvingImages?: boolean;
 };
 type SessionParams = {
     id?: string;
@@ -141,6 +145,8 @@ type APIConfig = {
     headers?: Record<string, string>;
     /** API endpoint for streaming (default: /api/workflows/ask/stream) */
     streamEndpoint?: string;
+    /** API endpoint for resolving RAG image URLs (default: /api/playground/ask/resolve-image-urls) */
+    resolveImagesEndpoint?: string;
 };
 type ChatConfig = {
     /** API configuration - required for the library to make calls */
@@ -250,6 +256,24 @@ type UseChatReturn = {
 };
 declare function useChat(config: ChatConfig, callbacks?: ChatCallbacks): UseChatReturn;
 
+type UseChatV2Return = {
+    messages: MessageDisplay[];
+    sendMessage: (userMessage: string) => Promise<void>;
+    clearMessages: () => void;
+    prependMessages: (messages: MessageDisplay[]) => void;
+    cancelStream: () => void;
+    resetSession: () => void;
+    getSessionId: () => string | undefined;
+    getMessages: () => MessageDisplay[];
+    isWaitingForResponse: boolean;
+    sessionId: string | undefined;
+    userActionState: UserActionState;
+    approveUserAction: (otp: string) => Promise<void>;
+    rejectUserAction: () => Promise<void>;
+    resendOtp: () => Promise<void>;
+};
+declare function useChatV2(config: ChatConfig, callbacks?: ChatCallbacks): UseChatV2Return;
+
 interface SpeechRecognitionEvent extends Event {
     results: SpeechRecognitionResultList;
     resultIndex: number;
@@ -322,6 +346,37 @@ type StreamOptions = {
  */
 declare function streamWorkflowEvents(url: string, body: Record<string, unknown>, headers: Record<string, string>, options?: StreamOptions): Promise<void>;
 
+/**
+ * Build a richly-formatted thinking string from the SDK's `steps` array
+ * and raw `allThinkingText`. This matches the demo's streaming format
+ * so both the SDK and demo produce identical thinking output.
+ *
+ * The SDK's `allThinkingText` only contains raw `INTENT_THINKING_CONT`
+ * deltas — no phase headers. This function reconstructs the full format
+ * from the steps array, which stores every event the SDK processes.
+ */
+declare function buildFormattedThinking(steps: StreamingStep[] | undefined, allThinkingText: string): string;
+
+type V2EventProcessorState = {
+    formattedThinkingText: string;
+    finalResponse: string;
+    currentWorker: string;
+    lastEventType: string;
+    sessionId?: string;
+    executionId?: string;
+    hasError: boolean;
+    errorMessage: string;
+    userActionRequest?: UserActionRequest;
+    userActionPending: boolean;
+    userActionResult?: UserActionResult;
+    finalData?: unknown;
+    steps: StreamingStep[];
+    stepCounter: number;
+    currentExecutingStepId?: string;
+};
+declare function createInitialV2State(): V2EventProcessorState;
+declare function processStreamEventV2(event: StreamEvent, state: V2EventProcessorState): V2EventProcessorState;
+
 type UserActionResponse = {
     success: boolean;
     message: string;
@@ -339,4 +394,4 @@ declare function cancelUserAction(config: ChatConfig, userActionId: string): Pro
  */
 declare function resendUserAction(config: ChatConfig, userActionId: string): Promise<UserActionResponse>;
 
-export { type APIConfig, type ChatCallbacks, type ChatConfig, type ChunkDisplay, type MessageDisplay, type MessageRole, type SessionParams, type StreamEvent, type StreamOptions, type StreamProgress, type StreamingStep, type UseChatReturn, type UseVoiceReturn, type UserActionRequest, type UserActionResult, type UserActionState, type UserActionType, type VoiceCallbacks, type VoiceConfig, type VoicePermissions, type VoiceResult, type VoiceState, type WorkflowStage, cancelUserAction, generateId, resendUserAction, streamWorkflowEvents, submitUserAction, useChat, useVoice };
+export { type APIConfig, type ChatCallbacks, type ChatConfig, type ChunkDisplay, type MessageDisplay, type MessageRole, type SessionParams, type StreamEvent, type StreamOptions, type StreamProgress, type StreamingStep, type UseChatReturn, type UseChatV2Return, type UseVoiceReturn, type UserActionRequest, type UserActionResult, type UserActionState, type UserActionType, type V2EventProcessorState, type VoiceCallbacks, type VoiceConfig, type VoicePermissions, type VoiceResult, type VoiceState, type WorkflowStage, buildFormattedThinking, cancelUserAction, createInitialV2State, generateId, processStreamEventV2, resendUserAction, streamWorkflowEvents, submitUserAction, useChat, useChatV2, useVoice };

package/dist/index.d.ts

@@ -126,6 +126,10 @@ type MessageDisplay = {
     activeThinkingText?: string;
     /** All thinking accumulated across blocks (for post-stream display) */
     allThinkingText?: string;
+    /** Pre-formatted thinking text built from steps + allThinkingText (v2 streaming format, matches demo) */
+    formattedThinkingText?: string;
+    /** True while RAG image URLs are being resolved after the final response is shown */
+    isResolvingImages?: boolean;
 };
 type SessionParams = {
     id?: string;
@@ -141,6 +145,8 @@ type APIConfig = {
     headers?: Record<string, string>;
     /** API endpoint for streaming (default: /api/workflows/ask/stream) */
     streamEndpoint?: string;
+    /** API endpoint for resolving RAG image URLs (default: /api/playground/ask/resolve-image-urls) */
+    resolveImagesEndpoint?: string;
 };
 type ChatConfig = {
     /** API configuration - required for the library to make calls */
@@ -250,6 +256,24 @@ type UseChatReturn = {
 };
 declare function useChat(config: ChatConfig, callbacks?: ChatCallbacks): UseChatReturn;
 
+type UseChatV2Return = {
+    messages: MessageDisplay[];
+    sendMessage: (userMessage: string) => Promise<void>;
+    clearMessages: () => void;
+    prependMessages: (messages: MessageDisplay[]) => void;
+    cancelStream: () => void;
+    resetSession: () => void;
+    getSessionId: () => string | undefined;
+    getMessages: () => MessageDisplay[];
+    isWaitingForResponse: boolean;
+    sessionId: string | undefined;
+    userActionState: UserActionState;
+    approveUserAction: (otp: string) => Promise<void>;
+    rejectUserAction: () => Promise<void>;
+    resendOtp: () => Promise<void>;
+};
+declare function useChatV2(config: ChatConfig, callbacks?: ChatCallbacks): UseChatV2Return;
+
 interface SpeechRecognitionEvent extends Event {
     results: SpeechRecognitionResultList;
     resultIndex: number;
@@ -322,6 +346,37 @@ type StreamOptions = {
  */
 declare function streamWorkflowEvents(url: string, body: Record<string, unknown>, headers: Record<string, string>, options?: StreamOptions): Promise<void>;
 
+/**
+ * Build a richly-formatted thinking string from the SDK's `steps` array
+ * and raw `allThinkingText`. This matches the demo's streaming format
+ * so both the SDK and demo produce identical thinking output.
+ *
+ * The SDK's `allThinkingText` only contains raw `INTENT_THINKING_CONT`
+ * deltas — no phase headers. This function reconstructs the full format
+ * from the steps array, which stores every event the SDK processes.
+ */
+declare function buildFormattedThinking(steps: StreamingStep[] | undefined, allThinkingText: string): string;
+
+type V2EventProcessorState = {
+    formattedThinkingText: string;
+    finalResponse: string;
+    currentWorker: string;
+    lastEventType: string;
+    sessionId?: string;
+    executionId?: string;
+    hasError: boolean;
+    errorMessage: string;
+    userActionRequest?: UserActionRequest;
+    userActionPending: boolean;
+    userActionResult?: UserActionResult;
+    finalData?: unknown;
+    steps: StreamingStep[];
+    stepCounter: number;
+    currentExecutingStepId?: string;
+};
+declare function createInitialV2State(): V2EventProcessorState;
+declare function processStreamEventV2(event: StreamEvent, state: V2EventProcessorState): V2EventProcessorState;
+
 type UserActionResponse = {
     success: boolean;
     message: string;
@@ -339,4 +394,4 @@ declare function cancelUserAction(config: ChatConfig, userActionId: string): Pro
  */
 declare function resendUserAction(config: ChatConfig, userActionId: string): Promise<UserActionResponse>;
 
-export { type APIConfig, type ChatCallbacks, type ChatConfig, type ChunkDisplay, type MessageDisplay, type MessageRole, type SessionParams, type StreamEvent, type StreamOptions, type StreamProgress, type StreamingStep, type UseChatReturn, type UseVoiceReturn, type UserActionRequest, type UserActionResult, type UserActionState, type UserActionType, type VoiceCallbacks, type VoiceConfig, type VoicePermissions, type VoiceResult, type VoiceState, type WorkflowStage, cancelUserAction, generateId, resendUserAction, streamWorkflowEvents, submitUserAction, useChat, useVoice };
+export { type APIConfig, type ChatCallbacks, type ChatConfig, type ChunkDisplay, type MessageDisplay, type MessageRole, type SessionParams, type StreamEvent, type StreamOptions, type StreamProgress, type StreamingStep, type UseChatReturn, type UseChatV2Return, type UseVoiceReturn, type UserActionRequest, type UserActionResult, type UserActionState, type UserActionType, type V2EventProcessorState, type VoiceCallbacks, type VoiceConfig, type VoicePermissions, type VoiceResult, type VoiceState, type WorkflowStage, buildFormattedThinking, cancelUserAction, createInitialV2State, generateId, processStreamEventV2, resendUserAction, streamWorkflowEvents, submitUserAction, useChat, useChatV2, useVoice };