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

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 { AtbPaymentInit } from '@1interface/shared-core';
 import { AttachedDocument } from '@1interface/shared-core';
 import { AuthApiResult } from '@1interface/shared-core';
 import { AuthState } from '@1interface/shared-core';
@@ -254,6 +255,60 @@ 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;
@@ -357,12 +412,12 @@ 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;
 
-export declare function buildHostedPaymentPageThemeMessage(skin: PaymentSkin): HostedPaymentPageThemeMessage;
-
 export declare const CHAT_INPUT_MODES: {
     readonly NORMAL: "normal";
     readonly RECORDING: "recording";
@@ -458,6 +513,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -561,6 +617,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -700,6 +757,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 }>;
@@ -873,6 +931,8 @@ export declare function formatAmount(minorUnits: number | undefined, currency: s
 
 export declare function formatResultMessage(result: PaymentResult): string;
 
+export declare function formatResultModelContext(result: PaymentResult): string | undefined;
+
 export declare const GENERIC_SERVER_ERROR_MESSAGE = "Something went wrong. Please try again.";
 
 export declare function getApiErrorMessage(err: unknown, clientFallback?: string): string;
@@ -893,54 +953,13 @@ 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 SUCCEEDED: "succeeded";
-    readonly FAILED: "failed";
-    readonly CANCELED: "canceled";
-};
-
-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;
-    amount?: number;
-    currency?: string;
-    message?: string;
-}
-
-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 isAtbCheckoutUrl(value: unknown): value is string;
 
-export declare function isHostedPaymentPageCallbackMessage(value: unknown): value is HostedPaymentPageCallbackMessage;
+export declare function isAtbMessage(value: unknown): value is AtbMessage;
 
-export declare function isHostedPaymentPageUrl(value: unknown): value is string;
+export declare const isEmptyMessage: (v: any) => boolean;
 
 export declare function loginApi(email: string, password: string): Promise<AuthApiResult>;
 
@@ -1009,8 +1028,6 @@ 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 {
@@ -1042,14 +1059,14 @@ export declare type PaymentResult = {
     paymentId: string;
     amount?: number;
     currency?: string;
-    dismissed?: boolean;
+    checkoutId?: string;
 } | {
     status: "failure";
     provider: PaymentProviderType;
     code?: string;
     message: string;
     paymentId?: string;
-    dismissed?: boolean;
+    checkoutId?: string;
 } | {
     status: "cancel";
     provider: PaymentProviderType;
@@ -1129,8 +1146,15 @@ export declare interface QueuedMessage {
     transcriptionIds?: string[];
     messageType?: string[];
     documents?: AttachedDocument[];
+    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>;
@@ -1143,17 +1167,20 @@ 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) => Promise<void>;
+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) => Promise<void>;
+declare type SendMessageFn_3 = (text?: string, transcriptionIds?: string[], options?: SendMessageOptions) => Promise<void>;
 
 export declare interface SendMessageOptions {
     messageType?: string[];
     documents?: AttachedDocument[];
+    modelText?: string;
 }
 
 export declare const serializableCheck: {
@@ -1238,6 +1265,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -1342,6 +1370,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -1477,6 +1506,8 @@ export declare const THINKING_MESSAGES: {
 
 export { TokenRefreshResult }
 
+export declare function toModelContext(documents?: AttachedDocument[], modelText?: string): ModelContextPart[] | undefined;
+
 export declare interface ToolServer {
     id: string;
     name: string;