@zeniai/client-epic-state 4.7.99 → 4.8.0

package/lib/view/scheduleView/scheduleListView/scheduleListHelper.d.ts

@@ -0,0 +1,70 @@
+import { NestedAccountHeirarchyForReport } from '../../../commonStateTypes/accountView/nestedAccountID';
+import { Amount } from '../../../commonStateTypes/amount';
+import { COABalance, COABalanceGroupedByPeriod } from '../../../commonStateTypes/coaBalance/coaBalance';
+import { TimeframeTickWithMetaData } from '../../../commonStateTypes/timeframeTick';
+import { AccountBase } from '../../../entity/account/accountState';
+import { JEScheduledTransaction, ScheduledJournalEntry } from '../../../entity/jeSchedules/jeSchedulesSelector';
+import { SchedulesTypes } from '../../../entity/jeSchedules/jeSchedulesTypes';
+import { JEScheduledTransactionWithBalance } from './scheduleListSelector';
+export declare type TimeframeTickBalances = Record<string, COABalance[]>;
+export interface ScheduleTotalType {
+    totalAmount: Amount;
+    totalRunningBalances: Amount;
+}
+/**
+ * This helper function calculates Total Amount and Total Running balances
+ * for all the JE transactions which can be used to display the totals on the Schedule List page.
+ * @param jeTransactions
+ * @returns
+ */
+export declare const getCalculatedScheduleTotals: (jeTransactions: JEScheduledTransaction[]) => ScheduleTotalType;
+export declare const getAccountListKeyForSchedulesTab: (scheduleTab: SchedulesTypes) => "accountList" | "prepaidExpenseAccountList";
+export declare const getAllAccountBase: () => AccountBase;
+export declare const getAllAccountNested: () => NestedAccountHeirarchyForReport;
+/**
+ * This helper function is to get all possible timeframe
+ * Logic --> Timeframe Range is startDate = (currentDate to 3 months back )and endDate = (currentDate to 9 months ahead)
+ * @param sortedJETransactionView
+ * @param startMonth
+ * @returns
+ */
+export declare const getAllTimeframeTicks: (sortedJETransactionView: JEScheduledTransaction[], startMonth: number) => TimeframeTickWithMetaData[];
+/**
+ * This is a helper function to map totalBalanceTimeframeTicks to COABalance
+ * @param totalBalanceTimeframeTicks
+ * @returns
+ */
+export declare const mapTotalBalanceTimeframeTickToCOAGroupedBalance: (totalBalanceTimeframeTicks: TimeframeTickBalances) => COABalance[];
+/**
+ * This function setting default values in the totalBalanceTimeframeTicks using allTimeframeTicks
+ * e.g {'Feb 2023' : [], 'Mar 2023' : [], 'Apr 2023' : [], 'Jun 2023' : [], 'Jun 2023' : [], 'Jul 2023' : []}
+ *
+ * @param allTimeframeTicks
+ * @returns
+ */
+export declare const setDefaultTotalBalanceTimeframeTicks: (allTimeframeTicks: TimeframeTickWithMetaData[]) => TimeframeTickBalances;
+/**
+ * This function returns an COABalanceGroupedByPeriod (months, weeks, years, quarters) with an array of COABalances
+ * in which we loop over the totalBalanceTimeframeTicks which is a record of <Labels(mm yy), Balances>- {'Feb 2023' : [20, 30, 40]}
+ * e.g - { months : { balance, startDate, endDate, type}}
+ * @param allTimeframeTickBalances
+ * @param allTimeframeTicks
+ * @param timeframe
+ * @returns
+ */
+export declare const calculateTotalBalanceTimeframeTick: (allTimeframeTickBalances: JEScheduledTransactionWithBalance[], allTimeframeTicks: TimeframeTickWithMetaData[], timeframe: 'months') => COABalanceGroupedByPeriod;
+/**
+ * This is a helper function just to map COABalance for every ScheduledJournalEntry
+ * @param scheduleJournal
+ * @param currencyCode
+ * @param currencySymbol
+ * @param timeframe
+ * @returns
+ */
+export declare const mapScheduleJournalToCOABalance: (scheduleJournal: ScheduledJournalEntry, currencyCode: string, currencySymbol: string, timeframe: 'month') => COABalance;
+/**
+ * This function helps us in finding COABalanceGroupedByPeriod for months
+ * @param jeSchedule
+ * @returns
+ */
+export declare const calculateCOABalanceGroupedByPeriod: (jeSchedule: JEScheduledTransaction) => COABalanceGroupedByPeriod;

