@zeniai/client-epic-state 5.1.7 → 5.1.8

package/lib/view/spendManagement/cashManagement/autoSweepFlow/autoSweepFlowReducer.js

@@ -0,0 +1,82 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearAutoSweepFlow = exports.updateAutoSweepSettingsFetchStatus = exports.saveAutoSweepSettings = exports.updateAutoSweepDraft = exports.updateAutoSweepRisk = exports.updateCashManagementSettingsFetchStatus = exports.updateCashManagementSettings = exports.fetchCashManagementSettings = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const autoSweepFlowPayload_1 = require("./autoSweepFlowPayload");
+const autoSweepFlowState_1 = require("./autoSweepFlowState");
+exports.initialState = autoSweepFlowState_1.initialAutoSweepFlowState;
+const autoSweepFlow = (0, toolkit_1.createSlice)({
+    name: 'autoSweepFlow',
+    initialState: exports.initialState,
+    reducers: {
+        /**
+         * Kicks off `GET /cash-management/settings`. Flips the top-level
+         * fetchState to `In-Progress`; the fetch epic picks this up.
+         */
+        fetchCashManagementSettings(draft) {
+            draft.fetchState = 'In-Progress';
+            draft.error = undefined;
+        },
+        /**
+         * Hydrates the form fields with the server-side settings (and stashes
+         * the settings id for subsequent saves). Marks the GET as `Completed`.
+         */
+        updateCashManagementSettings(draft, action) {
+            const patch = (0, autoSweepFlowPayload_1.toAutoSweepFlowStatePatch)(action.payload.data);
+            draft.bufferAmount = patch.bufferAmount;
+            draft.frequency = patch.frequency;
+            draft.nextTransferDate = patch.nextTransferDate;
+            draft.primaryFundingAccountId = patch.primaryFundingAccountId;
+            draft.settingsId = patch.settingsId;
+            draft.fetchState = 'Completed';
+            draft.error = undefined;
+        },
+        updateCashManagementSettingsFetchStatus(draft, action) {
+            draft.fetchState = action.payload.fetchState;
+            draft.error = action.payload.error;
+        },
+        /**
+         * Live-update the buffer (risk band) as the user toggles the risk picker
+         * on the setup page, without staging frequency/memo. The selector derives
+         * the risk-adjusted sweep amount off `bufferAmount`, so dispatching this on
+         * every risk change keeps the setup and review screens in sync.
+         */
+        updateAutoSweepRisk(draft, action) {
+            draft.bufferAmount = action.payload.bufferAmount;
+        },
+        /**
+         * Stage the in-flight form values without submitting them — fired from
+         * the setup→review transition so other selectors (and devtools) can see
+         * what the user is about to confirm. Leaves `saveStatus` untouched; the
+         * actual PUT only kicks off when the user clicks "Confirm Sweep" via
+         * `saveAutoSweepSettings`.
+         */
+        updateAutoSweepDraft(draft, action) {
+            draft.bufferAmount = action.payload.bufferAmount;
+            draft.frequency = action.payload.frequency;
+            draft.memo = action.payload.memo;
+        },
+        /**
+         * Trigger the PUT for the auto-sweep settings already staged via
+         * `updateAutoSweepDraft`. Carries no payload — flips `saveStatus` to
+         * `In-Progress` and the save epic reads `bufferAmount` / `frequency` /
+         * `memo` straight from the slice. Callers must ensure those fields
+         * reflect the user's latest input before dispatching.
+         */
+        saveAutoSweepSettings(draft) {
+            draft.saveStatus = { fetchState: 'In-Progress', error: undefined };
+        },
+        updateAutoSweepSettingsFetchStatus(draft, action) {
+            draft.saveStatus = {
+                fetchState: action.payload.fetchState,
+                error: action.payload.error,
+            };
+        },
+        clearAutoSweepFlow() {
+            return autoSweepFlowState_1.initialAutoSweepFlowState;
+        },
+    },
+});
+_a = autoSweepFlow.actions, exports.fetchCashManagementSettings = _a.fetchCashManagementSettings, exports.updateCashManagementSettings = _a.updateCashManagementSettings, exports.updateCashManagementSettingsFetchStatus = _a.updateCashManagementSettingsFetchStatus, exports.updateAutoSweepRisk = _a.updateAutoSweepRisk, exports.updateAutoSweepDraft = _a.updateAutoSweepDraft, exports.saveAutoSweepSettings = _a.saveAutoSweepSettings, exports.updateAutoSweepSettingsFetchStatus = _a.updateAutoSweepSettingsFetchStatus, exports.clearAutoSweepFlow = _a.clearAutoSweepFlow;
+exports.default = autoSweepFlow.reducer;

