@zeniai/client-epic-state 5.2.79 → 5.2.80

package/lib/entity/invoicing/dunningCase/dunningCasePayload.d.ts

@@ -21,6 +21,8 @@ export interface InvoicingDunningCasePayload {
     next_retry?: string;
     paused_reason?: string;
     paused_until?: string;
+    /** The dunning schedule step a retry runs next. */
+    schedule_step?: number | null;
     subscription_id?: string;
 }
 export declare const mapInvoicingDunningCasePayloadToState: (payload: InvoicingDunningCasePayload) => InvoicingDunningCase;

package/lib/entity/invoicing/dunningCase/dunningCasePayload.js

@@ -30,6 +30,7 @@ const mapInvoicingDunningCasePayloadToState = (payload) => {
         nextRetry: payload.next_retry != null ? (0, zeniDayJS_1.date)(payload.next_retry) : undefined,
         pausedReason: payload.paused_reason,
         pausedUntil: payload.paused_until != null ? (0, zeniDayJS_1.date)(payload.paused_until) : undefined,
+        scheduleStep: payload.schedule_step ?? undefined,
         subscriptionID: payload.subscription_id,
     };
 };

package/lib/entity/invoicing/dunningCase/dunningCaseState.d.ts

@@ -22,6 +22,8 @@ export interface InvoicingDunningCase {
     nextRetry?: ZeniDate;
     pausedReason?: string;
     pausedUntil?: ZeniDate;
+    /** The dunning schedule step a retry runs next. */
+    scheduleStep?: number;
     subscriptionID?: ID;
 }
 export interface InvoicingDunningCaseState {

package/lib/esm/entity/invoicing/dunningCase/dunningCasePayload.js

@@ -27,6 +27,7 @@ export const mapInvoicingDunningCasePayloadToState = (payload) => {
         nextRetry: payload.next_retry != null ? date(payload.next_retry) : undefined,
         pausedReason: payload.paused_reason,
         pausedUntil: payload.paused_until != null ? date(payload.paused_until) : undefined,
+        scheduleStep: payload.schedule_step ?? undefined,
         subscriptionID: payload.subscription_id,
     };
 };

package/lib/esm/view/invoicing/invoicingDunningCaseDetailView/fetchInvoicingDunningCaseDetailPageEpic.js

@@ -1,5 +1,7 @@
 import { EMPTY, from } from 'rxjs';
 import { filter, mergeMap, withLatestFrom } from 'rxjs/operators';