package/lib/view/scheduleView/scheduleListView/scheduleListHelper.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calculateCOABalanceGroupedByPeriod = exports.mapScheduleJournalToCOABalance = exports.calculateTotalBalanceTimeframeTick = exports.setDefaultTotalBalanceTimeframeTicks = exports.mapTotalBalanceTimeframeTickToCOAGroupedBalance = exports.getAllTimeframeTicks = exports.getAllAccountNested = exports.getAllAccountBase = exports.getAccountListKeyForSchedulesTab = exports.getCalculatedScheduleTotals = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const formatZeniDateFY_1 = require("../../../commonStateTypes/fiscalYearHelpers/formatZeniDateFY");
+const getFYMonths_1 = require("../../../commonStateTypes/fiscalYearHelpers/getFYMonths");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+/**
+ * This helper function calculates Total Amount and Total Running balances
+ * for all the JE transactions which can be used to display the totals on the Schedule List page.
+ * @param jeTransactions
+ * @returns
+ */
+const getCalculatedScheduleTotals = (jeTransactions) => {
+    if (jeTransactions.length == 0) {
+        return {
+            totalAmount: (0, amount_1.toAmount)(0, '', ''),
+            totalRunningBalances: (0, amount_1.toAmount)(0, '', ''),
+        };
+    }
+    const totalAmountSum = jeTransactions.reduce((sum, schedule) => {
+        return sum + schedule.baseTransaction.amount.amount;
+    }, 0);
+    const totalRunningBalanceSum = jeTransactions.reduce((sum, schedule) => {
+        return (sum +
+            (schedule.balanceAsOfToday != null ? schedule.balanceAsOfToday.amount : 0));
+    }, 0);
+    return {
+        totalAmount: Object.assign(Object.assign({}, jeTransactions[0].baseTransaction.amount), { amount: totalAmountSum }),
+        totalRunningBalances: Object.assign(Object.assign({}, jeTransactions[0].baseTransaction.amount), { amount: totalRunningBalanceSum }),
+    };
+};
+exports.getCalculatedScheduleTotals = getCalculatedScheduleTotals;
+const getAccountListKeyForSchedulesTab = (scheduleTab) => {
+    switch (scheduleTab) {
+        case 'prepaid_expenses':
+            return 'prepaidExpenseAccountList';
+        case 'accured_expenses':
+        case 'deferred_revenue':
+        case 'fixed_assets':
+            return 'accountList';
+    }
+};
+exports.getAccountListKeyForSchedulesTab = getAccountListKeyForSchedulesTab;
+const getAllAccountBase = () => ({
+    accountDescription: 'All',
+    accountId: 'all',
+    qboId: 'all',
+    accountName: 'All',
+    labels: [],
+});
+exports.getAllAccountBase = getAllAccountBase;
+const getAllAccountNested = () => ({
+    accountId: ['all'],
+    accountName: 'All',
+    qboId: 'all',
+    children: [],
+    hasSiblings: false,
+});
+exports.getAllAccountNested = getAllAccountNested;
+/**
+ * This helper function is to get all possible timeframe
+ * Logic --> Timeframe Range is startDate = (currentDate to 3 months back )and endDate = (currentDate to 9 months ahead)
+ * @param sortedJETransactionView
+ * @param startMonth
+ * @returns
+ */
+const getAllTimeframeTicks = (sortedJETransactionView, startMonth) => {
+    const tickLabel = [];
+    if (sortedJETransactionView.length > 0) {
+        const jeTransaction = sortedJETransactionView[0];
+        const { currencySymbol } = jeTransaction;
+        const start = (0, zeniDayJS_1.dateNow)().startOf('month').subtract(startMonth, 'month');
+        let months = 0;
+        while (months < getFYMonths_1.NUM_OF_MONTHS_IN_YEAR) {
+            tickLabel.push({
+                startDate: start.add(months, 'month'),
+                endDate: start.add(months, 'month').endOf('month'),
+                currencySymbol: currencySymbol,
+                balanceType: 'default',
+            });
+            months++;
+        }
+    }
+    return tickLabel;
+};
+exports.getAllTimeframeTicks = getAllTimeframeTicks;
+/**
+ * This is a helper function to map totalBalanceTimeframeTicks to COABalance
+ * @param totalBalanceTimeframeTicks
+ * @returns
+ */
+const mapTotalBalanceTimeframeTickToCOAGroupedBalance = (totalBalanceTimeframeTicks) => {
+    const coaBalanceTotalByTimeframe = [];
+    Object.keys(totalBalanceTimeframeTicks).map((timeframeLabel) => {
+        const coaBalance = totalBalanceTimeframeTicks[timeframeLabel];
+        if (coaBalance.length > 0) {
+            const totalCOABalance = Object.assign(Object.assign({}, coaBalance[0]), { balance: Object.assign(Object.assign({}, coaBalance[0].balance), { amount: 0 }) });
+            const calculatedCOABalance = coaBalance.reduce((prev, curr) => {
+                return Object.assign(Object.assign({}, curr), { balance: (0, amount_1.toAmount)(prev.balance.amount + curr.balance.amount, curr.balance.currencyCode, curr.balance.currencySymbol) });
+            }, totalCOABalance);
+            coaBalanceTotalByTimeframe.push(calculatedCOABalance);
+        }
+    });
+    return coaBalanceTotalByTimeframe;
+};
+exports.mapTotalBalanceTimeframeTickToCOAGroupedBalance = mapTotalBalanceTimeframeTickToCOAGroupedBalance;
+/**
+ * This function setting default values in the totalBalanceTimeframeTicks using allTimeframeTicks
+ * e.g {'Feb 2023' : [], 'Mar 2023' : [], 'Apr 2023' : [], 'Jun 2023' : [], 'Jun 2023' : [], 'Jul 2023' : []}
+ *
+ * @param allTimeframeTicks
+ * @returns
+ */
+const setDefaultTotalBalanceTimeframeTicks = (allTimeframeTicks) => {
+    const totalBalanceTimeframeTicks = {};
+    allTimeframeTicks.map((timeframe) => {
+        totalBalanceTimeframeTicks[timeframe.startDate.format(formatZeniDateFY_1.MONTH_YEAR_FORMAT)] =
+            [];
+    });
+    return totalBalanceTimeframeTicks;
+};
+exports.setDefaultTotalBalanceTimeframeTicks = setDefaultTotalBalanceTimeframeTicks;
+/**
+ * This function returns an COABalanceGroupedByPeriod (months, weeks, years, quarters) with an array of COABalances
+ * in which we loop over the totalBalanceTimeframeTicks which is a record of <Labels(mm yy), Balances>- {'Feb 2023' : [20, 30, 40]}
+ * e.g - { months : { balance, startDate, endDate, type}}
+ * @param allTimeframeTickBalances
+ * @param allTimeframeTicks
+ * @param timeframe
+ * @returns
+ */
+const calculateTotalBalanceTimeframeTick = (allTimeframeTickBalances, allTimeframeTicks, timeframe) => {
+    const totalBalanceTimeframeTicks = (0, exports.setDefaultTotalBalanceTimeframeTicks)(allTimeframeTicks);
+    allTimeframeTickBalances.forEach((jeScheduleKey) => {
+        const coaBalanceByPeriodByTimeframe = jeScheduleKey.coaBalanceByPeriod[timeframe];
+        if (coaBalanceByPeriodByTimeframe != null) {
+            coaBalanceByPeriodByTimeframe.map((coaBalancePeriod) => {
+                if (coaBalancePeriod.label != null &&
+                    totalBalanceTimeframeTicks[coaBalancePeriod.label] != null) {
+                    totalBalanceTimeframeTicks[coaBalancePeriod.label].push(coaBalancePeriod);
+                }
+            });
+        }
+    });
+    const coaBalanceGrouped = (0, exports.mapTotalBalanceTimeframeTickToCOAGroupedBalance)(totalBalanceTimeframeTicks);
+    return {
+        months: coaBalanceGrouped,
+    };
+};
+exports.calculateTotalBalanceTimeframeTick = calculateTotalBalanceTimeframeTick;
+/**
+ * This is a helper function just to map COABalance for every ScheduledJournalEntry
+ * @param scheduleJournal
+ * @param currencyCode
+ * @param currencySymbol
+ * @param timeframe
+ * @returns
+ */
+const mapScheduleJournalToCOABalance = (scheduleJournal, currencyCode, currencySymbol, timeframe) => {
+    var _a, _b, _c, _d, _e, _f;
+    const startDate = scheduleJournal.expectedPostDate.startOf('month');
+    const endDate = scheduleJournal.expectedPostDate.endOf('month');
+    const label = startDate.format(formatZeniDateFY_1.MONTH_YEAR_FORMAT);
+    return {
+        balance: (0, amount_1.toAmount)((_b = (_a = scheduleJournal.amount) === null || _a === void 0 ? void 0 : _a.amount) !== null && _b !== void 0 ? _b : 0, (_d = (_c = scheduleJournal.amount) === null || _c === void 0 ? void 0 : _c.currencyCode) !== null && _d !== void 0 ? _d : currencyCode, (_f = (_e = scheduleJournal.amount) === null || _e === void 0 ? void 0 : _e.currencySymbol) !== null && _f !== void 0 ? _f : currencySymbol),
+        balanceTimeFrame: timeframe,
+        type: 'default',
+        startDate,
+        endDate,
+        label,
+    };
+};
+exports.mapScheduleJournalToCOABalance = mapScheduleJournalToCOABalance;
+/**
+ * This function helps us in finding COABalanceGroupedByPeriod for months
+ * @param jeSchedule
+ * @returns
+ */
+const calculateCOABalanceGroupedByPeriod = (jeSchedule) => {
+    const scheduleJournalEntry = jeSchedule.scheduledJournalEntry;
+    const { currencyCode, currencySymbol } = jeSchedule;
+    return {
+        months: scheduleJournalEntry.map((scheduleJournal) => (0, exports.mapScheduleJournalToCOABalance)(scheduleJournal, currencyCode, currencySymbol, 'month')),
+    };
+};
+exports.calculateCOABalanceGroupedByPeriod = calculateCOABalanceGroupedByPeriod;

