@zeniai/client-epic-state 5.2.3 → 5.2.4

package/lib/view/invoicing/invoicingConfigView/invoicingConfigViewSelector.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInvoicingOnboardingGateView = exports.getInvoicingConfigView = void 0;
+exports.invoicingFieldHelpForGroup = exports.getInvoicingOnboardingGateView = exports.getInvoicingConfigView = void 0;
 const invoicingConfigViewPayload_1 = require("./invoicingConfigViewPayload");
 const getInvoicingConfigView = (state) => {
     const { acceptTermsFetchState, enableFetchState, ...configState } = state.invoicingConfigViewState;
@@ -22,3 +22,11 @@ const getInvoicingOnboardingGateView = (state) => {
     };
 };
 exports.getInvoicingOnboardingGateView = getInvoicingOnboardingGateView;
+/**
+ * One group's help copy, keyed by field code. Composed by the page-level view
+ * selectors rather than exported to the UI: a screen receives the slice for its
+ * own group, so no screen needs the config shape. Empty when the backend has
+ * not populated the group, which the UI reads as "render no icon".
+ */
+const invoicingFieldHelpForGroup = (state, group) => state.invoicingConfigViewState.fieldHelp[group] ?? {};
+exports.invoicingFieldHelpForGroup = invoicingFieldHelpForGroup;

package/lib/view/invoicing/invoicingConfigView/invoicingConfigViewState.d.ts

@@ -1,5 +1,5 @@
 import { FetchStateAndError, FetchedState } from '../../../commonStateTypes/common';
