@zeniai/client-epic-state 5.2.35-beta0MM → 5.2.35-beta2MM

package/lib/view/expenseAutomationView/epics/actualMatching/searchMatchTransactionsEpic.js

@@ -5,6 +5,7 @@ const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const actualMatchingSelector_1 = require("../../../../entity/actualMatching/actualMatchingSelector");
 const responsePayload_1 = require("../../../../responsePayload");
+const rootActions_1 = require("../../../../rootActions");
 const actualMatchingPayload_1 = require("../../payload/actualMatchingPayload");
 const actualMatchingViewReducer_1 = require("../../reducers/actualMatchingViewReducer");
 const actualMatchingViewSelector_1 = require("../../selectors/actualMatchingViewSelector");
@@ -70,7 +71,10 @@ const searchMatchTransactionsEpic = (actions$, state$, zeniAPI) => {
         }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, actualMatchingViewReducer_1.searchMatchTransactionsFailure)({
             error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Search match transactions REST API call errored out' +
                 JSON.stringify(error)),
-        }))));
+        }))), 
+        // On the HTTP stream only. Wrapping `merge(openModal$, search$)`
+        // would complete the epic on the first `clearAll` and drop later searches.
+        (0, operators_1.takeUntil)(actions$.pipe((0, operators_1.filter)(rootActions_1.clearAll.match))));
     }));
     return (0, rxjs_1.merge)(openModal$, search$);
 };

package/lib/view/expenseAutomationView/epics/actualMatching/undoReversalAccrualsEpic.js

@@ -4,14 +4,13 @@ exports.undoReversalAccrualsEpic = void 0;
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const timePeriod_1 = require("../../../../commonStateTypes/timePeriod");
-const tenantSelector_1 = require("../../../../entity/tenant/tenantSelector");
 const responsePayload_1 = require("../../../../responsePayload");
 const rootActions_1 = require("../../../../rootActions");
 const actualMatchingPayload_1 = require("../../payload/actualMatchingPayload");
 const actualMatchingViewReducer_1 = require("../../reducers/actualMatchingViewReducer");
