@zeniai/client-epic-state 4.20.6 → 4.20.8

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

@@ -1,2 +1,213 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseBatchFileStatus = parseBatchFileStatus;
+exports.toBatchFile = toBatchFile;
+exports.extractTransactionPayloadsFromBatchFiles = extractTransactionPayloadsFromBatchFiles;
+exports.toBatchSummary = toBatchSummary;
+exports.toBatchDetails = toBatchDetails;
+exports.isBatchDetailsStatusPendingOrProcessing = isBatchDetailsStatusPendingOrProcessing;
+exports.isBatchListStatusCompleted = isBatchListStatusCompleted;
+exports.filterBatchListItemsForBatchDetailsFetch = filterBatchListItemsForBatchDetailsFetch;
+exports.isBatchDetailsApiStatusCompleted = isBatchDetailsApiStatusCompleted;
+exports.findBatchListItemForBatchId = findBatchListItemForBatchId;
+exports.shouldFetchBatchDetailsForBatchId = shouldFetchBatchDetailsForBatchId;
+exports.toBatchListItem = toBatchListItem;
+exports.supportedTransactionPayloadToManualSearchResult = supportedTransactionPayloadToManualSearchResult;
+const urlPayload_1 = require("../../../commonPayloadTypes/urlPayload");
+const amount_1 = require("../../../commonStateTypes/amount");
+const transactionPayload_1 = require("../../../entity/transaction/payloadTypes/transactionPayload");
+const missingReceiptsViewState_1 = require("../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.
+ */
+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';
+    }
+}
+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
+            ? (0, missingReceiptsViewState_1.toMatchSource)(payload.match_source)
+            : undefined,
+        matchedTransactionId: payload.matched_transaction?.transaction_id,
+        status: (0, missingReceiptsViewState_1.toBatchFileStatus)(payload.status),
+    };
+}
+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 : (0, urlPayload_1.toURL)(payload.vendor_logo),
+    };
+}
+function toBatchSummary(payload) {
+    return {
+        failed: payload.failed,
+        matched: payload.matched,
+        noMatch: payload.no_match,
+        possibleMatches: payload.possible_matches,
+        total: payload.total,
+    };
+}
+function toBatchDetails(payload, filesEndPoint) {
+    return {
+        batchId: payload.batch_id,
+        createdAt: payload.created_at,
+        files: payload.files.map((file) => toBatchFile(file, filesEndPoint)),
+        status: (0, missingReceiptsViewState_1.toBatchStatusValue)(payload.status),
+        summary: toBatchSummary(payload.summary),
+        ...(payload.user_id != null && payload.user_id !== ''
+            ? { userId: payload.user_id }
+            : {}),
+    };
+}
+/** Batch is still in-flight for automatching (GET /batches/:id while not completed). */
+function isBatchDetailsStatusPendingOrProcessing(status) {
+    const s = status.toLowerCase();
+    return s === 'processing' || s === 'pending';
+}
+/** Batch list `status` is a string from the API — compare case-insensitively. */
+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.
+ */
+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).
+ */
+function isBatchDetailsApiStatusCompleted(status) {
+    return status.toLowerCase() === 'completed';
+}
+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).
+ */
+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;
+}
+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,
+        userId: payload.user_id,
+    };
+}
+/**
+ * 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 (0, amount_1.toAmount)(lineAmount, payload.currency_code, payload.currency_symbol);
+    }
+    return (0, transactionPayload_1.getTransactionPayloadAmount)(payload);
+}
+/** Maps expense-automation transaction rows to manual-search list rows (Unmatched tab). */
+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: (0, urlPayload_1.toURL)(payload.logo)?.href,
+    };
+}

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

@@ -1,11 +1,23 @@
 import { Amount } from '../../../commonStateTypes/amount';
-import { FetchStateAndError, UpdateType } from '../../../commonStateTypes/common';
+import { FetchStateAndError, ID, UpdateType } from '../../../commonStateTypes/common';
+import { SortOrder } from '../../../commonStateTypes/selectorTypes/sortOrderTypes';
 import { MonthYearPeriod, TimePeriod } from '../../../commonStateTypes/timePeriod';
+import type { MonthYearPeriodId } from '../../../commonStateTypes/timePeriod';
 import { TransactionPayload } from '../../../entity/transaction/payloadTypes/transactionPayload';
 import { SupportedTransactionPayload } from '../../../entity/transaction/transactionState';
 import { ZeniAPIStatus } from '../../../responsePayload';