package/lib/view/spendManagement/cashManagement/autoSweepFlow/autoSweepFlowSelector.d.ts

@@ -0,0 +1,40 @@
+import { Amount } from '../../../../commonStateTypes/amount';
+import { FetchStateAndError, ID } from '../../../../commonStateTypes/common';
+import { SelectorView } from '../../../../commonStateTypes/viewAndReport/viewAndReport';
+import { RootState } from '../../../../reducer';
+import { FundingAccount } from '../../commonSetup/setupViewSelector';
+import { TreasurySummaryWithBalance } from '../../treasury/treasuryList/treasuryDetailState';
+import { AutoSweepFrequency, RiskLevel } from './autoSweepFlowState';
+/**
+ * The editable form state behind `<AutoSweepSetupPage>`. Kept as a nested
+ * object on the selector view so the screen can pass it through as a single
+ * unit and the rest of the view (server-derived data + statuses) stays
+ * separate from "what the user is currently editing".
+ */
+export interface AutoSweepFlowFormData {
+    bufferAmount: Amount;
+    frequency: AutoSweepFrequency;
+    memo: string;
+    /** Derived from `bufferAmount` — the matching preset risk level, falling
+     *  back to `'moderate'` for custom server-side values. */
+    risk: RiskLevel;
+}
+export interface AutoSweepFlowSelectorView extends SelectorView {
+    formData: AutoSweepFlowFormData;
+    saveStatus: FetchStateAndError;
+    /**
+     * Recommended sweep amount. Sourced from the cash management banner
+     * (the first money_movements[0].movements[0].amount returned by the
+     * agent's `/recommend` endpoint). Defaults to zero when the agent
+     * hasn't returned a movement yet.
+     */
+    sweepAmount: Amount;
+    /** Resolved from `primaryFundingAccountId` against the deposit-account
+     *  entity bucket. `undefined` until the GET fetch publishes the account. */
+    primaryFundingAccount?: FundingAccount;
+    settingsId?: ID;
+    /** Treasury account summary used by the setup / review flow to render the
+     *  destination column. Mirrors `getTreasuryDetail().accountSummary`. */
+    treasurySummary?: TreasurySummaryWithBalance;
+}
+export declare const getAutoSweepFlow: (state: RootState) => AutoSweepFlowSelectorView;

