@zeniai/client-epic-state 5.2.50-betaRD1 → 5.2.50

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector.js

@@ -8,6 +8,7 @@ const couponViewSelector_1 = require("../couponView/couponViewSelector");
 const invoicingCatalogListViewSelector_1 = require("../invoicingCatalogListView/invoicingCatalogListViewSelector");
 const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
 const invoicingCustomerListViewSelector_1 = require("../invoicingCustomerListView/invoicingCustomerListViewSelector");
+const invoicingFormDraft_1 = require("../invoicingFormDraft");
 const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
 const invoicingSubscriptionFormConfig_2 = require("./invoicingSubscriptionFormConfig");
 const getEditInvoicingSubscriptionDetailViewState = (state, invoicingSubscriptionID) => {
@@ -37,8 +38,7 @@ const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID) => {
     // `seedInvoicingSubscriptionFormDraftEpic` when the detail load lands. Until
     // then the page is showing its skeleton.
     const localData = invoicingSubscriptionID != null
-        ? (editDraftById[invoicingSubscriptionID] ??
-            invoicingSubscriptionFormConfig_1.initialInvoicingSubscriptionFormLocalData)
+        ? (0, invoicingFormDraft_1.getInvoicingFormDraftLocalData)(editDraftById, invoicingSubscriptionID, invoicingSubscriptionFormConfig_1.initialInvoicingSubscriptionFormLocalData)
         : newSubscriptionDraft;
     // Shipping address is captured via the shared Address screen and seeded there
     // (looked up in the shared address store by `shippingAddressId`) on detail
@@ -69,6 +69,7 @@ const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID) => {
         subscriptionLifecycleActionOptions: configState.subscriptionLifecycleActionOptions,
         subscriptionMetadataEditAllowedFromStatuses: configState.subscriptionMetadataEditAllowedFromStatuses,
         recordState,
+        isFormLoading: (0, invoicingFormDraft_1.isInvoicingFormDraftPending)(editDraftById, invoicingSubscriptionID),
         fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'subscription'),
         coupons: (0, couponViewSelector_1.getInvoicingCouponListItems)(state),
         customers: (0, invoicingCustomerListViewSelector_1.getInvoicingCustomerListView)(state).customers,

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewState.d.ts

@@ -1,5 +1,6 @@
 import { Amount } from '../../../commonStateTypes/amount';
 import { FetchStateAndError, FetchedState, ID } from '../../../commonStateTypes/common';
+import { InvoicingFormDraftById } from '../invoicingFormDraft';
 /**
  * Draft form state for the create/edit subscription form. Held in CES so the
  * form flows its data from here (mirrors the customer form / bill-pay pattern).
@@ -41,7 +42,7 @@ export interface InvoicingSubscriptionFormLocalData {
 export interface EditInvoicingSubscriptionDetailViewState extends FetchedState {
     /** Lifecycle action fetch state per subscription id. */
     actionStateById: Record<ID, FetchStateAndError>;
-    editDraftById: Record<ID, InvoicingSubscriptionFormLocalData>;
+    editDraftById: InvoicingFormDraftById<InvoicingSubscriptionFormLocalData>;
     newSubscriptionDraft: InvoicingSubscriptionFormLocalData;
     /** Detail-load state per subscription id. */
     recordStateById: Record<ID, FetchStateAndError>;

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/fetchInvoicingSubscriptionFormPageEpic.js

