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

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>;

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

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingSubscriptionListEpic = 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 invoicingApiHelper_1 = require("../../invoicingApiHelper");
+const invoicingSubscriptionListViewReducer_1 = require("../invoicingSubscriptionListViewReducer");
+const buildQuery = (filters, cursor, sort) => {
+    const params = new URLSearchParams();
+    if (filters.status != null && filters.status.length > 0) {
+        params.set('status', filters.status);
+    }
+    if (filters.customerId != null) {
+        params.set('customer_id', filters.customerId);
+    }
+    if (filters.search != null && filters.search.length > 0) {
+        params.set('search', filters.search);
+    }
+    if (filters.startedFrom != null) {
+        params.set('started_from', filters.startedFrom);
+    }
+    if (filters.startedTo != null) {
+        params.set('started_to', filters.startedTo);
+    }
+    params.set('limit', String(invoicingApiHelper_1.INVOICING_LIST_PAGE_SIZE));
+    if (cursor != null) {
+        params.set('cursor', cursor);
+    }
+    (0, invoicingApiHelper_1.applyListSortParams)(params, sort);
+    return params;
+};
+const fetchInvoicingSubscriptionListEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(invoicingSubscriptionListViewReducer_1.fetchInvoicingSubscriptionList.match), (0, operators_1.switchMap)((action) => {
+    const { filters, cursor, keepExistingListItems, sort } = action.payload;
+    const apiUrl = (0, invoicingApiHelper_1.withQuery)(`${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/subscriptions`, buildQuery(filters, cursor, sort));
+    return zeniAPI.getJSON(apiUrl).pipe((0, operators_1.switchMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response)) {
+            const items = response.data?.items ?? [];
+            return [
+                (0, invoicingSubscriptionReducer_1.updateInvoicingSubscriptions)(items, 'merge'),
+                (0, invoicingSubscriptionListViewReducer_1.updateInvoicingSubscriptionList)({
+                    ids: items.map((item) => item.id),
+                    nextCursor: response.data?.next_cursor ?? null,
+                    keepExistingListItems,
+                }),
+            ];
+        }
+        return (0, rxjs_1.of)((0, invoicingSubscriptionListViewReducer_1.updateInvoicingSubscriptionListFailure)(response.status));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, invoicingSubscriptionListViewReducer_1.updateInvoicingSubscriptionListFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch subscription list REST API call errored out ' +
+        JSON.stringify(error))))));
+}));
+exports.fetchInvoicingSubscriptionListEpic = fetchInvoicingSubscriptionListEpic;

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

@@ -0,0 +1,16 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateInvoicingSubscriptions } from '../../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer';
+import { RootState } from '../../../../reducer';
+import { fetchInvoicingSubscriptionCounts, fetchInvoicingSubscriptionList, fetchInvoicingSubscriptionListPage, updateInvoicingSubscriptionCounts, updateInvoicingSubscriptionCountsFailure, updateInvoicingSubscriptionList, updateInvoicingSubscriptionListFailure } from '../invoicingSubscriptionListViewReducer';
+/**
+ * Aggregate of every action emitted across the subscription list view epics.
+ * Wired into the root action union for this view.
+ */
+export type ActionType = ReturnType<typeof fetchInvoicingSubscriptionList> | ReturnType<typeof fetchInvoicingSubscriptionListPage> | ReturnType<typeof fetchInvoicingSubscriptionCounts> | ReturnType<typeof updateInvoicingSubscriptionList> | ReturnType<typeof updateInvoicingSubscriptionListFailure> | ReturnType<typeof updateInvoicingSubscriptionCounts> | ReturnType<typeof updateInvoicingSubscriptionCountsFailure> | ReturnType<typeof updateInvoicingSubscriptions>;
+/**
+ * Orchestrates the subscriptions list page: on `fetchInvoicingSubscriptionListPage`,
+ * fans out to the list and counts fetches, skipping either one whose data is
+ * already cached unless `cacheOverride` is set (e.g. on a filter/sort change).
+ */
+export declare const fetchInvoicingSubscriptionListPageEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

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

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchInvoicingSubscriptionListPageEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const invoicingSubscriptionListViewReducer_1 = require("../invoicingSubscriptionListViewReducer");
+/**
+ * Fetch unless the endpoint is already loaded or in flight — or always when the
+ * caller forces a refresh via `cacheOverride` (e.g. on a filter/sort change).
+ */
+const shouldFetch = (fetchStateAndError, cacheOverride) => cacheOverride ||
+    (fetchStateAndError.fetchState !== 'Completed' &&
+        fetchStateAndError.fetchState !== 'In-Progress');
+/**
+ * Orchestrates the subscriptions list page: on `fetchInvoicingSubscriptionListPage`,
+ * fans out to the list and counts fetches, skipping either one whose data is
+ * already cached unless `cacheOverride` is set (e.g. on a filter/sort change).
+ */
+const fetchInvoicingSubscriptionListPageEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(invoicingSubscriptionListViewReducer_1.fetchInvoicingSubscriptionListPage.match), (0, operators_1.mergeMap)((action) => {
+    const { cacheOverride, filters, sort } = action.payload;
+    const state = state$.value.invoicingSubscriptionListViewState;
+    const pageActions = [];
+    if (shouldFetch({ fetchState: state.fetchState, error: state.error }, cacheOverride)) {
+        pageActions.push((0, invoicingSubscriptionListViewReducer_1.fetchInvoicingSubscriptionList)({ filters, sort }));
+    }
+    if (shouldFetch(state.countsFetchState, cacheOverride)) {
+        pageActions.push((0, invoicingSubscriptionListViewReducer_1.fetchInvoicingSubscriptionCounts)());
+    }
+    return (0, rxjs_1.concat)((0, rxjs_1.from)(pageActions));
+}));
+exports.fetchInvoicingSubscriptionListPageEpic = fetchInvoicingSubscriptionListPageEpic;