package/lib/view/spendManagement/cashManagement/autoSweepFlow/autoSweepFlowSelector.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAutoSweepFlow = void 0;
+const depositAccountSelector_1 = require("../../../../entity/depositAccount/depositAccountSelector");
+const setupViewSelector_1 = require("../../commonSetup/setupViewSelector");
+const treasuryDetailSelector_1 = require("../../treasury/treasuryList/treasuryDetailSelector");
+const cashManagementOverviewSelector_1 = require("../cashManagementOverview/cashManagementOverviewSelector");
+const autoSweepFlowState_1 = require("./autoSweepFlowState");
+/**
+ * Risk band the agent's recommended sweep amount is computed against. The
+ * `sweepAmount` returned by the banner assumes this buffer, so the selector
+ * adjusts the displayed sweep by the delta between the user's selected band
+ * and this default.
+ */
+const DEFAULT_RISK_LEVEL = 'moderate';
+const getAutoSweepFlow = (state) => {
+    const { bufferAmount, frequency, memo, saveStatus, settingsId, primaryFundingAccountId, fetchState, error, } = state.autoSweepFlowState;
+    const depositAccount = primaryFundingAccountId != null
+        ? (0, depositAccountSelector_1.getDepositAccountByDepositAccountId)(state.depositAccountState, primaryFundingAccountId)
+        : undefined;
+    const risk = (0, autoSweepFlowState_1.bufferAmountToRisk)(bufferAmount.amount);
+    // The banner's recommended sweep assumes the default buffer band; shift it
+    // by the delta between the default buffer and the user's selected band so a
+    // tighter buffer (higher risk → smaller buffer) sweeps more and a looser
+    // buffer (lower risk → larger buffer) sweeps less. Clamp at zero so a buffer
+    // larger than the available surplus never yields a negative sweep.
+    const baseSweepAmount = (0, cashManagementOverviewSelector_1.getCashManagementOverviewBanner)(state).amount;
+    const sweepAmount = {
+        ...baseSweepAmount,
+        amount: Math.max(0, baseSweepAmount.amount +
+            autoSweepFlowState_1.RISK_BUFFER_AMOUNT[DEFAULT_RISK_LEVEL] -
+            autoSweepFlowState_1.RISK_BUFFER_AMOUNT[risk]),
+    };
+    return {
+        fetchState,
+        error,
+        formData: {
+            bufferAmount,
+            frequency,
+            memo,
+            risk,
+        },
+        primaryFundingAccount: depositAccount != null
+            ? (0, setupViewSelector_1.mapDepositAccToFundingAccount)(depositAccount)
+            : undefined,
+        saveStatus,
+        settingsId,
+        sweepAmount,
+        treasurySummary: (0, treasuryDetailSelector_1.getTreasuryDetail)(state).accountSummary,
+        version: 0,
+    };
+};
+exports.getAutoSweepFlow = getAutoSweepFlow;

package/lib/view/spendManagement/cashManagement/autoSweepFlow/autoSweepFlowState.d.ts

@@ -0,0 +1,37 @@
+import { Amount } from '../../../../commonStateTypes/amount';
+import { FetchStateAndError, ID } from '../../../../commonStateTypes/common';
+import { ZeniDate } from '../../../../zeniDayJS';
+/**
+ * Cadence at which the auto-sweep transfer fires. Lowercase to match the
+ * cash-management settings API contract (and the `SweepFrequency` literal
+ * already used by `<AutoSweepSetupPage>` in web-components).
+ */
+export declare const ALL_AUTO_SWEEP_FREQUENCIES: readonly ["daily", "weekly", "biweekly", "monthly"];
+export declare const toAutoSweepFrequency: (v?: string) => "weekly" | "biweekly" | "monthly" | "daily";
+export type AutoSweepFrequency = NonNullable<ReturnType<typeof toAutoSweepFrequency>>;
+/**
+ * Risk presets the auto-sweep setup form exposes. Each level maps to a
+ * canonical minimum-buffer amount (USD). Selecting a level in the UI is
+ * shorthand for choosing that buffer.
+ */
+export declare const ALL_AUTO_SWEEP_RISK_LEVELS: readonly ["low", "moderate", "high"];
+export declare const toAutoSweepRiskLevel: (v?: string) => "high" | "low" | "moderate";
+export type RiskLevel = NonNullable<ReturnType<typeof toAutoSweepRiskLevel>>;
+export declare const RISK_BUFFER_AMOUNT: Record<RiskLevel, number>;
+/**
+ * Maps a buffer amount back onto the closest preset risk level. Falls back
+ * to `'moderate'` when the amount doesn't match a known preset (e.g. the
+ * server returned a custom value). The dropdown in `<AutoSweepSetupPage>`
+ * uses this so it can pre-select the user's existing band on edit.
+ */
+export declare const bufferAmountToRisk: (amount: number) => RiskLevel;
+export interface AutoSweepFlowState extends FetchStateAndError {
+    bufferAmount: Amount;
+    frequency: AutoSweepFrequency;
+    memo: string;
+    saveStatus: FetchStateAndError;
+    nextTransferDate?: ZeniDate;
+    primaryFundingAccountId?: ID;
+    settingsId?: ID;
+}
+export declare const initialAutoSweepFlowState: AutoSweepFlowState;

