@zeniai/client-epic-state 5.1.80 → 5.1.81

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewEpic.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchNetBurnOrIncomeProjectViewEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const netBurnOrIncomeProjectViewReducer_1 = require("./netBurnOrIncomeProjectViewReducer");
+const fetchNetBurnOrIncomeProjectViewEpic = (actions$, state) => actions$.pipe((0, operators_1.filter)(netBurnOrIncomeProjectViewReducer_1.fetchNetBurnOrIncomeProjectView.match), (0, operators_1.switchMap)((action) => {
+    const { cacheOverride } = action.payload;
+    if (cacheOverride === true) {
+        return (0, rxjs_1.from)([
+            (0, netBurnOrIncomeProjectViewReducer_1.fetchNetBurnOrIncomeForTimeframeProjectView)('month'),
+            (0, netBurnOrIncomeProjectViewReducer_1.fetchNetBurnOrIncomeForTimeframeProjectView)('quarter'),
+            (0, netBurnOrIncomeProjectViewReducer_1.fetchNetBurnOrIncomeForTimeframeProjectView)('year'),
+        ]);
+    }
+    else {
+        const fetchActions = [];
+        const projectFetchState = state.value.netBurnOrIncomeProjectViewState.fetchState;
+        if (projectFetchState['month'].fetchState !== 'In-Progress' &&
+            projectFetchState['month'].fetchState !== 'Completed') {
+            fetchActions.push((0, netBurnOrIncomeProjectViewReducer_1.fetchNetBurnOrIncomeForTimeframeProjectView)('month'));
+        }
+        if (projectFetchState['quarter'].fetchState !== 'In-Progress' &&
+            projectFetchState['quarter'].fetchState !== 'Completed') {
+            fetchActions.push((0, netBurnOrIncomeProjectViewReducer_1.fetchNetBurnOrIncomeForTimeframeProjectView)('quarter'));
+        }
+        if (projectFetchState['year'].fetchState !== 'In-Progress' &&
+            projectFetchState['year'].fetchState !== 'Completed') {
+            fetchActions.push((0, netBurnOrIncomeProjectViewReducer_1.fetchNetBurnOrIncomeForTimeframeProjectView)('year'));
+        }
+        return (0, rxjs_1.from)(fetchActions);
+    }
+}));
+exports.fetchNetBurnOrIncomeProjectViewEpic = fetchNetBurnOrIncomeProjectViewEpic;

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewPayload.d.ts

@@ -0,0 +1,11 @@
+import { COABalanceGroupedPayloadV2 } from '../../commonPayloadTypes/v2/coaBalancePayload';
+import { ZeniReportResponse } from '../../responsePayload';
+import { ReportByProjectMetadataPayloadV2, SectionByProjectCOABalanceGroupedPayloadV2 } from '../profitAndLossProjectView/profitAndLossProjectViewPayload';
+export interface NetBurnOrIncomeProjectViewPayload extends ReportByProjectMetadataPayloadV2 {
+    cogs: SectionByProjectCOABalanceGroupedPayloadV2;
+    expenses: SectionByProjectCOABalanceGroupedPayloadV2;
+    gross_burn: COABalanceGroupedPayloadV2;
+    income: SectionByProjectCOABalanceGroupedPayloadV2;
+    net_burn_or_income: COABalanceGroupedPayloadV2;
+}
+export type NetBurnOrIncomeReportProjectViewResponse = ZeniReportResponse<NetBurnOrIncomeProjectViewPayload>;

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewPayload.js

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

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewReducer.d.ts