package/lib/view/scheduleView/scheduleListView/scheduleListPayload.d.ts

@@ -0,0 +1,7 @@
+import { JEScheduledTransactionPayload, ScheduledJournalEntryPayload } from '../../../entity/jeSchedules/jeSchedulesPayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+export interface ScheduleListPayload {
+    je_schedules: JEScheduledTransactionPayload[];
+    scheduled_journal_entries?: ScheduledJournalEntryPayload[];
+}
+export declare type FetchScheduleListResponse = ZeniAPIResponse<ScheduleListPayload>;

package/lib/view/scheduleView/scheduleListView/scheduleListPayload.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/view/scheduleView/scheduleListView/scheduleListReducer.d.ts

@@ -0,0 +1,55 @@
+import { ScheduleListLocalData, ScheduleListViewState, ScheduleWithListStatus, ScheduleListUIState } from './scheduleListState';
+import { FetchState, ID } from '../../../commonStateTypes/common';
+import { TimeframeTick } from '../../../commonStateTypes/timeframeTick';
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { JEScheduledTransactionPayload } from '../../../entity/jeSchedules/jeSchedulesPayload';
+export declare const initialState: ScheduleListViewState;
+export declare const scheduleListInitialState: ScheduleWithListStatus;
+export declare const fetchDownloadSchedules: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue", timeframeAndCategory: {
+    selectedTimeframe: TimeframeTick;
+    selectedCategoryId: ID;
+}, downloadCategories: string[], cacheOverride?: any], {
+    timeframeAndCategory: {
+        selectedTimeframe: TimeframeTick;
+        selectedCategoryId: ID;
+    };
+    tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue";
+    cacheOverride: any;
+    downloadCategories: string[];
+}, string, never, never>, fetchScheduleList: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue", timeframeAndCategory?: {
+    selectedTimeframe: TimeframeTick;
+    selectedCategoryId: ID;
+} | undefined, cacheOverride?: any], {
+    timeframeAndCategory: {
+        selectedTimeframe: TimeframeTick;
+        selectedCategoryId: ID;
+    } | undefined;
+    tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue";
+    cacheOverride: any;
+}, string, never, never>, fetchSchedulesAccount: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue"], {
+    tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue";
+}, string, never, never>, updateScheduleListSuccess: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue", selectedTimeframe: TimeframeTick, selectedCategoryId: string, scheduleList: JEScheduledTransactionPayload[]], {
+    tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue";
+    selectedTimeframe: TimeframeTick;
+    selectedCategoryId: string;
+    scheduleList: JEScheduledTransactionPayload[];
+}, string, never, never>, updateScheduleListFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue", selectedTimeframe: TimeframeTick, selectedCategoryId: string, error: ZeniAPIStatus<Record<string, unknown>>], {
+    selectedCategoryId: string;
+    selectedTimeframe: TimeframeTick;
+    tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue";
+    error: ZeniAPIStatus<Record<string, unknown>>;
+}, string, never, never>, updateDownloadScheduleFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue", selectedTimeframe: TimeframeTick, selectedCategoryId: string, error: ZeniAPIStatus<Record<string, unknown>>], {
+    selectedCategoryId: string;
+    selectedTimeframe: TimeframeTick;
+    tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue";
+    error: ZeniAPIStatus<Record<string, unknown>>;
+}, string, never, never>, updateDownloadScheduleSuccess: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue", selectedTimeframe: TimeframeTick, selectedCategoryId: string, scheduleList: JEScheduledTransactionPayload[]], {
+    tab: "prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue";
+    selectedTimeframe: TimeframeTick;
+    selectedCategoryId: string;
+    scheduleList: JEScheduledTransactionPayload[];
+}, string, never, never>, updateScheduleListTab: import("@reduxjs/toolkit").ActionCreatorWithPayload<"prepaid_expenses" | "fixed_assets" | "accured_expenses" | "deferred_revenue", string>, updateScheduleListSubTab: import("@reduxjs/toolkit").ActionCreatorWithPayload<"all" | "new" | "completed" | "ongoing", string>, updateScheduleListUIState: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    uiState: Partial<ScheduleListUIState>;
+}, string>, updateScheduleListLocalData: import("@reduxjs/toolkit").ActionCreatorWithPayload<ScheduleListLocalData, string>, updateScheduleListSearchText: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, string>, updateScheduleListDownloadState: import("@reduxjs/toolkit").ActionCreatorWithPayload<FetchState, string>, clearScheduleList: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
+declare const _default: import("@reduxjs/toolkit").Reducer<ScheduleListViewState, import("@reduxjs/toolkit").AnyAction>;
+export default _default;

