@zeniai/client-epic-state 5.0.74 → 5.0.75

package/lib/view/transactionDetail/transactionDetailReducer.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setIsVendorUpdateAllChecked = exports.updateVendorBulkRecommendationsFetchStatus = exports.updateLatestSelectedEntity = exports.resetAllLineItemsToVendor = exports.updateVendorToAllLineItems = exports.updateLocalDataWithTransactionsUpdateWithVendorCheckbox = exports.resetSelectedCustomer = exports.resetVendor = exports.updateSelectedCustomer = exports.updateSelectedVendor = exports.removeEntityRecommendationForLineIdForTransactionDetail = exports.setEntityRecommendationForLineIdsForTransactionDetail = exports.setAllLineItemsLocalDataIsUpdateAllChecked = exports.setAllLineItemsToCategoryClassInLocalData = exports.resetLineItemsCategoryClassInLocalData = exports.clearTransactionDetailLocalData = exports.saveTransactionDetailLocalData = exports.initializeTransactionDetailLocalData = exports.saveTransactionDetail = exports.updateTransactionStateIfUpdateActionNotAllowed = exports.updateStatusConsolidatedSaveTransactionDetail = exports.updateStatusForTransactionNotMiscategorizedUpdate = exports.deleteTransactionAttachmentSuccess = exports.deleteTransactionAttachmentFailure = exports.deleteTransactionAttachment = exports.markTransactionAsNotMiscategorized = exports.clearTransactionDetailSaveStatus = exports.updateTransactionDetailSaveStatus = exports.updateTransactionDetail = exports.uploadMissingAttachmentSuccess = exports.clearTransactionDetail = exports.removeTransactionDetail = exports.updateTransactionDetailFetchState = exports.fetchTransactionDetail = exports.downloadAccountingProviderAttachmentFailure = exports.downloadAccountingProviderAttachmentSuccess = exports.downloadAccountingProviderAttachment = exports.initialState = void 0;
+exports.setIsVendorUpdateAllChecked = exports.updateVendorBulkRecommendationsFetchStatus = exports.updateLatestSelectedEntity = exports.resetAllLineItemsToVendor = exports.updateVendorToAllLineItems = exports.updateLocalDataWithTransactionsUpdateWithVendorCheckbox = exports.resetSelectedCustomer = exports.resetVendor = exports.updateSelectedCustomer = exports.updateSelectedVendor = exports.removeEntityRecommendationForLineIdForTransactionDetail = exports.markCategoryClassRecommendationsFailureForTransactionDetail = exports.markCategoryClassRecommendationsCompletedForTransactionDetail = exports.markCategoryClassRecommendationsInProgressForTransactionDetail = exports.setEntityRecommendationForLineIdsForTransactionDetail = exports.setAllLineItemsLocalDataIsUpdateAllChecked = exports.setAllLineItemsToCategoryClassInLocalData = exports.resetLineItemsCategoryClassInLocalData = exports.clearTransactionDetailLocalData = exports.saveTransactionDetailLocalData = exports.initializeTransactionDetailLocalData = exports.saveTransactionDetail = exports.updateTransactionStateIfUpdateActionNotAllowed = exports.updateStatusConsolidatedSaveTransactionDetail = exports.updateStatusForTransactionNotMiscategorizedUpdate = exports.deleteTransactionAttachmentSuccess = exports.deleteTransactionAttachmentFailure = exports.deleteTransactionAttachment = exports.markTransactionAsNotMiscategorized = exports.clearTransactionDetailSaveStatus = exports.updateTransactionDetailSaveStatus = exports.updateTransactionDetail = exports.uploadMissingAttachmentSuccess = exports.clearTransactionDetail = exports.removeTransactionDetail = exports.updateTransactionDetailFetchState = exports.fetchTransactionDetail = exports.downloadAccountingProviderAttachmentFailure = exports.downloadAccountingProviderAttachmentSuccess = exports.downloadAccountingProviderAttachment = exports.initialState = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
 const get_1 = __importDefault(require("lodash/get"));
 const entity_1 = require("../../entity/genericEntity/entity");