-import { MissingReceiptsViewState, MissingReceiptsViewUIState } from '../types/missingReceiptsViewState';
+import { type BatchDetails, type BatchListItem, type BatchStatus, type BulkUploadResultsTab, type BulkUploadSortKey, type BulkUploadState, type CompletedSubTab, type ManualSearchResult, type MissingReceiptsViewState, type MissingReceiptsViewUIState } from '../types/missingReceiptsViewState';
+export declare const getCompletedTransactionsCacheKey: (periodId: MonthYearPeriodId, sortKey: BulkUploadSortKey, sortOrder: SortOrder, subTab: CompletedSubTab) => string;
+export declare const initialBulkUploadState: BulkUploadState;
 export declare const initialState: MissingReceiptsViewState;
+/** Epic trigger only; batch-details fetch is handled in epics. */
+export declare const fetchBulkUploadBatchDetails: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/fetchBulkUploadBatchDetails">;
+/**
+ * Epic trigger only. Dispatched from the screen on missing-receipts entry / period switch so the
+ * automatching banner is restored for the logged-in user even when they sit on the Missing tab
+ * after a hard refresh. The epic owns the list + details API calls end-to-end.
+ */
+export declare const restoreBulkUploadAutomatchingOnMount: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/restoreBulkUploadAutomatchingOnMount">;
 export declare const fetchMissingReceipts: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[period: TimePeriod, minimumTransactionAmount: Amount, cacheOverride?: any, refreshViewInBackground?: any], {
     period: TimePeriod;
     minimumTransactionAmount: Amount;
@@ -26,6 +38,77 @@ export declare const fetchMissingReceipts: import("@reduxjs/toolkit").ActionCrea
 }, "expenseAutomationMissingReceiptsView/updateMissingReceiptUploadState", never, never>, updateMissingReceiptsUIState: import("@reduxjs/toolkit").ActionCreatorWithPayload<Partial<MissingReceiptsViewUIState>, "expenseAutomationMissingReceiptsView/updateMissingReceiptsUIState">, markMissingReceiptAsDone: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionPayload: SupportedTransactionPayload, selectedPeriod: MonthYearPeriod], {
     transactionPayload: SupportedTransactionPayload;
     selectedPeriod: MonthYearPeriod;
-}, "expenseAutomationMissingReceiptsView/markMissingReceiptAsDone", never, never>, clearExpenseAutomationMissingReceiptsView: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/clearExpenseAutomationMissingReceiptsView">;
+}, "expenseAutomationMissingReceiptsView/markMissingReceiptAsDone", never, never>, clearExpenseAutomationMissingReceiptsView: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/clearExpenseAutomationMissingReceiptsView">, bulkUploadReceipts: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[files: File[]], {
+    files: File[];
+    fileCount: number;
+}, "expenseAutomationMissingReceiptsView/bulkUploadReceipts", never, never>, updateBulkUploadProgress: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "expenseAutomationMissingReceiptsView/updateBulkUploadProgress">, setBulkUploadUploadedFileCount: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "expenseAutomationMissingReceiptsView/setBulkUploadUploadedFileCount">, bulkUploadReceiptsSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    batchId: ID;
+}, "expenseAutomationMissingReceiptsView/bulkUploadReceiptsSuccess">, bulkUploadReceiptsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+}, "expenseAutomationMissingReceiptsView/bulkUploadReceiptsFailure">, restoreBulkUploadMatchingState: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    batchId: ID;
+    totalFiles: number;
+}, "expenseAutomationMissingReceiptsView/restoreBulkUploadMatchingState">, bulkUploadAutomatchingTimedOut: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[batchId: string], {
+    batchId: string;
+}, "expenseAutomationMissingReceiptsView/bulkUploadAutomatchingTimedOut", never, never>, pusherBatchStatusUpdate: import("@reduxjs/toolkit").ActionCreatorWithPayload<BatchStatus, "expenseAutomationMissingReceiptsView/pusherBatchStatusUpdate">, requestMissingReceiptsTabNavigation: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    tab: BulkUploadResultsTab;
+}, "expenseAutomationMissingReceiptsView/requestMissingReceiptsTabNavigation">, clearMissingReceiptsTabNavigation: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/clearMissingReceiptsTabNavigation">, fetchBulkUploadBatchDetailsSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<BatchDetails, "expenseAutomationMissingReceiptsView/fetchBulkUploadBatchDetailsSuccess">, fetchBulkUploadBatchDetailsFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    error: ZeniAPIStatus;
+}], {
+    error: ZeniAPIStatus;
+}, "expenseAutomationMissingReceiptsView/fetchBulkUploadBatchDetailsFailure", never, never>, storeBatchDetails: import("@reduxjs/toolkit").ActionCreatorWithPayload<BatchDetails, "expenseAutomationMissingReceiptsView/storeBatchDetails">, batchDetailFetchFailed: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    batchId: ID;
+}, "expenseAutomationMissingReceiptsView/batchDetailFetchFailed">, setInitialBatchDetailsLoading: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/setInitialBatchDetailsLoading">, fetchMoreBatchDetails: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/fetchMoreBatchDetails">, fetchMoreBatchDetailsComplete: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/fetchMoreBatchDetailsComplete">, fetchMoreBatchDetailsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+}, "expenseAutomationMissingReceiptsView/fetchMoreBatchDetailsFailure">, fetchBulkUploadBatches: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[input?: {
+    cacheOverride?: boolean;
+    invalidateBatchDetailsCache?: boolean;
+} | undefined], {
+    cacheOverride: boolean;
+    invalidateBatchDetailsCache: boolean;
+}, "expenseAutomationMissingReceiptsView/fetchBulkUploadBatches", never, never>, fetchBulkUploadBatchesSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    batchList: BatchListItem[];
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationMissingReceiptsView/fetchBulkUploadBatchesSuccess">, fetchBulkUploadBatchesFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationMissingReceiptsView/fetchBulkUploadBatchesFailure">, confirmBulkUploadMatch: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[batchId: string, attachmentId: string, transactionId: string, transactionType: string, fileName: string], {
+    batchId: string;
+    attachmentId: string;
+    transactionId: string;
+    transactionType: string;
+    fileName: string;
+}, "expenseAutomationMissingReceiptsView/confirmBulkUploadMatch", never, never>, confirmBulkUploadMatchSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    attachmentId: ID;
+    batchId: ID;
+    transactionId: ID;
+}, "expenseAutomationMissingReceiptsView/confirmBulkUploadMatchSuccess">, confirmBulkUploadMatchFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+}, "expenseAutomationMissingReceiptsView/confirmBulkUploadMatchFailure">, setBulkUploadResultsTab: import("@reduxjs/toolkit").ActionCreatorWithPayload<"completed" | "unmatched", "expenseAutomationMissingReceiptsView/setBulkUploadResultsTab">, setBulkUploadCompletedSubTab: import("@reduxjs/toolkit").ActionCreatorWithPayload<"all" | "manual" | "ai_accountant", "expenseAutomationMissingReceiptsView/setBulkUploadCompletedSubTab">, setBulkUploadSortConfig: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    sortKey: BulkUploadSortKey;
+    sortOrder: SortOrder;
+}, "expenseAutomationMissingReceiptsView/setBulkUploadSortConfig">, clearBulkUpload: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/clearBulkUpload">, searchTransactionsForManualMatch: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[query: string, pageToken?: string | null | undefined], {
+    query: string;
+    pageToken: string | undefined;
+}, "expenseAutomationMissingReceiptsView/searchTransactionsForManualMatch", never, never>, searchTransactionsForManualMatchSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    append: boolean;
+    nextPageToken: string | null;
+    results: ManualSearchResult[];
+    totalCount: number;
+}, "expenseAutomationMissingReceiptsView/searchTransactionsForManualMatchSuccess">, searchTransactionsForManualMatchFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+}, "expenseAutomationMissingReceiptsView/searchTransactionsForManualMatchFailure">, clearManualSearchResults: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/clearManualSearchResults">, acknowledgeBulkUploadConfirmMatchComplete: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/acknowledgeBulkUploadConfirmMatchComplete">, fetchCompletedTransactions: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[pageToken?: string | undefined, cacheOverride?: boolean | undefined], {
+    pageToken: string | undefined;
+    cacheOverride: boolean | undefined;
+}, "expenseAutomationMissingReceiptsView/fetchCompletedTransactions", never, never>, fetchCompletedTransactionsSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    isInitialLoad: boolean;
+    nextPageToken: string | null;
+    selectedPeriod: MonthYearPeriod;
+    totalCount: number;
+    transactionIds: ID[];
+}, "expenseAutomationMissingReceiptsView/fetchCompletedTransactionsSuccess">, fetchCompletedTransactionsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+    selectedPeriod: MonthYearPeriod;
+}, "expenseAutomationMissingReceiptsView/fetchCompletedTransactionsFailure">;
 declare const _default: import("redux").Reducer<MissingReceiptsViewState>;
 export default _default;