@1interface/chat-core 0.19.0-dev.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';
@@ -17,7 +18,6 @@ import { EnhancedStore } from '@reduxjs/toolkit';
 import { FetchArgs } from '@reduxjs/toolkit/query';
 import { FetchBaseQueryError } from '@reduxjs/toolkit/query';
 import { ForgotPasswordRequest } from '@1interface/shared-core';
-import { HostedPaymentPageInit } from '@1interface/shared-core';
 import { IdpHint } from '@1interface/shared-core';
 import { InheritedAuthAdapter } from '@1interface/shared-core';
 import { LoggerContextProvider } from '@1interface/shared-core';
@@ -175,9 +175,7 @@ getProfile: QueryDefinition<void, BaseQueryFn<string | FetchArgs, unknown, Fetch
 updateProfile: MutationDefinition<UpdateProfilePayload, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", void, "profileApi", unknown>;
 deleteAccount: MutationDefinition<void, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", void, "profileApi", unknown>;
 updatePassword: MutationDefinition<UpdatePasswordPayload, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", string, "profileApi", unknown>;
-}, string, "profileApi">, ThunkDispatch<any, any, UnknownAction>> | Middleware<    {}, RootState_2<    {
-getHostedPaymentStatus: QueryDefinition<HostedPaymentStatusArgs, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, never, HostedPaymentSettlementStatus, "paymentApi", unknown>;
-}, string, "paymentApi">, ThunkDispatch<any, any, UnknownAction>>)[];
+}, string, "profileApi">, ThunkDispatch<any, any, UnknownAction>>)[];
 
 export declare const apiReducers: {
     chatApi: Reducer<CombinedState<    {
@@ -253,13 +251,64 @@ export declare const apiReducers: {
     deleteAccount: MutationDefinition<void, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", void, "profileApi", unknown>;
     updatePassword: MutationDefinition<UpdatePasswordPayload, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", string, "profileApi", unknown>;
     }, "profile", "profileApi">, UnknownAction>;
-    paymentApi: Reducer<CombinedState<    {
-    getHostedPaymentStatus: QueryDefinition<HostedPaymentStatusArgs, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, never, HostedPaymentSettlementStatus, "paymentApi", unknown>;
-    }, never, "paymentApi">, UnknownAction>;
 };
 
 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;
@@ -363,14 +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 function buildHostedPaymentResult(input: HostedPaymentResultInput): PaymentResult;
-
 export declare const CHAT_INPUT_MODES: {
     readonly NORMAL: "normal";
     readonly RECORDING: "recording";
@@ -466,6 +513,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -551,9 +599,6 @@ updateProfile: MutationDefinition<UpdateProfilePayload, BaseQueryFn<string | Fet
 deleteAccount: MutationDefinition<void, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", void, "profileApi", unknown>;
 updatePassword: MutationDefinition<UpdatePasswordPayload, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", string, "profileApi", unknown>;
 }, "profile", "profileApi">;
-paymentApi: CombinedState<    {
-getHostedPaymentStatus: QueryDefinition<HostedPaymentStatusArgs, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, never, HostedPaymentSettlementStatus, "paymentApi", unknown>;
-}, never, "paymentApi">;
 }, UnknownAction, Partial<{
 auth: AuthState;
 chat: {
@@ -572,6 +617,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -657,9 +703,6 @@ updateProfile: MutationDefinition<UpdateProfilePayload, BaseQueryFn<string | Fet
 deleteAccount: MutationDefinition<void, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", void, "profileApi", unknown>;
 updatePassword: MutationDefinition<UpdatePasswordPayload, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", string, "profileApi", unknown>;
 }, "profile", "profileApi">;
-paymentApi: CombinedState<    {
-getHostedPaymentStatus: QueryDefinition<HostedPaymentStatusArgs, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, never, HostedPaymentSettlementStatus, "paymentApi", unknown>;
-}, never, "paymentApi">;
 }>>;
 
 export declare interface ChatIndicator {
@@ -714,6 +757,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 }>;
@@ -887,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;
@@ -907,82 +953,13 @@ export declare function guestLoginApi(): Promise<AuthApiResult>;
 
 export declare const hasAnyExtraData: (msg: any) => boolean;
 