+const actualMatchingViewSelector_1 = require("../../selectors/actualMatchingViewSelector");
 function refreshActualMatchingList(state) {
-    const currentTenant = (0, tenantSelector_1.getCurrentTenant)(state);
-    const selectedMonthYear = state.expenseAutomationViewState.selectedPeriodByTenantId[currentTenant?.tenantId ?? ''];
+    const selectedMonthYear = (0, actualMatchingViewSelector_1.getSelectedMonthYearForCurrentTenant)(state);
     if (selectedMonthYear == null) {
         return [];
     }

package/lib/view/expenseAutomationView/expenseAutomationViewSelector.js

@@ -46,6 +46,7 @@ function getExpenseAutomationView(state) {
     const reconciliation = (0, reconciliationViewSelector_1.getExpenseAutomationReconciliationView)(state);
     const expenseAutomationTransactionsView = (0, transactionCategorizationSelector_1.getExpenseAutomationTransactionView)(state);
     const jeSchedules = (0, jeSchedulesViewSelector_1.getExpenseAutomationJESchedulesView)(state);
+    // Top-level sibling of `jeSchedules`: see ExpenseAutomationViewSelector.
     const actualMatching = (0, actualMatchingViewSelector_1.getExpenseAutomationActualMatchingView)(state);
     switch (currentSelectedView) {
         case 'reconciliation':

package/lib/view/expenseAutomationView/expenseAutomationViewState.d.ts

@@ -1,8 +1,9 @@
 import { FetchStateAndError, FetchedState, ID } from '../../commonStateTypes/common';
 import { MonthYearPeriod } from '../../commonStateTypes/timePeriod';
-export declare const EXPENSE_AUTOMATION_VIEW_TYPES: readonly ["transaction_categorization", "je_schedules", "reconciliation", "missing_receipts", "flux_analysis", "month_end_insights"];
 export declare const toExpenseAutomationViewType: (v: string) => "transaction_categorization" | "je_schedules" | "reconciliation" | "missing_receipts" | "flux_analysis" | "month_end_insights";
 export type ExpenseAutomationViewType = ReturnType<typeof toExpenseAutomationViewType>;
+/** Unlike `toExpenseAutomationViewType`, unknown strings return `undefined`. */
+export declare const toExpenseAutomationViewTypeStrict: (v: string) => ExpenseAutomationViewType | undefined;
 export interface ExpenseAutomationViewState extends FetchedState {
     currentSelectedView: ExpenseAutomationViewType;
     saveStatus: FetchStateAndError;

package/lib/view/expenseAutomationView/expenseAutomationViewState.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toExpenseAutomationViewType = exports.EXPENSE_AUTOMATION_VIEW_TYPES = void 0;
+exports.toExpenseAutomationViewTypeStrict = exports.toExpenseAutomationViewType = void 0;
 const stringToUnion_1 = require("../../commonStateTypes/stringToUnion");
-exports.EXPENSE_AUTOMATION_VIEW_TYPES = [
+const EXPENSE_AUTOMATION_VIEW_TYPES = [
     'transaction_categorization',
     'je_schedules',
     'reconciliation',
@@ -10,5 +10,8 @@ exports.EXPENSE_AUTOMATION_VIEW_TYPES = [
     'flux_analysis',
     'month_end_insights',
 ];
-const toExpenseAutomationViewType = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.EXPENSE_AUTOMATION_VIEW_TYPES);
+const toExpenseAutomationViewType = (v) => (0, stringToUnion_1.stringToUnion)(v, EXPENSE_AUTOMATION_VIEW_TYPES);
 exports.toExpenseAutomationViewType = toExpenseAutomationViewType;
+/** Unlike `toExpenseAutomationViewType`, unknown strings return `undefined`. */
+const toExpenseAutomationViewTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v, EXPENSE_AUTOMATION_VIEW_TYPES);
+exports.toExpenseAutomationViewTypeStrict = toExpenseAutomationViewTypeStrict;

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

@@ -67,8 +67,10 @@ export declare const clearActualMatchingView: import("@reduxjs/toolkit").ActionC
     results: ActualMatchingTransactionSearchResult[];
 }, "expenseAutomationActualMatchingView/searchMatchTransactionsSuccess">, undoReversalAccruals: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[params: UndoReversalAccrualsParams], UndoReversalAccrualsParams, "expenseAutomationActualMatchingView/undoReversalAccruals", never, never>, undoReversalAccrualsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     status: ZeniAPIStatus;
-}, "expenseAutomationActualMatchingView/undoReversalAccrualsFailure">, undoReversalAccrualsSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+}, "expenseAutomationActualMatchingView/undoReversalAccrualsFailure">, undoReversalAccrualsSuccess: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
     results: UndoReversalResult[];
-}, "expenseAutomationActualMatchingView/undoReversalAccrualsSuccess">, updateActualMatchingUIState: import("@reduxjs/toolkit").ActionCreatorWithPayload<Partial<ActualMatchingViewUIState>, "expenseAutomationActualMatchingView/updateActualMatchingUIState">;
+}], {
+    results: UndoReversalResult[];
+}, "expenseAutomationActualMatchingView/undoReversalAccrualsSuccess", never, never>, updateActualMatchingUIState: import("@reduxjs/toolkit").ActionCreatorWithPayload<Partial<ActualMatchingViewUIState>, "expenseAutomationActualMatchingView/updateActualMatchingUIState">;
 declare const _default: import("redux").Reducer<ActualMatchingViewState>;
 export default _default;

package/lib/view/expenseAutomationView/reducers/actualMatchingViewReducer.js

@@ -201,10 +201,13 @@ const expenseAutomationActualMatchingView = (0, toolkit_1.createSlice)({
                 }
             },
         },