package/lib/view/invoicing/invoicingSubscriptionListView/invoicingSubscriptionListViewPayload.d.ts

@@ -0,0 +1,5 @@
+import { InvoicingListCounts, InvoicingPaginatedList } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingSubscriptionPayload } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionPayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+export type InvoicingSubscriptionListResponse = ZeniAPIResponse<InvoicingPaginatedList<InvoicingSubscriptionPayload>>;
+export type InvoicingSubscriptionCountsResponse = ZeniAPIResponse<InvoicingListCounts>;

package/lib/view/invoicing/invoicingSubscriptionListView/invoicingSubscriptionListViewPayload.js

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

package/lib/view/invoicing/invoicingSubscriptionListView/invoicingSubscriptionListViewReducer.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 { InvoicingSubscriptionFilters, InvoicingSubscriptionListViewState } from './invoicingSubscriptionListViewState';
+export declare const initialState: InvoicingSubscriptionListViewState;
+export declare const fetchInvoicingSubscriptionList: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    cursor?: string;
+    filters?: InvoicingSubscriptionFilters;
+    keepExistingListItems?: boolean;
+    sort?: InvoicingListSort;
+}], {
+    filters: InvoicingSubscriptionFilters;
+    cursor: string | undefined;
+    keepExistingListItems: boolean;
+    sort: InvoicingListSort | undefined;
+}, "invoicingSubscriptionListView/fetchInvoicingSubscriptionList", never, never>, fetchInvoicingSubscriptionListPage: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    cacheOverride?: boolean;
+    filters?: InvoicingSubscriptionFilters;
+    sort?: InvoicingListSort;
+}], {
+    cacheOverride: boolean;
+    filters: InvoicingSubscriptionFilters;
+    sort: InvoicingListSort | undefined;
+}, "invoicingSubscriptionListView/fetchInvoicingSubscriptionListPage", never, never>, updateInvoicingSubscriptionList: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    ids: ID[];
+    keepExistingListItems: boolean;
+    nextCursor: string | null;
+}, "invoicingSubscriptionListView/updateInvoicingSubscriptionList">, updateInvoicingSubscriptionListFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingSubscriptionListView/updateInvoicingSubscriptionListFailure">, fetchInvoicingSubscriptionCounts: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingSubscriptionListView/fetchInvoicingSubscriptionCounts">, updateInvoicingSubscriptionCounts: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingListCounts, "invoicingSubscriptionListView/updateInvoicingSubscriptionCounts">, updateInvoicingSubscriptionCountsFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<ZeniAPIStatus<Record<string, unknown>>, "invoicingSubscriptionListView/updateInvoicingSubscriptionCountsFailure">, updateInvoicingSubscriptionFilters: import("@reduxjs/toolkit").ActionCreatorWithPayload<InvoicingSubscriptionFilters, "invoicingSubscriptionListView/updateInvoicingSubscriptionFilters">, clearInvoicingSubscriptionListView: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingSubscriptionListView/clearInvoicingSubscriptionListView">;
+declare const _default: import("redux").Reducer<InvoicingSubscriptionListViewState>;
+export default _default;

