@zeniai/client-epic-state 5.2.3 → 5.2.5

package/lib/esm/view/aiCfoView/epics/fetchSkillVersionsEpic.js

@@ -0,0 +1,37 @@
+import { of } from 'rxjs';
+import { catchError, filter, mergeMap, switchMap } from 'rxjs/operators';
+import { createZeniAPIStatus, isSuccessResponse } from '../../../responsePayload';
+import { fetchSkillVersions, fetchSkillVersionsFailure, fetchSkillVersionsSuccess, } from '../aiCfoViewReducer';
+const toVersion = (payload) => ({
+    version: payload.version,
+    semver: payload.semver ?? null,
+    displayName: payload.display_name ?? null,
+    updatedAt: payload.updated_at ?? null,
+    // Defaulted defensively: these are booleans the server always sends, but a malformed
+    // 2xx should render a row as inactive-and-not-latest rather than as the live one.
+    isActive: payload.is_active === true,
+    isLatest: payload.is_latest === true,
+    instructionsCharCount: payload.instructions_char_count ?? 0,
+});
+/** GET /1.0/skills/{macroId}/versions — the history panel. */
+export const fetchSkillVersionsEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(fetchSkillVersions.match), 
+// switchMap: a read, and only the skill currently open matters. The reducer also
+// drops responses whose macroId no longer matches, so a cancelled-but-in-flight
+// request cannot render one skill's history under another's title.
+switchMap((action) => {
+    const { macroId } = action.payload;
+    const url = `${zeniAPI.apiEndPoints.aiCfoMicroServiceBaseUrl}/1.0/skills/${encodeURIComponent(macroId)}/versions`;
+    return zeniAPI.getJSON(url).pipe(mergeMap((response) => {
+        if (isSuccessResponse(response) && response.data != null) {
+            return of(fetchSkillVersionsSuccess({
+                macroId,
+                // Guard the array: a malformed 2xx without `versions` must not crash .map.
+                versions: (response.data.versions ?? []).map(toVersion),
+            }));
+        }
+        return of(fetchSkillVersionsFailure({ macroId, error: response.status }));
+    }), catchError((error) => of(fetchSkillVersionsFailure({
+        macroId,
+        error: createZeniAPIStatus('Unexpected Error', 'Fetch skill versions REST API call failed', error instanceof Error ? { message: error.message } : undefined),
+    }))));
+}));

package/lib/esm/view/aiCfoView/epics/fetchSkillsEpic.js

@@ -2,6 +2,7 @@ import { of } from 'rxjs';
 import { catchError, filter, mergeMap, switchMap } from 'rxjs/operators';
 import { createZeniAPIStatus, isSuccessResponse } from '../../../responsePayload';
 import { fetchSkills, fetchSkillsFailure, fetchSkillsSuccess, } from '../aiCfoViewReducer';
+import { toBaseSkill } from './toSkillDetail';
 const isNonBlankString = (value) => typeof value === 'string' && value.trim() !== '';
 // parameter_hints is a free-form {param: exampleValue(s)} map; flatten its non-blank
 // string values (a single string or an array of them) into display-ready "try: …"
@@ -27,14 +28,12 @@ const toExampleHints = (parameterHints) => {
     // a broken duplicate to the user — dedupe across parameter keys and array entries.
     return Array.from(new Set(hints));
 };