package/lib/view/spendManagement/cashManagement/autoSweepFlow/autoSweepFlowState.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initialAutoSweepFlowState = exports.bufferAmountToRisk = exports.RISK_BUFFER_AMOUNT = exports.toAutoSweepRiskLevel = exports.ALL_AUTO_SWEEP_RISK_LEVELS = exports.toAutoSweepFrequency = exports.ALL_AUTO_SWEEP_FREQUENCIES = void 0;
+const amount_1 = require("../../../../commonStateTypes/amount");
+const stringToUnion_1 = require("../../../../commonStateTypes/stringToUnion");
+/**
+ * Cadence at which the auto-sweep transfer fires. Lowercase to match the
+ * cash-management settings API contract (and the `SweepFrequency` literal
+ * already used by `<AutoSweepSetupPage>` in web-components).
+ */
+exports.ALL_AUTO_SWEEP_FREQUENCIES = [
+    'daily',
+    'weekly',
+    'biweekly',
+    'monthly',
+];
+const toAutoSweepFrequency = (v) => (0, stringToUnion_1.stringToUnion)(v ?? '', exports.ALL_AUTO_SWEEP_FREQUENCIES);
+exports.toAutoSweepFrequency = toAutoSweepFrequency;
+/**
+ * Risk presets the auto-sweep setup form exposes. Each level maps to a
+ * canonical minimum-buffer amount (USD). Selecting a level in the UI is
+ * shorthand for choosing that buffer.
+ */
+exports.ALL_AUTO_SWEEP_RISK_LEVELS = ['low', 'moderate', 'high'];
+const toAutoSweepRiskLevel = (v) => (0, stringToUnion_1.stringToUnion)(v ?? '', exports.ALL_AUTO_SWEEP_RISK_LEVELS);
+exports.toAutoSweepRiskLevel = toAutoSweepRiskLevel;
+exports.RISK_BUFFER_AMOUNT = {
+    low: 15000,
+    moderate: 10000,
+    high: 5000,
+};
+/**
+ * Maps a buffer amount back onto the closest preset risk level. Falls back
+ * to `'moderate'` when the amount doesn't match a known preset (e.g. the
+ * server returned a custom value). The dropdown in `<AutoSweepSetupPage>`
+ * uses this so it can pre-select the user's existing band on edit.
+ */
+const bufferAmountToRisk = (amount) => {
+    const match = Object.entries(exports.RISK_BUFFER_AMOUNT).find(([, presetAmount]) => presetAmount === amount);
+    return match != null ? match[0] : 'moderate';
+};
+exports.bufferAmountToRisk = bufferAmountToRisk;
+exports.initialAutoSweepFlowState = {
+    bufferAmount: (0, amount_1.toAmount)(10000, 'USD', '$'),
+    frequency: 'weekly',
+    memo: '',
+    saveStatus: { fetchState: 'Not-Started', error: undefined },
+    nextTransferDate: undefined,
+    primaryFundingAccountId: undefined,
+    settingsId: undefined,
+    fetchState: 'Not-Started',
+    error: undefined,
+};

package/lib/view/spendManagement/cashManagement/autoSweepFlow/epics/fetchCashManagementSettingsEpic.d.ts