package/lib/view/invoicing/invoicingSubscriptionListView/invoicingSubscriptionListViewReducer.js

@@ -0,0 +1,93 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearInvoicingSubscriptionListView = exports.updateInvoicingSubscriptionFilters = exports.updateInvoicingSubscriptionCountsFailure = exports.updateInvoicingSubscriptionCounts = exports.fetchInvoicingSubscriptionCounts = exports.updateInvoicingSubscriptionListFailure = exports.updateInvoicingSubscriptionList = exports.fetchInvoicingSubscriptionListPage = exports.fetchInvoicingSubscriptionList = 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 invoicingSubscriptionListView = (0, toolkit_1.createSlice)({
+    name: 'invoicingSubscriptionListView',
+    initialState: exports.initialState,
+    reducers: {
+        fetchInvoicingSubscriptionList: {
+            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,
+                    },
+                };
+            },
+        },
+        fetchInvoicingSubscriptionListPage: {
+            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,
+                    },
+                };
+            },
+        },
+        updateInvoicingSubscriptionList(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;
+        },
+        updateInvoicingSubscriptionListFailure(draft, action) {
+            draft.fetchState = 'Error';
+            draft.error = action.payload;
+        },
+        fetchInvoicingSubscriptionCounts(draft) {
+            draft.countsFetchState.fetchState = 'In-Progress';
+            draft.countsFetchState.error = undefined;
+        },
+        updateInvoicingSubscriptionCounts(draft, action) {
+            draft.counts = action.payload;
+            draft.countsFetchState.fetchState = 'Completed';
+            draft.countsFetchState.error = undefined;
+        },
+        updateInvoicingSubscriptionCountsFailure(draft, action) {
+            draft.countsFetchState.fetchState = 'Error';
+            draft.countsFetchState.error = action.payload;
+        },
+        updateInvoicingSubscriptionFilters(draft, action) {
+            draft.filters = action.payload;
+        },
+        clearInvoicingSubscriptionListView(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = invoicingSubscriptionListView.actions, exports.fetchInvoicingSubscriptionList = _a.fetchInvoicingSubscriptionList, exports.fetchInvoicingSubscriptionListPage = _a.fetchInvoicingSubscriptionListPage, exports.updateInvoicingSubscriptionList = _a.updateInvoicingSubscriptionList, exports.updateInvoicingSubscriptionListFailure = _a.updateInvoicingSubscriptionListFailure, exports.fetchInvoicingSubscriptionCounts = _a.fetchInvoicingSubscriptionCounts, exports.updateInvoicingSubscriptionCounts = _a.updateInvoicingSubscriptionCounts, exports.updateInvoicingSubscriptionCountsFailure = _a.updateInvoicingSubscriptionCountsFailure, exports.updateInvoicingSubscriptionFilters = _a.updateInvoicingSubscriptionFilters, exports.clearInvoicingSubscriptionListView = _a.clearInvoicingSubscriptionListView;
+exports.default = invoicingSubscriptionListView.reducer;

package/lib/view/invoicing/invoicingSubscriptionListView/invoicingSubscriptionListViewSelector.d.ts

@@ -0,0 +1,19 @@
+import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
+import { InvoicingListCounts } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingSubscription } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionState';
+import { RootState } from '../../../reducer';
+import { InvoicingSubscriptionFilters } from './invoicingSubscriptionListViewState';
+export interface InvoicingSubscriptionListView extends SelectorView {
+    count: InvoicingListCounts;
+    filters: InvoicingSubscriptionFilters;
+    nextCursor: string | null;
+    subscriptions: InvoicingSubscription[];
+}
+/**
+ * Memoized so the denormalized `subscriptions` array (and the wrapping view
+ * object) keep referential identity until the subscription entity slice or the
+ * list-view slice actually change. Without this, the connected list page
+ * re-rendered on every unrelated redux action because a fresh array was built
+ * each call.
+ */
+export declare const getInvoicingSubscriptionListView: (state: RootState) => InvoicingSubscriptionListView;