@zeniai/client-epic-state 5.1.32 → 5.1.34-betaAK0

package/lib/view/invoicing/invoicingCustomerListView/invoicingCustomerListViewReducer.d.ts

@@ -0,0 +1,31 @@
+import { ID } from '../../../commonStateTypes/common';
+import { InvoicingListCounts } from '../../../entity/invoicing/invoicingCommonPayload';
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { InvoicingListSort } from '../invoicingApiHelper';
+import { InvoicingCustomerFilters, InvoicingCustomerListViewState } from './invoicingCustomerListViewState';
+export declare const initialState: InvoicingCustomerListViewState;
+export declare const fetchInvoicingCustomerList: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    cursor?: string;
+    filters?: InvoicingCustomerFilters;
+    keepExistingListItems?: boolean;
+    sort?: InvoicingListSort;
+}], {
+    filters: InvoicingCustomerFilters;
+    cursor: string | undefined;
+    keepExistingListItems: boolean;
+    sort: InvoicingListSort | undefined;
+}, "invoicingCustomerListView/fetchInvoicingCustomerList", never, never>, fetchInvoicingCustomerListPage: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    cacheOverride?: boolean;
+    filters?: InvoicingCustomerFilters;
+    sort?: InvoicingListSort;
+}], {
+    cacheOverride: boolean;
+    filters: InvoicingCustomerFilters;
+    sort: InvoicingListSort | undefined;
+}, "invoicingCustomerListView/fetchInvoicingCustomerListPage", never, never>, updateInvoicingCustomerList: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    ids: ID[];
+    keepExistingListItems: boolean;
+    nextCursor: string | null;
+}, "invoicingCustomerListView/updateInvoicingCustomerList">, updateInvoicingCustomerListFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingCustomerListView/updateInvoicingCustomerListFailure">, fetchInvoicingCustomerCounts: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingCustomerListView/fetchInvoicingCustomerCounts">, updateInvoicingCustomerCounts: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingListCounts, "invoicingCustomerListView/updateInvoicingCustomerCounts">, updateInvoicingCustomerCountsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingCustomerListView/updateInvoicingCustomerCountsFailure">, updateInvoicingCustomerFilters: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingCustomerFilters, "invoicingCustomerListView/updateInvoicingCustomerFilters">, clearInvoicingCustomerListView: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingCustomerListView/clearInvoicingCustomerListView">;
+declare const _default: import("redux").Reducer<InvoicingCustomerListViewState>;
+export default _default;

package/lib/view/invoicing/invoicingCustomerListView/invoicingCustomerListViewReducer.js

