@1interface/chat-core 0.17.0 → 0.19.0-dev.0

package/dist/index.d.ts

@@ -17,6 +17,7 @@ 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';
@@ -174,7 +175,9 @@ 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>>)[];
+}, 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>>)[];
 
 export declare const apiReducers: {
     chatApi: Reducer<CombinedState<    {
@@ -250,6 +253,9 @@ 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;
@@ -363,6 +369,8 @@ 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";
@@ -543,6 +551,9 @@ 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: {
@@ -646,6 +657,9 @@ 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 {
@@ -893,6 +907,8 @@ 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";
@@ -903,12 +919,25 @@ export declare const HOSTED_PAYMENT_PAGE_CALLBACK_MESSAGE_TYPE = "hosted-payment
 export declare const HOSTED_PAYMENT_PAGE_CALLBACK_PATH = "/payment-callback.html";
 
 export declare const HOSTED_PAYMENT_PAGE_STATUSES: {
-    readonly SUCCESS: "success";
+    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 {
@@ -920,6 +949,9 @@ export declare interface HostedPaymentPageCallbackMessage {
 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];
@@ -930,6 +962,20 @@ export declare interface HostedPaymentPageThemeMessage {
     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;
@@ -1127,6 +1173,8 @@ export declare interface QueuedMessage {
     documents?: AttachedDocument[];
 }
 
+export declare function readHostedPaymentStatus(value: unknown): HostedPaymentPageStatus | null;
+
 export declare function refreshTokenApi(payload: RefreshRequest): Promise<RefreshApiResult>;
 
 export declare function resendVerificationApi(payload: ResendVerificationRequest): Promise<string | undefined>;
@@ -1139,6 +1187,8 @@ 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 type RootState = ReturnType<typeof store.getState>;
 
 declare type SendMessageFn = (text?: string) => Promise<void>;
@@ -1173,6 +1223,8 @@ 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 {
@@ -1319,6 +1371,9 @@ 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;
@@ -1423,6 +1478,9 @@ 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]>>;
 
@@ -3797,6 +3855,19 @@ 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>;
@@ -3820,6 +3891,8 @@ 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;