@1interface/chat-core 0.19.0-dev.1 → 0.20.0

package/dist/index.d.ts

@@ -4,7 +4,6 @@ import { ActionCreatorWithoutPayload } from '@reduxjs/toolkit';
 import { Api } from '@reduxjs/toolkit/query';
 import { AppBrandingResponse } from '@1interface/shared-core';
 import { AppResponse } from '@1interface/shared-core';
-import { AtbPaymentInit } from '@1interface/shared-core';
 import { AttachedDocument } from '@1interface/shared-core';
 import { AuthApiResult } from '@1interface/shared-core';
 import { AuthState } from '@1interface/shared-core';
@@ -255,60 +254,6 @@ export declare const apiReducers: {
 
 export declare type AppDispatch = typeof store.dispatch;
 
-export declare const ATB_FAILURE_CODES: {
-    readonly SESSION_INVALID: "session_invalid";
-    readonly LOAD_FAILED: "load_failed";
-};
-
-export declare const ATB_FAILURE_MESSAGES: {
-    readonly NOT_COMPLETED: "The payment was not completed.";
-    readonly SESSION_INVALID: "This payment session has expired or is no longer valid. Please start a new payment.";
-    readonly LOAD_FAILED: "The payment page failed to load.";
-};
-
-export declare const ATB_MESSAGE_SOURCE = "atb-pga";
-
-export declare const ATB_MESSAGE_TYPES: {
-    readonly READY: "ready";
-    readonly COMPLETED: "completed";
-    readonly ERROR: "error";
-    readonly REDIRECT: "redirect";
-};
-
-export declare const ATB_OUTCOMES: {
-    readonly SUCCEEDED: "succeeded";
-    readonly FAILED: "failed";
-};
-
-export declare const ATB_PAYMENT_STATUSES: {
-    readonly DEPOSITED: "payment_deposited";
-    readonly DECLINED: "payment_declined";
-};
-
-export declare interface AtbCompletion {
-    status?: string;
-    checkoutId?: string;
-}
-
-declare interface AtbMessage {
-    source: typeof ATB_MESSAGE_SOURCE;
-    v: number;
-    type: AtbMessageType;
-    data?: Record<string, unknown>;
-}
-
-declare type AtbMessageType = (typeof ATB_MESSAGE_TYPES)[keyof typeof ATB_MESSAGE_TYPES];
-
-export declare type AtbOutcome = (typeof ATB_OUTCOMES)[keyof typeof ATB_OUTCOMES];
-
-export declare interface AtbResultInput {
-    outcome: AtbOutcome;
-    init: AtbPaymentInit;
-    message?: string;
-    checkoutId?: string;
-    code?: string;
-}
-
 export declare class AudioRecorder {
     private mediaRecorder;
     private audioChunks;
@@ -412,8 +357,6 @@ export declare interface BridgeRequestOptions {
     customHeaders?: Record<string, string>;
 }
 
-export declare function buildAtbResult({ outcome, init, message, checkoutId, code }: AtbResultInput): PaymentResult;
-
 export declare function buildBrandSkin(styles: ChatThemeStyles, resolvedTheme: "light" | "dark"): PaymentSkin;
 
 export declare function buildCallbackUrl(givenId?: string | null): string;
@@ -929,9 +872,14 @@ export declare function forgotPasswordApi(payload: ForgotPasswordRequest): Promi
 
 export declare function formatAmount(minorUnits: number | undefined, currency: string | undefined): string | null;
 
+export declare function formatPaymentResult(result: PaymentResult): FormattedPaymentResult;
+
 export declare function formatResultMessage(result: PaymentResult): string;
 
-export declare function formatResultModelContext(result: PaymentResult): string | undefined;
+export declare interface FormattedPaymentResult {
+    text: string;
+    modelText?: string;
+}
 
 export declare const GENERIC_SERVER_ERROR_MESSAGE = "Something went wrong. Please try again.";
 
@@ -955,12 +903,10 @@ export declare const hasAnyExtraData: (msg: any) => boolean;
 
 export declare function isApiServerError(err: unknown): boolean;
 
-export declare function isAtbCheckoutUrl(value: unknown): value is string;
-
-export declare function isAtbMessage(value: unknown): value is AtbMessage;
-
 export declare const isEmptyMessage: (v: any) => boolean;
 
+export declare function isHttpsUrl(value: unknown): value is string;
+
 export declare function loginApi(email: string, password: string): Promise<AuthApiResult>;
 
 export declare function logoutApi(payload: LogoutRequest, options?: {
@@ -981,6 +927,8 @@ export declare interface MessageArrival {
     lastUserMessageIndex: number;
 }
 
+export declare const MODEL_CONTEXT_TEXT_MAX_LENGTH = 1000;
+
 export declare const MOYASAR_CALLBACK_SENTINEL = "moyasar_cb";
 
 export declare interface MoyasarCallbackResult {
@@ -1030,6 +978,11 @@ export declare const PAGINATION: {
 
 export declare function parseMoyasarCallbackFromUrl(search: string): MoyasarCallbackResult | null;
 
+export declare const PAYMENT_FAILURE_CODES: {
+    readonly SESSION_INVALID: "session_invalid";
+    readonly LOAD_FAILED: "load_failed";
+};
+
 export declare interface PaymentAdapter {
     readonly type: PaymentProviderType;
     readonly label: string;
@@ -1059,14 +1012,12 @@ export declare type PaymentResult = {
     paymentId: string;
     amount?: number;
     currency?: string;
-    checkoutId?: string;
 } | {
     status: "failure";
     provider: PaymentProviderType;
     code?: string;
     message: string;
     paymentId?: string;
-    checkoutId?: string;
 } | {
     status: "cancel";
     provider: PaymentProviderType;
@@ -1149,12 +1100,6 @@ export declare interface QueuedMessage {
     modelText?: string;
 }
 
-export declare function readAtbCompletion(data: unknown): AtbCompletion;
-
-export declare function readAtbOutcome(status: string | undefined): AtbOutcome;
-
-export declare function readAtbRedirect(data: unknown): string | null;
-
 export declare function refreshTokenApi(payload: RefreshRequest): Promise<RefreshApiResult>;
 
 export declare function resendVerificationApi(payload: ResendVerificationRequest): Promise<string | undefined>;
@@ -1167,15 +1112,9 @@ export declare const resetChatState: ActionCreatorWithoutPayload<"chat/resetChat
 
 export declare function resetPasswordApi(payload: ResetPasswordRequest): Promise<string | undefined>;
 
-export declare function resolveAtbOrigin(url: string): string | null;
-
 export declare type RootState = ReturnType<typeof store.getState>;
 
-declare type SendMessageFn = (text?: string, transcriptionIds?: string[], options?: SendMessageOptions) => Promise<void>;
-
-declare type SendMessageFn_2 = (text?: string) => Promise<void>;
-
-declare type SendMessageFn_3 = (text?: string, transcriptionIds?: string[], options?: SendMessageOptions) => Promise<void>;
+export declare type SendMessageFn = (inputMsg?: string, transcriptionIds?: string[], options?: SendMessageOptions) => Promise<void>;
 
 export declare interface SendMessageOptions {
     messageType?: string[];
@@ -1240,6 +1179,7 @@ export declare interface StandardApiError {
 
 export declare interface StartConversationBody {
     client_metadata?: StartConversationMetadata;
+    locale?: string;
 }
 
 export declare interface StartConversationMetadata {
@@ -1551,11 +1491,11 @@ export declare const useAuth: () => {
 
 export declare const useChatCallbacks: () => ChatCallbacks;
 
-export declare const useChatConnection: ({ conversationId, messages, setMessages, enableTts, userLocation, startSession, debugMode, onPaymentInit, onSignInInit, onRequestDocuments, onConversationTitle, }: UseChatConnectionParams) => UseChatConnectionReturn;
+export declare const useChatConnection: ({ conversationId, setMessages, enableTts, userLocation, startSession, debugMode, onPaymentInit, onSignInInit, onRequestDocuments, onConversationTitle, initialMessage, locale, }: UseChatConnectionParams) => UseChatConnectionReturn;
 
 declare interface UseChatConnectionParams {
     conversationId: string | null;
-    messages: Message[];
+    messages?: Message[];
     setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
     enableTts?: boolean;
     userLocation?: UserLocation | null;
@@ -1565,10 +1505,12 @@ declare interface UseChatConnectionParams {
     onSignInInit?: (init: SignInInitPayload) => void;
     onRequestDocuments?: (payload: RequestDocumentsPayload) => void;
     onConversationTitle?: (title: string) => void;
+    initialMessage?: string | null;
+    locale?: string | null;
 }
 
 declare interface UseChatConnectionReturn {
-    sendMessage: (inputMsg?: string, transcriptionIds?: string[], options?: SendMessageOptions) => Promise<void>;
+    sendMessage: SendMessageFn;
     startInitialStream: (conversationId: string, location?: UserLocation | null) => Promise<void>;
     setThinkingState: (thinking: boolean) => void;
     abortStream: () => void;
@@ -4148,7 +4090,7 @@ export declare function useOAuthPopup({ signInInit, sendMessageRef, clearSignInI
 
 declare interface UseOAuthPopupArgs {
     signInInit: SignInInitPayload | null;
-    sendMessageRef: RefObject<SendMessageFn_2 | null>;
+    sendMessageRef: RefObject<SendMessageFn | null>;
     clearSignInInit: () => void;
     sendResumeMessage?: boolean;
 }
@@ -4156,7 +4098,7 @@ declare interface UseOAuthPopupArgs {
 export declare function usePayment({ sendMessageRef }: UsePaymentArgs): UsePaymentResult;
 
 export declare interface UsePaymentArgs {
-    sendMessageRef: MutableRefObject<SendMessageFn_3 | null>;
+    sendMessageRef: MutableRefObject<SendMessageFn | null>;
 }
 
 export declare const usePaymentFlow: ({ sendMessageRef, }: UsePaymentFlowArgs) => UsePaymentFlowReturn;