@1interface/chat-core 0.15.5 → 0.17.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { ActionCreatorWithoutPayload } from '@reduxjs/toolkit';
 import { Api } from '@reduxjs/toolkit/query';
 import { AppBrandingResponse } from '@1interface/shared-core';
 import { AppResponse } from '@1interface/shared-core';
+import { AttachedDocument } from '@1interface/shared-core';
 import { AuthApiResult } from '@1interface/shared-core';
 import { AuthState } from '@1interface/shared-core';
 import { BaseQueryFn } from '@reduxjs/toolkit/query';
@@ -22,6 +23,7 @@ import { LoggerContextProvider } from '@1interface/shared-core';
 import { LogoutRequest } from '@1interface/shared-core';
 import { Message } from '@1interface/shared-core';
 import { Middleware } from '@reduxjs/toolkit';
+import { ModelContextPart } from '@1interface/shared-core';
 import { MutableRefObject } from 'react';
 import { MutationActionCreatorResult } from '@reduxjs/toolkit/query';
 import { MutationDefinition } from '@reduxjs/toolkit/query';
@@ -38,6 +40,7 @@ import { Reducer } from '@reduxjs/toolkit';
 import { RefObject } from 'react';
 import { RefreshApiResult } from '@1interface/shared-core';
 import { RefreshRequest } from '@1interface/shared-core';
+import { RequestDocumentsPayload } from '@1interface/shared-core';
 import { ResendVerificationRequest } from '@1interface/shared-core';
 import { ResetPasswordRequest } from '@1interface/shared-core';
 import { RootState as RootState_2 } from '@reduxjs/toolkit/query';
@@ -358,6 +361,8 @@ export declare function buildBrandSkin(styles: ChatThemeStyles, resolvedTheme: "
 
 export declare function buildCallbackUrl(givenId?: string | null): string;
 
+export declare function buildHostedPaymentPageThemeMessage(skin: PaymentSkin): HostedPaymentPageThemeMessage;
+
 export declare const CHAT_INPUT_MODES: {
     readonly NORMAL: "normal";
     readonly RECORDING: "recording";
@@ -447,6 +452,12 @@ text: string;
 queuedAt: string;
 transcriptionIds?: string[];
 messageType?: string[];
+documents?: {
+document_id: string;
+filename: string;
+mime_type: string;
+size_bytes: number;
+}[];
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -544,6 +555,12 @@ text: string;
 queuedAt: string;
 transcriptionIds?: string[];
 messageType?: string[];
+documents?: {
+document_id: string;
+filename: string;
+mime_type: string;
+size_bytes: number;
+}[];
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -677,6 +694,12 @@ text: string;
 queuedAt: string;
 transcriptionIds?: string[];
 messageType?: string[];
+documents?: {
+document_id: string;
+filename: string;
+mime_type: string;
+size_bytes: number;
+}[];
 }[];
 pendingTranscriptionIds: string[];
 }>;