@@ -0,0 +1,14 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateDepositAccounts } from '../../../../../entity/depositAccount/depositAccountReducer';
+import { RootState } from '../../../../../reducer';
+import { ZeniAPI } from '../../../../../zeniAPI';
+import { fetchCashManagementSettings, updateCashManagementSettings, updateCashManagementSettingsFetchStatus } from '../autoSweepFlowReducer';
+export type ActionType = ReturnType<typeof fetchCashManagementSettings> | ReturnType<typeof updateCashManagementSettings> | ReturnType<typeof updateCashManagementSettingsFetchStatus> | ReturnType<typeof updateDepositAccounts>;
+/**
+ * Hits `GET /cash-management/settings` and hydrates the auto-sweep slice
+ * with the server's existing settings (frequency, minimum buffer, settings
+ * id). Called from the cash management overview page-fetch epic alongside
+ * the other top-level fetches.
+ */
+export declare const fetchCashManagementSettingsEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/spendManagement/cashManagement/autoSweepFlow/epics/fetchCashManagementSettingsEpic.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchCashManagementSettingsEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const depositAccountReducer_1 = require("../../../../../entity/depositAccount/depositAccountReducer");
+const responsePayload_1 = require("../../../../../responsePayload");
+const autoSweepFlowReducer_1 = require("../autoSweepFlowReducer");
+/**
+ * Hits `GET /cash-management/settings` and hydrates the auto-sweep slice
+ * with the server's existing settings (frequency, minimum buffer, settings
+ * id). Called from the cash management overview page-fetch epic alongside
+ * the other top-level fetches.
+ */
+const fetchCashManagementSettingsEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(autoSweepFlowReducer_1.fetchCashManagementSettings.match), (0, operators_1.switchMap)(() => {
+    const endpoint = `${zeniAPI.apiEndPoints.cashManagementAgentBaseUrl}/1.0/cash-management/settings`;
+    return zeniAPI.getJSON(endpoint).pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return (0, rxjs_1.of)(
+            // Publish the source deposit account into the shared entity
+            // bucket so the selector can hydrate the full `FundingAccount`
+            // from `getDepositAccountByDepositAccountId` rather than the
+            // auto-sweep slice holding a duplicate copy.
+            (0, depositAccountReducer_1.updateDepositAccounts)([response.data.source_bank_account]), (0, autoSweepFlowReducer_1.updateCashManagementSettings)({ data: response.data }));
+        }
+        return (0, rxjs_1.of)((0, autoSweepFlowReducer_1.updateCashManagementSettingsFetchStatus)({
+            fetchState: 'Error',
+            error: response.status,
+        }));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, autoSweepFlowReducer_1.updateCashManagementSettingsFetchStatus)({
+        fetchState: 'Error',
+        error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch cash management settings REST API call errored out: ' +
+            (error?.message ?? String(error))),
+    }))));
+}));
+exports.fetchCashManagementSettingsEpic = fetchCashManagementSettingsEpic;

package/lib/view/spendManagement/cashManagement/autoSweepFlow/epics/saveAutoSweepSettingsEpic.d.ts

@@ -0,0 +1,7 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../../../reducer';
+import { ZeniAPI } from '../../../../../zeniAPI';
+import { saveAutoSweepSettings, updateAutoSweepSettingsFetchStatus } from '../autoSweepFlowReducer';
+export type ActionType = ReturnType<typeof saveAutoSweepSettings> | ReturnType<typeof updateAutoSweepSettingsFetchStatus>;
+export declare const saveAutoSweepSettingsEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/spendManagement/cashManagement/autoSweepFlow/epics/saveAutoSweepSettingsEpic.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveAutoSweepSettingsEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../../responsePayload");
+const autoSweepFlowPayload_1 = require("../autoSweepFlowPayload");
+const autoSweepFlowReducer_1 = require("../autoSweepFlowReducer");
+const saveAutoSweepSettingsEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(autoSweepFlowReducer_1.saveAutoSweepSettings.match), (0, operators_1.switchMap)(() => {
+    const endpoint = `${zeniAPI.apiEndPoints.cashManagementAgentBaseUrl}/1.0/cash-management/settings`;
+    const { bufferAmount, frequency, memo, settingsId } = state$.value.autoSweepFlowState;
+    const payload = (0, autoSweepFlowPayload_1.toSaveAutoSweepSettingsBody)({
+        bufferAmount,
+        frequency,
+        memo,
+    });
+    // First-time setup (no settings id from the GET yet) → POST a new
+    // record. Subsequent edits update the existing one via PUT.
+    const request$ = settingsId == null
+        ? zeniAPI.postAndGetJSON(endpoint, payload)
+        : zeniAPI.putAndGetJSON(endpoint, payload);
+    return request$.pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return (0, rxjs_1.of)((0, autoSweepFlowReducer_1.updateAutoSweepSettingsFetchStatus)({ fetchState: 'Completed' }));
+        }
+        return (0, rxjs_1.of)((0, autoSweepFlowReducer_1.updateAutoSweepSettingsFetchStatus)({
+            fetchState: 'Error',
+            error: response?.status,
+        }));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, autoSweepFlowReducer_1.updateAutoSweepSettingsFetchStatus)({
+        fetchState: 'Error',
+        error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Save auto-sweep settings REST API call errored out: ' +
+            (error?.message ?? String(error))),
+    }))));
+}));
+exports.saveAutoSweepSettingsEpic = saveAutoSweepSettingsEpic;

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

