Merge pull request #97671 from truph01/feat/95355

[Download receipts] Add "Download receipts" to the Expenses and Reports search pages

Author: mollfpr

src/CONST/index.ts

@@ -6862,6 +6862,7 @@ const CONST = {
             EDIT: 'edit',
             EXPORT: 'export',
             DOWNLOAD_PDF: 'downloadPDF',
+            DOWNLOAD_RECEIPTS: 'downloadReceipts',
             DOWNLOAD_STATEMENT_PDF: 'downloadStatementPDF',
             APPROVE: 'approve',
             CHANGE_APPROVER: 'changeApprover',

src/hooks/useExportActions.ts

@@ -291,7 +291,7 @@ function useExportActions({reportID, policy, onPDFModalOpen}: UseExportActionsPa
                 if (!moneyRequestReport?.reportID) {
                     return;
                 }
-                const exportID = exportReceiptsToZip([moneyRequestReport.reportID]);
+                const exportID = exportReceiptsToZip({reportIDs: [moneyRequestReport.reportID]});
                 trackExport(exportID);
             },
         },

src/hooks/useSearchBulkActions.ts

@@ -8,7 +8,7 @@ import {useSearchQueryContext, useSearchResultsContext, useSearchSelectionAction
 import type {BulkPaySelectionData, PaymentData, SearchColumnType, SearchFilterKey, SearchQueryJSON, SelectedReports, SelectedTransactions} from '@components/Search/types';
 
 import {getExpensifyCardStatementPDF} from '@libs/actions/CompanyCards';
-import {exportReportsToPDF} from '@libs/actions/Export';
+import {exportReceiptsToZip, exportReportsToPDF} from '@libs/actions/Export';
 import {unholdRequest} from '@libs/actions/IOU/Hold';
 import {payInvoice, payMoneyRequest} from '@libs/actions/IOU/PayMoneyRequest';
 import {approveMoneyRequest} from '@libs/actions/IOU/ReportWorkflow';
@@ -2249,6 +2249,45 @@ function useSearchBulkActions({queryJSON}: UseSearchBulkActionsParams) {
             });
         }
 
+        const hasSelectedReportsWithExpenses = selectedReports.some((report) => (currentSearchResults?.data?.[`${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`]?.transactionCount ?? 0) > 0);
+        if (isExpenseReportSearch && selectedReportIDs.length > 0 && hasSelectedReportsWithExpenses) {
+            options.push({
+                icon: expensifyIcons.Download,
+                text: translate('common.downloadReceipts'),
+                value: CONST.SEARCH.BULK_ACTION_TYPES.DOWNLOAD_RECEIPTS,
+                shouldCloseModalOnSelect: true,
+                onSelected: () => {
+                    if (isOffline) {
+                        setIsOfflineModalVisible(true);
+                        return;
+                    }
+                    const exportID = exportReceiptsToZip({reportIDs: selectedReportIDs});
+                    trackExport(exportID);
+                },
+            });
+        }
+
+        const isExpenseSearch = queryJSON?.type === CONST.SEARCH.DATA_TYPES.EXPENSE || searchResults?.search.type === CONST.SEARCH.DATA_TYPES.EXPENSE;
+        // A group selected before its children load is stored under a group_ key, which is not a real
+        // transaction ID. Drop those keys so ExportReceiptsToZip only receives valid transaction IDs.
+        const transactionIDs = selectedTransactionsKeys.filter((key) => !key.startsWith(CONST.SEARCH.GROUP_PREFIX));
+        if (isExpenseSearch && selectedTransactionsKeys.length > 0 && transactionIDs.length > 0) {
+            options.push({
+                icon: expensifyIcons.Download,
+                text: translate('common.downloadReceipts'),
+                value: CONST.SEARCH.BULK_ACTION_TYPES.DOWNLOAD_RECEIPTS,
+                shouldCloseModalOnSelect: true,
+                onSelected: () => {
+                    if (isOffline) {
+                        setIsOfflineModalVisible(true);
+                        return;
+                    }
+                    const exportID = exportReceiptsToZip({transactionIDs});
+                    trackExport(exportID);
+                },
+            });
+        }
+
         // A standalone bulk action (not nested under Export). "Select all matching" only loads the visible
         // rows, so we would export an incomplete set of settlements while the UI claims everything is selected;
         // the statement has no whole-query export path (unlike CSV/templates), so require an explicit selection.

src/libs/API/parameters/ExportReceiptsToZipParams.ts

@@ -1,5 +1,6 @@
 type ExportReceiptsToZipParams = {
-    reportIDs: string;
+    transactionIDs?: string;
+    reportIDs?: string;
     exportID: string;
 };
 

src/libs/actions/Export.ts

@@ -102,7 +102,7 @@ function exportReportsToPDF(reportIDs: string[]): string {
     return exportID;
 }
 
-function exportReceiptsToZip(reportIDs: string[]): string {
+function exportReceiptsToZip({reportIDs, transactionIDs}: {reportIDs?: string[]; transactionIDs?: string[]}): string {
     const exportID = rand64();
     const onyxKey = `${ONYXKEYS.COLLECTION.EXPORT_DOWNLOAD}${exportID}` as const;
 
@@ -122,7 +122,15 @@ function exportReceiptsToZip(reportIDs: string[]): string {
         },
     ];
 
-    write(WRITE_COMMANDS.EXPORT_RECEIPTS_TO_ZIP, {reportIDs: JSON.stringify(reportIDs), exportID}, {optimisticData, failureData});
+    write(
+        WRITE_COMMANDS.EXPORT_RECEIPTS_TO_ZIP,
+        {
+            exportID,
+            reportIDs: reportIDs ? JSON.stringify(reportIDs) : undefined,
+            transactionIDs: transactionIDs ? JSON.stringify(transactionIDs) : undefined,
+        },
+        {optimisticData, failureData},
+    );
 
     return exportID;
 }

src/types/onyx/ExportDownload.ts

@@ -13,7 +13,7 @@ type ExportDownload = {
     /** Current state of the export download */
     state: ExportDownloadState;
 
-    /** Type of export (csv or pdf), used to show the correct failure message */
+    /** Type of export (csv, pdf or receipts), used to show the correct failure message */
     exportType?: ExportDownloadType;
 
     /** URL to download the exported file when state is ready */