@zeniai/client-epic-state 4.19.94 → 4.19.95

package/lib/esm/view/expenseAutomationView/epics/missingReceipts/fetchMultipleBatchDetailsEpic.js

@@ -0,0 +1,56 @@
+import { EMPTY, concat, from, of } from 'rxjs';
+import { catchError, filter, mergeMap } from 'rxjs/operators';
+import { updateTransactions } from '../../../../entity/transaction/transactionReducer';
+import { createZeniAPIStatus, isSuccessResponse, } from '../../../../responsePayload';
+import { extractTransactionPayloadsFromBatchFiles, filterBatchListItemsForBatchDetailsFetch, isBatchDetailsApiStatusCompleted, shouldFetchBatchDetailsForBatchId, toBatchDetails, } from '../../payload/missingReceiptsPayload';
+import { batchDetailFetchFailed, fetchBulkUploadBatchDetails, fetchBulkUploadBatchesSuccess, fetchMoreBatchDetailsComplete, setInitialBatchDetailsLoading, storeBatchDetails, } from '../../reducers/missingReceiptsViewReducer';
+const INITIAL_BATCH_PAGE_SIZE = 5;
+export function fetchBatchDetailsByIds(batchIds, zeniAPI) {
+    if (batchIds.length === 0) {
+        return EMPTY;
+    }
+    return from(batchIds).pipe(mergeMap((batchId) => zeniAPI
+        .getJSON(`${zeniAPI.apiEndPoints.communicationAgentMicroServiceBaseUrl}/1.0/batches/${batchId}`)
+        .pipe(mergeMap((response) => {
+        if (!isSuccessResponse(response) ||
+            response.data == null ||
+            !isBatchDetailsApiStatusCompleted(response.data.status)) {
+            return EMPTY;
+        }
+        const actions = [];
+        const transactionPayloads = extractTransactionPayloadsFromBatchFiles(response.data.files);
+        if (transactionPayloads.length > 0) {
+            actions.push(updateTransactions(transactionPayloads, (value) => value.transaction_id));
+        }
+        actions.push(storeBatchDetails(toBatchDetails(response.data, zeniAPI.apiEndPoints.fileMicroServiceBaseUrl)));
+        return from(actions);
+    }), catchError((error) => {
+        console.error(`Failed to fetch batch details for ${batchId}:`, createZeniAPIStatus('Unexpected Error', 'Fetch batch details errored out: ' + JSON.stringify(error)));
+        return of(batchDetailFetchFailed({ batchId }));
+    })), 5));
+}
+export const fetchMultipleBatchDetailsEpic = (actions$, state$, zeniAPI) => actions$.pipe(filter(fetchBulkUploadBatchesSuccess.match), mergeMap((action) => {
+    const batchList = action.payload.batchList;
+    const { batchDetailsById } = state$.value.expenseAutomationMissingReceiptsViewState.bulkUpload;
+    /** Only completed list rows may trigger batch-details API; preserve platform order. */
+    const completedBatchesMissingDetails = filterBatchListItemsForBatchDetailsFetch(batchList).filter((batch) => batchDetailsById[batch.batchId] == null);
+    const completedBatchIds = completedBatchesMissingDetails.map((batch) => batch.batchId);
+    const batchIdsToFetch = completedBatchIds.slice(0, INITIAL_BATCH_PAGE_SIZE);
+    if (batchIdsToFetch.length === 0) {
+        /**
+         * List refresh can complete while no row is `completed` yet (multi-fetch skips), or
+         * `currentBatchId` may not appear in the filtered list but still needs `GET /batches/:id`.
+         * Fall back to the single-batch-details epic so `phase` and details can resolve.
+         */
+        const bulkUpload = state$.value.expenseAutomationMissingReceiptsViewState.bulkUpload;
+        const currentId = bulkUpload.currentBatchId;
+        if (currentId != null &&
+            bulkUpload.phase === 'matching' &&
+            bulkUpload.batchDetailsById[currentId] == null &&
+            shouldFetchBatchDetailsForBatchId(bulkUpload.batchStatusById, bulkUpload.batchListByPeriod, currentId)) {
+            return of(fetchBulkUploadBatchDetails());
+        }
+        return EMPTY;
+    }
+    return concat(of(setInitialBatchDetailsLoading()), fetchBatchDetailsByIds(batchIdsToFetch, zeniAPI), of(fetchMoreBatchDetailsComplete()));
+}));