+// Only the LIST route returns parameter_hints, so this is the one call site that has
+// hints to spread in. Everything else about a summary comes from the shared base mapper,
+// so a new `Skill` field cannot land here and be missed on the detail path.
 const toSkill = (skillSummaryPayload) => ({
-    macroId: skillSummaryPayload.macro_id,
-    name: skillSummaryPayload.name,
-    displayName: skillSummaryPayload.display_name,
-    description: skillSummaryPayload.description,
-    semver: skillSummaryPayload.semver,
+    ...toBaseSkill(skillSummaryPayload),
     exampleHints: toExampleHints(skillSummaryPayload.parameter_hints),
-    hasScripts: skillSummaryPayload.has_scripts,
 });
 /** GET {aiCfoMicroServiceBaseUrl}/1.0/skills — chat-visible skills for the `/` menu. */
 export const fetchSkillsEpic = (actions$, 
@@ -52,6 +51,12 @@ switchMap(() => {
             // Guard the array: a malformed 2xx body without `skills` must not crash .map.
             return of(fetchSkillsSuccess({
                 skills: (response.data.skills ?? []).map(toSkill),
+                // === true, not a truthy check: a body missing the field entirely
+                // must read as "off" so the Skills entry stays hidden by default.
+                skillsEnabled: response.data.skills_enabled === true,
+                // Same discipline: a body without the field must withhold the publish
+                // control, not grant it.
+                canPublish: response.data.can_publish === true,
             }));
         }
         return of(fetchSkillsFailure(response.status));

package/lib/esm/view/aiCfoView/epics/saveSkillEpic.js

@@ -0,0 +1,72 @@
+import { of } from 'rxjs';
+import { catchError, filter, mergeMap } from 'rxjs/operators';
+import { createZeniAPIStatus, isSuccessResponse } from '../../../responsePayload';
+import { fetchSkillVersions, fetchSkills, saveSkill, saveSkillFailure, saveSkillSuccess, } from '../aiCfoViewReducer';
+import { getSkillDetail } from '../aiCfoViewSelector';
+import { isSkillDetailPayload, toSkillDetail } from './toSkillDetail';
+/**
+ * POST /1.0/skills (create) or PUT /1.0/skills/{macroId} (new version).
+ *
+ * One epic for both because they are the same action to a user — "save what I wrote" —
+ * and the server answers both with the detail payload. Splitting them would duplicate
+ * the payload mapping and the error handling for a difference the form does not have.
+ */
+export const saveSkillEpic = (actions$, state$, zeniAPI) => actions$.pipe(filter(saveSkill.match), 
+// mergeMap, NOT switchMap: a save is a write. Cancelling an in-flight one because
+// another started does not un-send it, it just hides the outcome — and for a
+// create that means a skill exists that the user was never told about.
+mergeMap((action) => {
+    const { draft, macroId } = action.payload;
+    const base = `${zeniAPI.apiEndPoints.aiCfoMicroServiceBaseUrl}/1.0/skills`;
+    const body = {
+        name: draft.name,
+        instructions: draft.instructions,
+        description: draft.description,
+        // Sent as the menu name too. The server derives the unique `/` slug from it, so
+        // letting the two drift would make the command stop matching the row's title.
+        display_name: draft.name,
+        // Spread, not `visibility: draft.visibility`: the server distinguishes an ABSENT
+        // visibility ("leave it alone") from an explicit null or 'private' ("make it
+        // private"). Sending the key with a null value would unpublish a tenant-wide
+        // skill on any edit by someone who cannot publish.
+        //
+        // `!= null`, not `!== null`: the type says this is always present, but the value
+        // arrives from a component, and an untyped caller omitting it would spread
+        // `{visibility: undefined}` — a key present with no value, which is the one shape
+        // the rule above is about. The looser check costs nothing and closes it.
+        ...(draft.visibility != null && { visibility: draft.visibility }),
+    };
+    const request$ = macroId != null && macroId !== ''
+        ? zeniAPI.putAndGetJSON(`${base}/${encodeURIComponent(macroId)}`, body)
+        : zeniAPI.postAndGetJSON(base, body);
+    return request$.pipe(mergeMap((response) => {
+        if (isSuccessResponse(response) &&
+            isSkillDetailPayload(response.data)) {
+            const saved = response.data;
+            const savedMacroId = saved.skill.macro_id;
+            const emitted = [
+                saveSkillSuccess({
+                    macroId: savedMacroId,
+                    // The response is a full detail read — carried through so an editor left
+                    // on this skill shows what it just saved rather than the previous prompt.
+                    detail: toSkillDetail(saved),
+                }),
+                // Refetch rather than splice the response in: a create changes the list's
+                // ordering and an update can change the name it is sorted by, so a local
+                // insert would put the row somewhere the next load moves it away from.
+                fetchSkills(),
+            ];
+            // A save adds a version, so the history panel is one behind — but only
+            // refetch when this skill is still the one on screen. `fetchSkillVersions`
+            // takes ownership of the versions slice, so firing it for a skill the user
+            // has already left would cancel the history of whatever they opened next.
+            if (getSkillDetail(state$.value).macroId === savedMacroId) {
+                emitted.push(fetchSkillVersions({ macroId: savedMacroId }));
+            }
+            return of(...emitted);
+        }
+        // A malformed 2xx is a failure, not a silent success: reporting "saved" when
+        // no skill came back leaves the user believing work was persisted.
+        return of(saveSkillFailure(response.status));
+    }), catchError((error) => of(saveSkillFailure(createZeniAPIStatus('Unexpected Error', 'Save skill REST API call failed', error instanceof Error ? { message: error.message } : undefined)))));
+}));

package/lib/esm/view/aiCfoView/epics/setSkillVisibilityEpic.js

@@ -0,0 +1,32 @@
+import { of } from 'rxjs';
+import { catchError, filter, mergeMap } from 'rxjs/operators';
+import { createZeniAPIStatus, isSuccessResponse } from '../../../responsePayload';
+import { fetchSkills, setSkillVisibility, setSkillVisibilityFailure, setSkillVisibilitySuccess, } from '../aiCfoViewReducer';
+import { isSkillDetailPayload, toSkillDetail } from './toSkillDetail';
+/**
+ * PUT /1.0/skills/{macroId}/visibility — publish or unpublish, without a new version.
+ *
+ * Its own route rather than the prompt PUT: that one requires name and instructions, so a
+ * visibility-only change cannot be expressed through it, and sending the whole prompt back
+ * to flip one field would create a version whose prompt is identical to its parent's.
+ */
+export const setSkillVisibilityEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(setSkillVisibility.match), 
+// mergeMap, like the other writes: cancelling a write in flight does not un-send it,
+// it only hides the outcome — and for a publish that means a skill sitting in every
+// colleague's menu with nobody told it got there.
+mergeMap((action) => {
+    const { macroId, visibility } = action.payload;
+    const url = `${zeniAPI.apiEndPoints.aiCfoMicroServiceBaseUrl}/1.0/skills/${encodeURIComponent(macroId)}/visibility`;
+    return zeniAPI.putAndGetJSON(url, { visibility }).pipe(mergeMap((response) => {
+        if (isSuccessResponse(response) &&
+            isSkillDetailPayload(response.data)) {
+            return of(setSkillVisibilitySuccess({
+                macroId,
+                detail: toSkillDetail(response.data),
+            }), 
+            // The list carries the badge that shows the audience, so it is now stale.
+            fetchSkills());
+        }
+        return of(setSkillVisibilityFailure(response.status));
+    }), catchError((error) => of(setSkillVisibilityFailure(createZeniAPIStatus('Unexpected Error', 'Set skill visibility REST API call failed', error instanceof Error ? { message: error.message } : undefined)))));
+}));

package/lib/esm/view/aiCfoView/epics/toSkillDetail.js

@@ -0,0 +1,102 @@
+/**
+ * Every value `SkillVisibility` admits, as data so the converter below cannot drift from
+ * the type. Adding a tier to the union without adding it here is a compile error.
+ */
+const SKILL_VISIBILITIES = ['private', 'tenant'];
+/**
+ * A wire string narrowed to {@link SkillVisibility}, or null.
+ *
+ * A converter rather than passing the raw string through, because `Skill.visibility` is a
+ * union on the state type and this is the boundary where an unvalidated payload becomes
+ * it — the repo's rule about explicit converters at scalar boundaries instead of a bare
+ * cast.
+ *
+ * Unrecognised maps to NULL, not to `'private'`. Null already means "does not apply" for a
+ * Zeni default, and consumers show no audience badge for it — so an unknown tier renders
+ * as no badge. Defaulting to `'private'` would instead label a skill the whole tenant can
+ * run as author-only, which is a confident lie rather than a visible gap.
+ */
+export const toSkillVisibility = (raw) => SKILL_VISIBILITIES.find((known) => known === raw) ?? null;
+/**
+ * Everything about a skill summary EXCEPT `exampleHints`, which no shared mapper can
+ * honestly supply.
+ *
+ * Only the LIST route returns `parameter_hints`; the detail and write routes do not. A
+ * shared mapper hardcoding `exampleHints: []` would put a "try: …" line under a skill
+ * that has hints, or drop them from the menu — so the field is `Omit`ted and each caller
+ * spreads in what its own route actually knows.
+ *
+ * Returning `Omit<Skill, 'exampleHints'>` rather than duplicating the mapper is what
+ * makes a new `Skill` field land in one place: this function stops compiling until the
+ * field is mapped, and both callers inherit it. The previous shape — two full copies —
+ * is how `isMine` was nearly added to only one of them, which would have silently
+ * withheld the edit and delete controls on whichever surface was missed.
+ */
+export const toBaseSkill = (payload) => ({
+    macroId: payload.macro_id,
+    name: payload.name,
+    displayName: payload.display_name,
+    description: payload.description,
+    semver: payload.semver,
+    hasScripts: payload.has_scripts === true,
+    // === true, so an absent field withholds the write controls rather than offering ones
+    // the API refuses.
+    isMine: payload.is_mine === true,
+    isOwnedByTenant: payload.is_owned_by_tenant === true,
+    updatedAt: payload.updated_at ?? null,
+    visibility: toSkillVisibility(payload.visibility),
+});
+/**
+ * Whether a 2xx body carries a prompt.
+ *
+ * Narrows to {@link PromptBody} and NOT to the whole payload, because the only consumer —
+ * the version-body read — dereferences `instructions` and nothing else. Asserting the
+ * whole shape here would claim `skill` was checked when it was not, and tying the read to
+ * it would fail a response whose prompt was fine and whose `skill` block was malformed,
+ * which is exactly what happened when this was one predicate instead of two.
+ *
+ * Takes `unknown`: the input is an unvalidated network body, and typing the parameter as
+ * the payload interface would assume the very thing being checked.
+ */
+export const hasPromptBody = (data) => typeof data?.instructions ===
+    'string';
+/**
+ * Whether a 2xx body can build a whole {@link SkillDetail}.
+ *
+ * Narrows to the payload type itself, which is now truthful: the two fields this checks
+ * are the two the interface still declares required, and the other three are optional
+ * there. Stricter than {@link hasPromptBody} by exactly one field. Four epics read this shape
+ * and each used to guard it differently — `data != null`, `data?.skill != null`, and a
+ * real `instructions` check — so one malformed response became a failure in one place, an
+ * empty prompt in another, and `undefined` in a third.
+ */
+export const isSkillDetailPayload = (data) => hasPromptBody(data) && data.skill != null;
+/**
+ * The detail payload every write route answers with.
+ *
+ * Shared because three epics need it — save, visibility, and the detail read — and a
+ * fourth copy is how one of them quietly stops carrying a field the others do.
+ *
+ * The coercions are not defensive habit; the payload type makes them mandatory — the
+ * three optional fields cannot be assigned to a non-optional `SkillDetail` without one.
+ * Which fields get coerced and which do not is the deliberate part:
+ *
+ * - `instructions` is load-bearing and already proven, so it passes through. Defaulting a
+ *   missing prompt to `''` is the one thing this module exists to prevent: the user
+ *   cannot tell an empty prompt from a skill that has one, and may save over the real
+ *   thing.
+ * - `instructionsCharCount` falls back to the prompt's own length, NOT to 0. A 12,000
+ *   character prompt displayed as "0 characters" is a lie the user can see, and the
+ *   prompt is right here to measure. Approximate only for astral-plane characters, where
+ *   UTF-16 units and the server's count differ — a rounding error, against a guaranteed
+ *   wrong answer.
+ * - `artifact` and `artifactTitle` degrade to empty. They render a preview card, so
+ *   losing them costs a card; failing the whole read would cost the user the skill.
+ */
+export const toSkillDetail = (payload) => ({
+    skill: { ...toBaseSkill(payload.skill), exampleHints: [] },
+    instructions: payload.instructions,
+    instructionsCharCount: payload.instructions_char_count ?? payload.instructions.length,
+    artifact: payload.artifact ?? '',
+    artifactTitle: payload.artifact_title ?? '',
+});

package/lib/esm/view/invoicing/auditView/auditViewPayload.js

@@ -39,6 +39,16 @@ function formatActor(actor, sourceLabel) {
     }
     return name;
 }