@@ -0,0 +1,56 @@
+import { ZeniAPIResponse } from '../../../../responsePayload';
+import { CashManagementBankAccountType, CashManagementBannerData, CashManagementScenario, CashManagementSubMovementType, CashManagementTransfer, CashManagementTransferStatus, UpcomingPaymentEvent, UpcomingPaymentEventAccountType } from './cashManagementOverviewState';
+export interface CashAgentEventPayload {
+    account_id: string;
+    account_type: UpcomingPaymentEventAccountType;
+    amount_usd: number;
+    currency_code: string;
+    label: string;
+    payment_date: string;
+}
+export interface CashAgentMovementPayload {
+    amount: number;
+    currency_code: string;
+    destination_bank_account_id: string | null;
+    destination_bank_account_type: CashManagementBankAccountType;
+    reasoning: string;
+    source_bank_account_id: string | null;
+    source_bank_account_type: CashManagementBankAccountType;
+    sub_movement_type: CashManagementSubMovementType;
+}
+export interface CashAgentMoneyMovementGroupPayload {
+    movement_type: string;
+    movements: CashAgentMovementPayload[];
+}
+export interface CashAgentRecommendPayload {
+    inflows: CashAgentEventPayload[];
+    money_movements: CashAgentMoneyMovementGroupPayload[];
+    outflows: CashAgentEventPayload[];
+}
+export type CashAgentRecommendResponse = ZeniAPIResponse<CashAgentRecommendPayload>;
+export declare const toUpcomingPaymentEvent: (event: CashAgentEventPayload) => UpcomingPaymentEvent;
+export declare const toCashManagementBannerData: (payload: CashAgentRecommendPayload) => CashManagementBannerData;
+export interface CashAgentTransferPayload {
+    amount: number;
+    atomic_transaction_id: string;
+    cash_management_transfer_id: string;
+    create_time: string;
+    currency_code: string;
+    date: string;
+    deposit_account_id: string;
+    reasoning: string;
+    scenario: CashManagementScenario;
+    status: CashManagementTransferStatus;
+    transaction_type: CashManagementSubMovementType;
+    update_time: string;
+}
+/**
+ * Response shape for `GET /cash-management/transfers`. The agent currently
+ * returns the single most-relevant transfer under `transfer`; the field is
+ * optional because fresh users (no settings yet) have no transfer history.
+ */
+export interface CashAgentRecentTransferData {
+    transfer?: CashAgentTransferPayload;
+}
+export type CashAgentRecentTransferResponse = ZeniAPIResponse<CashAgentRecentTransferData>;
+export declare const toCashManagementTransfer: (payload: CashAgentTransferPayload) => CashManagementTransfer;

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCashManagementTransfer = exports.toCashManagementBannerData = exports.toUpcomingPaymentEvent = void 0;
+const amount_1 = require("../../../../commonStateTypes/amount");
+const zeniDayJS_1 = require("../../../../zeniDayJS");
+// ---------------------------------------------------------------------------
+// Converters
+// ---------------------------------------------------------------------------
+// The cash agent payload reports `currency_code` only; the v1 surface is
+// USD-only, so we pair it with the canonical `$` symbol here. If the agent
+// grows multi-currency support, this is the single place to widen.
+const CASH_AGENT_CURRENCY_SYMBOL = '$';
+const toUpcomingPaymentEvent = (event) => ({
+    accountId: event.account_id,
+    accountType: event.account_type,
+    amount: (0, amount_1.toAmount)(event.amount_usd, event.currency_code, CASH_AGENT_CURRENCY_SYMBOL),
+    label: event.label,
+    paymentDate: (0, zeniDayJS_1.date)(event.payment_date),
+});
+exports.toUpcomingPaymentEvent = toUpcomingPaymentEvent;
+/**
+ * The agent reports a `null` account id whenever the "account" in question is
+ * a singleton inferred from the account type (today: the treasury account —
+ * there's only one per company, so the type alone identifies it). Callers
+ * already branch on `*BankAccountType`, so collapsing the id to `""` keeps the
+ * state type a plain `ID` (string) without losing information.
+ */
+const toCashManagementMovement = (payload) => ({
+    amount: (0, amount_1.toAmount)(payload.amount, payload.currency_code, CASH_AGENT_CURRENCY_SYMBOL),
+    destinationBankAccountId: payload.destination_bank_account_id ?? '',
+    destinationBankAccountType: payload.destination_bank_account_type,
+    reasoning: payload.reasoning,
+    sourceBankAccountId: payload.source_bank_account_id ?? '',
+    sourceBankAccountType: payload.source_bank_account_type,
+    subMovementType: payload.sub_movement_type,
+});
+const toCashManagementMoneyMovementGroup = (payload) => ({
+    movements: payload.movements.map(toCashManagementMovement),
+    movementType: payload.movement_type,
+});
+const toCashManagementBannerData = (payload) => ({
+    inflows: payload.inflows.map(exports.toUpcomingPaymentEvent),
+    moneyMovements: payload.money_movements.map(toCashManagementMoneyMovementGroup),
+    outflows: payload.outflows.map(exports.toUpcomingPaymentEvent),
+});
+exports.toCashManagementBannerData = toCashManagementBannerData;
+const toCashManagementTransfer = (payload) => ({
+    amount: (0, amount_1.toAmount)(payload.amount, payload.currency_code, CASH_AGENT_CURRENCY_SYMBOL),
+    atomicTransactionId: payload.atomic_transaction_id,
+    cashManagementTransferId: payload.cash_management_transfer_id,
+    createTime: (0, zeniDayJS_1.date)(payload.create_time),
+    date: (0, zeniDayJS_1.date)(payload.date),
+    depositAccountId: payload.deposit_account_id,
+    reasoning: payload.reasoning,
+    scenario: payload.scenario,
+    status: payload.status,
+    transactionType: payload.transaction_type,
+    updateTime: (0, zeniDayJS_1.date)(payload.update_time),
+});
+exports.toCashManagementTransfer = toCashManagementTransfer;

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

