@zeniai/client-epic-state 5.1.34 → 5.1.35

package/lib/view/expenseAutomationView/payload/reconciliationPayload.d.ts

@@ -8,8 +8,8 @@ import { FilePayload } from '../../../entity/file/filePayload';
 import { MatchedTransactionPayload } from '../../../entity/transaction/payloadTypes/reconciliationTransactionPayloads';
 import { UserPayload } from '../../../entity/user/userPayload';
 import { RootState } from '../../../reducer';
-import { ZeniAPIResponse } from '../../../responsePayload';
-import { BalancesLocalData, SaveReconcileDetailActionPayload } from '../types/reconciliationViewState';
+import { ZeniAPIResponse, ZeniAPIStatus } from '../../../responsePayload';
+import { BalancesLocalData, ParsedStatementData, SaveReconcileDetailActionPayload, StatementDateConflict, StatementUpdateLocalData, StatementUpdateLocalDataPayload } from '../types/reconciliationViewState';
 export interface DetectionInfoPayload {
     account_id: string;
     bank_balance: number | null;
@@ -31,6 +31,31 @@ interface ExclusionInfoPayload {
 export interface ExcludedAccountPayload extends AccountAndPaymentAccountPayload {
     exclusion_info: ExclusionInfoPayload;
 }
+export interface ReconciliationProgressBarPayload {
+    ai_percentage_share: number;
+    complete_percentage: number;
+    human_percentage_share: number;
+    remaining_percentage: number;
+}
+export interface ReconciliationSummaryPayload {
+    accounts: {
+        done: number;
+        failed: number;
+        in_progress: number;
+        total: number;
+    };
+    accounts_to_connect_count: number;
+    auto_matched: {
+        matched_txns: number;
+        total_txns: number;
+    };
+    needs_review: {
+        account_count: number;
+        txn_count: number;
+    };
+    time_saved_percentage: number;
+    progress_bar?: ReconciliationProgressBarPayload;
+}
 export interface ReconciliationPayload {
     accounts: AccountAndPaymentAccountPayload[];
     files: FilePayload[];
@@ -39,6 +64,7 @@ export interface ReconciliationPayload {
     detection_info?: DetectionInfoPayload;
     detection_reason?: string;
     excluded_accounts?: ExcludedAccountPayload[];
+    summary?: ReconciliationSummaryPayload;
 }
 export type ReconciliationResponse = ZeniAPIResponse<ReconciliationPayload>;
 export interface SaveReconciliationReviewPayload {
@@ -86,16 +112,156 @@ export interface UploadStatementDocumentAIPayload {
     processor_run_id: string;
 }
 export type UploadStatementDocumentAIResponse = ZeniAPIResponse<UploadStatementDocumentAIPayload>;
+export interface StatementUploadSummaryPayload {
+    account_type: string;
+    statement_data_status: StatusCodeWithLabelPayload;
+    statement_end_date: string;
+    statement_start_date: string;
+    statement_status: StatusCodeWithLabelPayload;
+    statement_upload_id: string;
+}
 export interface UploadStatementResponsePayload {
     file: FilePayload;
-    statement_upload: {
-        account_type: string;
-        statement_data_status: StatusCodeWithLabelPayload;
-        statement_end_date: string;
-        statement_start_date: string;
-        statement_status: StatusCodeWithLabelPayload;
-        statement_upload_id: string;
-    };
+    statement_upload: StatementUploadSummaryPayload;
 }
 export type UploadStatementResponse = ZeniAPIResponse<UploadStatementResponsePayload>;
+export interface PolygonPointPayload {
+    x: number;
+    y: number;
+}
+export interface CitationPayload {
+    page: number;
+    page_height: number;
+    page_width: number;
+    polygon: PolygonPointPayload[];
+    reference_text: string;
+}
+export interface StatementTransactionPayload {
+    amount: number;
+    citation: CitationPayload[];
+    is_user_added: boolean;
+    is_user_edited: boolean;
+    statement_transaction_id: string;
+    transaction_date: string;
+    transaction_direction: 'debit' | 'credit';
+    transaction_memo: string;
+}
+export interface ReconciliationMetaPayload {
+    end_date: string;
+    reconciliation_id: string;
+    start_date: string;
+    status: string;
+}
+export interface StatementMetaPayload {
+    closing_balance: number;
+    opening_balance: number;
+    statement_data_status: StatusCodeWithLabelPayload;
+    statement_end_date: string;
+    statement_start_date: string;
+    statement_status: StatusCodeWithLabelPayload;
+    statement_upload_id: string;
+    total_deposits: number;
+    total_payments: number;
+}
+export interface AccountInfoPayload {
+    account_id: string;
+    account_name: string;
+    account_type: string;
+    currency_code: string;
+    last_4_digits: string | null;
+}
+export interface FileInfoPayload {
+    file_id: string;
+    file_name: string;
+    signed_url: string;
+}
+export interface AiSummaryFieldPayload {
+    code: string;
+    label: string;
+}
+export interface PreviousReconciliationInfoPayload {
+    end_date: string;
+    reconciled_at: string;
+    reconciled_by_user_id: string;
+    reconciliation_id: string;
+    start_date: string;
+}
+export interface AiSummaryChainStatusPayload {
+    code: string;
+    expected_start_date: string | null;
+    label: string;
+    previous_reconciliation_info: PreviousReconciliationInfoPayload | null;
+}
+export interface AiSummaryPayload {
+    account_identified: string | null;
+    chain_status: AiSummaryChainStatusPayload;
+    exceptions_detected: number;
+    fields_captured: AiSummaryFieldPayload[];
+    transactions_extracted: number;
+}
+export interface StatementUploadPayload {
+    account: AccountInfoPayload;
+    file: FileInfoPayload | null;
+    statement_meta: StatementMetaPayload;
+    statement_transactions: StatementTransactionPayload[];
+    ai_summary?: AiSummaryPayload | null;
+}
+export interface ParseStatementResponsePayload {
+    reconciliation: ReconciliationMetaPayload;
+    statement_upload: StatementUploadPayload;
+}
+export interface ReparseStatementResponsePayload {
+    statement_upload: StatementUploadSummaryPayload;
+}
+export type ParseStatementResponse = ZeniAPIResponse<ParseStatementResponsePayload>;
+export type ReparseStatementResponse = ZeniAPIResponse<ReparseStatementResponsePayload>;
+/**
+ * Statement period chain validation (Confirm & Save).
+ *
+ * - 200 (auto-trim): the BE trimmed the start date and returns a
+ *   `date_adjustment` block alongside the usual reconciliation /
+ *   statement_upload data.
+ * - 409: the upload was rejected (total overlap or gap). The error fields
+ *   (`error_code`, `expected_start_date`, `previous_reconciliation_info`)
+ *   live at the top level of the response, next to `status`.
+ */
+export type StatementChainErrorCode = 'STATEMENT_RANGE_ALREADY_RECONCILED' | 'STATEMENT_RANGE_HAS_GAP';
+export interface StatementDateAdjustmentPayload {
+    adjusted_start_date: string;
+    original_start_date: string;
+    previous_reconciliation_info: PreviousReconciliationInfoPayload;
+    reason: string;
+}
+export interface UpdateStatementInfoResponsePayload {
+    reconciliation: ReconciliationMetaPayload;
+    statement_upload: StatementUploadPayload;
+    date_adjustment?: StatementDateAdjustmentPayload | null;
+}
+/** 2xx Confirm & Save — carries parsed statement data, no chain-validation errors. */
+export interface UpdateStatementInfoSuccessResponse extends ZeniAPIResponse<UpdateStatementInfoResponsePayload> {
+    error_code?: undefined;
+    expected_start_date?: undefined;
+    previous_reconciliation_info?: undefined;
+}
+/** 409 Confirm & Save — chain validation rejected the statement period. */
+export interface UpdateStatementInfoConflictResponse extends ZeniAPIResponse<UpdateStatementInfoResponsePayload | undefined> {
+    error_code: StatementChainErrorCode;
+    status: ZeniAPIStatus & {
+        code: 409;
+    };
+    expected_start_date?: string | null;
+    previous_reconciliation_info?: PreviousReconciliationInfoPayload | null;
+}
+export type UpdateStatementInfoResponse = UpdateStatementInfoSuccessResponse | UpdateStatementInfoConflictResponse;
+export declare function isStatementDateConflictResponse(response: UpdateStatementInfoResponse): response is UpdateStatementInfoConflictResponse;
+/**
+ * Builds date-conflict state from a 409 Confirm & Save response.
+ * Returns null for non-409 responses or 409s without a recognized error code.
+ */
+export declare function transformStatementDateConflictToState(response: UpdateStatementInfoResponse): StatementDateConflict | null;
+export declare function transformParseStatementPayloadToState(payload: ParseStatementResponsePayload): ParsedStatementData;
+export declare function transformUpdateStatementInfoPayloadToState(payload: UpdateStatementInfoResponsePayload): ParsedStatementData;
+export declare function transformStatementUpdateStateToPayload(localData: StatementUpdateLocalData): StatementUpdateLocalDataPayload;
+/** API request body for PUT statement-uploads; cast lives here for putAndGetJSON. */
+export declare function toStatementUpdateRequestBody(localData: StatementUpdateLocalData): Record<string, unknown>;
 export {};

package/lib/view/expenseAutomationView/payload/reconciliationPayload.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSaveReconciliationPayloadBasedOnActionAndMethod = createSaveReconciliationPayloadBasedOnActionAndMethod;
+exports.isStatementDateConflictResponse = isStatementDateConflictResponse;
+exports.transformStatementDateConflictToState = transformStatementDateConflictToState;
+exports.transformParseStatementPayloadToState = transformParseStatementPayloadToState;
+exports.transformUpdateStatementInfoPayloadToState = transformUpdateStatementInfoPayloadToState;
+exports.transformStatementUpdateStateToPayload = transformStatementUpdateStateToPayload;
+exports.toStatementUpdateRequestBody = toStatementUpdateRequestBody;
 const timePeriod_1 = require("../../../commonStateTypes/timePeriod");
 const accountReconPayload_1 = require("../../../entity/accountRecon/accountReconPayload");
 const reconciliationTransactionPayloads_1 = require("../../../entity/transaction/payloadTypes/reconciliationTransactionPayloads");
@@ -70,3 +76,156 @@ function createReviewTransactionPayload(accountReconciliationEntity) {
     });
     return reviewTransactionsPayload;
 }
+function isStatementDateConflictResponse(response) {
+    return response.status.code === 409 && response.error_code != null;
+}
+function transformStatementUploadPayloadToState(statementUploadPayload) {
+    return {
+        account: {
+            accountId: statementUploadPayload.account.account_id,
+            accountName: statementUploadPayload.account.account_name,
+            accountType: statementUploadPayload.account.account_type,
+            currencyCode: statementUploadPayload.account.currency_code,
+            last4Digits: statementUploadPayload.account.last_4_digits,
+        },
+        file: statementUploadPayload.file != null
+            ? {
+                fileId: statementUploadPayload.file.file_id,
+                fileName: statementUploadPayload.file.file_name,
+                signedUrl: statementUploadPayload.file.signed_url,
+            }
+            : null,
+        statementMeta: {
+            closingBalance: statementUploadPayload.statement_meta.closing_balance,
+            openingBalance: statementUploadPayload.statement_meta.opening_balance,
+            statementDataStatus: statementUploadPayload.statement_meta.statement_data_status,
+            statementEndDate: statementUploadPayload.statement_meta.statement_end_date,
+            statementStartDate: statementUploadPayload.statement_meta.statement_start_date,
+            statementStatus: statementUploadPayload.statement_meta.statement_status,
+            statementUploadId: statementUploadPayload.statement_meta.statement_upload_id,
+            totalDeposits: statementUploadPayload.statement_meta.total_deposits,
+            totalPayments: statementUploadPayload.statement_meta.total_payments,
+        },
+        statementTransactions: (statementUploadPayload.statement_transactions ?? []).map((txn) => ({
+            amount: txn.amount,
+            citations: (txn.citation ?? []).map((c) => ({
+                page: c.page,
+                pageHeight: c.page_height,
+                pageWidth: c.page_width,
+                polygon: (c.polygon ?? []).map((point) => ({
+                    x: point.x,
+                    y: point.y,
+                })),
+                referenceText: c.reference_text,
+            })),
+            isUserAdded: txn.is_user_added,
+            isUserEdited: txn.is_user_edited,
+            statementTransactionId: txn.statement_transaction_id,
+            transactionDate: txn.transaction_date,
+            transactionDirection: txn.transaction_direction,
+            transactionMemo: txn.transaction_memo,
+        })),
+        aiSummary: transformAiSummaryPayloadToState(statementUploadPayload.ai_summary),
+    };
+}
+function transformPreviousReconciliationInfoToState(payload) {
+    if (payload == null) {
+        return null;
+    }
+    return {
+        endDate: payload.end_date,
+        reconciledAt: payload.reconciled_at,
+        reconciledByUserId: payload.reconciled_by_user_id,
+        reconciliationId: payload.reconciliation_id,
+        startDate: payload.start_date,
+    };
+}
+function transformAiSummaryPayloadToState(aiSummaryPayload) {
+    if (aiSummaryPayload == null) {
+        return null;
+    }
+    const { chain_status: chainStatus } = aiSummaryPayload;
+    return {
+        accountIdentified: aiSummaryPayload.account_identified,
+        transactionsExtracted: aiSummaryPayload.transactions_extracted,
+        exceptionsDetected: aiSummaryPayload.exceptions_detected,
+        fieldsCaptured: (aiSummaryPayload.fields_captured ?? []).map((field) => ({
+            code: field.code,
+            label: field.label,
+        })),
+        chainStatus: {
+            code: chainStatus?.code ?? '',
+            label: chainStatus?.label ?? '',
+            expectedStartDate: chainStatus?.expected_start_date ?? null,
+            previousReconciliationInfo: transformPreviousReconciliationInfoToState(chainStatus?.previous_reconciliation_info),
+        },
+    };
+}
+/**
+ * Builds date-conflict state from a 409 Confirm & Save response.
+ * Returns null for non-409 responses or 409s without a recognized error code.
+ */
+function transformStatementDateConflictToState(response) {
+    if (isStatementDateConflictResponse(response) === false) {
+        return null;
+    }
+    const previousReconciliationInfo = transformPreviousReconciliationInfoToState(response.previous_reconciliation_info);
+    if (response.error_code === 'STATEMENT_RANGE_ALREADY_RECONCILED' &&
+        previousReconciliationInfo == null) {
+        return null;
+    }
+    if (response.error_code === 'STATEMENT_RANGE_HAS_GAP' &&
+        response.expected_start_date == null &&
+        previousReconciliationInfo == null) {
+        return null;
+    }
+    return {
+        errorCode: response.error_code,
+        expectedStartDate: response.expected_start_date ?? null,
+        ...(previousReconciliationInfo != null ? { previousReconciliationInfo } : {}),
+    };
+}
+function transformParseStatementPayloadToState(payload) {
+    return {
+        statementUpload: transformStatementUploadPayloadToState(payload.statement_upload),
+    };
+}
+function transformUpdateStatementInfoPayloadToState(payload) {
+    return {
+        statementUpload: transformStatementUploadPayloadToState(payload.statement_upload),
+    };
+}
+function transformStatementUpdateStateToPayload(localData) {
+    const { statementMeta, statementTransactions } = localData;
+    return {
+        statement_meta: {
+            opening_balance: statementMeta.openingBalance,
+            statement_end_date: statementMeta.statementEndDate,
+            statement_start_date: statementMeta.statementStartDate,
+            total_deposits: statementMeta.totalDeposits,
+            total_payments: statementMeta.totalPayments,
+        },
+        statement_transactions: {
+            added: statementTransactions.added.map((txn) => ({
+                amount: txn.amount,
+                transaction_date: txn.transactionDate,
+                transaction_direction: txn.transactionDirection,
+                transaction_memo: txn.transactionMemo,
+            })),
+            deleted_ids: statementTransactions.deletedIds,
+            updated: statementTransactions.updated
+                .filter((txn) => txn.statementTransactionId != null)
+                .map((txn) => ({
+                amount: txn.amount,
+                statement_transaction_id: txn.statementTransactionId,
+                transaction_date: txn.transactionDate,
+                transaction_direction: txn.transactionDirection,
+                transaction_memo: txn.transactionMemo,
+            })),
+        },
+    };
+}
+/** API request body for PUT statement-uploads; cast lives here for putAndGetJSON. */
+function toStatementUpdateRequestBody(localData) {
+    return transformStatementUpdateStateToPayload(localData);
+}

package/lib/view/expenseAutomationView/reducers/reconciliationViewReducer.d.ts

@@ -5,7 +5,7 @@ import { MonthYearPeriod } from '../../../commonStateTypes/timePeriod';
 import { ReconciliationDataPayload } from '../../../entity/accountRecon/accountReconPayload';
 import { ZeniAPIStatus } from '../../../responsePayload';
 import { ExcludedAccountFromReconciliationPayload, ReconciliationPayload, UploadStatementDocumentAIPayload } from '../payload/reconciliationPayload';
-import { AccountReconciliationLocalData, ActionFetchStates, ExcludeAccountFromReconciliationPayload, ReconReconcileSortKey, ReconReviewSortKey, ReconciliationReviewTabLocalData, ReconciliationTabsState, ReconciliationViewState, ReconciliationViewTabType, SaveReconcileDetailActionPayload, SaveReconciliationDetailFailurePayload, TransactionSummary } from '../types/reconciliationViewState';
+import { AccountReconciliationLocalData, ActionFetchStates, ExcludeAccountFromReconciliationPayload, ParsedStatementData, ReconReconcileSortKey, ReconReviewSortKey, ReconciliationReviewTabLocalData, ReconciliationTabsState, ReconciliationViewState, ReconciliationViewTabType, SaveReconcileDetailActionPayload, SaveReconciliationDetailFailurePayload, StatementDateConflict, StatementUpdateLocalData, TransactionSummary } from '../types/reconciliationViewState';
 export declare const initialReconciliationTabsState: ReconciliationTabsState;
 export declare const initialActionFetchState: ActionFetchStates;
 export declare const initialState: ReconciliationViewState;
@@ -52,7 +52,9 @@ export declare const fetchReconciliation: import("@reduxjs/toolkit").ActionCreat
     variancePercentage?: number;
 }, "expenseAutomationReconciliationView/updateBalancesLocalData">, initialiseLocalDataForSelectedAccountId: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationReconciliationView/initialiseLocalDataForSelectedAccountId">, clearExpenseAutomationReconciliationView: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationReconciliationView/clearExpenseAutomationReconciliationView">, updateSelectedDrawerAccountId: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     selectedDrawerAccountId?: ID;
-}, "expenseAutomationReconciliationView/updateSelectedDrawerAccountId">, updateReviewTabSortState: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+}, "expenseAutomationReconciliationView/updateSelectedDrawerAccountId">, updateStatementProcessingFailed: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    statementProcessingFailed: boolean;
+}, "expenseAutomationReconciliationView/updateStatementProcessingFailed">, updateReviewTabSortState: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     sortKey: ReconReviewSortKey;
     sortOrder: SortOrder;
 }, "expenseAutomationReconciliationView/updateReviewTabSortState">, initializeReconciliationReviewTabLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[localData: Record<string, ReconciliationReviewTabLocalData>], {
@@ -108,7 +110,55 @@ export declare const fetchReconciliation: import("@reduxjs/toolkit").ActionCreat
     accountId: ID;
     error: ZeniAPIStatus;
     selectedPeriod: MonthYearPeriod;
-}, "expenseAutomationReconciliationView/uploadAccountStatementFailure">, updateStatementUploadChosen: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+}, "expenseAutomationReconciliationView/uploadAccountStatementFailure">, parseStatement: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+    statementUploadId: ID;
+}, "expenseAutomationReconciliationView/parseStatement">, parseStatementSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationReconciliationView/parseStatementSuccess">, parseStatementFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    error: ZeniAPIStatus;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationReconciliationView/parseStatementFailure">, reparseStatement: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+    statementUploadId: ID;
+}, "expenseAutomationReconciliationView/reparseStatement">, reparseStatementSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationReconciliationView/reparseStatementSuccess">, reparseStatementFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    error: ZeniAPIStatus;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationReconciliationView/reparseStatementFailure">, resetReparseStatementStatus: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationReconciliationView/resetReparseStatementStatus">, updateParsedStatementData: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    parsedStatementData: ParsedStatementData;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationReconciliationView/updateParsedStatementData">, updateStatementUpdateLocalData: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+    statementUpdateLocalData: StatementUpdateLocalData;
+}, "expenseAutomationReconciliationView/updateStatementUpdateLocalData">, submitStatementUpdate: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+    statementUploadId: ID;
+}, "expenseAutomationReconciliationView/submitStatementUpdate">, submitStatementUpdateSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationReconciliationView/submitStatementUpdateSuccess">, submitStatementUpdateFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    error: ZeniAPIStatus;
+    selectedPeriod: MonthYearPeriod;
+    dateConflict?: StatementDateConflict | null;
+}, "expenseAutomationReconciliationView/submitStatementUpdateFailure">, clearStatementDateConflict: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    accountId: ID;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationReconciliationView/clearStatementDateConflict">, updateStatementUploadChosen: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     statementUploadChosen: boolean;
 }, "expenseAutomationReconciliationView/updateStatementUploadChosen">, updateNodeCollapseState: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     collapsed: boolean;