+/**
+ * The backend's human-readable action text, or `undefined` when it carries none.
+ * Blank copy collapses to `undefined` so the UI's `humanizeToken` fallback runs
+ * instead of rendering an empty Action cell, and surrounding whitespace is
+ * trimmed so the stored value is what should be displayed verbatim.
+ */
+function invoicingAuditActionLabel(actionLabel) {
+    const trimmed = actionLabel?.trim() ?? '';
+    return trimmed !== '' ? trimmed : undefined;
+}
 export function mapAuditLogEntry(entry) {
     const sourceLabel = entry.source_label ?? '';
     return {
@@ -49,6 +59,7 @@ export function mapAuditLogEntry(entry) {
         source: entry.source,
         sourceLabel: sourceLabel || undefined,
         action: entry.action,
+        actionLabel: invoicingAuditActionLabel(entry.action_label),
         entityId: entry.entity_id,
         entityType: entry.entity_type,
         customerId: entry.customer_id ?? undefined,

package/lib/esm/view/invoicing/createInvoice/createInvoiceSelector.js

@@ -1,5 +1,6 @@
 import { getAddressByAddressId } from '../../../entity/address/addressSelector';
 import { getInvoicingCatalogListView, getInvoicingCatalogPrices, } from '../invoicingCatalogListView/invoicingCatalogListViewSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { getInvoicingCustomerListView } from '../invoicingCustomerListView/invoicingCustomerListViewSelector';
 import { getInvoicingSettings } from '../settingsView/settingsViewSelector';
 /**
@@ -32,6 +33,7 @@ export const getCreateInvoiceFormView = (state) => {
     const createInvoiceState = state.invoicingCreateInvoiceState;
     const catalogListView = getInvoicingCatalogListView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'invoice'),
         customers: getInvoicingCustomerListView(state).customers.map((customer) => ({
             billingAddress: customer.billingAddressId != null
                 ? getAddressByAddressId(state.addressState, customer.billingAddressId)

package/lib/esm/view/invoicing/editInvoicingCatalogItemDetailView/editInvoicingCatalogItemDetailViewSelector.js

@@ -1,6 +1,6 @@
 import { createSelector } from '@reduxjs/toolkit';
 import { getInvoicingPlanById, getInvoicingPlansByIds, } from '../../../entity/invoicing/plan/planSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { INVOICING_CATALOG_APPLICABILITY_VALUES, INVOICING_CATALOG_PRICING_MODEL_VALUES, INVOICING_CATALOG_PRORATION_VALUES, INVOICING_CATALOG_TIER_TYPE_VALUES, entityToInvoicingCatalogItemFormLocalData, } from './invoicingCatalogItemFormConfig';
 export const getEditInvoicingCatalogItemDetailViewState = (state) => ({
     fetchState: state.editInvoicingCatalogItemDetailViewState.fetchState,
@@ -50,6 +50,7 @@ export const getInvoicingCatalogItemFormView = (state, id) => {
         : allApplicableItemOptions;
     const { billingPeriodUnitOptions, catalogItemTypeOptions, catalogTierTypeOptionsByPricingModel, catalogTrialEndActionOptions, catalogTrialUnitOptions, } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'catalog'),
         applicabilityValues: INVOICING_CATALOG_APPLICABILITY_VALUES,
         applicableItemOptions,
         localData,

package/lib/esm/view/invoicing/editInvoicingCouponDetailView/editInvoicingCouponDetailViewSelector.js

@@ -1,6 +1,6 @@
 import { getInvoicingCouponById } from '../../../entity/invoicing/coupon/couponSelector';
 import { toInvoicingFormOption, } from '../../../entity/invoicing/invoicingCommonPayload';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { entityToInvoicingCouponFormLocalData, } from './editInvoicingCouponDetailViewState';
 /**
  * Bundled view for the discount create/edit form: the save fetch state/error,
@@ -37,6 +37,7 @@ export const getInvoicingCouponFormView = (state, couponId) => {
         : newCouponDraft;
     const { billingPeriodUnitOptions, discountApplyOnOptions, discountDurationTypeOptions, discountTypeOptions, } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'discount'),
         ...base,
         applyOnOptions: discountApplyOnOptions.map(toInvoicingFormOption),
         discountTypeOptions: discountTypeOptions.map(toInvoicingFormOption),

package/lib/esm/view/invoicing/editInvoicingCustomerDetailView/editInvoicingCustomerDetailViewSelector.js

@@ -1,6 +1,6 @@
 import { getInvoicingCustomerById } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerSelector';
 import { getFormattedAddress } from '../../addressView/addressViewSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { INVOICING_CUSTOMER_BILLING_ADDRESS_TYPE, entityToInvoicingCustomerFormLocalData, } from './invoicingCustomerFormConfig';
 /**
  * Bundled view for the customer create/edit form. Exposes the draft `localData`
@@ -29,6 +29,7 @@ export const getInvoicingCustomerFormView = (state, invoicingCustomerID) => {
         : undefined;
     const { customerTypeOptions, netTermDayOptions, taxabilityOptions } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'customer'),
         customerTypeOptions,
         localData,
         mode,

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewPayload.js

@@ -1,5 +1,5 @@
 import { toAddressUpdatableInfoPayload } from '../../addressView/addressViewPayload';
-import { billingFrequencyToPeriod, invoicingSubscriptionTodayIso, toInvoicingSubscriptionBillingCycles, toInvoicingSubscriptionQuantity, } from './invoicingSubscriptionFormConfig';
+import { invoicingSubscriptionTodayIso, toInvoicingSubscriptionBillingCycles, toInvoicingSubscriptionQuantity, } from './invoicingSubscriptionFormConfig';
 /**
  * Build the create/update subscription request body from the form draft. The
  * shipping address is sent as an object (captured via the shared Address
@@ -8,9 +8,14 @@ import { billingFrequencyToPeriod, invoicingSubscriptionTodayIso, toInvoicingSub
  * `remaining_billing_cycles` is omitted when the user left the field empty, so
  * the backend applies the plan's own `billing_cycles` (or renews forever when
  * the plan sets no limit) rather than being pinned to a value the form invented.
+ *
+ * `billing_period` / `billing_period_unit` are deliberately absent. Billing
+ * cadence is a property of the selected price point, not of the subscription,
+ * and the backend derives it from that price point when the fields are omitted.
+ * Sending them made every price point whose cadence the form could not express
+ * — a daily plan, for instance — fail with a 422.
  */
 export const localDataToSaveInvoicingSubscriptionPayload = (localData, shippingAddress) => {
-    const frequency = billingFrequencyToPeriod(localData.billingFrequency);
     const items = [
         {
             item_price_code: localData.planPriceCode,
@@ -35,8 +40,6 @@ export const localDataToSaveInvoicingSubscriptionPayload = (localData, shippingA
     const remainingBillingCycles = toInvoicingSubscriptionBillingCycles(localData.remainingBillingCycles);
     return {
         auto_collection: localData.autoCollection ? 'on' : 'off',
-        billing_period: frequency.period,
-        billing_period_unit: frequency.unit,
         currency_code: localData.preferredCurrencyCode,
         customer_id: localData.customerId,
         started_at: startedAt !== '' ? startedAt : invoicingSubscriptionTodayIso(),

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

@@ -2,9 +2,9 @@ import { getInvoicingSubscriptionById } from '../../../entity/invoicing/invoicin
 import { getFormattedAddress } from '../../addressView/addressViewSelector';
 import { getInvoicingCouponListItems } from '../couponView/couponViewSelector';
 import { getInvoicingCatalogListView, getInvoicingCatalogPrices, } from '../invoicingCatalogListView/invoicingCatalogListViewSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { getInvoicingCustomerListView } from '../invoicingCustomerListView/invoicingCustomerListViewSelector';
-import { INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES, INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, } from './invoicingSubscriptionFormConfig';
+import { INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, } from './invoicingSubscriptionFormConfig';
 export const getEditInvoicingSubscriptionDetailViewState = (state, invoicingSubscriptionID) => {
     const { error, fetchState, savedSubscriptionId } = state.editInvoicingSubscriptionDetailViewState;
     const { subscriptionCommercialEditAllowedFromStatuses, subscriptionLifecycleActionOptions, subscriptionMetadataEditAllowedFromStatuses, } = getInvoicingConfigView(state);
@@ -42,9 +42,7 @@ export const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID)
     const planPrices = getInvoicingCatalogPrices(catalogListView.plans);
     const addonAndChargePrices = getInvoicingCatalogPrices(catalogListView.products);
     return {
-        billingFrequencyValues: [
-            ...INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES,
-        ],
+        fieldHelp: invoicingFieldHelpForGroup(state, 'subscription'),
         coupons: getInvoicingCouponListItems(state),
         customers: getInvoicingCustomerListView(state).customers,
         localData,

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/invoicingSubscriptionFormConfig.js

@@ -1,35 +1,6 @@
 import { dateNow } from '../../../zeniDayJS';
 /** `AddressType` key used when the subscription form opens the shared Address screen. */
 export const INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE = 'invoicing_subscription_shipping_address';
-/**
- * Canonical billing-frequency value set for the subscription form. CES owns the
- * values (and their period/unit mapping); web-components maps each value to a
- * localized label (same split as the customer form's value sets).
- */
-export const INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES = [
-    'weekly',
-    'monthly',
-    'quarterly',
-    'half_yearly',
-    'yearly',
-];
-const BILLING_FREQUENCY_TO_PERIOD = {
-    weekly: { period: 1, unit: 'week' },
-    monthly: { period: 1, unit: 'month' },
-    quarterly: { period: 3, unit: 'month' },
-    half_yearly: { period: 6, unit: 'month' },
-    yearly: { period: 1, unit: 'year' },
-};
-/** Map a billing-frequency value to its API `billing_period` / `billing_period_unit`. */
-export const billingFrequencyToPeriod = (value) => BILLING_FREQUENCY_TO_PERIOD[value] ?? BILLING_FREQUENCY_TO_PERIOD.monthly;
-/** Map an existing subscription's period/unit back to a billing-frequency value. */
-export const periodToBillingFrequency = (period, unit) => {
-    const match = INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES.find((value) => {
-        const mapped = BILLING_FREQUENCY_TO_PERIOD[value];
-        return mapped.period === period && mapped.unit === unit;
-    });
-    return match ?? 'monthly';
-};
 const subscriptionItemPriceCodes = (subscription, itemType) => subscription?.subscriptionItems
     ?.filter((item) => item.itemType === itemType)
     .map((item) => item.itemPriceCode)
@@ -80,7 +51,6 @@ export const initialInvoicingSubscriptionFormLocalData = {
     addonPriceCodes: [],
     addonQuantities: {},
     autoCollection: true,
-    billingFrequency: 'monthly',
     chargePriceCodes: [],
     chargeQuantities: {},
     couponId: '',
@@ -103,7 +73,6 @@ export const entityToInvoicingSubscriptionFormLocalData = (subscription) => {
         addonPriceCodes: subscriptionItemPriceCodes(subscription, 'addon'),
         addonQuantities: subscriptionItemQuantities(subscription, 'addon'),
         autoCollection: (subscription.autoCollection ?? 'on') === 'on',
-        billingFrequency: periodToBillingFrequency(subscription.billingPeriod, subscription.billingPeriodUnit),
         chargePriceCodes: subscriptionItemPriceCodes(subscription, 'charge'),
         chargeQuantities: subscriptionItemQuantities(subscription, 'charge'),
         couponId: subscription.coupons?.[0]?.couponCode ??

package/lib/esm/view/invoicing/invoiceDetail/invoiceDetailSelector.js

@@ -2,10 +2,12 @@ import recordGet from 'lodash/get';
 import { getAddressByAddressId } from '../../../entity/address/addressSelector';
 import { getInvoiceById } from '../../../entity/invoicing/invoice/invoiceSelector';
 import { getInvoicingInvoiceActionState } from '../invoiceAction/invoiceActionSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 export const getInvoiceDetail = (state, invoiceId) => {
     const detail = recordGet(state.invoicingInvoiceDetailState.detailById, invoiceId, undefined);
     const invoice = getInvoiceById(state.invoicingInvoiceState, invoiceId);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'invoice'),
         invoice,
         billingAddress: invoice?.billingAddressId != null
             ? getAddressByAddressId(state.addressState, invoice.billingAddressId)

package/lib/esm/view/invoicing/invoicingCatalogItemDetailView/invoicingCatalogItemDetailViewSelector.js

@@ -1,9 +1,10 @@
 import { getInvoicingPlanById } from '../../../entity/invoicing/plan/planSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 export const getInvoicingCatalogItemDetail = (state, _kind, id) => {
     const { error, fetchState } = state.invoicingCatalogItemDetailViewState;
     const { billingPeriodUnitOptions, catalogItemLifecycleActionOptions, catalogItemTypeOptions, catalogProductLifecycleActionOptions, catalogTierTypeOptionsByPricingModel, catalogTrialEndActionOptions, catalogTrialUnitOptions, fetchState: configFetchState, } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'catalog'),
         catalogItemLifecycleActionOptions,
         catalogProductLifecycleActionOptions,
         catalogTierTypeOptionsByPricingModel,

package/lib/esm/view/invoicing/invoicingConfigView/invoicingConfigViewReducer.js

@@ -1,5 +1,5 @@
 import { createSlice } from '@reduxjs/toolkit';
-import { toAuditLogEntityRouteOption, toInvoicingCatalogItemLifecycleActionOption, toInvoicingCatalogProductLifecycleActionOption, toInvoicingDiscountLifecycleActionOption, toInvoicingDunningAction, toInvoicingNamedOption, toInvoicingNamedOptionsByKey, toInvoicingQboAccountMappingKindOption, toInvoicingSubscriptionEditFieldOption, toInvoicingSubscriptionLifecycleActionOption, } from '../../../entity/invoicing/invoicingCommonPayload';
+import { toAuditLogEntityRouteOption, toInvoicingCatalogItemLifecycleActionOption, toInvoicingCatalogProductLifecycleActionOption, toInvoicingDiscountLifecycleActionOption, toInvoicingDunningAction, toInvoicingFieldHelp, toInvoicingNamedOption, toInvoicingNamedOptionsByKey, toInvoicingQboAccountMappingKindOption, toInvoicingSubscriptionEditFieldOption, toInvoicingSubscriptionLifecycleActionOption, } from '../../../entity/invoicing/invoicingCommonPayload';
 import { clearAll } from '../../../rootActions';
 export const initialState = {
     fetchState: 'Not-Started',
@@ -15,6 +15,7 @@ export const initialState = {
     catalogTrialUnitOptions: [],
     customerTypeOptions: [],
     dateFormatOptions: [],
+    fieldHelp: {},
     discountApplyOnOptions: [],
     discountDurationTypeOptions: [],
     discountTypeOptions: [],
@@ -75,6 +76,9 @@ export function mapInvoicingConfigPayloadToState(payload) {
         })),
         autoCollectionOptions: (payload.auto_collection_options ?? []).map(toInvoicingNamedOption),
         billingPeriodUnitOptions: (payload.billing_period_unit_options ?? []).map(toInvoicingNamedOption),
+        fieldHelp: payload.field_help != null
+            ? toInvoicingFieldHelp(payload.field_help)
+            : {},
         catalogTierTypeOptionsByPricingModel: payload.catalog_tier_type_options_by_pricing_model != null
             ? toInvoicingNamedOptionsByKey(payload.catalog_tier_type_options_by_pricing_model)
             : undefined,

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

@@ -17,3 +17,10 @@ export const getInvoicingOnboardingGateView = (state) => {
         status: deriveInvoicingOnboardingStatus(state.invoicingConfigViewState.isInvoicingTosAccepted, state.invoicingConfigViewState.isInvoicingEnabled),
     };
 };
+/**
+ * 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".
+ */
+export const invoicingFieldHelpForGroup = (state, group) => state.invoicingConfigViewState.fieldHelp[group] ?? {};

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

@@ -1,8 +1,10 @@
 import recordGet from 'lodash/get';
 import { getInvoicingCouponById } from '../../../entity/invoicing/coupon/couponSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 export const getInvoicingCouponDetail = (state, id) => {
     const detail = recordGet(state.invoicingCouponDetailViewState.detailById, id, undefined);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'discount'),
         coupon: getInvoicingCouponById(state.invoicingCouponState, id),
         fetchState: detail?.fetchState ?? 'Not-Started',
         error: detail?.error,

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

@@ -1,8 +1,10 @@
 import { getInvoicingCreditNoteById as getInvoicingCreditNoteByIdFromState } from '../../../entity/invoicing/creditNote/creditNoteSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 export const getInvoicingCreditNoteById = (state, id) => getInvoicingCreditNoteByIdFromState(state.invoicingCreditNoteState, id);
 export const getInvoicingCreditNoteDetail = (state, invoicingCreditNoteID) => {
     const { error, fetchState } = state.invoicingCreditNoteDetailViewState;
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'credit_note'),
         creditNote: getInvoicingCreditNoteById(state, invoicingCreditNoteID),
         fetchState,
         error,

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

@@ -2,6 +2,7 @@ import recordGet from 'lodash/get';
 import { getInvoicesByIds } from '../../../entity/invoicing/invoice/invoiceSelector';
 import { getInvoicingCustomerById, invoicingCustomerPaymentMethods, } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerSelector';
 import { getInvoicingPaymentLinkSendState, getInvoicingPaymentMethodSaveState, getInvoicingPlaidLinkToken, getInvoicingSentPaymentLinkEmail, getInvoicingSentPaymentLinkMagicUrl, getInvoicingSetupIntent, getInvoicingSetupIntentFetchState, } from '../customerPaymentMethod/customerPaymentMethodSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { isStripeConnectedFromSettings } from '../settingsView/invoicingSettingsHelpers';
 import { getInvoicingSettings } from '../settingsView/settingsViewSelector';
 export const getInvoicingCustomerDetail = (state, invoicingCustomerID) => {
@@ -10,6 +11,7 @@ export const getInvoicingCustomerDetail = (state, invoicingCustomerID) => {
     const settings = getInvoicingSettings(state);
     const invoicingCustomer = getInvoicingCustomerById(invoicingCustomerState, invoicingCustomerID);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'customer'),
         invoicingCustomer,
         invoices: getInvoicesByIds(state.invoicingInvoiceState, state.invoicingInvoiceListState.invoiceByTab[state.invoicingInvoiceListState.activeTab]?.invoiceIds ?? []),
         paymentMethods: invoicingCustomerPaymentMethods(invoicingCustomer),

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

@@ -1,5 +1,6 @@
 import { getInvoicingDunningCaseById as getInvoicingDunningCaseByIdFromState } from '../../../entity/invoicing/dunningCase/dunningCaseSelector';
 import { getInvoicingDunningActionState } from '../dunningAction/dunningActionSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 const EMAIL_PREVIEW_NOT_STARTED = {
     error: undefined,
     fetchState: 'Not-Started',
@@ -9,6 +10,7 @@ export const getInvoicingDunningCaseById = (state, id) => getInvoicingDunningCas
 export const getInvoicingDunningCaseDetail = (state, invoicingDunningCaseID) => {
     const { emailPreview, error, fetchState, id } = state.invoicingDunningCaseDetailViewState;
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'dunning'),
         actionState: getInvoicingDunningActionState(invoicingDunningCaseID)(state),
         dunningCase: getInvoicingDunningCaseById(state, invoicingDunningCaseID),
         emailPreview: id === invoicingDunningCaseID ? emailPreview : EMAIL_PREVIEW_NOT_STARTED,

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

@@ -1,9 +1,11 @@
 import { getInvoicingSubscriptionById as getInvoicingSubscriptionByIdFromState } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { getInvoicingSubscriptionActionState } from '../subscriptionAction/subscriptionActionSelector';
 export const getInvoicingSubscriptionById = (state, id) => getInvoicingSubscriptionByIdFromState(state.invoicingSubscriptionState, id);
 export const getInvoicingSubscriptionDetail = (state, invoicingSubscriptionID) => {
     const { error, fetchState } = state.invoicingSubscriptionDetailViewState;
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'subscription'),
         actionState: getInvoicingSubscriptionActionState(invoicingSubscriptionID)(state),
         subscription: getInvoicingSubscriptionById(state, invoicingSubscriptionID),
         fetchState,