+import { fetchInvoicingSettings } from '../settingsView/settingsViewReducer';
+import { getInvoicingSettingsFetchState } from '../settingsView/settingsViewSelector';
 import { fetchInvoicingDunningCaseDetail, fetchInvoicingDunningCaseDetailPage, fetchInvoicingDunningEmailPreviewPage, } from './invoicingDunningCaseDetailViewReducer';
 /**
  * Fetch unless the record is already loaded or in flight — or always when the
@@ -25,5 +27,9 @@ export const fetchInvoicingDunningCaseDetailPageEpic = (actions$, state$) => act
         pageActions.push(fetchInvoicingDunningCaseDetail({ id }));
     }
     pageActions.push(fetchInvoicingDunningEmailPreviewPage({ id, cacheOverride }));
+    // The current step is labelled from the settings schedule.
+    if (shouldFetch(getInvoicingSettingsFetchState(state), false)) {
+        pageActions.push(fetchInvoicingSettings());
+    }
     return pageActions.length > 0 ? from(pageActions) : EMPTY;
 }));

package/lib/esm/view/invoicing/invoicingDunningCaseDetailView/invoicingDunningCaseDetailViewSelector.js

@@ -1,6 +1,8 @@
 import { getInvoicingDunningCaseById as getInvoicingDunningCaseByIdFromState } from '../../../entity/invoicing/dunningCase/dunningCaseSelector';
 import { getInvoiceById } from '../../../entity/invoicing/invoice/invoiceSelector';
 import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { toInvoicingDunningCaseStep, } from '../invoicingDunningCaseListView/invoicingDunningCaseListViewSelector';
+import { getInvoicingSettings } from '../settingsView/settingsViewSelector';
 const EMAIL_PREVIEW_NOT_STARTED = {
     error: undefined,
     fetchState: 'Not-Started',
@@ -16,10 +18,11 @@ export const getInvoicingDunningCaseDetail = (state, invoicingDunningCaseID) =>
             : undefined,
         fieldHelp: invoicingFieldHelpForGroup(state, 'dunning'),
         actionState: state.invoicingDunningCaseDetailViewState.actionStateById[invoicingDunningCaseID] ?? { error: undefined, fetchState: 'Not-Started' },
-        dunningCase: getInvoicingDunningCaseById(state, invoicingDunningCaseID),
+        dunningCase,
         emailPreview: id === invoicingDunningCaseID ? emailPreview : EMAIL_PREVIEW_NOT_STARTED,
         fetchState,
         error,
+        step: toInvoicingDunningCaseStep(dunningCase?.scheduleStep, getInvoicingSettings(state)?.dunning_schedule, state.invoicingConfigViewState.dunningScheduleActionOptions),
         version: 1.0,
     };
 };

package/lib/esm/view/invoicing/invoicingDunningCaseListView/epics/fetchInvoicingDunningCaseListPageEpic.js

@@ -1,6 +1,8 @@
 import { concat, from } from 'rxjs';
 import { filter, mergeMap } from 'rxjs/operators';
 import { getInvoicingListTab, invoicingListSourceTab, planInvoicingListTabFetch, } from '../../invoicingListTabCache';
+import { fetchInvoicingSettings } from '../../settingsView/settingsViewReducer';
+import { getInvoicingSettingsFetchState } from '../../settingsView/settingsViewSelector';
 import { fetchInvoicingDunningCaseCounts, fetchInvoicingDunningCaseList, fetchInvoicingDunningCaseListPage, } from '../invoicingDunningCaseListViewReducer';
 /**
  * Fetch unless the endpoint is already loaded or in flight — or always when the
@@ -36,5 +38,10 @@ export const fetchInvoicingDunningCaseListPageEpic = (actions$, state$) => actio
     if (shouldFetch(state.countsFetchState, cacheOverride)) {
         pageActions.push(fetchInvoicingDunningCaseCounts());
     }
+    // The step column labels steps from the settings schedule; a search or
+    // sort change does not touch settings, so only a missing load fetches.
+    if (shouldFetch(getInvoicingSettingsFetchState(state$.value), false)) {
+        pageActions.push(fetchInvoicingSettings());
+    }
     return concat(from(pageActions));
 }));

package/lib/esm/view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewSelector.js

@@ -3,12 +3,30 @@ import { getInvoicingDunningCasesByIds } from '../../../entity/invoicing/dunning
 import { getInvoicingListTab, invoicingListSourceTab, } from '../invoicingListTabCache';
 import { invoicingTabIdsFromConfig } from '../invoicingTabHelper';
 import { ALL_INVOICING_DUNNING_CASE_TAB_IDS, INVOICING_DUNNING_CASE_COLUMNS, } from './invoicingDunningCaseListViewState';
+/**
+ * Join a case's `scheduleStep` with the tenant's dunning schedule and the
+ * config's action labels. The step alone is still shown when settings have not
+ * loaded or the schedule no longer has that step.
+ */
+export const toInvoicingDunningCaseStep = (scheduleStep, schedule, actionOptions) => {
+    if (scheduleStep == null) {
+        return undefined;
+    }
+    const action = schedule?.find((entry) => entry.step === scheduleStep)?.action;
+    return {
+        actionName: action != null
+            ? actionOptions.find((option) => option.code === action)?.name
+            : undefined,
+        step: scheduleStep,
+        totalSteps: schedule != null && schedule.length > 0 ? schedule.length : undefined,
+    };
+};
 /**
  * Memoized so the denormalized `dunningCases` array (and the wrapping view
  * object) keep referential identity until the dunning-case entity slice or the
  * list-view slice actually change.
  */