@@ -0,0 +1,22 @@
+import { FetchState } from '../../../../commonStateTypes/common';
+import { ZeniAPIStatus } from '../../../../responsePayload';
+import { CashAgentRecommendPayload, CashAgentTransferPayload } from './cashManagementOverviewPayload';
+import { CashManagementOverviewState } from './cashManagementOverviewState';
+export declare const initialState: CashManagementOverviewState;
+export declare const fetchCashManagementOverviewPage: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[cacheOverride: boolean], {
+    cacheOverride: boolean;
+}, "cashManagementOverview/fetchCashManagementOverviewPage", never, never>, fetchCashManagementBanner: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[cacheOverride: boolean], {
+    cacheOverride: boolean;
+}, "cashManagementOverview/fetchCashManagementBanner", never, never>, fetchCashManagementRecommendation: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"cashManagementOverview/fetchCashManagementRecommendation">, updateCashManagementRecommendation: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    data: CashAgentRecommendPayload;
+}, "cashManagementOverview/updateCashManagementRecommendation">, updateCashManagementRecommendationFetchStatus: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    fetchState: FetchState;
+    error?: ZeniAPIStatus;
+}, "cashManagementOverview/updateCashManagementRecommendationFetchStatus">, fetchRecentTransfer: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"cashManagementOverview/fetchRecentTransfer">, updateRecentTransfer: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    data?: CashAgentTransferPayload;
+}, "cashManagementOverview/updateRecentTransfer">, updateRecentTransferFetchStatus: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    fetchState: FetchState;
+    error?: ZeniAPIStatus;
+}, "cashManagementOverview/updateRecentTransferFetchStatus">, clearCashManagementOverview: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"cashManagementOverview/clearCashManagementOverview">;
+declare const _default: import("redux").Reducer<CashManagementOverviewState>;
+export default _default;

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

