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

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

@@ -171,18 +171,82 @@ function sortActualMatchingRows(rows, uiState) {
     const lodashOrder = uiState.sortOrder === 'ascending' ? 'asc' : 'desc';
     return orderBy(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;
+}
+export 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,
+        },
+    };
+}
 export function getExpenseAutomationActualMatchingMatchView(state, matchId) {
     const view = state.expenseAutomationActualMatchingViewState;
     return {
@@ -198,38 +262,15 @@ export function getExpenseAutomationActualMatchingView(state) {
     const selectedPeriod = getSelectedMonthYearForCurrentTenant(state);
     const monthYearPeriodId = selectedPeriod != null ? toMonthYearPeriodId(selectedPeriod) : undefined;
     const matchIds = monthYearPeriodId != null ? matchIdsByPeriod[monthYearPeriodId] : undefined;
-    const rows = (matchIds ?? [])
+    const allRows = (matchIds ?? [])
         .map((matchId) => 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) => getJEOneTimeAccrualByKey(key, state.jeSchedulesState))
         .filter((accrual) => accrual != null);

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/selectors/actualMatchingViewSelector.d.ts

@@ -6,7 +6,7 @@ import { JEOneTimeAccrual } from '../../../entity/jeSchedules/jeSchedulesSelecto
 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;
@@ -21,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

@@ -12,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"));
@@ -187,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 {
@@ -214,38 +279,15 @@ function getExpenseAutomationActualMatchingView(state) {
     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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.2.35-beta1MM",
+  "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",