-export const getInvoicingDunningCaseListView = createSelector((state) => state.invoicingDunningCaseState, (state) => state.invoicingDunningCaseListViewState, (state) => state.invoicingConfigViewState.dunningCaseStatusOptions, (dunningCaseState, listViewState, statusOptions) => {
+export const getInvoicingDunningCaseListView = createSelector((state) => state.invoicingDunningCaseState, (state) => state.invoicingDunningCaseListViewState, (state) => state.invoicingConfigViewState.dunningCaseStatusOptions, (state) => state.invoicingSettingsViewState.settings?.dunning_schedule, (state) => state.invoicingConfigViewState.dunningScheduleActionOptions, (dunningCaseState, listViewState, statusOptions, schedule, actionOptions) => {
     const { activeTab } = listViewState;
     const tab = getInvoicingListTab(listViewState.byTab, invoicingListSourceTab(activeTab));
     const dunningCases = getInvoicingDunningCasesByIds(dunningCaseState, tab.ids);
@@ -28,6 +46,10 @@ export const getInvoicingDunningCaseListView = createSelector((state) => state.i
             statusOptions,
         }),
         sort: listViewState.sort,
+        stepById: Object.fromEntries(dunningCases.flatMap((dunningCase) => {
+            const step = toInvoicingDunningCaseStep(dunningCase.scheduleStep, schedule, actionOptions);
+            return step != null ? [[dunningCase.id, step]] : [];
+        })),
         version: 1.0,
     };
 });

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