@@ -0,0 +1,93 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearInvoicingCustomerListView = exports.updateInvoicingCustomerFilters = exports.updateInvoicingCustomerCountsFailure = exports.updateInvoicingCustomerCounts = exports.fetchInvoicingCustomerCounts = exports.updateInvoicingCustomerListFailure = exports.updateInvoicingCustomerList = exports.fetchInvoicingCustomerListPage = exports.fetchInvoicingCustomerList = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+exports.initialState = {
+    fetchState: 'Not-Started',
+    error: undefined,
+    ids: [],
+    nextCursor: null,
+    filters: {},
+    counts: { all: 0 },
+    countsFetchState: { fetchState: 'Not-Started', error: undefined },
+    hasValidState() {
+        return this.fetchState === 'Completed';
+    },
+};
+const invoicingCustomerListView = (0, toolkit_1.createSlice)({
+    name: 'invoicingCustomerListView',
+    initialState: exports.initialState,
+    reducers: {
+        fetchInvoicingCustomerList: {
+            reducer(draft, action) {
+                if (!action.payload.keepExistingListItems) {
+                    draft.ids = [];
+                    draft.nextCursor = null;
+                }
+                draft.filters = action.payload.filters;
+                draft.sort = action.payload.sort;
+                draft.fetchState = 'In-Progress';
+                draft.error = undefined;
+            },
+            prepare(payload) {
+                return {
+                    payload: {
+                        filters: payload.filters ?? {},
+                        cursor: payload.cursor,
+                        keepExistingListItems: payload.keepExistingListItems ?? false,
+                        sort: payload.sort,
+                    },
+                };
+            },
+        },
+        fetchInvoicingCustomerListPage: {
+            reducer(draft, action) {
+                draft.filters = action.payload.filters;
+                draft.sort = action.payload.sort;
+            },
+            prepare(payload) {
+                return {
+                    payload: {
+                        cacheOverride: payload.cacheOverride ?? false,
+                        filters: payload.filters ?? {},
+                        sort: payload.sort,
+                    },
+                };
+            },
+        },
+        updateInvoicingCustomerList(draft, action) {
+            draft.ids = action.payload.keepExistingListItems
+                ? [...new Set([...draft.ids, ...action.payload.ids])]
+                : action.payload.ids;
+            draft.nextCursor = action.payload.nextCursor;
+            draft.fetchState = 'Completed';
+            draft.error = undefined;
+        },
+        updateInvoicingCustomerListFailure(draft, action) {
+            draft.fetchState = 'Error';
+            draft.error = action.payload;
+        },
+        fetchInvoicingCustomerCounts(draft) {
+            draft.countsFetchState.fetchState = 'In-Progress';
+            draft.countsFetchState.error = undefined;
+        },
+        updateInvoicingCustomerCounts(draft, action) {
+            draft.counts = action.payload;
+            draft.countsFetchState.fetchState = 'Completed';
+            draft.countsFetchState.error = undefined;
+        },
+        updateInvoicingCustomerCountsFailure(draft, action) {
+            draft.countsFetchState.fetchState = 'Error';
+            draft.countsFetchState.error = action.payload;
+        },
+        updateInvoicingCustomerFilters(draft, action) {
+            draft.filters = action.payload;
+        },
+        clearInvoicingCustomerListView(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = invoicingCustomerListView.actions, exports.fetchInvoicingCustomerList = _a.fetchInvoicingCustomerList, exports.fetchInvoicingCustomerListPage = _a.fetchInvoicingCustomerListPage, exports.updateInvoicingCustomerList = _a.updateInvoicingCustomerList, exports.updateInvoicingCustomerListFailure = _a.updateInvoicingCustomerListFailure, exports.fetchInvoicingCustomerCounts = _a.fetchInvoicingCustomerCounts, exports.updateInvoicingCustomerCounts = _a.updateInvoicingCustomerCounts, exports.updateInvoicingCustomerCountsFailure = _a.updateInvoicingCustomerCountsFailure, exports.updateInvoicingCustomerFilters = _a.updateInvoicingCustomerFilters, exports.clearInvoicingCustomerListView = _a.clearInvoicingCustomerListView;
+exports.default = invoicingCustomerListView.reducer;

package/lib/view/invoicing/invoicingCustomerListView/invoicingCustomerListViewSelector.d.ts

@@ -0,0 +1,12 @@
+import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
+import { InvoicingListCounts } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingCustomer } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerState';
+import { RootState } from '../../../reducer';
+import { InvoicingCustomerFilters } from './invoicingCustomerListViewState';
+export interface InvoicingCustomerListView extends SelectorView {
+    count: InvoicingListCounts;
+    customers: InvoicingCustomer[];
+    filters: InvoicingCustomerFilters;
+    nextCursor: string | null;
+}
+export declare const getInvoicingCustomerListView: (state: RootState) => InvoicingCustomerListView;

package/lib/view/invoicing/invoicingCustomerListView/invoicingCustomerListViewSelector.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingCustomerListView = void 0;
+const invoicingCustomerSelector_1 = require("../../../entity/invoicing/invoicingCustomer/invoicingCustomerSelector");
+const getInvoicingCustomerListView = (state) => ({
+    customers: (0, invoicingCustomerSelector_1.getInvoicingCustomersByIds)(state.invoicingCustomerState, state.invoicingCustomerListViewState.ids),
+    fetchState: state.invoicingCustomerListViewState.fetchState,
+    error: state.invoicingCustomerListViewState.error,
+    nextCursor: state.invoicingCustomerListViewState.nextCursor,
+    filters: state.invoicingCustomerListViewState.filters,
+    count: state.invoicingCustomerListViewState.counts,
+});
+exports.getInvoicingCustomerListView = getInvoicingCustomerListView;

package/lib/view/invoicing/invoicingCustomerListView/invoicingCustomerListViewState.d.ts

@@ -0,0 +1,16 @@
+import { FetchStateAndError, FetchedState, ID } from '../../../commonStateTypes/common';
+import { InvoicingListCounts } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingListSort } from '../invoicingApiHelper';
+export interface InvoicingCustomerFilters {
+    search?: string;
+    status?: string;
+}
+export interface InvoicingCustomerListViewState extends FetchedState {
+    counts: InvoicingListCounts;
+    countsFetchState: FetchStateAndError;
+    filters: InvoicingCustomerFilters;
+    ids: ID[];
+    nextCursor: string | null;
+    /** Active server-side sort (undefined = backend default order). */
+    sort?: InvoicingListSort;
+}

package/lib/view/invoicing/invoicingCustomerListView/invoicingCustomerListViewState.js

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

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewChurnEpic.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 { fetchInvoicingOverviewChurn, updateInvoicingOverviewChurn, updateInvoicingOverviewChurnFailure } from '../invoicingOverviewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingOverviewChurn> | ReturnType<typeof updateInvoicingOverviewChurn> | ReturnType<typeof updateInvoicingOverviewChurnFailure>;
+export declare const fetchInvoicingOverviewChurnEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewChurnEpic.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingOverviewChurnEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../responsePayload");
+const invoicingOverviewReducer_1 = require("../invoicingOverviewReducer");
+const fetchInvoicingOverviewChurnEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingOverviewReducer_1.fetchInvoicingOverviewChurn.match), (0, operators_1.switchMap)(() => {
+    const { period } = state$.value.invoicingOverviewState;
+    if (period == null) {
+        return rxjs_1.EMPTY;
+    }
+    const base = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    return zeniAPI
+        .getJSON(`${base}/analytics/churn?months=6&year=${period.year}&month=${period.month}`)
+        .pipe((0, operators_1.switchMap)((response) => (0, responsePayload_1.isSuccessResponse)(response) && response.data != null
+        ? (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewChurn)(response.data))
+        : (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewChurnFailure)(response.status))), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewChurnFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch overview churn REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingOverviewChurnEpic = fetchInvoicingOverviewChurnEpic;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewDashboardSummaryEpic.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 { fetchInvoicingOverviewDashboardSummary, updateInvoicingOverviewDashboardSummary, updateInvoicingOverviewDashboardSummaryFailure } from '../invoicingOverviewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingOverviewDashboardSummary> | ReturnType<typeof updateInvoicingOverviewDashboardSummary> | ReturnType<typeof updateInvoicingOverviewDashboardSummaryFailure>;
+export declare const fetchInvoicingOverviewDashboardSummaryEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewDashboardSummaryEpic.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingOverviewDashboardSummaryEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../responsePayload");
+const invoicingOverviewReducer_1 = require("../invoicingOverviewReducer");
+const fetchInvoicingOverviewDashboardSummaryEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingOverviewReducer_1.fetchInvoicingOverviewDashboardSummary.match), (0, operators_1.switchMap)(() => {
+    const { period } = state$.value.invoicingOverviewState;
+    if (period == null) {
+        return rxjs_1.EMPTY;
+    }
+    const base = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    return zeniAPI
+        .getJSON(`${base}/analytics/dashboard-summary?year=${period.year}&month=${period.month}`)
+        .pipe((0, operators_1.switchMap)((response) => (0, responsePayload_1.isSuccessResponse)(response) && response.data != null
+        ? (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewDashboardSummary)(response.data))
+        : (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewDashboardSummaryFailure)(response.status))), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewDashboardSummaryFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch overview dashboard summary REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingOverviewDashboardSummaryEpic = fetchInvoicingOverviewDashboardSummaryEpic;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewEpic.d.ts

@@ -0,0 +1,14 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../../reducer';
+import { fetchInvoicingSettings } from '../../settingsView/settingsViewReducer';
+import { fetchInvoicingSubscriptionList } from '../../invoicingSubscriptionListView/invoicingSubscriptionListViewReducer';
+import { clearInvoicingOverview, fetchInvoicingOverviewChurn, fetchInvoicingOverviewDashboardSummary, fetchInvoicingOverviewKPIs, fetchInvoicingOverviewMRR, fetchInvoicingOverviewPlanRevenue, fetchInvoicingOverviewRevenue, fetchInvoicingOverview, updateInvoicingOverviewChurn, updateInvoicingOverviewChurnFailure, updateInvoicingOverviewDashboardSummary, updateInvoicingOverviewDashboardSummaryFailure, updateInvoicingOverviewKPIs, updateInvoicingOverviewKPIsFailure, updateInvoicingOverviewMRR, updateInvoicingOverviewMRRFailure, updateInvoicingOverviewPlanRevenue, updateInvoicingOverviewPlanRevenueFailure, updateInvoicingOverviewRevenue, updateInvoicingOverviewRevenueFailure } from '../invoicingOverviewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingOverview> | ReturnType<typeof fetchInvoicingOverviewKPIs> | ReturnType<typeof updateInvoicingOverviewKPIs> | ReturnType<typeof updateInvoicingOverviewKPIsFailure> | ReturnType<typeof fetchInvoicingOverviewRevenue> | ReturnType<typeof updateInvoicingOverviewRevenue> | ReturnType<typeof updateInvoicingOverviewRevenueFailure> | ReturnType<typeof fetchInvoicingOverviewMRR> | ReturnType<typeof updateInvoicingOverviewMRR> | ReturnType<typeof updateInvoicingOverviewMRRFailure> | ReturnType<typeof fetchInvoicingOverviewChurn> | ReturnType<typeof updateInvoicingOverviewChurn> | ReturnType<typeof updateInvoicingOverviewChurnFailure> | ReturnType<typeof fetchInvoicingOverviewPlanRevenue> | ReturnType<typeof updateInvoicingOverviewPlanRevenue> | ReturnType<typeof updateInvoicingOverviewPlanRevenueFailure> | ReturnType<typeof fetchInvoicingOverviewDashboardSummary> | ReturnType<typeof updateInvoicingOverviewDashboardSummary> | ReturnType<typeof updateInvoicingOverviewDashboardSummaryFailure> | ReturnType<typeof clearInvoicingOverview> | ReturnType<typeof fetchInvoicingSettings> | ReturnType<typeof fetchInvoicingSubscriptionList>;
+/**
+ * Orchestrates the overview: on `fetchInvoicingOverview`, fans out to each
+ * per-endpoint fetch (the six analytics calls plus settings and the
+ * subscription list), skipping any whose data is already cached unless
+ * `cacheOverride` is set.
+ */
+export declare const fetchInvoicingOverviewEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewEpic.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingOverviewEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const settingsViewReducer_1 = require("../../settingsView/settingsViewReducer");
+const settingsViewSelector_1 = require("../../settingsView/settingsViewSelector");
+const invoicingSubscriptionListViewReducer_1 = require("../../invoicingSubscriptionListView/invoicingSubscriptionListViewReducer");
+const invoicingSubscriptionListViewSelector_1 = require("../../invoicingSubscriptionListView/invoicingSubscriptionListViewSelector");
+const invoicingOverviewReducer_1 = require("../invoicingOverviewReducer");
+/**
+ * Fetch unless the endpoint is already loaded or in flight \u2014 or always when the
+ * caller forces a refresh via `cacheOverride` (e.g. on a period change).
+ */
+const shouldFetch = (fetchStateAndError, cacheOverride) => cacheOverride ||
+    (fetchStateAndError.fetchState !== 'Completed' &&
+        fetchStateAndError.fetchState !== 'In-Progress');
+/**
+ * Orchestrates the overview: on `fetchInvoicingOverview`, fans out to each
+ * per-endpoint fetch (the six analytics calls plus settings and the
+ * subscription list), skipping any whose data is already cached unless
+ * `cacheOverride` is set.
+ */
+const fetchInvoicingOverviewEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(invoicingOverviewReducer_1.fetchInvoicingOverview.match), (0, operators_1.mergeMap)((action) => {
+    const { cacheOverride } = action.payload;
+    const rootState = state$.value;
+    const state = rootState.invoicingOverviewState;
+    const overviewActions = [];
+    if (shouldFetch(state.kpisFetchState, cacheOverride)) {
+        overviewActions.push((0, invoicingOverviewReducer_1.fetchInvoicingOverviewKPIs)());
+    }
+    if (shouldFetch(state.revenueFetchState, cacheOverride)) {
+        overviewActions.push((0, invoicingOverviewReducer_1.fetchInvoicingOverviewRevenue)());
+    }
+    if (shouldFetch(state.mrrFetchState, cacheOverride)) {
+        overviewActions.push((0, invoicingOverviewReducer_1.fetchInvoicingOverviewMRR)());
+    }
+    if (shouldFetch(state.churnFetchState, cacheOverride)) {
+        overviewActions.push((0, invoicingOverviewReducer_1.fetchInvoicingOverviewChurn)());
+    }
+    if (shouldFetch(state.planRevenueFetchState, cacheOverride)) {
+        overviewActions.push((0, invoicingOverviewReducer_1.fetchInvoicingOverviewPlanRevenue)());
+    }
+    if (shouldFetch(state.summaryFetchState, cacheOverride)) {
+        overviewActions.push((0, invoicingOverviewReducer_1.fetchInvoicingOverviewDashboardSummary)());
+    }
+    if (shouldFetch((0, settingsViewSelector_1.getInvoicingSettingsFetchState)(rootState), cacheOverride)) {
+        overviewActions.push((0, settingsViewReducer_1.fetchInvoicingSettings)());
+    }
+    const subscriptionListView = (0, invoicingSubscriptionListViewSelector_1.getInvoicingSubscriptionListView)(rootState);
+    if (shouldFetch({
+        fetchState: subscriptionListView.fetchState,
+        error: subscriptionListView.error,
+    }, cacheOverride)) {
+        overviewActions.push((0, invoicingSubscriptionListViewReducer_1.fetchInvoicingSubscriptionList)({}));
+    }
+    return (0, rxjs_1.concat)((0, rxjs_1.from)(overviewActions));
+}));
+exports.fetchInvoicingOverviewEpic = fetchInvoicingOverviewEpic;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewKPIsEpic.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 { fetchInvoicingOverviewKPIs, updateInvoicingOverviewKPIs, updateInvoicingOverviewKPIsFailure } from '../invoicingOverviewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingOverviewKPIs> | ReturnType<typeof updateInvoicingOverviewKPIs> | ReturnType<typeof updateInvoicingOverviewKPIsFailure>;
+export declare const fetchInvoicingOverviewKPIsEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewKPIsEpic.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingOverviewKPIsEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../responsePayload");
+const invoicingOverviewReducer_1 = require("../invoicingOverviewReducer");
+const fetchInvoicingOverviewKPIsEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingOverviewReducer_1.fetchInvoicingOverviewKPIs.match), (0, operators_1.switchMap)(() => {
+    const { period } = state$.value.invoicingOverviewState;
+    if (period == null) {
+        return rxjs_1.EMPTY;
+    }
+    const base = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    return zeniAPI
+        .getJSON(`${base}/analytics/kpis?year=${period.year}&month=${period.month}`)
+        .pipe((0, operators_1.switchMap)((response) => (0, responsePayload_1.isSuccessResponse)(response) && response.data != null
+        ? (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewKPIs)(response.data))
+        : (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewKPIsFailure)(response.status))), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewKPIsFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch overview KPIs REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingOverviewKPIsEpic = fetchInvoicingOverviewKPIsEpic;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewMRREpic.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 { fetchInvoicingOverviewMRR, updateInvoicingOverviewMRR, updateInvoicingOverviewMRRFailure } from '../invoicingOverviewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingOverviewMRR> | ReturnType<typeof updateInvoicingOverviewMRR> | ReturnType<typeof updateInvoicingOverviewMRRFailure>;
+export declare const fetchInvoicingOverviewMRREpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewMRREpic.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingOverviewMRREpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../responsePayload");
+const invoicingOverviewReducer_1 = require("../invoicingOverviewReducer");
+const fetchInvoicingOverviewMRREpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingOverviewReducer_1.fetchInvoicingOverviewMRR.match), (0, operators_1.switchMap)(() => {
+    const { period } = state$.value.invoicingOverviewState;
+    if (period == null) {
+        return rxjs_1.EMPTY;
+    }
+    const base = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    return zeniAPI
+        .getJSON(`${base}/analytics/mrr?months=6&year=${period.year}&month=${period.month}`)
+        .pipe((0, operators_1.switchMap)((response) => (0, responsePayload_1.isSuccessResponse)(response) && response.data != null
+        ? (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewMRR)(response.data))
+        : (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewMRRFailure)(response.status))), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewMRRFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch overview MRR REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingOverviewMRREpic = fetchInvoicingOverviewMRREpic;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewPlanRevenueEpic.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 { fetchInvoicingOverviewPlanRevenue, updateInvoicingOverviewPlanRevenue, updateInvoicingOverviewPlanRevenueFailure } from '../invoicingOverviewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingOverviewPlanRevenue> | ReturnType<typeof updateInvoicingOverviewPlanRevenue> | ReturnType<typeof updateInvoicingOverviewPlanRevenueFailure>;
+export declare const fetchInvoicingOverviewPlanRevenueEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewPlanRevenueEpic.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingOverviewPlanRevenueEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../responsePayload");
+const invoicingOverviewReducer_1 = require("../invoicingOverviewReducer");
+const fetchInvoicingOverviewPlanRevenueEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingOverviewReducer_1.fetchInvoicingOverviewPlanRevenue.match), (0, operators_1.switchMap)(() => {
+    const { period } = state$.value.invoicingOverviewState;
+    if (period == null) {
+        return rxjs_1.EMPTY;
+    }
+    const base = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    return zeniAPI
+        .getJSON(`${base}/analytics/plan-revenue?year=${period.year}&month=${period.month}`)
+        .pipe((0, operators_1.switchMap)((response) => (0, responsePayload_1.isSuccessResponse)(response) && response.data != null
+        ? (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewPlanRevenue)(response.data))
+        : (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewPlanRevenueFailure)(response.status))), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewPlanRevenueFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch overview plan revenue REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingOverviewPlanRevenueEpic = fetchInvoicingOverviewPlanRevenueEpic;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewRevenueEpic.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 { fetchInvoicingOverviewRevenue, updateInvoicingOverviewRevenue, updateInvoicingOverviewRevenueFailure } from '../invoicingOverviewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingOverviewRevenue> | ReturnType<typeof updateInvoicingOverviewRevenue> | ReturnType<typeof updateInvoicingOverviewRevenueFailure>;
+export declare const fetchInvoicingOverviewRevenueEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoicingOverview/epics/fetchInvoicingOverviewRevenueEpic.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingOverviewRevenueEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../responsePayload");
+const invoicingOverviewReducer_1 = require("../invoicingOverviewReducer");
+const fetchInvoicingOverviewRevenueEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingOverviewReducer_1.fetchInvoicingOverviewRevenue.match), (0, operators_1.switchMap)(() => {
+    const { period } = state$.value.invoicingOverviewState;
+    if (period == null) {
+        return rxjs_1.EMPTY;
+    }
+    const base = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0`;
+    return zeniAPI
+        .getJSON(`${base}/analytics/revenue?months=12&year=${period.year}&month=${period.month}`)
+        .pipe((0, operators_1.switchMap)((response) => (0, responsePayload_1.isSuccessResponse)(response) && response.data != null
+        ? (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewRevenue)(response.data))
+        : (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewRevenueFailure)(response.status))), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingOverviewReducer_1.updateInvoicingOverviewRevenueFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch overview revenue REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingOverviewRevenueEpic = fetchInvoicingOverviewRevenueEpic;

package/lib/view/invoicing/invoicingOverview/invoicingOverviewPayload.d.ts

@@ -0,0 +1,98 @@
+import { ZeniAPIResponse } from '../../../responsePayload';
+import { InvoicingChurnDataPoint, InvoicingDashboardSummary, InvoicingMRRDataPoint, InvoicingOverviewKPIs, InvoicingPlanRevenuePoint, InvoicingRevenueDataPoint } from './invoicingOverviewState';
+export interface InvoicingOverviewKPIsPayload {
+    active_customers: number;
+    active_subscriptions: number;
+    arr: number;
+    churn_rate: number;
+    mrr: number;
+    ltv?: number;
+    net_revenue_retention?: number;
+}
+export interface InvoicingRevenueDataPointPayload {
+    month: string;
+    revenue: number;
+    arr?: number;
+}
+export interface InvoicingMRRDataPointPayload {
+    month: string;
+    mrr: number;
+    churned?: number;
+    expansion?: number;
+    month_num?: number;
+    net?: number;
+    new?: number;
+    start_mrr?: number;
+    year?: number;
+}
+export interface InvoicingChurnDataPointPayload {
+    month: string;
+    rate: number;
+    churned?: number;
+    subscribers?: number;
+}
+export interface InvoicingPlanRevenuePointPayload {
+    mrr: number;
+    pct: number;
+    plan: string;
+}
+export interface InvoicingDashboardSummaryPayload {
+    customer_movement: {
+        churned: number;
+        net_change: number;
+        new: number;
+        paused: number;
+        reactivated: number;
+        resumed: number;
+        total_active: number;
+        total_active_value: number;
+    };
+    failed_payments: {
+        amount: number;
+        count: number;
+    };
+    grr: {
+        churn: number;
+        contraction: number;
+        grr: number;
+        retained_arr: number;
+        starting_arr: number;
+    };
+    mrr_movement: {
+        churned: number;
+        expansions: number;
+        net_change: number;
+        new_subscriptions: number;
+    };
+    nrr: {
+        churn: number;
+        contraction: number;
+        ending_arr: number;
+        expansion_arr: number;
+        nrr: number;
+        starting_arr: number;
+    };
+    outstanding: number;
+    past_due_invoices: {
+        amount: number;
+        count: number;
+    };
+    upcoming_invoices: {
+        amount: number;
+        count: number;
+    };
+    /** Period-over-period change in outstanding balance, e.g. -6.7. */
+    outstanding_change_pct?: number;
+}
+export type InvoicingOverviewKPIsResponse = ZeniAPIResponse<InvoicingOverviewKPIsPayload>;
+export type InvoicingOverviewRevenueResponse = ZeniAPIResponse<InvoicingRevenueDataPointPayload[]>;
+export type InvoicingOverviewMRRResponse = ZeniAPIResponse<InvoicingMRRDataPointPayload[]>;
+export type InvoicingOverviewChurnResponse = ZeniAPIResponse<InvoicingChurnDataPointPayload[]>;
+export type InvoicingOverviewPlanRevenueResponse = ZeniAPIResponse<InvoicingPlanRevenuePointPayload[]>;
+export type InvoicingOverviewDashboardSummaryResponse = ZeniAPIResponse<InvoicingDashboardSummaryPayload>;
+export declare const mapInvoicingOverviewKPIsPayloadToState: (payload: InvoicingOverviewKPIsPayload) => InvoicingOverviewKPIs;
+export declare const mapInvoicingRevenueDataPointPayloadToState: (payload: InvoicingRevenueDataPointPayload) => InvoicingRevenueDataPoint;
+export declare const mapInvoicingMRRDataPointPayloadToState: (payload: InvoicingMRRDataPointPayload) => InvoicingMRRDataPoint;
+export declare const mapInvoicingChurnDataPointPayloadToState: (payload: InvoicingChurnDataPointPayload) => InvoicingChurnDataPoint;
+export declare const mapInvoicingPlanRevenuePointPayloadToState: (payload: InvoicingPlanRevenuePointPayload) => InvoicingPlanRevenuePoint;
+export declare const mapInvoicingDashboardSummaryPayloadToState: (payload: InvoicingDashboardSummaryPayload) => InvoicingDashboardSummary;