@@ -0,0 +1,33 @@
+import { AccountViewMode, ID } from '../../commonStateTypes/common';
+import { ZeniAPIStatus, ZeniReportData } from '../../responsePayload';
+import { NetBurnOrIncomeProjectViewPayload } from './netBurnOrIncomeProjectViewPayload';
+import { NetBurnOrIncomeProjectViewState } from './netBurnOrIncomeProjectViewState';
+export declare const initialState: NetBurnOrIncomeProjectViewState;
+export declare const fetchNetBurnOrIncomeProjectView: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[cacheOverride?: boolean | undefined], {
+    cacheOverride: boolean;
+}, "netBurnOrIncomeProjectView/fetchNetBurnOrIncomeProjectView", never, never>, fetchNetBurnOrIncomeForTimeframeProjectView: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[timeframe: "month" | "year" | "quarter", fetchFullReport?: boolean | undefined, cacheOverride?: boolean | undefined], {
+    timeframe: "month" | "year" | "quarter";
+    fetchFullReport: boolean;
+    cacheOverride: boolean;
+}, "netBurnOrIncomeProjectView/fetchNetBurnOrIncomeForTimeframeProjectView", never, never>, updateNetBurnOrIncomeForTimeframeProjectView: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    report: ZeniReportData<NetBurnOrIncomeProjectViewPayload>;
+    timeframe: "month" | "quarter" | "year";
+}, "netBurnOrIncomeProjectView/updateNetBurnOrIncomeForTimeframeProjectView">, updateNetBurnOrIncomeForTimeframeProjectViewFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[error: ZeniAPIStatus<Record<string, unknown>>, timeframe: "month" | "year" | "quarter"], {
+    error: ZeniAPIStatus<Record<string, unknown>>;
+    timeframe: "month" | "year" | "quarter";
+}, "netBurnOrIncomeProjectView/updateNetBurnOrIncomeForTimeframeProjectViewFailure", never, never>, updateProjectsToFilterOut: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    projectsToFilterOut: ID[];
+}, "netBurnOrIncomeProjectView/updateProjectsToFilterOut">, updateNetBurnOrIncomeProjectViewUIState: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    nodeCollapseState?: {
+        isCollapsed: boolean;
+        nodeId: ID;
+    };
+    scrollPosition?: {
+        scrollTop: number;
+        scrollLeft?: number;
+    };
+}, "netBurnOrIncomeProjectView/updateNetBurnOrIncomeProjectViewUIState">, updateProjectViewAccountViewMode: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    viewMode: AccountViewMode;
+}, "netBurnOrIncomeProjectView/updateProjectViewAccountViewMode">, resetProjectNodeCollapseState: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"netBurnOrIncomeProjectView/resetProjectNodeCollapseState">, clearNetBurnOrIncomeProjectView: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"netBurnOrIncomeProjectView/clearNetBurnOrIncomeProjectView">;
+declare const _default: import("redux").Reducer<NetBurnOrIncomeProjectViewState>;
+export default _default;

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewReducer.js