package/lib/view/scheduleView/scheduleListView/scheduleListReducer.js

@@ -0,0 +1,228 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearScheduleList = exports.updateScheduleListDownloadState = exports.updateScheduleListSearchText = exports.updateScheduleListLocalData = exports.updateScheduleListUIState = exports.updateScheduleListSubTab = exports.updateScheduleListTab = exports.updateDownloadScheduleSuccess = exports.updateDownloadScheduleFailure = exports.updateScheduleListFailure = exports.updateScheduleListSuccess = exports.fetchSchedulesAccount = exports.fetchScheduleList = exports.fetchDownloadSchedules = exports.scheduleListInitialState = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+const transactionIDPayload_1 = require("../../../entity/transaction/payloadTypes/transactionIDPayload");
+const scheduleListTypes_1 = require("./scheduleListTypes");
+const transactionDetailState_1 = require("../../transactionDetail/transactionDetailState");
+exports.initialState = {
+    byScheduleListKey: {},
+    currentTab: 'prepaid_expenses',
+    currentSubTab: 'all',
+    searchText: '',
+    scheduleListLocalData: {
+        selectedCategoryID: 'all',
+        selectedTimeframe: {
+            startDate: (0, zeniDayJS_1.dateNow)().subtract(1, 'year'),
+            endDate: (0, zeniDayJS_1.dateNow)(),
+        },
+    },
+    selectedCategoryId: 'all',
+    selectedTimeframe: {
+        startDate: (0, zeniDayJS_1.dateNow)().subtract(1, 'year'),
+        endDate: (0, zeniDayJS_1.dateNow)(),
+    },
+    downloadState: {
+        fetchState: 'Not-Started',
+        error: undefined,
+    },
+};
+exports.scheduleListInitialState = {
+    fetchState: 'Not-Started',
+    error: undefined,
+    jeScheduleTransactionKeys: [],
+    uiState: {
+        sortKey: 'transactionDate',
+        sortOrder: 'descending',
+        scrollYOffset: 0,
+    },
+    hasValidState() {
+        return this.fetchState === 'Completed';
+    },
+};
+const scheduleListView = (0, toolkit_1.createSlice)({
+    name: 'scheduleListView',
+    initialState: exports.initialState,
+    reducers: {
+        fetchDownloadSchedules: {
+            reducer(draft, action) {
+                const selectedTimeframe = action.payload.timeframeAndCategory.selectedTimeframe;
+                const selectedCategoryID = action.payload.timeframeAndCategory.selectedCategoryId;
+                draft.scheduleListLocalData = {
+                    selectedTimeframe,
+                    selectedCategoryID: selectedCategoryID,
+                };
+                const key = (0, scheduleListTypes_1.getScheduleListKey)(action.payload.tab, selectedCategoryID, selectedTimeframe);
+                const record = draft.byScheduleListKey[key];
+                if (record == null) {
+                    draft.byScheduleListKey[key] = Object.assign({}, exports.scheduleListInitialState);
+                    draft.downloadState = {
+                        fetchState: 'In-Progress',
+                        error: undefined,
+                    };
+                }
+                else {
+                    draft.selectedCategoryId = selectedCategoryID;
+                    draft.selectedTimeframe = selectedTimeframe;
+                }
+            },
+            prepare(tab, timeframeAndCategory, downloadCategories, cacheOverride = false) {
+                return {
+                    payload: {
+                        timeframeAndCategory,
+                        tab,
+                        cacheOverride,
+                        downloadCategories,
+                    },
+                };
+            },
+        },
+        fetchSchedulesAccount: {
+            reducer() {
+                //do nothing
+            },
+            prepare(tab) {
+                return {
+                    payload: { tab },
+                };
+            },
+        },
+        fetchScheduleList: {
+            reducer(draft, action) {
+                const selectedTimeframe = action.payload.timeframeAndCategory != null
+                    ? action.payload.timeframeAndCategory.selectedTimeframe
+                    : draft.scheduleListLocalData.selectedTimeframe;
+                const selectedCategoryID = action.payload.timeframeAndCategory != null
+                    ? action.payload.timeframeAndCategory.selectedCategoryId
+                    : draft.scheduleListLocalData.selectedCategoryID;
+                const key = (0, scheduleListTypes_1.getScheduleListKey)(action.payload.tab, selectedCategoryID, selectedTimeframe);
+                const record = draft.byScheduleListKey[key];
+                if (record == null) {
+                    draft.byScheduleListKey[key] = Object.assign(Object.assign({}, exports.scheduleListInitialState), { fetchState: 'In-Progress' });
+                }
+                else {
+                    // if the record is found, then set the selected ID and timeframe.
+                    draft.scheduleListLocalData = {
+                        selectedTimeframe,
+                        selectedCategoryID,
+                    };
+                    draft.selectedCategoryId = selectedCategoryID;
+                    draft.selectedTimeframe = selectedTimeframe;
+                }
+            },
+            prepare(tab, timeframeAndCategory, cacheOverride = false) {
+                return {
+                    payload: {
+                        timeframeAndCategory,
+                        tab,
+                        cacheOverride,
+                    },
+                };
+            },
+        },
+        updateScheduleListSuccess: {
+            reducer(draft, action) {
+                doUpdateScheduleList(draft, action.payload.scheduleList, action.payload.tab, action.payload.selectedTimeframe, action.payload.selectedCategoryId);
+            },
+            prepare(tab, selectedTimeframe, selectedCategoryId, scheduleList) {
+                return {
+                    payload: { tab, selectedTimeframe, selectedCategoryId, scheduleList },
+                };
+            },
+        },
+        updateScheduleListFailure: {
+            reducer(draft, action) {
+                const key = (0, scheduleListTypes_1.getScheduleListKey)(action.payload.tab, action.payload.selectedCategoryId, action.payload.selectedTimeframe);
+                draft.byScheduleListKey[key] = Object.assign(Object.assign({}, exports.scheduleListInitialState), { fetchState: 'Error', error: action.payload.error });
+                draft.selectedCategoryId = action.payload.selectedCategoryId;
+                draft.selectedTimeframe = action.payload.selectedTimeframe;
+            },
+            prepare(tab, selectedTimeframe, selectedCategoryId, error) {
+                return { payload: { selectedCategoryId, selectedTimeframe, tab, error } };
+            },
+        },
+        updateDownloadScheduleSuccess: {
+            reducer(draft, action) {
+                doUpdateScheduleList(draft, action.payload.scheduleList, action.payload.tab, action.payload.selectedTimeframe, action.payload.selectedCategoryId);
+            },
+            prepare(tab, selectedTimeframe, selectedCategoryId, scheduleList) {
+                return {
+                    payload: { tab, selectedTimeframe, selectedCategoryId, scheduleList },
+                };
+            },
+        },
+        updateDownloadScheduleFailure: {
+            reducer(draft, action) {
+                const key = (0, scheduleListTypes_1.getScheduleListKey)(action.payload.tab, action.payload.selectedCategoryId, action.payload.selectedTimeframe);
+                draft.byScheduleListKey[key] = Object.assign(Object.assign({}, exports.scheduleListInitialState), { error: action.payload.error });
+                draft.selectedCategoryId = action.payload.selectedCategoryId;
+                draft.selectedTimeframe = action.payload.selectedTimeframe;
+                draft.downloadState = {
+                    fetchState: 'Error',
+                    error: action.payload.error,
+                };
+            },
+            prepare(tab, selectedTimeframe, selectedCategoryId, error) {
+                return { payload: { selectedCategoryId, selectedTimeframe, tab, error } };
+            },
+        },
+        updateScheduleListTab(draft, action) {
+            draft.currentTab = action.payload;
+        },
+        updateScheduleListSearchText(draft, action) {
+            draft.searchText = action.payload;
+        },
+        updateScheduleListSubTab(draft, action) {
+            draft.currentSubTab = action.payload;
+        },
+        updateScheduleListUIState(draft, action) {
+            const tab = draft.currentTab;
+            const key = (0, scheduleListTypes_1.getScheduleListKey)(tab, draft.selectedCategoryId, draft.selectedTimeframe);
+            if (draft.byScheduleListKey[key] != null) {
+                if (action.payload.uiState.sortKey != null) {
+                    draft.byScheduleListKey[key].uiState.sortKey =
+                        action.payload.uiState.sortKey;
+                }
+                if (action.payload.uiState.sortOrder != null) {
+                    draft.byScheduleListKey[key].uiState.sortOrder =
+                        action.payload.uiState.sortOrder;
+                }
+                if (action.payload.uiState.scrollYOffset != null) {
+                    draft.byScheduleListKey[key].uiState.scrollYOffset =
+                        action.payload.uiState.scrollYOffset;
+                }
+            }
+        },
+        updateScheduleListLocalData(draft, action) {
+            draft.scheduleListLocalData = action.payload;
+        },
+        updateScheduleListDownloadState(draft, action) {
+            draft.downloadState = { fetchState: action.payload, error: undefined };
+        },
+        clearScheduleList(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = scheduleListView.actions, exports.fetchDownloadSchedules = _a.fetchDownloadSchedules, exports.fetchScheduleList = _a.fetchScheduleList, exports.fetchSchedulesAccount = _a.fetchSchedulesAccount, exports.updateScheduleListSuccess = _a.updateScheduleListSuccess, exports.updateScheduleListFailure = _a.updateScheduleListFailure, exports.updateDownloadScheduleFailure = _a.updateDownloadScheduleFailure, exports.updateDownloadScheduleSuccess = _a.updateDownloadScheduleSuccess, exports.updateScheduleListTab = _a.updateScheduleListTab, exports.updateScheduleListSubTab = _a.updateScheduleListSubTab, exports.updateScheduleListUIState = _a.updateScheduleListUIState, exports.updateScheduleListLocalData = _a.updateScheduleListLocalData, exports.updateScheduleListSearchText = _a.updateScheduleListSearchText, exports.updateScheduleListDownloadState = _a.updateScheduleListDownloadState, exports.clearScheduleList = _a.clearScheduleList;
+exports.default = scheduleListView.reducer;
+/**
+ * Helper functions
+ */
+function doUpdateScheduleList(draft, payload, tab, selectedTimeframe, selectedCategoryId) {
+    const jeScheduleTransactionKeys = payload.map((schedules) => {
+        const transactionID = (0, transactionIDPayload_1.toTransactionID)(schedules.base_transaction);
+        return (0, transactionDetailState_1.getTransactionDetailKey)(transactionID);
+    });
+    draft.selectedCategoryId = selectedCategoryId;
+    draft.selectedTimeframe = selectedTimeframe;
+    const key = (0, scheduleListTypes_1.getScheduleListKey)(tab, selectedCategoryId, selectedTimeframe);
+    const record = draft.byScheduleListKey[key];
+    draft.byScheduleListKey[key] = Object.assign(Object.assign({}, record), { fetchState: 'Completed', error: undefined, jeScheduleTransactionKeys });
+    draft.downloadState = {
+        fetchState: 'Completed',
+        error: undefined,
+    };
+}

package/lib/view/scheduleView/scheduleListView/scheduleListSelector.d.ts

@@ -0,0 +1,38 @@
+import { FetchState, FetchStateAndError, ID } from '../../../commonStateTypes/common';
+import { EntityOrder } from '../../../commonStateTypes/selectorTypes/selectorTypes';
+import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
+import { RootState } from '../../../reducer';
+import { ScheduleListLocalData, ScheduleListUIState } from './scheduleListState';
+import { NestedAccountHeirarchyForReport } from '../../../commonStateTypes/accountView/nestedAccountID';
+import { TimeframeTick, TimeframeTickWithMetaData } from '../../../commonStateTypes/timeframeTick';
+import { AccountBase } from '../../../entity/account/accountState';
+import { JEScheduledTransaction } from '../../../entity/jeSchedules/jeSchedulesSelector';
+import { SchedulesTypes } from '../../../entity/jeSchedules/jeSchedulesTypes';
+import { ScheduleSubTabType } from './scheduleListTypes';
+import { Amount } from '../../../commonStateTypes/amount';
+import { COABalanceGroupedByPeriod } from '../../../commonStateTypes/coaBalance/coaBalance';
+export interface JEScheduledTransactionWithBalance extends JEScheduledTransaction {
+    coaBalanceByPeriod: COABalanceGroupedByPeriod;
+}
+export interface ScheduleListReport extends SelectorView {
+    allSubTabs: ScheduleSubTabType[];
+    currentTab: SchedulesTypes;
+    currentSubTab: ScheduleSubTabType;
+    downloadUIState: FetchStateAndError;
+    jeScheduleOrder: EntityOrder;
+    jeScheduledTransactions: JEScheduledTransactionWithBalance[];
+    searchText: string;
+    scheduleListAccounts: AccountBase[];
+    scheduleListNestedAccountHierarchy: NestedAccountHeirarchyForReport[];
+    uiState: ScheduleListUIState;
+    selectedCategoryID: ID;
+    selectedTimeframe: TimeframeTick;
+    scheduleListLocalData: ScheduleListLocalData;
+    allTimeframeTicks: TimeframeTickWithMetaData[];
+    totalBalanceTimeframeTicks: COABalanceGroupedByPeriod;
+    totalAmount: Amount;
+    totalRunningBalances: Amount;
+    selectedScheduledId?: ID;
+}
+export declare const getScheduleListReport: (state: RootState) => ScheduleListReport;
+export declare const getFetchStateForScheduleAccountList: (state: RootState, scheduleTab: SchedulesTypes) => FetchState;