-import type { AuditLogEntityRouteOption, AuditLogListSortFieldOption, AuditLogSourceLabelOption, InvoicingCatalogItemLifecycleAction, InvoicingCatalogLifecycleActionOption, InvoicingCatalogProductLifecycleAction, InvoicingDiscountLifecycleActionOption, InvoicingNamedOption, InvoicingNamedOptionsByKey, InvoicingQboAccountMappingKindOption, InvoicingSubscriptionEditFieldOption, InvoicingSubscriptionLifecycleActionOption } from '../../../entity/invoicing/invoicingCommonPayload';
+import type { AuditLogEntityRouteOption, AuditLogListSortFieldOption, AuditLogSourceLabelOption, InvoicingCatalogItemLifecycleAction, InvoicingCatalogLifecycleActionOption, InvoicingCatalogProductLifecycleAction, InvoicingDiscountLifecycleActionOption, InvoicingFieldHelp, InvoicingNamedOption, InvoicingNamedOptionsByKey, InvoicingQboAccountMappingKindOption, InvoicingSubscriptionEditFieldOption, InvoicingSubscriptionLifecycleActionOption } from '../../../entity/invoicing/invoicingCommonPayload';
 import { InvoicingDunningActionOption } from '../../../entity/invoicing/invoicingCommonPayload';
 export interface InvoicingConfigViewState extends FetchedState {
     acceptTermsFetchState: FetchStateAndError;
@@ -29,6 +29,8 @@ export interface InvoicingConfigViewState extends FetchedState {
     dunningCaseStatusOptions: InvoicingNamedOption[];
     dunningScheduleActionOptions: InvoicingDunningActionOption[];
     enableFetchState: FetchStateAndError;
+    /** Help copy per field group, flattened to `code -> description` at load. */
+    fieldHelp: InvoicingFieldHelp;
     invoiceStatusOptions: InvoicingNamedOption[];
     manualPaymentMethodOptions: InvoicingNamedOption[];
     netTermDayOptions: InvoicingNamedOption[];

package/lib/view/invoicing/invoicingCouponDetailView/invoicingCouponDetailViewSelector.d.ts

@@ -1,12 +1,18 @@
 import { ID } from '../../../commonStateTypes/common';
 import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
 import { InvoicingCoupon } from '../../../entity/invoicing/coupon/couponState';
+import type { InvoicingFieldHelpByCode } from '../../../entity/invoicing/invoicingCommonPayload';
 import { RootState } from '../../../rootStateTypes';
 /**
  * Read-only view for the discount detail page: the coupon entity + its per-id
  * fetch state. Lets the detail screen depend on this single read selector.
  */
 export interface InvoicingCouponDetailView extends SelectorView {
+    /**
+     * Backend help copy for this screen's field group, keyed by field code.
+     * Folded in here so the screen never reaches for the config view itself.
+     */
+    fieldHelp: InvoicingFieldHelpByCode;
     coupon?: InvoicingCoupon;
 }
 export declare const getInvoicingCouponDetail: (state: RootState, id: ID) => InvoicingCouponDetailView;

package/lib/view/invoicing/invoicingCouponDetailView/invoicingCouponDetailViewSelector.js

@@ -6,9 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInvoicingCouponDetail = void 0;
 const get_1 = __importDefault(require("lodash/get"));
 const couponSelector_1 = require("../../../entity/invoicing/coupon/couponSelector");
+const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
 const getInvoicingCouponDetail = (state, id) => {
     const detail = (0, get_1.default)(state.invoicingCouponDetailViewState.detailById, id, undefined);
     return {
+        fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'discount'),
         coupon: (0, couponSelector_1.getInvoicingCouponById)(state.invoicingCouponState, id),
         fetchState: detail?.fetchState ?? 'Not-Started',
         error: detail?.error,

package/lib/view/invoicing/invoicingCreditNoteDetailView/invoicingCreditNoteDetailViewSelector.d.ts

@@ -1,6 +1,7 @@
 import { ID } from '../../../commonStateTypes/common';
 import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
 import { InvoicingCreditNote } from '../../../entity/invoicing/creditNote/creditNoteState';
+import type { InvoicingFieldHelpByCode } from '../../../entity/invoicing/invoicingCommonPayload';
 import { RootState } from '../../../rootStateTypes';
 /**
  * Read-only view for the credit note detail page: the credit note entity + its
@@ -8,6 +9,11 @@ import { RootState } from '../../../rootStateTypes';
  * selector.
  */
 export interface InvoicingCreditNoteDetailView extends SelectorView {
+    /**
+     * Backend help copy for this screen's field group, keyed by field code.
+     * Folded in here so the screen never reaches for the config view itself.
+     */
+    fieldHelp: InvoicingFieldHelpByCode;
     creditNote?: InvoicingCreditNote;
 }
 export declare const getInvoicingCreditNoteById: (state: RootState, id: string) => InvoicingCreditNote | undefined;

package/lib/view/invoicing/invoicingCreditNoteDetailView/invoicingCreditNoteDetailViewSelector.js

@@ -2,11 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInvoicingCreditNoteDetail = exports.getInvoicingCreditNoteById = void 0;
 const creditNoteSelector_1 = require("../../../entity/invoicing/creditNote/creditNoteSelector");
+const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
 const getInvoicingCreditNoteById = (state, id) => (0, creditNoteSelector_1.getInvoicingCreditNoteById)(state.invoicingCreditNoteState, id);
 exports.getInvoicingCreditNoteById = getInvoicingCreditNoteById;
 const getInvoicingCreditNoteDetail = (state, invoicingCreditNoteID) => {
     const { error, fetchState } = state.invoicingCreditNoteDetailViewState;
     return {
+        fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'credit_note'),
         creditNote: (0, exports.getInvoicingCreditNoteById)(state, invoicingCreditNoteID),
         fetchState,
         error,

package/lib/view/invoicing/invoicingCreditNoteListView/invoicingCreditNoteListViewState.d.ts

@@ -6,7 +6,7 @@ export interface InvoicingCreditNoteFilters {
     search?: string;
 }
 export declare const ALL_INVOICING_CREDIT_NOTE_SORT_KEYS: readonly ["credit_note", "customer", "date", "type", "status", "reference_invoice", "utilization", "total"];
-export declare const toInvoicingCreditNoteSortKey: (v: string) => "type" | "date" | "status" | "customer" | "total" | "credit_note" | "reference_invoice" | "utilization";
+export declare const toInvoicingCreditNoteSortKey: (v: string) => "type" | "date" | "status" | "customer" | "credit_note" | "total" | "reference_invoice" | "utilization";
 export type InvoicingCreditNoteSortKey = ReturnType<typeof toInvoicingCreditNoteSortKey>;
 /**
  * Structural column descriptor owned by CES so the credit-notes-list column set,

package/lib/view/invoicing/invoicingCustomerDetailView/invoicingCustomerDetailViewSelector.d.ts

@@ -1,6 +1,7 @@
 import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
 import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
 import { InvoicingInvoice } from '../../../entity/invoicing/invoice/invoiceState';
+import type { InvoicingFieldHelpByCode } from '../../../entity/invoicing/invoicingCommonPayload';
 import { InvoicingCustomer, InvoicingCustomerPaymentMethod } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerState';
 import { RootState } from '../../../rootStateTypes';
 import { InvoicingSetupIntent } from '../customerPaymentMethod/customerPaymentMethodState';
@@ -13,6 +14,11 @@ import { InvoicingSetupIntent } from '../customerPaymentMethod/customerPaymentMe
  * read selector.
  */
 export interface InvoicingCustomerDetailView extends SelectorView {
+    /**
+     * Backend help copy for this screen's field group, keyed by field code.
+     * Folded in here so the screen never reaches for the config view itself.
+     */
+    fieldHelp: InvoicingFieldHelpByCode;
     invoices: InvoicingInvoice[];
     paymentMethods: InvoicingCustomerPaymentMethod[];
     paymentMethodSaveState: FetchStateAndError;

package/lib/view/invoicing/invoicingCustomerDetailView/invoicingCustomerDetailViewSelector.js

@@ -8,6 +8,7 @@ const get_1 = __importDefault(require("lodash/get"));
 const invoiceSelector_1 = require("../../../entity/invoicing/invoice/invoiceSelector");
 const invoicingCustomerSelector_1 = require("../../../entity/invoicing/invoicingCustomer/invoicingCustomerSelector");
 const customerPaymentMethodSelector_1 = require("../customerPaymentMethod/customerPaymentMethodSelector");
+const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
 const invoicingSettingsHelpers_1 = require("../settingsView/invoicingSettingsHelpers");
 const settingsViewSelector_1 = require("../settingsView/settingsViewSelector");
 const getInvoicingCustomerDetail = (state, invoicingCustomerID) => {
@@ -16,6 +17,7 @@ const getInvoicingCustomerDetail = (state, invoicingCustomerID) => {
     const settings = (0, settingsViewSelector_1.getInvoicingSettings)(state);
     const invoicingCustomer = (0, invoicingCustomerSelector_1.getInvoicingCustomerById)(invoicingCustomerState, invoicingCustomerID);
     return {
+        fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'customer'),
         invoicingCustomer,
         invoices: (0, invoiceSelector_1.getInvoicesByIds)(state.invoicingInvoiceState, state.invoicingInvoiceListState.invoiceByTab[state.invoicingInvoiceListState.activeTab]?.invoiceIds ?? []),
         paymentMethods: (0, invoicingCustomerSelector_1.invoicingCustomerPaymentMethods)(invoicingCustomer),

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

@@ -1,6 +1,7 @@
 import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
 import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
 import { InvoicingDunningCase } from '../../../entity/invoicing/dunningCase/dunningCaseState';
+import type { InvoicingFieldHelpByCode } from '../../../entity/invoicing/invoicingCommonPayload';
 import { RootState } from '../../../rootStateTypes';
 import { InvoicingDunningEmailPreviewState } from './invoicingDunningCaseDetailViewState';
 /**
@@ -11,6 +12,11 @@ import { InvoicingDunningEmailPreviewState } from './invoicingDunningCaseDetailV
 export interface InvoicingDunningCaseDetailView extends SelectorView {
     actionState: FetchStateAndError;
     emailPreview: InvoicingDunningEmailPreviewState;
+    /**
+     * Backend help copy for this screen's field group, keyed by field code.
+     * Folded in here so the screen never reaches for the config view itself.
+     */
+    fieldHelp: InvoicingFieldHelpByCode;
     dunningCase?: InvoicingDunningCase;
 }
 export declare const getInvoicingDunningCaseById: (state: RootState, id: string) => InvoicingDunningCase | undefined;

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInvoicingDunningEmailPreview = exports.getInvoicingDunningCaseDetail = exports.getInvoicingDunningCaseById = void 0;
 const dunningCaseSelector_1 = require("../../../entity/invoicing/dunningCase/dunningCaseSelector");
 const dunningActionSelector_1 = require("../dunningAction/dunningActionSelector");
+const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
 const EMAIL_PREVIEW_NOT_STARTED = {
     error: undefined,
     fetchState: 'Not-Started',
@@ -13,6 +14,7 @@ exports.getInvoicingDunningCaseById = getInvoicingDunningCaseById;
 const getInvoicingDunningCaseDetail = (state, invoicingDunningCaseID) => {
     const { emailPreview, error, fetchState, id } = state.invoicingDunningCaseDetailViewState;
     return {
+        fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'dunning'),
         actionState: (0, dunningActionSelector_1.getInvoicingDunningActionState)(invoicingDunningCaseID)(state),
         dunningCase: (0, exports.getInvoicingDunningCaseById)(state, invoicingDunningCaseID),
         emailPreview: id === invoicingDunningCaseID ? emailPreview : EMAIL_PREVIEW_NOT_STARTED,

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

@@ -1,5 +1,6 @@
 import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
 import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
+import type { InvoicingFieldHelpByCode } from '../../../entity/invoicing/invoicingCommonPayload';
 import { InvoicingSubscription } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionState';
 import { RootState } from '../../../rootStateTypes';
 /**
@@ -9,6 +10,11 @@ import { RootState } from '../../../rootStateTypes';
  */
 export interface InvoicingSubscriptionDetailView extends SelectorView {
     actionState: FetchStateAndError;
+    /**
+     * Backend help copy for this screen's field group, keyed by field code.
+     * Folded in here so the screen never reaches for the config view itself.
+     */
+    fieldHelp: InvoicingFieldHelpByCode;
     subscription?: InvoicingSubscription;
 }
 export declare const getInvoicingSubscriptionById: (state: RootState, id: string) => InvoicingSubscription | undefined;

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

@@ -2,12 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInvoicingSubscriptionDetail = exports.getInvoicingSubscriptionById = void 0;
 const invoicingSubscriptionSelector_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector");
+const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
 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 {
+        fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'subscription'),
         actionState: (0, subscriptionActionSelector_1.getInvoicingSubscriptionActionState)(invoicingSubscriptionID)(state),
         subscription: (0, exports.getInvoicingSubscriptionById)(state, invoicingSubscriptionID),
         fetchState,

package/lib/view/invoicing/issueCreditNote/issueCreditNoteSelector.d.ts

@@ -1,7 +1,7 @@
 import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
 import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
 import { InvoicingInvoice } from '../../../entity/invoicing/invoice/invoiceState';
-import { InvoicingNamedOption } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingFieldHelpByCode, InvoicingNamedOption } from '../../../entity/invoicing/invoicingCommonPayload';
 import { RootState } from '../../../rootStateTypes';
 import { IssueCreditNoteFormLocalData } from './issueCreditNoteState';
 /**
@@ -11,6 +11,11 @@ import { IssueCreditNoteFormLocalData } from './issueCreditNoteState';
  * as `submitState` so a save failure can't be mistaken for a load failure.
  */
 export interface IssueCreditNoteView extends SelectorView {
+    /**
+     * Backend help copy for this screen's field group, keyed by field code.
+     * Folded in here so the screen never reaches for the config view itself.
+     */
+    fieldHelp: InvoicingFieldHelpByCode;
     /**
      * True once the invoice has loaded and the draft for *this* invoice has line
      * items to credit.

package/lib/view/invoicing/issueCreditNote/issueCreditNoteSelector.js

@@ -16,6 +16,7 @@ const getIssueCreditNoteView = (state, invoiceId) => {
     const isDraftForInvoice = draft.invoiceId === invoiceId;
     const { creditNoteReasonCodeOptions, creditNoteTypeOptions } = (0, invoicingConfigViewSelector_1.getInvoicingConfigView)(state);
     return {
+        fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'credit_note'),
         invoice: invoiceView.invoice,
         isPageReady: invoiceView.fetchState === 'Completed' &&
             isDraftForInvoice &&

package/lib/view/invoicing/recordPayment/recordPaymentSelector.d.ts

@@ -1,6 +1,6 @@
 import { ID } from '../../../commonStateTypes/common';
 import { SelectorView } from '../../../commonStateTypes/viewAndReport/viewAndReport';
-import { InvoicingNamedOption } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingFieldHelpByCode, InvoicingNamedOption } from '../../../entity/invoicing/invoicingCommonPayload';
 import { RootState } from '../../../rootStateTypes';
 import { RecordPaymentFormLocalData } from './recordPaymentState';
 export interface InvoicingRecordPaymentView extends SelectorView {
@@ -17,6 +17,11 @@ export declare const getRecordPaymentView: (state: RootState) => InvoicingRecord
  * CES-owned payment-method / gateway value sets, and the submit fetch state.
  */
 export interface RecordPaymentFormView extends SelectorView {
+    /**
+     * Backend help copy for this screen's field group, keyed by field code.
+     * Folded in here so the screen never reaches for the config view itself.
+     */
+    fieldHelp: InvoicingFieldHelpByCode;
     gatewayOptions: InvoicingNamedOption[];
     localData: RecordPaymentFormLocalData;
     paymentMethodOptions: InvoicingNamedOption[];

package/lib/view/invoicing/recordPayment/recordPaymentSelector.js

@@ -23,6 +23,7 @@ const getRecordPaymentFormView = (state) => {
     const { contextInvoiceId, error, fetchState, newPaymentDraft } = state.invoicingRecordPaymentState;
     const { manualPaymentMethodOptions, paymentGatewayOptions } = (0, invoicingConfigViewSelector_1.getInvoicingConfigView)(state);
     return {
+        fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'payment'),
         contextInvoiceId,
         gatewayOptions: paymentGatewayOptions,
         localData: newPaymentDraft,

package/package.json

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