@1interface/chat-core 0.20.3 → 0.22.0

package/dist/index.d.ts

@@ -13,6 +13,7 @@ import { CombinedState } from '@reduxjs/toolkit/query';
 import { Context } from 'react';
 import { coreModuleName } from '@reduxjs/toolkit/query';
 import { Dispatch } from 'react';
+import { DocumentMetadata } from '@1interface/shared-core';
 import { EnhancedStore } from '@reduxjs/toolkit';
 import { FetchArgs } from '@reduxjs/toolkit/query';
 import { FetchBaseQueryError } from '@reduxjs/toolkit/query';
@@ -35,7 +36,6 @@ import { QueryDefinition } from '@reduxjs/toolkit/query';
 import { QueryStatus } from '@reduxjs/toolkit/query';
 import { QuerySubState } from '@reduxjs/toolkit/query';
 import { reactHooksModuleName } from '@reduxjs/toolkit/query/react';
-import { ReactNode } from 'react';
 import { Reducer } from '@reduxjs/toolkit';
 import { RefObject } from 'react';
 import { RefreshApiResult } from '@1interface/shared-core';
@@ -136,6 +136,7 @@ file: DocumentUploadFile;
 filename?: string;
 documentType?: string;
 conversationId?: string;
+metadata?: DocumentMetadata;
 onUploadProgress?: (loaded: number, total: number) => void;
 onUploadComplete?: () => void;
 }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "chat" | "toolServers", {
@@ -209,6 +210,7 @@ export declare const apiReducers: {
     filename?: string;
     documentType?: string;
     conversationId?: string;
+    metadata?: DocumentMetadata;
     onUploadProgress?: (loaded: number, total: number) => void;
     onUploadComplete?: () => void;
     }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "chat" | "toolServers", {
@@ -361,8 +363,6 @@ export declare interface BridgeRequestOptions {
 
 export declare function buildBrandSkin(styles: ChatThemeStyles, resolvedTheme: "light" | "dark"): PaymentSkin;
 
-export declare function buildCallbackUrl(givenId?: string | null): string;
-
 export declare const CHAT_INPUT_MODES: {
     readonly NORMAL: "normal";
     readonly RECORDING: "recording";
@@ -400,6 +400,7 @@ file: DocumentUploadFile;
 filename?: string;
 documentType?: string;
 conversationId?: string;
+metadata?: DocumentMetadata;
 onUploadProgress?: (loaded: number, total: number) => void;
 onUploadComplete?: () => void;
 }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "chat" | "toolServers", {
@@ -502,6 +503,7 @@ file: DocumentUploadFile;
 filename?: string;
 documentType?: string;
 conversationId?: string;
+metadata?: DocumentMetadata;
 onUploadProgress?: (loaded: number, total: number) => void;
 onUploadComplete?: () => void;
 }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "chat" | "toolServers", {
@@ -607,6 +609,7 @@ file: DocumentUploadFile;
 filename?: string;
 documentType?: string;
 conversationId?: string;
+metadata?: DocumentMetadata;
 onUploadProgress?: (loaded: number, total: number) => void;
 onUploadComplete?: () => void;
 }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "chat" | "toolServers", {
@@ -821,10 +824,21 @@ export declare function createSessionRefresher(store: SessionStoreLike): () => P
 
 export declare const DEFAULT_CONVERSATION_TITLE = "New Conversation";
 
-export declare const DEFAULT_PAYMENT_PROVIDER: PaymentProviderType;
-
 export declare const DEFAULT_PROTOCOL: ProtocolType;
 
+export declare function defaultAgentText({ status, amount, currency, paymentId }: DefaultAgentTextInput): string;
+
+export declare interface DefaultAgentTextInput {
+    status: PaymentOutcomeStatus;
+    amount?: number;
+    currency?: string;
+    paymentId?: string;
+}
+
+export declare function defaultCancelOutcome({ modelText }?: {
+    modelText?: string;
+}): PaymentOutcome;
+
 export declare const dequeueMessage: ActionCreatorWithoutPayload<"chat/dequeueMessage">;
 
 export declare interface DocumentsConfig {
@@ -876,15 +890,6 @@ 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 interface FormattedPaymentResult {
-    text: string;
-    modelText?: string;
-}
-
 export declare const GENERIC_SERVER_ERROR_MESSAGE = "Something went wrong. Please try again.";
 
 export declare function getApiErrorMessage(err: unknown, clientFallback?: string): string;
@@ -901,6 +906,8 @@ export declare function getErrorGroup(error: unknown): string | null;
 
 export declare const getLatestRequestId: () => string;
 
+export declare function getPaymentProvider(type?: string | null): PaymentProviderEntry | undefined;
+
 export declare function guestLoginApi(): Promise<AuthApiResult>;
 
 export declare const hasAnyExtraData: (msg: any) => boolean;
@@ -945,13 +952,6 @@ export declare interface MessageArrival {
 
 export declare const MODEL_CONTEXT_TEXT_MAX_LENGTH = 1000;
 
-export declare const MOYASAR_CALLBACK_SENTINEL = "moyasar_cb";
-
-export declare interface MoyasarCallbackResult {
-    result: PaymentResult;
-    conversationId: string | null;
-}
-
 export declare interface NormalizedEvent {
     type: NormalizedEventType;
     data: NormalizedEventData;
@@ -982,6 +982,14 @@ export declare type NormalizedEventData = {
 
 export declare type NormalizedEventType = 'text' | 'error' | 'widget' | 'status_update' | 'payment' | 'sign_in' | 'request_documents' | 'conversation_title' | 'stream_end';
 
+export declare interface NormalizedPayment<Config = unknown> {
+    provider: string;
+    paymentId: string;
+    amount?: number;
+    currency?: string;
+    config: Config;
+}
+
 export declare const OAUTH_ERROR_TYPE: "OAUTH_ERROR";
 
 export declare const OAUTH_SUCCESS_TYPE: "OAUTH_SUCCESS";
@@ -992,21 +1000,16 @@ export declare const PAGINATION: {
     readonly MESSAGE_PAGE_SIZE: 25;
 };
 
-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 const PAYMENT_OUTCOME_STATUSES: {
+    readonly SUCCESS: "success";
+    readonly FAILURE: "failure";
+    readonly CANCEL: "cancel";
 };
 
 export declare interface PaymentAdapter {
-    readonly type: PaymentProviderType;
     readonly label: string;
     readonly hideShellSubmit?: boolean;
     readonly hideShellFooter?: boolean;
-    ProviderWrapper?: React.FC<{
-        children: ReactNode;
-    }>;
     FormComponent: React.FC<PaymentFormProps>;
 }
 
@@ -1016,12 +1019,31 @@ export declare interface PaymentConfirmHandle {
 }
 
 export declare interface PaymentFormProps {
-    amount: number;
-    currency: string;
     skin: PaymentSkin;
     onReady?: () => void;
 }
 
+export declare interface PaymentOutcome {
+    status: PaymentOutcomeStatus;
+    agentText: string;
+    modelText?: string;
+    userMessage?: string;
+}
+
+export declare type PaymentOutcomeStatus = (typeof PAYMENT_OUTCOME_STATUSES)[keyof typeof PAYMENT_OUTCOME_STATUSES];
+
+export declare type PaymentProviderEntry<Config = unknown> = PaymentProviderSpec<Config> & {
+    loadAdapter(): Promise<{
+        default: PaymentAdapter;
+    }>;
+};
+
+export declare interface PaymentProviderSpec<Config = unknown> {
+    type: PaymentProviderType;
+    normalize(raw: PaymentInitPayload): NormalizedPayment<Config> | null;
+    cancelOutcome?(payment: NormalizedPayment<Config>): PaymentOutcome;
+}
+
 export declare type PaymentResult = {
     status: "success";
     provider: PaymentProviderType;
@@ -1039,6 +1061,8 @@ export declare type PaymentResult = {
     provider: PaymentProviderType;
 };
 
+declare type PaymentResultInput = PaymentOutcome | PaymentResult;
+
 export declare interface PaymentSkin {
     pageBg: string;
     cardBg: string;
@@ -1119,6 +1143,8 @@ export declare interface QueuedMessage {
 
 export declare function refreshTokenApi(payload: RefreshRequest): Promise<RefreshApiResult>;
 
+export declare function registerPaymentProvider<Config>(entry: PaymentProviderEntry<Config>): void;
+
 export declare function resendVerificationApi(payload: ResendVerificationRequest): Promise<string | undefined>;
 
 export declare const resetAllApiState: () => ThunkAction<void, unknown, unknown, UnknownAction>;
@@ -1129,6 +1155,8 @@ export declare const resetChatState: ActionCreatorWithoutPayload<"chat/resetChat
 
 export declare function resetPasswordApi(payload: ResetPasswordRequest): Promise<string | undefined>;
 
+export declare function resolvePaymentProvider(provider?: unknown): PaymentProviderEntry | undefined;
+
 export declare type RootState = ReturnType<typeof store.getState>;
 
 export declare type SendMessageFn = (inputMsg?: string, transcriptionIds?: string[], options?: SendMessageOptions) => Promise<void>;
@@ -1152,6 +1180,8 @@ export declare interface SessionStoreLike {
 
 export declare const setActiveConversationId: ActionCreatorWithOptionalPayload<string, "conversations/setActiveConversationId">;
 
+export declare function setDefaultPaymentProvider(type: string): void;
+
 export declare const setIsAgentWorking: ActionCreatorWithOptionalPayload<boolean, "chat/setIsAgentWorking">;
 
 export declare const setResponseStartTime: ActionCreatorWithOptionalPayload<number, "chat/setResponseStartTime">;
@@ -1266,6 +1296,7 @@ file: DocumentUploadFile;
 filename?: string;
 documentType?: string;
 conversationId?: string;
+metadata?: DocumentMetadata;
 onUploadProgress?: (loaded: number, total: number) => void;
 onUploadComplete?: () => void;
 }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "chat" | "toolServers", {
@@ -1372,6 +1403,7 @@ file: DocumentUploadFile;
 filename?: string;
 documentType?: string;
 conversationId?: string;
+metadata?: DocumentMetadata;
 onUploadProgress?: (loaded: number, total: number) => void;
 onUploadComplete?: () => void;
 }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "chat" | "toolServers", {
@@ -4129,31 +4161,33 @@ declare interface UsePaymentFlowArgs {
 
 declare interface UsePaymentFlowReturn {
     paymentInit: PaymentInitPayload | null;
+    payment: NormalizedPayment | null;
     setPaymentInit: (next: PaymentInitPayload | null) => void;
     clearPaymentInit: () => void;
-    handlePaymentResult: (result: PaymentResult) => void;
+    handlePaymentResult: (result: PaymentOutcome | PaymentResult) => void;
 }
 
 export declare interface UsePaymentResult {
     paymentInit: PaymentInitPayload | null;
+    payment: NormalizedPayment | null;
     setPaymentInit: (next: PaymentInitPayload | null) => void;
     isOpen: boolean;
     onOpenChange: (open: boolean) => void;
-    onResult: (result: PaymentResult) => void;
+    onResult: (result: PaymentOutcome | PaymentResult) => void;
     clearPaymentInit: () => void;
 }
 
-export declare function usePaymentResultDedup({ paymentInit, onPaymentResult, onClearPaymentInit, }: UsePaymentResultDedupArgs): UsePaymentResultDedupReturn;
+export declare function usePaymentResultDedup({ payment, onPaymentResult, onClearPaymentInit, }: UsePaymentResultDedupArgs): UsePaymentResultDedupReturn;
 
 declare interface UsePaymentResultDedupArgs {
-    paymentInit: PaymentInitPayload | null;
-    onPaymentResult?: (result: PaymentResult) => void;
+    payment: NormalizedPayment | null;
+    onPaymentResult?: (result: PaymentResultInput) => void;
     onClearPaymentInit?: () => void;
 }
 
 declare interface UsePaymentResultDedupReturn {
-    handlePaymentResult: (result: PaymentResult) => void;
-    handleModalOpenChange: (next: boolean) => void;
+    handlePaymentResult: (result: PaymentResultInput) => void;
+    handleSurfaceOpenChange: (next: boolean) => void;
 }
 
 export declare const useProtocol: () => ProtocolContextType;
@@ -5237,6 +5271,7 @@ export declare const useUploadDocumentMutation: <R extends Record<string, any> =
     filename?: string;
     documentType?: string;
     conversationId?: string;
+    metadata?: DocumentMetadata;
     onUploadProgress?: (loaded: number, total: number) => void;
     onUploadComplete?: () => void;
 }) => MutationActionCreatorResult<MutationDefinition<    {
@@ -5244,6 +5279,7 @@ file: DocumentUploadFile;
 filename?: string;
 documentType?: string;
 conversationId?: string;
+metadata?: DocumentMetadata;
 onUploadProgress?: (loaded: number, total: number) => void;
 onUploadComplete?: () => void;
 }, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, "chat" | "toolServers", {
@@ -5261,6 +5297,7 @@ size_bytes: number;
         filename?: string;
         documentType?: string;
         conversationId?: string;
+        metadata?: DocumentMetadata;
         onUploadProgress?: (loaded: number, total: number) => void;
         onUploadComplete?: () => void;
     };