@@ -0,0 +1,96 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearCashManagementOverview = exports.updateRecentTransferFetchStatus = exports.updateRecentTransfer = exports.fetchRecentTransfer = exports.updateCashManagementRecommendationFetchStatus = exports.updateCashManagementRecommendation = exports.fetchCashManagementRecommendation = exports.fetchCashManagementBanner = exports.fetchCashManagementOverviewPage = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const cashManagementOverviewPayload_1 = require("./cashManagementOverviewPayload");
+const cashManagementOverviewState_1 = require("./cashManagementOverviewState");
+exports.initialState = {
+    banner: cashManagementOverviewState_1.initialCashManagementBannerState,
+    recentTransfer: cashManagementOverviewState_1.initialCashManagementRecentTransferState,
+};
+const cashManagementOverview = (0, toolkit_1.createSlice)({
+    name: 'cashManagementOverview',
+    initialState: exports.initialState,
+    reducers: {
+        fetchCashManagementOverviewPage: {
+            reducer() { },
+            prepare(cacheOverride) {
+                return { payload: { cacheOverride } };
+            },
+        },
+        /**
+         * Public banner-fetch entry point. Triggers an orchestrator epic that
+         * fans out to the recommend, settings, and recent-transfer API calls
+         * in parallel. No reducer-side state change — each inner action drives
+         * its own sub-state.
+         *
+         * `cacheOverride === true` forces all three inner fetches regardless
+         * of current slice state; `false` keeps the per-slice dedup so repeat
+         * dispatches are no-ops once a slice is loaded or in-flight.
+         */
+        fetchCashManagementBanner: {
+            reducer() { },
+            prepare(cacheOverride) {
+                return { payload: { cacheOverride } };
+            },
+        },
+        /**
+         * Internal trigger for the recommend API (`/cash-agent/recommend`).
+         * Dispatched by the orchestrator; not exported.
+         */
+        fetchCashManagementRecommendation(draft) {
+            // Keep `draft.banner.data` so the projection chart renders the last
+            // good payload while the refetch is in flight, instead of flickering
+            // to the empty/skeleton state on every page revisit.
+            draft.banner.fetchState = 'In-Progress';
+            draft.banner.error = undefined;
+        },
+        updateCashManagementRecommendation(draft, action) {
+            draft.banner = {
+                fetchState: 'Completed',
+                error: undefined,
+                data: (0, cashManagementOverviewPayload_1.toCashManagementBannerData)(action.payload.data),
+            };
+        },
+        updateCashManagementRecommendationFetchStatus(draft, action) {
+            draft.banner = {
+                ...draft.banner,
+                fetchState: action.payload.fetchState,
+                error: action.payload.error,
+            };
+        },
+        /**
+         * Internal trigger for the recent-transfer API
+         * (`/cash-management/transfers`). Dispatched by the orchestrator; not
+         * exported.
+         */
+        fetchRecentTransfer(draft) {
+            // Same anti-flicker pattern as the recommend fetch: keep prior data
+            // while the refetch is in flight.
+            draft.recentTransfer.fetchState = 'In-Progress';
+            draft.recentTransfer.error = undefined;
+        },
+        updateRecentTransfer(draft, action) {
+            draft.recentTransfer = {
+                fetchState: 'Completed',
+                error: undefined,
+                data: action.payload.data != null
+                    ? (0, cashManagementOverviewPayload_1.toCashManagementTransfer)(action.payload.data)
+                    : undefined,
+            };
+        },
+        updateRecentTransferFetchStatus(draft, action) {
+            draft.recentTransfer = {
+                ...draft.recentTransfer,
+                fetchState: action.payload.fetchState,
+                error: action.payload.error,
+            };
+        },
+        clearCashManagementOverview(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = cashManagementOverview.actions, exports.fetchCashManagementOverviewPage = _a.fetchCashManagementOverviewPage, exports.fetchCashManagementBanner = _a.fetchCashManagementBanner, exports.fetchCashManagementRecommendation = _a.fetchCashManagementRecommendation, exports.updateCashManagementRecommendation = _a.updateCashManagementRecommendation, exports.updateCashManagementRecommendationFetchStatus = _a.updateCashManagementRecommendationFetchStatus, exports.fetchRecentTransfer = _a.fetchRecentTransfer, exports.updateRecentTransfer = _a.updateRecentTransfer, exports.updateRecentTransferFetchStatus = _a.updateRecentTransferFetchStatus, exports.clearCashManagementOverview = _a.clearCashManagementOverview;
+exports.default = cashManagementOverview.reducer;