@@ -245,12 +245,34 @@ const transactionDetail = (0, toolkit_1.createSlice)({
         saveTransactionDetailLocalData(draft, action) {
             const key = (0, transactionDetailState_1.getTransactionDetailKey)(action.payload.transactionId);
             const detail = (0, get_1.default)(draft.transactionDetailById, key, undefined);
-            if (detail != null) {
-                draft.transactionDetailById[key] = {
-                    ...detail,
-                    transactionDetailLocalData: action.payload.transactionLocalData,
-                };
+            if (detail == null) {
+                return;
             }
+            const incoming = action.payload.transactionLocalData;
+            const prevById = detail.transactionDetailLocalData.lineItemById;
+            // Per-line `categoryClassRecommendationsFetchState` is owned by the
+            // recommendation epic/reducers (markInProgress / markCompleted /
+            // markFailure / setEntityRecommendationForLineIdsForTransactionDetail).
+            // Callers that rebuild `transactionLocalData` from a UI snapshot will
+            // typically have an out-of-date copy of this field (e.g. payee-change
+            // captures the snapshot before the epic's start arm runs and would
+            // otherwise clobber In-Progress back to undefined). Treat the field as
+            // sticky: only let the caller override it when they explicitly set it.
+            const mergedLineItemById = {};
+            Object.entries(incoming.lineItemById ?? {}).forEach(([lineId, line]) => {
+                mergedLineItemById[lineId] = {
+                    ...line,
+                    categoryClassRecommendationsFetchState: line.categoryClassRecommendationsFetchState ??
+                        prevById?.[lineId]?.categoryClassRecommendationsFetchState,
+                };
+            });
+            draft.transactionDetailById[key] = {
+                ...detail,
+                transactionDetailLocalData: {
+                    ...incoming,
+                    lineItemById: mergedLineItemById,
+                },
+            };
         },
         saveTransactionDetail(draft, action) {
             const key = (0, transactionDetailState_1.getTransactionDetailKey)(action.payload.transactionId);
@@ -372,6 +394,21 @@ const transactionDetail = (0, toolkit_1.createSlice)({
                 const detail = (0, get_1.default)(draft.transactionDetailById, key, undefined);
                 if (detail != null) {
                     const newLocalData = (0, transactionDetailLocalDataHelper_1.setEntityRecommendationForLineIdInLocalData)(transaction, detail.transactionDetailLocalData, action.payload.entity, lineIds, uncategorizedIncomeExpense, recommendationWithCOTByLineId);
+                    // Release the per-line fetch flag for every line this fetch
+                    // covered so the inline skeleton resolves and the page-level
+                    // Save button can re-enable.
+                    lineIds.forEach((lineId) => {
+                        const lineItem = newLocalData.lineItemById[lineId];
+                        if (lineItem != null) {
+                            newLocalData.lineItemById[lineId] = {
+                                ...lineItem,
+                                categoryClassRecommendationsFetchState: {
+                                    fetchState: 'Completed',
+                                    error: undefined,
+                                },
+                            };
+                        }
+                    });
                     draft.transactionDetailById[key] = {
                         ...detail,
                         transactionDetailLocalData: newLocalData,
@@ -392,6 +429,84 @@ const transactionDetail = (0, toolkit_1.createSlice)({
                 };
             },
         },
+        // Start arm of the line-update recommendations fetch for the detail
+        // page. Flips covered lines to In-Progress; detail page has no
+        // checkbox, so no auto-uncheck side effect.
+        markCategoryClassRecommendationsInProgressForTransactionDetail: {
+            reducer(draft, action) {
+                const { transactionId, lineIds } = action.payload;
+                const key = (0, transactionDetailState_1.getTransactionDetailKey)(transactionId);
+                const detail = (0, get_1.default)(draft.transactionDetailById, key, undefined);
+                if (detail != null) {
+                    lineIds.forEach((lineId) => {
+                        const lineItem = detail.transactionDetailLocalData.lineItemById[lineId];
+                        if (lineItem != null) {
+                            detail.transactionDetailLocalData.lineItemById[lineId] = {
+                                ...lineItem,
+                                categoryClassRecommendationsFetchState: {
+                                    fetchState: 'In-Progress',
+                                    error: undefined,
+                                },
+                            };
+                        }
+                    });
+                }
+            },
+            prepare(transactionId, lineIds) {
+                return { payload: { transactionId, lineIds } };
+            },
+        },
+        // Completed arm. Used when the HTTP call succeeded but the server
+        // returned no per-line recommendations — still need to release the
+        // In-Progress flag.
+        markCategoryClassRecommendationsCompletedForTransactionDetail: {
+            reducer(draft, action) {
+                const { transactionId, lineIds } = action.payload;
+                const key = (0, transactionDetailState_1.getTransactionDetailKey)(transactionId);
+                const detail = (0, get_1.default)(draft.transactionDetailById, key, undefined);
+                if (detail != null) {
+                    lineIds.forEach((lineId) => {
+                        const lineItem = detail.transactionDetailLocalData.lineItemById[lineId];
+                        if (lineItem != null) {
+                            detail.transactionDetailLocalData.lineItemById[lineId] = {
+                                ...lineItem,
+                                categoryClassRecommendationsFetchState: {
+                                    fetchState: 'Completed',
+                                    error: undefined,
+                                },
+                            };
+                        }
+                    });
+                }
+            },
+            prepare(transactionId, lineIds) {
+                return { payload: { transactionId, lineIds } };
+            },
+        },
+        markCategoryClassRecommendationsFailureForTransactionDetail: {
+            reducer(draft, action) {
+                const { transactionId, lineIds, error } = action.payload;
+                const key = (0, transactionDetailState_1.getTransactionDetailKey)(transactionId);
+                const detail = (0, get_1.default)(draft.transactionDetailById, key, undefined);
+                if (detail != null) {
+                    lineIds.forEach((lineId) => {
+                        const lineItem = detail.transactionDetailLocalData.lineItemById[lineId];
+                        if (lineItem != null) {
+                            detail.transactionDetailLocalData.lineItemById[lineId] = {
+                                ...lineItem,
+                                categoryClassRecommendationsFetchState: {
+                                    fetchState: 'Error',
+                                    error,
+                                },
+                            };
+                        }
+                    });
+                }
+            },
+            prepare(transactionId, lineIds, error) {
+                return { payload: { transactionId, lineIds, error } };
+            },
+        },
         removeEntityRecommendationForLineIdForTransactionDetail: {
             reducer(draft, action) {
                 const { transaction, lineId } = action.payload;
@@ -663,7 +778,7 @@ const transactionDetail = (0, toolkit_1.createSlice)({
         },
     },
 });
-_a = transactionDetail.actions, exports.downloadAccountingProviderAttachment = _a.downloadAccountingProviderAttachment, exports.downloadAccountingProviderAttachmentSuccess = _a.downloadAccountingProviderAttachmentSuccess, exports.downloadAccountingProviderAttachmentFailure = _a.downloadAccountingProviderAttachmentFailure, exports.fetchTransactionDetail = _a.fetchTransactionDetail, exports.updateTransactionDetailFetchState = _a.updateTransactionDetailFetchState, exports.removeTransactionDetail = _a.removeTransactionDetail, exports.clearTransactionDetail = _a.clearTransactionDetail, exports.uploadMissingAttachmentSuccess = _a.uploadMissingAttachmentSuccess, exports.updateTransactionDetail = _a.updateTransactionDetail, exports.updateTransactionDetailSaveStatus = _a.updateTransactionDetailSaveStatus, exports.clearTransactionDetailSaveStatus = _a.clearTransactionDetailSaveStatus, exports.markTransactionAsNotMiscategorized = _a.markTransactionAsNotMiscategorized, exports.deleteTransactionAttachment = _a.deleteTransactionAttachment, exports.deleteTransactionAttachmentFailure = _a.deleteTransactionAttachmentFailure, exports.deleteTransactionAttachmentSuccess = _a.deleteTransactionAttachmentSuccess, exports.updateStatusForTransactionNotMiscategorizedUpdate = _a.updateStatusForTransactionNotMiscategorizedUpdate, exports.updateStatusConsolidatedSaveTransactionDetail = _a.updateStatusConsolidatedSaveTransactionDetail, exports.updateTransactionStateIfUpdateActionNotAllowed = _a.updateTransactionStateIfUpdateActionNotAllowed, exports.saveTransactionDetail = _a.saveTransactionDetail, exports.initializeTransactionDetailLocalData = _a.initializeTransactionDetailLocalData, exports.saveTransactionDetailLocalData = _a.saveTransactionDetailLocalData, exports.clearTransactionDetailLocalData = _a.clearTransactionDetailLocalData, exports.resetLineItemsCategoryClassInLocalData = _a.resetLineItemsCategoryClassInLocalData, exports.setAllLineItemsToCategoryClassInLocalData = _a.setAllLineItemsToCategoryClassInLocalData, exports.setAllLineItemsLocalDataIsUpdateAllChecked = _a.setAllLineItemsLocalDataIsUpdateAllChecked, exports.setEntityRecommendationForLineIdsForTransactionDetail = _a.setEntityRecommendationForLineIdsForTransactionDetail, exports.removeEntityRecommendationForLineIdForTransactionDetail = _a.removeEntityRecommendationForLineIdForTransactionDetail, exports.updateSelectedVendor = _a.updateSelectedVendor, exports.updateSelectedCustomer = _a.updateSelectedCustomer, exports.resetVendor = _a.resetVendor, exports.resetSelectedCustomer = _a.resetSelectedCustomer, exports.updateLocalDataWithTransactionsUpdateWithVendorCheckbox = _a.updateLocalDataWithTransactionsUpdateWithVendorCheckbox, exports.updateVendorToAllLineItems = _a.updateVendorToAllLineItems, exports.resetAllLineItemsToVendor = _a.resetAllLineItemsToVendor, exports.updateLatestSelectedEntity = _a.updateLatestSelectedEntity, exports.updateVendorBulkRecommendationsFetchStatus = _a.updateVendorBulkRecommendationsFetchStatus, exports.setIsVendorUpdateAllChecked = _a.setIsVendorUpdateAllChecked;
+_a = transactionDetail.actions, exports.downloadAccountingProviderAttachment = _a.downloadAccountingProviderAttachment, exports.downloadAccountingProviderAttachmentSuccess = _a.downloadAccountingProviderAttachmentSuccess, exports.downloadAccountingProviderAttachmentFailure = _a.downloadAccountingProviderAttachmentFailure, exports.fetchTransactionDetail = _a.fetchTransactionDetail, exports.updateTransactionDetailFetchState = _a.updateTransactionDetailFetchState, exports.removeTransactionDetail = _a.removeTransactionDetail, exports.clearTransactionDetail = _a.clearTransactionDetail, exports.uploadMissingAttachmentSuccess = _a.uploadMissingAttachmentSuccess, exports.updateTransactionDetail = _a.updateTransactionDetail, exports.updateTransactionDetailSaveStatus = _a.updateTransactionDetailSaveStatus, exports.clearTransactionDetailSaveStatus = _a.clearTransactionDetailSaveStatus, exports.markTransactionAsNotMiscategorized = _a.markTransactionAsNotMiscategorized, exports.deleteTransactionAttachment = _a.deleteTransactionAttachment, exports.deleteTransactionAttachmentFailure = _a.deleteTransactionAttachmentFailure, exports.deleteTransactionAttachmentSuccess = _a.deleteTransactionAttachmentSuccess, exports.updateStatusForTransactionNotMiscategorizedUpdate = _a.updateStatusForTransactionNotMiscategorizedUpdate, exports.updateStatusConsolidatedSaveTransactionDetail = _a.updateStatusConsolidatedSaveTransactionDetail, exports.updateTransactionStateIfUpdateActionNotAllowed = _a.updateTransactionStateIfUpdateActionNotAllowed, exports.saveTransactionDetail = _a.saveTransactionDetail, exports.initializeTransactionDetailLocalData = _a.initializeTransactionDetailLocalData, exports.saveTransactionDetailLocalData = _a.saveTransactionDetailLocalData, exports.clearTransactionDetailLocalData = _a.clearTransactionDetailLocalData, exports.resetLineItemsCategoryClassInLocalData = _a.resetLineItemsCategoryClassInLocalData, exports.setAllLineItemsToCategoryClassInLocalData = _a.setAllLineItemsToCategoryClassInLocalData, exports.setAllLineItemsLocalDataIsUpdateAllChecked = _a.setAllLineItemsLocalDataIsUpdateAllChecked, exports.setEntityRecommendationForLineIdsForTransactionDetail = _a.setEntityRecommendationForLineIdsForTransactionDetail, exports.markCategoryClassRecommendationsInProgressForTransactionDetail = _a.markCategoryClassRecommendationsInProgressForTransactionDetail, exports.markCategoryClassRecommendationsCompletedForTransactionDetail = _a.markCategoryClassRecommendationsCompletedForTransactionDetail, exports.markCategoryClassRecommendationsFailureForTransactionDetail = _a.markCategoryClassRecommendationsFailureForTransactionDetail, exports.removeEntityRecommendationForLineIdForTransactionDetail = _a.removeEntityRecommendationForLineIdForTransactionDetail, exports.updateSelectedVendor = _a.updateSelectedVendor, exports.updateSelectedCustomer = _a.updateSelectedCustomer, exports.resetVendor = _a.resetVendor, exports.resetSelectedCustomer = _a.resetSelectedCustomer, exports.updateLocalDataWithTransactionsUpdateWithVendorCheckbox = _a.updateLocalDataWithTransactionsUpdateWithVendorCheckbox, exports.updateVendorToAllLineItems = _a.updateVendorToAllLineItems, exports.resetAllLineItemsToVendor = _a.resetAllLineItemsToVendor, exports.updateLatestSelectedEntity = _a.updateLatestSelectedEntity, exports.updateVendorBulkRecommendationsFetchStatus = _a.updateVendorBulkRecommendationsFetchStatus, exports.setIsVendorUpdateAllChecked = _a.setIsVendorUpdateAllChecked;
 exports.default = transactionDetail.reducer;
 function getUpdatedEntityLocalData(detail, updates, entity, resetRecommendations, type) {
     const key = type === 'customer' ? 'customerUpdates' : 'vendorUpdates';

package/lib/view/transactionDetail/transactionDetailSelector.d.ts

@@ -18,6 +18,7 @@ export interface TransactionDetailReport extends SelectorView {
     classHierarchyList: NestedClassHierarchyForReport[];
     classList: ClassListSelectorView;
     deleteStatusByAttachmentName: Record<string, FetchStateAndError>;
+    hasInFlightCategoryClassRecommendations: boolean;
     isAccountingClassesEnabled: boolean;
     isAccountingProjectsEnabled: boolean;
     linkedTransactions: SupportedTransactionWithCOT[];
@@ -30,6 +31,7 @@ export interface TransactionDetailReport extends SelectorView {
 export interface VendorDetailsView extends SelectorView {
     vendors: Vendor[];
 }
+export declare const getDetailInFlightRecommendations: (state: RootState, transactionId: TransactionID) => boolean;
 export declare const getTransactionDetail: (state: RootState, transactionId: TransactionID, fetchLinkedTransactions?: boolean) => TransactionDetailReport;
 export declare function getTransactionDetailForTransaction(rootState: RootState, transactionId: TransactionID): TransactionDetailReport | undefined;
 export declare const getInitialUpdatablePeriodsForTransactionRecommendations: (companyIncorporationDate?: ZeniDate, bookCloseDate?: ZeniDate) => {

package/lib/view/transactionDetail/transactionDetailSelector.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInitialUpdatablePeriodsForTransactionRecommendations = exports.getTransactionDetail = void 0;
+exports.getInitialUpdatablePeriodsForTransactionRecommendations = exports.getTransactionDetail = exports.getDetailInFlightRecommendations = void 0;
 exports.getTransactionDetailForTransaction = getTransactionDetailForTransaction;
 const get_1 = __importDefault(require("lodash/get"));
 const reduceFetchState_1 = require("../../commonStateTypes/reduceFetchState");
@@ -17,6 +17,27 @@ const accountListSelector_1 = require("../accountList/accountListSelector");
 const classListSelector_1 = require("../classList/classListSelector");
 const projectListSelector_1 = require("../projectList/projectListSelector");
 const transactionDetailState_1 = require("./transactionDetailState");
+// "Any line on this transaction is fetching category/class recommendations?"
+// Inlined as a plain function because the upstream selector
+// `getTransactionDetail` is also un-memoized and the iteration is O(lines)
+// — typically <10. Exported standalone so consumers that only need the
+// flag (e.g. footer save-disable) can avoid materializing the whole
+// detail report.
+const getDetailInFlightRecommendations = (state, transactionId) => {
+    const detailKey = (0, transactionDetailState_1.getTransactionDetailKey)(transactionId);
+    const detail = (0, get_1.default)(state.transactionDetailState.transactionDetailById, detailKey, undefined);
+    if (detail == null) {
+        return false;
+    }
+    for (const lineItem of Object.values(detail.transactionDetailLocalData.lineItemById)) {
+        if (lineItem.categoryClassRecommendationsFetchState?.fetchState ===
+            'In-Progress') {
+            return true;
+        }
+    }
+    return false;
+};
+exports.getDetailInFlightRecommendations = getDetailInFlightRecommendations;
 const getTransactionDetail = (state, transactionId, fetchLinkedTransactions = true) => {
     const { transactionDetailState, transactionState, vendorState, vendorListState, accountState, classState, classListState, accountListState, projectState, projectListState, } = state;
     const detailKey = (0, transactionDetailState_1.getTransactionDetailKey)(transactionId);
@@ -85,6 +106,7 @@ const getTransactionDetail = (state, transactionId, fetchLinkedTransactions = tr
         : [];
     const transactionDetailAnyUpdateStatus = reduceUpdateFetchStates(transactionDetail);
     const vendors = (0, vendorSelector_1.getVendorsByVendorIds)(vendorState, vendorListState.vendorIds);
+    const hasInFlightCategoryClassRecommendations = (0, exports.getDetailInFlightRecommendations)(state, transactionId);
     return {
         reportId: 'transaction_detail',
         reportTitle: 'Transaction Detail',
@@ -100,6 +122,7 @@ const getTransactionDetail = (state, transactionId, fetchLinkedTransactions = tr
         classHierarchyList,
         accountsHierarchyList,
         classList: classList,
+        hasInFlightCategoryClassRecommendations,
         isAccountingClassesEnabled,
         isAccountingProjectsEnabled,
         projectList,

package/lib/view/transactionDetail/transactionDetailTypes.d.ts

@@ -14,6 +14,7 @@ export interface TransactionDetailLineItemData extends TransactionLineBase {
     isClassMiscategorized: boolean;
     account?: AccountBase;
     billable?: BillableStatus;
+    categoryClassRecommendationsFetchState?: FetchStateAndError;
     class?: ClassBase;
     customer?: CustomerBase;
     isCategoryUpdateSelected?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.0.74",
+  "version": "5.0.75",
   "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
   "main": "lib/index.js",
   "module": "lib/esm/index.js",