@zeniai/client-epic-state 4.19.82 → 4.19.84-betaVR1

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

@@ -1,5 +1,9 @@
+import { URLPayload } from '../../../commonPayloadTypes/urlPayload';
 import { TransactionPayload } from '../../../entity/transaction/payloadTypes/transactionPayload';
+import { SupportedTransactionPayload } from '../../../entity/transaction/transactionState';
 import { ZeniAPIResponse } from '../../../responsePayload';
+import type { MonthYearPeriodId } from '../../../commonStateTypes/timePeriod';
+import type { BatchDetails, BatchFile, BatchListItem, BatchStatus, BatchSummary, ManualSearchResult } from '../types/missingReceiptsViewState';
 export interface MissingReceiptsQueryPayload {
     end_date: string;
     is_attachment_missing_only: boolean;
@@ -13,4 +17,107 @@ interface MissingReceiptsPayload {
     transactions: TransactionPayload[];
 }
 export type MissingReceiptsResponse = ZeniAPIResponse<MissingReceiptsPayload>;
+export interface BatchListQueryPayload {
+    end_date: string;
+    sort_order: string;
+    start_date: string;
+}
+export interface BulkUploadResponsePayload {
+    batch_id: string;
+    status: string;
+    total_files: number;
+}
+export type BulkUploadResponse = ZeniAPIResponse<BulkUploadResponsePayload>;
+export interface BatchListResponsePayload {
+    batches: BatchListItemPayload[];
+}
+export interface BatchListItemPayload {
+    batch_id: string;
+    created_at: string;
+    failed_count: number;
+    matched_count: number;
+    no_match_count: number;
+    possible_matches_count: number;
+    status: string;
+    total_files: number;
+}
+export type BatchListResponse = ZeniAPIResponse<BatchListResponsePayload>;
+export interface MatchedTransactionPayload {
+    amount: number;
+    currency_code: string;
+    transaction_date: string | null;
+    transaction_id: string;
+    vendor_name: string;
+    transaction_type?: string;
+    vendor_logo?: URLPayload | null;
+}
+export interface MatchCandidatePayload extends MatchedTransactionPayload {
+    match_score: number;
+}
+export interface BatchFilePayload {
+    attachment_id: string;
+    file_id: string;
+    file_preview_url: string | null;
+    filename: string;
+    status: string;
+    candidates?: MatchCandidatePayload[];
+    match_source?: string;
+    matched_transaction?: MatchedTransactionPayload;
+}
+export interface BatchDetailsResponsePayload {
+    batch_id: string;
+    created_at: string;
+    files: BatchFilePayload[];
+    status: string;
+    summary: {
+        failed: number;
+        matched: number;
+        no_match: number;
+        possible_matches: number;
+        total: number;
+    };
+}
+export type BatchDetailsResponse = ZeniAPIResponse<BatchDetailsResponsePayload>;
+export declare function toBatchFile(payload: BatchFilePayload, filesEndPoint?: string): BatchFile;
+export declare function extractTransactionPayloadsFromBatchFiles(files: BatchFilePayload[]): SupportedTransactionPayload[];
+export declare function toBatchSummary(payload: BatchDetailsResponsePayload['summary']): BatchSummary;
+export declare function toBatchDetails(payload: BatchDetailsResponsePayload, filesEndPoint?: string): BatchDetails;
+/** Batch list `status` is a string from the API — compare case-insensitively. */
+export declare function isBatchListStatusCompleted(status: string): boolean;
+/**
+ * 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 declare function filterBatchListItemsForBatchDetailsFetch(batches: BatchListItem[]): BatchListItem[];
+/**
+ * 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 declare function isBatchDetailsApiStatusCompleted(status: string): boolean;
+export declare function findBatchListItemForBatchId(batchListByPeriod: Record<MonthYearPeriodId, BatchListItem[]>, batchId: string): BatchListItem | 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 declare function shouldFetchBatchDetailsForBatchId(batchStatusById: Record<string, BatchStatus>, batchListByPeriod: Record<MonthYearPeriodId, BatchListItem[]>, batchId: string): boolean;
+export declare function toBatchListItem(payload: BatchListItemPayload): BatchListItem;
+/** Maps expense-automation transaction rows to manual-search list rows (Unmatched tab). */
+export declare function supportedTransactionPayloadToManualSearchResult(payload: SupportedTransactionPayload): ManualSearchResult;
+export interface CompletedTransactionsQueryPayload {
+    end_date?: string;
+    match_type?: string;
+    page_size?: number;
+    page_token?: string | null;
+    sort_by?: string;
+    sort_order?: string;
+    start_date?: string;
+}
+export interface CompletedTransactionsResponsePayload {
+    next_page_token: string | null;
+    total_count: number;
+    transactions: SupportedTransactionPayload[];
+}
+export type CompletedTransactionsResponse = ZeniAPIResponse<CompletedTransactionsResponsePayload>;
 export {};

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

@@ -1,2 +1,160 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.toBatchFile = toBatchFile;
+exports.extractTransactionPayloadsFromBatchFiles = extractTransactionPayloadsFromBatchFiles;
+exports.toBatchSummary = toBatchSummary;
+exports.toBatchDetails = toBatchDetails;
+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 transactionPayload_1 = require("../../../entity/transaction/payloadTypes/transactionPayload");
+// -- Converter functions --
+function toBatchFile(payload, filesEndPoint) {
+    return {
+        attachmentId: payload.attachment_id,
+        candidates: payload.candidates?.map((c) => ({
+            transactionId: c.transaction_id,
+            matchScore: c.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,
+        matchedTransactionId: payload.matched_transaction?.transaction_id,
+        status: 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((f) => toBatchFile(f, filesEndPoint)),
+        status: payload.status,
+        summary: toBatchSummary(payload.summary),
+    };
+}
+/** 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((b) => isBatchListStatusCompleted(b.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((b) => b.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,
+    };
+}
+/** Maps expense-automation transaction rows to manual-search list rows (Unmatched tab). */
+function supportedTransactionPayloadToManualSearchResult(payload) {
+    const amountPayload = (0, transactionPayload_1.getTransactionPayloadAmount)(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,10 +1,14 @@
 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 { 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, BatchListItem, BatchStatus, BulkUploadResultsTab, BulkUploadSortKey, BulkUploadState, CompletedSubTab, ManualSearchResult, MissingReceiptsViewState, MissingReceiptsViewUIState } from '../types/missingReceiptsViewState';
+import type { MonthYearPeriodId } from '../../../commonStateTypes/timePeriod';
+export declare const getCompletedTransactionsCacheKey: (periodId: MonthYearPeriodId, sortKey: BulkUploadSortKey, sortOrder: SortOrder, subTab: CompletedSubTab) => string;
+export declare const initialBulkUploadState: BulkUploadState;
 export declare const initialState: MissingReceiptsViewState;
 export declare const fetchMissingReceipts: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[period: TimePeriod, minimumTransactionAmount: Amount, cacheOverride?: any, refreshViewInBackground?: any], {
     period: TimePeriod;
@@ -26,6 +30,69 @@ 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[];
+}, "expenseAutomationMissingReceiptsView/bulkUploadReceipts", never, never>, updateBulkUploadProgress: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "expenseAutomationMissingReceiptsView/updateBulkUploadProgress">, bulkUploadReceiptsSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    batchId: ID;
+}, "expenseAutomationMissingReceiptsView/bulkUploadReceiptsSuccess">, bulkUploadReceiptsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+}, "expenseAutomationMissingReceiptsView/bulkUploadReceiptsFailure">, pusherBatchStatusUpdate: import("@reduxjs/toolkit").ActionCreatorWithPayload<BatchStatus, "expenseAutomationMissingReceiptsView/pusherBatchStatusUpdate">, requestMissingReceiptsTabNavigation: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    tab: BulkUploadResultsTab;
+}, "expenseAutomationMissingReceiptsView/requestMissingReceiptsTabNavigation">, clearMissingReceiptsTabNavigation: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/clearMissingReceiptsTabNavigation">, fetchBulkUploadBatchDetails: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"expenseAutomationMissingReceiptsView/fetchBulkUploadBatchDetails">, fetchBulkUploadBatchDetailsSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<BatchDetails, "expenseAutomationMissingReceiptsView/fetchBulkUploadBatchDetailsSuccess">, fetchBulkUploadBatchDetailsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+}, "expenseAutomationMissingReceiptsView/fetchBulkUploadBatchDetailsFailure">, 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?: boolean | {
+    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<BulkUploadResultsTab, "expenseAutomationMissingReceiptsView/setBulkUploadResultsTab">, setBulkUploadCompletedSubTab: import("@reduxjs/toolkit").ActionCreatorWithPayload<CompletedSubTab, "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;