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

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;

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

@@ -0,0 +1,119 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearInvoicingOverview = exports.updateInvoicingOverviewDashboardSummaryFailure = exports.updateInvoicingOverviewDashboardSummary = exports.fetchInvoicingOverviewDashboardSummary = exports.updateInvoicingOverviewPlanRevenueFailure = exports.updateInvoicingOverviewPlanRevenue = exports.fetchInvoicingOverviewPlanRevenue = exports.updateInvoicingOverviewChurnFailure = exports.updateInvoicingOverviewChurn = exports.fetchInvoicingOverviewChurn = exports.updateInvoicingOverviewMRRFailure = exports.updateInvoicingOverviewMRR = exports.fetchInvoicingOverviewMRR = exports.updateInvoicingOverviewRevenueFailure = exports.updateInvoicingOverviewRevenue = exports.fetchInvoicingOverviewRevenue = exports.updateInvoicingOverviewKPIsFailure = exports.updateInvoicingOverviewKPIs = exports.fetchInvoicingOverviewKPIs = exports.fetchInvoicingOverview = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const invoicingOverviewPayload_1 = require("./invoicingOverviewPayload");
+const notStarted = { fetchState: 'Not-Started', error: undefined };
+exports.initialState = {
+    churn: [],
+    kpis: undefined,
+    mrr: [],
+    period: undefined,
+    planRevenue: [],
+    revenue: [],
+    summary: undefined,
+    churnFetchState: { ...notStarted },
+    kpisFetchState: { ...notStarted },
+    mrrFetchState: { ...notStarted },
+    planRevenueFetchState: { ...notStarted },
+    revenueFetchState: { ...notStarted },
+    summaryFetchState: { ...notStarted },
+};
+const invoicingOverview = (0, toolkit_1.createSlice)({
+    name: 'invoicingOverview',
+    initialState: exports.initialState,
+    reducers: {
+        // ── Orchestrator trigger (handled by fetchInvoicingOverviewEpic) ─────────
+        fetchInvoicingOverview: {
+            reducer(draft, action) {
+                draft.period = action.payload.period;
+            },
+            prepare(period, cacheOverride = false) {
+                return {
+                    payload: {
+                        period,
+                        cacheOverride
+                    },
+                };
+            },
+        },
+        // ── KPIs ─────────────────────────────────────────────────────────────────
+        fetchInvoicingOverviewKPIs(draft) {
+            draft.kpisFetchState = { fetchState: 'In-Progress', error: undefined };
+        },
+        updateInvoicingOverviewKPIs(draft, action) {
+            draft.kpis = (0, invoicingOverviewPayload_1.mapInvoicingOverviewKPIsPayloadToState)(action.payload);
+            draft.kpisFetchState = { fetchState: 'Completed', error: undefined };
+        },
+        updateInvoicingOverviewKPIsFailure(draft, action) {
+            draft.kpisFetchState = { fetchState: 'Error', error: action.payload };
+        },
+        // ── Revenue ────────────────────────────────────────────────────────────────
+        fetchInvoicingOverviewRevenue(draft) {
+            draft.revenueFetchState = { fetchState: 'In-Progress', error: undefined };
+        },
+        updateInvoicingOverviewRevenue(draft, action) {
+            draft.revenue = action.payload.map(invoicingOverviewPayload_1.mapInvoicingRevenueDataPointPayloadToState);
+            draft.revenueFetchState = { fetchState: 'Completed', error: undefined };
+        },
+        updateInvoicingOverviewRevenueFailure(draft, action) {
+            draft.revenueFetchState = { fetchState: 'Error', error: action.payload };
+        },
+        // ── MRR ────────────────────────────────────────────────────────────────────
+        fetchInvoicingOverviewMRR(draft) {
+            draft.mrrFetchState = { fetchState: 'In-Progress', error: undefined };
+        },
+        updateInvoicingOverviewMRR(draft, action) {
+            draft.mrr = action.payload.map(invoicingOverviewPayload_1.mapInvoicingMRRDataPointPayloadToState);
+            draft.mrrFetchState = { fetchState: 'Completed', error: undefined };
+        },
+        updateInvoicingOverviewMRRFailure(draft, action) {
+            draft.mrrFetchState = { fetchState: 'Error', error: action.payload };
+        },
+        // ── Churn ──────────────────────────────────────────────────────────────────
+        fetchInvoicingOverviewChurn(draft) {
+            draft.churnFetchState = { fetchState: 'In-Progress', error: undefined };
+        },
+        updateInvoicingOverviewChurn(draft, action) {
+            draft.churn = action.payload.map(invoicingOverviewPayload_1.mapInvoicingChurnDataPointPayloadToState);
+            draft.churnFetchState = { fetchState: 'Completed', error: undefined };
+        },
+        updateInvoicingOverviewChurnFailure(draft, action) {
+            draft.churnFetchState = { fetchState: 'Error', error: action.payload };
+        },
+        // ── Plan revenue ───────────────────────────────────────────────────────────
+        fetchInvoicingOverviewPlanRevenue(draft) {
+            draft.planRevenueFetchState = {
+                fetchState: 'In-Progress',
+                error: undefined,
+            };
+        },
+        updateInvoicingOverviewPlanRevenue(draft, action) {
+            draft.planRevenue = action.payload.map(invoicingOverviewPayload_1.mapInvoicingPlanRevenuePointPayloadToState);
+            draft.planRevenueFetchState = { fetchState: 'Completed', error: undefined };
+        },
+        updateInvoicingOverviewPlanRevenueFailure(draft, action) {
+            draft.planRevenueFetchState = {
+                fetchState: 'Error',
+                error: action.payload,
+            };
+        },
+        // ── Dashboard summary ──────────────────────────────────────────────────────
+        fetchInvoicingOverviewDashboardSummary(draft) {
+            draft.summaryFetchState = { fetchState: 'In-Progress', error: undefined };
+        },
+        updateInvoicingOverviewDashboardSummary(draft, action) {
+            draft.summary = (0, invoicingOverviewPayload_1.mapInvoicingDashboardSummaryPayloadToState)(action.payload);
+            draft.summaryFetchState = { fetchState: 'Completed', error: undefined };
+        },
+        updateInvoicingOverviewDashboardSummaryFailure(draft, action) {
+            draft.summaryFetchState = { fetchState: 'Error', error: action.payload };
+        },
+        clearInvoicingOverview(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = invoicingOverview.actions, exports.fetchInvoicingOverview = _a.fetchInvoicingOverview, exports.fetchInvoicingOverviewKPIs = _a.fetchInvoicingOverviewKPIs, exports.updateInvoicingOverviewKPIs = _a.updateInvoicingOverviewKPIs, exports.updateInvoicingOverviewKPIsFailure = _a.updateInvoicingOverviewKPIsFailure, exports.fetchInvoicingOverviewRevenue = _a.fetchInvoicingOverviewRevenue, exports.updateInvoicingOverviewRevenue = _a.updateInvoicingOverviewRevenue, exports.updateInvoicingOverviewRevenueFailure = _a.updateInvoicingOverviewRevenueFailure, exports.fetchInvoicingOverviewMRR = _a.fetchInvoicingOverviewMRR, exports.updateInvoicingOverviewMRR = _a.updateInvoicingOverviewMRR, exports.updateInvoicingOverviewMRRFailure = _a.updateInvoicingOverviewMRRFailure, exports.fetchInvoicingOverviewChurn = _a.fetchInvoicingOverviewChurn, exports.updateInvoicingOverviewChurn = _a.updateInvoicingOverviewChurn, exports.updateInvoicingOverviewChurnFailure = _a.updateInvoicingOverviewChurnFailure, exports.fetchInvoicingOverviewPlanRevenue = _a.fetchInvoicingOverviewPlanRevenue, exports.updateInvoicingOverviewPlanRevenue = _a.updateInvoicingOverviewPlanRevenue, exports.updateInvoicingOverviewPlanRevenueFailure = _a.updateInvoicingOverviewPlanRevenueFailure, exports.fetchInvoicingOverviewDashboardSummary = _a.fetchInvoicingOverviewDashboardSummary, exports.updateInvoicingOverviewDashboardSummary = _a.updateInvoicingOverviewDashboardSummary, exports.updateInvoicingOverviewDashboardSummaryFailure = _a.updateInvoicingOverviewDashboardSummaryFailure, exports.clearInvoicingOverview = _a.clearInvoicingOverview;
+exports.default = invoicingOverview.reducer;

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

@@ -0,0 +1,32 @@
+import { FetchStateAndError } from '../../../commonStateTypes/common';
+import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
+import { InvoicingSettingsPayload } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingSubscription } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionState';
+import { RootState } from '../../../reducer';
+import { InvoicingChurnDataPoint, InvoicingDashboardSummary, InvoicingMRRDataPoint, InvoicingOverviewKPIs, InvoicingPlanRevenuePoint, InvoicingRevenueDataPoint } from './invoicingOverviewState';
+/** A selectable month in the overview period picker. */
+export interface InvoicingOverviewPeriodOption {
+    label: string;
+    month: number;
+    year: number;
+}
+/** "Jun 1 - Jun 30, 2026" labels for the trailing months, newest first. */
+export declare function buildPeriodOptions(): InvoicingOverviewPeriodOption[];
+/** A single overview metric paired with the fetch state of its API call. */
+export interface InvoicingOverviewMetric<T> {
+    data: T;
+    fetchState: FetchStateAndError;
+}
+/** Every overview metric alongside its individual fetch state. */
+export interface InvoicingOverview extends SelectorView {
+    churn: InvoicingOverviewMetric<InvoicingChurnDataPoint[]>;
+    kpis: InvoicingOverviewMetric<InvoicingOverviewKPIs | undefined>;
+    mrr: InvoicingOverviewMetric<InvoicingMRRDataPoint[]>;
+    periodOptions: InvoicingOverviewPeriodOption[];
+    planRevenue: InvoicingOverviewMetric<InvoicingPlanRevenuePoint[]>;
+    revenue: InvoicingOverviewMetric<InvoicingRevenueDataPoint[]>;
+    settings: InvoicingOverviewMetric<InvoicingSettingsPayload | undefined>;
+    subscriptionList: InvoicingOverviewMetric<InvoicingSubscription[]>;
+    summary: InvoicingOverviewMetric<InvoicingDashboardSummary | undefined>;
+}
+export declare const getInvoicingOverview: (state: RootState) => InvoicingOverview;

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

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingOverview = void 0;
+exports.buildPeriodOptions = buildPeriodOptions;
+const reduceFetchState_1 = require("../../../commonStateTypes/reduceFetchState");
+const settingsViewSelector_1 = require("../settingsView/settingsViewSelector");
+const invoicingSubscriptionListViewSelector_1 = require("../invoicingSubscriptionListView/invoicingSubscriptionListViewSelector");
+const PERIOD_OPTION_MONTHS = 12;
+function daysInMonth(year, month) {
+    return new Date(year, month, 0).getDate();
+}
+/** "Jun 1 - Jun 30, 2026" labels for the trailing months, newest first. */
+function buildPeriodOptions() {
+    const now = new Date();
+    const options = [];
+    for (let offset = 0; offset < PERIOD_OPTION_MONTHS; offset += 1) {
+        const date = new Date(now.getFullYear(), now.getMonth() - offset, 1);
+        const year = date.getFullYear();
+        const month = date.getMonth() + 1;
+        const monthName = date.toLocaleDateString('en-US', { month: 'short' });
+        options.push({
+            label: `${monthName} 1 - ${monthName} ${daysInMonth(year, month)}, ${year}`,
+            month,
+            year,
+        });
+    }
+    return options;
+}
+const getInvoicingOverview = (state) => {
+    const overview = state.invoicingOverviewState;
+    const settingsFetchState = (0, settingsViewSelector_1.getInvoicingSettingsFetchState)(state);
+    const subscriptionListView = (0, invoicingSubscriptionListViewSelector_1.getInvoicingSubscriptionListView)(state);
+    const subscriptionListFetchState = {
+        fetchState: subscriptionListView.fetchState,
+        error: subscriptionListView.error,
+    };
+    const reducedFetchState = (0, reduceFetchState_1.reduceAllFetchState)([
+        overview.kpisFetchState,
+        overview.revenueFetchState,
+        overview.mrrFetchState,
+        overview.churnFetchState,
+        overview.planRevenueFetchState,
+        overview.summaryFetchState,
+        settingsFetchState,
+        subscriptionListFetchState,
+    ]);
+    return {
+        kpis: { data: overview.kpis, fetchState: overview.kpisFetchState },
+        revenue: { data: overview.revenue, fetchState: overview.revenueFetchState },
+        mrr: { data: overview.mrr, fetchState: overview.mrrFetchState },
+        periodOptions: buildPeriodOptions(),
+        churn: { data: overview.churn, fetchState: overview.churnFetchState },
+        planRevenue: {
+            data: overview.planRevenue,
+            fetchState: overview.planRevenueFetchState,
+        },
+        summary: { data: overview.summary, fetchState: overview.summaryFetchState },
+        settings: { data: (0, settingsViewSelector_1.getInvoicingSettings)(state), fetchState: settingsFetchState },
+        subscriptionList: {
+            data: subscriptionListView.subscriptions,
+            fetchState: subscriptionListFetchState,
+        },
+        ...reducedFetchState,
+        version: 1.0,
+    };
+};
+exports.getInvoicingOverview = getInvoicingOverview;

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

@@ -0,0 +1,110 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+export interface InvoicingOverviewPeriod {
+    month: number;
+    year: number;
+}
+export interface InvoicingOverviewKPIs {
+    activeCustomers: number;
+    activeSubscriptions: number;
+    arr: Amount;
+    churnRate: number;
+    mrr: Amount;
+    ltv?: number;
+    netRevenueRetention?: number;
+}
+export interface InvoicingRevenueDataPoint {
+    month: string;
+    revenue: Amount;
+    arr?: Amount;
+}
+export interface InvoicingMRRDataPoint {
+    month: string;
+    mrr: Amount;
+    churned?: number;
+    expansion?: number;
+    monthNum?: number;
+    net?: number;
+    new?: number;
+    startMrr?: Amount;
+    year?: number;
+}
+export interface InvoicingChurnDataPoint {
+    month: string;
+    rate: number;
+    churned?: number;
+    subscribers?: number;
+}
+export interface InvoicingPlanRevenuePoint {
+    mrr: Amount;
+    pct: number;
+    planID: ID;
+}
+export interface InvoicingDashboardSummary {
+    customerMovement: {
+        churned: number;
+        netChange: number;
+        new: number;
+        paused: number;
+        reactivated: number;
+        resumed: number;
+        totalActive: number;
+        totalActiveValue: Amount;
+    };
+    failedPayments: {
+        amount: Amount;
+        count: number;
+    };
+    grossRevenueRetention: {
+        churn: Amount;
+        contraction: Amount;
+        grr: number;
+        retainedArr: Amount;
+        startingArr: Amount;
+    };
+    mrrMovement: {
+        churned: number;
+        expansions: number;
+        netChange: number;
+        newSubscriptions: number;
+    };
+    netRevenueRetention: {
+        churn: Amount;
+        contraction: Amount;
+        endingArr: Amount;
+        expansionArr: Amount;
+        nrr: number;
+        startingArr: Amount;
+    };
+    outstanding: Amount;
+    pastDueInvoices: {
+        amount: Amount;
+        count: number;
+    };
+    upcomingInvoices: {
+        amount: Amount;
+        count: number;
+    };
+    /** Period-over-period change in outstanding balance, e.g. -6.7. */
+    outstandingChangePct?: number;
+}
+export interface InvoicingOverviewData {
+    churn: InvoicingChurnDataPoint[];
+    mrr: InvoicingMRRDataPoint[];
+    planRevenue: InvoicingPlanRevenuePoint[];
+    revenue: InvoicingRevenueDataPoint[];
+    kpis?: InvoicingOverviewKPIs;
+    summary?: InvoicingDashboardSummary;
+}
+/** Independent fetch state for each of the six overview API calls. */
+export interface InvoicingOverviewFetchStates {
+    churnFetchState: FetchStateAndError;
+    kpisFetchState: FetchStateAndError;
+    mrrFetchState: FetchStateAndError;
+    planRevenueFetchState: FetchStateAndError;
+    revenueFetchState: FetchStateAndError;
+    summaryFetchState: FetchStateAndError;
+}
+export interface InvoicingOverviewState extends InvoicingOverviewData, InvoicingOverviewFetchStates {
+    period?: InvoicingOverviewPeriod;
+}

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

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

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewEpics.d.ts

@@ -0,0 +1,8 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateInvoicingSubscriptions } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer';
+import { RootState } from '../../../reducer';
+import { ZeniAPI } from '../../../zeniAPI';
+import { fetchInvoicingSubscriptionDetail, updateInvoicingSubscriptionDetail, updateInvoicingSubscriptionDetailFailure } from './invoicingSubscriptionDetailViewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingSubscriptionDetail> | ReturnType<typeof updateInvoicingSubscriptionDetail> | ReturnType<typeof updateInvoicingSubscriptionDetailFailure> | ReturnType<typeof updateInvoicingSubscriptions>;
+export declare const fetchInvoicingSubscriptionDetailEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewEpics.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingSubscriptionDetailEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const invoicingSubscriptionReducer_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer");
+const responsePayload_1 = require("../../../responsePayload");
+const invoicingSubscriptionDetailViewReducer_1 = require("./invoicingSubscriptionDetailViewReducer");
+const fetchInvoicingSubscriptionDetailEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingSubscriptionDetailViewReducer_1.fetchInvoicingSubscriptionDetail.match), (0, operators_1.switchMap)((action) => {
+    const { id } = action.payload;
+    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/subscriptions/${id}`;
+    return zeniAPI.getJSON(apiUrl).pipe((0, operators_1.switchMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return [
+                (0, invoicingSubscriptionReducer_1.updateInvoicingSubscriptions)([response.data], 'merge'),
+                (0, invoicingSubscriptionDetailViewReducer_1.updateInvoicingSubscriptionDetail)({ id: response.data.id }),
+            ];
+        }
+        return (0, rxjs_1.of)((0, invoicingSubscriptionDetailViewReducer_1.updateInvoicingSubscriptionDetailFailure)(response.status));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingSubscriptionDetailViewReducer_1.updateInvoicingSubscriptionDetailFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch subscription detail REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingSubscriptionDetailEpic = fetchInvoicingSubscriptionDetailEpic;

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewPayload.d.ts

@@ -0,0 +1,3 @@
+import { InvoicingSubscriptionPayload } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionPayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+export type InvoicingSubscriptionDetailResponse = ZeniAPIResponse<InvoicingSubscriptionPayload>;

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewPayload.js

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

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewReducer.d.ts

@@ -0,0 +1,11 @@
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { InvoicingSubscriptionDetailViewState } from './invoicingSubscriptionDetailViewState';
+export declare const initialState: InvoicingSubscriptionDetailViewState;
+export declare const fetchInvoicingSubscriptionDetail: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id: ID;
+}, "invoicingSubscriptionDetailView/fetchInvoicingSubscriptionDetail">, updateInvoicingSubscriptionDetail: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id: ID;
+}, "invoicingSubscriptionDetailView/updateInvoicingSubscriptionDetail">, updateInvoicingSubscriptionDetailFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingSubscriptionDetailView/updateInvoicingSubscriptionDetailFailure">, clearInvoicingSubscriptionDetailView: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingSubscriptionDetailView/clearInvoicingSubscriptionDetailView">;
+declare const _default: import("redux").Reducer<InvoicingSubscriptionDetailViewState>;
+export default _default;

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewReducer.js

@@ -0,0 +1,35 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearInvoicingSubscriptionDetailView = exports.updateInvoicingSubscriptionDetailFailure = exports.updateInvoicingSubscriptionDetail = exports.fetchInvoicingSubscriptionDetail = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+exports.initialState = {
+    fetchState: 'Not-Started',
+    error: undefined,
+    id: undefined,
+};
+const invoicingSubscriptionDetailView = (0, toolkit_1.createSlice)({
+    name: 'invoicingSubscriptionDetailView',
+    initialState: exports.initialState,
+    reducers: {
+        fetchInvoicingSubscriptionDetail(draft, action) {
+            draft.id = action.payload.id;
+            draft.fetchState = 'In-Progress';
+            draft.error = undefined;
+        },
+        updateInvoicingSubscriptionDetail(draft, action) {
+            draft.id = action.payload.id;
+            draft.fetchState = 'Completed';
+            draft.error = undefined;
+        },
+        updateInvoicingSubscriptionDetailFailure(draft, action) {
+            draft.fetchState = 'Error';
+            draft.error = action.payload;
+        },
+        clearInvoicingSubscriptionDetailView(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = invoicingSubscriptionDetailView.actions, exports.fetchInvoicingSubscriptionDetail = _a.fetchInvoicingSubscriptionDetail, exports.updateInvoicingSubscriptionDetail = _a.updateInvoicingSubscriptionDetail, exports.updateInvoicingSubscriptionDetailFailure = _a.updateInvoicingSubscriptionDetailFailure, exports.clearInvoicingSubscriptionDetailView = _a.clearInvoicingSubscriptionDetailView;
+exports.default = invoicingSubscriptionDetailView.reducer;

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewSelector.d.ts

@@ -0,0 +1,15 @@
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
+import { InvoicingSubscription } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionState';
+import { RootState } from '../../../reducer';
+/**
+ * Read-only view for the subscription detail page: the subscription entity + its
+ * fetch state, plus the per-subscription action run-state (cancel/pause/resume)
+ * folded in so the detail screen depends on this single read selector.
+ */
+export interface InvoicingSubscriptionDetailView extends SelectorView {
+    actionState: FetchStateAndError;
+    subscription?: InvoicingSubscription;
+}
+export declare const getInvoicingSubscriptionById: (state: RootState, id: string) => InvoicingSubscription | undefined;
+export declare const getInvoicingSubscriptionDetail: (state: RootState, invoicingSubscriptionID: ID) => InvoicingSubscriptionDetailView;

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewSelector.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingSubscriptionDetail = exports.getInvoicingSubscriptionById = void 0;
+const invoicingSubscriptionSelector_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector");
+const subscriptionActionSelector_1 = require("../subscriptionAction/subscriptionActionSelector");
+const getInvoicingSubscriptionById = (state, id) => (0, invoicingSubscriptionSelector_1.getInvoicingSubscriptionById)(state.invoicingSubscriptionState, id);
+exports.getInvoicingSubscriptionById = getInvoicingSubscriptionById;
+const getInvoicingSubscriptionDetail = (state, invoicingSubscriptionID) => {
+    const { error, fetchState } = state.invoicingSubscriptionDetailViewState;
+    return {
+        actionState: (0, subscriptionActionSelector_1.getInvoicingSubscriptionActionState)(invoicingSubscriptionID)(state),
+        subscription: (0, exports.getInvoicingSubscriptionById)(state, invoicingSubscriptionID),
+        fetchState,
+        error,
+        version: 1.0,
+    };
+};
+exports.getInvoicingSubscriptionDetail = getInvoicingSubscriptionDetail;

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewState.d.ts

@@ -0,0 +1,4 @@
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+export interface InvoicingSubscriptionDetailViewState extends FetchStateAndError {
+    id?: ID;
+}

package/lib/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewState.js

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

package/lib/view/invoicing/invoicingSubscriptionListView/epics/fetchInvoicingSubscriptionCountsEpic.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 { fetchInvoicingSubscriptionCounts, updateInvoicingSubscriptionCounts, updateInvoicingSubscriptionCountsFailure } from '../invoicingSubscriptionListViewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingSubscriptionCounts> | ReturnType<typeof updateInvoicingSubscriptionCounts> | ReturnType<typeof updateInvoicingSubscriptionCountsFailure>;
+export declare const fetchInvoicingSubscriptionCountsEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/invoicingSubscriptionListView/epics/fetchInvoicingSubscriptionCountsEpic.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingSubscriptionCountsEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../../responsePayload");
+const invoicingApiHelper_1 = require("../../invoicingApiHelper");
+const invoicingSubscriptionListViewReducer_1 = require("../invoicingSubscriptionListViewReducer");
+const fetchInvoicingSubscriptionCountsEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingSubscriptionListViewReducer_1.fetchInvoicingSubscriptionCounts.match), (0, operators_1.switchMap)(() => {
+    const { filters } = state$.value.invoicingSubscriptionListViewState;
+    const params = new URLSearchParams();
+    if (filters.search != null && filters.search.length > 0) {
+        params.set('search', filters.search);
+    }
+    if (filters.customerId != null) {
+        params.set('customer_id', filters.customerId);
+    }
+    const apiUrl = (0, invoicingApiHelper_1.withQuery)(`${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/subscriptions/counts`, params);
+    return zeniAPI.getJSON(apiUrl).pipe((0, operators_1.switchMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return (0, rxjs_1.of)((0, invoicingSubscriptionListViewReducer_1.updateInvoicingSubscriptionCounts)(response.data));
+        }
+        return (0, rxjs_1.of)((0, invoicingSubscriptionListViewReducer_1.updateInvoicingSubscriptionCountsFailure)(response.status));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingSubscriptionListViewReducer_1.updateInvoicingSubscriptionCountsFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch subscription counts REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingSubscriptionCountsEpic = fetchInvoicingSubscriptionCountsEpic;

package/lib/view/invoicing/invoicingSubscriptionListView/epics/fetchInvoicingSubscriptionListEpic.d.ts

@@ -0,0 +1,8 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateInvoicingSubscriptions } from '../../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer';
+import { RootState } from '../../../../reducer';
+import { ZeniAPI } from '../../../../zeniAPI';
+import { fetchInvoicingSubscriptionList, updateInvoicingSubscriptionList, updateInvoicingSubscriptionListFailure } from '../invoicingSubscriptionListViewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingSubscriptionList> | ReturnType<typeof updateInvoicingSubscriptionList> | ReturnType<typeof updateInvoicingSubscriptionListFailure> | ReturnType<typeof updateInvoicingSubscriptions>;
+export declare const fetchInvoicingSubscriptionListEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;