@zeniai/client-epic-state 5.0.69 → 5.0.71-betaAK1

package/lib/view/spendManagement/cashManagement/cashManagementOverview/cashManagementOverviewReducer.js

@@ -0,0 +1,86 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearCashManagementOverview = exports.updateCashManagementBannerFetchStatus = exports.updateCashManagementBanner = exports.fetchCashManagementBanner = exports.updateUpcomingPaymentEventsListFetchStatus = exports.updateUpcomingPaymentEventsList = exports.fetchUpcomingPaymentEvents = exports.fetchCashManagementOverviewPage = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const cashManagementOverviewState_1 = require("./cashManagementOverviewState");
+exports.initialState = {
+    banner: cashManagementOverviewState_1.initialCashManagementBannerState,
+    upcomingPaymentEvents: cashManagementOverviewState_1.initialUpcomingPaymentEventsListState,
+    fetchState: 'Not-Started',
+    error: undefined,
+    hasValidState() {
+        return this.fetchState == 'Completed';
+    },
+};
+const cashManagementOverview = (0, toolkit_1.createSlice)({
+    name: 'cashManagementOverview',
+    initialState: exports.initialState,
+    reducers: {
+        fetchCashManagementOverviewPage: {
+            reducer() { },
+            prepare(cacheOverride) {
+                return { payload: { cacheOverride } };
+            },
+        },
+        fetchUpcomingPaymentEvents(draft) {
+            draft.upcomingPaymentEvents = {
+                ...draft.upcomingPaymentEvents,
+                fetchState: 'In-Progress',
+                error: undefined,
+            };
+        },
+        updateUpcomingPaymentEventsList(draft, action) {
+            const { data } = action.payload;
+            const eventIds = [];
+            data.events.forEach((payload) => {
+                if (payload.id != null) {
+                    eventIds.push(payload.id);
+                }
+            });
+            draft.upcomingPaymentEvents = {
+                fetchState: 'Completed',
+                error: undefined,
+                billStages: (data.bill_stages ?? []),
+                eventIds,
+                horizonDays: data.horizon_days,
+                reimbursementStages: (data.reimbursement_stages ??
+                    []),
+                tenantNamespace: data.tenant_namespace,
+            };
+        },
+        updateUpcomingPaymentEventsListFetchStatus(draft, action) {
+            draft.upcomingPaymentEvents = {
+                ...draft.upcomingPaymentEvents,
+                fetchState: action.payload.fetchState,
+                error: action.payload.error,
+            };
+        },
+        fetchCashManagementBanner(draft) {
+            draft.banner = {
+                ...cashManagementOverviewState_1.initialCashManagementBannerState,
+                fetchState: 'In-Progress',
+                error: undefined,
+            };
+        },
+        updateCashManagementBanner(draft, action) {
+            draft.banner = {
+                fetchState: 'Completed',
+                error: undefined,
+                data: action.payload.data,
+            };
+        },
+        updateCashManagementBannerFetchStatus(draft, action) {
+            draft.banner = {
+                ...draft.banner,
+                fetchState: action.payload.fetchState,
+                error: action.payload.error,
+            };
+        },
+        clearCashManagementOverview(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = cashManagementOverview.actions, exports.fetchCashManagementOverviewPage = _a.fetchCashManagementOverviewPage, exports.fetchUpcomingPaymentEvents = _a.fetchUpcomingPaymentEvents, exports.updateUpcomingPaymentEventsList = _a.updateUpcomingPaymentEventsList, exports.updateUpcomingPaymentEventsListFetchStatus = _a.updateUpcomingPaymentEventsListFetchStatus, exports.fetchCashManagementBanner = _a.fetchCashManagementBanner, exports.updateCashManagementBanner = _a.updateCashManagementBanner, exports.updateCashManagementBannerFetchStatus = _a.updateCashManagementBannerFetchStatus, exports.clearCashManagementOverview = _a.clearCashManagementOverview;
+exports.default = cashManagementOverview.reducer;

package/lib/view/spendManagement/cashManagement/cashManagementOverview/cashManagementOverviewSelector.d.ts

@@ -0,0 +1,20 @@
+import { Amount } from '../../../../commonStateTypes/amount';
+import { FetchStateAndError } from '../../../../commonStateTypes/common';
+import { SelectorView } from '../../../../commonStateTypes/viewAndReport/viewAndReport';
+import { UpcomingPaymentEvent } from '../../../../entity/upcomingPaymentEvent/upcomingPaymentEventState';
+import { RootState } from '../../../../reducer';
+import { CashManagementBannerData } from './cashManagementOverviewState';
+export interface CashManagementOverviewBannerSelectorView extends SelectorView {
+    data?: CashManagementBannerData;
+}
+export interface CashManagementOverviewSelectorView extends SelectorView {
+    bannerFetchState: FetchStateAndError;
+    cashBalance: Amount;
+    horizonDays: number;
+    outflowEvents: UpcomingPaymentEvent[];
+    outflowEventsFetchState: FetchStateAndError;
+    totalCash: Amount;
+    treasuryBalance: Amount;
+}
+export declare const getCashManagementOverviewBanner: (state: RootState) => CashManagementOverviewBannerSelectorView;
+export declare const getCashManagementOverview: (state: RootState) => CashManagementOverviewSelectorView;

package/lib/view/spendManagement/cashManagement/cashManagementOverview/cashManagementOverviewSelector.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCashManagementOverview = exports.getCashManagementOverviewBanner = void 0;
+const amount_1 = require("../../../../commonStateTypes/amount");
+const reduceFetchState_1 = require("../../../../commonStateTypes/reduceFetchState");
+const upcomingPaymentEventSelector_1 = require("../../../../entity/upcomingPaymentEvent/upcomingPaymentEventSelector");
+const getCashManagementOverviewBanner = (state) => {
+    const { banner } = state.cashManagementOverviewState;
+    return {
+        fetchState: banner.fetchState,
+        error: banner.error,
+        data: banner.data,
+        version: 0,
+    };
+};
+exports.getCashManagementOverviewBanner = getCashManagementOverviewBanner;
+const getCashManagementOverview = (state) => {
+    const { cashManagementOverviewState, depositAccountListState, depositAccountState, paymentAccountListState, paymentAccountState, treasuryDetailState, } = state;
+    const outflowEventsFetchState = {
+        fetchState: cashManagementOverviewState.upcomingPaymentEvents.fetchState,
+        error: cashManagementOverviewState.upcomingPaymentEvents.error,
+    };
+    const bannerFetchState = {
+        fetchState: cashManagementOverviewState.banner.fetchState,
+        error: cashManagementOverviewState.banner.error,
+    };
+    const aggregate = (0, reduceFetchState_1.reduceAllFetchState)([
+        {
+            fetchState: paymentAccountListState.fetchState,
+            error: paymentAccountListState.error,
+        },
+        {
+            fetchState: depositAccountListState.fetchState,
+            error: depositAccountListState.error,
+        },
+        {
+            fetchState: treasuryDetailState.fetchState,
+            error: treasuryDetailState.error,
+        },
+        outflowEventsFetchState,
+        bannerFetchState,
+    ]);
+    const treasuryBalance = treasuryDetailState.accountSummary?.totalBalance ?? (0, amount_1.zeroAmount)();
+    const cashBalance = sumCashBalances(paymentAccountListState.paymentAccountIds, paymentAccountState, depositAccountListState.accountIds, depositAccountState);
+    const totalCash = addAmounts(treasuryBalance, cashBalance);
+    return {
+        bannerFetchState,
+        cashBalance,
+        horizonDays: cashManagementOverviewState.upcomingPaymentEvents.horizonDays,
+        outflowEvents: (0, upcomingPaymentEventSelector_1.getUpcomingPaymentEventsByIds)(state.upcomingPaymentEventState, cashManagementOverviewState.upcomingPaymentEvents.eventIds),
+        outflowEventsFetchState,
+        totalCash,
+        treasuryBalance,
+        fetchState: aggregate.fetchState,
+        error: aggregate.error,
+        version: 0,
+    };
+};
+exports.getCashManagementOverview = getCashManagementOverview;
+const isZeroAmount = (a) => a.amount === 0 && a.currencyCode === 'USD' && a.currencySymbol === '$';
+/**
+ * Adds two Amounts. Currencies must match (the seeded zeroAmount() counts as
+ * "no currency yet" and adopts `b`'s currency). Mismatches return `a`
+ * unchanged and warn — mixing currencies in a total is a bug, not silent
+ * conversion.
+ */
+const addAmounts = (a, b) => {
+    if (isZeroAmount(a)) {
+        return { ...b };
+    }
+    if (a.currencyCode !== b.currencyCode ||
+        a.currencySymbol !== b.currencySymbol) {
+        console.warn(`cashManagementOverview: skipping balance with mismatched currency. Expected ${a.currencyCode} (${a.currencySymbol}), got ${b.currencyCode} (${b.currencySymbol}).`);
+        return a;
+    }
+    return {
+        amount: a.amount + b.amount,
+        currencyCode: a.currencyCode,
+        currencySymbol: a.currencySymbol,
+    };
+};
+const sumCashBalances = (paymentAccountIds, paymentAccountState, depositAccountIds, depositAccountState) => {
+    let total = (0, amount_1.zeroAmount)();
+    paymentAccountIds.forEach((id) => {
+        const balance = paymentAccountState.paymentAccountByID[id]?.balances
+            ?.available;
+        if (balance != null) {
+            total = addAmounts(total, balance);
+        }
+    });
+    depositAccountIds.forEach((id) => {
+        const balance = depositAccountState.depositAccountByID[id]?.accountBalance?.available;
+        if (balance != null) {
+            total = addAmounts(total, balance);
+        }
+    });
+    return total;
+};

package/lib/view/spendManagement/cashManagement/cashManagementOverview/cashManagementOverviewState.d.ts

@@ -0,0 +1,21 @@
+import { FetchStateAndError, FetchedState, ID } from '../../../../commonStateTypes/common';
+import { BillStageCodeType } from '../../../../entity/billPay/billTransaction/billTransactionState';
+export interface CashManagementBannerData {
+    placeholder?: never;
+}
+export interface CashManagementBannerState extends FetchStateAndError {
+    data?: CashManagementBannerData;
+}
+export interface UpcomingPaymentEventsListState extends FetchStateAndError {
+    billStages: BillStageCodeType[];
+    eventIds: ID[];
+    horizonDays: number;
+    reimbursementStages: BillStageCodeType[];
+    tenantNamespace?: string;
+}
+export interface CashManagementOverviewState extends FetchedState {
+    banner: CashManagementBannerState;
+    upcomingPaymentEvents: UpcomingPaymentEventsListState;
+}
+export declare const initialCashManagementBannerState: CashManagementBannerState;
+export declare const initialUpcomingPaymentEventsListState: UpcomingPaymentEventsListState;

package/lib/view/spendManagement/cashManagement/cashManagementOverview/cashManagementOverviewState.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initialUpcomingPaymentEventsListState = exports.initialCashManagementBannerState = void 0;
+exports.initialCashManagementBannerState = {
+    fetchState: 'Not-Started',
+    error: undefined,
+    data: undefined,
+};
+exports.initialUpcomingPaymentEventsListState = {
+    fetchState: 'Not-Started',
+    error: undefined,
+    billStages: [],
+    eventIds: [],
+    horizonDays: 0,
+    reimbursementStages: [],
+    tenantNamespace: undefined,
+};

package/lib/view/spendManagement/cashManagement/cashManagementOverview/epics/fetchCashManagementBannerEpic.d.ts

@@ -0,0 +1,5 @@
+import { ActionsObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { fetchCashManagementBanner, updateCashManagementBanner, updateCashManagementBannerFetchStatus } from '../cashManagementOverviewReducer';
+export type ActionType = ReturnType<typeof fetchCashManagementBanner> | ReturnType<typeof updateCashManagementBanner> | ReturnType<typeof updateCashManagementBannerFetchStatus>;
+export declare const fetchCashManagementBannerEpic: (actions$: ActionsObservable<ActionType>) => Observable<ActionType>;

package/lib/view/spendManagement/cashManagement/cashManagementOverview/epics/fetchCashManagementBannerEpic.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchCashManagementBannerEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const cashManagementOverviewReducer_1 = require("../cashManagementOverviewReducer");
+// TODO: replace EMPTY with an actual API call once the banner endpoint is finalized.
+// Figma: https://www.figma.com/design/FUg2pv7edRAidx9X56VnZT/Cash-Management?node-id=2265-63443
+const fetchCashManagementBannerEpic = (actions$) => actions$.pipe((0, operators_1.filter)(cashManagementOverviewReducer_1.fetchCashManagementBanner.match), (0, operators_1.mergeMap)(() => rxjs_1.EMPTY));
+exports.fetchCashManagementBannerEpic = fetchCashManagementBannerEpic;

package/lib/view/spendManagement/cashManagement/cashManagementOverview/epics/fetchCashManagementOverviewPageEpic.d.ts

@@ -0,0 +1,9 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../../../reducer';
+import { fetchAutoTransferRules } from '../../../autotransferRules/autoTransferRulesReducer';
+import { fetchTreasuryOverviewDetail } from '../../../treasury/treasuryList/treasuryDetailReducer';
+import { fetchZeniAccountList } from '../../../zeniAccounts/zeniAccountList/zeniAccountListReducer';
+import { fetchCashManagementBanner, fetchCashManagementOverviewPage, fetchUpcomingPaymentEvents } from '../cashManagementOverviewReducer';
+export type ActionType = ReturnType<typeof fetchCashManagementOverviewPage> | ReturnType<typeof fetchTreasuryOverviewDetail> | ReturnType<typeof fetchZeniAccountList> | ReturnType<typeof fetchUpcomingPaymentEvents> | ReturnType<typeof fetchCashManagementBanner> | ReturnType<typeof fetchAutoTransferRules>;
+export declare const fetchCashManagementOverviewPageEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

package/lib/view/spendManagement/cashManagement/cashManagementOverview/epics/fetchCashManagementOverviewPageEpic.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchCashManagementOverviewPageEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const autoTransferRulesReducer_1 = require("../../../autotransferRules/autoTransferRulesReducer");
+const treasuryDetailReducer_1 = require("../../../treasury/treasuryList/treasuryDetailReducer");
+const zeniAccountListReducer_1 = require("../../../zeniAccounts/zeniAccountList/zeniAccountListReducer");
+const cashManagementOverviewReducer_1 = require("../cashManagementOverviewReducer");
+const fetchCashManagementOverviewPageEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(cashManagementOverviewReducer_1.fetchCashManagementOverviewPage.match), (0, operators_1.mergeMap)((action) => {
+    const { cacheOverride } = action.payload;
+    const state = state$.value;
+    const pageActions = [];
+    if (cacheOverride === true) {
+        pageActions.push((0, treasuryDetailReducer_1.fetchTreasuryOverviewDetail)(true));
+        pageActions.push((0, zeniAccountListReducer_1.fetchZeniAccountList)(true));
+        pageActions.push((0, cashManagementOverviewReducer_1.fetchUpcomingPaymentEvents)());
+        pageActions.push((0, cashManagementOverviewReducer_1.fetchCashManagementBanner)());
+        pageActions.push((0, autoTransferRulesReducer_1.fetchAutoTransferRules)(true));
+    }
+    else {
+        const treasuryDetailState = state.treasuryDetailState;
+        if (treasuryDetailState.hasValidState() === false &&
+            treasuryDetailState.fetchState !== 'In-Progress') {
+            pageActions.push((0, treasuryDetailReducer_1.fetchTreasuryOverviewDetail)(false));
+        }
+        pageActions.push((0, zeniAccountListReducer_1.fetchZeniAccountList)(false));
+        const upcomingEvents = state.cashManagementOverviewState.upcomingPaymentEvents;
+        if (upcomingEvents.fetchState !== 'Completed' &&
+            upcomingEvents.fetchState !== 'In-Progress') {
+            pageActions.push((0, cashManagementOverviewReducer_1.fetchUpcomingPaymentEvents)());
+        }
+        const banner = state.cashManagementOverviewState.banner;
+        if (banner.fetchState !== 'Completed' &&
+            banner.fetchState !== 'In-Progress') {
+            pageActions.push((0, cashManagementOverviewReducer_1.fetchCashManagementBanner)());
+        }
+        const autoTransferRules = state.autotransferRulesState;
+        if (autoTransferRules.fetchState !== 'Completed' &&
+            autoTransferRules.fetchState !== 'In-Progress') {
+            pageActions.push((0, autoTransferRulesReducer_1.fetchAutoTransferRules)(false));
+        }
+    }
+    return (0, rxjs_1.concat)((0, rxjs_1.from)(pageActions));
+}));
+exports.fetchCashManagementOverviewPageEpic = fetchCashManagementOverviewPageEpic;

package/lib/view/spendManagement/cashManagement/cashManagementOverview/epics/fetchUpcomingPaymentEventsEpic.d.ts

@@ -0,0 +1,8 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../../../reducer';
+import { ZeniAPI } from '../../../../../zeniAPI';
+import { updateUpcomingPaymentEvents } from '../../../../../entity/upcomingPaymentEvent/upcomingPaymentEventReducer';
+import { fetchUpcomingPaymentEvents, updateUpcomingPaymentEventsList, updateUpcomingPaymentEventsListFetchStatus } from '../cashManagementOverviewReducer';
+export type ActionType = ReturnType<typeof fetchUpcomingPaymentEvents> | ReturnType<typeof updateUpcomingPaymentEvents> | ReturnType<typeof updateUpcomingPaymentEventsList> | ReturnType<typeof updateUpcomingPaymentEventsListFetchStatus>;
+export declare const fetchUpcomingPaymentEventsEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/spendManagement/cashManagement/cashManagementOverview/epics/fetchUpcomingPaymentEventsEpic.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchUpcomingPaymentEventsEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../../responsePayload");
+const upcomingPaymentEventReducer_1 = require("../../../../../entity/upcomingPaymentEvent/upcomingPaymentEventReducer");
+const cashManagementOverviewReducer_1 = require("../cashManagementOverviewReducer");
+const fetchUpcomingPaymentEventsEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(cashManagementOverviewReducer_1.fetchUpcomingPaymentEvents.match), (0, operators_1.switchMap)(() => zeniAPI
+    .getJSON(
+// TODO: drop /rajat/ once the prod endpoint lands. `${zeniAPI.apiEndPoints.spendManagementMicroServiceBaseUrl}/1.0/upcoming-payment-events`
+`https://dev.api.zeni.ai/version/spend-management/rajat/1.0/upcoming-payment-events`)
+    .pipe((0, operators_1.mergeMap)((response) => {
+    if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+        return (0, rxjs_1.of)((0, upcomingPaymentEventReducer_1.updateUpcomingPaymentEvents)(response.data.events), (0, cashManagementOverviewReducer_1.updateUpcomingPaymentEventsList)({ data: response.data }));
+    }
+    return (0, rxjs_1.of)((0, cashManagementOverviewReducer_1.updateUpcomingPaymentEventsListFetchStatus)({
+        fetchState: 'Error',
+        error: response.status,
+    }));
+}), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, cashManagementOverviewReducer_1.updateUpcomingPaymentEventsListFetchStatus)({
+    fetchState: 'Error',
+    error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch upcoming payment events REST API call errored out' +
+        JSON.stringify(error)),
+}))))));
+exports.fetchUpcomingPaymentEventsEpic = fetchUpcomingPaymentEventsEpic;