package/lib/esm/view/expenseAutomationView/epics/missingReceipts/searchTransactionsForManualMatchEpic.js

@@ -0,0 +1,77 @@
+import { EMPTY, from, merge, of } from 'rxjs';
+import { catchError, debounceTime, filter, mergeMap, switchMap, } from 'rxjs/operators';
+import { convertToPeriod } from '../../../../commonStateTypes/timePeriod';
+import { getCurrentTenant } from '../../../../entity/tenant/tenantSelector';
+import { updateTransactions } from '../../../../entity/transaction/transactionReducer';
+import { createZeniAPIStatus, isSuccessResponse, } from '../../../../responsePayload';
+import { supportedTransactionPayloadToManualSearchResult } from '../../payload/missingReceiptsPayload';
+import { searchTransactionsForManualMatch, searchTransactionsForManualMatchFailure, searchTransactionsForManualMatchSuccess, } from '../../reducers/missingReceiptsViewReducer';
+import { toTransactionsSortKey } from '../../types/transactionsViewState';
+/**
+ * `auto_categorized` for manual transaction search (Unmatched).
+ * Backend contract TBD — align with `fetchTransactionCategorizationEpic` (`selectedTab === 'autoCategorized'`)
+ * when the expense-automation API documents the intended filter for this flow.
+ */
+export const MANUAL_TRANSACTION_SEARCH_AUTO_CATEGORIZED = false;
+export const searchTransactionsForManualMatchEpic = (actions$, state$, zeniAPI) => {
+    const searchActions$ = actions$.pipe(filter(searchTransactionsForManualMatch.match));
+    const pagination$ = searchActions$.pipe(filter((action) => action.payload.pageToken != null));
+    /**
+     * No API for empty or 1-char queries; immediate merge so switchMap cancels any in-flight HTTP.
+     */
+    const newSearchTooShortOrClear$ = searchActions$.pipe(filter((action) => action.payload.pageToken == null &&
+        action.payload.query.trim().length < 2));
+    const newSearchDebounced$ = searchActions$.pipe(filter((action) => action.payload.pageToken == null &&
+        action.payload.query.trim().length >= 2), debounceTime(300));
+    return merge(pagination$, newSearchTooShortOrClear$, newSearchDebounced$).pipe(switchMap((action) => {
+        const { query, pageToken } = action.payload;
+        if (pageToken == null && query.trim().length < 2) {
+            return EMPTY;
+        }
+        const state = state$.value;
+        const { expenseAutomationViewState: { selectedPeriodByTenantId }, expenseAutomationMissingReceiptsViewState: { bulkUpload: { manualSearch, sortKey, sortOrder }, }, } = state;
+        const currentTenant = getCurrentTenant(state);
+        const selectedPeriod = selectedPeriodByTenantId[currentTenant.tenantId];
+        if (selectedPeriod == null) {
+            return of(searchTransactionsForManualMatchFailure({
+                error: createZeniAPIStatus('Unexpected Error', 'Manual search requires a selected accounting period.'),
+            }));
+        }
+        const period = convertToPeriod(selectedPeriod);
+        const queryParam = {
+            start_date: period.start,
+            end_date: period.end,
+            auto_categorized: MANUAL_TRANSACTION_SEARCH_AUTO_CATEGORIZED,
+            sort_by: toTransactionsSortKey(sortKey),
+            sort_order: sortOrder === 'ascending' ? 'asc' : 'desc',
+            page_token: pageToken ?? null,
+            page_size: manualSearch.pageSize,
+            search_text: query,
+        };
+        return zeniAPI
+            .getJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/expense-automation/transactions?query=${encodeURIComponent(JSON.stringify(queryParam))}`)
+            .pipe(mergeMap((response) => {
+            if (isSuccessResponse(response) && response.data != null) {
+                const { transactions, next_page_token, total_count } = response.data;
+                const append = pageToken != null;
+                const results = transactions.map(supportedTransactionPayloadToManualSearchResult);
+                const actionsOut = [
+                    updateTransactions(transactions, (value) => value.transaction_id, 'merge'),
+                    searchTransactionsForManualMatchSuccess({
+                        append,
+                        nextPageToken: next_page_token ?? null,
+                        results,
+                        totalCount: total_count,
+                    }),
+                ];
+                return from(actionsOut);
+            }
+            return of(searchTransactionsForManualMatchFailure({
+                error: response.status,
+            }));
+        }), catchError((error) => of(searchTransactionsForManualMatchFailure({
+            error: createZeniAPIStatus('Unexpected Error', 'Search transactions for manual match errored: ' +
+                JSON.stringify(error)),
+        }))));
+    }));
+};

package/lib/esm/view/expenseAutomationView/epics/missingReceipts/uploadMissingReceiptSuccessEpic.js

@@ -12,11 +12,13 @@ export const uploadMissingReceiptSuccessEpic = (actions$, state$) => actions$.pi
     updateActions.push(updateTransaction(transactionPayload.transaction_id, transactionPayload, updateType));
     if (currentTenant != null) {
         const monthEndChecksPeriod = selectedPeriodByTenantId[currentTenant.tenantId];
-        updateActions.push(fetchMonthEndCloseChecks({
-            tenantId: currentTenant.tenantId,
-            period: monthEndChecksPeriod,
-            refreshViewInBackground: true,
-        }));
+        if (monthEndChecksPeriod != null) {
+            updateActions.push(fetchMonthEndCloseChecks({
+                tenantId: currentTenant.tenantId,
+                period: monthEndChecksPeriod,
+                refreshViewInBackground: true,
+            }));
+        }
     }
     return from(updateActions);
 }));

package/lib/esm/view/expenseAutomationView/epics/missingReceipts/watchBulkUploadBatchStatusEpic.js

@@ -0,0 +1,79 @@
+import { EMPTY, from, merge, of, timer } from 'rxjs';
+import { catchError, debounceTime, filter, mergeMap, switchMap, takeUntil, } from 'rxjs/operators';
+import { openSnackbar } from '../../../../entity/snackbar/snackbarReducer';
+import { updateTransactions } from '../../../../entity/transaction/transactionReducer';
+import { isSuccessResponse } from '../../../../responsePayload';
+import { BULK_UPLOAD_AUTOMATCHING_TIMEOUT_MS } from '../../bulkUploadTiming';
+import { extractTransactionPayloadsFromBatchFiles, isBatchDetailsApiStatusCompleted, toBatchDetails, } from '../../payload/missingReceiptsPayload';
+import { bulkUploadAutomatchingTimedOut, bulkUploadReceiptsSuccess, clearBulkUpload, fetchBulkUploadBatchDetailsSuccess, fetchBulkUploadBatches, pusherBatchStatusUpdate, requestMissingReceiptsTabNavigation, } from '../../reducers/missingReceiptsViewReducer';
+/** First poll after upload; then interval while batch not resolved via Pusher or API. */
+const FALLBACK_FIRST_DELAY_MS = 30000;
+const FALLBACK_POLL_INTERVAL_MS = 10000;
+/**
+ * On Pusher batch completion: refresh batch list (then fetchMultipleBatchDetailsEpic runs),
+ * and request switching to the Unmatched tab. Debounced to reduce duplicate refreshes.
+ */
+export const pusherBatchStatusCompletionEpic = (actions$) => actions$.pipe(filter(pusherBatchStatusUpdate.match), filter((action) => action.payload.status === 'completed'), debounceTime(300), mergeMap(() => from([
+    fetchBulkUploadBatches({
+        cacheOverride: true,
+        invalidateBatchDetailsCache: true,
+    }),
+    requestMissingReceiptsTabNavigation({ tab: 'unmatched' }),
+])));
+/**
+ * If Pusher and batch-details are delayed beyond {@link BULK_UPLOAD_AUTOMATCHING_TIMEOUT_MS},
+ * force `phase` to `completed` (dismiss automatching banner) and refresh the batch list.
+ * Cancels when the batch completes normally, bulk state is cleared, or another upload supersedes.
+ */
+export const bulkUploadAutomatchingTimeoutEpic = (actions$, state$) => actions$.pipe(filter(bulkUploadReceiptsSuccess.match), mergeMap((action) => {
+    const { batchId } = action.payload;
+    return timer(BULK_UPLOAD_AUTOMATCHING_TIMEOUT_MS).pipe(mergeMap(() => {
+        const bulk = state$.value.expenseAutomationMissingReceiptsViewState.bulkUpload;
+        if (bulk.phase !== 'matching' || bulk.currentBatchId !== batchId) {
+            return EMPTY;
+        }
+        return from([
+            bulkUploadAutomatchingTimedOut(batchId),
+            fetchBulkUploadBatches({ cacheOverride: true }),
+        ]);
+    }), takeUntil(merge(actions$.pipe(filter(clearBulkUpload.match)), actions$.pipe(filter(pusherBatchStatusUpdate.match), filter((a) => a.payload.batchId === batchId &&
+        a.payload.status === 'completed')), actions$.pipe(filter(fetchBulkUploadBatchDetailsSuccess.match), filter((a) => a.payload.batchId === batchId)))));
+}));
+/**
+ * Fallback polling when Pusher is slow or unavailable. Network errors on a poll tick show one
+ * error snackbar per upload session (first failure only) so the user is not spammed every
+ * interval; Pusher or a later successful poll still completes the flow.
+ */
+export const pollBulkUploadBatchStatusEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(bulkUploadReceiptsSuccess.match), mergeMap((action) => {
+    const { batchId } = action.payload;
+    let pollErrorNotified = false;
+    return timer(FALLBACK_FIRST_DELAY_MS, FALLBACK_POLL_INTERVAL_MS).pipe(takeUntil(merge(actions$.pipe(filter(clearBulkUpload.match)), actions$.pipe(filter(pusherBatchStatusUpdate.match), filter((action) => action.payload.batchId === batchId)), actions$.pipe(filter(fetchBulkUploadBatchDetailsSuccess.match), filter((action) => action.payload.batchId === batchId)), actions$.pipe(filter(bulkUploadAutomatchingTimedOut.match), filter((action) => action.payload.batchId === batchId)))), switchMap(() => zeniAPI
+        .getJSON(`${zeniAPI.apiEndPoints.communicationAgentMicroServiceBaseUrl}/1.0/batches/${batchId}`)
+        .pipe(mergeMap((response) => {
+        /** Same batch-details URL; polls until `status` is completed (Pusher may win first). */
+        if (isSuccessResponse(response) && response.data != null) {
+            if (isBatchDetailsApiStatusCompleted(response.data.status)) {
+                const actions = [];
+                const transactionPayloads = extractTransactionPayloadsFromBatchFiles(response.data.files);
+                if (transactionPayloads.length > 0) {
+                    actions.push(updateTransactions(transactionPayloads, (value) => value.transaction_id));
+                }
+                actions.push(fetchBulkUploadBatchDetailsSuccess(toBatchDetails(response.data, zeniAPI.apiEndPoints.fileMicroServiceBaseUrl)));
+                actions.push(fetchBulkUploadBatches({ cacheOverride: true }));
+                actions.push(requestMissingReceiptsTabNavigation({ tab: 'unmatched' }));
+                return from(actions);
+            }
+        }
+        return EMPTY;
+    }), catchError(() => {
+        if (!pollErrorNotified) {
+            pollErrorNotified = true;
+            return of(openSnackbar({
+                messageSection: 'receipts_upload',
+                messageText: 'failed',
+                type: 'error',
+            }));
+        }
+        return EMPTY;
+    }))));
+}));

package/lib/esm/view/expenseAutomationView/epics/transactionCategorization/uploadTransactionReceiptSuccessEpic.js

@@ -0,0 +1,24 @@
+import { from } from 'rxjs';
+import { filter, mergeMap } from 'rxjs/operators';
+import { getCurrentTenant } from '../../../../entity/tenant/tenantSelector';
+import { updateTransaction } from '../../../../entity/transaction/transactionReducer';
+import { fetchMonthEndCloseChecks } from '../../../monthEndCloseChecksView/monthEndCloseChecksViewReducer';
+import { uploadTransactionCategorizationReceiptSuccess } from '../../reducers/transactionsViewReducer';
+export const uploadTransactionReceiptSuccessEpic = (actions$, state$) => actions$.pipe(filter(uploadTransactionCategorizationReceiptSuccess.match), mergeMap((action) => {
+    const { transactionPayload, updateType } = action.payload;
+    const updateActions = [];
+    const currentTenant = getCurrentTenant(state$.value);
+    const selectedPeriodByTenantId = state$.value.expenseAutomationViewState.selectedPeriodByTenantId;
+    updateActions.push(updateTransaction(transactionPayload.transaction_id, transactionPayload, updateType));
+    if (currentTenant != null) {
+        const monthEndChecksPeriod = selectedPeriodByTenantId[currentTenant.tenantId];
+        if (monthEndChecksPeriod != null) {
+            updateActions.push(fetchMonthEndCloseChecks({
+                tenantId: currentTenant.tenantId,
+                period: monthEndChecksPeriod,
+                refreshViewInBackground: true,
+            }));
+        }
+    }
+    return from(updateActions);
+}));

package/lib/esm/view/expenseAutomationView/payload/missingReceiptsPayload.js

@@ -1 +1,189 @@
-export {};
+import { toURL } from '../../../commonPayloadTypes/urlPayload';
+import { toAmount } from '../../../commonStateTypes/amount';
+import { getTransactionPayloadAmount, } from '../../../entity/transaction/payloadTypes/transactionPayload';
+import { toBatchFileStatus, toBatchStatusValue, toMatchSource, } from '../types/missingReceiptsViewState';
+// -- Converter functions --
+/**
+ * Maps batch-details API `files[].status` strings to canonical {@link BatchFileStatus}.
+ * Legacy aliases are supported during rollout; unknown strings map to `failed` so Redux never
+ * holds untyped status values.
+ */
+export function parseBatchFileStatus(raw) {
+    const normalizedStatus = raw.trim().toLowerCase().replace(/-/g, '_');
+    switch (normalizedStatus) {
+        case 'exact_match':
+        case 'matched':
+            return 'exact_match';
+        case 'possible_matches':
+        case 'possible_match':
+        case 'possiblematch':
+        case 'un_matched':
+        case 'unmatched':
+            return 'possible_matches';
+        case 'no_match':
+        case 'nomatch':
+            return 'no_match';
+        case 'failed':
+            return 'failed';
+        default:
+            return 'failed';
+    }
+}
+export function toBatchFile(payload, filesEndPoint) {
+    return {
+        attachmentId: payload.attachment_id,
+        candidates: payload.candidates?.map((candidate) => ({
+            transactionId: candidate.transaction_id,
+            matchScore: candidate.match_score,
+        })),
+        fileDownloadUrl: payload.file_id != null && filesEndPoint != null
+            ? `${filesEndPoint}/1.0/files/${payload.file_id}?query=${encodeURIComponent(JSON.stringify({ download_file: true }))}`
+            : null,
+        fileId: payload.file_id,
+        filePreviewUrl: payload.file_preview_url,
+        filename: payload.filename,
+        matchSource: payload.match_source != null
+            ? toMatchSource(payload.match_source)
+            : undefined,
+        matchedTransactionId: payload.matched_transaction?.transaction_id,
+        status: toBatchFileStatus(payload.status),
+    };
+}
+export function extractTransactionPayloadsFromBatchFiles(files) {
+    const seen = new Set();
+    const payloads = [];
+    for (const file of files) {
+        if (file.matched_transaction != null) {
+            const id = file.matched_transaction.transaction_id;
+            if (!seen.has(id)) {
+                seen.add(id);
+                payloads.push(matchedTransactionPayloadToSupportedTransactionPayload(file.matched_transaction));
+            }
+        }
+        if (file.candidates != null) {
+            for (const candidate of file.candidates) {
+                const id = candidate.transaction_id;
+                if (!seen.has(id)) {
+                    seen.add(id);
+                    payloads.push(matchedTransactionPayloadToSupportedTransactionPayload(candidate));
+                }
+            }
+        }
+    }
+    return payloads;
+}
+function matchedTransactionPayloadToSupportedTransactionPayload(payload) {
+    return {
+        transaction_id: payload.transaction_id,
+        transaction_type: payload.transaction_type ?? 'expense',
+        transaction_date: payload.transaction_date ?? '',
+        currency_code: payload.currency_code,
+        total_amount: payload.amount,
+        vendor_name: payload.vendor_name,
+        logo: payload.vendor_logo == null ? undefined : toURL(payload.vendor_logo),
+    };
+}
+export function toBatchSummary(payload) {
+    return {
+        failed: payload.failed,
+        matched: payload.matched,
+        noMatch: payload.no_match,
+        possibleMatches: payload.possible_matches,
+        total: payload.total,
+    };
+}
+export function toBatchDetails(payload, filesEndPoint) {
+    return {
+        batchId: payload.batch_id,
+        createdAt: payload.created_at,
+        files: payload.files.map((file) => toBatchFile(file, filesEndPoint)),
+        status: toBatchStatusValue(payload.status),
+        summary: toBatchSummary(payload.summary),
+    };
+}
+/** Batch list `status` is a string from the API — compare case-insensitively. */
+export function isBatchListStatusCompleted(status) {
+    return status.toLowerCase() === 'completed';
+}
+/**
+ * Subset of the get-all-batches (`/batches?query=...`) list that is eligible for
+ * `GET /batches/:batchId` details fetches. The stored list may include pending, failed, or other
+ * statuses for UI; only `completed` rows should trigger batch-details requests.
+ */
+export function filterBatchListItemsForBatchDetailsFetch(batches) {
+    return batches.filter((batch) => isBatchListStatusCompleted(batch.status));
+}
+/**
+ * Batch details API response `status` field — only completed payloads should be stored from
+ * multi-batch fetch paths (list can be briefly stale vs. live processing state).
+ */
+export function isBatchDetailsApiStatusCompleted(status) {
+    return status.toLowerCase() === 'completed';
+}
+export function findBatchListItemForBatchId(batchListByPeriod, batchId) {
+    for (const list of Object.values(batchListByPeriod)) {
+        const found = list.find((batch) => batch.batchId === batchId);
+        if (found != null) {
+            return found;
+        }
+    }
+    return undefined;
+}
+/**
+ * Whether it is appropriate to call `GET .../batches/:id` for details.
+ * Skips when live batch status or batch list row indicates the batch is not completed yet.
+ * When status is unknown in both sources, allows the request (e.g. dispatch before list refresh).
+ */
+export function shouldFetchBatchDetailsForBatchId(batchStatusById, batchListByPeriod, batchId) {
+    const live = batchStatusById[batchId]?.status;
+    if (live === 'completed') {
+        return true;
+    }
+    if (live === 'pending' || live === 'processing') {
+        return false;
+    }
+    const listItem = findBatchListItemForBatchId(batchListByPeriod, batchId);
+    if (listItem != null && !isBatchListStatusCompleted(listItem.status)) {
+        return false;
+    }
+    return true;
+}
+export function toBatchListItem(payload) {
+    return {
+        batchId: payload.batch_id,
+        createdAt: payload.created_at,
+        failedCount: payload.failed_count,
+        matchedCount: payload.matched_count,
+        noMatchCount: payload.no_match_count,
+        possibleMatchesCount: payload.possible_matches_count,
+        status: payload.status,
+        totalFiles: payload.total_files,
+    };
+}
+/**
+ * Amount shown in the Unmatched tab manual-search list: **first line only** when `lines` exist.
+ * Falls back to transaction-level totals via {@link getTransactionPayloadAmount} when there is
+ * no line or no line amount (same currency fields as the rest of the transaction payload).
+ */
+function getManualSearchListAmountFromPayload(payload) {
+    const lineAmount = payload.lines?.[0]?.amount;
+    if (lineAmount != null) {
+        return toAmount(lineAmount, payload.currency_code, payload.currency_symbol);
+    }
+    return getTransactionPayloadAmount(payload);
+}
+/** Maps expense-automation transaction rows to manual-search list rows (Unmatched tab). */
+export function supportedTransactionPayloadToManualSearchResult(payload) {
+    const amountPayload = getManualSearchListAmountFromPayload(payload);
+    return {
+        amount: amountPayload.amount,
+        currencyCode: amountPayload.currencyCode,
+        entityId: payload.vendor_id ?? payload.customer_id ?? '',
+        memo: payload.transaction_memo ?? '',
+        transactionDate: payload.transaction_date,
+        transactionId: payload.transaction_id,
+        transactionType: payload.transaction_type,
+        vendorName: payload.vendor_name ?? '',
+        vendorLogo: toURL(payload.logo)?.href,
+    };
+}