-export declare const HOSTED_PAYMENT_DEFAULT_FAILURE_MESSAGE = "The payment was not completed.";
-
-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 const HOSTED_PAYMENT_SETTLEMENT_STATUSES: {
-    readonly SUCCEEDED: "succeeded";
-    readonly FAILED: "failed";
-    readonly CANCELED: "canceled";
-    readonly PENDING: "pending";
-};
-
-export declare interface HostedPaymentCharge {
-    amount?: number;
-    currency?: string;
-}
-
-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 interface HostedPaymentResultInput {
-    status: HostedPaymentPageStatus;
-    paymentId: string;
-    charge?: HostedPaymentCharge;
-    message?: string;
-    dismissed?: boolean;
-}
-
-export declare type HostedPaymentSettlementStatus = HostedPaymentPageStatus | "pending";
-
-export declare interface HostedPaymentStatusArgs {
-    referenceId: 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>;
 
@@ -1051,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 {
@@ -1084,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;
@@ -1171,9 +1146,14 @@ export declare interface QueuedMessage {
     transcriptionIds?: string[];
     messageType?: string[];
     documents?: AttachedDocument[];
+    modelText?: string;
 }
 
-export declare function readHostedPaymentStatus(value: unknown): HostedPaymentPageStatus | null;
+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>;
 
@@ -1187,19 +1167,20 @@ export declare const resetChatState: ActionCreatorWithoutPayload<"chat/resetChat
 
 export declare function resetPasswordApi(payload: ResetPasswordRequest): Promise<string | undefined>;
 
-export declare function resolveHostedPaymentCharge(reported: HostedPaymentCharge | null | undefined, init: HostedPaymentPageInit): HostedPaymentCharge;
+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: {
@@ -1223,8 +1204,6 @@ export declare const setStatusText: ActionCreatorWithOptionalPayload<string, "ch
 
 export declare function shouldDisableMessage(message: Message, allMessages: Message[], disableOldWidgets: boolean): boolean;
 
-export declare function shouldPollForSettlement(init: HostedPaymentPageInit): boolean;
-
 export declare function signupApi(payload: SignupRequest): Promise<SignupApiResult>;
 
 export declare enum SSEEventType {
@@ -1286,6 +1265,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -1371,9 +1351,6 @@ updateProfile: MutationDefinition<UpdateProfilePayload, BaseQueryFn<string | Fet
 deleteAccount: MutationDefinition<void, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", void, "profileApi", unknown>;
 updatePassword: MutationDefinition<UpdatePasswordPayload, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", string, "profileApi", unknown>;
 }, "profile", "profileApi">;
-paymentApi: CombinedState<    {
-getHostedPaymentStatus: QueryDefinition<HostedPaymentStatusArgs, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, never, HostedPaymentSettlementStatus, "paymentApi", unknown>;
-}, never, "paymentApi">;
 }, UnknownAction, Tuple<[StoreEnhancer<    {
 dispatch: ((action: Action<"listenerMiddleware/add">) => UnsubscribeListener) & ThunkDispatch<    {
 auth: AuthState;
@@ -1393,6 +1370,7 @@ filename: string;
 mime_type: string;
 size_bytes: number;
 }[];
+modelText?: string;
 }[];
 pendingTranscriptionIds: string[];
 };
@@ -1478,9 +1456,6 @@ updateProfile: MutationDefinition<UpdateProfilePayload, BaseQueryFn<string | Fet
 deleteAccount: MutationDefinition<void, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", void, "profileApi", unknown>;
 updatePassword: MutationDefinition<UpdatePasswordPayload, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "profile", string, "profileApi", unknown>;
 }, "profile", "profileApi">;
-paymentApi: CombinedState<    {
-getHostedPaymentStatus: QueryDefinition<HostedPaymentStatusArgs, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, never, HostedPaymentSettlementStatus, "paymentApi", unknown>;
-}, never, "paymentApi">;
 }, undefined, UnknownAction>;
 }>, StoreEnhancer]>>;
 
@@ -1531,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;
@@ -3855,19 +3832,6 @@ export declare function useGuestLogin(): {
     isLoading: boolean;
 };
 
-export declare const useHostedPaymentSettlement: ({ init, enabled, }: UseHostedPaymentSettlementArgs) => UseHostedPaymentSettlementResult;
-
-export declare interface UseHostedPaymentSettlementArgs {
-    init: HostedPaymentPageInit;
-    enabled: boolean;
-}
-
-export declare interface UseHostedPaymentSettlementResult {
-    polling: boolean;
-    status: Exclude<HostedPaymentSettlementStatus, "pending"> | null;
-    timedOut: boolean;
-}
-
 export declare function useInfiniteScroll({ hasMore, isLoadingRef, scrollAreaRef, onLoadMore, itemCount, }: {
     hasMore: boolean;
     isLoadingRef: MutableRefObject<boolean>;
@@ -3891,8 +3855,6 @@ export declare interface UseInheritedAuthBootResult {
 
 export declare const useIsDesktop: () => boolean;
 
-export declare function useLatestRef<T>(value: T): MutableRefObject<T>;
-
 export declare const useLazyGetConversationByIdQuery: <R extends Record<string, any> = TSHelpersId<(Omit<{
 status: QueryStatus.uninitialized;
 originalArgs?: undefined;