@@ -3,6 +3,7 @@ export const ALL_INVOICING_DUNNING_CASE_SORT_KEYS = [
     'customer',
     'invoice',
     'attempts',
+    'step',
     'next_retry',
     'days_past_due',
     'failureReason',
@@ -14,6 +15,8 @@ export const INVOICING_DUNNING_CASE_COLUMNS = [
     { key: 'customer', sortable: true },
     { key: 'invoice', sortable: true },
     { key: 'attempts', sortable: true },
+    // The list API does not sort on `schedule_step`.
+    { key: 'step', sortable: false },
     { key: 'next_retry', sortable: true },
     { key: 'days_past_due', sortable: true },
     { key: 'failureReason', sortable: false },

package/lib/index.d.ts

@@ -1219,7 +1219,7 @@ export { fetchInvoicingDunningCaseCounts, fetchInvoicingDunningCaseList, fetchIn
 export { ALL_INVOICING_DUNNING_CASE_SORT_KEYS, ALL_INVOICING_DUNNING_CASE_TAB_IDS, INVOICING_DUNNING_CASE_COLUMNS, } from './view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewState';
 export type { InvoicingDunningCaseColumnConfig, InvoicingDunningCaseFilters, InvoicingDunningCaseSortKey, InvoicingDunningCaseTabId, } from './view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewState';
 export { getInvoicingDunningCaseListView } from './view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewSelector';
-export type { InvoicingDunningCaseListView } from './view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewSelector';
+export type { InvoicingDunningCaseListView, InvoicingDunningCaseStep, } from './view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewSelector';
 export { clearInvoicingDunningCaseDetailView, fetchInvoicingDunningCaseDetail, fetchInvoicingDunningCaseDetailPage, fetchInvoicingDunningEmailPreviewPage, invalidateInvoicingDunningEmailPreview, } from './view/invoicing/invoicingDunningCaseDetailView/invoicingDunningCaseDetailViewReducer';
 export { getInvoicingDunningCaseById, getInvoicingDunningCaseDetail, getInvoicingDunningEmailPreview, } from './view/invoicing/invoicingDunningCaseDetailView/invoicingDunningCaseDetailViewSelector';
 export type { InvoicingDunningCaseDetailView } from './view/invoicing/invoicingDunningCaseDetailView/invoicingDunningCaseDetailViewSelector';

package/lib/view/invoicing/invoicingDunningCaseDetailView/fetchInvoicingDunningCaseDetailPageEpic.d.ts

@@ -1,8 +1,9 @@
 import { ActionsObservable, StateObservable } from 'redux-observable';
 import { Observable } from 'rxjs';
 import { RootState } from '../../../rootStateTypes';
+import { fetchInvoicingSettings } from '../settingsView/settingsViewReducer';
 import { fetchInvoicingDunningCaseDetail, fetchInvoicingDunningCaseDetailPage, fetchInvoicingDunningEmailPreviewPage } from './invoicingDunningCaseDetailViewReducer';
-export type ActionType = ReturnType<typeof fetchInvoicingDunningCaseDetailPage> | ReturnType<typeof fetchInvoicingDunningCaseDetail> | ReturnType<typeof fetchInvoicingDunningEmailPreviewPage>;
+export type ActionType = ReturnType<typeof fetchInvoicingDunningCaseDetailPage> | ReturnType<typeof fetchInvoicingDunningCaseDetail> | ReturnType<typeof fetchInvoicingDunningEmailPreviewPage> | ReturnType<typeof fetchInvoicingSettings>;
 /**
  * Orchestrates the dunning case detail page: the case record, plus a warm of
  * the email composer's preview so the dialog paints with content on first

package/lib/view/invoicing/invoicingDunningCaseDetailView/fetchInvoicingDunningCaseDetailPageEpic.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchInvoicingDunningCaseDetailPageEpic = void 0;
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
+const settingsViewReducer_1 = require("../settingsView/settingsViewReducer");
+const settingsViewSelector_1 = require("../settingsView/settingsViewSelector");
 const invoicingDunningCaseDetailViewReducer_1 = require("./invoicingDunningCaseDetailViewReducer");
 /**
  * Fetch unless the record is already loaded or in flight — or always when the
@@ -28,6 +30,10 @@ const fetchInvoicingDunningCaseDetailPageEpic = (actions$, state$) => actions$.p
         pageActions.push((0, invoicingDunningCaseDetailViewReducer_1.fetchInvoicingDunningCaseDetail)({ id }));
     }
     pageActions.push((0, invoicingDunningCaseDetailViewReducer_1.fetchInvoicingDunningEmailPreviewPage)({ id, cacheOverride }));
+    // The current step is labelled from the settings schedule.
+    if (shouldFetch((0, settingsViewSelector_1.getInvoicingSettingsFetchState)(state), false)) {
+        pageActions.push((0, settingsViewReducer_1.fetchInvoicingSettings)());
+    }
     return pageActions.length > 0 ? (0, rxjs_1.from)(pageActions) : rxjs_1.EMPTY;
 }));
 exports.fetchInvoicingDunningCaseDetailPageEpic = fetchInvoicingDunningCaseDetailPageEpic;

package/lib/view/invoicing/invoicingDunningCaseDetailView/invoicingDunningCaseDetailViewSelector.d.ts

@@ -4,6 +4,7 @@ import { InvoicingDunningCase } from '../../../entity/invoicing/dunningCase/dunn
 import { InvoicingInvoice } from '../../../entity/invoicing/invoice/invoiceState';
 import type { InvoicingFieldHelpByCode } from '../../../entity/invoicing/invoicingCommonPayload';
 import { RootState } from '../../../rootStateTypes';
+import { InvoicingDunningCaseStep } from '../invoicingDunningCaseListView/invoicingDunningCaseListViewSelector';
 import { InvoicingDunningEmailPreviewState } from './invoicingDunningCaseDetailViewState';
 /**
  * Read-only view for the dunning case detail page: the dunning case entity + its
@@ -24,6 +25,8 @@ export interface InvoicingDunningCaseDetailView extends SelectorView {
      * selector rather than pairing this with the invoice detail view.
      */
     linkedInvoice?: InvoicingInvoice;
+    /** The schedule step a retry runs next; absent when the case has none. */
+    step?: InvoicingDunningCaseStep;
 }
 export declare const getInvoicingDunningCaseById: (state: RootState, id: string) => InvoicingDunningCase | undefined;
 export declare const getInvoicingDunningCaseDetail: (state: RootState, invoicingDunningCaseID: ID) => InvoicingDunningCaseDetailView;

package/lib/view/invoicing/invoicingDunningCaseDetailView/invoicingDunningCaseDetailViewSelector.js

@@ -4,6 +4,8 @@ exports.getInvoicingDunningEmailPreview = exports.getInvoicingDunningCaseDetail
 const dunningCaseSelector_1 = require("../../../entity/invoicing/dunningCase/dunningCaseSelector");
 const invoiceSelector_1 = require("../../../entity/invoicing/invoice/invoiceSelector");
 const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
+const invoicingDunningCaseListViewSelector_1 = require("../invoicingDunningCaseListView/invoicingDunningCaseListViewSelector");
+const settingsViewSelector_1 = require("../settingsView/settingsViewSelector");
 const EMAIL_PREVIEW_NOT_STARTED = {
     error: undefined,
     fetchState: 'Not-Started',
@@ -20,10 +22,11 @@ const getInvoicingDunningCaseDetail = (state, invoicingDunningCaseID) => {
             : undefined,
         fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'dunning'),
         actionState: state.invoicingDunningCaseDetailViewState.actionStateById[invoicingDunningCaseID] ?? { error: undefined, fetchState: 'Not-Started' },
-        dunningCase: (0, exports.getInvoicingDunningCaseById)(state, invoicingDunningCaseID),
+        dunningCase,
         emailPreview: id === invoicingDunningCaseID ? emailPreview : EMAIL_PREVIEW_NOT_STARTED,
         fetchState,
         error,
+        step: (0, invoicingDunningCaseListViewSelector_1.toInvoicingDunningCaseStep)(dunningCase?.scheduleStep, (0, settingsViewSelector_1.getInvoicingSettings)(state)?.dunning_schedule, state.invoicingConfigViewState.dunningScheduleActionOptions),
         version: 1.0,
     };
 };

package/lib/view/invoicing/invoicingDunningCaseListView/epics/fetchInvoicingDunningCaseListPageEpic.d.ts

@@ -2,12 +2,13 @@ import { ActionsObservable, StateObservable } from 'redux-observable';
 import { Observable } from 'rxjs';
 import { updateInvoicingDunningCases } from '../../../../entity/invoicing/dunningCase/dunningCaseReducer';
 import { RootState } from '../../../../rootStateTypes';
+import { fetchInvoicingSettings } from '../../settingsView/settingsViewReducer';
 import { fetchInvoicingDunningCaseCounts, fetchInvoicingDunningCaseList, fetchInvoicingDunningCaseListPage, updateInvoicingDunningCaseCounts, updateInvoicingDunningCaseCountsFailure, updateInvoicingDunningCaseList, updateInvoicingDunningCaseListFailure } from '../invoicingDunningCaseListViewReducer';
 /**
  * Aggregate of every action emitted across the dunning-case list view epics.
  * Wired into the root action union for this view.
  */
-export type ActionType = ReturnType<typeof fetchInvoicingDunningCaseList> | ReturnType<typeof fetchInvoicingDunningCaseListPage> | ReturnType<typeof fetchInvoicingDunningCaseCounts> | ReturnType<typeof updateInvoicingDunningCaseList> | ReturnType<typeof updateInvoicingDunningCaseListFailure> | ReturnType<typeof updateInvoicingDunningCaseCounts> | ReturnType<typeof updateInvoicingDunningCaseCountsFailure> | ReturnType<typeof updateInvoicingDunningCases>;
+export type ActionType = ReturnType<typeof fetchInvoicingDunningCaseList> | ReturnType<typeof fetchInvoicingDunningCaseListPage> | ReturnType<typeof fetchInvoicingDunningCaseCounts> | ReturnType<typeof updateInvoicingDunningCaseList> | ReturnType<typeof updateInvoicingDunningCaseListFailure> | ReturnType<typeof updateInvoicingDunningCaseCounts> | ReturnType<typeof updateInvoicingDunningCaseCountsFailure> | ReturnType<typeof updateInvoicingDunningCases> | ReturnType<typeof fetchInvoicingSettings>;
 /**
  * Orchestrates the dunning cases list page: on `fetchInvoicingDunningCaseListPage`,
  * fans out to the list and counts fetches, skipping any whose data is

package/lib/view/invoicing/invoicingDunningCaseListView/epics/fetchInvoicingDunningCaseListPageEpic.js

@@ -4,6 +4,8 @@ exports.fetchInvoicingDunningCaseListPageEpic = void 0;
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const invoicingListTabCache_1 = require("../../invoicingListTabCache");
+const settingsViewReducer_1 = require("../../settingsView/settingsViewReducer");
+const settingsViewSelector_1 = require("../../settingsView/settingsViewSelector");
 const invoicingDunningCaseListViewReducer_1 = require("../invoicingDunningCaseListViewReducer");
 /**
  * Fetch unless the endpoint is already loaded or in flight — or always when the
@@ -39,6 +41,11 @@ const fetchInvoicingDunningCaseListPageEpic = (actions$, state$) => actions$.pip
     if (shouldFetch(state.countsFetchState, cacheOverride)) {
         pageActions.push((0, invoicingDunningCaseListViewReducer_1.fetchInvoicingDunningCaseCounts)());
     }
+    // The step column labels steps from the settings schedule; a search or
+    // sort change does not touch settings, so only a missing load fetches.
+    if (shouldFetch((0, settingsViewSelector_1.getInvoicingSettingsFetchState)(state$.value), false)) {
+        pageActions.push((0, settingsViewReducer_1.fetchInvoicingSettings)());
+    }
     return (0, rxjs_1.concat)((0, rxjs_1.from)(pageActions));
 }));
 exports.fetchInvoicingDunningCaseListPageEpic = fetchInvoicingDunningCaseListPageEpic;

package/lib/view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewSelector.d.ts

@@ -1,7 +1,7 @@
-import { FetchStateAndError } from '../../../commonStateTypes/common';
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
 import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
 import { InvoicingDunningCase } from '../../../entity/invoicing/dunningCase/dunningCaseState';
-import { InvoicingListCounts, InvoicingNamedOption } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingDunningActionOption, InvoicingDunningScheduleStepPayload, InvoicingListCounts, InvoicingNamedOption } from '../../../entity/invoicing/invoicingCommonPayload';
 import { RootState } from '../../../rootStateTypes';
 import { InvoicingListSort } from '../invoicingApiHelper';
 import { InvoicingDunningCaseColumnConfig, InvoicingDunningCaseFilters, InvoicingDunningCaseTabId } from './invoicingDunningCaseListViewState';
@@ -14,9 +14,25 @@ export interface InvoicingDunningCaseListView extends SelectorView {
     filters: InvoicingDunningCaseFilters;
     /** Config status/type list; the page labels tabs and badges from it. */
     statusOptions: InvoicingNamedOption[];
+    /** Each listed case's schedule step, keyed by case id; absent when unknown. */
+    stepById: Record<ID, InvoicingDunningCaseStep>;
     tabIds: InvoicingDunningCaseTabId[];
     sort?: InvoicingListSort;
 }
