@zeniai/client-epic-state 5.2.54 → 5.2.56-betaRD1

package/lib/view/spendManagement/billPay/editBillView/editBillViewReducer.d.ts

@@ -26,7 +26,10 @@ export declare const fetchEditBillDetailPage: import("@reduxjs/toolkit").ActionC
 }, "editBillView/initializeBillToLocalStore", never, never>, saveBillUpdatesToLocalStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     billDetailLocalData: BillDetailLocalData;
     billId?: ID;
-}, "editBillView/saveBillUpdatesToLocalStore">, discardBillUpdatesInLocalStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+}, "editBillView/saveBillUpdatesToLocalStore">, updateBillLineRecommendationsInLocalStore: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[billId: string, updatesByLineId: Record<string, import("./editBillViewState").LineItemRecommendationsLocalData>], {
+    billId: string;
+    updatesByLineId: Record<string, import("./editBillViewState").LineItemRecommendationsLocalData>;
+}, "editBillView/updateBillLineRecommendationsInLocalStore", never, never>, discardBillUpdatesInLocalStore: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     billId?: ID;
 }, "editBillView/discardBillUpdatesInLocalStore">, saveBillDetail: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[billStageCode: "paid" | "pending_approval" | "scheduled" | "draft", isForMarkAsPaid: boolean, isApproverMarkingAsPaid: boolean, billId?: string | undefined], {
     billStageCode: "paid" | "pending_approval" | "scheduled" | "draft";

package/lib/view/spendManagement/billPay/editBillView/editBillViewReducer.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateShouldReplaceBillData = exports.replaceBillFileInLocalStore = exports.removeBillFileFromLocalStore = exports.updateWithdrawFromAccountId = exports.updateNewAddedBillPaymentAccount = exports.discardOutsideZeniPaymentLocalData = exports.updateOutsideZeniPaymentLocalData = exports.markBillForRetry = exports.waitForVendorByIdThenSaveBillUpdatetoLocalStore = exports.fetchVendorAndUpdateBillLocalData = exports.updateHomeCurrencyConversion = exports.currencyConversionValueSuccessOrFailure = exports.convertAmountToHomeCurrency = exports.updateVendorContactSuccessOrFailure = exports.updateVendorContact = exports.updateSuggestedVendorIdFromParsedInvoice = exports.updateRecommendedVendorId = exports.updateBillUploadFetchState = exports.updateAddBillAutoFields = exports.updateShowAutofill = exports.updateInternationalTransferFeeBearerPaymentMethodInLocalData = exports.waitForVendorByNameThenParsetoLocalStore = exports.waitForBillDetailThenInitializeLocalStore = exports.parseInvoiceToBill = exports.updateEditBillFetchStateCompleted = exports.saveBillSuccessOrFailure = exports.saveBillDetail = exports.discardBillUpdatesInLocalStore = exports.saveBillUpdatesToLocalStore = exports.initializeBillToLocalStore = exports.fetchVendorByNameAndParseInvoice = exports.fetchBillAndInitializeLocalStore = exports.fetchEditBillDetailPage = exports.initialState = void 0;
+exports.updateShouldReplaceBillData = exports.replaceBillFileInLocalStore = exports.removeBillFileFromLocalStore = exports.updateWithdrawFromAccountId = exports.updateNewAddedBillPaymentAccount = exports.discardOutsideZeniPaymentLocalData = exports.updateOutsideZeniPaymentLocalData = exports.markBillForRetry = exports.waitForVendorByIdThenSaveBillUpdatetoLocalStore = exports.fetchVendorAndUpdateBillLocalData = exports.updateHomeCurrencyConversion = exports.currencyConversionValueSuccessOrFailure = exports.convertAmountToHomeCurrency = exports.updateVendorContactSuccessOrFailure = exports.updateVendorContact = exports.updateSuggestedVendorIdFromParsedInvoice = exports.updateRecommendedVendorId = exports.updateBillUploadFetchState = exports.updateAddBillAutoFields = exports.updateShowAutofill = exports.updateInternationalTransferFeeBearerPaymentMethodInLocalData = exports.waitForVendorByNameThenParsetoLocalStore = exports.waitForBillDetailThenInitializeLocalStore = exports.parseInvoiceToBill = exports.updateEditBillFetchStateCompleted = exports.saveBillSuccessOrFailure = exports.saveBillDetail = exports.discardBillUpdatesInLocalStore = exports.updateBillLineRecommendationsInLocalStore = exports.saveBillUpdatesToLocalStore = exports.initializeBillToLocalStore = exports.fetchVendorByNameAndParseInvoice = exports.fetchBillAndInitializeLocalStore = exports.fetchEditBillDetailPage = exports.initialState = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
 const amount_1 = require("../../../../commonStateTypes/amount");
 const attachmentPayload_1 = require("../../../../entity/transaction/payloadTypes/attachmentPayload");
@@ -153,6 +153,23 @@ const editBillView = (0, toolkit_1.createSlice)({
                 }
             }
         },
