@zeniai/client-epic-state 5.1.37 → 5.1.39-betaAK0

package/lib/view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewState.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INVOICING_DUNNING_CASE_TABS = exports.toInvoicingDunningCaseTabId = exports.ALL_INVOICING_DUNNING_CASE_TAB_IDS = exports.INVOICING_DUNNING_CASE_COLUMNS = exports.toInvoicingDunningCaseSortKey = exports.ALL_INVOICING_DUNNING_CASE_SORT_KEYS = void 0;
+const stringToUnion_1 = require("../../../commonStateTypes/stringToUnion");
+exports.ALL_INVOICING_DUNNING_CASE_SORT_KEYS = [
+    'customer',
+    'invoice',
+    'attempts',
+    'nextRetry',
+    'daysPastDue',
+    'failureReason',
+    'status',
+    'amount',
+];
+const toInvoicingDunningCaseSortKey = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.ALL_INVOICING_DUNNING_CASE_SORT_KEYS);
+exports.toInvoicingDunningCaseSortKey = toInvoicingDunningCaseSortKey;
+exports.INVOICING_DUNNING_CASE_COLUMNS = [
+    { key: 'customer', sortable: true },
+    { key: 'invoice', sortable: true },
+    { key: 'attempts', sortable: true },
+    { key: 'nextRetry', sortable: true },
+    { key: 'daysPastDue', sortable: true },
+    { key: 'failureReason', sortable: false },
+    { key: 'status', sortable: true },
+    { key: 'amount', sortable: true },
+];
+exports.ALL_INVOICING_DUNNING_CASE_TAB_IDS = [
+    'all',
+    'Retrying',
+    'Scheduled',
+    'Manual Review',
+    'Resolved',
+    'Cancelled',
+];
+const toInvoicingDunningCaseTabId = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.ALL_INVOICING_DUNNING_CASE_TAB_IDS);
+exports.toInvoicingDunningCaseTabId = toInvoicingDunningCaseTabId;
+/**
+ * Ordered filter-tab id set owned by CES so the dunning-cases-list tabs live
+ * next to the model rather than being hardcoded in web-components. Tab labels
+ * and the per-tab count lookup stay in the view layer; this only carries the id
+ * set and display order.
+ */
+exports.INVOICING_DUNNING_CASE_TABS = [
+    ...exports.ALL_INVOICING_DUNNING_CASE_TAB_IDS,
+];

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 { fetchInvoicingSubscriptionList } from '../../invoicingSubscriptionListView/invoicingSubscriptionListViewReducer';
+import { fetchInvoicingSettings } from '../../settingsView/settingsViewReducer';
+import { clearInvoicingOverview, fetchInvoicingOverview, fetchInvoicingOverviewChurn, fetchInvoicingOverviewDashboardSummary, fetchInvoicingOverviewKPIs, fetchInvoicingOverviewMRR, fetchInvoicingOverviewPlanRevenue, fetchInvoicingOverviewRevenue, 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 invoicingSubscriptionListViewReducer_1 = require("../../invoicingSubscriptionListView/invoicingSubscriptionListViewReducer");
+const invoicingSubscriptionListViewSelector_1 = require("../../invoicingSubscriptionListView/invoicingSubscriptionListViewSelector");
+const settingsViewReducer_1 = require("../../settingsView/settingsViewReducer");
+const settingsViewSelector_1 = require("../../settingsView/settingsViewSelector");
+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;

package/lib/view/invoicing/invoicingOverview/invoicingOverviewPayload.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingDashboardSummaryPayloadToState = exports.mapInvoicingPlanRevenuePointPayloadToState = exports.mapInvoicingChurnDataPointPayloadToState = exports.mapInvoicingMRRDataPointPayloadToState = exports.mapInvoicingRevenueDataPointPayloadToState = exports.mapInvoicingOverviewKPIsPayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const mapInvoicingOverviewKPIsPayloadToState = (payload) => ({
+    activeCustomers: payload.active_customers,
+    activeSubscriptions: payload.active_subscriptions,
+    arr: (0, amount_1.toAmount)(payload.arr, 'USD', '$'),
+    churnRate: payload.churn_rate,
+    mrr: (0, amount_1.toAmount)(payload.mrr, 'USD', '$'),
+    ltv: payload.ltv,
+    netRevenueRetention: payload.net_revenue_retention,
+});
+exports.mapInvoicingOverviewKPIsPayloadToState = mapInvoicingOverviewKPIsPayloadToState;
+const mapInvoicingRevenueDataPointPayloadToState = (payload) => ({
+    month: payload.month,
+    revenue: (0, amount_1.toAmount)(payload.revenue, 'USD', '$'),
+    arr: payload.arr != null ? (0, amount_1.toAmount)(payload.arr, 'USD', '$') : undefined,
+});
+exports.mapInvoicingRevenueDataPointPayloadToState = mapInvoicingRevenueDataPointPayloadToState;
+const mapInvoicingMRRDataPointPayloadToState = (payload) => ({
+    month: payload.month,
+    mrr: (0, amount_1.toAmount)(payload.mrr, 'USD', '$'),
+    churned: payload.churned,
+    expansion: payload.expansion,
+    monthNum: payload.month_num,
+    net: payload.net,
+    new: payload.new,
+    startMrr: payload.start_mrr != null
+        ? (0, amount_1.toAmount)(payload.start_mrr, 'USD', '$')
+        : undefined,
+    year: payload.year,
+});
+exports.mapInvoicingMRRDataPointPayloadToState = mapInvoicingMRRDataPointPayloadToState;
+const mapInvoicingChurnDataPointPayloadToState = (payload) => ({
+    month: payload.month,
+    rate: payload.rate,
+    churned: payload.churned,
+    subscribers: payload.subscribers,
+});
+exports.mapInvoicingChurnDataPointPayloadToState = mapInvoicingChurnDataPointPayloadToState;
+const mapInvoicingPlanRevenuePointPayloadToState = (payload) => ({
+    mrr: (0, amount_1.toAmount)(payload.mrr, 'USD', '$'),
+    pct: payload.pct,
+    planID: payload.plan,
+});
+exports.mapInvoicingPlanRevenuePointPayloadToState = mapInvoicingPlanRevenuePointPayloadToState;
+const mapInvoicingDashboardSummaryPayloadToState = (payload) => ({
+    customerMovement: {
+        churned: payload.customer_movement.churned,
+        netChange: payload.customer_movement.net_change,
+        new: payload.customer_movement.new,
+        paused: payload.customer_movement.paused,
+        reactivated: payload.customer_movement.reactivated,
+        resumed: payload.customer_movement.resumed,
+        totalActive: payload.customer_movement.total_active,
+        totalActiveValue: (0, amount_1.toAmount)(payload.customer_movement.total_active_value, 'USD', '$'),
+    },
+    failedPayments: {
+        amount: (0, amount_1.toAmount)(payload.failed_payments.amount, 'USD', '$'),
+        count: payload.failed_payments.count,
+    },
+    grossRevenueRetention: {
+        churn: (0, amount_1.toAmount)(payload.grr.churn, 'USD', '$'),
+        contraction: (0, amount_1.toAmount)(payload.grr.contraction, 'USD', '$'),
+        grr: payload.grr.grr,
+        retainedArr: (0, amount_1.toAmount)(payload.grr.retained_arr, 'USD', '$'),
+        startingArr: (0, amount_1.toAmount)(payload.grr.starting_arr, 'USD', '$'),
+    },
+    mrrMovement: {
+        churned: payload.mrr_movement.churned,
+        expansions: payload.mrr_movement.expansions,
+        netChange: payload.mrr_movement.net_change,
+        newSubscriptions: payload.mrr_movement.new_subscriptions,
+    },
+    netRevenueRetention: {
+        churn: (0, amount_1.toAmount)(payload.nrr.churn, 'USD', '$'),
+        contraction: (0, amount_1.toAmount)(payload.nrr.contraction, 'USD', '$'),
+        endingArr: (0, amount_1.toAmount)(payload.nrr.ending_arr, 'USD', '$'),
+        expansionArr: (0, amount_1.toAmount)(payload.nrr.expansion_arr, 'USD', '$'),
+        nrr: payload.nrr.nrr,
+        startingArr: (0, amount_1.toAmount)(payload.nrr.starting_arr, 'USD', '$'),
+    },
+    outstanding: (0, amount_1.toAmount)(payload.outstanding, 'USD', '$'),
+    pastDueInvoices: {
+        amount: (0, amount_1.toAmount)(payload.past_due_invoices.amount, 'USD', '$'),
+        count: payload.past_due_invoices.count,
+    },
+    upcomingInvoices: {
+        amount: (0, amount_1.toAmount)(payload.upcoming_invoices.amount, 'USD', '$'),
+        count: payload.upcoming_invoices.count,
+    },
+    outstandingChangePct: payload.outstanding_change_pct,
+});
+exports.mapInvoicingDashboardSummaryPayloadToState = mapInvoicingDashboardSummaryPayloadToState;

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

@@ -0,0 +1,10 @@
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { InvoicingChurnDataPointPayload, InvoicingDashboardSummaryPayload, InvoicingMRRDataPointPayload, InvoicingOverviewKPIsPayload, InvoicingPlanRevenuePointPayload, InvoicingRevenueDataPointPayload } from './invoicingOverviewPayload';
+import { InvoicingOverviewPeriod, InvoicingOverviewState } from './invoicingOverviewState';
+export declare const initialState: InvoicingOverviewState;
+export declare const fetchInvoicingOverview: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[period: InvoicingOverviewPeriod, cacheOverride?: any], {
+    period: InvoicingOverviewPeriod;
+    cacheOverride: any;
+}, "invoicingOverview/fetchInvoicingOverview", never, never>, fetchInvoicingOverviewKPIs: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingOverview/fetchInvoicingOverviewKPIs">, updateInvoicingOverviewKPIs: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingOverviewKPIsPayload, "invoicingOverview/updateInvoicingOverviewKPIs">, updateInvoicingOverviewKPIsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingOverview/updateInvoicingOverviewKPIsFailure">, fetchInvoicingOverviewRevenue: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingOverview/fetchInvoicingOverviewRevenue">, updateInvoicingOverviewRevenue: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingRevenueDataPointPayload[], "invoicingOverview/updateInvoicingOverviewRevenue">, updateInvoicingOverviewRevenueFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingOverview/updateInvoicingOverviewRevenueFailure">, fetchInvoicingOverviewMRR: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingOverview/fetchInvoicingOverviewMRR">, updateInvoicingOverviewMRR: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingMRRDataPointPayload[], "invoicingOverview/updateInvoicingOverviewMRR">, updateInvoicingOverviewMRRFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingOverview/updateInvoicingOverviewMRRFailure">, fetchInvoicingOverviewChurn: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingOverview/fetchInvoicingOverviewChurn">, updateInvoicingOverviewChurn: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingChurnDataPointPayload[], "invoicingOverview/updateInvoicingOverviewChurn">, updateInvoicingOverviewChurnFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingOverview/updateInvoicingOverviewChurnFailure">, fetchInvoicingOverviewPlanRevenue: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingOverview/fetchInvoicingOverviewPlanRevenue">, updateInvoicingOverviewPlanRevenue: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingPlanRevenuePointPayload[], "invoicingOverview/updateInvoicingOverviewPlanRevenue">, updateInvoicingOverviewPlanRevenueFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingOverview/updateInvoicingOverviewPlanRevenueFailure">, fetchInvoicingOverviewDashboardSummary: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingOverview/fetchInvoicingOverviewDashboardSummary">, updateInvoicingOverviewDashboardSummary: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingDashboardSummaryPayload, "invoicingOverview/updateInvoicingOverviewDashboardSummary">, updateInvoicingOverviewDashboardSummaryFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingOverview/updateInvoicingOverviewDashboardSummaryFailure">, clearInvoicingOverview: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingOverview/clearInvoicingOverview">;
+declare const _default: import("redux").Reducer<InvoicingOverviewState>;
+export default _default;