@@ -714,6 +737,7 @@ export declare interface ClientConfig {
     conversations: ConversationsConfig;
     voice_agent: VoiceAgentConfig;
     stt: SttConfig;
+    documents: DocumentsConfig;
     features?: string[];
     backend_version?: string;
     panel_switcher_enabled?: boolean;
@@ -798,6 +822,12 @@ export declare const DEFAULT_PROTOCOL: ProtocolType;
 
 export declare const dequeueMessage: ActionCreatorWithoutPayload<"chat/dequeueMessage">;
 
+export declare interface DocumentsConfig {
+    max_bytes: number;
+    max_documents: number;
+    allowed_mime_types: string[] | null;
+}
+
 export declare type DocumentUploadFile = File | Blob | {
     uri: string;
     name: string;
@@ -863,10 +893,51 @@ export declare function guestLoginApi(): Promise<AuthApiResult>;
 
 export declare const hasAnyExtraData: (msg: any) => boolean;
 
+export declare const HOSTED_PAYMENT_PAGE_CALLBACK_ACTIONS: {
+    readonly LOADED: "loaded";
+    readonly DONE: "done";
+};
+
+export declare const HOSTED_PAYMENT_PAGE_CALLBACK_MESSAGE_TYPE = "hosted-payment-page-callback";
+
+export declare const HOSTED_PAYMENT_PAGE_CALLBACK_PATH = "/payment-callback.html";
+
+export declare const HOSTED_PAYMENT_PAGE_STATUSES: {
+    readonly SUCCESS: "success";
+    readonly FAILED: "failed";
+};
+
+export declare const HOSTED_PAYMENT_PAGE_THEME_MESSAGE_TYPE = "hosted-payment-page-theme";
+
+export declare type HostedPaymentPageCallbackAction = (typeof HOSTED_PAYMENT_PAGE_CALLBACK_ACTIONS)[keyof typeof HOSTED_PAYMENT_PAGE_CALLBACK_ACTIONS];
+
+export declare interface HostedPaymentPageCallbackMessage {
+    type: typeof HOSTED_PAYMENT_PAGE_CALLBACK_MESSAGE_TYPE;
+    action: HostedPaymentPageCallbackAction;
+    search: string;
+}
+
+export declare interface HostedPaymentPageCallbackResult {
+    paymentId: string;
+    paymentStatus: HostedPaymentPageStatus;
+}
+
+export declare type HostedPaymentPageStatus = (typeof HOSTED_PAYMENT_PAGE_STATUSES)[keyof typeof HOSTED_PAYMENT_PAGE_STATUSES];
+
+export declare interface HostedPaymentPageThemeMessage {
+    type: typeof HOSTED_PAYMENT_PAGE_THEME_MESSAGE_TYPE;
+    colorScheme: PaymentSkin["colorScheme"];
+    vars: Record<`--hpp-${string}`, string>;
+}
+
 export declare function isApiServerError(err: unknown): boolean;
 
 export declare const isEmptyMessage: (v: any) => boolean;
 
+export declare function isHostedPaymentPageCallbackMessage(value: unknown): value is HostedPaymentPageCallbackMessage;
+
+export declare function isHostedPaymentPageUrl(value: unknown): value is string;
+
 export declare function loginApi(email: string, password: string): Promise<AuthApiResult>;
 
 export declare function logoutApi(payload: LogoutRequest, options?: {
@@ -914,13 +985,15 @@ export declare type NormalizedEventData = {
     payment: PaymentInitPayload;
 } | {
     signIn: SignInInitPayload;
+} | {
+    requestDocuments: RequestDocumentsPayload;
 } | {
     conversationTitle: string;
 } | {
     isEnd: true;
 };
 
-export declare type NormalizedEventType = 'text' | 'error' | 'widget' | 'status_update' | 'payment' | 'sign_in' | 'conversation_title' | 'stream_end';
+export declare type NormalizedEventType = 'text' | 'error' | 'widget' | 'status_update' | 'payment' | 'sign_in' | 'request_documents' | 'conversation_title' | 'stream_end';
 
 export declare const OAUTH_ERROR_TYPE: "OAUTH_ERROR";
 
@@ -932,6 +1005,8 @@ export declare const PAGINATION: {
     readonly MESSAGE_PAGE_SIZE: 25;
 };
 
+export declare function parseHostedPaymentPageCallback(search: string): HostedPaymentPageCallbackResult | null;
+
 export declare function parseMoyasarCallbackFromUrl(search: string): MoyasarCallbackResult | null;
 
 export declare interface PaymentAdapter {
@@ -963,12 +1038,14 @@ export declare type PaymentResult = {
     paymentId: string;
     amount?: number;
     currency?: string;
+    dismissed?: boolean;
 } | {
     status: "failure";
     provider: PaymentProviderType;
     code?: string;
     message: string;
     paymentId?: string;
+    dismissed?: boolean;
 } | {
     status: "cancel";
     provider: PaymentProviderType;
@@ -984,6 +1061,12 @@ export declare interface PaymentSkin {
     accent: string;
     accentText: string;
     focus: string;
+    success: string;
+    successBg: string;
+    warning: string;
+    warningBg: string;
+    danger: string;
+    dangerBg: string;
     pillBg: string;
     pillBorder: string;
     pillText: string;
@@ -1041,6 +1124,7 @@ export declare interface QueuedMessage {
     queuedAt: string;
     transcriptionIds?: string[];
     messageType?: string[];
+    documents?: AttachedDocument[];
 }
 
 export declare function refreshTokenApi(payload: RefreshRequest): Promise<RefreshApiResult>;
@@ -1065,6 +1149,7 @@ declare type SendMessageFn_3 = (text?: string) => Promise<void>;
 
 export declare interface SendMessageOptions {
     messageType?: string[];
+    documents?: AttachedDocument[];
 }
 
 export declare const serializableCheck: {
@@ -1098,6 +1183,7 @@ export declare enum SSEEventType {
     CLEAR_STATUS = "clear_status",
     PAYMENT = "payment",
     SIGN_IN = "sign_in",
+    REQUEST_DOCUMENTS = "request_documents",
     CONVERSATION_TITLE = "conversation_title",
     END = "end"
 }
@@ -1142,6 +1228,12 @@ text: string;
 queuedAt: string;
 transcriptionIds?: string[];
 messageType?: string[];
+documents?: {
+document_id: string;
+filename: string;
+mime_type: string;
+size_bytes: number;
+}[];
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -1240,6 +1332,12 @@ text: string;
 queuedAt: string;
 transcriptionIds?: string[];
 messageType?: string[];
+documents?: {
+document_id: string;
+filename: string;
+mime_type: string;
+size_bytes: number;
+}[];
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -1351,6 +1449,7 @@ export declare interface StreamMessageParams {
     enableTts?: boolean;
     debugMode?: boolean;
     transcriptionIds?: string[];
+    modelContext?: ModelContextPart[];
     body?: Record<string, unknown>;
 }
 
@@ -1417,7 +1516,7 @@ export declare const useAuth: () => {
 
 export declare const useChatCallbacks: () => ChatCallbacks;
 
-export declare const useChatConnection: ({ conversationId, messages, setMessages, enableTts, userLocation, startSession, debugMode, onPaymentInit, onSignInInit, onConversationTitle, }: UseChatConnectionParams) => UseChatConnectionReturn;
+export declare const useChatConnection: ({ conversationId, messages, setMessages, enableTts, userLocation, startSession, debugMode, onPaymentInit, onSignInInit, onRequestDocuments, onConversationTitle, }: UseChatConnectionParams) => UseChatConnectionReturn;
 
 declare interface UseChatConnectionParams {
     conversationId: string | null;
@@ -1429,6 +1528,7 @@ declare interface UseChatConnectionParams {
     debugMode?: boolean;
     onPaymentInit?: (init: PaymentInitPayload) => void;
     onSignInInit?: (init: SignInInitPayload) => void;
+    onRequestDocuments?: (payload: RequestDocumentsPayload) => void;
     onConversationTitle?: (title: string) => void;
 }
 
@@ -1461,11 +1561,12 @@ declare interface UseChatHistoryParams {
     onClearChat?: () => void;
 }
 
-export declare const useChatInput: ({ onSend, disabled, transcribedText, onTranscribedTextUsed, isRecording, isTranscribing, }: UseChatInputParams) => UseChatInputResult;
+export declare const useChatInput: ({ onSend, disabled, hasAttachments, transcribedText, onTranscribedTextUsed, isRecording, isTranscribing, }: UseChatInputParams) => UseChatInputResult;
 
 export declare interface UseChatInputParams {
     onSend: (text: string) => void;
     disabled?: boolean;
+    hasAttachments?: boolean;
     transcribedText?: string | null;
     onTranscribedTextUsed?: () => void;
     isRecording?: boolean;