@paymanai/payman-ask-sdk 4.0.18 → 4.0.20

package/dist/index.d.mts

@@ -1,7 +1,8 @@
 import * as React from 'react';
 import React__default from 'react';
 import { MessageDisplay, AgentStage, ChatCallbacks as ChatCallbacks$1, ChatConfig as ChatConfig$1, ActiveUserAction, UserNotification } from '@paymanai/payman-typescript-ask-sdk';
-export { APIConfig, ActiveUserAction, AgentStage, ChunkDisplay, JsonSchemaField, JsonSchemaOption, MessageDisplay, MessageRole, RequestedSchema, SessionParams, StreamProgress, StreamingStep, UseChatV2Return, UseVoiceReturn, UserActionKind, UserActionRequest, UserActionStaleError, UserActionState, UserActionStatus, UserActionSubAction, UserNotification, VerificationType, VoiceCallbacks, VoiceConfig, VoicePermissions, VoiceResult, VoiceState, cancelUserAction, resendUserAction, submitUserAction, useChatV2, useVoice } from '@paymanai/payman-typescript-ask-sdk';
+export { APIConfig, ActiveUserAction, AgentStage, AttachmentUploadStatus, ChunkDisplay, ExecutionHistoryAttachment, ExecutionHistoryMessage, JsonSchemaField, JsonSchemaOption, MessageAttachment, MessageDisplay, MessageRole, RequestedSchema, SessionParams, StreamAttachmentPayload, StreamProgress, StreamingStep, TrackedAttachment, UseAttachmentUploadReturn, UseChatV2Return, UseVoiceReturn, UserActionKind, UserActionRequest, UserActionStaleError, UserActionState, UserActionStatus, UserActionSubAction, UserNotification, VerificationType, VoiceCallbacks, VoiceConfig, VoicePermissions, VoiceResult, VoiceState, buildSignedUrlEndpoint, cancelUserAction, mapExecutionHistoryPageToChatMessages, mapExecutionHistoryToChatMessages, resendUserAction, stripAttachmentsSuffixFromIntent, submitUserAction, uploadAttachment, uploadAttachments, useAttachmentUpload, useChatV2, useVoice } from '@paymanai/payman-typescript-ask-sdk';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ClassValue } from 'clsx';
 
 declare const NEGATIVE_FEEDBACK_REASONS: readonly [{
@@ -73,6 +74,41 @@ type SlashCommandConfig = {
     /** Show only when at least one permission is present. */
     requiredAnyPermissions?: string[];
 };
+type ChatAttachmentConfig = {
+    /** Show the attachment (+) menu button in the input bar. Default: true */
+    enabled?: boolean;
+    /** Show the "Upload image" option in the attachment menu. Default: true */
+    uploadImage?: boolean;
+    /** Show the "Attach file" option in the attachment menu. Default: true */
+    attachFile?: boolean;
+    /**
+     * Maximum combined image + document attachments per message/run.
+     * Omit for no limit.
+     */
+    maxCount?: number;
+    /**
+     * @deprecated Use `maxCount` — combined limit across images and files.
+     */
+    maxImages?: number;
+    /**
+     * @deprecated Use `maxCount` — combined limit across images and files.
+     */
+    maxDocuments?: number;
+    /** Maximum size in bytes for any single attachment. */
+    maxFileBytes?: number;
+    /** Maximum combined attachment size in bytes for one message/run. */
+    maxTotalBytes?: number;
+    /**
+     * Allowed image file extensions without a leading dot.
+     * Default: `png`, `jpg`, `jpeg`, `gif`, `webp`.
+     */
+    imageExtensions?: string[];
+    /**
+     * Allowed document file extensions without a leading dot.
+     * Default: `pdf`, `docx`, `xlsx`, `xls`.
+     */
+    documentExtensions?: string[];
+};
 type ChatConfig = ChatConfig$1 & {
     /** Custom React component to render above the empty state text (e.g. logo, illustration). */
     emptyStateComponent?: React__default.ReactNode;
@@ -88,11 +124,25 @@ type ChatConfig = ChatConfig$1 & {
     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) */
+    /**
+     * Attachment picker settings for the v2 input bar.
+     * Prefer this over the legacy flat `showAttachment*` flags below.
+     */
+    attachments?: ChatAttachmentConfig;
+    /**
+     * @deprecated Use `attachments.enabled` instead.
+     * Show the v2 attachment (+) menu button in the input bar (default: true).
+     */
     showAttachmentButton?: boolean;
-    /** Show the v2 "Upload image" attachment option (default: true) */
+    /**
+     * @deprecated Use `attachments.uploadImage` instead.
+     * Show the v2 "Upload image" attachment option (default: true).
+     */
     showUploadImageButton?: boolean;
-    /** Show the v2 "Attach file" attachment option (default: true) */
+    /**
+     * @deprecated Use `attachments.attachFile` instead.
+     * Show the v2 "Attach file" attachment option (default: true).
+     */
     showAttachFileButton?: boolean;
     /** Configure which per-message actions are visible in the v2 UI */
     messageActions?: MessageActionsConfig;
@@ -117,26 +167,6 @@ type ChatConfig = ChatConfig$1 & {
      * the consumer hasn't wired one.
      */
     debug?: boolean;
-    /**
-     * Accent / brand colour used by the React Native chat surface (send button,
-     * focused border, streaming indicator, etc.). Defaults to Payman teal `#00858d`.
-     * Web styling continues to follow Tailwind and ignores this field.
-     */
-    accent?: string;
-    /**
-     * Colour scheme for the React Native chat surface (message text, bubbles,
-     * markdown tables/code, borders). When omitted the SDK falls back to the
-     * device's system scheme via `useColorScheme()`. Pass this from the host
-     * app's theme context so the chat honours a manual light/dark override.
-     * Web styling continues to follow Tailwind and ignores this field.
-     */
-    colorScheme?: "light" | "dark";
-    /**
-     * Bottom safe-area inset (px) for the React Native chat surface. Pass the
-     * host app's `useSafeAreaInsets().bottom` so the input bar / voice bar clear
-     * the home indicator. Defaults to a small platform fallback when omitted.
-     */
-    contentInsetBottom?: number;
     /**
      * UI version to render.
      *   1 = original component set
@@ -173,6 +203,16 @@ type ChatConfig = ChatConfig$1 & {
         /** Rendered size in pixels. Defaults to 18 to match the default SVG spinner. */
         size?: number;
     };
+    /**
+     * How the v2 PDF preview panel is laid out relative to the chat column.
+     *   split — side-by-side flex layout with a wide default panel (~520px)
+     *   sheet — full-height overlay that slides in from the right and covers
+     *           the chat (for narrow agent side panels)
+     *
+     * Use `sheet` for narrow agent side panels (e.g. Agent Detail test chat).
+     * Use `split` (default) for full-width chat surfaces.
+     */
+    pdfPreviewMode?: "split" | "sheet";
 };
 type ChatCallbacks = ChatCallbacks$1 & {
     /** Called when the session is reset (via SDK reset button or ref.resetSession()) */
@@ -367,6 +407,8 @@ type MessageListV2Props = {
      *   1 = default, 2 = 2x faster, 0.5 = half speed, 0 = instant reveal.
      */
     typingSpeed?: number;
+    /** When a side panel (e.g. PDF preview) is open, disable sticky auto-scroll. */
+    sidePanelOpen?: boolean;
 };
 type MessageRowProps = {
     /** Message to display */
@@ -481,6 +523,16 @@ type ChatHeaderProps = {
  */
 declare const PaymanChat: React.ForwardRefExoticComponent<PaymanChatProps & React.RefAttributes<PaymanChatRef>>;
 
+type PdfPreviewLayoutMode = "split" | "sheet";
+
+type PdfSheetV2Props = {
+    src: string | null;
+    title: string;
+    onClose: () => void;
+    mode?: PdfPreviewLayoutMode;
+};
+declare function PdfSheetV2({ src, title, onClose, mode, }: PdfSheetV2Props): react_jsx_runtime.JSX.Element;
+
 interface PaymanChatContextValue {
     /**
      * Clear all messages and reset the chat
@@ -510,6 +562,14 @@ interface PaymanChatContextValue {
      * Check if currently waiting for response
      */
     isWaitingForResponse: boolean;
+    /**
+     * Open the PDF preview panel with the given URL and title.
+     * When called, the chat shifts left and the PDF panel slides in from the right.
+     * Pass `{ auto: true }` for stream auto-open; auto-open is suppressed after the user closes the sheet.
+     */
+    openPdfSheet: (href: string, title: string, options?: {
+        auto?: boolean;
+    }) => void;
 }
 declare const PaymanChatContext: React.Context<PaymanChatContextValue | undefined>;
 /**
@@ -560,4 +620,12 @@ interface ChatSessionContext {
  */
 declare function captureSentryError(error: Error | string, context: ChatSessionContext): void;
 
-export { type AgentMessageProps, type AssistantMessageActionsConfig, type ChatCallbacks, type ChatConfig, type ChatHeaderProps, type ChatInputProps, type ChatSessionContext, type MessageActionsConfig, type MessageListProps, type MessageListV2Props, type MessageRowProps, PaymanChat, PaymanChatContext, type PaymanChatContextValue, type PaymanChatProps, type PaymanChatRef, type SlashCommandConfig, type UserMessageActionsConfig, type UserMessageProps, captureSentryError, cn, formatDate, usePaymanChat };
+/** Human-readable byte size for attachment limit hints. */
+declare function formatAttachmentBytes(bytes: number): string;
+
+/** True when a markdown link href points at a PDF (incl. Azure blob signed URLs). */
+declare function isPdfUrl(href: string): boolean;
+/** Title for the PDF preview sheet — prefers link text, then filename from URL. */
+declare function getPdfTitleFromUrl(href: string, linkText?: string): string;
+
+export { type AgentMessageProps, type AssistantMessageActionsConfig, type ChatAttachmentConfig, type ChatCallbacks, type ChatConfig, type ChatHeaderProps, type ChatInputProps, type ChatSessionContext, type MessageActionsConfig, type MessageListProps, type MessageListV2Props, type MessageRowProps, PaymanChat, PaymanChatContext, type PaymanChatContextValue, type PaymanChatProps, type PaymanChatRef, type PdfPreviewLayoutMode, PdfSheetV2, type PdfSheetV2Props, type SlashCommandConfig, type UserMessageActionsConfig, type UserMessageProps, captureSentryError, cn, formatAttachmentBytes, formatDate, getPdfTitleFromUrl, isPdfUrl, usePaymanChat };

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import * as React from 'react';
 import React__default from 'react';
 import { MessageDisplay, AgentStage, ChatCallbacks as ChatCallbacks$1, ChatConfig as ChatConfig$1, ActiveUserAction, UserNotification } from '@paymanai/payman-typescript-ask-sdk';
-export { APIConfig, ActiveUserAction, AgentStage, ChunkDisplay, JsonSchemaField, JsonSchemaOption, MessageDisplay, MessageRole, RequestedSchema, SessionParams, StreamProgress, StreamingStep, UseChatV2Return, UseVoiceReturn, UserActionKind, UserActionRequest, UserActionStaleError, UserActionState, UserActionStatus, UserActionSubAction, UserNotification, VerificationType, VoiceCallbacks, VoiceConfig, VoicePermissions, VoiceResult, VoiceState, cancelUserAction, resendUserAction, submitUserAction, useChatV2, useVoice } from '@paymanai/payman-typescript-ask-sdk';
+export { APIConfig, ActiveUserAction, AgentStage, AttachmentUploadStatus, ChunkDisplay, ExecutionHistoryAttachment, ExecutionHistoryMessage, JsonSchemaField, JsonSchemaOption, MessageAttachment, MessageDisplay, MessageRole, RequestedSchema, SessionParams, StreamAttachmentPayload, StreamProgress, StreamingStep, TrackedAttachment, UseAttachmentUploadReturn, UseChatV2Return, UseVoiceReturn, UserActionKind, UserActionRequest, UserActionStaleError, UserActionState, UserActionStatus, UserActionSubAction, UserNotification, VerificationType, VoiceCallbacks, VoiceConfig, VoicePermissions, VoiceResult, VoiceState, buildSignedUrlEndpoint, cancelUserAction, mapExecutionHistoryPageToChatMessages, mapExecutionHistoryToChatMessages, resendUserAction, stripAttachmentsSuffixFromIntent, submitUserAction, uploadAttachment, uploadAttachments, useAttachmentUpload, useChatV2, useVoice } from '@paymanai/payman-typescript-ask-sdk';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ClassValue } from 'clsx';
 
 declare const NEGATIVE_FEEDBACK_REASONS: readonly [{
@@ -73,6 +74,41 @@ type SlashCommandConfig = {
     /** Show only when at least one permission is present. */
     requiredAnyPermissions?: string[];
 };
+type ChatAttachmentConfig = {
+    /** Show the attachment (+) menu button in the input bar. Default: true */
+    enabled?: boolean;
+    /** Show the "Upload image" option in the attachment menu. Default: true */
+    uploadImage?: boolean;
+    /** Show the "Attach file" option in the attachment menu. Default: true */
+    attachFile?: boolean;
+    /**
+     * Maximum combined image + document attachments per message/run.
+     * Omit for no limit.
+     */
+    maxCount?: number;
+    /**
+     * @deprecated Use `maxCount` — combined limit across images and files.
+     */
+    maxImages?: number;
+    /**
+     * @deprecated Use `maxCount` — combined limit across images and files.
+     */
+    maxDocuments?: number;
+    /** Maximum size in bytes for any single attachment. */
+    maxFileBytes?: number;
+    /** Maximum combined attachment size in bytes for one message/run. */
+    maxTotalBytes?: number;
+    /**
+     * Allowed image file extensions without a leading dot.
+     * Default: `png`, `jpg`, `jpeg`, `gif`, `webp`.
+     */
+    imageExtensions?: string[];
+    /**
+     * Allowed document file extensions without a leading dot.
+     * Default: `pdf`, `docx`, `xlsx`, `xls`.
+     */
+    documentExtensions?: string[];
+};
 type ChatConfig = ChatConfig$1 & {
     /** Custom React component to render above the empty state text (e.g. logo, illustration). */
     emptyStateComponent?: React__default.ReactNode;
@@ -88,11 +124,25 @@ type ChatConfig = ChatConfig$1 & {
     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) */
+    /**
+     * Attachment picker settings for the v2 input bar.
+     * Prefer this over the legacy flat `showAttachment*` flags below.
+     */
+    attachments?: ChatAttachmentConfig;
+    /**
+     * @deprecated Use `attachments.enabled` instead.
+     * Show the v2 attachment (+) menu button in the input bar (default: true).
+     */
     showAttachmentButton?: boolean;
-    /** Show the v2 "Upload image" attachment option (default: true) */
+    /**
+     * @deprecated Use `attachments.uploadImage` instead.
+     * Show the v2 "Upload image" attachment option (default: true).
+     */
     showUploadImageButton?: boolean;
-    /** Show the v2 "Attach file" attachment option (default: true) */
+    /**
+     * @deprecated Use `attachments.attachFile` instead.
+     * Show the v2 "Attach file" attachment option (default: true).
+     */
     showAttachFileButton?: boolean;
     /** Configure which per-message actions are visible in the v2 UI */
     messageActions?: MessageActionsConfig;
@@ -117,26 +167,6 @@ type ChatConfig = ChatConfig$1 & {
      * the consumer hasn't wired one.
      */
     debug?: boolean;
-    /**
-     * Accent / brand colour used by the React Native chat surface (send button,
-     * focused border, streaming indicator, etc.). Defaults to Payman teal `#00858d`.
-     * Web styling continues to follow Tailwind and ignores this field.
-     */
-    accent?: string;
-    /**
-     * Colour scheme for the React Native chat surface (message text, bubbles,
-     * markdown tables/code, borders). When omitted the SDK falls back to the
-     * device's system scheme via `useColorScheme()`. Pass this from the host
-     * app's theme context so the chat honours a manual light/dark override.
-     * Web styling continues to follow Tailwind and ignores this field.
-     */
-    colorScheme?: "light" | "dark";
-    /**
-     * Bottom safe-area inset (px) for the React Native chat surface. Pass the
-     * host app's `useSafeAreaInsets().bottom` so the input bar / voice bar clear
-     * the home indicator. Defaults to a small platform fallback when omitted.
-     */
-    contentInsetBottom?: number;
     /**
      * UI version to render.
      *   1 = original component set
@@ -173,6 +203,16 @@ type ChatConfig = ChatConfig$1 & {
         /** Rendered size in pixels. Defaults to 18 to match the default SVG spinner. */
         size?: number;
     };
+    /**
+     * How the v2 PDF preview panel is laid out relative to the chat column.
+     *   split — side-by-side flex layout with a wide default panel (~520px)
+     *   sheet — full-height overlay that slides in from the right and covers
+     *           the chat (for narrow agent side panels)
+     *
+     * Use `sheet` for narrow agent side panels (e.g. Agent Detail test chat).
+     * Use `split` (default) for full-width chat surfaces.
+     */
+    pdfPreviewMode?: "split" | "sheet";
 };
 type ChatCallbacks = ChatCallbacks$1 & {
     /** Called when the session is reset (via SDK reset button or ref.resetSession()) */
@@ -367,6 +407,8 @@ type MessageListV2Props = {
      *   1 = default, 2 = 2x faster, 0.5 = half speed, 0 = instant reveal.
      */
     typingSpeed?: number;
+    /** When a side panel (e.g. PDF preview) is open, disable sticky auto-scroll. */
+    sidePanelOpen?: boolean;
 };
 type MessageRowProps = {
     /** Message to display */
@@ -481,6 +523,16 @@ type ChatHeaderProps = {
  */
 declare const PaymanChat: React.ForwardRefExoticComponent<PaymanChatProps & React.RefAttributes<PaymanChatRef>>;
 
+type PdfPreviewLayoutMode = "split" | "sheet";
+
+type PdfSheetV2Props = {
+    src: string | null;
+    title: string;
+    onClose: () => void;
+    mode?: PdfPreviewLayoutMode;
+};
+declare function PdfSheetV2({ src, title, onClose, mode, }: PdfSheetV2Props): react_jsx_runtime.JSX.Element;
+
 interface PaymanChatContextValue {
     /**
      * Clear all messages and reset the chat
@@ -510,6 +562,14 @@ interface PaymanChatContextValue {
      * Check if currently waiting for response
      */
     isWaitingForResponse: boolean;
+    /**
+     * Open the PDF preview panel with the given URL and title.
+     * When called, the chat shifts left and the PDF panel slides in from the right.
+     * Pass `{ auto: true }` for stream auto-open; auto-open is suppressed after the user closes the sheet.
+     */
+    openPdfSheet: (href: string, title: string, options?: {
+        auto?: boolean;
+    }) => void;
 }
 declare const PaymanChatContext: React.Context<PaymanChatContextValue | undefined>;
 /**
@@ -560,4 +620,12 @@ interface ChatSessionContext {
  */
 declare function captureSentryError(error: Error | string, context: ChatSessionContext): void;
 
-export { type AgentMessageProps, type AssistantMessageActionsConfig, type ChatCallbacks, type ChatConfig, type ChatHeaderProps, type ChatInputProps, type ChatSessionContext, type MessageActionsConfig, type MessageListProps, type MessageListV2Props, type MessageRowProps, PaymanChat, PaymanChatContext, type PaymanChatContextValue, type PaymanChatProps, type PaymanChatRef, type SlashCommandConfig, type UserMessageActionsConfig, type UserMessageProps, captureSentryError, cn, formatDate, usePaymanChat };
+/** Human-readable byte size for attachment limit hints. */
+declare function formatAttachmentBytes(bytes: number): string;
+
+/** True when a markdown link href points at a PDF (incl. Azure blob signed URLs). */
+declare function isPdfUrl(href: string): boolean;
+/** Title for the PDF preview sheet — prefers link text, then filename from URL. */
+declare function getPdfTitleFromUrl(href: string, linkText?: string): string;
+
+export { type AgentMessageProps, type AssistantMessageActionsConfig, type ChatAttachmentConfig, type ChatCallbacks, type ChatConfig, type ChatHeaderProps, type ChatInputProps, type ChatSessionContext, type MessageActionsConfig, type MessageListProps, type MessageListV2Props, type MessageRowProps, PaymanChat, PaymanChatContext, type PaymanChatContextValue, type PaymanChatProps, type PaymanChatRef, type PdfPreviewLayoutMode, PdfSheetV2, type PdfSheetV2Props, type SlashCommandConfig, type UserMessageActionsConfig, type UserMessageProps, captureSentryError, cn, formatAttachmentBytes, formatDate, getPdfTitleFromUrl, isPdfUrl, usePaymanChat };