package/lib/view/spendManagement/commonHistoryView/commonHistory.d.ts

@@ -11,6 +11,7 @@ export interface HistoricEvent {
     eventSubText: string[];
     eventText: string[];
     updates: HistoricEventUpdate[];
+    paymentTraceId?: string | null;
     timestamp?: ZeniDate;
 }
 export interface HistoricEventUpdate {

package/lib/view/spendManagement/commonHistoryView/commonHistoryPayload.d.ts

@@ -20,6 +20,7 @@ interface HistoricEventMetaDataPayload {
     activity_title: string;
     actor_id: string;
     actor_name: string;
+    payment_trace_id?: string | null;
 }
 export declare const toHistoricEvent: (payload: HistoricEventPayload) => HistoricEvent;
 export type FetchEntityHistoryResponse = ZeniAPIResponse<HistoryPayload>;

package/lib/view/spendManagement/commonHistoryView/commonHistoryPayload.js

@@ -8,6 +8,7 @@ const toHistoricEvent = (payload) => ({
     eventSubText: payload.event_sub_text ?? [],
     timestamp: payload.timestamp != null ? (0, zeniDayJS_1.dateLocal)(payload.timestamp) : undefined,
     updates: payload.updates.map((eventUpdatePayload) => toHistoricEventUpdate(eventUpdatePayload)),
+    paymentTraceId: payload.metadata?.payment_trace_id ?? null,
 });
 exports.toHistoricEvent = toHistoricEvent;
 const toHistoricEventUpdate = (payload) => ({

package/package.json

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