+/** The dunning schedule step a case's retry runs next, for display. */
+export interface InvoicingDunningCaseStep {
+    step: number;
+    /** The configured step's action, e.g. "Email and retry". */
+    actionName?: string;
+    /** How many steps the tenant's schedule has, when settings are loaded. */
+    totalSteps?: number;
+}
+/**
+ * Join a case's `scheduleStep` with the tenant's dunning schedule and the
+ * config's action labels. The step alone is still shown when settings have not
+ * loaded or the schedule no longer has that step.
+ */
+export declare const toInvoicingDunningCaseStep: (scheduleStep: number | undefined, schedule: InvoicingDunningScheduleStepPayload[] | undefined, actionOptions: InvoicingDunningActionOption[]) => InvoicingDunningCaseStep | undefined;
 /**
  * Memoized so the denormalized `dunningCases` array (and the wrapping view
  * object) keep referential identity until the dunning-case entity slice or the

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

@@ -1,17 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInvoicingDunningCaseListView = void 0;
+exports.getInvoicingDunningCaseListView = exports.toInvoicingDunningCaseStep = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
 const dunningCaseSelector_1 = require("../../../entity/invoicing/dunningCase/dunningCaseSelector");
 const invoicingListTabCache_1 = require("../invoicingListTabCache");
 const invoicingTabHelper_1 = require("../invoicingTabHelper");
 const invoicingDunningCaseListViewState_1 = require("./invoicingDunningCaseListViewState");
+/**
+ * Join a case's `scheduleStep` with the tenant's dunning schedule and the
+ * config's action labels. The step alone is still shown when settings have not
+ * loaded or the schedule no longer has that step.
+ */
+const toInvoicingDunningCaseStep = (scheduleStep, schedule, actionOptions) => {
+    if (scheduleStep == null) {
+        return undefined;
+    }
+    const action = schedule?.find((entry) => entry.step === scheduleStep)?.action;
+    return {
+        actionName: action != null
+            ? actionOptions.find((option) => option.code === action)?.name
+            : undefined,
+        step: scheduleStep,
+        totalSteps: schedule != null && schedule.length > 0 ? schedule.length : undefined,
+    };
+};
+exports.toInvoicingDunningCaseStep = toInvoicingDunningCaseStep;
 /**
  * Memoized so the denormalized `dunningCases` array (and the wrapping view
  * object) keep referential identity until the dunning-case entity slice or the
  * list-view slice actually change.
  */