@@ -19,8 +19,11 @@ const fetchInvoicingSubscriptionFormPageEpic = (actions$) => actions$.pipe((0, o
     const { subscriptionId } = action.payload;
     const pageActions = [
         (0, invoicingCustomerListViewReducer_1.fetchInvoicingCustomerList)({ filters: {}, keepExistingListItems: false }),
+        // Plans only: the form's plan picker is the one consumer, and an
+        // unfiltered list would replace the store's plans with every catalog
+        // item.
         (0, invoicingCatalogListViewReducer_1.fetchInvoicingCatalogPlanList)({
-            filters: {},
+            filters: { type: 'plan' },
             keepExistingListItems: false,
         }),
         (0, couponViewReducer_1.fetchInvoicingCouponList)({ filters: {}, keepExistingListItems: false }),

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/saveInvoicingSubscriptionEpic.js

@@ -20,7 +20,7 @@ const saveInvoicingSubscriptionEpic = (actions$, state$, zeniAPI) => actions$.pi
     const rootState = state$.value;
     const viewState = rootState.editInvoicingSubscriptionDetailViewState;
     const localData = (id != null
-        ? viewState.editDraftById[id]
+        ? viewState.editDraftById[id]?.localData
         : viewState.newSubscriptionDraft) ?? viewState.newSubscriptionDraft;
     // Shipping address captured via the shared Address screen is sent as an
     // object in the payload (same pattern as the customer save flow).

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/seedInvoicingSubscriptionFormDraftEpic.d.ts

@@ -1,12 +1,16 @@
 import { ActionsObservable, StateObservable } from 'redux-observable';
 import { Observable } from 'rxjs';
 import { RootState } from '../../../rootStateTypes';
-import { seedInvoicingSubscriptionFormDraft, updateInvoicingSubscriptionDetail } from './editInvoicingSubscriptionDetailViewReducer';
-export type ActionType = ReturnType<typeof updateInvoicingSubscriptionDetail> | ReturnType<typeof seedInvoicingSubscriptionFormDraft>;
+import { fetchInvoicingSubscriptionFormPage, seedInvoicingSubscriptionFormDraft, updateInvoicingSubscriptionDetail } from './editInvoicingSubscriptionDetailViewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingSubscriptionFormPage> | ReturnType<typeof updateInvoicingSubscriptionDetail> | ReturnType<typeof seedInvoicingSubscriptionFormDraft>;
 /**
- * Seeds the edit draft from the record the moment the detail fetch lands, so
- * the form has its values before it mounts. The reducer ignores the seed when a
- * draft already exists, which is what stops a background refetch from
- * overwriting edits in progress.
+ * Seeds the edit draft from the record, so the form has its values before it
+ * mounts. The reducer ignores a seed once the draft holds the record, which is
+ * what stops a background refetch from overwriting edits in progress.
+ *
+ * Opening the page counts as a trigger, not just the detail response: the page
+ * fetch is cache-guarded, so re-opening a form for a record already loaded this
+ * session issues no request at all — and a draft cleared in between (by a save
+ * or a cancel) would have nothing left to seed it.
  */
 export declare const seedInvoicingSubscriptionFormDraftEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/seedInvoicingSubscriptionFormDraftEpic.js

@@ -7,14 +7,35 @@ const editInvoicingSubscriptionDetailViewReducer_1 = require("./editInvoicingSub
 const invoicingSubscriptionDetailHelper_1 = require("./invoicingSubscriptionDetailHelper");
 const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
 /**
- * Seeds the edit draft from the record the moment the detail fetch lands, so
- * the form has its values before it mounts. The reducer ignores the seed when a
- * draft already exists, which is what stops a background refetch from
- * overwriting edits in progress.
+ * Seeds the edit draft from the record, so the form has its values before it
+ * mounts. The reducer ignores a seed once the draft holds the record, which is
+ * what stops a background refetch from overwriting edits in progress.
+ *
+ * Opening the page counts as a trigger, not just the detail response: the page
+ * fetch is cache-guarded, so re-opening a form for a record already loaded this
+ * session issues no request at all — and a draft cleared in between (by a save
+ * or a cancel) would have nothing left to seed it.
  */
-const seedInvoicingSubscriptionFormDraftEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(editInvoicingSubscriptionDetailViewReducer_1.updateInvoicingSubscriptionDetail.match), (0, operators_1.withLatestFrom)(state$), (0, operators_1.mergeMap)(([action, state]) => {
-    const { id } = action.payload;
-    const subscription = (0, invoicingSubscriptionDetailHelper_1.getInvoicingSubscriptionById)(state, id);
+const seedInvoicingSubscriptionFormDraftEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)((action) => editInvoicingSubscriptionDetailViewReducer_1.updateInvoicingSubscriptionDetail.match(action) ||
+    editInvoicingSubscriptionDetailViewReducer_1.fetchInvoicingSubscriptionFormPage.match(action)), (0, operators_1.withLatestFrom)(state$), (0, operators_1.mergeMap)(([action, state]) => {
+    const id = editInvoicingSubscriptionDetailViewReducer_1.updateInvoicingSubscriptionDetail.match(action)
+        ? action.payload.id
+        : action.payload.subscriptionId;
+    if (id == null) {
+        return rxjs_1.EMPTY;
+    }
+    // The entity alone does not say the whole record is loaded — the list
+    // endpoints merge their own list-shaped rows into the same store. Only a
+    // completed detail load does, which is also exactly when the page's
+    // cache-guarded fetch issues no request and this is the sole seed.
+    if (editInvoicingSubscriptionDetailViewReducer_1.fetchInvoicingSubscriptionFormPage.match(action) &&
+        state.editInvoicingSubscriptionDetailViewState.recordStateById[id]
+            ?.fetchState !== 'Completed') {
+        return rxjs_1.EMPTY;
+    }
+    // Nothing to seed from on a cold open; the detail response triggers this
+    // again once it lands.
+    const subscription = id != null ? (0, invoicingSubscriptionDetailHelper_1.getInvoicingSubscriptionById)(state, id) : undefined;
     if (subscription == null) {
         return rxjs_1.EMPTY;
     }

package/lib/view/invoicing/invoicingFormDraft.d.ts

@@ -0,0 +1,54 @@
+import { FetchState, ID } from '../../commonStateTypes/common';
+/**
+ * A create/edit form's draft, plus where its values came from.
+ *
+ * The status is what lets an edit form tell "these are the record's values"
+ * from "these are whatever the form had at first render". It cannot be read off
+ * the presence of a draft, because the form writes drafts too: it pushes its
+ * whole state back on every change, so a change made before the record landed
+ * leaves a draft that looks seeded but holds nothing.
+ *
+ * `Not-Started` — written by the form, never filled from a record.
+ * `Completed`   — filled from the loaded record; the form may have edited it since.
+ * `Error`       — the record's fetch failed, so the form starts blank and a
+ *                 later successful fetch is still allowed to seed it.
+ */
+export interface InvoicingFormDraft<TLocalData> {
+    fetchState: FetchState;
+    localData: TLocalData;
+}
+export type InvoicingFormDraftById<TLocalData> = Record<ID, InvoicingFormDraft<TLocalData>>;
+/**
+ * The form's own write. Keeps the status: an edit on top of a seeded draft is
+ * still the record's draft, and an edit made before the record arrived must not
+ * pass for one.
+ */
+export declare function applyInvoicingFormDraftEdit<TLocalData>(draftById: InvoicingFormDraftById<TLocalData>, id: ID, localData: TLocalData): void;
+/**
+ * Fill the draft from the loaded record, once. A second seed is ignored so a
+ * late refetch cannot overwrite edits in progress — but a draft the form wrote
+ * before the record landed is replaced, since it was never the record's.
+ */
+export declare function applyInvoicingFormDraftSeed<TLocalData>(draftById: InvoicingFormDraftById<TLocalData>, id: ID, localData: TLocalData): void;
+/**
+ * Record that the fetch failed, so the form renders instead of waiting behind a
+ * skeleton that will never resolve.
+ *
+ * Mirrors the seed: a draft holding the record is left alone, since a
+ * background refetch failing is no reason to discard it, and anything else is
+ * marked failed. A draft the form wrote before the record landed keeps its
+ * values — there is no reason to throw away what the user typed — but stops
+ * counting as still loading, and a later successful fetch can still seed it.
+ */
+export declare function applyInvoicingFormDraftFailure<TLocalData>(draftById: InvoicingFormDraftById<TLocalData>, id: ID, blankLocalData: TLocalData): void;
+/** The draft's values, or the blank form when nothing is drafted yet. */
+export declare function getInvoicingFormDraftLocalData<TLocalData>(draftById: InvoicingFormDraftById<TLocalData>, id: ID | undefined, blankLocalData: TLocalData): TLocalData;
+/**
+ * Whether the form should still be showing its skeleton — the record has
+ * neither reached the draft nor failed trying.
+ *
+ * Settles once and stays settled, which is what keeps a later refetch from
+ * swapping a form the user is typing into back for a skeleton. Create mode
+ * (no id) has no record to wait for.
+ */
+export declare function isInvoicingFormDraftPending<TLocalData>(draftById: InvoicingFormDraftById<TLocalData>, id: ID | undefined): boolean;

package/lib/view/invoicing/invoicingFormDraft.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyInvoicingFormDraftEdit = applyInvoicingFormDraftEdit;
+exports.applyInvoicingFormDraftSeed = applyInvoicingFormDraftSeed;
+exports.applyInvoicingFormDraftFailure = applyInvoicingFormDraftFailure;
+exports.getInvoicingFormDraftLocalData = getInvoicingFormDraftLocalData;
+exports.isInvoicingFormDraftPending = isInvoicingFormDraftPending;
+/**
+ * The form's own write. Keeps the status: an edit on top of a seeded draft is
+ * still the record's draft, and an edit made before the record arrived must not
+ * pass for one.
+ */
+function applyInvoicingFormDraftEdit(draftById, id, localData) {
+    draftById[id] = {
+        fetchState: draftById[id]?.fetchState ?? 'Not-Started',
+        localData,
+    };
+}
+/**
+ * Fill the draft from the loaded record, once. A second seed is ignored so a
+ * late refetch cannot overwrite edits in progress — but a draft the form wrote
+ * before the record landed is replaced, since it was never the record's.
+ */
+function applyInvoicingFormDraftSeed(draftById, id, localData) {
+    if (draftById[id]?.fetchState === 'Completed') {
+        return;
+    }
+    draftById[id] = { fetchState: 'Completed', localData };
+}
+/**
+ * Record that the fetch failed, so the form renders instead of waiting behind a
+ * skeleton that will never resolve.
+ *
+ * Mirrors the seed: a draft holding the record is left alone, since a
+ * background refetch failing is no reason to discard it, and anything else is
+ * marked failed. A draft the form wrote before the record landed keeps its
+ * values — there is no reason to throw away what the user typed — but stops
+ * counting as still loading, and a later successful fetch can still seed it.
+ */
+function applyInvoicingFormDraftFailure(draftById, id, blankLocalData) {
+    const existing = draftById[id];
+    if (existing == null) {
+        draftById[id] = { fetchState: 'Error', localData: blankLocalData };
+        return;
+    }
+    if (existing.fetchState === 'Completed') {
+        return;
+    }
+    existing.fetchState = 'Error';
+}
+/** The draft's values, or the blank form when nothing is drafted yet. */
+function getInvoicingFormDraftLocalData(draftById, id, blankLocalData) {
+    if (id == null) {
+        return blankLocalData;
+    }
+    return draftById[id]?.localData ?? blankLocalData;
+}
+/**
+ * Whether the form should still be showing its skeleton — the record has
+ * neither reached the draft nor failed trying.
+ *
+ * Settles once and stays settled, which is what keeps a later refetch from
+ * swapping a form the user is typing into back for a skeleton. Create mode
+ * (no id) has no record to wait for.
+ */
+function isInvoicingFormDraftPending(draftById, id) {
+    if (id == null) {
+        return false;
+    }
+    const fetchState = draftById[id]?.fetchState;
+    return fetchState !== 'Completed' && fetchState !== 'Error';
+}

package/package.json

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

package/lib/esm/view/expenseAutomationView/epics/jeSchedule/fetchFailedJePostingsEpic.js

@@ -1,40 +0,0 @@
-import { from, of } from 'rxjs';
-import { catchError, filter, switchMap, takeUntil } from 'rxjs/operators';
-import { updateJESchedules, updateJESchedulesDetails, } from '../../../../entity/jeSchedules/jeSchedulesReducer';
-import { createZeniAPIStatus, isSuccessResponse, } from '../../../../responsePayload';
-import { clearAll } from '../../../../rootActions';
-import { fetchFailedJePostings, fetchFailedJePostingsFailure, fetchFailedJePostingsSuccess, initializeJeScheduleLocalData, } from '../../reducers/jeSchedulesViewReducer';
-/**
- * Fetches every currently-failing posting for the tenant, on its own endpoint and with no window.
- *
- * Sends no query at all. The endpoint takes an optional `expected_post_start_date` floor and the
- * client deliberately omits it: a failure is outstanding work until someone resolves it, whatever
- * month it belongs to, and windowing this list is exactly what kept older failures off the only
- * screen that can resolve them.
- *
- * `switchMap`, not `mergeMap`: there is one list per tenant, so a second trigger supersedes the
- * first rather than racing it.
- */
-export const fetchFailedJePostingsEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(fetchFailedJePostings.match), switchMap(() => zeniAPI
-    .getJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/expenses_automation/failed_je_postings`)
-    .pipe(switchMap((response) => {
-    if (!isSuccessResponse(response) || response.data == null) {
-        return of(fetchFailedJePostingsFailure(response.status));
-    }
-    const failedJeSchedules = response.data.failed_je_postings?.je_schedules ?? [];
-    const failedScheduledJournalEntries = response.data.failed_je_postings?.scheduled_journal_entries ?? [];
-    // Order matters and matches fetchJeSchedulesEpic: updateJESchedules fans out to the
-    // vendor / account / class / user entities, updateJESchedulesDetails then attaches the
-    // journal entries, and only then can initializeJeScheduleLocalData read them back.
-    return from([
-        updateJESchedules(failedJeSchedules),
-        updateJESchedulesDetails(failedJeSchedules, failedScheduledJournalEntries),
-        initializeJeScheduleLocalData(failedJeSchedules),
-        fetchFailedJePostingsSuccess(failedJeSchedules),
-    ]);
-}), catchError((error) => of(fetchFailedJePostingsFailure(createZeniAPIStatus('Unexpected Error', 'fetch failed JE postings REST API call errored out' +
-    JSON.stringify(error))))), 
-// A tenant switch clears the store while this request is still in flight. Without this
-// the old tenant's rows are written back into the freshly cleared store and stay on
-// screen under the new tenant until a manual refresh.
-takeUntil(actions$.pipe(filter(clearAll.match))))));