@zeniai/client-epic-state 5.2.48 → 5.2.49-betaAK0

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

@@ -7,15 +7,24 @@ 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);
-    if (subscription == null) {
+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;
+    // 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 (id == null || subscription == null) {
         return rxjs_1.EMPTY;
     }
     return (0, rxjs_1.of)((0, editInvoicingSubscriptionDetailViewReducer_1.seedInvoicingSubscriptionFormDraft)({

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

@@ -0,0 +1,50 @@
+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;
+/**
+ * Stand the draft up blank when the record's fetch fails, so the form renders
+ * instead of waiting behind a skeleton that will never resolve. A draft that
+ * already exists is left alone: a background refetch failing is no reason to
+ * discard what the user has.
+ */
+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,63 @@
+"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 };
+}
+/**
+ * Stand the draft up blank when the record's fetch fails, so the form renders
+ * instead of waiting behind a skeleton that will never resolve. A draft that
+ * already exists is left alone: a background refetch failing is no reason to
+ * discard what the user has.
+ */
+function applyInvoicingFormDraftFailure(draftById, id, blankLocalData) {
+    if (draftById[id] != null) {
+        return;
+    }
+    draftById[id] = { fetchState: 'Error', localData: blankLocalData };
+}
+/** 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.48",
+  "version": "5.2.49-betaAK0",
   "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
   "main": "lib/index.js",
   "module": "lib/esm/index.js",