-exports.getInvoicingDunningCaseListView = (0, toolkit_1.createSelector)((state) => state.invoicingDunningCaseState, (state) => state.invoicingDunningCaseListViewState, (state) => state.invoicingConfigViewState.dunningCaseStatusOptions, (dunningCaseState, listViewState, statusOptions) => {
+exports.getInvoicingDunningCaseListView = (0, toolkit_1.createSelector)((state) => state.invoicingDunningCaseState, (state) => state.invoicingDunningCaseListViewState, (state) => state.invoicingConfigViewState.dunningCaseStatusOptions, (state) => state.invoicingSettingsViewState.settings?.dunning_schedule, (state) => state.invoicingConfigViewState.dunningScheduleActionOptions, (dunningCaseState, listViewState, statusOptions, schedule, actionOptions) => {
     const { activeTab } = listViewState;
     const tab = (0, invoicingListTabCache_1.getInvoicingListTab)(listViewState.byTab, (0, invoicingListTabCache_1.invoicingListSourceTab)(activeTab));
     const dunningCases = (0, dunningCaseSelector_1.getInvoicingDunningCasesByIds)(dunningCaseState, tab.ids);
@@ -31,6 +50,10 @@ exports.getInvoicingDunningCaseListView = (0, toolkit_1.createSelector)((state)
             statusOptions,
         }),
         sort: listViewState.sort,
+        stepById: Object.fromEntries(dunningCases.flatMap((dunningCase) => {
+            const step = (0, exports.toInvoicingDunningCaseStep)(dunningCase.scheduleStep, schedule, actionOptions);
+            return step != null ? [[dunningCase.id, step]] : [];
+        })),
         version: 1.0,
     };
 });