+        // Dismiss (Cancel / overlay). Store reset matches `clearMatchNewModal`;
+        // the actions stay distinct so confirm-success vs user-dismiss stay observable.
         closeMatchNewModal(draft) {
             draft.matchModal.isOpen = false;
             resetMatchModalSearches(draft);
         },
+        // Confirm-success / host reset. Same slice write as close; different action type.
         clearMatchNewModal(draft) {
             draft.matchModal.isOpen = false;
             resetMatchModalSearches(draft);
@@ -341,12 +344,16 @@ const expenseAutomationActualMatchingView = (0, toolkit_1.createSlice)({
                 return { payload: params };
             },
         },
-        undoReversalAccrualsSuccess(draft, action) {
-            draft.undoReversalStatus = {
-                fetchState: 'Completed',
-                error: undefined,
-            };
-            void action;
+        undoReversalAccrualsSuccess: {
+            reducer(draft) {
+                draft.undoReversalStatus = {
+                    fetchState: 'Completed',
+                    error: undefined,
+                };
+            },
+            prepare(payload) {
+                return { payload };
+            },
         },
         undoReversalAccrualsFailure(draft, action) {
             draft.undoReversalStatus = {

package/lib/view/expenseAutomationView/selectorTypes/actualMatchingViewSelectorTypes.d.ts

@@ -26,23 +26,25 @@ export interface ActualMatchingRow extends JEOneTimeAccrual {
     transactionType?: string;
 }
 export interface ActualMatchingKpiSummary {
-    ai: {
+    actualsReceived: {
         count: number;
+        expectedCount: number;
+        vendorsPending: number;
     };
     autoReversed: {
-        amount: number;
-        count: number;
-    };
-    manual: {
+        clearedAmount: number;
         count: number;
+        percent: number;
     };
     pendingReview: {
         amount: number;
         count: number;
+        estimatedMinutesToClear: number;
     };
-    totalThisClose: {
-        amount: number;
-        count: number;
+    variance: {
+        averagePercentPerMatch: number;
+        netAmount: number;
+        percent: number;
     };
 }
 export interface ActualMatchingMatchModalView {

package/lib/view/expenseAutomationView/selectorTypes/expenseAutomationViewSelectorTypes.d.ts

@@ -22,6 +22,15 @@ export interface ExpenseAutomationStepDetails {
     title: string;
 }
 export interface ExpenseAutomationViewSelector extends SelectorView {
+    /**
+     * Sibling of `jeSchedules`, not nested under it. The Journal Entries navbar
+     * hosts Actual Matching (`selectedPageTab === 'actual_matching'`), but AM is
+     * a different GET, entity map (`byMatchId`), and period cache
+     * (`matchIdsByPeriod`) than Review / Existing. Nesting it on `jeSchedules`
+     * would hide a second store inside the schedules selector. Chrome coupling
+     * stays `jeSchedules.uiState.selectedPageTab`; AM rows, Match New, and undo
+     * live here.
+     */
     actualMatching: ExpenseAutomationActualMatchingViewSelector;
     allSteps: ExpenseAutomationStepDetails[];
     completionStatus: CompletionStatusType;

package/lib/view/expenseAutomationView/selectors/actualMatchingViewSelector.d.ts

@@ -1,11 +1,13 @@
 import { FetchStateAndError } from '../../../commonStateTypes/common';
+import { MonthYearPeriod } from '../../../commonStateTypes/timePeriod';
 import { ActualMatchingMatch } from '../../../entity/actualMatching/actualMatchingState';
 import { ActualMatchingMatchId } from '../../../entity/actualMatching/actualMatchingTypes';
 import { JEOneTimeAccrual } from '../../../entity/jeSchedules/jeSchedulesSelector';
 import { JEOneTimeAccrualMatchSuggestion } from '../../../entity/jeSchedules/jeSchedulesState';
 import { RootState } from '../../../rootStateTypes';
 import { ZeniDate } from '../../../zeniDayJS';
-import { ActualMatchingRow, ActualMatchingRowKind, ExpenseAutomationActualMatchingViewSelector } from '../selectorTypes/actualMatchingViewSelectorTypes';
+import { ActualMatchingKpiSummary, ActualMatchingRow, ActualMatchingRowKind, ExpenseAutomationActualMatchingViewSelector } from '../selectorTypes/actualMatchingViewSelectorTypes';
+export declare function getSelectedMonthYearForCurrentTenant(state: RootState): MonthYearPeriod | undefined;
 export declare function parseActualMatchingMatchId(matchId: string): {
     transactionIntegrationId: string;
     transactionType: string;
@@ -19,6 +21,7 @@ export declare function isReversedMatchKind(kind: ActualMatchingRowKind): boolea
 export declare function getClearedMatchedAmount(accrual: JEOneTimeAccrual): number | undefined;
 export declare function getActualMatchingAmount(row: ActualMatchingRow): number;
 export declare function getActualMatchingReversalDate(accrual: JEOneTimeAccrual): ZeniDate | undefined;
+export declare function buildActualMatchingKpiSummary(rows: ActualMatchingRow[]): ActualMatchingKpiSummary;
 export interface ExpenseAutomationActualMatchingMatchView {
     detailFetchState: FetchStateAndError;
     refreshStatus: FetchStateAndError;

package/lib/view/expenseAutomationView/selectors/actualMatchingViewSelector.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSelectedMonthYearForCurrentTenant = getSelectedMonthYearForCurrentTenant;
 exports.parseActualMatchingMatchId = parseActualMatchingMatchId;
 exports.isAutoReversedAccrual = isAutoReversedAccrual;
 exports.isManuallyReversedAccrual = isManuallyReversedAccrual;
@@ -11,6 +12,7 @@ exports.isReversedMatchKind = isReversedMatchKind;
 exports.getClearedMatchedAmount = getClearedMatchedAmount;
 exports.getActualMatchingAmount = getActualMatchingAmount;
 exports.getActualMatchingReversalDate = getActualMatchingReversalDate;
+exports.buildActualMatchingKpiSummary = buildActualMatchingKpiSummary;
 exports.getExpenseAutomationActualMatchingMatchView = getExpenseAutomationActualMatchingMatchView;
 exports.getExpenseAutomationActualMatchingView = getExpenseAutomationActualMatchingView;
 const orderBy_1 = __importDefault(require("lodash/orderBy"));
@@ -19,6 +21,13 @@ const actualMatchingSelector_1 = require("../../../entity/actualMatching/actualM
 const jeScheduleHelper_1 = require("../../../entity/jeSchedules/jeScheduleHelper");
 const jeSchedulesSelector_1 = require("../../../entity/jeSchedules/jeSchedulesSelector");
 const tenantSelector_1 = require("../../../entity/tenant/tenantSelector");
+function getSelectedMonthYearForCurrentTenant(state) {
+    const tenantId = (0, tenantSelector_1.getCurrentTenant)(state)?.tenantId;
+    if (tenantId == null) {
+        return undefined;
+    }
+    return state.expenseAutomationViewState.selectedPeriodByTenantId[tenantId];
+}
 function toMatchModalAccrual(member) {
     if ('jeOneTimeAccrualKey' in member && member.jeOneTimeAccrualKey != null) {
         return member;
@@ -179,18 +188,82 @@ function sortActualMatchingRows(rows, uiState) {
     const lodashOrder = uiState.sortOrder === 'ascending' ? 'asc' : 'desc';
     return (0, orderBy_1.default)(rows, [(row) => getActualMatchingSortValue(row, uiState.sortKey)], [lodashOrder]);
 }
+const ESTIMATED_MINUTES_PER_PENDING_MATCH = 4;
 function emptyKpiSummary() {
     return {
-        autoReversed: { count: 0, amount: 0 },
-        pendingReview: { count: 0, amount: 0 },
-        totalThisClose: { count: 0, amount: 0 },
-        ai: { count: 0 },
-        manual: { count: 0 },
+        actualsReceived: { count: 0, expectedCount: 0, vendorsPending: 0 },
+        autoReversed: { count: 0, percent: 0, clearedAmount: 0 },
+        pendingReview: { count: 0, amount: 0, estimatedMinutesToClear: 0 },
+        variance: { percent: 0, averagePercentPerMatch: 0, netAmount: 0 },
     };
 }
 function sumRowAmounts(rows) {
     return rows.reduce((sum, row) => sum + getActualMatchingAmount(row), 0);
 }
+function uniqueVendorCount(rows) {
+    const ids = new Set();
+    rows.forEach((row) => {
+        if (row.vendorId != null && row.vendorId !== '') {
+            ids.add(row.vendorId);
+            return;
+        }
+        if (row.vendorName !== '') {
+            ids.add(row.vendorName);
+        }
+    });
+    return ids.size;
+}
+function rowVariancePercent(row) {
+    const accrued = row.accruedAmount?.amount ?? row.estimatedAmount.amount;
+    const actual = row.actualAmount?.amount;
+    if (actual == null || accrued === 0) {
+        return undefined;
+    }
+    return ((actual - accrued) / accrued) * 100;
+}
+function buildActualMatchingKpiSummary(rows) {
+    if (rows.length === 0) {
+        return emptyKpiSummary();
+    }
+    const autoReversed = rows.filter((row) => row.kind === 'auto_reversed');
+    const pendingReview = rows.filter((row) => row.kind === 'pending_review');
+    const receivedCount = rows.length;
+    const rowsWithActual = rows.filter((row) => row.actualAmount?.amount != null);
+    const accruedTotal = rowsWithActual.reduce((sum, row) => sum + (row.accruedAmount?.amount ?? row.estimatedAmount.amount), 0);
+    const actualTotal = rowsWithActual.reduce((sum, row) => sum + (row.actualAmount?.amount ?? 0), 0);
+    const variancePercents = rows
+        .map(rowVariancePercent)
+        .filter((percent) => percent != null);
+    return {
+        actualsReceived: {
+            count: receivedCount,
+            // List API does not return still-expected accruals; hide "of N expected"
+            // in the strip until expectedCount is greater than received.
+            expectedCount: receivedCount,
+            vendorsPending: uniqueVendorCount(pendingReview),
+        },
+        autoReversed: {
+            count: autoReversed.length,
+            percent: Math.round((autoReversed.length / receivedCount) * 100),
+            clearedAmount: sumRowAmounts(autoReversed),
+        },
+        pendingReview: {
+            count: pendingReview.length,
+            amount: sumRowAmounts(pendingReview),
+            estimatedMinutesToClear: pendingReview.length * ESTIMATED_MINUTES_PER_PENDING_MATCH,
+        },
+        variance: {
+            percent: accruedTotal === 0
+                ? 0
+                : ((actualTotal - accruedTotal) / accruedTotal) * 100,
+            averagePercentPerMatch: variancePercents.length === 0
+                ? 0
+                : variancePercents.reduce((sum, percent) => sum + percent, 0) /
+                    variancePercents.length,
+            netAmount: actualTotal - accruedTotal,
+        },
+    };
+}
 function getExpenseAutomationActualMatchingMatchView(state, matchId) {
     const view = state.expenseAutomationActualMatchingViewState;
     return {
@@ -201,44 +274,20 @@ function getExpenseAutomationActualMatchingMatchView(state, matchId) {
     };
 }
 function getExpenseAutomationActualMatchingView(state) {
-    const { expenseAutomationActualMatchingViewState, expenseAutomationViewState } = state;
+    const { expenseAutomationActualMatchingViewState } = state;
     const { matchIdsByPeriod, fetchState, error, refreshStatus, uiState, matchModal, undoReversalStatus, } = expenseAutomationActualMatchingViewState;
-    const currentTenant = (0, tenantSelector_1.getCurrentTenant)(state);
-    const selectedPeriod = expenseAutomationViewState.selectedPeriodByTenantId[currentTenant?.tenantId ?? ''];
+    const selectedPeriod = getSelectedMonthYearForCurrentTenant(state);
     const monthYearPeriodId = selectedPeriod != null ? (0, timePeriod_1.toMonthYearPeriodId)(selectedPeriod) : undefined;
     const matchIds = monthYearPeriodId != null ? matchIdsByPeriod[monthYearPeriodId] : undefined;
-    const rows = (matchIds ?? [])
+    const allRows = (matchIds ?? [])
         .map((matchId) => (0, actualMatchingSelector_1.getActualMatchingMatchById)(state.actualMatchingState, matchId))
         .filter((match) => match != null)
         .filter((match) => match.members.length > 0)
-        .map(toActualMatchingRow)
-        .filter((row) => matchesSearch(row, uiState.searchString));
+        .map(toActualMatchingRow);
+    const rows = allRows.filter((row) => matchesSearch(row, uiState.searchString));
     const reversed = sortActualMatchingRows(rows.filter((row) => isReversedMatchKind(row.kind)), uiState);
     const pendingReview = sortActualMatchingRows(rows.filter((row) => row.kind === 'pending_review'), uiState);
-    const autoReversedForKpi = reversed.filter((row) => row.kind === 'auto_reversed');
-    const listedRows = [...reversed, ...pendingReview];
-    const kpiSummary = listedRows.length === 0
-        ? emptyKpiSummary()
-        : {
-            autoReversed: {
-                count: autoReversedForKpi.length,
-                amount: sumRowAmounts(autoReversedForKpi),
-            },
-            pendingReview: {
-                count: pendingReview.length,
-                amount: sumRowAmounts(pendingReview),
-            },
-            totalThisClose: {
-                count: listedRows.length,
-                amount: sumRowAmounts(listedRows),
-            },
-            ai: {
-                count: listedRows.filter((row) => row.origin === 'agent').length,
-            },
-            manual: {
-                count: listedRows.filter((row) => row.origin === 'human').length,
-            },
-        };
+    const kpiSummary = buildActualMatchingKpiSummary(allRows);
     const searchedAccruals = matchModal.accrualSearch.results
         .map((key) => (0, jeSchedulesSelector_1.getJEOneTimeAccrualByKey)(key, state.jeSchedulesState))
         .filter((accrual) => accrual != null);

package/lib/view/expenseAutomationView/selectors/jeSchedulesViewSelector.js

@@ -381,6 +381,7 @@ function getExpenseAutomationJESchedulesView(state) {
     // reports undefined rather than 0, so the UI can hide the badge instead of asserting "none".
     const scheduleCountsByTab = {};
     jeSchedulesViewState_1.ALL_JE_PAGE_TABS.forEach((pageTab) => {
+        // AM's badge is `actualMatching.kpiSummary`, not schedule row keys.
         if (pageTab === 'actual_matching') {
             return;
         }

package/lib/view/expenseAutomationView/types/jeSchedulesViewState.js

@@ -20,6 +20,9 @@ const JE_SCHEDULE_SORT_KEYS = [
 ];
 const toJEScheduleSortKey = (v) => (0, stringToUnion_1.stringToUnion)(v, JE_SCHEDULE_SORT_KEYS);
 exports.toJEScheduleSortKey = toJEScheduleSortKey;
+// `actual_matching` is chrome only: the JE tab bar includes it, but AM data is
+// `expenseAutomationActualMatchingViewState`, not the schedules period-tab
+// cache below. Walks of ALL_JE_PAGE_TABS that read schedule keys must skip it.
 const JE_PAGE_TABS = [
     'schedules',
     'actual_matching',

package/package.json

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