@@ -0,0 +1,115 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearNetBurnOrIncomeProjectView = exports.resetProjectNodeCollapseState = exports.updateProjectViewAccountViewMode = exports.updateNetBurnOrIncomeProjectViewUIState = exports.updateProjectsToFilterOut = exports.updateNetBurnOrIncomeForTimeframeProjectViewFailure = exports.updateNetBurnOrIncomeForTimeframeProjectView = exports.fetchNetBurnOrIncomeForTimeframeProjectView = exports.fetchNetBurnOrIncomeProjectView = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const viewAndReportPayloadv2_1 = require("../../commonPayloadTypes/v2/viewAndReportPayloadv2");
+exports.initialState = {
+    fetchState: {
+        month: {
+            fetchState: 'Not-Started',
+            error: undefined,
+        },
+        quarter: {
+            fetchState: 'Not-Started',
+            error: undefined,
+        },
+        year: {
+            fetchState: 'Not-Started',
+            error: undefined,
+        },
+    },
+    firstMonthOfFY: 1,
+    projectIds: [],
+    reportId: 'net_burn_or_income_by_projects',
+    reportTitle: 'Net Income',
+    uiState: {
+        accountViewMode: 'account_group',
+        nodeCollapseState: {},
+        projectsToFilterOut: [],
+        scrollPosition: undefined,
+    },
+};
+const netBurnOrIncomeProjectView = (0, toolkit_1.createSlice)({
+    name: 'netBurnOrIncomeProjectView',
+    initialState: exports.initialState,
+    reducers: {
+        fetchNetBurnOrIncomeProjectView: {
+            prepare(cacheOverride = false) {
+                return { payload: { cacheOverride } };
+            },
+            reducer(
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _draft, 
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _action) {
+                // nothing to do here
+            },
+        },
+        fetchNetBurnOrIncomeForTimeframeProjectView: {
+            prepare(timeframe, fetchFullReport = true, cacheOverride = false) {
+                return { payload: { timeframe, fetchFullReport, cacheOverride } };
+            },
+            reducer(draft, action) {
+                const timeframe = action.payload.timeframe;
+                draft.fetchState[timeframe].fetchState = 'In-Progress';
+                draft.fetchState[timeframe].error = undefined;
+            },
+        },
+        updateNetBurnOrIncomeForTimeframeProjectView(draft, action) {
+            doUpdateNetBurnOrIncomeProjectView(draft, action.payload.timeframe, action.payload.report);
+        },
+        updateNetBurnOrIncomeForTimeframeProjectViewFailure: {
+            prepare(error, timeframe) {
+                return {
+                    payload: {
+                        error,
+                        timeframe,
+                    },
+                };
+            },
+            reducer(draft, action) {
+                draft.fetchState[action.payload.timeframe] = {
+                    fetchState: 'Error',
+                    error: action.payload.error,
+                };
+            },
+        },
+        updateProjectsToFilterOut(draft, action) {
+            draft.uiState.projectsToFilterOut = action.payload.projectsToFilterOut;
+        },
+        updateNetBurnOrIncomeProjectViewUIState(draft, action) {
+            const { nodeCollapseState, scrollPosition } = action.payload;
+            if (nodeCollapseState != null) {
+                draft.uiState.nodeCollapseState = Object.assign({}, draft.uiState.nodeCollapseState, {
+                    [nodeCollapseState.nodeId]: nodeCollapseState.isCollapsed,
+                });
+            }
+            if (scrollPosition != null) {
+                draft.uiState.scrollPosition = scrollPosition;
+            }
+        },
+        updateProjectViewAccountViewMode(draft, action) {
+            draft.uiState.accountViewMode = action.payload.viewMode;
+        },
+        resetProjectNodeCollapseState(draft) {
+            draft.uiState.nodeCollapseState = {};
+        },
+        clearNetBurnOrIncomeProjectView(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = netBurnOrIncomeProjectView.actions, exports.fetchNetBurnOrIncomeProjectView = _a.fetchNetBurnOrIncomeProjectView, exports.fetchNetBurnOrIncomeForTimeframeProjectView = _a.fetchNetBurnOrIncomeForTimeframeProjectView, exports.updateNetBurnOrIncomeForTimeframeProjectView = _a.updateNetBurnOrIncomeForTimeframeProjectView, exports.updateNetBurnOrIncomeForTimeframeProjectViewFailure = _a.updateNetBurnOrIncomeForTimeframeProjectViewFailure, exports.updateProjectsToFilterOut = _a.updateProjectsToFilterOut, exports.updateNetBurnOrIncomeProjectViewUIState = _a.updateNetBurnOrIncomeProjectViewUIState, exports.updateProjectViewAccountViewMode = _a.updateProjectViewAccountViewMode, exports.resetProjectNodeCollapseState = _a.resetProjectNodeCollapseState, exports.clearNetBurnOrIncomeProjectView = _a.clearNetBurnOrIncomeProjectView;
+exports.default = netBurnOrIncomeProjectView.reducer;
+const doUpdateNetBurnOrIncomeProjectView = (draft, timeframe, netBurnReport) => {
+    const report = (0, viewAndReportPayloadv2_1.mapReportPayloadV2ToReportV2)(netBurnReport.report);
+    draft.dataAvailable = report.dataAvailable;
+    draft.firstMonthOfFY = report.firstMonthOfFY;
+    draft.bookCloseDate = report.bookCloseDate;
+    draft.status = report.status;
+    draft.fetchState[timeframe].fetchState = 'Completed';
+    if (draft.projectIds.length <= 0) {
+        draft.projectIds = netBurnReport.report.projects.map((project) => project.accounting_project_id);
+    }
+};

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewSelector.d.ts

@@ -0,0 +1,13 @@
+import { COABalancesFilterProjectView } from '../../commonStateTypes/coaBalance/coaBalancesFilterProjectView';
+import { AccountState } from '../../entity/account/accountState';
+import { ProjectState } from '../../entity/project/projectReducer';
+import { SectionProjectViewState } from '../../entity/sectionProjectView/sectionProjectViewState';
+import { RootState } from '../../reducer';
+import { NetBurnOrIncomeWithForecastState } from '../netBurnOrIncome/netBurnOrIncomeState';
+import { NetBurnOrIncomeClassesViewCalculatedSectionID, NetBurnOrIncomeClassesViewSectionID } from '../netBurnOrIncomeClassesView/netBurnOrIncomeClassesViewSelectorTypes';
+import { NetBurnOrIncomeProjectViewReport } from './netBurnOrIncomeProjectViewSelectorTypes';
+import { NetBurnOrIncomeProjectViewState } from './netBurnOrIncomeProjectViewState';
+export declare const netBurnOrIncomeProjectIdsInOrder: (NetBurnOrIncomeClassesViewSectionID | NetBurnOrIncomeClassesViewCalculatedSectionID)[];
+export declare const getNetBurnOrIncomeProjectView: (filter: COABalancesFilterProjectView, accountState: AccountState, projectState: ProjectState, sectionsState: SectionProjectViewState, netBurnOrIncomeWithForecastState: NetBurnOrIncomeWithForecastState, netBurnOrIncomeProjectViewState: NetBurnOrIncomeProjectViewState) => NetBurnOrIncomeProjectViewReport;
+export declare const getNetBurnOrIncomeProjectViewForSelectedRange: (state: RootState) => NetBurnOrIncomeProjectViewReport;
+export declare const getNetBurnOrIncomeProjectViewForHighlightedRange: (state: RootState) => NetBurnOrIncomeProjectViewReport;

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewSelector.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNetBurnOrIncomeProjectViewForHighlightedRange = exports.getNetBurnOrIncomeProjectViewForSelectedRange = exports.getNetBurnOrIncomeProjectView = exports.netBurnOrIncomeProjectIdsInOrder = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const getDifferenceOfBalancesGroupedByPeriod_1 = require("../../commonStateTypes/coaBalance/classBalances/getDifferenceOfBalancesGroupedByPeriod");
+const getSumOfBalancesGroupedByPeriod_1 = require("../../commonStateTypes/coaBalance/classBalances/getSumOfBalancesGroupedByPeriod");
+const coaBalance_1 = require("../../commonStateTypes/coaBalance/coaBalance");
+const coaBalancesFilterProjectView_1 = require("../../commonStateTypes/coaBalance/coaBalancesFilterProjectView");
+const reduceFetchState_1 = require("../../commonStateTypes/reduceFetchState");
+const projectSelector_1 = require("../../entity/project/projectSelector");
+const sectionProjectViewSelector_1 = require("../../entity/sectionProjectView/sectionProjectViewSelector");
+const netBurnOrIncomeClassesViewSelectorTypes_1 = require("../netBurnOrIncomeClassesView/netBurnOrIncomeClassesViewSelectorTypes");
+exports.netBurnOrIncomeProjectIdsInOrder = ['income', 'cogs', 'expenses', 'grossBurn', 'netBurnOrIncome'];
+const getNetBurnOrIncomeProjectView = (filter, accountState, projectState, sectionsState, netBurnOrIncomeWithForecastState, netBurnOrIncomeProjectViewState) => {
+    const fetchState = (0, reduceFetchState_1.reduceFetchStateParallelTimeframes)([
+        netBurnOrIncomeProjectViewState.fetchState.month,
+        netBurnOrIncomeProjectViewState.fetchState.quarter,
+        netBurnOrIncomeProjectViewState.fetchState.year,
+    ]);
+    const reportId = 'net_burn_or_income_by_projects';
+    const sections = {};
+    const calculatedSections = {};
+    if (fetchState.fetchState === 'Completed') {
+        netBurnOrIncomeClassesViewSelectorTypes_1.ALL_NETBURN_OR_INCOME_CLASSES_VIEW_SECTION_IDS.forEach((sectionId) => {
+            sections[`${sectionId}`] = (0, sectionProjectViewSelector_1.getSectionProjectViewReport)(accountState, projectState, sectionsState, netBurnOrIncomeProjectViewState.projectIds, {
+                reportId,
+                sectionId,
+            }, filter);
+        });
+        const grossBurnBalancesByPeriod = (0, getSumOfBalancesGroupedByPeriod_1.getSumOfBalancesByGroupedByPeriod)([
+            sections['expenses'].sectionBalancesTotalByPeriod,
+            sections['cogs'].sectionBalancesTotalByPeriod,
+        ]);
+        calculatedSections['grossBurn'] = (0, coaBalance_1.getCOABalances)(grossBurnBalancesByPeriod, filter);
+        const netBurnOrIncomeBalances = (0, getDifferenceOfBalancesGroupedByPeriod_1.getDifferenceOfBalancesGroupedByPeriod)(sections['income'].sectionBalancesTotalByPeriod, grossBurnBalancesByPeriod);
+        calculatedSections['netBurnOrIncome'] = (0, coaBalance_1.getCOABalances)(netBurnOrIncomeBalances, filter);
+    }
+    return {
+        sections,
+        calculatedSections,
+        reportId: netBurnOrIncomeProjectViewState.reportId,
+        reportTitle: netBurnOrIncomeProjectViewState.reportTitle,
+        firstMonthOfFY: netBurnOrIncomeProjectViewState.firstMonthOfFY,
+        dataAvailable: netBurnOrIncomeProjectViewState.dataAvailable,
+        bookCloseDate: netBurnOrIncomeProjectViewState.bookCloseDate,
+        version: netBurnOrIncomeProjectViewState.version,
+        status: netBurnOrIncomeProjectViewState.status,
+        fetchState: fetchState.fetchState,
+        error: fetchState.error,
+        filter,
+        uiState: netBurnOrIncomeProjectViewState.uiState,
+        projects: (0, projectSelector_1.getProjectsByIds)(projectState, netBurnOrIncomeProjectViewState.projectIds),
+        projectsToFilterOut: netBurnOrIncomeProjectViewState.uiState.projectsToFilterOut,
+        idsInOrder: exports.netBurnOrIncomeProjectIdsInOrder,
+        runwayAndAverages: netBurnOrIncomeWithForecastState.netBurnOrIncome.runwayAndAverages,
+    };
+};
+exports.getNetBurnOrIncomeProjectView = getNetBurnOrIncomeProjectView;
+exports.getNetBurnOrIncomeProjectViewForSelectedRange = (0, toolkit_1.createSelector)((state) => state.accountState, (state) => state.projectState, (state) => state.sectionProjectViewState, (state) => state.netBurnOrIncomeState, (state) => state.netBurnOrIncomeProjectViewState, (accountState, projectState, sectionsState, netBurnOrIncomeState, netBurnOrIncomeProjectViewState) => {
+    const { timeframe, selectedCOABalancesRange, selectedAdditionalBalances } = netBurnOrIncomeState.uiState;
+    const noFilter = (0, coaBalancesFilterProjectView_1.newBalancesFilterProjectView)(netBurnOrIncomeState.netBurnOrIncome.firstMonthOfFY, timeframe, selectedCOABalancesRange.numberOfPeriods, selectedCOABalancesRange.thisPeriod, 'ascending_date', selectedAdditionalBalances, netBurnOrIncomeProjectViewState.uiState.projectsToFilterOut);
+    return (0, exports.getNetBurnOrIncomeProjectView)(noFilter, accountState, projectState, sectionsState, netBurnOrIncomeState, netBurnOrIncomeProjectViewState);
+});
+exports.getNetBurnOrIncomeProjectViewForHighlightedRange = (0, toolkit_1.createSelector)((state) => state.accountState, (state) => state.projectState, (state) => state.sectionProjectViewState, (state) => state.netBurnOrIncomeState, (state) => state.netBurnOrIncomeProjectViewState, (accountState, projectState, sectionsState, netBurnOrIncomeState, netBurnOrIncomeProjectViewState) => {
+    const { timeframe, highlightedCOABalancesRange, selectedAdditionalBalances, maxNumOfPeriodsToHighlight, } = netBurnOrIncomeState.uiState;
+    const filter = (0, coaBalancesFilterProjectView_1.newBalancesFilterProjectView)(netBurnOrIncomeState.netBurnOrIncome.firstMonthOfFY, timeframe, highlightedCOABalancesRange?.numberOfPeriods ??
+        maxNumOfPeriodsToHighlight, highlightedCOABalancesRange?.thisPeriod, 'ascending_date', selectedAdditionalBalances, netBurnOrIncomeProjectViewState.uiState.projectsToFilterOut);
+    return (0, exports.getNetBurnOrIncomeProjectView)(filter, accountState, projectState, sectionsState, netBurnOrIncomeState, netBurnOrIncomeProjectViewState);
+});

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewSelectorTypes.d.ts

@@ -0,0 +1,21 @@
+import { COABalancesFilterProjectView } from '../../commonStateTypes/coaBalance/coaBalancesFilterProjectView';
+import { ID } from '../../commonStateTypes/common';
+import { DataAvailable } from '../../commonStateTypes/dataAvailable';
+import { CalculatedSection } from '../../commonStateTypes/selectorTypes/selectorTypes';
+import { SelectorReport } from '../../commonStateTypes/viewAndReport/viewAndReport';
+import { Project } from '../../entity/project/projectState';
+import { SectionProjectViewReport } from '../../entity/sectionProjectView/sectionProjectViewSelectorTypes';
+import { RunwayAndAverages } from '../netBurnOrIncome/netBurnOrIncomeState';
+import { NetBurnOrIncomeClassesViewCalculatedSectionID, NetBurnOrIncomeClassesViewSectionID } from '../netBurnOrIncomeClassesView/netBurnOrIncomeClassesViewSelectorTypes';
+import { NetBurnOrIncomeProjectViewUIState } from './netBurnOrIncomeProjectViewState';
+export interface NetBurnOrIncomeProjectViewReport extends SelectorReport {
+    calculatedSections: Record<NetBurnOrIncomeClassesViewCalculatedSectionID, CalculatedSection>;
+    filter: COABalancesFilterProjectView;
+    idsInOrder: (NetBurnOrIncomeClassesViewSectionID | NetBurnOrIncomeClassesViewCalculatedSectionID)[];
+    projects: Project[];
+    projectsToFilterOut: ID[];
+    runwayAndAverages: RunwayAndAverages;
+    sections: Record<NetBurnOrIncomeClassesViewSectionID, SectionProjectViewReport>;
+    uiState: NetBurnOrIncomeProjectViewUIState;
+    dataAvailable?: DataAvailable;
+}

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewSelectorTypes.js

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

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewState.d.ts

@@ -0,0 +1,20 @@
+import { AccountViewMode, FetchStateAndError, ID } from '../../commonStateTypes/common';
+import { Report } from '../../commonStateTypes/viewAndReport/viewAndReport';
+export interface NetBurnOrIncomeProjectViewUIState {
+    accountViewMode: AccountViewMode;
+    nodeCollapseState: Record<ID, boolean>;
+    projectsToFilterOut: ID[];
+    scrollPosition: {
+        scrollTop: number;
+        scrollLeft?: number;
+    } | undefined;
+}
+export interface NetBurnOrIncomeProjectViewState extends Report {
+    fetchState: {
+        month: FetchStateAndError;
+        quarter: FetchStateAndError;
+        year: FetchStateAndError;
+    };
+    projectIds: ID[];
+    uiState: NetBurnOrIncomeProjectViewUIState;
+}

package/lib/view/netBurnOrIncomeProjectView/netBurnOrIncomeProjectViewState.js

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

package/lib/view/opExProjectView/opExForTimeframeProjectViewEpic.d.ts

@@ -0,0 +1,9 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateProjects } from '../../entity/project/projectReducer';
+import { updateSectionProjectView } from '../../entity/sectionProjectView/sectionProjectViewReducer';
+import { RootState } from '../../reducer';
+import { ZeniAPI } from '../../zeniAPI';
+import { fetchOpExForTimeframeProjectView, updateOpExForTimeframeProjectView, updateOpExForTimeframeProjectViewFailure } from './opExProjectViewReducer';
+export type ActionType = ReturnType<typeof fetchOpExForTimeframeProjectView> | ReturnType<typeof updateOpExForTimeframeProjectView> | ReturnType<typeof updateOpExForTimeframeProjectViewFailure> | ReturnType<typeof updateProjects> | ReturnType<typeof updateSectionProjectView>;
+export declare const fetchOpExForTimeframeProjectViewEpic: (actions$: ActionsObservable<ActionType>, _: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/opExProjectView/opExForTimeframeProjectViewEpic.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchOpExForTimeframeProjectViewEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const projectReducer_1 = require("../../entity/project/projectReducer");
+const sectionProjectViewReducer_1 = require("../../entity/sectionProjectView/sectionProjectViewReducer");
+const responsePayload_1 = require("../../responsePayload");
+const opExProjectViewReducer_1 = require("./opExProjectViewReducer");
+const fetchOpExForTimeframeProjectViewEpic = (actions$, _, zeniAPI) => actions$.pipe((0, operators_1.filter)(opExProjectViewReducer_1.fetchOpExForTimeframeProjectView.match), (0, operators_1.mergeMap)((action) => {
+    const getTimeSeriesGroup = (timeframe) => {
+        switch (timeframe) {
+            case 'month':
+                return 'months';
+            case 'quarter':
+                return 'quarters';
+            case 'year':
+                return 'years';
+        }
+    };
+    const queryValue = {
+        is_full_response: action.payload.fetchFullReport,
+        time_series_groups: [getTimeSeriesGroup(action.payload.timeframe)],
+        is_group_by_project: true,
+    };
+    return zeniAPI
+        .getJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/2.0/reports/operating_expenses?query=${encodeURIComponent(JSON.stringify(queryValue))}`)
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if (response.data != null && (0, responsePayload_1.isSuccessResponse)(response)) {
+            const actions = [];
+            const report = response.data.report;
+            const currency = report.currency;
+            actions.push((0, projectReducer_1.updateProjects)(report.projects));
+            actions.push((0, sectionProjectViewReducer_1.updateSectionProjectView)(action.payload.timeframe, 'expenses', 'operating_expenses_by_projects', report.expenses, report.accounts, currency));
+            actions.push((0, opExProjectViewReducer_1.updateOpExForTimeframeProjectView)({
+                timeframe: action.payload.timeframe,
+                report: response.data,
+            }));
+            return (0, rxjs_1.from)(actions);
+        }
+        else {
+            return (0, rxjs_1.of)((0, opExProjectViewReducer_1.updateOpExForTimeframeProjectViewFailure)(response.status, action.payload.timeframe));
+        }
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, opExProjectViewReducer_1.updateOpExForTimeframeProjectViewFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'OpEx by Projects REST API call errored out' +
+        (error instanceof Error ? error.message : String(error))), action.payload.timeframe))));
+}));
+exports.fetchOpExForTimeframeProjectViewEpic = fetchOpExForTimeframeProjectViewEpic;

package/lib/view/opExProjectView/opExProjectViewEpic.d.ts

@@ -0,0 +1,6 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../reducer';
+import { fetchOpExForTimeframeProjectView, fetchOpExProjectView } from './opExProjectViewReducer';
+export type ActionType = ReturnType<typeof fetchOpExProjectView> | ReturnType<typeof fetchOpExForTimeframeProjectView>;
+export declare const fetchOpExProjectViewEpic: (actions$: ActionsObservable<ActionType>, state: StateObservable<RootState>) => Observable<ActionType>;

package/lib/view/opExProjectView/opExProjectViewEpic.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchOpExProjectViewEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const opExProjectViewReducer_1 = require("./opExProjectViewReducer");
+const fetchOpExProjectViewEpic = (actions$, state) => actions$.pipe((0, operators_1.filter)(opExProjectViewReducer_1.fetchOpExProjectView.match), (0, operators_1.switchMap)((action) => {
+    const { cacheOverride } = action.payload;
+    if (cacheOverride === true) {
+        return (0, rxjs_1.from)([
+            (0, opExProjectViewReducer_1.fetchOpExForTimeframeProjectView)('month'),
+            (0, opExProjectViewReducer_1.fetchOpExForTimeframeProjectView)('quarter'),
+            (0, opExProjectViewReducer_1.fetchOpExForTimeframeProjectView)('year'),
+        ]);
+    }
+    else {
+        const fetchActions = [];
+        const projectFetchState = state.value.opExProjectViewState.fetchState;
+        if (projectFetchState['month'].fetchState !== 'In-Progress' &&
+            projectFetchState['month'].fetchState !== 'Completed') {
+            fetchActions.push((0, opExProjectViewReducer_1.fetchOpExForTimeframeProjectView)('month'));
+        }
+        if (projectFetchState['quarter'].fetchState !== 'In-Progress' &&
+            projectFetchState['quarter'].fetchState !== 'Completed') {
+            fetchActions.push((0, opExProjectViewReducer_1.fetchOpExForTimeframeProjectView)('quarter'));
+        }
+        if (projectFetchState['year'].fetchState !== 'In-Progress' &&
+            projectFetchState['year'].fetchState !== 'Completed') {
+            fetchActions.push((0, opExProjectViewReducer_1.fetchOpExForTimeframeProjectView)('year'));
+        }
+        return (0, rxjs_1.from)(fetchActions);
+    }
+}));
+exports.fetchOpExProjectViewEpic = fetchOpExProjectViewEpic;

package/lib/view/opExProjectView/opExProjectViewPayload.d.ts

@@ -0,0 +1,6 @@
+import { ZeniReportResponse } from '../../responsePayload';
+import { ReportByProjectMetadataPayloadV2, SectionByProjectCOABalanceGroupedPayloadV2 } from '../profitAndLossProjectView/profitAndLossProjectViewPayload';
+export interface OpExProjectViewPayload extends ReportByProjectMetadataPayloadV2 {
+    expenses: SectionByProjectCOABalanceGroupedPayloadV2;
+}
+export type OpExReportProjectViewResponse = ZeniReportResponse<OpExProjectViewPayload>;

package/lib/view/opExProjectView/opExProjectViewPayload.js

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

package/lib/view/opExProjectView/opExProjectViewReducer.d.ts

@@ -0,0 +1,33 @@
+import { AccountViewMode, ID } from '../../commonStateTypes/common';
+import { ZeniAPIStatus, ZeniReportData } from '../../responsePayload';
+import { OpExProjectViewPayload } from './opExProjectViewPayload';
+import { OpExProjectViewState } from './opExProjectViewState';
+export declare const initialState: OpExProjectViewState;
+export declare const fetchOpExProjectView: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[cacheOverride?: boolean | undefined], {
+    cacheOverride: boolean;
+}, "opExProjectView/fetchOpExProjectView", never, never>, fetchOpExForTimeframeProjectView: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[timeframe: "month" | "year" | "quarter", fetchFullReport?: boolean | undefined, cacheOverride?: boolean | undefined], {
+    timeframe: "month" | "year" | "quarter";
+    fetchFullReport: boolean;
+    cacheOverride: boolean;
+}, "opExProjectView/fetchOpExForTimeframeProjectView", never, never>, updateOpExForTimeframeProjectView: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    report: ZeniReportData<OpExProjectViewPayload>;
+    timeframe: "month" | "quarter" | "year";
+}, "opExProjectView/updateOpExForTimeframeProjectView">, updateOpExForTimeframeProjectViewFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[error: ZeniAPIStatus<Record<string, unknown>>, timeframe: "month" | "year" | "quarter"], {
+    error: ZeniAPIStatus<Record<string, unknown>>;
+    timeframe: "month" | "year" | "quarter";
+}, "opExProjectView/updateOpExForTimeframeProjectViewFailure", never, never>, updateProjectsToFilterOut: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    projectsToFilterOut: ID[];
+}, "opExProjectView/updateProjectsToFilterOut">, updateOpExProjectViewUIState: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    nodeCollapseState?: {
+        isCollapsed: boolean;
+        nodeId: ID;
+    };
+    scrollPosition?: {
+        scrollTop: number;
+        scrollLeft?: number;
+    };
+}, "opExProjectView/updateOpExProjectViewUIState">, updateProjectViewAccountViewMode: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    viewMode: AccountViewMode;
+}, "opExProjectView/updateProjectViewAccountViewMode">, resetProjectNodeCollapseState: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"opExProjectView/resetProjectNodeCollapseState">, clearOpExProjectView: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"opExProjectView/clearOpExProjectView">;
+declare const _default: import("redux").Reducer<OpExProjectViewState>;
+export default _default;

package/lib/view/opExProjectView/opExProjectViewReducer.js

@@ -0,0 +1,115 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearOpExProjectView = exports.resetProjectNodeCollapseState = exports.updateProjectViewAccountViewMode = exports.updateOpExProjectViewUIState = exports.updateProjectsToFilterOut = exports.updateOpExForTimeframeProjectViewFailure = exports.updateOpExForTimeframeProjectView = exports.fetchOpExForTimeframeProjectView = exports.fetchOpExProjectView = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const viewAndReportPayloadv2_1 = require("../../commonPayloadTypes/v2/viewAndReportPayloadv2");
+exports.initialState = {
+    fetchState: {
+        month: {
+            fetchState: 'Not-Started',
+            error: undefined,
+        },
+        quarter: {
+            fetchState: 'Not-Started',
+            error: undefined,
+        },
+        year: {
+            fetchState: 'Not-Started',
+            error: undefined,
+        },
+    },
+    firstMonthOfFY: 1,
+    projectIds: [],
+    reportId: 'operating_expenses_by_projects',
+    reportTitle: 'operating_expenses_by_projects',
+    uiState: {
+        accountViewMode: 'account_group',
+        nodeCollapseState: {},
+        projectsToFilterOut: [],
+        scrollPosition: undefined,
+    },
+};
+const opExProjectView = (0, toolkit_1.createSlice)({
+    name: 'opExProjectView',
+    initialState: exports.initialState,
+    reducers: {
+        fetchOpExProjectView: {
+            prepare(cacheOverride = false) {
+                return { payload: { cacheOverride } };
+            },
+            reducer(
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _draft, 
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _action) {
+                // nothing to do here
+            },
+        },
+        fetchOpExForTimeframeProjectView: {
+            prepare(timeframe, fetchFullReport = true, cacheOverride = false) {
+                return { payload: { timeframe, fetchFullReport, cacheOverride } };
+            },
+            reducer(draft, action) {
+                const timeframe = action.payload.timeframe;
+                draft.fetchState[timeframe].fetchState = 'In-Progress';
+                draft.fetchState[timeframe].error = undefined;
+            },
+        },
+        updateOpExForTimeframeProjectView(draft, action) {
+            doUpdateOpExProjectView(draft, action.payload.timeframe, action.payload.report);
+        },
+        updateOpExForTimeframeProjectViewFailure: {
+            prepare(error, timeframe) {
+                return {
+                    payload: {
+                        error,
+                        timeframe,
+                    },
+                };
+            },
+            reducer(draft, action) {
+                draft.fetchState[action.payload.timeframe] = {
+                    fetchState: 'Error',
+                    error: action.payload.error,
+                };
+            },
+        },
+        updateProjectsToFilterOut(draft, action) {
+            draft.uiState.projectsToFilterOut = action.payload.projectsToFilterOut;
+        },
+        updateOpExProjectViewUIState(draft, action) {
+            const { nodeCollapseState, scrollPosition } = action.payload;
+            if (nodeCollapseState != null) {
+                draft.uiState.nodeCollapseState = Object.assign({}, draft.uiState.nodeCollapseState, {
+                    [nodeCollapseState.nodeId]: nodeCollapseState.isCollapsed,
+                });
+            }
+            if (scrollPosition != null) {
+                draft.uiState.scrollPosition = scrollPosition;
+            }
+        },
+        updateProjectViewAccountViewMode(draft, action) {
+            draft.uiState.accountViewMode = action.payload.viewMode;
+        },
+        resetProjectNodeCollapseState(draft) {
+            draft.uiState.nodeCollapseState = {};
+        },
+        clearOpExProjectView(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = opExProjectView.actions, exports.fetchOpExProjectView = _a.fetchOpExProjectView, exports.fetchOpExForTimeframeProjectView = _a.fetchOpExForTimeframeProjectView, exports.updateOpExForTimeframeProjectView = _a.updateOpExForTimeframeProjectView, exports.updateOpExForTimeframeProjectViewFailure = _a.updateOpExForTimeframeProjectViewFailure, exports.updateProjectsToFilterOut = _a.updateProjectsToFilterOut, exports.updateOpExProjectViewUIState = _a.updateOpExProjectViewUIState, exports.updateProjectViewAccountViewMode = _a.updateProjectViewAccountViewMode, exports.resetProjectNodeCollapseState = _a.resetProjectNodeCollapseState, exports.clearOpExProjectView = _a.clearOpExProjectView;
+exports.default = opExProjectView.reducer;
+const doUpdateOpExProjectView = (draft, timeframe, opExReport) => {
+    const report = (0, viewAndReportPayloadv2_1.mapReportPayloadV2ToReportV2)(opExReport.report);
+    draft.dataAvailable = report.dataAvailable;
+    draft.firstMonthOfFY = report.firstMonthOfFY;
+    draft.bookCloseDate = report.bookCloseDate;
+    draft.status = report.status;
+    draft.fetchState[timeframe].fetchState = 'Completed';
+    if (draft.projectIds.length <= 0) {
+        draft.projectIds = opExReport.report.projects.map((project) => project.accounting_project_id);
+    }
+};

package/lib/view/opExProjectView/opExProjectViewSelector.d.ts

@@ -0,0 +1,12 @@
+import { COABalancesFilterProjectView } from '../../commonStateTypes/coaBalance/coaBalancesFilterProjectView';
+import { AccountState } from '../../entity/account/accountState';
+import { ProjectState } from '../../entity/project/projectReducer';
+import { SectionProjectViewState } from '../../entity/sectionProjectView/sectionProjectViewState';
+import { RootState } from '../../reducer';
+import { OpExClassesViewCalculatedSectionID, OpExClassesViewSectionID } from '../opExClassesView/opExClassesViewSelectorTypes';
+import { OpExProjectViewReport } from './opExProjectViewSelectorTypes';
+import { OpExProjectViewState } from './opExProjectViewState';
+export declare const opExProjectIdsInOrder: (OpExClassesViewSectionID | OpExClassesViewCalculatedSectionID)[];
+export declare const getOpExProjectView: (filter: COABalancesFilterProjectView, accountState: AccountState, projectState: ProjectState, sectionsState: SectionProjectViewState, opExProjectViewState: OpExProjectViewState) => OpExProjectViewReport;
+export declare const getOpExProjectViewForSelectedRange: (state: RootState) => OpExProjectViewReport;
+export declare const getOpExProjectViewForHighlightedRange: (state: RootState) => OpExProjectViewReport;