@paymanai/payman-typescript-ask-sdk 1.0.1 → 1.1.0

package/dist/index.d.mts

@@ -3,6 +3,17 @@ import React from 'react';
 type MessageRole = "user" | "assistant" | "system";
 type StreamProgress = "started" | "processing" | "completed" | "error";
 type WorkflowStage = "DEV" | "SANDBOX" | "PROD" | "ARCHIVED";
+type UserActionRequest = {
+    userActionId: string;
+    message: string;
+    requestedSchema: Record<string, unknown>;
+};
+type UserActionResult = "approved" | "rejected";
+type UserActionState = {
+    request: UserActionRequest | null;
+    result: UserActionResult | null;
+    clearOtpTrigger: number;
+};
 type StreamingStep = {
     id: string;
     eventType: string;
@@ -36,6 +47,8 @@ type MessageDisplay = {
     steps?: StreamingStep[];
     isCancelled?: boolean;
     currentExecutingStepId?: string;
+    /** Result of user action (OTP approval/rejection) */
+    userActionResult?: UserActionResult;
 };
 type SessionParams = {
     id?: string;
@@ -61,6 +74,8 @@ type ChatConfig = {
     workflowVersion?: number;
     /** Stage/Environment */
     stage?: WorkflowStage;
+    /** Query param name for stage (default: "stage"). Use e.g. "workflowStage" if the API expects that name. */
+    stageQueryParam?: string;
     /** Session params */
     sessionParams?: SessionParams;
     /** Custom placeholder text */
@@ -123,9 +138,13 @@ type ChatCallbacks = {
     }) => void;
     /** Called when session ID changes */
     onSessionIdChange?: (sessionId: string) => void;
+    /** Called when a user action (e.g. OTP) is required */
+    onUserActionRequired?: (request: UserActionRequest) => void;
+    /** Called on user action events (SUCCESS, INVALID, EXPIRED, REJECTED, RESENT, FAILED) */
+    onUserActionEvent?: (eventType: string, message: string) => void;
 };
 
-declare function useChat(config: ChatConfig, callbacks?: ChatCallbacks): {
+type UseChatReturn = {
     messages: MessageDisplay[];
     sendMessage: (userMessage: string) => Promise<void>;
     clearMessages: () => void;
@@ -135,7 +154,16 @@ declare function useChat(config: ChatConfig, callbacks?: ChatCallbacks): {
     getMessages: () => MessageDisplay[];
     isWaitingForResponse: boolean;
     sessionId: string | undefined;
+    /** User action (OTP) state — always present, inert when workflow has no user actions */
+    userActionState: UserActionState;
+    /** Submit OTP for approval */
+    approveUserAction: (otp: string) => Promise<void>;
+    /** Reject / cancel a user action */
+    rejectUserAction: () => Promise<void>;
+    /** Resend OTP code */
+    resendOtp: () => Promise<void>;
 };
+declare function useChat(config: ChatConfig, callbacks?: ChatCallbacks): UseChatReturn;
 
 /**
  * Cross-platform UUID v4 generator
@@ -157,6 +185,11 @@ type StreamEvent = {
     inputTokens?: number;
     outputTokens?: number;
     elapsedMs?: number;
+    userActionRequest?: {
+        userActionId: string;
+        message: string;
+        requestedSchema: Record<string, unknown>;
+    };
     [key: string]: unknown;
 };
 type StreamOptions = {
@@ -170,4 +203,21 @@ type StreamOptions = {
  */
 declare function streamWorkflowEvents(url: string, body: Record<string, unknown>, headers: Record<string, string>, options?: StreamOptions): Promise<void>;
 
-export { type APIConfig, type ChatCallbacks, type ChatConfig, type ChunkDisplay, type MessageDisplay, type MessageRole, type SessionParams, type StreamEvent, type StreamOptions, type StreamProgress, type StreamingStep, type WorkflowStage, generateId, streamWorkflowEvents, useChat };
+type UserActionResponse = {
+    success: boolean;
+    message: string;
+};
+/**
+ * Submit a user action (e.g. OTP verification)
+ */
+declare function submitUserAction(config: ChatConfig, userActionId: string, data?: Record<string, unknown>): Promise<UserActionResponse>;
+/**
+ * Cancel / reject a user action
+ */
+declare function cancelUserAction(config: ChatConfig, userActionId: string): Promise<UserActionResponse>;
+/**
+ * Resend a user action (e.g. request a new OTP)
+ */
+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 UserActionRequest, type UserActionResult, type UserActionState, type WorkflowStage, cancelUserAction, generateId, resendUserAction, streamWorkflowEvents, submitUserAction, useChat };

package/dist/index.d.ts

@@ -3,6 +3,17 @@ import React from 'react';
 type MessageRole = "user" | "assistant" | "system";
 type StreamProgress = "started" | "processing" | "completed" | "error";
 type WorkflowStage = "DEV" | "SANDBOX" | "PROD" | "ARCHIVED";
+type UserActionRequest = {
+    userActionId: string;
+    message: string;
+    requestedSchema: Record<string, unknown>;
+};
+type UserActionResult = "approved" | "rejected";
+type UserActionState = {
+    request: UserActionRequest | null;
+    result: UserActionResult | null;
+    clearOtpTrigger: number;
+};
 type StreamingStep = {
     id: string;
     eventType: string;
@@ -36,6 +47,8 @@ type MessageDisplay = {
     steps?: StreamingStep[];
     isCancelled?: boolean;
     currentExecutingStepId?: string;
+    /** Result of user action (OTP approval/rejection) */
+    userActionResult?: UserActionResult;
 };
 type SessionParams = {
     id?: string;
@@ -61,6 +74,8 @@ type ChatConfig = {
     workflowVersion?: number;
     /** Stage/Environment */
     stage?: WorkflowStage;
+    /** Query param name for stage (default: "stage"). Use e.g. "workflowStage" if the API expects that name. */
+    stageQueryParam?: string;
     /** Session params */
     sessionParams?: SessionParams;
     /** Custom placeholder text */
@@ -123,9 +138,13 @@ type ChatCallbacks = {
     }) => void;
     /** Called when session ID changes */
     onSessionIdChange?: (sessionId: string) => void;
+    /** Called when a user action (e.g. OTP) is required */
+    onUserActionRequired?: (request: UserActionRequest) => void;
+    /** Called on user action events (SUCCESS, INVALID, EXPIRED, REJECTED, RESENT, FAILED) */
+    onUserActionEvent?: (eventType: string, message: string) => void;
 };
 
-declare function useChat(config: ChatConfig, callbacks?: ChatCallbacks): {
+type UseChatReturn = {
     messages: MessageDisplay[];
     sendMessage: (userMessage: string) => Promise<void>;
     clearMessages: () => void;
@@ -135,7 +154,16 @@ declare function useChat(config: ChatConfig, callbacks?: ChatCallbacks): {
     getMessages: () => MessageDisplay[];
     isWaitingForResponse: boolean;
     sessionId: string | undefined;
+    /** User action (OTP) state — always present, inert when workflow has no user actions */
+    userActionState: UserActionState;
+    /** Submit OTP for approval */
+    approveUserAction: (otp: string) => Promise<void>;
+    /** Reject / cancel a user action */
+    rejectUserAction: () => Promise<void>;
+    /** Resend OTP code */
+    resendOtp: () => Promise<void>;
 };
+declare function useChat(config: ChatConfig, callbacks?: ChatCallbacks): UseChatReturn;
 
 /**
  * Cross-platform UUID v4 generator
@@ -157,6 +185,11 @@ type StreamEvent = {
     inputTokens?: number;
     outputTokens?: number;
     elapsedMs?: number;
+    userActionRequest?: {
+        userActionId: string;
+        message: string;
+        requestedSchema: Record<string, unknown>;
+    };
     [key: string]: unknown;
 };
 type StreamOptions = {
@@ -170,4 +203,21 @@ type StreamOptions = {
  */
 declare function streamWorkflowEvents(url: string, body: Record<string, unknown>, headers: Record<string, string>, options?: StreamOptions): Promise<void>;
 
-export { type APIConfig, type ChatCallbacks, type ChatConfig, type ChunkDisplay, type MessageDisplay, type MessageRole, type SessionParams, type StreamEvent, type StreamOptions, type StreamProgress, type StreamingStep, type WorkflowStage, generateId, streamWorkflowEvents, useChat };
+type UserActionResponse = {
+    success: boolean;
+    message: string;
+};
+/**
+ * Submit a user action (e.g. OTP verification)
+ */
+declare function submitUserAction(config: ChatConfig, userActionId: string, data?: Record<string, unknown>): Promise<UserActionResponse>;
+/**
+ * Cancel / reject a user action
+ */
+declare function cancelUserAction(config: ChatConfig, userActionId: string): Promise<UserActionResponse>;
+/**
+ * Resend a user action (e.g. request a new OTP)
+ */
+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 UserActionRequest, type UserActionResult, type UserActionState, type WorkflowStage, cancelUserAction, generateId, resendUserAction, streamWorkflowEvents, submitUserAction, useChat };