package/lib/view/invoicing/invoicingDunningCaseListView/invoicingDunningCaseListViewState.d.ts

@@ -5,8 +5,8 @@ import { InvoicingListByTab } from '../invoicingListTabCache';
 export interface InvoicingDunningCaseFilters {
     search?: string;
 }
-export declare const ALL_INVOICING_DUNNING_CASE_SORT_KEYS: readonly ["customer", "invoice", "attempts", "next_retry", "days_past_due", "failureReason", "status", "amount"];
-export declare const toInvoicingDunningCaseSortKey: (v: string) => "status" | "invoice" | "amount" | "customer" | "attempts" | "next_retry" | "days_past_due" | "failureReason";
+export declare const ALL_INVOICING_DUNNING_CASE_SORT_KEYS: readonly ["customer", "invoice", "attempts", "step", "next_retry", "days_past_due", "failureReason", "status", "amount"];
+export declare const toInvoicingDunningCaseSortKey: (v: string) => "status" | "invoice" | "amount" | "customer" | "attempts" | "step" | "next_retry" | "days_past_due" | "failureReason";
 export type InvoicingDunningCaseSortKey = ReturnType<typeof toInvoicingDunningCaseSortKey>;
 /**
  * Structural column descriptor owned by CES so the dunning-list column set,

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

@@ -6,6 +6,7 @@ exports.ALL_INVOICING_DUNNING_CASE_SORT_KEYS = [
     'customer',
     'invoice',
     'attempts',
+    'step',
     'next_retry',
     'days_past_due',
     'failureReason',
@@ -18,6 +19,8 @@ exports.INVOICING_DUNNING_CASE_COLUMNS = [
     { key: 'customer', sortable: true },
     { key: 'invoice', sortable: true },
     { key: 'attempts', sortable: true },
+    // The list API does not sort on `schedule_step`.
+    { key: 'step', sortable: false },
     { key: 'next_retry', sortable: true },
     { key: 'days_past_due', sortable: true },
     { key: 'failureReason', sortable: false },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.2.79",
+  "version": "5.2.80",
   "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
   "main": "lib/index.js",
   "module": "lib/esm/index.js",