+        // Applied when the standalone recommendations fetch resolves after the
+        // edit local store was already initialized. `initializeBillToLocalStore`
+        // is guarded to run once, so without this the late recommendations would
+        // never reach the category/class autofill or the "update to" checkbox.
+        updateBillLineRecommendationsInLocalStore: {
+            reducer(draft, action) {
+                const { billId, updatesByLineId } = action.payload;
+                const key = (0, billDetailViewState_1.getBillTransactionDetailKey)(billId);
+                const editBill = draft.editBillStateById[key];
+                if (editBill != null) {
+                    editBill.billDetailLocalData.updatesByLineId = Object.assign({}, editBill.billDetailLocalData.updatesByLineId, updatesByLineId);
+                }
+            },
+            prepare(billId, updatesByLineId) {
+                return { payload: { billId, updatesByLineId } };
+            },
+        },
         discardBillUpdatesInLocalStore(draft, action) {
             if (action.payload.billId != null) {
                 const { billId } = action.payload;
@@ -498,7 +515,7 @@ const editBillView = (0, toolkit_1.createSlice)({
         });
     },
 });
-_a = editBillView.actions, exports.fetchEditBillDetailPage = _a.fetchEditBillDetailPage, exports.fetchBillAndInitializeLocalStore = _a.fetchBillAndInitializeLocalStore, exports.fetchVendorByNameAndParseInvoice = _a.fetchVendorByNameAndParseInvoice, exports.initializeBillToLocalStore = _a.initializeBillToLocalStore, exports.saveBillUpdatesToLocalStore = _a.saveBillUpdatesToLocalStore, exports.discardBillUpdatesInLocalStore = _a.discardBillUpdatesInLocalStore, exports.saveBillDetail = _a.saveBillDetail, exports.saveBillSuccessOrFailure = _a.saveBillSuccessOrFailure, exports.updateEditBillFetchStateCompleted = _a.updateEditBillFetchStateCompleted, exports.parseInvoiceToBill = _a.parseInvoiceToBill, exports.waitForBillDetailThenInitializeLocalStore = _a.waitForBillDetailThenInitializeLocalStore, exports.waitForVendorByNameThenParsetoLocalStore = _a.waitForVendorByNameThenParsetoLocalStore, exports.updateInternationalTransferFeeBearerPaymentMethodInLocalData = _a.updateInternationalTransferFeeBearerPaymentMethodInLocalData, exports.updateShowAutofill = _a.updateShowAutofill, exports.updateAddBillAutoFields = _a.updateAddBillAutoFields, exports.updateBillUploadFetchState = _a.updateBillUploadFetchState, exports.updateRecommendedVendorId = _a.updateRecommendedVendorId, exports.updateSuggestedVendorIdFromParsedInvoice = _a.updateSuggestedVendorIdFromParsedInvoice, exports.updateVendorContact = _a.updateVendorContact, exports.updateVendorContactSuccessOrFailure = _a.updateVendorContactSuccessOrFailure, exports.convertAmountToHomeCurrency = _a.convertAmountToHomeCurrency, exports.currencyConversionValueSuccessOrFailure = _a.currencyConversionValueSuccessOrFailure, exports.updateHomeCurrencyConversion = _a.updateHomeCurrencyConversion, exports.fetchVendorAndUpdateBillLocalData = _a.fetchVendorAndUpdateBillLocalData, exports.waitForVendorByIdThenSaveBillUpdatetoLocalStore = _a.waitForVendorByIdThenSaveBillUpdatetoLocalStore, exports.markBillForRetry = _a.markBillForRetry, exports.updateOutsideZeniPaymentLocalData = _a.updateOutsideZeniPaymentLocalData, exports.discardOutsideZeniPaymentLocalData = _a.discardOutsideZeniPaymentLocalData, exports.updateNewAddedBillPaymentAccount = _a.updateNewAddedBillPaymentAccount, exports.updateWithdrawFromAccountId = _a.updateWithdrawFromAccountId, exports.removeBillFileFromLocalStore = _a.removeBillFileFromLocalStore, exports.replaceBillFileInLocalStore = _a.replaceBillFileInLocalStore, exports.updateShouldReplaceBillData = _a.updateShouldReplaceBillData;
+_a = editBillView.actions, exports.fetchEditBillDetailPage = _a.fetchEditBillDetailPage, exports.fetchBillAndInitializeLocalStore = _a.fetchBillAndInitializeLocalStore, exports.fetchVendorByNameAndParseInvoice = _a.fetchVendorByNameAndParseInvoice, exports.initializeBillToLocalStore = _a.initializeBillToLocalStore, exports.saveBillUpdatesToLocalStore = _a.saveBillUpdatesToLocalStore, exports.updateBillLineRecommendationsInLocalStore = _a.updateBillLineRecommendationsInLocalStore, exports.discardBillUpdatesInLocalStore = _a.discardBillUpdatesInLocalStore, exports.saveBillDetail = _a.saveBillDetail, exports.saveBillSuccessOrFailure = _a.saveBillSuccessOrFailure, exports.updateEditBillFetchStateCompleted = _a.updateEditBillFetchStateCompleted, exports.parseInvoiceToBill = _a.parseInvoiceToBill, exports.waitForBillDetailThenInitializeLocalStore = _a.waitForBillDetailThenInitializeLocalStore, exports.waitForVendorByNameThenParsetoLocalStore = _a.waitForVendorByNameThenParsetoLocalStore, exports.updateInternationalTransferFeeBearerPaymentMethodInLocalData = _a.updateInternationalTransferFeeBearerPaymentMethodInLocalData, exports.updateShowAutofill = _a.updateShowAutofill, exports.updateAddBillAutoFields = _a.updateAddBillAutoFields, exports.updateBillUploadFetchState = _a.updateBillUploadFetchState, exports.updateRecommendedVendorId = _a.updateRecommendedVendorId, exports.updateSuggestedVendorIdFromParsedInvoice = _a.updateSuggestedVendorIdFromParsedInvoice, exports.updateVendorContact = _a.updateVendorContact, exports.updateVendorContactSuccessOrFailure = _a.updateVendorContactSuccessOrFailure, exports.convertAmountToHomeCurrency = _a.convertAmountToHomeCurrency, exports.currencyConversionValueSuccessOrFailure = _a.currencyConversionValueSuccessOrFailure, exports.updateHomeCurrencyConversion = _a.updateHomeCurrencyConversion, exports.fetchVendorAndUpdateBillLocalData = _a.fetchVendorAndUpdateBillLocalData, exports.waitForVendorByIdThenSaveBillUpdatetoLocalStore = _a.waitForVendorByIdThenSaveBillUpdatetoLocalStore, exports.markBillForRetry = _a.markBillForRetry, exports.updateOutsideZeniPaymentLocalData = _a.updateOutsideZeniPaymentLocalData, exports.discardOutsideZeniPaymentLocalData = _a.discardOutsideZeniPaymentLocalData, exports.updateNewAddedBillPaymentAccount = _a.updateNewAddedBillPaymentAccount, exports.updateWithdrawFromAccountId = _a.updateWithdrawFromAccountId, exports.removeBillFileFromLocalStore = _a.removeBillFileFromLocalStore, exports.replaceBillFileInLocalStore = _a.replaceBillFileInLocalStore, exports.updateShouldReplaceBillData = _a.updateShouldReplaceBillData;
 exports.default = editBillView.reducer;
 function doUpdateRecurringBillLocalData(billDetail, currentConfig, prevConfig) {
     const recurringBillDetail = (0, helpers_1.updateRecurringBillDetails)(currentConfig, prevConfig, billDetail.recurringBillInstances, billDetail.recipientTotalAmount?.amount);

package/lib/view/spendManagement/billPay/editBillView/editBillViewSelector.d.ts

@@ -99,6 +99,7 @@ export interface EditBillDetailSelectorView extends SelectorView {
     payNowCutOffTime?: ZeniDate;
     qboId?: ID;
     recommendationByLineID?: RecommendationByLineId;
+    recommendationsFetchStatus?: FetchStateAndError;
     recommendedVendor?: Vendor;
     recurringBillInstances?: RecurringBillInstance[];
     recurringConfig?: RecurringBillConfigLocalData;

package/lib/view/spendManagement/billPay/editBillView/editBillViewSelector.js

@@ -389,6 +389,9 @@ const getEditBillDetail = (state, isVendorRecommendationFeatureEnabled, isZeniAc
         classHierarchyList,
         latestApprovedDate: (0, helpers_1.getLatestApprovalDate)(billActivities),
         recommendationByLineID: recommendations,
+        recommendationsFetchStatus: billId != null
+            ? billDetailViewState.billDetailById[(0, billDetailViewState_1.getBillTransactionDetailKey)(billId)]?.recommendationsFetchStatus
+            : undefined,
         isRecurring,
         recurringBillInstances,
         recurringConfig,

package/lib/view/spendManagement/billPay/editBillView/epics/applyBillRecommendationsToLocalStoreEpic.d.ts

@@ -0,0 +1,18 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../../../reducer';
+import { fetchBillRecommendationsSuccess } from '../../billDetailView/billDetailViewReducer';
+import { updateBillLineRecommendationsInLocalStore } from '../editBillViewReducer';
+export type ActionType = ReturnType<typeof fetchBillRecommendationsSuccess> | ReturnType<typeof updateBillLineRecommendationsInLocalStore>;
+/**
+ * Back-fills the edit local store once the standalone recommendations fetch
+ * resolves. `initializeBillToLocalStore` reads `transaction.recommendations`
+ * exactly once and is guarded against re-running, so the recommendation-derived
+ * line data (category/class autofill, `recommendedCategory` / `recommendedClass`
+ * behind the "update to" checkbox) has to be recomputed here instead.
+ *
+ * Recomputes from the entity lines with the same helper the initializer uses, so
+ * an untouched line ends up exactly as it would have had the recommendations
+ * been present at init time.
+ */
+export declare const applyBillRecommendationsToLocalStoreEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

package/lib/view/spendManagement/billPay/editBillView/epics/applyBillRecommendationsToLocalStoreEpic.js

@@ -0,0 +1,102 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyBillRecommendationsToLocalStoreEpic = void 0;
+const get_1 = __importDefault(require("lodash/get"));
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const accountListSelector_1 = require("../../../../accountList/accountListSelector");
+const classListSelector_1 = require("../../../../classList/classListSelector");
+const billDetailViewReducer_1 = require("../../billDetailView/billDetailViewReducer");
+const billDetailViewState_1 = require("../../billDetailView/billDetailViewState");
+const editBillViewReducer_1 = require("../editBillViewReducer");
+const initializeBillToLocalStoreEpic_1 = require("./initializeBillToLocalStoreEpic");
+/**
+ * Back-fills the edit local store once the standalone recommendations fetch
+ * resolves. `initializeBillToLocalStore` reads `transaction.recommendations`
+ * exactly once and is guarded against re-running, so the recommendation-derived
+ * line data (category/class autofill, `recommendedCategory` / `recommendedClass`
+ * behind the "update to" checkbox) has to be recomputed here instead.
+ *
+ * Recomputes from the entity lines with the same helper the initializer uses, so
+ * an untouched line ends up exactly as it would have had the recommendations
+ * been present at init time.
+ */
+const applyBillRecommendationsToLocalStoreEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(billDetailViewReducer_1.fetchBillRecommendationsSuccess.match), 
+// The skip paths resolve the status without fetching — a draft whose
+// recommendations came on the bill detail response, or a stage that is not
+// served any. `initializeBillToLocalStore` has already read those, so
+// recomputing here would only reset the line's "update to" selections.
+(0, operators_1.filter)((action) => action.payload.didWriteRecommendations), (0, operators_1.mergeMap)((action) => {
+    const { billId } = action.payload;
+    const state = state$.value;
+    const key = (0, billDetailViewState_1.getBillTransactionDetailKey)(billId);
+    const editBillState = (0, get_1.default)(state.editBillDetailViewState.editBillStateById, key, undefined);
+    const transaction = (0, get_1.default)(state.billTransactionState.transactionById, billId, undefined);
+    const recommendations = transaction?.recommendations;
+    if (editBillState == null ||
+        transaction == null ||
+        transaction.lines == null ||
+        recommendations == null ||
+        Object.keys(recommendations).length === 0) {
+        return rxjs_1.EMPTY;
+    }
+    const localData = editBillState.billDetailLocalData;
+    // The recommendations were requested for the vendor on the bill. If the
+    // user has since switched vendors, `fetchVendorAndUpdateBillLocalData`
+    // owns the line data and these are stale — leave it alone.
+    //
+    // Both sides are QBO ids despite the field names suggesting otherwise.
+    // `transaction.vendor` is built by `mapVendorBasePayloadToVendorBase`,
+    // whose id is `getVendorPayloadIdentifier` = `vendor_id ?? qbo_id`, and
+    // on a bill transaction payload `vendor_id` IS the QBO id — the Zeni id
+    // rides separately as `zeni_vendor_id`. Verified against live DEV and QA
+    // responses, both of which have `vendor_id === qbo_vendor_id`.
+    if (localData.vendor?.qboId !== transaction.vendor?.id) {
+        return rxjs_1.EMPTY;
+    }
+    const accountList = (0, accountListSelector_1.getAccountList)(state.accountState, state.accountListState, 'billPayAccountList');
+    const classList = (0, classListSelector_1.getClassList)(state.classState, state.classListState);
+    const updatesByLineId = {};
+    transaction.lines.forEach((line) => {
+        // A line whose category/class the user already set keeps their input.
+        const localLine = localData.updatesByLineId[line.id];
+        if (localLine?.isCategoryOrClassUpdated) {
+            return;
+        }
+        // The helper spreads whatever line it is given into its result, and
+        // the reducer replaces the entry wholesale, so the local line has to
+        // go in or edits that leave `isCategoryOrClassUpdated` untouched — an
+        // amount or description changed while this fetch was in flight — get
+        // reverted.
+        //
+        // Category and class are the exception and come from the ENTITY line,
+        // exactly as at init. By now the local line may hold a category the
+        // vendor default autofilled when no recommendation was available yet,
+        // and the helper reads whatever it is given as the line's original
+        // value and will not replace one. Passing that back would leave an
+        // untouched line on the vendor default instead of the per-line
+        // recommendation, so the back-fill would not match what init would
+        // have produced had the recommendations been there all along.
+        const localLineWithEntityCategory = localLine == null || hasAccountAndClass(line) === false
+            ? line
+            : {
+                ...localLine,
+                account: line.account,
+                class: line.class,
+            };
+        updatesByLineId[line.id] = (0, initializeBillToLocalStoreEpic_1.getLineRecommendationsLocalData)(line.id, localLineWithEntityCategory, recommendations, accountList, classList, localData.vendor);
+    });
+    if (Object.keys(updatesByLineId).length === 0) {
+        return rxjs_1.EMPTY;
+    }
+    return (0, rxjs_1.of)((0, editBillViewReducer_1.updateBillLineRecommendationsInLocalStore)(billId, updatesByLineId));
+}));
+exports.applyBillRecommendationsToLocalStoreEpic = applyBillRecommendationsToLocalStoreEpic;
+// Only some `Line` members carry a category and class. A guard rather than a
+// cast so a shape change is a compile error, not a silent `undefined`.
+function hasAccountAndClass(line) {
+    return 'account' in line;
+}

package/package.json

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